ansible.windows.win_path module – Manage Windows path environment variables
This module is part of the ansible.windows collection (version 1.11.1).
You might already have this collection installed if you are using the
It is not included in
To check whether it is installed, run
ansible-galaxy collection list.
To install it, use:
ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify:
Allows element-based ordering, addition, and removal of Windows path environment variables.
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
Variable expansions (eg,
Any existing path elements not mentioned in
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.
Target path environment variable name.
The level at which the environment variable specified by
Whether the path elements specified in
This module is for modifying individual elements of path-like environment variables. For general-purpose management of other environment vars, use the ansible.windows.win_environment module.
This module does not broadcast change events. This means that the minority of windows applications which can have their environment changed without restarting will not be notified and therefore will need restarting to pick up new environment settings.
User level environment variables will require an interactive user to log out and in again before they become available.
The official documentation on the ansible.windows.win_environment module.
- name: Ensure that system32 and Powershell are present on the global system path, and in the specified order ansible.windows.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 ansible.windows.win_path: name: CLASSPATH elements: C:\Program Files\MyJavaThing scope: user state: absent