win_path — Управление переменными среды PATH Windows
Новое в версии 2.3.
Обзор
- Позволяет задавать порядок, добавлять и удалять переменные среды Windows PATH на основе элементов.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| elements обязательный | Один элемент пути или список элементов пути (например, каталоги) для добавления или удаления. Когда в списке содержатся несколько элементов (и state является present), элементы гарантированно будут появляться в том же относительном порядке в результирующем значении пути.Разрешены расширения переменных (например, %VARNAME%), и они сохраняются в целевом элементе пути без расширения.Любые существующие элементы пути, не упомянутые в elements, всегда сохраняются в их текущем порядке.Новые элементы пути добавляются в конец пути, а существующие элементы пути могут перемещаться ближе к концу для удовлетворения запрошенного порядка. Пути сравниваются без учета регистра, а завершающие обратные слэши игнорируются для целей сравнения. Однако обратите внимание, что завершающие обратные слэши в YAML требуют кавычек. | |
| name | Значение по умолчанию: PATH | Имя целевой переменной среды пути |
| scope |
| Уровень, на котором переменная среды, указанная в name, должна управляться (либо для текущего пользователя, либо для глобального уровня машины). |
| state |
| Указывает, должны ли элементы пути, указанные в elements, присутствовать или отсутствовать. |
Примечания
Примечание
- Этот модуль предназначен для изменения отдельных элементов переменных среды, подобных пути. Для общего управления другими переменными среды используйте модуль win_environment.
- Этот модуль не транслирует события изменений. Это означает, что небольшая часть приложений Windows, которые могут изменять свою среду без перезапуска, не будут уведомлены, и поэтому потребуется перезапуск, чтобы они подхватили новые настройки среды. Для переменных среды уровня пользователя пользователю потребуется выйти из системы и снова войти, прежде чем они станут доступными.
Примеры
- 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
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно будет обратной совместимости.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией 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.5/modules/win_path_module.html