lib/ansible/plugins/filter/win_dirname.yml


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
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