1Info::NortelStack(3)  User Contributed Perl Documentation Info::NortelStack(3)
2
3
4

NAME

6       SNMP::Info::NortelStack - SNMP Interface to the Nortel S5-AGENT-MIB and
7       S5-CHASSIS-MIB
8

AUTHOR

10       Eric Miller
11

SYNOPSIS

13        # Let SNMP::Info determine the correct subclass for you.
14        my $stack = new SNMP::Info(
15                           AutoSpecify => 1,
16                           Debug       => 1,
17                           # These arguments are passed directly on to SNMP::Session
18                           DestHost    => 'myswitch',
19                           Community   => 'public',
20                           Version     => 2
21                           )
22           or die "Can't connect to DestHost.\n";
23
24        my $class = $stack->class();
25        print "SNMP::Info determined this device to fall under subclass : $class\n";
26

DESCRIPTION

28       SNMP::Info::NortelStack is a subclass of SNMP::Info that provides an
29       interface to S5-AGENT-MIB and S5-CHASSIS-MIB.  These MIBs are used
30       across the Nortel Stackable Ethernet Switches (BayStack), as well as,
31       older Nortel devices such as the Centillion family of ATM switches.
32
33       Use or create in a subclass of SNMP::Info.  Do not use directly.
34
35   Inherited Classes
36       None.
37
38   Required MIBs
39       S5-AGENT-MIB
40       S5-CHASSIS-MIB
41       S5-ROOT-MIB and S5-TCS-MIB are required by the other MIBs.
42

GLOBAL METHODS

44       These are methods that return scalar values from SNMP
45
46       $stack->os_ver()
47           Returns the software version extracted from ("s5AgInfoVer")
48
49       $stack->os_bin()
50           Returns the firmware version extracted from ("s5AgInfoVer")
51
52       $stack->serial()
53           Returns serial number of the chassis
54
55           ("s5ChasSerNum")
56
57       $stack->ns_ag_ver()
58           Returns the version of the agent in the form
59           'major.minor.maintenance[letters]'.
60
61           ("s5AgInfoVer")
62
63       $stack->ns_op_mode()
64           Returns the stacking mode.
65
66           ("s5AgSysCurrentOperationalMode")
67
68       $stack->tftp_action()
69           This object is used to download or upload a config file or an image
70           file.
71
72           ("s5AgInfoFileAction")
73
74       $stack->tftp_result()
75           Returns the status of the latest action as shown by
76           $stack->tftp_action().
77
78           ("s5AgInfoFileStatus")
79
80       $stack->ns_auto_pvid()
81           Returns the value indicating whether adding a port as a member of a
82           VLAN automatically results in its PVID being set to be the same as
83           that VLAN ID.
84
85           ("s5AgSysAutoPvid")
86
87       $stack->tftp_file()
88           Name of the binary configuration file that will be
89           downloaded/uploaded when the $stack->tftp_action() object is set.
90
91           ("s5AgSysBinaryConfigFilename")
92
93       $stack->tftp_host()
94           The IP address of the TFTP server for all TFTP operations.
95
96           ("s5AgSysTftpServerAddress")
97
98       $stack->vlan()
99           Returns the VLAN ID of the system's management VLAN.
100
101           ("s5AgSysManagementVlanId")
102
103       $stack->ch_ser()
104           Returns the serial number of the chassis.
105
106           ("s5ChasSerNum")
107
108       $stack->ns_cfg_chg()
109           Returns the total number of configuration changes (other than
110           attachment changes, or physical additions or removals) in the
111           chassis that have been detected since cold/warm start.
112
113           ("s5ChasGblConfChngs")
114
115       $stack->ns_cfg_time()
116           Returns the value of "sysUpTime" when the last configuration change
117           (other than attachment changes, or physical additions or removals)
118           in the chassis was detected.
119
120           ("s5ChasGblConfLstChng")
121

TABLE METHODS

123       These are methods that return tables of information in the form of a
124       reference to a hash.
125
126   Agent Interface Table ("s5AgMyIfTable")
127       $stack->i_cfg_file()
128           Returns reference to hash.  Key: Table entry, Value: Name of the
129           file
130
131           ("s5AgMyIfCfgFname")
132
133       $stack->i_cfg_host()
134           Returns reference to hash.  Key: Table entry, Value: IP address of
135           the load server
136
137           ("s5AgMyIfLdSvrAddr")
138
139   Chassis Components Table ("s5ChasComTable")
140       $stack->ns_com_grp_idx()
141           Returns reference to hash.  Key: Table entry, Value: Index of the
142           chassis level group which contains this component.
143
144           ("s5ChasComGrpIndx")
145
146       $stack->ns_com_idx()
147           Returns reference to hash.  Key: Table entry, Value: Index of the
148           component in the group.  For modules in the 'board' group, this is
149           the slot number.
150
151           ("s5ChasComIndx")
152
153       $stack->ns_com_sub_idx()
154           Returns reference to hash.  Key: Table entry, Value: Index of the
155           sub-component in the component.
156
157           ("s5ChasComSubIndx")
158
159       $stack->ns_com_type()
160           Returns reference to hash.  Key: Table entry, Value: Type
161
162           ("s5ChasComType")
163
164       $stack->ns_com_descr()
165           Returns reference to hash.  Key: Table entry, Value: Description
166
167           ("s5ChasComDescr")
168
169       $stack->ns_com_ver()
170           Returns reference to hash.  Key: Table entry, Value: Version
171
172           ("s5ChasComVer")
173
174       $stack->ns_com_serial()
175           Returns reference to hash.  Key: Table entry, Value: Serial Number
176
177           ("s5ChasComSerNum")
178
179   Storage Area Table ("s5ChasStoreTable")
180       $stack->ns_store_grp_idx()
181           Returns reference to hash.  Key: Table entry, Value: Index of the
182           chassis level group.
183
184           ("s5ChasStoreGrpIndx")
185
186       $stack->ns_store_idx()
187           Returns reference to hash.  Key: Table entry, Value: Index of the
188           group.
189
190           ("s5ChasStoreComIndx")
191
192       $stack->ns_store_sub_idx()
193           Returns reference to hash.  Key: Table entry, Value: Index of the
194           sub-component.
195
196           ("s5ChasStoreSubIndx")
197
198       $stack->ns_store_idx()
199           Returns reference to hash.  Key: Table entry, Value: Index of the
200           storage area.
201
202           ("s5ChasStoreIndx")
203
204       $stack->ns_store_type()
205           Returns reference to hash.  Key: Table entry, Value: Type
206
207           ("s5ChasStoreType")
208
209       $stack->ns_store_size()
210           Returns reference to hash.  Key: Table entry, Value: Size
211
212           ("s5ChasStoreCurSize")
213
214       $stack->ns_store_ver()
215           Returns reference to hash.  Key: Table entry, Value: Version
216
217           ("s5ChasStoreCntntVer")
218
219   Pseudo ENTITY-MIB information
220       These methods emulate ENTITY-MIB Physical Table methods using
221       S5-CHASSIS-MIB.
222
223       $stack->ns_e_index()
224           Returns reference to hash.  Key: IID, Value: Integer, Indices are
225           combined into a six digit integer, each index is two digits padded
226           with leading zero if required.
227
228       $stack->ns_e_class()
229           Returns reference to hash.  Key: IID, Value: General hardware type
230           ("s5ChasGrpDescr").
231
232           Group is stripped from the string.  Values may be Supervisory
233           Module, Back Plane, Board, Power Supply, Sensor, Fan, Clock, Unit.
234
235       $stack->ns_e_descr()
236           Returns reference to hash.  Key: IID, Value: Human friendly name
237
238           ("s5ChasComDescr")
239
240       $stack->ns_e_name()
241           Returns reference to hash.  Key: IID, Value: Human friendly name
242
243       $stack->ns_e_hwver()
244           Returns reference to hash.  Key: IID, Value: Hardware version
245
246           ("s5ChasComVer")
247
248       $stack->ns_e_vendor()
249           Returns reference to hash.  Key: IID, Value: nortel
250
251       $stack->ns_e_serial()
252           Returns reference to hash.  Key: IID, Value: Serial number
253
254           ("s5ChasComSerNum")
255
256       $stack->ns_e_pos()
257           Returns reference to hash.  Key: IID, Value: The relative position
258           among all entities sharing the same parent.
259
260           ("s5ChasComSubIndx")
261
262       $stack->ns_e_type()
263           Returns reference to hash.  Key: IID, Value: Type of
264           component/sub-component as defined under "s5ChasComTypeVal" in
265           S5-REG-MIB.
266
267       $stack->ns_e_fwver()
268           Returns reference to hash.  Key: IID, Value: Firmware revision.
269
270           Value of "s5ChasStoreCntntVer" for entries with rom, boot, or
271           firmware in "s5ChasStoreType".
272
273       $stack->ns_e_swver()
274           Returns reference to hash.  Key: IID, Value: Software revision.
275
276           Value of "s5ChasStoreCntntVer" for entries with "flash" in
277           "s5ChasStoreType".
278
279       $stack->ns_e_parent()
280           Returns reference to hash.  Key: IID, Value: The value of
281           ns_e_index() for the entity which 'contains' this entity.  A value
282           of zero indicates   this entity is not contained in any other
283           entity.
284

Data Munging Callback Subroutines

286       $stack->munge_ns_grp_type()
287           Munges "s5ChasGrpType" into an "ENTITY-MIB PhysicalClass"
288           equivalent.
289
290
291
292perl v5.12.0                      2009-06-12              Info::NortelStack(3)