You can use the ModifyVolumePair method to pause or restart replication between a pair of volumes. This method is set on the source volume (the volume with read/write access).


This method has the following input parameters:

Name Description Type Default value Required
volumeID Identification number of the volume to be modified. integer None Yes
pausedManual Remote replication can be paused or restarted on the source (read/write) volume. Possible values:
  • true: Pause volume replication.
  • false: Restart volume replication.
If no value is specified, no change in replication is performed.
boolean None No
mode Volume replication mode. Possible values:
  • Async: Writes are acknowledged when they complete locally. The cluster does not wait for writes to be replicated to the target cluster.
  • Sync: The source acknowledges the write when the data is stored locally and on the remote cluster.
  • SnapshotsOnly: Only snapshots created on the source cluster are replicated. Active writes from the source volume are not replicated.
string None No

Return value

This method has no return value.

Request example

Requests for this method are similar to the following example:

  "method": "ModifyVolumePair", 
  "params": {
    "pausedManual": false, 
    "volumeID": 5,
    "mode": "sync"
  "id": 1

Response example

This method returns a response similar to the following example:

   "id" : 1,
   "result" : {}

New since version