ModifyReplicaSynchronization method of the CIM_ReplicationService class

Modify (or start a job to modify) the synchronization association between two storage objects or replication groups. 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.

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]

Operation describes the type of modification to be made to the replica and/or to the related associations. Abort: Abort the copy operation if it is possible. Activate Consistency: if consistency was not requested when CreateGroupReplica was called. If Consistency is already active, no modification is made. Activate: Activate an inactive or prepared Synchronized association. AddSyncPair: Add pairs of elements already in a relationship to source and target groups -- see SyncPair parameter. Deactivate Consistency: Deactivate consistency. If consistency was not enabled, this operation has no effect. Deactivate: Stop the data flow. Writes to source element are not copied to target. For Snapshots, writes to target are lost as the pointers to changed data are deleted. Detach: 'Forget' the synchronization between two storage objects. Start to treat the objects as independent. Dissolve: Dissolve the synchronization between two storage objects, however, the target element continues to exist. Failover: Use the target element as the source elements. Failback: Reverse the effect of failback. 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. RemoveSyncPair: Remove the pair associated via StorageSynchronized from the source and target groups. The pair continue to remain associated but not in the groups. Resync Replica: Re-establish the synchronization. This will negate the action of a previous Fracture/Split operation. Recreate a Point In Time image for a Snapshot or a Clone replication. Restart a Broken or Aborted synchronization relationship. Restore from Replica: Renew the contents of the original storage object from a replica. Resume: Continue the copy operation of a suspended association. Reset To Sync: Change the Mode of the copy operation to Synchronous (e.g., from the Asynchronous Mode). Reset To Async: Change the Mode of the copy operation to Asynchronous (e.g., from the Synchronous Mode). Return to ResourcePool: Dissolve a snapshot and free up its space back to the storage pool. Reverse Roles: Source element becomes the target element and vise versa. Split: Same as Fracture, however steps are taken to ensure the target elements are consistent. For example, stop I/O to source elements, wait for in-transit copy operations between source and target elements to stop, then instantly split source/target groups/elements. Suspend: Stop the background copy previously started. Unprepare: Causes the synchronization to be reinitialized.

Abort (2)

Activate Consistency (3)

Activate (4)

AddSyncPair (5)

Deactivate Consistency (6)

Deactivate (7)

Detach (8)

Dissolve (9)

Failover (10)

Failback (11)

Fracture (12)

RemoveSyncPair (13)

Resync Replica (14)

Restore from Replica (15)

Resume (16)

Reset To Sync (17)

Reset To Async (18)

Return To ResourcePool (19)

Reverse Roles (20)

Split (21)

Suspend (22)

Unprepare (23)

DMTF Reserved

24 32767

Vendor Specific

32768 65535

Synchronization [in]

The reference to the replication association describing the elements/groups relationship.

ReplicationSettingData [in]

If provided, it overrides the default replication setting data for the given SyncType. If not provided, the management server uses the default replication setting data.

SyncPair [in]

This parameter applies to AddSyncPair/RemoveSyncPair Operations.

Job [out]

Reference to the job (may be NULL if the task completed).

SettingsState [out]

Reference to the association between the source element and an instance of SynchronizationAspect. This parameters applies to operations such as Dissolve, which dissolves the Synchronized relationship, but causes the SettingDefineState association to be created.

Force [in]

Some operations may cause an inconsistency among the target elements. If true, the client is not warned and the operation is performed.

WaitForCopyState [in]

Method must wait until this CopyState is reached before returning. Only a subset of valid CopyStates apply. 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. Fractured/Split: Target elements are separated from the source elements. Etc.

Return value

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

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

CIM_ReplicationService