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