]>
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 | ||
45 | 1. The deprecation policy will take efect and be documented soon, please | |
46 | check the documentation of each used command as soon as a new release of | |
47 | QEMU is available | |
48 | ||
49 | 2. DO NOT rely on anything which is not explicit documented | |
50 | ||
51 | 3. Errors, in special, are not documented. Applications should NOT check | |
52 | for specific errors classes or data (it's strongly recommended to only | |
53 | check for the "error" key) | |
54 | ||
55 | 2. Regular Commands | |
56 | =================== | |
57 | ||
58 | Server's responses in the examples below are always a success response, please | |
59 | refer to the QMP specification for more details on error responses. | |
60 | ||
61 | EQMP | |
62 | ||
63 | { | |
64 | .name = "quit", | |
65 | .args_type = "", | |
66 | .params = "", | |
67 | .help = "quit the emulator", | |
68 | .user_print = monitor_user_noop, | |
69 | .mhandler.cmd_new = do_quit, | |
70 | }, | |
71 | ||
72 | SQMP | |
73 | quit | |
74 | ---- | |
75 | ||
76 | Quit the emulator. | |
77 | ||
78 | Arguments: None. | |
79 | ||
80 | Example: | |
81 | ||
82 | -> { "execute": "quit" } | |
83 | <- { "return": {} } | |
84 | ||
85 | EQMP | |
86 | ||
87 | { | |
88 | .name = "eject", | |
89 | .args_type = "force:-f,device:B", | |
90 | .params = "[-f] device", | |
91 | .help = "eject a removable medium (use -f to force it)", | |
92 | .user_print = monitor_user_noop, | |
93 | .mhandler.cmd_new = do_eject, | |
94 | }, | |
95 | ||
96 | SQMP | |
97 | eject | |
98 | ----- | |
99 | ||
100 | Eject a removable medium. | |
101 | ||
102 | Arguments: | |
103 | ||
104 | - force: force ejection (json-bool, optional) | |
105 | - device: device name (json-string) | |
106 | ||
107 | Example: | |
108 | ||
109 | -> { "execute": "eject", "arguments": { "device": "ide1-cd0" } } | |
110 | <- { "return": {} } | |
111 | ||
112 | Note: The "force" argument defaults to false. | |
113 | ||
114 | EQMP | |
115 | ||
116 | { | |
117 | .name = "change", | |
118 | .args_type = "device:B,target:F,arg:s?", | |
119 | .params = "device filename [format]", | |
120 | .help = "change a removable medium, optional format", | |
121 | .user_print = monitor_user_noop, | |
122 | .mhandler.cmd_new = do_change, | |
123 | }, | |
124 | ||
125 | SQMP | |
126 | change | |
127 | ------ | |
128 | ||
129 | Change a removable medium or VNC configuration. | |
130 | ||
131 | Arguments: | |
132 | ||
133 | - "device": device name (json-string) | |
134 | - "target": filename or item (json-string) | |
135 | - "arg": additional argument (json-string, optional) | |
136 | ||
137 | Examples: | |
138 | ||
139 | 1. Change a removable medium | |
140 | ||
141 | -> { "execute": "change", | |
142 | "arguments": { "device": "ide1-cd0", | |
143 | "target": "/srv/images/Fedora-12-x86_64-DVD.iso" } } | |
144 | <- { "return": {} } | |
145 | ||
146 | 2. Change VNC password | |
147 | ||
148 | -> { "execute": "change", | |
149 | "arguments": { "device": "vnc", "target": "password", | |
150 | "arg": "foobar1" } } | |
151 | <- { "return": {} } | |
152 | ||
153 | EQMP | |
154 | ||
155 | { | |
156 | .name = "screendump", | |
157 | .args_type = "filename:F", | |
158 | .params = "filename", | |
159 | .help = "save screen into PPM image 'filename'", | |
160 | .user_print = monitor_user_noop, | |
161 | .mhandler.cmd_new = do_screen_dump, | |
162 | }, | |
163 | ||
164 | SQMP | |
165 | screendump | |
166 | ---------- | |
167 | ||
168 | Save screen into PPM image. | |
169 | ||
170 | Arguments: | |
171 | ||
172 | - "filename": file path (json-string) | |
173 | ||
174 | Example: | |
175 | ||
176 | -> { "execute": "screendump", "arguments": { "filename": "/tmp/image" } } | |
177 | <- { "return": {} } | |
178 | ||
179 | EQMP | |
180 | ||
181 | { | |
182 | .name = "stop", | |
183 | .args_type = "", | |
184 | .params = "", | |
185 | .help = "stop emulation", | |
186 | .user_print = monitor_user_noop, | |
187 | .mhandler.cmd_new = do_stop, | |
188 | }, | |
189 | ||
190 | SQMP | |
191 | stop | |
192 | ---- | |
193 | ||
194 | Stop the emulator. | |
195 | ||
196 | Arguments: None. | |
197 | ||
198 | Example: | |
199 | ||
200 | -> { "execute": "stop" } | |
201 | <- { "return": {} } | |
202 | ||
203 | EQMP | |
204 | ||
205 | { | |
206 | .name = "cont", | |
207 | .args_type = "", | |
208 | .params = "", | |
209 | .help = "resume emulation", | |
210 | .user_print = monitor_user_noop, | |
211 | .mhandler.cmd_new = do_cont, | |
212 | }, | |
213 | ||
214 | SQMP | |
215 | cont | |
216 | ---- | |
217 | ||
218 | Resume emulation. | |
219 | ||
220 | Arguments: None. | |
221 | ||
222 | Example: | |
223 | ||
224 | -> { "execute": "cont" } | |
225 | <- { "return": {} } | |
226 | ||
227 | EQMP | |
228 | ||
229 | { | |
230 | .name = "system_reset", | |
231 | .args_type = "", | |
232 | .params = "", | |
233 | .help = "reset the system", | |
234 | .user_print = monitor_user_noop, | |
235 | .mhandler.cmd_new = do_system_reset, | |
236 | }, | |
237 | ||
238 | SQMP | |
239 | system_reset | |
240 | ------------ | |
241 | ||
242 | Reset the system. | |
243 | ||
244 | Arguments: None. | |
245 | ||
246 | Example: | |
247 | ||
248 | -> { "execute": "system_reset" } | |
249 | <- { "return": {} } | |
250 | ||
251 | EQMP | |
252 | ||
253 | { | |
254 | .name = "system_powerdown", | |
255 | .args_type = "", | |
256 | .params = "", | |
257 | .help = "send system power down event", | |
258 | .user_print = monitor_user_noop, | |
259 | .mhandler.cmd_new = do_system_powerdown, | |
260 | }, | |
261 | ||
262 | SQMP | |
263 | system_powerdown | |
264 | ---------------- | |
265 | ||
266 | Send system power down event. | |
267 | ||
268 | Arguments: None. | |
269 | ||
270 | Example: | |
271 | ||
272 | -> { "execute": "system_powerdown" } | |
273 | <- { "return": {} } | |
274 | ||
275 | EQMP | |
276 | ||
277 | { | |
278 | .name = "device_add", | |
279 | .args_type = "device:O", | |
280 | .params = "driver[,prop=value][,...]", | |
281 | .help = "add device, like -device on the command line", | |
282 | .user_print = monitor_user_noop, | |
283 | .mhandler.cmd_new = do_device_add, | |
284 | }, | |
285 | ||
286 | SQMP | |
287 | device_add | |
288 | ---------- | |
289 | ||
290 | Add a device. | |
291 | ||
292 | Arguments: | |
293 | ||
294 | - "driver": the name of the new device's driver (json-string) | |
295 | - "bus": the device's parent bus (device tree path, json-string, optional) | |
296 | - "id": the device's ID, must be unique (json-string) | |
297 | - device properties | |
298 | ||
299 | Example: | |
300 | ||
301 | -> { "execute": "device_add", "arguments": { "driver": "e1000", "id": "net1" } } | |
302 | <- { "return": {} } | |
303 | ||
304 | Notes: | |
305 | ||
306 | (1) For detailed information about this command, please refer to the | |
307 | 'docs/qdev-device-use.txt' file. | |
308 | ||
309 | (2) It's possible to list device properties by running QEMU with the | |
310 | "-device DEVICE,\?" command-line argument, where DEVICE is the device's name | |
311 | ||
312 | EQMP | |
313 | ||
314 | { | |
315 | .name = "device_del", | |
316 | .args_type = "id:s", | |
317 | .params = "device", | |
318 | .help = "remove device", | |
319 | .user_print = monitor_user_noop, | |
320 | .mhandler.cmd_new = do_device_del, | |
321 | }, | |
322 | ||
323 | SQMP | |
324 | device_del | |
325 | ---------- | |
326 | ||
327 | Remove a device. | |
328 | ||
329 | Arguments: | |
330 | ||
331 | - "id": the device's ID (json-string) | |
332 | ||
333 | Example: | |
334 | ||
335 | -> { "execute": "device_del", "arguments": { "id": "net1" } } | |
336 | <- { "return": {} } | |
337 | ||
338 | EQMP | |
339 | ||
340 | { | |
341 | .name = "cpu", | |
342 | .args_type = "index:i", | |
343 | .params = "index", | |
344 | .help = "set the default CPU", | |
345 | .user_print = monitor_user_noop, | |
346 | .mhandler.cmd_new = do_cpu_set, | |
347 | }, | |
348 | ||
349 | SQMP | |
350 | cpu | |
351 | --- | |
352 | ||
353 | Set the default CPU. | |
354 | ||
355 | Arguments: | |
356 | ||
357 | - "index": the CPU's index (json-int) | |
358 | ||
359 | Example: | |
360 | ||
361 | -> { "execute": "cpu", "arguments": { "index": 0 } } | |
362 | <- { "return": {} } | |
363 | ||
364 | Note: CPUs' indexes are obtained with the 'query-cpus' command. | |
365 | ||
366 | EQMP | |
367 | ||
368 | { | |
369 | .name = "memsave", | |
370 | .args_type = "val:l,size:i,filename:s", | |
371 | .params = "addr size file", | |
372 | .help = "save to disk virtual memory dump starting at 'addr' of size 'size'", | |
373 | .user_print = monitor_user_noop, | |
374 | .mhandler.cmd_new = do_memory_save, | |
375 | }, | |
376 | ||
377 | SQMP | |
378 | memsave | |
379 | ------- | |
380 | ||
381 | Save to disk virtual memory dump starting at 'val' of size 'size'. | |
382 | ||
383 | Arguments: | |
384 | ||
385 | - "val": the starting address (json-int) | |
386 | - "size": the memory size, in bytes (json-int) | |
387 | - "filename": file path (json-string) | |
388 | ||
389 | Example: | |
390 | ||
391 | -> { "execute": "memsave", | |
392 | "arguments": { "val": 10, | |
393 | "size": 100, | |
394 | "filename": "/tmp/virtual-mem-dump" } } | |
395 | <- { "return": {} } | |
396 | ||
397 | Note: Depends on the current CPU. | |
398 | ||
399 | EQMP | |
400 | ||
401 | { | |
402 | .name = "pmemsave", | |
403 | .args_type = "val:l,size:i,filename:s", | |
404 | .params = "addr size file", | |
405 | .help = "save to disk physical memory dump starting at 'addr' of size 'size'", | |
406 | .user_print = monitor_user_noop, | |
407 | .mhandler.cmd_new = do_physical_memory_save, | |
408 | }, | |
409 | ||
410 | SQMP | |
411 | pmemsave | |
412 | -------- | |
413 | ||
414 | Save to disk physical memory dump starting at 'val' of size 'size'. | |
415 | ||
416 | Arguments: | |
417 | ||
418 | - "val": the starting address (json-int) | |
419 | - "size": the memory size, in bytes (json-int) | |
420 | - "filename": file path (json-string) | |
421 | ||
422 | Example: | |
423 | ||
424 | -> { "execute": "pmemsave", | |
425 | "arguments": { "val": 10, | |
426 | "size": 100, | |
427 | "filename": "/tmp/physical-mem-dump" } } | |
428 | <- { "return": {} } | |
429 | ||
430 | EQMP | |
431 | ||
432 | { | |
433 | .name = "migrate", | |
434 | .args_type = "detach:-d,blk:-b,inc:-i,uri:s", | |
435 | .params = "[-d] [-b] [-i] uri", | |
436 | .help = "migrate to URI (using -d to not wait for completion)" | |
437 | "\n\t\t\t -b for migration without shared storage with" | |
438 | " full copy of disk\n\t\t\t -i for migration without " | |
439 | "shared storage with incremental copy of disk " | |
440 | "(base image shared between src and destination)", | |
441 | .user_print = monitor_user_noop, | |
442 | .mhandler.cmd_new = do_migrate, | |
443 | }, | |
444 | ||
445 | SQMP | |
446 | migrate | |
447 | ------- | |
448 | ||
449 | Migrate to URI. | |
450 | ||
451 | Arguments: | |
452 | ||
453 | - "blk": block migration, full disk copy (json-bool, optional) | |
454 | - "inc": incremental disk copy (json-bool, optional) | |
455 | - "uri": Destination URI (json-string) | |
456 | ||
457 | Example: | |
458 | ||
459 | -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } } | |
460 | <- { "return": {} } | |
461 | ||
462 | Notes: | |
463 | ||
464 | (1) The 'query-migrate' command should be used to check migration's progress | |
465 | and final result (this information is provided by the 'status' member) | |
466 | (2) All boolean arguments default to false | |
467 | (3) The user Monitor's "detach" argument is invalid in QMP and should not | |
468 | be used | |
469 | ||
470 | EQMP | |
471 | ||
472 | { | |
473 | .name = "migrate_cancel", | |
474 | .args_type = "", | |
475 | .params = "", | |
476 | .help = "cancel the current VM migration", | |
477 | .user_print = monitor_user_noop, | |
478 | .mhandler.cmd_new = do_migrate_cancel, | |
479 | }, | |
480 | ||
481 | SQMP | |
482 | migrate_cancel | |
483 | -------------- | |
484 | ||
485 | Cancel the current migration. | |
486 | ||
487 | Arguments: None. | |
488 | ||
489 | Example: | |
490 | ||
491 | -> { "execute": "migrate_cancel" } | |
492 | <- { "return": {} } | |
493 | ||
494 | EQMP | |
495 | ||
496 | { | |
497 | .name = "migrate_set_speed", | |
3a019b6e | 498 | .args_type = "value:o", |
82a56f0d LC |
499 | .params = "value", |
500 | .help = "set maximum speed (in bytes) for migrations", | |
501 | .user_print = monitor_user_noop, | |
502 | .mhandler.cmd_new = do_migrate_set_speed, | |
503 | }, | |
504 | ||
505 | SQMP | |
506 | migrate_set_speed | |
507 | ----------------- | |
508 | ||
509 | Set maximum speed for migrations. | |
510 | ||
511 | Arguments: | |
512 | ||
5569fd7c | 513 | - "value": maximum speed, in bytes per second (json-int) |
82a56f0d LC |
514 | |
515 | Example: | |
516 | ||
517 | -> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } } | |
518 | <- { "return": {} } | |
519 | ||
520 | EQMP | |
521 | ||
522 | { | |
523 | .name = "migrate_set_downtime", | |
524 | .args_type = "value:T", | |
525 | .params = "value", | |
526 | .help = "set maximum tolerated downtime (in seconds) for migrations", | |
527 | .user_print = monitor_user_noop, | |
528 | .mhandler.cmd_new = do_migrate_set_downtime, | |
529 | }, | |
530 | ||
531 | SQMP | |
532 | migrate_set_downtime | |
533 | -------------------- | |
534 | ||
535 | Set maximum tolerated downtime (in seconds) for migrations. | |
536 | ||
537 | Arguments: | |
538 | ||
539 | - "value": maximum downtime (json-number) | |
540 | ||
541 | Example: | |
542 | ||
543 | -> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } } | |
544 | <- { "return": {} } | |
545 | ||
546 | EQMP | |
547 | ||
548 | { | |
549 | .name = "netdev_add", | |
550 | .args_type = "netdev:O", | |
551 | .params = "[user|tap|socket],id=str[,prop=value][,...]", | |
552 | .help = "add host network device", | |
553 | .user_print = monitor_user_noop, | |
554 | .mhandler.cmd_new = do_netdev_add, | |
555 | }, | |
556 | ||
557 | SQMP | |
558 | netdev_add | |
559 | ---------- | |
560 | ||
561 | Add host network device. | |
562 | ||
563 | Arguments: | |
564 | ||
565 | - "type": the device type, "tap", "user", ... (json-string) | |
566 | - "id": the device's ID, must be unique (json-string) | |
567 | - device options | |
568 | ||
569 | Example: | |
570 | ||
571 | -> { "execute": "netdev_add", "arguments": { "type": "user", "id": "netdev1" } } | |
572 | <- { "return": {} } | |
573 | ||
574 | Note: The supported device options are the same ones supported by the '-net' | |
575 | command-line argument, which are listed in the '-help' output or QEMU's | |
576 | manual | |
577 | ||
578 | EQMP | |
579 | ||
580 | { | |
581 | .name = "netdev_del", | |
582 | .args_type = "id:s", | |
583 | .params = "id", | |
584 | .help = "remove host network device", | |
585 | .user_print = monitor_user_noop, | |
586 | .mhandler.cmd_new = do_netdev_del, | |
587 | }, | |
588 | ||
589 | SQMP | |
590 | netdev_del | |
591 | ---------- | |
592 | ||
593 | Remove host network device. | |
594 | ||
595 | Arguments: | |
596 | ||
597 | - "id": the device's ID, must be unique (json-string) | |
598 | ||
599 | Example: | |
600 | ||
601 | -> { "execute": "netdev_del", "arguments": { "id": "netdev1" } } | |
602 | <- { "return": {} } | |
603 | ||
6d4a2b3a CH |
604 | |
605 | EQMP | |
606 | ||
607 | { | |
608 | .name = "block_resize", | |
609 | .args_type = "device:B,size:o", | |
610 | .params = "device size", | |
611 | .help = "resize a block image", | |
612 | .user_print = monitor_user_noop, | |
613 | .mhandler.cmd_new = do_block_resize, | |
614 | }, | |
615 | ||
616 | SQMP | |
617 | block_resize | |
618 | ------------ | |
619 | ||
620 | Resize a block image while a guest is running. | |
621 | ||
622 | Arguments: | |
623 | ||
624 | - "device": the device's ID, must be unique (json-string) | |
625 | - "size": new size | |
626 | ||
627 | Example: | |
628 | ||
629 | -> { "execute": "block_resize", "arguments": { "device": "scratch", "size": 1073741824 } } | |
630 | <- { "return": {} } | |
631 | ||
82a56f0d LC |
632 | EQMP |
633 | ||
634 | { | |
635 | .name = "balloon", | |
636 | .args_type = "value:M", | |
637 | .params = "target", | |
638 | .help = "request VM to change its memory allocation (in MB)", | |
639 | .user_print = monitor_user_noop, | |
640 | .mhandler.cmd_async = do_balloon, | |
641 | .flags = MONITOR_CMD_ASYNC, | |
642 | }, | |
643 | ||
644 | SQMP | |
645 | balloon | |
646 | ------- | |
647 | ||
648 | Request VM to change its memory allocation (in bytes). | |
649 | ||
650 | Arguments: | |
651 | ||
652 | - "value": New memory allocation (json-int) | |
653 | ||
654 | Example: | |
655 | ||
656 | -> { "execute": "balloon", "arguments": { "value": 536870912 } } | |
657 | <- { "return": {} } | |
658 | ||
659 | EQMP | |
660 | ||
661 | { | |
662 | .name = "set_link", | |
663 | .args_type = "name:s,up:b", | |
664 | .params = "name on|off", | |
665 | .help = "change the link status of a network adapter", | |
666 | .user_print = monitor_user_noop, | |
667 | .mhandler.cmd_new = do_set_link, | |
668 | }, | |
669 | ||
670 | SQMP | |
671 | set_link | |
672 | -------- | |
673 | ||
674 | Change the link status of a network adapter. | |
675 | ||
676 | Arguments: | |
677 | ||
678 | - "name": network device name (json-string) | |
679 | - "up": status is up (json-bool) | |
680 | ||
681 | Example: | |
682 | ||
683 | -> { "execute": "set_link", "arguments": { "name": "e1000.0", "up": false } } | |
684 | <- { "return": {} } | |
685 | ||
686 | EQMP | |
687 | ||
688 | { | |
689 | .name = "getfd", | |
690 | .args_type = "fdname:s", | |
691 | .params = "getfd name", | |
692 | .help = "receive a file descriptor via SCM rights and assign it a name", | |
693 | .user_print = monitor_user_noop, | |
694 | .mhandler.cmd_new = do_getfd, | |
695 | }, | |
696 | ||
697 | SQMP | |
698 | getfd | |
699 | ----- | |
700 | ||
701 | Receive a file descriptor via SCM rights and assign it a name. | |
702 | ||
703 | Arguments: | |
704 | ||
705 | - "fdname": file descriptor name (json-string) | |
706 | ||
707 | Example: | |
708 | ||
709 | -> { "execute": "getfd", "arguments": { "fdname": "fd1" } } | |
710 | <- { "return": {} } | |
711 | ||
712 | EQMP | |
713 | ||
714 | { | |
715 | .name = "closefd", | |
716 | .args_type = "fdname:s", | |
717 | .params = "closefd name", | |
718 | .help = "close a file descriptor previously passed via SCM rights", | |
719 | .user_print = monitor_user_noop, | |
720 | .mhandler.cmd_new = do_closefd, | |
721 | }, | |
722 | ||
723 | SQMP | |
724 | closefd | |
725 | ------- | |
726 | ||
727 | Close a file descriptor previously passed via SCM rights. | |
728 | ||
729 | Arguments: | |
730 | ||
731 | - "fdname": file descriptor name (json-string) | |
732 | ||
733 | Example: | |
734 | ||
735 | -> { "execute": "closefd", "arguments": { "fdname": "fd1" } } | |
736 | <- { "return": {} } | |
737 | ||
738 | EQMP | |
739 | ||
740 | { | |
741 | .name = "block_passwd", | |
742 | .args_type = "device:B,password:s", | |
743 | .params = "block_passwd device password", | |
744 | .help = "set the password of encrypted block devices", | |
745 | .user_print = monitor_user_noop, | |
746 | .mhandler.cmd_new = do_block_set_passwd, | |
747 | }, | |
748 | ||
749 | SQMP | |
750 | block_passwd | |
751 | ------------ | |
752 | ||
753 | Set the password of encrypted block devices. | |
754 | ||
755 | Arguments: | |
756 | ||
757 | - "device": device name (json-string) | |
758 | - "password": password (json-string) | |
759 | ||
760 | Example: | |
761 | ||
762 | -> { "execute": "block_passwd", "arguments": { "device": "ide0-hd0", | |
763 | "password": "12345" } } | |
764 | <- { "return": {} } | |
765 | ||
7572150c GH |
766 | EQMP |
767 | ||
768 | { | |
769 | .name = "set_password", | |
770 | .args_type = "protocol:s,password:s,connected:s?", | |
771 | .params = "protocol password action-if-connected", | |
772 | .help = "set spice/vnc password", | |
773 | .user_print = monitor_user_noop, | |
774 | .mhandler.cmd_new = set_password, | |
775 | }, | |
776 | ||
777 | SQMP | |
778 | set_password | |
779 | ------------ | |
780 | ||
781 | Set the password for vnc/spice protocols. | |
782 | ||
783 | Arguments: | |
784 | ||
785 | - "protocol": protocol name (json-string) | |
786 | - "password": password (json-string) | |
787 | - "connected": [ keep | disconnect | fail ] (josn-string, optional) | |
788 | ||
789 | Example: | |
790 | ||
791 | -> { "execute": "set_password", "arguments": { "protocol": "vnc", | |
792 | "password": "secret" } } | |
793 | <- { "return": {} } | |
794 | ||
795 | EQMP | |
796 | ||
797 | { | |
798 | .name = "expire_password", | |
799 | .args_type = "protocol:s,time:s", | |
800 | .params = "protocol time", | |
801 | .help = "set spice/vnc password expire-time", | |
802 | .user_print = monitor_user_noop, | |
803 | .mhandler.cmd_new = expire_password, | |
804 | }, | |
805 | ||
806 | SQMP | |
807 | expire_password | |
808 | --------------- | |
809 | ||
810 | Set the password expire time for vnc/spice protocols. | |
811 | ||
812 | Arguments: | |
813 | ||
814 | - "protocol": protocol name (json-string) | |
815 | - "time": [ now | never | +secs | secs ] (json-string) | |
816 | ||
817 | Example: | |
818 | ||
819 | -> { "execute": "expire_password", "arguments": { "protocol": "vnc", | |
820 | "time": "+60" } } | |
821 | <- { "return": {} } | |
822 | ||
82a56f0d LC |
823 | EQMP |
824 | ||
825 | { | |
826 | .name = "qmp_capabilities", | |
827 | .args_type = "", | |
828 | .params = "", | |
829 | .help = "enable QMP capabilities", | |
830 | .user_print = monitor_user_noop, | |
831 | .mhandler.cmd_new = do_qmp_capabilities, | |
832 | }, | |
833 | ||
834 | SQMP | |
835 | qmp_capabilities | |
836 | ---------------- | |
837 | ||
838 | Enable QMP capabilities. | |
839 | ||
840 | Arguments: None. | |
841 | ||
842 | Example: | |
843 | ||
844 | -> { "execute": "qmp_capabilities" } | |
845 | <- { "return": {} } | |
846 | ||
847 | Note: This command must be issued before issuing any other command. | |
848 | ||
0268d97c LC |
849 | EQMP |
850 | ||
851 | { | |
852 | .name = "human-monitor-command", | |
853 | .args_type = "command-line:s,cpu-index:i?", | |
854 | .params = "", | |
855 | .help = "", | |
856 | .user_print = monitor_user_noop, | |
857 | .mhandler.cmd_new = do_hmp_passthrough, | |
858 | }, | |
859 | ||
860 | SQMP | |
861 | human-monitor-command | |
862 | --------------------- | |
863 | ||
864 | Execute a Human Monitor command. | |
865 | ||
866 | Arguments: | |
867 | ||
868 | - command-line: the command name and its arguments, just like the | |
869 | Human Monitor's shell (json-string) | |
870 | - cpu-index: select the CPU number to be used by commands which access CPU | |
871 | data, like 'info registers'. The Monitor selects CPU 0 if this | |
872 | argument is not provided (json-int, optional) | |
873 | ||
874 | Example: | |
875 | ||
876 | -> { "execute": "human-monitor-command", "arguments": { "command-line": "info kvm" } } | |
877 | <- { "return": "kvm support: enabled\r\n" } | |
878 | ||
879 | Notes: | |
880 | ||
881 | (1) The Human Monitor is NOT an stable interface, this means that command | |
882 | names, arguments and responses can change or be removed at ANY time. | |
883 | Applications that rely on long term stability guarantees should NOT | |
884 | use this command | |
885 | ||
886 | (2) Limitations: | |
887 | ||
888 | o This command is stateless, this means that commands that depend | |
889 | on state information (such as getfd) might not work | |
890 | ||
891 | o Commands that prompt the user for data (eg. 'cont' when the block | |
892 | device is encrypted) don't currently work | |
893 | ||
82a56f0d LC |
894 | 3. Query Commands |
895 | ================= | |
896 | ||
897 | HXCOMM Each query command below is inside a SQMP/EQMP section, do NOT change | |
898 | HXCOMM this! We will possibly move query commands definitions inside those | |
899 | HXCOMM sections, just like regular commands. | |
900 | ||
901 | EQMP | |
902 | ||
903 | SQMP | |
904 | query-version | |
905 | ------------- | |
906 | ||
907 | Show QEMU version. | |
908 | ||
909 | Return a json-object with the following information: | |
910 | ||
911 | - "qemu": A json-object containing three integer values: | |
912 | - "major": QEMU's major version (json-int) | |
913 | - "minor": QEMU's minor version (json-int) | |
914 | - "micro": QEMU's micro version (json-int) | |
915 | - "package": package's version (json-string) | |
916 | ||
917 | Example: | |
918 | ||
919 | -> { "execute": "query-version" } | |
920 | <- { | |
921 | "return":{ | |
922 | "qemu":{ | |
923 | "major":0, | |
924 | "minor":11, | |
925 | "micro":5 | |
926 | }, | |
927 | "package":"" | |
928 | } | |
929 | } | |
930 | ||
931 | EQMP | |
932 | ||
933 | SQMP | |
934 | query-commands | |
935 | -------------- | |
936 | ||
937 | List QMP available commands. | |
938 | ||
939 | Each command is represented by a json-object, the returned value is a json-array | |
940 | of all commands. | |
941 | ||
942 | Each json-object contain: | |
943 | ||
944 | - "name": command's name (json-string) | |
945 | ||
946 | Example: | |
947 | ||
948 | -> { "execute": "query-commands" } | |
949 | <- { | |
950 | "return":[ | |
951 | { | |
952 | "name":"query-balloon" | |
953 | }, | |
954 | { | |
955 | "name":"system_powerdown" | |
956 | } | |
957 | ] | |
958 | } | |
959 | ||
960 | Note: This example has been shortened as the real response is too long. | |
961 | ||
962 | EQMP | |
963 | ||
964 | SQMP | |
965 | query-chardev | |
966 | ------------- | |
967 | ||
968 | Each device is represented by a json-object. The returned value is a json-array | |
969 | of all devices. | |
970 | ||
971 | Each json-object contain the following: | |
972 | ||
973 | - "label": device's label (json-string) | |
974 | - "filename": device's file (json-string) | |
975 | ||
976 | Example: | |
977 | ||
978 | -> { "execute": "query-chardev" } | |
979 | <- { | |
980 | "return":[ | |
981 | { | |
982 | "label":"monitor", | |
983 | "filename":"stdio" | |
984 | }, | |
985 | { | |
986 | "label":"serial0", | |
987 | "filename":"vc" | |
988 | } | |
989 | ] | |
990 | } | |
991 | ||
992 | EQMP | |
993 | ||
994 | SQMP | |
995 | query-block | |
996 | ----------- | |
997 | ||
998 | Show the block devices. | |
999 | ||
1000 | Each block device information is stored in a json-object and the returned value | |
1001 | is a json-array of all devices. | |
1002 | ||
1003 | Each json-object contain the following: | |
1004 | ||
1005 | - "device": device name (json-string) | |
1006 | - "type": device type (json-string) | |
1007 | - Possible values: "hd", "cdrom", "floppy", "unknown" | |
1008 | - "removable": true if the device is removable, false otherwise (json-bool) | |
1009 | - "locked": true if the device is locked, false otherwise (json-bool) | |
1010 | - "inserted": only present if the device is inserted, it is a json-object | |
1011 | containing the following: | |
1012 | - "file": device file name (json-string) | |
1013 | - "ro": true if read-only, false otherwise (json-bool) | |
1014 | - "drv": driver format name (json-string) | |
1015 | - Possible values: "blkdebug", "bochs", "cloop", "cow", "dmg", | |
1016 | "file", "file", "ftp", "ftps", "host_cdrom", | |
1017 | "host_device", "host_floppy", "http", "https", | |
1018 | "nbd", "parallels", "qcow", "qcow2", "raw", | |
1019 | "tftp", "vdi", "vmdk", "vpc", "vvfat" | |
1020 | - "backing_file": backing file name (json-string, optional) | |
1021 | - "encrypted": true if encrypted, false otherwise (json-bool) | |
1022 | ||
1023 | Example: | |
1024 | ||
1025 | -> { "execute": "query-block" } | |
1026 | <- { | |
1027 | "return":[ | |
1028 | { | |
1029 | "device":"ide0-hd0", | |
1030 | "locked":false, | |
1031 | "removable":false, | |
1032 | "inserted":{ | |
1033 | "ro":false, | |
1034 | "drv":"qcow2", | |
1035 | "encrypted":false, | |
1036 | "file":"disks/test.img" | |
1037 | }, | |
1038 | "type":"hd" | |
1039 | }, | |
1040 | { | |
1041 | "device":"ide1-cd0", | |
1042 | "locked":false, | |
1043 | "removable":true, | |
1044 | "type":"cdrom" | |
1045 | }, | |
1046 | { | |
1047 | "device":"floppy0", | |
1048 | "locked":false, | |
1049 | "removable":true, | |
1050 | "type": "floppy" | |
1051 | }, | |
1052 | { | |
1053 | "device":"sd0", | |
1054 | "locked":false, | |
1055 | "removable":true, | |
1056 | "type":"floppy" | |
1057 | } | |
1058 | ] | |
1059 | } | |
1060 | ||
1061 | EQMP | |
1062 | ||
1063 | SQMP | |
1064 | query-blockstats | |
1065 | ---------------- | |
1066 | ||
1067 | Show block device statistics. | |
1068 | ||
1069 | Each device statistic information is stored in a json-object and the returned | |
1070 | value is a json-array of all devices. | |
1071 | ||
1072 | Each json-object contain the following: | |
1073 | ||
1074 | - "device": device name (json-string) | |
1075 | - "stats": A json-object with the statistics information, it contains: | |
1076 | - "rd_bytes": bytes read (json-int) | |
1077 | - "wr_bytes": bytes written (json-int) | |
1078 | - "rd_operations": read operations (json-int) | |
1079 | - "wr_operations": write operations (json-int) | |
1080 | - "wr_highest_offset": Highest offset of a sector written since the | |
1081 | BlockDriverState has been opened (json-int) | |
1082 | - "parent": Contains recursively the statistics of the underlying | |
1083 | protocol (e.g. the host file for a qcow2 image). If there is | |
1084 | no underlying protocol, this field is omitted | |
1085 | (json-object, optional) | |
1086 | ||
1087 | Example: | |
1088 | ||
1089 | -> { "execute": "query-blockstats" } | |
1090 | <- { | |
1091 | "return":[ | |
1092 | { | |
1093 | "device":"ide0-hd0", | |
1094 | "parent":{ | |
1095 | "stats":{ | |
1096 | "wr_highest_offset":3686448128, | |
1097 | "wr_bytes":9786368, | |
1098 | "wr_operations":751, | |
1099 | "rd_bytes":122567168, | |
1100 | "rd_operations":36772 | |
1101 | } | |
1102 | }, | |
1103 | "stats":{ | |
1104 | "wr_highest_offset":2821110784, | |
1105 | "wr_bytes":9786368, | |
1106 | "wr_operations":692, | |
1107 | "rd_bytes":122739200, | |
1108 | "rd_operations":36604 | |
1109 | } | |
1110 | }, | |
1111 | { | |
1112 | "device":"ide1-cd0", | |
1113 | "stats":{ | |
1114 | "wr_highest_offset":0, | |
1115 | "wr_bytes":0, | |
1116 | "wr_operations":0, | |
1117 | "rd_bytes":0, | |
1118 | "rd_operations":0 | |
1119 | } | |
1120 | }, | |
1121 | { | |
1122 | "device":"floppy0", | |
1123 | "stats":{ | |
1124 | "wr_highest_offset":0, | |
1125 | "wr_bytes":0, | |
1126 | "wr_operations":0, | |
1127 | "rd_bytes":0, | |
1128 | "rd_operations":0 | |
1129 | } | |
1130 | }, | |
1131 | { | |
1132 | "device":"sd0", | |
1133 | "stats":{ | |
1134 | "wr_highest_offset":0, | |
1135 | "wr_bytes":0, | |
1136 | "wr_operations":0, | |
1137 | "rd_bytes":0, | |
1138 | "rd_operations":0 | |
1139 | } | |
1140 | } | |
1141 | ] | |
1142 | } | |
1143 | ||
1144 | EQMP | |
1145 | ||
1146 | SQMP | |
1147 | query-cpus | |
1148 | ---------- | |
1149 | ||
1150 | Show CPU information. | |
1151 | ||
1152 | Return a json-array. Each CPU is represented by a json-object, which contains: | |
1153 | ||
1154 | - "CPU": CPU index (json-int) | |
1155 | - "current": true if this is the current CPU, false otherwise (json-bool) | |
1156 | - "halted": true if the cpu is halted, false otherwise (json-bool) | |
1157 | - Current program counter. The key's name depends on the architecture: | |
1158 | "pc": i386/x86_64 (json-int) | |
1159 | "nip": PPC (json-int) | |
1160 | "pc" and "npc": sparc (json-int) | |
1161 | "PC": mips (json-int) | |
1162 | ||
1163 | Example: | |
1164 | ||
1165 | -> { "execute": "query-cpus" } | |
1166 | <- { | |
1167 | "return":[ | |
1168 | { | |
1169 | "CPU":0, | |
1170 | "current":true, | |
1171 | "halted":false, | |
1172 | "pc":3227107138 | |
1173 | }, | |
1174 | { | |
1175 | "CPU":1, | |
1176 | "current":false, | |
1177 | "halted":true, | |
1178 | "pc":7108165 | |
1179 | } | |
1180 | ] | |
1181 | } | |
1182 | ||
1183 | EQMP | |
1184 | ||
1185 | SQMP | |
1186 | query-pci | |
1187 | --------- | |
1188 | ||
1189 | PCI buses and devices information. | |
1190 | ||
1191 | The returned value is a json-array of all buses. Each bus is represented by | |
1192 | a json-object, which has a key with a json-array of all PCI devices attached | |
1193 | to it. Each device is represented by a json-object. | |
1194 | ||
1195 | The bus json-object contains the following: | |
1196 | ||
1197 | - "bus": bus number (json-int) | |
1198 | - "devices": a json-array of json-objects, each json-object represents a | |
1199 | PCI device | |
1200 | ||
1201 | The PCI device json-object contains the following: | |
1202 | ||
1203 | - "bus": identical to the parent's bus number (json-int) | |
1204 | - "slot": slot number (json-int) | |
1205 | - "function": function number (json-int) | |
1206 | - "class_info": a json-object containing: | |
1207 | - "desc": device class description (json-string, optional) | |
1208 | - "class": device class number (json-int) | |
1209 | - "id": a json-object containing: | |
1210 | - "device": device ID (json-int) | |
1211 | - "vendor": vendor ID (json-int) | |
1212 | - "irq": device's IRQ if assigned (json-int, optional) | |
1213 | - "qdev_id": qdev id string (json-string) | |
1214 | - "pci_bridge": It's a json-object, only present if this device is a | |
1215 | PCI bridge, contains: | |
1216 | - "bus": bus number (json-int) | |
1217 | - "secondary": secondary bus number (json-int) | |
1218 | - "subordinate": subordinate bus number (json-int) | |
1219 | - "io_range": I/O memory range information, a json-object with the | |
1220 | following members: | |
1221 | - "base": base address, in bytes (json-int) | |
1222 | - "limit": limit address, in bytes (json-int) | |
1223 | - "memory_range": memory range information, a json-object with the | |
1224 | following members: | |
1225 | - "base": base address, in bytes (json-int) | |
1226 | - "limit": limit address, in bytes (json-int) | |
1227 | - "prefetchable_range": Prefetchable memory range information, a | |
1228 | json-object with the following members: | |
1229 | - "base": base address, in bytes (json-int) | |
1230 | - "limit": limit address, in bytes (json-int) | |
1231 | - "devices": a json-array of PCI devices if there's any attached, each | |
1232 | each element is represented by a json-object, which contains | |
1233 | the same members of the 'PCI device json-object' described | |
1234 | above (optional) | |
1235 | - "regions": a json-array of json-objects, each json-object represents a | |
1236 | memory region of this device | |
1237 | ||
1238 | The memory range json-object contains the following: | |
1239 | ||
1240 | - "base": base memory address (json-int) | |
1241 | - "limit": limit value (json-int) | |
1242 | ||
1243 | The region json-object can be an I/O region or a memory region, an I/O region | |
1244 | json-object contains the following: | |
1245 | ||
1246 | - "type": "io" (json-string, fixed) | |
1247 | - "bar": BAR number (json-int) | |
1248 | - "address": memory address (json-int) | |
1249 | - "size": memory size (json-int) | |
1250 | ||
1251 | A memory region json-object contains the following: | |
1252 | ||
1253 | - "type": "memory" (json-string, fixed) | |
1254 | - "bar": BAR number (json-int) | |
1255 | - "address": memory address (json-int) | |
1256 | - "size": memory size (json-int) | |
1257 | - "mem_type_64": true or false (json-bool) | |
1258 | - "prefetch": true or false (json-bool) | |
1259 | ||
1260 | Example: | |
1261 | ||
1262 | -> { "execute": "query-pci" } | |
1263 | <- { | |
1264 | "return":[ | |
1265 | { | |
1266 | "bus":0, | |
1267 | "devices":[ | |
1268 | { | |
1269 | "bus":0, | |
1270 | "qdev_id":"", | |
1271 | "slot":0, | |
1272 | "class_info":{ | |
1273 | "class":1536, | |
1274 | "desc":"Host bridge" | |
1275 | }, | |
1276 | "id":{ | |
1277 | "device":32902, | |
1278 | "vendor":4663 | |
1279 | }, | |
1280 | "function":0, | |
1281 | "regions":[ | |
1282 | ||
1283 | ] | |
1284 | }, | |
1285 | { | |
1286 | "bus":0, | |
1287 | "qdev_id":"", | |
1288 | "slot":1, | |
1289 | "class_info":{ | |
1290 | "class":1537, | |
1291 | "desc":"ISA bridge" | |
1292 | }, | |
1293 | "id":{ | |
1294 | "device":32902, | |
1295 | "vendor":28672 | |
1296 | }, | |
1297 | "function":0, | |
1298 | "regions":[ | |
1299 | ||
1300 | ] | |
1301 | }, | |
1302 | { | |
1303 | "bus":0, | |
1304 | "qdev_id":"", | |
1305 | "slot":1, | |
1306 | "class_info":{ | |
1307 | "class":257, | |
1308 | "desc":"IDE controller" | |
1309 | }, | |
1310 | "id":{ | |
1311 | "device":32902, | |
1312 | "vendor":28688 | |
1313 | }, | |
1314 | "function":1, | |
1315 | "regions":[ | |
1316 | { | |
1317 | "bar":4, | |
1318 | "size":16, | |
1319 | "address":49152, | |
1320 | "type":"io" | |
1321 | } | |
1322 | ] | |
1323 | }, | |
1324 | { | |
1325 | "bus":0, | |
1326 | "qdev_id":"", | |
1327 | "slot":2, | |
1328 | "class_info":{ | |
1329 | "class":768, | |
1330 | "desc":"VGA controller" | |
1331 | }, | |
1332 | "id":{ | |
1333 | "device":4115, | |
1334 | "vendor":184 | |
1335 | }, | |
1336 | "function":0, | |
1337 | "regions":[ | |
1338 | { | |
1339 | "prefetch":true, | |
1340 | "mem_type_64":false, | |
1341 | "bar":0, | |
1342 | "size":33554432, | |
1343 | "address":4026531840, | |
1344 | "type":"memory" | |
1345 | }, | |
1346 | { | |
1347 | "prefetch":false, | |
1348 | "mem_type_64":false, | |
1349 | "bar":1, | |
1350 | "size":4096, | |
1351 | "address":4060086272, | |
1352 | "type":"memory" | |
1353 | }, | |
1354 | { | |
1355 | "prefetch":false, | |
1356 | "mem_type_64":false, | |
1357 | "bar":6, | |
1358 | "size":65536, | |
1359 | "address":-1, | |
1360 | "type":"memory" | |
1361 | } | |
1362 | ] | |
1363 | }, | |
1364 | { | |
1365 | "bus":0, | |
1366 | "qdev_id":"", | |
1367 | "irq":11, | |
1368 | "slot":4, | |
1369 | "class_info":{ | |
1370 | "class":1280, | |
1371 | "desc":"RAM controller" | |
1372 | }, | |
1373 | "id":{ | |
1374 | "device":6900, | |
1375 | "vendor":4098 | |
1376 | }, | |
1377 | "function":0, | |
1378 | "regions":[ | |
1379 | { | |
1380 | "bar":0, | |
1381 | "size":32, | |
1382 | "address":49280, | |
1383 | "type":"io" | |
1384 | } | |
1385 | ] | |
1386 | } | |
1387 | ] | |
1388 | } | |
1389 | ] | |
1390 | } | |
1391 | ||
1392 | Note: This example has been shortened as the real response is too long. | |
1393 | ||
1394 | EQMP | |
1395 | ||
1396 | SQMP | |
1397 | query-kvm | |
1398 | --------- | |
1399 | ||
1400 | Show KVM information. | |
1401 | ||
1402 | Return a json-object with the following information: | |
1403 | ||
1404 | - "enabled": true if KVM support is enabled, false otherwise (json-bool) | |
1405 | - "present": true if QEMU has KVM support, false otherwise (json-bool) | |
1406 | ||
1407 | Example: | |
1408 | ||
1409 | -> { "execute": "query-kvm" } | |
1410 | <- { "return": { "enabled": true, "present": true } } | |
1411 | ||
1412 | EQMP | |
1413 | ||
1414 | SQMP | |
1415 | query-status | |
1416 | ------------ | |
1417 | ||
1418 | Return a json-object with the following information: | |
1419 | ||
1420 | - "running": true if the VM is running, or false if it is paused (json-bool) | |
1421 | - "singlestep": true if the VM is in single step mode, | |
1422 | false otherwise (json-bool) | |
1423 | ||
1424 | Example: | |
1425 | ||
1426 | -> { "execute": "query-status" } | |
1427 | <- { "return": { "running": true, "singlestep": false } } | |
1428 | ||
1429 | EQMP | |
1430 | ||
1431 | SQMP | |
1432 | query-mice | |
1433 | ---------- | |
1434 | ||
1435 | Show VM mice information. | |
1436 | ||
1437 | Each mouse is represented by a json-object, the returned value is a json-array | |
1438 | of all mice. | |
1439 | ||
1440 | The mouse json-object contains the following: | |
1441 | ||
1442 | - "name": mouse's name (json-string) | |
1443 | - "index": mouse's index (json-int) | |
1444 | - "current": true if this mouse is receiving events, false otherwise (json-bool) | |
1445 | - "absolute": true if the mouse generates absolute input events (json-bool) | |
1446 | ||
1447 | Example: | |
1448 | ||
1449 | -> { "execute": "query-mice" } | |
1450 | <- { | |
1451 | "return":[ | |
1452 | { | |
1453 | "name":"QEMU Microsoft Mouse", | |
1454 | "index":0, | |
1455 | "current":false, | |
1456 | "absolute":false | |
1457 | }, | |
1458 | { | |
1459 | "name":"QEMU PS/2 Mouse", | |
1460 | "index":1, | |
1461 | "current":true, | |
1462 | "absolute":true | |
1463 | } | |
1464 | ] | |
1465 | } | |
1466 | ||
1467 | EQMP | |
1468 | ||
1469 | SQMP | |
1470 | query-vnc | |
1471 | --------- | |
1472 | ||
1473 | Show VNC server information. | |
1474 | ||
1475 | Return a json-object with server information. Connected clients are returned | |
1476 | as a json-array of json-objects. | |
1477 | ||
1478 | The main json-object contains the following: | |
1479 | ||
1480 | - "enabled": true or false (json-bool) | |
1481 | - "host": server's IP address (json-string) | |
1482 | - "family": address family (json-string) | |
1483 | - Possible values: "ipv4", "ipv6", "unix", "unknown" | |
1484 | - "service": server's port number (json-string) | |
1485 | - "auth": authentication method (json-string) | |
1486 | - Possible values: "invalid", "none", "ra2", "ra2ne", "sasl", "tight", | |
1487 | "tls", "ultra", "unknown", "vencrypt", "vencrypt", | |
1488 | "vencrypt+plain", "vencrypt+tls+none", | |
1489 | "vencrypt+tls+plain", "vencrypt+tls+sasl", | |
1490 | "vencrypt+tls+vnc", "vencrypt+x509+none", | |
1491 | "vencrypt+x509+plain", "vencrypt+x509+sasl", | |
1492 | "vencrypt+x509+vnc", "vnc" | |
1493 | - "clients": a json-array of all connected clients | |
1494 | ||
1495 | Clients are described by a json-object, each one contain the following: | |
1496 | ||
1497 | - "host": client's IP address (json-string) | |
1498 | - "family": address family (json-string) | |
1499 | - Possible values: "ipv4", "ipv6", "unix", "unknown" | |
1500 | - "service": client's port number (json-string) | |
1501 | - "x509_dname": TLS dname (json-string, optional) | |
1502 | - "sasl_username": SASL username (json-string, optional) | |
1503 | ||
1504 | Example: | |
1505 | ||
1506 | -> { "execute": "query-vnc" } | |
1507 | <- { | |
1508 | "return":{ | |
1509 | "enabled":true, | |
1510 | "host":"0.0.0.0", | |
1511 | "service":"50402", | |
1512 | "auth":"vnc", | |
1513 | "family":"ipv4", | |
1514 | "clients":[ | |
1515 | { | |
1516 | "host":"127.0.0.1", | |
1517 | "service":"50401", | |
1518 | "family":"ipv4" | |
1519 | } | |
1520 | ] | |
1521 | } | |
1522 | } | |
1523 | ||
1524 | EQMP | |
1525 | ||
cb42a870 GH |
1526 | SQMP |
1527 | query-spice | |
1528 | ----------- | |
1529 | ||
1530 | Show SPICE server information. | |
1531 | ||
1532 | Return a json-object with server information. Connected clients are returned | |
1533 | as a json-array of json-objects. | |
1534 | ||
1535 | The main json-object contains the following: | |
1536 | ||
1537 | - "enabled": true or false (json-bool) | |
1538 | - "host": server's IP address (json-string) | |
1539 | - "port": server's port number (json-int, optional) | |
1540 | - "tls-port": server's port number (json-int, optional) | |
1541 | - "auth": authentication method (json-string) | |
1542 | - Possible values: "none", "spice" | |
1543 | - "channels": a json-array of all active channels clients | |
1544 | ||
1545 | Channels are described by a json-object, each one contain the following: | |
1546 | ||
1547 | - "host": client's IP address (json-string) | |
1548 | - "family": address family (json-string) | |
1549 | - Possible values: "ipv4", "ipv6", "unix", "unknown" | |
1550 | - "port": client's port number (json-string) | |
1551 | - "connection-id": spice connection id. All channels with the same id | |
1552 | belong to the same spice session (json-int) | |
1553 | - "channel-type": channel type. "1" is the main control channel, filter for | |
1554 | this one if you want track spice sessions only (json-int) | |
1555 | - "channel-id": channel id. Usually "0", might be different needed when | |
1556 | multiple channels of the same type exist, such as multiple | |
1557 | display channels in a multihead setup (json-int) | |
1558 | - "tls": whevener the channel is encrypted (json-bool) | |
1559 | ||
1560 | Example: | |
1561 | ||
1562 | -> { "execute": "query-spice" } | |
1563 | <- { | |
1564 | "return": { | |
1565 | "enabled": true, | |
1566 | "auth": "spice", | |
1567 | "port": 5920, | |
1568 | "tls-port": 5921, | |
1569 | "host": "0.0.0.0", | |
1570 | "channels": [ | |
1571 | { | |
1572 | "port": "54924", | |
1573 | "family": "ipv4", | |
1574 | "channel-type": 1, | |
1575 | "connection-id": 1804289383, | |
1576 | "host": "127.0.0.1", | |
1577 | "channel-id": 0, | |
1578 | "tls": true | |
1579 | }, | |
1580 | { | |
1581 | "port": "36710", | |
1582 | "family": "ipv4", | |
1583 | "channel-type": 4, | |
1584 | "connection-id": 1804289383, | |
1585 | "host": "127.0.0.1", | |
1586 | "channel-id": 0, | |
1587 | "tls": false | |
1588 | }, | |
1589 | [ ... more channels follow ... ] | |
1590 | ] | |
1591 | } | |
1592 | } | |
1593 | ||
1594 | EQMP | |
1595 | ||
82a56f0d LC |
1596 | SQMP |
1597 | query-name | |
1598 | ---------- | |
1599 | ||
1600 | Show VM name. | |
1601 | ||
1602 | Return a json-object with the following information: | |
1603 | ||
1604 | - "name": VM's name (json-string, optional) | |
1605 | ||
1606 | Example: | |
1607 | ||
1608 | -> { "execute": "query-name" } | |
1609 | <- { "return": { "name": "qemu-name" } } | |
1610 | ||
1611 | EQMP | |
1612 | ||
1613 | SQMP | |
1614 | query-uuid | |
1615 | ---------- | |
1616 | ||
1617 | Show VM UUID. | |
1618 | ||
1619 | Return a json-object with the following information: | |
1620 | ||
1621 | - "UUID": Universally Unique Identifier (json-string) | |
1622 | ||
1623 | Example: | |
1624 | ||
1625 | -> { "execute": "query-uuid" } | |
1626 | <- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } } | |
1627 | ||
1628 | EQMP | |
1629 | ||
1630 | SQMP | |
1631 | query-migrate | |
1632 | ------------- | |
1633 | ||
1634 | Migration status. | |
1635 | ||
1636 | Return a json-object. If migration is active there will be another json-object | |
1637 | with RAM migration status and if block migration is active another one with | |
1638 | block migration status. | |
1639 | ||
1640 | The main json-object contains the following: | |
1641 | ||
1642 | - "status": migration status (json-string) | |
1643 | - Possible values: "active", "completed", "failed", "cancelled" | |
1644 | - "ram": only present if "status" is "active", it is a json-object with the | |
1645 | following RAM information (in bytes): | |
1646 | - "transferred": amount transferred (json-int) | |
1647 | - "remaining": amount remaining (json-int) | |
1648 | - "total": total (json-int) | |
1649 | - "disk": only present if "status" is "active" and it is a block migration, | |
1650 | it is a json-object with the following disk information (in bytes): | |
1651 | - "transferred": amount transferred (json-int) | |
1652 | - "remaining": amount remaining (json-int) | |
1653 | - "total": total (json-int) | |
1654 | ||
1655 | Examples: | |
1656 | ||
1657 | 1. Before the first migration | |
1658 | ||
1659 | -> { "execute": "query-migrate" } | |
1660 | <- { "return": {} } | |
1661 | ||
1662 | 2. Migration is done and has succeeded | |
1663 | ||
1664 | -> { "execute": "query-migrate" } | |
1665 | <- { "return": { "status": "completed" } } | |
1666 | ||
1667 | 3. Migration is done and has failed | |
1668 | ||
1669 | -> { "execute": "query-migrate" } | |
1670 | <- { "return": { "status": "failed" } } | |
1671 | ||
1672 | 4. Migration is being performed and is not a block migration: | |
1673 | ||
1674 | -> { "execute": "query-migrate" } | |
1675 | <- { | |
1676 | "return":{ | |
1677 | "status":"active", | |
1678 | "ram":{ | |
1679 | "transferred":123, | |
1680 | "remaining":123, | |
1681 | "total":246 | |
1682 | } | |
1683 | } | |
1684 | } | |
1685 | ||
1686 | 5. Migration is being performed and is a block migration: | |
1687 | ||
1688 | -> { "execute": "query-migrate" } | |
1689 | <- { | |
1690 | "return":{ | |
1691 | "status":"active", | |
1692 | "ram":{ | |
1693 | "total":1057024, | |
1694 | "remaining":1053304, | |
1695 | "transferred":3720 | |
1696 | }, | |
1697 | "disk":{ | |
1698 | "total":20971520, | |
1699 | "remaining":20880384, | |
1700 | "transferred":91136 | |
1701 | } | |
1702 | } | |
1703 | } | |
1704 | ||
1705 | EQMP | |
1706 | ||
1707 | SQMP | |
1708 | query-balloon | |
1709 | ------------- | |
1710 | ||
1711 | Show balloon information. | |
1712 | ||
1713 | Make an asynchronous request for balloon info. When the request completes a | |
1714 | json-object will be returned containing the following data: | |
1715 | ||
1716 | - "actual": current balloon value in bytes (json-int) | |
1717 | - "mem_swapped_in": Amount of memory swapped in bytes (json-int, optional) | |
1718 | - "mem_swapped_out": Amount of memory swapped out in bytes (json-int, optional) | |
1719 | - "major_page_faults": Number of major faults (json-int, optional) | |
1720 | - "minor_page_faults": Number of minor faults (json-int, optional) | |
1721 | - "free_mem": Total amount of free and unused memory in | |
1722 | bytes (json-int, optional) | |
1723 | - "total_mem": Total amount of available memory in bytes (json-int, optional) | |
1724 | ||
1725 | Example: | |
1726 | ||
1727 | -> { "execute": "query-balloon" } | |
1728 | <- { | |
1729 | "return":{ | |
1730 | "actual":1073741824, | |
1731 | "mem_swapped_in":0, | |
1732 | "mem_swapped_out":0, | |
1733 | "major_page_faults":142, | |
1734 | "minor_page_faults":239245, | |
1735 | "free_mem":1014185984, | |
1736 | "total_mem":1044668416 | |
1737 | } | |
1738 | } | |
1739 | ||
1740 | EQMP | |
1741 |