arista.eos.eos_system module – Manage the system attributes on Arista EOS devices
Note
This module is part of the arista.eos collection (version 9.0.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install arista.eos
.
To use it in a playbook, specify: arista.eos.eos_system
.
New in arista.eos 1.0.0
Synopsis
This module provides declarative management of node system attributes on Arista EOS devices. It provides an option to configure host system parameters or remove those parameters from the device active configuration.
Aliases: system
Parameters
Parameter |
Comments |
---|---|
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. |
|
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 |
|
Configure the device hostname parameter. This option takes an ASCII string value. |
|
Provides one or more source interfaces to use for performing DNS lookups. The interface provided in |
|
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. |
|
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 Choices:
|
Notes
Note
Tested against Arista EOS 4.24.6F
Examples
- name: configure hostname and domain-name
arista.eos.eos_system:
hostname: eos01
domain_name: test.example.com
- name: remove configuration
arista.eos.eos_system:
state: absent
- name: configure DNS lookup sources
arista.eos.eos_system:
lookup_source: Management1
- name: configure DNS lookup sources with VRF support
arista.eos.eos_system:
lookup_source:
- interface: Management1
vrf: mgmt
- interface: Ethernet1
vrf: myvrf
- name: configure name servers
arista.eos.eos_system:
name_servers:
- 8.8.8.8
- 8.8.4.4
- name: configure name servers with VRF support
arista.eos.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 |
Description |
---|---|
The list of configuration mode commands to send to the device Returned: always Sample: |
|
The EOS config session name used to load the configuration Returned: changed Sample: |