Msvm_VirtualSystemSnapshotService class

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

The following syntax is simplified Managed Object Format (MOF) code, and it includes all of the inherited properties.

Syntax

[Dynamic, Provider("VmmsWmiInstanceAndMethodProvider"), AMENDMENT]
class Msvm_VirtualSystemSnapshotService : CIM_VirtualSystemSnapshotService
{
  string   InstanceID;
  string   Caption = "Hyper-V Virtual System Snapshot Service";
  string   Description = "Service for creating, destroying, and applying virtual machine snapshots";
  string   ElementName;
  datetime InstallDate;
  string   Name = "vssnapsvc";
  uint16   OperationalStatus[] = { 2 };
  string   StatusDescriptions[] = { "The service is running normally" };
  string   Status;
  uint16   HealthState = 5;
  uint16   CommunicationStatus;
  uint16   DetailedStatus;
  uint16   OperatingStatus;
  uint16   PrimaryStatus;
  uint16   EnabledState = 2;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault = 2;
  datetime TimeOfLastStateChange;
  uint16   AvailableRequestedStates[];
  uint16   TransitioningToState = 12;
  string   SystemCreationClassName = "Msvm_ComputerSystem";
  string   SystemName;
  string   CreationClassName = "Msvm_VirtualSystemSnapshotService";
  string   PrimaryOwnerName;
  string   PrimaryOwnerContact;
  string   StartMode;
  boolean  Started = True;
};

Members

The Msvm_VirtualSystemSnapshotService class has these types of members:

Methods

The Msvm_VirtualSystemSnapshotService class has these methods.

Method Description
ApplySnapshot Applies a virtual machine snapshot to the virtual machine that it was created from.
ClearSnapshotState Clears save state from an existing snapshot.
ConvertToReferencePoint Convert an existing virtual system snapshot to a reference point. The snapshot gets deleted as a side effect. Only recovery snapshots can be converted to reference points.
[!Note]
Support for this method was added in Windows 10.

CreateSnapshot Creates a snapshot of a virtual machine.
DestroySnapshot Destroy an existing virtual machine snapshot. This method may, as a side effect, destroy other snapshots that are dependent on the affected snapshot.
DestroySnapshotTree Removes an existing snapshot, and all its children, of a virtual machine.
RequestStateChange Requests a state change for the element.
[!Note]
Support for this method was added in Windows 10.

StartService This method is not supported.
StopService This method is not supported.

Properties

The Msvm_VirtualSystemSnapshotService class has these properties.

AvailableRequestedStates

Data type: uint16 array

Access type: Read-only

Indicates the possible values for the RequestedState parameter of the RequestStateChange method used to initiate a state change. The values listed will be a subset of the values contained in the RequestedStatesSupported property of the associated instance of CIM_EnabledLogicalElementCapabilities, where the values selected are a function of the current state of the CIM_EnabledLogicalElement object. This property can be non-Null if an implementation is able to advertise the set of possible values as a function of the current state. This property will be Null if an implementation is unable to determine the set of possible values as a function of the current state.

This property is inherited from CIM_EnabledLogicalElement.

Enabled (2)

Disabled (3)

Shut Down (4)

Offline (6)

Test (7)

Defer (8)

Quiesce (9)

Reboot (10)

Reset (11)

DMTF Reserved (.. )

Caption

Data type: string

Access type: Read-only

A short description of the object. This property is inherited from CIM_ManagedElement, and it is always set to "Hyper-V Virtual System Snapshot Service".

CommunicationStatus

Data type: uint16

Access type: Read-only

Indicates the ability of the instrumentation to communicate with the underlying managed element. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Unknown (0)

Not Available (1)

Communication OK (2)

Lost Communication (3)

No Contact (4)

DMTF Reserved (..)

Vendor Reserved (0x8000.. )

CreationClassName

Data type: string

Access type: Read-only

Qualifiers: Key, MaxLen ( 256 )

The name of the class or subclass used in the creation of an instance. This property is inherited from CIM_Service, and it is always set to "Msvm_VirtualSystemSnapshotService".

Description

Data type: string

Access type: Read-only

A description of the object. This property is inherited from CIM_ManagedElement, and it is always set to "Service for creating, destroying, and applying virtual machine snapshots".

DetailedStatus

Data type: uint16

Access type: Read-only

Compliments the PrimaryStatus property with additional status detail. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Not Available (0)

No Additional Information (1)

Stressed (2)

Predictive Failure (3)

Non-Recoverable Error (4)

Supporting Entity in Error (5)

DMTF Reserved (..)

Vendor Reserved (0x8000.. )

ElementName

Data type: string

Access type: Read-only

A display name for the object. This property is inherited from CIM_ManagedElement.

EnabledDefault

Data type: uint16

Access type: Read-only

An administrator's default or startup configuration for the enabled state of an element. This property is inherited from CIM_EnabledLogicalElement, and it is always set to 2 (Enabled).

Value Meaning
2
Enabled

EnabledState

Data type: uint16

Access type: Read-only

The enabled and disabled states of an element. It can also indicate the transitions between these requested states. This property is inherited from CIM_EnabledLogicalElement, and it is always set to 2 (Enabled).

Value Meaning
2
Enabled

HealthState

Data type: uint16

Access type: Read-only

The current health of the element. This attribute expresses the health of this element but not necessarily that of its subcomponents. The possible values are 0 to 30, where 5 means the element is entirely healthy and 30 means the element is completely nonfunctional. This property is inherited from CIM_ManagedSystemElement, and it is always set to 5 (OK).

Value Meaning
5
The health status is normal.

InstallDate

Data type: datetime

Access type: Read-only

The date and time the virtual machine configuration was created. This property is inherited from CIM_ManagedSystemElement.

InstanceID

Data type: string

Access type: Read-only

Qualifiers: Key

Uniquely identifies an instance of this class. This property is inherited from CIM_ManagedElement.

Name

Data type: string

Access type: Read-only

Qualifiers: Key, MaxLen ( 256 )

The label by which the object is known. This property is inherited from CIM_ManagedSystemElement, and it is always set to "vssnapsvc".

OperatingStatus

Data type: uint16

Access type: Read-only

Provides current status information for the operational condition of the element and can be used for providing more detail with respect to the value of the EnabledState property. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Unknown (0)

Not Available (1)

Servicing (2)

Starting (3)

Stopping (4)

Stopped (5)

Aborted (6)

Dormant (7)

Completed (8)

Migrating (9)

Emigrating (10)

Immigrating (11)

Snapshotting (12)

Shutting Down (13)

In Test (14)

Transitioning (15)

In Service (16)

DMTF Reserved (..)

Vendor Reserved (0x8000.. )

OperationalStatus

Data type: uint16 array

Access type: Read-only

The current statuses of the object. This property is inherited from CIM_ManagedSystemElement, and each array element is always set to 2 (OK).

OtherEnabledState

Data type: string

Access type: Read-only

A string that describes the enabled or disabled state of the element when the EnabledState property is set to 1 (Other). This property must be set to Null when EnabledState is any value other than 1. This property is inherited from CIM_EnabledLogicalElement, and it is always set to Null.

PrimaryOwnerContact

Data type: string

Access type: Read-only

Qualifiers: MaxLen ( 256 )

Any information about how the primary owner of the service can be reached (for example, phone number, email address, and so on). This property is inherited from CIM_Service, and it is always set to Null.

PrimaryOwnerName

Data type: string

Access type: Read-only

Qualifiers: MaxLen ( 64 )

The name of the primary owner for the service, if one is defined. The primary owner is the initial support contact for the service. This property is inherited from CIM_Service, and it is always set to Null.

PrimaryStatus

Data type: uint16

Access type: Read-only

Provides high level status information. This property should be used in conjunction with the DetailedStatus property to provide high level and detailed health status of the element and its subcomponents. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Unknown (0)

OK (1)

Degraded (2)

Error (3)

DMTF Reserved (..)

Vendor Reserved (0x8000.. )

RequestedState

Data type: uint16

Access type: Read-only

The last requested or desired state for the element. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current states for an element. A particular instance of the CIM_EnabledLogicalElement class might not support the RequestedState property. If this occurs, the value 12 (Not Applicable) is used. This property is inherited from CIM_EnabledLogicalElement, and it is always set to 12 (Not Applicable).

Value Meaning
12
Not applicable.

Started

Data type: boolean

Access type: Read-only

Indicates whether the service is currently running. This property is inherited from CIM_Service, and it is always set to True.

StartMode

Data type: string

Access type: Read-only

Qualifiers: MaxLen ( 10 )

A string value that indicates whether the service is automatically started by a system, an operating system, or is started only upon request. This property is inherited from CIM_Service, and it is always set to Null.

Status

Data type: string

Access type: Read-only

This property is inherited from CIM_ManagedSystemElement, but it is not used.

StatusDescriptions

Data type: string array

Access type: Read-only

Strings that describe the various OperationalStatus array values. This property is inherited from CIM_ManagedSystemElement, and each array element is always set to "The service is running normally".

SystemCreationClassName

Data type: string

Access type: Read-only

Qualifiers: Key, MaxLen ( 256 )

The scoping system's creation class name. This property is inherited from CIM_Service, and it is always set to "Msvm_ComputerSystem".

SystemName

Data type: string

Access type: Read-only

Qualifiers: Key, MaxLen ( 256 )

The NetBIOS name of the hosting computer system. This property is inherited from CIM_Service.

TimeOfLastStateChange

Data type: datetime

Access type: Read-only

The date or time when the enabled state of the element last changed. This property is inherited from CIM_EnabledLogicalElement.

TransitioningToState

Data type: uint16

Access type: Read-only

Indicates the target state to which the instance is transitioning. This property is inherited from CIM_EnabledLogicalElement.

Value Meaning
Unknown
0
Enabled
2
Disabled
3
Shut Down
4
No Change
5
No transition is in progress.
Offline
6
Test
7
Defer
8
Quiesce
9
Reboot
10
Reset
11
Not Applicable
12
The implementation does not support representing ongoing transitions.
DMTF Reserved
..

Requirements

Minimum supported client
Windows 8 [desktop apps only]
Minimum supported server
Windows Server 2012 [desktop apps only]
Namespace
Root\Virtualization\V2
MOF
WindowsVirtualization.V2.mof
DLL
Vmms.exe