.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "SNMP::Info::AMAP 3pm"
.TH SNMP::Info::AMAP 3pm "2019-02-25" "perl v5.28.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
SNMP::Info::AMAP \- SNMP Interface to Alcatel Mapping Adjacency Protocol (AMAP)
.SH "AUTHOR"
.IX Header "AUTHOR"
Eric Miller
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 7
\& my $amap = new SNMP::Info (
\&                             AutoSpecify => 1,
\&                             Debug       => 1,
\&                             DestHost    => \*(Aqrouter\*(Aq,
\&                             Community   => \*(Aqpublic\*(Aq,
\&                             Version     => 2
\&                           );
\&
\& my $class = $amap\->class();
\& print " Using device sub class : $class\en";
\&
\& $hasamap   = $amap\->hasAMAP() ? \*(Aqyes\*(Aq : \*(Aqno\*(Aq;
\&
\& # Print out a map of device ports with LLDP 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\en";
\& }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
SNMP::Info::AMAP is a subclass of SNMP::Info that provides an object oriented
interface to Alcatel Mapping Adjacency Protocol (\s-1AMAP\s0) information through
\&\s-1SNMP.\s0
.PP
\&\s-1AMAP\s0 is a Layer 2 protocol that allows a network device to advertise its
identity and capabilities on the local network providing topology information.
.PP
Create or use a device subclass that inherits this class.  Do not use
directly.
.SS "Inherited Classes"
.IX Subsection "Inherited Classes"
None.
.SS "Required MIBs"
.IX Subsection "Required MIBs"
.IP "\fI\s-1ALCATEL\-IND1\-INTERSWITCH\-PROTOCOL\-MIB\s0\fR" 4
.IX Item "ALCATEL-IND1-INTERSWITCH-PROTOCOL-MIB"
.SH "GLOBAL METHODS"
.IX Header "GLOBAL METHODS"
These are methods that return scalar values from \s-1SNMP\s0
.ie n .IP "$amap\->\fBhasAMAP()\fR" 4
.el .IP "\f(CW$amap\fR\->\fBhasAMAP()\fR" 4
.IX Item "$amap->hasAMAP()"
Is \s-1AMAP\s0 is active in this device?
.SH "TABLE METHODS"
.IX Header "TABLE METHODS"
These are methods that return tables of information in the form of a reference
to a hash.
.ie n .IP "$amap\->\fBamap_id()\fR" 4
.el .IP "\f(CW$amap\fR\->\fBamap_id()\fR" 4
.IX Item "$amap->amap_id()"
Returns the string value used to identify the remote system.
.ie n .IP "$amap\->\fBamap_if()\fR" 4
.el .IP "\f(CW$amap\fR\->\fBamap_if()\fR" 4
.IX Item "$amap->amap_if()"
Returns the mapping to the \s-1SNMP\s0 Interface Table.
.ie n .IP "$amap\->\fBamap_ip()\fR" 4
.el .IP "\f(CW$amap\fR\->\fBamap_ip()\fR" 4
.IX Item "$amap->amap_ip()"
Returns remote IPv4 addresses.  Note: \s-1AMAP\s0 returns all \s-1IP\s0 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 \fBamap_ip()\fR 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.
.ie n .IP "$amap\->\fBamap_port()\fR" 4
.el .IP "\f(CW$amap\fR\->\fBamap_port()\fR" 4
.IX Item "$amap->amap_port()"
Returns remote port \s-1ID\s0
.ie n .IP "$amap\->\fBamap_platform()\fR" 4
.el .IP "\f(CW$amap\fR\->\fBamap_platform()\fR" 4
.IX Item "$amap->amap_platform()"
Returns remote platform \s-1ID\s0