qmp-commands.hx

   1 HXCOMM QMP dispatch table and documentation
   2 HXCOMM Text between SQMP and EQMP is copied to the QMP documentation 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_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_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_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_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_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_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_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_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_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         .mhandler.cmd_new = qmp_device_add,
 280     },
 281
 282 SQMP
 283 device_add
 284 ----------
 285
 286 Add a device.
 287
 288 Arguments:
 289
 290 - "driver": the name of the new device's driver (json-string)
 291 - "bus": the device's parent bus (device tree path, json-string, optional)
 292 - "id": the device's ID, must be unique (json-string)
 293 - device properties
 294
 295 Example:
 296
 297 -> { "execute": "device_add", "arguments": { "driver": "e1000", "id": "net1" } }
 298 <- { "return": {} }
 299
 300 Notes:
 301
 302 (1) For detailed information about this command, please refer to the
 303     'docs/qdev-device-use.txt' file.
 304
 305 (2) It's possible to list device properties by running QEMU with the
 306     "-device DEVICE,\?" command-line argument, where DEVICE is the device's name
 307
 308 EQMP
 309
 310     {
 311         .name       = "device_del",
 312         .args_type  = "id:s",
 313         .mhandler.cmd_new = qmp_marshal_device_del,
 314     },
 315
 316 SQMP
 317 device_del
 318 ----------
 319
 320 Remove a device.
 321
 322 Arguments:
 323
 324 - "id": the device's ID or QOM path (json-string)
 325
 326 Example:
 327
 328 -> { "execute": "device_del", "arguments": { "id": "net1" } }
 329 <- { "return": {} }
 330
 331 Example:
 332
 333 -> { "execute": "device_del", "arguments": { "id": "/machine/peripheral-anon/device[0]" } }
 334 <- { "return": {} }
 335
 336 EQMP
 337
 338     {
 339         .name       = "send-key",
 340         .args_type  = "keys:q,hold-time:i?",
 341         .mhandler.cmd_new = qmp_marshal_send_key,
 342     },
 343
 344 SQMP
 345 send-key
 346 ----------
 347
 348 Send keys to VM.
 349
 350 Arguments:
 351
 352 keys array:
 353     - "key": key sequence (a json-array of key union values,
 354              union can be number or qcode enum)
 355
 356 - hold-time: time to delay key up events, milliseconds. Defaults to 100
 357              (json-int, optional)
 358
 359 Example:
 360
 361 -> { "execute": "send-key",
 362      "arguments": { "keys": [ { "type": "qcode", "data": "ctrl" },
 363                               { "type": "qcode", "data": "alt" },
 364                               { "type": "qcode", "data": "delete" } ] } }
 365 <- { "return": {} }
 366
 367 EQMP
 368
 369     {
 370         .name       = "cpu",
 371         .args_type  = "index:i",
 372         .mhandler.cmd_new = qmp_marshal_cpu,
 373     },
 374
 375 SQMP
 376 cpu
 377 ---
 378
 379 Set the default CPU.
 380
 381 Arguments:
 382
 383 - "index": the CPU's index (json-int)
 384
 385 Example:
 386
 387 -> { "execute": "cpu", "arguments": { "index": 0 } }
 388 <- { "return": {} }
 389
 390 Note: CPUs' indexes are obtained with the 'query-cpus' command.
 391
 392 EQMP
 393
 394     {
 395         .name       = "cpu-add",
 396         .args_type  = "id:i",
 397         .mhandler.cmd_new = qmp_marshal_cpu_add,
 398     },
 399
 400 SQMP
 401 cpu-add
 402 -------
 403
 404 Adds virtual cpu
 405
 406 Arguments:
 407
 408 - "id": cpu id (json-int)
 409
 410 Example:
 411
 412 -> { "execute": "cpu-add", "arguments": { "id": 2 } }
 413 <- { "return": {} }
 414
 415 EQMP
 416
 417     {
 418         .name       = "memsave",
 419         .args_type  = "val:l,size:i,filename:s,cpu:i?",
 420         .mhandler.cmd_new = qmp_marshal_memsave,
 421     },
 422
 423 SQMP
 424 memsave
 425 -------
 426
 427 Save to disk virtual memory dump starting at 'val' of size 'size'.
 428
 429 Arguments:
 430
 431 - "val": the starting address (json-int)
 432 - "size": the memory size, in bytes (json-int)
 433 - "filename": file path (json-string)
 434 - "cpu": virtual CPU index (json-int, optional)
 435
 436 Example:
 437
 438 -> { "execute": "memsave",
 439              "arguments": { "val": 10,
 440                             "size": 100,
 441                             "filename": "/tmp/virtual-mem-dump" } }
 442 <- { "return": {} }
 443
 444 EQMP
 445
 446     {
 447         .name       = "pmemsave",
 448         .args_type  = "val:l,size:i,filename:s",
 449         .mhandler.cmd_new = qmp_marshal_pmemsave,
 450     },
 451
 452 SQMP
 453 pmemsave
 454 --------
 455
 456 Save to disk physical memory dump starting at 'val' of size 'size'.
 457
 458 Arguments:
 459
 460 - "val": the starting address (json-int)
 461 - "size": the memory size, in bytes (json-int)
 462 - "filename": file path (json-string)
 463
 464 Example:
 465
 466 -> { "execute": "pmemsave",
 467              "arguments": { "val": 10,
 468                             "size": 100,
 469                             "filename": "/tmp/physical-mem-dump" } }
 470 <- { "return": {} }
 471
 472 EQMP
 473
 474     {
 475         .name       = "inject-nmi",
 476         .args_type  = "",
 477         .mhandler.cmd_new = qmp_marshal_inject_nmi,
 478     },
 479
 480 SQMP
 481 inject-nmi
 482 ----------
 483
 484 Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
 485
 486 Arguments: None.
 487
 488 Example:
 489
 490 -> { "execute": "inject-nmi" }
 491 <- { "return": {} }
 492
 493 Note: inject-nmi fails when the guest doesn't support injecting.
 494
 495 EQMP
 496
 497     {
 498         .name       = "ringbuf-write",
 499         .args_type  = "device:s,data:s,format:s?",
 500         .mhandler.cmd_new = qmp_marshal_ringbuf_write,
 501     },
 502
 503 SQMP
 504 ringbuf-write
 505 -------------
 506
 507 Write to a ring buffer character device.
 508
 509 Arguments:
 510
 511 - "device": ring buffer character device name (json-string)
 512 - "data": data to write (json-string)
 513 - "format": data format (json-string, optional)
 514           - Possible values: "utf8" (default), "base64"
 515
 516 Example:
 517
 518 -> { "execute": "ringbuf-write",
 519                 "arguments": { "device": "foo",
 520                                "data": "abcdefgh",
 521                                "format": "utf8" } }
 522 <- { "return": {} }
 523
 524 EQMP
 525
 526     {
 527         .name       = "ringbuf-read",
 528         .args_type  = "device:s,size:i,format:s?",
 529         .mhandler.cmd_new = qmp_marshal_ringbuf_read,
 530     },
 531
 532 SQMP
 533 ringbuf-read
 534 -------------
 535
 536 Read from a ring buffer character device.
 537
 538 Arguments:
 539
 540 - "device": ring buffer character device name (json-string)
 541 - "size": how many bytes to read at most (json-int)
 542           - Number of data bytes, not number of characters in encoded data
 543 - "format": data format (json-string, optional)
 544           - Possible values: "utf8" (default), "base64"
 545           - Naturally, format "utf8" works only when the ring buffer
 546             contains valid UTF-8 text.  Invalid UTF-8 sequences get
 547             replaced.  Bug: replacement doesn't work.  Bug: can screw
 548             up on encountering NUL characters, after the ring buffer
 549             lost data, and when reading stops because the size limit
 550             is reached.
 551
 552 Example:
 553
 554 -> { "execute": "ringbuf-read",
 555                 "arguments": { "device": "foo",
 556                                "size": 1000,
 557                                "format": "utf8" } }
 558 <- {"return": "abcdefgh"}
 559
 560 EQMP
 561
 562     {
 563         .name       = "xen-save-devices-state",
 564         .args_type  = "filename:F",
 565     .mhandler.cmd_new = qmp_marshal_xen_save_devices_state,
 566     },
 567
 568 SQMP
 569 xen-save-devices-state
 570 -------
 571
 572 Save the state of all devices to file. The RAM and the block devices
 573 of the VM are not saved by this command.
 574
 575 Arguments:
 576
 577 - "filename": the file to save the state of the devices to as binary
 578 data. See xen-save-devices-state.txt for a description of the binary
 579 format.
 580
 581 Example:
 582
 583 -> { "execute": "xen-save-devices-state",
 584      "arguments": { "filename": "/tmp/save" } }
 585 <- { "return": {} }
 586
 587 EQMP
 588
 589     {
 590         .name       = "xen-set-global-dirty-log",
 591         .args_type  = "enable:b",
 592         .mhandler.cmd_new = qmp_marshal_xen_set_global_dirty_log,
 593     },
 594
 595 SQMP
 596 xen-set-global-dirty-log
 597 -------
 598
 599 Enable or disable the global dirty log mode.
 600
 601 Arguments:
 602
 603 - "enable": Enable it or disable it.
 604
 605 Example:
 606
 607 -> { "execute": "xen-set-global-dirty-log",
 608      "arguments": { "enable": true } }
 609 <- { "return": {} }
 610
 611 EQMP
 612
 613     {
 614         .name       = "migrate",
 615         .args_type  = "detach:-d,blk:-b,inc:-i,uri:s",
 616         .mhandler.cmd_new = qmp_marshal_migrate,
 617     },
 618
 619 SQMP
 620 migrate
 621 -------
 622
 623 Migrate to URI.
 624
 625 Arguments:
 626
 627 - "blk": block migration, full disk copy (json-bool, optional)
 628 - "inc": incremental disk copy (json-bool, optional)
 629 - "uri": Destination URI (json-string)
 630
 631 Example:
 632
 633 -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
 634 <- { "return": {} }
 635
 636 Notes:
 637
 638 (1) The 'query-migrate' command should be used to check migration's progress
 639     and final result (this information is provided by the 'status' member)
 640 (2) All boolean arguments default to false
 641 (3) The user Monitor's "detach" argument is invalid in QMP and should not
 642     be used
 643
 644 EQMP
 645
 646     {
 647         .name       = "migrate_cancel",
 648         .args_type  = "",
 649         .mhandler.cmd_new = qmp_marshal_migrate_cancel,
 650     },
 651
 652 SQMP
 653 migrate_cancel
 654 --------------
 655
 656 Cancel the current migration.
 657
 658 Arguments: None.
 659
 660 Example:
 661
 662 -> { "execute": "migrate_cancel" }
 663 <- { "return": {} }
 664
 665 EQMP
 666
 667     {
 668         .name       = "migrate-incoming",
 669         .args_type  = "uri:s",
 670         .mhandler.cmd_new = qmp_marshal_migrate_incoming,
 671     },
 672
 673 SQMP
 674 migrate-incoming
 675 ----------------
 676
 677 Continue an incoming migration
 678
 679 Arguments:
 680
 681 - "uri": Source/listening URI (json-string)
 682
 683 Example:
 684
 685 -> { "execute": "migrate-incoming", "arguments": { "uri": "tcp::4446" } }
 686 <- { "return": {} }
 687
 688 Notes:
 689
 690 (1) QEMU must be started with -incoming defer to allow migrate-incoming to
 691     be used
 692 (2) The uri format is the same as for -incoming
 693
 694 EQMP
 695     {
 696         .name       = "migrate-set-cache-size",
 697         .args_type  = "value:o",
 698         .mhandler.cmd_new = qmp_marshal_migrate_set_cache_size,
 699     },
 700
 701 SQMP
 702 migrate-set-cache-size
 703 ----------------------
 704
 705 Set cache size to be used by XBZRLE migration, the cache size will be rounded
 706 down to the nearest power of 2
 707
 708 Arguments:
 709
 710 - "value": cache size in bytes (json-int)
 711
 712 Example:
 713
 714 -> { "execute": "migrate-set-cache-size", "arguments": { "value": 536870912 } }
 715 <- { "return": {} }
 716
 717 EQMP
 718     {
 719         .name       = "migrate-start-postcopy",
 720         .args_type  = "",
 721         .mhandler.cmd_new = qmp_marshal_migrate_start_postcopy,
 722     },
 723
 724 SQMP
 725 migrate-start-postcopy
 726 ----------------------
 727
 728 Switch an in-progress migration to postcopy mode. Ignored after the end of
 729 migration (or once already in postcopy).
 730
 731 Example:
 732 -> { "execute": "migrate-start-postcopy" }
 733 <- { "return": {} }
 734
 735 EQMP
 736
 737     {
 738         .name       = "query-migrate-cache-size",
 739         .args_type  = "",
 740         .mhandler.cmd_new = qmp_marshal_query_migrate_cache_size,
 741     },
 742
 743 SQMP
 744 query-migrate-cache-size
 745 ------------------------
 746
 747 Show cache size to be used by XBZRLE migration
 748
 749 returns a json-object with the following information:
 750 - "size" : json-int
 751
 752 Example:
 753
 754 -> { "execute": "query-migrate-cache-size" }
 755 <- { "return": 67108864 }
 756
 757 EQMP
 758
 759     {
 760         .name       = "migrate_set_speed",
 761         .args_type  = "value:o",
 762         .mhandler.cmd_new = qmp_marshal_migrate_set_speed,
 763     },
 764
 765 SQMP
 766 migrate_set_speed
 767 -----------------
 768
 769 Set maximum speed for migrations.
 770
 771 Arguments:
 772
 773 - "value": maximum speed, in bytes per second (json-int)
 774
 775 Example:
 776
 777 -> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } }
 778 <- { "return": {} }
 779
 780 EQMP
 781
 782     {
 783         .name       = "migrate_set_downtime",
 784         .args_type  = "value:T",
 785         .mhandler.cmd_new = qmp_marshal_migrate_set_downtime,
 786     },
 787
 788 SQMP
 789 migrate_set_downtime
 790 --------------------
 791
 792 Set maximum tolerated downtime (in seconds) for migrations.
 793
 794 Arguments:
 795
 796 - "value": maximum downtime (json-number)
 797
 798 Example:
 799
 800 -> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } }
 801 <- { "return": {} }
 802
 803 EQMP
 804
 805     {
 806         .name       = "client_migrate_info",
 807         .args_type  = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
 808         .params     = "protocol hostname port tls-port cert-subject",
 809         .help       = "set migration information for remote display",
 810         .mhandler.cmd_new = qmp_marshal_client_migrate_info,
 811     },
 812
 813 SQMP
 814 client_migrate_info
 815 -------------------
 816
 817 Set migration information for remote display.  This makes the server
 818 ask the client to automatically reconnect using the new parameters
 819 once migration finished successfully.  Only implemented for SPICE.
 820
 821 Arguments:
 822
 823 - "protocol":     must be "spice" (json-string)
 824 - "hostname":     migration target hostname (json-string)
 825 - "port":         spice tcp port for plaintext channels (json-int, optional)
 826 - "tls-port":     spice tcp port for tls-secured channels (json-int, optional)
 827 - "cert-subject": server certificate subject (json-string, optional)
 828
 829 Example:
 830
 831 -> { "execute": "client_migrate_info",
 832      "arguments": { "protocol": "spice",
 833                     "hostname": "virt42.lab.kraxel.org",
 834                     "port": 1234 } }
 835 <- { "return": {} }
 836
 837 EQMP
 838
 839     {
 840         .name       = "dump-guest-memory",
 841         .args_type  = "paging:b,protocol:s,detach:b?,begin:i?,end:i?,format:s?",
 842         .params     = "-p protocol [-d] [begin] [length] [format]",
 843         .help       = "dump guest memory to file",
 844         .mhandler.cmd_new = qmp_marshal_dump_guest_memory,
 845     },
 846
 847 SQMP
 848 dump
 849
 850
 851 Dump guest memory to file. The file can be processed with crash or gdb.
 852
 853 Arguments:
 854
 855 - "paging": do paging to get guest's memory mapping (json-bool)
 856 - "protocol": destination file(started with "file:") or destination file
 857               descriptor (started with "fd:") (json-string)
 858 - "detach": if specified, command will return immediately, without waiting
 859             for the dump to finish. The user can track progress using
 860             "query-dump". (json-bool)
 861 - "begin": the starting physical address. It's optional, and should be specified
 862            with length together (json-int)
 863 - "length": the memory size, in bytes. It's optional, and should be specified
 864             with begin together (json-int)
 865 - "format": the format of guest memory dump. It's optional, and can be
 866             elf|kdump-zlib|kdump-lzo|kdump-snappy, but non-elf formats will
 867             conflict with paging and filter, ie. begin and length (json-string)
 868
 869 Example:
 870
 871 -> { "execute": "dump-guest-memory", "arguments": { "protocol": "fd:dump" } }
 872 <- { "return": {} }
 873
 874 Notes:
 875
 876 (1) All boolean arguments default to false
 877
 878 EQMP
 879
 880     {
 881         .name       = "query-dump-guest-memory-capability",
 882         .args_type  = "",
 883     .mhandler.cmd_new = qmp_marshal_query_dump_guest_memory_capability,
 884     },
 885
 886 SQMP
 887 query-dump-guest-memory-capability
 888 ----------
 889
 890 Show available formats for 'dump-guest-memory'
 891
 892 Example:
 893
 894 -> { "execute": "query-dump-guest-memory-capability" }
 895 <- { "return": { "formats":
 896                     ["elf", "kdump-zlib", "kdump-lzo", "kdump-snappy"] }
 897
 898 EQMP
 899
 900     {
 901         .name       = "query-dump",
 902         .args_type  = "",
 903         .params     = "",
 904         .help       = "query background dump status",
 905         .mhandler.cmd_new = qmp_marshal_query_dump,
 906     },
 907
 908 SQMP
 909 query-dump
 910 ----------
 911
 912 Query background dump status.
 913
 914 Arguments: None.
 915
 916 Example:
 917
 918 -> { "execute": "query-dump" }
 919 <- { "return": { "status": "active", "completed": 1024000,
 920                  "total": 2048000 } }
 921
 922 EQMP
 923
 924 #if defined TARGET_S390X
 925     {
 926         .name       = "dump-skeys",
 927         .args_type  = "filename:F",
 928         .mhandler.cmd_new = qmp_marshal_dump_skeys,
 929     },
 930 #endif
 931
 932 SQMP
 933 dump-skeys
 934 ----------
 935
 936 Save guest storage keys to file.
 937
 938 Arguments:
 939
 940 - "filename": file path (json-string)
 941
 942 Example:
 943
 944 -> { "execute": "dump-skeys", "arguments": { "filename": "/tmp/skeys" } }
 945 <- { "return": {} }
 946
 947 EQMP
 948
 949     {
 950         .name       = "netdev_add",
 951         .args_type  = "netdev:O",
 952         .mhandler.cmd_new = qmp_netdev_add,
 953     },
 954
 955 SQMP
 956 netdev_add
 957 ----------
 958
 959 Add host network device.
 960
 961 Arguments:
 962
 963 - "type": the device type, "tap", "user", ... (json-string)
 964 - "id": the device's ID, must be unique (json-string)
 965 - device options
 966
 967 Example:
 968
 969 -> { "execute": "netdev_add",
 970      "arguments": { "type": "user", "id": "netdev1",
 971                     "dnssearch": "example.org" } }
 972 <- { "return": {} }
 973
 974 Note: The supported device options are the same ones supported by the '-netdev'
 975       command-line argument, which are listed in the '-help' output or QEMU's
 976       manual
 977
 978 EQMP
 979
 980     {
 981         .name       = "netdev_del",
 982         .args_type  = "id:s",
 983         .mhandler.cmd_new = qmp_marshal_netdev_del,
 984     },
 985
 986 SQMP
 987 netdev_del
 988 ----------
 989
 990 Remove host network device.
 991
 992 Arguments:
 993
 994 - "id": the device's ID, must be unique (json-string)
 995
 996 Example:
 997
 998 -> { "execute": "netdev_del", "arguments": { "id": "netdev1" } }
 999 <- { "return": {} }
1000
1001
1002 EQMP
1003
1004     {
1005         .name       = "object-add",
1006         .args_type  = "qom-type:s,id:s,props:q?",
1007         .mhandler.cmd_new = qmp_marshal_object_add,
1008     },
1009
1010 SQMP
1011 object-add
1012 ----------
1013
1014 Create QOM object.
1015
1016 Arguments:
1017
1018 - "qom-type": the object's QOM type, i.e. the class name (json-string)
1019 - "id": the object's ID, must be unique (json-string)
1020 - "props": a dictionary of object property values (optional, json-dict)
1021
1022 Example:
1023
1024 -> { "execute": "object-add", "arguments": { "qom-type": "rng-random", "id": "rng1",
1025      "props": { "filename": "/dev/hwrng" } } }
1026 <- { "return": {} }
1027
1028 EQMP
1029
1030     {
1031         .name       = "object-del",
1032         .args_type  = "id:s",
1033         .mhandler.cmd_new = qmp_marshal_object_del,
1034     },
1035
1036 SQMP
1037 object-del
1038 ----------
1039
1040 Remove QOM object.
1041
1042 Arguments:
1043
1044 - "id": the object's ID (json-string)
1045
1046 Example:
1047
1048 -> { "execute": "object-del", "arguments": { "id": "rng1" } }
1049 <- { "return": {} }
1050
1051
1052 EQMP
1053
1054
1055     {
1056         .name       = "block_resize",
1057         .args_type  = "device:s?,node-name:s?,size:o",
1058         .mhandler.cmd_new = qmp_marshal_block_resize,
1059     },
1060
1061 SQMP
1062 block_resize
1063 ------------
1064
1065 Resize a block image while a guest is running.
1066
1067 Arguments:
1068
1069 - "device": the device's ID, must be unique (json-string)
1070 - "node-name": the node name in the block driver state graph (json-string)
1071 - "size": new size
1072
1073 Example:
1074
1075 -> { "execute": "block_resize", "arguments": { "device": "scratch", "size": 1073741824 } }
1076 <- { "return": {} }
1077
1078 EQMP
1079
1080     {
1081         .name       = "block-stream",
1082         .args_type  = "device:B,base:s?,speed:o?,backing-file:s?,on-error:s?",
1083         .mhandler.cmd_new = qmp_marshal_block_stream,
1084     },
1085
1086 SQMP
1087 block-stream
1088 ------------
1089
1090 Copy data from a backing file into a block device.
1091
1092 Arguments:
1093
1094 - "device": The device's ID, must be unique (json-string)
1095 - "base": The file name of the backing image above which copying starts
1096           (json-string, optional)
1097 - "backing-file": The backing file string to write into the active layer. This
1098                   filename is not validated.
1099
1100                   If a pathname string is such that it cannot be resolved by
1101                   QEMU, that means that subsequent QMP or HMP commands must use
1102                   node-names for the image in question, as filename lookup
1103                   methods will fail.
1104
1105                   If not specified, QEMU will automatically determine the
1106                   backing file string to use, or error out if there is no
1107                   obvious choice.  Care should be taken when specifying the
1108                   string, to specify a valid filename or protocol.
1109                   (json-string, optional) (Since 2.1)
1110 - "speed":  the maximum speed, in bytes per second (json-int, optional)
1111 - "on-error": the action to take on an error (default 'report').  'stop' and
1112               'enospc' can only be used if the block device supports io-status.
1113               (json-string, optional) (Since 2.1)
1114
1115 Example:
1116
1117 -> { "execute": "block-stream", "arguments": { "device": "virtio0",
1118                                                "base": "/tmp/master.qcow2" } }
1119 <- { "return": {} }
1120
1121 EQMP
1122
1123     {
1124         .name       = "block-commit",
1125         .args_type  = "device:B,base:s?,top:s?,backing-file:s?,speed:o?",
1126         .mhandler.cmd_new = qmp_marshal_block_commit,
1127     },
1128
1129 SQMP
1130 block-commit
1131 ------------
1132
1133 Live commit of data from overlay image nodes into backing nodes - i.e., writes
1134 data between 'top' and 'base' into 'base'.
1135
1136 Arguments:
1137
1138 - "device": The device's ID, must be unique (json-string)
1139 - "base": The file name of the backing image to write data into.
1140           If not specified, this is the deepest backing image
1141           (json-string, optional)
1142 - "top":  The file name of the backing image within the image chain,
1143           which contains the topmost data to be committed down. If
1144           not specified, this is the active layer. (json-string, optional)
1145
1146 - backing-file:     The backing file string to write into the overlay
1147                     image of 'top'.  If 'top' is the active layer,
1148                     specifying a backing file string is an error. This
1149                     filename is not validated.
1150
1151                     If a pathname string is such that it cannot be
1152                     resolved by QEMU, that means that subsequent QMP or
1153                     HMP commands must use node-names for the image in
1154                     question, as filename lookup methods will fail.
1155
1156                     If not specified, QEMU will automatically determine
1157                     the backing file string to use, or error out if
1158                     there is no obvious choice. Care should be taken
1159                     when specifying the string, to specify a valid
1160                     filename or protocol.
1161                     (json-string, optional) (Since 2.1)
1162
1163           If top == base, that is an error.
1164           If top == active, the job will not be completed by itself,
1165           user needs to complete the job with the block-job-complete
1166           command after getting the ready event. (Since 2.0)
1167
1168           If the base image is smaller than top, then the base image
1169           will be resized to be the same size as top.  If top is
1170           smaller than the base image, the base will not be
1171           truncated.  If you want the base image size to match the
1172           size of the smaller top, you can safely truncate it
1173           yourself once the commit operation successfully completes.
1174           (json-string)
1175 - "speed":  the maximum speed, in bytes per second (json-int, optional)
1176
1177
1178 Example:
1179
1180 -> { "execute": "block-commit", "arguments": { "device": "virtio0",
1181                                               "top": "/tmp/snap1.qcow2" } }
1182 <- { "return": {} }
1183
1184 EQMP
1185
1186     {
1187         .name       = "drive-backup",
1188         .args_type  = "sync:s,device:B,target:s,speed:i?,mode:s?,format:s?,"
1189                       "bitmap:s?,on-source-error:s?,on-target-error:s?",
1190         .mhandler.cmd_new = qmp_marshal_drive_backup,
1191     },
1192
1193 SQMP
1194 drive-backup
1195 ------------
1196
1197 Start a point-in-time copy of a block device to a new destination.  The
1198 status of ongoing drive-backup operations can be checked with
1199 query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
1200 The operation can be stopped before it has completed using the
1201 block-job-cancel command.
1202
1203 Arguments:
1204
1205 - "device": the name of the device which should be copied.
1206             (json-string)
1207 - "target": the target of the new image. If the file exists, or if it is a
1208             device, the existing file/device will be used as the new
1209             destination.  If it does not exist, a new file will be created.
1210             (json-string)
1211 - "format": the format of the new destination, default is to probe if 'mode' is
1212             'existing', else the format of the source
1213             (json-string, optional)
1214 - "sync": what parts of the disk image should be copied to the destination;
1215   possibilities include "full" for all the disk, "top" for only the sectors
1216   allocated in the topmost image, "incremental" for only the dirty sectors in
1217   the bitmap, or "none" to only replicate new I/O (MirrorSyncMode).
1218 - "bitmap": dirty bitmap name for sync==incremental. Must be present if sync
1219             is "incremental", must NOT be present otherwise.
1220 - "mode": whether and how QEMU should create a new image
1221           (NewImageMode, optional, default 'absolute-paths')
1222 - "speed": the maximum speed, in bytes per second (json-int, optional)
1223 - "on-source-error": the action to take on an error on the source, default
1224                      'report'.  'stop' and 'enospc' can only be used
1225                      if the block device supports io-status.
1226                      (BlockdevOnError, optional)
1227 - "on-target-error": the action to take on an error on the target, default
1228                      'report' (no limitations, since this applies to
1229                      a different block device than device).
1230                      (BlockdevOnError, optional)
1231
1232 Example:
1233 -> { "execute": "drive-backup", "arguments": { "device": "drive0",
1234                                                "sync": "full",
1235                                                "target": "backup.img" } }
1236 <- { "return": {} }
1237
1238 EQMP
1239
1240     {
1241         .name       = "blockdev-backup",
1242         .args_type  = "sync:s,device:B,target:B,speed:i?,"
1243                       "on-source-error:s?,on-target-error:s?",
1244         .mhandler.cmd_new = qmp_marshal_blockdev_backup,
1245     },
1246
1247 SQMP
1248 blockdev-backup
1249 ---------------
1250
1251 The device version of drive-backup: this command takes an existing named device
1252 as backup target.
1253
1254 Arguments:
1255
1256 - "device": the name of the device which should be copied.
1257             (json-string)
1258 - "target": the name of the backup target device. (json-string)
1259 - "sync": what parts of the disk image should be copied to the destination;
1260           possibilities include "full" for all the disk, "top" for only the
1261           sectors allocated in the topmost image, or "none" to only replicate
1262           new I/O (MirrorSyncMode).
1263 - "speed": the maximum speed, in bytes per second (json-int, optional)
1264 - "on-source-error": the action to take on an error on the source, default
1265                      'report'.  'stop' and 'enospc' can only be used
1266                      if the block device supports io-status.
1267                      (BlockdevOnError, optional)
1268 - "on-target-error": the action to take on an error on the target, default
1269                      'report' (no limitations, since this applies to
1270                      a different block device than device).
1271                      (BlockdevOnError, optional)
1272
1273 Example:
1274 -> { "execute": "blockdev-backup", "arguments": { "device": "src-id",
1275                                                   "sync": "full",
1276                                                   "target": "tgt-id" } }
1277 <- { "return": {} }
1278
1279 EQMP
1280
1281     {
1282         .name       = "block-job-set-speed",
1283         .args_type  = "device:B,speed:o",
1284         .mhandler.cmd_new = qmp_marshal_block_job_set_speed,
1285     },
1286
1287     {
1288         .name       = "block-job-cancel",
1289         .args_type  = "device:B,force:b?",
1290         .mhandler.cmd_new = qmp_marshal_block_job_cancel,
1291     },
1292     {
1293         .name       = "block-job-pause",
1294         .args_type  = "device:B",
1295         .mhandler.cmd_new = qmp_marshal_block_job_pause,
1296     },
1297     {
1298         .name       = "block-job-resume",
1299         .args_type  = "device:B",
1300         .mhandler.cmd_new = qmp_marshal_block_job_resume,
1301     },
1302     {
1303         .name       = "block-job-complete",
1304         .args_type  = "device:B",
1305         .mhandler.cmd_new = qmp_marshal_block_job_complete,
1306     },
1307     {
1308         .name       = "transaction",
1309         .args_type  = "actions:q,properties:q?",
1310         .mhandler.cmd_new = qmp_marshal_transaction,
1311     },
1312
1313 SQMP
1314 transaction
1315 -----------
1316
1317 Atomically operate on one or more block devices.  Operations that are
1318 currently supported:
1319
1320     - drive-backup
1321     - blockdev-backup
1322     - blockdev-snapshot-sync
1323     - blockdev-snapshot-internal-sync
1324     - abort
1325     - block-dirty-bitmap-add
1326     - block-dirty-bitmap-clear
1327
1328 Refer to the qemu/qapi-schema.json file for minimum required QEMU
1329 versions for these operations.  A list of dictionaries is accepted,
1330 that contains the actions to be performed.  If there is any failure
1331 performing any of the operations, all operations for the group are
1332 abandoned.
1333
1334 For external snapshots, the dictionary contains the device, the file to use for
1335 the new snapshot, and the format.  The default format, if not specified, is
1336 qcow2.
1337
1338 Each new snapshot defaults to being created by QEMU (wiping any
1339 contents if the file already exists), but it is also possible to reuse
1340 an externally-created file.  In the latter case, you should ensure that
1341 the new image file has the same contents as the current one; QEMU cannot
1342 perform any meaningful check.  Typically this is achieved by using the
1343 current image file as the backing file for the new image.
1344
1345 On failure, the original disks pre-snapshot attempt will be used.
1346
1347 For internal snapshots, the dictionary contains the device and the snapshot's
1348 name.  If an internal snapshot matching name already exists, the request will
1349 be rejected.  Only some image formats support it, for example, qcow2, rbd,
1350 and sheepdog.
1351
1352 On failure, qemu will try delete the newly created internal snapshot in the
1353 transaction.  When an I/O error occurs during deletion, the user needs to fix
1354 it later with qemu-img or other command.
1355
1356 Arguments:
1357
1358 actions array:
1359     - "type": the operation to perform (json-string).  Possible
1360               values: "drive-backup", "blockdev-backup",
1361                       "blockdev-snapshot-sync",
1362                       "blockdev-snapshot-internal-sync",
1363                       "abort", "block-dirty-bitmap-add",
1364                       "block-dirty-bitmap-clear"
1365     - "data": a dictionary.  The contents depend on the value
1366       of "type".  When "type" is "blockdev-snapshot-sync":
1367       - "device": device name to snapshot (json-string)
1368       - "node-name": graph node name to snapshot (json-string)
1369       - "snapshot-file": name of new image file (json-string)
1370       - "snapshot-node-name": graph node name of the new snapshot (json-string)
1371       - "format": format of new image (json-string, optional)
1372       - "mode": whether and how QEMU should create the snapshot file
1373         (NewImageMode, optional, default "absolute-paths")
1374       When "type" is "blockdev-snapshot-internal-sync":
1375       - "device": device name to snapshot (json-string)
1376       - "name": name of the new snapshot (json-string)
1377
1378 Example:
1379
1380 -> { "execute": "transaction",
1381      "arguments": { "actions": [
1382          { "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd0",
1383                                          "snapshot-file": "/some/place/my-image",
1384                                          "format": "qcow2" } },
1385          { "type": "blockdev-snapshot-sync", "data" : { "node-name": "myfile",
1386                                          "snapshot-file": "/some/place/my-image2",
1387                                          "snapshot-node-name": "node3432",
1388                                          "mode": "existing",
1389                                          "format": "qcow2" } },
1390          { "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd1",
1391                                          "snapshot-file": "/some/place/my-image2",
1392                                          "mode": "existing",
1393                                          "format": "qcow2" } },
1394          { "type": "blockdev-snapshot-internal-sync", "data" : {
1395                                          "device": "ide-hd2",
1396                                          "name": "snapshot0" } } ] } }
1397 <- { "return": {} }
1398
1399 EQMP
1400
1401     {
1402         .name       = "block-dirty-bitmap-add",
1403         .args_type  = "node:B,name:s,granularity:i?",
1404         .mhandler.cmd_new = qmp_marshal_block_dirty_bitmap_add,
1405     },
1406
1407 SQMP
1408
1409 block-dirty-bitmap-add
1410 ----------------------
1411 Since 2.4
1412
1413 Create a dirty bitmap with a name on the device, and start tracking the writes.
1414
1415 Arguments:
1416
1417 - "node": device/node on which to create dirty bitmap (json-string)
1418 - "name": name of the new dirty bitmap (json-string)
1419 - "granularity": granularity to track writes with (int, optional)
1420
1421 Example:
1422
1423 -> { "execute": "block-dirty-bitmap-add", "arguments": { "node": "drive0",
1424                                                    "name": "bitmap0" } }
1425 <- { "return": {} }
1426
1427 EQMP
1428
1429     {
1430         .name       = "block-dirty-bitmap-remove",
1431         .args_type  = "node:B,name:s",
1432         .mhandler.cmd_new = qmp_marshal_block_dirty_bitmap_remove,
1433     },
1434
1435 SQMP
1436
1437 block-dirty-bitmap-remove
1438 -------------------------
1439 Since 2.4
1440
1441 Stop write tracking and remove the dirty bitmap that was created with
1442 block-dirty-bitmap-add.
1443
1444 Arguments:
1445
1446 - "node": device/node on which to remove dirty bitmap (json-string)
1447 - "name": name of the dirty bitmap to remove (json-string)
1448
1449 Example:
1450
1451 -> { "execute": "block-dirty-bitmap-remove", "arguments": { "node": "drive0",
1452                                                       "name": "bitmap0" } }
1453 <- { "return": {} }
1454
1455 EQMP
1456
1457     {
1458         .name       = "block-dirty-bitmap-clear",
1459         .args_type  = "node:B,name:s",
1460         .mhandler.cmd_new = qmp_marshal_block_dirty_bitmap_clear,
1461     },
1462
1463 SQMP
1464
1465 block-dirty-bitmap-clear
1466 ------------------------
1467 Since 2.4
1468
1469 Reset the dirty bitmap associated with a node so that an incremental backup
1470 from this point in time forward will only backup clusters modified after this
1471 clear operation.
1472
1473 Arguments:
1474
1475 - "node": device/node on which to remove dirty bitmap (json-string)
1476 - "name": name of the dirty bitmap to remove (json-string)
1477
1478 Example:
1479
1480 -> { "execute": "block-dirty-bitmap-clear", "arguments": { "node": "drive0",
1481                                                            "name": "bitmap0" } }
1482 <- { "return": {} }
1483
1484 EQMP
1485
1486     {
1487         .name       = "blockdev-snapshot-sync",
1488         .args_type  = "device:s?,node-name:s?,snapshot-file:s,snapshot-node-name:s?,format:s?,mode:s?",
1489         .mhandler.cmd_new = qmp_marshal_blockdev_snapshot_sync,
1490     },
1491
1492 SQMP
1493 blockdev-snapshot-sync
1494 ----------------------
1495
1496 Synchronous snapshot of a block device. snapshot-file specifies the
1497 target of the new image. If the file exists, or if it is a device, the
1498 snapshot will be created in the existing file/device. If does not
1499 exist, a new file will be created. format specifies the format of the
1500 snapshot image, default is qcow2.
1501
1502 Arguments:
1503
1504 - "device": device name to snapshot (json-string)
1505 - "node-name": graph node name to snapshot (json-string)
1506 - "snapshot-file": name of new image file (json-string)
1507 - "snapshot-node-name": graph node name of the new snapshot (json-string)
1508 - "mode": whether and how QEMU should create the snapshot file
1509   (NewImageMode, optional, default "absolute-paths")
1510 - "format": format of new image (json-string, optional)
1511
1512 Example:
1513
1514 -> { "execute": "blockdev-snapshot-sync", "arguments": { "device": "ide-hd0",
1515                                                          "snapshot-file":
1516                                                         "/some/place/my-image",
1517                                                         "format": "qcow2" } }
1518 <- { "return": {} }
1519
1520 EQMP
1521
1522     {
1523         .name       = "blockdev-snapshot",
1524         .args_type  = "node:s,overlay:s",
1525         .mhandler.cmd_new = qmp_marshal_blockdev_snapshot,
1526     },
1527
1528 SQMP
1529 blockdev-snapshot
1530 -----------------
1531 Since 2.5
1532
1533 Create a snapshot, by installing 'node' as the backing image of
1534 'overlay'. Additionally, if 'node' is associated with a block
1535 device, the block device changes to using 'overlay' as its new active
1536 image.
1537
1538 Arguments:
1539
1540 - "node": device that will have a snapshot created (json-string)
1541 - "overlay": device that will have 'node' as its backing image (json-string)
1542
1543 Example:
1544
1545 -> { "execute": "blockdev-add",
1546                 "arguments": { "options": { "driver": "qcow2",
1547                                             "node-name": "node1534",
1548                                             "file": { "driver": "file",
1549                                                       "filename": "hd1.qcow2" },
1550                                             "backing": "" } } }
1551
1552 <- { "return": {} }
1553
1554 -> { "execute": "blockdev-snapshot", "arguments": { "node": "ide-hd0",
1555                                                     "overlay": "node1534" } }
1556 <- { "return": {} }
1557
1558 EQMP
1559
1560     {
1561         .name       = "blockdev-snapshot-internal-sync",
1562         .args_type  = "device:B,name:s",
1563         .mhandler.cmd_new = qmp_marshal_blockdev_snapshot_internal_sync,
1564     },
1565
1566 SQMP
1567 blockdev-snapshot-internal-sync
1568 -------------------------------
1569
1570 Synchronously take an internal snapshot of a block device when the format of
1571 image used supports it.  If the name is an empty string, or a snapshot with
1572 name already exists, the operation will fail.
1573
1574 Arguments:
1575
1576 - "device": device name to snapshot (json-string)
1577 - "name": name of the new snapshot (json-string)
1578
1579 Example:
1580
1581 -> { "execute": "blockdev-snapshot-internal-sync",
1582                 "arguments": { "device": "ide-hd0",
1583                                "name": "snapshot0" }
1584    }
1585 <- { "return": {} }
1586
1587 EQMP
1588
1589     {
1590         .name       = "blockdev-snapshot-delete-internal-sync",
1591         .args_type  = "device:B,id:s?,name:s?",
1592         .mhandler.cmd_new =
1593                       qmp_marshal_blockdev_snapshot_delete_internal_sync,
1594     },
1595
1596 SQMP
1597 blockdev-snapshot-delete-internal-sync
1598 --------------------------------------
1599
1600 Synchronously delete an internal snapshot of a block device when the format of
1601 image used supports it.  The snapshot is identified by name or id or both.  One
1602 of name or id is required.  If the snapshot is not found, the operation will
1603 fail.
1604
1605 Arguments:
1606
1607 - "device": device name (json-string)
1608 - "id": ID of the snapshot (json-string, optional)
1609 - "name": name of the snapshot (json-string, optional)
1610
1611 Example:
1612
1613 -> { "execute": "blockdev-snapshot-delete-internal-sync",
1614                 "arguments": { "device": "ide-hd0",
1615                                "name": "snapshot0" }
1616    }
1617 <- { "return": {
1618                    "id": "1",
1619                    "name": "snapshot0",
1620                    "vm-state-size": 0,
1621                    "date-sec": 1000012,
1622                    "date-nsec": 10,
1623                    "vm-clock-sec": 100,
1624                    "vm-clock-nsec": 20
1625      }
1626    }
1627
1628 EQMP
1629
1630     {
1631         .name       = "drive-mirror",
1632         .args_type  = "sync:s,device:B,target:s,speed:i?,mode:s?,format:s?,"
1633                       "node-name:s?,replaces:s?,"
1634                       "on-source-error:s?,on-target-error:s?,"
1635                       "unmap:b?,"
1636                       "granularity:i?,buf-size:i?",
1637         .mhandler.cmd_new = qmp_marshal_drive_mirror,
1638     },
1639
1640 SQMP
1641 drive-mirror
1642 ------------
1643
1644 Start mirroring a block device's writes to a new destination. target
1645 specifies the target of the new image. If the file exists, or if it is
1646 a device, it will be used as the new destination for writes. If it does not
1647 exist, a new file will be created. format specifies the format of the
1648 mirror image, default is to probe if mode='existing', else the format
1649 of the source.
1650
1651 Arguments:
1652
1653 - "device": device name to operate on (json-string)
1654 - "target": name of new image file (json-string)
1655 - "format": format of new image (json-string, optional)
1656 - "node-name": the name of the new block driver state in the node graph
1657                (json-string, optional)
1658 - "replaces": the block driver node name to replace when finished
1659               (json-string, optional)
1660 - "mode": how an image file should be created into the target
1661   file/device (NewImageMode, optional, default 'absolute-paths')
1662 - "speed": maximum speed of the streaming job, in bytes per second
1663   (json-int)
1664 - "granularity": granularity of the dirty bitmap, in bytes (json-int, optional)
1665 - "buf-size": maximum amount of data in flight from source to target, in bytes
1666   (json-int, default 10M)
1667 - "sync": what parts of the disk image should be copied to the destination;
1668   possibilities include "full" for all the disk, "top" for only the sectors
1669   allocated in the topmost image, or "none" to only replicate new I/O
1670   (MirrorSyncMode).
1671 - "on-source-error": the action to take on an error on the source
1672   (BlockdevOnError, default 'report')
1673 - "on-target-error": the action to take on an error on the target
1674   (BlockdevOnError, default 'report')
1675 - "unmap": whether the target sectors should be discarded where source has only
1676   zeroes. (json-bool, optional, default true)
1677
1678 The default value of the granularity is the image cluster size clamped
1679 between 4096 and 65536, if the image format defines one.  If the format
1680 does not define a cluster size, the default value of the granularity
1681 is 65536.
1682
1683
1684 Example:
1685
1686 -> { "execute": "drive-mirror", "arguments": { "device": "ide-hd0",
1687                                                "target": "/some/place/my-image",
1688                                                "sync": "full",
1689                                                "format": "qcow2" } }
1690 <- { "return": {} }
1691
1692 EQMP
1693
1694     {
1695         .name       = "blockdev-mirror",
1696         .args_type  = "sync:s,device:B,target:B,replaces:s?,speed:i?,"
1697                       "on-source-error:s?,on-target-error:s?,"
1698                       "granularity:i?,buf-size:i?",
1699         .mhandler.cmd_new = qmp_marshal_blockdev_mirror,
1700     },
1701
1702 SQMP
1703 blockdev-mirror
1704 ------------
1705
1706 Start mirroring a block device's writes to another block device. target
1707 specifies the target of mirror operation.
1708
1709 Arguments:
1710
1711 - "device": device name to operate on (json-string)
1712 - "target": device name to mirror to (json-string)
1713 - "replaces": the block driver node name to replace when finished
1714               (json-string, optional)
1715 - "speed": maximum speed of the streaming job, in bytes per second
1716   (json-int)
1717 - "granularity": granularity of the dirty bitmap, in bytes (json-int, optional)
1718 - "buf_size": maximum amount of data in flight from source to target, in bytes
1719   (json-int, default 10M)
1720 - "sync": what parts of the disk image should be copied to the destination;
1721   possibilities include "full" for all the disk, "top" for only the sectors
1722   allocated in the topmost image, or "none" to only replicate new I/O
1723   (MirrorSyncMode).
1724 - "on-source-error": the action to take on an error on the source
1725   (BlockdevOnError, default 'report')
1726 - "on-target-error": the action to take on an error on the target
1727   (BlockdevOnError, default 'report')
1728
1729 The default value of the granularity is the image cluster size clamped
1730 between 4096 and 65536, if the image format defines one.  If the format
1731 does not define a cluster size, the default value of the granularity
1732 is 65536.
1733
1734 Example:
1735
1736 -> { "execute": "blockdev-mirror", "arguments": { "device": "ide-hd0",
1737                                                   "target": "target0",
1738                                                   "sync": "full" } }
1739 <- { "return": {} }
1740
1741 EQMP
1742     {
1743         .name       = "change-backing-file",
1744         .args_type  = "device:s,image-node-name:s,backing-file:s",
1745         .mhandler.cmd_new = qmp_marshal_change_backing_file,
1746     },
1747
1748 SQMP
1749 change-backing-file
1750 -------------------
1751 Since: 2.1
1752
1753 Change the backing file in the image file metadata.  This does not cause
1754 QEMU to reopen the image file to reparse the backing filename (it may,
1755 however, perform a reopen to change permissions from r/o -> r/w -> r/o,
1756 if needed). The new backing file string is written into the image file
1757 metadata, and the QEMU internal strings are updated.
1758
1759 Arguments:
1760
1761 - "image-node-name":    The name of the block driver state node of the
1762                         image to modify.  The "device" is argument is used to
1763                         verify "image-node-name" is in the chain described by
1764                         "device".
1765                         (json-string, optional)
1766
1767 - "device":             The name of the device.
1768                         (json-string)
1769
1770 - "backing-file":       The string to write as the backing file.  This string is
1771                         not validated, so care should be taken when specifying
1772                         the string or the image chain may not be able to be
1773                         reopened again.
1774                         (json-string)
1775
1776 Returns: Nothing on success
1777          If "device" does not exist or cannot be determined, DeviceNotFound
1778
1779 EQMP
1780
1781     {
1782         .name       = "balloon",
1783         .args_type  = "value:M",
1784         .mhandler.cmd_new = qmp_marshal_balloon,
1785     },
1786
1787 SQMP
1788 balloon
1789 -------
1790
1791 Request VM to change its memory allocation (in bytes).
1792
1793 Arguments:
1794
1795 - "value": New memory allocation (json-int)
1796
1797 Example:
1798
1799 -> { "execute": "balloon", "arguments": { "value": 536870912 } }
1800 <- { "return": {} }
1801
1802 EQMP
1803
1804     {
1805         .name       = "set_link",
1806         .args_type  = "name:s,up:b",
1807         .mhandler.cmd_new = qmp_marshal_set_link,
1808     },
1809
1810 SQMP
1811 set_link
1812 --------
1813
1814 Change the link status of a network adapter.
1815
1816 Arguments:
1817
1818 - "name": network device name (json-string)
1819 - "up": status is up (json-bool)
1820
1821 Example:
1822
1823 -> { "execute": "set_link", "arguments": { "name": "e1000.0", "up": false } }
1824 <- { "return": {} }
1825
1826 EQMP
1827
1828
1829     {
1830         .name       = "get_link",
1831         .args_type  = "name:s",
1832         .mhandler.cmd_new = qmp_marshal_get_link,
1833     },
1834
1835 SQMP
1836 get_link
1837 --------
1838
1839 Get the link status of a network adapter.
1840
1841 Arguments:
1842
1843 - "name": network device name (json-string)
1844
1845 Example:
1846
1847 -> { "execute": "get_link", "arguments": { "name": "e1000.0" } }
1848 <- { "return": {on|off} }
1849
1850 EQMP
1851
1852     {
1853         .name       = "getfd",
1854         .args_type  = "fdname:s",
1855         .params     = "getfd name",
1856         .help       = "receive a file descriptor via SCM rights and assign it a name",
1857         .mhandler.cmd_new = qmp_marshal_getfd,
1858     },
1859
1860 SQMP
1861 getfd
1862 -----
1863
1864 Receive a file descriptor via SCM rights and assign it a name.
1865
1866 Arguments:
1867
1868 - "fdname": file descriptor name (json-string)
1869
1870 Example:
1871
1872 -> { "execute": "getfd", "arguments": { "fdname": "fd1" } }
1873 <- { "return": {} }
1874
1875 Notes:
1876
1877 (1) If the name specified by the "fdname" argument already exists,
1878     the file descriptor assigned to it will be closed and replaced
1879     by the received file descriptor.
1880 (2) The 'closefd' command can be used to explicitly close the file
1881     descriptor when it is no longer needed.
1882
1883 EQMP
1884
1885     {
1886         .name       = "closefd",
1887         .args_type  = "fdname:s",
1888         .params     = "closefd name",
1889         .help       = "close a file descriptor previously passed via SCM rights",
1890         .mhandler.cmd_new = qmp_marshal_closefd,
1891     },
1892
1893 SQMP
1894 closefd
1895 -------
1896
1897 Close a file descriptor previously passed via SCM rights.
1898
1899 Arguments:
1900
1901 - "fdname": file descriptor name (json-string)
1902
1903 Example:
1904
1905 -> { "execute": "closefd", "arguments": { "fdname": "fd1" } }
1906 <- { "return": {} }
1907
1908 EQMP
1909
1910      {
1911         .name       = "add-fd",
1912         .args_type  = "fdset-id:i?,opaque:s?",
1913         .params     = "add-fd fdset-id opaque",
1914         .help       = "Add a file descriptor, that was passed via SCM rights, to an fd set",
1915         .mhandler.cmd_new = qmp_marshal_add_fd,
1916     },
1917
1918 SQMP
1919 add-fd
1920 -------
1921
1922 Add a file descriptor, that was passed via SCM rights, to an fd set.
1923
1924 Arguments:
1925
1926 - "fdset-id": The ID of the fd set to add the file descriptor to.
1927               (json-int, optional)
1928 - "opaque": A free-form string that can be used to describe the fd.
1929             (json-string, optional)
1930
1931 Return a json-object with the following information:
1932
1933 - "fdset-id": The ID of the fd set that the fd was added to. (json-int)
1934 - "fd": The file descriptor that was received via SCM rights and added to the
1935         fd set. (json-int)
1936
1937 Example:
1938
1939 -> { "execute": "add-fd", "arguments": { "fdset-id": 1 } }
1940 <- { "return": { "fdset-id": 1, "fd": 3 } }
1941
1942 Notes:
1943
1944 (1) The list of fd sets is shared by all monitor connections.
1945 (2) If "fdset-id" is not specified, a new fd set will be created.
1946
1947 EQMP
1948
1949      {
1950         .name       = "remove-fd",
1951         .args_type  = "fdset-id:i,fd:i?",
1952         .params     = "remove-fd fdset-id fd",
1953         .help       = "Remove a file descriptor from an fd set",
1954         .mhandler.cmd_new = qmp_marshal_remove_fd,
1955     },
1956
1957 SQMP
1958 remove-fd
1959 ---------
1960
1961 Remove a file descriptor from an fd set.
1962
1963 Arguments:
1964
1965 - "fdset-id": The ID of the fd set that the file descriptor belongs to.
1966               (json-int)
1967 - "fd": The file descriptor that is to be removed. (json-int, optional)
1968
1969 Example:
1970
1971 -> { "execute": "remove-fd", "arguments": { "fdset-id": 1, "fd": 3 } }
1972 <- { "return": {} }
1973
1974 Notes:
1975
1976 (1) The list of fd sets is shared by all monitor connections.
1977 (2) If "fd" is not specified, all file descriptors in "fdset-id" will be
1978     removed.
1979
1980 EQMP
1981
1982     {
1983         .name       = "query-fdsets",
1984         .args_type  = "",
1985         .help       = "Return information describing all fd sets",
1986         .mhandler.cmd_new = qmp_marshal_query_fdsets,
1987     },
1988
1989 SQMP
1990 query-fdsets
1991 -------------
1992
1993 Return information describing all fd sets.
1994
1995 Arguments: None
1996
1997 Example:
1998
1999 -> { "execute": "query-fdsets" }
2000 <- { "return": [
2001        {
2002          "fds": [
2003            {
2004              "fd": 30,
2005              "opaque": "rdonly:/path/to/file"
2006            },
2007            {
2008              "fd": 24,
2009              "opaque": "rdwr:/path/to/file"
2010            }
2011          ],
2012          "fdset-id": 1
2013        },
2014        {
2015          "fds": [
2016            {
2017              "fd": 28
2018            },
2019            {
2020              "fd": 29
2021            }
2022          ],
2023          "fdset-id": 0
2024        }
2025      ]
2026    }
2027
2028 Note: The list of fd sets is shared by all monitor connections.
2029
2030 EQMP
2031
2032     {
2033         .name       = "block_passwd",
2034         .args_type  = "device:s?,node-name:s?,password:s",
2035         .mhandler.cmd_new = qmp_marshal_block_passwd,
2036     },
2037
2038 SQMP
2039 block_passwd
2040 ------------
2041
2042 Set the password of encrypted block devices.
2043
2044 Arguments:
2045
2046 - "device": device name (json-string)
2047 - "node-name": name in the block driver state graph (json-string)
2048 - "password": password (json-string)
2049
2050 Example:
2051
2052 -> { "execute": "block_passwd", "arguments": { "device": "ide0-hd0",
2053                                                "password": "12345" } }
2054 <- { "return": {} }
2055
2056 EQMP
2057
2058     {
2059         .name       = "block_set_io_throttle",
2060         .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?,bps_max_length:l?,bps_rd_max_length:l?,bps_wr_max_length:l?,iops_max_length:l?,iops_rd_max_length:l?,iops_wr_max_length:l?,iops_size:l?,group:s?",
2061         .mhandler.cmd_new = qmp_marshal_block_set_io_throttle,
2062     },
2063
2064 SQMP
2065 block_set_io_throttle
2066 ------------
2067
2068 Change I/O throttle limits for a block drive.
2069
2070 Arguments:
2071
2072 - "device": device name (json-string)
2073 - "bps": total throughput limit in bytes per second (json-int)
2074 - "bps_rd": read throughput limit in bytes per second (json-int)
2075 - "bps_wr": write throughput limit in bytes per second (json-int)
2076 - "iops": total I/O operations per second (json-int)
2077 - "iops_rd": read I/O operations per second (json-int)
2078 - "iops_wr": write I/O operations per second (json-int)
2079 - "bps_max": total throughput limit during bursts, in bytes (json-int, optional)
2080 - "bps_rd_max": read throughput limit during bursts, in bytes (json-int, optional)
2081 - "bps_wr_max": write throughput limit during bursts, in bytes (json-int, optional)
2082 - "iops_max": total I/O operations per second during bursts (json-int, optional)
2083 - "iops_rd_max": read I/O operations per second during bursts (json-int, optional)
2084 - "iops_wr_max": write I/O operations per second during bursts (json-int, optional)
2085 - "bps_max_length": maximum length of the @bps_max burst period, in seconds (json-int, optional)
2086 - "bps_rd_max_length": maximum length of the @bps_rd_max burst period, in seconds (json-int, optional)
2087 - "bps_wr_max_length": maximum length of the @bps_wr_max burst period, in seconds (json-int, optional)
2088 - "iops_max_length": maximum length of the @iops_max burst period, in seconds (json-int, optional)
2089 - "iops_rd_max_length": maximum length of the @iops_rd_max burst period, in seconds (json-int, optional)
2090 - "iops_wr_max_length": maximum length of the @iops_wr_max burst period, in seconds (json-int, optional)
2091 - "iops_size":  I/O size in bytes when limiting (json-int, optional)
2092 - "group": throttle group name (json-string, optional)
2093
2094 Example:
2095
2096 -> { "execute": "block_set_io_throttle", "arguments": { "device": "virtio0",
2097                                                "bps": 1000000,
2098                                                "bps_rd": 0,
2099                                                "bps_wr": 0,
2100                                                "iops": 0,
2101                                                "iops_rd": 0,
2102                                                "iops_wr": 0,
2103                                                "bps_max": 8000000,
2104                                                "bps_rd_max": 0,
2105                                                "bps_wr_max": 0,
2106                                                "iops_max": 0,
2107                                                "iops_rd_max": 0,
2108                                                "iops_wr_max": 0,
2109                                                "bps_max_length": 60,
2110                                                "iops_size": 0 } }
2111 <- { "return": {} }
2112
2113 EQMP
2114
2115     {
2116         .name       = "set_password",
2117         .args_type  = "protocol:s,password:s,connected:s?",
2118         .mhandler.cmd_new = qmp_marshal_set_password,
2119     },
2120
2121 SQMP
2122 set_password
2123 ------------
2124
2125 Set the password for vnc/spice protocols.
2126
2127 Arguments:
2128
2129 - "protocol": protocol name (json-string)
2130 - "password": password (json-string)
2131 - "connected": [ keep | disconnect | fail ] (json-string, optional)
2132
2133 Example:
2134
2135 -> { "execute": "set_password", "arguments": { "protocol": "vnc",
2136                                                "password": "secret" } }
2137 <- { "return": {} }
2138
2139 EQMP
2140
2141     {
2142         .name       = "expire_password",
2143         .args_type  = "protocol:s,time:s",
2144         .mhandler.cmd_new = qmp_marshal_expire_password,
2145     },
2146
2147 SQMP
2148 expire_password
2149 ---------------
2150
2151 Set the password expire time for vnc/spice protocols.
2152
2153 Arguments:
2154
2155 - "protocol": protocol name (json-string)
2156 - "time": [ now | never | +secs | secs ] (json-string)
2157
2158 Example:
2159
2160 -> { "execute": "expire_password", "arguments": { "protocol": "vnc",
2161                                                   "time": "+60" } }
2162 <- { "return": {} }
2163
2164 EQMP
2165
2166     {
2167         .name       = "add_client",
2168         .args_type  = "protocol:s,fdname:s,skipauth:b?,tls:b?",
2169         .mhandler.cmd_new = qmp_marshal_add_client,
2170     },
2171
2172 SQMP
2173 add_client
2174 ----------
2175
2176 Add a graphics client
2177
2178 Arguments:
2179
2180 - "protocol": protocol name (json-string)
2181 - "fdname": file descriptor name (json-string)
2182 - "skipauth": whether to skip authentication (json-bool, optional)
2183 - "tls": whether to perform TLS (json-bool, optional)
2184
2185 Example:
2186
2187 -> { "execute": "add_client", "arguments": { "protocol": "vnc",
2188                                              "fdname": "myclient" } }
2189 <- { "return": {} }
2190
2191 EQMP
2192     {
2193         .name       = "qmp_capabilities",
2194         .args_type  = "",
2195         .params     = "",
2196         .help       = "enable QMP capabilities",
2197         .mhandler.cmd_new = qmp_capabilities,
2198     },
2199
2200 SQMP
2201 qmp_capabilities
2202 ----------------
2203
2204 Enable QMP capabilities.
2205
2206 Arguments: None.
2207
2208 Example:
2209
2210 -> { "execute": "qmp_capabilities" }
2211 <- { "return": {} }
2212
2213 Note: This command must be issued before issuing any other command.
2214
2215 EQMP
2216
2217     {
2218         .name       = "human-monitor-command",
2219         .args_type  = "command-line:s,cpu-index:i?",
2220         .mhandler.cmd_new = qmp_marshal_human_monitor_command,
2221     },
2222
2223 SQMP
2224 human-monitor-command
2225 ---------------------
2226
2227 Execute a Human Monitor command.
2228
2229 Arguments:
2230
2231 - command-line: the command name and its arguments, just like the
2232                 Human Monitor's shell (json-string)
2233 - cpu-index: select the CPU number to be used by commands which access CPU
2234              data, like 'info registers'. The Monitor selects CPU 0 if this
2235              argument is not provided (json-int, optional)
2236
2237 Example:
2238
2239 -> { "execute": "human-monitor-command", "arguments": { "command-line": "info kvm" } }
2240 <- { "return": "kvm support: enabled\r\n" }
2241
2242 Notes:
2243
2244 (1) The Human Monitor is NOT an stable interface, this means that command
2245     names, arguments and responses can change or be removed at ANY time.
2246     Applications that rely on long term stability guarantees should NOT
2247     use this command
2248
2249 (2) Limitations:
2250
2251     o This command is stateless, this means that commands that depend
2252       on state information (such as getfd) might not work
2253
2254     o Commands that prompt the user for data (eg. 'cont' when the block
2255       device is encrypted) don't currently work
2256
2257 3. Query Commands
2258 =================
2259
2260 HXCOMM Each query command below is inside a SQMP/EQMP section, do NOT change
2261 HXCOMM this! We will possibly move query commands definitions inside those
2262 HXCOMM sections, just like regular commands.
2263
2264 EQMP
2265
2266 SQMP
2267 query-version
2268 -------------
2269
2270 Show QEMU version.
2271
2272 Return a json-object with the following information:
2273
2274 - "qemu": A json-object containing three integer values:
2275     - "major": QEMU's major version (json-int)
2276     - "minor": QEMU's minor version (json-int)
2277     - "micro": QEMU's micro version (json-int)
2278 - "package": package's version (json-string)
2279
2280 Example:
2281
2282 -> { "execute": "query-version" }
2283 <- {
2284       "return":{
2285          "qemu":{
2286             "major":0,
2287             "minor":11,
2288             "micro":5
2289          },
2290          "package":""
2291       }
2292    }
2293
2294 EQMP
2295
2296     {
2297         .name       = "query-version",
2298         .args_type  = "",
2299         .mhandler.cmd_new = qmp_marshal_query_version,
2300     },
2301
2302 SQMP
2303 query-commands
2304 --------------
2305
2306 List QMP available commands.
2307
2308 Each command is represented by a json-object, the returned value is a json-array
2309 of all commands.
2310
2311 Each json-object contain:
2312
2313 - "name": command's name (json-string)
2314
2315 Example:
2316
2317 -> { "execute": "query-commands" }
2318 <- {
2319       "return":[
2320          {
2321             "name":"query-balloon"
2322          },
2323          {
2324             "name":"system_powerdown"
2325          }
2326       ]
2327    }
2328
2329 Note: This example has been shortened as the real response is too long.
2330
2331 EQMP
2332
2333     {
2334         .name       = "query-commands",
2335         .args_type  = "",
2336         .mhandler.cmd_new = qmp_marshal_query_commands,
2337     },
2338
2339 SQMP
2340 query-events
2341 --------------
2342
2343 List QMP available events.
2344
2345 Each event is represented by a json-object, the returned value is a json-array
2346 of all events.
2347
2348 Each json-object contains:
2349
2350 - "name": event's name (json-string)
2351
2352 Example:
2353
2354 -> { "execute": "query-events" }
2355 <- {
2356       "return":[
2357          {
2358             "name":"SHUTDOWN"
2359          },
2360          {
2361             "name":"RESET"
2362          }
2363       ]
2364    }
2365
2366 Note: This example has been shortened as the real response is too long.
2367
2368 EQMP
2369
2370     {
2371         .name       = "query-events",
2372         .args_type  = "",
2373         .mhandler.cmd_new = qmp_marshal_query_events,
2374     },
2375
2376 SQMP
2377 query-qmp-schema
2378 ----------------
2379
2380 Return the QMP wire schema.  The returned value is a json-array of
2381 named schema entities.  Entities are commands, events and various
2382 types.  See docs/qapi-code-gen.txt for information on their structure
2383 and intended use.
2384
2385 EQMP
2386
2387     {
2388         .name       = "query-qmp-schema",
2389         .args_type  = "",
2390         .mhandler.cmd_new = qmp_query_qmp_schema,
2391     },
2392
2393 SQMP
2394 query-chardev
2395 -------------
2396
2397 Each device is represented by a json-object. The returned value is a json-array
2398 of all devices.
2399
2400 Each json-object contain the following:
2401
2402 - "label": device's label (json-string)
2403 - "filename": device's file (json-string)
2404 - "frontend-open": open/closed state of the frontend device attached to this
2405                    backend (json-bool)
2406
2407 Example:
2408
2409 -> { "execute": "query-chardev" }
2410 <- {
2411       "return": [
2412          {
2413             "label": "charchannel0",
2414             "filename": "unix:/var/lib/libvirt/qemu/seabios.rhel6.agent,server",
2415             "frontend-open": false
2416          },
2417          {
2418             "label": "charmonitor",
2419             "filename": "unix:/var/lib/libvirt/qemu/seabios.rhel6.monitor,server",
2420             "frontend-open": true
2421          },
2422          {
2423             "label": "charserial0",
2424             "filename": "pty:/dev/pts/2",
2425             "frontend-open": true
2426          }
2427       ]
2428    }
2429
2430 EQMP
2431
2432     {
2433         .name       = "query-chardev",
2434         .args_type  = "",
2435         .mhandler.cmd_new = qmp_marshal_query_chardev,
2436     },
2437
2438 SQMP
2439 query-chardev-backends
2440 -------------
2441
2442 List available character device backends.
2443
2444 Each backend is represented by a json-object, the returned value is a json-array
2445 of all backends.
2446
2447 Each json-object contains:
2448
2449 - "name": backend name (json-string)
2450
2451 Example:
2452
2453 -> { "execute": "query-chardev-backends" }
2454 <- {
2455       "return":[
2456          {
2457             "name":"udp"
2458          },
2459          {
2460             "name":"tcp"
2461          },
2462          {
2463             "name":"unix"
2464          },
2465          {
2466             "name":"spiceport"
2467          }
2468       ]
2469    }
2470
2471 EQMP
2472
2473     {
2474         .name       = "query-chardev-backends",
2475         .args_type  = "",
2476         .mhandler.cmd_new = qmp_marshal_query_chardev_backends,
2477     },
2478
2479 SQMP
2480 query-block
2481 -----------
2482
2483 Show the block devices.
2484
2485 Each block device information is stored in a json-object and the returned value
2486 is a json-array of all devices.
2487
2488 Each json-object contain the following:
2489
2490 - "device": device name (json-string)
2491 - "type": device type (json-string)
2492          - deprecated, retained for backward compatibility
2493          - Possible values: "unknown"
2494 - "removable": true if the device is removable, false otherwise (json-bool)
2495 - "locked": true if the device is locked, false otherwise (json-bool)
2496 - "tray_open": only present if removable, true if the device has a tray,
2497                and it is open (json-bool)
2498 - "inserted": only present if the device is inserted, it is a json-object
2499    containing the following:
2500          - "file": device file name (json-string)
2501          - "ro": true if read-only, false otherwise (json-bool)
2502          - "drv": driver format name (json-string)
2503              - Possible values: "blkdebug", "bochs", "cloop", "dmg",
2504                                 "file", "file", "ftp", "ftps", "host_cdrom",
2505                                 "host_device", "http", "https",
2506                                 "nbd", "parallels", "qcow", "qcow2", "raw",
2507                                 "tftp", "vdi", "vmdk", "vpc", "vvfat"
2508          - "backing_file": backing file name (json-string, optional)
2509          - "backing_file_depth": number of files in the backing file chain (json-int)
2510          - "encrypted": true if encrypted, false otherwise (json-bool)
2511          - "bps": limit total bytes per second (json-int)
2512          - "bps_rd": limit read bytes per second (json-int)
2513          - "bps_wr": limit write bytes per second (json-int)
2514          - "iops": limit total I/O operations per second (json-int)
2515          - "iops_rd": limit read operations per second (json-int)
2516          - "iops_wr": limit write operations per second (json-int)
2517          - "bps_max":  total max in bytes (json-int)
2518          - "bps_rd_max":  read max in bytes (json-int)
2519          - "bps_wr_max":  write max in bytes (json-int)
2520          - "iops_max":  total I/O operations max (json-int)
2521          - "iops_rd_max":  read I/O operations max (json-int)
2522          - "iops_wr_max":  write I/O operations max (json-int)
2523          - "iops_size": I/O size when limiting by iops (json-int)
2524          - "detect_zeroes": detect and optimize zero writing (json-string)
2525              - Possible values: "off", "on", "unmap"
2526          - "write_threshold": write offset threshold in bytes, a event will be
2527                               emitted if crossed. Zero if disabled (json-int)
2528          - "image": the detail of the image, it is a json-object containing
2529             the following:
2530              - "filename": image file name (json-string)
2531              - "format": image format (json-string)
2532              - "virtual-size": image capacity in bytes (json-int)
2533              - "dirty-flag": true if image is not cleanly closed, not present
2534                              means clean (json-bool, optional)
2535              - "actual-size": actual size on disk in bytes of the image, not
2536                               present when image does not support thin
2537                               provision (json-int, optional)
2538              - "cluster-size": size of a cluster in bytes, not present if image
2539                                format does not support it (json-int, optional)
2540              - "encrypted": true if the image is encrypted, not present means
2541                             false or the image format does not support
2542                             encryption (json-bool, optional)
2543              - "backing_file": backing file name, not present means no backing
2544                                file is used or the image format does not
2545                                support backing file chain
2546                                (json-string, optional)
2547              - "full-backing-filename": full path of the backing file, not
2548                                         present if it equals backing_file or no
2549                                         backing file is used
2550                                         (json-string, optional)
2551              - "backing-filename-format": the format of the backing file, not
2552                                           present means unknown or no backing
2553                                           file (json-string, optional)
2554              - "snapshots": the internal snapshot info, it is an optional list
2555                 of json-object containing the following:
2556                  - "id": unique snapshot id (json-string)
2557                  - "name": snapshot name (json-string)
2558                  - "vm-state-size": size of the VM state in bytes (json-int)
2559                  - "date-sec": UTC date of the snapshot in seconds (json-int)
2560                  - "date-nsec": fractional part in nanoseconds to be used with
2561                                 date-sec (json-int)
2562                  - "vm-clock-sec": VM clock relative to boot in seconds
2563                                    (json-int)
2564                  - "vm-clock-nsec": fractional part in nanoseconds to be used
2565                                     with vm-clock-sec (json-int)
2566              - "backing-image": the detail of the backing image, it is an
2567                                 optional json-object only present when a
2568                                 backing image present for this image
2569
2570 - "io-status": I/O operation status, only present if the device supports it
2571                and the VM is configured to stop on errors. It's always reset
2572                to "ok" when the "cont" command is issued (json_string, optional)
2573              - Possible values: "ok", "failed", "nospace"
2574
2575 Example:
2576
2577 -> { "execute": "query-block" }
2578 <- {
2579       "return":[
2580          {
2581             "io-status": "ok",
2582             "device":"ide0-hd0",
2583             "locked":false,
2584             "removable":false,
2585             "inserted":{
2586                "ro":false,
2587                "drv":"qcow2",
2588                "encrypted":false,
2589                "file":"disks/test.qcow2",
2590                "backing_file_depth":1,
2591                "bps":1000000,
2592                "bps_rd":0,
2593                "bps_wr":0,
2594                "iops":1000000,
2595                "iops_rd":0,
2596                "iops_wr":0,
2597                "bps_max": 8000000,
2598                "bps_rd_max": 0,
2599                "bps_wr_max": 0,
2600                "iops_max": 0,
2601                "iops_rd_max": 0,
2602                "iops_wr_max": 0,
2603                "iops_size": 0,
2604                "detect_zeroes": "on",
2605                "write_threshold": 0,
2606                "image":{
2607                   "filename":"disks/test.qcow2",
2608                   "format":"qcow2",
2609                   "virtual-size":2048000,
2610                   "backing_file":"base.qcow2",
2611                   "full-backing-filename":"disks/base.qcow2",
2612                   "backing-filename-format":"qcow2",
2613                   "snapshots":[
2614                      {
2615                         "id": "1",
2616                         "name": "snapshot1",
2617                         "vm-state-size": 0,
2618                         "date-sec": 10000200,
2619                         "date-nsec": 12,
2620                         "vm-clock-sec": 206,
2621                         "vm-clock-nsec": 30
2622                      }
2623                   ],
2624                   "backing-image":{
2625                       "filename":"disks/base.qcow2",
2626                       "format":"qcow2",
2627                       "virtual-size":2048000
2628                   }
2629                }
2630             },
2631             "type":"unknown"
2632          },
2633          {
2634             "io-status": "ok",
2635             "device":"ide1-cd0",
2636             "locked":false,
2637             "removable":true,
2638             "type":"unknown"
2639          },
2640          {
2641             "device":"floppy0",
2642             "locked":false,
2643             "removable":true,
2644             "type":"unknown"
2645          },
2646          {
2647             "device":"sd0",
2648             "locked":false,
2649             "removable":true,
2650             "type":"unknown"
2651          }
2652       ]
2653    }
2654
2655 EQMP
2656
2657     {
2658         .name       = "query-block",
2659         .args_type  = "",
2660         .mhandler.cmd_new = qmp_marshal_query_block,
2661     },
2662
2663 SQMP
2664 query-blockstats
2665 ----------------
2666
2667 Show block device statistics.
2668
2669 Each device statistic information is stored in a json-object and the returned
2670 value is a json-array of all devices.
2671
2672 Each json-object contain the following:
2673
2674 - "device": device name (json-string)
2675 - "stats": A json-object with the statistics information, it contains:
2676     - "rd_bytes": bytes read (json-int)
2677     - "wr_bytes": bytes written (json-int)
2678     - "rd_operations": read operations (json-int)
2679     - "wr_operations": write operations (json-int)
2680     - "flush_operations": cache flush operations (json-int)
2681     - "wr_total_time_ns": total time spend on writes in nano-seconds (json-int)
2682     - "rd_total_time_ns": total time spend on reads in nano-seconds (json-int)
2683     - "flush_total_time_ns": total time spend on cache flushes in nano-seconds (json-int)
2684     - "wr_highest_offset": The offset after the greatest byte written to the
2685                            BlockDriverState since it has been opened (json-int)
2686     - "rd_merged": number of read requests that have been merged into
2687                    another request (json-int)
2688     - "wr_merged": number of write requests that have been merged into
2689                    another request (json-int)
2690     - "idle_time_ns": time since the last I/O operation, in
2691                       nanoseconds. If the field is absent it means
2692                       that there haven't been any operations yet
2693                       (json-int, optional)
2694     - "failed_rd_operations": number of failed read operations
2695                               (json-int)
2696     - "failed_wr_operations": number of failed write operations
2697                               (json-int)
2698     - "failed_flush_operations": number of failed flush operations
2699                                (json-int)
2700     - "invalid_rd_operations": number of invalid read operations
2701                                (json-int)
2702     - "invalid_wr_operations": number of invalid write operations
2703                                (json-int)
2704     - "invalid_flush_operations": number of invalid flush operations
2705                                   (json-int)
2706     - "account_invalid": whether invalid operations are included in
2707                          the last access statistics (json-bool)
2708     - "account_failed": whether failed operations are included in the
2709                          latency and last access statistics
2710                          (json-bool)
2711     - "timed_stats": A json-array containing statistics collected in
2712                      specific intervals, with the following members:
2713         - "interval_length": interval used for calculating the
2714                              statistics, in seconds (json-int)
2715         - "min_rd_latency_ns": minimum latency of read operations in
2716                                the defined interval, in nanoseconds
2717                                (json-int)
2718         - "min_wr_latency_ns": minimum latency of write operations in
2719                                the defined interval, in nanoseconds
2720                                (json-int)
2721         - "min_flush_latency_ns": minimum latency of flush operations
2722                                   in the defined interval, in
2723                                   nanoseconds (json-int)
2724         - "max_rd_latency_ns": maximum latency of read operations in
2725                                the defined interval, in nanoseconds
2726                                (json-int)
2727         - "max_wr_latency_ns": maximum latency of write operations in
2728                                the defined interval, in nanoseconds
2729                                (json-int)
2730         - "max_flush_latency_ns": maximum latency of flush operations
2731                                   in the defined interval, in
2732                                   nanoseconds (json-int)
2733         - "avg_rd_latency_ns": average latency of read operations in
2734                                the defined interval, in nanoseconds
2735                                (json-int)
2736         - "avg_wr_latency_ns": average latency of write operations in
2737                                the defined interval, in nanoseconds
2738                                (json-int)
2739         - "avg_flush_latency_ns": average latency of flush operations
2740                                   in the defined interval, in
2741                                   nanoseconds (json-int)
2742         - "avg_rd_queue_depth": average number of pending read
2743                                 operations in the defined interval
2744                                 (json-number)
2745         - "avg_wr_queue_depth": average number of pending write
2746                                 operations in the defined interval
2747                                 (json-number).
2748 - "parent": Contains recursively the statistics of the underlying
2749             protocol (e.g. the host file for a qcow2 image). If there is
2750             no underlying protocol, this field is omitted
2751             (json-object, optional)
2752
2753 Example:
2754
2755 -> { "execute": "query-blockstats" }
2756 <- {
2757       "return":[
2758          {
2759             "device":"ide0-hd0",
2760             "parent":{
2761                "stats":{
2762                   "wr_highest_offset":3686448128,
2763                   "wr_bytes":9786368,
2764                   "wr_operations":751,
2765                   "rd_bytes":122567168,
2766                   "rd_operations":36772
2767                   "wr_total_times_ns":313253456
2768                   "rd_total_times_ns":3465673657
2769                   "flush_total_times_ns":49653
2770                   "flush_operations":61,
2771                   "rd_merged":0,
2772                   "wr_merged":0,
2773                   "idle_time_ns":2953431879,
2774                   "account_invalid":true,
2775                   "account_failed":false
2776                }
2777             },
2778             "stats":{
2779                "wr_highest_offset":2821110784,
2780                "wr_bytes":9786368,
2781                "wr_operations":692,
2782                "rd_bytes":122739200,
2783                "rd_operations":36604
2784                "flush_operations":51,
2785                "wr_total_times_ns":313253456
2786                "rd_total_times_ns":3465673657
2787                "flush_total_times_ns":49653,
2788                "rd_merged":0,
2789                "wr_merged":0,
2790                "idle_time_ns":2953431879,
2791                "account_invalid":true,
2792                "account_failed":false
2793             }
2794          },
2795          {
2796             "device":"ide1-cd0",
2797             "stats":{
2798                "wr_highest_offset":0,
2799                "wr_bytes":0,
2800                "wr_operations":0,
2801                "rd_bytes":0,
2802                "rd_operations":0
2803                "flush_operations":0,
2804                "wr_total_times_ns":0
2805                "rd_total_times_ns":0
2806                "flush_total_times_ns":0,
2807                "rd_merged":0,
2808                "wr_merged":0,
2809                "account_invalid":false,
2810                "account_failed":false
2811             }
2812          },
2813          {
2814             "device":"floppy0",
2815             "stats":{
2816                "wr_highest_offset":0,
2817                "wr_bytes":0,
2818                "wr_operations":0,
2819                "rd_bytes":0,
2820                "rd_operations":0
2821                "flush_operations":0,
2822                "wr_total_times_ns":0
2823                "rd_total_times_ns":0
2824                "flush_total_times_ns":0,
2825                "rd_merged":0,
2826                "wr_merged":0,
2827                "account_invalid":false,
2828                "account_failed":false
2829             }
2830          },
2831          {
2832             "device":"sd0",
2833             "stats":{
2834                "wr_highest_offset":0,
2835                "wr_bytes":0,
2836                "wr_operations":0,
2837                "rd_bytes":0,
2838                "rd_operations":0
2839                "flush_operations":0,
2840                "wr_total_times_ns":0
2841                "rd_total_times_ns":0
2842                "flush_total_times_ns":0,
2843                "rd_merged":0,
2844                "wr_merged":0,
2845                "account_invalid":false,
2846                "account_failed":false
2847             }
2848          }
2849       ]
2850    }
2851
2852 EQMP
2853
2854     {
2855         .name       = "query-blockstats",
2856         .args_type  = "query-nodes:b?",
2857         .mhandler.cmd_new = qmp_marshal_query_blockstats,
2858     },
2859
2860 SQMP
2861 query-cpus
2862 ----------
2863
2864 Show CPU information.
2865
2866 Return a json-array. Each CPU is represented by a json-object, which contains:
2867
2868 - "CPU": CPU index (json-int)
2869 - "current": true if this is the current CPU, false otherwise (json-bool)
2870 - "halted": true if the cpu is halted, false otherwise (json-bool)
2871 - "qom_path": path to the CPU object in the QOM tree (json-str)
2872 - "arch": architecture of the cpu, which determines what additional
2873           keys will be present (json-str)
2874 - Current program counter. The key's name depends on the architecture:
2875      "pc": i386/x86_64 (json-int)
2876      "nip": PPC (json-int)
2877      "pc" and "npc": sparc (json-int)
2878      "PC": mips (json-int)
2879 - "thread_id": ID of the underlying host thread (json-int)
2880
2881 Example:
2882
2883 -> { "execute": "query-cpus" }
2884 <- {
2885       "return":[
2886          {
2887             "CPU":0,
2888             "current":true,
2889             "halted":false,
2890             "qom_path":"/machine/unattached/device[0]",
2891             "arch":"x86",
2892             "pc":3227107138,
2893             "thread_id":3134
2894          },
2895          {
2896             "CPU":1,
2897             "current":false,
2898             "halted":true,
2899             "qom_path":"/machine/unattached/device[2]",
2900             "arch":"x86",
2901             "pc":7108165,
2902             "thread_id":3135
2903          }
2904       ]
2905    }
2906
2907 EQMP
2908
2909     {
2910         .name       = "query-cpus",
2911         .args_type  = "",
2912         .mhandler.cmd_new = qmp_marshal_query_cpus,
2913     },
2914
2915 SQMP
2916 query-iothreads
2917 ---------------
2918
2919 Returns a list of information about each iothread.
2920
2921 Note this list excludes the QEMU main loop thread, which is not declared
2922 using the -object iothread command-line option.  It is always the main thread
2923 of the process.
2924
2925 Return a json-array. Each iothread is represented by a json-object, which contains:
2926
2927 - "id": name of iothread (json-str)
2928 - "thread-id": ID of the underlying host thread (json-int)
2929
2930 Example:
2931
2932 -> { "execute": "query-iothreads" }
2933 <- {
2934       "return":[
2935          {
2936             "id":"iothread0",
2937             "thread-id":3134
2938          },
2939          {
2940             "id":"iothread1",
2941             "thread-id":3135
2942          }
2943       ]
2944    }
2945
2946 EQMP
2947
2948     {
2949         .name       = "query-iothreads",
2950         .args_type  = "",
2951         .mhandler.cmd_new = qmp_marshal_query_iothreads,
2952     },
2953
2954 SQMP
2955 query-pci
2956 ---------
2957
2958 PCI buses and devices information.
2959
2960 The returned value is a json-array of all buses. Each bus is represented by
2961 a json-object, which has a key with a json-array of all PCI devices attached
2962 to it. Each device is represented by a json-object.
2963
2964 The bus json-object contains the following:
2965
2966 - "bus": bus number (json-int)
2967 - "devices": a json-array of json-objects, each json-object represents a
2968              PCI device
2969
2970 The PCI device json-object contains the following:
2971
2972 - "bus": identical to the parent's bus number (json-int)
2973 - "slot": slot number (json-int)
2974 - "function": function number (json-int)
2975 - "class_info": a json-object containing:
2976      - "desc": device class description (json-string, optional)
2977      - "class": device class number (json-int)
2978 - "id": a json-object containing:
2979      - "device": device ID (json-int)
2980      - "vendor": vendor ID (json-int)
2981 - "irq": device's IRQ if assigned (json-int, optional)
2982 - "qdev_id": qdev id string (json-string)
2983 - "pci_bridge": It's a json-object, only present if this device is a
2984                 PCI bridge, contains:
2985      - "bus": bus number (json-int)
2986      - "secondary": secondary bus number (json-int)
2987      - "subordinate": subordinate bus number (json-int)
2988      - "io_range": I/O memory range information, a json-object with the
2989                    following members:
2990                  - "base": base address, in bytes (json-int)
2991                  - "limit": limit address, in bytes (json-int)
2992      - "memory_range": memory range information, a json-object with the
2993                        following members:
2994                  - "base": base address, in bytes (json-int)
2995                  - "limit": limit address, in bytes (json-int)
2996      - "prefetchable_range": Prefetchable memory range information, a
2997                              json-object with the following members:
2998                  - "base": base address, in bytes (json-int)
2999                  - "limit": limit address, in bytes (json-int)
3000      - "devices": a json-array of PCI devices if there's any attached, each
3001                   each element is represented by a json-object, which contains
3002                   the same members of the 'PCI device json-object' described
3003                   above (optional)
3004 - "regions": a json-array of json-objects, each json-object represents a
3005              memory region of this device
3006
3007 The memory range json-object contains the following:
3008
3009 - "base": base memory address (json-int)
3010 - "limit": limit value (json-int)
3011
3012 The region json-object can be an I/O region or a memory region, an I/O region
3013 json-object contains the following:
3014
3015 - "type": "io" (json-string, fixed)
3016 - "bar": BAR number (json-int)
3017 - "address": memory address (json-int)
3018 - "size": memory size (json-int)
3019
3020 A memory region json-object contains the following:
3021
3022 - "type": "memory" (json-string, fixed)
3023 - "bar": BAR number (json-int)
3024 - "address": memory address (json-int)
3025 - "size": memory size (json-int)
3026 - "mem_type_64": true or false (json-bool)
3027 - "prefetch": true or false (json-bool)
3028
3029 Example:
3030
3031 -> { "execute": "query-pci" }
3032 <- {
3033       "return":[
3034          {
3035             "bus":0,
3036             "devices":[
3037                {
3038                   "bus":0,
3039                   "qdev_id":"",
3040                   "slot":0,
3041                   "class_info":{
3042                      "class":1536,
3043                      "desc":"Host bridge"
3044                   },
3045                   "id":{
3046                      "device":32902,
3047                      "vendor":4663
3048                   },
3049                   "function":0,
3050                   "regions":[
3051
3052                   ]
3053                },
3054                {
3055                   "bus":0,
3056                   "qdev_id":"",
3057                   "slot":1,
3058                   "class_info":{
3059                      "class":1537,
3060                      "desc":"ISA bridge"
3061                   },
3062                   "id":{
3063                      "device":32902,
3064                      "vendor":28672
3065                   },
3066                   "function":0,
3067                   "regions":[
3068
3069                   ]
3070                },
3071                {
3072                   "bus":0,
3073                   "qdev_id":"",
3074                   "slot":1,
3075                   "class_info":{
3076                      "class":257,
3077                      "desc":"IDE controller"
3078                   },
3079                   "id":{
3080                      "device":32902,
3081                      "vendor":28688
3082                   },
3083                   "function":1,
3084                   "regions":[
3085                      {
3086                         "bar":4,
3087                         "size":16,
3088                         "address":49152,
3089                         "type":"io"
3090                      }
3091                   ]
3092                },
3093                {
3094                   "bus":0,
3095                   "qdev_id":"",
3096                   "slot":2,
3097                   "class_info":{
3098                      "class":768,
3099                      "desc":"VGA controller"
3100                   },
3101                   "id":{
3102                      "device":4115,
3103                      "vendor":184
3104                   },
3105                   "function":0,
3106                   "regions":[
3107                      {
3108                         "prefetch":true,
3109                         "mem_type_64":false,
3110                         "bar":0,
3111                         "size":33554432,
3112                         "address":4026531840,
3113                         "type":"memory"
3114                      },
3115                      {
3116                         "prefetch":false,
3117                         "mem_type_64":false,
3118                         "bar":1,
3119                         "size":4096,
3120                         "address":4060086272,
3121                         "type":"memory"
3122                      },
3123                      {
3124                         "prefetch":false,
3125                         "mem_type_64":false,
3126                         "bar":6,
3127                         "size":65536,
3128                         "address":-1,
3129                         "type":"memory"
3130                      }
3131                   ]
3132                },
3133                {
3134                   "bus":0,
3135                   "qdev_id":"",
3136                   "irq":11,
3137                   "slot":4,
3138                   "class_info":{
3139                      "class":1280,
3140                      "desc":"RAM controller"
3141                   },
3142                   "id":{
3143                      "device":6900,
3144                      "vendor":4098
3145                   },
3146                   "function":0,
3147                   "regions":[
3148                      {
3149                         "bar":0,
3150                         "size":32,
3151                         "address":49280,
3152                         "type":"io"
3153                      }
3154                   ]
3155                }
3156             ]
3157          }
3158       ]
3159    }
3160
3161 Note: This example has been shortened as the real response is too long.
3162
3163 EQMP
3164
3165     {
3166         .name       = "query-pci",
3167         .args_type  = "",
3168         .mhandler.cmd_new = qmp_marshal_query_pci,
3169     },
3170
3171 SQMP
3172 query-kvm
3173 ---------
3174
3175 Show KVM information.
3176
3177 Return a json-object with the following information:
3178
3179 - "enabled": true if KVM support is enabled, false otherwise (json-bool)
3180 - "present": true if QEMU has KVM support, false otherwise (json-bool)
3181
3182 Example:
3183
3184 -> { "execute": "query-kvm" }
3185 <- { "return": { "enabled": true, "present": true } }
3186
3187 EQMP
3188
3189     {
3190         .name       = "query-kvm",
3191         .args_type  = "",
3192         .mhandler.cmd_new = qmp_marshal_query_kvm,
3193     },
3194
3195 SQMP
3196 query-status
3197 ------------
3198
3199 Return a json-object with the following information:
3200
3201 - "running": true if the VM is running, or false if it is paused (json-bool)
3202 - "singlestep": true if the VM is in single step mode,
3203                 false otherwise (json-bool)
3204 - "status": one of the following values (json-string)
3205     "debug" - QEMU is running on a debugger
3206     "inmigrate" - guest is paused waiting for an incoming migration
3207     "internal-error" - An internal error that prevents further guest
3208     execution has occurred
3209     "io-error" - the last IOP has failed and the device is configured
3210     to pause on I/O errors
3211     "paused" - guest has been paused via the 'stop' command
3212     "postmigrate" - guest is paused following a successful 'migrate'
3213     "prelaunch" - QEMU was started with -S and guest has not started
3214     "finish-migrate" - guest is paused to finish the migration process
3215     "restore-vm" - guest is paused to restore VM state
3216     "running" - guest is actively running
3217     "save-vm" - guest is paused to save the VM state
3218     "shutdown" - guest is shut down (and -no-shutdown is in use)
3219     "watchdog" - the watchdog action is configured to pause and
3220      has been triggered
3221
3222 Example:
3223
3224 -> { "execute": "query-status" }
3225 <- { "return": { "running": true, "singlestep": false, "status": "running" } }
3226
3227 EQMP
3228
3229     {
3230         .name       = "query-status",
3231         .args_type  = "",
3232         .mhandler.cmd_new = qmp_marshal_query_status,
3233     },
3234
3235 SQMP
3236 query-mice
3237 ----------
3238
3239 Show VM mice information.
3240
3241 Each mouse is represented by a json-object, the returned value is a json-array
3242 of all mice.
3243
3244 The mouse json-object contains the following:
3245
3246 - "name": mouse's name (json-string)
3247 - "index": mouse's index (json-int)
3248 - "current": true if this mouse is receiving events, false otherwise (json-bool)
3249 - "absolute": true if the mouse generates absolute input events (json-bool)
3250
3251 Example:
3252
3253 -> { "execute": "query-mice" }
3254 <- {
3255       "return":[
3256          {
3257             "name":"QEMU Microsoft Mouse",
3258             "index":0,
3259             "current":false,
3260             "absolute":false
3261          },
3262          {
3263             "name":"QEMU PS/2 Mouse",
3264             "index":1,
3265             "current":true,
3266             "absolute":true
3267          }
3268       ]
3269    }
3270
3271 EQMP
3272
3273     {
3274         .name       = "query-mice",
3275         .args_type  = "",
3276         .mhandler.cmd_new = qmp_marshal_query_mice,
3277     },
3278
3279 SQMP
3280 query-vnc
3281 ---------
3282
3283 Show VNC server information.
3284
3285 Return a json-object with server information. Connected clients are returned
3286 as a json-array of json-objects.
3287
3288 The main json-object contains the following:
3289
3290 - "enabled": true or false (json-bool)
3291 - "host": server's IP address (json-string)
3292 - "family": address family (json-string)
3293          - Possible values: "ipv4", "ipv6", "unix", "unknown"
3294 - "service": server's port number (json-string)
3295 - "auth": authentication method (json-string)
3296          - Possible values: "invalid", "none", "ra2", "ra2ne", "sasl", "tight",
3297                             "tls", "ultra", "unknown", "vencrypt", "vencrypt",
3298                             "vencrypt+plain", "vencrypt+tls+none",
3299                             "vencrypt+tls+plain", "vencrypt+tls+sasl",
3300                             "vencrypt+tls+vnc", "vencrypt+x509+none",
3301                             "vencrypt+x509+plain", "vencrypt+x509+sasl",
3302                             "vencrypt+x509+vnc", "vnc"
3303 - "clients": a json-array of all connected clients
3304
3305 Clients are described by a json-object, each one contain the following:
3306
3307 - "host": client's IP address (json-string)
3308 - "family": address family (json-string)
3309          - Possible values: "ipv4", "ipv6", "unix", "unknown"
3310 - "service": client's port number (json-string)
3311 - "x509_dname": TLS dname (json-string, optional)
3312 - "sasl_username": SASL username (json-string, optional)
3313
3314 Example:
3315
3316 -> { "execute": "query-vnc" }
3317 <- {
3318       "return":{
3319          "enabled":true,
3320          "host":"0.0.0.0",
3321          "service":"50402",
3322          "auth":"vnc",
3323          "family":"ipv4",
3324          "clients":[
3325             {
3326                "host":"127.0.0.1",
3327                "service":"50401",
3328                "family":"ipv4"
3329             }
3330          ]
3331       }
3332    }
3333
3334 EQMP
3335
3336     {
3337         .name       = "query-vnc",
3338         .args_type  = "",
3339         .mhandler.cmd_new = qmp_marshal_query_vnc,
3340     },
3341     {
3342         .name       = "query-vnc-servers",
3343         .args_type  = "",
3344         .mhandler.cmd_new = qmp_marshal_query_vnc_servers,
3345     },
3346
3347 SQMP
3348 query-spice
3349 -----------
3350
3351 Show SPICE server information.
3352
3353 Return a json-object with server information. Connected clients are returned
3354 as a json-array of json-objects.
3355
3356 The main json-object contains the following:
3357
3358 - "enabled": true or false (json-bool)
3359 - "host": server's IP address (json-string)
3360 - "port": server's port number (json-int, optional)
3361 - "tls-port": server's port number (json-int, optional)
3362 - "auth": authentication method (json-string)
3363          - Possible values: "none", "spice"
3364 - "channels": a json-array of all active channels clients
3365
3366 Channels are described by a json-object, each one contain the following:
3367
3368 - "host": client's IP address (json-string)
3369 - "family": address family (json-string)
3370          - Possible values: "ipv4", "ipv6", "unix", "unknown"
3371 - "port": client's port number (json-string)
3372 - "connection-id": spice connection id.  All channels with the same id
3373                    belong to the same spice session (json-int)
3374 - "channel-type": channel type.  "1" is the main control channel, filter for
3375                   this one if you want track spice sessions only (json-int)
3376 - "channel-id": channel id.  Usually "0", might be different needed when
3377                 multiple channels of the same type exist, such as multiple
3378                 display channels in a multihead setup (json-int)
3379 - "tls": whether the channel is encrypted (json-bool)
3380
3381 Example:
3382
3383 -> { "execute": "query-spice" }
3384 <- {
3385       "return": {
3386          "enabled": true,
3387          "auth": "spice",
3388          "port": 5920,
3389          "tls-port": 5921,
3390          "host": "0.0.0.0",
3391          "channels": [
3392             {
3393                "port": "54924",
3394                "family": "ipv4",
3395                "channel-type": 1,
3396                "connection-id": 1804289383,
3397                "host": "127.0.0.1",
3398                "channel-id": 0,
3399                "tls": true
3400             },
3401             {
3402                "port": "36710",
3403                "family": "ipv4",
3404                "channel-type": 4,
3405                "connection-id": 1804289383,
3406                "host": "127.0.0.1",
3407                "channel-id": 0,
3408                "tls": false
3409             },
3410             [ ... more channels follow ... ]
3411          ]
3412       }
3413    }
3414
3415 EQMP
3416
3417 #if defined(CONFIG_SPICE)
3418     {
3419         .name       = "query-spice",
3420         .args_type  = "",
3421         .mhandler.cmd_new = qmp_marshal_query_spice,
3422     },
3423 #endif
3424
3425 SQMP
3426 query-name
3427 ----------
3428
3429 Show VM name.
3430
3431 Return a json-object with the following information:
3432
3433 - "name": VM's name (json-string, optional)
3434
3435 Example:
3436
3437 -> { "execute": "query-name" }
3438 <- { "return": { "name": "qemu-name" } }
3439
3440 EQMP
3441
3442     {
3443         .name       = "query-name",
3444         .args_type  = "",
3445         .mhandler.cmd_new = qmp_marshal_query_name,
3446     },
3447
3448 SQMP
3449 query-uuid
3450 ----------
3451
3452 Show VM UUID.
3453
3454 Return a json-object with the following information:
3455
3456 - "UUID": Universally Unique Identifier (json-string)
3457
3458 Example:
3459
3460 -> { "execute": "query-uuid" }
3461 <- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } }
3462
3463 EQMP
3464
3465     {
3466         .name       = "query-uuid",
3467         .args_type  = "",
3468         .mhandler.cmd_new = qmp_marshal_query_uuid,
3469     },
3470
3471 SQMP
3472 query-command-line-options
3473 --------------------------
3474
3475 Show command line option schema.
3476
3477 Return a json-array of command line option schema for all options (or for
3478 the given option), returning an error if the given option doesn't exist.
3479
3480 Each array entry contains the following:
3481
3482 - "option": option name (json-string)
3483 - "parameters": a json-array describes all parameters of the option:
3484     - "name": parameter name (json-string)
3485     - "type": parameter type (one of 'string', 'boolean', 'number',
3486               or 'size')
3487     - "help": human readable description of the parameter
3488               (json-string, optional)
3489     - "default": default value string for the parameter
3490                  (json-string, optional)
3491
3492 Example:
3493
3494 -> { "execute": "query-command-line-options", "arguments": { "option": "option-rom" } }
3495 <- { "return": [
3496         {
3497             "parameters": [
3498                 {
3499                     "name": "romfile",
3500                     "type": "string"
3501                 },
3502                 {
3503                     "name": "bootindex",
3504                     "type": "number"
3505                 }
3506             ],
3507             "option": "option-rom"
3508         }
3509      ]
3510    }
3511
3512 EQMP
3513
3514     {
3515         .name       = "query-command-line-options",
3516         .args_type  = "option:s?",
3517         .mhandler.cmd_new = qmp_marshal_query_command_line_options,
3518     },
3519
3520 SQMP
3521 query-migrate
3522 -------------
3523
3524 Migration status.
3525
3526 Return a json-object. If migration is active there will be another json-object
3527 with RAM migration status and if block migration is active another one with
3528 block migration status.
3529
3530 The main json-object contains the following:
3531
3532 - "status": migration status (json-string)
3533      - Possible values: "setup", "active", "completed", "failed", "cancelled"
3534 - "total-time": total amount of ms since migration started.  If
3535                 migration has ended, it returns the total migration
3536                 time (json-int)
3537 - "setup-time" amount of setup time in milliseconds _before_ the
3538                iterations begin but _after_ the QMP command is issued.
3539                This is designed to provide an accounting of any activities
3540                (such as RDMA pinning) which may be expensive, but do not
3541                actually occur during the iterative migration rounds
3542                themselves. (json-int)
3543 - "downtime": only present when migration has finished correctly
3544               total amount in ms for downtime that happened (json-int)
3545 - "expected-downtime": only present while migration is active
3546                 total amount in ms for downtime that was calculated on
3547                 the last bitmap round (json-int)
3548 - "ram": only present if "status" is "active", it is a json-object with the
3549   following RAM information:
3550          - "transferred": amount transferred in bytes (json-int)
3551          - "remaining": amount remaining to transfer in bytes (json-int)
3552          - "total": total amount of memory in bytes (json-int)
3553          - "duplicate": number of pages filled entirely with the same
3554             byte (json-int)
3555             These are sent over the wire much more efficiently.
3556          - "skipped": number of skipped zero pages (json-int)
3557          - "normal" : number of whole pages transferred.  I.e. they
3558             were not sent as duplicate or xbzrle pages (json-int)
3559          - "normal-bytes" : number of bytes transferred in whole
3560             pages. This is just normal pages times size of one page,
3561             but this way upper levels don't need to care about page
3562             size (json-int)
3563          - "dirty-sync-count": times that dirty ram was synchronized (json-int)
3564 - "disk": only present if "status" is "active" and it is a block migration,
3565   it is a json-object with the following disk information:
3566          - "transferred": amount transferred in bytes (json-int)
3567          - "remaining": amount remaining to transfer in bytes json-int)
3568          - "total": total disk size in bytes (json-int)
3569 - "xbzrle-cache": only present if XBZRLE is active.
3570   It is a json-object with the following XBZRLE information:
3571          - "cache-size": XBZRLE cache size in bytes
3572          - "bytes": number of bytes transferred for XBZRLE compressed pages
3573          - "pages": number of XBZRLE compressed pages
3574          - "cache-miss": number of XBRZRLE page cache misses
3575          - "cache-miss-rate": rate of XBRZRLE page cache misses
3576          - "overflow": number of times XBZRLE overflows.  This means
3577            that the XBZRLE encoding was bigger than just sent the
3578            whole page, and then we sent the whole page instead (as as
3579            normal page).
3580
3581 Examples:
3582
3583 1. Before the first migration
3584
3585 -> { "execute": "query-migrate" }
3586 <- { "return": {} }
3587
3588 2. Migration is done and has succeeded
3589
3590 -> { "execute": "query-migrate" }
3591 <- { "return": {
3592         "status": "completed",
3593         "ram":{
3594           "transferred":123,
3595           "remaining":123,
3596           "total":246,
3597           "total-time":12345,
3598           "setup-time":12345,
3599           "downtime":12345,
3600           "duplicate":123,
3601           "normal":123,
3602           "normal-bytes":123456,
3603           "dirty-sync-count":15
3604         }
3605      }
3606    }
3607
3608 3. Migration is done and has failed
3609
3610 -> { "execute": "query-migrate" }
3611 <- { "return": { "status": "failed" } }
3612
3613 4. Migration is being performed and is not a block migration:
3614
3615 -> { "execute": "query-migrate" }
3616 <- {
3617       "return":{
3618          "status":"active",
3619          "ram":{
3620             "transferred":123,
3621             "remaining":123,
3622             "total":246,
3623             "total-time":12345,
3624             "setup-time":12345,
3625             "expected-downtime":12345,
3626             "duplicate":123,
3627             "normal":123,
3628             "normal-bytes":123456,
3629             "dirty-sync-count":15
3630          }
3631       }
3632    }
3633
3634 5. Migration is being performed and is a block migration:
3635
3636 -> { "execute": "query-migrate" }
3637 <- {
3638       "return":{
3639          "status":"active",
3640          "ram":{
3641             "total":1057024,
3642             "remaining":1053304,
3643             "transferred":3720,
3644             "total-time":12345,
3645             "setup-time":12345,
3646             "expected-downtime":12345,
3647             "duplicate":123,
3648             "normal":123,
3649             "normal-bytes":123456,
3650             "dirty-sync-count":15
3651          },
3652          "disk":{
3653             "total":20971520,
3654             "remaining":20880384,
3655             "transferred":91136
3656          }
3657       }
3658    }
3659
3660 6. Migration is being performed and XBZRLE is active:
3661
3662 -> { "execute": "query-migrate" }
3663 <- {
3664       "return":{
3665          "status":"active",
3666          "capabilities" : [ { "capability": "xbzrle", "state" : true } ],
3667          "ram":{
3668             "total":1057024,
3669             "remaining":1053304,
3670             "transferred":3720,
3671             "total-time":12345,
3672             "setup-time":12345,
3673             "expected-downtime":12345,
3674             "duplicate":10,
3675             "normal":3333,
3676             "normal-bytes":3412992,
3677             "dirty-sync-count":15
3678          },
3679          "xbzrle-cache":{
3680             "cache-size":67108864,
3681             "bytes":20971520,
3682             "pages":2444343,
3683             "cache-miss":2244,
3684             "cache-miss-rate":0.123,
3685             "overflow":34434
3686          }
3687       }
3688    }
3689
3690 EQMP
3691
3692     {
3693         .name       = "query-migrate",
3694         .args_type  = "",
3695         .mhandler.cmd_new = qmp_marshal_query_migrate,
3696     },
3697
3698 SQMP
3699 migrate-set-capabilities
3700 ------------------------
3701
3702 Enable/Disable migration capabilities
3703
3704 - "xbzrle": XBZRLE support
3705 - "rdma-pin-all": pin all pages when using RDMA during migration
3706 - "auto-converge": throttle down guest to help convergence of migration
3707 - "zero-blocks": compress zero blocks during block migration
3708 - "compress": use multiple compression threads to accelerate live migration
3709 - "events": generate events for each migration state change
3710 - "postcopy-ram": postcopy mode for live migration
3711
3712 Arguments:
3713
3714 Example:
3715
3716 -> { "execute": "migrate-set-capabilities" , "arguments":
3717      { "capabilities": [ { "capability": "xbzrle", "state": true } ] } }
3718
3719 EQMP
3720
3721     {
3722         .name       = "migrate-set-capabilities",
3723         .args_type  = "capabilities:q",
3724         .params     = "capability:s,state:b",
3725         .mhandler.cmd_new = qmp_marshal_migrate_set_capabilities,
3726     },
3727 SQMP
3728 query-migrate-capabilities
3729 --------------------------
3730
3731 Query current migration capabilities
3732
3733 - "capabilities": migration capabilities state
3734          - "xbzrle" : XBZRLE state (json-bool)
3735          - "rdma-pin-all" : RDMA Pin Page state (json-bool)
3736          - "auto-converge" : Auto Converge state (json-bool)
3737          - "zero-blocks" : Zero Blocks state (json-bool)
3738          - "compress": Multiple compression threads state (json-bool)
3739          - "events": Migration state change event state (json-bool)
3740          - "postcopy-ram": postcopy ram state (json-bool)
3741
3742 Arguments:
3743
3744 Example:
3745
3746 -> { "execute": "query-migrate-capabilities" }
3747 <- {"return": [
3748      {"state": false, "capability": "xbzrle"},
3749      {"state": false, "capability": "rdma-pin-all"},
3750      {"state": false, "capability": "auto-converge"},
3751      {"state": false, "capability": "zero-blocks"},
3752      {"state": false, "capability": "compress"},
3753      {"state": true, "capability": "events"},
3754      {"state": false, "capability": "postcopy-ram"}
3755    ]}
3756
3757 EQMP
3758
3759     {
3760         .name       = "query-migrate-capabilities",
3761         .args_type  = "",
3762         .mhandler.cmd_new = qmp_marshal_query_migrate_capabilities,
3763     },
3764
3765 SQMP
3766 migrate-set-parameters
3767 ----------------------
3768
3769 Set migration parameters
3770
3771 - "compress-level": set compression level during migration (json-int)
3772 - "compress-threads": set compression thread count for migration (json-int)
3773 - "decompress-threads": set decompression thread count for migration (json-int)
3774 - "x-cpu-throttle-initial": set initial percentage of time guest cpus are
3775                            throttled for auto-converge (json-int)
3776 - "x-cpu-throttle-increment": set throttle increasing percentage for
3777                              auto-converge (json-int)
3778
3779 Arguments:
3780
3781 Example:
3782
3783 -> { "execute": "migrate-set-parameters" , "arguments":
3784       { "compress-level": 1 } }
3785
3786 EQMP
3787
3788     {
3789         .name       = "migrate-set-parameters",
3790         .args_type  =
3791             "compress-level:i?,compress-threads:i?,decompress-threads:i?,x-cpu-throttle-initial:i?,x-cpu-throttle-increment:i?",
3792         .mhandler.cmd_new = qmp_marshal_migrate_set_parameters,
3793     },
3794 SQMP
3795 query-migrate-parameters
3796 ------------------------
3797
3798 Query current migration parameters
3799
3800 - "parameters": migration parameters value
3801          - "compress-level" : compression level value (json-int)
3802          - "compress-threads" : compression thread count value (json-int)
3803          - "decompress-threads" : decompression thread count value (json-int)
3804          - "x-cpu-throttle-initial" : initial percentage of time guest cpus are
3805                                       throttled (json-int)
3806          - "x-cpu-throttle-increment" : throttle increasing percentage for
3807                                         auto-converge (json-int)
3808
3809 Arguments:
3810
3811 Example:
3812
3813 -> { "execute": "query-migrate-parameters" }
3814 <- {
3815       "return": {
3816          "decompress-threads": 2,
3817          "x-cpu-throttle-increment": 10,
3818          "compress-threads": 8,
3819          "compress-level": 1,
3820          "x-cpu-throttle-initial": 20
3821       }
3822    }
3823
3824 EQMP
3825
3826     {
3827         .name       = "query-migrate-parameters",
3828         .args_type  = "",
3829         .mhandler.cmd_new = qmp_marshal_query_migrate_parameters,
3830     },
3831
3832 SQMP
3833 query-balloon
3834 -------------
3835
3836 Show balloon information.
3837
3838 Make an asynchronous request for balloon info. When the request completes a
3839 json-object will be returned containing the following data:
3840
3841 - "actual": current balloon value in bytes (json-int)
3842
3843 Example:
3844
3845 -> { "execute": "query-balloon" }
3846 <- {
3847       "return":{
3848          "actual":1073741824,
3849       }
3850    }
3851
3852 EQMP
3853
3854     {
3855         .name       = "query-balloon",
3856         .args_type  = "",
3857         .mhandler.cmd_new = qmp_marshal_query_balloon,
3858     },
3859
3860     {
3861         .name       = "query-block-jobs",
3862         .args_type  = "",
3863         .mhandler.cmd_new = qmp_marshal_query_block_jobs,
3864     },
3865
3866     {
3867         .name       = "qom-list",
3868         .args_type  = "path:s",
3869         .mhandler.cmd_new = qmp_marshal_qom_list,
3870     },
3871
3872     {
3873         .name       = "qom-set",
3874         .args_type  = "path:s,property:s,value:q",
3875         .mhandler.cmd_new = qmp_marshal_qom_set,
3876     },
3877
3878     {
3879         .name       = "qom-get",
3880         .args_type  = "path:s,property:s",
3881         .mhandler.cmd_new = qmp_marshal_qom_get,
3882     },
3883
3884     {
3885         .name       = "nbd-server-start",
3886         .args_type  = "addr:q,tls-creds:s?",
3887         .mhandler.cmd_new = qmp_marshal_nbd_server_start,
3888     },
3889     {
3890         .name       = "nbd-server-add",
3891         .args_type  = "device:B,writable:b?",
3892         .mhandler.cmd_new = qmp_marshal_nbd_server_add,
3893     },
3894     {
3895         .name       = "nbd-server-stop",
3896         .args_type  = "",
3897         .mhandler.cmd_new = qmp_marshal_nbd_server_stop,
3898     },
3899
3900     {
3901         .name       = "change-vnc-password",
3902         .args_type  = "password:s",
3903         .mhandler.cmd_new = qmp_marshal_change_vnc_password,
3904     },
3905     {
3906         .name       = "qom-list-types",
3907         .args_type  = "implements:s?,abstract:b?",
3908         .mhandler.cmd_new = qmp_marshal_qom_list_types,
3909     },
3910
3911     {
3912         .name       = "device-list-properties",
3913         .args_type  = "typename:s",
3914         .mhandler.cmd_new = qmp_marshal_device_list_properties,
3915     },
3916
3917     {
3918         .name       = "query-machines",
3919         .args_type  = "",
3920         .mhandler.cmd_new = qmp_marshal_query_machines,
3921     },
3922
3923     {
3924         .name       = "query-cpu-definitions",
3925         .args_type  = "",
3926         .mhandler.cmd_new = qmp_marshal_query_cpu_definitions,
3927     },
3928
3929     {
3930         .name       = "query-target",
3931         .args_type  = "",
3932         .mhandler.cmd_new = qmp_marshal_query_target,
3933     },
3934
3935     {
3936         .name       = "query-tpm",
3937         .args_type  = "",
3938         .mhandler.cmd_new = qmp_marshal_query_tpm,
3939     },
3940
3941 SQMP
3942 query-tpm
3943 ---------
3944
3945 Return information about the TPM device.
3946
3947 Arguments: None
3948
3949 Example:
3950
3951 -> { "execute": "query-tpm" }
3952 <- { "return":
3953      [
3954        { "model": "tpm-tis",
3955          "options":
3956            { "type": "passthrough",
3957              "data":
3958                { "cancel-path": "/sys/class/misc/tpm0/device/cancel",
3959                  "path": "/dev/tpm0"
3960                }
3961            },
3962          "id": "tpm0"
3963        }
3964      ]
3965    }
3966
3967 EQMP
3968
3969     {
3970         .name       = "query-tpm-models",
3971         .args_type  = "",
3972         .mhandler.cmd_new = qmp_marshal_query_tpm_models,
3973     },
3974
3975 SQMP
3976 query-tpm-models
3977 ----------------
3978
3979 Return a list of supported TPM models.
3980
3981 Arguments: None
3982
3983 Example:
3984
3985 -> { "execute": "query-tpm-models" }
3986 <- { "return": [ "tpm-tis" ] }
3987
3988 EQMP
3989
3990     {
3991         .name       = "query-tpm-types",
3992         .args_type  = "",
3993         .mhandler.cmd_new = qmp_marshal_query_tpm_types,
3994     },
3995
3996 SQMP
3997 query-tpm-types
3998 ---------------
3999
4000 Return a list of supported TPM types.
4001
4002 Arguments: None
4003
4004 Example:
4005
4006 -> { "execute": "query-tpm-types" }
4007 <- { "return": [ "passthrough" ] }
4008
4009 EQMP
4010
4011     {
4012         .name       = "chardev-add",
4013         .args_type  = "id:s,backend:q",
4014         .mhandler.cmd_new = qmp_marshal_chardev_add,
4015     },
4016
4017 SQMP
4018 chardev-add
4019 ----------------
4020
4021 Add a chardev.
4022
4023 Arguments:
4024
4025 - "id": the chardev's ID, must be unique (json-string)
4026 - "backend": chardev backend type + parameters
4027
4028 Examples:
4029
4030 -> { "execute" : "chardev-add",
4031      "arguments" : { "id" : "foo",
4032                      "backend" : { "type" : "null", "data" : {} } } }
4033 <- { "return": {} }
4034
4035 -> { "execute" : "chardev-add",
4036      "arguments" : { "id" : "bar",
4037                      "backend" : { "type" : "file",
4038                                    "data" : { "out" : "/tmp/bar.log" } } } }
4039 <- { "return": {} }
4040
4041 -> { "execute" : "chardev-add",
4042      "arguments" : { "id" : "baz",
4043                      "backend" : { "type" : "pty", "data" : {} } } }
4044 <- { "return": { "pty" : "/dev/pty/42" } }
4045
4046 EQMP
4047
4048     {
4049         .name       = "chardev-remove",
4050         .args_type  = "id:s",
4051         .mhandler.cmd_new = qmp_marshal_chardev_remove,
4052     },
4053
4054
4055 SQMP
4056 chardev-remove
4057 --------------
4058
4059 Remove a chardev.
4060
4061 Arguments:
4062
4063 - "id": the chardev's ID, must exist and not be in use (json-string)
4064
4065 Example:
4066
4067 -> { "execute": "chardev-remove", "arguments": { "id" : "foo" } }
4068 <- { "return": {} }
4069
4070 EQMP
4071     {
4072         .name       = "query-rx-filter",
4073         .args_type  = "name:s?",
4074         .mhandler.cmd_new = qmp_marshal_query_rx_filter,
4075     },
4076
4077 SQMP
4078 query-rx-filter
4079 ---------------
4080
4081 Show rx-filter information.
4082
4083 Returns a json-array of rx-filter information for all NICs (or for the
4084 given NIC), returning an error if the given NIC doesn't exist, or
4085 given NIC doesn't support rx-filter querying, or given net client
4086 isn't a NIC.
4087
4088 The query will clear the event notification flag of each NIC, then qemu
4089 will start to emit event to QMP monitor.
4090
4091 Each array entry contains the following:
4092
4093 - "name": net client name (json-string)
4094 - "promiscuous": promiscuous mode is enabled (json-bool)
4095 - "multicast": multicast receive state (one of 'normal', 'none', 'all')
4096 - "unicast": unicast receive state  (one of 'normal', 'none', 'all')
4097 - "vlan": vlan receive state (one of 'normal', 'none', 'all') (Since 2.0)
4098 - "broadcast-allowed": allow to receive broadcast (json-bool)
4099 - "multicast-overflow": multicast table is overflowed (json-bool)
4100 - "unicast-overflow": unicast table is overflowed (json-bool)
4101 - "main-mac": main macaddr string (json-string)
4102 - "vlan-table": a json-array of active vlan id
4103 - "unicast-table": a json-array of unicast macaddr string
4104 - "multicast-table": a json-array of multicast macaddr string
4105
4106 Example:
4107
4108 -> { "execute": "query-rx-filter", "arguments": { "name": "vnet0" } }
4109 <- { "return": [
4110         {
4111             "promiscuous": true,
4112             "name": "vnet0",
4113             "main-mac": "52:54:00:12:34:56",
4114             "unicast": "normal",
4115             "vlan": "normal",
4116             "vlan-table": [
4117                 4,
4118                 0
4119             ],
4120             "unicast-table": [
4121             ],
4122             "multicast": "normal",
4123             "multicast-overflow": false,
4124             "unicast-overflow": false,
4125             "multicast-table": [
4126                 "01:00:5e:00:00:01",
4127                 "33:33:00:00:00:01",
4128                 "33:33:ff:12:34:56"
4129             ],
4130             "broadcast-allowed": false
4131         }
4132       ]
4133    }
4134
4135 EQMP
4136
4137     {
4138         .name       = "blockdev-add",
4139         .args_type  = "options:q",
4140         .mhandler.cmd_new = qmp_marshal_blockdev_add,
4141     },
4142
4143 SQMP
4144 blockdev-add
4145 ------------
4146
4147 Add a block device.
4148
4149 This command is still a work in progress.  It doesn't support all
4150 block drivers among other things.  Stay away from it unless you want
4151 to help with its development.
4152
4153 Arguments:
4154
4155 - "options": block driver options
4156
4157 Example (1):
4158
4159 -> { "execute": "blockdev-add",
4160     "arguments": { "options" : { "driver": "qcow2",
4161                                  "file": { "driver": "file",
4162                                            "filename": "test.qcow2" } } } }
4163 <- { "return": {} }
4164
4165 Example (2):
4166
4167 -> { "execute": "blockdev-add",
4168      "arguments": {
4169          "options": {
4170            "driver": "qcow2",
4171            "id": "my_disk",
4172            "discard": "unmap",
4173            "cache": {
4174                "direct": true,
4175                "writeback": true
4176            },
4177            "file": {
4178                "driver": "file",
4179                "filename": "/tmp/test.qcow2"
4180            },
4181            "backing": {
4182                "driver": "raw",
4183                "file": {
4184                    "driver": "file",
4185                    "filename": "/dev/fdset/4"
4186                }
4187            }
4188          }
4189        }
4190      }
4191
4192 <- { "return": {} }
4193
4194 EQMP
4195
4196     {
4197         .name       = "x-blockdev-del",
4198         .args_type  = "id:s?,node-name:s?",
4199         .mhandler.cmd_new = qmp_marshal_x_blockdev_del,
4200     },
4201
4202 SQMP
4203 x-blockdev-del
4204 ------------
4205 Since 2.5
4206
4207 Deletes a block device thas has been added using blockdev-add.
4208 The selected device can be either a block backend or a graph node.
4209
4210 In the former case the backend will be destroyed, along with its
4211 inserted medium if there's any. The command will fail if the backend
4212 or its medium are in use.
4213
4214 In the latter case the node will be destroyed. The command will fail
4215 if the node is attached to a block backend or is otherwise being
4216 used.
4217
4218 One of "id" or "node-name" must be specified, but not both.
4219
4220 This command is still a work in progress and is considered
4221 experimental. Stay away from it unless you want to help with its
4222 development.
4223
4224 Arguments:
4225
4226 - "id": Name of the block backend device to delete (json-string, optional)
4227 - "node-name": Name of the graph node to delete (json-string, optional)
4228
4229 Example:
4230
4231 -> { "execute": "blockdev-add",
4232      "arguments": {
4233          "options": {
4234              "driver": "qcow2",
4235              "id": "drive0",
4236              "file": {
4237                  "driver": "file",
4238                  "filename": "test.qcow2"
4239              }
4240          }
4241      }
4242    }
4243
4244 <- { "return": {} }
4245
4246 -> { "execute": "x-blockdev-del",
4247      "arguments": { "id": "drive0" }
4248    }
4249 <- { "return": {} }
4250
4251 EQMP
4252
4253     {
4254         .name       = "blockdev-open-tray",
4255         .args_type  = "device:s,force:b?",
4256         .mhandler.cmd_new = qmp_marshal_blockdev_open_tray,
4257     },
4258
4259 SQMP
4260 blockdev-open-tray
4261 ------------------
4262
4263 Opens a block device's tray. If there is a block driver state tree inserted as a
4264 medium, it will become inaccessible to the guest (but it will remain associated
4265 to the block device, so closing the tray will make it accessible again).
4266
4267 If the tray was already open before, this will be a no-op.
4268
4269 Once the tray opens, a DEVICE_TRAY_MOVED event is emitted. There are cases in
4270 which no such event will be generated, these include:
4271 - if the guest has locked the tray, @force is false and the guest does not
4272   respond to the eject request
4273 - if the BlockBackend denoted by @device does not have a guest device attached
4274   to it
4275 - if the guest device does not have an actual tray and is empty, for instance
4276   for floppy disk drives
4277
4278 Arguments:
4279
4280 - "device": block device name (json-string)
4281 - "force": if false (the default), an eject request will be sent to the guest if
4282            it has locked the tray (and the tray will not be opened immediately);
4283            if true, the tray will be opened regardless of whether it is locked
4284            (json-bool, optional)
4285
4286 Example:
4287
4288 -> { "execute": "blockdev-open-tray",
4289      "arguments": { "device": "ide1-cd0" } }
4290
4291 <- { "timestamp": { "seconds": 1418751016,
4292                     "microseconds": 716996 },
4293      "event": "DEVICE_TRAY_MOVED",
4294      "data": { "device": "ide1-cd0",
4295                "tray-open": true } }
4296
4297 <- { "return": {} }
4298
4299 EQMP
4300
4301     {
4302         .name       = "blockdev-close-tray",
4303         .args_type  = "device:s",
4304         .mhandler.cmd_new = qmp_marshal_blockdev_close_tray,
4305     },
4306
4307 SQMP
4308 blockdev-close-tray
4309 -------------------
4310
4311 Closes a block device's tray. If there is a block driver state tree associated
4312 with the block device (which is currently ejected), that tree will be loaded as
4313 the medium.
4314
4315 If the tray was already closed before, this will be a no-op.
4316
4317 Arguments:
4318
4319 - "device": block device name (json-string)
4320
4321 Example:
4322
4323 -> { "execute": "blockdev-close-tray",
4324      "arguments": { "device": "ide1-cd0" } }
4325
4326 <- { "timestamp": { "seconds": 1418751345,
4327                     "microseconds": 272147 },
4328      "event": "DEVICE_TRAY_MOVED",
4329      "data": { "device": "ide1-cd0",
4330                "tray-open": false } }
4331
4332 <- { "return": {} }
4333
4334 EQMP
4335
4336     {
4337         .name       = "x-blockdev-remove-medium",
4338         .args_type  = "device:s",
4339         .mhandler.cmd_new = qmp_marshal_x_blockdev_remove_medium,
4340     },
4341
4342 SQMP
4343 x-blockdev-remove-medium
4344 ------------------------
4345
4346 Removes a medium (a block driver state tree) from a block device. That block
4347 device's tray must currently be open (unless there is no attached guest device).
4348
4349 If the tray is open and there is no medium inserted, this will be a no-op.
4350
4351 This command is still a work in progress and is considered experimental.
4352 Stay away from it unless you want to help with its development.
4353
4354 Arguments:
4355
4356 - "device": block device name (json-string)
4357
4358 Example:
4359
4360 -> { "execute": "x-blockdev-remove-medium",
4361      "arguments": { "device": "ide1-cd0" } }
4362
4363 <- { "error": { "class": "GenericError",
4364                 "desc": "Tray of device 'ide1-cd0' is not open" } }
4365
4366 -> { "execute": "blockdev-open-tray",
4367      "arguments": { "device": "ide1-cd0" } }
4368
4369 <- { "timestamp": { "seconds": 1418751627,
4370                     "microseconds": 549958 },
4371      "event": "DEVICE_TRAY_MOVED",
4372      "data": { "device": "ide1-cd0",
4373                "tray-open": true } }
4374
4375 <- { "return": {} }
4376
4377 -> { "execute": "x-blockdev-remove-medium",
4378      "arguments": { "device": "ide1-cd0" } }
4379
4380 <- { "return": {} }
4381
4382 EQMP
4383
4384     {
4385         .name       = "x-blockdev-insert-medium",
4386         .args_type  = "device:s,node-name:s",
4387         .mhandler.cmd_new = qmp_marshal_x_blockdev_insert_medium,
4388     },
4389
4390 SQMP
4391 x-blockdev-insert-medium
4392 ------------------------
4393
4394 Inserts a medium (a block driver state tree) into a block device. That block
4395 device's tray must currently be open (unless there is no attached guest device)
4396 and there must be no medium inserted already.
4397
4398 This command is still a work in progress and is considered experimental.
4399 Stay away from it unless you want to help with its development.
4400
4401 Arguments:
4402
4403 - "device": block device name (json-string)
4404 - "node-name": root node of the BDS tree to insert into the block device
4405
4406 Example:
4407
4408 -> { "execute": "blockdev-add",
4409      "arguments": { "options": { "node-name": "node0",
4410                                  "driver": "raw",
4411                                  "file": { "driver": "file",
4412                                            "filename": "fedora.iso" } } } }
4413
4414 <- { "return": {} }
4415
4416 -> { "execute": "x-blockdev-insert-medium",
4417      "arguments": { "device": "ide1-cd0",
4418                     "node-name": "node0" } }
4419
4420 <- { "return": {} }
4421
4422 EQMP
4423
4424     {
4425         .name       = "query-named-block-nodes",
4426         .args_type  = "",
4427         .mhandler.cmd_new = qmp_marshal_query_named_block_nodes,
4428     },
4429
4430 SQMP
4431 @query-named-block-nodes
4432 ------------------------
4433
4434 Return a list of BlockDeviceInfo for all the named block driver nodes
4435
4436 Example:
4437
4438 -> { "execute": "query-named-block-nodes" }
4439 <- { "return": [ { "ro":false,
4440                    "drv":"qcow2",
4441                    "encrypted":false,
4442                    "file":"disks/test.qcow2",
4443                    "node-name": "my-node",
4444                    "backing_file_depth":1,
4445                    "bps":1000000,
4446                    "bps_rd":0,
4447                    "bps_wr":0,
4448                    "iops":1000000,
4449                    "iops_rd":0,
4450                    "iops_wr":0,
4451                    "bps_max": 8000000,
4452                    "bps_rd_max": 0,
4453                    "bps_wr_max": 0,
4454                    "iops_max": 0,
4455                    "iops_rd_max": 0,
4456                    "iops_wr_max": 0,
4457                    "iops_size": 0,
4458                    "write_threshold": 0,
4459                    "image":{
4460                       "filename":"disks/test.qcow2",
4461                       "format":"qcow2",
4462                       "virtual-size":2048000,
4463                       "backing_file":"base.qcow2",
4464                       "full-backing-filename":"disks/base.qcow2",
4465                       "backing-filename-format":"qcow2",
4466                       "snapshots":[
4467                          {
4468                             "id": "1",
4469                             "name": "snapshot1",
4470                             "vm-state-size": 0,
4471                             "date-sec": 10000200,
4472                             "date-nsec": 12,
4473                             "vm-clock-sec": 206,
4474                             "vm-clock-nsec": 30
4475                          }
4476                       ],
4477                       "backing-image":{
4478                           "filename":"disks/base.qcow2",
4479                           "format":"qcow2",
4480                           "virtual-size":2048000
4481                       }
4482                    } } ] }
4483
4484 EQMP
4485
4486     {
4487         .name       = "blockdev-change-medium",
4488         .args_type  = "device:B,filename:F,format:s?,read-only-mode:s?",
4489         .mhandler.cmd_new = qmp_marshal_blockdev_change_medium,
4490     },
4491
4492 SQMP
4493 blockdev-change-medium
4494 ----------------------
4495
4496 Changes the medium inserted into a block device by ejecting the current medium
4497 and loading a new image file which is inserted as the new medium.
4498
4499 Arguments:
4500
4501 - "device": device name (json-string)
4502 - "filename": filename of the new image (json-string)
4503 - "format": format of the new image (json-string, optional)
4504 - "read-only-mode": new read-only mode (json-string, optional)
4505           - Possible values: "retain" (default), "read-only", "read-write"
4506
4507 Examples:
4508
4509 1. Change a removable medium
4510
4511 -> { "execute": "blockdev-change-medium",
4512              "arguments": { "device": "ide1-cd0",
4513                             "filename": "/srv/images/Fedora-12-x86_64-DVD.iso",
4514                             "format": "raw" } }
4515 <- { "return": {} }
4516
4517 2. Load a read-only medium into a writable drive
4518
4519 -> { "execute": "blockdev-change-medium",
4520              "arguments": { "device": "isa-fd0",
4521                             "filename": "/srv/images/ro.img",
4522                             "format": "raw",
4523                             "read-only-mode": "retain" } }
4524
4525 <- { "error":
4526      { "class": "GenericError",
4527        "desc": "Could not open '/srv/images/ro.img': Permission denied" } }
4528
4529 -> { "execute": "blockdev-change-medium",
4530              "arguments": { "device": "isa-fd0",
4531                             "filename": "/srv/images/ro.img",
4532                             "format": "raw",
4533                             "read-only-mode": "read-only" } }
4534
4535 <- { "return": {} }
4536
4537 EQMP
4538
4539     {
4540         .name       = "query-memdev",
4541         .args_type  = "",
4542         .mhandler.cmd_new = qmp_marshal_query_memdev,
4543     },
4544
4545 SQMP
4546 query-memdev
4547 ------------
4548
4549 Show memory devices information.
4550
4551
4552 Example (1):
4553
4554 -> { "execute": "query-memdev" }
4555 <- { "return": [
4556        {
4557          "size": 536870912,
4558          "merge": false,
4559          "dump": true,
4560          "prealloc": false,
4561          "host-nodes": [0, 1],
4562          "policy": "bind"
4563        },
4564        {
4565          "size": 536870912,
4566          "merge": false,
4567          "dump": true,
4568          "prealloc": true,
4569          "host-nodes": [2, 3],
4570          "policy": "preferred"
4571        }
4572      ]
4573    }
4574
4575 EQMP
4576
4577     {
4578         .name       = "query-memory-devices",
4579         .args_type  = "",
4580         .mhandler.cmd_new = qmp_marshal_query_memory_devices,
4581     },
4582
4583 SQMP
4584 @query-memory-devices
4585 --------------------
4586
4587 Return a list of memory devices.
4588
4589 Example:
4590 -> { "execute": "query-memory-devices" }
4591 <- { "return": [ { "data":
4592                       { "addr": 5368709120,
4593                         "hotpluggable": true,
4594                         "hotplugged": true,
4595                         "id": "d1",
4596                         "memdev": "/objects/memX",
4597                         "node": 0,
4598                         "size": 1073741824,
4599                         "slot": 0},
4600                    "type": "dimm"
4601                  } ] }
4602 EQMP
4603
4604     {
4605         .name       = "query-acpi-ospm-status",
4606         .args_type  = "",
4607         .mhandler.cmd_new = qmp_marshal_query_acpi_ospm_status,
4608     },
4609
4610 SQMP
4611 @query-acpi-ospm-status
4612 --------------------
4613
4614 Return list of ACPIOSTInfo for devices that support status reporting
4615 via ACPI _OST method.
4616
4617 Example:
4618 -> { "execute": "query-acpi-ospm-status" }
4619 <- { "return": [ { "device": "d1", "slot": "0", "slot-type": "DIMM", "source": 1, "status": 0},
4620                  { "slot": "1", "slot-type": "DIMM", "source": 0, "status": 0},
4621                  { "slot": "2", "slot-type": "DIMM", "source": 0, "status": 0},
4622                  { "slot": "3", "slot-type": "DIMM", "source": 0, "status": 0}
4623    ]}
4624 EQMP
4625
4626 #if defined TARGET_I386
4627     {
4628         .name       = "rtc-reset-reinjection",
4629         .args_type  = "",
4630         .mhandler.cmd_new = qmp_marshal_rtc_reset_reinjection,
4631     },
4632 #endif
4633
4634 SQMP
4635 rtc-reset-reinjection
4636 ---------------------
4637
4638 Reset the RTC interrupt reinjection backlog.
4639
4640 Arguments: None.
4641
4642 Example:
4643
4644 -> { "execute": "rtc-reset-reinjection" }
4645 <- { "return": {} }
4646 EQMP
4647
4648     {
4649         .name       = "trace-event-get-state",
4650         .args_type  = "name:s",
4651         .mhandler.cmd_new = qmp_marshal_trace_event_get_state,
4652     },
4653
4654 SQMP
4655 trace-event-get-state
4656 ---------------------
4657
4658 Query the state of events.
4659
4660 Example:
4661
4662 -> { "execute": "trace-event-get-state", "arguments": { "name": "qemu_memalign" } }
4663 <- { "return": [ { "name": "qemu_memalign", "state": "disabled" } ] }
4664 EQMP
4665
4666     {
4667         .name       = "trace-event-set-state",
4668         .args_type  = "name:s,enable:b,ignore-unavailable:b?",
4669         .mhandler.cmd_new = qmp_marshal_trace_event_set_state,
4670     },
4671
4672 SQMP
4673 trace-event-set-state
4674 ---------------------
4675
4676 Set the state of events.
4677
4678 Example:
4679
4680 -> { "execute": "trace-event-set-state", "arguments": { "name": "qemu_memalign", "enable": "true" } }
4681 <- { "return": {} }
4682 EQMP
4683
4684     {
4685         .name       = "input-send-event",
4686         .args_type  = "console:i?,events:q",
4687         .mhandler.cmd_new = qmp_marshal_input_send_event,
4688     },
4689
4690 SQMP
4691 @input-send-event
4692 -----------------
4693
4694 Send input event to guest.
4695
4696 Arguments:
4697
4698 - "device": display device (json-string, optional)
4699 - "head": display head (json-int, optional)
4700 - "events": list of input events
4701
4702 The consoles are visible in the qom tree, under
4703 /backend/console[$index]. They have a device link and head property, so
4704 it is possible to map which console belongs to which device and display.
4705
4706 Note: this command is experimental, and not a stable API.
4707
4708 Example (1):
4709
4710 Press left mouse button.
4711
4712 -> { "execute": "input-send-event",
4713     "arguments": { "device": "video0",
4714                    "events": [ { "type": "btn",
4715                    "data" : { "down": true, "button": "left" } } ] } }
4716 <- { "return": {} }
4717
4718 -> { "execute": "input-send-event",
4719     "arguments": { "device": "video0",
4720                    "events": [ { "type": "btn",
4721                    "data" : { "down": false, "button": "left" } } ] } }
4722 <- { "return": {} }
4723
4724 Example (2):
4725
4726 Press ctrl-alt-del.
4727
4728 -> { "execute": "input-send-event",
4729      "arguments": { "events": [
4730         { "type": "key", "data" : { "down": true,
4731           "key": {"type": "qcode", "data": "ctrl" } } },
4732         { "type": "key", "data" : { "down": true,
4733           "key": {"type": "qcode", "data": "alt" } } },
4734         { "type": "key", "data" : { "down": true,
4735           "key": {"type": "qcode", "data": "delete" } } } ] } }
4736 <- { "return": {} }
4737
4738 Example (3):
4739
4740 Move mouse pointer to absolute coordinates (20000, 400).
4741
4742 -> { "execute": "input-send-event" ,
4743   "arguments": { "events": [
4744                { "type": "abs", "data" : { "axis": "x", "value" : 20000 } },
4745                { "type": "abs", "data" : { "axis": "y", "value" : 400 } } ] } }
4746 <- { "return": {} }
4747
4748 EQMP
4749
4750     {
4751         .name       = "block-set-write-threshold",
4752         .args_type  = "node-name:s,write-threshold:l",
4753         .mhandler.cmd_new = qmp_marshal_block_set_write_threshold,
4754     },
4755
4756 SQMP
4757 block-set-write-threshold
4758 ------------
4759
4760 Change the write threshold for a block drive. The threshold is an offset,
4761 thus must be non-negative. Default is no write threshold.
4762 Setting the threshold to zero disables it.
4763
4764 Arguments:
4765
4766 - "node-name": the node name in the block driver state graph (json-string)
4767 - "write-threshold": the write threshold in bytes (json-int)
4768
4769 Example:
4770
4771 -> { "execute": "block-set-write-threshold",
4772   "arguments": { "node-name": "mydev",
4773                  "write-threshold": 17179869184 } }
4774 <- { "return": {} }
4775
4776 EQMP
4777
4778     {
4779         .name       = "query-rocker",
4780         .args_type  = "name:s",
4781         .mhandler.cmd_new = qmp_marshal_query_rocker,
4782     },
4783
4784 SQMP
4785 Show rocker switch
4786 ------------------
4787
4788 Arguments:
4789
4790 - "name": switch name
4791
4792 Example:
4793
4794 -> { "execute": "query-rocker", "arguments": { "name": "sw1" } }
4795 <- { "return": {"name": "sw1", "ports": 2, "id": 1327446905938}}
4796
4797 EQMP
4798
4799     {
4800         .name       = "query-rocker-ports",
4801         .args_type  = "name:s",
4802         .mhandler.cmd_new = qmp_marshal_query_rocker_ports,
4803     },
4804
4805 SQMP
4806 Show rocker switch ports
4807 ------------------------
4808
4809 Arguments:
4810
4811 - "name": switch name
4812
4813 Example:
4814
4815 -> { "execute": "query-rocker-ports", "arguments": { "name": "sw1" } }
4816 <- { "return": [ {"duplex": "full", "enabled": true, "name": "sw1.1",
4817                   "autoneg": "off", "link-up": true, "speed": 10000},
4818                  {"duplex": "full", "enabled": true, "name": "sw1.2",
4819                   "autoneg": "off", "link-up": true, "speed": 10000}
4820    ]}
4821
4822 EQMP
4823
4824     {
4825         .name       = "query-rocker-of-dpa-flows",
4826         .args_type  = "name:s,tbl-id:i?",
4827         .mhandler.cmd_new = qmp_marshal_query_rocker_of_dpa_flows,
4828     },
4829
4830 SQMP
4831 Show rocker switch OF-DPA flow tables
4832 -------------------------------------
4833
4834 Arguments:
4835
4836 - "name": switch name
4837 - "tbl-id": (optional) flow table ID
4838
4839 Example:
4840
4841 -> { "execute": "query-rocker-of-dpa-flows", "arguments": { "name": "sw1" } }
4842 <- { "return": [ {"key": {"in-pport": 0, "priority": 1, "tbl-id": 0},
4843                   "hits": 138,
4844                   "cookie": 0,
4845                   "action": {"goto-tbl": 10},
4846                   "mask": {"in-pport": 4294901760}
4847                  },
4848                  {...more...},
4849    ]}
4850
4851 EQMP
4852
4853     {
4854         .name       = "query-rocker-of-dpa-groups",
4855         .args_type  = "name:s,type:i?",
4856         .mhandler.cmd_new = qmp_marshal_query_rocker_of_dpa_groups,
4857     },
4858
4859 SQMP
4860 Show rocker OF-DPA group tables
4861 -------------------------------
4862
4863 Arguments:
4864
4865 - "name": switch name
4866 - "type": (optional) group type
4867
4868 Example:
4869
4870 -> { "execute": "query-rocker-of-dpa-groups", "arguments": { "name": "sw1" } }
4871 <- { "return": [ {"type": 0, "out-pport": 2, "pport": 2, "vlan-id": 3841,
4872                   "pop-vlan": 1, "id": 251723778},
4873                  {"type": 0, "out-pport": 0, "pport": 0, "vlan-id": 3841,
4874                   "pop-vlan": 1, "id": 251723776},
4875                  {"type": 0, "out-pport": 1, "pport": 1, "vlan-id": 3840,
4876                   "pop-vlan": 1, "id": 251658241},
4877                  {"type": 0, "out-pport": 0, "pport": 0, "vlan-id": 3840,
4878                   "pop-vlan": 1, "id": 251658240}
4879    ]}
4880
4881 EQMP
4882
4883 #if defined TARGET_ARM
4884     {
4885         .name       = "query-gic-capabilities",
4886         .args_type  = "",
4887         .mhandler.cmd_new = qmp_marshal_query_gic_capabilities,
4888     },
4889 #endif
4890
4891 SQMP
4892 query-gic-capabilities
4893 ---------------
4894
4895 Return a list of GICCapability objects, describing supported GIC
4896 (Generic Interrupt Controller) versions.
4897
4898 Arguments: None
4899
4900 Example:
4901
4902 -> { "execute": "query-gic-capabilities" }
4903 <- { "return": [{ "version": 2, "emulated": true, "kernel": false },
4904                 { "version": 3, "emulated": false, "kernel": true } ] }
4905
4906 EQMP