community.general.edgeos_facts (0.1.1) — module

Collect facts from remote devices running EdgeOS

Authors: Nathaniel Case (@Qalthos), Sam Doran (@samdoran)

preview | supported by community

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1


Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

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 U(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.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: collect all facts from the device
  edgeos_facts:
    gather_subset: all
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: collect only the config and default facts
  edgeos_facts:
    gather_subset: config
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: collect everything exception the config
  edgeos_facts:
    gather_subset: "!config"

Inputs

    
gather_subset:
    default: '!config'
    description:
    - 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 C(M(!)) to specify that a specific subset should not be collected.
    required: false

Outputs

ansible_net_commits:
  description: The set of available configuration revisions
  returned: when present
  type: list
ansible_net_config:
  description: The running-config from the device
  returned: when config is configured
  type: str
ansible_net_gather_subset:
  description: The list of subsets gathered by the module
  returned: always
  type: list
ansible_net_hostname:
  description: The configured system hostname
  returned: always
  type: str
ansible_net_model:
  description: The device model string
  returned: always
  type: str
ansible_net_neighbors:
  description: The set of LLDP neighbors
  returned: when interface is configured
  type: list
ansible_net_serialnum:
  description: The serial number of the device
  returned: always
  type: str
ansible_net_version:
  description: The version of the software running
  returned: always
  type: str