Class CIM_TierService
extends CIM_Service

The TierService class provides methods to allow a client to manage storage tiers.

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_TierService

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringThe TierService class provides methods to allow a client to manage storage tiers.
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

CreateStorageTier (uint32)

Method Qualifiers (CreateStorageTier)

NameData TypeValue
DescriptionstringCreate a new storage tier based on supplied storage objects. For example, a storage tier based on all storage extents of a storage pool, i.e. ConcreteComponents, that utilize solid state technology. The more parameters specified, the narrower the criteria for selecting the storage objects.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 0x8000..
ValuesstringCompleted 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 (CreateStorageTier)

NameTypeQualifiers
NameData TypeValue
ElementNamestring
DescriptionstringA end user relevant name for created storage tier. If null, then a system supplied default name may be used.
TierSettingDatastring
DescriptionstringIf provided, it overrides the default tier setting data that is used. For example, create a storage tier based on performance of underlying technology of components considered.
EmbeddedInstancestringCIM_TierSettingData
MembersCIM_LogicalElement[]
DescriptionstringList of elements to use to create a storage tier. If null, other specified parameters are considered, such as TierSettingData and Goal.
TierDomainCIM_AdminDomain[]
DescriptionstringInput: The created StorageTier to be associated to given array of TierDomains. If null, system associates created storage tier to a TierDomain and returns a reference to the TierDomain the system used.
OUTbooleantrue
Goal REF CIM_ManagedElement
DescriptionstringThe Quality of Service per the properties of supplied StorageSetting.
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if job is completed).
INbooleanfalse
OUTbooleantrue
StorageTier REF CIM_StorageTier
DescriptionstringReference to the created StorageTier.
INbooleanfalse
OUTbooleantrue

DeleteStorageTier (uint32)

Method Qualifiers (DeleteStorageTier)

NameData TypeValue
DescriptionstringDelete a storage tier. The storage objects associated to the storage tier are unaffected.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 0x8000..
ValuesstringCompleted 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 (DeleteStorageTier)

NameTypeQualifiers
NameData TypeValue
Forceboolean
DescriptionstringThe implementation may not allow a storage tier to be deleted if the storage tier is associated with underlying storage elements. In such situations specify "True" to force the deletion of the storage tier.
TierSettingDatastring
DescriptionstringIf provided, it overrides the default tier setting data that is used.
EmbeddedInstancestringCIM_TierSettingData
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if job is completed).
INbooleanfalse
OUTbooleantrue
StorageTier REF CIM_StorageTier
DescriptionstringReference to StorageTier to delete.

AddToStorageTier (uint32)

Method Qualifiers (AddToStorageTier)

NameData TypeValue
DescriptionstringAdd members, i.e. components, to a storage tier to expand the capacity of storage tier.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 0x8000..
ValuesstringCompleted 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 (AddToStorageTier)

NameTypeQualifiers
NameData TypeValue
TierSettingDatastring
DescriptionstringIf provided, it overrides the default tier setting data that is used.
EmbeddedInstancestringCIM_TierSettingData
MembersCIM_LogicalElement[]
DescriptionstringList of elements to add to storage tier.
Goal REF CIM_ManagedElement
DescriptionstringThe Quality of Service per the properties of supplied StorageSetting.
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if job is completed).
INbooleanfalse
OUTbooleantrue
StorageTier REF CIM_StorageTier
DescriptionstringReference to StorageTier to add to.

RemoveFromStorageTier (uint32)

Method Qualifiers (RemoveFromStorageTier)

NameData TypeValue
DescriptionstringRemove members, i.e. components, from a storage tier to reduce the capacity of storage tier.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, .., 0x8000..
ValuesstringCompleted 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 (RemoveFromStorageTier)

NameTypeQualifiers
NameData TypeValue
TierSettingDatastring
DescriptionstringIf provided, it overrides the default tier setting data that is used.
EmbeddedInstancestringCIM_TierSettingData
MembersCIM_LogicalElement[]
DescriptionstringList of elements to remove from storage tier.
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if job is completed).
INbooleanfalse
OUTbooleantrue
StorageTier REF CIM_StorageTier
DescriptionstringReference to the StorageTier to remove from.

CreateTierDomain (uint32)

Method Qualifiers (CreateTierDomain)

NameData TypeValue
DescriptionstringCreate a TierDomain and associate it to top-level ComputerSystem -- via SystemComponent association.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 0x8000..
ValuesstringCompleted 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 (CreateTierDomain)

NameTypeQualifiers
NameData TypeValue
ElementNamestring
DescriptionstringIf nameable, an end user relevant name for the TierDomain. If null or not nameable, then system assigns a name.
TierSettingDatastring
DescriptionstringIf provided, it overrides the default tier setting data that is used.
EmbeddedInstancestringCIM_TierSettingData
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if job is completed).
INbooleanfalse
OUTbooleantrue
TierDomain REF CIM_AdminDomain
DescriptionstringReference to the created TierDomain.
INbooleanfalse
OUTbooleantrue

DeleteTierDomain (uint32)

Method Qualifiers (DeleteTierDomain)

NameData TypeValue
DescriptionstringDelete an instance of TierDomain. If the Force parameter is true, the SystemComponents (i.e. StorageTier) of this domain that are not associated to another TierDomain will also be deleted.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 0x8000..
ValuesstringCompleted 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 (DeleteTierDomain)

NameTypeQualifiers
NameData TypeValue
Forceboolean
DescriptionstringIf true, delete a non-empty TierDomain and its associated StorageTiers, as long as the associated StorageTiers are not associated to other TierDomains; otherwise, return an error.
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if job is completed).
INbooleanfalse
OUTbooleantrue
TierDomain REF CIM_AdminDomain
DescriptionstringReference to TierDomain to delete.

ModifyStorageTierDomainAssociation (uint32)

Method Qualifiers (ModifyStorageTierDomainAssociation)

NameData TypeValue
DescriptionstringModify a StorageTier association to a TierDomain. A StorageTier shall always be associated to at least one TierDomain. This call ensures a StorageTier's association to a TierDomain is maintained especially when a StorageTier 'moves' from one TierDomain to another TierDomain. By setting the parameter RemoveFromTierDomain to null and setting the parameter AddToTierDomain to a TierDomain, this call associates a StorageTier to additional TierDomains.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 0x8000..
ValuesstringCompleted 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 (ModifyStorageTierDomainAssociation)

NameTypeQualifiers
NameData TypeValue
TierSettingDatastring
DescriptionstringIf provided, it overrides the default tier setting data that is used.
EmbeddedInstancestringCIM_TierSettingData
AddToTierDomain REF CIM_AdminDomain
DescriptionstringAssociate StorageTier to this TierDomain. If null, the association will not be added to an existing TierDomain.
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if job is completed).
INbooleanfalse
OUTbooleantrue
RemoveFromTierDomain REF CIM_AdminDomain
DescriptionstringRemove StorageTier's association to this TierDomain.If null, the association will not be removed from an existing TierDomain.
StorageTier REF CIM_StorageTier
DescriptionstringReference to the StorageTier to manipulate.

GetStorageTierCandidateObjects (uint32)

Method Qualifiers (GetStorageTierCandidateObjects)

NameData TypeValue
DescriptionstringThis method returns an array of storage objects that can form a storage tier. The selection criteria is based on the input parameters. The more input parameters, the narrower the search criteria. For example, it is possible to specify to return the candidate storage objects based on all storage extents of a storage pool, i.e. ConcreteComponents, that utilize solid state technology by supplying the appropriate InPools and TierSettingData.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 0x8000..
ValuesstringCompleted 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 (GetStorageTierCandidateObjects)

NameTypeQualifiers
NameData TypeValue
TierSettingDatastring
DescriptionstringIf provided, it overrides the default tier setting data that is used. For example, a storage tier based on performance of underlying technology of components considered.
EmbeddedInstancestringCIM_TierSettingData
CandidatesCIM_LogicalElement[]
DescriptionstringAn array of storage objects that can form a storage tier.
INbooleanfalse
OUTbooleantrue
InElementsCIM_LogicalElement[]
DescriptionstringList of elements to consider. For example, a list of storage pools.
Goal REF CIM_ManagedElement
DescriptionstringThe Quality of Service per the properties of supplied StorageSetting.
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if job is completed).
INbooleanfalse
OUTbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service