Merge remote-tracking branch 'remotes/pmaydell/tags/pull-cocoa-20150925-1' into staging
[qemu/ar7.git] / hmp-commands.hx
blob3a4ae3950ad500fce21a86147317fe3bf21fa3f0
1 HXCOMM Use DEFHEADING() to define headings in both help text and texi
2 HXCOMM Text between STEXI and ETEXI are copied to texi version and
3 HXCOMM discarded from C version
4 HXCOMM DEF(command, args, callback, arg_string, help) is used to construct
5 HXCOMM monitor commands
6 HXCOMM HXCOMM can be used for comments, discarded from both texi and C
8 STEXI
9 @table @option
10 ETEXI
13 .name = "help|?",
14 .args_type = "name:S?",
15 .params = "[cmd]",
16 .help = "show the help",
17 .mhandler.cmd = do_help_cmd,
20 STEXI
21 @item help or ? [@var{cmd}]
22 @findex help
23 Show the help for all commands or just for command @var{cmd}.
24 ETEXI
27 .name = "commit",
28 .args_type = "device:B",
29 .params = "device|all",
30 .help = "commit changes to the disk images (if -snapshot is used) or backing files",
31 .mhandler.cmd = hmp_commit,
34 STEXI
35 @item commit
36 @findex commit
37 Commit changes to the disk images (if -snapshot is used) or backing files.
38 If the backing file is smaller than the snapshot, then the backing file will be
39 resized to be the same size as the snapshot. If the snapshot is smaller than
40 the backing file, the backing file will not be truncated. If you want the
41 backing file to match the size of the smaller snapshot, you can safely truncate
42 it yourself once the commit operation successfully completes.
43 ETEXI
46 .name = "q|quit",
47 .args_type = "",
48 .params = "",
49 .help = "quit the emulator",
50 .mhandler.cmd = hmp_quit,
53 STEXI
54 @item q or quit
55 @findex quit
56 Quit the emulator.
57 ETEXI
60 .name = "block_resize",
61 .args_type = "device:B,size:o",
62 .params = "device size",
63 .help = "resize a block image",
64 .mhandler.cmd = hmp_block_resize,
67 STEXI
68 @item block_resize
69 @findex block_resize
70 Resize a block image while a guest is running. Usually requires guest
71 action to see the updated size. Resize to a lower size is supported,
72 but should be used with extreme caution. Note that this command only
73 resizes image files, it can not resize block devices like LVM volumes.
74 ETEXI
77 .name = "block_stream",
78 .args_type = "device:B,speed:o?,base:s?",
79 .params = "device [speed [base]]",
80 .help = "copy data from a backing file into a block device",
81 .mhandler.cmd = hmp_block_stream,
84 STEXI
85 @item block_stream
86 @findex block_stream
87 Copy data from a backing file into a block device.
88 ETEXI
91 .name = "block_job_set_speed",
92 .args_type = "device:B,speed:o",
93 .params = "device speed",
94 .help = "set maximum speed for a background block operation",
95 .mhandler.cmd = hmp_block_job_set_speed,
98 STEXI
99 @item block_job_set_speed
100 @findex block_job_set_speed
101 Set maximum speed for a background block operation.
102 ETEXI
105 .name = "block_job_cancel",
106 .args_type = "force:-f,device:B",
107 .params = "[-f] device",
108 .help = "stop an active background block operation (use -f"
109 "\n\t\t\t if the operation is currently paused)",
110 .mhandler.cmd = hmp_block_job_cancel,
113 STEXI
114 @item block_job_cancel
115 @findex block_job_cancel
116 Stop an active background block operation (streaming, mirroring).
117 ETEXI
120 .name = "block_job_complete",
121 .args_type = "device:B",
122 .params = "device",
123 .help = "stop an active background block operation",
124 .mhandler.cmd = hmp_block_job_complete,
127 STEXI
128 @item block_job_complete
129 @findex block_job_complete
130 Manually trigger completion of an active background block operation.
131 For mirroring, this will switch the device to the destination path.
132 ETEXI
135 .name = "block_job_pause",
136 .args_type = "device:B",
137 .params = "device",
138 .help = "pause an active background block operation",
139 .mhandler.cmd = hmp_block_job_pause,
142 STEXI
143 @item block_job_pause
144 @findex block_job_pause
145 Pause an active block streaming operation.
146 ETEXI
149 .name = "block_job_resume",
150 .args_type = "device:B",
151 .params = "device",
152 .help = "resume a paused background block operation",
153 .mhandler.cmd = hmp_block_job_resume,
156 STEXI
157 @item block_job_resume
158 @findex block_job_resume
159 Resume a paused block streaming operation.
160 ETEXI
163 .name = "eject",
164 .args_type = "force:-f,device:B",
165 .params = "[-f] device",
166 .help = "eject a removable medium (use -f to force it)",
167 .mhandler.cmd = hmp_eject,
170 STEXI
171 @item eject [-f] @var{device}
172 @findex eject
173 Eject a removable medium (use -f to force it).
174 ETEXI
177 .name = "drive_del",
178 .args_type = "id:B",
179 .params = "device",
180 .help = "remove host block device",
181 .mhandler.cmd = hmp_drive_del,
184 STEXI
185 @item drive_del @var{device}
186 @findex drive_del
187 Remove host block device. The result is that guest generated IO is no longer
188 submitted against the host device underlying the disk. Once a drive has
189 been deleted, the QEMU Block layer returns -EIO which results in IO
190 errors in the guest for applications that are reading/writing to the device.
191 These errors are always reported to the guest, regardless of the drive's error
192 actions (drive options rerror, werror).
193 ETEXI
196 .name = "change",
197 .args_type = "device:B,target:F,arg:s?",
198 .params = "device filename [format]",
199 .help = "change a removable medium, optional format",
200 .mhandler.cmd = hmp_change,
203 STEXI
204 @item change @var{device} @var{setting}
205 @findex change
206 Change the configuration of a device.
208 @table @option
209 @item change @var{diskdevice} @var{filename} [@var{format}]
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 @item change vnc @var{display},@var{options}
219 Change the configuration of the VNC server. The valid syntax for @var{display}
220 and @var{options} are described at @ref{sec_invocation}. eg
222 @example
223 (qemu) change vnc localhost:1
224 @end example
226 @item change vnc password [@var{password}]
228 Change the password associated with the VNC server. If the new password is not
229 supplied, the monitor will prompt for it to be entered. VNC passwords are only
230 significant up to 8 letters. eg
232 @example
233 (qemu) change vnc password
234 Password: ********
235 @end example
237 @end table
238 ETEXI
241 .name = "screendump",
242 .args_type = "filename:F",
243 .params = "filename",
244 .help = "save screen into PPM image 'filename'",
245 .mhandler.cmd = hmp_screendump,
248 STEXI
249 @item screendump @var{filename}
250 @findex screendump
251 Save screen into PPM image @var{filename}.
252 ETEXI
255 .name = "logfile",
256 .args_type = "filename:F",
257 .params = "filename",
258 .help = "output logs to 'filename'",
259 .mhandler.cmd = hmp_logfile,
262 STEXI
263 @item logfile @var{filename}
264 @findex logfile
265 Output logs to @var{filename}.
266 ETEXI
269 .name = "trace-event",
270 .args_type = "name:s,option:b",
271 .params = "name on|off",
272 .help = "changes status of a specific trace event",
273 .mhandler.cmd = hmp_trace_event,
274 .command_completion = trace_event_completion,
277 STEXI
278 @item trace-event
279 @findex trace-event
280 changes status of a trace event
281 ETEXI
283 #if defined(CONFIG_TRACE_SIMPLE)
285 .name = "trace-file",
286 .args_type = "op:s?,arg:F?",
287 .params = "on|off|flush|set [arg]",
288 .help = "open, close, or flush trace file, or set a new file name",
289 .mhandler.cmd = hmp_trace_file,
292 STEXI
293 @item trace-file on|off|flush
294 @findex trace-file
295 Open, close, or flush the trace file. If no argument is given, the status of the trace file is displayed.
296 ETEXI
297 #endif
300 .name = "log",
301 .args_type = "items:s",
302 .params = "item1[,...]",
303 .help = "activate logging of the specified items",
304 .mhandler.cmd = hmp_log,
307 STEXI
308 @item log @var{item1}[,...]
309 @findex log
310 Activate logging of the specified items.
311 ETEXI
314 .name = "savevm",
315 .args_type = "name:s?",
316 .params = "[tag|id]",
317 .help = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
318 .mhandler.cmd = hmp_savevm,
321 STEXI
322 @item savevm [@var{tag}|@var{id}]
323 @findex savevm
324 Create a snapshot of the whole virtual machine. If @var{tag} is
325 provided, it is used as human readable identifier. If there is already
326 a snapshot with the same tag or ID, it is replaced. More info at
327 @ref{vm_snapshots}.
328 ETEXI
331 .name = "loadvm",
332 .args_type = "name:s",
333 .params = "tag|id",
334 .help = "restore a VM snapshot from its tag or id",
335 .mhandler.cmd = hmp_loadvm,
336 .command_completion = loadvm_completion,
339 STEXI
340 @item loadvm @var{tag}|@var{id}
341 @findex loadvm
342 Set the whole virtual machine to the snapshot identified by the tag
343 @var{tag} or the unique snapshot ID @var{id}.
344 ETEXI
347 .name = "delvm",
348 .args_type = "name:s",
349 .params = "tag|id",
350 .help = "delete a VM snapshot from its tag or id",
351 .mhandler.cmd = hmp_delvm,
352 .command_completion = delvm_completion,
355 STEXI
356 @item delvm @var{tag}|@var{id}
357 @findex delvm
358 Delete the snapshot identified by @var{tag} or @var{id}.
359 ETEXI
362 .name = "singlestep",
363 .args_type = "option:s?",
364 .params = "[on|off]",
365 .help = "run emulation in singlestep mode or switch to normal mode",
366 .mhandler.cmd = hmp_singlestep,
369 STEXI
370 @item singlestep [off]
371 @findex singlestep
372 Run the emulation in single step mode.
373 If called with option off, the emulation returns to normal mode.
374 ETEXI
377 .name = "stop",
378 .args_type = "",
379 .params = "",
380 .help = "stop emulation",
381 .mhandler.cmd = hmp_stop,
384 STEXI
385 @item stop
386 @findex stop
387 Stop emulation.
388 ETEXI
391 .name = "c|cont",
392 .args_type = "",
393 .params = "",
394 .help = "resume emulation",
395 .mhandler.cmd = hmp_cont,
398 STEXI
399 @item c or cont
400 @findex cont
401 Resume emulation.
402 ETEXI
405 .name = "system_wakeup",
406 .args_type = "",
407 .params = "",
408 .help = "wakeup guest from suspend",
409 .mhandler.cmd = hmp_system_wakeup,
412 STEXI
413 @item system_wakeup
414 @findex system_wakeup
415 Wakeup guest from suspend.
416 ETEXI
419 .name = "gdbserver",
420 .args_type = "device:s?",
421 .params = "[device]",
422 .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
423 .mhandler.cmd = hmp_gdbserver,
426 STEXI
427 @item gdbserver [@var{port}]
428 @findex gdbserver
429 Start gdbserver session (default @var{port}=1234)
430 ETEXI
433 .name = "x",
434 .args_type = "fmt:/,addr:l",
435 .params = "/fmt addr",
436 .help = "virtual memory dump starting at 'addr'",
437 .mhandler.cmd = hmp_memory_dump,
440 STEXI
441 @item x/fmt @var{addr}
442 @findex x
443 Virtual memory dump starting at @var{addr}.
444 ETEXI
447 .name = "xp",
448 .args_type = "fmt:/,addr:l",
449 .params = "/fmt addr",
450 .help = "physical memory dump starting at 'addr'",
451 .mhandler.cmd = hmp_physical_memory_dump,
454 STEXI
455 @item xp /@var{fmt} @var{addr}
456 @findex xp
457 Physical memory dump starting at @var{addr}.
459 @var{fmt} is a format which tells the command how to format the
460 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
462 @table @var
463 @item count
464 is the number of items to be dumped.
466 @item format
467 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
468 c (char) or i (asm instruction).
470 @item size
471 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
472 @code{h} or @code{w} can be specified with the @code{i} format to
473 respectively select 16 or 32 bit code instruction size.
475 @end table
477 Examples:
478 @itemize
479 @item
480 Dump 10 instructions at the current instruction pointer:
481 @example
482 (qemu) x/10i $eip
483 0x90107063: ret
484 0x90107064: sti
485 0x90107065: lea 0x0(%esi,1),%esi
486 0x90107069: lea 0x0(%edi,1),%edi
487 0x90107070: ret
488 0x90107071: jmp 0x90107080
489 0x90107073: nop
490 0x90107074: nop
491 0x90107075: nop
492 0x90107076: nop
493 @end example
495 @item
496 Dump 80 16 bit values at the start of the video memory.
497 @smallexample
498 (qemu) xp/80hx 0xb8000
499 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
500 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
501 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
502 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
503 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
504 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
505 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
506 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
507 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
508 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
509 @end smallexample
510 @end itemize
511 ETEXI
514 .name = "p|print",
515 .args_type = "fmt:/,val:l",
516 .params = "/fmt expr",
517 .help = "print expression value (use $reg for CPU register access)",
518 .mhandler.cmd = do_print,
521 STEXI
522 @item p or print/@var{fmt} @var{expr}
523 @findex print
524 Print expression value. Only the @var{format} part of @var{fmt} is
525 used.
526 ETEXI
529 .name = "i",
530 .args_type = "fmt:/,addr:i,index:i.",
531 .params = "/fmt addr",
532 .help = "I/O port read",
533 .mhandler.cmd = hmp_ioport_read,
536 STEXI
537 @item i/@var{fmt} @var{addr} [.@var{index}]
538 @findex i
539 Read I/O port.
540 ETEXI
543 .name = "o",
544 .args_type = "fmt:/,addr:i,val:i",
545 .params = "/fmt addr value",
546 .help = "I/O port write",
547 .mhandler.cmd = hmp_ioport_write,
550 STEXI
551 @item o/@var{fmt} @var{addr} @var{val}
552 @findex o
553 Write to I/O port.
554 ETEXI
557 .name = "sendkey",
558 .args_type = "keys:s,hold-time:i?",
559 .params = "keys [hold_ms]",
560 .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
561 .mhandler.cmd = hmp_sendkey,
562 .command_completion = sendkey_completion,
565 STEXI
566 @item sendkey @var{keys}
567 @findex sendkey
568 Send @var{keys} to the guest. @var{keys} could be the name of the
569 key or the raw value in hexadecimal format. Use @code{-} to press
570 several keys simultaneously. Example:
571 @example
572 sendkey ctrl-alt-f1
573 @end example
575 This command is useful to send keys that your graphical user interface
576 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
577 ETEXI
580 .name = "system_reset",
581 .args_type = "",
582 .params = "",
583 .help = "reset the system",
584 .mhandler.cmd = hmp_system_reset,
587 STEXI
588 @item system_reset
589 @findex system_reset
590 Reset the system.
591 ETEXI
594 .name = "system_powerdown",
595 .args_type = "",
596 .params = "",
597 .help = "send system power down event",
598 .mhandler.cmd = hmp_system_powerdown,
601 STEXI
602 @item system_powerdown
603 @findex system_powerdown
604 Power down the system (if supported).
605 ETEXI
608 .name = "sum",
609 .args_type = "start:i,size:i",
610 .params = "addr size",
611 .help = "compute the checksum of a memory region",
612 .mhandler.cmd = hmp_sum,
615 STEXI
616 @item sum @var{addr} @var{size}
617 @findex sum
618 Compute the checksum of a memory region.
619 ETEXI
622 .name = "usb_add",
623 .args_type = "devname:s",
624 .params = "device",
625 .help = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
626 .mhandler.cmd = hmp_usb_add,
629 STEXI
630 @item usb_add @var{devname}
631 @findex usb_add
632 Add the USB device @var{devname}. For details of available devices see
633 @ref{usb_devices}
634 ETEXI
637 .name = "usb_del",
638 .args_type = "devname:s",
639 .params = "device",
640 .help = "remove USB device 'bus.addr'",
641 .mhandler.cmd = hmp_usb_del,
644 STEXI
645 @item usb_del @var{devname}
646 @findex usb_del
647 Remove the USB device @var{devname} from the QEMU virtual USB
648 hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
649 command @code{info usb} to see the devices you can remove.
650 ETEXI
653 .name = "device_add",
654 .args_type = "device:O",
655 .params = "driver[,prop=value][,...]",
656 .help = "add device, like -device on the command line",
657 .mhandler.cmd = hmp_device_add,
658 .command_completion = device_add_completion,
661 STEXI
662 @item device_add @var{config}
663 @findex device_add
664 Add device.
665 ETEXI
668 .name = "device_del",
669 .args_type = "id:s",
670 .params = "device",
671 .help = "remove device",
672 .mhandler.cmd = hmp_device_del,
673 .command_completion = device_del_completion,
676 STEXI
677 @item device_del @var{id}
678 @findex device_del
679 Remove device @var{id}. @var{id} may be a short ID
680 or a QOM object path.
681 ETEXI
684 .name = "cpu",
685 .args_type = "index:i",
686 .params = "index",
687 .help = "set the default CPU",
688 .mhandler.cmd = hmp_cpu,
691 STEXI
692 @item cpu @var{index}
693 @findex cpu
694 Set the default CPU.
695 ETEXI
698 .name = "mouse_move",
699 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
700 .params = "dx dy [dz]",
701 .help = "send mouse move events",
702 .mhandler.cmd = hmp_mouse_move,
705 STEXI
706 @item mouse_move @var{dx} @var{dy} [@var{dz}]
707 @findex mouse_move
708 Move the active mouse to the specified coordinates @var{dx} @var{dy}
709 with optional scroll axis @var{dz}.
710 ETEXI
713 .name = "mouse_button",
714 .args_type = "button_state:i",
715 .params = "state",
716 .help = "change mouse button state (1=L, 2=M, 4=R)",
717 .mhandler.cmd = hmp_mouse_button,
720 STEXI
721 @item mouse_button @var{val}
722 @findex mouse_button
723 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
724 ETEXI
727 .name = "mouse_set",
728 .args_type = "index:i",
729 .params = "index",
730 .help = "set which mouse device receives events",
731 .mhandler.cmd = hmp_mouse_set,
734 STEXI
735 @item mouse_set @var{index}
736 @findex mouse_set
737 Set which mouse device receives events at given @var{index}, index
738 can be obtained with
739 @example
740 info mice
741 @end example
742 ETEXI
745 .name = "wavcapture",
746 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
747 .params = "path [frequency [bits [channels]]]",
748 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
749 .mhandler.cmd = hmp_wavcapture,
751 STEXI
752 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
753 @findex wavcapture
754 Capture audio into @var{filename}. Using sample rate @var{frequency}
755 bits per sample @var{bits} and number of channels @var{channels}.
757 Defaults:
758 @itemize @minus
759 @item Sample rate = 44100 Hz - CD quality
760 @item Bits = 16
761 @item Number of channels = 2 - Stereo
762 @end itemize
763 ETEXI
766 .name = "stopcapture",
767 .args_type = "n:i",
768 .params = "capture index",
769 .help = "stop capture",
770 .mhandler.cmd = hmp_stopcapture,
772 STEXI
773 @item stopcapture @var{index}
774 @findex stopcapture
775 Stop capture with a given @var{index}, index can be obtained with
776 @example
777 info capture
778 @end example
779 ETEXI
782 .name = "memsave",
783 .args_type = "val:l,size:i,filename:s",
784 .params = "addr size file",
785 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
786 .mhandler.cmd = hmp_memsave,
789 STEXI
790 @item memsave @var{addr} @var{size} @var{file}
791 @findex memsave
792 save to disk virtual memory dump starting at @var{addr} of size @var{size}.
793 ETEXI
796 .name = "pmemsave",
797 .args_type = "val:l,size:i,filename:s",
798 .params = "addr size file",
799 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
800 .mhandler.cmd = hmp_pmemsave,
803 STEXI
804 @item pmemsave @var{addr} @var{size} @var{file}
805 @findex pmemsave
806 save to disk physical memory dump starting at @var{addr} of size @var{size}.
807 ETEXI
810 .name = "boot_set",
811 .args_type = "bootdevice:s",
812 .params = "bootdevice",
813 .help = "define new values for the boot device list",
814 .mhandler.cmd = hmp_boot_set,
817 STEXI
818 @item boot_set @var{bootdevicelist}
819 @findex boot_set
820 Define new values for the boot device list. Those values will override
821 the values specified on the command line through the @code{-boot} option.
823 The values that can be specified here depend on the machine type, but are
824 the same that can be specified in the @code{-boot} command line option.
825 ETEXI
828 .name = "nmi",
829 .args_type = "",
830 .params = "",
831 .help = "inject an NMI",
832 .mhandler.cmd = hmp_nmi,
834 STEXI
835 @item nmi @var{cpu}
836 @findex nmi
837 Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
839 ETEXI
842 .name = "ringbuf_write",
843 .args_type = "device:s,data:s",
844 .params = "device data",
845 .help = "Write to a ring buffer character device",
846 .mhandler.cmd = hmp_ringbuf_write,
847 .command_completion = ringbuf_write_completion,
850 STEXI
851 @item ringbuf_write @var{device} @var{data}
852 @findex ringbuf_write
853 Write @var{data} to ring buffer character device @var{device}.
854 @var{data} must be a UTF-8 string.
856 ETEXI
859 .name = "ringbuf_read",
860 .args_type = "device:s,size:i",
861 .params = "device size",
862 .help = "Read from a ring buffer character device",
863 .mhandler.cmd = hmp_ringbuf_read,
864 .command_completion = ringbuf_write_completion,
867 STEXI
868 @item ringbuf_read @var{device}
869 @findex ringbuf_read
870 Read and print up to @var{size} bytes from ring buffer character
871 device @var{device}.
872 Certain non-printable characters are printed \uXXXX, where XXXX is the
873 character code in hexadecimal. Character \ is printed \\.
874 Bug: can screw up when the buffer contains invalid UTF-8 sequences,
875 NUL characters, after the ring buffer lost data, and when reading
876 stops because the size limit is reached.
878 ETEXI
881 .name = "migrate",
882 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
883 .params = "[-d] [-b] [-i] uri",
884 .help = "migrate to URI (using -d to not wait for completion)"
885 "\n\t\t\t -b for migration without shared storage with"
886 " full copy of disk\n\t\t\t -i for migration without "
887 "shared storage with incremental copy of disk "
888 "(base image shared between src and destination)",
889 .mhandler.cmd = hmp_migrate,
893 STEXI
894 @item migrate [-d] [-b] [-i] @var{uri}
895 @findex migrate
896 Migrate to @var{uri} (using -d to not wait for completion).
897 -b for migration with full copy of disk
898 -i for migration with incremental copy of disk (base image is shared)
899 ETEXI
902 .name = "migrate_cancel",
903 .args_type = "",
904 .params = "",
905 .help = "cancel the current VM migration",
906 .mhandler.cmd = hmp_migrate_cancel,
909 STEXI
910 @item migrate_cancel
911 @findex migrate_cancel
912 Cancel the current VM migration.
914 ETEXI
917 .name = "migrate_incoming",
918 .args_type = "uri:s",
919 .params = "uri",
920 .help = "Continue an incoming migration from an -incoming defer",
921 .mhandler.cmd = hmp_migrate_incoming,
924 STEXI
925 @item migrate_incoming @var{uri}
926 @findex migrate_incoming
927 Continue an incoming migration using the @var{uri} (that has the same syntax
928 as the -incoming option).
930 ETEXI
933 .name = "migrate_set_cache_size",
934 .args_type = "value:o",
935 .params = "value",
936 .help = "set cache size (in bytes) for XBZRLE migrations,"
937 "the cache size will be rounded down to the nearest "
938 "power of 2.\n"
939 "The cache size affects the number of cache misses."
940 "In case of a high cache miss ratio you need to increase"
941 " the cache size",
942 .mhandler.cmd = hmp_migrate_set_cache_size,
945 STEXI
946 @item migrate_set_cache_size @var{value}
947 @findex migrate_set_cache_size
948 Set cache size to @var{value} (in bytes) for xbzrle migrations.
949 ETEXI
952 .name = "migrate_set_speed",
953 .args_type = "value:o",
954 .params = "value",
955 .help = "set maximum speed (in bytes) for migrations. "
956 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
957 .mhandler.cmd = hmp_migrate_set_speed,
960 STEXI
961 @item migrate_set_speed @var{value}
962 @findex migrate_set_speed
963 Set maximum speed to @var{value} (in bytes) for migrations.
964 ETEXI
967 .name = "migrate_set_downtime",
968 .args_type = "value:T",
969 .params = "value",
970 .help = "set maximum tolerated downtime (in seconds) for migrations",
971 .mhandler.cmd = hmp_migrate_set_downtime,
974 STEXI
975 @item migrate_set_downtime @var{second}
976 @findex migrate_set_downtime
977 Set maximum tolerated downtime (in seconds) for migration.
978 ETEXI
981 .name = "migrate_set_capability",
982 .args_type = "capability:s,state:b",
983 .params = "capability state",
984 .help = "Enable/Disable the usage of a capability for migration",
985 .mhandler.cmd = hmp_migrate_set_capability,
986 .command_completion = migrate_set_capability_completion,
989 STEXI
990 @item migrate_set_capability @var{capability} @var{state}
991 @findex migrate_set_capability
992 Enable/Disable the usage of a capability @var{capability} for migration.
993 ETEXI
996 .name = "migrate_set_parameter",
997 .args_type = "parameter:s,value:i",
998 .params = "parameter value",
999 .help = "Set the parameter for migration",
1000 .mhandler.cmd = hmp_migrate_set_parameter,
1001 .command_completion = migrate_set_parameter_completion,
1004 STEXI
1005 @item migrate_set_parameter @var{parameter} @var{value}
1006 @findex migrate_set_parameter
1007 Set the parameter @var{parameter} for migration.
1008 ETEXI
1011 .name = "client_migrate_info",
1012 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1013 .params = "protocol hostname port tls-port cert-subject",
1014 .help = "set migration information for remote display",
1015 .mhandler.cmd = hmp_client_migrate_info,
1018 STEXI
1019 @item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
1020 @findex client_migrate_info
1021 Set migration information for remote display. This makes the server
1022 ask the client to automatically reconnect using the new parameters
1023 once migration finished successfully. Only implemented for SPICE.
1024 ETEXI
1027 .name = "dump-guest-memory",
1028 .args_type = "paging:-p,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:i?,length:i?",
1029 .params = "[-p] [-z|-l|-s] filename [begin length]",
1030 .help = "dump guest memory into file 'filename'.\n\t\t\t"
1031 "-p: do paging to get guest's memory mapping.\n\t\t\t"
1032 "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1033 "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1034 "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
1035 "begin: the starting physical address.\n\t\t\t"
1036 "length: the memory size, in bytes.",
1037 .mhandler.cmd = hmp_dump_guest_memory,
1041 STEXI
1042 @item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
1043 @item dump-guest-memory [-z|-l|-s] @var{filename}
1044 @findex dump-guest-memory
1045 Dump guest memory to @var{protocol}. The file can be processed with crash or
1046 gdb. Without -z|-l|-s, the dump format is ELF.
1047 -p: do paging to get guest's memory mapping.
1048 -z: dump in kdump-compressed format, with zlib compression.
1049 -l: dump in kdump-compressed format, with lzo compression.
1050 -s: dump in kdump-compressed format, with snappy compression.
1051 filename: dump file name.
1052 begin: the starting physical address. It's optional, and should be
1053 specified together with length.
1054 length: the memory size, in bytes. It's optional, and should be specified
1055 together with begin.
1056 ETEXI
1058 #if defined(TARGET_S390X)
1060 .name = "dump-skeys",
1061 .args_type = "filename:F",
1062 .params = "",
1063 .help = "Save guest storage keys into file 'filename'.\n",
1064 .mhandler.cmd = hmp_dump_skeys,
1066 #endif
1068 STEXI
1069 @item dump-skeys @var{filename}
1070 @findex dump-skeys
1071 Save guest storage keys to a file.
1072 ETEXI
1075 .name = "snapshot_blkdev",
1076 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1077 .params = "[-n] device [new-image-file] [format]",
1078 .help = "initiates a live snapshot\n\t\t\t"
1079 "of device. If a new image file is specified, the\n\t\t\t"
1080 "new image file will become the new root image.\n\t\t\t"
1081 "If format is specified, the snapshot file will\n\t\t\t"
1082 "be created in that format.\n\t\t\t"
1083 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1084 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1085 "recreating it from scratch.",
1086 .mhandler.cmd = hmp_snapshot_blkdev,
1089 STEXI
1090 @item snapshot_blkdev
1091 @findex snapshot_blkdev
1092 Snapshot device, using snapshot file as target if provided
1093 ETEXI
1096 .name = "snapshot_blkdev_internal",
1097 .args_type = "device:B,name:s",
1098 .params = "device name",
1099 .help = "take an internal snapshot of device.\n\t\t\t"
1100 "The format of the image used by device must\n\t\t\t"
1101 "support it, such as qcow2.\n\t\t\t",
1102 .mhandler.cmd = hmp_snapshot_blkdev_internal,
1105 STEXI
1106 @item snapshot_blkdev_internal
1107 @findex snapshot_blkdev_internal
1108 Take an internal snapshot on device if it support
1109 ETEXI
1112 .name = "snapshot_delete_blkdev_internal",
1113 .args_type = "device:B,name:s,id:s?",
1114 .params = "device name [id]",
1115 .help = "delete an internal snapshot of device.\n\t\t\t"
1116 "If id is specified, qemu will try delete\n\t\t\t"
1117 "the snapshot matching both id and name.\n\t\t\t"
1118 "The format of the image used by device must\n\t\t\t"
1119 "support it, such as qcow2.\n\t\t\t",
1120 .mhandler.cmd = hmp_snapshot_delete_blkdev_internal,
1123 STEXI
1124 @item snapshot_delete_blkdev_internal
1125 @findex snapshot_delete_blkdev_internal
1126 Delete an internal snapshot on device if it support
1127 ETEXI
1130 .name = "drive_mirror",
1131 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1132 .params = "[-n] [-f] device target [format]",
1133 .help = "initiates live storage\n\t\t\t"
1134 "migration for a device. The device's contents are\n\t\t\t"
1135 "copied to the new image file, including data that\n\t\t\t"
1136 "is written after the command is started.\n\t\t\t"
1137 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1138 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1139 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1140 "so that the result does not need a backing file.\n\t\t\t",
1141 .mhandler.cmd = hmp_drive_mirror,
1143 STEXI
1144 @item drive_mirror
1145 @findex drive_mirror
1146 Start mirroring a block device's writes to a new destination,
1147 using the specified target.
1148 ETEXI
1151 .name = "drive_backup",
1152 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1153 .params = "[-n] [-f] device target [format]",
1154 .help = "initiates a point-in-time\n\t\t\t"
1155 "copy for a device. The device's contents are\n\t\t\t"
1156 "copied to the new image file, excluding data that\n\t\t\t"
1157 "is written after the command is started.\n\t\t\t"
1158 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1159 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1160 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1161 "so that the result does not need a backing file.\n\t\t\t",
1162 .mhandler.cmd = hmp_drive_backup,
1164 STEXI
1165 @item drive_backup
1166 @findex drive_backup
1167 Start a point-in-time copy of a block device to a specificed target.
1168 ETEXI
1171 .name = "drive_add",
1172 .args_type = "pci_addr:s,opts:s",
1173 .params = "[[<domain>:]<bus>:]<slot>\n"
1174 "[file=file][,if=type][,bus=n]\n"
1175 "[,unit=m][,media=d][,index=i]\n"
1176 "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
1177 "[,snapshot=on|off][,cache=on|off]\n"
1178 "[,readonly=on|off][,copy-on-read=on|off]",
1179 .help = "add drive to PCI storage controller",
1180 .mhandler.cmd = hmp_drive_add,
1183 STEXI
1184 @item drive_add
1185 @findex drive_add
1186 Add drive to PCI storage controller.
1187 ETEXI
1190 .name = "pcie_aer_inject_error",
1191 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1192 "id:s,error_status:s,"
1193 "header0:i?,header1:i?,header2:i?,header3:i?,"
1194 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1195 .params = "[-a] [-c] id "
1196 "<error_status> [<tlp header> [<tlp header prefix>]]",
1197 .help = "inject pcie aer error\n\t\t\t"
1198 " -a for advisory non fatal error\n\t\t\t"
1199 " -c for correctable error\n\t\t\t"
1200 "<id> = qdev device id\n\t\t\t"
1201 "<error_status> = error string or 32bit\n\t\t\t"
1202 "<tlb header> = 32bit x 4\n\t\t\t"
1203 "<tlb header prefix> = 32bit x 4",
1204 .mhandler.cmd = hmp_pcie_aer_inject_error,
1207 STEXI
1208 @item pcie_aer_inject_error
1209 @findex pcie_aer_inject_error
1210 Inject PCIe AER error
1211 ETEXI
1214 .name = "host_net_add",
1215 .args_type = "device:s,opts:s?",
1216 .params = "tap|user|socket|vde|netmap|bridge|vhost-user|dump [options]",
1217 .help = "add host VLAN client",
1218 .mhandler.cmd = hmp_host_net_add,
1219 .command_completion = host_net_add_completion,
1222 STEXI
1223 @item host_net_add
1224 @findex host_net_add
1225 Add host VLAN client.
1226 ETEXI
1229 .name = "host_net_remove",
1230 .args_type = "vlan_id:i,device:s",
1231 .params = "vlan_id name",
1232 .help = "remove host VLAN client",
1233 .mhandler.cmd = hmp_host_net_remove,
1234 .command_completion = host_net_remove_completion,
1237 STEXI
1238 @item host_net_remove
1239 @findex host_net_remove
1240 Remove host VLAN client.
1241 ETEXI
1244 .name = "netdev_add",
1245 .args_type = "netdev:O",
1246 .params = "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
1247 .help = "add host network device",
1248 .mhandler.cmd = hmp_netdev_add,
1249 .command_completion = netdev_add_completion,
1252 STEXI
1253 @item netdev_add
1254 @findex netdev_add
1255 Add host network device.
1256 ETEXI
1259 .name = "netdev_del",
1260 .args_type = "id:s",
1261 .params = "id",
1262 .help = "remove host network device",
1263 .mhandler.cmd = hmp_netdev_del,
1264 .command_completion = netdev_del_completion,
1267 STEXI
1268 @item netdev_del
1269 @findex netdev_del
1270 Remove host network device.
1271 ETEXI
1274 .name = "object_add",
1275 .args_type = "object:O",
1276 .params = "[qom-type=]type,id=str[,prop=value][,...]",
1277 .help = "create QOM object",
1278 .mhandler.cmd = hmp_object_add,
1279 .command_completion = object_add_completion,
1282 STEXI
1283 @item object_add
1284 @findex object_add
1285 Create QOM object.
1286 ETEXI
1289 .name = "object_del",
1290 .args_type = "id:s",
1291 .params = "id",
1292 .help = "destroy QOM object",
1293 .mhandler.cmd = hmp_object_del,
1294 .command_completion = object_del_completion,
1297 STEXI
1298 @item object_del
1299 @findex object_del
1300 Destroy QOM object.
1301 ETEXI
1303 #ifdef CONFIG_SLIRP
1305 .name = "hostfwd_add",
1306 .args_type = "arg1:s,arg2:s?,arg3:s?",
1307 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1308 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
1309 .mhandler.cmd = hmp_hostfwd_add,
1311 #endif
1312 STEXI
1313 @item hostfwd_add
1314 @findex hostfwd_add
1315 Redirect TCP or UDP connections from host to guest (requires -net user).
1316 ETEXI
1318 #ifdef CONFIG_SLIRP
1320 .name = "hostfwd_remove",
1321 .args_type = "arg1:s,arg2:s?,arg3:s?",
1322 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1323 .help = "remove host-to-guest TCP or UDP redirection",
1324 .mhandler.cmd = hmp_hostfwd_remove,
1327 #endif
1328 STEXI
1329 @item hostfwd_remove
1330 @findex hostfwd_remove
1331 Remove host-to-guest TCP or UDP redirection.
1332 ETEXI
1335 .name = "balloon",
1336 .args_type = "value:M",
1337 .params = "target",
1338 .help = "request VM to change its memory allocation (in MB)",
1339 .mhandler.cmd = hmp_balloon,
1342 STEXI
1343 @item balloon @var{value}
1344 @findex balloon
1345 Request VM to change its memory allocation to @var{value} (in MB).
1346 ETEXI
1349 .name = "set_link",
1350 .args_type = "name:s,up:b",
1351 .params = "name on|off",
1352 .help = "change the link status of a network adapter",
1353 .mhandler.cmd = hmp_set_link,
1354 .command_completion = set_link_completion,
1357 STEXI
1358 @item set_link @var{name} [on|off]
1359 @findex set_link
1360 Switch link @var{name} on (i.e. up) or off (i.e. down).
1361 ETEXI
1364 .name = "watchdog_action",
1365 .args_type = "action:s",
1366 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1367 .help = "change watchdog action",
1368 .mhandler.cmd = hmp_watchdog_action,
1369 .command_completion = watchdog_action_completion,
1372 STEXI
1373 @item watchdog_action
1374 @findex watchdog_action
1375 Change watchdog action.
1376 ETEXI
1379 .name = "acl_show",
1380 .args_type = "aclname:s",
1381 .params = "aclname",
1382 .help = "list rules in the access control list",
1383 .mhandler.cmd = hmp_acl_show,
1386 STEXI
1387 @item acl_show @var{aclname}
1388 @findex acl_show
1389 List all the matching rules in the access control list, and the default
1390 policy. There are currently two named access control lists,
1391 @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1392 certificate distinguished name, and SASL username respectively.
1393 ETEXI
1396 .name = "acl_policy",
1397 .args_type = "aclname:s,policy:s",
1398 .params = "aclname allow|deny",
1399 .help = "set default access control list policy",
1400 .mhandler.cmd = hmp_acl_policy,
1403 STEXI
1404 @item acl_policy @var{aclname} @code{allow|deny}
1405 @findex acl_policy
1406 Set the default access control list policy, used in the event that
1407 none of the explicit rules match. The default policy at startup is
1408 always @code{deny}.
1409 ETEXI
1412 .name = "acl_add",
1413 .args_type = "aclname:s,match:s,policy:s,index:i?",
1414 .params = "aclname match allow|deny [index]",
1415 .help = "add a match rule to the access control list",
1416 .mhandler.cmd = hmp_acl_add,
1419 STEXI
1420 @item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1421 @findex acl_add
1422 Add a match rule to the access control list, allowing or denying access.
1423 The match will normally be an exact username or x509 distinguished name,
1424 but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1425 allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
1426 normally be appended to the end of the ACL, but can be inserted
1427 earlier in the list if the optional @var{index} parameter is supplied.
1428 ETEXI
1431 .name = "acl_remove",
1432 .args_type = "aclname:s,match:s",
1433 .params = "aclname match",
1434 .help = "remove a match rule from the access control list",
1435 .mhandler.cmd = hmp_acl_remove,
1438 STEXI
1439 @item acl_remove @var{aclname} @var{match}
1440 @findex acl_remove
1441 Remove the specified match rule from the access control list.
1442 ETEXI
1445 .name = "acl_reset",
1446 .args_type = "aclname:s",
1447 .params = "aclname",
1448 .help = "reset the access control list",
1449 .mhandler.cmd = hmp_acl_reset,
1452 STEXI
1453 @item acl_reset @var{aclname}
1454 @findex acl_reset
1455 Remove all matches from the access control list, and set the default
1456 policy back to @code{deny}.
1457 ETEXI
1460 .name = "nbd_server_start",
1461 .args_type = "all:-a,writable:-w,uri:s",
1462 .params = "nbd_server_start [-a] [-w] host:port",
1463 .help = "serve block devices on the given host and port",
1464 .mhandler.cmd = hmp_nbd_server_start,
1466 STEXI
1467 @item nbd_server_start @var{host}:@var{port}
1468 @findex nbd_server_start
1469 Start an NBD server on the given host and/or port. If the @option{-a}
1470 option is included, all of the virtual machine's block devices that
1471 have an inserted media on them are automatically exported; in this case,
1472 the @option{-w} option makes the devices writable too.
1473 ETEXI
1476 .name = "nbd_server_add",
1477 .args_type = "writable:-w,device:B",
1478 .params = "nbd_server_add [-w] device",
1479 .help = "export a block device via NBD",
1480 .mhandler.cmd = hmp_nbd_server_add,
1482 STEXI
1483 @item nbd_server_add @var{device}
1484 @findex nbd_server_add
1485 Export a block device through QEMU's NBD server, which must be started
1486 beforehand with @command{nbd_server_start}. The @option{-w} option makes the
1487 exported device writable too.
1488 ETEXI
1491 .name = "nbd_server_stop",
1492 .args_type = "",
1493 .params = "nbd_server_stop",
1494 .help = "stop serving block devices using the NBD protocol",
1495 .mhandler.cmd = hmp_nbd_server_stop,
1497 STEXI
1498 @item nbd_server_stop
1499 @findex nbd_server_stop
1500 Stop the QEMU embedded NBD server.
1501 ETEXI
1504 #if defined(TARGET_I386)
1507 .name = "mce",
1508 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1509 .params = "[-b] cpu bank status mcgstatus addr misc",
1510 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1511 .mhandler.cmd = hmp_mce,
1514 #endif
1515 STEXI
1516 @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1517 @findex mce (x86)
1518 Inject an MCE on the given CPU (x86 only).
1519 ETEXI
1522 .name = "getfd",
1523 .args_type = "fdname:s",
1524 .params = "getfd name",
1525 .help = "receive a file descriptor via SCM rights and assign it a name",
1526 .mhandler.cmd = hmp_getfd,
1529 STEXI
1530 @item getfd @var{fdname}
1531 @findex getfd
1532 If a file descriptor is passed alongside this command using the SCM_RIGHTS
1533 mechanism on unix sockets, it is stored using the name @var{fdname} for
1534 later use by other monitor commands.
1535 ETEXI
1538 .name = "closefd",
1539 .args_type = "fdname:s",
1540 .params = "closefd name",
1541 .help = "close a file descriptor previously passed via SCM rights",
1542 .mhandler.cmd = hmp_closefd,
1545 STEXI
1546 @item closefd @var{fdname}
1547 @findex closefd
1548 Close the file descriptor previously assigned to @var{fdname} using the
1549 @code{getfd} command. This is only needed if the file descriptor was never
1550 used by another monitor command.
1551 ETEXI
1554 .name = "block_passwd",
1555 .args_type = "device:B,password:s",
1556 .params = "block_passwd device password",
1557 .help = "set the password of encrypted block devices",
1558 .mhandler.cmd = hmp_block_passwd,
1561 STEXI
1562 @item block_passwd @var{device} @var{password}
1563 @findex block_passwd
1564 Set the encrypted device @var{device} password to @var{password}
1565 ETEXI
1568 .name = "block_set_io_throttle",
1569 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1570 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1571 .help = "change I/O throttle limits for a block drive",
1572 .mhandler.cmd = hmp_block_set_io_throttle,
1575 STEXI
1576 @item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1577 @findex block_set_io_throttle
1578 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}
1579 ETEXI
1582 .name = "set_password",
1583 .args_type = "protocol:s,password:s,connected:s?",
1584 .params = "protocol password action-if-connected",
1585 .help = "set spice/vnc password",
1586 .mhandler.cmd = hmp_set_password,
1589 STEXI
1590 @item set_password [ vnc | spice ] password [ action-if-connected ]
1591 @findex set_password
1592 Change spice/vnc password. Use zero to make the password stay valid
1593 forever. @var{action-if-connected} specifies what should happen in
1594 case a connection is established: @var{fail} makes the password change
1595 fail. @var{disconnect} changes the password and disconnects the
1596 client. @var{keep} changes the password and keeps the connection up.
1597 @var{keep} is the default.
1598 ETEXI
1601 .name = "expire_password",
1602 .args_type = "protocol:s,time:s",
1603 .params = "protocol time",
1604 .help = "set spice/vnc password expire-time",
1605 .mhandler.cmd = hmp_expire_password,
1608 STEXI
1609 @item expire_password [ vnc | spice ] expire-time
1610 @findex expire_password
1611 Specify when a password for spice/vnc becomes
1612 invalid. @var{expire-time} accepts:
1614 @table @var
1615 @item now
1616 Invalidate password instantly.
1618 @item never
1619 Password stays valid forever.
1621 @item +nsec
1622 Password stays valid for @var{nsec} seconds starting now.
1624 @item nsec
1625 Password is invalidated at the given time. @var{nsec} are the seconds
1626 passed since 1970, i.e. unix epoch.
1628 @end table
1629 ETEXI
1632 .name = "chardev-add",
1633 .args_type = "args:s",
1634 .params = "args",
1635 .help = "add chardev",
1636 .mhandler.cmd = hmp_chardev_add,
1637 .command_completion = chardev_add_completion,
1640 STEXI
1641 @item chardev-add args
1642 @findex chardev-add
1643 chardev_add accepts the same parameters as the -chardev command line switch.
1645 ETEXI
1648 .name = "chardev-remove",
1649 .args_type = "id:s",
1650 .params = "id",
1651 .help = "remove chardev",
1652 .mhandler.cmd = hmp_chardev_remove,
1653 .command_completion = chardev_remove_completion,
1656 STEXI
1657 @item chardev-remove id
1658 @findex chardev-remove
1659 Removes the chardev @var{id}.
1661 ETEXI
1664 .name = "qemu-io",
1665 .args_type = "device:B,command:s",
1666 .params = "[device] \"[command]\"",
1667 .help = "run a qemu-io command on a block device",
1668 .mhandler.cmd = hmp_qemu_io,
1671 STEXI
1672 @item qemu-io @var{device} @var{command}
1673 @findex qemu-io
1674 Executes a qemu-io command on the given block device.
1676 ETEXI
1679 .name = "cpu-add",
1680 .args_type = "id:i",
1681 .params = "id",
1682 .help = "add cpu",
1683 .mhandler.cmd = hmp_cpu_add,
1686 STEXI
1687 @item cpu-add @var{id}
1688 @findex cpu-add
1689 Add CPU with id @var{id}
1690 ETEXI
1693 .name = "qom-list",
1694 .args_type = "path:s?",
1695 .params = "path",
1696 .help = "list QOM properties",
1697 .mhandler.cmd = hmp_qom_list,
1700 STEXI
1701 @item qom-list [@var{path}]
1702 Print QOM properties of object at location @var{path}
1703 ETEXI
1706 .name = "qom-set",
1707 .args_type = "path:s,property:s,value:s",
1708 .params = "path property value",
1709 .help = "set QOM property",
1710 .mhandler.cmd = hmp_qom_set,
1713 STEXI
1714 @item qom-set @var{path} @var{property} @var{value}
1715 Set QOM property @var{property} of object at location @var{path} to value @var{value}
1716 ETEXI
1719 .name = "info",
1720 .args_type = "item:s?",
1721 .params = "[subcommand]",
1722 .help = "show various information about the system state",
1723 .mhandler.cmd = hmp_info_help,
1724 .sub_table = info_cmds,
1727 STEXI
1728 @end table
1729 ETEXI