1SNMP::Info::Layer1::S30U0s0e(r3)Contributed Perl DocumenStNaMtPi:o:nInfo::Layer1::S3000(3)
2
3
4

NAME

6       SNMP::Info::Layer1::S3000 - SNMP Interface to Synoptics / Nortel Hubs
7

AUTHOR

9       Eric Miller
10

SYNOPSIS

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

DESCRIPTION

28       Provides abstraction to the configuration information obtainable from a
29       Bay hub device through SNMP.  Also provides device MAC to port mapping
30       through the proprietary MIB.
31
32       For speed or debugging purposes you can call the subclass directly, but
33       not after determining a more specific class using the method above.
34
35       my $s3000 = new SNMP::Info::Layer1::S3000(...);
36
37   Inherited Classes
38       SNMP::Info::Layer2
39
40   Required MIBs
41       SYNOPTICS-COMMON-MIB
42       SYNOPTICS-ETHERNET-MIB
43
44   Inherited MIBs
45       See "Required MIBs" in SNMP::Info::Layer2 for its MIB requirements.
46

GLOBALS

48       These are methods that return scalar value from SNMP
49
50       $s3000->vendor()
51           Returns 'nortel'
52
53       $s3000->os()
54           Returns 'synoptics'
55
56       $s3000->model()
57           Cross references $s3000->id() to the SYNOPTICS-MIB and returns the
58           results.
59
60           Removes "sreg-" from the model name and returns only the numeric
61           model identifier.
62
63       $stack->os_ver()
64           Returns the software version specified as major.minor.maint.
65
66           ("s3AgentSwMajorVer").("s3AgentSwMinorVer").("s3AgentSwMaintVer")
67
68       $stack->os_bin()
69           Returns the firmware version. ("s3AgentFwVer")
70
71       $s3000->mac()
72           Returns MAC of the advertised IP address of the device.
73
74   Overrides
75       $s3000->layers()
76           Returns 00000011.  Class emulates Layer 2 functionality through
77           proprietary MIBs.
78
79   Globals imported from SNMP::Info::Layer2
80       See "GLOBALS" in SNMP::Info::Layer2 for details.
81

TABLE METHODS

83       These are methods that return tables of information in the form of a
84       reference to a hash.
85
86   Overrides
87       $s3000->i_index()
88           Returns reference to map of IIDs to Interface index.
89
90           Since hubs do not support "ifIndex", the interface index is created
91           using the formula (board * 256 + port).  This is required to
92           support devices with more than one module.
93
94       $s3000->interfaces()
95           Returns reference to map of IIDs to physical ports.
96
97       $s3000->i_duplex()
98           Returns half, hubs do not support full duplex.
99
100       $s3000->i_duplex_admin()
101           Returns half, hubs do not support full duplex.
102
103       $s3000->i_speed()
104           Returns 10000000.  The hubs only support 10 Mbs Ethernet.
105
106       $s3000->i_up()
107           Returns ("s3EnetPortLinkStatus") for each port.  Translates on/off
108           to up/down.
109
110       $s3000->i_up_admin()
111           Returns ("s3EnetPortPartStatus") for each port.
112
113       $s3000->set_i_up_admin(state, ifIndex)
114           Sets port state, must be supplied with state and port "ifIndex"
115
116           State choices are 'up' or 'down'
117
118           Example:
119             my %if_map = reverse %{$s3000->interfaces()};
120             $s3000->set_i_up_admin('down', $if_map{'1.1'})
121                 or die "Couldn't change port state. ",$s3000->error(1);
122
123       $s3000->bp_index()
124           Simulates bridge MIB by returning reference to a hash containing
125           the index for both the keys and values.
126
127       $s3000->fw_port()
128           Returns reference to map of IIDs of the
129           "SYNOPTICS-ETHERNET-MIB::s3EnetShowNodesTable" to the Interface
130           index.
131
132       $s3000->fw_mac()
133           ("s3EnetShowNodesMacAddress")
134
135       $s3000->s3000_topo_port()
136           Returns reference to hash.  Key: Table entry, Value:Port Number
137           (interface iid)
138
139           ("s3EnetTopNmmPort")
140
141       $s3000->s3000_topo_mac()
142           ("s3EnetTopNmmMacAddr")
143
144           Returns reference to hash.  Key: Table entry, Value:Remote MAC
145           address
146
147   Table Methods imported from SNMP::Info::Layer2
148       See "TABLE METHODS" in SNMP::Info::Layer2 for details.
149
150
151
152perl v5.28.0                      2018-11-29      SNMP::Info::Layer1::S3000(3)
Impressum