Note
This plugin is part of the ansible.netcommon collection (version 1.5.0).
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
major release after 2022-06-01
Updated modules released with more functionality
Use platform-specific “[netos]_user” module
Note
This module has a corresponding action plugin.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| aggregate string | 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 name argument. | |
| configured_password string | 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 provider password. | |
| name string | The username to be configured on the remote network device. This argument accepts a string value and is mutually exclusive with the aggregate argument. Please note that this option is not same as provider username. | |
| nopassword boolean |
| Defines the username without assigning a password. This will allow the user to login to the system without being authenticated by a password. |
| privilege string | The 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. | |
| purge boolean |
| 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). |
| role string | 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. | |
| sshkey string | Specifies the SSH public key to configure for the given username. This argument accepts a valid SSH key value. | |
| state string |
| 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 |
| 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. |
Note
ansible_network_os network platforms. See the Network Platform Options for details.- 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
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: ['username ansible secret password', 'username admin secret admin'] |
© 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/ansible/netcommon/net_user_module.html