/ home / extreme / extreme.exos / 0.1.1 / module / exos_facts

extreme.exos.exos_facts (0.1.1) — module

Collect facts from devices running Extreme EXOS

Authors: Lance Richardson (@hlrichardson), Ujwal Koamrla (@ujwalkomarla)

preview | supported by community

Install collection

Install with ansible-galaxy collection install extreme.exos:==0.1.1

Add to requirements.yml

  collections:
    - name: extreme.exos
      version: 0.1.1

Description

Collects a base set of device facts from a remote device that is running EXOS. This module prepends all of the base network fact keys with C(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

Scanned by Steampunk Spotter

  - name:  Gather all legacy facts
    exos_facts:
      gather_subset: all

Scanned by Steampunk Spotter

  - name: Gather only the config and default facts
    exos_facts:
      gather_subset: config

Scanned by Steampunk Spotter

  - name: do not gather hardware facts
    exos_facts:
      gather_subset: "!hardware"

Scanned by Steampunk Spotter

  - name: Gather legacy and resource facts
    exos_facts:
      gather_subset: all
      gather_network_resources: all

Scanned by Steampunk Spotter

  - name: Gather only the lldp global resource facts and no legacy facts
    exos_facts:
      gather_subset:
        - '!all'
        - '!min'
      gather_network_resource:
        - lldp_global

Scanned by Steampunk Spotter

  - name: Gather lldp global resource and minimal legacy facts
    exos_facts:
      gather_subset: min
      gather_network_resource: lldp_global

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, hardware, config, and interfaces.  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
    type: list

gather_network_resources:
    description:
    - When supplied, this argument will restrict the facts collected to a given subset.
      Possible values for this argument include all and the resources like interfaces,
      vlans etc. 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. Valid subsets are 'all', 'lldp_global'.
    type: list

Outputs

ansible_net_all_ipv4_addresses:
  description: All IPv4 addresses configured on the device
  returned: when interfaces is configured
  type: list
ansible_net_all_ipv6_addresses:
  description: All Primary IPv6 addresses configured on the device
  returned: when interfaces is configured
  type: list
ansible_net_config:
  description: The current active config from the device
  returned: when config is configured
  type: str
ansible_net_gather_network_resources:
  description: The list of fact for network resource subsets collected from the device
  returned: when the resource is configured
  type: list
ansible_net_gather_subset:
  description: The list of fact subsets collected from the device
  returned: always
  type: list
ansible_net_hostname:
  description: The configured hostname of the device
  returned: always
  type: str
ansible_net_interfaces:
  description: A hash of all interfaces running on the system
  returned: when interfaces is configured
  type: dict
ansible_net_memfree_mb:
  description: The available free memory on the remote device in Mb
  returned: when hardware is configured
  type: int
ansible_net_memtotal_mb:
  description: The total memory on the remote device in Mb
  returned: when hardware is configured
  type: int
ansible_net_model:
  description: The model name returned from the device
  returned: always
  type: str
ansible_net_neighbors:
  description: The list of LLDP neighbors from the remote device
  returned: when interfaces is configured
  type: dict
ansible_net_serialnum:
  description: The serial number of the remote device
  returned: always
  type: str
ansible_net_version:
  description: The operating system version running on the remote device
  returned: always
  type: str