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. [community]
Авторы
- 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.7/modules/win_environment_module.html
