/ home / community / community.general / 0.1.1 / module / onyx_facts

community.general.onyx_facts (0.1.1) — module

Collect facts from Mellanox ONYX network devices

Authors: Waleed Mousa (@waleedym), Samer Deeb (@samerd)

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 ONYX Mellanox network devices 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: Collect all facts from the device
  onyx_facts:
    gather_subset: all

Scanned by Steampunk Spotter

- name: Collect only the interfaces facts
  onyx_facts:
    gather_subset:
      - interfaces

Scanned by Steampunk Spotter

- name: Do not collect version facts
  onyx_facts:
    gather_subset:
      - "!version"

Inputs

    
gather_subset:
    default: version
    description:
    - When supplied, this argument will restrict the facts collected to a given subset.  Possible
      values for this argument include all, version, module, 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_gather_subset:
  description: The list of fact subsets collected from the device
  returned: always
  type: list
ansible_net_interfaces:
  description: A hash of all interfaces running on the system
  returned: when interfaces is configured
  type: dict
ansible_net_modules:
  description: A hash of all modules on the systeme with status
  returned: when modules is configured
  type: dict
ansible_net_version:
  description: A hash of all currently running system image information
  returned: when version is configured or when no gather_subset is provided
  type: dict