scsi: Drop useless null test in scsi_unit_attention()
[qemu/opensuse.git] / qmp-commands.hx
blob5c692d0cb531910ecacdd0d1041c847ae929d9c8
1 HXCOMM QMP dispatch table and documentation
2 HXCOMM Text between SQMP and EQMP is copied to the QMP documention file and
3 HXCOMM does not show up in the other formats.
5 SQMP
6 QMP Supported Commands
7 ----------------------
9 This document describes all commands currently supported by QMP.
11 Most of the time their usage is exactly the same as in the user Monitor, this
12 means that any other document which also describe commands (the manpage,
13 QEMU's manual, etc) can and should be consulted.
15 QMP has two types of commands: regular and query commands. Regular commands
16 usually change the Virtual Machine's state someway, while query commands just
17 return information. The sections below are divided accordingly.
19 It's important to observe that all communication examples are formatted in
20 a reader-friendly way, so that they're easier to understand. However, in real
21 protocol usage, they're emitted as a single line.
23 Also, the following notation is used to denote data flow:
25 -> data issued by the Client
26 <- Server data response
28 Please, refer to the QMP specification (QMP/qmp-spec.txt) for detailed
29 information on the Server command and response formats.
31 NOTE: This document is temporary and will be replaced soon.
33 1. Stability Considerations
34 ===========================
36 The current QMP command set (described in this file) may be useful for a
37 number of use cases, however it's limited and several commands have bad
38 defined semantics, specially with regard to command completion.
40 These problems are going to be solved incrementally in the next QEMU releases
41 and we're going to establish a deprecation policy for badly defined commands.
43 If you're planning to adopt QMP, please observe the following:
45 1. The deprecation policy will take 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
49 2. DO NOT rely on anything which is not explicit documented
51 3. Errors, in special, are not documented. Applications should NOT check
52 for specific errors classes or data (it's strongly recommended to only
53 check for the "error" key)
55 2. Regular Commands
56 ===================
58 Server's responses in the examples below are always a success response, please
59 refer to the QMP specification for more details on error responses.
61 EQMP
64 .name = "quit",
65 .args_type = "",
66 .mhandler.cmd_new = qmp_marshal_input_quit,
69 SQMP
70 quit
71 ----
73 Quit the emulator.
75 Arguments: None.
77 Example:
79 -> { "execute": "quit" }
80 <- { "return": {} }
82 EQMP
85 .name = "eject",
86 .args_type = "force:-f,device:B",
87 .mhandler.cmd_new = qmp_marshal_input_eject,
90 SQMP
91 eject
92 -----
94 Eject a removable medium.
96 Arguments:
98 - force: force ejection (json-bool, optional)
99 - device: device name (json-string)
101 Example:
103 -> { "execute": "eject", "arguments": { "device": "ide1-cd0" } }
104 <- { "return": {} }
106 Note: The "force" argument defaults to false.
108 EQMP
111 .name = "change",
112 .args_type = "device:B,target:F,arg:s?",
113 .mhandler.cmd_new = qmp_marshal_input_change,
116 SQMP
117 change
118 ------
120 Change a removable medium or VNC configuration.
122 Arguments:
124 - "device": device name (json-string)
125 - "target": filename or item (json-string)
126 - "arg": additional argument (json-string, optional)
128 Examples:
130 1. Change a removable medium
132 -> { "execute": "change",
133 "arguments": { "device": "ide1-cd0",
134 "target": "/srv/images/Fedora-12-x86_64-DVD.iso" } }
135 <- { "return": {} }
137 2. Change VNC password
139 -> { "execute": "change",
140 "arguments": { "device": "vnc", "target": "password",
141 "arg": "foobar1" } }
142 <- { "return": {} }
144 EQMP
147 .name = "screendump",
148 .args_type = "filename:F",
149 .mhandler.cmd_new = qmp_marshal_input_screendump,
152 SQMP
153 screendump
154 ----------
156 Save screen into PPM image.
158 Arguments:
160 - "filename": file path (json-string)
162 Example:
164 -> { "execute": "screendump", "arguments": { "filename": "/tmp/image" } }
165 <- { "return": {} }
167 EQMP
170 .name = "stop",
171 .args_type = "",
172 .mhandler.cmd_new = qmp_marshal_input_stop,
175 SQMP
176 stop
177 ----
179 Stop the emulator.
181 Arguments: None.
183 Example:
185 -> { "execute": "stop" }
186 <- { "return": {} }
188 EQMP
191 .name = "cont",
192 .args_type = "",
193 .mhandler.cmd_new = qmp_marshal_input_cont,
196 SQMP
197 cont
198 ----
200 Resume emulation.
202 Arguments: None.
204 Example:
206 -> { "execute": "cont" }
207 <- { "return": {} }
209 EQMP
212 .name = "system_wakeup",
213 .args_type = "",
214 .mhandler.cmd_new = qmp_marshal_input_system_wakeup,
217 SQMP
218 system_wakeup
219 -------------
221 Wakeup guest from suspend.
223 Arguments: None.
225 Example:
227 -> { "execute": "system_wakeup" }
228 <- { "return": {} }
230 EQMP
233 .name = "system_reset",
234 .args_type = "",
235 .mhandler.cmd_new = qmp_marshal_input_system_reset,
238 SQMP
239 system_reset
240 ------------
242 Reset the system.
244 Arguments: None.
246 Example:
248 -> { "execute": "system_reset" }
249 <- { "return": {} }
251 EQMP
254 .name = "system_powerdown",
255 .args_type = "",
256 .mhandler.cmd_new = qmp_marshal_input_system_powerdown,
259 SQMP
260 system_powerdown
261 ----------------
263 Send system power down event.
265 Arguments: None.
267 Example:
269 -> { "execute": "system_powerdown" }
270 <- { "return": {} }
272 EQMP
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,
283 SQMP
284 device_add
285 ----------
287 Add a device.
289 Arguments:
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
296 Example:
298 -> { "execute": "device_add", "arguments": { "driver": "e1000", "id": "net1" } }
299 <- { "return": {} }
301 Notes:
303 (1) For detailed information about this command, please refer to the
304 'docs/qdev-device-use.txt' file.
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
309 EQMP
312 .name = "device_del",
313 .args_type = "id:s",
314 .mhandler.cmd_new = qmp_marshal_input_device_del,
317 SQMP
318 device_del
319 ----------
321 Remove a device.
323 Arguments:
325 - "id": the device's ID (json-string)
327 Example:
329 -> { "execute": "device_del", "arguments": { "id": "net1" } }
330 <- { "return": {} }
332 EQMP
335 .name = "send-key",
336 .args_type = "keys:O,hold-time:i?",
337 .mhandler.cmd_new = qmp_marshal_input_send_key,
340 SQMP
341 send-key
342 ----------
344 Send keys to VM.
346 Arguments:
348 keys array:
349 - "key": key sequence (a json-array of key enum values)
351 - hold-time: time to delay key up events, milliseconds. Defaults to 100
352 (json-int, optional)
354 Example:
356 -> { "execute": "send-key",
357 "arguments": { 'keys': [ 'ctrl', 'alt', 'delete' ] } }
358 <- { "return": {} }
360 EQMP
363 .name = "cpu",
364 .args_type = "index:i",
365 .mhandler.cmd_new = qmp_marshal_input_cpu,
368 SQMP
372 Set the default CPU.
374 Arguments:
376 - "index": the CPU's index (json-int)
378 Example:
380 -> { "execute": "cpu", "arguments": { "index": 0 } }
381 <- { "return": {} }
383 Note: CPUs' indexes are obtained with the 'query-cpus' command.
385 EQMP
388 .name = "memsave",
389 .args_type = "val:l,size:i,filename:s,cpu:i?",
390 .mhandler.cmd_new = qmp_marshal_input_memsave,
393 SQMP
394 memsave
395 -------
397 Save to disk virtual memory dump starting at 'val' of size 'size'.
399 Arguments:
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)
406 Example:
408 -> { "execute": "memsave",
409 "arguments": { "val": 10,
410 "size": 100,
411 "filename": "/tmp/virtual-mem-dump" } }
412 <- { "return": {} }
414 EQMP
417 .name = "pmemsave",
418 .args_type = "val:l,size:i,filename:s",
419 .mhandler.cmd_new = qmp_marshal_input_pmemsave,
422 SQMP
423 pmemsave
424 --------
426 Save to disk physical memory dump starting at 'val' of size 'size'.
428 Arguments:
430 - "val": the starting address (json-int)
431 - "size": the memory size, in bytes (json-int)
432 - "filename": file path (json-string)
434 Example:
436 -> { "execute": "pmemsave",
437 "arguments": { "val": 10,
438 "size": 100,
439 "filename": "/tmp/physical-mem-dump" } }
440 <- { "return": {} }
442 EQMP
445 .name = "inject-nmi",
446 .args_type = "",
447 .mhandler.cmd_new = qmp_marshal_input_inject_nmi,
450 SQMP
451 inject-nmi
452 ----------
454 Inject an NMI on guest's CPUs.
456 Arguments: None.
458 Example:
460 -> { "execute": "inject-nmi" }
461 <- { "return": {} }
463 Note: inject-nmi fails when the guest doesn't support injecting.
464 Currently, only x86 guests do.
466 EQMP
469 .name = "xen-save-devices-state",
470 .args_type = "filename:F",
471 .mhandler.cmd_new = qmp_marshal_input_xen_save_devices_state,
474 SQMP
475 xen-save-devices-state
476 -------
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.
481 Arguments:
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.
487 Example:
489 -> { "execute": "xen-save-devices-state",
490 "arguments": { "filename": "/tmp/save" } }
491 <- { "return": {} }
493 EQMP
496 .name = "xen-set-global-dirty-log",
497 .args_type = "enable:b",
498 .mhandler.cmd_new = qmp_marshal_input_xen_set_global_dirty_log,
501 SQMP
502 xen-set-global-dirty-log
503 -------
505 Enable or disable the global dirty log mode.
507 Arguments:
509 - "enable": Enable it or disable it.
511 Example:
513 -> { "execute": "xen-set-global-dirty-log",
514 "arguments": { "enable": true } }
515 <- { "return": {} }
517 EQMP
520 .name = "migrate",
521 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
522 .mhandler.cmd_new = qmp_marshal_input_migrate,
525 SQMP
526 migrate
527 -------
529 Migrate to URI.
531 Arguments:
533 - "blk": block migration, full disk copy (json-bool, optional)
534 - "inc": incremental disk copy (json-bool, optional)
535 - "uri": Destination URI (json-string)
537 Example:
539 -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
540 <- { "return": {} }
542 Notes:
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
550 EQMP
553 .name = "migrate_cancel",
554 .args_type = "",
555 .mhandler.cmd_new = qmp_marshal_input_migrate_cancel,
558 SQMP
559 migrate_cancel
560 --------------
562 Cancel the current migration.
564 Arguments: None.
566 Example:
568 -> { "execute": "migrate_cancel" }
569 <- { "return": {} }
571 EQMP
573 .name = "migrate-set-cache-size",
574 .args_type = "value:o",
575 .mhandler.cmd_new = qmp_marshal_input_migrate_set_cache_size,
578 SQMP
579 migrate-set-cache-size
580 ---------------------
582 Set cache size to be used by XBZRLE migration, the cache size will be rounded
583 down to the nearest power of 2
585 Arguments:
587 - "value": cache size in bytes (json-int)
589 Example:
591 -> { "execute": "migrate-set-cache-size", "arguments": { "value": 536870912 } }
592 <- { "return": {} }
594 EQMP
596 .name = "query-migrate-cache-size",
597 .args_type = "",
598 .mhandler.cmd_new = qmp_marshal_input_query_migrate_cache_size,
601 SQMP
602 query-migrate-cache-size
603 ---------------------
605 Show cache size to be used by XBZRLE migration
607 returns a json-object with the following information:
608 - "size" : json-int
610 Example:
612 -> { "execute": "query-migrate-cache-size" }
613 <- { "return": 67108864 }
615 EQMP
618 .name = "migrate_set_speed",
619 .args_type = "value:o",
620 .mhandler.cmd_new = qmp_marshal_input_migrate_set_speed,
623 SQMP
624 migrate_set_speed
625 -----------------
627 Set maximum speed for migrations.
629 Arguments:
631 - "value": maximum speed, in bytes per second (json-int)
633 Example:
635 -> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } }
636 <- { "return": {} }
638 EQMP
641 .name = "migrate_set_downtime",
642 .args_type = "value:T",
643 .mhandler.cmd_new = qmp_marshal_input_migrate_set_downtime,
646 SQMP
647 migrate_set_downtime
648 --------------------
650 Set maximum tolerated downtime (in seconds) for migrations.
652 Arguments:
654 - "value": maximum downtime (json-number)
656 Example:
658 -> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } }
659 <- { "return": {} }
661 EQMP
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,
673 SQMP
674 client_migrate_info
675 ------------------
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.
681 Arguments:
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)
689 Example:
691 -> { "execute": "client_migrate_info",
692 "arguments": { "protocol": "spice",
693 "hostname": "virt42.lab.kraxel.org",
694 "port": 1234 } }
695 <- { "return": {} }
697 EQMP
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,
708 SQMP
709 dump
712 Dump guest memory to file. The file can be processed with crash or gdb.
714 Arguments:
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)
724 Example:
726 -> { "execute": "dump-guest-memory", "arguments": { "protocol": "fd:dump" } }
727 <- { "return": {} }
729 Notes:
731 (1) All boolean arguments default to false
733 EQMP
736 .name = "netdev_add",
737 .args_type = "netdev:O",
738 .mhandler.cmd_new = qmp_netdev_add,
741 SQMP
742 netdev_add
743 ----------
745 Add host network device.
747 Arguments:
749 - "type": the device type, "tap", "user", ... (json-string)
750 - "id": the device's ID, must be unique (json-string)
751 - device options
753 Example:
755 -> { "execute": "netdev_add", "arguments": { "type": "user", "id": "netdev1" } }
756 <- { "return": {} }
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
762 EQMP
765 .name = "netdev_del",
766 .args_type = "id:s",
767 .mhandler.cmd_new = qmp_marshal_input_netdev_del,
770 SQMP
771 netdev_del
772 ----------
774 Remove host network device.
776 Arguments:
778 - "id": the device's ID, must be unique (json-string)
780 Example:
782 -> { "execute": "netdev_del", "arguments": { "id": "netdev1" } }
783 <- { "return": {} }
786 EQMP
789 .name = "block_resize",
790 .args_type = "device:B,size:o",
791 .mhandler.cmd_new = qmp_marshal_input_block_resize,
794 SQMP
795 block_resize
796 ------------
798 Resize a block image while a guest is running.
800 Arguments:
802 - "device": the device's ID, must be unique (json-string)
803 - "size": new size
805 Example:
807 -> { "execute": "block_resize", "arguments": { "device": "scratch", "size": 1073741824 } }
808 <- { "return": {} }
810 EQMP
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,
819 .name = "block-commit",
820 .args_type = "device:B,base:s?,top:s,speed:o?",
821 .mhandler.cmd_new = qmp_marshal_input_block_commit,
825 .name = "block-job-set-speed",
826 .args_type = "device:B,speed:o",
827 .mhandler.cmd_new = qmp_marshal_input_block_job_set_speed,
831 .name = "block-job-cancel",
832 .args_type = "device:B,force:b?",
833 .mhandler.cmd_new = qmp_marshal_input_block_job_cancel,
836 .name = "block-job-pause",
837 .args_type = "device:B",
838 .mhandler.cmd_new = qmp_marshal_input_block_job_pause,
841 .name = "block-job-resume",
842 .args_type = "device:B",
843 .mhandler.cmd_new = qmp_marshal_input_block_job_resume,
846 .name = "block-job-complete",
847 .args_type = "device:B",
848 .mhandler.cmd_new = qmp_marshal_input_block_job_complete,
851 .name = "transaction",
852 .args_type = "actions:q",
853 .mhandler.cmd_new = qmp_marshal_input_transaction,
856 SQMP
857 transaction
858 -----------
860 Atomically operate on one or more block devices. The only supported
861 operation for now is snapshotting. If there is any failure performing
862 any of the operations, all snapshots for the group are abandoned, and
863 the original disks pre-snapshot attempt are used.
865 A list of dictionaries is accepted, that contains the actions to be performed.
866 For snapshots this is the device, the file to use for the new snapshot,
867 and the format. The default format, if not specified, is qcow2.
869 Each new snapshot defaults to being created by QEMU (wiping any
870 contents if the file already exists), but it is also possible to reuse
871 an externally-created file. In the latter case, you should ensure that
872 the new image file has the same contents as the current one; QEMU cannot
873 perform any meaningful check. Typically this is achieved by using the
874 current image file as the backing file for the new image.
876 Arguments:
878 actions array:
879 - "type": the operation to perform. The only supported
880 value is "blockdev-snapshot-sync". (json-string)
881 - "data": a dictionary. The contents depend on the value
882 of "type". When "type" is "blockdev-snapshot-sync":
883 - "device": device name to snapshot (json-string)
884 - "snapshot-file": name of new image file (json-string)
885 - "format": format of new image (json-string, optional)
886 - "mode": whether and how QEMU should create the snapshot file
887 (NewImageMode, optional, default "absolute-paths")
889 Example:
891 -> { "execute": "transaction",
892 "arguments": { "actions": [
893 { 'type': 'blockdev-snapshot-sync', 'data' : { "device": "ide-hd0",
894 "snapshot-file": "/some/place/my-image",
895 "format": "qcow2" } },
896 { 'type': 'blockdev-snapshot-sync', 'data' : { "device": "ide-hd1",
897 "snapshot-file": "/some/place/my-image2",
898 "mode": "existing",
899 "format": "qcow2" } } ] } }
900 <- { "return": {} }
902 EQMP
905 .name = "blockdev-snapshot-sync",
906 .args_type = "device:B,snapshot-file:s,format:s?,mode:s?",
907 .mhandler.cmd_new = qmp_marshal_input_blockdev_snapshot_sync,
910 SQMP
911 blockdev-snapshot-sync
912 ----------------------
914 Synchronous snapshot of a block device. snapshot-file specifies the
915 target of the new image. If the file exists, or if it is a device, the
916 snapshot will be created in the existing file/device. If does not
917 exist, a new file will be created. format specifies the format of the
918 snapshot image, default is qcow2.
920 Arguments:
922 - "device": device name to snapshot (json-string)
923 - "snapshot-file": name of new image file (json-string)
924 - "mode": whether and how QEMU should create the snapshot file
925 (NewImageMode, optional, default "absolute-paths")
926 - "format": format of new image (json-string, optional)
928 Example:
930 -> { "execute": "blockdev-snapshot-sync", "arguments": { "device": "ide-hd0",
931 "snapshot-file":
932 "/some/place/my-image",
933 "format": "qcow2" } }
934 <- { "return": {} }
936 EQMP
939 .name = "drive-mirror",
940 .args_type = "sync:s,device:B,target:s,speed:i?,mode:s?,format:s?,"
941 "on-source-error:s?,on-target-error:s?",
942 .mhandler.cmd_new = qmp_marshal_input_drive_mirror,
945 SQMP
946 drive-mirror
947 ------------
949 Start mirroring a block device's writes to a new destination. target
950 specifies the target of the new image. If the file exists, or if it is
951 a device, it will be used as the new destination for writes. If it does not
952 exist, a new file will be created. format specifies the format of the
953 mirror image, default is to probe if mode='existing', else the format
954 of the source.
956 Arguments:
958 - "device": device name to operate on (json-string)
959 - "target": name of new image file (json-string)
960 - "format": format of new image (json-string, optional)
961 - "mode": how an image file should be created into the target
962 file/device (NewImageMode, optional, default 'absolute-paths')
963 - "speed": maximum speed of the streaming job, in bytes per second
964 (json-int)
965 - "sync": what parts of the disk image should be copied to the destination;
966 possibilities include "full" for all the disk, "top" for only the sectors
967 allocated in the topmost image, or "none" to only replicate new I/O
968 (MirrorSyncMode).
969 - "on-source-error": the action to take on an error on the source
970 (BlockdevOnError, default 'report')
971 - "on-target-error": the action to take on an error on the target
972 (BlockdevOnError, default 'report')
976 Example:
978 -> { "execute": "drive-mirror", "arguments": { "device": "ide-hd0",
979 "target": "/some/place/my-image",
980 "sync": "full",
981 "format": "qcow2" } }
982 <- { "return": {} }
984 EQMP
987 .name = "balloon",
988 .args_type = "value:M",
989 .mhandler.cmd_new = qmp_marshal_input_balloon,
992 SQMP
993 balloon
994 -------
996 Request VM to change its memory allocation (in bytes).
998 Arguments:
1000 - "value": New memory allocation (json-int)
1002 Example:
1004 -> { "execute": "balloon", "arguments": { "value": 536870912 } }
1005 <- { "return": {} }
1007 EQMP
1010 .name = "set_link",
1011 .args_type = "name:s,up:b",
1012 .mhandler.cmd_new = qmp_marshal_input_set_link,
1015 SQMP
1016 set_link
1017 --------
1019 Change the link status of a network adapter.
1021 Arguments:
1023 - "name": network device name (json-string)
1024 - "up": status is up (json-bool)
1026 Example:
1028 -> { "execute": "set_link", "arguments": { "name": "e1000.0", "up": false } }
1029 <- { "return": {} }
1031 EQMP
1034 .name = "getfd",
1035 .args_type = "fdname:s",
1036 .params = "getfd name",
1037 .help = "receive a file descriptor via SCM rights and assign it a name",
1038 .mhandler.cmd_new = qmp_marshal_input_getfd,
1041 SQMP
1042 getfd
1043 -----
1045 Receive a file descriptor via SCM rights and assign it a name.
1047 Arguments:
1049 - "fdname": file descriptor name (json-string)
1051 Example:
1053 -> { "execute": "getfd", "arguments": { "fdname": "fd1" } }
1054 <- { "return": {} }
1056 Notes:
1058 (1) If the name specified by the "fdname" argument already exists,
1059 the file descriptor assigned to it will be closed and replaced
1060 by the received file descriptor.
1061 (2) The 'closefd' command can be used to explicitly close the file
1062 descriptor when it is no longer needed.
1064 EQMP
1067 .name = "closefd",
1068 .args_type = "fdname:s",
1069 .params = "closefd name",
1070 .help = "close a file descriptor previously passed via SCM rights",
1071 .mhandler.cmd_new = qmp_marshal_input_closefd,
1074 SQMP
1075 closefd
1076 -------
1078 Close a file descriptor previously passed via SCM rights.
1080 Arguments:
1082 - "fdname": file descriptor name (json-string)
1084 Example:
1086 -> { "execute": "closefd", "arguments": { "fdname": "fd1" } }
1087 <- { "return": {} }
1089 EQMP
1092 .name = "add-fd",
1093 .args_type = "fdset-id:i?,opaque:s?",
1094 .params = "add-fd fdset-id opaque",
1095 .help = "Add a file descriptor, that was passed via SCM rights, to an fd set",
1096 .mhandler.cmd_new = qmp_marshal_input_add_fd,
1099 SQMP
1100 add-fd
1101 -------
1103 Add a file descriptor, that was passed via SCM rights, to an fd set.
1105 Arguments:
1107 - "fdset-id": The ID of the fd set to add the file descriptor to.
1108 (json-int, optional)
1109 - "opaque": A free-form string that can be used to describe the fd.
1110 (json-string, optional)
1112 Return a json-object with the following information:
1114 - "fdset-id": The ID of the fd set that the fd was added to. (json-int)
1115 - "fd": The file descriptor that was received via SCM rights and added to the
1116 fd set. (json-int)
1118 Example:
1120 -> { "execute": "add-fd", "arguments": { "fdset-id": 1 } }
1121 <- { "return": { "fdset-id": 1, "fd": 3 } }
1123 Notes:
1125 (1) The list of fd sets is shared by all monitor connections.
1126 (2) If "fdset-id" is not specified, a new fd set will be created.
1128 EQMP
1131 .name = "remove-fd",
1132 .args_type = "fdset-id:i,fd:i?",
1133 .params = "remove-fd fdset-id fd",
1134 .help = "Remove a file descriptor from an fd set",
1135 .mhandler.cmd_new = qmp_marshal_input_remove_fd,
1138 SQMP
1139 remove-fd
1140 ---------
1142 Remove a file descriptor from an fd set.
1144 Arguments:
1146 - "fdset-id": The ID of the fd set that the file descriptor belongs to.
1147 (json-int)
1148 - "fd": The file descriptor that is to be removed. (json-int, optional)
1150 Example:
1152 -> { "execute": "remove-fd", "arguments": { "fdset-id": 1, "fd": 3 } }
1153 <- { "return": {} }
1155 Notes:
1157 (1) The list of fd sets is shared by all monitor connections.
1158 (2) If "fd" is not specified, all file descriptors in "fdset-id" will be
1159 removed.
1161 EQMP
1164 .name = "query-fdsets",
1165 .args_type = "",
1166 .help = "Return information describing all fd sets",
1167 .mhandler.cmd_new = qmp_marshal_input_query_fdsets,
1170 SQMP
1171 query-fdsets
1172 -------------
1174 Return information describing all fd sets.
1176 Arguments: None
1178 Example:
1180 -> { "execute": "query-fdsets" }
1181 <- { "return": [
1183 "fds": [
1185 "fd": 30,
1186 "opaque": "rdonly:/path/to/file"
1189 "fd": 24,
1190 "opaque": "rdwr:/path/to/file"
1193 "fdset-id": 1
1196 "fds": [
1198 "fd": 28
1201 "fd": 29
1204 "fdset-id": 0
1209 Note: The list of fd sets is shared by all monitor connections.
1211 EQMP
1214 .name = "block_passwd",
1215 .args_type = "device:B,password:s",
1216 .mhandler.cmd_new = qmp_marshal_input_block_passwd,
1219 SQMP
1220 block_passwd
1221 ------------
1223 Set the password of encrypted block devices.
1225 Arguments:
1227 - "device": device name (json-string)
1228 - "password": password (json-string)
1230 Example:
1232 -> { "execute": "block_passwd", "arguments": { "device": "ide0-hd0",
1233 "password": "12345" } }
1234 <- { "return": {} }
1236 EQMP
1239 .name = "block_set_io_throttle",
1240 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1241 .mhandler.cmd_new = qmp_marshal_input_block_set_io_throttle,
1244 SQMP
1245 block_set_io_throttle
1246 ------------
1248 Change I/O throttle limits for a block drive.
1250 Arguments:
1252 - "device": device name (json-string)
1253 - "bps": total throughput limit in bytes per second(json-int)
1254 - "bps_rd": read throughput limit in bytes per second(json-int)
1255 - "bps_wr": read throughput limit in bytes per second(json-int)
1256 - "iops": total I/O operations per second(json-int)
1257 - "iops_rd": read I/O operations per second(json-int)
1258 - "iops_wr": write I/O operations per second(json-int)
1260 Example:
1262 -> { "execute": "block_set_io_throttle", "arguments": { "device": "virtio0",
1263 "bps": "1000000",
1264 "bps_rd": "0",
1265 "bps_wr": "0",
1266 "iops": "0",
1267 "iops_rd": "0",
1268 "iops_wr": "0" } }
1269 <- { "return": {} }
1271 EQMP
1274 .name = "set_password",
1275 .args_type = "protocol:s,password:s,connected:s?",
1276 .mhandler.cmd_new = qmp_marshal_input_set_password,
1279 SQMP
1280 set_password
1281 ------------
1283 Set the password for vnc/spice protocols.
1285 Arguments:
1287 - "protocol": protocol name (json-string)
1288 - "password": password (json-string)
1289 - "connected": [ keep | disconnect | fail ] (josn-string, optional)
1291 Example:
1293 -> { "execute": "set_password", "arguments": { "protocol": "vnc",
1294 "password": "secret" } }
1295 <- { "return": {} }
1297 EQMP
1300 .name = "expire_password",
1301 .args_type = "protocol:s,time:s",
1302 .mhandler.cmd_new = qmp_marshal_input_expire_password,
1305 SQMP
1306 expire_password
1307 ---------------
1309 Set the password expire time for vnc/spice protocols.
1311 Arguments:
1313 - "protocol": protocol name (json-string)
1314 - "time": [ now | never | +secs | secs ] (json-string)
1316 Example:
1318 -> { "execute": "expire_password", "arguments": { "protocol": "vnc",
1319 "time": "+60" } }
1320 <- { "return": {} }
1322 EQMP
1325 .name = "add_client",
1326 .args_type = "protocol:s,fdname:s,skipauth:b?,tls:b?",
1327 .mhandler.cmd_new = qmp_marshal_input_add_client,
1330 SQMP
1331 add_client
1332 ----------
1334 Add a graphics client
1336 Arguments:
1338 - "protocol": protocol name (json-string)
1339 - "fdname": file descriptor name (json-string)
1340 - "skipauth": whether to skip authentication (json-bool, optional)
1341 - "tls": whether to perform TLS (json-bool, optional)
1343 Example:
1345 -> { "execute": "add_client", "arguments": { "protocol": "vnc",
1346 "fdname": "myclient" } }
1347 <- { "return": {} }
1349 EQMP
1351 .name = "qmp_capabilities",
1352 .args_type = "",
1353 .params = "",
1354 .help = "enable QMP capabilities",
1355 .user_print = monitor_user_noop,
1356 .mhandler.cmd_new = do_qmp_capabilities,
1359 SQMP
1360 qmp_capabilities
1361 ----------------
1363 Enable QMP capabilities.
1365 Arguments: None.
1367 Example:
1369 -> { "execute": "qmp_capabilities" }
1370 <- { "return": {} }
1372 Note: This command must be issued before issuing any other command.
1374 EQMP
1377 .name = "human-monitor-command",
1378 .args_type = "command-line:s,cpu-index:i?",
1379 .mhandler.cmd_new = qmp_marshal_input_human_monitor_command,
1382 SQMP
1383 human-monitor-command
1384 ---------------------
1386 Execute a Human Monitor command.
1388 Arguments:
1390 - command-line: the command name and its arguments, just like the
1391 Human Monitor's shell (json-string)
1392 - cpu-index: select the CPU number to be used by commands which access CPU
1393 data, like 'info registers'. The Monitor selects CPU 0 if this
1394 argument is not provided (json-int, optional)
1396 Example:
1398 -> { "execute": "human-monitor-command", "arguments": { "command-line": "info kvm" } }
1399 <- { "return": "kvm support: enabled\r\n" }
1401 Notes:
1403 (1) The Human Monitor is NOT an stable interface, this means that command
1404 names, arguments and responses can change or be removed at ANY time.
1405 Applications that rely on long term stability guarantees should NOT
1406 use this command
1408 (2) Limitations:
1410 o This command is stateless, this means that commands that depend
1411 on state information (such as getfd) might not work
1413 o Commands that prompt the user for data (eg. 'cont' when the block
1414 device is encrypted) don't currently work
1416 3. Query Commands
1417 =================
1419 HXCOMM Each query command below is inside a SQMP/EQMP section, do NOT change
1420 HXCOMM this! We will possibly move query commands definitions inside those
1421 HXCOMM sections, just like regular commands.
1423 EQMP
1425 SQMP
1426 query-version
1427 -------------
1429 Show QEMU version.
1431 Return a json-object with the following information:
1433 - "qemu": A json-object containing three integer values:
1434 - "major": QEMU's major version (json-int)
1435 - "minor": QEMU's minor version (json-int)
1436 - "micro": QEMU's micro version (json-int)
1437 - "package": package's version (json-string)
1439 Example:
1441 -> { "execute": "query-version" }
1442 <- {
1443 "return":{
1444 "qemu":{
1445 "major":0,
1446 "minor":11,
1447 "micro":5
1449 "package":""
1453 EQMP
1456 .name = "query-version",
1457 .args_type = "",
1458 .mhandler.cmd_new = qmp_marshal_input_query_version,
1461 SQMP
1462 query-commands
1463 --------------
1465 List QMP available commands.
1467 Each command is represented by a json-object, the returned value is a json-array
1468 of all commands.
1470 Each json-object contain:
1472 - "name": command's name (json-string)
1474 Example:
1476 -> { "execute": "query-commands" }
1477 <- {
1478 "return":[
1480 "name":"query-balloon"
1483 "name":"system_powerdown"
1488 Note: This example has been shortened as the real response is too long.
1490 EQMP
1493 .name = "query-commands",
1494 .args_type = "",
1495 .mhandler.cmd_new = qmp_marshal_input_query_commands,
1498 SQMP
1499 query-events
1500 --------------
1502 List QMP available events.
1504 Each event is represented by a json-object, the returned value is a json-array
1505 of all events.
1507 Each json-object contains:
1509 - "name": event's name (json-string)
1511 Example:
1513 -> { "execute": "query-events" }
1514 <- {
1515 "return":[
1517 "name":"SHUTDOWN"
1520 "name":"RESET"
1525 Note: This example has been shortened as the real response is too long.
1527 EQMP
1530 .name = "query-events",
1531 .args_type = "",
1532 .mhandler.cmd_new = qmp_marshal_input_query_events,
1535 SQMP
1536 query-chardev
1537 -------------
1539 Each device is represented by a json-object. The returned value is a json-array
1540 of all devices.
1542 Each json-object contain the following:
1544 - "label": device's label (json-string)
1545 - "filename": device's file (json-string)
1547 Example:
1549 -> { "execute": "query-chardev" }
1550 <- {
1551 "return":[
1553 "label":"monitor",
1554 "filename":"stdio"
1557 "label":"serial0",
1558 "filename":"vc"
1563 EQMP
1566 .name = "query-chardev",
1567 .args_type = "",
1568 .mhandler.cmd_new = qmp_marshal_input_query_chardev,
1571 SQMP
1572 query-block
1573 -----------
1575 Show the block devices.
1577 Each block device information is stored in a json-object and the returned value
1578 is a json-array of all devices.
1580 Each json-object contain the following:
1582 - "device": device name (json-string)
1583 - "type": device type (json-string)
1584 - deprecated, retained for backward compatibility
1585 - Possible values: "unknown"
1586 - "removable": true if the device is removable, false otherwise (json-bool)
1587 - "locked": true if the device is locked, false otherwise (json-bool)
1588 - "tray-open": only present if removable, true if the device has a tray,
1589 and it is open (json-bool)
1590 - "inserted": only present if the device is inserted, it is a json-object
1591 containing the following:
1592 - "file": device file name (json-string)
1593 - "ro": true if read-only, false otherwise (json-bool)
1594 - "drv": driver format name (json-string)
1595 - Possible values: "blkdebug", "bochs", "cloop", "cow", "dmg",
1596 "file", "file", "ftp", "ftps", "host_cdrom",
1597 "host_device", "host_floppy", "http", "https",
1598 "nbd", "parallels", "qcow", "qcow2", "raw",
1599 "tftp", "vdi", "vmdk", "vpc", "vvfat"
1600 - "backing_file": backing file name (json-string, optional)
1601 - "backing_file_depth": number of files in the backing file chain (json-int)
1602 - "encrypted": true if encrypted, false otherwise (json-bool)
1603 - "bps": limit total bytes per second (json-int)
1604 - "bps_rd": limit read bytes per second (json-int)
1605 - "bps_wr": limit write bytes per second (json-int)
1606 - "iops": limit total I/O operations per second (json-int)
1607 - "iops_rd": limit read operations per second (json-int)
1608 - "iops_wr": limit write operations per second (json-int)
1610 - "io-status": I/O operation status, only present if the device supports it
1611 and the VM is configured to stop on errors. It's always reset
1612 to "ok" when the "cont" command is issued (json_string, optional)
1613 - Possible values: "ok", "failed", "nospace"
1615 Example:
1617 -> { "execute": "query-block" }
1618 <- {
1619 "return":[
1621 "io-status": "ok",
1622 "device":"ide0-hd0",
1623 "locked":false,
1624 "removable":false,
1625 "inserted":{
1626 "ro":false,
1627 "drv":"qcow2",
1628 "encrypted":false,
1629 "file":"disks/test.img",
1630 "backing_file_depth":0,
1631 "bps":1000000,
1632 "bps_rd":0,
1633 "bps_wr":0,
1634 "iops":1000000,
1635 "iops_rd":0,
1636 "iops_wr":0,
1638 "type":"unknown"
1641 "io-status": "ok",
1642 "device":"ide1-cd0",
1643 "locked":false,
1644 "removable":true,
1645 "type":"unknown"
1648 "device":"floppy0",
1649 "locked":false,
1650 "removable":true,
1651 "type":"unknown"
1654 "device":"sd0",
1655 "locked":false,
1656 "removable":true,
1657 "type":"unknown"
1662 EQMP
1665 .name = "query-block",
1666 .args_type = "",
1667 .mhandler.cmd_new = qmp_marshal_input_query_block,
1670 SQMP
1671 query-blockstats
1672 ----------------
1674 Show block device statistics.
1676 Each device statistic information is stored in a json-object and the returned
1677 value is a json-array of all devices.
1679 Each json-object contain the following:
1681 - "device": device name (json-string)
1682 - "stats": A json-object with the statistics information, it contains:
1683 - "rd_bytes": bytes read (json-int)
1684 - "wr_bytes": bytes written (json-int)
1685 - "rd_operations": read operations (json-int)
1686 - "wr_operations": write operations (json-int)
1687 - "flush_operations": cache flush operations (json-int)
1688 - "wr_total_time_ns": total time spend on writes in nano-seconds (json-int)
1689 - "rd_total_time_ns": total time spend on reads in nano-seconds (json-int)
1690 - "flush_total_time_ns": total time spend on cache flushes in nano-seconds (json-int)
1691 - "wr_highest_offset": Highest offset of a sector written since the
1692 BlockDriverState has been opened (json-int)
1693 - "parent": Contains recursively the statistics of the underlying
1694 protocol (e.g. the host file for a qcow2 image). If there is
1695 no underlying protocol, this field is omitted
1696 (json-object, optional)
1698 Example:
1700 -> { "execute": "query-blockstats" }
1701 <- {
1702 "return":[
1704 "device":"ide0-hd0",
1705 "parent":{
1706 "stats":{
1707 "wr_highest_offset":3686448128,
1708 "wr_bytes":9786368,
1709 "wr_operations":751,
1710 "rd_bytes":122567168,
1711 "rd_operations":36772
1712 "wr_total_times_ns":313253456
1713 "rd_total_times_ns":3465673657
1714 "flush_total_times_ns":49653
1715 "flush_operations":61,
1718 "stats":{
1719 "wr_highest_offset":2821110784,
1720 "wr_bytes":9786368,
1721 "wr_operations":692,
1722 "rd_bytes":122739200,
1723 "rd_operations":36604
1724 "flush_operations":51,
1725 "wr_total_times_ns":313253456
1726 "rd_total_times_ns":3465673657
1727 "flush_total_times_ns":49653
1731 "device":"ide1-cd0",
1732 "stats":{
1733 "wr_highest_offset":0,
1734 "wr_bytes":0,
1735 "wr_operations":0,
1736 "rd_bytes":0,
1737 "rd_operations":0
1738 "flush_operations":0,
1739 "wr_total_times_ns":0
1740 "rd_total_times_ns":0
1741 "flush_total_times_ns":0
1745 "device":"floppy0",
1746 "stats":{
1747 "wr_highest_offset":0,
1748 "wr_bytes":0,
1749 "wr_operations":0,
1750 "rd_bytes":0,
1751 "rd_operations":0
1752 "flush_operations":0,
1753 "wr_total_times_ns":0
1754 "rd_total_times_ns":0
1755 "flush_total_times_ns":0
1759 "device":"sd0",
1760 "stats":{
1761 "wr_highest_offset":0,
1762 "wr_bytes":0,
1763 "wr_operations":0,
1764 "rd_bytes":0,
1765 "rd_operations":0
1766 "flush_operations":0,
1767 "wr_total_times_ns":0
1768 "rd_total_times_ns":0
1769 "flush_total_times_ns":0
1775 EQMP
1778 .name = "query-blockstats",
1779 .args_type = "",
1780 .mhandler.cmd_new = qmp_marshal_input_query_blockstats,
1783 SQMP
1784 query-cpus
1785 ----------
1787 Show CPU information.
1789 Return a json-array. Each CPU is represented by a json-object, which contains:
1791 - "CPU": CPU index (json-int)
1792 - "current": true if this is the current CPU, false otherwise (json-bool)
1793 - "halted": true if the cpu is halted, false otherwise (json-bool)
1794 - Current program counter. The key's name depends on the architecture:
1795 "pc": i386/x86_64 (json-int)
1796 "nip": PPC (json-int)
1797 "pc" and "npc": sparc (json-int)
1798 "PC": mips (json-int)
1799 - "thread_id": ID of the underlying host thread (json-int)
1801 Example:
1803 -> { "execute": "query-cpus" }
1804 <- {
1805 "return":[
1807 "CPU":0,
1808 "current":true,
1809 "halted":false,
1810 "pc":3227107138
1811 "thread_id":3134
1814 "CPU":1,
1815 "current":false,
1816 "halted":true,
1817 "pc":7108165
1818 "thread_id":3135
1823 EQMP
1826 .name = "query-cpus",
1827 .args_type = "",
1828 .mhandler.cmd_new = qmp_marshal_input_query_cpus,
1831 SQMP
1832 query-pci
1833 ---------
1835 PCI buses and devices information.
1837 The returned value is a json-array of all buses. Each bus is represented by
1838 a json-object, which has a key with a json-array of all PCI devices attached
1839 to it. Each device is represented by a json-object.
1841 The bus json-object contains the following:
1843 - "bus": bus number (json-int)
1844 - "devices": a json-array of json-objects, each json-object represents a
1845 PCI device
1847 The PCI device json-object contains the following:
1849 - "bus": identical to the parent's bus number (json-int)
1850 - "slot": slot number (json-int)
1851 - "function": function number (json-int)
1852 - "class_info": a json-object containing:
1853 - "desc": device class description (json-string, optional)
1854 - "class": device class number (json-int)
1855 - "id": a json-object containing:
1856 - "device": device ID (json-int)
1857 - "vendor": vendor ID (json-int)
1858 - "irq": device's IRQ if assigned (json-int, optional)
1859 - "qdev_id": qdev id string (json-string)
1860 - "pci_bridge": It's a json-object, only present if this device is a
1861 PCI bridge, contains:
1862 - "bus": bus number (json-int)
1863 - "secondary": secondary bus number (json-int)
1864 - "subordinate": subordinate bus number (json-int)
1865 - "io_range": I/O memory range information, a json-object with the
1866 following members:
1867 - "base": base address, in bytes (json-int)
1868 - "limit": limit address, in bytes (json-int)
1869 - "memory_range": memory range information, a json-object with the
1870 following members:
1871 - "base": base address, in bytes (json-int)
1872 - "limit": limit address, in bytes (json-int)
1873 - "prefetchable_range": Prefetchable memory range information, a
1874 json-object with the following members:
1875 - "base": base address, in bytes (json-int)
1876 - "limit": limit address, in bytes (json-int)
1877 - "devices": a json-array of PCI devices if there's any attached, each
1878 each element is represented by a json-object, which contains
1879 the same members of the 'PCI device json-object' described
1880 above (optional)
1881 - "regions": a json-array of json-objects, each json-object represents a
1882 memory region of this device
1884 The memory range json-object contains the following:
1886 - "base": base memory address (json-int)
1887 - "limit": limit value (json-int)
1889 The region json-object can be an I/O region or a memory region, an I/O region
1890 json-object contains the following:
1892 - "type": "io" (json-string, fixed)
1893 - "bar": BAR number (json-int)
1894 - "address": memory address (json-int)
1895 - "size": memory size (json-int)
1897 A memory region json-object contains the following:
1899 - "type": "memory" (json-string, fixed)
1900 - "bar": BAR number (json-int)
1901 - "address": memory address (json-int)
1902 - "size": memory size (json-int)
1903 - "mem_type_64": true or false (json-bool)
1904 - "prefetch": true or false (json-bool)
1906 Example:
1908 -> { "execute": "query-pci" }
1909 <- {
1910 "return":[
1912 "bus":0,
1913 "devices":[
1915 "bus":0,
1916 "qdev_id":"",
1917 "slot":0,
1918 "class_info":{
1919 "class":1536,
1920 "desc":"Host bridge"
1922 "id":{
1923 "device":32902,
1924 "vendor":4663
1926 "function":0,
1927 "regions":[
1932 "bus":0,
1933 "qdev_id":"",
1934 "slot":1,
1935 "class_info":{
1936 "class":1537,
1937 "desc":"ISA bridge"
1939 "id":{
1940 "device":32902,
1941 "vendor":28672
1943 "function":0,
1944 "regions":[
1949 "bus":0,
1950 "qdev_id":"",
1951 "slot":1,
1952 "class_info":{
1953 "class":257,
1954 "desc":"IDE controller"
1956 "id":{
1957 "device":32902,
1958 "vendor":28688
1960 "function":1,
1961 "regions":[
1963 "bar":4,
1964 "size":16,
1965 "address":49152,
1966 "type":"io"
1971 "bus":0,
1972 "qdev_id":"",
1973 "slot":2,
1974 "class_info":{
1975 "class":768,
1976 "desc":"VGA controller"
1978 "id":{
1979 "device":4115,
1980 "vendor":184
1982 "function":0,
1983 "regions":[
1985 "prefetch":true,
1986 "mem_type_64":false,
1987 "bar":0,
1988 "size":33554432,
1989 "address":4026531840,
1990 "type":"memory"
1993 "prefetch":false,
1994 "mem_type_64":false,
1995 "bar":1,
1996 "size":4096,
1997 "address":4060086272,
1998 "type":"memory"
2001 "prefetch":false,
2002 "mem_type_64":false,
2003 "bar":6,
2004 "size":65536,
2005 "address":-1,
2006 "type":"memory"
2011 "bus":0,
2012 "qdev_id":"",
2013 "irq":11,
2014 "slot":4,
2015 "class_info":{
2016 "class":1280,
2017 "desc":"RAM controller"
2019 "id":{
2020 "device":6900,
2021 "vendor":4098
2023 "function":0,
2024 "regions":[
2026 "bar":0,
2027 "size":32,
2028 "address":49280,
2029 "type":"io"
2038 Note: This example has been shortened as the real response is too long.
2040 EQMP
2043 .name = "query-pci",
2044 .args_type = "",
2045 .mhandler.cmd_new = qmp_marshal_input_query_pci,
2048 SQMP
2049 query-kvm
2050 ---------
2052 Show KVM information.
2054 Return a json-object with the following information:
2056 - "enabled": true if KVM support is enabled, false otherwise (json-bool)
2057 - "present": true if QEMU has KVM support, false otherwise (json-bool)
2059 Example:
2061 -> { "execute": "query-kvm" }
2062 <- { "return": { "enabled": true, "present": true } }
2064 EQMP
2067 .name = "query-kvm",
2068 .args_type = "",
2069 .mhandler.cmd_new = qmp_marshal_input_query_kvm,
2072 SQMP
2073 query-status
2074 ------------
2076 Return a json-object with the following information:
2078 - "running": true if the VM is running, or false if it is paused (json-bool)
2079 - "singlestep": true if the VM is in single step mode,
2080 false otherwise (json-bool)
2081 - "status": one of the following values (json-string)
2082 "debug" - QEMU is running on a debugger
2083 "inmigrate" - guest is paused waiting for an incoming migration
2084 "internal-error" - An internal error that prevents further guest
2085 execution has occurred
2086 "io-error" - the last IOP has failed and the device is configured
2087 to pause on I/O errors
2088 "paused" - guest has been paused via the 'stop' command
2089 "postmigrate" - guest is paused following a successful 'migrate'
2090 "prelaunch" - QEMU was started with -S and guest has not started
2091 "finish-migrate" - guest is paused to finish the migration process
2092 "restore-vm" - guest is paused to restore VM state
2093 "running" - guest is actively running
2094 "save-vm" - guest is paused to save the VM state
2095 "shutdown" - guest is shut down (and -no-shutdown is in use)
2096 "watchdog" - the watchdog action is configured to pause and
2097 has been triggered
2099 Example:
2101 -> { "execute": "query-status" }
2102 <- { "return": { "running": true, "singlestep": false, "status": "running" } }
2104 EQMP
2107 .name = "query-status",
2108 .args_type = "",
2109 .mhandler.cmd_new = qmp_marshal_input_query_status,
2112 SQMP
2113 query-mice
2114 ----------
2116 Show VM mice information.
2118 Each mouse is represented by a json-object, the returned value is a json-array
2119 of all mice.
2121 The mouse json-object contains the following:
2123 - "name": mouse's name (json-string)
2124 - "index": mouse's index (json-int)
2125 - "current": true if this mouse is receiving events, false otherwise (json-bool)
2126 - "absolute": true if the mouse generates absolute input events (json-bool)
2128 Example:
2130 -> { "execute": "query-mice" }
2131 <- {
2132 "return":[
2134 "name":"QEMU Microsoft Mouse",
2135 "index":0,
2136 "current":false,
2137 "absolute":false
2140 "name":"QEMU PS/2 Mouse",
2141 "index":1,
2142 "current":true,
2143 "absolute":true
2148 EQMP
2151 .name = "query-mice",
2152 .args_type = "",
2153 .mhandler.cmd_new = qmp_marshal_input_query_mice,
2156 SQMP
2157 query-vnc
2158 ---------
2160 Show VNC server information.
2162 Return a json-object with server information. Connected clients are returned
2163 as a json-array of json-objects.
2165 The main json-object contains the following:
2167 - "enabled": true or false (json-bool)
2168 - "host": server's IP address (json-string)
2169 - "family": address family (json-string)
2170 - Possible values: "ipv4", "ipv6", "unix", "unknown"
2171 - "service": server's port number (json-string)
2172 - "auth": authentication method (json-string)
2173 - Possible values: "invalid", "none", "ra2", "ra2ne", "sasl", "tight",
2174 "tls", "ultra", "unknown", "vencrypt", "vencrypt",
2175 "vencrypt+plain", "vencrypt+tls+none",
2176 "vencrypt+tls+plain", "vencrypt+tls+sasl",
2177 "vencrypt+tls+vnc", "vencrypt+x509+none",
2178 "vencrypt+x509+plain", "vencrypt+x509+sasl",
2179 "vencrypt+x509+vnc", "vnc"
2180 - "clients": a json-array of all connected clients
2182 Clients are described by a json-object, each one contain the following:
2184 - "host": client's IP address (json-string)
2185 - "family": address family (json-string)
2186 - Possible values: "ipv4", "ipv6", "unix", "unknown"
2187 - "service": client's port number (json-string)
2188 - "x509_dname": TLS dname (json-string, optional)
2189 - "sasl_username": SASL username (json-string, optional)
2191 Example:
2193 -> { "execute": "query-vnc" }
2194 <- {
2195 "return":{
2196 "enabled":true,
2197 "host":"0.0.0.0",
2198 "service":"50402",
2199 "auth":"vnc",
2200 "family":"ipv4",
2201 "clients":[
2203 "host":"127.0.0.1",
2204 "service":"50401",
2205 "family":"ipv4"
2211 EQMP
2214 .name = "query-vnc",
2215 .args_type = "",
2216 .mhandler.cmd_new = qmp_marshal_input_query_vnc,
2219 SQMP
2220 query-spice
2221 -----------
2223 Show SPICE server information.
2225 Return a json-object with server information. Connected clients are returned
2226 as a json-array of json-objects.
2228 The main json-object contains the following:
2230 - "enabled": true or false (json-bool)
2231 - "host": server's IP address (json-string)
2232 - "port": server's port number (json-int, optional)
2233 - "tls-port": server's port number (json-int, optional)
2234 - "auth": authentication method (json-string)
2235 - Possible values: "none", "spice"
2236 - "channels": a json-array of all active channels clients
2238 Channels are described by a json-object, each one contain the following:
2240 - "host": client's IP address (json-string)
2241 - "family": address family (json-string)
2242 - Possible values: "ipv4", "ipv6", "unix", "unknown"
2243 - "port": client's port number (json-string)
2244 - "connection-id": spice connection id. All channels with the same id
2245 belong to the same spice session (json-int)
2246 - "channel-type": channel type. "1" is the main control channel, filter for
2247 this one if you want track spice sessions only (json-int)
2248 - "channel-id": channel id. Usually "0", might be different needed when
2249 multiple channels of the same type exist, such as multiple
2250 display channels in a multihead setup (json-int)
2251 - "tls": whevener the channel is encrypted (json-bool)
2253 Example:
2255 -> { "execute": "query-spice" }
2256 <- {
2257 "return": {
2258 "enabled": true,
2259 "auth": "spice",
2260 "port": 5920,
2261 "tls-port": 5921,
2262 "host": "0.0.0.0",
2263 "channels": [
2265 "port": "54924",
2266 "family": "ipv4",
2267 "channel-type": 1,
2268 "connection-id": 1804289383,
2269 "host": "127.0.0.1",
2270 "channel-id": 0,
2271 "tls": true
2274 "port": "36710",
2275 "family": "ipv4",
2276 "channel-type": 4,
2277 "connection-id": 1804289383,
2278 "host": "127.0.0.1",
2279 "channel-id": 0,
2280 "tls": false
2282 [ ... more channels follow ... ]
2287 EQMP
2289 #if defined(CONFIG_SPICE)
2291 .name = "query-spice",
2292 .args_type = "",
2293 .mhandler.cmd_new = qmp_marshal_input_query_spice,
2295 #endif
2297 SQMP
2298 query-name
2299 ----------
2301 Show VM name.
2303 Return a json-object with the following information:
2305 - "name": VM's name (json-string, optional)
2307 Example:
2309 -> { "execute": "query-name" }
2310 <- { "return": { "name": "qemu-name" } }
2312 EQMP
2315 .name = "query-name",
2316 .args_type = "",
2317 .mhandler.cmd_new = qmp_marshal_input_query_name,
2320 SQMP
2321 query-uuid
2322 ----------
2324 Show VM UUID.
2326 Return a json-object with the following information:
2328 - "UUID": Universally Unique Identifier (json-string)
2330 Example:
2332 -> { "execute": "query-uuid" }
2333 <- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } }
2335 EQMP
2338 .name = "query-uuid",
2339 .args_type = "",
2340 .mhandler.cmd_new = qmp_marshal_input_query_uuid,
2343 SQMP
2344 query-migrate
2345 -------------
2347 Migration status.
2349 Return a json-object. If migration is active there will be another json-object
2350 with RAM migration status and if block migration is active another one with
2351 block migration status.
2353 The main json-object contains the following:
2355 - "status": migration status (json-string)
2356 - Possible values: "active", "completed", "failed", "cancelled"
2357 - "total-time": total amount of ms since migration started. If
2358 migration has ended, it returns the total migration
2359 time (json-int)
2360 - "downtime": only present when migration has finished correctly
2361 total amount in ms for downtime that happened (json-int)
2362 - "expected-downtime": only present while migration is active
2363 total amount in ms for downtime that was calculated on
2364 the last bitmap round (json-int)
2365 - "ram": only present if "status" is "active", it is a json-object with the
2366 following RAM information (in bytes):
2367 - "transferred": amount transferred (json-int)
2368 - "remaining": amount remaining (json-int)
2369 - "total": total (json-int)
2370 - "duplicate": number of duplicated pages (json-int)
2371 - "normal" : number of normal pages transferred (json-int)
2372 - "normal-bytes" : number of normal bytes transferred (json-int)
2373 - "disk": only present if "status" is "active" and it is a block migration,
2374 it is a json-object with the following disk information (in bytes):
2375 - "transferred": amount transferred (json-int)
2376 - "remaining": amount remaining (json-int)
2377 - "total": total (json-int)
2378 - "xbzrle-cache": only present if XBZRLE is active.
2379 It is a json-object with the following XBZRLE information:
2380 - "cache-size": XBZRLE cache size
2381 - "bytes": total XBZRLE bytes transferred
2382 - "pages": number of XBZRLE compressed pages
2383 - "cache-miss": number of cache misses
2384 - "overflow": number of XBZRLE overflows
2385 Examples:
2387 1. Before the first migration
2389 -> { "execute": "query-migrate" }
2390 <- { "return": {} }
2392 2. Migration is done and has succeeded
2394 -> { "execute": "query-migrate" }
2395 <- { "return": {
2396 "status": "completed",
2397 "ram":{
2398 "transferred":123,
2399 "remaining":123,
2400 "total":246,
2401 "total-time":12345,
2402 "downtime":12345,
2403 "duplicate":123,
2404 "normal":123,
2405 "normal-bytes":123456
2410 3. Migration is done and has failed
2412 -> { "execute": "query-migrate" }
2413 <- { "return": { "status": "failed" } }
2415 4. Migration is being performed and is not a block migration:
2417 -> { "execute": "query-migrate" }
2418 <- {
2419 "return":{
2420 "status":"active",
2421 "ram":{
2422 "transferred":123,
2423 "remaining":123,
2424 "total":246,
2425 "total-time":12345,
2426 "expected-downtime":12345,
2427 "duplicate":123,
2428 "normal":123,
2429 "normal-bytes":123456
2434 5. Migration is being performed and is a block migration:
2436 -> { "execute": "query-migrate" }
2437 <- {
2438 "return":{
2439 "status":"active",
2440 "ram":{
2441 "total":1057024,
2442 "remaining":1053304,
2443 "transferred":3720,
2444 "total-time":12345,
2445 "expected-downtime":12345,
2446 "duplicate":123,
2447 "normal":123,
2448 "normal-bytes":123456
2450 "disk":{
2451 "total":20971520,
2452 "remaining":20880384,
2453 "transferred":91136
2458 6. Migration is being performed and XBZRLE is active:
2460 -> { "execute": "query-migrate" }
2461 <- {
2462 "return":{
2463 "status":"active",
2464 "capabilities" : [ { "capability": "xbzrle", "state" : true } ],
2465 "ram":{
2466 "total":1057024,
2467 "remaining":1053304,
2468 "transferred":3720,
2469 "total-time":12345,
2470 "expected-downtime":12345,
2471 "duplicate":10,
2472 "normal":3333,
2473 "normal-bytes":3412992
2475 "xbzrle-cache":{
2476 "cache-size":67108864,
2477 "bytes":20971520,
2478 "pages":2444343,
2479 "cache-miss":2244,
2480 "overflow":34434
2485 EQMP
2488 .name = "query-migrate",
2489 .args_type = "",
2490 .mhandler.cmd_new = qmp_marshal_input_query_migrate,
2493 SQMP
2494 migrate-set-capabilities
2495 -------
2497 Enable/Disable migration capabilities
2499 - "xbzrle": xbzrle support
2501 Arguments:
2503 Example:
2505 -> { "execute": "migrate-set-capabilities" , "arguments":
2506 { "capabilities": [ { "capability": "xbzrle", "state": true } ] } }
2508 EQMP
2511 .name = "migrate-set-capabilities",
2512 .args_type = "capabilities:O",
2513 .params = "capability:s,state:b",
2514 .mhandler.cmd_new = qmp_marshal_input_migrate_set_capabilities,
2516 SQMP
2517 query-migrate-capabilities
2518 -------
2520 Query current migration capabilities
2522 - "capabilities": migration capabilities state
2523 - "xbzrle" : XBZRLE state (json-bool)
2525 Arguments:
2527 Example:
2529 -> { "execute": "query-migrate-capabilities" }
2530 <- { "return": {
2531 "capabilities" : [ { "capability" : "xbzrle", "state" : false } ]
2534 EQMP
2537 .name = "query-migrate-capabilities",
2538 .args_type = "",
2539 .mhandler.cmd_new = qmp_marshal_input_query_migrate_capabilities,
2542 SQMP
2543 query-balloon
2544 -------------
2546 Show balloon information.
2548 Make an asynchronous request for balloon info. When the request completes a
2549 json-object will be returned containing the following data:
2551 - "actual": current balloon value in bytes (json-int)
2552 - "mem_swapped_in": Amount of memory swapped in bytes (json-int, optional)
2553 - "mem_swapped_out": Amount of memory swapped out in bytes (json-int, optional)
2554 - "major_page_faults": Number of major faults (json-int, optional)
2555 - "minor_page_faults": Number of minor faults (json-int, optional)
2556 - "free_mem": Total amount of free and unused memory in
2557 bytes (json-int, optional)
2558 - "total_mem": Total amount of available memory in bytes (json-int, optional)
2560 Example:
2562 -> { "execute": "query-balloon" }
2563 <- {
2564 "return":{
2565 "actual":1073741824,
2566 "mem_swapped_in":0,
2567 "mem_swapped_out":0,
2568 "major_page_faults":142,
2569 "minor_page_faults":239245,
2570 "free_mem":1014185984,
2571 "total_mem":1044668416
2575 EQMP
2578 .name = "query-balloon",
2579 .args_type = "",
2580 .mhandler.cmd_new = qmp_marshal_input_query_balloon,
2584 .name = "query-block-jobs",
2585 .args_type = "",
2586 .mhandler.cmd_new = qmp_marshal_input_query_block_jobs,
2590 .name = "qom-list",
2591 .args_type = "path:s",
2592 .mhandler.cmd_new = qmp_marshal_input_qom_list,
2596 .name = "qom-set",
2597 .args_type = "path:s,property:s,value:q",
2598 .mhandler.cmd_new = qmp_qom_set,
2602 .name = "qom-get",
2603 .args_type = "path:s,property:s",
2604 .mhandler.cmd_new = qmp_qom_get,
2608 .name = "nbd-server-start",
2609 .args_type = "addr:q",
2610 .mhandler.cmd_new = qmp_marshal_input_nbd_server_start,
2613 .name = "nbd-server-add",
2614 .args_type = "device:B,writable:b?",
2615 .mhandler.cmd_new = qmp_marshal_input_nbd_server_add,
2618 .name = "nbd-server-stop",
2619 .args_type = "",
2620 .mhandler.cmd_new = qmp_marshal_input_nbd_server_stop,
2624 .name = "change-vnc-password",
2625 .args_type = "password:s",
2626 .mhandler.cmd_new = qmp_marshal_input_change_vnc_password,
2629 .name = "qom-list-types",
2630 .args_type = "implements:s?,abstract:b?",
2631 .mhandler.cmd_new = qmp_marshal_input_qom_list_types,
2635 .name = "device-list-properties",
2636 .args_type = "typename:s",
2637 .mhandler.cmd_new = qmp_marshal_input_device_list_properties,
2641 .name = "query-machines",
2642 .args_type = "",
2643 .mhandler.cmd_new = qmp_marshal_input_query_machines,
2647 .name = "query-cpu-definitions",
2648 .args_type = "",
2649 .mhandler.cmd_new = qmp_marshal_input_query_cpu_definitions,
2653 .name = "query-target",
2654 .args_type = "",
2655 .mhandler.cmd_new = qmp_marshal_input_query_target,