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