Added return documentation to win_regmerge module

This commit is contained in:
jhawkesworth@users.noreply.github.com 2016-03-21 08:25:41 +00:00 committed by Matt Clay
parent 184d9fc4e5
commit d2fe2287f9

View file

@ -68,4 +68,20 @@ EXAMPLES = '''
compare_to: HKLM:\SOFTWARE\myCompany
'''
RETURN = '''# '''
RETURN = '''
compare_to_key_found:
description: whether the parent registry key has been found for comparison
returned: when comparison key not found in registry
type: boolean
sample: false
difference_count:
description: number of differences between the registry and the file
returned: changed
type: integer
sample: 1
compared:
description: whether a comparison has taken place between the registry and the file
returned: when a comparison key has been supplied and comparison has been attempted
type: boolean
sample: true
'''