eos_system - Manage the system attributes on Arista EOS devices

New in version 2.3.

Synopsis

Parameters

Parameter Choices/Defaults Comments
auth_pass
Deprecated
Starting with Ansible 2.5 we recommend using connection: network_cli and become: yes with become_pass.
This option is only required if you are using eAPI.
For more information please see the EOS Platform Options guide.

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
bool
    Choices:
  • no ←
  • yes
Deprecated
Starting with Ansible 2.5 we recommend using connection: network_cli and become: yes.
This option is only required if you are using eAPI.
For more information please see the EOS Platform Options guide.

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.
domain_name
Configure the IP domain name on the remote device to the provided value. Value should be in the dotted name form and will be appended to the hostname to create a fully-qualified domain name.
domain_search
Provides the list of domain suffixes to append to the hostname for the purpose of doing name resolution. This argument accepts a list of names and will be reconciled with the current active configuration on the running node.

aliases: domain_list
hostname
Configure the device hostname parameter. This option takes an ASCII string value.
lookup_source
Provides one or more source interfaces to use for performing DNS lookups. The interface provided in lookup_source can only exist in a single VRF. This argument accepts either a list of interface names or a list of hashes that configure the interface name and VRF name. See examples.
name_servers
List of DNS name servers by IP address to use to perform name resolution lookups. This argument accepts either a list of DNS servers or a list of hashes that configure the name server and VRF name. See examples.
provider
Deprecated
Starting with Ansible 2.5 we recommend using connection: network_cli.
This option is only required if you are using eAPI.
For more information please see the EOS 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 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 ANSIBLE_NET_USERNAME will be used instead.
authorize
bool
    Choices:
  • no ←
  • yes
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.
ssh_keyfile
Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
use_proxy
bool

(added in 2.5)
    Choices:
  • no
  • yes ←
If no, the environment variables http_proxy and https_proxy will be ignored.
auth_pass
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.
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.
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.
use_ssl
bool
    Choices:
  • no
  • yes ←
Configures the transport to use SSL if set to true only when the transport=eapi. If the transport argument is not eapi, this value is ignored.
password
Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either cli or eapi transports. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
validate_certs
bool
    Choices:
  • no
  • yes
If 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.
port Default:
0 (use common port)
Specifies the port to use when building the connection to the remote device. This value applies to either cli or 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).
transport
required
    Choices:
  • eapi
  • cli ←
Configures the transport connection to use when connecting to the remote device.
state
    Choices:
  • present ←
  • absent
State of the configuration values in the device's current active configuration. When set to present, the values should be configured in the device active configuration and when set to absent the values should not be in the device active configuration

Notes

Note

Examples

- name: configure hostname and domain-name
  eos_system:
    hostname: eos01
    domain_name: test.example.com

- name: remove configuration
  eos_system:
    state: absent

- name: configure DNS lookup sources
  eos_system:
    lookup_source: Management1

- name: configure DNS lookup sources with VRF support
  eos_system:
      lookup_source:
        - interface: Management1
          vrf: mgmt
        - interface: Ethernet1
          vrf: myvrf

- name: configure name servers
  eos_system:
    name_servers:
      - 8.8.8.8
      - 8.8.4.4

- name: configure name servers with VRF support
  eos_system:
    name_servers:
      - { server: 8.8.8.8, vrf: mgmt }
      - { server: 8.8.4.4, vrf: mgmt }

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
commands
list
always
The list of configuration mode commands to send to the device

Sample:
['hostname eos01', 'ip domain-name test.example.com']
session_name
str
changed
The EOS config session name used to load the configuration

Sample:
ansible_1479315771


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

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.

Support

For more information about Red Hat’s support of this module, please refer to this Knowledge Base article

Author

  • Peter Sprygada (@privateip)

Hint

If you notice any issues in this documentation you can edit this document to improve it.