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