Product Documentation

FairCom Replication JSON RPC API

Previous Topic

Next Topic

ctMemphisPersistDBEngine

int ctMemphisPersistDBEngine( pRCESJson request, ppRCESJson result )

Description:

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

HTTP URL: <baseURL>/ctMemphisPersistDBEngine/

HTTP Verb: POST

Constraints:

  • opSystem must be an existing OpSystem ID;
  • workingVolume must be an existing Volume ID;
  • workingDir is not NULL and "opSystem" + "workingVolume" + "workingDir" must be unique;
  • name is not NULL, not EMPTY and Unique per OpSystem;
  • status is not NULL and one of the existing EngineStatus value: "inactive", "active", "stopping", or "starting";

Parameters:

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

{

"checkDB": true, // optional, indicate if the agent should

sniff for the real physical DBEngine

information, default is TRUE

"dbEngine": {

"id": 3, // optional, must be a existing ID

for update

"logicalName": "FAIRCOMS3_hostname", // optional, if not provided it will

be automatically populated with

unique name

"opSystem": 0, // required

"workingVolume": 0, // required

"workingDir": "FairCom", // required, see

// Note 3 - File Separators

"name": "FAIRCOMS3", // required

"status": "active", // optional

"statusTime": "2015-11-05T10:00:00", // optional

"description": "Faircoms 3 DBEngine description", // optional

"authContent": "Ï/9ÈÓ8\ÛÞ15Ԑ,=ÉÉ+8ºÛ81ÓÔv", // optional

"isSQL": 1, // optional

"portNbr": 5587, // optional

"sqlPortNbr": 6587, // optional

"localVolume": 0, // optional

"localDir": "FairCom\data", // optional, see

// Note 3 - File Separators

"users": 150, // optional

"releaseVersion": "10.5.0.23948(Build-140411)", // optional

"serial": "39000010", // optional

"licenseOEM": 1, // optional

"licenseType": "2", // optional

"licenseCPUNbr": 0, // optional

"licenseServerType": "ALL (Standard - SQL)", // optional

"licenseUserNbr": 150, // optional

"isAgent": 1, // optional

"replNodeID": "1.1.1.3" // optional

"ipAddress": 192.168.1.32 // optional

}

}

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

{

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

},

"id": 3

}

Return:

Error code

TOCIndex