BlockServices
Class IBMTSSVC_StorageConfigurationService


CIM_ManagedElement
\_CIM_ManagedSystemElement
  \_CIM_LogicalElement
    \_CIM_EnabledLogicalElement
      \_CIM_Service
        \_CIM_StorageConfigurationService


Description

This service provides extrinsic methods for basic storage configuration tasks. E.g. creation of StoragePools, allocation of StorageVolumes, ...

Subclasses


Referenced By

IBMTSSVC_HostedStorageConfigurationService IBMTSSVC_StorageConfigurationServiceCapabilities IBMTSSVC_StorageReplicationCapabilities

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
The Name property uniquely identifies the Service and provides an indication of the function that is managed. This function 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
Description string
The Description property provides a textual description of the object.
EnabledDefault uint16
Enabled2
Disabled3
Not Applicable5
Enabled but Offline6
No Default7
DMTF Reserved8..32767
Vendor Reserved32768..65535
An enumerated value indicating an administrator's default or startup configuration for the Enabled State of an element. By default, the element is"Enabled"(value=2).
EnabledState uint16
Unknown0
Other1
Enabled2
Disabled3
Shutting Down4
Not Applicable5
Enabled but Offline6
In Test7
Deferred8
Quiesce9
Starting10
DMTF Reserved11..32767
Vendor Reserved32768..65535
EnabledState is an integer enumeration that indicates the enabled and disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value=4) and starting (value=10) are transient states between enabled and disabled. The following text briefly summarizes the various enabled and disabled states:Enabled (2) indicates that the element is or could be running commands, will process any queued commands, and queues new requests.Disabled (3) indicates that the element will not run commands and will drop any new requests.Shutting Down (4) indicates that the element is in the process of going to a Disabled state.Not Applicable (5) indicates the element does not support being enabled or disabled.Enabled but Offline (6) indicates that the element might be completing commands, and will drop any new requests.Test (7) indicates that the element is in a test state.Deferred (8) indicates that the element might be completing commands, but will queue any new requests.Quiesce (9) indicates that the element is enabled but in a restricted mode. The behavior of the element is similar to the Enabled state, but it processes only a restricted set of commands. All other requests are queued.Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued.
OperationalStatus uint16
Unknown0
Other1
OK2
Degraded3
Stressed4
Predictive Failure5
Error6
Non-Recoverable Error7
Starting8
Stopping9
Stopped10
In Service11
No Contact12
Lost Communication13
Aborted14
Dormant15
Supporting Entity in Error16
Completed17
Power Mode18
DMTF Reserved..
Vendor Reserved0x8000..
Indicates the current status(es) of the element. Various health and operational statuses are defined. Many of the enumeration's values are self- explanatory. However, a few are not and are described in more detail."Stressed"indicates that the element is functioning, but needs attention. Examples of"Stressed"states are overload, overheated, etc."Predictive Failure"indicates that an element is functioning nominally but predicting a failure in the near future."In Service"describes an element being configured, maintained, cleaned, or otherwise administered."No Contact"indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it."Lost Communication"indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable."Stopped"and"Aborted"are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the element's state and configuration may need to be updated."Dormant"indicates that the element is inactive or quiesced."Supporting Entity in Error"describes that this element may be"OK"but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower layer networking problems."Completed"indicates the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can till if the complete operation passed (Completed with OK), and failure (Completed with Error). Completed with Degraded implies the operation finished, but did not complete OK or report an error."Power Mode"indicates the element has additional power model information contained in the Associated PowerManagementService association.OperationalStatus replaces the Status property on ManagedSystemElement to provide a consistent approach to enumerations, to address implementation needs for an array property, and to provide a migration path from today's environment to the future. This change was not made earlier since it required the DEPRECATED qualifier. Due to the widespread use of the existing Status property in management applications, providers/instrumentation must provide both the Status and OperationalStatus properties. Further, the first value of OperationalStatus can contain the primary status for the element. When instrumented, Status (since it is single-valued) will also provide the primary status of the element.
OtherEnabledState string
A string that describes the enabled or disabled state of the element when the EnabledState property is set to 1 ("Other"). This property must be set to null when EnabledState is any value other than 1.
RequestedState uint16
Enabled2
Disabled3
Shut Down4
No Change5
Offline6
Test7
Deferred8
Quiesce9
Reboot10
Reset11
Not Applicable12
DMTF Reserved..
Vendor Reserved32768..65535
RequestedState is an integer enumeration that indicates the last requested or desired state for the element. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled or disabled states. When EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. By default, the RequestedState of the element is 5 ("No Change"). Refer to the EnabledState property description for explanations of the values in the RequestedState enumeration.It should be noted that there are two new values in RequestedState that build on the statuses of EnabledState. These are"Reboot"(10) and"Reset"(11). Reboot refers to doing a"Shut Down"and then moving to an"Enabled"state. Reset indicates that the element is first"Disabled"and then"Enabled". The distinction between requesting"Shut Down"and"Disabled"should also be noted. Shut Down requests an orderly transition to the Disabled state, and might involve removing power, to completely erase any existing state. The Disabled state requests an immediate disabling of the element, such that it will not run or accept any commands or processing requests.This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or can be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, because it allows an explicit invocation of the operation and the return of a result code.A particular instance of EnabledLogicalElement might not support RequestedStateChange. If this occurs, the value 12 ("Not Applicable") is used.
Started boolean
Started is a Boolean that indicates whether the Service has been started (TRUE), or stopped (FALSE).
StatusDescriptions string
Strings describing the various OperationalStatus array values. For example, if"Stopping"is the value assigned to OperationalStatus, then this property may contain an explanation as to why an object is being stopped. Entries in this array are correlated with those at the same array index in OperationalStatus.
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
AddVdiskCopyAdd an additional copy to an existing vdisk.
AttachReplicaCreate (or start a job to create) a StorageSynchronized relationship between two existing storage objects.
AttachReplicasCreate (or start a job to create) multiple StorageSynchornized relationships between two existing storage objects.
CreateOrModifyElementFromStoragePoolThis method will create or modify a StorageVolume.
CreateOrModifyStoragePoolThis method wil either create a new storage pool or modify an existing storage pool, depending on the"Pool"parameter.
CreateReplicaThis method starts a job to create a new StorageVolume which is a replica of the source StorageVolume.
CreateSynchronizedSetMethod to create a SynchronizedSet.
DeleteStoragePoolThis method will delete a StoragePool.
DeleteSynchronizedSetMethod to delete a SynchronizedSet.
GetDependentCascadingNamesGet the names of the dependent cascading mappings for the given volume.
GetDependentMappingNamesGet the names of the dependent mappings for the given FCMap.
GetVdiskCandidatesViewVendor extension to get a list of candidate VDisks for a given VDisk.
IncludeBackendVolumeThis method is used to reinclude a BackendVolume which has been expelled by the cluster.
MigrateVDiskExtentsMigrate VDisk extents from one MDisk to another MDisk.
MigrateVolumeThis method migrates a StorageVolume from one StoragePool to another.
MigrateVolumeToImageModeThis method migrates a StorageVolume to an image mode that maps 1-to-1 with a BackendVolume.
ModifySynchronizationThis method modifies a synchronization according to the operation that was passed in.
ModifySynchronizedSetMethod to manipulate SynchronizedSets.
RecoverVDiskRequests recovery of a vdisk.
RecoverVDiskByClusterRequests recovery of all vdisks within a cluster.
RecoverVDiskByIOGroupRequests recovery of all vdisks within an IO group.
RepairSpaceEfficientCopyRequests validating and repairing Space-Efficient metadata.
RepairVdiskCopyVerifies that the data on synchronized VDisk copies is indeed identical.
RequestDiscoveryInvoking this method causes the cluster to scan the Fibre Channel in order to discover new BackendVolumes.
ReturnToStoragePoolThis method will delelte a StorageVolume.
RmVdiskCopyDeletes a VDisk copy.
SetIOGroupThis method is used to assign a StorageVolume to another IOGroup.
SetQuorumThis method is used to set a BackendVolume as quorum disk.
SetThrottleThis method is used to set IO governing rates for the Virtual Disk.
SplitVdiskCopyAllows one to split a VDisk copy from its current VDisk tocreate a new, independent VDisk.
 
Inherited from class CIM_EnabledLogicalElement
RequestStateChange
 
Inherited from class CIM_Service
StartService, StopService
 
Inherited from class CIM_StorageConfigurationService
AttachReplica, CreateOrModifyElementFromElements, CreateOrModifyElementFromStoragePool, CreateOrModifyStoragePool, CreateReplica, DeleteStoragePool, ModifySynchronization, ReturnToStoragePool
 

Method Detail


AddVdiskCopy

Description

Add an additional copy to an existing vdisk.

Parameters

IdTypeRangeDescription
In
TheElement IBMTSSVC_StorageVolume
The vdisk to add a copy / copies to.
MirrorPools IBMTSSVC_ConcreteStoragePool
The list of mdisk groups to create the copies on.
BackendVolumes IBMTSSVC_BackendVolume
The list of mdisks to use.
VirtualizationType uint8
Sets the virtualization type of the new vdisk copies. Default is"striped"which will stripe the data of the volume across all BackendVolumes in the Pool. Other values are"image"and"sequential"which both store the data on a single BackendVolume."image"allows to map a vdisk copy 1:1 to a BackendVolume.
Format boolean
Optionally specifies that the new copies should be formatted.
CreateSync boolean
True = mark copy as synchronized without actually performing synchronization. This should only be specified if you are certain that no writes have been made to the existing vdisk copy. False = don't mark the copy as synchronized. Normal synchronization will occur.
SyncRate uint8
Controls the rate of synchronization of copies. 0 = no synchronization. 100 = maximum speed synchronization.
RealSizeBytes uint64
Real size of a space efficient copy.
WarningSizeBytes uint64
Set point of used capacity at which point a warning is triggered. Mutualy Exclusive with WarningSizePercent
RealSizePercent uint64
Real size of a space efficient copy.
WarningSizePercent uint8
Ratio of used versus real capacity at which point a warning is triggered. Mutualy Exclusive with WarningSizeBytes
Autoexpand boolean
Whether to automatically expand the real size.
Grainsize uint32
Size of allocation blocks in kb.
Job CIM_ConcreteJob
IBMTSSVC_VdiskSyncJob showing synchronization progress of newly created vdisk copy.
out
Job CIM_ConcreteJob
IBMTSSVC_VdiskSyncJob showing synchronization progress of newly created vdisk copy.
Return Codes
none

AttachReplica

Description

Create (or start a job to create) a StorageSynchronized relationship between two existing storage objects. 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
Synchronized boolean
Indicates in case of copy type"Sync"that source and target already contain identical data.
BackgroundCopyRate uint16
Sets the background copy rate as a percentage for flash copies (copy type 4 or 5). The default value is 50. A value of 0 specifieds that background copy is disabled. This value will be ignored for remote copies (copy type 2 or 3
Set IBMTSSVC_SynchronizedSet
The set the synchronization will be added to. This is an optional parameter. If set is a clone and synchronization is not a clone, then an invalid set error will be returned and the attach will fail.
ElementName string
The name of the StorageSynchronized association to be created.
Job CIM_ConcreteJob
Reference to the job (may be null if the task completed).
Incremental boolean
Indicates in case of copy type"UnSyncAssoc"or"UnSyncUnAssoc"that the relationship is incremental.Only available in firmware versions>= 4.2.1.0
GrainSize uint16
The size of the copy grain in case of"UnSyncAssoc"or"UnSynUnAssoc"copy types. Only available in firmware versions>= 4.2.1.0
CleanRate uint16
The cleaning rate in case of"UnSyncAssoc"or"UnSynUnAssoc"copy types. Only available in firmware versions>= 4.2.1.0
IOGroupID string
The iogroup ID or name in case of"UnSyncAssoc"or"UnSynUnAssoc"copy types during cascading.Only available in firmware versions>= 4.2.1.0
SourceElement CIM_ManagedElement
The source volume
TargetElement CIM_ManagedElement
The target volume
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

AttachReplicas

Description

Create (or start a job to create) multiple StorageSynchornized relationships between two existing storage objects. Using the input parameter, CopyType, this function can be used 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 us 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
Synchronized boolean
Indicates in case of copy type"Sync"that source and target already contain identical data.
BackgroundCopyRate uint16
The background copy rate in case of"UnSyncAssoc"copy types. The default 50. 0 value is only valid for FlashCopy Maps, and will return 36867 for RemoteCopy
Set IBMTSSVC_SynchronizedSet
The set the synchronization will be added to. This is an optional parameter.
ElementNames string
The names of the StorageSynchronized associations to be created.
Job CIM_ConcreteJob
Reference to the job (may be null if the task completed.)
ReturnValues uint32
The Ordered List of return codes from each individual attach in the order of input
Incremental boolean
Indicates in case of copy type"UnSyncAssoc"or"UnSyncUnAssoc"that the relationship is incremental.Only available in firmware versions>= 4.2.1.0
GrainSize uint16
The size of the copy grain in case of"UnSyncAssoc"or"UnSynUnAssoc"copy types. Only available in firmware versions>= 4.2.1.0
CleanRate uint16
The cleaning rate in case of"UnSyncAssoc"or"UnSynUnAssoc"copy types. Only available in firmwareversions>= 4.2.1.0
IOGroupID string
The iogroup ID or name in case of"UnSyncAssoc"or"UnSynUnAssoc"copy types during cascading.Only available in firmware versions>= 4.2.1.0
SourceElements CIM_ManagedElement
The source volumes
TargetElements CIM_ManagedElement
The target volumes
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.)
ReturnValues uint32
The Ordered List of return codes from each individual attach in the order of input
Return Codes
none

CreateOrModifyElementFromStoragePool

Description

This method will create or modify a StorageVolume.

Parameters

IdTypeRangeDescription
In
VirtualizationType uint8
Sets the virtualization type of the new StorageVolume. Default is"striped"which will stripe the data of the volume across all BackendVolumes in the Pool. Other values are"image"and"sequential"which both store the data on a single BackendVolume."image"allows to map a StorageVolume 1:1 to BackendVolume without touching the data which is already present on the BackendVolume.
IOGroup IBMTSSVC_IOGroup
Optionally specifies the IOGroup the StorageVolume will be assigned to.
PreferredNode IBMTSSVC_Node
Optionally specifies the preferred Node for StorageVolume access.
Format boolean
If true the volume will be formatted on creation (and expansion).
BackendVolumes IBMTSSVC_BackendVolume
Optionally specifies the BackendVolumes to store the StorageVolume's data on.
CacheMode uint16
The volume's cache mode. Can be either 0 ("None"), or 1 ("Read Write"). Ignored for SVC clusters running pre v3.1.0 Firmware.
UnitDeviceID uint16
The volume's Unit Device ID as defined by OpenVMS. Ignored for SVC Clusters running pre v4.1.0 Firmware.
ElementName string
An 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
The type of element to create/modify. Only type"StorageVolume"(2) is supported by the SAN Volume Controller.
Job CIM_ConcreteJob
Reference to the job (may be null if job completed).
Goal CIM_StorageSetting
If sumbitted"Goal"must be the SVC default setting.
Size uint64
The desired (new) size of the StorageVolume
InPool IBMTSSVC_ConcreteStoragePool
The StoragePool from which the new StorageVolume will be allocated. Mutually exclusive with"TheElement".
TheElement IBMTSSVC_StorageVolume
Contains the StorageVolume to be modified. If"TheElement"is NULL a new StorageVolume will be created. Mutually exclusive with"InPool".
isSpaceEfficient boolean
If specified it indicates that the VDisk is space efficient (otherwise it is fully allocated).
RealSizeBytes uint64
This parameter optionally requests that the VDisk be Space-Efficient and specifies the real size in bytes. Mutualy Exclusive with RealSizePercent Optional when used with Import. When modifying an existing VDisk for rsize, if a VDisk copy ID is not specified and multiple copies exist, the rsize of the VDisk copy with the lowest copy id be used to determine if the rsize is growing or shrinking and by how much.
WarningSizeBytes uint64
Set point of used capacity at which point a warning is triggered. Mutualy Exclusive with WarningSizePercent
RealSizePercent uint64
This parameter optionally requests that the VDisk be Space-Efficient and specifies the real size as a percentageof Size on Creation. Mutualy Exclusive with RealSizeBytes. Optional when used with Import. Will return error if used for Storage Volume Modification.
WarningSizePercent uint8
Ratio of used versus real capacity at which point a warning is triggered. Mutualy Exclusive with WarningSizeBytes range is 0 to 100
Autoexpand boolean
The default is that auto expand is off, this parameter overrides that default. This parameter enables autoexpand for a Space-Efficient StorageVolume
Grainsize uint32
Accepts the values 32, 64, 128 or 256. This parameter sets the grain size for a Space-Efficient StorageVolume. Value is ignored on Modify.
Import boolean
This parameter requests SVC import a Space-Efficient StorageVolume from the StoragePool
Copies uint32
The number of mirrored copies to create. Either 1 or 2 for SVC v4.3.
MirrorPools IBMTSSVC_ConcreteStoragePool
mdisk groups to use if creating multiple VDisk copies.The InPool parameter should be used to supply the mdisk group to use for the primary VDisk copy. This parameter should be used to supply the mdisk groups for the other VDisk copies.
CopyID uint32
The ID of the mirrored copy. Value is ignored on Creation.
Primary uint32
id of the copy to be made the primary read copy. Value is ignored on Creation.
CreateSync boolean
Whether mirrored copies should be created in sync.
SyncRate uint8
Synchronization rate of mirrored copies. 100 = maximum speed. 0 = no synchronization.
out
Job CIM_ConcreteJob
Reference to the job (may be null if job completed).
Size uint64
The desired (new) size of the StorageVolume
TheElement IBMTSSVC_StorageVolume
Contains the StorageVolume to be modified. If"TheElement"is NULL a new StorageVolume will be created. Mutually exclusive with"InPool".
Return Codes
none

CreateOrModifyStoragePool

Description

This method wil either create a new storage pool or modify an existing storage pool, depending on the"Pool"parameter.

Parameters

IdTypeRangeDescription
In
Force boolean
If true the removal of BackendVolumes from the Pool is forced. Ingnored on creation / expansion of a Pool.
BlockSize uint16
The block size of the new StoragePool. SVC will manage the capacity in chunks of this size. E.g. a block size of 128 MB means that all volumes from that Pool will occupy a space which is a multiple of 128 MB. So a 150 MB volume will occupy 256 MB of raw Pool capacity.
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.
Job CIM_ConcreteJob
Reference to the job (may be null if job completed).
Goal CIM_StorageSetting
If submitted"Goal"must be the SVC default setting.
Size uint64
As an input parameter this specifies the desired pool size in bytes. As an output parameter this specifies the size achieved. If this parameter is not provided withInExtents then it is assumed that the extents are beingadded to the Pool. If the extents need to be removed fromthe pool a Size parameter must be provided that is lessthan the current pool size and greater than 0.
InPools string
The Primordial StoragePools to create/expand the (new) StoragePool from. Mutually exclusive with InExtents[].
InExtents string
The BackendVolumes to add to or remove from the StoragePool. Mutually exclusive with InPools.
Pool IBMTSSVC_ConcreteStoragePool
If NULL a new StoragePool will be created. Otherwise BackendVolumes will be added to or removed from the StoragePool submitted here.
WarningSizeBytes uint64
Ratio of used versus real capacity at which point a warning is triggered. Expressed in bytes. Mutualy Exclusive with WarningSizePercent
WarningSizePercent uint8
Ratio of used versus real capacity at which point a warning is triggered. Expressed as a percentage. Mutualy Exclusive with WarningSizeBytes. Range is 0 to 100
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. If this parameter is not provided withInExtents then it is assumed that the extents are beingadded to the Pool. If the extents need to be removed fromthe pool a Size parameter must be provided that is lessthan the current pool size and greater than 0.
Pool IBMTSSVC_ConcreteStoragePool
If NULL a new StoragePool will be created. Otherwise BackendVolumes will be added to or removed from the StoragePool submitted here.
Return Codes
none

CreateReplica

Description

This method starts a job to create a new StorageVolume which is a replica of the source StorageVolume. Currently method is unsupported.

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.
VolumeName string
An end user relevant name for the target volume 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 volume.
Job CIM_ConcreteJob
Reference to the job (may be null if job completed).
Incremental boolean
Indicates in case of copy type"UnSyncAssoc"or"UnSyncUnAssoc"that the relationship is incremental.Only available in firmware versions>= 4.2.1.0
GrainSize uint16
The size of the copy grain in case of"UnSyncAssoc"or"UnSynUnAssoc"copy types.Only available in firmware versions>= 4.2.1.0
CleanRate uint16
The cleaning rate in case of"UnSyncAssoc"or"UnSynUnAssoc"copy types.Only available in firmware versions>= 4.2.1.0
IOGroupID string
The iogroup ID or name in case of"UnSyncAssoc"or"UnSynUnAssoc"copy types during cascading.Only available in firmware versions>= 4.2.1.0
SourceElement CIM_LogicalElement
The source storage object which may be a StorageVolume or storage object.
TargetElement CIM_LogicalElement
Reference to the created target storage element (that is, the replica).
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.
CacheMode uint16
The new volume's cache mode. Can be either 0 ("None"), or1 ("Read Write"). Ignored for SVC Clusters running pre v3.1.0 Firmware.
UnitDeviceID uint16
The new volume's Unit Device Identifier as defined by OpenVMS. Ignored for SVC Clusters running pre v4.1.0 Firmware
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 association to the source.UnSyncUnAssoc: Create unassociated copy of the source element.Only"UnSyncAssoc"&"UnsyncUnAssoc"are supported by the SAN Volume Controller.
VirtualizationType uint8
Sets the virtualization type of the new StorageVolume. Default is"striped"which will stripe the data of the volume across all BackendVolumes in the Pool. Other values are"image"and"sequential"which both store the data on a single BackendVolume."Image"allows to map a StorageVolume 1:1 to a BackendVolume without touching the data which is already present on the BackendVolume.
IOGroup IBMTSSVC_IOGroup
Optionally specifies the IOGroup to which the StorageVolume will be assigned.
PreferredNode IBMTSSVC_Node
Optionally specifies the preferred Node for StorageVolume access.
Format boolean
If true the volume will be formatted on creation (and expansion).
Size uint64
As an input parameter this specifies the desired pool size in bytes. As an output parameter this specifies the size achieved.
BackendVolumes IBMTSSVC_BackendVolume
Optionally specifies the BackendVolumes to store the StorageVolume's data on.
Goal CIM_StorageSetting
If submitted, Goal must be the SVC default setting.
InPool IBMTSSVC_ConcreteStoragePool
The StoragePool from which the new StorageVolume will be allocated. Mutually exclusive with"TheElement".
TheElement IBMTSSVC_StorageVolume
Contains the StorageVolume to be modified. If"TheElement"is NULL a new StorageVolume will be created. Mutually exclusive with"InPool".
Synchronized boolean
Indicates in case of copy type"Sync"that source and target already contain identical data.
BackgroundCopyRate uint16
The background copy rate in case of"UnSyncAssoc"copy types. The default 50.
Set IBMTSSVC_SynchronizedSet
The set the synchronization will be added to. This is an optional parameter.
out
Job CIM_ConcreteJob
Reference to the job (may be null if job completed).
TargetElement CIM_LogicalElement
Reference to the created target storage element (that is, the replica).
Size uint64
As an input parameter this specifies the desired pool size in bytes. As an output parameter this specifies the size achieved.
TheElement IBMTSSVC_StorageVolume
Contains the StorageVolume to be modified. If"TheElement"is NULL a new StorageVolume will be created. Mutually exclusive with"InPool".
Return Codes
none

CreateSynchronizedSet

Description

Method to create a SynchronizedSet. Some devices may not support SynchronizedSets. In order to find out if SynchronizedSets are supportedcall GetSupportedSetTypes.

Parameters

IdTypeRangeDescription
In
CopyType uint16
Provide one of the valid copy types. If the copytype is for a remote set, the set will be createdas being empty and will return with a 0x8000 copytypeproperty value. Copy Type 5 (auto deleting fccg) is only supported in cluster version 4.3.0 and above).
ElementName string
The ElementName property of the SynchronizedSet that will be created. See SynchronizedSet.ElementName
RemoteCluster IBMTSSVC_RemoteCluster
Optionally specifies a RemoteCluster if this Set is supposed to aggregate StorageSynchronized between Volumes of two SVC clusters.
Set IBMTSSVC_SynchronizedSet
The SynchronizedSet that was created.
out
Set IBMTSSVC_SynchronizedSet
The SynchronizedSet that was created.
Return Codes
none

DeleteStoragePool

Description

This method will delete a StoragePool. The StoragePool must not have any StorageVolumes or BackendVolume assigned or the method will fail.

Parameters

IdTypeRangeDescription
In
Force boolean
If true the deletion is forced.
Job CIM_ConcreteJob
The Job will always be NULL
Pool IBMTSSVC_ConcreteStoragePool
The StoragePool to delete.
out
Job CIM_ConcreteJob
The Job will always be NULL
Return Codes
none

DeleteSynchronizedSet

Description

Method to delete a SynchronizedSet. If the set contains StorageSynchronized associations they have to be removed from this set before this method is called by calling: ModifySynchronizedSet('Remove').

Parameters

IdTypeRangeDescription
In
Set IBMTSSVC_SynchronizedSet
The set that will be deleted.
Force boolean
If true the deletion is forced.
out
none
Return Codes
none

GetDependentCascadingNames

Description

Get the names of the dependent cascading mappings for the given volume. Only supported for clusters running SVC Firmware version>= 4.2.1

Parameters

IdTypeRangeDescription
In
Volume IBMTSSVC_StorageVolume
Get the dependent cascading mappings for this StorageVolume
CascadingNames string
The names of the dependent cascading mappings wil be returned in this array.
out
CascadingNames string
The names of the dependent cascading mappings wil be returned in this array.
Return Codes
none

GetDependentMappingNames

Description

Get the names of the dependent mappings for the given FCMap. Only supported for clusters running SVC Firmware version>= 4.2.0

Parameters

IdTypeRangeDescription
In
Mapping IBMTSSVC_LocalStorageSynchronized
Get the dependent mappings for this FCMap
Dependentnames string
The names of the dependent mappings wil be returned in this array.
out
Dependentnames string
The names of the dependent mappings wil be returned in this array.
Return Codes
none

GetVdiskCandidatesView

Description

Vendor extension to get a list of candidate VDisks for a given VDisk

Parameters

IdTypeRangeDescription
In
TheVolume IBMTSSVC_StorageVolume
The source volume
RemoteClusterName string
If looking for candidates from another cluster put that cluster name or ID here
CandidateNames string
The Names of the COPS of StorageVolume Candiate.
CandidateVolumes IBMTSSVC_CandidateVolume
The Reference to the potential StorageVolume Candiate.
out
CandidateNames string
The Names of the COPS of StorageVolume Candiate.
CandidateVolumes IBMTSSVC_CandidateVolume
The Reference to the potential StorageVolume Candiate.
Return Codes
none

IncludeBackendVolume

Description

This method is used to reinclude a BackendVolume which has been expelled by the cluster.

Parameters

IdTypeRangeDescription
In
Volume IBMTSSVC_BackendVolume
The BackendVolume to include.
out
none
Return Codes
none

MigrateVDiskExtents

Description

Migrate VDisk extents from one MDisk to another MDisk

Parameters

IdTypeRangeDescription
In
TheVDisk IBMTSSVC_StorageVolume
Extents allocated by this VDisk will be migrated
SourceMDisk IBMTSSVC_BackendVolume
Extents will be migrated OFF of this MDisk
TargetMDisk IBMTSSVC_BackendVolume
Extents will be migrated ONTO thisMDisk
NumberOfExtents uint32
The number of extents to be migrated
NumberOfThreads uint32
Optionally specifies the number of threads to use for the migration. The valid range is from 1 to 4 and the default is 4 threads.
CopyID uint32
VDisk copy id
Job IBMTSSVC_Job
Returns the ref of the asyncronous IBMTSSVC_MigrateVolumeJob that was initiated via this command.
out
Job IBMTSSVC_Job
Returns the ref of the asyncronous IBMTSSVC_MigrateVolumeJob that was initiated via this command.
Return Codes
none

MigrateVolume

Description

This method migrates a StorageVolume from one StoragePool to another.

Parameters

IdTypeRangeDescription
In
NumberOfThreads uint8
The number of threads to use for the migration process.
TargetPool IBMTSSVC_ConcreteStoragePool
The StoragePool to migrate to.
Volume IBMTSSVC_StorageVolume
The StorageVolume to migrate.
CopyID uint32
VDisk copy id
Job IBMTSSVC_Job
The job instance which can be used to monitor the migration process.
out
Job IBMTSSVC_Job
The job instance which can be used to monitor the migration process.
Return Codes
none

MigrateVolumeToImageMode

Description

This method migrates a StorageVolume to an image mode that maps 1-to-1 with a BackendVolume.

Parameters

IdTypeRangeDescription
In
NumberOfThreads uint8
The number of threads to use for the migration process.
TargetPool IBMTSSVC_ConcreteStoragePool
The StoragePool the target volume will become member of.
TargetVolume IBMTSSVC_BackendVolume
The BackendVolume to migrate to.
Volume IBMTSSVC_StorageVolume
The StorageVolume to migrate.
CopyID uint32
VDisk copy id
Job IBMTSSVC_Job
The job instance which can be used to monitor the migration process.
out
Job IBMTSSVC_Job
The job instance which can be used to monitor the migration process.
Return Codes
none

ModifySynchronization

Description

This method modifies a synchronization according to the operation that was passed in. If 0 is returned, the function completed successfully and no ConcreteJob instance was created. If 0x1000 is returned, a ConcreteJob was started. A reference to this Job is returned in the Job output parameter. The SAN Volume Controller does not allow modification of StorageSynchronized that are part of a ConsistencySet. In this case the error code 6 is returned.

Parameters

IdTypeRangeDescription
In
Direction boolean
If true the master (SyncedSystemElement) will become source, if false the auxillary (SyncedElement) will become source. Applies only on switch&resync of sync and async copy.If Direction is not set on a switch operation the default action will beto change the current primary to its opposite.
AllowAccess boolean
If true the target will be accessible for I/O. Only applies on fracture of sync copies.
Clean boolean
If true the target is assumed to be clean (initialized with zeros), so no initialize will be done before a resync of a sync copy.
Force boolean
If set to true the operation will be forced. Applies only to detach and resync operations. In the case ofResync operation the force flag causes a prepare to occurprior to the Resync.
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. 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 replica. This will negate the action of a previous Fracture operation.Restore from Replica: Renew the contents of the original storageobject 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.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.Unquiesce: Take the link from the quiesced state (without running the intended operation.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).
Job CIM_ConcreteJob
Reference to the job (may be null if the task completed).
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

ModifySynchronizedSet

Description

Method to manipulate SynchronizedSets.

Parameters

IdTypeRangeDescription
In
Operation uint16
Operation describes the type of modification to be made to the SynchronizedSet. Values are:Add: Add the passed StorageElement to the set.Remove: Remove the passed StorageElement from the set.DeleteSynchronizations: All StorageSynchronized associations in this SynchronizedSet are deleted.Fracture Replicas: Suspend the synchronizationw between all storage objects in the set. The associations 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 Replicas: Re-establish the synchronizations of all replicas in the set. If CopyType is Sync or Async, this will negate the action of a previous Fracture operation.Restore from Replica: Renew the contents of the original storage objects from tbe replicas.Prepare All: Prepare the participating volumes for a point in time copy.Switch: All relationships in the set will be switched. When a RCCG is empty the CopyType willbe 0x8000, when the first RC is added to the RCCG the CopyTypewill change to 2 or 3 depending on the type of RC, when thelast RC is removed from the RCCG the CopyType will revert to0x8000. Because CopyType is a key this will mean that thecurrent reference to the RCCG may change during add/delete.
Job IBMTSSVC_Job
Reference to the job (may be null if job completed).
SynchronizedSet IBMTSSVC_SynchronizedSet
The reference to the SynchronizedSet describing the set to be modified.
Synchronization IBMTSSVC_StorageSynchronized
The storage object being added or removed.
Force boolean
Force the modification when needed.If Force is true during a RESYNC attempt the set willbe prepared first, and then resynced.
Clean boolean
If true the target is assumed to be clean (initialized with zeros), so no initialize will be done before a resync of a sync copy.
Direction boolean
If true the master (SyncedSystemElement) will become source, if false the auxillary (SyncedElement) will become source. Applies only on switch of sync copy.
AllowAccess boolean
If true the target will be accessible for I/O. Only applies on fracture of sync copies.
out
Job IBMTSSVC_Job
Reference to the job (may be null if job completed).
SynchronizedSet IBMTSSVC_SynchronizedSet
The reference to the SynchronizedSet describing the set to be modified.
Return Codes
none

RecoverVDisk

Description

Requests recovery of a vdisk.

Parameters

IdTypeRangeDescription
In
TheElement IBMTSSVC_StorageVolume
The VDisk to recover
out
VdiskName string
Vdisk being recovered.
CacheState uint16
Vdisk recovery status.
State uint16
Vdisk state.
IsSpaceEfficient boolean
Indicates if any mirror extent is space efficient.
CopyCount uint32
Number of copies.
Return Codes
none

RecoverVDiskByCluster

Description

Requests recovery of all vdisks within a cluster.

Parameters

IdTypeRangeDescription
In
none
out
StorageVolume IBMTSSVC_StorageVolume
Reference to the recovered vdisks.
VdiskNames string
List of vdisks being recovered.
CacheState uint16
Vdisk recovery status.
State uint16
Vdisk state.
IsSpaceEfficient boolean
Indicates if any mirror extent is space efficient.
CopyCount uint32
Number of copies.
Return Codes
none

RecoverVDiskByIOGroup

Description

Requests recovery of all vdisks within an IO group.

Parameters

IdTypeRangeDescription
In
IOGroup IBMTSSVC_IOGroup
The IO group to recover the vdisks.
out
StorageVolume IBMTSSVC_StorageVolume
Reference to the recovered vdisks.
VdiskNames string
List of vdisks being recovered.
CacheState uint16
Vdisk recovery status.
State uint16
Vdisk state.
IsSpaceEfficient boolean
Indicates if any mirror extent is space efficient.
CopyCount uint32
Number of copies.
Return Codes
none

RepairSpaceEfficientCopy

Description

Requests validating and repairing Space-Efficient metadata.

Parameters

IdTypeRangeDescription
In
TheElement IBMTSSVC_StorageVolume
The VDisk
CopyID uint32
Optionally specifies which copy to repair
out
none
Return Codes
none

RepairVdiskCopy

Description

Verifies that the data on synchronized VDisk copies is indeed identical. It should only be necessary to use this command in rare situations when one is concerned that VDisk copies are not properly synchronized. Note that despite the name this command operates on a VDisk, not a VDisk copy, since it operates by comparing the data on the copies.

Parameters

IdTypeRangeDescription
In
TheElement IBMTSSVC_StorageVolume
The VDisk to validate / repair.
RepairType uint8
Specifies what sort of repair to perform: Validate: does not change any data on the VDisk copies. Simply reports if the copies are identical.Medium: converts sectors which are different to virtual medium errors. Resync: corrects sectors which are different by copying from the primary VDisk copy.
StartLBA uint64
Optionally specifies an LBA value at which to start the repair process.
Job CIM_ConcreteJob
Job for tracking progress of asynchonous repair
out
Job CIM_ConcreteJob
Job for tracking progress of asynchonous repair
Return Codes
none

RequestDiscovery

Description

Invoking this method causes the cluster to scan the Fibre Channel in order to discover new BackendVolumes.

Parameters

IdTypeRangeDescription
In
WaitTimeout uint32
For cluster code levels>= v4.1.0.0, this parameter controls how long the method will wait for discovery to complete.If WaitForResults is true and WaitTimeout is>0, the method will wait this many seconds for discovery to complete. If discoverydoes not complete in this amount of time, the return code will be'Discovery Timeout'and the output parameters may not contain valid information.
WaitForResults boolean
For clusters running code levels before v4.1.0.0, this method waits for discovery for a predetermined amount of time. Forcode levels>= v4.1.0.0, this flag controls how this method waits for discovery. If the flag is true, this method will not returnuntil the entire discovery process has completed. If false, this method will return immediately and theoutput parameters may not contain valid information. If this parameter is missing, it will behave as if true were passed.
DiscoveredElementNames string
The names of the discovered BackendVolumes.
DiscoveredElementCount uint32
The number of BackendVolumes discovered.
DiscoveredElements string
The COPs of the discovered BackendVolumes.
out
DiscoveredElementNames string
The names of the discovered BackendVolumes.
DiscoveredElementCount uint32
The number of BackendVolumes discovered.
DiscoveredElements string
The COPs of the discovered BackendVolumes.
Return Codes
none

ReturnToStoragePool

Description

This method will delelte a StorageVolume. The StorageVolume must not have any access granted to hosts, otherwise the method will fail.

Parameters

IdTypeRangeDescription
In
Force boolean
If true the deletion is forced.
Job CIM_ConcreteJob
The Job will always be NULL
TheElement IBMTSSVC_StorageVolume
The StorageVolume to delete.
out
Job CIM_ConcreteJob
The Job will always be NULL
Return Codes
none

RmVdiskCopy

Description

Deletes a VDisk copy. Will fail if deleting the VDisk copy would not leave any synchronized copies left.

Parameters

IdTypeRangeDescription
In
TheElement IBMTSSVC_StorageVolume
The VDisk
CopyID uint32
Copy id
Force boolean
Only used if the VDisk copy is an image mode copy. Needed in four situations: 1. Cache flush fails.2. Vdisk copy is not synchronized.3. Migrate to image mode is still in progress.4. Virtual medium errors exist on the copy.
out
none
Return Codes
none

SetIOGroup

Description

This method is used to assign a StorageVolume to another IOGroup. A StorageVolume which is a member of a copy relationship cannot be moved to another IO Group even with the use of the force flag

Parameters

IdTypeRangeDescription
In
Force boolean
Required to be true when intended to move a Volume to/from the recovery IO group.
Group IBMTSSVC_IOGroup
The IOGroup to assign the StorageVolume to.
Volume IBMTSSVC_StorageVolume
The StorageVolume to move.
Node IBMTSSVC_Node
Optionally sets the preferred Node of the storage volume in the changed IOGroup. Only available on clusters running firmware>= 4.2.1
out
none
Return Codes
none

SetQuorum

Description

This method is used to set a BackendVolume as quorum disk.

Parameters

IdTypeRangeDescription
In
QuorumID uint8
The quorum ID (0, 1 or 2).
Volume IBMTSSVC_BackendVolume
The BackendVolume to become a quorum.
out
none
Return Codes
none

SetThrottle

Description

This method is used to set IO governing rates for the Virtual Disk. This places a cap on the amount of IO that will be acceptedfor the Virtual Disk. The default units are IO/S, but can be set to MB/s with the use of the mbps flag

Parameters

IdTypeRangeDescription
In
MBps boolean
Optionally sets the units of the action to MB/s from IO/s
ThrottleRate uint64
The throttling rate
Volume IBMTSSVC_StorageVolume
The StorageVolume to alter.
out
none
Return Codes
none

SplitVdiskCopy

Description

Allows one to split a VDisk copy from its current VDisk tocreate a new, independent VDisk. The copy is deleted from the old VDisk and a new vdisk created.

Parameters

IdTypeRangeDescription
In
TheElement IBMTSSVC_StorageVolume
The VDisk that you want to split a copy off.
CopyID uint32
The copy to be split off.
IOGroup IBMTSSVC_IOGroup
The IO group for the new VDisk. Defaults to the same IO group as the original VDisk.
PreferredNode IBMTSSVC_Node
Preferred node for new VDisk.
ElementName string
Name for new VDisk.
CacheMode uint16
Cache mode for new VDisk.
UnitDeviceID uint16
Unit device ID for new VDisk. As defined by OpenVMS. Ignored by SVC clusters running pre v4.1.0 firmware.
Force boolean
Copy cannot be split off if it is not synchronized. Setting force = true will ignore the synchonization state and split the copy off anyway.
out
none
Return Codes
none