Msvm_MigrationJob class

Article
01/07/2021

This class represents a migration operation job created for storage or virtual system migration by the virtual system migration 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_MigrationJob : CIM_ConcreteJob
{
  string   InstanceID;
  string   Caption;
  string   Description;
  string   ElementName;
  datetime InstallDate;
  string   Name;
  uint16   OperationalStatus[] = { 2 };
  string   StatusDescriptions[] = { "OK" };
  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;
  uint16   RecoveryAction;
  string   OtherRecoveryAction;
  uint16   JobState;
  datetime TimeOfLastStateChange;
  datetime TimeBeforeRemoval = 00000000000500.000000:000;
  boolean  Cancellable;
  string   ErrorSummaryDescription;
  uint16   MigrationType;
  string   VirtualSystemName;
  string   DestinationHost;
  string   NewSystemSettingData;
  string   NewResourceSettingData[];
  uint16   JobType;
};

Members

The Msvm_MigrationJob class has these types of members:

Methods
Properties

Methods

The Msvm_MigrationJob class has these methods.

Method	Description
GetError	Retrieves the error object for the migration job, if one exists.
GetErrorEx	Retrieves the error objects for the migration job, if any exist.
KillJob	This method is not supported.
RequestStateChange	Requests that the state of the migration job be changed to the specified state.

Properties

The Msvm_MigrationJob 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.

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.

DestinationHost

Data type: string
Access type: Read-only

The hostname of the destination virtualization platform that the virtual system is migrating to. This will be Null for storage migration.

DetailedStatus

Data type: uint16
Access type: Read-only

Compliments 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 time interval that the job has been executing, or the total execution time if the job is complete. 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.

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
Qualifiers: Key

Uniquely identifies an instance of this class. This property is inherited from CIM_ManagedElement, and it is always set to Null.

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

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". 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 2 (New), 5(Suspended), or 11 (Service) states into the 4 (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 7 (Completed), 8 (Terminated), or 9 (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

Indicates the type of job being tracked by this object.

Unknown (0)

Creating Remote Virtual Machine (300)

Checking Virtual Machine Compatibility (301)

Checking Virtual Machine and Storage Compatibility (302)

Checking Storage Compatibility (303)

Checking Storage Migration (304)

Moving Virtual Machine (305)

Moving Virtual Machine and Storage (306)

Moving Storage (307)

LocalOrUtcTime

Data type: uint16
Access type: Read-only

This property is inherited from CIM_Job.

Indicates whether the times represented in the RunStartInterval and UntilTime properties represent local times or UTC times.

Local Time (1)
UTC Time (2 )

MigrationType

Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("Msvm_VirtualSystemMigrationSettingData.MigrationType")

The migration type represented by this job object. This will be one of the values defined for the MigrationType property of the Msvm_VirtualSystemMigrationSettingData class.

Name

Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen ( 256 )

The display name for this instance of a job. In addition, the display name can be used as a property for a search or query. This property is inherited from CIM_ManagedSystemElement.

NewResourceSettingData

Data type: string array
Access type: Read-only

For a live migration, this will always be set to Null.

For a storage migration, if this is Null, none of the virtual machine's virtual hard disks (VHDs) will be moved. Otherwise, this will contain an array of embedded instances of the Msvm_StorageAllocationSettingData class that represent the VHDs to be moved. The Connection property of these instances will specify the destination location of the VHD.

NewSystemSettingData

Data type: string
Access type: Read-only

For a live migration, this will always be set to Null.

For a storage migration, if this is Null, the virtual machine's data roots are not moving. Otherwise, this will contain an embedded instance of the Msvm_VirtualSystemSettingData class, where the ExternalDataRoot, SnapshotDataRoot, and SwapFileDataRoot properties will specify the new data roots.

Notify

Data type: string
Access type: Read-only

The user that is notified upon job completion or failure. This property is inherited from CIM_Job.

OperatingStatus

Data type: uint16
Access type: Read-only

Provides current status information for the operational condition of the element and can be used for providing more detail with respect to the value of the EnabledState property. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

OperationalStatus

Data type: uint16 array
Access type: Read-only

The current statuses of the object. This property is inherited from CIM_ManagedSystemElement, and each array element is always set to 2 (OK).

OtherRecoveryAction

Data type: string
Access type: Read-only

A string that describes the recovery action when the RecoveryAction property of the instance is 1 (Other). This property is inherited from CIM_Job.

Owner

Data type: string
Access type: Read-only

The user who submitted the job. This property is inherited from CIM_Job.

PercentComplete

Data type: uint16
Access type: Read-only
Qualifiers: MinValue ( 0 ), MaxValue ( 100 ), Units ( "Percent" )

The completion percentage of the job. This property is inherited from CIM_Job.

PrimaryStatus

Data type: uint16
Access type: Read-only

Provides high level status information. This property should be used in conjunction with the DetailedStatus property to provide high level and detailed health status of the element and its subcomponents. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Priority

Data type: uint32
Access type: Read-only

The importance of a job's execution. This property is inherited from CIM_Job.

RecoveryAction

Data type: uint16
Access type: Read-only

Describes the recovery action to be taken for an unsuccessfully run job. This property is inherited from CIM_Job.

Unknown (0)
Other (1)
Do Not Continue (2)
Continue With Next Job (3)
Re-run Job (4)
Run Recovery Job (5 )

RunDay

Data type: sint8
Access type: Read-only
Qualifiers: MinValue ( -31 ), MaxValue ( 31 )

The day of the month on which the job should be processed. There are different interpretations for this property, depending on the value of RunDayOfWeek.

When RunDayOfWeek is 0 and RunDay is positive, RunDay defines the day of the month on which the job is processed. For example, if RunDayOfWeek is 0 and RunDay is 12, then the job will be processed on the 12^th day of the month.

When RunDayOfWeek is 0 and RunDay is negative, RunDay defines the number of days before the last day of the month on which the job is processed. 1 indicates the last day of the month, 2 indicates one day before the last day of the month, and so on. For example, if RunDayOfWeek is 0 and RunDay is 1, then the job will be processed on the last day of the month.

When RunDayOfWeek is not 0, RunDayOfWeek is the day of the week that the job will be processed, relative to RunDay. For example, if RunDay is 15 and RunDayOfWeek is 7 (+Saturday), the job will be processed on the first Saturday on or after the 15^th day of the month. If RunDay is 20 and RunDayOfWeek is 7 ( Saturday), the job will be processed on the first Saturday on or before the 20^th day of the month. If RunDay is 1 and RunDayOfWeek is 1 ( Sunday), then the job will be processed on the last Sunday of the month.

This property is inherited from CIM_Job.

RunDayOfWeek

Data type: sint8
Access type: Read-only

A positive or negative integer used in conjunction with RunDay to indicate the day of the week or month on which the job is processed. See the description of the RunDay property for more information. This property is inherited from CIM_Job.

-Saturday ( 7)
-Friday ( 6)
-Thursday ( 5)
-Wednesday ( 4)
-Tuesday ( 3)
-Monday ( 2)
-Sunday ( 1)
ExactDayOfMonth (0)
Sunday (1)
Monday (2)
Tuesday (3)
Wednesday (4)
Thursday (5)
Friday (6)
Saturday (7 )

RunMonth

Data type: uint8
Access type: Read-only

The month during which the job should be processed. This property is inherited from CIM_Job.

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

The time interval after midnight when the job should be processed. This property is inherited from CIM_Job.

ScheduledStartTime

Data type: datetime
Access type: Read-only

The scheduled start time for the job, if applicable. 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

This property is inherited from CIM_ManagedSystemElement, but it is not used.

StatusDescriptions

Data type: string array
Access type: Read-only

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

Data type: datetime
Access type: Read-only

The amount of time, in minutes, 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, and it is always set to 00000000000500.000000:000.

TimeOfLastStateChange

Data type: datetime
Access type: Read-only

The date or time when the state of the job last changed. If the state of the job has not changed and this property is populated, then it must be set to a 0 interval value. If a state change was requested, but rejected or not yet processed, the property must not be updated. This property is inherited from CIM_ConcreteJob.

TimeSubmitted

Data type: datetime
Access type: Read-only

The time that the job was submitted. This property is inherited from CIM_Job.

UntilTime

Data type: datetime
Access type: Read-only

The time at which the job is not valid or should be stopped. This property is inherited from CIM_Job.

VirtualSystemName

Data type: string
Access type: Read-only

The unique name of the affected virtual system.

Requirements

Requirement	Value
Minimum supported client	Windows 8 [desktop apps only]
Minimum supported server	Windows Server 2012 [desktop apps only]
Namespace	Root\Virtualization\V2
MOF	WindowsVirtualization.V2.mof
DLL	Vmms.exe

Share via