Skip to content

eos_user

Collection Note

This module is part of the arista.eos collection. To install the collection, use:

ansible-galaxy collection install arista.eos
Added in version 1.0.0.

Synopsis

  • This module provides declarative management of the local usernames configured on Arista EOS devices. It allows playbooks to manage either individual usernames or the collection of usernames in the current running config. It also supports purging usernames from the configuration that are not explicitly defined.

Parameters

Parameter Defaults / Choices Comments
aggregate
list / elements=dict		 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 C(username) argument.
aggregate.configured_password 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.
aggregate.name The username to be configured on the remote Arista EOS device. This argument accepts a stringv value and is mutually exclusive with the C(aggregate) argument.
aggregate.nopassword Defines the username without assigning a password. This will allow the user to login to the system without being authenticated by a password.
aggregate.privilege The C(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.
aggregate.role 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.
aggregate.sshkey Specifies the SSH public key to configure for the given username. This argument accepts a valid SSH key value.
aggregate.state Choices: present, absent Configures the state of the username definition as it relates to the device operational configuration. When set to I(present), the username(s) should be configured in the device active configuration and when set to I(absent) the username(s) should not be in the device active configuration
aggregate.update_password Choices: on_create, always Since passwords are encrypted in the device running config, this argument will instruct the module when to change the password. When set to C(always), the password will always be updated in the device and when set to C(on_create) the password will be updated only if the username is created.
configured_password
str		 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.
name
str		 The username to be configured on the remote Arista EOS device. This argument accepts a stringv value and is mutually exclusive with the C(aggregate) argument.
nopassword
bool		 Defines the username without assigning a password. This will allow the user to login to the system without being authenticated by a password.
privilege
int		 The C(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
bool		 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
str		 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
str		 Specifies the SSH public key to configure for the given username. This argument accepts a valid SSH key value.
state
str		 Default: present
Choices: present, absent		 Configures the state of the username definition as it relates to the device operational configuration. When set to I(present), the username(s) should be configured in the device active configuration and when set to I(absent) the username(s) should not be in the device active configuration
update_password
str		 Default: always
Choices: on_create, always		 Since passwords are encrypted in the device running config, this argument will instruct the module when to change the password. When set to C(always), the password will always be updated in the device and when set to C(on_create) the password will be updated only if the username is created.

Notes

Note

  • Tested against Arista EOS 4.24.6F

Examples

- name: create a new user
  arista.eos.eos_user:
    name: ansible
    sshkey: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"
    state: present

- name: remove all users except admin
  arista.eos.eos_user:
    purge: true

- name: set multiple users to privilege level 15
  arista.eos.eos_user:
    aggregate:
      - name: netop
      - name: netend
    privilege: 15
    state: present

- name: Change Password for User netop
  arista.eos.eos_user:
    username: netop
    configured_password: '{{ new_password }}'
    update_password: always
    state: present

Return Values

Key Data Type Description Returned
commands list The list of configuration mode commands to send to the device always
session_name str The EOS config session name used to load the configuration when changed is True

Authors

  • Peter Sprygada (@privateip)