Product Documentation

FairCom Replication JSON RPC API

Previous Topic

Next Topic

ctMemphisPersistVolume

int ctMemphisPersistVolume( pRCESJson request, ppRCESJson result )

Description:

Persist a Volume into the Replication Manager Database. If it doesn't exist, create it, otherwise update it. To create a new volume, the ID must be -1 or not passed. And the update will be done by the ID.

HTTP URL: <baseURL>/ctMemphisPersistVolume/

HTTP Verb: POST

Constraints:

  • "opSystem" must be an existing OpSystem ID;
  • "name" is not NULL, not EMPTY and Unique per OpSystem;

Parameters:

  • request [IN] - Persist Volume request in JSON format. For example:

{

"volume": {

"id": 3, // optional, must be an existing

ID for update

"opSystem": 0, // required

"name": "E:/", // required to create a new volume,

see Note 3 - File Separators

"description": "Volume 3 description", // optional

"totalDiskSpace": 1000, // optional

"availDiskSpace": 500 // optional

}

}

  • result [OUT] - Result in JSON format. For example:

{

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

},

"id": 3

}

Return:

Error code

TOCIndex