New in version 2.0.
parameter | required | default | choices | comments |
---|---|---|---|---|
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
Note
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is community maintained without core committer oversight.
For more information on what this means please read Module Support
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.