ansible.builtin.realpath filter – Turn path into real path

Note

This filter plugin is part of ansible-core and included in all Ansible installations. In most cases, you can use the short plugin name realpath. However, we recommend you use the Fully Qualified Collection Name (FQCN) ansible.builtin.realpath for easy linking to the plugin documentation and to avoid conflicting with other collections that may have the same filter plugin name.

Synopsis

  • Resolves/follows symlinks to return the ‘real path’ from a given path.

  • Filters always run on the controller so this path is resolved using the controller’s filesystem.

Input

This describes the input of the filter, the value before | ansible.builtin.realpath.

Parameter

Comments

Input

path / required

A path.

Examples

# realpath => /usr/bin/somebinary
realpath: {{ '/path/to/synlink' | realpath }}

Return Value

Key

Description

Return value

path

The canonical path.

Returned: success

Authors

  • darkone23 (@darkone23)

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.