qmp-commands.hx

   1 HXCOMM QMP dispatch table and documentation
   2 HXCOMM Text between SQMP and EQMP is copied to the QMP documention file and
   3 HXCOMM does not show up in the other formats.
   4
   5 SQMP
   6                         QMP Supported Commands
   7                         ----------------------
   8
   9 This document describes all commands currently supported by QMP.
  10
  11 Most of the time their usage is exactly the same as in the user Monitor, this
  12 means that any other document which also describe commands (the manpage,
  13 QEMU's manual, etc) can and should be consulted.
  14
  15 QMP has two types of commands: regular and query commands. Regular commands
  16 usually change the Virtual Machine's state someway, while query commands just
  17 return information. The sections below are divided accordingly.
  18
  19 It's important to observe that all communication examples are formatted in
  20 a reader-friendly way, so that they're easier to understand. However, in real
  21 protocol usage, they're emitted as a single line.
  22
  23 Also, the following notation is used to denote data flow:
  24
  25 -> data issued by the Client
  26 <- Server data response
  27
  28 Please, refer to the QMP specification (QMP/qmp-spec.txt) for detailed
  29 information on the Server command and response formats.
  30
  31 NOTE: This document is temporary and will be replaced soon.
  32
  33 1. Stability Considerations
  34 ===========================
  35
  36 The current QMP command set (described in this file) may be useful for a
  37 number of use cases, however it's limited and several commands have bad
  38 defined semantics, specially with regard to command completion.
  39
  40 These problems are going to be solved incrementally in the next QEMU releases
  41 and we're going to establish a deprecation policy for badly defined commands.
  42
  43 If you're planning to adopt QMP, please observe the following:
  44
  45     1. The deprecation policy will take effect and be documented soon, please
  46        check the documentation of each used command as soon as a new release of
  47        QEMU is available
  48
  49     2. DO NOT rely on anything which is not explicit documented
  50
  51     3. Errors, in special, are not documented. Applications should NOT check
  52        for specific errors classes or data (it's strongly recommended to only
  53        check for the "error" key)
  54
  55 2. Regular Commands
  56 ===================
  57
  58 Server's responses in the examples below are always a success response, please
  59 refer to the QMP specification for more details on error responses.
  60
  61 EQMP
  62
  63     {
  64         .name       = "quit",
  65         .args_type  = "",
  66         .mhandler.cmd_new = qmp_marshal_input_quit,
  67     },
  68
  69 SQMP
  70 quit
  71 ----
  72
  73 Quit the emulator.
  74
  75 Arguments: None.
  76
  77 Example:
  78
  79 -> { "execute": "quit" }
  80 <- { "return": {} }
  81
  82 EQMP
  83
  84     {
  85         .name       = "eject",
  86         .args_type  = "force:-f,device:B",
  87         .mhandler.cmd_new = qmp_marshal_input_eject,
  88     },
  89
  90 SQMP
  91 eject
  92 -----
  93
  94 Eject a removable medium.
  95
  96 Arguments:
  97
  98 - force: force ejection (json-bool, optional)
  99 - device: device name (json-string)
 100
 101 Example:
 102
 103 -> { "execute": "eject", "arguments": { "device": "ide1-cd0" } }
 104 <- { "return": {} }
 105
 106 Note: The "force" argument defaults to false.
 107
 108 EQMP
 109
 110     {
 111         .name       = "change",
 112         .args_type  = "device:B,target:F,arg:s?",
 113         .mhandler.cmd_new = qmp_marshal_input_change,
 114     },
 115
 116 SQMP
 117 change
 118 ------
 119
 120 Change a removable medium or VNC configuration.
 121
 122 Arguments:
 123
 124 - "device": device name (json-string)
 125 - "target": filename or item (json-string)
 126 - "arg": additional argument (json-string, optional)
 127
 128 Examples:
 129
 130 1. Change a removable medium
 131
 132 -> { "execute": "change",
 133              "arguments": { "device": "ide1-cd0",
 134                             "target": "/srv/images/Fedora-12-x86_64-DVD.iso" } }
 135 <- { "return": {} }
 136
 137 2. Change VNC password
 138
 139 -> { "execute": "change",
 140              "arguments": { "device": "vnc", "target": "password",
 141                             "arg": "foobar1" } }
 142 <- { "return": {} }
 143
 144 EQMP
 145
 146     {
 147         .name       = "screendump",
 148         .args_type  = "filename:F",
 149         .mhandler.cmd_new = qmp_marshal_input_screendump,
 150     },
 151
 152 SQMP
 153 screendump
 154 ----------
 155
 156 Save screen into PPM image.
 157
 158 Arguments:
 159
 160 - "filename": file path (json-string)
 161
 162 Example:
 163
 164 -> { "execute": "screendump", "arguments": { "filename": "/tmp/image" } }
 165 <- { "return": {} }
 166
 167 EQMP
 168
 169     {
 170         .name       = "stop",
 171         .args_type  = "",
 172         .mhandler.cmd_new = qmp_marshal_input_stop,
 173     },
 174
 175 SQMP
 176 stop
 177 ----
 178
 179 Stop the emulator.
 180
 181 Arguments: None.
 182
 183 Example:
 184
 185 -> { "execute": "stop" }
 186 <- { "return": {} }
 187
 188 EQMP
 189
 190     {
 191         .name       = "cont",
 192         .args_type  = "",
 193         .mhandler.cmd_new = qmp_marshal_input_cont,
 194     },
 195
 196 SQMP
 197 cont
 198 ----
 199
 200 Resume emulation.
 201
 202 Arguments: None.
 203
 204 Example:
 205
 206 -> { "execute": "cont" }
 207 <- { "return": {} }
 208
 209 EQMP
 210
 211     {
 212         .name       = "system_wakeup",
 213         .args_type  = "",
 214         .mhandler.cmd_new = qmp_marshal_input_system_wakeup,
 215     },
 216
 217 SQMP
 218 system_wakeup
 219 -------------
 220
 221 Wakeup guest from suspend.
 222
 223 Arguments: None.
 224
 225 Example:
 226
 227 -> { "execute": "system_wakeup" }
 228 <- { "return": {} }
 229
 230 EQMP
 231
 232     {
 233         .name       = "system_reset",
 234         .args_type  = "",
 235         .mhandler.cmd_new = qmp_marshal_input_system_reset,
 236     },
 237
 238 SQMP
 239 system_reset
 240 ------------
 241
 242 Reset the system.
 243
 244 Arguments: None.
 245
 246 Example:
 247
 248 -> { "execute": "system_reset" }
 249 <- { "return": {} }
 250
 251 EQMP
 252
 253     {
 254         .name       = "system_powerdown",
 255         .args_type  = "",
 256         .mhandler.cmd_new = qmp_marshal_input_system_powerdown,
 257     },
 258
 259 SQMP
 260 system_powerdown
 261 ----------------
 262
 263 Send system power down event.
 264
 265 Arguments: None.
 266
 267 Example:
 268
 269 -> { "execute": "system_powerdown" }
 270 <- { "return": {} }
 271
 272 EQMP
 273
 274     {
 275         .name       = "device_add",
 276         .args_type  = "device:O",
 277         .params     = "driver[,prop=value][,...]",
 278         .help       = "add device, like -device on the command line",
 279         .user_print = monitor_user_noop,
 280         .mhandler.cmd_new = do_device_add,
 281     },
 282
 283 SQMP
 284 device_add
 285 ----------
 286
 287 Add a device.
 288
 289 Arguments:
 290
 291 - "driver": the name of the new device's driver (json-string)
 292 - "bus": the device's parent bus (device tree path, json-string, optional)
 293 - "id": the device's ID, must be unique (json-string)
 294 - device properties
 295
 296 Example:
 297
 298 -> { "execute": "device_add", "arguments": { "driver": "e1000", "id": "net1" } }
 299 <- { "return": {} }
 300
 301 Notes:
 302
 303 (1) For detailed information about this command, please refer to the
 304     'docs/qdev-device-use.txt' file.
 305
 306 (2) It's possible to list device properties by running QEMU with the
 307     "-device DEVICE,\?" command-line argument, where DEVICE is the device's name
 308
 309 EQMP
 310
 311     {
 312         .name       = "device_del",
 313         .args_type  = "id:s",
 314         .mhandler.cmd_new = qmp_marshal_input_device_del,
 315     },
 316
 317 SQMP
 318 device_del
 319 ----------
 320
 321 Remove a device.
 322
 323 Arguments:
 324
 325 - "id": the device's ID (json-string)
 326
 327 Example:
 328
 329 -> { "execute": "device_del", "arguments": { "id": "net1" } }
 330 <- { "return": {} }
 331
 332 EQMP
 333
 334     {
 335         .name       = "send-key",
 336         .args_type  = "keys:O,hold-time:i?",
 337         .mhandler.cmd_new = qmp_marshal_input_send_key,
 338     },
 339
 340 SQMP
 341 send-key
 342 ----------
 343
 344 Send keys to VM.
 345
 346 Arguments:
 347
 348 keys array:
 349     - "key": key sequence (a json-array of key union values,
 350              union can be number or qcode enum)
 351
 352 - hold-time: time to delay key up events, milliseconds. Defaults to 100
 353              (json-int, optional)
 354
 355 Example:
 356
 357 -> { "execute": "send-key",
 358      "arguments": { "keys": [ { "type": "qcode", "data": "ctrl" },
 359                               { "type": "qcode", "data": "alt" },
 360                               { "type": "qcode", "data": "delete" } ] } }
 361 <- { "return": {} }
 362
 363 EQMP
 364
 365     {
 366         .name       = "cpu",
 367         .args_type  = "index:i",
 368         .mhandler.cmd_new = qmp_marshal_input_cpu,
 369     },
 370
 371 SQMP
 372 cpu
 373 ---
 374
 375 Set the default CPU.
 376
 377 Arguments:
 378
 379 - "index": the CPU's index (json-int)
 380
 381 Example:
 382
 383 -> { "execute": "cpu", "arguments": { "index": 0 } }
 384 <- { "return": {} }
 385
 386 Note: CPUs' indexes are obtained with the 'query-cpus' command.
 387
 388 EQMP
 389
 390     {
 391         .name       = "cpu-add",
 392         .args_type  = "id:i",
 393         .mhandler.cmd_new = qmp_marshal_input_cpu_add,
 394     },
 395
 396 SQMP
 397 cpu-add
 398 -------
 399
 400 Adds virtual cpu
 401
 402 Arguments:
 403
 404 - "id": cpu id (json-int)
 405
 406 Example:
 407
 408 -> { "execute": "cpu-add", "arguments": { "id": 2 } }
 409 <- { "return": {} }
 410
 411 EQMP
 412
 413     {
 414         .name       = "memsave",
 415         .args_type  = "val:l,size:i,filename:s,cpu:i?",
 416         .mhandler.cmd_new = qmp_marshal_input_memsave,
 417     },
 418
 419 SQMP
 420 memsave
 421 -------
 422
 423 Save to disk virtual memory dump starting at 'val' of size 'size'.
 424
 425 Arguments:
 426
 427 - "val": the starting address (json-int)
 428 - "size": the memory size, in bytes (json-int)
 429 - "filename": file path (json-string)
 430 - "cpu": virtual CPU index (json-int, optional)
 431
 432 Example:
 433
 434 -> { "execute": "memsave",
 435              "arguments": { "val": 10,
 436                             "size": 100,
 437                             "filename": "/tmp/virtual-mem-dump" } }
 438 <- { "return": {} }
 439
 440 EQMP
 441
 442     {
 443         .name       = "pmemsave",
 444         .args_type  = "val:l,size:i,filename:s",
 445         .mhandler.cmd_new = qmp_marshal_input_pmemsave,
 446     },
 447
 448 SQMP
 449 pmemsave
 450 --------
 451
 452 Save to disk physical memory dump starting at 'val' of size 'size'.
 453
 454 Arguments:
 455
 456 - "val": the starting address (json-int)
 457 - "size": the memory size, in bytes (json-int)
 458 - "filename": file path (json-string)
 459
 460 Example:
 461
 462 -> { "execute": "pmemsave",
 463              "arguments": { "val": 10,
 464                             "size": 100,
 465                             "filename": "/tmp/physical-mem-dump" } }
 466 <- { "return": {} }
 467
 468 EQMP
 469
 470     {
 471         .name       = "inject-nmi",
 472         .args_type  = "",
 473         .mhandler.cmd_new = qmp_marshal_input_inject_nmi,
 474     },
 475
 476 SQMP
 477 inject-nmi
 478 ----------
 479
 480 Inject an NMI on guest's CPUs.
 481
 482 Arguments: None.
 483
 484 Example:
 485
 486 -> { "execute": "inject-nmi" }
 487 <- { "return": {} }
 488
 489 Note: inject-nmi fails when the guest doesn't support injecting.
 490       Currently, only x86 (NMI) and s390x (RESTART) guests do.
 491
 492 EQMP
 493
 494     {
 495         .name       = "ringbuf-write",
 496         .args_type  = "device:s,data:s,format:s?",
 497         .mhandler.cmd_new = qmp_marshal_input_ringbuf_write,
 498     },
 499
 500 SQMP
 501 ringbuf-write
 502 -------------
 503
 504 Write to a ring buffer character device.
 505
 506 Arguments:
 507
 508 - "device": ring buffer character device name (json-string)
 509 - "data": data to write (json-string)
 510 - "format": data format (json-string, optional)
 511           - Possible values: "utf8" (default), "base64"
 512             Bug: invalid base64 is currently not rejected.
 513             Whitespace *is* invalid.
 514
 515 Example:
 516
 517 -> { "execute": "ringbuf-write",
 518                 "arguments": { "device": "foo",
 519                                "data": "abcdefgh",
 520                                "format": "utf8" } }
 521 <- { "return": {} }
 522
 523 EQMP
 524
 525     {
 526         .name       = "ringbuf-read",
 527         .args_type  = "device:s,size:i,format:s?",
 528         .mhandler.cmd_new = qmp_marshal_input_ringbuf_read,
 529     },
 530
 531 SQMP
 532 ringbuf-read
 533 -------------
 534
 535 Read from a ring buffer character device.
 536
 537 Arguments:
 538
 539 - "device": ring buffer character device name (json-string)
 540 - "size": how many bytes to read at most (json-int)
 541           - Number of data bytes, not number of characters in encoded data
 542 - "format": data format (json-string, optional)
 543           - Possible values: "utf8" (default), "base64"
 544           - Naturally, format "utf8" works only when the ring buffer
 545             contains valid UTF-8 text.  Invalid UTF-8 sequences get
 546             replaced.  Bug: replacement doesn't work.  Bug: can screw
 547             up on encountering NUL characters, after the ring buffer
 548             lost data, and when reading stops because the size limit
 549             is reached.
 550
 551 Example:
 552
 553 -> { "execute": "ringbuf-read",
 554                 "arguments": { "device": "foo",
 555                                "size": 1000,
 556                                "format": "utf8" } }
 557 <- {"return": "abcdefgh"}
 558
 559 EQMP
 560
 561     {
 562         .name       = "xen-save-devices-state",
 563         .args_type  = "filename:F",
 564     .mhandler.cmd_new = qmp_marshal_input_xen_save_devices_state,
 565     },
 566
 567 SQMP
 568 xen-save-devices-state
 569 -------
 570
 571 Save the state of all devices to file. The RAM and the block devices
 572 of the VM are not saved by this command.
 573
 574 Arguments:
 575
 576 - "filename": the file to save the state of the devices to as binary
 577 data. See xen-save-devices-state.txt for a description of the binary
 578 format.
 579
 580 Example:
 581
 582 -> { "execute": "xen-save-devices-state",
 583      "arguments": { "filename": "/tmp/save" } }
 584 <- { "return": {} }
 585
 586 EQMP
 587
 588     {
 589         .name       = "xen-set-global-dirty-log",
 590         .args_type  = "enable:b",
 591         .mhandler.cmd_new = qmp_marshal_input_xen_set_global_dirty_log,
 592     },
 593
 594 SQMP
 595 xen-set-global-dirty-log
 596 -------
 597
 598 Enable or disable the global dirty log mode.
 599
 600 Arguments:
 601
 602 - "enable": Enable it or disable it.
 603
 604 Example:
 605
 606 -> { "execute": "xen-set-global-dirty-log",
 607      "arguments": { "enable": true } }
 608 <- { "return": {} }
 609
 610 EQMP
 611
 612     {
 613         .name       = "migrate",
 614         .args_type  = "detach:-d,blk:-b,inc:-i,uri:s",
 615         .mhandler.cmd_new = qmp_marshal_input_migrate,
 616     },
 617
 618 SQMP
 619 migrate
 620 -------
 621
 622 Migrate to URI.
 623
 624 Arguments:
 625
 626 - "blk": block migration, full disk copy (json-bool, optional)
 627 - "inc": incremental disk copy (json-bool, optional)
 628 - "uri": Destination URI (json-string)
 629
 630 Example:
 631
 632 -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
 633 <- { "return": {} }
 634
 635 Notes:
 636
 637 (1) The 'query-migrate' command should be used to check migration's progress
 638     and final result (this information is provided by the 'status' member)
 639 (2) All boolean arguments default to false
 640 (3) The user Monitor's "detach" argument is invalid in QMP and should not
 641     be used
 642
 643 EQMP
 644
 645     {
 646         .name       = "migrate_cancel",
 647         .args_type  = "",
 648         .mhandler.cmd_new = qmp_marshal_input_migrate_cancel,
 649     },
 650
 651 SQMP
 652 migrate_cancel
 653 --------------
 654
 655 Cancel the current migration.
 656
 657 Arguments: None.
 658
 659 Example:
 660
 661 -> { "execute": "migrate_cancel" }
 662 <- { "return": {} }
 663
 664 EQMP
 665 {
 666         .name       = "migrate-set-cache-size",
 667         .args_type  = "value:o",
 668         .mhandler.cmd_new = qmp_marshal_input_migrate_set_cache_size,
 669     },
 670
 671 SQMP
 672 migrate-set-cache-size
 673 ----------------------
 674
 675 Set cache size to be used by XBZRLE migration, the cache size will be rounded
 676 down to the nearest power of 2
 677
 678 Arguments:
 679
 680 - "value": cache size in bytes (json-int)
 681
 682 Example:
 683
 684 -> { "execute": "migrate-set-cache-size", "arguments": { "value": 536870912 } }
 685 <- { "return": {} }
 686
 687 EQMP
 688     {
 689         .name       = "query-migrate-cache-size",
 690         .args_type  = "",
 691         .mhandler.cmd_new = qmp_marshal_input_query_migrate_cache_size,
 692     },
 693
 694 SQMP
 695 query-migrate-cache-size
 696 ------------------------
 697
 698 Show cache size to be used by XBZRLE migration
 699
 700 returns a json-object with the following information:
 701 - "size" : json-int
 702
 703 Example:
 704
 705 -> { "execute": "query-migrate-cache-size" }
 706 <- { "return": 67108864 }
 707
 708 EQMP
 709
 710     {
 711         .name       = "migrate_set_speed",
 712         .args_type  = "value:o",
 713         .mhandler.cmd_new = qmp_marshal_input_migrate_set_speed,
 714     },
 715
 716 SQMP
 717 migrate_set_speed
 718 -----------------
 719
 720 Set maximum speed for migrations.
 721
 722 Arguments:
 723
 724 - "value": maximum speed, in bytes per second (json-int)
 725
 726 Example:
 727
 728 -> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } }
 729 <- { "return": {} }
 730
 731 EQMP
 732
 733     {
 734         .name       = "migrate_set_downtime",
 735         .args_type  = "value:T",
 736         .mhandler.cmd_new = qmp_marshal_input_migrate_set_downtime,
 737     },
 738
 739 SQMP
 740 migrate_set_downtime
 741 --------------------
 742
 743 Set maximum tolerated downtime (in seconds) for migrations.
 744
 745 Arguments:
 746
 747 - "value": maximum downtime (json-number)
 748
 749 Example:
 750
 751 -> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } }
 752 <- { "return": {} }
 753
 754 EQMP
 755
 756     {
 757         .name       = "client_migrate_info",
 758         .args_type  = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
 759         .params     = "protocol hostname port tls-port cert-subject",
 760         .help       = "send migration info to spice/vnc client",
 761         .user_print = monitor_user_noop,
 762         .mhandler.cmd_async = client_migrate_info,
 763         .flags      = MONITOR_CMD_ASYNC,
 764     },
 765
 766 SQMP
 767 client_migrate_info
 768 ------------------
 769
 770 Set the spice/vnc connection info for the migration target.  The spice/vnc
 771 server will ask the spice/vnc client to automatically reconnect using the
 772 new parameters (if specified) once the vm migration finished successfully.
 773
 774 Arguments:
 775
 776 - "protocol":     protocol: "spice" or "vnc" (json-string)
 777 - "hostname":     migration target hostname (json-string)
 778 - "port":         spice/vnc tcp port for plaintext channels (json-int, optional)
 779 - "tls-port":     spice tcp port for tls-secured channels (json-int, optional)
 780 - "cert-subject": server certificate subject (json-string, optional)
 781
 782 Example:
 783
 784 -> { "execute": "client_migrate_info",
 785      "arguments": { "protocol": "spice",
 786                     "hostname": "virt42.lab.kraxel.org",
 787                     "port": 1234 } }
 788 <- { "return": {} }
 789
 790 EQMP
 791
 792     {
 793         .name       = "dump-guest-memory",
 794         .args_type  = "paging:b,protocol:s,begin:i?,end:i?,format:s?",
 795         .params     = "-p protocol [begin] [length] [format]",
 796         .help       = "dump guest memory to file",
 797         .user_print = monitor_user_noop,
 798         .mhandler.cmd_new = qmp_marshal_input_dump_guest_memory,
 799     },
 800
 801 SQMP
 802 dump
 803
 804
 805 Dump guest memory to file. The file can be processed with crash or gdb.
 806
 807 Arguments:
 808
 809 - "paging": do paging to get guest's memory mapping (json-bool)
 810 - "protocol": destination file(started with "file:") or destination file
 811               descriptor (started with "fd:") (json-string)
 812 - "begin": the starting physical address. It's optional, and should be specified
 813            with length together (json-int)
 814 - "length": the memory size, in bytes. It's optional, and should be specified
 815             with begin together (json-int)
 816 - "format": the format of guest memory dump. It's optional, and can be
 817             elf|kdump-zlib|kdump-lzo|kdump-snappy, but non-elf formats will
 818             conflict with paging and filter, ie. begin and length (json-string)
 819
 820 Example:
 821
 822 -> { "execute": "dump-guest-memory", "arguments": { "protocol": "fd:dump" } }
 823 <- { "return": {} }
 824
 825 Notes:
 826
 827 (1) All boolean arguments default to false
 828
 829 EQMP
 830
 831     {
 832         .name       = "query-dump-guest-memory-capability",
 833         .args_type  = "",
 834     .mhandler.cmd_new = qmp_marshal_input_query_dump_guest_memory_capability,
 835     },
 836
 837 SQMP
 838 query-dump-guest-memory-capability
 839 ----------
 840
 841 Show available formats for 'dump-guest-memory'
 842
 843 Example:
 844
 845 -> { "execute": "query-dump-guest-memory-capability" }
 846 <- { "return": { "formats":
 847                     ["elf", "kdump-zlib", "kdump-lzo", "kdump-snappy"] }
 848
 849 EQMP
 850
 851     {
 852         .name       = "netdev_add",
 853         .args_type  = "netdev:O",
 854         .mhandler.cmd_new = qmp_netdev_add,
 855     },
 856
 857 SQMP
 858 netdev_add
 859 ----------
 860
 861 Add host network device.
 862
 863 Arguments:
 864
 865 - "type": the device type, "tap", "user", ... (json-string)
 866 - "id": the device's ID, must be unique (json-string)
 867 - device options
 868
 869 Example:
 870
 871 -> { "execute": "netdev_add", "arguments": { "type": "user", "id": "netdev1" } }
 872 <- { "return": {} }
 873
 874 Note: The supported device options are the same ones supported by the '-netdev'
 875       command-line argument, which are listed in the '-help' output or QEMU's
 876       manual
 877
 878 EQMP
 879
 880     {
 881         .name       = "netdev_del",
 882         .args_type  = "id:s",
 883         .mhandler.cmd_new = qmp_marshal_input_netdev_del,
 884     },
 885
 886 SQMP
 887 netdev_del
 888 ----------
 889
 890 Remove host network device.
 891
 892 Arguments:
 893
 894 - "id": the device's ID, must be unique (json-string)
 895
 896 Example:
 897
 898 -> { "execute": "netdev_del", "arguments": { "id": "netdev1" } }
 899 <- { "return": {} }
 900
 901
 902 EQMP
 903
 904     {
 905         .name       = "object-add",
 906         .args_type  = "qom-type:s,id:s,props:q?",
 907         .mhandler.cmd_new = qmp_object_add,
 908     },
 909
 910 SQMP
 911 object-add
 912 ----------
 913
 914 Create QOM object.
 915
 916 Arguments:
 917
 918 - "qom-type": the object's QOM type, i.e. the class name (json-string)
 919 - "id": the object's ID, must be unique (json-string)
 920 - "props": a dictionary of object property values (optional, json-dict)
 921
 922 Example:
 923
 924 -> { "execute": "object-add", "arguments": { "qom-type": "rng-random", "id": "rng1",
 925      "props": { "filename": "/dev/hwrng" } } }
 926 <- { "return": {} }
 927
 928 EQMP
 929
 930     {
 931         .name       = "object-del",
 932         .args_type  = "id:s",
 933         .mhandler.cmd_new = qmp_marshal_input_object_del,
 934     },
 935
 936 SQMP
 937 object-del
 938 ----------
 939
 940 Remove QOM object.
 941
 942 Arguments:
 943
 944 - "id": the object's ID (json-string)
 945
 946 Example:
 947
 948 -> { "execute": "object-del", "arguments": { "id": "rng1" } }
 949 <- { "return": {} }
 950
 951
 952 EQMP
 953
 954
 955     {
 956         .name       = "block_resize",
 957         .args_type  = "device:s?,node-name:s?,size:o",
 958         .mhandler.cmd_new = qmp_marshal_input_block_resize,
 959     },
 960
 961 SQMP
 962 block_resize
 963 ------------
 964
 965 Resize a block image while a guest is running.
 966
 967 Arguments:
 968
 969 - "device": the device's ID, must be unique (json-string)
 970 - "node-name": the node name in the block driver state graph (json-string)
 971 - "size": new size
 972
 973 Example:
 974
 975 -> { "execute": "block_resize", "arguments": { "device": "scratch", "size": 1073741824 } }
 976 <- { "return": {} }
 977
 978 EQMP
 979
 980     {
 981         .name       = "block-stream",
 982         .args_type  = "device:B,base:s?,speed:o?,on-error:s?",
 983         .mhandler.cmd_new = qmp_marshal_input_block_stream,
 984     },
 985
 986     {
 987         .name       = "block-commit",
 988         .args_type  = "device:B,base:s?,top:s,speed:o?",
 989         .mhandler.cmd_new = qmp_marshal_input_block_commit,
 990     },
 991
 992 SQMP
 993 block-commit
 994 ------------
 995
 996 Live commit of data from overlay image nodes into backing nodes - i.e., writes
 997 data between 'top' and 'base' into 'base'.
 998
 999 Arguments:
1000
1001 - "device": The device's ID, must be unique (json-string)
1002 - "base": The file name of the backing image to write data into.
1003           If not specified, this is the deepest backing image
1004           (json-string, optional)
1005 - "top":  The file name of the backing image within the image chain,
1006           which contains the topmost data to be committed down.
1007
1008           If top == base, that is an error.
1009           If top == active, the job will not be completed by itself,
1010           user needs to complete the job with the block-job-complete
1011           command after getting the ready event. (Since 2.0)
1012
1013           If the base image is smaller than top, then the base image
1014           will be resized to be the same size as top.  If top is
1015           smaller than the base image, the base will not be
1016           truncated.  If you want the base image size to match the
1017           size of the smaller top, you can safely truncate it
1018           yourself once the commit operation successfully completes.
1019           (json-string)
1020 - "speed":  the maximum speed, in bytes per second (json-int, optional)
1021
1022
1023 Example:
1024
1025 -> { "execute": "block-commit", "arguments": { "device": "virtio0",
1026                                               "top": "/tmp/snap1.qcow2" } }
1027 <- { "return": {} }
1028
1029 EQMP
1030
1031     {
1032         .name       = "drive-backup",
1033         .args_type  = "sync:s,device:B,target:s,speed:i?,mode:s?,format:s?,"
1034                       "on-source-error:s?,on-target-error:s?",
1035         .mhandler.cmd_new = qmp_marshal_input_drive_backup,
1036     },
1037
1038 SQMP
1039 drive-backup
1040 ------------
1041
1042 Start a point-in-time copy of a block device to a new destination.  The
1043 status of ongoing drive-backup operations can be checked with
1044 query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
1045 The operation can be stopped before it has completed using the
1046 block-job-cancel command.
1047
1048 Arguments:
1049
1050 - "device": the name of the device which should be copied.
1051             (json-string)
1052 - "target": the target of the new image. If the file exists, or if it is a
1053             device, the existing file/device will be used as the new
1054             destination.  If it does not exist, a new file will be created.
1055             (json-string)
1056 - "format": the format of the new destination, default is to probe if 'mode' is
1057             'existing', else the format of the source
1058             (json-string, optional)
1059 - "sync": what parts of the disk image should be copied to the destination;
1060   possibilities include "full" for all the disk, "top" for only the sectors
1061   allocated in the topmost image, or "none" to only replicate new I/O
1062   (MirrorSyncMode).
1063 - "mode": whether and how QEMU should create a new image
1064           (NewImageMode, optional, default 'absolute-paths')
1065 - "speed": the maximum speed, in bytes per second (json-int, optional)
1066 - "on-source-error": the action to take on an error on the source, default
1067                      'report'.  'stop' and 'enospc' can only be used
1068                      if the block device supports io-status.
1069                      (BlockdevOnError, optional)
1070 - "on-target-error": the action to take on an error on the target, default
1071                      'report' (no limitations, since this applies to
1072                      a different block device than device).
1073                      (BlockdevOnError, optional)
1074
1075 Example:
1076 -> { "execute": "drive-backup", "arguments": { "device": "drive0",
1077                                                "sync": "full",
1078                                                "target": "backup.img" } }
1079 <- { "return": {} }
1080 EQMP
1081
1082     {
1083         .name       = "block-job-set-speed",
1084         .args_type  = "device:B,speed:o",
1085         .mhandler.cmd_new = qmp_marshal_input_block_job_set_speed,
1086     },
1087
1088     {
1089         .name       = "block-job-cancel",
1090         .args_type  = "device:B,force:b?",
1091         .mhandler.cmd_new = qmp_marshal_input_block_job_cancel,
1092     },
1093     {
1094         .name       = "block-job-pause",
1095         .args_type  = "device:B",
1096         .mhandler.cmd_new = qmp_marshal_input_block_job_pause,
1097     },
1098     {
1099         .name       = "block-job-resume",
1100         .args_type  = "device:B",
1101         .mhandler.cmd_new = qmp_marshal_input_block_job_resume,
1102     },
1103     {
1104         .name       = "block-job-complete",
1105         .args_type  = "device:B",
1106         .mhandler.cmd_new = qmp_marshal_input_block_job_complete,
1107     },
1108     {
1109         .name       = "transaction",
1110         .args_type  = "actions:q",
1111         .mhandler.cmd_new = qmp_marshal_input_transaction,
1112     },
1113
1114 SQMP
1115 transaction
1116 -----------
1117
1118 Atomically operate on one or more block devices.  The only supported operations
1119 for now are drive-backup, internal and external snapshotting.  A list of
1120 dictionaries is accepted, that contains the actions to be performed.
1121 If there is any failure performing any of the operations, all operations
1122 for the group are abandoned.
1123
1124 For external snapshots, the dictionary contains the device, the file to use for
1125 the new snapshot, and the format.  The default format, if not specified, is
1126 qcow2.
1127
1128 Each new snapshot defaults to being created by QEMU (wiping any
1129 contents if the file already exists), but it is also possible to reuse
1130 an externally-created file.  In the latter case, you should ensure that
1131 the new image file has the same contents as the current one; QEMU cannot
1132 perform any meaningful check.  Typically this is achieved by using the
1133 current image file as the backing file for the new image.
1134
1135 On failure, the original disks pre-snapshot attempt will be used.
1136
1137 For internal snapshots, the dictionary contains the device and the snapshot's
1138 name.  If an internal snapshot matching name already exists, the request will
1139 be rejected.  Only some image formats support it, for example, qcow2, rbd,
1140 and sheepdog.
1141
1142 On failure, qemu will try delete the newly created internal snapshot in the
1143 transaction.  When an I/O error occurs during deletion, the user needs to fix
1144 it later with qemu-img or other command.
1145
1146 Arguments:
1147
1148 actions array:
1149     - "type": the operation to perform.  The only supported
1150       value is "blockdev-snapshot-sync". (json-string)
1151     - "data": a dictionary.  The contents depend on the value
1152       of "type".  When "type" is "blockdev-snapshot-sync":
1153       - "device": device name to snapshot (json-string)
1154       - "node-name": graph node name to snapshot (json-string)
1155       - "snapshot-file": name of new image file (json-string)
1156       - "snapshot-node-name": graph node name of the new snapshot (json-string)
1157       - "format": format of new image (json-string, optional)
1158       - "mode": whether and how QEMU should create the snapshot file
1159         (NewImageMode, optional, default "absolute-paths")
1160       When "type" is "blockdev-snapshot-internal-sync":
1161       - "device": device name to snapshot (json-string)
1162       - "name": name of the new snapshot (json-string)
1163
1164 Example:
1165
1166 -> { "execute": "transaction",
1167      "arguments": { "actions": [
1168          { "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd0",
1169                                          "snapshot-file": "/some/place/my-image",
1170                                          "format": "qcow2" } },
1171          { "type": "blockdev-snapshot-sync", "data" : { "node-name": "myfile",
1172                                          "snapshot-file": "/some/place/my-image2",
1173                                          "snapshot-node-name": "node3432",
1174                                          "mode": "existing",
1175                                          "format": "qcow2" } },
1176          { "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd1",
1177                                          "snapshot-file": "/some/place/my-image2",
1178                                          "mode": "existing",
1179                                          "format": "qcow2" } },
1180          { "type": "blockdev-snapshot-internal-sync", "data" : {
1181                                          "device": "ide-hd2",
1182                                          "name": "snapshot0" } } ] } }
1183 <- { "return": {} }
1184
1185 EQMP
1186
1187     {
1188         .name       = "blockdev-snapshot-sync",
1189         .args_type  = "device:s?,node-name:s?,snapshot-file:s,snapshot-node-name:s?,format:s?,mode:s?",
1190         .mhandler.cmd_new = qmp_marshal_input_blockdev_snapshot_sync,
1191     },
1192
1193 SQMP
1194 blockdev-snapshot-sync
1195 ----------------------
1196
1197 Synchronous snapshot of a block device. snapshot-file specifies the
1198 target of the new image. If the file exists, or if it is a device, the
1199 snapshot will be created in the existing file/device. If does not
1200 exist, a new file will be created. format specifies the format of the
1201 snapshot image, default is qcow2.
1202
1203 Arguments:
1204
1205 - "device": device name to snapshot (json-string)
1206 - "node-name": graph node name to snapshot (json-string)
1207 - "snapshot-file": name of new image file (json-string)
1208 - "snapshot-node-name": graph node name of the new snapshot (json-string)
1209 - "mode": whether and how QEMU should create the snapshot file
1210   (NewImageMode, optional, default "absolute-paths")
1211 - "format": format of new image (json-string, optional)
1212
1213 Example:
1214
1215 -> { "execute": "blockdev-snapshot-sync", "arguments": { "device": "ide-hd0",
1216                                                          "snapshot-file":
1217                                                         "/some/place/my-image",
1218                                                         "format": "qcow2" } }
1219 <- { "return": {} }
1220
1221 EQMP
1222
1223     {
1224         .name       = "blockdev-snapshot-internal-sync",
1225         .args_type  = "device:B,name:s",
1226         .mhandler.cmd_new = qmp_marshal_input_blockdev_snapshot_internal_sync,
1227     },
1228
1229 SQMP
1230 blockdev-snapshot-internal-sync
1231 -------------------------------
1232
1233 Synchronously take an internal snapshot of a block device when the format of
1234 image used supports it.  If the name is an empty string, or a snapshot with
1235 name already exists, the operation will fail.
1236
1237 Arguments:
1238
1239 - "device": device name to snapshot (json-string)
1240 - "name": name of the new snapshot (json-string)
1241
1242 Example:
1243
1244 -> { "execute": "blockdev-snapshot-internal-sync",
1245                 "arguments": { "device": "ide-hd0",
1246                                "name": "snapshot0" }
1247    }
1248 <- { "return": {} }
1249
1250 EQMP
1251
1252     {
1253         .name       = "blockdev-snapshot-delete-internal-sync",
1254         .args_type  = "device:B,id:s?,name:s?",
1255         .mhandler.cmd_new =
1256                       qmp_marshal_input_blockdev_snapshot_delete_internal_sync,
1257     },
1258
1259 SQMP
1260 blockdev-snapshot-delete-internal-sync
1261 --------------------------------------
1262
1263 Synchronously delete an internal snapshot of a block device when the format of
1264 image used supports it.  The snapshot is identified by name or id or both.  One
1265 of name or id is required.  If the snapshot is not found, the operation will
1266 fail.
1267
1268 Arguments:
1269
1270 - "device": device name (json-string)
1271 - "id": ID of the snapshot (json-string, optional)
1272 - "name": name of the snapshot (json-string, optional)
1273
1274 Example:
1275
1276 -> { "execute": "blockdev-snapshot-delete-internal-sync",
1277                 "arguments": { "device": "ide-hd0",
1278                                "name": "snapshot0" }
1279    }
1280 <- { "return": {
1281                    "id": "1",
1282                    "name": "snapshot0",
1283                    "vm-state-size": 0,
1284                    "date-sec": 1000012,
1285                    "date-nsec": 10,
1286                    "vm-clock-sec": 100,
1287                    "vm-clock-nsec": 20
1288      }
1289    }
1290
1291 EQMP
1292
1293     {
1294         .name       = "drive-mirror",
1295         .args_type  = "sync:s,device:B,target:s,speed:i?,mode:s?,format:s?,"
1296                       "node-name:s?,replaces:s?,"
1297                       "on-source-error:s?,on-target-error:s?,"
1298                       "granularity:i?,buf-size:i?",
1299         .mhandler.cmd_new = qmp_marshal_input_drive_mirror,
1300     },
1301
1302 SQMP
1303 drive-mirror
1304 ------------
1305
1306 Start mirroring a block device's writes to a new destination. target
1307 specifies the target of the new image. If the file exists, or if it is
1308 a device, it will be used as the new destination for writes. If it does not
1309 exist, a new file will be created. format specifies the format of the
1310 mirror image, default is to probe if mode='existing', else the format
1311 of the source.
1312
1313 Arguments:
1314
1315 - "device": device name to operate on (json-string)
1316 - "target": name of new image file (json-string)
1317 - "format": format of new image (json-string, optional)
1318 - "node-name": the name of the new block driver state in the node graph
1319                (json-string, optional)
1320 - "replaces": the block driver node name to replace when finished
1321               (json-string, optional)
1322 - "mode": how an image file should be created into the target
1323   file/device (NewImageMode, optional, default 'absolute-paths')
1324 - "speed": maximum speed of the streaming job, in bytes per second
1325   (json-int)
1326 - "granularity": granularity of the dirty bitmap, in bytes (json-int, optional)
1327 - "buf_size": maximum amount of data in flight from source to target, in bytes
1328   (json-int, default 10M)
1329 - "sync": what parts of the disk image should be copied to the destination;
1330   possibilities include "full" for all the disk, "top" for only the sectors
1331   allocated in the topmost image, or "none" to only replicate new I/O
1332   (MirrorSyncMode).
1333 - "on-source-error": the action to take on an error on the source
1334   (BlockdevOnError, default 'report')
1335 - "on-target-error": the action to take on an error on the target
1336   (BlockdevOnError, default 'report')
1337
1338 The default value of the granularity is the image cluster size clamped
1339 between 4096 and 65536, if the image format defines one.  If the format
1340 does not define a cluster size, the default value of the granularity
1341 is 65536.
1342
1343
1344 Example:
1345
1346 -> { "execute": "drive-mirror", "arguments": { "device": "ide-hd0",
1347                                                "target": "/some/place/my-image",
1348                                                "sync": "full",
1349                                                "format": "qcow2" } }
1350 <- { "return": {} }
1351
1352 EQMP
1353
1354     {
1355         .name       = "balloon",
1356         .args_type  = "value:M",
1357         .mhandler.cmd_new = qmp_marshal_input_balloon,
1358     },
1359
1360 SQMP
1361 balloon
1362 -------
1363
1364 Request VM to change its memory allocation (in bytes).
1365
1366 Arguments:
1367
1368 - "value": New memory allocation (json-int)
1369
1370 Example:
1371
1372 -> { "execute": "balloon", "arguments": { "value": 536870912 } }
1373 <- { "return": {} }
1374
1375 EQMP
1376
1377     {
1378         .name       = "set_link",
1379         .args_type  = "name:s,up:b",
1380         .mhandler.cmd_new = qmp_marshal_input_set_link,
1381     },
1382
1383 SQMP
1384 set_link
1385 --------
1386
1387 Change the link status of a network adapter.
1388
1389 Arguments:
1390
1391 - "name": network device name (json-string)
1392 - "up": status is up (json-bool)
1393
1394 Example:
1395
1396 -> { "execute": "set_link", "arguments": { "name": "e1000.0", "up": false } }
1397 <- { "return": {} }
1398
1399 EQMP
1400
1401     {
1402         .name       = "getfd",
1403         .args_type  = "fdname:s",
1404         .params     = "getfd name",
1405         .help       = "receive a file descriptor via SCM rights and assign it a name",
1406         .mhandler.cmd_new = qmp_marshal_input_getfd,
1407     },
1408
1409 SQMP
1410 getfd
1411 -----
1412
1413 Receive a file descriptor via SCM rights and assign it a name.
1414
1415 Arguments:
1416
1417 - "fdname": file descriptor name (json-string)
1418
1419 Example:
1420
1421 -> { "execute": "getfd", "arguments": { "fdname": "fd1" } }
1422 <- { "return": {} }
1423
1424 Notes:
1425
1426 (1) If the name specified by the "fdname" argument already exists,
1427     the file descriptor assigned to it will be closed and replaced
1428     by the received file descriptor.
1429 (2) The 'closefd' command can be used to explicitly close the file
1430     descriptor when it is no longer needed.
1431
1432 EQMP
1433
1434     {
1435         .name       = "closefd",
1436         .args_type  = "fdname:s",
1437         .params     = "closefd name",
1438         .help       = "close a file descriptor previously passed via SCM rights",
1439         .mhandler.cmd_new = qmp_marshal_input_closefd,
1440     },
1441
1442 SQMP
1443 closefd
1444 -------
1445
1446 Close a file descriptor previously passed via SCM rights.
1447
1448 Arguments:
1449
1450 - "fdname": file descriptor name (json-string)
1451
1452 Example:
1453
1454 -> { "execute": "closefd", "arguments": { "fdname": "fd1" } }
1455 <- { "return": {} }
1456
1457 EQMP
1458
1459      {
1460         .name       = "add-fd",
1461         .args_type  = "fdset-id:i?,opaque:s?",
1462         .params     = "add-fd fdset-id opaque",
1463         .help       = "Add a file descriptor, that was passed via SCM rights, to an fd set",
1464         .mhandler.cmd_new = qmp_marshal_input_add_fd,
1465     },
1466
1467 SQMP
1468 add-fd
1469 -------
1470
1471 Add a file descriptor, that was passed via SCM rights, to an fd set.
1472
1473 Arguments:
1474
1475 - "fdset-id": The ID of the fd set to add the file descriptor to.
1476               (json-int, optional)
1477 - "opaque": A free-form string that can be used to describe the fd.
1478             (json-string, optional)
1479
1480 Return a json-object with the following information:
1481
1482 - "fdset-id": The ID of the fd set that the fd was added to. (json-int)
1483 - "fd": The file descriptor that was received via SCM rights and added to the
1484         fd set. (json-int)
1485
1486 Example:
1487
1488 -> { "execute": "add-fd", "arguments": { "fdset-id": 1 } }
1489 <- { "return": { "fdset-id": 1, "fd": 3 } }
1490
1491 Notes:
1492
1493 (1) The list of fd sets is shared by all monitor connections.
1494 (2) If "fdset-id" is not specified, a new fd set will be created.
1495
1496 EQMP
1497
1498      {
1499         .name       = "remove-fd",
1500         .args_type  = "fdset-id:i,fd:i?",
1501         .params     = "remove-fd fdset-id fd",
1502         .help       = "Remove a file descriptor from an fd set",
1503         .mhandler.cmd_new = qmp_marshal_input_remove_fd,
1504     },
1505
1506 SQMP
1507 remove-fd
1508 ---------
1509
1510 Remove a file descriptor from an fd set.
1511
1512 Arguments:
1513
1514 - "fdset-id": The ID of the fd set that the file descriptor belongs to.
1515               (json-int)
1516 - "fd": The file descriptor that is to be removed. (json-int, optional)
1517
1518 Example:
1519
1520 -> { "execute": "remove-fd", "arguments": { "fdset-id": 1, "fd": 3 } }
1521 <- { "return": {} }
1522
1523 Notes:
1524
1525 (1) The list of fd sets is shared by all monitor connections.
1526 (2) If "fd" is not specified, all file descriptors in "fdset-id" will be
1527     removed.
1528
1529 EQMP
1530
1531     {
1532         .name       = "query-fdsets",
1533         .args_type  = "",
1534         .help       = "Return information describing all fd sets",
1535         .mhandler.cmd_new = qmp_marshal_input_query_fdsets,
1536     },
1537
1538 SQMP
1539 query-fdsets
1540 -------------
1541
1542 Return information describing all fd sets.
1543
1544 Arguments: None
1545
1546 Example:
1547
1548 -> { "execute": "query-fdsets" }
1549 <- { "return": [
1550        {
1551          "fds": [
1552            {
1553              "fd": 30,
1554              "opaque": "rdonly:/path/to/file"
1555            },
1556            {
1557              "fd": 24,
1558              "opaque": "rdwr:/path/to/file"
1559            }
1560          ],
1561          "fdset-id": 1
1562        },
1563        {
1564          "fds": [
1565            {
1566              "fd": 28
1567            },
1568            {
1569              "fd": 29
1570            }
1571          ],
1572          "fdset-id": 0
1573        }
1574      ]
1575    }
1576
1577 Note: The list of fd sets is shared by all monitor connections.
1578
1579 EQMP
1580
1581     {
1582         .name       = "block_passwd",
1583         .args_type  = "device:s?,node-name:s?,password:s",
1584         .mhandler.cmd_new = qmp_marshal_input_block_passwd,
1585     },
1586
1587 SQMP
1588 block_passwd
1589 ------------
1590
1591 Set the password of encrypted block devices.
1592
1593 Arguments:
1594
1595 - "device": device name (json-string)
1596 - "node-name": name in the block driver state graph (json-string)
1597 - "password": password (json-string)
1598
1599 Example:
1600
1601 -> { "execute": "block_passwd", "arguments": { "device": "ide0-hd0",
1602                                                "password": "12345" } }
1603 <- { "return": {} }
1604
1605 EQMP
1606
1607     {
1608         .name       = "block_set_io_throttle",
1609         .args_type  = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l,bps_max:l?,bps_rd_max:l?,bps_wr_max:l?,iops_max:l?,iops_rd_max:l?,iops_wr_max:l?,iops_size:l?",
1610         .mhandler.cmd_new = qmp_marshal_input_block_set_io_throttle,
1611     },
1612
1613 SQMP
1614 block_set_io_throttle
1615 ------------
1616
1617 Change I/O throttle limits for a block drive.
1618
1619 Arguments:
1620
1621 - "device": device name (json-string)
1622 - "bps": total throughput limit in bytes per second (json-int)
1623 - "bps_rd": read throughput limit in bytes per second (json-int)
1624 - "bps_wr": write throughput limit in bytes per second (json-int)
1625 - "iops": total I/O operations per second (json-int)
1626 - "iops_rd": read I/O operations per second (json-int)
1627 - "iops_wr": write I/O operations per second (json-int)
1628 - "bps_max":  total max in bytes (json-int)
1629 - "bps_rd_max":  read max in bytes (json-int)
1630 - "bps_wr_max":  write max in bytes (json-int)
1631 - "iops_max":  total I/O operations max (json-int)
1632 - "iops_rd_max":  read I/O operations max (json-int)
1633 - "iops_wr_max":  write I/O operations max (json-int)
1634 - "iops_size":  I/O size in bytes when limiting (json-int)
1635
1636 Example:
1637
1638 -> { "execute": "block_set_io_throttle", "arguments": { "device": "virtio0",
1639                                                "bps": 1000000,
1640                                                "bps_rd": 0,
1641                                                "bps_wr": 0,
1642                                                "iops": 0,
1643                                                "iops_rd": 0,
1644                                                "iops_wr": 0,
1645                                                "bps_max": 8000000,
1646                                                "bps_rd_max": 0,
1647                                                "bps_wr_max": 0,
1648                                                "iops_max": 0,
1649                                                "iops_rd_max": 0,
1650                                                "iops_wr_max": 0,
1651                                                "iops_size": 0 } }
1652 <- { "return": {} }
1653
1654 EQMP
1655
1656     {
1657         .name       = "set_password",
1658         .args_type  = "protocol:s,password:s,connected:s?",
1659         .mhandler.cmd_new = qmp_marshal_input_set_password,
1660     },
1661
1662 SQMP
1663 set_password
1664 ------------
1665
1666 Set the password for vnc/spice protocols.
1667
1668 Arguments:
1669
1670 - "protocol": protocol name (json-string)
1671 - "password": password (json-string)
1672 - "connected": [ keep | disconnect | fail ] (josn-string, optional)
1673
1674 Example:
1675
1676 -> { "execute": "set_password", "arguments": { "protocol": "vnc",
1677                                                "password": "secret" } }
1678 <- { "return": {} }
1679
1680 EQMP
1681
1682     {
1683         .name       = "expire_password",
1684         .args_type  = "protocol:s,time:s",
1685         .mhandler.cmd_new = qmp_marshal_input_expire_password,
1686     },
1687
1688 SQMP
1689 expire_password
1690 ---------------
1691
1692 Set the password expire time for vnc/spice protocols.
1693
1694 Arguments:
1695
1696 - "protocol": protocol name (json-string)
1697 - "time": [ now | never | +secs | secs ] (json-string)
1698
1699 Example:
1700
1701 -> { "execute": "expire_password", "arguments": { "protocol": "vnc",
1702                                                   "time": "+60" } }
1703 <- { "return": {} }
1704
1705 EQMP
1706
1707     {
1708         .name       = "add_client",
1709         .args_type  = "protocol:s,fdname:s,skipauth:b?,tls:b?",
1710         .mhandler.cmd_new = qmp_marshal_input_add_client,
1711     },
1712
1713 SQMP
1714 add_client
1715 ----------
1716
1717 Add a graphics client
1718
1719 Arguments:
1720
1721 - "protocol": protocol name (json-string)
1722 - "fdname": file descriptor name (json-string)
1723 - "skipauth": whether to skip authentication (json-bool, optional)
1724 - "tls": whether to perform TLS (json-bool, optional)
1725
1726 Example:
1727
1728 -> { "execute": "add_client", "arguments": { "protocol": "vnc",
1729                                              "fdname": "myclient" } }
1730 <- { "return": {} }
1731
1732 EQMP
1733     {
1734         .name       = "qmp_capabilities",
1735         .args_type  = "",
1736         .params     = "",
1737         .help       = "enable QMP capabilities",
1738         .user_print = monitor_user_noop,
1739         .mhandler.cmd_new = do_qmp_capabilities,
1740     },
1741
1742 SQMP
1743 qmp_capabilities
1744 ----------------
1745
1746 Enable QMP capabilities.
1747
1748 Arguments: None.
1749
1750 Example:
1751
1752 -> { "execute": "qmp_capabilities" }
1753 <- { "return": {} }
1754
1755 Note: This command must be issued before issuing any other command.
1756
1757 EQMP
1758
1759     {
1760         .name       = "human-monitor-command",
1761         .args_type  = "command-line:s,cpu-index:i?",
1762         .mhandler.cmd_new = qmp_marshal_input_human_monitor_command,
1763     },
1764
1765 SQMP
1766 human-monitor-command
1767 ---------------------
1768
1769 Execute a Human Monitor command.
1770
1771 Arguments:
1772
1773 - command-line: the command name and its arguments, just like the
1774                 Human Monitor's shell (json-string)
1775 - cpu-index: select the CPU number to be used by commands which access CPU
1776              data, like 'info registers'. The Monitor selects CPU 0 if this
1777              argument is not provided (json-int, optional)
1778
1779 Example:
1780
1781 -> { "execute": "human-monitor-command", "arguments": { "command-line": "info kvm" } }
1782 <- { "return": "kvm support: enabled\r\n" }
1783
1784 Notes:
1785
1786 (1) The Human Monitor is NOT an stable interface, this means that command
1787     names, arguments and responses can change or be removed at ANY time.
1788     Applications that rely on long term stability guarantees should NOT
1789     use this command
1790
1791 (2) Limitations:
1792
1793     o This command is stateless, this means that commands that depend
1794       on state information (such as getfd) might not work
1795
1796     o Commands that prompt the user for data (eg. 'cont' when the block
1797       device is encrypted) don't currently work
1798
1799 3. Query Commands
1800 =================
1801
1802 HXCOMM Each query command below is inside a SQMP/EQMP section, do NOT change
1803 HXCOMM this! We will possibly move query commands definitions inside those
1804 HXCOMM sections, just like regular commands.
1805
1806 EQMP
1807
1808 SQMP
1809 query-version
1810 -------------
1811
1812 Show QEMU version.
1813
1814 Return a json-object with the following information:
1815
1816 - "qemu": A json-object containing three integer values:
1817     - "major": QEMU's major version (json-int)
1818     - "minor": QEMU's minor version (json-int)
1819     - "micro": QEMU's micro version (json-int)
1820 - "package": package's version (json-string)
1821
1822 Example:
1823
1824 -> { "execute": "query-version" }
1825 <- {
1826       "return":{
1827          "qemu":{
1828             "major":0,
1829             "minor":11,
1830             "micro":5
1831          },
1832          "package":""
1833       }
1834    }
1835
1836 EQMP
1837
1838     {
1839         .name       = "query-version",
1840         .args_type  = "",
1841         .mhandler.cmd_new = qmp_marshal_input_query_version,
1842     },
1843
1844 SQMP
1845 query-commands
1846 --------------
1847
1848 List QMP available commands.
1849
1850 Each command is represented by a json-object, the returned value is a json-array
1851 of all commands.
1852
1853 Each json-object contain:
1854
1855 - "name": command's name (json-string)
1856
1857 Example:
1858
1859 -> { "execute": "query-commands" }
1860 <- {
1861       "return":[
1862          {
1863             "name":"query-balloon"
1864          },
1865          {
1866             "name":"system_powerdown"
1867          }
1868       ]
1869    }
1870
1871 Note: This example has been shortened as the real response is too long.
1872
1873 EQMP
1874
1875     {
1876         .name       = "query-commands",
1877         .args_type  = "",
1878         .mhandler.cmd_new = qmp_marshal_input_query_commands,
1879     },
1880
1881 SQMP
1882 query-events
1883 --------------
1884
1885 List QMP available events.
1886
1887 Each event is represented by a json-object, the returned value is a json-array
1888 of all events.
1889
1890 Each json-object contains:
1891
1892 - "name": event's name (json-string)
1893
1894 Example:
1895
1896 -> { "execute": "query-events" }
1897 <- {
1898       "return":[
1899          {
1900             "name":"SHUTDOWN"
1901          },
1902          {
1903             "name":"RESET"
1904          }
1905       ]
1906    }
1907
1908 Note: This example has been shortened as the real response is too long.
1909
1910 EQMP
1911
1912     {
1913         .name       = "query-events",
1914         .args_type  = "",
1915         .mhandler.cmd_new = qmp_marshal_input_query_events,
1916     },
1917
1918 SQMP
1919 query-chardev
1920 -------------
1921
1922 Each device is represented by a json-object. The returned value is a json-array
1923 of all devices.
1924
1925 Each json-object contain the following:
1926
1927 - "label": device's label (json-string)
1928 - "filename": device's file (json-string)
1929 - "frontend-open": open/closed state of the frontend device attached to this
1930                    backend (json-bool)
1931
1932 Example:
1933
1934 -> { "execute": "query-chardev" }
1935 <- {
1936       "return": [
1937          {
1938             "label": "charchannel0",
1939             "filename": "unix:/var/lib/libvirt/qemu/seabios.rhel6.agent,server",
1940             "frontend-open": false
1941          },
1942          {
1943             "label": "charmonitor",
1944             "filename": "unix:/var/lib/libvirt/qemu/seabios.rhel6.monitor,server",
1945             "frontend-open": true
1946          },
1947          {
1948             "label": "charserial0",
1949             "filename": "pty:/dev/pts/2",
1950             "frontend-open": true
1951          }
1952       ]
1953    }
1954
1955 EQMP
1956
1957     {
1958         .name       = "query-chardev",
1959         .args_type  = "",
1960         .mhandler.cmd_new = qmp_marshal_input_query_chardev,
1961     },
1962
1963 SQMP
1964 query-chardev-backends
1965 -------------
1966
1967 List available character device backends.
1968
1969 Each backend is represented by a json-object, the returned value is a json-array
1970 of all backends.
1971
1972 Each json-object contains:
1973
1974 - "name": backend name (json-string)
1975
1976 Example:
1977
1978 -> { "execute": "query-chardev-backends" }
1979 <- {
1980       "return":[
1981          {
1982             "name":"udp"
1983          },
1984          {
1985             "name":"tcp"
1986          },
1987          {
1988             "name":"unix"
1989          },
1990          {
1991             "name":"spiceport"
1992          }
1993       ]
1994    }
1995
1996 EQMP
1997
1998     {
1999         .name       = "query-chardev-backends",
2000         .args_type  = "",
2001         .mhandler.cmd_new = qmp_marshal_input_query_chardev_backends,
2002     },
2003
2004 SQMP
2005 query-block
2006 -----------
2007
2008 Show the block devices.
2009
2010 Each block device information is stored in a json-object and the returned value
2011 is a json-array of all devices.
2012
2013 Each json-object contain the following:
2014
2015 - "device": device name (json-string)
2016 - "type": device type (json-string)
2017          - deprecated, retained for backward compatibility
2018          - Possible values: "unknown"
2019 - "removable": true if the device is removable, false otherwise (json-bool)
2020 - "locked": true if the device is locked, false otherwise (json-bool)
2021 - "tray_open": only present if removable, true if the device has a tray,
2022                and it is open (json-bool)
2023 - "inserted": only present if the device is inserted, it is a json-object
2024    containing the following:
2025          - "file": device file name (json-string)
2026          - "ro": true if read-only, false otherwise (json-bool)
2027          - "drv": driver format name (json-string)
2028              - Possible values: "blkdebug", "bochs", "cloop", "cow", "dmg",
2029                                 "file", "file", "ftp", "ftps", "host_cdrom",
2030                                 "host_device", "host_floppy", "http", "https",
2031                                 "nbd", "parallels", "qcow", "qcow2", "raw",
2032                                 "tftp", "vdi", "vmdk", "vpc", "vvfat"
2033          - "backing_file": backing file name (json-string, optional)
2034          - "backing_file_depth": number of files in the backing file chain (json-int)
2035          - "encrypted": true if encrypted, false otherwise (json-bool)
2036          - "bps": limit total bytes per second (json-int)
2037          - "bps_rd": limit read bytes per second (json-int)
2038          - "bps_wr": limit write bytes per second (json-int)
2039          - "iops": limit total I/O operations per second (json-int)
2040          - "iops_rd": limit read operations per second (json-int)
2041          - "iops_wr": limit write operations per second (json-int)
2042          - "bps_max":  total max in bytes (json-int)
2043          - "bps_rd_max":  read max in bytes (json-int)
2044          - "bps_wr_max":  write max in bytes (json-int)
2045          - "iops_max":  total I/O operations max (json-int)
2046          - "iops_rd_max":  read I/O operations max (json-int)
2047          - "iops_wr_max":  write I/O operations max (json-int)
2048          - "iops_size": I/O size when limiting by iops (json-int)
2049          - "detect_zeroes": detect and optimize zero writing (json-string)
2050              - Possible values: "off", "on", "unmap"
2051          - "image": the detail of the image, it is a json-object containing
2052             the following:
2053              - "filename": image file name (json-string)
2054              - "format": image format (json-string)
2055              - "virtual-size": image capacity in bytes (json-int)
2056              - "dirty-flag": true if image is not cleanly closed, not present
2057                              means clean (json-bool, optional)
2058              - "actual-size": actual size on disk in bytes of the image, not
2059                               present when image does not support thin
2060                               provision (json-int, optional)
2061              - "cluster-size": size of a cluster in bytes, not present if image
2062                                format does not support it (json-int, optional)
2063              - "encrypted": true if the image is encrypted, not present means
2064                             false or the image format does not support
2065                             encryption (json-bool, optional)
2066              - "backing_file": backing file name, not present means no backing
2067                                file is used or the image format does not
2068                                support backing file chain
2069                                (json-string, optional)
2070              - "full-backing-filename": full path of the backing file, not
2071                                         present if it equals backing_file or no
2072                                         backing file is used
2073                                         (json-string, optional)
2074              - "backing-filename-format": the format of the backing file, not
2075                                           present means unknown or no backing
2076                                           file (json-string, optional)
2077              - "snapshots": the internal snapshot info, it is an optional list
2078                 of json-object containing the following:
2079                  - "id": unique snapshot id (json-string)
2080                  - "name": snapshot name (json-string)
2081                  - "vm-state-size": size of the VM state in bytes (json-int)
2082                  - "date-sec": UTC date of the snapshot in seconds (json-int)
2083                  - "date-nsec": fractional part in nanoseconds to be used with
2084                                 date-sec (json-int)
2085                  - "vm-clock-sec": VM clock relative to boot in seconds
2086                                    (json-int)
2087                  - "vm-clock-nsec": fractional part in nanoseconds to be used
2088                                     with vm-clock-sec (json-int)
2089              - "backing-image": the detail of the backing image, it is an
2090                                 optional json-object only present when a
2091                                 backing image present for this image
2092
2093 - "io-status": I/O operation status, only present if the device supports it
2094                and the VM is configured to stop on errors. It's always reset
2095                to "ok" when the "cont" command is issued (json_string, optional)
2096              - Possible values: "ok", "failed", "nospace"
2097
2098 Example:
2099
2100 -> { "execute": "query-block" }
2101 <- {
2102       "return":[
2103          {
2104             "io-status": "ok",
2105             "device":"ide0-hd0",
2106             "locked":false,
2107             "removable":false,
2108             "inserted":{
2109                "ro":false,
2110                "drv":"qcow2",
2111                "encrypted":false,
2112                "file":"disks/test.qcow2",
2113                "backing_file_depth":1,
2114                "bps":1000000,
2115                "bps_rd":0,
2116                "bps_wr":0,
2117                "iops":1000000,
2118                "iops_rd":0,
2119                "iops_wr":0,
2120                "bps_max": 8000000,
2121                "bps_rd_max": 0,
2122                "bps_wr_max": 0,
2123                "iops_max": 0,
2124                "iops_rd_max": 0,
2125                "iops_wr_max": 0,
2126                "iops_size": 0,
2127                "detect_zeroes": "on",
2128                "image":{
2129                   "filename":"disks/test.qcow2",
2130                   "format":"qcow2",
2131                   "virtual-size":2048000,
2132                   "backing_file":"base.qcow2",
2133                   "full-backing-filename":"disks/base.qcow2",
2134                   "backing-filename-format:"qcow2",
2135                   "snapshots":[
2136                      {
2137                         "id": "1",
2138                         "name": "snapshot1",
2139                         "vm-state-size": 0,
2140                         "date-sec": 10000200,
2141                         "date-nsec": 12,
2142                         "vm-clock-sec": 206,
2143                         "vm-clock-nsec": 30
2144                      }
2145                   ],
2146                   "backing-image":{
2147                       "filename":"disks/base.qcow2",
2148                       "format":"qcow2",
2149                       "virtual-size":2048000
2150                   }
2151                }
2152             },
2153             "type":"unknown"
2154          },
2155          {
2156             "io-status": "ok",
2157             "device":"ide1-cd0",
2158             "locked":false,
2159             "removable":true,
2160             "type":"unknown"
2161          },
2162          {
2163             "device":"floppy0",
2164             "locked":false,
2165             "removable":true,
2166             "type":"unknown"
2167          },
2168          {
2169             "device":"sd0",
2170             "locked":false,
2171             "removable":true,
2172             "type":"unknown"
2173          }
2174       ]
2175    }
2176
2177 EQMP
2178
2179     {
2180         .name       = "query-block",
2181         .args_type  = "",
2182         .mhandler.cmd_new = qmp_marshal_input_query_block,
2183     },
2184
2185 SQMP
2186 query-blockstats
2187 ----------------
2188
2189 Show block device statistics.
2190
2191 Each device statistic information is stored in a json-object and the returned
2192 value is a json-array of all devices.
2193
2194 Each json-object contain the following:
2195
2196 - "device": device name (json-string)
2197 - "stats": A json-object with the statistics information, it contains:
2198     - "rd_bytes": bytes read (json-int)
2199     - "wr_bytes": bytes written (json-int)
2200     - "rd_operations": read operations (json-int)
2201     - "wr_operations": write operations (json-int)
2202     - "flush_operations": cache flush operations (json-int)
2203     - "wr_total_time_ns": total time spend on writes in nano-seconds (json-int)
2204     - "rd_total_time_ns": total time spend on reads in nano-seconds (json-int)
2205     - "flush_total_time_ns": total time spend on cache flushes in nano-seconds (json-int)
2206     - "wr_highest_offset": Highest offset of a sector written since the
2207                            BlockDriverState has been opened (json-int)
2208 - "parent": Contains recursively the statistics of the underlying
2209             protocol (e.g. the host file for a qcow2 image). If there is
2210             no underlying protocol, this field is omitted
2211             (json-object, optional)
2212
2213 Example:
2214
2215 -> { "execute": "query-blockstats" }
2216 <- {
2217       "return":[
2218          {
2219             "device":"ide0-hd0",
2220             "parent":{
2221                "stats":{
2222                   "wr_highest_offset":3686448128,
2223                   "wr_bytes":9786368,
2224                   "wr_operations":751,
2225                   "rd_bytes":122567168,
2226                   "rd_operations":36772
2227                   "wr_total_times_ns":313253456
2228                   "rd_total_times_ns":3465673657
2229                   "flush_total_times_ns":49653
2230                   "flush_operations":61,
2231                }
2232             },
2233             "stats":{
2234                "wr_highest_offset":2821110784,
2235                "wr_bytes":9786368,
2236                "wr_operations":692,
2237                "rd_bytes":122739200,
2238                "rd_operations":36604
2239                "flush_operations":51,
2240                "wr_total_times_ns":313253456
2241                "rd_total_times_ns":3465673657
2242                "flush_total_times_ns":49653
2243             }
2244          },
2245          {
2246             "device":"ide1-cd0",
2247             "stats":{
2248                "wr_highest_offset":0,
2249                "wr_bytes":0,
2250                "wr_operations":0,
2251                "rd_bytes":0,
2252                "rd_operations":0
2253                "flush_operations":0,
2254                "wr_total_times_ns":0
2255                "rd_total_times_ns":0
2256                "flush_total_times_ns":0
2257             }
2258          },
2259          {
2260             "device":"floppy0",
2261             "stats":{
2262                "wr_highest_offset":0,
2263                "wr_bytes":0,
2264                "wr_operations":0,
2265                "rd_bytes":0,
2266                "rd_operations":0
2267                "flush_operations":0,
2268                "wr_total_times_ns":0
2269                "rd_total_times_ns":0
2270                "flush_total_times_ns":0
2271             }
2272          },
2273          {
2274             "device":"sd0",
2275             "stats":{
2276                "wr_highest_offset":0,
2277                "wr_bytes":0,
2278                "wr_operations":0,
2279                "rd_bytes":0,
2280                "rd_operations":0
2281                "flush_operations":0,
2282                "wr_total_times_ns":0
2283                "rd_total_times_ns":0
2284                "flush_total_times_ns":0
2285             }
2286          }
2287       ]
2288    }
2289
2290 EQMP
2291
2292     {
2293         .name       = "query-blockstats",
2294         .args_type  = "",
2295         .mhandler.cmd_new = qmp_marshal_input_query_blockstats,
2296     },
2297
2298 SQMP
2299 query-cpus
2300 ----------
2301
2302 Show CPU information.
2303
2304 Return a json-array. Each CPU is represented by a json-object, which contains:
2305
2306 - "CPU": CPU index (json-int)
2307 - "current": true if this is the current CPU, false otherwise (json-bool)
2308 - "halted": true if the cpu is halted, false otherwise (json-bool)
2309 - Current program counter. The key's name depends on the architecture:
2310      "pc": i386/x86_64 (json-int)
2311      "nip": PPC (json-int)
2312      "pc" and "npc": sparc (json-int)
2313      "PC": mips (json-int)
2314 - "thread_id": ID of the underlying host thread (json-int)
2315
2316 Example:
2317
2318 -> { "execute": "query-cpus" }
2319 <- {
2320       "return":[
2321          {
2322             "CPU":0,
2323             "current":true,
2324             "halted":false,
2325             "pc":3227107138
2326             "thread_id":3134
2327          },
2328          {
2329             "CPU":1,
2330             "current":false,
2331             "halted":true,
2332             "pc":7108165
2333             "thread_id":3135
2334          }
2335       ]
2336    }
2337
2338 EQMP
2339
2340     {
2341         .name       = "query-cpus",
2342         .args_type  = "",
2343         .mhandler.cmd_new = qmp_marshal_input_query_cpus,
2344     },
2345
2346 SQMP
2347 query-iothreads
2348 ---------------
2349
2350 Returns a list of information about each iothread.
2351
2352 Note this list excludes the QEMU main loop thread, which is not declared
2353 using the -object iothread command-line option.  It is always the main thread
2354 of the process.
2355
2356 Return a json-array. Each iothread is represented by a json-object, which contains:
2357
2358 - "id": name of iothread (json-str)
2359 - "thread-id": ID of the underlying host thread (json-int)
2360
2361 Example:
2362
2363 -> { "execute": "query-iothreads" }
2364 <- {
2365       "return":[
2366          {
2367             "id":"iothread0",
2368             "thread-id":3134
2369          },
2370          {
2371             "id":"iothread1",
2372             "thread-id":3135
2373          }
2374       ]
2375    }
2376
2377 EQMP
2378
2379     {
2380         .name       = "query-iothreads",
2381         .args_type  = "",
2382         .mhandler.cmd_new = qmp_marshal_input_query_iothreads,
2383     },
2384
2385 SQMP
2386 query-pci
2387 ---------
2388
2389 PCI buses and devices information.
2390
2391 The returned value is a json-array of all buses. Each bus is represented by
2392 a json-object, which has a key with a json-array of all PCI devices attached
2393 to it. Each device is represented by a json-object.
2394
2395 The bus json-object contains the following:
2396
2397 - "bus": bus number (json-int)
2398 - "devices": a json-array of json-objects, each json-object represents a
2399              PCI device
2400
2401 The PCI device json-object contains the following:
2402
2403 - "bus": identical to the parent's bus number (json-int)
2404 - "slot": slot number (json-int)
2405 - "function": function number (json-int)
2406 - "class_info": a json-object containing:
2407      - "desc": device class description (json-string, optional)
2408      - "class": device class number (json-int)
2409 - "id": a json-object containing:
2410      - "device": device ID (json-int)
2411      - "vendor": vendor ID (json-int)
2412 - "irq": device's IRQ if assigned (json-int, optional)
2413 - "qdev_id": qdev id string (json-string)
2414 - "pci_bridge": It's a json-object, only present if this device is a
2415                 PCI bridge, contains:
2416      - "bus": bus number (json-int)
2417      - "secondary": secondary bus number (json-int)
2418      - "subordinate": subordinate bus number (json-int)
2419      - "io_range": I/O memory range information, a json-object with the
2420                    following members:
2421                  - "base": base address, in bytes (json-int)
2422                  - "limit": limit address, in bytes (json-int)
2423      - "memory_range": memory range information, a json-object with the
2424                        following members:
2425                  - "base": base address, in bytes (json-int)
2426                  - "limit": limit address, in bytes (json-int)
2427      - "prefetchable_range": Prefetchable memory range information, a
2428                              json-object with the following members:
2429                  - "base": base address, in bytes (json-int)
2430                  - "limit": limit address, in bytes (json-int)
2431      - "devices": a json-array of PCI devices if there's any attached, each
2432                   each element is represented by a json-object, which contains
2433                   the same members of the 'PCI device json-object' described
2434                   above (optional)
2435 - "regions": a json-array of json-objects, each json-object represents a
2436              memory region of this device
2437
2438 The memory range json-object contains the following:
2439
2440 - "base": base memory address (json-int)
2441 - "limit": limit value (json-int)
2442
2443 The region json-object can be an I/O region or a memory region, an I/O region
2444 json-object contains the following:
2445
2446 - "type": "io" (json-string, fixed)
2447 - "bar": BAR number (json-int)
2448 - "address": memory address (json-int)
2449 - "size": memory size (json-int)
2450
2451 A memory region json-object contains the following:
2452
2453 - "type": "memory" (json-string, fixed)
2454 - "bar": BAR number (json-int)
2455 - "address": memory address (json-int)
2456 - "size": memory size (json-int)
2457 - "mem_type_64": true or false (json-bool)
2458 - "prefetch": true or false (json-bool)
2459
2460 Example:
2461
2462 -> { "execute": "query-pci" }
2463 <- {
2464       "return":[
2465          {
2466             "bus":0,
2467             "devices":[
2468                {
2469                   "bus":0,
2470                   "qdev_id":"",
2471                   "slot":0,
2472                   "class_info":{
2473                      "class":1536,
2474                      "desc":"Host bridge"
2475                   },
2476                   "id":{
2477                      "device":32902,
2478                      "vendor":4663
2479                   },
2480                   "function":0,
2481                   "regions":[
2482
2483                   ]
2484                },
2485                {
2486                   "bus":0,
2487                   "qdev_id":"",
2488                   "slot":1,
2489                   "class_info":{
2490                      "class":1537,
2491                      "desc":"ISA bridge"
2492                   },
2493                   "id":{
2494                      "device":32902,
2495                      "vendor":28672
2496                   },
2497                   "function":0,
2498                   "regions":[
2499
2500                   ]
2501                },
2502                {
2503                   "bus":0,
2504                   "qdev_id":"",
2505                   "slot":1,
2506                   "class_info":{
2507                      "class":257,
2508                      "desc":"IDE controller"
2509                   },
2510                   "id":{
2511                      "device":32902,
2512                      "vendor":28688
2513                   },
2514                   "function":1,
2515                   "regions":[
2516                      {
2517                         "bar":4,
2518                         "size":16,
2519                         "address":49152,
2520                         "type":"io"
2521                      }
2522                   ]
2523                },
2524                {
2525                   "bus":0,
2526                   "qdev_id":"",
2527                   "slot":2,
2528                   "class_info":{
2529                      "class":768,
2530                      "desc":"VGA controller"
2531                   },
2532                   "id":{
2533                      "device":4115,
2534                      "vendor":184
2535                   },
2536                   "function":0,
2537                   "regions":[
2538                      {
2539                         "prefetch":true,
2540                         "mem_type_64":false,
2541                         "bar":0,
2542                         "size":33554432,
2543                         "address":4026531840,
2544                         "type":"memory"
2545                      },
2546                      {
2547                         "prefetch":false,
2548                         "mem_type_64":false,
2549                         "bar":1,
2550                         "size":4096,
2551                         "address":4060086272,
2552                         "type":"memory"
2553                      },
2554                      {
2555                         "prefetch":false,
2556                         "mem_type_64":false,
2557                         "bar":6,
2558                         "size":65536,
2559                         "address":-1,
2560                         "type":"memory"
2561                      }
2562                   ]
2563                },
2564                {
2565                   "bus":0,
2566                   "qdev_id":"",
2567                   "irq":11,
2568                   "slot":4,
2569                   "class_info":{
2570                      "class":1280,
2571                      "desc":"RAM controller"
2572                   },
2573                   "id":{
2574                      "device":6900,
2575                      "vendor":4098
2576                   },
2577                   "function":0,
2578                   "regions":[
2579                      {
2580                         "bar":0,
2581                         "size":32,
2582                         "address":49280,
2583                         "type":"io"
2584                      }
2585                   ]
2586                }
2587             ]
2588          }
2589       ]
2590    }
2591
2592 Note: This example has been shortened as the real response is too long.
2593
2594 EQMP
2595
2596     {
2597         .name       = "query-pci",
2598         .args_type  = "",
2599         .mhandler.cmd_new = qmp_marshal_input_query_pci,
2600     },
2601
2602 SQMP
2603 query-kvm
2604 ---------
2605
2606 Show KVM information.
2607
2608 Return a json-object with the following information:
2609
2610 - "enabled": true if KVM support is enabled, false otherwise (json-bool)
2611 - "present": true if QEMU has KVM support, false otherwise (json-bool)
2612
2613 Example:
2614
2615 -> { "execute": "query-kvm" }
2616 <- { "return": { "enabled": true, "present": true } }
2617
2618 EQMP
2619
2620     {
2621         .name       = "query-kvm",
2622         .args_type  = "",
2623         .mhandler.cmd_new = qmp_marshal_input_query_kvm,
2624     },
2625
2626 SQMP
2627 query-status
2628 ------------
2629
2630 Return a json-object with the following information:
2631
2632 - "running": true if the VM is running, or false if it is paused (json-bool)
2633 - "singlestep": true if the VM is in single step mode,
2634                 false otherwise (json-bool)
2635 - "status": one of the following values (json-string)
2636     "debug" - QEMU is running on a debugger
2637     "inmigrate" - guest is paused waiting for an incoming migration
2638     "internal-error" - An internal error that prevents further guest
2639     execution has occurred
2640     "io-error" - the last IOP has failed and the device is configured
2641     to pause on I/O errors
2642     "paused" - guest has been paused via the 'stop' command
2643     "postmigrate" - guest is paused following a successful 'migrate'
2644     "prelaunch" - QEMU was started with -S and guest has not started
2645     "finish-migrate" - guest is paused to finish the migration process
2646     "restore-vm" - guest is paused to restore VM state
2647     "running" - guest is actively running
2648     "save-vm" - guest is paused to save the VM state
2649     "shutdown" - guest is shut down (and -no-shutdown is in use)
2650     "watchdog" - the watchdog action is configured to pause and
2651      has been triggered
2652
2653 Example:
2654
2655 -> { "execute": "query-status" }
2656 <- { "return": { "running": true, "singlestep": false, "status": "running" } }
2657
2658 EQMP
2659
2660     {
2661         .name       = "query-status",
2662         .args_type  = "",
2663         .mhandler.cmd_new = qmp_marshal_input_query_status,
2664     },
2665
2666 SQMP
2667 query-mice
2668 ----------
2669
2670 Show VM mice information.
2671
2672 Each mouse is represented by a json-object, the returned value is a json-array
2673 of all mice.
2674
2675 The mouse json-object contains the following:
2676
2677 - "name": mouse's name (json-string)
2678 - "index": mouse's index (json-int)
2679 - "current": true if this mouse is receiving events, false otherwise (json-bool)
2680 - "absolute": true if the mouse generates absolute input events (json-bool)
2681
2682 Example:
2683
2684 -> { "execute": "query-mice" }
2685 <- {
2686       "return":[
2687          {
2688             "name":"QEMU Microsoft Mouse",
2689             "index":0,
2690             "current":false,
2691             "absolute":false
2692          },
2693          {
2694             "name":"QEMU PS/2 Mouse",
2695             "index":1,
2696             "current":true,
2697             "absolute":true
2698          }
2699       ]
2700    }
2701
2702 EQMP
2703
2704     {
2705         .name       = "query-mice",
2706         .args_type  = "",
2707         .mhandler.cmd_new = qmp_marshal_input_query_mice,
2708     },
2709
2710 SQMP
2711 query-vnc
2712 ---------
2713
2714 Show VNC server information.
2715
2716 Return a json-object with server information. Connected clients are returned
2717 as a json-array of json-objects.
2718
2719 The main json-object contains the following:
2720
2721 - "enabled": true or false (json-bool)
2722 - "host": server's IP address (json-string)
2723 - "family": address family (json-string)
2724          - Possible values: "ipv4", "ipv6", "unix", "unknown"
2725 - "service": server's port number (json-string)
2726 - "auth": authentication method (json-string)
2727          - Possible values: "invalid", "none", "ra2", "ra2ne", "sasl", "tight",
2728                             "tls", "ultra", "unknown", "vencrypt", "vencrypt",
2729                             "vencrypt+plain", "vencrypt+tls+none",
2730                             "vencrypt+tls+plain", "vencrypt+tls+sasl",
2731                             "vencrypt+tls+vnc", "vencrypt+x509+none",
2732                             "vencrypt+x509+plain", "vencrypt+x509+sasl",
2733                             "vencrypt+x509+vnc", "vnc"
2734 - "clients": a json-array of all connected clients
2735
2736 Clients are described by a json-object, each one contain the following:
2737
2738 - "host": client's IP address (json-string)
2739 - "family": address family (json-string)
2740          - Possible values: "ipv4", "ipv6", "unix", "unknown"
2741 - "service": client's port number (json-string)
2742 - "x509_dname": TLS dname (json-string, optional)
2743 - "sasl_username": SASL username (json-string, optional)
2744
2745 Example:
2746
2747 -> { "execute": "query-vnc" }
2748 <- {
2749       "return":{
2750          "enabled":true,
2751          "host":"0.0.0.0",
2752          "service":"50402",
2753          "auth":"vnc",
2754          "family":"ipv4",
2755          "clients":[
2756             {
2757                "host":"127.0.0.1",
2758                "service":"50401",
2759                "family":"ipv4"
2760             }
2761          ]
2762       }
2763    }
2764
2765 EQMP
2766
2767     {
2768         .name       = "query-vnc",
2769         .args_type  = "",
2770         .mhandler.cmd_new = qmp_marshal_input_query_vnc,
2771     },
2772
2773 SQMP
2774 query-spice
2775 -----------
2776
2777 Show SPICE server information.
2778
2779 Return a json-object with server information. Connected clients are returned
2780 as a json-array of json-objects.
2781
2782 The main json-object contains the following:
2783
2784 - "enabled": true or false (json-bool)
2785 - "host": server's IP address (json-string)
2786 - "port": server's port number (json-int, optional)
2787 - "tls-port": server's port number (json-int, optional)
2788 - "auth": authentication method (json-string)
2789          - Possible values: "none", "spice"
2790 - "channels": a json-array of all active channels clients
2791
2792 Channels are described by a json-object, each one contain the following:
2793
2794 - "host": client's IP address (json-string)
2795 - "family": address family (json-string)
2796          - Possible values: "ipv4", "ipv6", "unix", "unknown"
2797 - "port": client's port number (json-string)
2798 - "connection-id": spice connection id.  All channels with the same id
2799                    belong to the same spice session (json-int)
2800 - "channel-type": channel type.  "1" is the main control channel, filter for
2801                   this one if you want track spice sessions only (json-int)
2802 - "channel-id": channel id.  Usually "0", might be different needed when
2803                 multiple channels of the same type exist, such as multiple
2804                 display channels in a multihead setup (json-int)
2805 - "tls": whevener the channel is encrypted (json-bool)
2806
2807 Example:
2808
2809 -> { "execute": "query-spice" }
2810 <- {
2811       "return": {
2812          "enabled": true,
2813          "auth": "spice",
2814          "port": 5920,
2815          "tls-port": 5921,
2816          "host": "0.0.0.0",
2817          "channels": [
2818             {
2819                "port": "54924",
2820                "family": "ipv4",
2821                "channel-type": 1,
2822                "connection-id": 1804289383,
2823                "host": "127.0.0.1",
2824                "channel-id": 0,
2825                "tls": true
2826             },
2827             {
2828                "port": "36710",
2829                "family": "ipv4",
2830                "channel-type": 4,
2831                "connection-id": 1804289383,
2832                "host": "127.0.0.1",
2833                "channel-id": 0,
2834                "tls": false
2835             },
2836             [ ... more channels follow ... ]
2837          ]
2838       }
2839    }
2840
2841 EQMP
2842
2843 #if defined(CONFIG_SPICE)
2844     {
2845         .name       = "query-spice",
2846         .args_type  = "",
2847         .mhandler.cmd_new = qmp_marshal_input_query_spice,
2848     },
2849 #endif
2850
2851 SQMP
2852 query-name
2853 ----------
2854
2855 Show VM name.
2856
2857 Return a json-object with the following information:
2858
2859 - "name": VM's name (json-string, optional)
2860
2861 Example:
2862
2863 -> { "execute": "query-name" }
2864 <- { "return": { "name": "qemu-name" } }
2865
2866 EQMP
2867
2868     {
2869         .name       = "query-name",
2870         .args_type  = "",
2871         .mhandler.cmd_new = qmp_marshal_input_query_name,
2872     },
2873
2874 SQMP
2875 query-uuid
2876 ----------
2877
2878 Show VM UUID.
2879
2880 Return a json-object with the following information:
2881
2882 - "UUID": Universally Unique Identifier (json-string)
2883
2884 Example:
2885
2886 -> { "execute": "query-uuid" }
2887 <- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } }
2888
2889 EQMP
2890
2891     {
2892         .name       = "query-uuid",
2893         .args_type  = "",
2894         .mhandler.cmd_new = qmp_marshal_input_query_uuid,
2895     },
2896
2897 SQMP
2898 query-command-line-options
2899 --------------------------
2900
2901 Show command line option schema.
2902
2903 Return a json-array of command line option schema for all options (or for
2904 the given option), returning an error if the given option doesn't exist.
2905
2906 Each array entry contains the following:
2907
2908 - "option": option name (json-string)
2909 - "parameters": a json-array describes all parameters of the option:
2910     - "name": parameter name (json-string)
2911     - "type": parameter type (one of 'string', 'boolean', 'number',
2912               or 'size')
2913     - "help": human readable description of the parameter
2914               (json-string, optional)
2915     - "default": default value string for the parameter
2916                  (json-string, optional)
2917
2918 Example:
2919
2920 -> { "execute": "query-command-line-options", "arguments": { "option": "option-rom" } }
2921 <- { "return": [
2922         {
2923             "parameters": [
2924                 {
2925                     "name": "romfile",
2926                     "type": "string"
2927                 },
2928                 {
2929                     "name": "bootindex",
2930                     "type": "number"
2931                 }
2932             ],
2933             "option": "option-rom"
2934         }
2935      ]
2936    }
2937
2938 EQMP
2939
2940     {
2941         .name       = "query-command-line-options",
2942         .args_type  = "option:s?",
2943         .mhandler.cmd_new = qmp_marshal_input_query_command_line_options,
2944     },
2945
2946 SQMP
2947 query-migrate
2948 -------------
2949
2950 Migration status.
2951
2952 Return a json-object. If migration is active there will be another json-object
2953 with RAM migration status and if block migration is active another one with
2954 block migration status.
2955
2956 The main json-object contains the following:
2957
2958 - "status": migration status (json-string)
2959      - Possible values: "setup", "active", "completed", "failed", "cancelled"
2960 - "total-time": total amount of ms since migration started.  If
2961                 migration has ended, it returns the total migration
2962                 time (json-int)
2963 - "setup-time" amount of setup time in milliseconds _before_ the
2964                iterations begin but _after_ the QMP command is issued.
2965                This is designed to provide an accounting of any activities
2966                (such as RDMA pinning) which may be expensive, but do not
2967                actually occur during the iterative migration rounds
2968                themselves. (json-int)
2969 - "downtime": only present when migration has finished correctly
2970               total amount in ms for downtime that happened (json-int)
2971 - "expected-downtime": only present while migration is active
2972                 total amount in ms for downtime that was calculated on
2973                 the last bitmap round (json-int)
2974 - "ram": only present if "status" is "active", it is a json-object with the
2975   following RAM information:
2976          - "transferred": amount transferred in bytes (json-int)
2977          - "remaining": amount remaining to transfer in bytes (json-int)
2978          - "total": total amount of memory in bytes (json-int)
2979          - "duplicate": number of pages filled entirely with the same
2980             byte (json-int)
2981             These are sent over the wire much more efficiently.
2982          - "skipped": number of skipped zero pages (json-int)
2983          - "normal" : number of whole pages transferred.  I.e. they
2984             were not sent as duplicate or xbzrle pages (json-int)
2985          - "normal-bytes" : number of bytes transferred in whole
2986             pages. This is just normal pages times size of one page,
2987             but this way upper levels don't need to care about page
2988             size (json-int)
2989          - "dirty-sync-count": times that dirty ram was synchronized (json-int)
2990 - "disk": only present if "status" is "active" and it is a block migration,
2991   it is a json-object with the following disk information:
2992          - "transferred": amount transferred in bytes (json-int)
2993          - "remaining": amount remaining to transfer in bytes json-int)
2994          - "total": total disk size in bytes (json-int)
2995 - "xbzrle-cache": only present if XBZRLE is active.
2996   It is a json-object with the following XBZRLE information:
2997          - "cache-size": XBZRLE cache size in bytes
2998          - "bytes": number of bytes transferred for XBZRLE compressed pages
2999          - "pages": number of XBZRLE compressed pages
3000          - "cache-miss": number of XBRZRLE page cache misses
3001          - "cache-miss-rate": rate of XBRZRLE page cache misses
3002          - "overflow": number of times XBZRLE overflows.  This means
3003            that the XBZRLE encoding was bigger than just sent the
3004            whole page, and then we sent the whole page instead (as as
3005            normal page).
3006
3007 Examples:
3008
3009 1. Before the first migration
3010
3011 -> { "execute": "query-migrate" }
3012 <- { "return": {} }
3013
3014 2. Migration is done and has succeeded
3015
3016 -> { "execute": "query-migrate" }
3017 <- { "return": {
3018         "status": "completed",
3019         "ram":{
3020           "transferred":123,
3021           "remaining":123,
3022           "total":246,
3023           "total-time":12345,
3024           "setup-time":12345,
3025           "downtime":12345,
3026           "duplicate":123,
3027           "normal":123,
3028           "normal-bytes":123456,
3029           "dirty-sync-count":15
3030         }
3031      }
3032    }
3033
3034 3. Migration is done and has failed
3035
3036 -> { "execute": "query-migrate" }
3037 <- { "return": { "status": "failed" } }
3038
3039 4. Migration is being performed and is not a block migration:
3040
3041 -> { "execute": "query-migrate" }
3042 <- {
3043       "return":{
3044          "status":"active",
3045          "ram":{
3046             "transferred":123,
3047             "remaining":123,
3048             "total":246,
3049             "total-time":12345,
3050             "setup-time":12345,
3051             "expected-downtime":12345,
3052             "duplicate":123,
3053             "normal":123,
3054             "normal-bytes":123456,
3055             "dirty-sync-count":15
3056          }
3057       }
3058    }
3059
3060 5. Migration is being performed and is a block migration:
3061
3062 -> { "execute": "query-migrate" }
3063 <- {
3064       "return":{
3065          "status":"active",
3066          "ram":{
3067             "total":1057024,
3068             "remaining":1053304,
3069             "transferred":3720,
3070             "total-time":12345,
3071             "setup-time":12345,
3072             "expected-downtime":12345,
3073             "duplicate":123,
3074             "normal":123,
3075             "normal-bytes":123456,
3076             "dirty-sync-count":15
3077          },
3078          "disk":{
3079             "total":20971520,
3080             "remaining":20880384,
3081             "transferred":91136
3082          }
3083       }
3084    }
3085
3086 6. Migration is being performed and XBZRLE is active:
3087
3088 -> { "execute": "query-migrate" }
3089 <- {
3090       "return":{
3091          "status":"active",
3092          "capabilities" : [ { "capability": "xbzrle", "state" : true } ],
3093          "ram":{
3094             "total":1057024,
3095             "remaining":1053304,
3096             "transferred":3720,
3097             "total-time":12345,
3098             "setup-time":12345,
3099             "expected-downtime":12345,
3100             "duplicate":10,
3101             "normal":3333,
3102             "normal-bytes":3412992,
3103             "dirty-sync-count":15
3104          },
3105          "xbzrle-cache":{
3106             "cache-size":67108864,
3107             "bytes":20971520,
3108             "pages":2444343,
3109             "cache-miss":2244,
3110             "cache-miss-rate":0.123,
3111             "overflow":34434
3112          }
3113       }
3114    }
3115
3116 EQMP
3117
3118     {
3119         .name       = "query-migrate",
3120         .args_type  = "",
3121         .mhandler.cmd_new = qmp_marshal_input_query_migrate,
3122     },
3123
3124 SQMP
3125 migrate-set-capabilities
3126 ------------------------
3127
3128 Enable/Disable migration capabilities
3129
3130 - "xbzrle": XBZRLE support
3131
3132 Arguments:
3133
3134 Example:
3135
3136 -> { "execute": "migrate-set-capabilities" , "arguments":
3137      { "capabilities": [ { "capability": "xbzrle", "state": true } ] } }
3138
3139 EQMP
3140
3141     {
3142         .name       = "migrate-set-capabilities",
3143         .args_type  = "capabilities:O",
3144         .params     = "capability:s,state:b",
3145         .mhandler.cmd_new = qmp_marshal_input_migrate_set_capabilities,
3146     },
3147 SQMP
3148 query-migrate-capabilities
3149 --------------------------
3150
3151 Query current migration capabilities
3152
3153 - "capabilities": migration capabilities state
3154          - "xbzrle" : XBZRLE state (json-bool)
3155
3156 Arguments:
3157
3158 Example:
3159
3160 -> { "execute": "query-migrate-capabilities" }
3161 <- { "return": [ { "state": false, "capability": "xbzrle" } ] }
3162
3163 EQMP
3164
3165     {
3166         .name       = "query-migrate-capabilities",
3167         .args_type  = "",
3168         .mhandler.cmd_new = qmp_marshal_input_query_migrate_capabilities,
3169     },
3170
3171 SQMP
3172 query-balloon
3173 -------------
3174
3175 Show balloon information.
3176
3177 Make an asynchronous request for balloon info. When the request completes a
3178 json-object will be returned containing the following data:
3179
3180 - "actual": current balloon value in bytes (json-int)
3181
3182 Example:
3183
3184 -> { "execute": "query-balloon" }
3185 <- {
3186       "return":{
3187          "actual":1073741824,
3188       }
3189    }
3190
3191 EQMP
3192
3193     {
3194         .name       = "query-balloon",
3195         .args_type  = "",
3196         .mhandler.cmd_new = qmp_marshal_input_query_balloon,
3197     },
3198
3199     {
3200         .name       = "query-block-jobs",
3201         .args_type  = "",
3202         .mhandler.cmd_new = qmp_marshal_input_query_block_jobs,
3203     },
3204
3205     {
3206         .name       = "qom-list",
3207         .args_type  = "path:s",
3208         .mhandler.cmd_new = qmp_marshal_input_qom_list,
3209     },
3210
3211     {
3212         .name       = "qom-set",
3213         .args_type  = "path:s,property:s,value:q",
3214         .mhandler.cmd_new = qmp_qom_set,
3215     },
3216
3217     {
3218         .name       = "qom-get",
3219         .args_type  = "path:s,property:s",
3220         .mhandler.cmd_new = qmp_qom_get,
3221     },
3222
3223     {
3224         .name       = "nbd-server-start",
3225         .args_type  = "addr:q",
3226         .mhandler.cmd_new = qmp_marshal_input_nbd_server_start,
3227     },
3228     {
3229         .name       = "nbd-server-add",
3230         .args_type  = "device:B,writable:b?",
3231         .mhandler.cmd_new = qmp_marshal_input_nbd_server_add,
3232     },
3233     {
3234         .name       = "nbd-server-stop",
3235         .args_type  = "",
3236         .mhandler.cmd_new = qmp_marshal_input_nbd_server_stop,
3237     },
3238
3239     {
3240         .name       = "change-vnc-password",
3241         .args_type  = "password:s",
3242         .mhandler.cmd_new = qmp_marshal_input_change_vnc_password,
3243     },
3244     {
3245         .name       = "qom-list-types",
3246         .args_type  = "implements:s?,abstract:b?",
3247         .mhandler.cmd_new = qmp_marshal_input_qom_list_types,
3248     },
3249
3250     {
3251         .name       = "device-list-properties",
3252         .args_type  = "typename:s",
3253         .mhandler.cmd_new = qmp_marshal_input_device_list_properties,
3254     },
3255
3256     {
3257         .name       = "query-machines",
3258         .args_type  = "",
3259         .mhandler.cmd_new = qmp_marshal_input_query_machines,
3260     },
3261
3262     {
3263         .name       = "query-cpu-definitions",
3264         .args_type  = "",
3265         .mhandler.cmd_new = qmp_marshal_input_query_cpu_definitions,
3266     },
3267
3268     {
3269         .name       = "query-target",
3270         .args_type  = "",
3271         .mhandler.cmd_new = qmp_marshal_input_query_target,
3272     },
3273
3274     {
3275         .name       = "query-tpm",
3276         .args_type  = "",
3277         .mhandler.cmd_new = qmp_marshal_input_query_tpm,
3278     },
3279
3280 SQMP
3281 query-tpm
3282 ---------
3283
3284 Return information about the TPM device.
3285
3286 Arguments: None
3287
3288 Example:
3289
3290 -> { "execute": "query-tpm" }
3291 <- { "return":
3292      [
3293        { "model": "tpm-tis",
3294          "options":
3295            { "type": "passthrough",
3296              "data":
3297                { "cancel-path": "/sys/class/misc/tpm0/device/cancel",
3298                  "path": "/dev/tpm0"
3299                }
3300            },
3301          "id": "tpm0"
3302        }
3303      ]
3304    }
3305
3306 EQMP
3307
3308     {
3309         .name       = "query-tpm-models",
3310         .args_type  = "",
3311         .mhandler.cmd_new = qmp_marshal_input_query_tpm_models,
3312     },
3313
3314 SQMP
3315 query-tpm-models
3316 ----------------
3317
3318 Return a list of supported TPM models.
3319
3320 Arguments: None
3321
3322 Example:
3323
3324 -> { "execute": "query-tpm-models" }
3325 <- { "return": [ "tpm-tis" ] }
3326
3327 EQMP
3328
3329     {
3330         .name       = "query-tpm-types",
3331         .args_type  = "",
3332         .mhandler.cmd_new = qmp_marshal_input_query_tpm_types,
3333     },
3334
3335 SQMP
3336 query-tpm-types
3337 ---------------
3338
3339 Return a list of supported TPM types.
3340
3341 Arguments: None
3342
3343 Example:
3344
3345 -> { "execute": "query-tpm-types" }
3346 <- { "return": [ "passthrough" ] }
3347
3348 EQMP
3349
3350     {
3351         .name       = "chardev-add",
3352         .args_type  = "id:s,backend:q",
3353         .mhandler.cmd_new = qmp_marshal_input_chardev_add,
3354     },
3355
3356 SQMP
3357 chardev-add
3358 ----------------
3359
3360 Add a chardev.
3361
3362 Arguments:
3363
3364 - "id": the chardev's ID, must be unique (json-string)
3365 - "backend": chardev backend type + parameters
3366
3367 Examples:
3368
3369 -> { "execute" : "chardev-add",
3370      "arguments" : { "id" : "foo",
3371                      "backend" : { "type" : "null", "data" : {} } } }
3372 <- { "return": {} }
3373
3374 -> { "execute" : "chardev-add",
3375      "arguments" : { "id" : "bar",
3376                      "backend" : { "type" : "file",
3377                                    "data" : { "out" : "/tmp/bar.log" } } } }
3378 <- { "return": {} }
3379
3380 -> { "execute" : "chardev-add",
3381      "arguments" : { "id" : "baz",
3382                      "backend" : { "type" : "pty", "data" : {} } } }
3383 <- { "return": { "pty" : "/dev/pty/42" } }
3384
3385 EQMP
3386
3387     {
3388         .name       = "chardev-remove",
3389         .args_type  = "id:s",
3390         .mhandler.cmd_new = qmp_marshal_input_chardev_remove,
3391     },
3392
3393
3394 SQMP
3395 chardev-remove
3396 --------------
3397
3398 Remove a chardev.
3399
3400 Arguments:
3401
3402 - "id": the chardev's ID, must exist and not be in use (json-string)
3403
3404 Example:
3405
3406 -> { "execute": "chardev-remove", "arguments": { "id" : "foo" } }
3407 <- { "return": {} }
3408
3409 EQMP
3410     {
3411         .name       = "query-rx-filter",
3412         .args_type  = "name:s?",
3413         .mhandler.cmd_new = qmp_marshal_input_query_rx_filter,
3414     },
3415
3416 SQMP
3417 query-rx-filter
3418 ---------------
3419
3420 Show rx-filter information.
3421
3422 Returns a json-array of rx-filter information for all NICs (or for the
3423 given NIC), returning an error if the given NIC doesn't exist, or
3424 given NIC doesn't support rx-filter querying, or given net client
3425 isn't a NIC.
3426
3427 The query will clear the event notification flag of each NIC, then qemu
3428 will start to emit event to QMP monitor.
3429
3430 Each array entry contains the following:
3431
3432 - "name": net client name (json-string)
3433 - "promiscuous": promiscuous mode is enabled (json-bool)
3434 - "multicast": multicast receive state (one of 'normal', 'none', 'all')
3435 - "unicast": unicast receive state  (one of 'normal', 'none', 'all')
3436 - "vlan": vlan receive state (one of 'normal', 'none', 'all') (Since 2.0)
3437 - "broadcast-allowed": allow to receive broadcast (json-bool)
3438 - "multicast-overflow": multicast table is overflowed (json-bool)
3439 - "unicast-overflow": unicast table is overflowed (json-bool)
3440 - "main-mac": main macaddr string (json-string)
3441 - "vlan-table": a json-array of active vlan id
3442 - "unicast-table": a json-array of unicast macaddr string
3443 - "multicast-table": a json-array of multicast macaddr string
3444
3445 Example:
3446
3447 -> { "execute": "query-rx-filter", "arguments": { "name": "vnet0" } }
3448 <- { "return": [
3449         {
3450             "promiscuous": true,
3451             "name": "vnet0",
3452             "main-mac": "52:54:00:12:34:56",
3453             "unicast": "normal",
3454             "vlan": "normal",
3455             "vlan-table": [
3456                 4,
3457                 0
3458             ],
3459             "unicast-table": [
3460             ],
3461             "multicast": "normal",
3462             "multicast-overflow": false,
3463             "unicast-overflow": false,
3464             "multicast-table": [
3465                 "01:00:5e:00:00:01",
3466                 "33:33:00:00:00:01",
3467                 "33:33:ff:12:34:56"
3468             ],
3469             "broadcast-allowed": false
3470         }
3471       ]
3472    }
3473
3474 EQMP
3475
3476     {
3477         .name       = "blockdev-add",
3478         .args_type  = "options:q",
3479         .mhandler.cmd_new = qmp_marshal_input_blockdev_add,
3480     },
3481
3482 SQMP
3483 blockdev-add
3484 ------------
3485
3486 Add a block device.
3487
3488 Arguments:
3489
3490 - "options": block driver options
3491
3492 Example (1):
3493
3494 -> { "execute": "blockdev-add",
3495     "arguments": { "options" : { "driver": "qcow2",
3496                                  "file": { "driver": "file",
3497                                            "filename": "test.qcow2" } } } }
3498 <- { "return": {} }
3499
3500 Example (2):
3501
3502 -> { "execute": "blockdev-add",
3503      "arguments": {
3504          "options": {
3505            "driver": "qcow2",
3506            "id": "my_disk",
3507            "discard": "unmap",
3508            "cache": {
3509                "direct": true,
3510                "writeback": true
3511            },
3512            "file": {
3513                "driver": "file",
3514                "filename": "/tmp/test.qcow2"
3515            },
3516            "backing": {
3517                "driver": "raw",
3518                "file": {
3519                    "driver": "file",
3520                    "filename": "/dev/fdset/4"
3521                }
3522            }
3523          }
3524        }
3525      }
3526
3527 <- { "return": {} }
3528
3529 EQMP
3530
3531     {
3532         .name       = "query-named-block-nodes",
3533         .args_type  = "",
3534         .mhandler.cmd_new = qmp_marshal_input_query_named_block_nodes,
3535     },
3536
3537 SQMP
3538 @query-named-block-nodes
3539 ------------------------
3540
3541 Return a list of BlockDeviceInfo for all the named block driver nodes
3542
3543 Example:
3544
3545 -> { "execute": "query-named-block-nodes" }
3546 <- { "return": [ { "ro":false,
3547                    "drv":"qcow2",
3548                    "encrypted":false,
3549                    "file":"disks/test.qcow2",
3550                    "node-name": "my-node",
3551                    "backing_file_depth":1,
3552                    "bps":1000000,
3553                    "bps_rd":0,
3554                    "bps_wr":0,
3555                    "iops":1000000,
3556                    "iops_rd":0,
3557                    "iops_wr":0,
3558                    "bps_max": 8000000,
3559                    "bps_rd_max": 0,
3560                    "bps_wr_max": 0,
3561                    "iops_max": 0,
3562                    "iops_rd_max": 0,
3563                    "iops_wr_max": 0,
3564                    "iops_size": 0,
3565                    "image":{
3566                       "filename":"disks/test.qcow2",
3567                       "format":"qcow2",
3568                       "virtual-size":2048000,
3569                       "backing_file":"base.qcow2",
3570                       "full-backing-filename":"disks/base.qcow2",
3571                       "backing-filename-format:"qcow2",
3572                       "snapshots":[
3573                          {
3574                             "id": "1",
3575                             "name": "snapshot1",
3576                             "vm-state-size": 0,
3577                             "date-sec": 10000200,
3578                             "date-nsec": 12,
3579                             "vm-clock-sec": 206,
3580                             "vm-clock-nsec": 30
3581                          }
3582                       ],
3583                       "backing-image":{
3584                           "filename":"disks/base.qcow2",
3585                           "format":"qcow2",
3586                           "virtual-size":2048000
3587                       }
3588                    } } ] }
3589
3590 EQMP
3591
3592     {
3593         .name       = "query-memdev",
3594         .args_type  = "",
3595         .mhandler.cmd_new = qmp_marshal_input_query_memdev,
3596     },
3597
3598 SQMP
3599 query-memdev
3600 ------------
3601
3602 Show memory devices information.
3603
3604
3605 Example (1):
3606
3607 -> { "execute": "query-memdev" }
3608 <- { "return": [
3609        {
3610          "size": 536870912,
3611          "merge": false,
3612          "dump": true,
3613          "prealloc": false,
3614          "host-nodes": [0, 1],
3615          "policy": "bind"
3616        },
3617        {
3618          "size": 536870912,
3619          "merge": false,
3620          "dump": true,
3621          "prealloc": true,
3622          "host-nodes": [2, 3],
3623          "policy": "preferred"
3624        }
3625      ]
3626    }
3627
3628 EQMP
3629
3630     {
3631         .name       = "query-memory-devices",
3632         .args_type  = "",
3633         .mhandler.cmd_new = qmp_marshal_input_query_memory_devices,
3634     },
3635
3636 SQMP
3637 @query-memory-devices
3638 --------------------
3639
3640 Return a list of memory devices.
3641
3642 Example:
3643 -> { "execute": "query-memory-devices" }
3644 <- { "return": [ { "data":
3645                       { "addr": 5368709120,
3646                         "hotpluggable": true,
3647                         "hotplugged": true,
3648                         "id": "d1",
3649                         "memdev": "/objects/memX",
3650                         "node": 0,
3651                         "size": 1073741824,
3652                         "slot": 0},
3653                    "type": "dimm"
3654                  } ] }
3655 EQMP
3656
3657     {
3658         .name       = "query-acpi-ospm-status",
3659         .args_type  = "",
3660         .mhandler.cmd_new = qmp_marshal_input_query_acpi_ospm_status,
3661     },
3662
3663 SQMP
3664 @query-acpi-ospm-status
3665 --------------------
3666
3667 Return list of ACPIOSTInfo for devices that support status reporting
3668 via ACPI _OST method.
3669
3670 Example:
3671 -> { "execute": "query-acpi-ospm-status" }
3672 <- { "return": [ { "device": "d1", "slot": "0", "slot-type": "DIMM", "source": 1, "status": 0},
3673                  { "slot": "1", "slot-type": "DIMM", "source": 0, "status": 0},
3674                  { "slot": "2", "slot-type": "DIMM", "source": 0, "status": 0},
3675                  { "slot": "3", "slot-type": "DIMM", "source": 0, "status": 0}
3676    ]}
3677 EQMP
3678
3679 #if defined TARGET_I386
3680     {
3681         .name       = "rtc-reset-reinjection",
3682         .args_type  = "",
3683         .mhandler.cmd_new = qmp_marshal_input_rtc_reset_reinjection,
3684     },
3685 #endif
3686
3687 SQMP
3688 rtc-reset-reinjection
3689 ---------------------
3690
3691 Reset the RTC interrupt reinjection backlog.
3692
3693 Arguments: None.
3694
3695 Example:
3696
3697 -> { "execute": "rtc-reset-reinjection" }
3698 <- { "return": {} }
3699
3700 EQMP