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