Class: Ansible::Ruby::Modules::Vyos_user

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/network/vyos/vyos_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 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, 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 VyOS 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 VyOS 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/vyos/vyos_user.rb', line 12

attribute :aggregate

#configured_password ⇒ String?

Returns The password to be configured on the VyOS 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:

  • (String, nil) —

    The password to be configured on the VyOS 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).



23
 
# File 'lib/ansible/ruby/modules/generated/network/vyos/vyos_user.rb', line 23

attribute :configured_password

#full_name ⇒ Object?

Returns The C(full_name) argument provides the full name of the user account to be created on the remote device. This argument accepts any text string value.

Returns:

  • (Object, nil) —

    The C(full_name) argument provides the full name of the user account to be created on the remote device. This argument accepts any text string value.



20
 
# File 'lib/ansible/ruby/modules/generated/network/vyos/vyos_user.rb', line 20

attribute :full_name

#level ⇒ String?

Returns The C(level) argument configures the level of the user when logged into the system. This argument accepts string values admin or operator.

Returns:

  • (String, nil) —

    The C(level) argument configures the level of the user when logged into the system. This argument accepts string values admin or operator.



31
 
# File 'lib/ansible/ruby/modules/generated/network/vyos/vyos_user.rb', line 31

attribute :level

#name ⇒ String?

Returns The username to be configured on the VyOS 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 VyOS 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/vyos/vyos_user.rb', line 16

attribute :name

#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).



35
 
# File 'lib/ansible/ruby/modules/generated/network/vyos/vyos_user.rb', line 35

attribute :purge

#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



39
 
# File 'lib/ansible/ruby/modules/generated/network/vyos/vyos_user.rb', line 39

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.



27
 
# File 'lib/ansible/ruby/modules/generated/network/vyos/vyos_user.rb', line 27

attribute :update_password