Product Documentation

FairCom Replication JSON RPC API

Previous Topic

Next Topic

ctMemphisRemoveOS

int ctMemphisRemoveOS( pRCESJson request, ppRCESJson result )

Description:

Remove a OpSystem from the Replication Manager Database.

HTTP URL: <baseURL>/ctMemphisRemoveOS/

HTTP Verb: POST

Constraints:

  • If the given OpSystem is in use by any DBEngine's Working Volume or Local Volume, an error message with the list of DBEngine names will be returned
  • The action table has a constraint to the OpSystem, so, in order to keep the action history, the OpSystem record might not be removable

Parameters:

  • request [IN] - Remove OpSystem request in JSON format. For example:

{

"recursive": 1, // optional, if TRUE, all the related

"Volumes" and "IP" records will be also removed

(see constraints in above)

"opSystem": { // required

"id": 2

}

}

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

{

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

}

}

Return:

Error code

TOCIndex