target/arm: Set VFP-related MVFR0 fields for arm926 and arm1026
[qemu/ar7.git] / hmp-commands.hx
blobbfa5681dd2579c120d656982871c4439afd49400
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,
18 .flags = "p",
21 STEXI
22 @item help or ? [@var{cmd}]
23 @findex help
24 Show the help for all commands or just for command @var{cmd}.
25 ETEXI
28 .name = "commit",
29 .args_type = "device:B",
30 .params = "device|all",
31 .help = "commit changes to the disk images (if -snapshot is used) or backing files",
32 .cmd = hmp_commit,
35 STEXI
36 @item commit
37 @findex commit
38 Commit changes to the disk images (if -snapshot is used) or backing files.
39 If the backing file is smaller than the snapshot, then the backing file will be
40 resized to be the same size as the snapshot. If the snapshot is smaller than
41 the backing file, the backing file will not be truncated. If you want the
42 backing file to match the size of the smaller snapshot, you can safely truncate
43 it yourself once the commit operation successfully completes.
44 ETEXI
47 .name = "q|quit",
48 .args_type = "",
49 .params = "",
50 .help = "quit the emulator",
51 .cmd = hmp_quit,
54 STEXI
55 @item q or quit
56 @findex quit
57 Quit the emulator.
58 ETEXI
61 .name = "exit_preconfig",
62 .args_type = "",
63 .params = "",
64 .help = "exit the preconfig state",
65 .cmd = hmp_exit_preconfig,
66 .flags = "p",
69 STEXI
70 @item exit_preconfig
71 @findex exit_preconfig
72 This command makes QEMU exit the preconfig state and proceed with
73 VM initialization using configuration data provided on the command line
74 and via the QMP monitor during the preconfig state. The command is only
75 available during the preconfig state (i.e. when the --preconfig command
76 line option was in use).
77 ETEXI
80 .name = "block_resize",
81 .args_type = "device:B,size:o",
82 .params = "device size",
83 .help = "resize a block image",
84 .cmd = hmp_block_resize,
87 STEXI
88 @item block_resize
89 @findex block_resize
90 Resize a block image while a guest is running. Usually requires guest
91 action to see the updated size. Resize to a lower size is supported,
92 but should be used with extreme caution. Note that this command only
93 resizes image files, it can not resize block devices like LVM volumes.
94 ETEXI
97 .name = "block_stream",
98 .args_type = "device:B,speed:o?,base:s?",
99 .params = "device [speed [base]]",
100 .help = "copy data from a backing file into a block device",
101 .cmd = hmp_block_stream,
104 STEXI
105 @item block_stream
106 @findex block_stream
107 Copy data from a backing file into a block device.
108 ETEXI
111 .name = "block_job_set_speed",
112 .args_type = "device:B,speed:o",
113 .params = "device speed",
114 .help = "set maximum speed for a background block operation",
115 .cmd = hmp_block_job_set_speed,
118 STEXI
119 @item block_job_set_speed
120 @findex block_job_set_speed
121 Set maximum speed for a background block operation.
122 ETEXI
125 .name = "block_job_cancel",
126 .args_type = "force:-f,device:B",
127 .params = "[-f] device",
128 .help = "stop an active background block operation (use -f"
129 "\n\t\t\t if you want to abort the operation immediately"
130 "\n\t\t\t instead of keep running until data is in sync)",
131 .cmd = hmp_block_job_cancel,
134 STEXI
135 @item block_job_cancel
136 @findex block_job_cancel
137 Stop an active background block operation (streaming, mirroring).
138 ETEXI
141 .name = "block_job_complete",
142 .args_type = "device:B",
143 .params = "device",
144 .help = "stop an active background block operation",
145 .cmd = hmp_block_job_complete,
148 STEXI
149 @item block_job_complete
150 @findex block_job_complete
151 Manually trigger completion of an active background block operation.
152 For mirroring, this will switch the device to the destination path.
153 ETEXI
156 .name = "block_job_pause",
157 .args_type = "device:B",
158 .params = "device",
159 .help = "pause an active background block operation",
160 .cmd = hmp_block_job_pause,
163 STEXI
164 @item block_job_pause
165 @findex block_job_pause
166 Pause an active block streaming operation.
167 ETEXI
170 .name = "block_job_resume",
171 .args_type = "device:B",
172 .params = "device",
173 .help = "resume a paused background block operation",
174 .cmd = hmp_block_job_resume,
177 STEXI
178 @item block_job_resume
179 @findex block_job_resume
180 Resume a paused block streaming operation.
181 ETEXI
184 .name = "eject",
185 .args_type = "force:-f,device:B",
186 .params = "[-f] device",
187 .help = "eject a removable medium (use -f to force it)",
188 .cmd = hmp_eject,
191 STEXI
192 @item eject [-f] @var{device}
193 @findex eject
194 Eject a removable medium (use -f to force it).
195 ETEXI
198 .name = "drive_del",
199 .args_type = "id:B",
200 .params = "device",
201 .help = "remove host block device",
202 .cmd = hmp_drive_del,
205 STEXI
206 @item drive_del @var{device}
207 @findex drive_del
208 Remove host block device. The result is that guest generated IO is no longer
209 submitted against the host device underlying the disk. Once a drive has
210 been deleted, the QEMU Block layer returns -EIO which results in IO
211 errors in the guest for applications that are reading/writing to the device.
212 These errors are always reported to the guest, regardless of the drive's error
213 actions (drive options rerror, werror).
214 ETEXI
217 .name = "change",
218 .args_type = "device:B,target:F,arg:s?,read-only-mode:s?",
219 .params = "device filename [format [read-only-mode]]",
220 .help = "change a removable medium, optional format",
221 .cmd = hmp_change,
224 STEXI
225 @item change @var{device} @var{setting}
226 @findex change
227 Change the configuration of a device.
229 @table @option
230 @item change @var{diskdevice} @var{filename} [@var{format} [@var{read-only-mode}]]
231 Change the medium for a removable disk device to point to @var{filename}. eg
233 @example
234 (qemu) change ide1-cd0 /path/to/some.iso
235 @end example
237 @var{format} is optional.
239 @var{read-only-mode} may be used to change the read-only status of the device.
240 It accepts the following values:
242 @table @var
243 @item retain
244 Retains the current status; this is the default.
246 @item read-only
247 Makes the device read-only.
249 @item read-write
250 Makes the device writable.
251 @end table
253 @item change vnc @var{display},@var{options}
254 Change the configuration of the VNC server. The valid syntax for @var{display}
255 and @var{options} are described at @ref{sec_invocation}. eg
257 @example
258 (qemu) change vnc localhost:1
259 @end example
261 @item change vnc password [@var{password}]
263 Change the password associated with the VNC server. If the new password is not
264 supplied, the monitor will prompt for it to be entered. VNC passwords are only
265 significant up to 8 letters. eg
267 @example
268 (qemu) change vnc password
269 Password: ********
270 @end example
272 @end table
273 ETEXI
276 .name = "screendump",
277 .args_type = "filename:F,device:s?,head:i?",
278 .params = "filename [device [head]]",
279 .help = "save screen from head 'head' of display device 'device' "
280 "into PPM image 'filename'",
281 .cmd = hmp_screendump,
284 STEXI
285 @item screendump @var{filename}
286 @findex screendump
287 Save screen into PPM image @var{filename}.
288 ETEXI
291 .name = "logfile",
292 .args_type = "filename:F",
293 .params = "filename",
294 .help = "output logs to 'filename'",
295 .cmd = hmp_logfile,
298 STEXI
299 @item logfile @var{filename}
300 @findex logfile
301 Output logs to @var{filename}.
302 ETEXI
305 .name = "trace-event",
306 .args_type = "name:s,option:b,vcpu:i?",
307 .params = "name on|off [vcpu]",
308 .help = "changes status of a specific trace event "
309 "(vcpu: vCPU to set, default is all)",
310 .cmd = hmp_trace_event,
311 .command_completion = trace_event_completion,
314 STEXI
315 @item trace-event
316 @findex trace-event
317 changes status of a trace event
318 ETEXI
320 #if defined(CONFIG_TRACE_SIMPLE)
322 .name = "trace-file",
323 .args_type = "op:s?,arg:F?",
324 .params = "on|off|flush|set [arg]",
325 .help = "open, close, or flush trace file, or set a new file name",
326 .cmd = hmp_trace_file,
329 STEXI
330 @item trace-file on|off|flush
331 @findex trace-file
332 Open, close, or flush the trace file. If no argument is given, the status of the trace file is displayed.
333 ETEXI
334 #endif
337 .name = "log",
338 .args_type = "items:s",
339 .params = "item1[,...]",
340 .help = "activate logging of the specified items",
341 .cmd = hmp_log,
344 STEXI
345 @item log @var{item1}[,...]
346 @findex log
347 Activate logging of the specified items.
348 ETEXI
351 .name = "savevm",
352 .args_type = "name:s?",
353 .params = "tag",
354 .help = "save a VM snapshot. If no tag is provided, a new snapshot is created",
355 .cmd = hmp_savevm,
358 STEXI
359 @item savevm @var{tag}
360 @findex savevm
361 Create a snapshot of the whole virtual machine. If @var{tag} is
362 provided, it is used as human readable identifier. If there is already
363 a snapshot with the same tag, it is replaced. More info at
364 @ref{vm_snapshots}.
366 Since 4.0, savevm stopped allowing the snapshot id to be set, accepting
367 only @var{tag} as parameter.
368 ETEXI
371 .name = "loadvm",
372 .args_type = "name:s",
373 .params = "tag",
374 .help = "restore a VM snapshot from its tag",
375 .cmd = hmp_loadvm,
376 .command_completion = loadvm_completion,
379 STEXI
380 @item loadvm @var{tag}
381 @findex loadvm
382 Set the whole virtual machine to the snapshot identified by the tag
383 @var{tag}.
385 Since 4.0, loadvm stopped accepting snapshot id as parameter.
386 ETEXI
389 .name = "delvm",
390 .args_type = "name:s",
391 .params = "tag",
392 .help = "delete a VM snapshot from its tag",
393 .cmd = hmp_delvm,
394 .command_completion = delvm_completion,
397 STEXI
398 @item delvm @var{tag}
399 @findex delvm
400 Delete the snapshot identified by @var{tag}.
402 Since 4.0, delvm stopped deleting snapshots by snapshot id, accepting
403 only @var{tag} as parameter.
404 ETEXI
407 .name = "singlestep",
408 .args_type = "option:s?",
409 .params = "[on|off]",
410 .help = "run emulation in singlestep mode or switch to normal mode",
411 .cmd = hmp_singlestep,
414 STEXI
415 @item singlestep [off]
416 @findex singlestep
417 Run the emulation in single step mode.
418 If called with option off, the emulation returns to normal mode.
419 ETEXI
422 .name = "stop",
423 .args_type = "",
424 .params = "",
425 .help = "stop emulation",
426 .cmd = hmp_stop,
429 STEXI
430 @item stop
431 @findex stop
432 Stop emulation.
433 ETEXI
436 .name = "c|cont",
437 .args_type = "",
438 .params = "",
439 .help = "resume emulation",
440 .cmd = hmp_cont,
443 STEXI
444 @item c or cont
445 @findex cont
446 Resume emulation.
447 ETEXI
450 .name = "system_wakeup",
451 .args_type = "",
452 .params = "",
453 .help = "wakeup guest from suspend",
454 .cmd = hmp_system_wakeup,
457 STEXI
458 @item system_wakeup
459 @findex system_wakeup
460 Wakeup guest from suspend.
461 ETEXI
464 .name = "gdbserver",
465 .args_type = "device:s?",
466 .params = "[device]",
467 .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
468 .cmd = hmp_gdbserver,
471 STEXI
472 @item gdbserver [@var{port}]
473 @findex gdbserver
474 Start gdbserver session (default @var{port}=1234)
475 ETEXI
478 .name = "x",
479 .args_type = "fmt:/,addr:l",
480 .params = "/fmt addr",
481 .help = "virtual memory dump starting at 'addr'",
482 .cmd = hmp_memory_dump,
485 STEXI
486 @item x/fmt @var{addr}
487 @findex x
488 Virtual memory dump starting at @var{addr}.
489 ETEXI
492 .name = "xp",
493 .args_type = "fmt:/,addr:l",
494 .params = "/fmt addr",
495 .help = "physical memory dump starting at 'addr'",
496 .cmd = hmp_physical_memory_dump,
499 STEXI
500 @item xp /@var{fmt} @var{addr}
501 @findex xp
502 Physical memory dump starting at @var{addr}.
504 @var{fmt} is a format which tells the command how to format the
505 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
507 @table @var
508 @item count
509 is the number of items to be dumped.
511 @item format
512 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
513 c (char) or i (asm instruction).
515 @item size
516 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
517 @code{h} or @code{w} can be specified with the @code{i} format to
518 respectively select 16 or 32 bit code instruction size.
520 @end table
522 Examples:
523 @itemize
524 @item
525 Dump 10 instructions at the current instruction pointer:
526 @example
527 (qemu) x/10i $eip
528 0x90107063: ret
529 0x90107064: sti
530 0x90107065: lea 0x0(%esi,1),%esi
531 0x90107069: lea 0x0(%edi,1),%edi
532 0x90107070: ret
533 0x90107071: jmp 0x90107080
534 0x90107073: nop
535 0x90107074: nop
536 0x90107075: nop
537 0x90107076: nop
538 @end example
540 @item
541 Dump 80 16 bit values at the start of the video memory.
542 @smallexample
543 (qemu) xp/80hx 0xb8000
544 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
545 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
546 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
547 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
548 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
549 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
550 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
551 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
552 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
553 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
554 @end smallexample
555 @end itemize
556 ETEXI
559 .name = "gpa2hva",
560 .args_type = "addr:l",
561 .params = "addr",
562 .help = "print the host virtual address corresponding to a guest physical address",
563 .cmd = hmp_gpa2hva,
566 STEXI
567 @item gpa2hva @var{addr}
568 @findex gpa2hva
569 Print the host virtual address at which the guest's physical address @var{addr}
570 is mapped.
571 ETEXI
573 #ifdef CONFIG_LINUX
575 .name = "gpa2hpa",
576 .args_type = "addr:l",
577 .params = "addr",
578 .help = "print the host physical address corresponding to a guest physical address",
579 .cmd = hmp_gpa2hpa,
581 #endif
583 STEXI
584 @item gpa2hpa @var{addr}
585 @findex gpa2hpa
586 Print the host physical address at which the guest's physical address @var{addr}
587 is mapped.
588 ETEXI
591 .name = "gva2gpa",
592 .args_type = "addr:l",
593 .params = "addr",
594 .help = "print the guest physical address corresponding to a guest virtual address",
595 .cmd = hmp_gva2gpa,
598 STEXI
599 @item gva2gpa @var{addr}
600 @findex gva2gpa
601 Print the guest physical address at which the guest's virtual address @var{addr}
602 is mapped based on the mapping for the current CPU.
603 ETEXI
606 .name = "p|print",
607 .args_type = "fmt:/,val:l",
608 .params = "/fmt expr",
609 .help = "print expression value (use $reg for CPU register access)",
610 .cmd = do_print,
613 STEXI
614 @item p or print/@var{fmt} @var{expr}
615 @findex print
616 Print expression value. Only the @var{format} part of @var{fmt} is
617 used.
618 ETEXI
621 .name = "i",
622 .args_type = "fmt:/,addr:i,index:i.",
623 .params = "/fmt addr",
624 .help = "I/O port read",
625 .cmd = hmp_ioport_read,
628 STEXI
629 @item i/@var{fmt} @var{addr} [.@var{index}]
630 @findex i
631 Read I/O port.
632 ETEXI
635 .name = "o",
636 .args_type = "fmt:/,addr:i,val:i",
637 .params = "/fmt addr value",
638 .help = "I/O port write",
639 .cmd = hmp_ioport_write,
642 STEXI
643 @item o/@var{fmt} @var{addr} @var{val}
644 @findex o
645 Write to I/O port.
646 ETEXI
649 .name = "sendkey",
650 .args_type = "keys:s,hold-time:i?",
651 .params = "keys [hold_ms]",
652 .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
653 .cmd = hmp_sendkey,
654 .command_completion = sendkey_completion,
657 STEXI
658 @item sendkey @var{keys}
659 @findex sendkey
660 Send @var{keys} to the guest. @var{keys} could be the name of the
661 key or the raw value in hexadecimal format. Use @code{-} to press
662 several keys simultaneously. Example:
663 @example
664 sendkey ctrl-alt-f1
665 @end example
667 This command is useful to send keys that your graphical user interface
668 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
669 ETEXI
671 .name = "sync-profile",
672 .args_type = "op:s?",
673 .params = "[on|off|reset]",
674 .help = "enable, disable or reset synchronization profiling. "
675 "With no arguments, prints whether profiling is on or off.",
676 .cmd = hmp_sync_profile,
679 STEXI
680 @item sync-profile [on|off|reset]
681 @findex sync-profile
682 Enable, disable or reset synchronization profiling. With no arguments, prints
683 whether profiling is on or off.
684 ETEXI
687 .name = "system_reset",
688 .args_type = "",
689 .params = "",
690 .help = "reset the system",
691 .cmd = hmp_system_reset,
694 STEXI
695 @item system_reset
696 @findex system_reset
697 Reset the system.
698 ETEXI
701 .name = "system_powerdown",
702 .args_type = "",
703 .params = "",
704 .help = "send system power down event",
705 .cmd = hmp_system_powerdown,
708 STEXI
709 @item system_powerdown
710 @findex system_powerdown
711 Power down the system (if supported).
712 ETEXI
715 .name = "sum",
716 .args_type = "start:i,size:i",
717 .params = "addr size",
718 .help = "compute the checksum of a memory region",
719 .cmd = hmp_sum,
722 STEXI
723 @item sum @var{addr} @var{size}
724 @findex sum
725 Compute the checksum of a memory region.
726 ETEXI
729 .name = "device_add",
730 .args_type = "device:O",
731 .params = "driver[,prop=value][,...]",
732 .help = "add device, like -device on the command line",
733 .cmd = hmp_device_add,
734 .command_completion = device_add_completion,
737 STEXI
738 @item device_add @var{config}
739 @findex device_add
740 Add device.
741 ETEXI
744 .name = "device_del",
745 .args_type = "id:s",
746 .params = "device",
747 .help = "remove device",
748 .cmd = hmp_device_del,
749 .command_completion = device_del_completion,
752 STEXI
753 @item device_del @var{id}
754 @findex device_del
755 Remove device @var{id}. @var{id} may be a short ID
756 or a QOM object path.
757 ETEXI
760 .name = "cpu",
761 .args_type = "index:i",
762 .params = "index",
763 .help = "set the default CPU",
764 .cmd = hmp_cpu,
767 STEXI
768 @item cpu @var{index}
769 @findex cpu
770 Set the default CPU.
771 ETEXI
774 .name = "mouse_move",
775 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
776 .params = "dx dy [dz]",
777 .help = "send mouse move events",
778 .cmd = hmp_mouse_move,
781 STEXI
782 @item mouse_move @var{dx} @var{dy} [@var{dz}]
783 @findex mouse_move
784 Move the active mouse to the specified coordinates @var{dx} @var{dy}
785 with optional scroll axis @var{dz}.
786 ETEXI
789 .name = "mouse_button",
790 .args_type = "button_state:i",
791 .params = "state",
792 .help = "change mouse button state (1=L, 2=M, 4=R)",
793 .cmd = hmp_mouse_button,
796 STEXI
797 @item mouse_button @var{val}
798 @findex mouse_button
799 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
800 ETEXI
803 .name = "mouse_set",
804 .args_type = "index:i",
805 .params = "index",
806 .help = "set which mouse device receives events",
807 .cmd = hmp_mouse_set,
810 STEXI
811 @item mouse_set @var{index}
812 @findex mouse_set
813 Set which mouse device receives events at given @var{index}, index
814 can be obtained with
815 @example
816 info mice
817 @end example
818 ETEXI
821 .name = "wavcapture",
822 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
823 .params = "path [frequency [bits [channels]]]",
824 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
825 .cmd = hmp_wavcapture,
827 STEXI
828 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
829 @findex wavcapture
830 Capture audio into @var{filename}. Using sample rate @var{frequency}
831 bits per sample @var{bits} and number of channels @var{channels}.
833 Defaults:
834 @itemize @minus
835 @item Sample rate = 44100 Hz - CD quality
836 @item Bits = 16
837 @item Number of channels = 2 - Stereo
838 @end itemize
839 ETEXI
842 .name = "stopcapture",
843 .args_type = "n:i",
844 .params = "capture index",
845 .help = "stop capture",
846 .cmd = hmp_stopcapture,
848 STEXI
849 @item stopcapture @var{index}
850 @findex stopcapture
851 Stop capture with a given @var{index}, index can be obtained with
852 @example
853 info capture
854 @end example
855 ETEXI
858 .name = "memsave",
859 .args_type = "val:l,size:i,filename:s",
860 .params = "addr size file",
861 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
862 .cmd = hmp_memsave,
865 STEXI
866 @item memsave @var{addr} @var{size} @var{file}
867 @findex memsave
868 save to disk virtual memory dump starting at @var{addr} of size @var{size}.
869 ETEXI
872 .name = "pmemsave",
873 .args_type = "val:l,size:i,filename:s",
874 .params = "addr size file",
875 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
876 .cmd = hmp_pmemsave,
879 STEXI
880 @item pmemsave @var{addr} @var{size} @var{file}
881 @findex pmemsave
882 save to disk physical memory dump starting at @var{addr} of size @var{size}.
883 ETEXI
886 .name = "boot_set",
887 .args_type = "bootdevice:s",
888 .params = "bootdevice",
889 .help = "define new values for the boot device list",
890 .cmd = hmp_boot_set,
893 STEXI
894 @item boot_set @var{bootdevicelist}
895 @findex boot_set
896 Define new values for the boot device list. Those values will override
897 the values specified on the command line through the @code{-boot} option.
899 The values that can be specified here depend on the machine type, but are
900 the same that can be specified in the @code{-boot} command line option.
901 ETEXI
904 .name = "nmi",
905 .args_type = "",
906 .params = "",
907 .help = "inject an NMI",
908 .cmd = hmp_nmi,
910 STEXI
911 @item nmi @var{cpu}
912 @findex nmi
913 Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
915 ETEXI
918 .name = "ringbuf_write",
919 .args_type = "device:s,data:s",
920 .params = "device data",
921 .help = "Write to a ring buffer character device",
922 .cmd = hmp_ringbuf_write,
923 .command_completion = ringbuf_write_completion,
926 STEXI
927 @item ringbuf_write @var{device} @var{data}
928 @findex ringbuf_write
929 Write @var{data} to ring buffer character device @var{device}.
930 @var{data} must be a UTF-8 string.
932 ETEXI
935 .name = "ringbuf_read",
936 .args_type = "device:s,size:i",
937 .params = "device size",
938 .help = "Read from a ring buffer character device",
939 .cmd = hmp_ringbuf_read,
940 .command_completion = ringbuf_write_completion,
943 STEXI
944 @item ringbuf_read @var{device}
945 @findex ringbuf_read
946 Read and print up to @var{size} bytes from ring buffer character
947 device @var{device}.
948 Certain non-printable characters are printed \uXXXX, where XXXX is the
949 character code in hexadecimal. Character \ is printed \\.
950 Bug: can screw up when the buffer contains invalid UTF-8 sequences,
951 NUL characters, after the ring buffer lost data, and when reading
952 stops because the size limit is reached.
954 ETEXI
957 .name = "announce_self",
958 .args_type = "interfaces:s?,id:s?",
959 .params = "[interfaces] [id]",
960 .help = "Trigger GARP/RARP announcements",
961 .cmd = hmp_announce_self,
964 STEXI
965 @item announce_self
966 @findex announce_self
967 Trigger a round of GARP/RARP broadcasts; this is useful for explicitly updating the
968 network infrastructure after a reconfiguration or some forms of migration.
969 The timings of the round are set by the migration announce parameters.
970 An optional comma separated @var{interfaces} list restricts the announce to the
971 named set of interfaces. An optional @var{id} can be used to start a separate announce
972 timer and to change the parameters of it later.
973 ETEXI
976 .name = "migrate",
977 .args_type = "detach:-d,blk:-b,inc:-i,resume:-r,uri:s",
978 .params = "[-d] [-b] [-i] [-r] uri",
979 .help = "migrate to URI (using -d to not wait for completion)"
980 "\n\t\t\t -b for migration without shared storage with"
981 " full copy of disk\n\t\t\t -i for migration without "
982 "shared storage with incremental copy of disk "
983 "(base image shared between src and destination)"
984 "\n\t\t\t -r to resume a paused migration",
985 .cmd = hmp_migrate,
989 STEXI
990 @item migrate [-d] [-b] [-i] @var{uri}
991 @findex migrate
992 Migrate to @var{uri} (using -d to not wait for completion).
993 -b for migration with full copy of disk
994 -i for migration with incremental copy of disk (base image is shared)
995 ETEXI
998 .name = "migrate_cancel",
999 .args_type = "",
1000 .params = "",
1001 .help = "cancel the current VM migration",
1002 .cmd = hmp_migrate_cancel,
1005 STEXI
1006 @item migrate_cancel
1007 @findex migrate_cancel
1008 Cancel the current VM migration.
1009 ETEXI
1012 .name = "migrate_continue",
1013 .args_type = "state:s",
1014 .params = "state",
1015 .help = "Continue migration from the given paused state",
1016 .cmd = hmp_migrate_continue,
1018 STEXI
1019 @item migrate_continue @var{state}
1020 @findex migrate_continue
1021 Continue migration from the paused state @var{state}
1022 ETEXI
1025 .name = "migrate_incoming",
1026 .args_type = "uri:s",
1027 .params = "uri",
1028 .help = "Continue an incoming migration from an -incoming defer",
1029 .cmd = hmp_migrate_incoming,
1032 STEXI
1033 @item migrate_incoming @var{uri}
1034 @findex migrate_incoming
1035 Continue an incoming migration using the @var{uri} (that has the same syntax
1036 as the -incoming option).
1037 ETEXI
1040 .name = "migrate_recover",
1041 .args_type = "uri:s",
1042 .params = "uri",
1043 .help = "Continue a paused incoming postcopy migration",
1044 .cmd = hmp_migrate_recover,
1047 STEXI
1048 @item migrate_recover @var{uri}
1049 @findex migrate_recover
1050 Continue a paused incoming postcopy migration using the @var{uri}.
1051 ETEXI
1054 .name = "migrate_pause",
1055 .args_type = "",
1056 .params = "",
1057 .help = "Pause an ongoing migration (postcopy-only)",
1058 .cmd = hmp_migrate_pause,
1061 STEXI
1062 @item migrate_pause
1063 @findex migrate_pause
1064 Pause an ongoing migration. Currently it only supports postcopy.
1065 ETEXI
1068 .name = "migrate_set_cache_size",
1069 .args_type = "value:o",
1070 .params = "value",
1071 .help = "set cache size (in bytes) for XBZRLE migrations,"
1072 "the cache size will be rounded down to the nearest "
1073 "power of 2.\n"
1074 "The cache size affects the number of cache misses."
1075 "In case of a high cache miss ratio you need to increase"
1076 " the cache size",
1077 .cmd = hmp_migrate_set_cache_size,
1080 STEXI
1081 @item migrate_set_cache_size @var{value}
1082 @findex migrate_set_cache_size
1083 Set cache size to @var{value} (in bytes) for xbzrle migrations.
1084 ETEXI
1087 .name = "migrate_set_speed",
1088 .args_type = "value:o",
1089 .params = "value",
1090 .help = "set maximum speed (in bytes) for migrations. "
1091 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
1092 .cmd = hmp_migrate_set_speed,
1095 STEXI
1096 @item migrate_set_speed @var{value}
1097 @findex migrate_set_speed
1098 Set maximum speed to @var{value} (in bytes) for migrations.
1099 ETEXI
1102 .name = "migrate_set_downtime",
1103 .args_type = "value:T",
1104 .params = "value",
1105 .help = "set maximum tolerated downtime (in seconds) for migrations",
1106 .cmd = hmp_migrate_set_downtime,
1109 STEXI
1110 @item migrate_set_downtime @var{second}
1111 @findex migrate_set_downtime
1112 Set maximum tolerated downtime (in seconds) for migration.
1113 ETEXI
1116 .name = "migrate_set_capability",
1117 .args_type = "capability:s,state:b",
1118 .params = "capability state",
1119 .help = "Enable/Disable the usage of a capability for migration",
1120 .cmd = hmp_migrate_set_capability,
1121 .command_completion = migrate_set_capability_completion,
1124 STEXI
1125 @item migrate_set_capability @var{capability} @var{state}
1126 @findex migrate_set_capability
1127 Enable/Disable the usage of a capability @var{capability} for migration.
1128 ETEXI
1131 .name = "migrate_set_parameter",
1132 .args_type = "parameter:s,value:s",
1133 .params = "parameter value",
1134 .help = "Set the parameter for migration",
1135 .cmd = hmp_migrate_set_parameter,
1136 .command_completion = migrate_set_parameter_completion,
1139 STEXI
1140 @item migrate_set_parameter @var{parameter} @var{value}
1141 @findex migrate_set_parameter
1142 Set the parameter @var{parameter} for migration.
1143 ETEXI
1146 .name = "migrate_start_postcopy",
1147 .args_type = "",
1148 .params = "",
1149 .help = "Followup to a migration command to switch the migration"
1150 " to postcopy mode. The postcopy-ram capability must "
1151 "be set on both source and destination before the "
1152 "original migration command .",
1153 .cmd = hmp_migrate_start_postcopy,
1156 STEXI
1157 @item migrate_start_postcopy
1158 @findex migrate_start_postcopy
1159 Switch in-progress migration to postcopy mode. Ignored after the end of
1160 migration (or once already in postcopy).
1161 ETEXI
1164 .name = "x_colo_lost_heartbeat",
1165 .args_type = "",
1166 .params = "",
1167 .help = "Tell COLO that heartbeat is lost,\n\t\t\t"
1168 "a failover or takeover is needed.",
1169 .cmd = hmp_x_colo_lost_heartbeat,
1172 STEXI
1173 @item x_colo_lost_heartbeat
1174 @findex x_colo_lost_heartbeat
1175 Tell COLO that heartbeat is lost, a failover or takeover is needed.
1176 ETEXI
1179 .name = "client_migrate_info",
1180 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1181 .params = "protocol hostname port tls-port cert-subject",
1182 .help = "set migration information for remote display",
1183 .cmd = hmp_client_migrate_info,
1186 STEXI
1187 @item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
1188 @findex client_migrate_info
1189 Set migration information for remote display. This makes the server
1190 ask the client to automatically reconnect using the new parameters
1191 once migration finished successfully. Only implemented for SPICE.
1192 ETEXI
1195 .name = "dump-guest-memory",
1196 .args_type = "paging:-p,detach:-d,windmp:-w,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:l?,length:l?",
1197 .params = "[-p] [-d] [-z|-l|-s|-w] filename [begin length]",
1198 .help = "dump guest memory into file 'filename'.\n\t\t\t"
1199 "-p: do paging to get guest's memory mapping.\n\t\t\t"
1200 "-d: return immediately (do not wait for completion).\n\t\t\t"
1201 "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1202 "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1203 "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
1204 "-w: dump in Windows crashdump format (can be used instead of ELF-dump converting),\n\t\t\t"
1205 " for Windows x64 guests with vmcoreinfo driver only.\n\t\t\t"
1206 "begin: the starting physical address.\n\t\t\t"
1207 "length: the memory size, in bytes.",
1208 .cmd = hmp_dump_guest_memory,
1211 STEXI
1212 @item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
1213 @item dump-guest-memory [-z|-l|-s|-w] @var{filename}
1214 @findex dump-guest-memory
1215 Dump guest memory to @var{protocol}. The file can be processed with crash or
1216 gdb. Without -z|-l|-s|-w, the dump format is ELF.
1217 -p: do paging to get guest's memory mapping.
1218 -z: dump in kdump-compressed format, with zlib compression.
1219 -l: dump in kdump-compressed format, with lzo compression.
1220 -s: dump in kdump-compressed format, with snappy compression.
1221 -w: dump in Windows crashdump format (can be used instead of ELF-dump converting),
1222 for Windows x64 guests with vmcoreinfo driver only
1223 filename: dump file name.
1224 begin: the starting physical address. It's optional, and should be
1225 specified together with length.
1226 length: the memory size, in bytes. It's optional, and should be specified
1227 together with begin.
1228 ETEXI
1230 #if defined(TARGET_S390X)
1232 .name = "dump-skeys",
1233 .args_type = "filename:F",
1234 .params = "",
1235 .help = "Save guest storage keys into file 'filename'.\n",
1236 .cmd = hmp_dump_skeys,
1238 #endif
1240 STEXI
1241 @item dump-skeys @var{filename}
1242 @findex dump-skeys
1243 Save guest storage keys to a file.
1244 ETEXI
1246 #if defined(TARGET_S390X)
1248 .name = "migration_mode",
1249 .args_type = "mode:i",
1250 .params = "mode",
1251 .help = "Enables or disables migration mode\n",
1252 .cmd = hmp_migrationmode,
1254 #endif
1256 STEXI
1257 @item migration_mode @var{mode}
1258 @findex migration_mode
1259 Enables or disables migration mode.
1260 ETEXI
1263 .name = "snapshot_blkdev",
1264 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1265 .params = "[-n] device [new-image-file] [format]",
1266 .help = "initiates a live snapshot\n\t\t\t"
1267 "of device. If a new image file is specified, the\n\t\t\t"
1268 "new image file will become the new root image.\n\t\t\t"
1269 "If format is specified, the snapshot file will\n\t\t\t"
1270 "be created in that format.\n\t\t\t"
1271 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1272 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1273 "recreating it from scratch.",
1274 .cmd = hmp_snapshot_blkdev,
1277 STEXI
1278 @item snapshot_blkdev
1279 @findex snapshot_blkdev
1280 Snapshot device, using snapshot file as target if provided
1281 ETEXI
1284 .name = "snapshot_blkdev_internal",
1285 .args_type = "device:B,name:s",
1286 .params = "device name",
1287 .help = "take an internal snapshot of device.\n\t\t\t"
1288 "The format of the image used by device must\n\t\t\t"
1289 "support it, such as qcow2.\n\t\t\t",
1290 .cmd = hmp_snapshot_blkdev_internal,
1293 STEXI
1294 @item snapshot_blkdev_internal
1295 @findex snapshot_blkdev_internal
1296 Take an internal snapshot on device if it support
1297 ETEXI
1300 .name = "snapshot_delete_blkdev_internal",
1301 .args_type = "device:B,name:s,id:s?",
1302 .params = "device name [id]",
1303 .help = "delete an internal snapshot of device.\n\t\t\t"
1304 "If id is specified, qemu will try delete\n\t\t\t"
1305 "the snapshot matching both id and name.\n\t\t\t"
1306 "The format of the image used by device must\n\t\t\t"
1307 "support it, such as qcow2.\n\t\t\t",
1308 .cmd = hmp_snapshot_delete_blkdev_internal,
1311 STEXI
1312 @item snapshot_delete_blkdev_internal
1313 @findex snapshot_delete_blkdev_internal
1314 Delete an internal snapshot on device if it support
1315 ETEXI
1318 .name = "drive_mirror",
1319 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1320 .params = "[-n] [-f] device target [format]",
1321 .help = "initiates live storage\n\t\t\t"
1322 "migration for a device. The device's contents are\n\t\t\t"
1323 "copied to the new image file, including data that\n\t\t\t"
1324 "is written after the command is started.\n\t\t\t"
1325 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1326 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1327 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1328 "so that the result does not need a backing file.\n\t\t\t",
1329 .cmd = hmp_drive_mirror,
1331 STEXI
1332 @item drive_mirror
1333 @findex drive_mirror
1334 Start mirroring a block device's writes to a new destination,
1335 using the specified target.
1336 ETEXI
1339 .name = "drive_backup",
1340 .args_type = "reuse:-n,full:-f,compress:-c,device:B,target:s,format:s?",
1341 .params = "[-n] [-f] [-c] device target [format]",
1342 .help = "initiates a point-in-time\n\t\t\t"
1343 "copy for a device. The device's contents are\n\t\t\t"
1344 "copied to the new image file, excluding data that\n\t\t\t"
1345 "is written after the command is started.\n\t\t\t"
1346 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1347 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1348 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1349 "so that the result does not need a backing file.\n\t\t\t"
1350 "The -c flag requests QEMU to compress backup data\n\t\t\t"
1351 "(if the target format supports it).\n\t\t\t",
1352 .cmd = hmp_drive_backup,
1354 STEXI
1355 @item drive_backup
1356 @findex drive_backup
1357 Start a point-in-time copy of a block device to a specificed target.
1358 ETEXI
1361 .name = "drive_add",
1362 .args_type = "node:-n,pci_addr:s,opts:s",
1363 .params = "[-n] [[<domain>:]<bus>:]<slot>\n"
1364 "[file=file][,if=type][,bus=n]\n"
1365 "[,unit=m][,media=d][,index=i]\n"
1366 "[,snapshot=on|off][,cache=on|off]\n"
1367 "[,readonly=on|off][,copy-on-read=on|off]",
1368 .help = "add drive to PCI storage controller",
1369 .cmd = hmp_drive_add,
1372 STEXI
1373 @item drive_add
1374 @findex drive_add
1375 Add drive to PCI storage controller.
1376 ETEXI
1379 .name = "pcie_aer_inject_error",
1380 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1381 "id:s,error_status:s,"
1382 "header0:i?,header1:i?,header2:i?,header3:i?,"
1383 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1384 .params = "[-a] [-c] id "
1385 "<error_status> [<tlp header> [<tlp header prefix>]]",
1386 .help = "inject pcie aer error\n\t\t\t"
1387 " -a for advisory non fatal error\n\t\t\t"
1388 " -c for correctable error\n\t\t\t"
1389 "<id> = qdev device id\n\t\t\t"
1390 "<error_status> = error string or 32bit\n\t\t\t"
1391 "<tlb header> = 32bit x 4\n\t\t\t"
1392 "<tlb header prefix> = 32bit x 4",
1393 .cmd = hmp_pcie_aer_inject_error,
1396 STEXI
1397 @item pcie_aer_inject_error
1398 @findex pcie_aer_inject_error
1399 Inject PCIe AER error
1400 ETEXI
1403 .name = "netdev_add",
1404 .args_type = "netdev:O",
1405 .params = "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
1406 .help = "add host network device",
1407 .cmd = hmp_netdev_add,
1408 .command_completion = netdev_add_completion,
1411 STEXI
1412 @item netdev_add
1413 @findex netdev_add
1414 Add host network device.
1415 ETEXI
1418 .name = "netdev_del",
1419 .args_type = "id:s",
1420 .params = "id",
1421 .help = "remove host network device",
1422 .cmd = hmp_netdev_del,
1423 .command_completion = netdev_del_completion,
1426 STEXI
1427 @item netdev_del
1428 @findex netdev_del
1429 Remove host network device.
1430 ETEXI
1433 .name = "object_add",
1434 .args_type = "object:O",
1435 .params = "[qom-type=]type,id=str[,prop=value][,...]",
1436 .help = "create QOM object",
1437 .cmd = hmp_object_add,
1438 .command_completion = object_add_completion,
1441 STEXI
1442 @item object_add
1443 @findex object_add
1444 Create QOM object.
1445 ETEXI
1448 .name = "object_del",
1449 .args_type = "id:s",
1450 .params = "id",
1451 .help = "destroy QOM object",
1452 .cmd = hmp_object_del,
1453 .command_completion = object_del_completion,
1456 STEXI
1457 @item object_del
1458 @findex object_del
1459 Destroy QOM object.
1460 ETEXI
1462 #ifdef CONFIG_SLIRP
1464 .name = "hostfwd_add",
1465 .args_type = "arg1:s,arg2:s?,arg3:s?",
1466 .params = "[hub_id name]|[netdev_id] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1467 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
1468 .cmd = hmp_hostfwd_add,
1470 #endif
1471 STEXI
1472 @item hostfwd_add
1473 @findex hostfwd_add
1474 Redirect TCP or UDP connections from host to guest (requires -net user).
1475 ETEXI
1477 #ifdef CONFIG_SLIRP
1479 .name = "hostfwd_remove",
1480 .args_type = "arg1:s,arg2:s?,arg3:s?",
1481 .params = "[hub_id name]|[netdev_id] [tcp|udp]:[hostaddr]:hostport",
1482 .help = "remove host-to-guest TCP or UDP redirection",
1483 .cmd = hmp_hostfwd_remove,
1486 #endif
1487 STEXI
1488 @item hostfwd_remove
1489 @findex hostfwd_remove
1490 Remove host-to-guest TCP or UDP redirection.
1491 ETEXI
1494 .name = "balloon",
1495 .args_type = "value:M",
1496 .params = "target",
1497 .help = "request VM to change its memory allocation (in MB)",
1498 .cmd = hmp_balloon,
1501 STEXI
1502 @item balloon @var{value}
1503 @findex balloon
1504 Request VM to change its memory allocation to @var{value} (in MB).
1505 ETEXI
1508 .name = "set_link",
1509 .args_type = "name:s,up:b",
1510 .params = "name on|off",
1511 .help = "change the link status of a network adapter",
1512 .cmd = hmp_set_link,
1513 .command_completion = set_link_completion,
1516 STEXI
1517 @item set_link @var{name} [on|off]
1518 @findex set_link
1519 Switch link @var{name} on (i.e. up) or off (i.e. down).
1520 ETEXI
1523 .name = "watchdog_action",
1524 .args_type = "action:s",
1525 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1526 .help = "change watchdog action",
1527 .cmd = hmp_watchdog_action,
1528 .command_completion = watchdog_action_completion,
1531 STEXI
1532 @item watchdog_action
1533 @findex watchdog_action
1534 Change watchdog action.
1535 ETEXI
1538 .name = "acl_show",
1539 .args_type = "aclname:s",
1540 .params = "aclname",
1541 .help = "list rules in the access control list",
1542 .cmd = hmp_acl_show,
1545 STEXI
1546 @item acl_show @var{aclname}
1547 @findex acl_show
1548 List all the matching rules in the access control list, and the default
1549 policy. There are currently two named access control lists,
1550 @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1551 certificate distinguished name, and SASL username respectively.
1552 ETEXI
1555 .name = "acl_policy",
1556 .args_type = "aclname:s,policy:s",
1557 .params = "aclname allow|deny",
1558 .help = "set default access control list policy",
1559 .cmd = hmp_acl_policy,
1562 STEXI
1563 @item acl_policy @var{aclname} @code{allow|deny}
1564 @findex acl_policy
1565 Set the default access control list policy, used in the event that
1566 none of the explicit rules match. The default policy at startup is
1567 always @code{deny}.
1568 ETEXI
1571 .name = "acl_add",
1572 .args_type = "aclname:s,match:s,policy:s,index:i?",
1573 .params = "aclname match allow|deny [index]",
1574 .help = "add a match rule to the access control list",
1575 .cmd = hmp_acl_add,
1578 STEXI
1579 @item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1580 @findex acl_add
1581 Add a match rule to the access control list, allowing or denying access.
1582 The match will normally be an exact username or x509 distinguished name,
1583 but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1584 allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
1585 normally be appended to the end of the ACL, but can be inserted
1586 earlier in the list if the optional @var{index} parameter is supplied.
1587 ETEXI
1590 .name = "acl_remove",
1591 .args_type = "aclname:s,match:s",
1592 .params = "aclname match",
1593 .help = "remove a match rule from the access control list",
1594 .cmd = hmp_acl_remove,
1597 STEXI
1598 @item acl_remove @var{aclname} @var{match}
1599 @findex acl_remove
1600 Remove the specified match rule from the access control list.
1601 ETEXI
1604 .name = "acl_reset",
1605 .args_type = "aclname:s",
1606 .params = "aclname",
1607 .help = "reset the access control list",
1608 .cmd = hmp_acl_reset,
1611 STEXI
1612 @item acl_reset @var{aclname}
1613 @findex acl_reset
1614 Remove all matches from the access control list, and set the default
1615 policy back to @code{deny}.
1616 ETEXI
1619 .name = "nbd_server_start",
1620 .args_type = "all:-a,writable:-w,uri:s",
1621 .params = "nbd_server_start [-a] [-w] host:port",
1622 .help = "serve block devices on the given host and port",
1623 .cmd = hmp_nbd_server_start,
1625 STEXI
1626 @item nbd_server_start @var{host}:@var{port}
1627 @findex nbd_server_start
1628 Start an NBD server on the given host and/or port. If the @option{-a}
1629 option is included, all of the virtual machine's block devices that
1630 have an inserted media on them are automatically exported; in this case,
1631 the @option{-w} option makes the devices writable too.
1632 ETEXI
1635 .name = "nbd_server_add",
1636 .args_type = "writable:-w,device:B,name:s?",
1637 .params = "nbd_server_add [-w] device [name]",
1638 .help = "export a block device via NBD",
1639 .cmd = hmp_nbd_server_add,
1641 STEXI
1642 @item nbd_server_add @var{device} [ @var{name} ]
1643 @findex nbd_server_add
1644 Export a block device through QEMU's NBD server, which must be started
1645 beforehand with @command{nbd_server_start}. The @option{-w} option makes the
1646 exported device writable too. The export name is controlled by @var{name},
1647 defaulting to @var{device}.
1648 ETEXI
1651 .name = "nbd_server_remove",
1652 .args_type = "force:-f,name:s",
1653 .params = "nbd_server_remove [-f] name",
1654 .help = "remove an export previously exposed via NBD",
1655 .cmd = hmp_nbd_server_remove,
1657 STEXI
1658 @item nbd_server_remove [-f] @var{name}
1659 @findex nbd_server_remove
1660 Stop exporting a block device through QEMU's NBD server, which was
1661 previously started with @command{nbd_server_add}. The @option{-f}
1662 option forces the server to drop the export immediately even if
1663 clients are connected; otherwise the command fails unless there are no
1664 clients.
1665 ETEXI
1668 .name = "nbd_server_stop",
1669 .args_type = "",
1670 .params = "nbd_server_stop",
1671 .help = "stop serving block devices using the NBD protocol",
1672 .cmd = hmp_nbd_server_stop,
1674 STEXI
1675 @item nbd_server_stop
1676 @findex nbd_server_stop
1677 Stop the QEMU embedded NBD server.
1678 ETEXI
1681 #if defined(TARGET_I386)
1684 .name = "mce",
1685 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1686 .params = "[-b] cpu bank status mcgstatus addr misc",
1687 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1688 .cmd = hmp_mce,
1691 #endif
1692 STEXI
1693 @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1694 @findex mce (x86)
1695 Inject an MCE on the given CPU (x86 only).
1696 ETEXI
1699 .name = "getfd",
1700 .args_type = "fdname:s",
1701 .params = "getfd name",
1702 .help = "receive a file descriptor via SCM rights and assign it a name",
1703 .cmd = hmp_getfd,
1706 STEXI
1707 @item getfd @var{fdname}
1708 @findex getfd
1709 If a file descriptor is passed alongside this command using the SCM_RIGHTS
1710 mechanism on unix sockets, it is stored using the name @var{fdname} for
1711 later use by other monitor commands.
1712 ETEXI
1715 .name = "closefd",
1716 .args_type = "fdname:s",
1717 .params = "closefd name",
1718 .help = "close a file descriptor previously passed via SCM rights",
1719 .cmd = hmp_closefd,
1722 STEXI
1723 @item closefd @var{fdname}
1724 @findex closefd
1725 Close the file descriptor previously assigned to @var{fdname} using the
1726 @code{getfd} command. This is only needed if the file descriptor was never
1727 used by another monitor command.
1728 ETEXI
1731 .name = "block_passwd",
1732 .args_type = "device:B,password:s",
1733 .params = "block_passwd device password",
1734 .help = "set the password of encrypted block devices",
1735 .cmd = hmp_block_passwd,
1738 STEXI
1739 @item block_passwd @var{device} @var{password}
1740 @findex block_passwd
1741 Set the encrypted device @var{device} password to @var{password}
1743 This command is now obsolete and will always return an error since 2.10
1744 ETEXI
1747 .name = "block_set_io_throttle",
1748 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1749 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1750 .help = "change I/O throttle limits for a block drive",
1751 .cmd = hmp_block_set_io_throttle,
1754 STEXI
1755 @item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1756 @findex block_set_io_throttle
1757 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}.
1758 @var{device} can be a block device name, a qdev ID or a QOM path.
1759 ETEXI
1762 .name = "set_password",
1763 .args_type = "protocol:s,password:s,connected:s?",
1764 .params = "protocol password action-if-connected",
1765 .help = "set spice/vnc password",
1766 .cmd = hmp_set_password,
1769 STEXI
1770 @item set_password [ vnc | spice ] password [ action-if-connected ]
1771 @findex set_password
1772 Change spice/vnc password. Use zero to make the password stay valid
1773 forever. @var{action-if-connected} specifies what should happen in
1774 case a connection is established: @var{fail} makes the password change
1775 fail. @var{disconnect} changes the password and disconnects the
1776 client. @var{keep} changes the password and keeps the connection up.
1777 @var{keep} is the default.
1778 ETEXI
1781 .name = "expire_password",
1782 .args_type = "protocol:s,time:s",
1783 .params = "protocol time",
1784 .help = "set spice/vnc password expire-time",
1785 .cmd = hmp_expire_password,
1788 STEXI
1789 @item expire_password [ vnc | spice ] expire-time
1790 @findex expire_password
1791 Specify when a password for spice/vnc becomes
1792 invalid. @var{expire-time} accepts:
1794 @table @var
1795 @item now
1796 Invalidate password instantly.
1798 @item never
1799 Password stays valid forever.
1801 @item +nsec
1802 Password stays valid for @var{nsec} seconds starting now.
1804 @item nsec
1805 Password is invalidated at the given time. @var{nsec} are the seconds
1806 passed since 1970, i.e. unix epoch.
1808 @end table
1809 ETEXI
1812 .name = "chardev-add",
1813 .args_type = "args:s",
1814 .params = "args",
1815 .help = "add chardev",
1816 .cmd = hmp_chardev_add,
1817 .command_completion = chardev_add_completion,
1820 STEXI
1821 @item chardev-add args
1822 @findex chardev-add
1823 chardev-add accepts the same parameters as the -chardev command line switch.
1825 ETEXI
1828 .name = "chardev-change",
1829 .args_type = "id:s,args:s",
1830 .params = "id args",
1831 .help = "change chardev",
1832 .cmd = hmp_chardev_change,
1835 STEXI
1836 @item chardev-change args
1837 @findex chardev-change
1838 chardev-change accepts existing chardev @var{id} and then the same arguments
1839 as the -chardev command line switch (except for "id").
1841 ETEXI
1844 .name = "chardev-remove",
1845 .args_type = "id:s",
1846 .params = "id",
1847 .help = "remove chardev",
1848 .cmd = hmp_chardev_remove,
1849 .command_completion = chardev_remove_completion,
1852 STEXI
1853 @item chardev-remove id
1854 @findex chardev-remove
1855 Removes the chardev @var{id}.
1857 ETEXI
1860 .name = "chardev-send-break",
1861 .args_type = "id:s",
1862 .params = "id",
1863 .help = "send a break on chardev",
1864 .cmd = hmp_chardev_send_break,
1865 .command_completion = chardev_remove_completion,
1868 STEXI
1869 @item chardev-send-break id
1870 @findex chardev-send-break
1871 Send a break on the chardev @var{id}.
1873 ETEXI
1876 .name = "qemu-io",
1877 .args_type = "device:B,command:s",
1878 .params = "[device] \"[command]\"",
1879 .help = "run a qemu-io command on a block device",
1880 .cmd = hmp_qemu_io,
1883 STEXI
1884 @item qemu-io @var{device} @var{command}
1885 @findex qemu-io
1886 Executes a qemu-io command on the given block device.
1888 ETEXI
1891 .name = "cpu-add",
1892 .args_type = "id:i",
1893 .params = "id",
1894 .help = "add cpu (deprecated, use device_add instead)",
1895 .cmd = hmp_cpu_add,
1898 STEXI
1899 @item cpu-add @var{id}
1900 @findex cpu-add
1901 Add CPU with id @var{id}. This command is deprecated, please
1902 +use @code{device_add} instead. For details, refer to
1903 'docs/cpu-hotplug.rst'.
1904 ETEXI
1907 .name = "qom-list",
1908 .args_type = "path:s?",
1909 .params = "path",
1910 .help = "list QOM properties",
1911 .cmd = hmp_qom_list,
1912 .flags = "p",
1915 STEXI
1916 @item qom-list [@var{path}]
1917 Print QOM properties of object at location @var{path}
1918 ETEXI
1921 .name = "qom-set",
1922 .args_type = "path:s,property:s,value:s",
1923 .params = "path property value",
1924 .help = "set QOM property",
1925 .cmd = hmp_qom_set,
1926 .flags = "p",
1929 STEXI
1930 @item qom-set @var{path} @var{property} @var{value}
1931 Set QOM property @var{property} of object at location @var{path} to value @var{value}
1932 ETEXI
1935 .name = "info",
1936 .args_type = "item:s?",
1937 .params = "[subcommand]",
1938 .help = "show various information about the system state",
1939 .cmd = hmp_info_help,
1940 .sub_table = hmp_info_cmds,
1941 .flags = "p",
1944 STEXI
1945 @end table
1946 ETEXI