1SNMP::Info::Layer3::AruUbsae(r3)Contributed Perl DocumenStNaMtPi:o:nInfo::Layer3::Aruba(3)
2
3
4

NAME

6       SNMP::Info::Layer3::Aruba - SNMP Interface to Aruba wireless switches
7

AUTHOR

9       Eric Miller
10

SYNOPSIS

12           my $aruba = new SNMP::Info(
13                                 AutoSpecify => 1,
14                                 Debug       => 1,
15                                 DestHost    => 'myswitch',
16                                 Community   => 'public',
17                                 Version     => 2
18                               )
19
20           or die "Can't connect to DestHost.\n";
21
22           my $class = $aruba->class();
23           print " Using device sub class : $class\n";
24

DESCRIPTION

26       SNMP::Info::Layer3::Aruba is a subclass of SNMP::Info that provides an
27       interface to Aruba wireless switches.  The Aruba platform utilizes
28       intelligent wireless switches which control thin access points.  The
29       thin access points themselves are unable to be polled for end station
30       information.
31
32       This class emulates bridge functionality for the wireless switch. This
33       enables end station MAC addresses collection and correlation to the
34       thin access point the end station is using for communication.
35
36       For speed or debugging purposes you can call the subclass directly, but
37       not after determining a more specific class using the method above.
38
39        my $aruba = new SNMP::Info::Layer3::Aruba(...);
40
41   Inherited Classes
42       SNMP::Info::Layer3
43
44   Required MIBs
45       WLSR-AP-MIB
46       WLSX-IFEXT-MIB
47       WLSX-POE-MIB
48       WLSX-SWITCH-MIB
49       WLSX-SYSTEMEXT-MIB
50       WLSX-USER-MIB
51       WLSX-WLAN-MIB
52
53   Inherited MIBs
54       See "Required MIBs" in SNMP::Info::Layer3 for its MIB requirements.
55

GLOBALS

57       These are methods that return scalar value from SNMP
58
59       $aruba->model()
60           Returns model type.  Cross references $aruba->id() with product IDs
61           in the Aruba MIB.
62
63       $aruba->vendor()
64           Returns 'aruba'
65
66       $aruba->os()
67           Returns 'airos'
68
69       $aruba->os_ver()
70           Returns the software version extracted from "sysDescr"
71
72   Overrides
73       $aruba->layers()
74           Returns 00000111.  Class emulates Layer 2 and Layer 3functionality
75           for Thin APs through proprietary MIBs.
76
77       $aruba->serial()
78           Returns the device serial number extracted from
79           "wlsxSwitchLicenseSerialNumber" or "wlsxSysExtLicenseSerialNumber"
80
81   Globals imported from SNMP::Info::Layer3
82       See "GLOBALS" in SNMP::Info::Layer3 for details.
83

TABLE METHODS

85       These are methods that return tables of information in the form of a
86       reference to a hash.
87
88       $aruba->i_80211channel()
89           Returns reference to hash.  Current operating frequency channel of
90           the radio interface.
91
92           ("wlanAPRadioChannel")
93
94       $aruba->dot11_cur_tx_pwr_mw()
95           Returns reference to hash.  Current transmit power, in milliwatts,
96           of the radio interface.
97
98           ("wlanAPRadioTransmitPower")
99
100       $aruba->i_ssidlist()
101           Returns reference to hash.  SSID's recognized by the radio
102           interface.
103
104           ("wlanAPESSID")
105
106       $aruba->i_ssidbcast()
107           Returns reference to hash.  Indicates whether the SSID is
108           broadcast, true or false.
109
110           ("wlsrHideSSID")
111
112       $aruba->i_ssidmac()
113           With the same keys as i_ssidlist, returns the Basic service set
114           identification (BSSID), MAC address, the AP is using for the SSID.
115
116       $aruba->cd11_mac()
117           Returns client radio interface MAC addresses.
118
119       $aruba->cd11_sigqual()
120           Returns client signal quality.
121
122       $aruba->cd11_txrate()
123           Returns to hash of arrays.  Client transmission speed in Mbs.
124
125       $aruba->cd11_rxbyte()
126           Total bytes received by the wireless client.
127
128       $aruba->cd11_txbyte()
129           Total bytes transmitted by the wireless client.
130
131       $aruba->cd11_rxpkt()
132           Total packets received by the wireless client.
133
134       $aruba->cd11_txpkt()
135           Total packets transmitted by the wireless client.
136
137   Overrides
138       $aruba->i_index()
139           Returns reference to map of IIDs to Interface index.
140
141           Extends "ifIndex" to support APs as device interfaces.
142
143       $aruba->interfaces()
144           Returns reference to map of IIDs to ports.  Thin APs are
145           implemented as device interfaces.  The thin AP MAC address and
146           radio number ("wlanAPRadioNumber") are combined as the port
147           identifier.
148
149       $aruba->i_name()
150           Interface name.  Returns ("ifName") for Ethernet interfaces and
151           ("wlanAPRadioAPName") for AP interfaces.
152
153       $aruba->i_description()
154           Returns reference to map of IIDs to interface descriptions.
155           Returns "ifDescr" for Ethernet interfaces and the Fully Qualified
156           Location Name ("wlanAPFQLN") for AP interfaces.
157
158       $aruba->i_type()
159           Returns reference to map of IIDs to interface types.  Returns
160           "ifType" for Ethernet interfaces and "wlanAPRadioType" for AP
161           interfaces.
162
163       $aruba->i_up()
164           Returns reference to map of IIDs to link status of the interface.
165           Returns "ifOperStatus" for Ethernet interfaces and "wlanAPStatus"
166           for AP interfaces.
167
168       $aruba->i_up_admin()
169           Returns reference to map of IIDs to administrative status of the
170           interface.  Returns "ifAdminStatus" for Ethernet interfaces and
171           "wlanAPStatus" for AP interfaces.
172
173       $aruba->i_mac()
174           Interface MAC address.  Returns interface MAC address for Ethernet
175           interfaces of ports and APs.
176
177       $aruba->i_duplex()
178           Returns reference to map of IIDs to current link duplex.  Ethernet
179           interfaces only.
180
181       $aruba->v_index()
182           Returns VLAN IDs.
183
184       $aruba->v_name()
185           Human-entered name for vlans.
186
187       $aruba->i_vlan()
188           Returns reference to map of IIDs to VLAN ID of the interface.
189
190       $aruba->i_vlan_membership()
191           Returns reference to hash of arrays: key = "ifIndex", value = array
192           of VLAN IDs.  These are the VLANs for which the port is a member.
193
194       $aruba->i_vlan_membership_untagged()
195           Returns reference to hash of arrays: key = "ifIndex", value = array
196           of VLAN IDs.  These are the VLANs which are members of the untagged
197           egress list for the port.
198
199       $aruba->bp_index()
200           Augments the bridge MIB by returning reference to a hash containing
201           the index mapping of BSSID to device port (AP).
202
203       $aruba->fw_port()
204           Augments the bridge MIB by including the BSSID a wireless end
205           station is communicating through ("nUserApBSSID").
206
207       $aruba->fw_mac()
208           Augments the bridge MIB by including the wireless end station MAC
209           ("nUserApBSSID") as extracted from the IID.
210
211       $aruba->qb_fw_vlan()
212           Augments the bridge MIB by including wireless end station VLANs
213           ("nUserCurrentVlan").
214
215   Pseudo ENTITY-MIB information
216       These methods emulate ENTITY-MIB Physical Table methods using WLSX-
217       WLAN-MIB and WLSX-SYSTEMEXT-MIB.  APs are included as subcomponents of
218       the wireless controller.
219
220       $aruba->e_index()
221           Returns reference to hash.  Key: IID and Value: Integer. The index
222           for APs is created with an integer representation of the last three
223           octets of the AP MAC address.
224
225       $aruba->e_class()
226           Returns reference to hash.  Key: IID, Value: General hardware type.
227           Returns 'ap' for wireless access points.
228
229       $aruba->e_name()
230           More computer friendly name of entity.  Name is 'WLAN Controller'
231           for the chassis, Card # for modules, or 'AP'.
232
233       $aruba->e_descr()
234           Returns reference to hash.  Key: IID, Value: Human friendly name.
235
236       $aruba->e_model()
237           Returns reference to hash.  Key: IID, Value: Model name.
238
239       $aruba->e_type()
240           Returns reference to hash.  Key: IID, Value: Type of component.
241
242       $aruba->e_hwver()
243           Returns reference to hash.  Key: IID, Value: Hardware revision.
244
245       $aruba->e_swver()
246           Returns reference to hash.  Key: IID, Value: Software revision.
247
248       $aruba->e_vendor()
249           Returns reference to hash.  Key: IID, Value: aruba.
250
251       $aruba->e_serial()
252           Returns reference to hash.  Key: IID, Value: Serial number.
253
254       $aruba->e_pos()
255           Returns reference to hash.  Key: IID, Value: The relative position
256           among all entities sharing the same parent. Chassis cards are
257           ordered to come before APs.
258
259       $aruba->e_parent()
260           Returns reference to hash.  Key: IID, Value: The value of e_index()
261           for the entity which 'contains' this entity.
262
263   Power Over Ethernet Port Table
264       These methods emulate the POWER-ETHERNET-MIB Power Source Entity (PSE)
265       Port Table "pethPsePortTable" methods using the WLSX-POE-MIB Power over
266       Ethernet Port Table "wlsxPsePortTable".
267
268       $aruba->peth_port_ifindex()
269           Creates an index of module.port to align with the indexing of the
270           "wlsxPsePortTable" with a value of "ifIndex".  The module defaults
271           1 if otherwise unknown.
272
273       $aruba->peth_port_admin()
274           Administrative status: is this port permitted to deliver power?
275
276           "wlsxPsePortAdminStatus"
277
278       $aruba->peth_port_status()
279           Current status: is this port delivering power.
280
281       $aruba->peth_port_class()
282           Device class: if status is delivering power, this represents the
283           802.3af class of the device being powered.
284
285       $aruba->peth_port_neg_power()
286           The power, in milliwatts, that has been committed to this port.
287           This value is derived from the 802.3af class of the device being
288           powered.
289
290       $aruba->peth_port_power()
291           The power, in milliwatts, that the port is delivering.
292
293   Power Over Ethernet Module Table
294       These methods emulate the POWER-ETHERNET-MIB Main Power Source Entity
295       (PSE) Table "pethMainPseTable" methods using the WLSX-POE-MIB Power
296       over Ethernet Port Table "wlsxPseSlotTable".
297
298       $aruba->peth_power_watts()
299           The power supply's capacity, in watts.
300
301       $aruba->peth_power_status()
302           The power supply's operational status.
303
304       $aruba->peth_power_consumption()
305           How much power, in watts, this power supply has been committed to
306           deliver.
307
308   Arp Cache Table Augmentation
309       The controller has knowledge of MAC->IP mappings for wireless clients.
310       Augmenting the arp cache data with these MAC->IP mappings enables
311       visibility for stations that only communicate locally.  We also capture
312       the AP MAC->IP mappings.
313
314       $aruba->at_paddr()
315           Adds MAC addresses extracted from the index of "nUserApBSSID".
316
317       $aruba->at_netaddr()
318           Adds IP addresses extracted from the index of "nUserApBSSID".
319
320   Table Methods imported from SNMP::Info::Layer3
321       See "TABLE METHODS" in SNMP::Info::Layer3 for details.
322

Data Munging Callback Subroutines

324       $aruba->munge_aruba_fqln()
325           Remove nulls encoded as '\.0' from the Fully Qualified Location
326           Name ("wlanAPFQLN").
327
328
329
330perl v5.28.1                      2019-04-04      SNMP::Info::Layer3::Aruba(3)
Impressum