Documentation

nxos_facts - Gets facts about NX-OS switches

New in version 2.1.

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.

Parameters

Parameter
Choices/Defaults
Comments
gather_subset
(added in 2.2)
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
Deprecated
Starting with Ansible 2.5 we recommend using connection: network_cli.
This option is only required if you are using NX-API.
For more information please see the NXOS Platform Options guide.

A dict object containing connection details.
 
username
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.
 
ssh_keyfile
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.
 
use_proxy
(added in 2.5)
    Choices:
  • no
  • yes ←
If no, the environment variables http_proxy and https_proxy will be ignored.
 
host
required
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.
 
timeout
(added in 2.3)
Default:
10
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).
 
use_ssl
    Choices:
  • no ←
  • yes
Configures the transport to use SSL if set to true only when the transport=nxapi, otherwise this value is ignored.
 
password
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.
 
validate_certs
    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.
 
port
Default:
0 (use common port)
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).
 
transport
required
Default:
cli
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.

Notes

Note

Examples

- nxos_facts:
    gather_subset: all

# Collect only the config and default facts
- nxos_facts:
    gather_subset:
      - config

# Do not collect hardware facts
- nxos_facts:
    gather_subset:
      - "!hardware"

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_config
str
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_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
dict
when interfaces is configured
A hash of all interfaces running on the system

ansible_net_memfree_mb
int
when hardware is configured
The available free memory on the remote device in Mb

ansible_net_memtotal_mb
int
when hardware is configured
The total memory on the remote device in Mb

ansible_net_model
str
always
The model name returned from the device

ansible_net_neighbors
dict
when interfaces is configured
The list of LLDP/CDP neighbors from the remote device

ansible_net_serialnum
str
always
The serial number of the remote device

ansible_net_version
str
always
The operating system version running on the remote device

fan_info
dict
when legacy is configured
A hash of facts about fans in the remote device

hostname
dict
when legacy is configured
The configured hostname of the remote device

interfaces_list
dict
when legacy is configured
The list of interface names on the remote device

kickstart
str
when legacy is configured
The software version used to boot the system

module
dict
when legacy is configured
A hash of facts about the modules in a remote device

platform
str
when legacy is configured
The hardware platform reported by the remote device

power_supply_info
str
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

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

For more information about Red Hat’s support of this module, please refer to this Knowledge Base article

Author

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

Hint

If you notice any issues in this documentation you can edit this document to improve it.