Class: Ansible::Ruby::Modules::Win_regedit

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/windows/win_regedit.rb

Overview

Add, modify or remove registry keys and values. More information about the windows registry from Wikipedia U(en.wikipedia.org/wiki/Windows_Registry).

Instance Method Summary collapse

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

#data ⇒ Integer, ...

Returns Value of the registry entry C(name) in C(path).,If not specified then the value for the property will be null for the corresponding C(type).,Binary and None data should be expressed in a yaml byte array or as comma separated hex values.,An easy way to generate this is to run C(regedit.exe) and use the I(export) option to save the registry values to a file.,In the exported file, binary value will look like C(hex:be,ef,be,ef), the C(hex:) prefix is optional.,DWORD and QWORD values should either be represented as a decimal number or a hex value.,Multistring values should be passed in as a list.,See the examples for more details on how to format this data.

Returns:

  • (Integer, Array<String>, String, nil) —

    Value of the registry entry C(name) in C(path).,If not specified then the value for the property will be null for the corresponding C(type).,Binary and None data should be expressed in a yaml byte array or as comma separated hex values.,An easy way to generate this is to run C(regedit.exe) and use the I(export) option to save the registry values to a file.,In the exported file, binary value will look like C(hex:be,ef,be,ef), the C(hex:) prefix is optional.,DWORD and QWORD values should either be represented as a decimal number or a hex value.,Multistring values should be passed in as a list.,See the examples for more details on how to format this data.



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

attribute :data

#delete_key ⇒ :yes, ...

Returns When C(state) is ‘absent’ then this will delete the entire key.,If C(no) then it will only clear out the ‘(Default)’ property for that key.

Returns:

  • (:yes, :no, nil) —

    When C(state) is ‘absent’ then this will delete the entire key.,If C(no) then it will only clear out the ‘(Default)’ property for that key.



33
 
# File 'lib/ansible/ruby/modules/generated/windows/win_regedit.rb', line 33

attribute :delete_key

#hive ⇒ String?

Returns A path to a hive key like C:UsersDefaultNTUSER.DAT to load in the registry.,This hive is loaded under the HKLM:ANSIBLE key which can then be used in I(name) like any other path.,This can be used to load the default user profile registry hive or any other hive saved as a file.,Using this function requires the user to have the C(SeRestorePrivilege) and C(SeBackupPrivilege) privileges enabled.

Returns:

  • (String, nil) —

    A path to a hive key like C:UsersDefaultNTUSER.DAT to load in the registry.,This hive is loaded under the HKLM:ANSIBLE key which can then be used in I(name) like any other path.,This can be used to load the default user profile registry hive or any other hive saved as a file.,Using this function requires the user to have the C(SeRestorePrivilege) and C(SeBackupPrivilege) privileges enabled.



37
 
# File 'lib/ansible/ruby/modules/generated/windows/win_regedit.rb', line 37

attribute :hive

#name ⇒ String?

Returns Name of the registry entry in the above C(path) parameters.,If not provided, or empty then the ‘(Default)’ property for the key will be used.

Returns:

  • (String, nil) —

    Name of the registry entry in the above C(path) parameters.,If not provided, or empty then the ‘(Default)’ property for the key will be used.



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

attribute :name

#path ⇒ String

Returns Name of the registry path.,Should be in one of the following registry hives: HKCC, HKCR, HKCU, HKLM, HKU.

Returns:

  • (String) —

    Name of the registry path.,Should be in one of the following registry hives: HKCC, HKCR, HKCU, HKLM, HKU.



13
 
# File 'lib/ansible/ruby/modules/generated/windows/win_regedit.rb', line 13

attribute :path

#state ⇒ :absent, ...

Returns The state of the registry entry.

Returns:

  • (:absent, :present, nil) —

    The state of the registry entry.



29
 
# File 'lib/ansible/ruby/modules/generated/windows/win_regedit.rb', line 29

attribute :state

#type ⇒ :binary, ...

Returns The registry value data type.

Returns:

  • (:binary, :dword, :expandstring, :multistring, :string, :qword, nil) —

    The registry value data type.



25
 
# File 'lib/ansible/ruby/modules/generated/windows/win_regedit.rb', line 25

attribute :type