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

FreeBSD Manual Pages

  
 
  

home | help
SNMP::Info::Layer2::NWUser0Contributed Perl DocSNMP::Info::Layer2::NWSS2300(3)

NAME
       SNMP::Info::Layer2::NWSS2300 - SNMP Interface to	Avaya (Trapeze)
       Wireless	Controllers

AUTHOR
       Eric Miller

SYNOPSIS
	   #Let	SNMP::Info determine the correct subclass for you.

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

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

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

DESCRIPTION
       Provides	abstraction to the configuration information obtainable	from
       Avaya (Trapeze) Wireless	Controllers through SNMP.

       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.

       For speed or debugging purposes you can call the	subclass directly, but
       not after determining a more specific class using the method above.

       my $nwss2300 = new SNMP::Info::Layer2::NWSS2300(...);

   Inherited Classes
       SNMP::Info
       SNMP::Info::Bridge

   Required MIBs
       NTWS-REGISTRATION-DEVICES-MIB
       NTWS-AP-STATUS-MIB
       NTWS-CLIENT-SESSION-MIB
       NTWS-SYSTEM-MIB
       NTWS-BASIC-MIB

   Inherited Classes' MIBs
       See "Required MIBs" in SNMP::Info for its own MIB requirements.

       See "Required MIBs" in SNMP::Info::Bridge for its own MIB requirements.

GLOBALS
       These are methods that return scalar value from SNMP

       $nwss2300->vendor()
	   Returns 'avaya'

       $nwss2300->os()
	   Returns 'trapeze'

       $nwss2300->os_ver()
	   ("ntwsVersionString")

       $nwss2300->model()
	   Tries to reference $nwss2300->id() to NTWS-REGISTRATION-DEVICES-MIB

	   Removes 'ntwsSwitch'	for readability.

       $nwss2300->serial()
	   ("ntwsSerialNumber")

       $nwss2300->mac()
	   ("dot1dBaseBridgeAddress")

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

   Global Methods imported from	SNMP::Info
       See documentation in "GLOBALS" in SNMP::Info for	details.

   Globals imported from SNMP::Info::Bridge
       See documentation in "GLOBALS" in SNMP::Info::Bridge for	details.

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

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

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

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

       cd11_mac()
	   Client MAC address.

   AP Status Table  ("ntwsApStatApStatusTable")
       A table describing all the APs currently	present	and managed by the
       controller.

       $nwss2300->nwss2300_ap_mac()
	   ("ntwsApStatApStatusBaseMac")

       $nwss2300->nwss2300_ap_name()
	   ("ntwsApStatApStatusApName")

       $nws2300->nwss2300_ap_ip()
	   ("ntwsApStatApStatusIpAddress")

       $nws2300->nwss2300_ap_sw()
	   ("ntwsApStatApStatusSoftwareVer")

       $nws2300->nwss2300_ap_fw()
	   ("ntwsApStatApStatusBootVer")

       $nws2300->nwss2300_ap_model()
	   ("ntwsApStatApStatusModel")

       $nws2300->nwss2300_ap_type()
	   ("ntwsApStatApStatusModel")

       $nws2300->nwss2300_ap_status()
	   ("ntwsApStatApStatusApState")

       $nws2300->nwss2300_ap_vendor()
	   ("ntwsApStatApStatusManufacturerId")

       $nws2300->nwss2300_ap_num()
	   ("ntwsApStatApStatusApNum")

       $nws2300->nwss2300_ap_dapnum()
	   ("ntwsApStatApStatusPortOrDapNum")

   AP Radio Status Table  ("ntwsApStatRadioStatusTable")
       A table describing all radios on	all the	APs currently present and
       managed by the controller.

       $nws2300->nwss2300_apif_mac()
	   ("ntwsApStatRadioStatusBaseMac")

       $nws2300->nwss2300_apif_type()
	   ("ntwsApStatRadioStatusRadioPhyType")

       $nws2300->nwss2300_apif_ch_num()
	   ("ntwsApStatRadioStatusCurrentChannelNum")

       $nws2300->nwss2300_apif_power()
	   ("ntwsApStatRadioStatusCurrentPowerLevel")

       $nws2300->nwss2300_apif_admin()
	   ("ntwsApStatRadioStatusRadioMode")

   AP Radio Status Service Table ("ntwsApStatRadioServiceTable")
       A table describing radio	services associated with APs currently present
       and managed by the controller.

       $nws2300->nwss2300_apif_bssid()
	   ("ntwsApStatRadioServBssid")

       $nws2300->nwss2300_apif_prof()
	   ("ntwsApStatRadioServServiceProfileName")

   AP Service Profile Config Table ("ntwsApConfServiceProfileTable")
       $nws2300->nwss2300_ess_bcast()
	   ("ntwsApConfServProfBeaconEnabled")

   AP Radio Config Table ("ntwsApConfRadioConfigTable")
       $nws2300->nwss2300_apcr_txpwr()
	   ("ntwsApConfRadioConfigTxPower")

       $nws2300->nwss2300_apcr_ch()
	   ("ntwsApConfRadioConfigChannel")

       $nws2300->nwss2300_apcr_mode()
	   ("ntwsApConfRadioConfigRadioMode")

   AP Config Table ("ntwsApConfApConfigTable")
       $nws2300->nwss2300_apc_descr()
	   ("ntwsApConfApConfigDescription")

       $nws2300->nwss2300_apc_loc()
	   ("ntwsApConfApConfigLocation")

       $nws2300->nwss2300_apc_name()
	   ("ntwsApConfApConfigApName")

       $nws2300->nwss2300_apc_model()
	   ("ntwsApConfApConfigApModelName")

       $nws2300->nwss2300_apc_serial()
	   ("ntwsApConfApConfigApSerialNum")

   Client Session Table	("ntwsClSessClientSessionTable")
       $nws2300->nwss2300_sta_slot()
	   ("ntwsClSessClientSessRadioNum")

       $nws2300->nwss2300_sta_serial()
	   ("ntwsClSessClientSessApSerialNum")

       $nws2300->nwss2300_sta_ssid()
	   ("ntwsClSessClientSessSsid")

       $nws2300->nwss2300_sta_ip()
	   ("ntwsClSessClientSessIpAddress")

   Client Session Statistics Table ("ntwsClSessClientSessionStatisticsTable")
       These emulate the CISCO-DOT11-MIB

       $nws2300->cd11_sigstrength()
	   ("ntwsClSessClientSessStatsLastRssi")

       $nws2300->cd11_sigqual()
	   ("ntwsClSessClientSessStatsLastSNR")

       $nws2300->cd11_txrate()
	   ("ntwsClSessClientSessStatsLastRate")

       $nws2300->cd11_rxbyte()
	   ("ntwsClSessClientSessStatsUniOctetIn")

       $nws2300->cd11_txbyte()
	   ("ntwsClSessClientSessStatsUniOctetOut")

       $nws2300->cd11_rxpkt()
	   ("ntwsClSessClientSessStatsUniPktIn")

       $nws2300->cd11_txpkt()
	   ("ntwsClSessClientSessStatsUniPktOut")

   Table Methods imported from SNMP::Info
       See documentation in "TABLE METHODS" in SNMP::Info for details.

   Table Methods imported from SNMP::Info::Bridge
       See documentation in "TABLE METHODS" in SNMP::Info::Bridge for details.

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

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

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

       $nwss2300->i_name()
	   Returns reference to	map of IIDs to interface names.	 Returns
	   "ifName" for	Ethernet interfaces and	nwss2300_ap_name() for thin AP
	   interfaces.

       $nwss2300->i_description()
	   Returns reference to	map of IIDs to interface types.	 Returns
	   "ifDescr" for Ethernet interfaces, nwss2300_ap_name() for thin AP
	   interfaces.

       $nwss2300->i_type()
	   Returns reference to	map of IIDs to interface descriptions.
	   Returns "ifType" for	Ethernet interfaces and
	   'capwapWtpVirtualRadio' for thin AP interfaces.

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

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

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

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

       $nwss2300->fw_port()
	   Returns reference to	a hash,	value being mac	and
	   nwss2300_sta_slot() combined	to match the interface iid.

       $nwss2300->fw_mac()
	   Extracts the	MAC from the nwss2300_sta_serial() index.

   Pseudo ARP Cache Entries
       The controller snoops on	the MAC->IP mappings.  Using this as ARP cache
       data allows us to get MAC->IP mappings even for stations	that only
       communicate locally.  The data is gathered from nwss2300_sta_ip().

       $nwss2300->at_paddr()
	   Returns reference to	hash of	Pseudo Arp Cache Entries to MAC
	   address

       $nwss2300->at_netaddr()
	   Returns reference to	hash of	Pseudo Arp Cache Entries to IP Address

   Pseudo ENTITY-MIB information
       These methods emulate ENTITY-MIB	Physical Table methods using NTWS-AP-
       STATUS-MIB.  Thin APs are included as subcomponents of the wireless
       controller.

       $nwss2300->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.

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

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

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

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

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

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

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

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

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

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

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

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

NAME | AUTHOR | SYNOPSIS | DESCRIPTION | GLOBALS | TABLE METHODS

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

home | help