summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/filter/dirname.yml
diff options
context:
space:
mode:
Diffstat (limited to 'lib/ansible/plugins/filter/dirname.yml')
-rw-r--r--lib/ansible/plugins/filter/dirname.yml24
1 files changed, 24 insertions, 0 deletions
diff --git a/lib/ansible/plugins/filter/dirname.yml b/lib/ansible/plugins/filter/dirname.yml
new file mode 100644
index 0000000..52f7d5d
--- /dev/null
+++ b/lib/ansible/plugins/filter/dirname.yml
@@ -0,0 +1,24 @@
+DOCUMENTATION:
+ name: dirname
+ author: ansible core team
+ version_added: "historical"
+ short_description: get a path's directory name
+ description:
+ - Returns the 'head' component of a path, basically everything that is not the 'basename'.
+ options:
+ _input:
+ description: A path.
+ type: path
+ required: true
+ seealso:
+ - plugin: ansible.builtin.basename
+ plugin_type: filter
+EXAMPLES: |
+
+ # To get the dir name of a file path, like '/etc/asdf' out of '/etc/asdf/foo.txt'
+ {{ mypath | dirname }}
+
+RETURN:
+ _value:
+ description: The directory portion of the original path.
+ type: path