Edit

ExportSystemDefinition method of the Msvm_VirtualSystemManagementService class

  • Article

Exports a virtual machine, or a snapshot of a virtual machine, to a file. The virtual machine must be in the "powered off" or "saved" state to be exported. The virtual machine, its associated configuration settings, and its associated resource settings will be preserved in the resulting file.

Syntax

uint32 ExportSystemDefinition(
  [in]  CIM_ComputerSystem REF ComputerSystem,
  [in]  string                 ExportDirectory,
  [in]  string                 ExportSettingData,
  [out] CIM_ConcreteJob    REF Job
);

Parameters

ComputerSystem [in]

A reference to a CIM_ComputerSystem that represents the virtual machine to be exported.

ExportDirectory [in]

The fully qualified path of the directory to which the virtual machine is to be exported. If the CreateVmExportSubdirectory property of the Msvm_VirtualSystemExportSettingData class in the ExportSettingData parameter is set to True, then this directory can be reused for exporting multiple virtual machines and this method places each virtual machine definition in a separate subdirectory under this path.

ExportSettingData [in]

An embedded instance of the Msvm_VirtualSystemExportSettingData class that represents the settings for the export operation.

Job [out]

If the operation is performed asynchronously, this method will return 4096, and this parameter will contain a reference to an object derived from CIM_ConcreteJob.

Return value

This method returns one of the following values.

Completed with No Error (0)

Method Parameters Checked - Job Started (4096)

Failed (32768)

Access Denied (32769)

Not Supported (32770)

Status is unknown (32771)

Timeout (32772)

Invalid parameter (32773)

System is in use (32774)

Invalid state for this operation (32775)

Incorrect data type (32776)

System is not available (32777)

Out of memory (32778)

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

Msvm_VirtualSystemManagementService