blob: 66701927af8b26eb3e26cf6dcbca0c5b656ef5f6 [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
480Inject an NMI on guest's CPUs.
481
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.
Eugene (jno) Dvurechenski7f7f9752012-12-05 15:50:07 +0100490 Currently, only x86 (NMI) and s390x (RESTART) guests do.
Lai Jiangshana4046662011-03-07 17:05:15 +0800491
492EQMP
493
494 {
Markus Armbruster3949e592013-02-06 21:27:24 +0100495 .name = "ringbuf-write",
Markus Armbruster82e59a62013-02-06 21:27:14 +0100496 .args_type = "device:s,data:s,format:s?",
Markus Armbruster3949e592013-02-06 21:27:24 +0100497 .mhandler.cmd_new = qmp_marshal_input_ringbuf_write,
Lei Li1f590cf2013-01-25 00:03:20 +0800498 },
499
500SQMP
Markus Armbruster3949e592013-02-06 21:27:24 +0100501ringbuf-write
Lei Li1f590cf2013-01-25 00:03:20 +0800502-------------
503
Markus Armbruster3949e592013-02-06 21:27:24 +0100504Write to a ring buffer character device.
Lei Li1f590cf2013-01-25 00:03:20 +0800505
506Arguments:
507
Markus Armbruster3949e592013-02-06 21:27:24 +0100508- "device": ring buffer character device name (json-string)
509- "data": data to write (json-string)
510- "format": data format (json-string, optional)
511 - Possible values: "utf8" (default), "base64"
512 Bug: invalid base64 is currently not rejected.
513 Whitespace *is* invalid.
Lei Li1f590cf2013-01-25 00:03:20 +0800514
515Example:
516
Markus Armbruster3949e592013-02-06 21:27:24 +0100517-> { "execute": "ringbuf-write",
518 "arguments": { "device": "foo",
Lei Li1f590cf2013-01-25 00:03:20 +0800519 "data": "abcdefgh",
520 "format": "utf8" } }
521<- { "return": {} }
522
523EQMP
524
525 {
Markus Armbruster3949e592013-02-06 21:27:24 +0100526 .name = "ringbuf-read",
Lei Li49b6d722013-01-25 00:03:21 +0800527 .args_type = "device:s,size:i,format:s?",
Markus Armbruster3949e592013-02-06 21:27:24 +0100528 .mhandler.cmd_new = qmp_marshal_input_ringbuf_read,
Lei Li49b6d722013-01-25 00:03:21 +0800529 },
530
531SQMP
Markus Armbruster3949e592013-02-06 21:27:24 +0100532ringbuf-read
Lei Li49b6d722013-01-25 00:03:21 +0800533-------------
534
Markus Armbruster3949e592013-02-06 21:27:24 +0100535Read from a ring buffer character device.
Lei Li49b6d722013-01-25 00:03:21 +0800536
537Arguments:
538
Markus Armbruster3949e592013-02-06 21:27:24 +0100539- "device": ring buffer character device name (json-string)
540- "size": how many bytes to read at most (json-int)
541 - Number of data bytes, not number of characters in encoded data
542- "format": data format (json-string, optional)
543 - Possible values: "utf8" (default), "base64"
544 - Naturally, format "utf8" works only when the ring buffer
545 contains valid UTF-8 text. Invalid UTF-8 sequences get
546 replaced. Bug: replacement doesn't work. Bug: can screw
547 up on encountering NUL characters, after the ring buffer
548 lost data, and when reading stops because the size limit
549 is reached.
Lei Li49b6d722013-01-25 00:03:21 +0800550
551Example:
552
Markus Armbruster3949e592013-02-06 21:27:24 +0100553-> { "execute": "ringbuf-read",
554 "arguments": { "device": "foo",
Lei Li49b6d722013-01-25 00:03:21 +0800555 "size": 1000,
556 "format": "utf8" } }
Markus Armbruster3ab651f2013-02-06 21:27:15 +0100557<- {"return": "abcdefgh"}
Lei Li49b6d722013-01-25 00:03:21 +0800558
559EQMP
560
561 {
Stefano Stabellinia7ae8352012-01-25 12:24:51 +0000562 .name = "xen-save-devices-state",
563 .args_type = "filename:F",
564 .mhandler.cmd_new = qmp_marshal_input_xen_save_devices_state,
565 },
566
567SQMP
568xen-save-devices-state
569-------
570
571Save the state of all devices to file. The RAM and the block devices
572of the VM are not saved by this command.
573
574Arguments:
575
576- "filename": the file to save the state of the devices to as binary
577data. See xen-save-devices-state.txt for a description of the binary
578format.
579
580Example:
581
582-> { "execute": "xen-save-devices-state",
583 "arguments": { "filename": "/tmp/save" } }
584<- { "return": {} }
585
586EQMP
587
588 {
Anthony PERARD39f42432012-10-03 13:48:19 +0000589 .name = "xen-set-global-dirty-log",
590 .args_type = "enable:b",
591 .mhandler.cmd_new = qmp_marshal_input_xen_set_global_dirty_log,
592 },
593
594SQMP
595xen-set-global-dirty-log
596-------
597
598Enable or disable the global dirty log mode.
599
600Arguments:
601
602- "enable": Enable it or disable it.
603
604Example:
605
606-> { "execute": "xen-set-global-dirty-log",
607 "arguments": { "enable": true } }
608<- { "return": {} }
609
610EQMP
611
612 {
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300613 .name = "migrate",
614 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
Luiz Capitulinoe1c37d02011-12-05 14:48:01 -0200615 .mhandler.cmd_new = qmp_marshal_input_migrate,
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300616 },
617
618SQMP
619migrate
620-------
621
622Migrate to URI.
623
624Arguments:
625
626- "blk": block migration, full disk copy (json-bool, optional)
627- "inc": incremental disk copy (json-bool, optional)
628- "uri": Destination URI (json-string)
629
630Example:
631
632-> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
633<- { "return": {} }
634
635Notes:
636
637(1) The 'query-migrate' command should be used to check migration's progress
638 and final result (this information is provided by the 'status' member)
639(2) All boolean arguments default to false
640(3) The user Monitor's "detach" argument is invalid in QMP and should not
641 be used
642
643EQMP
644
645 {
646 .name = "migrate_cancel",
647 .args_type = "",
Luiz Capitulino6cdedb02011-11-27 22:54:09 -0200648 .mhandler.cmd_new = qmp_marshal_input_migrate_cancel,
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300649 },
650
651SQMP
652migrate_cancel
653--------------
654
655Cancel the current migration.
656
657Arguments: None.
658
659Example:
660
661-> { "execute": "migrate_cancel" }
662<- { "return": {} }
663
664EQMP
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300665{
666 .name = "migrate-set-cache-size",
667 .args_type = "value:o",
668 .mhandler.cmd_new = qmp_marshal_input_migrate_set_cache_size,
669 },
670
671SQMP
672migrate-set-cache-size
Juan Quintela817c6042013-02-11 15:11:10 +0100673----------------------
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300674
675Set cache size to be used by XBZRLE migration, the cache size will be rounded
676down to the nearest power of 2
677
678Arguments:
679
680- "value": cache size in bytes (json-int)
681
682Example:
683
684-> { "execute": "migrate-set-cache-size", "arguments": { "value": 536870912 } }
685<- { "return": {} }
686
687EQMP
688 {
689 .name = "query-migrate-cache-size",
690 .args_type = "",
691 .mhandler.cmd_new = qmp_marshal_input_query_migrate_cache_size,
692 },
693
694SQMP
695query-migrate-cache-size
Juan Quintela817c6042013-02-11 15:11:10 +0100696------------------------
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300697
698Show cache size to be used by XBZRLE migration
699
700returns a json-object with the following information:
701- "size" : json-int
702
703Example:
704
705-> { "execute": "query-migrate-cache-size" }
706<- { "return": 67108864 }
707
708EQMP
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300709
710 {
711 .name = "migrate_set_speed",
Wen Congyang3a019b62010-11-25 09:06:05 +0800712 .args_type = "value:o",
Luiz Capitulino3dc85382011-11-28 11:59:37 -0200713 .mhandler.cmd_new = qmp_marshal_input_migrate_set_speed,
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300714 },
715
716SQMP
717migrate_set_speed
718-----------------
719
720Set maximum speed for migrations.
721
722Arguments:
723
Luiz Capitulino5569fd72010-12-15 17:56:18 -0200724- "value": maximum speed, in bytes per second (json-int)
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300725
726Example:
727
728-> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } }
729<- { "return": {} }
730
731EQMP
732
733 {
734 .name = "migrate_set_downtime",
735 .args_type = "value:T",
Luiz Capitulino4f0a9932011-11-27 23:18:01 -0200736 .mhandler.cmd_new = qmp_marshal_input_migrate_set_downtime,
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300737 },
738
739SQMP
740migrate_set_downtime
741--------------------
742
743Set maximum tolerated downtime (in seconds) for migrations.
744
745Arguments:
746
747- "value": maximum downtime (json-number)
748
749Example:
750
751-> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } }
752<- { "return": {} }
753
754EQMP
755
756 {
Jes Sorensenff73edf2011-03-09 14:31:06 +0100757 .name = "client_migrate_info",
758 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
759 .params = "protocol hostname port tls-port cert-subject",
760 .help = "send migration info to spice/vnc client",
761 .user_print = monitor_user_noop,
Yonit Halperinedc5cb12011-10-17 10:03:18 +0200762 .mhandler.cmd_async = client_migrate_info,
763 .flags = MONITOR_CMD_ASYNC,
Jes Sorensenff73edf2011-03-09 14:31:06 +0100764 },
765
766SQMP
767client_migrate_info
768------------------
769
770Set the spice/vnc connection info for the migration target. The spice/vnc
771server will ask the spice/vnc client to automatically reconnect using the
772new parameters (if specified) once the vm migration finished successfully.
773
774Arguments:
775
776- "protocol": protocol: "spice" or "vnc" (json-string)
777- "hostname": migration target hostname (json-string)
778- "port": spice/vnc tcp port for plaintext channels (json-int, optional)
779- "tls-port": spice tcp port for tls-secured channels (json-int, optional)
780- "cert-subject": server certificate subject (json-string, optional)
781
782Example:
783
784-> { "execute": "client_migrate_info",
785 "arguments": { "protocol": "spice",
786 "hostname": "virt42.lab.kraxel.org",
787 "port": 1234 } }
788<- { "return": {} }
789
790EQMP
791
792 {
Wen Congyang783e9b42012-05-07 12:10:47 +0800793 .name = "dump-guest-memory",
794 .args_type = "paging:b,protocol:s,begin:i?,end:i?",
795 .params = "-p protocol [begin] [length]",
796 .help = "dump guest memory to file",
797 .user_print = monitor_user_noop,
798 .mhandler.cmd_new = qmp_marshal_input_dump_guest_memory,
799 },
800
801SQMP
802dump
803
804
805Dump guest memory to file. The file can be processed with crash or gdb.
806
807Arguments:
808
809- "paging": do paging to get guest's memory mapping (json-bool)
810- "protocol": destination file(started with "file:") or destination file
811 descriptor (started with "fd:") (json-string)
812- "begin": the starting physical address. It's optional, and should be specified
813 with length together (json-int)
814- "length": the memory size, in bytes. It's optional, and should be specified
815 with begin together (json-int)
816
817Example:
818
819-> { "execute": "dump-guest-memory", "arguments": { "protocol": "fd:dump" } }
820<- { "return": {} }
821
822Notes:
823
824(1) All boolean arguments default to false
825
826EQMP
827
828 {
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300829 .name = "netdev_add",
830 .args_type = "netdev:O",
Luiz Capitulino928059a2012-04-18 17:34:15 -0300831 .mhandler.cmd_new = qmp_netdev_add,
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300832 },
833
834SQMP
835netdev_add
836----------
837
838Add host network device.
839
840Arguments:
841
842- "type": the device type, "tap", "user", ... (json-string)
843- "id": the device's ID, must be unique (json-string)
844- device options
845
846Example:
847
848-> { "execute": "netdev_add", "arguments": { "type": "user", "id": "netdev1" } }
849<- { "return": {} }
850
Markus Armbrusteraf347aa2013-02-22 18:31:51 +0100851Note: The supported device options are the same ones supported by the '-netdev'
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300852 command-line argument, which are listed in the '-help' output or QEMU's
853 manual
854
855EQMP
856
857 {
858 .name = "netdev_del",
859 .args_type = "id:s",
Luiz Capitulino5f964152012-04-16 14:36:32 -0300860 .mhandler.cmd_new = qmp_marshal_input_netdev_del,
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300861 },
862
863SQMP
864netdev_del
865----------
866
867Remove host network device.
868
869Arguments:
870
871- "id": the device's ID, must be unique (json-string)
872
873Example:
874
875-> { "execute": "netdev_del", "arguments": { "id": "netdev1" } }
876<- { "return": {} }
877
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +0100878
879EQMP
880
881 {
882 .name = "block_resize",
883 .args_type = "device:B,size:o",
Luiz Capitulino5e7caac2011-11-25 14:57:10 -0200884 .mhandler.cmd_new = qmp_marshal_input_block_resize,
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +0100885 },
886
887SQMP
888block_resize
889------------
890
891Resize a block image while a guest is running.
892
893Arguments:
894
895- "device": the device's ID, must be unique (json-string)
896- "size": new size
897
898Example:
899
900-> { "execute": "block_resize", "arguments": { "device": "scratch", "size": 1073741824 } }
901<- { "return": {} }
902
Luiz Capitulino82a56f02010-09-13 12:26:00 -0300903EQMP
904
905 {
Stefan Hajnoczidb58f9c2012-04-11 16:27:10 +0100906 .name = "block-stream",
Paolo Bonzini1d809092012-09-28 17:22:59 +0200907 .args_type = "device:B,base:s?,speed:o?,on-error:s?",
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +0000908 .mhandler.cmd_new = qmp_marshal_input_block_stream,
909 },
910
911 {
Jeff Codyed61fc12012-09-27 13:29:16 -0400912 .name = "block-commit",
913 .args_type = "device:B,base:s?,top:s,speed:o?",
914 .mhandler.cmd_new = qmp_marshal_input_block_commit,
915 },
916
917 {
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +0200918 .name = "drive-backup",
Stefan Hajnoczib53169e2013-06-26 14:11:57 +0200919 .args_type = "sync:s,device:B,target:s,speed:i?,mode:s?,format:s?,"
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +0200920 "on-source-error:s?,on-target-error:s?",
921 .mhandler.cmd_new = qmp_marshal_input_drive_backup,
922 },
923
924SQMP
925drive-backup
926------------
927
928Start a point-in-time copy of a block device to a new destination. The
929status of ongoing drive-backup operations can be checked with
930query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
931The operation can be stopped before it has completed using the
932block-job-cancel command.
933
934Arguments:
935
936- "device": the name of the device which should be copied.
937 (json-string)
938- "target": the target of the new image. If the file exists, or if it is a
939 device, the existing file/device will be used as the new
940 destination. If it does not exist, a new file will be created.
941 (json-string)
942- "format": the format of the new destination, default is to probe if 'mode' is
943 'existing', else the format of the source
944 (json-string, optional)
Stefan Hajnoczib53169e2013-06-26 14:11:57 +0200945- "sync": what parts of the disk image should be copied to the destination;
946 possibilities include "full" for all the disk, "top" for only the sectors
947 allocated in the topmost image, or "none" to only replicate new I/O
948 (MirrorSyncMode).
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +0200949- "mode": whether and how QEMU should create a new image
950 (NewImageMode, optional, default 'absolute-paths')
951- "speed": the maximum speed, in bytes per second (json-int, optional)
952- "on-source-error": the action to take on an error on the source, default
953 'report'. 'stop' and 'enospc' can only be used
954 if the block device supports io-status.
955 (BlockdevOnError, optional)
956- "on-target-error": the action to take on an error on the target, default
957 'report' (no limitations, since this applies to
958 a different block device than device).
959 (BlockdevOnError, optional)
960
961Example:
962-> { "execute": "drive-backup", "arguments": { "device": "drive0",
Ian Mainfc5d3f82013-07-26 11:39:04 -0700963 "sync": "full",
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +0200964 "target": "backup.img" } }
965<- { "return": {} }
966EQMP
967
968 {
Stefan Hajnoczidb58f9c2012-04-11 16:27:10 +0100969 .name = "block-job-set-speed",
Stefan Hajnoczi882ec7c2012-04-25 16:51:02 +0100970 .args_type = "device:B,speed:o",
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +0000971 .mhandler.cmd_new = qmp_marshal_input_block_job_set_speed,
972 },
973
974 {
Stefan Hajnoczidb58f9c2012-04-11 16:27:10 +0100975 .name = "block-job-cancel",
Paolo Bonzini6e37fb82012-09-28 17:22:51 +0200976 .args_type = "device:B,force:b?",
Stefan Hajnoczi370521a2012-01-18 14:40:48 +0000977 .mhandler.cmd_new = qmp_marshal_input_block_job_cancel,
978 },
Jeff Codyc1864022012-02-28 15:54:07 -0500979 {
Paolo Bonzini6e37fb82012-09-28 17:22:51 +0200980 .name = "block-job-pause",
981 .args_type = "device:B",
982 .mhandler.cmd_new = qmp_marshal_input_block_job_pause,
983 },
984 {
985 .name = "block-job-resume",
986 .args_type = "device:B",
987 .mhandler.cmd_new = qmp_marshal_input_block_job_resume,
988 },
989 {
Paolo Bonziniaeae8832012-10-18 16:49:21 +0200990 .name = "block-job-complete",
991 .args_type = "device:B",
992 .mhandler.cmd_new = qmp_marshal_input_block_job_complete,
993 },
994 {
Paolo Bonzini52e7c242012-03-06 18:55:57 +0100995 .name = "transaction",
Paolo Bonzinib9f89782012-03-22 12:51:11 +0100996 .args_type = "actions:q",
Paolo Bonzini52e7c242012-03-06 18:55:57 +0100997 .mhandler.cmd_new = qmp_marshal_input_transaction,
Jeff Codyc1864022012-02-28 15:54:07 -0500998 },
999
1000SQMP
Paolo Bonzini52e7c242012-03-06 18:55:57 +01001001transaction
1002-----------
Jeff Codyc1864022012-02-28 15:54:07 -05001003
Wenchao Xiabbe86012013-09-11 14:04:34 +08001004Atomically operate on one or more block devices. The only supported operations
1005for now are drive-backup, internal and external snapshotting. A list of
1006dictionaries is accepted, that contains the actions to be performed.
1007If there is any failure performing any of the operations, all operations
1008for the group are abandoned.
Jeff Codyc1864022012-02-28 15:54:07 -05001009
Wenchao Xiabbe86012013-09-11 14:04:34 +08001010For external snapshots, the dictionary contains the device, the file to use for
1011the new snapshot, and the format. The default format, if not specified, is
1012qcow2.
Jeff Codyc1864022012-02-28 15:54:07 -05001013
Paolo Bonzinibc8b0942012-03-06 18:55:58 +01001014Each new snapshot defaults to being created by QEMU (wiping any
1015contents if the file already exists), but it is also possible to reuse
1016an externally-created file. In the latter case, you should ensure that
1017the new image file has the same contents as the current one; QEMU cannot
1018perform any meaningful check. Typically this is achieved by using the
1019current image file as the backing file for the new image.
1020
Wenchao Xiabbe86012013-09-11 14:04:34 +08001021On failure, the original disks pre-snapshot attempt will be used.
1022
1023For internal snapshots, the dictionary contains the device and the snapshot's
1024name. If an internal snapshot matching name already exists, the request will
1025be rejected. Only some image formats support it, for example, qcow2, rbd,
1026and sheepdog.
1027
1028On failure, qemu will try delete the newly created internal snapshot in the
1029transaction. When an I/O error occurs during deletion, the user needs to fix
1030it later with qemu-img or other command.
1031
Jeff Codyc1864022012-02-28 15:54:07 -05001032Arguments:
1033
Paolo Bonzini52e7c242012-03-06 18:55:57 +01001034actions array:
1035 - "type": the operation to perform. The only supported
1036 value is "blockdev-snapshot-sync". (json-string)
1037 - "data": a dictionary. The contents depend on the value
1038 of "type". When "type" is "blockdev-snapshot-sync":
1039 - "device": device name to snapshot (json-string)
1040 - "snapshot-file": name of new image file (json-string)
1041 - "format": format of new image (json-string, optional)
Paolo Bonzinibc8b0942012-03-06 18:55:58 +01001042 - "mode": whether and how QEMU should create the snapshot file
1043 (NewImageMode, optional, default "absolute-paths")
Wenchao Xiabbe86012013-09-11 14:04:34 +08001044 When "type" is "blockdev-snapshot-internal-sync":
1045 - "device": device name to snapshot (json-string)
1046 - "name": name of the new snapshot (json-string)
Jeff Codyc1864022012-02-28 15:54:07 -05001047
1048Example:
1049
Paolo Bonzini52e7c242012-03-06 18:55:57 +01001050-> { "execute": "transaction",
1051 "arguments": { "actions": [
1052 { 'type': 'blockdev-snapshot-sync', 'data' : { "device": "ide-hd0",
1053 "snapshot-file": "/some/place/my-image",
1054 "format": "qcow2" } },
1055 { 'type': 'blockdev-snapshot-sync', 'data' : { "device": "ide-hd1",
1056 "snapshot-file": "/some/place/my-image2",
Paolo Bonzinibc8b0942012-03-06 18:55:58 +01001057 "mode": "existing",
Wenchao Xiabbe86012013-09-11 14:04:34 +08001058 "format": "qcow2" } },
1059 { 'type': 'blockdev-snapshot-internal-sync', 'data' : {
1060 "device": "ide-hd2",
1061 "name": "snapshot0" } } ] } }
Jeff Codyc1864022012-02-28 15:54:07 -05001062<- { "return": {} }
1063
1064EQMP
Stefan Hajnoczi370521a2012-01-18 14:40:48 +00001065
1066 {
Jes Sorensend967b2f2011-07-11 20:01:09 +02001067 .name = "blockdev-snapshot-sync",
Paolo Bonzini31155b92012-04-12 14:00:58 +02001068 .args_type = "device:B,snapshot-file:s,format:s?,mode:s?",
Luiz Capitulino6106e242011-11-25 16:15:19 -02001069 .mhandler.cmd_new = qmp_marshal_input_blockdev_snapshot_sync,
Jes Sorensend967b2f2011-07-11 20:01:09 +02001070 },
1071
1072SQMP
1073blockdev-snapshot-sync
1074----------------------
1075
1076Synchronous snapshot of a block device. snapshot-file specifies the
1077target of the new image. If the file exists, or if it is a device, the
1078snapshot will be created in the existing file/device. If does not
1079exist, a new file will be created. format specifies the format of the
1080snapshot image, default is qcow2.
1081
1082Arguments:
1083
1084- "device": device name to snapshot (json-string)
1085- "snapshot-file": name of new image file (json-string)
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001086- "mode": whether and how QEMU should create the snapshot file
1087 (NewImageMode, optional, default "absolute-paths")
Jes Sorensend967b2f2011-07-11 20:01:09 +02001088- "format": format of new image (json-string, optional)
1089
1090Example:
1091
Luiz Capitulino7f3850c2011-10-10 17:30:08 -03001092-> { "execute": "blockdev-snapshot-sync", "arguments": { "device": "ide-hd0",
1093 "snapshot-file":
1094 "/some/place/my-image",
1095 "format": "qcow2" } }
Jes Sorensend967b2f2011-07-11 20:01:09 +02001096<- { "return": {} }
1097
1098EQMP
1099
1100 {
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02001101 .name = "drive-mirror",
Paolo Bonzinib952b552012-10-18 16:49:28 +02001102 .args_type = "sync:s,device:B,target:s,speed:i?,mode:s?,format:s?,"
Paolo Bonzinieee13df2013-01-21 17:09:46 +01001103 "on-source-error:s?,on-target-error:s?,"
Paolo Bonzini08e4ed62013-01-22 09:03:13 +01001104 "granularity:i?,buf-size:i?",
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02001105 .mhandler.cmd_new = qmp_marshal_input_drive_mirror,
1106 },
1107
1108SQMP
1109drive-mirror
1110------------
1111
1112Start mirroring a block device's writes to a new destination. target
1113specifies the target of the new image. If the file exists, or if it is
1114a device, it will be used as the new destination for writes. If it does not
1115exist, a new file will be created. format specifies the format of the
1116mirror image, default is to probe if mode='existing', else the format
1117of the source.
1118
1119Arguments:
1120
1121- "device": device name to operate on (json-string)
1122- "target": name of new image file (json-string)
1123- "format": format of new image (json-string, optional)
1124- "mode": how an image file should be created into the target
1125 file/device (NewImageMode, optional, default 'absolute-paths')
1126- "speed": maximum speed of the streaming job, in bytes per second
1127 (json-int)
Paolo Bonzinieee13df2013-01-21 17:09:46 +01001128- "granularity": granularity of the dirty bitmap, in bytes (json-int, optional)
Paolo Bonzini08e4ed62013-01-22 09:03:13 +01001129- "buf_size": maximum amount of data in flight from source to target, in bytes
1130 (json-int, default 10M)
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02001131- "sync": what parts of the disk image should be copied to the destination;
1132 possibilities include "full" for all the disk, "top" for only the sectors
1133 allocated in the topmost image, or "none" to only replicate new I/O
1134 (MirrorSyncMode).
Paolo Bonzinib952b552012-10-18 16:49:28 +02001135- "on-source-error": the action to take on an error on the source
1136 (BlockdevOnError, default 'report')
1137- "on-target-error": the action to take on an error on the target
1138 (BlockdevOnError, default 'report')
1139
Paolo Bonzinieee13df2013-01-21 17:09:46 +01001140The default value of the granularity is the image cluster size clamped
1141between 4096 and 65536, if the image format defines one. If the format
1142does not define a cluster size, the default value of the granularity
1143is 65536.
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02001144
1145
1146Example:
1147
1148-> { "execute": "drive-mirror", "arguments": { "device": "ide-hd0",
1149 "target": "/some/place/my-image",
1150 "sync": "full",
1151 "format": "qcow2" } }
1152<- { "return": {} }
1153
1154EQMP
1155
1156 {
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001157 .name = "balloon",
1158 .args_type = "value:M",
Luiz Capitulinod72f3262011-11-25 14:38:09 -02001159 .mhandler.cmd_new = qmp_marshal_input_balloon,
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001160 },
1161
1162SQMP
1163balloon
1164-------
1165
1166Request VM to change its memory allocation (in bytes).
1167
1168Arguments:
1169
1170- "value": New memory allocation (json-int)
1171
1172Example:
1173
1174-> { "execute": "balloon", "arguments": { "value": 536870912 } }
1175<- { "return": {} }
1176
1177EQMP
1178
1179 {
1180 .name = "set_link",
1181 .args_type = "name:s,up:b",
Luiz Capitulino4b371562011-11-23 13:11:55 -02001182 .mhandler.cmd_new = qmp_marshal_input_set_link,
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001183 },
1184
1185SQMP
1186set_link
1187--------
1188
1189Change the link status of a network adapter.
1190
1191Arguments:
1192
1193- "name": network device name (json-string)
1194- "up": status is up (json-bool)
1195
1196Example:
1197
1198-> { "execute": "set_link", "arguments": { "name": "e1000.0", "up": false } }
1199<- { "return": {} }
1200
1201EQMP
1202
1203 {
1204 .name = "getfd",
1205 .args_type = "fdname:s",
1206 .params = "getfd name",
1207 .help = "receive a file descriptor via SCM rights and assign it a name",
Corey Bryant208c9d12012-06-22 14:36:09 -04001208 .mhandler.cmd_new = qmp_marshal_input_getfd,
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001209 },
1210
1211SQMP
1212getfd
1213-----
1214
1215Receive a file descriptor via SCM rights and assign it a name.
1216
1217Arguments:
1218
1219- "fdname": file descriptor name (json-string)
1220
1221Example:
1222
1223-> { "execute": "getfd", "arguments": { "fdname": "fd1" } }
1224<- { "return": {} }
1225
Corey Bryant208c9d12012-06-22 14:36:09 -04001226Notes:
1227
1228(1) If the name specified by the "fdname" argument already exists,
1229 the file descriptor assigned to it will be closed and replaced
1230 by the received file descriptor.
1231(2) The 'closefd' command can be used to explicitly close the file
1232 descriptor when it is no longer needed.
1233
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001234EQMP
1235
1236 {
1237 .name = "closefd",
1238 .args_type = "fdname:s",
1239 .params = "closefd name",
1240 .help = "close a file descriptor previously passed via SCM rights",
Corey Bryant208c9d12012-06-22 14:36:09 -04001241 .mhandler.cmd_new = qmp_marshal_input_closefd,
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001242 },
1243
1244SQMP
1245closefd
1246-------
1247
1248Close a file descriptor previously passed via SCM rights.
1249
1250Arguments:
1251
1252- "fdname": file descriptor name (json-string)
1253
1254Example:
1255
1256-> { "execute": "closefd", "arguments": { "fdname": "fd1" } }
1257<- { "return": {} }
1258
1259EQMP
1260
Corey Bryantba1c0482012-08-14 16:43:43 -04001261 {
1262 .name = "add-fd",
1263 .args_type = "fdset-id:i?,opaque:s?",
1264 .params = "add-fd fdset-id opaque",
1265 .help = "Add a file descriptor, that was passed via SCM rights, to an fd set",
1266 .mhandler.cmd_new = qmp_marshal_input_add_fd,
1267 },
1268
1269SQMP
1270add-fd
1271-------
1272
1273Add a file descriptor, that was passed via SCM rights, to an fd set.
1274
1275Arguments:
1276
1277- "fdset-id": The ID of the fd set to add the file descriptor to.
1278 (json-int, optional)
1279- "opaque": A free-form string that can be used to describe the fd.
1280 (json-string, optional)
1281
1282Return a json-object with the following information:
1283
1284- "fdset-id": The ID of the fd set that the fd was added to. (json-int)
1285- "fd": The file descriptor that was received via SCM rights and added to the
1286 fd set. (json-int)
1287
1288Example:
1289
1290-> { "execute": "add-fd", "arguments": { "fdset-id": 1 } }
1291<- { "return": { "fdset-id": 1, "fd": 3 } }
1292
1293Notes:
1294
1295(1) The list of fd sets is shared by all monitor connections.
1296(2) If "fdset-id" is not specified, a new fd set will be created.
1297
1298EQMP
1299
1300 {
1301 .name = "remove-fd",
1302 .args_type = "fdset-id:i,fd:i?",
1303 .params = "remove-fd fdset-id fd",
1304 .help = "Remove a file descriptor from an fd set",
1305 .mhandler.cmd_new = qmp_marshal_input_remove_fd,
1306 },
1307
1308SQMP
1309remove-fd
1310---------
1311
1312Remove a file descriptor from an fd set.
1313
1314Arguments:
1315
1316- "fdset-id": The ID of the fd set that the file descriptor belongs to.
1317 (json-int)
1318- "fd": The file descriptor that is to be removed. (json-int, optional)
1319
1320Example:
1321
1322-> { "execute": "remove-fd", "arguments": { "fdset-id": 1, "fd": 3 } }
1323<- { "return": {} }
1324
1325Notes:
1326
1327(1) The list of fd sets is shared by all monitor connections.
1328(2) If "fd" is not specified, all file descriptors in "fdset-id" will be
1329 removed.
1330
1331EQMP
1332
1333 {
1334 .name = "query-fdsets",
1335 .args_type = "",
1336 .help = "Return information describing all fd sets",
1337 .mhandler.cmd_new = qmp_marshal_input_query_fdsets,
1338 },
1339
1340SQMP
1341query-fdsets
1342-------------
1343
1344Return information describing all fd sets.
1345
1346Arguments: None
1347
1348Example:
1349
1350-> { "execute": "query-fdsets" }
1351<- { "return": [
1352 {
1353 "fds": [
1354 {
1355 "fd": 30,
1356 "opaque": "rdonly:/path/to/file"
1357 },
1358 {
1359 "fd": 24,
1360 "opaque": "rdwr:/path/to/file"
1361 }
1362 ],
1363 "fdset-id": 1
1364 },
1365 {
1366 "fds": [
1367 {
1368 "fd": 28
1369 },
1370 {
1371 "fd": 29
1372 }
1373 ],
1374 "fdset-id": 0
1375 }
1376 ]
1377 }
1378
1379Note: The list of fd sets is shared by all monitor connections.
1380
1381EQMP
1382
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001383 {
1384 .name = "block_passwd",
1385 .args_type = "device:B,password:s",
Luiz Capitulinoa4dea8a2011-11-23 13:28:21 -02001386 .mhandler.cmd_new = qmp_marshal_input_block_passwd,
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001387 },
1388
1389SQMP
1390block_passwd
1391------------
1392
1393Set the password of encrypted block devices.
1394
1395Arguments:
1396
1397- "device": device name (json-string)
1398- "password": password (json-string)
1399
1400Example:
1401
1402-> { "execute": "block_passwd", "arguments": { "device": "ide0-hd0",
1403 "password": "12345" } }
1404<- { "return": {} }
1405
1406EQMP
1407
1408 {
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001409 .name = "block_set_io_throttle",
Benoît Canet2024c1d2013-09-02 14:14:41 +02001410 .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 -02001411 .mhandler.cmd_new = qmp_marshal_input_block_set_io_throttle,
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001412 },
1413
1414SQMP
1415block_set_io_throttle
1416------------
1417
1418Change I/O throttle limits for a block drive.
1419
1420Arguments:
1421
1422- "device": device name (json-string)
Eric Blake586b5462013-08-30 14:44:11 -06001423- "bps": total throughput limit in bytes per second (json-int)
1424- "bps_rd": read throughput limit in bytes per second (json-int)
1425- "bps_wr": write throughput limit in bytes per second (json-int)
1426- "iops": total I/O operations per second (json-int)
1427- "iops_rd": read I/O operations per second (json-int)
1428- "iops_wr": write I/O operations per second (json-int)
Benoît Canet3e9fab62013-09-02 14:14:40 +02001429- "bps_max": total max in bytes (json-int)
1430- "bps_rd_max": read max in bytes (json-int)
1431- "bps_wr_max": write max in bytes (json-int)
1432- "iops_max": total I/O operations max (json-int)
1433- "iops_rd_max": read I/O operations max (json-int)
1434- "iops_wr_max": write I/O operations max (json-int)
Benoît Canet2024c1d2013-09-02 14:14:41 +02001435- "iops_size": I/O size in bytes when limiting (json-int)
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001436
1437Example:
1438
1439-> { "execute": "block_set_io_throttle", "arguments": { "device": "virtio0",
Eric Blake586b5462013-08-30 14:44:11 -06001440 "bps": 1000000,
1441 "bps_rd": 0,
1442 "bps_wr": 0,
1443 "iops": 0,
1444 "iops_rd": 0,
Benoît Canet3e9fab62013-09-02 14:14:40 +02001445 "iops_wr": 0,
1446 "bps_max": 8000000,
1447 "bps_rd_max": 0,
1448 "bps_wr_max": 0,
1449 "iops_max": 0,
1450 "iops_rd_max": 0,
Benoît Canet2024c1d2013-09-02 14:14:41 +02001451 "iops_wr_max": 0,
1452 "iops_size": 0 } }
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001453<- { "return": {} }
1454
1455EQMP
1456
1457 {
Gerd Hoffmann75721502010-10-07 12:22:54 +02001458 .name = "set_password",
1459 .args_type = "protocol:s,password:s,connected:s?",
Luiz Capitulinofbf796f2011-12-07 11:17:51 -02001460 .mhandler.cmd_new = qmp_marshal_input_set_password,
Gerd Hoffmann75721502010-10-07 12:22:54 +02001461 },
1462
1463SQMP
1464set_password
1465------------
1466
1467Set the password for vnc/spice protocols.
1468
1469Arguments:
1470
1471- "protocol": protocol name (json-string)
1472- "password": password (json-string)
1473- "connected": [ keep | disconnect | fail ] (josn-string, optional)
1474
1475Example:
1476
1477-> { "execute": "set_password", "arguments": { "protocol": "vnc",
1478 "password": "secret" } }
1479<- { "return": {} }
1480
1481EQMP
1482
1483 {
1484 .name = "expire_password",
1485 .args_type = "protocol:s,time:s",
Luiz Capitulino9ad53722011-12-07 11:47:57 -02001486 .mhandler.cmd_new = qmp_marshal_input_expire_password,
Gerd Hoffmann75721502010-10-07 12:22:54 +02001487 },
1488
1489SQMP
1490expire_password
1491---------------
1492
1493Set the password expire time for vnc/spice protocols.
1494
1495Arguments:
1496
1497- "protocol": protocol name (json-string)
1498- "time": [ now | never | +secs | secs ] (json-string)
1499
1500Example:
1501
1502-> { "execute": "expire_password", "arguments": { "protocol": "vnc",
1503 "time": "+60" } }
1504<- { "return": {} }
1505
1506EQMP
1507
1508 {
Daniel P. Berrange13661082011-06-23 13:31:42 +01001509 .name = "add_client",
Daniel P. Berrangef1f5f402012-02-13 13:43:08 +00001510 .args_type = "protocol:s,fdname:s,skipauth:b?,tls:b?",
Luiz Capitulinob224e5e2012-09-13 16:52:20 -03001511 .mhandler.cmd_new = qmp_marshal_input_add_client,
Daniel P. Berrange13661082011-06-23 13:31:42 +01001512 },
1513
1514SQMP
1515add_client
1516----------
1517
1518Add a graphics client
1519
1520Arguments:
1521
1522- "protocol": protocol name (json-string)
1523- "fdname": file descriptor name (json-string)
Daniel P. Berrangef1f5f402012-02-13 13:43:08 +00001524- "skipauth": whether to skip authentication (json-bool, optional)
1525- "tls": whether to perform TLS (json-bool, optional)
Daniel P. Berrange13661082011-06-23 13:31:42 +01001526
1527Example:
1528
1529-> { "execute": "add_client", "arguments": { "protocol": "vnc",
1530 "fdname": "myclient" } }
1531<- { "return": {} }
1532
1533EQMP
1534 {
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001535 .name = "qmp_capabilities",
1536 .args_type = "",
1537 .params = "",
1538 .help = "enable QMP capabilities",
1539 .user_print = monitor_user_noop,
1540 .mhandler.cmd_new = do_qmp_capabilities,
1541 },
1542
1543SQMP
1544qmp_capabilities
1545----------------
1546
1547Enable QMP capabilities.
1548
1549Arguments: None.
1550
1551Example:
1552
1553-> { "execute": "qmp_capabilities" }
1554<- { "return": {} }
1555
1556Note: This command must be issued before issuing any other command.
1557
Luiz Capitulino0268d972010-10-22 10:08:02 -02001558EQMP
1559
1560 {
1561 .name = "human-monitor-command",
1562 .args_type = "command-line:s,cpu-index:i?",
Luiz Capitulinod51a67b2011-11-25 17:52:45 -02001563 .mhandler.cmd_new = qmp_marshal_input_human_monitor_command,
Luiz Capitulino0268d972010-10-22 10:08:02 -02001564 },
1565
1566SQMP
1567human-monitor-command
1568---------------------
1569
1570Execute a Human Monitor command.
1571
1572Arguments:
1573
1574- command-line: the command name and its arguments, just like the
1575 Human Monitor's shell (json-string)
1576- cpu-index: select the CPU number to be used by commands which access CPU
1577 data, like 'info registers'. The Monitor selects CPU 0 if this
1578 argument is not provided (json-int, optional)
1579
1580Example:
1581
1582-> { "execute": "human-monitor-command", "arguments": { "command-line": "info kvm" } }
1583<- { "return": "kvm support: enabled\r\n" }
1584
1585Notes:
1586
1587(1) The Human Monitor is NOT an stable interface, this means that command
1588 names, arguments and responses can change or be removed at ANY time.
1589 Applications that rely on long term stability guarantees should NOT
1590 use this command
1591
1592(2) Limitations:
1593
1594 o This command is stateless, this means that commands that depend
1595 on state information (such as getfd) might not work
1596
1597 o Commands that prompt the user for data (eg. 'cont' when the block
1598 device is encrypted) don't currently work
1599
Luiz Capitulino82a56f02010-09-13 12:26:00 -030016003. Query Commands
1601=================
1602
1603HXCOMM Each query command below is inside a SQMP/EQMP section, do NOT change
1604HXCOMM this! We will possibly move query commands definitions inside those
1605HXCOMM sections, just like regular commands.
1606
1607EQMP
1608
1609SQMP
1610query-version
1611-------------
1612
1613Show QEMU version.
1614
1615Return a json-object with the following information:
1616
1617- "qemu": A json-object containing three integer values:
1618 - "major": QEMU's major version (json-int)
1619 - "minor": QEMU's minor version (json-int)
1620 - "micro": QEMU's micro version (json-int)
1621- "package": package's version (json-string)
1622
1623Example:
1624
1625-> { "execute": "query-version" }
1626<- {
1627 "return":{
1628 "qemu":{
1629 "major":0,
1630 "minor":11,
1631 "micro":5
1632 },
1633 "package":""
1634 }
1635 }
1636
1637EQMP
1638
Luiz Capitulinob9c15f12011-08-26 17:38:13 -03001639 {
1640 .name = "query-version",
1641 .args_type = "",
1642 .mhandler.cmd_new = qmp_marshal_input_query_version,
1643 },
1644
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001645SQMP
1646query-commands
1647--------------
1648
1649List QMP available commands.
1650
1651Each command is represented by a json-object, the returned value is a json-array
1652of all commands.
1653
1654Each json-object contain:
1655
1656- "name": command's name (json-string)
1657
1658Example:
1659
1660-> { "execute": "query-commands" }
1661<- {
1662 "return":[
1663 {
1664 "name":"query-balloon"
1665 },
1666 {
1667 "name":"system_powerdown"
1668 }
1669 ]
1670 }
1671
1672Note: This example has been shortened as the real response is too long.
1673
1674EQMP
1675
Luiz Capitulinoaa9b79b2011-09-21 14:31:51 -03001676 {
1677 .name = "query-commands",
1678 .args_type = "",
1679 .mhandler.cmd_new = qmp_marshal_input_query_commands,
1680 },
1681
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001682SQMP
Daniel P. Berrange48608532012-05-21 17:59:51 +01001683query-events
1684--------------
1685
1686List QMP available events.
1687
1688Each event is represented by a json-object, the returned value is a json-array
1689of all events.
1690
1691Each json-object contains:
1692
1693- "name": event's name (json-string)
1694
1695Example:
1696
1697-> { "execute": "query-events" }
1698<- {
1699 "return":[
1700 {
1701 "name":"SHUTDOWN"
1702 },
1703 {
1704 "name":"RESET"
1705 }
1706 ]
1707 }
1708
1709Note: This example has been shortened as the real response is too long.
1710
1711EQMP
1712
1713 {
1714 .name = "query-events",
1715 .args_type = "",
1716 .mhandler.cmd_new = qmp_marshal_input_query_events,
1717 },
1718
1719SQMP
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001720query-chardev
1721-------------
1722
1723Each device is represented by a json-object. The returned value is a json-array
1724of all devices.
1725
1726Each json-object contain the following:
1727
1728- "label": device's label (json-string)
1729- "filename": device's file (json-string)
1730
1731Example:
1732
1733-> { "execute": "query-chardev" }
1734<- {
1735 "return":[
1736 {
1737 "label":"monitor",
1738 "filename":"stdio"
1739 },
1740 {
1741 "label":"serial0",
1742 "filename":"vc"
1743 }
1744 ]
1745 }
1746
1747EQMP
1748
Luiz Capitulinoc5a415a2011-09-14 16:05:49 -03001749 {
1750 .name = "query-chardev",
1751 .args_type = "",
1752 .mhandler.cmd_new = qmp_marshal_input_query_chardev,
1753 },
1754
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001755SQMP
1756query-block
1757-----------
1758
1759Show the block devices.
1760
1761Each block device information is stored in a json-object and the returned value
1762is a json-array of all devices.
1763
1764Each json-object contain the following:
1765
1766- "device": device name (json-string)
1767- "type": device type (json-string)
Markus Armbrusterd8aeeb32011-05-16 15:04:55 +02001768 - deprecated, retained for backward compatibility
1769 - Possible values: "unknown"
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001770- "removable": true if the device is removable, false otherwise (json-bool)
1771- "locked": true if the device is locked, false otherwise (json-bool)
Michal Privoznik99f42802013-01-29 17:58:41 +01001772- "tray_open": only present if removable, true if the device has a tray,
Markus Armbrustere4def802011-09-06 18:58:53 +02001773 and it is open (json-bool)
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001774- "inserted": only present if the device is inserted, it is a json-object
1775 containing the following:
1776 - "file": device file name (json-string)
1777 - "ro": true if read-only, false otherwise (json-bool)
1778 - "drv": driver format name (json-string)
1779 - Possible values: "blkdebug", "bochs", "cloop", "cow", "dmg",
1780 "file", "file", "ftp", "ftps", "host_cdrom",
1781 "host_device", "host_floppy", "http", "https",
1782 "nbd", "parallels", "qcow", "qcow2", "raw",
1783 "tftp", "vdi", "vmdk", "vpc", "vvfat"
1784 - "backing_file": backing file name (json-string, optional)
Benoît Canet2e3e3312012-08-02 10:22:48 +02001785 - "backing_file_depth": number of files in the backing file chain (json-int)
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001786 - "encrypted": true if encrypted, false otherwise (json-bool)
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001787 - "bps": limit total bytes per second (json-int)
1788 - "bps_rd": limit read bytes per second (json-int)
1789 - "bps_wr": limit write bytes per second (json-int)
1790 - "iops": limit total I/O operations per second (json-int)
1791 - "iops_rd": limit read operations per second (json-int)
1792 - "iops_wr": limit write operations per second (json-int)
Benoît Canet3e9fab62013-09-02 14:14:40 +02001793 - "bps_max": total max in bytes (json-int)
1794 - "bps_rd_max": read max in bytes (json-int)
1795 - "bps_wr_max": write max in bytes (json-int)
1796 - "iops_max": total I/O operations max (json-int)
1797 - "iops_rd_max": read I/O operations max (json-int)
1798 - "iops_wr_max": write I/O operations max (json-int)
Benoît Canet2024c1d2013-09-02 14:14:41 +02001799 - "iops_size": I/O size when limiting by iops (json-int)
Wenchao Xia553a7e82013-06-06 12:27:59 +08001800 - "image": the detail of the image, it is a json-object containing
1801 the following:
1802 - "filename": image file name (json-string)
1803 - "format": image format (json-string)
1804 - "virtual-size": image capacity in bytes (json-int)
1805 - "dirty-flag": true if image is not cleanly closed, not present
1806 means clean (json-bool, optional)
1807 - "actual-size": actual size on disk in bytes of the image, not
1808 present when image does not support thin
1809 provision (json-int, optional)
1810 - "cluster-size": size of a cluster in bytes, not present if image
1811 format does not support it (json-int, optional)
1812 - "encrypted": true if the image is encrypted, not present means
1813 false or the image format does not support
1814 encryption (json-bool, optional)
1815 - "backing_file": backing file name, not present means no backing
1816 file is used or the image format does not
1817 support backing file chain
1818 (json-string, optional)
1819 - "full-backing-filename": full path of the backing file, not
1820 present if it equals backing_file or no
1821 backing file is used
1822 (json-string, optional)
1823 - "backing-filename-format": the format of the backing file, not
1824 present means unknown or no backing
1825 file (json-string, optional)
1826 - "snapshots": the internal snapshot info, it is an optional list
1827 of json-object containing the following:
1828 - "id": unique snapshot id (json-string)
1829 - "name": snapshot name (json-string)
1830 - "vm-state-size": size of the VM state in bytes (json-int)
1831 - "date-sec": UTC date of the snapshot in seconds (json-int)
1832 - "date-nsec": fractional part in nanoseconds to be used with
Eric Blake586b5462013-08-30 14:44:11 -06001833 date-sec (json-int)
Wenchao Xia553a7e82013-06-06 12:27:59 +08001834 - "vm-clock-sec": VM clock relative to boot in seconds
1835 (json-int)
1836 - "vm-clock-nsec": fractional part in nanoseconds to be used
1837 with vm-clock-sec (json-int)
1838 - "backing-image": the detail of the backing image, it is an
1839 optional json-object only present when a
1840 backing image present for this image
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001841
Luiz Capitulinof04ef602011-09-26 17:43:54 -03001842- "io-status": I/O operation status, only present if the device supports it
1843 and the VM is configured to stop on errors. It's always reset
1844 to "ok" when the "cont" command is issued (json_string, optional)
1845 - Possible values: "ok", "failed", "nospace"
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001846
1847Example:
1848
1849-> { "execute": "query-block" }
1850<- {
1851 "return":[
1852 {
Luiz Capitulinof04ef602011-09-26 17:43:54 -03001853 "io-status": "ok",
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001854 "device":"ide0-hd0",
1855 "locked":false,
1856 "removable":false,
1857 "inserted":{
1858 "ro":false,
1859 "drv":"qcow2",
1860 "encrypted":false,
Wenchao Xia553a7e82013-06-06 12:27:59 +08001861 "file":"disks/test.qcow2",
1862 "backing_file_depth":1,
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001863 "bps":1000000,
1864 "bps_rd":0,
1865 "bps_wr":0,
1866 "iops":1000000,
1867 "iops_rd":0,
1868 "iops_wr":0,
Benoît Canet3e9fab62013-09-02 14:14:40 +02001869 "bps_max": 8000000,
1870 "bps_rd_max": 0,
1871 "bps_wr_max": 0,
1872 "iops_max": 0,
1873 "iops_rd_max": 0,
1874 "iops_wr_max": 0,
Benoît Canet2024c1d2013-09-02 14:14:41 +02001875 "iops_size": 0,
Wenchao Xia553a7e82013-06-06 12:27:59 +08001876 "image":{
1877 "filename":"disks/test.qcow2",
1878 "format":"qcow2",
1879 "virtual-size":2048000,
1880 "backing_file":"base.qcow2",
1881 "full-backing-filename":"disks/base.qcow2",
1882 "backing-filename-format:"qcow2",
1883 "snapshots":[
1884 {
1885 "id": "1",
1886 "name": "snapshot1",
1887 "vm-state-size": 0,
1888 "date-sec": 10000200,
1889 "date-nsec": 12,
1890 "vm-clock-sec": 206,
1891 "vm-clock-nsec": 30
1892 }
1893 ],
1894 "backing-image":{
1895 "filename":"disks/base.qcow2",
1896 "format":"qcow2",
1897 "virtual-size":2048000
1898 }
1899 }
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001900 },
Markus Armbrusterd8aeeb32011-05-16 15:04:55 +02001901 "type":"unknown"
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001902 },
1903 {
Luiz Capitulinof04ef602011-09-26 17:43:54 -03001904 "io-status": "ok",
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001905 "device":"ide1-cd0",
1906 "locked":false,
1907 "removable":true,
Markus Armbrusterd8aeeb32011-05-16 15:04:55 +02001908 "type":"unknown"
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001909 },
1910 {
1911 "device":"floppy0",
1912 "locked":false,
1913 "removable":true,
Markus Armbrusterd8aeeb32011-05-16 15:04:55 +02001914 "type":"unknown"
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001915 },
1916 {
1917 "device":"sd0",
1918 "locked":false,
1919 "removable":true,
Markus Armbrusterd8aeeb32011-05-16 15:04:55 +02001920 "type":"unknown"
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001921 }
1922 ]
1923 }
1924
1925EQMP
1926
Luiz Capitulinob2023812011-09-21 17:16:47 -03001927 {
1928 .name = "query-block",
1929 .args_type = "",
1930 .mhandler.cmd_new = qmp_marshal_input_query_block,
1931 },
1932
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001933SQMP
1934query-blockstats
1935----------------
1936
1937Show block device statistics.
1938
1939Each device statistic information is stored in a json-object and the returned
1940value is a json-array of all devices.
1941
1942Each json-object contain the following:
1943
1944- "device": device name (json-string)
1945- "stats": A json-object with the statistics information, it contains:
1946 - "rd_bytes": bytes read (json-int)
1947 - "wr_bytes": bytes written (json-int)
1948 - "rd_operations": read operations (json-int)
1949 - "wr_operations": write operations (json-int)
Christoph Hellwige8045d62011-08-22 00:25:58 +02001950 - "flush_operations": cache flush operations (json-int)
Christoph Hellwigc488c7f2011-08-25 08:26:10 +02001951 - "wr_total_time_ns": total time spend on writes in nano-seconds (json-int)
1952 - "rd_total_time_ns": total time spend on reads in nano-seconds (json-int)
1953 - "flush_total_time_ns": total time spend on cache flushes in nano-seconds (json-int)
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001954 - "wr_highest_offset": Highest offset of a sector written since the
1955 BlockDriverState has been opened (json-int)
1956- "parent": Contains recursively the statistics of the underlying
1957 protocol (e.g. the host file for a qcow2 image). If there is
1958 no underlying protocol, this field is omitted
1959 (json-object, optional)
1960
1961Example:
1962
1963-> { "execute": "query-blockstats" }
1964<- {
1965 "return":[
1966 {
1967 "device":"ide0-hd0",
1968 "parent":{
1969 "stats":{
1970 "wr_highest_offset":3686448128,
1971 "wr_bytes":9786368,
1972 "wr_operations":751,
1973 "rd_bytes":122567168,
1974 "rd_operations":36772
Christoph Hellwigc488c7f2011-08-25 08:26:10 +02001975 "wr_total_times_ns":313253456
1976 "rd_total_times_ns":3465673657
1977 "flush_total_times_ns":49653
Christoph Hellwige8045d62011-08-22 00:25:58 +02001978 "flush_operations":61,
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001979 }
1980 },
1981 "stats":{
1982 "wr_highest_offset":2821110784,
1983 "wr_bytes":9786368,
1984 "wr_operations":692,
1985 "rd_bytes":122739200,
1986 "rd_operations":36604
Christoph Hellwige8045d62011-08-22 00:25:58 +02001987 "flush_operations":51,
Christoph Hellwigc488c7f2011-08-25 08:26:10 +02001988 "wr_total_times_ns":313253456
1989 "rd_total_times_ns":3465673657
1990 "flush_total_times_ns":49653
Luiz Capitulino82a56f02010-09-13 12:26:00 -03001991 }
1992 },
1993 {
1994 "device":"ide1-cd0",
1995 "stats":{
1996 "wr_highest_offset":0,
1997 "wr_bytes":0,
1998 "wr_operations":0,
1999 "rd_bytes":0,
2000 "rd_operations":0
Christoph Hellwige8045d62011-08-22 00:25:58 +02002001 "flush_operations":0,
Christoph Hellwigc488c7f2011-08-25 08:26:10 +02002002 "wr_total_times_ns":0
2003 "rd_total_times_ns":0
2004 "flush_total_times_ns":0
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002005 }
2006 },
2007 {
2008 "device":"floppy0",
2009 "stats":{
2010 "wr_highest_offset":0,
2011 "wr_bytes":0,
2012 "wr_operations":0,
2013 "rd_bytes":0,
2014 "rd_operations":0
Christoph Hellwige8045d62011-08-22 00:25:58 +02002015 "flush_operations":0,
Christoph Hellwigc488c7f2011-08-25 08:26:10 +02002016 "wr_total_times_ns":0
2017 "rd_total_times_ns":0
2018 "flush_total_times_ns":0
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002019 }
2020 },
2021 {
2022 "device":"sd0",
2023 "stats":{
2024 "wr_highest_offset":0,
2025 "wr_bytes":0,
2026 "wr_operations":0,
2027 "rd_bytes":0,
2028 "rd_operations":0
Christoph Hellwige8045d62011-08-22 00:25:58 +02002029 "flush_operations":0,
Christoph Hellwigc488c7f2011-08-25 08:26:10 +02002030 "wr_total_times_ns":0
2031 "rd_total_times_ns":0
2032 "flush_total_times_ns":0
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002033 }
2034 }
2035 ]
2036 }
2037
2038EQMP
2039
Luiz Capitulinof11f57e2011-09-22 15:56:36 -03002040 {
2041 .name = "query-blockstats",
2042 .args_type = "",
2043 .mhandler.cmd_new = qmp_marshal_input_query_blockstats,
2044 },
2045
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002046SQMP
2047query-cpus
2048----------
2049
2050Show CPU information.
2051
2052Return a json-array. Each CPU is represented by a json-object, which contains:
2053
2054- "CPU": CPU index (json-int)
2055- "current": true if this is the current CPU, false otherwise (json-bool)
2056- "halted": true if the cpu is halted, false otherwise (json-bool)
2057- Current program counter. The key's name depends on the architecture:
2058 "pc": i386/x86_64 (json-int)
2059 "nip": PPC (json-int)
2060 "pc" and "npc": sparc (json-int)
2061 "PC": mips (json-int)
Jan Kiszkadc7a09c2011-03-15 12:26:31 +01002062- "thread_id": ID of the underlying host thread (json-int)
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002063
2064Example:
2065
2066-> { "execute": "query-cpus" }
2067<- {
2068 "return":[
2069 {
2070 "CPU":0,
2071 "current":true,
2072 "halted":false,
2073 "pc":3227107138
Jan Kiszkadc7a09c2011-03-15 12:26:31 +01002074 "thread_id":3134
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002075 },
2076 {
2077 "CPU":1,
2078 "current":false,
2079 "halted":true,
2080 "pc":7108165
Jan Kiszkadc7a09c2011-03-15 12:26:31 +01002081 "thread_id":3135
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002082 }
2083 ]
2084 }
2085
2086EQMP
2087
Luiz Capitulinode0b36b2011-09-21 16:38:35 -03002088 {
2089 .name = "query-cpus",
2090 .args_type = "",
2091 .mhandler.cmd_new = qmp_marshal_input_query_cpus,
2092 },
2093
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002094SQMP
2095query-pci
2096---------
2097
2098PCI buses and devices information.
2099
2100The returned value is a json-array of all buses. Each bus is represented by
2101a json-object, which has a key with a json-array of all PCI devices attached
2102to it. Each device is represented by a json-object.
2103
2104The bus json-object contains the following:
2105
2106- "bus": bus number (json-int)
2107- "devices": a json-array of json-objects, each json-object represents a
2108 PCI device
2109
2110The PCI device json-object contains the following:
2111
2112- "bus": identical to the parent's bus number (json-int)
2113- "slot": slot number (json-int)
2114- "function": function number (json-int)
2115- "class_info": a json-object containing:
2116 - "desc": device class description (json-string, optional)
2117 - "class": device class number (json-int)
2118- "id": a json-object containing:
2119 - "device": device ID (json-int)
2120 - "vendor": vendor ID (json-int)
2121- "irq": device's IRQ if assigned (json-int, optional)
2122- "qdev_id": qdev id string (json-string)
2123- "pci_bridge": It's a json-object, only present if this device is a
2124 PCI bridge, contains:
2125 - "bus": bus number (json-int)
2126 - "secondary": secondary bus number (json-int)
2127 - "subordinate": subordinate bus number (json-int)
2128 - "io_range": I/O memory range information, a json-object with the
2129 following members:
2130 - "base": base address, in bytes (json-int)
2131 - "limit": limit address, in bytes (json-int)
2132 - "memory_range": memory range information, a json-object with the
2133 following members:
2134 - "base": base address, in bytes (json-int)
2135 - "limit": limit address, in bytes (json-int)
2136 - "prefetchable_range": Prefetchable memory range information, a
2137 json-object with the following members:
2138 - "base": base address, in bytes (json-int)
2139 - "limit": limit address, in bytes (json-int)
2140 - "devices": a json-array of PCI devices if there's any attached, each
2141 each element is represented by a json-object, which contains
2142 the same members of the 'PCI device json-object' described
2143 above (optional)
2144- "regions": a json-array of json-objects, each json-object represents a
2145 memory region of this device
2146
2147The memory range json-object contains the following:
2148
2149- "base": base memory address (json-int)
2150- "limit": limit value (json-int)
2151
2152The region json-object can be an I/O region or a memory region, an I/O region
2153json-object contains the following:
2154
2155- "type": "io" (json-string, fixed)
2156- "bar": BAR number (json-int)
2157- "address": memory address (json-int)
2158- "size": memory size (json-int)
2159
2160A memory region json-object contains the following:
2161
2162- "type": "memory" (json-string, fixed)
2163- "bar": BAR number (json-int)
2164- "address": memory address (json-int)
2165- "size": memory size (json-int)
2166- "mem_type_64": true or false (json-bool)
2167- "prefetch": true or false (json-bool)
2168
2169Example:
2170
2171-> { "execute": "query-pci" }
2172<- {
2173 "return":[
2174 {
2175 "bus":0,
2176 "devices":[
2177 {
2178 "bus":0,
2179 "qdev_id":"",
2180 "slot":0,
2181 "class_info":{
2182 "class":1536,
2183 "desc":"Host bridge"
2184 },
2185 "id":{
2186 "device":32902,
2187 "vendor":4663
2188 },
2189 "function":0,
2190 "regions":[
2191
2192 ]
2193 },
2194 {
2195 "bus":0,
2196 "qdev_id":"",
2197 "slot":1,
2198 "class_info":{
2199 "class":1537,
2200 "desc":"ISA bridge"
2201 },
2202 "id":{
2203 "device":32902,
2204 "vendor":28672
2205 },
2206 "function":0,
2207 "regions":[
2208
2209 ]
2210 },
2211 {
2212 "bus":0,
2213 "qdev_id":"",
2214 "slot":1,
2215 "class_info":{
2216 "class":257,
2217 "desc":"IDE controller"
2218 },
2219 "id":{
2220 "device":32902,
2221 "vendor":28688
2222 },
2223 "function":1,
2224 "regions":[
2225 {
2226 "bar":4,
2227 "size":16,
2228 "address":49152,
2229 "type":"io"
2230 }
2231 ]
2232 },
2233 {
2234 "bus":0,
2235 "qdev_id":"",
2236 "slot":2,
2237 "class_info":{
2238 "class":768,
2239 "desc":"VGA controller"
2240 },
2241 "id":{
2242 "device":4115,
2243 "vendor":184
2244 },
2245 "function":0,
2246 "regions":[
2247 {
2248 "prefetch":true,
2249 "mem_type_64":false,
2250 "bar":0,
2251 "size":33554432,
2252 "address":4026531840,
2253 "type":"memory"
2254 },
2255 {
2256 "prefetch":false,
2257 "mem_type_64":false,
2258 "bar":1,
2259 "size":4096,
2260 "address":4060086272,
2261 "type":"memory"
2262 },
2263 {
2264 "prefetch":false,
2265 "mem_type_64":false,
2266 "bar":6,
2267 "size":65536,
2268 "address":-1,
2269 "type":"memory"
2270 }
2271 ]
2272 },
2273 {
2274 "bus":0,
2275 "qdev_id":"",
2276 "irq":11,
2277 "slot":4,
2278 "class_info":{
2279 "class":1280,
2280 "desc":"RAM controller"
2281 },
2282 "id":{
2283 "device":6900,
2284 "vendor":4098
2285 },
2286 "function":0,
2287 "regions":[
2288 {
2289 "bar":0,
2290 "size":32,
2291 "address":49280,
2292 "type":"io"
2293 }
2294 ]
2295 }
2296 ]
2297 }
2298 ]
2299 }
2300
2301Note: This example has been shortened as the real response is too long.
2302
2303EQMP
2304
Luiz Capitulino79627472011-10-21 14:15:33 -02002305 {
2306 .name = "query-pci",
2307 .args_type = "",
2308 .mhandler.cmd_new = qmp_marshal_input_query_pci,
2309 },
2310
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002311SQMP
2312query-kvm
2313---------
2314
2315Show KVM information.
2316
2317Return a json-object with the following information:
2318
2319- "enabled": true if KVM support is enabled, false otherwise (json-bool)
2320- "present": true if QEMU has KVM support, false otherwise (json-bool)
2321
2322Example:
2323
2324-> { "execute": "query-kvm" }
2325<- { "return": { "enabled": true, "present": true } }
2326
2327EQMP
2328
Luiz Capitulino292a2602011-09-12 15:10:53 -03002329 {
2330 .name = "query-kvm",
2331 .args_type = "",
2332 .mhandler.cmd_new = qmp_marshal_input_query_kvm,
2333 },
2334
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002335SQMP
2336query-status
2337------------
2338
2339Return a json-object with the following information:
2340
2341- "running": true if the VM is running, or false if it is paused (json-bool)
2342- "singlestep": true if the VM is in single step mode,
2343 false otherwise (json-bool)
Luiz Capitulino9e37b9d2011-08-29 16:02:57 -03002344- "status": one of the following values (json-string)
2345 "debug" - QEMU is running on a debugger
2346 "inmigrate" - guest is paused waiting for an incoming migration
2347 "internal-error" - An internal error that prevents further guest
2348 execution has occurred
2349 "io-error" - the last IOP has failed and the device is configured
2350 to pause on I/O errors
2351 "paused" - guest has been paused via the 'stop' command
2352 "postmigrate" - guest is paused following a successful 'migrate'
2353 "prelaunch" - QEMU was started with -S and guest has not started
2354 "finish-migrate" - guest is paused to finish the migration process
2355 "restore-vm" - guest is paused to restore VM state
2356 "running" - guest is actively running
2357 "save-vm" - guest is paused to save the VM state
2358 "shutdown" - guest is shut down (and -no-shutdown is in use)
2359 "watchdog" - the watchdog action is configured to pause and
2360 has been triggered
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002361
2362Example:
2363
2364-> { "execute": "query-status" }
Luiz Capitulino9e37b9d2011-08-29 16:02:57 -03002365<- { "return": { "running": true, "singlestep": false, "status": "running" } }
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002366
2367EQMP
Luiz Capitulino1fa9a5e2011-09-12 17:54:20 -03002368
2369 {
2370 .name = "query-status",
2371 .args_type = "",
2372 .mhandler.cmd_new = qmp_marshal_input_query_status,
2373 },
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002374
2375SQMP
2376query-mice
2377----------
2378
2379Show VM mice information.
2380
2381Each mouse is represented by a json-object, the returned value is a json-array
2382of all mice.
2383
2384The mouse json-object contains the following:
2385
2386- "name": mouse's name (json-string)
2387- "index": mouse's index (json-int)
2388- "current": true if this mouse is receiving events, false otherwise (json-bool)
2389- "absolute": true if the mouse generates absolute input events (json-bool)
2390
2391Example:
2392
2393-> { "execute": "query-mice" }
2394<- {
2395 "return":[
2396 {
2397 "name":"QEMU Microsoft Mouse",
2398 "index":0,
2399 "current":false,
2400 "absolute":false
2401 },
2402 {
2403 "name":"QEMU PS/2 Mouse",
2404 "index":1,
2405 "current":true,
2406 "absolute":true
2407 }
2408 ]
2409 }
2410
2411EQMP
2412
Luiz Capitulinoe235cec2011-09-21 15:29:55 -03002413 {
2414 .name = "query-mice",
2415 .args_type = "",
2416 .mhandler.cmd_new = qmp_marshal_input_query_mice,
2417 },
2418
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002419SQMP
2420query-vnc
2421---------
2422
2423Show VNC server information.
2424
2425Return a json-object with server information. Connected clients are returned
2426as a json-array of json-objects.
2427
2428The main json-object contains the following:
2429
2430- "enabled": true or false (json-bool)
2431- "host": server's IP address (json-string)
2432- "family": address family (json-string)
2433 - Possible values: "ipv4", "ipv6", "unix", "unknown"
2434- "service": server's port number (json-string)
2435- "auth": authentication method (json-string)
2436 - Possible values: "invalid", "none", "ra2", "ra2ne", "sasl", "tight",
2437 "tls", "ultra", "unknown", "vencrypt", "vencrypt",
2438 "vencrypt+plain", "vencrypt+tls+none",
2439 "vencrypt+tls+plain", "vencrypt+tls+sasl",
2440 "vencrypt+tls+vnc", "vencrypt+x509+none",
2441 "vencrypt+x509+plain", "vencrypt+x509+sasl",
2442 "vencrypt+x509+vnc", "vnc"
2443- "clients": a json-array of all connected clients
2444
2445Clients are described by a json-object, each one contain the following:
2446
2447- "host": client's IP address (json-string)
2448- "family": address family (json-string)
2449 - Possible values: "ipv4", "ipv6", "unix", "unknown"
2450- "service": client's port number (json-string)
2451- "x509_dname": TLS dname (json-string, optional)
2452- "sasl_username": SASL username (json-string, optional)
2453
2454Example:
2455
2456-> { "execute": "query-vnc" }
2457<- {
2458 "return":{
2459 "enabled":true,
2460 "host":"0.0.0.0",
2461 "service":"50402",
2462 "auth":"vnc",
2463 "family":"ipv4",
2464 "clients":[
2465 {
2466 "host":"127.0.0.1",
2467 "service":"50401",
2468 "family":"ipv4"
2469 }
2470 ]
2471 }
2472 }
2473
2474EQMP
2475
Luiz Capitulino2b54aa82011-10-17 16:41:22 -02002476 {
2477 .name = "query-vnc",
2478 .args_type = "",
2479 .mhandler.cmd_new = qmp_marshal_input_query_vnc,
2480 },
2481
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002482SQMP
Gerd Hoffmanncb42a872010-11-30 11:02:51 +01002483query-spice
2484-----------
2485
2486Show SPICE server information.
2487
2488Return a json-object with server information. Connected clients are returned
2489as a json-array of json-objects.
2490
2491The main json-object contains the following:
2492
2493- "enabled": true or false (json-bool)
2494- "host": server's IP address (json-string)
2495- "port": server's port number (json-int, optional)
2496- "tls-port": server's port number (json-int, optional)
2497- "auth": authentication method (json-string)
2498 - Possible values: "none", "spice"
2499- "channels": a json-array of all active channels clients
2500
2501Channels are described by a json-object, each one contain the following:
2502
2503- "host": client's IP address (json-string)
2504- "family": address family (json-string)
2505 - Possible values: "ipv4", "ipv6", "unix", "unknown"
2506- "port": client's port number (json-string)
2507- "connection-id": spice connection id. All channels with the same id
2508 belong to the same spice session (json-int)
2509- "channel-type": channel type. "1" is the main control channel, filter for
2510 this one if you want track spice sessions only (json-int)
2511- "channel-id": channel id. Usually "0", might be different needed when
2512 multiple channels of the same type exist, such as multiple
2513 display channels in a multihead setup (json-int)
2514- "tls": whevener the channel is encrypted (json-bool)
2515
2516Example:
2517
2518-> { "execute": "query-spice" }
2519<- {
2520 "return": {
2521 "enabled": true,
2522 "auth": "spice",
2523 "port": 5920,
2524 "tls-port": 5921,
2525 "host": "0.0.0.0",
2526 "channels": [
2527 {
2528 "port": "54924",
2529 "family": "ipv4",
2530 "channel-type": 1,
2531 "connection-id": 1804289383,
2532 "host": "127.0.0.1",
2533 "channel-id": 0,
2534 "tls": true
2535 },
2536 {
2537 "port": "36710",
2538 "family": "ipv4",
2539 "channel-type": 4,
2540 "connection-id": 1804289383,
2541 "host": "127.0.0.1",
2542 "channel-id": 0,
2543 "tls": false
2544 },
2545 [ ... more channels follow ... ]
2546 ]
2547 }
2548 }
2549
2550EQMP
2551
Luiz Capitulinod1f29642011-10-20 17:01:33 -02002552#if defined(CONFIG_SPICE)
2553 {
2554 .name = "query-spice",
2555 .args_type = "",
2556 .mhandler.cmd_new = qmp_marshal_input_query_spice,
2557 },
2558#endif
2559
Gerd Hoffmanncb42a872010-11-30 11:02:51 +01002560SQMP
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002561query-name
2562----------
2563
2564Show VM name.
2565
2566Return a json-object with the following information:
2567
2568- "name": VM's name (json-string, optional)
2569
2570Example:
2571
2572-> { "execute": "query-name" }
2573<- { "return": { "name": "qemu-name" } }
2574
2575EQMP
2576
Anthony Liguori48a32be2011-09-02 12:34:48 -05002577 {
2578 .name = "query-name",
2579 .args_type = "",
2580 .mhandler.cmd_new = qmp_marshal_input_query_name,
2581 },
2582
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002583SQMP
2584query-uuid
2585----------
2586
2587Show VM UUID.
2588
2589Return a json-object with the following information:
2590
2591- "UUID": Universally Unique Identifier (json-string)
2592
2593Example:
2594
2595-> { "execute": "query-uuid" }
2596<- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } }
2597
2598EQMP
2599
Luiz Capitulinoefab7672011-09-13 17:16:25 -03002600 {
2601 .name = "query-uuid",
2602 .args_type = "",
2603 .mhandler.cmd_new = qmp_marshal_input_query_uuid,
2604 },
2605
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002606SQMP
Amos Kong1f8f9872013-04-25 17:50:35 +08002607query-command-line-options
2608--------------------------
2609
2610Show command line option schema.
2611
2612Return a json-array of command line option schema for all options (or for
2613the given option), returning an error if the given option doesn't exist.
2614
2615Each array entry contains the following:
2616
2617- "option": option name (json-string)
2618- "parameters": a json-array describes all parameters of the option:
2619 - "name": parameter name (json-string)
2620 - "type": parameter type (one of 'string', 'boolean', 'number',
2621 or 'size')
2622 - "help": human readable description of the parameter
2623 (json-string, optional)
2624
2625Example:
2626
2627-> { "execute": "query-command-line-options", "arguments": { "option": "option-rom" } }
2628<- { "return": [
2629 {
2630 "parameters": [
2631 {
2632 "name": "romfile",
2633 "type": "string"
2634 },
2635 {
2636 "name": "bootindex",
2637 "type": "number"
2638 }
2639 ],
2640 "option": "option-rom"
2641 }
2642 ]
2643 }
2644
2645EQMP
2646
2647 {
2648 .name = "query-command-line-options",
2649 .args_type = "option:s?",
2650 .mhandler.cmd_new = qmp_marshal_input_query_command_line_options,
2651 },
2652
2653SQMP
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002654query-migrate
2655-------------
2656
2657Migration status.
2658
2659Return a json-object. If migration is active there will be another json-object
2660with RAM migration status and if block migration is active another one with
2661block migration status.
2662
2663The main json-object contains the following:
2664
2665- "status": migration status (json-string)
2666 - Possible values: "active", "completed", "failed", "cancelled"
Juan Quintela7aa939a2012-08-18 13:17:10 +02002667- "total-time": total amount of ms since migration started. If
2668 migration has ended, it returns the total migration
Juan Quintela817c6042013-02-11 15:11:10 +01002669 time (json-int)
Michael R. Hines8f3067b2013-08-09 16:05:45 -04002670- "setup-time" amount of setup time in milliseconds _before_ the
2671 iterations begin but _after_ the QMP command is issued.
2672 This is designed to provide an accounting of any activities
2673 (such as RDMA pinning) which may be expensive, but do not
2674 actually occur during the iterative migration rounds
2675 themselves. (json-int)
Juan Quintela9c5a9fc2012-08-13 09:35:16 +02002676- "downtime": only present when migration has finished correctly
2677 total amount in ms for downtime that happened (json-int)
Juan Quintela2c52ddf2012-08-13 09:53:12 +02002678- "expected-downtime": only present while migration is active
2679 total amount in ms for downtime that was calculated on
Juan Quintela817c6042013-02-11 15:11:10 +01002680 the last bitmap round (json-int)
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002681- "ram": only present if "status" is "active", it is a json-object with the
Juan Quintela817c6042013-02-11 15:11:10 +01002682 following RAM information:
2683 - "transferred": amount transferred in bytes (json-int)
2684 - "remaining": amount remaining to transfer in bytes (json-int)
2685 - "total": total amount of memory in bytes (json-int)
2686 - "duplicate": number of pages filled entirely with the same
2687 byte (json-int)
2688 These are sent over the wire much more efficiently.
Peter Lievenf1c72792013-03-26 10:58:37 +01002689 - "skipped": number of skipped zero pages (json-int)
Stefan Weil805a2502013-04-28 11:49:57 +02002690 - "normal" : number of whole pages transferred. I.e. they
Juan Quintela817c6042013-02-11 15:11:10 +01002691 were not sent as duplicate or xbzrle pages (json-int)
2692 - "normal-bytes" : number of bytes transferred in whole
2693 pages. This is just normal pages times size of one page,
2694 but this way upper levels don't need to care about page
2695 size (json-int)
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002696- "disk": only present if "status" is "active" and it is a block migration,
Juan Quintela817c6042013-02-11 15:11:10 +01002697 it is a json-object with the following disk information:
2698 - "transferred": amount transferred in bytes (json-int)
2699 - "remaining": amount remaining to transfer in bytes json-int)
2700 - "total": total disk size in bytes (json-int)
Orit Wassermanf36d55a2012-08-06 21:42:57 +03002701- "xbzrle-cache": only present if XBZRLE is active.
2702 It is a json-object with the following XBZRLE information:
Juan Quintela817c6042013-02-11 15:11:10 +01002703 - "cache-size": XBZRLE cache size in bytes
2704 - "bytes": number of bytes transferred for XBZRLE compressed pages
Orit Wassermanf36d55a2012-08-06 21:42:57 +03002705 - "pages": number of XBZRLE compressed pages
Juan Quintela817c6042013-02-11 15:11:10 +01002706 - "cache-miss": number of XBRZRLE page cache misses
2707 - "overflow": number of times XBZRLE overflows. This means
2708 that the XBZRLE encoding was bigger than just sent the
2709 whole page, and then we sent the whole page instead (as as
2710 normal page).
2711
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002712Examples:
2713
27141. Before the first migration
2715
2716-> { "execute": "query-migrate" }
2717<- { "return": {} }
2718
27192. Migration is done and has succeeded
2720
2721-> { "execute": "query-migrate" }
Orit Wasserman004d4c12012-08-06 21:42:56 +03002722<- { "return": {
2723 "status": "completed",
2724 "ram":{
2725 "transferred":123,
2726 "remaining":123,
2727 "total":246,
2728 "total-time":12345,
Michael R. Hines8f3067b2013-08-09 16:05:45 -04002729 "setup-time":12345,
Juan Quintela9c5a9fc2012-08-13 09:35:16 +02002730 "downtime":12345,
Orit Wasserman004d4c12012-08-06 21:42:56 +03002731 "duplicate":123,
2732 "normal":123,
2733 "normal-bytes":123456
2734 }
2735 }
2736 }
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002737
27383. Migration is done and has failed
2739
2740-> { "execute": "query-migrate" }
2741<- { "return": { "status": "failed" } }
2742
27434. Migration is being performed and is not a block migration:
2744
2745-> { "execute": "query-migrate" }
2746<- {
2747 "return":{
2748 "status":"active",
2749 "ram":{
2750 "transferred":123,
2751 "remaining":123,
Orit Wasserman62d4e3f2012-08-06 21:42:55 +03002752 "total":246,
Orit Wasserman004d4c12012-08-06 21:42:56 +03002753 "total-time":12345,
Michael R. Hines8f3067b2013-08-09 16:05:45 -04002754 "setup-time":12345,
Juan Quintela2c52ddf2012-08-13 09:53:12 +02002755 "expected-downtime":12345,
Orit Wasserman004d4c12012-08-06 21:42:56 +03002756 "duplicate":123,
2757 "normal":123,
2758 "normal-bytes":123456
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002759 }
2760 }
2761 }
2762
27635. Migration is being performed and is a block migration:
2764
2765-> { "execute": "query-migrate" }
2766<- {
2767 "return":{
2768 "status":"active",
2769 "ram":{
2770 "total":1057024,
2771 "remaining":1053304,
Orit Wasserman62d4e3f2012-08-06 21:42:55 +03002772 "transferred":3720,
Orit Wasserman004d4c12012-08-06 21:42:56 +03002773 "total-time":12345,
Michael R. Hines8f3067b2013-08-09 16:05:45 -04002774 "setup-time":12345,
Juan Quintela2c52ddf2012-08-13 09:53:12 +02002775 "expected-downtime":12345,
Orit Wasserman004d4c12012-08-06 21:42:56 +03002776 "duplicate":123,
2777 "normal":123,
2778 "normal-bytes":123456
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002779 },
2780 "disk":{
2781 "total":20971520,
2782 "remaining":20880384,
2783 "transferred":91136
2784 }
2785 }
2786 }
2787
Orit Wassermanf36d55a2012-08-06 21:42:57 +030027886. Migration is being performed and XBZRLE is active:
2789
2790-> { "execute": "query-migrate" }
2791<- {
2792 "return":{
2793 "status":"active",
2794 "capabilities" : [ { "capability": "xbzrle", "state" : true } ],
2795 "ram":{
2796 "total":1057024,
2797 "remaining":1053304,
2798 "transferred":3720,
2799 "total-time":12345,
Michael R. Hines8f3067b2013-08-09 16:05:45 -04002800 "setup-time":12345,
Juan Quintela2c52ddf2012-08-13 09:53:12 +02002801 "expected-downtime":12345,
Orit Wassermanf36d55a2012-08-06 21:42:57 +03002802 "duplicate":10,
2803 "normal":3333,
2804 "normal-bytes":3412992
2805 },
2806 "xbzrle-cache":{
2807 "cache-size":67108864,
2808 "bytes":20971520,
2809 "pages":2444343,
2810 "cache-miss":2244,
2811 "overflow":34434
2812 }
2813 }
2814 }
2815
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002816EQMP
2817
Luiz Capitulino791e7c82011-09-13 17:37:16 -03002818 {
2819 .name = "query-migrate",
2820 .args_type = "",
2821 .mhandler.cmd_new = qmp_marshal_input_query_migrate,
2822 },
2823
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002824SQMP
Orit Wasserman00458432012-08-06 21:42:48 +03002825migrate-set-capabilities
Juan Quintela817c6042013-02-11 15:11:10 +01002826------------------------
Orit Wasserman00458432012-08-06 21:42:48 +03002827
2828Enable/Disable migration capabilities
2829
Juan Quintela817c6042013-02-11 15:11:10 +01002830- "xbzrle": XBZRLE support
Orit Wasserman00458432012-08-06 21:42:48 +03002831
2832Arguments:
2833
2834Example:
2835
2836-> { "execute": "migrate-set-capabilities" , "arguments":
2837 { "capabilities": [ { "capability": "xbzrle", "state": true } ] } }
2838
2839EQMP
2840
2841 {
2842 .name = "migrate-set-capabilities",
2843 .args_type = "capabilities:O",
2844 .params = "capability:s,state:b",
2845 .mhandler.cmd_new = qmp_marshal_input_migrate_set_capabilities,
2846 },
2847SQMP
Orit Wassermanbbf6da32012-08-06 21:42:47 +03002848query-migrate-capabilities
Juan Quintela817c6042013-02-11 15:11:10 +01002849--------------------------
Orit Wassermanbbf6da32012-08-06 21:42:47 +03002850
2851Query current migration capabilities
2852
2853- "capabilities": migration capabilities state
2854 - "xbzrle" : XBZRLE state (json-bool)
2855
2856Arguments:
2857
2858Example:
2859
2860-> { "execute": "query-migrate-capabilities" }
Orit Wassermandbca1b32013-01-31 09:12:17 +02002861<- { "return": [ { "state": false, "capability": "xbzrle" } ] }
2862
Orit Wassermanbbf6da32012-08-06 21:42:47 +03002863EQMP
2864
2865 {
2866 .name = "query-migrate-capabilities",
2867 .args_type = "",
2868 .mhandler.cmd_new = qmp_marshal_input_query_migrate_capabilities,
2869 },
2870
2871SQMP
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002872query-balloon
2873-------------
2874
2875Show balloon information.
2876
2877Make an asynchronous request for balloon info. When the request completes a
2878json-object will be returned containing the following data:
2879
2880- "actual": current balloon value in bytes (json-int)
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002881
2882Example:
2883
2884-> { "execute": "query-balloon" }
2885<- {
2886 "return":{
2887 "actual":1073741824,
Luiz Capitulino82a56f02010-09-13 12:26:00 -03002888 }
2889 }
2890
2891EQMP
2892
Luiz Capitulino96637bc2011-10-21 11:41:37 -02002893 {
2894 .name = "query-balloon",
2895 .args_type = "",
2896 .mhandler.cmd_new = qmp_marshal_input_query_balloon,
2897 },
Anthony Liguorib4b12c62011-12-12 14:29:34 -06002898
2899 {
Stefan Hajnoczifb5458c2012-01-18 14:40:49 +00002900 .name = "query-block-jobs",
2901 .args_type = "",
2902 .mhandler.cmd_new = qmp_marshal_input_query_block_jobs,
2903 },
2904
2905 {
Anthony Liguorib4b12c62011-12-12 14:29:34 -06002906 .name = "qom-list",
2907 .args_type = "path:s",
2908 .mhandler.cmd_new = qmp_marshal_input_qom_list,
2909 },
Anthony Liguorieb6e8ea2011-12-12 14:29:35 -06002910
2911 {
2912 .name = "qom-set",
Paolo Bonzinib9f89782012-03-22 12:51:11 +01002913 .args_type = "path:s,property:s,value:q",
Anthony Liguorieb6e8ea2011-12-12 14:29:35 -06002914 .mhandler.cmd_new = qmp_qom_set,
2915 },
2916
2917 {
2918 .name = "qom-get",
2919 .args_type = "path:s,property:s",
2920 .mhandler.cmd_new = qmp_qom_get,
2921 },
Luiz Capitulino270b2432011-12-08 11:45:55 -02002922
2923 {
Paolo Bonzini6dd844d2012-08-22 16:43:07 +02002924 .name = "nbd-server-start",
2925 .args_type = "addr:q",
2926 .mhandler.cmd_new = qmp_marshal_input_nbd_server_start,
2927 },
2928 {
2929 .name = "nbd-server-add",
2930 .args_type = "device:B,writable:b?",
2931 .mhandler.cmd_new = qmp_marshal_input_nbd_server_add,
2932 },
2933 {
2934 .name = "nbd-server-stop",
2935 .args_type = "",
2936 .mhandler.cmd_new = qmp_marshal_input_nbd_server_stop,
2937 },
2938
2939 {
Luiz Capitulino270b2432011-12-08 11:45:55 -02002940 .name = "change-vnc-password",
2941 .args_type = "password:s",
2942 .mhandler.cmd_new = qmp_marshal_input_change_vnc_password,
2943 },
Anthony Liguori5eeee3f2011-12-22 14:40:54 -06002944 {
2945 .name = "qom-list-types",
2946 .args_type = "implements:s?,abstract:b?",
2947 .mhandler.cmd_new = qmp_marshal_input_qom_list_types,
2948 },
Anthony Liguori1daa31b2012-08-10 11:04:09 -05002949
2950 {
2951 .name = "device-list-properties",
2952 .args_type = "typename:s",
2953 .mhandler.cmd_new = qmp_marshal_input_device_list_properties,
2954 },
2955
Anthony Liguori01d3c802012-08-10 11:04:11 -05002956 {
2957 .name = "query-machines",
2958 .args_type = "",
2959 .mhandler.cmd_new = qmp_marshal_input_query_machines,
2960 },
2961
Anthony Liguorie4e31c62012-08-10 11:04:13 -05002962 {
2963 .name = "query-cpu-definitions",
2964 .args_type = "",
2965 .mhandler.cmd_new = qmp_marshal_input_query_cpu_definitions,
2966 },
2967
Daniel P. Berrange99afc912012-08-20 15:31:38 +01002968 {
2969 .name = "query-target",
2970 .args_type = "",
2971 .mhandler.cmd_new = qmp_marshal_input_query_target,
2972 },
Gerd Hoffmannf1a1a352012-12-19 10:33:56 +01002973
2974 {
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05002975 .name = "query-tpm",
2976 .args_type = "",
2977 .mhandler.cmd_new = qmp_marshal_input_query_tpm,
2978 },
2979
Corey Bryant28c4fa32013-03-20 12:34:49 -04002980SQMP
2981query-tpm
2982---------
2983
2984Return information about the TPM device.
2985
2986Arguments: None
2987
2988Example:
2989
2990-> { "execute": "query-tpm" }
2991<- { "return":
2992 [
2993 { "model": "tpm-tis",
2994 "options":
2995 { "type": "passthrough",
2996 "data":
2997 { "cancel-path": "/sys/class/misc/tpm0/device/cancel",
2998 "path": "/dev/tpm0"
2999 }
3000 },
3001 "id": "tpm0"
3002 }
3003 ]
3004 }
3005
3006EQMP
3007
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05003008 {
3009 .name = "query-tpm-models",
3010 .args_type = "",
3011 .mhandler.cmd_new = qmp_marshal_input_query_tpm_models,
3012 },
3013
Corey Bryant28c4fa32013-03-20 12:34:49 -04003014SQMP
3015query-tpm-models
3016----------------
3017
3018Return a list of supported TPM models.
3019
3020Arguments: None
3021
3022Example:
3023
3024-> { "execute": "query-tpm-models" }
3025<- { "return": [ "tpm-tis" ] }
3026
3027EQMP
3028
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05003029 {
3030 .name = "query-tpm-types",
3031 .args_type = "",
3032 .mhandler.cmd_new = qmp_marshal_input_query_tpm_types,
3033 },
3034
Corey Bryant28c4fa32013-03-20 12:34:49 -04003035SQMP
3036query-tpm-types
3037---------------
3038
3039Return a list of supported TPM types.
3040
3041Arguments: None
3042
3043Example:
3044
3045-> { "execute": "query-tpm-types" }
3046<- { "return": [ "passthrough" ] }
3047
3048EQMP
3049
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05003050 {
Gerd Hoffmannf1a1a352012-12-19 10:33:56 +01003051 .name = "chardev-add",
3052 .args_type = "id:s,backend:q",
3053 .mhandler.cmd_new = qmp_marshal_input_chardev_add,
3054 },
3055
3056SQMP
3057chardev-add
3058----------------
3059
3060Add a chardev.
3061
3062Arguments:
3063
3064- "id": the chardev's ID, must be unique (json-string)
3065- "backend": chardev backend type + parameters
3066
Gerd Hoffmannffbdbe52012-12-19 13:13:57 +01003067Examples:
Gerd Hoffmannf1a1a352012-12-19 10:33:56 +01003068
3069-> { "execute" : "chardev-add",
3070 "arguments" : { "id" : "foo",
3071 "backend" : { "type" : "null", "data" : {} } } }
3072<- { "return": {} }
3073
Gerd Hoffmannffbdbe52012-12-19 13:13:57 +01003074-> { "execute" : "chardev-add",
3075 "arguments" : { "id" : "bar",
3076 "backend" : { "type" : "file",
3077 "data" : { "out" : "/tmp/bar.log" } } } }
3078<- { "return": {} }
3079
Gerd Hoffmann0a1a7fa2012-12-20 14:39:13 +01003080-> { "execute" : "chardev-add",
3081 "arguments" : { "id" : "baz",
3082 "backend" : { "type" : "pty", "data" : {} } } }
3083<- { "return": { "pty" : "/dev/pty/42" } }
3084
Gerd Hoffmannf1a1a352012-12-19 10:33:56 +01003085EQMP
3086
3087 {
3088 .name = "chardev-remove",
3089 .args_type = "id:s",
3090 .mhandler.cmd_new = qmp_marshal_input_chardev_remove,
3091 },
3092
3093
3094SQMP
3095chardev-remove
3096--------------
3097
3098Remove a chardev.
3099
3100Arguments:
3101
3102- "id": the chardev's ID, must exist and not be in use (json-string)
3103
3104Example:
3105
3106-> { "execute": "chardev-remove", "arguments": { "id" : "foo" } }
3107<- { "return": {} }
3108
3109EQMP
Amos Kongb1be4282013-06-14 15:45:52 +08003110 {
3111 .name = "query-rx-filter",
3112 .args_type = "name:s?",
3113 .mhandler.cmd_new = qmp_marshal_input_query_rx_filter,
3114 },
3115
3116SQMP
3117query-rx-filter
3118---------------
3119
3120Show rx-filter information.
3121
3122Returns a json-array of rx-filter information for all NICs (or for the
3123given NIC), returning an error if the given NIC doesn't exist, or
3124given NIC doesn't support rx-filter querying, or given net client
3125isn't a NIC.
3126
3127The query will clear the event notification flag of each NIC, then qemu
3128will start to emit event to QMP monitor.
3129
3130Each array entry contains the following:
3131
3132- "name": net client name (json-string)
3133- "promiscuous": promiscuous mode is enabled (json-bool)
3134- "multicast": multicast receive state (one of 'normal', 'none', 'all')
3135- "unicast": unicast receive state (one of 'normal', 'none', 'all')
3136- "broadcast-allowed": allow to receive broadcast (json-bool)
3137- "multicast-overflow": multicast table is overflowed (json-bool)
3138- "unicast-overflow": unicast table is overflowed (json-bool)
3139- "main-mac": main macaddr string (json-string)
3140- "vlan-table": a json-array of active vlan id
3141- "unicast-table": a json-array of unicast macaddr string
3142- "multicast-table": a json-array of multicast macaddr string
3143
3144Example:
3145
3146-> { "execute": "query-rx-filter", "arguments": { "name": "vnet0" } }
3147<- { "return": [
3148 {
3149 "promiscuous": true,
3150 "name": "vnet0",
3151 "main-mac": "52:54:00:12:34:56",
3152 "unicast": "normal",
3153 "vlan-table": [
3154 4,
3155 0
3156 ],
3157 "unicast-table": [
3158 ],
3159 "multicast": "normal",
3160 "multicast-overflow": false,
3161 "unicast-overflow": false,
3162 "multicast-table": [
3163 "01:00:5e:00:00:01",
3164 "33:33:00:00:00:01",
3165 "33:33:ff:12:34:56"
3166 ],
3167 "broadcast-allowed": false
3168 }
3169 ]
3170 }
3171
3172EQMP