vyos.vyos.vyos_facts module – Get facts about vyos devices.
Note
This module is part of the vyos.vyos collection (version 4.1.0).
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 vyos.vyos
.
To use it in a playbook, specify: vyos.vyos.vyos_facts
.
New in vyos.vyos 1.0.0
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.
Aliases: facts
Parameters
Parameter |
Comments |
---|---|
When ‘True’ a list of network resources for which resource modules are available will be provided. Choices:
|
|
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 |
|
When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include Default: |
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 |
Description |
---|---|
The name of the transport Returned: always |
|
The set of available configuration revisions Returned: when present |
|
The running-config from the device Returned: when config is configured |
|
The list of fact resource subsets collected from the device Returned: always |
|
The list of subsets gathered by the module Returned: always |
|
The configured system hostname Returned: always |
|
The device model string Returned: always |
|
The set of LLDP neighbors Returned: when interface is configured |
|
The Python version Ansible controller is using Returned: always |
|
The serial number of the device Returned: always |
|
The version of the software running Returned: always |