Try SpotterManage the collection of local users on EOS devices
| "added in version" 2.3 of ansible.builtin"
Authors: Peter Sprygada (@privateip)
preview | supported by network
pipInstall with pip install ansible==2.9.17
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.
- 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
name:
description:
- 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. Please
note that this option is not same as C(provider username).
version_added: '2.4'
version_added_collection: ansible.builtin
role:
description:
- 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.
purge:
default: false
description:
- 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.
type: bool
state:
choices:
- present
- absent
default: present
description:
- 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
sshkey:
description:
- Specifies the SSH public key to configure for the given username. This argument
accepts a valid SSH key value.
provider:
description:
- B(Deprecated)
- 'Starting with Ansible 2.5 we recommend using C(connection: network_cli).'
- 'Starting with Ansible 2.6 we recommend using C(connection: httpapi) for eAPI.'
- This option will be removed in a release after 2022-06-01.
- For more information please see the L(EOS Platform Options guide, ../network/user_guide/platform_eos.html).
- HORIZONTALLINE
- A dict object containing connection details.
suboptions:
auth_pass:
description:
- Specifies the password to use if required to enter privileged mode on the remote
device. If I(authorize) is false, then this argument does nothing. If the value
is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTH_PASS)
will be used instead.
type: str
authorize:
default: false
description:
- 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 C(ANSIBLE_NET_AUTHORIZE) will be used instead.
type: bool
host:
description:
- 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.
type: str
password:
description:
- Specifies the password to use to authenticate the connection to the remote device. This
is a common argument used for either I(cli) or I(eapi) transports. If the value
is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD)
will be used instead.
type: str
port:
default: 0
description:
- Specifies the port to use when building the connection to the remote device. This
value applies to either I(cli) or I(eapi).
- The port value will default to the appropriate transport common port if none
is provided in the task (cli=22, http=80, https=443).
type: int
ssh_keyfile:
description:
- Specifies the SSH keyfile to use to authenticate the connection to the remote
device. This argument is only used for I(cli) transports. If the value is not
specified in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE)
will be used instead.
type: path
timeout:
description:
- 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.
type: int
transport:
choices:
- cli
- eapi
default: cli
description:
- Configures the transport connection to use when connecting to the remote device.
type: str
use_proxy:
default: true
description:
- If C(no), the environment variables C(http_proxy) and C(https_proxy) will be
ignored.
type: bool
use_ssl:
default: true
description:
- Configures the I(transport) to use SSL if set to C(yes) only when the C(transport=eapi). If
the transport argument is not eapi, this value is ignored.
type: bool
username:
description:
- Configures the username to use to authenticate the connection to the remote
device. This value is used to authenticate either the CLI login or the eAPI
authentication depending on which transport is used. If the value is not specified
in the task, the value of environment variable C(ANSIBLE_NET_USERNAME) will
be used instead.
type: str
validate_certs:
default: true
description:
- If C(no), SSL certificates will not be validated. This should only be used on
personally controlled sites using self-signed certificates. If the transport
argument is not eapi, this value is ignored.
type: bool
type: dict
aggregate:
aliases:
- users
- collection
description:
- 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.
version_added: '2.4'
version_added_collection: ansible.builtin
privilege:
description:
- 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.
nopassword:
description:
- Defines the username without assigning a password. This will allow the user to
login to the system without being authenticated by a password.
type: bool
update_password:
choices:
- on_create
- always
default: always
description:
- 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:
description:
- 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 C(provider password).
version_added: '2.4'
version_added_collection: ansible.builtin
commands: description: The list of configuration mode commands to send to the device returned: always sample: - name ansible secret password - name admin secret admin type: list session_name: description: The EOS config session name used to load the configuration returned: when changed is True sample: ansible_1479315771 type: str