Class: Ansible::Ruby::Modules::Net_user

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/network/system/net_user.rb

Overview

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

Instance Method Summary

• #aggregate ⇒ Array<Hash>, ...

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

• #configured_password ⇒ Object^?

  The password to be configured on the remote network device.

• #name ⇒ String^?

  The username to be configured on the remote network device.

• #nopassword ⇒ Symbol^?

  Defines the username without assigning a password.

• #privilege ⇒ Integer^?

  The C(privilege) argument configures the privilege level of the user when logged into the system.

• #purge ⇒ Symbol^?

  Instructs the module to consider the resource definition absolute.

• #role ⇒ Object^?

  Configures the role for the username in the device running configuration.

• #sshkey ⇒ String^?

  Specifies the SSH public key to configure for the given username.

• #state ⇒ :present, ...

  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, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

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

Instance Method Details

#aggregate ⇒ Array<Hash>, ...

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

attribute :aggregate

#configured_password ⇒ Object^?

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

attribute :configured_password

#name ⇒ String^?

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

attribute :name

#nopassword ⇒ Symbol^?

# File 'lib/ansible/ruby/modules/generated/network/system/net_user.rb', line 38

attribute :nopassword

#privilege ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/network/system/net_user.rb', line 27

attribute :privilege

#purge ⇒ Symbol^?

# File 'lib/ansible/ruby/modules/generated/network/system/net_user.rb', line 42

attribute :purge

#role ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/system/net_user.rb', line 31

attribute :role

#sshkey ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/network/system/net_user.rb', line 34

attribute :sshkey

#state ⇒ :present, ...

# File 'lib/ansible/ruby/modules/generated/network/system/net_user.rb', line 46

attribute :state

#update_password ⇒ :on_create, ...

# File 'lib/ansible/ruby/modules/generated/network/system/net_user.rb', line 23

attribute :update_password