qmp-commands.hx

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