Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
SNMP::Info::Airespace(User Contributed Perl DocumentatSNMP::Info::Airespace(3)

NAME
       SNMP::Info::Airespace - SNMP Interface to data from
       AIRESPACE-WIRELESS-MIB and AIRESPACE-SWITCHING-MIB

AUTHOR
       Eric Miller

SYNOPSIS
	   my $airespace = new SNMP::Info(
				 AutoSpecify =>	1,
				 Debug	     =>	1,
				 DestHost    =>	'myswitch',
				 Community   =>	'public',
				 Version     =>	2
			       )

	   or die "Can't connect to DestHost.\n";

	   my $class = $airespace->class();
	   print " Using device	sub class : $class\n";

DESCRIPTION
       SNMP::Info::Airespace is	a subclass of SNMP::Info that provides an
       interface to AIRESPACE-WIRELESS-MIB and AIRESPACE-SWITCHING-MIB.	 These
       MIBs are	used in	Airespace wireless switches, as	well as, products from
       Cisco, Nortel, and Alcatel which	are based upon the Airespace platform.

       The Airespace platform utilizes intelligent wireless switches which
       control thin access points.  The	thin access points themselves are
       unable to be polled for end station information.

       This class emulates bridge functionality	for the	wireless switch. This
       enables end station MAC addresses collection and	correlation to the
       thin access point the end station is using for communication.

       Use or create a subclass	of SNMP::Info that inherits this one.  Do not
       use directly.

   Inherited Classes
       None.

   Required MIBs
       AIRESPACE-WIRELESS-MIB
       AIRESPACE-SWITCHING-MIB

GLOBALS
       These are methods that return scalar value from SNMP

       $airespace->airespace_type()
	   ("agentInventoryMachineType")

       $airespace->airespace_model()
	   ("agentInventoryMachineModel")

       $airespace->airespace_serial()
	   ("agentInventorySerialNumber")

       $airespace->airespace_maint_ver()
	   ("agentInventoryMaintenanceLevel")

       $airespace->airespace_mac()
	   ("agentInventoryBurnedInMacAddress")

       $airespace->airespace_os()
	   ("agentInventoryOperatingSystem")

       $airespace->airespace_vendor()
	   ("agentInventoryManufacturerName")

       $airespace->airespace_prod_name()
	   ("agentInventoryProductName")

       $airespace->os_ver()
	   ("agentInventoryProductVersion")

       $airespace->airespace_bssid_mode()
	   ("agentNetworkBroadcastSsidMode")

       $airespace->airespace_mc_mode()
	   ("agentNetworkMulticastMode")

       $airespace->airespace_lwapp_mode()
	   The LWAPP transport mode decides if the switch is operating in the
	   Layer2 or Layer3 mode.

	   ("agentSwitchLwappTransportMode")

       $airespace->airespace_ul_mode()
	   Transfer upload mode	configures the mode to use when	uploading from
	   the switch.	Normal usage tftp.

	   ("agentTransferUploadMode")

       $airespace->airespace_ul_ip()
	   Transfer upload tftp	server ip configures the IP address of the
	   server. It is valid only when the Transfer Mode is tftp.

	   ("agentTransferUploadServerIP")

       $airespace->airespace_ul_path()
	   Transfer upload tftp	path configures	the directory path where the
	   file	is to be uploaded to. The switch remembers the last file path
	   used.

	   ("agentTransferUploadPath")

       $airespace->airespace_ul_file()
	   ("agentTransferUploadFilename")

       $airespace->airespace_ul_type()
	   Transfer upload datatype configures the type	of file	to upload from
	   the switch.

	       The types for upload are:
	       config(2)
	       errorlog(3)
	       systemtrace(4)
	       traplog(5)
	       crashfile(6)

	   ("agentTransferUploadDataType")

       $airespace->airespace_ul_start()
	   ("agentTransferUploadStart")

       $airespace->airespace_ul_status()
	   ("agentTransferUploadStatus")

   Overrides
       $airespace->layers()
	   Returns 00000111.  Class emulates Layer 2 functionality for Thin
	   APs through proprietary MIBs.

       $airespace->serial()
	   ("agentInventorySerialNumber")

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

       $airespace->i_ssidlist()
	   Returns reference to	hash.  SSID's recognized by the	radio
	   interface.

       $airespace->i_ssidbcast()
	   Returns reference to	hash.  Indicates whether the SSID is
	   broadcast.

       $airespace->i_80211channel()
	   Returns reference to	hash.  Current operating frequency channel of
	   the radio interface.

       $airespace->dot11_cur_tx_pwr_mw()
	   Returns reference to	hash.  Current transmit	power, in milliwatts,
	   of the radio	interface.

       $airespace->i_ssidmac()
	   With	the same keys as i_ssidlist, returns the Basic service set
	   identification (BSSID), MAC address,	the AP is using	for the	SSID.

   Dot11 Ess Table  ("bsnDot11EssTable")
       Ess(WLAN) Configuration Table. Maximum of 17 WLANs can be created on
       Airespace Switch. Index of 17 is	reserved for WLAN for Third Party
       APs(non-Airespace APs).

       $airespace->airespace_ess_idx()
	   ("bsnDot11EssIndex")

       $airespace->airespace_ess_ssid()
	   SSID	assigned to ESS(WLAN)

	   ("bsnDot11EssSsid")

       $airespace->airespace_ess_macflt()
	   Select to filter clients by MAC address.  By	selecting this
	   Security, you need to create	MAC Filters in "bsnUsersTable" or have
	   MAC Filters configured on Radius Servers specified in
	   "bsnRadiusAuthenticationTable"

	   ("bsnDot11EssMacFiltering")

       $airespace->airespace_ess_status()
	   Administrative Status of ESS(WLAN).

	   ("bsnDot11EssAdminStatus")

       $airespace->airespace_ess_sec_auth()
	   Type	of 802.11 Authentication.

	   ("bsnDot11EssSecurityAuthType")

       $airespace->airespace_ess_radio_pol()
	   Radio Policy	for a WLAN. It can either be All where it will be
	   applicable to ALL types of protocols	or it can be set to apply to
	   combinations	of 802.11a, 802.11b, 802.11g.

	   ("bsnDot11EssRadioPolicy")

       $airespace->airespace_ess_qos()
	   Quality of Service for a WLAN.

	   ("bsnDot11EssQualityOfService")

       $airespace->airespace_ess_ifname()
	   Name	of the interface used by this WLAN.

	   ("bsnDot11EssInterfaceName")

       $airespace->airespace_ess_aclname()
	   Name	of ACL for the WLAN. This is applicable	only when Web
	   Authentication is enabled.

	   ("bsnDot11EssAclName")

       $airespace->airespace_ess_bcast()
	   This	attribute when enabled allows the switch to broadcast this
	   SSID.

	   ("bsnDot11EssBroadcastSsid")

   AP Table ("bsnAPTable")
       Table of	Airespace APs managed by this Airespace	Switch.

       $airespace->airespace_ap_mac()
	   The MAC address of the 802.3	interface of the AP.

	   ("bsnAPDot3MacAddress")

       $airespace->airespace_ap_name()
	   Name	assigned to this AP. If	an AP is not configured	its factory
	   default name	will be	ap:<last three byte of MAC Address>.  e.g.
	   ap:af:12:be

	   ("bsnAPName")

       $airespace->airespace_ap_ip()
	   Ip address of the AP. This will not be available when the switch is
	   operating in	the Layer2 mode. In this case, the attribute will
	   return 0 as value.

	   ("bsnApIpAddress")

       $airespace->airespace_ap_loc()
	   User	specified location of this AP.

	   ("bsnAPLocation")

       $airespace->airespace_ap_sw()
	   ("bsnAPSoftwareVersion")

       $airespace->airespace_ap_fw()
	   ("bsnAPBootVersion")

       $airespace->airespace_ap_model()
	   ("bsnAPModel")

       $airespace->airespace_ap_serial()
	   ("bsnAPSerialNumber")

       $airespace->airespace_ap_type()
	   ("bsnAPType")

       $airespace->airespace_ap_status()
	   ("bsnAPAdminStatus")

   AP Interface	Table ("bsnAPIfTable")
       Table of	802.11 interfaces in an	Airespace APs.

       $airespace->airespace_apif_slot()
	   The slot Id of this interface. Value	will be	0 for a	802.11a	(5Ghz)
	   interface and will be 1 for 802.11b/g (2.4Ghz) interface.

	   ("bsnAPIfSlotId")

       $airespace->airespace_apif_type()
	   ("bsnAPIfType")

       $airespace->airespace_apif_ch_num()
	   ("bsnAPIfPhyChannelNumber")

       $airespace->airespace_apif_power()
	   The transmit	power level N currently	being used to transmit data.

	   ("bsnAPIfPhyTxPowerLevel")

       $airespace->airespace_apif()
	   ("bsnAPIfOperStatus")

       $airespace->airespace_apif_oride()
	   This	flag when disabled implies that	all WLANs are available	from
	   this	radio.	However, if this is enabled, then only those WLANs
	   that	appear in the ("bsnApIfWlanOverrideTable") will	be available
	   from	this radio.

	   ("bsnAPIfWlanOverride")

       $airespace->airespace_apif_admin()
	   ("bsnAPIfAdminStatus")

       $airespace->airespace_apif_a_pwr()
	   List	of comma separated absolute power levels supported by the
	   radio.

	   ("bsnAPIfAbsolutePowerList")

   Mobile Station Table	("bsnMobileStationTable")
       $airespace->airespace_sta_mac()
	   Mac Address of the AP on which Mobile Station is associated.

	   ("bsnMobileStationAPMacAddr")

       $airespace->airespace_sta_slot()
	   Slot	Id of AP If on which mobile station is associated.

	   ("bsnMobileStationAPIfSlotId")

       $airespace->airespace_sta_ess_idx()
	   Ess Index of	the Wlan(SSID) that is being used by Mobile Station to
	   connect to the AP.

	   ("bsnMobileStationEssIndex")

       $airespace->airespace_sta_ssid()
	   The SSID Advertised by the Mobile Station.

	   ("bsnMobileStationSsid")

       $airespace->airespace_sta_delete()
	   Action to Deauthenticate the	Mobile Station.	Set the	State to
	   delete.

	   ("bsnMobileStationDeleteAction")

   Users Table ("bsnUsersTable")
       The (conceptual)	table listing Wlan Users.

       $airespace->airespace_user_name()
	   User	name.  For MAC filters,	this will be the MAC address (e.g.
	   000123456789).

	   ("bsnUserName")

       $airespace->airespace_user_pw()
	   User	Password.  For MAC filters, this will be "nopassword".

	   ("bsnUserPassword")

       $airespace->airespace_user_ess_idx()
	   User	WLAN ID. Value 0 implies that this applies to any WLAN ID.

	   ("bsnUserEssIndex")

       $airespace->airespace_user_access()
	   For MAC filters, this will be "readOnly".

	   ("bsnUserAccessMode")

       $airespace->airespace_user_type()
	   User	Access Mode. For MAC filters, this will	be "macFilter".

	   ("bsnUserType")

       $airespace->airespace_user_ifname()
	   ACL for MAC Filters.	 An interface name from
	   "agentInterfaceConfigTable"

	   ("bsnUserInterfaceName")

       $airespace->airespace_user_rstat()
	   ("bsnUserRowStatus")

   Black List Client Table ("bsnBlackListClientTable")
       The table listing Wlan Black Listed Clients

       $airespace->airespace_bl_mac()
	   ("bsnBlackListClientMacAddress")

       $airespace->airespace_bl_descr()
	   ("bsnBlackListClientDescription")

       $airespace->airespace_bl_rstat()
	   ("bsnBlackListClientRowStatus")

   AP Interface	WLAN Override Table ("bsnAPIfWlanOverrideTable")
       Each entry represents an	SSID added to the AP when the attribute
       "bsnAPIfWlanOverride" on	the radio is enabled.  This means only those
       WLANs on	the switch that	are added to this table	will be	available on
       such a radio.

       $airespace->airespace_oride_id()
	   Index of the	WLAN ("bsnDot11EssIndex") added	to the radio.

	   ("bsnAPIfWlanOverrideId")

       $airespace->airespace_oride_ssid()
	   SSID	assigned to the	override WLAN.

	   ("bsnAPIfWlanOverrideSsid")

   Interface Config Table ("agentInterfaceConfigTable")
       A table of the switch's Interface Config	entries. Typically, it will
       contain entries	 for Service Port Interface, DS	Port Interface and
       Virtual Gateway Interface apart from other entries.

       $airespace->airespace_if_name()
	   Interface Name. This	values is 'management' for DS port,
	   'service-port' for service port and 'virtual' for virtual gateway.
	   For other interfaces, the name can be anything. These interfaces
	   are already created by default.

	   ("agentInterfaceName")

       $airespace->airespace_if_vlan()
	   VLAN	Id configured for the Interface.

	   ("agentInterfaceVlanId")

       $airespace->airespace_if_type()
	   The interface's type. The static type is set	for the	interfaces
	   that	are created by default on the switch and these cannot be
	   deleted. Any	other interface	that is	created	is of type dynamic
	   which can be	deleted.

	   ("agentInterfaceType")

       $airespace->airespace_if_mac()
	   Interface MAC Address. This is only applicable in case of
	   management and service-port interfaces.

	   ("agentInterfaceMacAddress")

       $airespace->airespace_if_ip()
	   ("agentInterfaceIPAddress")

       $airespace->airespace_if_mask()
	   ("agentInterfaceIPNetmask")

       $airespace->airespace_if_acl()
	   Name	of the Access Control List applied to the interface. This
	   attribute is	applicable only	to the management interface and	other
	   dynamic interfaces.	If it is required to remove the	ACL name for
	   an interface, it should be set to an	empty string.

	   ("agentInterfaceAclName")

       $airespace->airespace_if_rstat()
	   ("agentInterfaceRowStatus")

   Port	Config Table ("agentPortConfigTable")
       $airespace->airespace_duplex_admin()
	   ("agentPortPhysicalMode")

       $airespace->airespace_duplex()
	   ("agentPortPhysicalStatus")

   Overrides
       $airespace->i_index()
	   Returns reference to	map of IIDs to Interface index.

	   Extends "ifIndex" to	support	thin APs and WLAN virtual interfaces
	   as device interfaces.

       $airespace->interfaces()
	   Returns reference to	map of IIDs to ports.  Thin APs	are
	   implemented as device interfaces.  The thin AP MAC address
	   airespace_ap_mac() and Slot ID airespace_apif_slot()	are used as
	   the port identifier.	 Virtual interfaces use	airespace_if_name() as
	   the port identifier.

       $airespace->i_name()
	   Returns reference to	map of IIDs to interface names.	 Returns
	   "ifName" for	Ethernet interfaces, airespace_ap_name() for thin AP
	   interfaces, and airespace_if_name() for virtual interfaces.

       $airespace->i_description()
	   Returns reference to	map of IIDs to interface descriptions.
	   Returns "ifDescr" for Ethernet interfaces, airespace_ap_loc() for
	   thin	AP interfaces, and airespace_if_name() for virtual interfaces.

       $airespace->i_type()
	   Returns reference to	map of IIDs to interface types.	 Returns
	   "ifType" for	Ethernet interfaces, airespace_apif_type() for thin AP
	   interfaces, and airespace_if_type() for virtual interfaces.

       $airespace->i_up()
	   Returns reference to	map of IIDs to link status of the interface.
	   Returns "ifOperStatus" for Ethernet interfaces and airespace_apif()
	   for thin AP interfaces.

       $airespace->i_up_admin()
	   Returns reference to	map of IIDs to administrative status of	the
	   interface.  Returns "ifAdminStatus" for Ethernet interfaces and
	   airespace_apif_admin() for thin AP interfaces.

       $airespace->i_mac()
	   Returns reference to	map of IIDs to MAC address of the interface.
	   Returns "ifPhysAddress" for Ethernet	interfaces and
	   airespace_if_mac() for virtual interfaces.

       $airespace->i_vlan()
	   Returns reference to	map of IIDs to VLAN ID of the interface.
	   Returns airespace_if_vlan() for virtual interfaces.

       $airespace->i_duplex()
	   Returns reference to	map of IIDs to current link duplex.  Ethernet
	   interfaces only.

       $airespace->i_duplex_admin()
	   Returns reference to	hash of	IIDs to	admin duplex setting.
	   Ethernet interfaces only.

       $airespace->ip_index()
	   Extends table by mapping airespace_if_ip() to the interface IID.

       $airespace->ip_netmask()
	   Extends IP table by mapping airespace_if_mask() to
	   airespace_if_ip()

       $airespace->bp_index()
	   Simulates bridge MIB	by returning reference to a hash mapping
	   i_index() to	the interface iid.

       $airespace->fw_port()
	   Returns reference to	a hash,	value being airespace_sta_mac()	and
	   airespace_sta_slot()	combined to match the interface	iid.

       $airespace->fw_mac()
	   ("bsnMobileStationMacAddress")

   Pseudo ENTITY-MIB information
       These methods emulate ENTITY-MIB	Physical Table methods using
       AIRESPACE-SWITCHING-MIB and AIRESPACE-WIRELESS-MIB.  Thin APs are
       included	as subcomponents of the	wireless controller.

       $airespace->e_index()
	   Returns reference to	hash.  Key: IID	and Value: Integer. The	index
	   for APs is created with an integer representation of	the last three
	   octets of the AP MAC	address.

       $airespace->e_class()
	   Returns reference to	hash.  Key: IID, Value:	General	hardware type.
	   Return ap for wireless access points.

       $airespace->e_descr()
	   Returns reference to	hash.  Key: IID, Value:	Human friendly name.

       $airespace->e_model()
	   Returns reference to	hash.  Key: IID, Value:	Model name.

       $airespace->e_name()
	   More	computer friendly name of entity.  Name	is either 'WLAN
	   Controller' or 'AP'.

       $airespace->e_vendor()
	   Returns reference to	hash.  Key: IID, Value:	cisco.

       $airespace->e_serial()
	   Returns reference to	hash.  Key: IID, Value:	Serial number.

       $airespace->e_pos()
	   Returns reference to	hash.  Key: IID, Value:	The relative position
	   among all entities sharing the same parent.

       $airespace->e_type()
	   Returns reference to	hash.  Key: IID, Value:	Type of	component.

       $airespace->e_fwver()
	   Returns reference to	hash.  Key: IID, Value:	Firmware revision.

       $airespace->e_swver()
	   Returns reference to	hash.  Key: IID, Value:	Software revision.

       $airespace->e_parent()
	   Returns reference to	hash.  Key: IID, Value:	The value of e_index()
	   for the entity which	'contains' this	entity.

   Arp Cache Table Augmentation
       The controller has knowledge of MAC->IP mappings	for wireless clients.
       Augmenting the arp cache	data with these	MAC->IP	mappings enables
       visibility for stations that only communicate locally.

       $airespace->at_paddr()
	   Adds	MAC addresses extracted	from the index of
	   "bsnMobileStationIpAddress".

       $airespace->at_netaddr()
	   Adds	IP addresses from "bsnMobileStationIpAddress".

Data Munging Callback Subroutines
       munge_64bits()
	   Truncate packet values to 32	bits.

perl v5.32.0			  2020-08-09	      SNMP::Info::Airespace(3)

NAME | AUTHOR | SYNOPSIS | DESCRIPTION | GLOBALS | TABLE METHODS | Data Munging Callback Subroutines

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=SNMP::Info::Airespace&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help