# 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

Name | Data Type | Value
--- | --- | ---
Description | string | A ProtocolEndpoint that is dedicated to running BGP.
UMLPackagePath | string | CIM::Network::ProtocolEndpoints
Version | string | 2.8.0

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
AdminStatus | uint16 |
Deprecated | string | CIM_EnabledLogicalElement.RequestedState
Description | string | This 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.
MappingStrings | string | MIB.IETF|BGP4-MIB.bgpPeerAdminStatus
ValueMap | string | 1, 2
Values | string | Stop, Start
ConnectRetryInterval | uint32 | 120
Description | string | This defines the time interval, in seconds, for the ConnectRetry timer. The suggested value is 120 seconds.
MappingStrings | string | MIB.IETF|BGP4-MIB.bgpConnectRetryInterval
Units | string | Seconds
HoldTime | uint16 |
Description | string | This 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.
MappingStrings | string | MIB.IETF|BGP4-MIB.bgpPeerHoldTime
Units | string | Seconds
HoldTimeConfigured | uint16 | 90
Description | string | This 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.
MappingStrings | string | MIB.IETF|BGP4-MIB.bgpPeerHoldTimeConfigured
Units | string | Seconds
IsEBGP | boolean |
Description | string | A boolean that, when TRUE, signifies that this is an instance of the external version of BGP (FALSE is the internal version).
IsEBGPMultihop | boolean |
Description | string | Normally, 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).
KeepAlive | uint16 |
Description | string | This 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.
MappingStrings | string | MIB.IETF|BGP4-MIB.bgpPeerKeepAlive
Units | string | Seconds
KeepAliveConfigured | uint16 | 30
Description | string | This 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.
MappingStrings | string | MIB.IETF|BGP4-MIB.bgpPeerKeepAliveConfigured
Units | string | Seconds
LocalAddress | string |
Deprecated | string | CIM_BindsTo, CIM_IPProtocolEndpoint
Description | string | This 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.
MappingStrings | string | MIB.IETF|BGP4-MIB.bgpPeerLocalAddr
LocalIdentifier | string |
Description | string | This is the unique identifier of the local BGP router. This is often the router ID (e.g., an IP address).
MappingStrings | string | MIB.IETF|BGP4-MIB.bgpIdentifier
LocalPort | uint16 |
Deprecated | string | CIM_BindsTo, CIM_TCPProtocolEndpoint
Description | string | This 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.
MappingStrings | string | MIB.IETF|BGP4-MIB.bgpPeerLocalPort
MinASOriginationInterval | uint16 | 15
Description | string | This defines the time interval in seconds for the MinASOriginationInterval timer. The suggested value for this property is 15 seconds.
MappingStrings | string | MIB.IETF|BGP4-MIB.bgpPeerMinASOriginationInterval
Units | string | Seconds
MinRouteAdvertisementInterval | uint16 | 30
Description | string | This defines the time interval in seconds for the MinRouteAdvertisementInterval timer. The suggested value for this property is 30 seconds.
MappingStrings | string | MIB.IETF|BGP4-MIB.bgpPeerMinRouteAdvertisementInterval
Units | string | Seconds
NegotiatedVersion | string |
Description | string | This defines the negotiated version of BGP that is running between the two peers.
MappingStrings | string | MIB.IETF|BGP4-MIB.bgpPeerNegotiatedVersion
PeerIdentifier | string |
Description | string | This is the unique identifier of the peer BGP router. This is often the router ID (e.g., an IP address).
MappingStrings | string | MIB.IETF|BGP4-MIB.bgpPeerIdentifier
ProtocolIFType | uint16 | 4108
Description | string | ProtocolIFType's enumeration is limited to BGP and reserved values for this subclass of ProtocolEndpoint.
MappingStrings | string | MIB.IETF|IF-MIB.ifType
ModelCorrespondence | string | CIM_ProtocolEndpoint.OtherTypeDescription
Override | string | ProtocolIFType
ValueMap | string | 1, 225..4095, 4108, 4301..32767, 32768..
Values | string | Other, IANA Reserved, BGP, DMTF Reserved, Vendor Reserved
RemoteAddress | string |
Deprecated | string | CIM_BindsTo, CIM_RemoteServiceAccessPoint
Description | string | This 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.
MappingStrings | string | MIB.IETF|BGP4-MIB.bgpPeerRemoteAddr
RemoteAS | uint16 |
Description | string | This is the remote AS number for this router's BGP connection.
MappingStrings | string | MIB.IETF|BGP4-MIB.bgpPeerRemoteAs
RemotePort | uint16 |
Deprecated | string | CIM_BindsTo, CIM_RemotePort
Description | string | This 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.
MappingStrings | string | MIB.IETF|BGP4-MIB.bgpPeerRemotePort
State | uint16 |
Description | string | This defines the current connection state of the BGP Peer.
MappingStrings | string | MIB.IETF|BGP4-MIB.bgpPeerState
ValueMap | string | 1, 2, 3, 4, 5, 6
Values | string | Idle, Connect, Active, OpenSet, OpenConfirm, Established

### Inherited Properties

Name | Data Type | Class Origin
--- | --- | ---
BroadcastResetSupported | boolean | CIM_ProtocolEndpoint
Caption | string | CIM_ManagedElement
CommunicationStatus | uint16 | CIM_ManagedSystemElement
CreationClassName | string | CIM_ServiceAccessPoint
Description | string | CIM_ProtocolEndpoint
DetailedStatus | uint16 | CIM_ManagedSystemElement
ElementName | string | CIM_ManagedElement
EnabledDefault | uint16 | CIM_EnabledLogicalElement
EnabledState | uint16 | CIM_ProtocolEndpoint
Generation | uint64 | CIM_ManagedElement
HealthState | uint16 | CIM_ManagedSystemElement
InstallDate | datetime | CIM_ManagedSystemElement
InstanceID | string | CIM_ManagedElement
Name | string | CIM_ProtocolEndpoint
NameFormat | string | CIM_ProtocolEndpoint
OperatingStatus | uint16 | CIM_ManagedSystemElement
OtherEnabledState | string | CIM_EnabledLogicalElement
OtherTypeDescription | string | CIM_ProtocolEndpoint
PrimaryStatus | uint16 | CIM_ManagedSystemElement
ProtocolType | uint16 | CIM_ProtocolEndpoint
RequestedState | uint16 | CIM_EnabledLogicalElement
Status | string | CIM_ManagedSystemElement
SystemCreationClassName | string | CIM_ServiceAccessPoint
SystemName | string | CIM_ServiceAccessPoint
TimeOfLastStateChange | datetime | CIM_ProtocolEndpoint
TransitioningToState | uint16 | CIM_EnabledLogicalElement
AvailableRequestedStates | uint16[] | CIM_EnabledLogicalElement
OperationalStatus | uint16[] | CIM_ProtocolEndpoint
StatusDescriptions | string[] | CIM_ManagedSystemElement

## Class Methods

### Inherited Class Methods

Name | Return Type | Class Origin
--- | --- | ---
BroadcastReset | uint32 | CIM_ProtocolEndpoint
RequestStateChange | uint32 | CIM_EnabledLogicalElement