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