alliedtelesis.awplus.awplus_facts (1.0.0) — module

Install collection

Install with ansible-galaxy collection install alliedtelesis.awplus:==1.0.0

Add to requirements.yml

  collections:
    - name: alliedtelesis.awplus
      version: 1.0.0

Description

Collects facts from network devices running the AlliedWare Plus 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
- awplus_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 interfaces facts
- awplus_facts:
    gather_subset:
      - "!all"
      - "!min"
    gather_network_resources:
      - interfaces

Scanned by Steampunk Spotter

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

# Do not collect interfaces facts
- awplus_facts:
    gather_network_resources:
      - "!interfaces"

Scanned by Steampunk Spotter

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

# Collect interfaces and minimal default facts
- awplus_facts:
    gather_subset: min
    gather_network_resources: interfaces

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, min, hardware, config, legacy, 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

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.
    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 IPv6 addresses configured on the device
  returned: when interfaces is configured
  type: list
ansible_net_api:
  description: The name of the transport
  returned: always
  type: str
ansible_net_config:
  description: The current active config from the device
  returned: when config is configured
  type: str
ansible_net_filesystems:
  description: All file system names available on the device
  returned: when hardware is configured
  type: list
ansible_net_filesystems_info:
  description: A hash of all file systems containing info about each file system (e.g.
    free and total space)
  returned: when hardware is configured
  type: dict
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 CDP and LLDP neighbors from the remote device. If both, CDP and LLDP
    neighbor data is present on one port, CDP is preferred.
  returned: when interfaces is configured
  type: dict
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 remote device
  returned: always
  type: str
ansible_net_stacked_models:
  description: The model names of each device in the stack
  returned: when multiple devices are configured in a stack
  type: list
ansible_net_stacked_serialnums:
  description: The serial numbers of each device in the stack
  returned: when multiple devices are configured in a stack
  type: list
ansible_net_version:
  description: The operating system version running on the remote device
  returned: always
  type: str