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       = "xen-save-devices-state",
 448         .args_type  = "filename:F",
 449     .mhandler.cmd_new = qmp_marshal_input_xen_save_devices_state,
 450     },
 451
 452 SQMP
 453 xen-save-devices-state
 454 -------
 455
 456 Save the state of all devices to file. The RAM and the block devices
 457 of the VM are not saved by this command.
 458
 459 Arguments:
 460
 461 - "filename": the file to save the state of the devices to as binary
 462 data. See xen-save-devices-state.txt for a description of the binary
 463 format.
 464
 465 Example:
 466
 467 -> { "execute": "xen-save-devices-state",
 468      "arguments": { "filename": "/tmp/save" } }
 469 <- { "return": {} }
 470
 471 EQMP
 472
 473     {
 474         .name       = "migrate",
 475         .args_type  = "detach:-d,blk:-b,inc:-i,uri:s",
 476         .mhandler.cmd_new = qmp_marshal_input_migrate,
 477     },
 478
 479 SQMP
 480 migrate
 481 -------
 482
 483 Migrate to URI.
 484
 485 Arguments:
 486
 487 - "blk": block migration, full disk copy (json-bool, optional)
 488 - "inc": incremental disk copy (json-bool, optional)
 489 - "uri": Destination URI (json-string)
 490
 491 Example:
 492
 493 -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
 494 <- { "return": {} }
 495
 496 Notes:
 497
 498 (1) The 'query-migrate' command should be used to check migration's progress
 499     and final result (this information is provided by the 'status' member)
 500 (2) All boolean arguments default to false
 501 (3) The user Monitor's "detach" argument is invalid in QMP and should not
 502     be used
 503
 504 EQMP
 505
 506     {
 507         .name       = "migrate_cancel",
 508         .args_type  = "",
 509         .mhandler.cmd_new = qmp_marshal_input_migrate_cancel,
 510     },
 511
 512 SQMP
 513 migrate_cancel
 514 --------------
 515
 516 Cancel the current migration.
 517
 518 Arguments: None.
 519
 520 Example:
 521
 522 -> { "execute": "migrate_cancel" }
 523 <- { "return": {} }
 524
 525 EQMP
 526
 527     {
 528         .name       = "migrate_set_speed",
 529         .args_type  = "value:o",
 530         .mhandler.cmd_new = qmp_marshal_input_migrate_set_speed,
 531     },
 532
 533 SQMP
 534 migrate_set_speed
 535 -----------------
 536
 537 Set maximum speed for migrations.
 538
 539 Arguments:
 540
 541 - "value": maximum speed, in bytes per second (json-int)
 542
 543 Example:
 544
 545 -> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } }
 546 <- { "return": {} }
 547
 548 EQMP
 549
 550     {
 551         .name       = "migrate_set_downtime",
 552         .args_type  = "value:T",
 553         .mhandler.cmd_new = qmp_marshal_input_migrate_set_downtime,
 554     },
 555
 556 SQMP
 557 migrate_set_downtime
 558 --------------------
 559
 560 Set maximum tolerated downtime (in seconds) for migrations.
 561
 562 Arguments:
 563
 564 - "value": maximum downtime (json-number)
 565
 566 Example:
 567
 568 -> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } }
 569 <- { "return": {} }
 570
 571 EQMP
 572
 573     {
 574         .name       = "client_migrate_info",
 575         .args_type  = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
 576         .params     = "protocol hostname port tls-port cert-subject",
 577         .help       = "send migration info to spice/vnc client",
 578         .user_print = monitor_user_noop,
 579         .mhandler.cmd_async = client_migrate_info,
 580         .flags      = MONITOR_CMD_ASYNC,
 581     },
 582
 583 SQMP
 584 client_migrate_info
 585 ------------------
 586
 587 Set the spice/vnc connection info for the migration target.  The spice/vnc
 588 server will ask the spice/vnc client to automatically reconnect using the
 589 new parameters (if specified) once the vm migration finished successfully.
 590
 591 Arguments:
 592
 593 - "protocol":     protocol: "spice" or "vnc" (json-string)
 594 - "hostname":     migration target hostname (json-string)
 595 - "port":         spice/vnc tcp port for plaintext channels (json-int, optional)
 596 - "tls-port":     spice tcp port for tls-secured channels (json-int, optional)
 597 - "cert-subject": server certificate subject (json-string, optional)
 598
 599 Example:
 600
 601 -> { "execute": "client_migrate_info",
 602      "arguments": { "protocol": "spice",
 603                     "hostname": "virt42.lab.kraxel.org",
 604                     "port": 1234 } }
 605 <- { "return": {} }
 606
 607 EQMP
 608
 609     {
 610         .name       = "netdev_add",
 611         .args_type  = "netdev:O",
 612         .params     = "[user|tap|socket],id=str[,prop=value][,...]",
 613         .help       = "add host network device",
 614         .user_print = monitor_user_noop,
 615         .mhandler.cmd_new = do_netdev_add,
 616     },
 617
 618 SQMP
 619 netdev_add
 620 ----------
 621
 622 Add host network device.
 623
 624 Arguments:
 625
 626 - "type": the device type, "tap", "user", ... (json-string)
 627 - "id": the device's ID, must be unique (json-string)
 628 - device options
 629
 630 Example:
 631
 632 -> { "execute": "netdev_add", "arguments": { "type": "user", "id": "netdev1" } }
 633 <- { "return": {} }
 634
 635 Note: The supported device options are the same ones supported by the '-net'
 636       command-line argument, which are listed in the '-help' output or QEMU's
 637       manual
 638
 639 EQMP
 640
 641     {
 642         .name       = "netdev_del",
 643         .args_type  = "id:s",
 644         .params     = "id",
 645         .help       = "remove host network device",
 646         .user_print = monitor_user_noop,
 647         .mhandler.cmd_new = do_netdev_del,
 648     },
 649
 650 SQMP
 651 netdev_del
 652 ----------
 653
 654 Remove host network device.
 655
 656 Arguments:
 657
 658 - "id": the device's ID, must be unique (json-string)
 659
 660 Example:
 661
 662 -> { "execute": "netdev_del", "arguments": { "id": "netdev1" } }
 663 <- { "return": {} }
 664
 665
 666 EQMP
 667
 668     {
 669         .name       = "block_resize",
 670         .args_type  = "device:B,size:o",
 671         .mhandler.cmd_new = qmp_marshal_input_block_resize,
 672     },
 673
 674 SQMP
 675 block_resize
 676 ------------
 677
 678 Resize a block image while a guest is running.
 679
 680 Arguments:
 681
 682 - "device": the device's ID, must be unique (json-string)
 683 - "size": new size
 684
 685 Example:
 686
 687 -> { "execute": "block_resize", "arguments": { "device": "scratch", "size": 1073741824 } }
 688 <- { "return": {} }
 689
 690 EQMP
 691
 692     {
 693         .name       = "block_stream",
 694         .args_type  = "device:B,base:s?",
 695         .mhandler.cmd_new = qmp_marshal_input_block_stream,
 696     },
 697
 698     {
 699         .name       = "block_job_set_speed",
 700         .args_type  = "device:B,value:o",
 701         .mhandler.cmd_new = qmp_marshal_input_block_job_set_speed,
 702     },
 703
 704     {
 705         .name       = "block_job_cancel",
 706         .args_type  = "device:B",
 707         .mhandler.cmd_new = qmp_marshal_input_block_job_cancel,
 708     },
 709     {
 710         .name       = "transaction",
 711         .args_type  = "actions:q",
 712         .mhandler.cmd_new = qmp_marshal_input_transaction,
 713     },
 714
 715 SQMP
 716 transaction
 717 -----------
 718
 719 Atomically operate on one or more block devices.  The only supported
 720 operation for now is snapshotting.  If there is any failure performing
 721 any of the operations, all snapshots for the group are abandoned, and
 722 the original disks pre-snapshot attempt are used.
 723
 724 A list of dictionaries is accepted, that contains the actions to be performed.
 725 For snapshots this is the device, the file to use for the new snapshot,
 726 and the format.  The default format, if not specified, is qcow2.
 727
 728 Each new snapshot defaults to being created by QEMU (wiping any
 729 contents if the file already exists), but it is also possible to reuse
 730 an externally-created file.  In the latter case, you should ensure that
 731 the new image file has the same contents as the current one; QEMU cannot
 732 perform any meaningful check.  Typically this is achieved by using the
 733 current image file as the backing file for the new image.
 734
 735 Arguments:
 736
 737 actions array:
 738     - "type": the operation to perform.  The only supported
 739       value is "blockdev-snapshot-sync". (json-string)
 740     - "data": a dictionary.  The contents depend on the value
 741       of "type".  When "type" is "blockdev-snapshot-sync":
 742       - "device": device name to snapshot (json-string)
 743       - "snapshot-file": name of new image file (json-string)
 744       - "format": format of new image (json-string, optional)
 745       - "mode": whether and how QEMU should create the snapshot file
 746         (NewImageMode, optional, default "absolute-paths")
 747
 748 Example:
 749
 750 -> { "execute": "transaction",
 751      "arguments": { "actions": [
 752          { 'type': 'blockdev-snapshot-sync', 'data' : { "device": "ide-hd0",
 753                                          "snapshot-file": "/some/place/my-image",
 754                                          "format": "qcow2" } },
 755          { 'type': 'blockdev-snapshot-sync', 'data' : { "device": "ide-hd1",
 756                                          "snapshot-file": "/some/place/my-image2",
 757                                          "mode": "existing",
 758                                          "format": "qcow2" } } ] } }
 759 <- { "return": {} }
 760
 761 EQMP
 762
 763     {
 764         .name       = "blockdev-snapshot-sync",
 765         .args_type  = "device:B,snapshot-file:s,format:s?",
 766         .mhandler.cmd_new = qmp_marshal_input_blockdev_snapshot_sync,
 767     },
 768
 769 SQMP
 770 blockdev-snapshot-sync
 771 ----------------------
 772
 773 Synchronous snapshot of a block device. snapshot-file specifies the
 774 target of the new image. If the file exists, or if it is a device, the
 775 snapshot will be created in the existing file/device. If does not
 776 exist, a new file will be created. format specifies the format of the
 777 snapshot image, default is qcow2.
 778
 779 Arguments:
 780
 781 - "device": device name to snapshot (json-string)
 782 - "snapshot-file": name of new image file (json-string)
 783 - "mode": whether and how QEMU should create the snapshot file
 784   (NewImageMode, optional, default "absolute-paths")
 785 - "format": format of new image (json-string, optional)
 786
 787 Example:
 788
 789 -> { "execute": "blockdev-snapshot-sync", "arguments": { "device": "ide-hd0",
 790                                                          "snapshot-file":
 791                                                         "/some/place/my-image",
 792                                                         "format": "qcow2" } }
 793 <- { "return": {} }
 794
 795 EQMP
 796
 797     {
 798         .name       = "balloon",
 799         .args_type  = "value:M",
 800         .mhandler.cmd_new = qmp_marshal_input_balloon,
 801     },
 802
 803 SQMP
 804 balloon
 805 -------
 806
 807 Request VM to change its memory allocation (in bytes).
 808
 809 Arguments:
 810
 811 - "value": New memory allocation (json-int)
 812
 813 Example:
 814
 815 -> { "execute": "balloon", "arguments": { "value": 536870912 } }
 816 <- { "return": {} }
 817
 818 EQMP
 819
 820     {
 821         .name       = "set_link",
 822         .args_type  = "name:s,up:b",
 823         .mhandler.cmd_new = qmp_marshal_input_set_link,
 824     },
 825
 826 SQMP
 827 set_link
 828 --------
 829
 830 Change the link status of a network adapter.
 831
 832 Arguments:
 833
 834 - "name": network device name (json-string)
 835 - "up": status is up (json-bool)
 836
 837 Example:
 838
 839 -> { "execute": "set_link", "arguments": { "name": "e1000.0", "up": false } }
 840 <- { "return": {} }
 841
 842 EQMP
 843
 844     {
 845         .name       = "getfd",
 846         .args_type  = "fdname:s",
 847         .params     = "getfd name",
 848         .help       = "receive a file descriptor via SCM rights and assign it a name",
 849         .user_print = monitor_user_noop,
 850         .mhandler.cmd_new = do_getfd,
 851     },
 852
 853 SQMP
 854 getfd
 855 -----
 856
 857 Receive a file descriptor via SCM rights and assign it a name.
 858
 859 Arguments:
 860
 861 - "fdname": file descriptor name (json-string)
 862
 863 Example:
 864
 865 -> { "execute": "getfd", "arguments": { "fdname": "fd1" } }
 866 <- { "return": {} }
 867
 868 EQMP
 869
 870     {
 871         .name       = "closefd",
 872         .args_type  = "fdname:s",
 873         .params     = "closefd name",
 874         .help       = "close a file descriptor previously passed via SCM rights",
 875         .user_print = monitor_user_noop,
 876         .mhandler.cmd_new = do_closefd,
 877     },
 878
 879 SQMP
 880 closefd
 881 -------
 882
 883 Close a file descriptor previously passed via SCM rights.
 884
 885 Arguments:
 886
 887 - "fdname": file descriptor name (json-string)
 888
 889 Example:
 890
 891 -> { "execute": "closefd", "arguments": { "fdname": "fd1" } }
 892 <- { "return": {} }
 893
 894 EQMP
 895
 896     {
 897         .name       = "block_passwd",
 898         .args_type  = "device:B,password:s",
 899         .mhandler.cmd_new = qmp_marshal_input_block_passwd,
 900     },
 901
 902 SQMP
 903 block_passwd
 904 ------------
 905
 906 Set the password of encrypted block devices.
 907
 908 Arguments:
 909
 910 - "device": device name (json-string)
 911 - "password": password (json-string)
 912
 913 Example:
 914
 915 -> { "execute": "block_passwd", "arguments": { "device": "ide0-hd0",
 916                                                "password": "12345" } }
 917 <- { "return": {} }
 918
 919 EQMP
 920
 921     {
 922         .name       = "block_set_io_throttle",
 923         .args_type  = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
 924         .mhandler.cmd_new = qmp_marshal_input_block_set_io_throttle,
 925     },
 926
 927 SQMP
 928 block_set_io_throttle
 929 ------------
 930
 931 Change I/O throttle limits for a block drive.
 932
 933 Arguments:
 934
 935 - "device": device name (json-string)
 936 - "bps":  total throughput limit in bytes per second(json-int)
 937 - "bps_rd":  read throughput limit in bytes per second(json-int)
 938 - "bps_wr":  read throughput limit in bytes per second(json-int)
 939 - "iops":  total I/O operations per second(json-int)
 940 - "iops_rd":  read I/O operations per second(json-int)
 941 - "iops_wr":  write I/O operations per second(json-int)
 942
 943 Example:
 944
 945 -> { "execute": "block_set_io_throttle", "arguments": { "device": "virtio0",
 946                                                "bps": "1000000",
 947                                                "bps_rd": "0",
 948                                                "bps_wr": "0",
 949                                                "iops": "0",
 950                                                "iops_rd": "0",
 951                                                "iops_wr": "0" } }
 952 <- { "return": {} }
 953
 954 EQMP
 955
 956     {
 957         .name       = "set_password",
 958         .args_type  = "protocol:s,password:s,connected:s?",
 959         .mhandler.cmd_new = qmp_marshal_input_set_password,
 960     },
 961
 962 SQMP
 963 set_password
 964 ------------
 965
 966 Set the password for vnc/spice protocols.
 967
 968 Arguments:
 969
 970 - "protocol": protocol name (json-string)
 971 - "password": password (json-string)
 972 - "connected": [ keep | disconnect | fail ] (josn-string, optional)
 973
 974 Example:
 975
 976 -> { "execute": "set_password", "arguments": { "protocol": "vnc",
 977                                                "password": "secret" } }
 978 <- { "return": {} }
 979
 980 EQMP
 981
 982     {
 983         .name       = "expire_password",
 984         .args_type  = "protocol:s,time:s",
 985         .mhandler.cmd_new = qmp_marshal_input_expire_password,
 986     },
 987
 988 SQMP
 989 expire_password
 990 ---------------
 991
 992 Set the password expire time for vnc/spice protocols.
 993
 994 Arguments:
 995
 996 - "protocol": protocol name (json-string)
 997 - "time": [ now | never | +secs | secs ] (json-string)
 998
 999 Example:
1000
1001 -> { "execute": "expire_password", "arguments": { "protocol": "vnc",
1002                                                   "time": "+60" } }
1003 <- { "return": {} }
1004
1005 EQMP
1006
1007     {
1008         .name       = "add_client",
1009         .args_type  = "protocol:s,fdname:s,skipauth:b?,tls:b?",
1010         .params     = "protocol fdname skipauth tls",
1011         .help       = "add a graphics client",
1012         .user_print = monitor_user_noop,
1013         .mhandler.cmd_new = add_graphics_client,
1014     },
1015
1016 SQMP
1017 add_client
1018 ----------
1019
1020 Add a graphics client
1021
1022 Arguments:
1023
1024 - "protocol": protocol name (json-string)
1025 - "fdname": file descriptor name (json-string)
1026 - "skipauth": whether to skip authentication (json-bool, optional)
1027 - "tls": whether to perform TLS (json-bool, optional)
1028
1029 Example:
1030
1031 -> { "execute": "add_client", "arguments": { "protocol": "vnc",
1032                                              "fdname": "myclient" } }
1033 <- { "return": {} }
1034
1035 EQMP
1036     {
1037         .name       = "qmp_capabilities",
1038         .args_type  = "",
1039         .params     = "",
1040         .help       = "enable QMP capabilities",
1041         .user_print = monitor_user_noop,
1042         .mhandler.cmd_new = do_qmp_capabilities,
1043     },
1044
1045 SQMP
1046 qmp_capabilities
1047 ----------------
1048
1049 Enable QMP capabilities.
1050
1051 Arguments: None.
1052
1053 Example:
1054
1055 -> { "execute": "qmp_capabilities" }
1056 <- { "return": {} }
1057
1058 Note: This command must be issued before issuing any other command.
1059
1060 EQMP
1061
1062     {
1063         .name       = "human-monitor-command",
1064         .args_type  = "command-line:s,cpu-index:i?",
1065         .mhandler.cmd_new = qmp_marshal_input_human_monitor_command,
1066     },
1067
1068 SQMP
1069 human-monitor-command
1070 ---------------------
1071
1072 Execute a Human Monitor command.
1073
1074 Arguments:
1075
1076 - command-line: the command name and its arguments, just like the
1077                 Human Monitor's shell (json-string)
1078 - cpu-index: select the CPU number to be used by commands which access CPU
1079              data, like 'info registers'. The Monitor selects CPU 0 if this
1080              argument is not provided (json-int, optional)
1081
1082 Example:
1083
1084 -> { "execute": "human-monitor-command", "arguments": { "command-line": "info kvm" } }
1085 <- { "return": "kvm support: enabled\r\n" }
1086
1087 Notes:
1088
1089 (1) The Human Monitor is NOT an stable interface, this means that command
1090     names, arguments and responses can change or be removed at ANY time.
1091     Applications that rely on long term stability guarantees should NOT
1092     use this command
1093
1094 (2) Limitations:
1095
1096     o This command is stateless, this means that commands that depend
1097       on state information (such as getfd) might not work
1098
1099     o Commands that prompt the user for data (eg. 'cont' when the block
1100       device is encrypted) don't currently work
1101
1102 3. Query Commands
1103 =================
1104
1105 HXCOMM Each query command below is inside a SQMP/EQMP section, do NOT change
1106 HXCOMM this! We will possibly move query commands definitions inside those
1107 HXCOMM sections, just like regular commands.
1108
1109 EQMP
1110
1111 SQMP
1112 query-version
1113 -------------
1114
1115 Show QEMU version.
1116
1117 Return a json-object with the following information:
1118
1119 - "qemu": A json-object containing three integer values:
1120     - "major": QEMU's major version (json-int)
1121     - "minor": QEMU's minor version (json-int)
1122     - "micro": QEMU's micro version (json-int)
1123 - "package": package's version (json-string)
1124
1125 Example:
1126
1127 -> { "execute": "query-version" }
1128 <- {
1129       "return":{
1130          "qemu":{
1131             "major":0,
1132             "minor":11,
1133             "micro":5
1134          },
1135          "package":""
1136       }
1137    }
1138
1139 EQMP
1140
1141     {
1142         .name       = "query-version",
1143         .args_type  = "",
1144         .mhandler.cmd_new = qmp_marshal_input_query_version,
1145     },
1146
1147 SQMP
1148 query-commands
1149 --------------
1150
1151 List QMP available commands.
1152
1153 Each command is represented by a json-object, the returned value is a json-array
1154 of all commands.
1155
1156 Each json-object contain:
1157
1158 - "name": command's name (json-string)
1159
1160 Example:
1161
1162 -> { "execute": "query-commands" }
1163 <- {
1164       "return":[
1165          {
1166             "name":"query-balloon"
1167          },
1168          {
1169             "name":"system_powerdown"
1170          }
1171       ]
1172    }
1173
1174 Note: This example has been shortened as the real response is too long.
1175
1176 EQMP
1177
1178     {
1179         .name       = "query-commands",
1180         .args_type  = "",
1181         .mhandler.cmd_new = qmp_marshal_input_query_commands,
1182     },
1183
1184 SQMP
1185 query-chardev
1186 -------------
1187
1188 Each device is represented by a json-object. The returned value is a json-array
1189 of all devices.
1190
1191 Each json-object contain the following:
1192
1193 - "label": device's label (json-string)
1194 - "filename": device's file (json-string)
1195
1196 Example:
1197
1198 -> { "execute": "query-chardev" }
1199 <- {
1200       "return":[
1201          {
1202             "label":"monitor",
1203             "filename":"stdio"
1204          },
1205          {
1206             "label":"serial0",
1207             "filename":"vc"
1208          }
1209       ]
1210    }
1211
1212 EQMP
1213
1214     {
1215         .name       = "query-chardev",
1216         .args_type  = "",
1217         .mhandler.cmd_new = qmp_marshal_input_query_chardev,
1218     },
1219
1220 SQMP
1221 query-block
1222 -----------
1223
1224 Show the block devices.
1225
1226 Each block device information is stored in a json-object and the returned value
1227 is a json-array of all devices.
1228
1229 Each json-object contain the following:
1230
1231 - "device": device name (json-string)
1232 - "type": device type (json-string)
1233          - deprecated, retained for backward compatibility
1234          - Possible values: "unknown"
1235 - "removable": true if the device is removable, false otherwise (json-bool)
1236 - "locked": true if the device is locked, false otherwise (json-bool)
1237 - "tray-open": only present if removable, true if the device has a tray,
1238                and it is open (json-bool)
1239 - "inserted": only present if the device is inserted, it is a json-object
1240    containing the following:
1241          - "file": device file name (json-string)
1242          - "ro": true if read-only, false otherwise (json-bool)
1243          - "drv": driver format name (json-string)
1244              - Possible values: "blkdebug", "bochs", "cloop", "cow", "dmg",
1245                                 "file", "file", "ftp", "ftps", "host_cdrom",
1246                                 "host_device", "host_floppy", "http", "https",
1247                                 "nbd", "parallels", "qcow", "qcow2", "raw",
1248                                 "tftp", "vdi", "vmdk", "vpc", "vvfat"
1249          - "backing_file": backing file name (json-string, optional)
1250          - "encrypted": true if encrypted, false otherwise (json-bool)
1251          - "bps": limit total bytes per second (json-int)
1252          - "bps_rd": limit read bytes per second (json-int)
1253          - "bps_wr": limit write bytes per second (json-int)
1254          - "iops": limit total I/O operations per second (json-int)
1255          - "iops_rd": limit read operations per second (json-int)
1256          - "iops_wr": limit write operations per second (json-int)
1257
1258 - "io-status": I/O operation status, only present if the device supports it
1259                and the VM is configured to stop on errors. It's always reset
1260                to "ok" when the "cont" command is issued (json_string, optional)
1261              - Possible values: "ok", "failed", "nospace"
1262
1263 Example:
1264
1265 -> { "execute": "query-block" }
1266 <- {
1267       "return":[
1268          {
1269             "io-status": "ok",
1270             "device":"ide0-hd0",
1271             "locked":false,
1272             "removable":false,
1273             "inserted":{
1274                "ro":false,
1275                "drv":"qcow2",
1276                "encrypted":false,
1277                "file":"disks/test.img",
1278                "bps":1000000,
1279                "bps_rd":0,
1280                "bps_wr":0,
1281                "iops":1000000,
1282                "iops_rd":0,
1283                "iops_wr":0,
1284             },
1285             "type":"unknown"
1286          },
1287          {
1288             "io-status": "ok",
1289             "device":"ide1-cd0",
1290             "locked":false,
1291             "removable":true,
1292             "type":"unknown"
1293          },
1294          {
1295             "device":"floppy0",
1296             "locked":false,
1297             "removable":true,
1298             "type":"unknown"
1299          },
1300          {
1301             "device":"sd0",
1302             "locked":false,
1303             "removable":true,
1304             "type":"unknown"
1305          }
1306       ]
1307    }
1308
1309 EQMP
1310
1311     {
1312         .name       = "query-block",
1313         .args_type  = "",
1314         .mhandler.cmd_new = qmp_marshal_input_query_block,
1315     },
1316
1317 SQMP
1318 query-blockstats
1319 ----------------
1320
1321 Show block device statistics.
1322
1323 Each device statistic information is stored in a json-object and the returned
1324 value is a json-array of all devices.
1325
1326 Each json-object contain the following:
1327
1328 - "device": device name (json-string)
1329 - "stats": A json-object with the statistics information, it contains:
1330     - "rd_bytes": bytes read (json-int)
1331     - "wr_bytes": bytes written (json-int)
1332     - "rd_operations": read operations (json-int)
1333     - "wr_operations": write operations (json-int)
1334     - "flush_operations": cache flush operations (json-int)
1335     - "wr_total_time_ns": total time spend on writes in nano-seconds (json-int)
1336     - "rd_total_time_ns": total time spend on reads in nano-seconds (json-int)
1337     - "flush_total_time_ns": total time spend on cache flushes in nano-seconds (json-int)
1338     - "wr_highest_offset": Highest offset of a sector written since the
1339                            BlockDriverState has been opened (json-int)
1340 - "parent": Contains recursively the statistics of the underlying
1341             protocol (e.g. the host file for a qcow2 image). If there is
1342             no underlying protocol, this field is omitted
1343             (json-object, optional)
1344
1345 Example:
1346
1347 -> { "execute": "query-blockstats" }
1348 <- {
1349       "return":[
1350          {
1351             "device":"ide0-hd0",
1352             "parent":{
1353                "stats":{
1354                   "wr_highest_offset":3686448128,
1355                   "wr_bytes":9786368,
1356                   "wr_operations":751,
1357                   "rd_bytes":122567168,
1358                   "rd_operations":36772
1359                   "wr_total_times_ns":313253456
1360                   "rd_total_times_ns":3465673657
1361                   "flush_total_times_ns":49653
1362                   "flush_operations":61,
1363                }
1364             },
1365             "stats":{
1366                "wr_highest_offset":2821110784,
1367                "wr_bytes":9786368,
1368                "wr_operations":692,
1369                "rd_bytes":122739200,
1370                "rd_operations":36604
1371                "flush_operations":51,
1372                "wr_total_times_ns":313253456
1373                "rd_total_times_ns":3465673657
1374                "flush_total_times_ns":49653
1375             }
1376          },
1377          {
1378             "device":"ide1-cd0",
1379             "stats":{
1380                "wr_highest_offset":0,
1381                "wr_bytes":0,
1382                "wr_operations":0,
1383                "rd_bytes":0,
1384                "rd_operations":0
1385                "flush_operations":0,
1386                "wr_total_times_ns":0
1387                "rd_total_times_ns":0
1388                "flush_total_times_ns":0
1389             }
1390          },
1391          {
1392             "device":"floppy0",
1393             "stats":{
1394                "wr_highest_offset":0,
1395                "wr_bytes":0,
1396                "wr_operations":0,
1397                "rd_bytes":0,
1398                "rd_operations":0
1399                "flush_operations":0,
1400                "wr_total_times_ns":0
1401                "rd_total_times_ns":0
1402                "flush_total_times_ns":0
1403             }
1404          },
1405          {
1406             "device":"sd0",
1407             "stats":{
1408                "wr_highest_offset":0,
1409                "wr_bytes":0,
1410                "wr_operations":0,
1411                "rd_bytes":0,
1412                "rd_operations":0
1413                "flush_operations":0,
1414                "wr_total_times_ns":0
1415                "rd_total_times_ns":0
1416                "flush_total_times_ns":0
1417             }
1418          }
1419       ]
1420    }
1421
1422 EQMP
1423
1424     {
1425         .name       = "query-blockstats",
1426         .args_type  = "",
1427         .mhandler.cmd_new = qmp_marshal_input_query_blockstats,
1428     },
1429
1430 SQMP
1431 query-cpus
1432 ----------
1433
1434 Show CPU information.
1435
1436 Return a json-array. Each CPU is represented by a json-object, which contains:
1437
1438 - "CPU": CPU index (json-int)
1439 - "current": true if this is the current CPU, false otherwise (json-bool)
1440 - "halted": true if the cpu is halted, false otherwise (json-bool)
1441 - Current program counter. The key's name depends on the architecture:
1442      "pc": i386/x86_64 (json-int)
1443      "nip": PPC (json-int)
1444      "pc" and "npc": sparc (json-int)
1445      "PC": mips (json-int)
1446 - "thread_id": ID of the underlying host thread (json-int)
1447
1448 Example:
1449
1450 -> { "execute": "query-cpus" }
1451 <- {
1452       "return":[
1453          {
1454             "CPU":0,
1455             "current":true,
1456             "halted":false,
1457             "pc":3227107138
1458             "thread_id":3134
1459          },
1460          {
1461             "CPU":1,
1462             "current":false,
1463             "halted":true,
1464             "pc":7108165
1465             "thread_id":3135
1466          }
1467       ]
1468    }
1469
1470 EQMP
1471
1472     {
1473         .name       = "query-cpus",
1474         .args_type  = "",
1475         .mhandler.cmd_new = qmp_marshal_input_query_cpus,
1476     },
1477
1478 SQMP
1479 query-pci
1480 ---------
1481
1482 PCI buses and devices information.
1483
1484 The returned value is a json-array of all buses. Each bus is represented by
1485 a json-object, which has a key with a json-array of all PCI devices attached
1486 to it. Each device is represented by a json-object.
1487
1488 The bus json-object contains the following:
1489
1490 - "bus": bus number (json-int)
1491 - "devices": a json-array of json-objects, each json-object represents a
1492              PCI device
1493
1494 The PCI device json-object contains the following:
1495
1496 - "bus": identical to the parent's bus number (json-int)
1497 - "slot": slot number (json-int)
1498 - "function": function number (json-int)
1499 - "class_info": a json-object containing:
1500      - "desc": device class description (json-string, optional)
1501      - "class": device class number (json-int)
1502 - "id": a json-object containing:
1503      - "device": device ID (json-int)
1504      - "vendor": vendor ID (json-int)
1505 - "irq": device's IRQ if assigned (json-int, optional)
1506 - "qdev_id": qdev id string (json-string)
1507 - "pci_bridge": It's a json-object, only present if this device is a
1508                 PCI bridge, contains:
1509      - "bus": bus number (json-int)
1510      - "secondary": secondary bus number (json-int)
1511      - "subordinate": subordinate bus number (json-int)
1512      - "io_range": I/O memory range information, a json-object with the
1513                    following members:
1514                  - "base": base address, in bytes (json-int)
1515                  - "limit": limit address, in bytes (json-int)
1516      - "memory_range": memory range information, a json-object with the
1517                        following members:
1518                  - "base": base address, in bytes (json-int)
1519                  - "limit": limit address, in bytes (json-int)
1520      - "prefetchable_range": Prefetchable memory range information, a
1521                              json-object with the following members:
1522                  - "base": base address, in bytes (json-int)
1523                  - "limit": limit address, in bytes (json-int)
1524      - "devices": a json-array of PCI devices if there's any attached, each
1525                   each element is represented by a json-object, which contains
1526                   the same members of the 'PCI device json-object' described
1527                   above (optional)
1528 - "regions": a json-array of json-objects, each json-object represents a
1529              memory region of this device
1530
1531 The memory range json-object contains the following:
1532
1533 - "base": base memory address (json-int)
1534 - "limit": limit value (json-int)
1535
1536 The region json-object can be an I/O region or a memory region, an I/O region
1537 json-object contains the following:
1538
1539 - "type": "io" (json-string, fixed)
1540 - "bar": BAR number (json-int)
1541 - "address": memory address (json-int)
1542 - "size": memory size (json-int)
1543
1544 A memory region json-object contains the following:
1545
1546 - "type": "memory" (json-string, fixed)
1547 - "bar": BAR number (json-int)
1548 - "address": memory address (json-int)
1549 - "size": memory size (json-int)
1550 - "mem_type_64": true or false (json-bool)
1551 - "prefetch": true or false (json-bool)
1552
1553 Example:
1554
1555 -> { "execute": "query-pci" }
1556 <- {
1557       "return":[
1558          {
1559             "bus":0,
1560             "devices":[
1561                {
1562                   "bus":0,
1563                   "qdev_id":"",
1564                   "slot":0,
1565                   "class_info":{
1566                      "class":1536,
1567                      "desc":"Host bridge"
1568                   },
1569                   "id":{
1570                      "device":32902,
1571                      "vendor":4663
1572                   },
1573                   "function":0,
1574                   "regions":[
1575
1576                   ]
1577                },
1578                {
1579                   "bus":0,
1580                   "qdev_id":"",
1581                   "slot":1,
1582                   "class_info":{
1583                      "class":1537,
1584                      "desc":"ISA bridge"
1585                   },
1586                   "id":{
1587                      "device":32902,
1588                      "vendor":28672
1589                   },
1590                   "function":0,
1591                   "regions":[
1592
1593                   ]
1594                },
1595                {
1596                   "bus":0,
1597                   "qdev_id":"",
1598                   "slot":1,
1599                   "class_info":{
1600                      "class":257,
1601                      "desc":"IDE controller"
1602                   },
1603                   "id":{
1604                      "device":32902,
1605                      "vendor":28688
1606                   },
1607                   "function":1,
1608                   "regions":[
1609                      {
1610                         "bar":4,
1611                         "size":16,
1612                         "address":49152,
1613                         "type":"io"
1614                      }
1615                   ]
1616                },
1617                {
1618                   "bus":0,
1619                   "qdev_id":"",
1620                   "slot":2,
1621                   "class_info":{
1622                      "class":768,
1623                      "desc":"VGA controller"
1624                   },
1625                   "id":{
1626                      "device":4115,
1627                      "vendor":184
1628                   },
1629                   "function":0,
1630                   "regions":[
1631                      {
1632                         "prefetch":true,
1633                         "mem_type_64":false,
1634                         "bar":0,
1635                         "size":33554432,
1636                         "address":4026531840,
1637                         "type":"memory"
1638                      },
1639                      {
1640                         "prefetch":false,
1641                         "mem_type_64":false,
1642                         "bar":1,
1643                         "size":4096,
1644                         "address":4060086272,
1645                         "type":"memory"
1646                      },
1647                      {
1648                         "prefetch":false,
1649                         "mem_type_64":false,
1650                         "bar":6,
1651                         "size":65536,
1652                         "address":-1,
1653                         "type":"memory"
1654                      }
1655                   ]
1656                },
1657                {
1658                   "bus":0,
1659                   "qdev_id":"",
1660                   "irq":11,
1661                   "slot":4,
1662                   "class_info":{
1663                      "class":1280,
1664                      "desc":"RAM controller"
1665                   },
1666                   "id":{
1667                      "device":6900,
1668                      "vendor":4098
1669                   },
1670                   "function":0,
1671                   "regions":[
1672                      {
1673                         "bar":0,
1674                         "size":32,
1675                         "address":49280,
1676                         "type":"io"
1677                      }
1678                   ]
1679                }
1680             ]
1681          }
1682       ]
1683    }
1684
1685 Note: This example has been shortened as the real response is too long.
1686
1687 EQMP
1688
1689     {
1690         .name       = "query-pci",
1691         .args_type  = "",
1692         .mhandler.cmd_new = qmp_marshal_input_query_pci,
1693     },
1694
1695 SQMP
1696 query-kvm
1697 ---------
1698
1699 Show KVM information.
1700
1701 Return a json-object with the following information:
1702
1703 - "enabled": true if KVM support is enabled, false otherwise (json-bool)
1704 - "present": true if QEMU has KVM support, false otherwise (json-bool)
1705
1706 Example:
1707
1708 -> { "execute": "query-kvm" }
1709 <- { "return": { "enabled": true, "present": true } }
1710
1711 EQMP
1712
1713     {
1714         .name       = "query-kvm",
1715         .args_type  = "",
1716         .mhandler.cmd_new = qmp_marshal_input_query_kvm,
1717     },
1718
1719 SQMP
1720 query-status
1721 ------------
1722
1723 Return a json-object with the following information:
1724
1725 - "running": true if the VM is running, or false if it is paused (json-bool)
1726 - "singlestep": true if the VM is in single step mode,
1727                 false otherwise (json-bool)
1728 - "status": one of the following values (json-string)
1729     "debug" - QEMU is running on a debugger
1730     "inmigrate" - guest is paused waiting for an incoming migration
1731     "internal-error" - An internal error that prevents further guest
1732     execution has occurred
1733     "io-error" - the last IOP has failed and the device is configured
1734     to pause on I/O errors
1735     "paused" - guest has been paused via the 'stop' command
1736     "postmigrate" - guest is paused following a successful 'migrate'
1737     "prelaunch" - QEMU was started with -S and guest has not started
1738     "finish-migrate" - guest is paused to finish the migration process
1739     "restore-vm" - guest is paused to restore VM state
1740     "running" - guest is actively running
1741     "save-vm" - guest is paused to save the VM state
1742     "shutdown" - guest is shut down (and -no-shutdown is in use)
1743     "watchdog" - the watchdog action is configured to pause and
1744      has been triggered
1745
1746 Example:
1747
1748 -> { "execute": "query-status" }
1749 <- { "return": { "running": true, "singlestep": false, "status": "running" } }
1750
1751 EQMP
1752
1753     {
1754         .name       = "query-status",
1755         .args_type  = "",
1756         .mhandler.cmd_new = qmp_marshal_input_query_status,
1757     },
1758
1759 SQMP
1760 query-mice
1761 ----------
1762
1763 Show VM mice information.
1764
1765 Each mouse is represented by a json-object, the returned value is a json-array
1766 of all mice.
1767
1768 The mouse json-object contains the following:
1769
1770 - "name": mouse's name (json-string)
1771 - "index": mouse's index (json-int)
1772 - "current": true if this mouse is receiving events, false otherwise (json-bool)
1773 - "absolute": true if the mouse generates absolute input events (json-bool)
1774
1775 Example:
1776
1777 -> { "execute": "query-mice" }
1778 <- {
1779       "return":[
1780          {
1781             "name":"QEMU Microsoft Mouse",
1782             "index":0,
1783             "current":false,
1784             "absolute":false
1785          },
1786          {
1787             "name":"QEMU PS/2 Mouse",
1788             "index":1,
1789             "current":true,
1790             "absolute":true
1791          }
1792       ]
1793    }
1794
1795 EQMP
1796
1797     {
1798         .name       = "query-mice",
1799         .args_type  = "",
1800         .mhandler.cmd_new = qmp_marshal_input_query_mice,
1801     },
1802
1803 SQMP
1804 query-vnc
1805 ---------
1806
1807 Show VNC server information.
1808
1809 Return a json-object with server information. Connected clients are returned
1810 as a json-array of json-objects.
1811
1812 The main json-object contains the following:
1813
1814 - "enabled": true or false (json-bool)
1815 - "host": server's IP address (json-string)
1816 - "family": address family (json-string)
1817          - Possible values: "ipv4", "ipv6", "unix", "unknown"
1818 - "service": server's port number (json-string)
1819 - "auth": authentication method (json-string)
1820          - Possible values: "invalid", "none", "ra2", "ra2ne", "sasl", "tight",
1821                             "tls", "ultra", "unknown", "vencrypt", "vencrypt",
1822                             "vencrypt+plain", "vencrypt+tls+none",
1823                             "vencrypt+tls+plain", "vencrypt+tls+sasl",
1824                             "vencrypt+tls+vnc", "vencrypt+x509+none",
1825                             "vencrypt+x509+plain", "vencrypt+x509+sasl",
1826                             "vencrypt+x509+vnc", "vnc"
1827 - "clients": a json-array of all connected clients
1828
1829 Clients are described by a json-object, each one contain the following:
1830
1831 - "host": client's IP address (json-string)
1832 - "family": address family (json-string)
1833          - Possible values: "ipv4", "ipv6", "unix", "unknown"
1834 - "service": client's port number (json-string)
1835 - "x509_dname": TLS dname (json-string, optional)
1836 - "sasl_username": SASL username (json-string, optional)
1837
1838 Example:
1839
1840 -> { "execute": "query-vnc" }
1841 <- {
1842       "return":{
1843          "enabled":true,
1844          "host":"0.0.0.0",
1845          "service":"50402",
1846          "auth":"vnc",
1847          "family":"ipv4",
1848          "clients":[
1849             {
1850                "host":"127.0.0.1",
1851                "service":"50401",
1852                "family":"ipv4"
1853             }
1854          ]
1855       }
1856    }
1857
1858 EQMP
1859
1860     {
1861         .name       = "query-vnc",
1862         .args_type  = "",
1863         .mhandler.cmd_new = qmp_marshal_input_query_vnc,
1864     },
1865
1866 SQMP
1867 query-spice
1868 -----------
1869
1870 Show SPICE server information.
1871
1872 Return a json-object with server information. Connected clients are returned
1873 as a json-array of json-objects.
1874
1875 The main json-object contains the following:
1876
1877 - "enabled": true or false (json-bool)
1878 - "host": server's IP address (json-string)
1879 - "port": server's port number (json-int, optional)
1880 - "tls-port": server's port number (json-int, optional)
1881 - "auth": authentication method (json-string)
1882          - Possible values: "none", "spice"
1883 - "channels": a json-array of all active channels clients
1884
1885 Channels are described by a json-object, each one contain the following:
1886
1887 - "host": client's IP address (json-string)
1888 - "family": address family (json-string)
1889          - Possible values: "ipv4", "ipv6", "unix", "unknown"
1890 - "port": client's port number (json-string)
1891 - "connection-id": spice connection id.  All channels with the same id
1892                    belong to the same spice session (json-int)
1893 - "channel-type": channel type.  "1" is the main control channel, filter for
1894                   this one if you want track spice sessions only (json-int)
1895 - "channel-id": channel id.  Usually "0", might be different needed when
1896                 multiple channels of the same type exist, such as multiple
1897                 display channels in a multihead setup (json-int)
1898 - "tls": whevener the channel is encrypted (json-bool)
1899
1900 Example:
1901
1902 -> { "execute": "query-spice" }
1903 <- {
1904       "return": {
1905          "enabled": true,
1906          "auth": "spice",
1907          "port": 5920,
1908          "tls-port": 5921,
1909          "host": "0.0.0.0",
1910          "channels": [
1911             {
1912                "port": "54924",
1913                "family": "ipv4",
1914                "channel-type": 1,
1915                "connection-id": 1804289383,
1916                "host": "127.0.0.1",
1917                "channel-id": 0,
1918                "tls": true
1919             },
1920             {
1921                "port": "36710",
1922                "family": "ipv4",
1923                "channel-type": 4,
1924                "connection-id": 1804289383,
1925                "host": "127.0.0.1",
1926                "channel-id": 0,
1927                "tls": false
1928             },
1929             [ ... more channels follow ... ]
1930          ]
1931       }
1932    }
1933
1934 EQMP
1935
1936 #if defined(CONFIG_SPICE)
1937     {
1938         .name       = "query-spice",
1939         .args_type  = "",
1940         .mhandler.cmd_new = qmp_marshal_input_query_spice,
1941     },
1942 #endif
1943
1944 SQMP
1945 query-name
1946 ----------
1947
1948 Show VM name.
1949
1950 Return a json-object with the following information:
1951
1952 - "name": VM's name (json-string, optional)
1953
1954 Example:
1955
1956 -> { "execute": "query-name" }
1957 <- { "return": { "name": "qemu-name" } }
1958
1959 EQMP
1960
1961     {
1962         .name       = "query-name",
1963         .args_type  = "",
1964         .mhandler.cmd_new = qmp_marshal_input_query_name,
1965     },
1966
1967 SQMP
1968 query-uuid
1969 ----------
1970
1971 Show VM UUID.
1972
1973 Return a json-object with the following information:
1974
1975 - "UUID": Universally Unique Identifier (json-string)
1976
1977 Example:
1978
1979 -> { "execute": "query-uuid" }
1980 <- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } }
1981
1982 EQMP
1983
1984     {
1985         .name       = "query-uuid",
1986         .args_type  = "",
1987         .mhandler.cmd_new = qmp_marshal_input_query_uuid,
1988     },
1989
1990 SQMP
1991 query-migrate
1992 -------------
1993
1994 Migration status.
1995
1996 Return a json-object. If migration is active there will be another json-object
1997 with RAM migration status and if block migration is active another one with
1998 block migration status.
1999
2000 The main json-object contains the following:
2001
2002 - "status": migration status (json-string)
2003      - Possible values: "active", "completed", "failed", "cancelled"
2004 - "ram": only present if "status" is "active", it is a json-object with the
2005   following RAM information (in bytes):
2006          - "transferred": amount transferred (json-int)
2007          - "remaining": amount remaining (json-int)
2008          - "total": total (json-int)
2009 - "disk": only present if "status" is "active" and it is a block migration,
2010   it is a json-object with the following disk information (in bytes):
2011          - "transferred": amount transferred (json-int)
2012          - "remaining": amount remaining (json-int)
2013          - "total": total (json-int)
2014
2015 Examples:
2016
2017 1. Before the first migration
2018
2019 -> { "execute": "query-migrate" }
2020 <- { "return": {} }
2021
2022 2. Migration is done and has succeeded
2023
2024 -> { "execute": "query-migrate" }
2025 <- { "return": { "status": "completed" } }
2026
2027 3. Migration is done and has failed
2028
2029 -> { "execute": "query-migrate" }
2030 <- { "return": { "status": "failed" } }
2031
2032 4. Migration is being performed and is not a block migration:
2033
2034 -> { "execute": "query-migrate" }
2035 <- {
2036       "return":{
2037          "status":"active",
2038          "ram":{
2039             "transferred":123,
2040             "remaining":123,
2041             "total":246
2042          }
2043       }
2044    }
2045
2046 5. Migration is being performed and is a block migration:
2047
2048 -> { "execute": "query-migrate" }
2049 <- {
2050       "return":{
2051          "status":"active",
2052          "ram":{
2053             "total":1057024,
2054             "remaining":1053304,
2055             "transferred":3720
2056          },
2057          "disk":{
2058             "total":20971520,
2059             "remaining":20880384,
2060             "transferred":91136
2061          }
2062       }
2063    }
2064
2065 EQMP
2066
2067     {
2068         .name       = "query-migrate",
2069         .args_type  = "",
2070         .mhandler.cmd_new = qmp_marshal_input_query_migrate,
2071     },
2072
2073 SQMP
2074 query-balloon
2075 -------------
2076
2077 Show balloon information.
2078
2079 Make an asynchronous request for balloon info. When the request completes a
2080 json-object will be returned containing the following data:
2081
2082 - "actual": current balloon value in bytes (json-int)
2083 - "mem_swapped_in": Amount of memory swapped in bytes (json-int, optional)
2084 - "mem_swapped_out": Amount of memory swapped out in bytes (json-int, optional)
2085 - "major_page_faults": Number of major faults (json-int, optional)
2086 - "minor_page_faults": Number of minor faults (json-int, optional)
2087 - "free_mem": Total amount of free and unused memory in
2088               bytes (json-int, optional)
2089 - "total_mem": Total amount of available memory in bytes (json-int, optional)
2090
2091 Example:
2092
2093 -> { "execute": "query-balloon" }
2094 <- {
2095       "return":{
2096          "actual":1073741824,
2097          "mem_swapped_in":0,
2098          "mem_swapped_out":0,
2099          "major_page_faults":142,
2100          "minor_page_faults":239245,
2101          "free_mem":1014185984,
2102          "total_mem":1044668416
2103       }
2104    }
2105
2106 EQMP
2107
2108     {
2109         .name       = "query-balloon",
2110         .args_type  = "",
2111         .mhandler.cmd_new = qmp_marshal_input_query_balloon,
2112     },
2113
2114     {
2115         .name       = "query-block-jobs",
2116         .args_type  = "",
2117         .mhandler.cmd_new = qmp_marshal_input_query_block_jobs,
2118     },
2119
2120     {
2121         .name       = "qom-list",
2122         .args_type  = "path:s",
2123         .mhandler.cmd_new = qmp_marshal_input_qom_list,
2124     },
2125
2126     {
2127         .name       = "qom-set",
2128         .args_type  = "path:s,property:s,value:q",
2129         .mhandler.cmd_new = qmp_qom_set,
2130     },
2131
2132     {
2133         .name       = "qom-get",
2134         .args_type  = "path:s,property:s",
2135         .mhandler.cmd_new = qmp_qom_get,
2136     },
2137
2138     {
2139         .name       = "change-vnc-password",
2140         .args_type  = "password:s",
2141         .mhandler.cmd_new = qmp_marshal_input_change_vnc_password,
2142     },
2143     {
2144         .name       = "qom-list-types",
2145         .args_type  = "implements:s?,abstract:b?",
2146         .mhandler.cmd_new = qmp_marshal_input_qom_list_types,
2147     },