1Info::Layer3::Passport(U3s)er Contributed Perl DocumentatIinofno::Layer3::Passport(3)
2
3
4

NAME

6       SNMP::Info::Layer3::Passport - SNMP Interface to modular Nortel
7       Ethernet Routing Switches (formerly Passport / Accelar)
8

AUTHOR

10       Eric Miller
11

SYNOPSIS

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

DESCRIPTION

27       Abstraction subclass for modular Nortel Ethernet Routing Switches
28       (formerly Passport and Accelar Series Switches).
29
30       These devices have some of the same characteristics as the stackable
31       Nortel Ethernet Switches (Baystack).  For example, extended interface
32       information is gleaned from RAPID-CITY.
33
34       For speed or debugging purposes you can call the subclass directly, but
35       not after determining a more specific class using the method above.
36
37        my $passport = new SNMP::Info::Layer3::Passport(...);
38
39   Inherited Classes
40       SNMP::Info::SONMP
41       SNMP::Info::RapidCity
42       SNMP::Info::Layer3
43
44   Required MIBs
45       Inherited Classes' MIBs
46           See "Required MIBs" in SNMP::Info::SONMP for its own MIB
47           requirements.
48
49           See "Required MIBs" in SNMP::Info::RapidCity for its own MIB
50           requirements.
51
52           See "Required MIBs" in SNMP::Info::Layer3 for its own MIB
53           requirements.
54

GLOBALS

56       These are methods that return scalar value from SNMP
57
58       $passport->model()
59           Returns model type.  Checks $passport->id() against the RAPID-CITY-
60           MIB and then parses out "rcA".
61
62       $passport->vendor()
63           Returns 'nortel'
64
65       $passport->os()
66           Returns 'passport'
67
68       $passport->os_ver()
69           Returns the software version extracted from "sysDescr"
70
71       $passport->serial()
72           Returns ("rcChasSerialNumber")
73
74       $passport->root_ip()
75           Returns the primary IP used to communicate with the device.
76           Returns the first found:  CLIP (CircuitLess IP), Management Virtual
77           IP ("rcSysVirtualIpAddr"), OSPF Router ID ("ospfRouterId"), SONMP
78           Advertised IP Address.
79
80   Overrides
81       $passport->index_factor()
82           Required by SNMP::Info::SONMP.  Returns 64 for 8600, 16 for
83           Accelar.
84
85       $passport->port_offset()
86           Required by SNMP::Info::SONMP.  Returns 1.
87
88       $passport->slot_offset()
89           Required by SNMP::Info::SONMP.  Returns 0.
90
91   Global Methods imported from SNMP::Info::SONMP
92       See documentation in "GLOBALS" in SNMP::Info::SONMP for details.
93
94   Global Methods imported from SNMP::Info::RapidCity
95       See documentation in "GLOBALS" in SNMP::Info::RapidCity for details.
96
97   Globals imported from SNMP::Info::Layer3
98       See documentation in "GLOBALS" in SNMP::Info::Layer3 for details.
99

TABLE METHODS

101       These are methods that return tables of information in the form of a
102       reference to a hash.
103
104   Overrides
105       $passport->i_index()
106           Returns SNMP IID to Interface index.  Extends ("ifIndex") by adding
107           the index of the CPU virtual management IP (if present), each CPU
108           Ethernet port, and each VLAN to ensure the virtual router ports are
109           captured.
110
111       $passport->interfaces()
112           Returns reference to the map between IID and physical Port.
113
114           Slot and port numbers on the Passport switches are determined by
115           the formula: port = ("ifIndex % index_factor") + port_offset, slot
116           = int("ifIndex / index_factor").
117
118           The physical port name is returned as slot.port.  CPU Ethernet
119           ports are prefixed with CPU and VLAN interfaces are returned as the
120           VLAN ID prefixed with Vlan.
121
122       $passport->i_mac()
123           MAC address of the interface.  Note this is just the MAC of the
124           port, not anything connected to it.
125
126       $passport->i_description()
127           Description of the interface. Usually a little longer single word
128           name that is both human and machine friendly.  Not always.
129
130       $passport->i_name()
131           Crosses rc_alias() ("rcPortName") with ifAlias() and returns the
132           human set port name if exists.
133
134       $passport->ip_index()
135           Maps the IP Table to the IID.  Extends ("ipAdEntIfIndex") by adding
136           the index of the CPU virtual management IP (if present) and each
137           CPU Ethernet port.
138
139       $passport->ip_netmask()
140           Extends ("ipAdEntNetMask") by adding the mask of the CPU virtual
141           management IP (if present) and each CPU Ethernet port.
142
143       $passport->bp_index()
144           Returns reference to hash of bridge port table entries map back to
145           interface identifier (iid)
146
147           Returns ("ifIndex") for both key and value since some devices seem
148           to have problems with BRIDGE-MIB
149
150   Pseudo ENTITY-MIB information
151       These devices do not support ENTITY-MIB.  These methods emulate
152       Physical Table methods using the RAPID-CITY MIB.
153
154       $passport->e_index()
155           Returns reference to hash.  Key and Value: Integer. The index is
156           created by combining the slot, module, and position into a five or
157           six digit integer.  Slot can be either one or two digits while the
158           module and position are each two digits padded with leading zero if
159           required.
160
161       $passport->e_class()
162           Returns reference to hash.  Key: IID, Value: General hardware type.
163           This class only returns container, module, and power supply types.
164
165       $passport->e_descr()
166           Returns reference to hash.  Key: IID, Value: Human friendly name.
167
168       $passport->e_name()
169           Returns reference to hash.  Key: IID, Value: Human friendly name.
170
171       $passport->e_hwver()
172           Returns reference to hash.  Key: IID, Value: Hardware version.
173
174       $passport->e_vendor()
175           Returns reference to hash.  Key: IID, Value: nortel.
176
177       $passport->e_serial()
178           Returns reference to hash.  Key: IID, Value: Serial number.
179
180       $passport->e_pos()
181           Returns reference to hash.  Key: IID, Value: The relative position
182           among all entities sharing the same parent.
183
184       $passport->e_type()
185           Returns reference to hash.  Key: IID, Value: Type of
186           component/sub-component.
187
188       $passport->e_parent()
189           Returns reference to hash.  Key: IID, Value: The value of e_index()
190           for the entity which 'contains' this entity.  A value of zero
191           indicates  this entity is not contained in any other entity.
192
193   Table Methods imported from SNMP::Info::SONMP
194       See documentation in "TABLE METHODS" in SNMP::Info::SONMP for details.
195
196   Table Methods imported from SNMP::Info::RapidCity
197       See documentation in "TABLE METHODS" in SNMP::Info::RapidCity for
198       details.
199
200   Table Methods imported from SNMP::Info::Layer3
201       See documentation in "TABLE METHODS" in SNMP::Info::Layer3 for details.
202
203
204
205perl v5.12.0                      2009-06-12         Info::Layer3::Passport(3)