win_environment – Модификация переменных среды на хостах Windows

Описание
Параметры
Примечания
См. также
Примеры
Возвращаемые значения
Статус

Описание

Использует .NET Environment для установки или удаления переменных среды и может устанавливать их на уровне пользователя, компьютера или процесса.
Переменные среды на уровне пользователя будут установлены, но не станут доступны до тех пор, пока пользователь не выйдет и не войдёт снова.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
level строка / обязательно	Варианты: machine process user	Уровень, на котором следует установить переменную среды. Используйте `machine` для установки для всех пользователей. Используйте `user` для установки для текущего пользователя, с которым подключен Ansible. Используйте `process` для установки для текущего процесса. Вероятно, это не очень полезно.
name строка / обязательно		Имя переменной среды.
state строка	Варианты: absent present ←	Установите в `present`, чтобы гарантировать установку переменной среды. Установите в `absent`, чтобы гарантировать её удаление.
value строка		Значение для хранения в переменной среды. Обязательно указывать, когда `state=present`, и оно не может быть пустым. Можно опустить для `state=absent`.

Примечания

Примечание

Этот модуль лучше всего подходит для установки полного значения переменной среды. Для безопасного управления переменными среды, имеющими структуру типа пути, используйте модуль win_path.
Этот модуль не транслирует события изменения. Это означает, что небольшое число приложений Windows, которые могут изменять свою среду без перезапуска, не будут уведомлены и, следовательно, потребуют перезапуска для применения новых параметров среды. Для переменных среды на уровне пользователя пользователю потребуется выйти и войти снова, прежде чем они станут доступны.

См. также

win_path – Управление переменными среды путей Windows: Официальная документация по модулю win_path.

Примеры

- 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.9/modules/win_environment_module.html