Msvm_VirtualSystemExportSettingData class

Article
2018-05-31

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

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[Dynamic, Provider("VmmsWmiInstanceAndMethodProvider"), AMENDMENT]
class Msvm_VirtualSystemExportSettingData : CIM_SettingData
{
  string  Caption;
  string  Description;
  string  InstanceID;
  string  ElementName;
  boolean CopyVmStorage;
  boolean CopyVmRuntimeInformation;
  boolean CreateVmExportSubdirectory;
  uint8   CopySnapshotConfiguration;
  string  SnapshotVirtualSystem;
};

Members

The Msvm_VirtualSystemExportSettingData class has these types of members:

Properties

Properties

The Msvm_VirtualSystemExportSettingData class has these properties.

Caption

Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

A short description (one-line string) of the object. This property is inherited from CIM_SettingData.

CopySnapshotConfiguration

Data type: uint8
Access type: Read/write

Indicates what snapshots are to be exported with the VM.

ExportAllSnapshots (0)

All snapshots will be exported with the VM.

ExportNoSnapshots (1)

No snapshots will be exported with the VM.

ExportOneSnapshot (2)

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

CopyVmRuntimeInformation

Data type: boolean
Access type: Read/write

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

Value	Meaning
TRUE	The VM run-time information will be copied.
FALSE	The VM run-time information will not be copied.

CopyVmStorage

Data type: boolean
Access type: Read/write

Indicates whether the VM storage will be copied when the VM is exported.

Value	Meaning
TRUE	The VM storage will be copied.
FALSE	The VM storage will not be copied.

CreateVmExportSubdirectory

Data type: boolean
Access type: Read/write

Indicates whether a subdirectory with the name of the VM will be created when the VM 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_SettingData.

ElementName

Data type: string
Access type: Read-only
Qualifiers: Required

The display name for this instance. In addition, the display name can be used as an index property for a search or query. (Note: The name does not have to be unique within a namespace.) This property is inherited from CIM_SettingData.

InstanceID

Data type: string
Access type: Read-only
Qualifiers: Key

Within the scope of the instantiating Namespace, InstanceID 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 VM. 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


Minimum supported client	None supported
Minimum supported server	Windows Server 2008 R2
End of client support	None supported
End of server support	Windows Server 2012 R2
Namespace	Root\Virtualization
MOF	WindowsVirtualization.mof

Share via