1SNMP::Info::Airespace(3U)ser Contributed Perl DocumentatiSoNnMP::Info::Airespace(3)
2
6 SNMP::Info::Airespace - SNMP Interface to data from
7 AIRESPACE-WIRELESS-MIB and AIRESPACE-SWITCHING-MIB
8
10 Eric Miller
11
13 my $airespace = new SNMP::Info(
14 AutoSpecify => 1,
15 Debug => 1,
16 DestHost => 'myswitch',
17 Community => 'public',
18 Version => 2
19 )
20 or die "Can't connect to DestHost.\n";
22 my $class = $airespace->class();
24 print " Using device sub class : $class\n";
25
27 SNMP::Info::Airespace is a subclass of SNMP::Info that provides an
28 interface to AIRESPACE-WIRELESS-MIB and AIRESPACE-SWITCHING-MIB. These
29 MIBs are used in Airespace wireless switches, as well as, products from
30 Cisco, Nortel, and Alcatel which are based upon the Airespace platform.
31 The Airespace platform utilizes intelligent wireless switches which
33 control thin access points. The thin access points themselves are
34 unable to be polled for end station information.
35 This class emulates bridge functionality for the wireless switch. This
37 enables end station MAC addresses collection and correlation to the
38 thin access point the end station is using for communication.
39 Use or create a subclass of SNMP::Info that inherits this one. Do not
41 use directly.
42 Inherited Classes
44 None.
45 Required MIBs
47 AIRESPACE-WIRELESS-MIB
48 AIRESPACE-SWITCHING-MIB
49
51 These are methods that return scalar value from SNMP
52 $airespace->airespace_type()
54 ("agentInventoryMachineType")
55 $airespace->airespace_model()
57 ("agentInventoryMachineModel")
58 $airespace->airespace_serial()
60 ("agentInventorySerialNumber")
61 $airespace->airespace_maint_ver()
63 ("agentInventoryMaintenanceLevel")
64 $airespace->airespace_mac()
66 ("agentInventoryBurnedInMacAddress")
67 $airespace->airespace_os()
69 ("agentInventoryOperatingSystem")
70 $airespace->airespace_vendor()
72 ("agentInventoryManufacturerName")
73 $airespace->airespace_prod_name()
75 ("agentInventoryProductName")
76 $airespace->os_ver()
78 ("agentInventoryProductVersion")
79 $airespace->airespace_bssid_mode()
81 ("agentNetworkBroadcastSsidMode")
82 $airespace->airespace_mc_mode()
84 ("agentNetworkMulticastMode")
85 $airespace->airespace_lwapp_mode()
87 The LWAPP transport mode decides if the switch is operating in the
88 Layer2 or Layer3 mode.
89 ("agentSwitchLwappTransportMode")
91 $airespace->airespace_ul_mode()
93 Transfer upload mode configures the mode to use when uploading from
94 the switch. Normal usage tftp.
95 ("agentTransferUploadMode")
97 $airespace->airespace_ul_ip()
99 Transfer upload tftp server ip configures the IP address of the
100 server. It is valid only when the Transfer Mode is tftp.
101 ("agentTransferUploadServerIP")
103 $airespace->airespace_ul_path()
105 Transfer upload tftp path configures the directory path where the
106 file is to be uploaded to. The switch remembers the last file path
107 used.
108 ("agentTransferUploadPath")
110 $airespace->airespace_ul_file()
112 ("agentTransferUploadFilename")
113 $airespace->airespace_ul_type()
115 Transfer upload datatype configures the type of file to upload from
116 the switch.
117 The types for upload are:
119 config(2)
120 errorlog(3)
121 systemtrace(4)
122 traplog(5)
123 crashfile(6)
124 ("agentTransferUploadDataType")
126 $airespace->airespace_ul_start()
128 ("agentTransferUploadStart")
129 $airespace->airespace_ul_status()
131 ("agentTransferUploadStatus")
132 Overrides
134 $airespace->layers()
135 Returns 00000111. Class emulates Layer 2 functionality for Thin
136 APs through proprietary MIBs.
137 $airespace->serial()
139 ("agentInventorySerialNumber")
140
142 These are methods that return tables of information in the form of a
143 reference to a hash.
144 $airespace->i_ssidlist()
146 Returns reference to hash. SSID's recognized by the radio
147 interface.
148 $airespace->i_ssidbcast()
150 Returns reference to hash. Indicates whether the SSID is
151 broadcast.
152 $airespace->i_80211channel()
154 Returns reference to hash. Current operating frequency channel of
155 the radio interface.
156 $airespace->dot11_cur_tx_pwr_mw()
158 Returns reference to hash. Current transmit power, in milliwatts,
159 of the radio interface.
160 $airespace->i_ssidmac()
162 With the same keys as i_ssidlist, returns the Basic service set
163 identification (BSSID), MAC address, the AP is using for the SSID.
164 Dot11 Ess Table ("bsnDot11EssTable")
166 Ess(WLAN) Configuration Table. Maximum of 17 WLANs can be created on
167 Airespace Switch. Index of 17 is reserved for WLAN for Third Party
168 APs(non-Airespace APs).
169 $airespace->airespace_ess_idx()
171 ("bsnDot11EssIndex")
172 $airespace->airespace_ess_ssid()
174 SSID assigned to ESS(WLAN)
175 ("bsnDot11EssSsid")
177 $airespace->airespace_ess_macflt()
179 Select to filter clients by MAC address. By selecting this
180 Security, you need to create MAC Filters in "bsnUsersTable" or have
181 MAC Filters configured on Radius Servers specified in
182 "bsnRadiusAuthenticationTable"
183 ("bsnDot11EssMacFiltering")
185 $airespace->airespace_ess_status()
187 Administrative Status of ESS(WLAN).
188 ("bsnDot11EssAdminStatus")
190 $airespace->airespace_ess_sec_auth()
192 Type of 802.11 Authentication.
193 ("bsnDot11EssSecurityAuthType")
195 $airespace->airespace_ess_radio_pol()
197 Radio Policy for a WLAN. It can either be All where it will be
198 applicable to ALL types of protocols or it can be set to apply to
199 combinations of 802.11a, 802.11b, 802.11g.
200 ("bsnDot11EssRadioPolicy")
202 $airespace->airespace_ess_qos()
204 Quality of Service for a WLAN.
205 ("bsnDot11EssQualityOfService")
207 $airespace->airespace_ess_ifname()
209 Name of the interface used by this WLAN.
210 ("bsnDot11EssInterfaceName")
212 $airespace->airespace_ess_aclname()
214 Name of ACL for the WLAN. This is applicable only when Web
215 Authentication is enabled.
216 ("bsnDot11EssAclName")
218 $airespace->airespace_ess_bcast()
220 This attribute when enabled allows the switch to broadcast this
221 SSID.
222 ("bsnDot11EssBroadcastSsid")
224 AP Table ("bsnAPTable")
226 Table of Airespace APs managed by this Airespace Switch.
227 $airespace->airespace_ap_mac()
229 The MAC address of the 802.3 interface of the AP.
230 ("bsnAPDot3MacAddress")
232 $airespace->airespace_ap_name()
234 Name assigned to this AP. If an AP is not configured its factory
235 default name will be ap:<last three byte of MAC Address>. e.g.
236 ap:af:12:be
237 ("bsnAPName")
239 $airespace->airespace_ap_ip()
241 Ip address of the AP. This will not be available when the switch is
242 operating in the Layer2 mode. In this case, the attribute will
243 return 0 as value.
244 ("bsnApIpAddress")
246 $airespace->airespace_ap_loc()
248 User specified location of this AP.
249 ("bsnAPLocation")
251 $airespace->airespace_ap_sw()
253 ("bsnAPSoftwareVersion")
254 $airespace->airespace_ap_fw()
256 ("bsnAPBootVersion")
257 $airespace->airespace_ap_model()
259 ("bsnAPModel")
260 $airespace->airespace_ap_serial()
262 ("bsnAPSerialNumber")
263 $airespace->airespace_ap_type()
265 ("bsnAPType")
266 $airespace->airespace_ap_status()
268 ("bsnAPAdminStatus")
269 AP Interface Table ("bsnAPIfTable")
271 Table of 802.11 interfaces in an Airespace APs.
272 $airespace->airespace_apif_slot()
274 The slot Id of this interface. Value will be 0 for a 802.11a (5Ghz)
275 interface and will be 1 for 802.11b/g (2.4Ghz) interface.
276 ("bsnAPIfSlotId")
278 $airespace->airespace_apif_type()
280 ("bsnAPIfType")
281 $airespace->airespace_apif_ch_num()
283 ("bsnAPIfPhyChannelNumber")
284 $airespace->airespace_apif_power()
286 The transmit power level N currently being used to transmit data.
287 ("bsnAPIfPhyTxPowerLevel")
289 $airespace->airespace_apif()
291 ("bsnAPIfOperStatus")
292 $airespace->airespace_apif_oride()
294 This flag when disabled implies that all WLANs are available from
295 this radio. However, if this is enabled, then only those WLANs
296 that appear in the ("bsnApIfWlanOverrideTable") will be available
297 from this radio.
298 ("bsnAPIfWlanOverride")
300 $airespace->airespace_apif_admin()
302 ("bsnAPIfAdminStatus")
303 $airespace->airespace_apif_a_pwr()
305 List of comma separated absolute power levels supported by the
306 radio.
307 ("bsnAPIfAbsolutePowerList")
309 Mobile Station Table ("bsnMobileStationTable")
311 $airespace->airespace_sta_mac()
312 Mac Address of the AP on which Mobile Station is associated.
313 ("bsnMobileStationAPMacAddr")
315 $airespace->airespace_sta_slot()
317 Slot Id of AP If on which mobile station is associated.
318 ("bsnMobileStationAPIfSlotId")
320 $airespace->airespace_sta_ess_idx()
322 Ess Index of the Wlan(SSID) that is being used by Mobile Station to
323 connect to the AP.
324 ("bsnMobileStationEssIndex")
326 $airespace->airespace_sta_ssid()
328 The SSID Advertised by the Mobile Station.
329 ("bsnMobileStationSsid")
331 $airespace->airespace_sta_delete()
333 Action to Deauthenticate the Mobile Station. Set the State to
334 delete.
335 ("bsnMobileStationDeleteAction")
337 Users Table ("bsnUsersTable")
339 The (conceptual) table listing Wlan Users.
340 $airespace->airespace_user_name()
342 User name. For MAC filters, this will be the MAC address (e.g.
343 000123456789).
344 ("bsnUserName")
346 $airespace->airespace_user_pw()
348 User Password. For MAC filters, this will be "nopassword".
349 ("bsnUserPassword")
351 $airespace->airespace_user_ess_idx()
353 User WLAN ID. Value 0 implies that this applies to any WLAN ID.
354 ("bsnUserEssIndex")
356 $airespace->airespace_user_access()
358 For MAC filters, this will be "readOnly".
359 ("bsnUserAccessMode")
361 $airespace->airespace_user_type()
363 User Access Mode. For MAC filters, this will be "macFilter".
364 ("bsnUserType")
366 $airespace->airespace_user_ifname()
368 ACL for MAC Filters. An interface name from
369 "agentInterfaceConfigTable"
370 ("bsnUserInterfaceName")
372 $airespace->airespace_user_rstat()
374 ("bsnUserRowStatus")
375 Black List Client Table ("bsnBlackListClientTable")
377 The table listing Wlan Black Listed Clients
378 $airespace->airespace_bl_mac()
380 ("bsnBlackListClientMacAddress")
381 $airespace->airespace_bl_descr()
383 ("bsnBlackListClientDescription")
384 $airespace->airespace_bl_rstat()
386 ("bsnBlackListClientRowStatus")
387 AP Interface WLAN Override Table ("bsnAPIfWlanOverrideTable")
389 Each entry represents an SSID added to the AP when the attribute
390 "bsnAPIfWlanOverride" on the radio is enabled. This means only those
391 WLANs on the switch that are added to this table will be available on
392 such a radio.
393 $airespace->airespace_oride_id()
395 Index of the WLAN ("bsnDot11EssIndex") added to the radio.
396 ("bsnAPIfWlanOverrideId")
398 $airespace->airespace_oride_ssid()
400 SSID assigned to the override WLAN.
401 ("bsnAPIfWlanOverrideSsid")
403 Interface Config Table ("agentInterfaceConfigTable")
405 A table of the switch's Interface Config entries. Typically, it will
406 contain entries for Service Port Interface, DS Port Interface and
407 Virtual Gateway Interface apart from other entries.
408 $airespace->airespace_if_name()
410 Interface Name. This values is 'management' for DS port,
411 'service-port' for service port and 'virtual' for virtual gateway.
412 For other interfaces, the name can be anything. These interfaces
413 are already created by default.
414 ("agentInterfaceName")
416 $airespace->airespace_if_vlan()
418 VLAN Id configured for the Interface.
419 ("agentInterfaceVlanId")
421 $airespace->airespace_if_type()
423 The interface's type. The static type is set for the interfaces
424 that are created by default on the switch and these cannot be
425 deleted. Any other interface that is created is of type dynamic
426 which can be deleted.
427 ("agentInterfaceType")
429 $airespace->airespace_if_mac()
431 Interface MAC Address. This is only applicable in case of
432 management and service-port interfaces.
433 ("agentInterfaceMacAddress")
435 $airespace->airespace_if_ip()
437 ("agentInterfaceIPAddress")
438 $airespace->airespace_if_mask()
440 ("agentInterfaceIPNetmask")
441 $airespace->airespace_if_acl()
443 Name of the Access Control List applied to the interface. This
444 attribute is applicable only to the management interface and other
445 dynamic interfaces. If it is required to remove the ACL name for
446 an interface, it should be set to an empty string.
447 ("agentInterfaceAclName")
449 $airespace->airespace_if_rstat()
451 ("agentInterfaceRowStatus")
452 Port Config Table ("agentPortConfigTable")
454 $airespace->airespace_duplex_admin()
455 ("agentPortPhysicalMode")
456 $airespace->airespace_duplex()
458 ("agentPortPhysicalStatus")
459 Overrides
461 $airespace->i_index()
462 Returns reference to map of IIDs to Interface index.
463 Extends "ifIndex" to support thin APs and WLAN virtual interfaces
465 as device interfaces.
466 $airespace->interfaces()
468 Returns reference to map of IIDs to ports. Thin APs are
469 implemented as device interfaces. The thin AP MAC address
470 airespace_ap_mac() and Slot ID airespace_apif_slot() are used as
471 the port identifier. Virtual interfaces use airespace_if_name() as
472 the port identifier.
473 $airespace->i_name()
475 Returns reference to map of IIDs to interface names. Returns
476 "ifName" for Ethernet interfaces, airespace_ap_name() for thin AP
477 interfaces, and airespace_if_name() for virtual interfaces.
478 $airespace->i_description()
480 Returns reference to map of IIDs to interface descriptions.
481 Returns "ifDescr" for Ethernet interfaces, airespace_ap_loc() for
482 thin AP interfaces, and airespace_if_name() for virtual interfaces.
483 $airespace->i_type()
485 Returns reference to map of IIDs to interface types. Returns
486 "ifType" for Ethernet interfaces, airespace_apif_type() for thin AP
487 interfaces, and airespace_if_type() for virtual interfaces.
488 $airespace->i_up()
490 Returns reference to map of IIDs to link status of the interface.
491 Returns "ifOperStatus" for Ethernet interfaces and airespace_apif()
492 for thin AP interfaces.
493 $airespace->i_up_admin()
495 Returns reference to map of IIDs to administrative status of the
496 interface. Returns "ifAdminStatus" for Ethernet interfaces and
497 airespace_apif_admin() for thin AP interfaces.
498 $airespace->i_mac()
500 Returns reference to map of IIDs to MAC address of the interface.
501 Returns "ifPhysAddress" for Ethernet interfaces and
502 airespace_if_mac() for virtual interfaces.
503 $airespace->i_vlan()
505 Returns reference to map of IIDs to VLAN ID of the interface.
506 Returns airespace_if_vlan() for virtual interfaces.
507 $airespace->i_duplex()
509 Returns reference to map of IIDs to current link duplex. Ethernet
510 interfaces only.
511 $airespace->i_duplex_admin()
513 Returns reference to hash of IIDs to admin duplex setting.
514 Ethernet interfaces only.
515 $airespace->ip_index()
517 Extends table by mapping airespace_if_ip() to the interface IID.
518 $airespace->ip_netmask()
520 Extends IP table by mapping airespace_if_mask() to
521 airespace_if_ip()
522 $airespace->bp_index()
524 Simulates bridge MIB by returning reference to a hash mapping
525 i_index() to the interface iid.
526 $airespace->fw_port()
528 Returns reference to a hash, value being airespace_sta_mac() and
529 airespace_sta_slot() combined to match the interface iid.
530 $airespace->fw_mac()
532 ("bsnMobileStationMacAddress")
533 Pseudo ENTITY-MIB information
535 These methods emulate ENTITY-MIB Physical Table methods using
536 AIRESPACE-SWITCHING-MIB and AIRESPACE-WIRELESS-MIB. Thin APs are
537 included as subcomponents of the wireless controller.
538 $airespace->e_index()
540 Returns reference to hash. Key: IID and Value: Integer. The index
541 for APs is created with an integer representation of the last three
542 octets of the AP MAC address.
543 $airespace->e_class()
545 Returns reference to hash. Key: IID, Value: General hardware type.
546 Return ap for wireless access points.
547 $airespace->e_descr()
549 Returns reference to hash. Key: IID, Value: Human friendly name.
550 $airespace->e_model()
552 Returns reference to hash. Key: IID, Value: Model name.
553 $airespace->e_name()
555 More computer friendly name of entity. Name is either 'WLAN
556 Controller' or 'AP'.
557 $airespace->e_vendor()
559 Returns reference to hash. Key: IID, Value: cisco.
560 $airespace->e_serial()
562 Returns reference to hash. Key: IID, Value: Serial number.
563 $airespace->e_pos()
565 Returns reference to hash. Key: IID, Value: The relative position
566 among all entities sharing the same parent.
567 $airespace->e_type()
569 Returns reference to hash. Key: IID, Value: Type of component.
570 $airespace->e_fwver()
572 Returns reference to hash. Key: IID, Value: Firmware revision.
573 $airespace->e_swver()
575 Returns reference to hash. Key: IID, Value: Software revision.
576 $airespace->e_parent()
578 Returns reference to hash. Key: IID, Value: The value of e_index()
579 for the entity which 'contains' this entity.
580 Arp Cache Table Augmentation
582 The controller has knowledge of MAC->IP mappings for wireless clients.
583 Augmenting the arp cache data with these MAC->IP mappings enables
584 visibility for stations that only communicate locally.
585 $airespace->at_paddr()
587 Adds MAC addresses extracted from the index of
588 "bsnMobileStationIpAddress".
589 $airespace->at_netaddr()
591 Adds IP addresses from "bsnMobileStationIpAddress".
592
594 munge_64bits()
595 Truncate packet values to 32 bits.
596perl v5.30.0 2019-10-30 SNMP::Info::Airespace(3)