win_environment - Изменение переменных среды на хостах Windows
Новое в версии 2.0.
Описание
- Использует .NET Environment для установки или удаления переменных среды и может устанавливать их на уровне пользователя, компьютера или процесса.
- Переменные среды на уровне пользователя будут установлены, но недоступны до тех пор, пока пользователь не выйдет и не войдёт снова.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| level обязательно |
| Уровень, на котором устанавливается переменная среды. Используйте machine для установки для всех пользователей.Используйте user для установки для текущего пользователя, от имени которого выполняется Ansible.Используйте process для установки для текущего процесса. Вероятно, это не очень полезно. |
| name обязательно | Имя переменной среды. | |
| state |
| Установите в present для обеспечения установки переменной среды.Установите в absent для обеспечения её удаления. |
| value | Значение, которое нужно сохранить в переменной среды. Должно быть установлено при state=present, и не может быть пустой строкой.Можно опустить для state=absent. |
Примечания
Примечание
- Этот модуль лучше всего подходит для установки всего значения переменной среды. Для безопасного управления переменными среды, похожими на пути, используйте модуль win_path.
- Этот модуль не транслирует события изменения. Это означает, что меньшинство приложений Windows, которые могут изменять свою среду без перезапуска, не будут уведомлены и, следовательно, потребуют перезапуска, чтобы получить новые настройки среды. Переменные среды на уровне пользователя потребуют выхода и повторного входа пользователя, прежде чем они станут доступными.
Примеры
- name: Set an environment variable for all users
win_environment:
state: present
name: TestVariable
value: Test value
level: machine
- name: Remove an environment variable for the current user
win_environment:
state: absent
name: TestVariable
level: user
Возвращаемые значения
Общие значения, возвращаемые модулями, описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| before_value строка | всегда | значение ключа среды до изменения, равно null, если ключ не существовал Пример: C:\Windows\System32 |
| value строка | всегда | значение ключа среды, которое было установлено, равно null, если ключ был удалён Пример: C:\Program Files\jdk1.8 |
Статус
Этот модуль помечен как предварительный, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество Ansible. Подробнее см. Техническое обслуживание и поддержка модулей.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- Jon Hawkesworth (@jhawkesworth)
Подсказка
Если вы заметили проблемы в этом документе, вы можете отредактировать его для улучшения.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/win_environment_module.html
