summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/test/is_file.yml
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 16:04:21 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 16:04:21 +0000
commit8a754e0858d922e955e71b253c139e071ecec432 (patch)
tree527d16e74bfd1840c85efd675fdecad056c54107 /lib/ansible/plugins/test/is_file.yml
parentInitial commit. (diff)
downloadansible-core-8a754e0858d922e955e71b253c139e071ecec432.tar.xz
ansible-core-8a754e0858d922e955e71b253c139e071ecec432.zip
Adding upstream version 2.14.3.upstream/2.14.3upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'lib/ansible/plugins/test/is_file.yml')
-rw-r--r--lib/ansible/plugins/test/is_file.yml22
1 files changed, 22 insertions, 0 deletions
diff --git a/lib/ansible/plugins/test/is_file.yml b/lib/ansible/plugins/test/is_file.yml
new file mode 100644
index 0000000..8b79c07
--- /dev/null
+++ b/lib/ansible/plugins/test/is_file.yml
@@ -0,0 +1,22 @@
+DOCUMENTATION:
+ name: file
+ author: Ansible Core
+ version_added: "2.5"
+ short_description: does the path resolve to an existing file
+ description:
+ - Check if the provided path maps to an existing file on the controller's filesystem (localhost)
+ aliases: [is_file]
+ options:
+ _input:
+ description: A path.
+ type: path
+
+EXAMPLES: |
+ vars:
+ my_etc_hosts_is_a_file: "{{ '/etc/hosts' is file }}"
+ list_of_files: "{{ list_of_paths | select('file') }}"
+
+RETURN:
+ _value:
+ description: Returns C(True) if the path corresponds to an existing file on the filesystem on the controller, C(False) if otherwise.
+ type: boolean