NAME

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

AUTHOR

       Eric Miller

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";

        $hassonmp   = $sonmp->hasSONMP() ? 'yes' : 'no';

        # Print out a map of device ports with CDP neighbors:
        my $interfaces = $sonmp->interfaces();
        my $sonmp_if       = $sonmp->sonmp_if();
        my $sonmp_ip       = $sonmp->sonmp_ip();
        my $sonmp_port     = $sonmp->sonmp_port();

        foreach my $sonmp_key (keys %$sonmp_ip){
           my $iid           = $sonmp_if->{$sonmp_key};
           my $port          = $interfaces->{$iid};
           my $neighbor      = $sonmp_ip->{$sonmp_key};
           my $neighbor_port = $sonmp_port->{$sonmp_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, Nortel, and
       Avaya devices.  SONMP has been rebranded by Bay then Nortel and may be referred to by
       several different names, including Nortel Discovery Protocol (NDP).

       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

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.

       $sonmp->hasSONMP()
           Is SONMP is active in this device?

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

           ("s5EnMsTopIpAddr")

       $sonmp->sonmp_run()
           Returns true if SONMP is on for this device.

           ("s5EnMsTopStatus")

       $sonmp->mac()
           Returns MAC of the advertised IP address of this 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")

   Layer2 Topology info ("s5EnMsTopNmmEnhancedTable")
       $sonmp->sonmp_topo_e_mac()
           ("s5EnMsTopNmmEnhancedMacAddr")

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

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

           ("s5EnMsTopNmmEnhancedChassisType")

   Common topology information
       All entries with port=0 are local and ignored.

       $sonmp->sonmp_if()
           Returns reference to hash.  Key: IID, Value: Local port (interfaces)

       $sonmp->sonmp_ip()
           Returns reference to hash.  Key: IID, Value: Remote IP address

           If multiple entries exist with the same local port, sonmp_if(), with different IPv4
           addresses, sonmp_ip(), there is either a non SONMP device in between two or more
           devices or multiple devices which are not directly connected.

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

       $sonmp->sonmp_port()
           Returns reference to hash. Key: IID, Value: Remote port (interfaces)

       $sonmp->sonmp_platform()
           Returns reference to hash. Key: IID, Value: Remote device type