community.network.edgeswitch_facts – Collect facts from remote devices running Edgeswitch

Note

This plugin is part of the community.network collection (version 2.0.1).

To install it use: ansible-galaxy collection install community.network.

To use it in a playbook, specify: community.network.edgeswitch_facts.

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
string
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

- name: Collect all facts from the device
  community.network.edgeswitch_facts:
    gather_subset: all

- name: Collect only the running config and default facts
  community.network.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 / elements=string
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_startupconfig
string
added in 1.2.0 of community.network
 when config is configured
The startup config from the device
ansible_net_version
string
always
The operating system version running on the remote device


Authors

  • Frederic Bor (@f-bor)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/edgeswitch_facts_module.html