Try SpotterModule to manage the aggregates of local users.
| "added in version" 1.0.0 of cisco.ios"
Authors: Trishna Guha (@trishnaguha)
Install with ansible-galaxy collection install cisco.ios:==8.0.0
collections:
- name: cisco.ios
version: 8.0.0This 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.
# Using state: present
# Before state:
# -------------
# router-ios#show running-config | section ^username
# username testuser privilege 15 password 0 password
# Present state create a new user play:
# -------------------------------------
- name: Create a new user
cisco.ios.ios_user:
name: ansible
nopassword: true
sshkey: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"
state: present
# Task Output
# -----------
# commands:
# - ip ssh pubkey-chain
# - username ansible
# - key-hash ssh-rsa 2ABB27BBC33ED53EF7D55037952ABB27 test@fedora
# - exit
# - exit
# - username ansible nopassword
# After state:
# ------------
# router-ios#show running-config | section username
# username testuser privilege 15 password 0 password
# username ansible nopassword
# username ansible
# key-hash ssh-rsa 2ABB27BBC33ED53EF7D55037952ABB27 test@fedora
# Using state: present
# Before state:
# -------------
# router-ios#show running-config | section ^username
# username testuser privilege 15 password 0 password
# Present state create a new user with multiple keys play:
# --------------------------------------------------------
- name: Create a new user with multiple keys
cisco.ios.ios_user:
name: ansible
sshkey:
- "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"
- "{{ lookup('file', '~/path/to/public_key') }}"
state: present
# Task Output
# -----------
# commands:
# - ip ssh pubkey-chain
# - username ansible
# - key-hash ssh-rsa 2ABB27BBC33ED53EF7D55037952ABB27 test@fedora
# - key-hash ssh-rsa 1985673DCF7FA9A0F374BB97DC2ABB27 test@fedora
# - exit
# - exit
# After state:
# ------------
# router-ios#show running-config | section username
# username testuser privilege 15 password 0 password
# username ansible
# key-hash ssh-rsa 2ABB27BBC33ED53EF7D55037952ABB27 test@fedora
# key-hash ssh-rsa 1985673DCF7FA9A0F374BB97DC2ABB27 test@fedora
# Using Purge: true
# Before state:
# -------------
# router-ios#show running-config | section ^username
# username admin privilege 15 password 0 password
# username testuser privilege 15 password 0 password
# username ansible nopassword
# username ansible
# key-hash ssh-rsa 2ABB27BBC33ED53EF7D55037952ABB27 test@fedora
# Purge all users except admin play:
# ----------------------------------
- name: Remove all users except admin
cisco.ios.ios_user:
purge: true
# Task Output
# -----------
# commands:
# - no username testuser
# - no username ansible
# - ip ssh pubkey-chain
# - no username ansible
# - exit
# After state:
# ------------
# router-ios#show running-config | section username
# username admin privilege 15 password 0 password
# Using Purge: true
# Before state:
# -------------
# router-ios#show running-config | section ^username
# username admin privilege 15 password 0 password
# username testuser privilege 15 password 0 password1
# username testuser1 privilege 15 password 0 password2
# username ansible nopassword
# Purge all users except admin and these listed users play:
# ---------------------------------------------------------
- name: Remove all users except admin and these listed users
cisco.ios.ios_user:
aggregate:
- name: testuser
- name: testuser1
purge: true
# Task Output
# -----------
# commands:
# - no username ansible
# After state:
# ------------
# router-ios#show running-config | section username
# username admin privilege 15 password 0 password
# username testuser privilege 15 password 0 password1
# username testuser1 privilege 15 password 0 password2
# Using state: present
# Before state:
# -------------
# router-ios#show running-config | section ^username
# username admin privilege 15 password 0 password
# username netop password 0 password1
# username netend password 0 password2
# Present state set multiple users to privilege level 15 play:
# ------------------------------------------------------------
- name: Set multiple users to privilege level 15
cisco.ios.ios_user:
aggregate:
- name: netop
- name: netend
privilege: 15
state: present
# Task Output
# -----------
# commands:
# - username netop privilege 15
# - username netend privilege 15
# After state:
# ------------
# router-ios#show running-config | section username
# username admin privilege 15 password 0 password
# username netop privilege 15 password 0 password1
# username netend privilege 15 password 0 password2
# Using state: present
# Before state:
# -------------
# router-ios#show running-config | section ^username
# username admin privilege 15 password 0 password
# username netop privilege 15 password 0 oldpassword
# Present state Change Password for User netop play:
# --------------------------------------------
- name: Change Password for User netop
cisco.ios.ios_user:
name: netop
configured_password: "newpassword"
password_type: password
update_password: always
state: present
# Task Output
# -----------
# commands:
# - username netop password newpassword
# After state:
# ------------
# router-ios#show running-config | section username
# username admin privilege 15 password 0 password
# username netop privilege 15 password 0 newpassword
# Using state: present
# Before state:
# -------------
# router-ios#show running-config | section ^username
# username admin privilege 15 password 0 password
# username netop privilege 15 password 0 password
# username netend privilege 15 password 0 password
# Present state set user view/role for users play:
# --------------------------------------------
- name: Set user view/role for users
cisco.ios.ios_user:
aggregate:
- name: netop
- name: netend
view: network-admin
state: present
# Task Output
# -----------
# commands:
# - username netop view network-admin
# - username netend view network-admin
# After state:
# ------------
# router-ios#show running-config | section username
# username admin privilege 15 password 0 password
# username netop privilege 15 view network-admin password 0 password
# username netend privilege 15 view network-admin password 0 password
# Using state: present
# Before state:
# -------------
# router-ios#show running-config | section ^username
# username admin privilege 15 password 0 password
# Present state create a new user with hashed password play:
# --------------------------------------------------------------
- name: Create a new user with hashed password
cisco.ios.ios_user:
name: ansibletest5
hashed_password:
type: 9
value: "thiswillbereplacedwithhashedpassword"
state: present
# Task Output
# -----------
# commands:
# - username ansibletest5 secret 9 thiswillbereplacedwithhashedpassword
# After state:
# ------------
# router-ios#show running-config | section username
# username admin privilege 15 password 0 password
# username ansibletest5 secret 9 thiswillbereplacedwithhashedpassword
# Using state: absent
# Before state:
# -------------
# router-ios#show running-config | section ^username
# username admin privilege 15 password 0 password
# username ansibletest1 password 0 password
# username ansibletest2 secret 9 thiswillbereplacedwithhashedpassword
# username ansibletest3 password 5 thistoowillbereplacedwithhashedpassword
# Absent state remove multiple users play:
# ----------------------------------------
- name: Delete users with aggregate
cisco.ios.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).
type: str
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.
type: str
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
type: str
sshkey:
description:
- Specifies one or more SSH public key(s) to configure for the given username.
- This argument accepts a valid SSH key value.
elements: str
type: list
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.
elements: dict
suboptions:
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).
type: str
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
type: str
type: dict
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).
required: true
type: str
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
description:
- This argument determines whether a 'password' or 'secret' will be configured.
type: str
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.
type: int
sshkey:
description:
- Specifies one or more SSH public key(s) to configure for the given username.
- This argument accepts a valid SSH key value.
elements: str
type: list
state:
choices:
- present
- absent
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
type: str
update_password:
choices:
- on_create
- 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.
type: str
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.
type: str
type: list
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.
type: int
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.
type: str
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
type: str
type: dict
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.
type: str
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).
type: str
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