cbrx_connection_cli

Perform command line interface operation on the connected hub and return the complete result. This allows you to run commands directly on the hub’s command line without stopping the API service. This method is only for using the CLI commands to obtain information and not update settings, if you wish to change the internal hub settings please use the Syntax: see Call Structure command.

Syntax: see API Call Structure

{

"method": "cbrx_connection_cli",

"params": [

connection-handle

cli-command

]

}

Parameter Description
connection-handle The Connection Handles as an integer
cli-command

The CLI command you wish to send. For all CLI commands see the CLI Documentation www.cambrionix.com/cambrionix-cli

Returns:

{

"result": [cli-response] }

cli-response is an array of strings containing all the lines of output returned from the command. For more information see www.cambrionix.com/cli

Examples

Example JSON-RPC request

Copy
{
  "jsonrpc": "2.0",
  "id": 0,
  "method": "cbrx_connection_cli",
  "params": [
    7654,
    "id"
  ]
}

Example successful response:

Copy
{
"jsonrpc": "2.0", 
"id": 0, 
"result": ["mfr:cambrionix,mode:main,hw:PP15S,hwid:0x13,fw:1.83,bl: 0.12,sn:000000,group:-,fc:un"]
 }