hmp-commands.hx

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