block: add a 'blockdev-snapshot' QMP command
[qemu.git] / hmp-commands.hx
blobf3de4076471b65b55430912aa575935bba63083d
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
8 STEXI
9 @table @option
10 ETEXI
13 .name = "help|?",
14 .args_type = "name:S?",
15 .params = "[cmd]",
16 .help = "show the help",
17 .mhandler.cmd = do_help_cmd,
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
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,
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
46 .name = "q|quit",
47 .args_type = "",
48 .params = "",
49 .help = "quit the emulator",
50 .mhandler.cmd = hmp_quit,
53 STEXI
54 @item q or quit
55 @findex quit
56 Quit the emulator.
57 ETEXI
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,
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
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,
84 STEXI
85 @item block_stream
86 @findex block_stream
87 Copy data from a backing file into a block device.
88 ETEXI
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,
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
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,
113 STEXI
114 @item block_job_cancel
115 @findex block_job_cancel
116 Stop an active background block operation (streaming, mirroring).
117 ETEXI
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,
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
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,
142 STEXI
143 @item block_job_pause
144 @findex block_job_pause
145 Pause an active block streaming operation.
146 ETEXI
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,
156 STEXI
157 @item block_job_resume
158 @findex block_job_resume
159 Resume a paused block streaming operation.
160 ETEXI
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,
170 STEXI
171 @item eject [-f] @var{device}
172 @findex eject
173 Eject a removable medium (use -f to force it).
174 ETEXI
177 .name = "drive_del",
178 .args_type = "id:B",
179 .params = "device",
180 .help = "remove host block device",
181 .mhandler.cmd = hmp_drive_del,
184 STEXI
185 @item drive_del @var{device}
186 @findex drive_del
187 Remove host block device. The result is that guest generated IO is no longer
188 submitted against the host device underlying the disk. Once a drive has
189 been deleted, the QEMU Block layer returns -EIO which results in IO
190 errors in the guest for applications that are reading/writing to the device.
191 These errors are always reported to the guest, regardless of the drive's error
192 actions (drive options rerror, werror).
193 ETEXI
196 .name = "change",
197 .args_type = "device:B,target:F,arg:s?,read-only-mode:s?",
198 .params = "device filename [format [read-only-mode]]",
199 .help = "change a removable medium, optional format",
200 .mhandler.cmd = hmp_change,
203 STEXI
204 @item change @var{device} @var{setting}
205 @findex change
206 Change the configuration of a device.
208 @table @option
209 @item change @var{diskdevice} @var{filename} [@var{format} [@var{read-only-mode}]]
210 Change the medium for a removable disk device to point to @var{filename}. eg
212 @example
213 (qemu) change ide1-cd0 /path/to/some.iso
214 @end example
216 @var{format} is optional.
218 @var{read-only-mode} may be used to change the read-only status of the device.
219 It accepts the following values:
221 @table @var
222 @item retain
223 Retains the current status; this is the default.
225 @item read-only
226 Makes the device read-only.
228 @item read-write
229 Makes the device writable.
230 @end table
232 @item change vnc @var{display},@var{options}
233 Change the configuration of the VNC server. The valid syntax for @var{display}
234 and @var{options} are described at @ref{sec_invocation}. eg
236 @example
237 (qemu) change vnc localhost:1
238 @end example
240 @item change vnc password [@var{password}]
242 Change the password associated with the VNC server. If the new password is not
243 supplied, the monitor will prompt for it to be entered. VNC passwords are only
244 significant up to 8 letters. eg
246 @example
247 (qemu) change vnc password
248 Password: ********
249 @end example
251 @end table
252 ETEXI
255 .name = "screendump",
256 .args_type = "filename:F",
257 .params = "filename",
258 .help = "save screen into PPM image 'filename'",
259 .mhandler.cmd = hmp_screendump,
262 STEXI
263 @item screendump @var{filename}
264 @findex screendump
265 Save screen into PPM image @var{filename}.
266 ETEXI
269 .name = "logfile",
270 .args_type = "filename:F",
271 .params = "filename",
272 .help = "output logs to 'filename'",
273 .mhandler.cmd = hmp_logfile,
276 STEXI
277 @item logfile @var{filename}
278 @findex logfile
279 Output logs to @var{filename}.
280 ETEXI
283 .name = "trace-event",
284 .args_type = "name:s,option:b",
285 .params = "name on|off",
286 .help = "changes status of a specific trace event",
287 .mhandler.cmd = hmp_trace_event,
288 .command_completion = trace_event_completion,
291 STEXI
292 @item trace-event
293 @findex trace-event
294 changes status of a trace event
295 ETEXI
297 #if defined(CONFIG_TRACE_SIMPLE)
299 .name = "trace-file",
300 .args_type = "op:s?,arg:F?",
301 .params = "on|off|flush|set [arg]",
302 .help = "open, close, or flush trace file, or set a new file name",
303 .mhandler.cmd = hmp_trace_file,
306 STEXI
307 @item trace-file on|off|flush
308 @findex trace-file
309 Open, close, or flush the trace file. If no argument is given, the status of the trace file is displayed.
310 ETEXI
311 #endif
314 .name = "log",
315 .args_type = "items:s",
316 .params = "item1[,...]",
317 .help = "activate logging of the specified items",
318 .mhandler.cmd = hmp_log,
321 STEXI
322 @item log @var{item1}[,...]
323 @findex log
324 Activate logging of the specified items.
325 ETEXI
328 .name = "savevm",
329 .args_type = "name:s?",
330 .params = "[tag|id]",
331 .help = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
332 .mhandler.cmd = hmp_savevm,
335 STEXI
336 @item savevm [@var{tag}|@var{id}]
337 @findex savevm
338 Create a snapshot of the whole virtual machine. If @var{tag} is
339 provided, it is used as human readable identifier. If there is already
340 a snapshot with the same tag or ID, it is replaced. More info at
341 @ref{vm_snapshots}.
342 ETEXI
345 .name = "loadvm",
346 .args_type = "name:s",
347 .params = "tag|id",
348 .help = "restore a VM snapshot from its tag or id",
349 .mhandler.cmd = hmp_loadvm,
350 .command_completion = loadvm_completion,
353 STEXI
354 @item loadvm @var{tag}|@var{id}
355 @findex loadvm
356 Set the whole virtual machine to the snapshot identified by the tag
357 @var{tag} or the unique snapshot ID @var{id}.
358 ETEXI
361 .name = "delvm",
362 .args_type = "name:s",
363 .params = "tag|id",
364 .help = "delete a VM snapshot from its tag or id",
365 .mhandler.cmd = hmp_delvm,
366 .command_completion = delvm_completion,
369 STEXI
370 @item delvm @var{tag}|@var{id}
371 @findex delvm
372 Delete the snapshot identified by @var{tag} or @var{id}.
373 ETEXI
376 .name = "singlestep",
377 .args_type = "option:s?",
378 .params = "[on|off]",
379 .help = "run emulation in singlestep mode or switch to normal mode",
380 .mhandler.cmd = hmp_singlestep,
383 STEXI
384 @item singlestep [off]
385 @findex singlestep
386 Run the emulation in single step mode.
387 If called with option off, the emulation returns to normal mode.
388 ETEXI
391 .name = "stop",
392 .args_type = "",
393 .params = "",
394 .help = "stop emulation",
395 .mhandler.cmd = hmp_stop,
398 STEXI
399 @item stop
400 @findex stop
401 Stop emulation.
402 ETEXI
405 .name = "c|cont",
406 .args_type = "",
407 .params = "",
408 .help = "resume emulation",
409 .mhandler.cmd = hmp_cont,
412 STEXI
413 @item c or cont
414 @findex cont
415 Resume emulation.
416 ETEXI
419 .name = "system_wakeup",
420 .args_type = "",
421 .params = "",
422 .help = "wakeup guest from suspend",
423 .mhandler.cmd = hmp_system_wakeup,
426 STEXI
427 @item system_wakeup
428 @findex system_wakeup
429 Wakeup guest from suspend.
430 ETEXI
433 .name = "gdbserver",
434 .args_type = "device:s?",
435 .params = "[device]",
436 .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
437 .mhandler.cmd = hmp_gdbserver,
440 STEXI
441 @item gdbserver [@var{port}]
442 @findex gdbserver
443 Start gdbserver session (default @var{port}=1234)
444 ETEXI
447 .name = "x",
448 .args_type = "fmt:/,addr:l",
449 .params = "/fmt addr",
450 .help = "virtual memory dump starting at 'addr'",
451 .mhandler.cmd = hmp_memory_dump,
454 STEXI
455 @item x/fmt @var{addr}
456 @findex x
457 Virtual memory dump starting at @var{addr}.
458 ETEXI
461 .name = "xp",
462 .args_type = "fmt:/,addr:l",
463 .params = "/fmt addr",
464 .help = "physical memory dump starting at 'addr'",
465 .mhandler.cmd = hmp_physical_memory_dump,
468 STEXI
469 @item xp /@var{fmt} @var{addr}
470 @findex xp
471 Physical memory dump starting at @var{addr}.
473 @var{fmt} is a format which tells the command how to format the
474 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
476 @table @var
477 @item count
478 is the number of items to be dumped.
480 @item format
481 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
482 c (char) or i (asm instruction).
484 @item size
485 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
486 @code{h} or @code{w} can be specified with the @code{i} format to
487 respectively select 16 or 32 bit code instruction size.
489 @end table
491 Examples:
492 @itemize
493 @item
494 Dump 10 instructions at the current instruction pointer:
495 @example
496 (qemu) x/10i $eip
497 0x90107063: ret
498 0x90107064: sti
499 0x90107065: lea 0x0(%esi,1),%esi
500 0x90107069: lea 0x0(%edi,1),%edi
501 0x90107070: ret
502 0x90107071: jmp 0x90107080
503 0x90107073: nop
504 0x90107074: nop
505 0x90107075: nop
506 0x90107076: nop
507 @end example
509 @item
510 Dump 80 16 bit values at the start of the video memory.
511 @smallexample
512 (qemu) xp/80hx 0xb8000
513 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
514 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
515 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
516 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
517 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
518 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
519 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
520 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
521 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
522 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
523 @end smallexample
524 @end itemize
525 ETEXI
528 .name = "p|print",
529 .args_type = "fmt:/,val:l",
530 .params = "/fmt expr",
531 .help = "print expression value (use $reg for CPU register access)",
532 .mhandler.cmd = do_print,
535 STEXI
536 @item p or print/@var{fmt} @var{expr}
537 @findex print
538 Print expression value. Only the @var{format} part of @var{fmt} is
539 used.
540 ETEXI
543 .name = "i",
544 .args_type = "fmt:/,addr:i,index:i.",
545 .params = "/fmt addr",
546 .help = "I/O port read",
547 .mhandler.cmd = hmp_ioport_read,
550 STEXI
551 @item i/@var{fmt} @var{addr} [.@var{index}]
552 @findex i
553 Read I/O port.
554 ETEXI
557 .name = "o",
558 .args_type = "fmt:/,addr:i,val:i",
559 .params = "/fmt addr value",
560 .help = "I/O port write",
561 .mhandler.cmd = hmp_ioport_write,
564 STEXI
565 @item o/@var{fmt} @var{addr} @var{val}
566 @findex o
567 Write to I/O port.
568 ETEXI
571 .name = "sendkey",
572 .args_type = "keys:s,hold-time:i?",
573 .params = "keys [hold_ms]",
574 .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
575 .mhandler.cmd = hmp_sendkey,
576 .command_completion = sendkey_completion,
579 STEXI
580 @item sendkey @var{keys}
581 @findex sendkey
582 Send @var{keys} to the guest. @var{keys} could be the name of the
583 key or the raw value in hexadecimal format. Use @code{-} to press
584 several keys simultaneously. Example:
585 @example
586 sendkey ctrl-alt-f1
587 @end example
589 This command is useful to send keys that your graphical user interface
590 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
591 ETEXI
594 .name = "system_reset",
595 .args_type = "",
596 .params = "",
597 .help = "reset the system",
598 .mhandler.cmd = hmp_system_reset,
601 STEXI
602 @item system_reset
603 @findex system_reset
604 Reset the system.
605 ETEXI
608 .name = "system_powerdown",
609 .args_type = "",
610 .params = "",
611 .help = "send system power down event",
612 .mhandler.cmd = hmp_system_powerdown,
615 STEXI
616 @item system_powerdown
617 @findex system_powerdown
618 Power down the system (if supported).
619 ETEXI
622 .name = "sum",
623 .args_type = "start:i,size:i",
624 .params = "addr size",
625 .help = "compute the checksum of a memory region",
626 .mhandler.cmd = hmp_sum,
629 STEXI
630 @item sum @var{addr} @var{size}
631 @findex sum
632 Compute the checksum of a memory region.
633 ETEXI
636 .name = "usb_add",
637 .args_type = "devname:s",
638 .params = "device",
639 .help = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
640 .mhandler.cmd = hmp_usb_add,
643 STEXI
644 @item usb_add @var{devname}
645 @findex usb_add
646 Add the USB device @var{devname}. For details of available devices see
647 @ref{usb_devices}
648 ETEXI
651 .name = "usb_del",
652 .args_type = "devname:s",
653 .params = "device",
654 .help = "remove USB device 'bus.addr'",
655 .mhandler.cmd = hmp_usb_del,
658 STEXI
659 @item usb_del @var{devname}
660 @findex usb_del
661 Remove the USB device @var{devname} from the QEMU virtual USB
662 hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
663 command @code{info usb} to see the devices you can remove.
664 ETEXI
667 .name = "device_add",
668 .args_type = "device:O",
669 .params = "driver[,prop=value][,...]",
670 .help = "add device, like -device on the command line",
671 .mhandler.cmd = hmp_device_add,
672 .command_completion = device_add_completion,
675 STEXI
676 @item device_add @var{config}
677 @findex device_add
678 Add device.
679 ETEXI
682 .name = "device_del",
683 .args_type = "id:s",
684 .params = "device",
685 .help = "remove device",
686 .mhandler.cmd = hmp_device_del,
687 .command_completion = device_del_completion,
690 STEXI
691 @item device_del @var{id}
692 @findex device_del
693 Remove device @var{id}. @var{id} may be a short ID
694 or a QOM object path.
695 ETEXI
698 .name = "cpu",
699 .args_type = "index:i",
700 .params = "index",
701 .help = "set the default CPU",
702 .mhandler.cmd = hmp_cpu,
705 STEXI
706 @item cpu @var{index}
707 @findex cpu
708 Set the default CPU.
709 ETEXI
712 .name = "mouse_move",
713 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
714 .params = "dx dy [dz]",
715 .help = "send mouse move events",
716 .mhandler.cmd = hmp_mouse_move,
719 STEXI
720 @item mouse_move @var{dx} @var{dy} [@var{dz}]
721 @findex mouse_move
722 Move the active mouse to the specified coordinates @var{dx} @var{dy}
723 with optional scroll axis @var{dz}.
724 ETEXI
727 .name = "mouse_button",
728 .args_type = "button_state:i",
729 .params = "state",
730 .help = "change mouse button state (1=L, 2=M, 4=R)",
731 .mhandler.cmd = hmp_mouse_button,
734 STEXI
735 @item mouse_button @var{val}
736 @findex mouse_button
737 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
738 ETEXI
741 .name = "mouse_set",
742 .args_type = "index:i",
743 .params = "index",
744 .help = "set which mouse device receives events",
745 .mhandler.cmd = hmp_mouse_set,
748 STEXI
749 @item mouse_set @var{index}
750 @findex mouse_set
751 Set which mouse device receives events at given @var{index}, index
752 can be obtained with
753 @example
754 info mice
755 @end example
756 ETEXI
759 .name = "wavcapture",
760 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
761 .params = "path [frequency [bits [channels]]]",
762 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
763 .mhandler.cmd = hmp_wavcapture,
765 STEXI
766 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
767 @findex wavcapture
768 Capture audio into @var{filename}. Using sample rate @var{frequency}
769 bits per sample @var{bits} and number of channels @var{channels}.
771 Defaults:
772 @itemize @minus
773 @item Sample rate = 44100 Hz - CD quality
774 @item Bits = 16
775 @item Number of channels = 2 - Stereo
776 @end itemize
777 ETEXI
780 .name = "stopcapture",
781 .args_type = "n:i",
782 .params = "capture index",
783 .help = "stop capture",
784 .mhandler.cmd = hmp_stopcapture,
786 STEXI
787 @item stopcapture @var{index}
788 @findex stopcapture
789 Stop capture with a given @var{index}, index can be obtained with
790 @example
791 info capture
792 @end example
793 ETEXI
796 .name = "memsave",
797 .args_type = "val:l,size:i,filename:s",
798 .params = "addr size file",
799 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
800 .mhandler.cmd = hmp_memsave,
803 STEXI
804 @item memsave @var{addr} @var{size} @var{file}
805 @findex memsave
806 save to disk virtual memory dump starting at @var{addr} of size @var{size}.
807 ETEXI
810 .name = "pmemsave",
811 .args_type = "val:l,size:i,filename:s",
812 .params = "addr size file",
813 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
814 .mhandler.cmd = hmp_pmemsave,
817 STEXI
818 @item pmemsave @var{addr} @var{size} @var{file}
819 @findex pmemsave
820 save to disk physical memory dump starting at @var{addr} of size @var{size}.
821 ETEXI
824 .name = "boot_set",
825 .args_type = "bootdevice:s",
826 .params = "bootdevice",
827 .help = "define new values for the boot device list",
828 .mhandler.cmd = hmp_boot_set,
831 STEXI
832 @item boot_set @var{bootdevicelist}
833 @findex boot_set
834 Define new values for the boot device list. Those values will override
835 the values specified on the command line through the @code{-boot} option.
837 The values that can be specified here depend on the machine type, but are
838 the same that can be specified in the @code{-boot} command line option.
839 ETEXI
842 .name = "nmi",
843 .args_type = "",
844 .params = "",
845 .help = "inject an NMI",
846 .mhandler.cmd = hmp_nmi,
848 STEXI
849 @item nmi @var{cpu}
850 @findex nmi
851 Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
853 ETEXI
856 .name = "ringbuf_write",
857 .args_type = "device:s,data:s",
858 .params = "device data",
859 .help = "Write to a ring buffer character device",
860 .mhandler.cmd = hmp_ringbuf_write,
861 .command_completion = ringbuf_write_completion,
864 STEXI
865 @item ringbuf_write @var{device} @var{data}
866 @findex ringbuf_write
867 Write @var{data} to ring buffer character device @var{device}.
868 @var{data} must be a UTF-8 string.
870 ETEXI
873 .name = "ringbuf_read",
874 .args_type = "device:s,size:i",
875 .params = "device size",
876 .help = "Read from a ring buffer character device",
877 .mhandler.cmd = hmp_ringbuf_read,
878 .command_completion = ringbuf_write_completion,
881 STEXI
882 @item ringbuf_read @var{device}
883 @findex ringbuf_read
884 Read and print up to @var{size} bytes from ring buffer character
885 device @var{device}.
886 Certain non-printable characters are printed \uXXXX, where XXXX is the
887 character code in hexadecimal. Character \ is printed \\.
888 Bug: can screw up when the buffer contains invalid UTF-8 sequences,
889 NUL characters, after the ring buffer lost data, and when reading
890 stops because the size limit is reached.
892 ETEXI
895 .name = "migrate",
896 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
897 .params = "[-d] [-b] [-i] uri",
898 .help = "migrate to URI (using -d to not wait for completion)"
899 "\n\t\t\t -b for migration without shared storage with"
900 " full copy of disk\n\t\t\t -i for migration without "
901 "shared storage with incremental copy of disk "
902 "(base image shared between src and destination)",
903 .mhandler.cmd = hmp_migrate,
907 STEXI
908 @item migrate [-d] [-b] [-i] @var{uri}
909 @findex migrate
910 Migrate to @var{uri} (using -d to not wait for completion).
911 -b for migration with full copy of disk
912 -i for migration with incremental copy of disk (base image is shared)
913 ETEXI
916 .name = "migrate_cancel",
917 .args_type = "",
918 .params = "",
919 .help = "cancel the current VM migration",
920 .mhandler.cmd = hmp_migrate_cancel,
923 STEXI
924 @item migrate_cancel
925 @findex migrate_cancel
926 Cancel the current VM migration.
928 ETEXI
931 .name = "migrate_incoming",
932 .args_type = "uri:s",
933 .params = "uri",
934 .help = "Continue an incoming migration from an -incoming defer",
935 .mhandler.cmd = hmp_migrate_incoming,
938 STEXI
939 @item migrate_incoming @var{uri}
940 @findex migrate_incoming
941 Continue an incoming migration using the @var{uri} (that has the same syntax
942 as the -incoming option).
944 ETEXI
947 .name = "migrate_set_cache_size",
948 .args_type = "value:o",
949 .params = "value",
950 .help = "set cache size (in bytes) for XBZRLE migrations,"
951 "the cache size will be rounded down to the nearest "
952 "power of 2.\n"
953 "The cache size affects the number of cache misses."
954 "In case of a high cache miss ratio you need to increase"
955 " the cache size",
956 .mhandler.cmd = hmp_migrate_set_cache_size,
959 STEXI
960 @item migrate_set_cache_size @var{value}
961 @findex migrate_set_cache_size
962 Set cache size to @var{value} (in bytes) for xbzrle migrations.
963 ETEXI
966 .name = "migrate_set_speed",
967 .args_type = "value:o",
968 .params = "value",
969 .help = "set maximum speed (in bytes) for migrations. "
970 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
971 .mhandler.cmd = hmp_migrate_set_speed,
974 STEXI
975 @item migrate_set_speed @var{value}
976 @findex migrate_set_speed
977 Set maximum speed to @var{value} (in bytes) for migrations.
978 ETEXI
981 .name = "migrate_set_downtime",
982 .args_type = "value:T",
983 .params = "value",
984 .help = "set maximum tolerated downtime (in seconds) for migrations",
985 .mhandler.cmd = hmp_migrate_set_downtime,
988 STEXI
989 @item migrate_set_downtime @var{second}
990 @findex migrate_set_downtime
991 Set maximum tolerated downtime (in seconds) for migration.
992 ETEXI
995 .name = "migrate_set_capability",
996 .args_type = "capability:s,state:b",
997 .params = "capability state",
998 .help = "Enable/Disable the usage of a capability for migration",
999 .mhandler.cmd = hmp_migrate_set_capability,
1000 .command_completion = migrate_set_capability_completion,
1003 STEXI
1004 @item migrate_set_capability @var{capability} @var{state}
1005 @findex migrate_set_capability
1006 Enable/Disable the usage of a capability @var{capability} for migration.
1007 ETEXI
1010 .name = "migrate_set_parameter",
1011 .args_type = "parameter:s,value:i",
1012 .params = "parameter value",
1013 .help = "Set the parameter for migration",
1014 .mhandler.cmd = hmp_migrate_set_parameter,
1015 .command_completion = migrate_set_parameter_completion,
1018 STEXI
1019 @item migrate_set_parameter @var{parameter} @var{value}
1020 @findex migrate_set_parameter
1021 Set the parameter @var{parameter} for migration.
1022 ETEXI
1025 .name = "migrate_start_postcopy",
1026 .args_type = "",
1027 .params = "",
1028 .help = "Switch migration to postcopy mode",
1029 .mhandler.cmd = hmp_migrate_start_postcopy,
1032 STEXI
1033 @item migrate_start_postcopy
1034 @findex migrate_start_postcopy
1035 Switch in-progress migration to postcopy mode. Ignored after the end of
1036 migration (or once already in postcopy).
1037 ETEXI
1040 .name = "client_migrate_info",
1041 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1042 .params = "protocol hostname port tls-port cert-subject",
1043 .help = "set migration information for remote display",
1044 .mhandler.cmd = hmp_client_migrate_info,
1047 STEXI
1048 @item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
1049 @findex client_migrate_info
1050 Set migration information for remote display. This makes the server
1051 ask the client to automatically reconnect using the new parameters
1052 once migration finished successfully. Only implemented for SPICE.
1053 ETEXI
1056 .name = "dump-guest-memory",
1057 .args_type = "paging:-p,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:i?,length:i?",
1058 .params = "[-p] [-z|-l|-s] filename [begin length]",
1059 .help = "dump guest memory into file 'filename'.\n\t\t\t"
1060 "-p: do paging to get guest's memory mapping.\n\t\t\t"
1061 "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1062 "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1063 "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
1064 "begin: the starting physical address.\n\t\t\t"
1065 "length: the memory size, in bytes.",
1066 .mhandler.cmd = hmp_dump_guest_memory,
1070 STEXI
1071 @item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
1072 @item dump-guest-memory [-z|-l|-s] @var{filename}
1073 @findex dump-guest-memory
1074 Dump guest memory to @var{protocol}. The file can be processed with crash or
1075 gdb. Without -z|-l|-s, the dump format is ELF.
1076 -p: do paging to get guest's memory mapping.
1077 -z: dump in kdump-compressed format, with zlib compression.
1078 -l: dump in kdump-compressed format, with lzo compression.
1079 -s: dump in kdump-compressed format, with snappy compression.
1080 filename: dump file name.
1081 begin: the starting physical address. It's optional, and should be
1082 specified together with length.
1083 length: the memory size, in bytes. It's optional, and should be specified
1084 together with begin.
1085 ETEXI
1087 #if defined(TARGET_S390X)
1089 .name = "dump-skeys",
1090 .args_type = "filename:F",
1091 .params = "",
1092 .help = "Save guest storage keys into file 'filename'.\n",
1093 .mhandler.cmd = hmp_dump_skeys,
1095 #endif
1097 STEXI
1098 @item dump-skeys @var{filename}
1099 @findex dump-skeys
1100 Save guest storage keys to a file.
1101 ETEXI
1104 .name = "snapshot_blkdev",
1105 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1106 .params = "[-n] device [new-image-file] [format]",
1107 .help = "initiates a live snapshot\n\t\t\t"
1108 "of device. If a new image file is specified, the\n\t\t\t"
1109 "new image file will become the new root image.\n\t\t\t"
1110 "If format is specified, the snapshot file will\n\t\t\t"
1111 "be created in that format.\n\t\t\t"
1112 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1113 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1114 "recreating it from scratch.",
1115 .mhandler.cmd = hmp_snapshot_blkdev,
1118 STEXI
1119 @item snapshot_blkdev
1120 @findex snapshot_blkdev
1121 Snapshot device, using snapshot file as target if provided
1122 ETEXI
1125 .name = "snapshot_blkdev_internal",
1126 .args_type = "device:B,name:s",
1127 .params = "device name",
1128 .help = "take an internal snapshot of device.\n\t\t\t"
1129 "The format of the image used by device must\n\t\t\t"
1130 "support it, such as qcow2.\n\t\t\t",
1131 .mhandler.cmd = hmp_snapshot_blkdev_internal,
1134 STEXI
1135 @item snapshot_blkdev_internal
1136 @findex snapshot_blkdev_internal
1137 Take an internal snapshot on device if it support
1138 ETEXI
1141 .name = "snapshot_delete_blkdev_internal",
1142 .args_type = "device:B,name:s,id:s?",
1143 .params = "device name [id]",
1144 .help = "delete an internal snapshot of device.\n\t\t\t"
1145 "If id is specified, qemu will try delete\n\t\t\t"
1146 "the snapshot matching both id and name.\n\t\t\t"
1147 "The format of the image used by device must\n\t\t\t"
1148 "support it, such as qcow2.\n\t\t\t",
1149 .mhandler.cmd = hmp_snapshot_delete_blkdev_internal,
1152 STEXI
1153 @item snapshot_delete_blkdev_internal
1154 @findex snapshot_delete_blkdev_internal
1155 Delete an internal snapshot on device if it support
1156 ETEXI
1159 .name = "drive_mirror",
1160 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1161 .params = "[-n] [-f] device target [format]",
1162 .help = "initiates live storage\n\t\t\t"
1163 "migration for a device. The device's contents are\n\t\t\t"
1164 "copied to the new image file, including data that\n\t\t\t"
1165 "is written after the command is started.\n\t\t\t"
1166 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1167 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1168 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1169 "so that the result does not need a backing file.\n\t\t\t",
1170 .mhandler.cmd = hmp_drive_mirror,
1172 STEXI
1173 @item drive_mirror
1174 @findex drive_mirror
1175 Start mirroring a block device's writes to a new destination,
1176 using the specified target.
1177 ETEXI
1180 .name = "drive_backup",
1181 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1182 .params = "[-n] [-f] device target [format]",
1183 .help = "initiates a point-in-time\n\t\t\t"
1184 "copy for a device. The device's contents are\n\t\t\t"
1185 "copied to the new image file, excluding data that\n\t\t\t"
1186 "is written after the command is started.\n\t\t\t"
1187 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1188 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1189 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1190 "so that the result does not need a backing file.\n\t\t\t",
1191 .mhandler.cmd = hmp_drive_backup,
1193 STEXI
1194 @item drive_backup
1195 @findex drive_backup
1196 Start a point-in-time copy of a block device to a specificed target.
1197 ETEXI
1200 .name = "drive_add",
1201 .args_type = "pci_addr:s,opts:s",
1202 .params = "[[<domain>:]<bus>:]<slot>\n"
1203 "[file=file][,if=type][,bus=n]\n"
1204 "[,unit=m][,media=d][,index=i]\n"
1205 "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
1206 "[,snapshot=on|off][,cache=on|off]\n"
1207 "[,readonly=on|off][,copy-on-read=on|off]",
1208 .help = "add drive to PCI storage controller",
1209 .mhandler.cmd = hmp_drive_add,
1212 STEXI
1213 @item drive_add
1214 @findex drive_add
1215 Add drive to PCI storage controller.
1216 ETEXI
1219 .name = "pcie_aer_inject_error",
1220 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1221 "id:s,error_status:s,"
1222 "header0:i?,header1:i?,header2:i?,header3:i?,"
1223 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1224 .params = "[-a] [-c] id "
1225 "<error_status> [<tlp header> [<tlp header prefix>]]",
1226 .help = "inject pcie aer error\n\t\t\t"
1227 " -a for advisory non fatal error\n\t\t\t"
1228 " -c for correctable error\n\t\t\t"
1229 "<id> = qdev device id\n\t\t\t"
1230 "<error_status> = error string or 32bit\n\t\t\t"
1231 "<tlb header> = 32bit x 4\n\t\t\t"
1232 "<tlb header prefix> = 32bit x 4",
1233 .mhandler.cmd = hmp_pcie_aer_inject_error,
1236 STEXI
1237 @item pcie_aer_inject_error
1238 @findex pcie_aer_inject_error
1239 Inject PCIe AER error
1240 ETEXI
1243 .name = "host_net_add",
1244 .args_type = "device:s,opts:s?",
1245 .params = "tap|user|socket|vde|netmap|bridge|vhost-user|dump [options]",
1246 .help = "add host VLAN client",
1247 .mhandler.cmd = hmp_host_net_add,
1248 .command_completion = host_net_add_completion,
1251 STEXI
1252 @item host_net_add
1253 @findex host_net_add
1254 Add host VLAN client.
1255 ETEXI
1258 .name = "host_net_remove",
1259 .args_type = "vlan_id:i,device:s",
1260 .params = "vlan_id name",
1261 .help = "remove host VLAN client",
1262 .mhandler.cmd = hmp_host_net_remove,
1263 .command_completion = host_net_remove_completion,
1266 STEXI
1267 @item host_net_remove
1268 @findex host_net_remove
1269 Remove host VLAN client.
1270 ETEXI
1273 .name = "netdev_add",
1274 .args_type = "netdev:O",
1275 .params = "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
1276 .help = "add host network device",
1277 .mhandler.cmd = hmp_netdev_add,
1278 .command_completion = netdev_add_completion,
1281 STEXI
1282 @item netdev_add
1283 @findex netdev_add
1284 Add host network device.
1285 ETEXI
1288 .name = "netdev_del",
1289 .args_type = "id:s",
1290 .params = "id",
1291 .help = "remove host network device",
1292 .mhandler.cmd = hmp_netdev_del,
1293 .command_completion = netdev_del_completion,
1296 STEXI
1297 @item netdev_del
1298 @findex netdev_del
1299 Remove host network device.
1300 ETEXI
1303 .name = "object_add",
1304 .args_type = "object:O",
1305 .params = "[qom-type=]type,id=str[,prop=value][,...]",
1306 .help = "create QOM object",
1307 .mhandler.cmd = hmp_object_add,
1308 .command_completion = object_add_completion,
1311 STEXI
1312 @item object_add
1313 @findex object_add
1314 Create QOM object.
1315 ETEXI
1318 .name = "object_del",
1319 .args_type = "id:s",
1320 .params = "id",
1321 .help = "destroy QOM object",
1322 .mhandler.cmd = hmp_object_del,
1323 .command_completion = object_del_completion,
1326 STEXI
1327 @item object_del
1328 @findex object_del
1329 Destroy QOM object.
1330 ETEXI
1332 #ifdef CONFIG_SLIRP
1334 .name = "hostfwd_add",
1335 .args_type = "arg1:s,arg2:s?,arg3:s?",
1336 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1337 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
1338 .mhandler.cmd = hmp_hostfwd_add,
1340 #endif
1341 STEXI
1342 @item hostfwd_add
1343 @findex hostfwd_add
1344 Redirect TCP or UDP connections from host to guest (requires -net user).
1345 ETEXI
1347 #ifdef CONFIG_SLIRP
1349 .name = "hostfwd_remove",
1350 .args_type = "arg1:s,arg2:s?,arg3:s?",
1351 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1352 .help = "remove host-to-guest TCP or UDP redirection",
1353 .mhandler.cmd = hmp_hostfwd_remove,
1356 #endif
1357 STEXI
1358 @item hostfwd_remove
1359 @findex hostfwd_remove
1360 Remove host-to-guest TCP or UDP redirection.
1361 ETEXI
1364 .name = "balloon",
1365 .args_type = "value:M",
1366 .params = "target",
1367 .help = "request VM to change its memory allocation (in MB)",
1368 .mhandler.cmd = hmp_balloon,
1371 STEXI
1372 @item balloon @var{value}
1373 @findex balloon
1374 Request VM to change its memory allocation to @var{value} (in MB).
1375 ETEXI
1378 .name = "set_link",
1379 .args_type = "name:s,up:b",
1380 .params = "name on|off",
1381 .help = "change the link status of a network adapter",
1382 .mhandler.cmd = hmp_set_link,
1383 .command_completion = set_link_completion,
1386 STEXI
1387 @item set_link @var{name} [on|off]
1388 @findex set_link
1389 Switch link @var{name} on (i.e. up) or off (i.e. down).
1390 ETEXI
1393 .name = "watchdog_action",
1394 .args_type = "action:s",
1395 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1396 .help = "change watchdog action",
1397 .mhandler.cmd = hmp_watchdog_action,
1398 .command_completion = watchdog_action_completion,
1401 STEXI
1402 @item watchdog_action
1403 @findex watchdog_action
1404 Change watchdog action.
1405 ETEXI
1408 .name = "acl_show",
1409 .args_type = "aclname:s",
1410 .params = "aclname",
1411 .help = "list rules in the access control list",
1412 .mhandler.cmd = hmp_acl_show,
1415 STEXI
1416 @item acl_show @var{aclname}
1417 @findex acl_show
1418 List all the matching rules in the access control list, and the default
1419 policy. There are currently two named access control lists,
1420 @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1421 certificate distinguished name, and SASL username respectively.
1422 ETEXI
1425 .name = "acl_policy",
1426 .args_type = "aclname:s,policy:s",
1427 .params = "aclname allow|deny",
1428 .help = "set default access control list policy",
1429 .mhandler.cmd = hmp_acl_policy,
1432 STEXI
1433 @item acl_policy @var{aclname} @code{allow|deny}
1434 @findex acl_policy
1435 Set the default access control list policy, used in the event that
1436 none of the explicit rules match. The default policy at startup is
1437 always @code{deny}.
1438 ETEXI
1441 .name = "acl_add",
1442 .args_type = "aclname:s,match:s,policy:s,index:i?",
1443 .params = "aclname match allow|deny [index]",
1444 .help = "add a match rule to the access control list",
1445 .mhandler.cmd = hmp_acl_add,
1448 STEXI
1449 @item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1450 @findex acl_add
1451 Add a match rule to the access control list, allowing or denying access.
1452 The match will normally be an exact username or x509 distinguished name,
1453 but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1454 allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
1455 normally be appended to the end of the ACL, but can be inserted
1456 earlier in the list if the optional @var{index} parameter is supplied.
1457 ETEXI
1460 .name = "acl_remove",
1461 .args_type = "aclname:s,match:s",
1462 .params = "aclname match",
1463 .help = "remove a match rule from the access control list",
1464 .mhandler.cmd = hmp_acl_remove,
1467 STEXI
1468 @item acl_remove @var{aclname} @var{match}
1469 @findex acl_remove
1470 Remove the specified match rule from the access control list.
1471 ETEXI
1474 .name = "acl_reset",
1475 .args_type = "aclname:s",
1476 .params = "aclname",
1477 .help = "reset the access control list",
1478 .mhandler.cmd = hmp_acl_reset,
1481 STEXI
1482 @item acl_reset @var{aclname}
1483 @findex acl_reset
1484 Remove all matches from the access control list, and set the default
1485 policy back to @code{deny}.
1486 ETEXI
1489 .name = "nbd_server_start",
1490 .args_type = "all:-a,writable:-w,uri:s",
1491 .params = "nbd_server_start [-a] [-w] host:port",
1492 .help = "serve block devices on the given host and port",
1493 .mhandler.cmd = hmp_nbd_server_start,
1495 STEXI
1496 @item nbd_server_start @var{host}:@var{port}
1497 @findex nbd_server_start
1498 Start an NBD server on the given host and/or port. If the @option{-a}
1499 option is included, all of the virtual machine's block devices that
1500 have an inserted media on them are automatically exported; in this case,
1501 the @option{-w} option makes the devices writable too.
1502 ETEXI
1505 .name = "nbd_server_add",
1506 .args_type = "writable:-w,device:B",
1507 .params = "nbd_server_add [-w] device",
1508 .help = "export a block device via NBD",
1509 .mhandler.cmd = hmp_nbd_server_add,
1511 STEXI
1512 @item nbd_server_add @var{device}
1513 @findex nbd_server_add
1514 Export a block device through QEMU's NBD server, which must be started
1515 beforehand with @command{nbd_server_start}. The @option{-w} option makes the
1516 exported device writable too.
1517 ETEXI
1520 .name = "nbd_server_stop",
1521 .args_type = "",
1522 .params = "nbd_server_stop",
1523 .help = "stop serving block devices using the NBD protocol",
1524 .mhandler.cmd = hmp_nbd_server_stop,
1526 STEXI
1527 @item nbd_server_stop
1528 @findex nbd_server_stop
1529 Stop the QEMU embedded NBD server.
1530 ETEXI
1533 #if defined(TARGET_I386)
1536 .name = "mce",
1537 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1538 .params = "[-b] cpu bank status mcgstatus addr misc",
1539 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1540 .mhandler.cmd = hmp_mce,
1543 #endif
1544 STEXI
1545 @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1546 @findex mce (x86)
1547 Inject an MCE on the given CPU (x86 only).
1548 ETEXI
1551 .name = "getfd",
1552 .args_type = "fdname:s",
1553 .params = "getfd name",
1554 .help = "receive a file descriptor via SCM rights and assign it a name",
1555 .mhandler.cmd = hmp_getfd,
1558 STEXI
1559 @item getfd @var{fdname}
1560 @findex getfd
1561 If a file descriptor is passed alongside this command using the SCM_RIGHTS
1562 mechanism on unix sockets, it is stored using the name @var{fdname} for
1563 later use by other monitor commands.
1564 ETEXI
1567 .name = "closefd",
1568 .args_type = "fdname:s",
1569 .params = "closefd name",
1570 .help = "close a file descriptor previously passed via SCM rights",
1571 .mhandler.cmd = hmp_closefd,
1574 STEXI
1575 @item closefd @var{fdname}
1576 @findex closefd
1577 Close the file descriptor previously assigned to @var{fdname} using the
1578 @code{getfd} command. This is only needed if the file descriptor was never
1579 used by another monitor command.
1580 ETEXI
1583 .name = "block_passwd",
1584 .args_type = "device:B,password:s",
1585 .params = "block_passwd device password",
1586 .help = "set the password of encrypted block devices",
1587 .mhandler.cmd = hmp_block_passwd,
1590 STEXI
1591 @item block_passwd @var{device} @var{password}
1592 @findex block_passwd
1593 Set the encrypted device @var{device} password to @var{password}
1594 ETEXI
1597 .name = "block_set_io_throttle",
1598 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1599 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1600 .help = "change I/O throttle limits for a block drive",
1601 .mhandler.cmd = hmp_block_set_io_throttle,
1604 STEXI
1605 @item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1606 @findex block_set_io_throttle
1607 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}
1608 ETEXI
1611 .name = "set_password",
1612 .args_type = "protocol:s,password:s,connected:s?",
1613 .params = "protocol password action-if-connected",
1614 .help = "set spice/vnc password",
1615 .mhandler.cmd = hmp_set_password,
1618 STEXI
1619 @item set_password [ vnc | spice ] password [ action-if-connected ]
1620 @findex set_password
1621 Change spice/vnc password. Use zero to make the password stay valid
1622 forever. @var{action-if-connected} specifies what should happen in
1623 case a connection is established: @var{fail} makes the password change
1624 fail. @var{disconnect} changes the password and disconnects the
1625 client. @var{keep} changes the password and keeps the connection up.
1626 @var{keep} is the default.
1627 ETEXI
1630 .name = "expire_password",
1631 .args_type = "protocol:s,time:s",
1632 .params = "protocol time",
1633 .help = "set spice/vnc password expire-time",
1634 .mhandler.cmd = hmp_expire_password,
1637 STEXI
1638 @item expire_password [ vnc | spice ] expire-time
1639 @findex expire_password
1640 Specify when a password for spice/vnc becomes
1641 invalid. @var{expire-time} accepts:
1643 @table @var
1644 @item now
1645 Invalidate password instantly.
1647 @item never
1648 Password stays valid forever.
1650 @item +nsec
1651 Password stays valid for @var{nsec} seconds starting now.
1653 @item nsec
1654 Password is invalidated at the given time. @var{nsec} are the seconds
1655 passed since 1970, i.e. unix epoch.
1657 @end table
1658 ETEXI
1661 .name = "chardev-add",
1662 .args_type = "args:s",
1663 .params = "args",
1664 .help = "add chardev",
1665 .mhandler.cmd = hmp_chardev_add,
1666 .command_completion = chardev_add_completion,
1669 STEXI
1670 @item chardev-add args
1671 @findex chardev-add
1672 chardev_add accepts the same parameters as the -chardev command line switch.
1674 ETEXI
1677 .name = "chardev-remove",
1678 .args_type = "id:s",
1679 .params = "id",
1680 .help = "remove chardev",
1681 .mhandler.cmd = hmp_chardev_remove,
1682 .command_completion = chardev_remove_completion,
1685 STEXI
1686 @item chardev-remove id
1687 @findex chardev-remove
1688 Removes the chardev @var{id}.
1690 ETEXI
1693 .name = "qemu-io",
1694 .args_type = "device:B,command:s",
1695 .params = "[device] \"[command]\"",
1696 .help = "run a qemu-io command on a block device",
1697 .mhandler.cmd = hmp_qemu_io,
1700 STEXI
1701 @item qemu-io @var{device} @var{command}
1702 @findex qemu-io
1703 Executes a qemu-io command on the given block device.
1705 ETEXI
1708 .name = "cpu-add",
1709 .args_type = "id:i",
1710 .params = "id",
1711 .help = "add cpu",
1712 .mhandler.cmd = hmp_cpu_add,
1715 STEXI
1716 @item cpu-add @var{id}
1717 @findex cpu-add
1718 Add CPU with id @var{id}
1719 ETEXI
1722 .name = "qom-list",
1723 .args_type = "path:s?",
1724 .params = "path",
1725 .help = "list QOM properties",
1726 .mhandler.cmd = hmp_qom_list,
1729 STEXI
1730 @item qom-list [@var{path}]
1731 Print QOM properties of object at location @var{path}
1732 ETEXI
1735 .name = "qom-set",
1736 .args_type = "path:s,property:s,value:s",
1737 .params = "path property value",
1738 .help = "set QOM property",
1739 .mhandler.cmd = hmp_qom_set,
1742 STEXI
1743 @item qom-set @var{path} @var{property} @var{value}
1744 Set QOM property @var{property} of object at location @var{path} to value @var{value}
1745 ETEXI
1748 .name = "info",
1749 .args_type = "item:s?",
1750 .params = "[subcommand]",
1751 .help = "show various information about the system state",
1752 .mhandler.cmd = hmp_info_help,
1753 .sub_table = info_cmds,
1756 STEXI
1757 @end table
1758 ETEXI