You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

arista.eos.eos_facts module – Collect facts from remote devices running Arista EOS

Note

This module is part of the arista.eos collection (version 3.1.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_facts.

New in version 1.0.0: of arista.eos

Synopsis

• Collects facts from Arista devices running the EOS operating system. This module places the facts gathered in the fact tree keyed by the respective resource name. The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.

Note

This module has a corresponding action plugin.

Parameters

Parameter	Comments
available_network_resources boolean	When ‘True’ a list of network resources for which resource modules are available will be provided. Choices: no ← (default) yes
gather_network_resources list / elements=string	When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all and the resources like interfaces, vlans etc. Can specify a list of values to include a larger subset. Values can also be used with an initial M(!) to specify that a specific subset should not be collected. Values can also be used with an initial M(!) to specify that a specific subset should not be collected. Valid subsets are ‘all’, ‘interfaces’, ‘l2_interfaces’, ‘l3_interfaces’, ‘lacp’, ‘lacp_interfaces’, ‘lag_interfaces’, ‘lldp_global’, ‘lldp_interfaces’, ‘vlans’, ‘acls’.
gather_subset list / elements=string	When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all, hardware, config, and interfaces. Can specify a list of values to include a larger subset. Values can also be used with an initial M(!) to specify that a specific subset should not be collected. Default: “!config”
provider dictionary	Deprecated Starting with Ansible 2.5 we recommend using connection: network_cli. Starting with Ansible 2.6 we recommend using connection: httpapi for eAPI. This option will be removed in a release after 2022-06-01. For more information please see the EOS Platform Options guide. A dict object containing connection details.
auth_pass string	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 boolean	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. Choices: no ← (default) yes
host string	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.
password string	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.
port integer	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). Default: 0
ssh_keyfile path	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.
timeout integer	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.
transport string	Configures the transport connection to use when connecting to the remote device. Choices: cli ← (default) eapi
use_proxy boolean	If no, the environment variables http_proxy and https_proxy will be ignored. Choices: no yes ← (default)
use_ssl boolean	Configures the transport to use SSL if set to yes only when the transport=eapi. If the transport argument is not eapi, this value is ignored. Choices: no yes ← (default)
username string	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.
validate_certs boolean	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. Choices: no yes ← (default)

Notes

Note

• For information on using CLI, eAPI and privileged mode see the EOS Platform Options guide

• For more information on using Ansible to manage network devices see the Ansible Network Guide

• For more information on using Ansible to manage Arista EOS devices see the Arista integration page.

Examples

- name: Gather all legacy facts
- arista.eos.eos_facts:
    gather_subset: all

- name: Gather only the config and default facts
  arista.eos.eos_facts:
    gather_subset:
    - config

- name: Do not gather hardware facts
  arista.eos.eos_facts:
    gather_subset:
    - '!hardware'

- name: Gather legacy and resource facts
  arista.eos.eos_facts:
    gather_subset: all
    gather_network_resources: all

- name: Gather only the interfaces resource facts and no legacy facts
- arista.eos.eos_facts:
    gather_subset:
    - '!all'
    - '!min'
    gather_network_resources:
    - interfaces

- name: Gather all resource facts and minimal legacy facts
  arista.eos.eos_facts:
    gather_subset: min
    gather_network_resources: all

Return Values

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

Key	Description
ansible_net_all_ipv4_addresses list / elements=string	All IPv4 addresses configured on the device Returned: when interfaces is configured
ansible_net_all_ipv6_addresses list / elements=string	All IPv6 addresses configured on the device Returned: when interfaces is configured
ansible_net_api string	The name of the transport Returned: always
ansible_net_config string	The current active config from the device Returned: when config is configured
ansible_net_filesystems list / elements=string	All file system names available on the device Returned: when hardware is configured
ansible_net_fqdn string	The fully qualified domain name of the device Returned: always
ansible_net_gather_network_resources list / elements=string	The list of fact for network resource subsets collected from the device Returned: when the resource is configured
ansible_net_gather_subset list / elements=string	The list of fact subsets collected from the device Returned: always
ansible_net_hostname string	The configured hostname of the device Returned: always
ansible_net_image string	The image file the device is running Returned: always
ansible_net_interfaces dictionary	A hash of all interfaces running on the system Returned: when interfaces is configured
ansible_net_memfree_mb integer	The available free memory on the remote device in Mb Returned: when hardware is configured
ansible_net_memtotal_mb integer	The total memory on the remote device in Mb Returned: when hardware is configured
ansible_net_model string	The model name returned from the device Returned: always
ansible_net_neighbors dictionary	The list of LLDP neighbors from the remote device Returned: when interfaces is configured
ansible_net_python_version string	The Python version Ansible controller is using Returned: always
ansible_net_serialnum string	The serial number of the remote device Returned: always
ansible_net_version string	The operating system version running on the remote device Returned: always

Authors

• Peter Sprygada (@privateip)

• Nathaniel Case (@Qalthos)

Collection links

Issue Tracker Repository (Sources)