CreateSnapshot method of the Msvm_VirtualSystemSnapshotService class
Creates a snapshot of a virtual machine.
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 machine.
-
SnapshotSettings [in]
-
An embedded instance of the CIM_SettingData class that contains the parameter settings for the snapshot. This parameter is optional and may be an empty string.
-
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 a CIM_VirtualSystemSettingData object that represents the new virtual machine snapshot.
Job [out]
A reference to an optional job for the operation if the operation is run asynchronously.
Return value
This method returns one of the following values.
-
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 |
|
| MOF |
|
| DLL |
|