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 |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно будет обратной совместим.
Автор
- 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.5/modules/win_environment_module.html
