summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/test/directory.yml
blob: 5d7fa78ef693e538a7e62a6001dc357af72fc012 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
DOCUMENTATION:
  name: directory
  author: Ansible Core
  version_added: "2.5"
  short_description: does the path resolve to an existing directory
  description:
    - Check if the provided path maps to an existing directory on the controller's filesystem (localhost).
  options:
    _input:
      description: A path.
      type: path

EXAMPLES: |
  vars:
    my_etc_hosts_not_a_dir: "{{ '/etc/hosts' is directory}}"
    list_of_files: "{{ list_of_paths | reject('directory') }}"

RETURN:
  _value:
    description: Returns C(True) if the path corresponds to an existing directory on the filesystem on the controller, c(False) if otherwise.
    type: boolean