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