Msvm_VirtualSystemCollection class
Represents a collection of virtual machines.
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.
Syntax
[Dynamic, Provider("VmmsWmiInstanceAndMethodProvider"), AMENDMENT]
class Msvm_VirtualSystemCollection : CIM_CollectionOfMSEs
{
string InstanceID;
string Caption;
string Description;
string CollectionID;
string ElementName;
uint16 ReplicationState;
uint16 ReplicationMode;
uint16 FailedOverReplicationType;
DateTime LastApplyTime;
String LastApplyVirtualMachineIds[];
uint16 LastApplyConsistencyLevel;
};
Members
The Msvm_VirtualSystemCollection class has these types of members:
Properties
The Msvm_VirtualSystemCollection 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.
-
-
CollectionID
-
The unique identifier of the collection object.
-
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: Override ("ElementName")
An user-defined name for the collection.
-
-
FailedOverReplicationType
-
-
Data type: uint16
-
Access type: Read-only
Type of failover that was performed for the virtual system collection.
-
-
None (0)
-
Regular (1)
-
Planned (2)
InstanceID
-
Data type: string
-
Access type: Read-only
Uniquely and opaquely 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, or be a registered ID that is assigned by a recognized global authority. This pattern is similar to the structure of schema class names. In addition, to ensure uniqueness, the first colon in InstanceID must be between the OrgID andLocalID. Therefore the OrgID must not contain a colon (':').
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 Distributed Management Task Force (DMTF) defined instances, the pattern must be used with the OrgID set to CIM.
This property is inherited from CIM_ManagedElement.
LastApplyConsistencyLevel
-
Data type: uint16
-
Access type: Read-only
Consistency level of the last applied delta.
Unknown (0)
The last applied delta indicates a point in time when the virtual system was in application consistent state.
Application Consistent (1)
The last applied delta indicates a point in time when the virtual system was in crash consistent state.
Crash Consistent (2)
Group Crash Consistent (3)
The last applied delta indicates a point in time when the group was in crash consistent state.
LastApplyTime
-
Data type: DateTime
-
Access type: Read-only
The time at which the last replication is applied on recovery for the virtual system collection.
LastApplyVirtualMachineIds
-
Data type: String array
-
Access type: Read-only
Array of virtual machine Ids which were successfully applied in last apply cycle.
ReplicationMode
-
Data type: uint16
-
Access type: Read-only
Replication type for the virtual system collection.
None (0)
Primary (1)
Replica (2)
Test Replica (3)
ReplicationState
-
Data type: uint16
-
Access type: Read-only
Replication state for the virtual system collection.
Disabled (0)
Ready for replication (1)
Waiting to complete initial replication (2)
Replicating (3)
Failover initiated (4)
Recovered (5)
Committed (6)
Suspended (7)
Critical (8)
Waiting to start resynchronization (9)
Resynchronizing (10)
Planned failover initiatedRepurpose initiatedTest failover initiatedPartially enabled (11)
Partially disabled (12)
Partially recovered (13)
(14)
(15)
(16)
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2016 |
| Namespace |
Root\HyperVCluster\v2 |
| MOF |
|
| DLL |
|