Msvm_MigrationJob クラス

[アーティクル]
06/12/2023

このクラスは、仮想システム移行サービスによってストレージまたは仮想システムの移行用に作成された移行操作ジョブを表します。

次の構文は、簡略化されたマネージドオブジェクト形式 (MOF) コードであり、継承されたすべてのプロパティが含まれています。

構文

[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;
};

メンバー

Msvm_MigrationJob クラスには、次の種類のメンバーがあります。

メソッド
プロパティ

メソッド

Msvm_MigrationJob クラスには、これらのメソッドがあります。

メソッド	説明
GetError	移行ジョブのエラーオブジェクト (存在する場合) を取得します。
GetErrorEx	移行ジョブのエラーオブジェクト (存在する場合) を取得します。
KillJob	このメソッドはサポートされていません。
RequestStateChange	移行ジョブの状態を指定した状態に変更することを要求します。

プロパティ

Msvm_MigrationJob クラスには、これらのプロパティがあります。

取り消し可能

データ型: ブール値
アクセスの種類: 読み取り専用

ジョブを取り消すことができるかどうかを示します。このプロパティの値は、ジョブを取り消す要求が成功することを保証するものではありません。

Caption

データ型: string
アクセスの種類: 読み取り専用

オブジェクトの簡単な説明。このプロパティは、 CIM_ManagedElementから継承されます。

CommunicationStatus

データ型: uint16
アクセスの種類: 読み取り専用

基になるマネージド要素と通信するインストルメンテーションの機能を示します。 Null 値は、このプロパティが実装されていないことを示します。このプロパティは、 CIM_ManagedSystemElementから継承されます。

DeleteOnCompletion

データ型: ブール値
アクセスの種類: 読み取り専用

完了時にジョブを自動的に削除するかどうかを指定します。このプロパティは、 CIM_Jobから継承されます。

説明

データ型: string
アクセスの種類: 読み取り専用

オブジェクトの説明。このプロパティは、 CIM_ManagedElementから継承されます。

DestinationHost

データ型: string
アクセスの種類: 読み取り専用

仮想システムが移行する移行先の仮想化プラットフォームのホスト名。これは、ストレージ移行の 場合は Null になります。

DetailedStatus

データ型: uint16
アクセスの種類: 読み取り専用

PrimaryStatus プロパティに追加の状態の詳細を補完します。 Null 値は、このプロパティが実装されていないことを示します。このプロパティは、 CIM_ManagedSystemElementから継承されます。

ElapsedTime

データ型: datetime
アクセスの種類: 読み取り専用

ジョブが実行されている時間間隔、またはジョブが完了した場合の合計実行時間。このプロパティは、 CIM_Jobから継承されます。

ElementName

データ型: string
アクセスの種類: 読み取り専用

オブジェクトの表示名。このプロパティは、 CIM_ManagedElementから継承されます。

ErrorCode

データ型: uint16
アクセスの種類: 読み取り専用

ベンダー固有のエラーコード。ジョブがエラーなしで完了した場合は、値を 0 に設定する必要があります。このプロパティは、 CIM_Jobから継承されます。

ErrorDescription

データ型: string
アクセスの種類: 読み取り専用

ベンダーエラーの説明を含む文字列。このプロパティは、 CIM_Jobから継承されます。

ErrorSummaryDescription

データ型: string
アクセスの種類: 読み取り専用
修飾子: ModelCorrespondence ("CIM_Job。ErrorCode")

エラーの概要の説明 (存在する場合)。

HealthState

データ型: uint16
アクセスの種類: 読み取り専用

要素の現在の正常性。この属性は、この要素の正常性を表しますが、必ずしもサブコンポーネントの正常性を表すわけではありません。指定できる値は 0 ~ 30 で、5 は要素が完全に正常であることを意味し、30 は要素が完全に非機能であることを意味します。このプロパティは CIM_ManagedSystemElementから継承され、常に 5 に設定されます。

InstallDate

データ型: datetime
アクセスの種類: 読み取り専用

仮想マシン構成が作成された日時。このプロパティは、 CIM_ManagedSystemElementから継承されます。

InstanceID

データ型: string
アクセスの種類: 読み取り専用
修飾子: キー

このクラスのインスタンスを一意に識別します。このプロパティは CIM_ManagedElementから継承され、常に Null に設定 されます。

JobRunTimes

データ型: uint32
アクセスの種類: 読み取り専用

ジョブを実行する必要がある回数。値 1 はジョブが繰り返されないことを示し、0 以外の値はジョブが繰り返される回数の制限を示します。ゼロは、ジョブを処理できる回数に制限がないことを示しますが、 UntilTime に達した後、またはジョブが手動で終了した後に終了されます。このプロパティは、 CIM_Jobから継承されます。

JobState

データ型: uint16
アクセスの種類: 読み取り専用

JobState は、ジョブの操作状態を示す整数列挙型です。また、"シャットダウン中" や "開始中" など、これらの状態間の遷移を示すこともできます。このプロパティは、 CIM_ConcreteJobから継承されます。

値	説明
[新規作成] 2	ジョブは開始されていません。
開始中 3	ジョブは、2 (新規)、5 (中断)、または 11 (サービス) 状態から 4 (実行中) 状態に移行しています。
実行中 4	ジョブは実行中です。
中断済み 5	ジョブは停止されますが、シームレスな方法で再起動できます。
シャットダウン 6	ジョブは、7 (完了)、8 (終了)、または 9 (強制終了) 状態に移行しています。
Completed 7	ジョブは正常に完了しました。
終了 8	ジョブが "Terminate" 状態変更要求によって停止されました。ジョブとその基になるすべてのプロセスが終了し、新しいジョブとしてのみ再起動できます。ジョブを新しいジョブとしてのみ再起動するという要件は、ジョブ固有です。
Killed 9	ジョブが "Kill" 状態変更要求によって停止されました。基になるプロセスがまだ実行されている可能性があり、リソースを解放するにはクリーンが必要な場合があります。
Exception 10	ジョブが異常な状態にあり、エラー状態を示している可能性があります。ジョブの実際の状態は、ジョブ固有のオブジェクトを介して使用できる場合があります。
サービス 11	ジョブは、問題の検出、解決、またはその両方をサポートするベンダー固有の状態です。
DMTF 予約済み 12 32767	予約済み。
ベンダー予約済み 32768 65535	予約済み。

JobStatus

データ型: string
アクセスの種類: 読み取り専用

ジョブの状態を表す文字列。このプロパティは、 CIM_Jobから継承されます。

JobType

データ型: uint16
アクセスの種類: 読み取り専用

このオブジェクトによって追跡されるジョブの種類を示します。

不明 (0)

リモート仮想マシンの作成 (300)

仮想マシンの互換性の確認 (301)

仮想マシンとストレージの互換性の確認 (302)

ストレージの互換性の確認 (303)

ストレージ移行の確認 (304)

仮想マシンの移動 (305)

仮想マシンとストレージの移動 (306)

ストレージの移動 (307)

LocalOrUtcTime

データ型: uint16
アクセスの種類: 読み取り専用

このプロパティは、 CIM_Jobから継承されます。

RunStartInterval プロパティと UntilTime プロパティで表される時刻がローカル時刻または UTC 時刻を表すかどうかを示します。

現地時刻 (1)
UTC 時刻 (2)

MigrationType

データ型: uint16
アクセスの種類: 読み取り専用
修飾子: ModelCorrespondence ("Msvm_VirtualSystemMigrationSettingData。MigrationType")

このジョブオブジェクトによって表される移行の種類。これは、Msvm_VirtualSystemMigrationSettingData クラスの MigrationType プロパティに定義されている値のいずれかになります。

Name

データ型: string
アクセスの種類: 読み取り専用
修飾子: Key、 MaxLen ( 256 )

ジョブのこのインスタンスの表示名。さらに、表示名は、検索またはクエリのプロパティとして使用できます。このプロパティは 、CIM_ManagedSystemElementから継承されます。

NewResourceSettingData

データ型: 文字列 配列
アクセスの種類: 読み取り専用

ライブマイグレーションの場合、これは常に Null に設定されます。

ストレージ移行の場合、これが Null の場合、仮想マシンの仮想ハードディスク (VHD) は移動されません。それ以外の場合、移動する VHD を表す Msvm_StorageAllocationSettingData クラスの埋め込みインスタンスの配列が含まれます。これらのインスタンスの Connection プロパティは、VHD の宛先の場所を指定します。

NewSystemSettingData

データ型: string
アクセスの種類: 読み取り専用

ライブマイグレーションの場合、これは常に Null に設定されます。

ストレージ移行の場合、これが Null の場合、仮想マシンのデータルートは移動しません。それ以外の場合、 これには Msvm_VirtualSystemSettingData クラスの埋め込みインスタンスが含まれます。 ExternalDataRoot、 SnapshotDataRoot、 および SwapFileDataRoot プロパティは、新しいデータルートを指定します。

通知

データ型: string
アクセスの種類: 読み取り専用

ジョブの完了または失敗時に通知されるユーザー。このプロパティは、 CIM_Jobから継承されます。

OperatingStatus

データ型: uint16
アクセスの種類: 読み取り専用

要素の操作条件の現在の状態情報を提供し、 EnabledState プロパティの値に関してより詳細な情報を提供するために使用できます。 Null 値は、このプロパティが実装されていないことを示します。このプロパティは 、CIM_ManagedSystemElementから継承されます。

OperationalStatus

データ型: uint16 配列
アクセスの種類: 読み取り専用

オブジェクトの現在の状態。このプロパティは CIM_ManagedSystemElementから継承され、各配列要素は常に 2 (OK) に設定されます。

OtherRecoveryAction

データ型: string
アクセスの種類: 読み取り専用

インスタンスの RecoveryAction プロパティが 1 (Other) の場合の回復アクションを表す文字列。このプロパティは、 CIM_Jobから継承されます。

所有者

データ型: string
アクセスの種類: 読み取り専用

ジョブを送信したユーザー。このプロパティは、 CIM_Jobから継承されます。

PercentComplete

データ型: uint16
アクセスの種類: 読み取り専用
修飾子: MinValue ( 0 ), MaxValue ( 100 ), Units ( "Percent" )

ジョブの完了率。このプロパティは、 CIM_Jobから継承されます。

PrimaryStatus

データ型: uint16
アクセスの種類: 読み取り専用

高レベルの状態情報を提供します。このプロパティは、要素とそのサブコンポーネントの高レベルで詳細な正常性状態を提供するために 、DetailedStatus プロパティと組み合わせて使用する必要があります。 Null 値は、このプロパティが実装されていないことを示します。このプロパティは 、CIM_ManagedSystemElementから継承されます。

優先順位

データ型: uint32
アクセスの種類: 読み取り専用

ジョブの実行の重要性。このプロパティは、 CIM_Jobから継承されます。

RecoveryAction

データ型: uint16
アクセスの種類: 読み取り専用

失敗した実行ジョブに対して実行される回復アクションについて説明します。このプロパティは、 CIM_Jobから継承されます。

不明 (0)
その他 (1)
続行しない (2)
次のジョブを続行 する (3)
ジョブの再実行 (4)
回復ジョブの実行 (5)

RunDay

データ型: sint8
アクセスの種類: 読み取り専用
修飾子: MinValue ( -31 ), MaxValue ( 31 )

ジョブを処理する月の日。このプロパティの解釈は、 RunDayOfWeek の値によって異なります。

RunDayOfWeek が 0 で RunDay が正の場合、RunDay はジョブが処理される月の日を定義します。たとえば、 RunDayOfWeek が 0 で RunDay が 12 の場合、ジョブは月の 12^日に処理されます。

RunDayOfWeek が 0 で RunDay が負の場合、RunDay はジョブが処理される月の最後の日の前の日数を定義します。 1 は月の最後の日を示し、2 は月の最終日の 1 日前を示します。などです。たとえば、 RunDayOfWeek が 0 で RunDay が 1 の場合、ジョブは月の最終日に処理されます。

RunDayOfWeek が 0 でない場合、RunDayOfWeek は RunDay を基準にしてジョブが処理される曜日です。たとえば、 RunDay が 15 で 、RunDayOfWeek が 7 (+Saturday) の場合、ジョブは月の 15^日以降の最初の土曜日に処理されます。 RunDay が 20 で、RunDayOfWeek が 7 ( 土曜日) の場合、ジョブは月の 20^日の前の最初の土曜日に処理されます。 RunDay が 1 で、RunDayOfWeek が 1 ( 日曜日) の場合、ジョブは月の最後の日曜日に処理されます。

このプロパティは、 CIM_Jobから継承されます。

RunDayOfWeek

データ型: sint8
アクセスの種類: 読み取り専用

ジョブが処理される曜日または月を示すために RunDay と組み合わせて使用される正または負の整数。詳細については、 RunDay プロパティの説明を参照してください。このプロパティは、 CIM_Jobから継承されます。

-Saturday ( 7)
-Friday ( 6)
-Thursday ( 5)
-Wednesday ( 4)
-Tuesday ( 3)
-Monday ( 2)
-Sunday ( 1)
ExactDayOfMonth (0)
日曜日 (1)
月曜日 (2)
火曜日 (3)
水曜日 (4)
木曜日 (5)
金曜日 (6)
土曜日 (7)

RunMonth

データ型: uint8
アクセスの種類: 読み取り専用

ジョブを処理する必要がある月。このプロパティは、 CIM_Jobから継承されます。

1 月 (0)
2 月 (1)
3 月 (2)
4 月 (3)
5 月 (4)
6 月 (5)
7 月 (6)
8 月 (7)
9 月 (8)
10 月 (9)
11 月 (10)
12 月 (11)

RunStartInterval

データ型: datetime
アクセスの種類: 読み取り専用

ジョブを処理する必要がある午前 0 時以降の時間間隔。このプロパティは、 CIM_Jobから継承されます。

ScheduledStartTime

データ型: datetime
アクセスの種類: 読み取り専用

ジョブのスケジュールされた開始時刻 (該当する場合)。このプロパティは、 CIM_Jobから継承されます。

StartTime

データ型: datetime
アクセスの種類: 読み取り専用

ジョブが開始された時刻。このプロパティは、 CIM_Jobから継承されます。

状態

データ型: string
アクセスの種類: 読み取り専用

このプロパティは CIM_ManagedSystemElementから継承されますが、使用されません。

StatusDescriptions

データ型: 文字列 配列
アクセスの種類: 読み取り専用

さまざまな OperationalStatus 配列値を記述する文字列。このプロパティは CIM_ManagedSystemElementから継承され、各配列要素は常に "OK" に設定されます。

TimeBeforeRemoval

データ型: datetime
アクセスの種類: 読み取り専用

ジョブの実行が完了した後にジョブが保持される時間 (分単位)。 DeleteOnCompletion プロパティの値に関係なく、ジョブは一定期間存在する必要があります。既定値は 5 分です。このプロパティは CIM_ConcreteJobから継承され、常に 00000000000500.000000:000 に設定されます。

TimeOfLastStateChange

データ型: datetime
アクセスの種類: 読み取り専用

ジョブの状態が最後に変更された日時。ジョブの状態が変更されておらず、このプロパティが設定されている場合は、0 間隔の値に設定する必要があります。状態の変更が要求されたが、拒否された場合、またはまだ処理されていない場合は、プロパティを更新しないでください。このプロパティは、 CIM_ConcreteJobから継承されます。

TimeSubmitted

データ型: datetime
アクセスの種類: 読み取り専用

ジョブが送信された時刻。このプロパティは、 CIM_Jobから継承されます。

UntilTime

データ型: datetime
アクセスの種類: 読み取り専用

ジョブが無効であるか、停止する必要がある時刻。このプロパティは、 CIM_Jobから継承されます。

VirtualSystemName

データ型: string
アクセスの種類: 読み取り専用

影響を受ける仮想システムの一意の名前。

要件

要件	値
サポートされている最小のクライアント	Windows 8 [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows Server 2012 [デスクトップアプリのみ]
名前空間	Root\Virtualization\V2
MOF	WindowsVirtualization.V2.mof
[DLL]	Vmms.exe

次の方法で共有

Msvm_MigrationJob クラス

構文

メンバー

メソッド

プロパティ

要件

フィードバック

その他のリソース