Class: Ansible::Ruby::Modules::Win_regmerge

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Win_regmerge

Defined in:

lib/ansible/ruby/modules/generated/windows/win_regmerge.rb

Overview

Wraps the reg.exe command to import the contents of a registry file. Suitable for use with registry files created using M(win_template). Windows registry files have a specific format and must be constructed correctly with carriage return and line feed line endings otherwise they will not be merged. Exported registry files often start with a Byte Order Mark which must be removed if the file is to templated using M(win_template). Registry file format is described at U(support.microsoft.com/en-us/kb/310516) See also M(win_template), M(win_regedit)

Instance Method Summary

• #compare_key ⇒ Object^?

  The parent key to use when comparing the contents of the registry to the contents of the file.

• #path ⇒ String

  The full path including file name to the registry file on the remote machine to be merged.

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#compare_key ⇒ Object^?

Returns 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_MACHINESOFTWARE If not supplied, or the registry key is not found, no comparison will be made, and the module will report changed.

Returns:

• (Object, nil) —

  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_MACHINESOFTWARE If not supplied, or the registry key is not found, no comparison will be made, and the module will report changed.

# File 'lib/ansible/ruby/modules/generated/windows/win_regmerge.rb', line 21

attribute :compare_key

#path ⇒ String

Returns The full path including file name to the registry file on the remote machine to be merged.

Returns:

• (String) —

  The full path including file name to the registry file on the remote machine to be merged

# File 'lib/ansible/ruby/modules/generated/windows/win_regmerge.rb', line 17

attribute :path