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

Inherits:

Base

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

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

• #aggregate ⇒ Object^?

  The set of username objects to be configured on the remote Cisco Nexus device.

• #configured_password ⇒ Object^?

  The password to be configured on the network device.

• #name ⇒ String^?

  The username to be configured on the remote Cisco Nexus device.

• #purge ⇒ :yes, ...

  The C(purge) argument instructs the module to consider the resource definition absolute.

• #role ⇒ Object^?

  The C(role) argument configures the role for the username in the device running configuration.

• #sshkey ⇒ String^?

  The C(sshkey) argument defines the SSH public key to configure for the username.

• #state ⇒ :present, ...

  The C(state) argument configures the state of the username definition as it relates to the device operational configuration.

• #update_password ⇒ :on_create, ...

  Since passwords are encrypted in the device running config, this argument will instruct the module when to change the password.

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

#aggregate ⇒ Object^?

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

attribute :aggregate

#configured_password ⇒ Object^?

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

attribute :configured_password

#name ⇒ String^?

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

attribute :name

#purge ⇒ :yes, ...

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

attribute :purge

#role ⇒ Object^?

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

attribute :role

#sshkey ⇒ String^?

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

attribute :sshkey

#state ⇒ :present, ...

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

attribute :state

#update_password ⇒ :on_create, ...

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

attribute :update_password