CreateVirtualSystemSnapshot method of the CIM_VirtualSystemManagementService class

Creates a snapshot of a virtual computer system.

Syntax

uint32 CreateVirtualSystemSnapshot(
  [in]  CIM_ComputerSystem           REF SourceSystem,
  [out] CIM_VirtualSystemSettingData REF SnapshotSettingData,
  [out] CIM_ConcreteJob              REF Job
);

Parameters

SourceSystem [in]

A reference to the virtual computer system to be snapshotted.

SnapshotSettingData [out]

The CIM_VirtualSystemSettingData instance that was created to represent the snapshot.

Job [out]

An optional reference that is returned if the operation is executed asynchronously. If present, the returned reference to an instance of CIM_ConcreteJob can be used to monitor progress and to obtain the result of the method.

Return value

If this method is executed synchronously, it returns 0 if it succeeds. If this method is executed asynchronously, it returns 4096 and the Job output parameter can be used to track the progress of the asynchronous operation. Any other return value indicates an error.

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 used (32774)

Invalid state for this operation (32775)

Incorrect data type (32776)

System is not available (32777)

Out of memory (32778)

Requirements

See also

CIM_VirtualSystemManagementService