qmp-commands.hx

   1 HXCOMM QMP dispatch table and documentation
   2 HXCOMM Text between SQMP and EQMP is copied to the QMP documention file and
   3 HXCOMM does not show up in the other formats.
   4
   5 SQMP
   6                         QMP Supported Commands
   7                         ----------------------
   8
   9 This document describes all commands currently supported by QMP.
  10
  11 Most of the time their usage is exactly the same as in the user Monitor, this
  12 means that any other document which also describe commands (the manpage,
  13 QEMU's manual, etc) can and should be consulted.
  14
  15 QMP has two types of commands: regular and query commands. Regular commands
  16 usually change the Virtual Machine's state someway, while query commands just
  17 return information. The sections below are divided accordingly.
  18
  19 It's important to observe that all communication examples are formatted in
  20 a reader-friendly way, so that they're easier to understand. However, in real
  21 protocol usage, they're emitted as a single line.
  22
  23 Also, the following notation is used to denote data flow:
  24
  25 -> data issued by the Client
  26 <- Server data response
  27
  28 Please, refer to the QMP specification (QMP/qmp-spec.txt) for detailed
  29 information on the Server command and response formats.
  30
  31 NOTE: This document is temporary and will be replaced soon.
  32
  33 1. Stability Considerations
  34 ===========================
  35
  36 The current QMP command set (described in this file) may be useful for a
  37 number of use cases, however it's limited and several commands have bad
  38 defined semantics, specially with regard to command completion.
  39
  40 These problems are going to be solved incrementally in the next QEMU releases
  41 and we're going to establish a deprecation policy for badly defined commands.
  42
  43 If you're planning to adopt QMP, please observe the following:
  44
  45     1. The deprecation policy will take effect and be documented soon, please
  46        check the documentation of each used command as soon as a new release of
  47        QEMU is available
  48
  49     2. DO NOT rely on anything which is not explicit documented
  50
  51     3. Errors, in special, are not documented. Applications should NOT check
  52        for specific errors classes or data (it's strongly recommended to only
  53        check for the "error" key)
  54
  55 2. Regular Commands
  56 ===================
  57
  58 Server's responses in the examples below are always a success response, please
  59 refer to the QMP specification for more details on error responses.
  60
  61 EQMP
  62
  63     {
  64         .name       = "quit",
  65         .args_type  = "",
  66         .mhandler.cmd_new = qmp_marshal_input_quit,
  67     },
  68
  69 SQMP
  70 quit
  71 ----
  72
  73 Quit the emulator.
  74
  75 Arguments: None.
  76
  77 Example:
  78
  79 -> { "execute": "quit" }
  80 <- { "return": {} }
  81
  82 EQMP
  83
  84     {
  85         .name       = "eject",
  86         .args_type  = "force:-f,device:B",
  87         .mhandler.cmd_new = qmp_marshal_input_eject,
  88     },
  89
  90 SQMP
  91 eject
  92 -----
  93
  94 Eject a removable medium.
  95
  96 Arguments:
  97
  98 - force: force ejection (json-bool, optional)
  99 - device: device name (json-string)
 100
 101 Example:
 102
 103 -> { "execute": "eject", "arguments": { "device": "ide1-cd0" } }
 104 <- { "return": {} }
 105
 106 Note: The "force" argument defaults to false.
 107
 108 EQMP
 109
 110     {
 111         .name       = "change",
 112         .args_type  = "device:B,target:F,arg:s?",
 113         .mhandler.cmd_new = qmp_marshal_input_change,
 114     },
 115
 116 SQMP
 117 change
 118 ------
 119
 120 Change a removable medium or VNC configuration.
 121
 122 Arguments:
 123
 124 - "device": device name (json-string)
 125 - "target": filename or item (json-string)
 126 - "arg": additional argument (json-string, optional)
 127
 128 Examples:
 129
 130 1. Change a removable medium
 131
 132 -> { "execute": "change",
 133              "arguments": { "device": "ide1-cd0",
 134                             "target": "/srv/images/Fedora-12-x86_64-DVD.iso" } }
 135 <- { "return": {} }
 136
 137 2. Change VNC password
 138
 139 -> { "execute": "change",
 140              "arguments": { "device": "vnc", "target": "password",
 141                             "arg": "foobar1" } }
 142 <- { "return": {} }
 143
 144 EQMP
 145
 146     {
 147         .name       = "screendump",
 148         .args_type  = "filename:F",
 149         .mhandler.cmd_new = qmp_marshal_input_screendump,
 150     },
 151
 152 SQMP
 153 screendump
 154 ----------
 155
 156 Save screen into PPM image.
 157
 158 Arguments:
 159
 160 - "filename": file path (json-string)
 161
 162 Example:
 163
 164 -> { "execute": "screendump", "arguments": { "filename": "/tmp/image" } }
 165 <- { "return": {} }
 166
 167 EQMP
 168
 169     {
 170         .name       = "stop",
 171         .args_type  = "",
 172         .mhandler.cmd_new = qmp_marshal_input_stop,
 173     },
 174
 175 SQMP
 176 stop
 177 ----
 178
 179 Stop the emulator.
 180
 181 Arguments: None.
 182
 183 Example:
 184
 185 -> { "execute": "stop" }
 186 <- { "return": {} }
 187
 188 EQMP
 189
 190     {
 191         .name       = "cont",
 192         .args_type  = "",
 193         .mhandler.cmd_new = qmp_marshal_input_cont,
 194     },
 195
 196 SQMP
 197 cont
 198 ----
 199
 200 Resume emulation.
 201
 202 Arguments: None.
 203
 204 Example:
 205
 206 -> { "execute": "cont" }
 207 <- { "return": {} }
 208
 209 EQMP
 210
 211     {
 212         .name       = "system_wakeup",
 213         .args_type  = "",
 214         .mhandler.cmd_new = qmp_marshal_input_system_wakeup,
 215     },
 216
 217 SQMP
 218 system_wakeup
 219 -------------
 220
 221 Wakeup guest from suspend.
 222
 223 Arguments: None.
 224
 225 Example:
 226
 227 -> { "execute": "system_wakeup" }
 228 <- { "return": {} }
 229
 230 EQMP
 231
 232     {
 233         .name       = "system_reset",
 234         .args_type  = "",
 235         .mhandler.cmd_new = qmp_marshal_input_system_reset,
 236     },
 237
 238 SQMP
 239 system_reset
 240 ------------
 241
 242 Reset the system.
 243
 244 Arguments: None.
 245
 246 Example:
 247
 248 -> { "execute": "system_reset" }
 249 <- { "return": {} }
 250
 251 EQMP
 252
 253     {
 254         .name       = "system_powerdown",
 255         .args_type  = "",
 256         .mhandler.cmd_new = qmp_marshal_input_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         .mhandler.cmd_new = qmp_marshal_input_device_del,
 315     },
 316
 317 SQMP
 318 device_del
 319 ----------
 320
 321 Remove a device.
 322
 323 Arguments:
 324
 325 - "id": the device's ID (json-string)
 326
 327 Example:
 328
 329 -> { "execute": "device_del", "arguments": { "id": "net1" } }
 330 <- { "return": {} }
 331
 332 EQMP
 333
 334     {
 335         .name       = "send-key",
 336         .args_type  = "keys:O,hold-time:i?",
 337         .mhandler.cmd_new = qmp_marshal_input_send_key,
 338     },
 339
 340 SQMP
 341 send-key
 342 ----------
 343
 344 Send keys to VM.
 345
 346 Arguments:
 347
 348 keys array:
 349     - "key": key sequence (a json-array of key union values,
 350              union can be number or qcode enum)
 351
 352 - hold-time: time to delay key up events, milliseconds. Defaults to 100
 353              (json-int, optional)
 354
 355 Example:
 356
 357 -> { "execute": "send-key",
 358      "arguments": { "keys": [ { "type": "qcode", "data": "ctrl" },
 359                               { "type": "qcode", "data": "alt" },
 360                               { "type": "qcode", "data": "delete" } ] } }
 361 <- { "return": {} }
 362
 363 EQMP
 364
 365     {
 366         .name       = "cpu",
 367         .args_type  = "index:i",
 368         .mhandler.cmd_new = qmp_marshal_input_cpu,
 369     },
 370
 371 SQMP
 372 cpu
 373 ---
 374
 375 Set the default CPU.
 376
 377 Arguments:
 378
 379 - "index": the CPU's index (json-int)
 380
 381 Example:
 382
 383 -> { "execute": "cpu", "arguments": { "index": 0 } }
 384 <- { "return": {} }
 385
 386 Note: CPUs' indexes are obtained with the 'query-cpus' command.
 387
 388 EQMP
 389
 390     {
 391         .name       = "cpu-add",
 392         .args_type  = "id:i",
 393         .mhandler.cmd_new = qmp_marshal_input_cpu_add,
 394     },
 395
 396 SQMP
 397 cpu-add
 398 -------
 399
 400 Adds virtual cpu
 401
 402 Arguments:
 403
 404 - "id": cpu id (json-int)
 405
 406 Example:
 407
 408 -> { "execute": "cpu-add", "arguments": { "id": 2 } }
 409 <- { "return": {} }
 410
 411 EQMP
 412
 413     {
 414         .name       = "memsave",
 415         .args_type  = "val:l,size:i,filename:s,cpu:i?",
 416         .mhandler.cmd_new = qmp_marshal_input_memsave,
 417     },
 418
 419 SQMP
 420 memsave
 421 -------
 422
 423 Save to disk virtual memory dump starting at 'val' of size 'size'.
 424
 425 Arguments:
 426
 427 - "val": the starting address (json-int)
 428 - "size": the memory size, in bytes (json-int)
 429 - "filename": file path (json-string)
 430 - "cpu": virtual CPU index (json-int, optional)
 431
 432 Example:
 433
 434 -> { "execute": "memsave",
 435              "arguments": { "val": 10,
 436                             "size": 100,
 437                             "filename": "/tmp/virtual-mem-dump" } }
 438 <- { "return": {} }
 439
 440 EQMP
 441
 442     {
 443         .name       = "pmemsave",
 444         .args_type  = "val:l,size:i,filename:s",
 445         .mhandler.cmd_new = qmp_marshal_input_pmemsave,
 446     },
 447
 448 SQMP
 449 pmemsave
 450 --------
 451
 452 Save to disk physical memory dump starting at 'val' of size 'size'.
 453
 454 Arguments:
 455
 456 - "val": the starting address (json-int)
 457 - "size": the memory size, in bytes (json-int)
 458 - "filename": file path (json-string)
 459
 460 Example:
 461
 462 -> { "execute": "pmemsave",
 463              "arguments": { "val": 10,
 464                             "size": 100,
 465                             "filename": "/tmp/physical-mem-dump" } }
 466 <- { "return": {} }
 467
 468 EQMP
 469
 470     {
 471         .name       = "inject-nmi",
 472         .args_type  = "",
 473         .mhandler.cmd_new = qmp_marshal_input_inject_nmi,
 474     },
 475
 476 SQMP
 477 inject-nmi
 478 ----------
 479
 480 Inject an NMI on guest's CPUs.
 481
 482 Arguments: None.
 483
 484 Example:
 485
 486 -> { "execute": "inject-nmi" }
 487 <- { "return": {} }
 488
 489 Note: inject-nmi fails when the guest doesn't support injecting.
 490       Currently, only x86 (NMI) and s390x (RESTART) guests do.
 491
 492 EQMP
 493
 494     {
 495         .name       = "ringbuf-write",
 496         .args_type  = "device:s,data:s,format:s?",
 497         .mhandler.cmd_new = qmp_marshal_input_ringbuf_write,
 498     },
 499
 500 SQMP
 501 ringbuf-write
 502 -------------
 503
 504 Write to a ring buffer character device.
 505
 506 Arguments:
 507
 508 - "device": ring buffer character device name (json-string)
 509 - "data": data to write (json-string)
 510 - "format": data format (json-string, optional)
 511           - Possible values: "utf8" (default), "base64"
 512             Bug: invalid base64 is currently not rejected.
 513             Whitespace *is* invalid.
 514
 515 Example:
 516
 517 -> { "execute": "ringbuf-write",
 518                 "arguments": { "device": "foo",
 519                                "data": "abcdefgh",
 520                                "format": "utf8" } }
 521 <- { "return": {} }
 522
 523 EQMP
 524
 525     {
 526         .name       = "ringbuf-read",
 527         .args_type  = "device:s,size:i,format:s?",
 528         .mhandler.cmd_new = qmp_marshal_input_ringbuf_read,
 529     },
 530
 531 SQMP
 532 ringbuf-read
 533 -------------
 534
 535 Read from a ring buffer character device.
 536
 537 Arguments:
 538
 539 - "device": ring buffer character device name (json-string)
 540 - "size": how many bytes to read at most (json-int)
 541           - Number of data bytes, not number of characters in encoded data
 542 - "format": data format (json-string, optional)
 543           - Possible values: "utf8" (default), "base64"
 544           - Naturally, format "utf8" works only when the ring buffer
 545             contains valid UTF-8 text.  Invalid UTF-8 sequences get
 546             replaced.  Bug: replacement doesn't work.  Bug: can screw
 547             up on encountering NUL characters, after the ring buffer
 548             lost data, and when reading stops because the size limit
 549             is reached.
 550
 551 Example:
 552
 553 -> { "execute": "ringbuf-read",
 554                 "arguments": { "device": "foo",
 555                                "size": 1000,
 556                                "format": "utf8" } }
 557 <- {"return": "abcdefgh"}
 558
 559 EQMP
 560
 561     {
 562         .name       = "xen-save-devices-state",
 563         .args_type  = "filename:F",
 564     .mhandler.cmd_new = qmp_marshal_input_xen_save_devices_state,
 565     },
 566
 567 SQMP
 568 xen-save-devices-state
 569 -------
 570
 571 Save the state of all devices to file. The RAM and the block devices
 572 of the VM are not saved by this command.
 573
 574 Arguments:
 575
 576 - "filename": the file to save the state of the devices to as binary
 577 data. See xen-save-devices-state.txt for a description of the binary
 578 format.
 579
 580 Example:
 581
 582 -> { "execute": "xen-save-devices-state",
 583      "arguments": { "filename": "/tmp/save" } }
 584 <- { "return": {} }
 585
 586 EQMP
 587
 588     {
 589         .name       = "xen-set-global-dirty-log",
 590         .args_type  = "enable:b",
 591         .mhandler.cmd_new = qmp_marshal_input_xen_set_global_dirty_log,
 592     },
 593
 594 SQMP
 595 xen-set-global-dirty-log
 596 -------
 597
 598 Enable or disable the global dirty log mode.
 599
 600 Arguments:
 601
 602 - "enable": Enable it or disable it.
 603
 604 Example:
 605
 606 -> { "execute": "xen-set-global-dirty-log",
 607      "arguments": { "enable": true } }
 608 <- { "return": {} }
 609
 610 EQMP
 611
 612     {
 613         .name       = "migrate",
 614         .args_type  = "detach:-d,blk:-b,inc:-i,uri:s",
 615         .mhandler.cmd_new = qmp_marshal_input_migrate,
 616     },
 617
 618 SQMP
 619 migrate
 620 -------
 621
 622 Migrate to URI.
 623
 624 Arguments:
 625
 626 - "blk": block migration, full disk copy (json-bool, optional)
 627 - "inc": incremental disk copy (json-bool, optional)
 628 - "uri": Destination URI (json-string)
 629
 630 Example:
 631
 632 -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
 633 <- { "return": {} }
 634
 635 Notes:
 636
 637 (1) The 'query-migrate' command should be used to check migration's progress
 638     and final result (this information is provided by the 'status' member)
 639 (2) All boolean arguments default to false
 640 (3) The user Monitor's "detach" argument is invalid in QMP and should not
 641     be used
 642
 643 EQMP
 644
 645     {
 646         .name       = "migrate_cancel",
 647         .args_type  = "",
 648         .mhandler.cmd_new = qmp_marshal_input_migrate_cancel,
 649     },
 650
 651 SQMP
 652 migrate_cancel
 653 --------------
 654
 655 Cancel the current migration.
 656
 657 Arguments: None.
 658
 659 Example:
 660
 661 -> { "execute": "migrate_cancel" }
 662 <- { "return": {} }
 663
 664 EQMP
 665 {
 666         .name       = "migrate-set-cache-size",
 667         .args_type  = "value:o",
 668         .mhandler.cmd_new = qmp_marshal_input_migrate_set_cache_size,
 669     },
 670
 671 SQMP
 672 migrate-set-cache-size
 673 ----------------------
 674
 675 Set cache size to be used by XBZRLE migration, the cache size will be rounded
 676 down to the nearest power of 2
 677
 678 Arguments:
 679
 680 - "value": cache size in bytes (json-int)
 681
 682 Example:
 683
 684 -> { "execute": "migrate-set-cache-size", "arguments": { "value": 536870912 } }
 685 <- { "return": {} }
 686
 687 EQMP
 688     {
 689         .name       = "query-migrate-cache-size",
 690         .args_type  = "",
 691         .mhandler.cmd_new = qmp_marshal_input_query_migrate_cache_size,
 692     },
 693
 694 SQMP
 695 query-migrate-cache-size
 696 ------------------------
 697
 698 Show cache size to be used by XBZRLE migration
 699
 700 returns a json-object with the following information:
 701 - "size" : json-int
 702
 703 Example:
 704
 705 -> { "execute": "query-migrate-cache-size" }
 706 <- { "return": 67108864 }
 707
 708 EQMP
 709
 710     {
 711         .name       = "migrate_set_speed",
 712         .args_type  = "value:o",
 713         .mhandler.cmd_new = qmp_marshal_input_migrate_set_speed,
 714     },
 715
 716 SQMP
 717 migrate_set_speed
 718 -----------------
 719
 720 Set maximum speed for migrations.
 721
 722 Arguments:
 723
 724 - "value": maximum speed, in bytes per second (json-int)
 725
 726 Example:
 727
 728 -> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } }
 729 <- { "return": {} }
 730
 731 EQMP
 732
 733     {
 734         .name       = "migrate_set_downtime",
 735         .args_type  = "value:T",
 736         .mhandler.cmd_new = qmp_marshal_input_migrate_set_downtime,
 737     },
 738
 739 SQMP
 740 migrate_set_downtime
 741 --------------------
 742
 743 Set maximum tolerated downtime (in seconds) for migrations.
 744
 745 Arguments:
 746
 747 - "value": maximum downtime (json-number)
 748
 749 Example:
 750
 751 -> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } }
 752 <- { "return": {} }
 753
 754 EQMP
 755
 756     {
 757         .name       = "client_migrate_info",
 758         .args_type  = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
 759         .params     = "protocol hostname port tls-port cert-subject",
 760         .help       = "send migration info to spice/vnc client",
 761         .user_print = monitor_user_noop,
 762         .mhandler.cmd_async = client_migrate_info,
 763         .flags      = MONITOR_CMD_ASYNC,
 764     },
 765
 766 SQMP
 767 client_migrate_info
 768 ------------------
 769
 770 Set the spice/vnc connection info for the migration target.  The spice/vnc
 771 server will ask the spice/vnc client to automatically reconnect using the
 772 new parameters (if specified) once the vm migration finished successfully.
 773
 774 Arguments:
 775
 776 - "protocol":     protocol: "spice" or "vnc" (json-string)
 777 - "hostname":     migration target hostname (json-string)
 778 - "port":         spice/vnc tcp port for plaintext channels (json-int, optional)
 779 - "tls-port":     spice tcp port for tls-secured channels (json-int, optional)
 780 - "cert-subject": server certificate subject (json-string, optional)
 781
 782 Example:
 783
 784 -> { "execute": "client_migrate_info",
 785      "arguments": { "protocol": "spice",
 786                     "hostname": "virt42.lab.kraxel.org",
 787                     "port": 1234 } }
 788 <- { "return": {} }
 789
 790 EQMP
 791
 792     {
 793         .name       = "dump-guest-memory",
 794         .args_type  = "paging:b,protocol:s,begin:i?,end:i?",
 795         .params     = "-p protocol [begin] [length]",
 796         .help       = "dump guest memory to file",
 797         .user_print = monitor_user_noop,
 798         .mhandler.cmd_new = qmp_marshal_input_dump_guest_memory,
 799     },
 800
 801 SQMP
 802 dump
 803
 804
 805 Dump guest memory to file. The file can be processed with crash or gdb.
 806
 807 Arguments:
 808
 809 - "paging": do paging to get guest's memory mapping (json-bool)
 810 - "protocol": destination file(started with "file:") or destination file
 811               descriptor (started with "fd:") (json-string)
 812 - "begin": the starting physical address. It's optional, and should be specified
 813            with length together (json-int)
 814 - "length": the memory size, in bytes. It's optional, and should be specified
 815             with begin together (json-int)
 816
 817 Example:
 818
 819 -> { "execute": "dump-guest-memory", "arguments": { "protocol": "fd:dump" } }
 820 <- { "return": {} }
 821
 822 Notes:
 823
 824 (1) All boolean arguments default to false
 825
 826 EQMP
 827
 828     {
 829         .name       = "netdev_add",
 830         .args_type  = "netdev:O",
 831         .mhandler.cmd_new = qmp_netdev_add,
 832     },
 833
 834 SQMP
 835 netdev_add
 836 ----------
 837
 838 Add host network device.
 839
 840 Arguments:
 841
 842 - "type": the device type, "tap", "user", ... (json-string)
 843 - "id": the device's ID, must be unique (json-string)
 844 - device options
 845
 846 Example:
 847
 848 -> { "execute": "netdev_add", "arguments": { "type": "user", "id": "netdev1" } }
 849 <- { "return": {} }
 850
 851 Note: The supported device options are the same ones supported by the '-netdev'
 852       command-line argument, which are listed in the '-help' output or QEMU's
 853       manual
 854
 855 EQMP
 856
 857     {
 858         .name       = "netdev_del",
 859         .args_type  = "id:s",
 860         .mhandler.cmd_new = qmp_marshal_input_netdev_del,
 861     },
 862
 863 SQMP
 864 netdev_del
 865 ----------
 866
 867 Remove host network device.
 868
 869 Arguments:
 870
 871 - "id": the device's ID, must be unique (json-string)
 872
 873 Example:
 874
 875 -> { "execute": "netdev_del", "arguments": { "id": "netdev1" } }
 876 <- { "return": {} }
 877
 878
 879 EQMP
 880
 881     {
 882         .name       = "block_resize",
 883         .args_type  = "device:B,size:o",
 884         .mhandler.cmd_new = qmp_marshal_input_block_resize,
 885     },
 886
 887 SQMP
 888 block_resize
 889 ------------
 890
 891 Resize a block image while a guest is running.
 892
 893 Arguments:
 894
 895 - "device": the device's ID, must be unique (json-string)
 896 - "size": new size
 897
 898 Example:
 899
 900 -> { "execute": "block_resize", "arguments": { "device": "scratch", "size": 1073741824 } }
 901 <- { "return": {} }
 902
 903 EQMP
 904
 905     {
 906         .name       = "block-stream",
 907         .args_type  = "device:B,base:s?,speed:o?,on-error:s?",
 908         .mhandler.cmd_new = qmp_marshal_input_block_stream,
 909     },
 910
 911     {
 912         .name       = "block-commit",
 913         .args_type  = "device:B,base:s?,top:s,speed:o?",
 914         .mhandler.cmd_new = qmp_marshal_input_block_commit,
 915     },
 916
 917     {
 918         .name       = "drive-backup",
 919         .args_type  = "sync:s,device:B,target:s,speed:i?,mode:s?,format:s?,"
 920                       "on-source-error:s?,on-target-error:s?",
 921         .mhandler.cmd_new = qmp_marshal_input_drive_backup,
 922     },
 923
 924 SQMP
 925 drive-backup
 926 ------------
 927
 928 Start a point-in-time copy of a block device to a new destination.  The
 929 status of ongoing drive-backup operations can be checked with
 930 query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
 931 The operation can be stopped before it has completed using the
 932 block-job-cancel command.
 933
 934 Arguments:
 935
 936 - "device": the name of the device which should be copied.
 937             (json-string)
 938 - "target": the target of the new image. If the file exists, or if it is a
 939             device, the existing file/device will be used as the new
 940             destination.  If it does not exist, a new file will be created.
 941             (json-string)
 942 - "format": the format of the new destination, default is to probe if 'mode' is
 943             'existing', else the format of the source
 944             (json-string, optional)
 945 - "sync": what parts of the disk image should be copied to the destination;
 946   possibilities include "full" for all the disk, "top" for only the sectors
 947   allocated in the topmost image, or "none" to only replicate new I/O
 948   (MirrorSyncMode).
 949 - "mode": whether and how QEMU should create a new image
 950           (NewImageMode, optional, default 'absolute-paths')
 951 - "speed": the maximum speed, in bytes per second (json-int, optional)
 952 - "on-source-error": the action to take on an error on the source, default
 953                      'report'.  'stop' and 'enospc' can only be used
 954                      if the block device supports io-status.
 955                      (BlockdevOnError, optional)
 956 - "on-target-error": the action to take on an error on the target, default
 957                      'report' (no limitations, since this applies to
 958                      a different block device than device).
 959                      (BlockdevOnError, optional)
 960
 961 Example:
 962 -> { "execute": "drive-backup", "arguments": { "device": "drive0",
 963                                                "sync": "full",
 964                                                "target": "backup.img" } }
 965 <- { "return": {} }
 966 EQMP
 967
 968     {
 969         .name       = "block-job-set-speed",
 970         .args_type  = "device:B,speed:o",
 971         .mhandler.cmd_new = qmp_marshal_input_block_job_set_speed,
 972     },
 973
 974     {
 975         .name       = "block-job-cancel",
 976         .args_type  = "device:B,force:b?",
 977         .mhandler.cmd_new = qmp_marshal_input_block_job_cancel,
 978     },
 979     {
 980         .name       = "block-job-pause",
 981         .args_type  = "device:B",
 982         .mhandler.cmd_new = qmp_marshal_input_block_job_pause,
 983     },
 984     {
 985         .name       = "block-job-resume",
 986         .args_type  = "device:B",
 987         .mhandler.cmd_new = qmp_marshal_input_block_job_resume,
 988     },
 989     {
 990         .name       = "block-job-complete",
 991         .args_type  = "device:B",
 992         .mhandler.cmd_new = qmp_marshal_input_block_job_complete,
 993     },
 994     {
 995         .name       = "transaction",
 996         .args_type  = "actions:q",
 997         .mhandler.cmd_new = qmp_marshal_input_transaction,
 998     },
 999
1000 SQMP
1001 transaction
1002 -----------
1003
1004 Atomically operate on one or more block devices.  The only supported
1005 operation for now is snapshotting.  If there is any failure performing
1006 any of the operations, all snapshots for the group are abandoned, and
1007 the original disks pre-snapshot attempt are used.
1008
1009 A list of dictionaries is accepted, that contains the actions to be performed.
1010 For snapshots this is the device, the file to use for the new snapshot,
1011 and the format.  The default format, if not specified, is qcow2.
1012
1013 Each new snapshot defaults to being created by QEMU (wiping any
1014 contents if the file already exists), but it is also possible to reuse
1015 an externally-created file.  In the latter case, you should ensure that
1016 the new image file has the same contents as the current one; QEMU cannot
1017 perform any meaningful check.  Typically this is achieved by using the
1018 current image file as the backing file for the new image.
1019
1020 Arguments:
1021
1022 actions array:
1023     - "type": the operation to perform.  The only supported
1024       value is "blockdev-snapshot-sync". (json-string)
1025     - "data": a dictionary.  The contents depend on the value
1026       of "type".  When "type" is "blockdev-snapshot-sync":
1027       - "device": device name to snapshot (json-string)
1028       - "snapshot-file": name of new image file (json-string)
1029       - "format": format of new image (json-string, optional)
1030       - "mode": whether and how QEMU should create the snapshot file
1031         (NewImageMode, optional, default "absolute-paths")
1032
1033 Example:
1034
1035 -> { "execute": "transaction",
1036      "arguments": { "actions": [
1037          { 'type': 'blockdev-snapshot-sync', 'data' : { "device": "ide-hd0",
1038                                          "snapshot-file": "/some/place/my-image",
1039                                          "format": "qcow2" } },
1040          { 'type': 'blockdev-snapshot-sync', 'data' : { "device": "ide-hd1",
1041                                          "snapshot-file": "/some/place/my-image2",
1042                                          "mode": "existing",
1043                                          "format": "qcow2" } } ] } }
1044 <- { "return": {} }
1045
1046 EQMP
1047
1048     {
1049         .name       = "blockdev-snapshot-sync",
1050         .args_type  = "device:B,snapshot-file:s,format:s?,mode:s?",
1051         .mhandler.cmd_new = qmp_marshal_input_blockdev_snapshot_sync,
1052     },
1053
1054 SQMP
1055 blockdev-snapshot-sync
1056 ----------------------
1057
1058 Synchronous snapshot of a block device. snapshot-file specifies the
1059 target of the new image. If the file exists, or if it is a device, the
1060 snapshot will be created in the existing file/device. If does not
1061 exist, a new file will be created. format specifies the format of the
1062 snapshot image, default is qcow2.
1063
1064 Arguments:
1065
1066 - "device": device name to snapshot (json-string)
1067 - "snapshot-file": name of new image file (json-string)
1068 - "mode": whether and how QEMU should create the snapshot file
1069   (NewImageMode, optional, default "absolute-paths")
1070 - "format": format of new image (json-string, optional)
1071
1072 Example:
1073
1074 -> { "execute": "blockdev-snapshot-sync", "arguments": { "device": "ide-hd0",
1075                                                          "snapshot-file":
1076                                                         "/some/place/my-image",
1077                                                         "format": "qcow2" } }
1078 <- { "return": {} }
1079
1080 EQMP
1081
1082     {
1083         .name       = "drive-mirror",
1084         .args_type  = "sync:s,device:B,target:s,speed:i?,mode:s?,format:s?,"
1085                       "on-source-error:s?,on-target-error:s?,"
1086                       "granularity:i?,buf-size:i?",
1087         .mhandler.cmd_new = qmp_marshal_input_drive_mirror,
1088     },
1089
1090 SQMP
1091 drive-mirror
1092 ------------
1093
1094 Start mirroring a block device's writes to a new destination. target
1095 specifies the target of the new image. If the file exists, or if it is
1096 a device, it will be used as the new destination for writes. If it does not
1097 exist, a new file will be created. format specifies the format of the
1098 mirror image, default is to probe if mode='existing', else the format
1099 of the source.
1100
1101 Arguments:
1102
1103 - "device": device name to operate on (json-string)
1104 - "target": name of new image file (json-string)
1105 - "format": format of new image (json-string, optional)
1106 - "mode": how an image file should be created into the target
1107   file/device (NewImageMode, optional, default 'absolute-paths')
1108 - "speed": maximum speed of the streaming job, in bytes per second
1109   (json-int)
1110 - "granularity": granularity of the dirty bitmap, in bytes (json-int, optional)
1111 - "buf_size": maximum amount of data in flight from source to target, in bytes
1112   (json-int, default 10M)
1113 - "sync": what parts of the disk image should be copied to the destination;
1114   possibilities include "full" for all the disk, "top" for only the sectors
1115   allocated in the topmost image, or "none" to only replicate new I/O
1116   (MirrorSyncMode).
1117 - "on-source-error": the action to take on an error on the source
1118   (BlockdevOnError, default 'report')
1119 - "on-target-error": the action to take on an error on the target
1120   (BlockdevOnError, default 'report')
1121
1122 The default value of the granularity is the image cluster size clamped
1123 between 4096 and 65536, if the image format defines one.  If the format
1124 does not define a cluster size, the default value of the granularity
1125 is 65536.
1126
1127
1128 Example:
1129
1130 -> { "execute": "drive-mirror", "arguments": { "device": "ide-hd0",
1131                                                "target": "/some/place/my-image",
1132                                                "sync": "full",
1133                                                "format": "qcow2" } }
1134 <- { "return": {} }
1135
1136 EQMP
1137
1138     {
1139         .name       = "balloon",
1140         .args_type  = "value:M",
1141         .mhandler.cmd_new = qmp_marshal_input_balloon,
1142     },
1143
1144 SQMP
1145 balloon
1146 -------
1147
1148 Request VM to change its memory allocation (in bytes).
1149
1150 Arguments:
1151
1152 - "value": New memory allocation (json-int)
1153
1154 Example:
1155
1156 -> { "execute": "balloon", "arguments": { "value": 536870912 } }
1157 <- { "return": {} }
1158
1159 EQMP
1160
1161     {
1162         .name       = "set_link",
1163         .args_type  = "name:s,up:b",
1164         .mhandler.cmd_new = qmp_marshal_input_set_link,
1165     },
1166
1167 SQMP
1168 set_link
1169 --------
1170
1171 Change the link status of a network adapter.
1172
1173 Arguments:
1174
1175 - "name": network device name (json-string)
1176 - "up": status is up (json-bool)
1177
1178 Example:
1179
1180 -> { "execute": "set_link", "arguments": { "name": "e1000.0", "up": false } }
1181 <- { "return": {} }
1182
1183 EQMP
1184
1185     {
1186         .name       = "getfd",
1187         .args_type  = "fdname:s",
1188         .params     = "getfd name",
1189         .help       = "receive a file descriptor via SCM rights and assign it a name",
1190         .mhandler.cmd_new = qmp_marshal_input_getfd,
1191     },
1192
1193 SQMP
1194 getfd
1195 -----
1196
1197 Receive a file descriptor via SCM rights and assign it a name.
1198
1199 Arguments:
1200
1201 - "fdname": file descriptor name (json-string)
1202
1203 Example:
1204
1205 -> { "execute": "getfd", "arguments": { "fdname": "fd1" } }
1206 <- { "return": {} }
1207
1208 Notes:
1209
1210 (1) If the name specified by the "fdname" argument already exists,
1211     the file descriptor assigned to it will be closed and replaced
1212     by the received file descriptor.
1213 (2) The 'closefd' command can be used to explicitly close the file
1214     descriptor when it is no longer needed.
1215
1216 EQMP
1217
1218     {
1219         .name       = "closefd",
1220         .args_type  = "fdname:s",
1221         .params     = "closefd name",
1222         .help       = "close a file descriptor previously passed via SCM rights",
1223         .mhandler.cmd_new = qmp_marshal_input_closefd,
1224     },
1225
1226 SQMP
1227 closefd
1228 -------
1229
1230 Close a file descriptor previously passed via SCM rights.
1231
1232 Arguments:
1233
1234 - "fdname": file descriptor name (json-string)
1235
1236 Example:
1237
1238 -> { "execute": "closefd", "arguments": { "fdname": "fd1" } }
1239 <- { "return": {} }
1240
1241 EQMP
1242
1243      {
1244         .name       = "add-fd",
1245         .args_type  = "fdset-id:i?,opaque:s?",
1246         .params     = "add-fd fdset-id opaque",
1247         .help       = "Add a file descriptor, that was passed via SCM rights, to an fd set",
1248         .mhandler.cmd_new = qmp_marshal_input_add_fd,
1249     },
1250
1251 SQMP
1252 add-fd
1253 -------
1254
1255 Add a file descriptor, that was passed via SCM rights, to an fd set.
1256
1257 Arguments:
1258
1259 - "fdset-id": The ID of the fd set to add the file descriptor to.
1260               (json-int, optional)
1261 - "opaque": A free-form string that can be used to describe the fd.
1262             (json-string, optional)
1263
1264 Return a json-object with the following information:
1265
1266 - "fdset-id": The ID of the fd set that the fd was added to. (json-int)
1267 - "fd": The file descriptor that was received via SCM rights and added to the
1268         fd set. (json-int)
1269
1270 Example:
1271
1272 -> { "execute": "add-fd", "arguments": { "fdset-id": 1 } }
1273 <- { "return": { "fdset-id": 1, "fd": 3 } }
1274
1275 Notes:
1276
1277 (1) The list of fd sets is shared by all monitor connections.
1278 (2) If "fdset-id" is not specified, a new fd set will be created.
1279
1280 EQMP
1281
1282      {
1283         .name       = "remove-fd",
1284         .args_type  = "fdset-id:i,fd:i?",
1285         .params     = "remove-fd fdset-id fd",
1286         .help       = "Remove a file descriptor from an fd set",
1287         .mhandler.cmd_new = qmp_marshal_input_remove_fd,
1288     },
1289
1290 SQMP
1291 remove-fd
1292 ---------
1293
1294 Remove a file descriptor from an fd set.
1295
1296 Arguments:
1297
1298 - "fdset-id": The ID of the fd set that the file descriptor belongs to.
1299               (json-int)
1300 - "fd": The file descriptor that is to be removed. (json-int, optional)
1301
1302 Example:
1303
1304 -> { "execute": "remove-fd", "arguments": { "fdset-id": 1, "fd": 3 } }
1305 <- { "return": {} }
1306
1307 Notes:
1308
1309 (1) The list of fd sets is shared by all monitor connections.
1310 (2) If "fd" is not specified, all file descriptors in "fdset-id" will be
1311     removed.
1312
1313 EQMP
1314
1315     {
1316         .name       = "query-fdsets",
1317         .args_type  = "",
1318         .help       = "Return information describing all fd sets",
1319         .mhandler.cmd_new = qmp_marshal_input_query_fdsets,
1320     },
1321
1322 SQMP
1323 query-fdsets
1324 -------------
1325
1326 Return information describing all fd sets.
1327
1328 Arguments: None
1329
1330 Example:
1331
1332 -> { "execute": "query-fdsets" }
1333 <- { "return": [
1334        {
1335          "fds": [
1336            {
1337              "fd": 30,
1338              "opaque": "rdonly:/path/to/file"
1339            },
1340            {
1341              "fd": 24,
1342              "opaque": "rdwr:/path/to/file"
1343            }
1344          ],
1345          "fdset-id": 1
1346        },
1347        {
1348          "fds": [
1349            {
1350              "fd": 28
1351            },
1352            {
1353              "fd": 29
1354            }
1355          ],
1356          "fdset-id": 0
1357        }
1358      ]
1359    }
1360
1361 Note: The list of fd sets is shared by all monitor connections.
1362
1363 EQMP
1364
1365     {
1366         .name       = "block_passwd",
1367         .args_type  = "device:B,password:s",
1368         .mhandler.cmd_new = qmp_marshal_input_block_passwd,
1369     },
1370
1371 SQMP
1372 block_passwd
1373 ------------
1374
1375 Set the password of encrypted block devices.
1376
1377 Arguments:
1378
1379 - "device": device name (json-string)
1380 - "password": password (json-string)
1381
1382 Example:
1383
1384 -> { "execute": "block_passwd", "arguments": { "device": "ide0-hd0",
1385                                                "password": "12345" } }
1386 <- { "return": {} }
1387
1388 EQMP
1389
1390     {
1391         .name       = "block_set_io_throttle",
1392         .args_type  = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l,bps_max:l?,bps_rd_max:l?,bps_wr_max:l?,iops_max:l?,iops_rd_max:l?,iops_wr_max:l?,iops_size:l?",
1393         .mhandler.cmd_new = qmp_marshal_input_block_set_io_throttle,
1394     },
1395
1396 SQMP
1397 block_set_io_throttle
1398 ------------
1399
1400 Change I/O throttle limits for a block drive.
1401
1402 Arguments:
1403
1404 - "device": device name (json-string)
1405 - "bps": total throughput limit in bytes per second (json-int)
1406 - "bps_rd": read throughput limit in bytes per second (json-int)
1407 - "bps_wr": write throughput limit in bytes per second (json-int)
1408 - "iops": total I/O operations per second (json-int)
1409 - "iops_rd": read I/O operations per second (json-int)
1410 - "iops_wr": write I/O operations per second (json-int)
1411 - "bps_max":  total max in bytes (json-int)
1412 - "bps_rd_max":  read max in bytes (json-int)
1413 - "bps_wr_max":  write max in bytes (json-int)
1414 - "iops_max":  total I/O operations max (json-int)
1415 - "iops_rd_max":  read I/O operations max (json-int)
1416 - "iops_wr_max":  write I/O operations max (json-int)
1417 - "iops_size":  I/O size in bytes when limiting (json-int)
1418
1419 Example:
1420
1421 -> { "execute": "block_set_io_throttle", "arguments": { "device": "virtio0",
1422                                                "bps": 1000000,
1423                                                "bps_rd": 0,
1424                                                "bps_wr": 0,
1425                                                "iops": 0,
1426                                                "iops_rd": 0,
1427                                                "iops_wr": 0,
1428                                                "bps_max": 8000000,
1429                                                "bps_rd_max": 0,
1430                                                "bps_wr_max": 0,
1431                                                "iops_max": 0,
1432                                                "iops_rd_max": 0,
1433                                                "iops_wr_max": 0,
1434                                                "iops_size": 0 } }
1435 <- { "return": {} }
1436
1437 EQMP
1438
1439     {
1440         .name       = "set_password",
1441         .args_type  = "protocol:s,password:s,connected:s?",
1442         .mhandler.cmd_new = qmp_marshal_input_set_password,
1443     },
1444
1445 SQMP
1446 set_password
1447 ------------
1448
1449 Set the password for vnc/spice protocols.
1450
1451 Arguments:
1452
1453 - "protocol": protocol name (json-string)
1454 - "password": password (json-string)
1455 - "connected": [ keep | disconnect | fail ] (josn-string, optional)
1456
1457 Example:
1458
1459 -> { "execute": "set_password", "arguments": { "protocol": "vnc",
1460                                                "password": "secret" } }
1461 <- { "return": {} }
1462
1463 EQMP
1464
1465     {
1466         .name       = "expire_password",
1467         .args_type  = "protocol:s,time:s",
1468         .mhandler.cmd_new = qmp_marshal_input_expire_password,
1469     },
1470
1471 SQMP
1472 expire_password
1473 ---------------
1474
1475 Set the password expire time for vnc/spice protocols.
1476
1477 Arguments:
1478
1479 - "protocol": protocol name (json-string)
1480 - "time": [ now | never | +secs | secs ] (json-string)
1481
1482 Example:
1483
1484 -> { "execute": "expire_password", "arguments": { "protocol": "vnc",
1485                                                   "time": "+60" } }
1486 <- { "return": {} }
1487
1488 EQMP
1489
1490     {
1491         .name       = "add_client",
1492         .args_type  = "protocol:s,fdname:s,skipauth:b?,tls:b?",
1493         .mhandler.cmd_new = qmp_marshal_input_add_client,
1494     },
1495
1496 SQMP
1497 add_client
1498 ----------
1499
1500 Add a graphics client
1501
1502 Arguments:
1503
1504 - "protocol": protocol name (json-string)
1505 - "fdname": file descriptor name (json-string)
1506 - "skipauth": whether to skip authentication (json-bool, optional)
1507 - "tls": whether to perform TLS (json-bool, optional)
1508
1509 Example:
1510
1511 -> { "execute": "add_client", "arguments": { "protocol": "vnc",
1512                                              "fdname": "myclient" } }
1513 <- { "return": {} }
1514
1515 EQMP
1516     {
1517         .name       = "qmp_capabilities",
1518         .args_type  = "",
1519         .params     = "",
1520         .help       = "enable QMP capabilities",
1521         .user_print = monitor_user_noop,
1522         .mhandler.cmd_new = do_qmp_capabilities,
1523     },
1524
1525 SQMP
1526 qmp_capabilities
1527 ----------------
1528
1529 Enable QMP capabilities.
1530
1531 Arguments: None.
1532
1533 Example:
1534
1535 -> { "execute": "qmp_capabilities" }
1536 <- { "return": {} }
1537
1538 Note: This command must be issued before issuing any other command.
1539
1540 EQMP
1541
1542     {
1543         .name       = "human-monitor-command",
1544         .args_type  = "command-line:s,cpu-index:i?",
1545         .mhandler.cmd_new = qmp_marshal_input_human_monitor_command,
1546     },
1547
1548 SQMP
1549 human-monitor-command
1550 ---------------------
1551
1552 Execute a Human Monitor command.
1553
1554 Arguments:
1555
1556 - command-line: the command name and its arguments, just like the
1557                 Human Monitor's shell (json-string)
1558 - cpu-index: select the CPU number to be used by commands which access CPU
1559              data, like 'info registers'. The Monitor selects CPU 0 if this
1560              argument is not provided (json-int, optional)
1561
1562 Example:
1563
1564 -> { "execute": "human-monitor-command", "arguments": { "command-line": "info kvm" } }
1565 <- { "return": "kvm support: enabled\r\n" }
1566
1567 Notes:
1568
1569 (1) The Human Monitor is NOT an stable interface, this means that command
1570     names, arguments and responses can change or be removed at ANY time.
1571     Applications that rely on long term stability guarantees should NOT
1572     use this command
1573
1574 (2) Limitations:
1575
1576     o This command is stateless, this means that commands that depend
1577       on state information (such as getfd) might not work
1578
1579     o Commands that prompt the user for data (eg. 'cont' when the block
1580       device is encrypted) don't currently work
1581
1582 3. Query Commands
1583 =================
1584
1585 HXCOMM Each query command below is inside a SQMP/EQMP section, do NOT change
1586 HXCOMM this! We will possibly move query commands definitions inside those
1587 HXCOMM sections, just like regular commands.
1588
1589 EQMP
1590
1591 SQMP
1592 query-version
1593 -------------
1594
1595 Show QEMU version.
1596
1597 Return a json-object with the following information:
1598
1599 - "qemu": A json-object containing three integer values:
1600     - "major": QEMU's major version (json-int)
1601     - "minor": QEMU's minor version (json-int)
1602     - "micro": QEMU's micro version (json-int)
1603 - "package": package's version (json-string)
1604
1605 Example:
1606
1607 -> { "execute": "query-version" }
1608 <- {
1609       "return":{
1610          "qemu":{
1611             "major":0,
1612             "minor":11,
1613             "micro":5
1614          },
1615          "package":""
1616       }
1617    }
1618
1619 EQMP
1620
1621     {
1622         .name       = "query-version",
1623         .args_type  = "",
1624         .mhandler.cmd_new = qmp_marshal_input_query_version,
1625     },
1626
1627 SQMP
1628 query-commands
1629 --------------
1630
1631 List QMP available commands.
1632
1633 Each command is represented by a json-object, the returned value is a json-array
1634 of all commands.
1635
1636 Each json-object contain:
1637
1638 - "name": command's name (json-string)
1639
1640 Example:
1641
1642 -> { "execute": "query-commands" }
1643 <- {
1644       "return":[
1645          {
1646             "name":"query-balloon"
1647          },
1648          {
1649             "name":"system_powerdown"
1650          }
1651       ]
1652    }
1653
1654 Note: This example has been shortened as the real response is too long.
1655
1656 EQMP
1657
1658     {
1659         .name       = "query-commands",
1660         .args_type  = "",
1661         .mhandler.cmd_new = qmp_marshal_input_query_commands,
1662     },
1663
1664 SQMP
1665 query-events
1666 --------------
1667
1668 List QMP available events.
1669
1670 Each event is represented by a json-object, the returned value is a json-array
1671 of all events.
1672
1673 Each json-object contains:
1674
1675 - "name": event's name (json-string)
1676
1677 Example:
1678
1679 -> { "execute": "query-events" }
1680 <- {
1681       "return":[
1682          {
1683             "name":"SHUTDOWN"
1684          },
1685          {
1686             "name":"RESET"
1687          }
1688       ]
1689    }
1690
1691 Note: This example has been shortened as the real response is too long.
1692
1693 EQMP
1694
1695     {
1696         .name       = "query-events",
1697         .args_type  = "",
1698         .mhandler.cmd_new = qmp_marshal_input_query_events,
1699     },
1700
1701 SQMP
1702 query-chardev
1703 -------------
1704
1705 Each device is represented by a json-object. The returned value is a json-array
1706 of all devices.
1707
1708 Each json-object contain the following:
1709
1710 - "label": device's label (json-string)
1711 - "filename": device's file (json-string)
1712
1713 Example:
1714
1715 -> { "execute": "query-chardev" }
1716 <- {
1717       "return":[
1718          {
1719             "label":"monitor",
1720             "filename":"stdio"
1721          },
1722          {
1723             "label":"serial0",
1724             "filename":"vc"
1725          }
1726       ]
1727    }
1728
1729 EQMP
1730
1731     {
1732         .name       = "query-chardev",
1733         .args_type  = "",
1734         .mhandler.cmd_new = qmp_marshal_input_query_chardev,
1735     },
1736
1737 SQMP
1738 query-block
1739 -----------
1740
1741 Show the block devices.
1742
1743 Each block device information is stored in a json-object and the returned value
1744 is a json-array of all devices.
1745
1746 Each json-object contain the following:
1747
1748 - "device": device name (json-string)
1749 - "type": device type (json-string)
1750          - deprecated, retained for backward compatibility
1751          - Possible values: "unknown"
1752 - "removable": true if the device is removable, false otherwise (json-bool)
1753 - "locked": true if the device is locked, false otherwise (json-bool)
1754 - "tray_open": only present if removable, true if the device has a tray,
1755                and it is open (json-bool)
1756 - "inserted": only present if the device is inserted, it is a json-object
1757    containing the following:
1758          - "file": device file name (json-string)
1759          - "ro": true if read-only, false otherwise (json-bool)
1760          - "drv": driver format name (json-string)
1761              - Possible values: "blkdebug", "bochs", "cloop", "cow", "dmg",
1762                                 "file", "file", "ftp", "ftps", "host_cdrom",
1763                                 "host_device", "host_floppy", "http", "https",
1764                                 "nbd", "parallels", "qcow", "qcow2", "raw",
1765                                 "tftp", "vdi", "vmdk", "vpc", "vvfat"
1766          - "backing_file": backing file name (json-string, optional)
1767          - "backing_file_depth": number of files in the backing file chain (json-int)
1768          - "encrypted": true if encrypted, false otherwise (json-bool)
1769          - "bps": limit total bytes per second (json-int)
1770          - "bps_rd": limit read bytes per second (json-int)
1771          - "bps_wr": limit write bytes per second (json-int)
1772          - "iops": limit total I/O operations per second (json-int)
1773          - "iops_rd": limit read operations per second (json-int)
1774          - "iops_wr": limit write operations per second (json-int)
1775          - "bps_max":  total max in bytes (json-int)
1776          - "bps_rd_max":  read max in bytes (json-int)
1777          - "bps_wr_max":  write max in bytes (json-int)
1778          - "iops_max":  total I/O operations max (json-int)
1779          - "iops_rd_max":  read I/O operations max (json-int)
1780          - "iops_wr_max":  write I/O operations max (json-int)
1781          - "iops_size": I/O size when limiting by iops (json-int)
1782          - "image": the detail of the image, it is a json-object containing
1783             the following:
1784              - "filename": image file name (json-string)
1785              - "format": image format (json-string)
1786              - "virtual-size": image capacity in bytes (json-int)
1787              - "dirty-flag": true if image is not cleanly closed, not present
1788                              means clean (json-bool, optional)
1789              - "actual-size": actual size on disk in bytes of the image, not
1790                               present when image does not support thin
1791                               provision (json-int, optional)
1792              - "cluster-size": size of a cluster in bytes, not present if image
1793                                format does not support it (json-int, optional)
1794              - "encrypted": true if the image is encrypted, not present means
1795                             false or the image format does not support
1796                             encryption (json-bool, optional)
1797              - "backing_file": backing file name, not present means no backing
1798                                file is used or the image format does not
1799                                support backing file chain
1800                                (json-string, optional)
1801              - "full-backing-filename": full path of the backing file, not
1802                                         present if it equals backing_file or no
1803                                         backing file is used
1804                                         (json-string, optional)
1805              - "backing-filename-format": the format of the backing file, not
1806                                           present means unknown or no backing
1807                                           file (json-string, optional)
1808              - "snapshots": the internal snapshot info, it is an optional list
1809                 of json-object containing the following:
1810                  - "id": unique snapshot id (json-string)
1811                  - "name": snapshot name (json-string)
1812                  - "vm-state-size": size of the VM state in bytes (json-int)
1813                  - "date-sec": UTC date of the snapshot in seconds (json-int)
1814                  - "date-nsec": fractional part in nanoseconds to be used with
1815                                 date-sec (json-int)
1816                  - "vm-clock-sec": VM clock relative to boot in seconds
1817                                    (json-int)
1818                  - "vm-clock-nsec": fractional part in nanoseconds to be used
1819                                     with vm-clock-sec (json-int)
1820              - "backing-image": the detail of the backing image, it is an
1821                                 optional json-object only present when a
1822                                 backing image present for this image
1823
1824 - "io-status": I/O operation status, only present if the device supports it
1825                and the VM is configured to stop on errors. It's always reset
1826                to "ok" when the "cont" command is issued (json_string, optional)
1827              - Possible values: "ok", "failed", "nospace"
1828
1829 Example:
1830
1831 -> { "execute": "query-block" }
1832 <- {
1833       "return":[
1834          {
1835             "io-status": "ok",
1836             "device":"ide0-hd0",
1837             "locked":false,
1838             "removable":false,
1839             "inserted":{
1840                "ro":false,
1841                "drv":"qcow2",
1842                "encrypted":false,
1843                "file":"disks/test.qcow2",
1844                "backing_file_depth":1,
1845                "bps":1000000,
1846                "bps_rd":0,
1847                "bps_wr":0,
1848                "iops":1000000,
1849                "iops_rd":0,
1850                "iops_wr":0,
1851                "bps_max": 8000000,
1852                "bps_rd_max": 0,
1853                "bps_wr_max": 0,
1854                "iops_max": 0,
1855                "iops_rd_max": 0,
1856                "iops_wr_max": 0,
1857                "iops_size": 0,
1858                "image":{
1859                   "filename":"disks/test.qcow2",
1860                   "format":"qcow2",
1861                   "virtual-size":2048000,
1862                   "backing_file":"base.qcow2",
1863                   "full-backing-filename":"disks/base.qcow2",
1864                   "backing-filename-format:"qcow2",
1865                   "snapshots":[
1866                      {
1867                         "id": "1",
1868                         "name": "snapshot1",
1869                         "vm-state-size": 0,
1870                         "date-sec": 10000200,
1871                         "date-nsec": 12,
1872                         "vm-clock-sec": 206,
1873                         "vm-clock-nsec": 30
1874                      }
1875                   ],
1876                   "backing-image":{
1877                       "filename":"disks/base.qcow2",
1878                       "format":"qcow2",
1879                       "virtual-size":2048000
1880                   }
1881                }
1882             },
1883             "type":"unknown"
1884          },
1885          {
1886             "io-status": "ok",
1887             "device":"ide1-cd0",
1888             "locked":false,
1889             "removable":true,
1890             "type":"unknown"
1891          },
1892          {
1893             "device":"floppy0",
1894             "locked":false,
1895             "removable":true,
1896             "type":"unknown"
1897          },
1898          {
1899             "device":"sd0",
1900             "locked":false,
1901             "removable":true,
1902             "type":"unknown"
1903          }
1904       ]
1905    }
1906
1907 EQMP
1908
1909     {
1910         .name       = "query-block",
1911         .args_type  = "",
1912         .mhandler.cmd_new = qmp_marshal_input_query_block,
1913     },
1914
1915 SQMP
1916 query-blockstats
1917 ----------------
1918
1919 Show block device statistics.
1920
1921 Each device statistic information is stored in a json-object and the returned
1922 value is a json-array of all devices.
1923
1924 Each json-object contain the following:
1925
1926 - "device": device name (json-string)
1927 - "stats": A json-object with the statistics information, it contains:
1928     - "rd_bytes": bytes read (json-int)
1929     - "wr_bytes": bytes written (json-int)
1930     - "rd_operations": read operations (json-int)
1931     - "wr_operations": write operations (json-int)
1932     - "flush_operations": cache flush operations (json-int)
1933     - "wr_total_time_ns": total time spend on writes in nano-seconds (json-int)
1934     - "rd_total_time_ns": total time spend on reads in nano-seconds (json-int)
1935     - "flush_total_time_ns": total time spend on cache flushes in nano-seconds (json-int)
1936     - "wr_highest_offset": Highest offset of a sector written since the
1937                            BlockDriverState has been opened (json-int)
1938 - "parent": Contains recursively the statistics of the underlying
1939             protocol (e.g. the host file for a qcow2 image). If there is
1940             no underlying protocol, this field is omitted
1941             (json-object, optional)
1942
1943 Example:
1944
1945 -> { "execute": "query-blockstats" }
1946 <- {
1947       "return":[
1948          {
1949             "device":"ide0-hd0",
1950             "parent":{
1951                "stats":{
1952                   "wr_highest_offset":3686448128,
1953                   "wr_bytes":9786368,
1954                   "wr_operations":751,
1955                   "rd_bytes":122567168,
1956                   "rd_operations":36772
1957                   "wr_total_times_ns":313253456
1958                   "rd_total_times_ns":3465673657
1959                   "flush_total_times_ns":49653
1960                   "flush_operations":61,
1961                }
1962             },
1963             "stats":{
1964                "wr_highest_offset":2821110784,
1965                "wr_bytes":9786368,
1966                "wr_operations":692,
1967                "rd_bytes":122739200,
1968                "rd_operations":36604
1969                "flush_operations":51,
1970                "wr_total_times_ns":313253456
1971                "rd_total_times_ns":3465673657
1972                "flush_total_times_ns":49653
1973             }
1974          },
1975          {
1976             "device":"ide1-cd0",
1977             "stats":{
1978                "wr_highest_offset":0,
1979                "wr_bytes":0,
1980                "wr_operations":0,
1981                "rd_bytes":0,
1982                "rd_operations":0
1983                "flush_operations":0,
1984                "wr_total_times_ns":0
1985                "rd_total_times_ns":0
1986                "flush_total_times_ns":0
1987             }
1988          },
1989          {
1990             "device":"floppy0",
1991             "stats":{
1992                "wr_highest_offset":0,
1993                "wr_bytes":0,
1994                "wr_operations":0,
1995                "rd_bytes":0,
1996                "rd_operations":0
1997                "flush_operations":0,
1998                "wr_total_times_ns":0
1999                "rd_total_times_ns":0
2000                "flush_total_times_ns":0
2001             }
2002          },
2003          {
2004             "device":"sd0",
2005             "stats":{
2006                "wr_highest_offset":0,
2007                "wr_bytes":0,
2008                "wr_operations":0,
2009                "rd_bytes":0,
2010                "rd_operations":0
2011                "flush_operations":0,
2012                "wr_total_times_ns":0
2013                "rd_total_times_ns":0
2014                "flush_total_times_ns":0
2015             }
2016          }
2017       ]
2018    }
2019
2020 EQMP
2021
2022     {
2023         .name       = "query-blockstats",
2024         .args_type  = "",
2025         .mhandler.cmd_new = qmp_marshal_input_query_blockstats,
2026     },
2027
2028 SQMP
2029 query-cpus
2030 ----------
2031
2032 Show CPU information.
2033
2034 Return a json-array. Each CPU is represented by a json-object, which contains:
2035
2036 - "CPU": CPU index (json-int)
2037 - "current": true if this is the current CPU, false otherwise (json-bool)
2038 - "halted": true if the cpu is halted, false otherwise (json-bool)
2039 - Current program counter. The key's name depends on the architecture:
2040      "pc": i386/x86_64 (json-int)
2041      "nip": PPC (json-int)
2042      "pc" and "npc": sparc (json-int)
2043      "PC": mips (json-int)
2044 - "thread_id": ID of the underlying host thread (json-int)
2045
2046 Example:
2047
2048 -> { "execute": "query-cpus" }
2049 <- {
2050       "return":[
2051          {
2052             "CPU":0,
2053             "current":true,
2054             "halted":false,
2055             "pc":3227107138
2056             "thread_id":3134
2057          },
2058          {
2059             "CPU":1,
2060             "current":false,
2061             "halted":true,
2062             "pc":7108165
2063             "thread_id":3135
2064          }
2065       ]
2066    }
2067
2068 EQMP
2069
2070     {
2071         .name       = "query-cpus",
2072         .args_type  = "",
2073         .mhandler.cmd_new = qmp_marshal_input_query_cpus,
2074     },
2075
2076 SQMP
2077 query-pci
2078 ---------
2079
2080 PCI buses and devices information.
2081
2082 The returned value is a json-array of all buses. Each bus is represented by
2083 a json-object, which has a key with a json-array of all PCI devices attached
2084 to it. Each device is represented by a json-object.
2085
2086 The bus json-object contains the following:
2087
2088 - "bus": bus number (json-int)
2089 - "devices": a json-array of json-objects, each json-object represents a
2090              PCI device
2091
2092 The PCI device json-object contains the following:
2093
2094 - "bus": identical to the parent's bus number (json-int)
2095 - "slot": slot number (json-int)
2096 - "function": function number (json-int)
2097 - "class_info": a json-object containing:
2098      - "desc": device class description (json-string, optional)
2099      - "class": device class number (json-int)
2100 - "id": a json-object containing:
2101      - "device": device ID (json-int)
2102      - "vendor": vendor ID (json-int)
2103 - "irq": device's IRQ if assigned (json-int, optional)
2104 - "qdev_id": qdev id string (json-string)
2105 - "pci_bridge": It's a json-object, only present if this device is a
2106                 PCI bridge, contains:
2107      - "bus": bus number (json-int)
2108      - "secondary": secondary bus number (json-int)
2109      - "subordinate": subordinate bus number (json-int)
2110      - "io_range": I/O memory range information, a json-object with the
2111                    following members:
2112                  - "base": base address, in bytes (json-int)
2113                  - "limit": limit address, in bytes (json-int)
2114      - "memory_range": memory range information, a json-object with the
2115                        following members:
2116                  - "base": base address, in bytes (json-int)
2117                  - "limit": limit address, in bytes (json-int)
2118      - "prefetchable_range": Prefetchable memory range information, a
2119                              json-object with the following members:
2120                  - "base": base address, in bytes (json-int)
2121                  - "limit": limit address, in bytes (json-int)
2122      - "devices": a json-array of PCI devices if there's any attached, each
2123                   each element is represented by a json-object, which contains
2124                   the same members of the 'PCI device json-object' described
2125                   above (optional)
2126 - "regions": a json-array of json-objects, each json-object represents a
2127              memory region of this device
2128
2129 The memory range json-object contains the following:
2130
2131 - "base": base memory address (json-int)
2132 - "limit": limit value (json-int)
2133
2134 The region json-object can be an I/O region or a memory region, an I/O region
2135 json-object contains the following:
2136
2137 - "type": "io" (json-string, fixed)
2138 - "bar": BAR number (json-int)
2139 - "address": memory address (json-int)
2140 - "size": memory size (json-int)
2141
2142 A memory region json-object contains the following:
2143
2144 - "type": "memory" (json-string, fixed)
2145 - "bar": BAR number (json-int)
2146 - "address": memory address (json-int)
2147 - "size": memory size (json-int)
2148 - "mem_type_64": true or false (json-bool)
2149 - "prefetch": true or false (json-bool)
2150
2151 Example:
2152
2153 -> { "execute": "query-pci" }
2154 <- {
2155       "return":[
2156          {
2157             "bus":0,
2158             "devices":[
2159                {
2160                   "bus":0,
2161                   "qdev_id":"",
2162                   "slot":0,
2163                   "class_info":{
2164                      "class":1536,
2165                      "desc":"Host bridge"
2166                   },
2167                   "id":{
2168                      "device":32902,
2169                      "vendor":4663
2170                   },
2171                   "function":0,
2172                   "regions":[
2173
2174                   ]
2175                },
2176                {
2177                   "bus":0,
2178                   "qdev_id":"",
2179                   "slot":1,
2180                   "class_info":{
2181                      "class":1537,
2182                      "desc":"ISA bridge"
2183                   },
2184                   "id":{
2185                      "device":32902,
2186                      "vendor":28672
2187                   },
2188                   "function":0,
2189                   "regions":[
2190
2191                   ]
2192                },
2193                {
2194                   "bus":0,
2195                   "qdev_id":"",
2196                   "slot":1,
2197                   "class_info":{
2198                      "class":257,
2199                      "desc":"IDE controller"
2200                   },
2201                   "id":{
2202                      "device":32902,
2203                      "vendor":28688
2204                   },
2205                   "function":1,
2206                   "regions":[
2207                      {
2208                         "bar":4,
2209                         "size":16,
2210                         "address":49152,
2211                         "type":"io"
2212                      }
2213                   ]
2214                },
2215                {
2216                   "bus":0,
2217                   "qdev_id":"",
2218                   "slot":2,
2219                   "class_info":{
2220                      "class":768,
2221                      "desc":"VGA controller"
2222                   },
2223                   "id":{
2224                      "device":4115,
2225                      "vendor":184
2226                   },
2227                   "function":0,
2228                   "regions":[
2229                      {
2230                         "prefetch":true,
2231                         "mem_type_64":false,
2232                         "bar":0,
2233                         "size":33554432,
2234                         "address":4026531840,
2235                         "type":"memory"
2236                      },
2237                      {
2238                         "prefetch":false,
2239                         "mem_type_64":false,
2240                         "bar":1,
2241                         "size":4096,
2242                         "address":4060086272,
2243                         "type":"memory"
2244                      },
2245                      {
2246                         "prefetch":false,
2247                         "mem_type_64":false,
2248                         "bar":6,
2249                         "size":65536,
2250                         "address":-1,
2251                         "type":"memory"
2252                      }
2253                   ]
2254                },
2255                {
2256                   "bus":0,
2257                   "qdev_id":"",
2258                   "irq":11,
2259                   "slot":4,
2260                   "class_info":{
2261                      "class":1280,
2262                      "desc":"RAM controller"
2263                   },
2264                   "id":{
2265                      "device":6900,
2266                      "vendor":4098
2267                   },
2268                   "function":0,
2269                   "regions":[
2270                      {
2271                         "bar":0,
2272                         "size":32,
2273                         "address":49280,
2274                         "type":"io"
2275                      }
2276                   ]
2277                }
2278             ]
2279          }
2280       ]
2281    }
2282
2283 Note: This example has been shortened as the real response is too long.
2284
2285 EQMP
2286
2287     {
2288         .name       = "query-pci",
2289         .args_type  = "",
2290         .mhandler.cmd_new = qmp_marshal_input_query_pci,
2291     },
2292
2293 SQMP
2294 query-kvm
2295 ---------
2296
2297 Show KVM information.
2298
2299 Return a json-object with the following information:
2300
2301 - "enabled": true if KVM support is enabled, false otherwise (json-bool)
2302 - "present": true if QEMU has KVM support, false otherwise (json-bool)
2303
2304 Example:
2305
2306 -> { "execute": "query-kvm" }
2307 <- { "return": { "enabled": true, "present": true } }
2308
2309 EQMP
2310
2311     {
2312         .name       = "query-kvm",
2313         .args_type  = "",
2314         .mhandler.cmd_new = qmp_marshal_input_query_kvm,
2315     },
2316
2317 SQMP
2318 query-status
2319 ------------
2320
2321 Return a json-object with the following information:
2322
2323 - "running": true if the VM is running, or false if it is paused (json-bool)
2324 - "singlestep": true if the VM is in single step mode,
2325                 false otherwise (json-bool)
2326 - "status": one of the following values (json-string)
2327     "debug" - QEMU is running on a debugger
2328     "inmigrate" - guest is paused waiting for an incoming migration
2329     "internal-error" - An internal error that prevents further guest
2330     execution has occurred
2331     "io-error" - the last IOP has failed and the device is configured
2332     to pause on I/O errors
2333     "paused" - guest has been paused via the 'stop' command
2334     "postmigrate" - guest is paused following a successful 'migrate'
2335     "prelaunch" - QEMU was started with -S and guest has not started
2336     "finish-migrate" - guest is paused to finish the migration process
2337     "restore-vm" - guest is paused to restore VM state
2338     "running" - guest is actively running
2339     "save-vm" - guest is paused to save the VM state
2340     "shutdown" - guest is shut down (and -no-shutdown is in use)
2341     "watchdog" - the watchdog action is configured to pause and
2342      has been triggered
2343
2344 Example:
2345
2346 -> { "execute": "query-status" }
2347 <- { "return": { "running": true, "singlestep": false, "status": "running" } }
2348
2349 EQMP
2350
2351     {
2352         .name       = "query-status",
2353         .args_type  = "",
2354         .mhandler.cmd_new = qmp_marshal_input_query_status,
2355     },
2356
2357 SQMP
2358 query-mice
2359 ----------
2360
2361 Show VM mice information.
2362
2363 Each mouse is represented by a json-object, the returned value is a json-array
2364 of all mice.
2365
2366 The mouse json-object contains the following:
2367
2368 - "name": mouse's name (json-string)
2369 - "index": mouse's index (json-int)
2370 - "current": true if this mouse is receiving events, false otherwise (json-bool)
2371 - "absolute": true if the mouse generates absolute input events (json-bool)
2372
2373 Example:
2374
2375 -> { "execute": "query-mice" }
2376 <- {
2377       "return":[
2378          {
2379             "name":"QEMU Microsoft Mouse",
2380             "index":0,
2381             "current":false,
2382             "absolute":false
2383          },
2384          {
2385             "name":"QEMU PS/2 Mouse",
2386             "index":1,
2387             "current":true,
2388             "absolute":true
2389          }
2390       ]
2391    }
2392
2393 EQMP
2394
2395     {
2396         .name       = "query-mice",
2397         .args_type  = "",
2398         .mhandler.cmd_new = qmp_marshal_input_query_mice,
2399     },
2400
2401 SQMP
2402 query-vnc
2403 ---------
2404
2405 Show VNC server information.
2406
2407 Return a json-object with server information. Connected clients are returned
2408 as a json-array of json-objects.
2409
2410 The main json-object contains the following:
2411
2412 - "enabled": true or false (json-bool)
2413 - "host": server's IP address (json-string)
2414 - "family": address family (json-string)
2415          - Possible values: "ipv4", "ipv6", "unix", "unknown"
2416 - "service": server's port number (json-string)
2417 - "auth": authentication method (json-string)
2418          - Possible values: "invalid", "none", "ra2", "ra2ne", "sasl", "tight",
2419                             "tls", "ultra", "unknown", "vencrypt", "vencrypt",
2420                             "vencrypt+plain", "vencrypt+tls+none",
2421                             "vencrypt+tls+plain", "vencrypt+tls+sasl",
2422                             "vencrypt+tls+vnc", "vencrypt+x509+none",
2423                             "vencrypt+x509+plain", "vencrypt+x509+sasl",
2424                             "vencrypt+x509+vnc", "vnc"
2425 - "clients": a json-array of all connected clients
2426
2427 Clients are described by a json-object, each one contain the following:
2428
2429 - "host": client's IP address (json-string)
2430 - "family": address family (json-string)
2431          - Possible values: "ipv4", "ipv6", "unix", "unknown"
2432 - "service": client's port number (json-string)
2433 - "x509_dname": TLS dname (json-string, optional)
2434 - "sasl_username": SASL username (json-string, optional)
2435
2436 Example:
2437
2438 -> { "execute": "query-vnc" }
2439 <- {
2440       "return":{
2441          "enabled":true,
2442          "host":"0.0.0.0",
2443          "service":"50402",
2444          "auth":"vnc",
2445          "family":"ipv4",
2446          "clients":[
2447             {
2448                "host":"127.0.0.1",
2449                "service":"50401",
2450                "family":"ipv4"
2451             }
2452          ]
2453       }
2454    }
2455
2456 EQMP
2457
2458     {
2459         .name       = "query-vnc",
2460         .args_type  = "",
2461         .mhandler.cmd_new = qmp_marshal_input_query_vnc,
2462     },
2463
2464 SQMP
2465 query-spice
2466 -----------
2467
2468 Show SPICE server information.
2469
2470 Return a json-object with server information. Connected clients are returned
2471 as a json-array of json-objects.
2472
2473 The main json-object contains the following:
2474
2475 - "enabled": true or false (json-bool)
2476 - "host": server's IP address (json-string)
2477 - "port": server's port number (json-int, optional)
2478 - "tls-port": server's port number (json-int, optional)
2479 - "auth": authentication method (json-string)
2480          - Possible values: "none", "spice"
2481 - "channels": a json-array of all active channels clients
2482
2483 Channels are described by a json-object, each one contain the following:
2484
2485 - "host": client's IP address (json-string)
2486 - "family": address family (json-string)
2487          - Possible values: "ipv4", "ipv6", "unix", "unknown"
2488 - "port": client's port number (json-string)
2489 - "connection-id": spice connection id.  All channels with the same id
2490                    belong to the same spice session (json-int)
2491 - "channel-type": channel type.  "1" is the main control channel, filter for
2492                   this one if you want track spice sessions only (json-int)
2493 - "channel-id": channel id.  Usually "0", might be different needed when
2494                 multiple channels of the same type exist, such as multiple
2495                 display channels in a multihead setup (json-int)
2496 - "tls": whevener the channel is encrypted (json-bool)
2497
2498 Example:
2499
2500 -> { "execute": "query-spice" }
2501 <- {
2502       "return": {
2503          "enabled": true,
2504          "auth": "spice",
2505          "port": 5920,
2506          "tls-port": 5921,
2507          "host": "0.0.0.0",
2508          "channels": [
2509             {
2510                "port": "54924",
2511                "family": "ipv4",
2512                "channel-type": 1,
2513                "connection-id": 1804289383,
2514                "host": "127.0.0.1",
2515                "channel-id": 0,
2516                "tls": true
2517             },
2518             {
2519                "port": "36710",
2520                "family": "ipv4",
2521                "channel-type": 4,
2522                "connection-id": 1804289383,
2523                "host": "127.0.0.1",
2524                "channel-id": 0,
2525                "tls": false
2526             },
2527             [ ... more channels follow ... ]
2528          ]
2529       }
2530    }
2531
2532 EQMP
2533
2534 #if defined(CONFIG_SPICE)
2535     {
2536         .name       = "query-spice",
2537         .args_type  = "",
2538         .mhandler.cmd_new = qmp_marshal_input_query_spice,
2539     },
2540 #endif
2541
2542 SQMP
2543 query-name
2544 ----------
2545
2546 Show VM name.
2547
2548 Return a json-object with the following information:
2549
2550 - "name": VM's name (json-string, optional)
2551
2552 Example:
2553
2554 -> { "execute": "query-name" }
2555 <- { "return": { "name": "qemu-name" } }
2556
2557 EQMP
2558
2559     {
2560         .name       = "query-name",
2561         .args_type  = "",
2562         .mhandler.cmd_new = qmp_marshal_input_query_name,
2563     },
2564
2565 SQMP
2566 query-uuid
2567 ----------
2568
2569 Show VM UUID.
2570
2571 Return a json-object with the following information:
2572
2573 - "UUID": Universally Unique Identifier (json-string)
2574
2575 Example:
2576
2577 -> { "execute": "query-uuid" }
2578 <- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } }
2579
2580 EQMP
2581
2582     {
2583         .name       = "query-uuid",
2584         .args_type  = "",
2585         .mhandler.cmd_new = qmp_marshal_input_query_uuid,
2586     },
2587
2588 SQMP
2589 query-command-line-options
2590 --------------------------
2591
2592 Show command line option schema.
2593
2594 Return a json-array of command line option schema for all options (or for
2595 the given option), returning an error if the given option doesn't exist.
2596
2597 Each array entry contains the following:
2598
2599 - "option": option name (json-string)
2600 - "parameters": a json-array describes all parameters of the option:
2601     - "name": parameter name (json-string)
2602     - "type": parameter type (one of 'string', 'boolean', 'number',
2603               or 'size')
2604     - "help": human readable description of the parameter
2605               (json-string, optional)
2606
2607 Example:
2608
2609 -> { "execute": "query-command-line-options", "arguments": { "option": "option-rom" } }
2610 <- { "return": [
2611         {
2612             "parameters": [
2613                 {
2614                     "name": "romfile",
2615                     "type": "string"
2616                 },
2617                 {
2618                     "name": "bootindex",
2619                     "type": "number"
2620                 }
2621             ],
2622             "option": "option-rom"
2623         }
2624      ]
2625    }
2626
2627 EQMP
2628
2629     {
2630         .name       = "query-command-line-options",
2631         .args_type  = "option:s?",
2632         .mhandler.cmd_new = qmp_marshal_input_query_command_line_options,
2633     },
2634
2635 SQMP
2636 query-migrate
2637 -------------
2638
2639 Migration status.
2640
2641 Return a json-object. If migration is active there will be another json-object
2642 with RAM migration status and if block migration is active another one with
2643 block migration status.
2644
2645 The main json-object contains the following:
2646
2647 - "status": migration status (json-string)
2648      - Possible values: "active", "completed", "failed", "cancelled"
2649 - "total-time": total amount of ms since migration started.  If
2650                 migration has ended, it returns the total migration
2651                 time (json-int)
2652 - "setup-time" amount of setup time in milliseconds _before_ the
2653                iterations begin but _after_ the QMP command is issued.
2654                This is designed to provide an accounting of any activities
2655                (such as RDMA pinning) which may be expensive, but do not
2656                actually occur during the iterative migration rounds
2657                themselves. (json-int)
2658 - "downtime": only present when migration has finished correctly
2659               total amount in ms for downtime that happened (json-int)
2660 - "expected-downtime": only present while migration is active
2661                 total amount in ms for downtime that was calculated on
2662                 the last bitmap round (json-int)
2663 - "ram": only present if "status" is "active", it is a json-object with the
2664   following RAM information:
2665          - "transferred": amount transferred in bytes (json-int)
2666          - "remaining": amount remaining to transfer in bytes (json-int)
2667          - "total": total amount of memory in bytes (json-int)
2668          - "duplicate": number of pages filled entirely with the same
2669             byte (json-int)
2670             These are sent over the wire much more efficiently.
2671          - "skipped": number of skipped zero pages (json-int)
2672          - "normal" : number of whole pages transferred.  I.e. they
2673             were not sent as duplicate or xbzrle pages (json-int)
2674          - "normal-bytes" : number of bytes transferred in whole
2675             pages. This is just normal pages times size of one page,
2676             but this way upper levels don't need to care about page
2677             size (json-int)
2678 - "disk": only present if "status" is "active" and it is a block migration,
2679   it is a json-object with the following disk information:
2680          - "transferred": amount transferred in bytes (json-int)
2681          - "remaining": amount remaining to transfer in bytes json-int)
2682          - "total": total disk size in bytes (json-int)
2683 - "xbzrle-cache": only present if XBZRLE is active.
2684   It is a json-object with the following XBZRLE information:
2685          - "cache-size": XBZRLE cache size in bytes
2686          - "bytes": number of bytes transferred for XBZRLE compressed pages
2687          - "pages": number of XBZRLE compressed pages
2688          - "cache-miss": number of XBRZRLE page cache misses
2689          - "overflow": number of times XBZRLE overflows.  This means
2690            that the XBZRLE encoding was bigger than just sent the
2691            whole page, and then we sent the whole page instead (as as
2692            normal page).
2693
2694 Examples:
2695
2696 1. Before the first migration
2697
2698 -> { "execute": "query-migrate" }
2699 <- { "return": {} }
2700
2701 2. Migration is done and has succeeded
2702
2703 -> { "execute": "query-migrate" }
2704 <- { "return": {
2705         "status": "completed",
2706         "ram":{
2707           "transferred":123,
2708           "remaining":123,
2709           "total":246,
2710           "total-time":12345,
2711           "setup-time":12345,
2712           "downtime":12345,
2713           "duplicate":123,
2714           "normal":123,
2715           "normal-bytes":123456
2716         }
2717      }
2718    }
2719
2720 3. Migration is done and has failed
2721
2722 -> { "execute": "query-migrate" }
2723 <- { "return": { "status": "failed" } }
2724
2725 4. Migration is being performed and is not a block migration:
2726
2727 -> { "execute": "query-migrate" }
2728 <- {
2729       "return":{
2730          "status":"active",
2731          "ram":{
2732             "transferred":123,
2733             "remaining":123,
2734             "total":246,
2735             "total-time":12345,
2736             "setup-time":12345,
2737             "expected-downtime":12345,
2738             "duplicate":123,
2739             "normal":123,
2740             "normal-bytes":123456
2741          }
2742       }
2743    }
2744
2745 5. Migration is being performed and is a block migration:
2746
2747 -> { "execute": "query-migrate" }
2748 <- {
2749       "return":{
2750          "status":"active",
2751          "ram":{
2752             "total":1057024,
2753             "remaining":1053304,
2754             "transferred":3720,
2755             "total-time":12345,
2756             "setup-time":12345,
2757             "expected-downtime":12345,
2758             "duplicate":123,
2759             "normal":123,
2760             "normal-bytes":123456
2761          },
2762          "disk":{
2763             "total":20971520,
2764             "remaining":20880384,
2765             "transferred":91136
2766          }
2767       }
2768    }
2769
2770 6. Migration is being performed and XBZRLE is active:
2771
2772 -> { "execute": "query-migrate" }
2773 <- {
2774       "return":{
2775          "status":"active",
2776          "capabilities" : [ { "capability": "xbzrle", "state" : true } ],
2777          "ram":{
2778             "total":1057024,
2779             "remaining":1053304,
2780             "transferred":3720,
2781             "total-time":12345,
2782             "setup-time":12345,
2783             "expected-downtime":12345,
2784             "duplicate":10,
2785             "normal":3333,
2786             "normal-bytes":3412992
2787          },
2788          "xbzrle-cache":{
2789             "cache-size":67108864,
2790             "bytes":20971520,
2791             "pages":2444343,
2792             "cache-miss":2244,
2793             "overflow":34434
2794          }
2795       }
2796    }
2797
2798 EQMP
2799
2800     {
2801         .name       = "query-migrate",
2802         .args_type  = "",
2803         .mhandler.cmd_new = qmp_marshal_input_query_migrate,
2804     },
2805
2806 SQMP
2807 migrate-set-capabilities
2808 ------------------------
2809
2810 Enable/Disable migration capabilities
2811
2812 - "xbzrle": XBZRLE support
2813
2814 Arguments:
2815
2816 Example:
2817
2818 -> { "execute": "migrate-set-capabilities" , "arguments":
2819      { "capabilities": [ { "capability": "xbzrle", "state": true } ] } }
2820
2821 EQMP
2822
2823     {
2824         .name       = "migrate-set-capabilities",
2825         .args_type  = "capabilities:O",
2826         .params     = "capability:s,state:b",
2827         .mhandler.cmd_new = qmp_marshal_input_migrate_set_capabilities,
2828     },
2829 SQMP
2830 query-migrate-capabilities
2831 --------------------------
2832
2833 Query current migration capabilities
2834
2835 - "capabilities": migration capabilities state
2836          - "xbzrle" : XBZRLE state (json-bool)
2837
2838 Arguments:
2839
2840 Example:
2841
2842 -> { "execute": "query-migrate-capabilities" }
2843 <- { "return": [ { "state": false, "capability": "xbzrle" } ] }
2844
2845 EQMP
2846
2847     {
2848         .name       = "query-migrate-capabilities",
2849         .args_type  = "",
2850         .mhandler.cmd_new = qmp_marshal_input_query_migrate_capabilities,
2851     },
2852
2853 SQMP
2854 query-balloon
2855 -------------
2856
2857 Show balloon information.
2858
2859 Make an asynchronous request for balloon info. When the request completes a
2860 json-object will be returned containing the following data:
2861
2862 - "actual": current balloon value in bytes (json-int)
2863
2864 Example:
2865
2866 -> { "execute": "query-balloon" }
2867 <- {
2868       "return":{
2869          "actual":1073741824,
2870       }
2871    }
2872
2873 EQMP
2874
2875     {
2876         .name       = "query-balloon",
2877         .args_type  = "",
2878         .mhandler.cmd_new = qmp_marshal_input_query_balloon,
2879     },
2880
2881     {
2882         .name       = "query-block-jobs",
2883         .args_type  = "",
2884         .mhandler.cmd_new = qmp_marshal_input_query_block_jobs,
2885     },
2886
2887     {
2888         .name       = "qom-list",
2889         .args_type  = "path:s",
2890         .mhandler.cmd_new = qmp_marshal_input_qom_list,
2891     },
2892
2893     {
2894         .name       = "qom-set",
2895         .args_type  = "path:s,property:s,value:q",
2896         .mhandler.cmd_new = qmp_qom_set,
2897     },
2898
2899     {
2900         .name       = "qom-get",
2901         .args_type  = "path:s,property:s",
2902         .mhandler.cmd_new = qmp_qom_get,
2903     },
2904
2905     {
2906         .name       = "nbd-server-start",
2907         .args_type  = "addr:q",
2908         .mhandler.cmd_new = qmp_marshal_input_nbd_server_start,
2909     },
2910     {
2911         .name       = "nbd-server-add",
2912         .args_type  = "device:B,writable:b?",
2913         .mhandler.cmd_new = qmp_marshal_input_nbd_server_add,
2914     },
2915     {
2916         .name       = "nbd-server-stop",
2917         .args_type  = "",
2918         .mhandler.cmd_new = qmp_marshal_input_nbd_server_stop,
2919     },
2920
2921     {
2922         .name       = "change-vnc-password",
2923         .args_type  = "password:s",
2924         .mhandler.cmd_new = qmp_marshal_input_change_vnc_password,
2925     },
2926     {
2927         .name       = "qom-list-types",
2928         .args_type  = "implements:s?,abstract:b?",
2929         .mhandler.cmd_new = qmp_marshal_input_qom_list_types,
2930     },
2931
2932     {
2933         .name       = "device-list-properties",
2934         .args_type  = "typename:s",
2935         .mhandler.cmd_new = qmp_marshal_input_device_list_properties,
2936     },
2937
2938     {
2939         .name       = "query-machines",
2940         .args_type  = "",
2941         .mhandler.cmd_new = qmp_marshal_input_query_machines,
2942     },
2943
2944     {
2945         .name       = "query-cpu-definitions",
2946         .args_type  = "",
2947         .mhandler.cmd_new = qmp_marshal_input_query_cpu_definitions,
2948     },
2949
2950     {
2951         .name       = "query-target",
2952         .args_type  = "",
2953         .mhandler.cmd_new = qmp_marshal_input_query_target,
2954     },
2955
2956     {
2957         .name       = "query-tpm",
2958         .args_type  = "",
2959         .mhandler.cmd_new = qmp_marshal_input_query_tpm,
2960     },
2961
2962 SQMP
2963 query-tpm
2964 ---------
2965
2966 Return information about the TPM device.
2967
2968 Arguments: None
2969
2970 Example:
2971
2972 -> { "execute": "query-tpm" }
2973 <- { "return":
2974      [
2975        { "model": "tpm-tis",
2976          "options":
2977            { "type": "passthrough",
2978              "data":
2979                { "cancel-path": "/sys/class/misc/tpm0/device/cancel",
2980                  "path": "/dev/tpm0"
2981                }
2982            },
2983          "id": "tpm0"
2984        }
2985      ]
2986    }
2987
2988 EQMP
2989
2990     {
2991         .name       = "query-tpm-models",
2992         .args_type  = "",
2993         .mhandler.cmd_new = qmp_marshal_input_query_tpm_models,
2994     },
2995
2996 SQMP
2997 query-tpm-models
2998 ----------------
2999
3000 Return a list of supported TPM models.
3001
3002 Arguments: None
3003
3004 Example:
3005
3006 -> { "execute": "query-tpm-models" }
3007 <- { "return": [ "tpm-tis" ] }
3008
3009 EQMP
3010
3011     {
3012         .name       = "query-tpm-types",
3013         .args_type  = "",
3014         .mhandler.cmd_new = qmp_marshal_input_query_tpm_types,
3015     },
3016
3017 SQMP
3018 query-tpm-types
3019 ---------------
3020
3021 Return a list of supported TPM types.
3022
3023 Arguments: None
3024
3025 Example:
3026
3027 -> { "execute": "query-tpm-types" }
3028 <- { "return": [ "passthrough" ] }
3029
3030 EQMP
3031
3032     {
3033         .name       = "chardev-add",
3034         .args_type  = "id:s,backend:q",
3035         .mhandler.cmd_new = qmp_marshal_input_chardev_add,
3036     },
3037
3038 SQMP
3039 chardev-add
3040 ----------------
3041
3042 Add a chardev.
3043
3044 Arguments:
3045
3046 - "id": the chardev's ID, must be unique (json-string)
3047 - "backend": chardev backend type + parameters
3048
3049 Examples:
3050
3051 -> { "execute" : "chardev-add",
3052      "arguments" : { "id" : "foo",
3053                      "backend" : { "type" : "null", "data" : {} } } }
3054 <- { "return": {} }
3055
3056 -> { "execute" : "chardev-add",
3057      "arguments" : { "id" : "bar",
3058                      "backend" : { "type" : "file",
3059                                    "data" : { "out" : "/tmp/bar.log" } } } }
3060 <- { "return": {} }
3061
3062 -> { "execute" : "chardev-add",
3063      "arguments" : { "id" : "baz",
3064                      "backend" : { "type" : "pty", "data" : {} } } }
3065 <- { "return": { "pty" : "/dev/pty/42" } }
3066
3067 EQMP
3068
3069     {
3070         .name       = "chardev-remove",
3071         .args_type  = "id:s",
3072         .mhandler.cmd_new = qmp_marshal_input_chardev_remove,
3073     },
3074
3075
3076 SQMP
3077 chardev-remove
3078 --------------
3079
3080 Remove a chardev.
3081
3082 Arguments:
3083
3084 - "id": the chardev's ID, must exist and not be in use (json-string)
3085
3086 Example:
3087
3088 -> { "execute": "chardev-remove", "arguments": { "id" : "foo" } }
3089 <- { "return": {} }
3090
3091 EQMP
3092     {
3093         .name       = "query-rx-filter",
3094         .args_type  = "name:s?",
3095         .mhandler.cmd_new = qmp_marshal_input_query_rx_filter,
3096     },
3097
3098 SQMP
3099 query-rx-filter
3100 ---------------
3101
3102 Show rx-filter information.
3103
3104 Returns a json-array of rx-filter information for all NICs (or for the
3105 given NIC), returning an error if the given NIC doesn't exist, or
3106 given NIC doesn't support rx-filter querying, or given net client
3107 isn't a NIC.
3108
3109 The query will clear the event notification flag of each NIC, then qemu
3110 will start to emit event to QMP monitor.
3111
3112 Each array entry contains the following:
3113
3114 - "name": net client name (json-string)
3115 - "promiscuous": promiscuous mode is enabled (json-bool)
3116 - "multicast": multicast receive state (one of 'normal', 'none', 'all')
3117 - "unicast": unicast receive state  (one of 'normal', 'none', 'all')
3118 - "broadcast-allowed": allow to receive broadcast (json-bool)
3119 - "multicast-overflow": multicast table is overflowed (json-bool)
3120 - "unicast-overflow": unicast table is overflowed (json-bool)
3121 - "main-mac": main macaddr string (json-string)
3122 - "vlan-table": a json-array of active vlan id
3123 - "unicast-table": a json-array of unicast macaddr string
3124 - "multicast-table": a json-array of multicast macaddr string
3125
3126 Example:
3127
3128 -> { "execute": "query-rx-filter", "arguments": { "name": "vnet0" } }
3129 <- { "return": [
3130         {
3131             "promiscuous": true,
3132             "name": "vnet0",
3133             "main-mac": "52:54:00:12:34:56",
3134             "unicast": "normal",
3135             "vlan-table": [
3136                 4,
3137                 0
3138             ],
3139             "unicast-table": [
3140             ],
3141             "multicast": "normal",
3142             "multicast-overflow": false,
3143             "unicast-overflow": false,
3144             "multicast-table": [
3145                 "01:00:5e:00:00:01",
3146                 "33:33:00:00:00:01",
3147                 "33:33:ff:12:34:56"
3148             ],
3149             "broadcast-allowed": false
3150         }
3151       ]
3152    }
3153
3154 EQMP