vyos.vyos.vyos_facts_module.rst

vyos.vyos.vyos_facts

Get facts about vyos devices.

Version added: 1.0.0

• Synopsis
• Parameters
• Notes
• Examples
• Return Values
• Status

Synopsis

• Collects facts from network devices running the vyos operating system. This module places the facts gathered in the fact tree keyed by the respective resource name. 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
available_network_resources boolean	Choices: no ← yes	When 'True' a list of network resources for which resource modules are available will be provided.
gather_network_resources list / elements=string		When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all and the resources like 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. Valid subsets are 'all', 'interfaces', 'l3_interfaces', 'lag_interfaces', 'lldp_global', 'lldp_interfaces', 'static_routes', 'firewall_rules', 'firewall_global', 'firewall_interfaces', 'ospfv3', 'ospfv2'.
gather_subset list / elements=string	Default: "min"	When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all, default, config, neighbors and min. 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.

Notes

Note

• Tested against VyOS 1.1.8 (helium).
• This module works with connection ansible.netcommon.network_cli. See the VyOS OS Platform Options.
• For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`

Examples

# Gather all facts
- vyos.vyos.vyos_facts:
    gather_subset: all
    gather_network_resources: all

# collect only the config and default facts
- vyos.vyos.vyos_facts:
    gather_subset: config

# collect everything exception the config
- vyos.vyos.vyos_facts:
    gather_subset: '!config'

# Collect only the interfaces facts
- vyos.vyos.vyos_facts:
    gather_subset:
      - '!all'
      - '!min'
    gather_network_resources:
      - interfaces

# Do not collect interfaces facts
- vyos.vyos.vyos_facts:
    gather_network_resources:
      - '!interfaces'

# Collect interfaces and minimal default facts
- vyos.vyos.vyos_facts:
    gather_subset: min
    gather_network_resources: interfaces

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
ansible_net_api string	always	The name of the transport
ansible_net_commits list	when present	The set of available configuration revisions
ansible_net_config string	when config is configured	The running-config from the device
ansible_net_gather_network_resources list	always	The list of fact resource subsets collected from the device
ansible_net_gather_subset list	always	The list of subsets gathered by the module
ansible_net_hostname string	always	The configured system hostname
ansible_net_model string	always	The device model string
ansible_net_neighbors list	when interface is configured	The set of LLDP neighbors
ansible_net_python_version string	always	The Python version Ansible controller is using
ansible_net_serialnum string	always	The serial number of the device
ansible_net_version string	always	The version of the software running

Status

Authors

• Nathaniel Case (@qalthos)
• Nilashish Chakraborty (@Nilashishc)
• Rohit Thakur (@rohitthakur2590)