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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/ansible/windows/win_environment_module.html