qemu-monitor.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 Text between SQMP and EQMP is copied to the QMP documention file and
   5 HXCOMM does not show up in the other formats.
   6 HXCOMM DEF(command, args, callback, arg_string, help) is used to construct
   7 HXCOMM monitor commands
   8 HXCOMM HXCOMM can be used for comments, discarded from both texi and C
   9
  10 SQMP
  11                         QMP Supported Commands
  12                         ----------------------
  13
  14 This document describes all commands currently supported by QMP.
  15
  16 Most of the time their usage is exactly the same as in the user Monitor, this
  17 means that any other document which also describe commands (the manpage,
  18 QEMU's manual, etc) can and should be consulted.
  19
  20 QMP has two types of commands: regular and query commands. Regular commands
  21 usually change the Virtual Machine's state someway, while query commands just
  22 return information. The sections below are divided accordingly.
  23
  24 It's important to observe that all communication examples are formatted in
  25 a reader-friendly way, so that they're easier to understand. However, in real
  26 protocol usage, they're emitted as a single line.
  27
  28 Also, the following notation is used to denote data flow:
  29
  30 -> data issued by the Client
  31 <- Server data response
  32
  33 Please, refer to the QMP specification (QMP/qmp-spec.txt) for detailed
  34 information on the Server command and response formats.
  35
  36 NOTE: This document is temporary and will be replaced soon.
  37
  38 1. Stability Considerations
  39 ===========================
  40
  41 The current QMP command set (described in this file) may be useful for a
  42 number of use cases, however it's limited and several commands have bad
  43 defined semantics, specially with regard to command completion.
  44
  45 These problems are going to be solved incrementally in the next QEMU releases
  46 and we're going to establish a deprecation policy for badly defined commands.
  47
  48 If you're planning to adopt QMP, please observe the following:
  49
  50     1. The deprecation policy will take efect and be documented soon, please
  51        check the documentation of each used command as soon as a new release of
  52        QEMU is available
  53
  54     2. DO NOT rely on anything which is not explicit documented
  55
  56     3. Errors, in special, are not documented. Applications should NOT check
  57        for specific errors classes or data (it's strongly recommended to only
  58        check for the "error" key)
  59
  60 2. Regular Commands
  61 ===================
  62
  63 Server's responses in the examples below are always a success response, please
  64 refer to the QMP specification for more details on error responses.
  65
  66 EQMP
  67
  68 STEXI
  69 @table @option
  70 ETEXI
  71
  72     {
  73         .name       = "help|?",
  74         .args_type  = "name:s?",
  75         .params     = "[cmd]",
  76         .help       = "show the help",
  77         .mhandler.cmd = do_help_cmd,
  78     },
  79
  80 STEXI
  81 @item help or ? [@var{cmd}]
  82 @findex help
  83 Show the help for all commands or just for command @var{cmd}.
  84 ETEXI
  85
  86     {
  87         .name       = "commit",
  88         .args_type  = "device:B",
  89         .params     = "device|all",
  90         .help       = "commit changes to the disk images (if -snapshot is used) or backing files",
  91         .mhandler.cmd = do_commit,
  92     },
  93
  94 STEXI
  95 @item commit
  96 @findex commit
  97 Commit changes to the disk images (if -snapshot is used) or backing files.
  98 ETEXI
  99
 100     {
 101         .name       = "q|quit",
 102         .args_type  = "",
 103         .params     = "",
 104         .help       = "quit the emulator",
 105         .user_print = monitor_user_noop,
 106         .mhandler.cmd_new = do_quit,
 107     },
 108
 109 STEXI
 110 @item q or quit
 111 @findex quit
 112 Quit the emulator.
 113 ETEXI
 114 SQMP
 115 quit
 116 ----
 117
 118 Quit the emulator.
 119
 120 Arguments: None.
 121
 122 Example:
 123
 124 -> { "execute": "quit" }
 125 <- { "return": {} }
 126
 127 EQMP
 128
 129     {
 130         .name       = "eject",
 131         .args_type  = "force:-f,device:B",
 132         .params     = "[-f] device",
 133         .help       = "eject a removable medium (use -f to force it)",
 134         .user_print = monitor_user_noop,
 135         .mhandler.cmd_new = do_eject,
 136     },
 137
 138 STEXI
 139 @item eject [-f] @var{device}
 140 @findex eject
 141 Eject a removable medium (use -f to force it).
 142 ETEXI
 143 SQMP
 144 eject
 145 -----
 146
 147 Eject a removable medium.
 148
 149 Arguments:
 150
 151 - force: force ejection (json-bool, optional)
 152 - device: device name (json-string)
 153
 154 Example:
 155
 156 -> { "execute": "eject", "arguments": { "device": "ide1-cd0" } }
 157 <- { "return": {} }
 158
 159 Note: The "force" argument defaults to false.
 160
 161 EQMP
 162
 163     {
 164         .name       = "change",
 165         .args_type  = "device:B,target:F,arg:s?",
 166         .params     = "device filename [format]",
 167         .help       = "change a removable medium, optional format",
 168         .user_print = monitor_user_noop,
 169         .mhandler.cmd_new = do_change,
 170     },
 171
 172 STEXI
 173 @item change @var{device} @var{setting}
 174 @findex change
 175
 176 Change the configuration of a device.
 177
 178 @table @option
 179 @item change @var{diskdevice} @var{filename} [@var{format}]
 180 Change the medium for a removable disk device to point to @var{filename}. eg
 181
 182 @example
 183 (qemu) change ide1-cd0 /path/to/some.iso
 184 @end example
 185
 186 @var{format} is optional.
 187
 188 @item change vnc @var{display},@var{options}
 189 Change the configuration of the VNC server. The valid syntax for @var{display}
 190 and @var{options} are described at @ref{sec_invocation}. eg
 191
 192 @example
 193 (qemu) change vnc localhost:1
 194 @end example
 195
 196 @item change vnc password [@var{password}]
 197
 198 Change the password associated with the VNC server. If the new password is not
 199 supplied, the monitor will prompt for it to be entered. VNC passwords are only
 200 significant up to 8 letters. eg
 201
 202 @example
 203 (qemu) change vnc password
 204 Password: ********
 205 @end example
 206
 207 @end table
 208 ETEXI
 209 SQMP
 210 change
 211 ------
 212
 213 Change a removable medium or VNC configuration.
 214
 215 Arguments:
 216
 217 - "device": device name (json-string)
 218 - "target": filename or item (json-string)
 219 - "arg": additional argument (json-string, optional)
 220
 221 Examples:
 222
 223 1. Change a removable medium
 224
 225 -> { "execute": "change",
 226              "arguments": { "device": "ide1-cd0",
 227                             "target": "/srv/images/Fedora-12-x86_64-DVD.iso" } }
 228 <- { "return": {} }
 229
 230 2. Change VNC password
 231
 232 -> { "execute": "change",
 233              "arguments": { "device": "vnc", "target": "password",
 234                             "arg": "foobar1" } }
 235 <- { "return": {} }
 236
 237 EQMP
 238
 239     {
 240         .name       = "screendump",
 241         .args_type  = "filename:F",
 242         .params     = "filename",
 243         .help       = "save screen into PPM image 'filename'",
 244         .user_print = monitor_user_noop,
 245         .mhandler.cmd_new = do_screen_dump,
 246     },
 247
 248 STEXI
 249 @item screendump @var{filename}
 250 @findex screendump
 251 Save screen into PPM image @var{filename}.
 252 ETEXI
 253 SQMP
 254 screendump
 255 ----------
 256
 257 Save screen into PPM image.
 258
 259 Arguments:
 260
 261 - "filename": file path (json-string)
 262
 263 Example:
 264
 265 -> { "execute": "screendump", "arguments": { "filename": "/tmp/image" } }
 266 <- { "return": {} }
 267
 268 EQMP
 269
 270     {
 271         .name       = "logfile",
 272         .args_type  = "filename:F",
 273         .params     = "filename",
 274         .help       = "output logs to 'filename'",
 275         .mhandler.cmd = do_logfile,
 276     },
 277
 278 STEXI
 279 @item logfile @var{filename}
 280 @findex logfile
 281 Output logs to @var{filename}.
 282 ETEXI
 283
 284     {
 285         .name       = "log",
 286         .args_type  = "items:s",
 287         .params     = "item1[,...]",
 288         .help       = "activate logging of the specified items to '/tmp/qemu.log'",
 289         .mhandler.cmd = do_log,
 290     },
 291
 292 STEXI
 293 @item log @var{item1}[,...]
 294 @findex log
 295 Activate logging of the specified items to @file{/tmp/qemu.log}.
 296 ETEXI
 297
 298     {
 299         .name       = "savevm",
 300         .args_type  = "name:s?",
 301         .params     = "[tag|id]",
 302         .help       = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
 303         .mhandler.cmd = do_savevm,
 304     },
 305
 306 STEXI
 307 @item savevm [@var{tag}|@var{id}]
 308 @findex savevm
 309 Create a snapshot of the whole virtual machine. If @var{tag} is
 310 provided, it is used as human readable identifier. If there is already
 311 a snapshot with the same tag or ID, it is replaced. More info at
 312 @ref{vm_snapshots}.
 313 ETEXI
 314
 315     {
 316         .name       = "loadvm",
 317         .args_type  = "name:s",
 318         .params     = "tag|id",
 319         .help       = "restore a VM snapshot from its tag or id",
 320         .mhandler.cmd = do_loadvm,
 321     },
 322
 323 STEXI
 324 @item loadvm @var{tag}|@var{id}
 325 @findex loadvm
 326 Set the whole virtual machine to the snapshot identified by the tag
 327 @var{tag} or the unique snapshot ID @var{id}.
 328 ETEXI
 329
 330     {
 331         .name       = "delvm",
 332         .args_type  = "name:s",
 333         .params     = "tag|id",
 334         .help       = "delete a VM snapshot from its tag or id",
 335         .mhandler.cmd = do_delvm,
 336     },
 337
 338 STEXI
 339 @item delvm @var{tag}|@var{id}
 340 @findex delvm
 341 Delete the snapshot identified by @var{tag} or @var{id}.
 342 ETEXI
 343
 344     {
 345         .name       = "singlestep",
 346         .args_type  = "option:s?",
 347         .params     = "[on|off]",
 348         .help       = "run emulation in singlestep mode or switch to normal mode",
 349         .mhandler.cmd = do_singlestep,
 350     },
 351
 352 STEXI
 353 @item singlestep [off]
 354 @findex singlestep
 355 Run the emulation in single step mode.
 356 If called with option off, the emulation returns to normal mode.
 357 ETEXI
 358
 359     {
 360         .name       = "stop",
 361         .args_type  = "",
 362         .params     = "",
 363         .help       = "stop emulation",
 364         .user_print = monitor_user_noop,
 365         .mhandler.cmd_new = do_stop,
 366     },
 367
 368 STEXI
 369 @item stop
 370 @findex stop
 371 Stop emulation.
 372 ETEXI
 373 SQMP
 374 stop
 375 ----
 376
 377 Stop the emulator.
 378
 379 Arguments: None.
 380
 381 Example:
 382
 383 -> { "execute": "stop" }
 384 <- { "return": {} }
 385
 386 EQMP
 387
 388     {
 389         .name       = "c|cont",
 390         .args_type  = "",
 391         .params     = "",
 392         .help       = "resume emulation",
 393         .user_print = monitor_user_noop,
 394         .mhandler.cmd_new = do_cont,
 395     },
 396
 397 STEXI
 398 @item c or cont
 399 @findex cont
 400 Resume emulation.
 401 ETEXI
 402 SQMP
 403 cont
 404 ----
 405
 406 Resume emulation.
 407
 408 Arguments: None.
 409
 410 Example:
 411
 412 -> { "execute": "cont" }
 413 <- { "return": {} }
 414
 415 EQMP
 416
 417     {
 418         .name       = "gdbserver",
 419         .args_type  = "device:s?",
 420         .params     = "[device]",
 421         .help       = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
 422         .mhandler.cmd = do_gdbserver,
 423     },
 424
 425 STEXI
 426 @item gdbserver [@var{port}]
 427 @findex gdbserver
 428 Start gdbserver session (default @var{port}=1234)
 429 ETEXI
 430
 431     {
 432         .name       = "x",
 433         .args_type  = "fmt:/,addr:l",
 434         .params     = "/fmt addr",
 435         .help       = "virtual memory dump starting at 'addr'",
 436         .mhandler.cmd = do_memory_dump,
 437     },
 438
 439 STEXI
 440 @item x/fmt @var{addr}
 441 @findex x
 442 Virtual memory dump starting at @var{addr}.
 443 ETEXI
 444
 445     {
 446         .name       = "xp",
 447         .args_type  = "fmt:/,addr:l",
 448         .params     = "/fmt addr",
 449         .help       = "physical memory dump starting at 'addr'",
 450         .mhandler.cmd = do_physical_memory_dump,
 451     },
 452
 453 STEXI
 454 @item xp /@var{fmt} @var{addr}
 455 @findex xp
 456 Physical memory dump starting at @var{addr}.
 457
 458 @var{fmt} is a format which tells the command how to format the
 459 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
 460
 461 @table @var
 462 @item count
 463 is the number of items to be dumped.
 464
 465 @item format
 466 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
 467 c (char) or i (asm instruction).
 468
 469 @item size
 470 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
 471 @code{h} or @code{w} can be specified with the @code{i} format to
 472 respectively select 16 or 32 bit code instruction size.
 473
 474 @end table
 475
 476 Examples:
 477 @itemize
 478 @item
 479 Dump 10 instructions at the current instruction pointer:
 480 @example
 481 (qemu) x/10i $eip
 482 0x90107063:  ret
 483 0x90107064:  sti
 484 0x90107065:  lea    0x0(%esi,1),%esi
 485 0x90107069:  lea    0x0(%edi,1),%edi
 486 0x90107070:  ret
 487 0x90107071:  jmp    0x90107080
 488 0x90107073:  nop
 489 0x90107074:  nop
 490 0x90107075:  nop
 491 0x90107076:  nop
 492 @end example
 493
 494 @item
 495 Dump 80 16 bit values at the start of the video memory.
 496 @smallexample
 497 (qemu) xp/80hx 0xb8000
 498 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
 499 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
 500 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
 501 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
 502 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
 503 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
 504 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
 505 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
 506 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
 507 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
 508 @end smallexample
 509 @end itemize
 510 ETEXI
 511
 512     {
 513         .name       = "p|print",
 514         .args_type  = "fmt:/,val:l",
 515         .params     = "/fmt expr",
 516         .help       = "print expression value (use $reg for CPU register access)",
 517         .mhandler.cmd = do_print,
 518     },
 519
 520 STEXI
 521 @item p or print/@var{fmt} @var{expr}
 522 @findex print
 523
 524 Print expression value. Only the @var{format} part of @var{fmt} is
 525 used.
 526 ETEXI
 527
 528     {
 529         .name       = "i",
 530         .args_type  = "fmt:/,addr:i,index:i.",
 531         .params     = "/fmt addr",
 532         .help       = "I/O port read",
 533         .mhandler.cmd = do_ioport_read,
 534     },
 535
 536 STEXI
 537 Read I/O port.
 538 ETEXI
 539
 540     {
 541         .name       = "o",
 542         .args_type  = "fmt:/,addr:i,val:i",
 543         .params     = "/fmt addr value",
 544         .help       = "I/O port write",
 545         .mhandler.cmd = do_ioport_write,
 546     },
 547
 548 STEXI
 549 Write to I/O port.
 550 ETEXI
 551
 552     {
 553         .name       = "sendkey",
 554         .args_type  = "string:s,hold_time:i?",
 555         .params     = "keys [hold_ms]",
 556         .help       = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
 557         .mhandler.cmd = do_sendkey,
 558     },
 559
 560 STEXI
 561 @item sendkey @var{keys}
 562 @findex sendkey
 563
 564 Send @var{keys} to the emulator. @var{keys} could be the name of the
 565 key or @code{#} followed by the raw value in either decimal or hexadecimal
 566 format. Use @code{-} to press several keys simultaneously. Example:
 567 @example
 568 sendkey ctrl-alt-f1
 569 @end example
 570
 571 This command is useful to send keys that your graphical user interface
 572 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
 573 ETEXI
 574
 575     {
 576         .name       = "system_reset",
 577         .args_type  = "",
 578         .params     = "",
 579         .help       = "reset the system",
 580         .user_print = monitor_user_noop,
 581         .mhandler.cmd_new = do_system_reset,
 582     },
 583
 584 STEXI
 585 @item system_reset
 586 @findex system_reset
 587
 588 Reset the system.
 589 ETEXI
 590 SQMP
 591 system_reset
 592 ------------
 593
 594 Reset the system.
 595
 596 Arguments: None.
 597
 598 Example:
 599
 600 -> { "execute": "system_reset" }
 601 <- { "return": {} }
 602
 603 EQMP
 604
 605     {
 606         .name       = "system_powerdown",
 607         .args_type  = "",
 608         .params     = "",
 609         .help       = "send system power down event",
 610         .user_print = monitor_user_noop,
 611         .mhandler.cmd_new = do_system_powerdown,
 612     },
 613
 614 STEXI
 615 @item system_powerdown
 616 @findex system_powerdown
 617
 618 Power down the system (if supported).
 619 ETEXI
 620 SQMP
 621 system_powerdown
 622 ----------------
 623
 624 Send system power down event.
 625
 626 Arguments: None.
 627
 628 Example:
 629
 630 -> { "execute": "system_powerdown" }
 631 <- { "return": {} }
 632
 633 EQMP
 634
 635     {
 636         .name       = "sum",
 637         .args_type  = "start:i,size:i",
 638         .params     = "addr size",
 639         .help       = "compute the checksum of a memory region",
 640         .mhandler.cmd = do_sum,
 641     },
 642
 643 STEXI
 644 @item sum @var{addr} @var{size}
 645 @findex sum
 646
 647 Compute the checksum of a memory region.
 648 ETEXI
 649
 650     {
 651         .name       = "usb_add",
 652         .args_type  = "devname:s",
 653         .params     = "device",
 654         .help       = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
 655         .mhandler.cmd = do_usb_add,
 656     },
 657
 658 STEXI
 659 @item usb_add @var{devname}
 660 @findex usb_add
 661
 662 Add the USB device @var{devname}.  For details of available devices see
 663 @ref{usb_devices}
 664 ETEXI
 665
 666     {
 667         .name       = "usb_del",
 668         .args_type  = "devname:s",
 669         .params     = "device",
 670         .help       = "remove USB device 'bus.addr'",
 671         .mhandler.cmd = do_usb_del,
 672     },
 673
 674 STEXI
 675 @item usb_del @var{devname}
 676 @findex usb_del
 677
 678 Remove the USB device @var{devname} from the QEMU virtual USB
 679 hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
 680 command @code{info usb} to see the devices you can remove.
 681 ETEXI
 682
 683     {
 684         .name       = "device_add",
 685         .args_type  = "device:O",
 686         .params     = "driver[,prop=value][,...]",
 687         .help       = "add device, like -device on the command line",
 688         .user_print = monitor_user_noop,
 689         .mhandler.cmd_new = do_device_add,
 690     },
 691
 692 STEXI
 693 @item device_add @var{config}
 694 @findex device_add
 695
 696 Add device.
 697 ETEXI
 698 SQMP
 699 device_add
 700 ----------
 701
 702 Add a device.
 703
 704 Arguments:
 705
 706 - "driver": the name of the new device's driver (json-string)
 707 - "bus": the device's parent bus (device tree path, json-string, optional)
 708 - "id": the device's ID, must be unique (json-string)
 709 - device properties
 710
 711 Example:
 712
 713 -> { "execute": "device_add", "arguments": { "driver": "e1000", "id": "net1" } }
 714 <- { "return": {} }
 715
 716 Notes:
 717
 718 (1) For detailed information about this command, please refer to the
 719     'docs/qdev-device-use.txt' file.
 720
 721 (2) It's possible to list device properties by running QEMU with the
 722     "-device DEVICE,\?" command-line argument, where DEVICE is the device's name
 723
 724 EQMP
 725
 726     {
 727         .name       = "device_del",
 728         .args_type  = "id:s",
 729         .params     = "device",
 730         .help       = "remove device",
 731         .user_print = monitor_user_noop,
 732         .mhandler.cmd_new = do_device_del,
 733     },
 734
 735 STEXI
 736 @item device_del @var{id}
 737 @findex device_del
 738
 739 Remove device @var{id}.
 740 ETEXI
 741 SQMP
 742 device_del
 743 ----------
 744
 745 Remove a device.
 746
 747 Arguments:
 748
 749 - "id": the device's ID (json-string)
 750
 751 Example:
 752
 753 -> { "execute": "device_del", "arguments": { "id": "net1" } }
 754 <- { "return": {} }
 755
 756 EQMP
 757
 758     {
 759         .name       = "cpu",
 760         .args_type  = "index:i",
 761         .params     = "index",
 762         .help       = "set the default CPU",
 763         .user_print = monitor_user_noop,
 764         .mhandler.cmd_new = do_cpu_set,
 765     },
 766
 767 STEXI
 768 @item cpu @var{index}
 769 @findex cpu
 770 Set the default CPU.
 771 ETEXI
 772 SQMP
 773 cpu
 774 ---
 775
 776 Set the default CPU.
 777
 778 Arguments:
 779
 780 - "index": the CPU's index (json-int)
 781
 782 Example:
 783
 784 -> { "execute": "cpu", "arguments": { "index": 0 } }
 785 <- { "return": {} }
 786
 787 Note: CPUs' indexes are obtained with the 'query-cpus' command.
 788
 789 EQMP
 790
 791     {
 792         .name       = "mouse_move",
 793         .args_type  = "dx_str:s,dy_str:s,dz_str:s?",
 794         .params     = "dx dy [dz]",
 795         .help       = "send mouse move events",
 796         .mhandler.cmd = do_mouse_move,
 797     },
 798
 799 STEXI
 800 @item mouse_move @var{dx} @var{dy} [@var{dz}]
 801 @findex mouse_move
 802 Move the active mouse to the specified coordinates @var{dx} @var{dy}
 803 with optional scroll axis @var{dz}.
 804 ETEXI
 805
 806     {
 807         .name       = "mouse_button",
 808         .args_type  = "button_state:i",
 809         .params     = "state",
 810         .help       = "change mouse button state (1=L, 2=M, 4=R)",
 811         .mhandler.cmd = do_mouse_button,
 812     },
 813
 814 STEXI
 815 @item mouse_button @var{val}
 816 @findex mouse_button
 817 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
 818 ETEXI
 819
 820     {
 821         .name       = "mouse_set",
 822         .args_type  = "index:i",
 823         .params     = "index",
 824         .help       = "set which mouse device receives events",
 825         .mhandler.cmd = do_mouse_set,
 826     },
 827
 828 STEXI
 829 @item mouse_set @var{index}
 830 @findex mouse_set
 831 Set which mouse device receives events at given @var{index}, index
 832 can be obtained with
 833 @example
 834 info mice
 835 @end example
 836 ETEXI
 837
 838 #ifdef HAS_AUDIO
 839     {
 840         .name       = "wavcapture",
 841         .args_type  = "path:F,freq:i?,bits:i?,nchannels:i?",
 842         .params     = "path [frequency [bits [channels]]]",
 843         .help       = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
 844         .mhandler.cmd = do_wav_capture,
 845     },
 846 #endif
 847 STEXI
 848 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
 849 @findex wavcapture
 850 Capture audio into @var{filename}. Using sample rate @var{frequency}
 851 bits per sample @var{bits} and number of channels @var{channels}.
 852
 853 Defaults:
 854 @itemize @minus
 855 @item Sample rate = 44100 Hz - CD quality
 856 @item Bits = 16
 857 @item Number of channels = 2 - Stereo
 858 @end itemize
 859 ETEXI
 860
 861 #ifdef HAS_AUDIO
 862     {
 863         .name       = "stopcapture",
 864         .args_type  = "n:i",
 865         .params     = "capture index",
 866         .help       = "stop capture",
 867         .mhandler.cmd = do_stop_capture,
 868     },
 869 #endif
 870 STEXI
 871 @item stopcapture @var{index}
 872 @findex stopcapture
 873 Stop capture with a given @var{index}, index can be obtained with
 874 @example
 875 info capture
 876 @end example
 877 ETEXI
 878
 879     {
 880         .name       = "memsave",
 881         .args_type  = "val:l,size:i,filename:s",
 882         .params     = "addr size file",
 883         .help       = "save to disk virtual memory dump starting at 'addr' of size 'size'",
 884         .user_print = monitor_user_noop,
 885         .mhandler.cmd_new = do_memory_save,
 886     },
 887
 888 STEXI
 889 @item memsave @var{addr} @var{size} @var{file}
 890 @findex memsave
 891 save to disk virtual memory dump starting at @var{addr} of size @var{size}.
 892 ETEXI
 893 SQMP
 894 memsave
 895 -------
 896
 897 Save to disk virtual memory dump starting at 'val' of size 'size'.
 898
 899 Arguments:
 900
 901 - "val": the starting address (json-int)
 902 - "size": the memory size, in bytes (json-int)
 903 - "filename": file path (json-string)
 904
 905 Example:
 906
 907 -> { "execute": "memsave",
 908              "arguments": { "val": 10,
 909                             "size": 100,
 910                             "filename": "/tmp/virtual-mem-dump" } }
 911 <- { "return": {} }
 912
 913 Note: Depends on the current CPU.
 914
 915 EQMP
 916
 917     {
 918         .name       = "pmemsave",
 919         .args_type  = "val:l,size:i,filename:s",
 920         .params     = "addr size file",
 921         .help       = "save to disk physical memory dump starting at 'addr' of size 'size'",
 922         .user_print = monitor_user_noop,
 923         .mhandler.cmd_new = do_physical_memory_save,
 924     },
 925
 926 STEXI
 927 @item pmemsave @var{addr} @var{size} @var{file}
 928 @findex pmemsave
 929 save to disk physical memory dump starting at @var{addr} of size @var{size}.
 930 ETEXI
 931 SQMP
 932 pmemsave
 933 --------
 934
 935 Save to disk physical memory dump starting at 'val' of size 'size'.
 936
 937 Arguments:
 938
 939 - "val": the starting address (json-int)
 940 - "size": the memory size, in bytes (json-int)
 941 - "filename": file path (json-string)
 942
 943 Example:
 944
 945 -> { "execute": "pmemsave",
 946              "arguments": { "val": 10,
 947                             "size": 100,
 948                             "filename": "/tmp/physical-mem-dump" } }
 949 <- { "return": {} }
 950
 951 EQMP
 952
 953     {
 954         .name       = "boot_set",
 955         .args_type  = "bootdevice:s",
 956         .params     = "bootdevice",
 957         .help       = "define new values for the boot device list",
 958         .mhandler.cmd = do_boot_set,
 959     },
 960
 961 STEXI
 962 @item boot_set @var{bootdevicelist}
 963 @findex boot_set
 964
 965 Define new values for the boot device list. Those values will override
 966 the values specified on the command line through the @code{-boot} option.
 967
 968 The values that can be specified here depend on the machine type, but are
 969 the same that can be specified in the @code{-boot} command line option.
 970 ETEXI
 971
 972 #if defined(TARGET_I386)
 973     {
 974         .name       = "nmi",
 975         .args_type  = "cpu_index:i",
 976         .params     = "cpu",
 977         .help       = "inject an NMI on the given CPU",
 978         .mhandler.cmd = do_inject_nmi,
 979     },
 980 #endif
 981 STEXI
 982 @item nmi @var{cpu}
 983 @findex nmi
 984 Inject an NMI on the given CPU (x86 only).
 985 ETEXI
 986
 987     {
 988         .name       = "migrate",
 989         .args_type  = "detach:-d,blk:-b,inc:-i,uri:s",
 990         .params     = "[-d] [-b] [-i] uri",
 991         .help       = "migrate to URI (using -d to not wait for completion)"
 992                       "\n\t\t\t -b for migration without shared storage with"
 993                       " full copy of disk\n\t\t\t -i for migration without "
 994                       "shared storage with incremental copy of disk "
 995                       "(base image shared between src and destination)",
 996         .user_print = monitor_user_noop,
 997         .mhandler.cmd_new = do_migrate,
 998     },
 999
1000
1001 STEXI
1002 @item migrate [-d] [-b] [-i] @var{uri}
1003 @findex migrate
1004 Migrate to @var{uri} (using -d to not wait for completion).
1005         -b for migration with full copy of disk
1006         -i for migration with incremental copy of disk (base image is shared)
1007 ETEXI
1008 SQMP
1009 migrate
1010 -------
1011
1012 Migrate to URI.
1013
1014 Arguments:
1015
1016 - "blk": block migration, full disk copy (json-bool, optional)
1017 - "inc": incremental disk copy (json-bool, optional)
1018 - "uri": Destination URI (json-string)
1019
1020 Example:
1021
1022 -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
1023 <- { "return": {} }
1024
1025 Notes:
1026
1027 (1) The 'query-migrate' command should be used to check migration's progress
1028     and final result (this information is provided by the 'status' member)
1029 (2) All boolean arguments default to false
1030 (3) The user Monitor's "detach" argument is invalid in QMP and should not
1031     be used
1032
1033 EQMP
1034
1035     {
1036         .name       = "migrate_cancel",
1037         .args_type  = "",
1038         .params     = "",
1039         .help       = "cancel the current VM migration",
1040         .user_print = monitor_user_noop,
1041         .mhandler.cmd_new = do_migrate_cancel,
1042     },
1043
1044 STEXI
1045 @item migrate_cancel
1046 @findex migrate_cancel
1047 Cancel the current VM migration.
1048 ETEXI
1049 SQMP
1050 migrate_cancel
1051 --------------
1052
1053 Cancel the current migration.
1054
1055 Arguments: None.
1056
1057 Example:
1058
1059 -> { "execute": "migrate_cancel" }
1060 <- { "return": {} }
1061
1062 EQMP
1063
1064     {
1065         .name       = "migrate_set_speed",
1066         .args_type  = "value:f",
1067         .params     = "value",
1068         .help       = "set maximum speed (in bytes) for migrations",
1069         .user_print = monitor_user_noop,
1070         .mhandler.cmd_new = do_migrate_set_speed,
1071     },
1072
1073 STEXI
1074 @item migrate_set_speed @var{value}
1075 @findex migrate_set_speed
1076 Set maximum speed to @var{value} (in bytes) for migrations.
1077 ETEXI
1078 SQMP
1079 migrate_set_speed
1080 -----------------
1081
1082 Set maximum speed for migrations.
1083
1084 Arguments:
1085
1086 - "value": maximum speed, in bytes per second (json-number)
1087
1088 Example:
1089
1090 -> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } }
1091 <- { "return": {} }
1092
1093 EQMP
1094
1095     {
1096         .name       = "migrate_set_downtime",
1097         .args_type  = "value:T",
1098         .params     = "value",
1099         .help       = "set maximum tolerated downtime (in seconds) for migrations",
1100         .user_print = monitor_user_noop,
1101         .mhandler.cmd_new = do_migrate_set_downtime,
1102     },
1103
1104 STEXI
1105 @item migrate_set_downtime @var{second}
1106 @findex migrate_set_downtime
1107 Set maximum tolerated downtime (in seconds) for migration.
1108 ETEXI
1109 SQMP
1110 migrate_set_downtime
1111 --------------------
1112
1113 Set maximum tolerated downtime (in seconds) for migrations.
1114
1115 Arguments:
1116
1117 - "value": maximum downtime (json-number)
1118
1119 Example:
1120
1121 -> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } }
1122 <- { "return": {} }
1123
1124 EQMP
1125
1126 #if defined(TARGET_I386)
1127     {
1128         .name       = "drive_add",
1129         .args_type  = "pci_addr:s,opts:s",
1130         .params     = "[[<domain>:]<bus>:]<slot>\n"
1131                       "[file=file][,if=type][,bus=n]\n"
1132                       "[,unit=m][,media=d][index=i]\n"
1133                       "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
1134                       "[snapshot=on|off][,cache=on|off]",
1135         .help       = "add drive to PCI storage controller",
1136         .mhandler.cmd = drive_hot_add,
1137     },
1138 #endif
1139
1140 STEXI
1141 @item drive_add
1142 @findex drive_add
1143 Add drive to PCI storage controller.
1144 ETEXI
1145
1146 #if defined(TARGET_I386)
1147     {
1148         .name       = "pci_add",
1149         .args_type  = "pci_addr:s,type:s,opts:s?",
1150         .params     = "auto|[[<domain>:]<bus>:]<slot> nic|storage|host [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]... [host=02:00.0[,name=string][,dma=none]",
1151         .help       = "hot-add PCI device",
1152         .mhandler.cmd = pci_device_hot_add,
1153     },
1154 #endif
1155
1156 STEXI
1157 @item pci_add
1158 @findex pci_add
1159 Hot-add PCI device.
1160 ETEXI
1161
1162 #if defined(TARGET_I386)
1163     {
1164         .name       = "pci_del",
1165         .args_type  = "pci_addr:s",
1166         .params     = "[[<domain>:]<bus>:]<slot>",
1167         .help       = "hot remove PCI device",
1168         .mhandler.cmd = do_pci_device_hot_remove,
1169     },
1170 #endif
1171
1172 STEXI
1173 @item pci_del
1174 @findex pci_del
1175 Hot remove PCI device.
1176 ETEXI
1177
1178     {
1179         .name       = "host_net_add",
1180         .args_type  = "device:s,opts:s?",
1181         .params     = "tap|user|socket|vde|dump [options]",
1182         .help       = "add host VLAN client",
1183         .mhandler.cmd = net_host_device_add,
1184     },
1185
1186 STEXI
1187 @item host_net_add
1188 @findex host_net_add
1189 Add host VLAN client.
1190 ETEXI
1191
1192     {
1193         .name       = "host_net_remove",
1194         .args_type  = "vlan_id:i,device:s",
1195         .params     = "vlan_id name",
1196         .help       = "remove host VLAN client",
1197         .mhandler.cmd = net_host_device_remove,
1198     },
1199
1200 STEXI
1201 @item host_net_remove
1202 @findex host_net_remove
1203 Remove host VLAN client.
1204 ETEXI
1205
1206     {
1207         .name       = "netdev_add",
1208         .args_type  = "netdev:O",
1209         .params     = "[user|tap|socket],id=str[,prop=value][,...]",
1210         .help       = "add host network device",
1211         .user_print = monitor_user_noop,
1212         .mhandler.cmd_new = do_netdev_add,
1213     },
1214
1215 STEXI
1216 @item netdev_add
1217 @findex netdev_add
1218 Add host network device.
1219 ETEXI
1220 SQMP
1221 netdev_add
1222 ----------
1223
1224 Add host network device.
1225
1226 Arguments:
1227
1228 - "type": the device type, "tap", "user", ... (json-string)
1229 - "id": the device's ID, must be unique (json-string)
1230 - device options
1231
1232 Example:
1233
1234 -> { "execute": "netdev_add", "arguments": { "type": "user", "id": "netdev1" } }
1235 <- { "return": {} }
1236
1237 Note: The supported device options are the same ones supported by the '-net'
1238       command-line argument, which are listed in the '-help' output or QEMU's
1239       manual
1240
1241 EQMP
1242
1243     {
1244         .name       = "netdev_del",
1245         .args_type  = "id:s",
1246         .params     = "id",
1247         .help       = "remove host network device",
1248         .user_print = monitor_user_noop,
1249         .mhandler.cmd_new = do_netdev_del,
1250     },
1251
1252 STEXI
1253 @item netdev_del
1254 @findex netdev_del
1255 Remove host network device.
1256 ETEXI
1257 SQMP
1258 netdev_del
1259 ----------
1260
1261 Remove host network device.
1262
1263 Arguments:
1264
1265 - "id": the device's ID, must be unique (json-string)
1266
1267 Example:
1268
1269 -> { "execute": "netdev_del", "arguments": { "id": "netdev1" } }
1270 <- { "return": {} }
1271
1272 EQMP
1273
1274 #ifdef CONFIG_SLIRP
1275     {
1276         .name       = "hostfwd_add",
1277         .args_type  = "arg1:s,arg2:s?,arg3:s?",
1278         .params     = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1279         .help       = "redirect TCP or UDP connections from host to guest (requires -net user)",
1280         .mhandler.cmd = net_slirp_hostfwd_add,
1281     },
1282 #endif
1283 STEXI
1284 @item hostfwd_add
1285 @findex hostfwd_add
1286 Redirect TCP or UDP connections from host to guest (requires -net user).
1287 ETEXI
1288
1289 #ifdef CONFIG_SLIRP
1290     {
1291         .name       = "hostfwd_remove",
1292         .args_type  = "arg1:s,arg2:s?,arg3:s?",
1293         .params     = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1294         .help       = "remove host-to-guest TCP or UDP redirection",
1295         .mhandler.cmd = net_slirp_hostfwd_remove,
1296     },
1297
1298 #endif
1299 STEXI
1300 @item hostfwd_remove
1301 @findex hostfwd_remove
1302 Remove host-to-guest TCP or UDP redirection.
1303 ETEXI
1304
1305     {
1306         .name       = "balloon",
1307         .args_type  = "value:M",
1308         .params     = "target",
1309         .help       = "request VM to change its memory allocation (in MB)",
1310         .user_print = monitor_user_noop,
1311         .mhandler.cmd_async = do_balloon,
1312         .flags      = MONITOR_CMD_ASYNC,
1313     },
1314
1315 STEXI
1316 @item balloon @var{value}
1317 @findex balloon
1318 Request VM to change its memory allocation to @var{value} (in MB).
1319 ETEXI
1320 SQMP
1321 balloon
1322 -------
1323
1324 Request VM to change its memory allocation (in bytes).
1325
1326 Arguments:
1327
1328 - "value": New memory allocation (json-int)
1329
1330 Example:
1331
1332 -> { "execute": "balloon", "arguments": { "value": 536870912 } }
1333 <- { "return": {} }
1334
1335 EQMP
1336
1337     {
1338         .name       = "set_link",
1339         .args_type  = "name:s,up:b",
1340         .params     = "name on|off",
1341         .help       = "change the link status of a network adapter",
1342         .user_print = monitor_user_noop,
1343         .mhandler.cmd_new = do_set_link,
1344     },
1345
1346 STEXI
1347 @item set_link @var{name} [on|off]
1348 @findex set_link
1349 Switch link @var{name} on (i.e. up) or off (i.e. down).
1350 ETEXI
1351 SQMP
1352 set_link
1353 --------
1354
1355 Change the link status of a network adapter.
1356
1357 Arguments:
1358
1359 - "name": network device name (json-string)
1360 - "up": status is up (json-bool)
1361
1362 Example:
1363
1364 -> { "execute": "set_link", "arguments": { "name": "e1000.0", "up": false } }
1365 <- { "return": {} }
1366
1367 EQMP
1368
1369     {
1370         .name       = "watchdog_action",
1371         .args_type  = "action:s",
1372         .params     = "[reset|shutdown|poweroff|pause|debug|none]",
1373         .help       = "change watchdog action",
1374         .mhandler.cmd = do_watchdog_action,
1375     },
1376
1377 STEXI
1378 @item watchdog_action
1379 @findex watchdog_action
1380 Change watchdog action.
1381 ETEXI
1382
1383     {
1384         .name       = "acl_show",
1385         .args_type  = "aclname:s",
1386         .params     = "aclname",
1387         .help       = "list rules in the access control list",
1388         .mhandler.cmd = do_acl_show,
1389     },
1390
1391 STEXI
1392 @item acl_show @var{aclname}
1393 @findex acl_show
1394 List all the matching rules in the access control list, and the default
1395 policy. There are currently two named access control lists,
1396 @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1397 certificate distinguished name, and SASL username respectively.
1398 ETEXI
1399
1400     {
1401         .name       = "acl_policy",
1402         .args_type  = "aclname:s,policy:s",
1403         .params     = "aclname allow|deny",
1404         .help       = "set default access control list policy",
1405         .mhandler.cmd = do_acl_policy,
1406     },
1407
1408 STEXI
1409 @item acl_policy @var{aclname} @code{allow|deny}
1410 @findex acl_policy
1411 Set the default access control list policy, used in the event that
1412 none of the explicit rules match. The default policy at startup is
1413 always @code{deny}.
1414 ETEXI
1415
1416     {
1417         .name       = "acl_add",
1418         .args_type  = "aclname:s,match:s,policy:s,index:i?",
1419         .params     = "aclname match allow|deny [index]",
1420         .help       = "add a match rule to the access control list",
1421         .mhandler.cmd = do_acl_add,
1422     },
1423
1424 STEXI
1425 @item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1426 @findex acl_add
1427 Add a match rule to the access control list, allowing or denying access.
1428 The match will normally be an exact username or x509 distinguished name,
1429 but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1430 allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
1431 normally be appended to the end of the ACL, but can be inserted
1432 earlier in the list if the optional @var{index} parameter is supplied.
1433 ETEXI
1434
1435     {
1436         .name       = "acl_remove",
1437         .args_type  = "aclname:s,match:s",
1438         .params     = "aclname match",
1439         .help       = "remove a match rule from the access control list",
1440         .mhandler.cmd = do_acl_remove,
1441     },
1442
1443 STEXI
1444 @item acl_remove @var{aclname} @var{match}
1445 @findex acl_remove
1446 Remove the specified match rule from the access control list.
1447 ETEXI
1448
1449     {
1450         .name       = "acl_reset",
1451         .args_type  = "aclname:s",
1452         .params     = "aclname",
1453         .help       = "reset the access control list",
1454         .mhandler.cmd = do_acl_reset,
1455     },
1456
1457 STEXI
1458 @item acl_reset @var{aclname}
1459 @findex acl_reset
1460 Remove all matches from the access control list, and set the default
1461 policy back to @code{deny}.
1462 ETEXI
1463
1464 #if defined(TARGET_I386)
1465
1466     {
1467         .name       = "mce",
1468         .args_type  = "cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1469         .params     = "cpu bank status mcgstatus addr misc",
1470         .help       = "inject a MCE on the given CPU",
1471         .mhandler.cmd = do_inject_mce,
1472     },
1473
1474 #endif
1475 STEXI
1476 @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1477 @findex mce (x86)
1478 Inject an MCE on the given CPU (x86 only).
1479 ETEXI
1480
1481     {
1482         .name       = "getfd",
1483         .args_type  = "fdname:s",
1484         .params     = "getfd name",
1485         .help       = "receive a file descriptor via SCM rights and assign it a name",
1486         .user_print = monitor_user_noop,
1487         .mhandler.cmd_new = do_getfd,
1488     },
1489
1490 STEXI
1491 @item getfd @var{fdname}
1492 @findex getfd
1493 If a file descriptor is passed alongside this command using the SCM_RIGHTS
1494 mechanism on unix sockets, it is stored using the name @var{fdname} for
1495 later use by other monitor commands.
1496 ETEXI
1497 SQMP
1498 getfd
1499 -----
1500
1501 Receive a file descriptor via SCM rights and assign it a name.
1502
1503 Arguments:
1504
1505 - "fdname": file descriptor name (json-string)
1506
1507 Example:
1508
1509 -> { "execute": "getfd", "arguments": { "fdname": "fd1" } }
1510 <- { "return": {} }
1511
1512 EQMP
1513
1514     {
1515         .name       = "closefd",
1516         .args_type  = "fdname:s",
1517         .params     = "closefd name",
1518         .help       = "close a file descriptor previously passed via SCM rights",
1519         .user_print = monitor_user_noop,
1520         .mhandler.cmd_new = do_closefd,
1521     },
1522
1523 STEXI
1524 @item closefd @var{fdname}
1525 @findex closefd
1526 Close the file descriptor previously assigned to @var{fdname} using the
1527 @code{getfd} command. This is only needed if the file descriptor was never
1528 used by another monitor command.
1529 ETEXI
1530 SQMP
1531 closefd
1532 -------
1533
1534 Close a file descriptor previously passed via SCM rights.
1535
1536 Arguments:
1537
1538 - "fdname": file descriptor name (json-string)
1539
1540 Example:
1541
1542 -> { "execute": "closefd", "arguments": { "fdname": "fd1" } }
1543 <- { "return": {} }
1544
1545 EQMP
1546
1547     {
1548         .name       = "block_passwd",
1549         .args_type  = "device:B,password:s",
1550         .params     = "block_passwd device password",
1551         .help       = "set the password of encrypted block devices",
1552         .user_print = monitor_user_noop,
1553         .mhandler.cmd_new = do_block_set_passwd,
1554     },
1555
1556 STEXI
1557 @item block_passwd @var{device} @var{password}
1558 @findex block_passwd
1559 Set the encrypted device @var{device} password to @var{password}
1560 ETEXI
1561 SQMP
1562 block_passwd
1563 ------------
1564
1565 Set the password of encrypted block devices.
1566
1567 Arguments:
1568
1569 - "device": device name (json-string)
1570 - "password": password (json-string)
1571
1572 Example:
1573
1574 -> { "execute": "block_passwd", "arguments": { "device": "ide0-hd0",
1575                                                "password": "12345" } }
1576 <- { "return": {} }
1577
1578 EQMP
1579
1580     {
1581         .name       = "cpu_set",
1582         .args_type  = "cpu:i,state:s",
1583         .params     = "cpu [online|offline]",
1584         .help       = "change cpu state",
1585         .mhandler.cmd  = do_cpu_set_nr,
1586     },
1587
1588 STEXI
1589 @item cpu_set @var{cpu} [online|offline]
1590 Set CPU @var{cpu} online or offline.
1591 ETEXI
1592
1593     {
1594         .name       = "qmp_capabilities",
1595         .args_type  = "",
1596         .params     = "",
1597         .help       = "enable QMP capabilities",
1598         .user_print = monitor_user_noop,
1599         .mhandler.cmd_new = do_qmp_capabilities,
1600     },
1601
1602 STEXI
1603 @item qmp_capabilities
1604 @findex qmp_capabilities
1605 Enable the specified QMP capabilities
1606 ETEXI
1607 SQMP
1608 qmp_capabilities
1609 ----------------
1610
1611 Enable QMP capabilities.
1612
1613 Arguments: None.
1614
1615 Example:
1616
1617 -> { "execute": "qmp_capabilities" }
1618 <- { "return": {} }
1619
1620 Note: This command must be issued before issuing any other command.
1621
1622 EQMP
1623
1624
1625 HXCOMM Keep the 'info' command at the end!
1626 HXCOMM This is required for the QMP documentation layout.
1627
1628 SQMP
1629
1630 3. Query Commands
1631 =================
1632
1633 EQMP
1634
1635     {
1636         .name       = "info",
1637         .args_type  = "item:s?",
1638         .params     = "[subcommand]",
1639         .help       = "show various information about the system state",
1640         .user_print = monitor_user_noop,
1641         .mhandler.cmd_new = do_info,
1642     },
1643
1644 STEXI
1645 @item info @var{subcommand}
1646 @findex info
1647 Show various information about the system state.
1648
1649 @table @option
1650 @item info version
1651 show the version of QEMU
1652 ETEXI
1653 SQMP
1654 query-version
1655 -------------
1656
1657 Show QEMU version.
1658
1659 Return a json-object with the following information:
1660
1661 - "qemu": A json-object containing three integer values:
1662     - "major": QEMU's major version (json-int)
1663     - "minor": QEMU's minor version (json-int)
1664     - "micro": QEMU's micro version (json-int)
1665 - "package": package's version (json-string)
1666
1667 Example:
1668
1669 -> { "execute": "query-version" }
1670 <- {
1671       "return":{
1672          "qemu":{
1673             "major":0,
1674             "minor":11,
1675             "micro":5
1676          },
1677          "package":""
1678       }
1679    }
1680
1681 EQMP
1682
1683 STEXI
1684 @item info commands
1685 list QMP available commands
1686 ETEXI
1687 SQMP
1688 query-commands
1689 --------------
1690
1691 List QMP available commands.
1692
1693 Each command is represented by a json-object, the returned value is a json-array
1694 of all commands.
1695
1696 Each json-object contain:
1697
1698 - "name": command's name (json-string)
1699
1700 Example:
1701
1702 -> { "execute": "query-commands" }
1703 <- {
1704       "return":[
1705          {
1706             "name":"query-balloon"
1707          },
1708          {
1709             "name":"system_powerdown"
1710          }
1711       ]
1712    }
1713
1714 Note: This example has been shortened as the real response is too long.
1715
1716 EQMP
1717
1718 STEXI
1719 @item info network
1720 show the various VLANs and the associated devices
1721 ETEXI
1722
1723 STEXI
1724 @item info chardev
1725 show the character devices
1726 ETEXI
1727 SQMP
1728 query-chardev
1729 -------------
1730
1731 Each device is represented by a json-object. The returned value is a json-array
1732 of all devices.
1733
1734 Each json-object contain the following:
1735
1736 - "label": device's label (json-string)
1737 - "filename": device's file (json-string)
1738
1739 Example:
1740
1741 -> { "execute": "query-chardev" }
1742 <- {
1743       "return":[
1744          {
1745             "label":"monitor",
1746             "filename":"stdio"
1747          },
1748          {
1749             "label":"serial0",
1750             "filename":"vc"
1751          }
1752       ]
1753    }
1754
1755 EQMP
1756
1757 STEXI
1758 @item info block
1759 show the block devices
1760 ETEXI
1761 SQMP
1762 query-block
1763 -----------
1764
1765 Show the block devices.
1766
1767 Each block device information is stored in a json-object and the returned value
1768 is a json-array of all devices.
1769
1770 Each json-object contain the following:
1771
1772 - "device": device name (json-string)
1773 - "type": device type (json-string)
1774          - Possible values: "hd", "cdrom", "floppy", "unknown"
1775 - "removable": true if the device is removable, false otherwise (json-bool)
1776 - "locked": true if the device is locked, false otherwise (json-bool)
1777 - "inserted": only present if the device is inserted, it is a json-object
1778    containing the following:
1779          - "file": device file name (json-string)
1780          - "ro": true if read-only, false otherwise (json-bool)
1781          - "drv": driver format name (json-string)
1782              - Possible values: "blkdebug", "bochs", "cloop", "cow", "dmg",
1783                                 "file", "file", "ftp", "ftps", "host_cdrom",
1784                                 "host_device", "host_floppy", "http", "https",
1785                                 "nbd", "parallels", "qcow", "qcow2", "raw",
1786                                 "tftp", "vdi", "vmdk", "vpc", "vvfat"
1787          - "backing_file": backing file name (json-string, optional)
1788          - "encrypted": true if encrypted, false otherwise (json-bool)
1789
1790 Example:
1791
1792 -> { "execute": "query-block" }
1793 <- {
1794       "return":[
1795          {
1796             "device":"ide0-hd0",
1797             "locked":false,
1798             "removable":false,
1799             "inserted":{
1800                "ro":false,
1801                "drv":"qcow2",
1802                "encrypted":false,
1803                "file":"disks/test.img"
1804             },
1805             "type":"hd"
1806          },
1807          {
1808             "device":"ide1-cd0",
1809             "locked":false,
1810             "removable":true,
1811             "type":"cdrom"
1812          },
1813          {
1814             "device":"floppy0",
1815             "locked":false,
1816             "removable":true,
1817             "type": "floppy"
1818          },
1819          {
1820             "device":"sd0",
1821             "locked":false,
1822             "removable":true,
1823             "type":"floppy"
1824          }
1825       ]
1826    }
1827
1828 EQMP
1829
1830 STEXI
1831 @item info blockstats
1832 show block device statistics
1833 ETEXI
1834 SQMP
1835 query-blockstats
1836 ----------------
1837
1838 Show block device statistics.
1839
1840 Each device statistic information is stored in a json-object and the returned
1841 value is a json-array of all devices.
1842
1843 Each json-object contain the following:
1844
1845 - "device": device name (json-string)
1846 - "stats": A json-object with the statistics information, it contains:
1847     - "rd_bytes": bytes read (json-int)
1848     - "wr_bytes": bytes written (json-int)
1849     - "rd_operations": read operations (json-int)
1850     - "wr_operations": write operations (json-int)
1851     - "wr_highest_offset": Highest offset of a sector written since the
1852                            BlockDriverState has been opened (json-int)
1853 - "parent": Contains recursively the statistics of the underlying
1854             protocol (e.g. the host file for a qcow2 image). If there is
1855             no underlying protocol, this field is omitted
1856             (json-object, optional)
1857
1858 Example:
1859
1860 -> { "execute": "query-blockstats" }
1861 <- {
1862       "return":[
1863          {
1864             "device":"ide0-hd0",
1865             "parent":{
1866                "stats":{
1867                   "wr_highest_offset":3686448128,
1868                   "wr_bytes":9786368,
1869                   "wr_operations":751,
1870                   "rd_bytes":122567168,
1871                   "rd_operations":36772
1872                }
1873             },
1874             "stats":{
1875                "wr_highest_offset":2821110784,
1876                "wr_bytes":9786368,
1877                "wr_operations":692,
1878                "rd_bytes":122739200,
1879                "rd_operations":36604
1880             }
1881          },
1882          {
1883             "device":"ide1-cd0",
1884             "stats":{
1885                "wr_highest_offset":0,
1886                "wr_bytes":0,
1887                "wr_operations":0,
1888                "rd_bytes":0,
1889                "rd_operations":0
1890             }
1891          },
1892          {
1893             "device":"floppy0",
1894             "stats":{
1895                "wr_highest_offset":0,
1896                "wr_bytes":0,
1897                "wr_operations":0,
1898                "rd_bytes":0,
1899                "rd_operations":0
1900             }
1901          },
1902          {
1903             "device":"sd0",
1904             "stats":{
1905                "wr_highest_offset":0,
1906                "wr_bytes":0,
1907                "wr_operations":0,
1908                "rd_bytes":0,
1909                "rd_operations":0
1910             }
1911          }
1912       ]
1913    }
1914
1915 EQMP
1916
1917 STEXI
1918 @item info registers
1919 show the cpu registers
1920 @item info cpus
1921 show infos for each CPU
1922 ETEXI
1923 SQMP
1924 query-cpus
1925 ----------
1926
1927 Show CPU information.
1928
1929 Return a json-array. Each CPU is represented by a json-object, which contains:
1930
1931 - "CPU": CPU index (json-int)
1932 - "current": true if this is the current CPU, false otherwise (json-bool)
1933 - "halted": true if the cpu is halted, false otherwise (json-bool)
1934 - Current program counter. The key's name depends on the architecture:
1935      "pc": i386/x86_64 (json-int)
1936      "nip": PPC (json-int)
1937      "pc" and "npc": sparc (json-int)
1938      "PC": mips (json-int)
1939
1940 Example:
1941
1942 -> { "execute": "query-cpus" }
1943 <- {
1944       "return":[
1945          {
1946             "CPU":0,
1947             "current":true,
1948             "halted":false,
1949             "pc":3227107138
1950          },
1951          {
1952             "CPU":1,
1953             "current":false,
1954             "halted":true,
1955             "pc":7108165
1956          }
1957       ]
1958    }
1959
1960 EQMP
1961
1962 STEXI
1963 @item info history
1964 show the command line history
1965 @item info irq
1966 show the interrupts statistics (if available)
1967 @item info pic
1968 show i8259 (PIC) state
1969 ETEXI
1970
1971 STEXI
1972 @item info pci
1973 show emulated PCI device info
1974 ETEXI
1975 SQMP
1976 query-pci
1977 ---------
1978
1979 PCI buses and devices information.
1980
1981 The returned value is a json-array of all buses. Each bus is represented by
1982 a json-object, which has a key with a json-array of all PCI devices attached
1983 to it. Each device is represented by a json-object.
1984
1985 The bus json-object contains the following:
1986
1987 - "bus": bus number (json-int)
1988 - "devices": a json-array of json-objects, each json-object represents a
1989              PCI device
1990
1991 The PCI device json-object contains the following:
1992
1993 - "bus": identical to the parent's bus number (json-int)
1994 - "slot": slot number (json-int)
1995 - "function": function number (json-int)
1996 - "class_info": a json-object containing:
1997      - "desc": device class description (json-string, optional)
1998      - "class": device class number (json-int)
1999 - "id": a json-object containing:
2000      - "device": device ID (json-int)
2001      - "vendor": vendor ID (json-int)
2002 - "irq": device's IRQ if assigned (json-int, optional)
2003 - "qdev_id": qdev id string (json-string)
2004 - "pci_bridge": It's a json-object, only present if this device is a
2005                 PCI bridge, contains:
2006      - "bus": bus number (json-int)
2007      - "secondary": secondary bus number (json-int)
2008      - "subordinate": subordinate bus number (json-int)
2009      - "io_range": I/O memory range information, a json-object with the
2010                    following members:
2011                  - "base": base address, in bytes (json-int)
2012                  - "limit": limit address, in bytes (json-int)
2013      - "memory_range": memory range information, a json-object with the
2014                        following members:
2015                  - "base": base address, in bytes (json-int)
2016                  - "limit": limit address, in bytes (json-int)
2017      - "prefetchable_range": Prefetchable memory range information, a
2018                              json-object with the following members:
2019                  - "base": base address, in bytes (json-int)
2020                  - "limit": limit address, in bytes (json-int)
2021      - "devices": a json-array of PCI devices if there's any attached, each
2022                   each element is represented by a json-object, which contains
2023                   the same members of the 'PCI device json-object' described
2024                   above (optional)
2025 - "regions": a json-array of json-objects, each json-object represents a
2026              memory region of this device
2027
2028 The memory range json-object contains the following:
2029
2030 - "base": base memory address (json-int)
2031 - "limit": limit value (json-int)
2032
2033 The region json-object can be an I/O region or a memory region, an I/O region
2034 json-object contains the following:
2035
2036 - "type": "io" (json-string, fixed)
2037 - "bar": BAR number (json-int)
2038 - "address": memory address (json-int)
2039 - "size": memory size (json-int)
2040
2041 A memory region json-object contains the following:
2042
2043 - "type": "memory" (json-string, fixed)
2044 - "bar": BAR number (json-int)
2045 - "address": memory address (json-int)
2046 - "size": memory size (json-int)
2047 - "mem_type_64": true or false (json-bool)
2048 - "prefetch": true or false (json-bool)
2049
2050 Example:
2051
2052 -> { "execute": "query-pci" }
2053 <- {
2054       "return":[
2055          {
2056             "bus":0,
2057             "devices":[
2058                {
2059                   "bus":0,
2060                   "qdev_id":"",
2061                   "slot":0,
2062                   "class_info":{
2063                      "class":1536,
2064                      "desc":"Host bridge"
2065                   },
2066                   "id":{
2067                      "device":32902,
2068                      "vendor":4663
2069                   },
2070                   "function":0,
2071                   "regions":[
2072
2073                   ]
2074                },
2075                {
2076                   "bus":0,
2077                   "qdev_id":"",
2078                   "slot":1,
2079                   "class_info":{
2080                      "class":1537,
2081                      "desc":"ISA bridge"
2082                   },
2083                   "id":{
2084                      "device":32902,
2085                      "vendor":28672
2086                   },
2087                   "function":0,
2088                   "regions":[
2089
2090                   ]
2091                },
2092                {
2093                   "bus":0,
2094                   "qdev_id":"",
2095                   "slot":1,
2096                   "class_info":{
2097                      "class":257,
2098                      "desc":"IDE controller"
2099                   },
2100                   "id":{
2101                      "device":32902,
2102                      "vendor":28688
2103                   },
2104                   "function":1,
2105                   "regions":[
2106                      {
2107                         "bar":4,
2108                         "size":16,
2109                         "address":49152,
2110                         "type":"io"
2111                      }
2112                   ]
2113                },
2114                {
2115                   "bus":0,
2116                   "qdev_id":"",
2117                   "slot":2,
2118                   "class_info":{
2119                      "class":768,
2120                      "desc":"VGA controller"
2121                   },
2122                   "id":{
2123                      "device":4115,
2124                      "vendor":184
2125                   },
2126                   "function":0,
2127                   "regions":[
2128                      {
2129                         "prefetch":true,
2130                         "mem_type_64":false,
2131                         "bar":0,
2132                         "size":33554432,
2133                         "address":4026531840,
2134                         "type":"memory"
2135                      },
2136                      {
2137                         "prefetch":false,
2138                         "mem_type_64":false,
2139                         "bar":1,
2140                         "size":4096,
2141                         "address":4060086272,
2142                         "type":"memory"
2143                      },
2144                      {
2145                         "prefetch":false,
2146                         "mem_type_64":false,
2147                         "bar":6,
2148                         "size":65536,
2149                         "address":-1,
2150                         "type":"memory"
2151                      }
2152                   ]
2153                },
2154                {
2155                   "bus":0,
2156                   "qdev_id":"",
2157                   "irq":11,
2158                   "slot":4,
2159                   "class_info":{
2160                      "class":1280,
2161                      "desc":"RAM controller"
2162                   },
2163                   "id":{
2164                      "device":6900,
2165                      "vendor":4098
2166                   },
2167                   "function":0,
2168                   "regions":[
2169                      {
2170                         "bar":0,
2171                         "size":32,
2172                         "address":49280,
2173                         "type":"io"
2174                      }
2175                   ]
2176                }
2177             ]
2178          }
2179       ]
2180    }
2181
2182 Note: This example has been shortened as the real response is too long.
2183
2184 EQMP
2185
2186 STEXI
2187 @item info tlb
2188 show virtual to physical memory mappings (i386 only)
2189 @item info mem
2190 show the active virtual memory mappings (i386 only)
2191 ETEXI
2192
2193 STEXI
2194 @item info jit
2195 show dynamic compiler info
2196 @item info kvm
2197 show KVM information
2198 @item info numa
2199 show NUMA information
2200 ETEXI
2201
2202 STEXI
2203 @item info kvm
2204 show KVM information
2205 ETEXI
2206 SQMP
2207 query-kvm
2208 ---------
2209
2210 Show KVM information.
2211
2212 Return a json-object with the following information:
2213
2214 - "enabled": true if KVM support is enabled, false otherwise (json-bool)
2215 - "present": true if QEMU has KVM support, false otherwise (json-bool)
2216
2217 Example:
2218
2219 -> { "execute": "query-kvm" }
2220 <- { "return": { "enabled": true, "present": true } }
2221
2222 EQMP
2223
2224 STEXI
2225 @item info usb
2226 show USB devices plugged on the virtual USB hub
2227 @item info usbhost
2228 show all USB host devices
2229 @item info profile
2230 show profiling information
2231 @item info capture
2232 show information about active capturing
2233 @item info snapshots
2234 show list of VM snapshots
2235 ETEXI
2236
2237 STEXI
2238 @item info status
2239 show the current VM status (running|paused)
2240 ETEXI
2241 SQMP
2242 query-status
2243 ------------
2244
2245 Return a json-object with the following information:
2246
2247 - "running": true if the VM is running, or false if it is paused (json-bool)
2248 - "singlestep": true if the VM is in single step mode,
2249                 false otherwise (json-bool)
2250
2251 Example:
2252
2253 -> { "execute": "query-status" }
2254 <- { "return": { "running": true, "singlestep": false } }
2255
2256 EQMP
2257
2258 STEXI
2259 @item info pcmcia
2260 show guest PCMCIA status
2261 ETEXI
2262
2263 STEXI
2264 @item info mice
2265 show which guest mouse is receiving events
2266 ETEXI
2267 SQMP
2268 query-mice
2269 ----------
2270
2271 Show VM mice information.
2272
2273 Each mouse is represented by a json-object, the returned value is a json-array
2274 of all mice.
2275
2276 The mouse json-object contains the following:
2277
2278 - "name": mouse's name (json-string)
2279 - "index": mouse's index (json-int)
2280 - "current": true if this mouse is receiving events, false otherwise (json-bool)
2281 - "absolute": true if the mouse generates absolute input events (json-bool)
2282
2283 Example:
2284
2285 -> { "execute": "query-mice" }
2286 <- {
2287       "return":[
2288          {
2289             "name":"QEMU Microsoft Mouse",
2290             "index":0,
2291             "current":false,
2292             "absolute":false
2293          },
2294          {
2295             "name":"QEMU PS/2 Mouse",
2296             "index":1,
2297             "current":true,
2298             "absolute":true
2299          }
2300       ]
2301    }
2302
2303 EQMP
2304
2305 STEXI
2306 @item info vnc
2307 show the vnc server status
2308 ETEXI
2309 SQMP
2310 query-vnc
2311 ---------
2312
2313 Show VNC server information.
2314
2315 Return a json-object with server information. Connected clients are returned
2316 as a json-array of json-objects.
2317
2318 The main json-object contains the following:
2319
2320 - "enabled": true or false (json-bool)
2321 - "host": server's IP address (json-string)
2322 - "family": address family (json-string)
2323          - Possible values: "ipv4", "ipv6", "unix", "unknown"
2324 - "service": server's port number (json-string)
2325 - "auth": authentication method (json-string)
2326          - Possible values: "invalid", "none", "ra2", "ra2ne", "sasl", "tight",
2327                             "tls", "ultra", "unknown", "vencrypt", "vencrypt",
2328                             "vencrypt+plain", "vencrypt+tls+none",
2329                             "vencrypt+tls+plain", "vencrypt+tls+sasl",
2330                             "vencrypt+tls+vnc", "vencrypt+x509+none",
2331                             "vencrypt+x509+plain", "vencrypt+x509+sasl",
2332                             "vencrypt+x509+vnc", "vnc"
2333 - "clients": a json-array of all connected clients
2334
2335 Clients are described by a json-object, each one contain the following:
2336
2337 - "host": client's IP address (json-string)
2338 - "family": address family (json-string)
2339          - Possible values: "ipv4", "ipv6", "unix", "unknown"
2340 - "service": client's port number (json-string)
2341 - "x509_dname": TLS dname (json-string, optional)
2342 - "sasl_username": SASL username (json-string, optional)
2343
2344 Example:
2345
2346 -> { "execute": "query-vnc" }
2347 <- {
2348       "return":{
2349          "enabled":true,
2350          "host":"0.0.0.0",
2351          "service":"50402",
2352          "auth":"vnc",
2353          "family":"ipv4",
2354          "clients":[
2355             {
2356                "host":"127.0.0.1",
2357                "service":"50401",
2358                "family":"ipv4"
2359             }
2360          ]
2361       }
2362    }
2363
2364 EQMP
2365
2366 STEXI
2367 @item info name
2368 show the current VM name
2369 ETEXI
2370 SQMP
2371 query-name
2372 ----------
2373
2374 Show VM name.
2375
2376 Return a json-object with the following information:
2377
2378 - "name": VM's name (json-string, optional)
2379
2380 Example:
2381
2382 -> { "execute": "query-name" }
2383 <- { "return": { "name": "qemu-name" } }
2384
2385 EQMP
2386
2387 STEXI
2388 @item info uuid
2389 show the current VM UUID
2390 ETEXI
2391 SQMP
2392 query-uuid
2393 ----------
2394
2395 Show VM UUID.
2396
2397 Return a json-object with the following information:
2398
2399 - "UUID": Universally Unique Identifier (json-string)
2400
2401 Example:
2402
2403 -> { "execute": "query-uuid" }
2404 <- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } }
2405
2406 EQMP
2407
2408 STEXI
2409 @item info cpustats
2410 show CPU statistics
2411 @item info usernet
2412 show user network stack connection states
2413 ETEXI
2414
2415 STEXI
2416 @item info migrate
2417 show migration status
2418 ETEXI
2419 SQMP
2420 query-migrate
2421 -------------
2422
2423 Migration status.
2424
2425 Return a json-object. If migration is active there will be another json-object
2426 with RAM migration status and if block migration is active another one with
2427 block migration status.
2428
2429 The main json-object contains the following:
2430
2431 - "status": migration status (json-string)
2432      - Possible values: "active", "completed", "failed", "cancelled"
2433 - "ram": only present if "status" is "active", it is a json-object with the
2434   following RAM information (in bytes):
2435          - "transferred": amount transferred (json-int)
2436          - "remaining": amount remaining (json-int)
2437          - "total": total (json-int)
2438 - "disk": only present if "status" is "active" and it is a block migration,
2439   it is a json-object with the following disk information (in bytes):
2440          - "transferred": amount transferred (json-int)
2441          - "remaining": amount remaining (json-int)
2442          - "total": total (json-int)
2443
2444 Examples:
2445
2446 1. Before the first migration
2447
2448 -> { "execute": "query-migrate" }
2449 <- { "return": {} }
2450
2451 2. Migration is done and has succeeded
2452
2453 -> { "execute": "query-migrate" }
2454 <- { "return": { "status": "completed" } }
2455
2456 3. Migration is done and has failed
2457
2458 -> { "execute": "query-migrate" }
2459 <- { "return": { "status": "failed" } }
2460
2461 4. Migration is being performed and is not a block migration:
2462
2463 -> { "execute": "query-migrate" }
2464 <- {
2465       "return":{
2466          "status":"active",
2467          "ram":{
2468             "transferred":123,
2469             "remaining":123,
2470             "total":246
2471          }
2472       }
2473    }
2474
2475 5. Migration is being performed and is a block migration:
2476
2477 -> { "execute": "query-migrate" }
2478 <- {
2479       "return":{
2480          "status":"active",
2481          "ram":{
2482             "total":1057024,
2483             "remaining":1053304,
2484             "transferred":3720
2485          },
2486          "disk":{
2487             "total":20971520,
2488             "remaining":20880384,
2489             "transferred":91136
2490          }
2491       }
2492    }
2493
2494 EQMP
2495
2496 STEXI
2497 @item info balloon
2498 show balloon information
2499 ETEXI
2500 SQMP
2501 query-balloon
2502 -------------
2503
2504 Show balloon information.
2505
2506 Make an asynchronous request for balloon info. When the request completes a
2507 json-object will be returned containing the following data:
2508
2509 - "actual": current balloon value in bytes (json-int)
2510 - "mem_swapped_in": Amount of memory swapped in bytes (json-int, optional)
2511 - "mem_swapped_out": Amount of memory swapped out in bytes (json-int, optional)
2512 - "major_page_faults": Number of major faults (json-int, optional)
2513 - "minor_page_faults": Number of minor faults (json-int, optional)
2514 - "free_mem": Total amount of free and unused memory in
2515               bytes (json-int, optional)
2516 - "total_mem": Total amount of available memory in bytes (json-int, optional)
2517
2518 Example:
2519
2520 -> { "execute": "query-balloon" }
2521 <- {
2522       "return":{
2523          "actual":1073741824,
2524          "mem_swapped_in":0,
2525          "mem_swapped_out":0,
2526          "major_page_faults":142,
2527          "minor_page_faults":239245,
2528          "free_mem":1014185984,
2529          "total_mem":1044668416
2530       }
2531    }
2532
2533 EQMP
2534
2535 STEXI
2536 @item info qtree
2537 show device tree
2538 @item info qdm
2539 show qdev device model list
2540 @item info roms
2541 show roms
2542 @end table
2543 ETEXI
2544
2545 HXCOMM DO NOT add new commands after 'info', move your addition before it!
2546
2547 STEXI
2548 @end table
2549 ETEXI