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