Network\CIM_MPLSTunnel.mof.mof (HTML version)

Return to index
CIM_MPLSTunnel Superclass: CIM_EnabledLogicalElement
This class represents an MPLS traffic engineering tunnel as defined in RFC 3031.
Qualifiers:Version ( "2.8.1000" ) Experimental UMLPackagePath ( "CIM::Network::MPLS" )
Parameters (local in grey)
Override ( "ElementName" )
string ElementName ;
The canonical name assigned to the tunnel. This name can be used to refer to the tunnel on the LSR's console port.
uint32 TunnelInstancePriority ;
This value represents the priority for a tunnel in descending order, with 0 indicating the lowest priority, within a group of tunnels used for redundancy/load sharing. Tunnel group priorities are used to denote the priority at which a particular tunnel instance will supercede another. Instances of tunnels containing the same TunnelInstancePriority will be used for load sharing.
boolean IngressMayReroute ;
Flag to indicate that the tunnel ingress node may choose to reroute this tunnel without tearing it down.
Key
string InstanceID ;
InstanceID opaquely identifies a unique instance of SettingData. The InstanceID must be unique within a namespace. In order to ensure uniqueness, the value of InstanceID SHOULD be constructed in the following manner:
<Vendor ID><ID>
<Vendor ID> MUST include a copyrighted, trademarked or otherwise unique name that is owned by the business entity or a registered ID that is assigned to the business entity that is defining the InstanceID. (This is similar to the <Schema Name>_<Class Name> structure of Schema class names). The purpose of <Vendor ID> is to ensure that <ID> is truly unique across multiple vendor implementations. If such a name is not used, the defining entity MUST assure that the <ID> portion of the Instance ID is unique when compared with other instance providers. For DMTF defined instances, the <Vendor ID> is 'CIM'.
<ID> MUST include a vendor specified unique identifier.
Write
boolean Established ;
Boolean indicating whether or not the tunnel is currently signaled. Note that if the tunnel is not established, then the OperationalStatus properties inherited from Managed SystemElement have no meaning.
Punit ( "bit / second * 10^3" )
Units ( "KiloBits per Second" )
uint32 ActiveBandwidth ;
Active bandwidth for this tunnel in kilobits per second. If the tunnel is not yet Established, then this property has no meaning. Knowing current Bandwidth is important because several path options may be configured for the tunnel. Note that it is possible to signal 0 bandwidth for a pure best- effort tunnel.
MappingStrings { "MIB.IETF|MPLS-TE-MIB.MPLSTunnelIncludeAllAffinity" }
uint32 IncludeAllAffinity ;
Resource classes and resource class affinities are described in [RFC2702]. Resource classes can be associated with links and advertised in routing protocols. Resource class affinities are used by RSVP-TE [RFC3209]. In order to be used, a link MUST pass three tests. One of them against this property.

IncludeAllAffinity is one type of resource class affinity. It specifies a set of attribute filters for the tunnel, and all of the filters must match for a link to be acceptable (i.e., pass this test). If IncludeAllAffinity is zero, then the test automatically passes. The test takes the form,
(IncludeAllAffinity == 0) || (((MPLSProtocolEndpoint.ResourceClass & IncludeAllAffinity) ^ IncludeAllAffinity) == 0)
Punit ( "bit / second * 10^3" )
Units ( "KiloBits per Second" )
uint32 Bandwidth ;
The bandwidth property denotes the complete bandwidth (in kilobits per second) required to be transported by the tunnel. Note, that the bandwidth is not directly implemented/ configured in a router, but the MPLSTunnel's Reserved Bandwidth property might be derived from this information.
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" }
Values { "Unknown" , "Other" , "Admin" , "RSVP" , "CRDLP" , "Policy Agent" }
uint8 TunnelManagementOwner ;
Indicates which protocol created and is responsible for managing this tunnel. Values rsvp(3) and crldp(4) should NOT be used at the head-end of an MPLS tunnel.
MaxValue ( 7 )
MinValue ( 0 )
MappingStrings { "MIB.IETF|MPLS-TE-MIB.mplsTunnelHoldingPrio" }
uint8 HoldingPriority ;
Property to indicate the holding priority of an established tunnel. If the tunnel is not yet established, this property has no meaning. A new tunnel is allowed to preempt the resources of this tunnel only if its SetupPriority is smaller than the HoldingPriority of the established one. (See RFC3209 for additional information.) The value 0 is the highest priority.
boolean LocalProtectionAvailable ;
Flag to indicate that transit routers are permitted to use a local repair mechanism which may result in violation of the explicit routing of this tunnel. When a fault is detected on an adjacent downstream link or node, a transit router can reroute traffic for fast service restoration.
boolean IsAdaptive ;
In some situations, it is necessary to reroute a tunnel without disrupting traffic. This flag indicates whether the tunnel's route is adaptive.
boolean Lockdown = true ;
Indicates whether the tunnel is a candidate for re-optimization at all. If true the ReoptimizationFreq property should be taken into account. By default, a tunnel is re-optimized periodically.
ValueMap { "0" , "2" , "3" , "4" }
Values { "Unknown" , "Head" , "Transit" , "Tail" }
uint16 TunnelRole ;
This property signifies the role that this tunnel entry/instance represents. The value MUST be set to head(2) at the originating point of the tunnel, to transit(3) at transit points along the tunnel (if transit points are supported), and to tail(4) at the terminating point of the tunnel (if tunnel tails are supported).
ValueMap { "0" , "1" , "2" , "3" , "4" }
Values { "Unknown" , "Other" , "None" , "RSVP" , "CRLDP" }
uint8 TunnelSignalingProtocol ;
The signaling protocol, if any, which was used to setup this tunnel.
Punit ( "bit / second * 10^3" )
Units ( "KiloBits per Second" )
uint32 ReservedBandwidth ;
Reserved bandwidth for this tunnel in kilobits per second. In a load sharing environment, the bandwidth on each tunnel is set to be proportional to how traffic should be balanced. An LSR then load-shares into the tunnels based on the aggregate bandwidth. Note that it is possible to signal 0 bandwidth for a pure best-effort tunnel.
uint32 EgressLSRId ;
ID of egress LSR.
boolean IsPinned ;
Flag to indicate whether the loosely-routed hops of this tunnel are to be pinned.
boolean IsDynamicallyRouted ;
Flag to indicate whether the route for the tunnel is selected dynamically based on routing protocols - as opposed to being specified 'statically' via configuration, where a network operator or other external entity specifies the path of the tunnel hop by hop.
MappingStrings { "MIB.IETF|MPLS-TE-MIB.MPLSTunnelIncludeAnyAffinity" }
uint32 IncludeAnyAffinity ;
Resource classes and resource class affinities are described in [RFC2702]. Resource classes can be associated with links and advertised in routing protocols. Resource class affinities are used by RSVP-TE [RFC3209]. In order to be used, a link MUST pass three tests. One of them against this property.

IncludeAnyAffinity is one type of resource class affinity. It specifies a set of attribute filters for the tunnel, and any of the filters must match for a link to be acceptable (i.e., pass this test). If IncludeAllAffinity is zero, then the test automatically passes. The test takes the form,
(IncludeAnyAffinity == 0) || ((MPLSProtocolEndpoint.ResourceClass & IncludeAnyAffinity) != 0)
MaxValue ( 7 )
MinValue ( 0 )
MappingStrings { "MIB.IETF|MPLS-TE-MIB.mplsTunnelSetupPrio" }
uint8 SetupPriority ;
Guaranteed bandwidth tunnels can have setup and preemption priorities associated with them. These priorities determine if an existing tunnel can be preempted by a new one. The SetupPriority of the new tunnel is compared to the Holding Priority of the established one, to determine if the new tunnel can preempt the existing one. It does preempt if the SetupPriority in smaller than the HoldingPriority. Note that the value 0 is the highest priority.
boolean IsPersistent ;
Flag to indicate that this tunnel should be restored automatically after a failure occurs.
boolean IsResilient ;
The IsResilient property indicates the recovery procedure to be applied to tunnels whose paths are impacted by faults. More specifically, it contains a boolean value that determines whether the tunnel is to be rerouted or not, when segments of its path fail. If set to true, the tunnel should be rerouted in case of failure; if false, it should not (which means that other means are applied, e.g. lower layer technologies for rerouting.)
Punit ( "second" )
MaxValue ( 604800 )
Units ( "Seconds" )
uint32 ReoptimizationFreq = 3600 ;
Due to changes in network and traffic characteristics, there may be a need to periodically change the paths of tunnels for optimization purposes. This should not be done too frequently as it could adversely affect the stability of the network. This property indicates how often such reoptimization should be performed for a specific tunnel. Note that the class, CIM_MPLSTEService, also has a reoptimization frequency property. The frequency specified in this class is specific to a particular tunnel, whereas the MPLSTEService's frequency is per service, on a Label Switched Router.
MappingStrings { "MIB.IETF|MPLS-TE-MIB.MPLSTunnelExcludeAllAffinity" }
uint32 ExcludeAllAffinity ;
Resource classes and resource class affinities are described in [RFC2702]. Resource classes can be associated with links and advertised in routing protocols. Resource class affinities are used by RSVP-TE [RFC3209]. In order to be used, a link MUST pass three tests. One of them is against this property.

ExcludeAllAffinity is one type of resource class affinity. It specifies a set of attribute filters for the tunnel, and a match on any of the filters renders a link unacceptable (it is excluded for consideration). This test takes the form,
(MPLSProtocolEndpoint.ResourceClass & ExcludeAllAffinity) == 0.
ModelCorrespondence { "CIM_MPLSTunnel.TunnelSignalingProtocol" }
uint32 IngressLSRId ;
The purpose of this object is to uniquely identity a tunnel within a network. When the MPLS signaling protocol is rsvp(3), this value SHOULD mimic the Extended Tunnel Id field in the SESSION object. When the MPLS signaling protoocol is crldp(4), this value SHOULD mimic the Ingress LSR Router ID field in the LSPID TLV object.
datetime TimeOfLastStateChange ;
The date or time when the EnabledState of the element 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.
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , ".." , "4096" , "4097" , "4098" , "4099" , "4100..32767" , "32768..65535" }
Values { "Completed with No Error" , "Not Supported" , "Unknown or Unspecified Error" , "Cannot complete within Timeout Period" , "Failed" , "Invalid Parameter" , "In Use" , "DMTF Reserved" , "Method Parameters Checked - Job Started" , "Invalid State Transition" , "Use of Timeout Parameter Not Supported" , "Busy" , "Method Reserved" , "Vendor Specific" }
ModelCorrespondence { "CIM_EnabledLogicalElement.RequestedState" }
uint32RequestStateChange(
The state requested for the element. This information will be placed into the RequestedState property of the instance if the return code of the RequestStateChange method is 0 ('Completed with No Error'), 3 ('Timeout'), or 4096 (0x1000) ('Job Started'). Refer to the description of the EnabledState and RequestedState properties for the detailed explanations of the RequestedState values.
Qualifiers:ValueMap { "2" , "3" , "4" , "6" , "7" , "8" , "9" , "10" , "11" , ".." , "32768..65535" } Values { "Enabled" , "Disabled" , "Shut Down" , "Offline" , "Test" , "Defer" , "Quiesce" , "Reboot" , "Reset" , "DMTF Reserved" , "Vendor Reserved" } ModelCorrespondence { "CIM_EnabledLogicalElement.RequestedState" } IN
uint16 RequestedState
Reference to the job (can be null if the task is completed).
Qualifiers:OUT IN ( false )
CIM_ConcreteJob REF Job
A timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format must be used to specify the TimeoutPeriod. A value of 0 or a null parameter indicates that the client has no time requirements for the transition.
If this property does not contain 0 or null and the implementation does not support this parameter, a return code of 'Use Of Timeout Parameter Not Supported' must be returned.

Qualifiers:IN
datetime TimeoutPeriod
)
Requests that the state of the element be changed to the value specified in the RequestedState parameter. When the requested state change takes place, the EnabledState and RequestedState of the element will be the same. Invoking the RequestStateChange method multiple times could result in earlier requests being overwritten or lost.
If 0 is returned, then the task completed successfully and the use of ConcreteJob was not required. If 4096 (0x1000) is returned, then the task will take some time to complete, ConcreteJob will be created, and its reference returned in the output parameter Job. Any other return code indicates an error condition.
ValueMap { "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , ".." , "32768..65535" }
Values { "Enabled" , "Disabled" , "Shut Down" , "No Change" , "Offline" , "Test" , "Deferred" , "Quiesce" , "Reboot" , "Reset" , "Not Applicable" , "DMTF Reserved" , "Vendor Reserved" }
ModelCorrespondence { "CIM_EnabledLogicalElement.EnabledState" }
uint16 RequestedState = 12 ;
RequestedState is an integer enumeration that indicates 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 or disabled states. Note that when EnabledState is set to 5 ('Not Applicable'), then this property has no meaning. By default, the RequestedState of the element is 5 ('No Change'). Refer to the EnabledState property description for explanations of the values in the RequestedState enumeration.
Offline (6) indicates that the element has been requested to transition to the Enabled but Offline EnabledState.
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). Reboot refers to doing a 'Shut Down' and then moving to an 'Enabled' state. Reset indicates that the element is first 'Disabled' and then 'Enabled'. The distinction between requesting 'Shut Down' and 'Disabled' should also be noted. Shut Down requests an orderly transition to the Disabled state, and might involve removing power, to completely erase any existing state. 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 can be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, because it allows an explicit invocation of the operation and the return of a result code.

A particular instance of EnabledLogicalElement might not support RequestedStateChange. If this occurs, the value 12 ('Not Applicable') is used.
ValueMap { "2" , "3" , "5" , "6" , "7" , "9" , ".." , "32768..65535" }
Values { "Enabled" , "Disabled" , "Not Applicable" , "Enabled but Offline" , "No Default" , "Quiesce" , "DMTF Reserved" , "Vendor Reserved" }
Write
uint16 EnabledDefault = 2 ;
An enumerated value indicating an administrator's default or startup configuration for the Enabled State of an element. By default, the element is 'Enabled' (value=2).
ModelCorrespondence { "CIM_EnabledLogicalElement.EnabledState" }
string OtherEnabledState ;
A string that describes the enabled or disabled state of the element when the EnabledState property is set to 1 ('Other'). This property must be set to null when EnabledState is any value other than 1.
ValueMap { "0" , "1" , "2" , "3" , ".." , "0x8000.." }
Values { "Unknown" , "OK" , "Degraded" , "Error" , "DMTF Reserved" , "Vendor Reserved" }
Experimental
ModelCorrespondence { "CIM_ManagedSystemElement.DetailedStatus" , "CIM_ManagedSystemElement.HealthState" }
uint16 PrimaryStatus ;
PrimaryStatus provides a high level status value, intended to align with Red-Yellow-Green type representation of status. It should be used in conjunction with DetailedStatus to provide high level and detailed health status of the ManagedElement and its subcomponents.
PrimaryStatus consists of one of the following values: Unknown, OK, Degraded or Error. 'Unknown' indicates the implementation is in general capable of returning this property, but is unable to do so at this time.
'OK' indicates the ManagedElement is functioning normally.
'Degraded' indicates the ManagedElement is functioning below normal.
'Error' indicates the ManagedElement is in an Error condition.
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , "13" , "14" , ".." , "0x8000.." }
Values { "Unknown" , "Not Available" , "In Service" , "Starting" , "Stopping" , "Stopped" , "Aborted" , "Dormant" , "Completed" , "Migrating" , "Emigrating" , "Immigrating" , "Snapshotting" , "Shutting Down" , "In Test" , "DMTF Reserved" , "Vendor Reserved" }
Experimental
ModelCorrespondence { "CIM_EnabledLogicalElement.EnabledState" }
uint16 OperatingStatus ;
OperatingStatus provides a current status value for the operational condition of the element and can be used for providing more detail with respect to the value of EnabledState. It can also provide the transitional states when an element is transitioning from one state to another, such as when an element is transitioning between EnabledState and RequestedState, as well as other transitional conditions.
OperatingStatus consists of one of the following values: Unknown, Not Available, In Service, Starting, Stopping, Stopped, Aborted, Dormant, Completed, Migrating, Emmigrating, Immigrating, Snapshotting. Shutting Down, In Test
A Null return indicates the implementation (provider) does not implement this property.
'Unknown' indicates the implementation is in general capable of returning this property, but is unable to do so at this time.
'None' indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property).
'In Service' describes an element being configured, maintained, cleaned, or otherwise administered.
'Starting' describes an element being initialized.
'Stopping' describes an element being brought to an orderly stop.
'Stopped' and 'Aborted' are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the state and configuration of the element might need to be updated.
'Dormant' indicates that the element is inactive or quiesced.
'Completed' indicates that the element has completed its operation. This value should be combined with either OK, Error, or Degraded in the PrimaryStatus so that a client can tell if the complete operation Completed with OK (passed), Completed with Error (failed), or Completed with Degraded (the operation finished, but it did not complete OK or did not report an error).
'Migrating' element is being moved between host elements.
'Immigrating' element is being moved to new host element.
'Emigrating' element is being moved away from host element.
'Shutting Down' describes an element being brought to an abrupt stop.
'In Test' element is performing test functions.
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11..32767" , "32768..65535" }
Values { "Unknown" , "Other" , "Enabled" , "Disabled" , "Shutting Down" , "Not Applicable" , "Enabled but Offline" , "In Test" , "Deferred" , "Quiesce" , "Starting" , "DMTF Reserved" , "Vendor Reserved" }
ModelCorrespondence { "CIM_EnabledLogicalElement.OtherEnabledState" }
uint16 EnabledState = 5 ;
EnabledState is an integer enumeration that indicates the enabled and 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 and disabled states:
Enabled (2) indicates that the element is or 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 does not support being enabled or disabled.
Enabled but Offline (6) indicates that the element might 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 might be completing commands, but will queue any new requests.
Quiesce (9) indicates that the element is enabled but in a restricted mode.
Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued.
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , ".." , "0x8000.." }
Values { "Not Available" , "No Additional Information" , "Stressed" , "Predictive Failure" , "Non-Recoverable Error" , "Supporting Entity in Error" , "DMTF Reserved" , "Vendor Reserved" }
Experimental
ModelCorrespondence { "CIM_EnabledLogicalElement.PrimaryStatus" , "CIM_ManagedSystemElement.HealthState" }
uint16 DetailedStatus ;
DetailedStatus compliments PrimaryStatus with additional status detail. It consists of one of the following values: Not Available, No Additional Information, Stressed, Predictive Failure, Error, Non-Recoverable Error, SupportingEntityInError. Detailed status is used to expand upon the PrimaryStatus of the element.
A Null return indicates the implementation (provider) does not implement this property.
'Not Available' indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property).
'No Additional Information' indicates that the element is functioning normally as indicated by PrimaryStatus = 'OK'.
'Stressed' indicates that the element is functioning, but needs attention. Examples of 'Stressed' states are overload, overheated, and so on.
'Predictive Failure' indicates that an element is functioning normally but a failure is predicted in the near future.
'Non-Recoverable Error ' indicates that this element is in an error condition that requires human intervention.
'Supporting Entity in Error' indicates that this element might 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.
ValueMap { "0" , "1" , "2" , "3" , "4" , ".." , "0x8000.." }
Values { "Unknown" , "Not Available" , "Communication OK" , "Lost Communication" , "No Contact" , "DMTF Reserved" , "Vendor Reserved" }
Experimental
uint16 CommunicationStatus ;
CommunicationStatus indicates the ability of the instrumentation to communicate with the underlying ManagedElement. CommunicationStatus consists of one of the following values: Unknown, None, Communication OK, Lost Communication, or No Contact.
A Null return indicates the implementation (provider) does not implement this property.
'Unknown' indicates the implementation is in general capable of returning this property, but is unable to do so at this time.
'Not Available' indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property).
'Communication OK ' indicates communication is established with the element, but does not convey any quality of service.
'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 Managed Element is known to exist and has been contacted successfully in the past, but is currently unreachable.
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , "13" , "14" , "15" , "16" , "17" , "18" , ".." , "0x8000.." }
ArrayType ( "Indexed" )
Values { "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" }
ModelCorrespondence { "CIM_ManagedSystemElement.StatusDescriptions" }
uint16 OperationalStatus [ ] ;
Indicates the current statuses of the element. Various operational statuses are defined. Many of the enumeration's values are self-explanatory. However, a few are not and are described here in more detail.
'Stressed' indicates that the element is functioning, but needs attention. Examples of 'Stressed' states are overload, overheated, and so on.
'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 state and configuration of the element might need to be updated.
'Dormant' indicates that the element is inactive or quiesced.
'Supporting Entity in Error' indicates that this element might 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 that the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can tell if the complete operation Completed with OK (passed), Completed with Error (failed), or Completed with Degraded (the operation finished, but it did not complete OK or did not report an error).
'Power Mode' indicates that 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 because it required the deprecated qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly recommended that providers or 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 (because it is single-valued) should also provide the primary status of the element.
ArrayType ( "Indexed" )
ModelCorrespondence { "CIM_ManagedSystemElement.OperationalStatus" }
string StatusDescriptions [ ] ;
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.
ValueMap { "OK" , "Error" , "Degraded" , "Unknown" , "Pred Fail" , "Starting" , "Stopping" , "Service" , "Stressed" , "NonRecover" , "No Contact" , "Lost Comm" , "Stopped" }
MaxLen ( 10 )
Deprecated { "CIM_ManagedSystemElement.OperationalStatus" }
string Status ;
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 definition overcomes the limitation of describing status using a single value, when it is really a multi-valued property (for example, an element might be OK AND Stopped.
2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values.
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.
MappingStrings { "MIF.DMTF|ComponentID|001.5" }
datetime InstallDate ;
A datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed.
MaxLen ( 1024 )
string Name ;
The Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property.
ValueMap { "0" , "5" , "10" , "15" , "20" , "25" , "30" , ".." }
Values { "Unknown" , "OK" , "Degraded/Warning" , "Minor failure" , "Major failure" , "Critical failure" , "Non-recoverable error" , "DMTF Reserved" }
uint16 HealthState ;
Indicates the current health of the element. This attribute expresses the health of this element but not necessarily that of its subcomponents. The possible values are 0 to 30, where 5 means the element is entirely healthy and 30 means the element is completely non-functional. The following continuum is defined:
'Non-recoverable Error' (30) - The element has completely failed, and recovery is not possible. All functionality provided by this element has been lost.
'Critical Failure' (25) - The element is non-functional and recovery might not be possible.
'Major Failure' (20) - The element is failing. It is possible that some or all of the functionality of this component is degraded or not working.
'Minor Failure' (15) - All functionality is available but some might be degraded.
'Degraded/Warning' (10) - The element is in working order and all functionality is provided. However, the element is not working to the best of its abilities. For example, the element might not be operating at optimal performance or it might be reporting recoverable errors.
'OK' (5) - The element is fully functional and is operating within normal operational parameters and without error.
'Unknown' (0) - The implementation cannot report on HealthState at this time.
DMTF has reserved the unused portion of the continuum for additional HealthStates in the future.
MaxLen ( 64 )
string Caption ;
The Caption property is a short textual description (one- line string) of the object.
string Description ;
The Description property provides a textual description of the object.