System\CIM_JobSettingData.mof.mof (HTML version)

Return to index
CIM_JobSettingData Superclass: CIM_SettingData
JobSettingData represents job characteristics and scheduling information for a CIM_Job. The settings may be applied to a job handling Service, a JobQueue or other destination to which jobs are submitted, and/or to individual CIM_Jobs. The applicability of the settings are defined using the ElementSettingData relationship. Since the Settings may be defined in several contexts and applied to many types of elements, this class is defined as a subclass of SettingData, versus ScopedSettingData.
Qualifiers:Version ( "2.9.0" )
Parameters (local in grey)
ModelCorrespondence { "CIM_JobSettingData.RecoveryAction" , "CIM_Job.OtherRecoveryAction" }
string OtherRecoveryAction ;
A string describing the recovery action when the instance's RecoveryAction property is 1 ('Other').
Write
ModelCorrespondence { "CIM_Job.DeleteOnCompletion" }
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.
Values { "Unknown" , "Other" , "Do Not Continue" , "Continue With Next Job" , "Re-run Job" , "Run Recovery Job" }
ModelCorrespondence { "CIM_JobSettingData.OtherRecoveryAction" , "CIM_Job.RecoveryAction" }
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" }
uint16 RecoveryAction ;
Describes the recovery setting if the Job does not successfully complete. 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.
Required
Override ( "ElementName" )
string ElementName ;
The user-friendly name for this instance of SettingData. In addition, the user-friendly name can be used as an index property for a search or query. (Note: The 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. 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 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 reused 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 reused 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.
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.