StartVolumePairing

You can use the StartVolumePairing method to create an encoded key from a volume that is used to pair with another volume. The key that this method creates is used in the CompleteVolumePairing method to establish a volume pairing.

Parameters

This method has the following input parameters:

Name Description Type Default value Required
mode The mode of the volume on which to start the pairing process. The mode can only be set if the volume is the source volume. Possible values:
  • Async: Writes are acknowledged when they complete locally. The cluster does not wait for writes to be replicated to the target cluster. (Default if no mode parameter specified.)
  • Sync: Source acknowledges 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
volumeID The ID of the volume on which to start the pairing process. integer None Yes

Return value

This method has the following return value:

Name Description Type
volumePairingKey A string of characters that is used by the CompleteVolumePairing API method. string

Request example

Requests for this method are similar to the following example:

{
   "method": "StartVolumePairing",
   "params": {
         "mode": "Async",
	 "volumeID" : 14  
      },
   "id" : 1
}

Response example

This method returns a response similar to the following example:

{
   "id" : 1,
   "result" : {
      "volumePairingKey" : "7b226d766970223a223139322e3136382e3133392e313232222c22766f6c756d654944223a312c22766f6c756d654e616d65223a2254657374222c22766f6c756d655061697255554944223a2236393632346663622d323032652d343332352d613536392d656339633635356337623561227d"  
      }
}