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