SNMP::Info::Layer3::Passport(3pm)

1SNMP::Info::Layer3::PasUsspeorrtC(o3nptmr)ibuted Perl DoScNuMmPe:n:tIantfioo:n:Layer3::Passport(3pm)
2
3
4

NAME

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

GLOBALS

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

TABLE METHODS

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