eos_facts¶

Collection Note

This module is part of the arista.eos collection. To install the collection, use:

ansible-galaxy collection install arista.eos

Added in version 1.0.0.

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	Defaults / Choices	Comments
available_network_resources bool		When 'True' a list of network resources for which resource modules are available will be provided.
gather_network_resources list / elements=str		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 C(!) to specify that a specific subset should not be collected. Values can also be used with an initial C(!) 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=str	Default: min	When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include C(all), C(hardware), C(config), C(legacy), C(interfaces), and C(min). Can specify a list of values to include a larger subset. Values can also be used with an initial C(!) to specify that a specific subset should not be collected.

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¶

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

Authors¶

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