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