/ 
SNMP-Info-3.985000
⭐ Starred 39 / SNMP::Info::Layer2::RuckusAP

NAME

SNMP::Info::Layer2::RuckusAP - SNMP interface to Ruckus access points

AUTHOR

SNMP::Info Developers

SYNOPSIS

# Let SNMP::Info determine the correct subclass for you.
my $ruckus = new SNMP::Info(
                         AutoSpecify => 1,
                         Debug       => 1,
                         DestHost    => 'myap',
                         Community   => 'public',
                         Version     => 2
                       )
   or die "Can't connect to DestHost.\n";

my $class = $ruckus->class();
print "SNMP::Info determined this device to fall under subclass : $class\n";

DESCRIPTION

Provides model, serial number, and software version information for Ruckus access points registered below the Ruckus wireless product OID branches, and for Unleashed access points identified by sysDescr. It also maps active WLANs, radio channels, and associated station data to the standard SNMP::Info wireless methods, with one port per radio.

Inherited Classes

SNMP::Info::Layer2

Required MIBs

RUCKUS-HWINFO-MIB
RUCKUS-SWINFO-MIB
RUCKUS-WLAN-MIB

Inherited MIBs

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

GLOBALS

These methods return scalar values.

$ruckus->ruckus_model()

Returns the model number reported by the access point.

(ruckusHwInfoModelNumber)

$ruckus->ruckus_serial()

Returns the serial number reported by the access point.

(ruckusHwInfoSerialNumber)

Overrides

$ruckus->layers()

Ruckus access points do not implement sysServices. Returns the layer 2 capability bit so layer-aware applications can collect wireless client MACs.

$ruckus->vendor()

Returns ruckus.

$ruckus->os()

Returns ruckus.

$ruckus->model()

Returns the model from ruckusHwInfoModelNumber. Unleashed access points do not answer it, so the model named in sysDescr is used next, then the inherited model method.

$ruckus->serial()

Returns the serial number from ruckusHwInfoSerialNumber, falling back to the inherited serial method.

$ruckus->os_ver()

Returns the software revision whose ruckusSwRevStatus is active. When no revision has a status, returns the lowest-indexed revision, then falls back to the inherited method.

Global Methods imported from SNMP::Info::Layer2

See "GLOBALS" in SNMP::Info::Layer2 for details.

TABLE METHODS

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

Overrides

$ruckus->interfaces()

Returns reference to hash. As the inherited method, without the WLAN interfaces that belong to a radio: their SSIDs and stations are on the radio's port.

$ruckus->bp_index()

Returns reference to hash. Key: IF-MIB index, Value: the same index. No Ruckus access point seen serves BRIDGE-MIB, and fw_port() returns the radio's IF-MIB index, so each interface is its own bridge port.

$ruckus->fw_mac()

Returns reference to hash of forwarding table MAC addresses. Inherited entries are kept, and each station on an active WLAN with a port is added.

(ruckusWLANStaAddr)

$ruckus->fw_port()

Returns reference to hash of forwarding table entries' interface, with the same keys as fw_mac(). The first part of a station's index is its WLAN number, and the station is placed on that WLAN's port: its radio, as described under i_ssidlist().

(ruckusWLANStaAddr)

$ruckus->i_vlan_membership()

Returns reference to hash. Key: port index, Value: reference to a sorted array of the VLANs of the port's active WLANs. A VLAN of 0 is skipped.

(ruckusWLANVlanID)

$ruckus->qb_fw_vlan()

Returns reference to hash, with the same keys as fw_mac(). Inherited entries are kept; each station takes its WLAN's VLAN. No station table has a VLAN column, so a VLAN assigned per client is not reported.

(ruckusWLANVlanID)

Ruckus Software Revision Table (ruckusSwRevTable)

$ruckus->ruckus_sw_rev()

Returns reference to hash. Key: revision index, Value: software revision.

(ruckusSwRevision)

$ruckus->ruckus_sw_rev_status()

Returns reference to hash. Key: revision index, Value: active for the running revision, otherwise inactive.

(ruckusSwRevStatus)

Ruckus WLAN Table (ruckusWLANTable)

$ruckus->ruckus_wlan_ssid()

Returns reference to hash. Key: WLAN row, Value: SSID name.

(ruckusWLANSSID)

$ruckus->ruckus_wlan_bssid()

Returns reference to hash. Key: WLAN row, Value: BSSID.

(ruckusWLANBSSID)

$ruckus->ruckus_wlan_channel()

Returns reference to hash. Key: WLAN row, Value: channel.

(ruckusWLANChannel)

$ruckus->ruckus_wlan_admin_status()

Returns reference to hash. Key: WLAN row, Value: admin status.

(ruckusWLANAdminStatus)

$ruckus->ruckus_wlan_bcast_disabled()

Returns reference to hash. Key: WLAN row, Value: SSID broadcast disable flag.

(ruckusWLANSSIDBcastDisable)

$ruckus->ruckus_wlan_ifindex()

Returns reference to hash. Key: WLAN row, Value: the table's index. The MIB calls it an interface index, but access points return the WLAN number (wlan5 is row 5), not an IF-MIB index.

(ruckusWLANIfIndex)

$ruckus->ruckus_wlan_name()

Returns reference to hash. Key: WLAN row, Value: WLAN interface name, as the IF-MIB ifDescr of that WLAN's interface.

(ruckusWLANName)

$ruckus->ruckus_wlan_vlan()

Returns reference to hash. Key: WLAN row, Value: the WLAN's VLAN ID.

(ruckusWLANVlanID)

Ruckus Station Table (ruckusWLANStaTable)

$ruckus->ruckus_station_mac()

Returns reference to hash. Key: WLAN number, address length and station address, Value: station MAC address.

(ruckusWLANStaAddr)

$ruckus->ruckus_station_rates()

Returns reference to hash. Key: as ruckus_station_mac(), Value: supported rates.

(ruckusWLANStaRates)

Ruckus Station Statistics Table (ruckusWLANStaStatsTable)

$ruckus->ruckus_station_stats_mac()

Returns reference to hash. Key: WLAN number, address length and station address, Value: station MAC address.

(ruckusWLANStaStatsMacAddr)

$ruckus->ruckus_station_stats_ssid()

Returns reference to hash. Key: as ruckus_station_stats_mac(), Value: SSID name.

(ruckusWLANStaStatsSSID)

$ruckus->ruckus_station_stats_rxpkt()

Returns reference to hash. Key: as ruckus_station_stats_mac(), Value: received data frames.

(ruckusWLANStaStatsRxDataFrames)

$ruckus->ruckus_station_stats_rxbyte()

Returns reference to hash. Key: as ruckus_station_stats_mac(), Value: received bytes.

(ruckusWLANStaStatsRxBytes)

$ruckus->ruckus_station_stats_txpkt()

Returns reference to hash. Key: as ruckus_station_stats_mac(), Value: transmitted data frames.

(ruckusWLANStaStatsTxDataFrames)

$ruckus->ruckus_station_stats_txbyte()

Returns reference to hash. Key: as ruckus_station_stats_mac(), Value: transmitted bytes.

(ruckusWLANStaStatsTxBytes)

$ruckus->ruckus_station_stats_rssi()

Returns reference to hash. Key: as ruckus_station_stats_mac(), Value: received signal strength indicator, as the agent reports it.

(ruckusWLANStaStatsRSSI)

Ruckus Station Rks Table (ruckusWLANStaRksTable)

$ruckus->ruckus_station_rks_txrate()

Returns reference to hash. Key: WLAN number and station address, without the address length, Value: current transmit PHY rate in Kbps.

(ruckusWLANStaRksTxRate)

802.11 SSID and Channel Table Emulation

These methods emulate the IEEE802dot11-MIB SSID and channel methods using the RUCKUS-WLAN-MIB ruckusWLANTable, on one port per radio. Only WLAN rows whose admin status is up are returned.

No column names a WLAN's radio. The access point numbers WLANs 0 to 31 on radio wifi0 and 32 to 63 on wifi1, so a WLAN's port is the IF-MIB interface named wifi followed by its WLAN number divided by 32. A WLAN with no such radio interface stays on its own interface, the one whose ifDescr equals its ruckusWLANName.

$ruckus->i_ssidlist()

Returns reference to hash. Key: port IF-MIB index and WLAN row, Value: SSID.

(ruckusWLANSSID)

$ruckus->i_ssidmac()

Returns reference to hash. Key: as i_ssidlist(), Value: BSSID.

(ruckusWLANBSSID)

$ruckus->i_ssidbcast()

Returns reference to hash. Key: as i_ssidlist(), Value: 1 when the SSID is broadcast, otherwise 0.

(ruckusWLANSSIDBcastDisable)

$ruckus->i_80211channel()

Returns reference to hash. Key: port IF-MIB index, Value: channel. Each WLAN on a radio repeats its channel, so the lowest WLAN row is used. ruckusRadioChannel is not used: access points return 0.

(ruckusWLANChannel)

$ruckus->fw_ssid()

Returns reference to hash. Key: as fw_mac(), Value: the SSID of the station's WLAN.

(ruckusWLANSSID)

Wireless Client Table Emulation

These methods emulate the CISCO-DOT11-ASSOCIATION-MIB cd11_* methods using the RUCKUS-WLAN-MIB station tables. Keys are the station statistics index: WLAN number, address length and station address. The MIB exposes no signal quality or noise, so cd11_sigqual() is not provided.

$ruckus->cd11_mac()

Returns reference to hash. Value: client MAC address.

(ruckusWLANStaStatsMacAddr)

$ruckus->cd11_ssid()

Returns reference to hash. Value: SSID the client is associated with.

(ruckusWLANStaStatsSSID)

$ruckus->cd11_txrate()

Returns reference to hash. Value: array reference holding the current transmit PHY rate in Mbps.

(ruckusWLANStaRksTxRate)

$ruckus->cd11_rateset()

Returns reference to hash. Value: array reference of supported rates in Mbps, from a list of numbers or from 802.11 rate octets.

(ruckusWLANStaRates)

$ruckus->cd11_sigstrength()

Returns reference to hash. Value: received signal strength indicator, as the agent reports it.

(ruckusWLANStaStatsRSSI)

$ruckus->cd11_rxpkt()

Returns reference to hash. Value: received data frames.

(ruckusWLANStaStatsRxDataFrames)

$ruckus->cd11_txpkt()

Returns reference to hash. Value: transmitted data frames.

(ruckusWLANStaStatsTxDataFrames)

$ruckus->cd11_rxbyte()

Returns reference to hash. Value: received bytes.

(ruckusWLANStaStatsRxBytes)

$ruckus->cd11_txbyte()

Returns reference to hash. Value: transmitted bytes.

(ruckusWLANStaStatsTxBytes)

Table Methods imported from SNMP::Info::Layer2

See "TABLE METHODS" in SNMP::Info::Layer2 for details.