xref: /qemu/hmp-commands.hx (revision 94ae12cb)
1HXCOMM Use DEFHEADING() to define headings in both help text and texi
2HXCOMM Text between STEXI and ETEXI are copied to texi version and
3HXCOMM discarded from C version
4HXCOMM DEF(command, args, callback, arg_string, help) is used to construct
5HXCOMM monitor commands
6HXCOMM HXCOMM can be used for comments, discarded from both texi and C
7
8STEXI
9@table @option
10ETEXI
11
12    {
13        .name       = "help|?",
14        .args_type  = "name:S?",
15        .params     = "[cmd]",
16        .help       = "show the help",
17        .cmd        = do_help_cmd,
18    },
19
20STEXI
21@item help or ? [@var{cmd}]
22@findex help
23Show the help for all commands or just for command @var{cmd}.
24ETEXI
25
26    {
27        .name       = "commit",
28        .args_type  = "device:B",
29        .params     = "device|all",
30        .help       = "commit changes to the disk images (if -snapshot is used) or backing files",
31        .cmd        = hmp_commit,
32    },
33
34STEXI
35@item commit
36@findex commit
37Commit changes to the disk images (if -snapshot is used) or backing files.
38If the backing file is smaller than the snapshot, then the backing file will be
39resized to be the same size as the snapshot.  If the snapshot is smaller than
40the backing file, the backing file will not be truncated.  If you want the
41backing file to match the size of the smaller snapshot, you can safely truncate
42it yourself once the commit operation successfully completes.
43ETEXI
44
45    {
46        .name       = "q|quit",
47        .args_type  = "",
48        .params     = "",
49        .help       = "quit the emulator",
50        .cmd        = hmp_quit,
51    },
52
53STEXI
54@item q or quit
55@findex quit
56Quit the emulator.
57ETEXI
58
59    {
60        .name       = "block_resize",
61        .args_type  = "device:B,size:o",
62        .params     = "device size",
63        .help       = "resize a block image",
64        .cmd        = hmp_block_resize,
65    },
66
67STEXI
68@item block_resize
69@findex block_resize
70Resize a block image while a guest is running.  Usually requires guest
71action to see the updated size.  Resize to a lower size is supported,
72but should be used with extreme caution.  Note that this command only
73resizes image files, it can not resize block devices like LVM volumes.
74ETEXI
75
76    {
77        .name       = "block_stream",
78        .args_type  = "device:B,speed:o?,base:s?",
79        .params     = "device [speed [base]]",
80        .help       = "copy data from a backing file into a block device",
81        .cmd        = hmp_block_stream,
82    },
83
84STEXI
85@item block_stream
86@findex block_stream
87Copy data from a backing file into a block device.
88ETEXI
89
90    {
91        .name       = "block_job_set_speed",
92        .args_type  = "device:B,speed:o",
93        .params     = "device speed",
94        .help       = "set maximum speed for a background block operation",
95        .cmd        = hmp_block_job_set_speed,
96    },
97
98STEXI
99@item block_job_set_speed
100@findex block_job_set_speed
101Set maximum speed for a background block operation.
102ETEXI
103
104    {
105        .name       = "block_job_cancel",
106        .args_type  = "force:-f,device:B",
107        .params     = "[-f] device",
108        .help       = "stop an active background block operation (use -f"
109                      "\n\t\t\t if the operation is currently paused)",
110        .cmd        = hmp_block_job_cancel,
111    },
112
113STEXI
114@item block_job_cancel
115@findex block_job_cancel
116Stop an active background block operation (streaming, mirroring).
117ETEXI
118
119    {
120        .name       = "block_job_complete",
121        .args_type  = "device:B",
122        .params     = "device",
123        .help       = "stop an active background block operation",
124        .cmd        = hmp_block_job_complete,
125    },
126
127STEXI
128@item block_job_complete
129@findex block_job_complete
130Manually trigger completion of an active background block operation.
131For mirroring, this will switch the device to the destination path.
132ETEXI
133
134    {
135        .name       = "block_job_pause",
136        .args_type  = "device:B",
137        .params     = "device",
138        .help       = "pause an active background block operation",
139        .cmd        = hmp_block_job_pause,
140    },
141
142STEXI
143@item block_job_pause
144@findex block_job_pause
145Pause an active block streaming operation.
146ETEXI
147
148    {
149        .name       = "block_job_resume",
150        .args_type  = "device:B",
151        .params     = "device",
152        .help       = "resume a paused background block operation",
153        .cmd        = hmp_block_job_resume,
154    },
155
156STEXI
157@item block_job_resume
158@findex block_job_resume
159Resume a paused block streaming operation.
160ETEXI
161
162    {
163        .name       = "eject",
164        .args_type  = "force:-f,device:B",
165        .params     = "[-f] device",
166        .help       = "eject a removable medium (use -f to force it)",
167        .cmd        = hmp_eject,
168    },
169
170STEXI
171@item eject [-f] @var{device}
172@findex eject
173Eject a removable medium (use -f to force it).
174ETEXI
175
176    {
177        .name       = "drive_del",
178        .args_type  = "id:B",
179        .params     = "device",
180        .help       = "remove host block device",
181        .cmd        = hmp_drive_del,
182    },
183
184STEXI
185@item drive_del @var{device}
186@findex drive_del
187Remove host block device.  The result is that guest generated IO is no longer
188submitted against the host device underlying the disk.  Once a drive has
189been deleted, the QEMU Block layer returns -EIO which results in IO
190errors in the guest for applications that are reading/writing to the device.
191These errors are always reported to the guest, regardless of the drive's error
192actions (drive options rerror, werror).
193ETEXI
194
195    {
196        .name       = "change",
197        .args_type  = "device:B,target:F,arg:s?,read-only-mode:s?",
198        .params     = "device filename [format [read-only-mode]]",
199        .help       = "change a removable medium, optional format",
200        .cmd        = hmp_change,
201    },
202
203STEXI
204@item change @var{device} @var{setting}
205@findex change
206Change the configuration of a device.
207
208@table @option
209@item change @var{diskdevice} @var{filename} [@var{format} [@var{read-only-mode}]]
210Change the medium for a removable disk device to point to @var{filename}. eg
211
212@example
213(qemu) change ide1-cd0 /path/to/some.iso
214@end example
215
216@var{format} is optional.
217
218@var{read-only-mode} may be used to change the read-only status of the device.
219It accepts the following values:
220
221@table @var
222@item retain
223Retains the current status; this is the default.
224
225@item read-only
226Makes the device read-only.
227
228@item read-write
229Makes the device writable.
230@end table
231
232@item change vnc @var{display},@var{options}
233Change the configuration of the VNC server. The valid syntax for @var{display}
234and @var{options} are described at @ref{sec_invocation}. eg
235
236@example
237(qemu) change vnc localhost:1
238@end example
239
240@item change vnc password [@var{password}]
241
242Change the password associated with the VNC server. If the new password is not
243supplied, the monitor will prompt for it to be entered. VNC passwords are only
244significant up to 8 letters. eg
245
246@example
247(qemu) change vnc password
248Password: ********
249@end example
250
251@end table
252ETEXI
253
254    {
255        .name       = "screendump",
256        .args_type  = "filename:F",
257        .params     = "filename",
258        .help       = "save screen into PPM image 'filename'",
259        .cmd        = hmp_screendump,
260    },
261
262STEXI
263@item screendump @var{filename}
264@findex screendump
265Save screen into PPM image @var{filename}.
266ETEXI
267
268    {
269        .name       = "logfile",
270        .args_type  = "filename:F",
271        .params     = "filename",
272        .help       = "output logs to 'filename'",
273        .cmd        = hmp_logfile,
274    },
275
276STEXI
277@item logfile @var{filename}
278@findex logfile
279Output logs to @var{filename}.
280ETEXI
281
282    {
283        .name       = "trace-event",
284        .args_type  = "name:s,option:b,vcpu:i?",
285        .params     = "name on|off [vcpu]",
286        .help       = "changes status of a specific trace event "
287                      "(vcpu: vCPU to set, default is all)",
288        .cmd = hmp_trace_event,
289        .command_completion = trace_event_completion,
290    },
291
292STEXI
293@item trace-event
294@findex trace-event
295changes status of a trace event
296ETEXI
297
298#if defined(CONFIG_TRACE_SIMPLE)
299    {
300        .name       = "trace-file",
301        .args_type  = "op:s?,arg:F?",
302        .params     = "on|off|flush|set [arg]",
303        .help       = "open, close, or flush trace file, or set a new file name",
304        .cmd        = hmp_trace_file,
305    },
306
307STEXI
308@item trace-file on|off|flush
309@findex trace-file
310Open, close, or flush the trace file.  If no argument is given, the status of the trace file is displayed.
311ETEXI
312#endif
313
314    {
315        .name       = "log",
316        .args_type  = "items:s",
317        .params     = "item1[,...]",
318        .help       = "activate logging of the specified items",
319        .cmd        = hmp_log,
320    },
321
322STEXI
323@item log @var{item1}[,...]
324@findex log
325Activate logging of the specified items.
326ETEXI
327
328    {
329        .name       = "savevm",
330        .args_type  = "name:s?",
331        .params     = "[tag|id]",
332        .help       = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
333        .cmd        = hmp_savevm,
334    },
335
336STEXI
337@item savevm [@var{tag}|@var{id}]
338@findex savevm
339Create a snapshot of the whole virtual machine. If @var{tag} is
340provided, it is used as human readable identifier. If there is already
341a snapshot with the same tag or ID, it is replaced. More info at
342@ref{vm_snapshots}.
343ETEXI
344
345    {
346        .name       = "loadvm",
347        .args_type  = "name:s",
348        .params     = "tag|id",
349        .help       = "restore a VM snapshot from its tag or id",
350        .cmd        = hmp_loadvm,
351        .command_completion = loadvm_completion,
352    },
353
354STEXI
355@item loadvm @var{tag}|@var{id}
356@findex loadvm
357Set the whole virtual machine to the snapshot identified by the tag
358@var{tag} or the unique snapshot ID @var{id}.
359ETEXI
360
361    {
362        .name       = "delvm",
363        .args_type  = "name:s",
364        .params     = "tag|id",
365        .help       = "delete a VM snapshot from its tag or id",
366        .cmd        = hmp_delvm,
367        .command_completion = delvm_completion,
368    },
369
370STEXI
371@item delvm @var{tag}|@var{id}
372@findex delvm
373Delete the snapshot identified by @var{tag} or @var{id}.
374ETEXI
375
376    {
377        .name       = "singlestep",
378        .args_type  = "option:s?",
379        .params     = "[on|off]",
380        .help       = "run emulation in singlestep mode or switch to normal mode",
381        .cmd        = hmp_singlestep,
382    },
383
384STEXI
385@item singlestep [off]
386@findex singlestep
387Run the emulation in single step mode.
388If called with option off, the emulation returns to normal mode.
389ETEXI
390
391    {
392        .name       = "stop",
393        .args_type  = "",
394        .params     = "",
395        .help       = "stop emulation",
396        .cmd        = hmp_stop,
397    },
398
399STEXI
400@item stop
401@findex stop
402Stop emulation.
403ETEXI
404
405    {
406        .name       = "c|cont",
407        .args_type  = "",
408        .params     = "",
409        .help       = "resume emulation",
410        .cmd        = hmp_cont,
411    },
412
413STEXI
414@item c or cont
415@findex cont
416Resume emulation.
417ETEXI
418
419    {
420        .name       = "system_wakeup",
421        .args_type  = "",
422        .params     = "",
423        .help       = "wakeup guest from suspend",
424        .cmd        = hmp_system_wakeup,
425    },
426
427STEXI
428@item system_wakeup
429@findex system_wakeup
430Wakeup guest from suspend.
431ETEXI
432
433    {
434        .name       = "gdbserver",
435        .args_type  = "device:s?",
436        .params     = "[device]",
437        .help       = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
438        .cmd        = hmp_gdbserver,
439    },
440
441STEXI
442@item gdbserver [@var{port}]
443@findex gdbserver
444Start gdbserver session (default @var{port}=1234)
445ETEXI
446
447    {
448        .name       = "x",
449        .args_type  = "fmt:/,addr:l",
450        .params     = "/fmt addr",
451        .help       = "virtual memory dump starting at 'addr'",
452        .cmd        = hmp_memory_dump,
453    },
454
455STEXI
456@item x/fmt @var{addr}
457@findex x
458Virtual memory dump starting at @var{addr}.
459ETEXI
460
461    {
462        .name       = "xp",
463        .args_type  = "fmt:/,addr:l",
464        .params     = "/fmt addr",
465        .help       = "physical memory dump starting at 'addr'",
466        .cmd        = hmp_physical_memory_dump,
467    },
468
469STEXI
470@item xp /@var{fmt} @var{addr}
471@findex xp
472Physical memory dump starting at @var{addr}.
473
474@var{fmt} is a format which tells the command how to format the
475data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
476
477@table @var
478@item count
479is the number of items to be dumped.
480
481@item format
482can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
483c (char) or i (asm instruction).
484
485@item size
486can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
487@code{h} or @code{w} can be specified with the @code{i} format to
488respectively select 16 or 32 bit code instruction size.
489
490@end table
491
492Examples:
493@itemize
494@item
495Dump 10 instructions at the current instruction pointer:
496@example
497(qemu) x/10i $eip
4980x90107063:  ret
4990x90107064:  sti
5000x90107065:  lea    0x0(%esi,1),%esi
5010x90107069:  lea    0x0(%edi,1),%edi
5020x90107070:  ret
5030x90107071:  jmp    0x90107080
5040x90107073:  nop
5050x90107074:  nop
5060x90107075:  nop
5070x90107076:  nop
508@end example
509
510@item
511Dump 80 16 bit values at the start of the video memory.
512@smallexample
513(qemu) xp/80hx 0xb8000
5140x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
5150x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
5160x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
5170x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
5180x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
5190x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
5200x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
5210x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
5220x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
5230x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
524@end smallexample
525@end itemize
526ETEXI
527
528    {
529        .name       = "gpa2hva",
530        .args_type  = "addr:l",
531        .params     = "addr",
532        .help       = "print the host virtual address corresponding to a guest physical address",
533        .cmd        = hmp_gpa2hva,
534    },
535
536STEXI
537@item gpa2hva @var{addr}
538@findex gpa2hva
539Print the host virtual address at which the guest's physical address @var{addr}
540is mapped.
541ETEXI
542
543#ifdef CONFIG_LINUX
544    {
545        .name       = "gpa2hpa",
546        .args_type  = "addr:l",
547        .params     = "addr",
548        .help       = "print the host physical address corresponding to a guest physical address",
549        .cmd        = hmp_gpa2hpa,
550    },
551#endif
552
553STEXI
554@item gpa2hpa @var{addr}
555@findex gpa2hpa
556Print the host physical address at which the guest's physical address @var{addr}
557is mapped.
558ETEXI
559
560    {
561        .name       = "p|print",
562        .args_type  = "fmt:/,val:l",
563        .params     = "/fmt expr",
564        .help       = "print expression value (use $reg for CPU register access)",
565        .cmd        = do_print,
566    },
567
568STEXI
569@item p or print/@var{fmt} @var{expr}
570@findex print
571Print expression value. Only the @var{format} part of @var{fmt} is
572used.
573ETEXI
574
575    {
576        .name       = "i",
577        .args_type  = "fmt:/,addr:i,index:i.",
578        .params     = "/fmt addr",
579        .help       = "I/O port read",
580        .cmd        = hmp_ioport_read,
581    },
582
583STEXI
584@item i/@var{fmt} @var{addr} [.@var{index}]
585@findex i
586Read I/O port.
587ETEXI
588
589    {
590        .name       = "o",
591        .args_type  = "fmt:/,addr:i,val:i",
592        .params     = "/fmt addr value",
593        .help       = "I/O port write",
594        .cmd        = hmp_ioport_write,
595    },
596
597STEXI
598@item o/@var{fmt} @var{addr} @var{val}
599@findex o
600Write to I/O port.
601ETEXI
602
603    {
604        .name       = "sendkey",
605        .args_type  = "keys:s,hold-time:i?",
606        .params     = "keys [hold_ms]",
607        .help       = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
608        .cmd        = hmp_sendkey,
609        .command_completion = sendkey_completion,
610    },
611
612STEXI
613@item sendkey @var{keys}
614@findex sendkey
615Send @var{keys} to the guest. @var{keys} could be the name of the
616key or the raw value in hexadecimal format. Use @code{-} to press
617several keys simultaneously. Example:
618@example
619sendkey ctrl-alt-f1
620@end example
621
622This command is useful to send keys that your graphical user interface
623intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
624ETEXI
625
626    {
627        .name       = "system_reset",
628        .args_type  = "",
629        .params     = "",
630        .help       = "reset the system",
631        .cmd        = hmp_system_reset,
632    },
633
634STEXI
635@item system_reset
636@findex system_reset
637Reset the system.
638ETEXI
639
640    {
641        .name       = "system_powerdown",
642        .args_type  = "",
643        .params     = "",
644        .help       = "send system power down event",
645        .cmd        = hmp_system_powerdown,
646    },
647
648STEXI
649@item system_powerdown
650@findex system_powerdown
651Power down the system (if supported).
652ETEXI
653
654    {
655        .name       = "sum",
656        .args_type  = "start:i,size:i",
657        .params     = "addr size",
658        .help       = "compute the checksum of a memory region",
659        .cmd        = hmp_sum,
660    },
661
662STEXI
663@item sum @var{addr} @var{size}
664@findex sum
665Compute the checksum of a memory region.
666ETEXI
667
668    {
669        .name       = "usb_add",
670        .args_type  = "devname:s",
671        .params     = "device",
672        .help       = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
673        .cmd        = hmp_usb_add,
674    },
675
676STEXI
677@item usb_add @var{devname}
678@findex usb_add
679Add the USB device @var{devname}. This command is deprecated, please
680use @code{device_add} instead. For details of available devices see
681@ref{usb_devices}
682ETEXI
683
684    {
685        .name       = "usb_del",
686        .args_type  = "devname:s",
687        .params     = "device",
688        .help       = "remove USB device 'bus.addr'",
689        .cmd        = hmp_usb_del,
690    },
691
692STEXI
693@item usb_del @var{devname}
694@findex usb_del
695Remove the USB device @var{devname} from the QEMU virtual USB
696hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
697command @code{info usb} to see the devices you can remove. This
698command is deprecated, please use @code{device_del} instead.
699ETEXI
700
701    {
702        .name       = "device_add",
703        .args_type  = "device:O",
704        .params     = "driver[,prop=value][,...]",
705        .help       = "add device, like -device on the command line",
706        .cmd        = hmp_device_add,
707        .command_completion = device_add_completion,
708    },
709
710STEXI
711@item device_add @var{config}
712@findex device_add
713Add device.
714ETEXI
715
716    {
717        .name       = "device_del",
718        .args_type  = "id:s",
719        .params     = "device",
720        .help       = "remove device",
721        .cmd        = hmp_device_del,
722        .command_completion = device_del_completion,
723    },
724
725STEXI
726@item device_del @var{id}
727@findex device_del
728Remove device @var{id}. @var{id} may be a short ID
729or a QOM object path.
730ETEXI
731
732    {
733        .name       = "cpu",
734        .args_type  = "index:i",
735        .params     = "index",
736        .help       = "set the default CPU",
737        .cmd        = hmp_cpu,
738    },
739
740STEXI
741@item cpu @var{index}
742@findex cpu
743Set the default CPU.
744ETEXI
745
746    {
747        .name       = "mouse_move",
748        .args_type  = "dx_str:s,dy_str:s,dz_str:s?",
749        .params     = "dx dy [dz]",
750        .help       = "send mouse move events",
751        .cmd        = hmp_mouse_move,
752    },
753
754STEXI
755@item mouse_move @var{dx} @var{dy} [@var{dz}]
756@findex mouse_move
757Move the active mouse to the specified coordinates @var{dx} @var{dy}
758with optional scroll axis @var{dz}.
759ETEXI
760
761    {
762        .name       = "mouse_button",
763        .args_type  = "button_state:i",
764        .params     = "state",
765        .help       = "change mouse button state (1=L, 2=M, 4=R)",
766        .cmd        = hmp_mouse_button,
767    },
768
769STEXI
770@item mouse_button @var{val}
771@findex mouse_button
772Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
773ETEXI
774
775    {
776        .name       = "mouse_set",
777        .args_type  = "index:i",
778        .params     = "index",
779        .help       = "set which mouse device receives events",
780        .cmd        = hmp_mouse_set,
781    },
782
783STEXI
784@item mouse_set @var{index}
785@findex mouse_set
786Set which mouse device receives events at given @var{index}, index
787can be obtained with
788@example
789info mice
790@end example
791ETEXI
792
793    {
794        .name       = "wavcapture",
795        .args_type  = "path:F,freq:i?,bits:i?,nchannels:i?",
796        .params     = "path [frequency [bits [channels]]]",
797        .help       = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
798        .cmd        = hmp_wavcapture,
799    },
800STEXI
801@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
802@findex wavcapture
803Capture audio into @var{filename}. Using sample rate @var{frequency}
804bits per sample @var{bits} and number of channels @var{channels}.
805
806Defaults:
807@itemize @minus
808@item Sample rate = 44100 Hz - CD quality
809@item Bits = 16
810@item Number of channels = 2 - Stereo
811@end itemize
812ETEXI
813
814    {
815        .name       = "stopcapture",
816        .args_type  = "n:i",
817        .params     = "capture index",
818        .help       = "stop capture",
819        .cmd        = hmp_stopcapture,
820    },
821STEXI
822@item stopcapture @var{index}
823@findex stopcapture
824Stop capture with a given @var{index}, index can be obtained with
825@example
826info capture
827@end example
828ETEXI
829
830    {
831        .name       = "memsave",
832        .args_type  = "val:l,size:i,filename:s",
833        .params     = "addr size file",
834        .help       = "save to disk virtual memory dump starting at 'addr' of size 'size'",
835        .cmd        = hmp_memsave,
836    },
837
838STEXI
839@item memsave @var{addr} @var{size} @var{file}
840@findex memsave
841save to disk virtual memory dump starting at @var{addr} of size @var{size}.
842ETEXI
843
844    {
845        .name       = "pmemsave",
846        .args_type  = "val:l,size:i,filename:s",
847        .params     = "addr size file",
848        .help       = "save to disk physical memory dump starting at 'addr' of size 'size'",
849        .cmd        = hmp_pmemsave,
850    },
851
852STEXI
853@item pmemsave @var{addr} @var{size} @var{file}
854@findex pmemsave
855save to disk physical memory dump starting at @var{addr} of size @var{size}.
856ETEXI
857
858    {
859        .name       = "boot_set",
860        .args_type  = "bootdevice:s",
861        .params     = "bootdevice",
862        .help       = "define new values for the boot device list",
863        .cmd        = hmp_boot_set,
864    },
865
866STEXI
867@item boot_set @var{bootdevicelist}
868@findex boot_set
869Define new values for the boot device list. Those values will override
870the values specified on the command line through the @code{-boot} option.
871
872The values that can be specified here depend on the machine type, but are
873the same that can be specified in the @code{-boot} command line option.
874ETEXI
875
876    {
877        .name       = "nmi",
878        .args_type  = "",
879        .params     = "",
880        .help       = "inject an NMI",
881        .cmd        = hmp_nmi,
882    },
883STEXI
884@item nmi @var{cpu}
885@findex nmi
886Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
887
888ETEXI
889
890    {
891        .name       = "ringbuf_write",
892        .args_type  = "device:s,data:s",
893        .params     = "device data",
894        .help       = "Write to a ring buffer character device",
895        .cmd        = hmp_ringbuf_write,
896        .command_completion = ringbuf_write_completion,
897    },
898
899STEXI
900@item ringbuf_write @var{device} @var{data}
901@findex ringbuf_write
902Write @var{data} to ring buffer character device @var{device}.
903@var{data} must be a UTF-8 string.
904
905ETEXI
906
907    {
908        .name       = "ringbuf_read",
909        .args_type  = "device:s,size:i",
910        .params     = "device size",
911        .help       = "Read from a ring buffer character device",
912        .cmd        = hmp_ringbuf_read,
913        .command_completion = ringbuf_write_completion,
914    },
915
916STEXI
917@item ringbuf_read @var{device}
918@findex ringbuf_read
919Read and print up to @var{size} bytes from ring buffer character
920device @var{device}.
921Certain non-printable characters are printed \uXXXX, where XXXX is the
922character code in hexadecimal.  Character \ is printed \\.
923Bug: can screw up when the buffer contains invalid UTF-8 sequences,
924NUL characters, after the ring buffer lost data, and when reading
925stops because the size limit is reached.
926
927ETEXI
928
929    {
930        .name       = "migrate",
931        .args_type  = "detach:-d,blk:-b,inc:-i,uri:s",
932        .params     = "[-d] [-b] [-i] uri",
933        .help       = "migrate to URI (using -d to not wait for completion)"
934		      "\n\t\t\t -b for migration without shared storage with"
935		      " full copy of disk\n\t\t\t -i for migration without "
936		      "shared storage with incremental copy of disk "
937		      "(base image shared between src and destination)",
938        .cmd        = hmp_migrate,
939    },
940
941
942STEXI
943@item migrate [-d] [-b] [-i] @var{uri}
944@findex migrate
945Migrate to @var{uri} (using -d to not wait for completion).
946	-b for migration with full copy of disk
947	-i for migration with incremental copy of disk (base image is shared)
948ETEXI
949
950    {
951        .name       = "migrate_cancel",
952        .args_type  = "",
953        .params     = "",
954        .help       = "cancel the current VM migration",
955        .cmd        = hmp_migrate_cancel,
956    },
957
958STEXI
959@item migrate_cancel
960@findex migrate_cancel
961Cancel the current VM migration.
962ETEXI
963
964    {
965        .name       = "migrate_continue",
966        .args_type  = "state:s",
967        .params     = "state",
968        .help       = "Continue migration from the given paused state",
969        .cmd        = hmp_migrate_continue,
970    },
971STEXI
972@item migrate_continue @var{state}
973@findex migrate_continue
974Continue migration from the paused state @var{state}
975ETEXI
976
977    {
978        .name       = "migrate_incoming",
979        .args_type  = "uri:s",
980        .params     = "uri",
981        .help       = "Continue an incoming migration from an -incoming defer",
982        .cmd        = hmp_migrate_incoming,
983    },
984
985STEXI
986@item migrate_incoming @var{uri}
987@findex migrate_incoming
988Continue an incoming migration using the @var{uri} (that has the same syntax
989as the -incoming option).
990
991ETEXI
992
993    {
994        .name       = "migrate_set_cache_size",
995        .args_type  = "value:o",
996        .params     = "value",
997        .help       = "set cache size (in bytes) for XBZRLE migrations,"
998                      "the cache size will be rounded down to the nearest "
999                      "power of 2.\n"
1000                      "The cache size affects the number of cache misses."
1001                      "In case of a high cache miss ratio you need to increase"
1002                      " the cache size",
1003        .cmd        = hmp_migrate_set_cache_size,
1004    },
1005
1006STEXI
1007@item migrate_set_cache_size @var{value}
1008@findex migrate_set_cache_size
1009Set cache size to @var{value} (in bytes) for xbzrle migrations.
1010ETEXI
1011
1012    {
1013        .name       = "migrate_set_speed",
1014        .args_type  = "value:o",
1015        .params     = "value",
1016        .help       = "set maximum speed (in bytes) for migrations. "
1017	"Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
1018        .cmd        = hmp_migrate_set_speed,
1019    },
1020
1021STEXI
1022@item migrate_set_speed @var{value}
1023@findex migrate_set_speed
1024Set maximum speed to @var{value} (in bytes) for migrations.
1025ETEXI
1026
1027    {
1028        .name       = "migrate_set_downtime",
1029        .args_type  = "value:T",
1030        .params     = "value",
1031        .help       = "set maximum tolerated downtime (in seconds) for migrations",
1032        .cmd        = hmp_migrate_set_downtime,
1033    },
1034
1035STEXI
1036@item migrate_set_downtime @var{second}
1037@findex migrate_set_downtime
1038Set maximum tolerated downtime (in seconds) for migration.
1039ETEXI
1040
1041    {
1042        .name       = "migrate_set_capability",
1043        .args_type  = "capability:s,state:b",
1044        .params     = "capability state",
1045        .help       = "Enable/Disable the usage of a capability for migration",
1046        .cmd        = hmp_migrate_set_capability,
1047        .command_completion = migrate_set_capability_completion,
1048    },
1049
1050STEXI
1051@item migrate_set_capability @var{capability} @var{state}
1052@findex migrate_set_capability
1053Enable/Disable the usage of a capability @var{capability} for migration.
1054ETEXI
1055
1056    {
1057        .name       = "migrate_set_parameter",
1058        .args_type  = "parameter:s,value:s",
1059        .params     = "parameter value",
1060        .help       = "Set the parameter for migration",
1061        .cmd        = hmp_migrate_set_parameter,
1062        .command_completion = migrate_set_parameter_completion,
1063    },
1064
1065STEXI
1066@item migrate_set_parameter @var{parameter} @var{value}
1067@findex migrate_set_parameter
1068Set the parameter @var{parameter} for migration.
1069ETEXI
1070
1071    {
1072        .name       = "migrate_start_postcopy",
1073        .args_type  = "",
1074        .params     = "",
1075        .help       = "Followup to a migration command to switch the migration"
1076                      " to postcopy mode. The postcopy-ram capability must "
1077                      "be set before the original migration command.",
1078        .cmd        = hmp_migrate_start_postcopy,
1079    },
1080
1081STEXI
1082@item migrate_start_postcopy
1083@findex migrate_start_postcopy
1084Switch in-progress migration to postcopy mode. Ignored after the end of
1085migration (or once already in postcopy).
1086ETEXI
1087
1088    {
1089        .name       = "x_colo_lost_heartbeat",
1090        .args_type  = "",
1091        .params     = "",
1092        .help       = "Tell COLO that heartbeat is lost,\n\t\t\t"
1093                      "a failover or takeover is needed.",
1094        .cmd = hmp_x_colo_lost_heartbeat,
1095    },
1096
1097STEXI
1098@item x_colo_lost_heartbeat
1099@findex x_colo_lost_heartbeat
1100Tell COLO that heartbeat is lost, a failover or takeover is needed.
1101ETEXI
1102
1103    {
1104        .name       = "client_migrate_info",
1105        .args_type  = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1106        .params     = "protocol hostname port tls-port cert-subject",
1107        .help       = "set migration information for remote display",
1108        .cmd        = hmp_client_migrate_info,
1109    },
1110
1111STEXI
1112@item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
1113@findex client_migrate_info
1114Set migration information for remote display.  This makes the server
1115ask the client to automatically reconnect using the new parameters
1116once migration finished successfully.  Only implemented for SPICE.
1117ETEXI
1118
1119    {
1120        .name       = "dump-guest-memory",
1121        .args_type  = "paging:-p,detach:-d,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:i?,length:i?",
1122        .params     = "[-p] [-d] [-z|-l|-s] filename [begin length]",
1123        .help       = "dump guest memory into file 'filename'.\n\t\t\t"
1124                      "-p: do paging to get guest's memory mapping.\n\t\t\t"
1125                      "-d: return immediately (do not wait for completion).\n\t\t\t"
1126                      "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1127                      "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1128                      "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
1129                      "begin: the starting physical address.\n\t\t\t"
1130                      "length: the memory size, in bytes.",
1131        .cmd        = hmp_dump_guest_memory,
1132    },
1133
1134
1135STEXI
1136@item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
1137@item dump-guest-memory [-z|-l|-s] @var{filename}
1138@findex dump-guest-memory
1139Dump guest memory to @var{protocol}. The file can be processed with crash or
1140gdb. Without -z|-l|-s, the dump format is ELF.
1141        -p: do paging to get guest's memory mapping.
1142        -z: dump in kdump-compressed format, with zlib compression.
1143        -l: dump in kdump-compressed format, with lzo compression.
1144        -s: dump in kdump-compressed format, with snappy compression.
1145  filename: dump file name.
1146     begin: the starting physical address. It's optional, and should be
1147            specified together with length.
1148    length: the memory size, in bytes. It's optional, and should be specified
1149            together with begin.
1150ETEXI
1151
1152#if defined(TARGET_S390X)
1153    {
1154        .name       = "dump-skeys",
1155        .args_type  = "filename:F",
1156        .params     = "",
1157        .help       = "Save guest storage keys into file 'filename'.\n",
1158        .cmd        = hmp_dump_skeys,
1159    },
1160#endif
1161
1162STEXI
1163@item dump-skeys @var{filename}
1164@findex dump-skeys
1165Save guest storage keys to a file.
1166ETEXI
1167
1168#if defined(TARGET_S390X)
1169    {
1170        .name       = "migration_mode",
1171        .args_type  = "mode:i",
1172        .params     = "mode",
1173        .help       = "Enables or disables migration mode\n",
1174        .cmd        = hmp_migrationmode,
1175    },
1176#endif
1177
1178STEXI
1179@item migration_mode @var{mode}
1180@findex migration_mode
1181Enables or disables migration mode.
1182ETEXI
1183
1184    {
1185        .name       = "snapshot_blkdev",
1186        .args_type  = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1187        .params     = "[-n] device [new-image-file] [format]",
1188        .help       = "initiates a live snapshot\n\t\t\t"
1189                      "of device. If a new image file is specified, the\n\t\t\t"
1190                      "new image file will become the new root image.\n\t\t\t"
1191                      "If format is specified, the snapshot file will\n\t\t\t"
1192                      "be created in that format.\n\t\t\t"
1193                      "The default format is qcow2.  The -n flag requests QEMU\n\t\t\t"
1194                      "to reuse the image found in new-image-file, instead of\n\t\t\t"
1195                      "recreating it from scratch.",
1196        .cmd        = hmp_snapshot_blkdev,
1197    },
1198
1199STEXI
1200@item snapshot_blkdev
1201@findex snapshot_blkdev
1202Snapshot device, using snapshot file as target if provided
1203ETEXI
1204
1205    {
1206        .name       = "snapshot_blkdev_internal",
1207        .args_type  = "device:B,name:s",
1208        .params     = "device name",
1209        .help       = "take an internal snapshot of device.\n\t\t\t"
1210                      "The format of the image used by device must\n\t\t\t"
1211                      "support it, such as qcow2.\n\t\t\t",
1212        .cmd        = hmp_snapshot_blkdev_internal,
1213    },
1214
1215STEXI
1216@item snapshot_blkdev_internal
1217@findex snapshot_blkdev_internal
1218Take an internal snapshot on device if it support
1219ETEXI
1220
1221    {
1222        .name       = "snapshot_delete_blkdev_internal",
1223        .args_type  = "device:B,name:s,id:s?",
1224        .params     = "device name [id]",
1225        .help       = "delete an internal snapshot of device.\n\t\t\t"
1226                      "If id is specified, qemu will try delete\n\t\t\t"
1227                      "the snapshot matching both id and name.\n\t\t\t"
1228                      "The format of the image used by device must\n\t\t\t"
1229                      "support it, such as qcow2.\n\t\t\t",
1230        .cmd        = hmp_snapshot_delete_blkdev_internal,
1231    },
1232
1233STEXI
1234@item snapshot_delete_blkdev_internal
1235@findex snapshot_delete_blkdev_internal
1236Delete an internal snapshot on device if it support
1237ETEXI
1238
1239    {
1240        .name       = "drive_mirror",
1241        .args_type  = "reuse:-n,full:-f,device:B,target:s,format:s?",
1242        .params     = "[-n] [-f] device target [format]",
1243        .help       = "initiates live storage\n\t\t\t"
1244                      "migration for a device. The device's contents are\n\t\t\t"
1245                      "copied to the new image file, including data that\n\t\t\t"
1246                      "is written after the command is started.\n\t\t\t"
1247                      "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1248                      "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1249                      "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1250                      "so that the result does not need a backing file.\n\t\t\t",
1251        .cmd        = hmp_drive_mirror,
1252    },
1253STEXI
1254@item drive_mirror
1255@findex drive_mirror
1256Start mirroring a block device's writes to a new destination,
1257using the specified target.
1258ETEXI
1259
1260    {
1261        .name       = "drive_backup",
1262        .args_type  = "reuse:-n,full:-f,compress:-c,device:B,target:s,format:s?",
1263        .params     = "[-n] [-f] [-c] device target [format]",
1264        .help       = "initiates a point-in-time\n\t\t\t"
1265                      "copy for a device. The device's contents are\n\t\t\t"
1266                      "copied to the new image file, excluding data that\n\t\t\t"
1267                      "is written after the command is started.\n\t\t\t"
1268                      "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1269                      "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1270                      "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1271                      "so that the result does not need a backing file.\n\t\t\t"
1272                      "The -c flag requests QEMU to compress backup data\n\t\t\t"
1273                      "(if the target format supports it).\n\t\t\t",
1274        .cmd        = hmp_drive_backup,
1275    },
1276STEXI
1277@item drive_backup
1278@findex drive_backup
1279Start a point-in-time copy of a block device to a specificed target.
1280ETEXI
1281
1282    {
1283        .name       = "drive_add",
1284        .args_type  = "node:-n,pci_addr:s,opts:s",
1285        .params     = "[-n] [[<domain>:]<bus>:]<slot>\n"
1286                      "[file=file][,if=type][,bus=n]\n"
1287                      "[,unit=m][,media=d][,index=i]\n"
1288                      "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
1289                      "[,snapshot=on|off][,cache=on|off]\n"
1290                      "[,readonly=on|off][,copy-on-read=on|off]",
1291        .help       = "add drive to PCI storage controller",
1292        .cmd        = hmp_drive_add,
1293    },
1294
1295STEXI
1296@item drive_add
1297@findex drive_add
1298Add drive to PCI storage controller.
1299ETEXI
1300
1301    {
1302        .name       = "pcie_aer_inject_error",
1303        .args_type  = "advisory_non_fatal:-a,correctable:-c,"
1304	              "id:s,error_status:s,"
1305	              "header0:i?,header1:i?,header2:i?,header3:i?,"
1306	              "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1307        .params     = "[-a] [-c] id "
1308                      "<error_status> [<tlp header> [<tlp header prefix>]]",
1309        .help       = "inject pcie aer error\n\t\t\t"
1310	              " -a for advisory non fatal error\n\t\t\t"
1311	              " -c for correctable error\n\t\t\t"
1312                      "<id> = qdev device id\n\t\t\t"
1313                      "<error_status> = error string or 32bit\n\t\t\t"
1314                      "<tlb header> = 32bit x 4\n\t\t\t"
1315                      "<tlb header prefix> = 32bit x 4",
1316        .cmd        = hmp_pcie_aer_inject_error,
1317    },
1318
1319STEXI
1320@item pcie_aer_inject_error
1321@findex pcie_aer_inject_error
1322Inject PCIe AER error
1323ETEXI
1324
1325    {
1326        .name       = "host_net_add",
1327        .args_type  = "device:s,opts:s?",
1328        .params     = "tap|user|socket|vde|netmap|bridge|vhost-user|dump [options]",
1329        .help       = "add host VLAN client (deprecated, use netdev_add instead)",
1330        .cmd        = hmp_host_net_add,
1331        .command_completion = host_net_add_completion,
1332    },
1333
1334STEXI
1335@item host_net_add
1336@findex host_net_add
1337Add host VLAN client. Deprecated, please use @code{netdev_add} instead.
1338ETEXI
1339
1340    {
1341        .name       = "host_net_remove",
1342        .args_type  = "vlan_id:i,device:s",
1343        .params     = "vlan_id name",
1344        .help       = "remove host VLAN client (deprecated, use netdev_del instead)",
1345        .cmd        = hmp_host_net_remove,
1346        .command_completion = host_net_remove_completion,
1347    },
1348
1349STEXI
1350@item host_net_remove
1351@findex host_net_remove
1352Remove host VLAN client. Deprecated, please use @code{netdev_del} instead.
1353ETEXI
1354
1355    {
1356        .name       = "netdev_add",
1357        .args_type  = "netdev:O",
1358        .params     = "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
1359        .help       = "add host network device",
1360        .cmd        = hmp_netdev_add,
1361        .command_completion = netdev_add_completion,
1362    },
1363
1364STEXI
1365@item netdev_add
1366@findex netdev_add
1367Add host network device.
1368ETEXI
1369
1370    {
1371        .name       = "netdev_del",
1372        .args_type  = "id:s",
1373        .params     = "id",
1374        .help       = "remove host network device",
1375        .cmd        = hmp_netdev_del,
1376        .command_completion = netdev_del_completion,
1377    },
1378
1379STEXI
1380@item netdev_del
1381@findex netdev_del
1382Remove host network device.
1383ETEXI
1384
1385    {
1386        .name       = "object_add",
1387        .args_type  = "object:O",
1388        .params     = "[qom-type=]type,id=str[,prop=value][,...]",
1389        .help       = "create QOM object",
1390        .cmd        = hmp_object_add,
1391        .command_completion = object_add_completion,
1392    },
1393
1394STEXI
1395@item object_add
1396@findex object_add
1397Create QOM object.
1398ETEXI
1399
1400    {
1401        .name       = "object_del",
1402        .args_type  = "id:s",
1403        .params     = "id",
1404        .help       = "destroy QOM object",
1405        .cmd        = hmp_object_del,
1406        .command_completion = object_del_completion,
1407    },
1408
1409STEXI
1410@item object_del
1411@findex object_del
1412Destroy QOM object.
1413ETEXI
1414
1415#ifdef CONFIG_SLIRP
1416    {
1417        .name       = "hostfwd_add",
1418        .args_type  = "arg1:s,arg2:s?,arg3:s?",
1419        .params     = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1420        .help       = "redirect TCP or UDP connections from host to guest (requires -net user)",
1421        .cmd        = hmp_hostfwd_add,
1422    },
1423#endif
1424STEXI
1425@item hostfwd_add
1426@findex hostfwd_add
1427Redirect TCP or UDP connections from host to guest (requires -net user).
1428ETEXI
1429
1430#ifdef CONFIG_SLIRP
1431    {
1432        .name       = "hostfwd_remove",
1433        .args_type  = "arg1:s,arg2:s?,arg3:s?",
1434        .params     = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1435        .help       = "remove host-to-guest TCP or UDP redirection",
1436        .cmd        = hmp_hostfwd_remove,
1437    },
1438
1439#endif
1440STEXI
1441@item hostfwd_remove
1442@findex hostfwd_remove
1443Remove host-to-guest TCP or UDP redirection.
1444ETEXI
1445
1446    {
1447        .name       = "balloon",
1448        .args_type  = "value:M",
1449        .params     = "target",
1450        .help       = "request VM to change its memory allocation (in MB)",
1451        .cmd        = hmp_balloon,
1452    },
1453
1454STEXI
1455@item balloon @var{value}
1456@findex balloon
1457Request VM to change its memory allocation to @var{value} (in MB).
1458ETEXI
1459
1460    {
1461        .name       = "set_link",
1462        .args_type  = "name:s,up:b",
1463        .params     = "name on|off",
1464        .help       = "change the link status of a network adapter",
1465        .cmd        = hmp_set_link,
1466        .command_completion = set_link_completion,
1467    },
1468
1469STEXI
1470@item set_link @var{name} [on|off]
1471@findex set_link
1472Switch link @var{name} on (i.e. up) or off (i.e. down).
1473ETEXI
1474
1475    {
1476        .name       = "watchdog_action",
1477        .args_type  = "action:s",
1478        .params     = "[reset|shutdown|poweroff|pause|debug|none]",
1479        .help       = "change watchdog action",
1480        .cmd        = hmp_watchdog_action,
1481        .command_completion = watchdog_action_completion,
1482    },
1483
1484STEXI
1485@item watchdog_action
1486@findex watchdog_action
1487Change watchdog action.
1488ETEXI
1489
1490    {
1491        .name       = "acl_show",
1492        .args_type  = "aclname:s",
1493        .params     = "aclname",
1494        .help       = "list rules in the access control list",
1495        .cmd        = hmp_acl_show,
1496    },
1497
1498STEXI
1499@item acl_show @var{aclname}
1500@findex acl_show
1501List all the matching rules in the access control list, and the default
1502policy. There are currently two named access control lists,
1503@var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1504certificate distinguished name, and SASL username respectively.
1505ETEXI
1506
1507    {
1508        .name       = "acl_policy",
1509        .args_type  = "aclname:s,policy:s",
1510        .params     = "aclname allow|deny",
1511        .help       = "set default access control list policy",
1512        .cmd        = hmp_acl_policy,
1513    },
1514
1515STEXI
1516@item acl_policy @var{aclname} @code{allow|deny}
1517@findex acl_policy
1518Set the default access control list policy, used in the event that
1519none of the explicit rules match. The default policy at startup is
1520always @code{deny}.
1521ETEXI
1522
1523    {
1524        .name       = "acl_add",
1525        .args_type  = "aclname:s,match:s,policy:s,index:i?",
1526        .params     = "aclname match allow|deny [index]",
1527        .help       = "add a match rule to the access control list",
1528        .cmd        = hmp_acl_add,
1529    },
1530
1531STEXI
1532@item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1533@findex acl_add
1534Add a match rule to the access control list, allowing or denying access.
1535The match will normally be an exact username or x509 distinguished name,
1536but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1537allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
1538normally be appended to the end of the ACL, but can be inserted
1539earlier in the list if the optional @var{index} parameter is supplied.
1540ETEXI
1541
1542    {
1543        .name       = "acl_remove",
1544        .args_type  = "aclname:s,match:s",
1545        .params     = "aclname match",
1546        .help       = "remove a match rule from the access control list",
1547        .cmd        = hmp_acl_remove,
1548    },
1549
1550STEXI
1551@item acl_remove @var{aclname} @var{match}
1552@findex acl_remove
1553Remove the specified match rule from the access control list.
1554ETEXI
1555
1556    {
1557        .name       = "acl_reset",
1558        .args_type  = "aclname:s",
1559        .params     = "aclname",
1560        .help       = "reset the access control list",
1561        .cmd        = hmp_acl_reset,
1562    },
1563
1564STEXI
1565@item acl_reset @var{aclname}
1566@findex acl_reset
1567Remove all matches from the access control list, and set the default
1568policy back to @code{deny}.
1569ETEXI
1570
1571    {
1572        .name       = "nbd_server_start",
1573        .args_type  = "all:-a,writable:-w,uri:s",
1574        .params     = "nbd_server_start [-a] [-w] host:port",
1575        .help       = "serve block devices on the given host and port",
1576        .cmd        = hmp_nbd_server_start,
1577    },
1578STEXI
1579@item nbd_server_start @var{host}:@var{port}
1580@findex nbd_server_start
1581Start an NBD server on the given host and/or port.  If the @option{-a}
1582option is included, all of the virtual machine's block devices that
1583have an inserted media on them are automatically exported; in this case,
1584the @option{-w} option makes the devices writable too.
1585ETEXI
1586
1587    {
1588        .name       = "nbd_server_add",
1589        .args_type  = "writable:-w,device:B",
1590        .params     = "nbd_server_add [-w] device",
1591        .help       = "export a block device via NBD",
1592        .cmd        = hmp_nbd_server_add,
1593    },
1594STEXI
1595@item nbd_server_add @var{device}
1596@findex nbd_server_add
1597Export a block device through QEMU's NBD server, which must be started
1598beforehand with @command{nbd_server_start}.  The @option{-w} option makes the
1599exported device writable too.
1600ETEXI
1601
1602    {
1603        .name       = "nbd_server_stop",
1604        .args_type  = "",
1605        .params     = "nbd_server_stop",
1606        .help       = "stop serving block devices using the NBD protocol",
1607        .cmd        = hmp_nbd_server_stop,
1608    },
1609STEXI
1610@item nbd_server_stop
1611@findex nbd_server_stop
1612Stop the QEMU embedded NBD server.
1613ETEXI
1614
1615
1616#if defined(TARGET_I386)
1617
1618    {
1619        .name       = "mce",
1620        .args_type  = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1621        .params     = "[-b] cpu bank status mcgstatus addr misc",
1622        .help       = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1623        .cmd        = hmp_mce,
1624    },
1625
1626#endif
1627STEXI
1628@item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1629@findex mce (x86)
1630Inject an MCE on the given CPU (x86 only).
1631ETEXI
1632
1633    {
1634        .name       = "getfd",
1635        .args_type  = "fdname:s",
1636        .params     = "getfd name",
1637        .help       = "receive a file descriptor via SCM rights and assign it a name",
1638        .cmd        = hmp_getfd,
1639    },
1640
1641STEXI
1642@item getfd @var{fdname}
1643@findex getfd
1644If a file descriptor is passed alongside this command using the SCM_RIGHTS
1645mechanism on unix sockets, it is stored using the name @var{fdname} for
1646later use by other monitor commands.
1647ETEXI
1648
1649    {
1650        .name       = "closefd",
1651        .args_type  = "fdname:s",
1652        .params     = "closefd name",
1653        .help       = "close a file descriptor previously passed via SCM rights",
1654        .cmd        = hmp_closefd,
1655    },
1656
1657STEXI
1658@item closefd @var{fdname}
1659@findex closefd
1660Close the file descriptor previously assigned to @var{fdname} using the
1661@code{getfd} command. This is only needed if the file descriptor was never
1662used by another monitor command.
1663ETEXI
1664
1665    {
1666        .name       = "block_passwd",
1667        .args_type  = "device:B,password:s",
1668        .params     = "block_passwd device password",
1669        .help       = "set the password of encrypted block devices",
1670        .cmd        = hmp_block_passwd,
1671    },
1672
1673STEXI
1674@item block_passwd @var{device} @var{password}
1675@findex block_passwd
1676Set the encrypted device @var{device} password to @var{password}
1677
1678This command is now obsolete and will always return an error since 2.10
1679ETEXI
1680
1681    {
1682        .name       = "block_set_io_throttle",
1683        .args_type  = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1684        .params     = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1685        .help       = "change I/O throttle limits for a block drive",
1686        .cmd        = hmp_block_set_io_throttle,
1687    },
1688
1689STEXI
1690@item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1691@findex block_set_io_throttle
1692Change 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}
1693ETEXI
1694
1695    {
1696        .name       = "set_password",
1697        .args_type  = "protocol:s,password:s,connected:s?",
1698        .params     = "protocol password action-if-connected",
1699        .help       = "set spice/vnc password",
1700        .cmd        = hmp_set_password,
1701    },
1702
1703STEXI
1704@item set_password [ vnc | spice ] password [ action-if-connected ]
1705@findex set_password
1706Change spice/vnc password.  Use zero to make the password stay valid
1707forever.  @var{action-if-connected} specifies what should happen in
1708case a connection is established: @var{fail} makes the password change
1709fail.  @var{disconnect} changes the password and disconnects the
1710client.  @var{keep} changes the password and keeps the connection up.
1711@var{keep} is the default.
1712ETEXI
1713
1714    {
1715        .name       = "expire_password",
1716        .args_type  = "protocol:s,time:s",
1717        .params     = "protocol time",
1718        .help       = "set spice/vnc password expire-time",
1719        .cmd        = hmp_expire_password,
1720    },
1721
1722STEXI
1723@item expire_password [ vnc | spice ] expire-time
1724@findex expire_password
1725Specify when a password for spice/vnc becomes
1726invalid. @var{expire-time} accepts:
1727
1728@table @var
1729@item now
1730Invalidate password instantly.
1731
1732@item never
1733Password stays valid forever.
1734
1735@item +nsec
1736Password stays valid for @var{nsec} seconds starting now.
1737
1738@item nsec
1739Password is invalidated at the given time.  @var{nsec} are the seconds
1740passed since 1970, i.e. unix epoch.
1741
1742@end table
1743ETEXI
1744
1745    {
1746        .name       = "chardev-add",
1747        .args_type  = "args:s",
1748        .params     = "args",
1749        .help       = "add chardev",
1750        .cmd        = hmp_chardev_add,
1751        .command_completion = chardev_add_completion,
1752    },
1753
1754STEXI
1755@item chardev-add args
1756@findex chardev-add
1757chardev-add accepts the same parameters as the -chardev command line switch.
1758
1759ETEXI
1760
1761    {
1762        .name       = "chardev-change",
1763        .args_type  = "id:s,args:s",
1764        .params     = "id args",
1765        .help       = "change chardev",
1766        .cmd        = hmp_chardev_change,
1767    },
1768
1769STEXI
1770@item chardev-change args
1771@findex chardev-change
1772chardev-change accepts existing chardev @var{id} and then the same arguments
1773as the -chardev command line switch (except for "id").
1774
1775ETEXI
1776
1777    {
1778        .name       = "chardev-remove",
1779        .args_type  = "id:s",
1780        .params     = "id",
1781        .help       = "remove chardev",
1782        .cmd        = hmp_chardev_remove,
1783        .command_completion = chardev_remove_completion,
1784    },
1785
1786STEXI
1787@item chardev-remove id
1788@findex chardev-remove
1789Removes the chardev @var{id}.
1790
1791ETEXI
1792
1793    {
1794        .name       = "chardev-send-break",
1795        .args_type  = "id:s",
1796        .params     = "id",
1797        .help       = "send a break on chardev",
1798        .cmd        = hmp_chardev_send_break,
1799        .command_completion = chardev_remove_completion,
1800    },
1801
1802STEXI
1803@item chardev-send-break id
1804@findex chardev-send-break
1805Send a break on the chardev @var{id}.
1806
1807ETEXI
1808
1809    {
1810        .name       = "qemu-io",
1811        .args_type  = "device:B,command:s",
1812        .params     = "[device] \"[command]\"",
1813        .help       = "run a qemu-io command on a block device",
1814        .cmd        = hmp_qemu_io,
1815    },
1816
1817STEXI
1818@item qemu-io @var{device} @var{command}
1819@findex qemu-io
1820Executes a qemu-io command on the given block device.
1821
1822ETEXI
1823
1824    {
1825        .name       = "cpu-add",
1826        .args_type  = "id:i",
1827        .params     = "id",
1828        .help       = "add cpu",
1829        .cmd        = hmp_cpu_add,
1830    },
1831
1832STEXI
1833@item cpu-add @var{id}
1834@findex cpu-add
1835Add CPU with id @var{id}
1836ETEXI
1837
1838    {
1839        .name       = "qom-list",
1840        .args_type  = "path:s?",
1841        .params     = "path",
1842        .help       = "list QOM properties",
1843        .cmd        = hmp_qom_list,
1844    },
1845
1846STEXI
1847@item qom-list [@var{path}]
1848Print QOM properties of object at location @var{path}
1849ETEXI
1850
1851    {
1852        .name       = "qom-set",
1853        .args_type  = "path:s,property:s,value:s",
1854        .params     = "path property value",
1855        .help       = "set QOM property",
1856        .cmd        = hmp_qom_set,
1857    },
1858
1859STEXI
1860@item qom-set @var{path} @var{property} @var{value}
1861Set QOM property @var{property} of object at location @var{path} to value @var{value}
1862ETEXI
1863
1864    {
1865        .name       = "info",
1866        .args_type  = "item:s?",
1867        .params     = "[subcommand]",
1868        .help       = "show various information about the system state",
1869        .cmd        = hmp_info_help,
1870        .sub_table  = info_cmds,
1871    },
1872
1873STEXI
1874@end table
1875ETEXI
1876