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