CreateSnapshot method of the Msvm_CollectionSnapshotService class

  • Article

Creates a snapshot of a virtual system collection.

Syntax

uint32 CreateSnapshot(
  [in]      CIM_CollectionOfMSEs REF Collection,
  [in]      string                   SnapshotSettings,
  [in]      uint16                   SnapshotType,
  [in, out] CIM_Collection       REF ResultingSnapshotCollection,
  [out]     CIM_ConcreteJob      REF Job
);

Parameters

Collection [in]

Reference to the affected virtual system collection.

SnapshotSettings [in]

The settings for the snapshot.

SnapshotType [in]

The snapshot type.

The possible values are:

Unknown (0)

Standard Snapshot (1)

Recovery Snapshot (2)

DMTF Reserved

3 32767

Vendor Specific

32768 65535

ResultingSnapshotCollection [in, out]

A reference to the new 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

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

Msvm_CollectionSnapshotService