cisco.nxos.nxos_facts (7.0.0) — module

Gets facts about NX-OS switches

| "added in version" 1.0.0 of cisco.nxos"

Authors: Jason Edelman (@jedelman8), Gabriele Gerbino (@GGabriele)

Install collection

Install with ansible-galaxy collection install cisco.nxos:==7.0.0


Add to requirements.yml

  collections:
    - name: cisco.nxos
      version: 7.0.0

Description

Collects facts from Cisco Nexus devices running the NX-OS operating system. Fact collection is supported over both C(network_cli) and C(httpapi). This module prepends all of the base network fact keys with C(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.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Gather all legacy facts
  cisco.nxos.nxos_facts:
    gather_subset: all
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Gather only the config and default facts
  cisco.nxos.nxos_facts:
    gather_subset:
      - config
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Do not gather hardware facts
  cisco.nxos.nxos_facts:
    gather_subset:
      - '!hardware'
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Gather legacy and resource facts
  cisco.nxos.nxos_facts:
    gather_subset: all
    gather_network_resources: all
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Gather only the interfaces resource facts and no legacy facts
  cisco.nxos.nxos_facts:
    gather_subset:
      - '!all'
      - '!min'
    gather_network_resources:
      - interfaces
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Gather interfaces resource and minimal legacy facts
  cisco.nxos.nxos_facts:
    gather_subset: min
    gather_network_resources: interfaces

Inputs

    
gather_subset:
    default: min
    description:
    - When supplied, this argument will gather operational facts only for the 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.
    elements: str
    required: false
    type: list

gather_network_resources:
    description:
    - 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 C(!) to specify that a specific subset should not be collected.
    - Valid subsets are C(all), C(bfd_interfaces), C(lag_interfaces), C(telemetry), C(vlans),
      C(lacp), C(lacp_interfaces), C(interfaces), C(l3_interfaces), C(l2_interfaces),
      C(lldp_global), C(acls), C(acl_interfaces), C(ospfv2), C(ospfv3), C(ospf_interfaces),
      C(bgp_global), C(bgp_address_family), C(route_maps), C(prefix_lists), C(logging_global),
      C(ntp_global), C(snmp_server), C(hostname).
    elements: str
    required: false
    type: list

available_network_resources:
    default: false
    description: When set to C(true) a list of network resources for which resource modules
      are available will be provided.
    type: bool

Outputs

ansible_net_all_ipv4_addresses:
  description: All IPv4 addresses configured on the device
  returned: when interfaces is configured
  type: list
ansible_net_all_ipv6_addresses:
  description: All IPv6 addresses configured on the device
  returned: when interfaces is configured
  type: list
ansible_net_api:
  description: The name of the transport
  returned: always
  type: str
ansible_net_config:
  description: The current active config from the device
  returned: when config is configured
  type: str
ansible_net_filesystems:
  description: All file system names available on the device
  returned: when hardware is configured
  type: list
ansible_net_gather_network_resources:
  description: The list of fact for network resource subsets collected from the device
  returned: when the resource is configured
  type: list
ansible_net_gather_subset:
  description: The list of fact subsets collected from the device
  returned: always
  type: list
ansible_net_hostname:
  description: The configured hostname of the device
  returned: always
  type: str
ansible_net_image:
  description: The image file the device is running
  returned: always
  type: str
ansible_net_interfaces:
  description: A hash of all interfaces running on the system
  returned: when interfaces is configured
  type: dict
ansible_net_license_hostid:
  description: The License host id of the device
  returned: always
  type: str
ansible_net_memfree_mb:
  description: The available free memory on the remote device in Mb
  returned: when hardware is configured
  type: int
ansible_net_memtotal_mb:
  description: The total memory on the remote device in Mb
  returned: when hardware is configured
  type: int
ansible_net_model:
  description: The model name returned from the device
  returned: always
  type: str
ansible_net_neighbors:
  description:
  - 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.
  returned: when interfaces is configured
  type: dict
ansible_net_python_version:
  description: The Python version Ansible controller is using
  returned: always
  type: str
ansible_net_serialnum:
  description: The serial number of the remote device
  returned: always
  type: str
ansible_net_version:
  description: The operating system version running on the remote device
  returned: always
  type: str
fan_info:
  description: A hash of facts about fans in the remote device
  returned: when legacy is configured
  type: dict
hostname:
  description: The configured hostname of the remote device
  returned: when legacy is configured
  type: dict
interfaces_list:
  description: The list of interface names on the remote device
  returned: when legacy is configured
  type: dict
kickstart:
  description: The software version used to boot the system
  returned: when legacy is configured
  type: str
module:
  description: A hash of facts about the modules in a remote device
  returned: when legacy is configured
  type: dict
platform:
  description: The hardware platform reported by the remote device
  returned: when legacy is configured
  type: str
power_supply_info:
  description: A hash of facts about the power supplies in the remote device
  returned: when legacy is configured
  type: str
vlan_list:
  description: The list of VLAN IDs configured on the remote device
  returned: when legacy is configured
  type: list