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