frr.frr.frr_facts – Collect facts from remote devices running Free Range Routing (FRR).
Note
This plugin is part of the frr.frr collection (version 1.0.3).
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 frr.frr
.
To use it in a playbook, specify: frr.frr.frr_facts
.
New in version 1.0.0: of frr.frr
Synopsis
- Collects a base set of device facts from a remote device that is running FRR. 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 |
---|---|---|
gather_subset list / elements=string | Default: "!config" | When supplied, this argument restricts the facts collected to a given subset. Possible values for this argument include all , hardware , config , and interfaces .Specify a list of values to include a larger subset. Use a value with an initial ! to collect all facts except that subset. |
Notes
Note
- Tested against FRR 6.0.
Examples
- name: Collect all facts from the device frr.frr.frr_facts: gather_subset: all - name: Collect only the config and default facts frr.frr.frr_facts: gather_subset: - config - name: Collect the config and hardware facts frr.frr.frr_facts: gather_subset: - config - hardware - name: Do not collect hardware facts frr.frr.frr_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 / elements=string | when interfaces is configured | All IPv4 addresses configured on the device |
ansible_net_all_ipv6_addresses list / elements=string | when interfaces is configured | All IPv6 addresses configured on the device |
ansible_net_api string | always | The name of the transport |
ansible_net_config string | when config is configured | The current active config from the device |
ansible_net_gather_subset list / elements=string | always | The list of fact subsets collected from the device |
ansible_net_hostname string | always | The configured hostname of the device |
ansible_net_interfaces dictionary | when interfaces is configured | A hash of all interfaces running on the system |
ansible_net_mem_stats dictionary | when hardware is configured | The memory statistics fetched from the device |
ansible_net_mpls_ldp_neighbors dictionary | when interfaces is configured and LDP daemon is running on the device | The list of MPLS LDP neighbors from the remote device |
ansible_net_python_version string | always | The Python version that the Ansible controller is using |
ansible_net_version string | always | The FRR version running on the remote device |
Authors
- Nilashish Chakraborty (@NilashishC)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/frr/frr/frr_facts_module.html