Class CIM_StorageConfigurationService


CIM_ManagedElement
\_CIM_ManagedSystemElement
  \_CIM_LogicalElement
    \_CIM_EnabledLogicalElement
      \_CIM_Service


Description

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

Subclasses

IBMTSDS_StorageConfigurationService

Referenced By


Properties

IdTypeRangeDescription
Key
CreationClassName string
Max Length256
CreationClassName indicates the name of the class or the subclass that is used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.
Name string
Max Length256
The Name property uniquely identifies the Service and provides an indication of the functionality that is managed. This functionality is described in more detail in the Description property of the object.
SystemCreationClassName string
Max Length256
The CreationClassName of the scoping System.
SystemName string
Max Length256
The Name of the scoping System.
Read Only
Read Write
 
Inherited from class CIM_ManagedElement
Caption, Description, ElementName
 
Inherited from class CIM_ManagedSystemElement
HealthState, InstallDate, Name, OperationalStatus, Status, StatusDescriptions
 
Inherited from class CIM_EnabledLogicalElement
EnabledState, OtherEnabledState, RequestedState, TimeOfLastStateChange, EnabledDefault
 
Inherited from class CIM_Service
Started, StartMode, PrimaryOwnerContact, PrimaryOwnerName
 

Method Summary

NameDescription
AttachOrModifyReplicaCreate (or start a job to create) a StorageSynchronized mirror relationship between two storage elements.
AttachReplicaCreate (or start a job to create) a StorageSynchronized relationship between two existing storage objects.
CreateOrModifyElementFromElementsStart a job to create (or modify) a specified storage element from specified input StorageExtents.
CreateOrModifyElementFromStoragePoolStart a job to create (or modify) a specified element (for example a StorageVolume or StorageExtent) from a StoragePool.
CreateOrModifyReplicationPipeThis method establishes a peer-to-peer connection identified by a NetworkPipe element and two ProtocolEndpoint elements created by the method provider.
CreateOrModifyStoragePoolStarts a job to create (or modify) a StoragePool.
CreateReplicaStart a job to create a new storage object which is a replica of the specified source storage object.
CreateReplicationBufferCreate (or start a job to create) a replication buffer that buffers asynchronous write operations for remote mirror pairs.
DeleteStoragePoolStart a job to delete a StoragePool.
ModifySynchronizationModify (or start a job to modify) the synchronization association between two storage objects.
ReturnToStoragePoolStart a job to delete an element previously created from a StoragePool.
ScsiScanThis method requests that the system rescan SCSI devices for changes in their configuration.
 
Inherited from class CIM_EnabledLogicalElement
RequestStateChange
 
Inherited from class CIM_Service
StartService, StopService
 

Method Detail


AttachOrModifyReplica

Description

Create (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.

Parameters

IdTypeRangeDescription
In
SourceElement CIM_ManagedElement
The 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.
TargetElement CIM_ManagedElement
Reference 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.
CopyType uint16
CopyType 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.
Goal string
The StorageSetting properties to be created or modified for the target element.
ReplicationPipe CIM_NetworkPipe
The NetworkPipe element that scopes the remote mirror pair. If the value is null, remote mirrors do not require a pre-established connection.
out
Job CIM_ConcreteJob
Reference to the job (may be null if the task completed).
Return Codes
none

AttachReplica

Description

Create (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.

Parameters

IdTypeRangeDescription
In
SourceElement CIM_ManagedElement
The source storage object which may be a StorageVolume or other storage object.
TargetElement CIM_ManagedElement
Reference to the target storageelement (i.e., the replica).
CopyType uint16
CopyType 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.
out
Job CIM_ConcreteJob
Reference to the job (may be null if the task completed).
Return Codes
none

CreateOrModifyElementFromElements

Description

Start 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 geta 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.

Parameters

IdTypeRangeDescription
In
ElementName string
A 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.
ElementType uint16
Enumeration 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.
Goal CIM_ManagedElement
The 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.
Size uint64
As 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.
InElements CIM_StorageExtent
Array of references to storage element instances that are used to create or modify TheElement.
TheElement CIM_LogicalElement
As 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.
out
Job CIM_ConcreteJob
Reference to the job (may be null if job completed).
Size uint64
As 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.
TheElement CIM_LogicalElement
As 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.
Return Codes
none

CreateOrModifyElementFromStoragePool

Description

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

Parameters

IdTypeRangeDescription
In
ElementName string
A 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.
ElementType uint16
Enumeration 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.
Goal CIM_ManagedElement
The 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.
Size uint64
As 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.
InPool CIM_StoragePool
The 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).
TheElement CIM_LogicalElement
As 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.
out
Job CIM_ConcreteJob
Reference to the job (may be null if job completed).
Size uint64
As 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.
TheElement CIM_LogicalElement
As 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.
Return Codes
none

CreateOrModifyReplicationPipe

Description

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

Parameters

IdTypeRangeDescription
In
PipeElementName string
A user-friendly name for the element created.
SourceSystem CIM_ComputerSystem
One 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.
TargetSystem CIM_ComputerSystem
One 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.
SourceEndpoint CIM_ProtocolEndpoint
References 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.
TargetEndpoint CIM_ProtocolEndpoint
References 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.
Goal string
The setting properties to be maintained for the peer-to-peer connection.
ReplicationPipe CIM_NetworkPipe
Reference to the created or modified NetworkPipe.
out
ReplicationPipe CIM_NetworkPipe
Reference to the created or modified NetworkPipe.
Return Codes
none

CreateOrModifyStoragePool

Description

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

Parameters

IdTypeRangeDescription
In
ElementName string
A 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.
Goal CIM_StorageSetting
Reference 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.
Size uint64
As an input parameter this specifies the desired pool size in bytes. As an output parameter this specifies the size achieved.
InPools string
Array of strings containing representations of references to CIM_StoragePool instances, that are used to create the Pool or modify the source pools.
InExtents string
Array of strings containing representations of references to CIM_StorageExtent instances, that are used to create the Pool or modify the source extents.
Pool CIM_StoragePool
As 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.
out
Job CIM_ConcreteJob
Reference to the job (may be null if job completed).
Size uint64
As an input parameter this specifies the desired pool size in bytes. As an output parameter this specifies the size achieved.
Pool CIM_StoragePool
As 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.
Return Codes
none

CreateReplica

Description

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

Parameters

IdTypeRangeDescription
In
ElementName string
A 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.
SourceElement CIM_LogicalElement
The source storage object which may be a StorageVolume or storage object.
TargetSettingGoal CIM_StorageSetting
The definition for the StorageSetting to be maintained by the target storage object (the replica).
TargetPool CIM_StoragePool
The underlying storage for the target element (the replica) will be drawn from TargetPool if specified, otherwise the allocation is implementation specific.
CopyType uint16
CopyType 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 associationto the source.UnSyncUnAssoc: Create unassociated copy of the source element.
out
Job CIM_ConcreteJob
Reference to the job (may be null if job completed).
TargetElement CIM_LogicalElement
Reference to the created target storage element (i.e., the replica).
Return Codes
none

CreateReplicationBuffer

Description

Create (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.

Parameters

IdTypeRangeDescription
In
Host CIM_ManagedElement
The hosting system or replication pipe that will be antecedent to the created buffer.
TargetElement CIM_StorageExtent
Reference to a component extent for the buffer element.
TargetPool CIM_StoragePool
Reference to a container pool for the buffer element.
ReplicaBuffer CIM_Memory
Reference to the created replica buffer element.
out
Job CIM_ConcreteJob
Reference to the job (may be null if the task completed).
ReplicaBuffer CIM_Memory
Reference to the created replica buffer element.
Return Codes
none

DeleteStoragePool

Description

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

Parameters

IdTypeRangeDescription
In
Pool CIM_StoragePool
Reference to the pool to delete.
out
Job CIM_ConcreteJob
Reference to the job (may be null if job completed).
Return Codes
none

ModifySynchronization

Description

Modify (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.

Parameters

IdTypeRangeDescription
In
Operation uint16
Operation 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).
Synchronization CIM_StorageSynchronized
The referenced to the StorageSynchronized association describing the storage source/replica relationship.
out
Job CIM_ConcreteJob
Reference to the job (may be null if the task completed).
Return Codes
none

ReturnToStoragePool

Description

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

Parameters

IdTypeRangeDescription
In
TheElement CIM_LogicalElement
Reference to the element to return to the StoragePool.
out
Job CIM_ConcreteJob
Reference to the job (may be null if job completed).
Return Codes
none

ScsiScan

Description

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

Parameters

IdTypeRangeDescription
In
Job CIM_ConcreteJob
Reference to the job (may be null if job completed).
ConnectionType uint16
The type of connection, constrains the scan to initiator ports of this type.Only used if the Initiators parameter is null.
OtherConnectionType string
The connection type, if the ConnectionType parameter is"Other".
Initiators CIM_SCSIProtocolEndpoint
A 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.
Targets string
A 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.
LogicalUnits string
A list of SCSI logical unit numbers representing logicalunits hosted on the targets specified in the Targets argument.
out
Job CIM_ConcreteJob
Reference to the job (may be null if job completed).
Return Codes
none