Edit

Share via

Msvm_VirtualSystemExportSettingData class

  • Article

Provides additional information to be used with the ExportSystemDefinition method of the Msvm_VirtualSystemManagementService class.

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_VirtualSystemExportSettingData : CIM_SettingData
{
  uint8   CaptureLiveState;
  string  InstanceID;
  string  Caption;
  string  Description;
  string  ElementName;
  uint8   CopySnapshotConfiguration;
  boolean CopyVmRuntimeInformation;
  boolean CopyVmStorage;
  boolean CreateVmExportSubdirectory;
  string  SnapshotVirtualSystem;
  uint8   BackupIntent;
  boolean ExportForLiveMigration;
  boolean DisableDifferentialOfIgnoredStorage;
  string  ExcludedVirtualHardDisks[];
  string  DifferentialBackupBase;
};

Members

The Msvm_VirtualSystemExportSettingData class has these types of members:

Properties

The Msvm_VirtualSystemExportSettingData class has these properties.

BackupIntent

Data type: uint8

Access type: Read/write

Indicates the intent on how the exported backup sets would be used.

Note

This property was added in Windows 10 and Windows Server 2016.

BackupIntentPreserveChain (0)

All exported full and differential backup sets would be preserved as they are.

BackupIntentMerge (1)

The exported full and differential backup sets would be merged to synthesize full backup sets.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

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

CaptureLiveState

Data type: uint8

Access type: Read/write

Indicates what state to capture if the target of the export is a running VM.

CaptureCrashConsistentState (0)

No saved state files will be exported for the running VM, placing it in a crash consistent state.

CaptureSavedState (1)

Saved state files for the running VM will be exported along with the VM configuration.

CaptureAppConsistentState (2)

Application-consistent state of the running VM will be exported.

Note

Added in Windows 10 and Windows Server 2016.

CopySnapshotConfiguration

Data type: uint8

Access type: Read/write

Indicates what snapshots are to be exported with the virtual machine.

ExportAllSnapshots (0)

All snapshots will be exported with the virtual machine.

ExportNoSnapshots (1)

No snapshots will be exported with the virtual machine.

ExportOneSnapshot (2)

The snapshots identified by the SnapshotVirtualSystem property will be exported with the virtual machine. The CopyVmStorage and CopyVmRuntimeInformation properties are ignored, storage and run-time information is exported with the virtual machine, and any VHD differencing disks will be merged into a new VHD.

ExportOneSnapshotForBackup (3)

The snapshot identified by the SnapshotVirtualSystem property will be exported for the purpose of backing up the VM. The exported configuration will use ID of the VM.

Note

Added in Windows 10 and Windows Server 2016.

CopyVmRuntimeInformation

Data type: boolean

Access type: Read/write

Indicates whether the virtual machine run-time information will be copied when the virtual machine is exported.

Value Meaning
True
 The virtual machine run-time information will be copied.
False
 The virtual machine run-time information will not be copied.

CopyVmStorage

Data type: boolean

Access type: Read/write

Indicates whether the virtual machine storage will be copied when the virtual machine is exported.

Value Meaning
True
 The virtual machine storage will be copied.
False
 The virtual machine storage will not be copied.

CreateVmExportSubdirectory

Data type: boolean

Access type: Read/write

Indicates whether a subdirectory with the name of the virtual machine will be created when the virtual machine is exported.

Value Meaning
True
 A subdirectory will be created.
False
 A subdirectory will not be created.

Description

Data type: string

Access type: Read-only

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

DifferentialBackupBase

Data type: string

Access type: Read/write

Base for differential export. This is either path to a Msvm_VirtualSystemReferencePoint instance that represents the reference point or path to a Msvm_VirtualSystemSettingData instance that represents the snapshot to be used as a base for differential export. If the CopySnapshotConfiguration property is not set to 3(ExportOneSnapshotForBackup), this property is ignored.

Note

Added in Windows 10 and Windows Server 2016.

DisableDifferentialOfIgnoredStorage

Data type: boolean

Access type: Read/write

Indicates whether differencing disks will be created or not for storage ignored during export. By default this is set to false, which means that differencing disks are created for the storage that is not going to be copied over to the export destination.

Note

Added in Windows 10, version 1709.

ElementName

Data type: string

Access type: Read-only

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

ExcludedVirtualHardDisks

Data type: string array

Access type: Read/write

Array of Msvm_StorageAllocationSettingData (RASD) instance IDs that represent the virtual hard disks that are requested to be excluded from the export operation. If at least one of the supplied IDs is not a valid attached virtual hard disk, the operation will fail.

The virtual hard disks referenced by this property may be from the VM and/or from any of its snapshots. Exclusion of virtual hard disks is not supported when property CopySnapshotConfiguration is set to 0(ExportAllSnapshots).

Note that the RASD instance ID for virtual hard disks represents the location they are attached to, and excluding through this ID excludes all virtual hard disks attached in that location throughout the virtual machine's snapshot tree, regardless of them really being a valid virtual hard disk chain.

Note

Added in Windows 10, version 1709.

ExportForLiveMigration

Data type: boolean

Access type: Read/write

Indicates whether the exported VM is intended to be used in live migration.

Note

Added in Windows 10, version 1703 and Windows Server 2016.

InstanceID

Data type: string

Access type: Read-only

Qualifiers: Key

Within the scope of the instantiating Namespace, opaquely and uniquely identifies an instance of this class. This property is inherited from CIM_SettingData.

SnapshotVirtualSystem

Data type: string

Access type: Read/write

Path to a Msvm_VirtualSystemSettingData instance that represents the snapshot to be exported with the virtual machine. If the CopySnapshotConfiguration property is not set to 2 (ExportOneSnapshot), this property is ignored.

Remarks

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

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

See also

CIM_SettingData

Virtual System Management Classes

ExportSystemDefinition