Class: Ansible::Ruby::Modules::Nxos_user

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

Overview

This module provides declarative management of the local usernames configured on Cisco Nexus devices. It allows playbooks to manage either individual usernames or the collection of usernames in the current running config. It also supports purging usernames from the configuration that are not explicitly defined.

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

#aggregate ⇒ Object?

Returns The set of username objects to be configured on the remote Cisco Nexus device. The list entries can either be the username or a hash of username and properties. This argument is mutually exclusive with the C(name) argument.

Returns:

  • (Object, nil) —

    The set of username objects to be configured on the remote Cisco Nexus device. The list entries can either be the username or a hash of username and properties. This argument is mutually exclusive with the C(name) argument.



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

attribute :aggregate

#configured_password ⇒ Object?

Returns The password to be configured on the network device. The password needs to be provided in cleartext and it will be encrypted on the device. Please note that this option is not same as C(provider password).

Returns:

  • (Object, nil) —

    The password to be configured on the network device. The password needs to be provided in cleartext and it will be encrypted on the device. Please note that this option is not same as C(provider password).



19
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_user.rb', line 19

attribute :configured_password

#name ⇒ String?

Returns The username to be configured on the remote Cisco Nexus device. This argument accepts a string value and is mutually exclusive with the C(aggregate) argument.

Returns:

  • (String, nil) —

    The username to be configured on the remote Cisco Nexus device. This argument accepts a string value and is mutually exclusive with the C(aggregate) argument.



15
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_user.rb', line 15

attribute :name

#purge ⇒ :yes, ...

Returns The C(purge) argument instructs the module to consider the resource definition absolute. It will remove any previously configured usernames on the device with the exception of the ‘admin` user which cannot be deleted per nxos constraints.

Returns:

  • (:yes, :no, nil) —

    The C(purge) argument instructs the module to consider the resource definition absolute. It will remove any previously configured usernames on the device with the exception of the ‘admin` user which cannot be deleted per nxos constraints.



33
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_user.rb', line 33

attribute :purge

#role ⇒ Object?

Returns The C(role) argument configures the role for the username in the device running configuration. The argument accepts a string value defining the role name. This argument does not check if the role has been configured on the device.

Returns:

  • (Object, nil) —

    The C(role) argument configures the role for the username in the device running configuration. The argument accepts a string value defining the role name. This argument does not check if the role has been configured on the device.



26
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_user.rb', line 26

attribute :role

#sshkey ⇒ String?

Returns The C(sshkey) argument defines the SSH public key to configure for the username. This argument accepts a valid SSH key value.

Returns:

  • (String, nil) —

    The C(sshkey) argument defines the SSH public key to configure for the username. This argument accepts a valid SSH key value.



29
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_user.rb', line 29

attribute :sshkey

#state ⇒ :present, ...

Returns The C(state) argument configures the state of the username definition as it relates to the device operational configuration. When set to I(present), the username(s) should be configured in the device active configuration and when set to I(absent) the username(s) should not be in the device active configuration.

Returns:

  • (:present, :absent, nil) —

    The C(state) argument configures the state of the username definition as it relates to the device operational configuration. When set to I(present), the username(s) should be configured in the device active configuration and when set to I(absent) the username(s) should not be in the device active configuration



37
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_user.rb', line 37

attribute :state

#update_password ⇒ :on_create, ...

Returns Since passwords are encrypted in the device running config, this argument will instruct the module when to change the password. When set to C(always), the password will always be updated in the device and when set to C(on_create) the password will be updated only if the username is created.

Returns:

  • (:on_create, :always, nil) —

    Since passwords are encrypted in the device running config, this argument will instruct the module when to change the password. When set to C(always), the password will always be updated in the device and when set to C(on_create) the password will be updated only if the username is created.



22
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_user.rb', line 22

attribute :update_password