vyos_facts - Collect facts from remote devices running VyOS

New in version 2.2.

Synopsis
Options
Examples
Return Values
Notes
- Status
- Maintenance Info

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.

Options

parameter required default choices comments

gather_subset

!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

A dict object containing connection details.

**Dictionary object provider**
parameter	required	default	comments
username	no		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.
host	yes		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.
ssh_keyfile	no		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	no	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.
password	no		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	no	22	Specifies the port to use when building the connection to the remote device.

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 Return Values, the following are the fields unique to this module:

name	description	returned	type
ansible_net_commits	The set of available configuration revisions	when present	list
ansible_net_config	The running-config from the device	when config is configured	str
ansible_net_gather_subset	The list of subsets gathered by the module	always	list
ansible_net_hostname	The configured system hostname	always	str
ansible_net_model	The device model string	always	str
ansible_net_neighbors	The set of LLDP neighbors	when interface is configured	list
ansible_net_serialnum	The serial number of the device	always	str
ansible_net_version	The version of the software running	always	str

Notes

Note

Tested against VYOS 1.1.7

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/vyos_facts_module.html