ansible.builtin.same_file test – compares two paths to see if they resolve to the same filesystem object

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 same_file. However, we recommend you use the Fully Qualified Collection Name (FQCN) ansible.builtin.same_file for easy linking to the plugin documentation and to avoid conflicting with other collections that may have the same test plugin name.

Synopsis

  • Check if the provided paths map to the same location on the controller’s filesystem (localhost).

Aliases: is_file, is_same_file

Input

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

Parameter

Comments

Input

path / required

A path.

Keyword parameters

This describes keyword parameters of the test. These are the values key1=value1, key2=value2 and so on in the following examples: input is ansible.builtin.same_file(key1=value1, key2=value2, ...) and input is not ansible.builtin.same_file(key1=value1, key2=value2, ...)

Parameter

Comments

_path2

path / required

Another path.

Examples

amionelevelfromroot: "{{ '/etc/hosts' is same_file('../etc/hosts') }}"

Return Value

Key

Description

Return value

boolean

Returns True if the paths correspond to the same location on the filesystem on the controller, False if otherwise.

Returned: success

Authors

  • Ansible Core

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.

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