File: exists.yml

package info (click to toggle)
ansible-core 2.19.0~beta6-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 32,628 kB
  • sloc: python: 180,313; cs: 4,929; sh: 4,601; xml: 34; makefile: 21
file content (23 lines) | stat: -rw-r--r-- 885 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
DOCUMENTATION:
  name: exists
  author: Ansible Core
  version_added: "2.5"
  short_description: does the path exist, follow symlinks
  description:
    - Check if the provided path maps to an existing filesystem object on the controller (localhost).
    - Follows symlinks and checks the target of the symlink instead of the link itself, use the P(ansible.builtin.link#test)
      or P(ansible.builtin.link_exists#test) tests to check on the link.
  options:
    _input:
      description: a path
      type: path

EXAMPLES: |
  vars:
    my_etc_hosts_exists: "{{ '/etc/hosts' is exists }}"
    list_of_local_files_to_copy_to_remote: "{{ list_of_all_possible_files | select('exists') }}"

RETURN:
  _value:
    description: Returns V(True) if the path corresponds to an existing filesystem object on the controller (after following symlinks), V(False) if otherwise.
    type: boolean