win_reg_stat - returns information about a Windows registry key or property of a key
New in version 2.3.
Synopsis
- Like win_file, 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 property, it will return the information specific for that property.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
name | The registry property name to get information for, the return json will not include the sub_keys and properties entries for the key specified. aliases: entry, value, property | |
path required | The full registry key path including the hive to search for. aliases: key |
Examples
# Obtain information about a registry key using short form - win_reg_stat: path: HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion register: current_version # Obtain information about a registry key property - win_reg_stat: path: HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion name: CommonFilesDir register: common_files_dir
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
changed boolean | always | Whether anything was changed. Sample: True |
exists boolean | success and path/property exists | States whether the registry key/property exists. Sample: True |
properties dict | success, path exists and property not specified | A dictionary containing all the properties and their values in the registry key. Sample: {'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 string | success, path/property exists and property specified | 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. Sample: %ProgramDir%\\Common Files |
sub_keys list | success, path exists and property not specified | A list of all the sub keys of the key specified. Sample: ['AppHost', 'Casting', 'DateTime'] |
type string | success, path/property exists and property specified | The property type. Sample: REG_EXPAND_SZ |
value string | success, path/property exists and property specified | The value of the property. Sample: C:\\Program Files\\Common Files |
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Author
- Jordan Borean (@jborean93)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 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_reg_stat_module.html