Name | Data Type | Qualifiers |
Name | Data Type | Value | Scope | Flavors |
AdminStatus | uint16 |
Deprecated | string | CIM_EnabledLogicalElement.RequestedState | TOSUBCLASS= false | None |
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. | None | TRANSLATABLE= true |
MappingStrings | string | MIB.IETF|BGP4-MIB.bgpPeerAdminStatus | None | None |
ValueMap | string | 1, 2 | None | None |
Values | string | Stop, Start | None | TRANSLATABLE= true |
Caption | string |
Description | string | The Caption property is a short textual description (one- line string) of the object. | None | TRANSLATABLE= true |
MaxLen | uint32 | 64 | None | None |
ConnectRetryInterval | uint32 |
Description | string | This defines the time interval, in seconds, for the ConnectRetry timer. The suggested value is 120 seconds. | None | TRANSLATABLE= true |
MappingStrings | string | MIB.IETF|BGP4-MIB.bgpConnectRetryInterval | None | None |
Units | string | Seconds | None | TRANSLATABLE= true |
CreationClassName | string |
Description | string | CreationClassName 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 |
Key | boolean | true | None | OVERRIDABLE= false
|
MaxLen | uint32 | 256 | None | None |
Description | string |
Description | string | The Description property provides a textual description of the object. | None | TRANSLATABLE= true |
MappingStrings | string | MIB.IETF|IF-MIB.ifDescr | None | None |
Override | string | Description | None | OVERRIDABLE= false
|
ElementName | string |
Description | string | A 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 |
EnabledDefault | uint16 |
Description | string | An 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 |
ValueMap | string | 2, 3, 5, 6, 7, 8..32767, 32768..65535 | None | None |
Values | string | Enabled, Disabled, Not Applicable, Enabled but Offline, No Default, DMTF Reserved, Vendor Reserved | None | TRANSLATABLE= true |
Write | boolean | true | None | None |
EnabledState | uint16 |
Description | string | EnabledState 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 |
MappingStrings | string | MIB.IETF|IF-MIB.ifAdminStatus | None | None |
ModelCorrespondence | string | CIM_EnabledLogicalElement.OtherEnabledState | None | None |
Override | string | EnabledState | None | OVERRIDABLE= false
|
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11..32767, 32768..65535 | None | None |
Values | string | Unknown, Other, Enabled, Disabled, Shutting Down, Not Applicable, Enabled but Offline, In Test, Deferred, Quiesce, Starting, DMTF Reserved, Vendor Reserved | None | TRANSLATABLE= true |
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. | None | TRANSLATABLE= true |
MappingStrings | string | MIB.IETF|BGP4-MIB.bgpPeerHoldTime | None | None |
Units | string | Seconds | None | TRANSLATABLE= true |
HoldTimeConfigured | uint16 |
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. | None | TRANSLATABLE= true |
MappingStrings | string | MIB.IETF|BGP4-MIB.bgpPeerHoldTimeConfigured | None | None |
Units | string | Seconds | None | TRANSLATABLE= true |
InstallDate | datetime |
Description | string | A 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 |
MappingStrings | string | MIF.DMTF|ComponentID|001.5 | None | None |
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). | None | TRANSLATABLE= true |
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). | None | TRANSLATABLE= true |
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. | None | TRANSLATABLE= true |
MappingStrings | string | MIB.IETF|BGP4-MIB.bgpPeerKeepAlive | None | None |
Units | string | Seconds | None | TRANSLATABLE= true |
KeepAliveConfigured | uint16 |
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. | None | TRANSLATABLE= true |
MappingStrings | string | MIB.IETF|BGP4-MIB.bgpPeerKeepAliveConfigured | None | None |
Units | string | Seconds | None | TRANSLATABLE= true |
LocalAddress | string |
Deprecated | string | CIM_BindsTo, CIM_IPProtocolEndpoint | TOSUBCLASS= false | None |
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. | None | TRANSLATABLE= true |
MappingStrings | string | MIB.IETF|BGP4-MIB.bgpPeerLocalAddr | None | None |
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). | None | TRANSLATABLE= true |
MappingStrings | string | MIB.IETF|BGP4-MIB.bgpIdentifier | None | None |
LocalPort | uint16 |
Deprecated | string | CIM_BindsTo, CIM_TCPProtocolEndpoint | TOSUBCLASS= false | None |
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. | None | TRANSLATABLE= true |
MappingStrings | string | MIB.IETF|BGP4-MIB.bgpPeerLocalPort | None | None |
MinASOriginationInterval | uint16 |
Description | string | This defines the time interval in seconds for the MinASOriginationInterval timer. The suggested value for this property is 15 seconds. | None | TRANSLATABLE= true |
MappingStrings | string | MIB.IETF|BGP4-MIB.bgpPeerMinASOriginationInterval | None | None |
Units | string | Seconds | None | TRANSLATABLE= true |
MinRouteAdvertisementInterval | uint16 |
Description | string | This defines the time interval in seconds for the MinRouteAdvertisementInterval timer. The suggested value for this property is 30 seconds. | None | TRANSLATABLE= true |
MappingStrings | string | MIB.IETF|BGP4-MIB.bgpPeerMinRouteAdvertisementInterval | None | None |
Units | string | Seconds | None | TRANSLATABLE= true |
Name | string |
Description | string | A 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 |
Key | boolean | true | None | OVERRIDABLE= false
|
MaxLen | uint32 | 256 | None | None |
Override | string | Name | None | OVERRIDABLE= false
|
NameFormat | string |
Description | string | NameFormat 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 |
MaxLen | uint32 | 256 | None | None |
NegotiatedVersion | string |
Description | string | This defines the negotiated version of BGP that is running between the two peers. | None | TRANSLATABLE= true |
MappingStrings | string | MIB.IETF|BGP4-MIB.bgpPeerNegotiatedVersion | None | None |
OtherEnabledState | string |
Description | string | A 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 |
ModelCorrespondence | string | CIM_EnabledLogicalElement.EnabledState | None | None |
OtherTypeDescription | string |
Description | string | A 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 |
MaxLen | uint32 | 64 | None | None |
ModelCorrespondence | string | CIM_ProtocolEndpoint.ProtocolType, CIM_ProtocolEndpoint.ProtocolIFType | None | None |
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). | None | TRANSLATABLE= true |
MappingStrings | string | MIB.IETF|BGP4-MIB.bgpPeerIdentifier | None | None |
ProtocolIFType | uint16 |
Description | string | ProtocolIFType's enumeration is limited to BGP and reserved values for this subclass of ProtocolEndpoint. | None | TRANSLATABLE= true |
MappingStrings | string | MIB.IETF|IF-MIB.ifType | None | None |
ModelCorrespondence | string | CIM_ProtocolEndpoint.OtherTypeDescription | None | None |
Override | string | ProtocolIFType | None | OVERRIDABLE= false
|
ValueMap | string | 1, 222..4095, 4108, 4116..32767, 32768.. | None | None |
Values | string | Other, IANA Reserved, BGP, DMTF Reserved, Vendor Reserved | None | TRANSLATABLE= true |
ProtocolType | uint16 |
Deprecated | string | CIM_ProtocolEndpoint.ProtocolIFType | TOSUBCLASS= false | None |
Description | string | ProtocolType 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 |
ModelCorrespondence | string | CIM_ProtocolEndpoint.OtherTypeDescription | None | None |
ValueMap | string | 0, 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, 27 | None | None |
Values | string | Unknown, 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, TCP | None | TRANSLATABLE= true |
RemoteAddress | string |
Deprecated | string | CIM_BindsTo, CIM_RemoteServiceAccessPoint | TOSUBCLASS= false | None |
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. | None | TRANSLATABLE= true |
MappingStrings | string | MIB.IETF|BGP4-MIB.bgpPeerRemoteAddr | None | None |
RemoteAS | uint16 |
Description | string | This is the remote AS number for this router's BGP connection. | None | TRANSLATABLE= true |
MappingStrings | string | MIB.IETF|BGP4-MIB.bgpPeerRemoteAs | None | None |
RemotePort | uint16 |
Deprecated | string | CIM_BindsTo, CIM_RemotePort | TOSUBCLASS= false | None |
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. | None | TRANSLATABLE= true |
MappingStrings | string | MIB.IETF|BGP4-MIB.bgpPeerRemotePort | None | None |
RequestedState | uint16 |
Description | string | RequestedState 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 |
ModelCorrespondence | string | CIM_EnabledLogicalElement.EnabledState | None | None |
ValueMap | string | 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, .., 32768..65535 | None | None |
Values | string | Enabled, Disabled, Shut Down, No Change, Offline, Test, Deferred, Quiesce, Reboot, Reset, DMTF Reserved, Vendor Reserved | None | TRANSLATABLE= true |
State | uint16 |
Description | string | This defines the current connection state of the BGP Peer. | None | TRANSLATABLE= true |
MappingStrings | string | MIB.IETF|BGP4-MIB.bgpPeerState | None | None |
ValueMap | string | 1, 2, 3, 4, 5, 6 | None | None |
Values | string | Idle, Connect, Active, OpenSet, OpenConfirm, Established | None | TRANSLATABLE= true |
Status | string |
Deprecated | string | CIM_ManagedSystemElement.OperationalStatus | TOSUBCLASS= false | None |
Description | string | A 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 |
MaxLen | uint32 | 10 | None | None |
ValueMap | string | OK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service, Stressed, NonRecover, No Contact, Lost Comm, Stopped | None | None |
SystemCreationClassName | string |
Description | string | The scoping System's CreationClassName. | None | TRANSLATABLE= true |
Key | boolean | true | None | OVERRIDABLE= false
|
MaxLen | uint32 | 256 | None | None |
Propagated | string | CIM_System.CreationClassName | None | OVERRIDABLE= false
|
SystemName | string |
Description | string | The scoping System's Name. | None | TRANSLATABLE= true |
Key | boolean | true | None | OVERRIDABLE= false
|
MaxLen | uint32 | 256 | None | None |
Propagated | string | CIM_System.Name | None | OVERRIDABLE= false
|
TimeOfLastStateChange | datetime |
Description | string | The 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 |
MappingStrings | string | MIB.IETF|IF-MIB.ifLastChange | None | None |
Override | string | TimeOfLastStateChange | None | OVERRIDABLE= false
|
OperationalStatus | uint16[] |
ArrayType | string | Indexed | None | OVERRIDABLE= false
|
Description | string | Indicates 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 |
MappingStrings | string | MIB.IETF|IF-MIB.ifOperStatus | None | None |
ModelCorrespondence | string | CIM_ManagedSystemElement.StatusDescriptions | None | None |
Override | string | OperationalStatus | None | OVERRIDABLE= false
|
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, .., 0x8000.. | None | None |
Values | string | Unknown, 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 Reserved | None | TRANSLATABLE= true |
StatusDescriptions | string[] |
ArrayType | string | Indexed | None | OVERRIDABLE= false
|
Description | string | Strings 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 |
ModelCorrespondence | string | CIM_ManagedSystemElement.OperationalStatus | None | None |