test-hbitmap: Add non-advancing iter_next tests
[qemu.git] / hmp-commands.hx
blob0de7c4c29e1fa742560d0a37418fa359bf621283
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 you want to abort the operation immediately"
110 "\n\t\t\t instead of keep running until data is in sync)",
111 .cmd = hmp_block_job_cancel,
114 STEXI
115 @item block_job_cancel
116 @findex block_job_cancel
117 Stop an active background block operation (streaming, mirroring).
118 ETEXI
121 .name = "block_job_complete",
122 .args_type = "device:B",
123 .params = "device",
124 .help = "stop an active background block operation",
125 .cmd = hmp_block_job_complete,
128 STEXI
129 @item block_job_complete
130 @findex block_job_complete
131 Manually trigger completion of an active background block operation.
132 For mirroring, this will switch the device to the destination path.
133 ETEXI
136 .name = "block_job_pause",
137 .args_type = "device:B",
138 .params = "device",
139 .help = "pause an active background block operation",
140 .cmd = hmp_block_job_pause,
143 STEXI
144 @item block_job_pause
145 @findex block_job_pause
146 Pause an active block streaming operation.
147 ETEXI
150 .name = "block_job_resume",
151 .args_type = "device:B",
152 .params = "device",
153 .help = "resume a paused background block operation",
154 .cmd = hmp_block_job_resume,
157 STEXI
158 @item block_job_resume
159 @findex block_job_resume
160 Resume a paused block streaming operation.
161 ETEXI
164 .name = "eject",
165 .args_type = "force:-f,device:B",
166 .params = "[-f] device",
167 .help = "eject a removable medium (use -f to force it)",
168 .cmd = hmp_eject,
171 STEXI
172 @item eject [-f] @var{device}
173 @findex eject
174 Eject a removable medium (use -f to force it).
175 ETEXI
178 .name = "drive_del",
179 .args_type = "id:B",
180 .params = "device",
181 .help = "remove host block device",
182 .cmd = hmp_drive_del,
185 STEXI
186 @item drive_del @var{device}
187 @findex drive_del
188 Remove host block device. The result is that guest generated IO is no longer
189 submitted against the host device underlying the disk. Once a drive has
190 been deleted, the QEMU Block layer returns -EIO which results in IO
191 errors in the guest for applications that are reading/writing to the device.
192 These errors are always reported to the guest, regardless of the drive's error
193 actions (drive options rerror, werror).
194 ETEXI
197 .name = "change",
198 .args_type = "device:B,target:F,arg:s?,read-only-mode:s?",
199 .params = "device filename [format [read-only-mode]]",
200 .help = "change a removable medium, optional format",
201 .cmd = hmp_change,
204 STEXI
205 @item change @var{device} @var{setting}
206 @findex change
207 Change the configuration of a device.
209 @table @option
210 @item change @var{diskdevice} @var{filename} [@var{format} [@var{read-only-mode}]]
211 Change the medium for a removable disk device to point to @var{filename}. eg
213 @example
214 (qemu) change ide1-cd0 /path/to/some.iso
215 @end example
217 @var{format} is optional.
219 @var{read-only-mode} may be used to change the read-only status of the device.
220 It accepts the following values:
222 @table @var
223 @item retain
224 Retains the current status; this is the default.
226 @item read-only
227 Makes the device read-only.
229 @item read-write
230 Makes the device writable.
231 @end table
233 @item change vnc @var{display},@var{options}
234 Change the configuration of the VNC server. The valid syntax for @var{display}
235 and @var{options} are described at @ref{sec_invocation}. eg
237 @example
238 (qemu) change vnc localhost:1
239 @end example
241 @item change vnc password [@var{password}]
243 Change the password associated with the VNC server. If the new password is not
244 supplied, the monitor will prompt for it to be entered. VNC passwords are only
245 significant up to 8 letters. eg
247 @example
248 (qemu) change vnc password
249 Password: ********
250 @end example
252 @end table
253 ETEXI
256 .name = "screendump",
257 .args_type = "filename:F,device:s?,head:i?",
258 .params = "filename [device [head]]",
259 .help = "save screen from head 'head' of display device 'device' "
260 "into PPM image 'filename'",
261 .cmd = hmp_screendump,
264 STEXI
265 @item screendump @var{filename}
266 @findex screendump
267 Save screen into PPM image @var{filename}.
268 ETEXI
271 .name = "logfile",
272 .args_type = "filename:F",
273 .params = "filename",
274 .help = "output logs to 'filename'",
275 .cmd = hmp_logfile,
278 STEXI
279 @item logfile @var{filename}
280 @findex logfile
281 Output logs to @var{filename}.
282 ETEXI
285 .name = "trace-event",
286 .args_type = "name:s,option:b,vcpu:i?",
287 .params = "name on|off [vcpu]",
288 .help = "changes status of a specific trace event "
289 "(vcpu: vCPU to set, default is all)",
290 .cmd = hmp_trace_event,
291 .command_completion = trace_event_completion,
294 STEXI
295 @item trace-event
296 @findex trace-event
297 changes status of a trace event
298 ETEXI
300 #if defined(CONFIG_TRACE_SIMPLE)
302 .name = "trace-file",
303 .args_type = "op:s?,arg:F?",
304 .params = "on|off|flush|set [arg]",
305 .help = "open, close, or flush trace file, or set a new file name",
306 .cmd = hmp_trace_file,
309 STEXI
310 @item trace-file on|off|flush
311 @findex trace-file
312 Open, close, or flush the trace file. If no argument is given, the status of the trace file is displayed.
313 ETEXI
314 #endif
317 .name = "log",
318 .args_type = "items:s",
319 .params = "item1[,...]",
320 .help = "activate logging of the specified items",
321 .cmd = hmp_log,
324 STEXI
325 @item log @var{item1}[,...]
326 @findex log
327 Activate logging of the specified items.
328 ETEXI
331 .name = "savevm",
332 .args_type = "name:s?",
333 .params = "[tag|id]",
334 .help = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
335 .cmd = hmp_savevm,
338 STEXI
339 @item savevm [@var{tag}|@var{id}]
340 @findex savevm
341 Create a snapshot of the whole virtual machine. If @var{tag} is
342 provided, it is used as human readable identifier. If there is already
343 a snapshot with the same tag or ID, it is replaced. More info at
344 @ref{vm_snapshots}.
345 ETEXI
348 .name = "loadvm",
349 .args_type = "name:s",
350 .params = "tag|id",
351 .help = "restore a VM snapshot from its tag or id",
352 .cmd = hmp_loadvm,
353 .command_completion = loadvm_completion,
356 STEXI
357 @item loadvm @var{tag}|@var{id}
358 @findex loadvm
359 Set the whole virtual machine to the snapshot identified by the tag
360 @var{tag} or the unique snapshot ID @var{id}.
361 ETEXI
364 .name = "delvm",
365 .args_type = "name:s",
366 .params = "tag|id",
367 .help = "delete a VM snapshot from its tag or id",
368 .cmd = hmp_delvm,
369 .command_completion = delvm_completion,
372 STEXI
373 @item delvm @var{tag}|@var{id}
374 @findex delvm
375 Delete the snapshot identified by @var{tag} or @var{id}.
376 ETEXI
379 .name = "singlestep",
380 .args_type = "option:s?",
381 .params = "[on|off]",
382 .help = "run emulation in singlestep mode or switch to normal mode",
383 .cmd = hmp_singlestep,
386 STEXI
387 @item singlestep [off]
388 @findex singlestep
389 Run the emulation in single step mode.
390 If called with option off, the emulation returns to normal mode.
391 ETEXI
394 .name = "stop",
395 .args_type = "",
396 .params = "",
397 .help = "stop emulation",
398 .cmd = hmp_stop,
401 STEXI
402 @item stop
403 @findex stop
404 Stop emulation.
405 ETEXI
408 .name = "c|cont",
409 .args_type = "",
410 .params = "",
411 .help = "resume emulation",
412 .cmd = hmp_cont,
415 STEXI
416 @item c or cont
417 @findex cont
418 Resume emulation.
419 ETEXI
422 .name = "system_wakeup",
423 .args_type = "",
424 .params = "",
425 .help = "wakeup guest from suspend",
426 .cmd = hmp_system_wakeup,
429 STEXI
430 @item system_wakeup
431 @findex system_wakeup
432 Wakeup guest from suspend.
433 ETEXI
436 .name = "gdbserver",
437 .args_type = "device:s?",
438 .params = "[device]",
439 .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
440 .cmd = hmp_gdbserver,
443 STEXI
444 @item gdbserver [@var{port}]
445 @findex gdbserver
446 Start gdbserver session (default @var{port}=1234)
447 ETEXI
450 .name = "x",
451 .args_type = "fmt:/,addr:l",
452 .params = "/fmt addr",
453 .help = "virtual memory dump starting at 'addr'",
454 .cmd = hmp_memory_dump,
457 STEXI
458 @item x/fmt @var{addr}
459 @findex x
460 Virtual memory dump starting at @var{addr}.
461 ETEXI
464 .name = "xp",
465 .args_type = "fmt:/,addr:l",
466 .params = "/fmt addr",
467 .help = "physical memory dump starting at 'addr'",
468 .cmd = hmp_physical_memory_dump,
471 STEXI
472 @item xp /@var{fmt} @var{addr}
473 @findex xp
474 Physical memory dump starting at @var{addr}.
476 @var{fmt} is a format which tells the command how to format the
477 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
479 @table @var
480 @item count
481 is the number of items to be dumped.
483 @item format
484 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
485 c (char) or i (asm instruction).
487 @item size
488 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
489 @code{h} or @code{w} can be specified with the @code{i} format to
490 respectively select 16 or 32 bit code instruction size.
492 @end table
494 Examples:
495 @itemize
496 @item
497 Dump 10 instructions at the current instruction pointer:
498 @example
499 (qemu) x/10i $eip
500 0x90107063: ret
501 0x90107064: sti
502 0x90107065: lea 0x0(%esi,1),%esi
503 0x90107069: lea 0x0(%edi,1),%edi
504 0x90107070: ret
505 0x90107071: jmp 0x90107080
506 0x90107073: nop
507 0x90107074: nop
508 0x90107075: nop
509 0x90107076: nop
510 @end example
512 @item
513 Dump 80 16 bit values at the start of the video memory.
514 @smallexample
515 (qemu) xp/80hx 0xb8000
516 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
517 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
518 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
519 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
520 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
521 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
522 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
523 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
524 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
525 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
526 @end smallexample
527 @end itemize
528 ETEXI
531 .name = "gpa2hva",
532 .args_type = "addr:l",
533 .params = "addr",
534 .help = "print the host virtual address corresponding to a guest physical address",
535 .cmd = hmp_gpa2hva,
538 STEXI
539 @item gpa2hva @var{addr}
540 @findex gpa2hva
541 Print the host virtual address at which the guest's physical address @var{addr}
542 is mapped.
543 ETEXI
545 #ifdef CONFIG_LINUX
547 .name = "gpa2hpa",
548 .args_type = "addr:l",
549 .params = "addr",
550 .help = "print the host physical address corresponding to a guest physical address",
551 .cmd = hmp_gpa2hpa,
553 #endif
555 STEXI
556 @item gpa2hpa @var{addr}
557 @findex gpa2hpa
558 Print the host physical address at which the guest's physical address @var{addr}
559 is mapped.
560 ETEXI
563 .name = "p|print",
564 .args_type = "fmt:/,val:l",
565 .params = "/fmt expr",
566 .help = "print expression value (use $reg for CPU register access)",
567 .cmd = do_print,
570 STEXI
571 @item p or print/@var{fmt} @var{expr}
572 @findex print
573 Print expression value. Only the @var{format} part of @var{fmt} is
574 used.
575 ETEXI
578 .name = "i",
579 .args_type = "fmt:/,addr:i,index:i.",
580 .params = "/fmt addr",
581 .help = "I/O port read",
582 .cmd = hmp_ioport_read,
585 STEXI
586 @item i/@var{fmt} @var{addr} [.@var{index}]
587 @findex i
588 Read I/O port.
589 ETEXI
592 .name = "o",
593 .args_type = "fmt:/,addr:i,val:i",
594 .params = "/fmt addr value",
595 .help = "I/O port write",
596 .cmd = hmp_ioport_write,
599 STEXI
600 @item o/@var{fmt} @var{addr} @var{val}
601 @findex o
602 Write to I/O port.
603 ETEXI
606 .name = "sendkey",
607 .args_type = "keys:s,hold-time:i?",
608 .params = "keys [hold_ms]",
609 .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
610 .cmd = hmp_sendkey,
611 .command_completion = sendkey_completion,
614 STEXI
615 @item sendkey @var{keys}
616 @findex sendkey
617 Send @var{keys} to the guest. @var{keys} could be the name of the
618 key or the raw value in hexadecimal format. Use @code{-} to press
619 several keys simultaneously. Example:
620 @example
621 sendkey ctrl-alt-f1
622 @end example
624 This command is useful to send keys that your graphical user interface
625 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
626 ETEXI
629 .name = "system_reset",
630 .args_type = "",
631 .params = "",
632 .help = "reset the system",
633 .cmd = hmp_system_reset,
636 STEXI
637 @item system_reset
638 @findex system_reset
639 Reset the system.
640 ETEXI
643 .name = "system_powerdown",
644 .args_type = "",
645 .params = "",
646 .help = "send system power down event",
647 .cmd = hmp_system_powerdown,
650 STEXI
651 @item system_powerdown
652 @findex system_powerdown
653 Power down the system (if supported).
654 ETEXI
657 .name = "sum",
658 .args_type = "start:i,size:i",
659 .params = "addr size",
660 .help = "compute the checksum of a memory region",
661 .cmd = hmp_sum,
664 STEXI
665 @item sum @var{addr} @var{size}
666 @findex sum
667 Compute the checksum of a memory region.
668 ETEXI
671 .name = "device_add",
672 .args_type = "device:O",
673 .params = "driver[,prop=value][,...]",
674 .help = "add device, like -device on the command line",
675 .cmd = hmp_device_add,
676 .command_completion = device_add_completion,
679 STEXI
680 @item device_add @var{config}
681 @findex device_add
682 Add device.
683 ETEXI
686 .name = "device_del",
687 .args_type = "id:s",
688 .params = "device",
689 .help = "remove device",
690 .cmd = hmp_device_del,
691 .command_completion = device_del_completion,
694 STEXI
695 @item device_del @var{id}
696 @findex device_del
697 Remove device @var{id}. @var{id} may be a short ID
698 or a QOM object path.
699 ETEXI
702 .name = "cpu",
703 .args_type = "index:i",
704 .params = "index",
705 .help = "set the default CPU",
706 .cmd = hmp_cpu,
709 STEXI
710 @item cpu @var{index}
711 @findex cpu
712 Set the default CPU.
713 ETEXI
716 .name = "mouse_move",
717 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
718 .params = "dx dy [dz]",
719 .help = "send mouse move events",
720 .cmd = hmp_mouse_move,
723 STEXI
724 @item mouse_move @var{dx} @var{dy} [@var{dz}]
725 @findex mouse_move
726 Move the active mouse to the specified coordinates @var{dx} @var{dy}
727 with optional scroll axis @var{dz}.
728 ETEXI
731 .name = "mouse_button",
732 .args_type = "button_state:i",
733 .params = "state",
734 .help = "change mouse button state (1=L, 2=M, 4=R)",
735 .cmd = hmp_mouse_button,
738 STEXI
739 @item mouse_button @var{val}
740 @findex mouse_button
741 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
742 ETEXI
745 .name = "mouse_set",
746 .args_type = "index:i",
747 .params = "index",
748 .help = "set which mouse device receives events",
749 .cmd = hmp_mouse_set,
752 STEXI
753 @item mouse_set @var{index}
754 @findex mouse_set
755 Set which mouse device receives events at given @var{index}, index
756 can be obtained with
757 @example
758 info mice
759 @end example
760 ETEXI
763 .name = "wavcapture",
764 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
765 .params = "path [frequency [bits [channels]]]",
766 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
767 .cmd = hmp_wavcapture,
769 STEXI
770 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
771 @findex wavcapture
772 Capture audio into @var{filename}. Using sample rate @var{frequency}
773 bits per sample @var{bits} and number of channels @var{channels}.
775 Defaults:
776 @itemize @minus
777 @item Sample rate = 44100 Hz - CD quality
778 @item Bits = 16
779 @item Number of channels = 2 - Stereo
780 @end itemize
781 ETEXI
784 .name = "stopcapture",
785 .args_type = "n:i",
786 .params = "capture index",
787 .help = "stop capture",
788 .cmd = hmp_stopcapture,
790 STEXI
791 @item stopcapture @var{index}
792 @findex stopcapture
793 Stop capture with a given @var{index}, index can be obtained with
794 @example
795 info capture
796 @end example
797 ETEXI
800 .name = "memsave",
801 .args_type = "val:l,size:i,filename:s",
802 .params = "addr size file",
803 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
804 .cmd = hmp_memsave,
807 STEXI
808 @item memsave @var{addr} @var{size} @var{file}
809 @findex memsave
810 save to disk virtual memory dump starting at @var{addr} of size @var{size}.
811 ETEXI
814 .name = "pmemsave",
815 .args_type = "val:l,size:i,filename:s",
816 .params = "addr size file",
817 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
818 .cmd = hmp_pmemsave,
821 STEXI
822 @item pmemsave @var{addr} @var{size} @var{file}
823 @findex pmemsave
824 save to disk physical memory dump starting at @var{addr} of size @var{size}.
825 ETEXI
828 .name = "boot_set",
829 .args_type = "bootdevice:s",
830 .params = "bootdevice",
831 .help = "define new values for the boot device list",
832 .cmd = hmp_boot_set,
835 STEXI
836 @item boot_set @var{bootdevicelist}
837 @findex boot_set
838 Define new values for the boot device list. Those values will override
839 the values specified on the command line through the @code{-boot} option.
841 The values that can be specified here depend on the machine type, but are
842 the same that can be specified in the @code{-boot} command line option.
843 ETEXI
846 .name = "nmi",
847 .args_type = "",
848 .params = "",
849 .help = "inject an NMI",
850 .cmd = hmp_nmi,
852 STEXI
853 @item nmi @var{cpu}
854 @findex nmi
855 Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
857 ETEXI
860 .name = "ringbuf_write",
861 .args_type = "device:s,data:s",
862 .params = "device data",
863 .help = "Write to a ring buffer character device",
864 .cmd = hmp_ringbuf_write,
865 .command_completion = ringbuf_write_completion,
868 STEXI
869 @item ringbuf_write @var{device} @var{data}
870 @findex ringbuf_write
871 Write @var{data} to ring buffer character device @var{device}.
872 @var{data} must be a UTF-8 string.
874 ETEXI
877 .name = "ringbuf_read",
878 .args_type = "device:s,size:i",
879 .params = "device size",
880 .help = "Read from a ring buffer character device",
881 .cmd = hmp_ringbuf_read,
882 .command_completion = ringbuf_write_completion,
885 STEXI
886 @item ringbuf_read @var{device}
887 @findex ringbuf_read
888 Read and print up to @var{size} bytes from ring buffer character
889 device @var{device}.
890 Certain non-printable characters are printed \uXXXX, where XXXX is the
891 character code in hexadecimal. Character \ is printed \\.
892 Bug: can screw up when the buffer contains invalid UTF-8 sequences,
893 NUL characters, after the ring buffer lost data, and when reading
894 stops because the size limit is reached.
896 ETEXI
899 .name = "migrate",
900 .args_type = "detach:-d,blk:-b,inc:-i,resume:-r,uri:s",
901 .params = "[-d] [-b] [-i] [-r] uri",
902 .help = "migrate to URI (using -d to not wait for completion)"
903 "\n\t\t\t -b for migration without shared storage with"
904 " full copy of disk\n\t\t\t -i for migration without "
905 "shared storage with incremental copy of disk "
906 "(base image shared between src and destination)"
907 "\n\t\t\t -r to resume a paused migration",
908 .cmd = hmp_migrate,
912 STEXI
913 @item migrate [-d] [-b] [-i] @var{uri}
914 @findex migrate
915 Migrate to @var{uri} (using -d to not wait for completion).
916 -b for migration with full copy of disk
917 -i for migration with incremental copy of disk (base image is shared)
918 ETEXI
921 .name = "migrate_cancel",
922 .args_type = "",
923 .params = "",
924 .help = "cancel the current VM migration",
925 .cmd = hmp_migrate_cancel,
928 STEXI
929 @item migrate_cancel
930 @findex migrate_cancel
931 Cancel the current VM migration.
932 ETEXI
935 .name = "migrate_continue",
936 .args_type = "state:s",
937 .params = "state",
938 .help = "Continue migration from the given paused state",
939 .cmd = hmp_migrate_continue,
941 STEXI
942 @item migrate_continue @var{state}
943 @findex migrate_continue
944 Continue migration from the paused state @var{state}
945 ETEXI
948 .name = "migrate_incoming",
949 .args_type = "uri:s",
950 .params = "uri",
951 .help = "Continue an incoming migration from an -incoming defer",
952 .cmd = hmp_migrate_incoming,
955 STEXI
956 @item migrate_incoming @var{uri}
957 @findex migrate_incoming
958 Continue an incoming migration using the @var{uri} (that has the same syntax
959 as the -incoming option).
960 ETEXI
963 .name = "migrate_recover",
964 .args_type = "uri:s",
965 .params = "uri",
966 .help = "Continue a paused incoming postcopy migration",
967 .cmd = hmp_migrate_recover,
970 STEXI
971 @item migrate_recover @var{uri}
972 @findex migrate_recover
973 Continue a paused incoming postcopy migration using the @var{uri}.
974 ETEXI
977 .name = "migrate_pause",
978 .args_type = "",
979 .params = "",
980 .help = "Pause an ongoing migration (postcopy-only)",
981 .cmd = hmp_migrate_pause,
984 STEXI
985 @item migrate_pause
986 @findex migrate_pause
987 Pause an ongoing migration. Currently it only supports postcopy.
988 ETEXI
991 .name = "migrate_set_cache_size",
992 .args_type = "value:o",
993 .params = "value",
994 .help = "set cache size (in bytes) for XBZRLE migrations,"
995 "the cache size will be rounded down to the nearest "
996 "power of 2.\n"
997 "The cache size affects the number of cache misses."
998 "In case of a high cache miss ratio you need to increase"
999 " the cache size",
1000 .cmd = hmp_migrate_set_cache_size,
1003 STEXI
1004 @item migrate_set_cache_size @var{value}
1005 @findex migrate_set_cache_size
1006 Set cache size to @var{value} (in bytes) for xbzrle migrations.
1007 ETEXI
1010 .name = "migrate_set_speed",
1011 .args_type = "value:o",
1012 .params = "value",
1013 .help = "set maximum speed (in bytes) for migrations. "
1014 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
1015 .cmd = hmp_migrate_set_speed,
1018 STEXI
1019 @item migrate_set_speed @var{value}
1020 @findex migrate_set_speed
1021 Set maximum speed to @var{value} (in bytes) for migrations.
1022 ETEXI
1025 .name = "migrate_set_downtime",
1026 .args_type = "value:T",
1027 .params = "value",
1028 .help = "set maximum tolerated downtime (in seconds) for migrations",
1029 .cmd = hmp_migrate_set_downtime,
1032 STEXI
1033 @item migrate_set_downtime @var{second}
1034 @findex migrate_set_downtime
1035 Set maximum tolerated downtime (in seconds) for migration.
1036 ETEXI
1039 .name = "migrate_set_capability",
1040 .args_type = "capability:s,state:b",
1041 .params = "capability state",
1042 .help = "Enable/Disable the usage of a capability for migration",
1043 .cmd = hmp_migrate_set_capability,
1044 .command_completion = migrate_set_capability_completion,
1047 STEXI
1048 @item migrate_set_capability @var{capability} @var{state}
1049 @findex migrate_set_capability
1050 Enable/Disable the usage of a capability @var{capability} for migration.
1051 ETEXI
1054 .name = "migrate_set_parameter",
1055 .args_type = "parameter:s,value:s",
1056 .params = "parameter value",
1057 .help = "Set the parameter for migration",
1058 .cmd = hmp_migrate_set_parameter,
1059 .command_completion = migrate_set_parameter_completion,
1062 STEXI
1063 @item migrate_set_parameter @var{parameter} @var{value}
1064 @findex migrate_set_parameter
1065 Set the parameter @var{parameter} for migration.
1066 ETEXI
1069 .name = "migrate_start_postcopy",
1070 .args_type = "",
1071 .params = "",
1072 .help = "Followup to a migration command to switch the migration"
1073 " to postcopy mode. The postcopy-ram capability must "
1074 "be set on both source and destination before the "
1075 "original migration command .",
1076 .cmd = hmp_migrate_start_postcopy,
1079 STEXI
1080 @item migrate_start_postcopy
1081 @findex migrate_start_postcopy
1082 Switch in-progress migration to postcopy mode. Ignored after the end of
1083 migration (or once already in postcopy).
1084 ETEXI
1087 .name = "x_colo_lost_heartbeat",
1088 .args_type = "",
1089 .params = "",
1090 .help = "Tell COLO that heartbeat is lost,\n\t\t\t"
1091 "a failover or takeover is needed.",
1092 .cmd = hmp_x_colo_lost_heartbeat,
1095 STEXI
1096 @item x_colo_lost_heartbeat
1097 @findex x_colo_lost_heartbeat
1098 Tell COLO that heartbeat is lost, a failover or takeover is needed.
1099 ETEXI
1102 .name = "client_migrate_info",
1103 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1104 .params = "protocol hostname port tls-port cert-subject",
1105 .help = "set migration information for remote display",
1106 .cmd = hmp_client_migrate_info,
1109 STEXI
1110 @item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
1111 @findex client_migrate_info
1112 Set migration information for remote display. This makes the server
1113 ask the client to automatically reconnect using the new parameters
1114 once migration finished successfully. Only implemented for SPICE.
1115 ETEXI
1118 .name = "dump-guest-memory",
1119 .args_type = "paging:-p,detach:-d,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:i?,length:i?",
1120 .params = "[-p] [-d] [-z|-l|-s] filename [begin length]",
1121 .help = "dump guest memory into file 'filename'.\n\t\t\t"
1122 "-p: do paging to get guest's memory mapping.\n\t\t\t"
1123 "-d: return immediately (do not wait for completion).\n\t\t\t"
1124 "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1125 "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1126 "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
1127 "begin: the starting physical address.\n\t\t\t"
1128 "length: the memory size, in bytes.",
1129 .cmd = hmp_dump_guest_memory,
1133 STEXI
1134 @item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
1135 @item dump-guest-memory [-z|-l|-s] @var{filename}
1136 @findex dump-guest-memory
1137 Dump guest memory to @var{protocol}. The file can be processed with crash or
1138 gdb. Without -z|-l|-s, the dump format is ELF.
1139 -p: do paging to get guest's memory mapping.
1140 -z: dump in kdump-compressed format, with zlib compression.
1141 -l: dump in kdump-compressed format, with lzo compression.
1142 -s: dump in kdump-compressed format, with snappy compression.
1143 filename: dump file name.
1144 begin: the starting physical address. It's optional, and should be
1145 specified together with length.
1146 length: the memory size, in bytes. It's optional, and should be specified
1147 together with begin.
1148 ETEXI
1150 #if defined(TARGET_S390X)
1152 .name = "dump-skeys",
1153 .args_type = "filename:F",
1154 .params = "",
1155 .help = "Save guest storage keys into file 'filename'.\n",
1156 .cmd = hmp_dump_skeys,
1158 #endif
1160 STEXI
1161 @item dump-skeys @var{filename}
1162 @findex dump-skeys
1163 Save guest storage keys to a file.
1164 ETEXI
1166 #if defined(TARGET_S390X)
1168 .name = "migration_mode",
1169 .args_type = "mode:i",
1170 .params = "mode",
1171 .help = "Enables or disables migration mode\n",
1172 .cmd = hmp_migrationmode,
1174 #endif
1176 STEXI
1177 @item migration_mode @var{mode}
1178 @findex migration_mode
1179 Enables or disables migration mode.
1180 ETEXI
1183 .name = "snapshot_blkdev",
1184 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1185 .params = "[-n] device [new-image-file] [format]",
1186 .help = "initiates a live snapshot\n\t\t\t"
1187 "of device. If a new image file is specified, the\n\t\t\t"
1188 "new image file will become the new root image.\n\t\t\t"
1189 "If format is specified, the snapshot file will\n\t\t\t"
1190 "be created in that format.\n\t\t\t"
1191 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1192 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1193 "recreating it from scratch.",
1194 .cmd = hmp_snapshot_blkdev,
1197 STEXI
1198 @item snapshot_blkdev
1199 @findex snapshot_blkdev
1200 Snapshot device, using snapshot file as target if provided
1201 ETEXI
1204 .name = "snapshot_blkdev_internal",
1205 .args_type = "device:B,name:s",
1206 .params = "device name",
1207 .help = "take an internal snapshot of device.\n\t\t\t"
1208 "The format of the image used by device must\n\t\t\t"
1209 "support it, such as qcow2.\n\t\t\t",
1210 .cmd = hmp_snapshot_blkdev_internal,
1213 STEXI
1214 @item snapshot_blkdev_internal
1215 @findex snapshot_blkdev_internal
1216 Take an internal snapshot on device if it support
1217 ETEXI
1220 .name = "snapshot_delete_blkdev_internal",
1221 .args_type = "device:B,name:s,id:s?",
1222 .params = "device name [id]",
1223 .help = "delete an internal snapshot of device.\n\t\t\t"
1224 "If id is specified, qemu will try delete\n\t\t\t"
1225 "the snapshot matching both id and name.\n\t\t\t"
1226 "The format of the image used by device must\n\t\t\t"
1227 "support it, such as qcow2.\n\t\t\t",
1228 .cmd = hmp_snapshot_delete_blkdev_internal,
1231 STEXI
1232 @item snapshot_delete_blkdev_internal
1233 @findex snapshot_delete_blkdev_internal
1234 Delete an internal snapshot on device if it support
1235 ETEXI
1238 .name = "drive_mirror",
1239 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1240 .params = "[-n] [-f] device target [format]",
1241 .help = "initiates live storage\n\t\t\t"
1242 "migration for a device. The device's contents are\n\t\t\t"
1243 "copied to the new image file, including data that\n\t\t\t"
1244 "is written after the command is started.\n\t\t\t"
1245 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1246 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1247 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1248 "so that the result does not need a backing file.\n\t\t\t",
1249 .cmd = hmp_drive_mirror,
1251 STEXI
1252 @item drive_mirror
1253 @findex drive_mirror
1254 Start mirroring a block device's writes to a new destination,
1255 using the specified target.
1256 ETEXI
1259 .name = "drive_backup",
1260 .args_type = "reuse:-n,full:-f,compress:-c,device:B,target:s,format:s?",
1261 .params = "[-n] [-f] [-c] device target [format]",
1262 .help = "initiates a point-in-time\n\t\t\t"
1263 "copy for a device. The device's contents are\n\t\t\t"
1264 "copied to the new image file, excluding data that\n\t\t\t"
1265 "is written after the command is started.\n\t\t\t"
1266 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1267 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1268 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1269 "so that the result does not need a backing file.\n\t\t\t"
1270 "The -c flag requests QEMU to compress backup data\n\t\t\t"
1271 "(if the target format supports it).\n\t\t\t",
1272 .cmd = hmp_drive_backup,
1274 STEXI
1275 @item drive_backup
1276 @findex drive_backup
1277 Start a point-in-time copy of a block device to a specificed target.
1278 ETEXI
1281 .name = "drive_add",
1282 .args_type = "node:-n,pci_addr:s,opts:s",
1283 .params = "[-n] [[<domain>:]<bus>:]<slot>\n"
1284 "[file=file][,if=type][,bus=n]\n"
1285 "[,unit=m][,media=d][,index=i]\n"
1286 "[,snapshot=on|off][,cache=on|off]\n"
1287 "[,readonly=on|off][,copy-on-read=on|off]",
1288 .help = "add drive to PCI storage controller",
1289 .cmd = hmp_drive_add,
1292 STEXI
1293 @item drive_add
1294 @findex drive_add
1295 Add drive to PCI storage controller.
1296 ETEXI
1299 .name = "pcie_aer_inject_error",
1300 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1301 "id:s,error_status:s,"
1302 "header0:i?,header1:i?,header2:i?,header3:i?,"
1303 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1304 .params = "[-a] [-c] id "
1305 "<error_status> [<tlp header> [<tlp header prefix>]]",
1306 .help = "inject pcie aer error\n\t\t\t"
1307 " -a for advisory non fatal error\n\t\t\t"
1308 " -c for correctable error\n\t\t\t"
1309 "<id> = qdev device id\n\t\t\t"
1310 "<error_status> = error string or 32bit\n\t\t\t"
1311 "<tlb header> = 32bit x 4\n\t\t\t"
1312 "<tlb header prefix> = 32bit x 4",
1313 .cmd = hmp_pcie_aer_inject_error,
1316 STEXI
1317 @item pcie_aer_inject_error
1318 @findex pcie_aer_inject_error
1319 Inject PCIe AER error
1320 ETEXI
1323 .name = "netdev_add",
1324 .args_type = "netdev:O",
1325 .params = "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
1326 .help = "add host network device",
1327 .cmd = hmp_netdev_add,
1328 .command_completion = netdev_add_completion,
1331 STEXI
1332 @item netdev_add
1333 @findex netdev_add
1334 Add host network device.
1335 ETEXI
1338 .name = "netdev_del",
1339 .args_type = "id:s",
1340 .params = "id",
1341 .help = "remove host network device",
1342 .cmd = hmp_netdev_del,
1343 .command_completion = netdev_del_completion,
1346 STEXI
1347 @item netdev_del
1348 @findex netdev_del
1349 Remove host network device.
1350 ETEXI
1353 .name = "object_add",
1354 .args_type = "object:O",
1355 .params = "[qom-type=]type,id=str[,prop=value][,...]",
1356 .help = "create QOM object",
1357 .cmd = hmp_object_add,
1358 .command_completion = object_add_completion,
1361 STEXI
1362 @item object_add
1363 @findex object_add
1364 Create QOM object.
1365 ETEXI
1368 .name = "object_del",
1369 .args_type = "id:s",
1370 .params = "id",
1371 .help = "destroy QOM object",
1372 .cmd = hmp_object_del,
1373 .command_completion = object_del_completion,
1376 STEXI
1377 @item object_del
1378 @findex object_del
1379 Destroy QOM object.
1380 ETEXI
1382 #ifdef CONFIG_SLIRP
1384 .name = "hostfwd_add",
1385 .args_type = "arg1:s,arg2:s?,arg3:s?",
1386 .params = "[hub_id name]|[netdev_id] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1387 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
1388 .cmd = hmp_hostfwd_add,
1390 #endif
1391 STEXI
1392 @item hostfwd_add
1393 @findex hostfwd_add
1394 Redirect TCP or UDP connections from host to guest (requires -net user).
1395 ETEXI
1397 #ifdef CONFIG_SLIRP
1399 .name = "hostfwd_remove",
1400 .args_type = "arg1:s,arg2:s?,arg3:s?",
1401 .params = "[hub_id name]|[netdev_id] [tcp|udp]:[hostaddr]:hostport",
1402 .help = "remove host-to-guest TCP or UDP redirection",
1403 .cmd = hmp_hostfwd_remove,
1406 #endif
1407 STEXI
1408 @item hostfwd_remove
1409 @findex hostfwd_remove
1410 Remove host-to-guest TCP or UDP redirection.
1411 ETEXI
1414 .name = "balloon",
1415 .args_type = "value:M",
1416 .params = "target",
1417 .help = "request VM to change its memory allocation (in MB)",
1418 .cmd = hmp_balloon,
1421 STEXI
1422 @item balloon @var{value}
1423 @findex balloon
1424 Request VM to change its memory allocation to @var{value} (in MB).
1425 ETEXI
1428 .name = "set_link",
1429 .args_type = "name:s,up:b",
1430 .params = "name on|off",
1431 .help = "change the link status of a network adapter",
1432 .cmd = hmp_set_link,
1433 .command_completion = set_link_completion,
1436 STEXI
1437 @item set_link @var{name} [on|off]
1438 @findex set_link
1439 Switch link @var{name} on (i.e. up) or off (i.e. down).
1440 ETEXI
1443 .name = "watchdog_action",
1444 .args_type = "action:s",
1445 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1446 .help = "change watchdog action",
1447 .cmd = hmp_watchdog_action,
1448 .command_completion = watchdog_action_completion,
1451 STEXI
1452 @item watchdog_action
1453 @findex watchdog_action
1454 Change watchdog action.
1455 ETEXI
1458 .name = "acl_show",
1459 .args_type = "aclname:s",
1460 .params = "aclname",
1461 .help = "list rules in the access control list",
1462 .cmd = hmp_acl_show,
1465 STEXI
1466 @item acl_show @var{aclname}
1467 @findex acl_show
1468 List all the matching rules in the access control list, and the default
1469 policy. There are currently two named access control lists,
1470 @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1471 certificate distinguished name, and SASL username respectively.
1472 ETEXI
1475 .name = "acl_policy",
1476 .args_type = "aclname:s,policy:s",
1477 .params = "aclname allow|deny",
1478 .help = "set default access control list policy",
1479 .cmd = hmp_acl_policy,
1482 STEXI
1483 @item acl_policy @var{aclname} @code{allow|deny}
1484 @findex acl_policy
1485 Set the default access control list policy, used in the event that
1486 none of the explicit rules match. The default policy at startup is
1487 always @code{deny}.
1488 ETEXI
1491 .name = "acl_add",
1492 .args_type = "aclname:s,match:s,policy:s,index:i?",
1493 .params = "aclname match allow|deny [index]",
1494 .help = "add a match rule to the access control list",
1495 .cmd = hmp_acl_add,
1498 STEXI
1499 @item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1500 @findex acl_add
1501 Add a match rule to the access control list, allowing or denying access.
1502 The match will normally be an exact username or x509 distinguished name,
1503 but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1504 allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
1505 normally be appended to the end of the ACL, but can be inserted
1506 earlier in the list if the optional @var{index} parameter is supplied.
1507 ETEXI
1510 .name = "acl_remove",
1511 .args_type = "aclname:s,match:s",
1512 .params = "aclname match",
1513 .help = "remove a match rule from the access control list",
1514 .cmd = hmp_acl_remove,
1517 STEXI
1518 @item acl_remove @var{aclname} @var{match}
1519 @findex acl_remove
1520 Remove the specified match rule from the access control list.
1521 ETEXI
1524 .name = "acl_reset",
1525 .args_type = "aclname:s",
1526 .params = "aclname",
1527 .help = "reset the access control list",
1528 .cmd = hmp_acl_reset,
1531 STEXI
1532 @item acl_reset @var{aclname}
1533 @findex acl_reset
1534 Remove all matches from the access control list, and set the default
1535 policy back to @code{deny}.
1536 ETEXI
1539 .name = "nbd_server_start",
1540 .args_type = "all:-a,writable:-w,uri:s",
1541 .params = "nbd_server_start [-a] [-w] host:port",
1542 .help = "serve block devices on the given host and port",
1543 .cmd = hmp_nbd_server_start,
1545 STEXI
1546 @item nbd_server_start @var{host}:@var{port}
1547 @findex nbd_server_start
1548 Start an NBD server on the given host and/or port. If the @option{-a}
1549 option is included, all of the virtual machine's block devices that
1550 have an inserted media on them are automatically exported; in this case,
1551 the @option{-w} option makes the devices writable too.
1552 ETEXI
1555 .name = "nbd_server_add",
1556 .args_type = "writable:-w,device:B,name:s?",
1557 .params = "nbd_server_add [-w] device [name]",
1558 .help = "export a block device via NBD",
1559 .cmd = hmp_nbd_server_add,
1561 STEXI
1562 @item nbd_server_add @var{device} [ @var{name} ]
1563 @findex nbd_server_add
1564 Export a block device through QEMU's NBD server, which must be started
1565 beforehand with @command{nbd_server_start}. The @option{-w} option makes the
1566 exported device writable too. The export name is controlled by @var{name},
1567 defaulting to @var{device}.
1568 ETEXI
1571 .name = "nbd_server_remove",
1572 .args_type = "force:-f,name:s",
1573 .params = "nbd_server_remove [-f] name",
1574 .help = "remove an export previously exposed via NBD",
1575 .cmd = hmp_nbd_server_remove,
1577 STEXI
1578 @item nbd_server_remove [-f] @var{name}
1579 @findex nbd_server_remove
1580 Stop exporting a block device through QEMU's NBD server, which was
1581 previously started with @command{nbd_server_add}. The @option{-f}
1582 option forces the server to drop the export immediately even if
1583 clients are connected; otherwise the command fails unless there are no
1584 clients.
1585 ETEXI
1588 .name = "nbd_server_stop",
1589 .args_type = "",
1590 .params = "nbd_server_stop",
1591 .help = "stop serving block devices using the NBD protocol",
1592 .cmd = hmp_nbd_server_stop,
1594 STEXI
1595 @item nbd_server_stop
1596 @findex nbd_server_stop
1597 Stop the QEMU embedded NBD server.
1598 ETEXI
1601 #if defined(TARGET_I386)
1604 .name = "mce",
1605 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1606 .params = "[-b] cpu bank status mcgstatus addr misc",
1607 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1608 .cmd = hmp_mce,
1611 #endif
1612 STEXI
1613 @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1614 @findex mce (x86)
1615 Inject an MCE on the given CPU (x86 only).
1616 ETEXI
1619 .name = "getfd",
1620 .args_type = "fdname:s",
1621 .params = "getfd name",
1622 .help = "receive a file descriptor via SCM rights and assign it a name",
1623 .cmd = hmp_getfd,
1626 STEXI
1627 @item getfd @var{fdname}
1628 @findex getfd
1629 If a file descriptor is passed alongside this command using the SCM_RIGHTS
1630 mechanism on unix sockets, it is stored using the name @var{fdname} for
1631 later use by other monitor commands.
1632 ETEXI
1635 .name = "closefd",
1636 .args_type = "fdname:s",
1637 .params = "closefd name",
1638 .help = "close a file descriptor previously passed via SCM rights",
1639 .cmd = hmp_closefd,
1642 STEXI
1643 @item closefd @var{fdname}
1644 @findex closefd
1645 Close the file descriptor previously assigned to @var{fdname} using the
1646 @code{getfd} command. This is only needed if the file descriptor was never
1647 used by another monitor command.
1648 ETEXI
1651 .name = "block_passwd",
1652 .args_type = "device:B,password:s",
1653 .params = "block_passwd device password",
1654 .help = "set the password of encrypted block devices",
1655 .cmd = hmp_block_passwd,
1658 STEXI
1659 @item block_passwd @var{device} @var{password}
1660 @findex block_passwd
1661 Set the encrypted device @var{device} password to @var{password}
1663 This command is now obsolete and will always return an error since 2.10
1664 ETEXI
1667 .name = "block_set_io_throttle",
1668 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1669 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1670 .help = "change I/O throttle limits for a block drive",
1671 .cmd = hmp_block_set_io_throttle,
1674 STEXI
1675 @item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1676 @findex block_set_io_throttle
1677 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}.
1678 @var{device} can be a block device name, a qdev ID or a QOM path.
1679 ETEXI
1682 .name = "set_password",
1683 .args_type = "protocol:s,password:s,connected:s?",
1684 .params = "protocol password action-if-connected",
1685 .help = "set spice/vnc password",
1686 .cmd = hmp_set_password,
1689 STEXI
1690 @item set_password [ vnc | spice ] password [ action-if-connected ]
1691 @findex set_password
1692 Change spice/vnc password. Use zero to make the password stay valid
1693 forever. @var{action-if-connected} specifies what should happen in
1694 case a connection is established: @var{fail} makes the password change
1695 fail. @var{disconnect} changes the password and disconnects the
1696 client. @var{keep} changes the password and keeps the connection up.
1697 @var{keep} is the default.
1698 ETEXI
1701 .name = "expire_password",
1702 .args_type = "protocol:s,time:s",
1703 .params = "protocol time",
1704 .help = "set spice/vnc password expire-time",
1705 .cmd = hmp_expire_password,
1708 STEXI
1709 @item expire_password [ vnc | spice ] expire-time
1710 @findex expire_password
1711 Specify when a password for spice/vnc becomes
1712 invalid. @var{expire-time} accepts:
1714 @table @var
1715 @item now
1716 Invalidate password instantly.
1718 @item never
1719 Password stays valid forever.
1721 @item +nsec
1722 Password stays valid for @var{nsec} seconds starting now.
1724 @item nsec
1725 Password is invalidated at the given time. @var{nsec} are the seconds
1726 passed since 1970, i.e. unix epoch.
1728 @end table
1729 ETEXI
1732 .name = "chardev-add",
1733 .args_type = "args:s",
1734 .params = "args",
1735 .help = "add chardev",
1736 .cmd = hmp_chardev_add,
1737 .command_completion = chardev_add_completion,
1740 STEXI
1741 @item chardev-add args
1742 @findex chardev-add
1743 chardev-add accepts the same parameters as the -chardev command line switch.
1745 ETEXI
1748 .name = "chardev-change",
1749 .args_type = "id:s,args:s",
1750 .params = "id args",
1751 .help = "change chardev",
1752 .cmd = hmp_chardev_change,
1755 STEXI
1756 @item chardev-change args
1757 @findex chardev-change
1758 chardev-change accepts existing chardev @var{id} and then the same arguments
1759 as the -chardev command line switch (except for "id").
1761 ETEXI
1764 .name = "chardev-remove",
1765 .args_type = "id:s",
1766 .params = "id",
1767 .help = "remove chardev",
1768 .cmd = hmp_chardev_remove,
1769 .command_completion = chardev_remove_completion,
1772 STEXI
1773 @item chardev-remove id
1774 @findex chardev-remove
1775 Removes the chardev @var{id}.
1777 ETEXI
1780 .name = "chardev-send-break",
1781 .args_type = "id:s",
1782 .params = "id",
1783 .help = "send a break on chardev",
1784 .cmd = hmp_chardev_send_break,
1785 .command_completion = chardev_remove_completion,
1788 STEXI
1789 @item chardev-send-break id
1790 @findex chardev-send-break
1791 Send a break on the chardev @var{id}.
1793 ETEXI
1796 .name = "qemu-io",
1797 .args_type = "device:B,command:s",
1798 .params = "[device] \"[command]\"",
1799 .help = "run a qemu-io command on a block device",
1800 .cmd = hmp_qemu_io,
1803 STEXI
1804 @item qemu-io @var{device} @var{command}
1805 @findex qemu-io
1806 Executes a qemu-io command on the given block device.
1808 ETEXI
1811 .name = "cpu-add",
1812 .args_type = "id:i",
1813 .params = "id",
1814 .help = "add cpu",
1815 .cmd = hmp_cpu_add,
1818 STEXI
1819 @item cpu-add @var{id}
1820 @findex cpu-add
1821 Add CPU with id @var{id}
1822 ETEXI
1825 .name = "qom-list",
1826 .args_type = "path:s?",
1827 .params = "path",
1828 .help = "list QOM properties",
1829 .cmd = hmp_qom_list,
1832 STEXI
1833 @item qom-list [@var{path}]
1834 Print QOM properties of object at location @var{path}
1835 ETEXI
1838 .name = "qom-set",
1839 .args_type = "path:s,property:s,value:s",
1840 .params = "path property value",
1841 .help = "set QOM property",
1842 .cmd = hmp_qom_set,
1845 STEXI
1846 @item qom-set @var{path} @var{property} @var{value}
1847 Set QOM property @var{property} of object at location @var{path} to value @var{value}
1848 ETEXI
1851 .name = "info",
1852 .args_type = "item:s?",
1853 .params = "[subcommand]",
1854 .help = "show various information about the system state",
1855 .cmd = hmp_info_help,
1856 .sub_table = info_cmds,
1859 STEXI
1860 @end table
1861 ETEXI