summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/filter/win_dirname.yml
diff options
context:
space:
mode:
Diffstat (limited to 'lib/ansible/plugins/filter/win_dirname.yml')
-rw-r--r--lib/ansible/plugins/filter/win_dirname.yml24
1 files changed, 24 insertions, 0 deletions
diff --git a/lib/ansible/plugins/filter/win_dirname.yml b/lib/ansible/plugins/filter/win_dirname.yml
new file mode 100644
index 0000000..dbc85c7
--- /dev/null
+++ b/lib/ansible/plugins/filter/win_dirname.yml
@@ -0,0 +1,24 @@
+DOCUMENTATION:
+ name: win_dirname
+ author: ansible core team
+ version_added: "2.0"
+ short_description: Get a Windows path's directory
+ description:
+ - Returns the directory component of a Windows path, what is left in the string that is not 'win_basename'.
+ options:
+ _input:
+ description: A Windows path.
+ type: str
+ required: true
+ seealso:
+ - plugin_type: filter
+ plugin: ansible.builtin.win_basename
+EXAMPLES: |
+
+ # To get the last name of a file Windows path, like 'C:\users\asdf' out of 'C:\Users\asdf\foo.txt'
+ {{ mypath | win_dirname }}
+
+RETURN:
+ _value:
+ description: The directory from the Windows path provided.
+ type: str