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