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