ciena.saos10.saos10_facts (1.7.0) — module

Install collection

Install with ansible-galaxy collection install ciena.saos10:==1.7.0

Add to requirements.yml

  collections:
    - name: ciena.saos10
      version: 1.7.0

Description

Collects facts from network devices running the saos10 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

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Gather all facts
- saos10_facts:
    gather_subset: all
    gather_network_resources: all

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Collect only the classifiers facts
- saos10_facts:
    gather_subset:
      - "!all"
      - "!min"
    gather_network_resources:
      - classifiers

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Collect classifiers and minimal default facts
- saos10_facts:
    gather_subset: min
    gather_network_resources: classifiers

Inputs

    
config_format:
    choices:
    - xml
    - text
    - json
    default: xml
    description:
    - The I(config_format) argument specifies the format of the configuration when serializing
      output from the device. This argument is applicable only when C(config) value is
      present in I(gather_subset). The I(config_format) should be supported by the waveserver
      version running on device. This value is not applicable while fetching old style
      facts that is when C(ofacts) value is present in value if I(gather_subset) value.
      This option is valid only for C(gather_subset) values.
    required: false
    type: str

gather_subset:
    default:
    - '!config'
    description:
    - When supplied, this argument will restrict the facts collected to a given subset.  Possible
      values for this argument include C(all), C(default), C(config), C(min). Can specify
      a list of values to include a larger subset.
    elements: str
    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(!) to specify that a specific subset should not be collected.
      Valid subsets are 'all', 'interfaces'
    elements: str
    required: false
    type: list
    version_added: 0.0.1
    version_added_collection: ciena.saos10

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