New in version 2.3.
Parameter | Choices/Defaults | Comments |
---|---|---|
elements
list
/ required
|
A single path element, or a list of path elements (ie, directories) to add or remove.
When multiple elements are included in the list (and
state is present ), the elements are guaranteed to appear in the same relative order in the resultant path value.Variable expansions (eg,
%VARNAME% ) are allowed, and are stored unexpanded in the target path element.Any existing path elements not mentioned in
elements are always preserved in their current order.New path elements are appended to the path, and existing path elements may be moved closer to the end to satisfy the requested ordering.
Paths are compared in a case-insensitive fashion, and trailing backslashes are ignored for comparison purposes. However, note that trailing backslashes in YAML require quotes.
|
|
name
string
|
Default: "PATH"
|
Target path environment variable name.
|
scope
string
|
|
The level at which the environment variable specified by
name should be managed (either for the current user or global machine scope). |
state
string
|
|
Whether the path elements specified in
elements should be present or absent. |
Note
See also
- name: Ensure that system32 and Powershell are present on the global system path, and in the specified order
win_path:
elements:
- '%SystemRoot%\system32'
- '%SystemRoot%\system32\WindowsPowerShell\v1.0'
- name: Ensure that C:\Program Files\MyJavaThing is not on the current user's CLASSPATH
win_path:
name: CLASSPATH
elements: C:\Program Files\MyJavaThing
scope: user
state: absent
More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.
Hint
If you notice any issues in this documentation you can edit this document to improve it.