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