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