block: implement is_allocated for raw
[qemu.git] / qmp-commands.hx
1 HXCOMM QMP dispatch table and documentation
2 HXCOMM Text between SQMP and EQMP is copied to the QMP documention file and
3 HXCOMM does not show up in the other formats.
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_input_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_input_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_input_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         .params     = "filename",
150         .help       = "save screen into PPM image 'filename'",
151         .user_print = monitor_user_noop,
152         .mhandler.cmd_new = do_screen_dump,
153     },
154
155 SQMP
156 screendump
157 ----------
158
159 Save screen into PPM image.
160
161 Arguments:
162
163 - "filename": file path (json-string)
164
165 Example:
166
167 -> { "execute": "screendump", "arguments": { "filename": "/tmp/image" } }
168 <- { "return": {} }
169
170 EQMP
171
172     {
173         .name       = "stop",
174         .args_type  = "",
175         .mhandler.cmd_new = qmp_marshal_input_stop,
176     },
177
178 SQMP
179 stop
180 ----
181
182 Stop the emulator.
183
184 Arguments: None.
185
186 Example:
187
188 -> { "execute": "stop" }
189 <- { "return": {} }
190
191 EQMP
192
193     {
194         .name       = "cont",
195         .args_type  = "",
196         .mhandler.cmd_new = qmp_marshal_input_cont,
197     },
198
199 SQMP
200 cont
201 ----
202
203 Resume emulation.
204
205 Arguments: None.
206
207 Example:
208
209 -> { "execute": "cont" }
210 <- { "return": {} }
211
212 EQMP
213
214     {
215         .name       = "system_wakeup",
216         .args_type  = "",
217         .mhandler.cmd_new = qmp_marshal_input_system_wakeup,
218     },
219
220 SQMP
221 system_wakeup
222 -------------
223
224 Wakeup guest from suspend.
225
226 Arguments: None.
227
228 Example:
229
230 -> { "execute": "system_wakeup" }
231 <- { "return": {} }
232
233 EQMP
234
235     {
236         .name       = "system_reset",
237         .args_type  = "",
238         .mhandler.cmd_new = qmp_marshal_input_system_reset,
239     },
240
241 SQMP
242 system_reset
243 ------------
244
245 Reset the system.
246
247 Arguments: None.
248
249 Example:
250
251 -> { "execute": "system_reset" }
252 <- { "return": {} }
253
254 EQMP
255
256     {
257         .name       = "system_powerdown",
258         .args_type  = "",
259         .mhandler.cmd_new = qmp_marshal_input_system_powerdown,
260     },
261
262 SQMP
263 system_powerdown
264 ----------------
265
266 Send system power down event.
267
268 Arguments: None.
269
270 Example:
271
272 -> { "execute": "system_powerdown" }
273 <- { "return": {} }
274
275 EQMP
276
277     {
278         .name       = "device_add",
279         .args_type  = "device:O",
280         .params     = "driver[,prop=value][,...]",
281         .help       = "add device, like -device on the command line",
282         .user_print = monitor_user_noop,
283         .mhandler.cmd_new = do_device_add,
284     },
285
286 SQMP
287 device_add
288 ----------
289
290 Add a device.
291
292 Arguments:
293
294 - "driver": the name of the new device's driver (json-string)
295 - "bus": the device's parent bus (device tree path, json-string, optional)
296 - "id": the device's ID, must be unique (json-string)
297 - device properties
298
299 Example:
300
301 -> { "execute": "device_add", "arguments": { "driver": "e1000", "id": "net1" } }
302 <- { "return": {} }
303
304 Notes:
305
306 (1) For detailed information about this command, please refer to the
307     'docs/qdev-device-use.txt' file.
308
309 (2) It's possible to list device properties by running QEMU with the
310     "-device DEVICE,\?" command-line argument, where DEVICE is the device's name
311
312 EQMP
313
314     {
315         .name       = "device_del",
316         .args_type  = "id:s",
317         .mhandler.cmd_new = qmp_marshal_input_device_del,
318     },
319
320 SQMP
321 device_del
322 ----------
323
324 Remove a device.
325
326 Arguments:
327
328 - "id": the device's ID (json-string)
329
330 Example:
331
332 -> { "execute": "device_del", "arguments": { "id": "net1" } }
333 <- { "return": {} }
334
335 EQMP
336
337     {
338         .name       = "cpu",
339         .args_type  = "index:i",
340         .mhandler.cmd_new = qmp_marshal_input_cpu,
341     },
342
343 SQMP
344 cpu
345 ---
346
347 Set the default CPU.
348
349 Arguments:
350
351 - "index": the CPU's index (json-int)
352
353 Example:
354
355 -> { "execute": "cpu", "arguments": { "index": 0 } }
356 <- { "return": {} }
357
358 Note: CPUs' indexes are obtained with the 'query-cpus' command.
359
360 EQMP
361
362     {
363         .name       = "memsave",
364         .args_type  = "val:l,size:i,filename:s,cpu:i?",
365         .mhandler.cmd_new = qmp_marshal_input_memsave,
366     },
367
368 SQMP
369 memsave
370 -------
371
372 Save to disk virtual memory dump starting at 'val' of size 'size'.
373
374 Arguments:
375
376 - "val": the starting address (json-int)
377 - "size": the memory size, in bytes (json-int)
378 - "filename": file path (json-string)
379 - "cpu": virtual CPU index (json-int, optional)
380
381 Example:
382
383 -> { "execute": "memsave",
384              "arguments": { "val": 10,
385                             "size": 100,
386                             "filename": "/tmp/virtual-mem-dump" } }
387 <- { "return": {} }
388
389 EQMP
390
391     {
392         .name       = "pmemsave",
393         .args_type  = "val:l,size:i,filename:s",
394         .mhandler.cmd_new = qmp_marshal_input_pmemsave,
395     },
396
397 SQMP
398 pmemsave
399 --------
400
401 Save to disk physical memory dump starting at 'val' of size 'size'.
402
403 Arguments:
404
405 - "val": the starting address (json-int)
406 - "size": the memory size, in bytes (json-int)
407 - "filename": file path (json-string)
408
409 Example:
410
411 -> { "execute": "pmemsave",
412              "arguments": { "val": 10,
413                             "size": 100,
414                             "filename": "/tmp/physical-mem-dump" } }
415 <- { "return": {} }
416
417 EQMP
418
419     {
420         .name       = "inject-nmi",
421         .args_type  = "",
422         .mhandler.cmd_new = qmp_marshal_input_inject_nmi,
423     },
424
425 SQMP
426 inject-nmi
427 ----------
428
429 Inject an NMI on guest's CPUs.
430
431 Arguments: None.
432
433 Example:
434
435 -> { "execute": "inject-nmi" }
436 <- { "return": {} }
437
438 Note: inject-nmi is only supported for x86 guest currently, it will
439       returns "Unsupported" error for non-x86 guest.
440
441 EQMP
442
443     {
444         .name       = "xen-save-devices-state",
445         .args_type  = "filename:F",
446     .mhandler.cmd_new = qmp_marshal_input_xen_save_devices_state,
447     },
448
449 SQMP
450 xen-save-devices-state
451 -------
452
453 Save the state of all devices to file. The RAM and the block devices
454 of the VM are not saved by this command.
455
456 Arguments:
457
458 - "filename": the file to save the state of the devices to as binary
459 data. See xen-save-devices-state.txt for a description of the binary
460 format.
461
462 Example:
463
464 -> { "execute": "xen-save-devices-state",
465      "arguments": { "filename": "/tmp/save" } }
466 <- { "return": {} }
467
468 EQMP
469
470     {
471         .name       = "migrate",
472         .args_type  = "detach:-d,blk:-b,inc:-i,uri:s",
473         .mhandler.cmd_new = qmp_marshal_input_migrate,
474     },
475
476 SQMP
477 migrate
478 -------
479
480 Migrate to URI.
481
482 Arguments:
483
484 - "blk": block migration, full disk copy (json-bool, optional)
485 - "inc": incremental disk copy (json-bool, optional)
486 - "uri": Destination URI (json-string)
487
488 Example:
489
490 -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
491 <- { "return": {} }
492
493 Notes:
494
495 (1) The 'query-migrate' command should be used to check migration's progress
496     and final result (this information is provided by the 'status' member)
497 (2) All boolean arguments default to false
498 (3) The user Monitor's "detach" argument is invalid in QMP and should not
499     be used
500
501 EQMP
502
503     {
504         .name       = "migrate_cancel",
505         .args_type  = "",
506         .mhandler.cmd_new = qmp_marshal_input_migrate_cancel,
507     },
508
509 SQMP
510 migrate_cancel
511 --------------
512
513 Cancel the current migration.
514
515 Arguments: None.
516
517 Example:
518
519 -> { "execute": "migrate_cancel" }
520 <- { "return": {} }
521
522 EQMP
523
524     {
525         .name       = "migrate_set_speed",
526         .args_type  = "value:o",
527         .mhandler.cmd_new = qmp_marshal_input_migrate_set_speed,
528     },
529
530 SQMP
531 migrate_set_speed
532 -----------------
533
534 Set maximum speed for migrations.
535
536 Arguments:
537
538 - "value": maximum speed, in bytes per second (json-int)
539
540 Example:
541
542 -> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } }
543 <- { "return": {} }
544
545 EQMP
546
547     {
548         .name       = "migrate_set_downtime",
549         .args_type  = "value:T",
550         .mhandler.cmd_new = qmp_marshal_input_migrate_set_downtime,
551     },
552
553 SQMP
554 migrate_set_downtime
555 --------------------
556
557 Set maximum tolerated downtime (in seconds) for migrations.
558
559 Arguments:
560
561 - "value": maximum downtime (json-number)
562
563 Example:
564
565 -> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } }
566 <- { "return": {} }
567
568 EQMP
569
570     {
571         .name       = "client_migrate_info",
572         .args_type  = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
573         .params     = "protocol hostname port tls-port cert-subject",
574         .help       = "send migration info to spice/vnc client",
575         .user_print = monitor_user_noop,
576         .mhandler.cmd_async = client_migrate_info,
577         .flags      = MONITOR_CMD_ASYNC,
578     },
579
580 SQMP
581 client_migrate_info
582 ------------------
583
584 Set the spice/vnc connection info for the migration target.  The spice/vnc
585 server will ask the spice/vnc client to automatically reconnect using the
586 new parameters (if specified) once the vm migration finished successfully.
587
588 Arguments:
589
590 - "protocol":     protocol: "spice" or "vnc" (json-string)
591 - "hostname":     migration target hostname (json-string)
592 - "port":         spice/vnc tcp port for plaintext channels (json-int, optional)
593 - "tls-port":     spice tcp port for tls-secured channels (json-int, optional)
594 - "cert-subject": server certificate subject (json-string, optional)
595
596 Example:
597
598 -> { "execute": "client_migrate_info",
599      "arguments": { "protocol": "spice",
600                     "hostname": "virt42.lab.kraxel.org",
601                     "port": 1234 } }
602 <- { "return": {} }
603
604 EQMP
605
606     {
607         .name       = "dump-guest-memory",
608         .args_type  = "paging:b,protocol:s,begin:i?,end:i?",
609         .params     = "-p protocol [begin] [length]",
610         .help       = "dump guest memory to file",
611         .user_print = monitor_user_noop,
612         .mhandler.cmd_new = qmp_marshal_input_dump_guest_memory,
613     },
614
615 SQMP
616 dump
617
618
619 Dump guest memory to file. The file can be processed with crash or gdb.
620
621 Arguments:
622
623 - "paging": do paging to get guest's memory mapping (json-bool)
624 - "protocol": destination file(started with "file:") or destination file
625               descriptor (started with "fd:") (json-string)
626 - "begin": the starting physical address. It's optional, and should be specified
627            with length together (json-int)
628 - "length": the memory size, in bytes. It's optional, and should be specified
629             with begin together (json-int)
630
631 Example:
632
633 -> { "execute": "dump-guest-memory", "arguments": { "protocol": "fd:dump" } }
634 <- { "return": {} }
635
636 Notes:
637
638 (1) All boolean arguments default to false
639
640 EQMP
641
642     {
643         .name       = "netdev_add",
644         .args_type  = "netdev:O",
645         .mhandler.cmd_new = qmp_netdev_add,
646     },
647
648 SQMP
649 netdev_add
650 ----------
651
652 Add host network device.
653
654 Arguments:
655
656 - "type": the device type, "tap", "user", ... (json-string)
657 - "id": the device's ID, must be unique (json-string)
658 - device options
659
660 Example:
661
662 -> { "execute": "netdev_add", "arguments": { "type": "user", "id": "netdev1" } }
663 <- { "return": {} }
664
665 Note: The supported device options are the same ones supported by the '-net'
666       command-line argument, which are listed in the '-help' output or QEMU's
667       manual
668
669 EQMP
670
671     {
672         .name       = "netdev_del",
673         .args_type  = "id:s",
674         .mhandler.cmd_new = qmp_marshal_input_netdev_del,
675     },
676
677 SQMP
678 netdev_del
679 ----------
680
681 Remove host network device.
682
683 Arguments:
684
685 - "id": the device's ID, must be unique (json-string)
686
687 Example:
688
689 -> { "execute": "netdev_del", "arguments": { "id": "netdev1" } }
690 <- { "return": {} }
691
692
693 EQMP
694
695     {
696         .name       = "block_resize",
697         .args_type  = "device:B,size:o",
698         .mhandler.cmd_new = qmp_marshal_input_block_resize,
699     },
700
701 SQMP
702 block_resize
703 ------------
704
705 Resize a block image while a guest is running.
706
707 Arguments:
708
709 - "device": the device's ID, must be unique (json-string)
710 - "size": new size
711
712 Example:
713
714 -> { "execute": "block_resize", "arguments": { "device": "scratch", "size": 1073741824 } }
715 <- { "return": {} }
716
717 EQMP
718
719     {
720         .name       = "block-stream",
721         .args_type  = "device:B,base:s?,speed:o?",
722         .mhandler.cmd_new = qmp_marshal_input_block_stream,
723     },
724
725     {
726         .name       = "block-job-set-speed",
727         .args_type  = "device:B,speed:o",
728         .mhandler.cmd_new = qmp_marshal_input_block_job_set_speed,
729     },
730
731     {
732         .name       = "block-job-cancel",
733         .args_type  = "device:B",
734         .mhandler.cmd_new = qmp_marshal_input_block_job_cancel,
735     },
736     {
737         .name       = "transaction",
738         .args_type  = "actions:q",
739         .mhandler.cmd_new = qmp_marshal_input_transaction,
740     },
741
742 SQMP
743 transaction
744 -----------
745
746 Atomically operate on one or more block devices.  The only supported
747 operation for now is snapshotting.  If there is any failure performing
748 any of the operations, all snapshots for the group are abandoned, and
749 the original disks pre-snapshot attempt are used.
750
751 A list of dictionaries is accepted, that contains the actions to be performed.
752 For snapshots this is the device, the file to use for the new snapshot,
753 and the format.  The default format, if not specified, is qcow2.
754
755 Each new snapshot defaults to being created by QEMU (wiping any
756 contents if the file already exists), but it is also possible to reuse
757 an externally-created file.  In the latter case, you should ensure that
758 the new image file has the same contents as the current one; QEMU cannot
759 perform any meaningful check.  Typically this is achieved by using the
760 current image file as the backing file for the new image.
761
762 Arguments:
763
764 actions array:
765     - "type": the operation to perform.  The only supported
766       value is "blockdev-snapshot-sync". (json-string)
767     - "data": a dictionary.  The contents depend on the value
768       of "type".  When "type" is "blockdev-snapshot-sync":
769       - "device": device name to snapshot (json-string)
770       - "snapshot-file": name of new image file (json-string)
771       - "format": format of new image (json-string, optional)
772       - "mode": whether and how QEMU should create the snapshot file
773         (NewImageMode, optional, default "absolute-paths")
774
775 Example:
776
777 -> { "execute": "transaction",
778      "arguments": { "actions": [
779          { 'type': 'blockdev-snapshot-sync', 'data' : { "device": "ide-hd0",
780                                          "snapshot-file": "/some/place/my-image",
781                                          "format": "qcow2" } },
782          { 'type': 'blockdev-snapshot-sync', 'data' : { "device": "ide-hd1",
783                                          "snapshot-file": "/some/place/my-image2",
784                                          "mode": "existing",
785                                          "format": "qcow2" } } ] } }
786 <- { "return": {} }
787
788 EQMP
789
790     {
791         .name       = "blockdev-snapshot-sync",
792         .args_type  = "device:B,snapshot-file:s,format:s?,mode:s?",
793         .mhandler.cmd_new = qmp_marshal_input_blockdev_snapshot_sync,
794     },
795
796 SQMP
797 blockdev-snapshot-sync
798 ----------------------
799
800 Synchronous snapshot of a block device. snapshot-file specifies the
801 target of the new image. If the file exists, or if it is a device, the
802 snapshot will be created in the existing file/device. If does not
803 exist, a new file will be created. format specifies the format of the
804 snapshot image, default is qcow2.
805
806 Arguments:
807
808 - "device": device name to snapshot (json-string)
809 - "snapshot-file": name of new image file (json-string)
810 - "mode": whether and how QEMU should create the snapshot file
811   (NewImageMode, optional, default "absolute-paths")
812 - "format": format of new image (json-string, optional)
813
814 Example:
815
816 -> { "execute": "blockdev-snapshot-sync", "arguments": { "device": "ide-hd0",
817                                                          "snapshot-file":
818                                                         "/some/place/my-image",
819                                                         "format": "qcow2" } }
820 <- { "return": {} }
821
822 EQMP
823
824     {
825         .name       = "balloon",
826         .args_type  = "value:M",
827         .mhandler.cmd_new = qmp_marshal_input_balloon,
828     },
829
830 SQMP
831 balloon
832 -------
833
834 Request VM to change its memory allocation (in bytes).
835
836 Arguments:
837
838 - "value": New memory allocation (json-int)
839
840 Example:
841
842 -> { "execute": "balloon", "arguments": { "value": 536870912 } }
843 <- { "return": {} }
844
845 EQMP
846
847     {
848         .name       = "set_link",
849         .args_type  = "name:s,up:b",
850         .mhandler.cmd_new = qmp_marshal_input_set_link,
851     },
852
853 SQMP
854 set_link
855 --------
856
857 Change the link status of a network adapter.
858
859 Arguments:
860
861 - "name": network device name (json-string)
862 - "up": status is up (json-bool)
863
864 Example:
865
866 -> { "execute": "set_link", "arguments": { "name": "e1000.0", "up": false } }
867 <- { "return": {} }
868
869 EQMP
870
871     {
872         .name       = "getfd",
873         .args_type  = "fdname:s",
874         .params     = "getfd name",
875         .help       = "receive a file descriptor via SCM rights and assign it a name",
876         .user_print = monitor_user_noop,
877         .mhandler.cmd_new = do_getfd,
878     },
879
880 SQMP
881 getfd
882 -----
883
884 Receive a file descriptor via SCM rights and assign it a name.
885
886 Arguments:
887
888 - "fdname": file descriptor name (json-string)
889
890 Example:
891
892 -> { "execute": "getfd", "arguments": { "fdname": "fd1" } }
893 <- { "return": {} }
894
895 EQMP
896
897     {
898         .name       = "closefd",
899         .args_type  = "fdname:s",
900         .params     = "closefd name",
901         .help       = "close a file descriptor previously passed via SCM rights",
902         .user_print = monitor_user_noop,
903         .mhandler.cmd_new = do_closefd,
904     },
905
906 SQMP
907 closefd
908 -------
909
910 Close a file descriptor previously passed via SCM rights.
911
912 Arguments:
913
914 - "fdname": file descriptor name (json-string)
915
916 Example:
917
918 -> { "execute": "closefd", "arguments": { "fdname": "fd1" } }
919 <- { "return": {} }
920
921 EQMP
922
923     {
924         .name       = "block_passwd",
925         .args_type  = "device:B,password:s",
926         .mhandler.cmd_new = qmp_marshal_input_block_passwd,
927     },
928
929 SQMP
930 block_passwd
931 ------------
932
933 Set the password of encrypted block devices.
934
935 Arguments:
936
937 - "device": device name (json-string)
938 - "password": password (json-string)
939
940 Example:
941
942 -> { "execute": "block_passwd", "arguments": { "device": "ide0-hd0",
943                                                "password": "12345" } }
944 <- { "return": {} }
945
946 EQMP
947
948     {
949         .name       = "block_set_io_throttle",
950         .args_type  = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
951         .mhandler.cmd_new = qmp_marshal_input_block_set_io_throttle,
952     },
953
954 SQMP
955 block_set_io_throttle
956 ------------
957
958 Change I/O throttle limits for a block drive.
959
960 Arguments:
961
962 - "device": device name (json-string)
963 - "bps":  total throughput limit in bytes per second(json-int)
964 - "bps_rd":  read throughput limit in bytes per second(json-int)
965 - "bps_wr":  read throughput limit in bytes per second(json-int)
966 - "iops":  total I/O operations per second(json-int)
967 - "iops_rd":  read I/O operations per second(json-int)
968 - "iops_wr":  write I/O operations per second(json-int)
969
970 Example:
971
972 -> { "execute": "block_set_io_throttle", "arguments": { "device": "virtio0",
973                                                "bps": "1000000",
974                                                "bps_rd": "0",
975                                                "bps_wr": "0",
976                                                "iops": "0",
977                                                "iops_rd": "0",
978                                                "iops_wr": "0" } }
979 <- { "return": {} }
980
981 EQMP
982
983     {
984         .name       = "set_password",
985         .args_type  = "protocol:s,password:s,connected:s?",
986         .mhandler.cmd_new = qmp_marshal_input_set_password,
987     },
988
989 SQMP
990 set_password
991 ------------
992
993 Set the password for vnc/spice protocols.
994
995 Arguments:
996
997 - "protocol": protocol name (json-string)
998 - "password": password (json-string)
999 - "connected": [ keep | disconnect | fail ] (josn-string, optional)
1000
1001 Example:
1002
1003 -> { "execute": "set_password", "arguments": { "protocol": "vnc",
1004                                                "password": "secret" } }
1005 <- { "return": {} }
1006
1007 EQMP
1008
1009     {
1010         .name       = "expire_password",
1011         .args_type  = "protocol:s,time:s",
1012         .mhandler.cmd_new = qmp_marshal_input_expire_password,
1013     },
1014
1015 SQMP
1016 expire_password
1017 ---------------
1018
1019 Set the password expire time for vnc/spice protocols.
1020
1021 Arguments:
1022
1023 - "protocol": protocol name (json-string)
1024 - "time": [ now | never | +secs | secs ] (json-string)
1025
1026 Example:
1027
1028 -> { "execute": "expire_password", "arguments": { "protocol": "vnc",
1029                                                   "time": "+60" } }
1030 <- { "return": {} }
1031
1032 EQMP
1033
1034     {
1035         .name       = "add_client",
1036         .args_type  = "protocol:s,fdname:s,skipauth:b?,tls:b?",
1037         .params     = "protocol fdname skipauth tls",
1038         .help       = "add a graphics client",
1039         .user_print = monitor_user_noop,
1040         .mhandler.cmd_new = add_graphics_client,
1041     },
1042
1043 SQMP
1044 add_client
1045 ----------
1046
1047 Add a graphics client
1048
1049 Arguments:
1050
1051 - "protocol": protocol name (json-string)
1052 - "fdname": file descriptor name (json-string)
1053 - "skipauth": whether to skip authentication (json-bool, optional)
1054 - "tls": whether to perform TLS (json-bool, optional)
1055
1056 Example:
1057
1058 -> { "execute": "add_client", "arguments": { "protocol": "vnc",
1059                                              "fdname": "myclient" } }
1060 <- { "return": {} }
1061
1062 EQMP
1063     {
1064         .name       = "qmp_capabilities",
1065         .args_type  = "",
1066         .params     = "",
1067         .help       = "enable QMP capabilities",
1068         .user_print = monitor_user_noop,
1069         .mhandler.cmd_new = do_qmp_capabilities,
1070     },
1071
1072 SQMP
1073 qmp_capabilities
1074 ----------------
1075
1076 Enable QMP capabilities.
1077
1078 Arguments: None.
1079
1080 Example:
1081
1082 -> { "execute": "qmp_capabilities" }
1083 <- { "return": {} }
1084
1085 Note: This command must be issued before issuing any other command.
1086
1087 EQMP
1088
1089     {
1090         .name       = "human-monitor-command",
1091         .args_type  = "command-line:s,cpu-index:i?",
1092         .mhandler.cmd_new = qmp_marshal_input_human_monitor_command,
1093     },
1094
1095 SQMP
1096 human-monitor-command
1097 ---------------------
1098
1099 Execute a Human Monitor command.
1100
1101 Arguments: 
1102
1103 - command-line: the command name and its arguments, just like the
1104                 Human Monitor's shell (json-string)
1105 - cpu-index: select the CPU number to be used by commands which access CPU
1106              data, like 'info registers'. The Monitor selects CPU 0 if this
1107              argument is not provided (json-int, optional)
1108
1109 Example:
1110
1111 -> { "execute": "human-monitor-command", "arguments": { "command-line": "info kvm" } }
1112 <- { "return": "kvm support: enabled\r\n" }
1113
1114 Notes:
1115
1116 (1) The Human Monitor is NOT an stable interface, this means that command
1117     names, arguments and responses can change or be removed at ANY time.
1118     Applications that rely on long term stability guarantees should NOT
1119     use this command
1120
1121 (2) Limitations:
1122
1123     o This command is stateless, this means that commands that depend
1124       on state information (such as getfd) might not work
1125
1126     o Commands that prompt the user for data (eg. 'cont' when the block
1127       device is encrypted) don't currently work
1128
1129 3. Query Commands
1130 =================
1131
1132 HXCOMM Each query command below is inside a SQMP/EQMP section, do NOT change
1133 HXCOMM this! We will possibly move query commands definitions inside those
1134 HXCOMM sections, just like regular commands.
1135
1136 EQMP
1137
1138 SQMP
1139 query-version
1140 -------------
1141
1142 Show QEMU version.
1143
1144 Return a json-object with the following information:
1145
1146 - "qemu": A json-object containing three integer values:
1147     - "major": QEMU's major version (json-int)
1148     - "minor": QEMU's minor version (json-int)
1149     - "micro": QEMU's micro version (json-int)
1150 - "package": package's version (json-string)
1151
1152 Example:
1153
1154 -> { "execute": "query-version" }
1155 <- {
1156       "return":{
1157          "qemu":{
1158             "major":0,
1159             "minor":11,
1160             "micro":5
1161          },
1162          "package":""
1163       }
1164    }
1165
1166 EQMP
1167
1168     {
1169         .name       = "query-version",
1170         .args_type  = "",
1171         .mhandler.cmd_new = qmp_marshal_input_query_version,
1172     },
1173
1174 SQMP
1175 query-commands
1176 --------------
1177
1178 List QMP available commands.
1179
1180 Each command is represented by a json-object, the returned value is a json-array
1181 of all commands.
1182
1183 Each json-object contain:
1184
1185 - "name": command's name (json-string)
1186
1187 Example:
1188
1189 -> { "execute": "query-commands" }
1190 <- {
1191       "return":[
1192          {
1193             "name":"query-balloon"
1194          },
1195          {
1196             "name":"system_powerdown"
1197          }
1198       ]
1199    }
1200
1201 Note: This example has been shortened as the real response is too long.
1202
1203 EQMP
1204
1205     {
1206         .name       = "query-commands",
1207         .args_type  = "",
1208         .mhandler.cmd_new = qmp_marshal_input_query_commands,
1209     },
1210
1211 SQMP
1212 query-events
1213 --------------
1214
1215 List QMP available events.
1216
1217 Each event is represented by a json-object, the returned value is a json-array
1218 of all events.
1219
1220 Each json-object contains:
1221
1222 - "name": event's name (json-string)
1223
1224 Example:
1225
1226 -> { "execute": "query-events" }
1227 <- {
1228       "return":[
1229          {
1230             "name":"SHUTDOWN"
1231          },
1232          {
1233             "name":"RESET"
1234          }
1235       ]
1236    }
1237
1238 Note: This example has been shortened as the real response is too long.
1239
1240 EQMP
1241
1242     {
1243         .name       = "query-events",
1244         .args_type  = "",
1245         .mhandler.cmd_new = qmp_marshal_input_query_events,
1246     },
1247
1248 SQMP
1249 query-chardev
1250 -------------
1251
1252 Each device is represented by a json-object. The returned value is a json-array
1253 of all devices.
1254
1255 Each json-object contain the following:
1256
1257 - "label": device's label (json-string)
1258 - "filename": device's file (json-string)
1259
1260 Example:
1261
1262 -> { "execute": "query-chardev" }
1263 <- {
1264       "return":[
1265          {
1266             "label":"monitor",
1267             "filename":"stdio"
1268          },
1269          {
1270             "label":"serial0",
1271             "filename":"vc"
1272          }
1273       ]
1274    }
1275
1276 EQMP
1277
1278     {
1279         .name       = "query-chardev",
1280         .args_type  = "",
1281         .mhandler.cmd_new = qmp_marshal_input_query_chardev,
1282     },
1283
1284 SQMP
1285 query-block
1286 -----------
1287
1288 Show the block devices.
1289
1290 Each block device information is stored in a json-object and the returned value
1291 is a json-array of all devices.
1292
1293 Each json-object contain the following:
1294
1295 - "device": device name (json-string)
1296 - "type": device type (json-string)
1297          - deprecated, retained for backward compatibility
1298          - Possible values: "unknown"
1299 - "removable": true if the device is removable, false otherwise (json-bool)
1300 - "locked": true if the device is locked, false otherwise (json-bool)
1301 - "tray-open": only present if removable, true if the device has a tray,
1302                and it is open (json-bool)
1303 - "inserted": only present if the device is inserted, it is a json-object
1304    containing the following:
1305          - "file": device file name (json-string)
1306          - "ro": true if read-only, false otherwise (json-bool)
1307          - "drv": driver format name (json-string)
1308              - Possible values: "blkdebug", "bochs", "cloop", "cow", "dmg",
1309                                 "file", "file", "ftp", "ftps", "host_cdrom",
1310                                 "host_device", "host_floppy", "http", "https",
1311                                 "nbd", "parallels", "qcow", "qcow2", "raw",
1312                                 "tftp", "vdi", "vmdk", "vpc", "vvfat"
1313          - "backing_file": backing file name (json-string, optional)
1314          - "encrypted": true if encrypted, false otherwise (json-bool)
1315          - "bps": limit total bytes per second (json-int)
1316          - "bps_rd": limit read bytes per second (json-int)
1317          - "bps_wr": limit write bytes per second (json-int)
1318          - "iops": limit total I/O operations per second (json-int)
1319          - "iops_rd": limit read operations per second (json-int)
1320          - "iops_wr": limit write operations per second (json-int)
1321
1322 - "io-status": I/O operation status, only present if the device supports it
1323                and the VM is configured to stop on errors. It's always reset
1324                to "ok" when the "cont" command is issued (json_string, optional)
1325              - Possible values: "ok", "failed", "nospace"
1326
1327 Example:
1328
1329 -> { "execute": "query-block" }
1330 <- {
1331       "return":[
1332          {
1333             "io-status": "ok",
1334             "device":"ide0-hd0",
1335             "locked":false,
1336             "removable":false,
1337             "inserted":{
1338                "ro":false,
1339                "drv":"qcow2",
1340                "encrypted":false,
1341                "file":"disks/test.img",
1342                "bps":1000000,
1343                "bps_rd":0,
1344                "bps_wr":0,
1345                "iops":1000000,
1346                "iops_rd":0,
1347                "iops_wr":0,
1348             },
1349             "type":"unknown"
1350          },
1351          {
1352             "io-status": "ok",
1353             "device":"ide1-cd0",
1354             "locked":false,
1355             "removable":true,
1356             "type":"unknown"
1357          },
1358          {
1359             "device":"floppy0",
1360             "locked":false,
1361             "removable":true,
1362             "type":"unknown"
1363          },
1364          {
1365             "device":"sd0",
1366             "locked":false,
1367             "removable":true,
1368             "type":"unknown"
1369          }
1370       ]
1371    }
1372
1373 EQMP
1374
1375     {
1376         .name       = "query-block",
1377         .args_type  = "",
1378         .mhandler.cmd_new = qmp_marshal_input_query_block,
1379     },
1380
1381 SQMP
1382 query-blockstats
1383 ----------------
1384
1385 Show block device statistics.
1386
1387 Each device statistic information is stored in a json-object and the returned
1388 value is a json-array of all devices.
1389
1390 Each json-object contain the following:
1391
1392 - "device": device name (json-string)
1393 - "stats": A json-object with the statistics information, it contains:
1394     - "rd_bytes": bytes read (json-int)
1395     - "wr_bytes": bytes written (json-int)
1396     - "rd_operations": read operations (json-int)
1397     - "wr_operations": write operations (json-int)
1398     - "flush_operations": cache flush operations (json-int)
1399     - "wr_total_time_ns": total time spend on writes in nano-seconds (json-int)
1400     - "rd_total_time_ns": total time spend on reads in nano-seconds (json-int)
1401     - "flush_total_time_ns": total time spend on cache flushes in nano-seconds (json-int)
1402     - "wr_highest_offset": Highest offset of a sector written since the
1403                            BlockDriverState has been opened (json-int)
1404 - "parent": Contains recursively the statistics of the underlying
1405             protocol (e.g. the host file for a qcow2 image). If there is
1406             no underlying protocol, this field is omitted
1407             (json-object, optional)
1408
1409 Example:
1410
1411 -> { "execute": "query-blockstats" }
1412 <- {
1413       "return":[
1414          {
1415             "device":"ide0-hd0",
1416             "parent":{
1417                "stats":{
1418                   "wr_highest_offset":3686448128,
1419                   "wr_bytes":9786368,
1420                   "wr_operations":751,
1421                   "rd_bytes":122567168,
1422                   "rd_operations":36772
1423                   "wr_total_times_ns":313253456
1424                   "rd_total_times_ns":3465673657
1425                   "flush_total_times_ns":49653
1426                   "flush_operations":61,
1427                }
1428             },
1429             "stats":{
1430                "wr_highest_offset":2821110784,
1431                "wr_bytes":9786368,
1432                "wr_operations":692,
1433                "rd_bytes":122739200,
1434                "rd_operations":36604
1435                "flush_operations":51,
1436                "wr_total_times_ns":313253456
1437                "rd_total_times_ns":3465673657
1438                "flush_total_times_ns":49653
1439             }
1440          },
1441          {
1442             "device":"ide1-cd0",
1443             "stats":{
1444                "wr_highest_offset":0,
1445                "wr_bytes":0,
1446                "wr_operations":0,
1447                "rd_bytes":0,
1448                "rd_operations":0
1449                "flush_operations":0,
1450                "wr_total_times_ns":0
1451                "rd_total_times_ns":0
1452                "flush_total_times_ns":0
1453             }
1454          },
1455          {
1456             "device":"floppy0",
1457             "stats":{
1458                "wr_highest_offset":0,
1459                "wr_bytes":0,
1460                "wr_operations":0,
1461                "rd_bytes":0,
1462                "rd_operations":0
1463                "flush_operations":0,
1464                "wr_total_times_ns":0
1465                "rd_total_times_ns":0
1466                "flush_total_times_ns":0
1467             }
1468          },
1469          {
1470             "device":"sd0",
1471             "stats":{
1472                "wr_highest_offset":0,
1473                "wr_bytes":0,
1474                "wr_operations":0,
1475                "rd_bytes":0,
1476                "rd_operations":0
1477                "flush_operations":0,
1478                "wr_total_times_ns":0
1479                "rd_total_times_ns":0
1480                "flush_total_times_ns":0
1481             }
1482          }
1483       ]
1484    }
1485
1486 EQMP
1487
1488     {
1489         .name       = "query-blockstats",
1490         .args_type  = "",
1491         .mhandler.cmd_new = qmp_marshal_input_query_blockstats,
1492     },
1493
1494 SQMP
1495 query-cpus
1496 ----------
1497
1498 Show CPU information.
1499
1500 Return a json-array. Each CPU is represented by a json-object, which contains:
1501
1502 - "CPU": CPU index (json-int)
1503 - "current": true if this is the current CPU, false otherwise (json-bool)
1504 - "halted": true if the cpu is halted, false otherwise (json-bool)
1505 - Current program counter. The key's name depends on the architecture:
1506      "pc": i386/x86_64 (json-int)
1507      "nip": PPC (json-int)
1508      "pc" and "npc": sparc (json-int)
1509      "PC": mips (json-int)
1510 - "thread_id": ID of the underlying host thread (json-int)
1511
1512 Example:
1513
1514 -> { "execute": "query-cpus" }
1515 <- {
1516       "return":[
1517          {
1518             "CPU":0,
1519             "current":true,
1520             "halted":false,
1521             "pc":3227107138
1522             "thread_id":3134
1523          },
1524          {
1525             "CPU":1,
1526             "current":false,
1527             "halted":true,
1528             "pc":7108165
1529             "thread_id":3135
1530          }
1531       ]
1532    }
1533
1534 EQMP
1535
1536     {
1537         .name       = "query-cpus",
1538         .args_type  = "",
1539         .mhandler.cmd_new = qmp_marshal_input_query_cpus,
1540     },
1541
1542 SQMP
1543 query-pci
1544 ---------
1545
1546 PCI buses and devices information.
1547
1548 The returned value is a json-array of all buses. Each bus is represented by
1549 a json-object, which has a key with a json-array of all PCI devices attached
1550 to it. Each device is represented by a json-object.
1551
1552 The bus json-object contains the following:
1553
1554 - "bus": bus number (json-int)
1555 - "devices": a json-array of json-objects, each json-object represents a
1556              PCI device
1557
1558 The PCI device json-object contains the following:
1559
1560 - "bus": identical to the parent's bus number (json-int)
1561 - "slot": slot number (json-int)
1562 - "function": function number (json-int)
1563 - "class_info": a json-object containing:
1564      - "desc": device class description (json-string, optional)
1565      - "class": device class number (json-int)
1566 - "id": a json-object containing:
1567      - "device": device ID (json-int)
1568      - "vendor": vendor ID (json-int)
1569 - "irq": device's IRQ if assigned (json-int, optional)
1570 - "qdev_id": qdev id string (json-string)
1571 - "pci_bridge": It's a json-object, only present if this device is a
1572                 PCI bridge, contains:
1573      - "bus": bus number (json-int)
1574      - "secondary": secondary bus number (json-int)
1575      - "subordinate": subordinate bus number (json-int)
1576      - "io_range": I/O memory range information, a json-object with the
1577                    following members:
1578                  - "base": base address, in bytes (json-int)
1579                  - "limit": limit address, in bytes (json-int)
1580      - "memory_range": memory range information, a json-object with the
1581                        following members:
1582                  - "base": base address, in bytes (json-int)
1583                  - "limit": limit address, in bytes (json-int)
1584      - "prefetchable_range": Prefetchable memory range information, a
1585                              json-object with the following members:
1586                  - "base": base address, in bytes (json-int)
1587                  - "limit": limit address, in bytes (json-int)
1588      - "devices": a json-array of PCI devices if there's any attached, each
1589                   each element is represented by a json-object, which contains
1590                   the same members of the 'PCI device json-object' described
1591                   above (optional)
1592 - "regions": a json-array of json-objects, each json-object represents a
1593              memory region of this device
1594
1595 The memory range json-object contains the following:
1596
1597 - "base": base memory address (json-int)
1598 - "limit": limit value (json-int)
1599
1600 The region json-object can be an I/O region or a memory region, an I/O region
1601 json-object contains the following:
1602
1603 - "type": "io" (json-string, fixed)
1604 - "bar": BAR number (json-int)
1605 - "address": memory address (json-int)
1606 - "size": memory size (json-int)
1607
1608 A memory region json-object contains the following:
1609
1610 - "type": "memory" (json-string, fixed)
1611 - "bar": BAR number (json-int)
1612 - "address": memory address (json-int)
1613 - "size": memory size (json-int)
1614 - "mem_type_64": true or false (json-bool)
1615 - "prefetch": true or false (json-bool)
1616
1617 Example:
1618
1619 -> { "execute": "query-pci" }
1620 <- {
1621       "return":[
1622          {
1623             "bus":0,
1624             "devices":[
1625                {
1626                   "bus":0,
1627                   "qdev_id":"",
1628                   "slot":0,
1629                   "class_info":{
1630                      "class":1536,
1631                      "desc":"Host bridge"
1632                   },
1633                   "id":{
1634                      "device":32902,
1635                      "vendor":4663
1636                   },
1637                   "function":0,
1638                   "regions":[
1639    
1640                   ]
1641                },
1642                {
1643                   "bus":0,
1644                   "qdev_id":"",
1645                   "slot":1,
1646                   "class_info":{
1647                      "class":1537,
1648                      "desc":"ISA bridge"
1649                   },
1650                   "id":{
1651                      "device":32902,
1652                      "vendor":28672
1653                   },
1654                   "function":0,
1655                   "regions":[
1656    
1657                   ]
1658                },
1659                {
1660                   "bus":0,
1661                   "qdev_id":"",
1662                   "slot":1,
1663                   "class_info":{
1664                      "class":257,
1665                      "desc":"IDE controller"
1666                   },
1667                   "id":{
1668                      "device":32902,
1669                      "vendor":28688
1670                   },
1671                   "function":1,
1672                   "regions":[
1673                      {
1674                         "bar":4,
1675                         "size":16,
1676                         "address":49152,
1677                         "type":"io"
1678                      }
1679                   ]
1680                },
1681                {
1682                   "bus":0,
1683                   "qdev_id":"",
1684                   "slot":2,
1685                   "class_info":{
1686                      "class":768,
1687                      "desc":"VGA controller"
1688                   },
1689                   "id":{
1690                      "device":4115,
1691                      "vendor":184
1692                   },
1693                   "function":0,
1694                   "regions":[
1695                      {
1696                         "prefetch":true,
1697                         "mem_type_64":false,
1698                         "bar":0,
1699                         "size":33554432,
1700                         "address":4026531840,
1701                         "type":"memory"
1702                      },
1703                      {
1704                         "prefetch":false,
1705                         "mem_type_64":false,
1706                         "bar":1,
1707                         "size":4096,
1708                         "address":4060086272,
1709                         "type":"memory"
1710                      },
1711                      {
1712                         "prefetch":false,
1713                         "mem_type_64":false,
1714                         "bar":6,
1715                         "size":65536,
1716                         "address":-1,
1717                         "type":"memory"
1718                      }
1719                   ]
1720                },
1721                {
1722                   "bus":0,
1723                   "qdev_id":"",
1724                   "irq":11,
1725                   "slot":4,
1726                   "class_info":{
1727                      "class":1280,
1728                      "desc":"RAM controller"
1729                   },
1730                   "id":{
1731                      "device":6900,
1732                      "vendor":4098
1733                   },
1734                   "function":0,
1735                   "regions":[
1736                      {
1737                         "bar":0,
1738                         "size":32,
1739                         "address":49280,
1740                         "type":"io"
1741                      }
1742                   ]
1743                }
1744             ]
1745          }
1746       ]
1747    }
1748
1749 Note: This example has been shortened as the real response is too long.
1750
1751 EQMP
1752
1753     {
1754         .name       = "query-pci",
1755         .args_type  = "",
1756         .mhandler.cmd_new = qmp_marshal_input_query_pci,
1757     },
1758
1759 SQMP
1760 query-kvm
1761 ---------
1762
1763 Show KVM information.
1764
1765 Return a json-object with the following information:
1766
1767 - "enabled": true if KVM support is enabled, false otherwise (json-bool)
1768 - "present": true if QEMU has KVM support, false otherwise (json-bool)
1769
1770 Example:
1771
1772 -> { "execute": "query-kvm" }
1773 <- { "return": { "enabled": true, "present": true } }
1774
1775 EQMP
1776
1777     {
1778         .name       = "query-kvm",
1779         .args_type  = "",
1780         .mhandler.cmd_new = qmp_marshal_input_query_kvm,
1781     },
1782
1783 SQMP
1784 query-status
1785 ------------
1786
1787 Return a json-object with the following information:
1788
1789 - "running": true if the VM is running, or false if it is paused (json-bool)
1790 - "singlestep": true if the VM is in single step mode,
1791                 false otherwise (json-bool)
1792 - "status": one of the following values (json-string)
1793     "debug" - QEMU is running on a debugger
1794     "inmigrate" - guest is paused waiting for an incoming migration
1795     "internal-error" - An internal error that prevents further guest
1796     execution has occurred
1797     "io-error" - the last IOP has failed and the device is configured
1798     to pause on I/O errors
1799     "paused" - guest has been paused via the 'stop' command
1800     "postmigrate" - guest is paused following a successful 'migrate'
1801     "prelaunch" - QEMU was started with -S and guest has not started
1802     "finish-migrate" - guest is paused to finish the migration process
1803     "restore-vm" - guest is paused to restore VM state
1804     "running" - guest is actively running
1805     "save-vm" - guest is paused to save the VM state
1806     "shutdown" - guest is shut down (and -no-shutdown is in use)
1807     "watchdog" - the watchdog action is configured to pause and
1808      has been triggered
1809
1810 Example:
1811
1812 -> { "execute": "query-status" }
1813 <- { "return": { "running": true, "singlestep": false, "status": "running" } }
1814
1815 EQMP
1816     
1817     {
1818         .name       = "query-status",
1819         .args_type  = "",
1820         .mhandler.cmd_new = qmp_marshal_input_query_status,
1821     },
1822
1823 SQMP
1824 query-mice
1825 ----------
1826
1827 Show VM mice information.
1828
1829 Each mouse is represented by a json-object, the returned value is a json-array
1830 of all mice.
1831
1832 The mouse json-object contains the following:
1833
1834 - "name": mouse's name (json-string)
1835 - "index": mouse's index (json-int)
1836 - "current": true if this mouse is receiving events, false otherwise (json-bool)
1837 - "absolute": true if the mouse generates absolute input events (json-bool)
1838
1839 Example:
1840
1841 -> { "execute": "query-mice" }
1842 <- {
1843       "return":[
1844          {
1845             "name":"QEMU Microsoft Mouse",
1846             "index":0,
1847             "current":false,
1848             "absolute":false
1849          },
1850          {
1851             "name":"QEMU PS/2 Mouse",
1852             "index":1,
1853             "current":true,
1854             "absolute":true
1855          }
1856       ]
1857    }
1858
1859 EQMP
1860
1861     {
1862         .name       = "query-mice",
1863         .args_type  = "",
1864         .mhandler.cmd_new = qmp_marshal_input_query_mice,
1865     },
1866
1867 SQMP
1868 query-vnc
1869 ---------
1870
1871 Show VNC server information.
1872
1873 Return a json-object with server information. Connected clients are returned
1874 as a json-array of json-objects.
1875
1876 The main json-object contains the following:
1877
1878 - "enabled": true or false (json-bool)
1879 - "host": server's IP address (json-string)
1880 - "family": address family (json-string)
1881          - Possible values: "ipv4", "ipv6", "unix", "unknown"
1882 - "service": server's port number (json-string)
1883 - "auth": authentication method (json-string)
1884          - Possible values: "invalid", "none", "ra2", "ra2ne", "sasl", "tight",
1885                             "tls", "ultra", "unknown", "vencrypt", "vencrypt",
1886                             "vencrypt+plain", "vencrypt+tls+none",
1887                             "vencrypt+tls+plain", "vencrypt+tls+sasl",
1888                             "vencrypt+tls+vnc", "vencrypt+x509+none",
1889                             "vencrypt+x509+plain", "vencrypt+x509+sasl",
1890                             "vencrypt+x509+vnc", "vnc"
1891 - "clients": a json-array of all connected clients
1892
1893 Clients are described by a json-object, each one contain the following:
1894
1895 - "host": client's IP address (json-string)
1896 - "family": address family (json-string)
1897          - Possible values: "ipv4", "ipv6", "unix", "unknown"
1898 - "service": client's port number (json-string)
1899 - "x509_dname": TLS dname (json-string, optional)
1900 - "sasl_username": SASL username (json-string, optional)
1901
1902 Example:
1903
1904 -> { "execute": "query-vnc" }
1905 <- {
1906       "return":{
1907          "enabled":true,
1908          "host":"0.0.0.0",
1909          "service":"50402",
1910          "auth":"vnc",
1911          "family":"ipv4",
1912          "clients":[
1913             {
1914                "host":"127.0.0.1",
1915                "service":"50401",
1916                "family":"ipv4"
1917             }
1918          ]
1919       }
1920    }
1921
1922 EQMP
1923
1924     {
1925         .name       = "query-vnc",
1926         .args_type  = "",
1927         .mhandler.cmd_new = qmp_marshal_input_query_vnc,
1928     },
1929
1930 SQMP
1931 query-spice
1932 -----------
1933
1934 Show SPICE server information.
1935
1936 Return a json-object with server information. Connected clients are returned
1937 as a json-array of json-objects.
1938
1939 The main json-object contains the following:
1940
1941 - "enabled": true or false (json-bool)
1942 - "host": server's IP address (json-string)
1943 - "port": server's port number (json-int, optional)
1944 - "tls-port": server's port number (json-int, optional)
1945 - "auth": authentication method (json-string)
1946          - Possible values: "none", "spice"
1947 - "channels": a json-array of all active channels clients
1948
1949 Channels are described by a json-object, each one contain the following:
1950
1951 - "host": client's IP address (json-string)
1952 - "family": address family (json-string)
1953          - Possible values: "ipv4", "ipv6", "unix", "unknown"
1954 - "port": client's port number (json-string)
1955 - "connection-id": spice connection id.  All channels with the same id
1956                    belong to the same spice session (json-int)
1957 - "channel-type": channel type.  "1" is the main control channel, filter for
1958                   this one if you want track spice sessions only (json-int)
1959 - "channel-id": channel id.  Usually "0", might be different needed when
1960                 multiple channels of the same type exist, such as multiple
1961                 display channels in a multihead setup (json-int)
1962 - "tls": whevener the channel is encrypted (json-bool)
1963
1964 Example:
1965
1966 -> { "execute": "query-spice" }
1967 <- {
1968       "return": {
1969          "enabled": true,
1970          "auth": "spice",
1971          "port": 5920,
1972          "tls-port": 5921,
1973          "host": "0.0.0.0",
1974          "channels": [
1975             {
1976                "port": "54924",
1977                "family": "ipv4",
1978                "channel-type": 1,
1979                "connection-id": 1804289383,
1980                "host": "127.0.0.1",
1981                "channel-id": 0,
1982                "tls": true
1983             },
1984             {
1985                "port": "36710",
1986                "family": "ipv4",
1987                "channel-type": 4,
1988                "connection-id": 1804289383,
1989                "host": "127.0.0.1",
1990                "channel-id": 0,
1991                "tls": false
1992             },
1993             [ ... more channels follow ... ]
1994          ]
1995       }
1996    }
1997
1998 EQMP
1999
2000 #if defined(CONFIG_SPICE)
2001     {
2002         .name       = "query-spice",
2003         .args_type  = "",
2004         .mhandler.cmd_new = qmp_marshal_input_query_spice,
2005     },
2006 #endif
2007
2008 SQMP
2009 query-name
2010 ----------
2011
2012 Show VM name.
2013
2014 Return a json-object with the following information:
2015
2016 - "name": VM's name (json-string, optional)
2017
2018 Example:
2019
2020 -> { "execute": "query-name" }
2021 <- { "return": { "name": "qemu-name" } }
2022
2023 EQMP
2024
2025     {
2026         .name       = "query-name",
2027         .args_type  = "",
2028         .mhandler.cmd_new = qmp_marshal_input_query_name,
2029     },
2030
2031 SQMP
2032 query-uuid
2033 ----------
2034
2035 Show VM UUID.
2036
2037 Return a json-object with the following information:
2038
2039 - "UUID": Universally Unique Identifier (json-string)
2040
2041 Example:
2042
2043 -> { "execute": "query-uuid" }
2044 <- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } }
2045
2046 EQMP
2047
2048     {
2049         .name       = "query-uuid",
2050         .args_type  = "",
2051         .mhandler.cmd_new = qmp_marshal_input_query_uuid,
2052     },
2053
2054 SQMP
2055 query-migrate
2056 -------------
2057
2058 Migration status.
2059
2060 Return a json-object. If migration is active there will be another json-object
2061 with RAM migration status and if block migration is active another one with
2062 block migration status.
2063
2064 The main json-object contains the following:
2065
2066 - "status": migration status (json-string)
2067      - Possible values: "active", "completed", "failed", "cancelled"
2068 - "ram": only present if "status" is "active", it is a json-object with the
2069   following RAM information (in bytes):
2070          - "transferred": amount transferred (json-int)
2071          - "remaining": amount remaining (json-int)
2072          - "total": total (json-int)
2073 - "disk": only present if "status" is "active" and it is a block migration,
2074   it is a json-object with the following disk information (in bytes):
2075          - "transferred": amount transferred (json-int)
2076          - "remaining": amount remaining (json-int)
2077          - "total": total (json-int)
2078
2079 Examples:
2080
2081 1. Before the first migration
2082
2083 -> { "execute": "query-migrate" }
2084 <- { "return": {} }
2085
2086 2. Migration is done and has succeeded
2087
2088 -> { "execute": "query-migrate" }
2089 <- { "return": { "status": "completed" } }
2090
2091 3. Migration is done and has failed
2092
2093 -> { "execute": "query-migrate" }
2094 <- { "return": { "status": "failed" } }
2095
2096 4. Migration is being performed and is not a block migration:
2097
2098 -> { "execute": "query-migrate" }
2099 <- {
2100       "return":{
2101          "status":"active",
2102          "ram":{
2103             "transferred":123,
2104             "remaining":123,
2105             "total":246
2106          }
2107       }
2108    }
2109
2110 5. Migration is being performed and is a block migration:
2111
2112 -> { "execute": "query-migrate" }
2113 <- {
2114       "return":{
2115          "status":"active",
2116          "ram":{
2117             "total":1057024,
2118             "remaining":1053304,
2119             "transferred":3720
2120          },
2121          "disk":{
2122             "total":20971520,
2123             "remaining":20880384,
2124             "transferred":91136
2125          }
2126       }
2127    }
2128
2129 EQMP
2130
2131     {
2132         .name       = "query-migrate",
2133         .args_type  = "",
2134         .mhandler.cmd_new = qmp_marshal_input_query_migrate,
2135     },
2136
2137 SQMP
2138 query-balloon
2139 -------------
2140
2141 Show balloon information.
2142
2143 Make an asynchronous request for balloon info. When the request completes a
2144 json-object will be returned containing the following data:
2145
2146 - "actual": current balloon value in bytes (json-int)
2147 - "mem_swapped_in": Amount of memory swapped in bytes (json-int, optional)
2148 - "mem_swapped_out": Amount of memory swapped out in bytes (json-int, optional)
2149 - "major_page_faults": Number of major faults (json-int, optional)
2150 - "minor_page_faults": Number of minor faults (json-int, optional)
2151 - "free_mem": Total amount of free and unused memory in
2152               bytes (json-int, optional)
2153 - "total_mem": Total amount of available memory in bytes (json-int, optional)
2154
2155 Example:
2156
2157 -> { "execute": "query-balloon" }
2158 <- {
2159       "return":{
2160          "actual":1073741824,
2161          "mem_swapped_in":0,
2162          "mem_swapped_out":0,
2163          "major_page_faults":142,
2164          "minor_page_faults":239245,
2165          "free_mem":1014185984,
2166          "total_mem":1044668416
2167       }
2168    }
2169
2170 EQMP
2171
2172     {
2173         .name       = "query-balloon",
2174         .args_type  = "",
2175         .mhandler.cmd_new = qmp_marshal_input_query_balloon,
2176     },
2177
2178     {
2179         .name       = "query-block-jobs",
2180         .args_type  = "",
2181         .mhandler.cmd_new = qmp_marshal_input_query_block_jobs,
2182     },
2183
2184     {
2185         .name       = "qom-list",
2186         .args_type  = "path:s",
2187         .mhandler.cmd_new = qmp_marshal_input_qom_list,
2188     },
2189
2190     {
2191         .name       = "qom-set",
2192         .args_type  = "path:s,property:s,value:q",
2193         .mhandler.cmd_new = qmp_qom_set,
2194     },
2195
2196     {
2197         .name       = "qom-get",
2198         .args_type  = "path:s,property:s",
2199         .mhandler.cmd_new = qmp_qom_get,
2200     },
2201
2202     {
2203         .name       = "change-vnc-password",
2204         .args_type  = "password:s",
2205         .mhandler.cmd_new = qmp_marshal_input_change_vnc_password,
2206     },
2207     {
2208         .name       = "qom-list-types",
2209         .args_type  = "implements:s?,abstract:b?",
2210         .mhandler.cmd_new = qmp_marshal_input_qom_list_types,
2211     },