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

Примечание

Этот плагин входит в состав коллекции ansible.windows (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install ansible.windows.

Для использования в книге задач укажите: ansible.windows.win_environment.

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

Описание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
level строка / обязательно	Варианты: machine process user	Уровень, на котором следует установить переменную среды. Используйте `machine`, чтобы установить для всех пользователей. Используйте `user`, чтобы установить для текущего пользователя, от имени которого подключён ansible. Используйте `process`, чтобы установить для текущего процесса. Вероятно, не очень полезно.
name строка		Имя переменной среды. Требуется, когда state=absent.
state строка	Варианты: absent present	Установите в `present`, чтобы убедиться, что переменная среды установлена. Установите в `absent`, чтобы убедиться, что она удалена. При использовании variables не устанавливайте этот параметр.
value строка		Значение для хранения в переменной среды. Должен быть установлен, когда state=present, и не может быть пустой строкой. Должен быть опущен для state=absent и variables.
variables словарь добавлен в 1.3.0 ansible.windows		Словарь, в котором можно сразу определить несколько переменных среды. Недействителен, когда установлено state. Переменные со значением будут установлены (`present`), а переменные с пустым значением будут удалены (`absent`). level применяется ко всем переменным, определённым таким образом.

Примечания

Примечание

Этот модуль лучше всего подходит для установки всего значения переменной среды. Для безопасного элементарного управления переменными среды типа пути используйте модуль ansible.windows.win_path.
Этот модуль не транслирует события изменений. Это означает, что небольшая часть приложений Windows, которые могут изменять свою среду без перезапуска, не будут уведомлены и, следовательно, им потребуется перезапуск, чтобы получить новые настройки среды. Переменные среды на уровне пользователя потребуют выхода пользователя и повторного входа, прежде чем они станут доступными.
В результате before_value и value будут установлены в последние значения при использовании variables. В этом случае лучше использовать values, если вам нужно найти значения переменной до и после изменения.

См. также

ansible.windows.win_path: Официальная документация по модулю ansible.windows.win_path.

Примеры

- name: Set an environment variable for all users
  ansible.windows.win_environment:
    state: present
    name: TestVariable
    value: Test value
    level: machine

- name: Remove an environment variable for the current user
  ansible.windows.win_environment:
    state: absent
    name: TestVariable
    level: user

- name: Set several variables at once
  ansible.windows.win_environment:
    level: machine
    variables:
      TestVariable: Test value
      CUSTOM_APP_VAR: 'Very important value'
      ANOTHER_VAR: '{{ my_ansible_var }}'

- name: Set and remove multiple variables at once
  ansible.windows.win_environment:
    level: user
    variables:
      TestVariable: Test value
      CUSTOM_APP_VAR: 'Very important value'
      ANOTHER_VAR: '{{ my_ansible_var }}'
      UNWANTED_VAR: ''  # < this will be removed

Возвращаемые значения

Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Возвращаемое значение	Описание
before_value строка	всегда	значение ключа среды до изменения, если его не было, то значение null Пример: C:\Windows\System32
value строка	всегда	значение, в которое ключ среды был установлен, если был удален, то значение null Пример: C:\Program Files\jdk1.8
values словарь добавлен в 1.3.0 ansible.windows	всегда	словарь значений до и после; каждый ключ — это имя переменной, каждое значение — другой словарь с `before`, `after`, и `changed` ключами

Авторы

Jon Hawkesworth (@jhawkesworth)
Brian Scholer (@briantist)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ansible/windows/win_environment_module.html