JobControl
Class IBMTSSVC_Job


CIM_ManagedElement
\_CIM_ManagedSystemElement
  \_CIM_LogicalElement
    \_CIM_Job
      \_CIM_ConcreteJob


Description

A job instnace is used to monitor asynchrouns commands on the deivece. E.g. format, migration or copy operations.

Subclasses

IBMTSSVC_FlashCopyJob IBMTSSVC_FormatVolumeJob IBMTSSVC_MigrateVolumeJob IBMTSSVC_RepairVdiskCopyJob IBMTSSVC_SpaceEfficientRepairJob IBMTSSVC_SyncCopyJob IBMTSSVC_VdiskSyncJob

Referenced By

IBMTSSVC_HostedJob IBMTSSVC_StorageConfigurationService

Properties

IdTypeRangeDescription
Key
InstanceID string
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 will 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 will 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 otherproviders for this instance's NameSpace.For DMTF defined instances, the'preferred'algorithm must be used with the<OrgID>set to'CIM'.
Read Only
Description string
The Description property provides a textual description of the object.
ErrorCode uint16
A vendor-specific error code. The value must be set to zero if the Job completed without error. 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.
ErrorDescription string
A free-form string that contains the vendor error description. 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.
JobState uint16
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.
JobStatus string
A 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.
Name string
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.)
OperationalStatus uint16
Unknown0
Other1
OK2
Degraded3
Stressed4
Predictive Failure5
Error6
Non-Recoverable Error7
Starting8
Stopping9
Stopped10
In Service11
No Contact12
Lost Communication13
Aborted14
Dormant15
Supporting Entity in Error16
Completed17
Power Mode18
DMTF Reserved..
Vendor Reserved0x8000..
Indicates the current status(es) of the element. Various health and operational statuses are defined. Many of the enumeration's values are self- explanatory. However, a few are not and are described in more detail."Stressed"indicates that the element is functioning, but needs attention. Examples of"Stressed"states are overload, overheated, etc."Predictive Failure"indicates that an element is functioning nominally but predicting a failure in the near future."In Service"describes an element being configured, maintained, cleaned, or otherwise administered."No Contact"indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it."Lost Communication"indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable."Stopped"and"Aborted"are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the element's state and configuration may need to be updated."Dormant"indicates that the element is inactive or quiesced."Supporting Entity in Error"describes that this element may be"OK"but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower layer networking problems."Completed"indicates the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can till if the complete operation passed (Completed with OK), and failure (Completed with Error). Completed with Degraded implies 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, providers/instrumentation must provide both the Status and OperationalStatus properties. Further, the first value of OperationalStatus will contain the primary status for the element. When instrumented, Status (since it is single-valued) will also provide the primary status of the element.
TimeOfLastStateChange datetime
Unsupported Property
Read Write
DeleteOnCompletion boolean
Indicates whether or not the job should be automatically deleted upon completion. 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.
PercentComplete uint16
The percentage of the job that has completed at the time that this value is requested.
TimeBeforeRemoval datetime
Unsupported Property.
 
Inherited from class CIM_ManagedElement
Caption, Description, ElementName
 
Inherited from class CIM_ManagedSystemElement
HealthState, InstallDate, Name, OperationalStatus, Status, StatusDescriptions
 
Inherited from class CIM_Job
ElapsedTime, ErrorCode, ErrorDescription, JobStatus, OtherRecoveryAction, Owner, PercentComplete, RecoveryAction, StartTime, TimeSubmitted, DeleteOnCompletion, JobRunTimes, LocalOrUtcTime, Notify, Priority, RunDay, RunDayOfWeek, RunMonth, RunStartInterval, ScheduledStartTime, UntilTime
 
Inherited from class CIM_ConcreteJob
JobState, Name, TimeOfLastStateChange, TimeBeforeRemoval
 

Method Summary

NameDescription
 
Inherited from class CIM_Job
KillJob
 
Inherited from class CIM_ConcreteJob
RequestStateChange
 

Method Detail