ios_facts - Collect facts from remote devices running Cisco IOS

New in version 2.2.

Synopsis

  • Collects a base set of device facts from a remote device that is running IOS. 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
auth_pass Default:
none
Deprecated
Starting with Ansible 2.5 we recommend using connection: network_cli and become: yes with become_pass.
For more information please see the IOS Platform Options guide.
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
    Choices:
  • yes
  • no
Deprecated
Starting with Ansible 2.5 we recommend using connection: network_cli and become: yes.
For more information please see the IOS Platform Options guide.
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.
gather_subset Default:
!config
When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all, hardware, config, 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 Default:
None
Deprecated
Starting with Ansible 2.5 we recommend using connection: network_cli.
For more information please see the IOS 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 the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
authorize
    Choices:
  • yes
  • no
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.
ssh_keyfile
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
auth_pass Default:
none
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.
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 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.
password Default:
None
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
port Default:
22
Specifies the port to use when building the connection to the remote device.

Notes

Note

Examples

# Collect all facts from the device
- ios_facts:
    gather_subset: all

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

# Do not collect hardware facts
- ios_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
string
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
string
always
The model name returned from the device

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

ansible_net_serialnum
string
always
The serial number of the remote device

ansible_net_stacked_models
list
when multiple devices are configured in a stack
The model names of each device in the stack

ansible_net_stacked_serialnums
list
when multiple devices are configured in a stack
The serial numbers of each device in the stack

ansible_net_version
string
always
The operating system version running 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

  • Peter Sprygada (@privateip)

Hint

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/ios_facts_module.html