diff options
Diffstat (limited to 'lib/ansible/plugins/filter/basename.yml')
-rw-r--r-- | lib/ansible/plugins/filter/basename.yml | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/lib/ansible/plugins/filter/basename.yml b/lib/ansible/plugins/filter/basename.yml new file mode 100644 index 0000000..4e868df --- /dev/null +++ b/lib/ansible/plugins/filter/basename.yml @@ -0,0 +1,24 @@ +DOCUMENTATION: + name: basename + author: ansible core team + version_added: "historical" + short_description: get a path's base name + description: + - Returns the last name component of a path, what is left in the string that is not 'dirname'. + options: + _input: + description: A path. + type: path + required: true + seealso: + - plugin_type: filter + plugin: ansible.builtin.dirname +EXAMPLES: | + + # To get the last name of a file path, like 'foo.txt' out of '/etc/asdf/foo.txt' + {{ mypath | basename }} + +RETURN: + _value: + description: The base name from the path provided. + type: str |