CIM29 Class Declaration
CIM_BGPIPRoute

Table of Contents:
Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary

Class Hierarchy

CIM_BGPIPRoute --> CIM_IPRoute --> CIM_NextHopRouting --> CIM_LogicalElement --> CIM_ManagedSystemElement --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_IPRoute
NAMECIM_BGPIPRoute

Class Qualifiers

Class CIM_BGPIPRoute Qualifiers
NameTypeValueFrom Class
Versionstring2.6.0 CIM_BGPIPRoute
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. CIM_BGPIPRoute
DescriptionstringAn IPRoute relates a destination address to the address or interface through which the remote address may be reached. The destination address may be a specific IP endpoint or a subnet, dependent on the mask. An instance of this class represents either static or dynamic routing. Static routes are distinguished by setting the IsStatic boolean property to TRUE. Since many routes between endpoints can be defined (using different route calculation algorithms), the CIM_IPRoute class is defined as Abstract. This forces subclassing (for example, see CIM_BGPIPRoute) and allows the instances of its subclasses to be distinguished based on their CreationClassName key property. IPRoute is deprecated in lieu of the more general, concrete NextHopIPRoute class. NextHopIPRoute allows the definition of BOTH a next hop address and an interface for transmission of the traffic. Also, it does not mandate the instantiation of a ForwardingService class. CIM_IPRoute
DescriptionstringNextHopRouting relates a destination address to the address or interface through which the remote address may be reached. An instance of this class can represent either static or dynamic routing, and may represent a routing table entry (but it is not required that all NextHopRoutes be in a routing table). Static routes are distinguished by setting the IsStatic boolean property to TRUE. Subclasses of NextHopRouting provide specific protocol and Key information. NextHopRoutes are dependent on at least one ForwardingService to execute them. This is conveyed by the CIM_NextHopForwardedByService association. NextHopRouting is deprecated in lieu of the more general, concrete NextHopRoute class. NextHopRoute allows the definition of BOTH a next hop address and an interface for transmission of the traffic. Also, it does not mandate the instantiation of a ForwardingService class. The latter is not needed if the sole purpose of the instance is to specify a ’ desired/configured ’ route. This is simply a specification of the next hop. CIM_NextHopRouting
DescriptionstringCIM_LogicalElement is a base class for all the components of a System that represent abstract system components, such as Files, Processes, or LogicalDevices. CIM_LogicalElement
DescriptionstringCIM_ManagedSystemElement is the base class for the System Element hierarchy. Any distinguishable component of a System is a candidate for inclusion in this class. Examples of system components include: - software components such as application servers, databases, and applications - operating system components such as files, processes, and threads - device components such as disk drives, controllers, processors, and printers - physical components such as chips and cards. CIM_ManagedSystemElement
DescriptionstringManagedElement is an abstract class that provides a common superclass (or top of the inheritance tree) for the non-association classes in the CIM Schema. CIM_ManagedElement

Properties

Properties
NameTypeValueQualifiersClassOrigin
IsBackDoorRouteboolean Description CIM_BGPIPRoute
UsesLoopbackPeeringboolean Description CIM_BGPIPRoute
SystemCreationClassNamestring Deprecated
Key
Propagated
Description
MaxLen
CIM_IPRoute
SystemNamestring Deprecated
Key
Propagated
Description
MaxLen
CIM_IPRoute
ServiceCreationClassNamestring Deprecated
Key
Propagated
Description
MaxLen
CIM_IPRoute
ServiceNamestring Deprecated
Key
Propagated
Description
MaxLen
CIM_IPRoute
CreationClassNamestring Deprecated
Key
Description
MaxLen
CIM_IPRoute
IPDestinationAddressstring Deprecated
Key
Description
ModelCorrespondence
CIM_IPRoute
IPDestinationMaskstring Deprecated
Key
Description
ModelCorrespondence
CIM_IPRoute
AddressTypeuint16 Deprecated
Key
Description
ValueMap
Values
CIM_IPRoute
DestinationAddressstring Deprecated
Override
ModelCorrespondence
Description
CIM_IPRoute
DestinationMaskstring Deprecated
Override
ModelCorrespondence
Description
CIM_IPRoute
NextHopstring Deprecated
Description
CIM_NextHopRouting
IsStaticboolean Deprecated
Description
CIM_NextHopRouting
InstallDatedatetime Description
MappingStrings
CIM_ManagedSystemElement
Namestring Description
MaxLen
CIM_ManagedSystemElement
OperationalStatusuint16[] Description
ValueMap
Values
ArrayType
ModelCorrespondence
CIM_ManagedSystemElement
StatusDescriptionsstring[] Description
ArrayType
ModelCorrespondence
CIM_ManagedSystemElement
Statusstring Deprecated
Description
ValueMap
MaxLen
CIM_ManagedSystemElement
Captionstring Description
MaxLen
CIM_ManagedElement
Descriptionstring Description CIM_ManagedElement
ElementNamestring Description CIM_ManagedElement

Property Qualifiers

Property IsBackDoorRoute Qualifiers
NameTypeValueFrom Class
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. CIM_BGPIPRoute

Property UsesLoopbackPeering Qualifiers
NameTypeValueFrom Class
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. CIM_BGPIPRoute

Property SystemCreationClassName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_IPRoute
PropagatedstringCIM_ForwardingService.SystemCreationClassName CIM_IPRoute
DescriptionstringThe scoping ForwardingService ’ s SystemCreationClassName. CIM_IPRoute
MaxLenuint32256 CIM_IPRoute

Property SystemName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_IPRoute
PropagatedstringCIM_ForwardingService.SystemName CIM_IPRoute
DescriptionstringThe scoping ForwardingService ’ s SystemName. CIM_IPRoute
MaxLenuint32256 CIM_IPRoute

Property ServiceCreationClassName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_IPRoute
PropagatedstringCIM_ForwardingService.CreationClassName CIM_IPRoute
DescriptionstringThe scoping ForwardingService ’ s CreationClassName. CIM_IPRoute
MaxLenuint32256 CIM_IPRoute

Property ServiceName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_IPRoute
PropagatedstringCIM_ForwardingService.Name CIM_IPRoute
DescriptionstringThe scoping ForwardingService ’ s Name. CIM_IPRoute
MaxLenuint32256 CIM_IPRoute

Property CreationClassName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_IPRoute
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. CIM_IPRoute
MaxLenuint32256 CIM_IPRoute

Property IPDestinationAddress Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_IPRoute
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. CIM_IPRoute
ModelCorrespondencestringCIM_IPRoute.DestinationAddress CIM_IPRoute

Property IPDestinationMask Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_IPRoute
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. CIM_IPRoute
ModelCorrespondencestringCIM_IPRoute.DestinationMask CIM_IPRoute

Property AddressType Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_IPRoute
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. CIM_IPRoute
ValueMapstring
[See below.]
CIM_IPRoute
ValuesstringUnknown
IPv4
IPv6
CIM_IPRoute

NameValue
0Unknown
1IPv4
2IPv6
Property DestinationAddress Qualifiers
NameTypeValueFrom Class
OverridestringDestinationAddress CIM_IPRoute
ModelCorrespondencestringCIM_IPRoute.IPDestinationAddress CIM_IPRoute
DescriptionstringThe address which serves as the destination to be reached. CIM_IPRoute

Property DestinationMask Qualifiers
NameTypeValueFrom Class
OverridestringDestinationMask CIM_IPRoute
ModelCorrespondencestringCIM_IPRoute.IPDestinationMask CIM_IPRoute
DescriptionstringThe mask for the DestinationAddress. CIM_IPRoute

Property DestinationAddress Qualifiers
NameTypeValueFrom Class
DescriptionstringThe address which serves as the destination to be reached. CIM_NextHopRouting

Property DestinationMask Qualifiers
NameTypeValueFrom Class
DescriptionstringThe mask for the DestinationAddress. CIM_NextHopRouting

Property NextHop Qualifiers
NameTypeValueFrom Class
DescriptionstringThis contains either the address of the next-hop router, or the interface used to reach the destination. CIM_NextHopRouting

Property IsStatic Qualifiers
NameTypeValueFrom Class
DescriptionstringTRUE indicates that this is a static route, and FALSE indicates a dynamically-learned route. CIM_NextHopRouting

Property InstallDate Qualifiers
NameTypeValueFrom Class
DescriptionstringA datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed. CIM_ManagedSystemElement
MappingStringsstringMIF.DMTF|ComponentID|001.5 CIM_ManagedSystemElement

Property Name Qualifiers
NameTypeValueFrom Class
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. CIM_ManagedSystemElement
MaxLenuint321024 CIM_ManagedSystemElement

Property OperationalStatus Qualifiers
NameTypeValueFrom Class
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. CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
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 Reserved
CIM_ManagedSystemElement
ArrayTypestringIndexed CIM_ManagedSystemElement
ModelCorrespondencestringCIM_ManagedSystemElement.StatusDescriptions CIM_ManagedSystemElement

NameValue
0Unknown
1Other
2OK
3Degraded
4Stressed
5Predictive Failure
6Error
7Non-Recoverable Error
8Starting
9Stopping
10Stopped
11In Service
12No Contact
13Lost Communication
14Aborted
15Dormant
16Supporting Entity in Error
17Completed
18Power Mode
..DMTF Reserved
0x8000..Vendor Reserved
Property StatusDescriptions Qualifiers
NameTypeValueFrom Class
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. CIM_ManagedSystemElement
ArrayTypestringIndexed CIM_ManagedSystemElement
ModelCorrespondencestringCIM_ManagedSystemElement.OperationalStatus CIM_ManagedSystemElement

Property Status Qualifiers
NameTypeValueFrom Class
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. CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
MaxLenuint3210 CIM_ManagedSystemElement

NameValue
OK[none]
Error[none]
Degraded[none]
Unknown[none]
Pred Fail[none]
Starting[none]
Stopping[none]
Service[none]
Stressed[none]
NonRecover[none]
No Contact[none]
Lost Comm[none]
Stopped[none]
Property Caption Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Caption property is a short textual description (one- line string) of the object. CIM_ManagedElement
MaxLenuint3264 CIM_ManagedElement

Property Description Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Description property provides a textual description of the object. CIM_ManagedElement

Property ElementName Qualifiers
NameTypeValueFrom Class
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. CIM_ManagedElement

Methods

Method Qualifiers

Parameters

Parameter Qualifiers

Associations this class can participate in

Association
Class
Reference
Class
Role
CIM_RoutesBGPCIM_BGPIPRouteDependent
CIM_BGPAttributesForRouteCIM_BGPIPRouteDependent
CIM_ForwardedRoutesCIM_IPRouteDependent
CIM_CalculatedRoutesCIM_IPRouteDependent
CIM_RouteForwardedByServiceCIM_NextHopRoutingDependent
CIM_ResidesOnExtentCIM_LogicalElementDependent
CIM_OperationLogCIM_LogicalElementDependent
CIM_LogicalElementUnitOfWorkDefCIM_LogicalElementAntecedent
CIM_LogicalElementPerformsUoWCIM_LogicalElementAntecedent
CIM_AllocatedFromStoragePoolCIM_LogicalElementDependent
CIM_AssociatedMemoryCIM_LogicalElementDependent
CIM_DiagnosticTestForMSECIM_ManagedSystemElementDependent
CIM_UseOfLogCIM_ManagedSystemElementDependent
CIM_SystemComponentCIM_ManagedSystemElementPartComponent
CIM_RedundancyComponentCIM_ManagedSystemElementPartComponent
CIM_CollectedMSEsCIM_ManagedSystemElementMember
CIM_ActsAsSpareCIM_ManagedSystemElementSpare
CIM_ElementSettingCIM_ManagedSystemElementElement
CIM_ElementConfigurationCIM_ManagedSystemElementElement
CIM_DiagnosticResultForMSECIM_ManagedSystemElementSystemElement
CIM_DependencyCIM_ManagedElementAntecedent
CIM_DependencyCIM_ManagedElementDependent
CIM_ConcreteDependencyCIM_ManagedElementAntecedent
CIM_ConcreteDependencyCIM_ManagedElementDependent
CIM_HostedDependencyCIM_ManagedElementAntecedent
CIM_HostedDependencyCIM_ManagedElementDependent
CIM_ScopedSettingCIM_ManagedElementAntecedent
CIM_ProvidesServiceToElementCIM_ManagedElementDependent
CIM_ElementSoftwareIdentityCIM_ManagedElementDependent
CIM_RecordAppliesToElementCIM_ManagedElementDependent
CIM_AuthenticationTargetCIM_ManagedElementDependent
CIM_ElementAsUserCIM_ManagedElementAntecedent
CIM_AuthorizationSubjectCIM_ManagedElementDependent
CIM_AuthorizationTargetCIM_ManagedElementDependent
CIM_MetricDefForMECIM_ManagedElementAntecedent
CIM_MetricForMECIM_ManagedElementAntecedent
CIM_ComponentCIM_ManagedElementGroupComponent
CIM_ComponentCIM_ManagedElementPartComponent
CIM_ConcreteComponentCIM_ManagedElementGroupComponent
CIM_ConcreteComponentCIM_ManagedElementPartComponent
CIM_LogicalIdentityCIM_ManagedElementSystemElement
CIM_LogicalIdentityCIM_ManagedElementSameElement
CIM_ConcreteIdentityCIM_ManagedElementSystemElement
CIM_ConcreteIdentityCIM_ManagedElementSameElement
CIM_SynchronizedCIM_ManagedElementSystemElement
CIM_SynchronizedCIM_ManagedElementSyncedElement
CIM_StorageSynchronizedCIM_ManagedElementSystemElement
CIM_StorageSynchronizedCIM_ManagedElementSyncedElement
CIM_ServiceAvailableToElementCIM_ManagedElementUserOfService
CIM_ServiceAffectsElementCIM_ManagedElementAffectedElement
CIM_SAPAvailableForElementCIM_ManagedElementManagedElement
CIM_ElementLocationCIM_ManagedElementElement
CIM_MemberOfCollectionCIM_ManagedElementMember
CIM_MemberPrincipalCIM_ManagedElementMember
CIM_ElementInPolicyRoleCollectionCIM_ManagedElementMember
CIM_ElementCapabilitiesCIM_ManagedElementManagedElement
CIM_ElementSettingDataCIM_ManagedElementManagedElement
CIM_ElementProfileCIM_ManagedElementManagedElement
CIM_ElementStatisticalDataCIM_ManagedElementManagedElement
CIM_StatisticsCIM_ManagedElementElement
CIM_ParameterValueSourcesCIM_ManagedElementValueSource
CIM_ParametersForMethodCIM_ManagedElementTheMethod
CIM_OwningJobElementCIM_ManagedElementOwningElement
CIM_AffectedJobElementCIM_ManagedElementAffectedElement
CIM_ElementConformsToProfileCIM_ManagedElementManagedElement
CIM_IdentityContextCIM_ManagedElementElementProvidingContext
CIM_AssignedIdentityCIM_ManagedElementManagedElement
CIM_ElementSecuritySensitivityCIM_ManagedElementManagedElement
CIM_AuthorizedSubjectCIM_ManagedElementPrivilegedElement
CIM_AuthorizedTargetCIM_ManagedElementTargetElement
CIM_PolicySetAppliesToElementCIM_ManagedElementManagedElement