cisco.nxos.nxos_facts – Gets facts about NX-OS switches
Note
This plugin is part of the cisco.nxos collection (version 2.8.2).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
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 |
Comments |
---|---|
When ‘True’ a list of network resources for which resource modules are available will be provided. Choices:
|
|
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 |
|
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 Default: “!config” |
|
Deprecated Starting with Ansible 2.5 we recommend using Starting with Ansible 2.6 we recommend using This option will be removed in a release after 2022-06-01. For more information please see the https://docs.ansible.com/ansible/latest/network/user_guide/platform_nxos.html. A dict object containing connection details. |
|
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 |
|
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 Choices:
|
|
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. |
|
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 |
|
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). |
|
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 |
|
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). |
|
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. Choices:
|
|
If Choices:
|
|
Configures the transport to use SSL if set to Choices:
|
|
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 |
|
If Choices:
|
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 NXOS Platform Options guide
For more information on using Ansible to manage network devices see the Ansible 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 |
Description |
---|---|
All IPv4 addresses configured on the device Returned: when interfaces is configured |
|
All IPv6 addresses configured on the device Returned: when interfaces is configured |
|
The name of the transport Returned: always |
|
The current active config from the device Returned: when config is configured |
|
All file system names available on the device Returned: when hardware is configured |
|
The list of fact for network resource subsets collected from the device Returned: when the resource is configured |
|
The list of fact subsets collected from the device Returned: always |
|
The configured hostname of the device Returned: always |
|
The image file the device is running Returned: always |
|
A hash of all interfaces running on the system Returned: when interfaces is configured |
|
The License host id of the device Returned: always |
|
The available free memory on the remote device in Mb Returned: when hardware is configured |
|
The total memory on the remote device in Mb Returned: when hardware is configured |
|
The model name returned from the device Returned: always |
|
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 |
|
The Python version Ansible controller is using Returned: always |
|
The serial number of the remote device Returned: always |
|
The operating system version running on the remote device Returned: always |
|
A hash of facts about fans in the remote device Returned: when legacy is configured |
|
The configured hostname of the remote device Returned: when legacy is configured |
|
The list of interface names on the remote device Returned: when legacy is configured |
|
The software version used to boot the system Returned: when legacy is configured |
|
A hash of facts about the modules in a remote device Returned: when legacy is configured |
|
The hardware platform reported by the remote device Returned: when legacy is configured |
|
A hash of facts about the power supplies in the remote device Returned: when legacy is configured |
|
The list of VLAN IDs configured on the remote device Returned: when legacy is configured |
Authors
Jason Edelman (@jedelman8)
Gabriele Gerbino (@GGabriele)