SNMP::Info::Layer3::Aruba(3p)

NAME
SNMP::Info::Layer3::Aruba - SNMP Interface to Aruba wireless switches

AUTHOR
Eric Miller

SYNOPSIS
    my $aruba = new SNMP::Info(
                          AutoSpecify => 1,
                          Debug       => 1,
                          DestHost    => 'myswitch',
                          Community   => 'public',
                          Version     => 2
                        )

    or die "Can't connect to DestHost.\n";

    my $class = $aruba->class();
    print " Using device sub class : $class\n";

DESCRIPTION
SNMP::Info::Layer3::Aruba is a subclass of SNMP::Info that provides an interface to Aruba wireless switches. The Aruba platform utilizes intelligent wireless switches which control thin access points. The thin access points themselves are unable to be polled for end station information.

This class emulates bridge functionality for the wireless switch. This enables end station MAC addresses collection and correlation to the thin access point the end station is using for communication.

  Inherited Classes

SNMP::Info::Layer3

  Required MIBs

WLSR-AP-MIB
WLSX-IFEXT-MIB
WLSX-POE-MIB
WLSX-SWITCH-MIB
WLSX-SYSTEMEXT-MIB
WLSX-USER-MIB
WLSX-WLAN-MIB

  Inherited MIBs
See "Required MIBs" in SNMP::Info::Layer3 for its MIB requirements.

GLOBALS
These are methods that return scalar value from SNMP

$aruba->model()
    Returns model type. Cross references $aruba->id() with product IDs in the Aruba MIB.

$aruba->vendor()
    Returns 'aruba'

$aruba->os()
    Returns 'airos'

$aruba->os_ver()
    Returns the software version extracted from "sysDescr"

  Overrides

$aruba->layers()
    Returns 00000111. Class emulates Layer 2 and Layer 3functionality for Thin APs through proprietary MIBs.

$aruba->serial()
    Returns the device serial number extracted from "wlsxSwitchLicenseSerialNumber" or "wlsxSysExtLicenseSerialNumber"

  Globals imported from SNMP::Info::Layer3
See "GLOBALS" in SNMP::Info::Layer3 for details.

TABLE METHODS
These are methods that return tables of information in the form of a reference to a hash.

$aruba->i_80211channel()
    Returns reference to hash. Current operating frequency channel of the radio interface.

    ("wlanAPRadioChannel")

$aruba->dot11_cur_tx_pwr_mw()
    Returns reference to hash. Current transmit power, in milliwatts, of the radio interface.

    ("wlanAPRadioTransmitPower")

$aruba->i_ssidlist()
    Returns reference to hash. SSID's recognized by the radio interface.

    ("wlanAPESSID")

$aruba->i_ssidbcast()
    Returns reference to hash. Indicates whether the SSID is broadcast, true or false.

    ("wlsrHideSSID")

$aruba->i_ssidmac()
    With the same keys as i_ssidlist, returns the Basic service set identification (BSSID), MAC address, the AP is using for the SSID.

$aruba->cd11_mac()
    Returns client radio interface MAC addresses.

$aruba->cd11_sigqual()
    Returns client signal quality.

$aruba->cd11_txrate()
    Returns to hash of arrays. Client transmission speed in Mbs.

$aruba->cd11_rxbyte()
    Total bytes received by the wireless client.

$aruba->cd11_txbyte()
    Total bytes transmitted by the wireless client.

$aruba->cd11_rxpkt()
    Total packets received by the wireless client.

$aruba->cd11_txpkt()
    Total packets transmitted by the wireless client.

  Overrides

$aruba->i_index()
    Returns reference to map of IIDs to Interface index.

    Extends "ifIndex" to support APs as device interfaces.

$aruba->interfaces()
    Returns reference to map of IIDs to ports. Thin APs are implemented as device interfaces. The thin AP MAC address and radio number ("wlanAPRadioNumber") are combined as the port identifier.

$aruba->i_name()
    Interface name. Returns ("ifName") for Ethernet interfaces and ("wlanAPRadioAPName") for AP interfaces.

$aruba->i_description()
    Returns reference to map of IIDs to interface descriptions. Returns "ifDescr" for Ethernet interfaces and the Fully Qualified Location Name ("wlanAPFQLN") for AP interfaces.

$aruba->i_type()
    Returns reference to map of IIDs to interface types. Returns "ifType" for Ethernet interfaces and "wlanAPRadioType" for AP interfaces.

$aruba->i_up()
    Returns reference to map of IIDs to link status of the interface. Returns "ifOperStatus" for Ethernet interfaces and "wlanAPStatus" for AP interfaces.

$aruba->i_up_admin()
    Returns reference to map of IIDs to administrative status of the interface. Returns "ifAdminStatus" for Ethernet interfaces and "wlanAPStatus" for AP interfaces.

$aruba->i_mac()
    Interface MAC address. Returns interface MAC address for Ethernet interfaces of ports and APs.

$aruba->i_duplex()
    Returns reference to map of IIDs to current link duplex. Ethernet interfaces only.

$aruba->v_index()
    Returns VLAN IDs.

$aruba->v_name()
    Human-entered name for vlans.

$aruba->i_vlan()
    Returns reference to map of IIDs to VLAN ID of the interface.

$aruba->i_vlan_membership()
    Returns reference to hash of arrays: key = "ifIndex", value = array of VLAN IDs. These are the VLANs for which the port is a member.

$aruba->i_vlan_membership_untagged()
    Returns reference to hash of arrays: key = "ifIndex", value = array of VLAN IDs. These are the VLANs which are members of the untagged egress list for the port.

$aruba->bp_index()
    Augments the bridge MIB by returning reference to a hash containing the index mapping of BSSID to device port (AP).

$aruba->fw_port()
    Augments the bridge MIB by including the BSSID a wireless end station is communicating through ("nUserApBSSID").

$aruba->fw_mac()
    Augments the bridge MIB by including the wireless end station MAC ("nUserApBSSID") as extracted from the IID.

$aruba->qb_fw_vlan()
    Augments the bridge MIB by including wireless end station VLANs ("nUserCurrentVlan").

  Pseudo ENTITY-MIB information
These methods emulate ENTITY-MIB Physical Table methods using WLSX-WLAN-MIB and WLSX-SYSTEMEXT-MIB. APs are included as subcomponents of the wireless controller.

$aruba->e_index()
    Returns reference to hash. Key: IID and Value: Integer. The index for APs is created with an integer representation of the last three octets of the AP MAC address.

$aruba->e_class()
    Returns reference to hash. Key: IID, Value: General hardware type. Returns 'ap' for wireless access points.

$aruba->e_name()
    More computer friendly name of entity. Name is 'WLAN Controller' for the chassis, Card # for modules, or 'AP'.

$aruba->e_descr()
    Returns reference to hash. Key: IID, Value: Human friendly name.

$aruba->e_model()
    Returns reference to hash. Key: IID, Value: Model name.

$aruba->e_type()
    Returns reference to hash. Key: IID, Value: Type of component.

$aruba->e_hwver()
    Returns reference to hash. Key: IID, Value: Hardware revision.

$aruba->e_swver()
    Returns reference to hash. Key: IID, Value: Software revision.

$aruba->e_vendor()
    Returns reference to hash. Key: IID, Value: aruba.

$aruba->e_serial()
    Returns reference to hash. Key: IID, Value: Serial number.

$aruba->e_pos()
    Returns reference to hash. Key: IID, Value: The relative position among all entities sharing the same parent. Chassis cards are ordered to come before APs.

$aruba->e_parent()
    Returns reference to hash. Key: IID, Value: The value of e_index() for the entity which 'contains' this entity.

  Power Over Ethernet Port Table
These methods emulate the POWER-ETHERNET-MIB Power Source Entity (PSE) Port Table "pethPsePortTable" methods using the WLSX-POE-MIB Power over Ethernet Port Table "wlsxPsePortTable".

$aruba->peth_port_ifindex()
    Creates an index of module.port to align with the indexing of the "wlsxPsePortTable" with a value of "ifIndex". The module defaults 1 if otherwise unknown.

$aruba->peth_port_admin()
    Administrative status: is this port permitted to deliver power?

    "wlsxPsePortAdminStatus"

$aruba->peth_port_status()
    Current status: is this port delivering power.

$aruba->peth_port_class()
    Device class: if status is delivering power, this represents the 802.3af class of the device being powered.

$aruba->peth_port_neg_power()
    The power, in milliwatts, that has been committed to this port. This value is derived from the 802.3af class of the device being powered.

$aruba->peth_port_power()
    The power, in milliwatts, that the port is delivering.

  Power Over Ethernet Module Table
These methods emulate the POWER-ETHERNET-MIB Main Power Source Entity (PSE) Table "pethMainPseTable" methods using the WLSX-POE-MIB Power over Ethernet Port Table "wlsxPseSlotTable".

$aruba->peth_power_watts()
    The power supply's capacity, in watts.

$aruba->peth_power_status()
    The power supply's operational status.

$aruba->peth_power_consumption()
    How much power, in watts, this power supply has been committed to deliver.

  Arp Cache Table Augmentation
The controller has knowledge of MAC->IP mappings for wireless clients. Augmenting the arp cache data with these MAC->IP mappings enables visibility for stations that only communicate locally. We also capture the AP MAC->IP mappings.

$aruba->at_paddr()
    Adds MAC addresses extracted from the index of "nUserApBSSID".

$aruba->at_netaddr()
    Adds IP addresses extracted from the index of "nUserApBSSID".

  Table Methods imported from SNMP::Info::Layer3
See "TABLE METHODS" in SNMP::Info::Layer3 for details.

Data Munging Callback Subroutines

$aruba->munge_aruba_fqln()
    Remove nulls encoded as '\.0' from the Fully Qualified Location Name ("wlanAPFQLN").