qmp-commands.hx

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