Msvm_VirtualSystemSettingData クラス

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

仮想マシンの仮想化固有の設定を表します。

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

構文

[Dynamic, Provider("VmmsWmiInstanceAndMethodProvider"), AMENDMENT]
class Msvm_VirtualSystemSettingData : CIM_VirtualSystemSettingData
{
  string   InstanceID;
  string   Caption = "Virtual Machine Settings";
  string   Description;
  string   ElementName;
  string   VirtualSystemIdentifier;
  string   VirtualSystemType;
  string   Notes[];
  datetime CreationTime;
  string   ConfigurationID;
  string   ConfigurationDataRoot;
  string   ConfigurationFile;
  string   SnapshotDataRoot;
  string   SuspendDataRoot;
  string   SwapFileDataRoot;
  string   LogDataRoot;
  uint16   AutomaticStartupAction;
  datetime AutomaticStartupActionDelay;
  uint16   AutomaticStartupActionSequenceNumber;
  uint16   AutomaticShutdownAction;
  uint16   AutomaticRecoveryAction;
  string   RecoveryFile;
  string   BIOSGUID;
  string   BIOSSerialNumber;
  string   BaseBoardSerialNumber;
  string   ChassisSerialNumber;
  string   Architecture;
  string   ChassisAssetTag;
  boolean  BIOSNumLock;
  uint16   BootOrder[];
  string   Parent;
  uint16   UserSnapshotType;
  boolean  IsSaved;
  string   AdditionalRecoveryInformation;
  boolean  AllowFullSCSICommandSet;
  uint32   DebugChannelId;
  uint16   DebugPortEnabled;
  uint32   DebugPort;
  string   Version;
  boolean  IncrementalBackupEnabled;
  boolean  VirtualNumaEnabled;
  boolean  AllowReducedFcRedundancy = False;
  string   VirtualSystemSubType;
  string   BootSourceOrder[];
  boolean  PauseAfterBootFailure;
  uint16   NetworkBootPreferredProtocol;
  boolean  GuestControlledCacheTypes;
  boolean  AutomaticSnapshotsEnabled;
  boolean  IsAutomaticSnapshot;
  string   GuestStateFile;
  string   GuestStateDataRoot;
  boolean  LockOnDisconnect;
  string   ParentPackage;
  datetime AutomaticCriticalErrorActionTimeout;
  uint16   AutomaticCriticalErrorAction;
  uint16   ConsoleMode;
  boolean  SecureBootEnabled;
  string   SecureBootTemplateId;
  uint64   LowMmioGapSize;
  uint64   HighMmioGapSize;
  uint16   EnhancedSessionTransportType;
};

メンバー

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

Properties

プロパティ

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

AdditionalRecoveryInformation

データ型: string
アクセスの種類: 読み取り/書き込み

回復アクションに提供される追加情報。このプロパティの意味は、 AutomaticRecoveryAction のアクションによって定義されます。 AutomaticRecoveryAction が 0 ("None") または 1 ("Restart") の場合、この値は Null です。 AutomaticRecoveryAction が 2 ("スナップショットに戻す") の場合、これは仮想マシンワーカープロセスの失敗時に適用する必要があるスナップショットへのオブジェクトパスです。

AllowFullSCSICommandSet

データ型: boolean
アクセスの種類: 読み取り/書き込み

True を指定 すると、ゲストオペレーティングシステムの SCSI コマンドがパススルーディスクに渡されます。それ以外の場合 は False。 True の場合、ゲストオペレーティングシステムからパススルーディスクに出力される SCSI コマンドはフィルター処理されません。運用環境の展開では、SCSI フィルター処理を有効にしたままにすることをお勧めします。

AllowReducedFcRedundancy

データ型: boolean
アクセスの種類: 読み取り/書き込み

仮想ファイバーチャネルアダプターを使用して構成された仮想マシンのライブマイグレーションを、ターゲットファイバーチャネルデバイスへのパスが存在しないか、または縮小されている可能性がある移行先コンピューターに許可するかどうかを指定します。このプロパティは、ライブマイグレーション後にクリアする必要があります。

値	説明
False	仮想マシンは、ターゲットファイバーチャネルデバイスへのパスが存在しないか、または減少している可能性があるターゲットコンピューターにライブ移行できません。
True	仮想マシンは、ターゲットファイバーチャネルデバイスへのパスが存在しないか、または減少している可能性があるターゲットコンピューターにライブ移行できます。ゲストオペレーティングシステムがストレージへの接続を失う可能性があり、予期しない方法で動作する可能性があります。

アーキテクチャ

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

このシステムのアーキテクチャ。

注意

Windows 10 バージョン 1709 に追加されました。

x64 ()

arm64 ()

AutomaticCriticalErrorAction

データ型: uint16
アクセスの種類: 読み取り/書き込み

ストレージの切断など、重大なエラーが発生したときに VM で実行されるアクションを識別します。

注意

Windows 10 と Windows Server 2016 に追加されました。

なし (0)

重大なエラー状態に対して特定のアクションは実行されません。

再開の一時停止 (1)

重大なエラー状態が解決されると、VM が一時停止され、自動的に再開されます。

AutomaticCriticalErrorActionTimeout

データ型: datetime
アクセスの種類: 読み取り/書き込み
修飾子: SubType ("interval")

重大なエラーを解決するために AutomaticCriticalErrorAction を実行する最大期間を識別します。これは、 AutomaticCriticalErrorAction プロパティの値が 0 (なし) でない場合にのみ適用されます。タイムアウトが切れると、VM の電源がオフになります。値は、最も近い分に切り上げられます。値 0 は、重大なエラー状態が発生したときに VM の電源をすぐにオフにする必要があることを意味します。

注意

Windows 10 と Windows Server 2016 に追加されました。

AutomaticRecoveryAction

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

仮想マシンによって実行されたソフトウェアが失敗したときに仮想マシンに対して実行するアクション。この場合のエラーは、中断不可能な待機状態の状態など、ホストプラットフォームによって検出可能な障害を意味します。このプロパティは 、CIM_VirtualSystemSettingDataから継承されます。

これには、次のいずれかの値を指定できます。

値	意味
2	[なし] :
3	再起動して。
4	スナップショットに戻します。
5..32768	予約済み。

AutomaticShutdownAction

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

ホストがシャットダウンされたときに仮想マシンに対して実行するアクション。このプロパティは 、CIM_VirtualSystemSettingDataから継承されます。

これには、次のいずれかの値を指定できます。

値	意味
2	無効にする。
3	状態を保存します。
4	シャットダウン。
5..32768	予約済み。

AutomaticSnapshotsEnabled

データ型: boolean
アクセスの種類: 読み取り/書き込み

この仮想マシンで自動スナップショットを有効にする必要があるかどうかを示します。

注意

Windows 10 バージョン 1709 に追加されました。

AutomaticStartupAction

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

ホストの起動時に仮想マシンに対して実行するアクション。このプロパティは 、CIM_VirtualSystemSettingDataから継承されます。

これには、次のいずれかの値を指定できます。

値	意味
2	[なし] :
3	以前にアクティブだった場合は再起動します。
4	常に開始します。
5..32768	予約済み。

AutomaticStartupActionDelay

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

仮想マシンが自動的に起動するまでの遅延時間。このプロパティは 、CIM_VirtualSystemSettingDataから継承されます。

AutomaticStartupActionSequenceNumber

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

ホストシステムの起動時の仮想マシンのアクティブ化の相対シーケンスを示す数値。小さい数値は、以前のアクティブ化を示します。 1 つ以上の構成で同じ値が表示される場合、シーケンスは実装に依存します。値 0 は、シーケンスが実装に依存していることを示します。このプロパティは 、CIM_VirtualSystemSettingDataから継承されます。

BaseBoardSerialNumber

データ型: string
アクセスの種類: 読み取り/書き込み

仮想マシンのベースボードのシリアル番号。

BIOSGUID

データ型: string
アクセスの種類: 読み取り/書き込み

仮想マシンの BIOS のグローバル一意識別子。

BIOSNumLock

データ型: boolean
アクセスの種類: 読み取り/書き込み

TRUE を指定 すると、BIOS によって num ロックキーがオンに設定されます。 FALSE の 場合、BIOS によって num lock キーが off に設定されます。

BIOSSerialNumber

データ型: string
アクセスの種類: 読み取り/書き込み

仮想マシンの BIOS のシリアル番号。

BootOrder

データ型: uint16 配列
アクセスの種類: 読み取り/書き込み
修飾子: ArrayType ("Indexed")、 MAX (4)

仮想マシンの BIOS 内で設定されたブート順序。このプロパティは、 BootOrder[0] から BootOrder[3] までの値の配列であり、各値は起動元のデバイスを示します。配列内の 4 つの各値を設定する必要があり、配列内の別の値と同じにすることはできません。仮想マシンは、まず、配列内の最初の値によって示されるデバイスから起動を試みます。そのデバイスにブートセクターが含まれていない場合、仮想マシンは BootOrder プロパティで指定された次のデバイスから起動しようとします。ブートセクターを含む BootOrder 内に指定されたデバイスがない場合、仮想マシンは起動に失敗します。仮想マシンの既定値は [0, 1, 2, 3] です。

フロッピー (0)

仮想マシンは、フロッピードライブ内のフロッピーディスクから起動しようとします。

CD-ROM (1)

仮想マシンは、ブートセクターで検出された最初の CD または DVD ディスクから起動を試みます。

IDE ハードドライブ (2)

仮想マシンは、ブートセクターで検出された最初のハードディスクドライブから起動を試みます。

PXE ブート (3)

仮想マシンは、ネットワークから PXE ブートを試みます。

SCSI ハードドライブ (4)

予約済み (5..65535)

BootSourceOrder

データ型: 文字列 配列
アクセスの種類: 読み取り/書き込み

仮想マシンのブートソースの順序。

Windows 8.1: この値は、Windows 8.1して R2 をWindows Server 2012するまでサポートされません。

Caption

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

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

ChassisAssetTag

データ型: string
アクセスの種類: 読み取り/書き込み

仮想マシンのシャーシの資産タグ。

ChassisSerialNumber

データ型: string
アクセスの種類: 読み取り/書き込み

仮想マシンのシャーシのシリアル番号。

ConfigurationDataRoot

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

仮想マシンの構成に関する情報が格納されているディレクトリのパス。このプロパティは 、CIM_VirtualSystemSettingDataから継承されます。

ConfigurationFile

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

仮想マシン構成に関する情報が格納されているファイルの相対パスとファイル名。このパスは 、ConfigurationDataRoot プロパティに対する相対パスです。このプロパティは 、CIM_VirtualSystemSettingDataから継承されます。

ConfigurationID

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

仮想マシン構成の一意識別子。このプロパティは 、CIM_VirtualSystemSettingDataから継承されます。

ConsoleMode

データ型: uint16
アクセスの種類: 読み取り/書き込み

VM のコンソールモードを識別します。

注意

このプロパティは、Windows 10 および Windows Server 2016 で追加されました。

既定値 (0)

COM1 (1)

COM2 (2)

なし (3)

CreationTime

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

仮想マシンの設定が作成された日時。このオブジェクトが仮想マシンの現在の設定を表す場合、この値はシステムが作成された時刻になります。このオブジェクトが仮想マシンのスナップショット設定を表す場合、この値はスナップショットが取得された時刻になります。このプロパティは 、CIM_VirtualSystemSettingDataから継承されます。

DebugChannelId

データ型: uint32
アクセスの種類: 読み取り/書き込み

統合デバッガーを使用して仮想マシンをデバッグするために使用されるチャネル識別子。

DebugPort

データ型: uint32
アクセスの種類: 読み取り/書き込み

合成デバッグを使用して仮想マシンをデバッグするために使用される TCP/IP ポート。

DebugPortEnabled

データ型: uint16
アクセスの種類: 読み取り/書き込み

仮想マシンが合成デバッグを使用しているかどうかを指定します。これには、次のいずれかの値を指定できます。

Off (0)

On (1)

OnAutoAssigned (2)

自動割り当て

説明

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

オブジェクトの説明。このプロパティは CIM_ManagedElementから継承され、常に次のいずれかの値に設定されます。

値	説明
"仮想マシンのアクティブな設定"	このインスタンスは仮想マシンを参照します。
"仮想マシンのスナップショット設定"	このインスタンスは、スナップショットを参照します。

ElementName

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

オブジェクトの表示名。このプロパティは CIM_VirtualSystemSettingDataから継承され、常にマシンの表示名に設定されます。この名前の長さは 100 文字以下です。

EnhancedSessionTransportType

データ型: uint16
アクセスの種類: 読み取り/書き込み

拡張セッションに接続するときに使用するトランスポートの種類を示します。

注意

このプロパティは、Windows 10 バージョン 1803 で追加されました。

VMBus パイプ (0)

Hyper-V ソケット (1)

GuestControlledCacheTypes

データ型: boolean
アクセスの種類: 読み取り/書き込み

ゲストがキャッシュの種類を制御できるかどうかを示します。

注意

Windows 10 と Windows Server 2016 に追加されました。

GuestStateDataRoot

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

ゲストランタイムの状態に関する情報が格納されているディレクトリのファイルパス。

注意

Windows 10 バージョン 1709 に追加されました。

GuestStateFile

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

ゲストランタイムの状態に関する情報が格納されているファイルの Filepath。相対パスは 、GuestStateDataRoot プロパティの値に追加されます。

注意

Windows 10 バージョン 1709 に追加されました。

HighMmioGapSize

データ型: uint64
アクセスの種類: 読み取り/書き込み

高 (4 GB 以上) Memory-Mapped IO ギャップのサイズ (MB)

注意

このプロパティは、Windows 10 バージョン 1703 で追加されました。

IncrementalBackupEnabled

データ型: boolean
アクセスの種類: 読み取り/書き込み

Hyper-V VSS ライターで、この仮想マシンの増分バックアップの作成がサポートされているかどうかを示します。

InstanceID

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

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

IsAutomaticSnapshot

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

これがユーザーに対して自動的に作成されるスナップショットであるかどうかを示します。

注意

Windows 10 バージョン 1709 で追加されました。

IsSaved

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

True の 場合は、構成に保存された状態ファイルへの参照があります。それ以外の場合は False。これは、このようなファイルが存在することを示すのではなく、構成で指定されているファイルのみです。

LockOnDisconnect

データ型: ブール値
アクセスの種類: 読み取り/書き込み

vmconnect から切断するときにコンソールをロックします。

注意

Windows 10 と Windows Server 2016 に追加されました。

LogDataRoot

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

仮想マシンのログ情報が格納されているディレクトリのパス。このプロパティは、 CIM_VirtualSystemSettingDataから継承されます。

LowMmioGapSize

データ型: uint64
アクセスの種類: 読み取り/書き込み

仮想マシン (VM) の最初の MMIO ギャップのサイズを MB 単位で構成します。

Windows 8.1: この値は、Windows 8.1して R2 をWindows Server 2012するまでサポートされません。

範囲: 128 3584

NetworkBootPreferredProtocol

データ型: uint16
アクセスの種類: 読み取り/書き込み

PXE ブートに推奨されるプロトコルが IPv4 または IPv6 かどうかを決定します。

Windows 8.1: この値は、Windows 8.1して R2 をWindows Server 2012するまでサポートされません。

IPv4 (4096)

IPv6 (4097)

メモ

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

仮想マシンに関連するユーザー指定のメモ。このプロパティは、 CIM_VirtualSystemSettingDataから継承されます。

Parent

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

このインスタンスが仮想マシンのスナップショットに基づくシステムを表さない場合、このプロパティは Null です。それ以外の場合、プロパティは、このインスタンスの基になっている Msvm_VirtualSystemSettingData オブジェクトのオブジェクトパスを保持します。仮想マシンのスナップショットツリー階層を構築する場合、このプロパティは現在のインスタンスの派生元のオブジェクトを参照します (現在のインスタンスは子ノード、このプロパティで参照されるオブジェクトは親ノードです)。

ParentPackage

データ型: string
アクセスの種類: 読み取り/書き込み

このシステムがコンテナーの場合、このシステムの基になるMsvm_ContainerPackageへのパス。

注意

Windows 10で追加されました。バージョン 1703 Windows 10で削除されました。

PauseAfterBootFailure

データ型: ブール値
アクセスの種類: 読み取り/書き込み

ユーザーがキーを押すのを待機しているブートエントリエラーのたびに BIOS が一時停止するかどうかを示します。 TRUE の 場合、BIOS が一時停止します。それ以外の場合は False。

Windows 8.1: この値は、Windows 8.1して R2 をWindows Server 2012するまでサポートされません。

RecoveryFile

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

仮想マシンの回復関連情報が格納されているファイルの完全パス。このプロパティは、 CIM_VirtualSystemSettingDataから継承されます。

SecureBootEnabled

データ型: ブール値
アクセスの種類: 読み取り/書き込み

仮想マシン (VM) に対してセキュアブートが有効になっているかどうかを示します。 True の 場合は有効です。それ以外の場合は False。

注意

セキュアブートは、第 2 世代 VM でのみ有効にすることができます。

Windows 8.1: この値は、Windows 8.1して R2 をWindows Server 2012するまでサポートされません。

SecureBootTemplateId

データ型: string
アクセスの種類: 読み取り/書き込み

UEFI セキュアブート関連変数の初期化値のテンプレートのグローバル一意識別子。

これは読み取り専用プロパティですが、Msvm_VirtualSystemManagementService クラスの ModifyVirtualSystem メソッドを使用して変更できます。

注意

Windows 10 と Windows Server 2016 に追加されました。

SnapshotDataRoot

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

仮想マシンのスナップショットに関する情報が格納されているディレクトリのパス。このプロパティは、 CIM_VirtualSystemSettingDataから継承されます。

SuspendDataRoot

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

仮想マシンに関する情報が中断関連情報が格納されるディレクトリのパス。このプロパティは、 CIM_VirtualSystemSettingDataから継承されます。

SwapFileDataRoot

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

仮想マシンのスワップファイルが格納されるディレクトリのパス。このプロパティは、 CIM_VirtualSystemSettingDataから継承されます。

UserSnapshotType

データ型: uint16
アクセスの種類: 読み取り/書き込み

ユーザー定義のスナップショット型を示します。

注意

Windows 10 と Windows Server 2016 に追加されました。

無効にする (2)

スナップショットの作成を無効にします。

ProductionFallbackToTest (3)

運用環境で使用するためのデータ整合性スナップショット。データ整合性スナップショットを作成する機能が使用できない場合に、アプリケーションの状態でスナップショットを実行します。

ProductionNoFallback (4)

運用環境で使用するためのデータ整合性スナップショット。データ整合性スナップショットを作成できない場合は、アプリケーションの状態を持つスナップショットを作成しません。

テスト (5)

テストと開発の目的でメモリとデバイスの情報を含むスナップショット。

Version

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

"major.minor" の形式の仮想マシンのバージョン ("2.0" など)。

VirtualNumaEnabled

データ型: boolean
アクセスの種類: 読み取り/書き込み
修飾子: ModelCorrespondence ("Msvm_ProcessorSettingData。MaxProcessorsPerNumaNode", "Msvm_MemorySettingData。MaxMemoryBlocksPerNumaNode")

True を指定 すると、仮想マシンに仮想非均一メモリアクセス (NUMA) ノードが投影されます。 False を指定 すると、仮想マシンに 1 つのノードが含まれます。 True の場合、仮想マシンに投影される仮想 NUMA ノードの数は、Msvm_ProcessorSettingData.MaxProcessorsPerNumaNode プロパティと Msvm_MemorySettingData.MaxMemoryBlocksPerNumaNode プロパティの値から決まります。

VirtualSystemIdentifier

データ型: string
アクセスの種類: 読み取り専用
修飾子: オーバーライド ("CIM_VirtualSystemSettingData.VirtualSystemIdentifier")、 ModelCorrespondence ("CIM_ComputerSystem。Name")

この設定データが属する CIM_ComputerSystem オブジェクトの名前。このプロパティは、 CIM_VirtualSystemSettingDataからのオーバーライドです。

VirtualSystemSubType

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

このプロパティの有効な値は、Microsoft:Hyper-V:SubType:1 と Microsoft:Hyper-V:SubType:2 です。第 1 世代 VM はサブタイプ 1 です。第 2 世代 VM はサブタイプ 2 です。

Windows 8.1: この値は、Windows 8.1して R2 をWindows Server 2012するまでサポートされません。

Microsoft:Hyper-V:SubType:1 ("Microsoft:Hyper-V:SubType:1")

Microsoft:Hyper-V:SubType:2 ("Microsoft:Hyper-V:SubType:2")

VirtualSystemType

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

設定データが表す仮想マシンの種類を指定します。このプロパティは、 CIM_VirtualSystemSettingData クラスから継承されます。これは、次のいずれかの値になります。

値	説明
"Microsoft:Hyper-V:System:Realized"	実現された仮想マシン。
"Microsoft:Hyper-V:System:Planned"	計画された仮想マシン。
"Microsoft:Hyper-V:Snapshot:Realized"	実現された仮想マシンのスナップショット。
"Microsoft:Hyper-V:Snapshot:Recovery"	復旧仮想マシンのスナップショット。
"Microsoft:Hyper-V:Snapshot:Planned"	計画された仮想マシンのスナップショット。
"Microsoft:Hyper-V:Snapshot:Missing"	不足しているスナップショット。
"Microsoft:Hyper-V:Snapshot:Replica:Standard"	時間ベースのレプリケーションポイントスナップショット。
"Microsoft:Hyper-V:Snapshot:Replica:ApplicationConsistent"	VSS レプリケーションポイントスナップショット。
"Microsoft:Hyper-V:Snapshot:Replica:PlannedFailover"	計画されたレプリケーションスナップショット。

注釈

MSVM_VIRTUALSYSTEMSETTINGDATA クラスへのアクセスは、UAC フィルター処理によって制限される場合があります。詳細については、「ユーザーアカウント制御と WMI」を参照してください。

要件

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

こちらもご覧ください

CIM_VirtualSystemSettingData
CIM_VirtualSystemSettingData
仮想システムクラス

次の方法で共有

Msvm_VirtualSystemSettingData クラス

構文

メンバー

プロパティ

注釈

要件

こちらもご覧ください

フィードバック

その他のリソース