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_splitdrive. However, we recommend you use the Fully Qualified Collection Name (FQCN) ansible.builtin.win_splitdrive for easy linking to the plugin documentation and to avoid conflicting with other collections that may have the same filter plugin name.
This describes the input of the filter, the value before | ansible.builtin.win_splitdrive.
Parameter | Comments |
|---|---|
Input string / required | A Windows path. |
# To get the last name of a file Windows path, like ['C:', '\Users\asdf\foo.txt'] out of 'C:\Users\asdf\foo.txt'
{{ mypath | win_splitdrive }}
# To get path from UNC (Universal Naming Convention) path, like ['//host/computer', '/dir/a'] out of '//host/computer/dir/a'
# just the drive letter, like ['C:'] out of 'C:\Users\asdf\foo.txt'
{{ mypath | win_splitdrive | first }}
# path w/o drive letter, like ['\Users\asdf\foo.txt'] out of 'C:\Users\asdf\foo.txt'
{{ mypath | win_splitdrive | last }}
# just the hostname and share, like ['//host/computer'] out of '//host/computer/dir/a'
{{ mypath | win_splitdrive | first }}
# path w/o hostname and share, like ['/dir/a'] out of '//host/computer/dir/a'
{{ mypath | win_splitdrive | last }}
Key | Description |
|---|---|
Return value list / elements=string | List in which the first element is the drive letter with colon and the second the rest of the path. In case of UNC path, first element is the hostname and share and the second the rest of the path. Returned: success |
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ansible/builtin/win_splitdrive_filter.html