# Class CIM_RedundancySet
extends CIM_SystemSpecificCollection

A class derived from SystemSpecificCollection that is a special collection of ManagedElements. This collection indicates that the aggregated elements together provide redundancy, or that redundancy is provided via sparing. All elements collected in a RedundancySet SHOULD be instantiations of the same object class.

### Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods

## Class Hierarchy

CIM_ManagedElement
|
+--CIM_Collection
|
+--CIM_SystemSpecificCollection
|
+--CIM_RedundancySet

## Direct Known Subclasses

CIM_StorageRedundancySet

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---
Description | string | A class derived from SystemSpecificCollection that is a special collection of ManagedElements. This collection indicates that the aggregated elements together provide redundancy, or that redundancy is provided via sparing. All elements collected in a RedundancySet SHOULD be instantiations of the same object class.
UMLPackagePath | string | CIM::Core::Redundancy
Version | string | 2.18.0

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
LoadBalanceAlgorithm | uint16 | 2
Description | string | The current load balance algorithm. Least Blocks, Least IO, and Address Region are used in storage device path redundancy drivers to optimize load balancing by routing requests to a path with the least queued blocks or IO requests, or based on locality of reference. 'Product Specific' indicates that the algorithm is optimized for a particular type of product. Information about that product SHOULD be provided in an associated CIM_Product instance.
ModelCorrespondence | string | CIM_RedundancySet.OtherLoadBalanceAlgorithm
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7
Values | string | Unknown, Other, No Load Balancing, Round Robin, Least Blocks, Least IO, Address Region, Product Specific
Write | boolean | true
MaxNumberSupported | uint32 |
Description | string | MaxNumberSupported indicates the largest number of elements that can participate in the RedundancySet. A value of 0 indicates there is no limit on the number of elements.
MinNumberNeeded | uint32 |
Description | string | MinNumberNeeded indicates the smallest number of elements that MUST be operational in order to function. For example, in an N+1 redundancy relationship, the MinNumberNeeded property is set equal to N. In a 'LimitedSparing' environment, this property is meaningless and SHOULD be set to zero.
MinValue | sint64 | 0
OtherLoadBalanceAlgorithm | string |
Description | string | When LoadBalanceAlgorithm is Other, this property describes the algorithm.
ModelCorrespondence | string | CIM_RedundancySet.LoadBalanceAlgorithm
Write | boolean | true
RedundancyStatus | uint16 |
Description | string | RedundancyStatus provides information on the state of the RedundancyGroup. 'Fully Redundant' (value=2) means that all of the configured redundancy is still available; 'Degraded Redundancy' (3) means that some configured elements are degraded, missing or failed but that the number of elements in the set is still greater than the minimum required ('MinNumberNeeded'); 'Redundancy Lost' (4) means that sufficient configured elements are missing or failed that no redundancy is available and the next failure experienced will cause overall failure. 'Overall Failure' (5) means that there has been an overall failure of the RedundancySet.
ModelCorrespondence | string | CIM_RedundancySet.MinNumberNeeded
ValueMap | string | 0, 1, 2, 3, 4, 5
Values | string | Unknown, DMTF Reserved, Fully Redundant, Degraded Redundancy, Redundancy Lost, Overall Failure
VendorIdentifyingInfo | string |
Description | string | VendorIdentifyingInfo captures the vendor identifying data for the RedundancySet. One example is the product name for a cluster.
OtherTypeOfSet | string[] |
ArrayType | string | Indexed
Description | string | When the corresponding array entry in TypeOfSet[] is 'Other', this entry provides a string describing the type of set.
ModelCorrespondence | string | CIM_RedundancySet.TypeOfSet
TypeOfSet | uint16[] |
ArrayType | string | Indexed
Description | string | TypeOfSet provides information on the type of redundancy. N+1 (=2) indicates all members are active, are unaware and function independent of one another. However, there exist at least one extra member to achieve functionality. 'Sparing' is implied (i.e. each member can be a spare for the other(s). An example of N+1 is a system that has 2 power supplies, but needs only 1 power supply to functioning properly. N+1 is a special case of N+M redundancy where M=1. A value of N+1 (=2) shall be used for N+M redundancy. - Load Balanced (=3) indicates all members are active. However, there functionality is not independent of each other. Their functioning is determined by some sort of load balancing algrothim (implemented in hardware and/or software). 'Sparing' is implied (i.e. each member can be a spare for the other(s). - Sparing (=4) indicates that all members are active and are aware of each others. However, their functionality is independent until failover. Each member can be a spare for the other(s). - Limited Sparing (=5) indicates that all members are active, and they may or may not be aware of each and they are not spares for each other. Instead, their redundancy is indicated by the IsSpare relationship.
ModelCorrespondence | string | CIM_RedundancySet.OtherTypeOfSet
ValueMap | string | 0, 1, 2, 3, 4, 5, .., 0x8000..
Values | string | Unknown, Other, N+1, Load Balanced, Sparing, Limited Sparing, DMTF Reserved, Vendor Reserved

### Inherited Properties

Name | Data Type | Class Origin
--- | --- | ---
Caption | string | CIM_ManagedElement
Description | string | CIM_ManagedElement
ElementName | string | CIM_ManagedElement
Generation | uint64 | CIM_ManagedElement
InstanceID | string | CIM_SystemSpecificCollection

## Class Methods

### Local Class Methods

#### Failover (uint32)

#### Method Qualifiers (Failover)

Name | Data Type | Value
--- | --- | ---
Description | string | This method forces a failover from one ManagedElement to another. There are two parameters to the Failover method. - FailoverFrom is a reference to an 'active' ManagedElement that will become inactive after the method. This element SHOULD be part of the RedundancySet via a MemberOfCollection relationship. - FailoverTo is a reference to the ManagedElement that will take over for the FailoverFrom element. This element SHOULD either be a member of the RedundancySet or be associated with the RedundancySet via an IsSpare relationship. Upon sucessful completion: - the FailoverTo element SHOULD be associated to the RedundancySet via MemberOfCollection. - the FailFrom element SHOULD either still be associated to the RedundandySet via MemberOfCollection with a OperationalStatus or EnableState that indicates it not active, or it SHOULD be associated to the 'Spared' collection via the MemberOfCollection association.
ValueMap | string | 0, 1, 2, 3, 4, .., 32768..65535
Values | string | Completed with No Error, Not Supported, Unknown/Unspecified Error, Busy/In Use, Paramter Error, DMTF Reserved, Vendor Reserved

#### Method Parameters (Failover)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
FailoverFrom | REF CIM_ManagedElement
Description | string | The primary ManagedSystemElement that will become inactive after the method.
IN | boolean | true
FailoverTo | REF CIM_ManagedElement
Description | string | The ManagedSystemElement that will take over from the primary MSE.
IN | boolean | true