Msvm_MigrationJob, ROOT\virtualization\v2

Class | Methods (4) | Properties (46) | Qualifiers (4) | Instances | Namespaces (2)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

This class represents a migration operation job created for storage orvirtual system migration by virtual system migration service.

Msvm_MigrationJob methods

Msvm_MigrationJob has 4 methods (1 Local, 3 Derived)

NameOriginReturn
GetErrorCIM_ConcreteJobuint32 {'out':True}
GetErrorExMsvm_MigrationJobuint32 {'out':True}
KillJobCIM_Jobuint32 {'out':True}
RequestStateChangeCIM_ConcreteJobuint32 {'out':True}

Msvm_MigrationJob properties

Msvm_MigrationJob has 46 properties (8 Local, 38 Derived)

NameOriginCIMType
CancellableMsvm_MigrationJob11 [boolean]
CaptionCIM_ManagedElement8 [string]
CommunicationStatusCIM_ManagedSystemElement18 [uint16]
DeleteOnCompletionCIM_Job11 [boolean]
DescriptionCIM_ManagedElement8 [string]
DestinationHostMsvm_MigrationJob8 [string]
DetailedStatusCIM_ManagedSystemElement18 [uint16]
ElapsedTimeCIM_Job101 [datetime]
ElementNameCIM_ManagedElement8 [string]
ErrorCodeCIM_Job18 [uint16]
ErrorDescriptionCIM_Job8 [string]
ErrorSummaryDescriptionMsvm_MigrationJob8 [string]
HealthStateCIM_ManagedSystemElement18 [uint16]
InstallDateCIM_ManagedSystemElement101 [datetime]
key
InstanceID
CIM_ManagedElement8 [string]
JobRunTimesCIM_Job19 [uint32]
JobStateCIM_ConcreteJob18 [uint16]
JobStatusCIM_Job8 [string]
JobTypeMsvm_MigrationJob18 [uint16]
LocalOrUtcTimeCIM_Job18 [uint16]
MigrationTypeMsvm_MigrationJob18 [uint16]
NameCIM_ManagedSystemElement8 [string]
NewResourceSettingDataMsvm_MigrationJob8 [string]
NewSystemSettingDataMsvm_MigrationJob8 [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]
TimeBeforeRemovalCIM_ConcreteJob101 [datetime]
TimeOfLastStateChangeCIM_ConcreteJob101 [datetime]
TimeSubmittedCIM_Job101 [datetime]
UntilTimeCIM_Job101 [datetime]
VirtualSystemNameMsvm_MigrationJob8 [string]

Detailed description of Msvm_MigrationJob methods

Local methods (1) of Msvm_MigrationJob class

GetErrorEx method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Errorsstring0-{'ArrayType':'Indexed','Description':'If the operational status of the job is not "OK", this method returns an array of Msvm_Error instances. Otherwise, if the job is "OK", NULL is returned.','HyperVEmbeddedInstance':'Msvm_Error','Out':True}
Bypass_GetObjectTrue
Description'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 instances are returned.'
ImplementedTrue
ValueMap['0', '32768', '32769', '32770', '32771', '32772', '32773', '32774', '32775', '32776', '32777', '32778']
Values['Completed with No Error', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in used', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
GetErrorEx method is in 4 classes of ROOT\virtualization\v2 and in 2 namespaces

Derived methods (3) of Msvm_MigrationJob class

GetError method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Errorstring0-{'Description':'If the OperationalStatus on the Job is not "OK", then this method will return a CIM Error instance. Otherwise, when the Job is "OK", null is returned.','HyperVEmbeddedInstance':'CIM_Error'}
Bypass_GetObjectTrue
ImplementedTrue
Override'CIM_ConcreteJob.GetError'
ValueMap['0', '32768', '32769', '32770', '32771', '32772', '32773', '32774', '32775', '32776', '32777', '32778']
Values['Completed with No Error', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in used', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
GetError method is in 5 classes of ROOT\virtualization\v2 and in 8 namespaces
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.'}
KillJob method is in 6 classes of ROOT\virtualization\v2 and in 8 namespaces
RequestStateChange method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
RequestedStateuint160-{'Description':'RequestStateChange changes the state of a job. The possible values are as follows: Start (2) changes the state to 'Running'. Suspend (3) stops the job temporarily. The intention is to subsequently restart the job with 'Start'. It might be possible to enter the 'Service' state while suspended. (This is job-specific.) Terminate (4) stops the job cleanly, saving data, preserving the state, and shutting down all underlying processes in an orderly manner. Kill (5) terminates the job immediately with no requirement to save data or preserve the state. Service (6) puts the job into a vendor-specific service state. It might be possible to restart the job.','ValueMap':['2', '3', '4', '5', '6', '7..32767', '32768..65535'],'Values':['Start', 'Suspend', 'Terminate', 'Kill', 'Service', 'DMTF Reserved', 'Vendor Reserved']}
TimeoutPerioddatetime1-{'Description':'A timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format must be used to specify the TimeoutPeriod. A value of 0 or a null parameter indicates that the client has no time requirements for the transition. If this property does not contain 0 or null and the implementation does not support this parameter, a return code of 'Use Of Timeout Parameter Not Supported' must be returned.'}
Bypass_GetObjectTrue
ImplementedTrue
Override'CIM_ConcreteJob.RequestStateChange'
ValueMap['0', '32768', '32769', '32770', '32771', '32772', '32773', '32774', '32775', '32776', '32777', '32778']
RequestStateChange method is in 111 classes of ROOT\virtualization\v2 and in 15 namespaces

Detailed description of Msvm_MigrationJob properties

Local properties (8) of Msvm_MigrationJob class

Cancellable property
CIMTYPE'boolean'
Description'Indicates whether the job can be cancelled. The value of this property does not guarantee that a request to cancel the job will succeed.'
readTrue
Cancellable property is in 4 classes of ROOT\virtualization\v2 and in 2 namespaces
DestinationHost property
CIMTYPE'string'
Description'Hostname the destination virtualization platform where the virtual system is migrating. It will be NULL for storage migration.'
readTrue
DestinationHost property is in 1 class (Msvm_MigrationJob) of ROOT\virtualization\v2 and in 2 namespaces
ErrorSummaryDescription property
CIMTYPE'string'
ModelCorrespondence['CIM_Job.ErrorCode']
readTrue
ErrorSummaryDescription property is in 4 classes of ROOT\virtualization\v2 and in 1 namespace
JobType property
CIMTYPE'uint16'
Description'Indicates the type of Job being tracked by this object.'
readTrue
ValueMap['0', '300', '301', '302', '303', '304', '305', '306', '307']
Values['Unknown', 'Creating Remote Virtual Machine', 'Checking Virtual Machine Compatibility', 'Checking Virtual Machine and Storage Compatibility', 'Checking Storage Compatibility', 'Checking Storage Migration', 'Moving Virtual Machine', 'Moving Virtual Machine and Storage', 'Moving Storage']
JobType property is in 3 classes of ROOT\virtualization\v2 and in 2 namespaces
MigrationType property
CIMTYPE'uint16'
Description'The migration type as defined in Msvm_VirtualSystemMigrationSettingData.MigrationType. This can beused to identify the type of migration the job represents.'
ModelCorrespondence['Msvm_VirtualSystemMigrationSettingData.MigrationType']
readTrue
MigrationType property is in 3 classes of ROOT\virtualization\v2 and in 2 namespaces
NewResourceSettingData property
CIMTYPE'string'
Description'For Live Migration this must be set to NULL. For Storage Migration, it will specify the virtual machine's virtual hard drives which moved and where they moved. If not NULL, NewResourceSettingData will contain an array of embedded instances of resource allocation setting data (RASD) which represent VHDs. Destination location will be provided using Connection property of RASD.'
readTrue
NewResourceSettingData property is in 1 class (Msvm_MigrationJob) of ROOT\virtualization\v2 and in 2 namespaces
NewSystemSettingData property
CIMTYPE'string'
Description'For Live Migration this will be set to NULL. For Storage Migration, it will indicate the new path for virtual machine data (ExternalDataRoot, SnapshotDataRoot and SwapFileDataRoot). This being NULL indicates that virtual machine's data roots are not moving. Otherwise NewSystemSettingData will be instance of Msvm_VirtualSystemGlobalSettingData containing properties ExternalDataRoot, SnapshotDataRoot and SwapFileDataRoot. If not NULL, ExternalDataRoot property will specify new location of virtual machine's current configuration and saved state. If not NULL, SnapshotDataRoot property will specify new location for snapshots data. If not NULL, SwapFileDataRoot property will specify new location of virtual machine's Smart Paging files '
readTrue
NewSystemSettingData property is in 1 class (Msvm_MigrationJob) of ROOT\virtualization\v2 and in 2 namespaces
VirtualSystemName property
CIMTYPE'string'
Description'GUID of the affected virtual system.'
readTrue
VirtualSystemName property is in 2 classes of ROOT\virtualization\v2 and in 2 namespaces

Derived properties (38) of Msvm_MigrationJob 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
DeleteOnCompletion property
CIMTYPE'boolean'
DeleteOnCompletion property is in 6 classes of ROOT\virtualization\v2 and in 11 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
ElapsedTime property
CIMTYPE'datetime'
ElapsedTime property is in 6 classes of ROOT\virtualization\v2 and in 17 namespaces
ElementName property
CIMTYPE'string'
ElementName property is in 223 classes of ROOT\virtualization\v2 and in 21 namespaces
ErrorCode property
CIMTYPE'uint16'
ErrorCode property is in 8 classes of ROOT\virtualization\v2 and in 142 namespaces
ErrorDescription property
CIMTYPE'string'
ErrorDescription property is in 71 classes of ROOT\virtualization\v2 and in 142 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'
keyTrue
InstanceID property is in 223 classes of ROOT\virtualization\v2 and in 21 namespaces
JobRunTimes property
CIMTYPE'uint32'
JobRunTimes property is in 6 classes of ROOT\virtualization\v2 and in 8 namespaces
JobState property
CIMTYPE'uint16'
JobState property is in 5 classes of ROOT\virtualization\v2 and in 13 namespaces
JobStatus property
CIMTYPE'string'
JobStatus property is in 6 classes of ROOT\virtualization\v2 and in 15 namespaces
LocalOrUtcTime property
CIMTYPE'uint16'
LocalOrUtcTime property is in 6 classes of ROOT\virtualization\v2 and in 13 namespaces
Name property
CIMTYPE'string'
Name property is in 152 classes of ROOT\virtualization\v2 and in 142 namespaces
Notify property
CIMTYPE'string'
Notify property is in 6 classes of ROOT\virtualization\v2 and in 13 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
OtherRecoveryAction property
CIMTYPE'string'
OtherRecoveryAction property is in 6 classes of ROOT\virtualization\v2 and in 11 namespaces
Owner property
CIMTYPE'string'
Owner property is in 7 classes of ROOT\virtualization\v2 and in 142 namespaces
PercentComplete property
CIMTYPE'uint16'
PercentComplete property is in 6 classes of ROOT\virtualization\v2 and in 15 namespaces
PrimaryStatus property
CIMTYPE'uint16'
PrimaryStatus property is in 127 classes of ROOT\virtualization\v2 and in 9 namespaces
Priority property
CIMTYPE'uint32'
Priority property is in 8 classes of ROOT\virtualization\v2 and in 31 namespaces
RecoveryAction property
CIMTYPE'uint16'
RecoveryAction property is in 6 classes of ROOT\virtualization\v2 and in 11 namespaces
RunDay property
CIMTYPE'sint8'
RunDay property is in 6 classes of ROOT\virtualization\v2 and in 8 namespaces
RunDayOfWeek property
CIMTYPE'sint8'
RunDayOfWeek property is in 6 classes of ROOT\virtualization\v2 and in 8 namespaces
RunMonth property
CIMTYPE'uint8'
RunMonth property is in 6 classes of ROOT\virtualization\v2 and in 8 namespaces
RunStartInterval property
CIMTYPE'datetime'
RunStartInterval property is in 6 classes of ROOT\virtualization\v2 and in 8 namespaces
ScheduledStartTime property
CIMTYPE'datetime'
ScheduledStartTime property is in 6 classes of ROOT\virtualization\v2 and in 8 namespaces
StartTime property
CIMTYPE'datetime'
StartTime property is in 6 classes of ROOT\virtualization\v2 and in 24 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
TimeBeforeRemoval property
CIMTYPE'datetime'
TimeBeforeRemoval property is in 5 classes of ROOT\virtualization\v2 and in 13 namespaces
TimeOfLastStateChange property
CIMTYPE'datetime'
TimeOfLastStateChange property is in 111 classes of ROOT\virtualization\v2 and in 17 namespaces
TimeSubmitted property
CIMTYPE'datetime'
TimeSubmitted property is in 6 classes of ROOT\virtualization\v2 and in 15 namespaces
UntilTime property
CIMTYPE'datetime'
UntilTime property is in 6 classes of ROOT\virtualization\v2 and in 10 namespaces

Msvm_MigrationJob Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
Description'This class represents a migration operation job created for storage orvirtual system migration by virtual system migration service.'
dynamicTrue
Locale1033
provider'VmmsWmiInstanceAndMethodProvider'

Msvm_MigrationJob System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\virtualization\v2:Msvm_MigrationJob'___SYSTEM8
__NAMESPACE'ROOT\virtualization\v2'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['CIM_ConcreteJob', 'CIM_Job', 'CIM_LogicalElement', 'CIM_ManagedSystemElement', 'CIM_ManagedElement']___SYSTEM8
__PROPERTY_COUNT46___SYSTEM3
__RELPATH'Msvm_MigrationJob'___SYSTEM8
__DYNASTY'CIM_ManagedElement'___SYSTEM8
__SUPERCLASS'CIM_ConcreteJob'___SYSTEM8
__CLASS'Msvm_MigrationJob'___SYSTEM8
__GENUS1___SYSTEM3
WUtils.com
online utility - toplist