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.2).
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 |
---|---|
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 Default: |
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 |
---|---|
The set of available configuration revisions Returned: when present |
|
The running-config from the device Returned: when config is configured |
|
The list of subsets gathered by the module Returned: always |
|
The configured system hostname Returned: always |
|
The device model string Returned: always |
|
The set of LLDP neighbors Returned: when interface is configured |
|
The serial number of the device Returned: always |
|
The version of the software running Returned: always |