Msvm_StorageJob class
Represents an image operation job created by the Microsoft Hyper-V Image Management Service.
The following syntax is simplified Managed Object Format (MOF) code, and it includes all of the inherited properties.
Syntax
[Dynamic, Provider("VmmsWmiInstanceAndMethodProvider"), AMENDMENT]
class Msvm_StorageJob : CIM_ConcreteJob
{
string Caption = "Storage Job";
string Description;
string ElementName = "Storage Job";
datetime InstallDate;
uint16 OperationalStatus[] = 2;
string StatusDescriptions[] = { "OK" };
string Status;
uint16 HealthState = 5;
string JobStatus;
datetime TimeSubmitted;
datetime ScheduledStartTime;
datetime StartTime;
datetime ElapsedTime;
uint32 JobRunTimes = 1;
uint8 RunMonth;
sint8 RunDay;
sint8 RunDayOfWeek;
datetime RunStartInterval;
uint16 LocalOrUtcTime;
datetime UntilTime;
string Notify;
string Owner;
uint32 Priority;
uint16 PercentComplete;
boolean DeleteOnCompletion;
uint16 ErrorCode;
string ErrorDescription;
string ErrorSummaryDescription;
uint16 RecoveryAction;
string OtherRecoveryAction;
string InstanceID;
string Name = "Storage Job";
uint16 JobState;
datetime TimeOfLastStateChange;
datetime TimeBeforeRemoval = "00000000000500.000000:000";
boolean Cancellable;
uint16 Type;
UINT32 JobCompletionStatusCode;
string Parent;
string Child;
};
Members
The Msvm_StorageJob class has these types of members:
Methods
The Msvm_StorageJob class has these methods.
| Method | Description |
|---|---|
| GetError | This method is not supported. |
| GetErrorEx | When the job is executing or has terminated without error, then this method returns no Msvm_Error instance. However, if the job has failed because of some internal problem or because the job has been terminated by a client, then one or more Msvm_Error instance is returned. |
| KillJob | This method is not supported. |
| RequestStateChange | This method is not supported. |
Properties
The Msvm_StorageJob class has these properties.
-
Cancellable
-
-
Data type: boolean
-
Access type: Read-only
Indicates whether the job can be cancelled. The value of this property does not guarantee that a request to cancel the job will succeed.
-
-
Caption
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64)
A short textual description (one-line string) of the object. This property is inherited from CIM_ManagedElement and it is always set to "Storage Job".
-
-
Child
-
-
Data type: string
-
Access type: Read-only
On failure of the asynchronous operation, this property contains the file path to the child of the VHD being affected by this operation.
-
-
DeleteOnCompletion
-
-
Data type: boolean
-
Access type: Read/write
This property is inherited from CIM_Job.
-
-
Description
-
-
Data type: string
-
Access type: Read-only
A textual description of the object. This property is inherited from CIM_ManagedElement.
-
-
ElapsedTime
-
-
Data type: datetime
-
Access type: Read-only
-
Qualifiers: SubType ("Interval")
The length of time that the job has been executing. This property is inherited from CIM_Job.
-
-
ElementName
-
-
Data type: string
-
Access type: Read-only
A user-friendly name for the object. This property is inherited from CIM_ManagedElement and it is set to "Storage Job" by default.
-
-
ErrorCode
-
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_Job.ErrorDescription")
This property is inherited from CIM_Job.
-
-
ErrorDescription
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_Job.ErrorCode")
This property is inherited from CIM_Job.
-
-
ErrorSummaryDescription
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_Job.ErrorCode")
This property is inherited from CIM_Job.
-
-
HealthState
-
-
Data type: uint16
-
Access type: Read-only
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. This property is inherited from CIM_ManagedSystemElement and it is always set to 5.
-
-
OK (5)
-
The element is fully functional and operates within normal operational parameters and without error.
InstallDate
-
Data type: datetime
-
Access type: Read-only
-
Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")
The date and time the virtual machine configuration was created. This property is inherited from CIM_ManagedSystemElement.
InstanceID
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Key
For instances associated with a virtual system, this defaults to "Microsoft:GUID\device-specific data". For instances which define potential settings for a virtual system, this defaults to "Microsoft:Definition\GUID\Type", where Type is "Maximum", "Minimum", "Default", or "Increment". This property is inherited from CIM_ConcreteJob.
JobCompletionStatusCode
-
Data type: UINT32
-
Access type: Read-only
The HRESULT code that describes the completion status for the asynchronous operation.
JobRunTimes
-
Data type: uint32
-
Access type: Read/write
This property is inherited from CIM_Job.
The possible values are.
(0)
Repeat the job until the time specified by the UntilTime property or until it is manually shut down.
(1)
Run the job once. This is the default value.
Run the job for the specified number of times.
JobState
-
Data type: uint16
-
Access type: Read-only
The operational state of a job. It can also indicate transitions between these states, for example, 6 (Shutting Down) and 3 (Starting). This property is inherited from CIM_ConcreteJob.
The possible values are.
New (2)
The job has never been started.
Starting (3)
The job is moving from the New, Suspended, or Service states into the Running state.
Running (4)
The Job is running.
Suspended (5)
The Job is stopped, but can be restarted in a seamless manner.
Shutting Down (6)
The job is moving to a Completed, Terminated, or Killed state.
Completed (7)
The job has completed normally.
Terminated (8)
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)
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)
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)
The Job is in a vendor-specific state that supports problem discovery, or resolution, or both.
Query Pending (12)
The Job is waiting for a client to resolve a query.
DMTF Reserved
Reserved.
Vendor Reserved
Reserved.
JobStatus
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")
A free-form string that represents the job status. This property is inherited from CIM_Job.
LocalOrUtcTime
-
Data type: uint16
-
Access type: Read/write
This property is inherited from CIM_Job.
The possible values are.
Local Time (1)
Local time.
UTC Time (2)
UTC time.
Name
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Required
The label by which the object is known. This property is inherited from CIM_ConcreteJob and it is the same as the ElementName property.
Notify
-
Data type: string
-
Access type: Read/write
The user that is notified upon job completion or failure. This property is inherited from CIM_Job.
OperationalStatus
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.StatusDescriptions")
The current statuses of the object. This property is inherited from CIM_ManagedSystemElement and each array element is always set to 2 (OK).
OK (2)
Indicates full functionality without errors.
OtherRecoveryAction
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_Job.RecoveryAction")
This property is inherited from CIM_Job.
Owner
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_OwningJobElement")
The user who submitted the job. This property is inherited from CIM_Job.
Parent
-
Data type: string
-
Access type: Read-only
On failure of the asynchronous operation, this property contains the file path to the parent of the VHD being affected by this operation.
PercentComplete
-
Data type: uint16
-
Access type: Read-only
This property is inherited from CIM_Job.
Priority
-
Data type: uint32
-
Access type: Read/write
The importance of a job's execution. This property is inherited from CIM_Job.
RecoveryAction
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_Job.OtherRecoveryAction")
This property is inherited from CIM_Job.
The possible values are.
Unknown (0)
Unknown.
Other (1)
Take the action specified in the OtherRecoveryAction property.
Do Not Continue (2)
Stop the job and update its status.
Continue With Next Job (3)
Run the next job in the queue.
Re-run Job (4)
Re-run job.
Run Recovery Job (5)
Run the recovery job.
RunDay
-
Data type: sint8
-
Access type: Read/write
-
Qualifiers: MinValue (-31), MaxValue (31), ModelCorrespondence ("CIM_Job.RunMonth", "CIM_Job.RunDayOfWeek", "CIM_Job.RunStartInterval")
This property is inherited from CIM_Job.
RunDayOfWeek
-
Data type: sint8
-
Access type: Read/write
-
Qualifiers: ModelCorrespondence ("CIM_Job.RunMonth", "CIM_Job.RunDay", "CIM_Job.RunStartInterval")
This property is inherited from CIM_Job.
The possible values are.
-Saturday (-7)
The job is processed on the last Saturday on or before the day specified by RunDay.
-Friday (-6)
The job is processed on the last Friday on or before the day specified by RunDay.
-Thursday (-5)
The job is processed on the last Thursday on or before the day specified by RunDay.
-Wednesday (-4)
The job is processed on the last Wednesday on or before the day specified by RunDay.
-Tuesday (-3)
The job is processed on the last Tuesday on or before the day specified by RunDay.
-Monday (-2)
The job is processed on the last Monday on or before the day specified by RunDay.
-Sunday (-1)
The job is processed on the last Sunday on or before the day specified by RunDay.
ExactDayOfMonth (0)
RunDay indicates the day of the month when the job is processed.
Sunday (1)
The job is processed on the first Sunday on or after the day specified by RunDay.
Monday (2)
The job is processed on the first Monday on or after the day specified by RunDay.
Tuesday (3)
The job is processed on the first Tuesday on or after the day specified by RunDay.
Wednesday (4)
The job is processed on the first Wednesday on or after the day specified by RunDay.
Thursday (5)
The job is processed on the first Thursday on or after the day specified by RunDay.
Friday (6)
The job is processed on the first Friday on or after the day specified by RunDay.
Saturday (7)
The job is processed on the first Saturday on or after the day specified by RunDay.
RunMonth
-
Data type: uint8
-
Access type: Read/write
-
Qualifiers: ModelCorrespondence ("CIM_Job.RunDay", "CIM_Job.RunDayOfWeek", "CIM_Job.RunStartInterval")
This property is inherited from CIM_Job.
The possible values are.
January (0)
February (1)
March (2)
April (3)
May (4)
June (5)
July (6)
August (7)
September (8)
October (9)
November (10)
December (11)
RunStartInterval
-
Data type: datetime
-
Access type: Read/write
-
Qualifiers: SubType ("Interval"), ModelCorrespondence ("CIM_Job.RunMonth", "CIM_Job.RunDay", "CIM_Job.RunDayOfWeek", "CIM_Job.RunStartInterval")
This property is inherited from CIM_Job.
ScheduledStartTime
-
Data type: datetime
-
Access type: Read/write
-
Qualifiers: Deprecated ("CIM_Job.RunMonth", "CIM_Job.RunDay", "CIM_Job.RunDayOfWeek", "CIM_Job.RunStartInterval")
This property is inherited from CIM_Job.
StartTime
-
Data type: datetime
-
Access type: Read-only
The time that the job began. This property is inherited from CIM_Job.
Status
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus"), MaxLen (10)
This property is inherited from CIM_ManagedSystemElement but it is not used.
StatusDescriptions
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")
Strings that describe the various OperationalStatus array values. This property is inherited from CIM_ManagedSystemElement and each array element is always set to "OK".
TimeBeforeRemoval
The 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. This property is inherited from CIM_ConcreteJob.
TimeOfLastStateChange
-
Data type: datetime
-
Access type: Read-only
The time at which the virtual machine's state was last modified. This property is inherited from CIM_EnabledLogicalElement.
TimeSubmitted
-
Data type: datetime
-
Access type: Read-only
The time that the job was submitted. This property is inherited from CIM_Job.
Type
-
Data type: uint16
-
Access type: Read-only
The type of asynchronous operation being tracked by this instance of Msvm_StorageJob.
DiskJobTypeInvalid (0)
DiskJobTypeCreation (1)
Creating a virtual hard disk (VHD) image.
DiskJobTypeFloppyCreation (2)
Creating a virtual floppy disk image (VFD).
DiskJobTypeCompaction (3)
Compacting the size of a VHD image.
DiskJobTypeExpansion (4)
Expanding the size of a VHD image.
DiskJobTypeMerging (5)
Merging multiple VHD images into a single image.
DiskJobTypeConversion (6)
DiskJobTypeLoopbackMount (7)
DiskJobTypeGetInfo (8)
DiskJobTypeValidateImage (9)
UntilTime
-
Data type: datetime
-
Access type: Read/write
-
Qualifiers: ModelCorrespondence ("CIM_Job.LocalOrUtcTime")
The time at which the job is invalid or should be stopped. This property is inherited from CIM_Job.
Remarks
Access to the Msvm_StorageJob class might be restricted by UAC Filtering. For more information, see User Account Control and WMI.
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2008 |
| End of client support |
None supported |
| End of server support |
Windows Server 2012 R2 |
| Namespace |
Root\Virtualization |
| MOF |
|