# Class CIM_VirtualSystemSnapshotService
extends CIM_Service

Service to create, apply and destroy snapshots of virtual systems.

### Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods

## Class Hierarchy

CIM_ManagedElement
|
+--CIM_ManagedSystemElement
|
+--CIM_LogicalElement
|
+--CIM_EnabledLogicalElement
|
+--CIM_Service
|
+--CIM_VirtualSystemSnapshotService

## Direct Known Subclasses

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---
Description | string | Service to create, apply and destroy snapshots of virtual systems.
UMLPackagePath | string | CIM::Core::Virtualization
Version | string | 2.40.0

## Class Properties

### Inherited Properties

Name | Data Type | Class Origin
--- | --- | ---
Caption | string | CIM_ManagedElement
CommunicationStatus | uint16 | CIM_ManagedSystemElement
CreationClassName | string | CIM_Service
Description | string | CIM_ManagedElement
DetailedStatus | uint16 | CIM_ManagedSystemElement
ElementName | string | CIM_ManagedElement
EnabledDefault | uint16 | CIM_EnabledLogicalElement
EnabledState | uint16 | CIM_EnabledLogicalElement
HealthState | uint16 | CIM_ManagedSystemElement
InstallDate | datetime | CIM_ManagedSystemElement
InstanceID | string | CIM_ManagedElement
Name | string | CIM_Service
OperatingStatus | uint16 | CIM_ManagedSystemElement
OtherEnabledState | string | CIM_EnabledLogicalElement
PrimaryOwnerContact | string | CIM_Service
PrimaryOwnerName | string | CIM_Service
PrimaryStatus | uint16 | CIM_ManagedSystemElement
RequestedState | uint16 | CIM_EnabledLogicalElement
Started | boolean | CIM_Service
StartMode | string | CIM_Service
Status | string | CIM_ManagedSystemElement
SystemCreationClassName | string | CIM_Service
SystemName | string | CIM_Service
TimeOfLastStateChange | datetime | CIM_EnabledLogicalElement
TransitioningToState | uint16 | CIM_EnabledLogicalElement
AvailableRequestedStates | uint16[] | CIM_EnabledLogicalElement
OperationalStatus | uint16[] | CIM_ManagedSystemElement
StatusDescriptions | string[] | CIM_ManagedSystemElement

## Class Methods

### Local Class Methods

#### CreateSnapshot (uint32)

#### Method Qualifiers (CreateSnapshot)

Name | Data Type | Value
--- | --- | ---
Description | string | Creates a snapshot of a virtual system.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 32768..65535
Values | string | Completed with No Error, Not Supported, Failed, Timeout, Invalid Parameter, Invalid State, Invalid Type, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

#### Method Parameters (CreateSnapshot)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
SnapshotSettings | string
Description | string | Parameter settings.
EmbeddedInstance | string | CIM_SettingData
SnapshotType | uint16
Description | string | Requested snapshot type: Full Snapshot: Complete snapshot of the virtual system. Disk Snapshot: Snapshot of virtual system disks.
ModelCorrespondence | string | CIM_VirtualSystemSnapshotCapabilities.SnapshotTypesEnabled, CIM_VirtualSystemSnapshotServiceCapabilities.SnapshotTypesSupported
ValueMap | string | 2, 3, .., 32768..65535
Values | string | Full Snapshot, Disk Snapshot, DMTF Reserved, Vendor Specific
AffectedSystem | REF CIM_ComputerSystem
Description | string | Reference to the affected virtual system.
Job | REF CIM_ConcreteJob

Description

string

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 and the value of the ElementEffects set to 5 (Create).

In | boolean | false
Out | boolean | true
ResultingSnapshot | REF CIM_VirtualSystemSettingData
Description | string | Resulting virtual system snapshot
In | boolean | false
Out | boolean | true

#### DestroySnapshot (uint32)

#### Method Qualifiers (DestroySnapshot)

Name | Data Type | Value
--- | --- | ---
Description | string | Destroy an existing virtual system snapshot.This method may as a side effect destroy other snapshots that are dependent on the affected snapshot.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 32768..65535
Values | string | Completed with No Error, Not Supported, Failed, Timeout, Invalid Parameter, Invalid State, Invalid Type, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

#### Method Parameters (DestroySnapshot)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
AffectedSnapshot | REF CIM_VirtualSystemSettingData
Description | string | Reference to the affected virtual system snapshot.
Job | REF CIM_ConcreteJob
Description | string | If the operation is long running, then optionally a job may be returned.
In | boolean | false
Out | boolean | true

#### ApplySnapshot (uint32)

#### Method Qualifiers (ApplySnapshot)

Name | Data Type | Value
--- | --- | ---
Description | string | Apply a virtual system snapshot to the virtual system that it was created from.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 32768..65535
Values | string | Completed with No Error, Not Supported, Failed, Timeout, Invalid Parameter, Invalid State, Invalid Type, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

#### Method Parameters (ApplySnapshot)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
Job | REF CIM_ConcreteJob
Description | string | If the operation is long running, then optionally a job may be returned.
In | boolean | false
Out | boolean | true
Snapshot | REF CIM_VirtualSystemSettingData
Description | string | Reference to the virtual system snapshot.

### Inherited Class Methods

Name | Return Type | Class Origin
--- | --- | ---
RequestStateChange | uint32 | CIM_EnabledLogicalElement
StartService | uint32 | CIM_Service
StopService | uint32 | CIM_Service