New in version 2.3.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
|
active
bool (added in 2.4) |
|
Specifies whether or not the configuration is active or deactivated
|
|
|
aggregate
(added in 2.4) |
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.aliases: users, collection |
||
| full_name |
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 |
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 |
Deprecated
Starting with Ansible 2.5 we recommend using
connection: network_cli or connection: netconf.For more information please see the Junos OS Platform Options guide.
A dict object containing connection details.
|
||
| username |
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_USERNAME will be used instead. |
||
|
host
required |
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
|
||
| ssh_keyfile |
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_SSH_KEYFILE will be used instead. |
||
| timeout |
Default: 10
|
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
|
|
| password |
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_PASSWORD will be used instead. |
||
| port |
Default: 22
|
Specifies the port to use when building the connection to the remote device. The port value will default to the well known SSH port of 22 (for
transport=cli) or port 830 (for transport=netconf) device. |
|
|
purge
bool |
|
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 |
|
The
role argument defines the role of the user account on the remote system. User accounts can have more than one role configured. |
|
| sshkey |
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 |
|
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 |
|
Note
netconf. See the Junos OS Platform Options.local connections for legacy playbooks.- 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}
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
|
diff.prepared
string
|
when configuration is changed and diff option is enabled. |
Configuration difference before and after applying change.
Sample:
[edit system login] + user test-user { + uid 2005; + class read-only; + }
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as network which means that it is maintained by the Ansible Network Team. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Network Team, see here.
For more information about Red Hat’s support of this module, please refer to this Knowledge Base article
Hint
If you notice any issues in this documentation you can edit this document to improve it.