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

Inherits:
Base show all
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 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

#aggregate ⇒ Array<Hash>, ...

Returns The set of username objects to be configured on the remote network 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:

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

    The set of username objects to be configured on the remote network 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/system/net_user.rb', line 12

attribute :aggregate

#configured_password ⇒ Object?

Returns The password to be configured on the remote network device. The password needs to be provided in clear 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 remote network device. The password needs to be provided in clear and it will be encrypted on the device. Please note that this option is not same as C(provider password).



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

attribute :configured_password

#name ⇒ String?

Returns The username to be configured on the remote network device. This argument accepts a string value and is mutually exclusive with the C(aggregate) argument. Please note that this option is not same as C(provider username).

Returns:

  • (String, nil) —

    The username to be configured on the remote network device. This argument accepts a string value and is mutually exclusive with the C(aggregate) argument. Please note that this option is not same as C(provider username).



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

attribute :name

#nopassword ⇒ Symbol?

Returns Defines the username without assigning a password. This will allow the user to login to the system without being authenticated by a password.

Returns:

  • (Symbol, nil) —

    Defines the username without assigning a password. This will allow the user to login to the system without being authenticated by a password.



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

attribute :nopassword

#privilege ⇒ Integer?

Returns The C(privilege) argument configures the privilege level of the user when logged into the system. This argument accepts integer values in the range of 1 to 15.

Returns:

  • (Integer, nil) —

    The C(privilege) argument configures the privilege level of the user when logged into the system. This argument accepts integer values in the range of 1 to 15.



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

attribute :privilege

#purge ⇒ Symbol?

Returns 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 (the current defined set of users).

Returns:

  • (Symbol, nil) —

    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 (the current defined set of users).



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

attribute :purge

#role ⇒ Object?

Returns 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) —

    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.



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

attribute :role

#sshkey ⇒ String?

Returns Specifies the SSH public key to configure for the given username. This argument accepts a valid SSH key value.

Returns:

  • (String, nil) —

    Specifies the SSH public key to configure for the given username. This argument accepts a valid SSH key value.



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

attribute :sshkey

#state ⇒ :present, ...

Returns 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) —

    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



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

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.



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

attribute :update_password