win_environment - Модифицирует переменные окружения на хостах Windows.
Новое в версии 2.0.
Описание
- Использует .net Environment для установки или удаления переменных окружения и может устанавливать их на уровне пользователя, машины или процесса.
- Переменные окружения уровня пользователя будут установлены, но не будут доступны до тех пор, пока пользователь не выйдет и не войдет снова.
Параметры
| параметр | обязательно | по умолчанию | выбор | комментарии |
|---|---|---|---|---|
| уровень | да | нет по умолчанию |
| Уровень, на котором нужно установить переменную окружения. Используйте 'машина', чтобы установить для всех пользователей. Используйте 'пользователь', чтобы установить для текущего пользователя, от имени которого подключен ansible. Используйте 'процесс', чтобы установить для текущего процесса. Вероятно, не так полезно. |
| имя | да | нет по умолчанию | Имя переменной окружения | |
| состояние | нет | наличие |
| наличие, чтобы убедиться, что переменная окружения установлена, или отсутствие, чтобы убедиться, что она удалена |
| значение | нет | нет по умолчанию | Значение для сохранения в переменной окружения. Можно опустить для state=отсутствует |
Примеры
- 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 |
| уровень | уровень, установленный при вызове модуля | всегда | строка | машина |
| имя | имя ключа окружения, проверенного модулем | всегда | строка | JAVA_HOME |
| значение | значение, до которого был установлен ключ окружения | всегда | строка | C:\Program Files\jdk1.8 |
Примечания
Примечание
- Данный модуль лучше всего подходит для установки всего значения переменной окружения. Для безопасного управления переменными окружения, имеющими структуру пути, используйте модуль win_path.
- Этот модуль не транслирует события изменений. Это означает, что небольшое количество приложений Windows, которые могут изменить свои переменные окружения без перезапуска, не будут уведомлены и, следовательно, потребуют перезапуска, чтобы принять новые настройки окружения. Для переменных окружения уровня пользователя пользователю потребуется выйти и снова войти в систему, прежде чем они станут доступными.
Статус
Этот модуль помечен как предварительная версия, что означает, что его интерфейс не гарантируется как обратная совместимость.
Для получения помощи в разработке модулей, если вы заинтересованы, пожалуйста, ознакомьтесь с Справочная информация по сообществу и вклад, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/win_environment_module.html
