xref: /illumos-kvm-cmd/hmp-commands.hx (revision 68396ea9)
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 = do_commit,
32    },
33
34STEXI
35@item commit
36@findex commit
37Commit changes to the disk images (if -snapshot is used) or backing files.
38ETEXI
39
40    {
41        .name       = "q|quit",
42        .args_type  = "",
43        .params     = "",
44        .help       = "quit the emulator",
45        .user_print = monitor_user_noop,
46        .mhandler.cmd_new = do_quit,
47    },
48
49STEXI
50@item q or quit
51@findex quit
52Quit the emulator.
53ETEXI
54
55    {
56        .name       = "block_resize",
57        .args_type  = "device:B,size:o",
58        .params     = "device size",
59        .help       = "resize a block image",
60        .user_print = monitor_user_noop,
61        .mhandler.cmd_new = do_block_resize,
62    },
63
64STEXI
65@item block_resize
66@findex block_resize
67Resize a block image while a guest is running.  Usually requires guest
68action to see the updated size.  Resize to a lower size is supported,
69but should be used with extreme caution.  Note that this command only
70resizes image files, it can not resize block devices like LVM volumes.
71ETEXI
72
73
74    {
75        .name       = "eject",
76        .args_type  = "force:-f,device:B",
77        .params     = "[-f] device",
78        .help       = "eject a removable medium (use -f to force it)",
79        .user_print = monitor_user_noop,
80        .mhandler.cmd_new = do_eject,
81    },
82
83STEXI
84@item eject [-f] @var{device}
85@findex eject
86Eject a removable medium (use -f to force it).
87ETEXI
88
89    {
90        .name       = "drive_del",
91        .args_type  = "id:s",
92        .params     = "device",
93        .help       = "remove host block device",
94        .user_print = monitor_user_noop,
95        .mhandler.cmd_new = do_drive_del,
96    },
97
98STEXI
99@item drive_del @var{device}
100@findex drive_del
101Remove host block device.  The result is that guest generated IO is no longer
102submitted against the host device underlying the disk.  Once a drive has
103been deleted, the QEMU Block layer returns -EIO which results in IO
104errors in the guest for applications that are reading/writing to the device.
105ETEXI
106
107    {
108        .name       = "change",
109        .args_type  = "device:B,target:F,arg:s?",
110        .params     = "device filename [format]",
111        .help       = "change a removable medium, optional format",
112        .user_print = monitor_user_noop,
113        .mhandler.cmd_new = do_change,
114    },
115
116STEXI
117@item change @var{device} @var{setting}
118@findex change
119
120Change the configuration of a device.
121
122@table @option
123@item change @var{diskdevice} @var{filename} [@var{format}]
124Change the medium for a removable disk device to point to @var{filename}. eg
125
126@example
127(qemu) change ide1-cd0 /path/to/some.iso
128@end example
129
130@var{format} is optional.
131
132@item change vnc @var{display},@var{options}
133Change the configuration of the VNC server. The valid syntax for @var{display}
134and @var{options} are described at @ref{sec_invocation}. eg
135
136@example
137(qemu) change vnc localhost:1
138@end example
139
140@item change vnc password [@var{password}]
141
142Change the password associated with the VNC server. If the new password is not
143supplied, the monitor will prompt for it to be entered. VNC passwords are only
144significant up to 8 letters. eg
145
146@example
147(qemu) change vnc password
148Password: ********
149@end example
150
151@end table
152ETEXI
153
154    {
155        .name       = "screendump",
156        .args_type  = "filename:F",
157        .params     = "filename",
158        .help       = "save screen into PPM image 'filename'",
159        .user_print = monitor_user_noop,
160        .mhandler.cmd_new = do_screen_dump,
161    },
162
163STEXI
164@item screendump @var{filename}
165@findex screendump
166Save screen into PPM image @var{filename}.
167ETEXI
168
169    {
170        .name       = "logfile",
171        .args_type  = "filename:F",
172        .params     = "filename",
173        .help       = "output logs to 'filename'",
174        .mhandler.cmd = do_logfile,
175    },
176
177STEXI
178@item logfile @var{filename}
179@findex logfile
180Output logs to @var{filename}.
181ETEXI
182
183#ifdef CONFIG_SIMPLE_TRACE
184    {
185        .name       = "trace-event",
186        .args_type  = "name:s,option:b",
187        .params     = "name on|off",
188        .help       = "changes status of a specific trace event",
189        .mhandler.cmd = do_change_trace_event_state,
190    },
191
192STEXI
193@item trace-event
194@findex trace-event
195changes status of a trace event
196ETEXI
197
198    {
199        .name       = "trace-file",
200        .args_type  = "op:s?,arg:F?",
201        .params     = "on|off|flush|set [arg]",
202        .help       = "open, close, or flush trace file, or set a new file name",
203        .mhandler.cmd = do_trace_file,
204    },
205
206STEXI
207@item trace-file on|off|flush
208@findex trace-file
209Open, close, or flush the trace file.  If no argument is given, the status of the trace file is displayed.
210ETEXI
211#endif
212
213    {
214        .name       = "log",
215        .args_type  = "items:s",
216        .params     = "item1[,...]",
217        .help       = "activate logging of the specified items to '/tmp/qemu.log'",
218        .mhandler.cmd = do_log,
219    },
220
221STEXI
222@item log @var{item1}[,...]
223@findex log
224Activate logging of the specified items to @file{/tmp/qemu.log}.
225ETEXI
226
227    {
228        .name       = "savevm",
229        .args_type  = "name:s?",
230        .params     = "[tag|id]",
231        .help       = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
232        .mhandler.cmd = do_savevm,
233    },
234
235STEXI
236@item savevm [@var{tag}|@var{id}]
237@findex savevm
238Create a snapshot of the whole virtual machine. If @var{tag} is
239provided, it is used as human readable identifier. If there is already
240a snapshot with the same tag or ID, it is replaced. More info at
241@ref{vm_snapshots}.
242ETEXI
243
244    {
245        .name       = "loadvm",
246        .args_type  = "name:s",
247        .params     = "tag|id",
248        .help       = "restore a VM snapshot from its tag or id",
249        .mhandler.cmd = do_loadvm,
250    },
251
252STEXI
253@item loadvm @var{tag}|@var{id}
254@findex loadvm
255Set the whole virtual machine to the snapshot identified by the tag
256@var{tag} or the unique snapshot ID @var{id}.
257ETEXI
258
259    {
260        .name       = "delvm",
261        .args_type  = "name:s",
262        .params     = "tag|id",
263        .help       = "delete a VM snapshot from its tag or id",
264        .mhandler.cmd = do_delvm,
265    },
266
267STEXI
268@item delvm @var{tag}|@var{id}
269@findex delvm
270Delete the snapshot identified by @var{tag} or @var{id}.
271ETEXI
272
273    {
274        .name       = "singlestep",
275        .args_type  = "option:s?",
276        .params     = "[on|off]",
277        .help       = "run emulation in singlestep mode or switch to normal mode",
278        .mhandler.cmd = do_singlestep,
279    },
280
281STEXI
282@item singlestep [off]
283@findex singlestep
284Run the emulation in single step mode.
285If called with option off, the emulation returns to normal mode.
286ETEXI
287
288    {
289        .name       = "stop",
290        .args_type  = "",
291        .params     = "",
292        .help       = "stop emulation",
293        .user_print = monitor_user_noop,
294        .mhandler.cmd_new = do_stop,
295    },
296
297STEXI
298@item stop
299@findex stop
300Stop emulation.
301ETEXI
302
303    {
304        .name       = "c|cont",
305        .args_type  = "",
306        .params     = "",
307        .help       = "resume emulation",
308        .user_print = monitor_user_noop,
309        .mhandler.cmd_new = do_cont,
310    },
311
312STEXI
313@item c or cont
314@findex cont
315Resume emulation.
316ETEXI
317
318    {
319        .name       = "gdbserver",
320        .args_type  = "device:s?",
321        .params     = "[device]",
322        .help       = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
323        .mhandler.cmd = do_gdbserver,
324    },
325
326STEXI
327@item gdbserver [@var{port}]
328@findex gdbserver
329Start gdbserver session (default @var{port}=1234)
330ETEXI
331
332    {
333        .name       = "x",
334        .args_type  = "fmt:/,addr:l",
335        .params     = "/fmt addr",
336        .help       = "virtual memory dump starting at 'addr'",
337        .mhandler.cmd = do_memory_dump,
338    },
339
340STEXI
341@item x/fmt @var{addr}
342@findex x
343Virtual memory dump starting at @var{addr}.
344ETEXI
345
346    {
347        .name       = "xp",
348        .args_type  = "fmt:/,addr:l",
349        .params     = "/fmt addr",
350        .help       = "physical memory dump starting at 'addr'",
351        .mhandler.cmd = do_physical_memory_dump,
352    },
353
354STEXI
355@item xp /@var{fmt} @var{addr}
356@findex xp
357Physical memory dump starting at @var{addr}.
358
359@var{fmt} is a format which tells the command how to format the
360data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
361
362@table @var
363@item count
364is the number of items to be dumped.
365
366@item format
367can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
368c (char) or i (asm instruction).
369
370@item size
371can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
372@code{h} or @code{w} can be specified with the @code{i} format to
373respectively select 16 or 32 bit code instruction size.
374
375@end table
376
377Examples:
378@itemize
379@item
380Dump 10 instructions at the current instruction pointer:
381@example
382(qemu) x/10i $eip
3830x90107063:  ret
3840x90107064:  sti
3850x90107065:  lea    0x0(%esi,1),%esi
3860x90107069:  lea    0x0(%edi,1),%edi
3870x90107070:  ret
3880x90107071:  jmp    0x90107080
3890x90107073:  nop
3900x90107074:  nop
3910x90107075:  nop
3920x90107076:  nop
393@end example
394
395@item
396Dump 80 16 bit values at the start of the video memory.
397@smallexample
398(qemu) xp/80hx 0xb8000
3990x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
4000x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
4010x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
4020x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
4030x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
4040x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
4050x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
4060x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
4070x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
4080x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
409@end smallexample
410@end itemize
411ETEXI
412
413    {
414        .name       = "p|print",
415        .args_type  = "fmt:/,val:l",
416        .params     = "/fmt expr",
417        .help       = "print expression value (use $reg for CPU register access)",
418        .mhandler.cmd = do_print,
419    },
420
421STEXI
422@item p or print/@var{fmt} @var{expr}
423@findex print
424
425Print expression value. Only the @var{format} part of @var{fmt} is
426used.
427ETEXI
428
429    {
430        .name       = "i",
431        .args_type  = "fmt:/,addr:i,index:i.",
432        .params     = "/fmt addr",
433        .help       = "I/O port read",
434        .mhandler.cmd = do_ioport_read,
435    },
436
437STEXI
438Read I/O port.
439ETEXI
440
441    {
442        .name       = "o",
443        .args_type  = "fmt:/,addr:i,val:i",
444        .params     = "/fmt addr value",
445        .help       = "I/O port write",
446        .mhandler.cmd = do_ioport_write,
447    },
448
449STEXI
450Write to I/O port.
451ETEXI
452
453    {
454        .name       = "sendkey",
455        .args_type  = "string:s,hold_time:i?",
456        .params     = "keys [hold_ms]",
457        .help       = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
458        .mhandler.cmd = do_sendkey,
459    },
460
461STEXI
462@item sendkey @var{keys}
463@findex sendkey
464
465Send @var{keys} to the emulator. @var{keys} could be the name of the
466key or @code{#} followed by the raw value in either decimal or hexadecimal
467format. Use @code{-} to press several keys simultaneously. Example:
468@example
469sendkey ctrl-alt-f1
470@end example
471
472This command is useful to send keys that your graphical user interface
473intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
474ETEXI
475
476    {
477        .name       = "system_reset",
478        .args_type  = "",
479        .params     = "",
480        .help       = "reset the system",
481        .user_print = monitor_user_noop,
482        .mhandler.cmd_new = do_system_reset,
483    },
484
485STEXI
486@item system_reset
487@findex system_reset
488
489Reset the system.
490ETEXI
491
492    {
493        .name       = "system_powerdown",
494        .args_type  = "",
495        .params     = "",
496        .help       = "send system power down event",
497        .user_print = monitor_user_noop,
498        .mhandler.cmd_new = do_system_powerdown,
499    },
500
501STEXI
502@item system_powerdown
503@findex system_powerdown
504
505Power down the system (if supported).
506ETEXI
507
508    {
509        .name       = "sum",
510        .args_type  = "start:i,size:i",
511        .params     = "addr size",
512        .help       = "compute the checksum of a memory region",
513        .mhandler.cmd = do_sum,
514    },
515
516STEXI
517@item sum @var{addr} @var{size}
518@findex sum
519
520Compute the checksum of a memory region.
521ETEXI
522
523    {
524        .name       = "usb_add",
525        .args_type  = "devname:s",
526        .params     = "device",
527        .help       = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
528        .mhandler.cmd = do_usb_add,
529    },
530
531STEXI
532@item usb_add @var{devname}
533@findex usb_add
534
535Add the USB device @var{devname}.  For details of available devices see
536@ref{usb_devices}
537ETEXI
538
539    {
540        .name       = "usb_del",
541        .args_type  = "devname:s",
542        .params     = "device",
543        .help       = "remove USB device 'bus.addr'",
544        .mhandler.cmd = do_usb_del,
545    },
546
547STEXI
548@item usb_del @var{devname}
549@findex usb_del
550
551Remove the USB device @var{devname} from the QEMU virtual USB
552hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
553command @code{info usb} to see the devices you can remove.
554ETEXI
555
556    {
557        .name       = "device_add",
558        .args_type  = "device:O",
559        .params     = "driver[,prop=value][,...]",
560        .help       = "add device, like -device on the command line",
561        .user_print = monitor_user_noop,
562        .mhandler.cmd_new = do_device_add,
563    },
564
565STEXI
566@item device_add @var{config}
567@findex device_add
568
569Add device.
570ETEXI
571
572    {
573        .name       = "device_del",
574        .args_type  = "id:s",
575        .params     = "device",
576        .help       = "remove device",
577        .user_print = monitor_user_noop,
578        .mhandler.cmd_new = do_device_del,
579    },
580
581STEXI
582@item device_del @var{id}
583@findex device_del
584
585Remove device @var{id}.
586ETEXI
587
588    {
589        .name       = "cpu",
590        .args_type  = "index:i",
591        .params     = "index",
592        .help       = "set the default CPU",
593        .user_print = monitor_user_noop,
594        .mhandler.cmd_new = do_cpu_set,
595    },
596
597STEXI
598@item cpu @var{index}
599@findex cpu
600Set the default CPU.
601ETEXI
602
603    {
604        .name       = "mouse_move",
605        .args_type  = "dx_str:s,dy_str:s,dz_str:s?",
606        .params     = "dx dy [dz]",
607        .help       = "send mouse move events",
608        .mhandler.cmd = do_mouse_move,
609    },
610
611STEXI
612@item mouse_move @var{dx} @var{dy} [@var{dz}]
613@findex mouse_move
614Move the active mouse to the specified coordinates @var{dx} @var{dy}
615with optional scroll axis @var{dz}.
616ETEXI
617
618    {
619        .name       = "mouse_button",
620        .args_type  = "button_state:i",
621        .params     = "state",
622        .help       = "change mouse button state (1=L, 2=M, 4=R)",
623        .mhandler.cmd = do_mouse_button,
624    },
625
626STEXI
627@item mouse_button @var{val}
628@findex mouse_button
629Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
630ETEXI
631
632    {
633        .name       = "mouse_set",
634        .args_type  = "index:i",
635        .params     = "index",
636        .help       = "set which mouse device receives events",
637        .mhandler.cmd = do_mouse_set,
638    },
639
640STEXI
641@item mouse_set @var{index}
642@findex mouse_set
643Set which mouse device receives events at given @var{index}, index
644can be obtained with
645@example
646info mice
647@end example
648ETEXI
649
650#ifdef HAS_AUDIO
651    {
652        .name       = "wavcapture",
653        .args_type  = "path:F,freq:i?,bits:i?,nchannels:i?",
654        .params     = "path [frequency [bits [channels]]]",
655        .help       = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
656        .mhandler.cmd = do_wav_capture,
657    },
658#endif
659STEXI
660@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
661@findex wavcapture
662Capture audio into @var{filename}. Using sample rate @var{frequency}
663bits per sample @var{bits} and number of channels @var{channels}.
664
665Defaults:
666@itemize @minus
667@item Sample rate = 44100 Hz - CD quality
668@item Bits = 16
669@item Number of channels = 2 - Stereo
670@end itemize
671ETEXI
672
673#ifdef HAS_AUDIO
674    {
675        .name       = "stopcapture",
676        .args_type  = "n:i",
677        .params     = "capture index",
678        .help       = "stop capture",
679        .mhandler.cmd = do_stop_capture,
680    },
681#endif
682STEXI
683@item stopcapture @var{index}
684@findex stopcapture
685Stop capture with a given @var{index}, index can be obtained with
686@example
687info capture
688@end example
689ETEXI
690
691    {
692        .name       = "memsave",
693        .args_type  = "val:l,size:i,filename:s",
694        .params     = "addr size file",
695        .help       = "save to disk virtual memory dump starting at 'addr' of size 'size'",
696        .user_print = monitor_user_noop,
697        .mhandler.cmd_new = do_memory_save,
698    },
699
700STEXI
701@item memsave @var{addr} @var{size} @var{file}
702@findex memsave
703save to disk virtual memory dump starting at @var{addr} of size @var{size}.
704ETEXI
705
706    {
707        .name       = "pmemsave",
708        .args_type  = "val:l,size:i,filename:s",
709        .params     = "addr size file",
710        .help       = "save to disk physical memory dump starting at 'addr' of size 'size'",
711        .user_print = monitor_user_noop,
712        .mhandler.cmd_new = do_physical_memory_save,
713    },
714
715STEXI
716@item pmemsave @var{addr} @var{size} @var{file}
717@findex pmemsave
718save to disk physical memory dump starting at @var{addr} of size @var{size}.
719ETEXI
720
721    {
722        .name       = "boot_set",
723        .args_type  = "bootdevice:s",
724        .params     = "bootdevice",
725        .help       = "define new values for the boot device list",
726        .mhandler.cmd = do_boot_set,
727    },
728
729STEXI
730@item boot_set @var{bootdevicelist}
731@findex boot_set
732
733Define new values for the boot device list. Those values will override
734the values specified on the command line through the @code{-boot} option.
735
736The values that can be specified here depend on the machine type, but are
737the same that can be specified in the @code{-boot} command line option.
738ETEXI
739
740#if defined(TARGET_I386)
741    {
742        .name       = "nmi",
743        .args_type  = "cpu_index:i",
744        .params     = "cpu",
745        .help       = "inject an NMI on the given CPU",
746        .mhandler.cmd = do_inject_nmi,
747    },
748#endif
749STEXI
750@item nmi @var{cpu}
751@findex nmi
752Inject an NMI on the given CPU (x86 only).
753ETEXI
754
755    {
756        .name       = "migrate",
757        .args_type  = "detach:-d,blk:-b,inc:-i,uri:s",
758        .params     = "[-d] [-b] [-i] uri",
759        .help       = "migrate to URI (using -d to not wait for completion)"
760		      "\n\t\t\t -b for migration without shared storage with"
761		      " full copy of disk\n\t\t\t -i for migration without "
762		      "shared storage with incremental copy of disk "
763		      "(base image shared between src and destination)",
764        .user_print = monitor_user_noop,
765	.mhandler.cmd_new = do_migrate,
766    },
767
768
769STEXI
770@item migrate [-d] [-b] [-i] @var{uri}
771@findex migrate
772Migrate to @var{uri} (using -d to not wait for completion).
773	-b for migration with full copy of disk
774	-i for migration with incremental copy of disk (base image is shared)
775ETEXI
776
777    {
778        .name       = "migrate_cancel",
779        .args_type  = "",
780        .params     = "",
781        .help       = "cancel the current VM migration",
782        .user_print = monitor_user_noop,
783        .mhandler.cmd_new = do_migrate_cancel,
784    },
785
786STEXI
787@item migrate_cancel
788@findex migrate_cancel
789Cancel the current VM migration.
790ETEXI
791
792    {
793        .name       = "migrate_set_speed",
794        .args_type  = "value:o",
795        .params     = "value",
796        .help       = "set maximum speed (in bytes) for migrations. "
797	"Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
798        .user_print = monitor_user_noop,
799        .mhandler.cmd_new = do_migrate_set_speed,
800    },
801
802STEXI
803@item migrate_set_speed @var{value}
804@findex migrate_set_speed
805Set maximum speed to @var{value} (in bytes) for migrations.
806ETEXI
807
808    {
809        .name       = "migrate_set_downtime",
810        .args_type  = "value:T",
811        .params     = "value",
812        .help       = "set maximum tolerated downtime (in seconds) for migrations",
813        .user_print = monitor_user_noop,
814        .mhandler.cmd_new = do_migrate_set_downtime,
815    },
816
817STEXI
818@item migrate_set_downtime @var{second}
819@findex migrate_set_downtime
820Set maximum tolerated downtime (in seconds) for migration.
821ETEXI
822
823    {
824        .name       = "snapshot_blkdev",
825        .args_type  = "device:B,snapshot_file:s?,format:s?",
826        .params     = "device [new-image-file] [format]",
827        .help       = "initiates a live snapshot\n\t\t\t"
828                      "of device. If a new image file is specified, the\n\t\t\t"
829                      "new image file will become the new root image.\n\t\t\t"
830                      "If format is specified, the snapshot file will\n\t\t\t"
831                      "be created in that format. Otherwise the\n\t\t\t"
832                      "snapshot will be internal! (currently unsupported)",
833        .mhandler.cmd_new = do_snapshot_blkdev,
834    },
835
836STEXI
837@item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
838@findex client_migrate_info
839Set the spice/vnc connection info for the migration target.  The spice/vnc
840server will ask the spice/vnc client to automatically reconnect using the
841new parameters (if specified) once the vm migration finished successfully.
842ETEXI
843
844    {
845        .name       = "client_migrate_info",
846        .args_type  = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
847        .params     = "protocol hostname port tls-port cert-subject",
848        .help       = "send migration info to spice/vnc client",
849        .user_print = monitor_user_noop,
850        .mhandler.cmd_new = client_migrate_info,
851    },
852
853STEXI
854@item snapshot_blkdev
855@findex snapshot_blkdev
856Snapshot device, using snapshot file as target if provided
857ETEXI
858
859#if defined(TARGET_I386)
860    {
861        .name       = "drive_add",
862        .args_type  = "pci_addr:s,opts:s",
863        .params     = "[[<domain>:]<bus>:]<slot>\n"
864                      "[file=file][,if=type][,bus=n]\n"
865                      "[,unit=m][,media=d][index=i]\n"
866                      "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
867                      "[snapshot=on|off][,cache=on|off]",
868        .help       = "add drive to PCI storage controller",
869        .mhandler.cmd = drive_hot_add,
870    },
871#endif
872
873STEXI
874@item drive_add
875@findex drive_add
876Add drive to PCI storage controller.
877ETEXI
878
879#if defined(TARGET_I386)
880    {
881        .name       = "pci_add",
882        .args_type  = "pci_addr:s,type:s,opts:s?",
883        .params     = "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...",
884        .help       = "hot-add PCI device",
885        .mhandler.cmd = pci_device_hot_add,
886    },
887#endif
888
889STEXI
890@item pci_add
891@findex pci_add
892Hot-add PCI device.
893ETEXI
894
895#if defined(TARGET_I386)
896    {
897        .name       = "pci_del",
898        .args_type  = "pci_addr:s",
899        .params     = "[[<domain>:]<bus>:]<slot>",
900        .help       = "hot remove PCI device",
901        .mhandler.cmd = do_pci_device_hot_remove,
902    },
903#endif
904
905STEXI
906@item pci_del
907@findex pci_del
908Hot remove PCI device.
909ETEXI
910
911    {
912        .name       = "pcie_aer_inject_error",
913        .args_type  = "advisory_non_fatal:-a,correctable:-c,"
914	              "id:s,error_status:s,"
915	              "header0:i?,header1:i?,header2:i?,header3:i?,"
916	              "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
917        .params     = "[-a] [-c] id "
918                      "<error_status> [<tlp header> [<tlp header prefix>]]",
919        .help       = "inject pcie aer error\n\t\t\t"
920	              " -a for advisory non fatal error\n\t\t\t"
921	              " -c for correctable error\n\t\t\t"
922                      "<id> = qdev device id\n\t\t\t"
923                      "<error_status> = error string or 32bit\n\t\t\t"
924                      "<tlb header> = 32bit x 4\n\t\t\t"
925                      "<tlb header prefix> = 32bit x 4",
926        .user_print  = pcie_aer_inject_error_print,
927        .mhandler.cmd_new = do_pcie_aer_inejct_error,
928    },
929
930STEXI
931@item pcie_aer_inject_error
932@findex pcie_aer_inject_error
933Inject PCIe AER error
934ETEXI
935
936    {
937        .name       = "host_net_add",
938        .args_type  = "device:s,opts:s?",
939        .params     = "tap|user|socket|vde|dump [options]",
940        .help       = "add host VLAN client",
941        .mhandler.cmd = net_host_device_add,
942    },
943
944STEXI
945@item host_net_add
946@findex host_net_add
947Add host VLAN client.
948ETEXI
949
950    {
951        .name       = "host_net_remove",
952        .args_type  = "vlan_id:i,device:s",
953        .params     = "vlan_id name",
954        .help       = "remove host VLAN client",
955        .mhandler.cmd = net_host_device_remove,
956    },
957
958STEXI
959@item host_net_remove
960@findex host_net_remove
961Remove host VLAN client.
962ETEXI
963
964    {
965        .name       = "netdev_add",
966        .args_type  = "netdev:O",
967        .params     = "[user|tap|socket],id=str[,prop=value][,...]",
968        .help       = "add host network device",
969        .user_print = monitor_user_noop,
970        .mhandler.cmd_new = do_netdev_add,
971    },
972
973STEXI
974@item netdev_add
975@findex netdev_add
976Add host network device.
977ETEXI
978
979    {
980        .name       = "netdev_del",
981        .args_type  = "id:s",
982        .params     = "id",
983        .help       = "remove host network device",
984        .user_print = monitor_user_noop,
985        .mhandler.cmd_new = do_netdev_del,
986    },
987
988STEXI
989@item netdev_del
990@findex netdev_del
991Remove host network device.
992ETEXI
993
994#ifdef CONFIG_SLIRP
995    {
996        .name       = "hostfwd_add",
997        .args_type  = "arg1:s,arg2:s?,arg3:s?",
998        .params     = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
999        .help       = "redirect TCP or UDP connections from host to guest (requires -net user)",
1000        .mhandler.cmd = net_slirp_hostfwd_add,
1001    },
1002#endif
1003STEXI
1004@item hostfwd_add
1005@findex hostfwd_add
1006Redirect TCP or UDP connections from host to guest (requires -net user).
1007ETEXI
1008
1009#ifdef CONFIG_SLIRP
1010    {
1011        .name       = "hostfwd_remove",
1012        .args_type  = "arg1:s,arg2:s?,arg3:s?",
1013        .params     = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1014        .help       = "remove host-to-guest TCP or UDP redirection",
1015        .mhandler.cmd = net_slirp_hostfwd_remove,
1016    },
1017
1018#endif
1019STEXI
1020@item hostfwd_remove
1021@findex hostfwd_remove
1022Remove host-to-guest TCP or UDP redirection.
1023ETEXI
1024
1025    {
1026        .name       = "balloon",
1027        .args_type  = "value:M",
1028        .params     = "target",
1029        .help       = "request VM to change its memory allocation (in MB)",
1030        .user_print = monitor_user_noop,
1031        .mhandler.cmd_async = do_balloon,
1032        .flags      = MONITOR_CMD_ASYNC,
1033    },
1034
1035STEXI
1036@item balloon @var{value}
1037@findex balloon
1038Request VM to change its memory allocation to @var{value} (in MB).
1039ETEXI
1040
1041    {
1042        .name       = "set_link",
1043        .args_type  = "name:s,up:b",
1044        .params     = "name on|off",
1045        .help       = "change the link status of a network adapter",
1046        .user_print = monitor_user_noop,
1047        .mhandler.cmd_new = do_set_link,
1048    },
1049
1050STEXI
1051@item set_link @var{name} [on|off]
1052@findex set_link
1053Switch link @var{name} on (i.e. up) or off (i.e. down).
1054ETEXI
1055
1056    {
1057        .name       = "watchdog_action",
1058        .args_type  = "action:s",
1059        .params     = "[reset|shutdown|poweroff|pause|debug|none]",
1060        .help       = "change watchdog action",
1061        .mhandler.cmd = do_watchdog_action,
1062    },
1063
1064STEXI
1065@item watchdog_action
1066@findex watchdog_action
1067Change watchdog action.
1068ETEXI
1069
1070    {
1071        .name       = "acl_show",
1072        .args_type  = "aclname:s",
1073        .params     = "aclname",
1074        .help       = "list rules in the access control list",
1075        .mhandler.cmd = do_acl_show,
1076    },
1077
1078STEXI
1079@item acl_show @var{aclname}
1080@findex acl_show
1081List all the matching rules in the access control list, and the default
1082policy. There are currently two named access control lists,
1083@var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1084certificate distinguished name, and SASL username respectively.
1085ETEXI
1086
1087    {
1088        .name       = "acl_policy",
1089        .args_type  = "aclname:s,policy:s",
1090        .params     = "aclname allow|deny",
1091        .help       = "set default access control list policy",
1092        .mhandler.cmd = do_acl_policy,
1093    },
1094
1095STEXI
1096@item acl_policy @var{aclname} @code{allow|deny}
1097@findex acl_policy
1098Set the default access control list policy, used in the event that
1099none of the explicit rules match. The default policy at startup is
1100always @code{deny}.
1101ETEXI
1102
1103    {
1104        .name       = "acl_add",
1105        .args_type  = "aclname:s,match:s,policy:s,index:i?",
1106        .params     = "aclname match allow|deny [index]",
1107        .help       = "add a match rule to the access control list",
1108        .mhandler.cmd = do_acl_add,
1109    },
1110
1111STEXI
1112@item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1113@findex acl_add
1114Add a match rule to the access control list, allowing or denying access.
1115The match will normally be an exact username or x509 distinguished name,
1116but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1117allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
1118normally be appended to the end of the ACL, but can be inserted
1119earlier in the list if the optional @var{index} parameter is supplied.
1120ETEXI
1121
1122    {
1123        .name       = "acl_remove",
1124        .args_type  = "aclname:s,match:s",
1125        .params     = "aclname match",
1126        .help       = "remove a match rule from the access control list",
1127        .mhandler.cmd = do_acl_remove,
1128    },
1129
1130STEXI
1131@item acl_remove @var{aclname} @var{match}
1132@findex acl_remove
1133Remove the specified match rule from the access control list.
1134ETEXI
1135
1136    {
1137        .name       = "acl_reset",
1138        .args_type  = "aclname:s",
1139        .params     = "aclname",
1140        .help       = "reset the access control list",
1141        .mhandler.cmd = do_acl_reset,
1142    },
1143
1144STEXI
1145@item acl_reset @var{aclname}
1146@findex acl_reset
1147Remove all matches from the access control list, and set the default
1148policy back to @code{deny}.
1149ETEXI
1150
1151#if defined(TARGET_I386)
1152
1153    {
1154        .name       = "mce",
1155        .args_type  = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1156        .params     = "[-b] cpu bank status mcgstatus addr misc",
1157        .help       = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1158        .mhandler.cmd = do_inject_mce,
1159    },
1160
1161#endif
1162STEXI
1163@item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1164@findex mce (x86)
1165Inject an MCE on the given CPU (x86 only).
1166ETEXI
1167
1168    {
1169        .name       = "getfd",
1170        .args_type  = "fdname:s",
1171        .params     = "getfd name",
1172        .help       = "receive a file descriptor via SCM rights and assign it a name",
1173        .user_print = monitor_user_noop,
1174        .mhandler.cmd_new = do_getfd,
1175    },
1176
1177STEXI
1178@item getfd @var{fdname}
1179@findex getfd
1180If a file descriptor is passed alongside this command using the SCM_RIGHTS
1181mechanism on unix sockets, it is stored using the name @var{fdname} for
1182later use by other monitor commands.
1183ETEXI
1184
1185    {
1186        .name       = "closefd",
1187        .args_type  = "fdname:s",
1188        .params     = "closefd name",
1189        .help       = "close a file descriptor previously passed via SCM rights",
1190        .user_print = monitor_user_noop,
1191        .mhandler.cmd_new = do_closefd,
1192    },
1193
1194STEXI
1195@item closefd @var{fdname}
1196@findex closefd
1197Close the file descriptor previously assigned to @var{fdname} using the
1198@code{getfd} command. This is only needed if the file descriptor was never
1199used by another monitor command.
1200ETEXI
1201
1202    {
1203        .name       = "block_passwd",
1204        .args_type  = "device:B,password:s",
1205        .params     = "block_passwd device password",
1206        .help       = "set the password of encrypted block devices",
1207        .user_print = monitor_user_noop,
1208        .mhandler.cmd_new = do_block_set_passwd,
1209    },
1210
1211STEXI
1212@item block_passwd @var{device} @var{password}
1213@findex block_passwd
1214Set the encrypted device @var{device} password to @var{password}
1215ETEXI
1216
1217    {
1218        .name       = "cpu_set",
1219        .args_type  = "cpu:i,state:s",
1220        .params     = "cpu [online|offline]",
1221        .help       = "change cpu state",
1222        .mhandler.cmd  = do_cpu_set_nr,
1223    },
1224
1225STEXI
1226@item cpu_set @var{cpu} [online|offline]
1227Set CPU @var{cpu} online or offline.
1228ETEXI
1229
1230    {
1231        .name       = "set_password",
1232        .args_type  = "protocol:s,password:s,connected:s?",
1233        .params     = "protocol password action-if-connected",
1234        .help       = "set spice/vnc password",
1235        .user_print = monitor_user_noop,
1236        .mhandler.cmd_new = set_password,
1237    },
1238
1239STEXI
1240@item set_password [ vnc | spice ] password [ action-if-connected ]
1241@findex set_password
1242
1243Change spice/vnc password.  Use zero to make the password stay valid
1244forever.  @var{action-if-connected} specifies what should happen in
1245case a connection is established: @var{fail} makes the password change
1246fail.  @var{disconnect} changes the password and disconnects the
1247client.  @var{keep} changes the password and keeps the connection up.
1248@var{keep} is the default.
1249ETEXI
1250
1251    {
1252        .name       = "expire_password",
1253        .args_type  = "protocol:s,time:s",
1254        .params     = "protocol time",
1255        .help       = "set spice/vnc password expire-time",
1256        .user_print = monitor_user_noop,
1257        .mhandler.cmd_new = expire_password,
1258    },
1259
1260STEXI
1261@item expire_password [ vnc | spice ] expire-time
1262@findex expire_password
1263
1264Specify when a password for spice/vnc becomes
1265invalid. @var{expire-time} accepts:
1266
1267@table @var
1268@item now
1269Invalidate password instantly.
1270
1271@item never
1272Password stays valid forever.
1273
1274@item +nsec
1275Password stays valid for @var{nsec} seconds starting now.
1276
1277@item nsec
1278Password is invalidated at the given time.  @var{nsec} are the seconds
1279passed since 1970, i.e. unix epoch.
1280
1281@end table
1282ETEXI
1283
1284    {
1285        .name       = "info",
1286        .args_type  = "item:s?",
1287        .params     = "[subcommand]",
1288        .help       = "show various information about the system state",
1289        .mhandler.cmd = do_info,
1290    },
1291
1292STEXI
1293@item info @var{subcommand}
1294@findex info
1295Show various information about the system state.
1296
1297@table @option
1298@item info version
1299show the version of QEMU
1300@item info network
1301show the various VLANs and the associated devices
1302@item info chardev
1303show the character devices
1304@item info block
1305show the block devices
1306@item info blockstats
1307show block device statistics
1308@item info registers
1309show the cpu registers
1310@item info cpus
1311show infos for each CPU
1312@item info history
1313show the command line history
1314@item info irq
1315show the interrupts statistics (if available)
1316@item info pic
1317show i8259 (PIC) state
1318@item info pci
1319show emulated PCI device info
1320@item info tlb
1321show virtual to physical memory mappings (i386, SH4 and SPARC only)
1322@item info mem
1323show the active virtual memory mappings (i386 only)
1324@item info jit
1325show dynamic compiler info
1326@item info kvm
1327show KVM information
1328@item info numa
1329show NUMA information
1330@item info kvm
1331show KVM information
1332@item info usb
1333show USB devices plugged on the virtual USB hub
1334@item info usbhost
1335show all USB host devices
1336@item info profile
1337show profiling information
1338@item info capture
1339show information about active capturing
1340@item info snapshots
1341show list of VM snapshots
1342@item info status
1343show the current VM status (running|paused)
1344@item info pcmcia
1345show guest PCMCIA status
1346@item info mice
1347show which guest mouse is receiving events
1348@item info vnc
1349show the vnc server status
1350@item info name
1351show the current VM name
1352@item info uuid
1353show the current VM UUID
1354@item info cpustats
1355show CPU statistics
1356@item info usernet
1357show user network stack connection states
1358@item info migrate
1359show migration status
1360@item info balloon
1361show balloon information
1362@item info qtree
1363show device tree
1364@item info qdm
1365show qdev device model list
1366@item info roms
1367show roms
1368@end table
1369ETEXI
1370
1371#ifdef CONFIG_SIMPLE_TRACE
1372STEXI
1373@item info trace
1374show contents of trace buffer
1375@item info trace-events
1376show available trace events and their state
1377ETEXI
1378#endif
1379
1380STEXI
1381@end table
1382ETEXI
1383