summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/filter/realpath.yml
blob: 12687b6131f2d7649d229d9fe5000059ef72c186 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
DOCUMENTATION:
  name: realpath
  author: darkone23 (@darkone23)
  version_added: "1.8"
  short_description: Turn path into real path
  description:
    - Resolves/follows symliknks to return the 'real path' from a given path.
    - Filters alwasy run on controller so this path is resolved using the controller's filesystem.
  options:
    _input:
      description: A path.
      type: path
      required: true
EXAMPLES: |

  realpath: {{ '/path/to/synlink' | realpath }}

RETURN:
  _value:
    description: The canonical path.
    type: path