ansible.windows.win_path – Manage Windows path environment variables¶
Note
This plugin is part of the ansible.windows collection (version 1.4.0).
To install it use: ansible-galaxy collection install ansible.windows
.
To use it in a playbook, specify: ansible.windows.win_path
.
Synopsis¶
Allows element-based ordering, addition, and removal of Windows path environment variables.
Parameters¶
Notes¶
Note
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.
See Also¶
See also
- ansible.windows.win_environment
The official documentation on the ansible.windows.win_environment module.
Examples¶
- 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
Authors¶
Matt Davis (@nitzmahone)