ansible.builtin.directory test – does the path resolve to an existing directory

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 directory even without specifying the collections: keyword. However, we recommend you use the FQCN 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 path maps to an existing directory on the controller’s filesystem (localhost).

Aliases: is_dir

Input

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

Parameter

Comments

Input

path

A path.

Examples

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

Return Value

Key

Description

Return value

boolean

Returns True if the path corresponds to an existing directory on the filesystem on the controller, c(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.