Msvm_VirtualSystemSnapshotSettingData class
Retrieves additional information for the CreateSnapshot method of the Msvm_VirtualSystemSnapshotService class.
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.
Syntax
[AMENDMENT]
class Msvm_VirtualSystemSnapshotSettingData : CIM_SettingData
{
string Caption;
string Description;
string InstanceID;
string ElementName;
uint8 ConsistencyLevel;
boolean IgnoreNonSnapshottableDisks;
uint8 GuestBackupType;
};
Members
The Msvm_VirtualSystemSnapshotSettingData class has these types of members:
Properties
The Msvm_VirtualSystemSnapshotSettingData class has these properties.
-
Caption
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64)
A short textual description of the object.
This property is inherited from CIM_ManagedElement.
-
-
ConsistencyLevel
-
-
Data type: uint8
-
Access type: Read-only
The consistency level of the snapshot.
The possible values are:
-
-
Unknown (0)
-
Application Consistent (1)
-
Crash Consistent (2)
Description
-
Data type: string
-
Access type: Read-only
A textual description of the object.
This property is inherited from CIM_ManagedElement.
ElementName
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Required
The user-friendly name for an instance of this class. In addition, the user-friendly name can be used as an index for a search or query. The name does not have to be unique within a namespace.
This property is inherited from CIM_SettingData.
GuestBackupType
-
Data type: uint8
-
Access type: Read-only
The backup type to be used inside the guest.
The possible values are:
Undefined (0)
Full (1)
Copy (2)
IgnoreNonSnapshottableDisks
-
Data type: boolean
-
Access type: Read-only
true to ignore disks that aren't compatible with snapshots (such as fibre channel and passthrough disks) when creating the snapshot; otherwise, false.
InstanceID
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Key
Uniquely identifies an instance of this class within the scope of the containing namespace.
[!Important]
In order to ensure uniqueness within the namespace, the value of the InstanceID property should be constructed in the following pattern: OrgID:LocalID
- OrgID must include a copyrighted, trademarked or otherwise unique name that is owned by the business entity that defines the InstanceID property, or be a registered ID that is assigned by a recognized global authority.
- OrgID must not contain a colon. The first colon in InstanceID must be between the OrgID andLocalID.
- LocalID is chosen by the business entity and should not be re-used to identify different underlying real-world elements.
- If the above pattern is not used, the defining entity must assure that the resultant InstanceID value is not re-used across any InstanceID properties that are produced by this provider or other providers for this namespace.
- For DMTF defined instances, the pattern must be used with the OrgID set to "CIM".
This property is inherited from CIM_SettingData.
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2016 |
| Namespace |
Root\HyperVCluster\v2 |
| MOF |
|
| DLL |
|