ansible.builtin.win_basename filter – Get a Windows path’s base name

Note

This filter plugin is part of ansible-core and included in all Ansible installations. In most cases, you can use the short plugin name win_basename even without specifying the collections: keyword. However, we recommend you use the FQCN for easy linking to the plugin documentation and to avoid conflicting with other collections that may have the same filter plugin name.

New in Ansible 2.0

Synopsis

  • Returns the last name component of a Windows path, what is left in the string that is not ‘win_dirname’.

Input

This describes the input of the filter, the value before | ansible.builtin.win_basename.

Parameter

Comments

Input

string / required

A Windows path.

See Also

See also

ansible.builtin.win_dirname filter plugin

The official documentation on the ansible.builtin.win_dirname filter plugin.

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

Key

Description

Return value

string

The base name from the Windows path provided.

Returned: success

Authors

  • ansible core team

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.