cisco.ios.ios_facts_module.rst

cisco.ios.ios_facts

Module to collect facts from remote devices.

Version added: 1.0.0

• Synopsis
• Parameters
• Notes
• Examples
• Return Values
• Status

Synopsis

• Collects a base set of device facts from a remote device that is running IOS. This module prepends all of the base network fact keys with ansible_net_<fact>. 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
available_network_resources boolean	Choices: no ← yes	When 'True' a list of network resources for which resource modules are available will be provided.
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 ! to specify that a specific subset should not be collected. Valid subsets are 'bgp_global', 'l3_interfaces', 'lag_interfaces', 'ntp_global', 'acls', 'hostname', 'interfaces', 'lldp_interfaces', 'logging_global', 'ospf_interfaces', 'ospfv2', 'prefix_lists', 'static_routes', 'acl_interfaces', 'all', 'bgp_address_family', 'l2_interfaces', 'lacp', 'lacp_interfaces', 'lldp_global', 'ospfv3', 'snmp_server', 'vlans', 'service'.
gather_subset list / elements=string	Default: "min"	When supplied, this argument restricts the facts collected to a given subset. Possible values for this argument include all, min, default, hardware, config, and interfaces. Specify a list of values to include a larger subset. Use a value with an initial ! to collect all facts except that subset.

Notes

Note

• Tested against Cisco IOSXE Version 17.3 on CML and IOS 15.6 for L2 specific resource.
• Facts gathering for L3 devices are supposed to produce blank output for unsupported resources like vlan.
• This module works with connection network_cli. See https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.html
• For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
• For more information on using Ansible to manage Cisco devices see the Cisco integration page.

Examples

- name: Gather all legacy facts
  cisco.ios.ios_facts:
    gather_subset: all

- name: Gather only the config and default facts
  cisco.ios.ios_facts:
    gather_subset:
      - config

- name: Do not gather hardware facts
  cisco.ios.ios_facts:
    gather_subset:
      - "!hardware"

- name: Gather legacy and resource facts
  cisco.ios.ios_facts:
    gather_subset: all
    gather_network_resources: all

- name: Gather only the interfaces resource facts and no legacy facts
  cisco.ios.ios_facts:
    gather_subset:
      - "!all"
      - "!min"
    gather_network_resources:
      - interfaces

- name: Gather interfaces resource and minimal legacy facts
  cisco.ios.ios_facts:
    gather_subset: min
    gather_network_resources: interfaces

- name: Gather L2 interfaces resource and minimal legacy facts
  cisco.ios.ios_facts:
    gather_subset: min
    gather_network_resources: l2_interfaces

- name: Gather L3 interfaces resource and minimal legacy facts
  cisco.ios.ios_facts:
    gather_subset: min
    gather_network_resources: l3_interfaces

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_cpu_utilization dictionary	when hardware is configured	The current CPU utilization of the device
ansible_net_filesystems list	when hardware is configured	All file system names available on the device
ansible_net_filesystems_info dictionary	when hardware is configured	A hash of all file systems containing info about each file system (e.g. free and total space)
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_iostype string	always	The operating system type (IOS or IOS-XE) running on the remote device
ansible_net_memfree_mb integer	when hardware is configured	The available free memory on the remote device in MiB
ansible_net_memtotal_mb integer	when hardware is configured	The total memory on the remote device in MiB
ansible_net_model string	always	The model name returned from the device
ansible_net_neighbors dictionary	when interfaces is configured	The list of CDP and LLDP neighbors from the remote device. If both, CDP and LLDP neighbor data is present on one port, CDP is preferred.
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_stacked_models list	when multiple devices are configured in a stack	The model names of each device in the stack
ansible_net_stacked_serialnums list	when multiple devices are configured in a stack	The serial numbers of each device in the stack
ansible_net_version string	always	The operating system version running on the remote device

Status

Authors

• Peter Sprygada (@privateip)
• Sumit Jaiswal (@justjais)