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

NameData TypeValue
DescriptionstringService to create, apply and destroy snapshots of virtual systems.
UMLPackagePathstringCIM::Core::Virtualization
Versionstring2.22.0

Class Properties

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_Service
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
LoSIDstringCIM_Service
LoSOrgIDstringCIM_Service
NamestringCIM_Service
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PrimaryOwnerContactstringCIM_Service
PrimaryOwnerNamestringCIM_Service
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StartedbooleanCIM_Service
StartModestringCIM_Service
StatusstringCIM_ManagedSystemElement
SystemCreationClassNamestringCIM_Service
SystemNamestringCIM_Service
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TransitioningToStateuint16CIM_EnabledLogicalElement
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
OperationalStatusuint16[]CIM_ManagedSystemElement
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

CreateSnapshot (uint32)

Method Qualifiers (CreateSnapshot)

NameData TypeValue
DescriptionstringCreates a snapshot of a virtual system.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 32768..65535
ValuesstringCompleted 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)

NameTypeQualifiers
NameData TypeValue
SnapshotSettingsstring
DescriptionstringParameter settings.
EmbeddedInstancestringCIM_SettingData
Inbooleantrue
SnapshotTypeuint16
DescriptionstringRequested snapshot type: Full Snapshot: Complete snapshot of the virtual system. Disk Snapshot: Snapshot of virtual system disks.
Inbooleantrue
ModelCorrespondencestringCIM_VirtualSystemSnapshotCapabilities.SnapshotTypesEnabled, CIM_VirtualSystemSnapshotServiceCapabilities.SnapshotTypesSupported
ValueMapstring2, 3, .., 32768..65535
ValuesstringFull Snapshot, Disk Snapshot, DMTF Reserved, Vendor Specific
AffectedSystem REF CIM_ComputerSystem
DescriptionstringReference to the affected virtual system.
Inbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringIf 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).
Inbooleantrue
Outbooleantrue
ResultingSnapshot REF CIM_VirtualSystemSettingData
DescriptionstringResulting virtual system snapshot
Inbooleantrue
Outbooleantrue

DestroySnapshot (uint32)

Method Qualifiers (DestroySnapshot)

NameData TypeValue
DescriptionstringDestroy an existing virtual system snapshot.This method may as a side effect destroy other snapshots that are dependent on the affected snapshot.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 32768..65535
ValuesstringCompleted 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)

NameTypeQualifiers
NameData TypeValue
AffectedSnapshot REF CIM_VirtualSystemSettingData
DescriptionstringReference to the affected virtual system snapshot.
Inbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringIf the operation is long running, then optionally a job may be returned.
Inbooleantrue
Outbooleantrue

ApplySnapshot (uint32)

Method Qualifiers (ApplySnapshot)

NameData TypeValue
DescriptionstringApply a virtual system snapshot to the virtual system that it was created from.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 32768..65535
ValuesstringCompleted 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)

NameTypeQualifiers
NameData TypeValue
Job REF CIM_ConcreteJob
DescriptionstringIf the operation is long running, then optionally a job may be returned.
Inbooleantrue
Outbooleantrue
Snapshot REF CIM_VirtualSystemSettingData
DescriptionstringReference to the virtual system snapshot.
Inbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service