Class CIM_StorageRelocationService
extends CIM_Service

Typically, a storage pool is established on a set of storage extents, and a volume is allocated to a storage pool with different performance characteristics (e.g. with different RPM drives, or different drive classes). Storage Relocation (SR) can relocate storage elements to a different storage pool, or relocate a storage element to a specified set of storage extents.The relocation source and target could be either local or remote. Two functions are defined in this class: RelocateStorageElementsToStoragePool and RelocateStorageElementToElements.

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_StorageRelocationService

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringTypically, a storage pool is established on a set of storage extents, and a volume is allocated to a storage pool with different performance characteristics (e.g. with different RPM drives, or different drive classes). Storage Relocation (SR) can relocate storage elements to a different storage pool, or relocate a storage element to a specified set of storage extents.The relocation source and target could be either local or remote. Two functions are defined in this class: RelocateStorageElementsToStoragePool and RelocateStorageElementToElements.
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

RelocateStorageVolumesToStoragePool (uint32)

Method Qualifiers (RelocateStorageVolumesToStoragePool)

NameData TypeValue
DescriptionstringStart a job to relocate a specified set of volumes to a target StoragePool. Both relocation source and target could be either local or remote. If 0 is returned, the function completes successfully and no ConcreteJob instance was required. If 4096/0x1000 is returned, a ConcreteJob will be started to kick off the relocation. The Job's reference will be returned in the output parameter Job.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097, 4098..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, ElementType Not Supported, Method Reserved, Vendor Specific

Method Parameters (RelocateStorageVolumesToStoragePool)

NameTypeQualifiers
NameData TypeValue
TheElementsCIM_StorageVolume[]
DescriptionstringAs an input, TheElements is an array of storage volumes for the source of relocation. As an output, it represents the storage volumes after relocation. Notice that: 1) The input may not be identical to the output. One example is relocation from local to remote. 2)It is output only when the relocation operation succeeds.
OUTbooleantrue
Requiredbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue
TargetPool REF CIM_StoragePool
DescriptionstringA reference to target storage pool instance used for relocation. As an input parameter, TargetPool specifies the storage pool to relocate source onto. As an output parameter, TargetPool represents the pool actually used as the relocation target. It is output only when the relocation succeeds.
OUTbooleantrue
Requiredbooleantrue
TargetSettingGoal REF CIM_StorageSetting
DescriptionstringThe requirements for the relocation target pool. If set to a null value, the default configuration associated with the service will be used. This parameter should be a reference to a CIM_StorageSetting which represent the profile appropriate to the relocation target pool. If not NULL, this parameter will supply a new Goal for the target pool.

RelocateStoragePoolsToStoragePool (uint32)

Method Qualifiers (RelocateStoragePoolsToStoragePool)

NameData TypeValue
DescriptionstringStart a job to relocate a specified set of storage pools to a target StoragePool. Both relocation source and target could be either local or remote. If 0 is returned, the function completes successfully and no ConcreteJob instance was required. If 4096/0x1000 is returned, a ConcreteJob will be started to kick off the relocation. The Job's reference will be returned in the output parameter Job.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097, 4098..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, ElementType Not Supported, Method Reserved, Vendor Specific

Method Parameters (RelocateStoragePoolsToStoragePool)

NameTypeQualifiers
NameData TypeValue
TheElementsCIM_StoragePool[]
DescriptionstringAs an input, TheElements is an array of storage pools for the source of relocation. As an output, it represents the storage pools after relocation. Notice that: 1) The input may not be identical to the output. One example is relocation from local to remote. 2)It is output only when the relocation operation succeeds.
OUTbooleantrue
Requiredbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue
TargetPool REF CIM_StoragePool
DescriptionstringA reference to target storage pool instance used for relocation. As an input parameter, TargetPool specifies the storage pool to relocate source onto. As an output parameter, TargetPool represents the pool actually used as the relocation target. It is output only when the relocation succeeds.
OUTbooleantrue
Requiredbooleantrue
TargetSettingGoal REF CIM_StorageSetting
DescriptionstringThe requirements for the relocation target pool. If set to a null value, the default configuration associated with the service will be used. This parameter should be a reference to a CIM_StorageSetting which represent the profile appropriate to the relocation target pool. If not NULL, this parameter will supply a new Goal for the target pool.

RelocateStorageVolumeToStorageExtents (uint32)

Method Qualifiers (RelocateStorageVolumeToStorageExtents)

NameData TypeValue
DescriptionstringStart a job to relocate a StorageVolume to a specified group of storage extents. Both relocation source and target couldbe either local or remote. If 0 is returned, the function completed successfully and no ConcreteJob instance was required. If 4096/0x1000 is returned, a ConcreteJob will be started to kick off the relocation. The Job's reference will be returned in the output parameter Job.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097, 4098..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, ElementType Not Supported, Method Reserved, Vendor Specific

Method Parameters (RelocateStorageVolumeToStorageExtents)

NameTypeQualifiers
NameData TypeValue
InElementsCIM_StorageExtent[]
DescriptionstringAn array of StorageExtents that 'TheElement' is relocated to.
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue
TargetSettingGoal REF CIM_StorageSetting
DescriptionstringThe requirements for the relocation target element. If set to a null value, the default configuration associated with the service will be used. This parameter should be a reference to a CIM_StorageSetting which represents the profile appropriate to the relocation target elements. If not NULL, this parameter will supply a new Goal for the target elements.
TheElement REF CIM_StorageVolume
DescriptionstringAs an input, TheElement is a storageVolume as the source ofrelocation. As an output, it represents the storageVolume after relocation. Notice that: 1) The input may not be identical to the output. One example is relocation from local to remote. 2) It is output only when the relocation operation succeeds.
OUTbooleantrue
Requiredbooleantrue

RelocateStoragePoolToStorageExtents (uint32)

Method Qualifiers (RelocateStoragePoolToStorageExtents)

NameData TypeValue
DescriptionstringStart a job to relocate a StoragePool to a specified group of storage extents. Both relocation source and target couldbe either local or remote. If 0 is returned, the function completed successfully and no ConcreteJob instance was required. If 4096/0x1000 is returned, a ConcreteJob will be started to kick off the relocation. The Job's reference will be returned in the output parameter Job.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097, 4098..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, ElementType Not Supported, Method Reserved, Vendor Specific

Method Parameters (RelocateStoragePoolToStorageExtents)

NameTypeQualifiers
NameData TypeValue
InElementsCIM_StorageExtent[]
DescriptionstringAn array of StorageExtents that 'TheElement' is relocated to.
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue
TargetSettingGoal REF CIM_StorageSetting
DescriptionstringThe requirements for the relocation target element. If set to a null value, the default configuration associated with the service will be used. This parameter should be a reference to a CIM_StorageSetting which represents the profile appropriate to the relocation target elements. If not NULL, this parameter will supply a new Goal for the target elements.
TheElement REF CIM_StoragePool
DescriptionstringAs an input, TheElement is a storagePool as the source ofrelocation. As an output, it represents the storagePool after relocation. Notice that: 1) The input may not be identical to the output. One example is relocation from local to remote. 2) It is output only when the relocation operation succeeds.
OUTbooleantrue
Requiredbooleantrue

RelocateLogicalDiskToStorageExtents (uint32)

Method Qualifiers (RelocateLogicalDiskToStorageExtents)

NameData TypeValue
DescriptionstringStart a job to relocate a LogicalDisk to a specified group of storage extents. Both relocation source and target couldbe either local or remote. If 0 is returned, the function completed successfully and no ConcreteJob instance was required. If 4096/0x1000 is returned, a ConcreteJob will be started to kick off the relocation. The Job's reference will be returned in the output parameter Job.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097, 4098..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, ElementType Not Supported, Method Reserved, Vendor Specific

Method Parameters (RelocateLogicalDiskToStorageExtents)

NameTypeQualifiers
NameData TypeValue
InElementsCIM_StorageExtent[]
DescriptionstringAn array of StorageExtents that 'TheElement' is relocated to.
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue
TargetSettingGoal REF CIM_StorageSetting
DescriptionstringThe requirements for the relocation target element. If set to a null value, the default configuration associated with the service will be used. This parameter should be a reference to a CIM_StorageSetting which represents the profile appropriate to the relocation target elements. If not NULL, this parameter will supply a new Goal for the target elements.
TheElement REF CIM_LogicalDisk
DescriptionstringAs an input, TheElement is a logicalDisk as the source ofrelocation. As an output, it represents the logicalDisk after relocation. Notice that: 1) The input may not be identical to the output. One example is relocation from local to remote. 2) It is output only when the relocation operation succeeds.
OUTbooleantrue
Requiredbooleantrue

GetAvailableTargetRelocationExtents (uint32)

Method Qualifiers (GetAvailableTargetRelocationExtents)

NameData TypeValue
DescriptionstringThis method can be used to retrieve a list of available target Extents that may be used in the relocation of a StoragePool, StorageVolume, or LogicalDisk. This method MUST return Extents from InPool. 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 that have been allocated from this Pool.
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 (GetAvailableTargetRelocationExtents)

NameTypeQualifiers
NameData TypeValue
AvailableExtentsCIM_StorageExtent[]
DescriptionstringList of references to available StorageExtents for relocation.
OUTbooleantrue
InPool REF CIM_StoragePool
DescriptionstringA reference to target storage pool instance used for relocation. InPool specifies the storage pool to relocate source onto.
Requiredbooleantrue
TargetSettingGoal REF CIM_StorageSetting
DescriptionstringThe TargetSettingGoal for which supported extents should be retrieved as available. If a NULL is passed for the Goal, the method will return all available extents, regardless of the goal. There exists a possibility of error in relocating a Pool, Volume, or LogicalDisk to extents retrieved in this manner.
TheElement REF CIM_LogicalElement
DescriptionstringTheElement is a storage element as the source of relocation.
Requiredbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service