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