ansible.windows.win_path 模块 – 管理 Windows 环境变量路径

注意

此模块是 ansible.windows 集合 (版本 2.5.0) 的一部分。

如果您使用的是 ansible 软件包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install ansible.windows。

要在 playbook 中使用它，请指定：ansible.windows.win_path。

概要

  • 允许基于元素对 Windows 环境变量路径进行排序、添加和删除。

参数

参数

注释

elements

列表 / elements=字符串 / 必需

单个路径元素或要添加或删除的路径元素（即目录）列表。

当列表中包含多个元素（并且 state 为 present）时，保证这些元素在生成的路径值中具有相同的相对顺序。

允许变量扩展（例如，%VARNAME%），并且这些扩展在目标路径元素中以未扩展的形式存储。

elements 中未提及的任何现有路径元素始终按其当前顺序保留。

新的路径元素将附加到路径，并且可以将现有路径元素移动到更靠近末尾的位置以满足所需的排序。

路径比较不区分大小写，并且忽略比较目的的尾部反斜杠。但是，请注意，YAML 中的尾部反斜杠需要带引号。

name

字符串

目标路径环境变量名称。

默认值： "PATH"

scope

字符串

应管理 name 指定的环境变量的级别（当前用户或全局机器范围）。

选项

  • "machine" ← (默认)

  • "user"

state

字符串

elements 中指定的路径元素应该是存在还是不存在。

选项

  • "absent"

  • "present" ← (默认)

备注

注意

  • 此模块用于修改类似路径的环境变量的各个元素。对于其他环境变量的通用管理，请使用 ansible.windows.win_environment 模块。

  • 此模块不广播更改事件。这意味着少数无需重新启动即可更改其环境的 Windows 应用程序不会收到通知，因此需要重新启动才能获取新的环境设置。

  • 用户级别的环境变量需要交互式用户注销并重新登录才能使用。

另请参见

另请参见

ansible.windows.win_environment

修改 Windows 主机上的环境变量。

示例

- name: Ensure that system32 and Powershell are present on the global system path, and in the specified order
  ansible.windows.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
  ansible.windows.win_path:
    name: CLASSPATH
    elements: C:\Program Files\MyJavaThing
    scope: user
    state: absent

作者

  • Matt Davis (@nitzmahone)