ansible.netcommon.net_user – (deprecated, removed after 2022-06-01) Manage the aggregate of local users on network device
Note
This plugin is part of the ansible.netcommon collection (version 2.5.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install ansible.netcommon
.
To use it in a playbook, specify: ansible.netcommon.net_user
.
New in version 1.0.0: of ansible.netcommon
DEPRECATED
- Removed in
major release after 2022-06-01
- Why
Updated modules released with more functionality
- Alternative
Use platform-specific “[netos]_user” module
Synopsis
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.
Note
This module has a corresponding action plugin.
Parameters
Parameter |
Comments |
---|---|
The set of username objects to be configured on the remote network device. The list entries can either be the username or a hash of username and properties. This argument is mutually exclusive with the |
|
The password to be configured on the remote network 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 |
|
The username to be configured on the remote network device. This argument accepts a string value and is mutually exclusive with the |
|
Defines the username without assigning a password. This will allow the user to login to the system without being authenticated by a password. Choices:
|
|
The |
|
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). Choices:
|
|
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. |
|
Specifies the SSH public key to configure for the given username. This argument accepts a valid SSH key value. |
|
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 Choices:
|
|
Since passwords are encrypted in the device running config, this argument will instruct the module when to change the password. When set to Choices:
|
Notes
Note
This module is supported on
ansible_network_os
network platforms. See the Network Platform Options for details.
Examples
- name: create a new user
ansible.netcommon.net_user:
name: ansible
sshkey: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"
state: present
- name: remove all users except admin
ansible.netcommon.net_user:
purge: yes
- name: set multiple users to privilege level 15
ansible.netcommon.net_user:
aggregate:
- {name: netop}
- {name: netend}
privilege: 15
state: present
- name: Change Password for User netop
ansible.netcommon.net_user:
name: netop
configured_password: '{{ new_password }}'
update_password: always
state: present
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The list of configuration mode commands to send to the device Returned: always Sample: [“username ansible secret password”, “username admin secret admin”] |
Status
This module will be removed in a major release after 2022-06-01. [deprecated]
For more information see DEPRECATED.
Authors
Trishna Guha (@trishnaguha)