/ home / extreme / extreme.nos / 0.1.0 / module / nos_facts

extreme.nos.nos_facts (0.1.0) — module

Collect facts from devices running Extreme NOS

Authors: Lindsay Hill (@LindsayHill)

preview | supported by community

Install collection

Install with ansible-galaxy collection install extreme.nos:==0.1.0

Add to requirements.yml

  collections:
    - name: extreme.nos
      version: 0.1.0

Description

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

# Collect all facts from the device
- nos_facts:
    gather_subset: all

Scanned by Steampunk Spotter

# Collect only the config and default facts
- nos_facts:
    gather_subset:
      - config

Scanned by Steampunk Spotter

# Do not collect hardware facts
- nos_facts:
    gather_subset:
      - "!hardware"

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

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_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