ansible / ansible.builtin / v2.9.3 / module / ios_user Manage the aggregate of local users on Cisco IOS device | "added in version" 2.4 of ansible.builtin" Authors: Trishna Guha (@trishnaguha) preview | supported by networkansible.builtin.ios_user (v2.9.3) — module
pip
Install with pip install ansible==2.9.3
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 ios_user: name: ansible nopassword: True sshkey: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}" state: present
- name: create a new user with multiple keys ios_user: name: ansible sshkey: - "{{ lookup('file', '~/.ssh/id_rsa.pub') }}" - "{{ lookup('file', '~/path/to/public_key') }}" state: present
- name: remove all users except admin ios_user: purge: yes
- name: remove all users except admin and these listed users ios_user: aggregate: - name: testuser1 - name: testuser2 - name: testuser3 purge: yes
- name: set multiple users to privilege level 15 ios_user: aggregate: - name: netop - name: netend privilege: 15 state: present
- name: set user view/role ios_user: name: netop view: network-operator state: present
- name: Change Password for User netop ios_user: name: netop configured_password: "{{ new_password }}" update_password: always state: present
- name: Aggregate of users ios_user: aggregate: - name: ansibletest2 - name: ansibletest3 view: network-admin
- name: Add a user specifying password type ios_user: name: ansibletest4 configured_password: "{{ new_password }}" password_type: password
- name: Add a user with MD5 hashed password ios_user: name: ansibletest5 hashed_password: type: 5 value: $3$8JcDilcYgFZi.yz4ApaqkHG2.8/
- name: Delete users with aggregate ios_user: aggregate: - name: ansibletest1 - name: ansibletest2 - name: ansibletest3 state: absent
name: description: - The username to be configured on the Cisco IOS 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). view: aliases: - role description: - Configures the view for the username in the device running configuration. The argument accepts a string value defining the view name. This argument does not check if the view 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 (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 sshkey: description: - Specifies one or more SSH public key(s) to configure for the given username. - This argument accepts a valid SSH key value. version_added: '2.7' 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 U(https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.html). - HORIZONTALLINE - A dict object containing connection details. suboptions: auth_pass: description: - Specifies the password to use if required to enter privileged mode on the remote device. If I(authorize) is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. type: str authorize: default: false description: - Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTHORIZE) will be used instead. type: bool 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. 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: 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: 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 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. privilege: description: - 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. nopassword: description: - Defines the username without assigning a password. This will allow the user to login to the system without being authenticated by a password. type: bool password_type: choices: - secret - password default: secret description: - This argument determines whether a 'password' or 'secret' will be configured. version_added: '2.8' version_added_collection: ansible.builtin hashed_password: description: - This option allows configuring hashed passwords on Cisco IOS devices. suboptions: type: description: - Specifies the type of hash (e.g., 5 for MD5, 8 for PBKDF2, etc.) - For this to work, the device needs to support the desired hash type required: true type: int value: description: - The actual hashed password to be configured on the device required: true version_added: '2.8' 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 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).
commands: description: The list of configuration mode commands to send to the device returned: always sample: - username ansible secret password - username admin secret admin type: list