Skip to content

win_splitdrive

Collection Note

This module is part of the ansible.builtin collection. To install the collection, use:

ansible-galaxy collection install ansible.builtin
Added in version 2.0.

Synopsis

  • Returns a list with the first component being the drive letter and the second, the rest of the path.
  • If the path contains a drive letter, drive will contain everything up to and including the colon.
  • If the path contains a UNC (Universal Naming Convention) path, drive will contain the host name and share, up to but not including the fourth separator.

Parameters

Parameter Defaults / Choices Comments
_input
str
required		 A Windows path.

Examples

# 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 }}

Return Values

Key Data Type Description Returned
_value list 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.

Authors

  • Ansible Core Team