summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/filter/win_splitdrive.yml
diff options
context:
space:
mode:
Diffstat (limited to 'lib/ansible/plugins/filter/win_splitdrive.yml')
-rw-r--r--lib/ansible/plugins/filter/win_splitdrive.yml29
1 files changed, 29 insertions, 0 deletions
diff --git a/lib/ansible/plugins/filter/win_splitdrive.yml b/lib/ansible/plugins/filter/win_splitdrive.yml
new file mode 100644
index 0000000..828d1dd
--- /dev/null
+++ b/lib/ansible/plugins/filter/win_splitdrive.yml
@@ -0,0 +1,29 @@
+DOCUMENTATION:
+ name: win_splitdrive
+ author: ansible core team
+ version_added: "2.0"
+ 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.
+ options:
+ _input:
+ description: A Windows path.
+ type: str
+ required: true
+
+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 }}
+
+ # just the drive letter
+ {{ mypath | win_splitdrive | first }}
+
+ # path w/o drive letter
+ {{ 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.
+ type: list
+ elements: str