Documentation

iosxr_facts - Collect facts from remote devices running IOS XR

New in version 2.2.

Synopsis

  • Collects a base set of device facts from a remote device that is running IOS XR. 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.

Requirements

The below requirements are needed on the host that executes this module.

  • ncclient >= 0.5.3 when using netconf
  • lxml >= 4.1.1 when using netconf

Parameters

Parameter
Choices/Defaults
Comments
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
Deprecated
Starting with Ansible 2.5 we recommend using connection: network_cli.
For more information please see the Network 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.
 
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.
 
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.
 
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
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

  • Tested against IOS XRv 6.1.2
  • This module does not support netconf connection
  • 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

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

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

# Do not collect hardware facts
- iosxr_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_neighbors
dict
when interfaces is configured
The list of LLDP neighbors from the remote device

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

  • Ricardo Carrillo Cruz (@rcarrillocruz)

Hint

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