win_path – Управление переменными среды PATH Windows

Описание
Параметры
Примечания
См. также
Примеры
Статус

Описание

Разрешает упорядочение, добавление и удаление переменных среды PATH Windows на основе элементов.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
elements список / обязательно		Один путь или список путей (то есть каталогов) для добавления или удаления. Когда в списке указано несколько элементов (и `state` является `present`), элементы гарантированно будут отображаться в том же относительном порядке в результирующем значении пути. Разрешены расширения переменных (например, `%VARNAME%`), которые сохраняются в целевом элементе пути в нерасширенном виде. Любые существующие элементы пути, не указанные в `elements`, всегда сохраняются в их текущем порядке. Новые элементы пути добавляются в конец пути, а существующие элементы могут перемещаться ближе к концу для удовлетворения запрошенного порядка. Пути сравниваются без учета регистра, а заключительные обратные косые черты игнорируются при сравнении. Однако обратите внимание, что заключительные обратные косые черты в YAML требуют кавычек.
name строка	Значение по умолчанию: "PATH"	Имя целевой переменной среды PATH.
scope строка	Варианты: machine ← пользователь	Уровень, на котором должна управляться переменная среды, указанная в `name`, (либо для текущего пользователя, либо для глобальной области видимости машины).
state строка	Варианты: absent present	Определяет, должны ли быть присутствовать или отсутствовать элементы пути, указанные в `elements`.

Примечания

Примечание

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

См. также

win_environment – Изменение переменных среды на хостах Windows: Официальная документация модуля win_environment.

Примеры

- name: Ensure that system32 and Powershell are present on the global system path, and in the specified order
  win_path:
    elements:
    - '%SystemRoot%\system32'
    - '%SystemRoot%\system32\WindowsPowerShell\v1.0'

- name: Ensure that C:\Program Files\MyJavaThing is not on the current user's CLASSPATH
  win_path:
    name: CLASSPATH
    elements: C:\Program Files\MyJavaThing
    scope: user
    state: absent

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается командой разработчиков Ansible. [core]

Поддержка Red Hat

Дополнительная информация о поддержке данного модуля Red Hat доступна в этой статье базы знаний Red Hat.

Авторы

Matt Davis (@nitzmahone)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 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_path_module.html