In |
SourceElements
|
CIM_StorageVolume
|
|
The source storage objects, can be instances of IBMTSDS_Volume or IBMTSDS_SEVolume. |
TargetElements
|
CIM_StorageVolume
|
|
References to the target storage elements (i.e., the replica), can be instances of IBMTSDS_Volume or IBMTSDS_SEVolume. Will be matched with source at the corresponding array position. i.e. the first TargetElement will be matched with the first SourceElement. |
CopyType
|
uint16
|
|
CopyType describes the type of Synchronized relationship that will be created. Valid values are:UnSyncAssoc: Create an unsynchronized copy and maintain an association to the source. (Persistent FlashCopy)UnSyncUnAssoc: Create unassociated copy of the source element. (Non-Persistent FlashCopy) |
Options
|
uint16
|
|
Options describes the ESS/DS-specific options for creating StorageSynchronized association. All Replicas attached in one method call will be attached using the same options.The following values are supported : AcceleratedDestage Select this option to cause a FlashCopy source volume track, which is being modified and is in a FlashCopy relationship, to be destaged from cache sooner than it would be if normal cache algorithms were applied. This feature minimizes the number of modified tracks that are resident in cache so that a new instance of FlashCopy does not go through the time consuming process of staging the source track and destaging it to the target volume before it indicates that the FlashCopy relationship is complete. AllowPPRCPrimary Selecting this options allows the flashcopy to establish when the flashcopy target is also a PPRC primary DoNotPermitIfTargetOnline Select this option if you do not want to establish a FlashCopy relationship if the target is online to the S/390 or zSeries host InhibitTargetWrites Select this option to insure that writes are inhibited on the target volume until an incremental FlashCopy operation is complete. This ensures data consistency on the target volume. NoBackgroundCopy Use this option when you don't want a background copy to occur after the FlashCopy pair has been established. This background copy will physically copy all data from the source to the target. This option is not necessary when the target is a space efficient volume, because there is never background copy when the target is a space efficient volume. NoRecordChanges Select this option to deactivate change recording on the volume pair participating in a FlashCopy relationship. An increment of a FlashCopy relationship will fail if the original relationship does not have change recording enabled. If InhibitTargetWrites is set, change recording cannot be performed on target volume. Change Recording applies only to Persistent FlashCopy. |
out |
ReturnCodes
|
uint32
|
|
Array of returned code status of attached replicas. See ReturnCodes.txt for a complete list of return codes. |
Return Codes |
none |
In |
ElementName
|
string
|
|
An end user relevant name for the element being created. 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.The maximum length is 16 characters for DS and 8 for ESS. |
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. Only creation and modification of StorageVolume is supported. ElementType modification is not supported. |
Goal
|
IBMTSDS_DataTypeSetting
|
|
The requirements for the element to maintain. This should be a reference to IBMTSDS_DataTypeSetting. If set to a null value, the default configuration from the source pool will be used, Block512 for Fixed Block pool and 3390 for CKD pool. For ESS, since pools are either 3380 or 3390, the default Goal will be taken from the pool. Goal modification is not supported. Supported DataTypeSettings for a particular pool can be obtained by following the StorageSettingsAssociatedToCapabilities assocation from the ExtentPool to the DataTypeSettings. |
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. NULL size is not supported during creation. Size expansion is supported for DS only. Contraction is not supported. During modification, a Size of null or 0 is treated as not modifying the Size.The Size as an output parameter will contain the nearest size that can be created. |
InPool
|
CIM_StoragePool
|
|
The Pool from which to create the element. This must be an instance of IBMTSDS_ExtentPool. |
TheElement
|
CIM_StorageVolume
|
|
As an input parameter: if null, creates a new StorageVolume. If not null, then the method modifies the specified StorageVolume. As an output parameter, it is a reference to the resulting StorageVolume. |
out |
Job
|
CIM_ConcreteJob
|
|
Not supported. |
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. NULL size is not supported during creation. Size expansion is supported for DS only. Contraction is not supported. During modification, a Size of null or 0 is treated as not modifying the Size.The Size as an output parameter will contain the nearest size that can be created. |
TheElement
|
CIM_StorageVolume
|
|
As an input parameter: if null, creates a new StorageVolume. If not null, then the method modifies the specified StorageVolume. As an output parameter, it is a reference to the resulting StorageVolume. |
Return Codes |
none |
In |
ElementNames
|
string
|
|
An end user relevant name for the elements being created. The value will be stored in the'ElementName'property for the created volume. If not NULL,this parameter willsupply a new name when modifying an existing pool.If not NULL, must have the same length as the quantity to be created or modified.The maximum length is 16 characters for DS and 8 for ESS. |
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. Only creation and modification of StorageVolume is supported. ElementType modification is not supported. |
Goal
|
IBMTSDS_DataTypeSetting
|
|
The requirements for the element to maintain. This should be a reference to IBMTSDS_DataTypeSetting. If set to a null value, the default configuration from the source pool will be used, Block512 for Fixed Block pool and 3390 for CKD pool. For ESS, since pools are either 3380 or 3390, the default Goal will be taken from the pool. Goal modification is not supported. Supported DataTypeSettings for a particular pool can be obtained by following the StorageSettingsAssociatedToCapabilities assocation from the ExtentPool to the DataTypeSettings. |
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. NULL size is not supported during creation. Size expansion is supported for DS only. Contraction is not supported. During modification, a Size of null or 0 is treated as not modifying the Size.The Size as an output parameter will contain the nearest size that can be created.All volumes created or modified will have the same Size. Beacuse different types of volumes have different size requirements, it is strongly recommended that all of the volumes being modified are of the same type and size. |
Quantity
|
uint16
|
|
As input, the number of StorageVolumes to be created. This parameter must be NULL when modifying StorageVolumes. As output, the number of volumes created if successful. Or if not sucessful due to too many volumes and not enough capacity on the ExtentPool, the number of volumes that can be created. |
LssNumber
|
string
|
|
LssNumber specifies the LSS on which to start the volume creation operation.If the specified LSS does not have enough space to create the given numberof volumes. This includes a LSS with 0 space left, then the first LSS innumerical order with space will be used to complete the volume creation operation.Notice the created volume may extend to multiple lsses.If this parameter is missing the first batch available lsses (if any) areused. LssNumber is a hex value from 00 to FF without the'0x'.If the rankGroup property of the ExtentPool is 0 then the LssNumber must be even, if it is 1 then the LssNumber must be odd.If an LSS has a CKD volume, then all volumes on the LSS must be CKD.If an LSS has a FB volume, then all volumes on the LSS must be FB.The first hex digit is the LSS group number. If an LSS group has a CKD LSS, then all LSS's in that LSS group must be CKD. Same applies for FB. Each call to this method only supports creation of volumes within one LSS.Modification is not supported. |
InPool
|
CIM_StoragePool
|
|
The Pool from which to create the element. This must be an instance of IBMTSDS_ExtentPool.Modification is not supported. |
TheElements
|
CIM_StorageVolume
|
|
As an input parameter: if null, creates new StorageVolumes. If not null, then the method modifies the specified StorageVolume. As an output parameter, it is a reference to the resulting StorageVolumes. |
out |
Job
|
CIM_ConcreteJob
|
|
Not supported. |
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. NULL size is not supported during creation. Size expansion is supported for DS only. Contraction is not supported. During modification, a Size of null or 0 is treated as not modifying the Size.The Size as an output parameter will contain the nearest size that can be created.All volumes created or modified will have the same Size. Beacuse different types of volumes have different size requirements, it is strongly recommended that all of the volumes being modified are of the same type and size. |
Quantity
|
uint16
|
|
As input, the number of StorageVolumes to be created. This parameter must be NULL when modifying StorageVolumes. As output, the number of volumes created if successful. Or if not sucessful due to too many volumes and not enough capacity on the ExtentPool, the number of volumes that can be created. |
TheElements
|
CIM_StorageVolume
|
|
As an input parameter: if null, creates new StorageVolumes. If not null, then the method modifies the specified StorageVolume. As an output parameter, it is a reference to the resulting StorageVolumes. |
ReturnCodes
|
uint32
|
|
Array of returned code status of created volumes. See ReturnCodes.txt for a complete list of return codes. |
Return Codes |
none |
In |
ElementName
|
string
|
|
The user can only define an ElementName for ExtentPool creation and modification. ElementName is not definable for ArrayPool or RankPool. |
Goal
|
CIM_StorageSetting
|
|
Reference to an instance of StorageSetting that defines the desired capabilities of the StoragePool.For ArrayPool creation for DS, this must be an instance of IBMTSDS_RAIDSetting.For RankPool and ExtentPool creation for DS, this must be an instnace of IBMTSDS_ExtentTypeSetting.Only ExtentPool creation is allowed on ESS, and for that case this must be an instnace of IBMTSDS_RAIDVSFormatSetting.The StorageSetting to be passed into this paramter can be obtained by following the StorageSettingsAssociatedToCapabilities association from StoragePoolCapabilities to StorageSettings.If a Goal is not passed in, the default setting for RankPool for DS is RAID5, the ExtentPool for DS will take on the characteristics of the RankPool that is passed into the InPools parameter, and the ExtentPool for ESS will be RAID5 and FB.Modification of Goal is not supported. |
InPools
|
string
|
|
Array of strings containing the CIM Object Path (Object Reference) of the CIM_StoragePool instances, that are used to create the Pool or modify the source pools. The InPools references must be only one type of Pool. In other words, only ArraySitePools, ArrayPools, or RankPools, and not a combination.If an ArraySitePool is passed in, an ArrayPool will be created. The DS6000 supports one or two ArraySites when creating an Array. The DS8000 only supports one ArraySite for Array creation.If an ArrayPool is passed in, a RankPool will be created. Currently the DS systems only support creation of a Rank from a single Array.If a RankPool is passed in, an ExtentPool will be created. An ExtentPool can be created from multiple RankPools, even if they have different RAID types, although this configuration is not suggested.Modification of InPools is only supported for ExtentPools, meaning the Pool input must be an ExtentPool and the InPools input must be an array of RankPools to assign to the ExtentPool.An ExtentPool cannot be passed in as a parameter. |
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.Not supported. |
Pool
|
CIM_StoragePool
|
|
As an input parameter: if null, creates a new StoragePool. If not null, modifies the referenced Pool. Whenreturned, it is a reference to the resulting StoragePool. Only modification of ElementName and InPools of ExtentPool is supported. |
out |
Job
|
CIM_ConcreteJob
|
|
Not supported. |
Size
|
uint64
|
|
Not supported as in input parameter, since the size created is directly obtained from the InPools input. 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. Whenreturned, it is a reference to the resulting StoragePool. Only modification of ElementName and InPools of ExtentPool is supported. |
Return Codes |
none |
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_StorageVolume
|
|
The source storage object - can be an instance of IBMTSDS_Volume or IBMTSDS_SEVolume. |
TargetSettingGoal
|
IBMTSDS_DataTypeSetting
|
|
The definition for the StorageSetting to be maintained by the target storage object (the replica). Must be an instance of IBMTSDS_DatatTypeSetting. |
TargetPool
|
CIM_StoragePool
|
|
The underlying storage for the target element (the replica) will be drawn from TargetPool. Must be an instance of IBMTSDS_ExtentPool. |
CopyType
|
uint16
|
|
CopyType describes the type of copy that will be made. Supported values are:UnSyncAssoc: Create an unsynchronized copy and maintain an association to the source. (Persistent FlashCopy)UnSyncUnAssoc: Create unassociated copy of the source element (Non-Persistent FlashCopy). |
out |
TargetElement
|
CIM_StorageVolume
|
|
Reference to the created target storage element (i.e., the replica). |
Return Codes |
none |
In |
Operation
|
uint16
|
|
See ModifySynchronization |
Options
|
uint16
|
|
The following options are supported: For options 0-2 and 4-6 see description in AttachReplicas. For Detaching UnSyncAssoc or UnSyncUnAssoc: Commit This option is used to withdraw the previous consistency and commit the new data to the FlashCopy target Revertible state will be reset, ChangeRecording will be toggled(if active),SourceWriteInhibit will be reset. If relation is not in a Revertible state the command is terminated. InitiateBackground Use this option to copy all data on the source volume to the the target volume for each FlashCopy pair. This option is useful if you have established a FlashCopy relationship without a background copy and later need to create a permanent physical copy of the data for backup or disaster recovery purposes. All FlashCopy relationships are withdrawn once the copies are complete. This option works only for UnPersistent FlashCopy. ResetTargetWriteInhibit Use this option to remove the inhibit write to target option from the FlashCopy relationship. This will not cause the relation to be withdrawn. Revert This option is used to withdraw new data and revert to the previous consistency This will not cause the relation to be withdrawn and the revertible state will be reset. If the relation is not in a revertible state, then the command is terminated. TargetIssue Use this option on the target volume when you want to remove its I-am-a-copy icon. ReleaseAllocTgtSpace When set, if the specified target volume is a space efficient volume, then the space on the target volume associated with the FlashCopy relation will be released. If the target volume is NOT a space efficient volume, this option will be ignored. Valid combinations of options for detaching UnSync: none targetIssue initiateBackground commit revert resetTargetWrite resetTargetWrite| initiateBackground For Resync Replica UnSyncAssoc or UnSyncUnAssoc: InhibitSourceWrites This option is used to establish a FlashCopy that does not allow source I/O Only works if Revertible option is set Revertible This option is used to establish a revertible FlashCopy. Before you can use this option, a flash copy pair must already be established with the persistent and change recording enabled. Then a second flash copy has to be performed on the same volumes with the revertible option set. Other condition to set this option are: NoBackgroundCopy, InhibitWritesToTarget, InhibitWritesToSource, Do NOT AllowPPRCPrimary All valid options for AttachReplicas are also valid for Resync Replica for UnSyncAssoc and UnSyncUnAssoc For Restore from Replica, UnSyncAssoc only: FastReverseRestore Select this option to reverse the FlashCopy relationship and copy the modified tracks from the target volume to the source volume. The user will be to execute the Reverse Restore even though Background Copy may not have completed. By acknowledging that Background Copy has not completed, the users should be aware that they don't know what data they have on the Target device. ChangeRecording must be enabled on the original source, the originat Target must be write inhibited |
Synchronizations
|
IBMTSDS_StorageSynchronized
|
|
The referenced to the StorageSynchronized association describing the storage source/replica relationship. |
out |
ReturnCodes
|
uint32
|
|
Array of returned code status of modifySynchronizations replicas. See ReturnCodes.txt for a complete list of return codes. |
Return Codes |
none |