/ home / ansible / ansible.windows / 2.3.0 / module / win_reg_stat

ansible.windows.win_reg_stat (2.3.0) — module

Get information about Windows registry keys

Authors: Jordan Borean (@jborean93)

Install collection

Install with ansible-galaxy collection install ansible.windows:==2.3.0

Add to requirements.yml

  collections:
    - name: ansible.windows
      version: 2.3.0

Description

Like M(ansible.windows.win_file), M(ansible.windows.win_reg_stat) will return whether the key/property exists.

It also returns the sub keys and properties of the key specified.

If specifying a property name through I(property), it will return the information specific for that property.

Usage examples

Scanned by Steampunk Spotter

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

Scanned by Steampunk Spotter

- 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

Scanned by Steampunk Spotter

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

Inputs

    
name:
    aliases:
    - entry
    - value
    - property
    description:
    - The registry property name to get information for, the return json will not include
      the sub_keys and properties entries for the I(key) specified.
    - Set to an empty string to target the registry key's C((Default)) property value.
    type: str

path:
    aliases:
    - key
    description: The full registry key path including the hive to search for.
    required: true
    type: str

Outputs

changed:
  description: Whether anything was changed.
  returned: always
  sample: true
  type: bool
exists:
  description: States whether the registry key/property exists.
  returned: success and path/property exists
  sample: true
  type: bool
properties:
  description: A dictionary containing all the properties and their values in the
    registry key.
  returned: success, path exists and property not specified
  sample:
    ? ''
    : 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
  type: dict
raw_value:
  description: Returns the raw value of the registry property, REG_EXPAND_SZ has no
    string expansion, REG_BINARY or REG_NONE is in hex 0x format. REG_NONE, this value
    is a hex string in the 0x format.
  returned: success, path/property exists and property specified
  sample: '%ProgramDir%\\Common Files'
  type: str
sub_keys:
  description: A list of all the sub keys of the key specified.
  returned: success, path exists and property not specified
  sample:
  - AppHost
  - Casting
  - DateTime
  type: list
type:
  description: The property type.
  returned: success, path/property exists and property specified
  sample: REG_EXPAND_SZ
  type: str
value:
  description: The value of the property.
  returned: success, path/property exists and property specified
  sample: C:\\Program Files\\Common Files
  type: str

Install collection

Add to requirements.yml

Description

Usage examples

Inputs

Outputs

See also