cisco.nxos.nxos_facts – Gets facts about NX-OS switches

Note

This plugin is part of the cisco.nxos collection (version 1.4.0).

To install it use: ansible-galaxy collection install cisco.nxos.

To use it in a playbook, specify: cisco.nxos.nxos_facts.

New in version 1.0.0: of cisco.nxos

Synopsis

  • Collects facts from Cisco Nexus devices running the NX-OS operating system. Fact collection is supported over both Cli and Nxapi transports. 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.

Note

This module has a corresponding action plugin.

Parameters

Parameter Choices/Defaults Comments
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 'all', 'bfd_interfaces', 'lag_interfaces', 'telemetry', 'vlans', 'lacp', 'lacp_interfaces', 'interfaces', 'l3_interfaces', 'l2_interfaces', 'lldp_global', 'acls', 'acl_interfaces', 'ospfv2'.
gather_subset
list / elements=string
Default:
"!config"
When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all, hardware, config, legacy, 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.
Starting with Ansible 2.6 we recommend using connection: httpapi for NX-API.
This option will be removed in a release after 2022-06-01.
For more information please see the NXOS 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
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 nxapi transports. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
port
integer
Specifies the port to use when building the connection to the remote device. This value applies to either cli or nxapi. 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
string
Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for the cli transport. 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. NX-API can be slow to return on long-running commands (sh mac, sh bgp, etc).
transport
string
    Choices:
  • cli ←
  • nxapi
Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity to the device over cli (ssh) or nxapi.
use_proxy
boolean
    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=nxapi, otherwise 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 nxapi 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 nxapi, this value is ignored.

Notes

Note

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 / elements=string
when interfaces is configured
All IPv4 addresses configured on the device

ansible_net_all_ipv6_addresses
list / elements=string
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 / elements=string
when hardware is configured
All file system names available on the device

ansible_net_gather_network_resources
list / elements=string
when the resource is configured
The list of fact for network resource subsets collected from the device

ansible_net_gather_subset
list / elements=string
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 / elements=string
when legacy is configured
The list of VLAN IDs configured on the remote device



Authors

  • Jason Edelman (@jedelman8)

  • Gabriele Gerbino (@GGabriele)