arubanetworks.aos_switch.arubaoss_facts (1.7.0) — module

Install collection

Install with ansible-galaxy collection install arubanetworks.aos_switch:==1.7.0

Add to requirements.yml

  collections:
    - name: arubanetworks.aos_switch
      version: 1.7.0

Description

This module retrieves facts from Aruba devices running the PVOS 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"
  arubaoss_facts:
  register: facts_output

Scanned by Steampunk Spotter

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

- name: Retrieve power supply and modules info from the device
  arubaoss_facts:
    gather_subset: ['system_power_supply', 'module_info']

Scanned by Steampunk Spotter

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

- name: Retrieve ACL info and host system info from the device and save into a variable
  arubaoss_facts:
    gather_subset: ['host_system_info']
    gather_network_resources: ['acls']
  register: facts_subset_output

Inputs

    
provider:
    description: A dict object containing connection details.
    suboptions:
      api_version:
        default: None
        description: 'Configures (force) API version (vX.Y) for acces to the remote device.

          '
        type: str
      host:
        description: 'Specifies the DNS host name or address for connecting to the remote
          device over the specified transport. The value of host is used as the destination
          address for the transport.

          '
        type: str
      password:
        description: 'Specifies the password to use to authenticate the connection to
          the remote device. This value is used to authenticate the SSH session. If the
          value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD
          will be used instead.

          '
        type: str
      port:
        description: 'Specifies the port to use when building the connection to the remote
          device.

          '
        type: int
      ssh_keyfile:
        description: 'Specifies the SSH key to use to authenticate the connection to the
          remote device. This value is the path to the key used to authenticate the SSH
          session. If the value is not specified in the task, the value of environment
          variable ANSIBLE_NET_SSH_KEYFILE will be used instead.

          '
        type: path
      timeout:
        description: 'Specifies the timeout in seconds for communicating with the network
          device for either connecting or sending commands. If the timeout is exceeded
          before the operation is completed, the module will error.

          '
        type: int
      transport:
        default: aossapi
        description: 'Configures the transport (aossapi or network_cli) mode.

          '
        type: str
      use_proxy:
        default: false
        description: 'Configures use (Local) Proxy for access to the remote device.

          '
        type: bool
      use_ssl:
        description: 'Configures use SSL (HTTPS) for access to the remote device.

          '
        type: bool
      username:
        description: 'Configures the username to use to authenticate the connection to
          the remote device. This value is used to authenticate the SSH session. If the
          value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME
          will be used instead.

          '
        type: str
      validate_certs:
        default: false
        description: 'Configures validation of certification for access to the remote
          device.

          '
        type: bool
    type: dict

gather_subset:
    choices:
    - host_system_info
    - switch_specific_system_info
    - module_info
    - system_power_supply
    default:
    - host_system_info
    - switch_specific_system_info
    - module_info
    - system_power_supply
    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.
    required: false
    type: list

gather_network_resources:
    choices:
    - interfaces
    - vlans
    - vlans_ports
    - vlan_port_element
    - loop_protect_status
    - loop_protect_ports
    - loop_protect_vlans
    - acls
    - lacp_interfaces
    - lldp_neighbors
    description:
    - Retrieve vlan, interface, acl, lacp interfaces or lldp neighbors information. This
      can be a single category or it can be a list. Leaving this field blank returns all
      interfaces, vlans, vlan-port assignments, loop protect status/ports/vlans, acl,
      lacp interfaces and lldp neighbors.
    required: false
    type: list

Outputs

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_host_system_info:
  description: The host system info returned from the device
  returned: always
  type: dict
ansible_net_interfaces:
  description: A dictionary of all interfaces running on the system
  returned: always
  type: dict
ansible_net_module_info:
  description: The modules info returned from the device
  returned: always
  type: dict
ansible_net_switch_specific_system_info:
  description: The switch specific system info returned from the device
  returned: always
  type: dict
ansible_net_system_power_supply:
  description: All power supplies available on the device
  returned: always
  type: dict