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