Default to GSSAPI (Kerberos) instead of DIGEST-MD5 for SASL
[qemu.git] / hmp-commands.hx
blob0aca984261716f483599009463423f2bd121b388
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 .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 .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 .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 .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 .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 .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 .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 .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 .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 .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 .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 .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 .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 .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 .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,vcpu:i?",
285 .params = "name on|off [vcpu]",
286 .help = "changes status of a specific trace event "
287 "(vcpu: vCPU to set, default is all)",
288 .cmd = hmp_trace_event,
289 .command_completion = trace_event_completion,
292 STEXI
293 @item trace-event
294 @findex trace-event
295 changes status of a trace event
296 ETEXI
298 #if defined(CONFIG_TRACE_SIMPLE)
300 .name = "trace-file",
301 .args_type = "op:s?,arg:F?",
302 .params = "on|off|flush|set [arg]",
303 .help = "open, close, or flush trace file, or set a new file name",
304 .cmd = hmp_trace_file,
307 STEXI
308 @item trace-file on|off|flush
309 @findex trace-file
310 Open, close, or flush the trace file. If no argument is given, the status of the trace file is displayed.
311 ETEXI
312 #endif
315 .name = "log",
316 .args_type = "items:s",
317 .params = "item1[,...]",
318 .help = "activate logging of the specified items",
319 .cmd = hmp_log,
322 STEXI
323 @item log @var{item1}[,...]
324 @findex log
325 Activate logging of the specified items.
326 ETEXI
329 .name = "savevm",
330 .args_type = "name:s?",
331 .params = "[tag|id]",
332 .help = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
333 .cmd = hmp_savevm,
336 STEXI
337 @item savevm [@var{tag}|@var{id}]
338 @findex savevm
339 Create a snapshot of the whole virtual machine. If @var{tag} is
340 provided, it is used as human readable identifier. If there is already
341 a snapshot with the same tag or ID, it is replaced. More info at
342 @ref{vm_snapshots}.
343 ETEXI
346 .name = "loadvm",
347 .args_type = "name:s",
348 .params = "tag|id",
349 .help = "restore a VM snapshot from its tag or id",
350 .cmd = hmp_loadvm,
351 .command_completion = loadvm_completion,
354 STEXI
355 @item loadvm @var{tag}|@var{id}
356 @findex loadvm
357 Set the whole virtual machine to the snapshot identified by the tag
358 @var{tag} or the unique snapshot ID @var{id}.
359 ETEXI
362 .name = "delvm",
363 .args_type = "name:s",
364 .params = "tag|id",
365 .help = "delete a VM snapshot from its tag or id",
366 .cmd = hmp_delvm,
367 .command_completion = delvm_completion,
370 STEXI
371 @item delvm @var{tag}|@var{id}
372 @findex delvm
373 Delete the snapshot identified by @var{tag} or @var{id}.
374 ETEXI
377 .name = "singlestep",
378 .args_type = "option:s?",
379 .params = "[on|off]",
380 .help = "run emulation in singlestep mode or switch to normal mode",
381 .cmd = hmp_singlestep,
384 STEXI
385 @item singlestep [off]
386 @findex singlestep
387 Run the emulation in single step mode.
388 If called with option off, the emulation returns to normal mode.
389 ETEXI
392 .name = "stop",
393 .args_type = "",
394 .params = "",
395 .help = "stop emulation",
396 .cmd = hmp_stop,
399 STEXI
400 @item stop
401 @findex stop
402 Stop emulation.
403 ETEXI
406 .name = "c|cont",
407 .args_type = "",
408 .params = "",
409 .help = "resume emulation",
410 .cmd = hmp_cont,
413 STEXI
414 @item c or cont
415 @findex cont
416 Resume emulation.
417 ETEXI
420 .name = "system_wakeup",
421 .args_type = "",
422 .params = "",
423 .help = "wakeup guest from suspend",
424 .cmd = hmp_system_wakeup,
427 STEXI
428 @item system_wakeup
429 @findex system_wakeup
430 Wakeup guest from suspend.
431 ETEXI
434 .name = "gdbserver",
435 .args_type = "device:s?",
436 .params = "[device]",
437 .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
438 .cmd = hmp_gdbserver,
441 STEXI
442 @item gdbserver [@var{port}]
443 @findex gdbserver
444 Start gdbserver session (default @var{port}=1234)
445 ETEXI
448 .name = "x",
449 .args_type = "fmt:/,addr:l",
450 .params = "/fmt addr",
451 .help = "virtual memory dump starting at 'addr'",
452 .cmd = hmp_memory_dump,
455 STEXI
456 @item x/fmt @var{addr}
457 @findex x
458 Virtual memory dump starting at @var{addr}.
459 ETEXI
462 .name = "xp",
463 .args_type = "fmt:/,addr:l",
464 .params = "/fmt addr",
465 .help = "physical memory dump starting at 'addr'",
466 .cmd = hmp_physical_memory_dump,
469 STEXI
470 @item xp /@var{fmt} @var{addr}
471 @findex xp
472 Physical memory dump starting at @var{addr}.
474 @var{fmt} is a format which tells the command how to format the
475 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
477 @table @var
478 @item count
479 is the number of items to be dumped.
481 @item format
482 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
483 c (char) or i (asm instruction).
485 @item size
486 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
487 @code{h} or @code{w} can be specified with the @code{i} format to
488 respectively select 16 or 32 bit code instruction size.
490 @end table
492 Examples:
493 @itemize
494 @item
495 Dump 10 instructions at the current instruction pointer:
496 @example
497 (qemu) x/10i $eip
498 0x90107063: ret
499 0x90107064: sti
500 0x90107065: lea 0x0(%esi,1),%esi
501 0x90107069: lea 0x0(%edi,1),%edi
502 0x90107070: ret
503 0x90107071: jmp 0x90107080
504 0x90107073: nop
505 0x90107074: nop
506 0x90107075: nop
507 0x90107076: nop
508 @end example
510 @item
511 Dump 80 16 bit values at the start of the video memory.
512 @smallexample
513 (qemu) xp/80hx 0xb8000
514 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
515 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
516 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
517 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
518 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
519 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
520 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
521 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
522 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
523 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
524 @end smallexample
525 @end itemize
526 ETEXI
529 .name = "gpa2hva",
530 .args_type = "addr:l",
531 .params = "addr",
532 .help = "print the host virtual address corresponding to a guest physical address",
533 .cmd = hmp_gpa2hva,
536 STEXI
537 @item gpa2hva @var{addr}
538 @findex gpa2hva
539 Print the host virtual address at which the guest's physical address @var{addr}
540 is mapped.
541 ETEXI
543 #ifdef CONFIG_LINUX
545 .name = "gpa2hpa",
546 .args_type = "addr:l",
547 .params = "addr",
548 .help = "print the host physical address corresponding to a guest physical address",
549 .cmd = hmp_gpa2hpa,
551 #endif
553 STEXI
554 @item gpa2hpa @var{addr}
555 @findex gpa2hpa
556 Print the host physical address at which the guest's physical address @var{addr}
557 is mapped.
558 ETEXI
561 .name = "p|print",
562 .args_type = "fmt:/,val:l",
563 .params = "/fmt expr",
564 .help = "print expression value (use $reg for CPU register access)",
565 .cmd = do_print,
568 STEXI
569 @item p or print/@var{fmt} @var{expr}
570 @findex print
571 Print expression value. Only the @var{format} part of @var{fmt} is
572 used.
573 ETEXI
576 .name = "i",
577 .args_type = "fmt:/,addr:i,index:i.",
578 .params = "/fmt addr",
579 .help = "I/O port read",
580 .cmd = hmp_ioport_read,
583 STEXI
584 @item i/@var{fmt} @var{addr} [.@var{index}]
585 @findex i
586 Read I/O port.
587 ETEXI
590 .name = "o",
591 .args_type = "fmt:/,addr:i,val:i",
592 .params = "/fmt addr value",
593 .help = "I/O port write",
594 .cmd = hmp_ioport_write,
597 STEXI
598 @item o/@var{fmt} @var{addr} @var{val}
599 @findex o
600 Write to I/O port.
601 ETEXI
604 .name = "sendkey",
605 .args_type = "keys:s,hold-time:i?",
606 .params = "keys [hold_ms]",
607 .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
608 .cmd = hmp_sendkey,
609 .command_completion = sendkey_completion,
612 STEXI
613 @item sendkey @var{keys}
614 @findex sendkey
615 Send @var{keys} to the guest. @var{keys} could be the name of the
616 key or the raw value in hexadecimal format. Use @code{-} to press
617 several keys simultaneously. Example:
618 @example
619 sendkey ctrl-alt-f1
620 @end example
622 This command is useful to send keys that your graphical user interface
623 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
624 ETEXI
627 .name = "system_reset",
628 .args_type = "",
629 .params = "",
630 .help = "reset the system",
631 .cmd = hmp_system_reset,
634 STEXI
635 @item system_reset
636 @findex system_reset
637 Reset the system.
638 ETEXI
641 .name = "system_powerdown",
642 .args_type = "",
643 .params = "",
644 .help = "send system power down event",
645 .cmd = hmp_system_powerdown,
648 STEXI
649 @item system_powerdown
650 @findex system_powerdown
651 Power down the system (if supported).
652 ETEXI
655 .name = "sum",
656 .args_type = "start:i,size:i",
657 .params = "addr size",
658 .help = "compute the checksum of a memory region",
659 .cmd = hmp_sum,
662 STEXI
663 @item sum @var{addr} @var{size}
664 @findex sum
665 Compute the checksum of a memory region.
666 ETEXI
669 .name = "usb_add",
670 .args_type = "devname:s",
671 .params = "device",
672 .help = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
673 .cmd = hmp_usb_add,
676 STEXI
677 @item usb_add @var{devname}
678 @findex usb_add
679 Add the USB device @var{devname}. For details of available devices see
680 @ref{usb_devices}
681 ETEXI
684 .name = "usb_del",
685 .args_type = "devname:s",
686 .params = "device",
687 .help = "remove USB device 'bus.addr'",
688 .cmd = hmp_usb_del,
691 STEXI
692 @item usb_del @var{devname}
693 @findex usb_del
694 Remove the USB device @var{devname} from the QEMU virtual USB
695 hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
696 command @code{info usb} to see the devices you can remove.
697 ETEXI
700 .name = "device_add",
701 .args_type = "device:O",
702 .params = "driver[,prop=value][,...]",
703 .help = "add device, like -device on the command line",
704 .cmd = hmp_device_add,
705 .command_completion = device_add_completion,
708 STEXI
709 @item device_add @var{config}
710 @findex device_add
711 Add device.
712 ETEXI
715 .name = "device_del",
716 .args_type = "id:s",
717 .params = "device",
718 .help = "remove device",
719 .cmd = hmp_device_del,
720 .command_completion = device_del_completion,
723 STEXI
724 @item device_del @var{id}
725 @findex device_del
726 Remove device @var{id}. @var{id} may be a short ID
727 or a QOM object path.
728 ETEXI
731 .name = "cpu",
732 .args_type = "index:i",
733 .params = "index",
734 .help = "set the default CPU",
735 .cmd = hmp_cpu,
738 STEXI
739 @item cpu @var{index}
740 @findex cpu
741 Set the default CPU.
742 ETEXI
745 .name = "mouse_move",
746 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
747 .params = "dx dy [dz]",
748 .help = "send mouse move events",
749 .cmd = hmp_mouse_move,
752 STEXI
753 @item mouse_move @var{dx} @var{dy} [@var{dz}]
754 @findex mouse_move
755 Move the active mouse to the specified coordinates @var{dx} @var{dy}
756 with optional scroll axis @var{dz}.
757 ETEXI
760 .name = "mouse_button",
761 .args_type = "button_state:i",
762 .params = "state",
763 .help = "change mouse button state (1=L, 2=M, 4=R)",
764 .cmd = hmp_mouse_button,
767 STEXI
768 @item mouse_button @var{val}
769 @findex mouse_button
770 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
771 ETEXI
774 .name = "mouse_set",
775 .args_type = "index:i",
776 .params = "index",
777 .help = "set which mouse device receives events",
778 .cmd = hmp_mouse_set,
781 STEXI
782 @item mouse_set @var{index}
783 @findex mouse_set
784 Set which mouse device receives events at given @var{index}, index
785 can be obtained with
786 @example
787 info mice
788 @end example
789 ETEXI
792 .name = "wavcapture",
793 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
794 .params = "path [frequency [bits [channels]]]",
795 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
796 .cmd = hmp_wavcapture,
798 STEXI
799 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
800 @findex wavcapture
801 Capture audio into @var{filename}. Using sample rate @var{frequency}
802 bits per sample @var{bits} and number of channels @var{channels}.
804 Defaults:
805 @itemize @minus
806 @item Sample rate = 44100 Hz - CD quality
807 @item Bits = 16
808 @item Number of channels = 2 - Stereo
809 @end itemize
810 ETEXI
813 .name = "stopcapture",
814 .args_type = "n:i",
815 .params = "capture index",
816 .help = "stop capture",
817 .cmd = hmp_stopcapture,
819 STEXI
820 @item stopcapture @var{index}
821 @findex stopcapture
822 Stop capture with a given @var{index}, index can be obtained with
823 @example
824 info capture
825 @end example
826 ETEXI
829 .name = "memsave",
830 .args_type = "val:l,size:i,filename:s",
831 .params = "addr size file",
832 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
833 .cmd = hmp_memsave,
836 STEXI
837 @item memsave @var{addr} @var{size} @var{file}
838 @findex memsave
839 save to disk virtual memory dump starting at @var{addr} of size @var{size}.
840 ETEXI
843 .name = "pmemsave",
844 .args_type = "val:l,size:i,filename:s",
845 .params = "addr size file",
846 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
847 .cmd = hmp_pmemsave,
850 STEXI
851 @item pmemsave @var{addr} @var{size} @var{file}
852 @findex pmemsave
853 save to disk physical memory dump starting at @var{addr} of size @var{size}.
854 ETEXI
857 .name = "boot_set",
858 .args_type = "bootdevice:s",
859 .params = "bootdevice",
860 .help = "define new values for the boot device list",
861 .cmd = hmp_boot_set,
864 STEXI
865 @item boot_set @var{bootdevicelist}
866 @findex boot_set
867 Define new values for the boot device list. Those values will override
868 the values specified on the command line through the @code{-boot} option.
870 The values that can be specified here depend on the machine type, but are
871 the same that can be specified in the @code{-boot} command line option.
872 ETEXI
875 .name = "nmi",
876 .args_type = "",
877 .params = "",
878 .help = "inject an NMI",
879 .cmd = hmp_nmi,
881 STEXI
882 @item nmi @var{cpu}
883 @findex nmi
884 Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
886 ETEXI
889 .name = "ringbuf_write",
890 .args_type = "device:s,data:s",
891 .params = "device data",
892 .help = "Write to a ring buffer character device",
893 .cmd = hmp_ringbuf_write,
894 .command_completion = ringbuf_write_completion,
897 STEXI
898 @item ringbuf_write @var{device} @var{data}
899 @findex ringbuf_write
900 Write @var{data} to ring buffer character device @var{device}.
901 @var{data} must be a UTF-8 string.
903 ETEXI
906 .name = "ringbuf_read",
907 .args_type = "device:s,size:i",
908 .params = "device size",
909 .help = "Read from a ring buffer character device",
910 .cmd = hmp_ringbuf_read,
911 .command_completion = ringbuf_write_completion,
914 STEXI
915 @item ringbuf_read @var{device}
916 @findex ringbuf_read
917 Read and print up to @var{size} bytes from ring buffer character
918 device @var{device}.
919 Certain non-printable characters are printed \uXXXX, where XXXX is the
920 character code in hexadecimal. Character \ is printed \\.
921 Bug: can screw up when the buffer contains invalid UTF-8 sequences,
922 NUL characters, after the ring buffer lost data, and when reading
923 stops because the size limit is reached.
925 ETEXI
928 .name = "migrate",
929 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
930 .params = "[-d] [-b] [-i] uri",
931 .help = "migrate to URI (using -d to not wait for completion)"
932 "\n\t\t\t -b for migration without shared storage with"
933 " full copy of disk\n\t\t\t -i for migration without "
934 "shared storage with incremental copy of disk "
935 "(base image shared between src and destination)",
936 .cmd = hmp_migrate,
940 STEXI
941 @item migrate [-d] [-b] [-i] @var{uri}
942 @findex migrate
943 Migrate to @var{uri} (using -d to not wait for completion).
944 -b for migration with full copy of disk
945 -i for migration with incremental copy of disk (base image is shared)
946 ETEXI
949 .name = "migrate_cancel",
950 .args_type = "",
951 .params = "",
952 .help = "cancel the current VM migration",
953 .cmd = hmp_migrate_cancel,
956 STEXI
957 @item migrate_cancel
958 @findex migrate_cancel
959 Cancel the current VM migration.
961 ETEXI
964 .name = "migrate_incoming",
965 .args_type = "uri:s",
966 .params = "uri",
967 .help = "Continue an incoming migration from an -incoming defer",
968 .cmd = hmp_migrate_incoming,
971 STEXI
972 @item migrate_incoming @var{uri}
973 @findex migrate_incoming
974 Continue an incoming migration using the @var{uri} (that has the same syntax
975 as the -incoming option).
977 ETEXI
980 .name = "migrate_set_cache_size",
981 .args_type = "value:o",
982 .params = "value",
983 .help = "set cache size (in bytes) for XBZRLE migrations,"
984 "the cache size will be rounded down to the nearest "
985 "power of 2.\n"
986 "The cache size affects the number of cache misses."
987 "In case of a high cache miss ratio you need to increase"
988 " the cache size",
989 .cmd = hmp_migrate_set_cache_size,
992 STEXI
993 @item migrate_set_cache_size @var{value}
994 @findex migrate_set_cache_size
995 Set cache size to @var{value} (in bytes) for xbzrle migrations.
996 ETEXI
999 .name = "migrate_set_speed",
1000 .args_type = "value:o",
1001 .params = "value",
1002 .help = "set maximum speed (in bytes) for migrations. "
1003 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
1004 .cmd = hmp_migrate_set_speed,
1007 STEXI
1008 @item migrate_set_speed @var{value}
1009 @findex migrate_set_speed
1010 Set maximum speed to @var{value} (in bytes) for migrations.
1011 ETEXI
1014 .name = "migrate_set_downtime",
1015 .args_type = "value:T",
1016 .params = "value",
1017 .help = "set maximum tolerated downtime (in seconds) for migrations",
1018 .cmd = hmp_migrate_set_downtime,
1021 STEXI
1022 @item migrate_set_downtime @var{second}
1023 @findex migrate_set_downtime
1024 Set maximum tolerated downtime (in seconds) for migration.
1025 ETEXI
1028 .name = "migrate_set_capability",
1029 .args_type = "capability:s,state:b",
1030 .params = "capability state",
1031 .help = "Enable/Disable the usage of a capability for migration",
1032 .cmd = hmp_migrate_set_capability,
1033 .command_completion = migrate_set_capability_completion,
1036 STEXI
1037 @item migrate_set_capability @var{capability} @var{state}
1038 @findex migrate_set_capability
1039 Enable/Disable the usage of a capability @var{capability} for migration.
1040 ETEXI
1043 .name = "migrate_set_parameter",
1044 .args_type = "parameter:s,value:s",
1045 .params = "parameter value",
1046 .help = "Set the parameter for migration",
1047 .cmd = hmp_migrate_set_parameter,
1048 .command_completion = migrate_set_parameter_completion,
1051 STEXI
1052 @item migrate_set_parameter @var{parameter} @var{value}
1053 @findex migrate_set_parameter
1054 Set the parameter @var{parameter} for migration.
1055 ETEXI
1058 .name = "migrate_start_postcopy",
1059 .args_type = "",
1060 .params = "",
1061 .help = "Followup to a migration command to switch the migration"
1062 " to postcopy mode. The postcopy-ram capability must "
1063 "be set before the original migration command.",
1064 .cmd = hmp_migrate_start_postcopy,
1067 STEXI
1068 @item migrate_start_postcopy
1069 @findex migrate_start_postcopy
1070 Switch in-progress migration to postcopy mode. Ignored after the end of
1071 migration (or once already in postcopy).
1072 ETEXI
1075 .name = "x_colo_lost_heartbeat",
1076 .args_type = "",
1077 .params = "",
1078 .help = "Tell COLO that heartbeat is lost,\n\t\t\t"
1079 "a failover or takeover is needed.",
1080 .cmd = hmp_x_colo_lost_heartbeat,
1083 STEXI
1084 @item x_colo_lost_heartbeat
1085 @findex x_colo_lost_heartbeat
1086 Tell COLO that heartbeat is lost, a failover or takeover is needed.
1087 ETEXI
1090 .name = "client_migrate_info",
1091 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1092 .params = "protocol hostname port tls-port cert-subject",
1093 .help = "set migration information for remote display",
1094 .cmd = hmp_client_migrate_info,
1097 STEXI
1098 @item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
1099 @findex client_migrate_info
1100 Set migration information for remote display. This makes the server
1101 ask the client to automatically reconnect using the new parameters
1102 once migration finished successfully. Only implemented for SPICE.
1103 ETEXI
1106 .name = "dump-guest-memory",
1107 .args_type = "paging:-p,detach:-d,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:i?,length:i?",
1108 .params = "[-p] [-d] [-z|-l|-s] filename [begin length]",
1109 .help = "dump guest memory into file 'filename'.\n\t\t\t"
1110 "-p: do paging to get guest's memory mapping.\n\t\t\t"
1111 "-d: return immediately (do not wait for completion).\n\t\t\t"
1112 "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1113 "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1114 "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
1115 "begin: the starting physical address.\n\t\t\t"
1116 "length: the memory size, in bytes.",
1117 .cmd = hmp_dump_guest_memory,
1121 STEXI
1122 @item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
1123 @item dump-guest-memory [-z|-l|-s] @var{filename}
1124 @findex dump-guest-memory
1125 Dump guest memory to @var{protocol}. The file can be processed with crash or
1126 gdb. Without -z|-l|-s, the dump format is ELF.
1127 -p: do paging to get guest's memory mapping.
1128 -z: dump in kdump-compressed format, with zlib compression.
1129 -l: dump in kdump-compressed format, with lzo compression.
1130 -s: dump in kdump-compressed format, with snappy compression.
1131 filename: dump file name.
1132 begin: the starting physical address. It's optional, and should be
1133 specified together with length.
1134 length: the memory size, in bytes. It's optional, and should be specified
1135 together with begin.
1136 ETEXI
1138 #if defined(TARGET_S390X)
1140 .name = "dump-skeys",
1141 .args_type = "filename:F",
1142 .params = "",
1143 .help = "Save guest storage keys into file 'filename'.\n",
1144 .cmd = hmp_dump_skeys,
1146 #endif
1148 STEXI
1149 @item dump-skeys @var{filename}
1150 @findex dump-skeys
1151 Save guest storage keys to a file.
1152 ETEXI
1155 .name = "snapshot_blkdev",
1156 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1157 .params = "[-n] device [new-image-file] [format]",
1158 .help = "initiates a live snapshot\n\t\t\t"
1159 "of device. If a new image file is specified, the\n\t\t\t"
1160 "new image file will become the new root image.\n\t\t\t"
1161 "If format is specified, the snapshot file will\n\t\t\t"
1162 "be created in that format.\n\t\t\t"
1163 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1164 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1165 "recreating it from scratch.",
1166 .cmd = hmp_snapshot_blkdev,
1169 STEXI
1170 @item snapshot_blkdev
1171 @findex snapshot_blkdev
1172 Snapshot device, using snapshot file as target if provided
1173 ETEXI
1176 .name = "snapshot_blkdev_internal",
1177 .args_type = "device:B,name:s",
1178 .params = "device name",
1179 .help = "take an internal snapshot of device.\n\t\t\t"
1180 "The format of the image used by device must\n\t\t\t"
1181 "support it, such as qcow2.\n\t\t\t",
1182 .cmd = hmp_snapshot_blkdev_internal,
1185 STEXI
1186 @item snapshot_blkdev_internal
1187 @findex snapshot_blkdev_internal
1188 Take an internal snapshot on device if it support
1189 ETEXI
1192 .name = "snapshot_delete_blkdev_internal",
1193 .args_type = "device:B,name:s,id:s?",
1194 .params = "device name [id]",
1195 .help = "delete an internal snapshot of device.\n\t\t\t"
1196 "If id is specified, qemu will try delete\n\t\t\t"
1197 "the snapshot matching both id and name.\n\t\t\t"
1198 "The format of the image used by device must\n\t\t\t"
1199 "support it, such as qcow2.\n\t\t\t",
1200 .cmd = hmp_snapshot_delete_blkdev_internal,
1203 STEXI
1204 @item snapshot_delete_blkdev_internal
1205 @findex snapshot_delete_blkdev_internal
1206 Delete an internal snapshot on device if it support
1207 ETEXI
1210 .name = "drive_mirror",
1211 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1212 .params = "[-n] [-f] device target [format]",
1213 .help = "initiates live storage\n\t\t\t"
1214 "migration for a device. The device's contents are\n\t\t\t"
1215 "copied to the new image file, including data that\n\t\t\t"
1216 "is written after the command is started.\n\t\t\t"
1217 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1218 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1219 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1220 "so that the result does not need a backing file.\n\t\t\t",
1221 .cmd = hmp_drive_mirror,
1223 STEXI
1224 @item drive_mirror
1225 @findex drive_mirror
1226 Start mirroring a block device's writes to a new destination,
1227 using the specified target.
1228 ETEXI
1231 .name = "drive_backup",
1232 .args_type = "reuse:-n,full:-f,compress:-c,device:B,target:s,format:s?",
1233 .params = "[-n] [-f] [-c] device target [format]",
1234 .help = "initiates a point-in-time\n\t\t\t"
1235 "copy for a device. The device's contents are\n\t\t\t"
1236 "copied to the new image file, excluding data that\n\t\t\t"
1237 "is written after the command is started.\n\t\t\t"
1238 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1239 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1240 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1241 "so that the result does not need a backing file.\n\t\t\t"
1242 "The -c flag requests QEMU to compress backup data\n\t\t\t"
1243 "(if the target format supports it).\n\t\t\t",
1244 .cmd = hmp_drive_backup,
1246 STEXI
1247 @item drive_backup
1248 @findex drive_backup
1249 Start a point-in-time copy of a block device to a specificed target.
1250 ETEXI
1253 .name = "drive_add",
1254 .args_type = "node:-n,pci_addr:s,opts:s",
1255 .params = "[-n] [[<domain>:]<bus>:]<slot>\n"
1256 "[file=file][,if=type][,bus=n]\n"
1257 "[,unit=m][,media=d][,index=i]\n"
1258 "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
1259 "[,snapshot=on|off][,cache=on|off]\n"
1260 "[,readonly=on|off][,copy-on-read=on|off]",
1261 .help = "add drive to PCI storage controller",
1262 .cmd = hmp_drive_add,
1265 STEXI
1266 @item drive_add
1267 @findex drive_add
1268 Add drive to PCI storage controller.
1269 ETEXI
1272 .name = "pcie_aer_inject_error",
1273 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1274 "id:s,error_status:s,"
1275 "header0:i?,header1:i?,header2:i?,header3:i?,"
1276 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1277 .params = "[-a] [-c] id "
1278 "<error_status> [<tlp header> [<tlp header prefix>]]",
1279 .help = "inject pcie aer error\n\t\t\t"
1280 " -a for advisory non fatal error\n\t\t\t"
1281 " -c for correctable error\n\t\t\t"
1282 "<id> = qdev device id\n\t\t\t"
1283 "<error_status> = error string or 32bit\n\t\t\t"
1284 "<tlb header> = 32bit x 4\n\t\t\t"
1285 "<tlb header prefix> = 32bit x 4",
1286 .cmd = hmp_pcie_aer_inject_error,
1289 STEXI
1290 @item pcie_aer_inject_error
1291 @findex pcie_aer_inject_error
1292 Inject PCIe AER error
1293 ETEXI
1296 .name = "host_net_add",
1297 .args_type = "device:s,opts:s?",
1298 .params = "tap|user|socket|vde|netmap|bridge|vhost-user|dump [options]",
1299 .help = "add host VLAN client",
1300 .cmd = hmp_host_net_add,
1301 .command_completion = host_net_add_completion,
1304 STEXI
1305 @item host_net_add
1306 @findex host_net_add
1307 Add host VLAN client.
1308 ETEXI
1311 .name = "host_net_remove",
1312 .args_type = "vlan_id:i,device:s",
1313 .params = "vlan_id name",
1314 .help = "remove host VLAN client",
1315 .cmd = hmp_host_net_remove,
1316 .command_completion = host_net_remove_completion,
1319 STEXI
1320 @item host_net_remove
1321 @findex host_net_remove
1322 Remove host VLAN client.
1323 ETEXI
1326 .name = "netdev_add",
1327 .args_type = "netdev:O",
1328 .params = "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
1329 .help = "add host network device",
1330 .cmd = hmp_netdev_add,
1331 .command_completion = netdev_add_completion,
1334 STEXI
1335 @item netdev_add
1336 @findex netdev_add
1337 Add host network device.
1338 ETEXI
1341 .name = "netdev_del",
1342 .args_type = "id:s",
1343 .params = "id",
1344 .help = "remove host network device",
1345 .cmd = hmp_netdev_del,
1346 .command_completion = netdev_del_completion,
1349 STEXI
1350 @item netdev_del
1351 @findex netdev_del
1352 Remove host network device.
1353 ETEXI
1356 .name = "object_add",
1357 .args_type = "object:O",
1358 .params = "[qom-type=]type,id=str[,prop=value][,...]",
1359 .help = "create QOM object",
1360 .cmd = hmp_object_add,
1361 .command_completion = object_add_completion,
1364 STEXI
1365 @item object_add
1366 @findex object_add
1367 Create QOM object.
1368 ETEXI
1371 .name = "object_del",
1372 .args_type = "id:s",
1373 .params = "id",
1374 .help = "destroy QOM object",
1375 .cmd = hmp_object_del,
1376 .command_completion = object_del_completion,
1379 STEXI
1380 @item object_del
1381 @findex object_del
1382 Destroy QOM object.
1383 ETEXI
1385 #ifdef CONFIG_SLIRP
1387 .name = "hostfwd_add",
1388 .args_type = "arg1:s,arg2:s?,arg3:s?",
1389 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1390 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
1391 .cmd = hmp_hostfwd_add,
1393 #endif
1394 STEXI
1395 @item hostfwd_add
1396 @findex hostfwd_add
1397 Redirect TCP or UDP connections from host to guest (requires -net user).
1398 ETEXI
1400 #ifdef CONFIG_SLIRP
1402 .name = "hostfwd_remove",
1403 .args_type = "arg1:s,arg2:s?,arg3:s?",
1404 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1405 .help = "remove host-to-guest TCP or UDP redirection",
1406 .cmd = hmp_hostfwd_remove,
1409 #endif
1410 STEXI
1411 @item hostfwd_remove
1412 @findex hostfwd_remove
1413 Remove host-to-guest TCP or UDP redirection.
1414 ETEXI
1417 .name = "balloon",
1418 .args_type = "value:M",
1419 .params = "target",
1420 .help = "request VM to change its memory allocation (in MB)",
1421 .cmd = hmp_balloon,
1424 STEXI
1425 @item balloon @var{value}
1426 @findex balloon
1427 Request VM to change its memory allocation to @var{value} (in MB).
1428 ETEXI
1431 .name = "set_link",
1432 .args_type = "name:s,up:b",
1433 .params = "name on|off",
1434 .help = "change the link status of a network adapter",
1435 .cmd = hmp_set_link,
1436 .command_completion = set_link_completion,
1439 STEXI
1440 @item set_link @var{name} [on|off]
1441 @findex set_link
1442 Switch link @var{name} on (i.e. up) or off (i.e. down).
1443 ETEXI
1446 .name = "watchdog_action",
1447 .args_type = "action:s",
1448 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1449 .help = "change watchdog action",
1450 .cmd = hmp_watchdog_action,
1451 .command_completion = watchdog_action_completion,
1454 STEXI
1455 @item watchdog_action
1456 @findex watchdog_action
1457 Change watchdog action.
1458 ETEXI
1461 .name = "acl_show",
1462 .args_type = "aclname:s",
1463 .params = "aclname",
1464 .help = "list rules in the access control list",
1465 .cmd = hmp_acl_show,
1468 STEXI
1469 @item acl_show @var{aclname}
1470 @findex acl_show
1471 List all the matching rules in the access control list, and the default
1472 policy. There are currently two named access control lists,
1473 @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1474 certificate distinguished name, and SASL username respectively.
1475 ETEXI
1478 .name = "acl_policy",
1479 .args_type = "aclname:s,policy:s",
1480 .params = "aclname allow|deny",
1481 .help = "set default access control list policy",
1482 .cmd = hmp_acl_policy,
1485 STEXI
1486 @item acl_policy @var{aclname} @code{allow|deny}
1487 @findex acl_policy
1488 Set the default access control list policy, used in the event that
1489 none of the explicit rules match. The default policy at startup is
1490 always @code{deny}.
1491 ETEXI
1494 .name = "acl_add",
1495 .args_type = "aclname:s,match:s,policy:s,index:i?",
1496 .params = "aclname match allow|deny [index]",
1497 .help = "add a match rule to the access control list",
1498 .cmd = hmp_acl_add,
1501 STEXI
1502 @item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1503 @findex acl_add
1504 Add a match rule to the access control list, allowing or denying access.
1505 The match will normally be an exact username or x509 distinguished name,
1506 but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1507 allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
1508 normally be appended to the end of the ACL, but can be inserted
1509 earlier in the list if the optional @var{index} parameter is supplied.
1510 ETEXI
1513 .name = "acl_remove",
1514 .args_type = "aclname:s,match:s",
1515 .params = "aclname match",
1516 .help = "remove a match rule from the access control list",
1517 .cmd = hmp_acl_remove,
1520 STEXI
1521 @item acl_remove @var{aclname} @var{match}
1522 @findex acl_remove
1523 Remove the specified match rule from the access control list.
1524 ETEXI
1527 .name = "acl_reset",
1528 .args_type = "aclname:s",
1529 .params = "aclname",
1530 .help = "reset the access control list",
1531 .cmd = hmp_acl_reset,
1534 STEXI
1535 @item acl_reset @var{aclname}
1536 @findex acl_reset
1537 Remove all matches from the access control list, and set the default
1538 policy back to @code{deny}.
1539 ETEXI
1542 .name = "nbd_server_start",
1543 .args_type = "all:-a,writable:-w,uri:s",
1544 .params = "nbd_server_start [-a] [-w] host:port",
1545 .help = "serve block devices on the given host and port",
1546 .cmd = hmp_nbd_server_start,
1548 STEXI
1549 @item nbd_server_start @var{host}:@var{port}
1550 @findex nbd_server_start
1551 Start an NBD server on the given host and/or port. If the @option{-a}
1552 option is included, all of the virtual machine's block devices that
1553 have an inserted media on them are automatically exported; in this case,
1554 the @option{-w} option makes the devices writable too.
1555 ETEXI
1558 .name = "nbd_server_add",
1559 .args_type = "writable:-w,device:B",
1560 .params = "nbd_server_add [-w] device",
1561 .help = "export a block device via NBD",
1562 .cmd = hmp_nbd_server_add,
1564 STEXI
1565 @item nbd_server_add @var{device}
1566 @findex nbd_server_add
1567 Export a block device through QEMU's NBD server, which must be started
1568 beforehand with @command{nbd_server_start}. The @option{-w} option makes the
1569 exported device writable too.
1570 ETEXI
1573 .name = "nbd_server_stop",
1574 .args_type = "",
1575 .params = "nbd_server_stop",
1576 .help = "stop serving block devices using the NBD protocol",
1577 .cmd = hmp_nbd_server_stop,
1579 STEXI
1580 @item nbd_server_stop
1581 @findex nbd_server_stop
1582 Stop the QEMU embedded NBD server.
1583 ETEXI
1586 #if defined(TARGET_I386)
1589 .name = "mce",
1590 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1591 .params = "[-b] cpu bank status mcgstatus addr misc",
1592 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1593 .cmd = hmp_mce,
1596 #endif
1597 STEXI
1598 @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1599 @findex mce (x86)
1600 Inject an MCE on the given CPU (x86 only).
1601 ETEXI
1604 .name = "getfd",
1605 .args_type = "fdname:s",
1606 .params = "getfd name",
1607 .help = "receive a file descriptor via SCM rights and assign it a name",
1608 .cmd = hmp_getfd,
1611 STEXI
1612 @item getfd @var{fdname}
1613 @findex getfd
1614 If a file descriptor is passed alongside this command using the SCM_RIGHTS
1615 mechanism on unix sockets, it is stored using the name @var{fdname} for
1616 later use by other monitor commands.
1617 ETEXI
1620 .name = "closefd",
1621 .args_type = "fdname:s",
1622 .params = "closefd name",
1623 .help = "close a file descriptor previously passed via SCM rights",
1624 .cmd = hmp_closefd,
1627 STEXI
1628 @item closefd @var{fdname}
1629 @findex closefd
1630 Close the file descriptor previously assigned to @var{fdname} using the
1631 @code{getfd} command. This is only needed if the file descriptor was never
1632 used by another monitor command.
1633 ETEXI
1636 .name = "block_passwd",
1637 .args_type = "device:B,password:s",
1638 .params = "block_passwd device password",
1639 .help = "set the password of encrypted block devices",
1640 .cmd = hmp_block_passwd,
1643 STEXI
1644 @item block_passwd @var{device} @var{password}
1645 @findex block_passwd
1646 Set the encrypted device @var{device} password to @var{password}
1647 ETEXI
1650 .name = "block_set_io_throttle",
1651 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1652 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1653 .help = "change I/O throttle limits for a block drive",
1654 .cmd = hmp_block_set_io_throttle,
1657 STEXI
1658 @item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1659 @findex block_set_io_throttle
1660 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}
1661 ETEXI
1664 .name = "set_password",
1665 .args_type = "protocol:s,password:s,connected:s?",
1666 .params = "protocol password action-if-connected",
1667 .help = "set spice/vnc password",
1668 .cmd = hmp_set_password,
1671 STEXI
1672 @item set_password [ vnc | spice ] password [ action-if-connected ]
1673 @findex set_password
1674 Change spice/vnc password. Use zero to make the password stay valid
1675 forever. @var{action-if-connected} specifies what should happen in
1676 case a connection is established: @var{fail} makes the password change
1677 fail. @var{disconnect} changes the password and disconnects the
1678 client. @var{keep} changes the password and keeps the connection up.
1679 @var{keep} is the default.
1680 ETEXI
1683 .name = "expire_password",
1684 .args_type = "protocol:s,time:s",
1685 .params = "protocol time",
1686 .help = "set spice/vnc password expire-time",
1687 .cmd = hmp_expire_password,
1690 STEXI
1691 @item expire_password [ vnc | spice ] expire-time
1692 @findex expire_password
1693 Specify when a password for spice/vnc becomes
1694 invalid. @var{expire-time} accepts:
1696 @table @var
1697 @item now
1698 Invalidate password instantly.
1700 @item never
1701 Password stays valid forever.
1703 @item +nsec
1704 Password stays valid for @var{nsec} seconds starting now.
1706 @item nsec
1707 Password is invalidated at the given time. @var{nsec} are the seconds
1708 passed since 1970, i.e. unix epoch.
1710 @end table
1711 ETEXI
1714 .name = "chardev-add",
1715 .args_type = "args:s",
1716 .params = "args",
1717 .help = "add chardev",
1718 .cmd = hmp_chardev_add,
1719 .command_completion = chardev_add_completion,
1722 STEXI
1723 @item chardev-add args
1724 @findex chardev-add
1725 chardev_add accepts the same parameters as the -chardev command line switch.
1727 ETEXI
1730 .name = "chardev-remove",
1731 .args_type = "id:s",
1732 .params = "id",
1733 .help = "remove chardev",
1734 .cmd = hmp_chardev_remove,
1735 .command_completion = chardev_remove_completion,
1738 STEXI
1739 @item chardev-remove id
1740 @findex chardev-remove
1741 Removes the chardev @var{id}.
1743 ETEXI
1746 .name = "qemu-io",
1747 .args_type = "device:B,command:s",
1748 .params = "[device] \"[command]\"",
1749 .help = "run a qemu-io command on a block device",
1750 .cmd = hmp_qemu_io,
1753 STEXI
1754 @item qemu-io @var{device} @var{command}
1755 @findex qemu-io
1756 Executes a qemu-io command on the given block device.
1758 ETEXI
1761 .name = "cpu-add",
1762 .args_type = "id:i",
1763 .params = "id",
1764 .help = "add cpu",
1765 .cmd = hmp_cpu_add,
1768 STEXI
1769 @item cpu-add @var{id}
1770 @findex cpu-add
1771 Add CPU with id @var{id}
1772 ETEXI
1775 .name = "qom-list",
1776 .args_type = "path:s?",
1777 .params = "path",
1778 .help = "list QOM properties",
1779 .cmd = hmp_qom_list,
1782 STEXI
1783 @item qom-list [@var{path}]
1784 Print QOM properties of object at location @var{path}
1785 ETEXI
1788 .name = "qom-set",
1789 .args_type = "path:s,property:s,value:s",
1790 .params = "path property value",
1791 .help = "set QOM property",
1792 .cmd = hmp_qom_set,
1795 STEXI
1796 @item qom-set @var{path} @var{property} @var{value}
1797 Set QOM property @var{property} of object at location @var{path} to value @var{value}
1798 ETEXI
1801 .name = "info",
1802 .args_type = "item:s?",
1803 .params = "[subcommand]",
1804 .help = "show various information about the system state",
1805 .cmd = hmp_info_help,
1806 .sub_table = info_cmds,
1809 STEXI
1810 @end table
1811 ETEXI