CreateSnapshot method of the CIM_VirtualSystemSnapshotService class

Creates a snapshot of a virtual system.

Syntax

uint32 CreateSnapshot(
  [in]      CIM_ComputerSystem           REF AffectedSystem,
  [in]      string                           SnapshotSettings,
  [in]      uint16                           SnapshotType,
  [in, out] CIM_VirtualSystemSettingData REF ResultingSnapshot,
  [out]     CIM_ConcreteJob              REF Job
);

Parameters

AffectedSystem [in]

A CIM_ComputerSystem reference to the affected virtual system.

SnapshotSettings [in]

Parameter settings.

SnapshotType [in]

Requested snapshot type:

Full Snapshot (2)

Complete snapshot of the virtual system.

Disk Snapshot (3)

Snapshot of virtual system disks.

DMTF Reserved (..)

Vendor Specific (32768..65535)

ResultingSnapshot [in, out]

A CIM_VirtualSystemSettingData reference to the resulting virtual system snapshot.

Job [out]

If the operation is long running, then optionally a job may be returned. In this case, the instance of the CIM_VirtualSystemSettingData class representing the new virtual system snapshot is presented via the CIM_AffectedJobElement association with the value of the AffectedElement property referring to the new instance of the CIM_VirtualSystemSettingData class representing the virtual system snapshot and the value of the ElementEffects set to 5 (Create).

Note

This parameter was read/write in Windows 8.1.

Return value

On success, returns 0; otherwise, returns an error.

Completed with No Error (0)

Not Supported (1)

Failed (2)

Timeout (3)

Invalid Parameter (4)

Invalid State (5)

Invalid Type (6)

DMTF Reserved (..)

Method Parameters Checked - Job Started (4096)

Method Reserved (4097..32767)

Vendor Specific (32768..65535)

Requirements

Minimum supported client
Windows 8.1
Minimum supported server
Windows Server 2012 R2
Namespace
Root\virtualization\v2
MOF
WindowsVirtualization.V2.mof
DLL
Vmms.exe

See also

CIM_VirtualSystemSnapshotService