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