vmxnet3: Use common MAC address tracing macros
[qemu.git] / qmp-commands.hx
1 HXCOMM QMP dispatch table and documentation
2 HXCOMM Text between SQMP and EQMP is copied to the QMP documentation file and
3 HXCOMM does not show up in the other formats.
4
5 SQMP
6                         QMP Supported Commands
7                         ----------------------
8
9 This document describes all commands currently supported by QMP.
10
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.
14
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.
18
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.
22
23 Also, the following notation is used to denote data flow:
24
25 -> data issued by the Client
26 <- Server data response
27
28 Please, refer to the QMP specification (QMP/qmp-spec.txt) for detailed
29 information on the Server command and response formats.
30
31 NOTE: This document is temporary and will be replaced soon.
32
33 1. Stability Considerations
34 ===========================
35
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.
39
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.
42
43 If you're planning to adopt QMP, please observe the following:
44
45     1. The deprecation policy will take effect and be documented soon, please
46        check the documentation of each used command as soon as a new release of
47        QEMU is available
48
49     2. DO NOT rely on anything which is not explicit documented
50
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)
54
55 2. Regular Commands
56 ===================
57
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.
60
61 EQMP
62
63     {
64         .name       = "quit",
65         .args_type  = "",
66         .mhandler.cmd_new = qmp_marshal_quit,
67     },
68
69 SQMP
70 quit
71 ----
72
73 Quit the emulator.
74
75 Arguments: None.
76
77 Example:
78
79 -> { "execute": "quit" }
80 <- { "return": {} }
81
82 EQMP
83
84     {
85         .name       = "eject",
86         .args_type  = "force:-f,device:B",
87         .mhandler.cmd_new = qmp_marshal_eject,
88     },
89
90 SQMP
91 eject
92 -----
93
94 Eject a removable medium.
95
96 Arguments: 
97
98 - force: force ejection (json-bool, optional)
99 - device: device name (json-string)
100
101 Example:
102
103 -> { "execute": "eject", "arguments": { "device": "ide1-cd0" } }
104 <- { "return": {} }
105
106 Note: The "force" argument defaults to false.
107
108 EQMP
109
110     {
111         .name       = "change",
112         .args_type  = "device:B,target:F,arg:s?",
113         .mhandler.cmd_new = qmp_marshal_change,
114     },
115
116 SQMP
117 change
118 ------
119
120 Change a removable medium or VNC configuration.
121
122 Arguments:
123
124 - "device": device name (json-string)
125 - "target": filename or item (json-string)
126 - "arg": additional argument (json-string, optional)
127
128 Examples:
129
130 1. Change a removable medium
131
132 -> { "execute": "change",
133              "arguments": { "device": "ide1-cd0",
134                             "target": "/srv/images/Fedora-12-x86_64-DVD.iso" } }
135 <- { "return": {} }
136
137 2. Change VNC password
138
139 -> { "execute": "change",
140              "arguments": { "device": "vnc", "target": "password",
141                             "arg": "foobar1" } }
142 <- { "return": {} }
143
144 EQMP
145
146     {
147         .name       = "screendump",
148         .args_type  = "filename:F",
149         .mhandler.cmd_new = qmp_marshal_screendump,
150     },
151
152 SQMP
153 screendump
154 ----------
155
156 Save screen into PPM image.
157
158 Arguments:
159
160 - "filename": file path (json-string)
161
162 Example:
163
164 -> { "execute": "screendump", "arguments": { "filename": "/tmp/image" } }
165 <- { "return": {} }
166
167 EQMP
168
169     {
170         .name       = "stop",
171         .args_type  = "",
172         .mhandler.cmd_new = qmp_marshal_stop,
173     },
174
175 SQMP
176 stop
177 ----
178
179 Stop the emulator.
180
181 Arguments: None.
182
183 Example:
184
185 -> { "execute": "stop" }
186 <- { "return": {} }
187
188 EQMP
189
190     {
191         .name       = "cont",
192         .args_type  = "",
193         .mhandler.cmd_new = qmp_marshal_cont,
194     },
195
196 SQMP
197 cont
198 ----
199
200 Resume emulation.
201
202 Arguments: None.
203
204 Example:
205
206 -> { "execute": "cont" }
207 <- { "return": {} }
208
209 EQMP
210
211     {
212         .name       = "system_wakeup",
213         .args_type  = "",
214         .mhandler.cmd_new = qmp_marshal_system_wakeup,
215     },
216
217 SQMP
218 system_wakeup
219 -------------
220
221 Wakeup guest from suspend.
222
223 Arguments: None.
224
225 Example:
226
227 -> { "execute": "system_wakeup" }
228 <- { "return": {} }
229
230 EQMP
231
232     {
233         .name       = "system_reset",
234         .args_type  = "",
235         .mhandler.cmd_new = qmp_marshal_system_reset,
236     },
237
238 SQMP
239 system_reset
240 ------------
241
242 Reset the system.
243
244 Arguments: None.
245
246 Example:
247
248 -> { "execute": "system_reset" }
249 <- { "return": {} }
250
251 EQMP
252
253     {
254         .name       = "system_powerdown",
255         .args_type  = "",
256         .mhandler.cmd_new = qmp_marshal_system_powerdown,
257     },
258
259 SQMP
260 system_powerdown
261 ----------------
262
263 Send system power down event.
264
265 Arguments: None.
266
267 Example:
268
269 -> { "execute": "system_powerdown" }
270 <- { "return": {} }
271
272 EQMP
273
274     {
275         .name       = "device_add",
276         .args_type  = "device:O",
277         .params     = "driver[,prop=value][,...]",
278         .help       = "add device, like -device on the command line",
279         .mhandler.cmd_new = qmp_device_add,
280     },
281
282 SQMP
283 device_add
284 ----------
285
286 Add a device.
287
288 Arguments:
289
290 - "driver": the name of the new device's driver (json-string)
291 - "bus": the device's parent bus (device tree path, json-string, optional)
292 - "id": the device's ID, must be unique (json-string)
293 - device properties
294
295 Example:
296
297 -> { "execute": "device_add", "arguments": { "driver": "e1000", "id": "net1" } }
298 <- { "return": {} }
299
300 Notes:
301
302 (1) For detailed information about this command, please refer to the
303     'docs/qdev-device-use.txt' file.
304
305 (2) It's possible to list device properties by running QEMU with the
306     "-device DEVICE,\?" command-line argument, where DEVICE is the device's name
307
308 EQMP
309
310     {
311         .name       = "device_del",
312         .args_type  = "id:s",
313         .mhandler.cmd_new = qmp_marshal_device_del,
314     },
315
316 SQMP
317 device_del
318 ----------
319
320 Remove a device.
321
322 Arguments:
323
324 - "id": the device's ID or QOM path (json-string)
325
326 Example:
327
328 -> { "execute": "device_del", "arguments": { "id": "net1" } }
329 <- { "return": {} }
330
331 Example:
332
333 -> { "execute": "device_del", "arguments": { "id": "/machine/peripheral-anon/device[0]" } }
334 <- { "return": {} }
335
336 EQMP
337
338     {
339         .name       = "send-key",
340         .args_type  = "keys:q,hold-time:i?",
341         .mhandler.cmd_new = qmp_marshal_send_key,
342     },
343
344 SQMP
345 send-key
346 ----------
347
348 Send keys to VM.
349
350 Arguments:
351
352 keys array:
353     - "key": key sequence (a json-array of key union values,
354              union can be number or qcode enum)
355
356 - hold-time: time to delay key up events, milliseconds. Defaults to 100
357              (json-int, optional)
358
359 Example:
360
361 -> { "execute": "send-key",
362      "arguments": { "keys": [ { "type": "qcode", "data": "ctrl" },
363                               { "type": "qcode", "data": "alt" },
364                               { "type": "qcode", "data": "delete" } ] } }
365 <- { "return": {} }
366
367 EQMP
368
369     {
370         .name       = "cpu",
371         .args_type  = "index:i",
372         .mhandler.cmd_new = qmp_marshal_cpu,
373     },
374
375 SQMP
376 cpu
377 ---
378
379 Set the default CPU.
380
381 Arguments:
382
383 - "index": the CPU's index (json-int)
384
385 Example:
386
387 -> { "execute": "cpu", "arguments": { "index": 0 } }
388 <- { "return": {} }
389
390 Note: CPUs' indexes are obtained with the 'query-cpus' command.
391
392 EQMP
393
394     {
395         .name       = "cpu-add",
396         .args_type  = "id:i",
397         .mhandler.cmd_new = qmp_marshal_cpu_add,
398     },
399
400 SQMP
401 cpu-add
402 -------
403
404 Adds virtual cpu
405
406 Arguments:
407
408 - "id": cpu id (json-int)
409
410 Example:
411
412 -> { "execute": "cpu-add", "arguments": { "id": 2 } }
413 <- { "return": {} }
414
415 EQMP
416
417     {
418         .name       = "memsave",
419         .args_type  = "val:l,size:i,filename:s,cpu:i?",
420         .mhandler.cmd_new = qmp_marshal_memsave,
421     },
422
423 SQMP
424 memsave
425 -------
426
427 Save to disk virtual memory dump starting at 'val' of size 'size'.
428
429 Arguments:
430
431 - "val": the starting address (json-int)
432 - "size": the memory size, in bytes (json-int)
433 - "filename": file path (json-string)
434 - "cpu": virtual CPU index (json-int, optional)
435
436 Example:
437
438 -> { "execute": "memsave",
439              "arguments": { "val": 10,
440                             "size": 100,
441                             "filename": "/tmp/virtual-mem-dump" } }
442 <- { "return": {} }
443
444 EQMP
445
446     {
447         .name       = "pmemsave",
448         .args_type  = "val:l,size:i,filename:s",
449         .mhandler.cmd_new = qmp_marshal_pmemsave,
450     },
451
452 SQMP
453 pmemsave
454 --------
455
456 Save to disk physical memory dump starting at 'val' of size 'size'.
457
458 Arguments:
459
460 - "val": the starting address (json-int)
461 - "size": the memory size, in bytes (json-int)
462 - "filename": file path (json-string)
463
464 Example:
465
466 -> { "execute": "pmemsave",
467              "arguments": { "val": 10,
468                             "size": 100,
469                             "filename": "/tmp/physical-mem-dump" } }
470 <- { "return": {} }
471
472 EQMP
473
474     {
475         .name       = "inject-nmi",
476         .args_type  = "",
477         .mhandler.cmd_new = qmp_marshal_inject_nmi,
478     },
479
480 SQMP
481 inject-nmi
482 ----------
483
484 Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
485
486 Arguments: None.
487
488 Example:
489
490 -> { "execute": "inject-nmi" }
491 <- { "return": {} }
492
493 Note: inject-nmi fails when the guest doesn't support injecting.
494
495 EQMP
496
497     {
498         .name       = "ringbuf-write",
499         .args_type  = "device:s,data:s,format:s?",
500         .mhandler.cmd_new = qmp_marshal_ringbuf_write,
501     },
502
503 SQMP
504 ringbuf-write
505 -------------
506
507 Write to a ring buffer character device.
508
509 Arguments:
510
511 - "device": ring buffer character device name (json-string)
512 - "data": data to write (json-string)
513 - "format": data format (json-string, optional)
514           - Possible values: "utf8" (default), "base64"
515
516 Example:
517
518 -> { "execute": "ringbuf-write",
519                 "arguments": { "device": "foo",
520                                "data": "abcdefgh",
521                                "format": "utf8" } }
522 <- { "return": {} }
523
524 EQMP
525
526     {
527         .name       = "ringbuf-read",
528         .args_type  = "device:s,size:i,format:s?",
529         .mhandler.cmd_new = qmp_marshal_ringbuf_read,
530     },
531
532 SQMP
533 ringbuf-read
534 -------------
535
536 Read from a ring buffer character device.
537
538 Arguments:
539
540 - "device": ring buffer character device name (json-string)
541 - "size": how many bytes to read at most (json-int)
542           - Number of data bytes, not number of characters in encoded data
543 - "format": data format (json-string, optional)
544           - Possible values: "utf8" (default), "base64"
545           - Naturally, format "utf8" works only when the ring buffer
546             contains valid UTF-8 text.  Invalid UTF-8 sequences get
547             replaced.  Bug: replacement doesn't work.  Bug: can screw
548             up on encountering NUL characters, after the ring buffer
549             lost data, and when reading stops because the size limit
550             is reached.
551
552 Example:
553
554 -> { "execute": "ringbuf-read",
555                 "arguments": { "device": "foo",
556                                "size": 1000,
557                                "format": "utf8" } }
558 <- {"return": "abcdefgh"}
559
560 EQMP
561
562     {
563         .name       = "xen-save-devices-state",
564         .args_type  = "filename:F",
565     .mhandler.cmd_new = qmp_marshal_xen_save_devices_state,
566     },
567
568 SQMP
569 xen-save-devices-state
570 -------
571
572 Save the state of all devices to file. The RAM and the block devices
573 of the VM are not saved by this command.
574
575 Arguments:
576
577 - "filename": the file to save the state of the devices to as binary
578 data. See xen-save-devices-state.txt for a description of the binary
579 format.
580
581 Example:
582
583 -> { "execute": "xen-save-devices-state",
584      "arguments": { "filename": "/tmp/save" } }
585 <- { "return": {} }
586
587 EQMP
588
589     {
590         .name       = "xen-set-global-dirty-log",
591         .args_type  = "enable:b",
592         .mhandler.cmd_new = qmp_marshal_xen_set_global_dirty_log,
593     },
594
595 SQMP
596 xen-set-global-dirty-log
597 -------
598
599 Enable or disable the global dirty log mode.
600
601 Arguments:
602
603 - "enable": Enable it or disable it.
604
605 Example:
606
607 -> { "execute": "xen-set-global-dirty-log",
608      "arguments": { "enable": true } }
609 <- { "return": {} }
610
611 EQMP
612
613     {
614         .name       = "migrate",
615         .args_type  = "detach:-d,blk:-b,inc:-i,uri:s",
616         .mhandler.cmd_new = qmp_marshal_migrate,
617     },
618
619 SQMP
620 migrate
621 -------
622
623 Migrate to URI.
624
625 Arguments:
626
627 - "blk": block migration, full disk copy (json-bool, optional)
628 - "inc": incremental disk copy (json-bool, optional)
629 - "uri": Destination URI (json-string)
630
631 Example:
632
633 -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
634 <- { "return": {} }
635
636 Notes:
637
638 (1) The 'query-migrate' command should be used to check migration's progress
639     and final result (this information is provided by the 'status' member)
640 (2) All boolean arguments default to false
641 (3) The user Monitor's "detach" argument is invalid in QMP and should not
642     be used
643
644 EQMP
645
646     {
647         .name       = "migrate_cancel",
648         .args_type  = "",
649         .mhandler.cmd_new = qmp_marshal_migrate_cancel,
650     },
651
652 SQMP
653 migrate_cancel
654 --------------
655
656 Cancel the current migration.
657
658 Arguments: None.
659
660 Example:
661
662 -> { "execute": "migrate_cancel" }
663 <- { "return": {} }
664
665 EQMP
666
667     {
668         .name       = "migrate-incoming",
669         .args_type  = "uri:s",
670         .mhandler.cmd_new = qmp_marshal_migrate_incoming,
671     },
672
673 SQMP
674 migrate-incoming
675 ----------------
676
677 Continue an incoming migration
678
679 Arguments:
680
681 - "uri": Source/listening URI (json-string)
682
683 Example:
684
685 -> { "execute": "migrate-incoming", "arguments": { "uri": "tcp::4446" } }
686 <- { "return": {} }
687
688 Notes:
689
690 (1) QEMU must be started with -incoming defer to allow migrate-incoming to
691     be used
692 (2) The uri format is the same as for -incoming
693
694 EQMP
695     {
696         .name       = "migrate-set-cache-size",
697         .args_type  = "value:o",
698         .mhandler.cmd_new = qmp_marshal_migrate_set_cache_size,
699     },
700
701 SQMP
702 migrate-set-cache-size
703 ----------------------
704
705 Set cache size to be used by XBZRLE migration, the cache size will be rounded
706 down to the nearest power of 2
707
708 Arguments:
709
710 - "value": cache size in bytes (json-int)
711
712 Example:
713
714 -> { "execute": "migrate-set-cache-size", "arguments": { "value": 536870912 } }
715 <- { "return": {} }
716
717 EQMP
718     {
719         .name       = "migrate-start-postcopy",
720         .args_type  = "",
721         .mhandler.cmd_new = qmp_marshal_migrate_start_postcopy,
722     },
723
724 SQMP
725 migrate-start-postcopy
726 ----------------------
727
728 Switch an in-progress migration to postcopy mode. Ignored after the end of
729 migration (or once already in postcopy).
730
731 Example:
732 -> { "execute": "migrate-start-postcopy" }
733 <- { "return": {} }
734
735 EQMP
736
737     {
738         .name       = "query-migrate-cache-size",
739         .args_type  = "",
740         .mhandler.cmd_new = qmp_marshal_query_migrate_cache_size,
741     },
742
743 SQMP
744 query-migrate-cache-size
745 ------------------------
746
747 Show cache size to be used by XBZRLE migration
748
749 returns a json-object with the following information:
750 - "size" : json-int
751
752 Example:
753
754 -> { "execute": "query-migrate-cache-size" }
755 <- { "return": 67108864 }
756
757 EQMP
758
759     {
760         .name       = "migrate_set_speed",
761         .args_type  = "value:o",
762         .mhandler.cmd_new = qmp_marshal_migrate_set_speed,
763     },
764
765 SQMP
766 migrate_set_speed
767 -----------------
768
769 Set maximum speed for migrations.
770
771 Arguments:
772
773 - "value": maximum speed, in bytes per second (json-int)
774
775 Example:
776
777 -> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } }
778 <- { "return": {} }
779
780 EQMP
781
782     {
783         .name       = "migrate_set_downtime",
784         .args_type  = "value:T",
785         .mhandler.cmd_new = qmp_marshal_migrate_set_downtime,
786     },
787
788 SQMP
789 migrate_set_downtime
790 --------------------
791
792 Set maximum tolerated downtime (in seconds) for migrations.
793
794 Arguments:
795
796 - "value": maximum downtime (json-number)
797
798 Example:
799
800 -> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } }
801 <- { "return": {} }
802
803 EQMP
804
805     {
806         .name       = "client_migrate_info",
807         .args_type  = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
808         .params     = "protocol hostname port tls-port cert-subject",
809         .help       = "set migration information for remote display",
810         .mhandler.cmd_new = qmp_marshal_client_migrate_info,
811     },
812
813 SQMP
814 client_migrate_info
815 -------------------
816
817 Set migration information for remote display.  This makes the server
818 ask the client to automatically reconnect using the new parameters
819 once migration finished successfully.  Only implemented for SPICE.
820
821 Arguments:
822
823 - "protocol":     must be "spice" (json-string)
824 - "hostname":     migration target hostname (json-string)
825 - "port":         spice tcp port for plaintext channels (json-int, optional)
826 - "tls-port":     spice tcp port for tls-secured channels (json-int, optional)
827 - "cert-subject": server certificate subject (json-string, optional)
828
829 Example:
830
831 -> { "execute": "client_migrate_info",
832      "arguments": { "protocol": "spice",
833                     "hostname": "virt42.lab.kraxel.org",
834                     "port": 1234 } }
835 <- { "return": {} }
836
837 EQMP
838
839     {
840         .name       = "dump-guest-memory",
841         .args_type  = "paging:b,protocol:s,detach:b?,begin:i?,end:i?,format:s?",
842         .params     = "-p protocol [-d] [begin] [length] [format]",
843         .help       = "dump guest memory to file",
844         .mhandler.cmd_new = qmp_marshal_dump_guest_memory,
845     },
846
847 SQMP
848 dump
849
850
851 Dump guest memory to file. The file can be processed with crash or gdb.
852
853 Arguments:
854
855 - "paging": do paging to get guest's memory mapping (json-bool)
856 - "protocol": destination file(started with "file:") or destination file
857               descriptor (started with "fd:") (json-string)
858 - "detach": if specified, command will return immediately, without waiting
859             for the dump to finish. The user can track progress using
860             "query-dump". (json-bool)
861 - "begin": the starting physical address. It's optional, and should be specified
862            with length together (json-int)
863 - "length": the memory size, in bytes. It's optional, and should be specified
864             with begin together (json-int)
865 - "format": the format of guest memory dump. It's optional, and can be
866             elf|kdump-zlib|kdump-lzo|kdump-snappy, but non-elf formats will
867             conflict with paging and filter, ie. begin and length (json-string)
868
869 Example:
870
871 -> { "execute": "dump-guest-memory", "arguments": { "protocol": "fd:dump" } }
872 <- { "return": {} }
873
874 Notes:
875
876 (1) All boolean arguments default to false
877
878 EQMP
879
880     {
881         .name       = "query-dump-guest-memory-capability",
882         .args_type  = "",
883     .mhandler.cmd_new = qmp_marshal_query_dump_guest_memory_capability,
884     },
885
886 SQMP
887 query-dump-guest-memory-capability
888 ----------
889
890 Show available formats for 'dump-guest-memory'
891
892 Example:
893
894 -> { "execute": "query-dump-guest-memory-capability" }
895 <- { "return": { "formats":
896                     ["elf", "kdump-zlib", "kdump-lzo", "kdump-snappy"] }
897
898 EQMP
899
900     {
901         .name       = "query-dump",
902         .args_type  = "",
903         .params     = "",
904         .help       = "query background dump status",
905         .mhandler.cmd_new = qmp_marshal_query_dump,
906     },
907
908 SQMP
909 query-dump
910 ----------
911
912 Query background dump status.
913
914 Arguments: None.
915
916 Example:
917
918 -> { "execute": "query-dump" }
919 <- { "return": { "status": "active", "completed": 1024000,
920                  "total": 2048000 } }
921
922 EQMP
923
924 #if defined TARGET_S390X
925     {
926         .name       = "dump-skeys",
927         .args_type  = "filename:F",
928         .mhandler.cmd_new = qmp_marshal_dump_skeys,
929     },
930 #endif
931
932 SQMP
933 dump-skeys
934 ----------
935
936 Save guest storage keys to file.
937
938 Arguments:
939
940 - "filename": file path (json-string)
941
942 Example:
943
944 -> { "execute": "dump-skeys", "arguments": { "filename": "/tmp/skeys" } }
945 <- { "return": {} }
946
947 EQMP
948
949     {
950         .name       = "netdev_add",
951         .args_type  = "netdev:O",
952         .mhandler.cmd_new = qmp_netdev_add,
953     },
954
955 SQMP
956 netdev_add
957 ----------
958
959 Add host network device.
960
961 Arguments:
962
963 - "type": the device type, "tap", "user", ... (json-string)
964 - "id": the device's ID, must be unique (json-string)
965 - device options
966
967 Example:
968
969 -> { "execute": "netdev_add",
970      "arguments": { "type": "user", "id": "netdev1",
971                     "dnssearch": "example.org" } }
972 <- { "return": {} }
973
974 Note: The supported device options are the same ones supported by the '-netdev'
975       command-line argument, which are listed in the '-help' output or QEMU's
976       manual
977
978 EQMP
979
980     {
981         .name       = "netdev_del",
982         .args_type  = "id:s",
983         .mhandler.cmd_new = qmp_marshal_netdev_del,
984     },
985
986 SQMP
987 netdev_del
988 ----------
989
990 Remove host network device.
991
992 Arguments:
993
994 - "id": the device's ID, must be unique (json-string)
995
996 Example:
997
998 -> { "execute": "netdev_del", "arguments": { "id": "netdev1" } }
999 <- { "return": {} }
1000
1001
1002 EQMP
1003
1004     {
1005         .name       = "object-add",
1006         .args_type  = "qom-type:s,id:s,props:q?",
1007         .mhandler.cmd_new = qmp_marshal_object_add,
1008     },
1009
1010 SQMP
1011 object-add
1012 ----------
1013
1014 Create QOM object.
1015
1016 Arguments:
1017
1018 - "qom-type": the object's QOM type, i.e. the class name (json-string)
1019 - "id": the object's ID, must be unique (json-string)
1020 - "props": a dictionary of object property values (optional, json-dict)
1021
1022 Example:
1023
1024 -> { "execute": "object-add", "arguments": { "qom-type": "rng-random", "id": "rng1",
1025      "props": { "filename": "/dev/hwrng" } } }
1026 <- { "return": {} }
1027
1028 EQMP
1029
1030     {
1031         .name       = "object-del",
1032         .args_type  = "id:s",
1033         .mhandler.cmd_new = qmp_marshal_object_del,
1034     },
1035
1036 SQMP
1037 object-del
1038 ----------
1039
1040 Remove QOM object.
1041
1042 Arguments:
1043
1044 - "id": the object's ID (json-string)
1045
1046 Example:
1047
1048 -> { "execute": "object-del", "arguments": { "id": "rng1" } }
1049 <- { "return": {} }
1050
1051
1052 EQMP
1053
1054
1055     {
1056         .name       = "block_resize",
1057         .args_type  = "device:s?,node-name:s?,size:o",
1058         .mhandler.cmd_new = qmp_marshal_block_resize,
1059     },
1060
1061 SQMP
1062 block_resize
1063 ------------
1064
1065 Resize a block image while a guest is running.
1066
1067 Arguments:
1068
1069 - "device": the device's ID, must be unique (json-string)
1070 - "node-name": the node name in the block driver state graph (json-string)
1071 - "size": new size
1072
1073 Example:
1074
1075 -> { "execute": "block_resize", "arguments": { "device": "scratch", "size": 1073741824 } }
1076 <- { "return": {} }
1077
1078 EQMP
1079
1080     {
1081         .name       = "block-stream",
1082         .args_type  = "device:B,base:s?,speed:o?,backing-file:s?,on-error:s?",
1083         .mhandler.cmd_new = qmp_marshal_block_stream,
1084     },
1085
1086 SQMP
1087 block-stream
1088 ------------
1089
1090 Copy data from a backing file into a block device.
1091
1092 Arguments:
1093
1094 - "device": The device's ID, must be unique (json-string)
1095 - "base": The file name of the backing image above which copying starts
1096           (json-string, optional)
1097 - "backing-file": The backing file string to write into the active layer. This
1098                   filename is not validated.
1099
1100                   If a pathname string is such that it cannot be resolved by
1101                   QEMU, that means that subsequent QMP or HMP commands must use
1102                   node-names for the image in question, as filename lookup
1103                   methods will fail.
1104
1105                   If not specified, QEMU will automatically determine the
1106                   backing file string to use, or error out if there is no
1107                   obvious choice.  Care should be taken when specifying the
1108                   string, to specify a valid filename or protocol.
1109                   (json-string, optional) (Since 2.1)
1110 - "speed":  the maximum speed, in bytes per second (json-int, optional)
1111 - "on-error": the action to take on an error (default 'report').  'stop' and
1112               'enospc' can only be used if the block device supports io-status.
1113               (json-string, optional) (Since 2.1)
1114
1115 Example:
1116
1117 -> { "execute": "block-stream", "arguments": { "device": "virtio0",
1118                                                "base": "/tmp/master.qcow2" } }
1119 <- { "return": {} }
1120
1121 EQMP
1122
1123     {
1124         .name       = "block-commit",
1125         .args_type  = "device:B,base:s?,top:s?,backing-file:s?,speed:o?",
1126         .mhandler.cmd_new = qmp_marshal_block_commit,
1127     },
1128
1129 SQMP
1130 block-commit
1131 ------------
1132
1133 Live commit of data from overlay image nodes into backing nodes - i.e., writes
1134 data between 'top' and 'base' into 'base'.
1135
1136 Arguments:
1137
1138 - "device": The device's ID, must be unique (json-string)
1139 - "base": The file name of the backing image to write data into.
1140           If not specified, this is the deepest backing image
1141           (json-string, optional)
1142 - "top":  The file name of the backing image within the image chain,
1143           which contains the topmost data to be committed down. If
1144           not specified, this is the active layer. (json-string, optional)
1145
1146 - backing-file:     The backing file string to write into the overlay
1147                     image of 'top'.  If 'top' is the active layer,
1148                     specifying a backing file string is an error. This
1149                     filename is not validated.
1150
1151                     If a pathname string is such that it cannot be
1152                     resolved by QEMU, that means that subsequent QMP or
1153                     HMP commands must use node-names for the image in
1154                     question, as filename lookup methods will fail.
1155
1156                     If not specified, QEMU will automatically determine
1157                     the backing file string to use, or error out if
1158                     there is no obvious choice. Care should be taken
1159                     when specifying the string, to specify a valid
1160                     filename or protocol.
1161                     (json-string, optional) (Since 2.1)
1162
1163           If top == base, that is an error.
1164           If top == active, the job will not be completed by itself,
1165           user needs to complete the job with the block-job-complete
1166           command after getting the ready event. (Since 2.0)
1167
1168           If the base image is smaller than top, then the base image
1169           will be resized to be the same size as top.  If top is
1170           smaller than the base image, the base will not be
1171           truncated.  If you want the base image size to match the
1172           size of the smaller top, you can safely truncate it
1173           yourself once the commit operation successfully completes.
1174           (json-string)
1175 - "speed":  the maximum speed, in bytes per second (json-int, optional)
1176
1177
1178 Example:
1179
1180 -> { "execute": "block-commit", "arguments": { "device": "virtio0",
1181                                               "top": "/tmp/snap1.qcow2" } }
1182 <- { "return": {} }
1183
1184 EQMP
1185
1186     {
1187         .name       = "drive-backup",
1188         .args_type  = "sync:s,device:B,target:s,speed:i?,mode:s?,format:s?,"
1189                       "bitmap:s?,on-source-error:s?,on-target-error:s?",
1190         .mhandler.cmd_new = qmp_marshal_drive_backup,
1191     },
1192
1193 SQMP
1194 drive-backup
1195 ------------
1196
1197 Start a point-in-time copy of a block device to a new destination.  The
1198 status of ongoing drive-backup operations can be checked with
1199 query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
1200 The operation can be stopped before it has completed using the
1201 block-job-cancel command.
1202
1203 Arguments:
1204
1205 - "device": the name of the device which should be copied.
1206             (json-string)
1207 - "target": the target of the new image. If the file exists, or if it is a
1208             device, the existing file/device will be used as the new
1209             destination.  If it does not exist, a new file will be created.
1210             (json-string)
1211 - "format": the format of the new destination, default is to probe if 'mode' is
1212             'existing', else the format of the source
1213             (json-string, optional)
1214 - "sync": what parts of the disk image should be copied to the destination;
1215   possibilities include "full" for all the disk, "top" for only the sectors
1216   allocated in the topmost image, "incremental" for only the dirty sectors in
1217   the bitmap, or "none" to only replicate new I/O (MirrorSyncMode).
1218 - "bitmap": dirty bitmap name for sync==incremental. Must be present if sync
1219             is "incremental", must NOT be present otherwise.
1220 - "mode": whether and how QEMU should create a new image
1221           (NewImageMode, optional, default 'absolute-paths')
1222 - "speed": the maximum speed, in bytes per second (json-int, optional)
1223 - "on-source-error": the action to take on an error on the source, default
1224                      'report'.  'stop' and 'enospc' can only be used
1225                      if the block device supports io-status.
1226                      (BlockdevOnError, optional)
1227 - "on-target-error": the action to take on an error on the target, default
1228                      'report' (no limitations, since this applies to
1229                      a different block device than device).
1230                      (BlockdevOnError, optional)
1231
1232 Example:
1233 -> { "execute": "drive-backup", "arguments": { "device": "drive0",
1234                                                "sync": "full",
1235                                                "target": "backup.img" } }
1236 <- { "return": {} }
1237
1238 EQMP
1239
1240     {
1241         .name       = "blockdev-backup",
1242         .args_type  = "sync:s,device:B,target:B,speed:i?,"
1243                       "on-source-error:s?,on-target-error:s?",
1244         .mhandler.cmd_new = qmp_marshal_blockdev_backup,
1245     },
1246
1247 SQMP
1248 blockdev-backup
1249 ---------------
1250
1251 The device version of drive-backup: this command takes an existing named device
1252 as backup target.
1253
1254 Arguments:
1255
1256 - "device": the name of the device which should be copied.
1257             (json-string)
1258 - "target": the name of the backup target device. (json-string)
1259 - "sync": what parts of the disk image should be copied to the destination;
1260           possibilities include "full" for all the disk, "top" for only the
1261           sectors allocated in the topmost image, or "none" to only replicate
1262           new I/O (MirrorSyncMode).
1263 - "speed": the maximum speed, in bytes per second (json-int, optional)
1264 - "on-source-error": the action to take on an error on the source, default
1265                      'report'.  'stop' and 'enospc' can only be used
1266                      if the block device supports io-status.
1267                      (BlockdevOnError, optional)
1268 - "on-target-error": the action to take on an error on the target, default
1269                      'report' (no limitations, since this applies to
1270                      a different block device than device).
1271                      (BlockdevOnError, optional)
1272
1273 Example:
1274 -> { "execute": "blockdev-backup", "arguments": { "device": "src-id",
1275                                                   "sync": "full",
1276                                                   "target": "tgt-id" } }
1277 <- { "return": {} }
1278
1279 EQMP
1280
1281     {
1282         .name       = "block-job-set-speed",
1283         .args_type  = "device:B,speed:o",
1284         .mhandler.cmd_new = qmp_marshal_block_job_set_speed,
1285     },
1286
1287     {
1288         .name       = "block-job-cancel",
1289         .args_type  = "device:B,force:b?",
1290         .mhandler.cmd_new = qmp_marshal_block_job_cancel,
1291     },
1292     {
1293         .name       = "block-job-pause",
1294         .args_type  = "device:B",
1295         .mhandler.cmd_new = qmp_marshal_block_job_pause,
1296     },
1297     {
1298         .name       = "block-job-resume",
1299         .args_type  = "device:B",
1300         .mhandler.cmd_new = qmp_marshal_block_job_resume,
1301     },
1302     {
1303         .name       = "block-job-complete",
1304         .args_type  = "device:B",
1305         .mhandler.cmd_new = qmp_marshal_block_job_complete,
1306     },
1307     {
1308         .name       = "transaction",
1309         .args_type  = "actions:q,properties:q?",
1310         .mhandler.cmd_new = qmp_marshal_transaction,
1311     },
1312
1313 SQMP
1314 transaction
1315 -----------
1316
1317 Atomically operate on one or more block devices.  Operations that are
1318 currently supported:
1319
1320     - drive-backup
1321     - blockdev-backup
1322     - blockdev-snapshot-sync
1323     - blockdev-snapshot-internal-sync
1324     - abort
1325     - block-dirty-bitmap-add
1326     - block-dirty-bitmap-clear
1327
1328 Refer to the qemu/qapi-schema.json file for minimum required QEMU
1329 versions for these operations.  A list of dictionaries is accepted,
1330 that contains the actions to be performed.  If there is any failure
1331 performing any of the operations, all operations for the group are
1332 abandoned.
1333
1334 For external snapshots, the dictionary contains the device, the file to use for
1335 the new snapshot, and the format.  The default format, if not specified, is
1336 qcow2.
1337
1338 Each new snapshot defaults to being created by QEMU (wiping any
1339 contents if the file already exists), but it is also possible to reuse
1340 an externally-created file.  In the latter case, you should ensure that
1341 the new image file has the same contents as the current one; QEMU cannot
1342 perform any meaningful check.  Typically this is achieved by using the
1343 current image file as the backing file for the new image.
1344
1345 On failure, the original disks pre-snapshot attempt will be used.
1346
1347 For internal snapshots, the dictionary contains the device and the snapshot's
1348 name.  If an internal snapshot matching name already exists, the request will
1349 be rejected.  Only some image formats support it, for example, qcow2, rbd,
1350 and sheepdog.
1351
1352 On failure, qemu will try delete the newly created internal snapshot in the
1353 transaction.  When an I/O error occurs during deletion, the user needs to fix
1354 it later with qemu-img or other command.
1355
1356 Arguments:
1357
1358 actions array:
1359     - "type": the operation to perform (json-string).  Possible
1360               values: "drive-backup", "blockdev-backup",
1361                       "blockdev-snapshot-sync",
1362                       "blockdev-snapshot-internal-sync",
1363                       "abort", "block-dirty-bitmap-add",
1364                       "block-dirty-bitmap-clear"
1365     - "data": a dictionary.  The contents depend on the value
1366       of "type".  When "type" is "blockdev-snapshot-sync":
1367       - "device": device name to snapshot (json-string)
1368       - "node-name": graph node name to snapshot (json-string)
1369       - "snapshot-file": name of new image file (json-string)
1370       - "snapshot-node-name": graph node name of the new snapshot (json-string)
1371       - "format": format of new image (json-string, optional)
1372       - "mode": whether and how QEMU should create the snapshot file
1373         (NewImageMode, optional, default "absolute-paths")
1374       When "type" is "blockdev-snapshot-internal-sync":
1375       - "device": device name to snapshot (json-string)
1376       - "name": name of the new snapshot (json-string)
1377
1378 Example:
1379
1380 -> { "execute": "transaction",
1381      "arguments": { "actions": [
1382          { "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd0",
1383                                          "snapshot-file": "/some/place/my-image",
1384                                          "format": "qcow2" } },
1385          { "type": "blockdev-snapshot-sync", "data" : { "node-name": "myfile",
1386                                          "snapshot-file": "/some/place/my-image2",
1387                                          "snapshot-node-name": "node3432",
1388                                          "mode": "existing",
1389                                          "format": "qcow2" } },
1390          { "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd1",
1391                                          "snapshot-file": "/some/place/my-image2",
1392                                          "mode": "existing",
1393                                          "format": "qcow2" } },
1394          { "type": "blockdev-snapshot-internal-sync", "data" : {
1395                                          "device": "ide-hd2",
1396                                          "name": "snapshot0" } } ] } }
1397 <- { "return": {} }
1398
1399 EQMP
1400
1401     {
1402         .name       = "block-dirty-bitmap-add",
1403         .args_type  = "node:B,name:s,granularity:i?",
1404         .mhandler.cmd_new = qmp_marshal_block_dirty_bitmap_add,
1405     },
1406
1407 SQMP
1408
1409 block-dirty-bitmap-add
1410 ----------------------
1411 Since 2.4
1412
1413 Create a dirty bitmap with a name on the device, and start tracking the writes.
1414
1415 Arguments:
1416
1417 - "node": device/node on which to create dirty bitmap (json-string)
1418 - "name": name of the new dirty bitmap (json-string)
1419 - "granularity": granularity to track writes with (int, optional)
1420
1421 Example:
1422
1423 -> { "execute": "block-dirty-bitmap-add", "arguments": { "node": "drive0",
1424                                                    "name": "bitmap0" } }
1425 <- { "return": {} }
1426
1427 EQMP
1428
1429     {
1430         .name       = "block-dirty-bitmap-remove",
1431         .args_type  = "node:B,name:s",
1432         .mhandler.cmd_new = qmp_marshal_block_dirty_bitmap_remove,
1433     },
1434
1435 SQMP
1436
1437 block-dirty-bitmap-remove
1438 -------------------------
1439 Since 2.4
1440
1441 Stop write tracking and remove the dirty bitmap that was created with
1442 block-dirty-bitmap-add.
1443
1444 Arguments:
1445
1446 - "node": device/node on which to remove dirty bitmap (json-string)
1447 - "name": name of the dirty bitmap to remove (json-string)
1448
1449 Example:
1450
1451 -> { "execute": "block-dirty-bitmap-remove", "arguments": { "node": "drive0",
1452                                                       "name": "bitmap0" } }
1453 <- { "return": {} }
1454
1455 EQMP
1456
1457     {
1458         .name       = "block-dirty-bitmap-clear",
1459         .args_type  = "node:B,name:s",
1460         .mhandler.cmd_new = qmp_marshal_block_dirty_bitmap_clear,
1461     },
1462
1463 SQMP
1464
1465 block-dirty-bitmap-clear
1466 ------------------------
1467 Since 2.4
1468
1469 Reset the dirty bitmap associated with a node so that an incremental backup
1470 from this point in time forward will only backup clusters modified after this
1471 clear operation.
1472
1473 Arguments:
1474
1475 - "node": device/node on which to remove dirty bitmap (json-string)
1476 - "name": name of the dirty bitmap to remove (json-string)
1477
1478 Example:
1479
1480 -> { "execute": "block-dirty-bitmap-clear", "arguments": { "node": "drive0",
1481                                                            "name": "bitmap0" } }
1482 <- { "return": {} }
1483
1484 EQMP
1485
1486     {
1487         .name       = "blockdev-snapshot-sync",
1488         .args_type  = "device:s?,node-name:s?,snapshot-file:s,snapshot-node-name:s?,format:s?,mode:s?",
1489         .mhandler.cmd_new = qmp_marshal_blockdev_snapshot_sync,
1490     },
1491
1492 SQMP
1493 blockdev-snapshot-sync
1494 ----------------------
1495
1496 Synchronous snapshot of a block device. snapshot-file specifies the
1497 target of the new image. If the file exists, or if it is a device, the
1498 snapshot will be created in the existing file/device. If does not
1499 exist, a new file will be created. format specifies the format of the
1500 snapshot image, default is qcow2.
1501
1502 Arguments:
1503
1504 - "device": device name to snapshot (json-string)
1505 - "node-name": graph node name to snapshot (json-string)
1506 - "snapshot-file": name of new image file (json-string)
1507 - "snapshot-node-name": graph node name of the new snapshot (json-string)
1508 - "mode": whether and how QEMU should create the snapshot file
1509   (NewImageMode, optional, default "absolute-paths")
1510 - "format": format of new image (json-string, optional)
1511
1512 Example:
1513
1514 -> { "execute": "blockdev-snapshot-sync", "arguments": { "device": "ide-hd0",
1515                                                          "snapshot-file":
1516                                                         "/some/place/my-image",
1517                                                         "format": "qcow2" } }
1518 <- { "return": {} }
1519
1520 EQMP
1521
1522     {
1523         .name       = "blockdev-snapshot",
1524         .args_type  = "node:s,overlay:s",
1525         .mhandler.cmd_new = qmp_marshal_blockdev_snapshot,
1526     },
1527
1528 SQMP
1529 blockdev-snapshot
1530 -----------------
1531 Since 2.5
1532
1533 Create a snapshot, by installing 'node' as the backing image of
1534 'overlay'. Additionally, if 'node' is associated with a block
1535 device, the block device changes to using 'overlay' as its new active
1536 image.
1537
1538 Arguments:
1539
1540 - "node": device that will have a snapshot created (json-string)
1541 - "overlay": device that will have 'node' as its backing image (json-string)
1542
1543 Example:
1544
1545 -> { "execute": "blockdev-add",
1546                 "arguments": { "options": { "driver": "qcow2",
1547                                             "node-name": "node1534",
1548                                             "file": { "driver": "file",
1549                                                       "filename": "hd1.qcow2" },
1550                                             "backing": "" } } }
1551
1552 <- { "return": {} }
1553
1554 -> { "execute": "blockdev-snapshot", "arguments": { "node": "ide-hd0",
1555                                                     "overlay": "node1534" } }
1556 <- { "return": {} }
1557
1558 EQMP
1559
1560     {
1561         .name       = "blockdev-snapshot-internal-sync",
1562         .args_type  = "device:B,name:s",
1563         .mhandler.cmd_new = qmp_marshal_blockdev_snapshot_internal_sync,
1564     },
1565
1566 SQMP
1567 blockdev-snapshot-internal-sync
1568 -------------------------------
1569
1570 Synchronously take an internal snapshot of a block device when the format of
1571 image used supports it.  If the name is an empty string, or a snapshot with
1572 name already exists, the operation will fail.
1573
1574 Arguments:
1575
1576 - "device": device name to snapshot (json-string)
1577 - "name": name of the new snapshot (json-string)
1578
1579 Example:
1580
1581 -> { "execute": "blockdev-snapshot-internal-sync",
1582                 "arguments": { "device": "ide-hd0",
1583                                "name": "snapshot0" }
1584    }
1585 <- { "return": {} }
1586
1587 EQMP
1588
1589     {
1590         .name       = "blockdev-snapshot-delete-internal-sync",
1591         .args_type  = "device:B,id:s?,name:s?",
1592         .mhandler.cmd_new =
1593                       qmp_marshal_blockdev_snapshot_delete_internal_sync,
1594     },
1595
1596 SQMP
1597 blockdev-snapshot-delete-internal-sync
1598 --------------------------------------
1599
1600 Synchronously delete an internal snapshot of a block device when the format of
1601 image used supports it.  The snapshot is identified by name or id or both.  One
1602 of name or id is required.  If the snapshot is not found, the operation will
1603 fail.
1604
1605 Arguments:
1606
1607 - "device": device name (json-string)
1608 - "id": ID of the snapshot (json-string, optional)
1609 - "name": name of the snapshot (json-string, optional)
1610
1611 Example:
1612
1613 -> { "execute": "blockdev-snapshot-delete-internal-sync",
1614                 "arguments": { "device": "ide-hd0",
1615                                "name": "snapshot0" }
1616    }
1617 <- { "return": {
1618                    "id": "1",
1619                    "name": "snapshot0",
1620                    "vm-state-size": 0,
1621                    "date-sec": 1000012,
1622                    "date-nsec": 10,
1623                    "vm-clock-sec": 100,
1624                    "vm-clock-nsec": 20
1625      }
1626    }
1627
1628 EQMP
1629
1630     {
1631         .name       = "drive-mirror",
1632         .args_type  = "sync:s,device:B,target:s,speed:i?,mode:s?,format:s?,"
1633                       "node-name:s?,replaces:s?,"
1634                       "on-source-error:s?,on-target-error:s?,"
1635                       "unmap:b?,"
1636                       "granularity:i?,buf-size:i?",
1637         .mhandler.cmd_new = qmp_marshal_drive_mirror,
1638     },
1639
1640 SQMP
1641 drive-mirror
1642 ------------
1643
1644 Start mirroring a block device's writes to a new destination. target
1645 specifies the target of the new image. If the file exists, or if it is
1646 a device, it will be used as the new destination for writes. If it does not
1647 exist, a new file will be created. format specifies the format of the
1648 mirror image, default is to probe if mode='existing', else the format
1649 of the source.
1650
1651 Arguments:
1652
1653 - "device": device name to operate on (json-string)
1654 - "target": name of new image file (json-string)
1655 - "format": format of new image (json-string, optional)
1656 - "node-name": the name of the new block driver state in the node graph
1657                (json-string, optional)
1658 - "replaces": the block driver node name to replace when finished
1659               (json-string, optional)
1660 - "mode": how an image file should be created into the target
1661   file/device (NewImageMode, optional, default 'absolute-paths')
1662 - "speed": maximum speed of the streaming job, in bytes per second
1663   (json-int)
1664 - "granularity": granularity of the dirty bitmap, in bytes (json-int, optional)
1665 - "buf-size": maximum amount of data in flight from source to target, in bytes
1666   (json-int, default 10M)
1667 - "sync": what parts of the disk image should be copied to the destination;
1668   possibilities include "full" for all the disk, "top" for only the sectors
1669   allocated in the topmost image, or "none" to only replicate new I/O
1670   (MirrorSyncMode).
1671 - "on-source-error": the action to take on an error on the source
1672   (BlockdevOnError, default 'report')
1673 - "on-target-error": the action to take on an error on the target
1674   (BlockdevOnError, default 'report')
1675 - "unmap": whether the target sectors should be discarded where source has only
1676   zeroes. (json-bool, optional, default true)
1677
1678 The default value of the granularity is the image cluster size clamped
1679 between 4096 and 65536, if the image format defines one.  If the format
1680 does not define a cluster size, the default value of the granularity
1681 is 65536.
1682
1683
1684 Example:
1685
1686 -> { "execute": "drive-mirror", "arguments": { "device": "ide-hd0",
1687                                                "target": "/some/place/my-image",
1688                                                "sync": "full",
1689                                                "format": "qcow2" } }
1690 <- { "return": {} }
1691
1692 EQMP
1693
1694     {
1695         .name       = "blockdev-mirror",
1696         .args_type  = "sync:s,device:B,target:B,replaces:s?,speed:i?,"
1697                       "on-source-error:s?,on-target-error:s?,"
1698                       "granularity:i?,buf-size:i?",
1699         .mhandler.cmd_new = qmp_marshal_blockdev_mirror,
1700     },
1701
1702 SQMP
1703 blockdev-mirror
1704 ------------
1705
1706 Start mirroring a block device's writes to another block device. target
1707 specifies the target of mirror operation.
1708
1709 Arguments:
1710
1711 - "device": device name to operate on (json-string)
1712 - "target": device name to mirror to (json-string)
1713 - "replaces": the block driver node name to replace when finished
1714               (json-string, optional)
1715 - "speed": maximum speed of the streaming job, in bytes per second
1716   (json-int)
1717 - "granularity": granularity of the dirty bitmap, in bytes (json-int, optional)
1718 - "buf_size": maximum amount of data in flight from source to target, in bytes
1719   (json-int, default 10M)
1720 - "sync": what parts of the disk image should be copied to the destination;
1721   possibilities include "full" for all the disk, "top" for only the sectors
1722   allocated in the topmost image, or "none" to only replicate new I/O
1723   (MirrorSyncMode).
1724 - "on-source-error": the action to take on an error on the source
1725   (BlockdevOnError, default 'report')
1726 - "on-target-error": the action to take on an error on the target
1727   (BlockdevOnError, default 'report')
1728
1729 The default value of the granularity is the image cluster size clamped
1730 between 4096 and 65536, if the image format defines one.  If the format
1731 does not define a cluster size, the default value of the granularity
1732 is 65536.
1733
1734 Example:
1735
1736 -> { "execute": "blockdev-mirror", "arguments": { "device": "ide-hd0",
1737                                                   "target": "target0",
1738                                                   "sync": "full" } }
1739 <- { "return": {} }
1740
1741 EQMP
1742     {
1743         .name       = "change-backing-file",
1744         .args_type  = "device:s,image-node-name:s,backing-file:s",
1745         .mhandler.cmd_new = qmp_marshal_change_backing_file,
1746     },
1747
1748 SQMP
1749 change-backing-file
1750 -------------------
1751 Since: 2.1
1752
1753 Change the backing file in the image file metadata.  This does not cause
1754 QEMU to reopen the image file to reparse the backing filename (it may,
1755 however, perform a reopen to change permissions from r/o -> r/w -> r/o,
1756 if needed). The new backing file string is written into the image file
1757 metadata, and the QEMU internal strings are updated.
1758
1759 Arguments:
1760
1761 - "image-node-name":    The name of the block driver state node of the
1762                         image to modify.  The "device" is argument is used to
1763                         verify "image-node-name" is in the chain described by
1764                         "device".
1765                         (json-string, optional)
1766
1767 - "device":             The name of the device.
1768                         (json-string)
1769
1770 - "backing-file":       The string to write as the backing file.  This string is
1771                         not validated, so care should be taken when specifying
1772                         the string or the image chain may not be able to be
1773                         reopened again.
1774                         (json-string)
1775
1776 Returns: Nothing on success
1777          If "device" does not exist or cannot be determined, DeviceNotFound
1778
1779 EQMP
1780
1781     {
1782         .name       = "balloon",
1783         .args_type  = "value:M",
1784         .mhandler.cmd_new = qmp_marshal_balloon,
1785     },
1786
1787 SQMP
1788 balloon
1789 -------
1790
1791 Request VM to change its memory allocation (in bytes).
1792
1793 Arguments:
1794
1795 - "value": New memory allocation (json-int)
1796
1797 Example:
1798
1799 -> { "execute": "balloon", "arguments": { "value": 536870912 } }
1800 <- { "return": {} }
1801
1802 EQMP
1803
1804     {
1805         .name       = "set_link",
1806         .args_type  = "name:s,up:b",
1807         .mhandler.cmd_new = qmp_marshal_set_link,
1808     },
1809
1810 SQMP
1811 set_link
1812 --------
1813
1814 Change the link status of a network adapter.
1815
1816 Arguments:
1817
1818 - "name": network device name (json-string)
1819 - "up": status is up (json-bool)
1820
1821 Example:
1822
1823 -> { "execute": "set_link", "arguments": { "name": "e1000.0", "up": false } }
1824 <- { "return": {} }
1825
1826 EQMP
1827
1828     {
1829         .name       = "getfd",
1830         .args_type  = "fdname:s",
1831         .params     = "getfd name",
1832         .help       = "receive a file descriptor via SCM rights and assign it a name",
1833         .mhandler.cmd_new = qmp_marshal_getfd,
1834     },
1835
1836 SQMP
1837 getfd
1838 -----
1839
1840 Receive a file descriptor via SCM rights and assign it a name.
1841
1842 Arguments:
1843
1844 - "fdname": file descriptor name (json-string)
1845
1846 Example:
1847
1848 -> { "execute": "getfd", "arguments": { "fdname": "fd1" } }
1849 <- { "return": {} }
1850
1851 Notes:
1852
1853 (1) If the name specified by the "fdname" argument already exists,
1854     the file descriptor assigned to it will be closed and replaced
1855     by the received file descriptor.
1856 (2) The 'closefd' command can be used to explicitly close the file
1857     descriptor when it is no longer needed.
1858
1859 EQMP
1860
1861     {
1862         .name       = "closefd",
1863         .args_type  = "fdname:s",
1864         .params     = "closefd name",
1865         .help       = "close a file descriptor previously passed via SCM rights",
1866         .mhandler.cmd_new = qmp_marshal_closefd,
1867     },
1868
1869 SQMP
1870 closefd
1871 -------
1872
1873 Close a file descriptor previously passed via SCM rights.
1874
1875 Arguments:
1876
1877 - "fdname": file descriptor name (json-string)
1878
1879 Example:
1880
1881 -> { "execute": "closefd", "arguments": { "fdname": "fd1" } }
1882 <- { "return": {} }
1883
1884 EQMP
1885
1886      {
1887         .name       = "add-fd",
1888         .args_type  = "fdset-id:i?,opaque:s?",
1889         .params     = "add-fd fdset-id opaque",
1890         .help       = "Add a file descriptor, that was passed via SCM rights, to an fd set",
1891         .mhandler.cmd_new = qmp_marshal_add_fd,
1892     },
1893
1894 SQMP
1895 add-fd
1896 -------
1897
1898 Add a file descriptor, that was passed via SCM rights, to an fd set.
1899
1900 Arguments:
1901
1902 - "fdset-id": The ID of the fd set to add the file descriptor to.
1903               (json-int, optional)
1904 - "opaque": A free-form string that can be used to describe the fd.
1905             (json-string, optional)
1906
1907 Return a json-object with the following information:
1908
1909 - "fdset-id": The ID of the fd set that the fd was added to. (json-int)
1910 - "fd": The file descriptor that was received via SCM rights and added to the
1911         fd set. (json-int)
1912
1913 Example:
1914
1915 -> { "execute": "add-fd", "arguments": { "fdset-id": 1 } }
1916 <- { "return": { "fdset-id": 1, "fd": 3 } }
1917
1918 Notes:
1919
1920 (1) The list of fd sets is shared by all monitor connections.
1921 (2) If "fdset-id" is not specified, a new fd set will be created.
1922
1923 EQMP
1924
1925      {
1926         .name       = "remove-fd",
1927         .args_type  = "fdset-id:i,fd:i?",
1928         .params     = "remove-fd fdset-id fd",
1929         .help       = "Remove a file descriptor from an fd set",
1930         .mhandler.cmd_new = qmp_marshal_remove_fd,
1931     },
1932
1933 SQMP
1934 remove-fd
1935 ---------
1936
1937 Remove a file descriptor from an fd set.
1938
1939 Arguments:
1940
1941 - "fdset-id": The ID of the fd set that the file descriptor belongs to.
1942               (json-int)
1943 - "fd": The file descriptor that is to be removed. (json-int, optional)
1944
1945 Example:
1946
1947 -> { "execute": "remove-fd", "arguments": { "fdset-id": 1, "fd": 3 } }
1948 <- { "return": {} }
1949
1950 Notes:
1951
1952 (1) The list of fd sets is shared by all monitor connections.
1953 (2) If "fd" is not specified, all file descriptors in "fdset-id" will be
1954     removed.
1955
1956 EQMP
1957
1958     {
1959         .name       = "query-fdsets",
1960         .args_type  = "",
1961         .help       = "Return information describing all fd sets",
1962         .mhandler.cmd_new = qmp_marshal_query_fdsets,
1963     },
1964
1965 SQMP
1966 query-fdsets
1967 -------------
1968
1969 Return information describing all fd sets.
1970
1971 Arguments: None
1972
1973 Example:
1974
1975 -> { "execute": "query-fdsets" }
1976 <- { "return": [
1977        {
1978          "fds": [
1979            {
1980              "fd": 30,
1981              "opaque": "rdonly:/path/to/file"
1982            },
1983            {
1984              "fd": 24,
1985              "opaque": "rdwr:/path/to/file"
1986            }
1987          ],
1988          "fdset-id": 1
1989        },
1990        {
1991          "fds": [
1992            {
1993              "fd": 28
1994            },
1995            {
1996              "fd": 29
1997            }
1998          ],
1999          "fdset-id": 0
2000        }
2001      ]
2002    }
2003
2004 Note: The list of fd sets is shared by all monitor connections.
2005
2006 EQMP
2007
2008     {
2009         .name       = "block_passwd",
2010         .args_type  = "device:s?,node-name:s?,password:s",
2011         .mhandler.cmd_new = qmp_marshal_block_passwd,
2012     },
2013
2014 SQMP
2015 block_passwd
2016 ------------
2017
2018 Set the password of encrypted block devices.
2019
2020 Arguments:
2021
2022 - "device": device name (json-string)
2023 - "node-name": name in the block driver state graph (json-string)
2024 - "password": password (json-string)
2025
2026 Example:
2027
2028 -> { "execute": "block_passwd", "arguments": { "device": "ide0-hd0",
2029                                                "password": "12345" } }
2030 <- { "return": {} }
2031
2032 EQMP
2033
2034     {
2035         .name       = "block_set_io_throttle",
2036         .args_type  = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l,bps_max:l?,bps_rd_max:l?,bps_wr_max:l?,iops_max:l?,iops_rd_max:l?,iops_wr_max:l?,bps_max_length:l?,bps_rd_max_length:l?,bps_wr_max_length:l?,iops_max_length:l?,iops_rd_max_length:l?,iops_wr_max_length:l?,iops_size:l?,group:s?",
2037         .mhandler.cmd_new = qmp_marshal_block_set_io_throttle,
2038     },
2039
2040 SQMP
2041 block_set_io_throttle
2042 ------------
2043
2044 Change I/O throttle limits for a block drive.
2045
2046 Arguments:
2047
2048 - "device": device name (json-string)
2049 - "bps": total throughput limit in bytes per second (json-int)
2050 - "bps_rd": read throughput limit in bytes per second (json-int)
2051 - "bps_wr": write throughput limit in bytes per second (json-int)
2052 - "iops": total I/O operations per second (json-int)
2053 - "iops_rd": read I/O operations per second (json-int)
2054 - "iops_wr": write I/O operations per second (json-int)
2055 - "bps_max": total throughput limit during bursts, in bytes (json-int, optional)
2056 - "bps_rd_max": read throughput limit during bursts, in bytes (json-int, optional)
2057 - "bps_wr_max": write throughput limit during bursts, in bytes (json-int, optional)
2058 - "iops_max": total I/O operations per second during bursts (json-int, optional)
2059 - "iops_rd_max": read I/O operations per second during bursts (json-int, optional)
2060 - "iops_wr_max": write I/O operations per second during bursts (json-int, optional)
2061 - "bps_max_length": maximum length of the @bps_max burst period, in seconds (json-int, optional)
2062 - "bps_rd_max_length": maximum length of the @bps_rd_max burst period, in seconds (json-int, optional)
2063 - "bps_wr_max_length": maximum length of the @bps_wr_max burst period, in seconds (json-int, optional)
2064 - "iops_max_length": maximum length of the @iops_max burst period, in seconds (json-int, optional)
2065 - "iops_rd_max_length": maximum length of the @iops_rd_max burst period, in seconds (json-int, optional)
2066 - "iops_wr_max_length": maximum length of the @iops_wr_max burst period, in seconds (json-int, optional)
2067 - "iops_size":  I/O size in bytes when limiting (json-int, optional)
2068 - "group": throttle group name (json-string, optional)
2069
2070 Example:
2071
2072 -> { "execute": "block_set_io_throttle", "arguments": { "device": "virtio0",
2073                                                "bps": 1000000,
2074                                                "bps_rd": 0,
2075                                                "bps_wr": 0,
2076                                                "iops": 0,
2077                                                "iops_rd": 0,
2078                                                "iops_wr": 0,
2079                                                "bps_max": 8000000,
2080                                                "bps_rd_max": 0,
2081                                                "bps_wr_max": 0,
2082                                                "iops_max": 0,
2083                                                "iops_rd_max": 0,
2084                                                "iops_wr_max": 0,
2085                                                "bps_max_length": 60,
2086                                                "iops_size": 0 } }
2087 <- { "return": {} }
2088
2089 EQMP
2090
2091     {
2092         .name       = "set_password",
2093         .args_type  = "protocol:s,password:s,connected:s?",
2094         .mhandler.cmd_new = qmp_marshal_set_password,
2095     },
2096
2097 SQMP
2098 set_password
2099 ------------
2100
2101 Set the password for vnc/spice protocols.
2102
2103 Arguments:
2104
2105 - "protocol": protocol name (json-string)
2106 - "password": password (json-string)
2107 - "connected": [ keep | disconnect | fail ] (json-string, optional)
2108
2109 Example:
2110
2111 -> { "execute": "set_password", "arguments": { "protocol": "vnc",
2112                                                "password": "secret" } }
2113 <- { "return": {} }
2114
2115 EQMP
2116
2117     {
2118         .name       = "expire_password",
2119         .args_type  = "protocol:s,time:s",
2120         .mhandler.cmd_new = qmp_marshal_expire_password,
2121     },
2122
2123 SQMP
2124 expire_password
2125 ---------------
2126
2127 Set the password expire time for vnc/spice protocols.
2128
2129 Arguments:
2130
2131 - "protocol": protocol name (json-string)
2132 - "time": [ now | never | +secs | secs ] (json-string)
2133
2134 Example:
2135
2136 -> { "execute": "expire_password", "arguments": { "protocol": "vnc",
2137                                                   "time": "+60" } }
2138 <- { "return": {} }
2139
2140 EQMP
2141
2142     {
2143         .name       = "add_client",
2144         .args_type  = "protocol:s,fdname:s,skipauth:b?,tls:b?",
2145         .mhandler.cmd_new = qmp_marshal_add_client,
2146     },
2147
2148 SQMP
2149 add_client
2150 ----------
2151
2152 Add a graphics client
2153
2154 Arguments:
2155
2156 - "protocol": protocol name (json-string)
2157 - "fdname": file descriptor name (json-string)
2158 - "skipauth": whether to skip authentication (json-bool, optional)
2159 - "tls": whether to perform TLS (json-bool, optional)
2160
2161 Example:
2162
2163 -> { "execute": "add_client", "arguments": { "protocol": "vnc",
2164                                              "fdname": "myclient" } }
2165 <- { "return": {} }
2166
2167 EQMP
2168     {
2169         .name       = "qmp_capabilities",
2170         .args_type  = "",
2171         .params     = "",
2172         .help       = "enable QMP capabilities",
2173         .mhandler.cmd_new = qmp_capabilities,
2174     },
2175
2176 SQMP
2177 qmp_capabilities
2178 ----------------
2179
2180 Enable QMP capabilities.
2181
2182 Arguments: None.
2183
2184 Example:
2185
2186 -> { "execute": "qmp_capabilities" }
2187 <- { "return": {} }
2188
2189 Note: This command must be issued before issuing any other command.
2190
2191 EQMP
2192
2193     {
2194         .name       = "human-monitor-command",
2195         .args_type  = "command-line:s,cpu-index:i?",
2196         .mhandler.cmd_new = qmp_marshal_human_monitor_command,
2197     },
2198
2199 SQMP
2200 human-monitor-command
2201 ---------------------
2202
2203 Execute a Human Monitor command.
2204
2205 Arguments: 
2206
2207 - command-line: the command name and its arguments, just like the
2208                 Human Monitor's shell (json-string)
2209 - cpu-index: select the CPU number to be used by commands which access CPU
2210              data, like 'info registers'. The Monitor selects CPU 0 if this
2211              argument is not provided (json-int, optional)
2212
2213 Example:
2214
2215 -> { "execute": "human-monitor-command", "arguments": { "command-line": "info kvm" } }
2216 <- { "return": "kvm support: enabled\r\n" }
2217
2218 Notes:
2219
2220 (1) The Human Monitor is NOT an stable interface, this means that command
2221     names, arguments and responses can change or be removed at ANY time.
2222     Applications that rely on long term stability guarantees should NOT
2223     use this command
2224
2225 (2) Limitations:
2226
2227     o This command is stateless, this means that commands that depend
2228       on state information (such as getfd) might not work
2229
2230     o Commands that prompt the user for data (eg. 'cont' when the block
2231       device is encrypted) don't currently work
2232
2233 3. Query Commands
2234 =================
2235
2236 HXCOMM Each query command below is inside a SQMP/EQMP section, do NOT change
2237 HXCOMM this! We will possibly move query commands definitions inside those
2238 HXCOMM sections, just like regular commands.
2239
2240 EQMP
2241
2242 SQMP
2243 query-version
2244 -------------
2245
2246 Show QEMU version.
2247
2248 Return a json-object with the following information:
2249
2250 - "qemu": A json-object containing three integer values:
2251     - "major": QEMU's major version (json-int)
2252     - "minor": QEMU's minor version (json-int)
2253     - "micro": QEMU's micro version (json-int)
2254 - "package": package's version (json-string)
2255
2256 Example:
2257
2258 -> { "execute": "query-version" }
2259 <- {
2260       "return":{
2261          "qemu":{
2262             "major":0,
2263             "minor":11,
2264             "micro":5
2265          },
2266          "package":""
2267       }
2268    }
2269
2270 EQMP
2271
2272     {
2273         .name       = "query-version",
2274         .args_type  = "",
2275         .mhandler.cmd_new = qmp_marshal_query_version,
2276     },
2277
2278 SQMP
2279 query-commands
2280 --------------
2281
2282 List QMP available commands.
2283
2284 Each command is represented by a json-object, the returned value is a json-array
2285 of all commands.
2286
2287 Each json-object contain:
2288
2289 - "name": command's name (json-string)
2290
2291 Example:
2292
2293 -> { "execute": "query-commands" }
2294 <- {
2295       "return":[
2296          {
2297             "name":"query-balloon"
2298          },
2299          {
2300             "name":"system_powerdown"
2301          }
2302       ]
2303    }
2304
2305 Note: This example has been shortened as the real response is too long.
2306
2307 EQMP
2308
2309     {
2310         .name       = "query-commands",
2311         .args_type  = "",
2312         .mhandler.cmd_new = qmp_marshal_query_commands,
2313     },
2314
2315 SQMP
2316 query-events
2317 --------------
2318
2319 List QMP available events.
2320
2321 Each event is represented by a json-object, the returned value is a json-array
2322 of all events.
2323
2324 Each json-object contains:
2325
2326 - "name": event's name (json-string)
2327
2328 Example:
2329
2330 -> { "execute": "query-events" }
2331 <- {
2332       "return":[
2333          {
2334             "name":"SHUTDOWN"
2335          },
2336          {
2337             "name":"RESET"
2338          }
2339       ]
2340    }
2341
2342 Note: This example has been shortened as the real response is too long.
2343
2344 EQMP
2345
2346     {
2347         .name       = "query-events",
2348         .args_type  = "",
2349         .mhandler.cmd_new = qmp_marshal_query_events,
2350     },
2351
2352 SQMP
2353 query-qmp-schema
2354 ----------------
2355
2356 Return the QMP wire schema.  The returned value is a json-array of
2357 named schema entities.  Entities are commands, events and various
2358 types.  See docs/qapi-code-gen.txt for information on their structure
2359 and intended use.
2360
2361 EQMP
2362
2363     {
2364         .name       = "query-qmp-schema",
2365         .args_type  = "",
2366         .mhandler.cmd_new = qmp_query_qmp_schema,
2367     },
2368
2369 SQMP
2370 query-chardev
2371 -------------
2372
2373 Each device is represented by a json-object. The returned value is a json-array
2374 of all devices.
2375
2376 Each json-object contain the following:
2377
2378 - "label": device's label (json-string)
2379 - "filename": device's file (json-string)
2380 - "frontend-open": open/closed state of the frontend device attached to this
2381                    backend (json-bool)
2382
2383 Example:
2384
2385 -> { "execute": "query-chardev" }
2386 <- {
2387       "return": [
2388          {
2389             "label": "charchannel0",
2390             "filename": "unix:/var/lib/libvirt/qemu/seabios.rhel6.agent,server",
2391             "frontend-open": false
2392          },
2393          {
2394             "label": "charmonitor",
2395             "filename": "unix:/var/lib/libvirt/qemu/seabios.rhel6.monitor,server",
2396             "frontend-open": true
2397          },
2398          {
2399             "label": "charserial0",
2400             "filename": "pty:/dev/pts/2",
2401             "frontend-open": true
2402          }
2403       ]
2404    }
2405
2406 EQMP
2407
2408     {
2409         .name       = "query-chardev",
2410         .args_type  = "",
2411         .mhandler.cmd_new = qmp_marshal_query_chardev,
2412     },
2413
2414 SQMP
2415 query-chardev-backends
2416 -------------
2417
2418 List available character device backends.
2419
2420 Each backend is represented by a json-object, the returned value is a json-array
2421 of all backends.
2422
2423 Each json-object contains:
2424
2425 - "name": backend name (json-string)
2426
2427 Example:
2428
2429 -> { "execute": "query-chardev-backends" }
2430 <- {
2431       "return":[
2432          {
2433             "name":"udp"
2434          },
2435          {
2436             "name":"tcp"
2437          },
2438          {
2439             "name":"unix"
2440          },
2441          {
2442             "name":"spiceport"
2443          }
2444       ]
2445    }
2446
2447 EQMP
2448
2449     {
2450         .name       = "query-chardev-backends",
2451         .args_type  = "",
2452         .mhandler.cmd_new = qmp_marshal_query_chardev_backends,
2453     },
2454
2455 SQMP
2456 query-block
2457 -----------
2458
2459 Show the block devices.
2460
2461 Each block device information is stored in a json-object and the returned value
2462 is a json-array of all devices.
2463
2464 Each json-object contain the following:
2465
2466 - "device": device name (json-string)
2467 - "type": device type (json-string)
2468          - deprecated, retained for backward compatibility
2469          - Possible values: "unknown"
2470 - "removable": true if the device is removable, false otherwise (json-bool)
2471 - "locked": true if the device is locked, false otherwise (json-bool)
2472 - "tray_open": only present if removable, true if the device has a tray,
2473                and it is open (json-bool)
2474 - "inserted": only present if the device is inserted, it is a json-object
2475    containing the following:
2476          - "file": device file name (json-string)
2477          - "ro": true if read-only, false otherwise (json-bool)
2478          - "drv": driver format name (json-string)
2479              - Possible values: "blkdebug", "bochs", "cloop", "dmg",
2480                                 "file", "file", "ftp", "ftps", "host_cdrom",
2481                                 "host_device", "http", "https",
2482                                 "nbd", "parallels", "qcow", "qcow2", "raw",
2483                                 "tftp", "vdi", "vmdk", "vpc", "vvfat"
2484          - "backing_file": backing file name (json-string, optional)
2485          - "backing_file_depth": number of files in the backing file chain (json-int)
2486          - "encrypted": true if encrypted, false otherwise (json-bool)
2487          - "bps": limit total bytes per second (json-int)
2488          - "bps_rd": limit read bytes per second (json-int)
2489          - "bps_wr": limit write bytes per second (json-int)
2490          - "iops": limit total I/O operations per second (json-int)
2491          - "iops_rd": limit read operations per second (json-int)
2492          - "iops_wr": limit write operations per second (json-int)
2493          - "bps_max":  total max in bytes (json-int)
2494          - "bps_rd_max":  read max in bytes (json-int)
2495          - "bps_wr_max":  write max in bytes (json-int)
2496          - "iops_max":  total I/O operations max (json-int)
2497          - "iops_rd_max":  read I/O operations max (json-int)
2498          - "iops_wr_max":  write I/O operations max (json-int)
2499          - "iops_size": I/O size when limiting by iops (json-int)
2500          - "detect_zeroes": detect and optimize zero writing (json-string)
2501              - Possible values: "off", "on", "unmap"
2502          - "write_threshold": write offset threshold in bytes, a event will be
2503                               emitted if crossed. Zero if disabled (json-int)
2504          - "image": the detail of the image, it is a json-object containing
2505             the following:
2506              - "filename": image file name (json-string)
2507              - "format": image format (json-string)
2508              - "virtual-size": image capacity in bytes (json-int)
2509              - "dirty-flag": true if image is not cleanly closed, not present
2510                              means clean (json-bool, optional)
2511              - "actual-size": actual size on disk in bytes of the image, not
2512                               present when image does not support thin
2513                               provision (json-int, optional)
2514              - "cluster-size": size of a cluster in bytes, not present if image
2515                                format does not support it (json-int, optional)
2516              - "encrypted": true if the image is encrypted, not present means
2517                             false or the image format does not support
2518                             encryption (json-bool, optional)
2519              - "backing_file": backing file name, not present means no backing
2520                                file is used or the image format does not
2521                                support backing file chain
2522                                (json-string, optional)
2523              - "full-backing-filename": full path of the backing file, not
2524                                         present if it equals backing_file or no
2525                                         backing file is used
2526                                         (json-string, optional)
2527              - "backing-filename-format": the format of the backing file, not
2528                                           present means unknown or no backing
2529                                           file (json-string, optional)
2530              - "snapshots": the internal snapshot info, it is an optional list
2531                 of json-object containing the following:
2532                  - "id": unique snapshot id (json-string)
2533                  - "name": snapshot name (json-string)
2534                  - "vm-state-size": size of the VM state in bytes (json-int)
2535                  - "date-sec": UTC date of the snapshot in seconds (json-int)
2536                  - "date-nsec": fractional part in nanoseconds to be used with
2537                                 date-sec (json-int)
2538                  - "vm-clock-sec": VM clock relative to boot in seconds
2539                                    (json-int)
2540                  - "vm-clock-nsec": fractional part in nanoseconds to be used
2541                                     with vm-clock-sec (json-int)
2542              - "backing-image": the detail of the backing image, it is an
2543                                 optional json-object only present when a
2544                                 backing image present for this image
2545
2546 - "io-status": I/O operation status, only present if the device supports it
2547                and the VM is configured to stop on errors. It's always reset
2548                to "ok" when the "cont" command is issued (json_string, optional)
2549              - Possible values: "ok", "failed", "nospace"
2550
2551 Example:
2552
2553 -> { "execute": "query-block" }
2554 <- {
2555       "return":[
2556          {
2557             "io-status": "ok",
2558             "device":"ide0-hd0",
2559             "locked":false,
2560             "removable":false,
2561             "inserted":{
2562                "ro":false,
2563                "drv":"qcow2",
2564                "encrypted":false,
2565                "file":"disks/test.qcow2",
2566                "backing_file_depth":1,
2567                "bps":1000000,
2568                "bps_rd":0,
2569                "bps_wr":0,
2570                "iops":1000000,
2571                "iops_rd":0,
2572                "iops_wr":0,
2573                "bps_max": 8000000,
2574                "bps_rd_max": 0,
2575                "bps_wr_max": 0,
2576                "iops_max": 0,
2577                "iops_rd_max": 0,
2578                "iops_wr_max": 0,
2579                "iops_size": 0,
2580                "detect_zeroes": "on",
2581                "write_threshold": 0,
2582                "image":{
2583                   "filename":"disks/test.qcow2",
2584                   "format":"qcow2",
2585                   "virtual-size":2048000,
2586                   "backing_file":"base.qcow2",
2587                   "full-backing-filename":"disks/base.qcow2",
2588                   "backing-filename-format":"qcow2",
2589                   "snapshots":[
2590                      {
2591                         "id": "1",
2592                         "name": "snapshot1",
2593                         "vm-state-size": 0,
2594                         "date-sec": 10000200,
2595                         "date-nsec": 12,
2596                         "vm-clock-sec": 206,
2597                         "vm-clock-nsec": 30
2598                      }
2599                   ],
2600                   "backing-image":{
2601                       "filename":"disks/base.qcow2",
2602                       "format":"qcow2",
2603                       "virtual-size":2048000
2604                   }
2605                }
2606             },
2607             "type":"unknown"
2608          },
2609          {
2610             "io-status": "ok",
2611             "device":"ide1-cd0",
2612             "locked":false,
2613             "removable":true,
2614             "type":"unknown"
2615          },
2616          {
2617             "device":"floppy0",
2618             "locked":false,
2619             "removable":true,
2620             "type":"unknown"
2621          },
2622          {
2623             "device":"sd0",
2624             "locked":false,
2625             "removable":true,
2626             "type":"unknown"
2627          }
2628       ]
2629    }
2630
2631 EQMP
2632
2633     {
2634         .name       = "query-block",
2635         .args_type  = "",
2636         .mhandler.cmd_new = qmp_marshal_query_block,
2637     },
2638
2639 SQMP
2640 query-blockstats
2641 ----------------
2642
2643 Show block device statistics.
2644
2645 Each device statistic information is stored in a json-object and the returned
2646 value is a json-array of all devices.
2647
2648 Each json-object contain the following:
2649
2650 - "device": device name (json-string)
2651 - "stats": A json-object with the statistics information, it contains:
2652     - "rd_bytes": bytes read (json-int)
2653     - "wr_bytes": bytes written (json-int)
2654     - "rd_operations": read operations (json-int)
2655     - "wr_operations": write operations (json-int)
2656     - "flush_operations": cache flush operations (json-int)
2657     - "wr_total_time_ns": total time spend on writes in nano-seconds (json-int)
2658     - "rd_total_time_ns": total time spend on reads in nano-seconds (json-int)
2659     - "flush_total_time_ns": total time spend on cache flushes in nano-seconds (json-int)
2660     - "wr_highest_offset": The offset after the greatest byte written to the
2661                            BlockDriverState since it has been opened (json-int)
2662     - "rd_merged": number of read requests that have been merged into
2663                    another request (json-int)
2664     - "wr_merged": number of write requests that have been merged into
2665                    another request (json-int)
2666     - "idle_time_ns": time since the last I/O operation, in
2667                       nanoseconds. If the field is absent it means
2668                       that there haven't been any operations yet
2669                       (json-int, optional)
2670     - "failed_rd_operations": number of failed read operations
2671                               (json-int)
2672     - "failed_wr_operations": number of failed write operations
2673                               (json-int)
2674     - "failed_flush_operations": number of failed flush operations
2675                                (json-int)
2676     - "invalid_rd_operations": number of invalid read operations
2677                                (json-int)
2678     - "invalid_wr_operations": number of invalid write operations
2679                                (json-int)
2680     - "invalid_flush_operations": number of invalid flush operations
2681                                   (json-int)
2682     - "account_invalid": whether invalid operations are included in
2683                          the last access statistics (json-bool)
2684     - "account_failed": whether failed operations are included in the
2685                          latency and last access statistics
2686                          (json-bool)
2687     - "timed_stats": A json-array containing statistics collected in
2688                      specific intervals, with the following members:
2689         - "interval_length": interval used for calculating the
2690                              statistics, in seconds (json-int)
2691         - "min_rd_latency_ns": minimum latency of read operations in
2692                                the defined interval, in nanoseconds
2693                                (json-int)
2694         - "min_wr_latency_ns": minimum latency of write operations in
2695                                the defined interval, in nanoseconds
2696                                (json-int)
2697         - "min_flush_latency_ns": minimum latency of flush operations
2698                                   in the defined interval, in
2699                                   nanoseconds (json-int)
2700         - "max_rd_latency_ns": maximum latency of read operations in
2701                                the defined interval, in nanoseconds
2702                                (json-int)
2703         - "max_wr_latency_ns": maximum latency of write operations in
2704                                the defined interval, in nanoseconds
2705                                (json-int)
2706         - "max_flush_latency_ns": maximum latency of flush operations
2707                                   in the defined interval, in
2708                                   nanoseconds (json-int)
2709         - "avg_rd_latency_ns": average latency of read operations in
2710                                the defined interval, in nanoseconds
2711                                (json-int)
2712         - "avg_wr_latency_ns": average latency of write operations in
2713                                the defined interval, in nanoseconds
2714                                (json-int)
2715         - "avg_flush_latency_ns": average latency of flush operations
2716                                   in the defined interval, in
2717                                   nanoseconds (json-int)
2718         - "avg_rd_queue_depth": average number of pending read
2719                                 operations in the defined interval
2720                                 (json-number)
2721         - "avg_wr_queue_depth": average number of pending write
2722                                 operations in the defined interval
2723                                 (json-number).
2724 - "parent": Contains recursively the statistics of the underlying
2725             protocol (e.g. the host file for a qcow2 image). If there is
2726             no underlying protocol, this field is omitted
2727             (json-object, optional)
2728
2729 Example:
2730
2731 -> { "execute": "query-blockstats" }
2732 <- {
2733       "return":[
2734          {
2735             "device":"ide0-hd0",
2736             "parent":{
2737                "stats":{
2738                   "wr_highest_offset":3686448128,
2739                   "wr_bytes":9786368,
2740                   "wr_operations":751,
2741                   "rd_bytes":122567168,
2742                   "rd_operations":36772
2743                   "wr_total_times_ns":313253456
2744                   "rd_total_times_ns":3465673657
2745                   "flush_total_times_ns":49653
2746                   "flush_operations":61,
2747                   "rd_merged":0,
2748                   "wr_merged":0,
2749                   "idle_time_ns":2953431879,
2750                   "account_invalid":true,
2751                   "account_failed":false
2752                }
2753             },
2754             "stats":{
2755                "wr_highest_offset":2821110784,
2756                "wr_bytes":9786368,
2757                "wr_operations":692,
2758                "rd_bytes":122739200,
2759                "rd_operations":36604
2760                "flush_operations":51,
2761                "wr_total_times_ns":313253456
2762                "rd_total_times_ns":3465673657
2763                "flush_total_times_ns":49653,
2764                "rd_merged":0,
2765                "wr_merged":0,
2766                "idle_time_ns":2953431879,
2767                "account_invalid":true,
2768                "account_failed":false
2769             }
2770          },
2771          {
2772             "device":"ide1-cd0",
2773             "stats":{
2774                "wr_highest_offset":0,
2775                "wr_bytes":0,
2776                "wr_operations":0,
2777                "rd_bytes":0,
2778                "rd_operations":0
2779                "flush_operations":0,
2780                "wr_total_times_ns":0
2781                "rd_total_times_ns":0
2782                "flush_total_times_ns":0,
2783                "rd_merged":0,
2784                "wr_merged":0,
2785                "account_invalid":false,
2786                "account_failed":false
2787             }
2788          },
2789          {
2790             "device":"floppy0",
2791             "stats":{
2792                "wr_highest_offset":0,
2793                "wr_bytes":0,
2794                "wr_operations":0,
2795                "rd_bytes":0,
2796                "rd_operations":0
2797                "flush_operations":0,
2798                "wr_total_times_ns":0
2799                "rd_total_times_ns":0
2800                "flush_total_times_ns":0,
2801                "rd_merged":0,
2802                "wr_merged":0,
2803                "account_invalid":false,
2804                "account_failed":false
2805             }
2806          },
2807          {
2808             "device":"sd0",
2809             "stats":{
2810                "wr_highest_offset":0,
2811                "wr_bytes":0,
2812                "wr_operations":0,
2813                "rd_bytes":0,
2814                "rd_operations":0
2815                "flush_operations":0,
2816                "wr_total_times_ns":0
2817                "rd_total_times_ns":0
2818                "flush_total_times_ns":0,
2819                "rd_merged":0,
2820                "wr_merged":0,
2821                "account_invalid":false,
2822                "account_failed":false
2823             }
2824          }
2825       ]
2826    }
2827
2828 EQMP
2829
2830     {
2831         .name       = "query-blockstats",
2832         .args_type  = "query-nodes:b?",
2833         .mhandler.cmd_new = qmp_marshal_query_blockstats,
2834     },
2835
2836 SQMP
2837 query-cpus
2838 ----------
2839
2840 Show CPU information.
2841
2842 Return a json-array. Each CPU is represented by a json-object, which contains:
2843
2844 - "CPU": CPU index (json-int)
2845 - "current": true if this is the current CPU, false otherwise (json-bool)
2846 - "halted": true if the cpu is halted, false otherwise (json-bool)
2847 - "qom_path": path to the CPU object in the QOM tree (json-str)
2848 - "arch": architecture of the cpu, which determines what additional
2849           keys will be present (json-str)
2850 - Current program counter. The key's name depends on the architecture:
2851      "pc": i386/x86_64 (json-int)
2852      "nip": PPC (json-int)
2853      "pc" and "npc": sparc (json-int)
2854      "PC": mips (json-int)
2855 - "thread_id": ID of the underlying host thread (json-int)
2856
2857 Example:
2858
2859 -> { "execute": "query-cpus" }
2860 <- {
2861       "return":[
2862          {
2863             "CPU":0,
2864             "current":true,
2865             "halted":false,
2866             "qom_path":"/machine/unattached/device[0]",
2867             "arch":"x86",
2868             "pc":3227107138,
2869             "thread_id":3134
2870          },
2871          {
2872             "CPU":1,
2873             "current":false,
2874             "halted":true,
2875             "qom_path":"/machine/unattached/device[2]",
2876             "arch":"x86",
2877             "pc":7108165,
2878             "thread_id":3135
2879          }
2880       ]
2881    }
2882
2883 EQMP
2884
2885     {
2886         .name       = "query-cpus",
2887         .args_type  = "",
2888         .mhandler.cmd_new = qmp_marshal_query_cpus,
2889     },
2890
2891 SQMP
2892 query-iothreads
2893 ---------------
2894
2895 Returns a list of information about each iothread.
2896
2897 Note this list excludes the QEMU main loop thread, which is not declared
2898 using the -object iothread command-line option.  It is always the main thread
2899 of the process.
2900
2901 Return a json-array. Each iothread is represented by a json-object, which contains:
2902
2903 - "id": name of iothread (json-str)
2904 - "thread-id": ID of the underlying host thread (json-int)
2905
2906 Example:
2907
2908 -> { "execute": "query-iothreads" }
2909 <- {
2910       "return":[
2911          {
2912             "id":"iothread0",
2913             "thread-id":3134
2914          },
2915          {
2916             "id":"iothread1",
2917             "thread-id":3135
2918          }
2919       ]
2920    }
2921
2922 EQMP
2923
2924     {
2925         .name       = "query-iothreads",
2926         .args_type  = "",
2927         .mhandler.cmd_new = qmp_marshal_query_iothreads,
2928     },
2929
2930 SQMP
2931 query-pci
2932 ---------
2933
2934 PCI buses and devices information.
2935
2936 The returned value is a json-array of all buses. Each bus is represented by
2937 a json-object, which has a key with a json-array of all PCI devices attached
2938 to it. Each device is represented by a json-object.
2939
2940 The bus json-object contains the following:
2941
2942 - "bus": bus number (json-int)
2943 - "devices": a json-array of json-objects, each json-object represents a
2944              PCI device
2945
2946 The PCI device json-object contains the following:
2947
2948 - "bus": identical to the parent's bus number (json-int)
2949 - "slot": slot number (json-int)
2950 - "function": function number (json-int)
2951 - "class_info": a json-object containing:
2952      - "desc": device class description (json-string, optional)
2953      - "class": device class number (json-int)
2954 - "id": a json-object containing:
2955      - "device": device ID (json-int)
2956      - "vendor": vendor ID (json-int)
2957 - "irq": device's IRQ if assigned (json-int, optional)
2958 - "qdev_id": qdev id string (json-string)
2959 - "pci_bridge": It's a json-object, only present if this device is a
2960                 PCI bridge, contains:
2961      - "bus": bus number (json-int)
2962      - "secondary": secondary bus number (json-int)
2963      - "subordinate": subordinate bus number (json-int)
2964      - "io_range": I/O memory range information, a json-object with the
2965                    following members:
2966                  - "base": base address, in bytes (json-int)
2967                  - "limit": limit address, in bytes (json-int)
2968      - "memory_range": memory range information, a json-object with the
2969                        following members:
2970                  - "base": base address, in bytes (json-int)
2971                  - "limit": limit address, in bytes (json-int)
2972      - "prefetchable_range": Prefetchable memory range information, a
2973                              json-object with the following members:
2974                  - "base": base address, in bytes (json-int)
2975                  - "limit": limit address, in bytes (json-int)
2976      - "devices": a json-array of PCI devices if there's any attached, each
2977                   each element is represented by a json-object, which contains
2978                   the same members of the 'PCI device json-object' described
2979                   above (optional)
2980 - "regions": a json-array of json-objects, each json-object represents a
2981              memory region of this device
2982
2983 The memory range json-object contains the following:
2984
2985 - "base": base memory address (json-int)
2986 - "limit": limit value (json-int)
2987
2988 The region json-object can be an I/O region or a memory region, an I/O region
2989 json-object contains the following:
2990
2991 - "type": "io" (json-string, fixed)
2992 - "bar": BAR number (json-int)
2993 - "address": memory address (json-int)
2994 - "size": memory size (json-int)
2995
2996 A memory region json-object contains the following:
2997
2998 - "type": "memory" (json-string, fixed)
2999 - "bar": BAR number (json-int)
3000 - "address": memory address (json-int)
3001 - "size": memory size (json-int)
3002 - "mem_type_64": true or false (json-bool)
3003 - "prefetch": true or false (json-bool)
3004
3005 Example:
3006
3007 -> { "execute": "query-pci" }
3008 <- {
3009       "return":[
3010          {
3011             "bus":0,
3012             "devices":[
3013                {
3014                   "bus":0,
3015                   "qdev_id":"",
3016                   "slot":0,
3017                   "class_info":{
3018                      "class":1536,
3019                      "desc":"Host bridge"
3020                   },
3021                   "id":{
3022                      "device":32902,
3023                      "vendor":4663
3024                   },
3025                   "function":0,
3026                   "regions":[
3027    
3028                   ]
3029                },
3030                {
3031                   "bus":0,
3032                   "qdev_id":"",
3033                   "slot":1,
3034                   "class_info":{
3035                      "class":1537,
3036                      "desc":"ISA bridge"
3037                   },
3038                   "id":{
3039                      "device":32902,
3040                      "vendor":28672
3041                   },
3042                   "function":0,
3043                   "regions":[
3044    
3045                   ]
3046                },
3047                {
3048                   "bus":0,
3049                   "qdev_id":"",
3050                   "slot":1,
3051                   "class_info":{
3052                      "class":257,
3053                      "desc":"IDE controller"
3054                   },
3055                   "id":{
3056                      "device":32902,
3057                      "vendor":28688
3058                   },
3059                   "function":1,
3060                   "regions":[
3061                      {
3062                         "bar":4,
3063                         "size":16,
3064                         "address":49152,
3065                         "type":"io"
3066                      }
3067                   ]
3068                },
3069                {
3070                   "bus":0,
3071                   "qdev_id":"",
3072                   "slot":2,
3073                   "class_info":{
3074                      "class":768,
3075                      "desc":"VGA controller"
3076                   },
3077                   "id":{
3078                      "device":4115,
3079                      "vendor":184
3080                   },
3081                   "function":0,
3082                   "regions":[
3083                      {
3084                         "prefetch":true,
3085                         "mem_type_64":false,
3086                         "bar":0,
3087                         "size":33554432,
3088                         "address":4026531840,
3089                         "type":"memory"
3090                      },
3091                      {
3092                         "prefetch":false,
3093                         "mem_type_64":false,
3094                         "bar":1,
3095                         "size":4096,
3096                         "address":4060086272,
3097                         "type":"memory"
3098                      },
3099                      {
3100                         "prefetch":false,
3101                         "mem_type_64":false,
3102                         "bar":6,
3103                         "size":65536,
3104                         "address":-1,
3105                         "type":"memory"
3106                      }
3107                   ]
3108                },
3109                {
3110                   "bus":0,
3111                   "qdev_id":"",
3112                   "irq":11,
3113                   "slot":4,
3114                   "class_info":{
3115                      "class":1280,
3116                      "desc":"RAM controller"
3117                   },
3118                   "id":{
3119                      "device":6900,
3120                      "vendor":4098
3121                   },
3122                   "function":0,
3123                   "regions":[
3124                      {
3125                         "bar":0,
3126                         "size":32,
3127                         "address":49280,
3128                         "type":"io"
3129                      }
3130                   ]
3131                }
3132             ]
3133          }
3134       ]
3135    }
3136
3137 Note: This example has been shortened as the real response is too long.
3138
3139 EQMP
3140
3141     {
3142         .name       = "query-pci",
3143         .args_type  = "",
3144         .mhandler.cmd_new = qmp_marshal_query_pci,
3145     },
3146
3147 SQMP
3148 query-kvm
3149 ---------
3150
3151 Show KVM information.
3152
3153 Return a json-object with the following information:
3154
3155 - "enabled": true if KVM support is enabled, false otherwise (json-bool)
3156 - "present": true if QEMU has KVM support, false otherwise (json-bool)
3157
3158 Example:
3159
3160 -> { "execute": "query-kvm" }
3161 <- { "return": { "enabled": true, "present": true } }
3162
3163 EQMP
3164
3165     {
3166         .name       = "query-kvm",
3167         .args_type  = "",
3168         .mhandler.cmd_new = qmp_marshal_query_kvm,
3169     },
3170
3171 SQMP
3172 query-status
3173 ------------
3174
3175 Return a json-object with the following information:
3176
3177 - "running": true if the VM is running, or false if it is paused (json-bool)
3178 - "singlestep": true if the VM is in single step mode,
3179                 false otherwise (json-bool)
3180 - "status": one of the following values (json-string)
3181     "debug" - QEMU is running on a debugger
3182     "inmigrate" - guest is paused waiting for an incoming migration
3183     "internal-error" - An internal error that prevents further guest
3184     execution has occurred
3185     "io-error" - the last IOP has failed and the device is configured
3186     to pause on I/O errors
3187     "paused" - guest has been paused via the 'stop' command
3188     "postmigrate" - guest is paused following a successful 'migrate'
3189     "prelaunch" - QEMU was started with -S and guest has not started
3190     "finish-migrate" - guest is paused to finish the migration process
3191     "restore-vm" - guest is paused to restore VM state
3192     "running" - guest is actively running
3193     "save-vm" - guest is paused to save the VM state
3194     "shutdown" - guest is shut down (and -no-shutdown is in use)
3195     "watchdog" - the watchdog action is configured to pause and
3196      has been triggered
3197
3198 Example:
3199
3200 -> { "execute": "query-status" }
3201 <- { "return": { "running": true, "singlestep": false, "status": "running" } }
3202
3203 EQMP
3204     
3205     {
3206         .name       = "query-status",
3207         .args_type  = "",
3208         .mhandler.cmd_new = qmp_marshal_query_status,
3209     },
3210
3211 SQMP
3212 query-mice
3213 ----------
3214
3215 Show VM mice information.
3216
3217 Each mouse is represented by a json-object, the returned value is a json-array
3218 of all mice.
3219
3220 The mouse json-object contains the following:
3221
3222 - "name": mouse's name (json-string)
3223 - "index": mouse's index (json-int)
3224 - "current": true if this mouse is receiving events, false otherwise (json-bool)
3225 - "absolute": true if the mouse generates absolute input events (json-bool)
3226
3227 Example:
3228
3229 -> { "execute": "query-mice" }
3230 <- {
3231       "return":[
3232          {
3233             "name":"QEMU Microsoft Mouse",
3234             "index":0,
3235             "current":false,
3236             "absolute":false
3237          },
3238          {
3239             "name":"QEMU PS/2 Mouse",
3240             "index":1,
3241             "current":true,
3242             "absolute":true
3243          }
3244       ]
3245    }
3246
3247 EQMP
3248
3249     {
3250         .name       = "query-mice",
3251         .args_type  = "",
3252         .mhandler.cmd_new = qmp_marshal_query_mice,
3253     },
3254
3255 SQMP
3256 query-vnc
3257 ---------
3258
3259 Show VNC server information.
3260
3261 Return a json-object with server information. Connected clients are returned
3262 as a json-array of json-objects.
3263
3264 The main json-object contains the following:
3265
3266 - "enabled": true or false (json-bool)
3267 - "host": server's IP address (json-string)
3268 - "family": address family (json-string)
3269          - Possible values: "ipv4", "ipv6", "unix", "unknown"
3270 - "service": server's port number (json-string)
3271 - "auth": authentication method (json-string)
3272          - Possible values: "invalid", "none", "ra2", "ra2ne", "sasl", "tight",
3273                             "tls", "ultra", "unknown", "vencrypt", "vencrypt",
3274                             "vencrypt+plain", "vencrypt+tls+none",
3275                             "vencrypt+tls+plain", "vencrypt+tls+sasl",
3276                             "vencrypt+tls+vnc", "vencrypt+x509+none",
3277                             "vencrypt+x509+plain", "vencrypt+x509+sasl",
3278                             "vencrypt+x509+vnc", "vnc"
3279 - "clients": a json-array of all connected clients
3280
3281 Clients are described by a json-object, each one contain the following:
3282
3283 - "host": client's IP address (json-string)
3284 - "family": address family (json-string)
3285          - Possible values: "ipv4", "ipv6", "unix", "unknown"
3286 - "service": client's port number (json-string)
3287 - "x509_dname": TLS dname (json-string, optional)
3288 - "sasl_username": SASL username (json-string, optional)
3289
3290 Example:
3291
3292 -> { "execute": "query-vnc" }
3293 <- {
3294       "return":{
3295          "enabled":true,
3296          "host":"0.0.0.0",
3297          "service":"50402",
3298          "auth":"vnc",
3299          "family":"ipv4",
3300          "clients":[
3301             {
3302                "host":"127.0.0.1",
3303                "service":"50401",
3304                "family":"ipv4"
3305             }
3306          ]
3307       }
3308    }
3309
3310 EQMP
3311
3312     {
3313         .name       = "query-vnc",
3314         .args_type  = "",
3315         .mhandler.cmd_new = qmp_marshal_query_vnc,
3316     },
3317     {
3318         .name       = "query-vnc-servers",
3319         .args_type  = "",
3320         .mhandler.cmd_new = qmp_marshal_query_vnc_servers,
3321     },
3322
3323 SQMP
3324 query-spice
3325 -----------
3326
3327 Show SPICE server information.
3328
3329 Return a json-object with server information. Connected clients are returned
3330 as a json-array of json-objects.
3331
3332 The main json-object contains the following:
3333
3334 - "enabled": true or false (json-bool)
3335 - "host": server's IP address (json-string)
3336 - "port": server's port number (json-int, optional)
3337 - "tls-port": server's port number (json-int, optional)
3338 - "auth": authentication method (json-string)
3339          - Possible values: "none", "spice"
3340 - "channels": a json-array of all active channels clients
3341
3342 Channels are described by a json-object, each one contain the following:
3343
3344 - "host": client's IP address (json-string)
3345 - "family": address family (json-string)
3346          - Possible values: "ipv4", "ipv6", "unix", "unknown"
3347 - "port": client's port number (json-string)
3348 - "connection-id": spice connection id.  All channels with the same id
3349                    belong to the same spice session (json-int)
3350 - "channel-type": channel type.  "1" is the main control channel, filter for
3351                   this one if you want track spice sessions only (json-int)
3352 - "channel-id": channel id.  Usually "0", might be different needed when
3353                 multiple channels of the same type exist, such as multiple
3354                 display channels in a multihead setup (json-int)
3355 - "tls": whether the channel is encrypted (json-bool)
3356
3357 Example:
3358
3359 -> { "execute": "query-spice" }
3360 <- {
3361       "return": {
3362          "enabled": true,
3363          "auth": "spice",
3364          "port": 5920,
3365          "tls-port": 5921,
3366          "host": "0.0.0.0",
3367          "channels": [
3368             {
3369                "port": "54924",
3370                "family": "ipv4",
3371                "channel-type": 1,
3372                "connection-id": 1804289383,
3373                "host": "127.0.0.1",
3374                "channel-id": 0,
3375                "tls": true
3376             },
3377             {
3378                "port": "36710",
3379                "family": "ipv4",
3380                "channel-type": 4,
3381                "connection-id": 1804289383,
3382                "host": "127.0.0.1",
3383                "channel-id": 0,
3384                "tls": false
3385             },
3386             [ ... more channels follow ... ]
3387          ]
3388       }
3389    }
3390
3391 EQMP
3392
3393 #if defined(CONFIG_SPICE)
3394     {
3395         .name       = "query-spice",
3396         .args_type  = "",
3397         .mhandler.cmd_new = qmp_marshal_query_spice,
3398     },
3399 #endif
3400
3401 SQMP
3402 query-name
3403 ----------
3404
3405 Show VM name.
3406
3407 Return a json-object with the following information:
3408
3409 - "name": VM's name (json-string, optional)
3410
3411 Example:
3412
3413 -> { "execute": "query-name" }
3414 <- { "return": { "name": "qemu-name" } }
3415
3416 EQMP
3417
3418     {
3419         .name       = "query-name",
3420         .args_type  = "",
3421         .mhandler.cmd_new = qmp_marshal_query_name,
3422     },
3423
3424 SQMP
3425 query-uuid
3426 ----------
3427
3428 Show VM UUID.
3429
3430 Return a json-object with the following information:
3431
3432 - "UUID": Universally Unique Identifier (json-string)
3433
3434 Example:
3435
3436 -> { "execute": "query-uuid" }
3437 <- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } }
3438
3439 EQMP
3440
3441     {
3442         .name       = "query-uuid",
3443         .args_type  = "",
3444         .mhandler.cmd_new = qmp_marshal_query_uuid,
3445     },
3446
3447 SQMP
3448 query-command-line-options
3449 --------------------------
3450
3451 Show command line option schema.
3452
3453 Return a json-array of command line option schema for all options (or for
3454 the given option), returning an error if the given option doesn't exist.
3455
3456 Each array entry contains the following:
3457
3458 - "option": option name (json-string)
3459 - "parameters": a json-array describes all parameters of the option:
3460     - "name": parameter name (json-string)
3461     - "type": parameter type (one of 'string', 'boolean', 'number',
3462               or 'size')
3463     - "help": human readable description of the parameter
3464               (json-string, optional)
3465     - "default": default value string for the parameter
3466                  (json-string, optional)
3467
3468 Example:
3469
3470 -> { "execute": "query-command-line-options", "arguments": { "option": "option-rom" } }
3471 <- { "return": [
3472         {
3473             "parameters": [
3474                 {
3475                     "name": "romfile",
3476                     "type": "string"
3477                 },
3478                 {
3479                     "name": "bootindex",
3480                     "type": "number"
3481                 }
3482             ],
3483             "option": "option-rom"
3484         }
3485      ]
3486    }
3487
3488 EQMP
3489
3490     {
3491         .name       = "query-command-line-options",
3492         .args_type  = "option:s?",
3493         .mhandler.cmd_new = qmp_marshal_query_command_line_options,
3494     },
3495
3496 SQMP
3497 query-migrate
3498 -------------
3499
3500 Migration status.
3501
3502 Return a json-object. If migration is active there will be another json-object
3503 with RAM migration status and if block migration is active another one with
3504 block migration status.
3505
3506 The main json-object contains the following:
3507
3508 - "status": migration status (json-string)
3509      - Possible values: "setup", "active", "completed", "failed", "cancelled"
3510 - "total-time": total amount of ms since migration started.  If
3511                 migration has ended, it returns the total migration
3512                 time (json-int)
3513 - "setup-time" amount of setup time in milliseconds _before_ the
3514                iterations begin but _after_ the QMP command is issued.
3515                This is designed to provide an accounting of any activities
3516                (such as RDMA pinning) which may be expensive, but do not 
3517                actually occur during the iterative migration rounds 
3518                themselves. (json-int)
3519 - "downtime": only present when migration has finished correctly
3520               total amount in ms for downtime that happened (json-int)
3521 - "expected-downtime": only present while migration is active
3522                 total amount in ms for downtime that was calculated on
3523                 the last bitmap round (json-int)
3524 - "ram": only present if "status" is "active", it is a json-object with the
3525   following RAM information:
3526          - "transferred": amount transferred in bytes (json-int)
3527          - "remaining": amount remaining to transfer in bytes (json-int)
3528          - "total": total amount of memory in bytes (json-int)
3529          - "duplicate": number of pages filled entirely with the same
3530             byte (json-int)
3531             These are sent over the wire much more efficiently.
3532          - "skipped": number of skipped zero pages (json-int)
3533          - "normal" : number of whole pages transferred.  I.e. they
3534             were not sent as duplicate or xbzrle pages (json-int)
3535          - "normal-bytes" : number of bytes transferred in whole
3536             pages. This is just normal pages times size of one page,
3537             but this way upper levels don't need to care about page
3538             size (json-int)
3539          - "dirty-sync-count": times that dirty ram was synchronized (json-int)
3540 - "disk": only present if "status" is "active" and it is a block migration,
3541   it is a json-object with the following disk information:
3542          - "transferred": amount transferred in bytes (json-int)
3543          - "remaining": amount remaining to transfer in bytes json-int)
3544          - "total": total disk size in bytes (json-int)
3545 - "xbzrle-cache": only present if XBZRLE is active.
3546   It is a json-object with the following XBZRLE information:
3547          - "cache-size": XBZRLE cache size in bytes
3548          - "bytes": number of bytes transferred for XBZRLE compressed pages
3549          - "pages": number of XBZRLE compressed pages
3550          - "cache-miss": number of XBRZRLE page cache misses
3551          - "cache-miss-rate": rate of XBRZRLE page cache misses
3552          - "overflow": number of times XBZRLE overflows.  This means
3553            that the XBZRLE encoding was bigger than just sent the
3554            whole page, and then we sent the whole page instead (as as
3555            normal page).
3556
3557 Examples:
3558
3559 1. Before the first migration
3560
3561 -> { "execute": "query-migrate" }
3562 <- { "return": {} }
3563
3564 2. Migration is done and has succeeded
3565
3566 -> { "execute": "query-migrate" }
3567 <- { "return": {
3568         "status": "completed",
3569         "ram":{
3570           "transferred":123,
3571           "remaining":123,
3572           "total":246,
3573           "total-time":12345,
3574           "setup-time":12345,
3575           "downtime":12345,
3576           "duplicate":123,
3577           "normal":123,
3578           "normal-bytes":123456,
3579           "dirty-sync-count":15
3580         }
3581      }
3582    }
3583
3584 3. Migration is done and has failed
3585
3586 -> { "execute": "query-migrate" }
3587 <- { "return": { "status": "failed" } }
3588
3589 4. Migration is being performed and is not a block migration:
3590
3591 -> { "execute": "query-migrate" }
3592 <- {
3593       "return":{
3594          "status":"active",
3595          "ram":{
3596             "transferred":123,
3597             "remaining":123,
3598             "total":246,
3599             "total-time":12345,
3600             "setup-time":12345,
3601             "expected-downtime":12345,
3602             "duplicate":123,
3603             "normal":123,
3604             "normal-bytes":123456,
3605             "dirty-sync-count":15
3606          }
3607       }
3608    }
3609
3610 5. Migration is being performed and is a block migration:
3611
3612 -> { "execute": "query-migrate" }
3613 <- {
3614       "return":{
3615          "status":"active",
3616          "ram":{
3617             "total":1057024,
3618             "remaining":1053304,
3619             "transferred":3720,
3620             "total-time":12345,
3621             "setup-time":12345,
3622             "expected-downtime":12345,
3623             "duplicate":123,
3624             "normal":123,
3625             "normal-bytes":123456,
3626             "dirty-sync-count":15
3627          },
3628          "disk":{
3629             "total":20971520,
3630             "remaining":20880384,
3631             "transferred":91136
3632          }
3633       }
3634    }
3635
3636 6. Migration is being performed and XBZRLE is active:
3637
3638 -> { "execute": "query-migrate" }
3639 <- {
3640       "return":{
3641          "status":"active",
3642          "capabilities" : [ { "capability": "xbzrle", "state" : true } ],
3643          "ram":{
3644             "total":1057024,
3645             "remaining":1053304,
3646             "transferred":3720,
3647             "total-time":12345,
3648             "setup-time":12345,
3649             "expected-downtime":12345,
3650             "duplicate":10,
3651             "normal":3333,
3652             "normal-bytes":3412992,
3653             "dirty-sync-count":15
3654          },
3655          "xbzrle-cache":{
3656             "cache-size":67108864,
3657             "bytes":20971520,
3658             "pages":2444343,
3659             "cache-miss":2244,
3660             "cache-miss-rate":0.123,
3661             "overflow":34434
3662          }
3663       }
3664    }
3665
3666 EQMP
3667
3668     {
3669         .name       = "query-migrate",
3670         .args_type  = "",
3671         .mhandler.cmd_new = qmp_marshal_query_migrate,
3672     },
3673
3674 SQMP
3675 migrate-set-capabilities
3676 ------------------------
3677
3678 Enable/Disable migration capabilities
3679
3680 - "xbzrle": XBZRLE support
3681 - "rdma-pin-all": pin all pages when using RDMA during migration
3682 - "auto-converge": throttle down guest to help convergence of migration
3683 - "zero-blocks": compress zero blocks during block migration
3684 - "compress": use multiple compression threads to accelerate live migration
3685 - "events": generate events for each migration state change
3686 - "postcopy-ram": postcopy mode for live migration
3687
3688 Arguments:
3689
3690 Example:
3691
3692 -> { "execute": "migrate-set-capabilities" , "arguments":
3693      { "capabilities": [ { "capability": "xbzrle", "state": true } ] } }
3694
3695 EQMP
3696
3697     {
3698         .name       = "migrate-set-capabilities",
3699         .args_type  = "capabilities:q",
3700         .params     = "capability:s,state:b",
3701         .mhandler.cmd_new = qmp_marshal_migrate_set_capabilities,
3702     },
3703 SQMP
3704 query-migrate-capabilities
3705 --------------------------
3706
3707 Query current migration capabilities
3708
3709 - "capabilities": migration capabilities state
3710          - "xbzrle" : XBZRLE state (json-bool)
3711          - "rdma-pin-all" : RDMA Pin Page state (json-bool)
3712          - "auto-converge" : Auto Converge state (json-bool)
3713          - "zero-blocks" : Zero Blocks state (json-bool)
3714          - "compress": Multiple compression threads state (json-bool)
3715          - "events": Migration state change event state (json-bool)
3716          - "postcopy-ram": postcopy ram state (json-bool)
3717
3718 Arguments:
3719
3720 Example:
3721
3722 -> { "execute": "query-migrate-capabilities" }
3723 <- {"return": [
3724      {"state": false, "capability": "xbzrle"},
3725      {"state": false, "capability": "rdma-pin-all"},
3726      {"state": false, "capability": "auto-converge"},
3727      {"state": false, "capability": "zero-blocks"},
3728      {"state": false, "capability": "compress"},
3729      {"state": true, "capability": "events"},
3730      {"state": false, "capability": "postcopy-ram"}
3731    ]}
3732
3733 EQMP
3734
3735     {
3736         .name       = "query-migrate-capabilities",
3737         .args_type  = "",
3738         .mhandler.cmd_new = qmp_marshal_query_migrate_capabilities,
3739     },
3740
3741 SQMP
3742 migrate-set-parameters
3743 ----------------------
3744
3745 Set migration parameters
3746
3747 - "compress-level": set compression level during migration (json-int)
3748 - "compress-threads": set compression thread count for migration (json-int)
3749 - "decompress-threads": set decompression thread count for migration (json-int)
3750 - "cpu-throttle-initial": set initial percentage of time guest cpus are
3751                           throttled for auto-converge (json-int)
3752 - "cpu-throttle-increment": set throttle increasing percentage for
3753                             auto-converge (json-int)
3754
3755 Arguments:
3756
3757 Example:
3758
3759 -> { "execute": "migrate-set-parameters" , "arguments":
3760       { "compress-level": 1 } }
3761
3762 EQMP
3763
3764     {
3765         .name       = "migrate-set-parameters",
3766         .args_type  =
3767             "compress-level:i?,compress-threads:i?,decompress-threads:i?,cpu-throttle-initial:i?,cpu-throttle-increment:i?",
3768         .mhandler.cmd_new = qmp_marshal_migrate_set_parameters,
3769     },
3770 SQMP
3771 query-migrate-parameters
3772 ------------------------
3773
3774 Query current migration parameters
3775
3776 - "parameters": migration parameters value
3777          - "compress-level" : compression level value (json-int)
3778          - "compress-threads" : compression thread count value (json-int)
3779          - "decompress-threads" : decompression thread count value (json-int)
3780          - "cpu-throttle-initial" : initial percentage of time guest cpus are
3781                                     throttled (json-int)
3782          - "cpu-throttle-increment" : throttle increasing percentage for
3783                                       auto-converge (json-int)
3784
3785 Arguments:
3786
3787 Example:
3788
3789 -> { "execute": "query-migrate-parameters" }
3790 <- {
3791       "return": {
3792          "decompress-threads": 2,
3793          "cpu-throttle-increment": 10,
3794          "compress-threads": 8,
3795          "compress-level": 1,
3796          "cpu-throttle-initial": 20
3797       }
3798    }
3799
3800 EQMP
3801
3802     {
3803         .name       = "query-migrate-parameters",
3804         .args_type  = "",
3805         .mhandler.cmd_new = qmp_marshal_query_migrate_parameters,
3806     },
3807
3808 SQMP
3809 query-balloon
3810 -------------
3811
3812 Show balloon information.
3813
3814 Make an asynchronous request for balloon info. When the request completes a
3815 json-object will be returned containing the following data:
3816
3817 - "actual": current balloon value in bytes (json-int)
3818
3819 Example:
3820
3821 -> { "execute": "query-balloon" }
3822 <- {
3823       "return":{
3824          "actual":1073741824,
3825       }
3826    }
3827
3828 EQMP
3829
3830     {
3831         .name       = "query-balloon",
3832         .args_type  = "",
3833         .mhandler.cmd_new = qmp_marshal_query_balloon,
3834     },
3835
3836     {
3837         .name       = "query-block-jobs",
3838         .args_type  = "",
3839         .mhandler.cmd_new = qmp_marshal_query_block_jobs,