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