CIM211 Class Declaration
CIM_DatabaseSystem

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

Class Hierarchy

CIM_DatabaseSystem --> CIM_ApplicationSystem --> CIM_System --> CIM_EnabledLogicalElement --> CIM_LogicalElement --> CIM_ManagedSystemElement --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_ApplicationSystem
NAMECIM_DatabaseSystem

Class Qualifiers

Class CIM_DatabaseSystem Qualifiers
NameTypeValueFrom Class
Versionstring2.7.0 CIM_DatabaseSystem
DescriptionstringA database environment is composed of a database system (the application system represented by this class), one or more database services, and one or more databases. See the descriptions of CIM_DatabaseService and CIM_CommonDatabase for get more detailed information about database services and databases. Each separately manageable database system should have an instance in this class. This class can be used: - to determine the software that belongs to the database system. - to perform database system-wide management operations, such as stopping all the databases that were created by the database system for maintenance purposes. - to view runtime statistics in the context of a database system. Many of the management capabilities that are needed to represent a database system as an application system have already been modeled in the CIM_ApplicationSystem class from which CIM_DatabaseSystem extends. CIM_DatabaseSystem provides a logical entity to define the relationships that are specific to the database management domain. CIM_DatabaseSystem
DescriptionstringThe ApplicationSystem class represents an application or a software system that supports a particular business function and that can be managed as an independent unit. Such a system can be decomposed into its functional components using the CIM_SoftwareFeature class. The Features for a particular application or software system are located using the CIM_ApplicationSystemSoftwareFeature association. The features are part of the deployment-oriented aspects of the application system. With regard to the application runtime aspects, the ApplicationSystem class also represents the core class of the Application Systems ’ sub-model which of the application runtime model. Its role in the systems sub-model is a) the root node of the containment hierarchy of the application elements (at runtime) as services, components, sub-systems, etc., b) the place for runtime overview information such as response time or system status, c) runtime control of the entire application (e.g., start/stop), and d) the main entry point to the navigation through and drill-down into the runtime model. The lifetime of an instance of this class is not limited to the application instance it represents. Even if the application is not running, the ApplicationSystem object can report properties that have values (e.g., the name of the application or the current status). Note that it is also possible to define the lifetime of the objects through the lifetime of the application instances. Through ApplicationSystemDependency, non-containment relationships can be expressed. CIM_ApplicationSystem
DescriptionstringCIM_System represents an entity made up of component parts (defined by the SystemComponent relationship), that operates as a ’ functional whole ’ . Systems are top-level objects in the CIM hierarchy, requiring no scoping or weak relationships in order to exist and have context. It should be reasonable to uniquely name and manage a System at an enterprise level. For example, a ComputerSystem is a kind of System that can be uniquely named and independently managed in an enterprise. However, these qualities are not true for the power supply (or the power supply sub- ’ system ’ ) within the computer. Although a System can be viewed as a Collection, this view is not the correct model. A Collection is simply a ’ bag ’ that ’ holds ’ its members. A System is a higher-level abstraction, built out of its individual components. It is more than the sum of its parts. Note that System is a subclass of EnabledLogicalElement which allows the entire abstraction to be functionally enabled or disabled at a higher level than enabling or disabling its component parts. CIM_System
DescriptionstringThis class extends LogicalElement to abstract the concept of an element that is enabled and disabled, such as a LogicalDevice or a ServiceAccessPoint. CIM_EnabledLogicalElement
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
Distributionuint16 Description
ValueMap
Values
CIM_ApplicationSystem
EnabledStateuint160 Override
Description
ValueMap
Values
ModelCorrespondence
CIM_ApplicationSystem
StartupTimedatetime Description CIM_ApplicationSystem
ServingStatusuint16 Description
ValueMap
Values
ModelCorrespondence
CIM_ApplicationSystem
LastServingStatusUpdatedatetime Description
ModelCorrespondence
CIM_ApplicationSystem
CreationClassNamestring Key
Description
MaxLen
CIM_System
Namestring Key
Override
Description
MaxLen
CIM_System
NameFormatstring Description
MaxLen
CIM_System
PrimaryOwnerNamestring Write
Description
MaxLen
MappingStrings
CIM_System
PrimaryOwnerContactstring Write
Description
MaxLen
MappingStrings
CIM_System
Rolesstring[] Write
Description
CIM_System
OtherEnabledStatestring Description
ModelCorrespondence
CIM_EnabledLogicalElement
RequestedStateuint1612 Description
ValueMap
Values
ModelCorrespondence
CIM_EnabledLogicalElement
EnabledDefaultuint162 Write
Description
ValueMap
Values
CIM_EnabledLogicalElement
TimeOfLastStateChangedatetime Description CIM_EnabledLogicalElement
InstallDatedatetime Description
MappingStrings
CIM_ManagedSystemElement
OperationalStatusuint16[] Description
ValueMap
Values
ArrayType
ModelCorrespondence
CIM_ManagedSystemElement
StatusDescriptionsstring[] Description
ArrayType
ModelCorrespondence
CIM_ManagedSystemElement
Statusstring Deprecated
Description
ValueMap
MaxLen
CIM_ManagedSystemElement
HealthStateuint16 Description
ValueMap
Values
CIM_ManagedSystemElement
Captionstring Description
MaxLen
CIM_ManagedElement
Descriptionstring Description CIM_ManagedElement
ElementNamestring Description CIM_ManagedElement

Property Qualifiers

Property Distribution Qualifiers
NameTypeValueFrom Class
DescriptionstringDistribution describes how the application system is distributed with respect to its underlying servers. In general, the application system is distributed or local. This property indicates whether the application system is running on one or multiple servers. This can be determined without having to query for associated servers represented by ComputerSystems. Distributed systems also introduce a virtual notion to themselves. Note that a distributed application system is not tangible but virtual. Only its contained local systems can be found as processes or threads, and can therefore be regarded as tangible. The distributed system remains a named, virtual entity, that scopes strongly bound constituents and allows the application to be managed in its entirety. The property is needed to help root cause analysis and operations, especially when these are automated, in order to clearly know that more than one executed application - most likely the local application systems - is affected by the management task. This is particularly true if the contained application systems provide uniform functionality like webserver or application server farms. To express constraints between distributed and local system, this class must be derived and appropriate associations must be defined. This property should not be confused with the Roles[] property defined in System. The latter is reserved for administrator assigned roles. CIM_ApplicationSystem
ValueMapstring
[See below.]
CIM_ApplicationSystem
ValuesstringUnknown
Distributed
Local
DMTF Reserved
Vendor Specific
CIM_ApplicationSystem

NameValue
0Unknown
1Distributed
2Local
3..32767DMTF Reserved
32768..65535Vendor Specific
Property EnabledState Qualifiers
NameTypeValueFrom Class
OverridestringEnabledState CIM_ApplicationSystem
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 and starting are transient states between enabled and disabled. In contrast to the original version defined higher in the inheritance hierarchy (EnabledLogicalElement), EnabledState is simplified. It reflects the notion of an execution status tailored to applications and represents a summary of the original property. It allows simplified and efficient determination of whether the application is started, stopped or in transition between either of these states. The property does not show any errors. Errors MUST be described in MSE.OperationalStatus, and MAY also be described in logs or other data sources. The mapping to MSE.OperationalStatus is as follows: ExecutionStatus < - MSE.OperationalStatus Unknown < - Unknown, No Contact, Lost Communication, Either of the values < - Other Enabled (started) < - OK, Degraded, Stressed, Predictive Failure, In Service, Dormant, Supporting Entity in Error, Completed Enabled or Disabled (Started or Stopped) < - Error, Non-Recoverable Error Starting < - Starting Shutting Down (Stopping) < - Stopping Disabled (Stopped) < - Stopped, Aborted. The mapping to the original EnabledState property is as follows: Unknown < - Unknown, Not Applicable Either of the values < -Other Enabled < - Enabled, Enabled but Offline, In Test, Deferred, Quiesce Disabled < - Disabled ShuttingDown < - ShuttingDown Starting < - Starting. CIM_ApplicationSystem
ValueMapstring
[See below.]
CIM_ApplicationSystem
ValuesstringUnknown
Enabled
Disabled
Shutting Down
Starting
DMTF Reserved
Vendor Reserved
CIM_ApplicationSystem
ModelCorrespondencestringCIM_EnabledLogicalElement.OtherEnabledState CIM_ApplicationSystem

NameValue
0Unknown
2Enabled
3Disabled
4Shutting Down
10Starting
11..32767DMTF Reserved
32768..65535Vendor Reserved
Property StartupTime Qualifiers
NameTypeValueFrom Class
DescriptionstringThe point in time (date and time) when the application system was last started. If the application system is in a state other the state Enabled (i.e., started and running) this value is not meaningful and the property value MUST be set to all zeros. StartupTime is preferably the point in time when the application is available to the user. Instead, if the provider and/or the instrumentation cannot determine the point in time the application becomes available, the point in time can be used at which the underlying operating system reports successful launch of the application. If no value can be provided the property value MUST be set to all zeros. CIM_ApplicationSystem

Property ServingStatus Qualifiers
NameTypeValueFrom Class
DescriptionstringServingStatus is a summary of MSE.OperationalStatus. It allows simplified and efficient determination of whether the application is providing service or has stopped doing so for various reasons like errors, shutdown, abort, etc. Therefore, no transitional values are provided. The property does not show any errors. Errors MUST be described in MSE.OperationalStatus, and MAY also be described in logs or other data sources. Therefore, ServingStatus is suited to provide summary information for monitoring purposes and service level management. The mapping to MSE.OperationalStatus is as follows: ServingStatus < - MSE.OperationalStatus Unknown < - Unknown, No Contact, Lost Communication Either of the values < - Other Serving < - OK, Degraded, Stressed, Predictive Failure, Completed Not Serving < - Error, Non-Recoverable Error, Starting, Stopping, Stopped, In Service, Aborted, Dormant, Supporting Entity in Error. CIM_ApplicationSystem
ValueMapstring
[See below.]
CIM_ApplicationSystem
ValuesstringUnknown
Serving
Not Serving
DMTF Reserved
Vendor Specific
CIM_ApplicationSystem
ModelCorrespondencestringCIM_ManagedSystemElement.OperationalStatus CIM_ApplicationSystem

NameValue
0Unknown
1Serving
2Not Serving
5..4096DMTF Reserved
4097..65535Vendor Specific
Property LastServingStatusUpdate Qualifiers
NameTypeValueFrom Class
DescriptionstringThe point in time at which the ServingStatus property was last updated. CIM_ApplicationSystem
ModelCorrespondencestringCIM_ApplicationSystem.ServingStatus CIM_ApplicationSystem

Property CreationClassName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_System
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_System
MaxLenuint32256 CIM_System

Property Name Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_System
OverridestringName CIM_System
DescriptionstringThe inherited Name serves as the key of a System instance in an enterprise environment. CIM_System
MaxLenuint32256 CIM_System

Property NameFormat Qualifiers
NameTypeValueFrom Class
DescriptionstringThe System object and its derivatives are top-level objects of CIM. They provide the scope for numerous components. Having unique System keys is required. A heuristic can be defined in individual System subclasses to attempt to always generate the same System Name Key. The NameFormat property identifies how the System name was generated, using the heuristic of the subclass. CIM_System
MaxLenuint3264 CIM_System

Property PrimaryOwnerName Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_System
DescriptionstringThe name of the primary system owner. The system owner is the primary user of the system. CIM_System
MaxLenuint3264 CIM_System
MappingStringsstringMIF.DMTF|General Information|001.3 CIM_System

Property PrimaryOwnerContact Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_System
DescriptionstringA string that provides information on how the primary system owner can be reached (for example, phone number, e-mail address, and so on). CIM_System
MaxLenuint32256 CIM_System
MappingStringsstringMIF.DMTF|General Information|001.4 CIM_System

Property Roles Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_System
DescriptionstringAn array (bag) of strings that specifies the administrator -defined roles this System plays in the managed environment. Examples might be ’ Building 8 print server ’ or ’ Boise user directories ’ . A single system may perform multiple roles. Note that the instrumentation view of the ’ roles ’ of a System is defined by instantiating a specific subclass of System, or by properties in a subclass, or both. For example, the purpose of a ComputerSystem is defined using the Dedicated and OtherDedicatedDescription properties. CIM_System

Property EnabledState Qualifiers
NameTypeValueFrom Class
DescriptionstringEnabledState 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. The behavior of the element is similar to the Enabled state, but it processes only 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. CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringUnknown
Other
Enabled
Disabled
Shutting Down
Not Applicable
Enabled but Offline
In Test
Deferred
Quiesce
Starting
DMTF Reserved
Vendor Reserved
CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.OtherEnabledState CIM_EnabledLogicalElement

NameValue
0Unknown
1Other
2Enabled
3Disabled
4Shutting Down
5Not Applicable
6Enabled but Offline
7In Test
8Deferred
9Quiesce
10Starting
11..32767DMTF Reserved
32768..65535Vendor Reserved
Property OtherEnabledState Qualifiers
NameTypeValueFrom Class
DescriptionstringA 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. CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledState CIM_EnabledLogicalElement

Property RequestedState Qualifiers
NameTypeValueFrom Class
DescriptionstringRequestedState 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. 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. CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringEnabled
Disabled
Shut Down
No Change
Offline
Test
Deferred
Quiesce
Reboot
Reset
Not Applicable
DMTF Reserved
Vendor Reserved
CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledState CIM_EnabledLogicalElement

NameValue
2Enabled
3Disabled
4Shut Down
5No Change
6Offline
7Test
8Deferred
9Quiesce
10Reboot
11Reset
12Not Applicable
..DMTF Reserved
32768..65535Vendor Reserved
Property EnabledDefault Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_EnabledLogicalElement
DescriptionstringAn 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). CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringEnabled
Disabled
Not Applicable
Enabled but Offline
No Default
DMTF Reserved
Vendor Reserved
CIM_EnabledLogicalElement

NameValue
2Enabled
3Disabled
5Not Applicable
6Enabled but Offline
7No Default
8..32767DMTF Reserved
32768..65535Vendor Reserved
Property TimeOfLastStateChange Qualifiers
NameTypeValueFrom Class
DescriptionstringThe 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. CIM_EnabledLogicalElement

Property InstallDate Qualifiers
NameTypeValueFrom Class
DescriptionstringA datetime value that indicates when the object was installed. 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 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. 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 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. 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 HealthState Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates 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. CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
ValuesstringUnknown
OK
Degraded/Warning
Minor failure
Major failure
Critical failure
Non-recoverable error
DMTF Reserved
CIM_ManagedSystemElement

NameValue
0Unknown
5OK
10Degraded/Warning
15Minor failure
20Major failure
25Critical failure
30Non-recoverable error
..DMTF Reserved
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 the Name property of ManagedSystemElement 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 can be present in both the Name and ElementName properties. CIM_ManagedElement

Methods

NameTypeValueQualifiersParametersClassOrigin
StartApplicationuint16 Description
ValueMap
Values
ModelCorrespondence
 CIM_ApplicationSystem
StopApplicationuint16 Description
ValueMap
Values
ModelCorrespondence
 CIM_ApplicationSystem
RequestStateChangeuint32 Description
ValueMap
Values
ModelCorrespondence
RequestedState
TimeoutPeriod
CIM_EnabledLogicalElement

Method Qualifiers

Method StartApplication Qualifiers
NameTypeValueFrom Class
DescriptionstringStartApplication() starts an application system. The ApplicationSystem object must have been created prior to the invocation of this method. It is up to the implementation of the method to define which of the contained or dependent sub-elements are to be started and in which order their startup may occur. Since a system startup can extend over long periods of time (several minutes is not unusual for complex distributed applications), the method can be implemented synchronously or asynchronously. In both cases EnabledState and RequestedState reflect the current state of the application and the desired state (Enabled) respectively. The exact nature of the errors during the startup cannot be determined in the asynchronous case. The method must return one of the following values: Unspecified Error: If no return code can be identified Completed with No Error: successful invocation Start Already in Progress: application still being started Failed:Indicates errors upon execution. CIM_ApplicationSystem
ValueMapstring
[See below.]
CIM_ApplicationSystem
ValuesstringUnspecified Error
Completed with No Error
Start Already in Progress
Failed
DMTF Reserved
Method Reserved
Vendor Specific
CIM_ApplicationSystem
ModelCorrespondencestringCIM_ApplicationSystem.EnabledState
CIM_ApplicationSystem.RequestedState
CIM_ApplicationSystem

Method StopApplication Qualifiers
NameTypeValueFrom Class
DescriptionstringStopApplication() allows for stopping/shutting down an application system. It is up to the implementation of the method to define which of the contained or dependent sub-elements are to be stopped and in which order their stop has to occur. Since a system shutdown can last considerable time (several minutes is not necessarily unusual for complex distributed applications), the method can be implemented synchronously or asynchronously. In both cases EnabledState and RequestedState reflect the current state of the application and the desired state (Disabled) respectively. The exact nature of the errors during the stop cannot be determined in the asynchronous case. The method must return one of the following: Unspecified Error: If no return code can be identified Completed with No Error: successful invocation Stop Already in Process: application is shutting down Failed: Indicates errors upon execution. CIM_ApplicationSystem
ValueMapstring
[See below.]
CIM_ApplicationSystem
ValuesstringUnspecified Error
Completed with No Error
Stop Already in Process
Failed
DMTF Reserved
Method Reserved
Vendor Specific
CIM_ApplicationSystem
ModelCorrespondencestringCIM_ApplicationSystem.EnabledState
CIM_ApplicationSystem.RequestedState
CIM_ApplicationSystem

Method RequestStateChange Qualifiers
NameTypeValueFrom Class
DescriptionstringRequests 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. CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringCompleted 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
CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.RequestedState CIM_EnabledLogicalElement

Parameters

Method RequestStateChange Parameters
NameTypeQualifiers
RequestedStateuint16IN
Description
ValueMap
Values
ModelCorrespondence
TimeoutPerioddatetimeIN
Description

Parameter Qualifiers

Parameter RequestedState Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_EnabledLogicalElement
DescriptionstringThe 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. CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringEnabled
Disabled
Shut Down
Offline
Test
Defer
Quiesce
Reboot
Reset
DMTF Reserved
Vendor Reserved
CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.RequestedState CIM_EnabledLogicalElement

Parameter TimeoutPeriod Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_EnabledLogicalElement
DescriptionstringA 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. CIM_EnabledLogicalElement

Associations this class can participate in

Association
Class
Reference
Class
Role
CIM_AssociatedDatabaseSystemCIM_DatabaseSystemAntecedent
CIM_ApplicationSystemSoftwareFeatureCIM_ApplicationSystemGroupComponent
CIM_ApplicationSystemHierarchyCIM_ApplicationSystemGroupComponent
CIM_ApplicationSystemHierarchyCIM_ApplicationSystemPartComponent
CIM_ApplicationSystemDependencyCIM_ApplicationSystemAntecedent
CIM_ApplicationSystemDependencyCIM_ApplicationSystemDependent
CIM_AssociatedAppSystemOverviewStatisticsCIM_ApplicationSystemManagedElement
CIM_ApplicationSystemDirectoryCIM_ApplicationSystemDependent
CIM_SystemComponentCIM_SystemGroupComponent
CIM_SystemDeviceCIM_SystemGroupComponent
CIM_AccountOnSystemCIM_SystemGroupComponent
CIM_HostedFileSystemCIM_SystemGroupComponent
CIM_HostedStoragePoolCIM_SystemGroupComponent
CIM_ResourceOfSystemCIM_SystemGroupComponent
CIM_ConfigurationForSystemCIM_SystemAntecedent
CIM_HostedAccessPointCIM_SystemAntecedent
CIM_HostedACICIM_SystemAntecedent
CIM_HostedAuthenticationRequirementCIM_SystemAntecedent
CIM_HostedCollectionCIM_SystemAntecedent
CIM_PolicyRoleCollectionInSystemCIM_SystemAntecedent
CIM_HostedJobDestinationCIM_SystemAntecedent
CIM_HostedRouteCIM_SystemAntecedent
CIM_HostedServiceCIM_SystemAntecedent
CIM_HostedBootServiceCIM_SystemAntecedent
CIM_HostedShareCIM_SystemAntecedent
CIM_PolicyInSystemCIM_SystemAntecedent
CIM_PolicySetInSystemCIM_SystemAntecedent
CIM_PolicyGroupInSystemCIM_SystemAntecedent
CIM_PolicyRuleInSystemCIM_SystemAntecedent
CIM_SettingForSystemCIM_SystemAntecedent
CIM_SystemAdministratorCIM_SystemAntecedent
CIM_SystemAdministratorGroupCIM_SystemAntecedent
CIM_SystemAdministratorRoleCIM_SystemAntecedent
CIM_SystemPackagingCIM_SystemDependent
CIM_ExecutionCandidateCIM_SystemAntecedent
CIM_ExecutionTargetCIM_SystemAntecedent
CIM_IdentificationOfManagedSystemCIM_SystemAntecedent
CIM_IPsecPolicyForSystemCIM_SystemAntecedent
CIM_SecurityServiceForSystemCIM_SystemDependent
CIM_ManagesAccountOnSystemCIM_SystemDependent
CIM_SystemStatisticsCIM_SystemElement
CIM_CollectionInSystemCIM_SystemParent
CIM_InstalledSoftwareIdentityCIM_SystemSystem
CIM_ReplicaPoolForStorageCIM_EnabledLogicalElementAntecedent
CIM_RemoteAccessAvailableToElementCIM_EnabledLogicalElementDependent
CIM_LogicalElementPerformsUoWCIM_LogicalElementAntecedent
CIM_ImportedShareRootCIM_LogicalElementAntecedent
CIM_ImportedShareRootCIM_LogicalElementDependent
CIM_LogicalElementUnitOfWorkDefCIM_LogicalElementAntecedent
CIM_SharedElementRootCIM_LogicalElementAntecedent
CIM_OperationLogCIM_LogicalElementDependent
CIM_AllocatedFromStoragePoolCIM_LogicalElementDependent
CIM_ResidesOnExtentCIM_LogicalElementDependent
CIM_AssociatedMemoryCIM_LogicalElementDependent
CIM_AttachedElementCIM_LogicalElementSystemElement
CIM_AttachedElementCIM_LogicalElementSameElement
CIM_MountedElementCIM_LogicalElementSystemElement
CIM_MountedElementCIM_LogicalElementSameElement
CIM_ImportedShareCIM_LogicalElementSystemElement
CIM_ImportedShareCIM_LogicalElementSameElement
CIM_SharedElementCIM_LogicalElementSystemElement
CIM_RedundancyComponentCIM_ManagedSystemElementPartComponent
CIM_SystemComponentCIM_ManagedSystemElementPartComponent
CIM_UseOfLogCIM_ManagedSystemElementDependent
CIM_DiagnosticTestForMSECIM_ManagedSystemElementDependent
CIM_CollectedMSEsCIM_ManagedSystemElementMember
CIM_DiagnosticResultForMSECIM_ManagedSystemElementSystemElement
CIM_ElementConfigurationCIM_ManagedSystemElementElement
CIM_ElementSettingCIM_ManagedSystemElementElement
CIM_ActsAsSpareCIM_ManagedSystemElementSpare
CIM_ComponentCIM_ManagedElementGroupComponent
CIM_ComponentCIM_ManagedElementPartComponent
CIM_ConcreteComponentCIM_ManagedElementGroupComponent
CIM_ConcreteComponentCIM_ManagedElementPartComponent
CIM_CredentialContextCIM_ManagedElementElementProvidingContext
CIM_DefaultElementCapabilitiesCIM_ManagedElementManagedElement
CIM_DependencyCIM_ManagedElementAntecedent
CIM_DependencyCIM_ManagedElementDependent
CIM_HostedDependencyCIM_ManagedElementAntecedent
CIM_HostedDependencyCIM_ManagedElementDependent
CIM_ScopedSettingCIM_ManagedElementAntecedent
CIM_MetricDefForMECIM_ManagedElementAntecedent
CIM_MetricForMECIM_ManagedElementAntecedent
CIM_RelatedElementCausingErrorCIM_ManagedElementDependent
CIM_RelatedElementCausingErrorCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementDependent
CIM_ConcreteDependencyCIM_ManagedElementAntecedent
CIM_ConcreteDependencyCIM_ManagedElementDependent
CIM_ElementAsUserCIM_ManagedElementAntecedent
CIM_RecordAppliesToElementCIM_ManagedElementDependent
CIM_AuthenticationTargetCIM_ManagedElementDependent
CIM_AuthorizationSubjectCIM_ManagedElementDependent
CIM_AuthorizationTargetCIM_ManagedElementDependent
CIM_ElementSoftwareIdentityCIM_ManagedElementDependent
CIM_IsSpareCIM_ManagedElementAntecedent
CIM_ProvidesServiceToElementCIM_ManagedElementDependent
CIM_ElementCapabilitiesCIM_ManagedElementManagedElement
CIM_IdentityContextCIM_ManagedElementElementProvidingContext
CIM_LogicalIdentityCIM_ManagedElementSystemElement
CIM_LogicalIdentityCIM_ManagedElementSameElement
CIM_ConcreteIdentityCIM_ManagedElementSystemElement
CIM_ConcreteIdentityCIM_ManagedElementSameElement
CIM_SWRManageableAspectCIM_ManagedElementSystemElement
CIM_MemberOfCollectionCIM_ManagedElementMember
CIM_MemberPrincipalCIM_ManagedElementMember
CIM_ElementInPolicyRoleCollectionCIM_ManagedElementMember
CIM_OwningCollectionElementCIM_ManagedElementOwningElement
CIM_ParametersForMethodCIM_ManagedElementTheMethod
CIM_ParameterValueSourcesCIM_ManagedElementValueSource
CIM_PolicySetAppliesToElementCIM_ManagedElementManagedElement
CIM_AuthorizationRuleAppliesToTargetCIM_ManagedElementManagedElement
CIM_RoleLimitedToTargetCIM_ManagedElementTargetElement
CIM_StatisticsCIM_ManagedElementElement
CIM_SynchronizedCIM_ManagedElementSystemElement
CIM_SynchronizedCIM_ManagedElementSyncedElement
CIM_StorageSynchronizedCIM_ManagedElementSystemElement
CIM_StorageSynchronizedCIM_ManagedElementSyncedElement
CIM_AssignedIdentityCIM_ManagedElementManagedElement
CIM_AuthorizedSubjectCIM_ManagedElementPrivilegedElement
CIM_AuthorizedTargetCIM_ManagedElementTargetElement
CIM_ElementConformsToProfileCIM_ManagedElementManagedElement
CIM_ElementLocationCIM_ManagedElementElement
CIM_ElementProfileCIM_ManagedElementManagedElement
CIM_ElementSecuritySensitivityCIM_ManagedElementManagedElement
CIM_ElementSettingDataCIM_ManagedElementManagedElement
CIM_ElementStatisticalDataCIM_ManagedElementManagedElement
CIM_OwningJobElementCIM_ManagedElementOwningElement
CIM_AffectedJobElementCIM_ManagedElementAffectedElement
CIM_ServiceAffectsElementCIM_ManagedElementAffectedElement
CIM_ServiceAvailableToElementCIM_ManagedElementUserOfService
CIM_SAPAvailableForElementCIM_ManagedElementManagedElement
CIM_ManagementSAPCIM_ManagedElementManagedElement