New in version 2.1.
Parameter |
Choices/Defaults |
Comments |
---|---|---|
compare_key
|
Default:
no default
|
The parent key to use when comparing the contents of the registry to the contents of the file. Needs to be in HKLM or HKCU part of registry. Use a PS-Drive style path for example HKLM:\SOFTWARE not HKEY_LOCAL_MACHINE\SOFTWARE If not supplied, or the registry key is not found, no comparison will be made, and the module will report changed.
|
path
required |
Default:
no default
|
The full path including file name to the registry file on the remote machine to be merged
|
Note
# Merge in a registry file without comparing to current registry
# Note that paths using / to separate are preferred as they require less special handling than \
- win_regmerge:
path: C:/autodeploy/myCompany-settings.reg
# Compare and merge registry file
- win_regmerge:
path: C:/autodeploy/myCompany-settings.reg
compare_to: HKLM:\SOFTWARE\myCompany
Common return values are documented here, the following are the fields unique to this module:
Key |
Returned |
Description |
---|---|---|
compare_to_key_found
boolean
|
when comparison key not found in registry |
whether the parent registry key has been found for comparison
|
compared
boolean
|
when a comparison key has been supplied and comparison has been attempted |
whether a comparison has taken place between the registry and the file
Sample:
True
|
difference_count
int
|
changed |
number of differences between the registry and the file
Sample:
1
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.