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 reference to the virtual system that is the source of the snapshot.

SnapshotSettings [in]

The parameter settings for the snapshot.

SnapshotType [in]

The requested snapshot type.

The possible values are.

Full Snapshot (2)

Disk Snapshot (3)

DMTF Reserved

4 32767

Vendor Specific

32768 65535

ResultingSnapshot [in, out]

A reference to the new virtual system snapshot.

Job [out]

A reference to a job for the operation, when the operation runs for long period of time. The use of the job is optional.

If a job is created, the CIM_AffectedJobElement class must be used to associate the job with the CIM_VirtualSystemSettingData instance that represents the new snapshot.

Return value

The possible return values are.

Completed with No Error (0)

Not Supported (1)

Failed (2)

Timeout (3)

Invalid Parameter (4)

Invalid State (5)

Invalid Type (6)

DMTF Reserved (7 4095)

Method Parameters Checked - Job Started (4096)

Method Reserved (4097 32767)

Vendor Specific (32768 65535)

Requirements

Minimum supported client	None supported
Minimum supported server	Windows Server 2016
Namespace	Root\HyperVCluster\v2
Header	Dbdaoint.h
MOF	WindowsHyperVCluster.V2.mof
DLL	VMMS.exe

See also

CIM_VirtualSystemSnapshotService