junos_user - Manage local user accounts on Juniper JUNOS devices
New in version 2.3.
Synopsis
- This module manages locally configured user accounts on remote network devices running the JUNOS operating system. It provides a set of arguments for creating, removing and updating locally defined accounts
Requirements (on host that executes module)
- ncclient (>=v0.5.2)
Options
parameter | required | default | choices | comments | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
active (added in 2.4)
| no | True |
| Specifies whether or not the configuration is active or deactivated | |||||||||||||||||||||||||||||||||||
aggregate (added in 2.4)
| no | The aggregate argument defines a list of users to be configured on the remote device. The list of users will be compared against the current users and only changes will be added or removed from the device configuration. This argument is mutually exclusive with the name argument. alias users . | |||||||||||||||||||||||||||||||||||||
full_name | no | The full_name argument provides the full name of the user account to be created on the remote device. This argument accepts any text string value. | |||||||||||||||||||||||||||||||||||||
name | no | The name argument defines the username of the user to be created on the system. This argument must follow appropriate usernaming conventions for the target device running JUNOS. This argument is mutually exclusive with the aggregate argument. | |||||||||||||||||||||||||||||||||||||
provider | no | A dict object containing connection details. |
|||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
purge | no | The purge argument instructs the module to consider the users definition absolute. It will remove any previously configured users on the device with the exception of the current defined set of aggregate. | |||||||||||||||||||||||||||||||||||||
role | no |
| The role argument defines the role of the user account on the remote system. User accounts can have more than one role configured. | ||||||||||||||||||||||||||||||||||||
sshkey | no | The sshkey argument defines the public SSH key to be configured for the user account on the remote system. This argument must be a valid SSH key | |||||||||||||||||||||||||||||||||||||
state | no | present |
| The state argument configures the state of the user definitions as it relates to the device operational configuration. When set to present, the user should be configured in the device active configuration and when set to absent the user should not be in the device active configuration |
Examples
- name: create new user account junos_user: name: ansible role: super-user sshkey: "{{ lookup('file', '~/.ssh/ansible.pub') }}" state: present - name: remove a user account junos_user: name: ansible state: absent - name: remove all user accounts except ansible junos_user: aggregate: - name: ansible purge: yes - name: Create list of users junos_user: aggregate: - {name: test_user1, full_name: test_user2, role: operator, state: present} - {name: test_user2, full_name: test_user2, role: read-only, state: present} - name: Delete list of users junos_user: aggregate: - {name: test_user1, full_name: test_user2, role: operator, state: absent} - {name: test_user2, full_name: test_user2, role: read-only, state: absent}
Return Values
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
diff.prepared | Configuration difference before and after applying change. | when configuration is changed and diff option is enabled. | string | [edit system login] + user test-user { + uid 2005; + class read-only; + } |
Notes
Note
- This module requires the netconf system service be enabled on the remote device being managed.
- Tested against vSRX JUNOS version 15.1X49-D15.4, vqfx-10000 JUNOS Version 15.1X53-D60.4.
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance Info
For more information about Red Hat’s this support of this module, please refer to this knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/junos_user_module.html