1 HXCOMM QMP dispatch table and documentation
2 HXCOMM Text between SQMP and EQMP is copied to the QMP documention file and
3 HXCOMM does not show up
in the other formats
.
9 This document describes all commands currently supported by QMP
.
11 Most of the time their usage is exactly the same as
in the user Monitor
, this
12 means that any other document which also describe
commands (the manpage
,
13 QEMU
's manual, etc) can and should be consulted.
15 QMP has two types of commands: regular and query commands. Regular commands
16 usually change the Virtual Machine's state someway
, while query commands just
17 return information
. The sections below are divided accordingly
.
19 It
's important to observe that all communication examples are formatted in
20 a reader-friendly way, so that they're easier to understand
. However
, in real
21 protocol usage
, they
're emitted as a single line.
23 Also, the following notation is used to denote data flow:
25 -> data issued by the Client
26 <- Server data response
28 Please, refer to the QMP specification (QMP/qmp-spec.txt) for detailed
29 information on the Server command and response formats.
31 NOTE: This document is temporary and will be replaced soon.
33 1. Stability Considerations
34 ===========================
36 The current QMP command set (described in this file) may be useful for a
37 number of use cases, however it's limited and several commands have bad
38 defined semantics
, specially with regard to command completion
.
40 These problems are going to be solved incrementally
in the next QEMU releases
41 and we
're going to establish a deprecation policy for badly defined commands.
43 If you're planning to adopt QMP
, please observe the following
:
45 1. The deprecation policy will take efect and be documented soon
, please
46 check the documentation of each used command as soon as a
new release of
49 2. DO NOT rely on anything which is not explicit documented
51 3. Errors
, in special
, are not documented
. Applications should NOT check
52 for specific errors classes or
data (it
's strongly recommended to only
53 check for the "error" key)
58 Server's responses
in the examples below are always a success response
, please
59 refer to the QMP specification
for more details on error responses
.
67 .help
= "quit the emulator",
68 .user_print
= monitor_user_noop
,
69 .mhandler
.cmd_new
= do_quit
,
82 -> { "execute": "quit" }
89 .args_type
= "force:-f,device:B",
90 .params
= "[-f] device",
91 .help
= "eject a removable medium (use -f to force it)",
92 .user_print
= monitor_user_noop
,
93 .mhandler
.cmd_new
= do_eject
,
100 Eject a removable medium
.
104 - force
: force
ejection (json
-bool
, optional
)
105 - device
: device
name (json
-string
)
109 -> { "execute": "eject", "arguments": { "device": "ide1-cd0" } }
112 Note
: The
"force" argument defaults to
false.
118 .args_type
= "device:B,target:F,arg:s?",
119 .params
= "device filename [format]",
120 .help
= "change a removable medium, optional format",
121 .user_print
= monitor_user_noop
,
122 .mhandler
.cmd_new
= do_change
,
129 Change a removable medium or VNC configuration
.
133 - "device": device
name (json
-string
)
134 - "target": filename or
item (json
-string
)
135 - "arg": additional
argument (json
-string
, optional
)
139 1. Change a removable medium
141 -> { "execute": "change",
142 "arguments": { "device": "ide1-cd0",
143 "target": "/srv/images/Fedora-12-x86_64-DVD.iso" } }
146 2. Change VNC password
148 -> { "execute": "change",
149 "arguments": { "device": "vnc", "target": "password",
156 .name
= "screendump",
157 .args_type
= "filename:F",
158 .params
= "filename",
159 .help
= "save screen into PPM image 'filename'",
160 .user_print
= monitor_user_noop
,
161 .mhandler
.cmd_new
= do_screen_dump
,
168 Save screen into PPM image
.
172 - "filename": file
path (json
-string
)
176 -> { "execute": "screendump", "arguments": { "filename": "/tmp/image" } }
185 .help
= "stop emulation",
186 .user_print
= monitor_user_noop
,
187 .mhandler
.cmd_new
= do_stop
,
200 -> { "execute": "stop" }
209 .help
= "resume emulation",
210 .user_print
= monitor_user_noop
,
211 .mhandler
.cmd_new
= do_cont
,
224 -> { "execute": "cont" }
230 .name
= "system_reset",
233 .help
= "reset the system",
234 .user_print
= monitor_user_noop
,
235 .mhandler
.cmd_new
= do_system_reset
,
248 -> { "execute": "system_reset" }
254 .name
= "system_powerdown",
257 .help
= "send system power down event",
258 .user_print
= monitor_user_noop
,
259 .mhandler
.cmd_new
= do_system_powerdown
,
266 Send system power down event
.
272 -> { "execute": "system_powerdown" }
278 .name
= "device_add",
279 .args_type
= "device:O",
280 .params
= "driver[,prop=value][,...]",
281 .help
= "add device, like -device on the command line",
282 .user_print
= monitor_user_noop
,
283 .mhandler
.cmd_new
= do_device_add
,
294 - "driver": the name of the
new device
's driver (json-string)
295 - "bus": the device's parent
bus (device tree path
, json
-string
, optional
)
296 - "id": the device
's ID, must be unique (json-string)
301 -> { "execute": "device_add", "arguments": { "driver": "e1000", "id": "net1" } }
306 (1) For detailed information about this command, please refer to the
307 'docs
/qdev
-device
-use
.txt
' file.
309 (2) It's possible to list device properties by running QEMU with the
310 "-device DEVICE,\?" command
-line argument
, where DEVICE is the device
's name
315 .name = "device_del",
318 .help = "remove device",
319 .user_print = monitor_user_noop,
320 .mhandler.cmd_new = do_device_del,
331 - "id": the device's
ID (json
-string
)
335 -> { "execute": "device_del", "arguments": { "id": "net1" } }
342 .args_type
= "index:i",
344 .help
= "set the default CPU",
345 .user_print
= monitor_user_noop
,
346 .mhandler
.cmd_new
= do_cpu_set
,
357 - "index": the CPU
's index (json-int)
361 -> { "execute": "cpu", "arguments": { "index": 0 } }
364 Note: CPUs' indexes are obtained with the
'query-cpus' command
.
370 .args_type
= "val:l,size:i,filename:s",
371 .params
= "addr size file",
372 .help
= "save to disk virtual memory dump starting at 'addr' of size 'size'",
373 .user_print
= monitor_user_noop
,
374 .mhandler
.cmd_new
= do_memory_save
,
381 Save to disk virtual memory dump starting at
'val' of size
'size'.
385 - "val": the starting
address (json
-int
)
386 - "size": the memory size
, in bytes (json
-int
)
387 - "filename": file
path (json
-string
)
391 -> { "execute": "memsave",
392 "arguments": { "val": 10,
394 "filename": "/tmp/virtual-mem-dump" } }
397 Note
: Depends on the current CPU
.
403 .args_type
= "val:l,size:i,filename:s",
404 .params
= "addr size file",
405 .help
= "save to disk physical memory dump starting at 'addr' of size 'size'",
406 .user_print
= monitor_user_noop
,
407 .mhandler
.cmd_new
= do_physical_memory_save
,
414 Save to disk physical memory dump starting at
'val' of size
'size'.
418 - "val": the starting
address (json
-int
)
419 - "size": the memory size
, in bytes (json
-int
)
420 - "filename": file
path (json
-string
)
424 -> { "execute": "pmemsave",
425 "arguments": { "val": 10,
427 "filename": "/tmp/physical-mem-dump" } }
434 .args_type
= "detach:-d,blk:-b,inc:-i,uri:s",
435 .params
= "[-d] [-b] [-i] uri",
436 .help
= "migrate to URI (using -d to not wait for completion)"
437 "\n\t\t\t -b for migration without shared storage with"
438 " full copy of disk\n\t\t\t -i for migration without "
439 "shared storage with incremental copy of disk "
440 "(base image shared between src and destination)",
441 .user_print
= monitor_user_noop
,
442 .mhandler
.cmd_new
= do_migrate
,
453 - "blk": block migration
, full disk
copy (json
-bool
, optional
)
454 - "inc": incremental disk
copy (json
-bool
, optional
)
455 - "uri": Destination
URI (json
-string
)
459 -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
464 (1) The
'query-migrate' command should be used to check migration
's progress
465 and final result (this information is provided by the 'status
' member)
466 (2) All boolean arguments default to false
467 (3) The user Monitor's
"detach" argument is invalid
in QMP and should not
473 .name
= "migrate_cancel",
476 .help
= "cancel the current VM migration",
477 .user_print
= monitor_user_noop
,
478 .mhandler
.cmd_new
= do_migrate_cancel
,
485 Cancel the current migration
.
491 -> { "execute": "migrate_cancel" }
497 .name
= "migrate_set_speed",
498 .args_type
= "value:o",
500 .help
= "set maximum speed (in bytes) for migrations",
501 .user_print
= monitor_user_noop
,
502 .mhandler
.cmd_new
= do_migrate_set_speed
,
509 Set the spice
/vnc connection info
for the migration target
. The spice
/vnc
510 server will ask the spice
/vnc client to automatically reconnect
using the
511 new parameters (if specified
) once the vm migration finished successfully
.
515 - "protocol": protocol
: "spice" or
"vnc" (json
-string
)
516 - "hostname": migration target
hostname (json
-string
)
517 - "port": spice
/vnc tcp port
for plaintext
channels (json
-int
, optional
)
518 - "tls-port": spice tcp port
for tls
-secured
channels (json
-int
, optional
)
519 - "cert-subject": server certificate
subject (json
-string
, optional
)
523 -> { "execute": "client_migrate_info",
524 "arguments": { "protocol": "spice",
525 "hostname": "virt42.lab.kraxel.org",
532 .name
= "client_migrate_info",
533 .args_type
= "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
534 .params
= "protocol hostname port tls-port cert-subject",
535 .help
= "send migration info to spice/vnc client",
536 .user_print
= monitor_user_noop
,
537 .mhandler
.cmd_new
= client_migrate_info
,
544 Set maximum speed
for migrations
.
548 - "value": maximum speed
, in bytes per
second (json
-int
)
552 -> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } }
558 .name
= "migrate_set_downtime",
559 .args_type
= "value:T",
561 .help
= "set maximum tolerated downtime (in seconds) for migrations",
562 .user_print
= monitor_user_noop
,
563 .mhandler
.cmd_new
= do_migrate_set_downtime
,
570 Set maximum tolerated
downtime (in seconds
) for migrations
.
574 - "value": maximum
downtime (json
-number
)
578 -> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } }
584 .name
= "netdev_add",
585 .args_type
= "netdev:O",
586 .params
= "[user|tap|socket],id=str[,prop=value][,...]",
587 .help
= "add host network device",
588 .user_print
= monitor_user_noop
,
589 .mhandler
.cmd_new
= do_netdev_add
,
596 Add host network device
.
600 - "type": the device type
, "tap", "user", ... (json
-string
)
601 - "id": the device
's ID, must be unique (json-string)
606 -> { "execute": "netdev_add", "arguments": { "type": "user", "id": "netdev1" } }
609 Note: The supported device options are the same ones supported by the '-net
'
610 command-line argument, which are listed in the '-help
' output or QEMU's
616 .name
= "netdev_del",
619 .help
= "remove host network device",
620 .user_print
= monitor_user_noop
,
621 .mhandler
.cmd_new
= do_netdev_del
,
628 Remove host network device
.
632 - "id": the device
's ID, must be unique (json-string)
636 -> { "execute": "netdev_del", "arguments": { "id": "netdev1" } }
643 .args_type = "value:M",
645 .help = "request VM to change its memory allocation (in MB)",
646 .user_print = monitor_user_noop,
647 .mhandler.cmd_async = do_balloon,
648 .flags = MONITOR_CMD_ASYNC,
655 Request VM to change its memory allocation (in bytes).
659 - "value": New memory allocation (json-int)
663 -> { "execute": "balloon", "arguments": { "value": 536870912 } }
670 .args_type = "name:s,up:b",
671 .params = "name on|off",
672 .help = "change the link status of a network adapter",
673 .user_print = monitor_user_noop,
674 .mhandler.cmd_new = do_set_link,
681 Change the link status of a network adapter.
685 - "name": network device name (json-string)
686 - "up": status is up (json-bool)
690 -> { "execute": "set_link", "arguments": { "name": "e1000.0", "up": false } }
697 .args_type = "fdname:s",
698 .params = "getfd name",
699 .help = "receive a file descriptor via SCM rights and assign it a name",
700 .user_print = monitor_user_noop,
701 .mhandler.cmd_new = do_getfd,
708 Receive a file descriptor via SCM rights and assign it a name.
712 - "fdname": file descriptor name (json-string)
716 -> { "execute": "getfd", "arguments": { "fdname": "fd1" } }
723 .args_type = "fdname:s",
724 .params = "closefd name",
725 .help = "close a file descriptor previously passed via SCM rights",
726 .user_print = monitor_user_noop,
727 .mhandler.cmd_new = do_closefd,
734 Close a file descriptor previously passed via SCM rights.
738 - "fdname": file descriptor name (json-string)
742 -> { "execute": "closefd", "arguments": { "fdname": "fd1" } }
748 .name = "block_passwd",
749 .args_type = "device:B,password:s",
750 .params = "block_passwd device password",
751 .help = "set the password of encrypted block devices",
752 .user_print = monitor_user_noop,
753 .mhandler.cmd_new = do_block_set_passwd,
760 Set the password of encrypted block devices.
764 - "device": device name (json-string)
765 - "password": password (json-string)
769 -> { "execute": "block_passwd", "arguments": { "device": "ide0-hd0",
770 "password": "12345" } }
776 .name = "set_password",
777 .args_type = "protocol:s,password:s,connected:s?",
778 .params = "protocol password action-if-connected",
779 .help = "set spice/vnc password",
780 .user_print = monitor_user_noop,
781 .mhandler.cmd_new = set_password,
788 Set the password for vnc/spice protocols.
792 - "protocol": protocol name (json-string)
793 - "password": password (json-string)
794 - "connected": [ keep | disconnect | fail ] (josn-string, optional)
798 -> { "execute": "set_password", "arguments": { "protocol": "vnc",
799 "password": "secret" } }
805 .name = "expire_password",
806 .args_type = "protocol:s,time:s",
807 .params = "protocol time",
808 .help = "set spice/vnc password expire-time",
809 .user_print = monitor_user_noop,
810 .mhandler.cmd_new = expire_password,
817 Set the password expire time for vnc/spice protocols.
821 - "protocol": protocol name (json-string)
822 - "time": [ now | never | +secs | secs ] (json-string)
826 -> { "execute": "expire_password", "arguments": { "protocol": "vnc",
833 .name = "qmp_capabilities",
836 .help = "enable QMP capabilities",
837 .user_print = monitor_user_noop,
838 .mhandler.cmd_new = do_qmp_capabilities,
845 Enable QMP capabilities.
851 -> { "execute": "qmp_capabilities" }
854 Note: This command must be issued before issuing any other command.
859 .name = "human-monitor-command",
860 .args_type = "command-line:s,cpu-index:i?",
863 .user_print = monitor_user_noop,
864 .mhandler.cmd_new = do_hmp_passthrough,
868 human-monitor-command
869 ---------------------
871 Execute a Human Monitor command.
875 - command-line: the command name and its arguments, just like the
876 Human Monitor's
shell (json
-string
)
877 - cpu
-index
: select the CPU number to be used by commands which access CPU
878 data
, like
'info registers'. The Monitor selects CPU
0 if this
879 argument is not
provided (json
-int
, optional
)
883 -> { "execute": "human-monitor-command", "arguments": { "command-line": "info kvm" } }
884 <- { "return": "kvm support: enabled\r\n" }
888 (1) The Human Monitor is NOT an stable
interface, this means that command
889 names
, arguments and responses can change or be removed at ANY time
.
890 Applications that rely on long term stability guarantees should NOT
895 o This command is stateless
, this means that commands that depend
896 on state
information (such as getfd
) might not work
898 o Commands that prompt the user
for data (eg
. 'cont' when the block
899 device is encrypted
) don
't currently work
904 HXCOMM Each query command below is inside a SQMP/EQMP section, do NOT change
905 HXCOMM this! We will possibly move query commands definitions inside those
906 HXCOMM sections, just like regular commands.
916 Return a json-object with the following information:
918 - "qemu": A json-object containing three integer values:
919 - "major": QEMU's major
version (json
-int
)
920 - "minor": QEMU
's minor version (json-int)
921 - "micro": QEMU's micro
version (json
-int
)
922 - "package": package's version (json-string)
926 -> { "execute": "query-version" }
944 List QMP available commands.
946 Each command is represented by a json-object, the returned value is a json-array
949 Each json-object contain:
951 - "name": command's
name (json
-string
)
955 -> { "execute": "query-commands" }
959 "name":"query-balloon"
962 "name":"system_powerdown"
967 Note
: This example has been shortened as the real response is too long
.
975 Each device is represented by a json
-object
. The returned value is a json
-array
978 Each json
-object contain the following
:
980 - "label": device
's label (json-string)
981 - "filename": device's
file (json
-string
)
985 -> { "execute": "query-chardev" }
1005 Show the block devices
.
1007 Each block device information is stored
in a json
-object and the returned value
1008 is a json
-array of all devices
.
1010 Each json
-object contain the following
:
1012 - "device": device
name (json
-string
)
1013 - "type": device
type (json
-string
)
1014 - Possible values
: "hd", "cdrom", "floppy", "unknown"
1015 - "removable": true if the device is removable
, false otherwise (json
-bool
)
1016 - "locked": true if the device is locked
, false otherwise (json
-bool
)
1017 - "inserted": only present
if the device is inserted
, it is a json
-object
1018 containing the following
:
1019 - "file": device file
name (json
-string
)
1020 - "ro": true if read
-only
, false otherwise (json
-bool
)
1021 - "drv": driver format
name (json
-string
)
1022 - Possible values
: "blkdebug", "bochs", "cloop", "cow", "dmg",
1023 "file", "file", "ftp", "ftps", "host_cdrom",
1024 "host_device", "host_floppy", "http", "https",
1025 "nbd", "parallels", "qcow", "qcow2", "raw",
1026 "tftp", "vdi", "vmdk", "vpc", "vvfat"
1027 - "backing_file": backing file
name (json
-string
, optional
)
1028 - "encrypted": true if encrypted
, false otherwise (json
-bool
)
1032 -> { "execute": "query-block" }
1036 "device":"ide0-hd0",
1043 "file":"disks/test.img"
1048 "device":"ide1-cd0",
1074 Show block device statistics
.
1076 Each device statistic information is stored
in a json
-object and the returned
1077 value is a json
-array of all devices
.
1079 Each json
-object contain the following
:
1081 - "device": device
name (json
-string
)
1082 - "stats": A json
-object with the statistics information
, it contains
:
1083 - "rd_bytes": bytes
read (json
-int
)
1084 - "wr_bytes": bytes
written (json
-int
)
1085 - "rd_operations": read
operations (json
-int
)
1086 - "wr_operations": write
operations (json
-int
)
1087 - "wr_highest_offset": Highest offset of a sector written since the
1088 BlockDriverState has been
opened (json
-int
)
1089 - "parent": Contains recursively the statistics of the underlying
1090 protocol (e
.g
. the host file
for a qcow2 image
). If there is
1091 no underlying protocol
, this field is omitted
1092 (json
-object
, optional
)
1096 -> { "execute": "query-blockstats" }
1100 "device":"ide0-hd0",
1103 "wr_highest_offset":3686448128,
1105 "wr_operations":751,
1106 "rd_bytes":122567168,
1107 "rd_operations":36772
1111 "wr_highest_offset":2821110784,
1113 "wr_operations":692,
1114 "rd_bytes":122739200,
1115 "rd_operations":36604
1119 "device":"ide1-cd0",
1121 "wr_highest_offset":0,
1131 "wr_highest_offset":0,
1141 "wr_highest_offset":0,
1157 Show CPU information
.
1159 Return a json
-array
. Each CPU is represented by a json
-object
, which contains
:
1161 - "CPU": CPU
index (json
-int
)
1162 - "current": true if this is the current CPU
, false otherwise (json
-bool
)
1163 - "halted": true if the cpu is halted
, false otherwise (json
-bool
)
1164 - Current program counter
. The key
's name depends on the architecture:
1165 "pc": i386/x86_64 (json-int)
1166 "nip": PPC (json-int)
1167 "pc" and "npc": sparc (json-int)
1168 "PC": mips (json-int)
1172 -> { "execute": "query-cpus" }
1196 PCI buses and devices information.
1198 The returned value is a json-array of all buses. Each bus is represented by
1199 a json-object, which has a key with a json-array of all PCI devices attached
1200 to it. Each device is represented by a json-object.
1202 The bus json-object contains the following:
1204 - "bus": bus number (json-int)
1205 - "devices": a json-array of json-objects, each json-object represents a
1208 The PCI device json-object contains the following:
1210 - "bus": identical to the parent's bus
number (json
-int
)
1211 - "slot": slot
number (json
-int
)
1212 - "function": function number (json
-int
)
1213 - "class_info": a json
-object containing
:
1214 - "desc": device
class description (json
-string
, optional
)
1215 - "class": device
class number (json
-int
)
1216 - "id": a json
-object containing
:
1217 - "device": device
ID (json
-int
)
1218 - "vendor": vendor
ID (json
-int
)
1219 - "irq": device
's IRQ if assigned (json-int, optional)
1220 - "qdev_id": qdev id string (json-string)
1221 - "pci_bridge": It's a json
-object
, only present
if this device is a
1222 PCI bridge
, contains
:
1223 - "bus": bus
number (json
-int
)
1224 - "secondary": secondary bus
number (json
-int
)
1225 - "subordinate": subordinate bus
number (json
-int
)
1226 - "io_range": I
/O memory range information
, a json
-object with the
1228 - "base": base address
, in bytes (json
-int
)
1229 - "limit": limit address
, in bytes (json
-int
)
1230 - "memory_range": memory range information
, a json
-object with the
1232 - "base": base address
, in bytes (json
-int
)
1233 - "limit": limit address
, in bytes (json
-int
)
1234 - "prefetchable_range": Prefetchable memory range information
, a
1235 json
-object with the following members
:
1236 - "base": base address
, in bytes (json
-int
)
1237 - "limit": limit address
, in bytes (json
-int
)
1238 - "devices": a json
-array of PCI devices
if there
's any attached, each
1239 each element is represented by a json-object, which contains
1240 the same members of the 'PCI device json
-object
' described
1242 - "regions": a json-array of json-objects, each json-object represents a
1243 memory region of this device
1245 The memory range json-object contains the following:
1247 - "base": base memory address (json-int)
1248 - "limit": limit value (json-int)
1250 The region json-object can be an I/O region or a memory region, an I/O region
1251 json-object contains the following:
1253 - "type": "io" (json-string, fixed)
1254 - "bar": BAR number (json-int)
1255 - "address": memory address (json-int)
1256 - "size": memory size (json-int)
1258 A memory region json-object contains the following:
1260 - "type": "memory" (json-string, fixed)
1261 - "bar": BAR number (json-int)
1262 - "address": memory address (json-int)
1263 - "size": memory size (json-int)
1264 - "mem_type_64": true or false (json-bool)
1265 - "prefetch": true or false (json-bool)
1269 -> { "execute": "query-pci" }
1281 "desc":"Host bridge"
1315 "desc":"IDE controller"
1337 "desc":"VGA controller"
1347 "mem_type_64":false,
1350 "address":4026531840,
1355 "mem_type_64":false,
1358 "address":4060086272,
1363 "mem_type_64":false,
1378 "desc":"RAM controller"
1399 Note: This example has been shortened as the real response is too long.
1407 Show KVM information.
1409 Return a json-object with the following information:
1411 - "enabled": true if KVM support is enabled, false otherwise (json-bool)
1412 - "present": true if QEMU has KVM support, false otherwise (json-bool)
1416 -> { "execute": "query-kvm" }
1417 <- { "return": { "enabled": true, "present": true } }
1425 Return a json-object with the following information:
1427 - "running": true if the VM is running, or false if it is paused (json-bool)
1428 - "singlestep": true if the VM is in single step mode,
1429 false otherwise (json-bool)
1433 -> { "execute": "query-status" }
1434 <- { "return": { "running": true, "singlestep": false } }
1442 Show VM mice information.
1444 Each mouse is represented by a json-object, the returned value is a json-array
1447 The mouse json-object contains the following:
1449 - "name": mouse's
name (json
-string
)
1450 - "index": mouse
's index (json-int)
1451 - "current": true if this mouse is receiving events, false otherwise (json-bool)
1452 - "absolute": true if the mouse generates absolute input events (json-bool)
1456 -> { "execute": "query-mice" }
1460 "name":"QEMU Microsoft Mouse",
1466 "name":"QEMU PS/2 Mouse",
1480 Show VNC server information.
1482 Return a json-object with server information. Connected clients are returned
1483 as a json-array of json-objects.
1485 The main json-object contains the following:
1487 - "enabled": true or false (json-bool)
1488 - "host": server's IP
address (json
-string
)
1489 - "family": address
family (json
-string
)
1490 - Possible values
: "ipv4", "ipv6", "unix", "unknown"
1491 - "service": server
's port number (json-string)
1492 - "auth": authentication method (json-string)
1493 - Possible values: "invalid", "none", "ra2", "ra2ne", "sasl", "tight",
1494 "tls", "ultra", "unknown", "vencrypt", "vencrypt",
1495 "vencrypt+plain", "vencrypt+tls+none",
1496 "vencrypt+tls+plain", "vencrypt+tls+sasl",
1497 "vencrypt+tls+vnc", "vencrypt+x509+none",
1498 "vencrypt+x509+plain", "vencrypt+x509+sasl",
1499 "vencrypt+x509+vnc", "vnc"
1500 - "clients": a json-array of all connected clients
1502 Clients are described by a json-object, each one contain the following:
1504 - "host": client's IP
address (json
-string
)
1505 - "family": address
family (json
-string
)
1506 - Possible values
: "ipv4", "ipv6", "unix", "unknown"
1507 - "service": client
's port number (json-string)
1508 - "x509_dname": TLS dname (json-string, optional)
1509 - "sasl_username": SASL username (json-string, optional)
1513 -> { "execute": "query-vnc" }
1537 Show SPICE server information.
1539 Return a json-object with server information. Connected clients are returned
1540 as a json-array of json-objects.
1542 The main json-object contains the following:
1544 - "enabled": true or false (json-bool)
1545 - "host": server's IP
address (json
-string
)
1546 - "port": server
's port number (json-int, optional)
1547 - "tls-port": server's port
number (json
-int
, optional
)
1548 - "auth": authentication
method (json
-string
)
1549 - Possible values
: "none", "spice"
1550 - "channels": a json
-array of all active channels clients
1552 Channels are described by a json
-object
, each one contain the following
:
1554 - "host": client
's IP address (json-string)
1555 - "family": address family (json-string)
1556 - Possible values: "ipv4", "ipv6", "unix", "unknown"
1557 - "port": client's port
number (json
-string
)
1558 - "connection-id": spice connection id
. All channels with the same id
1559 belong to the same spice
session (json
-int
)
1560 - "channel-type": channel type
. "1" is the main control channel
, filter
for
1561 this one
if you want track spice sessions
only (json
-int
)
1562 - "channel-id": channel id
. Usually
"0", might be different needed when
1563 multiple channels of the same type exist
, such as multiple
1564 display channels
in a multihead
setup (json
-int
)
1565 - "tls": whevener the channel is
encrypted (json
-bool
)
1569 -> { "execute": "query-spice" }
1582 "connection-id": 1804289383,
1583 "host": "127.0.0.1",
1591 "connection-id": 1804289383,
1592 "host": "127.0.0.1",
1596 [ ... more channels follow
... ]
1609 Return a json
-object with the following information
:
1611 - "name": VM
's name (json-string, optional)
1615 -> { "execute": "query-name" }
1616 <- { "return": { "name": "qemu-name" } }
1626 Return a json-object with the following information:
1628 - "UUID": Universally Unique Identifier (json-string)
1632 -> { "execute": "query-uuid" }
1633 <- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } }
1643 Return a json-object. If migration is active there will be another json-object
1644 with RAM migration status and if block migration is active another one with
1645 block migration status.
1647 The main json-object contains the following:
1649 - "status": migration status (json-string)
1650 - Possible values: "active", "completed", "failed", "cancelled"
1651 - "ram": only present if "status" is "active", it is a json-object with the
1652 following RAM information (in bytes):
1653 - "transferred": amount transferred (json-int)
1654 - "remaining": amount remaining (json-int)
1655 - "total": total (json-int)
1656 - "disk": only present if "status" is "active" and it is a block migration,
1657 it is a json-object with the following disk information (in bytes):
1658 - "transferred": amount transferred (json-int)
1659 - "remaining": amount remaining (json-int)
1660 - "total": total (json-int)
1664 1. Before the first migration
1666 -> { "execute": "query-migrate" }
1669 2. Migration is done and has succeeded
1671 -> { "execute": "query-migrate" }
1672 <- { "return": { "status": "completed" } }
1674 3. Migration is done and has failed
1676 -> { "execute": "query-migrate" }
1677 <- { "return": { "status": "failed" } }
1679 4. Migration is being performed and is not a block migration:
1681 -> { "execute": "query-migrate" }
1693 5. Migration is being performed and is a block migration:
1695 -> { "execute": "query-migrate" }
1701 "remaining":1053304,
1706 "remaining":20880384,
1718 Show balloon information.
1720 Make an asynchronous request for balloon info. When the request completes a
1721 json-object will be returned containing the following data:
1723 - "actual": current balloon value in bytes (json-int)
1724 - "mem_swapped_in": Amount of memory swapped in bytes (json-int, optional)
1725 - "mem_swapped_out": Amount of memory swapped out in bytes (json-int, optional)
1726 - "major_page_faults": Number of major faults (json-int, optional)
1727 - "minor_page_faults": Number of minor faults (json-int, optional)
1728 - "free_mem": Total amount of free and unused memory in
1729 bytes (json-int, optional)
1730 - "total_mem": Total amount of available memory in bytes (json-int, optional)
1734 -> { "execute": "query-balloon" }
1737 "actual":1073741824,
1739 "mem_swapped_out":0,
1740 "major_page_faults":142,
1741 "minor_page_faults":239245,
1742 "free_mem":1014185984,
1743 "total_mem":1044668416