New in version 2.3.
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 |
- name: Obtain information about a registry key using short form win_reg_stat: path: HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion register: current_version - name: Obtain information about a registry key property win_reg_stat: path: HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion name: CommonFilesDir register: common_files_dir
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 |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/win_reg_stat_module.html