Skip to content

Serial Console

Supported Versions Last Updated
1.2.00 & higher
json output 1.14.00 & higher
2013/05/04
Action vserver-console
Method GET, POST
Variables

vserverid [id of virtual server]

access [enable|disable] only needs to be specified if enabling/disabling a session

time [1|2|3|4|5|6|7|8] optional with the access variable

rdtype [json] For json output specify json or for default output leave blank. This variable is optional

Example Output

XML

Success:

 <status>success</status>

<statusmsg></statusmsg>

<type>openvz|xen</type>

<consoleip>ip of host</consoleip>

<consoleport>port of host</consoleport>

<consolepassword>console password</consolepassword>

<consoleusername>console username</consoleusername>

<cancelled>success</cancelled> or <cancelled>error-REASON</cancelled>

<created>success</created> or <created>error-REASON</created>

<sessionactive>1</sessionactive>

<sessionexpire>3600</sessionexpire>

Error:

 <status>error</status>

<statusmsg>ERROR MESSAGE</statusmsg>

JSON

Success:

 {

"status":"success",

"statusmsg":"",

"created":"success",

"type>openvz|xen",

"consoleip":"ip of host",

"consoleport":"port of host",

"consolepassword":"console password",

"consoleusername":"console username",

"cancelled":"success",

"sessionactive":"1",

"sessionexpire":3600

}

Error:

 {"status":"error","statusmsg":"ERROR MESSAGE"}