Product Documentation

FairCom Replication JSON RPC API

Previous Topic

Next Topic

ctMemphisGetOSs

int ctMemphisGetOSs( pRCESJson request, ppRCESJson result )

Description:

Retrieve all the OpSystems for a given Hardware from the Replication Manager Database.

HTTP URL: <baseURL>/ctMemphisGetOSs/

HTTP Verb: POST

Parameters:

  • request [IN] - Get OpSystems request in JSON format. For example:

{

"id": 0, // optional, if passed, return OS

by its ID

"hostname": "hostname", // optional, if passed, return OS

by its hostname

"ip": "10.0.0.1", // optional, if passed, return OS

by its IP address

"hardware": 0, // optional, if not passed, it will return

all the opsystems from all the hardware

"name": "name1", // optional, if passed with hardware,

return OS by its name

"paging": true, // optional, see Note 1 - Paging Parameters

"limit": 100, // optional, see Note 1 - Paging Parameters

"start": 200 // optional, see Note 1 - Paging Parameters

}

Note: If "hardware" is not provided, it will return all the OSs from the Replication Manager Database.

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

{

"opSystemList": [

{

"id": 1,

"hardware": 0,

"name": "name1",

"hostname": "host1",

"ipList": [

{

"ip": "10.0.0.1",

"type": "ipV4"

},

{

"ip": "0000:0000:0000:0000:0000:0000:0000:0001",

"type": "ipV6"

}

],

"description": "OpSystem 1 description",

"memory": 16,

"diskSpace": 1000,

"cpu": 8,

"type": "Windows 64",

"edition": "Server 2012",

"pathCaseSensitive": false,

"platform": "Windows64"

},

{

"id": 2,

"hardware": 0,

"name": "name2",

"hostname": "host2",

"ipList": [

{

"ip": "10.0.0.2",

"type": "ipV4"

}

],

"description": "OpSystem 2 description",

"memory": 16,

"diskSpace": 1000,

"cpu": 8,

"type": "Linux 32",

"edition": "Ubuntu",

"pathCaseSensitive": true,

"platform": "Linux64"

}

]

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

},

"total": 500 // total number of opsystems for the query -

see Note 1 - Paging Parameters

}

Return:

Error code

TOCIndex