hmp-commands.hx 49.8 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
HXCOMM Use DEFHEADING() to define headings in both help text and texi
HXCOMM Text between STEXI and ETEXI are copied to texi version and
HXCOMM discarded from C version
HXCOMM DEF(command, args, callback, arg_string, help) is used to construct
HXCOMM monitor commands
HXCOMM HXCOMM can be used for comments, discarded from both texi and C

STEXI
@table @option
ETEXI

12 13
    {
        .name       = "help|?",
14
        .args_type  = "name:S?",
15 16
        .params     = "[cmd]",
        .help       = "show the help",
17
        .mhandler.cmd = do_help_cmd,
18 19
    },

20 21
STEXI
@item help or ? [@var{cmd}]
22
@findex help
23 24 25
Show the help for all commands or just for command @var{cmd}.
ETEXI

26 27 28 29 30
    {
        .name       = "commit",
        .args_type  = "device:B",
        .params     = "device|all",
        .help       = "commit changes to the disk images (if -snapshot is used) or backing files",
31
        .mhandler.cmd = do_commit,
32 33
    },

34 35
STEXI
@item commit
36
@findex commit
37
Commit changes to the disk images (if -snapshot is used) or backing files.
38 39 40 41 42
If the backing file is smaller than the snapshot, then the backing file will be
resized to be the same size as the snapshot.  If the snapshot is smaller than
the backing file, the backing file will not be truncated.  If you want the
backing file to match the size of the smaller snapshot, you can safely truncate
it yourself once the commit operation successfully completes.
43 44
ETEXI

45 46 47 48 49
    {
        .name       = "q|quit",
        .args_type  = "",
        .params     = "",
        .help       = "quit the emulator",
50
        .user_print = monitor_user_noop,
L
Luiz Capitulino 已提交
51
        .mhandler.cmd = hmp_quit,
52 53
    },

54 55
STEXI
@item q or quit
56
@findex quit
57 58 59
Quit the emulator.
ETEXI

60 61 62 63 64
    {
        .name       = "block_resize",
        .args_type  = "device:B,size:o",
        .params     = "device size",
        .help       = "resize a block image",
L
Luiz Capitulino 已提交
65
        .mhandler.cmd = hmp_block_resize,
66 67 68 69 70 71 72 73 74 75 76
    },

STEXI
@item block_resize
@findex block_resize
Resize a block image while a guest is running.  Usually requires guest
action to see the updated size.  Resize to a lower size is supported,
but should be used with extreme caution.  Note that this command only
resizes image files, it can not resize block devices like LVM volumes.
ETEXI

S
Stefan Hajnoczi 已提交
77 78
    {
        .name       = "block_stream",
79 80
        .args_type  = "device:B,speed:o?,base:s?",
        .params     = "device [speed [base]]",
S
Stefan Hajnoczi 已提交
81 82 83 84 85 86 87 88
        .help       = "copy data from a backing file into a block device",
        .mhandler.cmd = hmp_block_stream,
    },

STEXI
@item block_stream
@findex block_stream
Copy data from a backing file into a block device.
89 90 91 92
ETEXI

    {
        .name       = "block_job_set_speed",
93 94
        .args_type  = "device:B,speed:o",
        .params     = "device speed",
95 96 97 98 99
        .help       = "set maximum speed for a background block operation",
        .mhandler.cmd = hmp_block_job_set_speed,
    },

STEXI
100 101
@item block_job_set_speed
@findex block_job_set_speed
102
Set maximum speed for a background block operation.
103 104 105 106
ETEXI

    {
        .name       = "block_job_cancel",
107 108 109 110
        .args_type  = "force:-f,device:B",
        .params     = "[-f] device",
        .help       = "stop an active background block operation (use -f"
                      "\n\t\t\t if the operation is currently paused)",
111 112 113 114 115 116
        .mhandler.cmd = hmp_block_job_cancel,
    },

STEXI
@item block_job_cancel
@findex block_job_cancel
P
Paolo Bonzini 已提交
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
Stop an active background block operation (streaming, mirroring).
ETEXI

    {
        .name       = "block_job_complete",
        .args_type  = "device:B",
        .params     = "device",
        .help       = "stop an active background block operation",
        .mhandler.cmd = hmp_block_job_complete,
    },

STEXI
@item block_job_complete
@findex block_job_complete
Manually trigger completion of an active background block operation.
For mirroring, this will switch the device to the destination path.
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
ETEXI

    {
        .name       = "block_job_pause",
        .args_type  = "device:B",
        .params     = "device",
        .help       = "pause an active background block operation",
        .mhandler.cmd = hmp_block_job_pause,
    },

STEXI
@item block_job_pause
@findex block_job_pause
Pause an active block streaming operation.
ETEXI

    {
        .name       = "block_job_resume",
        .args_type  = "device:B",
        .params     = "device",
        .help       = "resume a paused background block operation",
        .mhandler.cmd = hmp_block_job_resume,
    },

STEXI
@item block_job_resume
@findex block_job_resume
Resume a paused block streaming operation.
S
Stefan Hajnoczi 已提交
161
ETEXI
162

163 164
    {
        .name       = "eject",
L
Luiz Capitulino 已提交
165
        .args_type  = "force:-f,device:B",
166 167
        .params     = "[-f] device",
        .help       = "eject a removable medium (use -f to force it)",
L
Luiz Capitulino 已提交
168
        .mhandler.cmd = hmp_eject,
169 170
    },

171 172
STEXI
@item eject [-f] @var{device}
173
@findex eject
174
Eject a removable medium (use -f to force it).
175 176 177 178
ETEXI

    {
        .name       = "drive_del",
179
        .args_type  = "id:B",
180 181 182 183 184 185 186 187 188 189 190 191 192
        .params     = "device",
        .help       = "remove host block device",
        .user_print = monitor_user_noop,
        .mhandler.cmd_new = do_drive_del,
    },

STEXI
@item drive_del @var{device}
@findex drive_del
Remove host block device.  The result is that guest generated IO is no longer
submitted against the host device underlying the disk.  Once a drive has
been deleted, the QEMU Block layer returns -EIO which results in IO
errors in the guest for applications that are reading/writing to the device.
193 194
These errors are always reported to the guest, regardless of the drive's error
actions (drive options rerror, werror).
195 196
ETEXI

197 198 199 200 201
    {
        .name       = "change",
        .args_type  = "device:B,target:F,arg:s?",
        .params     = "device filename [format]",
        .help       = "change a removable medium, optional format",
L
Luiz Capitulino 已提交
202
        .mhandler.cmd = hmp_change,
203 204
    },

205 206
STEXI
@item change @var{device} @var{setting}
207
@findex change
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242

Change the configuration of a device.

@table @option
@item change @var{diskdevice} @var{filename} [@var{format}]
Change the medium for a removable disk device to point to @var{filename}. eg

@example
(qemu) change ide1-cd0 /path/to/some.iso
@end example

@var{format} is optional.

@item change vnc @var{display},@var{options}
Change the configuration of the VNC server. The valid syntax for @var{display}
and @var{options} are described at @ref{sec_invocation}. eg

@example
(qemu) change vnc localhost:1
@end example

@item change vnc password [@var{password}]

Change the password associated with the VNC server. If the new password is not
supplied, the monitor will prompt for it to be entered. VNC passwords are only
significant up to 8 letters. eg

@example
(qemu) change vnc password
Password: ********
@end example

@end table
ETEXI

243 244 245 246 247
    {
        .name       = "screendump",
        .args_type  = "filename:F",
        .params     = "filename",
        .help       = "save screen into PPM image 'filename'",
L
Luiz Capitulino 已提交
248
        .mhandler.cmd = hmp_screen_dump,
249 250
    },

251 252
STEXI
@item screendump @var{filename}
253
@findex screendump
254 255 256
Save screen into PPM image @var{filename}.
ETEXI

257 258 259 260 261
    {
        .name       = "logfile",
        .args_type  = "filename:F",
        .params     = "filename",
        .help       = "output logs to 'filename'",
262
        .mhandler.cmd = do_logfile,
263 264
    },

265 266
STEXI
@item logfile @var{filename}
267
@findex logfile
268 269 270
Output logs to @var{filename}.
ETEXI

271 272 273 274 275
    {
        .name       = "trace-event",
        .args_type  = "name:s,option:b",
        .params     = "name on|off",
        .help       = "changes status of a specific trace event",
276
        .mhandler.cmd = do_trace_event_set_state,
277 278 279 280 281 282
    },

STEXI
@item trace-event
@findex trace-event
changes status of a trace event
283 284
ETEXI

M
Michael Roth 已提交
285
#if defined(CONFIG_TRACE_SIMPLE)
286 287 288 289 290 291 292 293 294 295 296 297
    {
        .name       = "trace-file",
        .args_type  = "op:s?,arg:F?",
        .params     = "on|off|flush|set [arg]",
        .help       = "open, close, or flush trace file, or set a new file name",
        .mhandler.cmd = do_trace_file,
    },

STEXI
@item trace-file on|off|flush
@findex trace-file
Open, close, or flush the trace file.  If no argument is given, the status of the trace file is displayed.
298 299 300
ETEXI
#endif

301 302 303 304
    {
        .name       = "log",
        .args_type  = "items:s",
        .params     = "item1[,...]",
305
        .help       = "activate logging of the specified items",
306
        .mhandler.cmd = do_log,
307 308
    },

309 310
STEXI
@item log @var{item1}[,...]
311
@findex log
312
Activate logging of the specified items.
313 314
ETEXI

315 316 317 318 319
    {
        .name       = "savevm",
        .args_type  = "name:s?",
        .params     = "[tag|id]",
        .help       = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
320
        .mhandler.cmd = do_savevm,
321 322
    },

323 324
STEXI
@item savevm [@var{tag}|@var{id}]
325
@findex savevm
326 327 328 329 330 331
Create a snapshot of the whole virtual machine. If @var{tag} is
provided, it is used as human readable identifier. If there is already
a snapshot with the same tag or ID, it is replaced. More info at
@ref{vm_snapshots}.
ETEXI

332 333 334 335 336
    {
        .name       = "loadvm",
        .args_type  = "name:s",
        .params     = "tag|id",
        .help       = "restore a VM snapshot from its tag or id",
337
        .mhandler.cmd = do_loadvm,
338
        .command_completion = loadvm_completion,
339 340
    },

341 342
STEXI
@item loadvm @var{tag}|@var{id}
343
@findex loadvm
344 345 346 347
Set the whole virtual machine to the snapshot identified by the tag
@var{tag} or the unique snapshot ID @var{id}.
ETEXI

348 349 350 351 352
    {
        .name       = "delvm",
        .args_type  = "name:s",
        .params     = "tag|id",
        .help       = "delete a VM snapshot from its tag or id",
353
        .mhandler.cmd = do_delvm,
354
        .command_completion = delvm_completion,
355 356
    },

357 358
STEXI
@item delvm @var{tag}|@var{id}
359
@findex delvm
360 361 362
Delete the snapshot identified by @var{tag} or @var{id}.
ETEXI

363 364 365 366 367
    {
        .name       = "singlestep",
        .args_type  = "option:s?",
        .params     = "[on|off]",
        .help       = "run emulation in singlestep mode or switch to normal mode",
368
        .mhandler.cmd = do_singlestep,
369 370
    },

371 372
STEXI
@item singlestep [off]
373
@findex singlestep
374 375 376 377
Run the emulation in single step mode.
If called with option off, the emulation returns to normal mode.
ETEXI

378 379 380 381 382
    {
        .name       = "stop",
        .args_type  = "",
        .params     = "",
        .help       = "stop emulation",
L
Luiz Capitulino 已提交
383
        .mhandler.cmd = hmp_stop,
384 385
    },

386 387
STEXI
@item stop
388
@findex stop
389 390 391
Stop emulation.
ETEXI

392 393 394 395 396
    {
        .name       = "c|cont",
        .args_type  = "",
        .params     = "",
        .help       = "resume emulation",
L
Luiz Capitulino 已提交
397
        .mhandler.cmd = hmp_cont,
398 399
    },

400 401
STEXI
@item c or cont
402
@findex cont
403
Resume emulation.
404 405 406 407 408 409 410 411 412 413 414 415 416 417
ETEXI

    {
        .name       = "system_wakeup",
        .args_type  = "",
        .params     = "",
        .help       = "wakeup guest from suspend",
        .mhandler.cmd = hmp_system_wakeup,
    },

STEXI
@item system_wakeup
@findex system_wakeup
Wakeup guest from suspend.
418 419
ETEXI

420 421 422 423 424
    {
        .name       = "gdbserver",
        .args_type  = "device:s?",
        .params     = "[device]",
        .help       = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
425
        .mhandler.cmd = do_gdbserver,
426 427
    },

428 429
STEXI
@item gdbserver [@var{port}]
430
@findex gdbserver
431 432 433
Start gdbserver session (default @var{port}=1234)
ETEXI

434 435 436 437 438
    {
        .name       = "x",
        .args_type  = "fmt:/,addr:l",
        .params     = "/fmt addr",
        .help       = "virtual memory dump starting at 'addr'",
439
        .mhandler.cmd = do_memory_dump,
440 441
    },

442 443
STEXI
@item x/fmt @var{addr}
444
@findex x
445 446 447
Virtual memory dump starting at @var{addr}.
ETEXI

448 449 450 451 452
    {
        .name       = "xp",
        .args_type  = "fmt:/,addr:l",
        .params     = "/fmt addr",
        .help       = "physical memory dump starting at 'addr'",
453
        .mhandler.cmd = do_physical_memory_dump,
454 455
    },

456 457
STEXI
@item xp /@var{fmt} @var{addr}
458
@findex xp
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
Physical memory dump starting at @var{addr}.

@var{fmt} is a format which tells the command how to format the
data. Its syntax is: @option{/@{count@}@{format@}@{size@}}

@table @var
@item count
is the number of items to be dumped.

@item format
can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
c (char) or i (asm instruction).

@item size
can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
@code{h} or @code{w} can be specified with the @code{i} format to
respectively select 16 or 32 bit code instruction size.

@end table

Examples:
@itemize
@item
Dump 10 instructions at the current instruction pointer:
@example
(qemu) x/10i $eip
0x90107063:  ret
0x90107064:  sti
0x90107065:  lea    0x0(%esi,1),%esi
0x90107069:  lea    0x0(%edi,1),%edi
0x90107070:  ret
0x90107071:  jmp    0x90107080
0x90107073:  nop
0x90107074:  nop
0x90107075:  nop
0x90107076:  nop
@end example

@item
Dump 80 16 bit values at the start of the video memory.
@smallexample
(qemu) xp/80hx 0xb8000
0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
@end smallexample
@end itemize
ETEXI

515 516 517 518 519
    {
        .name       = "p|print",
        .args_type  = "fmt:/,val:l",
        .params     = "/fmt expr",
        .help       = "print expression value (use $reg for CPU register access)",
520
        .mhandler.cmd = do_print,
521 522
    },

523 524
STEXI
@item p or print/@var{fmt} @var{expr}
525
@findex print
526 527 528 529 530

Print expression value. Only the @var{format} part of @var{fmt} is
used.
ETEXI

531 532 533 534 535
    {
        .name       = "i",
        .args_type  = "fmt:/,addr:i,index:i.",
        .params     = "/fmt addr",
        .help       = "I/O port read",
536
        .mhandler.cmd = do_ioport_read,
537 538
    },

539 540 541 542
STEXI
Read I/O port.
ETEXI

543 544 545 546 547
    {
        .name       = "o",
        .args_type  = "fmt:/,addr:i,val:i",
        .params     = "/fmt addr value",
        .help       = "I/O port write",
548
        .mhandler.cmd = do_ioport_write,
549 550
    },

J
Jan Kiszka 已提交
551 552 553
STEXI
Write to I/O port.
ETEXI
554

555 556
    {
        .name       = "sendkey",
A
Amos Kong 已提交
557
        .args_type  = "keys:s,hold-time:i?",
558 559
        .params     = "keys [hold_ms]",
        .help       = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
A
Amos Kong 已提交
560
        .mhandler.cmd = hmp_send_key,
561
        .command_completion = sendkey_completion,
562 563
    },

564 565
STEXI
@item sendkey @var{keys}
566
@findex sendkey
567

568 569 570
Send @var{keys} to the guest. @var{keys} could be the name of the
key or the raw value in hexadecimal format. Use @code{-} to press
several keys simultaneously. Example:
571 572 573 574 575 576 577 578
@example
sendkey ctrl-alt-f1
@end example

This command is useful to send keys that your graphical user interface
intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
ETEXI

579 580 581 582 583
    {
        .name       = "system_reset",
        .args_type  = "",
        .params     = "",
        .help       = "reset the system",
L
Luiz Capitulino 已提交
584
        .mhandler.cmd = hmp_system_reset,
585 586
    },

587 588
STEXI
@item system_reset
589
@findex system_reset
590 591 592 593

Reset the system.
ETEXI

594 595 596 597 598
    {
        .name       = "system_powerdown",
        .args_type  = "",
        .params     = "",
        .help       = "send system power down event",
L
Luiz Capitulino 已提交
599
        .mhandler.cmd = hmp_system_powerdown,
600 601
    },

602 603
STEXI
@item system_powerdown
604
@findex system_powerdown
605 606 607 608

Power down the system (if supported).
ETEXI

609 610 611 612 613
    {
        .name       = "sum",
        .args_type  = "start:i,size:i",
        .params     = "addr size",
        .help       = "compute the checksum of a memory region",
614
        .mhandler.cmd = do_sum,
615 616
    },

617 618
STEXI
@item sum @var{addr} @var{size}
619
@findex sum
620 621 622 623

Compute the checksum of a memory region.
ETEXI

624 625 626 627 628
    {
        .name       = "usb_add",
        .args_type  = "devname:s",
        .params     = "device",
        .help       = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
629
        .mhandler.cmd = do_usb_add,
630 631
    },

632 633
STEXI
@item usb_add @var{devname}
634
@findex usb_add
635 636 637 638 639

Add the USB device @var{devname}.  For details of available devices see
@ref{usb_devices}
ETEXI

640 641 642 643 644
    {
        .name       = "usb_del",
        .args_type  = "devname:s",
        .params     = "device",
        .help       = "remove USB device 'bus.addr'",
645
        .mhandler.cmd = do_usb_del,
646 647
    },

648 649
STEXI
@item usb_del @var{devname}
650
@findex usb_del
651 652 653 654 655 656

Remove the USB device @var{devname} from the QEMU virtual USB
hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
command @code{info usb} to see the devices you can remove.
ETEXI

657 658
    {
        .name       = "device_add",
659 660
        .args_type  = "device:O",
        .params     = "driver[,prop=value][,...]",
661
        .help       = "add device, like -device on the command line",
662 663
        .user_print = monitor_user_noop,
        .mhandler.cmd_new = do_device_add,
664
        .command_completion = device_add_completion,
665 666
    },

667 668
STEXI
@item device_add @var{config}
669
@findex device_add
670 671 672 673

Add device.
ETEXI

674 675 676 677 678
    {
        .name       = "device_del",
        .args_type  = "id:s",
        .params     = "device",
        .help       = "remove device",
L
Luiz Capitulino 已提交
679
        .mhandler.cmd = hmp_device_del,
680
        .command_completion = device_del_completion,
681 682
    },

683 684
STEXI
@item device_del @var{id}
685
@findex device_del
686 687 688 689

Remove device @var{id}.
ETEXI

690 691 692 693 694
    {
        .name       = "cpu",
        .args_type  = "index:i",
        .params     = "index",
        .help       = "set the default CPU",
L
Luiz Capitulino 已提交
695
        .mhandler.cmd = hmp_cpu,
696
    },
697

698
STEXI
699 700
@item cpu @var{index}
@findex cpu
701 702 703
Set the default CPU.
ETEXI

704 705 706 707 708
    {
        .name       = "mouse_move",
        .args_type  = "dx_str:s,dy_str:s,dz_str:s?",
        .params     = "dx dy [dz]",
        .help       = "send mouse move events",
709
        .mhandler.cmd = do_mouse_move,
710 711
    },

712 713
STEXI
@item mouse_move @var{dx} @var{dy} [@var{dz}]
714
@findex mouse_move
715 716 717 718
Move the active mouse to the specified coordinates @var{dx} @var{dy}
with optional scroll axis @var{dz}.
ETEXI

719 720 721 722 723
    {
        .name       = "mouse_button",
        .args_type  = "button_state:i",
        .params     = "state",
        .help       = "change mouse button state (1=L, 2=M, 4=R)",
724
        .mhandler.cmd = do_mouse_button,
725 726
    },

727 728
STEXI
@item mouse_button @var{val}
729
@findex mouse_button
730 731 732
Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
ETEXI

733 734 735 736 737
    {
        .name       = "mouse_set",
        .args_type  = "index:i",
        .params     = "index",
        .help       = "set which mouse device receives events",
738
        .mhandler.cmd = do_mouse_set,
739 740
    },

741 742
STEXI
@item mouse_set @var{index}
743
@findex mouse_set
744 745 746 747 748 749 750
Set which mouse device receives events at given @var{index}, index
can be obtained with
@example
info mice
@end example
ETEXI

751 752 753 754 755
    {
        .name       = "wavcapture",
        .args_type  = "path:F,freq:i?,bits:i?,nchannels:i?",
        .params     = "path [frequency [bits [channels]]]",
        .help       = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
756
        .mhandler.cmd = do_wav_capture,
757
    },
758 759
STEXI
@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
760
@findex wavcapture
761 762 763 764 765 766 767 768 769 770 771
Capture audio into @var{filename}. Using sample rate @var{frequency}
bits per sample @var{bits} and number of channels @var{channels}.

Defaults:
@itemize @minus
@item Sample rate = 44100 Hz - CD quality
@item Bits = 16
@item Number of channels = 2 - Stereo
@end itemize
ETEXI

772 773 774 775 776
    {
        .name       = "stopcapture",
        .args_type  = "n:i",
        .params     = "capture index",
        .help       = "stop capture",
777
        .mhandler.cmd = do_stop_capture,
778
    },
779 780
STEXI
@item stopcapture @var{index}
781
@findex stopcapture
782 783 784 785 786 787
Stop capture with a given @var{index}, index can be obtained with
@example
info capture
@end example
ETEXI

788 789 790 791 792
    {
        .name       = "memsave",
        .args_type  = "val:l,size:i,filename:s",
        .params     = "addr size file",
        .help       = "save to disk virtual memory dump starting at 'addr' of size 'size'",
L
Luiz Capitulino 已提交
793
        .mhandler.cmd = hmp_memsave,
794 795
    },

796 797
STEXI
@item memsave @var{addr} @var{size} @var{file}
798
@findex memsave
799 800 801
save to disk virtual memory dump starting at @var{addr} of size @var{size}.
ETEXI

802 803 804 805 806
    {
        .name       = "pmemsave",
        .args_type  = "val:l,size:i,filename:s",
        .params     = "addr size file",
        .help       = "save to disk physical memory dump starting at 'addr' of size 'size'",
L
Luiz Capitulino 已提交
807
        .mhandler.cmd = hmp_pmemsave,
808 809
    },

810 811
STEXI
@item pmemsave @var{addr} @var{size} @var{file}
812
@findex pmemsave
813 814 815
save to disk physical memory dump starting at @var{addr} of size @var{size}.
ETEXI

816 817 818 819 820
    {
        .name       = "boot_set",
        .args_type  = "bootdevice:s",
        .params     = "bootdevice",
        .help       = "define new values for the boot device list",
821
        .mhandler.cmd = do_boot_set,
822 823
    },

824 825
STEXI
@item boot_set @var{bootdevicelist}
826
@findex boot_set
827 828 829 830 831 832 833 834

Define new values for the boot device list. Those values will override
the values specified on the command line through the @code{-boot} option.

The values that can be specified here depend on the machine type, but are
the same that can be specified in the @code{-boot} command line option.
ETEXI

835
#if defined(TARGET_I386) || defined(TARGET_S390X)
836 837
    {
        .name       = "nmi",
838 839 840
        .args_type  = "",
        .params     = "",
        .help       = "inject an NMI on all guest's CPUs",
L
Luiz Capitulino 已提交
841
        .mhandler.cmd = hmp_inject_nmi,
842
    },
843 844 845
#endif
STEXI
@item nmi @var{cpu}
846
@findex nmi
847
Inject an NMI (x86) or RESTART (s390x) on the given CPU.
848 849 850 851

ETEXI

    {
852
        .name       = "ringbuf_write",
853 854
        .args_type  = "device:s,data:s",
        .params     = "device data",
855 856
        .help       = "Write to a ring buffer character device",
        .mhandler.cmd = hmp_ringbuf_write,
857
        .command_completion = ringbuf_write_completion,
858 859 860
    },

STEXI
861 862 863 864
@item ringbuf_write @var{device} @var{data}
@findex ringbuf_write
Write @var{data} to ring buffer character device @var{device}.
@var{data} must be a UTF-8 string.
865

866 867 868
ETEXI

    {
869
        .name       = "ringbuf_read",
870 871
        .args_type  = "device:s,size:i",
        .params     = "device size",
872 873
        .help       = "Read from a ring buffer character device",
        .mhandler.cmd = hmp_ringbuf_read,
874
        .command_completion = ringbuf_write_completion,
875 876 877
    },

STEXI
878 879 880 881
@item ringbuf_read @var{device}
@findex ringbuf_read
Read and print up to @var{size} bytes from ring buffer character
device @var{device}.
882 883
Certain non-printable characters are printed \uXXXX, where XXXX is the
character code in hexadecimal.  Character \ is printed \\.
884 885 886
Bug: can screw up when the buffer contains invalid UTF-8 sequences,
NUL characters, after the ring buffer lost data, and when reading
stops because the size limit is reached.
887

888 889
ETEXI

890 891
    {
        .name       = "migrate",
892 893 894 895 896 897 898
        .args_type  = "detach:-d,blk:-b,inc:-i,uri:s",
        .params     = "[-d] [-b] [-i] uri",
        .help       = "migrate to URI (using -d to not wait for completion)"
		      "\n\t\t\t -b for migration without shared storage with"
		      " full copy of disk\n\t\t\t -i for migration without "
		      "shared storage with incremental copy of disk "
		      "(base image shared between src and destination)",
L
Luiz Capitulino 已提交
899
        .mhandler.cmd = hmp_migrate,
900 901
    },

902

903
STEXI
904
@item migrate [-d] [-b] [-i] @var{uri}
905
@findex migrate
906
Migrate to @var{uri} (using -d to not wait for completion).
907 908
	-b for migration with full copy of disk
	-i for migration with incremental copy of disk (base image is shared)
909 910
ETEXI

911 912 913 914 915
    {
        .name       = "migrate_cancel",
        .args_type  = "",
        .params     = "",
        .help       = "cancel the current VM migration",
L
Luiz Capitulino 已提交
916
        .mhandler.cmd = hmp_migrate_cancel,
917 918
    },

919 920
STEXI
@item migrate_cancel
921
@findex migrate_cancel
922
Cancel the current VM migration.
923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942

ETEXI

    {
        .name       = "migrate_set_cache_size",
        .args_type  = "value:o",
        .params     = "value",
        .help       = "set cache size (in bytes) for XBZRLE migrations,"
                      "the cache size will be rounded down to the nearest "
                      "power of 2.\n"
                      "The cache size affects the number of cache misses."
                      "In case of a high cache miss ratio you need to increase"
                      " the cache size",
        .mhandler.cmd = hmp_migrate_set_cache_size,
    },

STEXI
@item migrate_set_cache_size @var{value}
@findex migrate_set_cache_size
Set cache size to @var{value} (in bytes) for xbzrle migrations.
943 944
ETEXI

945 946
    {
        .name       = "migrate_set_speed",
947
        .args_type  = "value:o",
948
        .params     = "value",
949 950
        .help       = "set maximum speed (in bytes) for migrations. "
	"Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
L
Luiz Capitulino 已提交
951
        .mhandler.cmd = hmp_migrate_set_speed,
952 953
    },

954 955
STEXI
@item migrate_set_speed @var{value}
956
@findex migrate_set_speed
957
Set maximum speed to @var{value} (in bytes) for migrations.
G
Glauber Costa 已提交
958 959
ETEXI

960 961
    {
        .name       = "migrate_set_downtime",
962
        .args_type  = "value:T",
963 964
        .params     = "value",
        .help       = "set maximum tolerated downtime (in seconds) for migrations",
965
        .mhandler.cmd = hmp_migrate_set_downtime,
966
    },
G
Glauber Costa 已提交
967 968 969

STEXI
@item migrate_set_downtime @var{second}
970
@findex migrate_set_downtime
G
Glauber Costa 已提交
971
Set maximum tolerated downtime (in seconds) for migration.
O
Orit Wasserman 已提交
972 973 974 975 976 977 978 979
ETEXI

    {
        .name       = "migrate_set_capability",
        .args_type  = "capability:s,state:b",
        .params     = "capability state",
        .help       = "Enable/Disable the usage of a capability for migration",
        .mhandler.cmd = hmp_migrate_set_capability,
980
        .command_completion = migrate_set_capability_completion,
O
Orit Wasserman 已提交
981 982 983 984 985 986
    },

STEXI
@item migrate_set_capability @var{capability} @var{state}
@findex migrate_set_capability
Enable/Disable the usage of a capability @var{capability} for migration.
987 988 989
ETEXI

    {
990 991 992 993 994
        .name       = "client_migrate_info",
        .args_type  = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
        .params     = "protocol hostname port tls-port cert-subject",
        .help       = "send migration info to spice/vnc client",
        .user_print = monitor_user_noop,
995 996
        .mhandler.cmd_async = client_migrate_info,
        .flags      = MONITOR_CMD_ASYNC,
997 998
    },

G
Gerd Hoffmann 已提交
999 1000 1001 1002 1003 1004 1005 1006
STEXI
@item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
@findex client_migrate_info
Set the spice/vnc connection info for the migration target.  The spice/vnc
server will ask the spice/vnc client to automatically reconnect using the
new parameters (if specified) once the vm migration finished successfully.
ETEXI

1007 1008
    {
        .name       = "dump-guest-memory",
1009 1010
        .args_type  = "paging:-p,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:i?,length:i?",
        .params     = "[-p] [-z|-l|-s] filename [begin length]",
Q
Qiao Nuohan 已提交
1011 1012
        .help       = "dump guest memory into file 'filename'.\n\t\t\t"
                      "-p: do paging to get guest's memory mapping.\n\t\t\t"
1013 1014 1015
                      "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
                      "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
                      "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
Q
Qiao Nuohan 已提交
1016 1017
                      "begin: the starting physical address.\n\t\t\t"
                      "length: the memory size, in bytes.",
1018 1019 1020 1021 1022
        .mhandler.cmd = hmp_dump_guest_memory,
    },


STEXI
Q
Qiao Nuohan 已提交
1023
@item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
1024
@item dump-guest-memory [-z|-l|-s] @var{filename}
1025 1026
@findex dump-guest-memory
Dump guest memory to @var{protocol}. The file can be processed with crash or
1027
gdb. Without -z|-l|-s, the dump format is ELF.
Q
Qiao Nuohan 已提交
1028
        -p: do paging to get guest's memory mapping.
1029 1030 1031
        -z: dump in kdump-compressed format, with zlib compression.
        -l: dump in kdump-compressed format, with lzo compression.
        -s: dump in kdump-compressed format, with snappy compression.
Q
Qiao Nuohan 已提交
1032
  filename: dump file name.
1033
     begin: the starting physical address. It's optional, and should be
Q
Qiao Nuohan 已提交
1034
            specified together with length.
1035
    length: the memory size, in bytes. It's optional, and should be specified
Q
Qiao Nuohan 已提交
1036
            together with begin.
1037 1038
ETEXI

G
Gerd Hoffmann 已提交
1039
    {
1040
        .name       = "snapshot_blkdev",
1041 1042
        .args_type  = "reuse:-n,device:B,snapshot-file:s?,format:s?",
        .params     = "[-n] device [new-image-file] [format]",
1043 1044 1045 1046
        .help       = "initiates a live snapshot\n\t\t\t"
                      "of device. If a new image file is specified, the\n\t\t\t"
                      "new image file will become the new root image.\n\t\t\t"
                      "If format is specified, the snapshot file will\n\t\t\t"
1047
                      "be created in that format.\n\t\t\t"
1048 1049 1050
                      "The default format is qcow2.  The -n flag requests QEMU\n\t\t\t"
                      "to reuse the image found in new-image-file, instead of\n\t\t\t"
                      "recreating it from scratch.",
1051
        .mhandler.cmd = hmp_snapshot_blkdev,
G
Gerd Hoffmann 已提交
1052 1053
    },

1054 1055 1056 1057
STEXI
@item snapshot_blkdev
@findex snapshot_blkdev
Snapshot device, using snapshot file as target if provided
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073
ETEXI

    {
        .name       = "snapshot_blkdev_internal",
        .args_type  = "device:B,name:s",
        .params     = "device name",
        .help       = "take an internal snapshot of device.\n\t\t\t"
                      "The format of the image used by device must\n\t\t\t"
                      "support it, such as qcow2.\n\t\t\t",
        .mhandler.cmd = hmp_snapshot_blkdev_internal,
    },

STEXI
@item snapshot_blkdev_internal
@findex snapshot_blkdev_internal
Take an internal snapshot on device if it support
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091
ETEXI

    {
        .name       = "snapshot_delete_blkdev_internal",
        .args_type  = "device:B,name:s,id:s?",
        .params     = "device name [id]",
        .help       = "delete an internal snapshot of device.\n\t\t\t"
                      "If id is specified, qemu will try delete\n\t\t\t"
                      "the snapshot matching both id and name.\n\t\t\t"
                      "The format of the image used by device must\n\t\t\t"
                      "support it, such as qcow2.\n\t\t\t",
        .mhandler.cmd = hmp_snapshot_delete_blkdev_internal,
    },

STEXI
@item snapshot_delete_blkdev_internal
@findex snapshot_delete_blkdev_internal
Delete an internal snapshot on device if it support
P
Paolo Bonzini 已提交
1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112
ETEXI

    {
        .name       = "drive_mirror",
        .args_type  = "reuse:-n,full:-f,device:B,target:s,format:s?",
        .params     = "[-n] [-f] device target [format]",
        .help       = "initiates live storage\n\t\t\t"
                      "migration for a device. The device's contents are\n\t\t\t"
                      "copied to the new image file, including data that\n\t\t\t"
                      "is written after the command is started.\n\t\t\t"
                      "The -n flag requests QEMU to reuse the image found\n\t\t\t"
                      "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
                      "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
                      "so that the result does not need a backing file.\n\t\t\t",
        .mhandler.cmd = hmp_drive_mirror,
    },
STEXI
@item drive_mirror
@findex drive_mirror
Start mirroring a block device's writes to a new destination,
using the specified target.
1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132
ETEXI

    {
        .name       = "drive_backup",
        .args_type  = "reuse:-n,full:-f,device:B,target:s,format:s?",
        .params     = "[-n] [-f] device target [format]",
        .help       = "initiates a point-in-time\n\t\t\t"
                      "copy for a device. The device's contents are\n\t\t\t"
                      "copied to the new image file, excluding data that\n\t\t\t"
                      "is written after the command is started.\n\t\t\t"
                      "The -n flag requests QEMU to reuse the image found\n\t\t\t"
                      "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
                      "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
                      "so that the result does not need a backing file.\n\t\t\t",
        .mhandler.cmd = hmp_drive_backup,
    },
STEXI
@item drive_backup
@findex drive_backup
Start a point-in-time copy of a block device to a specificed target.
1133 1134
ETEXI

1135 1136 1137 1138 1139
    {
        .name       = "drive_add",
        .args_type  = "pci_addr:s,opts:s",
        .params     = "[[<domain>:]<bus>:]<slot>\n"
                      "[file=file][,if=type][,bus=n]\n"
1140
                      "[,unit=m][,media=d][,index=i]\n"
1141
                      "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
1142 1143
                      "[,snapshot=on|off][,cache=on|off]\n"
                      "[,readonly=on|off][,copy-on-read=on|off]",
1144
        .help       = "add drive to PCI storage controller",
1145
        .mhandler.cmd = drive_hot_add,
1146 1147
    },

1148 1149
STEXI
@item drive_add
1150
@findex drive_add
1151 1152 1153
Add drive to PCI storage controller.
ETEXI

1154
#if defined(CONFIG_PCI_HOTPLUG_OLD)
1155 1156 1157 1158 1159
    {
        .name       = "pci_add",
        .args_type  = "pci_addr:s,type:s,opts:s?",
        .params     = "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...",
        .help       = "hot-add PCI device",
1160
        .mhandler.cmd = pci_device_hot_add,
1161
    },
1162
#endif
1163

1164 1165
STEXI
@item pci_add
1166
@findex pci_add
1167 1168 1169
Hot-add PCI device.
ETEXI

1170
#if defined(CONFIG_PCI_HOTPLUG_OLD)
1171 1172 1173 1174 1175
    {
        .name       = "pci_del",
        .args_type  = "pci_addr:s",
        .params     = "[[<domain>:]<bus>:]<slot>",
        .help       = "hot remove PCI device",
1176
        .mhandler.cmd = do_pci_device_hot_remove,
1177
    },
1178
#endif
1179

1180 1181
STEXI
@item pci_del
1182
@findex pci_del
1183
Hot remove PCI device.
1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201
ETEXI

    {
        .name       = "pcie_aer_inject_error",
        .args_type  = "advisory_non_fatal:-a,correctable:-c,"
	              "id:s,error_status:s,"
	              "header0:i?,header1:i?,header2:i?,header3:i?,"
	              "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
        .params     = "[-a] [-c] id "
                      "<error_status> [<tlp header> [<tlp header prefix>]]",
        .help       = "inject pcie aer error\n\t\t\t"
	              " -a for advisory non fatal error\n\t\t\t"
	              " -c for correctable error\n\t\t\t"
                      "<id> = qdev device id\n\t\t\t"
                      "<error_status> = error string or 32bit\n\t\t\t"
                      "<tlb header> = 32bit x 4\n\t\t\t"
                      "<tlb header prefix> = 32bit x 4",
        .user_print  = pcie_aer_inject_error_print,
1202
        .mhandler.cmd_new = do_pcie_aer_inject_error,
1203 1204 1205 1206 1207 1208
    },

STEXI
@item pcie_aer_inject_error
@findex pcie_aer_inject_error
Inject PCIe AER error
1209 1210
ETEXI

1211 1212 1213
    {
        .name       = "host_net_add",
        .args_type  = "device:s,opts:s?",
1214
        .params     = "tap|user|socket|vde|netmap|bridge|vhost-user|dump [options]",
1215
        .help       = "add host VLAN client",
1216
        .mhandler.cmd = net_host_device_add,
1217
        .command_completion = host_net_add_completion,
1218 1219
    },

1220 1221
STEXI
@item host_net_add
1222
@findex host_net_add
1223 1224 1225
Add host VLAN client.
ETEXI

1226 1227 1228 1229 1230
    {
        .name       = "host_net_remove",
        .args_type  = "vlan_id:i,device:s",
        .params     = "vlan_id name",
        .help       = "remove host VLAN client",
1231
        .mhandler.cmd = net_host_device_remove,
1232
        .command_completion = host_net_remove_completion,
1233 1234
    },

1235 1236
STEXI
@item host_net_remove
1237
@findex host_net_remove
1238
Remove host VLAN client.
1239 1240 1241 1242 1243
ETEXI

    {
        .name       = "netdev_add",
        .args_type  = "netdev:O",
1244
        .params     = "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
1245
        .help       = "add host network device",
L
Luiz Capitulino 已提交
1246
        .mhandler.cmd = hmp_netdev_add,
1247
        .command_completion = netdev_add_completion,
1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260
    },

STEXI
@item netdev_add
@findex netdev_add
Add host network device.
ETEXI

    {
        .name       = "netdev_del",
        .args_type  = "id:s",
        .params     = "id",
        .help       = "remove host network device",
L
Luiz Capitulino 已提交
1261
        .mhandler.cmd = hmp_netdev_del,
1262
        .command_completion = netdev_del_completion,
1263 1264 1265 1266 1267 1268
    },

STEXI
@item netdev_del
@findex netdev_del
Remove host network device.
1269 1270 1271 1272 1273 1274 1275 1276
ETEXI

    {
        .name       = "object_add",
        .args_type  = "object:O",
        .params     = "[qom-type=]type,id=str[,prop=value][,...]",
        .help       = "create QOM object",
        .mhandler.cmd = hmp_object_add,
1277
        .command_completion = object_add_completion,
1278 1279 1280 1281 1282 1283
    },

STEXI
@item object_add
@findex object_add
Create QOM object.
1284 1285 1286 1287 1288 1289 1290 1291
ETEXI

    {
        .name       = "object_del",
        .args_type  = "id:s",
        .params     = "id",
        .help       = "destroy QOM object",
        .mhandler.cmd = hmp_object_del,
1292
        .command_completion = object_del_completion,
1293 1294 1295 1296 1297 1298
    },

STEXI
@item object_del
@findex object_del
Destroy QOM object.
1299 1300 1301
ETEXI

#ifdef CONFIG_SLIRP
1302 1303 1304 1305 1306
    {
        .name       = "hostfwd_add",
        .args_type  = "arg1:s,arg2:s?,arg3:s?",
        .params     = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
        .help       = "redirect TCP or UDP connections from host to guest (requires -net user)",
1307
        .mhandler.cmd = net_slirp_hostfwd_add,
1308
    },
1309 1310 1311 1312 1313 1314
#endif
STEXI
@item hostfwd_add
@findex hostfwd_add
Redirect TCP or UDP connections from host to guest (requires -net user).
ETEXI
1315

1316
#ifdef CONFIG_SLIRP
1317 1318 1319 1320 1321
    {
        .name       = "hostfwd_remove",
        .args_type  = "arg1:s,arg2:s?,arg3:s?",
        .params     = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
        .help       = "remove host-to-guest TCP or UDP redirection",
1322
        .mhandler.cmd = net_slirp_hostfwd_remove,
1323 1324
    },

1325 1326
#endif
STEXI
1327 1328 1329
@item hostfwd_remove
@findex hostfwd_remove
Remove host-to-guest TCP or UDP redirection.
1330 1331
ETEXI

1332 1333
    {
        .name       = "balloon",
1334
        .args_type  = "value:M",
1335
        .params     = "target",
1336
        .help       = "request VM to change its memory allocation (in MB)",
L
Luiz Capitulino 已提交
1337
        .mhandler.cmd = hmp_balloon,
1338 1339
    },

1340 1341
STEXI
@item balloon @var{value}
1342
@findex balloon
1343 1344 1345
Request VM to change its memory allocation to @var{value} (in MB).
ETEXI

1346 1347
    {
        .name       = "set_link",
1348 1349
        .args_type  = "name:s,up:b",
        .params     = "name on|off",
1350
        .help       = "change the link status of a network adapter",
L
Luiz Capitulino 已提交
1351
        .mhandler.cmd = hmp_set_link,
1352
        .command_completion = set_link_completion,
1353 1354
    },

1355
STEXI
1356
@item set_link @var{name} [on|off]
1357
@findex set_link
1358
Switch link @var{name} on (i.e. up) or off (i.e. down).
1359 1360
ETEXI

1361 1362 1363 1364 1365
    {
        .name       = "watchdog_action",
        .args_type  = "action:s",
        .params     = "[reset|shutdown|poweroff|pause|debug|none]",
        .help       = "change watchdog action",
1366
        .mhandler.cmd = do_watchdog_action,
1367
        .command_completion = watchdog_action_completion,
1368 1369
    },

1370 1371
STEXI
@item watchdog_action
1372
@findex watchdog_action
1373 1374 1375
Change watchdog action.
ETEXI

1376 1377 1378 1379 1380
    {
        .name       = "acl_show",
        .args_type  = "aclname:s",
        .params     = "aclname",
        .help       = "list rules in the access control list",
1381
        .mhandler.cmd = do_acl_show,
1382 1383
    },

1384
STEXI
J
Jan Kiszka 已提交
1385
@item acl_show @var{aclname}
1386
@findex acl_show
J
Jan Kiszka 已提交
1387 1388 1389 1390 1391
List all the matching rules in the access control list, and the default
policy. There are currently two named access control lists,
@var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
certificate distinguished name, and SASL username respectively.
ETEXI
1392

1393 1394 1395 1396 1397
    {
        .name       = "acl_policy",
        .args_type  = "aclname:s,policy:s",
        .params     = "aclname allow|deny",
        .help       = "set default access control list policy",
1398
        .mhandler.cmd = do_acl_policy,
1399 1400
    },

J
Jan Kiszka 已提交
1401
STEXI
J
Jan Kiszka 已提交
1402
@item acl_policy @var{aclname} @code{allow|deny}
1403
@findex acl_policy
J
Jan Kiszka 已提交
1404
Set the default access control list policy, used in the event that
1405
none of the explicit rules match. The default policy at startup is
J
Jan Kiszka 已提交
1406 1407 1408
always @code{deny}.
ETEXI

1409 1410 1411 1412 1413
    {
        .name       = "acl_add",
        .args_type  = "aclname:s,match:s,policy:s,index:i?",
        .params     = "aclname match allow|deny [index]",
        .help       = "add a match rule to the access control list",
1414
        .mhandler.cmd = do_acl_add,
1415 1416
    },

J
Jan Kiszka 已提交
1417
STEXI
1418 1419
@item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
@findex acl_add
J
Jan Kiszka 已提交
1420 1421 1422 1423
Add a match rule to the access control list, allowing or denying access.
The match will normally be an exact username or x509 distinguished name,
but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
1424
normally be appended to the end of the ACL, but can be inserted
J
Jan Kiszka 已提交
1425 1426 1427
earlier in the list if the optional @var{index} parameter is supplied.
ETEXI

1428 1429 1430 1431 1432
    {
        .name       = "acl_remove",
        .args_type  = "aclname:s,match:s",
        .params     = "aclname match",
        .help       = "remove a match rule from the access control list",
1433
        .mhandler.cmd = do_acl_remove,
1434 1435
    },

J
Jan Kiszka 已提交
1436 1437
STEXI
@item acl_remove @var{aclname} @var{match}
1438
@findex acl_remove
J
Jan Kiszka 已提交
1439 1440 1441
Remove the specified match rule from the access control list.
ETEXI

1442 1443 1444 1445 1446
    {
        .name       = "acl_reset",
        .args_type  = "aclname:s",
        .params     = "aclname",
        .help       = "reset the access control list",
1447
        .mhandler.cmd = do_acl_reset,
1448 1449
    },

J
Jan Kiszka 已提交
1450
STEXI
1451 1452
@item acl_reset @var{aclname}
@findex acl_reset
J
Jan Kiszka 已提交
1453
Remove all matches from the access control list, and set the default
1454 1455 1456
policy back to @code{deny}.
ETEXI

P
Paolo Bonzini 已提交
1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501
    {
        .name       = "nbd_server_start",
        .args_type  = "all:-a,writable:-w,uri:s",
        .params     = "nbd_server_start [-a] [-w] host:port",
        .help       = "serve block devices on the given host and port",
        .mhandler.cmd = hmp_nbd_server_start,
    },
STEXI
@item nbd_server_start @var{host}:@var{port}
@findex nbd_server_start
Start an NBD server on the given host and/or port.  If the @option{-a}
option is included, all of the virtual machine's block devices that
have an inserted media on them are automatically exported; in this case,
the @option{-w} option makes the devices writable too.
ETEXI

    {
        .name       = "nbd_server_add",
        .args_type  = "writable:-w,device:B",
        .params     = "nbd_server_add [-w] device",
        .help       = "export a block device via NBD",
        .mhandler.cmd = hmp_nbd_server_add,
    },
STEXI
@item nbd_server_add @var{device}
@findex nbd_server_add
Export a block device through QEMU's NBD server, which must be started
beforehand with @command{nbd_server_start}.  The @option{-w} option makes the
exported device writable too.
ETEXI

    {
        .name       = "nbd_server_stop",
        .args_type  = "",
        .params     = "nbd_server_stop",
        .help       = "stop serving block devices using the NBD protocol",
        .mhandler.cmd = hmp_nbd_server_stop,
    },
STEXI
@item nbd_server_stop
@findex nbd_server_stop
Stop the QEMU embedded NBD server.
ETEXI


1502
#if defined(TARGET_I386)
1503 1504 1505

    {
        .name       = "mce",
1506 1507 1508
        .args_type  = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
        .params     = "[-b] cpu bank status mcgstatus addr misc",
        .help       = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1509
        .mhandler.cmd = do_inject_mce,
1510 1511
    },

1512 1513 1514
#endif
STEXI
@item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1515
@findex mce (x86)
1516
Inject an MCE on the given CPU (x86 only).
1517 1518
ETEXI

1519 1520 1521 1522 1523
    {
        .name       = "getfd",
        .args_type  = "fdname:s",
        .params     = "getfd name",
        .help       = "receive a file descriptor via SCM rights and assign it a name",
C
Corey Bryant 已提交
1524
        .mhandler.cmd = hmp_getfd,
1525 1526
    },

1527 1528
STEXI
@item getfd @var{fdname}
1529
@findex getfd
1530 1531 1532 1533 1534
If a file descriptor is passed alongside this command using the SCM_RIGHTS
mechanism on unix sockets, it is stored using the name @var{fdname} for
later use by other monitor commands.
ETEXI

1535 1536 1537 1538 1539
    {
        .name       = "closefd",
        .args_type  = "fdname:s",
        .params     = "closefd name",
        .help       = "close a file descriptor previously passed via SCM rights",
C
Corey Bryant 已提交
1540
        .mhandler.cmd = hmp_closefd,
1541 1542
    },

1543 1544
STEXI
@item closefd @var{fdname}
1545
@findex closefd
1546 1547 1548
Close the file descriptor previously assigned to @var{fdname} using the
@code{getfd} command. This is only needed if the file descriptor was never
used by another monitor command.
1549 1550 1551 1552 1553 1554 1555
ETEXI

    {
        .name       = "block_passwd",
        .args_type  = "device:B,password:s",
        .params     = "block_passwd device password",
        .help       = "set the password of encrypted block devices",
L
Luiz Capitulino 已提交
1556
        .mhandler.cmd = hmp_block_passwd,
1557 1558
    },

Z
Zhi Yong Wu 已提交
1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569
STEXI
@item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
@findex block_set_io_throttle
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}
ETEXI

    {
        .name       = "block_set_io_throttle",
        .args_type  = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
        .params     = "device bps bps_rd bps_wr iops iops_rd iops_wr",
        .help       = "change I/O throttle limits for a block drive",
1570
        .mhandler.cmd = hmp_block_set_io_throttle,
Z
Zhi Yong Wu 已提交
1571 1572
    },

1573 1574
STEXI
@item block_passwd @var{device} @var{password}
1575
@findex block_passwd
1576
Set the encrypted device @var{device} password to @var{password}
1577 1578 1579 1580 1581 1582 1583
ETEXI

    {
        .name       = "set_password",
        .args_type  = "protocol:s,password:s,connected:s?",
        .params     = "protocol password action-if-connected",
        .help       = "set spice/vnc password",
L
Luiz Capitulino 已提交
1584
        .mhandler.cmd = hmp_set_password,
1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603
    },

STEXI
@item set_password [ vnc | spice ] password [ action-if-connected ]
@findex set_password

Change spice/vnc password.  Use zero to make the password stay valid
forever.  @var{action-if-connected} specifies what should happen in
case a connection is established: @var{fail} makes the password change
fail.  @var{disconnect} changes the password and disconnects the
client.  @var{keep} changes the password and keeps the connection up.
@var{keep} is the default.
ETEXI

    {
        .name       = "expire_password",
        .args_type  = "protocol:s,time:s",
        .params     = "protocol time",
        .help       = "set spice/vnc password expire-time",
L
Luiz Capitulino 已提交
1604
        .mhandler.cmd = hmp_expire_password,
1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628
    },

STEXI
@item expire_password [ vnc | spice ] expire-time
@findex expire_password

Specify when a password for spice/vnc becomes
invalid. @var{expire-time} accepts:

@table @var
@item now
Invalidate password instantly.

@item never
Password stays valid forever.

@item +nsec
Password stays valid for @var{nsec} seconds starting now.

@item nsec
Password is invalidated at the given time.  @var{nsec} are the seconds
passed since 1970, i.e. unix epoch.

@end table
1629 1630
ETEXI

1631 1632 1633 1634 1635 1636
    {
        .name       = "chardev-add",
        .args_type  = "args:s",
        .params     = "args",
        .help       = "add chardev",
        .mhandler.cmd = hmp_chardev_add,
1637
        .command_completion = chardev_add_completion,
1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653
    },

STEXI
@item chardev_add args
@findex chardev_add

chardev_add accepts the same parameters as the -chardev command line switch.

ETEXI

    {
        .name       = "chardev-remove",
        .args_type  = "id:s",
        .params     = "id",
        .help       = "remove chardev",
        .mhandler.cmd = hmp_chardev_remove,
1654
        .command_completion = chardev_remove_completion,
1655 1656 1657 1658 1659 1660 1661 1662
    },

STEXI
@item chardev_remove id
@findex chardev_remove

Removes the chardev @var{id}.

1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678
ETEXI

    {
        .name       = "qemu-io",
        .args_type  = "device:B,command:s",
        .params     = "[device] \"[command]\"",
        .help       = "run a qemu-io command on a block device",
        .mhandler.cmd = hmp_qemu_io,
    },

STEXI
@item qemu-io @var{device} @var{command}
@findex qemu-io

Executes a qemu-io command on the given block device.

1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691
ETEXI

    {
        .name       = "cpu-add",
        .args_type  = "id:i",
        .params     = "id",
        .help       = "add cpu",
        .mhandler.cmd  = hmp_cpu_add,
    },

STEXI
@item cpu-add @var{id}
Add CPU with id @var{id}
1692
ETEXI
1693

J
Jan Kiszka 已提交
1694 1695 1696 1697 1698
    {
        .name       = "info",
        .args_type  = "item:s?",
        .params     = "[subcommand]",
        .help       = "show various information about the system state",
W
Wenchao Xia 已提交
1699 1700
        .mhandler.cmd = do_info_help,
        .sub_table = info_cmds,
J
Jan Kiszka 已提交
1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731
    },

STEXI
@item info @var{subcommand}
@findex info
Show various information about the system state.

@table @option
@item info version
show the version of QEMU
@item info network
show the various VLANs and the associated devices
@item info chardev
show the character devices
@item info block
show the block devices
@item info blockstats
show block device statistics
@item info registers
show the cpu registers
@item info cpus
show infos for each CPU
@item info history
show the command line history
@item info irq
show the interrupts statistics (if available)
@item info pic
show i8259 (PIC) state
@item info pci
show emulated PCI device info
@item info tlb
1732
show virtual to physical memory mappings (i386, SH4, SPARC, PPC, and Xtensa only)
J
Jan Kiszka 已提交
1733 1734 1735 1736 1737 1738
@item info mem
show the active virtual memory mappings (i386 only)
@item info jit
show dynamic compiler info
@item info numa
show NUMA information
1739 1740
@item info kvm
show KVM information
J
Jan Kiszka 已提交
1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768
@item info usb
show USB devices plugged on the virtual USB hub
@item info usbhost
show all USB host devices
@item info profile
show profiling information
@item info capture
show information about active capturing
@item info snapshots
show list of VM snapshots
@item info status
show the current VM status (running|paused)
@item info pcmcia
show guest PCMCIA status
@item info mice
show which guest mouse is receiving events
@item info vnc
show the vnc server status
@item info name
show the current VM name
@item info uuid
show the current VM UUID
@item info cpustats
show CPU statistics
@item info usernet
show user network stack connection states
@item info migrate
show migration status
O
Orit Wasserman 已提交
1769 1770
@item info migrate_capabilities
show current migration capabilities
1771 1772
@item info migrate_cache_size
show current migration XBZRLE cache size
J
Jan Kiszka 已提交
1773 1774 1775 1776 1777 1778 1779 1780
@item info balloon
show balloon information
@item info qtree
show device tree
@item info qdm
show qdev device model list
@item info roms
show roms
1781 1782
@item info tpm
show the TPM device
J
Jan Kiszka 已提交
1783 1784 1785
@end table
ETEXI

1786
STEXI
1787 1788 1789 1790
@item info trace-events
show available trace events and their state
ETEXI

1791 1792 1793
STEXI
@end table
ETEXI