Class: Ansible::Ruby::Modules::Nxos_snmp_user

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/network/nxos/nxos_snmp_user.rb

Overview

Manages SNMP user configuration.

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

#authentication ⇒ :md5, ...

Returns Authentication parameters for the user.

Returns:

  • (:md5, :sha, nil) —

    Authentication parameters for the user.



20
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_snmp_user.rb', line 20

attribute :authentication

#encrypt ⇒ Symbol?

Returns Enables AES-128 bit encryption when using privacy password.

Returns:

  • (Symbol, nil) —

    Enables AES-128 bit encryption when using privacy password.



31
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_snmp_user.rb', line 31

attribute :encrypt

#group ⇒ String?

Returns Group to which the user will belong to. If state = present, and the user is existing, the group is added to the user. If the user is not existing, user entry is created with this group argument. If state = absent, only the group is removed from the user entry. However, to maintain backward compatibility, if the existing user belongs to only one group, and if group argument is same as the existing user’s group, then the user entry also is deleted.

Returns:

  • (String, nil) —

    Group to which the user will belong to. If state = present, and the user is existing, the group is added to the user. If the user is not existing, user entry is created with this group argument. If state = absent, only the group is removed from the user entry. However, to maintain backward compatibility, if the existing user belongs to only one group, and if group argument is same as the existing user’s group, then the user entry also is deleted.



16
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_snmp_user.rb', line 16

attribute :group

#privacy ⇒ Object?

Returns Privacy password for the user. This is not idempotent.

Returns:

  • (Object, nil) —

    Privacy password for the user. This is not idempotent



28
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_snmp_user.rb', line 28

attribute :privacy

#pwd ⇒ String?

Returns Authentication password when using md5 or sha. This is not idempotent.

Returns:

  • (String, nil) —

    Authentication password when using md5 or sha. This is not idempotent



24
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_snmp_user.rb', line 24

attribute :pwd

#state ⇒ :present, ...

Returns Manage the state of the resource.

Returns:

  • (:present, :absent, nil) —

    Manage the state of the resource.



35
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_snmp_user.rb', line 35

attribute :state

#user ⇒ String

Returns Name of the user.

Returns:

  • (String) —

    Name of the user.



12
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_snmp_user.rb', line 12

attribute :user