cisco.nxos.nxos_user_module.rst

cisco.nxos.nxos_user

Manage the collection of local users on Nexus devices

Version added: 1.0.0

Synopsis

• This module provides declarative management of the local usernames configured on Cisco Nexus 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.

Parameters

Parameter		Choices/Defaults	Comments
aggregate list / elements=dictionary			The set of username objects to be configured on the remote Cisco Nexus device. The list entries can either be the username or a hash of username and properties. This argument is mutually exclusive with the name argument. aliases: users, collection
	configured_password string		The password to be configured on the network device. The password needs to be provided in cleartext and it will be encrypted on the device.
	hashed_password string		The hashed password to be configured on the network device. The password needs to already be encrypted.
	name string		The username to be configured on the remote Cisco Nexus device. This argument accepts a string value and is mutually exclusive with the aggregate argument.
	roles list / elements=string		The role argument configures the role for the username in the device running configuration. The argument accepts a string value defining the role name. This argument does not check if the role has been configured on the device. aliases: role
	sshkey string		The sshkey argument defines the SSH public key to configure for the username. This argument accepts a valid SSH key value.
	state string	Choices: present absent	The state argument configures the state of the username definition as it relates to the device operational configuration. When set to present, the username(s) should be configured in the device active configuration and when set to absent the username(s) should not be in the device active configuration
	update_password string	Choices: on_create always	Since passwords are encrypted in the device running config, this argument will instruct the module when to change the password. When set to always, the password will always be updated in the device and when set to on_create the password will be updated only if the username is created.
configured_password string			The password to be configured on the network device. The password needs to be provided in cleartext and it will be encrypted on the device.
hashed_password string			The hashed password to be configured on the network device. The password needs to already be encrypted.
name string			The username to be configured on the remote Cisco Nexus device. This argument accepts a string value and is mutually exclusive with the aggregate argument.
purge boolean		Choices: no ← yes	The purge argument 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 which cannot be deleted per nxos constraints.
roles list / elements=string			The role argument configures the role for the username in the device running configuration. The argument accepts a string value defining the role name. This argument does not check if the role has been configured on the device. aliases: role
sshkey string			The sshkey argument defines the SSH public key to configure for the username. This argument accepts a valid SSH key value.
state string		Choices: present ← absent	The state argument configures the state of the username definition as it relates to the device operational configuration. When set to present, the username(s) should be configured in the device active configuration and when set to absent the username(s) should not be in the device active configuration
update_password string		Choices: on_create always ←	Since passwords are encrypted in the device running config, this argument will instruct the module when to change the password. When set to always, the password will always be updated in the device and when set to on_create the password will be updated only if the username is created.

Notes

Note

- Limited Support for Cisco MDS - For information on using CLI and NX-API see the NXOS Platform Options guide <nxos_platform_options> - For more information on using Ansible to manage network devices see the Ansible Network Guide <network_guide> - For more information on using Ansible to manage Cisco devices see the Cisco integration page.

Examples

- name: create a new user
  cisco.nxos.nxos_user:
    name: ansible
    sshkey: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"
    state: present

- name: remove all users except admin
  cisco.nxos.nxos_user:
    purge: true

- name: set multiple users role
  cisco.nxos.nxos_user:
    aggregate:
      - name: netop
      - name: netend
    role: network-operator
  state: present

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
commands list	always	The list of configuration mode commands to send to the device Sample: ['name ansible', 'name ansible password password']

Status

Authors

• Peter Sprygada (@privateip)