hmp-commands.hx

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