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         .mhandler.cmd = hmp_device_add,
 657         .command_completion = device_add_completion,
 658     },
 659
 660 STEXI
 661 @item device_add @var{config}
 662 @findex device_add
 663 Add device.
 664 ETEXI
 665
 666     {
 667         .name       = "device_del",
 668         .args_type  = "id:s",
 669         .params     = "device",
 670         .help       = "remove device",
 671         .mhandler.cmd = hmp_device_del,
 672         .command_completion = device_del_completion,
 673     },
 674
 675 STEXI
 676 @item device_del @var{id}
 677 @findex device_del
 678 Remove device @var{id}.
 679 ETEXI
 680
 681     {
 682         .name       = "cpu",
 683         .args_type  = "index:i",
 684         .params     = "index",
 685         .help       = "set the default CPU",
 686         .mhandler.cmd = hmp_cpu,
 687     },
 688
 689 STEXI
 690 @item cpu @var{index}
 691 @findex cpu
 692 Set the default CPU.
 693 ETEXI
 694
 695     {
 696         .name       = "mouse_move",
 697         .args_type  = "dx_str:s,dy_str:s,dz_str:s?",
 698         .params     = "dx dy [dz]",
 699         .help       = "send mouse move events",
 700         .mhandler.cmd = hmp_mouse_move,
 701     },
 702
 703 STEXI
 704 @item mouse_move @var{dx} @var{dy} [@var{dz}]
 705 @findex mouse_move
 706 Move the active mouse to the specified coordinates @var{dx} @var{dy}
 707 with optional scroll axis @var{dz}.
 708 ETEXI
 709
 710     {
 711         .name       = "mouse_button",
 712         .args_type  = "button_state:i",
 713         .params     = "state",
 714         .help       = "change mouse button state (1=L, 2=M, 4=R)",
 715         .mhandler.cmd = hmp_mouse_button,
 716     },
 717
 718 STEXI
 719 @item mouse_button @var{val}
 720 @findex mouse_button
 721 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
 722 ETEXI
 723
 724     {
 725         .name       = "mouse_set",
 726         .args_type  = "index:i",
 727         .params     = "index",
 728         .help       = "set which mouse device receives events",
 729         .mhandler.cmd = hmp_mouse_set,
 730     },
 731
 732 STEXI
 733 @item mouse_set @var{index}
 734 @findex mouse_set
 735 Set which mouse device receives events at given @var{index}, index
 736 can be obtained with
 737 @example
 738 info mice
 739 @end example
 740 ETEXI
 741
 742     {
 743         .name       = "wavcapture",
 744         .args_type  = "path:F,freq:i?,bits:i?,nchannels:i?",
 745         .params     = "path [frequency [bits [channels]]]",
 746         .help       = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
 747         .mhandler.cmd = hmp_wavcapture,
 748     },
 749 STEXI
 750 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
 751 @findex wavcapture
 752 Capture audio into @var{filename}. Using sample rate @var{frequency}
 753 bits per sample @var{bits} and number of channels @var{channels}.
 754
 755 Defaults:
 756 @itemize @minus
 757 @item Sample rate = 44100 Hz - CD quality
 758 @item Bits = 16
 759 @item Number of channels = 2 - Stereo
 760 @end itemize
 761 ETEXI
 762
 763     {
 764         .name       = "stopcapture",
 765         .args_type  = "n:i",
 766         .params     = "capture index",
 767         .help       = "stop capture",
 768         .mhandler.cmd = hmp_stopcapture,
 769     },
 770 STEXI
 771 @item stopcapture @var{index}
 772 @findex stopcapture
 773 Stop capture with a given @var{index}, index can be obtained with
 774 @example
 775 info capture
 776 @end example
 777 ETEXI
 778
 779     {
 780         .name       = "memsave",
 781         .args_type  = "val:l,size:i,filename:s",
 782         .params     = "addr size file",
 783         .help       = "save to disk virtual memory dump starting at 'addr' of size 'size'",
 784         .mhandler.cmd = hmp_memsave,
 785     },
 786
 787 STEXI
 788 @item memsave @var{addr} @var{size} @var{file}
 789 @findex memsave
 790 save to disk virtual memory dump starting at @var{addr} of size @var{size}.
 791 ETEXI
 792
 793     {
 794         .name       = "pmemsave",
 795         .args_type  = "val:l,size:i,filename:s",
 796         .params     = "addr size file",
 797         .help       = "save to disk physical memory dump starting at 'addr' of size 'size'",
 798         .mhandler.cmd = hmp_pmemsave,
 799     },
 800
 801 STEXI
 802 @item pmemsave @var{addr} @var{size} @var{file}
 803 @findex pmemsave
 804 save to disk physical memory dump starting at @var{addr} of size @var{size}.
 805 ETEXI
 806
 807     {
 808         .name       = "boot_set",
 809         .args_type  = "bootdevice:s",
 810         .params     = "bootdevice",
 811         .help       = "define new values for the boot device list",
 812         .mhandler.cmd = hmp_boot_set,
 813     },
 814
 815 STEXI
 816 @item boot_set @var{bootdevicelist}
 817 @findex boot_set
 818 Define new values for the boot device list. Those values will override
 819 the values specified on the command line through the @code{-boot} option.
 820
 821 The values that can be specified here depend on the machine type, but are
 822 the same that can be specified in the @code{-boot} command line option.
 823 ETEXI
 824
 825     {
 826         .name       = "nmi",
 827         .args_type  = "",
 828         .params     = "",
 829         .help       = "inject an NMI",
 830         .mhandler.cmd = hmp_nmi,
 831     },
 832 STEXI
 833 @item nmi @var{cpu}
 834 @findex nmi
 835 Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
 836
 837 ETEXI
 838
 839     {
 840         .name       = "ringbuf_write",
 841         .args_type  = "device:s,data:s",
 842         .params     = "device data",
 843         .help       = "Write to a ring buffer character device",
 844         .mhandler.cmd = hmp_ringbuf_write,
 845         .command_completion = ringbuf_write_completion,
 846     },
 847
 848 STEXI
 849 @item ringbuf_write @var{device} @var{data}
 850 @findex ringbuf_write
 851 Write @var{data} to ring buffer character device @var{device}.
 852 @var{data} must be a UTF-8 string.
 853
 854 ETEXI
 855
 856     {
 857         .name       = "ringbuf_read",
 858         .args_type  = "device:s,size:i",
 859         .params     = "device size",
 860         .help       = "Read from a ring buffer character device",
 861         .mhandler.cmd = hmp_ringbuf_read,
 862         .command_completion = ringbuf_write_completion,
 863     },
 864
 865 STEXI
 866 @item ringbuf_read @var{device}
 867 @findex ringbuf_read
 868 Read and print up to @var{size} bytes from ring buffer character
 869 device @var{device}.
 870 Certain non-printable characters are printed \uXXXX, where XXXX is the
 871 character code in hexadecimal.  Character \ is printed \\.
 872 Bug: can screw up when the buffer contains invalid UTF-8 sequences,
 873 NUL characters, after the ring buffer lost data, and when reading
 874 stops because the size limit is reached.
 875
 876 ETEXI
 877
 878     {
 879         .name       = "migrate",
 880         .args_type  = "detach:-d,blk:-b,inc:-i,uri:s",
 881         .params     = "[-d] [-b] [-i] uri",
 882         .help       = "migrate to URI (using -d to not wait for completion)"
 883                       "\n\t\t\t -b for migration without shared storage with"
 884                       " full copy of disk\n\t\t\t -i for migration without "
 885                       "shared storage with incremental copy of disk "
 886                       "(base image shared between src and destination)",
 887         .mhandler.cmd = hmp_migrate,
 888     },
 889
 890
 891 STEXI
 892 @item migrate [-d] [-b] [-i] @var{uri}
 893 @findex migrate
 894 Migrate to @var{uri} (using -d to not wait for completion).
 895         -b for migration with full copy of disk
 896         -i for migration with incremental copy of disk (base image is shared)
 897 ETEXI
 898
 899     {
 900         .name       = "migrate_cancel",
 901         .args_type  = "",
 902         .params     = "",
 903         .help       = "cancel the current VM migration",
 904         .mhandler.cmd = hmp_migrate_cancel,
 905     },
 906
 907 STEXI
 908 @item migrate_cancel
 909 @findex migrate_cancel
 910 Cancel the current VM migration.
 911
 912 ETEXI
 913
 914     {
 915         .name       = "migrate_incoming",
 916         .args_type  = "uri:s",
 917         .params     = "uri",
 918         .help       = "Continue an incoming migration from an -incoming defer",
 919         .mhandler.cmd = hmp_migrate_incoming,
 920     },
 921
 922 STEXI
 923 @item migrate_incoming @var{uri}
 924 @findex migrate_incoming
 925 Continue an incoming migration using the @var{uri} (that has the same syntax
 926 as the -incoming option).
 927
 928 ETEXI
 929
 930     {
 931         .name       = "migrate_set_cache_size",
 932         .args_type  = "value:o",
 933         .params     = "value",
 934         .help       = "set cache size (in bytes) for XBZRLE migrations,"
 935                       "the cache size will be rounded down to the nearest "
 936                       "power of 2.\n"
 937                       "The cache size affects the number of cache misses."
 938                       "In case of a high cache miss ratio you need to increase"
 939                       " the cache size",
 940         .mhandler.cmd = hmp_migrate_set_cache_size,
 941     },
 942
 943 STEXI
 944 @item migrate_set_cache_size @var{value}
 945 @findex migrate_set_cache_size
 946 Set cache size to @var{value} (in bytes) for xbzrle migrations.
 947 ETEXI
 948
 949     {
 950         .name       = "migrate_set_speed",
 951         .args_type  = "value:o",
 952         .params     = "value",
 953         .help       = "set maximum speed (in bytes) for migrations. "
 954         "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
 955         .mhandler.cmd = hmp_migrate_set_speed,
 956     },
 957
 958 STEXI
 959 @item migrate_set_speed @var{value}
 960 @findex migrate_set_speed
 961 Set maximum speed to @var{value} (in bytes) for migrations.
 962 ETEXI
 963
 964     {
 965         .name       = "migrate_set_downtime",
 966         .args_type  = "value:T",
 967         .params     = "value",
 968         .help       = "set maximum tolerated downtime (in seconds) for migrations",
 969         .mhandler.cmd = hmp_migrate_set_downtime,
 970     },
 971
 972 STEXI
 973 @item migrate_set_downtime @var{second}
 974 @findex migrate_set_downtime
 975 Set maximum tolerated downtime (in seconds) for migration.
 976 ETEXI
 977
 978     {
 979         .name       = "migrate_set_capability",
 980         .args_type  = "capability:s,state:b",
 981         .params     = "capability state",
 982         .help       = "Enable/Disable the usage of a capability for migration",
 983         .mhandler.cmd = hmp_migrate_set_capability,
 984         .command_completion = migrate_set_capability_completion,
 985     },
 986
 987 STEXI
 988 @item migrate_set_capability @var{capability} @var{state}
 989 @findex migrate_set_capability
 990 Enable/Disable the usage of a capability @var{capability} for migration.
 991 ETEXI
 992
 993     {
 994         .name       = "migrate_set_parameter",
 995         .args_type  = "parameter:s,value:i",
 996         .params     = "parameter value",
 997         .help       = "Set the parameter for migration",
 998         .mhandler.cmd = hmp_migrate_set_parameter,
 999         .command_completion = migrate_set_parameter_completion,
1000     },
1001
1002 STEXI
1003 @item migrate_set_parameter @var{parameter} @var{value}
1004 @findex migrate_set_parameter
1005 Set the parameter @var{parameter} for migration.
1006 ETEXI
1007
1008     {
1009         .name       = "client_migrate_info",
1010         .args_type  = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1011         .params     = "protocol hostname port tls-port cert-subject",
1012         .help       = "set migration information for remote display",
1013         .mhandler.cmd = hmp_client_migrate_info,
1014     },
1015
1016 STEXI
1017 @item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
1018 @findex client_migrate_info
1019 Set migration information for remote display.  This makes the server
1020 ask the client to automatically reconnect using the new parameters
1021 once migration finished successfully.  Only implemented for SPICE.
1022 ETEXI
1023
1024     {
1025         .name       = "dump-guest-memory",
1026         .args_type  = "paging:-p,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:i?,length:i?",
1027         .params     = "[-p] [-z|-l|-s] filename [begin length]",
1028         .help       = "dump guest memory into file 'filename'.\n\t\t\t"
1029                       "-p: do paging to get guest's memory mapping.\n\t\t\t"
1030                       "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1031                       "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1032                       "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
1033                       "begin: the starting physical address.\n\t\t\t"
1034                       "length: the memory size, in bytes.",
1035         .mhandler.cmd = hmp_dump_guest_memory,
1036     },
1037
1038
1039 STEXI
1040 @item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
1041 @item dump-guest-memory [-z|-l|-s] @var{filename}
1042 @findex dump-guest-memory
1043 Dump guest memory to @var{protocol}. The file can be processed with crash or
1044 gdb. Without -z|-l|-s, the dump format is ELF.
1045         -p: do paging to get guest's memory mapping.
1046         -z: dump in kdump-compressed format, with zlib compression.
1047         -l: dump in kdump-compressed format, with lzo compression.
1048         -s: dump in kdump-compressed format, with snappy compression.
1049   filename: dump file name.
1050      begin: the starting physical address. It's optional, and should be
1051             specified together with length.
1052     length: the memory size, in bytes. It's optional, and should be specified
1053             together with begin.
1054 ETEXI
1055
1056 #if defined(TARGET_S390X)
1057     {
1058         .name       = "dump-skeys",
1059         .args_type  = "filename:F",
1060         .params     = "",
1061         .help       = "Save guest storage keys into file 'filename'.\n",
1062         .mhandler.cmd = hmp_dump_skeys,
1063     },
1064 #endif
1065
1066 STEXI
1067 @item dump-skeys @var{filename}
1068 @findex dump-skeys
1069 Save guest storage keys to a file.
1070 ETEXI
1071
1072     {
1073         .name       = "snapshot_blkdev",
1074         .args_type  = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1075         .params     = "[-n] device [new-image-file] [format]",
1076         .help       = "initiates a live snapshot\n\t\t\t"
1077                       "of device. If a new image file is specified, the\n\t\t\t"
1078                       "new image file will become the new root image.\n\t\t\t"
1079                       "If format is specified, the snapshot file will\n\t\t\t"
1080                       "be created in that format.\n\t\t\t"
1081                       "The default format is qcow2.  The -n flag requests QEMU\n\t\t\t"
1082                       "to reuse the image found in new-image-file, instead of\n\t\t\t"
1083                       "recreating it from scratch.",
1084         .mhandler.cmd = hmp_snapshot_blkdev,
1085     },
1086
1087 STEXI
1088 @item snapshot_blkdev
1089 @findex snapshot_blkdev
1090 Snapshot device, using snapshot file as target if provided
1091 ETEXI
1092
1093     {
1094         .name       = "snapshot_blkdev_internal",
1095         .args_type  = "device:B,name:s",
1096         .params     = "device name",
1097         .help       = "take an internal snapshot of device.\n\t\t\t"
1098                       "The format of the image used by device must\n\t\t\t"
1099                       "support it, such as qcow2.\n\t\t\t",
1100         .mhandler.cmd = hmp_snapshot_blkdev_internal,
1101     },
1102
1103 STEXI
1104 @item snapshot_blkdev_internal
1105 @findex snapshot_blkdev_internal
1106 Take an internal snapshot on device if it support
1107 ETEXI
1108
1109     {
1110         .name       = "snapshot_delete_blkdev_internal",
1111         .args_type  = "device:B,name:s,id:s?",
1112         .params     = "device name [id]",
1113         .help       = "delete an internal snapshot of device.\n\t\t\t"
1114                       "If id is specified, qemu will try delete\n\t\t\t"
1115                       "the snapshot matching both id and name.\n\t\t\t"
1116                       "The format of the image used by device must\n\t\t\t"
1117                       "support it, such as qcow2.\n\t\t\t",
1118         .mhandler.cmd = hmp_snapshot_delete_blkdev_internal,
1119     },
1120
1121 STEXI
1122 @item snapshot_delete_blkdev_internal
1123 @findex snapshot_delete_blkdev_internal
1124 Delete an internal snapshot on device if it support
1125 ETEXI
1126
1127     {
1128         .name       = "drive_mirror",
1129         .args_type  = "reuse:-n,full:-f,device:B,target:s,format:s?",
1130         .params     = "[-n] [-f] device target [format]",
1131         .help       = "initiates live storage\n\t\t\t"
1132                       "migration for a device. The device's contents are\n\t\t\t"
1133                       "copied to the new image file, including data that\n\t\t\t"
1134                       "is written after the command is started.\n\t\t\t"
1135                       "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1136                       "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1137                       "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1138                       "so that the result does not need a backing file.\n\t\t\t",
1139         .mhandler.cmd = hmp_drive_mirror,
1140     },
1141 STEXI
1142 @item drive_mirror
1143 @findex drive_mirror
1144 Start mirroring a block device's writes to a new destination,
1145 using the specified target.
1146 ETEXI
1147
1148     {
1149         .name       = "drive_backup",
1150         .args_type  = "reuse:-n,full:-f,device:B,target:s,format:s?",
1151         .params     = "[-n] [-f] device target [format]",
1152         .help       = "initiates a point-in-time\n\t\t\t"
1153                       "copy for a device. The device's contents are\n\t\t\t"
1154                       "copied to the new image file, excluding data that\n\t\t\t"
1155                       "is written after the command is started.\n\t\t\t"
1156                       "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1157                       "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1158                       "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1159                       "so that the result does not need a backing file.\n\t\t\t",
1160         .mhandler.cmd = hmp_drive_backup,
1161     },
1162 STEXI
1163 @item drive_backup
1164 @findex drive_backup
1165 Start a point-in-time copy of a block device to a specificed target.
1166 ETEXI
1167
1168     {
1169         .name       = "drive_add",
1170         .args_type  = "pci_addr:s,opts:s",
1171         .params     = "[[<domain>:]<bus>:]<slot>\n"
1172                       "[file=file][,if=type][,bus=n]\n"
1173                       "[,unit=m][,media=d][,index=i]\n"
1174                       "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
1175                       "[,snapshot=on|off][,cache=on|off]\n"
1176                       "[,readonly=on|off][,copy-on-read=on|off]",
1177         .help       = "add drive to PCI storage controller",
1178         .mhandler.cmd = hmp_drive_add,
1179     },
1180
1181 STEXI
1182 @item drive_add
1183 @findex drive_add
1184 Add drive to PCI storage controller.
1185 ETEXI
1186
1187     {
1188         .name       = "pcie_aer_inject_error",
1189         .args_type  = "advisory_non_fatal:-a,correctable:-c,"
1190                       "id:s,error_status:s,"
1191                       "header0:i?,header1:i?,header2:i?,header3:i?,"
1192                       "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1193         .params     = "[-a] [-c] id "
1194                       "<error_status> [<tlp header> [<tlp header prefix>]]",
1195         .help       = "inject pcie aer error\n\t\t\t"
1196                       " -a for advisory non fatal error\n\t\t\t"
1197                       " -c for correctable error\n\t\t\t"
1198                       "<id> = qdev device id\n\t\t\t"
1199                       "<error_status> = error string or 32bit\n\t\t\t"
1200                       "<tlb header> = 32bit x 4\n\t\t\t"
1201                       "<tlb header prefix> = 32bit x 4",
1202         .mhandler.cmd = hmp_pcie_aer_inject_error,
1203     },
1204
1205 STEXI
1206 @item pcie_aer_inject_error
1207 @findex pcie_aer_inject_error
1208 Inject PCIe AER error
1209 ETEXI
1210
1211     {
1212         .name       = "host_net_add",
1213         .args_type  = "device:s,opts:s?",
1214         .params     = "tap|user|socket|vde|netmap|bridge|vhost-user|dump [options]",
1215         .help       = "add host VLAN client",
1216         .mhandler.cmd = hmp_host_net_add,
1217         .command_completion = host_net_add_completion,
1218     },
1219
1220 STEXI
1221 @item host_net_add
1222 @findex host_net_add
1223 Add host VLAN client.
1224 ETEXI
1225
1226     {
1227         .name       = "host_net_remove",
1228         .args_type  = "vlan_id:i,device:s",
1229         .params     = "vlan_id name",
1230         .help       = "remove host VLAN client",
1231         .mhandler.cmd = hmp_host_net_remove,
1232         .command_completion = host_net_remove_completion,
1233     },
1234
1235 STEXI
1236 @item host_net_remove
1237 @findex host_net_remove
1238 Remove host VLAN client.
1239 ETEXI
1240
1241     {
1242         .name       = "netdev_add",
1243         .args_type  = "netdev:O",
1244         .params     = "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
1245         .help       = "add host network device",
1246         .mhandler.cmd = hmp_netdev_add,
1247         .command_completion = netdev_add_completion,
1248     },
1249
1250 STEXI
1251 @item netdev_add
1252 @findex netdev_add
1253 Add host network device.
1254 ETEXI
1255
1256     {
1257         .name       = "netdev_del",
1258         .args_type  = "id:s",
1259         .params     = "id",
1260         .help       = "remove host network device",
1261         .mhandler.cmd = hmp_netdev_del,
1262         .command_completion = netdev_del_completion,
1263     },
1264
1265 STEXI
1266 @item netdev_del
1267 @findex netdev_del
1268 Remove host network device.
1269 ETEXI
1270
1271     {
1272         .name       = "object_add",
1273         .args_type  = "object:O",
1274         .params     = "[qom-type=]type,id=str[,prop=value][,...]",
1275         .help       = "create QOM object",
1276         .mhandler.cmd = hmp_object_add,
1277         .command_completion = object_add_completion,
1278     },
1279
1280 STEXI
1281 @item object_add
1282 @findex object_add
1283 Create QOM object.
1284 ETEXI
1285
1286     {
1287         .name       = "object_del",
1288         .args_type  = "id:s",
1289         .params     = "id",
1290         .help       = "destroy QOM object",
1291         .mhandler.cmd = hmp_object_del,
1292         .command_completion = object_del_completion,
1293     },
1294
1295 STEXI
1296 @item object_del
1297 @findex object_del
1298 Destroy QOM object.
1299 ETEXI
1300
1301 #ifdef CONFIG_SLIRP
1302     {
1303         .name       = "hostfwd_add",
1304         .args_type  = "arg1:s,arg2:s?,arg3:s?",
1305         .params     = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1306         .help       = "redirect TCP or UDP connections from host to guest (requires -net user)",
1307         .mhandler.cmd = hmp_hostfwd_add,
1308     },
1309 #endif
1310 STEXI
1311 @item hostfwd_add
1312 @findex hostfwd_add
1313 Redirect TCP or UDP connections from host to guest (requires -net user).
1314 ETEXI
1315
1316 #ifdef CONFIG_SLIRP
1317     {
1318         .name       = "hostfwd_remove",
1319         .args_type  = "arg1:s,arg2:s?,arg3:s?",
1320         .params     = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1321         .help       = "remove host-to-guest TCP or UDP redirection",
1322         .mhandler.cmd = hmp_hostfwd_remove,
1323     },
1324
1325 #endif
1326 STEXI
1327 @item hostfwd_remove
1328 @findex hostfwd_remove
1329 Remove host-to-guest TCP or UDP redirection.
1330 ETEXI
1331
1332     {
1333         .name       = "balloon",
1334         .args_type  = "value:M",
1335         .params     = "target",
1336         .help       = "request VM to change its memory allocation (in MB)",
1337         .mhandler.cmd = hmp_balloon,
1338     },
1339
1340 STEXI
1341 @item balloon @var{value}
1342 @findex balloon
1343 Request VM to change its memory allocation to @var{value} (in MB).
1344 ETEXI
1345
1346     {
1347         .name       = "set_link",
1348         .args_type  = "name:s,up:b",
1349         .params     = "name on|off",
1350         .help       = "change the link status of a network adapter",
1351         .mhandler.cmd = hmp_set_link,
1352         .command_completion = set_link_completion,
1353     },
1354
1355 STEXI
1356 @item set_link @var{name} [on|off]
1357 @findex set_link
1358 Switch link @var{name} on (i.e. up) or off (i.e. down).
1359 ETEXI
1360
1361     {
1362         .name       = "watchdog_action",
1363         .args_type  = "action:s",
1364         .params     = "[reset|shutdown|poweroff|pause|debug|none]",
1365         .help       = "change watchdog action",
1366         .mhandler.cmd = hmp_watchdog_action,
1367         .command_completion = watchdog_action_completion,
1368     },
1369
1370 STEXI
1371 @item watchdog_action
1372 @findex watchdog_action
1373 Change watchdog action.
1374 ETEXI
1375
1376     {
1377         .name       = "acl_show",
1378         .args_type  = "aclname:s",
1379         .params     = "aclname",
1380         .help       = "list rules in the access control list",
1381         .mhandler.cmd = hmp_acl_show,
1382     },
1383
1384 STEXI
1385 @item acl_show @var{aclname}
1386 @findex acl_show
1387 List all the matching rules in the access control list, and the default
1388 policy. There are currently two named access control lists,
1389 @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1390 certificate distinguished name, and SASL username respectively.
1391 ETEXI
1392
1393     {
1394         .name       = "acl_policy",
1395         .args_type  = "aclname:s,policy:s",
1396         .params     = "aclname allow|deny",
1397         .help       = "set default access control list policy",
1398         .mhandler.cmd = hmp_acl_policy,
1399     },
1400
1401 STEXI
1402 @item acl_policy @var{aclname} @code{allow|deny}
1403 @findex acl_policy
1404 Set the default access control list policy, used in the event that
1405 none of the explicit rules match. The default policy at startup is
1406 always @code{deny}.
1407 ETEXI
1408
1409     {
1410         .name       = "acl_add",
1411         .args_type  = "aclname:s,match:s,policy:s,index:i?",
1412         .params     = "aclname match allow|deny [index]",
1413         .help       = "add a match rule to the access control list",
1414         .mhandler.cmd = hmp_acl_add,
1415     },
1416
1417 STEXI
1418 @item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1419 @findex acl_add
1420 Add a match rule to the access control list, allowing or denying access.
1421 The match will normally be an exact username or x509 distinguished name,
1422 but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1423 allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
1424 normally be appended to the end of the ACL, but can be inserted
1425 earlier in the list if the optional @var{index} parameter is supplied.
1426 ETEXI
1427
1428     {
1429         .name       = "acl_remove",
1430         .args_type  = "aclname:s,match:s",
1431         .params     = "aclname match",
1432         .help       = "remove a match rule from the access control list",
1433         .mhandler.cmd = hmp_acl_remove,
1434     },
1435
1436 STEXI
1437 @item acl_remove @var{aclname} @var{match}
1438 @findex acl_remove
1439 Remove the specified match rule from the access control list.
1440 ETEXI
1441
1442     {
1443         .name       = "acl_reset",
1444         .args_type  = "aclname:s",
1445         .params     = "aclname",
1446         .help       = "reset the access control list",
1447         .mhandler.cmd = hmp_acl_reset,
1448     },
1449
1450 STEXI
1451 @item acl_reset @var{aclname}
1452 @findex acl_reset
1453 Remove all matches from the access control list, and set the default
1454 policy back to @code{deny}.
1455 ETEXI
1456
1457     {
1458         .name       = "nbd_server_start",
1459         .args_type  = "all:-a,writable:-w,uri:s",
1460         .params     = "nbd_server_start [-a] [-w] host:port",
1461         .help       = "serve block devices on the given host and port",
1462         .mhandler.cmd = hmp_nbd_server_start,
1463     },
1464 STEXI
1465 @item nbd_server_start @var{host}:@var{port}
1466 @findex nbd_server_start
1467 Start an NBD server on the given host and/or port.  If the @option{-a}
1468 option is included, all of the virtual machine's block devices that
1469 have an inserted media on them are automatically exported; in this case,
1470 the @option{-w} option makes the devices writable too.
1471 ETEXI
1472
1473     {
1474         .name       = "nbd_server_add",
1475         .args_type  = "writable:-w,device:B",
1476         .params     = "nbd_server_add [-w] device",
1477         .help       = "export a block device via NBD",
1478         .mhandler.cmd = hmp_nbd_server_add,
1479     },
1480 STEXI
1481 @item nbd_server_add @var{device}
1482 @findex nbd_server_add
1483 Export a block device through QEMU's NBD server, which must be started
1484 beforehand with @command{nbd_server_start}.  The @option{-w} option makes the
1485 exported device writable too.
1486 ETEXI
1487
1488     {
1489         .name       = "nbd_server_stop",
1490         .args_type  = "",
1491         .params     = "nbd_server_stop",
1492         .help       = "stop serving block devices using the NBD protocol",
1493         .mhandler.cmd = hmp_nbd_server_stop,
1494     },
1495 STEXI
1496 @item nbd_server_stop
1497 @findex nbd_server_stop
1498 Stop the QEMU embedded NBD server.
1499 ETEXI
1500
1501
1502 #if defined(TARGET_I386)
1503
1504     {
1505         .name       = "mce",
1506         .args_type  = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1507         .params     = "[-b] cpu bank status mcgstatus addr misc",
1508         .help       = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1509         .mhandler.cmd = hmp_mce,
1510     },
1511
1512 #endif
1513 STEXI
1514 @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1515 @findex mce (x86)
1516 Inject an MCE on the given CPU (x86 only).
1517 ETEXI
1518
1519     {
1520         .name       = "getfd",
1521         .args_type  = "fdname:s",
1522         .params     = "getfd name",
1523         .help       = "receive a file descriptor via SCM rights and assign it a name",
1524         .mhandler.cmd = hmp_getfd,
1525     },
1526
1527 STEXI
1528 @item getfd @var{fdname}
1529 @findex getfd
1530 If a file descriptor is passed alongside this command using the SCM_RIGHTS
1531 mechanism on unix sockets, it is stored using the name @var{fdname} for
1532 later use by other monitor commands.
1533 ETEXI
1534
1535     {
1536         .name       = "closefd",
1537         .args_type  = "fdname:s",
1538         .params     = "closefd name",
1539         .help       = "close a file descriptor previously passed via SCM rights",
1540         .mhandler.cmd = hmp_closefd,
1541     },
1542
1543 STEXI
1544 @item closefd @var{fdname}
1545 @findex closefd
1546 Close the file descriptor previously assigned to @var{fdname} using the
1547 @code{getfd} command. This is only needed if the file descriptor was never
1548 used by another monitor command.
1549 ETEXI
1550
1551     {
1552         .name       = "block_passwd",
1553         .args_type  = "device:B,password:s",
1554         .params     = "block_passwd device password",
1555         .help       = "set the password of encrypted block devices",
1556         .mhandler.cmd = hmp_block_passwd,
1557     },
1558
1559 STEXI
1560 @item block_passwd @var{device} @var{password}
1561 @findex block_passwd
1562 Set the encrypted device @var{device} password to @var{password}
1563 ETEXI
1564
1565     {
1566         .name       = "block_set_io_throttle",
1567         .args_type  = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1568         .params     = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1569         .help       = "change I/O throttle limits for a block drive",
1570         .mhandler.cmd = hmp_block_set_io_throttle,
1571     },
1572
1573 STEXI
1574 @item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1575 @findex block_set_io_throttle
1576 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}
1577 ETEXI
1578
1579     {
1580         .name       = "set_password",
1581         .args_type  = "protocol:s,password:s,connected:s?",
1582         .params     = "protocol password action-if-connected",
1583         .help       = "set spice/vnc password",
1584         .mhandler.cmd = hmp_set_password,
1585     },
1586
1587 STEXI
1588 @item set_password [ vnc | spice ] password [ action-if-connected ]
1589 @findex set_password
1590 Change spice/vnc password.  Use zero to make the password stay valid
1591 forever.  @var{action-if-connected} specifies what should happen in
1592 case a connection is established: @var{fail} makes the password change
1593 fail.  @var{disconnect} changes the password and disconnects the
1594 client.  @var{keep} changes the password and keeps the connection up.
1595 @var{keep} is the default.
1596 ETEXI
1597
1598     {
1599         .name       = "expire_password",
1600         .args_type  = "protocol:s,time:s",
1601         .params     = "protocol time",
1602         .help       = "set spice/vnc password expire-time",
1603         .mhandler.cmd = hmp_expire_password,
1604     },
1605
1606 STEXI
1607 @item expire_password [ vnc | spice ] expire-time
1608 @findex expire_password
1609 Specify when a password for spice/vnc becomes
1610 invalid. @var{expire-time} accepts:
1611
1612 @table @var
1613 @item now
1614 Invalidate password instantly.
1615
1616 @item never
1617 Password stays valid forever.
1618
1619 @item +nsec
1620 Password stays valid for @var{nsec} seconds starting now.
1621
1622 @item nsec
1623 Password is invalidated at the given time.  @var{nsec} are the seconds
1624 passed since 1970, i.e. unix epoch.
1625
1626 @end table
1627 ETEXI
1628
1629     {
1630         .name       = "chardev-add",
1631         .args_type  = "args:s",
1632         .params     = "args",
1633         .help       = "add chardev",
1634         .mhandler.cmd = hmp_chardev_add,
1635         .command_completion = chardev_add_completion,
1636     },
1637
1638 STEXI
1639 @item chardev-add args
1640 @findex chardev-add
1641 chardev_add accepts the same parameters as the -chardev command line switch.
1642
1643 ETEXI
1644
1645     {
1646         .name       = "chardev-remove",
1647         .args_type  = "id:s",
1648         .params     = "id",
1649         .help       = "remove chardev",
1650         .mhandler.cmd = hmp_chardev_remove,
1651         .command_completion = chardev_remove_completion,
1652     },
1653
1654 STEXI
1655 @item chardev-remove id
1656 @findex chardev-remove
1657 Removes the chardev @var{id}.
1658
1659 ETEXI
1660
1661     {
1662         .name       = "qemu-io",
1663         .args_type  = "device:B,command:s",
1664         .params     = "[device] \"[command]\"",
1665         .help       = "run a qemu-io command on a block device",
1666         .mhandler.cmd = hmp_qemu_io,
1667     },
1668
1669 STEXI
1670 @item qemu-io @var{device} @var{command}
1671 @findex qemu-io
1672 Executes a qemu-io command on the given block device.
1673
1674 ETEXI
1675
1676     {
1677         .name       = "cpu-add",
1678         .args_type  = "id:i",
1679         .params     = "id",
1680         .help       = "add cpu",
1681         .mhandler.cmd  = hmp_cpu_add,
1682     },
1683
1684 STEXI
1685 @item cpu-add @var{id}
1686 @findex cpu-add
1687 Add CPU with id @var{id}
1688 ETEXI
1689
1690     {
1691         .name       = "qom-list",
1692         .args_type  = "path:s?",
1693         .params     = "path",
1694         .help       = "list QOM properties",
1695         .mhandler.cmd  = hmp_qom_list,
1696     },
1697
1698 STEXI
1699 @item qom-list [@var{path}]
1700 Print QOM properties of object at location @var{path}
1701 ETEXI
1702
1703     {
1704         .name       = "qom-set",
1705         .args_type  = "path:s,property:s,value:s",
1706         .params     = "path property value",
1707         .help       = "set QOM property",
1708         .mhandler.cmd  = hmp_qom_set,
1709     },
1710
1711 STEXI
1712 @item qom-set @var{path} @var{property} @var{value}
1713 Set QOM property @var{property} of object at location @var{path} to value @var{value}
1714 ETEXI
1715
1716     {
1717         .name       = "info",
1718         .args_type  = "item:s?",
1719         .params     = "[subcommand]",
1720         .help       = "show various information about the system state",
1721         .mhandler.cmd = hmp_info_help,
1722         .sub_table = info_cmds,
1723     },
1724
1725 STEXI
1726 @item info @var{subcommand}
1727 @findex info
1728 Show various information about the system state.
1729
1730 @table @option
1731 @item info version
1732 show the version of QEMU
1733 @item info network
1734 show the various VLANs and the associated devices
1735 @item info chardev
1736 show the character devices
1737 @item info block
1738 show the block devices
1739 @item info blockstats
1740 show block device statistics
1741 @item info registers
1742 show the cpu registers
1743 @item info cpus
1744 show infos for each CPU
1745 @item info history
1746 show the command line history
1747 @item info irq
1748 show the interrupts statistics (if available)
1749 @item info pic
1750 show i8259 (PIC) state
1751 @item info pci
1752 show emulated PCI device info
1753 @item info tlb
1754 show virtual to physical memory mappings (i386, SH4, SPARC, PPC, and Xtensa only)
1755 @item info mem
1756 show the active virtual memory mappings (i386 only)
1757 @item info jit
1758 show dynamic compiler info
1759 @item info numa
1760 show NUMA information
1761 @item info kvm
1762 show KVM information
1763 @item info usb
1764 show USB devices plugged on the virtual USB hub
1765 @item info usbhost
1766 show all USB host devices
1767 @item info profile
1768 show profiling information
1769 @item info capture
1770 show information about active capturing
1771 @item info snapshots
1772 show list of VM snapshots
1773 @item info status
1774 show the current VM status (running|paused)
1775 @item info mice
1776 show which guest mouse is receiving events
1777 @item info vnc
1778 show the vnc server status
1779 @item info name
1780 show the current VM name
1781 @item info uuid
1782 show the current VM UUID
1783 @item info cpustats
1784 show CPU statistics
1785 @item info usernet
1786 show user network stack connection states
1787 @item info migrate
1788 show migration status
1789 @item info migrate_capabilities
1790 show current migration capabilities
1791 @item info migrate_parameters
1792 show current migration parameters
1793 @item info migrate_cache_size
1794 show current migration XBZRLE cache size
1795 @item info balloon
1796 show balloon information
1797 @item info qtree
1798 show device tree
1799 @item info qdm
1800 show qdev device model list
1801 @item info qom-tree
1802 show object composition tree
1803 @item info roms
1804 show roms
1805 @item info tpm
1806 show the TPM device
1807 @item info memory-devices
1808 show the memory devices
1809 @item info skeys
1810 Display the value of a storage key (s390 only)
1811 @end table
1812 ETEXI
1813
1814 STEXI
1815 @item info trace-events
1816 show available trace events and their state
1817 ETEXI
1818
1819 STEXI
1820 @item rocker @var{name}
1821 @findex rocker
1822 Show Rocker(s)
1823 ETEXI
1824
1825 STEXI
1826 @item rocker_ports @var{name}
1827 @findex rocker_ports
1828 Show Rocker ports
1829 ETEXI
1830
1831 STEXI
1832 @item rocker_of_dpa_flows @var{name} [@var{tbl_id}]
1833 @findex rocker_of_dpa_flows
1834 Show Rocker OF-DPA flow tables
1835 ETEXI
1836
1837 STEXI
1838 @item rocker_of_dpa_groups @var{name} [@var{type}]
1839 @findex rocker_of_dpa_groups
1840 Show Rocker OF-DPA groups
1841 ETEXI
1842
1843 STEXI
1844 @end table
1845 ETEXI