vyos_facts – Collect facts from remote devices running VyOS

New in version 2.2.

Synopsis

  • Collects a base set of device facts from a remote device that is running VyOS. 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
-
Default:
"!config"
When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all, default, config, and neighbors. 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.
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.
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.
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.
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.

Notes

Note

  • Tested against VYOS 1.1.7
  • For more information on using Ansible to manage network devices see the Ansible Network Guide

Examples

- name: collect all facts from the device
  vyos_facts:
    gather_subset: all

- name: collect only the config and default facts
  vyos_facts:
    gather_subset: config

- name: collect everything exception the config
  vyos_facts:
    gather_subset: "!config"

Return Values

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

Key Returned Description
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_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_serialnum
string
 always
The serial number of the device
ansible_net_version
string
 always
The version of the software running


Status

Red Hat Support

More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.

Authors

  • Nathaniel Case (@qalthos)

Hint

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