hmp-commands.hx

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