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