New in version 2.1.
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.
The full path including file name to the registry file on the remote machine to be merged
# 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 Return Values, the following are the fields unique to this module:
|difference_count||number of differences between the registry and the file||changed||integer||1|
|compared||whether a comparison has taken place between the registry and the file||when a comparison key has been supplied and comparison has been attempted||boolean||True|
|compare_to_key_found||whether the parent registry key has been found for comparison||when comparison key not found in registry||boolean||False|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is community maintained without core committer oversight.
For more information on what this means please read Module Support