qmp-commands.hx

   1 HXCOMM QMP dispatch table and documentation
   2 HXCOMM Text between SQMP and EQMP is copied to the QMP documention file and
   3 HXCOMM does not show up in the other formats.
   4
   5 SQMP
   6                         QMP Supported Commands
   7                         ----------------------
   8
   9 This document describes all commands currently supported by QMP.
  10
  11 Most of the time their usage is exactly the same as in the user Monitor, this
  12 means that any other document which also describe commands (the manpage,
  13 QEMU's manual, etc) can and should be consulted.
  14
  15 QMP has two types of commands: regular and query commands. Regular commands
  16 usually change the Virtual Machine's state someway, while query commands just
  17 return information. The sections below are divided accordingly.
  18
  19 It's important to observe that all communication examples are formatted in
  20 a reader-friendly way, so that they're easier to understand. However, in real
  21 protocol usage, they're emitted as a single line.
  22
  23 Also, the following notation is used to denote data flow:
  24
  25 -> data issued by the Client
  26 <- Server data response
  27
  28 Please, refer to the QMP specification (QMP/qmp-spec.txt) for detailed
  29 information on the Server command and response formats.
  30
  31 NOTE: This document is temporary and will be replaced soon.
  32
  33 1. Stability Considerations
  34 ===========================
  35
  36 The current QMP command set (described in this file) may be useful for a
  37 number of use cases, however it's limited and several commands have bad
  38 defined semantics, specially with regard to command completion.
  39
  40 These problems are going to be solved incrementally in the next QEMU releases
  41 and we're going to establish a deprecation policy for badly defined commands.
  42
  43 If you're planning to adopt QMP, please observe the following:
  44
  45     1. The deprecation policy will take effect and be documented soon, please
  46        check the documentation of each used command as soon as a new release of
  47        QEMU is available
  48
  49     2. DO NOT rely on anything which is not explicit documented
  50
  51     3. Errors, in special, are not documented. Applications should NOT check
  52        for specific errors classes or data (it's strongly recommended to only
  53        check for the "error" key)
  54
  55 2. Regular Commands
  56 ===================
  57
  58 Server's responses in the examples below are always a success response, please
  59 refer to the QMP specification for more details on error responses.
  60
  61 EQMP
  62
  63     {
  64         .name       = "quit",
  65         .args_type  = "",
  66         .mhandler.cmd_new = qmp_marshal_input_quit,
  67     },
  68
  69 SQMP
  70 quit
  71 ----
  72
  73 Quit the emulator.
  74
  75 Arguments: None.
  76
  77 Example:
  78
  79 -> { "execute": "quit" }
  80 <- { "return": {} }
  81
  82 EQMP
  83
  84     {
  85         .name       = "eject",
  86         .args_type  = "force:-f,device:B",
  87         .mhandler.cmd_new = qmp_marshal_input_eject,
  88     },
  89
  90 SQMP
  91 eject
  92 -----
  93
  94 Eject a removable medium.
  95
  96 Arguments:
  97
  98 - force: force ejection (json-bool, optional)
  99 - device: device name (json-string)
 100
 101 Example:
 102
 103 -> { "execute": "eject", "arguments": { "device": "ide1-cd0" } }
 104 <- { "return": {} }
 105
 106 Note: The "force" argument defaults to false.
 107
 108 EQMP
 109
 110     {
 111         .name       = "change",
 112         .args_type  = "device:B,target:F,arg:s?",
 113         .mhandler.cmd_new = qmp_marshal_input_change,
 114     },
 115
 116 SQMP
 117 change
 118 ------
 119
 120 Change a removable medium or VNC configuration.
 121
 122 Arguments:
 123
 124 - "device": device name (json-string)
 125 - "target": filename or item (json-string)
 126 - "arg": additional argument (json-string, optional)
 127
 128 Examples:
 129
 130 1. Change a removable medium
 131
 132 -> { "execute": "change",
 133              "arguments": { "device": "ide1-cd0",
 134                             "target": "/srv/images/Fedora-12-x86_64-DVD.iso" } }
 135 <- { "return": {} }
 136
 137 2. Change VNC password
 138
 139 -> { "execute": "change",
 140              "arguments": { "device": "vnc", "target": "password",
 141                             "arg": "foobar1" } }
 142 <- { "return": {} }
 143
 144 EQMP
 145
 146     {
 147         .name       = "screendump",
 148         .args_type  = "filename:F",
 149         .params     = "filename",
 150         .help       = "save screen into PPM image 'filename'",
 151         .user_print = monitor_user_noop,
 152         .mhandler.cmd_new = do_screen_dump,
 153     },
 154
 155 SQMP
 156 screendump
 157 ----------
 158
 159 Save screen into PPM image.
 160
 161 Arguments:
 162
 163 - "filename": file path (json-string)
 164
 165 Example:
 166
 167 -> { "execute": "screendump", "arguments": { "filename": "/tmp/image" } }
 168 <- { "return": {} }
 169
 170 EQMP
 171
 172     {
 173         .name       = "stop",
 174         .args_type  = "",
 175         .mhandler.cmd_new = qmp_marshal_input_stop,
 176     },
 177
 178 SQMP
 179 stop
 180 ----
 181
 182 Stop the emulator.
 183
 184 Arguments: None.
 185
 186 Example:
 187
 188 -> { "execute": "stop" }
 189 <- { "return": {} }
 190
 191 EQMP
 192
 193     {
 194         .name       = "cont",
 195         .args_type  = "",
 196         .mhandler.cmd_new = qmp_marshal_input_cont,
 197     },
 198
 199 SQMP
 200 cont
 201 ----
 202
 203 Resume emulation.
 204
 205 Arguments: None.
 206
 207 Example:
 208
 209 -> { "execute": "cont" }
 210 <- { "return": {} }
 211
 212 EQMP
 213
 214     {
 215         .name       = "system_wakeup",
 216         .args_type  = "",
 217         .mhandler.cmd_new = qmp_marshal_input_system_wakeup,
 218     },
 219
 220 SQMP
 221 system_wakeup
 222 -------------
 223
 224 Wakeup guest from suspend.
 225
 226 Arguments: None.
 227
 228 Example:
 229
 230 -> { "execute": "system_wakeup" }
 231 <- { "return": {} }
 232
 233 EQMP
 234
 235     {
 236         .name       = "system_reset",
 237         .args_type  = "",
 238         .mhandler.cmd_new = qmp_marshal_input_system_reset,
 239     },
 240
 241 SQMP
 242 system_reset
 243 ------------
 244
 245 Reset the system.
 246
 247 Arguments: None.
 248
 249 Example:
 250
 251 -> { "execute": "system_reset" }
 252 <- { "return": {} }
 253
 254 EQMP
 255
 256     {
 257         .name       = "system_powerdown",
 258         .args_type  = "",
 259         .mhandler.cmd_new = qmp_marshal_input_system_powerdown,
 260     },
 261
 262 SQMP
 263 system_powerdown
 264 ----------------
 265
 266 Send system power down event.
 267
 268 Arguments: None.
 269
 270 Example:
 271
 272 -> { "execute": "system_powerdown" }
 273 <- { "return": {} }
 274
 275 EQMP
 276
 277     {
 278         .name       = "device_add",
 279         .args_type  = "device:O",
 280         .params     = "driver[,prop=value][,...]",
 281         .help       = "add device, like -device on the command line",
 282         .user_print = monitor_user_noop,
 283         .mhandler.cmd_new = do_device_add,
 284     },
 285
 286 SQMP
 287 device_add
 288 ----------
 289
 290 Add a device.
 291
 292 Arguments:
 293
 294 - "driver": the name of the new device's driver (json-string)
 295 - "bus": the device's parent bus (device tree path, json-string, optional)
 296 - "id": the device's ID, must be unique (json-string)
 297 - device properties
 298
 299 Example:
 300
 301 -> { "execute": "device_add", "arguments": { "driver": "e1000", "id": "net1" } }
 302 <- { "return": {} }
 303
 304 Notes:
 305
 306 (1) For detailed information about this command, please refer to the
 307     'docs/qdev-device-use.txt' file.
 308
 309 (2) It's possible to list device properties by running QEMU with the
 310     "-device DEVICE,\?" command-line argument, where DEVICE is the device's name
 311
 312 EQMP
 313
 314     {
 315         .name       = "device_del",
 316         .args_type  = "id:s",
 317         .params     = "device",
 318         .help       = "remove device",
 319         .user_print = monitor_user_noop,
 320         .mhandler.cmd_new = do_device_del,
 321     },
 322
 323 SQMP
 324 device_del
 325 ----------
 326
 327 Remove a device.
 328
 329 Arguments:
 330
 331 - "id": the device's ID (json-string)
 332
 333 Example:
 334
 335 -> { "execute": "device_del", "arguments": { "id": "net1" } }
 336 <- { "return": {} }
 337
 338 EQMP
 339
 340     {
 341         .name       = "cpu",
 342         .args_type  = "index:i",
 343         .mhandler.cmd_new = qmp_marshal_input_cpu,
 344     },
 345
 346 SQMP
 347 cpu
 348 ---
 349
 350 Set the default CPU.
 351
 352 Arguments:
 353
 354 - "index": the CPU's index (json-int)
 355
 356 Example:
 357
 358 -> { "execute": "cpu", "arguments": { "index": 0 } }
 359 <- { "return": {} }
 360
 361 Note: CPUs' indexes are obtained with the 'query-cpus' command.
 362
 363 EQMP
 364
 365     {
 366         .name       = "memsave",
 367         .args_type  = "val:l,size:i,filename:s,cpu:i?",
 368         .mhandler.cmd_new = qmp_marshal_input_memsave,
 369     },
 370
 371 SQMP
 372 memsave
 373 -------
 374
 375 Save to disk virtual memory dump starting at 'val' of size 'size'.
 376
 377 Arguments:
 378
 379 - "val": the starting address (json-int)
 380 - "size": the memory size, in bytes (json-int)
 381 - "filename": file path (json-string)
 382 - "cpu": virtual CPU index (json-int, optional)
 383
 384 Example:
 385
 386 -> { "execute": "memsave",
 387              "arguments": { "val": 10,
 388                             "size": 100,
 389                             "filename": "/tmp/virtual-mem-dump" } }
 390 <- { "return": {} }
 391
 392 EQMP
 393
 394     {
 395         .name       = "pmemsave",
 396         .args_type  = "val:l,size:i,filename:s",
 397         .mhandler.cmd_new = qmp_marshal_input_pmemsave,
 398     },
 399
 400 SQMP
 401 pmemsave
 402 --------
 403
 404 Save to disk physical memory dump starting at 'val' of size 'size'.
 405
 406 Arguments:
 407
 408 - "val": the starting address (json-int)
 409 - "size": the memory size, in bytes (json-int)
 410 - "filename": file path (json-string)
 411
 412 Example:
 413
 414 -> { "execute": "pmemsave",
 415              "arguments": { "val": 10,
 416                             "size": 100,
 417                             "filename": "/tmp/physical-mem-dump" } }
 418 <- { "return": {} }
 419
 420 EQMP
 421
 422     {
 423         .name       = "inject-nmi",
 424         .args_type  = "",
 425         .mhandler.cmd_new = qmp_marshal_input_inject_nmi,
 426     },
 427
 428 SQMP
 429 inject-nmi
 430 ----------
 431
 432 Inject an NMI on guest's CPUs.
 433
 434 Arguments: None.
 435
 436 Example:
 437
 438 -> { "execute": "inject-nmi" }
 439 <- { "return": {} }
 440
 441 Note: inject-nmi is only supported for x86 guest currently, it will
 442       returns "Unsupported" error for non-x86 guest.
 443
 444 EQMP
 445
 446     {
 447         .name       = "migrate",
 448         .args_type  = "detach:-d,blk:-b,inc:-i,uri:s",
 449         .params     = "[-d] [-b] [-i] uri",
 450         .help       = "migrate to URI (using -d to not wait for completion)"
 451                       "\n\t\t\t -b for migration without shared storage with"
 452                       " full copy of disk\n\t\t\t -i for migration without "
 453                       "shared storage with incremental copy of disk "
 454                       "(base image shared between src and destination)",
 455         .user_print = monitor_user_noop,
 456         .mhandler.cmd_new = do_migrate,
 457     },
 458
 459 SQMP
 460 migrate
 461 -------
 462
 463 Migrate to URI.
 464
 465 Arguments:
 466
 467 - "blk": block migration, full disk copy (json-bool, optional)
 468 - "inc": incremental disk copy (json-bool, optional)
 469 - "uri": Destination URI (json-string)
 470
 471 Example:
 472
 473 -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
 474 <- { "return": {} }
 475
 476 Notes:
 477
 478 (1) The 'query-migrate' command should be used to check migration's progress
 479     and final result (this information is provided by the 'status' member)
 480 (2) All boolean arguments default to false
 481 (3) The user Monitor's "detach" argument is invalid in QMP and should not
 482     be used
 483
 484 EQMP
 485
 486     {
 487         .name       = "migrate_cancel",
 488         .args_type  = "",
 489         .mhandler.cmd_new = qmp_marshal_input_migrate_cancel,
 490     },
 491
 492 SQMP
 493 migrate_cancel
 494 --------------
 495
 496 Cancel the current migration.
 497
 498 Arguments: None.
 499
 500 Example:
 501
 502 -> { "execute": "migrate_cancel" }
 503 <- { "return": {} }
 504
 505 EQMP
 506
 507     {
 508         .name       = "migrate_set_speed",
 509         .args_type  = "value:o",
 510         .mhandler.cmd_new = qmp_marshal_input_migrate_set_speed,
 511     },
 512
 513 SQMP
 514 migrate_set_speed
 515 -----------------
 516
 517 Set maximum speed for migrations.
 518
 519 Arguments:
 520
 521 - "value": maximum speed, in bytes per second (json-int)
 522
 523 Example:
 524
 525 -> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } }
 526 <- { "return": {} }
 527
 528 EQMP
 529
 530     {
 531         .name       = "migrate_set_downtime",
 532         .args_type  = "value:T",
 533         .mhandler.cmd_new = qmp_marshal_input_migrate_set_downtime,
 534     },
 535
 536 SQMP
 537 migrate_set_downtime
 538 --------------------
 539
 540 Set maximum tolerated downtime (in seconds) for migrations.
 541
 542 Arguments:
 543
 544 - "value": maximum downtime (json-number)
 545
 546 Example:
 547
 548 -> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } }
 549 <- { "return": {} }
 550
 551 EQMP
 552
 553     {
 554         .name       = "client_migrate_info",
 555         .args_type  = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
 556         .params     = "protocol hostname port tls-port cert-subject",
 557         .help       = "send migration info to spice/vnc client",
 558         .user_print = monitor_user_noop,
 559         .mhandler.cmd_async = client_migrate_info,
 560         .flags      = MONITOR_CMD_ASYNC,
 561     },
 562
 563 SQMP
 564 client_migrate_info
 565 ------------------
 566
 567 Set the spice/vnc connection info for the migration target.  The spice/vnc
 568 server will ask the spice/vnc client to automatically reconnect using the
 569 new parameters (if specified) once the vm migration finished successfully.
 570
 571 Arguments:
 572
 573 - "protocol":     protocol: "spice" or "vnc" (json-string)
 574 - "hostname":     migration target hostname (json-string)
 575 - "port":         spice/vnc tcp port for plaintext channels (json-int, optional)
 576 - "tls-port":     spice tcp port for tls-secured channels (json-int, optional)
 577 - "cert-subject": server certificate subject (json-string, optional)
 578
 579 Example:
 580
 581 -> { "execute": "client_migrate_info",
 582      "arguments": { "protocol": "spice",
 583                     "hostname": "virt42.lab.kraxel.org",
 584                     "port": 1234 } }
 585 <- { "return": {} }
 586
 587 EQMP
 588
 589     {
 590         .name       = "netdev_add",
 591         .args_type  = "netdev:O",
 592         .params     = "[user|tap|socket],id=str[,prop=value][,...]",
 593         .help       = "add host network device",
 594         .user_print = monitor_user_noop,
 595         .mhandler.cmd_new = do_netdev_add,
 596     },
 597
 598 SQMP
 599 netdev_add
 600 ----------
 601
 602 Add host network device.
 603
 604 Arguments:
 605
 606 - "type": the device type, "tap", "user", ... (json-string)
 607 - "id": the device's ID, must be unique (json-string)
 608 - device options
 609
 610 Example:
 611
 612 -> { "execute": "netdev_add", "arguments": { "type": "user", "id": "netdev1" } }
 613 <- { "return": {} }
 614
 615 Note: The supported device options are the same ones supported by the '-net'
 616       command-line argument, which are listed in the '-help' output or QEMU's
 617       manual
 618
 619 EQMP
 620
 621     {
 622         .name       = "netdev_del",
 623         .args_type  = "id:s",
 624         .params     = "id",
 625         .help       = "remove host network device",
 626         .user_print = monitor_user_noop,
 627         .mhandler.cmd_new = do_netdev_del,
 628     },
 629
 630 SQMP
 631 netdev_del
 632 ----------
 633
 634 Remove host network device.
 635
 636 Arguments:
 637
 638 - "id": the device's ID, must be unique (json-string)
 639
 640 Example:
 641
 642 -> { "execute": "netdev_del", "arguments": { "id": "netdev1" } }
 643 <- { "return": {} }
 644
 645
 646 EQMP
 647
 648     {
 649         .name       = "block_resize",
 650         .args_type  = "device:B,size:o",
 651         .mhandler.cmd_new = qmp_marshal_input_block_resize,
 652     },
 653
 654 SQMP
 655 block_resize
 656 ------------
 657
 658 Resize a block image while a guest is running.
 659
 660 Arguments:
 661
 662 - "device": the device's ID, must be unique (json-string)
 663 - "size": new size
 664
 665 Example:
 666
 667 -> { "execute": "block_resize", "arguments": { "device": "scratch", "size": 1073741824 } }
 668 <- { "return": {} }
 669
 670 EQMP
 671
 672     {
 673         .name       = "block_stream",
 674         .args_type  = "device:B,base:s?",
 675         .mhandler.cmd_new = qmp_marshal_input_block_stream,
 676     },
 677
 678     {
 679         .name       = "block_job_set_speed",
 680         .args_type  = "device:B,value:o",
 681         .mhandler.cmd_new = qmp_marshal_input_block_job_set_speed,
 682     },
 683
 684     {
 685         .name       = "block_job_cancel",
 686         .args_type  = "device:B",
 687         .mhandler.cmd_new = qmp_marshal_input_block_job_cancel,
 688     },
 689     {
 690         .name       = "transaction",
 691         .args_type  = "actions:O",
 692         .mhandler.cmd_new = qmp_marshal_input_transaction,
 693     },
 694
 695 SQMP
 696 transaction
 697 -----------
 698
 699 Atomically operate on one or more block devices.  The only supported
 700 operation for now is snapshotting.  If there is any failure performing
 701 any of the operations, all snapshots for the group are abandoned, and
 702 the original disks pre-snapshot attempt are used.
 703
 704 A list of dictionaries is accepted, that contains the actions to be performed.
 705 For snapshots this is the device, the file to use for the new snapshot,
 706 and the format.  The default format, if not specified, is qcow2.
 707
 708 Arguments:
 709
 710 actions array:
 711     - "type": the operation to perform.  The only supported
 712       value is "blockdev-snapshot-sync". (json-string)
 713     - "data": a dictionary.  The contents depend on the value
 714       of "type".  When "type" is "blockdev-snapshot-sync":
 715       - "device": device name to snapshot (json-string)
 716       - "snapshot-file": name of new image file (json-string)
 717       - "format": format of new image (json-string, optional)
 718
 719 Example:
 720
 721 -> { "execute": "transaction",
 722      "arguments": { "actions": [
 723          { 'type': 'blockdev-snapshot-sync', 'data' : { "device": "ide-hd0",
 724                                          "snapshot-file": "/some/place/my-image",
 725                                          "format": "qcow2" } },
 726          { 'type': 'blockdev-snapshot-sync', 'data' : { "device": "ide-hd1",
 727                                          "snapshot-file": "/some/place/my-image2",
 728                                          "format": "qcow2" } } ] } }
 729 <- { "return": {} }
 730
 731 EQMP
 732
 733     {
 734         .name       = "blockdev-snapshot-sync",
 735         .args_type  = "device:B,snapshot-file:s,format:s?",
 736         .mhandler.cmd_new = qmp_marshal_input_blockdev_snapshot_sync,
 737     },
 738
 739 SQMP
 740 blockdev-snapshot-sync
 741 ----------------------
 742
 743 Synchronous snapshot of a block device. snapshot-file specifies the
 744 target of the new image. If the file exists, or if it is a device, the
 745 snapshot will be created in the existing file/device. If does not
 746 exist, a new file will be created. format specifies the format of the
 747 snapshot image, default is qcow2.
 748
 749 Arguments:
 750
 751 - "device": device name to snapshot (json-string)
 752 - "snapshot-file": name of new image file (json-string)
 753 - "format": format of new image (json-string, optional)
 754
 755 Example:
 756
 757 -> { "execute": "blockdev-snapshot-sync", "arguments": { "device": "ide-hd0",
 758                                                          "snapshot-file":
 759                                                         "/some/place/my-image",
 760                                                         "format": "qcow2" } }
 761 <- { "return": {} }
 762
 763 EQMP
 764
 765     {
 766         .name       = "balloon",
 767         .args_type  = "value:M",
 768         .mhandler.cmd_new = qmp_marshal_input_balloon,
 769     },
 770
 771 SQMP
 772 balloon
 773 -------
 774
 775 Request VM to change its memory allocation (in bytes).
 776
 777 Arguments:
 778
 779 - "value": New memory allocation (json-int)
 780
 781 Example:
 782
 783 -> { "execute": "balloon", "arguments": { "value": 536870912 } }
 784 <- { "return": {} }
 785
 786 EQMP
 787
 788     {
 789         .name       = "set_link",
 790         .args_type  = "name:s,up:b",
 791         .mhandler.cmd_new = qmp_marshal_input_set_link,
 792     },
 793
 794 SQMP
 795 set_link
 796 --------
 797
 798 Change the link status of a network adapter.
 799
 800 Arguments:
 801
 802 - "name": network device name (json-string)
 803 - "up": status is up (json-bool)
 804
 805 Example:
 806
 807 -> { "execute": "set_link", "arguments": { "name": "e1000.0", "up": false } }
 808 <- { "return": {} }
 809
 810 EQMP
 811
 812     {
 813         .name       = "getfd",
 814         .args_type  = "fdname:s",
 815         .params     = "getfd name",
 816         .help       = "receive a file descriptor via SCM rights and assign it a name",
 817         .user_print = monitor_user_noop,
 818         .mhandler.cmd_new = do_getfd,
 819     },
 820
 821 SQMP
 822 getfd
 823 -----
 824
 825 Receive a file descriptor via SCM rights and assign it a name.
 826
 827 Arguments:
 828
 829 - "fdname": file descriptor name (json-string)
 830
 831 Example:
 832
 833 -> { "execute": "getfd", "arguments": { "fdname": "fd1" } }
 834 <- { "return": {} }
 835
 836 EQMP
 837
 838     {
 839         .name       = "closefd",
 840         .args_type  = "fdname:s",
 841         .params     = "closefd name",
 842         .help       = "close a file descriptor previously passed via SCM rights",
 843         .user_print = monitor_user_noop,
 844         .mhandler.cmd_new = do_closefd,
 845     },
 846
 847 SQMP
 848 closefd
 849 -------
 850
 851 Close a file descriptor previously passed via SCM rights.
 852
 853 Arguments:
 854
 855 - "fdname": file descriptor name (json-string)
 856
 857 Example:
 858
 859 -> { "execute": "closefd", "arguments": { "fdname": "fd1" } }
 860 <- { "return": {} }
 861
 862 EQMP
 863
 864     {
 865         .name       = "block_passwd",
 866         .args_type  = "device:B,password:s",
 867         .mhandler.cmd_new = qmp_marshal_input_block_passwd,
 868     },
 869
 870 SQMP
 871 block_passwd
 872 ------------
 873
 874 Set the password of encrypted block devices.
 875
 876 Arguments:
 877
 878 - "device": device name (json-string)
 879 - "password": password (json-string)
 880
 881 Example:
 882
 883 -> { "execute": "block_passwd", "arguments": { "device": "ide0-hd0",
 884                                                "password": "12345" } }
 885 <- { "return": {} }
 886
 887 EQMP
 888
 889     {
 890         .name       = "block_set_io_throttle",
 891         .args_type  = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
 892         .mhandler.cmd_new = qmp_marshal_input_block_set_io_throttle,
 893     },
 894
 895 SQMP
 896 block_set_io_throttle
 897 ------------
 898
 899 Change I/O throttle limits for a block drive.
 900
 901 Arguments:
 902
 903 - "device": device name (json-string)
 904 - "bps":  total throughput limit in bytes per second(json-int)
 905 - "bps_rd":  read throughput limit in bytes per second(json-int)
 906 - "bps_wr":  read throughput limit in bytes per second(json-int)
 907 - "iops":  total I/O operations per second(json-int)
 908 - "iops_rd":  read I/O operations per second(json-int)
 909 - "iops_wr":  write I/O operations per second(json-int)
 910
 911 Example:
 912
 913 -> { "execute": "block_set_io_throttle", "arguments": { "device": "virtio0",
 914                                                "bps": "1000000",
 915                                                "bps_rd": "0",
 916                                                "bps_wr": "0",
 917                                                "iops": "0",
 918                                                "iops_rd": "0",
 919                                                "iops_wr": "0" } }
 920 <- { "return": {} }
 921
 922 EQMP
 923
 924     {
 925         .name       = "set_password",
 926         .args_type  = "protocol:s,password:s,connected:s?",
 927         .mhandler.cmd_new = qmp_marshal_input_set_password,
 928     },
 929
 930 SQMP
 931 set_password
 932 ------------
 933
 934 Set the password for vnc/spice protocols.
 935
 936 Arguments:
 937
 938 - "protocol": protocol name (json-string)
 939 - "password": password (json-string)
 940 - "connected": [ keep | disconnect | fail ] (josn-string, optional)
 941
 942 Example:
 943
 944 -> { "execute": "set_password", "arguments": { "protocol": "vnc",
 945                                                "password": "secret" } }
 946 <- { "return": {} }
 947
 948 EQMP
 949
 950     {
 951         .name       = "expire_password",
 952         .args_type  = "protocol:s,time:s",
 953         .mhandler.cmd_new = qmp_marshal_input_expire_password,
 954     },
 955
 956 SQMP
 957 expire_password
 958 ---------------
 959
 960 Set the password expire time for vnc/spice protocols.
 961
 962 Arguments:
 963
 964 - "protocol": protocol name (json-string)
 965 - "time": [ now | never | +secs | secs ] (json-string)
 966
 967 Example:
 968
 969 -> { "execute": "expire_password", "arguments": { "protocol": "vnc",
 970                                                   "time": "+60" } }
 971 <- { "return": {} }
 972
 973 EQMP
 974
 975     {
 976         .name       = "add_client",
 977         .args_type  = "protocol:s,fdname:s,skipauth:b?,tls:b?",
 978         .params     = "protocol fdname skipauth tls",
 979         .help       = "add a graphics client",
 980         .user_print = monitor_user_noop,
 981         .mhandler.cmd_new = add_graphics_client,
 982     },
 983
 984 SQMP
 985 add_client
 986 ----------
 987
 988 Add a graphics client
 989
 990 Arguments:
 991
 992 - "protocol": protocol name (json-string)
 993 - "fdname": file descriptor name (json-string)
 994 - "skipauth": whether to skip authentication (json-bool, optional)
 995 - "tls": whether to perform TLS (json-bool, optional)
 996
 997 Example:
 998
 999 -> { "execute": "add_client", "arguments": { "protocol": "vnc",
1000                                              "fdname": "myclient" } }
1001 <- { "return": {} }
1002
1003 EQMP
1004     {
1005         .name       = "qmp_capabilities",
1006         .args_type  = "",
1007         .params     = "",
1008         .help       = "enable QMP capabilities",
1009         .user_print = monitor_user_noop,
1010         .mhandler.cmd_new = do_qmp_capabilities,
1011     },
1012
1013 SQMP
1014 qmp_capabilities
1015 ----------------
1016
1017 Enable QMP capabilities.
1018
1019 Arguments: None.
1020
1021 Example:
1022
1023 -> { "execute": "qmp_capabilities" }
1024 <- { "return": {} }
1025
1026 Note: This command must be issued before issuing any other command.
1027
1028 EQMP
1029
1030     {
1031         .name       = "human-monitor-command",
1032         .args_type  = "command-line:s,cpu-index:i?",
1033         .mhandler.cmd_new = qmp_marshal_input_human_monitor_command,
1034     },
1035
1036 SQMP
1037 human-monitor-command
1038 ---------------------
1039
1040 Execute a Human Monitor command.
1041
1042 Arguments:
1043
1044 - command-line: the command name and its arguments, just like the
1045                 Human Monitor's shell (json-string)
1046 - cpu-index: select the CPU number to be used by commands which access CPU
1047              data, like 'info registers'. The Monitor selects CPU 0 if this
1048              argument is not provided (json-int, optional)
1049
1050 Example:
1051
1052 -> { "execute": "human-monitor-command", "arguments": { "command-line": "info kvm" } }
1053 <- { "return": "kvm support: enabled\r\n" }
1054
1055 Notes:
1056
1057 (1) The Human Monitor is NOT an stable interface, this means that command
1058     names, arguments and responses can change or be removed at ANY time.
1059     Applications that rely on long term stability guarantees should NOT
1060     use this command
1061
1062 (2) Limitations:
1063
1064     o This command is stateless, this means that commands that depend
1065       on state information (such as getfd) might not work
1066
1067     o Commands that prompt the user for data (eg. 'cont' when the block
1068       device is encrypted) don't currently work
1069
1070 3. Query Commands
1071 =================
1072
1073 HXCOMM Each query command below is inside a SQMP/EQMP section, do NOT change
1074 HXCOMM this! We will possibly move query commands definitions inside those
1075 HXCOMM sections, just like regular commands.
1076
1077 EQMP
1078
1079 SQMP
1080 query-version
1081 -------------
1082
1083 Show QEMU version.
1084
1085 Return a json-object with the following information:
1086
1087 - "qemu": A json-object containing three integer values:
1088     - "major": QEMU's major version (json-int)
1089     - "minor": QEMU's minor version (json-int)
1090     - "micro": QEMU's micro version (json-int)
1091 - "package": package's version (json-string)
1092
1093 Example:
1094
1095 -> { "execute": "query-version" }
1096 <- {
1097       "return":{
1098          "qemu":{
1099             "major":0,
1100             "minor":11,
1101             "micro":5
1102          },
1103          "package":""
1104       }
1105    }
1106
1107 EQMP
1108
1109     {
1110         .name       = "query-version",
1111         .args_type  = "",
1112         .mhandler.cmd_new = qmp_marshal_input_query_version,
1113     },
1114
1115 SQMP
1116 query-commands
1117 --------------
1118
1119 List QMP available commands.
1120
1121 Each command is represented by a json-object, the returned value is a json-array
1122 of all commands.
1123
1124 Each json-object contain:
1125
1126 - "name": command's name (json-string)
1127
1128 Example:
1129
1130 -> { "execute": "query-commands" }
1131 <- {
1132       "return":[
1133          {
1134             "name":"query-balloon"
1135          },
1136          {
1137             "name":"system_powerdown"
1138          }
1139       ]
1140    }
1141
1142 Note: This example has been shortened as the real response is too long.
1143
1144 EQMP
1145
1146     {
1147         .name       = "query-commands",
1148         .args_type  = "",
1149         .mhandler.cmd_new = qmp_marshal_input_query_commands,
1150     },
1151
1152 SQMP
1153 query-chardev
1154 -------------
1155
1156 Each device is represented by a json-object. The returned value is a json-array
1157 of all devices.
1158
1159 Each json-object contain the following:
1160
1161 - "label": device's label (json-string)
1162 - "filename": device's file (json-string)
1163
1164 Example:
1165
1166 -> { "execute": "query-chardev" }
1167 <- {
1168       "return":[
1169          {
1170             "label":"monitor",
1171             "filename":"stdio"
1172          },
1173          {
1174             "label":"serial0",
1175             "filename":"vc"
1176          }
1177       ]
1178    }
1179
1180 EQMP
1181
1182     {
1183         .name       = "query-chardev",
1184         .args_type  = "",
1185         .mhandler.cmd_new = qmp_marshal_input_query_chardev,
1186     },
1187
1188 SQMP
1189 query-block
1190 -----------
1191
1192 Show the block devices.
1193
1194 Each block device information is stored in a json-object and the returned value
1195 is a json-array of all devices.
1196
1197 Each json-object contain the following:
1198
1199 - "device": device name (json-string)
1200 - "type": device type (json-string)
1201          - deprecated, retained for backward compatibility
1202          - Possible values: "unknown"
1203 - "removable": true if the device is removable, false otherwise (json-bool)
1204 - "locked": true if the device is locked, false otherwise (json-bool)
1205 - "tray-open": only present if removable, true if the device has a tray,
1206                and it is open (json-bool)
1207 - "inserted": only present if the device is inserted, it is a json-object
1208    containing the following:
1209          - "file": device file name (json-string)
1210          - "ro": true if read-only, false otherwise (json-bool)
1211          - "drv": driver format name (json-string)
1212              - Possible values: "blkdebug", "bochs", "cloop", "cow", "dmg",
1213                                 "file", "file", "ftp", "ftps", "host_cdrom",
1214                                 "host_device", "host_floppy", "http", "https",
1215                                 "nbd", "parallels", "qcow", "qcow2", "raw",
1216                                 "tftp", "vdi", "vmdk", "vpc", "vvfat"
1217          - "backing_file": backing file name (json-string, optional)
1218          - "encrypted": true if encrypted, false otherwise (json-bool)
1219          - "bps": limit total bytes per second (json-int)
1220          - "bps_rd": limit read bytes per second (json-int)
1221          - "bps_wr": limit write bytes per second (json-int)
1222          - "iops": limit total I/O operations per second (json-int)
1223          - "iops_rd": limit read operations per second (json-int)
1224          - "iops_wr": limit write operations per second (json-int)
1225
1226 - "io-status": I/O operation status, only present if the device supports it
1227                and the VM is configured to stop on errors. It's always reset
1228                to "ok" when the "cont" command is issued (json_string, optional)
1229              - Possible values: "ok", "failed", "nospace"
1230
1231 Example:
1232
1233 -> { "execute": "query-block" }
1234 <- {
1235       "return":[
1236          {
1237             "io-status": "ok",
1238             "device":"ide0-hd0",
1239             "locked":false,
1240             "removable":false,
1241             "inserted":{
1242                "ro":false,
1243                "drv":"qcow2",
1244                "encrypted":false,
1245                "file":"disks/test.img",
1246                "bps":1000000,
1247                "bps_rd":0,
1248                "bps_wr":0,
1249                "iops":1000000,
1250                "iops_rd":0,
1251                "iops_wr":0,
1252             },
1253             "type":"unknown"
1254          },
1255          {
1256             "io-status": "ok",
1257             "device":"ide1-cd0",
1258             "locked":false,
1259             "removable":true,
1260             "type":"unknown"
1261          },
1262          {
1263             "device":"floppy0",
1264             "locked":false,
1265             "removable":true,
1266             "type":"unknown"
1267          },
1268          {
1269             "device":"sd0",
1270             "locked":false,
1271             "removable":true,
1272             "type":"unknown"
1273          }
1274       ]
1275    }
1276
1277 EQMP
1278
1279     {
1280         .name       = "query-block",
1281         .args_type  = "",
1282         .mhandler.cmd_new = qmp_marshal_input_query_block,
1283     },
1284
1285 SQMP
1286 query-blockstats
1287 ----------------
1288
1289 Show block device statistics.
1290
1291 Each device statistic information is stored in a json-object and the returned
1292 value is a json-array of all devices.
1293
1294 Each json-object contain the following:
1295
1296 - "device": device name (json-string)
1297 - "stats": A json-object with the statistics information, it contains:
1298     - "rd_bytes": bytes read (json-int)
1299     - "wr_bytes": bytes written (json-int)
1300     - "rd_operations": read operations (json-int)
1301     - "wr_operations": write operations (json-int)
1302     - "flush_operations": cache flush operations (json-int)
1303     - "wr_total_time_ns": total time spend on writes in nano-seconds (json-int)
1304     - "rd_total_time_ns": total time spend on reads in nano-seconds (json-int)
1305     - "flush_total_time_ns": total time spend on cache flushes in nano-seconds (json-int)
1306     - "wr_highest_offset": Highest offset of a sector written since the
1307                            BlockDriverState has been opened (json-int)
1308 - "parent": Contains recursively the statistics of the underlying
1309             protocol (e.g. the host file for a qcow2 image). If there is
1310             no underlying protocol, this field is omitted
1311             (json-object, optional)
1312
1313 Example:
1314
1315 -> { "execute": "query-blockstats" }
1316 <- {
1317       "return":[
1318          {
1319             "device":"ide0-hd0",
1320             "parent":{
1321                "stats":{
1322                   "wr_highest_offset":3686448128,
1323                   "wr_bytes":9786368,
1324                   "wr_operations":751,
1325                   "rd_bytes":122567168,
1326                   "rd_operations":36772
1327                   "wr_total_times_ns":313253456
1328                   "rd_total_times_ns":3465673657
1329                   "flush_total_times_ns":49653
1330                   "flush_operations":61,
1331                }
1332             },
1333             "stats":{
1334                "wr_highest_offset":2821110784,
1335                "wr_bytes":9786368,
1336                "wr_operations":692,
1337                "rd_bytes":122739200,
1338                "rd_operations":36604
1339                "flush_operations":51,
1340                "wr_total_times_ns":313253456
1341                "rd_total_times_ns":3465673657
1342                "flush_total_times_ns":49653
1343             }
1344          },
1345          {
1346             "device":"ide1-cd0",
1347             "stats":{
1348                "wr_highest_offset":0,
1349                "wr_bytes":0,
1350                "wr_operations":0,
1351                "rd_bytes":0,
1352                "rd_operations":0
1353                "flush_operations":0,
1354                "wr_total_times_ns":0
1355                "rd_total_times_ns":0
1356                "flush_total_times_ns":0
1357             }
1358          },
1359          {
1360             "device":"floppy0",
1361             "stats":{
1362                "wr_highest_offset":0,
1363                "wr_bytes":0,
1364                "wr_operations":0,
1365                "rd_bytes":0,
1366                "rd_operations":0
1367                "flush_operations":0,
1368                "wr_total_times_ns":0
1369                "rd_total_times_ns":0
1370                "flush_total_times_ns":0
1371             }
1372          },
1373          {
1374             "device":"sd0",
1375             "stats":{
1376                "wr_highest_offset":0,
1377                "wr_bytes":0,
1378                "wr_operations":0,
1379                "rd_bytes":0,
1380                "rd_operations":0
1381                "flush_operations":0,
1382                "wr_total_times_ns":0
1383                "rd_total_times_ns":0
1384                "flush_total_times_ns":0
1385             }
1386          }
1387       ]
1388    }
1389
1390 EQMP
1391
1392     {
1393         .name       = "query-blockstats",
1394         .args_type  = "",
1395         .mhandler.cmd_new = qmp_marshal_input_query_blockstats,
1396     },
1397
1398 SQMP
1399 query-cpus
1400 ----------
1401
1402 Show CPU information.
1403
1404 Return a json-array. Each CPU is represented by a json-object, which contains:
1405
1406 - "CPU": CPU index (json-int)
1407 - "current": true if this is the current CPU, false otherwise (json-bool)
1408 - "halted": true if the cpu is halted, false otherwise (json-bool)
1409 - Current program counter. The key's name depends on the architecture:
1410      "pc": i386/x86_64 (json-int)
1411      "nip": PPC (json-int)
1412      "pc" and "npc": sparc (json-int)
1413      "PC": mips (json-int)
1414 - "thread_id": ID of the underlying host thread (json-int)
1415
1416 Example:
1417
1418 -> { "execute": "query-cpus" }
1419 <- {
1420       "return":[
1421          {
1422             "CPU":0,
1423             "current":true,
1424             "halted":false,
1425             "pc":3227107138
1426             "thread_id":3134
1427          },
1428          {
1429             "CPU":1,
1430             "current":false,
1431             "halted":true,
1432             "pc":7108165
1433             "thread_id":3135
1434          }
1435       ]
1436    }
1437
1438 EQMP
1439
1440     {
1441         .name       = "query-cpus",
1442         .args_type  = "",
1443         .mhandler.cmd_new = qmp_marshal_input_query_cpus,
1444     },
1445
1446 SQMP
1447 query-pci
1448 ---------
1449
1450 PCI buses and devices information.
1451
1452 The returned value is a json-array of all buses. Each bus is represented by
1453 a json-object, which has a key with a json-array of all PCI devices attached
1454 to it. Each device is represented by a json-object.
1455
1456 The bus json-object contains the following:
1457
1458 - "bus": bus number (json-int)
1459 - "devices": a json-array of json-objects, each json-object represents a
1460              PCI device
1461
1462 The PCI device json-object contains the following:
1463
1464 - "bus": identical to the parent's bus number (json-int)
1465 - "slot": slot number (json-int)
1466 - "function": function number (json-int)
1467 - "class_info": a json-object containing:
1468      - "desc": device class description (json-string, optional)
1469      - "class": device class number (json-int)
1470 - "id": a json-object containing:
1471      - "device": device ID (json-int)
1472      - "vendor": vendor ID (json-int)
1473 - "irq": device's IRQ if assigned (json-int, optional)
1474 - "qdev_id": qdev id string (json-string)
1475 - "pci_bridge": It's a json-object, only present if this device is a
1476                 PCI bridge, contains:
1477      - "bus": bus number (json-int)
1478      - "secondary": secondary bus number (json-int)
1479      - "subordinate": subordinate bus number (json-int)
1480      - "io_range": I/O memory range information, a json-object with the
1481                    following members:
1482                  - "base": base address, in bytes (json-int)
1483                  - "limit": limit address, in bytes (json-int)
1484      - "memory_range": memory range information, a json-object with the
1485                        following members:
1486                  - "base": base address, in bytes (json-int)
1487                  - "limit": limit address, in bytes (json-int)
1488      - "prefetchable_range": Prefetchable memory range information, a
1489                              json-object with the following members:
1490                  - "base": base address, in bytes (json-int)
1491                  - "limit": limit address, in bytes (json-int)
1492      - "devices": a json-array of PCI devices if there's any attached, each
1493                   each element is represented by a json-object, which contains
1494                   the same members of the 'PCI device json-object' described
1495                   above (optional)
1496 - "regions": a json-array of json-objects, each json-object represents a
1497              memory region of this device
1498
1499 The memory range json-object contains the following:
1500
1501 - "base": base memory address (json-int)
1502 - "limit": limit value (json-int)
1503
1504 The region json-object can be an I/O region or a memory region, an I/O region
1505 json-object contains the following:
1506
1507 - "type": "io" (json-string, fixed)
1508 - "bar": BAR number (json-int)
1509 - "address": memory address (json-int)
1510 - "size": memory size (json-int)
1511
1512 A memory region json-object contains the following:
1513
1514 - "type": "memory" (json-string, fixed)
1515 - "bar": BAR number (json-int)
1516 - "address": memory address (json-int)
1517 - "size": memory size (json-int)
1518 - "mem_type_64": true or false (json-bool)
1519 - "prefetch": true or false (json-bool)
1520
1521 Example:
1522
1523 -> { "execute": "query-pci" }
1524 <- {
1525       "return":[
1526          {
1527             "bus":0,
1528             "devices":[
1529                {
1530                   "bus":0,
1531                   "qdev_id":"",
1532                   "slot":0,
1533                   "class_info":{
1534                      "class":1536,
1535                      "desc":"Host bridge"
1536                   },
1537                   "id":{
1538                      "device":32902,
1539                      "vendor":4663
1540                   },
1541                   "function":0,
1542                   "regions":[
1543
1544                   ]
1545                },
1546                {
1547                   "bus":0,
1548                   "qdev_id":"",
1549                   "slot":1,
1550                   "class_info":{
1551                      "class":1537,
1552                      "desc":"ISA bridge"
1553                   },
1554                   "id":{
1555                      "device":32902,
1556                      "vendor":28672
1557                   },
1558                   "function":0,
1559                   "regions":[
1560
1561                   ]
1562                },
1563                {
1564                   "bus":0,
1565                   "qdev_id":"",
1566                   "slot":1,
1567                   "class_info":{
1568                      "class":257,
1569                      "desc":"IDE controller"
1570                   },
1571                   "id":{
1572                      "device":32902,
1573                      "vendor":28688
1574                   },
1575                   "function":1,
1576                   "regions":[
1577                      {
1578                         "bar":4,
1579                         "size":16,
1580                         "address":49152,
1581                         "type":"io"
1582                      }
1583                   ]
1584                },
1585                {
1586                   "bus":0,
1587                   "qdev_id":"",
1588                   "slot":2,
1589                   "class_info":{
1590                      "class":768,
1591                      "desc":"VGA controller"
1592                   },
1593                   "id":{
1594                      "device":4115,
1595                      "vendor":184
1596                   },
1597                   "function":0,
1598                   "regions":[
1599                      {
1600                         "prefetch":true,
1601                         "mem_type_64":false,
1602                         "bar":0,
1603                         "size":33554432,
1604                         "address":4026531840,
1605                         "type":"memory"
1606                      },
1607                      {
1608                         "prefetch":false,
1609                         "mem_type_64":false,
1610                         "bar":1,
1611                         "size":4096,
1612                         "address":4060086272,
1613                         "type":"memory"
1614                      },
1615                      {
1616                         "prefetch":false,
1617                         "mem_type_64":false,
1618                         "bar":6,
1619                         "size":65536,
1620                         "address":-1,
1621                         "type":"memory"
1622                      }
1623                   ]
1624                },
1625                {
1626                   "bus":0,
1627                   "qdev_id":"",
1628                   "irq":11,
1629                   "slot":4,
1630                   "class_info":{
1631                      "class":1280,
1632                      "desc":"RAM controller"
1633                   },
1634                   "id":{
1635                      "device":6900,
1636                      "vendor":4098
1637                   },
1638                   "function":0,
1639                   "regions":[
1640                      {
1641                         "bar":0,
1642                         "size":32,
1643                         "address":49280,
1644                         "type":"io"
1645                      }
1646                   ]
1647                }
1648             ]
1649          }
1650       ]
1651    }
1652
1653 Note: This example has been shortened as the real response is too long.
1654
1655 EQMP
1656
1657     {
1658         .name       = "query-pci",
1659         .args_type  = "",
1660         .mhandler.cmd_new = qmp_marshal_input_query_pci,
1661     },
1662
1663 SQMP
1664 query-kvm
1665 ---------
1666
1667 Show KVM information.
1668
1669 Return a json-object with the following information:
1670
1671 - "enabled": true if KVM support is enabled, false otherwise (json-bool)
1672 - "present": true if QEMU has KVM support, false otherwise (json-bool)
1673
1674 Example:
1675
1676 -> { "execute": "query-kvm" }
1677 <- { "return": { "enabled": true, "present": true } }
1678
1679 EQMP
1680
1681     {
1682         .name       = "query-kvm",
1683         .args_type  = "",
1684         .mhandler.cmd_new = qmp_marshal_input_query_kvm,
1685     },
1686
1687 SQMP
1688 query-status
1689 ------------
1690
1691 Return a json-object with the following information:
1692
1693 - "running": true if the VM is running, or false if it is paused (json-bool)
1694 - "singlestep": true if the VM is in single step mode,
1695                 false otherwise (json-bool)
1696 - "status": one of the following values (json-string)
1697     "debug" - QEMU is running on a debugger
1698     "inmigrate" - guest is paused waiting for an incoming migration
1699     "internal-error" - An internal error that prevents further guest
1700     execution has occurred
1701     "io-error" - the last IOP has failed and the device is configured
1702     to pause on I/O errors
1703     "paused" - guest has been paused via the 'stop' command
1704     "postmigrate" - guest is paused following a successful 'migrate'
1705     "prelaunch" - QEMU was started with -S and guest has not started
1706     "finish-migrate" - guest is paused to finish the migration process
1707     "restore-vm" - guest is paused to restore VM state
1708     "running" - guest is actively running
1709     "save-vm" - guest is paused to save the VM state
1710     "shutdown" - guest is shut down (and -no-shutdown is in use)
1711     "watchdog" - the watchdog action is configured to pause and
1712      has been triggered
1713
1714 Example:
1715
1716 -> { "execute": "query-status" }
1717 <- { "return": { "running": true, "singlestep": false, "status": "running" } }
1718
1719 EQMP
1720
1721     {
1722         .name       = "query-status",
1723         .args_type  = "",
1724         .mhandler.cmd_new = qmp_marshal_input_query_status,
1725     },
1726
1727 SQMP
1728 query-mice
1729 ----------
1730
1731 Show VM mice information.
1732
1733 Each mouse is represented by a json-object, the returned value is a json-array
1734 of all mice.
1735
1736 The mouse json-object contains the following:
1737
1738 - "name": mouse's name (json-string)
1739 - "index": mouse's index (json-int)
1740 - "current": true if this mouse is receiving events, false otherwise (json-bool)
1741 - "absolute": true if the mouse generates absolute input events (json-bool)
1742
1743 Example:
1744
1745 -> { "execute": "query-mice" }
1746 <- {
1747       "return":[
1748          {
1749             "name":"QEMU Microsoft Mouse",
1750             "index":0,
1751             "current":false,
1752             "absolute":false
1753          },
1754          {
1755             "name":"QEMU PS/2 Mouse",
1756             "index":1,
1757             "current":true,
1758             "absolute":true
1759          }
1760       ]
1761    }
1762
1763 EQMP
1764
1765     {
1766         .name       = "query-mice",
1767         .args_type  = "",
1768         .mhandler.cmd_new = qmp_marshal_input_query_mice,
1769     },
1770
1771 SQMP
1772 query-vnc
1773 ---------
1774
1775 Show VNC server information.
1776
1777 Return a json-object with server information. Connected clients are returned
1778 as a json-array of json-objects.
1779
1780 The main json-object contains the following:
1781
1782 - "enabled": true or false (json-bool)
1783 - "host": server's IP address (json-string)
1784 - "family": address family (json-string)
1785          - Possible values: "ipv4", "ipv6", "unix", "unknown"
1786 - "service": server's port number (json-string)
1787 - "auth": authentication method (json-string)
1788          - Possible values: "invalid", "none", "ra2", "ra2ne", "sasl", "tight",
1789                             "tls", "ultra", "unknown", "vencrypt", "vencrypt",
1790                             "vencrypt+plain", "vencrypt+tls+none",
1791                             "vencrypt+tls+plain", "vencrypt+tls+sasl",
1792                             "vencrypt+tls+vnc", "vencrypt+x509+none",
1793                             "vencrypt+x509+plain", "vencrypt+x509+sasl",
1794                             "vencrypt+x509+vnc", "vnc"
1795 - "clients": a json-array of all connected clients
1796
1797 Clients are described by a json-object, each one contain the following:
1798
1799 - "host": client's IP address (json-string)
1800 - "family": address family (json-string)
1801          - Possible values: "ipv4", "ipv6", "unix", "unknown"
1802 - "service": client's port number (json-string)
1803 - "x509_dname": TLS dname (json-string, optional)
1804 - "sasl_username": SASL username (json-string, optional)
1805
1806 Example:
1807
1808 -> { "execute": "query-vnc" }
1809 <- {
1810       "return":{
1811          "enabled":true,
1812          "host":"0.0.0.0",
1813          "service":"50402",
1814          "auth":"vnc",
1815          "family":"ipv4",
1816          "clients":[
1817             {
1818                "host":"127.0.0.1",
1819                "service":"50401",
1820                "family":"ipv4"
1821             }
1822          ]
1823       }
1824    }
1825
1826 EQMP
1827
1828     {
1829         .name       = "query-vnc",
1830         .args_type  = "",
1831         .mhandler.cmd_new = qmp_marshal_input_query_vnc,
1832     },
1833
1834 SQMP
1835 query-spice
1836 -----------
1837
1838 Show SPICE server information.
1839
1840 Return a json-object with server information. Connected clients are returned
1841 as a json-array of json-objects.
1842
1843 The main json-object contains the following:
1844
1845 - "enabled": true or false (json-bool)
1846 - "host": server's IP address (json-string)
1847 - "port": server's port number (json-int, optional)
1848 - "tls-port": server's port number (json-int, optional)
1849 - "auth": authentication method (json-string)
1850          - Possible values: "none", "spice"
1851 - "channels": a json-array of all active channels clients
1852
1853 Channels are described by a json-object, each one contain the following:
1854
1855 - "host": client's IP address (json-string)
1856 - "family": address family (json-string)
1857          - Possible values: "ipv4", "ipv6", "unix", "unknown"
1858 - "port": client's port number (json-string)
1859 - "connection-id": spice connection id.  All channels with the same id
1860                    belong to the same spice session (json-int)
1861 - "channel-type": channel type.  "1" is the main control channel, filter for
1862                   this one if you want track spice sessions only (json-int)
1863 - "channel-id": channel id.  Usually "0", might be different needed when
1864                 multiple channels of the same type exist, such as multiple
1865                 display channels in a multihead setup (json-int)
1866 - "tls": whevener the channel is encrypted (json-bool)
1867
1868 Example:
1869
1870 -> { "execute": "query-spice" }
1871 <- {
1872       "return": {
1873          "enabled": true,
1874          "auth": "spice",
1875          "port": 5920,
1876          "tls-port": 5921,
1877          "host": "0.0.0.0",
1878          "channels": [
1879             {
1880                "port": "54924",
1881                "family": "ipv4",
1882                "channel-type": 1,
1883                "connection-id": 1804289383,
1884                "host": "127.0.0.1",
1885                "channel-id": 0,
1886                "tls": true
1887             },
1888             {
1889                "port": "36710",
1890                "family": "ipv4",
1891                "channel-type": 4,
1892                "connection-id": 1804289383,
1893                "host": "127.0.0.1",
1894                "channel-id": 0,
1895                "tls": false
1896             },
1897             [ ... more channels follow ... ]
1898          ]
1899       }
1900    }
1901
1902 EQMP
1903
1904 #if defined(CONFIG_SPICE)
1905     {
1906         .name       = "query-spice",
1907         .args_type  = "",
1908         .mhandler.cmd_new = qmp_marshal_input_query_spice,
1909     },
1910 #endif
1911
1912 SQMP
1913 query-name
1914 ----------
1915
1916 Show VM name.
1917
1918 Return a json-object with the following information:
1919
1920 - "name": VM's name (json-string, optional)
1921
1922 Example:
1923
1924 -> { "execute": "query-name" }
1925 <- { "return": { "name": "qemu-name" } }
1926
1927 EQMP
1928
1929     {
1930         .name       = "query-name",
1931         .args_type  = "",
1932         .mhandler.cmd_new = qmp_marshal_input_query_name,
1933     },
1934
1935 SQMP
1936 query-uuid
1937 ----------
1938
1939 Show VM UUID.
1940
1941 Return a json-object with the following information:
1942
1943 - "UUID": Universally Unique Identifier (json-string)
1944
1945 Example:
1946
1947 -> { "execute": "query-uuid" }
1948 <- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } }
1949
1950 EQMP
1951
1952     {
1953         .name       = "query-uuid",
1954         .args_type  = "",
1955         .mhandler.cmd_new = qmp_marshal_input_query_uuid,
1956     },
1957
1958 SQMP
1959 query-migrate
1960 -------------
1961
1962 Migration status.
1963
1964 Return a json-object. If migration is active there will be another json-object
1965 with RAM migration status and if block migration is active another one with
1966 block migration status.
1967
1968 The main json-object contains the following:
1969
1970 - "status": migration status (json-string)
1971      - Possible values: "active", "completed", "failed", "cancelled"
1972 - "ram": only present if "status" is "active", it is a json-object with the
1973   following RAM information (in bytes):
1974          - "transferred": amount transferred (json-int)
1975          - "remaining": amount remaining (json-int)
1976          - "total": total (json-int)
1977 - "disk": only present if "status" is "active" and it is a block migration,
1978   it is a json-object with the following disk information (in bytes):
1979          - "transferred": amount transferred (json-int)
1980          - "remaining": amount remaining (json-int)
1981          - "total": total (json-int)
1982
1983 Examples:
1984
1985 1. Before the first migration
1986
1987 -> { "execute": "query-migrate" }
1988 <- { "return": {} }
1989
1990 2. Migration is done and has succeeded
1991
1992 -> { "execute": "query-migrate" }
1993 <- { "return": { "status": "completed" } }
1994
1995 3. Migration is done and has failed
1996
1997 -> { "execute": "query-migrate" }
1998 <- { "return": { "status": "failed" } }
1999
2000 4. Migration is being performed and is not a block migration:
2001
2002 -> { "execute": "query-migrate" }
2003 <- {
2004       "return":{
2005          "status":"active",
2006          "ram":{
2007             "transferred":123,
2008             "remaining":123,
2009             "total":246
2010          }
2011       }
2012    }
2013
2014 5. Migration is being performed and is a block migration:
2015
2016 -> { "execute": "query-migrate" }
2017 <- {
2018       "return":{
2019          "status":"active",
2020          "ram":{
2021             "total":1057024,
2022             "remaining":1053304,
2023             "transferred":3720
2024          },
2025          "disk":{
2026             "total":20971520,
2027             "remaining":20880384,
2028             "transferred":91136
2029          }
2030       }
2031    }
2032
2033 EQMP
2034
2035     {
2036         .name       = "query-migrate",
2037         .args_type  = "",
2038         .mhandler.cmd_new = qmp_marshal_input_query_migrate,
2039     },
2040
2041 SQMP
2042 query-balloon
2043 -------------
2044
2045 Show balloon information.
2046
2047 Make an asynchronous request for balloon info. When the request completes a
2048 json-object will be returned containing the following data:
2049
2050 - "actual": current balloon value in bytes (json-int)
2051 - "mem_swapped_in": Amount of memory swapped in bytes (json-int, optional)
2052 - "mem_swapped_out": Amount of memory swapped out in bytes (json-int, optional)
2053 - "major_page_faults": Number of major faults (json-int, optional)
2054 - "minor_page_faults": Number of minor faults (json-int, optional)
2055 - "free_mem": Total amount of free and unused memory in
2056               bytes (json-int, optional)
2057 - "total_mem": Total amount of available memory in bytes (json-int, optional)
2058
2059 Example:
2060
2061 -> { "execute": "query-balloon" }
2062 <- {
2063       "return":{
2064          "actual":1073741824,
2065          "mem_swapped_in":0,
2066          "mem_swapped_out":0,
2067          "major_page_faults":142,
2068          "minor_page_faults":239245,
2069          "free_mem":1014185984,
2070          "total_mem":1044668416
2071       }
2072    }
2073
2074 EQMP
2075
2076     {
2077         .name       = "query-balloon",
2078         .args_type  = "",
2079         .mhandler.cmd_new = qmp_marshal_input_query_balloon,
2080     },
2081
2082     {
2083         .name       = "query-block-jobs",
2084         .args_type  = "",
2085         .mhandler.cmd_new = qmp_marshal_input_query_block_jobs,
2086     },
2087
2088     {
2089         .name       = "qom-list",
2090         .args_type  = "path:s",
2091         .mhandler.cmd_new = qmp_marshal_input_qom_list,
2092     },
2093
2094     {
2095         .name       = "qom-set",
2096         .args_type  = "path:s,property:s,opts:O",
2097         .mhandler.cmd_new = qmp_qom_set,
2098     },
2099
2100     {
2101         .name       = "qom-get",
2102         .args_type  = "path:s,property:s",
2103         .mhandler.cmd_new = qmp_qom_get,
2104     },
2105
2106     {
2107         .name       = "change-vnc-password",
2108         .args_type  = "password:s",
2109         .mhandler.cmd_new = qmp_marshal_input_change_vnc_password,
2110     },
2111     {
2112         .name       = "qom-list-types",
2113         .args_type  = "implements:s?,abstract:b?",
2114         .mhandler.cmd_new = qmp_marshal_input_qom_list_types,
2115     },