CIM_Job, ROOT\virtualization\v2

Class | Childs (1) | Methods (1) | Properties (35) | Qualifiers (5) | Instances | Namespaces (11)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

A 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 - child subclasses in ROOT\virtualization\v2

Number of classes:1
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
CIM_ConcreteJob4383---

CIM_Job methods

CIM_Job has 1 methods (1 Local)

NameOriginReturn
KillJobCIM_Jobuint32 {'out':True}

CIM_Job properties

CIM_Job has 35 properties (21 Local, 14 Derived)

NameOriginCIMType
CaptionCIM_ManagedElement8 [string]
CommunicationStatusCIM_ManagedSystemElement18 [uint16]
DeleteOnCompletionCIM_Job11 [boolean]
DescriptionCIM_ManagedElement8 [string]
DetailedStatusCIM_ManagedSystemElement18 [uint16]
ElapsedTimeCIM_Job101 [datetime]
ElementNameCIM_ManagedElement8 [string]
ErrorCodeCIM_Job18 [uint16]
ErrorDescriptionCIM_Job8 [string]
HealthStateCIM_ManagedSystemElement18 [uint16]
InstallDateCIM_ManagedSystemElement101 [datetime]
InstanceIDCIM_ManagedElement8 [string]
JobRunTimesCIM_Job19 [uint32]
JobStatusCIM_Job8 [string]
LocalOrUtcTimeCIM_Job18 [uint16]
NameCIM_ManagedSystemElement8 [string]
NotifyCIM_Job8 [string]
OperatingStatusCIM_ManagedSystemElement18 [uint16]
OperationalStatusCIM_ManagedSystemElement18 [uint16]
OtherRecoveryActionCIM_Job8 [string]
OwnerCIM_Job8 [string]
PercentCompleteCIM_Job18 [uint16]
PrimaryStatusCIM_ManagedSystemElement18 [uint16]
PriorityCIM_Job19 [uint32]
RecoveryActionCIM_Job18 [uint16]
RunDayCIM_Job16 [sint8]
RunDayOfWeekCIM_Job16 [sint8]
RunMonthCIM_Job17 [uint8]
RunStartIntervalCIM_Job101 [datetime]
ScheduledStartTimeCIM_Job101 [datetime]
StartTimeCIM_Job101 [datetime]
StatusCIM_ManagedSystemElement8 [string]
StatusDescriptionsCIM_ManagedSystemElement8 [string]
TimeSubmittedCIM_Job101 [datetime]
UntilTimeCIM_Job101 [datetime]

Detailed description of CIM_Job methods

Local methods (1) of CIM_Job class

KillJob method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
DeleteOnKillboolean0-{'Description':'Indicates whether or not the Job should be automatically deleted upon termination. This parameter takes precedence over the property, DeleteOnCompletion.'}
Deprecated['CIM_ConcreteJob.RequestStateChange()']
Description'KillJob 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.'
ValueMap['0', '1', '2', '3', '4', '6', '7', '..', '32768..65535']
Values['Success', 'Not Supported', 'Unknown', 'Timeout', 'Failed', 'Access Denied', 'Not Found', 'DMTF Reserved', 'Vendor Specific']
KillJob method is in 6 classes of ROOT\virtualization\v2 and in 8 namespaces

Detailed description of CIM_Job properties

Local properties (21) of CIM_Job class

DeleteOnCompletion property
CIMTYPE'boolean'
Description'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 instead of updating this property.'
writeTrue
DeleteOnCompletion property is in 6 classes of ROOT\virtualization\v2 and in 11 namespaces
ElapsedTime property
CIMTYPE'datetime'
Description'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 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.'
ElapsedTime property is in 6 classes of ROOT\virtualization\v2 and in 17 namespaces
ErrorCode property
CIMTYPE'uint16'
Description'A 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.'
ModelCorrespondence['CIM_Job.ErrorDescription']
ErrorCode property is in 8 classes of ROOT\virtualization\v2 and in 142 namespaces
ErrorDescription property
CIMTYPE'string'
Description'A 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.'
ModelCorrespondence['CIM_Job.ErrorCode']
ErrorDescription property is in 71 classes of ROOT\virtualization\v2 and in 142 namespaces
JobRunTimes property
CIMTYPE'uint32'
Description'The 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.'
writeTrue
JobRunTimes property is in 6 classes of ROOT\virtualization\v2 and in 8 namespaces
JobStatus property
CIMTYPE'string'
Description'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.'
ModelCorrespondence['CIM_ManagedSystemElement.OperationalStatus']
JobStatus property is in 6 classes of ROOT\virtualization\v2 and in 15 namespaces
LocalOrUtcTime property
CIMTYPE'uint16'
Description'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".'
ValueMap['1', '2']
Values['Local Time', 'UTC Time']
writeTrue
LocalOrUtcTime property is in 6 classes of ROOT\virtualization\v2 and in 13 namespaces
Notify property
CIMTYPE'string'
Description'The User who is to be notified upon the Job completion or failure.'
writeTrue
Notify property is in 6 classes of ROOT\virtualization\v2 and in 13 namespaces
OtherRecoveryAction property
CIMTYPE'string'
Description'A string describing the recovery action when the RecoveryAction property of the instance is 1 ("Other").'
ModelCorrespondence['CIM_Job.RecoveryAction']
OtherRecoveryAction property is in 6 classes of ROOT\virtualization\v2 and in 11 namespaces
Owner property
CIMTYPE'string'
Description'The User that submitted the Job, or the Service or method name that caused the job to be created.'
ModelCorrespondence['CIM_OwningJobElement']
Owner property is in 7 classes of ROOT\virtualization\v2 and in 142 namespaces
PercentComplete property
CIMTYPE'uint16'
Description'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 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.'
MaxValue101
MinValue0
PUnit'percent'
Units'Percent'
PercentComplete property is in 6 classes of ROOT\virtualization\v2 and in 15 namespaces
Priority property
CIMTYPE'uint32'
Description'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 class is necessary to capture the setting information that would influence the results of a job.'
writeTrue
Priority property is in 8 classes of ROOT\virtualization\v2 and in 31 namespaces
RecoveryAction property
CIMTYPE'uint16'
Description'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 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.'
ModelCorrespondence['CIM_Job.OtherRecoveryAction']
ValueMap['0', '1', '2', '3', '4', '5']
Values['Unknown', 'Other', 'Do Not Continue', 'Continue With Next Job', 'Re-run Job', 'Run Recovery Job']
RecoveryAction property is in 6 classes of ROOT\virtualization\v2 and in 11 namespaces
RunDay property
CIMTYPE'sint8'
Description'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 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.'
MaxValue31
MinValue-31
ModelCorrespondence['CIM_Job.RunMonth', 'CIM_Job.RunDayOfWeek', 'CIM_Job.RunStartInterval']
writeTrue
RunDay property is in 6 classes of ROOT\virtualization\v2 and in 8 namespaces
RunDayOfWeek property
CIMTYPE'sint8'
Description'A 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.'
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']
Values['-Saturday', '-Friday', '-Thursday', '-Wednesday', '-Tuesday', '-Monday', '-Sunday', 'ExactDayOfMonth', 'Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday']
writeTrue
RunDayOfWeek property is in 6 classes of ROOT\virtualization\v2 and in 8 namespaces
RunMonth property
CIMTYPE'uint8'
Description'The month during which the Job should be processed. Specify 0 for January, 1 for February, and so on.'
ModelCorrespondence['CIM_Job.RunDay', 'CIM_Job.RunDayOfWeek', 'CIM_Job.RunStartInterval']
ValueMap['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11']
Values['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December']
writeTrue
RunMonth property is in 6 classes of ROOT\virtualization\v2 and in 8 namespaces
RunStartInterval property
CIMTYPE'datetime'
Description'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.'
ModelCorrespondence['CIM_Job.RunMonth', 'CIM_Job.RunDay', 'CIM_Job.RunDayOfWeek', 'CIM_Job.RunStartInterval']
writeTrue
RunStartInterval property is in 6 classes of ROOT\virtualization\v2 and in 8 namespaces
ScheduledStartTime property
CIMTYPE'datetime'
Deprecated['CIM_Job.RunMonth', 'CIM_Job.RunDay', 'CIM_Job.RunDayOfWeek', 'CIM_Job.RunStartInterval']
Description'The 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.'
writeTrue
ScheduledStartTime property is in 6 classes of ROOT\virtualization\v2 and in 8 namespaces
StartTime property
CIMTYPE'datetime'
Description'The 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.'
StartTime property is in 6 classes of ROOT\virtualization\v2 and in 24 namespaces
TimeSubmitted property
CIMTYPE'datetime'
Description'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.'
TimeSubmitted property is in 6 classes of ROOT\virtualization\v2 and in 15 namespaces
UntilTime property
CIMTYPE'datetime'
Description'The 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.'
ModelCorrespondence['CIM_Job.LocalOrUtcTime']
writeTrue
UntilTime property is in 6 classes of ROOT\virtualization\v2 and in 10 namespaces

Derived properties (14) of CIM_Job class

Caption property
CIMTYPE'string'
Caption property is in 222 classes of ROOT\virtualization\v2 and in 37 namespaces
CommunicationStatus property
CIMTYPE'uint16'
CommunicationStatus property is in 127 classes of ROOT\virtualization\v2 and in 9 namespaces
Description property
CIMTYPE'string'
Description property is in 225 classes of ROOT\virtualization\v2 and in 142 namespaces
DetailedStatus property
CIMTYPE'uint16'
DetailedStatus property is in 127 classes of ROOT\virtualization\v2 and in 9 namespaces
ElementName property
CIMTYPE'string'
ElementName property is in 223 classes of ROOT\virtualization\v2 and in 21 namespaces
HealthState property
CIMTYPE'uint16'
HealthState property is in 128 classes of ROOT\virtualization\v2 and in 15 namespaces
InstallDate property
CIMTYPE'datetime'
InstallDate property is in 127 classes of ROOT\virtualization\v2 and in 23 namespaces
InstanceID property
CIMTYPE'string'
InstanceID property is in 223 classes of ROOT\virtualization\v2 and in 21 namespaces
Name property
CIMTYPE'string'
Name property is in 152 classes of ROOT\virtualization\v2 and in 142 namespaces
OperatingStatus property
CIMTYPE'uint16'
OperatingStatus property is in 127 classes of ROOT\virtualization\v2 and in 9 namespaces
OperationalStatus property
CIMTYPE'uint16'
OperationalStatus property is in 128 classes of ROOT\virtualization\v2 and in 18 namespaces
PrimaryStatus property
CIMTYPE'uint16'
PrimaryStatus property is in 127 classes of ROOT\virtualization\v2 and in 9 namespaces
Status property
CIMTYPE'string'
Status property is in 127 classes of ROOT\virtualization\v2 and in 42 namespaces
StatusDescriptions property
CIMTYPE'string'
StatusDescriptions property is in 128 classes of ROOT\virtualization\v2 and in 18 namespaces

CIM_Job Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
AbstractTrue
Description'A 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.'
LOCALE1033
UMLPackagePath'CIM::Core::CoreElements'
Version'2.10.0'

CIM_Job System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\virtualization\v2:CIM_Job'___SYSTEM8
__NAMESPACE'ROOT\virtualization\v2'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['CIM_LogicalElement', 'CIM_ManagedSystemElement', 'CIM_ManagedElement']___SYSTEM8
__PROPERTY_COUNT35___SYSTEM3
__RELPATH'CIM_Job'___SYSTEM8
__DYNASTY'CIM_ManagedElement'___SYSTEM8
__SUPERCLASS'CIM_LogicalElement'___SYSTEM8
__CLASS'CIM_Job'___SYSTEM8
__GENUS1___SYSTEM3

Similar Classes to CIM_Job

Number of classes:10
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
CIM_AffectedJobElement240---
CIM_ConcreteJob4383---
CIM_OwningJobElement120---
Msvm_AffectedJobElement040----
Msvm_AffectedStorageJobElement040----
Msvm_ConcreteJob0414----
Msvm_CopyFileToGuestJob0424----
Msvm_MigrationJob0464----
Msvm_OwningJobElement020----
Msvm_StorageJob0444----
comments powered by Disqus
WUtils.com