community.network.edgeos_facts – Collect facts from remote devices running EdgeOS
Note
This plugin is part of the community.network collection (version 3.0.0).
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 | 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, 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. |
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 | Returned | Description |
|---|---|---|
| ansible_net_commits list / elements=string | when present | The set of available configuration revisions |
| ansible_net_config string | when config is configured | The running-config from the device |
| ansible_net_gather_subset list / elements=string | always | The list of subsets gathered by the module |
| ansible_net_hostname string | always | The configured system hostname |
| ansible_net_model string | always | The device model string |
| ansible_net_neighbors list / elements=string | when interface is configured | The set of LLDP neighbors |
| ansible_net_serialnum string | always | The serial number of the device |
| ansible_net_version string | always | The version of the software running |
Authors
- Nathaniel Case (@Qalthos)
- Sam Doran (@samdoran)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/edgeos_facts_module.html