Class CIM_SpareConfigurationService
extends CIM_Service

This service allows the active management of spares in a Storage Server. It allows jobs to be started for the adding and removing of spares, replacing a failed storage extent with a spare and rebuilding a storage extent in a StorageRedundancySet.

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


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_Service
   |
   +--CIM_SpareConfigurationService

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringThis service allows the active management of spares in a Storage Server. It allows jobs to be started for the adding and removing of spares, replacing a failed storage extent with a spare and rebuilding a storage extent in a StorageRedundancySet.
UMLPackagePathstringCIM::Device::StorageServices
Versionstring2.45.0

Class Properties

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_Service
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
LoSIDstringCIM_Service
LoSOrgIDstringCIM_Service
NamestringCIM_Service
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PrimaryOwnerContactstringCIM_Service
PrimaryOwnerNamestringCIM_Service
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StartedbooleanCIM_Service
StartModestringCIM_Service
StatusstringCIM_ManagedSystemElement
SystemCreationClassNamestringCIM_Service
SystemNamestringCIM_Service
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TransitioningToStateuint16CIM_EnabledLogicalElement
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
OperationalStatusuint16[]CIM_ManagedSystemElement
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

AssignSpares (uint32)

Method Qualifiers (AssignSpares)

NameData TypeValue
DescriptionstringThis method assigns one or more primordial StorageExtents as spares. Once a spare is assigned, the storage system can use it to spare a failed StorageExtent associated to a StorageRedundancySet. Depending on the capabilities of the storage system, the spare may failover the failed extent or may remain a spare. The spare extents may be designated to spare for a specific StorageRedundancySet (dedicated) or may be used to spare for any compatible StorageRedundancySet (global).
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097, 4098, 4099, 4100..32767, 32768..65535
ValuesstringJob Completed with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Multiple StoragePools, Spares Are Not Compatible, StorageExtent is in use, Method Reserved, Vendor Specific

Method Parameters (AssignSpares)

NameTypeQualifiers
NameData TypeValue
InExtentsCIM_StorageExtent[]
DescriptionstringAn array of references to StorageExtents that are to be assigned as spares.
Requiredbooleantrue
InPool REF CIM_StoragePool
DescriptionstringThe primordial StoragePool that contains the StorageExtents. This parameter does not need to be specified if there is only one primordial StoragePool.
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue
RedundancySet REF CIM_StorageRedundancySet
DescriptionstringIf specified, the spares will only spare for StorageExtents in this StorageRedundancySet (dedicated). If no reference is specified, the spares can spare for any compatible StorageRedundancySet (global).

UnassignSpares (uint32)

Method Qualifiers (UnassignSpares)

NameData TypeValue
DescriptionstringThis method unassigns spares and returns the StorageExtents to the primordial StoragePool.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097, 4098, 4099, 4100..32767, 32768..65535
ValuesstringJob Completed with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Multiple Primordial StoragePools, StorageExtent is in use, Spares Are Not Compatible, Method Reserved, Vendor Specific

Method Parameters (UnassignSpares)

NameTypeQualifiers
NameData TypeValue
InExtentsCIM_StorageExtent[]
DescriptionstringAn array of references to StorageExtents that are spares.
Requiredbooleantrue
InPool REF CIM_StoragePool
DescriptionstringThe primordial StoragePool to which the unassigned StorageExtents are to be returned. This parameter does not need to be specified if there is only one primordial StoragePool.
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue

RebuildStorageExtent (uint32)

Method Qualifiers (RebuildStorageExtent)

NameData TypeValue
DescriptionstringThis method causes the data in the StorageExtent to be rebuilt from the other members of the StorageRedundancySet.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097, 4098, 4099..32767, 32768..65535
ValuesstringJob Completed with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Target is Not a Member of a StorageRedundancySet, Rebuild already in Progress, Method Reserved, Vendor Specific

Method Parameters (RebuildStorageExtent)

NameTypeQualifiers
NameData TypeValue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue
Target REF CIM_StorageExtent
DescriptionstringThe StorageExtent that will be rebuilt.
Requiredbooleantrue

CheckParityConsistency (uint32)

Method Qualifiers (CheckParityConsistency)

NameData TypeValue
DescriptionstringThis method checks the parity data in the StorageRedundancySet to ensure that it is consistent with the real data. If no StorageRedundancySet is specified, all StorageRedundancySets are checked.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097, 4098, 4099..32767, 32768..65535
ValuesstringJob Completed with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Consistency Check Already in Progress, No Parity to Check, Method Reserved, Vendor Specific

Method Parameters (CheckParityConsistency)

NameTypeQualifiers
NameData TypeValue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue
Target REF CIM_StorageExtent
DescriptionstringThe StorageExtent that will be rebuilt.
Requiredbooleantrue

RepairParity (uint32)

Method Qualifiers (RepairParity)

NameData TypeValue
DescriptionstringThis method repairs parity consistency problems found by the CheckParityConsistency method.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 32768..65535
ValuesstringJob Completed with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (RepairParity)

NameTypeQualifiers
NameData TypeValue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue
Target REF CIM_StorageExtent
DescriptionstringThe StorageExtent that will be checked.
Requiredbooleantrue

GetAvailableSpareExtents (uint32)

Method Qualifiers (GetAvailableSpareExtents)

NameData TypeValue
DescriptionstringThis method can be used to retrieve a list of available Extents that may be used in sparing the passed Redundancy set. The returned Extents are available at the time the method returns. There is no guarantee that the same Extents will be available later. This method MUST return the Extents that are not being used as supporting capacity for any other Pools, Volumes, or LogicalDisks. The extents returned from this method shall be compatible with all restrictions imposed by the AssignSpares() method. The implementor and consumer of this method must be aware of what is the allowable source pools and returned extents as specified by the AssignSpares() method.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4098..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Reserved, Vendor Specific

Method Parameters (GetAvailableSpareExtents)

NameTypeQualifiers
NameData TypeValue
AvailableExtentsCIM_StorageExtent[]
DescriptionstringList of references to available StorageExtents.
OUTbooleantrue
InPool REF CIM_StoragePool
DescriptionstringThe Storage pool that is the source of the extents that can be used for sparing. This may be a NULL value in which case the method shall not be restricted to return a set of extents from a particular storage pool.
RedundancySet REF CIM_StorageRedundancySet
DescriptionstringA list of redundancy sets which the returned list of extents must spare.

CheckStorageElement (uint32)

Method Qualifiers (CheckStorageElement)

NameData TypeValue
DescriptionstringThe method performs a check of the StorageElement in accordance to the specified CheckType . If the Job execution fails or the job completes with error, then use concreteJob.GetError() to get the Error that indicates what caused the failure. In this case, the storage elements affected by the error shall report the appropriate, non OK, OperationalStatus.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097, 4099..32767, 32768..65535
ValuesstringJob Completed with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Storage Element Check Already in Progress, Method Reserved, Vendor Specific

Method Parameters (CheckStorageElement)

NameTypeQualifiers
NameData TypeValue
CheckModeuint16
DescriptionstringRunOneTime - Perform the check one time. Continuous - Perform the check continuously. Operation Stops when job is terminated.
ValueMapstring1, 2, .., 32768..65535
ValuesstringRun One Time, Continuous, DMTF Reserved, Vendor Specific
CheckTypeuint16
DescriptionstringDefault - Perform any data check the storage element is capable of Parity - Check that the parity distribution across the storage element is consistent Bad Block - Check for any bad blocks across the element where data may be stored. Replication - Check that replicated data on the element is consistent.
ValueMapstring1, 2, 3, 4, .., 32768..65535
ValuesstringDefault, Parity, Bad Block, Replication, DMTF Reserved, Vendor Specific
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if the task completed).
INbooleanfalse
OUTbooleantrue
TargetElement REF CIM_LogicalElement
DescriptionstringThe target storage object of the operation.
Requiredbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service