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