Msvm_VirtualSystemExportSettingData class

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

class Msvm_VirtualSystemExportSettingData : CIM_SettingData
{
  string  InstanceID;
  string  Caption;
  string  Description;
  string  ElementName;
  uint8   CopySnapshotConfiguration;
  boolean CopyVmRuntimeInformation;
  boolean CopyVmStorage;
  boolean CreateVmExportSubdirectory;
  string  SnapshotVirtualSystem;
};

Members

The Msvm_VirtualSystemExportSettingData class has these types of members:

Properties

The Msvm_VirtualSystemExportSettingData class has these properties.

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

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

CopySnapshotConfiguration
Data type: uint8
Access type: Read/write

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

ValueMeaning
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.

 

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.

ValueMeaning
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.

ValueMeaning
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.

ValueMeaning
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.

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.

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

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

See also

Virtual System Management Classes
ExportSystemDefinition

 

 

Community Additions

ADD
Show: