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.

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->bp_index()

Returns reference to hash. Key: IF-MIB index, Value: the same index. No Ruckus access point seen serves BRIDGE-MIB, and the station tables are keyed by interface, 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 interface is added.

(ruckusWLANStaAddr)

$ruckus->fw_port()

Returns reference to hash of forwarding table entries' interface, with the same keys as fw_mac(). A station's interface is the first part of its index.

(ruckusWLANStaAddr)

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: IF-MIB index. The MIB indexes the table by this value, so the row and the index normally match.

(ruckusWLANIfIndex)

Ruckus Station Table (`ruckusWLANStaTable`)

$ruckus->ruckus_station_mac()

Returns reference to hash. Key: IF-MIB index, 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: IF-MIB index, 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: IF-MIB index 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. Only WLAN rows whose admin status is up and whose IF-MIB index exists are returned.

$ruckus->i_ssidlist()

Returns reference to hash. Key: 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: IF-MIB index, Value: channel. Each WLAN on a radio repeats its channel, so the lowest WLAN row is used.

(ruckusWLANChannel)

$ruckus->fw_ssid()

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

(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: IF-MIB index, 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.

To install SNMP::Info, copy and paste the appropriate command in to your terminal.

cpanm

cpanm SNMP::Info

CPAN shell

perl -MCPAN -e shell
install SNMP::Info

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	Go to GitHub issues (only if GitHub is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

AUTHOR

SYNOPSIS

DESCRIPTION

Inherited Classes

Required MIBs

Inherited MIBs

GLOBALS

Overrides

Global Methods imported from SNMP::Info::Layer2

TABLE METHODS

Overrides

Ruckus Software Revision Table (ruckusSwRevTable)

Ruckus WLAN Table (ruckusWLANTable)

Ruckus Station Table (ruckusWLANStaTable)

Ruckus Station Statistics Table (ruckusWLANStaStatsTable)

Ruckus Station Rks Table (ruckusWLANStaRksTable)

802.11 SSID and Channel Table Emulation

Wireless Client Table Emulation

Table Methods imported from SNMP::Info::Layer2

Module Install Instructions

Keyboard Shortcuts

Ruckus Software Revision Table (`ruckusSwRevTable`)

Ruckus WLAN Table (`ruckusWLANTable`)

Ruckus Station Table (`ruckusWLANStaTable`)

Ruckus Station Statistics Table (`ruckusWLANStaStatsTable`)

Ruckus Station Rks Table (`ruckusWLANStaRksTable`)