ModifyListSynchronization method of the MSISCSITARGET_ReplicationService class

Modifies an array of synchronization associations between two storage objects or replication groups.

This method is inherited from the CIM_ReplicationService class.

Syntax

uint32 ModifyListSynchronization(
  [in]           uint16                      Operation,
  [in]           CIM_Synchronized Ref        Synchronization[],
  [in, optional] string                      ReplicationSettingData,
  [out]          CIM_ConcreteJob Ref         Job,
  [out]          CIM_SettingsDefineState Ref SettingsState[],
  [in]           boolean                     Force,
  [in, optional] uint16                      WaitForCopyState
);

Parameters

Operation [in]

Specifies the type of modification to be made to the replica and the related associations. Required.

Abort (2)

Aborts a copy operation if possible.

DMTF Reserved (3)

Activate (4)

Activates an inactive or prepared CIM_Synchronized association.

DMTF Reserved

Deactivate (7)

Stops the data flow. Write operations to the source element are not copied to the target. For snapshot replications, write operations to the target are lost because the pointers to changed data are deleted.

Detach (8)

Ends the synchronization between two storage objects. Starts to treat the objects as independent.

Dissolve (9)

Dissolves the synchronization between two storage objects. The target element continues to exist.

Failover (10)

Reverses the direction of the synchronization. Use the target element as the source element.

Failback (11)

Reverses the effect of a Failover.

Fracture (12)

Suspends the synchronization between two storage objects that use mirror or snapshot replication. The association and, typically, the changes are saved for fast re-synchronization. This value can be used during a backup cycle to copy one of the objects while the other object remains in production.

DMTF Reserved (13)

Reserved.

Resync Replica (14)

Re-establishes the synchronization. This negates the action of a previous Fracture/Split operation, re-creates a point-in-time image for a snapshot or a clone replication, or restarts a Broken or Aborted synchronization relationship.

Restore from Replica (15)

Renews the contents of the original storage object from a replica.

Resume (16)

Continues the copy operation of a suspended association.

Reset To Sync (17)

Changes the Mode of the copy operations to Synchronous.

Reset To Async (18)

Changes the Mode of the copy operations to Asynchronous.

Return To ResourcePool (19)

Dissolves a snapshot and returns its space to the storage pool.

Reverse Roles (20)

Makes the source element the target element and vise versa.

Split (21)

Suspends the synchronization between two storage objects like the Fracture operation; however, steps are taken to ensure the target elements are consistent. For example, stop I/O to the source elements, wait for in-transit copy operations between source and target elements to stop, then split the source and target elements.

Suspend (22)

Stops the background copy that was previously started.

Unprepare (23)

Reinitializes the synchronization.

DMTF Reserved

Reserved.

Vendor Specific

Reserved.

Synchronization [in]

Specifies the replication associations on which to perform the operation. Required.

All elements of this array must be the same concrete class, for example CIM_StorageSynchronized or CIM_GroupSynchronized, and must have the same SyncType and Mode properties. The Operation parameter must be valid for the ReplicationType, SyncType, Mode properties, and whether it is local or remote.

ReplicationSettingData [in, optional]

If provided, specifies the replication setting data for the given SyncType parameter in the form of an embedded CIM_ReplicationSettingData instance. If not provided, the management server uses the default replication setting data. Optional.

Job [out]

On return, contains a reference to the job, which can be NULL, if the job is completed.

SettingsState [out]

On return, contains references to the associations between the source element and a synchronization aspect instance. This parameter applies to operations such as Dissolve, which dissolves the synchronized relationship, but causes the CIM_SettingDefineState association to be created.

Force [in]

Specifies how to handle operations that might cause an inconsistency among the target elements. If set to True, the client is not warned and the operation is performed.

WaitForCopyState [in, optional]

Specifies the CopyState value that must be reached before this method returns. Only a subset of valid values applies.

For example.

• Initialized: Associations have been established, but there is no data flow.
• Inactive: Initialization is complete, but the data flow remains idle until it is activated.
• Synchronized: Replicas are an exact copy of the source.
• UnSynchronized: Copy operation is in progress.

Return value

This method returns one of the following values.

Completed with No Error (0)

Not Supported (1)

Unspecified Error (2)

Timeout (3)

Failed (4)

Invalid Parameter (5)

In Use (6)

DMTF Reserved (7 4095)

Method Parameters Checked - Job Started (4096)

Method Reserved (4097 0x7FFF)

Vendor Specific (0x8000 = value )

Requirements

Minimum supported client	None supported
Minimum supported server	Windows Server 2012 R2
Namespace	Root\CIMv2\Storage\iScsiTarget
MOF	SmIscsiTarget.mof
DLL	SmIScsiTargetProv.dll

See also

MSISCSITARGET_ReplicationService