ansible.builtin.abs test – is the path absolute

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 abs. However, we recommend you use the Fully Qualified Collection Name (FQCN) ansible.builtin.abs 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 is absolute, not relative.
  • An absolute path expresses the location of a filesystem object starting at the filesystem root and requires no context.
  • A relative path does not start at the filesystem root and requires a ‘current’ directory as a context to resolve.

Aliases: is_abs

Input

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

Parameter

Comments

Input

path

A path.

Examples

is_path_absolute: "{{ '/etc/hosts' is abs }}}"
relative_paths: "{{ all_paths | reject('abs') }}"

Return Value

Key

Description

Return value

boolean

Returns True if the path is absolute, False if it is relative.

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.

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ansible/builtin/abs_test.html