qmp-commands.hx

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