| A concrete version of Job. This class represents a generic and instantiable unit of work, such as a batch or a print job. | | Qualifiers:Version ( "2.8.1000" ) | | Parameters (local in grey) | | datetime TimeOfLastStateChange ;
The date/time when the Job's State 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. | Values { "Completed 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" }
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , ".." , "4096" , "4097" , "4098" , "4099" , "4100..32767" , "32768..65535" }
uint32RequestStateChange( | | Changes the state of a job.
Start (2) changes the state to 'Running'.
Suspend (3) stops the job temporarily. The intention is to subsequently restart the job with 'Start'. It may be possible to enter the 'Service' state while suspended - this is job-specific.
Terminate (4) stops the job cleanly, saving data, preserving 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 state. Service (6) puts the job into a vendor-specific service state. The job may be able to be restarted.
Qualifiers:Values { "Start" , "Suspend" , "Terminate" , "Kill" , "Service" , "DMTF Reserved" , "Vendor Reserved" }
IN
ValueMap { "2" , "3" , "4" , "5" , "6" , "7..32767" , "32768..65535" }
| | uint16 RequestedState | | | 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 doesn't support this parameter. A return code of 'Use Of Timeout Parameter Not Supported' MUST be returned.
Qualifiers:IN
| | datetime TimeoutPeriod |
)
Requests that the job's state be changed to the value specified in the RequestedState parameter. Invoking the RequestStateChange method multiple times could result in earlier requests being overwritten/lost.
If 0 is returned, then the task completed successfully. Any other return code indicates an error condition. | Experimental
Values { "Success" , "Not Supported" , "Unspecified Error" , "Timeout" , "Failed" , "Invalid Parameter" , "Access Denied" , "DMTF Reserved" , "Vendor Specific" }
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "4098..32767" , "32768..65535" }
uint32GetError( | | If 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.
Qualifiers:OUT
EmbeddedInstance ( "CIM_Error" )
| | string Error |
)
When 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. | Experimental
Write
Required
datetime TimeBeforeRemoval = "00000000000500.000000:000" ;
The amount of time 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. | Values { "New" , "Starting" , "Running" , "Suspended" , "Shutting Down" , "Completed" , "Terminated" , "Killed" , "Exception" , "Service" , "DMTF Reserved" , "Vendor Reserved" }
ValueMap { "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12..32767" , "32768..65535" }
uint16 JobState ;
JobState 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 may be restarted in a seamless manner.
Shutting Down (6) indicates 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 may 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 may have been left running and cleanup may be required to free up resources.
Exception (10) indicates that the Job is in an abnormal state that may be indicative of an error condition. Actual status may be surfaced though job-specific objects.
Service (11) indicates that the Job is in a vendor-specific state that supports problem discovery and/or resolution. | Required
Override ( "Name" )
string Name ;
The user friendly name for this instance of 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.) | Key
string InstanceID ;
Within 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 creating/defining the InstanceID, or is a registered ID that is assigned to the business entity by a recognized global authority (This 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 resultant InstanceID is not re-used across any InstanceIDs produced by this or other providers for this instance's NameSpace.
For DMTF defined instances, the 'preferred' algorithm MUST be used with the <OrgID> set to 'CIM'. | Write
ModelCorrespondence { "CIM_Job.RunMonth" , "CIM_Job.RunDay" , "CIM_Job.RunDayOfWeek" , "CIM_Job.RunStartInterval" }
datetime RunStartInterval ;
The 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. | Values { "-Saturday" , "-Friday" , "-Thursday" , "-Wednesday" , "-Tuesday" , "-Monday" , "-Sunday" , "ExactDayOfMonth" , "Sunday" , "Monday" , "Tuesday" , "Wednesday" , "Thursday" , "Friday" , "Saturday" }
Write
ModelCorrespondence { "CIM_Job.RunMonth" , "CIM_Job.RunDay" , "CIM_Job.RunStartInterval" }
ValueMap { "-7" , "-6" , "-5" , "-4" , "-3" , "-2" , "-1" , "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" }
sint8 RunDayOfWeek ;
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. | Write
string Notify ;
User to be notified upon the Job completion or failure. | ModelCorrespondence { "CIM_Job.RecoveryAction" }
string OtherRecoveryAction ;
A string describing the recovery action when the instance's RecoveryAction property is 1 ('Other'). | Values { "Success" , "Not Supported" , "Unknown" , "Timeout" , "Failed" , "Access Denied" , "Not Found" , "DMTF Reserved" , "Vendor Specific" }
Deprecated { "CIM_ConcreteJob.RequestStateChange()" }
ValueMap { "0" , "1" , "2" , "3" , "4" , "6" , "7" , ".." , "32768..65535" }
uint32KillJob( | | Indicates whether or not the Job should be automatically deleted upon termination. This parameter takes precedence over the property, DeleteOnCompletion.
Qualifiers:IN
| | boolean DeleteOnKill |
)
KillJob is being deprecated because there is no distiction 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. | ModelCorrespondence { "CIM_Job.ErrorCode" }
string ErrorDescription ;
A free form string containing the vendor error description. Note that this property is also present in the JobProcessingStatistics class. This is necessary to capture the processing information for recurring Jobs, since only the 'last' run error can be stored in this single-valued property. | MinValue ( 31 )
Write
ModelCorrespondence { "CIM_Job.RunMonth" , "CIM_Job.RunDayOfWeek" , "CIM_Job.RunStartInterval" }
MaxValue ( 31 )
sint8 RunDay ;
The 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 the end of the month. For example, 5 indicates the fifth day in 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 (e.g., 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. | Values { "January" , "February" , "March" , "April" , "May" , "June" , "July" , "August" , "September" , "October" , "November" , "December" }
Write
ModelCorrespondence { "CIM_Job.RunDay" , "CIM_Job.RunDayOfWeek" , "CIM_Job.RunStartInterval" }
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" }
uint8 RunMonth ;
The month during which the Job should be processed. Specify 0 for January, 1 for February, and so on. | Values { "Unknown" , "Other" , "Do Not Continue" , "Continue With Next Job" , "Re-run Job" , "Run Recovery Job" }
ModelCorrespondence { "CIM_Job.OtherRecoveryAction" }
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" }
uint16 RecoveryAction ;
Describes 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 property, OtherRecoveryAction
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 on the queue from which it will run. | datetime StartTime ;
The time that the Job was actually started. This may 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 is necessary to capture the processing information for recurring Jobs, since only the 'last' run time can be stored in this single-valued property. | ModelCorrespondence { "CIM_ManagedSystemElement.OperationalStatus" }
string JobStatus ;
A free form string representing the Job's status. The primary status is reflected in the inherited OperationalStatus property. JobStatus provides additional, implementation-specific details. | ModelCorrespondence { "CIM_Job.ErrorDescription" }
uint16 ErrorCode ;
A vendor specific error code. This MUST be set to zero if the Job completed without error. Note that this property is also present in the JobProcessingStatistics class. This is necessary to capture the processing information for recurring Jobs, since only the 'last' run error can be stored in this single-valued property. | Write
ModelCorrespondence { "CIM_Job.LocalOrUtcTime" }
datetime UntilTime ;
The time after which the Job is invalid or should be stopped. This may 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. | Write
Deprecated { "CIM_Job.RunMonth" , "CIM_Job.RunDay" , "CIM_Job.RunDayOfWeek" , "CIM_Job.RunStartInterval" }
datetime ScheduledStartTime ;
The time that the current Job is scheduled to start. This may 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. | datetime TimeSubmitted ;
The 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. | MinValue ( 0 )
MaxValue ( 101 )
Units ( "Percent" )
uint16 PercentComplete ;
The 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 is necessary to capture the processing information for recurring Jobs, since 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. | Values { "Local Time" , "UTC Time" }
Write
ValueMap { "1" , "2" }
uint16 LocalOrUtcTime ;
This 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'. | datetime ElapsedTime ;
The 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 is necessary to capture the processing information for recurring Jobs, since only the 'last' run time can be stored in this single-valued property. | Write
uint32 JobRunTimes = 1 ;
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. | ModelCorrespondence { "CIM_OwningJobElement" }
string Owner ;
The User that submitted the Job or the Service/method name/etc. that caused the job to be created. | Write
boolean DeleteOnCompletion ;
Indicates 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 versus updating this property. | Write
uint32 Priority ;
Indicates 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 is necessary to capture the setting information that would influence a Job's results. | Experimental
Values { "Unknown" , "OK" , "Degraded/Warning" , "Minor failure" , "Major failure" , "Critical failure" , "Non-recoverable error" , "DMTF Reserved" }
ValueMap { "0" , "5" , "10" , "15" , "20" , "25" , "30" , ".." }
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 completed 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 MAY NOT be possible.
'Major Failure' (20) - The element is failing. It is possible the some or all of the functionality of this component is degraded or not working.
'Minor Failure' (15) - All functionality is available but some MAY 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 may not be operating at optimal performance or it may 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 can not report on HealthState at this time.
DMTF has reserved the unused portion of the continuum for additional HealthStates in the future. | ModelCorrespondence { "CIM_ManagedSystemElement.OperationalStatus" }
ArrayType ( "Indexed" )
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. | 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" }
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , "13" , "14" , "15" , "16" , "17" , "18" , ".." , "0x8000.." }
ArrayType ( "Indexed" )
uint16 OperationalStatus [ ] ;
Indicates the current status(es) 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 in more detail.
'Stressed' indicates that the element is functioning, but needs attention. Examples of 'Stressed' states are overload, overheated, etc.
'Predictive Failure' indicates that an element is functioning nominally but predicting a failure in the near future.
'In Service' describes an element being configured, maintained, cleaned, or otherwise administered.
'No Contact' indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it.
'Lost Communication' indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable.
'Stopped' and 'Aborted' are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the element's state and configuration may need to be updated.
'Dormant' indicates that the element is inactive or quiesced.
'Supporting Entity in Error' describes that this element may be 'OK' but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower layer networking problems.
'Completed' indicates the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can till if the complete operation passed (Completed with OK), and failure (Completed with Error). Completed with Degraded would imply the operation finished, but did not complete OK or report an error.
'Power Mode' indicates the element has additional power model information contained in the Associated PowerManagementService association.
OperationalStatus replaces the Status property on ManagedSystemElement to provide a consistent approach to enumerations, to address implementation needs for an array property, and to provide a migration path from today's environment to the future. This change was not made earlier since it required the DEPRECATED qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly RECOMMENDED that providers/instrumentation provide BOTH the Status and OperationalStatus properties. Further, the first value of OperationalStatus SHOULD contain the primary status for the element. When instrumented, Status (since it is single-valued) SHOULD also provide the primary status of the element. | MappingStrings { "MIF.DMTF|ComponentID|001.5" }
datetime InstallDate ;
A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed. | MaxLen ( 10 )
Deprecated { "CIM_ManagedSystemElement.OperationalStatus" }
ValueMap { "OK" , "Error" , "Degraded" , "Unknown" , "Pred Fail" , "Starting" , "Stopping" , "Service" , "Stressed" , "NonRecover" , "No Contact" , "Lost Comm" , "Stopped" }
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 overcomes the limitation of describing status via a single value, when it is really a multi-valued property (for example, an element may be OK AND Stopped. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. And, 3) The change to a uint16 data type was discussed when CIM V2.0 was defined. However, existing V1.0 implementations used the string property and did not want to modify their code. Therefore, Status was grandfathered into the Schema. Use of the Deprecated qualifier allows the maintenance of the existing property, but also permits an improved definition using OperationalStatus. | 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. | string ElementName ;
A user-friendly name for the object. This property allows each instance to define a user-friendly name IN ADDITION TO its key properties/identity data, and description information.
Note that ManagedSystemElement's Name property is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information MAY be present in both the Name and ElementName properties. |
| | | | |
|
