Share via

ModifyReplicaSynchronization method of the MSISCSITARGET_ReplicationService class

  • Article

Modifies to modify the synchronization association between two storage objects or between two replication groups.

This method overrides the method that is inherited from the CIM_ReplicationService class.

Syntax

uint32 ModifyReplicaSynchronization(
  [in]  uint16                      Operation,
  [in]  CIM_Synchronized        REF Synchronization,
  [in]  string                      ReplicationSettingData,
  [in]  CIM_StorageSynchronized REF SyncPair[],
  [out] CIM_ConcreteJob         REF Job,
  [out] CIM_SettingsDefineState REF SettingsState,
  [in]  boolean                     Force,
  [in]  uint16                      WaitForCopyState
);

Parameters

Operation [in]

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

Abort (2)

Abort the copy operation if possible.

Activate Consistency (3)

Activate consistency if it is not already enabled. If consistency is already enabled, this operation has no effect.

Activate (4)

Activate an inactive or prepared synchronized association.

AddSyncPair (5)

Add pairs of elements that are already in a relationship to source and target groups, as specified in the SyncPair parameter.

Deactivate Consistency (6)

Deactivate consistency if it is enabled. If consistency was not enabled, this operation has no effect.

Deactivate (7)

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

Detach (8)

Delete the synchronization between two storage objects. Treat the objects as independent after the synchronization is deleted.

Dissolve (9)

Dissolve the synchronization between two storage objects; however, the target element continues to exist.

Failover (10)

Use the target element as the source element.

Failback (11)

Reverse the effect of Failover.

Fracture (12)

Suspend the synchronization between two storage objects. The implementation records the association to enable a faster re-synchronization.

This value can be used during a backup cycle to copy one of the objects while the other object remains in production.

RemoveSyncPair (13)

Remove the pair that is specified in the SyncPair property from the source and target groups. The elements in the pair remain associated but do not remain in the groups.

Resync Replica (14)

Re-establish the synchronization. The re-synchronization negates the action of a previous Fracture or Split operation. Re-create a point-in-time image for a snapshot or a clone replication. Restart a Broken or Aborted synchronization relationship.

Restore from Replica (15)

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

Resume (16)

Continue the copy operation of a suspended association.

Reset To Sync (17)

Change the mode of the copy operation to Synchronous from the Asynchronous mode.

Reset To Async (18)

Change the mode property of the copy operation to Asynchronous from the Synchronous mode.

Return To ResourcePool (19)

Dissolve a snapshot and return the space it used back to the storage pool.

Reverse Roles (20)

Reverse the roles of the elements so that the source element becomes the target element and vise versa.

Split (21)

Suspend the synchronization between two storage objects in the same way as the Fracture operation; however, take steps to ensure the target elements are consistent. For example, stop changes to the source elements, wait for copy operations between source and target elements to stop, then split the source and target elements.

Suspend (22)

Stop the background copy that was previously started.

Unprepare (23)

Causes the synchronization to be reinitialized.

DMTF Reserved

Reserved.

Vendor Specific

Reserved.

Synchronization [in]

Specifies the replication association between the source and the target elements. Required.

ReplicationSettingData [in]

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.

SyncPair [in]

Specifies the CIM_StorageSynchronized instance that describes the replication.

Job [out]

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

SettingsState [out]

On return, contains a reference to the association 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]

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

Vendor Specific (32768 = 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