win_environment – Изменение переменных среды на хостах Windows

Новое в версии 2.0.

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

Обзор

Использует .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.8/modules/win_environment_module.html