New in version 2.0.
Uses .net Environment to set or remove environment variables and can set at User, Machine or Process level. User level environment variables will be set, but not available until the user has logged off and on again.
|level ||yes||no default|| ||
The level at which to set the environment variable.
Use 'machine' to set for all users.
Use 'user' to set for the current user that ansible is connected as.
Use 'process' to set for the current process. Probably not that useful.
|name ||yes||no default||
The name of the environment variable
|state ||no||present|| ||
present to ensure environment variable is set, or absent to ensure it is removed
|value ||no||no default||
The value to store in the environment variable. Can be omitted for state=absent
# Set an environment variable for all users win_environment: state: present name: TestVariable value: "Test value" level: machine # Remove an environment variable for the current users win_environment: state: absent name: TestVariable level: user
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 the user to log out and in again before they become available.
For more information on what this means please read Extras Modules
© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.