]> git.proxmox.com Git - mirror_qemu.git/blob - hmp-commands.hx
iotests, parallels: test for newly created parallels image via qemu-img
[mirror_qemu.git] / hmp-commands.hx
1 HXCOMM Use DEFHEADING() to define headings in both help text and texi
2 HXCOMM Text between STEXI and ETEXI are copied to texi version and
3 HXCOMM discarded from C version
4 HXCOMM DEF(command, args, callback, arg_string, help) is used to construct
5 HXCOMM monitor commands
6 HXCOMM HXCOMM can be used for comments, discarded from both texi and C
7
8 STEXI
9 @table @option
10 ETEXI
11
12 {
13 .name = "help|?",
14 .args_type = "name:S?",
15 .params = "[cmd]",
16 .help = "show the help",
17 .mhandler.cmd = do_help_cmd,
18 },
19
20 STEXI
21 @item help or ? [@var{cmd}]
22 @findex help
23 Show the help for all commands or just for command @var{cmd}.
24 ETEXI
25
26 {
27 .name = "commit",
28 .args_type = "device:B",
29 .params = "device|all",
30 .help = "commit changes to the disk images (if -snapshot is used) or backing files",
31 .mhandler.cmd = hmp_commit,
32 },
33
34 STEXI
35 @item commit
36 @findex commit
37 Commit changes to the disk images (if -snapshot is used) or backing files.
38 If the backing file is smaller than the snapshot, then the backing file will be
39 resized to be the same size as the snapshot. If the snapshot is smaller than
40 the backing file, the backing file will not be truncated. If you want the
41 backing file to match the size of the smaller snapshot, you can safely truncate
42 it yourself once the commit operation successfully completes.
43 ETEXI
44
45 {
46 .name = "q|quit",
47 .args_type = "",
48 .params = "",
49 .help = "quit the emulator",
50 .mhandler.cmd = hmp_quit,
51 },
52
53 STEXI
54 @item q or quit
55 @findex quit
56 Quit the emulator.
57 ETEXI
58
59 {
60 .name = "block_resize",
61 .args_type = "device:B,size:o",
62 .params = "device size",
63 .help = "resize a block image",
64 .mhandler.cmd = hmp_block_resize,
65 },
66
67 STEXI
68 @item block_resize
69 @findex block_resize
70 Resize a block image while a guest is running. Usually requires guest
71 action to see the updated size. Resize to a lower size is supported,
72 but should be used with extreme caution. Note that this command only
73 resizes image files, it can not resize block devices like LVM volumes.
74 ETEXI
75
76 {
77 .name = "block_stream",
78 .args_type = "device:B,speed:o?,base:s?",
79 .params = "device [speed [base]]",
80 .help = "copy data from a backing file into a block device",
81 .mhandler.cmd = hmp_block_stream,
82 },
83
84 STEXI
85 @item block_stream
86 @findex block_stream
87 Copy data from a backing file into a block device.
88 ETEXI
89
90 {
91 .name = "block_job_set_speed",
92 .args_type = "device:B,speed:o",
93 .params = "device speed",
94 .help = "set maximum speed for a background block operation",
95 .mhandler.cmd = hmp_block_job_set_speed,
96 },
97
98 STEXI
99 @item block_job_set_speed
100 @findex block_job_set_speed
101 Set maximum speed for a background block operation.
102 ETEXI
103
104 {
105 .name = "block_job_cancel",
106 .args_type = "force:-f,device:B",
107 .params = "[-f] device",
108 .help = "stop an active background block operation (use -f"
109 "\n\t\t\t if the operation is currently paused)",
110 .mhandler.cmd = hmp_block_job_cancel,
111 },
112
113 STEXI
114 @item block_job_cancel
115 @findex block_job_cancel
116 Stop an active background block operation (streaming, mirroring).
117 ETEXI
118
119 {
120 .name = "block_job_complete",
121 .args_type = "device:B",
122 .params = "device",
123 .help = "stop an active background block operation",
124 .mhandler.cmd = hmp_block_job_complete,
125 },
126
127 STEXI
128 @item block_job_complete
129 @findex block_job_complete
130 Manually trigger completion of an active background block operation.
131 For mirroring, this will switch the device to the destination path.
132 ETEXI
133
134 {
135 .name = "block_job_pause",
136 .args_type = "device:B",
137 .params = "device",
138 .help = "pause an active background block operation",
139 .mhandler.cmd = hmp_block_job_pause,
140 },
141
142 STEXI
143 @item block_job_pause
144 @findex block_job_pause
145 Pause an active block streaming operation.
146 ETEXI
147
148 {
149 .name = "block_job_resume",
150 .args_type = "device:B",
151 .params = "device",
152 .help = "resume a paused background block operation",
153 .mhandler.cmd = hmp_block_job_resume,
154 },
155
156 STEXI
157 @item block_job_resume
158 @findex block_job_resume
159 Resume a paused block streaming operation.
160 ETEXI
161
162 {
163 .name = "eject",
164 .args_type = "force:-f,device:B",
165 .params = "[-f] device",
166 .help = "eject a removable medium (use -f to force it)",
167 .mhandler.cmd = hmp_eject,
168 },
169
170 STEXI
171 @item eject [-f] @var{device}
172 @findex eject
173 Eject a removable medium (use -f to force it).
174 ETEXI
175
176 {
177 .name = "drive_del",
178 .args_type = "id:B",
179 .params = "device",
180 .help = "remove host block device",
181 .user_print = monitor_user_noop,
182 .mhandler.cmd_new = hmp_drive_del,
183 },
184
185 STEXI
186 @item drive_del @var{device}
187 @findex drive_del
188 Remove host block device. The result is that guest generated IO is no longer
189 submitted against the host device underlying the disk. Once a drive has
190 been deleted, the QEMU Block layer returns -EIO which results in IO
191 errors in the guest for applications that are reading/writing to the device.
192 These errors are always reported to the guest, regardless of the drive's error
193 actions (drive options rerror, werror).
194 ETEXI
195
196 {
197 .name = "change",
198 .args_type = "device:B,target:F,arg:s?",
199 .params = "device filename [format]",
200 .help = "change a removable medium, optional format",
201 .mhandler.cmd = hmp_change,
202 },
203
204 STEXI
205 @item change @var{device} @var{setting}
206 @findex change
207 Change the configuration of a device.
208
209 @table @option
210 @item change @var{diskdevice} @var{filename} [@var{format}]
211 Change the medium for a removable disk device to point to @var{filename}. eg
212
213 @example
214 (qemu) change ide1-cd0 /path/to/some.iso
215 @end example
216
217 @var{format} is optional.
218
219 @item change vnc @var{display},@var{options}
220 Change the configuration of the VNC server. The valid syntax for @var{display}
221 and @var{options} are described at @ref{sec_invocation}. eg
222
223 @example
224 (qemu) change vnc localhost:1
225 @end example
226
227 @item change vnc password [@var{password}]
228
229 Change the password associated with the VNC server. If the new password is not
230 supplied, the monitor will prompt for it to be entered. VNC passwords are only
231 significant up to 8 letters. eg
232
233 @example
234 (qemu) change vnc password
235 Password: ********
236 @end example
237
238 @end table
239 ETEXI
240
241 {
242 .name = "screendump",
243 .args_type = "filename:F",
244 .params = "filename",
245 .help = "save screen into PPM image 'filename'",
246 .mhandler.cmd = hmp_screendump,
247 },
248
249 STEXI
250 @item screendump @var{filename}
251 @findex screendump
252 Save screen into PPM image @var{filename}.
253 ETEXI
254
255 {
256 .name = "logfile",
257 .args_type = "filename:F",
258 .params = "filename",
259 .help = "output logs to 'filename'",
260 .mhandler.cmd = hmp_logfile,
261 },
262
263 STEXI
264 @item logfile @var{filename}
265 @findex logfile
266 Output logs to @var{filename}.
267 ETEXI
268
269 {
270 .name = "trace-event",
271 .args_type = "name:s,option:b",
272 .params = "name on|off",
273 .help = "changes status of a specific trace event",
274 .mhandler.cmd = hmp_trace_event,
275 },
276
277 STEXI
278 @item trace-event
279 @findex trace-event
280 changes status of a trace event
281 ETEXI
282
283 #if defined(CONFIG_TRACE_SIMPLE)
284 {
285 .name = "trace-file",
286 .args_type = "op:s?,arg:F?",
287 .params = "on|off|flush|set [arg]",
288 .help = "open, close, or flush trace file, or set a new file name",
289 .mhandler.cmd = hmp_trace_file,
290 },
291
292 STEXI
293 @item trace-file on|off|flush
294 @findex trace-file
295 Open, close, or flush the trace file. If no argument is given, the status of the trace file is displayed.
296 ETEXI
297 #endif
298
299 {
300 .name = "log",
301 .args_type = "items:s",
302 .params = "item1[,...]",
303 .help = "activate logging of the specified items",
304 .mhandler.cmd = hmp_log,
305 },
306
307 STEXI
308 @item log @var{item1}[,...]
309 @findex log
310 Activate logging of the specified items.
311 ETEXI
312
313 {
314 .name = "savevm",
315 .args_type = "name:s?",
316 .params = "[tag|id]",
317 .help = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
318 .mhandler.cmd = hmp_savevm,
319 },
320
321 STEXI
322 @item savevm [@var{tag}|@var{id}]
323 @findex savevm
324 Create a snapshot of the whole virtual machine. If @var{tag} is
325 provided, it is used as human readable identifier. If there is already
326 a snapshot with the same tag or ID, it is replaced. More info at
327 @ref{vm_snapshots}.
328 ETEXI
329
330 {
331 .name = "loadvm",
332 .args_type = "name:s",
333 .params = "tag|id",
334 .help = "restore a VM snapshot from its tag or id",
335 .mhandler.cmd = hmp_loadvm,
336 .command_completion = loadvm_completion,
337 },
338
339 STEXI
340 @item loadvm @var{tag}|@var{id}
341 @findex loadvm
342 Set the whole virtual machine to the snapshot identified by the tag
343 @var{tag} or the unique snapshot ID @var{id}.
344 ETEXI
345
346 {
347 .name = "delvm",
348 .args_type = "name:s",
349 .params = "tag|id",
350 .help = "delete a VM snapshot from its tag or id",
351 .mhandler.cmd = hmp_delvm,
352 .command_completion = delvm_completion,
353 },
354
355 STEXI
356 @item delvm @var{tag}|@var{id}
357 @findex delvm
358 Delete the snapshot identified by @var{tag} or @var{id}.
359 ETEXI
360
361 {
362 .name = "singlestep",
363 .args_type = "option:s?",
364 .params = "[on|off]",
365 .help = "run emulation in singlestep mode or switch to normal mode",
366 .mhandler.cmd = hmp_singlestep,
367 },
368
369 STEXI
370 @item singlestep [off]
371 @findex singlestep
372 Run the emulation in single step mode.
373 If called with option off, the emulation returns to normal mode.
374 ETEXI
375
376 {
377 .name = "stop",
378 .args_type = "",
379 .params = "",
380 .help = "stop emulation",
381 .mhandler.cmd = hmp_stop,
382 },
383
384 STEXI
385 @item stop
386 @findex stop
387 Stop emulation.
388 ETEXI
389
390 {
391 .name = "c|cont",
392 .args_type = "",
393 .params = "",
394 .help = "resume emulation",
395 .mhandler.cmd = hmp_cont,
396 },
397
398 STEXI
399 @item c or cont
400 @findex cont
401 Resume emulation.
402 ETEXI
403
404 {
405 .name = "system_wakeup",
406 .args_type = "",
407 .params = "",
408 .help = "wakeup guest from suspend",
409 .mhandler.cmd = hmp_system_wakeup,
410 },
411
412 STEXI
413 @item system_wakeup
414 @findex system_wakeup
415 Wakeup guest from suspend.
416 ETEXI
417
418 {
419 .name = "gdbserver",
420 .args_type = "device:s?",
421 .params = "[device]",
422 .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
423 .mhandler.cmd = hmp_gdbserver,
424 },
425
426 STEXI
427 @item gdbserver [@var{port}]
428 @findex gdbserver
429 Start gdbserver session (default @var{port}=1234)
430 ETEXI
431
432 {
433 .name = "x",
434 .args_type = "fmt:/,addr:l",
435 .params = "/fmt addr",
436 .help = "virtual memory dump starting at 'addr'",
437 .mhandler.cmd = hmp_memory_dump,
438 },
439
440 STEXI
441 @item x/fmt @var{addr}
442 @findex x
443 Virtual memory dump starting at @var{addr}.
444 ETEXI
445
446 {
447 .name = "xp",
448 .args_type = "fmt:/,addr:l",
449 .params = "/fmt addr",
450 .help = "physical memory dump starting at 'addr'",
451 .mhandler.cmd = hmp_physical_memory_dump,
452 },
453
454 STEXI
455 @item xp /@var{fmt} @var{addr}
456 @findex xp
457 Physical memory dump starting at @var{addr}.
458
459 @var{fmt} is a format which tells the command how to format the
460 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
461
462 @table @var
463 @item count
464 is the number of items to be dumped.
465
466 @item format
467 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
468 c (char) or i (asm instruction).
469
470 @item size
471 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
472 @code{h} or @code{w} can be specified with the @code{i} format to
473 respectively select 16 or 32 bit code instruction size.
474
475 @end table
476
477 Examples:
478 @itemize
479 @item
480 Dump 10 instructions at the current instruction pointer:
481 @example
482 (qemu) x/10i $eip
483 0x90107063: ret
484 0x90107064: sti
485 0x90107065: lea 0x0(%esi,1),%esi
486 0x90107069: lea 0x0(%edi,1),%edi
487 0x90107070: ret
488 0x90107071: jmp 0x90107080
489 0x90107073: nop
490 0x90107074: nop
491 0x90107075: nop
492 0x90107076: nop
493 @end example
494
495 @item
496 Dump 80 16 bit values at the start of the video memory.
497 @smallexample
498 (qemu) xp/80hx 0xb8000
499 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
500 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
501 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
502 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
503 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
504 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
505 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
506 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
507 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
508 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
509 @end smallexample
510 @end itemize
511 ETEXI
512
513 {
514 .name = "p|print",
515 .args_type = "fmt:/,val:l",
516 .params = "/fmt expr",
517 .help = "print expression value (use $reg for CPU register access)",
518 .mhandler.cmd = do_print,
519 },
520
521 STEXI
522 @item p or print/@var{fmt} @var{expr}
523 @findex print
524 Print expression value. Only the @var{format} part of @var{fmt} is
525 used.
526 ETEXI
527
528 {
529 .name = "i",
530 .args_type = "fmt:/,addr:i,index:i.",
531 .params = "/fmt addr",
532 .help = "I/O port read",
533 .mhandler.cmd = hmp_ioport_read,
534 },
535
536 STEXI
537 @item i/@var{fmt} @var{addr} [.@var{index}]
538 @findex i
539 Read I/O port.
540 ETEXI
541
542 {
543 .name = "o",
544 .args_type = "fmt:/,addr:i,val:i",
545 .params = "/fmt addr value",
546 .help = "I/O port write",
547 .mhandler.cmd = hmp_ioport_write,
548 },
549
550 STEXI
551 @item o/@var{fmt} @var{addr} @var{val}
552 @findex o
553 Write to I/O port.
554 ETEXI
555
556 {
557 .name = "sendkey",
558 .args_type = "keys:s,hold-time:i?",
559 .params = "keys [hold_ms]",
560 .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
561 .mhandler.cmd = hmp_sendkey,
562 .command_completion = sendkey_completion,
563 },
564
565 STEXI
566 @item sendkey @var{keys}
567 @findex sendkey
568 Send @var{keys} to the guest. @var{keys} could be the name of the
569 key or the raw value in hexadecimal format. Use @code{-} to press
570 several keys simultaneously. Example:
571 @example
572 sendkey ctrl-alt-f1
573 @end example
574
575 This command is useful to send keys that your graphical user interface
576 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
577 ETEXI
578
579 {
580 .name = "system_reset",
581 .args_type = "",
582 .params = "",
583 .help = "reset the system",
584 .mhandler.cmd = hmp_system_reset,
585 },
586
587 STEXI
588 @item system_reset
589 @findex system_reset
590 Reset the system.
591 ETEXI
592
593 {
594 .name = "system_powerdown",
595 .args_type = "",
596 .params = "",
597 .help = "send system power down event",
598 .mhandler.cmd = hmp_system_powerdown,
599 },
600
601 STEXI
602 @item system_powerdown
603 @findex system_powerdown
604 Power down the system (if supported).
605 ETEXI
606
607 {
608 .name = "sum",
609 .args_type = "start:i,size:i",
610 .params = "addr size",
611 .help = "compute the checksum of a memory region",
612 .mhandler.cmd = hmp_sum,
613 },
614
615 STEXI
616 @item sum @var{addr} @var{size}
617 @findex sum
618 Compute the checksum of a memory region.
619 ETEXI
620
621 {
622 .name = "usb_add",
623 .args_type = "devname:s",
624 .params = "device",
625 .help = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
626 .mhandler.cmd = hmp_usb_add,
627 },
628
629 STEXI
630 @item usb_add @var{devname}
631 @findex usb_add
632 Add the USB device @var{devname}. For details of available devices see
633 @ref{usb_devices}
634 ETEXI
635
636 {
637 .name = "usb_del",
638 .args_type = "devname:s",
639 .params = "device",
640 .help = "remove USB device 'bus.addr'",
641 .mhandler.cmd = hmp_usb_del,
642 },
643
644 STEXI
645 @item usb_del @var{devname}
646 @findex usb_del
647 Remove the USB device @var{devname} from the QEMU virtual USB
648 hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
649 command @code{info usb} to see the devices you can remove.
650 ETEXI
651
652 {
653 .name = "device_add",
654 .args_type = "device:O",
655 .params = "driver[,prop=value][,...]",
656 .help = "add device, like -device on the command line",
657 .user_print = monitor_user_noop,
658 .mhandler.cmd_new = do_device_add,
659 .command_completion = device_add_completion,
660 },
661
662 STEXI
663 @item device_add @var{config}
664 @findex device_add
665 Add device.
666 ETEXI
667
668 {
669 .name = "device_del",
670 .args_type = "id:s",
671 .params = "device",
672 .help = "remove device",
673 .mhandler.cmd = hmp_device_del,
674 .command_completion = device_del_completion,
675 },
676
677 STEXI
678 @item device_del @var{id}
679 @findex device_del
680 Remove device @var{id}.
681 ETEXI
682
683 {
684 .name = "cpu",
685 .args_type = "index:i",
686 .params = "index",
687 .help = "set the default CPU",
688 .mhandler.cmd = hmp_cpu,
689 },
690
691 STEXI
692 @item cpu @var{index}
693 @findex cpu
694 Set the default CPU.
695 ETEXI
696
697 {
698 .name = "mouse_move",
699 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
700 .params = "dx dy [dz]",
701 .help = "send mouse move events",
702 .mhandler.cmd = hmp_mouse_move,
703 },
704
705 STEXI
706 @item mouse_move @var{dx} @var{dy} [@var{dz}]
707 @findex mouse_move
708 Move the active mouse to the specified coordinates @var{dx} @var{dy}
709 with optional scroll axis @var{dz}.
710 ETEXI
711
712 {
713 .name = "mouse_button",
714 .args_type = "button_state:i",
715 .params = "state",
716 .help = "change mouse button state (1=L, 2=M, 4=R)",
717 .mhandler.cmd = hmp_mouse_button,
718 },
719
720 STEXI
721 @item mouse_button @var{val}
722 @findex mouse_button
723 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
724 ETEXI
725
726 {
727 .name = "mouse_set",
728 .args_type = "index:i",
729 .params = "index",
730 .help = "set which mouse device receives events",
731 .mhandler.cmd = hmp_mouse_set,
732 },
733
734 STEXI
735 @item mouse_set @var{index}
736 @findex mouse_set
737 Set which mouse device receives events at given @var{index}, index
738 can be obtained with
739 @example
740 info mice
741 @end example
742 ETEXI
743
744 {
745 .name = "wavcapture",
746 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
747 .params = "path [frequency [bits [channels]]]",
748 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
749 .mhandler.cmd = hmp_wavcapture,
750 },
751 STEXI
752 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
753 @findex wavcapture
754 Capture audio into @var{filename}. Using sample rate @var{frequency}
755 bits per sample @var{bits} and number of channels @var{channels}.
756
757 Defaults:
758 @itemize @minus
759 @item Sample rate = 44100 Hz - CD quality
760 @item Bits = 16
761 @item Number of channels = 2 - Stereo
762 @end itemize
763 ETEXI
764
765 {
766 .name = "stopcapture",
767 .args_type = "n:i",
768 .params = "capture index",
769 .help = "stop capture",
770 .mhandler.cmd = hmp_stopcapture,
771 },
772 STEXI
773 @item stopcapture @var{index}
774 @findex stopcapture
775 Stop capture with a given @var{index}, index can be obtained with
776 @example
777 info capture
778 @end example
779 ETEXI
780
781 {
782 .name = "memsave",
783 .args_type = "val:l,size:i,filename:s",
784 .params = "addr size file",
785 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
786 .mhandler.cmd = hmp_memsave,
787 },
788
789 STEXI
790 @item memsave @var{addr} @var{size} @var{file}
791 @findex memsave
792 save to disk virtual memory dump starting at @var{addr} of size @var{size}.
793 ETEXI
794
795 {
796 .name = "pmemsave",
797 .args_type = "val:l,size:i,filename:s",
798 .params = "addr size file",
799 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
800 .mhandler.cmd = hmp_pmemsave,
801 },
802
803 STEXI
804 @item pmemsave @var{addr} @var{size} @var{file}
805 @findex pmemsave
806 save to disk physical memory dump starting at @var{addr} of size @var{size}.
807 ETEXI
808
809 {
810 .name = "boot_set",
811 .args_type = "bootdevice:s",
812 .params = "bootdevice",
813 .help = "define new values for the boot device list",
814 .mhandler.cmd = hmp_boot_set,
815 },
816
817 STEXI
818 @item boot_set @var{bootdevicelist}
819 @findex boot_set
820 Define new values for the boot device list. Those values will override
821 the values specified on the command line through the @code{-boot} option.
822
823 The values that can be specified here depend on the machine type, but are
824 the same that can be specified in the @code{-boot} command line option.
825 ETEXI
826
827 {
828 .name = "nmi",
829 .args_type = "",
830 .params = "",
831 .help = "inject an NMI",
832 .mhandler.cmd = hmp_nmi,
833 },
834 STEXI
835 @item nmi @var{cpu}
836 @findex nmi
837 Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
838
839 ETEXI
840
841 {
842 .name = "ringbuf_write",
843 .args_type = "device:s,data:s",
844 .params = "device data",
845 .help = "Write to a ring buffer character device",
846 .mhandler.cmd = hmp_ringbuf_write,
847 .command_completion = ringbuf_write_completion,
848 },
849
850 STEXI
851 @item ringbuf_write @var{device} @var{data}
852 @findex ringbuf_write
853 Write @var{data} to ring buffer character device @var{device}.
854 @var{data} must be a UTF-8 string.
855
856 ETEXI
857
858 {
859 .name = "ringbuf_read",
860 .args_type = "device:s,size:i",
861 .params = "device size",
862 .help = "Read from a ring buffer character device",
863 .mhandler.cmd = hmp_ringbuf_read,
864 .command_completion = ringbuf_write_completion,
865 },
866
867 STEXI
868 @item ringbuf_read @var{device}
869 @findex ringbuf_read
870 Read and print up to @var{size} bytes from ring buffer character
871 device @var{device}.
872 Certain non-printable characters are printed \uXXXX, where XXXX is the
873 character code in hexadecimal. Character \ is printed \\.
874 Bug: can screw up when the buffer contains invalid UTF-8 sequences,
875 NUL characters, after the ring buffer lost data, and when reading
876 stops because the size limit is reached.
877
878 ETEXI
879
880 {
881 .name = "migrate",
882 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
883 .params = "[-d] [-b] [-i] uri",
884 .help = "migrate to URI (using -d to not wait for completion)"
885 "\n\t\t\t -b for migration without shared storage with"
886 " full copy of disk\n\t\t\t -i for migration without "
887 "shared storage with incremental copy of disk "
888 "(base image shared between src and destination)",
889 .mhandler.cmd = hmp_migrate,
890 },
891
892
893 STEXI
894 @item migrate [-d] [-b] [-i] @var{uri}
895 @findex migrate
896 Migrate to @var{uri} (using -d to not wait for completion).
897 -b for migration with full copy of disk
898 -i for migration with incremental copy of disk (base image is shared)
899 ETEXI
900
901 {
902 .name = "migrate_cancel",
903 .args_type = "",
904 .params = "",
905 .help = "cancel the current VM migration",
906 .mhandler.cmd = hmp_migrate_cancel,
907 },
908
909 STEXI
910 @item migrate_cancel
911 @findex migrate_cancel
912 Cancel the current VM migration.
913
914 ETEXI
915
916 {
917 .name = "migrate_incoming",
918 .args_type = "uri:s",
919 .params = "uri",
920 .help = "Continue an incoming migration from an -incoming defer",
921 .mhandler.cmd = hmp_migrate_incoming,
922 },
923
924 STEXI
925 @item migrate_incoming @var{uri}
926 @findex migrate_incoming
927 Continue an incoming migration using the @var{uri} (that has the same syntax
928 as the -incoming option).
929
930 ETEXI
931
932 {
933 .name = "migrate_set_cache_size",
934 .args_type = "value:o",
935 .params = "value",
936 .help = "set cache size (in bytes) for XBZRLE migrations,"
937 "the cache size will be rounded down to the nearest "
938 "power of 2.\n"
939 "The cache size affects the number of cache misses."
940 "In case of a high cache miss ratio you need to increase"
941 " the cache size",
942 .mhandler.cmd = hmp_migrate_set_cache_size,
943 },
944
945 STEXI
946 @item migrate_set_cache_size @var{value}
947 @findex migrate_set_cache_size
948 Set cache size to @var{value} (in bytes) for xbzrle migrations.
949 ETEXI
950
951 {
952 .name = "migrate_set_speed",
953 .args_type = "value:o",
954 .params = "value",
955 .help = "set maximum speed (in bytes) for migrations. "
956 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
957 .mhandler.cmd = hmp_migrate_set_speed,
958 },
959
960 STEXI
961 @item migrate_set_speed @var{value}
962 @findex migrate_set_speed
963 Set maximum speed to @var{value} (in bytes) for migrations.
964 ETEXI
965
966 {
967 .name = "migrate_set_downtime",
968 .args_type = "value:T",
969 .params = "value",
970 .help = "set maximum tolerated downtime (in seconds) for migrations",
971 .mhandler.cmd = hmp_migrate_set_downtime,
972 },
973
974 STEXI
975 @item migrate_set_downtime @var{second}
976 @findex migrate_set_downtime
977 Set maximum tolerated downtime (in seconds) for migration.
978 ETEXI
979
980 {
981 .name = "migrate_set_capability",
982 .args_type = "capability:s,state:b",
983 .params = "capability state",
984 .help = "Enable/Disable the usage of a capability for migration",
985 .mhandler.cmd = hmp_migrate_set_capability,
986 .command_completion = migrate_set_capability_completion,
987 },
988
989 STEXI
990 @item migrate_set_capability @var{capability} @var{state}
991 @findex migrate_set_capability
992 Enable/Disable the usage of a capability @var{capability} for migration.
993 ETEXI
994
995 {
996 .name = "migrate_set_parameter",
997 .args_type = "parameter:s,value:i",
998 .params = "parameter value",
999 .help = "Set the parameter for migration",
1000 .mhandler.cmd = hmp_migrate_set_parameter,
1001 .command_completion = migrate_set_parameter_completion,
1002 },
1003
1004 STEXI
1005 @item migrate_set_parameter @var{parameter} @var{value}
1006 @findex migrate_set_parameter
1007 Set the parameter @var{parameter} for migration.
1008 ETEXI
1009
1010 {
1011 .name = "client_migrate_info",
1012 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1013 .params = "protocol hostname port tls-port cert-subject",
1014 .help = "send migration info to spice/vnc client",
1015 .user_print = monitor_user_noop,
1016 .mhandler.cmd_new = client_migrate_info,
1017 },
1018
1019 STEXI
1020 @item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
1021 @findex client_migrate_info
1022 Set the spice/vnc connection info for the migration target. The spice/vnc
1023 server will ask the spice/vnc client to automatically reconnect using the
1024 new parameters (if specified) once the vm migration finished successfully.
1025 ETEXI
1026
1027 {
1028 .name = "dump-guest-memory",
1029 .args_type = "paging:-p,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:i?,length:i?",
1030 .params = "[-p] [-z|-l|-s] filename [begin length]",
1031 .help = "dump guest memory into file 'filename'.\n\t\t\t"
1032 "-p: do paging to get guest's memory mapping.\n\t\t\t"
1033 "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1034 "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1035 "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
1036 "begin: the starting physical address.\n\t\t\t"
1037 "length: the memory size, in bytes.",
1038 .mhandler.cmd = hmp_dump_guest_memory,
1039 },
1040
1041
1042 STEXI
1043 @item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
1044 @item dump-guest-memory [-z|-l|-s] @var{filename}
1045 @findex dump-guest-memory
1046 Dump guest memory to @var{protocol}. The file can be processed with crash or
1047 gdb. Without -z|-l|-s, the dump format is ELF.
1048 -p: do paging to get guest's memory mapping.
1049 -z: dump in kdump-compressed format, with zlib compression.
1050 -l: dump in kdump-compressed format, with lzo compression.
1051 -s: dump in kdump-compressed format, with snappy compression.
1052 filename: dump file name.
1053 begin: the starting physical address. It's optional, and should be
1054 specified together with length.
1055 length: the memory size, in bytes. It's optional, and should be specified
1056 together with begin.
1057 ETEXI
1058
1059 {
1060 .name = "snapshot_blkdev",
1061 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1062 .params = "[-n] device [new-image-file] [format]",
1063 .help = "initiates a live snapshot\n\t\t\t"
1064 "of device. If a new image file is specified, the\n\t\t\t"
1065 "new image file will become the new root image.\n\t\t\t"
1066 "If format is specified, the snapshot file will\n\t\t\t"
1067 "be created in that format.\n\t\t\t"
1068 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1069 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1070 "recreating it from scratch.",
1071 .mhandler.cmd = hmp_snapshot_blkdev,
1072 },
1073
1074 STEXI
1075 @item snapshot_blkdev
1076 @findex snapshot_blkdev
1077 Snapshot device, using snapshot file as target if provided
1078 ETEXI
1079
1080 {
1081 .name = "snapshot_blkdev_internal",
1082 .args_type = "device:B,name:s",
1083 .params = "device name",
1084 .help = "take an internal snapshot of device.\n\t\t\t"
1085 "The format of the image used by device must\n\t\t\t"
1086 "support it, such as qcow2.\n\t\t\t",
1087 .mhandler.cmd = hmp_snapshot_blkdev_internal,
1088 },
1089
1090 STEXI
1091 @item snapshot_blkdev_internal
1092 @findex snapshot_blkdev_internal
1093 Take an internal snapshot on device if it support
1094 ETEXI
1095
1096 {
1097 .name = "snapshot_delete_blkdev_internal",
1098 .args_type = "device:B,name:s,id:s?",
1099 .params = "device name [id]",
1100 .help = "delete an internal snapshot of device.\n\t\t\t"
1101 "If id is specified, qemu will try delete\n\t\t\t"
1102 "the snapshot matching both id and name.\n\t\t\t"
1103 "The format of the image used by device must\n\t\t\t"
1104 "support it, such as qcow2.\n\t\t\t",
1105 .mhandler.cmd = hmp_snapshot_delete_blkdev_internal,
1106 },
1107
1108 STEXI
1109 @item snapshot_delete_blkdev_internal
1110 @findex snapshot_delete_blkdev_internal
1111 Delete an internal snapshot on device if it support
1112 ETEXI
1113
1114 {
1115 .name = "drive_mirror",
1116 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1117 .params = "[-n] [-f] device target [format]",
1118 .help = "initiates live storage\n\t\t\t"
1119 "migration for a device. The device's contents are\n\t\t\t"
1120 "copied to the new image file, including data that\n\t\t\t"
1121 "is written after the command is started.\n\t\t\t"
1122 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1123 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1124 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1125 "so that the result does not need a backing file.\n\t\t\t",
1126 .mhandler.cmd = hmp_drive_mirror,
1127 },
1128 STEXI
1129 @item drive_mirror
1130 @findex drive_mirror
1131 Start mirroring a block device's writes to a new destination,
1132 using the specified target.
1133 ETEXI
1134
1135 {
1136 .name = "drive_backup",
1137 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1138 .params = "[-n] [-f] device target [format]",
1139 .help = "initiates a point-in-time\n\t\t\t"
1140 "copy for a device. The device's contents are\n\t\t\t"
1141 "copied to the new image file, excluding data that\n\t\t\t"
1142 "is written after the command is started.\n\t\t\t"
1143 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1144 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1145 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1146 "so that the result does not need a backing file.\n\t\t\t",
1147 .mhandler.cmd = hmp_drive_backup,
1148 },
1149 STEXI
1150 @item drive_backup
1151 @findex drive_backup
1152 Start a point-in-time copy of a block device to a specificed target.
1153 ETEXI
1154
1155 {
1156 .name = "drive_add",
1157 .args_type = "pci_addr:s,opts:s",
1158 .params = "[[<domain>:]<bus>:]<slot>\n"
1159 "[file=file][,if=type][,bus=n]\n"
1160 "[,unit=m][,media=d][,index=i]\n"
1161 "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
1162 "[,snapshot=on|off][,cache=on|off]\n"
1163 "[,readonly=on|off][,copy-on-read=on|off]",
1164 .help = "add drive to PCI storage controller",
1165 .mhandler.cmd = hmp_drive_add,
1166 },
1167
1168 STEXI
1169 @item drive_add
1170 @findex drive_add
1171 Add drive to PCI storage controller.
1172 ETEXI
1173
1174 {
1175 .name = "pcie_aer_inject_error",
1176 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1177 "id:s,error_status:s,"
1178 "header0:i?,header1:i?,header2:i?,header3:i?,"
1179 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1180 .params = "[-a] [-c] id "
1181 "<error_status> [<tlp header> [<tlp header prefix>]]",
1182 .help = "inject pcie aer error\n\t\t\t"
1183 " -a for advisory non fatal error\n\t\t\t"
1184 " -c for correctable error\n\t\t\t"
1185 "<id> = qdev device id\n\t\t\t"
1186 "<error_status> = error string or 32bit\n\t\t\t"
1187 "<tlb header> = 32bit x 4\n\t\t\t"
1188 "<tlb header prefix> = 32bit x 4",
1189 .user_print = pcie_aer_inject_error_print,
1190 .mhandler.cmd_new = hmp_pcie_aer_inject_error,
1191 },
1192
1193 STEXI
1194 @item pcie_aer_inject_error
1195 @findex pcie_aer_inject_error
1196 Inject PCIe AER error
1197 ETEXI
1198
1199 {
1200 .name = "host_net_add",
1201 .args_type = "device:s,opts:s?",
1202 .params = "tap|user|socket|vde|netmap|bridge|vhost-user|dump [options]",
1203 .help = "add host VLAN client",
1204 .mhandler.cmd = hmp_host_net_add,
1205 .command_completion = host_net_add_completion,
1206 },
1207
1208 STEXI
1209 @item host_net_add
1210 @findex host_net_add
1211 Add host VLAN client.
1212 ETEXI
1213
1214 {
1215 .name = "host_net_remove",
1216 .args_type = "vlan_id:i,device:s",
1217 .params = "vlan_id name",
1218 .help = "remove host VLAN client",
1219 .mhandler.cmd = hmp_host_net_remove,
1220 .command_completion = host_net_remove_completion,
1221 },
1222
1223 STEXI
1224 @item host_net_remove
1225 @findex host_net_remove
1226 Remove host VLAN client.
1227 ETEXI
1228
1229 {
1230 .name = "netdev_add",
1231 .args_type = "netdev:O",
1232 .params = "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
1233 .help = "add host network device",
1234 .mhandler.cmd = hmp_netdev_add,
1235 .command_completion = netdev_add_completion,
1236 },
1237
1238 STEXI
1239 @item netdev_add
1240 @findex netdev_add
1241 Add host network device.
1242 ETEXI
1243
1244 {
1245 .name = "netdev_del",
1246 .args_type = "id:s",
1247 .params = "id",
1248 .help = "remove host network device",
1249 .mhandler.cmd = hmp_netdev_del,
1250 .command_completion = netdev_del_completion,
1251 },
1252
1253 STEXI
1254 @item netdev_del
1255 @findex netdev_del
1256 Remove host network device.
1257 ETEXI
1258
1259 {
1260 .name = "object_add",
1261 .args_type = "object:O",
1262 .params = "[qom-type=]type,id=str[,prop=value][,...]",
1263 .help = "create QOM object",
1264 .mhandler.cmd = hmp_object_add,
1265 .command_completion = object_add_completion,
1266 },
1267
1268 STEXI
1269 @item object_add
1270 @findex object_add
1271 Create QOM object.
1272 ETEXI
1273
1274 {
1275 .name = "object_del",
1276 .args_type = "id:s",
1277 .params = "id",
1278 .help = "destroy QOM object",
1279 .mhandler.cmd = hmp_object_del,
1280 .command_completion = object_del_completion,
1281 },
1282
1283 STEXI
1284 @item object_del
1285 @findex object_del
1286 Destroy QOM object.
1287 ETEXI
1288
1289 #ifdef CONFIG_SLIRP
1290 {
1291 .name = "hostfwd_add",
1292 .args_type = "arg1:s,arg2:s?,arg3:s?",
1293 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1294 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
1295 .mhandler.cmd = hmp_hostfwd_add,
1296 },
1297 #endif
1298 STEXI
1299 @item hostfwd_add
1300 @findex hostfwd_add
1301 Redirect TCP or UDP connections from host to guest (requires -net user).
1302 ETEXI
1303
1304 #ifdef CONFIG_SLIRP
1305 {
1306 .name = "hostfwd_remove",
1307 .args_type = "arg1:s,arg2:s?,arg3:s?",
1308 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1309 .help = "remove host-to-guest TCP or UDP redirection",
1310 .mhandler.cmd = hmp_hostfwd_remove,
1311 },
1312
1313 #endif
1314 STEXI
1315 @item hostfwd_remove
1316 @findex hostfwd_remove
1317 Remove host-to-guest TCP or UDP redirection.
1318 ETEXI
1319
1320 {
1321 .name = "balloon",
1322 .args_type = "value:M",
1323 .params = "target",
1324 .help = "request VM to change its memory allocation (in MB)",
1325 .mhandler.cmd = hmp_balloon,
1326 },
1327
1328 STEXI
1329 @item balloon @var{value}
1330 @findex balloon
1331 Request VM to change its memory allocation to @var{value} (in MB).
1332 ETEXI
1333
1334 {
1335 .name = "set_link",
1336 .args_type = "name:s,up:b",
1337 .params = "name on|off",
1338 .help = "change the link status of a network adapter",
1339 .mhandler.cmd = hmp_set_link,
1340 .command_completion = set_link_completion,
1341 },
1342
1343 STEXI
1344 @item set_link @var{name} [on|off]
1345 @findex set_link
1346 Switch link @var{name} on (i.e. up) or off (i.e. down).
1347 ETEXI
1348
1349 {
1350 .name = "watchdog_action",
1351 .args_type = "action:s",
1352 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1353 .help = "change watchdog action",
1354 .mhandler.cmd = hmp_watchdog_action,
1355 .command_completion = watchdog_action_completion,
1356 },
1357
1358 STEXI
1359 @item watchdog_action
1360 @findex watchdog_action
1361 Change watchdog action.
1362 ETEXI
1363
1364 {
1365 .name = "acl_show",
1366 .args_type = "aclname:s",
1367 .params = "aclname",
1368 .help = "list rules in the access control list",
1369 .mhandler.cmd = hmp_acl_show,
1370 },
1371
1372 STEXI
1373 @item acl_show @var{aclname}
1374 @findex acl_show
1375 List all the matching rules in the access control list, and the default
1376 policy. There are currently two named access control lists,
1377 @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1378 certificate distinguished name, and SASL username respectively.
1379 ETEXI
1380
1381 {
1382 .name = "acl_policy",
1383 .args_type = "aclname:s,policy:s",
1384 .params = "aclname allow|deny",
1385 .help = "set default access control list policy",
1386 .mhandler.cmd = hmp_acl_policy,
1387 },
1388
1389 STEXI
1390 @item acl_policy @var{aclname} @code{allow|deny}
1391 @findex acl_policy
1392 Set the default access control list policy, used in the event that
1393 none of the explicit rules match. The default policy at startup is
1394 always @code{deny}.
1395 ETEXI
1396
1397 {
1398 .name = "acl_add",
1399 .args_type = "aclname:s,match:s,policy:s,index:i?",
1400 .params = "aclname match allow|deny [index]",
1401 .help = "add a match rule to the access control list",
1402 .mhandler.cmd = hmp_acl_add,
1403 },
1404
1405 STEXI
1406 @item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1407 @findex acl_add
1408 Add a match rule to the access control list, allowing or denying access.
1409 The match will normally be an exact username or x509 distinguished name,
1410 but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1411 allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
1412 normally be appended to the end of the ACL, but can be inserted
1413 earlier in the list if the optional @var{index} parameter is supplied.
1414 ETEXI
1415
1416 {
1417 .name = "acl_remove",
1418 .args_type = "aclname:s,match:s",
1419 .params = "aclname match",
1420 .help = "remove a match rule from the access control list",
1421 .mhandler.cmd = hmp_acl_remove,
1422 },
1423
1424 STEXI
1425 @item acl_remove @var{aclname} @var{match}
1426 @findex acl_remove
1427 Remove the specified match rule from the access control list.
1428 ETEXI
1429
1430 {
1431 .name = "acl_reset",
1432 .args_type = "aclname:s",
1433 .params = "aclname",
1434 .help = "reset the access control list",
1435 .mhandler.cmd = hmp_acl_reset,
1436 },
1437
1438 STEXI
1439 @item acl_reset @var{aclname}
1440 @findex acl_reset
1441 Remove all matches from the access control list, and set the default
1442 policy back to @code{deny}.
1443 ETEXI
1444
1445 {
1446 .name = "nbd_server_start",
1447 .args_type = "all:-a,writable:-w,uri:s",
1448 .params = "nbd_server_start [-a] [-w] host:port",
1449 .help = "serve block devices on the given host and port",
1450 .mhandler.cmd = hmp_nbd_server_start,
1451 },
1452 STEXI
1453 @item nbd_server_start @var{host}:@var{port}
1454 @findex nbd_server_start
1455 Start an NBD server on the given host and/or port. If the @option{-a}
1456 option is included, all of the virtual machine's block devices that
1457 have an inserted media on them are automatically exported; in this case,
1458 the @option{-w} option makes the devices writable too.
1459 ETEXI
1460
1461 {
1462 .name = "nbd_server_add",
1463 .args_type = "writable:-w,device:B",
1464 .params = "nbd_server_add [-w] device",
1465 .help = "export a block device via NBD",
1466 .mhandler.cmd = hmp_nbd_server_add,
1467 },
1468 STEXI
1469 @item nbd_server_add @var{device}
1470 @findex nbd_server_add
1471 Export a block device through QEMU's NBD server, which must be started
1472 beforehand with @command{nbd_server_start}. The @option{-w} option makes the
1473 exported device writable too.
1474 ETEXI
1475
1476 {
1477 .name = "nbd_server_stop",
1478 .args_type = "",
1479 .params = "nbd_server_stop",
1480 .help = "stop serving block devices using the NBD protocol",
1481 .mhandler.cmd = hmp_nbd_server_stop,
1482 },
1483 STEXI
1484 @item nbd_server_stop
1485 @findex nbd_server_stop
1486 Stop the QEMU embedded NBD server.
1487 ETEXI
1488
1489
1490 #if defined(TARGET_I386)
1491
1492 {
1493 .name = "mce",
1494 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1495 .params = "[-b] cpu bank status mcgstatus addr misc",
1496 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1497 .mhandler.cmd = hmp_mce,
1498 },
1499
1500 #endif
1501 STEXI
1502 @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1503 @findex mce (x86)
1504 Inject an MCE on the given CPU (x86 only).
1505 ETEXI
1506
1507 {
1508 .name = "getfd",
1509 .args_type = "fdname:s",
1510 .params = "getfd name",
1511 .help = "receive a file descriptor via SCM rights and assign it a name",
1512 .mhandler.cmd = hmp_getfd,
1513 },
1514
1515 STEXI
1516 @item getfd @var{fdname}
1517 @findex getfd
1518 If a file descriptor is passed alongside this command using the SCM_RIGHTS
1519 mechanism on unix sockets, it is stored using the name @var{fdname} for
1520 later use by other monitor commands.
1521 ETEXI
1522
1523 {
1524 .name = "closefd",
1525 .args_type = "fdname:s",
1526 .params = "closefd name",
1527 .help = "close a file descriptor previously passed via SCM rights",
1528 .mhandler.cmd = hmp_closefd,
1529 },
1530
1531 STEXI
1532 @item closefd @var{fdname}
1533 @findex closefd
1534 Close the file descriptor previously assigned to @var{fdname} using the
1535 @code{getfd} command. This is only needed if the file descriptor was never
1536 used by another monitor command.
1537 ETEXI
1538
1539 {
1540 .name = "block_passwd",
1541 .args_type = "device:B,password:s",
1542 .params = "block_passwd device password",
1543 .help = "set the password of encrypted block devices",
1544 .mhandler.cmd = hmp_block_passwd,
1545 },
1546
1547 STEXI
1548 @item block_passwd @var{device} @var{password}
1549 @findex block_passwd
1550 Set the encrypted device @var{device} password to @var{password}
1551 ETEXI
1552
1553 {
1554 .name = "block_set_io_throttle",
1555 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1556 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1557 .help = "change I/O throttle limits for a block drive",
1558 .mhandler.cmd = hmp_block_set_io_throttle,
1559 },
1560
1561 STEXI
1562 @item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1563 @findex block_set_io_throttle
1564 Change I/O throttle limits for a block drive to @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1565 ETEXI
1566
1567 {
1568 .name = "set_password",
1569 .args_type = "protocol:s,password:s,connected:s?",
1570 .params = "protocol password action-if-connected",
1571 .help = "set spice/vnc password",
1572 .mhandler.cmd = hmp_set_password,
1573 },
1574
1575 STEXI
1576 @item set_password [ vnc | spice ] password [ action-if-connected ]
1577 @findex set_password
1578 Change spice/vnc password. Use zero to make the password stay valid
1579 forever. @var{action-if-connected} specifies what should happen in
1580 case a connection is established: @var{fail} makes the password change
1581 fail. @var{disconnect} changes the password and disconnects the
1582 client. @var{keep} changes the password and keeps the connection up.
1583 @var{keep} is the default.
1584 ETEXI
1585
1586 {
1587 .name = "expire_password",
1588 .args_type = "protocol:s,time:s",
1589 .params = "protocol time",
1590 .help = "set spice/vnc password expire-time",
1591 .mhandler.cmd = hmp_expire_password,
1592 },
1593
1594 STEXI
1595 @item expire_password [ vnc | spice ] expire-time
1596 @findex expire_password
1597 Specify when a password for spice/vnc becomes
1598 invalid. @var{expire-time} accepts:
1599
1600 @table @var
1601 @item now
1602 Invalidate password instantly.
1603
1604 @item never
1605 Password stays valid forever.
1606
1607 @item +nsec
1608 Password stays valid for @var{nsec} seconds starting now.
1609
1610 @item nsec
1611 Password is invalidated at the given time. @var{nsec} are the seconds
1612 passed since 1970, i.e. unix epoch.
1613
1614 @end table
1615 ETEXI
1616
1617 {
1618 .name = "chardev-add",
1619 .args_type = "args:s",
1620 .params = "args",
1621 .help = "add chardev",
1622 .mhandler.cmd = hmp_chardev_add,
1623 .command_completion = chardev_add_completion,
1624 },
1625
1626 STEXI
1627 @item chardev-add args
1628 @findex chardev-add
1629 chardev_add accepts the same parameters as the -chardev command line switch.
1630
1631 ETEXI
1632
1633 {
1634 .name = "chardev-remove",
1635 .args_type = "id:s",
1636 .params = "id",
1637 .help = "remove chardev",
1638 .mhandler.cmd = hmp_chardev_remove,
1639 .command_completion = chardev_remove_completion,
1640 },
1641
1642 STEXI
1643 @item chardev-remove id
1644 @findex chardev-remove
1645 Removes the chardev @var{id}.
1646
1647 ETEXI
1648
1649 {
1650 .name = "qemu-io",
1651 .args_type = "device:B,command:s",
1652 .params = "[device] \"[command]\"",
1653 .help = "run a qemu-io command on a block device",
1654 .mhandler.cmd = hmp_qemu_io,
1655 },
1656
1657 STEXI
1658 @item qemu-io @var{device} @var{command}
1659 @findex qemu-io
1660 Executes a qemu-io command on the given block device.
1661
1662 ETEXI
1663
1664 {
1665 .name = "cpu-add",
1666 .args_type = "id:i",
1667 .params = "id",
1668 .help = "add cpu",
1669 .mhandler.cmd = hmp_cpu_add,
1670 },
1671
1672 STEXI
1673 @item cpu-add @var{id}
1674 @findex cpu-add
1675 Add CPU with id @var{id}
1676 ETEXI
1677
1678 {
1679 .name = "qom-list",
1680 .args_type = "path:s?",
1681 .params = "path",
1682 .help = "list QOM properties",
1683 .mhandler.cmd = hmp_qom_list,
1684 },
1685
1686 STEXI
1687 @item qom-list [@var{path}]
1688 Print QOM properties of object at location @var{path}
1689 ETEXI
1690
1691 {
1692 .name = "qom-set",
1693 .args_type = "path:s,property:s,value:s",
1694 .params = "path property value",
1695 .help = "set QOM property",
1696 .mhandler.cmd = hmp_qom_set,
1697 },
1698
1699 STEXI
1700 @item qom-set @var{path} @var{property} @var{value}
1701 Set QOM property @var{property} of object at location @var{path} to value @var{value}
1702 ETEXI
1703
1704 {
1705 .name = "info",
1706 .args_type = "item:s?",
1707 .params = "[subcommand]",
1708 .help = "show various information about the system state",
1709 .mhandler.cmd = hmp_info_help,
1710 .sub_table = info_cmds,
1711 },
1712
1713 STEXI
1714 @item info @var{subcommand}
1715 @findex info
1716 Show various information about the system state.
1717
1718 @table @option
1719 @item info version
1720 show the version of QEMU
1721 @item info network
1722 show the various VLANs and the associated devices
1723 @item info chardev
1724 show the character devices
1725 @item info block
1726 show the block devices
1727 @item info blockstats
1728 show block device statistics
1729 @item info registers
1730 show the cpu registers
1731 @item info cpus
1732 show infos for each CPU
1733 @item info history
1734 show the command line history
1735 @item info irq
1736 show the interrupts statistics (if available)
1737 @item info pic
1738 show i8259 (PIC) state
1739 @item info pci
1740 show emulated PCI device info
1741 @item info tlb
1742 show virtual to physical memory mappings (i386, SH4, SPARC, PPC, and Xtensa only)
1743 @item info mem
1744 show the active virtual memory mappings (i386 only)
1745 @item info jit
1746 show dynamic compiler info
1747 @item info numa
1748 show NUMA information
1749 @item info kvm
1750 show KVM information
1751 @item info usb
1752 show USB devices plugged on the virtual USB hub
1753 @item info usbhost
1754 show all USB host devices
1755 @item info profile
1756 show profiling information
1757 @item info capture
1758 show information about active capturing
1759 @item info snapshots
1760 show list of VM snapshots
1761 @item info status
1762 show the current VM status (running|paused)
1763 @item info mice
1764 show which guest mouse is receiving events
1765 @item info vnc
1766 show the vnc server status
1767 @item info name
1768 show the current VM name
1769 @item info uuid
1770 show the current VM UUID
1771 @item info cpustats
1772 show CPU statistics
1773 @item info usernet
1774 show user network stack connection states
1775 @item info migrate
1776 show migration status
1777 @item info migrate_capabilities
1778 show current migration capabilities
1779 @item info migrate_parameters
1780 show current migration parameters
1781 @item info migrate_cache_size
1782 show current migration XBZRLE cache size
1783 @item info balloon
1784 show balloon information
1785 @item info qtree
1786 show device tree
1787 @item info qdm
1788 show qdev device model list
1789 @item info qom-tree
1790 show object composition tree
1791 @item info roms
1792 show roms
1793 @item info tpm
1794 show the TPM device
1795 @item info memory-devices
1796 show the memory devices
1797 @end table
1798 ETEXI
1799
1800 STEXI
1801 @item info trace-events
1802 show available trace events and their state
1803 ETEXI
1804
1805 STEXI
1806 @end table
1807 ETEXI