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