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