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