edgeswitch_facts – Collect facts from remote devices running Edgeswitch

New in version 2.8.

Synopsis

  • Collects a base set of device facts from a remote device that is running Ubiquiti Edgeswitch. 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, config, and 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.

Notes

Note

  • Tested against Edgeswitch 1.7.4

Examples

# Collect all facts from the device
- edgeswitch_facts:
    gather_subset: all

# Collect only the config and default facts
- edgeswitch_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_config
string
 when config is configured
The current active config from the device
ansible_net_gather_subset
list
 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_model
string
 always
The model name returned from the device
ansible_net_serialnum
string
 always
The serial number of the remote device
ansible_net_version
string
 always
The operating system version running on the remote device


Status

Authors

  • Frederic Bor (@f-bor)

Hint

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