Msvm_StorageJob class

Represents a storage 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   InstanceID;
  string   Caption;
  string   Description;
  string   ElementName;
  datetime InstallDate;
  string   Name;
  uint16   OperationalStatus[];
  string   StatusDescriptions[];
  string   Status;
  uint16   HealthState = 5;
  uint16   CommunicationStatus;
  uint16   DetailedStatus;
  uint16   OperatingStatus;
  uint16   PrimaryStatus;
  string   JobStatus;
  datetime TimeSubmitted;
  datetime ScheduledStartTime;
  datetime StartTime;
  datetime ElapsedTime;
  uint32   JobRunTimes;
  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;
  uint16   JobState;
  datetime TimeOfLastStateChange;
  datetime TimeBeforeRemoval = 00000000000500.000000:000";
  boolean  Cancellable;
  string   Child;
  UINT32   JobCompletionStatusCode;
  string   Parent;
  uint16   JobType;
};

Members

The Msvm_StorageJob class has these types of members:

• Methods
• Properties

Methods

The Msvm_StorageJob class has these methods.

Properties

The Msvm_StorageJob class has these properties.

Cancellable

Data type: boolean

Access type: Read-only

Indicates whether the job can be canceled. 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

A short description of the object. This property is inherited from CIM_ManagedElement.

Child

Data type: string

Access type: Read-only

On failure of the asynchronous operation, this property contains the full path of the child of the VHD being affected by this operation.

CommunicationStatus

Data type: uint16

Access type: Read-only

Indicates the ability of the instrumentation to communicate with the underlying managed element. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

DeleteOnCompletion

Data type: boolean

Access type: Read-only

Specifies whether the job should be automatically deleted upon completion. This property is inherited from CIM_Job.

Description

Data type: string

Access type: Read-only

A description of the object. This property is inherited from CIM_ManagedElement.

DetailedStatus

Data type: uint16

Access type: Read-only

Complements the PrimaryStatus property with additional status detail. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

ElapsedTime

Data type: datetime

Access type: Read-only

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 display name for the object. This property is inherited from CIM_ManagedElement.

ErrorCode

Data type: uint16

Access type: Read-only

A vendor-specific error code. The value must be set to zero if the job completed without error. This property is inherited from CIM_Job.

ErrorDescription

Data type: string

Access type: Read-only

A string that contains the vendor error description. This property is inherited from CIM_Job.

ErrorSummaryDescription

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_Job.ErrorCode")

A summary description of the error, if present. 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 nonfunctional. This property is inherited from CIM_ManagedSystemElement, and it is always set to 5.

InstallDate

Data type: datetime

Access type: Read-only

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

Uniquely identifies an instance of this class. This property is inherited from CIM_ManagedElement.

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-only

The number of times that the job should be run. A value of 1 indicates that the job is not recurring, while any nonzero 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 it will be terminated either after the UntilTime has been reached, or the job is manually terminated. This property is inherited from CIM_Job.

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.

Value	Meaning
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 it 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 only as a new job. The requirement that the job be restarted only as a new job is job specific.
Killed 9	The job has been stopped by a "Kill" state change request. Underlying processes may still be running, and a clean-up might be required to free up resources.
Exception 10	The job is in an abnormal state that might be indicative of an error condition. The actual status of the job might be available through job-specific objects.
Service 11	The job is in a vendor-specific state that supports problem discovery, or resolution, or both.
DMTF Reserved 12 32767	Reserved.
Vendor Reserved 32768 65535	Reserved.

JobStatus

Data type: string

Access type: Read-only

A string that represents the job status. This property is inherited from CIM_Job.

JobType

Data type: uint16

Access type: Read-only

The type of asynchronous operation being tracked by this instance of Msvm_StorageJob.

Unknown (0)

VHD Creation (1)

Creating a virtual hard disk (VHD) image.

Floppy Creation (2)

Creating a virtual floppy disk image (VFD).

Compaction (3)

Compacting the size of a VHD image.

Expansion (4)

Expanding the size of a VHD image.

Merging (5)

Merging multiple VHD images into a single image.

Conversion (6)

Converting the type of a virtual hard disk image.

Loopback Mount (7)

Mounting the virtual hard disk on the parent partition

Get VHD Info (8)

Mounting the VHD on the management operating system.

Validate VHD Image (9)

Remarks

Access to the Msvm_StorageJob class might be restricted by UAC Filtering. For more information, see User Account Control and WMI.

Requirements

See also

CIM_ConcreteJob

CIM_ConcreteJob

Storage Classes