.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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::CiscoBGP 3pm"
.TH SNMP::Info::CiscoBGP 3pm "2023-09-30" "perl v5.36.0" "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::CiscoBGP \- SNMP Interface to Cisco's BGP MIBs
.SH "AUTHOR"
.IX Header "AUTHOR"
Alexander Hartmaier
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
# Let SNMP::Info determine the correct subclass for you.
my \f(CW$device\fR = SNMP::Info\->(
    AutoSpecify => 1,
    Debug       => 1,
    DestHost    => 'myswitch',
    Community   => 'public',
    Version     => 2
) or die \*(L"Can't connect to DestHost.\en\*(R";
.PP
my \f(CW$remoteas_for_index\fR = \f(CW$device\fR\->cisco_bgp_peer2_remoteas;
.PP
for my \f(CW$index\fR (keys \f(CW$remoteas_for_index\fR\->%*) {
    my ($type, \f(CW$addrlength\fR, \f(CW$ip\fR) =
        \f(CW$device\fR\->parse_cisco_bgp_peer2_entry_index($index);
    printf('remote: %\-39s  type: %\-4s  remote \s-1AS:\s0 \f(CW%5d\fR',
        \f(CW$ip\fR, \f(CW$type\fR, \f(CW$remoteas_for_index\fR\->{$index});
}
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
SNMP::Info::CiscoBGP is a subclass of SNMP::Info that provides
information about a cisco device's \s-1BGP\s0 configuration and state.
.PP
Use or create in a subclass of SNMP::Info.  Do not use directly.
.SS "Inherited Classes"
.IX Subsection "Inherited Classes"
none.
.SS "Required MIBs"
.IX Subsection "Required MIBs"
.IP "\fI\s-1CISCO\-BGP4\-MIB\s0\fR" 4
.IX Item "CISCO-BGP4-MIB"
.SH "GLOBALS"
.IX Header "GLOBALS"
.RS 4
None
.RE
.SH "TABLE METHODS"
.IX Header "TABLE METHODS"
.SS "Cisco \s-1BGP\s0 Peer 2 Table (cbgpPeer2Table)"
.IX Subsection "Cisco BGP Peer 2 Table (cbgpPeer2Table)"
This table contains, one entry per \s-1BGP\s0 peer, information about the connections
with \s-1BGP\s0 peers.
.IP "cisco_bgp_peer2_state (cbgpPeer2State)" 4
.IX Item "cisco_bgp_peer2_state (cbgpPeer2State)"
.PD 0
.IP "cisco_bgp_peer2_adminstatus (cbgpPeer2AdminStatus)" 4
.IX Item "cisco_bgp_peer2_adminstatus (cbgpPeer2AdminStatus)"
.IP "cisco_bgp_peer2_localaddr (cbgpPeer2LocalAddr)" 4
.IX Item "cisco_bgp_peer2_localaddr (cbgpPeer2LocalAddr)"
.IP "cisco_bgp_peer2_localport (cbgpPeer2LocalPort)" 4
.IX Item "cisco_bgp_peer2_localport (cbgpPeer2LocalPort)"
.IP "cisco_bgp_peer2_localas (cbgpPeer2LocalAs)" 4
.IX Item "cisco_bgp_peer2_localas (cbgpPeer2LocalAs)"
.IP "cisco_bgp_peer2_localidentifier (cbgpPeer2LocalIdentifier)" 4
.IX Item "cisco_bgp_peer2_localidentifier (cbgpPeer2LocalIdentifier)"
.IP "cisco_bgp_peer2_remoteport (cbgpPeer2RemotePort)" 4
.IX Item "cisco_bgp_peer2_remoteport (cbgpPeer2RemotePort)"
.IP "cisco_bgp_peer2_remoteas (cbgpPeer2RemoteAs)" 4
.IX Item "cisco_bgp_peer2_remoteas (cbgpPeer2RemoteAs)"
.IP "cisco_bgp_peer2_remoteidentifier (cbgpPeer2RemoteIdentifier)" 4
.IX Item "cisco_bgp_peer2_remoteidentifier (cbgpPeer2RemoteIdentifier)"
.IP "cisco_bgp_peer2_inupdates (cbgpPeer2InUpdates)" 4
.IX Item "cisco_bgp_peer2_inupdates (cbgpPeer2InUpdates)"
.IP "cisco_bgp_peer2_outupdates (cbgpPeer2OutUpdates)" 4
.IX Item "cisco_bgp_peer2_outupdates (cbgpPeer2OutUpdates)"
.IP "cisco_bgp_peer2_intotalmessages (cbgpPeer2InTotalMessages)" 4
.IX Item "cisco_bgp_peer2_intotalmessages (cbgpPeer2InTotalMessages)"
.IP "cisco_bgp_peer2_outtotalmessages (cbgpPeer2OutTotalMessages)" 4
.IX Item "cisco_bgp_peer2_outtotalmessages (cbgpPeer2OutTotalMessages)"
.IP "cisco_bgp_peer2_lasterror (cbgpPeer2LastError)" 4
.IX Item "cisco_bgp_peer2_lasterror (cbgpPeer2LastError)"
.IP "cisco_bgp_peer2_fsmestablishedtransitions (cbgpPeer2FsmEstablishedTransitions)" 4
.IX Item "cisco_bgp_peer2_fsmestablishedtransitions (cbgpPeer2FsmEstablishedTransitions)"
.IP "cisco_bgp_peer2_fsmestablishedtime (cbgpPeer2FsmEstablishedTime)" 4
.IX Item "cisco_bgp_peer2_fsmestablishedtime (cbgpPeer2FsmEstablishedTime)"
.IP "cisco_bgp_peer2_connectretryinterval (cbgpPeer2ConnectRetryInterval)" 4
.IX Item "cisco_bgp_peer2_connectretryinterval (cbgpPeer2ConnectRetryInterval)"
.IP "cisco_bgp_peer2_holdtime (cbgpPeer2HoldTime)" 4
.IX Item "cisco_bgp_peer2_holdtime (cbgpPeer2HoldTime)"
.IP "cisco_bgp_peer2_keepalive (cbgpPeer2KeepAlive)" 4
.IX Item "cisco_bgp_peer2_keepalive (cbgpPeer2KeepAlive)"
.IP "cisco_bgp_peer2_holdtimeconfigured (cbgpPeer2HoldTimeConfigured)" 4
.IX Item "cisco_bgp_peer2_holdtimeconfigured (cbgpPeer2HoldTimeConfigured)"
.IP "cisco_bgp_peer2_keepaliveconfigured (cbgpPeer2KeepAliveConfigured)" 4
.IX Item "cisco_bgp_peer2_keepaliveconfigured (cbgpPeer2KeepAliveConfigured)"
.IP "cisco_bgp_peer2_minasoriginationinterval (cbgpPeer2MinASOriginationInterval)" 4
.IX Item "cisco_bgp_peer2_minasoriginationinterval (cbgpPeer2MinASOriginationInterval)"
.IP "cisco_bgp_peer2_inupdatelapsedtime (cbgpPeer2InUpdateElapsedTime)" 4
.IX Item "cisco_bgp_peer2_inupdatelapsedtime (cbgpPeer2InUpdateElapsedTime)"
.IP "cisco_bgp_peer2_lasterrortxt (cbgpPeer2LastErrorTxt)" 4
.IX Item "cisco_bgp_peer2_lasterrortxt (cbgpPeer2LastErrorTxt)"
.IP "cisco_bgp_peer2_prevstate (cbgpPeer2PrevState)" 4
.IX Item "cisco_bgp_peer2_prevstate (cbgpPeer2PrevState)"
.PD
.SS "Cisco \s-1BGP\s0 Peer 2 Address Family Prefix Table (cbgpPeer2AddrFamilyPrefixTable)"
.IX Subsection "Cisco BGP Peer 2 Address Family Prefix Table (cbgpPeer2AddrFamilyPrefixTable)"
This table contains prefix related information related to address families
supported by a peer.
.IP "cisco_bgp_peer2_acceptedprefixes (cbgpPeer2AcceptedPrefixes)" 4
.IX Item "cisco_bgp_peer2_acceptedprefixes (cbgpPeer2AcceptedPrefixes)"
.PD 0
.IP "cisco_bgp_peer2_deniedprefixes (cbgpPeer2DeniedPrefixes)" 4
.IX Item "cisco_bgp_peer2_deniedprefixes (cbgpPeer2DeniedPrefixes)"
.IP "cisco_bgp_peer2_prefixadminlimit (cbgpPeer2PrefixAdminLimit)" 4
.IX Item "cisco_bgp_peer2_prefixadminlimit (cbgpPeer2PrefixAdminLimit)"
.IP "cisco_bgp_peer2_prefixthreshold (cbgpPeer2PrefixThreshold)" 4
.IX Item "cisco_bgp_peer2_prefixthreshold (cbgpPeer2PrefixThreshold)"
.IP "cisco_bgp_peer2_prefixclearthreshold (cbgpPeer2PrefixClearThreshold)" 4
.IX Item "cisco_bgp_peer2_prefixclearthreshold (cbgpPeer2PrefixClearThreshold)"
.IP "cisco_bgp_peer2_advertisedprefixes (cbgpPeer2AdvertisedPrefixes)" 4
.IX Item "cisco_bgp_peer2_advertisedprefixes (cbgpPeer2AdvertisedPrefixes)"
.IP "cisco_bgp_peer2_suppressedprefixes (cbgpPeer2SuppressedPrefixes)" 4
.IX Item "cisco_bgp_peer2_suppressedprefixes (cbgpPeer2SuppressedPrefixes)"
.IP "cisco_bgp_peer2_withdrawnprefixes (cbgpPeer2WithdrawnPrefixes)" 4
.IX Item "cisco_bgp_peer2_withdrawnprefixes (cbgpPeer2WithdrawnPrefixes)"
.PD
.SS "\s-1METHODS\s0"
.IX Subsection "METHODS"
.IP "parse_cisco_bgp_peer2_entry_index" 4
.IX Item "parse_cisco_bgp_peer2_entry_index"
Takes a cbgpPeer2Entry index as returned by all methods of the Cisco \s-1BGP\s0 Peer
2 Table methods.
.Sp
Returns a list of type (numeric, cbgpPeer2Type), address length (in bytes:
4 for IPv4, 16 for IPv6) and the remote \s-1IP\s0 address as string.