Class CIM_BGPProtocolEndpoint
extends CIM_ProtocolEndpoint

A ProtocolEndpoint that is dedicated to running BGP.

Class Hierarchy

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

Direct Known Subclasses

None.

Class Qualifiers

NameData TypeValueScopeFlavors
DescriptionstringA ProtocolEndpoint that is dedicated to running BGP.None TRANSLATABLE= true
Versionstring2.8.0TOSUBCLASS= falseTRANSLATABLE= true

Local Class Properties

NameData TypeQualifiers
NameData TypeValueScopeFlavors
AdminStatusuint16
DeprecatedstringCIM_EnabledLogicalElement.RequestedStateTOSUBCLASS= falseNone
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.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgpPeerAdminStatusNone None
ValueMapstring1, 2None None
ValuesstringStop, StartNone TRANSLATABLE= true
Captionstring
DescriptionstringThe Caption property is a short textual description (one- line string) of the object.None TRANSLATABLE= true
MaxLenuint3264None None
ConnectRetryIntervaluint32
DescriptionstringThis defines the time interval, in seconds, for the ConnectRetry timer. The suggested value is 120 seconds.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgpConnectRetryIntervalNone None
UnitsstringSecondsNone TRANSLATABLE= true
CreationClassNamestring
DescriptionstringCreationClassName indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint32256None None
Descriptionstring
DescriptionstringThe Description property provides a textual description of the object.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|IF-MIB.ifDescrNone None
OverridestringDescriptionNone OVERRIDABLE= false
ElementNamestring
DescriptionstringA user-friendly name for the object. This property allows each instance to define a user-friendly name IN ADDITION TO its key properties/identity data, and description information. Note that ManagedSystemElement's Name property is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information MAY be present in both the Name and ElementName properties.None TRANSLATABLE= true
EnabledDefaultuint16
DescriptionstringAn enumerated value indicating an administrator's default/startup configuration for an element's Enabled State. By default, the element is "Enabled" (value=2).None TRANSLATABLE= true
ValueMapstring2, 3, 5, 6, 7, 8..32767, 32768..65535None None
ValuesstringEnabled, Disabled, Not Applicable, Enabled but Offline, No Default, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
WritebooleantrueNone None
EnabledStateuint16
DescriptionstringEnabledState is an integer enumeration that indicates the enabled/disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value = 4) and starting (value=10) are transient states between enabled and disabled. The following text briefly summarizes the various enabled/disabled states: Enabled (2) indicates that the element is/could be executing commands, will process any queued commands, and queues new requests. Disabled (3) indicates that the element will not execute commands and will drop any new requests. Shutting Down (4) indicates that the element is in the process of going to a Disabled state. Not Applicable (5) indicates the element doesn't support being enabled/disabled. Enabled but Offline (6) indicates that the element may be completing commands, and will drop any new requests. Test (7) indicates that the element is in a test state. Deferred (8) indicates that the element may be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. The element's behavior is similar to the Enabled state, but it only processes a restricted set of commands. All other requests are queued. Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|IF-MIB.ifAdminStatusNone None
ModelCorrespondencestringCIM_EnabledLogicalElement.OtherEnabledStateNone None
OverridestringEnabledStateNone OVERRIDABLE= false
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11..32767, 32768..65535None None
ValuesstringUnknown, Other, Enabled, Disabled, Shutting Down, Not Applicable, Enabled but Offline, In Test, Deferred, Quiesce, Starting, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
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.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgpPeerHoldTimeNone None
UnitsstringSecondsNone TRANSLATABLE= true
HoldTimeConfigureduint16
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.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgpPeerHoldTimeConfiguredNone None
UnitsstringSecondsNone TRANSLATABLE= true
InstallDatedatetime
DescriptionstringA datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.None TRANSLATABLE= true
MappingStringsstringMIF.DMTF|ComponentID|001.5None None
IsEBGPboolean
DescriptionstringA boolean that, when TRUE, signifies that this is an instance of the external version of BGP (FALSE is the internal version).None TRANSLATABLE= true
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).None TRANSLATABLE= true
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.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgpPeerKeepAliveNone None
UnitsstringSecondsNone TRANSLATABLE= true
KeepAliveConfigureduint16
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.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgpPeerKeepAliveConfiguredNone None
UnitsstringSecondsNone TRANSLATABLE= true
LocalAddressstring
DeprecatedstringCIM_BindsTo, CIM_IPProtocolEndpointTOSUBCLASS= falseNone
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.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgpPeerLocalAddrNone None
LocalIdentifierstring
DescriptionstringThis is the unique identifier of the local BGP router. This is often the router ID (e.g., an IP address).None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgpIdentifierNone None
LocalPortuint16
DeprecatedstringCIM_BindsTo, CIM_TCPProtocolEndpointTOSUBCLASS= falseNone
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.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgpPeerLocalPortNone None
MinASOriginationIntervaluint16
DescriptionstringThis defines the time interval in seconds for the MinASOriginationInterval timer. The suggested value for this property is 15 seconds.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgpPeerMinASOriginationIntervalNone None
UnitsstringSecondsNone TRANSLATABLE= true
MinRouteAdvertisementIntervaluint16
DescriptionstringThis defines the time interval in seconds for the MinRouteAdvertisementInterval timer. The suggested value for this property is 30 seconds.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgpPeerMinRouteAdvertisementIntervalNone None
UnitsstringSecondsNone TRANSLATABLE= true
Namestring
DescriptionstringA string which identifies this ProtocolEndpoint with either a port or an interface on a device. To ensure uniqueness, the Name property should be prepended or appended with information from the Type or OtherTypeDescription properties. The method chosen is described in the NameFormat property of this class.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint32256None None
OverridestringNameNone OVERRIDABLE= false
NameFormatstring
DescriptionstringNameFormat contains the naming heuristic that is chosen to ensure that the value of the Name property is unique. For example, one might choose to prepend the name of the port or interface with the Type of ProtocolEndpoint that this instance is (e.g., IPv4) followed by an underscore.None TRANSLATABLE= true
MaxLenuint32256None None
NegotiatedVersionstring
DescriptionstringThis defines the negotiated version of BGP that is running between the two peers.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgpPeerNegotiatedVersionNone None
OtherEnabledStatestring
DescriptionstringA string describing the element's enabled/disabled state when the EnabledState property is set to 1 ("Other"). This property MUST be set to NULL when EnabledState is any value other than 1.None TRANSLATABLE= true
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledStateNone None
OtherTypeDescriptionstring
DescriptionstringA string describing the type of ProtocolEndpoint when the Type property of this class (or any of its subclasses) is set to 1 (i.e., "Other"). This property should be set to NULL when the Type property is any value other than 1.None TRANSLATABLE= true
MaxLenuint3264None None
ModelCorrespondencestringCIM_ProtocolEndpoint.ProtocolType, CIM_ProtocolEndpoint.ProtocolIFTypeNone None
PeerIdentifierstring
DescriptionstringThis is the unique identifier of the peer BGP router. This is often the router ID (e.g., an IP address).None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgpPeerIdentifierNone None
ProtocolIFTypeuint16
DescriptionstringProtocolIFType's enumeration is limited to BGP and reserved values for this subclass of ProtocolEndpoint.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|IF-MIB.ifTypeNone None
ModelCorrespondencestringCIM_ProtocolEndpoint.OtherTypeDescriptionNone None
OverridestringProtocolIFTypeNone OVERRIDABLE= false
ValueMapstring1, 222..4095, 4108, 4116..32767, 32768..None None
ValuesstringOther, IANA Reserved, BGP, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
ProtocolTypeuint16
DeprecatedstringCIM_ProtocolEndpoint.ProtocolIFTypeTOSUBCLASS= falseNone
DescriptionstringProtocolType is an enumeration providing information to categorize and classify different instances of this class. For most instances, information in this enumeration and the subclass' definition overlap. However, there are several cases where a specific subclass of ProtocolEndpoint is not required (for example, there is no Fibre Channel subclass of ProtocolEndpoint). Hence, this property is needed to define the type of Endpoint. This property is deprecated in lieu of the ProtocolIFType enumeration. This is done to have better alignment between the IETF's IF-MIB and this CIM class.None TRANSLATABLE= true
ModelCorrespondencestringCIM_ProtocolEndpoint.OtherTypeDescriptionNone None
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27None None
ValuesstringUnknown, Other, IPv4, IPv6, IPX, AppleTalk, DECnet, SNA, CONP, CLNP, VINES, XNS, ATM, Frame Relay, Ethernet, TokenRing, FDDI, Infiniband, Fibre Channel, ISDN BRI Endpoint, ISDN B Channel Endpoint, ISDN D Channel Endpoint, IPv4/v6, BGP, OSPF, MPLS, UDP, TCPNone TRANSLATABLE= true
RemoteAddressstring
DeprecatedstringCIM_BindsTo, CIM_RemoteServiceAccessPointTOSUBCLASS= falseNone
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.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgpPeerRemoteAddrNone None
RemoteASuint16
DescriptionstringThis is the remote AS number for this router's BGP connection.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgpPeerRemoteAsNone None
RemotePortuint16
DeprecatedstringCIM_BindsTo, CIM_RemotePortTOSUBCLASS= falseNone
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.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgpPeerRemotePortNone None
RequestedStateuint16
DescriptionstringRequestedState is an integer enumeration indicating the last requested or desired state for the element. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled/disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. By default, the element's RequestedState is 5 ("No Change"). Refer to the EnabledState's property Description for explanations of the values in the RequestedState enumeration. It should be noted that there are two new values in RequestedState that build on the statuses of EnabledState. These are "Reboot" (10) and "Reset" (11). The former, Reboot, refers to doing a "Shut Down" and then moving to an "Enabled" state. The latter, Reset, indicates that the element is first "Disabled" and then "Enabled". The distinction between requesting "Shut Down" and "Disabled" should also be noted. The former, Shut Down, requests an orderly transition to the Disabled state, and MAY involve removing power, to completely erase any existing state. The latter, the Disabled state, requests an immediate disabling of the element, such that it will not execute or accept any commands or processing requests. This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or may be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, since it allows an explicit invocation of the operation and the return of a result code.None TRANSLATABLE= true
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledStateNone None
ValueMapstring2, 3, 4, 5, 6, 7, 8, 9, 10, 11, .., 32768..65535None None
ValuesstringEnabled, Disabled, Shut Down, No Change, Offline, Test, Deferred, Quiesce, Reboot, Reset, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
Stateuint16
DescriptionstringThis defines the current connection state of the BGP Peer.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgpPeerStateNone None
ValueMapstring1, 2, 3, 4, 5, 6None None
ValuesstringIdle, Connect, Active, OpenSet, OpenConfirm, EstablishedNone TRANSLATABLE= true
Statusstring
DeprecatedstringCIM_ManagedSystemElement.OperationalStatusTOSUBCLASS= falseNone
DescriptionstringA string indicating the current status of the object. Various operational and non-operational statuses are defined. This property is deprecated in lieu of OperationalStatus, which includes the same semantics in its enumeration. This change is made for 3 reasons: 1) Status is more correctly defined as an array. This overcomes the limitation of describing status via a single value, when it is really a multi-valued property (for example, an element may be OK AND Stopped. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. And, 3) The change to a uint16 data type was discussed when CIM V2.0 was defined. However, existing V1.0 implementations used the string property and did not want to modify their code. Therefore, Status was grandfathered into the Schema. Use of the Deprecated qualifier allows the maintenance of the existing property, but also permits an improved definition using OperationalStatus.None TRANSLATABLE= true
MaxLenuint3210None None
ValueMapstringOK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service, Stressed, NonRecover, No Contact, Lost Comm, StoppedNone None
SystemCreationClassNamestring
DescriptionstringThe scoping System's CreationClassName.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint32256None None
PropagatedstringCIM_System.CreationClassNameNone OVERRIDABLE= false
SystemNamestring
DescriptionstringThe scoping System's Name.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint32256None None
PropagatedstringCIM_System.NameNone OVERRIDABLE= false
TimeOfLastStateChangedatetime
DescriptionstringThe date/time when the element's EnabledState last changed. If the state of the element has not changed and this property is populated, then it MUST be set to a 0 interval value. If a state change was requested, but rejected or not yet processed, the property MUST NOT be updated.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|IF-MIB.ifLastChangeNone None
OverridestringTimeOfLastStateChangeNone OVERRIDABLE= false
OperationalStatusuint16[]
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringIndicates the current status(es) of the element. Various health and operational statuses are defined. Many of the enumeration's values are self- explanatory. However, a few are not and are described in more detail. "Stressed" indicates that the element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, etc. "Predictive Failure" indicates that an element is functioning nominally but predicting a failure in the near future. "In Service" describes an element being configured, maintained, cleaned, or otherwise administered. "No Contact" indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it. "Lost Communication" indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable. "Stopped" and "Aborted" are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the element's state and configuration may need to be updated. "Dormant" indicates that the element is inactive or quiesced. "Supporting Entity in Error" describes that this element may be "OK" but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower layer networking problems. "Completed" indicates the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can till if the complete operation passed (Completed with OK), and failure (Completed with Error). Completed with Degraded would imply the operation finished, but did not complete OK or report an error. "Power Mode" indicates the element has additional power model information contained in the Associated PowerManagementService association. OperationalStatus replaces the Status property on ManagedSystemElement to provide a consistent approach to enumerations, to address implementation needs for an array property, and to provide a migration path from today's environment to the future. This change was not made earlier since it required the DEPRECATED qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly RECOMMENDED that providers/instrumentation provide BOTH the Status and OperationalStatus properties. Further, the first value of OperationalStatus SHOULD contain the primary status for the element. When instrumented, Status (since it is single-valued) SHOULD also provide the primary status of the element.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|IF-MIB.ifOperStatusNone None
ModelCorrespondencestringCIM_ManagedSystemElement.StatusDescriptionsNone None
OverridestringOperationalStatusNone OVERRIDABLE= false
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, .., 0x8000..None None
ValuesstringUnknown, Other, OK, Degraded, Stressed, Predictive Failure, Error, Non-Recoverable Error, Starting, Stopping, Stopped, In Service, No Contact, Lost Communication, Aborted, Dormant, Supporting Entity in Error, Completed, Power Mode, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
StatusDescriptionsstring[]
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringStrings describing the various OperationalStatus array values. For example, if "Stopping" is the value assigned to OperationalStatus, then this property may contain an explanation as to why an object is being stopped. Note that entries in this array are correlated with those at the same array index in OperationalStatus.None TRANSLATABLE= true
ModelCorrespondencestringCIM_ManagedSystemElement.OperationalStatusNone None