cisco.nxos.nxos_facts_module.rst

cisco.nxos.nxos_facts

Gets facts about NX-OS switches

Version added: 1.0.0

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

Synopsis

• Collects facts from Cisco Nexus devices running the NX-OS operating system. Fact collection is supported over both network_cli and httpapi. 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 set to 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 gather configuration facts only for the given subset. 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 all, bfd_interfaces, lag_interfaces, telemetry, vlans, lacp, lacp_interfaces, interfaces, l3_interfaces, l2_interfaces, lldp_global, acls, acl_interfaces, ospfv2, ospfv3, ospf_interfaces, bgp_global, bgp_address_family, route_maps, prefix_lists, logging_global, ntp_global, snmp_server, hostname.
gather_subset list / elements=string	Default: "min"	When supplied, this argument will gather operational facts only for the given subset. Possible values for this argument include all, hardware, config, legacy, interfaces, and min. 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.

Notes

Note

• Tested against NXOSv 7.3.(0)D1(1) on VIRL
• Unsupported for Cisco MDS
• For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide <nxos_platform_options>`
• 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.nxos.nxos_facts:
    gather_subset: all
- name: Gather only the config and default facts
  cisco.nxos.nxos_facts:
    gather_subset:
      - config
- name: Do not gather hardware facts
  cisco.nxos.nxos_facts:
    gather_subset:
      - '!hardware'
- name: Gather legacy and resource facts
  cisco.nxos.nxos_facts:
    gather_subset: all
    gather_network_resources: all
- name: Gather only the interfaces resource facts and no legacy facts
  cisco.nxos.nxos_facts:
    gather_subset:
      - '!all'
      - '!min'
    gather_network_resources:
      - interfaces
- name: Gather interfaces resource and minimal legacy facts
  cisco.nxos.nxos_facts:
    gather_subset: min
    gather_network_resources: 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_filesystems list	when hardware is configured	All file system names available on 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_license_hostid string	always	The License host id of the device
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 and CDP neighbors from the 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_version string	always	The operating system version running on the remote device
fan_info dictionary	when legacy is configured	A hash of facts about fans in the remote device
hostname dictionary	when legacy is configured	The configured hostname of the remote device
interfaces_list dictionary	when legacy is configured	The list of interface names on the remote device
kickstart string	when legacy is configured	The software version used to boot the system
module dictionary	when legacy is configured	A hash of facts about the modules in a remote device
platform string	when legacy is configured	The hardware platform reported by the remote device
power_supply_info string	when legacy is configured	A hash of facts about the power supplies in the remote device
vlan_list list	when legacy is configured	The list of VLAN IDs configured on the remote device

Status

Authors

• Jason Edelman (@jedelman8)
• Gabriele Gerbino (@GGabriele)