NAME

SNMP::Info::SONMP - Perl5 Interface to SynOptics Network Management Protocol (SONMP) using SNMP


AUTHOR

Max Baker (max@warped.org), Eric Miller (eric@jeneric.org)


SYNOPSIS

 my $sonmp = new SNMP::Info ( 
                             AutoSpecify => 1,
                             Debug       => 1,
                             DestHost    => 'router', 
                             Community   => 'public',
                             Version     => 2
                           );
 my $class = $sonmp->class();
 print " Using device sub class : $class\n";
 $hascdp   = $sonmp->hasCDP() ? 'yes' : 'no';
 # Print out a map of device ports with CDP neighbors:
 my $interfaces = $sonmp->interfaces();
 my $c_if       = $sonmp->c_if();
 my $c_ip       = $sonmp->c_ip();
 my $c_port     = $sonmp->c_port();
 foreach my $cdp_key (keys %$c_ip){
    my $iid           = $c_if->{$cdp_key};
    my $port          = $interfaces->{$iid};
    my $neighbor      = $c_ip->{$cdp_key};
    my $neighbor_port = $c_port->{$cdp_key};
    print "Port : $port connected to $neighbor / $neighbor_port\n";
 }


DESCRIPTION

SNMP::Info::SONMP is a subclass of SNMP::Info that provides an object oriented interface to the SynOptics Network Management Protocol (SONMP) information through SNMP.

SONMP is a Layer 2 protocol that supplies topology information of devices that also speak SONMP, mostly switches and hubs. SONMP is implemented in SynOptics, Bay, and Nortel Networks devices. SONMP has been rebranded by Bay then Nortel Networks and is know by several different names.

Create or use a device subclass that inherits this class. Do not use directly.

Each device implements a subset of the global and cache entries. Check the return value to see if that data is held by the device.

Inherited Classes

None.

Required MIBs

SYNOPTICS-ROOT-MIB
S5-ETH-MULTISEG-TOPOLOGY-MIB

MIBs can be found on the CD that came with your product.

Or, they can be downloaded directly from Nortel Networks regardless of support contract status.

Go to http://www.nortelnetworks.com Techninal Support, Browse Technical Support, Select by product, Java Device Manager, Software. Download the latest version. After installation, all mibs are located under the install directory under mibs and the repspective product line.

Note: Required version of SYNOPTICS-ROOT-MIB, must be version 199 or higher, for example synro199.mib.


GLOBAL METHODS

These are methods that return scalar values from SNMP

$sonmp->index_factor()
Returns a number representing the number of ports reserved per slot or switch within the device MIB. Defaults to 32.

$sonmp->slot_offset()
Returns the offset if slot numbering does not start at 0. Defaults to 1.

$sonmp->port_offset()
Returns the offset if port numbering does not start at 0. Defaults to 0.

$cdp->hasCDP()
Is CDP is active in this device?

$sonmp->cdp_id()
Returns the IP that the device is sending out for its Nmm topology info.

(s5EnMsTopIpAddr)

$sonmp->cdp_run()
Returns if the S5-ETH-MULTISEG-TOPOLOGY info is on for this device.

(s5EnMsTopStatus)

$sonmp->mac()
Returns MAC of the advertised IP address of the device.


TABLE METHODS

These are methods that return tables of information in the form of a reference to a hash.

Layer2 Topology info (s5EnMsTopNmmTable)

$sonmp->sonmp_topo_slot()
Returns reference to hash. Key: Table entry, Value:slot number

(s5EnMsTopNmmSlot)

$sonmp->sonmp_topo_port()
Returns reference to hash. Key: Table entry, Value:Port Number (interface iid)

(s5EnMsTopNmmPort)

$sonmp->sonmp_topo_ip()
Returns reference to hash. Key: Table entry, Value:Remote IP address of entry

(s5EnMsTopNmmIpAddr)

$sonmp->sonmp_topo_seg()
Returns reference to hash. Key: Table entry, Value:Remote Segment ID

(s5EnMsTopNmmSegId)

$sonmp->sonmp_topo_mac
(s5EnMsTopNmmMacAddr)

Returns reference to hash. Key: Table entry, Value:Remote MAC address

$sonmp->sonmp_topo_platform
Returns reference to hash. Key: Table entry, Value:Remote Device Type

(s5EnMsTopNmmChassisType)

$sonmp->sonmp_topo_localseg
Returns reference to hash. Key: Table entry, Value:Boolean, if bay_topo_seg() is local

(s5EnMsTopNmmLocalSeg)

Psuedo CDP information

All entries with port=0 are local and ignored.

$sonmp->c_if()
Returns reference to hash. Key: ifIndex.1 Value: port (iid)

$sonmp->c_ip()
Returns referenece to hash. Key: ifIndex.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-SONMP 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 neighbors, is if there is a non-SONMP device in between two or more devices.

Use the data from the Layer2 Topology Table below to dig deeper.

$sonmp->c_port()
Returns reference to hash. Key: ifIndex.1 Value: remote port

$sonmp->c_platform()
Returns reference to hash. Key: ifIndex.1 Value: Remote Device Type