135/snmp-info
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

- POD Validation

Browse Source 
- POD spell check
- Prep 1.09
This commit is contained in:
Eric Miller
2008-07-07 04:10:39 +00:00
parent 6221228d1f
commit ba85dc670b
69 changed files with 2820 additions and 2760 deletions
Download Patch File Download Diff File Expand all files Collapse all files

103
Info/Layer2/Bay.pm
View File

@@ -1,8 +1,8 @@
# SNMP::Info::Layer2::Bay
# Max Baker
# $Id$
# This module depricated. See Layer2::BayStack
#
# Copyright (c) 2004 Max Baker changes from version 0.8 and beyond.
# Copyright (c) 2008 Max Baker changes from version 0.8 and beyond.
#
# Copyright (c) 2002,2003 Regents of the University of California
# All rights reserved.
@@ -12,27 +12,28 @@
#
# * Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
# * Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
# * Neither the name of the University of California, Santa Cruz nor the
# names of its contributors may be used to endorse or promote products
# derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
# LIABLE FOR # ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
package SNMP::Info::Layer2::Bay;
$VERSION = '1.07';
# $Id$
$VERSION = '1.09';
use strict;
use Exporter;
@@ -277,15 +278,15 @@ Max Baker
=head1 SYNOPSIS
This module is Depricated. Please use Layer2::BayStack instead.
This module is Deprecated. Please use Layer2::BayStack instead.
=head1 DESCRIPTION
Provides abstraction to the configuration information obtainable from a
Bay device through SNMP.
For speed or debugging purposes you can call the subclass directly, but not after determining
a more specific class using the method above.
For speed or debugging purposes you can call the subclass directly, but not
after determining a more specific class using the method above.
my $bay = new SNMP::Info::Layer2::Bay(...);
@@ -301,9 +302,9 @@ a more specific class using the method above.
=over
=item SYNOPTICS-ROOT-MIB
=item F<SYNOPTICS-ROOT-MIB>
=item S5-ETH-MULTISEG-TOPOLOGY-MIB
=item F<S5-ETH-MULTISEG-TOPOLOGY-MIB>
=item Inherited classes
@@ -311,15 +312,6 @@ MIBs required by L<SNMP::Info::Layer2/"Required MIBs"> and its superclasses.
=back
Bay MIBs can be found on the CD that came with your product.
Or, if you still have a service contract they can be downloaded at
www.nortelnetworks.com
They have also been seen at : http://www.inotech.com/mibs/vendor/baynetworks/synoptics/synoptics.asp
Or http://www.oidview.com/mibs/detail.html under Synoptics. Check also www.mibdepot.com
=head1 GLOBALS
These are methods that return scalar value from SNMP
@@ -332,23 +324,23 @@ Returns 'bay' :)
=item $bay->model()
Cross references $bay->id() to the SYNOPTICS-MIB and returns
Cross references $bay->id() to the F<SYNOPTICS-MIB> and returns
the results. 303s and 304s have the same ID, so we have a hack
to return depending on which it is.
Removes sreg- from the model name
Removes C<sreg-> from the model name
=item $bay->cdp_id()
Returns the IP that the device is sending out for its Nmm topology info.
(B<s5EnMsTopIpAddr>)
(C<s5EnMsTopIpAddr>)
=item $bay->cdp_run()
Returns if the S5-ETH-MULTISEG-TOPOLOGY info is on for this device.
Returns if the F<S5-ETH-MULTISEG-TOPOLOGY> info is on for this device.
(B<s5EnMsTopStatus>)
(C<s5EnMsTopStatus>)
=back
@@ -369,17 +361,17 @@ to a hash.
Returns reference to map of IIDs to physical ports.
Currently simply returns the B<ifIndex>
Currently simply returns the C<ifIndex>
=item $bay->i_ignore()
Returns reference to hash of IIDs to ignore.
Simply calls the SNMP::Info::Layer2::i_ignore() fn for this.
Simply calls the SNMP::Info::Layer2::i_ignore() for this.
=item $bay->i_mac()
Returns the B<ifPhysAddress> table entries.
Returns the C<ifPhysAddress> table entries.
Removes all entries matching '00:00:00:00:00:00' -- Certain
older revisions of Bay 303 and 304 firmware report all zeros
@@ -387,7 +379,7 @@ for each port mac.
=back
=head2 Psuedo CDP information
=head2 Pseudo CDP information
All entries with port=0 are local and ignored.
@@ -395,18 +387,20 @@ All entries with port=0 are local and ignored.
=item $bay->c_if()
Returns referenece to hash. Key: port.1 Value: port (iid)
Returns reference to hash. Key: port.1 Value: port (iid)
=item $bay->c_ip()
Returns referenece to hash. Key: port.1
Returns reference to hash. Key: port.1
The value of each hash entry can either be a scalar or an array.
A scalar value is most likely a direct neighbor to that port.
It is possible that there is a non-bay device in between this device and the remote device.
It is possible that there is a non-bay device in between this device and the
remote device.
An array value represents a list of seen devices. The only time you will get an array
of nieghbors, is if there is a non-bay device in between two or more devices.
An array value represents a list of seen devices. The only time you will get
an array of neighbors, is if there is a non-bay device in between two or more
devices.
Use the data from the Layer2 Topology Table below to dig deeper.
@@ -420,7 +414,7 @@ Returns reference to hash. Key: port.1 Value: Remote Device Type
=back
=head2 Layer2 Topology info (s5EnMsTopNmmTable)
=head2 Layer2 Topology info (C<s5EnMsTopNmmTable>)
=over
@@ -428,28 +422,28 @@ Returns reference to hash. Key: port.1 Value: Remote Device Type
Returns reference to hash. Key: Table entry, Value:slot number
(B<s5EnMsTopNmmSlot>)
(C<s5EnMsTopNmmSlot>)
=item $bay->bay_topo_port()
Returns reference to hash. Key: Table entry, Value:Port Number (interface iid)
(B<s5EnMsTopNmmPort>)
(C<s5EnMsTopNmmPort>)
=item $bay->bay_topo_ip()
Returns reference to hash. Key: Table entry, Value:Remote IP address of entry
(B<s5EnMsTopNmmIpAddr>)
(C<s5EnMsTopNmmIpAddr>)
=item $bay->bay_topo_seg()
Returns reference to hash. Key: Table entry, Value:Remote Segment ID
(B<s5EnMsTopNmmSegId>)
(C<s5EnMsTopNmmSegId>)
=item $bay->bay_topo_mac
(B<s5EnMsTopNmmMacAddr>)
(C<s5EnMsTopNmmMacAddr>)
Returns reference to hash. Key: Table entry, Value:Remote MAC address
@@ -457,13 +451,14 @@ Returns reference to hash. Key: Table entry, Value:Remote MAC address
Returns reference to hash. Key: Table entry, Value:Remote Device Type
(B<s5EnMsTopNmmChassisType>)
(C<s5EnMsTopNmmChassisType>)
=item $bay->bay_topo_localseg
Returns reference to hash. Key: Table entry, Value:Boolean, if bay_topo_seg() is local
Returns reference to hash. Key: Table entry, Value:Boolean, if bay_topo_seg()
is local
(B<s5EnMsTopNmmLocalSeg>)
(C<s5EnMsTopNmmLocalSeg>)
=back