SNMP::Info::RapidCity(3pm)

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

NAME

6       SNMP::Info::RapidCity - SNMP Interface to the Nortel RapidCity MIB
7

AUTHOR

9       Eric Miller
10

SYNOPSIS

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

DESCRIPTION

27       SNMP::Info::RapidCity is a subclass of SNMP::Info that provides an
28       interface to the "RAPID-CITY" MIB.  This MIB is used across the Nortel
29       Ethernet Routing Switch and Ethernet Switch product lines (Formerly
30       known as Passport, BayStack, and Accelar).
31
32       Use or create in a subclass of SNMP::Info.  Do not use directly.
33
34   Inherited Classes
35       None.
36
37   Required MIBs
38       RAPID-CITY
39

GLOBAL METHODS

41       These are methods that return scalar values from SNMP
42
43       $rapidcity->rc_base_mac()
44           ("rc2kChassisBaseMacAddr")
45
46       $rapidcity->rc_serial()
47           ("rcChasSerialNumber")
48
49       $rapidcity->rc_ch_rev()
50           ("rcChasHardwareRevision")
51
52       $rapidcity->chassis()
53           ("rcChasType")
54
55       $rapidcity->slots()
56           ("rcChasNumSlots")
57
58       $rapidcity->rc_virt_ip()
59           ("rcSysVirtualIpAddr")
60
61       $rapidcity->rc_virt_mask()
62           ("rcSysVirtualNetMask")
63
64       $rapidcity->tftp_host()
65           ("rcTftpHost")
66
67       $rapidcity->tftp_file()
68           ("rcTftpFile")
69
70       $rapidcity->tftp_action()
71           ("rcTftpAction")
72
73       $rapidcity->tftp_result()
74           ("rcTftpResult")
75
76   Overrides
77       $rapidcity->serial()
78           Returns serial number of the chassis
79

TABLE METHODS

81       These are methods that return tables of information in the form of a
82       reference to a hash.
83
84       $rapidcity->i_duplex()
85           Returns reference to map of IIDs to current link duplex.
86
87       $rapidcity->i_duplex_admin()
88           Returns reference to hash of IIDs to admin duplex setting.
89
90       $rapidcity->i_vlan()
91           Returns a mapping between "ifIndex" and the PVID or default VLAN.
92
93       $rapidcity->i_vlan_membership()
94           Returns reference to hash of arrays: key = "ifIndex", value = array
95           of VLAN IDs.  These are the VLANs which are members of the egress
96           list for the port.
97
98             Example:
99             my $interfaces = $rapidcity->interfaces();
100             my $vlans      = $rapidcity->i_vlan_membership();
101
102             foreach my $iid (sort keys %$interfaces) {
103               my $port = $interfaces->{$iid};
104               my $vlan = join(',', sort(@{$vlans->{$iid}}));
105               print "Port: $port VLAN: $vlan\n";
106             }
107
108       $rapidcity->v_index()
109           Returns VLAN IDs
110
111           ("rcVlanId")
112
113   RAPID-CITY Port Table ("rcPortTable")
114       $rapidcity->rc_index()
115           ("rcPortIndex")
116
117       $rapidcity->rc_duplex()
118           ("rcPortOperDuplex")
119
120       $rapidcity->rc_duplex_admin()
121           ("rcPortAdminDuplex")
122
123       $rapidcity->rc_speed_admin()
124           ("rcPortAdminSpeed")
125
126       $rapidcity->rc_auto()
127           ("rcPortAutoNegotiate")
128
129       $rapidcity->rc_alias()
130           ("rcPortName")
131
132   RAPID-CITY CPU Ethernet Port Table ("rc2kCpuEthernetPortTable")
133       $rapidcity->rc_cpu_ifindex()
134           ("rc2kCpuEthernetPortIfIndex")
135
136       $rapidcity->rc_cpu_admin()
137           ("rc2kCpuEthernetPortAdminStatus")
138
139       $rapidcity->rc_cpu_oper()
140           ("rc2kCpuEthernetPortOperStatus")
141
142       $rapidcity->rc_cpu_ip()
143           ("rc2kCpuEthernetPortAddr")
144
145       $rapidcity->rc_cpu_mask()
146           ("rc2kCpuEthernetPortMask")
147
148       $rapidcity->rc_cpu_auto()
149           ("rc2kCpuEthernetPortAutoNegotiate")
150
151       $rapidcity->rc_cpu_duplex_admin()
152           ("rc2kCpuEthernetPortAdminDuplex")
153
154       $rapidcity->rc_cpu_duplex()
155           ("rc2kCpuEthernetPortOperDuplex")
156
157       $rapidcity->rc_cpu_speed_admin()
158           ("rc2kCpuEthernetPortAdminSpeed")
159
160       $rapidcity->rc_cpu_speed_oper()
161           ("rc2kCpuEthernetPortOperSpeed")
162
163       $rapidcity->rc_cpu_mac()
164           ("rc2kCpuEthernetPortMgmtMacAddr")
165
166   RAPID-CITY VLAN Port Table ("rcVlanPortTable")
167       $rapidcity->rc_i_vlan_if()
168           ("rcVlanPortIndex")
169
170       $rapidcity->rc_i_vlan_num()
171           ("rcVlanPortNumVlanIds")
172
173       $rapidcity->rc_i_vlan()
174           ("rcVlanPortVlanIds")
175
176       $rapidcity->rc_i_vlan_type()
177           ("rcVlanPortType")
178
179       $rapidcity->rc_i_vlan_pvid()
180           ("rcVlanPortDefaultVlanId")
181
182       $rapidcity->rc_i_vlan_tag()
183           ("rcVlanPortPerformTagging")
184
185   RAPID-CITY VLAN Table ("rcVlanTable")
186       $rapidcity->rc_vlan_id()
187           ("rcVlanId")
188
189       $rapidcity->v_name()
190           ("rcVlanName")
191
192       $rapidcity->rc_vlan_color()
193           ("rcVlanColor")
194
195       $rapidcity->rc_vlan_if()
196           ("rcVlanIfIndex")
197
198       $rapidcity->rc_vlan_stg()
199           ("rcVlanStgId")
200
201       $rapidcity->rc_vlan_type()
202           ("rcVlanType")
203
204       $rapidcity->rc_vlan_members()
205           ("rcVlanPortMembers")
206
207       $rapidcity->rc_vlan_mac()
208           ("rcVlanMacAddress")
209
210   RAPID-CITY IP Address Table ("rcIpAddrTable")
211       $rapidcity->rc_ip_index()
212           ("rcIpAdEntIfIndex")
213
214       $rapidcity->rc_ip_addr()
215           ("rcIpAdEntAddr")
216
217       $rapidcity->rc_ip_type()
218           ("rcIpAdEntIfType")
219
220   RAPID-CITY Chassis Fan Table ("rcChasFanTable")
221       $rapidcity->rc_fan_op()
222           ("rcChasFanOperStatus")
223
224   RAPID-CITY Power Supply Table ("rcChasPowerSupplyTable")
225       $rapidcity->rc_ps_op()
226           ("rcChasPowerSupplyOperStatus")
227
228   RAPID-CITY Power Supply Detail Table ("rcChasPowerSupplyDetailTable")
229       $rapidcity->rc_ps_type()
230           ("rcChasPowerSupplyDetailType")
231
232       $rapidcity->rc_ps_serial()
233           ("rcChasPowerSupplyDetailSerialNumber")
234
235       $rapidcity->rc_ps_rev()
236           ("rcChasPowerSupplyDetailHardwareRevision")
237
238       $rapidcity->rc_ps_part()
239           ("rcChasPowerSupplyDetailPartNumber")
240
241       $rapidcity->rc_ps_detail()
242           ("rcChasPowerSupplyDetailDescription")
243
244   RAPID-CITY Card Table ("rcCardTable")
245       $rapidcity->rc_c_type()
246           ("rcCardType")
247
248       $rapidcity->rc_c_serial()
249           ("rcCardSerialNumber")
250
251       $rapidcity->rc_c_rev()
252           ("rcCardHardwareRevision")
253
254       $rapidcity->rc_c_part()
255           ("rcCardPartNumber")
256
257   RAPID-CITY 2k Card Table ("rc2kCardTable")
258       $rapidcity->rc2k_c_ftype()
259           ("rc2kCardFrontType")
260
261       $rapidcity->rc2k_c_fdesc()
262           ("rc2kCardFrontDescription")
263
264       $rapidcity->rc2k_c_fserial()
265           ("rc2kCardFrontSerialNum")
266
267       $rapidcity->rc2k_c_frev()
268           ("rc2kCardFrontHwVersion")
269
270       $rapidcity->rc2k_c_fpart()
271           ("rc2kCardFrontPartNumber")
272
273       $rapidcity->rc2k_c_fdate()
274           ("rc2kCardFrontDateCode")
275
276       $rapidcity->rc2k_c_fdev()
277           ("rc2kCardFrontDeviations")
278
279       $rapidcity->rc2k_c_btype()
280           ("rc2kCardBackType")
281
282       $rapidcity->rc2k_c_bdesc()
283           ("rc2kCardBackDescription")
284
285       $rapidcity->rc2k_c_bserial()
286           ("rc2kCardBackSerialNum")
287
288       $rapidcity->rc2k_c_brev()
289           ("rc2kCardBackHwVersion")
290
291       $rapidcity->rc2k_c_bpart()
292           ("rc2kCardBackPartNumber")
293
294       $rapidcity->rc2k_c_bdate()
295           ("rc2kCardBackDateCode")
296
297       $rapidcity->rc2k_c_bdev()
298           ("rc2kCardBackDeviations")
299
300   RAPID-CITY MDA Card Table ("rc2kMdaCardTable")
301       $rapidcity->rc2k_mda_type()
302           ("rc2kMdaCardType")
303
304       $rapidcity->rc2k_mda_desc()
305           ("rc2kMdaCardDescription")
306
307       $rapidcity->rc2k_mda_serial()
308           ("rc2kMdaCardSerialNum")
309
310       $rapidcity->rc2k_mda_rev()
311           ("rc2kMdaCardHwVersion")
312
313       $rapidcity->rc2k_mda_part()
314           ("rc2kMdaCardPartNumber")
315
316       $rapidcity->rc2k_mda_date()
317           ("rc2kMdaCardDateCode")
318
319       $rapidcity->rc2k_mda_dev()
320           ("rc2kMdaCardDeviations")
321

SET METHODS

323       These are methods that provide SNMP set functionality for overridden
324       methods or provide a simpler interface to complex set operations.  See
325       "SETTING DATA VIA SNMP" in SNMP::Info for general information on set
326       operations.
327
328       $rapidcity->set_i_speed_admin(speed, ifIndex)
329           Sets port speed, must be supplied with speed and port "ifIndex".
330           Speed choices are 'auto', '10', '100', '1000'.
331
332            Example:
333            my %if_map = reverse %{$rapidcity->interfaces()};
334            $rapidcity->set_i_speed_admin('auto', $if_map{'1.1'})
335               or die "Couldn't change port speed. ",$rapidcity->error(1);
336
337       $rapidcity->set_i_duplex_admin(duplex, ifIndex)
338           Sets port duplex, must be supplied with duplex and port "ifIndex".
339           Speed choices are 'auto', 'half', 'full'.
340
341             Example:
342             my %if_map = reverse %{$rapidcity->interfaces()};
343             $rapidcity->set_i_duplex_admin('auto', $if_map{'1.1'})
344               or die "Couldn't change port duplex. ",$rapidcity->error(1);
345
346       $rapidcity->set_i_vlan(vlan, ifIndex)
347           Changes an access (untagged) port VLAN, must be supplied with the
348           numeric VLAN ID and port "ifIndex".  This method will modify the
349           port's VLAN membership and PVID (default VLAN).  This method should
350           only be used on end station (non-trunk) ports.
351
352             Example:
353             my %if_map = reverse %{$rapidcity->interfaces()};
354             $rapidcity->set_i_vlan('2', $if_map{'1.1'})
355               or die "Couldn't change port VLAN. ",$rapidcity->error(1);
356
357       $rapidcity->set_i_pvid(pvid, ifIndex)
358           Sets port PVID or default VLAN, must be supplied with the numeric
359           VLAN ID and port "ifIndex".  This method only changes the PVID, to
360           modify an access (untagged) port use set_i_vlan() instead.
361
362             Example:
363             my %if_map = reverse %{$rapidcity->interfaces()};
364             $rapidcity->set_i_pvid('2', $if_map{'1.1'})
365               or die "Couldn't change port PVID. ",$rapidcity->error(1);
366
367       $rapidcity->set_add_i_vlan_tagged(vlan, ifIndex)
368           Adds the port to the egress list of the VLAN, must be supplied with
369           the numeric VLAN ID and port "ifIndex".
370
371             Example:
372             my %if_map = reverse %{$rapidcity->interfaces()};
373             $rapidcity->set_add_i_vlan_tagged('2', $if_map{'1.1'})
374               or die "Couldn't add port to egress list. ",$rapidcity->error(1);
375
376       $rapidcity->set_remove_i_vlan_tagged(vlan, ifIndex)
377           Removes the port from the egress list of the VLAN, must be supplied
378           with the numeric VLAN ID and port "ifIndex".
379
380             Example:
381             my %if_map = reverse %{$rapidcity->interfaces()};
382             $rapidcity->set_remove_i_vlan_tagged('2', $if_map{'1.1'})
383               or die "Couldn't add port to egress list. ",$rapidcity->error(1);
384
385       $rapidcity->set_delete_vlan(vlan)
386           Deletes the specified VLAN from the device.
387
388       $rapidcity->set_create_vlan(name, vlan)
389           Creates the specified VLAN on the device.
390
391           Note:  This method only allows creation of Port type VLANs and does
392           not allow for the setting of the Spanning Tree Group (STG) which
393           defaults to 1.
394
395
396
397perl v5.12.0                      2009-06-12                Info::RapidCity(3)