Request for Comments: 4273 S. Hares, Ed.
Obsoletes: 1269, 1657 NextHop Technologies
Category: Standards Track January 2006
Definitions of Managed Objects for BGP-4
Status of This Memo
This document specifies an Internet standards track protocol for the
Internet community, and requests discussion and suggestions for
improvements. Please refer to the current edition of the "Internet
Official Protocol Standards" (STD 1) for the standardization state
and status of this protocol. Distribution of this memo is unlimited.
Copyright Notice
Copyright (C) The Internet Society (2006).
Abstract
This memo defines a portion of the Management Information Base (MIB)
for use with network management protocols in the Internet community
In particular, it describes managed objects used for managing the
Border Gateway Protocol Version 4 or lower.
The origin of this memo is from RFC 1269 "Definitions of Managed
Objects for the Border Gateway Protocol (Version 3)", which was
updated to support BGP-4 in RFC 1657. This memo fixes errors
introduced when the MIB module was converted to use the SMIv2
language. This memo also updates references to the current SNMP
framework documents.
This memo is intended to document deployed implementations of this
MIB module in a historical context, to provide clarifications of some
items, and to note errors where the MIB module fails to fully
represent the BGP protocol. Work is currently in progress to replace
this MIB module with a new one representing the current state of the
BGP protocol and its extensions.
This document obsoletes RFC 1269 and RFC 1657.
Table of Contents
1. Introduction ....................................................2
2. The Internet-Standard Management Framework ......................2
3. Overview ........................................................2
4. Definitions .....................................................3
5. Security Considerations ........................................28
6. Acknowledgements ...............................................30
7. Normative References ...........................................31
1. Introduction
This memo defines a portion of the Management Information Base (MIB)
for use with network management protocols in the Internet community.
In particular, it describes managed objects used for managing the
Border Gateway Protocol Version 4 or lower [BGP4, BGP4APP].
This memo obsoletes RFC 1657 and RFC 1269.
2. The Internet-Standard Management Framework
For a detailed overview of the documents that describe the current
Internet-Standard Management Framework, please refer to section 7 of
RFC 3410 [RFC3410].
Managed objects are accessed via a virtual information store, termed
the Management Information Base or MIB. MIB objects are generally
accessed through the Simple Network Management Protocol (SNMP).
Objects in the MIB are defined using the mechanisms defined in the
Structure of Management Information (SMI). This memo specifies a MIB
module that is compliant to the SMIv2, which is described in STD 58,
RFC 2578 [RFC2578], STD 58, RFC 2579 [RFC2579] and STD 58, RFC 2580
[RFC2580].
3. Overview
These objects are used to control and manage a BGP-4 implementation.
Apart from a few system-wide scalar objects, this MIB is broken into
three tables: the BGP Peer Table, the BGP Received Path Attribute
Table, and the BGP-4 Received Path Attribute Table. The BGP Peer
Table contains information about state and current activity of
connections with the BGP peers. The BGP Received Path Attribute
Table contains path attributes received from all peers running BGP
version 3 or less. The BGP-4 Received Path Attribute Table contains
path attributes received from all BGP-4 peers. The actual attributes
used in determining a route are a subset of the received attribute
tables after local routing policy has been applied.
4. Definitions
BGP4-MIB DEFINITIONS ::= BEGIN
IMPORTS
MODULE-IDENTITY, OBJECT-TYPE, NOTIFICATION-TYPE,
IpAddress, Integer32, Counter32, Gauge32, mib-2
FROM SNMPv2-SMI
MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP
FROM SNMPv2-CONF;
bgp MODULE-IDENTITY
LAST-UPDATED "200601110000Z"
ORGANIZATION "IETF IDR Working Group"
CONTACT-INFO "E-mail: idr@ietf.org
Jeffrey Haas, Susan Hares (Editors)
NextHop Technologies
825 Victors Way
Suite 100
Ann Arbor, MI 48108-2738
Tel: +1 734 222-1600
Fax: +1 734 222-1602
E-mail: jhaas@nexthop.com
skh@nexthop.com"
DESCRIPTION
"The MIB module for the BGP-4 protocol.
Copyright (C) The Internet Society (2006). This
version of this MIB module is part of RFC 4273;
see the RFC itself for full legal notices."
REVISION "200601110000Z"
DESCRIPTION
"Changes from RFC 1657:
1) Fixed the definitions of the notifications
to make them equivalent to their initial
definition in RFC 1269.
2) Added compliance and conformance info.
3) Updated information for the values of
bgpPeerNegotiatedVersion, bgp4PathAttrLocalPref,
bgp4PathAttrCalcLocalPref,
bgp4PathAttrMultiExitDisc,
bgp4PathAttrASPathSegement.
4) Added additional clarification comments where
needed.
5) Noted where objects do not fully reflect
the protocol as Known Issues.
6) Updated the DESCRIPTION for the
bgp4PathAttrAtomicAggregate object.
7) The following objects have had their DESCRIPTION
clause modified to remove the text that suggested
(using ’should’ verb) initializing the counter
to zero on a transition to the established state:
bgpPeerInUpdates, bgpPeerOutUpdates,
bgpPeerInTotalMessages, bgpPeerOutTotalMessages
Those implementations that still do this are
still compliant with this new wording.
Applications should not assume counters have
started at zero.
Published as RFC 4273."
REVISION "199405050000Z"
DESCRIPTION
"Translated to SMIv2 and published as RFC 1657."
REVISION "199110261839Z"
DESCRIPTION
"Initial version, published as RFC 1269."
::= { mib-2 15 }
bgpVersion OBJECT-TYPE
SYNTAX OCTET STRING (SIZE (1..255))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Vector of supported BGP protocol version
numbers. Each peer negotiates the version
from this vector. Versions are identified
via the string of bits contained within this
object. The first octet contains bits 0 to
7, the second octet contains bits 8 to 15,
and so on, with the most significant bit
referring to the lowest bit number in the
octet (e.g., the MSB of the first octet
refers to bit 0). If a bit, i, is present
and set, then the version (i+1) of the BGP
is supported."
REFERENCE
"RFC 4271, Section 4.2."
::= { bgp 1 }
bgpLocalAs OBJECT-TYPE
SYNTAX Integer32 (0..65535)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The local autonomous system number."
REFERENCE
"RFC 4271, Section 4.2, ’My Autonomous System’."
::= { bgp 2 }
-- BGP Peer table. This table contains, one entry per
-- BGP peer, information about the BGP peer.
bgpPeerTable OBJECT-TYPE
SYNTAX SEQUENCE OF BgpPeerEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"BGP peer table. This table contains,
one entry per BGP peer, information about the
connections with BGP peers."
::= { bgp 3 }
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
Integer32,
bgpPeerRemoteAddr
IpAddress,
bgpPeerRemotePort
Integer32,
bgpPeerRemoteAs
Integer32,
bgpPeerInUpdates
Counter32,
bgpPeerOutUpdates
Counter32,
bgpPeerInTotalMessages
Counter32,
bgpPeerOutTotalMessages
Counter32,
bgpPeerLastError
OCTET STRING,
bgpPeerFsmEstablishedTransitions
Counter32,
bgpPeerFsmEstablishedTime
Gauge32,
bgpPeerConnectRetryInterval
Integer32,
bgpPeerHoldTime
Integer32,
bgpPeerKeepAlive
Integer32,
bgpPeerHoldTimeConfigured
Integer32,
bgpPeerKeepAliveConfigured
Integer32,
bgpPeerMinASOriginationInterval
Integer32,
bgpPeerMinRouteAdvertisementInterval
Integer32,
bgpPeerInUpdateElapsedTime
Gauge32
}
bgpPeerIdentifier OBJECT-TYPE
SYNTAX IpAddress
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The BGP Identifier of this entry’s BGP peer.
This entry MUST be 0.0.0.0 unless the
bgpPeerState is in the openconfirm or the
established state."
REFERENCE
"RFC 4271, Section 4.2, ’BGP Identifier’."
::= { 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."
REFERENCE
"RFC 4271, Section 8.2.2."
::= { 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 Manual Start Event to be generated.
A transition from ’start’ to ’stop’ will cause
the BGP Manual 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."
REFERENCE
"RFC 4271, Section 8.1.2."
::= { bgpPeerEntry 3 }
bgpPeerNegotiatedVersion OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The negotiated version of BGP running between
the two peers.
This entry MUST be zero (0) unless the
bgpPeerState is in the openconfirm or the
established state.
Note that legal values for this object are
between 0 and 255."
REFERENCE
"RFC 4271, Section 4.2.
RFC 4271, Section 7."
::= { 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 Integer32 (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 Integer32 (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 Integer32 (0..65535)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The remote autonomous system number received in
the BGP OPEN message."
REFERENCE
"RFC 4271, Section 4.2."
::= { bgpPeerEntry 9 }
bgpPeerInUpdates OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of BGP UPDATE messages
received on this connection."
REFERENCE
"RFC 4271, Section 4.3."
::= { bgpPeerEntry 10 }
bgpPeerOutUpdates OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of BGP UPDATE messages
transmitted on this connection."
REFERENCE
"RFC 4271, Section 4.3."
::= { bgpPeerEntry 11 }
bgpPeerInTotalMessages OBJECT-TYPE
SYNTAX Counter32