ansible.windows.win_reg_stat 模块 – 获取 Windows 注册表键信息

注意

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

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

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

要在剧本中使用它，请指定：ansible.windows.win_reg_stat。

概要 

与 ansible.windows.win_file 一样，ansible.windows.win_reg_stat 将返回键/属性是否存在。
它还返回指定键的子键和属性。
如果通过 *property* 指定属性名称，它将返回该属性的特定信息。

参数 

参数	注释
name 别名：entry, value, property 字符串	要获取信息的注册表属性名称，返回的 JSON 将不包含为指定的 key 的子键和属性条目。设置为空字符串以定位注册表键的 `(Default`) 属性值。
path 别名：key 字符串 / 必填	要搜索的完整注册表键路径，包括注册表项。

备注 

注意

返回值 properties 将包含一个空字符串键 ""，它指的是键的 Default 值。如果未设置该值，则不返回此键。

另请参阅 

另请参阅

ansible.windows.win_regedit: 添加、更改或删除注册表键和值。
community.windows.win_regmerge: 将注册表文件的内容合并到 Windows 注册表中。

示例 

- name: Obtain information about a registry key using short form
  ansible.windows.win_reg_stat:
    path: HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion
  register: current_version

- name: Obtain information about a registry key property
  ansible.windows.win_reg_stat:
    path: HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion
    name: CommonFilesDir
  register: common_files_dir

- name: Obtain the registry key's (Default) property
  ansible.windows.win_reg_stat:
    path: HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion
    name: ''
  register: current_version_default

返回值 

常见返回值已在此处记录，以下是此模块特有的字段

键	描述
changed 布尔值	是否发生了更改。返回：始终示例：`true`
exists 布尔值	指示注册表键/属性是否存在。返回：成功且路径/属性存在示例：`true`
properties 字典	包含注册表键中所有属性及其值的字典。返回：成功，路径存在且未指定属性示例：`{"": {"raw_value": "", "type": "REG_SZ", "value": ""}, "binary_property": {"raw_value": ["0x01", "0x16"], "type": "REG_BINARY", "value": [1, 22]}, "multi_string_property": {"raw_value": ["a", "b"], "type": "REG_MULTI_SZ", "value": ["a", "b"]}}`
raw_value 字符串	返回注册表属性的原始值，REG_EXPAND_SZ 没有字符串扩展，REG_BINARY 或 REG_NONE 为十六进制 0x 格式。REG_NONE，此值为 0x 格式的十六进制字符串。返回：成功，路径/属性存在且指定了属性示例：`"%ProgramDir%\\\\Common Files"`
sub_keys 列表 / 元素=字符串	指定键的所有子键的列表。返回：成功，路径存在且未指定属性示例：`["AppHost", "Casting", "DateTime"]`
type 字符串	属性类型。返回：成功，路径/属性存在且指定了属性示例：`"REG_EXPAND_SZ"`
value 字符串	属性的值。返回：成功，路径/属性存在且指定了属性示例：`"C:\\\\Program Files\\\\Common Files"`

作者

Jordan Borean (@jborean93)