summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/test/file.yml
blob: 8b79c07d638d576e04eafc4f2fe36dd67d7d9c0b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
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