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         .user_print = monitor_user_noop,
 308         .mhandler.cmd_new = do_cont,
 309     },
 310
 311 STEXI
 312 @item c or cont
 313 @findex cont
 314 Resume emulation.
 315 ETEXI
 316
 317     {
 318         .name       = "gdbserver",
 319         .args_type  = "device:s?",
 320         .params     = "[device]",
 321         .help       = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
 322         .mhandler.cmd = do_gdbserver,
 323     },
 324
 325 STEXI
 326 @item gdbserver [@var{port}]
 327 @findex gdbserver
 328 Start gdbserver session (default @var{port}=1234)
 329 ETEXI
 330
 331     {
 332         .name       = "x",
 333         .args_type  = "fmt:/,addr:l",
 334         .params     = "/fmt addr",
 335         .help       = "virtual memory dump starting at 'addr'",
 336         .mhandler.cmd = do_memory_dump,
 337     },
 338
 339 STEXI
 340 @item x/fmt @var{addr}
 341 @findex x
 342 Virtual memory dump starting at @var{addr}.
 343 ETEXI
 344
 345     {
 346         .name       = "xp",
 347         .args_type  = "fmt:/,addr:l",
 348         .params     = "/fmt addr",
 349         .help       = "physical memory dump starting at 'addr'",
 350         .mhandler.cmd = do_physical_memory_dump,
 351     },
 352
 353 STEXI
 354 @item xp /@var{fmt} @var{addr}
 355 @findex xp
 356 Physical memory dump starting at @var{addr}.
 357
 358 @var{fmt} is a format which tells the command how to format the
 359 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
 360
 361 @table @var
 362 @item count
 363 is the number of items to be dumped.
 364
 365 @item format
 366 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
 367 c (char) or i (asm instruction).
 368
 369 @item size
 370 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
 371 @code{h} or @code{w} can be specified with the @code{i} format to
 372 respectively select 16 or 32 bit code instruction size.
 373
 374 @end table
 375
 376 Examples:
 377 @itemize
 378 @item
 379 Dump 10 instructions at the current instruction pointer:
 380 @example
 381 (qemu) x/10i $eip
 382 0x90107063:  ret
 383 0x90107064:  sti
 384 0x90107065:  lea    0x0(%esi,1),%esi
 385 0x90107069:  lea    0x0(%edi,1),%edi
 386 0x90107070:  ret
 387 0x90107071:  jmp    0x90107080
 388 0x90107073:  nop
 389 0x90107074:  nop
 390 0x90107075:  nop
 391 0x90107076:  nop
 392 @end example
 393
 394 @item
 395 Dump 80 16 bit values at the start of the video memory.
 396 @smallexample
 397 (qemu) xp/80hx 0xb8000
 398 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
 399 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
 400 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
 401 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
 402 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
 403 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
 404 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
 405 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
 406 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
 407 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
 408 @end smallexample
 409 @end itemize
 410 ETEXI
 411
 412     {
 413         .name       = "p|print",
 414         .args_type  = "fmt:/,val:l",
 415         .params     = "/fmt expr",
 416         .help       = "print expression value (use $reg for CPU register access)",
 417         .mhandler.cmd = do_print,
 418     },
 419
 420 STEXI
 421 @item p or print/@var{fmt} @var{expr}
 422 @findex print
 423
 424 Print expression value. Only the @var{format} part of @var{fmt} is
 425 used.
 426 ETEXI
 427
 428     {
 429         .name       = "i",
 430         .args_type  = "fmt:/,addr:i,index:i.",
 431         .params     = "/fmt addr",
 432         .help       = "I/O port read",
 433         .mhandler.cmd = do_ioport_read,
 434     },
 435
 436 STEXI
 437 Read I/O port.
 438 ETEXI
 439
 440     {
 441         .name       = "o",
 442         .args_type  = "fmt:/,addr:i,val:i",
 443         .params     = "/fmt addr value",
 444         .help       = "I/O port write",
 445         .mhandler.cmd = do_ioport_write,
 446     },
 447
 448 STEXI
 449 Write to I/O port.
 450 ETEXI
 451
 452     {
 453         .name       = "sendkey",
 454         .args_type  = "string:s,hold_time:i?",
 455         .params     = "keys [hold_ms]",
 456         .help       = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
 457         .mhandler.cmd = do_sendkey,
 458     },
 459
 460 STEXI
 461 @item sendkey @var{keys}
 462 @findex sendkey
 463
 464 Send @var{keys} to the emulator. @var{keys} could be the name of the
 465 key or @code{#} followed by the raw value in either decimal or hexadecimal
 466 format. Use @code{-} to press several keys simultaneously. Example:
 467 @example
 468 sendkey ctrl-alt-f1
 469 @end example
 470
 471 This command is useful to send keys that your graphical user interface
 472 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
 473 ETEXI
 474
 475     {
 476         .name       = "system_reset",
 477         .args_type  = "",
 478         .params     = "",
 479         .help       = "reset the system",
 480         .mhandler.cmd = hmp_system_reset,
 481     },
 482
 483 STEXI
 484 @item system_reset
 485 @findex system_reset
 486
 487 Reset the system.
 488 ETEXI
 489
 490     {
 491         .name       = "system_powerdown",
 492         .args_type  = "",
 493         .params     = "",
 494         .help       = "send system power down event",
 495         .mhandler.cmd = hmp_system_powerdown,
 496     },
 497
 498 STEXI
 499 @item system_powerdown
 500 @findex system_powerdown
 501
 502 Power down the system (if supported).
 503 ETEXI
 504
 505     {
 506         .name       = "sum",
 507         .args_type  = "start:i,size:i",
 508         .params     = "addr size",
 509         .help       = "compute the checksum of a memory region",
 510         .mhandler.cmd = do_sum,
 511     },
 512
 513 STEXI
 514 @item sum @var{addr} @var{size}
 515 @findex sum
 516
 517 Compute the checksum of a memory region.
 518 ETEXI
 519
 520     {
 521         .name       = "usb_add",
 522         .args_type  = "devname:s",
 523         .params     = "device",
 524         .help       = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
 525         .mhandler.cmd = do_usb_add,
 526     },
 527
 528 STEXI
 529 @item usb_add @var{devname}
 530 @findex usb_add
 531
 532 Add the USB device @var{devname}.  For details of available devices see
 533 @ref{usb_devices}
 534 ETEXI
 535
 536     {
 537         .name       = "usb_del",
 538         .args_type  = "devname:s",
 539         .params     = "device",
 540         .help       = "remove USB device 'bus.addr'",
 541         .mhandler.cmd = do_usb_del,
 542     },
 543
 544 STEXI
 545 @item usb_del @var{devname}
 546 @findex usb_del
 547
 548 Remove the USB device @var{devname} from the QEMU virtual USB
 549 hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
 550 command @code{info usb} to see the devices you can remove.
 551 ETEXI
 552
 553     {
 554         .name       = "device_add",
 555         .args_type  = "device:O",
 556         .params     = "driver[,prop=value][,...]",
 557         .help       = "add device, like -device on the command line",
 558         .user_print = monitor_user_noop,
 559         .mhandler.cmd_new = do_device_add,
 560     },
 561
 562 STEXI
 563 @item device_add @var{config}
 564 @findex device_add
 565
 566 Add device.
 567 ETEXI
 568
 569     {
 570         .name       = "device_del",
 571         .args_type  = "id:s",
 572         .params     = "device",
 573         .help       = "remove device",
 574         .user_print = monitor_user_noop,
 575         .mhandler.cmd_new = do_device_del,
 576     },
 577
 578 STEXI
 579 @item device_del @var{id}
 580 @findex device_del
 581
 582 Remove device @var{id}.
 583 ETEXI
 584
 585     {
 586         .name       = "cpu",
 587         .args_type  = "index:i",
 588         .params     = "index",
 589         .help       = "set the default CPU",
 590         .mhandler.cmd = hmp_cpu,
 591     },
 592
 593 STEXI
 594 @item cpu @var{index}
 595 @findex cpu
 596 Set the default CPU.
 597 ETEXI
 598
 599     {
 600         .name       = "mouse_move",
 601         .args_type  = "dx_str:s,dy_str:s,dz_str:s?",
 602         .params     = "dx dy [dz]",
 603         .help       = "send mouse move events",
 604         .mhandler.cmd = do_mouse_move,
 605     },
 606
 607 STEXI
 608 @item mouse_move @var{dx} @var{dy} [@var{dz}]
 609 @findex mouse_move
 610 Move the active mouse to the specified coordinates @var{dx} @var{dy}
 611 with optional scroll axis @var{dz}.
 612 ETEXI
 613
 614     {
 615         .name       = "mouse_button",
 616         .args_type  = "button_state:i",
 617         .params     = "state",
 618         .help       = "change mouse button state (1=L, 2=M, 4=R)",
 619         .mhandler.cmd = do_mouse_button,
 620     },
 621
 622 STEXI
 623 @item mouse_button @var{val}
 624 @findex mouse_button
 625 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
 626 ETEXI
 627
 628     {
 629         .name       = "mouse_set",
 630         .args_type  = "index:i",
 631         .params     = "index",
 632         .help       = "set which mouse device receives events",
 633         .mhandler.cmd = do_mouse_set,
 634     },
 635
 636 STEXI
 637 @item mouse_set @var{index}
 638 @findex mouse_set
 639 Set which mouse device receives events at given @var{index}, index
 640 can be obtained with
 641 @example
 642 info mice
 643 @end example
 644 ETEXI
 645
 646 #ifdef HAS_AUDIO
 647     {
 648         .name       = "wavcapture",
 649         .args_type  = "path:F,freq:i?,bits:i?,nchannels:i?",
 650         .params     = "path [frequency [bits [channels]]]",
 651         .help       = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
 652         .mhandler.cmd = do_wav_capture,
 653     },
 654 #endif
 655 STEXI
 656 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
 657 @findex wavcapture
 658 Capture audio into @var{filename}. Using sample rate @var{frequency}
 659 bits per sample @var{bits} and number of channels @var{channels}.
 660
 661 Defaults:
 662 @itemize @minus
 663 @item Sample rate = 44100 Hz - CD quality
 664 @item Bits = 16
 665 @item Number of channels = 2 - Stereo
 666 @end itemize
 667 ETEXI
 668
 669 #ifdef HAS_AUDIO
 670     {
 671         .name       = "stopcapture",
 672         .args_type  = "n:i",
 673         .params     = "capture index",
 674         .help       = "stop capture",
 675         .mhandler.cmd = do_stop_capture,
 676     },
 677 #endif
 678 STEXI
 679 @item stopcapture @var{index}
 680 @findex stopcapture
 681 Stop capture with a given @var{index}, index can be obtained with
 682 @example
 683 info capture
 684 @end example
 685 ETEXI
 686
 687     {
 688         .name       = "memsave",
 689         .args_type  = "val:l,size:i,filename:s",
 690         .params     = "addr size file",
 691         .help       = "save to disk virtual memory dump starting at 'addr' of size 'size'",
 692         .user_print = monitor_user_noop,
 693         .mhandler.cmd_new = do_memory_save,
 694     },
 695
 696 STEXI
 697 @item memsave @var{addr} @var{size} @var{file}
 698 @findex memsave
 699 save to disk virtual memory dump starting at @var{addr} of size @var{size}.
 700 ETEXI
 701
 702     {
 703         .name       = "pmemsave",
 704         .args_type  = "val:l,size:i,filename:s",
 705         .params     = "addr size file",
 706         .help       = "save to disk physical memory dump starting at 'addr' of size 'size'",
 707         .user_print = monitor_user_noop,
 708         .mhandler.cmd_new = do_physical_memory_save,
 709     },
 710
 711 STEXI
 712 @item pmemsave @var{addr} @var{size} @var{file}
 713 @findex pmemsave
 714 save to disk physical memory dump starting at @var{addr} of size @var{size}.
 715 ETEXI
 716
 717     {
 718         .name       = "boot_set",
 719         .args_type  = "bootdevice:s",
 720         .params     = "bootdevice",
 721         .help       = "define new values for the boot device list",
 722         .mhandler.cmd = do_boot_set,
 723     },
 724
 725 STEXI
 726 @item boot_set @var{bootdevicelist}
 727 @findex boot_set
 728
 729 Define new values for the boot device list. Those values will override
 730 the values specified on the command line through the @code{-boot} option.
 731
 732 The values that can be specified here depend on the machine type, but are
 733 the same that can be specified in the @code{-boot} command line option.
 734 ETEXI
 735
 736 #if defined(TARGET_I386)
 737     {
 738         .name       = "nmi",
 739         .args_type  = "",
 740         .params     = "",
 741         .help       = "inject an NMI on all guest's CPUs",
 742         .user_print = monitor_user_noop,
 743         .mhandler.cmd_new = do_inject_nmi,
 744     },
 745 #endif
 746 STEXI
 747 @item nmi @var{cpu}
 748 @findex nmi
 749 Inject an NMI on the given CPU (x86 only).
 750 ETEXI
 751
 752     {
 753         .name       = "migrate",
 754         .args_type  = "detach:-d,blk:-b,inc:-i,uri:s",
 755         .params     = "[-d] [-b] [-i] uri",
 756         .help       = "migrate to URI (using -d to not wait for completion)"
 757                       "\n\t\t\t -b for migration without shared storage with"
 758                       " full copy of disk\n\t\t\t -i for migration without "
 759                       "shared storage with incremental copy of disk "
 760                       "(base image shared between src and destination)",
 761         .user_print = monitor_user_noop,
 762         .mhandler.cmd_new = do_migrate,
 763     },
 764
 765
 766 STEXI
 767 @item migrate [-d] [-b] [-i] @var{uri}
 768 @findex migrate
 769 Migrate to @var{uri} (using -d to not wait for completion).
 770         -b for migration with full copy of disk
 771         -i for migration with incremental copy of disk (base image is shared)
 772 ETEXI
 773
 774     {
 775         .name       = "migrate_cancel",
 776         .args_type  = "",
 777         .params     = "",
 778         .help       = "cancel the current VM migration",
 779         .user_print = monitor_user_noop,
 780         .mhandler.cmd_new = do_migrate_cancel,
 781     },
 782
 783 STEXI
 784 @item migrate_cancel
 785 @findex migrate_cancel
 786 Cancel the current VM migration.
 787 ETEXI
 788
 789     {
 790         .name       = "migrate_set_speed",
 791         .args_type  = "value:o",
 792         .params     = "value",
 793         .help       = "set maximum speed (in bytes) for migrations. "
 794         "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
 795         .user_print = monitor_user_noop,
 796         .mhandler.cmd_new = do_migrate_set_speed,
 797     },
 798
 799 STEXI
 800 @item migrate_set_speed @var{value}
 801 @findex migrate_set_speed
 802 Set maximum speed to @var{value} (in bytes) for migrations.
 803 ETEXI
 804
 805     {
 806         .name       = "migrate_set_downtime",
 807         .args_type  = "value:T",
 808         .params     = "value",
 809         .help       = "set maximum tolerated downtime (in seconds) for migrations",
 810         .user_print = monitor_user_noop,
 811         .mhandler.cmd_new = do_migrate_set_downtime,
 812     },
 813
 814 STEXI
 815 @item migrate_set_downtime @var{second}
 816 @findex migrate_set_downtime
 817 Set maximum tolerated downtime (in seconds) for migration.
 818 ETEXI
 819
 820     {
 821         .name       = "client_migrate_info",
 822         .args_type  = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
 823         .params     = "protocol hostname port tls-port cert-subject",
 824         .help       = "send migration info to spice/vnc client",
 825         .user_print = monitor_user_noop,
 826         .mhandler.cmd_new = client_migrate_info,
 827     },
 828
 829 STEXI
 830 @item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
 831 @findex client_migrate_info
 832 Set the spice/vnc connection info for the migration target.  The spice/vnc
 833 server will ask the spice/vnc client to automatically reconnect using the
 834 new parameters (if specified) once the vm migration finished successfully.
 835 ETEXI
 836
 837     {
 838         .name       = "snapshot_blkdev",
 839         .args_type  = "device:B,snapshot-file:s?,format:s?",
 840         .params     = "device [new-image-file] [format]",
 841         .help       = "initiates a live snapshot\n\t\t\t"
 842                       "of device. If a new image file is specified, the\n\t\t\t"
 843                       "new image file will become the new root image.\n\t\t\t"
 844                       "If format is specified, the snapshot file will\n\t\t\t"
 845                       "be created in that format. Otherwise the\n\t\t\t"
 846                       "snapshot will be internal! (currently unsupported)",
 847         .mhandler.cmd_new = do_snapshot_blkdev,
 848     },
 849
 850 STEXI
 851 @item snapshot_blkdev
 852 @findex snapshot_blkdev
 853 Snapshot device, using snapshot file as target if provided
 854 ETEXI
 855
 856 #if defined(TARGET_I386)
 857     {
 858         .name       = "drive_add",
 859         .args_type  = "pci_addr:s,opts:s",
 860         .params     = "[[<domain>:]<bus>:]<slot>\n"
 861                       "[file=file][,if=type][,bus=n]\n"
 862                       "[,unit=m][,media=d][index=i]\n"
 863                       "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
 864                       "[snapshot=on|off][,cache=on|off]",
 865         .help       = "add drive to PCI storage controller",
 866         .mhandler.cmd = drive_hot_add,
 867     },
 868 #endif
 869
 870 STEXI
 871 @item drive_add
 872 @findex drive_add
 873 Add drive to PCI storage controller.
 874 ETEXI
 875
 876 #if defined(TARGET_I386)
 877     {
 878         .name       = "pci_add",
 879         .args_type  = "pci_addr:s,type:s,opts:s?",
 880         .params     = "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...",
 881         .help       = "hot-add PCI device",
 882         .mhandler.cmd = pci_device_hot_add,
 883     },
 884 #endif
 885
 886 STEXI
 887 @item pci_add
 888 @findex pci_add
 889 Hot-add PCI device.
 890 ETEXI
 891
 892 #if defined(TARGET_I386)
 893     {
 894         .name       = "pci_del",
 895         .args_type  = "pci_addr:s",
 896         .params     = "[[<domain>:]<bus>:]<slot>",
 897         .help       = "hot remove PCI device",
 898         .mhandler.cmd = do_pci_device_hot_remove,
 899     },
 900 #endif
 901
 902 STEXI
 903 @item pci_del
 904 @findex pci_del
 905 Hot remove PCI device.
 906 ETEXI
 907
 908     {
 909         .name       = "pcie_aer_inject_error",
 910         .args_type  = "advisory_non_fatal:-a,correctable:-c,"
 911                       "id:s,error_status:s,"
 912                       "header0:i?,header1:i?,header2:i?,header3:i?,"
 913                       "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
 914         .params     = "[-a] [-c] id "
 915                       "<error_status> [<tlp header> [<tlp header prefix>]]",
 916         .help       = "inject pcie aer error\n\t\t\t"
 917                       " -a for advisory non fatal error\n\t\t\t"
 918                       " -c for correctable error\n\t\t\t"
 919                       "<id> = qdev device id\n\t\t\t"
 920                       "<error_status> = error string or 32bit\n\t\t\t"
 921                       "<tlb header> = 32bit x 4\n\t\t\t"
 922                       "<tlb header prefix> = 32bit x 4",
 923         .user_print  = pcie_aer_inject_error_print,
 924         .mhandler.cmd_new = do_pcie_aer_inejct_error,
 925     },
 926
 927 STEXI
 928 @item pcie_aer_inject_error
 929 @findex pcie_aer_inject_error
 930 Inject PCIe AER error
 931 ETEXI
 932
 933     {
 934         .name       = "host_net_add",
 935         .args_type  = "device:s,opts:s?",
 936         .params     = "tap|user|socket|vde|dump [options]",
 937         .help       = "add host VLAN client",
 938         .mhandler.cmd = net_host_device_add,
 939     },
 940
 941 STEXI
 942 @item host_net_add
 943 @findex host_net_add
 944 Add host VLAN client.
 945 ETEXI
 946
 947     {
 948         .name       = "host_net_remove",
 949         .args_type  = "vlan_id:i,device:s",
 950         .params     = "vlan_id name",
 951         .help       = "remove host VLAN client",
 952         .mhandler.cmd = net_host_device_remove,
 953     },
 954
 955 STEXI
 956 @item host_net_remove
 957 @findex host_net_remove
 958 Remove host VLAN client.
 959 ETEXI
 960
 961     {
 962         .name       = "netdev_add",
 963         .args_type  = "netdev:O",
 964         .params     = "[user|tap|socket],id=str[,prop=value][,...]",
 965         .help       = "add host network device",
 966         .user_print = monitor_user_noop,
 967         .mhandler.cmd_new = do_netdev_add,
 968     },
 969
 970 STEXI
 971 @item netdev_add
 972 @findex netdev_add
 973 Add host network device.
 974 ETEXI
 975
 976     {
 977         .name       = "netdev_del",
 978         .args_type  = "id:s",
 979         .params     = "id",
 980         .help       = "remove host network device",
 981         .user_print = monitor_user_noop,
 982         .mhandler.cmd_new = do_netdev_del,
 983     },
 984
 985 STEXI
 986 @item netdev_del
 987 @findex netdev_del
 988 Remove host network device.
 989 ETEXI
 990
 991 #ifdef CONFIG_SLIRP
 992     {
 993         .name       = "hostfwd_add",
 994         .args_type  = "arg1:s,arg2:s?,arg3:s?",
 995         .params     = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
 996         .help       = "redirect TCP or UDP connections from host to guest (requires -net user)",
 997         .mhandler.cmd = net_slirp_hostfwd_add,
 998     },
 999 #endif
1000 STEXI
1001 @item hostfwd_add
1002 @findex hostfwd_add
1003 Redirect TCP or UDP connections from host to guest (requires -net user).
1004 ETEXI
1005
1006 #ifdef CONFIG_SLIRP
1007     {
1008         .name       = "hostfwd_remove",
1009         .args_type  = "arg1:s,arg2:s?,arg3:s?",
1010         .params     = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1011         .help       = "remove host-to-guest TCP or UDP redirection",
1012         .mhandler.cmd = net_slirp_hostfwd_remove,
1013     },
1014
1015 #endif
1016 STEXI
1017 @item hostfwd_remove
1018 @findex hostfwd_remove
1019 Remove host-to-guest TCP or UDP redirection.
1020 ETEXI
1021
1022     {
1023         .name       = "balloon",
1024         .args_type  = "value:M",
1025         .params     = "target",
1026         .help       = "request VM to change its memory allocation (in MB)",
1027         .user_print = monitor_user_noop,
1028         .mhandler.cmd_async = do_balloon,
1029         .flags      = MONITOR_CMD_ASYNC,
1030     },
1031
1032 STEXI
1033 @item balloon @var{value}
1034 @findex balloon
1035 Request VM to change its memory allocation to @var{value} (in MB).
1036 ETEXI
1037
1038     {
1039         .name       = "set_link",
1040         .args_type  = "name:s,up:b",
1041         .params     = "name on|off",
1042         .help       = "change the link status of a network adapter",
1043         .user_print = monitor_user_noop,
1044         .mhandler.cmd_new = do_set_link,
1045     },
1046
1047 STEXI
1048 @item set_link @var{name} [on|off]
1049 @findex set_link
1050 Switch link @var{name} on (i.e. up) or off (i.e. down).
1051 ETEXI
1052
1053     {
1054         .name       = "watchdog_action",
1055         .args_type  = "action:s",
1056         .params     = "[reset|shutdown|poweroff|pause|debug|none]",
1057         .help       = "change watchdog action",
1058         .mhandler.cmd = do_watchdog_action,
1059     },
1060
1061 STEXI
1062 @item watchdog_action
1063 @findex watchdog_action
1064 Change watchdog action.
1065 ETEXI
1066
1067     {
1068         .name       = "acl_show",
1069         .args_type  = "aclname:s",
1070         .params     = "aclname",
1071         .help       = "list rules in the access control list",
1072         .mhandler.cmd = do_acl_show,
1073     },
1074
1075 STEXI
1076 @item acl_show @var{aclname}
1077 @findex acl_show
1078 List all the matching rules in the access control list, and the default
1079 policy. There are currently two named access control lists,
1080 @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1081 certificate distinguished name, and SASL username respectively.
1082 ETEXI
1083
1084     {
1085         .name       = "acl_policy",
1086         .args_type  = "aclname:s,policy:s",
1087         .params     = "aclname allow|deny",
1088         .help       = "set default access control list policy",
1089         .mhandler.cmd = do_acl_policy,
1090     },
1091
1092 STEXI
1093 @item acl_policy @var{aclname} @code{allow|deny}
1094 @findex acl_policy
1095 Set the default access control list policy, used in the event that
1096 none of the explicit rules match. The default policy at startup is
1097 always @code{deny}.
1098 ETEXI
1099
1100     {
1101         .name       = "acl_add",
1102         .args_type  = "aclname:s,match:s,policy:s,index:i?",
1103         .params     = "aclname match allow|deny [index]",
1104         .help       = "add a match rule to the access control list",
1105         .mhandler.cmd = do_acl_add,
1106     },
1107
1108 STEXI
1109 @item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1110 @findex acl_add
1111 Add a match rule to the access control list, allowing or denying access.
1112 The match will normally be an exact username or x509 distinguished name,
1113 but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1114 allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
1115 normally be appended to the end of the ACL, but can be inserted
1116 earlier in the list if the optional @var{index} parameter is supplied.
1117 ETEXI
1118
1119     {
1120         .name       = "acl_remove",
1121         .args_type  = "aclname:s,match:s",
1122         .params     = "aclname match",
1123         .help       = "remove a match rule from the access control list",
1124         .mhandler.cmd = do_acl_remove,
1125     },
1126
1127 STEXI
1128 @item acl_remove @var{aclname} @var{match}
1129 @findex acl_remove
1130 Remove the specified match rule from the access control list.
1131 ETEXI
1132
1133     {
1134         .name       = "acl_reset",
1135         .args_type  = "aclname:s",
1136         .params     = "aclname",
1137         .help       = "reset the access control list",
1138         .mhandler.cmd = do_acl_reset,
1139     },
1140
1141 STEXI
1142 @item acl_reset @var{aclname}
1143 @findex acl_reset
1144 Remove all matches from the access control list, and set the default
1145 policy back to @code{deny}.
1146 ETEXI
1147
1148 #if defined(TARGET_I386)
1149
1150     {
1151         .name       = "mce",
1152         .args_type  = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1153         .params     = "[-b] cpu bank status mcgstatus addr misc",
1154         .help       = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1155         .mhandler.cmd = do_inject_mce,
1156     },
1157
1158 #endif
1159 STEXI
1160 @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1161 @findex mce (x86)
1162 Inject an MCE on the given CPU (x86 only).
1163 ETEXI
1164
1165     {
1166         .name       = "getfd",
1167         .args_type  = "fdname:s",
1168         .params     = "getfd name",
1169         .help       = "receive a file descriptor via SCM rights and assign it a name",
1170         .user_print = monitor_user_noop,
1171         .mhandler.cmd_new = do_getfd,
1172     },
1173
1174 STEXI
1175 @item getfd @var{fdname}
1176 @findex getfd
1177 If a file descriptor is passed alongside this command using the SCM_RIGHTS
1178 mechanism on unix sockets, it is stored using the name @var{fdname} for
1179 later use by other monitor commands.
1180 ETEXI
1181
1182     {
1183         .name       = "closefd",
1184         .args_type  = "fdname:s",
1185         .params     = "closefd name",
1186         .help       = "close a file descriptor previously passed via SCM rights",
1187         .user_print = monitor_user_noop,
1188         .mhandler.cmd_new = do_closefd,
1189     },
1190
1191 STEXI
1192 @item closefd @var{fdname}
1193 @findex closefd
1194 Close the file descriptor previously assigned to @var{fdname} using the
1195 @code{getfd} command. This is only needed if the file descriptor was never
1196 used by another monitor command.
1197 ETEXI
1198
1199     {
1200         .name       = "block_passwd",
1201         .args_type  = "device:B,password:s",
1202         .params     = "block_passwd device password",
1203         .help       = "set the password of encrypted block devices",
1204         .user_print = monitor_user_noop,
1205         .mhandler.cmd_new = do_block_set_passwd,
1206     },
1207
1208 STEXI
1209 @item block_passwd @var{device} @var{password}
1210 @findex block_passwd
1211 Set the encrypted device @var{device} password to @var{password}
1212 ETEXI
1213
1214     {
1215         .name       = "set_password",
1216         .args_type  = "protocol:s,password:s,connected:s?",
1217         .params     = "protocol password action-if-connected",
1218         .help       = "set spice/vnc password",
1219         .user_print = monitor_user_noop,
1220         .mhandler.cmd_new = set_password,
1221     },
1222
1223 STEXI
1224 @item set_password [ vnc | spice ] password [ action-if-connected ]
1225 @findex set_password
1226
1227 Change spice/vnc password.  Use zero to make the password stay valid
1228 forever.  @var{action-if-connected} specifies what should happen in
1229 case a connection is established: @var{fail} makes the password change
1230 fail.  @var{disconnect} changes the password and disconnects the
1231 client.  @var{keep} changes the password and keeps the connection up.
1232 @var{keep} is the default.
1233 ETEXI
1234
1235     {
1236         .name       = "expire_password",
1237         .args_type  = "protocol:s,time:s",
1238         .params     = "protocol time",
1239         .help       = "set spice/vnc password expire-time",
1240         .user_print = monitor_user_noop,
1241         .mhandler.cmd_new = 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