New in version 2.1.
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.
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| gather_subset (added in 2.2)
| no | !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. |
|
| host | yes | 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 | no | 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 | no | 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). |
|
| provider | no | Convenience method that allows all nxos arguments to be passed as a dict object. All constraints (required, choices, etc) must be met either by individual arguments or values in this dict. |
||
| ssh_keyfile | no | 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. |
||
| transport | yes | 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. |
|
| use_ssl | no |
| Configures the transport to use SSL if set to true only when the transport=nxapi, otherwise this value is ignored. |
|
| username | no | Configures the username to use to authenticate the connection to the remote device. The value of username 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. |
# Note: examples below use the following provider dict to handle
# transport and authentication to the node.
vars:
cli:
host: "{{ inventory_hostname }}"
username: admin
password: admin
transport: cli
- 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"
Common return values are documented here Common Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| fan_info | A hash of facts about fans in the remote device | when legacy is configured | dict | |
| kickstart | The software version used to boot the system | when legacy is configured | str | |
| ansible_net_all_ipv4_addresses | All IPv4 addresses configured on the device | when interfaces is configured | list | |
| ansible_net_hostname | The configured hostname of the device | always | string | |
| ansible_net_model | The model name returned from the device | always | str | |
| ansible_net_serialnum | The serial number of the remote device | always | str | |
| module | A hash of facts about the modules in a remote device | when legacy is configured | dict | |
| vlan_list | The list of VLAN IDs configured on the remote device | when legacy is configured | list | |
| ansible_net_version | The operating system version running on the remote device | always | str | |
| ansible_net_memtotal_mb | The total memory on the remote device in Mb | when hardware is configured | int | |
| ansible_net_filesystems | All file system names available on the device | when hardware is configured | list | |
| ansible_net_image | The image file the device is running | always | string | |
| platform | The hardware platform reported by the remote device | when legacy is configured | str | |
| ansible_net_config | The current active config from the device | when config is configured | str | |
| interfaces_list | The list of interface names on the remote device | when legacy is configured | dict | |
| ansible_net_gather_subset | The list of fact subsets collected from the device | always | list | |
| power_supply_info | A hash of facts about the power supplies in the remote device | when legacy is configured | str | |
| ansible_net_interfaces | A hash of all interfaces running on the system | when interfaces is configured | dict | |
| ansible_net_all_ipv6_addresses | All IPv6 addresses configured on the device | when interfaces is configured | list | |
| ansible_net_neighbors | The list of LLDP neighbors from the remote device | when interfaces is configured | dict | |
| ansible_net_memfree_mb | The available free memory on the remote device in Mb | when hardware is configured | int | |
| hostname | The configured hostname of the remote device | when legacy is configured | dict |
For more information on what this means please read Core Modules
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.
© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/nxos_facts_module.html