Connected: An Internet Encyclopedia
RFC 1657 - BGP Peer Table

Top: Connected: An Internet Encyclopedia
Up: Requests For Comments
Up: RFC 1657
Up: 5. Definitions
Prev: 5. Definitions
Next: Received Path Attribute Table

### BGP Peer Table

                    bgpPeerEntry OBJECT-TYPE
                        SYNTAX     BgpPeerEntry
                        MAX-ACCESS not-accessible
                        STATUS     current
                        DESCRIPTION
                                "Entry containing information about the
                                connection with a BGP peer."
                        INDEX { bgpPeerRemoteAddr }
                        ::= { bgpPeerTable 1 }

                    BgpPeerEntry ::= SEQUENCE {
                            bgpPeerIdentifier
                                IpAddress,
                            bgpPeerState
                                INTEGER,
                            bgpPeerAdminStatus
                                INTEGER,
                            bgpPeerNegotiatedVersion
                                Integer32,
                            bgpPeerLocalAddr
                                IpAddress,
                            bgpPeerLocalPort
                                INTEGER,
                            bgpPeerRemoteAddr
                                IpAddress,
                            bgpPeerRemotePort
                                INTEGER,
                            bgpPeerRemoteAs
                                INTEGER,
                            bgpPeerInUpdates
                                Counter32,
                            bgpPeerOutUpdates
                                Counter32,
                            bgpPeerInTotalMessages
                                Counter32,
                            bgpPeerOutTotalMessages
                                Counter32,
                            bgpPeerLastError
                                OCTET STRING,
                            bgpPeerFsmEstablishedTransitions
                                Counter32,
                            bgpPeerFsmEstablishedTime
                                Gauge32,
                            bgpPeerConnectRetryInterval
                                INTEGER,
                            bgpPeerHoldTime
                                INTEGER,
                            bgpPeerKeepAlive
                                INTEGER,
                            bgpPeerHoldTimeConfigured
                                INTEGER,
                            bgpPeerKeepAliveConfigured
                                INTEGER,
                            bgpPeerMinASOriginationInterval
                                INTEGER,
                            bgpPeerMinRouteAdvertisementInterval
                                INTEGER,
                            bgpPeerInUpdateElapsedTime
                                Gauge32
                            }

                    bgpPeerIdentifier OBJECT-TYPE
                        SYNTAX     IpAddress
                        MAX-ACCESS read-only
                        STATUS     current
                        DESCRIPTION
                                "The BGP Identifier of this entry's BGP
                                peer."
                        ::= { bgpPeerEntry 1 }

                    bgpPeerState OBJECT-TYPE
                        SYNTAX     INTEGER {
                                            idle(1),
                                            connect(2),
                                            active(3),
                                            opensent(4),
                                            openconfirm(5),
                                            established(6)
                                   }
                        MAX-ACCESS read-only
                        STATUS     current
                        DESCRIPTION
                                "The BGP peer connection state."
                        ::= { bgpPeerEntry 2 }

                    bgpPeerAdminStatus OBJECT-TYPE
                        SYNTAX     INTEGER {
                                            stop(1),
                                            start(2)
                                   }
                        MAX-ACCESS read-write
                        STATUS     current
                        DESCRIPTION
                                "The desired state of the BGP connection.
                                A transition from 'stop' to 'start' will
                                cause the BGP Start Event to be generated.
                                A transition from 'start' to 'stop' will
                                cause the BGP Stop Event to be generated.
                                This parameter can be used to restart BGP
                                peer connections.  Care should be used in
                                providing write access to this object
                                without adequate authentication."
                        ::= { bgpPeerEntry 3 }

                    bgpPeerNegotiatedVersion OBJECT-TYPE
                        SYNTAX     Integer32
                        MAX-ACCESS read-only
                        STATUS     current
                        DESCRIPTION
                                "The negotiated version of BGP running
                                between the two peers."
                        ::= { bgpPeerEntry 4 }

                    bgpPeerLocalAddr OBJECT-TYPE
                        SYNTAX     IpAddress
                        MAX-ACCESS read-only
                        STATUS     current
                        DESCRIPTION
                                "The local IP address of this entry's BGP
                                connection."
                        ::= { bgpPeerEntry 5 }

                    bgpPeerLocalPort OBJECT-TYPE
                        SYNTAX     INTEGER (0..65535)
                        MAX-ACCESS read-only
                        STATUS     current
                        DESCRIPTION
                                "The local port for the TCP connection
                                between the BGP peers."
                        ::= { bgpPeerEntry 6 }

                    bgpPeerRemoteAddr OBJECT-TYPE
                        SYNTAX     IpAddress
                        MAX-ACCESS read-only
                        STATUS     current
                        DESCRIPTION
                                "The remote IP address of this entry's BGP
                                peer."
                        ::= { bgpPeerEntry 7 }

                    bgpPeerRemotePort OBJECT-TYPE
                        SYNTAX     INTEGER (0..65535)
                        MAX-ACCESS read-only
                        STATUS     current
                        DESCRIPTION
                                "The remote port for the TCP connection
                                between the BGP peers.  Note that the
                                objects bgpPeerLocalAddr,
                                bgpPeerLocalPort, bgpPeerRemoteAddr and
                                bgpPeerRemotePort provide the appropriate
                                reference to the standard MIB TCP
                                connection table."
                        ::= { bgpPeerEntry 8 }

                    bgpPeerRemoteAs OBJECT-TYPE
                        SYNTAX     INTEGER (0..65535)
                        MAX-ACCESS read-only
                        STATUS     current
                        DESCRIPTION
                                "The remote autonomous system number."
                        ::= { bgpPeerEntry 9 }

                    bgpPeerInUpdates OBJECT-TYPE
                        SYNTAX     Counter32
                        MAX-ACCESS read-only
                        STATUS     current
                        DESCRIPTION
                                "The number of BGP UPDATE messages
                                received on this connection.  This object
                                should be initialized to zero (0) when the
                                connection is established."
                        ::= { bgpPeerEntry 10 }

                    bgpPeerOutUpdates OBJECT-TYPE
                        SYNTAX     Counter32
                        MAX-ACCESS read-only
                        STATUS     current
                        DESCRIPTION
                                "The number of BGP UPDATE messages
                                transmitted on this connection.  This
                                object should be initialized to zero (0)
                                when the connection is established."
                        ::= { bgpPeerEntry 11 }

                    bgpPeerInTotalMessages OBJECT-TYPE
                        SYNTAX     Counter32
                        MAX-ACCESS read-only
                        STATUS     current
                        DESCRIPTION
                                "The total number of messages received
                                from the remote peer on this connection.
                                This object should be initialized to zero
                                when the connection is established."
                        ::= { bgpPeerEntry 12 }

                    bgpPeerOutTotalMessages OBJECT-TYPE
                        SYNTAX     Counter32
                        MAX-ACCESS read-only
                        STATUS     current
                        DESCRIPTION
                                "The total number of messages transmitted to
                                the remote peer on this connection.  This
                                object should be initialized to zero when
                                the connection is established."
                        ::= { bgpPeerEntry 13 }

                    bgpPeerLastError OBJECT-TYPE
                        SYNTAX     OCTET STRING (SIZE (2))
                        MAX-ACCESS read-only
                        STATUS     current
                        DESCRIPTION
                                "The last error code and subcode seen by this
                                peer on this connection.  If no error has
                                occurred, this field is zero.  Otherwise, the
                                first byte of this two byte OCTET STRING
                                contains the error code, and the second byte
                                contains the subcode."
                        ::= { bgpPeerEntry 14 }

                    bgpPeerFsmEstablishedTransitions OBJECT-TYPE
                        SYNTAX     Counter32
                        MAX-ACCESS read-only
                        STATUS     current
                        DESCRIPTION
                                "The total number of times the BGP FSM
                                transitioned into the established state."
                        ::= { bgpPeerEntry 15 }

                    bgpPeerFsmEstablishedTime OBJECT-TYPE
                        SYNTAX     Gauge32
                        MAX-ACCESS read-only
                        STATUS     current
                        DESCRIPTION
                                "This timer indicates how long (in
                                seconds) this peer has been in the
                                Established state or how long
                                since this peer was last in the
                                Established state.  It is set to zero when
                                a new peer is configured or the router is
                                booted."
                        ::= { bgpPeerEntry 16 }

                    bgpPeerConnectRetryInterval OBJECT-TYPE
                        SYNTAX     INTEGER (1..65535)
                        MAX-ACCESS read-write
                        STATUS     current
                        DESCRIPTION
                                "Time interval in seconds for the
                                ConnectRetry timer.  The suggested value
                                for this timer is 120 seconds."
                        ::= { bgpPeerEntry 17 }

                    bgpPeerHoldTime OBJECT-TYPE
                        SYNTAX     INTEGER  ( 0 | 3..65535 )
                        MAX-ACCESS read-only
                        STATUS     current
                        DESCRIPTION
                                "Time interval in seconds for the Hold
                                Timer established with the peer.  The
                                value of this object is calculated by this
                                BGP speaker by using the smaller of the
                                value in bgpPeerHoldTimeConfigured and the
                                Hold Time received in the OPEN message.
                                This value must be at lease three seconds
                                if it is not zero (0) in which case the
                                Hold Timer has not been established with
                                the peer, or, the value of
                                bgpPeerHoldTimeConfigured is zero (0)."
                        ::= { bgpPeerEntry 18 }

                    bgpPeerKeepAlive OBJECT-TYPE
                        SYNTAX     INTEGER ( 0 | 1..21845 )
                        MAX-ACCESS read-only
                        STATUS     current
                        DESCRIPTION
                                "Time interval in seconds for the KeepAlive
                                timer established with the peer.  The value
                                of this object is calculated by this BGP
                                speaker such that, when compared with
                                bgpPeerHoldTime, it has the same
                                proportion as what
                                bgpPeerKeepAliveConfigured has when
                                compared with bgpPeerHoldTimeConfigured.
                                If the value of this object is zero (0),
                                it indicates that the KeepAlive timer has
                                not been established with the peer, or,
                                the value of bgpPeerKeepAliveConfigured is
                                zero (0)."
                        ::= { bgpPeerEntry 19 }

                    bgpPeerHoldTimeConfigured OBJECT-TYPE
                        SYNTAX     INTEGER ( 0 | 3..65535 )
                        MAX-ACCESS read-write
                        STATUS     current
                        DESCRIPTION
                                "Time interval in seconds for the Hold Time
                                configured for this BGP speaker with this
                                peer.  This value is placed in an OPEN
                                message sent to this peer by this BGP
                                speaker, and is compared with the Hold
                                Time field in an OPEN message received
                                from the peer when determining the Hold
                                Time (bgpPeerHoldTime) with the peer.
                                This value must not be less than three
                                seconds if it is not zero (0) in which
                                case the Hold Time is NOT to be
                                established with the peer.  The suggested
                                value for this timer is 90 seconds."
                        ::= { bgpPeerEntry 20 }

                    bgpPeerKeepAliveConfigured OBJECT-TYPE
                        SYNTAX     INTEGER ( 0 | 1..21845 )
                        MAX-ACCESS read-write
                        STATUS     current
                        DESCRIPTION
                                "Time interval in seconds for the
                                KeepAlive timer configured for this BGP
                                speaker with this peer.  The value of this
                                object will only determine the
                                KEEPALIVE messages' frequency relative to
                                the value specified in
                                bgpPeerHoldTimeConfigured; the actual
                                time interval for the KEEPALIVE messages
                                is indicated by bgpPeerKeepAlive.  A
                                reasonable maximum value for this timer
                                would be configured to be one
                                third of that of
                                bgpPeerHoldTimeConfigured.
                                If the value of this object is zero (0),
                                no periodical KEEPALIVE messages are sent
                                to the peer after the BGP connection has
                                been established.  The suggested value for
                                this timer is 30 seconds."
                        ::= { bgpPeerEntry 21 }

                    bgpPeerMinASOriginationInterval OBJECT-TYPE
                        SYNTAX     INTEGER (1..65535)
                        MAX-ACCESS read-write
                        STATUS     current
                        DESCRIPTION
                                "Time interval in seconds for the
                                MinASOriginationInterval timer.
                                The suggested value for this timer is 15
                                seconds."
                        ::= { bgpPeerEntry 22 }

                    bgpPeerMinRouteAdvertisementInterval OBJECT-TYPE
                        SYNTAX     INTEGER (1..65535)
                        MAX-ACCESS read-write
                        STATUS     current
                        DESCRIPTION
                                "Time interval in seconds for the
                                MinRouteAdvertisementInterval timer.
                                The suggested value for this timer is 30
                                seconds."
                        ::= { bgpPeerEntry 23 }

                    bgpPeerInUpdateElapsedTime OBJECT-TYPE
                        SYNTAX     Gauge32
                        MAX-ACCESS read-only
                        STATUS     current
                        DESCRIPTION
                                "Elapsed time in seconds since the last BGP
                                UPDATE message was received from the peer.
                                Each time bgpPeerInUpdates is incremented,
                                the value of this object is set to zero
                                (0)."
                        ::= { bgpPeerEntry 24 }

Next: Received Path Attribute Table

Connected: An Internet Encyclopedia
RFC 1657 - BGP Peer Table