Msvm_RedundancySet class
Represents a collection of managed elements that provide redundancy.
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_RedundancySet : CIM_RedundancySet
{
string Caption;
string Description;
string ElementName;
string InstanceID;
uint16 RedundancyStatus;
uint16 TypeOfSet[];
uint32 MinNumberNeeded;
uint32 MaxNumberSupported;
string VendorIdentifyingInfo;
string OtherTypeOfSet[];
uint16 LoadBalanceAlgorithm;
string OtherLoadBalanceAlgorithm;
};
Members
The Msvm_RedundancySet class has these types of members:
Methods
The Msvm_RedundancySet class has these methods.
| Method | Description |
|---|---|
| Failover | Forces a failover from one managed element to another. This method is inherited from CIM_RedundancySet. |
Properties
The Msvm_RedundancySet 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.
-
-
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
A user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information.
This property is inherited from CIM_ManagedElement.
-
-
InstanceID
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Key
Uniquely identifies an instance of this class within the scope of the containing namespace.
In order to ensure uniqueness within the namespace, the value of the InstanceID property should be constructed in the following format: OrgID:LocalID
- OrgID must include a copyrighted, trademarked or a 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.
- 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 this format 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_SystemSpecificCollection.
-
-
LoadBalanceAlgorithm
-
-
Data type: uint16
-
Access type: Read/write
-
Qualifiers: ModelCorrespondence ("CIM_RedundancySet.OtherLoadBalanceAlgorithm")
The current load balancing algorithm of the redundancy set.
This property is inherited from CIM_RedundancySet.
The possible values are:
-
-
Unknown (0)
-
Other (1)
-
No Load Balancing (2)
-
Round Robin (3)
-
Least Blocks (4)
-
Least IO (5)
-
Address Region (6)
-
Product Specific (7)
MaxNumberSupported
-
Data type: uint32
-
Access type: Read-only
The largest number of elements that can participate in the r edundancy set. A value of "0" indicates there is no limit on the number of elements.
This property is inherited from CIM_RedundancySet.
MinNumberNeeded
-
Data type: uint32
-
Access type: Read-only
-
Qualifiers: MinValue (0)
The minimum number of elements that must be operational for redundancy to function.
This property is not used if TypeOfSet is set to "5" (limited sparing).
This property is inherited from CIM_RedundancySet.
OtherLoadBalanceAlgorithm
-
Data type: string
-
Access type: Read/write
-
Qualifiers: ModelCorrespondence ("CIM_RedundancySet.LoadBalanceAlgorithm")
An array that contains descriptions of LoadBalanceAlgorithm values that are set to "1" (other).
This property is inherited from CIM_RedundancySet.
OtherTypeOfSet
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_RedundancySet.TypeOfSet")
An array that contains descriptions of TypeOfSet values that are set to "1" (other).
This property is inherited from CIM_RedundancySet.
RedundancyStatus
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_RedundancySet.MinNumberNeeded")
The state of the redundancy group.
This property is inherited from CIM_RedundancySet.
The possible values are:
Unknown (0)
DMTF Reserved (1)
Fully Redundant (2)
Degraded Redundancy (3)
Redundancy Lost (4)
Overall Failure (5)
TypeOfSet
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_RedundancySet.OtherTypeOfSet")
An array that contains information about the type of redundancy used by the collection.
This property is inherited from CIM_RedundancySet.
The possible values are:
Unknown (0)
Other (1)
N+1 (2)
Load Balanced (3)
Sparing (4)
Limited Sparing (5)
DMTF Reserved
Vendor Reserved
VendorIdentifyingInfo
-
Data type: string
-
Access type: Read-only
The vendor identifying data for the redundancy set. One example is the product name for a cluster.
This property is inherited from CIM_RedundancySet.
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2016 |
| Namespace |
Root\HyperVCluster\v2 |
| MOF |
|
| DLL |
|