ansible / ansible.builtin / v2.9.13 / module / iosxr_user Manage the aggregate of local users on Cisco IOS XR device | "added in version" 2.4 of ansible.builtin" Authors: Trishna Guha (@trishnaguha), Sebastiaan van Doesselaar (@sebasdoes), Kedar Kekan (@kedarX) preview | supported by networkansible.builtin.iosxr_user (v2.9.13) — module
pip
Install with pip install ansible==2.9.13
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.
- name: create a new user iosxr_user: name: ansible configured_password: mypassword state: present
- name: create a new user in admin configuration mode iosxr_user: name: ansible configured_password: mypassword admin: True state: present
- name: remove all users except admin iosxr_user: purge: True
- name: set multiple users to group sys-admin iosxr_user: aggregate: - name: netop - name: netend group: sysadmin state: present
- name: set multiple users to multiple groups iosxr_user: aggregate: - name: netop - name: netend groups: - sysadmin - root-system state: present
- name: Change Password for User netop iosxr_user: name: netop configured_password: "{{ new_password }}" update_password: always state: present
- name: Add private key authentication for user netop iosxr_user: name: netop state: present public_key_contents: "{{ lookup('file', '/home/netop/.ssh/id_rsa.pub' }}"
name: description: - 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). admin: default: false description: - Enters into administration configuration mode for making config changes to the device. - Applicable only when using network_cli transport type: bool version_added: '2.8' version_added_collection: ansible.builtin group: aliases: - role description: - 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. purge: default: false description: - 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. type: bool state: choices: - present - absent default: present description: - 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 groups: description: - 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 aggregate command for usernames, but lets you configure multiple groups for the user(s). version_added: '2.5' version_added_collection: ansible.builtin provider: description: - B(Deprecated) - 'Starting with Ansible 2.5 we recommend using C(connection: network_cli).' - For more information please see the L(Network Guide, ../network/getting_started/network_differences.html#multiple-communication-protocols). - HORIZONTALLINE - A dict object containing connection details. suboptions: host: description: - Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. required: true type: str password: description: - Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. type: str port: default: 22 description: - Specifies the port to use when building the connection to the remote device. type: int ssh_keyfile: description: - Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. type: path timeout: default: 10 description: - Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. type: int username: description: - Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. type: str type: dict aggregate: aliases: - users - collection description: - 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. public_key: description: - 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. version_added: '2.5' version_added_collection: ansible.builtin update_password: choices: - on_create - always default: always description: - 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. configured_password: description: - 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). public_key_contents: description: - 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. version_added: '2.5' version_added_collection: ansible.builtin
commands: description: The list of configuration mode commands to send to the device returned: always sample: - username ansible secret password group sysadmin - username admin secret admin type: list xml: description: NetConf rpc xml sent to device with transport C(netconf) returned: always (empty list when no xml rpc to send) sample: - <config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0"> <aaa xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-aaa-lib-cfg"> <usernames xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-aaa-locald-cfg"> <username xc:operation="merge"> <name>test7</name> <usergroup-under-usernames> <usergroup-under-username> <name>sysadmin</name> </usergroup-under-username> </usergroup-under-usernames> <secret>$1$ZsXC$zZ50wqhDC543ZWQkkAHLW0</secret> </username> </usernames> </aaa> </config> type: list version_added: 2.5 version_added_collection: ansible.builtin