Class CIM_TierPolicyService
extends CIM_TierService

The TierPolicyService class provides methods to allow a client to manage policies used in storage tiering.

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
   |
   +--CIM_TierPolicyService

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringThe TierPolicyService class provides methods to allow a client to manage policies used in storage tiering.
Experimentalbooleantrue
UMLPackagePathstringCIM::Device::StorageServices
Versionstring2.31.1

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
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

CreateStorageTierPolicyRule (uint32)

Method Qualifiers (CreateStorageTierPolicyRule)

NameData TypeValue
DescriptionstringCreate a new storage tiering policy.
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 (CreateStorageTierPolicyRule)

NameTypeQualifiers
NameData TypeValue
Activityuint16
DescriptionstringIndicates the purpose of the policy rule. Data movement: Rule to be applied for data movement. Workload statistics collection: Rule is in effect for collecting statistics about the managed element. If null, defaults to Data movement.
INbooleantrue
ValueMapstring2, 3, .., 0x8000..
ValuesstringData movement, Workload statistics collection, DMTF Reserved, Vendor Specific
PolicyRuleNamestring
DescriptionstringA end user relevant name for the created policy rule. If null, then a system supplied default name may be used.
INbooleantrue
PolicyStateuint16
DescriptionstringIndicates whether the created policy is set to Enabled or Disabled. If null, the policy is set to Enabled.
INbooleantrue
ModelCorrespondencestringCIM_TierPolicyRule.Enabled
ValueMapstring2, 3, .., 0x8000..
ValuesstringEnabled, Disabled, DMTF Reserved, Vendor Specific
PolicyTimePeriodConditionstring
DescriptionstringIf provided, it represents the time periods during which the policy is active. If not provided, the policy is active at all times.
EmbeddedInstancestringCIM_PolicyTimePeriodCondition
INbooleantrue
TierPolicySettingDatastring
DescriptionstringIf provided, it supplies additional information to incorporate in a policy rule. For example, the RulePriority.
EmbeddedInstancestringCIM_TierPolicySettingData
INbooleantrue
MaxPercentAllocateduint16[]
ArrayTypestringIndexed
DescriptionstringThe percentage of the capacity that is allocated from the corresponding storage tier. This array is index-correlated with the array Tiers.
INbooleantrue
MaxValuesint64100
MinValuesint640
ModelCorrespondencestringCreateStorageTierPolicyRule.Tiers
PUnitstringpercent
UnitsstringPercent
InElementsCIM_ManagedElement[]
DescriptionstringAssociate these elements to the created policy.
INbooleantrue
TiersCIM_StorageTier[]
ArrayTypestringIndexed
DescriptionstringList of storage tiers to associate to this policy. If null, no tiers will be associated to this policy.
INbooleantrue
ModelCorrespondencestringCreateStorageTierPolicyRule.MaxPercentAllocated
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if job is completed).
INbooleanfalse
OUTbooleantrue
PolicyRule REF CIM_PolicyRule
DescriptionstringReference to the created PolicyRule.
INbooleanfalse
OUTbooleantrue

DeleteStorageTierPolicyRule (uint32)

Method Qualifiers (DeleteStorageTierPolicyRule)

NameData TypeValue
DescriptionstringDelete a storage tiering policy.
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 (DeleteStorageTierPolicyRule)

NameTypeQualifiers
NameData TypeValue
Forceboolean
DescriptionstringIf the policy is actively being used, the system may prevent the policy to be deleted. By passing true for this parameter, the system will attempt to delete an active policy.
INbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if job is completed).
INbooleanfalse
OUTbooleantrue
PolicyRule REF CIM_PolicyRule
DescriptionstringStorage policy rule to delete.
INbooleantrue
Requiredbooleantrue

ModifyStorageTierPolicyRule (uint32)

Method Qualifiers (ModifyStorageTierPolicyRule)

NameData TypeValue
DescriptionstringModify a storage tiering policy. The parameter "Operation" specifies the modification to be performed. Only the applicable parameters for the requested operation are necessary to be supplied. For example, to update the associated PolicyTimePeriodCondition to a policy rule, only the parameters PolicyTimePeriodCondition and PolicyRule are necessary.
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 (ModifyStorageTierPolicyRule)

NameTypeQualifiers
NameData TypeValue
Operationuint16
DescriptionstringThe Operations to perform.
INbooleantrue
ValueMapstring2, 3, 4, 5, 6, 7, 8, 9, .., 0x8000..
ValuesstringRename PolicyRuleName, Add Tiers to Policy, Remove Tiers from Policy, Add InElements to Policy, Remove InElements from Policy, Update MaxPercentAllocated, Add PolicyTimePeriodCondition, Remove PolicyTimePeriodCondition, DMTF Reserved, Vendor Specific
PolicyRuleNamestring
DescriptionstringA end user relevant name for created policy rule. If null, then a system supplied default name may be used.
INbooleantrue
PolicyTimePeriodConditionstring
DescriptionstringIf provided, it represents the time periods during which the policy is active. If not provided, the policy is active at all times.
EmbeddedInstancestringCIM_PolicyTimePeriodCondition
INbooleantrue
TierPolicySettingDatastring
DescriptionstringIf provided, it supplies additional information to incorporate in a policy rule. For example, the RulePriority.
EmbeddedInstancestringCIM_TierPolicySettingData
INbooleantrue
MaxPercentAllocateduint16[]
ArrayTypestringIndexed
DescriptionstringThe percentage of the capacity that is allocated from the corresponding storage tier. This array is index-correlated with the array Tiers.
INbooleantrue
MaxValuesint64100
MinValuesint640
ModelCorrespondencestringCreateStorageTierPolicyRule.Tiers
PUnitstringpercent
UnitsstringPercent
InElementsCIM_ManagedElement[]
DescriptionstringAssociate the elements to the policy.
INbooleantrue
TiersCIM_StorageTier[]
ArrayTypestringIndexed
DescriptionstringList of storage tiers to associate to this policy.
INbooleantrue
ModelCorrespondencestringCreateStorageTierPolicyRule.MaxPercentAllocated
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if job is completed).
INbooleanfalse
OUTbooleantrue
PolicyRule REF CIM_PolicyRule
DescriptionstringReference to the PolicyRule to be modified.
INbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
AddToStorageTieruint32CIM_TierService
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
CreateStorageTieruint32CIM_TierService
CreateTierDomainuint32CIM_TierService
DeleteStorageTieruint32CIM_TierService
DeleteTierDomainuint32CIM_TierService
GetStorageTierCandidateObjectsuint32CIM_TierService
ModifyStorageTierDomainAssociationuint32CIM_TierService
RemoveFromStorageTieruint32CIM_TierService
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service