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 operations
1005 for now are drive-backup, internal and external snapshotting.  A list of
1006 dictionaries is accepted, that contains the actions to be performed.
1007 If there is any failure performing any of the operations, all operations
1008 for the group are abandoned.
1009
1010 For external snapshots, the dictionary contains the device, the file to use for
1011 the new snapshot, and the format.  The default format, if not specified, is
1012 qcow2.
1013
1014 Each new snapshot defaults to being created by QEMU (wiping any
1015 contents if the file already exists), but it is also possible to reuse
1016 an externally-created file.  In the latter case, you should ensure that
1017 the new image file has the same contents as the current one; QEMU cannot
1018 perform any meaningful check.  Typically this is achieved by using the
1019 current image file as the backing file for the new image.
1020
1021 On failure, the original disks pre-snapshot attempt will be used.
1022
1023 For internal snapshots, the dictionary contains the device and the snapshot's
1024 name.  If an internal snapshot matching name already exists, the request will
1025 be rejected.  Only some image formats support it, for example, qcow2, rbd,
1026 and sheepdog.
1027
1028 On failure, qemu will try delete the newly created internal snapshot in the
1029 transaction.  When an I/O error occurs during deletion, the user needs to fix
1030 it later with qemu-img or other command.
1031
1032 Arguments:
1033
1034 actions array:
1035     - "type": the operation to perform.  The only supported
1036       value is "blockdev-snapshot-sync". (json-string)
1037     - "data": a dictionary.  The contents depend on the value
1038       of "type".  When "type" is "blockdev-snapshot-sync":
1039       - "device": device name to snapshot (json-string)
1040       - "snapshot-file": name of new image file (json-string)
1041       - "format": format of new image (json-string, optional)
1042       - "mode": whether and how QEMU should create the snapshot file
1043         (NewImageMode, optional, default "absolute-paths")
1044       When "type" is "blockdev-snapshot-internal-sync":
1045       - "device": device name to snapshot (json-string)
1046       - "name": name of the new snapshot (json-string)
1047
1048 Example:
1049
1050 -> { "execute": "transaction",
1051      "arguments": { "actions": [
1052          { 'type': 'blockdev-snapshot-sync', 'data' : { "device": "ide-hd0",
1053                                          "snapshot-file": "/some/place/my-image",
1054                                          "format": "qcow2" } },
1055          { 'type': 'blockdev-snapshot-sync', 'data' : { "device": "ide-hd1",
1056                                          "snapshot-file": "/some/place/my-image2",
1057                                          "mode": "existing",
1058                                          "format": "qcow2" } },
1059          { 'type': 'blockdev-snapshot-internal-sync', 'data' : {
1060                                          "device": "ide-hd2",
1061                                          "name": "snapshot0" } } ] } }
1062 <- { "return": {} }
1063
1064 EQMP
1065
1066     {
1067         .name       = "blockdev-snapshot-sync",
1068         .args_type  = "device:B,snapshot-file:s,format:s?,mode:s?",
1069         .mhandler.cmd_new = qmp_marshal_input_blockdev_snapshot_sync,
1070     },
1071
1072 SQMP
1073 blockdev-snapshot-sync
1074 ----------------------
1075
1076 Synchronous snapshot of a block device. snapshot-file specifies the
1077 target of the new image. If the file exists, or if it is a device, the
1078 snapshot will be created in the existing file/device. If does not
1079 exist, a new file will be created. format specifies the format of the
1080 snapshot image, default is qcow2.
1081
1082 Arguments:
1083
1084 - "device": device name to snapshot (json-string)
1085 - "snapshot-file": name of new image file (json-string)
1086 - "mode": whether and how QEMU should create the snapshot file
1087   (NewImageMode, optional, default "absolute-paths")
1088 - "format": format of new image (json-string, optional)
1089
1090 Example:
1091
1092 -> { "execute": "blockdev-snapshot-sync", "arguments": { "device": "ide-hd0",
1093                                                          "snapshot-file":
1094                                                         "/some/place/my-image",
1095                                                         "format": "qcow2" } }
1096 <- { "return": {} }
1097
1098 EQMP
1099
1100     {
1101         .name       = "blockdev-snapshot-internal-sync",
1102         .args_type  = "device:B,name:s",
1103         .mhandler.cmd_new = qmp_marshal_input_blockdev_snapshot_internal_sync,
1104     },
1105
1106 SQMP
1107 blockdev-snapshot-internal-sync
1108 -------------------------------
1109
1110 Synchronously take an internal snapshot of a block device when the format of
1111 image used supports it.  If the name is an empty string, or a snapshot with
1112 name already exists, the operation will fail.
1113
1114 Arguments:
1115
1116 - "device": device name to snapshot (json-string)
1117 - "name": name of the new snapshot (json-string)
1118
1119 Example:
1120
1121 -> { "execute": "blockdev-snapshot-internal-sync",
1122                 "arguments": { "device": "ide-hd0",
1123                                "name": "snapshot0" }
1124    }
1125 <- { "return": {} }
1126
1127 EQMP
1128
1129     {
1130         .name       = "drive-mirror",
1131         .args_type  = "sync:s,device:B,target:s,speed:i?,mode:s?,format:s?,"
1132                       "on-source-error:s?,on-target-error:s?,"
1133                       "granularity:i?,buf-size:i?",
1134         .mhandler.cmd_new = qmp_marshal_input_drive_mirror,
1135     },
1136
1137 SQMP
1138 drive-mirror
1139 ------------
1140
1141 Start mirroring a block device's writes to a new destination. target
1142 specifies the target of the new image. If the file exists, or if it is
1143 a device, it will be used as the new destination for writes. If it does not
1144 exist, a new file will be created. format specifies the format of the
1145 mirror image, default is to probe if mode='existing', else the format
1146 of the source.
1147
1148 Arguments:
1149
1150 - "device": device name to operate on (json-string)
1151 - "target": name of new image file (json-string)
1152 - "format": format of new image (json-string, optional)
1153 - "mode": how an image file should be created into the target
1154   file/device (NewImageMode, optional, default 'absolute-paths')
1155 - "speed": maximum speed of the streaming job, in bytes per second
1156   (json-int)
1157 - "granularity": granularity of the dirty bitmap, in bytes (json-int, optional)
1158 - "buf_size": maximum amount of data in flight from source to target, in bytes
1159   (json-int, default 10M)
1160 - "sync": what parts of the disk image should be copied to the destination;
1161   possibilities include "full" for all the disk, "top" for only the sectors
1162   allocated in the topmost image, or "none" to only replicate new I/O
1163   (MirrorSyncMode).
1164 - "on-source-error": the action to take on an error on the source
1165   (BlockdevOnError, default 'report')
1166 - "on-target-error": the action to take on an error on the target
1167   (BlockdevOnError, default 'report')
1168
1169 The default value of the granularity is the image cluster size clamped
1170 between 4096 and 65536, if the image format defines one.  If the format
1171 does not define a cluster size, the default value of the granularity
1172 is 65536.
1173
1174
1175 Example:
1176
1177 -> { "execute": "drive-mirror", "arguments": { "device": "ide-hd0",
1178                                                "target": "/some/place/my-image",
1179                                                "sync": "full",
1180                                                "format": "qcow2" } }
1181 <- { "return": {} }
1182
1183 EQMP
1184
1185     {
1186         .name       = "balloon",
1187         .args_type  = "value:M",
1188         .mhandler.cmd_new = qmp_marshal_input_balloon,
1189     },
1190
1191 SQMP
1192 balloon
1193 -------
1194
1195 Request VM to change its memory allocation (in bytes).
1196
1197 Arguments:
1198
1199 - "value": New memory allocation (json-int)
1200
1201 Example:
1202
1203 -> { "execute": "balloon", "arguments": { "value": 536870912 } }
1204 <- { "return": {} }
1205
1206 EQMP
1207
1208     {
1209         .name       = "set_link",
1210         .args_type  = "name:s,up:b",
1211         .mhandler.cmd_new = qmp_marshal_input_set_link,
1212     },
1213
1214 SQMP
1215 set_link
1216 --------
1217
1218 Change the link status of a network adapter.
1219
1220 Arguments:
1221
1222 - "name": network device name (json-string)
1223 - "up": status is up (json-bool)
1224
1225 Example:
1226
1227 -> { "execute": "set_link", "arguments": { "name": "e1000.0", "up": false } }
1228 <- { "return": {} }
1229
1230 EQMP
1231
1232     {
1233         .name       = "getfd",
1234         .args_type  = "fdname:s",
1235         .params     = "getfd name",
1236         .help       = "receive a file descriptor via SCM rights and assign it a name",
1237         .mhandler.cmd_new = qmp_marshal_input_getfd,
1238     },
1239
1240 SQMP
1241 getfd
1242 -----
1243
1244 Receive a file descriptor via SCM rights and assign it a name.
1245
1246 Arguments:
1247
1248 - "fdname": file descriptor name (json-string)
1249
1250 Example:
1251
1252 -> { "execute": "getfd", "arguments": { "fdname": "fd1" } }
1253 <- { "return": {} }
1254
1255 Notes:
1256
1257 (1) If the name specified by the "fdname" argument already exists,
1258     the file descriptor assigned to it will be closed and replaced
1259     by the received file descriptor.
1260 (2) The 'closefd' command can be used to explicitly close the file
1261     descriptor when it is no longer needed.
1262
1263 EQMP
1264
1265     {
1266         .name       = "closefd",
1267         .args_type  = "fdname:s",
1268         .params     = "closefd name",
1269         .help       = "close a file descriptor previously passed via SCM rights",
1270         .mhandler.cmd_new = qmp_marshal_input_closefd,
1271     },
1272
1273 SQMP
1274 closefd
1275 -------
1276
1277 Close a file descriptor previously passed via SCM rights.
1278
1279 Arguments:
1280
1281 - "fdname": file descriptor name (json-string)
1282
1283 Example:
1284
1285 -> { "execute": "closefd", "arguments": { "fdname": "fd1" } }
1286 <- { "return": {} }
1287
1288 EQMP
1289
1290      {
1291         .name       = "add-fd",
1292         .args_type  = "fdset-id:i?,opaque:s?",
1293         .params     = "add-fd fdset-id opaque",
1294         .help       = "Add a file descriptor, that was passed via SCM rights, to an fd set",
1295         .mhandler.cmd_new = qmp_marshal_input_add_fd,
1296     },
1297
1298 SQMP
1299 add-fd
1300 -------
1301
1302 Add a file descriptor, that was passed via SCM rights, to an fd set.
1303
1304 Arguments:
1305
1306 - "fdset-id": The ID of the fd set to add the file descriptor to.
1307               (json-int, optional)
1308 - "opaque": A free-form string that can be used to describe the fd.
1309             (json-string, optional)
1310
1311 Return a json-object with the following information:
1312
1313 - "fdset-id": The ID of the fd set that the fd was added to. (json-int)
1314 - "fd": The file descriptor that was received via SCM rights and added to the
1315         fd set. (json-int)
1316
1317 Example:
1318
1319 -> { "execute": "add-fd", "arguments": { "fdset-id": 1 } }
1320 <- { "return": { "fdset-id": 1, "fd": 3 } }
1321
1322 Notes:
1323
1324 (1) The list of fd sets is shared by all monitor connections.
1325 (2) If "fdset-id" is not specified, a new fd set will be created.
1326
1327 EQMP
1328
1329      {
1330         .name       = "remove-fd",
1331         .args_type  = "fdset-id:i,fd:i?",
1332         .params     = "remove-fd fdset-id fd",
1333         .help       = "Remove a file descriptor from an fd set",
1334         .mhandler.cmd_new = qmp_marshal_input_remove_fd,
1335     },
1336
1337 SQMP
1338 remove-fd
1339 ---------
1340
1341 Remove a file descriptor from an fd set.
1342
1343 Arguments:
1344
1345 - "fdset-id": The ID of the fd set that the file descriptor belongs to.
1346               (json-int)
1347 - "fd": The file descriptor that is to be removed. (json-int, optional)
1348
1349 Example:
1350
1351 -> { "execute": "remove-fd", "arguments": { "fdset-id": 1, "fd": 3 } }
1352 <- { "return": {} }
1353
1354 Notes:
1355
1356 (1) The list of fd sets is shared by all monitor connections.
1357 (2) If "fd" is not specified, all file descriptors in "fdset-id" will be
1358     removed.
1359
1360 EQMP
1361
1362     {
1363         .name       = "query-fdsets",
1364         .args_type  = "",
1365         .help       = "Return information describing all fd sets",
1366         .mhandler.cmd_new = qmp_marshal_input_query_fdsets,
1367     },
1368
1369 SQMP
1370 query-fdsets
1371 -------------
1372
1373 Return information describing all fd sets.
1374
1375 Arguments: None
1376
1377 Example:
1378
1379 -> { "execute": "query-fdsets" }
1380 <- { "return": [
1381        {
1382          "fds": [
1383            {
1384              "fd": 30,
1385              "opaque": "rdonly:/path/to/file"
1386            },
1387            {
1388              "fd": 24,
1389              "opaque": "rdwr:/path/to/file"
1390            }
1391          ],
1392          "fdset-id": 1
1393        },
1394        {
1395          "fds": [
1396            {
1397              "fd": 28
1398            },
1399            {
1400              "fd": 29
1401            }
1402          ],
1403          "fdset-id": 0
1404        }
1405      ]
1406    }
1407
1408 Note: The list of fd sets is shared by all monitor connections.
1409
1410 EQMP
1411
1412     {
1413         .name       = "block_passwd",
1414         .args_type  = "device:B,password:s",
1415         .mhandler.cmd_new = qmp_marshal_input_block_passwd,
1416     },
1417
1418 SQMP
1419 block_passwd
1420 ------------
1421
1422 Set the password of encrypted block devices.
1423
1424 Arguments:
1425
1426 - "device": device name (json-string)
1427 - "password": password (json-string)
1428
1429 Example:
1430
1431 -> { "execute": "block_passwd", "arguments": { "device": "ide0-hd0",
1432                                                "password": "12345" } }
1433 <- { "return": {} }
1434
1435 EQMP
1436
1437     {
1438         .name       = "block_set_io_throttle",
1439         .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?",
1440         .mhandler.cmd_new = qmp_marshal_input_block_set_io_throttle,
1441     },
1442
1443 SQMP
1444 block_set_io_throttle
1445 ------------
1446
1447 Change I/O throttle limits for a block drive.
1448
1449 Arguments:
1450
1451 - "device": device name (json-string)
1452 - "bps": total throughput limit in bytes per second (json-int)
1453 - "bps_rd": read throughput limit in bytes per second (json-int)
1454 - "bps_wr": write throughput limit in bytes per second (json-int)
1455 - "iops": total I/O operations per second (json-int)
1456 - "iops_rd": read I/O operations per second (json-int)
1457 - "iops_wr": write I/O operations per second (json-int)
1458 - "bps_max":  total max in bytes (json-int)
1459 - "bps_rd_max":  read max in bytes (json-int)
1460 - "bps_wr_max":  write max in bytes (json-int)
1461 - "iops_max":  total I/O operations max (json-int)
1462 - "iops_rd_max":  read I/O operations max (json-int)
1463 - "iops_wr_max":  write I/O operations max (json-int)
1464 - "iops_size":  I/O size in bytes when limiting (json-int)
1465
1466 Example:
1467
1468 -> { "execute": "block_set_io_throttle", "arguments": { "device": "virtio0",
1469                                                "bps": 1000000,
1470                                                "bps_rd": 0,
1471                                                "bps_wr": 0,
1472                                                "iops": 0,
1473                                                "iops_rd": 0,
1474                                                "iops_wr": 0,
1475                                                "bps_max": 8000000,
1476                                                "bps_rd_max": 0,
1477                                                "bps_wr_max": 0,
1478                                                "iops_max": 0,
1479                                                "iops_rd_max": 0,
1480                                                "iops_wr_max": 0,
1481                                                "iops_size": 0 } }
1482 <- { "return": {} }
1483
1484 EQMP
1485
1486     {
1487         .name       = "set_password",
1488         .args_type  = "protocol:s,password:s,connected:s?",
1489         .mhandler.cmd_new = qmp_marshal_input_set_password,
1490     },
1491
1492 SQMP
1493 set_password
1494 ------------
1495
1496 Set the password for vnc/spice protocols.
1497
1498 Arguments:
1499
1500 - "protocol": protocol name (json-string)
1501 - "password": password (json-string)
1502 - "connected": [ keep | disconnect | fail ] (josn-string, optional)
1503
1504 Example:
1505
1506 -> { "execute": "set_password", "arguments": { "protocol": "vnc",
1507                                                "password": "secret" } }
1508 <- { "return": {} }
1509
1510 EQMP
1511
1512     {
1513         .name       = "expire_password",
1514         .args_type  = "protocol:s,time:s",
1515         .mhandler.cmd_new = qmp_marshal_input_expire_password,
1516     },
1517
1518 SQMP
1519 expire_password
1520 ---------------
1521
1522 Set the password expire time for vnc/spice protocols.
1523
1524 Arguments:
1525
1526 - "protocol": protocol name (json-string)
1527 - "time": [ now | never | +secs | secs ] (json-string)
1528
1529 Example:
1530
1531 -> { "execute": "expire_password", "arguments": { "protocol": "vnc",
1532                                                   "time": "+60" } }
1533 <- { "return": {} }
1534
1535 EQMP
1536
1537     {
1538         .name       = "add_client",
1539         .args_type  = "protocol:s,fdname:s,skipauth:b?,tls:b?",
1540         .mhandler.cmd_new = qmp_marshal_input_add_client,
1541     },
1542
1543 SQMP
1544 add_client
1545 ----------
1546
1547 Add a graphics client
1548
1549 Arguments:
1550
1551 - "protocol": protocol name (json-string)
1552 - "fdname": file descriptor name (json-string)
1553 - "skipauth": whether to skip authentication (json-bool, optional)
1554 - "tls": whether to perform TLS (json-bool, optional)
1555
1556 Example:
1557
1558 -> { "execute": "add_client", "arguments": { "protocol": "vnc",
1559                                              "fdname": "myclient" } }
1560 <- { "return": {} }
1561
1562 EQMP
1563     {
1564         .name       = "qmp_capabilities",
1565         .args_type  = "",
1566         .params     = "",
1567         .help       = "enable QMP capabilities",
1568         .user_print = monitor_user_noop,
1569         .mhandler.cmd_new = do_qmp_capabilities,
1570     },
1571
1572 SQMP
1573 qmp_capabilities
1574 ----------------
1575
1576 Enable QMP capabilities.
1577
1578 Arguments: None.
1579
1580 Example:
1581
1582 -> { "execute": "qmp_capabilities" }
1583 <- { "return": {} }
1584
1585 Note: This command must be issued before issuing any other command.
1586
1587 EQMP
1588
1589     {
1590         .name       = "human-monitor-command",
1591         .args_type  = "command-line:s,cpu-index:i?",
1592         .mhandler.cmd_new = qmp_marshal_input_human_monitor_command,
1593     },
1594
1595 SQMP
1596 human-monitor-command
1597 ---------------------
1598
1599 Execute a Human Monitor command.
1600
1601 Arguments:
1602
1603 - command-line: the command name and its arguments, just like the
1604                 Human Monitor's shell (json-string)
1605 - cpu-index: select the CPU number to be used by commands which access CPU
1606              data, like 'info registers'. The Monitor selects CPU 0 if this
1607              argument is not provided (json-int, optional)
1608
1609 Example:
1610
1611 -> { "execute": "human-monitor-command", "arguments": { "command-line": "info kvm" } }
1612 <- { "return": "kvm support: enabled\r\n" }
1613
1614 Notes:
1615
1616 (1) The Human Monitor is NOT an stable interface, this means that command
1617     names, arguments and responses can change or be removed at ANY time.
1618     Applications that rely on long term stability guarantees should NOT
1619     use this command
1620
1621 (2) Limitations:
1622
1623     o This command is stateless, this means that commands that depend
1624       on state information (such as getfd) might not work
1625
1626     o Commands that prompt the user for data (eg. 'cont' when the block
1627       device is encrypted) don't currently work
1628
1629 3. Query Commands
1630 =================
1631
1632 HXCOMM Each query command below is inside a SQMP/EQMP section, do NOT change
1633 HXCOMM this! We will possibly move query commands definitions inside those
1634 HXCOMM sections, just like regular commands.
1635
1636 EQMP
1637
1638 SQMP
1639 query-version
1640 -------------
1641
1642 Show QEMU version.
1643
1644 Return a json-object with the following information:
1645
1646 - "qemu": A json-object containing three integer values:
1647     - "major": QEMU's major version (json-int)
1648     - "minor": QEMU's minor version (json-int)
1649     - "micro": QEMU's micro version (json-int)
1650 - "package": package's version (json-string)
1651
1652 Example:
1653
1654 -> { "execute": "query-version" }
1655 <- {
1656       "return":{
1657          "qemu":{
1658             "major":0,
1659             "minor":11,
1660             "micro":5
1661          },
1662          "package":""
1663       }
1664    }
1665
1666 EQMP
1667
1668     {
1669         .name       = "query-version",
1670         .args_type  = "",
1671         .mhandler.cmd_new = qmp_marshal_input_query_version,
1672     },
1673
1674 SQMP
1675 query-commands
1676 --------------
1677
1678 List QMP available commands.
1679
1680 Each command is represented by a json-object, the returned value is a json-array
1681 of all commands.
1682
1683 Each json-object contain:
1684
1685 - "name": command's name (json-string)
1686
1687 Example:
1688
1689 -> { "execute": "query-commands" }
1690 <- {
1691       "return":[
1692          {
1693             "name":"query-balloon"
1694          },
1695          {
1696             "name":"system_powerdown"
1697          }
1698       ]
1699    }
1700
1701 Note: This example has been shortened as the real response is too long.
1702
1703 EQMP
1704
1705     {
1706         .name       = "query-commands",
1707         .args_type  = "",
1708         .mhandler.cmd_new = qmp_marshal_input_query_commands,
1709     },
1710
1711 SQMP
1712 query-events
1713 --------------
1714
1715 List QMP available events.
1716
1717 Each event is represented by a json-object, the returned value is a json-array
1718 of all events.
1719
1720 Each json-object contains:
1721
1722 - "name": event's name (json-string)
1723
1724 Example:
1725
1726 -> { "execute": "query-events" }
1727 <- {
1728       "return":[
1729          {
1730             "name":"SHUTDOWN"
1731          },
1732          {
1733             "name":"RESET"
1734          }
1735       ]
1736    }
1737
1738 Note: This example has been shortened as the real response is too long.
1739
1740 EQMP
1741
1742     {
1743         .name       = "query-events",
1744         .args_type  = "",
1745         .mhandler.cmd_new = qmp_marshal_input_query_events,
1746     },
1747
1748 SQMP
1749 query-chardev
1750 -------------
1751
1752 Each device is represented by a json-object. The returned value is a json-array
1753 of all devices.
1754
1755 Each json-object contain the following:
1756
1757 - "label": device's label (json-string)
1758 - "filename": device's file (json-string)
1759
1760 Example:
1761
1762 -> { "execute": "query-chardev" }
1763 <- {
1764       "return":[
1765          {
1766             "label":"monitor",
1767             "filename":"stdio"
1768          },
1769          {
1770             "label":"serial0",
1771             "filename":"vc"
1772          }
1773       ]
1774    }
1775
1776 EQMP
1777
1778     {
1779         .name       = "query-chardev",
1780         .args_type  = "",
1781         .mhandler.cmd_new = qmp_marshal_input_query_chardev,
1782     },
1783
1784 SQMP
1785 query-block
1786 -----------
1787
1788 Show the block devices.
1789
1790 Each block device information is stored in a json-object and the returned value
1791 is a json-array of all devices.
1792
1793 Each json-object contain the following:
1794
1795 - "device": device name (json-string)
1796 - "type": device type (json-string)
1797          - deprecated, retained for backward compatibility
1798          - Possible values: "unknown"
1799 - "removable": true if the device is removable, false otherwise (json-bool)
1800 - "locked": true if the device is locked, false otherwise (json-bool)
1801 - "tray_open": only present if removable, true if the device has a tray,
1802                and it is open (json-bool)
1803 - "inserted": only present if the device is inserted, it is a json-object
1804    containing the following:
1805          - "file": device file name (json-string)
1806          - "ro": true if read-only, false otherwise (json-bool)
1807          - "drv": driver format name (json-string)
1808              - Possible values: "blkdebug", "bochs", "cloop", "cow", "dmg",
1809                                 "file", "file", "ftp", "ftps", "host_cdrom",
1810                                 "host_device", "host_floppy", "http", "https",
1811                                 "nbd", "parallels", "qcow", "qcow2", "raw",
1812                                 "tftp", "vdi", "vmdk", "vpc", "vvfat"
1813          - "backing_file": backing file name (json-string, optional)
1814          - "backing_file_depth": number of files in the backing file chain (json-int)
1815          - "encrypted": true if encrypted, false otherwise (json-bool)
1816          - "bps": limit total bytes per second (json-int)
1817          - "bps_rd": limit read bytes per second (json-int)
1818          - "bps_wr": limit write bytes per second (json-int)
1819          - "iops": limit total I/O operations per second (json-int)
1820          - "iops_rd": limit read operations per second (json-int)
1821          - "iops_wr": limit write operations per second (json-int)
1822          - "bps_max":  total max in bytes (json-int)
1823          - "bps_rd_max":  read max in bytes (json-int)
1824          - "bps_wr_max":  write max in bytes (json-int)
1825          - "iops_max":  total I/O operations max (json-int)
1826          - "iops_rd_max":  read I/O operations max (json-int)
1827          - "iops_wr_max":  write I/O operations max (json-int)
1828          - "iops_size": I/O size when limiting by iops (json-int)
1829          - "image": the detail of the image, it is a json-object containing
1830             the following:
1831              - "filename": image file name (json-string)
1832              - "format": image format (json-string)
1833              - "virtual-size": image capacity in bytes (json-int)
1834              - "dirty-flag": true if image is not cleanly closed, not present
1835                              means clean (json-bool, optional)
1836              - "actual-size": actual size on disk in bytes of the image, not
1837                               present when image does not support thin
1838                               provision (json-int, optional)
1839              - "cluster-size": size of a cluster in bytes, not present if image
1840                                format does not support it (json-int, optional)
1841              - "encrypted": true if the image is encrypted, not present means
1842                             false or the image format does not support
1843                             encryption (json-bool, optional)
1844              - "backing_file": backing file name, not present means no backing
1845                                file is used or the image format does not
1846                                support backing file chain
1847                                (json-string, optional)
1848              - "full-backing-filename": full path of the backing file, not
1849                                         present if it equals backing_file or no
1850                                         backing file is used
1851                                         (json-string, optional)
1852              - "backing-filename-format": the format of the backing file, not
1853                                           present means unknown or no backing
1854                                           file (json-string, optional)
1855              - "snapshots": the internal snapshot info, it is an optional list
1856                 of json-object containing the following:
1857                  - "id": unique snapshot id (json-string)
1858                  - "name": snapshot name (json-string)
1859                  - "vm-state-size": size of the VM state in bytes (json-int)
1860                  - "date-sec": UTC date of the snapshot in seconds (json-int)
1861                  - "date-nsec": fractional part in nanoseconds to be used with
1862                                 date-sec (json-int)
1863                  - "vm-clock-sec": VM clock relative to boot in seconds
1864                                    (json-int)
1865                  - "vm-clock-nsec": fractional part in nanoseconds to be used
1866                                     with vm-clock-sec (json-int)
1867              - "backing-image": the detail of the backing image, it is an
1868                                 optional json-object only present when a
1869                                 backing image present for this image
1870
1871 - "io-status": I/O operation status, only present if the device supports it
1872                and the VM is configured to stop on errors. It's always reset
1873                to "ok" when the "cont" command is issued (json_string, optional)
1874              - Possible values: "ok", "failed", "nospace"
1875
1876 Example:
1877
1878 -> { "execute": "query-block" }
1879 <- {
1880       "return":[
1881          {
1882             "io-status": "ok",
1883             "device":"ide0-hd0",
1884             "locked":false,
1885             "removable":false,
1886             "inserted":{
1887                "ro":false,
1888                "drv":"qcow2",
1889                "encrypted":false,
1890                "file":"disks/test.qcow2",
1891                "backing_file_depth":1,
1892                "bps":1000000,
1893                "bps_rd":0,
1894                "bps_wr":0,
1895                "iops":1000000,
1896                "iops_rd":0,
1897                "iops_wr":0,
1898                "bps_max": 8000000,
1899                "bps_rd_max": 0,
1900                "bps_wr_max": 0,
1901                "iops_max": 0,
1902                "iops_rd_max": 0,
1903                "iops_wr_max": 0,
1904                "iops_size": 0,
1905                "image":{
1906                   "filename":"disks/test.qcow2",
1907                   "format":"qcow2",
1908                   "virtual-size":2048000,
1909                   "backing_file":"base.qcow2",
1910                   "full-backing-filename":"disks/base.qcow2",
1911                   "backing-filename-format:"qcow2",
1912                   "snapshots":[
1913                      {
1914                         "id": "1",
1915                         "name": "snapshot1",
1916                         "vm-state-size": 0,
1917                         "date-sec": 10000200,
1918                         "date-nsec": 12,
1919                         "vm-clock-sec": 206,
1920                         "vm-clock-nsec": 30
1921                      }
1922                   ],
1923                   "backing-image":{
1924                       "filename":"disks/base.qcow2",
1925                       "format":"qcow2",
1926                       "virtual-size":2048000
1927                   }
1928                }
1929             },
1930             "type":"unknown"
1931          },
1932          {
1933             "io-status": "ok",
1934             "device":"ide1-cd0",
1935             "locked":false,
1936             "removable":true,
1937             "type":"unknown"
1938          },
1939          {
1940             "device":"floppy0",
1941             "locked":false,
1942             "removable":true,
1943             "type":"unknown"
1944          },
1945          {
1946             "device":"sd0",
1947             "locked":false,
1948             "removable":true,
1949             "type":"unknown"
1950          }
1951       ]
1952    }
1953
1954 EQMP
1955
1956     {
1957         .name       = "query-block",
1958         .args_type  = "",
1959         .mhandler.cmd_new = qmp_marshal_input_query_block,
1960     },
1961
1962 SQMP
1963 query-blockstats
1964 ----------------
1965
1966 Show block device statistics.
1967
1968 Each device statistic information is stored in a json-object and the returned
1969 value is a json-array of all devices.
1970
1971 Each json-object contain the following:
1972
1973 - "device": device name (json-string)
1974 - "stats": A json-object with the statistics information, it contains:
1975     - "rd_bytes": bytes read (json-int)
1976     - "wr_bytes": bytes written (json-int)
1977     - "rd_operations": read operations (json-int)
1978     - "wr_operations": write operations (json-int)
1979     - "flush_operations": cache flush operations (json-int)
1980     - "wr_total_time_ns": total time spend on writes in nano-seconds (json-int)
1981     - "rd_total_time_ns": total time spend on reads in nano-seconds (json-int)
1982     - "flush_total_time_ns": total time spend on cache flushes in nano-seconds (json-int)
1983     - "wr_highest_offset": Highest offset of a sector written since the
1984                            BlockDriverState has been opened (json-int)
1985 - "parent": Contains recursively the statistics of the underlying
1986             protocol (e.g. the host file for a qcow2 image). If there is
1987             no underlying protocol, this field is omitted
1988             (json-object, optional)
1989
1990 Example:
1991
1992 -> { "execute": "query-blockstats" }
1993 <- {
1994       "return":[
1995          {
1996             "device":"ide0-hd0",
1997             "parent":{
1998                "stats":{
1999                   "wr_highest_offset":3686448128,
2000                   "wr_bytes":9786368,
2001                   "wr_operations":751,
2002                   "rd_bytes":122567168,
2003                   "rd_operations":36772
2004                   "wr_total_times_ns":313253456
2005                   "rd_total_times_ns":3465673657
2006                   "flush_total_times_ns":49653
2007                   "flush_operations":61,
2008                }
2009             },
2010             "stats":{
2011                "wr_highest_offset":2821110784,
2012                "wr_bytes":9786368,
2013                "wr_operations":692,
2014                "rd_bytes":122739200,
2015                "rd_operations":36604
2016                "flush_operations":51,
2017                "wr_total_times_ns":313253456
2018                "rd_total_times_ns":3465673657
2019                "flush_total_times_ns":49653
2020             }
2021          },
2022          {
2023             "device":"ide1-cd0",
2024             "stats":{
2025                "wr_highest_offset":0,
2026                "wr_bytes":0,
2027                "wr_operations":0,
2028                "rd_bytes":0,
2029                "rd_operations":0
2030                "flush_operations":0,
2031                "wr_total_times_ns":0
2032                "rd_total_times_ns":0
2033                "flush_total_times_ns":0
2034             }
2035          },
2036          {
2037             "device":"floppy0",
2038             "stats":{
2039                "wr_highest_offset":0,
2040                "wr_bytes":0,
2041                "wr_operations":0,
2042                "rd_bytes":0,
2043                "rd_operations":0
2044                "flush_operations":0,
2045                "wr_total_times_ns":0
2046                "rd_total_times_ns":0
2047                "flush_total_times_ns":0
2048             }
2049          },
2050          {
2051             "device":"sd0",
2052             "stats":{
2053                "wr_highest_offset":0,
2054                "wr_bytes":0,
2055                "wr_operations":0,
2056                "rd_bytes":0,
2057                "rd_operations":0
2058                "flush_operations":0,
2059                "wr_total_times_ns":0
2060                "rd_total_times_ns":0
2061                "flush_total_times_ns":0
2062             }
2063          }
2064       ]
2065    }
2066
2067 EQMP
2068
2069     {
2070         .name       = "query-blockstats",
2071         .args_type  = "",
2072         .mhandler.cmd_new = qmp_marshal_input_query_blockstats,
2073     },
2074
2075 SQMP
2076 query-cpus
2077 ----------
2078
2079 Show CPU information.
2080
2081 Return a json-array. Each CPU is represented by a json-object, which contains:
2082
2083 - "CPU": CPU index (json-int)
2084 - "current": true if this is the current CPU, false otherwise (json-bool)
2085 - "halted": true if the cpu is halted, false otherwise (json-bool)
2086 - Current program counter. The key's name depends on the architecture:
2087      "pc": i386/x86_64 (json-int)
2088      "nip": PPC (json-int)
2089      "pc" and "npc": sparc (json-int)
2090      "PC": mips (json-int)
2091 - "thread_id": ID of the underlying host thread (json-int)
2092
2093 Example:
2094
2095 -> { "execute": "query-cpus" }
2096 <- {
2097       "return":[
2098          {
2099             "CPU":0,
2100             "current":true,
2101             "halted":false,
2102             "pc":3227107138
2103             "thread_id":3134
2104          },
2105          {
2106             "CPU":1,
2107             "current":false,
2108             "halted":true,
2109             "pc":7108165
2110             "thread_id":3135
2111          }
2112       ]
2113    }
2114
2115 EQMP
2116
2117     {
2118         .name       = "query-cpus",
2119         .args_type  = "",
2120         .mhandler.cmd_new = qmp_marshal_input_query_cpus,
2121     },
2122
2123 SQMP
2124 query-pci
2125 ---------
2126
2127 PCI buses and devices information.
2128
2129 The returned value is a json-array of all buses. Each bus is represented by
2130 a json-object, which has a key with a json-array of all PCI devices attached
2131 to it. Each device is represented by a json-object.
2132
2133 The bus json-object contains the following:
2134
2135 - "bus": bus number (json-int)
2136 - "devices": a json-array of json-objects, each json-object represents a
2137              PCI device
2138
2139 The PCI device json-object contains the following:
2140
2141 - "bus": identical to the parent's bus number (json-int)
2142 - "slot": slot number (json-int)
2143 - "function": function number (json-int)
2144 - "class_info": a json-object containing:
2145      - "desc": device class description (json-string, optional)
2146      - "class": device class number (json-int)
2147 - "id": a json-object containing:
2148      - "device": device ID (json-int)
2149      - "vendor": vendor ID (json-int)
2150 - "irq": device's IRQ if assigned (json-int, optional)
2151 - "qdev_id": qdev id string (json-string)
2152 - "pci_bridge": It's a json-object, only present if this device is a
2153                 PCI bridge, contains:
2154      - "bus": bus number (json-int)
2155      - "secondary": secondary bus number (json-int)
2156      - "subordinate": subordinate bus number (json-int)
2157      - "io_range": I/O memory range information, a json-object with the
2158                    following members:
2159                  - "base": base address, in bytes (json-int)
2160                  - "limit": limit address, in bytes (json-int)
2161      - "memory_range": memory range information, a json-object with the
2162                        following members:
2163                  - "base": base address, in bytes (json-int)
2164                  - "limit": limit address, in bytes (json-int)
2165      - "prefetchable_range": Prefetchable memory range information, a
2166                              json-object with the following members:
2167                  - "base": base address, in bytes (json-int)
2168                  - "limit": limit address, in bytes (json-int)
2169      - "devices": a json-array of PCI devices if there's any attached, each
2170                   each element is represented by a json-object, which contains
2171                   the same members of the 'PCI device json-object' described
2172                   above (optional)
2173 - "regions": a json-array of json-objects, each json-object represents a
2174              memory region of this device
2175
2176 The memory range json-object contains the following:
2177
2178 - "base": base memory address (json-int)
2179 - "limit": limit value (json-int)
2180
2181 The region json-object can be an I/O region or a memory region, an I/O region
2182 json-object contains the following:
2183
2184 - "type": "io" (json-string, fixed)
2185 - "bar": BAR number (json-int)
2186 - "address": memory address (json-int)
2187 - "size": memory size (json-int)
2188
2189 A memory region json-object contains the following:
2190
2191 - "type": "memory" (json-string, fixed)
2192 - "bar": BAR number (json-int)
2193 - "address": memory address (json-int)
2194 - "size": memory size (json-int)
2195 - "mem_type_64": true or false (json-bool)
2196 - "prefetch": true or false (json-bool)
2197
2198 Example:
2199
2200 -> { "execute": "query-pci" }
2201 <- {
2202       "return":[
2203          {
2204             "bus":0,
2205             "devices":[
2206                {
2207                   "bus":0,
2208                   "qdev_id":"",
2209                   "slot":0,
2210                   "class_info":{
2211                      "class":1536,
2212                      "desc":"Host bridge"
2213                   },
2214                   "id":{
2215                      "device":32902,
2216                      "vendor":4663
2217                   },
2218                   "function":0,
2219                   "regions":[
2220
2221                   ]
2222                },
2223                {
2224                   "bus":0,
2225                   "qdev_id":"",
2226                   "slot":1,
2227                   "class_info":{
2228                      "class":1537,
2229                      "desc":"ISA bridge"
2230                   },
2231                   "id":{
2232                      "device":32902,
2233                      "vendor":28672
2234                   },
2235                   "function":0,
2236                   "regions":[
2237
2238                   ]
2239                },
2240                {
2241                   "bus":0,
2242                   "qdev_id":"",
2243                   "slot":1,
2244                   "class_info":{
2245                      "class":257,
2246                      "desc":"IDE controller"
2247                   },
2248                   "id":{
2249                      "device":32902,
2250                      "vendor":28688
2251                   },
2252                   "function":1,
2253                   "regions":[
2254                      {
2255                         "bar":4,
2256                         "size":16,
2257                         "address":49152,
2258                         "type":"io"
2259                      }
2260                   ]
2261                },
2262                {
2263                   "bus":0,
2264                   "qdev_id":"",
2265                   "slot":2,
2266                   "class_info":{
2267                      "class":768,
2268                      "desc":"VGA controller"
2269                   },
2270                   "id":{
2271                      "device":4115,
2272                      "vendor":184
2273                   },
2274                   "function":0,
2275                   "regions":[
2276                      {
2277                         "prefetch":true,
2278                         "mem_type_64":false,
2279                         "bar":0,
2280                         "size":33554432,
2281                         "address":4026531840,
2282                         "type":"memory"
2283                      },
2284                      {
2285                         "prefetch":false,
2286                         "mem_type_64":false,
2287                         "bar":1,
2288                         "size":4096,
2289                         "address":4060086272,
2290                         "type":"memory"
2291                      },
2292                      {
2293                         "prefetch":false,
2294                         "mem_type_64":false,
2295                         "bar":6,
2296                         "size":65536,
2297                         "address":-1,
2298                         "type":"memory"
2299                      }
2300                   ]
2301                },
2302                {
2303                   "bus":0,
2304                   "qdev_id":"",
2305                   "irq":11,
2306                   "slot":4,
2307                   "class_info":{
2308                      "class":1280,
2309                      "desc":"RAM controller"
2310                   },
2311                   "id":{
2312                      "device":6900,
2313                      "vendor":4098
2314                   },
2315                   "function":0,
2316                   "regions":[
2317                      {
2318                         "bar":0,
2319                         "size":32,
2320                         "address":49280,
2321                         "type":"io"
2322                      }
2323                   ]
2324                }
2325             ]
2326          }
2327       ]
2328    }
2329
2330 Note: This example has been shortened as the real response is too long.
2331
2332 EQMP
2333
2334     {
2335         .name       = "query-pci",
2336         .args_type  = "",
2337         .mhandler.cmd_new = qmp_marshal_input_query_pci,
2338     },
2339
2340 SQMP
2341 query-kvm
2342 ---------
2343
2344 Show KVM information.
2345
2346 Return a json-object with the following information:
2347
2348 - "enabled": true if KVM support is enabled, false otherwise (json-bool)
2349 - "present": true if QEMU has KVM support, false otherwise (json-bool)
2350
2351 Example:
2352
2353 -> { "execute": "query-kvm" }
2354 <- { "return": { "enabled": true, "present": true } }
2355
2356 EQMP
2357
2358     {
2359         .name       = "query-kvm",
2360         .args_type  = "",
2361         .mhandler.cmd_new = qmp_marshal_input_query_kvm,
2362     },
2363
2364 SQMP
2365 query-status
2366 ------------
2367
2368 Return a json-object with the following information:
2369
2370 - "running": true if the VM is running, or false if it is paused (json-bool)
2371 - "singlestep": true if the VM is in single step mode,
2372                 false otherwise (json-bool)
2373 - "status": one of the following values (json-string)
2374     "debug" - QEMU is running on a debugger
2375     "inmigrate" - guest is paused waiting for an incoming migration
2376     "internal-error" - An internal error that prevents further guest
2377     execution has occurred
2378     "io-error" - the last IOP has failed and the device is configured
2379     to pause on I/O errors
2380     "paused" - guest has been paused via the 'stop' command
2381     "postmigrate" - guest is paused following a successful 'migrate'
2382     "prelaunch" - QEMU was started with -S and guest has not started
2383     "finish-migrate" - guest is paused to finish the migration process
2384     "restore-vm" - guest is paused to restore VM state
2385     "running" - guest is actively running
2386     "save-vm" - guest is paused to save the VM state
2387     "shutdown" - guest is shut down (and -no-shutdown is in use)
2388     "watchdog" - the watchdog action is configured to pause and
2389      has been triggered
2390
2391 Example:
2392
2393 -> { "execute": "query-status" }
2394 <- { "return": { "running": true, "singlestep": false, "status": "running" } }
2395
2396 EQMP
2397
2398     {
2399         .name       = "query-status",
2400         .args_type  = "",
2401         .mhandler.cmd_new = qmp_marshal_input_query_status,
2402     },
2403
2404 SQMP
2405 query-mice
2406 ----------
2407
2408 Show VM mice information.
2409
2410 Each mouse is represented by a json-object, the returned value is a json-array
2411 of all mice.
2412
2413 The mouse json-object contains the following:
2414
2415 - "name": mouse's name (json-string)
2416 - "index": mouse's index (json-int)
2417 - "current": true if this mouse is receiving events, false otherwise (json-bool)
2418 - "absolute": true if the mouse generates absolute input events (json-bool)
2419
2420 Example:
2421
2422 -> { "execute": "query-mice" }
2423 <- {
2424       "return":[
2425          {
2426             "name":"QEMU Microsoft Mouse",
2427             "index":0,
2428             "current":false,
2429             "absolute":false
2430          },
2431          {
2432             "name":"QEMU PS/2 Mouse",
2433             "index":1,
2434             "current":true,
2435             "absolute":true
2436          }
2437       ]
2438    }
2439
2440 EQMP
2441
2442     {
2443         .name       = "query-mice",
2444         .args_type  = "",
2445         .mhandler.cmd_new = qmp_marshal_input_query_mice,
2446     },
2447
2448 SQMP
2449 query-vnc
2450 ---------
2451
2452 Show VNC server information.
2453
2454 Return a json-object with server information. Connected clients are returned
2455 as a json-array of json-objects.
2456
2457 The main json-object contains the following:
2458
2459 - "enabled": true or false (json-bool)
2460 - "host": server's IP address (json-string)
2461 - "family": address family (json-string)
2462          - Possible values: "ipv4", "ipv6", "unix", "unknown"
2463 - "service": server's port number (json-string)
2464 - "auth": authentication method (json-string)
2465          - Possible values: "invalid", "none", "ra2", "ra2ne", "sasl", "tight",
2466                             "tls", "ultra", "unknown", "vencrypt", "vencrypt",
2467                             "vencrypt+plain", "vencrypt+tls+none",
2468                             "vencrypt+tls+plain", "vencrypt+tls+sasl",
2469                             "vencrypt+tls+vnc", "vencrypt+x509+none",
2470                             "vencrypt+x509+plain", "vencrypt+x509+sasl",
2471                             "vencrypt+x509+vnc", "vnc"
2472 - "clients": a json-array of all connected clients
2473
2474 Clients are described by a json-object, each one contain the following:
2475
2476 - "host": client's IP address (json-string)
2477 - "family": address family (json-string)
2478          - Possible values: "ipv4", "ipv6", "unix", "unknown"
2479 - "service": client's port number (json-string)
2480 - "x509_dname": TLS dname (json-string, optional)
2481 - "sasl_username": SASL username (json-string, optional)
2482
2483 Example:
2484
2485 -> { "execute": "query-vnc" }
2486 <- {
2487       "return":{
2488          "enabled":true,
2489          "host":"0.0.0.0",
2490          "service":"50402",
2491          "auth":"vnc",
2492          "family":"ipv4",
2493          "clients":[
2494             {
2495                "host":"127.0.0.1",
2496                "service":"50401",
2497                "family":"ipv4"
2498             }
2499          ]
2500       }
2501    }
2502
2503 EQMP
2504
2505     {
2506         .name       = "query-vnc",
2507         .args_type  = "",
2508         .mhandler.cmd_new = qmp_marshal_input_query_vnc,
2509     },
2510
2511 SQMP
2512 query-spice
2513 -----------
2514
2515 Show SPICE server information.
2516
2517 Return a json-object with server information. Connected clients are returned
2518 as a json-array of json-objects.
2519
2520 The main json-object contains the following:
2521
2522 - "enabled": true or false (json-bool)
2523 - "host": server's IP address (json-string)
2524 - "port": server's port number (json-int, optional)
2525 - "tls-port": server's port number (json-int, optional)
2526 - "auth": authentication method (json-string)
2527          - Possible values: "none", "spice"
2528 - "channels": a json-array of all active channels clients
2529
2530 Channels are described by a json-object, each one contain the following:
2531
2532 - "host": client's IP address (json-string)
2533 - "family": address family (json-string)
2534          - Possible values: "ipv4", "ipv6", "unix", "unknown"
2535 - "port": client's port number (json-string)
2536 - "connection-id": spice connection id.  All channels with the same id
2537                    belong to the same spice session (json-int)
2538 - "channel-type": channel type.  "1" is the main control channel, filter for
2539                   this one if you want track spice sessions only (json-int)
2540 - "channel-id": channel id.  Usually "0", might be different needed when
2541                 multiple channels of the same type exist, such as multiple
2542                 display channels in a multihead setup (json-int)
2543 - "tls": whevener the channel is encrypted (json-bool)
2544
2545 Example:
2546
2547 -> { "execute": "query-spice" }
2548 <- {
2549       "return": {
2550          "enabled": true,
2551          "auth": "spice",
2552          "port": 5920,
2553          "tls-port": 5921,
2554          "host": "0.0.0.0",
2555          "channels": [
2556             {
2557                "port": "54924",
2558                "family": "ipv4",
2559                "channel-type": 1,
2560                "connection-id": 1804289383,
2561                "host": "127.0.0.1",
2562                "channel-id": 0,
2563                "tls": true
2564             },
2565             {
2566                "port": "36710",
2567                "family": "ipv4",
2568                "channel-type": 4,
2569                "connection-id": 1804289383,
2570                "host": "127.0.0.1",
2571                "channel-id": 0,
2572                "tls": false
2573             },
2574             [ ... more channels follow ... ]
2575          ]
2576       }
2577    }
2578
2579 EQMP
2580
2581 #if defined(CONFIG_SPICE)
2582     {
2583         .name       = "query-spice",
2584         .args_type  = "",
2585         .mhandler.cmd_new = qmp_marshal_input_query_spice,
2586     },
2587 #endif
2588
2589 SQMP
2590 query-name
2591 ----------
2592
2593 Show VM name.
2594
2595 Return a json-object with the following information:
2596
2597 - "name": VM's name (json-string, optional)
2598
2599 Example:
2600
2601 -> { "execute": "query-name" }
2602 <- { "return": { "name": "qemu-name" } }
2603
2604 EQMP
2605
2606     {
2607         .name       = "query-name",
2608         .args_type  = "",
2609         .mhandler.cmd_new = qmp_marshal_input_query_name,
2610     },
2611
2612 SQMP
2613 query-uuid
2614 ----------
2615
2616 Show VM UUID.
2617
2618 Return a json-object with the following information:
2619
2620 - "UUID": Universally Unique Identifier (json-string)
2621
2622 Example:
2623
2624 -> { "execute": "query-uuid" }
2625 <- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } }
2626
2627 EQMP
2628
2629     {
2630         .name       = "query-uuid",
2631         .args_type  = "",
2632         .mhandler.cmd_new = qmp_marshal_input_query_uuid,
2633     },
2634
2635 SQMP
2636 query-command-line-options
2637 --------------------------
2638
2639 Show command line option schema.
2640
2641 Return a json-array of command line option schema for all options (or for
2642 the given option), returning an error if the given option doesn't exist.
2643
2644 Each array entry contains the following:
2645
2646 - "option": option name (json-string)
2647 - "parameters": a json-array describes all parameters of the option:
2648     - "name": parameter name (json-string)
2649     - "type": parameter type (one of 'string', 'boolean', 'number',
2650               or 'size')
2651     - "help": human readable description of the parameter
2652               (json-string, optional)
2653
2654 Example:
2655
2656 -> { "execute": "query-command-line-options", "arguments": { "option": "option-rom" } }
2657 <- { "return": [
2658         {
2659             "parameters": [
2660                 {
2661                     "name": "romfile",
2662                     "type": "string"
2663                 },
2664                 {
2665                     "name": "bootindex",
2666                     "type": "number"
2667                 }
2668             ],
2669             "option": "option-rom"
2670         }
2671      ]
2672    }
2673
2674 EQMP
2675
2676     {
2677         .name       = "query-command-line-options",
2678         .args_type  = "option:s?",
2679         .mhandler.cmd_new = qmp_marshal_input_query_command_line_options,
2680     },
2681
2682 SQMP
2683 query-migrate
2684 -------------
2685
2686 Migration status.
2687
2688 Return a json-object. If migration is active there will be another json-object
2689 with RAM migration status and if block migration is active another one with
2690 block migration status.
2691
2692 The main json-object contains the following:
2693
2694 - "status": migration status (json-string)
2695      - Possible values: "active", "completed", "failed", "cancelled"
2696 - "total-time": total amount of ms since migration started.  If
2697                 migration has ended, it returns the total migration
2698                 time (json-int)
2699 - "setup-time" amount of setup time in milliseconds _before_ the
2700                iterations begin but _after_ the QMP command is issued.
2701                This is designed to provide an accounting of any activities
2702                (such as RDMA pinning) which may be expensive, but do not
2703                actually occur during the iterative migration rounds
2704                themselves. (json-int)
2705 - "downtime": only present when migration has finished correctly
2706               total amount in ms for downtime that happened (json-int)
2707 - "expected-downtime": only present while migration is active
2708                 total amount in ms for downtime that was calculated on
2709                 the last bitmap round (json-int)
2710 - "ram": only present if "status" is "active", it is a json-object with the
2711   following RAM information:
2712          - "transferred": amount transferred in bytes (json-int)
2713          - "remaining": amount remaining to transfer in bytes (json-int)
2714          - "total": total amount of memory in bytes (json-int)
2715          - "duplicate": number of pages filled entirely with the same
2716             byte (json-int)
2717             These are sent over the wire much more efficiently.
2718          - "skipped": number of skipped zero pages (json-int)
2719          - "normal" : number of whole pages transferred.  I.e. they
2720             were not sent as duplicate or xbzrle pages (json-int)
2721          - "normal-bytes" : number of bytes transferred in whole
2722             pages. This is just normal pages times size of one page,
2723             but this way upper levels don't need to care about page
2724             size (json-int)
2725 - "disk": only present if "status" is "active" and it is a block migration,
2726   it is a json-object with the following disk information:
2727          - "transferred": amount transferred in bytes (json-int)
2728          - "remaining": amount remaining to transfer in bytes json-int)
2729          - "total": total disk size in bytes (json-int)
2730 - "xbzrle-cache": only present if XBZRLE is active.
2731   It is a json-object with the following XBZRLE information:
2732          - "cache-size": XBZRLE cache size in bytes
2733          - "bytes": number of bytes transferred for XBZRLE compressed pages
2734          - "pages": number of XBZRLE compressed pages
2735          - "cache-miss": number of XBRZRLE page cache misses
2736          - "overflow": number of times XBZRLE overflows.  This means
2737            that the XBZRLE encoding was bigger than just sent the
2738            whole page, and then we sent the whole page instead (as as
2739            normal page).
2740
2741 Examples:
2742
2743 1. Before the first migration
2744
2745 -> { "execute": "query-migrate" }
2746 <- { "return": {} }
2747
2748 2. Migration is done and has succeeded
2749
2750 -> { "execute": "query-migrate" }
2751 <- { "return": {
2752         "status": "completed",
2753         "ram":{
2754           "transferred":123,
2755           "remaining":123,
2756           "total":246,
2757           "total-time":12345,
2758           "setup-time":12345,
2759           "downtime":12345,
2760           "duplicate":123,
2761           "normal":123,
2762           "normal-bytes":123456
2763         }
2764      }
2765    }
2766
2767 3. Migration is done and has failed
2768
2769 -> { "execute": "query-migrate" }
2770 <- { "return": { "status": "failed" } }
2771
2772 4. Migration is being performed and is not a block migration:
2773
2774 -> { "execute": "query-migrate" }
2775 <- {
2776       "return":{
2777          "status":"active",
2778          "ram":{
2779             "transferred":123,
2780             "remaining":123,
2781             "total":246,
2782             "total-time":12345,
2783             "setup-time":12345,
2784             "expected-downtime":12345,
2785             "duplicate":123,
2786             "normal":123,
2787             "normal-bytes":123456
2788          }
2789       }
2790    }
2791
2792 5. Migration is being performed and is a block migration:
2793
2794 -> { "execute": "query-migrate" }
2795 <- {
2796       "return":{
2797          "status":"active",
2798          "ram":{
2799             "total":1057024,
2800             "remaining":1053304,
2801             "transferred":3720,
2802             "total-time":12345,
2803             "setup-time":12345,
2804             "expected-downtime":12345,
2805             "duplicate":123,
2806             "normal":123,
2807             "normal-bytes":123456
2808          },
2809          "disk":{
2810             "total":20971520,
2811             "remaining":20880384,
2812             "transferred":91136
2813          }
2814       }
2815    }
2816
2817 6. Migration is being performed and XBZRLE is active:
2818
2819 -> { "execute": "query-migrate" }
2820 <- {
2821       "return":{
2822          "status":"active",
2823          "capabilities" : [ { "capability": "xbzrle", "state" : true } ],
2824          "ram":{
2825             "total":1057024,
2826             "remaining":1053304,
2827             "transferred":3720,
2828             "total-time":12345,
2829             "setup-time":12345,
2830             "expected-downtime":12345,
2831             "duplicate":10,
2832             "normal":3333,
2833             "normal-bytes":3412992
2834          },
2835          "xbzrle-cache":{
2836             "cache-size":67108864,
2837             "bytes":20971520,
2838             "pages":2444343,
2839             "cache-miss":2244,
2840             "overflow":34434
2841          }
2842       }
2843    }
2844
2845 EQMP
2846
2847     {
2848         .name       = "query-migrate",
2849         .args_type  = "",
2850         .mhandler.cmd_new = qmp_marshal_input_query_migrate,
2851     },
2852
2853 SQMP
2854 migrate-set-capabilities
2855 ------------------------
2856
2857 Enable/Disable migration capabilities
2858
2859 - "xbzrle": XBZRLE support
2860
2861 Arguments:
2862
2863 Example:
2864
2865 -> { "execute": "migrate-set-capabilities" , "arguments":
2866      { "capabilities": [ { "capability": "xbzrle", "state": true } ] } }
2867
2868 EQMP
2869
2870     {
2871         .name       = "migrate-set-capabilities",
2872         .args_type  = "capabilities:O",
2873         .params     = "capability:s,state:b",
2874         .mhandler.cmd_new = qmp_marshal_input_migrate_set_capabilities,
2875     },
2876 SQMP
2877 query-migrate-capabilities
2878 --------------------------
2879
2880 Query current migration capabilities
2881
2882 - "capabilities": migration capabilities state
2883          - "xbzrle" : XBZRLE state (json-bool)
2884
2885 Arguments:
2886
2887 Example:
2888
2889 -> { "execute": "query-migrate-capabilities" }
2890 <- { "return": [ { "state": false, "capability": "xbzrle" } ] }
2891
2892 EQMP
2893
2894     {
2895         .name       = "query-migrate-capabilities",
2896         .args_type  = "",
2897         .mhandler.cmd_new = qmp_marshal_input_query_migrate_capabilities,
2898     },
2899
2900 SQMP
2901 query-balloon
2902 -------------
2903
2904 Show balloon information.
2905
2906 Make an asynchronous request for balloon info. When the request completes a
2907 json-object will be returned containing the following data:
2908
2909 - "actual": current balloon value in bytes (json-int)
2910
2911 Example:
2912
2913 -> { "execute": "query-balloon" }
2914 <- {
2915       "return":{
2916          "actual":1073741824,
2917       }
2918    }
2919
2920 EQMP
2921
2922     {
2923         .name       = "query-balloon",
2924         .args_type  = "",
2925         .mhandler.cmd_new = qmp_marshal_input_query_balloon,
2926     },
2927
2928     {
2929         .name       = "query-block-jobs",
2930         .args_type  = "",
2931         .mhandler.cmd_new = qmp_marshal_input_query_block_jobs,
2932     },
2933
2934     {
2935         .name       = "qom-list",
2936         .args_type  = "path:s",
2937         .mhandler.cmd_new = qmp_marshal_input_qom_list,
2938     },
2939
2940     {
2941         .name       = "qom-set",
2942         .args_type  = "path:s,property:s,value:q",
2943         .mhandler.cmd_new = qmp_qom_set,
2944     },
2945
2946     {
2947         .name       = "qom-get",
2948         .args_type  = "path:s,property:s",
2949         .mhandler.cmd_new = qmp_qom_get,
2950     },
2951
2952     {
2953         .name       = "nbd-server-start",
2954         .args_type  = "addr:q",
2955         .mhandler.cmd_new = qmp_marshal_input_nbd_server_start,
2956     },
2957     {
2958         .name       = "nbd-server-add",
2959         .args_type  = "device:B,writable:b?",
2960         .mhandler.cmd_new = qmp_marshal_input_nbd_server_add,
2961     },
2962     {
2963         .name       = "nbd-server-stop",
2964         .args_type  = "",
2965         .mhandler.cmd_new = qmp_marshal_input_nbd_server_stop,
2966     },
2967
2968     {
2969         .name       = "change-vnc-password",
2970         .args_type  = "password:s",
2971         .mhandler.cmd_new = qmp_marshal_input_change_vnc_password,
2972     },
2973     {
2974         .name       = "qom-list-types",
2975         .args_type  = "implements:s?,abstract:b?",
2976         .mhandler.cmd_new = qmp_marshal_input_qom_list_types,
2977     },
2978
2979     {
2980         .name       = "device-list-properties",
2981         .args_type  = "typename:s",
2982         .mhandler.cmd_new = qmp_marshal_input_device_list_properties,
2983     },
2984
2985     {
2986         .name       = "query-machines",
2987         .args_type  = "",
2988         .mhandler.cmd_new = qmp_marshal_input_query_machines,
2989     },
2990
2991     {
2992         .name       = "query-cpu-definitions",
2993         .args_type  = "",
2994         .mhandler.cmd_new = qmp_marshal_input_query_cpu_definitions,
2995     },
2996
2997     {
2998         .name       = "query-target",
2999         .args_type  = "",
3000         .mhandler.cmd_new = qmp_marshal_input_query_target,
3001     },
3002
3003     {
3004         .name       = "query-tpm",
3005         .args_type  = "",
3006         .mhandler.cmd_new = qmp_marshal_input_query_tpm,
3007     },
3008
3009 SQMP
3010 query-tpm
3011 ---------
3012
3013 Return information about the TPM device.
3014
3015 Arguments: None
3016
3017 Example:
3018
3019 -> { "execute": "query-tpm" }
3020 <- { "return":
3021      [
3022        { "model": "tpm-tis",
3023          "options":
3024            { "type": "passthrough",
3025              "data":
3026                { "cancel-path": "/sys/class/misc/tpm0/device/cancel",
3027                  "path": "/dev/tpm0"
3028                }
3029            },
3030          "id": "tpm0"
3031        }
3032      ]
3033    }
3034
3035 EQMP
3036
3037     {
3038         .name       = "query-tpm-models",
3039         .args_type  = "",
3040         .mhandler.cmd_new = qmp_marshal_input_query_tpm_models,
3041     },
3042
3043 SQMP
3044 query-tpm-models
3045 ----------------
3046
3047 Return a list of supported TPM models.
3048
3049 Arguments: None
3050
3051 Example:
3052
3053 -> { "execute": "query-tpm-models" }
3054 <- { "return": [ "tpm-tis" ] }
3055
3056 EQMP
3057
3058     {
3059         .name       = "query-tpm-types",
3060         .args_type  = "",
3061         .mhandler.cmd_new = qmp_marshal_input_query_tpm_types,
3062     },
3063
3064 SQMP
3065 query-tpm-types
3066 ---------------
3067
3068 Return a list of supported TPM types.
3069
3070 Arguments: None
3071
3072 Example:
3073
3074 -> { "execute": "query-tpm-types" }
3075 <- { "return": [ "passthrough" ] }
3076
3077 EQMP
3078
3079     {
3080         .name       = "chardev-add",
3081         .args_type  = "id:s,backend:q",
3082         .mhandler.cmd_new = qmp_marshal_input_chardev_add,
3083     },
3084
3085 SQMP
3086 chardev-add
3087 ----------------
3088
3089 Add a chardev.
3090
3091 Arguments:
3092
3093 - "id": the chardev's ID, must be unique (json-string)
3094 - "backend": chardev backend type + parameters
3095
3096 Examples:
3097
3098 -> { "execute" : "chardev-add",
3099      "arguments" : { "id" : "foo",
3100                      "backend" : { "type" : "null", "data" : {} } } }
3101 <- { "return": {} }
3102
3103 -> { "execute" : "chardev-add",
3104      "arguments" : { "id" : "bar",
3105                      "backend" : { "type" : "file",
3106                                    "data" : { "out" : "/tmp/bar.log" } } } }
3107 <- { "return": {} }
3108
3109 -> { "execute" : "chardev-add",
3110      "arguments" : { "id" : "baz",
3111                      "backend" : { "type" : "pty", "data" : {} } } }
3112 <- { "return": { "pty" : "/dev/pty/42" } }
3113
3114 EQMP
3115
3116     {
3117         .name       = "chardev-remove",
3118         .args_type  = "id:s",
3119         .mhandler.cmd_new = qmp_marshal_input_chardev_remove,
3120     },
3121
3122
3123 SQMP
3124 chardev-remove
3125 --------------
3126
3127 Remove a chardev.
3128
3129 Arguments:
3130
3131 - "id": the chardev's ID, must exist and not be in use (json-string)
3132
3133 Example:
3134
3135 -> { "execute": "chardev-remove", "arguments": { "id" : "foo" } }
3136 <- { "return": {} }
3137
3138 EQMP
3139     {
3140         .name       = "query-rx-filter",
3141         .args_type  = "name:s?",
3142         .mhandler.cmd_new = qmp_marshal_input_query_rx_filter,
3143     },
3144
3145 SQMP
3146 query-rx-filter
3147 ---------------
3148
3149 Show rx-filter information.
3150
3151 Returns a json-array of rx-filter information for all NICs (or for the
3152 given NIC), returning an error if the given NIC doesn't exist, or
3153 given NIC doesn't support rx-filter querying, or given net client
3154 isn't a NIC.
3155
3156 The query will clear the event notification flag of each NIC, then qemu
3157 will start to emit event to QMP monitor.
3158
3159 Each array entry contains the following:
3160
3161 - "name": net client name (json-string)
3162 - "promiscuous": promiscuous mode is enabled (json-bool)
3163 - "multicast": multicast receive state (one of 'normal', 'none', 'all')
3164 - "unicast": unicast receive state  (one of 'normal', 'none', 'all')
3165 - "broadcast-allowed": allow to receive broadcast (json-bool)
3166 - "multicast-overflow": multicast table is overflowed (json-bool)
3167 - "unicast-overflow": unicast table is overflowed (json-bool)
3168 - "main-mac": main macaddr string (json-string)
3169 - "vlan-table": a json-array of active vlan id
3170 - "unicast-table": a json-array of unicast macaddr string
3171 - "multicast-table": a json-array of multicast macaddr string
3172
3173 Example:
3174
3175 -> { "execute": "query-rx-filter", "arguments": { "name": "vnet0" } }
3176 <- { "return": [
3177         {
3178             "promiscuous": true,
3179             "name": "vnet0",
3180             "main-mac": "52:54:00:12:34:56",
3181             "unicast": "normal",
3182             "vlan-table": [
3183                 4,
3184                 0
3185             ],
3186             "unicast-table": [
3187             ],
3188             "multicast": "normal",
3189             "multicast-overflow": false,
3190             "unicast-overflow": false,
3191             "multicast-table": [
3192                 "01:00:5e:00:00:01",
3193                 "33:33:00:00:00:01",
3194                 "33:33:ff:12:34:56"
3195             ],
3196             "broadcast-allowed": false
3197         }
3198       ]
3199    }
3200
3201 EQMP