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 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
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¶
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:
Status¶
This module will be removed in a major release after 2022-06-01. [deprecated]
For more information see DEPRECATED.
Authors¶
Trishna Guha (@trishnaguha)