summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/filter/win_basename.yml
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 16:04:21 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 16:04:21 +0000
commit8a754e0858d922e955e71b253c139e071ecec432 (patch)
tree527d16e74bfd1840c85efd675fdecad056c54107 /lib/ansible/plugins/filter/win_basename.yml
parentInitial commit. (diff)
downloadansible-core-upstream.tar.xz
ansible-core-upstream.zip
Adding upstream version 2.14.3.upstream/2.14.3upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'lib/ansible/plugins/filter/win_basename.yml')
-rw-r--r--lib/ansible/plugins/filter/win_basename.yml24
1 files changed, 24 insertions, 0 deletions
diff --git a/lib/ansible/plugins/filter/win_basename.yml b/lib/ansible/plugins/filter/win_basename.yml
new file mode 100644
index 0000000..f89baa5
--- /dev/null
+++ b/lib/ansible/plugins/filter/win_basename.yml
@@ -0,0 +1,24 @@
+DOCUMENTATION:
+ name: win_basename
+ author: ansible core team
+ version_added: "2.0"
+ short_description: Get a Windows path's base name
+ description:
+ - Returns the last name component of a Windows path, what is left in the string that is not 'win_dirname'.
+ options:
+ _input:
+ description: A Windows path.
+ type: str
+ required: true
+ seealso:
+ - plugin_type: filter
+ plugin: ansible.builtin.win_dirname
+EXAMPLES: |
+
+ # To get the last name of a file Windows path, like 'foo.txt' out of 'C:\Users\asdf\foo.txt'
+ {{ mypath | win_basename }}
+
+RETURN:
+ _value:
+ description: The base name from the Windows path provided.
+ type: str