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.
Options
| parameter | required | default | choices | comments | |||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| gather_subset |
no | !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 |
no |
A dict object containing connection details.
|
|||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||
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 Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| ansible_net_all_ipv4_addresses |
All IPv4 addresses configured on the device
|
when interfaces is configured | list | |
| ansible_net_all_ipv6_addresses |
All IPv6 addresses configured on the device
|
when interfaces is configured | list | |
| ansible_net_config |
The current active config from the device
|
when config is configured | str | |
| ansible_net_filesystems |
All file system names available on the device
|
when hardware is configured | list | |
| ansible_net_gather_subset |
The list of fact subsets collected from the device
|
always | list | |
| ansible_net_hostname |
The configured hostname of the device
|
always | string | |
| ansible_net_image |
The image file the device is running
|
always | string | |
| ansible_net_interfaces |
A hash of all interfaces running on the system
|
when interfaces is configured | dict | |
| ansible_net_memfree_mb |
The available free memory on the remote device in Mb
|
when hardware is configured | int | |
| ansible_net_memtotal_mb |
The total memory on the remote device in Mb
|
when hardware is configured | int | |
| ansible_net_neighbors |
The list of LLDP neighbors from the remote device
|
when interfaces is configured | dict | |
| ansible_net_version |
The operating system version running on the remote device
|
always | str |
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance Info
For more information about Red Hat’s this support of this module, please refer to this knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/iosxr_facts_module.html