FairCom Replication JSON RPC API

ctMemphisScanReplAgent

int ctMemphisScanReplAgent( pRCESJson request, ppRCESJson result )

Description:

Retrieve all the current Replication agents physically set by the current supported technology.

HTTP URL: <baseURL>/ctMemphisScanReplAgent/

HTTP Verb: POST

Constraints:

• "opSystem" must be an existing OpSystem ID.
• To process this action, we need to have at least one Replication Studio agent running in the machine defined by "opSystem."

Parameters:

• request [IN] - Scan Replication Agent request in JSON format. For example:

{

"opSystem": 0, // optional, Operating System in

which the Replication information

will be searched, if not passed

it will try to scan all the

current OpSystems

"basePath": "C:\faircom\v11.3.0\win32\tools" // optional, base path from where

the Replication setup will be

recursively scanned

}

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

{

"replAgentList": [

{

"opSystem": 0, // required

"path": "C:\faircom\v11.3.0\win32\tools\replication", // required

"name": "FAIRAGENT", // required

"sourceServer": "FAIRCOMS@SourceIP", // required

"sourceNodeID": "sourceNode", // optional

"targetServer": "FAIRCOMS@localhost", // required

"targetNodeID": "targetNode" // optional

},

{

"opSystem": 0, // required

"path": "C:\faircom\v11.3.0\win32\tools\replication2", // required

"name": "FAIRAGENT2", // required

"sourceServer": "FAIRCOMS2@SourceIP", // required

"sourceNodeID": "sourceNode2", // optional

"targetServer": "FAIRCOMS2@localhost", // required

"targetNodeID": "targetNode2" // optional

},

{

"opSystem": 0, // required

"path": "C:\faircom\v11.3.0\win32\tools\replication3", // required

"name": "FAIRAGENT3", // required

"sourceServer": "FAIRCOMS3@SourceIP", // required

"sourceNodeID": "sourceNode3", // optional

"targetServer": "FAIRCOMS3@localhost", // required

"targetNodeID": "targetNode3" // optional

}

],

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

}

}

Return:

Error code