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