eos_facts – Collect facts from remote devices running Arista EOS¶

Synopsis
Parameters
Notes
Examples
Return Values
Status

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.

Parameters ¶

Parameter		Choices/Defaults	Comments
auth_pass string			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 boolean		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.
gather_network_resources list added in 2.9			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 `!` to specify that a specific subset should not be collected. Values can also be used with an initial `!` 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'.
gather_subset list		Default: "!config"	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 `!` to specify that a specific subset should not be collected.
provider dictionary			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.
	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	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.
	host string / 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.
	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	Default: 0	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).
	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 / required	Choices: cli ← eapi	Configures the transport connection to use when connecting to the remote device.
	use_proxy boolean added in 2.5	Choices: no yes ←	If `no`, the environment variables `http_proxy` and `https_proxy` will be ignored.
	use_ssl boolean	Choices: no yes ←	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.
	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	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.

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
- eos_facts:
    gather_subset: all

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

- name: Do not gather hardware facts
  eos_facts:
    gather_subset:
      - "!hardware"

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

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

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

Status ¶

This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Network Team. [network]

Red Hat Support¶

More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.

Authors¶

Peter Sprygada (@privateip)
Nathaniel Case (@Qalthos)

Hint

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

eos_facts – Collect facts from remote devices running Arista EOS¶

Synopsis¶

Parameters¶

Notes¶

Examples¶

Return Values¶

Status¶