starred/ansible
1
0
Fork 0
mirror of https://github.com/ansible/ansible.git synced 2026-08-03 08:03:05 +02:00
Code Issues Packages Projects Releases Wiki Activity

[stable-2.16] filter: update the documentation for win_splitdrive (#83307)

Browse Source 
Fixes: #83299

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
(cherry picked from commit c1d41ee44e)
This commit is contained in:
Abhijeet Kasurde
2024-06-06 16:00:05 -05:00
committed by GitHub
parent 68463c2e4d
commit a31f07eee7
1 changed files with 16 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/ansible/plugins/filter/win_splitdrive.yml
+16 -4
View File
@@ -5,6 +5,8 @@ DOCUMENTATION:
short_description: Split a Windows path by the drive letter
description:
- 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.
options:
_input:
description: A Windows path.
@@ -13,17 +15,27 @@ DOCUMENTATION:
EXAMPLES: |
# To get the last name of a file Windows path, like ['C', '\Users\asdf\foo.txt'] out of 'C:\Users\asdf\foo.txt'
# 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 }}
# just the drive letter
# 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
# 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:
_value:
description: List in which the first element is the drive letter and the second the rest of the path.
description:
- 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.
type: list
elements: str