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