blob: f581813fde06af289a38af48626de59c5c780dc5 [file] [log] [blame]
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001HXCOMM QMP dispatch table and documentation
2HXCOMM Text between SQMP and EQMP is copied to the QMP documention file and
3HXCOMM does not show up in the other formats.
4
5SQMP
6 QMP Supported Commands
7 ----------------------
8
9This document describes all commands currently supported by QMP.
10
11Most of the time their usage is exactly the same as in the user Monitor, this
12means that any other document which also describe commands (the manpage,
13QEMU's manual, etc) can and should be consulted.
14
15QMP has two types of commands: regular and query commands. Regular commands
16usually change the Virtual Machine's state someway, while query commands just
17return information. The sections below are divided accordingly.
18
19It's important to observe that all communication examples are formatted in
20a reader-friendly way, so that they're easier to understand. However, in real
21protocol usage, they're emitted as a single line.
22
23Also, the following notation is used to denote data flow:
24
25-> data issued by the Client
26<- Server data response
27
28Please, refer to the QMP specification (QMP/qmp-spec.txt) for detailed
29information on the Server command and response formats.
30
31NOTE: This document is temporary and will be replaced soon.
32
331. Stability Considerations
34===========================
35
36The current QMP command set (described in this file) may be useful for a
37number of use cases, however it's limited and several commands have bad
38defined semantics, specially with regard to command completion.
39
40These problems are going to be solved incrementally in the next QEMU releases
41and we're going to establish a deprecation policy for badly defined commands.
42
43If you're planning to adopt QMP, please observe the following:
44
Zhi Yong Wuc20cdf82011-07-27 14:32:56 +080045 1. The deprecation policy will take effect and be documented soon, please
Luiz Capitulino82a56f02010-09-13 12:26:00 -030046 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
552. Regular Commands
56===================
57
58Server's responses in the examples below are always a success response, please
59refer to the QMP specification for more details on error responses.
60
61EQMP
62
63 {
64 .name = "quit",
65 .args_type = "",
Luiz Capitulino7a7f3252011-09-15 14:20:28 -030066 .mhandler.cmd_new = qmp_marshal_input_quit,
Luiz Capitulino82a56f02010-09-13 12:26:00 -030067 },
68
69SQMP
70quit
71----
72
73Quit the emulator.
74
75Arguments: None.
76
77Example:
78
79-> { "execute": "quit" }
80<- { "return": {} }
81
82EQMP
83
84 {
85 .name = "eject",
86 .args_type = "force:-f,device:B",
Luiz Capitulinoc245b6a2011-12-07 16:02:36 -020087 .mhandler.cmd_new = qmp_marshal_input_eject,
Luiz Capitulino82a56f02010-09-13 12:26:00 -030088 },
89
90SQMP
91eject
92-----
93
94Eject a removable medium.
95
96Arguments:
97
98- force: force ejection (json-bool, optional)
99- device: device name (json-string)
100
101Example:
102
103-> { "execute": "eject", "arguments": { "device": "ide1-cd0" } }
104<- { "return": {} }
105
106Note: The "force" argument defaults to false.
107
108EQMP
109
110 {
111 .name = "change",
112 .args_type = "device:B,target:F,arg:s?",
Luiz Capitulino333a96e2011-12-08 11:13:50 -0200113 .mhandler.cmd_new = qmp_marshal_input_change,
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300114 },
115
116SQMP
117change
118------
119
120Change a removable medium or VNC configuration.
121
122Arguments:
123
124- "device": device name (json-string)
125- "target": filename or item (json-string)
126- "arg": additional argument (json-string, optional)
127
128Examples:
129
1301. 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
1372. Change VNC password
138
139-> { "execute": "change",
140 "arguments": { "device": "vnc", "target": "password",
141 "arg": "foobar1" } }
142<- { "return": {} }
143
144EQMP
145
146 {
147 .name = "screendump",
148 .args_type = "filename:F",
Luiz Capitulinoad39cf62012-05-24 13:48:23 -0300149 .mhandler.cmd_new = qmp_marshal_input_screendump,
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300150 },
151
152SQMP
153screendump
154----------
155
156Save screen into PPM image.
157
158Arguments:
159
160- "filename": file path (json-string)
161
162Example:
163
164-> { "execute": "screendump", "arguments": { "filename": "/tmp/image" } }
165<- { "return": {} }
166
167EQMP
168
169 {
170 .name = "stop",
171 .args_type = "",
Luiz Capitulino5f158f22011-09-15 14:34:39 -0300172 .mhandler.cmd_new = qmp_marshal_input_stop,
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300173 },
174
175SQMP
176stop
177----
178
179Stop the emulator.
180
181Arguments: None.
182
183Example:
184
185-> { "execute": "stop" }
186<- { "return": {} }
187
188EQMP
189
190 {
191 .name = "cont",
192 .args_type = "",
Luiz Capitulinoe42e8182011-11-22 17:58:31 -0200193 .mhandler.cmd_new = qmp_marshal_input_cont,
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300194 },
195
196SQMP
197cont
198----
199
200Resume emulation.
201
202Arguments: None.
203
204Example:
205
206-> { "execute": "cont" }
207<- { "return": {} }
208
209EQMP
210
211 {
Gerd Hoffmann9b9df252012-02-23 13:45:21 +0100212 .name = "system_wakeup",
213 .args_type = "",
214 .mhandler.cmd_new = qmp_marshal_input_system_wakeup,
215 },
216
217SQMP
218system_wakeup
219-------------
220
221Wakeup guest from suspend.
222
223Arguments: None.
224
225Example:
226
227-> { "execute": "system_wakeup" }
228<- { "return": {} }
229
230EQMP
231
232 {
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300233 .name = "system_reset",
234 .args_type = "",
Luiz Capitulino38d22652011-09-15 14:41:46 -0300235 .mhandler.cmd_new = qmp_marshal_input_system_reset,
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300236 },
237
238SQMP
239system_reset
240------------
241
242Reset the system.
243
244Arguments: None.
245
246Example:
247
248-> { "execute": "system_reset" }
249<- { "return": {} }
250
251EQMP
252
253 {
254 .name = "system_powerdown",
255 .args_type = "",
Luiz Capitulino22e1bb92011-11-27 22:40:03 -0200256 .mhandler.cmd_new = qmp_marshal_input_system_powerdown,
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300257 },
258
259SQMP
260system_powerdown
261----------------
262
263Send system power down event.
264
265Arguments: None.
266
267Example:
268
269-> { "execute": "system_powerdown" }
270<- { "return": {} }
271
272EQMP
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
283SQMP
284device_add
285----------
286
287Add a device.
288
289Arguments:
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
296Example:
297
298-> { "execute": "device_add", "arguments": { "driver": "e1000", "id": "net1" } }
299<- { "return": {} }
300
301Notes:
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
309EQMP
310
311 {
312 .name = "device_del",
313 .args_type = "id:s",
Luiz Capitulinoa15fef22012-03-29 12:38:50 -0300314 .mhandler.cmd_new = qmp_marshal_input_device_del,
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300315 },
316
317SQMP
318device_del
319----------
320
321Remove a device.
322
323Arguments:
324
325- "id": the device's ID (json-string)
326
327Example:
328
329-> { "execute": "device_del", "arguments": { "id": "net1" } }
330<- { "return": {} }
331
332EQMP
333
334 {
Amos Konge4c8f002012-08-31 10:56:26 +0800335 .name = "send-key",
336 .args_type = "keys:O,hold-time:i?",
337 .mhandler.cmd_new = qmp_marshal_input_send_key,
338 },
339
340SQMP
341send-key
342----------
343
344Send keys to VM.
345
346Arguments:
347
348keys array:
Amos Kongf9b1d9b2013-07-16 19:52:14 +0800349 - "key": key sequence (a json-array of key union values,
350 union can be number or qcode enum)
Amos Konge4c8f002012-08-31 10:56:26 +0800351
352- hold-time: time to delay key up events, milliseconds. Defaults to 100
353 (json-int, optional)
354
355Example:
356
357-> { "execute": "send-key",
Amos Kongf9b1d9b2013-07-16 19:52:14 +0800358 "arguments": { "keys": [ { "type": "qcode", "data": "ctrl" },
359 { "type": "qcode", "data": "alt" },
360 { "type": "qcode", "data": "delete" } ] } }
Amos Konge4c8f002012-08-31 10:56:26 +0800361<- { "return": {} }
362
363EQMP
364
365 {
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300366 .name = "cpu",
367 .args_type = "index:i",
Luiz Capitulino755f1962011-10-06 14:31:39 -0300368 .mhandler.cmd_new = qmp_marshal_input_cpu,
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300369 },
370
371SQMP
372cpu
373---
374
375Set the default CPU.
376
377Arguments:
378
379- "index": the CPU's index (json-int)
380
381Example:
382
383-> { "execute": "cpu", "arguments": { "index": 0 } }
384<- { "return": {} }
385
386Note: CPUs' indexes are obtained with the 'query-cpus' command.
387
388EQMP
389
390 {
Igor Mammedov69ca3ea2013-04-30 15:41:25 +0200391 .name = "cpu-add",
392 .args_type = "id:i",
393 .mhandler.cmd_new = qmp_marshal_input_cpu_add,
394 },
395
396SQMP
397cpu-add
398-------
399
400Adds virtual cpu
401
402Arguments:
403
404- "id": cpu id (json-int)
405
406Example:
407
408-> { "execute": "cpu-add", "arguments": { "id": 2 } }
409<- { "return": {} }
410
411EQMP
412
413 {
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300414 .name = "memsave",
Luiz Capitulino0cfd6a92011-11-22 16:32:37 -0200415 .args_type = "val:l,size:i,filename:s,cpu:i?",
416 .mhandler.cmd_new = qmp_marshal_input_memsave,
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300417 },
418
419SQMP
420memsave
421-------
422
423Save to disk virtual memory dump starting at 'val' of size 'size'.
424
425Arguments:
426
427- "val": the starting address (json-int)
428- "size": the memory size, in bytes (json-int)
429- "filename": file path (json-string)
Luiz Capitulino0cfd6a92011-11-22 16:32:37 -0200430- "cpu": virtual CPU index (json-int, optional)
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300431
432Example:
433
434-> { "execute": "memsave",
435 "arguments": { "val": 10,
436 "size": 100,
437 "filename": "/tmp/virtual-mem-dump" } }
438<- { "return": {} }
439
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300440EQMP
441
442 {
443 .name = "pmemsave",
444 .args_type = "val:l,size:i,filename:s",
Luiz Capitulino6d3962b2011-11-22 17:26:46 -0200445 .mhandler.cmd_new = qmp_marshal_input_pmemsave,
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300446 },
447
448SQMP
449pmemsave
450--------
451
452Save to disk physical memory dump starting at 'val' of size 'size'.
453
454Arguments:
455
456- "val": the starting address (json-int)
457- "size": the memory size, in bytes (json-int)
458- "filename": file path (json-string)
459
460Example:
461
462-> { "execute": "pmemsave",
463 "arguments": { "val": 10,
464 "size": 100,
465 "filename": "/tmp/physical-mem-dump" } }
466<- { "return": {} }
467
468EQMP
469
470 {
Lai Jiangshana4046662011-03-07 17:05:15 +0800471 .name = "inject-nmi",
472 .args_type = "",
Luiz Capitulinoab49ab52011-11-23 12:55:53 -0200473 .mhandler.cmd_new = qmp_marshal_input_inject_nmi,
Lai Jiangshana4046662011-03-07 17:05:15 +0800474 },
475
476SQMP
477inject-nmi
478----------
479
Alexey Kardashevskiy9cb805f2014-08-20 22:16:33 +1000480Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
Lai Jiangshana4046662011-03-07 17:05:15 +0800481
482Arguments: None.
483
484Example:
485
486-> { "execute": "inject-nmi" }
487<- { "return": {} }
488
Luiz Capitulinode253f12012-07-27 16:18:16 -0300489Note: inject-nmi fails when the guest doesn't support injecting.
Lai Jiangshana4046662011-03-07 17:05:15 +0800490
491EQMP
492
493 {
Markus Armbruster3949e592013-02-06 21:27:24 +0100494 .name = "ringbuf-write",
Markus Armbruster82e59a62013-02-06 21:27:14 +0100495 .args_type = "device:s,data:s,format:s?",
Markus Armbruster3949e592013-02-06 21:27:24 +0100496 .mhandler.cmd_new = qmp_marshal_input_ringbuf_write,
Lei Li1f590cf2013-01-25 00:03:20 +0800497 },
498
499SQMP
Markus Armbruster3949e592013-02-06 21:27:24 +0100500ringbuf-write
Lei Li1f590cf2013-01-25 00:03:20 +0800501-------------
502
Markus Armbruster3949e592013-02-06 21:27:24 +0100503Write to a ring buffer character device.
Lei Li1f590cf2013-01-25 00:03:20 +0800504
505Arguments:
506
Markus Armbruster3949e592013-02-06 21:27:24 +0100507- "device": ring buffer character device name (json-string)
508- "data": data to write (json-string)
509- "format": data format (json-string, optional)
510 - Possible values: "utf8" (default), "base64"
511 Bug: invalid base64 is currently not rejected.
512 Whitespace *is* invalid.
Lei Li1f590cf2013-01-25 00:03:20 +0800513
514Example:
515
Markus Armbruster3949e592013-02-06 21:27:24 +0100516-> { "execute": "ringbuf-write",
517 "arguments": { "device": "foo",
Lei Li1f590cf2013-01-25 00:03:20 +0800518 "data": "abcdefgh",
519 "format": "utf8" } }
520<- { "return": {} }
521
522EQMP
523
524 {
Markus Armbruster3949e592013-02-06 21:27:24 +0100525 .name = "ringbuf-read",
Lei Li49b6d722013-01-25 00:03:21 +0800526 .args_type = "device:s,size:i,format:s?",
Markus Armbruster3949e592013-02-06 21:27:24 +0100527 .mhandler.cmd_new = qmp_marshal_input_ringbuf_read,
Lei Li49b6d722013-01-25 00:03:21 +0800528 },
529
530SQMP
Markus Armbruster3949e592013-02-06 21:27:24 +0100531ringbuf-read
Lei Li49b6d722013-01-25 00:03:21 +0800532-------------
533
Markus Armbruster3949e592013-02-06 21:27:24 +0100534Read from a ring buffer character device.
Lei Li49b6d722013-01-25 00:03:21 +0800535
536Arguments:
537
Markus Armbruster3949e592013-02-06 21:27:24 +0100538- "device": ring buffer character device name (json-string)
539- "size": how many bytes to read at most (json-int)
540 - Number of data bytes, not number of characters in encoded data
541- "format": data format (json-string, optional)
542 - Possible values: "utf8" (default), "base64"
543 - Naturally, format "utf8" works only when the ring buffer
544 contains valid UTF-8 text. Invalid UTF-8 sequences get
545 replaced. Bug: replacement doesn't work. Bug: can screw
546 up on encountering NUL characters, after the ring buffer
547 lost data, and when reading stops because the size limit
548 is reached.
Lei Li49b6d722013-01-25 00:03:21 +0800549
550Example:
551
Markus Armbruster3949e592013-02-06 21:27:24 +0100552-> { "execute": "ringbuf-read",
553 "arguments": { "device": "foo",
Lei Li49b6d722013-01-25 00:03:21 +0800554 "size": 1000,
555 "format": "utf8" } }
Markus Armbruster3ab651f2013-02-06 21:27:15 +0100556<- {"return": "abcdefgh"}
Lei Li49b6d722013-01-25 00:03:21 +0800557
558EQMP
559
560 {
Stefano Stabellinia7ae8352012-01-25 12:24:51 +0000561 .name = "xen-save-devices-state",
562 .args_type = "filename:F",
563 .mhandler.cmd_new = qmp_marshal_input_xen_save_devices_state,
564 },
565
566SQMP
567xen-save-devices-state
568-------
569
570Save the state of all devices to file. The RAM and the block devices
571of the VM are not saved by this command.
572
573Arguments:
574
575- "filename": the file to save the state of the devices to as binary
576data. See xen-save-devices-state.txt for a description of the binary
577format.
578
579Example:
580
581-> { "execute": "xen-save-devices-state",
582 "arguments": { "filename": "/tmp/save" } }
583<- { "return": {} }
584
585EQMP
586
587 {
Anthony PERARD39f42432012-10-03 13:48:19 +0000588 .name = "xen-set-global-dirty-log",
589 .args_type = "enable:b",
590 .mhandler.cmd_new = qmp_marshal_input_xen_set_global_dirty_log,
591 },
592
593SQMP
594xen-set-global-dirty-log
595-------
596
597Enable or disable the global dirty log mode.
598
599Arguments:
600
601- "enable": Enable it or disable it.
602
603Example:
604
605-> { "execute": "xen-set-global-dirty-log",
606 "arguments": { "enable": true } }
607<- { "return": {} }
608
609EQMP
610
611 {
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300612 .name = "migrate",
613 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
Luiz Capitulinoe1c37d02011-12-05 14:48:01 -0200614 .mhandler.cmd_new = qmp_marshal_input_migrate,
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300615 },
616
617SQMP
618migrate
619-------
620
621Migrate to URI.
622
623Arguments:
624
625- "blk": block migration, full disk copy (json-bool, optional)
626- "inc": incremental disk copy (json-bool, optional)
627- "uri": Destination URI (json-string)
628
629Example:
630
631-> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
632<- { "return": {} }
633
634Notes:
635
636(1) The 'query-migrate' command should be used to check migration's progress
637 and final result (this information is provided by the 'status' member)
638(2) All boolean arguments default to false
639(3) The user Monitor's "detach" argument is invalid in QMP and should not
640 be used
641
642EQMP
643
644 {
645 .name = "migrate_cancel",
646 .args_type = "",
Luiz Capitulino6cdedb02011-11-27 22:54:09 -0200647 .mhandler.cmd_new = qmp_marshal_input_migrate_cancel,
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300648 },
649
650SQMP
651migrate_cancel
652--------------
653
654Cancel the current migration.
655
656Arguments: None.
657
658Example:
659
660-> { "execute": "migrate_cancel" }
661<- { "return": {} }
662
663EQMP
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300664{
665 .name = "migrate-set-cache-size",
666 .args_type = "value:o",
667 .mhandler.cmd_new = qmp_marshal_input_migrate_set_cache_size,
668 },
669
670SQMP
671migrate-set-cache-size
Juan Quintela817c6042013-02-11 15:11:10 +0100672----------------------
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300673
674Set cache size to be used by XBZRLE migration, the cache size will be rounded
675down to the nearest power of 2
676
677Arguments:
678
679- "value": cache size in bytes (json-int)
680
681Example:
682
683-> { "execute": "migrate-set-cache-size", "arguments": { "value": 536870912 } }
684<- { "return": {} }
685
686EQMP
687 {
688 .name = "query-migrate-cache-size",
689 .args_type = "",
690 .mhandler.cmd_new = qmp_marshal_input_query_migrate_cache_size,
691 },
692
693SQMP
694query-migrate-cache-size
Juan Quintela817c6042013-02-11 15:11:10 +0100695------------------------
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300696
697Show cache size to be used by XBZRLE migration
698
699returns a json-object with the following information:
700- "size" : json-int
701
702Example:
703
704-> { "execute": "query-migrate-cache-size" }
705<- { "return": 67108864 }
706
707EQMP
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300708
709 {
710 .name = "migrate_set_speed",
Wen Congyang3a019b62010-11-25 09:06:05 +0800711 .args_type = "value:o",
Luiz Capitulino3dc85382011-11-28 11:59:37 -0200712 .mhandler.cmd_new = qmp_marshal_input_migrate_set_speed,
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300713 },
714
715SQMP
716migrate_set_speed
717-----------------
718
719Set maximum speed for migrations.
720
721Arguments:
722
Luiz Capitulino5569fd72010-12-15 17:56:18 -0200723- "value": maximum speed, in bytes per second (json-int)
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300724
725Example:
726
727-> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } }
728<- { "return": {} }
729
730EQMP
731
732 {
733 .name = "migrate_set_downtime",
734 .args_type = "value:T",
Luiz Capitulino4f0a9932011-11-27 23:18:01 -0200735 .mhandler.cmd_new = qmp_marshal_input_migrate_set_downtime,
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300736 },
737
738SQMP
739migrate_set_downtime
740--------------------
741
742Set maximum tolerated downtime (in seconds) for migrations.
743
744Arguments:
745
746- "value": maximum downtime (json-number)
747
748Example:
749
750-> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } }
751<- { "return": {} }
752
753EQMP
754
755 {
Jes Sorensenff73edf2011-03-09 14:31:06 +0100756 .name = "client_migrate_info",
757 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
758 .params = "protocol hostname port tls-port cert-subject",
759 .help = "send migration info to spice/vnc client",
760 .user_print = monitor_user_noop,
Yonit Halperinedc5cb12011-10-17 10:03:18 +0200761 .mhandler.cmd_async = client_migrate_info,
762 .flags = MONITOR_CMD_ASYNC,
Jes Sorensenff73edf2011-03-09 14:31:06 +0100763 },
764
765SQMP
766client_migrate_info
767------------------
768
769Set the spice/vnc connection info for the migration target. The spice/vnc
770server will ask the spice/vnc client to automatically reconnect using the
771new parameters (if specified) once the vm migration finished successfully.
772
773Arguments:
774
775- "protocol": protocol: "spice" or "vnc" (json-string)
776- "hostname": migration target hostname (json-string)
777- "port": spice/vnc tcp port for plaintext channels (json-int, optional)
778- "tls-port": spice tcp port for tls-secured channels (json-int, optional)
779- "cert-subject": server certificate subject (json-string, optional)
780
781Example:
782
783-> { "execute": "client_migrate_info",
784 "arguments": { "protocol": "spice",
785 "hostname": "virt42.lab.kraxel.org",
786 "port": 1234 } }
787<- { "return": {} }
788
789EQMP
790
791 {
Wen Congyang783e9b42012-05-07 12:10:47 +0800792 .name = "dump-guest-memory",
qiaonuohanb53ccc32014-02-18 14:11:36 +0800793 .args_type = "paging:b,protocol:s,begin:i?,end:i?,format:s?",
794 .params = "-p protocol [begin] [length] [format]",
Wen Congyang783e9b42012-05-07 12:10:47 +0800795 .help = "dump guest memory to file",
796 .user_print = monitor_user_noop,
797 .mhandler.cmd_new = qmp_marshal_input_dump_guest_memory,
798 },
799
800SQMP
801dump
802
803
804Dump guest memory to file. The file can be processed with crash or gdb.
805
806Arguments:
807
808- "paging": do paging to get guest's memory mapping (json-bool)
809- "protocol": destination file(started with "file:") or destination file
810 descriptor (started with "fd:") (json-string)
811- "begin": the starting physical address. It's optional, and should be specified
812 with length together (json-int)
813- "length": the memory size, in bytes. It's optional, and should be specified
814 with begin together (json-int)
qiaonuohanb53ccc32014-02-18 14:11:36 +0800815- "format": the format of guest memory dump. It's optional, and can be
816 elf|kdump-zlib|kdump-lzo|kdump-snappy, but non-elf formats will
817 conflict with paging and filter, ie. begin and length (json-string)
Wen Congyang783e9b42012-05-07 12:10:47 +0800818
819Example:
820
821-> { "execute": "dump-guest-memory", "arguments": { "protocol": "fd:dump" } }
822<- { "return": {} }
823
824Notes:
825
826(1) All boolean arguments default to false
827
828EQMP
829
830 {
qiaonuohan7d6dc7f2014-02-18 14:11:38 +0800831 .name = "query-dump-guest-memory-capability",
832 .args_type = "",
833 .mhandler.cmd_new = qmp_marshal_input_query_dump_guest_memory_capability,
834 },
835
836SQMP
837query-dump-guest-memory-capability
838----------
839
840Show available formats for 'dump-guest-memory'
841
842Example:
843
844-> { "execute": "query-dump-guest-memory-capability" }
845<- { "return": { "formats":
846 ["elf", "kdump-zlib", "kdump-lzo", "kdump-snappy"] }
847
848EQMP
849
850 {
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300851 .name = "netdev_add",
852 .args_type = "netdev:O",
Luiz Capitulino928059a2012-04-18 17:34:15 -0300853 .mhandler.cmd_new = qmp_netdev_add,
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300854 },
855
856SQMP
857netdev_add
858----------
859
860Add host network device.
861
862Arguments:
863
864- "type": the device type, "tap", "user", ... (json-string)
865- "id": the device's ID, must be unique (json-string)
866- device options
867
868Example:
869
870-> { "execute": "netdev_add", "arguments": { "type": "user", "id": "netdev1" } }
871<- { "return": {} }
872
Markus Armbrusteraf347aa2013-02-22 18:31:51 +0100873Note: The supported device options are the same ones supported by the '-netdev'
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300874 command-line argument, which are listed in the '-help' output or QEMU's
875 manual
876
877EQMP
878
879 {
880 .name = "netdev_del",
881 .args_type = "id:s",
Luiz Capitulino5f964152012-04-16 14:36:32 -0300882 .mhandler.cmd_new = qmp_marshal_input_netdev_del,
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300883 },
884
885SQMP
886netdev_del
887----------
888
889Remove host network device.
890
891Arguments:
892
893- "id": the device's ID, must be unique (json-string)
894
895Example:
896
897-> { "execute": "netdev_del", "arguments": { "id": "netdev1" } }
898<- { "return": {} }
899
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +0100900
901EQMP
902
903 {
Paolo Bonzinicff8b2c2013-12-20 23:21:10 +0100904 .name = "object-add",
905 .args_type = "qom-type:s,id:s,props:q?",
906 .mhandler.cmd_new = qmp_object_add,
907 },
908
909SQMP
910object-add
911----------
912
913Create QOM object.
914
915Arguments:
916
917- "qom-type": the object's QOM type, i.e. the class name (json-string)
918- "id": the object's ID, must be unique (json-string)
919- "props": a dictionary of object property values (optional, json-dict)
920
921Example:
922
923-> { "execute": "object-add", "arguments": { "qom-type": "rng-random", "id": "rng1",
924 "props": { "filename": "/dev/hwrng" } } }
925<- { "return": {} }
926
927EQMP
928
929 {
Paolo Bonziniab2d0532013-12-20 23:21:09 +0100930 .name = "object-del",
931 .args_type = "id:s",
932 .mhandler.cmd_new = qmp_marshal_input_object_del,
933 },
934
935SQMP
936object-del
937----------
938
939Remove QOM object.
940
941Arguments:
942
943- "id": the object's ID (json-string)
944
945Example:
946
947-> { "execute": "object-del", "arguments": { "id": "rng1" } }
948<- { "return": {} }
949
950
951EQMP
952
953
954 {
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +0100955 .name = "block_resize",
Benoît Canet3b1dbd12014-01-23 21:31:37 +0100956 .args_type = "device:s?,node-name:s?,size:o",
Luiz Capitulino5e7caac2011-11-25 14:57:10 -0200957 .mhandler.cmd_new = qmp_marshal_input_block_resize,
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +0100958 },
959
960SQMP
961block_resize
962------------
963
964Resize a block image while a guest is running.
965
966Arguments:
967
968- "device": the device's ID, must be unique (json-string)
Benoît Canet3b1dbd12014-01-23 21:31:37 +0100969- "node-name": the node name in the block driver state graph (json-string)
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +0100970- "size": new size
971
972Example:
973
974-> { "execute": "block_resize", "arguments": { "device": "scratch", "size": 1073741824 } }
975<- { "return": {} }
976
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300977EQMP
978
979 {
Stefan Hajnoczidb58f9c2012-04-11 16:27:10 +0100980 .name = "block-stream",
Jeff Cody13d8cc52014-06-25 15:40:11 -0400981 .args_type = "device:B,base:s?,speed:o?,backing-file:s?,on-error:s?",
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +0000982 .mhandler.cmd_new = qmp_marshal_input_block_stream,
983 },
984
985 {
Jeff Codyed61fc12012-09-27 13:29:16 -0400986 .name = "block-commit",
Jeff Cody54e26902014-06-25 15:40:10 -0400987 .args_type = "device:B,base:s?,top:s?,backing-file:s?,speed:o?",
Jeff Codyed61fc12012-09-27 13:29:16 -0400988 .mhandler.cmd_new = qmp_marshal_input_block_commit,
989 },
990
Jeff Cody37222902014-01-24 09:02:37 -0500991SQMP
992block-commit
993------------
994
995Live commit of data from overlay image nodes into backing nodes - i.e., writes
996data between 'top' and 'base' into 'base'.
997
998Arguments:
999
1000- "device": The device's ID, must be unique (json-string)
1001- "base": The file name of the backing image to write data into.
1002 If not specified, this is the deepest backing image
1003 (json-string, optional)
1004- "top": The file name of the backing image within the image chain,
Jeff Cody7676e2c2014-06-30 15:14:15 +02001005 which contains the topmost data to be committed down. If
1006 not specified, this is the active layer. (json-string, optional)
Jeff Cody37222902014-01-24 09:02:37 -05001007
Jeff Cody54e26902014-06-25 15:40:10 -04001008- backing-file: The backing file string to write into the overlay
1009 image of 'top'. If 'top' is the active layer,
1010 specifying a backing file string is an error. This
1011 filename is not validated.
1012
1013 If a pathname string is such that it cannot be
1014 resolved by QEMU, that means that subsequent QMP or
1015 HMP commands must use node-names for the image in
1016 question, as filename lookup methods will fail.
1017
1018 If not specified, QEMU will automatically determine
1019 the backing file string to use, or error out if
1020 there is no obvious choice. Care should be taken
1021 when specifying the string, to specify a valid
1022 filename or protocol.
1023 (json-string, optional) (Since 2.1)
1024
Jeff Cody37222902014-01-24 09:02:37 -05001025 If top == base, that is an error.
1026 If top == active, the job will not be completed by itself,
1027 user needs to complete the job with the block-job-complete
1028 command after getting the ready event. (Since 2.0)
1029
1030 If the base image is smaller than top, then the base image
1031 will be resized to be the same size as top. If top is
1032 smaller than the base image, the base will not be
1033 truncated. If you want the base image size to match the
1034 size of the smaller top, you can safely truncate it
1035 yourself once the commit operation successfully completes.
1036 (json-string)
1037- "speed": the maximum speed, in bytes per second (json-int, optional)
1038
1039
1040Example:
1041
1042-> { "execute": "block-commit", "arguments": { "device": "virtio0",
1043 "top": "/tmp/snap1.qcow2" } }
1044<- { "return": {} }
1045
1046EQMP
1047
Jeff Codyed61fc12012-09-27 13:29:16 -04001048 {
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02001049 .name = "drive-backup",
Stefan Hajnoczib53169e2013-06-26 14:11:57 +02001050 .args_type = "sync:s,device:B,target:s,speed:i?,mode:s?,format:s?,"
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02001051 "on-source-error:s?,on-target-error:s?",
1052 .mhandler.cmd_new = qmp_marshal_input_drive_backup,
1053 },
1054
1055SQMP
1056drive-backup
1057------------
1058
1059Start a point-in-time copy of a block device to a new destination. The
1060status of ongoing drive-backup operations can be checked with
1061query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
1062The operation can be stopped before it has completed using the
1063block-job-cancel command.
1064
1065Arguments:
1066
1067- "device": the name of the device which should be copied.
1068 (json-string)
1069- "target": the target of the new image. If the file exists, or if it is a
1070 device, the existing file/device will be used as the new
1071 destination. If it does not exist, a new file will be created.
1072 (json-string)
1073- "format": the format of the new destination, default is to probe if 'mode' is
1074 'existing', else the format of the source
1075 (json-string, optional)
Stefan Hajnoczib53169e2013-06-26 14:11:57 +02001076- "sync": what parts of the disk image should be copied to the destination;
1077 possibilities include "full" for all the disk, "top" for only the sectors
1078 allocated in the topmost image, or "none" to only replicate new I/O
1079 (MirrorSyncMode).
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02001080- "mode": whether and how QEMU should create a new image
1081 (NewImageMode, optional, default 'absolute-paths')
1082- "speed": the maximum speed, in bytes per second (json-int, optional)
1083- "on-source-error": the action to take on an error on the source, default
1084 'report'. 'stop' and 'enospc' can only be used
1085 if the block device supports io-status.
1086 (BlockdevOnError, optional)
1087- "on-target-error": the action to take on an error on the target, default
1088 'report' (no limitations, since this applies to
1089 a different block device than device).
1090 (BlockdevOnError, optional)
1091
1092Example:
1093-> { "execute": "drive-backup", "arguments": { "device": "drive0",
Ian Mainfc5d3f82013-07-26 11:39:04 -07001094 "sync": "full",
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02001095 "target": "backup.img" } }
1096<- { "return": {} }
1097EQMP
1098
1099 {
Stefan Hajnoczidb58f9c2012-04-11 16:27:10 +01001100 .name = "block-job-set-speed",
Stefan Hajnoczi882ec7c2012-04-25 16:51:02 +01001101 .args_type = "device:B,speed:o",
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00001102 .mhandler.cmd_new = qmp_marshal_input_block_job_set_speed,
1103 },
1104
1105 {
Stefan Hajnoczidb58f9c2012-04-11 16:27:10 +01001106 .name = "block-job-cancel",
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02001107 .args_type = "device:B,force:b?",
Stefan Hajnoczi370521a2012-01-18 14:40:48 +00001108 .mhandler.cmd_new = qmp_marshal_input_block_job_cancel,
1109 },
Jeff Codyc1864022012-02-28 15:54:07 -05001110 {
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02001111 .name = "block-job-pause",
1112 .args_type = "device:B",
1113 .mhandler.cmd_new = qmp_marshal_input_block_job_pause,
1114 },
1115 {
1116 .name = "block-job-resume",
1117 .args_type = "device:B",
1118 .mhandler.cmd_new = qmp_marshal_input_block_job_resume,
1119 },
1120 {
Paolo Bonziniaeae8832012-10-18 16:49:21 +02001121 .name = "block-job-complete",
1122 .args_type = "device:B",
1123 .mhandler.cmd_new = qmp_marshal_input_block_job_complete,
1124 },
1125 {
Paolo Bonzini52e7c242012-03-06 18:55:57 +01001126 .name = "transaction",
Paolo Bonzinib9f89782012-03-22 12:51:11 +01001127 .args_type = "actions:q",
Paolo Bonzini52e7c242012-03-06 18:55:57 +01001128 .mhandler.cmd_new = qmp_marshal_input_transaction,
Jeff Codyc1864022012-02-28 15:54:07 -05001129 },
1130
1131SQMP
Paolo Bonzini52e7c242012-03-06 18:55:57 +01001132transaction
1133-----------
Jeff Codyc1864022012-02-28 15:54:07 -05001134
Wenchao Xiabbe86012013-09-11 14:04:34 +08001135Atomically operate on one or more block devices. The only supported operations
1136for now are drive-backup, internal and external snapshotting. A list of
1137dictionaries is accepted, that contains the actions to be performed.
1138If there is any failure performing any of the operations, all operations
1139for the group are abandoned.
Jeff Codyc1864022012-02-28 15:54:07 -05001140
Wenchao Xiabbe86012013-09-11 14:04:34 +08001141For external snapshots, the dictionary contains the device, the file to use for
1142the new snapshot, and the format. The default format, if not specified, is
1143qcow2.
Jeff Codyc1864022012-02-28 15:54:07 -05001144
Paolo Bonzinibc8b0942012-03-06 18:55:58 +01001145Each new snapshot defaults to being created by QEMU (wiping any
1146contents if the file already exists), but it is also possible to reuse
1147an externally-created file. In the latter case, you should ensure that
1148the new image file has the same contents as the current one; QEMU cannot
1149perform any meaningful check. Typically this is achieved by using the
1150current image file as the backing file for the new image.
1151
Wenchao Xiabbe86012013-09-11 14:04:34 +08001152On failure, the original disks pre-snapshot attempt will be used.
1153
1154For internal snapshots, the dictionary contains the device and the snapshot's
1155name. If an internal snapshot matching name already exists, the request will
1156be rejected. Only some image formats support it, for example, qcow2, rbd,
1157and sheepdog.
1158
1159On failure, qemu will try delete the newly created internal snapshot in the
1160transaction. When an I/O error occurs during deletion, the user needs to fix
1161it later with qemu-img or other command.
1162
Jeff Codyc1864022012-02-28 15:54:07 -05001163Arguments:
1164
Paolo Bonzini52e7c242012-03-06 18:55:57 +01001165actions array:
1166 - "type": the operation to perform. The only supported
1167 value is "blockdev-snapshot-sync". (json-string)
1168 - "data": a dictionary. The contents depend on the value
1169 of "type". When "type" is "blockdev-snapshot-sync":
1170 - "device": device name to snapshot (json-string)
Benoît Canet0901f672014-01-23 21:31:38 +01001171 - "node-name": graph node name to snapshot (json-string)
Paolo Bonzini52e7c242012-03-06 18:55:57 +01001172 - "snapshot-file": name of new image file (json-string)
Benoît Canet0901f672014-01-23 21:31:38 +01001173 - "snapshot-node-name": graph node name of the new snapshot (json-string)
Paolo Bonzini52e7c242012-03-06 18:55:57 +01001174 - "format": format of new image (json-string, optional)
Paolo Bonzinibc8b0942012-03-06 18:55:58 +01001175 - "mode": whether and how QEMU should create the snapshot file
1176 (NewImageMode, optional, default "absolute-paths")
Wenchao Xiabbe86012013-09-11 14:04:34 +08001177 When "type" is "blockdev-snapshot-internal-sync":
1178 - "device": device name to snapshot (json-string)
1179 - "name": name of the new snapshot (json-string)
Jeff Codyc1864022012-02-28 15:54:07 -05001180
1181Example:
1182
Paolo Bonzini52e7c242012-03-06 18:55:57 +01001183-> { "execute": "transaction",
1184 "arguments": { "actions": [
Eric Blakecd0c5382014-05-06 09:39:03 -06001185 { "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd0",
Paolo Bonzini52e7c242012-03-06 18:55:57 +01001186 "snapshot-file": "/some/place/my-image",
1187 "format": "qcow2" } },
Eric Blakecd0c5382014-05-06 09:39:03 -06001188 { "type": "blockdev-snapshot-sync", "data" : { "node-name": "myfile",
Benoît Canet0901f672014-01-23 21:31:38 +01001189 "snapshot-file": "/some/place/my-image2",
1190 "snapshot-node-name": "node3432",
1191 "mode": "existing",
1192 "format": "qcow2" } },
Eric Blakecd0c5382014-05-06 09:39:03 -06001193 { "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd1",
Paolo Bonzini52e7c242012-03-06 18:55:57 +01001194 "snapshot-file": "/some/place/my-image2",
Paolo Bonzinibc8b0942012-03-06 18:55:58 +01001195 "mode": "existing",
Wenchao Xiabbe86012013-09-11 14:04:34 +08001196 "format": "qcow2" } },
Eric Blakecd0c5382014-05-06 09:39:03 -06001197 { "type": "blockdev-snapshot-internal-sync", "data" : {
Wenchao Xiabbe86012013-09-11 14:04:34 +08001198 "device": "ide-hd2",
1199 "name": "snapshot0" } } ] } }
Jeff Codyc1864022012-02-28 15:54:07 -05001200<- { "return": {} }
1201
1202EQMP
Stefan Hajnoczi370521a2012-01-18 14:40:48 +00001203
1204 {
Jes Sorensend967b2f2011-07-11 20:01:09 +02001205 .name = "blockdev-snapshot-sync",
Benoît Canet0901f672014-01-23 21:31:38 +01001206 .args_type = "device:s?,node-name:s?,snapshot-file:s,snapshot-node-name:s?,format:s?,mode:s?",
Luiz Capitulino6106e242011-11-25 16:15:19 -02001207 .mhandler.cmd_new = qmp_marshal_input_blockdev_snapshot_sync,
Jes Sorensend967b2f2011-07-11 20:01:09 +02001208 },
1209
1210SQMP
1211blockdev-snapshot-sync
1212----------------------
1213
1214Synchronous snapshot of a block device. snapshot-file specifies the
1215target of the new image. If the file exists, or if it is a device, the
1216snapshot will be created in the existing file/device. If does not
1217exist, a new file will be created. format specifies the format of the
1218snapshot image, default is qcow2.
1219
1220Arguments:
1221
1222- "device": device name to snapshot (json-string)
Benoît Canet0901f672014-01-23 21:31:38 +01001223- "node-name": graph node name to snapshot (json-string)
Jes Sorensend967b2f2011-07-11 20:01:09 +02001224- "snapshot-file": name of new image file (json-string)
Benoît Canet0901f672014-01-23 21:31:38 +01001225- "snapshot-node-name": graph node name of the new snapshot (json-string)
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001226- "mode": whether and how QEMU should create the snapshot file
1227 (NewImageMode, optional, default "absolute-paths")
Jes Sorensend967b2f2011-07-11 20:01:09 +02001228- "format": format of new image (json-string, optional)
1229
1230Example:
1231
Luiz Capitulino7f3850c2011-10-10 17:30:08 -03001232-> { "execute": "blockdev-snapshot-sync", "arguments": { "device": "ide-hd0",
1233 "snapshot-file":
1234 "/some/place/my-image",
1235 "format": "qcow2" } }
Jes Sorensend967b2f2011-07-11 20:01:09 +02001236<- { "return": {} }
1237
1238EQMP
1239
1240 {
Wenchao Xiaf323bc92013-09-11 14:04:35 +08001241 .name = "blockdev-snapshot-internal-sync",
1242 .args_type = "device:B,name:s",
1243 .mhandler.cmd_new = qmp_marshal_input_blockdev_snapshot_internal_sync,
1244 },
1245
1246SQMP
1247blockdev-snapshot-internal-sync
1248-------------------------------
1249
1250Synchronously take an internal snapshot of a block device when the format of
1251image used supports it. If the name is an empty string, or a snapshot with
1252name already exists, the operation will fail.
1253
1254Arguments:
1255
1256- "device": device name to snapshot (json-string)
1257- "name": name of the new snapshot (json-string)
1258
1259Example:
1260
1261-> { "execute": "blockdev-snapshot-internal-sync",
1262 "arguments": { "device": "ide-hd0",
1263 "name": "snapshot0" }
1264 }
1265<- { "return": {} }
1266
1267EQMP
1268
1269 {
Wenchao Xia44e3e052013-09-11 14:04:36 +08001270 .name = "blockdev-snapshot-delete-internal-sync",
1271 .args_type = "device:B,id:s?,name:s?",
1272 .mhandler.cmd_new =
1273 qmp_marshal_input_blockdev_snapshot_delete_internal_sync,
1274 },
1275
1276SQMP
1277blockdev-snapshot-delete-internal-sync
1278--------------------------------------
1279
1280Synchronously delete an internal snapshot of a block device when the format of
1281image used supports it. The snapshot is identified by name or id or both. One
1282of name or id is required. If the snapshot is not found, the operation will
1283fail.
1284
1285Arguments:
1286
1287- "device": device name (json-string)
1288- "id": ID of the snapshot (json-string, optional)
1289- "name": name of the snapshot (json-string, optional)
1290
1291Example:
1292
1293-> { "execute": "blockdev-snapshot-delete-internal-sync",
1294 "arguments": { "device": "ide-hd0",
1295 "name": "snapshot0" }
1296 }
1297<- { "return": {
1298 "id": "1",
1299 "name": "snapshot0",
1300 "vm-state-size": 0,
1301 "date-sec": 1000012,
1302 "date-nsec": 10,
1303 "vm-clock-sec": 100,
1304 "vm-clock-nsec": 20
1305 }
1306 }
1307
1308EQMP
1309
1310 {
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02001311 .name = "drive-mirror",
Paolo Bonzinib952b552012-10-18 16:49:28 +02001312 .args_type = "sync:s,device:B,target:s,speed:i?,mode:s?,format:s?,"
Benoît Canet09158f02014-06-27 18:25:25 +02001313 "node-name:s?,replaces:s?,"
Paolo Bonzinieee13df2013-01-21 17:09:46 +01001314 "on-source-error:s?,on-target-error:s?,"
Paolo Bonzini08e4ed62013-01-22 09:03:13 +01001315 "granularity:i?,buf-size:i?",
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02001316 .mhandler.cmd_new = qmp_marshal_input_drive_mirror,
1317 },
1318
1319SQMP
1320drive-mirror
1321------------
1322
1323Start mirroring a block device's writes to a new destination. target
1324specifies the target of the new image. If the file exists, or if it is
1325a device, it will be used as the new destination for writes. If it does not
1326exist, a new file will be created. format specifies the format of the
1327mirror image, default is to probe if mode='existing', else the format
1328of the source.
1329
1330Arguments:
1331
1332- "device": device name to operate on (json-string)
1333- "target": name of new image file (json-string)
1334- "format": format of new image (json-string, optional)
Benoît Canet4c828dc2014-06-16 12:00:55 +02001335- "node-name": the name of the new block driver state in the node graph
1336 (json-string, optional)
Benoît Canet09158f02014-06-27 18:25:25 +02001337- "replaces": the block driver node name to replace when finished
1338 (json-string, optional)
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02001339- "mode": how an image file should be created into the target
1340 file/device (NewImageMode, optional, default 'absolute-paths')
1341- "speed": maximum speed of the streaming job, in bytes per second
1342 (json-int)
Paolo Bonzinieee13df2013-01-21 17:09:46 +01001343- "granularity": granularity of the dirty bitmap, in bytes (json-int, optional)
Paolo Bonzini08e4ed62013-01-22 09:03:13 +01001344- "buf_size": maximum amount of data in flight from source to target, in bytes
1345 (json-int, default 10M)
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02001346- "sync": what parts of the disk image should be copied to the destination;
1347 possibilities include "full" for all the disk, "top" for only the sectors
1348 allocated in the topmost image, or "none" to only replicate new I/O
1349 (MirrorSyncMode).
Paolo Bonzinib952b552012-10-18 16:49:28 +02001350- "on-source-error": the action to take on an error on the source
1351 (BlockdevOnError, default 'report')
1352- "on-target-error": the action to take on an error on the target
1353 (BlockdevOnError, default 'report')
1354
Paolo Bonzinieee13df2013-01-21 17:09:46 +01001355The default value of the granularity is the image cluster size clamped
1356between 4096 and 65536, if the image format defines one. If the format
1357does not define a cluster size, the default value of the granularity
1358is 65536.
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02001359
1360
1361Example:
1362
1363-> { "execute": "drive-mirror", "arguments": { "device": "ide-hd0",
1364 "target": "/some/place/my-image",
1365 "sync": "full",
1366 "format": "qcow2" } }
1367<- { "return": {} }
1368
1369EQMP
1370
1371 {
Jeff Codyfa40e652014-07-01 09:52:16 +02001372 .name = "change-backing-file",
1373 .args_type = "device:s,image-node-name:s,backing-file:s",
1374 .mhandler.cmd_new = qmp_marshal_input_change_backing_file,
1375 },
1376
1377SQMP
1378change-backing-file
1379-------------------
1380Since: 2.1
1381
1382Change the backing file in the image file metadata. This does not cause
1383QEMU to reopen the image file to reparse the backing filename (it may,
1384however, perform a reopen to change permissions from r/o -> r/w -> r/o,
1385if needed). The new backing file string is written into the image file
1386metadata, and the QEMU internal strings are updated.
1387
1388Arguments:
1389
1390- "image-node-name": The name of the block driver state node of the
1391 image to modify. The "device" is argument is used to
1392 verify "image-node-name" is in the chain described by
1393 "device".
1394 (json-string, optional)
1395
1396- "device": The name of the device.
1397 (json-string)
1398
1399- "backing-file": The string to write as the backing file. This string is
1400 not validated, so care should be taken when specifying
1401 the string or the image chain may not be able to be
1402 reopened again.
1403 (json-string)
1404
1405Returns: Nothing on success
1406 If "device" does not exist or cannot be determined, DeviceNotFound
1407
1408EQMP
1409
1410 {
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001411 .name = "balloon",
1412 .args_type = "value:M",
Luiz Capitulinod72f3262011-11-25 14:38:09 -02001413 .mhandler.cmd_new = qmp_marshal_input_balloon,
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001414 },
1415
1416SQMP
1417balloon
1418-------
1419
1420Request VM to change its memory allocation (in bytes).
1421
1422Arguments:
1423
1424- "value": New memory allocation (json-int)
1425
1426Example:
1427
1428-> { "execute": "balloon", "arguments": { "value": 536870912 } }
1429<- { "return": {} }
1430
1431EQMP
1432
1433 {
1434 .name = "set_link",
1435 .args_type = "name:s,up:b",
Luiz Capitulino4b371562011-11-23 13:11:55 -02001436 .mhandler.cmd_new = qmp_marshal_input_set_link,
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001437 },
1438
1439SQMP
1440set_link
1441--------
1442
1443Change the link status of a network adapter.
1444
1445Arguments:
1446
1447- "name": network device name (json-string)
1448- "up": status is up (json-bool)
1449
1450Example:
1451
1452-> { "execute": "set_link", "arguments": { "name": "e1000.0", "up": false } }
1453<- { "return": {} }
1454
1455EQMP
1456
1457 {
1458 .name = "getfd",
1459 .args_type = "fdname:s",
1460 .params = "getfd name",
1461 .help = "receive a file descriptor via SCM rights and assign it a name",
Corey Bryant208c9d12012-06-22 14:36:09 -04001462 .mhandler.cmd_new = qmp_marshal_input_getfd,
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001463 },
1464
1465SQMP
1466getfd
1467-----
1468
1469Receive a file descriptor via SCM rights and assign it a name.
1470
1471Arguments:
1472
1473- "fdname": file descriptor name (json-string)
1474
1475Example:
1476
1477-> { "execute": "getfd", "arguments": { "fdname": "fd1" } }
1478<- { "return": {} }
1479
Corey Bryant208c9d12012-06-22 14:36:09 -04001480Notes:
1481
1482(1) If the name specified by the "fdname" argument already exists,
1483 the file descriptor assigned to it will be closed and replaced
1484 by the received file descriptor.
1485(2) The 'closefd' command can be used to explicitly close the file
1486 descriptor when it is no longer needed.
1487
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001488EQMP
1489
1490 {
1491 .name = "closefd",
1492 .args_type = "fdname:s",
1493 .params = "closefd name",
1494 .help = "close a file descriptor previously passed via SCM rights",
Corey Bryant208c9d12012-06-22 14:36:09 -04001495 .mhandler.cmd_new = qmp_marshal_input_closefd,
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001496 },
1497
1498SQMP
1499closefd
1500-------
1501
1502Close a file descriptor previously passed via SCM rights.
1503
1504Arguments:
1505
1506- "fdname": file descriptor name (json-string)
1507
1508Example:
1509
1510-> { "execute": "closefd", "arguments": { "fdname": "fd1" } }
1511<- { "return": {} }
1512
1513EQMP
1514
Corey Bryantba1c0482012-08-14 16:43:43 -04001515 {
1516 .name = "add-fd",
1517 .args_type = "fdset-id:i?,opaque:s?",
1518 .params = "add-fd fdset-id opaque",
1519 .help = "Add a file descriptor, that was passed via SCM rights, to an fd set",
1520 .mhandler.cmd_new = qmp_marshal_input_add_fd,
1521 },
1522
1523SQMP
1524add-fd
1525-------
1526
1527Add a file descriptor, that was passed via SCM rights, to an fd set.
1528
1529Arguments:
1530
1531- "fdset-id": The ID of the fd set to add the file descriptor to.
1532 (json-int, optional)
1533- "opaque": A free-form string that can be used to describe the fd.
1534 (json-string, optional)
1535
1536Return a json-object with the following information:
1537
1538- "fdset-id": The ID of the fd set that the fd was added to. (json-int)
1539- "fd": The file descriptor that was received via SCM rights and added to the
1540 fd set. (json-int)
1541
1542Example:
1543
1544-> { "execute": "add-fd", "arguments": { "fdset-id": 1 } }
1545<- { "return": { "fdset-id": 1, "fd": 3 } }
1546
1547Notes:
1548
1549(1) The list of fd sets is shared by all monitor connections.
1550(2) If "fdset-id" is not specified, a new fd set will be created.
1551
1552EQMP
1553
1554 {
1555 .name = "remove-fd",
1556 .args_type = "fdset-id:i,fd:i?",
1557 .params = "remove-fd fdset-id fd",
1558 .help = "Remove a file descriptor from an fd set",
1559 .mhandler.cmd_new = qmp_marshal_input_remove_fd,
1560 },
1561
1562SQMP
1563remove-fd
1564---------
1565
1566Remove a file descriptor from an fd set.
1567
1568Arguments:
1569
1570- "fdset-id": The ID of the fd set that the file descriptor belongs to.
1571 (json-int)
1572- "fd": The file descriptor that is to be removed. (json-int, optional)
1573
1574Example:
1575
1576-> { "execute": "remove-fd", "arguments": { "fdset-id": 1, "fd": 3 } }
1577<- { "return": {} }
1578
1579Notes:
1580
1581(1) The list of fd sets is shared by all monitor connections.
1582(2) If "fd" is not specified, all file descriptors in "fdset-id" will be
1583 removed.
1584
1585EQMP
1586
1587 {
1588 .name = "query-fdsets",
1589 .args_type = "",
1590 .help = "Return information describing all fd sets",
1591 .mhandler.cmd_new = qmp_marshal_input_query_fdsets,
1592 },
1593
1594SQMP
1595query-fdsets
1596-------------
1597
1598Return information describing all fd sets.
1599
1600Arguments: None
1601
1602Example:
1603
1604-> { "execute": "query-fdsets" }
1605<- { "return": [
1606 {
1607 "fds": [
1608 {
1609 "fd": 30,
1610 "opaque": "rdonly:/path/to/file"
1611 },
1612 {
1613 "fd": 24,
1614 "opaque": "rdwr:/path/to/file"
1615 }
1616 ],
1617 "fdset-id": 1
1618 },
1619 {
1620 "fds": [
1621 {
1622 "fd": 28
1623 },
1624 {
1625 "fd": 29
1626 }
1627 ],
1628 "fdset-id": 0
1629 }
1630 ]
1631 }
1632
1633Note: The list of fd sets is shared by all monitor connections.
1634
1635EQMP
1636
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001637 {
1638 .name = "block_passwd",
Benoît Canet12d3ba82014-01-23 21:31:35 +01001639 .args_type = "device:s?,node-name:s?,password:s",
Luiz Capitulinoa4dea8a2011-11-23 13:28:21 -02001640 .mhandler.cmd_new = qmp_marshal_input_block_passwd,
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001641 },
1642
1643SQMP
1644block_passwd
1645------------
1646
1647Set the password of encrypted block devices.
1648
1649Arguments:
1650
1651- "device": device name (json-string)
Benoît Canet12d3ba82014-01-23 21:31:35 +01001652- "node-name": name in the block driver state graph (json-string)
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001653- "password": password (json-string)
1654
1655Example:
1656
1657-> { "execute": "block_passwd", "arguments": { "device": "ide0-hd0",
1658 "password": "12345" } }
1659<- { "return": {} }
1660
1661EQMP
1662
1663 {
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001664 .name = "block_set_io_throttle",
Benoît Canet2024c1d2013-09-02 14:14:41 +02001665 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l,bps_max:l?,bps_rd_max:l?,bps_wr_max:l?,iops_max:l?,iops_rd_max:l?,iops_wr_max:l?,iops_size:l?",
Luiz Capitulino80047da2011-12-14 16:49:14 -02001666 .mhandler.cmd_new = qmp_marshal_input_block_set_io_throttle,
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001667 },
1668
1669SQMP
1670block_set_io_throttle
1671------------
1672
1673Change I/O throttle limits for a block drive.
1674
1675Arguments:
1676
1677- "device": device name (json-string)
Eric Blake586b5462013-08-30 14:44:11 -06001678- "bps": total throughput limit in bytes per second (json-int)
1679- "bps_rd": read throughput limit in bytes per second (json-int)
1680- "bps_wr": write throughput limit in bytes per second (json-int)
1681- "iops": total I/O operations per second (json-int)
1682- "iops_rd": read I/O operations per second (json-int)
1683- "iops_wr": write I/O operations per second (json-int)
Benoît Canet3e9fab62013-09-02 14:14:40 +02001684- "bps_max": total max in bytes (json-int)
1685- "bps_rd_max": read max in bytes (json-int)
1686- "bps_wr_max": write max in bytes (json-int)
1687- "iops_max": total I/O operations max (json-int)
1688- "iops_rd_max": read I/O operations max (json-int)
1689- "iops_wr_max": write I/O operations max (json-int)
Benoît Canet2024c1d2013-09-02 14:14:41 +02001690- "iops_size": I/O size in bytes when limiting (json-int)
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001691
1692Example:
1693
1694-> { "execute": "block_set_io_throttle", "arguments": { "device": "virtio0",
Eric Blake586b5462013-08-30 14:44:11 -06001695 "bps": 1000000,
1696 "bps_rd": 0,
1697 "bps_wr": 0,
1698 "iops": 0,
1699 "iops_rd": 0,
Benoît Canet3e9fab62013-09-02 14:14:40 +02001700 "iops_wr": 0,
1701 "bps_max": 8000000,
1702 "bps_rd_max": 0,
1703 "bps_wr_max": 0,
1704 "iops_max": 0,
1705 "iops_rd_max": 0,
Benoît Canet2024c1d2013-09-02 14:14:41 +02001706 "iops_wr_max": 0,
1707 "iops_size": 0 } }
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001708<- { "return": {} }
1709
1710EQMP
1711
1712 {
Gerd Hoffmann75721502010-10-07 12:22:54 +02001713 .name = "set_password",
1714 .args_type = "protocol:s,password:s,connected:s?",
Luiz Capitulinofbf796f2011-12-07 11:17:51 -02001715 .mhandler.cmd_new = qmp_marshal_input_set_password,
Gerd Hoffmann75721502010-10-07 12:22:54 +02001716 },
1717
1718SQMP
1719set_password
1720------------
1721
1722Set the password for vnc/spice protocols.
1723
1724Arguments:
1725
1726- "protocol": protocol name (json-string)
1727- "password": password (json-string)
1728- "connected": [ keep | disconnect | fail ] (josn-string, optional)
1729
1730Example:
1731
1732-> { "execute": "set_password", "arguments": { "protocol": "vnc",
1733 "password": "secret" } }
1734<- { "return": {} }
1735
1736EQMP
1737
1738 {
1739 .name = "expire_password",
1740 .args_type = "protocol:s,time:s",
Luiz Capitulino9ad53722011-12-07 11:47:57 -02001741 .mhandler.cmd_new = qmp_marshal_input_expire_password,
Gerd Hoffmann75721502010-10-07 12:22:54 +02001742 },
1743
1744SQMP
1745expire_password
1746---------------
1747
1748Set the password expire time for vnc/spice protocols.
1749
1750Arguments:
1751
1752- "protocol": protocol name (json-string)
1753- "time": [ now | never | +secs | secs ] (json-string)
1754
1755Example:
1756
1757-> { "execute": "expire_password", "arguments": { "protocol": "vnc",
1758 "time": "+60" } }
1759<- { "return": {} }
1760
1761EQMP
1762
1763 {
Daniel P. Berrange13661082011-06-23 13:31:42 +01001764 .name = "add_client",
Daniel P. Berrangef1f5f402012-02-13 13:43:08 +00001765 .args_type = "protocol:s,fdname:s,skipauth:b?,tls:b?",
Luiz Capitulinob224e5e2012-09-13 16:52:20 -03001766 .mhandler.cmd_new = qmp_marshal_input_add_client,
Daniel P. Berrange13661082011-06-23 13:31:42 +01001767 },
1768
1769SQMP
1770add_client
1771----------
1772
1773Add a graphics client
1774
1775Arguments:
1776
1777- "protocol": protocol name (json-string)
1778- "fdname": file descriptor name (json-string)
Daniel P. Berrangef1f5f402012-02-13 13:43:08 +00001779- "skipauth": whether to skip authentication (json-bool, optional)
1780- "tls": whether to perform TLS (json-bool, optional)
Daniel P. Berrange13661082011-06-23 13:31:42 +01001781
1782Example:
1783
1784-> { "execute": "add_client", "arguments": { "protocol": "vnc",
1785 "fdname": "myclient" } }
1786<- { "return": {} }
1787
1788EQMP
1789 {
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001790 .name = "qmp_capabilities",
1791 .args_type = "",
1792 .params = "",
1793 .help = "enable QMP capabilities",
1794 .user_print = monitor_user_noop,
1795 .mhandler.cmd_new = do_qmp_capabilities,
1796 },
1797
1798SQMP
1799qmp_capabilities
1800----------------
1801
1802Enable QMP capabilities.
1803
1804Arguments: None.
1805
1806Example:
1807
1808-> { "execute": "qmp_capabilities" }
1809<- { "return": {} }
1810
1811Note: This command must be issued before issuing any other command.
1812
Luiz Capitulino0268d972010-10-22 10:08:02 -02001813EQMP
1814
1815 {
1816 .name = "human-monitor-command",
1817 .args_type = "command-line:s,cpu-index:i?",
Luiz Capitulinod51a67b2011-11-25 17:52:45 -02001818 .mhandler.cmd_new = qmp_marshal_input_human_monitor_command,
Luiz Capitulino0268d972010-10-22 10:08:02 -02001819 },
1820
1821SQMP
1822human-monitor-command
1823---------------------
1824
1825Execute a Human Monitor command.
1826
1827Arguments:
1828
1829- command-line: the command name and its arguments, just like the
1830 Human Monitor's shell (json-string)
1831- cpu-index: select the CPU number to be used by commands which access CPU
1832 data, like 'info registers'. The Monitor selects CPU 0 if this
1833 argument is not provided (json-int, optional)
1834
1835Example:
1836
1837-> { "execute": "human-monitor-command", "arguments": { "command-line": "info kvm" } }
1838<- { "return": "kvm support: enabled\r\n" }
1839
1840Notes:
1841
1842(1) The Human Monitor is NOT an stable interface, this means that command
1843 names, arguments and responses can change or be removed at ANY time.
1844 Applications that rely on long term stability guarantees should NOT
1845 use this command
1846
1847(2) Limitations:
1848
1849 o This command is stateless, this means that commands that depend
1850 on state information (such as getfd) might not work
1851
1852 o Commands that prompt the user for data (eg. 'cont' when the block
1853 device is encrypted) don't currently work
1854
Luiz Capitulino82a56f02010-09-13 12:26:00 -030018553. Query Commands
1856=================
1857
1858HXCOMM Each query command below is inside a SQMP/EQMP section, do NOT change
1859HXCOMM this! We will possibly move query commands definitions inside those
1860HXCOMM sections, just like regular commands.
1861
1862EQMP
1863
1864SQMP
1865query-version
1866-------------
1867
1868Show QEMU version.
1869
1870Return a json-object with the following information:
1871
1872- "qemu": A json-object containing three integer values:
1873 - "major": QEMU's major version (json-int)
1874 - "minor": QEMU's minor version (json-int)
1875 - "micro": QEMU's micro version (json-int)
1876- "package": package's version (json-string)
1877
1878Example:
1879
1880-> { "execute": "query-version" }
1881<- {
1882 "return":{
1883 "qemu":{
1884 "major":0,
1885 "minor":11,
1886 "micro":5
1887 },
1888 "package":""
1889 }
1890 }
1891
1892EQMP
1893
Luiz Capitulinob9c15f12011-08-26 17:38:13 -03001894 {
1895 .name = "query-version",
1896 .args_type = "",
1897 .mhandler.cmd_new = qmp_marshal_input_query_version,
1898 },
1899
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001900SQMP
1901query-commands
1902--------------
1903
1904List QMP available commands.
1905
1906Each command is represented by a json-object, the returned value is a json-array
1907of all commands.
1908
1909Each json-object contain:
1910
1911- "name": command's name (json-string)
1912
1913Example:
1914
1915-> { "execute": "query-commands" }
1916<- {
1917 "return":[
1918 {
1919 "name":"query-balloon"
1920 },
1921 {
1922 "name":"system_powerdown"
1923 }
1924 ]
1925 }
1926
1927Note: This example has been shortened as the real response is too long.
1928
1929EQMP
1930
Luiz Capitulinoaa9b79b2011-09-21 14:31:51 -03001931 {
1932 .name = "query-commands",
1933 .args_type = "",
1934 .mhandler.cmd_new = qmp_marshal_input_query_commands,
1935 },
1936
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001937SQMP
Daniel P. Berrange48608532012-05-21 17:59:51 +01001938query-events
1939--------------
1940
1941List QMP available events.
1942
1943Each event is represented by a json-object, the returned value is a json-array
1944of all events.
1945
1946Each json-object contains:
1947
1948- "name": event's name (json-string)
1949
1950Example:
1951
1952-> { "execute": "query-events" }
1953<- {
1954 "return":[
1955 {
1956 "name":"SHUTDOWN"
1957 },
1958 {
1959 "name":"RESET"
1960 }
1961 ]
1962 }
1963
1964Note: This example has been shortened as the real response is too long.
1965
1966EQMP
1967
1968 {
1969 .name = "query-events",
1970 .args_type = "",
1971 .mhandler.cmd_new = qmp_marshal_input_query_events,
1972 },
1973
1974SQMP
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001975query-chardev
1976-------------
1977
1978Each device is represented by a json-object. The returned value is a json-array
1979of all devices.
1980
1981Each json-object contain the following:
1982
1983- "label": device's label (json-string)
1984- "filename": device's file (json-string)
Laszlo Ersek32a97ea2014-06-26 17:50:03 +02001985- "frontend-open": open/closed state of the frontend device attached to this
1986 backend (json-bool)
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001987
1988Example:
1989
1990-> { "execute": "query-chardev" }
1991<- {
Laszlo Ersek32a97ea2014-06-26 17:50:03 +02001992 "return": [
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001993 {
Laszlo Ersek32a97ea2014-06-26 17:50:03 +02001994 "label": "charchannel0",
1995 "filename": "unix:/var/lib/libvirt/qemu/seabios.rhel6.agent,server",
1996 "frontend-open": false
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001997 },
1998 {
Laszlo Ersek32a97ea2014-06-26 17:50:03 +02001999 "label": "charmonitor",
2000 "filename": "unix:/var/lib/libvirt/qemu/seabios.rhel6.monitor,server",
2001 "frontend-open": true
2002 },
2003 {
2004 "label": "charserial0",
2005 "filename": "pty:/dev/pts/2",
2006 "frontend-open": true
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002007 }
2008 ]
2009 }
2010
2011EQMP
2012
Luiz Capitulinoc5a415a2011-09-14 16:05:49 -03002013 {
2014 .name = "query-chardev",
2015 .args_type = "",
2016 .mhandler.cmd_new = qmp_marshal_input_query_chardev,
2017 },
2018
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002019SQMP
Martin Kletzander77d1c3c2014-02-01 12:52:42 +01002020query-chardev-backends
2021-------------
2022
2023List available character device backends.
2024
2025Each backend is represented by a json-object, the returned value is a json-array
2026of all backends.
2027
2028Each json-object contains:
2029
2030- "name": backend name (json-string)
2031
2032Example:
2033
2034-> { "execute": "query-chardev-backends" }
2035<- {
2036 "return":[
2037 {
2038 "name":"udp"
2039 },
2040 {
2041 "name":"tcp"
2042 },
2043 {
2044 "name":"unix"
2045 },
2046 {
2047 "name":"spiceport"
2048 }
2049 ]
2050 }
2051
2052EQMP
2053
2054 {
2055 .name = "query-chardev-backends",
2056 .args_type = "",
2057 .mhandler.cmd_new = qmp_marshal_input_query_chardev_backends,
2058 },
2059
2060SQMP
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002061query-block
2062-----------
2063
2064Show the block devices.
2065
2066Each block device information is stored in a json-object and the returned value
2067is a json-array of all devices.
2068
2069Each json-object contain the following:
2070
2071- "device": device name (json-string)
2072- "type": device type (json-string)
Markus Armbrusterd8aeeb32011-05-16 15:04:55 +02002073 - deprecated, retained for backward compatibility
2074 - Possible values: "unknown"
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002075- "removable": true if the device is removable, false otherwise (json-bool)
2076- "locked": true if the device is locked, false otherwise (json-bool)
Michal Privoznik99f42802013-01-29 17:58:41 +01002077- "tray_open": only present if removable, true if the device has a tray,
Markus Armbrustere4def802011-09-06 18:58:53 +02002078 and it is open (json-bool)
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002079- "inserted": only present if the device is inserted, it is a json-object
2080 containing the following:
2081 - "file": device file name (json-string)
2082 - "ro": true if read-only, false otherwise (json-bool)
2083 - "drv": driver format name (json-string)
Stefan Hajnoczi550830f2014-09-16 15:24:24 +01002084 - Possible values: "blkdebug", "bochs", "cloop", "dmg",
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002085 "file", "file", "ftp", "ftps", "host_cdrom",
2086 "host_device", "host_floppy", "http", "https",
2087 "nbd", "parallels", "qcow", "qcow2", "raw",
2088 "tftp", "vdi", "vmdk", "vpc", "vvfat"
2089 - "backing_file": backing file name (json-string, optional)
Benoît Canet2e3e3312012-08-02 10:22:48 +02002090 - "backing_file_depth": number of files in the backing file chain (json-int)
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002091 - "encrypted": true if encrypted, false otherwise (json-bool)
Zhi Yong Wu727f0052011-11-08 13:00:31 +08002092 - "bps": limit total bytes per second (json-int)
2093 - "bps_rd": limit read bytes per second (json-int)
2094 - "bps_wr": limit write bytes per second (json-int)
2095 - "iops": limit total I/O operations per second (json-int)
2096 - "iops_rd": limit read operations per second (json-int)
2097 - "iops_wr": limit write operations per second (json-int)
Benoît Canet3e9fab62013-09-02 14:14:40 +02002098 - "bps_max": total max in bytes (json-int)
2099 - "bps_rd_max": read max in bytes (json-int)
2100 - "bps_wr_max": write max in bytes (json-int)
2101 - "iops_max": total I/O operations max (json-int)
2102 - "iops_rd_max": read I/O operations max (json-int)
2103 - "iops_wr_max": write I/O operations max (json-int)
Benoît Canet2024c1d2013-09-02 14:14:41 +02002104 - "iops_size": I/O size when limiting by iops (json-int)
Peter Lieven465bee12014-05-18 00:58:19 +02002105 - "detect_zeroes": detect and optimize zero writing (json-string)
2106 - Possible values: "off", "on", "unmap"
Wenchao Xia553a7e82013-06-06 12:27:59 +08002107 - "image": the detail of the image, it is a json-object containing
2108 the following:
2109 - "filename": image file name (json-string)
2110 - "format": image format (json-string)
2111 - "virtual-size": image capacity in bytes (json-int)
2112 - "dirty-flag": true if image is not cleanly closed, not present
2113 means clean (json-bool, optional)
2114 - "actual-size": actual size on disk in bytes of the image, not
2115 present when image does not support thin
2116 provision (json-int, optional)
2117 - "cluster-size": size of a cluster in bytes, not present if image
2118 format does not support it (json-int, optional)
2119 - "encrypted": true if the image is encrypted, not present means
2120 false or the image format does not support
2121 encryption (json-bool, optional)
2122 - "backing_file": backing file name, not present means no backing
2123 file is used or the image format does not
2124 support backing file chain
2125 (json-string, optional)
2126 - "full-backing-filename": full path of the backing file, not
2127 present if it equals backing_file or no
2128 backing file is used
2129 (json-string, optional)
2130 - "backing-filename-format": the format of the backing file, not
2131 present means unknown or no backing
2132 file (json-string, optional)
2133 - "snapshots": the internal snapshot info, it is an optional list
2134 of json-object containing the following:
2135 - "id": unique snapshot id (json-string)
2136 - "name": snapshot name (json-string)
2137 - "vm-state-size": size of the VM state in bytes (json-int)
2138 - "date-sec": UTC date of the snapshot in seconds (json-int)
2139 - "date-nsec": fractional part in nanoseconds to be used with
Eric Blake586b5462013-08-30 14:44:11 -06002140 date-sec (json-int)
Wenchao Xia553a7e82013-06-06 12:27:59 +08002141 - "vm-clock-sec": VM clock relative to boot in seconds
2142 (json-int)
2143 - "vm-clock-nsec": fractional part in nanoseconds to be used
2144 with vm-clock-sec (json-int)
2145 - "backing-image": the detail of the backing image, it is an
2146 optional json-object only present when a
2147 backing image present for this image
Zhi Yong Wu727f0052011-11-08 13:00:31 +08002148
Luiz Capitulinof04ef602011-09-26 17:43:54 -03002149- "io-status": I/O operation status, only present if the device supports it
2150 and the VM is configured to stop on errors. It's always reset
2151 to "ok" when the "cont" command is issued (json_string, optional)
2152 - Possible values: "ok", "failed", "nospace"
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002153
2154Example:
2155
2156-> { "execute": "query-block" }
2157<- {
2158 "return":[
2159 {
Luiz Capitulinof04ef602011-09-26 17:43:54 -03002160 "io-status": "ok",
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002161 "device":"ide0-hd0",
2162 "locked":false,
2163 "removable":false,
2164 "inserted":{
2165 "ro":false,
2166 "drv":"qcow2",
2167 "encrypted":false,
Wenchao Xia553a7e82013-06-06 12:27:59 +08002168 "file":"disks/test.qcow2",
2169 "backing_file_depth":1,
Zhi Yong Wu727f0052011-11-08 13:00:31 +08002170 "bps":1000000,
2171 "bps_rd":0,
2172 "bps_wr":0,
2173 "iops":1000000,
2174 "iops_rd":0,
2175 "iops_wr":0,
Benoît Canet3e9fab62013-09-02 14:14:40 +02002176 "bps_max": 8000000,
2177 "bps_rd_max": 0,
2178 "bps_wr_max": 0,
2179 "iops_max": 0,
2180 "iops_rd_max": 0,
2181 "iops_wr_max": 0,
Benoît Canet2024c1d2013-09-02 14:14:41 +02002182 "iops_size": 0,
Peter Lieven465bee12014-05-18 00:58:19 +02002183 "detect_zeroes": "on",
Wenchao Xia553a7e82013-06-06 12:27:59 +08002184 "image":{
2185 "filename":"disks/test.qcow2",
2186 "format":"qcow2",
2187 "virtual-size":2048000,
2188 "backing_file":"base.qcow2",
2189 "full-backing-filename":"disks/base.qcow2",
2190 "backing-filename-format:"qcow2",
2191 "snapshots":[
2192 {
2193 "id": "1",
2194 "name": "snapshot1",
2195 "vm-state-size": 0,
2196 "date-sec": 10000200,
2197 "date-nsec": 12,
2198 "vm-clock-sec": 206,
2199 "vm-clock-nsec": 30
2200 }
2201 ],
2202 "backing-image":{
2203 "filename":"disks/base.qcow2",
2204 "format":"qcow2",
2205 "virtual-size":2048000
2206 }
2207 }
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002208 },
Markus Armbrusterd8aeeb32011-05-16 15:04:55 +02002209 "type":"unknown"
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002210 },
2211 {
Luiz Capitulinof04ef602011-09-26 17:43:54 -03002212 "io-status": "ok",
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002213 "device":"ide1-cd0",
2214 "locked":false,
2215 "removable":true,
Markus Armbrusterd8aeeb32011-05-16 15:04:55 +02002216 "type":"unknown"
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002217 },
2218 {
2219 "device":"floppy0",
2220 "locked":false,
2221 "removable":true,
Markus Armbrusterd8aeeb32011-05-16 15:04:55 +02002222 "type":"unknown"
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002223 },
2224 {
2225 "device":"sd0",
2226 "locked":false,
2227 "removable":true,
Markus Armbrusterd8aeeb32011-05-16 15:04:55 +02002228 "type":"unknown"
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002229 }
2230 ]
2231 }
2232
2233EQMP
2234
Luiz Capitulinob2023812011-09-21 17:16:47 -03002235 {
2236 .name = "query-block",
2237 .args_type = "",
2238 .mhandler.cmd_new = qmp_marshal_input_query_block,
2239 },
2240
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002241SQMP
2242query-blockstats
2243----------------
2244
2245Show block device statistics.
2246
2247Each device statistic information is stored in a json-object and the returned
2248value is a json-array of all devices.
2249
2250Each json-object contain the following:
2251
2252- "device": device name (json-string)
2253- "stats": A json-object with the statistics information, it contains:
2254 - "rd_bytes": bytes read (json-int)
2255 - "wr_bytes": bytes written (json-int)
2256 - "rd_operations": read operations (json-int)
2257 - "wr_operations": write operations (json-int)
Christoph Hellwige8045d62011-08-22 00:25:58 +02002258 - "flush_operations": cache flush operations (json-int)
Christoph Hellwigc488c7f2011-08-25 08:26:10 +02002259 - "wr_total_time_ns": total time spend on writes in nano-seconds (json-int)
2260 - "rd_total_time_ns": total time spend on reads in nano-seconds (json-int)
2261 - "flush_total_time_ns": total time spend on cache flushes in nano-seconds (json-int)
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002262 - "wr_highest_offset": Highest offset of a sector written since the
2263 BlockDriverState has been opened (json-int)
2264- "parent": Contains recursively the statistics of the underlying
2265 protocol (e.g. the host file for a qcow2 image). If there is
2266 no underlying protocol, this field is omitted
2267 (json-object, optional)
2268
2269Example:
2270
2271-> { "execute": "query-blockstats" }
2272<- {
2273 "return":[
2274 {
2275 "device":"ide0-hd0",
2276 "parent":{
2277 "stats":{
2278 "wr_highest_offset":3686448128,
2279 "wr_bytes":9786368,
2280 "wr_operations":751,
2281 "rd_bytes":122567168,
2282 "rd_operations":36772
Christoph Hellwigc488c7f2011-08-25 08:26:10 +02002283 "wr_total_times_ns":313253456
2284 "rd_total_times_ns":3465673657
2285 "flush_total_times_ns":49653
Christoph Hellwige8045d62011-08-22 00:25:58 +02002286 "flush_operations":61,
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002287 }
2288 },
2289 "stats":{
2290 "wr_highest_offset":2821110784,
2291 "wr_bytes":9786368,
2292 "wr_operations":692,
2293 "rd_bytes":122739200,
2294 "rd_operations":36604
Christoph Hellwige8045d62011-08-22 00:25:58 +02002295 "flush_operations":51,
Christoph Hellwigc488c7f2011-08-25 08:26:10 +02002296 "wr_total_times_ns":313253456
2297 "rd_total_times_ns":3465673657
2298 "flush_total_times_ns":49653
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002299 }
2300 },
2301 {
2302 "device":"ide1-cd0",
2303 "stats":{
2304 "wr_highest_offset":0,
2305 "wr_bytes":0,
2306 "wr_operations":0,
2307 "rd_bytes":0,
2308 "rd_operations":0
Christoph Hellwige8045d62011-08-22 00:25:58 +02002309 "flush_operations":0,
Christoph Hellwigc488c7f2011-08-25 08:26:10 +02002310 "wr_total_times_ns":0
2311 "rd_total_times_ns":0
2312 "flush_total_times_ns":0
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002313 }
2314 },
2315 {
2316 "device":"floppy0",
2317 "stats":{
2318 "wr_highest_offset":0,
2319 "wr_bytes":0,
2320 "wr_operations":0,
2321 "rd_bytes":0,
2322 "rd_operations":0
Christoph Hellwige8045d62011-08-22 00:25:58 +02002323 "flush_operations":0,
Christoph Hellwigc488c7f2011-08-25 08:26:10 +02002324 "wr_total_times_ns":0
2325 "rd_total_times_ns":0
2326 "flush_total_times_ns":0
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002327 }
2328 },
2329 {
2330 "device":"sd0",
2331 "stats":{
2332 "wr_highest_offset":0,
2333 "wr_bytes":0,
2334 "wr_operations":0,
2335 "rd_bytes":0,
2336 "rd_operations":0
Christoph Hellwige8045d62011-08-22 00:25:58 +02002337 "flush_operations":0,
Christoph Hellwigc488c7f2011-08-25 08:26:10 +02002338 "wr_total_times_ns":0
2339 "rd_total_times_ns":0
2340 "flush_total_times_ns":0
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002341 }
2342 }
2343 ]
2344 }
2345
2346EQMP
2347
Luiz Capitulinof11f57e2011-09-22 15:56:36 -03002348 {
2349 .name = "query-blockstats",
2350 .args_type = "",
2351 .mhandler.cmd_new = qmp_marshal_input_query_blockstats,
2352 },
2353
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002354SQMP
2355query-cpus
2356----------
2357
2358Show CPU information.
2359
2360Return a json-array. Each CPU is represented by a json-object, which contains:
2361
2362- "CPU": CPU index (json-int)
2363- "current": true if this is the current CPU, false otherwise (json-bool)
2364- "halted": true if the cpu is halted, false otherwise (json-bool)
2365- Current program counter. The key's name depends on the architecture:
2366 "pc": i386/x86_64 (json-int)
2367 "nip": PPC (json-int)
2368 "pc" and "npc": sparc (json-int)
2369 "PC": mips (json-int)
Jan Kiszkadc7a09c2011-03-15 12:26:31 +01002370- "thread_id": ID of the underlying host thread (json-int)
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002371
2372Example:
2373
2374-> { "execute": "query-cpus" }
2375<- {
2376 "return":[
2377 {
2378 "CPU":0,
2379 "current":true,
2380 "halted":false,
2381 "pc":3227107138
Jan Kiszkadc7a09c2011-03-15 12:26:31 +01002382 "thread_id":3134
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002383 },
2384 {
2385 "CPU":1,
2386 "current":false,
2387 "halted":true,
2388 "pc":7108165
Jan Kiszkadc7a09c2011-03-15 12:26:31 +01002389 "thread_id":3135
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002390 }
2391 ]
2392 }
2393
2394EQMP
2395
Luiz Capitulinode0b36b2011-09-21 16:38:35 -03002396 {
2397 .name = "query-cpus",
2398 .args_type = "",
2399 .mhandler.cmd_new = qmp_marshal_input_query_cpus,
2400 },
2401
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002402SQMP
Stefan Hajnoczidc3dd0d2014-02-27 11:48:42 +01002403query-iothreads
2404---------------
2405
2406Returns a list of information about each iothread.
2407
2408Note this list excludes the QEMU main loop thread, which is not declared
2409using the -object iothread command-line option. It is always the main thread
2410of the process.
2411
2412Return a json-array. Each iothread is represented by a json-object, which contains:
2413
2414- "id": name of iothread (json-str)
2415- "thread-id": ID of the underlying host thread (json-int)
2416
2417Example:
2418
2419-> { "execute": "query-iothreads" }
2420<- {
2421 "return":[
2422 {
2423 "id":"iothread0",
2424 "thread-id":3134
2425 },
2426 {
2427 "id":"iothread1",
2428 "thread-id":3135
2429 }
2430 ]
2431 }
2432
2433EQMP
2434
2435 {
2436 .name = "query-iothreads",
2437 .args_type = "",
2438 .mhandler.cmd_new = qmp_marshal_input_query_iothreads,
2439 },
2440
2441SQMP
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002442query-pci
2443---------
2444
2445PCI buses and devices information.
2446
2447The returned value is a json-array of all buses. Each bus is represented by
2448a json-object, which has a key with a json-array of all PCI devices attached
2449to it. Each device is represented by a json-object.
2450
2451The bus json-object contains the following:
2452
2453- "bus": bus number (json-int)
2454- "devices": a json-array of json-objects, each json-object represents a
2455 PCI device
2456
2457The PCI device json-object contains the following:
2458
2459- "bus": identical to the parent's bus number (json-int)
2460- "slot": slot number (json-int)
2461- "function": function number (json-int)
2462- "class_info": a json-object containing:
2463 - "desc": device class description (json-string, optional)
2464 - "class": device class number (json-int)
2465- "id": a json-object containing:
2466 - "device": device ID (json-int)
2467 - "vendor": vendor ID (json-int)
2468- "irq": device's IRQ if assigned (json-int, optional)
2469- "qdev_id": qdev id string (json-string)
2470- "pci_bridge": It's a json-object, only present if this device is a
2471 PCI bridge, contains:
2472 - "bus": bus number (json-int)
2473 - "secondary": secondary bus number (json-int)
2474 - "subordinate": subordinate bus number (json-int)
2475 - "io_range": I/O memory range information, a json-object with the
2476 following members:
2477 - "base": base address, in bytes (json-int)
2478 - "limit": limit address, in bytes (json-int)
2479 - "memory_range": memory range information, a json-object with the
2480 following members:
2481 - "base": base address, in bytes (json-int)
2482 - "limit": limit address, in bytes (json-int)
2483 - "prefetchable_range": Prefetchable memory range information, a
2484 json-object with the following members:
2485 - "base": base address, in bytes (json-int)
2486 - "limit": limit address, in bytes (json-int)
2487 - "devices": a json-array of PCI devices if there's any attached, each
2488 each element is represented by a json-object, which contains
2489 the same members of the 'PCI device json-object' described
2490 above (optional)
2491- "regions": a json-array of json-objects, each json-object represents a
2492 memory region of this device
2493
2494The memory range json-object contains the following:
2495
2496- "base": base memory address (json-int)
2497- "limit": limit value (json-int)
2498
2499The region json-object can be an I/O region or a memory region, an I/O region
2500json-object contains the following:
2501
2502- "type": "io" (json-string, fixed)
2503- "bar": BAR number (json-int)
2504- "address": memory address (json-int)
2505- "size": memory size (json-int)
2506
2507A memory region json-object contains the following:
2508
2509- "type": "memory" (json-string, fixed)
2510- "bar": BAR number (json-int)
2511- "address": memory address (json-int)
2512- "size": memory size (json-int)
2513- "mem_type_64": true or false (json-bool)
2514- "prefetch": true or false (json-bool)
2515
2516Example:
2517
2518-> { "execute": "query-pci" }
2519<- {
2520 "return":[
2521 {
2522 "bus":0,
2523 "devices":[
2524 {
2525 "bus":0,
2526 "qdev_id":"",
2527 "slot":0,
2528 "class_info":{
2529 "class":1536,
2530 "desc":"Host bridge"
2531 },
2532 "id":{
2533 "device":32902,
2534 "vendor":4663
2535 },
2536 "function":0,
2537 "regions":[
2538
2539 ]
2540 },
2541 {
2542 "bus":0,
2543 "qdev_id":"",
2544 "slot":1,
2545 "class_info":{
2546 "class":1537,
2547 "desc":"ISA bridge"
2548 },
2549 "id":{
2550 "device":32902,
2551 "vendor":28672
2552 },
2553 "function":0,
2554 "regions":[
2555
2556 ]
2557 },
2558 {
2559 "bus":0,
2560 "qdev_id":"",
2561 "slot":1,
2562 "class_info":{
2563 "class":257,
2564 "desc":"IDE controller"
2565 },
2566 "id":{
2567 "device":32902,
2568 "vendor":28688
2569 },
2570 "function":1,
2571 "regions":[
2572 {
2573 "bar":4,
2574 "size":16,
2575 "address":49152,
2576 "type":"io"
2577 }
2578 ]
2579 },
2580 {
2581 "bus":0,
2582 "qdev_id":"",
2583 "slot":2,
2584 "class_info":{
2585 "class":768,
2586 "desc":"VGA controller"
2587 },
2588 "id":{
2589 "device":4115,
2590 "vendor":184
2591 },
2592 "function":0,
2593 "regions":[
2594 {
2595 "prefetch":true,
2596 "mem_type_64":false,
2597 "bar":0,
2598 "size":33554432,
2599 "address":4026531840,
2600 "type":"memory"
2601 },
2602 {
2603 "prefetch":false,
2604 "mem_type_64":false,
2605 "bar":1,
2606 "size":4096,
2607 "address":4060086272,
2608 "type":"memory"
2609 },
2610 {
2611 "prefetch":false,
2612 "mem_type_64":false,
2613 "bar":6,
2614 "size":65536,
2615 "address":-1,
2616 "type":"memory"
2617 }
2618 ]
2619 },
2620 {
2621 "bus":0,
2622 "qdev_id":"",
2623 "irq":11,
2624 "slot":4,
2625 "class_info":{
2626 "class":1280,
2627 "desc":"RAM controller"
2628 },
2629 "id":{
2630 "device":6900,
2631 "vendor":4098
2632 },
2633 "function":0,
2634 "regions":[
2635 {
2636 "bar":0,
2637 "size":32,
2638 "address":49280,
2639 "type":"io"
2640 }
2641 ]
2642 }
2643 ]
2644 }
2645 ]
2646 }
2647
2648Note: This example has been shortened as the real response is too long.
2649
2650EQMP
2651
Luiz Capitulino79627472011-10-21 14:15:33 -02002652 {
2653 .name = "query-pci",
2654 .args_type = "",
2655 .mhandler.cmd_new = qmp_marshal_input_query_pci,
2656 },
2657
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002658SQMP
2659query-kvm
2660---------
2661
2662Show KVM information.
2663
2664Return a json-object with the following information:
2665
2666- "enabled": true if KVM support is enabled, false otherwise (json-bool)
2667- "present": true if QEMU has KVM support, false otherwise (json-bool)
2668
2669Example:
2670
2671-> { "execute": "query-kvm" }
2672<- { "return": { "enabled": true, "present": true } }
2673
2674EQMP
2675
Luiz Capitulino292a2602011-09-12 15:10:53 -03002676 {
2677 .name = "query-kvm",
2678 .args_type = "",
2679 .mhandler.cmd_new = qmp_marshal_input_query_kvm,
2680 },
2681
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002682SQMP
2683query-status
2684------------
2685
2686Return a json-object with the following information:
2687
2688- "running": true if the VM is running, or false if it is paused (json-bool)
2689- "singlestep": true if the VM is in single step mode,
2690 false otherwise (json-bool)
Luiz Capitulino9e37b9d2011-08-29 16:02:57 -03002691- "status": one of the following values (json-string)
2692 "debug" - QEMU is running on a debugger
2693 "inmigrate" - guest is paused waiting for an incoming migration
2694 "internal-error" - An internal error that prevents further guest
2695 execution has occurred
2696 "io-error" - the last IOP has failed and the device is configured
2697 to pause on I/O errors
2698 "paused" - guest has been paused via the 'stop' command
2699 "postmigrate" - guest is paused following a successful 'migrate'
2700 "prelaunch" - QEMU was started with -S and guest has not started
2701 "finish-migrate" - guest is paused to finish the migration process
2702 "restore-vm" - guest is paused to restore VM state
2703 "running" - guest is actively running
2704 "save-vm" - guest is paused to save the VM state
2705 "shutdown" - guest is shut down (and -no-shutdown is in use)
2706 "watchdog" - the watchdog action is configured to pause and
2707 has been triggered
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002708
2709Example:
2710
2711-> { "execute": "query-status" }
Luiz Capitulino9e37b9d2011-08-29 16:02:57 -03002712<- { "return": { "running": true, "singlestep": false, "status": "running" } }
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002713
2714EQMP
Luiz Capitulino1fa9a5e2011-09-12 17:54:20 -03002715
2716 {
2717 .name = "query-status",
2718 .args_type = "",
2719 .mhandler.cmd_new = qmp_marshal_input_query_status,
2720 },
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002721
2722SQMP
2723query-mice
2724----------
2725
2726Show VM mice information.
2727
2728Each mouse is represented by a json-object, the returned value is a json-array
2729of all mice.
2730
2731The mouse json-object contains the following:
2732
2733- "name": mouse's name (json-string)
2734- "index": mouse's index (json-int)
2735- "current": true if this mouse is receiving events, false otherwise (json-bool)
2736- "absolute": true if the mouse generates absolute input events (json-bool)
2737
2738Example:
2739
2740-> { "execute": "query-mice" }
2741<- {
2742 "return":[
2743 {
2744 "name":"QEMU Microsoft Mouse",
2745 "index":0,
2746 "current":false,
2747 "absolute":false
2748 },
2749 {
2750 "name":"QEMU PS/2 Mouse",
2751 "index":1,
2752 "current":true,
2753 "absolute":true
2754 }
2755 ]
2756 }
2757
2758EQMP
2759
Luiz Capitulinoe235cec2011-09-21 15:29:55 -03002760 {
2761 .name = "query-mice",
2762 .args_type = "",
2763 .mhandler.cmd_new = qmp_marshal_input_query_mice,
2764 },
2765
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002766SQMP
2767query-vnc
2768---------
2769
2770Show VNC server information.
2771
2772Return a json-object with server information. Connected clients are returned
2773as a json-array of json-objects.
2774
2775The main json-object contains the following:
2776
2777- "enabled": true or false (json-bool)
2778- "host": server's IP address (json-string)
2779- "family": address family (json-string)
2780 - Possible values: "ipv4", "ipv6", "unix", "unknown"
2781- "service": server's port number (json-string)
2782- "auth": authentication method (json-string)
2783 - Possible values: "invalid", "none", "ra2", "ra2ne", "sasl", "tight",
2784 "tls", "ultra", "unknown", "vencrypt", "vencrypt",
2785 "vencrypt+plain", "vencrypt+tls+none",
2786 "vencrypt+tls+plain", "vencrypt+tls+sasl",
2787 "vencrypt+tls+vnc", "vencrypt+x509+none",
2788 "vencrypt+x509+plain", "vencrypt+x509+sasl",
2789 "vencrypt+x509+vnc", "vnc"
2790- "clients": a json-array of all connected clients
2791
2792Clients are described by a json-object, each one contain the following:
2793
2794- "host": client's IP address (json-string)
2795- "family": address family (json-string)
2796 - Possible values: "ipv4", "ipv6", "unix", "unknown"
2797- "service": client's port number (json-string)
2798- "x509_dname": TLS dname (json-string, optional)
2799- "sasl_username": SASL username (json-string, optional)
2800
2801Example:
2802
2803-> { "execute": "query-vnc" }
2804<- {
2805 "return":{
2806 "enabled":true,
2807 "host":"0.0.0.0",
2808 "service":"50402",
2809 "auth":"vnc",
2810 "family":"ipv4",
2811 "clients":[
2812 {
2813 "host":"127.0.0.1",
2814 "service":"50401",
2815 "family":"ipv4"
2816 }
2817 ]
2818 }
2819 }
2820
2821EQMP
2822
Luiz Capitulino2b54aa82011-10-17 16:41:22 -02002823 {
2824 .name = "query-vnc",
2825 .args_type = "",
2826 .mhandler.cmd_new = qmp_marshal_input_query_vnc,
2827 },
2828
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002829SQMP
Gerd Hoffmanncb42a872010-11-30 11:02:51 +01002830query-spice
2831-----------
2832
2833Show SPICE server information.
2834
2835Return a json-object with server information. Connected clients are returned
2836as a json-array of json-objects.
2837
2838The main json-object contains the following:
2839
2840- "enabled": true or false (json-bool)
2841- "host": server's IP address (json-string)
2842- "port": server's port number (json-int, optional)
2843- "tls-port": server's port number (json-int, optional)
2844- "auth": authentication method (json-string)
2845 - Possible values: "none", "spice"
2846- "channels": a json-array of all active channels clients
2847
2848Channels are described by a json-object, each one contain the following:
2849
2850- "host": client's IP address (json-string)
2851- "family": address family (json-string)
2852 - Possible values: "ipv4", "ipv6", "unix", "unknown"
2853- "port": client's port number (json-string)
2854- "connection-id": spice connection id. All channels with the same id
2855 belong to the same spice session (json-int)
2856- "channel-type": channel type. "1" is the main control channel, filter for
2857 this one if you want track spice sessions only (json-int)
2858- "channel-id": channel id. Usually "0", might be different needed when
2859 multiple channels of the same type exist, such as multiple
2860 display channels in a multihead setup (json-int)
2861- "tls": whevener the channel is encrypted (json-bool)
2862
2863Example:
2864
2865-> { "execute": "query-spice" }
2866<- {
2867 "return": {
2868 "enabled": true,
2869 "auth": "spice",
2870 "port": 5920,
2871 "tls-port": 5921,
2872 "host": "0.0.0.0",
2873 "channels": [
2874 {
2875 "port": "54924",
2876 "family": "ipv4",
2877 "channel-type": 1,
2878 "connection-id": 1804289383,
2879 "host": "127.0.0.1",
2880 "channel-id": 0,
2881 "tls": true
2882 },
2883 {
2884 "port": "36710",
2885 "family": "ipv4",
2886 "channel-type": 4,
2887 "connection-id": 1804289383,
2888 "host": "127.0.0.1",
2889 "channel-id": 0,
2890 "tls": false
2891 },
2892 [ ... more channels follow ... ]
2893 ]
2894 }
2895 }
2896
2897EQMP
2898
Luiz Capitulinod1f29642011-10-20 17:01:33 -02002899#if defined(CONFIG_SPICE)
2900 {
2901 .name = "query-spice",
2902 .args_type = "",
2903 .mhandler.cmd_new = qmp_marshal_input_query_spice,
2904 },
2905#endif
2906
Gerd Hoffmanncb42a872010-11-30 11:02:51 +01002907SQMP
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002908query-name
2909----------
2910
2911Show VM name.
2912
2913Return a json-object with the following information:
2914
2915- "name": VM's name (json-string, optional)
2916
2917Example:
2918
2919-> { "execute": "query-name" }
2920<- { "return": { "name": "qemu-name" } }
2921
2922EQMP
2923
Anthony Liguori48a32be2011-09-02 12:34:48 -05002924 {
2925 .name = "query-name",
2926 .args_type = "",
2927 .mhandler.cmd_new = qmp_marshal_input_query_name,
2928 },
2929
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002930SQMP
2931query-uuid
2932----------
2933
2934Show VM UUID.
2935
2936Return a json-object with the following information:
2937
2938- "UUID": Universally Unique Identifier (json-string)
2939
2940Example:
2941
2942-> { "execute": "query-uuid" }
2943<- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } }
2944
2945EQMP
2946
Luiz Capitulinoefab7672011-09-13 17:16:25 -03002947 {
2948 .name = "query-uuid",
2949 .args_type = "",
2950 .mhandler.cmd_new = qmp_marshal_input_query_uuid,
2951 },
2952
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002953SQMP
Amos Kong1f8f9872013-04-25 17:50:35 +08002954query-command-line-options
2955--------------------------
2956
2957Show command line option schema.
2958
2959Return a json-array of command line option schema for all options (or for
2960the given option), returning an error if the given option doesn't exist.
2961
2962Each array entry contains the following:
2963
2964- "option": option name (json-string)
2965- "parameters": a json-array describes all parameters of the option:
2966 - "name": parameter name (json-string)
2967 - "type": parameter type (one of 'string', 'boolean', 'number',
2968 or 'size')
2969 - "help": human readable description of the parameter
2970 (json-string, optional)
Chunyan Liue36af942014-06-05 17:20:43 +08002971 - "default": default value string for the parameter
2972 (json-string, optional)
Amos Kong1f8f9872013-04-25 17:50:35 +08002973
2974Example:
2975
2976-> { "execute": "query-command-line-options", "arguments": { "option": "option-rom" } }
2977<- { "return": [
2978 {
2979 "parameters": [
2980 {
2981 "name": "romfile",
2982 "type": "string"
2983 },
2984 {
2985 "name": "bootindex",
2986 "type": "number"
2987 }
2988 ],
2989 "option": "option-rom"
2990 }
2991 ]
2992 }
2993
2994EQMP
2995
2996 {
2997 .name = "query-command-line-options",
2998 .args_type = "option:s?",
2999 .mhandler.cmd_new = qmp_marshal_input_query_command_line_options,
3000 },
3001
3002SQMP
Luiz Capitulino82a56f02010-09-13 12:26:00 -03003003query-migrate
3004-------------
3005
3006Migration status.
3007
3008Return a json-object. If migration is active there will be another json-object
3009with RAM migration status and if block migration is active another one with
3010block migration status.
3011
3012The main json-object contains the following:
3013
3014- "status": migration status (json-string)
Peter Feiner3b695952014-05-16 10:40:47 -04003015 - Possible values: "setup", "active", "completed", "failed", "cancelled"
Juan Quintela7aa939a2012-08-18 13:17:10 +02003016- "total-time": total amount of ms since migration started. If
3017 migration has ended, it returns the total migration
Juan Quintela817c6042013-02-11 15:11:10 +01003018 time (json-int)
Michael R. Hines8f3067b2013-08-09 16:05:45 -04003019- "setup-time" amount of setup time in milliseconds _before_ the
3020 iterations begin but _after_ the QMP command is issued.
3021 This is designed to provide an accounting of any activities
3022 (such as RDMA pinning) which may be expensive, but do not
3023 actually occur during the iterative migration rounds
3024 themselves. (json-int)
Juan Quintela9c5a9fc2012-08-13 09:35:16 +02003025- "downtime": only present when migration has finished correctly
3026 total amount in ms for downtime that happened (json-int)
Juan Quintela2c52ddf2012-08-13 09:53:12 +02003027- "expected-downtime": only present while migration is active
3028 total amount in ms for downtime that was calculated on
Juan Quintela817c6042013-02-11 15:11:10 +01003029 the last bitmap round (json-int)
Luiz Capitulino82a56f02010-09-13 12:26:00 -03003030- "ram": only present if "status" is "active", it is a json-object with the
Juan Quintela817c6042013-02-11 15:11:10 +01003031 following RAM information:
3032 - "transferred": amount transferred in bytes (json-int)
3033 - "remaining": amount remaining to transfer in bytes (json-int)
3034 - "total": total amount of memory in bytes (json-int)
3035 - "duplicate": number of pages filled entirely with the same
3036 byte (json-int)
3037 These are sent over the wire much more efficiently.
Peter Lievenf1c72792013-03-26 10:58:37 +01003038 - "skipped": number of skipped zero pages (json-int)
Stefan Weil805a2502013-04-28 11:49:57 +02003039 - "normal" : number of whole pages transferred. I.e. they
Juan Quintela817c6042013-02-11 15:11:10 +01003040 were not sent as duplicate or xbzrle pages (json-int)
3041 - "normal-bytes" : number of bytes transferred in whole
3042 pages. This is just normal pages times size of one page,
3043 but this way upper levels don't need to care about page
3044 size (json-int)
ChenLiang58570ed2014-04-04 17:57:55 +08003045 - "dirty-sync-count": times that dirty ram was synchronized (json-int)
Luiz Capitulino82a56f02010-09-13 12:26:00 -03003046- "disk": only present if "status" is "active" and it is a block migration,
Juan Quintela817c6042013-02-11 15:11:10 +01003047 it is a json-object with the following disk information:
3048 - "transferred": amount transferred in bytes (json-int)
3049 - "remaining": amount remaining to transfer in bytes json-int)
3050 - "total": total disk size in bytes (json-int)
Orit Wassermanf36d55a2012-08-06 21:42:57 +03003051- "xbzrle-cache": only present if XBZRLE is active.
3052 It is a json-object with the following XBZRLE information:
Juan Quintela817c6042013-02-11 15:11:10 +01003053 - "cache-size": XBZRLE cache size in bytes
3054 - "bytes": number of bytes transferred for XBZRLE compressed pages
Orit Wassermanf36d55a2012-08-06 21:42:57 +03003055 - "pages": number of XBZRLE compressed pages
Juan Quintela817c6042013-02-11 15:11:10 +01003056 - "cache-miss": number of XBRZRLE page cache misses
ChenLiang8bc39232014-04-04 17:57:56 +08003057 - "cache-miss-rate": rate of XBRZRLE page cache misses
Juan Quintela817c6042013-02-11 15:11:10 +01003058 - "overflow": number of times XBZRLE overflows. This means
3059 that the XBZRLE encoding was bigger than just sent the
3060 whole page, and then we sent the whole page instead (as as
3061 normal page).
3062
Luiz Capitulino82a56f02010-09-13 12:26:00 -03003063Examples:
3064
30651. Before the first migration
3066
3067-> { "execute": "query-migrate" }
3068<- { "return": {} }
3069
30702. Migration is done and has succeeded
3071
3072-> { "execute": "query-migrate" }
Orit Wasserman004d4c12012-08-06 21:42:56 +03003073<- { "return": {
3074 "status": "completed",
3075 "ram":{
3076 "transferred":123,
3077 "remaining":123,
3078 "total":246,
3079 "total-time":12345,
Michael R. Hines8f3067b2013-08-09 16:05:45 -04003080 "setup-time":12345,
Juan Quintela9c5a9fc2012-08-13 09:35:16 +02003081 "downtime":12345,
Orit Wasserman004d4c12012-08-06 21:42:56 +03003082 "duplicate":123,
3083 "normal":123,
ChenLiang58570ed2014-04-04 17:57:55 +08003084 "normal-bytes":123456,
3085 "dirty-sync-count":15
Orit Wasserman004d4c12012-08-06 21:42:56 +03003086 }
3087 }
3088 }
Luiz Capitulino82a56f02010-09-13 12:26:00 -03003089
30903. Migration is done and has failed
3091
3092-> { "execute": "query-migrate" }
3093<- { "return": { "status": "failed" } }
3094
30954. Migration is being performed and is not a block migration:
3096
3097-> { "execute": "query-migrate" }
3098<- {
3099 "return":{
3100 "status":"active",
3101 "ram":{
3102 "transferred":123,
3103 "remaining":123,
Orit Wasserman62d4e3f2012-08-06 21:42:55 +03003104 "total":246,
Orit Wasserman004d4c12012-08-06 21:42:56 +03003105 "total-time":12345,
Michael R. Hines8f3067b2013-08-09 16:05:45 -04003106 "setup-time":12345,
Juan Quintela2c52ddf2012-08-13 09:53:12 +02003107 "expected-downtime":12345,
Orit Wasserman004d4c12012-08-06 21:42:56 +03003108 "duplicate":123,
3109 "normal":123,
ChenLiang58570ed2014-04-04 17:57:55 +08003110 "normal-bytes":123456,
3111 "dirty-sync-count":15
Luiz Capitulino82a56f02010-09-13 12:26:00 -03003112 }
3113 }
3114 }
3115
31165. Migration is being performed and is a block migration:
3117
3118-> { "execute": "query-migrate" }
3119<- {
3120 "return":{
3121 "status":"active",
3122 "ram":{
3123 "total":1057024,
3124 "remaining":1053304,
Orit Wasserman62d4e3f2012-08-06 21:42:55 +03003125 "transferred":3720,
Orit Wasserman004d4c12012-08-06 21:42:56 +03003126 "total-time":12345,
Michael R. Hines8f3067b2013-08-09 16:05:45 -04003127 "setup-time":12345,
Juan Quintela2c52ddf2012-08-13 09:53:12 +02003128 "expected-downtime":12345,
Orit Wasserman004d4c12012-08-06 21:42:56 +03003129 "duplicate":123,
3130 "normal":123,
ChenLiang58570ed2014-04-04 17:57:55 +08003131 "normal-bytes":123456,
3132 "dirty-sync-count":15
Luiz Capitulino82a56f02010-09-13 12:26:00 -03003133 },
3134 "disk":{
3135 "total":20971520,
3136 "remaining":20880384,
3137 "transferred":91136
3138 }
3139 }
3140 }
3141
Orit Wassermanf36d55a2012-08-06 21:42:57 +030031426. Migration is being performed and XBZRLE is active:
3143
3144-> { "execute": "query-migrate" }
3145<- {
3146 "return":{
3147 "status":"active",
3148 "capabilities" : [ { "capability": "xbzrle", "state" : true } ],
3149 "ram":{
3150 "total":1057024,
3151 "remaining":1053304,
3152 "transferred":3720,
3153 "total-time":12345,
Michael R. Hines8f3067b2013-08-09 16:05:45 -04003154 "setup-time":12345,
Juan Quintela2c52ddf2012-08-13 09:53:12 +02003155 "expected-downtime":12345,
Orit Wassermanf36d55a2012-08-06 21:42:57 +03003156 "duplicate":10,
3157 "normal":3333,
ChenLiang58570ed2014-04-04 17:57:55 +08003158 "normal-bytes":3412992,
3159 "dirty-sync-count":15
Orit Wassermanf36d55a2012-08-06 21:42:57 +03003160 },
3161 "xbzrle-cache":{
3162 "cache-size":67108864,
3163 "bytes":20971520,
3164 "pages":2444343,
3165 "cache-miss":2244,
ChenLiang8bc39232014-04-04 17:57:56 +08003166 "cache-miss-rate":0.123,
Orit Wassermanf36d55a2012-08-06 21:42:57 +03003167 "overflow":34434
3168 }
3169 }
3170 }
3171
Luiz Capitulino82a56f02010-09-13 12:26:00 -03003172EQMP
3173
Luiz Capitulino791e7c82011-09-13 17:37:16 -03003174 {
3175 .name = "query-migrate",
3176 .args_type = "",
3177 .mhandler.cmd_new = qmp_marshal_input_query_migrate,
3178 },
3179
Luiz Capitulino82a56f02010-09-13 12:26:00 -03003180SQMP
Orit Wasserman00458432012-08-06 21:42:48 +03003181migrate-set-capabilities
Juan Quintela817c6042013-02-11 15:11:10 +01003182------------------------
Orit Wasserman00458432012-08-06 21:42:48 +03003183
3184Enable/Disable migration capabilities
3185
Juan Quintela817c6042013-02-11 15:11:10 +01003186- "xbzrle": XBZRLE support
Orit Wasserman00458432012-08-06 21:42:48 +03003187
3188Arguments:
3189
3190Example:
3191
3192-> { "execute": "migrate-set-capabilities" , "arguments":
3193 { "capabilities": [ { "capability": "xbzrle", "state": true } ] } }
3194
3195EQMP
3196
3197 {
3198 .name = "migrate-set-capabilities",
3199 .args_type = "capabilities:O",
3200 .params = "capability:s,state:b",
3201 .mhandler.cmd_new = qmp_marshal_input_migrate_set_capabilities,
3202 },
3203SQMP
Orit Wassermanbbf6da32012-08-06 21:42:47 +03003204query-migrate-capabilities
Juan Quintela817c6042013-02-11 15:11:10 +01003205--------------------------
Orit Wassermanbbf6da32012-08-06 21:42:47 +03003206
3207Query current migration capabilities
3208
3209- "capabilities": migration capabilities state
3210 - "xbzrle" : XBZRLE state (json-bool)
3211
3212Arguments:
3213
3214Example:
3215
3216-> { "execute": "query-migrate-capabilities" }
Orit Wassermandbca1b32013-01-31 09:12:17 +02003217<- { "return": [ { "state": false, "capability": "xbzrle" } ] }
3218
Orit Wassermanbbf6da32012-08-06 21:42:47 +03003219EQMP
3220
3221 {
3222 .name = "query-migrate-capabilities",
3223 .args_type = "",
3224 .mhandler.cmd_new = qmp_marshal_input_query_migrate_capabilities,
3225 },
3226
3227SQMP
Luiz Capitulino82a56f02010-09-13 12:26:00 -03003228query-balloon
3229-------------
3230
3231Show balloon information.
3232
3233Make an asynchronous request for balloon info. When the request completes a
3234json-object will be returned containing the following data:
3235
3236- "actual": current balloon value in bytes (json-int)
Luiz Capitulino82a56f02010-09-13 12:26:00 -03003237
3238Example:
3239
3240-> { "execute": "query-balloon" }
3241<- {
3242 "return":{
3243 "actual":1073741824,
Luiz Capitulino82a56f02010-09-13 12:26:00 -03003244 }
3245 }
3246
3247EQMP
3248
Luiz Capitulino96637bc2011-10-21 11:41:37 -02003249 {
3250 .name = "query-balloon",
3251 .args_type = "",
3252 .mhandler.cmd_new = qmp_marshal_input_query_balloon,
3253 },
Anthony Liguorib4b12c62011-12-12 14:29:34 -06003254
3255 {
Stefan Hajnoczifb5458c2012-01-18 14:40:49 +00003256 .name = "query-block-jobs",
3257 .args_type = "",
3258 .mhandler.cmd_new = qmp_marshal_input_query_block_jobs,
3259 },
3260
3261 {
Anthony Liguorib4b12c62011-12-12 14:29:34 -06003262 .name = "qom-list",
3263 .args_type = "path:s",
3264 .mhandler.cmd_new = qmp_marshal_input_qom_list,
3265 },
Anthony Liguorieb6e8ea2011-12-12 14:29:35 -06003266
3267 {
3268 .name = "qom-set",
Paolo Bonzinib9f89782012-03-22 12:51:11 +01003269 .args_type = "path:s,property:s,value:q",
Anthony Liguorieb6e8ea2011-12-12 14:29:35 -06003270 .mhandler.cmd_new = qmp_qom_set,
3271 },
3272
3273 {
3274 .name = "qom-get",
3275 .args_type = "path:s,property:s",
3276 .mhandler.cmd_new = qmp_qom_get,
3277 },
Luiz Capitulino270b2432011-12-08 11:45:55 -02003278
3279 {
Paolo Bonzini6dd844d2012-08-22 16:43:07 +02003280 .name = "nbd-server-start",
3281 .args_type = "addr:q",
3282 .mhandler.cmd_new = qmp_marshal_input_nbd_server_start,
3283 },
3284 {
3285 .name = "nbd-server-add",
3286 .args_type = "device:B,writable:b?",
3287 .mhandler.cmd_new = qmp_marshal_input_nbd_server_add,
3288 },
3289 {
3290 .name = "nbd-server-stop",
3291 .args_type = "",
3292 .mhandler.cmd_new = qmp_marshal_input_nbd_server_stop,
3293 },
3294
3295 {
Luiz Capitulino270b2432011-12-08 11:45:55 -02003296 .name = "change-vnc-password",
3297 .args_type = "password:s",
3298 .mhandler.cmd_new = qmp_marshal_input_change_vnc_password,
3299 },
Anthony Liguori5eeee3f2011-12-22 14:40:54 -06003300 {
3301 .name = "qom-list-types",
3302 .args_type = "implements:s?,abstract:b?",
3303 .mhandler.cmd_new = qmp_marshal_input_qom_list_types,
3304 },
Anthony Liguori1daa31b2012-08-10 11:04:09 -05003305
3306 {
3307 .name = "device-list-properties",
3308 .args_type = "typename:s",
3309 .mhandler.cmd_new = qmp_marshal_input_device_list_properties,
3310 },
3311
Anthony Liguori01d3c802012-08-10 11:04:11 -05003312 {
3313 .name = "query-machines",
3314 .args_type = "",
3315 .mhandler.cmd_new = qmp_marshal_input_query_machines,
3316 },
3317
Anthony Liguorie4e31c62012-08-10 11:04:13 -05003318 {
3319 .name = "query-cpu-definitions",
3320 .args_type = "",
3321 .mhandler.cmd_new = qmp_marshal_input_query_cpu_definitions,
3322 },
3323
Daniel P. Berrange99afc912012-08-20 15:31:38 +01003324 {
3325 .name = "query-target",
3326 .args_type = "",
3327 .mhandler.cmd_new = qmp_marshal_input_query_target,
3328 },
Gerd Hoffmannf1a1a352012-12-19 10:33:56 +01003329
3330 {
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05003331 .name = "query-tpm",
3332 .args_type = "",
3333 .mhandler.cmd_new = qmp_marshal_input_query_tpm,
3334 },
3335
Corey Bryant28c4fa32013-03-20 12:34:49 -04003336SQMP
3337query-tpm
3338---------
3339
3340Return information about the TPM device.
3341
3342Arguments: None
3343
3344Example:
3345
3346-> { "execute": "query-tpm" }
3347<- { "return":
3348 [
3349 { "model": "tpm-tis",
3350 "options":
3351 { "type": "passthrough",
3352 "data":
3353 { "cancel-path": "/sys/class/misc/tpm0/device/cancel",
3354 "path": "/dev/tpm0"
3355 }
3356 },
3357 "id": "tpm0"
3358 }
3359 ]
3360 }
3361
3362EQMP
3363
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05003364 {
3365 .name = "query-tpm-models",
3366 .args_type = "",
3367 .mhandler.cmd_new = qmp_marshal_input_query_tpm_models,
3368 },
3369
Corey Bryant28c4fa32013-03-20 12:34:49 -04003370SQMP
3371query-tpm-models
3372----------------
3373
3374Return a list of supported TPM models.
3375
3376Arguments: None
3377
3378Example:
3379
3380-> { "execute": "query-tpm-models" }
3381<- { "return": [ "tpm-tis" ] }
3382
3383EQMP
3384
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05003385 {
3386 .name = "query-tpm-types",
3387 .args_type = "",
3388 .mhandler.cmd_new = qmp_marshal_input_query_tpm_types,
3389 },
3390
Corey Bryant28c4fa32013-03-20 12:34:49 -04003391SQMP
3392query-tpm-types
3393---------------
3394
3395Return a list of supported TPM types.
3396
3397Arguments: None
3398
3399Example:
3400
3401-> { "execute": "query-tpm-types" }
3402<- { "return": [ "passthrough" ] }
3403
3404EQMP
3405
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05003406 {
Gerd Hoffmannf1a1a352012-12-19 10:33:56 +01003407 .name = "chardev-add",
3408 .args_type = "id:s,backend:q",
3409 .mhandler.cmd_new = qmp_marshal_input_chardev_add,
3410 },
3411
3412SQMP
3413chardev-add
3414----------------
3415
3416Add a chardev.
3417
3418Arguments:
3419
3420- "id": the chardev's ID, must be unique (json-string)
3421- "backend": chardev backend type + parameters
3422
Gerd Hoffmannffbdbe52012-12-19 13:13:57 +01003423Examples:
Gerd Hoffmannf1a1a352012-12-19 10:33:56 +01003424
3425-> { "execute" : "chardev-add",
3426 "arguments" : { "id" : "foo",
3427 "backend" : { "type" : "null", "data" : {} } } }
3428<- { "return": {} }
3429
Gerd Hoffmannffbdbe52012-12-19 13:13:57 +01003430-> { "execute" : "chardev-add",
3431 "arguments" : { "id" : "bar",
3432 "backend" : { "type" : "file",
3433 "data" : { "out" : "/tmp/bar.log" } } } }
3434<- { "return": {} }
3435
Gerd Hoffmann0a1a7fa2012-12-20 14:39:13 +01003436-> { "execute" : "chardev-add",
3437 "arguments" : { "id" : "baz",
3438 "backend" : { "type" : "pty", "data" : {} } } }
3439<- { "return": { "pty" : "/dev/pty/42" } }
3440
Gerd Hoffmannf1a1a352012-12-19 10:33:56 +01003441EQMP
3442
3443 {
3444 .name = "chardev-remove",
3445 .args_type = "id:s",
3446 .mhandler.cmd_new = qmp_marshal_input_chardev_remove,
3447 },
3448
3449
3450SQMP
3451chardev-remove
3452--------------
3453
3454Remove a chardev.
3455
3456Arguments:
3457
3458- "id": the chardev's ID, must exist and not be in use (json-string)
3459
3460Example:
3461
3462-> { "execute": "chardev-remove", "arguments": { "id" : "foo" } }
3463<- { "return": {} }
3464
3465EQMP
Amos Kongb1be4282013-06-14 15:45:52 +08003466 {
3467 .name = "query-rx-filter",
3468 .args_type = "name:s?",
3469 .mhandler.cmd_new = qmp_marshal_input_query_rx_filter,
3470 },
3471
3472SQMP
3473query-rx-filter
3474---------------
3475
3476Show rx-filter information.
3477
3478Returns a json-array of rx-filter information for all NICs (or for the
3479given NIC), returning an error if the given NIC doesn't exist, or
3480given NIC doesn't support rx-filter querying, or given net client
3481isn't a NIC.
3482
3483The query will clear the event notification flag of each NIC, then qemu
3484will start to emit event to QMP monitor.
3485
3486Each array entry contains the following:
3487
3488- "name": net client name (json-string)
3489- "promiscuous": promiscuous mode is enabled (json-bool)
3490- "multicast": multicast receive state (one of 'normal', 'none', 'all')
3491- "unicast": unicast receive state (one of 'normal', 'none', 'all')
Amos Kongf7bc8ef2014-03-26 08:19:43 +08003492- "vlan": vlan receive state (one of 'normal', 'none', 'all') (Since 2.0)
Amos Kongb1be4282013-06-14 15:45:52 +08003493- "broadcast-allowed": allow to receive broadcast (json-bool)
3494- "multicast-overflow": multicast table is overflowed (json-bool)
3495- "unicast-overflow": unicast table is overflowed (json-bool)
3496- "main-mac": main macaddr string (json-string)
3497- "vlan-table": a json-array of active vlan id
3498- "unicast-table": a json-array of unicast macaddr string
3499- "multicast-table": a json-array of multicast macaddr string
3500
3501Example:
3502
3503-> { "execute": "query-rx-filter", "arguments": { "name": "vnet0" } }
3504<- { "return": [
3505 {
3506 "promiscuous": true,
3507 "name": "vnet0",
3508 "main-mac": "52:54:00:12:34:56",
3509 "unicast": "normal",
Amos Kongf7bc8ef2014-03-26 08:19:43 +08003510 "vlan": "normal",
Amos Kongb1be4282013-06-14 15:45:52 +08003511 "vlan-table": [
3512 4,
3513 0
3514 ],
3515 "unicast-table": [
3516 ],
3517 "multicast": "normal",
3518 "multicast-overflow": false,
3519 "unicast-overflow": false,
3520 "multicast-table": [
3521 "01:00:5e:00:00:01",
3522 "33:33:00:00:00:01",
3523 "33:33:ff:12:34:56"
3524 ],
3525 "broadcast-allowed": false
3526 }
3527 ]
3528 }
3529
3530EQMP
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003531
3532 {
3533 .name = "blockdev-add",
3534 .args_type = "options:q",
3535 .mhandler.cmd_new = qmp_marshal_input_blockdev_add,
3536 },
3537
3538SQMP
3539blockdev-add
3540------------
3541
3542Add a block device.
3543
3544Arguments:
3545
3546- "options": block driver options
3547
3548Example (1):
3549
3550-> { "execute": "blockdev-add",
3551 "arguments": { "options" : { "driver": "qcow2",
3552 "file": { "driver": "file",
3553 "filename": "test.qcow2" } } } }
3554<- { "return": {} }
3555
3556Example (2):
3557
3558-> { "execute": "blockdev-add",
3559 "arguments": {
3560 "options": {
3561 "driver": "qcow2",
3562 "id": "my_disk",
3563 "discard": "unmap",
3564 "cache": {
3565 "direct": true,
3566 "writeback": true
3567 },
3568 "file": {
3569 "driver": "file",
3570 "filename": "/tmp/test.qcow2"
3571 },
3572 "backing": {
3573 "driver": "raw",
3574 "file": {
3575 "driver": "file",
3576 "filename": "/dev/fdset/4"
3577 }
3578 }
3579 }
3580 }
3581 }
3582
3583<- { "return": {} }
3584
3585EQMP
Benoît Canetc13163f2014-01-23 21:31:34 +01003586
3587 {
3588 .name = "query-named-block-nodes",
3589 .args_type = "",
3590 .mhandler.cmd_new = qmp_marshal_input_query_named_block_nodes,
3591 },
3592
3593SQMP
3594@query-named-block-nodes
3595------------------------
3596
3597Return a list of BlockDeviceInfo for all the named block driver nodes
3598
3599Example:
3600
3601-> { "execute": "query-named-block-nodes" }
3602<- { "return": [ { "ro":false,
3603 "drv":"qcow2",
3604 "encrypted":false,
3605 "file":"disks/test.qcow2",
3606 "node-name": "my-node",
3607 "backing_file_depth":1,
3608 "bps":1000000,
3609 "bps_rd":0,
3610 "bps_wr":0,
3611 "iops":1000000,
3612 "iops_rd":0,
3613 "iops_wr":0,
3614 "bps_max": 8000000,
3615 "bps_rd_max": 0,
3616 "bps_wr_max": 0,
3617 "iops_max": 0,
3618 "iops_rd_max": 0,
3619 "iops_wr_max": 0,
3620 "iops_size": 0,
3621 "image":{
3622 "filename":"disks/test.qcow2",
3623 "format":"qcow2",
3624 "virtual-size":2048000,
3625 "backing_file":"base.qcow2",
3626 "full-backing-filename":"disks/base.qcow2",
3627 "backing-filename-format:"qcow2",
3628 "snapshots":[
3629 {
3630 "id": "1",
3631 "name": "snapshot1",
3632 "vm-state-size": 0,
3633 "date-sec": 10000200,
3634 "date-nsec": 12,
3635 "vm-clock-sec": 206,
3636 "vm-clock-nsec": 30
3637 }
3638 ],
3639 "backing-image":{
3640 "filename":"disks/base.qcow2",
3641 "format":"qcow2",
3642 "virtual-size":2048000
3643 }
Michael S. Tsirkinc0594512014-06-16 15:20:18 +03003644 } } ] }
Benoît Canetc13163f2014-01-23 21:31:34 +01003645
3646EQMP
Hu Tao76b5d852014-06-16 18:05:41 +08003647
3648 {
3649 .name = "query-memdev",
3650 .args_type = "",
3651 .mhandler.cmd_new = qmp_marshal_input_query_memdev,
3652 },
3653
3654SQMP
3655query-memdev
3656------------
3657
3658Show memory devices information.
3659
3660
3661Example (1):
3662
3663-> { "execute": "query-memdev" }
3664<- { "return": [
3665 {
3666 "size": 536870912,
3667 "merge": false,
3668 "dump": true,
3669 "prealloc": false,
3670 "host-nodes": [0, 1],
3671 "policy": "bind"
3672 },
3673 {
3674 "size": 536870912,
3675 "merge": false,
3676 "dump": true,
3677 "prealloc": true,
3678 "host-nodes": [2, 3],
3679 "policy": "preferred"
3680 }
3681 ]
3682 }
3683
3684EQMP
Igor Mammedov6f2e2732014-06-16 19:12:25 +02003685
3686 {
3687 .name = "query-memory-devices",
3688 .args_type = "",
3689 .mhandler.cmd_new = qmp_marshal_input_query_memory_devices,
3690 },
3691
3692SQMP
3693@query-memory-devices
3694--------------------
3695
3696Return a list of memory devices.
3697
3698Example:
3699-> { "execute": "query-memory-devices" }
3700<- { "return": [ { "data":
3701 { "addr": 5368709120,
3702 "hotpluggable": true,
3703 "hotplugged": true,
3704 "id": "d1",
3705 "memdev": "/objects/memX",
3706 "node": 0,
3707 "size": 1073741824,
3708 "slot": 0},
3709 "type": "dimm"
3710 } ] }
3711EQMP
Igor Mammedov02419bc2014-06-16 19:12:28 +02003712
3713 {
3714 .name = "query-acpi-ospm-status",
3715 .args_type = "",
3716 .mhandler.cmd_new = qmp_marshal_input_query_acpi_ospm_status,
3717 },
3718
3719SQMP
3720@query-acpi-ospm-status
3721--------------------
3722
3723Return list of ACPIOSTInfo for devices that support status reporting
3724via ACPI _OST method.
3725
3726Example:
3727-> { "execute": "query-acpi-ospm-status" }
3728<- { "return": [ { "device": "d1", "slot": "0", "slot-type": "DIMM", "source": 1, "status": 0},
3729 { "slot": "1", "slot-type": "DIMM", "source": 0, "status": 0},
3730 { "slot": "2", "slot-type": "DIMM", "source": 0, "status": 0},
3731 { "slot": "3", "slot-type": "DIMM", "source": 0, "status": 0}
3732 ]}
3733EQMP
Marcelo Tosattif2ae8ab2014-06-24 18:55:11 -03003734
3735#if defined TARGET_I386
3736 {
3737 .name = "rtc-reset-reinjection",
3738 .args_type = "",
3739 .mhandler.cmd_new = qmp_marshal_input_rtc_reset_reinjection,
3740 },
3741#endif
3742
3743SQMP
3744rtc-reset-reinjection
3745---------------------
3746
3747Reset the RTC interrupt reinjection backlog.
3748
3749Arguments: None.
3750
3751Example:
3752
3753-> { "execute": "rtc-reset-reinjection" }
3754<- { "return": {} }
Lluís Vilanova1dde0f42014-08-25 13:19:57 +02003755EQMP
Marcelo Tosattif2ae8ab2014-06-24 18:55:11 -03003756
Lluís Vilanova1dde0f42014-08-25 13:19:57 +02003757 {
3758 .name = "trace-event-get-state",
3759 .args_type = "name:s",
3760 .mhandler.cmd_new = qmp_marshal_input_trace_event_get_state,
3761 },
3762
3763SQMP
3764trace-event-get-state
3765---------------------
3766
3767Query the state of events.
3768
3769Example:
3770
3771-> { "execute": "trace-event-get-state", "arguments": { "name": "qemu_memalign" } }
3772<- { "return": [ { "name": "qemu_memalign", "state": "disabled" } ] }
3773EQMP
3774
3775 {
3776 .name = "trace-event-set-state",
3777 .args_type = "name:s,enable:b,ignore-unavailable:b?",
3778 .mhandler.cmd_new = qmp_marshal_input_trace_event_set_state,
3779 },
3780
3781SQMP
3782trace-event-set-state
3783---------------------
3784
3785Set the state of events.
3786
3787Example:
3788
3789-> { "execute": "trace-event-set-state", "arguments": { "name": "qemu_memalign", "enable": "true" } }
3790<- { "return": {} }
Marcelo Tosattif2ae8ab2014-06-24 18:55:11 -03003791EQMP