community.network.cnos_user – Manage the collection of local users on Lenovo CNOS devices
community.network.cnos_user – Manage the collection of local users on Lenovo CNOS devices
Note
This plugin is part of the community.network collection (version 2.0.1).
To install it use: ansible-galaxy collection install community.network
.
To use it in a playbook, specify: community.network.cnos_user
.
Synopsis
- This module provides declarative management of the local usernames configured on Lenovo CNOS 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 string |
The set of username objects to be configured on the remote Lenovo CNOS device. The list entries can either be the username or a hash of username and properties. This argument is mutually exclusive with the
| |
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. Please note that this option is not same as | |
name string |
The username to be configured on the remote Lenovo CNOS device. This argument accepts a string value and is mutually exclusive with the | |
purge boolean |
|
The |
role string |
The
| |
sshkey string |
The | |
state string |
|
The |
update_password string |
|
Since passwords are encrypted in the device running config, this argument will instruct the module when to change the password. When set to |
Examples
- name: Create a new user
community.network.cnos_user:
name: ansible
sshkey: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"
state: present
- name: Remove all users except admin
community.network.cnos_user:
purge: yes
- name: Set multiple users role
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 / elements=string |
always |
The list of configuration mode commands to send to the device
Sample: ['name ansible', 'name ansible password password'] |
delta string |
always |
The time elapsed to perform all operations
Sample: 0:00:10.469466 |
end string |
always |
The time the job ended
Sample: 2016-11-16 10:38:25.595612 |
start string |
always |
The time the job started
Sample: 2016-11-16 10:38:15.126146 |
Authors
- Anil Kumar Muraleedharan (@amuraleedhar)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/cnos_user_module.html