IndexTree
SubclassesReferenced ByPropertiesMethods

IBMTSESS_AsyncPPRCService

Superclasses

Subclasses

none

Referenced By

none

Description

It is used to support Asynchronous PPRC, ESS ICAT provides the following class and methods.

Properties

IdTypeRangeDescription
Keys
SystemCreationClassNamestringMax = 256The scoping System's CreationClassName.  
SystemNamestringMax = 256The scoping System's Name.  
CreationClassNamestringMax = 256CreationClassName indicates the name of the class or the subclass 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.  
NamestringMax = 256The 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 object's Description property.  
Writeable
PrimaryOwnerNamestringMax = 64The name of the primary owner for the service, if one is defined. The primary owner is the initial support contact for the Service.  
PrimaryOwnerContactstringMax = 256A string that provides information on how the primary owner of the Service can be reached (e.g. phone number, email address, ...).  
EnabledDefaultuint16Enabled
Disabled
Not Applicable
Enabled but Offline
No Default
DMTF Reserved
Vendor Reserved
An enumerated value indicating an administrator's default/startup configuration for an element's Enabled State. By default, the element is \"Enabled\" (value=2).  
Read only
StartModestringAutomatic
Manual
StartMode is a string value indicating whether the Service is automatically started by a System, Operating System, etc. or only started upon request. This property is deprecated in lieu of the EnabledDefault property inherited from EnabledLogicalElement, which addresses the same semantics. The change to a uint16 data type was discussed when CIM V2.0 was defined. However, existing V1.0 implementations used the string property and did not want to modify their code. Therefore, StartMode was grandfathered into the Schema. Use of the Deprecated qualifier allows the maintenance of the existing property, but also permits an improved, clarified definition using EnabledDefault.  
Startedboolean-Started is a boolean indicating whether the Service has been started (TRUE), or stopped (FALSE).  
EnabledStateuint16Unknown
Other
Enabled
Disabled
Shutting Down
Not Applicable
Enabled but Offline
In Test
Deferred
Quiesce
Starting
DMTF Reserved
Vendor Reserved
EnabledState is an integer enumeration that indicates the enabled/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/disabled states: \nEnabled (2) indicates that the element is/could be executing commands, will process any queued commands, and queues new requests. \nDisabled (3) indicates that the element will not execute commands and will drop any new requests. \nShutting Down (4) indicates that the element is in the process of going to a Disabled state. \nNot Applicable (5) indicates the element doesn't support being enabled/disabled. \nEnabled but Offline (6) indicates that the element may be completing commands, and will drop any new requests. \nTest (7) indicates that the element is in a test state. \nDeferred (8) indicates that the element may be completing commands, but will queue any new requests. \nQuiesce (9) indicates that the element is enabled but in a restricted mode. The element's behavior is similar to the Enabled state, but it only processes a restricted set of commands. All other requests are queued. \nStarting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued.  
OtherEnabledStatestring-A string describing the element's enabled/disabled state when the EnabledState property is set to 1 (\"Other\"). This property MUST be set to NULL when EnabledState is any value other than 1.  
RequestedStateuint16Enabled
Disabled
Shut Down
No Change
Offline
Test
Deferred
Quiesce
Reboot
Reset
DMTF Reserved
Vendor Reserved
RequestedState is an integer enumeration indicating 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/disabled states. Note that when EnabledState is set to 5 (\"Not Applicable\"), then this property has no meaning. By default, the element's RequestedState is 5 (\"No Change\"). Refer to the EnabledState's property Description for explanations of the values in the RequestedState enumeration. \n\nIt 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). The former, Reboot, refers to doing a \"Shut Down\" and then moving to an \"Enabled\" state. The latter, Reset, indicates that the element is first \"Disabled\" and then \"Enabled\". The distinction between requesting \"Shut Down\" and \"Disabled\" should also be noted. The former, Shut Down, requests an orderly transition to the Disabled state, and MAY involve removing power, to completely erase any existing state. The latter, the Disabled state, requests an immediate disabling of the element, such that it will not execute or accept any commands or processing requests. \n\nThis property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or may be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, since it allows an explicit invocation of the operation and the return of a result code.  
TimeOfLastStateChangedatetime-The date/time when the element's EnabledState last changed. If the state of the element has not changed and this property is populated, then it MUST be set to a 0 interval value. If a state change was requested, but rejected or not yet processed, the property MUST NOT be updated.  
InstallDatedatetime-A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.  
OperationalStatusuint16[ ]Unknown
Other
OK
Degraded
Stressed
Predictive Failure
Error
Non-Recoverable Error
Starting
Stopping
Stopped
In Service
No Contact
Lost Communication
Aborted
Dormant
Supporting Entity in Error
Completed
Power Mode
DMTF Reserved
Vendor Reserved
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. \n\"Stressed\" indicates that the element is functioning, but needs attention. Examples of \"Stressed\" states are overload, overheated, etc. \n\"Predictive Failure\" indicates that an element is functioning nominally but predicting a failure in the near future. \n\"In Service\" describes an element being configured, maintained, cleaned, or otherwise administered. \n\"No Contact\" indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it. \n\"Lost Communication\" indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable. \n\"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. \n\"Dormant\" indicates that the element is inactive or quiesced. \n\"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. \n\"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 would imply the operation finished, but did not complete OK or report an error. \n\"Power Mode\" indicates the element has additional power model information contained in the Associated PowerManagementService association. \nOperationalStatus 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, it is strongly RECOMMENDED that providers/instrumentation provide BOTH the Status and OperationalStatus properties. Further, the first value of OperationalStatus SHOULD contain the primary status for the element. When instrumented, Status (since it is single-valued) SHOULD also provide the primary status of the element.  
StatusDescriptionsstring[ ]-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. Note that entries in this array are correlated with those at the same array index in OperationalStatus.  
StatusstringOK
Error
Degraded
Unknown
Pred Fail
Starting
Stopping
Service
Stressed
NonRecover
No Contact
Lost Comm
Stopped
A string indicating the current status of the object. Various operational and non-operational statuses are defined. This property is deprecated in lieu of OperationalStatus, which includes the same semantics in its enumeration. This change is made for 3 reasons: 1) Status is more correctly defined as an array. This overcomes the limitation of describing status via a single value, when it is really a multi-valued property (for example, an element may be OK AND Stopped. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. And, 3) The change to a uint16 data type was discussed when CIM V2.0 was defined. However, existing V1.0 implementations used the string property and did not want to modify their code. Therefore, Status was grandfathered into the Schema. Use of the Deprecated qualifier allows the maintenance of the existing property, but also permits an improved definition using OperationalStatus.  
CaptionstringMax = 64The Caption property is a short textual description (one- line string) of the object.  
Descriptionstring-The Description property provides a textual description of the object.  
ElementNamestring-A user-friendly name for the object. This property allows each instance to define a user-friendly name IN ADDITION TO its key properties/identity data, and description information. \nNote that ManagedSystemElement's Name property is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information MAY be present in both the Name and ElementName properties.  

Method Summary

NameDescription
ManageSessionThe method creates or destroys a session, which constitutes a group of volumes, all belonging to a specified LSS, have some consistency correlation.
ManageSessionVolumeThe method adds or removes the specified volumes to or from a session.
ManageAsyncPPRCThe method manages an ESS Asynchronous PPRC copy relationship, based on specified operation.
QueryXDCIncrementStatusThe method retrieves information about Extended Distance Consistency's Consistency Group and Flash Copy status.
QueryXDCOutOfSyncStatusThe method retrieves information about Extended Distance Consistency's Out-of-Sync Tracks.
QueryXDCSessionsAndDevicesThe method retrieves information about Extended Distance Consistency's sessions and volumes.
QueryAsyncPPRCStatusThe method retrieves information about Asynchronous PPRC.
CreateOrModifyStoragePoolStarts a job to create (or modify) a StoragePool.
CreateOrModifyElementFromStoragePoolStart a job to create (or modify) a specified element (for example a StorageVolume or StorageExtent) from a StoragePool.
DeleteStoragePoolStart a job to delete a StoragePool.
ReturnToStoragePoolStart a job to delete an element previously created from a StoragePool.
CreateReplicaStart a job to create a new storage object which is a replica of the specified source storage object.
ModifySynchronizationModify (or start a job to modify) the synchronization association between two storage objects.
ModifyConsistencySetMethod to manipulate ConsistencySets.
CreateSynchronizationMethod to create a StorageSynchronized association.
DeleteSynchronizationMethod to delete a StorageSynchronized association.
CreateConsistencySetMethod to create a ConsistencySet.
DeleteConsistencySetMethod to delete a ConsistencySet.
CreateSynchronizedSetMethod to create a SynchronizedSet.
DeleteSynchronizedSetMethod to delete a SynchronizedSet.
ModifySynchronizedSetMethod to manipulate SynchronizedSets.
GetSupportedSetTypesThis method returns the types of sets that are supported by the device.
AttachReplicaCreate (or start a job to create) a StorageSynchronized relationship between two existing storage objects.
StartServiceThe StartService method places the Service in the started state.
StopServiceThe StopService method places the Service in the stopped state.
RequestStateChangeRequests that the element's state be changed to the value specified in the RequestedState parameter.

Method Detail


ManageSession

StaticThe method creates or destroys a session, which constitutes a group of volumes, all belonging to a specified LSS, have some consistency correlation.

Parameters

IdTypeRangeDescription
In
SessionNumberuint16-Session number in decimal (1-255)  
SessionTypestring-Session type in hexadecimal , for example, 0x40 for XDC session, 0x30 for Flash Copy session, 0x20 for PPRC session, 0x10 for XRC session  
LSSstring-LSS for the session, in format ESSID:LSSID:SSID where ESSID is of format like 2105.FA120 LSSID is 1 or 2 byte hexadecimal LSS number SSID is 1 or 2 byte hexadecimal SS ID (empty string if undefined)  
Operationuint16Open
Close
Type of operation - open or close session  
Return CodesId
Job Completed with No Error0
Not Supported1
Unknown2
Timeout3
Failed4
Invalid Parameter5
In Use6
DMTF Reserved..
Method Parameters Checked - Job Started4096
Size Not Supported4097
Method Reserved4098..32767
Vendor Specific32768..65535

ManageSessionVolume

StaticThe method adds or removes the specified volumes to or from a session.

Parameters

IdTypeRangeDescription
In
SessionNumberuint16-Session number in decimal (1-255)  
SessionTypestring-Session type in hexadecimal , for example, 0x40 for XDC session, 0x30 for Flash Copy session, 0x20 for PPRC session, 0x10 for XRC session  
LSSstring-LSS for the session, in format ESSID:LSSID:SSID where ESSID is of format like 2105.FA120 LSSID is 1 or 2 byte hexadecimal LSS number SSID is 1 or 2 byte hexadecimal SS ID (empty string if undefined)  
Operationuint16Add
Remove
Type of operation - add or remove volume to/from session  
Return CodesId
Job Completed with No Error0
Not Supported1
Unknown2
Timeout3
Failed4
Invalid Parameter5
In Use6
DMTF Reserved..
Method Parameters Checked - Job Started4096
Size Not Supported4097
Method Reserved4098..32767
Vendor Specific32768..65535

ManageAsyncPPRC

StaticThe method manages an ESS Asynchronous PPRC copy relationship, based on specified operation.

Parameters

IdTypeRangeDescription
In
SessionNumberuint16-Session number in decimal (1-255)  
SessionTypestring-Session type in hexadecimal , for example, 0x40 for XDC session, 0x30 for Flash Copy session, 0x20 for PPRC session, 0x10 for XRC session  
MasterLSSstring-Master LSS ID, of format ESSID:LSSID:SSID, like 2105.FA120:15:FF21  
Operationuint16Start
Pause
Resume
Terminate
ForceTerminate
Operation type  
ConsistencyGroupIntervaluint16-Interval (in seconds) between ConsistencyGroup formation Required for Start, Optional for Resume, Ignored for Pause, Terminate  
MaxXDCCoordinationTimeuint16-Maximum time (in milliseconds) allowed for master to coordinate slaves to form Consistency Group, Default 50 msec. Required for Start, Optional for Resume, Ignored for Pause, Terminate  
MaxConsistencyGroupDrainuint16-Maximum time (in minutes) allowed to drain Out-Of-Sync data to B volumes, Default 4 minutes Required for Start, Optional for Resume, Ignored for Pause, Terminate  
Return CodesId
Job Completed with No Error0
Not Supported1
Unknown2
Timeout3
Failed4
Invalid Parameter5
In Use6
DMTF Reserved..
Method Parameters Checked - Job Started4096
Size Not Supported4097
Method Reserved4098..32767
Vendor Specific32768..65535

QueryXDCIncrementStatus

StaticThe method retrieves information about Extended Distance Consistency's Consistency Group and Flash Copy status. The scope can be one LSS.

Parameters

IdTypeRangeDescription
In
SessionNumberuint16-Session number in decimal (1-255)  
SessionTypestring-Session type in hexadecimal , for example,0x40 for XDC session, 0x30 for Flash Copy session, 0x20 for PPRC session, 0x10 for XRC session  
Scopestring-LSSID of format like 2105.FA120:LSSID:SSID  
Return CodesId
Job Completed with No Error0
Not Supported1
Unknown2
Timeout3
Failed4
Invalid Parameter5
In Use6
DMTF Reserved..
Method Parameters Checked - Job Started4096
Size Not Supported4097
Method Reserved4098..32767
Vendor Specific32768..65535

QueryXDCOutOfSyncStatus

StaticThe method retrieves information about Extended Distance Consistency's Out-of-Sync Tracks. The scope can be one LSS.

Parameters

IdTypeRangeDescription
In
SessionNumberuint16-Session number in decimal (1-255)  
SessionTypestring-Session type in hexadecimal , for example, 0x40 for XDC session, 0x30 for Flash Copy session, 0x20 for PPRC session, 0x10 for XRC session  
Scopestring-LSSID of format like 2105.FA120:LSSID:SSID  
Return CodesId
Job Completed with No Error0
Not Supported1
Unknown2
Timeout3
Failed4
Invalid Parameter5
In Use6
DMTF Reserved..
Method Parameters Checked - Job Started4096
Size Not Supported4097
Method Reserved4098..32767
Vendor Specific32768..65535

QueryXDCSessionsAndDevices

StaticThe method retrieves information about Extended Distance Consistency's sessions and volumes. The scope can be one LSS.

Parameters

IdTypeRangeDescription
In
SessionNumberuint16-Session number in decimal (1-255)  
SessionTypestring-Session type in hexadecimal , for example, 0x40 for XDC session, 0x30 for Flash Copy session, 0x20 for PPRC session, 0x10 for XRC session  
Scopestring-LSSID of format like 2105.FA120:LSSID:SSID  
Return CodesId
Job Completed with No Error0
Not Supported1
Unknown2
Timeout3
Failed4
Invalid Parameter5
In Use6
DMTF Reserved..
Method Parameters Checked - Job Started4096
Size Not Supported4097
Method Reserved4098..32767
Vendor Specific32768..65535

QueryAsyncPPRCStatus

StaticThe method retrieves information about Asynchronous PPRC. The scope can be one LSS.

Parameters

IdTypeRangeDescription
In
Scopestring-LSSID of format like 2105.FA120:LSSID:SSID  
Return CodesId
Job Completed with No Error0
Not Supported1
Unknown2
Timeout3
Failed4
Invalid Parameter5
In Use6
DMTF Reserved..
Method Parameters Checked - Job Started4096
Size Not Supported4097
Method Reserved4098..32767
Vendor Specific32768..65535

CreateOrModifyStoragePool

StaticStarts 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
ElementNamestring-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.  
Sizeuint64-As an input parameter this specifies the desired pool size in bytes. As an output parameter this specifies the size achieved.  
Out
Sizeuint64-As an input parameter this specifies the desired pool size in bytes. As an output parameter this specifies the size achieved.  
Return CodesId
Job Completed with No Error0
Not Supported1
Unknown2
Timeout3
Failed4
Invalid Parameter5
In Use6
DMTF Reserved..
Method Parameters Checked - Job Started4096
Size Not Supported4097
Method Reserved4098..32767
Vendor Specific32768..65535

CreateOrModifyElementFromStoragePool

StaticStart 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
ElementNamestring-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.  
ElementTypeuint16Unknown
Reserved
StorageVolume
StorageExtent
DMTF Reserved
Vendor Specific
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.  
Sizeuint64-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.  
Out
Sizeuint64-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.  
Return CodesId
Job Completed with No Error0
Not Supported1
Unknown2
Timeout3
Failed4
Invalid Parameter5
In Use6
DMTF Reserved..
Method Parameters Checked - Job Started4096
Size Not Supported4097
Method Reserved4098..32767
Vendor Specific32768..65535

DeleteStoragePool

StaticStart a job to delete a StoragePool. The freed space is returned source StoragePools (indicated by AllocatedFromStoragePool) 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
Return CodesId
Job Completed with No Error0
Not Supported1
Unknown2
Timeout3
Failed4
Invalid Parameter5
In Use6
DMTF Reserved..
Method Parameters Checked - Job Started4096
Method Reserved4097..32767
Vendor Specific32768..65535

ReturnToStoragePool

StaticStart 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
Return CodesId
Job Completed with No Error0
Not Supported1
Unknown2
Timeout3
Failed4
Invalid Parameter5
In Use6
DMTF Reserved..
Method Parameters Checked - Job Started4096
Method Reserved4097..32767
Vendor Specific32768..65535

CreateReplica

StaticStart 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
ElementNamestring-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.  
CopyTypeuint16Async
Sync
UnSyncAssoc
UnSyncUnAssoc
DMTF Reserved
Vendor Specific
CopyType describes the type of copy that will be made. Values are: \n Async: Create and maintain an asynchronous copy of the source. \n Sync: Create and maintain a synchronized copy of the source. \n UnSyncAssoc: Create an unsynchronized copy and maintain an association to the source. \n UnSyncUnAssoc: Create unassociated copy of the source element.  
Return CodesId
Job Completed with No Error0
Not Supported1
Unknown2
Timeout3
Failed4
Invalid Parameter5
In Use6
DMTF Reserved..
Method Parameters Checked - Job Started4096
Method Reserved4097..32767
Vendor Specific32768..65535

ModifySynchronization

StaticModify (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
Operationuint16DMTF Reserved
DMTF Reserved
Detach
Fracture
Resync Replica
Restore from Replica
Prepare
Unprepare
Quiesce
Unquiesce
Reset To Sync
Reset To Async
DMTF Reserved
Vendor Specific
Operation describes the type of modification to be made to the replica. Values are: \n Detach: 'Forget' the synchronization between two storage objects. Start to treat the objects as independent. \n 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. \n Resync Replica: Re-establish the synchronization of a replica. This will negate the action of a previous Fracture operation. \n Restore from Replica: Renew the contents of the original storage object from a replica. \n 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.\n Unprepare: Clear a prepared state if a Prepare is not to be followed by a Resync operation. \n Quiesce: Some applications require notification so that they can ready the link for an operation. For example flush any cached data or buffered changes.\n Unquiesce: Take the link from the quiesced state (without executing the intended operation.\n Reset To Sync: Change the CopyType of the association to Sync (e.g., from the Async CopyType). \n Reset To Async: Change the CopyType of the association to Async (e.g., from the Sync CopyType).  
Return CodesId
Job Completed with No Error0
Not Supported1
Unspecified Error2
Timeout3
Failed4
Invalid Parameter5
In Use6
DMTF Reserved..
Method Parameters Checked - Job Started0x1000
Method Reserved0x1001..0x7FFF
Vendor Specific0x8000..0xFFFF

ModifyConsistencySet

StaticMethod to manipulate ConsistencySets. Since thereare two types of ConsistencySets the error Wrong Member Typeis thrown when it is attempted to add a volume to aConistencySet whose MemberType is 1 (aggregating StorageSynchrnoizeds)and vice versa (adding StorageSynchrnoizeds to a set with MemberType 0)or invoking a method that operates onStorageSynchrnoized when the ConsistencySet has a MemberTypeof 0 (aggreagating volumes

Parameters

IdTypeRangeDescription
In
Operationuint16DMTF Reserved
DMTF Reserved
Add
Remove
DMTF Reserved
Vendor Specific
Operation describes the type of modification to bemade to the ConsistencySet. Values are: Add: Add the passed StorageElement to the set. Remove: Remove the passed StorageElement from the set.  
Return CodesId
Job Completed with No Error0
Not Supported1
Unknown2
Timeout3
Failed4
Invalid Parameter5
Wrong Member Type6
DMTF Reserved..
Method Parameters Checked - Job Started0x1000
Method Reserved0x1001..0x7777
Vendor Specific0x8000..

CreateSynchronization

StaticMethod to create a StorageSynchronized association. Optionallythis association can be added to a ConsistencySet which has beencreated before. If the device doesn't support aggregating associationsin ConsistencySets it is not permitted to pass in a ConsistencySet.In order to find out what kind of ConsistencySets a device supportscall GetSupportedSetTypes.

Parameters

IdTypeRangeDescription
In
CopyTypeuint16-The copy type of this copy relation. SeeStorageSynchronized.CopyType.  
ElementNamestring-The ElementName property of the StorageSynchronizedto be created.  
Return CodesId
Success0
Not Supported1
Unknown2
Timeout3
Failed4
Invalid Parameter5
CopyType not supported6
ConsistencySets not supported7
SynchronizedSets not supported8
System- and SyncedElement must be volumes if Set is passed in9
DMTF Reserved..
Vendor Specific0x8000..

DeleteSynchronization

StaticMethod to delete a StorageSynchronized association. If thecopy relation is part of a SynchronizedSet it may have to be removedfrom this set before this method is called by calling:ModifySynchronizedSet('Remove'). If there is a copyjob started and not yet finished the association cannot be deleteduntil the job is completed. This method does not delete theconnected volumes.

Parameters

IdTypeRangeDescription
Return CodesId
Success0
Not Supported1
Unknown2
Timeout3
Failed4
Invalid Parameter5
Synchronization is member of SynchronizedSet6
Copy in process7
DMTF Reserved..
Vendor Specific0x8000..

CreateConsistencySet

StaticMethod to create a ConsistencySet. Some devices may not supportConsistencySets. In order to find out if ConsistencySets are supportedcall GetSupportedSetTypes.

Parameters

IdTypeRangeDescription
In
CopyTypeuint16-The copy type for associations in this set. SeeStorageSynchronized.CopyType. This parameter may be optional forsome devices  
ElementNamestring-The ElementName property of the ConsistencySet thatwill be created. See ConsistencySet.ElementName  
Return CodesId
Success0
Not Supported1
Unknown2
Timeout3
Failed4
Invalid Parameter5
CopyType not supported6
ConsistencySets not supported7
DMTF Reserved..
Vendor Specific0x8000..

DeleteConsistencySet

StaticMethod to delete a ConsistencySet.

Parameters

IdTypeRangeDescription
Return CodesId
Success0
Not Supported1
Unknown2
Timeout3
Failed4
Invalid Parameter5
ConsistencySet is not empty6
DMTF Reserved..
Vendor Specific0x8000..

CreateSynchronizedSet

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

Parameters

IdTypeRangeDescription
In
CopyTypeuint16-The copy type for associations in this set. SeeStorageSynchronized.CopyType. This parameter may be optional forsome devices  
ElementNamestring-The ElementName property of the SynchronizedSet thatwill be created. See SynchronizedSet.ElementName  
Return CodesId
Success0
Not Supported1
Unknown2
Timeout3
Failed4
Invalid Parameter5
CopyType not supported6
SynchronizedSets not supported8
DMTF Reserved..
Vendor Specific0x8000..

DeleteSynchronizedSet

StaticMethod to delete a SynchronizedSet. If the set containsStorageSynchronized associations they have to be removedfrom this set before this method is called by calling:ModifySynchronizedSet('Remove').

Parameters

IdTypeRangeDescription
Return CodesId
Success0
Not Supported1
Unknown2
Timeout3
Failed4
Invalid Parameter5
SynchronizedSet is not empty6
DMTF Reserved..
Vendor Specific0x8000..

ModifySynchronizedSet

StaticMethod to manipulate SynchronizedSets.

Parameters

IdTypeRangeDescription
In
Operationuint16DMTF Reserved
DMTF Reserved
Add
Remove
Delete Synchronizations
Fracture Replicas
Resync Replicas
Restore From Replicas
Prepare All
DMTF Reserved
Vendor Specific
Operation describes the type of modification to bemade to the SynchronizedSet. Values are: Add: Add the passed StorageElement to the set. Remove: Remove the passed StorageElement from the set. Delete Synchronizations: All StorageSynchronized associationsin 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. \n 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. \n Restore from Replica: Renew the contents of the original storage objects from tbe replicas. Prepare All: Prepare the participating volumes fora point in time copy.  
Return CodesId
Job Completed with No Error0
Not Supported1
Unknown2
Timeout3
Failed4
Invalid Parameter5
Operatio not supported6
StorageSynchronized not in the Set7
StorageSynchronized already in a Set8
DMTF Reserved..
Method Parameters Checked - Job Started0x1000
Method Reserved0x1001..0x7777
Vendor Specific0x8000..

GetSupportedSetTypes

StaticThis method returns the types of sets that are supported by the device.

Parameters

IdTypeRangeDescription
Return CodesId
Success0
Not Supported1
Unknown2
Timeout3
Failed4
DMTF Reserved..
Vendor Specific0x8000..

AttachReplica

StaticCreate (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 sourceand 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
CopyTypeuint16Async
Sync
UnSyncAssoc
UnSyncUnAssoc
DMTF Reserved
Vendor Specific
CopyType describes the type of Synchronized relationship that will be created. Values are: \n Async: Create and maintain an asynchronous copy of the source. \n Sync: Create and maintain a synchronized copy of the source. \n UnSyncAssoc: Create an unsynchronized copy and maintain an association to the source. \n UnSyncUnAssoc: Create unassociated copy of the source element.  
Return CodesId
Job Completed with No Error0
Not Supported1
Unspecified Error2
Timeout3
Failed4
Invalid Parameter5
In Use6
DMTF Reserved..
Method Parameters Checked - Job Started0x1000
Method Reserved0x1001..0x7FFF
Vendor Specific0x8000..0xFFFF

StartService

StaticThe StartService method places the Service in the started state. Note that this method's function overlaps with the RequestedState property. RequestedState was added to the model to maintain a record (i.e., a persisted value) of the last state request. Invoking the StartService method should set the RequestedState property appropriately. The method returns an integer value of 0 if the Service was successfully started, 1 if the request is not supported and any other number to indicate an error. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' may also be specified in the subclass as a Values array qualifier. \n\nNote that this method overlaps in semantics with the RequestStateChange method inherited from EnabledLogicalElement. This method is maintained since it has been widely implemented, and its simple 'start' semantics are convenient to use.

Parameters

IdTypeRangeDescription
Return CodesId

StopService

StaticThe StopService method places the Service in the stopped state. Note that this method's function overlaps with the RequestedState property. RequestedState was added to the model to maintain a record (i.e., a persisted value) of the last state request. Invoking the StopService method should set the RequestedState property appropriately. The method returns an integer value of 0 if the Service was successfully stopped, 1 if the request is not supported and any other number to indicate an error. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' may also be specified in the subclass as a Values array qualifier. \n\nNote that this method overlaps in semantics with the RequestStateChange method inherited from EnabledLogicalElement. This method is maintained since it has been widely implemented, and its simple 'stop' semantics are convenient to use.

Parameters

IdTypeRangeDescription
Return CodesId

RequestStateChange

StaticRequests that the element's state be changed to the value specified in the RequestedState parameter. When the requested state change takes place, the element's EnabledState and RequestedState will be the same. Invoking the RequestStateChange method multiple times could result in earlier requests being overwritten/lost. \nIf 0 is returned, then the task completed successfully and the use of ConcreteJob was not required. If 4096 (0x1000) is returned, then the task will take some time to complete, ConcreteJob will be created, and its reference returned in the output parameter Job. Any other return code indicates an error condition.

Parameters

IdTypeRangeDescription
In
RequestedStateuint16Enabled
Disabled
Shut Down
Offline
Test
Defer
Quiesce
Reboot
Reset
DMTF Reserved
Vendor Reserved
The state requested for the element. This information will be placed into the instance's RequestedState property if the RequestStateChange method's return code is 0, 3, or 4096 (0x1000) - 'Completed with No Error', 'Timeout', or 'Job Started' respectively. Refer to the description of the EnabledState and RequestedState properties for the detailed meanings of the RequestedState values.  
TimeoutPerioddatetime-A timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format MUST be used to specify the TimeoutPeriod. A value of 0 or a null parameter indicates that the client has no time requirements for the transition. \nIf this property does not contain 0 or null and the implementation doesn't support this parameter. A return code of 'Use Of Timeout Parameter Not Supported' MUST be returned.  
Return CodesId
Completed with No Error0
Not Supported1
Unknown/Unspecified Error2
Can NOT complete within Timeout Period3
Failed4
Invalid Parameter5
In Use6
DMTF Reserved..
Method Parameters Checked - Job Started4096
Invalid State Transition4097
Use of Timeout Parameter Not Supported4098
Busy4099
Method Reserved4100..32767
Vendor Specific32768..65535