Class CIM_StorageConfigurationService
extends CIM_Service

This service allows the active management of a Storage Server. It allows jobs to be started for the creation, modification and deletion of storage objects (StoragePools, StorageVolumes and LogicalDisks).

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_StorageConfigurationService

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringThis service allows the active management of a Storage Server. It allows jobs to be started for the creation, modification and deletion of storage objects (StoragePools, StorageVolumes and LogicalDisks).
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

CreateOrModifyStoragePool (uint32)

Method Qualifiers (CreateOrModifyStoragePool)

NameData TypeValue
DescriptionstringStarts a job to create (or modify) a StoragePool. The StoragePool will be (or must be) scoped to the same System as this Service. One of the parameters for this method is Size. As an input parameter, Size specifies the desired size of the pool. As an output parameter, it specifies the size achieved. Space is taken from either or both of the specified input StoragePools and StorageExtents (InPools and InExtents). The capability requirements that the Pool must support are defined using the Goal parameter. If the requested pool size cannot be created, no action will be taken, the Return Value will be 4097/0x1001, and the output value of Size will be set to the nearest possible size. If 0 is returned, then the task completed successfully and the use of ConcreteJob was not required. If the task will take some time to complete, a ConcreteJob will be created and its reference returned in the output parameter Job.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097, 4098..32767, 32768..65535
ValuesstringJob Completed with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Size Not Supported, Method Reserved, Vendor Specific

Method Parameters (CreateOrModifyStoragePool)

NameTypeQualifiers
NameData TypeValue
ElementNamestring
DescriptionstringA end user relevant name for the pool being created. If NULL, then a system supplied default name can be used. The value will be stored in the 'ElementName' property for the created pool. If not NULL, this parameter will supply a new name when modifying an existing pool.
Sizeuint64
DescriptionstringAs an input parameter this specifies the desired pool size in bytes. As an output parameter this specifies the size achieved.
OUTbooleantrue
PUnitstringbyte
UnitsstringBytes
InExtentsstring[]
DescriptionstringArray of strings containing representations of references to CIM_StorageExtent instances, that are used to create the Pool or modify the source extents.
InPoolsstring[]
DescriptionstringArray of strings containing representations of references to CIM_StoragePool instances, that are used to create the Pool or modify the source pools.
Goal REF CIM_StorageSetting
DescriptionstringReference to an instance of StorageSetting that defines the desired capabilities of the StoragePool. If set to a null value, the default configuration from the source pool will be used. If not NULL, this parameter will supply a new Goal setting when modifying an existing pool.
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue
Pool REF CIM_StoragePool
DescriptionstringAs an input parameter: if null, creates a new StoragePool. If not null, modifies the referenced Pool. When returned, it is a reference to the resulting StoragePool.
OUTbooleantrue

CreateOrModifyElementFromStoragePool (uint32)

Method Qualifiers (CreateOrModifyElementFromStoragePool)

NameData TypeValue
DescriptionstringStart a job to create (or modify) a specified element (for example a StorageVolume or StorageExtent) from a StoragePool. One of the parameters for this method is Size. As an input parameter, Size specifies the desired size of the element. As an output parameter, it specifies the size achieved. Space is taken from the input StoragePool. The desired settings for the element are specified by the Goal parameter. If the requested size cannot be created, no action will be taken, and the Return Value will be 4097/0x1001. Also, the output value of Size is set to the nearest possible size. 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 create the element. 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
ValuesstringJob Completed with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Size Not Supported, Method Reserved, Vendor Specific

Method Parameters (CreateOrModifyElementFromStoragePool)

NameTypeQualifiers
NameData TypeValue
ElementNamestring
DescriptionstringA end user relevant name for the element being created. If NULL, then a system supplied default name can be used. The value will be stored in the 'ElementName' property for the created element. If not NULL, this parameter will supply a new name when modifying an existing element.
ElementTypeuint16
DescriptionstringEnumeration indicating the type of element being created or modified. If the input parameter TheElement is specified when the operation is a 'modify', this type value must match the type of that instance. With ElementType of "2" and "3", the implementation decides the provisioning of the element.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, .., 32768..65535
ValuesstringUnknown, Reserved, StorageVolume, StorageExtent, LogicalDisk, ThinlyProvisionedStorageVolume, ThinlyProvisionedLogicalDisk, FullyProvisionedStorageVolume, FullyProvisionedLogicalDisk, DMTF Reserved, Vendor Specific
Sizeuint64
DescriptionstringAs an input parameter Size specifies the desired size. If not NULL, this parameter will supply a new size when modifying an existing element. As an output parameter Size specifies the size achieved.
OUTbooleantrue
PUnitstringbyte
UnitsstringBytes
Goal REF CIM_ManagedElement
DescriptionstringThe requirements for the element to maintain. If set to a null value, the default configuration from the source pool will be used. This parameter should be a reference to a Setting or Profile appropriate to the element being created. If not NULL, this parameter will supply a new Goal when modifying an existing element.
InPool REF CIM_StoragePool
DescriptionstringThe Pool from which to create the element. This parameter must be set to null if the input parameter TheElement is specified (in the case of a 'modify' operation).
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue
TheElement REF CIM_LogicalElement
DescriptionstringAs an input parameter: if null, creates a new element. If not null, then the method modifies the specified element. As an output parameter, it is a reference to the resulting element.
OUTbooleantrue

DeleteStoragePool (uint32)

Method Qualifiers (DeleteStoragePool)

NameData TypeValue
DescriptionstringStart a job to delete a StoragePool. The freed space is returned source StoragePools (indicated by AllocatedFrom StoragePool) or back to underlying storage extents. If 0 is returned, the function completed successfully, and no ConcreteJob was required. If 4096/0x1000 is returned, a ConcreteJob will be started to delete the StoragePool. A reference to the Job is returned in the Job parameter.
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 (DeleteStoragePool)

NameTypeQualifiers
NameData TypeValue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue
Pool REF CIM_StoragePool
DescriptionstringReference to the pool to delete.

ReturnToStoragePool (uint32)

Method Qualifiers (ReturnToStoragePool)

NameData TypeValue
DescriptionstringStart a job to delete an element previously created from a StoragePool. The freed space is returned to the source StoragePool. If 0 is returned, the function completed successfully and no ConcreteJob was required. If 4096/0x1000 is returned, a ConcreteJob will be started to delete the element. A reference to the Job is returned in the Job parameter.
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 (ReturnToStoragePool)

NameTypeQualifiers
NameData TypeValue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue
TheElement REF CIM_LogicalElement
DescriptionstringReference to the element to return to the StoragePool.

CreateReplica (uint32)

Method Qualifiers (CreateReplica)

NameData TypeValue
DescriptionstringStart a job to create a new storage object which is a replica of the specified source storage object. (SourceElement). Note that using the input paramter, CopyType, this function can be used to instantiate the replica, and to create an ongoing association between the source and replica. If 0 is returned, the function completed successfully and no ConcreteJob instance is created. If 4096/0x1000 is returned, a ConcreteJob is started, a reference to which is returned in the Job output parameter.
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 (CreateReplica)

NameTypeQualifiers
NameData TypeValue
CopyTypeuint16
DescriptionstringCopyType describes the type of copy that will be made. Values are: Async: Create and maintain an asynchronous copy of the source. Sync: Create and maintain a synchronized copy of the source. UnSyncAssoc: Create an unsynchronized copy and maintain an association to the source. UnSyncUnAssoc: Create unassociated copy of the source element.
ValueMapstring2, 3, 4, 5, .., 32768..65535
ValuesstringAsync, Sync, UnSyncAssoc, UnSyncUnAssoc, DMTF Reserved, Vendor Specific
ElementNamestring
DescriptionstringA end user relevant name for the element being created. If NULL, then a system supplied default name can be used. The value will be stored in the 'ElementName' property for the created element.
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue
SourceElement REF CIM_LogicalElement
DescriptionstringThe source storage object which may be a StorageVolume or storage object.
Requiredbooleantrue
TargetElement REF CIM_LogicalElement
DescriptionstringReference to the created target storage element (i.e., the replica).
INbooleanfalse
OUTbooleantrue
TargetPool REF CIM_StoragePool
DescriptionstringThe underlying storage for the target element (the replica) will be drawn from TargetPool if specified, otherwise the allocation is implementation specific.
TargetSettingGoal REF CIM_StorageSetting
DescriptionstringThe definition for the StorageSetting to be maintained by the target storage object (the replica).

ModifySynchronization (uint32)

Method Qualifiers (ModifySynchronization)

NameData TypeValue
DescriptionstringModify (or start a job to modify) the synchronization association between two storage objects. If 0 is returned, the function completed successfully and no ConcreteJob instance was created. If 0x1000 is returned, a ConcreteJob was started and a reference to this Job is returned in the Job output parameter. A return value of 1 indicates the method is not supported. All other values indicate some type of error condition.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 0x1000, 0x1001..0x7FFF, 0x8000..0xFFFF
ValuesstringJob Completed with No Error, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (ModifySynchronization)

NameTypeQualifiers
NameData TypeValue
Operationuint16
DescriptionstringOperation describes the type of modification to be made to the replica. Values are: Detach: 'Forget' the synchronization between two storage objects. Start to treat the objects as independent. Fracture: Suspend the synchronization between two storage objects using Sync or Async replication. The association and (typically) changes are remembered to allow a fast resynchronization. This may be used during a backup cycle to allow one of the objects to be copied while the other remains in production. Resync Replica: Re-establish the synchronization of a Sync or Async replication. This will negate the action of a previous Fracture operation. Recreate a Point In Time image for an UnSyncAssoc replication. Restore from Replica: Renew the contents of the original storage object from a replica. Prepare: Get the link ready for a Resync operation to take place. Some implementations will require this operation to be invoked to keep the Resync operation as fast as possible. May start the copy engine. Unprepare: Clear a prepared state if a Prepare is not to be followed by a Resync operation. Quiesce: Some applications require notification so that they can ready the link for an operation. For example flush any cached data or buffered changes. The copy engine is stopped for UnSyncAssoc replications. Unquiesce: Take the link from the quiesced state (without executing the intended operation. Start Copy: initiate a full background copy of the source to the UnSyncAssoc replica. Replica enters Frozen state when copy operation is completed. Stop Copy: stop the background copy previously started. Reset To Sync: Change the CopyType of the association to Sync (e.g., from the Async CopyType). Reset To Async: Change the CopyType of the association to Async (e.g., from the Sync CopyType).
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, .., 0x8000..0xFFFF
ValuesstringDMTF Reserved, DMTF Reserved, Detach, Fracture, Resync Replica, Restore from Replica, Prepare, Unprepare, Quiesce, Unquiesce, Reset To Sync, Reset To Async, Start Copy, Stop Copy, DMTF Reserved, Vendor Specific
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if the task completed).
INbooleanfalse
OUTbooleantrue
Synchronization REF CIM_StorageSynchronized
DescriptionstringThe referenced to the StorageSynchronized association describing the storage source/replica relationship.

AttachReplica (uint32)

Method Qualifiers (AttachReplica)

NameData TypeValue
DescriptionstringCreate (or start a job to create) a StorageSynchronized relationship between two existing storage objects. Note that using the input parameter, CopyType, this function can be used to to create an ongoing association between the source and replica. If 0 is returned, the function completed successfully and no ConcreteJob instance is created. If 0x1000 is returned, a ConcreteJob is started, a reference to which is returned in the Job output parameter. A return value of 1 indicates the method is not supported. All other values indicate some type of error condition.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 0x1000, 0x1001..0x7FFF, 0x8000..0xFFFF
ValuesstringJob Completed with No Error, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (AttachReplica)

NameTypeQualifiers
NameData TypeValue
CopyTypeuint16
DescriptionstringCopyType describes the type of Synchronized relationship that will be created. Values are: Async: Create and maintain an asynchronous copy of the source. Sync: Create and maintain a synchronized copy of the source. UnSyncAssoc: Create an unsynchronized copy and maintain an association to the source. UnSyncUnAssoc: Create unassociated copy of the source element.
ValueMapstring2, 3, 4, 5, .., 0x8000..0xFFFF
ValuesstringAsync, Sync, UnSyncAssoc, UnSyncUnAssoc, DMTF Reserved, Vendor Specific
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if the task completed).
INbooleanfalse
OUTbooleantrue
SourceElement REF CIM_ManagedElement
DescriptionstringThe source storage object which may be a StorageVolume or other storage object.
Requiredbooleantrue
TargetElement REF CIM_ManagedElement
DescriptionstringReference to the target storage element (i.e., the replica).

CreateOrModifyElementFromElements (uint32)

Method Qualifiers (CreateOrModifyElementFromElements)

NameData TypeValue
DescriptionstringStart a job to create (or modify) a specified storage element from specified input StorageExtents. The created or modified storage element can be a StorageExtent, StorageVolume, LogicalDisk, or StoragePool. An input list of InElements must be specified. The GetAvailableExtents method can be used to get a list of valid extents that can be used to achieve a desired goal. Validity of the extents is determined by the implementation. As an input parameter, Size specifies the desired size of the element. As an output parameter, it specifies the size achieved. Space is taken from the input InElements. The desired Settings for the element are specified by the Goal parameter. If the size of Extents passed is less than the size requested, then the capacity is drawn from the extents in the order, left to right, that the Extents were specified. The partial consumption of an Extent is represented by an Extent for the capacity used and an Extent for the capacity not used. If the Size is NULL, then a configuration using all Extents passed will be attempted. If the requested size cannot be created, no action will be taken, and the Return Value will be 4097/0x1001. Also, the output value of Size is set to the nearest possible size. 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 create the element. 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, Size Not Supported, Method Reserved, Vendor Specific

Method Parameters (CreateOrModifyElementFromElements)

NameTypeQualifiers
NameData TypeValue
ElementNamestring
DescriptionstringA end user relevant name for the element being created. If NULL, then a system-supplied default name can be used. The value will be stored in the 'ElementName' property for the created element. If not NULL, this parameter will supply a new name when modifying an existing element.
ElementTypeuint16
DescriptionstringEnumeration indicating the type of element being created or modified. If the input parameter TheElement is specified when the operation is a 'modify', this type value must match the type of that instance. The actual CIM class of the created TheElement can be vendor-specific, but it must be a derived class of the appropriate CIM class -- i.e., CIM_StorageVolume, CIM_StorageExtent, CIM_LogicalDisk, or CIM_StoragePool.
Requiredbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, .., 32768..65535
ValuesstringUnknown, Reserved, Storage Volume, Storage Extent, Storage Pool, Logical Disk, ThinlyProvisionedStorageVolume, ThinlyProvisionedLogicalDisk, DMTF Reserved, Vendor Specific
Sizeuint64
DescriptionstringAs an input parameter Size specifies the desired size. If not NULL, this parameter will supply a new size when modifying an existing element. As an output parameter Size specifies the size achieved.
OUTbooleantrue
PUnitstringbyte
UnitsstringBytes
InElementsCIM_StorageExtent[]
DescriptionstringArray of references to storage element instances that are used to create or modify TheElement.
Requiredbooleantrue
Goal REF CIM_ManagedElement
DescriptionstringThe requirements for the element to maintain. If set to a null value, the default configuration associated with the Service will be used. This parameter should be a reference to a Setting, SettingData, or Profile appropriate to the element being created. If not NULL, this parameter will supply a new Goal when modifying an existing element.
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue
TheElement REF CIM_LogicalElement
DescriptionstringAs an input parameter: if null, creates a new element. If not null, then the method modifies the specified element. As an output parameter, it is a reference to the resulting element.
OUTbooleantrue

AssignStorageResourceAffinity (uint32)

Method Qualifiers (AssignStorageResourceAffinity)

NameData TypeValue
DescriptionstringStart a job to assign affinity of a StoragePool(s) or StorageVolume(s) to a storage processor. At the conclusion of the operation, the resource will be a member of the StorageResourceLoadGroup with the primary affinity for the specified storage processor. Support for this method is indicated by the presence of an instance of StorageServerAsymmetryCapabilites in which the property StorageResourceAffinityAssignable is 'true'. If 0 is returned, the function completed successfully and no ConcreteJob instance was required. If 4096/0x1000 is returned, a job will be started to assign the element. The Job's reference will be returned in the output parameter Job.
MethodConstraintstringpre:(StorageResources.oclIsTypeOf(CIM_StoragePool)OR StorageResources.oclIsTypeOf(CIM_StorageVolume))
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, Size Not Supported, Method Reserved, Vendor Specific

Method Parameters (AssignStorageResourceAffinity)

NameTypeQualifiers
NameData TypeValue
ResourceTypeuint16
DescriptionstringEnumeration indicating the type of resource being assigned or modified. .
Requiredbooleantrue
ValueMapstring2, 3
ValuesstringStorageVolume, StoragePool
StorageResourcesCIM_LogicalElement[]
DescriptionstringArray of references to storage resource instances to be assigned.
Requiredbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue
StorageProcessor REF CIM_ComputerSystem
DescriptionstringReference to the storage processor to which to assign the resource.

AttachOrModifyReplica (uint32)

Method Qualifiers (AttachOrModifyReplica)

NameData TypeValue
DescriptionstringCreate (or start a job to create) a StorageSynchronized mirror relationship between two storage elements. The target element may be a local or a remote storage element. A remote mirror pair may be scoped by a peer-to-peer connection modeled as a NetworkPipe between peers. If Job Completed with No Error (0) is returned, the function completed successfully and a ConcreteJob instance is not created. If Method Parameters Checked - Job Started (0x1000) is returned, a ConcreteJob is started, a reference to which is returned in the Job output parameter. A return value of Not Supported (1) indicates the method is not supported. All other values indicate some type of error condition.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 0x1000, 0x1001..0x7FFF, 0x8000..0xFFFF
ValuesstringJob Completed with No Error, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (AttachOrModifyReplica)

NameTypeQualifiers
NameData TypeValue
CopyTypeuint16
DescriptionstringCopyType describes the type of Synchronized relationship that will be created. Values are: Async: Create and maintain an asynchronous copy of the source. Sync: Create and maintain a synchronized copy of the source. UnSyncAssoc: Create an unsynchronized copy and maintain an association to the source element. UnSyncUnAssoc: Create an unassociated copy of the source element. UnSyncAssoc and UnSyncUnAssoc are not supported for remote mirror replicas.
Requiredbooleantrue
ValueMapstring2, 3, 4, 5, 6..4095, 0x1000..0xFFFF
ValuesstringAsync, Sync, UnSyncAssoc, UnSyncUnAssoc, DMTF Reserved, Vendor Specific
Goalstring
DescriptionstringThe StorageSetting properties to be created or modified for the target element.
EmbeddedInstancestringCIM_SettingData
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if the task completed).
INbooleanfalse
OUTbooleantrue
ReplicationPipe REF CIM_NetworkPipe
DescriptionstringThe NetworkPipe element that scopes the remote mirror pair. If the value is null, remote mirrors do not require a pre-established connection.
SourceElement REF CIM_ManagedElement
DescriptionstringThe source storage element which may be a StorageVolume, StorageExtent, LogicalFile, FileSystem, CommonDatabase, or any other storage object. For this reason, the type is made very generic.
Requiredbooleantrue
TargetElement REF CIM_ManagedElement
DescriptionstringReference to the target storage element (i.e., the replica). The target storage element which may be a StorageVolume, StorageExtent, LogicalFile, FileSystem, CommonDatabase, or any other storage object. For this reason, the type is made very generic.
Requiredbooleantrue

CreateElementsFromStoragePools (uint32)

Method Qualifiers (CreateElementsFromStoragePools)

NameData TypeValue
DescriptionstringStart a job to create (or modify) a specified elements (for example StorageVolumes or StorageExtents) from StoragePools. One of the parameters for this method is Size. As an input parameter, Size specifies the desired size of the element. As an output parameter, it specifies the size achieved. Space is taken from the input StoragePool. The desired settings for the element are specified by the Goal parameter. If the requested size cannot be created, no action will be taken, and the Return Value will be 4097/0x1001. Also, the output value of Size is set to the nearest possible size. 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 create the element. The Job's reference will be returned in the output parameter Job. If the number of elements created is less than the number of elements requested, the return value will be 4098/0x1002.
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, Size Not Supported, Partially Completed Operation, Method Reserved, Vendor Specific

Method Parameters (CreateElementsFromStoragePools)

NameTypeQualifiers
NameData TypeValue
ElementCountuint64
DescriptionstringCount of elements to create. If null, it defaults to one element.
ElementTypeuint16
DescriptionstringEnumeration indicating the type of element being created. With ElementType of "2" and "3", the implementation decides the provisioning of the element.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, .., 32768..65535
ValuesstringUnknown, Reserved, StorageVolume, StorageExtent, LogicalDisk, ThinlyProvisionedStorageVolume, ThinlyProvisionedLogicalDisk, FullyProvisionedStorageVolume, FullyProvisionedLogicalDisk, DMTF Reserved, Vendor Specific
Sizeuint64
DescriptionstringAs an input parameter Size specifies the desired size for each element created. As an output parameter Size specifies the size achieved.
OUTbooleantrue
PUnitstringbyte
UnitsstringBytes
ElementNamesstring[]
DescriptionstringOne or more user relevant names for the element being created. If NULL, then system supplied default names may be used. The value will be stored in the "ElementName" property for the created element.
InPoolsCIM_StoragePool[]
DescriptionstringThe Pools from which to create the elements. If not supplied, system locates the appropriate pools.
TheElementsCIM_LogicalElement[]
DescriptionstringReference to the resulting elements.
OUTbooleantrue
Goal REF CIM_SettingData
DescriptionstringThe requirements for the element to maintain. If set to a null value, the default configuration from the source pool will be used. This parameter should be a reference to a Setting or Profile appropriate to the element being created.
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue

CreateOrModifyReplicationPipe (uint32)

Method Qualifiers (CreateOrModifyReplicationPipe)

NameData TypeValue
DescriptionstringThis method establishes a peer-to-peer connection identified by a NetworkPipe element and two ProtocolEndpoint elements created by the method provider. The NetworkPipe is associated to a special peer-to-peer Network element. The provider will verify that two systems are capable of a peer relationship. If endpoints are assigned to the pipe, the same number of source and target endpoints must be supplied by the client to form a set of endpoint pairs. If ReplicationPipe is not supplied as an input parameter, a new pipe is created. If a pipe is supplied, a new set of endpoints is assigned to the existing pipe. If Success (0) is returned, the function completed successfully. A return value of Not Supported (1) indicates the method is not supported. A return value of Busy (0x1000) indicates the method is not supported. All other values indicate some type of error condition.
ValueMapstring0, 1, 2, 3, 4, 5, .., 0x1000, 0x1001..0x7FFF, 0x8000..0xFFFF
ValuesstringSuccess, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, DMTF Reserved, Busy, Method Reserved, Vendor Specific

Method Parameters (CreateOrModifyReplicationPipe)

NameTypeQualifiers
NameData TypeValue
Goalstring
DescriptionstringThe setting properties to be maintained for the peer-to-peer connection.
EmbeddedInstancestringCIM_SettingData
PipeElementNamestring
DescriptionstringA user-friendly name for the element created.
SourceEndpointCIM_ProtocolEndpoint[]
DescriptionstringReferences to source system endpoints/ports assigned to the pipe. If a new pipe is created, this is the initial set of endpoints assigned. If an existing pipe is modified, this set replaces the previous set. The list must be null if a provider does not allow the client to manage port assignment.
TargetEndpointCIM_ProtocolEndpoint[]
DescriptionstringReferences to target system endpoints/ports assigned to the pipe. If a new pipe is created, this is the initial set of endpoints assigned. If an existing pipe is modified, this set replaces the previous set. The list must be null if a provider does not allow the client to manage port assignment.
ReplicationPipe REF CIM_NetworkPipe
DescriptionstringReference to the created or modified NetworkPipe.
OUTbooleantrue
SourceSystem REF CIM_ComputerSystem
DescriptionstringOne of the two peer systems participating in the established peer-to-peer connection. If the provider supports uni-directional connections, this must identify the system hosting replica source elements.
Requiredbooleantrue
TargetSystem REF CIM_ComputerSystem
DescriptionstringOne of the two peer systems participating in the established peer-to-peer connection. If the provider supports uni-directional connections, this must identify the system hosting replica target elements.
Requiredbooleantrue

CreateReplicationBuffer (uint32)

Method Qualifiers (CreateReplicationBuffer)

NameData TypeValue
DescriptionstringCreate (or start a job to create) a replication buffer that buffers asynchronous write operations for remote mirror pairs. The buffer is an instance of CIM_Memory with an AssociatedMemory association to a hosting system or to a replication network pipe. The buffer element may be created based on a StorageExtent, in a pool or in a manner opaque to a client. If 0 is returned, the function completed successfully and no ConcreteJob instance is created. If 0x1000 is returned, a ConcreteJob is started, a reference to which is returned in the Job output parameter. A return value of 1 indicates the method is not supported. All other values indicate some type of error condition. If Job Completed with No Error (0) is returned, the function completed successfully and a ConcreteJob instance is not created. If Method Parameters Checked - Job Started (0x1000) is returned, a ConcreteJob is started, a reference to which is returned in the Job output parameter. A return value of Not Supported (1) indicates the method is not supported. All other values indicate some type of error condition.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 0x1000, 0x1001..0x7FFF, 0x8000..0xFFFF
ValuesstringJob Completed with No Error, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (CreateReplicationBuffer)

NameTypeQualifiers
NameData TypeValue
Host REF CIM_ManagedElement
DescriptionstringThe hosting system or replication pipe that will be antecedent to the created buffer.
Requiredbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if the task completed).
INbooleanfalse
OUTbooleantrue
ReplicaBuffer REF CIM_Memory
DescriptionstringReference to the created replica buffer element.
OUTbooleantrue
TargetElement REF CIM_StorageExtent
DescriptionstringReference to a component extent for the buffer element.
TargetPool REF CIM_StoragePool
DescriptionstringReference to a container pool for the buffer element.

GetAvailableTargetElements (uint32)

Method Qualifiers (GetAvailableTargetElements)

NameData TypeValue
DescriptionstringGiven a source volume and a set of storage pools, this method will return a list of candidate target volumes. Since the rules for determining potential target volumes for a copy operation are not always straightforward, due to certain conditions, such as RAID level, the number of extents which consist of the StorageVolume, the type of storage array, and so on, it can be difficult for the client to know which volumes can be used as copy targets for a given source volume. This makes it difficult for the user to create a copy pair with the AttachOrModifyReplica because he must know which volumes can be used for target volume for a particular source volume, otherwise the request may fail.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Reserved, Vendor Specific

Method Parameters (GetAvailableTargetElements)

NameTypeQualifiers
NameData TypeValue
CopyTypeuint16
DescriptionstringCopy type: 2: Async 3: Sync 4: UnSyncAssoc 5: UnSyncUnAssoc 6: Migrate
Requiredbooleantrue
CandidatesCIM_LogicalElement[]
DescriptionstringThe list of the target volumes as the candidates.
OUTbooleantrue
TargetPoolCIM_StoragePool[]
DescriptionstringThe arrays of the pools to search for target volumes. The method finds candidate target volumes from the available volumes in the specified TargetPools. This does include volumes with a Usage property value of reserved for copy target. If null, the method finds volumes from all of the pools.
SourceElement REF CIM_LogicalElement
DescriptionstringThe original source volume for the pair.
Requiredbooleantrue

GetElementsBasedOnUsage (uint32)

Method Qualifiers (GetElementsBasedOnUsage)

NameData TypeValue
DescriptionstringAllows retrieving elements that meet the specified Usage. The criteria can be "available only", "in use only", or both.
ValueMapstring0, 1, 2, 3, 4, 5, .., 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Vendor Specific

Method Parameters (GetElementsBasedOnUsage)

NameTypeQualifiers
NameData TypeValue
Criteriauint16
DescriptionstringSpecifies whether to retrieve all elements, available elements only, or the elements that are in use.
ValueMapstring0, 2, 3, 4, .., 32768..65535
ValuesstringUnknown, All, Available Only, In Use Only, DMTF Reserved, Vendor Specific
ElementTypeuint16
DescriptionstringEnumeration indicating the type of elements to get.
ValueMapstring0, 2, 3, 4, 5, .., 32768..65535
ValuesstringUnknown, StorageVolume, StorageExtent, StoragePool, Logical Disk, DMTF Reserved, Vendor Specific
Usageuint16
DescriptionstringThe specific Usage to be retrieved.
ModelCorrespondencestringCIM_StoragePool.Usage, CIM_StorageExtent.Usage
TheElementsCIM_ManagedSystemElement[]
DescriptionstringArray of references to storage element instances retrieved.
OUTbooleantrue
ThePool REF CIM_StoragePool
DescriptionstringLimit the search for the elements that satisfy the criteria to this StoragePool only. If null, all appropriate StoragePools will be considered.

RequestUsageChange (uint32)

Method Qualifiers (RequestUsageChange)

NameData TypeValue
DescriptionstringAllows a client to request the Usage to be set if the client has access to the element supplied and the request is valid.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, Not Authorized, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (RequestUsageChange)

NameTypeQualifiers
NameData TypeValue
Operationuint16
DescriptionstringThe action to perform.
ValueMapstring2, 3, .., 32768..65535
ValuesstringSet, Modify "Other" description only, DMTF Reserved, Vendor Specific
OtherUsageDescriptionstring
DescriptionstringNew description text. Applicable when the usage value includes "Other".
UsageValueuint16
DescriptionstringApplicable requested usage/restriction -- see the appropriate Usage ValueMap.
ModelCorrespondencestringCIM_StoragePool.Usage, CIM_StorageExtent.Usage
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
OUTbooleantrue
TheElement REF CIM_LogicalElement
DescriptionstringThe storage element to modify.

ReturnElementsToStoragePool (uint32)

Method Qualifiers (ReturnElementsToStoragePool)

NameData TypeValue
DescriptionstringStart a job to delete elements previously created from StoragePools. The freed space is returned to the source StoragePool. If 0 is returned, the function completed successfully and no ConcreteJob was required. If 4096/0x1000 is returned, a ConcreteJob will be started to delete the element. A reference to the Job is returned in the Job parameter.
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 (ReturnElementsToStoragePool)

NameTypeQualifiers
NameData TypeValue
Optionsuint16
DescriptionstringAdditional options. Continue on nonexistent element: if the method encounters a non-existent element in the list of elements supplied, the method continues to delete the remaining elements. Return error on nonexistent element: if the method encounters a non-existent element in the list of elements supplied, the method returns an error.
ValueMapstring2, 3, .., 32768..65535
ValuesstringContinue on nonexistent element, Return error on nonexistent element, DMTF Reserved, Vendor Specific
TheElementsCIM_LogicalElement[]
DescriptionstringReferences to the elements to return to the StoragePool.
Requiredbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue

ScsiScan (uint32)

Method Qualifiers (ScsiScan)

NameData TypeValue
DescriptionstringThis method requests that the system rescan SCSI devices for changes in their configuration. If called on a general-purpose host, the changes are reflected in the list of devices available to applications (for example, the UNIX 'device tree'. This method may also be used on a storage appliance to force rescanning of attached SCSI devices. This operation can be disruptive; optional parameters allow the caller to limit the scan to a single or set of SCSI device elements. All parameters are optional; if parameters other Job are passed in as null, a full scan is invoked.
ValueMapstring0, 1, 2, 3, 4, 5, 6..4095, 4096, 4097, 4098, 4099, 4100, .., 32768..65535
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Invalid connection type, Invalid Initiator, No matching target found, No matching LUs found, Prohibited by name binding configuration, DMTF Reserved, Vendor Specific

Method Parameters (ScsiScan)

NameTypeQualifiers
NameData TypeValue
ConnectionTypeuint16
DescriptionstringThe type of connection, constrains the scan to initiator ports of this type. Only used if the Initiators parameter is null.
ModelCorrespondencestringCIM_SCSIProtocolEndpoint.ConnectionType
ValueMapstring1, 2, 3, 4, 5, 6, 7, 8, 9
ValuesstringOther, Fibre Channel, Parallel SCSI, SSA, IEEE 1394, RDMA, iSCSI, SAS, ADT
OtherConnectionTypestring
DescriptionstringThe connection type, if the ConnectionType parameter is "Other".
LogicalUnitsstring[]
DescriptionstringA list of SCSI logical unit numbers representing logical units hosted on the targets specified in the Targets argument.
Targetsstring[]
DescriptionstringA list of names or numbers for targets. These should be formatted to match the appropriate connection type, For example, PortWWNs would be specified for Fibre Channel targets.
InitiatorsCIM_SCSIProtocolEndpoint[]
DescriptionstringA list of references to initiators. Scanning will be limited to SCSI targets attached to these initiators. If this parameter is null and connection is specified, all initiators of that connection type are scanned. If this parameter and ConnectionType are null, all targets on all system initiators are probed.
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
OUTbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service