community.network.edgeos_facts module – Collect facts from remote devices running EdgeOS

Note

This module is part of the community.network collection (version 4.0.1).

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 community.network.

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

Synopsis

  • Collects a base set of device facts from a remote device that is running EdgeOS. 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

Comments

gather_subset

string

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.

Default: “!config”

Notes

Note

  • Tested against EdgeOS 1.9.7

Examples

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

- name: Collect only the config and default facts
  community.network.edgeos_facts:
    gather_subset: config

- name: Collect everything exception the config
  community.network.edgeos_facts:
    gather_subset: "!config"

Return Values

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

Key

Description

ansible_net_commits

list / elements=string

The set of available configuration revisions

Returned: when present

ansible_net_config

string

The running-config from the device

Returned: when config is configured

ansible_net_gather_subset

list / elements=string

The list of subsets gathered by the module

Returned: always

ansible_net_hostname

string

The configured system hostname

Returned: always

ansible_net_model

string

The device model string

Returned: always

ansible_net_neighbors

list / elements=string

The set of LLDP neighbors

Returned: when interface is configured

ansible_net_serialnum

string

The serial number of the device

Returned: always

ansible_net_version

string

The version of the software running

Returned: always

Authors

  • Nathaniel Case (@Qalthos)

  • Sam Doran (@samdoran)