Class CIM_BGPIPRoute
extends CIM_IPRoute

BGPIPRoute describes a BGP routing entry that connects two peer routers that are running BGP. The source and destination addresses may be either specific IP endpoints or IP subnets. Examining the BGPIPRoute class definition, note that its superclass IPRoute is deprecated. Unfortunately, IPRoute cannot be removed from the object hierarchy without a major Schema release. When/if this occurs, the IPRoute superclass will be removed, and BGPIPRoute will subclass from CIM_NextHopRouting directly.

Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_NextHopRouting
   |
   +--CIM_IPRoute
   |
   +--CIM_BGPIPRoute

Direct Known Subclasses

None.

Class Qualifiers

NameData TypeValueScopeFlavors
DescriptionstringBGPIPRoute describes a BGP routing entry that connects two peer routers that are running BGP. The source and destination addresses may be either specific IP endpoints or IP subnets. Examining the BGPIPRoute class definition, note that its superclass IPRoute is deprecated. Unfortunately, IPRoute cannot be removed from the object hierarchy without a major Schema release. When/if this occurs, the IPRoute superclass will be removed, and BGPIPRoute will subclass from CIM_NextHopRouting directly.None TRANSLATABLE= true
Versionstring2.6.0TOSUBCLASS= falseTRANSLATABLE= true

Local Class Properties

NameData TypeQualifiers
NameData TypeValueScopeFlavors
AddressTypeuint16
DeprecatedstringCIM_NextHopIPRoute.AddressTypeTOSUBCLASS= falseNone
DescriptionstringAn enumeration that describes the format of the address property. Addresses that can be formatted in IPv4 format, must be formatted that way to ensure mixed IPv4/IPv6 support. AddressType is part of the key so that an IPv4 and an IPv6 route to IP subnets with the same network number but different IP versions (v4/v6) can coexist.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
ValueMapstring0, 1, 2None None
ValuesstringUnknown, IPv4, IPv6None TRANSLATABLE= true
Captionstring
DescriptionstringThe Caption property is a short textual description (one- line string) of the object.None TRANSLATABLE= true
MaxLenuint3264None None
CreationClassNamestring
DeprecatedstringNo valueTOSUBCLASS= falseNone
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
DestinationAddressstring
DescriptionstringThe address which serves as the destination to be reached.None TRANSLATABLE= true
ModelCorrespondencestringCIM_IPRoute.IPDestinationAddressNone None
OverridestringDestinationAddressNone OVERRIDABLE= false
DestinationMaskstring
DescriptionstringThe mask for the DestinationAddress.None TRANSLATABLE= true
ModelCorrespondencestringCIM_IPRoute.IPDestinationMaskNone None
OverridestringDestinationMaskNone 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
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
IPDestinationAddressstring
DeprecatedstringCIM_NextHopIPRoute.DestinationAddressTOSUBCLASS= falseNone
DescriptionstringThe IP address which serves as the destination of the traffic, formatted according to the appropriate convention as defined in the AddressType property of this class. This property has the same semantics as DestinationAddress inherited from the NextHopRouting superclass, but a different property name. This is because this property and class were defined before NextHopRouting and are Key properties. They cannot be removed. ModelCorrespondence indicates that they should be set to equivalent values for consistency and ease of query.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
ModelCorrespondencestringCIM_IPRoute.DestinationAddressNone None
IPDestinationMaskstring
DeprecatedstringCIM_NextHopIPRoute.DestinationMaskTOSUBCLASS= falseNone
DescriptionstringThe mask for the destination IP address, formatted according to the appropriate convention as defined in the AddressType property of this class. This property has the same semantics as DestinationMask inherited from the NextHopRouting superclass, but a different property name. This is because this property and class were defined before NextHopRouting and are Key properties. They cannot be removed. ModelCorrespondence indicates that they should be set to equivalent values for consistency and ease of query.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
ModelCorrespondencestringCIM_IPRoute.DestinationMaskNone None
IsBackDoorRouteboolean
DescriptionstringUsually, the administrative distance is used to determine which route gets installed in the routing table. Using this scheme, routes learned via EBGP will win over routes learned via an IGP. If this is not desired, then this assigns the administrative distance of this route to be equal to that of a local route, which means that the same route learned by an IGP will have a lower administrative distance and be installed instead.None TRANSLATABLE= true
IsStaticboolean
DeprecatedstringCIM_NextHopRoute.IsStaticTOSUBCLASS= falseNone
DescriptionstringTRUE indicates that this is a static route, and FALSE indicates a dynamically-learned route.None TRANSLATABLE= true
Namestring
DescriptionstringThe Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property.None TRANSLATABLE= true
MaxLenuint321024None None
NextHopstring
DeprecatedstringCIM_AssociatedNextHop.Antecedent, CIM_RouteUsesEndpoint.AntecedentTOSUBCLASS= falseNone
DescriptionstringThis contains either the address of the next-hop router, or the interface used to reach the destination.None TRANSLATABLE= true
ServiceCreationClassNamestring
DeprecatedstringNo valueTOSUBCLASS= falseNone
DescriptionstringThe scoping ForwardingService's CreationClassName.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint32256None None
PropagatedstringCIM_ForwardingService.CreationClassNameNone OVERRIDABLE= false
ServiceNamestring
DeprecatedstringNo valueTOSUBCLASS= falseNone
DescriptionstringThe scoping ForwardingService's Name.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint32256None None
PropagatedstringCIM_ForwardingService.NameNone OVERRIDABLE= false
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
DeprecatedstringNo valueTOSUBCLASS= falseNone
DescriptionstringThe scoping ForwardingService's SystemCreationClassName.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint32256None None
PropagatedstringCIM_ForwardingService.SystemCreationClassNameNone OVERRIDABLE= false
SystemNamestring
DeprecatedstringNo valueTOSUBCLASS= falseNone
DescriptionstringThe scoping ForwardingService's SystemName.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint32256None None
PropagatedstringCIM_ForwardingService.SystemNameNone OVERRIDABLE= false
UsesLoopbackPeeringboolean
DescriptionstringLoopback interfaces are often used by IBGP peers, because they eliminate a dependency that would otherwise occur if the actual IP address of a physical interface was used to configure BGP. The loopback interface instead instructs the router to use any available interface.None TRANSLATABLE= true
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
ModelCorrespondencestringCIM_ManagedSystemElement.StatusDescriptionsNone None
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