XML element RunningVPSInfo

Reference for RimuHosting's Data Structures (as used in our REST-ful APIs)

These data structures are used in our REST-ful APIs.
These data structures and their fields are in beta and subject to change. If you need to rely on them being stable, please contact RimuHosting so we can advise.

Name: RunningVPSInfo

Stats from the VPS host server. This is 'live' data from a physical server (vs. data returned from a database).

XML Example:

<RunningVPSInfo>
  <console_public_authorized_keys>xsd:string</console_public_authorized_keys>
  <current_kernel>xsd:string</current_kernel>
  <current_kernel_canonical>xsd:string</current_kernel_canonical>
  <is_backup_running>xsd:boolean</is_backup_running>
  <is_backups_enabled>xsd:boolean</is_backups_enabled>
  <is_console_login_enabled>xsd:boolean</is_console_login_enabled>
  <is_suspended>xsd:boolean</is_suspended>
  <last_backup_message>xsd:string</last_backup_message>
  <next_backup_time>java.sql.Timestamp</next_backup_time>
  <pings_ok>xsd:boolean</pings_ok>
  <running_state>RUNNING | NOTRUNNING | RESTARTING | POWERCYCLING</running_state>
  <vps_cpu_time_s>xsd:long</vps_cpu_time_s>
  <vps_uptime_s>xsd:long</vps_uptime_s>
</RunningVPSInfo>

JSON Example:

{"RunningVPSInfo":
 {
   "console_public_authorized_keys": String,
   "current_kernel": String,
   "current_kernel_canonical": String,
   "is_backup_running": Boolean,
   "is_backups_enabled": Boolean,
   "is_console_login_enabled": Boolean,
   "is_suspended": Boolean,
   "last_backup_message": String,
   "next_backup_time": java.sql.Timestamp,
   "pings_ok": Boolean,
   "running_state": 'RUNNING' | 'NOTRUNNING' | 'RESTARTING' | 'POWERCYCLING',
   "vps_cpu_time_s": Number,
   "vps_uptime_s": Number,
 }
}

Elements
Name	Type	Required	Nillable	Description
console_public_authorized_keys	xsd:string	false	false	The console-over-sshes authorized keys (if they are set). Else the console access would be controlled by a password.
current_kernel	xsd:string	false	false	The current kernel label. e.g.
current_kernel_canonical	xsd:string	false	false	Some current_kernel labels are symlinks to different kernel. e.g.
is_backup_running	xsd:boolean	false	false	true when the host server is running a backup of the VPS. On new hosts we use LVM file systems so backups can be performed by only pausing VPSs for a fraction of a second.
is_backups_enabled	xsd:boolean	false	false	true on almost all servers. false when the backups are enabled. e.g.
is_console_login_enabled	xsd:boolean	false	false	Whether the console-over-ssh login feature is enabled.
is_suspended	xsd:boolean	false	false	Whether the VPS is marked to not run. e.g.
last_backup_message	xsd:string	false	false	The last backup message stored for the VPS.
next_backup_time	java.sql.Timestamp	false	false	The time we next expect a backup to run. The actual time may be a bit later (e.g.
pings_ok	xsd:boolean	false	false	Whether the server pinged from the host server.
running_state	RUNNING \| NOTRUNNING \| RESTARTING \| POWERCYCLING	false	false	Whether the VPS is, for example, running or not. Typically VPSs will all be running. A VPS may be in a non-running state, for example, for a short time after its host server is restarted. Since we start VPSs sequentially (one after the other) to keep server load to a manageable level.
vps_cpu_time_s	xsd:long	false	false	The number of CPU seconds consumed by a VPS. Note that if a VPS is using more than one core or CPU then this number can be higher than the uptime number.
vps_uptime_s	xsd:long	false	false	How long Xen reports the VPS has been up and running for. In seconds. Divide by your time unit of choice :)