ImportSystemDefinition method of the Msvm_VirtualSystemManagementService class

Creates a new planned computer system based on the specified virtual machine definition.


uint32 ImportSystemDefinition(
  [in]  string                         SystemDefinitionFile,
  [in]  string                         SnapshotFolder,
  [in]  boolean                        GenerateNewSystemIdentifier,
  [out] Msvm_PlannedComputerSystem REF ImportedSystem,
  [out] CIM_ConcreteJob            REF Job


SystemDefinitionFile [in]

The fully qualified path to the system definition file (.xml or .exp) representing the virtual machine which is to be imported. The definition file must not already be in use by the host system or the virtualization platform.

SnapshotFolder [in]

The fully qualified path to the folder where the snapshot configurations for this virtual machine can be found. This folder will be searched in order to locate any snapshots referenced by the virtual machine definition. Any referenced snapshots not found in this location must be deleted using the DestroySnapshot method, or imported using the ImportSnapshotDefinitions method prior to realizing the planned computer system.

GenerateNewSystemIdentifier [in]

Indicates whether to reuse the unique identifier for the virtual machine. If this parameter is True, then a new system identifier is generated. If this parameter is False, then the existing system identifier is used.

ImportedSystem [out]

If the operation completes synchronously, a reference to an Msvm_PlannedComputerSystem object that represents the imported virtual machine.

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)

File in Use (32779)


Requirement Value
Minimum supported client
Windows 8 [desktop apps only]
Minimum supported server
Windows Server 2012 [desktop apps only]

See also