TCG/HPPA: use stack for TCG temps
[qemu/mdroth.git] / qmp-commands.hx
blob92c5c3a318fa638b067269663b528e393eb5306e
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.
5 SQMP
6 QMP Supported Commands
7 ----------------------
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
47 QEMU is available
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)
55 2. Regular Commands
56 ===================
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.
61 EQMP
64 .name = "quit",
65 .args_type = "",
66 .params = "",
67 .help = "quit the emulator",
68 .user_print = monitor_user_noop,
69 .mhandler.cmd_new = do_quit,
72 SQMP
73 quit
74 ----
76 Quit the emulator.
78 Arguments: None.
80 Example:
82 -> { "execute": "quit" }
83 <- { "return": {} }
85 EQMP
88 .name = "eject",
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,
96 SQMP
97 eject
98 -----
100 Eject a removable medium.
102 Arguments:
104 - force: force ejection (json-bool, optional)
105 - device: device name (json-string)
107 Example:
109 -> { "execute": "eject", "arguments": { "device": "ide1-cd0" } }
110 <- { "return": {} }
112 Note: The "force" argument defaults to false.
114 EQMP
117 .name = "change",
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,
125 SQMP
126 change
127 ------
129 Change a removable medium or VNC configuration.
131 Arguments:
133 - "device": device name (json-string)
134 - "target": filename or item (json-string)
135 - "arg": additional argument (json-string, optional)
137 Examples:
139 1. Change a removable medium
141 -> { "execute": "change",
142 "arguments": { "device": "ide1-cd0",
143 "target": "/srv/images/Fedora-12-x86_64-DVD.iso" } }
144 <- { "return": {} }
146 2. Change VNC password
148 -> { "execute": "change",
149 "arguments": { "device": "vnc", "target": "password",
150 "arg": "foobar1" } }
151 <- { "return": {} }
153 EQMP
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,
164 SQMP
165 screendump
166 ----------
168 Save screen into PPM image.
170 Arguments:
172 - "filename": file path (json-string)
174 Example:
176 -> { "execute": "screendump", "arguments": { "filename": "/tmp/image" } }
177 <- { "return": {} }
179 EQMP
182 .name = "stop",
183 .args_type = "",
184 .params = "",
185 .help = "stop emulation",
186 .user_print = monitor_user_noop,
187 .mhandler.cmd_new = do_stop,
190 SQMP
191 stop
192 ----
194 Stop the emulator.
196 Arguments: None.
198 Example:
200 -> { "execute": "stop" }
201 <- { "return": {} }
203 EQMP
206 .name = "cont",
207 .args_type = "",
208 .params = "",
209 .help = "resume emulation",
210 .user_print = monitor_user_noop,
211 .mhandler.cmd_new = do_cont,
214 SQMP
215 cont
216 ----
218 Resume emulation.
220 Arguments: None.
222 Example:
224 -> { "execute": "cont" }
225 <- { "return": {} }
227 EQMP
230 .name = "system_reset",
231 .args_type = "",
232 .params = "",
233 .help = "reset the system",
234 .user_print = monitor_user_noop,
235 .mhandler.cmd_new = do_system_reset,
238 SQMP
239 system_reset
240 ------------
242 Reset the system.
244 Arguments: None.
246 Example:
248 -> { "execute": "system_reset" }
249 <- { "return": {} }
251 EQMP
254 .name = "system_powerdown",
255 .args_type = "",
256 .params = "",
257 .help = "send system power down event",
258 .user_print = monitor_user_noop,
259 .mhandler.cmd_new = do_system_powerdown,
262 SQMP
263 system_powerdown
264 ----------------
266 Send system power down event.
268 Arguments: None.
270 Example:
272 -> { "execute": "system_powerdown" }
273 <- { "return": {} }
275 EQMP
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,
286 SQMP
287 device_add
288 ----------
290 Add a device.
292 Arguments:
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)
297 - device properties
299 Example:
301 -> { "execute": "device_add", "arguments": { "driver": "e1000", "id": "net1" } }
302 <- { "return": {} }
304 Notes:
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
312 EQMP
315 .name = "device_del",
316 .args_type = "id:s",
317 .params = "device",
318 .help = "remove device",
319 .user_print = monitor_user_noop,
320 .mhandler.cmd_new = do_device_del,
323 SQMP
324 device_del
325 ----------
327 Remove a device.
329 Arguments:
331 - "id": the device's ID (json-string)
333 Example:
335 -> { "execute": "device_del", "arguments": { "id": "net1" } }
336 <- { "return": {} }
338 EQMP
341 .name = "cpu",
342 .args_type = "index:i",
343 .params = "index",
344 .help = "set the default CPU",
345 .user_print = monitor_user_noop,
346 .mhandler.cmd_new = do_cpu_set,
349 SQMP
353 Set the default CPU.
355 Arguments:
357 - "index": the CPU's index (json-int)
359 Example:
361 -> { "execute": "cpu", "arguments": { "index": 0 } }
362 <- { "return": {} }
364 Note: CPUs' indexes are obtained with the 'query-cpus' command.
366 EQMP
369 .name = "memsave",
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,
377 SQMP
378 memsave
379 -------
381 Save to disk virtual memory dump starting at 'val' of size 'size'.
383 Arguments:
385 - "val": the starting address (json-int)
386 - "size": the memory size, in bytes (json-int)
387 - "filename": file path (json-string)
389 Example:
391 -> { "execute": "memsave",
392 "arguments": { "val": 10,
393 "size": 100,
394 "filename": "/tmp/virtual-mem-dump" } }
395 <- { "return": {} }
397 Note: Depends on the current CPU.
399 EQMP
402 .name = "pmemsave",
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,
410 SQMP
411 pmemsave
412 --------
414 Save to disk physical memory dump starting at 'val' of size 'size'.
416 Arguments:
418 - "val": the starting address (json-int)
419 - "size": the memory size, in bytes (json-int)
420 - "filename": file path (json-string)
422 Example:
424 -> { "execute": "pmemsave",
425 "arguments": { "val": 10,
426 "size": 100,
427 "filename": "/tmp/physical-mem-dump" } }
428 <- { "return": {} }
430 EQMP
433 .name = "inject-nmi",
434 .args_type = "",
435 .params = "",
436 .help = "",
437 .user_print = monitor_user_noop,
438 .mhandler.cmd_new = do_inject_nmi,
441 SQMP
442 inject-nmi
443 ----------
445 Inject an NMI on guest's CPUs.
447 Arguments: None.
449 Example:
451 -> { "execute": "inject-nmi" }
452 <- { "return": {} }
454 Note: inject-nmi is only supported for x86 guest currently, it will
455 returns "Unsupported" error for non-x86 guest.
457 EQMP
460 .name = "migrate",
461 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
462 .params = "[-d] [-b] [-i] uri",
463 .help = "migrate to URI (using -d to not wait for completion)"
464 "\n\t\t\t -b for migration without shared storage with"
465 " full copy of disk\n\t\t\t -i for migration without "
466 "shared storage with incremental copy of disk "
467 "(base image shared between src and destination)",
468 .user_print = monitor_user_noop,
469 .mhandler.cmd_new = do_migrate,
472 SQMP
473 migrate
474 -------
476 Migrate to URI.
478 Arguments:
480 - "blk": block migration, full disk copy (json-bool, optional)
481 - "inc": incremental disk copy (json-bool, optional)
482 - "uri": Destination URI (json-string)
484 Example:
486 -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
487 <- { "return": {} }
489 Notes:
491 (1) The 'query-migrate' command should be used to check migration's progress
492 and final result (this information is provided by the 'status' member)
493 (2) All boolean arguments default to false
494 (3) The user Monitor's "detach" argument is invalid in QMP and should not
495 be used
497 EQMP
500 .name = "migrate_cancel",
501 .args_type = "",
502 .params = "",
503 .help = "cancel the current VM migration",
504 .user_print = monitor_user_noop,
505 .mhandler.cmd_new = do_migrate_cancel,
508 SQMP
509 migrate_cancel
510 --------------
512 Cancel the current migration.
514 Arguments: None.
516 Example:
518 -> { "execute": "migrate_cancel" }
519 <- { "return": {} }
521 EQMP
524 .name = "migrate_set_speed",
525 .args_type = "value:o",
526 .params = "value",
527 .help = "set maximum speed (in bytes) for migrations",
528 .user_print = monitor_user_noop,
529 .mhandler.cmd_new = do_migrate_set_speed,
532 SQMP
533 migrate_set_speed
534 -----------------
536 Set maximum speed for migrations.
538 Arguments:
540 - "value": maximum speed, in bytes per second (json-int)
542 Example:
544 -> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } }
545 <- { "return": {} }
547 EQMP
550 .name = "migrate_set_downtime",
551 .args_type = "value:T",
552 .params = "value",
553 .help = "set maximum tolerated downtime (in seconds) for migrations",
554 .user_print = monitor_user_noop,
555 .mhandler.cmd_new = do_migrate_set_downtime,
558 SQMP
559 migrate_set_downtime
560 --------------------
562 Set maximum tolerated downtime (in seconds) for migrations.
564 Arguments:
566 - "value": maximum downtime (json-number)
568 Example:
570 -> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } }
571 <- { "return": {} }
573 EQMP
576 .name = "client_migrate_info",
577 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
578 .params = "protocol hostname port tls-port cert-subject",
579 .help = "send migration info to spice/vnc client",
580 .user_print = monitor_user_noop,
581 .mhandler.cmd_new = client_migrate_info,
584 SQMP
585 client_migrate_info
586 ------------------
588 Set the spice/vnc connection info for the migration target. The spice/vnc
589 server will ask the spice/vnc client to automatically reconnect using the
590 new parameters (if specified) once the vm migration finished successfully.
592 Arguments:
594 - "protocol": protocol: "spice" or "vnc" (json-string)
595 - "hostname": migration target hostname (json-string)
596 - "port": spice/vnc tcp port for plaintext channels (json-int, optional)
597 - "tls-port": spice tcp port for tls-secured channels (json-int, optional)
598 - "cert-subject": server certificate subject (json-string, optional)
600 Example:
602 -> { "execute": "client_migrate_info",
603 "arguments": { "protocol": "spice",
604 "hostname": "virt42.lab.kraxel.org",
605 "port": 1234 } }
606 <- { "return": {} }
608 EQMP
611 .name = "netdev_add",
612 .args_type = "netdev:O",
613 .params = "[user|tap|socket],id=str[,prop=value][,...]",
614 .help = "add host network device",
615 .user_print = monitor_user_noop,
616 .mhandler.cmd_new = do_netdev_add,
619 SQMP
620 netdev_add
621 ----------
623 Add host network device.
625 Arguments:
627 - "type": the device type, "tap", "user", ... (json-string)
628 - "id": the device's ID, must be unique (json-string)
629 - device options
631 Example:
633 -> { "execute": "netdev_add", "arguments": { "type": "user", "id": "netdev1" } }
634 <- { "return": {} }
636 Note: The supported device options are the same ones supported by the '-net'
637 command-line argument, which are listed in the '-help' output or QEMU's
638 manual
640 EQMP
643 .name = "netdev_del",
644 .args_type = "id:s",
645 .params = "id",
646 .help = "remove host network device",
647 .user_print = monitor_user_noop,
648 .mhandler.cmd_new = do_netdev_del,
651 SQMP
652 netdev_del
653 ----------
655 Remove host network device.
657 Arguments:
659 - "id": the device's ID, must be unique (json-string)
661 Example:
663 -> { "execute": "netdev_del", "arguments": { "id": "netdev1" } }
664 <- { "return": {} }
667 EQMP
670 .name = "block_resize",
671 .args_type = "device:B,size:o",
672 .params = "device size",
673 .help = "resize a block image",
674 .user_print = monitor_user_noop,
675 .mhandler.cmd_new = do_block_resize,
678 SQMP
679 block_resize
680 ------------
682 Resize a block image while a guest is running.
684 Arguments:
686 - "device": the device's ID, must be unique (json-string)
687 - "size": new size
689 Example:
691 -> { "execute": "block_resize", "arguments": { "device": "scratch", "size": 1073741824 } }
692 <- { "return": {} }
694 EQMP
697 .name = "balloon",
698 .args_type = "value:M",
699 .params = "target",
700 .help = "request VM to change its memory allocation (in MB)",
701 .user_print = monitor_user_noop,
702 .mhandler.cmd_async = do_balloon,
703 .flags = MONITOR_CMD_ASYNC,
706 SQMP
707 balloon
708 -------
710 Request VM to change its memory allocation (in bytes).
712 Arguments:
714 - "value": New memory allocation (json-int)
716 Example:
718 -> { "execute": "balloon", "arguments": { "value": 536870912 } }
719 <- { "return": {} }
721 EQMP
724 .name = "set_link",
725 .args_type = "name:s,up:b",
726 .params = "name on|off",
727 .help = "change the link status of a network adapter",
728 .user_print = monitor_user_noop,
729 .mhandler.cmd_new = do_set_link,
732 SQMP
733 set_link
734 --------
736 Change the link status of a network adapter.
738 Arguments:
740 - "name": network device name (json-string)
741 - "up": status is up (json-bool)
743 Example:
745 -> { "execute": "set_link", "arguments": { "name": "e1000.0", "up": false } }
746 <- { "return": {} }
748 EQMP
751 .name = "getfd",
752 .args_type = "fdname:s",
753 .params = "getfd name",
754 .help = "receive a file descriptor via SCM rights and assign it a name",
755 .user_print = monitor_user_noop,
756 .mhandler.cmd_new = do_getfd,
759 SQMP
760 getfd
761 -----
763 Receive a file descriptor via SCM rights and assign it a name.
765 Arguments:
767 - "fdname": file descriptor name (json-string)
769 Example:
771 -> { "execute": "getfd", "arguments": { "fdname": "fd1" } }
772 <- { "return": {} }
774 EQMP
777 .name = "closefd",
778 .args_type = "fdname:s",
779 .params = "closefd name",
780 .help = "close a file descriptor previously passed via SCM rights",
781 .user_print = monitor_user_noop,
782 .mhandler.cmd_new = do_closefd,
785 SQMP
786 closefd
787 -------
789 Close a file descriptor previously passed via SCM rights.
791 Arguments:
793 - "fdname": file descriptor name (json-string)
795 Example:
797 -> { "execute": "closefd", "arguments": { "fdname": "fd1" } }
798 <- { "return": {} }
800 EQMP
803 .name = "block_passwd",
804 .args_type = "device:B,password:s",
805 .params = "block_passwd device password",
806 .help = "set the password of encrypted block devices",
807 .user_print = monitor_user_noop,
808 .mhandler.cmd_new = do_block_set_passwd,
811 SQMP
812 block_passwd
813 ------------
815 Set the password of encrypted block devices.
817 Arguments:
819 - "device": device name (json-string)
820 - "password": password (json-string)
822 Example:
824 -> { "execute": "block_passwd", "arguments": { "device": "ide0-hd0",
825 "password": "12345" } }
826 <- { "return": {} }
828 EQMP
831 .name = "set_password",
832 .args_type = "protocol:s,password:s,connected:s?",
833 .params = "protocol password action-if-connected",
834 .help = "set spice/vnc password",
835 .user_print = monitor_user_noop,
836 .mhandler.cmd_new = set_password,
839 SQMP
840 set_password
841 ------------
843 Set the password for vnc/spice protocols.
845 Arguments:
847 - "protocol": protocol name (json-string)
848 - "password": password (json-string)
849 - "connected": [ keep | disconnect | fail ] (josn-string, optional)
851 Example:
853 -> { "execute": "set_password", "arguments": { "protocol": "vnc",
854 "password": "secret" } }
855 <- { "return": {} }
857 EQMP
860 .name = "expire_password",
861 .args_type = "protocol:s,time:s",
862 .params = "protocol time",
863 .help = "set spice/vnc password expire-time",
864 .user_print = monitor_user_noop,
865 .mhandler.cmd_new = expire_password,
868 SQMP
869 expire_password
870 ---------------
872 Set the password expire time for vnc/spice protocols.
874 Arguments:
876 - "protocol": protocol name (json-string)
877 - "time": [ now | never | +secs | secs ] (json-string)
879 Example:
881 -> { "execute": "expire_password", "arguments": { "protocol": "vnc",
882 "time": "+60" } }
883 <- { "return": {} }
885 EQMP
888 .name = "qmp_capabilities",
889 .args_type = "",
890 .params = "",
891 .help = "enable QMP capabilities",
892 .user_print = monitor_user_noop,
893 .mhandler.cmd_new = do_qmp_capabilities,
896 SQMP
897 qmp_capabilities
898 ----------------
900 Enable QMP capabilities.
902 Arguments: None.
904 Example:
906 -> { "execute": "qmp_capabilities" }
907 <- { "return": {} }
909 Note: This command must be issued before issuing any other command.
911 EQMP
914 .name = "human-monitor-command",
915 .args_type = "command-line:s,cpu-index:i?",
916 .params = "",
917 .help = "",
918 .user_print = monitor_user_noop,
919 .mhandler.cmd_new = do_hmp_passthrough,
922 SQMP
923 human-monitor-command
924 ---------------------
926 Execute a Human Monitor command.
928 Arguments:
930 - command-line: the command name and its arguments, just like the
931 Human Monitor's shell (json-string)
932 - cpu-index: select the CPU number to be used by commands which access CPU
933 data, like 'info registers'. The Monitor selects CPU 0 if this
934 argument is not provided (json-int, optional)
936 Example:
938 -> { "execute": "human-monitor-command", "arguments": { "command-line": "info kvm" } }
939 <- { "return": "kvm support: enabled\r\n" }
941 Notes:
943 (1) The Human Monitor is NOT an stable interface, this means that command
944 names, arguments and responses can change or be removed at ANY time.
945 Applications that rely on long term stability guarantees should NOT
946 use this command
948 (2) Limitations:
950 o This command is stateless, this means that commands that depend
951 on state information (such as getfd) might not work
953 o Commands that prompt the user for data (eg. 'cont' when the block
954 device is encrypted) don't currently work
956 3. Query Commands
957 =================
959 HXCOMM Each query command below is inside a SQMP/EQMP section, do NOT change
960 HXCOMM this! We will possibly move query commands definitions inside those
961 HXCOMM sections, just like regular commands.
963 EQMP
965 SQMP
966 query-version
967 -------------
969 Show QEMU version.
971 Return a json-object with the following information:
973 - "qemu": A json-object containing three integer values:
974 - "major": QEMU's major version (json-int)
975 - "minor": QEMU's minor version (json-int)
976 - "micro": QEMU's micro version (json-int)
977 - "package": package's version (json-string)
979 Example:
981 -> { "execute": "query-version" }
982 <- {
983 "return":{
984 "qemu":{
985 "major":0,
986 "minor":11,
987 "micro":5
989 "package":""
993 EQMP
995 SQMP
996 query-commands
997 --------------
999 List QMP available commands.
1001 Each command is represented by a json-object, the returned value is a json-array
1002 of all commands.
1004 Each json-object contain:
1006 - "name": command's name (json-string)
1008 Example:
1010 -> { "execute": "query-commands" }
1011 <- {
1012 "return":[
1014 "name":"query-balloon"
1017 "name":"system_powerdown"
1022 Note: This example has been shortened as the real response is too long.
1024 EQMP
1026 SQMP
1027 query-chardev
1028 -------------
1030 Each device is represented by a json-object. The returned value is a json-array
1031 of all devices.
1033 Each json-object contain the following:
1035 - "label": device's label (json-string)
1036 - "filename": device's file (json-string)
1038 Example:
1040 -> { "execute": "query-chardev" }
1041 <- {
1042 "return":[
1044 "label":"monitor",
1045 "filename":"stdio"
1048 "label":"serial0",
1049 "filename":"vc"
1054 EQMP
1056 SQMP
1057 query-block
1058 -----------
1060 Show the block devices.
1062 Each block device information is stored in a json-object and the returned value
1063 is a json-array of all devices.
1065 Each json-object contain the following:
1067 - "device": device name (json-string)
1068 - "type": device type (json-string)
1069 - deprecated, retained for backward compatibility
1070 - Possible values: "unknown"
1071 - "removable": true if the device is removable, false otherwise (json-bool)
1072 - "locked": true if the device is locked, false otherwise (json-bool)
1073 - "inserted": only present if the device is inserted, it is a json-object
1074 containing the following:
1075 - "file": device file name (json-string)
1076 - "ro": true if read-only, false otherwise (json-bool)
1077 - "drv": driver format name (json-string)
1078 - Possible values: "blkdebug", "bochs", "cloop", "cow", "dmg",
1079 "file", "file", "ftp", "ftps", "host_cdrom",
1080 "host_device", "host_floppy", "http", "https",
1081 "nbd", "parallels", "qcow", "qcow2", "raw",
1082 "tftp", "vdi", "vmdk", "vpc", "vvfat"
1083 - "backing_file": backing file name (json-string, optional)
1084 - "encrypted": true if encrypted, false otherwise (json-bool)
1086 Example:
1088 -> { "execute": "query-block" }
1089 <- {
1090 "return":[
1092 "device":"ide0-hd0",
1093 "locked":false,
1094 "removable":false,
1095 "inserted":{
1096 "ro":false,
1097 "drv":"qcow2",
1098 "encrypted":false,
1099 "file":"disks/test.img"
1101 "type":"unknown"
1104 "device":"ide1-cd0",
1105 "locked":false,
1106 "removable":true,
1107 "type":"unknown"
1110 "device":"floppy0",
1111 "locked":false,
1112 "removable":true,
1113 "type":"unknown"
1116 "device":"sd0",
1117 "locked":false,
1118 "removable":true,
1119 "type":"unknown"
1124 EQMP
1126 SQMP
1127 query-blockstats
1128 ----------------
1130 Show block device statistics.
1132 Each device statistic information is stored in a json-object and the returned
1133 value is a json-array of all devices.
1135 Each json-object contain the following:
1137 - "device": device name (json-string)
1138 - "stats": A json-object with the statistics information, it contains:
1139 - "rd_bytes": bytes read (json-int)
1140 - "wr_bytes": bytes written (json-int)
1141 - "rd_operations": read operations (json-int)
1142 - "wr_operations": write operations (json-int)
1143 - "wr_highest_offset": Highest offset of a sector written since the
1144 BlockDriverState has been opened (json-int)
1145 - "parent": Contains recursively the statistics of the underlying
1146 protocol (e.g. the host file for a qcow2 image). If there is
1147 no underlying protocol, this field is omitted
1148 (json-object, optional)
1150 Example:
1152 -> { "execute": "query-blockstats" }
1153 <- {
1154 "return":[
1156 "device":"ide0-hd0",
1157 "parent":{
1158 "stats":{
1159 "wr_highest_offset":3686448128,
1160 "wr_bytes":9786368,
1161 "wr_operations":751,
1162 "rd_bytes":122567168,
1163 "rd_operations":36772
1166 "stats":{
1167 "wr_highest_offset":2821110784,
1168 "wr_bytes":9786368,
1169 "wr_operations":692,
1170 "rd_bytes":122739200,
1171 "rd_operations":36604
1175 "device":"ide1-cd0",
1176 "stats":{
1177 "wr_highest_offset":0,
1178 "wr_bytes":0,
1179 "wr_operations":0,
1180 "rd_bytes":0,
1181 "rd_operations":0
1185 "device":"floppy0",
1186 "stats":{
1187 "wr_highest_offset":0,
1188 "wr_bytes":0,
1189 "wr_operations":0,
1190 "rd_bytes":0,
1191 "rd_operations":0
1195 "device":"sd0",
1196 "stats":{
1197 "wr_highest_offset":0,
1198 "wr_bytes":0,
1199 "wr_operations":0,
1200 "rd_bytes":0,
1201 "rd_operations":0
1207 EQMP
1209 SQMP
1210 query-cpus
1211 ----------
1213 Show CPU information.
1215 Return a json-array. Each CPU is represented by a json-object, which contains:
1217 - "CPU": CPU index (json-int)
1218 - "current": true if this is the current CPU, false otherwise (json-bool)
1219 - "halted": true if the cpu is halted, false otherwise (json-bool)
1220 - Current program counter. The key's name depends on the architecture:
1221 "pc": i386/x86_64 (json-int)
1222 "nip": PPC (json-int)
1223 "pc" and "npc": sparc (json-int)
1224 "PC": mips (json-int)
1225 - "thread_id": ID of the underlying host thread (json-int)
1227 Example:
1229 -> { "execute": "query-cpus" }
1230 <- {
1231 "return":[
1233 "CPU":0,
1234 "current":true,
1235 "halted":false,
1236 "pc":3227107138
1237 "thread_id":3134
1240 "CPU":1,
1241 "current":false,
1242 "halted":true,
1243 "pc":7108165
1244 "thread_id":3135
1249 EQMP
1251 SQMP
1252 query-pci
1253 ---------
1255 PCI buses and devices information.
1257 The returned value is a json-array of all buses. Each bus is represented by
1258 a json-object, which has a key with a json-array of all PCI devices attached
1259 to it. Each device is represented by a json-object.
1261 The bus json-object contains the following:
1263 - "bus": bus number (json-int)
1264 - "devices": a json-array of json-objects, each json-object represents a
1265 PCI device
1267 The PCI device json-object contains the following:
1269 - "bus": identical to the parent's bus number (json-int)
1270 - "slot": slot number (json-int)
1271 - "function": function number (json-int)
1272 - "class_info": a json-object containing:
1273 - "desc": device class description (json-string, optional)
1274 - "class": device class number (json-int)
1275 - "id": a json-object containing:
1276 - "device": device ID (json-int)
1277 - "vendor": vendor ID (json-int)
1278 - "irq": device's IRQ if assigned (json-int, optional)
1279 - "qdev_id": qdev id string (json-string)
1280 - "pci_bridge": It's a json-object, only present if this device is a
1281 PCI bridge, contains:
1282 - "bus": bus number (json-int)
1283 - "secondary": secondary bus number (json-int)
1284 - "subordinate": subordinate bus number (json-int)
1285 - "io_range": I/O memory range information, a json-object with the
1286 following members:
1287 - "base": base address, in bytes (json-int)
1288 - "limit": limit address, in bytes (json-int)
1289 - "memory_range": memory range information, a json-object with the
1290 following members:
1291 - "base": base address, in bytes (json-int)
1292 - "limit": limit address, in bytes (json-int)
1293 - "prefetchable_range": Prefetchable memory range information, a
1294 json-object with the following members:
1295 - "base": base address, in bytes (json-int)
1296 - "limit": limit address, in bytes (json-int)
1297 - "devices": a json-array of PCI devices if there's any attached, each
1298 each element is represented by a json-object, which contains
1299 the same members of the 'PCI device json-object' described
1300 above (optional)
1301 - "regions": a json-array of json-objects, each json-object represents a
1302 memory region of this device
1304 The memory range json-object contains the following:
1306 - "base": base memory address (json-int)
1307 - "limit": limit value (json-int)
1309 The region json-object can be an I/O region or a memory region, an I/O region
1310 json-object contains the following:
1312 - "type": "io" (json-string, fixed)
1313 - "bar": BAR number (json-int)
1314 - "address": memory address (json-int)
1315 - "size": memory size (json-int)
1317 A memory region json-object contains the following:
1319 - "type": "memory" (json-string, fixed)
1320 - "bar": BAR number (json-int)
1321 - "address": memory address (json-int)
1322 - "size": memory size (json-int)
1323 - "mem_type_64": true or false (json-bool)
1324 - "prefetch": true or false (json-bool)
1326 Example:
1328 -> { "execute": "query-pci" }
1329 <- {
1330 "return":[
1332 "bus":0,
1333 "devices":[
1335 "bus":0,
1336 "qdev_id":"",
1337 "slot":0,
1338 "class_info":{
1339 "class":1536,
1340 "desc":"Host bridge"
1342 "id":{
1343 "device":32902,
1344 "vendor":4663
1346 "function":0,
1347 "regions":[
1352 "bus":0,
1353 "qdev_id":"",
1354 "slot":1,
1355 "class_info":{
1356 "class":1537,
1357 "desc":"ISA bridge"
1359 "id":{
1360 "device":32902,
1361 "vendor":28672
1363 "function":0,
1364 "regions":[
1369 "bus":0,
1370 "qdev_id":"",
1371 "slot":1,
1372 "class_info":{
1373 "class":257,
1374 "desc":"IDE controller"
1376 "id":{
1377 "device":32902,
1378 "vendor":28688
1380 "function":1,
1381 "regions":[
1383 "bar":4,
1384 "size":16,
1385 "address":49152,
1386 "type":"io"
1391 "bus":0,
1392 "qdev_id":"",
1393 "slot":2,
1394 "class_info":{
1395 "class":768,
1396 "desc":"VGA controller"
1398 "id":{
1399 "device":4115,
1400 "vendor":184
1402 "function":0,
1403 "regions":[
1405 "prefetch":true,
1406 "mem_type_64":false,
1407 "bar":0,
1408 "size":33554432,
1409 "address":4026531840,
1410 "type":"memory"
1413 "prefetch":false,
1414 "mem_type_64":false,
1415 "bar":1,
1416 "size":4096,
1417 "address":4060086272,
1418 "type":"memory"
1421 "prefetch":false,
1422 "mem_type_64":false,
1423 "bar":6,
1424 "size":65536,
1425 "address":-1,
1426 "type":"memory"
1431 "bus":0,
1432 "qdev_id":"",
1433 "irq":11,
1434 "slot":4,
1435 "class_info":{
1436 "class":1280,
1437 "desc":"RAM controller"
1439 "id":{
1440 "device":6900,
1441 "vendor":4098
1443 "function":0,
1444 "regions":[
1446 "bar":0,
1447 "size":32,
1448 "address":49280,
1449 "type":"io"
1458 Note: This example has been shortened as the real response is too long.
1460 EQMP
1462 SQMP
1463 query-kvm
1464 ---------
1466 Show KVM information.
1468 Return a json-object with the following information:
1470 - "enabled": true if KVM support is enabled, false otherwise (json-bool)
1471 - "present": true if QEMU has KVM support, false otherwise (json-bool)
1473 Example:
1475 -> { "execute": "query-kvm" }
1476 <- { "return": { "enabled": true, "present": true } }
1478 EQMP
1480 SQMP
1481 query-status
1482 ------------
1484 Return a json-object with the following information:
1486 - "running": true if the VM is running, or false if it is paused (json-bool)
1487 - "singlestep": true if the VM is in single step mode,
1488 false otherwise (json-bool)
1490 Example:
1492 -> { "execute": "query-status" }
1493 <- { "return": { "running": true, "singlestep": false } }
1495 EQMP
1497 SQMP
1498 query-mice
1499 ----------
1501 Show VM mice information.
1503 Each mouse is represented by a json-object, the returned value is a json-array
1504 of all mice.
1506 The mouse json-object contains the following:
1508 - "name": mouse's name (json-string)
1509 - "index": mouse's index (json-int)
1510 - "current": true if this mouse is receiving events, false otherwise (json-bool)
1511 - "absolute": true if the mouse generates absolute input events (json-bool)
1513 Example:
1515 -> { "execute": "query-mice" }
1516 <- {
1517 "return":[
1519 "name":"QEMU Microsoft Mouse",
1520 "index":0,
1521 "current":false,
1522 "absolute":false
1525 "name":"QEMU PS/2 Mouse",
1526 "index":1,
1527 "current":true,
1528 "absolute":true
1533 EQMP
1535 SQMP
1536 query-vnc
1537 ---------
1539 Show VNC server information.
1541 Return a json-object with server information. Connected clients are returned
1542 as a json-array of json-objects.
1544 The main json-object contains the following:
1546 - "enabled": true or false (json-bool)
1547 - "host": server's IP address (json-string)
1548 - "family": address family (json-string)
1549 - Possible values: "ipv4", "ipv6", "unix", "unknown"
1550 - "service": server's port number (json-string)
1551 - "auth": authentication method (json-string)
1552 - Possible values: "invalid", "none", "ra2", "ra2ne", "sasl", "tight",
1553 "tls", "ultra", "unknown", "vencrypt", "vencrypt",
1554 "vencrypt+plain", "vencrypt+tls+none",
1555 "vencrypt+tls+plain", "vencrypt+tls+sasl",
1556 "vencrypt+tls+vnc", "vencrypt+x509+none",
1557 "vencrypt+x509+plain", "vencrypt+x509+sasl",
1558 "vencrypt+x509+vnc", "vnc"
1559 - "clients": a json-array of all connected clients
1561 Clients are described by a json-object, each one contain the following:
1563 - "host": client's IP address (json-string)
1564 - "family": address family (json-string)
1565 - Possible values: "ipv4", "ipv6", "unix", "unknown"
1566 - "service": client's port number (json-string)
1567 - "x509_dname": TLS dname (json-string, optional)
1568 - "sasl_username": SASL username (json-string, optional)
1570 Example:
1572 -> { "execute": "query-vnc" }
1573 <- {
1574 "return":{
1575 "enabled":true,
1576 "host":"0.0.0.0",
1577 "service":"50402",
1578 "auth":"vnc",
1579 "family":"ipv4",
1580 "clients":[
1582 "host":"127.0.0.1",
1583 "service":"50401",
1584 "family":"ipv4"
1590 EQMP
1592 SQMP
1593 query-spice
1594 -----------
1596 Show SPICE server information.
1598 Return a json-object with server information. Connected clients are returned
1599 as a json-array of json-objects.
1601 The main json-object contains the following:
1603 - "enabled": true or false (json-bool)
1604 - "host": server's IP address (json-string)
1605 - "port": server's port number (json-int, optional)
1606 - "tls-port": server's port number (json-int, optional)
1607 - "auth": authentication method (json-string)
1608 - Possible values: "none", "spice"
1609 - "channels": a json-array of all active channels clients
1611 Channels are described by a json-object, each one contain the following:
1613 - "host": client's IP address (json-string)
1614 - "family": address family (json-string)
1615 - Possible values: "ipv4", "ipv6", "unix", "unknown"
1616 - "port": client's port number (json-string)
1617 - "connection-id": spice connection id. All channels with the same id
1618 belong to the same spice session (json-int)
1619 - "channel-type": channel type. "1" is the main control channel, filter for
1620 this one if you want track spice sessions only (json-int)
1621 - "channel-id": channel id. Usually "0", might be different needed when
1622 multiple channels of the same type exist, such as multiple
1623 display channels in a multihead setup (json-int)
1624 - "tls": whevener the channel is encrypted (json-bool)
1626 Example:
1628 -> { "execute": "query-spice" }
1629 <- {
1630 "return": {
1631 "enabled": true,
1632 "auth": "spice",
1633 "port": 5920,
1634 "tls-port": 5921,
1635 "host": "0.0.0.0",
1636 "channels": [
1638 "port": "54924",
1639 "family": "ipv4",
1640 "channel-type": 1,
1641 "connection-id": 1804289383,
1642 "host": "127.0.0.1",
1643 "channel-id": 0,
1644 "tls": true
1647 "port": "36710",
1648 "family": "ipv4",
1649 "channel-type": 4,
1650 "connection-id": 1804289383,
1651 "host": "127.0.0.1",
1652 "channel-id": 0,
1653 "tls": false
1655 [ ... more channels follow ... ]
1660 EQMP
1662 SQMP
1663 query-name
1664 ----------
1666 Show VM name.
1668 Return a json-object with the following information:
1670 - "name": VM's name (json-string, optional)
1672 Example:
1674 -> { "execute": "query-name" }
1675 <- { "return": { "name": "qemu-name" } }
1677 EQMP
1679 SQMP
1680 query-uuid
1681 ----------
1683 Show VM UUID.
1685 Return a json-object with the following information:
1687 - "UUID": Universally Unique Identifier (json-string)
1689 Example:
1691 -> { "execute": "query-uuid" }
1692 <- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } }
1694 EQMP
1696 SQMP
1697 query-migrate
1698 -------------
1700 Migration status.
1702 Return a json-object. If migration is active there will be another json-object
1703 with RAM migration status and if block migration is active another one with
1704 block migration status.
1706 The main json-object contains the following:
1708 - "status": migration status (json-string)
1709 - Possible values: "active", "completed", "failed", "cancelled"
1710 - "ram": only present if "status" is "active", it is a json-object with the
1711 following RAM information (in bytes):
1712 - "transferred": amount transferred (json-int)
1713 - "remaining": amount remaining (json-int)
1714 - "total": total (json-int)
1715 - "disk": only present if "status" is "active" and it is a block migration,
1716 it is a json-object with the following disk information (in bytes):
1717 - "transferred": amount transferred (json-int)
1718 - "remaining": amount remaining (json-int)
1719 - "total": total (json-int)
1721 Examples:
1723 1. Before the first migration
1725 -> { "execute": "query-migrate" }
1726 <- { "return": {} }
1728 2. Migration is done and has succeeded
1730 -> { "execute": "query-migrate" }
1731 <- { "return": { "status": "completed" } }
1733 3. Migration is done and has failed
1735 -> { "execute": "query-migrate" }
1736 <- { "return": { "status": "failed" } }
1738 4. Migration is being performed and is not a block migration:
1740 -> { "execute": "query-migrate" }
1741 <- {
1742 "return":{
1743 "status":"active",
1744 "ram":{
1745 "transferred":123,
1746 "remaining":123,
1747 "total":246
1752 5. Migration is being performed and is a block migration:
1754 -> { "execute": "query-migrate" }
1755 <- {
1756 "return":{
1757 "status":"active",
1758 "ram":{
1759 "total":1057024,
1760 "remaining":1053304,
1761 "transferred":3720
1763 "disk":{
1764 "total":20971520,
1765 "remaining":20880384,
1766 "transferred":91136
1771 EQMP
1773 SQMP
1774 query-balloon
1775 -------------
1777 Show balloon information.
1779 Make an asynchronous request for balloon info. When the request completes a
1780 json-object will be returned containing the following data:
1782 - "actual": current balloon value in bytes (json-int)
1783 - "mem_swapped_in": Amount of memory swapped in bytes (json-int, optional)
1784 - "mem_swapped_out": Amount of memory swapped out in bytes (json-int, optional)
1785 - "major_page_faults": Number of major faults (json-int, optional)
1786 - "minor_page_faults": Number of minor faults (json-int, optional)
1787 - "free_mem": Total amount of free and unused memory in
1788 bytes (json-int, optional)
1789 - "total_mem": Total amount of available memory in bytes (json-int, optional)
1791 Example:
1793 -> { "execute": "query-balloon" }
1794 <- {
1795 "return":{
1796 "actual":1073741824,
1797 "mem_swapped_in":0,
1798 "mem_swapped_out":0,
1799 "major_page_faults":142,
1800 "minor_page_faults":239245,
1801 "free_mem":1014185984,
1802 "total_mem":1044668416
1806 EQMP