Class: Ansible::Ruby::Modules::Pamd

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/system/pamd.rb

Overview

Edit PAM service’s type, control, module path and module arguments. In order for a PAM rule to be modified, the type, control and module_path must match an existing rule. See man(5) pam.d for details.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#backup ⇒ :yes, ...

Returns Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.

Returns:

  • (:yes, :no, nil) —

    Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.



52
 
# File 'lib/ansible/ruby/modules/generated/system/pamd.rb', line 52

attribute :backup

#control ⇒ String

Returns The control of the PAM rule being modified. This may be a complicated control with brackets. If this is the case, be sure to put “[bracketed controls]” in quotes. The type, control and module_path all must match a rule to be modified.

Returns:

  • (String) —

    The control of the PAM rule being modified. This may be a complicated control with brackets. If this is the case, be sure to put “[bracketed controls]” in quotes. The type, control and module_path all must match a rule to be modified.



20
 
# File 'lib/ansible/ruby/modules/generated/system/pamd.rb', line 20

attribute :control

#module_arguments ⇒ Array<String>, ...

Returns When state is ‘updated’, the module_arguments will replace existing module_arguments. When state is ‘args_absent’ args matching those listed in module_arguments will be removed. When state is ‘args_present’ any args listed in module_arguments are added if missing from the existing rule. Furthermore, if the module argument takes a value denoted by ‘=’, the value will be changed to that specified in module_arguments. Note that module_arguments is a list. Please see the examples for usage.

Returns:

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

    When state is ‘updated’, the module_arguments will replace existing module_arguments. When state is ‘args_absent’ args matching those listed in module_arguments will be removed. When state is ‘args_present’ any args listed in module_arguments are added if missing from the existing rule. Furthermore, if the module argument takes a value denoted by ‘=’, the value will be changed to that specified in module_arguments. Note that module_arguments is a list. Please see the examples for usage.



40
 
# File 'lib/ansible/ruby/modules/generated/system/pamd.rb', line 40

attribute :module_arguments

#module_path ⇒ String

Returns The module path of the PAM rule being modified. The type, control and module_path all must match a rule to be modified.

Returns:

  • (String) —

    The module path of the PAM rule being modified. The type, control and module_path all must match a rule to be modified.



24
 
# File 'lib/ansible/ruby/modules/generated/system/pamd.rb', line 24

attribute :module_path

#name ⇒ String

Returns The name generally refers to the PAM service file to change, for example system-auth.

Returns:

  • (String) —

    The name generally refers to the PAM service file to change, for example system-auth.



12
 
# File 'lib/ansible/ruby/modules/generated/system/pamd.rb', line 12

attribute :name

#new_control ⇒ String?

Returns The new control to assign to the new rule.

Returns:

  • (String, nil) —

    The new control to assign to the new rule.



32
 
# File 'lib/ansible/ruby/modules/generated/system/pamd.rb', line 32

attribute :new_control

#new_module_path ⇒ String?

Returns The new module path to be assigned to the new rule.

Returns:

  • (String, nil) —

    The new module path to be assigned to the new rule.



36
 
# File 'lib/ansible/ruby/modules/generated/system/pamd.rb', line 36

attribute :new_module_path

#new_type ⇒ String?

Returns The new type to assign to the new rule.

Returns:

  • (String, nil) —

    The new type to assign to the new rule.



28
 
# File 'lib/ansible/ruby/modules/generated/system/pamd.rb', line 28

attribute :new_type

#path ⇒ String?

Returns This is the path to the PAM service files.

Returns:

  • (String, nil) —

    This is the path to the PAM service files



48
 
# File 'lib/ansible/ruby/modules/generated/system/pamd.rb', line 48

attribute :path

#state ⇒ :updated, ...

Returns The default of ‘updated’ will modify an existing rule if type, control and module_path all match an existing rule. With ‘before’, the new rule will be inserted before a rule matching type, control and module_path. Similarly, with ‘after’, the new rule will be inserted after an existing rule matching type, control and module_path. With either ‘before’ or ‘after’ new_type, new_control, and new_module_path must all be specified. If state is ‘args_absent’ or ‘args_present’, new_type, new_control, and new_module_path will be ignored. State ‘absent’ will remove the rule. The ‘absent’ state was added in version 2.4 and is only available in Ansible versions >= 2.4.

Returns:

  • (:updated, :before, :after, :args_present, :args_absent, :absent, nil) —

    The default of ‘updated’ will modify an existing rule if type, control and module_path all match an existing rule. With ‘before’, the new rule will be inserted before a rule matching type, control and module_path. Similarly, with ‘after’, the new rule will be inserted after an existing rule matching type, control and module_path. With either ‘before’ or ‘after’ new_type, new_control, and new_module_path must all be specified. If state is ‘args_absent’ or ‘args_present’, new_type, new_control, and new_module_path will be ignored. State ‘absent’ will remove the rule. The ‘absent’ state was added in version 2.4 and is only available in Ansible versions >= 2.4.



44
 
# File 'lib/ansible/ruby/modules/generated/system/pamd.rb', line 44

attribute :state

#type ⇒ String

Returns The type of the PAM rule being modified. The type, control and module_path all must match a rule to be modified.

Returns:

  • (String) —

    The type of the PAM rule being modified. The type, control and module_path all must match a rule to be modified.



16
 
# File 'lib/ansible/ruby/modules/generated/system/pamd.rb', line 16

attribute :type