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