New in version 2.3.
| parameter | required | default | choices | comments | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| aggregate (added in 2.4) |
no |
The set of username objects to be configured on the remote Arista EOS device. The list entries can either be the username or a hash of username and properties. This argument is mutually exclusive with the
username argument. alias users. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| auth_pass |
no | none |
Specifies the password to use if required to enter privileged mode on the remote device. If authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_AUTH_PASS will be used instead. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| authorize |
no |
|
Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_AUTHORIZE will be used instead. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| configured_password (added in 2.4) |
no |
The password to be configured on the remote Arista EOS 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 (added in 2.4) |
no |
The username to be configured on the remote Arista EOS device. This argument accepts a stringv value and is mutually exclusive with the
aggregate argument. Please note that this option is not same as provider username. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| nopassword |
no |
|
Defines the username without assigning a password. This will allow the user to login to the system without being authenticated by a password.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| privilege |
no |
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| provider |
no |
A dict object containing connection details.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| purge |
no |
|
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 which cannot be deleted per EOS constraints.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| role |
no |
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 |
no |
Specifies the SSH public key to configure for the given username. This argument accepts a valid SSH key value.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| state |
no | present |
|
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 |
no | always |
|
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- name: create a new user eos_user: name: ansible sshkey: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}" state: present - name: remove all users except admin eos_user: purge: yes - name: set multiple users to privilege level 15 eos_user: aggregate: - name: netop - name: netend privilege: 15 state: present - name: Change Password for User netop eos_user: username: netop configured_password: "{{ new_password }}" update_password: always state: present
Common return values are documented here Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| commands |
The list of configuration mode commands to send to the device
|
always | list | ['name ansible secret password', 'name admin secret admin'] |
| session_name |
The EOS config session name used to load the configuration
|
when changed is True | str | ansible_1479315771 |
Note
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
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.