/ home / ciena / ciena.saos8 / 1.0.1 / module / saos8_facts

ciena.saos8.saos8_facts (1.0.1) — module

Get facts about saos8 devices.

| "added in version" 1.0.0 of ciena.saos8"

Authors: Jeff Groom

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install ciena.saos8:==1.0.1

Add to requirements.yml

  collections:
    - name: ciena.saos8
      version: 1.0.1

Description

Collects facts from network devices running the saos8 operating system. This module places the facts gathered in the fact tree keyed by the respective resource name. 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 facts
  ciena.saos8.saos8_facts:
    gather_subset: all
    gather_network_resources: all

Scanned by Steampunk Spotter

- name: collect config and default facts
  ciena.saos8.saos8_facts:
    gather_subset: config

Scanned by Steampunk Spotter

- name: collect everything exception the config
  ciena.saos8.saos8_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

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.
      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', 'interfaces', 'neighbors'
    required: false

Outputs

ansible_net_api:
  description: The name of the transport
  returned: always
  type: str
ansible_net_config:
  description: The running-config from the device
  returned: when config is configured
  type: str
ansible_net_gather_network_resources:
  description: The list of fact resource subsets collected from the device
  returned: always
  type: list
ansible_net_gather_subset:
  description: The list of subsets gathered by the module
  returned: always
  type: list
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_python_version:
  description: The Python version Ansible controller is using
  returned: always
  type: str
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