Class CIM_BGPProtocolEndpoint
extends CIM_ProtocolEndpoint

A ProtocolEndpoint that is dedicated to running BGP.

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_ServiceAccessPoint
   |
   +--CIM_ProtocolEndpoint
   |
   +--CIM_BGPProtocolEndpoint

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringA ProtocolEndpoint that is dedicated to running BGP.
UMLPackagePathstringCIM::Network::ProtocolEndpoints
Versionstring2.8.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
AdminStatusuint16
DeprecatedstringCIM_EnabledLogicalElement.RequestedState
DescriptionstringThis defines the desired state of the BGP connection. It is equivalent to the RequestedState property (i.e., enabled/disabled status) that is inherited from EnabledLogicalElement. AdminStatus is deprecated in lieu of this inherited property.
MappingStringsstringMIB.IETF|BGP4-MIB.bgpPeerAdminStatus
ValueMapstring1, 2
ValuesstringStop, Start
ConnectRetryIntervaluint32120
DescriptionstringThis defines the time interval, in seconds, for the ConnectRetry timer. The suggested value is 120 seconds.
MappingStringsstringMIB.IETF|BGP4-MIB.bgpConnectRetryInterval
UnitsstringSeconds
HoldTimeuint16
DescriptionstringThis defines the maximum amount of time in seconds that may elapse between the receipt of successive KEEPALIVE or UPDATE messages. This is instrumented as a counter that increments from zero to the value specified in this property. The value of this property is calculated by the BGP speaker by using the smaller of the values of bgpPeerHoldTimeConfigured and the Hold Time received in the OPEN message. This value, if not zero seconds, must be at least three seconds, up to a maximum of 65535 seconds. Receipt of either a KEEPALIVE or an UPDATE message resets this value.
MappingStringsstringMIB.IETF|BGP4-MIB.bgpPeerHoldTime
UnitsstringSeconds
HoldTimeConfigureduint1690
DescriptionstringThis defines the time interval in seconds for the Hold Time configured for this BGP speaker with a peer. This value is placed in an OPEN message sent to a peer by this BGP speaker, and is compared with the Hold Time field in the OPEN message received from the peer. It enables this speaker to establish a mutually agreeable Hold Time with the peer. This value must not be less than three seconds. If it is zero, then the Hold Time is NOT to be established with the peer. The suggested value for this timer is 90 seconds.
MappingStringsstringMIB.IETF|BGP4-MIB.bgpPeerHoldTimeConfigured
UnitsstringSeconds
IsEBGPboolean
DescriptionstringA boolean that, when TRUE, signifies that this is an instance of the external version of BGP (FALSE is the internal version).
IsEBGPMultihopboolean
DescriptionstringNormally, two routers running EBGP must be physically connected. This boolean, when TRUE, denotes a LOGICAL connection between two routers that are running EBGP (e.g., there is an intermediate router or interface between them).
KeepAliveuint16
DescriptionstringThis defines the time interval in seconds for the KeepAlive timer established with the peer. The value of this property is calculated by the speaker such that, when compared with the HoldTime property, it has the same proportion as the KeepAliveConfigured property has with the HoldTimeConfigured property. A value of 0 indicates that the KeepAlive timer has not yet been established. The maximum value of this property is 21845 seconds.
MappingStringsstringMIB.IETF|BGP4-MIB.bgpPeerKeepAlive
UnitsstringSeconds
KeepAliveConfigureduint1630
DescriptionstringThis defines the time interval in seconds for the KeepAlive timer configured for this BGP speaker with a peer. This value will determine the frequency of the KEEPALIVE messages relative to the value of the HoldTimeConfigured property; the actual frequency is specified by the value of the KeepAlive property. A reasonable value is one third of that of the value of the HoldTimeConfigured property. If it is zero, then NO periodic KEEPALIVE messages are sent to the peer. The suggested value for this property is 30 seconds. The maximum value of this property is 21845 seconds.
MappingStringsstringMIB.IETF|BGP4-MIB.bgpPeerKeepAliveConfigured
UnitsstringSeconds
LocalAddressstring
DeprecatedstringCIM_BindsTo, CIM_IPProtocolEndpoint
DescriptionstringThis is the local IP address of this router's BGP connection. It is deprecated since a binding should be defined using the CIM_BindsTo association. Ideally the binding is to a TCPProtocolEndpoint which then handles the association to its IPEndpoint.
MappingStringsstringMIB.IETF|BGP4-MIB.bgpPeerLocalAddr
LocalIdentifierstring
DescriptionstringThis is the unique identifier of the local BGP router. This is often the router ID (e.g., an IP address).
MappingStringsstringMIB.IETF|BGP4-MIB.bgpIdentifier
LocalPortuint16
DeprecatedstringCIM_BindsTo, CIM_TCPProtocolEndpoint
DescriptionstringThis is the local port number for the TCP connection of this router's BGP connection. It is deprecated since a binding should be defined (to a TCPProtocolEndpoint) using the CIM_BindsTo association.
MappingStringsstringMIB.IETF|BGP4-MIB.bgpPeerLocalPort
MinASOriginationIntervaluint1615
DescriptionstringThis defines the time interval in seconds for the MinASOriginationInterval timer. The suggested value for this property is 15 seconds.
MappingStringsstringMIB.IETF|BGP4-MIB.bgpPeerMinASOriginationInterval
UnitsstringSeconds
MinRouteAdvertisementIntervaluint1630
DescriptionstringThis defines the time interval in seconds for the MinRouteAdvertisementInterval timer. The suggested value for this property is 30 seconds.
MappingStringsstringMIB.IETF|BGP4-MIB.bgpPeerMinRouteAdvertisementInterval
UnitsstringSeconds
NegotiatedVersionstring
DescriptionstringThis defines the negotiated version of BGP that is running between the two peers.
MappingStringsstringMIB.IETF|BGP4-MIB.bgpPeerNegotiatedVersion
PeerIdentifierstring
DescriptionstringThis is the unique identifier of the peer BGP router. This is often the router ID (e.g., an IP address).
MappingStringsstringMIB.IETF|BGP4-MIB.bgpPeerIdentifier
ProtocolIFTypeuint164108
DescriptionstringProtocolIFType's enumeration is limited to BGP and reserved values for this subclass of ProtocolEndpoint.
MappingStringsstringMIB.IETF|IF-MIB.ifType
ModelCorrespondencestringCIM_ProtocolEndpoint.OtherTypeDescription
OverridestringProtocolIFType
ValueMapstring1, 225..4095, 4108, 4301..32767, 32768..
ValuesstringOther, IANA Reserved, BGP, DMTF Reserved, Vendor Reserved
RemoteAddressstring
DeprecatedstringCIM_BindsTo, CIM_RemoteServiceAccessPoint
DescriptionstringThis is the remote IP address of this router's BGP connection. It is deprecated since a binding to a Remote ServiceAccessPoint should be instantiated, using CIM_BindsTo.
MappingStringsstringMIB.IETF|BGP4-MIB.bgpPeerRemoteAddr
RemoteASuint16
DescriptionstringThis is the remote AS number for this router's BGP connection.
MappingStringsstringMIB.IETF|BGP4-MIB.bgpPeerRemoteAs
RemotePortuint16
DeprecatedstringCIM_BindsTo, CIM_RemotePort
DescriptionstringThis is the remote port number for the TCP connection of this router's BGP connection. It is deprecated since a binding to a RemotePort should be instantiated, using CIM_BindsTo.
MappingStringsstringMIB.IETF|BGP4-MIB.bgpPeerRemotePort
Stateuint16
DescriptionstringThis defines the current connection state of the BGP Peer.
MappingStringsstringMIB.IETF|BGP4-MIB.bgpPeerState
ValueMapstring1, 2, 3, 4, 5, 6
ValuesstringIdle, Connect, Active, OpenSet, OpenConfirm, Established

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_ServiceAccessPoint
DescriptionstringCIM_ProtocolEndpoint
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_ProtocolEndpoint
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
NamestringCIM_ProtocolEndpoint
NameFormatstringCIM_ProtocolEndpoint
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
OtherTypeDescriptionstringCIM_ProtocolEndpoint
PrimaryStatusuint16CIM_ManagedSystemElement
ProtocolTypeuint16CIM_ProtocolEndpoint
RequestedStateuint16CIM_EnabledLogicalElement
StatusstringCIM_ManagedSystemElement
SystemCreationClassNamestringCIM_ServiceAccessPoint
SystemNamestringCIM_ServiceAccessPoint
TimeOfLastStateChangedatetimeCIM_ProtocolEndpoint
TransitioningToStateuint16CIM_EnabledLogicalElement
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
OperationalStatusuint16[]CIM_ProtocolEndpoint
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Inherited Class Methods

NameReturn TypeClass Origin
RequestStateChangeuint32CIM_EnabledLogicalElement