1SNMP::Info::Layer3::BayURsSe(r3pCmo)ntributed Perl DocumSeNnMtPa:t:iIonnfo::Layer3::BayRS(3pm)
2
3
4

NAME

6       SNMP::Info::Layer3::BayRS - SNMP Interface to Avaya/Nortel routers
7       running BayRS.
8

AUTHOR

10       Eric Miller
11

SYNOPSIS

13        # Let SNMP::Info determine the correct subclass for you.
14        my $bayrs = 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      = $bayrs->class();
24        print "SNMP::Info determined this device to fall under subclass : $class\n";
25

DESCRIPTION

27       Abstraction subclass for routers running Avaya/Nortel BayRS.
28
29   Inherited Classes
30       SNMP::Info::Layer3
31
32   Required MIBs
33       Wellfleet-HARDWARE-MIB
34       Wellfleet-MODULE-MIB
35       Wellfleet-OSPF-MIB
36       Wellfleet-DOT1QTAG-CONFIG-MIB
37       Wellfleet-CSMACD-MIB
38
39   Inherited MIBs
40       See "Required MIBs" in SNMP::Info::Layer3 for its own MIB requirements.
41

GLOBALS

43       These are methods that return scalar value from SNMP
44
45       $bayrs->model()
46           Returns the model of the BayRS router.  Will translate between the
47           MIB model and the common model with this map :
48
49               C<%MODEL_MAP = (
50                   'acefn'     => 'FN',
51                   'aceln'     => 'LN',
52                   'acecn'     => 'CN',
53                   'afn'       => 'AFN',
54                   'in'        => 'IN',
55                   'an'        => 'AN',
56                   'arn'       => 'ARN',
57                   'sys5000'   => '5000',
58                   'freln'     => 'BLN',
59                   'frecn'     => 'BCN',
60                   'frerbln'   => 'BLN-2',
61                   'asn'       => 'ASN',
62                   'asnzcable' => 'ASN-Z',
63                   'asnbcable' => 'ASN-B',
64                   );>
65
66       $bayrs->vendor()
67           Returns 'avaya'
68
69       $bayrs->os()
70           Returns 'bayrs'
71
72       $bayrs->os_ver()
73           Returns the software version extracted from "sysDescr"
74
75       $bayrs->serial()
76           Returns ("wfHwBpSerialNumber") after conversion to ASCII decimal
77
78       $bayrs->root_ip()
79           Returns the primary IP used to communicate with the router.
80
81           Returns the first found:  CLIP (CircuitLess IP),
82           ("wfOspfRouterId"), or undefined.
83
84   Globals imported from SNMP::Info::Layer3
85       See documentation in "GLOBALS" in SNMP::Info::Layer3 for details.
86

TABLE METHODS

88       These are methods that return tables of information in the form of a
89       reference to a hash.
90
91       Note:  These methods do not support partial table fetches, a partial
92       can be passed but the entire table will be returned.
93
94   Overrides
95       $bayrs->interfaces()
96           Returns reference to the map between IID and physical Port.
97
98           The physical port name is stripped to letter and numbers to signify
99           port type and slot port (S11) if the default platform naming was
100           maintained.  Otherwise the port is the interface description.
101
102       $bayrs->i_name()
103           Returns ("ifDescr") along with VLAN name ("wfDot1qTagCfgVlanName")
104           for VLAN interfaces.
105
106       $bayrs->i_duplex()
107           Returns reference to hash.  Maps port operational duplexes to IIDs
108           for Ethernet interfaces.
109
110       $bayrs->i_duplex_admin()
111           Returns reference to hash.  Maps port admin duplexes to IIDs for
112           Ethernet interfaces.
113
114       $bayrs->i_vlan()
115           Returns reference to hash.  Maps port VLAN ID to IIDs.
116
117       $bayrs->i_pvid()
118           Returns reference to hash.  Maps port VLAN ID to IIDs.
119
120   Pseudo ENTITY-MIB information
121       These methods emulate ENTITY-MIB Physical Table methods using
122       Wellfleet-HARDWARE-MIB and Wellfleet-MODULE-MIB.
123
124       $bayrs->e_index()
125           Returns reference to hash.  Key and Value: Integer. The index is
126           created by combining the slot, module, and position into a five or
127           six digit integer.  Slot can be either one or two digits while the
128           module and position are each two digits padded with leading zero if
129           required.
130
131       $bayrs->e_class()
132           Returns reference to hash.  Key: IID, Value: General hardware type.
133           This class only returns container and module types.
134
135       $bayrs->e_descr()
136           Returns reference to hash.  Key: IID, Value: Human friendly name.
137
138       $bayrs->e_name()
139           Returns reference to hash.  Key: IID, Value: Human friendly name.
140
141       $bayrs->e_hwver()
142           Returns reference to hash.  Key: IID, Value: Hardware version.
143
144       $bayrs->e_vendor()
145           Returns reference to hash.  Key: IID, Value: avaya.
146
147       $bayrs->e_serial()
148           Returns reference to hash.  Key: IID, Value: Serial number.
149
150       $bayrs->e_pos()
151           Returns reference to hash.  Key: IID, Value: The relative position
152           among all entities sharing the same parent.
153
154       $bayrs->e_type()
155           Returns reference to hash.  Key: IID, Value: Type of
156           component/sub-component as defined in Wellfleet-HARDWARE-MIB for
157           processors and link modules or Wellfleet-MODULE-MIB for hardware
158           modules.
159
160       $bayrs->e_fwver()
161           Returns reference to hash.  Key: IID, Value: Firmware revision.
162           Only available on processors.
163
164       $bayrs->e_swver()
165           Returns reference to hash.  Key: IID, Value: Software revision.
166           Only available on processors.
167
168       $bayrs->e_parent()
169           Returns reference to hash.  Key: IID, Value: The value of e_index()
170           for the entity which 'contains' this entity.  A value of zero
171           indicates  this entity is not contained in any other entity.
172
173   Table Methods imported from SNMP::Info::Layer3
174       See documentation in "TABLE METHODS" in SNMP::Info::Layer3 for details.
175

Data Munging Callback Subroutines

177       $bayrs->munge_hw_rev()
178           Converts octets to a decimal major.minor string.
179
180       $bayrs->munge_wf_serial()
181           Coverts octets to a decimal string.
182
183
184
185perl v5.38.0                      2023-09-04    SNMP::Info::Layer3::BayRS(3pm)
Impressum