CIM211 Class Declaration
CIM_BatchJob

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

Class Hierarchy

CIM_BatchJob --> CIM_ConcreteJob --> CIM_Job --> CIM_LogicalElement --> CIM_ManagedSystemElement --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_ConcreteJob
NAMECIM_BatchJob

Class Qualifiers

Class CIM_BatchJob Qualifiers
NameTypeValueFrom Class
Experimentalbooleantrue CIM_BatchJob
Versionstring2.8.1000 CIM_BatchJob
DescriptionstringDescription of a batch request that is either waiting on a BatchQueue to run, in the process of running, or that has previously run. Jobs that are completed and not recurring will NOT be associated with a BatchQueue. Jobs that are completed but recurring WILL be associated with a BatchQueue, since they are waiting to run given the scheduling information in the associated JobSettingData instance. CIM_BatchJob
DescriptionstringA concrete version of Job. This class represents a generic and instantiable unit of work, such as a batch or a print job. CIM_ConcreteJob
DescriptionstringA Job is a LogicalElement that represents an executing unit of work, such as a script or a print job. A Job is distinct from a Process in that a Job can be scheduled or queued, and its execution is not limited to a single system. CIM_Job
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
Namestring Description
Required
Override
MaxLen
CIM_BatchJob
MaxCPUTimeuint32 Write
Description
Units
CIM_BatchJob
TimeCompleteddatetime Description
ModelCorrespondence
CIM_BatchJob
JobOriginationstring Write
Description
CIM_BatchJob
Taskstring Description CIM_BatchJob
InstanceIDstring Key
Description
CIM_ConcreteJob
JobStateuint16 Description
ValueMap
Values
CIM_ConcreteJob
TimeOfLastStateChangedatetime Description CIM_ConcreteJob
TimeBeforeRemovaldatetime00000000000500.000000:000 Required
Write
Description
CIM_ConcreteJob
JobStatusstring Description
ModelCorrespondence
CIM_Job
TimeSubmitteddatetime Description CIM_Job
ScheduledStartTimedatetime Deprecated
Write
Description
CIM_Job
StartTimedatetime Description CIM_Job
ElapsedTimedatetime Description CIM_Job
JobRunTimesuint321 Write
Description
CIM_Job
RunMonthuint8 Write
Description
ValueMap
Values
ModelCorrespondence
CIM_Job
RunDaysint8 Write
Description
MinValue
MaxValue
ModelCorrespondence
CIM_Job
RunDayOfWeeksint8 Write
Description
ValueMap
Values
ModelCorrespondence
CIM_Job
RunStartIntervaldatetime Write
Description
ModelCorrespondence
CIM_Job
LocalOrUtcTimeuint16 Write
Description
ValueMap
Values
CIM_Job
UntilTimedatetime Write
Description
ModelCorrespondence
CIM_Job
Notifystring Write
Description
CIM_Job
Ownerstring Description
ModelCorrespondence
CIM_Job
Priorityuint32 Write
Description
CIM_Job
PercentCompleteuint16 Description
Units
MinValue
MaxValue
CIM_Job
DeleteOnCompletionboolean Write
Description
CIM_Job
ErrorCodeuint16 Description
ModelCorrespondence
CIM_Job
ErrorDescriptionstring Description
ModelCorrespondence
CIM_Job
RecoveryActionuint16 Description
ValueMap
Values
ModelCorrespondence
CIM_Job
OtherRecoveryActionstring Description
ModelCorrespondence
CIM_Job
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 Name Qualifiers
NameTypeValueFrom Class
DescriptionstringUniquely identifies this Job within a BatchQueue and BatchService. This property can be used in the construction of the InstanceID key inherited from ConcreteJob. CIM_BatchJob
Requiredbooleantrue CIM_BatchJob
OverridestringName CIM_BatchJob
MaxLenuint321024 CIM_BatchJob

Property MaxCPUTime Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_BatchJob
DescriptionstringSpecifies the maximum number of milliseconds of CPU time that this job can use in any individual run. CIM_BatchJob
UnitsstringMilliSeconds CIM_BatchJob

Property TimeCompleted Qualifiers
NameTypeValueFrom Class
DescriptionstringTime when this BatchJob was completed. This value is only valid if the inherited JobState property has been set to " Completed " (value=7), " Terminated " (value=8), or " Killed " (value=9). CIM_BatchJob
ModelCorrespondencestringCIM_BatchJob.JobState CIM_BatchJob

Property JobOrigination Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_BatchJob
DescriptionstringProvides additional information, beyond Job Owner inherited from CIM_Job, to identify the origins of the BatchJob. This property could include information such as the System, application or Process that created the BatchJob. CIM_BatchJob

Property Task Qualifiers
NameTypeValueFrom Class
DescriptionstringProvides the command and parameters, in string form, for the execution of this job. CIM_BatchJob

Property InstanceID Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_ConcreteJob
DescriptionstringWithin the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. In order to ensure uniqueness within the NameSpace, the value of InstanceID SHOULD be constructed using the following ’ preferred ’ algorithm: < OrgID > : < LocalID > Where < OrgID > and < LocalID > are separated by a colon ’ : ’ , and where < OrgID > must include a copyrighted, trademarked or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID, or that is a registered ID that is assigned to the business entity by a recognized global authority. (This requirement is similar to the < Schema Name > _ < Class Name > structure of Schema class names.) In addition, to ensure uniqueness < OrgID > must not contain a colon ( ’ : ’ ). When using this algorithm, the first colon to appear in InstanceID must appear between < OrgID > and < LocalID > . < LocalID > is chosen by the business entity and should not be re-used to identify different underlying (real-world) elements. If the above ’ preferred ’ algorithm is not used, the defining entity must assure that the resulting InstanceID is not re-used across any InstanceIDs produced by this or other providers for the NameSpace of this instance. For DMTF defined instances, the ’ preferred ’ algorithm must be used with the < OrgID > set to ’ CIM ’ . CIM_ConcreteJob

Property Name Qualifiers
NameTypeValueFrom Class
Requiredbooleantrue CIM_ConcreteJob
OverridestringName CIM_ConcreteJob
DescriptionstringThe user-friendly name for this instance of a Job. In addition, the user-friendly name can be used as a property for a search or query. (Note: Name does not have to be unique within a namespace.) CIM_ConcreteJob
MaxLenuint321024 CIM_ConcreteJob

Property JobState Qualifiers
NameTypeValueFrom Class
DescriptionstringJobState is an integer enumeration that indicates the operational state of a Job. It can also indicate transitions between these states, for example, ’ Shutting Down ’ and ’ Starting ’ . Following is a brief description of the states: New (2) indicates that the job has never been started. Starting (3) indicates that the job is moving from the ’ New ’ , ’ Suspended ’ , or ’ Service ’ states into the ’ Running ’ state. Running (4) indicates that the Job is running. Suspended (5) indicates that the Job is stopped, but can be restarted in a seamless manner. Shutting Down (6) indicates that the job is moving to a ’ Completed ’ , ’ Terminated ’ , or ’ Killed ’ state. Completed (7) indicates that the job has completed normally. Terminated (8) indicates that the job has been stopped by a ’ Terminate ’ state change request. The job and all its underlying processes are ended and can be restarted (this is job-specific) only as a new job. Killed (9) indicates that the job has been stopped by a ’ Kill ’ state change request. Underlying processes might have been left running, and cleanup might be required to free up resources. Exception (10) indicates that the Job is in an abnormal state that might be indicative of an error condition. Actual status might be displayed though job-specific objects. Service (11) indicates that the Job is in a vendor-specific state that supports problem discovery, or resolution, or both. CIM_ConcreteJob
ValueMapstring
[See below.]
CIM_ConcreteJob
ValuesstringNew
Starting
Running
Suspended
Shutting Down
Completed
Terminated
Killed
Exception
Service
DMTF Reserved
Vendor Reserved
CIM_ConcreteJob

NameValue
2New
3Starting
4Running
5Suspended
6Shutting Down
7Completed
8Terminated
9Killed
10Exception
11Service
12..32767DMTF Reserved
32768..65535Vendor Reserved
Property TimeOfLastStateChange Qualifiers
NameTypeValueFrom Class
DescriptionstringThe date or time when the state of the Job last changed. If the state of the Job 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_ConcreteJob

Property TimeBeforeRemoval Qualifiers
NameTypeValueFrom Class
Requiredbooleantrue CIM_ConcreteJob
Writebooleantrue CIM_ConcreteJob
DescriptionstringThe amount of time that the Job is retained after it has finished executing, either succeeding or failing in that execution. The job must remain in existence for some period of time regardless of the value of the DeleteOnCompletion property. The default is five minutes. CIM_ConcreteJob

Property JobStatus Qualifiers
NameTypeValueFrom Class
DescriptionstringA free-form string that represents the status of the job. The primary status is reflected in the inherited OperationalStatus property. JobStatus provides additional, implementation-specific details. CIM_Job
ModelCorrespondencestringCIM_ManagedSystemElement.OperationalStatus CIM_Job

Property TimeSubmitted Qualifiers
NameTypeValueFrom Class
DescriptionstringThe time that the Job was submitted to execute. A value of all zeroes indicates that the owning element is not capable of reporting a date and time. Therefore, the ScheduledStartTime and StartTime are reported as intervals relative to the time their values are requested. CIM_Job

Property ScheduledStartTime Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_Job
DescriptionstringThe time that the current Job is scheduled to start. This time can be represented by the actual date and time, or an interval relative to the time that this property is requested. A value of all zeroes indicates that the Job is already executing. The property is deprecated in lieu of the more expressive scheduling properties, RunMonth, RunDay, RunDayOfWeek, and RunStartInterval. CIM_Job

Property StartTime Qualifiers
NameTypeValueFrom Class
DescriptionstringThe time that the Job was actually started. This time can be represented by an actual date and time, or by an interval relative to the time that this property is requested. Note that this property is also present in the JobProcessingStatistics class. This class is necessary to capture the processing information for recurring Jobs, because only the ’ last ’ run time can be stored in this single-valued property. CIM_Job

Property ElapsedTime Qualifiers
NameTypeValueFrom Class
DescriptionstringThe time interval that the Job has been executing or the total execution time if the Job is complete. Note that this property is also present in the JobProcessingStatistics class. This class is necessary to capture the processing information for recurring Jobs, because only the ’ last ’ run time can be stored in this single-valued property. CIM_Job

Property JobRunTimes Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_Job
DescriptionstringThe number of times that the Job should be run. A value of 1 indicates that the Job is not recurring, while any non-zero value indicates a limit to the number of times that the Job will recur. Zero indicates that there is no limit to the number of times that the Job can be processed, but that it is terminated either after the UntilTime or by manual intervention. By default, a Job is processed once. CIM_Job

Property RunMonth Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_Job
DescriptionstringThe month during which the Job should be processed. Specify 0 for January, 1 for February, and so on. CIM_Job
ValueMapstring
[See below.]
CIM_Job
ValuesstringJanuary
February
March
April
May
June
July
August
September
October
November
December
CIM_Job
ModelCorrespondencestringCIM_Job.RunDay
CIM_Job.RunDayOfWeek
CIM_Job.RunStartInterval
CIM_Job

NameValue
0January
1February
2March
3April
4May
5June
6July
7August
8September
9October
10November
11December
Property RunDay Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_Job
DescriptionstringThe day in the month on which the Job should be processed. There are two different interpretations for this property, depending on the value of DayOfWeek. In one case, RunDay defines the day-in-month on which the Job is processed. This interpretation is used when the DayOfWeek is 0. A positive or negative integer indicates whether the RunDay should be calculated from the beginning or end of the month. For example, 5 indicates the fifth day in the RunMonth and -1 indicates the last day in the RunMonth. When RunDayOfWeek is not 0, RunDay is the day-in-month on which the Job is processed, defined in conjunction with RunDayOfWeek. For example, if RunDay is 15 and RunDayOfWeek is Saturday, then the Job is processed on the first Saturday on or after the 15th day in the RunMonth (for example, the third Saturday in the month). If RunDay is 20 and RunDayOfWeek is -Saturday, then this indicates the first Saturday on or before the 20th day in the RunMonth. If RunDay is -1 and RunDayOfWeek is -Sunday, then this indicates the last Sunday in the RunMonth. CIM_Job
MinValuesint64-31 CIM_Job
MaxValuesint6431 CIM_Job
ModelCorrespondencestringCIM_Job.RunMonth
CIM_Job.RunDayOfWeek
CIM_Job.RunStartInterval
CIM_Job

Property RunDayOfWeek Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_Job
DescriptionstringA positive or negative integer used in conjunction with RunDay to indicate the day of the week on which the Job is processed. RunDayOfWeek is set to 0 to indicate an exact day of the month, such as March 1. A positive integer (representing Sunday, Monday, ..., Saturday) means that the day of week is found on or after the specified RunDay. A negative integer (representing -Sunday, -Monday, ..., -Saturday) means that the day of week is found on or BEFORE the RunDay. CIM_Job
ValueMapstring
[See below.]
CIM_Job
Valuesstring-Saturday
-Friday
-Thursday
-Wednesday
-Tuesday
-Monday
-Sunday
ExactDayOfMonth
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
CIM_Job
ModelCorrespondencestringCIM_Job.RunMonth
CIM_Job.RunDay
CIM_Job.RunStartInterval
CIM_Job

NameValue
-7-Saturday
-6-Friday
-5-Thursday
-4-Wednesday
-3-Tuesday
-2-Monday
-1-Sunday
0ExactDayOfMonth
1Sunday
2Monday
3Tuesday
4Wednesday
5Thursday
6Friday
7Saturday
Property RunStartInterval Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_Job
DescriptionstringThe time interval after midnight when the Job should be processed. For example, 00000000020000.000000:000 indicates that the Job should be run on or after two o ’ clock, local time or UTC time (distinguished using the LocalOrUtcTime property. CIM_Job
ModelCorrespondencestringCIM_Job.RunMonth
CIM_Job.RunDay
CIM_Job.RunDayOfWeek
CIM_Job.RunStartInterval
CIM_Job

Property LocalOrUtcTime Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_Job
DescriptionstringThis property indicates whether the times represented in the RunStartInterval and UntilTime properties represent local times or UTC times. Time values are synchronized worldwide by using the enumeration value 2, " UTC Time " . CIM_Job
ValueMapstring
[See below.]
CIM_Job
ValuesstringLocal Time
UTC Time
CIM_Job

NameValue
1Local Time
2UTC Time
Property UntilTime Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_Job
DescriptionstringThe time after which the Job is invalid or should be stopped. This time can be represented by an actual date and time, or by an interval relative to the time that this property is requested. A value of all nines indicates that the Job can run indefinitely. CIM_Job
ModelCorrespondencestringCIM_Job.LocalOrUtcTime CIM_Job

Property Notify Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_Job
DescriptionstringThe User who is to be notified upon the Job completion or failure. CIM_Job

Property Owner Qualifiers
NameTypeValueFrom Class
DescriptionstringThe User that submitted the Job, or the Service or method name that caused the job to be created. CIM_Job
ModelCorrespondencestringCIM_OwningJobElement CIM_Job

Property Priority Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_Job
DescriptionstringIndicates the urgency or importance of execution of the Job. The lower the number, the higher the priority. Note that this property is also present in the JobProcessingStatistics class. This class is necessary to capture the setting information that would influence the results of a job. CIM_Job

Property PercentComplete Qualifiers
NameTypeValueFrom Class
DescriptionstringThe percentage of the job that has completed at the time that this value is requested. Note that this property is also present in the JobProcessingStatistics class. This class is necessary to capture the processing information for recurring Jobs, because only the ’ last ’ run data can be stored in this single-valued property. Note that the value 101 is undefined and will be not be allowed in the next major revision of the specification. CIM_Job
UnitsstringPercent CIM_Job
MinValuesint640 CIM_Job
MaxValuesint64101 CIM_Job

Property DeleteOnCompletion Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_Job
DescriptionstringIndicates whether or not the job should be automatically deleted upon completion. Note that the ’ completion ’ of a recurring job is defined by its JobRunTimes or UntilTime properties, or when the Job is terminated by manual intervention. If this property is set to false and the job completes, then the extrinsic method DeleteInstance must be used to delete the job instead of updating this property. CIM_Job

Property ErrorCode Qualifiers
NameTypeValueFrom Class
DescriptionstringA vendor-specific error code. The value must be set to zero if the Job completed without error. Note that this property is also present in the JobProcessingStatistics class. This class is necessary to capture the processing information for recurring Jobs, because only the ’ last ’ run error can be stored in this single-valued property. CIM_Job
ModelCorrespondencestringCIM_Job.ErrorDescription CIM_Job

Property ErrorDescription Qualifiers
NameTypeValueFrom Class
DescriptionstringA free-form string that contains the vendor error description. Note that this property is also present in the JobProcessingStatistics class. This class is necessary to capture the processing information for recurring Jobs, because only the ’ last ’ run error can be stored in this single-valued property. CIM_Job
ModelCorrespondencestringCIM_Job.ErrorCode CIM_Job

Property RecoveryAction Qualifiers
NameTypeValueFrom Class
DescriptionstringDescribes the recovery action to be taken for an unsuccessfully run Job. The possible values are: 0 = " Unknown " , meaning it is unknown as to what recovery action to take 1 = " Other " , indicating that the recovery action will be specified in the OtherRecoveryAction property 2 = " Do Not Continue " , meaning stop the execution of the job and appropriately update its status 3 = " Continue With Next Job " , meaning continue with the next job in the queue 4 = " Re-run Job " , indicating that the job should be re-run 5 = " Run Recovery Job " , meaning run the Job associated using the RecoveryJob relationship. Note that the recovery Job must already be in the queue from which it will run. CIM_Job
ValueMapstring
[See below.]
CIM_Job
ValuesstringUnknown
Other
Do Not Continue
Continue With Next Job
Re-run Job
Run Recovery Job
CIM_Job
ModelCorrespondencestringCIM_Job.OtherRecoveryAction CIM_Job

NameValue
0Unknown
1Other
2Do Not Continue
3Continue With Next Job
4Re-run Job
5Run Recovery Job
Property OtherRecoveryAction Qualifiers
NameTypeValueFrom Class
DescriptionstringA string describing the recovery action when the RecoveryAction property of the instance is 1 ( " Other " ). CIM_Job
ModelCorrespondencestringCIM_Job.RecoveryAction CIM_Job

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
RequestStateChangeuint32 Description
ValueMap
Values
RequestedState
TimeoutPeriod
CIM_ConcreteJob
GetErroruint32 Experimental
Description
ValueMap
Values
ErrorCIM_ConcreteJob
KillJobuint32 Deprecated
Description
ValueMap
Values
DeleteOnKillCIM_Job

Method Qualifiers

Method RequestStateChange Qualifiers
NameTypeValueFrom Class
DescriptionstringRequests that the state of the job be changed to the value specified in the RequestedState parameter. Invoking the RequestStateChange method multiple times could result in earlier requests being overwritten or lost. If 0 is returned, then the task completed successfully. Any other return code indicates an error condition. CIM_ConcreteJob
ValueMapstring
[See below.]
CIM_ConcreteJob
ValuesstringCompleted with No Error
Not Supported
Unknown/Unspecified Error
Can NOT complete within Timeout Period
Failed
Invalid Parameter
In Use
DMTF Reserved
Method Parameters Checked - Transition Started
Invalid State Transition
Use of Timeout Parameter Not Supported
Busy
Method Reserved
Vendor Specific
CIM_ConcreteJob

Method GetError Qualifiers
NameTypeValueFrom Class
DescriptionstringWhen the job is executing or has terminated without error, then this method returns no CIM_Error instance. However, if the job has failed because of some internal problem or because the job has been terminated by a client, then a CIM_Error instance is returned. CIM_ConcreteJob
ValueMapstring
[See below.]
CIM_ConcreteJob
ValuesstringSuccess
Not Supported
Unspecified Error
Timeout
Failed
Invalid Parameter
Access Denied
DMTF Reserved
Vendor Specific
CIM_ConcreteJob

Method KillJob Qualifiers
NameTypeValueFrom Class
DescriptionstringKillJob is being deprecated because there is no distinction made between an orderly shutdown and an immediate kill. CIM_ConcreteJob.RequestStateChange() provides ’ Terminate ’ and ’ Kill ’ options to allow this distinction. A method to kill this job and any underlying processes, and to remove any ’ dangling ’ associations. CIM_Job
ValueMapstring
[See below.]
CIM_Job
ValuesstringSuccess
Not Supported
Unknown
Timeout
Failed
Access Denied
Not Found
DMTF Reserved
Vendor Specific
CIM_Job

Parameters

Method RequestStateChange Parameters
NameTypeQualifiers
RequestedStateuint16IN
Description
ValueMap
Values
TimeoutPerioddatetimeIN
Description

Method GetError Parameters
NameTypeQualifiers
ErrorstringOUT
Description
EmbeddedInstance

Method KillJob Parameters
NameTypeQualifiers
DeleteOnKillbooleanIN
Description

Parameter Qualifiers

Parameter RequestedState Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_ConcreteJob
DescriptionstringRequestStateChange changes the state of a job. The possible values are as follows: Start (2) changes the state to ’ Running ’ . Suspend (3) stops the job temporarily. The intention is to subsequently restart the job with ’ Start ’ . It might be possible to enter the ’ Service ’ state while suspended. (This is job-specific.) Terminate (4) stops the job cleanly, saving data, preserving the state, and shutting down all underlying processes in an orderly manner. Kill (5) terminates the job immediately with no requirement to save data or preserve the state. Service (6) puts the job into a vendor-specific service state. It might be possible to restart the job. CIM_ConcreteJob
ValueMapstring
[See below.]
CIM_ConcreteJob
ValuesstringStart
Suspend
Terminate
Kill
Service
DMTF Reserved
Vendor Reserved
CIM_ConcreteJob

Parameter TimeoutPeriod Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_ConcreteJob
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_ConcreteJob

Parameter Error Qualifiers
NameTypeValueFrom Class
OUTbooleantrue CIM_ConcreteJob
DescriptionstringIf the OperationalStatus on the Job is not " OK " , then this method will return a CIM Error instance. Otherwise, when the Job is " OK " , null is returned. CIM_ConcreteJob
EmbeddedInstancestringCIM_Error CIM_ConcreteJob

Parameter DeleteOnKill Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_Job
DescriptionstringIndicates whether or not the Job should be automatically deleted upon termination. This parameter takes precedence over the property, DeleteOnCompletion. CIM_Job

Associations this class can participate in

Association
Class
Reference
Class
Role
CIM_AssociatedJobMethodResultCIM_ConcreteJobJob
CIM_ProcessOfJobCIM_JobGroupComponent
CIM_RecoveryJobCIM_JobAntecedent
CIM_RecoveryJobCIM_JobDependent
CIM_ExecutionRequirementCIM_JobDependent
CIM_JobDestinationJobsCIM_JobDependent
CIM_ExecutionCandidateCIM_JobDependent
CIM_ExecutionTargetCIM_JobDependent
CIM_OwningJobElementCIM_JobOwnedElement
CIM_AffectedJobElementCIM_JobAffectingElement
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