--- name: "SNMP::Info::NortelStack" section: "3pm" platform: "linux" package: "libsnmp-info-perl" version: "3.972002-1" release: "Debian 13 (Trixie)" platforms: ["linux"] url: "https://new.carta.tech/SNMP::Info::NortelStack" --- # SNMP::Info::NortelStack(3pm) SNMP Interface to the Avaya/Nortel S5-AGENT-MIB and S5-CHASSIS-MIB ## NAME SNMP::Info::NortelStack - SNMP Interface to the Avaya/Nortel S5-AGENT-MIB and S5-CHASSIS-MIB ## AUTHOR Eric Miller ## SYNOPSIS ``` # Let SNMP::Info determine the correct subclass for you. my $stack = new SNMP::Info( AutoSpecify => 1, Debug => 1, # These arguments are passed directly on to SNMP::Session DestHost => 'myswitch', Community => 'public', Version => 2 ) or die "Can't connect to DestHost.\n"; my $class = $stack->class(); print "SNMP::Info determined this device to fall under subclass : $class\n"; ``` ## DESCRIPTION SNMP::Info::NortelStack is a subclass of SNMP::Info that provides an interface to *S5-AGENT-MIB* and *S5-CHASSIS-MIB*. These MIBs are used across the Avaya/Nortel Stackable Ethernet Switches (BayStack), as well as, older Nortel devices such as the Centillion family of ATM switches. Use or create in a subclass of SNMP::Info. Do not use directly. ### Inherited Classes None. ### Required MIBs - *S5-AGENT-MIB* - *S5-CHASSIS-MIB* - *S5-ROOT-MIB* and *S5-TCS-MIB* are required by the other MIBs. ## GLOBALS These are methods that return scalar values from SNMP - $stack-\>**os\_ver()** Returns the software version extracted from (`"s5AgInfoVer"`) - $stack-\>**os\_bin()** Returns the firmware version extracted from (`"s5AgInfoVer"`) - $stack-\>**serial()** Returns serial number of the chassis (`"s5ChasSerNum"`) - $stack-\>**ns\_ag\_ver()** Returns the version of the agent in the form 'major.minor.maintenance\[letters\]'. (`"s5AgInfoVer"`) - $stack-\>**ns\_op\_mode()** Returns the stacking mode. (`"s5AgSysCurrentOperationalMode"`) - $stack-\>**tftp\_action()** This object is used to download or upload a config file or an image file. (`"s5AgInfoFileAction"`) - $stack-\>**tftp\_result()** Returns the status of the latest action as shown by `$stack`-\>**tftp\_action()**. (`"s5AgInfoFileStatus"`) - $stack-\>**ns\_auto\_pvid()** Returns the value indicating whether adding a port as a member of a VLAN automatically results in its PVID being set to be the same as that VLAN ID. (`"s5AgSysAutoPvid"`) - $stack-\>**tftp\_file()** Name of the binary configuration file that will be downloaded/uploaded when the `$stack`-\>**tftp\_action()** object is set. (`"s5AgSysBinaryConfigFilename"`) - $stack-\>**tftp\_host()** The IP address of the TFTP server for all TFTP operations. (`"s5AgSysTftpServerAddress"`) - $stack-\>**vlan()** Returns the VLAN ID of the system's management VLAN. (`"s5AgSysManagementVlanId"`) - $stack-\>**ch\_ser()** Returns the serial number of the chassis. (`"s5ChasSerNum"`) - $stack-\>**ns\_cfg\_chg()** Returns the total number of configuration changes (other than attachment changes, or physical additions or removals) in the chassis that have been detected since cold/warm start. (`"s5ChasGblConfChngs"`) - $stack-\>**ns\_cfg\_time()** Returns the value of `"sysUpTime"` when the last configuration change (other than attachment changes, or physical additions or removals) in the chassis was detected. (`"s5ChasGblConfLstChng"`) ## TABLE METHODS These are methods that return tables of information in the form of a reference to a hash. ### Agent Interface Table ("s5AgMyIfTable") - $stack-\>**i\_cfg\_file()** Returns reference to hash. Key: Table entry, Value: Name of the file (`"s5AgMyIfCfgFname"`) - $stack-\>**i\_cfg\_host()** Returns reference to hash. Key: Table entry, Value: IP address of the load server (`"s5AgMyIfLdSvrAddr"`) ### Chassis Components Table ("s5ChasComTable") - $stack-\>**ns\_com\_grp\_idx()** Returns reference to hash. Key: Table entry, Value: Index of the chassis level group which contains this component. (`"s5ChasComGrpIndx"`) - $stack-\>**ns\_com\_idx()** Returns reference to hash. Key: Table entry, Value: Index of the component in the group. For modules in the 'board' group, this is the slot number. (`"s5ChasComIndx"`) - $stack-\>**ns\_com\_sub\_idx()** Returns reference to hash. Key: Table entry, Value: Index of the sub-component in the component. (`"s5ChasComSubIndx"`) - $stack-\>**ns\_com\_type()** Returns reference to hash. Key: Table entry, Value: Type (`"s5ChasComType"`) - $stack-\>**ns\_com\_descr()** Returns reference to hash. Key: Table entry, Value: Description (`"s5ChasComDescr"`) - $stack-\>**ns\_com\_ver()** Returns reference to hash. Key: Table entry, Value: Version (`"s5ChasComVer"`) - $stack-\>**ns\_com\_serial()** Returns reference to hash. Key: Table entry, Value: Serial Number (`"s5ChasComSerNum"`) ### Storage Area Table ("s5ChasStoreTable") - $stack-\>**ns\_store\_grp\_idx()** Returns reference to hash. Key: Table entry, Value: Index of the chassis level group. (`"s5ChasStoreGrpIndx"`) - $stack-\>**ns\_store\_idx()** Returns reference to hash. Key: Table entry, Value: Index of the group. (`"s5ChasStoreComIndx"`) - $stack-\>**ns\_store\_sub\_idx()** Returns reference to hash. Key: Table entry, Value: Index of the sub-component. (`"s5ChasStoreSubIndx"`) - $stack-\>**ns\_store\_idx()** Returns reference to hash. Key: Table entry, Value: Index of the storage area. (`"s5ChasStoreIndx"`) - $stack-\>**ns\_store\_type()** Returns reference to hash. Key: Table entry, Value: Type (`"s5ChasStoreType"`) - $stack-\>**ns\_store\_size()** Returns reference to hash. Key: Table entry, Value: Size (`"s5ChasStoreCurSize"`) - $stack-\>**ns\_store\_ver()** Returns reference to hash. Key: Table entry, Value: Version (`"s5ChasStoreCntntVer"`) ### Pseudo *ENTITY-MIB* information These methods emulate *ENTITY-MIB* Physical Table methods using *S5-CHASSIS-MIB*. - $stack-\>**ns\_e\_index()** Returns reference to hash. Key: IID, Value: Integer, Indices are combined into a six digit integer, each index is two digits padded with leading zero if required. - $stack-\>**ns\_e\_class()** Returns reference to hash. Key: IID, Value: General hardware type (`"s5ChasGrpDescr"`). Group is stripped from the string. Values may be Supervisory Module, Back Plane, Board, Power Supply, Sensor, Fan, Clock, Unit. - $stack-\>**ns\_e\_descr()** Returns reference to hash. Key: IID, Value: Human friendly name (`"s5ChasComDescr"`) - $stack-\>**ns\_e\_name()** Returns reference to hash. Key: IID, Value: Human friendly name - $stack-\>**ns\_e\_hwver()** Returns reference to hash. Key: IID, Value: Hardware version (`"s5ChasComVer"`) - $stack-\>**ns\_e\_vendor()** Returns reference to hash. Key: IID, Value: avaya - $stack-\>**ns\_e\_serial()** Returns reference to hash. Key: IID, Value: Serial number (`"s5ChasComSerNum"`) - $stack-\>**ns\_e\_pos()** Returns reference to hash. Key: IID, Value: The relative position among all entities sharing the same parent. (`"s5ChasComSubIndx"`) - $stack-\>**ns\_e\_type()** Returns reference to hash. Key: IID, Value: Type of component/sub-component as defined under `"s5ChasComTypeVal"` in *S5-REG-MIB*. - $stack-\>**ns\_e\_fwver()** Returns reference to hash. Key: IID, Value: Firmware revision. Value of `"s5ChasStoreCntntVer"` for entries with rom, boot, or firmware in `"s5ChasStoreType"`. - $stack-\>**ns\_e\_swver()** Returns reference to hash. Key: IID, Value: Software revision. Value of `"s5ChasStoreCntntVer"` for entries with "flash" in `"s5ChasStoreType"`. - $stack-\>**ns\_e\_parent()** Returns reference to hash. Key: IID, Value: The value of **ns\_e\_index()** for the entity which 'contains' this entity. A value of zero indicates this entity is not contained in any other entity. ## Data Munging Callback Subroutines - $stack-\>**munge\_ns\_grp\_type()** Munges `"s5ChasGrpType"` into an `"ENTITY-MIB PhysicalClass"` equivalent.