xref: /openbmc/qemu/hmp-commands.hx (revision 786a4ea8)
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        .user_print = monitor_user_noop,
182        .mhandler.cmd_new = hmp_drive_del,
183    },
184
185STEXI
186@item drive_del @var{device}
187@findex drive_del
188Remove host block device.  The result is that guest generated IO is no longer
189submitted against the host device underlying the disk.  Once a drive has
190been deleted, the QEMU Block layer returns -EIO which results in IO
191errors in the guest for applications that are reading/writing to the device.
192These errors are always reported to the guest, regardless of the drive's error
193actions (drive options rerror, werror).
194ETEXI
195
196    {
197        .name       = "change",
198        .args_type  = "device:B,target:F,arg:s?",
199        .params     = "device filename [format]",
200        .help       = "change a removable medium, optional format",
201        .mhandler.cmd = hmp_change,
202    },
203
204STEXI
205@item change @var{device} @var{setting}
206@findex change
207Change the configuration of a device.
208
209@table @option
210@item change @var{diskdevice} @var{filename} [@var{format}]
211Change the medium for a removable disk device to point to @var{filename}. eg
212
213@example
214(qemu) change ide1-cd0 /path/to/some.iso
215@end example
216
217@var{format} is optional.
218
219@item change vnc @var{display},@var{options}
220Change the configuration of the VNC server. The valid syntax for @var{display}
221and @var{options} are described at @ref{sec_invocation}. eg
222
223@example
224(qemu) change vnc localhost:1
225@end example
226
227@item change vnc password [@var{password}]
228
229Change the password associated with the VNC server. If the new password is not
230supplied, the monitor will prompt for it to be entered. VNC passwords are only
231significant up to 8 letters. eg
232
233@example
234(qemu) change vnc password
235Password: ********
236@end example
237
238@end table
239ETEXI
240
241    {
242        .name       = "screendump",
243        .args_type  = "filename:F",
244        .params     = "filename",
245        .help       = "save screen into PPM image 'filename'",
246        .mhandler.cmd = hmp_screendump,
247    },
248
249STEXI
250@item screendump @var{filename}
251@findex screendump
252Save screen into PPM image @var{filename}.
253ETEXI
254
255    {
256        .name       = "logfile",
257        .args_type  = "filename:F",
258        .params     = "filename",
259        .help       = "output logs to 'filename'",
260        .mhandler.cmd = hmp_logfile,
261    },
262
263STEXI
264@item logfile @var{filename}
265@findex logfile
266Output logs to @var{filename}.
267ETEXI
268
269    {
270        .name       = "trace-event",
271        .args_type  = "name:s,option:b",
272        .params     = "name on|off",
273        .help       = "changes status of a specific trace event",
274        .mhandler.cmd = hmp_trace_event,
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        .user_print = monitor_user_noop,
658        .mhandler.cmd_new = do_device_add,
659        .command_completion = device_add_completion,
660    },
661
662STEXI
663@item device_add @var{config}
664@findex device_add
665Add device.
666ETEXI
667
668    {
669        .name       = "device_del",
670        .args_type  = "id:s",
671        .params     = "device",
672        .help       = "remove device",
673        .mhandler.cmd = hmp_device_del,
674        .command_completion = device_del_completion,
675    },
676
677STEXI
678@item device_del @var{id}
679@findex device_del
680Remove device @var{id}.
681ETEXI
682
683    {
684        .name       = "cpu",
685        .args_type  = "index:i",
686        .params     = "index",
687        .help       = "set the default CPU",
688        .mhandler.cmd = hmp_cpu,
689    },
690
691STEXI
692@item cpu @var{index}
693@findex cpu
694Set the default CPU.
695ETEXI
696
697    {
698        .name       = "mouse_move",
699        .args_type  = "dx_str:s,dy_str:s,dz_str:s?",
700        .params     = "dx dy [dz]",
701        .help       = "send mouse move events",
702        .mhandler.cmd = hmp_mouse_move,
703    },
704
705STEXI
706@item mouse_move @var{dx} @var{dy} [@var{dz}]
707@findex mouse_move
708Move the active mouse to the specified coordinates @var{dx} @var{dy}
709with optional scroll axis @var{dz}.
710ETEXI
711
712    {
713        .name       = "mouse_button",
714        .args_type  = "button_state:i",
715        .params     = "state",
716        .help       = "change mouse button state (1=L, 2=M, 4=R)",
717        .mhandler.cmd = hmp_mouse_button,
718    },
719
720STEXI
721@item mouse_button @var{val}
722@findex mouse_button
723Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
724ETEXI
725
726    {
727        .name       = "mouse_set",
728        .args_type  = "index:i",
729        .params     = "index",
730        .help       = "set which mouse device receives events",
731        .mhandler.cmd = hmp_mouse_set,
732    },
733
734STEXI
735@item mouse_set @var{index}
736@findex mouse_set
737Set which mouse device receives events at given @var{index}, index
738can be obtained with
739@example
740info mice
741@end example
742ETEXI
743
744    {
745        .name       = "wavcapture",
746        .args_type  = "path:F,freq:i?,bits:i?,nchannels:i?",
747        .params     = "path [frequency [bits [channels]]]",
748        .help       = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
749        .mhandler.cmd = hmp_wavcapture,
750    },
751STEXI
752@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
753@findex wavcapture
754Capture audio into @var{filename}. Using sample rate @var{frequency}
755bits per sample @var{bits} and number of channels @var{channels}.
756
757Defaults:
758@itemize @minus
759@item Sample rate = 44100 Hz - CD quality
760@item Bits = 16
761@item Number of channels = 2 - Stereo
762@end itemize
763ETEXI
764
765    {
766        .name       = "stopcapture",
767        .args_type  = "n:i",
768        .params     = "capture index",
769        .help       = "stop capture",
770        .mhandler.cmd = hmp_stopcapture,
771    },
772STEXI
773@item stopcapture @var{index}
774@findex stopcapture
775Stop capture with a given @var{index}, index can be obtained with
776@example
777info capture
778@end example
779ETEXI
780
781    {
782        .name       = "memsave",
783        .args_type  = "val:l,size:i,filename:s",
784        .params     = "addr size file",
785        .help       = "save to disk virtual memory dump starting at 'addr' of size 'size'",
786        .mhandler.cmd = hmp_memsave,
787    },
788
789STEXI
790@item memsave @var{addr} @var{size} @var{file}
791@findex memsave
792save to disk virtual memory dump starting at @var{addr} of size @var{size}.
793ETEXI
794
795    {
796        .name       = "pmemsave",
797        .args_type  = "val:l,size:i,filename:s",
798        .params     = "addr size file",
799        .help       = "save to disk physical memory dump starting at 'addr' of size 'size'",
800        .mhandler.cmd = hmp_pmemsave,
801    },
802
803STEXI
804@item pmemsave @var{addr} @var{size} @var{file}
805@findex pmemsave
806save to disk physical memory dump starting at @var{addr} of size @var{size}.
807ETEXI
808
809    {
810        .name       = "boot_set",
811        .args_type  = "bootdevice:s",
812        .params     = "bootdevice",
813        .help       = "define new values for the boot device list",
814        .mhandler.cmd = hmp_boot_set,
815    },
816
817STEXI
818@item boot_set @var{bootdevicelist}
819@findex boot_set
820Define new values for the boot device list. Those values will override
821the values specified on the command line through the @code{-boot} option.
822
823The values that can be specified here depend on the machine type, but are
824the same that can be specified in the @code{-boot} command line option.
825ETEXI
826
827    {
828        .name       = "nmi",
829        .args_type  = "",
830        .params     = "",
831        .help       = "inject an NMI",
832        .mhandler.cmd = hmp_nmi,
833    },
834STEXI
835@item nmi @var{cpu}
836@findex nmi
837Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
838
839ETEXI
840
841    {
842        .name       = "ringbuf_write",
843        .args_type  = "device:s,data:s",
844        .params     = "device data",
845        .help       = "Write to a ring buffer character device",
846        .mhandler.cmd = hmp_ringbuf_write,
847        .command_completion = ringbuf_write_completion,
848    },
849
850STEXI
851@item ringbuf_write @var{device} @var{data}
852@findex ringbuf_write
853Write @var{data} to ring buffer character device @var{device}.
854@var{data} must be a UTF-8 string.
855
856ETEXI
857
858    {
859        .name       = "ringbuf_read",
860        .args_type  = "device:s,size:i",
861        .params     = "device size",
862        .help       = "Read from a ring buffer character device",
863        .mhandler.cmd = hmp_ringbuf_read,
864        .command_completion = ringbuf_write_completion,
865    },
866
867STEXI
868@item ringbuf_read @var{device}
869@findex ringbuf_read
870Read and print up to @var{size} bytes from ring buffer character
871device @var{device}.
872Certain non-printable characters are printed \uXXXX, where XXXX is the
873character code in hexadecimal.  Character \ is printed \\.
874Bug: can screw up when the buffer contains invalid UTF-8 sequences,
875NUL characters, after the ring buffer lost data, and when reading
876stops because the size limit is reached.
877
878ETEXI
879
880    {
881        .name       = "migrate",
882        .args_type  = "detach:-d,blk:-b,inc:-i,uri:s",
883        .params     = "[-d] [-b] [-i] uri",
884        .help       = "migrate to URI (using -d to not wait for completion)"
885		      "\n\t\t\t -b for migration without shared storage with"
886		      " full copy of disk\n\t\t\t -i for migration without "
887		      "shared storage with incremental copy of disk "
888		      "(base image shared between src and destination)",
889        .mhandler.cmd = hmp_migrate,
890    },
891
892
893STEXI
894@item migrate [-d] [-b] [-i] @var{uri}
895@findex migrate
896Migrate to @var{uri} (using -d to not wait for completion).
897	-b for migration with full copy of disk
898	-i for migration with incremental copy of disk (base image is shared)
899ETEXI
900
901    {
902        .name       = "migrate_cancel",
903        .args_type  = "",
904        .params     = "",
905        .help       = "cancel the current VM migration",
906        .mhandler.cmd = hmp_migrate_cancel,
907    },
908
909STEXI
910@item migrate_cancel
911@findex migrate_cancel
912Cancel the current VM migration.
913
914ETEXI
915
916    {
917        .name       = "migrate_incoming",
918        .args_type  = "uri:s",
919        .params     = "uri",
920        .help       = "Continue an incoming migration from an -incoming defer",
921        .mhandler.cmd = hmp_migrate_incoming,
922    },
923
924STEXI
925@item migrate_incoming @var{uri}
926@findex migrate_incoming
927Continue an incoming migration using the @var{uri} (that has the same syntax
928as the -incoming option).
929
930ETEXI
931
932    {
933        .name       = "migrate_set_cache_size",
934        .args_type  = "value:o",
935        .params     = "value",
936        .help       = "set cache size (in bytes) for XBZRLE migrations,"
937                      "the cache size will be rounded down to the nearest "
938                      "power of 2.\n"
939                      "The cache size affects the number of cache misses."
940                      "In case of a high cache miss ratio you need to increase"
941                      " the cache size",
942        .mhandler.cmd = hmp_migrate_set_cache_size,
943    },
944
945STEXI
946@item migrate_set_cache_size @var{value}
947@findex migrate_set_cache_size
948Set cache size to @var{value} (in bytes) for xbzrle migrations.
949ETEXI
950
951    {
952        .name       = "migrate_set_speed",
953        .args_type  = "value:o",
954        .params     = "value",
955        .help       = "set maximum speed (in bytes) for migrations. "
956	"Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
957        .mhandler.cmd = hmp_migrate_set_speed,
958    },
959
960STEXI
961@item migrate_set_speed @var{value}
962@findex migrate_set_speed
963Set maximum speed to @var{value} (in bytes) for migrations.
964ETEXI
965
966    {
967        .name       = "migrate_set_downtime",
968        .args_type  = "value:T",
969        .params     = "value",
970        .help       = "set maximum tolerated downtime (in seconds) for migrations",
971        .mhandler.cmd = hmp_migrate_set_downtime,
972    },
973
974STEXI
975@item migrate_set_downtime @var{second}
976@findex migrate_set_downtime
977Set maximum tolerated downtime (in seconds) for migration.
978ETEXI
979
980    {
981        .name       = "migrate_set_capability",
982        .args_type  = "capability:s,state:b",
983        .params     = "capability state",
984        .help       = "Enable/Disable the usage of a capability for migration",
985        .mhandler.cmd = hmp_migrate_set_capability,
986        .command_completion = migrate_set_capability_completion,
987    },
988
989STEXI
990@item migrate_set_capability @var{capability} @var{state}
991@findex migrate_set_capability
992Enable/Disable the usage of a capability @var{capability} for migration.
993ETEXI
994
995    {
996        .name       = "client_migrate_info",
997        .args_type  = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
998        .params     = "protocol hostname port tls-port cert-subject",
999        .help       = "send migration info to spice/vnc client",
1000        .user_print = monitor_user_noop,
1001        .mhandler.cmd_new = client_migrate_info,
1002    },
1003
1004STEXI
1005@item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
1006@findex client_migrate_info
1007Set the spice/vnc connection info for the migration target.  The spice/vnc
1008server will ask the spice/vnc client to automatically reconnect using the
1009new parameters (if specified) once the vm migration finished successfully.
1010ETEXI
1011
1012    {
1013        .name       = "dump-guest-memory",
1014        .args_type  = "paging:-p,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:i?,length:i?",
1015        .params     = "[-p] [-z|-l|-s] filename [begin length]",
1016        .help       = "dump guest memory into file 'filename'.\n\t\t\t"
1017                      "-p: do paging to get guest's memory mapping.\n\t\t\t"
1018                      "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1019                      "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1020                      "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
1021                      "begin: the starting physical address.\n\t\t\t"
1022                      "length: the memory size, in bytes.",
1023        .mhandler.cmd = hmp_dump_guest_memory,
1024    },
1025
1026
1027STEXI
1028@item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
1029@item dump-guest-memory [-z|-l|-s] @var{filename}
1030@findex dump-guest-memory
1031Dump guest memory to @var{protocol}. The file can be processed with crash or
1032gdb. Without -z|-l|-s, the dump format is ELF.
1033        -p: do paging to get guest's memory mapping.
1034        -z: dump in kdump-compressed format, with zlib compression.
1035        -l: dump in kdump-compressed format, with lzo compression.
1036        -s: dump in kdump-compressed format, with snappy compression.
1037  filename: dump file name.
1038     begin: the starting physical address. It's optional, and should be
1039            specified together with length.
1040    length: the memory size, in bytes. It's optional, and should be specified
1041            together with begin.
1042ETEXI
1043
1044    {
1045        .name       = "snapshot_blkdev",
1046        .args_type  = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1047        .params     = "[-n] device [new-image-file] [format]",
1048        .help       = "initiates a live snapshot\n\t\t\t"
1049                      "of device. If a new image file is specified, the\n\t\t\t"
1050                      "new image file will become the new root image.\n\t\t\t"
1051                      "If format is specified, the snapshot file will\n\t\t\t"
1052                      "be created in that format.\n\t\t\t"
1053                      "The default format is qcow2.  The -n flag requests QEMU\n\t\t\t"
1054                      "to reuse the image found in new-image-file, instead of\n\t\t\t"
1055                      "recreating it from scratch.",
1056        .mhandler.cmd = hmp_snapshot_blkdev,
1057    },
1058
1059STEXI
1060@item snapshot_blkdev
1061@findex snapshot_blkdev
1062Snapshot device, using snapshot file as target if provided
1063ETEXI
1064
1065    {
1066        .name       = "snapshot_blkdev_internal",
1067        .args_type  = "device:B,name:s",
1068        .params     = "device name",
1069        .help       = "take an internal snapshot of device.\n\t\t\t"
1070                      "The format of the image used by device must\n\t\t\t"
1071                      "support it, such as qcow2.\n\t\t\t",
1072        .mhandler.cmd = hmp_snapshot_blkdev_internal,
1073    },
1074
1075STEXI
1076@item snapshot_blkdev_internal
1077@findex snapshot_blkdev_internal
1078Take an internal snapshot on device if it support
1079ETEXI
1080
1081    {
1082        .name       = "snapshot_delete_blkdev_internal",
1083        .args_type  = "device:B,name:s,id:s?",
1084        .params     = "device name [id]",
1085        .help       = "delete an internal snapshot of device.\n\t\t\t"
1086                      "If id is specified, qemu will try delete\n\t\t\t"
1087                      "the snapshot matching both id and name.\n\t\t\t"
1088                      "The format of the image used by device must\n\t\t\t"
1089                      "support it, such as qcow2.\n\t\t\t",
1090        .mhandler.cmd = hmp_snapshot_delete_blkdev_internal,
1091    },
1092
1093STEXI
1094@item snapshot_delete_blkdev_internal
1095@findex snapshot_delete_blkdev_internal
1096Delete an internal snapshot on device if it support
1097ETEXI
1098
1099    {
1100        .name       = "drive_mirror",
1101        .args_type  = "reuse:-n,full:-f,device:B,target:s,format:s?",
1102        .params     = "[-n] [-f] device target [format]",
1103        .help       = "initiates live storage\n\t\t\t"
1104                      "migration for a device. The device's contents are\n\t\t\t"
1105                      "copied to the new image file, including data that\n\t\t\t"
1106                      "is written after the command is started.\n\t\t\t"
1107                      "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1108                      "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1109                      "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1110                      "so that the result does not need a backing file.\n\t\t\t",
1111        .mhandler.cmd = hmp_drive_mirror,
1112    },
1113STEXI
1114@item drive_mirror
1115@findex drive_mirror
1116Start mirroring a block device's writes to a new destination,
1117using the specified target.
1118ETEXI
1119
1120    {
1121        .name       = "drive_backup",
1122        .args_type  = "reuse:-n,full:-f,device:B,target:s,format:s?",
1123        .params     = "[-n] [-f] device target [format]",
1124        .help       = "initiates a point-in-time\n\t\t\t"
1125                      "copy for a device. The device's contents are\n\t\t\t"
1126                      "copied to the new image file, excluding data that\n\t\t\t"
1127                      "is written after the command is started.\n\t\t\t"
1128                      "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1129                      "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1130                      "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1131                      "so that the result does not need a backing file.\n\t\t\t",
1132        .mhandler.cmd = hmp_drive_backup,
1133    },
1134STEXI
1135@item drive_backup
1136@findex drive_backup
1137Start a point-in-time copy of a block device to a specificed target.
1138ETEXI
1139
1140    {
1141        .name       = "drive_add",
1142        .args_type  = "pci_addr:s,opts:s",
1143        .params     = "[[<domain>:]<bus>:]<slot>\n"
1144                      "[file=file][,if=type][,bus=n]\n"
1145                      "[,unit=m][,media=d][,index=i]\n"
1146                      "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
1147                      "[,snapshot=on|off][,cache=on|off]\n"
1148                      "[,readonly=on|off][,copy-on-read=on|off]",
1149        .help       = "add drive to PCI storage controller",
1150        .mhandler.cmd = hmp_drive_add,
1151    },
1152
1153STEXI
1154@item drive_add
1155@findex drive_add
1156Add drive to PCI storage controller.
1157ETEXI
1158
1159    {
1160        .name       = "pcie_aer_inject_error",
1161        .args_type  = "advisory_non_fatal:-a,correctable:-c,"
1162	              "id:s,error_status:s,"
1163	              "header0:i?,header1:i?,header2:i?,header3:i?,"
1164	              "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1165        .params     = "[-a] [-c] id "
1166                      "<error_status> [<tlp header> [<tlp header prefix>]]",
1167        .help       = "inject pcie aer error\n\t\t\t"
1168	              " -a for advisory non fatal error\n\t\t\t"
1169	              " -c for correctable error\n\t\t\t"
1170                      "<id> = qdev device id\n\t\t\t"
1171                      "<error_status> = error string or 32bit\n\t\t\t"
1172                      "<tlb header> = 32bit x 4\n\t\t\t"
1173                      "<tlb header prefix> = 32bit x 4",
1174        .user_print  = pcie_aer_inject_error_print,
1175        .mhandler.cmd_new = hmp_pcie_aer_inject_error,
1176    },
1177
1178STEXI
1179@item pcie_aer_inject_error
1180@findex pcie_aer_inject_error
1181Inject PCIe AER error
1182ETEXI
1183
1184    {
1185        .name       = "host_net_add",
1186        .args_type  = "device:s,opts:s?",
1187        .params     = "tap|user|socket|vde|netmap|bridge|vhost-user|dump [options]",
1188        .help       = "add host VLAN client",
1189        .mhandler.cmd = hmp_host_net_add,
1190        .command_completion = host_net_add_completion,
1191    },
1192
1193STEXI
1194@item host_net_add
1195@findex host_net_add
1196Add host VLAN client.
1197ETEXI
1198
1199    {
1200        .name       = "host_net_remove",
1201        .args_type  = "vlan_id:i,device:s",
1202        .params     = "vlan_id name",
1203        .help       = "remove host VLAN client",
1204        .mhandler.cmd = hmp_host_net_remove,
1205        .command_completion = host_net_remove_completion,
1206    },
1207
1208STEXI
1209@item host_net_remove
1210@findex host_net_remove
1211Remove host VLAN client.
1212ETEXI
1213
1214    {
1215        .name       = "netdev_add",
1216        .args_type  = "netdev:O",
1217        .params     = "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
1218        .help       = "add host network device",
1219        .mhandler.cmd = hmp_netdev_add,
1220        .command_completion = netdev_add_completion,
1221    },
1222
1223STEXI
1224@item netdev_add
1225@findex netdev_add
1226Add host network device.
1227ETEXI
1228
1229    {
1230        .name       = "netdev_del",
1231        .args_type  = "id:s",
1232        .params     = "id",
1233        .help       = "remove host network device",
1234        .mhandler.cmd = hmp_netdev_del,
1235        .command_completion = netdev_del_completion,
1236    },
1237
1238STEXI
1239@item netdev_del
1240@findex netdev_del
1241Remove host network device.
1242ETEXI
1243
1244    {
1245        .name       = "object_add",
1246        .args_type  = "object:O",
1247        .params     = "[qom-type=]type,id=str[,prop=value][,...]",
1248        .help       = "create QOM object",
1249        .mhandler.cmd = hmp_object_add,
1250        .command_completion = object_add_completion,
1251    },
1252
1253STEXI
1254@item object_add
1255@findex object_add
1256Create QOM object.
1257ETEXI
1258
1259    {
1260        .name       = "object_del",
1261        .args_type  = "id:s",
1262        .params     = "id",
1263        .help       = "destroy QOM object",
1264        .mhandler.cmd = hmp_object_del,
1265        .command_completion = object_del_completion,
1266    },
1267
1268STEXI
1269@item object_del
1270@findex object_del
1271Destroy QOM object.
1272ETEXI
1273
1274#ifdef CONFIG_SLIRP
1275    {
1276        .name       = "hostfwd_add",
1277        .args_type  = "arg1:s,arg2:s?,arg3:s?",
1278        .params     = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1279        .help       = "redirect TCP or UDP connections from host to guest (requires -net user)",
1280        .mhandler.cmd = hmp_hostfwd_add,
1281    },
1282#endif
1283STEXI
1284@item hostfwd_add
1285@findex hostfwd_add
1286Redirect TCP or UDP connections from host to guest (requires -net user).
1287ETEXI
1288
1289#ifdef CONFIG_SLIRP
1290    {
1291        .name       = "hostfwd_remove",
1292        .args_type  = "arg1:s,arg2:s?,arg3:s?",
1293        .params     = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1294        .help       = "remove host-to-guest TCP or UDP redirection",
1295        .mhandler.cmd = hmp_hostfwd_remove,
1296    },
1297
1298#endif
1299STEXI
1300@item hostfwd_remove
1301@findex hostfwd_remove
1302Remove host-to-guest TCP or UDP redirection.
1303ETEXI
1304
1305    {
1306        .name       = "balloon",
1307        .args_type  = "value:M",
1308        .params     = "target",
1309        .help       = "request VM to change its memory allocation (in MB)",
1310        .mhandler.cmd = hmp_balloon,
1311    },
1312
1313STEXI
1314@item balloon @var{value}
1315@findex balloon
1316Request VM to change its memory allocation to @var{value} (in MB).
1317ETEXI
1318
1319    {
1320        .name       = "set_link",
1321        .args_type  = "name:s,up:b",
1322        .params     = "name on|off",
1323        .help       = "change the link status of a network adapter",
1324        .mhandler.cmd = hmp_set_link,
1325        .command_completion = set_link_completion,
1326    },
1327
1328STEXI
1329@item set_link @var{name} [on|off]
1330@findex set_link
1331Switch link @var{name} on (i.e. up) or off (i.e. down).
1332ETEXI
1333
1334    {
1335        .name       = "watchdog_action",
1336        .args_type  = "action:s",
1337        .params     = "[reset|shutdown|poweroff|pause|debug|none]",
1338        .help       = "change watchdog action",
1339        .mhandler.cmd = hmp_watchdog_action,
1340        .command_completion = watchdog_action_completion,
1341    },
1342
1343STEXI
1344@item watchdog_action
1345@findex watchdog_action
1346Change watchdog action.
1347ETEXI
1348
1349    {
1350        .name       = "acl_show",
1351        .args_type  = "aclname:s",
1352        .params     = "aclname",
1353        .help       = "list rules in the access control list",
1354        .mhandler.cmd = hmp_acl_show,
1355    },
1356
1357STEXI
1358@item acl_show @var{aclname}
1359@findex acl_show
1360List all the matching rules in the access control list, and the default
1361policy. There are currently two named access control lists,
1362@var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1363certificate distinguished name, and SASL username respectively.
1364ETEXI
1365
1366    {
1367        .name       = "acl_policy",
1368        .args_type  = "aclname:s,policy:s",
1369        .params     = "aclname allow|deny",
1370        .help       = "set default access control list policy",
1371        .mhandler.cmd = hmp_acl_policy,
1372    },
1373
1374STEXI
1375@item acl_policy @var{aclname} @code{allow|deny}
1376@findex acl_policy
1377Set the default access control list policy, used in the event that
1378none of the explicit rules match. The default policy at startup is
1379always @code{deny}.
1380ETEXI
1381
1382    {
1383        .name       = "acl_add",
1384        .args_type  = "aclname:s,match:s,policy:s,index:i?",
1385        .params     = "aclname match allow|deny [index]",
1386        .help       = "add a match rule to the access control list",
1387        .mhandler.cmd = hmp_acl_add,
1388    },
1389
1390STEXI
1391@item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1392@findex acl_add
1393Add a match rule to the access control list, allowing or denying access.
1394The match will normally be an exact username or x509 distinguished name,
1395but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1396allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
1397normally be appended to the end of the ACL, but can be inserted
1398earlier in the list if the optional @var{index} parameter is supplied.
1399ETEXI
1400
1401    {
1402        .name       = "acl_remove",
1403        .args_type  = "aclname:s,match:s",
1404        .params     = "aclname match",
1405        .help       = "remove a match rule from the access control list",
1406        .mhandler.cmd = hmp_acl_remove,
1407    },
1408
1409STEXI
1410@item acl_remove @var{aclname} @var{match}
1411@findex acl_remove
1412Remove the specified match rule from the access control list.
1413ETEXI
1414
1415    {
1416        .name       = "acl_reset",
1417        .args_type  = "aclname:s",
1418        .params     = "aclname",
1419        .help       = "reset the access control list",
1420        .mhandler.cmd = hmp_acl_reset,
1421    },
1422
1423STEXI
1424@item acl_reset @var{aclname}
1425@findex acl_reset
1426Remove all matches from the access control list, and set the default
1427policy back to @code{deny}.
1428ETEXI
1429
1430    {
1431        .name       = "nbd_server_start",
1432        .args_type  = "all:-a,writable:-w,uri:s",
1433        .params     = "nbd_server_start [-a] [-w] host:port",
1434        .help       = "serve block devices on the given host and port",
1435        .mhandler.cmd = hmp_nbd_server_start,
1436    },
1437STEXI
1438@item nbd_server_start @var{host}:@var{port}
1439@findex nbd_server_start
1440Start an NBD server on the given host and/or port.  If the @option{-a}
1441option is included, all of the virtual machine's block devices that
1442have an inserted media on them are automatically exported; in this case,
1443the @option{-w} option makes the devices writable too.
1444ETEXI
1445
1446    {
1447        .name       = "nbd_server_add",
1448        .args_type  = "writable:-w,device:B",
1449        .params     = "nbd_server_add [-w] device",
1450        .help       = "export a block device via NBD",
1451        .mhandler.cmd = hmp_nbd_server_add,
1452    },
1453STEXI
1454@item nbd_server_add @var{device}
1455@findex nbd_server_add
1456Export a block device through QEMU's NBD server, which must be started
1457beforehand with @command{nbd_server_start}.  The @option{-w} option makes the
1458exported device writable too.
1459ETEXI
1460
1461    {
1462        .name       = "nbd_server_stop",
1463        .args_type  = "",
1464        .params     = "nbd_server_stop",
1465        .help       = "stop serving block devices using the NBD protocol",
1466        .mhandler.cmd = hmp_nbd_server_stop,
1467    },
1468STEXI
1469@item nbd_server_stop
1470@findex nbd_server_stop
1471Stop the QEMU embedded NBD server.
1472ETEXI
1473
1474
1475#if defined(TARGET_I386)
1476
1477    {
1478        .name       = "mce",
1479        .args_type  = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1480        .params     = "[-b] cpu bank status mcgstatus addr misc",
1481        .help       = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1482        .mhandler.cmd = hmp_mce,
1483    },
1484
1485#endif
1486STEXI
1487@item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1488@findex mce (x86)
1489Inject an MCE on the given CPU (x86 only).
1490ETEXI
1491
1492    {
1493        .name       = "getfd",
1494        .args_type  = "fdname:s",
1495        .params     = "getfd name",
1496        .help       = "receive a file descriptor via SCM rights and assign it a name",
1497        .mhandler.cmd = hmp_getfd,
1498    },
1499
1500STEXI
1501@item getfd @var{fdname}
1502@findex getfd
1503If a file descriptor is passed alongside this command using the SCM_RIGHTS
1504mechanism on unix sockets, it is stored using the name @var{fdname} for
1505later use by other monitor commands.
1506ETEXI
1507
1508    {
1509        .name       = "closefd",
1510        .args_type  = "fdname:s",
1511        .params     = "closefd name",
1512        .help       = "close a file descriptor previously passed via SCM rights",
1513        .mhandler.cmd = hmp_closefd,
1514    },
1515
1516STEXI
1517@item closefd @var{fdname}
1518@findex closefd
1519Close the file descriptor previously assigned to @var{fdname} using the
1520@code{getfd} command. This is only needed if the file descriptor was never
1521used by another monitor command.
1522ETEXI
1523
1524    {
1525        .name       = "block_passwd",
1526        .args_type  = "device:B,password:s",
1527        .params     = "block_passwd device password",
1528        .help       = "set the password of encrypted block devices",
1529        .mhandler.cmd = hmp_block_passwd,
1530    },
1531
1532STEXI
1533@item block_passwd @var{device} @var{password}
1534@findex block_passwd
1535Set the encrypted device @var{device} password to @var{password}
1536ETEXI
1537
1538    {
1539        .name       = "block_set_io_throttle",
1540        .args_type  = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1541        .params     = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1542        .help       = "change I/O throttle limits for a block drive",
1543        .mhandler.cmd = hmp_block_set_io_throttle,
1544    },
1545
1546STEXI
1547@item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1548@findex block_set_io_throttle
1549Change 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}
1550ETEXI
1551
1552    {
1553        .name       = "set_password",
1554        .args_type  = "protocol:s,password:s,connected:s?",
1555        .params     = "protocol password action-if-connected",
1556        .help       = "set spice/vnc password",
1557        .mhandler.cmd = hmp_set_password,
1558    },
1559
1560STEXI
1561@item set_password [ vnc | spice ] password [ action-if-connected ]
1562@findex set_password
1563Change spice/vnc password.  Use zero to make the password stay valid
1564forever.  @var{action-if-connected} specifies what should happen in
1565case a connection is established: @var{fail} makes the password change
1566fail.  @var{disconnect} changes the password and disconnects the
1567client.  @var{keep} changes the password and keeps the connection up.
1568@var{keep} is the default.
1569ETEXI
1570
1571    {
1572        .name       = "expire_password",
1573        .args_type  = "protocol:s,time:s",
1574        .params     = "protocol time",
1575        .help       = "set spice/vnc password expire-time",
1576        .mhandler.cmd = hmp_expire_password,
1577    },
1578
1579STEXI
1580@item expire_password [ vnc | spice ] expire-time
1581@findex expire_password
1582Specify when a password for spice/vnc becomes
1583invalid. @var{expire-time} accepts:
1584
1585@table @var
1586@item now
1587Invalidate password instantly.
1588
1589@item never
1590Password stays valid forever.
1591
1592@item +nsec
1593Password stays valid for @var{nsec} seconds starting now.
1594
1595@item nsec
1596Password is invalidated at the given time.  @var{nsec} are the seconds
1597passed since 1970, i.e. unix epoch.
1598
1599@end table
1600ETEXI
1601
1602    {
1603        .name       = "chardev-add",
1604        .args_type  = "args:s",
1605        .params     = "args",
1606        .help       = "add chardev",
1607        .mhandler.cmd = hmp_chardev_add,
1608        .command_completion = chardev_add_completion,
1609    },
1610
1611STEXI
1612@item chardev-add args
1613@findex chardev-add
1614chardev_add accepts the same parameters as the -chardev command line switch.
1615
1616ETEXI
1617
1618    {
1619        .name       = "chardev-remove",
1620        .args_type  = "id:s",
1621        .params     = "id",
1622        .help       = "remove chardev",
1623        .mhandler.cmd = hmp_chardev_remove,
1624        .command_completion = chardev_remove_completion,
1625    },
1626
1627STEXI
1628@item chardev-remove id
1629@findex chardev-remove
1630Removes the chardev @var{id}.
1631
1632ETEXI
1633
1634    {
1635        .name       = "qemu-io",
1636        .args_type  = "device:B,command:s",
1637        .params     = "[device] \"[command]\"",
1638        .help       = "run a qemu-io command on a block device",
1639        .mhandler.cmd = hmp_qemu_io,
1640    },
1641
1642STEXI
1643@item qemu-io @var{device} @var{command}
1644@findex qemu-io
1645Executes a qemu-io command on the given block device.
1646
1647ETEXI
1648
1649    {
1650        .name       = "cpu-add",
1651        .args_type  = "id:i",
1652        .params     = "id",
1653        .help       = "add cpu",
1654        .mhandler.cmd  = hmp_cpu_add,
1655    },
1656
1657STEXI
1658@item cpu-add @var{id}
1659@findex cpu-add
1660Add CPU with id @var{id}
1661ETEXI
1662
1663    {
1664        .name       = "qom-list",
1665        .args_type  = "path:s?",
1666        .params     = "path",
1667        .help       = "list QOM properties",
1668        .mhandler.cmd  = hmp_qom_list,
1669    },
1670
1671STEXI
1672@item qom-list [@var{path}]
1673Print QOM properties of object at location @var{path}
1674ETEXI
1675
1676    {
1677        .name       = "qom-set",
1678        .args_type  = "path:s,property:s,value:s",
1679        .params     = "path property value",
1680        .help       = "set QOM property",
1681        .mhandler.cmd  = hmp_qom_set,
1682    },
1683
1684STEXI
1685@item qom-set @var{path} @var{property} @var{value}
1686Set QOM property @var{property} of object at location @var{path} to value @var{value}
1687ETEXI
1688
1689    {
1690        .name       = "info",
1691        .args_type  = "item:s?",
1692        .params     = "[subcommand]",
1693        .help       = "show various information about the system state",
1694        .mhandler.cmd = hmp_info_help,
1695        .sub_table = info_cmds,
1696    },
1697
1698STEXI
1699@item info @var{subcommand}
1700@findex info
1701Show various information about the system state.
1702
1703@table @option
1704@item info version
1705show the version of QEMU
1706@item info network
1707show the various VLANs and the associated devices
1708@item info chardev
1709show the character devices
1710@item info block
1711show the block devices
1712@item info blockstats
1713show block device statistics
1714@item info registers
1715show the cpu registers
1716@item info cpus
1717show infos for each CPU
1718@item info history
1719show the command line history
1720@item info irq
1721show the interrupts statistics (if available)
1722@item info pic
1723show i8259 (PIC) state
1724@item info pci
1725show emulated PCI device info
1726@item info tlb
1727show virtual to physical memory mappings (i386, SH4, SPARC, PPC, and Xtensa only)
1728@item info mem
1729show the active virtual memory mappings (i386 only)
1730@item info jit
1731show dynamic compiler info
1732@item info numa
1733show NUMA information
1734@item info kvm
1735show KVM information
1736@item info usb
1737show USB devices plugged on the virtual USB hub
1738@item info usbhost
1739show all USB host devices
1740@item info profile
1741show profiling information
1742@item info capture
1743show information about active capturing
1744@item info snapshots
1745show list of VM snapshots
1746@item info status
1747show the current VM status (running|paused)
1748@item info mice
1749show which guest mouse is receiving events
1750@item info vnc
1751show the vnc server status
1752@item info name
1753show the current VM name
1754@item info uuid
1755show the current VM UUID
1756@item info cpustats
1757show CPU statistics
1758@item info usernet
1759show user network stack connection states
1760@item info migrate
1761show migration status
1762@item info migrate_capabilities
1763show current migration capabilities
1764@item info migrate_cache_size
1765show current migration XBZRLE cache size
1766@item info balloon
1767show balloon information
1768@item info qtree
1769show device tree
1770@item info qdm
1771show qdev device model list
1772@item info qom-tree
1773show object composition tree
1774@item info roms
1775show roms
1776@item info tpm
1777show the TPM device
1778@item info memory-devices
1779show the memory devices
1780@end table
1781ETEXI
1782
1783STEXI
1784@item info trace-events
1785show available trace events and their state
1786ETEXI
1787
1788STEXI
1789@end table
1790ETEXI
1791