Class: Ansible::Ruby::Modules::Iosxr_user

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/network/iosxr/iosxr_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 Cisco IOS XR 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 Cisco IOS XR 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/iosxr/iosxr_user.rb', line 12

attribute :aggregate

#configured_password ⇒ String?

Returns The password to be configured on the Cisco IOS XR device. The password needs to be provided in clear text. Password is encrypted on the device when used with I(cli) and by Ansible when used with I(netconf) using the same MD5 hash technique with salt size of 3. Please note that this option is not same as C(provider password).

Returns:

  • (String, nil) —

    The password to be configured on the Cisco IOS XR device. The password needs to be provided in clear text. Password is encrypted on the device when used with I(cli) and by Ansible when used with I(netconf) using the same MD5 hash technique with salt size of 3. Please note that this option is not same as C(provider password).



20
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_user.rb', line 20

attribute :configured_password

#group ⇒ String?

Returns Configures the group for the username in the device running configuration. The argument accepts a string value defining the group name. This argument does not check if the group has been configured on the device.

Returns:

  • (String, nil) —

    Configures the group for the username in the device running configuration. The argument accepts a string value defining the group name. This argument does not check if the group has been configured on the device.



28
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_user.rb', line 28

attribute :group

#groups ⇒ Array<String>, ...

Returns Configures the groups for the username in the device running configuration. The argument accepts a list of group names. This argument does not check if the group has been configured on the device. It is similar to the aggregrate command for usernames, but lets you configure multiple groups for the user(s).

Returns:

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

    Configures the groups for the username in the device running configuration. The argument accepts a list of group names. This argument does not check if the group has been configured on the device. It is similar to the aggregrate command for usernames, but lets you configure multiple groups for the user(s).



32
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_user.rb', line 32

attribute :groups

#name ⇒ String?

Returns The username to be configured on the Cisco IOS XR 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 Cisco IOS XR 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/iosxr/iosxr_user.rb', line 16

attribute :name

#public_key ⇒ Object?

Returns Configures the contents of the public keyfile to upload to the IOS-XR node. This enables users to login using the accompanying private key. IOS-XR only accepts base64 decoded files, so this will be decoded and uploaded to the node. Do note that this requires an OpenSSL public key file, PuTTy generated files will not work! Mutually exclusive with public_key_contents. If used with multiple users in aggregates, then the same key file is used for all users.

Returns:

  • (Object, nil) —

    Configures the contents of the public keyfile to upload to the IOS-XR node. This enables users to login using the accompanying private key. IOS-XR only accepts base64 decoded files, so this will be decoded and uploaded to the node. Do note that this requires an OpenSSL public key file, PuTTy generated files will not work! Mutually exclusive with public_key_contents. If used with multiple users in aggregates, then the same key file is used for all users.



44
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_user.rb', line 44

attribute :public_key

#public_key_contents ⇒ String?

Returns Configures the contents of the public keyfile to upload to the IOS-XR node. This enables users to login using the accompanying private key. IOS-XR only accepts base64 decoded files, so this will be decoded and uploaded to the node. Do note that this requires an OpenSSL public key file, PuTTy generated files will not work! Mutually exclusive with public_key.If used with multiple users in aggregates, then the same key file is used for all users.

Returns:

  • (String, nil) —

    Configures the contents of the public keyfile to upload to the IOS-XR node. This enables users to login using the accompanying private key. IOS-XR only accepts base64 decoded files, so this will be decoded and uploaded to the node. Do note that this requires an OpenSSL public key file, PuTTy generated files will not work! Mutually exclusive with public_key.If used with multiple users in aggregates, then the same key file is used for all users.



47
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_user.rb', line 47

attribute :public_key_contents

#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 and 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 and the current defined set of users.



36
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_user.rb', line 36

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



40
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_user.rb', line 40

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.



24
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_user.rb', line 24

attribute :update_password