arubanetworks.aoscx.aoscx_facts (4.3.2) — module

Install collection

Install with ansible-galaxy collection install arubanetworks.aoscx:==4.3.2

Add to requirements.yml

  collections:
    - name: arubanetworks.aoscx
      version: 4.3.2

Description

This module retrieves facts from Aruba devices running the AOS-CX operating system. Facts will be printed out when the playbook execution is done with increased verbosity.

Usage examples

Scanned by Steampunk Spotter

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

- name: >
    Retrieve all information from the device and save into a variable
    "facts_output".
  aoscx_facts:
  register: facts_output

Scanned by Steampunk Spotter

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

- name: Retrieve power supply and domain name info from the device
  aoscx_facts:
    gather_subset:
      - domain_name
      - power_supplies

Scanned by Steampunk Spotter

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

- name: >
    Retrieve VRF info, host name, and fan info from the device and save into a
    variable.
  aoscx_facts:
    gather_subset:
      - fans
      - host_name
    gather_network_resources:
      - vrfs
  register: facts_subset_output

Inputs

    
gather_subset:
    choices:
    - config
    - domain_name
    - fans
    - host_name
    - management_interface
    - physical_interfaces
    - platform_name
    - power_supplies
    - product_info
    - resource_utilization
    - software_images
    - software_info
    - software_version
    default:
    - domain_name
    - fans
    - host_name
    - management_interface
    - physical_interfaces
    - platform_name
    - power_supplies
    - product_info
    - resource_utilization
    - software_images
    - software_info
    - software_version
    description: 'Retrieve a subset of all device information. This can be a single category
      or it can be a list. As warning, leaving this field blank returns all facts, which
      may be an intensive process.

      '
    elements: str
    required: false
    type: list

gather_network_resources:
    choices:
    - interfaces
    - vlans
    - vrfs
    - lldp_neighbors
    description: 'Retrieve vlan, interface, lldp_neighbors or vrf information. This can
      be a single category or it can be a list. Leaving this field blank returns all interfaces,
      vlans, and vrfs.

      '
    elements: str
    required: false
    type: list

Outputs

ansible_net_domain_name:
  description: The domain name returned from the device
  returned: always
  type: str
ansible_net_fans:
  description: The fan information returned from the device
  returned: always
  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 dictionary of all interfaces running on the system
  returned: always
  type: dict
ansible_net_mgmt_intf_status:
  description: A dictionary of management interfaces running on the system
  returned: always
  type: dict
ansible_net_platform_name:
  description: The platform name returned from the device
  returned: always
  type: str
ansible_net_power_supplies:
  description: All power supplies available on the device
  returned: always
  type: dict
ansible_net_product_info:
  description: The product system information returned from the device
  returned: always
  type: dict
ansible_net_resource_utilization:
  description: The resource utilization of the remote device
  returned: always
  type: dict
ansible_net_software_images:
  description: The software images on the remote device
  returned: always
  type: dict
ansible_net_software_info:
  description: The details of the software image running on the remote device
  returned: always
  type: dict
ansible_net_software_version:
  description: The software version running on the remote device
  returned: always
  type: str