W3cubDocs

/Ansible

ansible.builtin.link test – does the path reference existing symbolic link

Note

This test plugin is part of ansible-core and included in all Ansible installations. In most cases, you can use the short plugin name link. However, we recommend you use the Fully Qualified Collection Name (FQCN) ansible.builtin.link for easy linking to the plugin documentation and to avoid conflicting with other collections that may have the same test plugin name.

Synopsis
Input
Examples
Return Value

Synopsis

Check if the provided path maps to an existing symlink on the controller’s filesystem (localhost).

Aliases: is_link, islink

Input

This describes the input of the test, the value before is ansible.builtin.link or is not ansible.builtin.link.

Parameter	Comments
Input path	A path.

Examples

ismyhostsalink: "{{ '/etc/hosts' is link}}"
list_of_symlinks: "{{ list_of_paths | select('link') }}"

Return Value

Key	Description
Return value boolean	Returns `True` if the path corresponds to an existing symlink on the filesystem on the controller, `False` if otherwise. Returned: success

Authors

Ansible Core

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ansible/builtin/link_test.html