plucky (3) SNMP::Info::AMAP.3pm.gz

Provided by: libsnmp-info-perl_3.972002-1_all bug

NAME

       SNMP::Info::AMAP - SNMP Interface to Alcatel Mapping Adjacency Protocol (AMAP)

AUTHOR

       Eric Miller

SYNOPSIS

        my $amap = new SNMP::Info (
                                    AutoSpecify => 1,
                                    Debug       => 1,
                                    DestHost    => 'router',
                                    Community   => 'public',
                                    Version     => 2
                                  );

        my $class = $amap->class();
        print " Using device sub class : $class\n";

        $hasamap   = $amap->hasAMAP() ? 'yes' : 'no';

        # Print out a map of device ports with AMAP neighbors:
        my $interfaces    = $amap->interfaces();
        my $amap_if       = $amap->amap_if();
        my $amap_ip       = $amap->amap_ip();
        my $amap_port     = $amap->amap_port();

        foreach my $amap_key (keys %$amap_ip){
           my $iid           = $amap_if->{$amap_key};
           my $port          = $interfaces->{$iid};
           my $neighbor      = $amap_ip->{$amap_key};
           my $neighbor_port = $amap_port->{$amap_key};
           print "Port : $port connected to $neighbor / $neighbor_port\n";
        }

DESCRIPTION

       SNMP::Info::AMAP is a subclass of SNMP::Info that provides an object oriented interface to Alcatel
       Mapping Adjacency Protocol (AMAP) information through SNMP.

       AMAP is a Layer 2 protocol that allows a network device to advertise its identity and capabilities on the
       local network providing topology information.

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

   Inherited Classes
       None.

   Required MIBs
       ALCATEL-IND1-INTERSWITCH-PROTOCOL-MIB

GLOBALS

       These are methods that return scalar values from SNMP

       $amap->hasAMAP()
           Is AMAP is active in this device?

TABLE METHODS

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

       $amap->amap_id()
           Returns the string value used to identify the remote system.

       $amap->amap_if()
           Returns the mapping to the SNMP Interface Table.

       $amap->amap_ip()
           Returns remote IPv4 addresses.  Note: AMAP returns all IP addresses associated with the remote
           device.  It would be preferable to include only one address since they should all originate from the
           same device, but amap_ip() can not determine if all addresses are reachable from the network
           management application therefore all addresses are returned and the calling application must
           determine which address to use and if they are in fact from the same device.

       $amap->amap_port()
           Returns remote port ID

       $amap->amap_platform()
           Returns remote platform ID