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     {
  74         .name       = "eject",
  75         .args_type  = "force:-f,device:B",
  76         .params     = "[-f] device",
  77         .help       = "eject a removable medium (use -f to force it)",
  78         .mhandler.cmd = hmp_eject,
  79     },
  80
  81 STEXI
  82 @item eject [-f] @var{device}
  83 @findex eject
  84 Eject a removable medium (use -f to force it).
  85 ETEXI
  86
  87     {
  88         .name       = "drive_del",
  89         .args_type  = "id:s",
  90         .params     = "device",
  91         .help       = "remove host block device",
  92         .user_print = monitor_user_noop,
  93         .mhandler.cmd_new = do_drive_del,
  94     },
  95
  96 STEXI
  97 @item drive_del @var{device}
  98 @findex drive_del
  99 Remove host block device.  The result is that guest generated IO is no longer
 100 submitted against the host device underlying the disk.  Once a drive has
 101 been deleted, the QEMU Block layer returns -EIO which results in IO
 102 errors in the guest for applications that are reading/writing to the device.
 103 ETEXI
 104
 105     {
 106         .name       = "change",
 107         .args_type  = "device:B,target:F,arg:s?",
 108         .params     = "device filename [format]",
 109         .help       = "change a removable medium, optional format",
 110         .user_print = monitor_user_noop,
 111         .mhandler.cmd_new = do_change,
 112     },
 113
 114 STEXI
 115 @item change @var{device} @var{setting}
 116 @findex change
 117
 118 Change the configuration of a device.
 119
 120 @table @option
 121 @item change @var{diskdevice} @var{filename} [@var{format}]
 122 Change the medium for a removable disk device to point to @var{filename}. eg
 123
 124 @example
 125 (qemu) change ide1-cd0 /path/to/some.iso
 126 @end example
 127
 128 @var{format} is optional.
 129
 130 @item change vnc @var{display},@var{options}
 131 Change the configuration of the VNC server. The valid syntax for @var{display}
 132 and @var{options} are described at @ref{sec_invocation}. eg
 133
 134 @example
 135 (qemu) change vnc localhost:1
 136 @end example
 137
 138 @item change vnc password [@var{password}]
 139
 140 Change the password associated with the VNC server. If the new password is not
 141 supplied, the monitor will prompt for it to be entered. VNC passwords are only
 142 significant up to 8 letters. eg
 143
 144 @example
 145 (qemu) change vnc password
 146 Password: ********
 147 @end example
 148
 149 @end table
 150 ETEXI
 151
 152     {
 153         .name       = "screendump",
 154         .args_type  = "filename:F",
 155         .params     = "filename",
 156         .help       = "save screen into PPM image 'filename'",
 157         .user_print = monitor_user_noop,
 158         .mhandler.cmd_new = do_screen_dump,
 159     },
 160
 161 STEXI
 162 @item screendump @var{filename}
 163 @findex screendump
 164 Save screen into PPM image @var{filename}.
 165 ETEXI
 166
 167     {
 168         .name       = "logfile",
 169         .args_type  = "filename:F",
 170         .params     = "filename",
 171         .help       = "output logs to 'filename'",
 172         .mhandler.cmd = do_logfile,
 173     },
 174
 175 STEXI
 176 @item logfile @var{filename}
 177 @findex logfile
 178 Output logs to @var{filename}.
 179 ETEXI
 180
 181     {
 182         .name       = "trace-event",
 183         .args_type  = "name:s,option:b",
 184         .params     = "name on|off",
 185         .help       = "changes status of a specific trace event",
 186         .mhandler.cmd = do_trace_event_set_state,
 187     },
 188
 189 STEXI
 190 @item trace-event
 191 @findex trace-event
 192 changes status of a trace event
 193 ETEXI
 194
 195 #if defined(CONFIG_TRACE_SIMPLE)
 196     {
 197         .name       = "trace-file",
 198         .args_type  = "op:s?,arg:F?",
 199         .params     = "on|off|flush|set [arg]",
 200         .help       = "open, close, or flush trace file, or set a new file name",
 201         .mhandler.cmd = do_trace_file,
 202     },
 203
 204 STEXI
 205 @item trace-file on|off|flush
 206 @findex trace-file
 207 Open, close, or flush the trace file.  If no argument is given, the status of the trace file is displayed.
 208 ETEXI
 209 #endif
 210
 211     {
 212         .name       = "log",
 213         .args_type  = "items:s",
 214         .params     = "item1[,...]",
 215         .help       = "activate logging of the specified items to '/tmp/qemu.log'",
 216         .mhandler.cmd = do_log,
 217     },
 218
 219 STEXI
 220 @item log @var{item1}[,...]
 221 @findex log
 222 Activate logging of the specified items to @file{/tmp/qemu.log}.
 223 ETEXI
 224
 225     {
 226         .name       = "savevm",
 227         .args_type  = "name:s?",
 228         .params     = "[tag|id]",
 229         .help       = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
 230         .mhandler.cmd = do_savevm,
 231     },
 232
 233 STEXI
 234 @item savevm [@var{tag}|@var{id}]
 235 @findex savevm
 236 Create a snapshot of the whole virtual machine. If @var{tag} is
 237 provided, it is used as human readable identifier. If there is already
 238 a snapshot with the same tag or ID, it is replaced. More info at
 239 @ref{vm_snapshots}.
 240 ETEXI
 241
 242     {
 243         .name       = "loadvm",
 244         .args_type  = "name:s",
 245         .params     = "tag|id",
 246         .help       = "restore a VM snapshot from its tag or id",
 247         .mhandler.cmd = do_loadvm,
 248     },
 249
 250 STEXI
 251 @item loadvm @var{tag}|@var{id}
 252 @findex loadvm
 253 Set the whole virtual machine to the snapshot identified by the tag
 254 @var{tag} or the unique snapshot ID @var{id}.
 255 ETEXI
 256
 257     {
 258         .name       = "delvm",
 259         .args_type  = "name:s",
 260         .params     = "tag|id",
 261         .help       = "delete a VM snapshot from its tag or id",
 262         .mhandler.cmd = do_delvm,
 263     },
 264
 265 STEXI
 266 @item delvm @var{tag}|@var{id}
 267 @findex delvm
 268 Delete the snapshot identified by @var{tag} or @var{id}.
 269 ETEXI
 270
 271     {
 272         .name       = "singlestep",
 273         .args_type  = "option:s?",
 274         .params     = "[on|off]",
 275         .help       = "run emulation in singlestep mode or switch to normal mode",
 276         .mhandler.cmd = do_singlestep,
 277     },
 278
 279 STEXI
 280 @item singlestep [off]
 281 @findex singlestep
 282 Run the emulation in single step mode.
 283 If called with option off, the emulation returns to normal mode.
 284 ETEXI
 285
 286     {
 287         .name       = "stop",
 288         .args_type  = "",
 289         .params     = "",
 290         .help       = "stop emulation",
 291         .mhandler.cmd = hmp_stop,
 292     },
 293
 294 STEXI
 295 @item stop
 296 @findex stop
 297 Stop emulation.
 298 ETEXI
 299
 300     {
 301         .name       = "c|cont",
 302         .args_type  = "",
 303         .params     = "",
 304         .help       = "resume emulation",
 305         .mhandler.cmd = hmp_cont,
 306     },
 307
 308 STEXI
 309 @item c or cont
 310 @findex cont
 311 Resume emulation.
 312 ETEXI
 313
 314     {
 315         .name       = "gdbserver",
 316         .args_type  = "device:s?",
 317         .params     = "[device]",
 318         .help       = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
 319         .mhandler.cmd = do_gdbserver,
 320     },
 321
 322 STEXI
 323 @item gdbserver [@var{port}]
 324 @findex gdbserver
 325 Start gdbserver session (default @var{port}=1234)
 326 ETEXI
 327
 328     {
 329         .name       = "x",
 330         .args_type  = "fmt:/,addr:l",
 331         .params     = "/fmt addr",
 332         .help       = "virtual memory dump starting at 'addr'",
 333         .mhandler.cmd = do_memory_dump,
 334     },
 335
 336 STEXI
 337 @item x/fmt @var{addr}
 338 @findex x
 339 Virtual memory dump starting at @var{addr}.
 340 ETEXI
 341
 342     {
 343         .name       = "xp",
 344         .args_type  = "fmt:/,addr:l",
 345         .params     = "/fmt addr",
 346         .help       = "physical memory dump starting at 'addr'",
 347         .mhandler.cmd = do_physical_memory_dump,
 348     },
 349
 350 STEXI
 351 @item xp /@var{fmt} @var{addr}
 352 @findex xp
 353 Physical memory dump starting at @var{addr}.
 354
 355 @var{fmt} is a format which tells the command how to format the
 356 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
 357
 358 @table @var
 359 @item count
 360 is the number of items to be dumped.
 361
 362 @item format
 363 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
 364 c (char) or i (asm instruction).
 365
 366 @item size
 367 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
 368 @code{h} or @code{w} can be specified with the @code{i} format to
 369 respectively select 16 or 32 bit code instruction size.
 370
 371 @end table
 372
 373 Examples:
 374 @itemize
 375 @item
 376 Dump 10 instructions at the current instruction pointer:
 377 @example
 378 (qemu) x/10i $eip
 379 0x90107063:  ret
 380 0x90107064:  sti
 381 0x90107065:  lea    0x0(%esi,1),%esi
 382 0x90107069:  lea    0x0(%edi,1),%edi
 383 0x90107070:  ret
 384 0x90107071:  jmp    0x90107080
 385 0x90107073:  nop
 386 0x90107074:  nop
 387 0x90107075:  nop
 388 0x90107076:  nop
 389 @end example
 390
 391 @item
 392 Dump 80 16 bit values at the start of the video memory.
 393 @smallexample
 394 (qemu) xp/80hx 0xb8000
 395 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
 396 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
 397 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
 398 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
 399 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
 400 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
 401 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
 402 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
 403 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
 404 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
 405 @end smallexample
 406 @end itemize
 407 ETEXI
 408
 409     {
 410         .name       = "p|print",
 411         .args_type  = "fmt:/,val:l",
 412         .params     = "/fmt expr",
 413         .help       = "print expression value (use $reg for CPU register access)",
 414         .mhandler.cmd = do_print,
 415     },
 416
 417 STEXI
 418 @item p or print/@var{fmt} @var{expr}
 419 @findex print
 420
 421 Print expression value. Only the @var{format} part of @var{fmt} is
 422 used.
 423 ETEXI
 424
 425     {
 426         .name       = "i",
 427         .args_type  = "fmt:/,addr:i,index:i.",
 428         .params     = "/fmt addr",
 429         .help       = "I/O port read",
 430         .mhandler.cmd = do_ioport_read,
 431     },
 432
 433 STEXI
 434 Read I/O port.
 435 ETEXI
 436
 437     {
 438         .name       = "o",
 439         .args_type  = "fmt:/,addr:i,val:i",
 440         .params     = "/fmt addr value",
 441         .help       = "I/O port write",
 442         .mhandler.cmd = do_ioport_write,
 443     },
 444
 445 STEXI
 446 Write to I/O port.
 447 ETEXI
 448
 449     {
 450         .name       = "sendkey",
 451         .args_type  = "string:s,hold_time:i?",
 452         .params     = "keys [hold_ms]",
 453         .help       = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
 454         .mhandler.cmd = do_sendkey,
 455     },
 456
 457 STEXI
 458 @item sendkey @var{keys}
 459 @findex sendkey
 460
 461 Send @var{keys} to the emulator. @var{keys} could be the name of the
 462 key or @code{#} followed by the raw value in either decimal or hexadecimal
 463 format. Use @code{-} to press several keys simultaneously. Example:
 464 @example
 465 sendkey ctrl-alt-f1
 466 @end example
 467
 468 This command is useful to send keys that your graphical user interface
 469 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
 470 ETEXI
 471
 472     {
 473         .name       = "system_reset",
 474         .args_type  = "",
 475         .params     = "",
 476         .help       = "reset the system",
 477         .mhandler.cmd = hmp_system_reset,
 478     },
 479
 480 STEXI
 481 @item system_reset
 482 @findex system_reset
 483
 484 Reset the system.
 485 ETEXI
 486
 487     {
 488         .name       = "system_powerdown",
 489         .args_type  = "",
 490         .params     = "",
 491         .help       = "send system power down event",
 492         .mhandler.cmd = hmp_system_powerdown,
 493     },
 494
 495 STEXI
 496 @item system_powerdown
 497 @findex system_powerdown
 498
 499 Power down the system (if supported).
 500 ETEXI
 501
 502     {
 503         .name       = "sum",
 504         .args_type  = "start:i,size:i",
 505         .params     = "addr size",
 506         .help       = "compute the checksum of a memory region",
 507         .mhandler.cmd = do_sum,
 508     },
 509
 510 STEXI
 511 @item sum @var{addr} @var{size}
 512 @findex sum
 513
 514 Compute the checksum of a memory region.
 515 ETEXI
 516
 517     {
 518         .name       = "usb_add",
 519         .args_type  = "devname:s",
 520         .params     = "device",
 521         .help       = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
 522         .mhandler.cmd = do_usb_add,
 523     },
 524
 525 STEXI
 526 @item usb_add @var{devname}
 527 @findex usb_add
 528
 529 Add the USB device @var{devname}.  For details of available devices see
 530 @ref{usb_devices}
 531 ETEXI
 532
 533     {
 534         .name       = "usb_del",
 535         .args_type  = "devname:s",
 536         .params     = "device",
 537         .help       = "remove USB device 'bus.addr'",
 538         .mhandler.cmd = do_usb_del,
 539     },
 540
 541 STEXI
 542 @item usb_del @var{devname}
 543 @findex usb_del
 544
 545 Remove the USB device @var{devname} from the QEMU virtual USB
 546 hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
 547 command @code{info usb} to see the devices you can remove.
 548 ETEXI
 549
 550     {
 551         .name       = "device_add",
 552         .args_type  = "device:O",
 553         .params     = "driver[,prop=value][,...]",
 554         .help       = "add device, like -device on the command line",
 555         .user_print = monitor_user_noop,
 556         .mhandler.cmd_new = do_device_add,
 557     },
 558
 559 STEXI
 560 @item device_add @var{config}
 561 @findex device_add
 562
 563 Add device.
 564 ETEXI
 565
 566     {
 567         .name       = "device_del",
 568         .args_type  = "id:s",
 569         .params     = "device",
 570         .help       = "remove device",
 571         .user_print = monitor_user_noop,
 572         .mhandler.cmd_new = do_device_del,
 573     },
 574
 575 STEXI
 576 @item device_del @var{id}
 577 @findex device_del
 578
 579 Remove device @var{id}.
 580 ETEXI
 581
 582     {
 583         .name       = "cpu",
 584         .args_type  = "index:i",
 585         .params     = "index",
 586         .help       = "set the default CPU",
 587         .mhandler.cmd = hmp_cpu,
 588     },
 589
 590 STEXI
 591 @item cpu @var{index}
 592 @findex cpu
 593 Set the default CPU.
 594 ETEXI
 595
 596     {
 597         .name       = "mouse_move",
 598         .args_type  = "dx_str:s,dy_str:s,dz_str:s?",
 599         .params     = "dx dy [dz]",
 600         .help       = "send mouse move events",
 601         .mhandler.cmd = do_mouse_move,
 602     },
 603
 604 STEXI
 605 @item mouse_move @var{dx} @var{dy} [@var{dz}]
 606 @findex mouse_move
 607 Move the active mouse to the specified coordinates @var{dx} @var{dy}
 608 with optional scroll axis @var{dz}.
 609 ETEXI
 610
 611     {
 612         .name       = "mouse_button",
 613         .args_type  = "button_state:i",
 614         .params     = "state",
 615         .help       = "change mouse button state (1=L, 2=M, 4=R)",
 616         .mhandler.cmd = do_mouse_button,
 617     },
 618
 619 STEXI
 620 @item mouse_button @var{val}
 621 @findex mouse_button
 622 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
 623 ETEXI
 624
 625     {
 626         .name       = "mouse_set",
 627         .args_type  = "index:i",
 628         .params     = "index",
 629         .help       = "set which mouse device receives events",
 630         .mhandler.cmd = do_mouse_set,
 631     },
 632
 633 STEXI
 634 @item mouse_set @var{index}
 635 @findex mouse_set
 636 Set which mouse device receives events at given @var{index}, index
 637 can be obtained with
 638 @example
 639 info mice
 640 @end example
 641 ETEXI
 642
 643 #ifdef HAS_AUDIO
 644     {
 645         .name       = "wavcapture",
 646         .args_type  = "path:F,freq:i?,bits:i?,nchannels:i?",
 647         .params     = "path [frequency [bits [channels]]]",
 648         .help       = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
 649         .mhandler.cmd = do_wav_capture,
 650     },
 651 #endif
 652 STEXI
 653 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
 654 @findex wavcapture
 655 Capture audio into @var{filename}. Using sample rate @var{frequency}
 656 bits per sample @var{bits} and number of channels @var{channels}.
 657
 658 Defaults:
 659 @itemize @minus
 660 @item Sample rate = 44100 Hz - CD quality
 661 @item Bits = 16
 662 @item Number of channels = 2 - Stereo
 663 @end itemize
 664 ETEXI
 665
 666 #ifdef HAS_AUDIO
 667     {
 668         .name       = "stopcapture",
 669         .args_type  = "n:i",
 670         .params     = "capture index",
 671         .help       = "stop capture",
 672         .mhandler.cmd = do_stop_capture,
 673     },
 674 #endif
 675 STEXI
 676 @item stopcapture @var{index}
 677 @findex stopcapture
 678 Stop capture with a given @var{index}, index can be obtained with
 679 @example
 680 info capture
 681 @end example
 682 ETEXI
 683
 684     {
 685         .name       = "memsave",
 686         .args_type  = "val:l,size:i,filename:s",
 687         .params     = "addr size file",
 688         .help       = "save to disk virtual memory dump starting at 'addr' of size 'size'",
 689         .mhandler.cmd = hmp_memsave,
 690     },
 691
 692 STEXI
 693 @item memsave @var{addr} @var{size} @var{file}
 694 @findex memsave
 695 save to disk virtual memory dump starting at @var{addr} of size @var{size}.
 696 ETEXI
 697
 698     {
 699         .name       = "pmemsave",
 700         .args_type  = "val:l,size:i,filename:s",
 701         .params     = "addr size file",
 702         .help       = "save to disk physical memory dump starting at 'addr' of size 'size'",
 703         .mhandler.cmd = hmp_pmemsave,
 704     },
 705
 706 STEXI
 707 @item pmemsave @var{addr} @var{size} @var{file}
 708 @findex pmemsave
 709 save to disk physical memory dump starting at @var{addr} of size @var{size}.
 710 ETEXI
 711
 712     {
 713         .name       = "boot_set",
 714         .args_type  = "bootdevice:s",
 715         .params     = "bootdevice",
 716         .help       = "define new values for the boot device list",
 717         .mhandler.cmd = do_boot_set,
 718     },
 719
 720 STEXI
 721 @item boot_set @var{bootdevicelist}
 722 @findex boot_set
 723
 724 Define new values for the boot device list. Those values will override
 725 the values specified on the command line through the @code{-boot} option.
 726
 727 The values that can be specified here depend on the machine type, but are
 728 the same that can be specified in the @code{-boot} command line option.
 729 ETEXI
 730
 731 #if defined(TARGET_I386)
 732     {
 733         .name       = "nmi",
 734         .args_type  = "",
 735         .params     = "",
 736         .help       = "inject an NMI on all guest's CPUs",
 737         .mhandler.cmd = hmp_inject_nmi,
 738     },
 739 #endif
 740 STEXI
 741 @item nmi @var{cpu}
 742 @findex nmi
 743 Inject an NMI on the given CPU (x86 only).
 744 ETEXI
 745
 746     {
 747         .name       = "migrate",
 748         .args_type  = "detach:-d,blk:-b,inc:-i,uri:s",
 749         .params     = "[-d] [-b] [-i] uri",
 750         .help       = "migrate to URI (using -d to not wait for completion)"
 751                       "\n\t\t\t -b for migration without shared storage with"
 752                       " full copy of disk\n\t\t\t -i for migration without "
 753                       "shared storage with incremental copy of disk "
 754                       "(base image shared between src and destination)",
 755         .user_print = monitor_user_noop,
 756         .mhandler.cmd_new = do_migrate,
 757     },
 758
 759
 760 STEXI
 761 @item migrate [-d] [-b] [-i] @var{uri}
 762 @findex migrate
 763 Migrate to @var{uri} (using -d to not wait for completion).
 764         -b for migration with full copy of disk
 765         -i for migration with incremental copy of disk (base image is shared)
 766 ETEXI
 767
 768     {
 769         .name       = "migrate_cancel",
 770         .args_type  = "",
 771         .params     = "",
 772         .help       = "cancel the current VM migration",
 773         .mhandler.cmd = hmp_migrate_cancel,
 774     },
 775
 776 STEXI
 777 @item migrate_cancel
 778 @findex migrate_cancel
 779 Cancel the current VM migration.
 780 ETEXI
 781
 782     {
 783         .name       = "migrate_set_speed",
 784         .args_type  = "value:o",
 785         .params     = "value",
 786         .help       = "set maximum speed (in bytes) for migrations. "
 787         "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
 788         .mhandler.cmd = hmp_migrate_set_speed,
 789     },
 790
 791 STEXI
 792 @item migrate_set_speed @var{value}
 793 @findex migrate_set_speed
 794 Set maximum speed to @var{value} (in bytes) for migrations.
 795 ETEXI
 796
 797     {
 798         .name       = "migrate_set_downtime",
 799         .args_type  = "value:T",
 800         .params     = "value",
 801         .help       = "set maximum tolerated downtime (in seconds) for migrations",
 802         .mhandler.cmd = hmp_migrate_set_downtime,
 803     },
 804
 805 STEXI
 806 @item migrate_set_downtime @var{second}
 807 @findex migrate_set_downtime
 808 Set maximum tolerated downtime (in seconds) for migration.
 809 ETEXI
 810
 811     {
 812         .name       = "client_migrate_info",
 813         .args_type  = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
 814         .params     = "protocol hostname port tls-port cert-subject",
 815         .help       = "send migration info to spice/vnc client",
 816         .user_print = monitor_user_noop,
 817         .mhandler.cmd_async = client_migrate_info,
 818         .flags      = MONITOR_CMD_ASYNC,
 819     },
 820
 821 STEXI
 822 @item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
 823 @findex client_migrate_info
 824 Set the spice/vnc connection info for the migration target.  The spice/vnc
 825 server will ask the spice/vnc client to automatically reconnect using the
 826 new parameters (if specified) once the vm migration finished successfully.
 827 ETEXI
 828
 829     {
 830         .name       = "snapshot_blkdev",
 831         .args_type  = "device:B,snapshot-file:s?,format:s?",
 832         .params     = "device [new-image-file] [format]",
 833         .help       = "initiates a live snapshot\n\t\t\t"
 834                       "of device. If a new image file is specified, the\n\t\t\t"
 835                       "new image file will become the new root image.\n\t\t\t"
 836                       "If format is specified, the snapshot file will\n\t\t\t"
 837                       "be created in that format. Otherwise the\n\t\t\t"
 838                       "snapshot will be internal! (currently unsupported)",
 839         .mhandler.cmd = hmp_snapshot_blkdev,
 840     },
 841
 842 STEXI
 843 @item snapshot_blkdev
 844 @findex snapshot_blkdev
 845 Snapshot device, using snapshot file as target if provided
 846 ETEXI
 847
 848     {
 849         .name       = "drive_add",
 850         .args_type  = "pci_addr:s,opts:s",
 851         .params     = "[[<domain>:]<bus>:]<slot>\n"
 852                       "[file=file][,if=type][,bus=n]\n"
 853                       "[,unit=m][,media=d][,index=i]\n"
 854                       "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
 855                       "[,snapshot=on|off][,cache=on|off]\n"
 856                       "[,readonly=on|off][,copy-on-read=on|off]",
 857         .help       = "add drive to PCI storage controller",
 858         .mhandler.cmd = drive_hot_add,
 859     },
 860
 861 STEXI
 862 @item drive_add
 863 @findex drive_add
 864 Add drive to PCI storage controller.
 865 ETEXI
 866
 867 #if defined(TARGET_I386)
 868     {
 869         .name       = "pci_add",
 870         .args_type  = "pci_addr:s,type:s,opts:s?",
 871         .params     = "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...",
 872         .help       = "hot-add PCI device",
 873         .mhandler.cmd = pci_device_hot_add,
 874     },
 875 #endif
 876
 877 STEXI
 878 @item pci_add
 879 @findex pci_add
 880 Hot-add PCI device.
 881 ETEXI
 882
 883 #if defined(TARGET_I386)
 884     {
 885         .name       = "pci_del",
 886         .args_type  = "pci_addr:s",
 887         .params     = "[[<domain>:]<bus>:]<slot>",
 888         .help       = "hot remove PCI device",
 889         .mhandler.cmd = do_pci_device_hot_remove,
 890     },
 891 #endif
 892
 893 STEXI
 894 @item pci_del
 895 @findex pci_del
 896 Hot remove PCI device.
 897 ETEXI
 898
 899     {
 900         .name       = "pcie_aer_inject_error",
 901         .args_type  = "advisory_non_fatal:-a,correctable:-c,"
 902                       "id:s,error_status:s,"
 903                       "header0:i?,header1:i?,header2:i?,header3:i?,"
 904                       "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
 905         .params     = "[-a] [-c] id "
 906                       "<error_status> [<tlp header> [<tlp header prefix>]]",
 907         .help       = "inject pcie aer error\n\t\t\t"
 908                       " -a for advisory non fatal error\n\t\t\t"
 909                       " -c for correctable error\n\t\t\t"
 910                       "<id> = qdev device id\n\t\t\t"
 911                       "<error_status> = error string or 32bit\n\t\t\t"
 912                       "<tlb header> = 32bit x 4\n\t\t\t"
 913                       "<tlb header prefix> = 32bit x 4",
 914         .user_print  = pcie_aer_inject_error_print,
 915         .mhandler.cmd_new = do_pcie_aer_inject_error,
 916     },
 917
 918 STEXI
 919 @item pcie_aer_inject_error
 920 @findex pcie_aer_inject_error
 921 Inject PCIe AER error
 922 ETEXI
 923
 924     {
 925         .name       = "host_net_add",
 926         .args_type  = "device:s,opts:s?",
 927         .params     = "tap|user|socket|vde|dump [options]",
 928         .help       = "add host VLAN client",
 929         .mhandler.cmd = net_host_device_add,
 930     },
 931
 932 STEXI
 933 @item host_net_add
 934 @findex host_net_add
 935 Add host VLAN client.
 936 ETEXI
 937
 938     {
 939         .name       = "host_net_remove",
 940         .args_type  = "vlan_id:i,device:s",
 941         .params     = "vlan_id name",
 942         .help       = "remove host VLAN client",
 943         .mhandler.cmd = net_host_device_remove,
 944     },
 945
 946 STEXI
 947 @item host_net_remove
 948 @findex host_net_remove
 949 Remove host VLAN client.
 950 ETEXI
 951
 952     {
 953         .name       = "netdev_add",
 954         .args_type  = "netdev:O",
 955         .params     = "[user|tap|socket],id=str[,prop=value][,...]",
 956         .help       = "add host network device",
 957         .user_print = monitor_user_noop,
 958         .mhandler.cmd_new = do_netdev_add,
 959     },
 960
 961 STEXI
 962 @item netdev_add
 963 @findex netdev_add
 964 Add host network device.
 965 ETEXI
 966
 967     {
 968         .name       = "netdev_del",
 969         .args_type  = "id:s",
 970         .params     = "id",
 971         .help       = "remove host network device",
 972         .user_print = monitor_user_noop,
 973         .mhandler.cmd_new = do_netdev_del,
 974     },
 975
 976 STEXI
 977 @item netdev_del
 978 @findex netdev_del
 979 Remove host network device.
 980 ETEXI
 981
 982 #ifdef CONFIG_SLIRP
 983     {
 984         .name       = "hostfwd_add",
 985         .args_type  = "arg1:s,arg2:s?,arg3:s?",
 986         .params     = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
 987         .help       = "redirect TCP or UDP connections from host to guest (requires -net user)",
 988         .mhandler.cmd = net_slirp_hostfwd_add,
 989     },
 990 #endif
 991 STEXI
 992 @item hostfwd_add
 993 @findex hostfwd_add
 994 Redirect TCP or UDP connections from host to guest (requires -net user).
 995 ETEXI
 996
 997 #ifdef CONFIG_SLIRP
 998     {
 999         .name       = "hostfwd_remove",
1000         .args_type  = "arg1:s,arg2:s?,arg3:s?",
1001         .params     = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1002         .help       = "remove host-to-guest TCP or UDP redirection",
1003         .mhandler.cmd = net_slirp_hostfwd_remove,
1004     },
1005
1006 #endif
1007 STEXI
1008 @item hostfwd_remove
1009 @findex hostfwd_remove
1010 Remove host-to-guest TCP or UDP redirection.
1011 ETEXI
1012
1013     {
1014         .name       = "balloon",
1015         .args_type  = "value:M",
1016         .params     = "target",
1017         .help       = "request VM to change its memory allocation (in MB)",
1018         .mhandler.cmd = hmp_balloon,
1019     },
1020
1021 STEXI
1022 @item balloon @var{value}
1023 @findex balloon
1024 Request VM to change its memory allocation to @var{value} (in MB).
1025 ETEXI
1026
1027     {
1028         .name       = "set_link",
1029         .args_type  = "name:s,up:b",
1030         .params     = "name on|off",
1031         .help       = "change the link status of a network adapter",
1032         .mhandler.cmd = hmp_set_link,
1033     },
1034
1035 STEXI
1036 @item set_link @var{name} [on|off]
1037 @findex set_link
1038 Switch link @var{name} on (i.e. up) or off (i.e. down).
1039 ETEXI
1040
1041     {
1042         .name       = "watchdog_action",
1043         .args_type  = "action:s",
1044         .params     = "[reset|shutdown|poweroff|pause|debug|none]",
1045         .help       = "change watchdog action",
1046         .mhandler.cmd = do_watchdog_action,
1047     },
1048
1049 STEXI
1050 @item watchdog_action
1051 @findex watchdog_action
1052 Change watchdog action.
1053 ETEXI
1054
1055     {
1056         .name       = "acl_show",
1057         .args_type  = "aclname:s",
1058         .params     = "aclname",
1059         .help       = "list rules in the access control list",
1060         .mhandler.cmd = do_acl_show,
1061     },
1062
1063 STEXI
1064 @item acl_show @var{aclname}
1065 @findex acl_show
1066 List all the matching rules in the access control list, and the default
1067 policy. There are currently two named access control lists,
1068 @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1069 certificate distinguished name, and SASL username respectively.
1070 ETEXI
1071
1072     {
1073         .name       = "acl_policy",
1074         .args_type  = "aclname:s,policy:s",
1075         .params     = "aclname allow|deny",
1076         .help       = "set default access control list policy",
1077         .mhandler.cmd = do_acl_policy,
1078     },
1079
1080 STEXI
1081 @item acl_policy @var{aclname} @code{allow|deny}
1082 @findex acl_policy
1083 Set the default access control list policy, used in the event that
1084 none of the explicit rules match. The default policy at startup is
1085 always @code{deny}.
1086 ETEXI
1087
1088     {
1089         .name       = "acl_add",
1090         .args_type  = "aclname:s,match:s,policy:s,index:i?",
1091         .params     = "aclname match allow|deny [index]",
1092         .help       = "add a match rule to the access control list",
1093         .mhandler.cmd = do_acl_add,
1094     },
1095
1096 STEXI
1097 @item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1098 @findex acl_add
1099 Add a match rule to the access control list, allowing or denying access.
1100 The match will normally be an exact username or x509 distinguished name,
1101 but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1102 allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
1103 normally be appended to the end of the ACL, but can be inserted
1104 earlier in the list if the optional @var{index} parameter is supplied.
1105 ETEXI
1106
1107     {
1108         .name       = "acl_remove",
1109         .args_type  = "aclname:s,match:s",
1110         .params     = "aclname match",
1111         .help       = "remove a match rule from the access control list",
1112         .mhandler.cmd = do_acl_remove,
1113     },
1114
1115 STEXI
1116 @item acl_remove @var{aclname} @var{match}
1117 @findex acl_remove
1118 Remove the specified match rule from the access control list.
1119 ETEXI
1120
1121     {
1122         .name       = "acl_reset",
1123         .args_type  = "aclname:s",
1124         .params     = "aclname",
1125         .help       = "reset the access control list",
1126         .mhandler.cmd = do_acl_reset,
1127     },
1128
1129 STEXI
1130 @item acl_reset @var{aclname}
1131 @findex acl_reset
1132 Remove all matches from the access control list, and set the default
1133 policy back to @code{deny}.
1134 ETEXI
1135
1136 #if defined(TARGET_I386)
1137
1138     {
1139         .name       = "mce",
1140         .args_type  = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1141         .params     = "[-b] cpu bank status mcgstatus addr misc",
1142         .help       = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1143         .mhandler.cmd = do_inject_mce,
1144     },
1145
1146 #endif
1147 STEXI
1148 @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1149 @findex mce (x86)
1150 Inject an MCE on the given CPU (x86 only).
1151 ETEXI
1152
1153     {
1154         .name       = "getfd",
1155         .args_type  = "fdname:s",
1156         .params     = "getfd name",
1157         .help       = "receive a file descriptor via SCM rights and assign it a name",
1158         .user_print = monitor_user_noop,
1159         .mhandler.cmd_new = do_getfd,
1160     },
1161
1162 STEXI
1163 @item getfd @var{fdname}
1164 @findex getfd
1165 If a file descriptor is passed alongside this command using the SCM_RIGHTS
1166 mechanism on unix sockets, it is stored using the name @var{fdname} for
1167 later use by other monitor commands.
1168 ETEXI
1169
1170     {
1171         .name       = "closefd",
1172         .args_type  = "fdname:s",
1173         .params     = "closefd name",
1174         .help       = "close a file descriptor previously passed via SCM rights",
1175         .user_print = monitor_user_noop,
1176         .mhandler.cmd_new = do_closefd,
1177     },
1178
1179 STEXI
1180 @item closefd @var{fdname}
1181 @findex closefd
1182 Close the file descriptor previously assigned to @var{fdname} using the
1183 @code{getfd} command. This is only needed if the file descriptor was never
1184 used by another monitor command.
1185 ETEXI
1186
1187     {
1188         .name       = "block_passwd",
1189         .args_type  = "device:B,password:s",
1190         .params     = "block_passwd device password",
1191         .help       = "set the password of encrypted block devices",
1192         .mhandler.cmd = hmp_block_passwd,
1193     },
1194
1195 STEXI
1196 @item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1197 @findex block_set_io_throttle
1198 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}
1199 ETEXI
1200
1201     {
1202         .name       = "block_set_io_throttle",
1203         .args_type  = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1204         .params     = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1205         .help       = "change I/O throttle limits for a block drive",
1206         .user_print = monitor_user_noop,
1207         .mhandler.cmd_new = do_block_set_io_throttle,
1208     },
1209
1210 STEXI
1211 @item block_passwd @var{device} @var{password}
1212 @findex block_passwd
1213 Set the encrypted device @var{device} password to @var{password}
1214 ETEXI
1215
1216     {
1217         .name       = "set_password",
1218         .args_type  = "protocol:s,password:s,connected:s?",
1219         .params     = "protocol password action-if-connected",
1220         .help       = "set spice/vnc password",
1221         .mhandler.cmd = hmp_set_password,
1222     },
1223
1224 STEXI
1225 @item set_password [ vnc | spice ] password [ action-if-connected ]
1226 @findex set_password
1227
1228 Change spice/vnc password.  Use zero to make the password stay valid
1229 forever.  @var{action-if-connected} specifies what should happen in
1230 case a connection is established: @var{fail} makes the password change
1231 fail.  @var{disconnect} changes the password and disconnects the
1232 client.  @var{keep} changes the password and keeps the connection up.
1233 @var{keep} is the default.
1234 ETEXI
1235
1236     {
1237         .name       = "expire_password",
1238         .args_type  = "protocol:s,time:s",
1239         .params     = "protocol time",
1240         .help       = "set spice/vnc password expire-time",
1241         .mhandler.cmd = hmp_expire_password,
1242     },
1243
1244 STEXI
1245 @item expire_password [ vnc | spice ] expire-time
1246 @findex expire_password
1247
1248 Specify when a password for spice/vnc becomes
1249 invalid. @var{expire-time} accepts:
1250
1251 @table @var
1252 @item now
1253 Invalidate password instantly.
1254
1255 @item never
1256 Password stays valid forever.
1257
1258 @item +nsec
1259 Password stays valid for @var{nsec} seconds starting now.
1260
1261 @item nsec
1262 Password is invalidated at the given time.  @var{nsec} are the seconds
1263 passed since 1970, i.e. unix epoch.
1264
1265 @end table
1266 ETEXI
1267
1268     {
1269         .name       = "info",
1270         .args_type  = "item:s?",
1271         .params     = "[subcommand]",
1272         .help       = "show various information about the system state",
1273         .mhandler.cmd = do_info,
1274     },
1275
1276 STEXI
1277 @item info @var{subcommand}
1278 @findex info
1279 Show various information about the system state.
1280
1281 @table @option
1282 @item info version
1283 show the version of QEMU
1284 @item info network
1285 show the various VLANs and the associated devices
1286 @item info chardev
1287 show the character devices
1288 @item info block
1289 show the block devices
1290 @item info blockstats
1291 show block device statistics
1292 @item info registers
1293 show the cpu registers
1294 @item info cpus
1295 show infos for each CPU
1296 @item info history
1297 show the command line history
1298 @item info irq
1299 show the interrupts statistics (if available)
1300 @item info pic
1301 show i8259 (PIC) state
1302 @item info pci
1303 show emulated PCI device info
1304 @item info tlb
1305 show virtual to physical memory mappings (i386, SH4, SPARC, and PPC only)
1306 @item info mem
1307 show the active virtual memory mappings (i386 only)
1308 @item info jit
1309 show dynamic compiler info
1310 @item info numa
1311 show NUMA information
1312 @item info kvm
1313 show KVM information
1314 @item info usb
1315 show USB devices plugged on the virtual USB hub
1316 @item info usbhost
1317 show all USB host devices
1318 @item info profile
1319 show profiling information
1320 @item info capture
1321 show information about active capturing
1322 @item info snapshots
1323 show list of VM snapshots
1324 @item info status
1325 show the current VM status (running|paused)
1326 @item info pcmcia
1327 show guest PCMCIA status
1328 @item info mice
1329 show which guest mouse is receiving events
1330 @item info vnc
1331 show the vnc server status
1332 @item info name
1333 show the current VM name
1334 @item info uuid
1335 show the current VM UUID
1336 @item info cpustats
1337 show CPU statistics
1338 @item info usernet
1339 show user network stack connection states
1340 @item info migrate
1341 show migration status
1342 @item info balloon
1343 show balloon information
1344 @item info qtree
1345 show device tree
1346 @item info qdm
1347 show qdev device model list
1348 @item info roms
1349 show roms
1350 @end table
1351 ETEXI
1352
1353 #ifdef CONFIG_TRACE_SIMPLE
1354 STEXI
1355 @item info trace
1356 show contents of trace buffer
1357 ETEXI
1358 #endif
1359
1360 STEXI
1361 @item info trace-events
1362 show available trace events and their state
1363 ETEXI
1364
1365 STEXI
1366 @end table
1367 ETEXI