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 guests do.
 491
 492 EQMP
 493
 494     {
 495         .name       = "ringbuf-write",
 496         .args_type  = "device:s,data:s,format:s?",
 497         .mhandler.cmd_new = qmp_marshal_input_ringbuf_write,
 498     },
 499
 500 SQMP
 501 ringbuf-write
 502 -------------
 503
 504 Write to a ring buffer character device.
 505
 506 Arguments:
 507
 508 - "device": ring buffer character device name (json-string)
 509 - "data": data to write (json-string)
 510 - "format": data format (json-string, optional)
 511           - Possible values: "utf8" (default), "base64"
 512             Bug: invalid base64 is currently not rejected.
 513             Whitespace *is* invalid.
 514
 515 Example:
 516
 517 -> { "execute": "ringbuf-write",
 518                 "arguments": { "device": "foo",
 519                                "data": "abcdefgh",
 520                                "format": "utf8" } }
 521 <- { "return": {} }
 522
 523 EQMP
 524
 525     {
 526         .name       = "ringbuf-read",
 527         .args_type  = "device:s,size:i,format:s?",
 528         .mhandler.cmd_new = qmp_marshal_input_ringbuf_read,
 529     },
 530
 531 SQMP
 532 ringbuf-read
 533 -------------
 534
 535 Read from a ring buffer character device.
 536
 537 Arguments:
 538
 539 - "device": ring buffer character device name (json-string)
 540 - "size": how many bytes to read at most (json-int)
 541           - Number of data bytes, not number of characters in encoded data
 542 - "format": data format (json-string, optional)
 543           - Possible values: "utf8" (default), "base64"
 544           - Naturally, format "utf8" works only when the ring buffer
 545             contains valid UTF-8 text.  Invalid UTF-8 sequences get
 546             replaced.  Bug: replacement doesn't work.  Bug: can screw
 547             up on encountering NUL characters, after the ring buffer
 548             lost data, and when reading stops because the size limit
 549             is reached.
 550
 551 Example:
 552
 553 -> { "execute": "ringbuf-read",
 554                 "arguments": { "device": "foo",
 555                                "size": 1000,
 556                                "format": "utf8" } }
 557 <- {"return": "abcdefgh"}
 558
 559 EQMP
 560
 561     {
 562         .name       = "xen-save-devices-state",
 563         .args_type  = "filename:F",
 564     .mhandler.cmd_new = qmp_marshal_input_xen_save_devices_state,
 565     },
 566
 567 SQMP
 568 xen-save-devices-state
 569 -------
 570
 571 Save the state of all devices to file. The RAM and the block devices
 572 of the VM are not saved by this command.
 573
 574 Arguments:
 575
 576 - "filename": the file to save the state of the devices to as binary
 577 data. See xen-save-devices-state.txt for a description of the binary
 578 format.
 579
 580 Example:
 581
 582 -> { "execute": "xen-save-devices-state",
 583      "arguments": { "filename": "/tmp/save" } }
 584 <- { "return": {} }
 585
 586 EQMP
 587
 588     {
 589         .name       = "xen-set-global-dirty-log",
 590         .args_type  = "enable:b",
 591         .mhandler.cmd_new = qmp_marshal_input_xen_set_global_dirty_log,
 592     },
 593
 594 SQMP
 595 xen-set-global-dirty-log
 596 -------
 597
 598 Enable or disable the global dirty log mode.
 599
 600 Arguments:
 601
 602 - "enable": Enable it or disable it.
 603
 604 Example:
 605
 606 -> { "execute": "xen-set-global-dirty-log",
 607      "arguments": { "enable": true } }
 608 <- { "return": {} }
 609
 610 EQMP
 611
 612     {
 613         .name       = "migrate",
 614         .args_type  = "detach:-d,blk:-b,inc:-i,uri:s",
 615         .mhandler.cmd_new = qmp_marshal_input_migrate,
 616     },
 617
 618 SQMP
 619 migrate
 620 -------
 621
 622 Migrate to URI.
 623
 624 Arguments:
 625
 626 - "blk": block migration, full disk copy (json-bool, optional)
 627 - "inc": incremental disk copy (json-bool, optional)
 628 - "uri": Destination URI (json-string)
 629
 630 Example:
 631
 632 -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
 633 <- { "return": {} }
 634
 635 Notes:
 636
 637 (1) The 'query-migrate' command should be used to check migration's progress
 638     and final result (this information is provided by the 'status' member)
 639 (2) All boolean arguments default to false
 640 (3) The user Monitor's "detach" argument is invalid in QMP and should not
 641     be used
 642
 643 EQMP
 644
 645     {
 646         .name       = "migrate_cancel",
 647         .args_type  = "",
 648         .mhandler.cmd_new = qmp_marshal_input_migrate_cancel,
 649     },
 650
 651 SQMP
 652 migrate_cancel
 653 --------------
 654
 655 Cancel the current migration.
 656
 657 Arguments: None.
 658
 659 Example:
 660
 661 -> { "execute": "migrate_cancel" }
 662 <- { "return": {} }
 663
 664 EQMP
 665 {
 666         .name       = "migrate-set-cache-size",
 667         .args_type  = "value:o",
 668         .mhandler.cmd_new = qmp_marshal_input_migrate_set_cache_size,
 669     },
 670
 671 SQMP
 672 migrate-set-cache-size
 673 ----------------------
 674
 675 Set cache size to be used by XBZRLE migration, the cache size will be rounded
 676 down to the nearest power of 2
 677
 678 Arguments:
 679
 680 - "value": cache size in bytes (json-int)
 681
 682 Example:
 683
 684 -> { "execute": "migrate-set-cache-size", "arguments": { "value": 536870912 } }
 685 <- { "return": {} }
 686
 687 EQMP
 688     {
 689         .name       = "query-migrate-cache-size",
 690         .args_type  = "",
 691         .mhandler.cmd_new = qmp_marshal_input_query_migrate_cache_size,
 692     },
 693
 694 SQMP
 695 query-migrate-cache-size
 696 ------------------------
 697
 698 Show cache size to be used by XBZRLE migration
 699
 700 returns a json-object with the following information:
 701 - "size" : json-int
 702
 703 Example:
 704
 705 -> { "execute": "query-migrate-cache-size" }
 706 <- { "return": 67108864 }
 707
 708 EQMP
 709
 710     {
 711         .name       = "migrate_set_speed",
 712         .args_type  = "value:o",
 713         .mhandler.cmd_new = qmp_marshal_input_migrate_set_speed,
 714     },
 715
 716 SQMP
 717 migrate_set_speed
 718 -----------------
 719
 720 Set maximum speed for migrations.
 721
 722 Arguments:
 723
 724 - "value": maximum speed, in bytes per second (json-int)
 725
 726 Example:
 727
 728 -> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } }
 729 <- { "return": {} }
 730
 731 EQMP
 732
 733     {
 734         .name       = "migrate_set_downtime",
 735         .args_type  = "value:T",
 736         .mhandler.cmd_new = qmp_marshal_input_migrate_set_downtime,
 737     },
 738
 739 SQMP
 740 migrate_set_downtime
 741 --------------------
 742
 743 Set maximum tolerated downtime (in seconds) for migrations.
 744
 745 Arguments:
 746
 747 - "value": maximum downtime (json-number)
 748
 749 Example:
 750
 751 -> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } }
 752 <- { "return": {} }
 753
 754 EQMP
 755
 756     {
 757         .name       = "client_migrate_info",
 758         .args_type  = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
 759         .params     = "protocol hostname port tls-port cert-subject",
 760         .help       = "send migration info to spice/vnc client",
 761         .user_print = monitor_user_noop,
 762         .mhandler.cmd_async = client_migrate_info,
 763         .flags      = MONITOR_CMD_ASYNC,
 764     },
 765
 766 SQMP
 767 client_migrate_info
 768 ------------------
 769
 770 Set the spice/vnc connection info for the migration target.  The spice/vnc
 771 server will ask the spice/vnc client to automatically reconnect using the
 772 new parameters (if specified) once the vm migration finished successfully.
 773
 774 Arguments:
 775
 776 - "protocol":     protocol: "spice" or "vnc" (json-string)
 777 - "hostname":     migration target hostname (json-string)
 778 - "port":         spice/vnc tcp port for plaintext channels (json-int, optional)
 779 - "tls-port":     spice tcp port for tls-secured channels (json-int, optional)
 780 - "cert-subject": server certificate subject (json-string, optional)
 781
 782 Example:
 783
 784 -> { "execute": "client_migrate_info",
 785      "arguments": { "protocol": "spice",
 786                     "hostname": "virt42.lab.kraxel.org",
 787                     "port": 1234 } }
 788 <- { "return": {} }
 789
 790 EQMP
 791
 792     {
 793         .name       = "dump-guest-memory",
 794         .args_type  = "paging:b,protocol:s,begin:i?,end:i?",
 795         .params     = "-p protocol [begin] [length]",
 796         .help       = "dump guest memory to file",
 797         .user_print = monitor_user_noop,
 798         .mhandler.cmd_new = qmp_marshal_input_dump_guest_memory,
 799     },
 800
 801 SQMP
 802 dump
 803
 804
 805 Dump guest memory to file. The file can be processed with crash or gdb.
 806
 807 Arguments:
 808
 809 - "paging": do paging to get guest's memory mapping (json-bool)
 810 - "protocol": destination file(started with "file:") or destination file
 811               descriptor (started with "fd:") (json-string)
 812 - "begin": the starting physical address. It's optional, and should be specified
 813            with length together (json-int)
 814 - "length": the memory size, in bytes. It's optional, and should be specified
 815             with begin together (json-int)
 816
 817 Example:
 818
 819 -> { "execute": "dump-guest-memory", "arguments": { "protocol": "fd:dump" } }
 820 <- { "return": {} }
 821
 822 Notes:
 823
 824 (1) All boolean arguments default to false
 825
 826 EQMP
 827
 828     {
 829         .name       = "netdev_add",
 830         .args_type  = "netdev:O",
 831         .mhandler.cmd_new = qmp_netdev_add,
 832     },
 833
 834 SQMP
 835 netdev_add
 836 ----------
 837
 838 Add host network device.
 839
 840 Arguments:
 841
 842 - "type": the device type, "tap", "user", ... (json-string)
 843 - "id": the device's ID, must be unique (json-string)
 844 - device options
 845
 846 Example:
 847
 848 -> { "execute": "netdev_add", "arguments": { "type": "user", "id": "netdev1" } }
 849 <- { "return": {} }
 850
 851 Note: The supported device options are the same ones supported by the '-netdev'
 852       command-line argument, which are listed in the '-help' output or QEMU's
 853       manual
 854
 855 EQMP
 856
 857     {
 858         .name       = "netdev_del",
 859         .args_type  = "id:s",
 860         .mhandler.cmd_new = qmp_marshal_input_netdev_del,
 861     },
 862
 863 SQMP
 864 netdev_del
 865 ----------
 866
 867 Remove host network device.
 868
 869 Arguments:
 870
 871 - "id": the device's ID, must be unique (json-string)
 872
 873 Example:
 874
 875 -> { "execute": "netdev_del", "arguments": { "id": "netdev1" } }
 876 <- { "return": {} }
 877
 878
 879 EQMP
 880
 881     {
 882         .name       = "block_resize",
 883         .args_type  = "device:B,size:o",
 884         .mhandler.cmd_new = qmp_marshal_input_block_resize,
 885     },
 886
 887 SQMP
 888 block_resize
 889 ------------
 890
 891 Resize a block image while a guest is running.
 892
 893 Arguments:
 894
 895 - "device": the device's ID, must be unique (json-string)
 896 - "size": new size
 897
 898 Example:
 899
 900 -> { "execute": "block_resize", "arguments": { "device": "scratch", "size": 1073741824 } }
 901 <- { "return": {} }
 902
 903 EQMP
 904
 905     {
 906         .name       = "block-stream",
 907         .args_type  = "device:B,base:s?,speed:o?,on-error:s?",
 908         .mhandler.cmd_new = qmp_marshal_input_block_stream,
 909     },
 910
 911     {
 912         .name       = "block-commit",
 913         .args_type  = "device:B,base:s?,top:s,speed:o?",
 914         .mhandler.cmd_new = qmp_marshal_input_block_commit,
 915     },
 916
 917     {
 918         .name       = "drive-backup",
 919         .args_type  = "sync:s,device:B,target:s,speed:i?,mode:s?,format:s?,"
 920                       "on-source-error:s?,on-target-error:s?",
 921         .mhandler.cmd_new = qmp_marshal_input_drive_backup,
 922     },
 923
 924 SQMP
 925 drive-backup
 926 ------------
 927
 928 Start a point-in-time copy of a block device to a new destination.  The
 929 status of ongoing drive-backup operations can be checked with
 930 query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
 931 The operation can be stopped before it has completed using the
 932 block-job-cancel command.
 933
 934 Arguments:
 935
 936 - "device": the name of the device which should be copied.
 937             (json-string)
 938 - "target": the target of the new image. If the file exists, or if it is a
 939             device, the existing file/device will be used as the new
 940             destination.  If it does not exist, a new file will be created.
 941             (json-string)
 942 - "format": the format of the new destination, default is to probe if 'mode' is
 943             'existing', else the format of the source
 944             (json-string, optional)
 945 - "sync": what parts of the disk image should be copied to the destination;
 946   possibilities include "full" for all the disk, "top" for only the sectors
 947   allocated in the topmost image, or "none" to only replicate new I/O
 948   (MirrorSyncMode).
 949 - "mode": whether and how QEMU should create a new image
 950           (NewImageMode, optional, default 'absolute-paths')
 951 - "speed": the maximum speed, in bytes per second (json-int, optional)
 952 - "on-source-error": the action to take on an error on the source, default
 953                      'report'.  'stop' and 'enospc' can only be used
 954                      if the block device supports io-status.
 955                      (BlockdevOnError, optional)
 956 - "on-target-error": the action to take on an error on the target, default
 957                      'report' (no limitations, since this applies to
 958                      a different block device than device).
 959                      (BlockdevOnError, optional)
 960
 961 Example:
 962 -> { "execute": "drive-backup", "arguments": { "device": "drive0",
 963                                                "target": "backup.img" } }
 964 <- { "return": {} }
 965 EQMP
 966
 967     {
 968         .name       = "block-job-set-speed",
 969         .args_type  = "device:B,speed:o",
 970         .mhandler.cmd_new = qmp_marshal_input_block_job_set_speed,
 971     },
 972
 973     {
 974         .name       = "block-job-cancel",
 975         .args_type  = "device:B,force:b?",
 976         .mhandler.cmd_new = qmp_marshal_input_block_job_cancel,
 977     },
 978     {
 979         .name       = "block-job-pause",
 980         .args_type  = "device:B",
 981         .mhandler.cmd_new = qmp_marshal_input_block_job_pause,
 982     },
 983     {
 984         .name       = "block-job-resume",
 985         .args_type  = "device:B",
 986         .mhandler.cmd_new = qmp_marshal_input_block_job_resume,
 987     },
 988     {
 989         .name       = "block-job-complete",
 990         .args_type  = "device:B",
 991         .mhandler.cmd_new = qmp_marshal_input_block_job_complete,
 992     },
 993     {
 994         .name       = "transaction",
 995         .args_type  = "actions:q",
 996         .mhandler.cmd_new = qmp_marshal_input_transaction,
 997     },
 998
 999 SQMP
1000 transaction
1001 -----------
1002
1003 Atomically operate on one or more block devices.  The only supported
1004 operation for now is snapshotting.  If there is any failure performing
1005 any of the operations, all snapshots for the group are abandoned, and
1006 the original disks pre-snapshot attempt are used.
1007
1008 A list of dictionaries is accepted, that contains the actions to be performed.
1009 For snapshots this is the device, the file to use for the new snapshot,
1010 and the format.  The default format, if not specified, is qcow2.
1011
1012 Each new snapshot defaults to being created by QEMU (wiping any
1013 contents if the file already exists), but it is also possible to reuse
1014 an externally-created file.  In the latter case, you should ensure that
1015 the new image file has the same contents as the current one; QEMU cannot
1016 perform any meaningful check.  Typically this is achieved by using the
1017 current image file as the backing file for the new image.
1018
1019 Arguments:
1020
1021 actions array:
1022     - "type": the operation to perform.  The only supported
1023       value is "blockdev-snapshot-sync". (json-string)
1024     - "data": a dictionary.  The contents depend on the value
1025       of "type".  When "type" is "blockdev-snapshot-sync":
1026       - "device": device name to snapshot (json-string)
1027       - "snapshot-file": name of new image file (json-string)
1028       - "format": format of new image (json-string, optional)
1029       - "mode": whether and how QEMU should create the snapshot file
1030         (NewImageMode, optional, default "absolute-paths")
1031
1032 Example:
1033
1034 -> { "execute": "transaction",
1035      "arguments": { "actions": [
1036          { 'type': 'blockdev-snapshot-sync', 'data' : { "device": "ide-hd0",
1037                                          "snapshot-file": "/some/place/my-image",
1038                                          "format": "qcow2" } },
1039          { 'type': 'blockdev-snapshot-sync', 'data' : { "device": "ide-hd1",
1040                                          "snapshot-file": "/some/place/my-image2",
1041                                          "mode": "existing",
1042                                          "format": "qcow2" } } ] } }
1043 <- { "return": {} }
1044
1045 EQMP
1046
1047     {
1048         .name       = "blockdev-snapshot-sync",
1049         .args_type  = "device:B,snapshot-file:s,format:s?,mode:s?",
1050         .mhandler.cmd_new = qmp_marshal_input_blockdev_snapshot_sync,
1051     },
1052
1053 SQMP
1054 blockdev-snapshot-sync
1055 ----------------------
1056
1057 Synchronous snapshot of a block device. snapshot-file specifies the
1058 target of the new image. If the file exists, or if it is a device, the
1059 snapshot will be created in the existing file/device. If does not
1060 exist, a new file will be created. format specifies the format of the
1061 snapshot image, default is qcow2.
1062
1063 Arguments:
1064
1065 - "device": device name to snapshot (json-string)
1066 - "snapshot-file": name of new image file (json-string)
1067 - "mode": whether and how QEMU should create the snapshot file
1068   (NewImageMode, optional, default "absolute-paths")
1069 - "format": format of new image (json-string, optional)
1070
1071 Example:
1072
1073 -> { "execute": "blockdev-snapshot-sync", "arguments": { "device": "ide-hd0",
1074                                                          "snapshot-file":
1075                                                         "/some/place/my-image",
1076                                                         "format": "qcow2" } }
1077 <- { "return": {} }
1078
1079 EQMP
1080
1081     {
1082         .name       = "drive-mirror",
1083         .args_type  = "sync:s,device:B,target:s,speed:i?,mode:s?,format:s?,"
1084                       "on-source-error:s?,on-target-error:s?,"
1085                       "granularity:i?,buf-size:i?",
1086         .mhandler.cmd_new = qmp_marshal_input_drive_mirror,
1087     },
1088
1089 SQMP
1090 drive-mirror
1091 ------------
1092
1093 Start mirroring a block device's writes to a new destination. target
1094 specifies the target of the new image. If the file exists, or if it is
1095 a device, it will be used as the new destination for writes. If it does not
1096 exist, a new file will be created. format specifies the format of the
1097 mirror image, default is to probe if mode='existing', else the format
1098 of the source.
1099
1100 Arguments:
1101
1102 - "device": device name to operate on (json-string)
1103 - "target": name of new image file (json-string)
1104 - "format": format of new image (json-string, optional)
1105 - "mode": how an image file should be created into the target
1106   file/device (NewImageMode, optional, default 'absolute-paths')
1107 - "speed": maximum speed of the streaming job, in bytes per second
1108   (json-int)
1109 - "granularity": granularity of the dirty bitmap, in bytes (json-int, optional)
1110 - "buf_size": maximum amount of data in flight from source to target, in bytes
1111   (json-int, default 10M)
1112 - "sync": what parts of the disk image should be copied to the destination;
1113   possibilities include "full" for all the disk, "top" for only the sectors
1114   allocated in the topmost image, or "none" to only replicate new I/O
1115   (MirrorSyncMode).
1116 - "on-source-error": the action to take on an error on the source
1117   (BlockdevOnError, default 'report')
1118 - "on-target-error": the action to take on an error on the target
1119   (BlockdevOnError, default 'report')
1120
1121 The default value of the granularity is the image cluster size clamped
1122 between 4096 and 65536, if the image format defines one.  If the format
1123 does not define a cluster size, the default value of the granularity
1124 is 65536.
1125
1126
1127 Example:
1128
1129 -> { "execute": "drive-mirror", "arguments": { "device": "ide-hd0",
1130                                                "target": "/some/place/my-image",
1131                                                "sync": "full",
1132                                                "format": "qcow2" } }
1133 <- { "return": {} }
1134
1135 EQMP
1136
1137     {
1138         .name       = "balloon",
1139         .args_type  = "value:M",
1140         .mhandler.cmd_new = qmp_marshal_input_balloon,
1141     },
1142
1143 SQMP
1144 balloon
1145 -------
1146
1147 Request VM to change its memory allocation (in bytes).
1148
1149 Arguments:
1150
1151 - "value": New memory allocation (json-int)
1152
1153 Example:
1154
1155 -> { "execute": "balloon", "arguments": { "value": 536870912 } }
1156 <- { "return": {} }
1157
1158 EQMP
1159
1160     {
1161         .name       = "set_link",
1162         .args_type  = "name:s,up:b",
1163         .mhandler.cmd_new = qmp_marshal_input_set_link,
1164     },
1165
1166 SQMP
1167 set_link
1168 --------
1169
1170 Change the link status of a network adapter.
1171
1172 Arguments:
1173
1174 - "name": network device name (json-string)
1175 - "up": status is up (json-bool)
1176
1177 Example:
1178
1179 -> { "execute": "set_link", "arguments": { "name": "e1000.0", "up": false } }
1180 <- { "return": {} }
1181
1182 EQMP
1183
1184     {
1185         .name       = "getfd",
1186         .args_type  = "fdname:s",
1187         .params     = "getfd name",
1188         .help       = "receive a file descriptor via SCM rights and assign it a name",
1189         .mhandler.cmd_new = qmp_marshal_input_getfd,
1190     },
1191
1192 SQMP
1193 getfd
1194 -----
1195
1196 Receive a file descriptor via SCM rights and assign it a name.
1197
1198 Arguments:
1199
1200 - "fdname": file descriptor name (json-string)
1201
1202 Example:
1203
1204 -> { "execute": "getfd", "arguments": { "fdname": "fd1" } }
1205 <- { "return": {} }
1206
1207 Notes:
1208
1209 (1) If the name specified by the "fdname" argument already exists,
1210     the file descriptor assigned to it will be closed and replaced
1211     by the received file descriptor.
1212 (2) The 'closefd' command can be used to explicitly close the file
1213     descriptor when it is no longer needed.
1214
1215 EQMP
1216
1217     {
1218         .name       = "closefd",
1219         .args_type  = "fdname:s",
1220         .params     = "closefd name",
1221         .help       = "close a file descriptor previously passed via SCM rights",
1222         .mhandler.cmd_new = qmp_marshal_input_closefd,
1223     },
1224
1225 SQMP
1226 closefd
1227 -------
1228
1229 Close a file descriptor previously passed via SCM rights.
1230
1231 Arguments:
1232
1233 - "fdname": file descriptor name (json-string)
1234
1235 Example:
1236
1237 -> { "execute": "closefd", "arguments": { "fdname": "fd1" } }
1238 <- { "return": {} }
1239
1240 EQMP
1241
1242      {
1243         .name       = "add-fd",
1244         .args_type  = "fdset-id:i?,opaque:s?",
1245         .params     = "add-fd fdset-id opaque",
1246         .help       = "Add a file descriptor, that was passed via SCM rights, to an fd set",
1247         .mhandler.cmd_new = qmp_marshal_input_add_fd,
1248     },
1249
1250 SQMP
1251 add-fd
1252 -------
1253
1254 Add a file descriptor, that was passed via SCM rights, to an fd set.
1255
1256 Arguments:
1257
1258 - "fdset-id": The ID of the fd set to add the file descriptor to.
1259               (json-int, optional)
1260 - "opaque": A free-form string that can be used to describe the fd.
1261             (json-string, optional)
1262
1263 Return a json-object with the following information:
1264
1265 - "fdset-id": The ID of the fd set that the fd was added to. (json-int)
1266 - "fd": The file descriptor that was received via SCM rights and added to the
1267         fd set. (json-int)
1268
1269 Example:
1270
1271 -> { "execute": "add-fd", "arguments": { "fdset-id": 1 } }
1272 <- { "return": { "fdset-id": 1, "fd": 3 } }
1273
1274 Notes:
1275
1276 (1) The list of fd sets is shared by all monitor connections.
1277 (2) If "fdset-id" is not specified, a new fd set will be created.
1278
1279 EQMP
1280
1281      {
1282         .name       = "remove-fd",
1283         .args_type  = "fdset-id:i,fd:i?",
1284         .params     = "remove-fd fdset-id fd",
1285         .help       = "Remove a file descriptor from an fd set",
1286         .mhandler.cmd_new = qmp_marshal_input_remove_fd,
1287     },
1288
1289 SQMP
1290 remove-fd
1291 ---------
1292
1293 Remove a file descriptor from an fd set.
1294
1295 Arguments:
1296
1297 - "fdset-id": The ID of the fd set that the file descriptor belongs to.
1298               (json-int)
1299 - "fd": The file descriptor that is to be removed. (json-int, optional)
1300
1301 Example:
1302
1303 -> { "execute": "remove-fd", "arguments": { "fdset-id": 1, "fd": 3 } }
1304 <- { "return": {} }
1305
1306 Notes:
1307
1308 (1) The list of fd sets is shared by all monitor connections.
1309 (2) If "fd" is not specified, all file descriptors in "fdset-id" will be
1310     removed.
1311
1312 EQMP
1313
1314     {
1315         .name       = "query-fdsets",
1316         .args_type  = "",
1317         .help       = "Return information describing all fd sets",
1318         .mhandler.cmd_new = qmp_marshal_input_query_fdsets,
1319     },
1320
1321 SQMP
1322 query-fdsets
1323 -------------
1324
1325 Return information describing all fd sets.
1326
1327 Arguments: None
1328
1329 Example:
1330
1331 -> { "execute": "query-fdsets" }
1332 <- { "return": [
1333        {
1334          "fds": [
1335            {
1336              "fd": 30,
1337              "opaque": "rdonly:/path/to/file"
1338            },
1339            {
1340              "fd": 24,
1341              "opaque": "rdwr:/path/to/file"
1342            }
1343          ],
1344          "fdset-id": 1
1345        },
1346        {
1347          "fds": [
1348            {
1349              "fd": 28
1350            },
1351            {
1352              "fd": 29
1353            }
1354          ],
1355          "fdset-id": 0
1356        }
1357      ]
1358    }
1359
1360 Note: The list of fd sets is shared by all monitor connections.
1361
1362 EQMP
1363
1364     {
1365         .name       = "block_passwd",
1366         .args_type  = "device:B,password:s",
1367         .mhandler.cmd_new = qmp_marshal_input_block_passwd,
1368     },
1369
1370 SQMP
1371 block_passwd
1372 ------------
1373
1374 Set the password of encrypted block devices.
1375
1376 Arguments:
1377
1378 - "device": device name (json-string)
1379 - "password": password (json-string)
1380
1381 Example:
1382
1383 -> { "execute": "block_passwd", "arguments": { "device": "ide0-hd0",
1384                                                "password": "12345" } }
1385 <- { "return": {} }
1386
1387 EQMP
1388
1389     {
1390         .name       = "block_set_io_throttle",
1391         .args_type  = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1392         .mhandler.cmd_new = qmp_marshal_input_block_set_io_throttle,
1393     },
1394
1395 SQMP
1396 block_set_io_throttle
1397 ------------
1398
1399 Change I/O throttle limits for a block drive.
1400
1401 Arguments:
1402
1403 - "device": device name (json-string)
1404 - "bps":  total throughput limit in bytes per second(json-int)
1405 - "bps_rd":  read throughput limit in bytes per second(json-int)
1406 - "bps_wr":  read throughput limit in bytes per second(json-int)
1407 - "iops":  total I/O operations per second(json-int)
1408 - "iops_rd":  read I/O operations per second(json-int)
1409 - "iops_wr":  write I/O operations per second(json-int)
1410
1411 Example:
1412
1413 -> { "execute": "block_set_io_throttle", "arguments": { "device": "virtio0",
1414                                                "bps": "1000000",
1415                                                "bps_rd": "0",
1416                                                "bps_wr": "0",
1417                                                "iops": "0",
1418                                                "iops_rd": "0",
1419                                                "iops_wr": "0" } }
1420 <- { "return": {} }
1421
1422 EQMP
1423
1424     {
1425         .name       = "set_password",
1426         .args_type  = "protocol:s,password:s,connected:s?",
1427         .mhandler.cmd_new = qmp_marshal_input_set_password,
1428     },
1429
1430 SQMP
1431 set_password
1432 ------------
1433
1434 Set the password for vnc/spice protocols.
1435
1436 Arguments:
1437
1438 - "protocol": protocol name (json-string)
1439 - "password": password (json-string)
1440 - "connected": [ keep | disconnect | fail ] (josn-string, optional)
1441
1442 Example:
1443
1444 -> { "execute": "set_password", "arguments": { "protocol": "vnc",
1445                                                "password": "secret" } }
1446 <- { "return": {} }
1447
1448 EQMP
1449
1450     {
1451         .name       = "expire_password",
1452         .args_type  = "protocol:s,time:s",
1453         .mhandler.cmd_new = qmp_marshal_input_expire_password,
1454     },
1455
1456 SQMP
1457 expire_password
1458 ---------------
1459
1460 Set the password expire time for vnc/spice protocols.
1461
1462 Arguments:
1463
1464 - "protocol": protocol name (json-string)
1465 - "time": [ now | never | +secs | secs ] (json-string)
1466
1467 Example:
1468
1469 -> { "execute": "expire_password", "arguments": { "protocol": "vnc",
1470                                                   "time": "+60" } }
1471 <- { "return": {} }
1472
1473 EQMP
1474
1475     {
1476         .name       = "add_client",
1477         .args_type  = "protocol:s,fdname:s,skipauth:b?,tls:b?",
1478         .mhandler.cmd_new = qmp_marshal_input_add_client,
1479     },
1480
1481 SQMP
1482 add_client
1483 ----------
1484
1485 Add a graphics client
1486
1487 Arguments:
1488
1489 - "protocol": protocol name (json-string)
1490 - "fdname": file descriptor name (json-string)
1491 - "skipauth": whether to skip authentication (json-bool, optional)
1492 - "tls": whether to perform TLS (json-bool, optional)
1493
1494 Example:
1495
1496 -> { "execute": "add_client", "arguments": { "protocol": "vnc",
1497                                              "fdname": "myclient" } }
1498 <- { "return": {} }
1499
1500 EQMP
1501     {
1502         .name       = "qmp_capabilities",
1503         .args_type  = "",
1504         .params     = "",
1505         .help       = "enable QMP capabilities",
1506         .user_print = monitor_user_noop,
1507         .mhandler.cmd_new = do_qmp_capabilities,
1508     },
1509
1510 SQMP
1511 qmp_capabilities
1512 ----------------
1513
1514 Enable QMP capabilities.
1515
1516 Arguments: None.
1517
1518 Example:
1519
1520 -> { "execute": "qmp_capabilities" }
1521 <- { "return": {} }
1522
1523 Note: This command must be issued before issuing any other command.
1524
1525 EQMP
1526
1527     {
1528         .name       = "human-monitor-command",
1529         .args_type  = "command-line:s,cpu-index:i?",
1530         .mhandler.cmd_new = qmp_marshal_input_human_monitor_command,
1531     },
1532
1533 SQMP
1534 human-monitor-command
1535 ---------------------
1536
1537 Execute a Human Monitor command.
1538
1539 Arguments:
1540
1541 - command-line: the command name and its arguments, just like the
1542                 Human Monitor's shell (json-string)
1543 - cpu-index: select the CPU number to be used by commands which access CPU
1544              data, like 'info registers'. The Monitor selects CPU 0 if this
1545              argument is not provided (json-int, optional)
1546
1547 Example:
1548
1549 -> { "execute": "human-monitor-command", "arguments": { "command-line": "info kvm" } }
1550 <- { "return": "kvm support: enabled\r\n" }
1551
1552 Notes:
1553
1554 (1) The Human Monitor is NOT an stable interface, this means that command
1555     names, arguments and responses can change or be removed at ANY time.
1556     Applications that rely on long term stability guarantees should NOT
1557     use this command
1558
1559 (2) Limitations:
1560
1561     o This command is stateless, this means that commands that depend
1562       on state information (such as getfd) might not work
1563
1564     o Commands that prompt the user for data (eg. 'cont' when the block
1565       device is encrypted) don't currently work
1566
1567 3. Query Commands
1568 =================
1569
1570 HXCOMM Each query command below is inside a SQMP/EQMP section, do NOT change
1571 HXCOMM this! We will possibly move query commands definitions inside those
1572 HXCOMM sections, just like regular commands.
1573
1574 EQMP
1575
1576 SQMP
1577 query-version
1578 -------------
1579
1580 Show QEMU version.
1581
1582 Return a json-object with the following information:
1583
1584 - "qemu": A json-object containing three integer values:
1585     - "major": QEMU's major version (json-int)
1586     - "minor": QEMU's minor version (json-int)
1587     - "micro": QEMU's micro version (json-int)
1588 - "package": package's version (json-string)
1589
1590 Example:
1591
1592 -> { "execute": "query-version" }
1593 <- {
1594       "return":{
1595          "qemu":{
1596             "major":0,
1597             "minor":11,
1598             "micro":5
1599          },
1600          "package":""
1601       }
1602    }
1603
1604 EQMP
1605
1606     {
1607         .name       = "query-version",
1608         .args_type  = "",
1609         .mhandler.cmd_new = qmp_marshal_input_query_version,
1610     },
1611
1612 SQMP
1613 query-commands
1614 --------------
1615
1616 List QMP available commands.
1617
1618 Each command is represented by a json-object, the returned value is a json-array
1619 of all commands.
1620
1621 Each json-object contain:
1622
1623 - "name": command's name (json-string)
1624
1625 Example:
1626
1627 -> { "execute": "query-commands" }
1628 <- {
1629       "return":[
1630          {
1631             "name":"query-balloon"
1632          },
1633          {
1634             "name":"system_powerdown"
1635          }
1636       ]
1637    }
1638
1639 Note: This example has been shortened as the real response is too long.
1640
1641 EQMP
1642
1643     {
1644         .name       = "query-commands",
1645         .args_type  = "",
1646         .mhandler.cmd_new = qmp_marshal_input_query_commands,
1647     },
1648
1649 SQMP
1650 query-events
1651 --------------
1652
1653 List QMP available events.
1654
1655 Each event is represented by a json-object, the returned value is a json-array
1656 of all events.
1657
1658 Each json-object contains:
1659
1660 - "name": event's name (json-string)
1661
1662 Example:
1663
1664 -> { "execute": "query-events" }
1665 <- {
1666       "return":[
1667          {
1668             "name":"SHUTDOWN"
1669          },
1670          {
1671             "name":"RESET"
1672          }
1673       ]
1674    }
1675
1676 Note: This example has been shortened as the real response is too long.
1677
1678 EQMP
1679
1680     {
1681         .name       = "query-events",
1682         .args_type  = "",
1683         .mhandler.cmd_new = qmp_marshal_input_query_events,
1684     },
1685
1686 SQMP
1687 query-chardev
1688 -------------
1689
1690 Each device is represented by a json-object. The returned value is a json-array
1691 of all devices.
1692
1693 Each json-object contain the following:
1694
1695 - "label": device's label (json-string)
1696 - "filename": device's file (json-string)
1697
1698 Example:
1699
1700 -> { "execute": "query-chardev" }
1701 <- {
1702       "return":[
1703          {
1704             "label":"monitor",
1705             "filename":"stdio"
1706          },
1707          {
1708             "label":"serial0",
1709             "filename":"vc"
1710          }
1711       ]
1712    }
1713
1714 EQMP
1715
1716     {
1717         .name       = "query-chardev",
1718         .args_type  = "",
1719         .mhandler.cmd_new = qmp_marshal_input_query_chardev,
1720     },
1721
1722 SQMP
1723 query-block
1724 -----------
1725
1726 Show the block devices.
1727
1728 Each block device information is stored in a json-object and the returned value
1729 is a json-array of all devices.
1730
1731 Each json-object contain the following:
1732
1733 - "device": device name (json-string)
1734 - "type": device type (json-string)
1735          - deprecated, retained for backward compatibility
1736          - Possible values: "unknown"
1737 - "removable": true if the device is removable, false otherwise (json-bool)
1738 - "locked": true if the device is locked, false otherwise (json-bool)
1739 - "tray_open": only present if removable, true if the device has a tray,
1740                and it is open (json-bool)
1741 - "inserted": only present if the device is inserted, it is a json-object
1742    containing the following:
1743          - "file": device file name (json-string)
1744          - "ro": true if read-only, false otherwise (json-bool)
1745          - "drv": driver format name (json-string)
1746              - Possible values: "blkdebug", "bochs", "cloop", "cow", "dmg",
1747                                 "file", "file", "ftp", "ftps", "host_cdrom",
1748                                 "host_device", "host_floppy", "http", "https",
1749                                 "nbd", "parallels", "qcow", "qcow2", "raw",
1750                                 "tftp", "vdi", "vmdk", "vpc", "vvfat"
1751          - "backing_file": backing file name (json-string, optional)
1752          - "backing_file_depth": number of files in the backing file chain (json-int)
1753          - "encrypted": true if encrypted, false otherwise (json-bool)
1754          - "bps": limit total bytes per second (json-int)
1755          - "bps_rd": limit read bytes per second (json-int)
1756          - "bps_wr": limit write bytes per second (json-int)
1757          - "iops": limit total I/O operations per second (json-int)
1758          - "iops_rd": limit read operations per second (json-int)
1759          - "iops_wr": limit write operations per second (json-int)
1760          - "image": the detail of the image, it is a json-object containing
1761             the following:
1762              - "filename": image file name (json-string)
1763              - "format": image format (json-string)
1764              - "virtual-size": image capacity in bytes (json-int)
1765              - "dirty-flag": true if image is not cleanly closed, not present
1766                              means clean (json-bool, optional)
1767              - "actual-size": actual size on disk in bytes of the image, not
1768                               present when image does not support thin
1769                               provision (json-int, optional)
1770              - "cluster-size": size of a cluster in bytes, not present if image
1771                                format does not support it (json-int, optional)
1772              - "encrypted": true if the image is encrypted, not present means
1773                             false or the image format does not support
1774                             encryption (json-bool, optional)
1775              - "backing_file": backing file name, not present means no backing
1776                                file is used or the image format does not
1777                                support backing file chain
1778                                (json-string, optional)
1779              - "full-backing-filename": full path of the backing file, not
1780                                         present if it equals backing_file or no
1781                                         backing file is used
1782                                         (json-string, optional)
1783              - "backing-filename-format": the format of the backing file, not
1784                                           present means unknown or no backing
1785                                           file (json-string, optional)
1786              - "snapshots": the internal snapshot info, it is an optional list
1787                 of json-object containing the following:
1788                  - "id": unique snapshot id (json-string)
1789                  - "name": snapshot name (json-string)
1790                  - "vm-state-size": size of the VM state in bytes (json-int)
1791                  - "date-sec": UTC date of the snapshot in seconds (json-int)
1792                  - "date-nsec": fractional part in nanoseconds to be used with
1793                                 date-sec(json-int)
1794                  - "vm-clock-sec": VM clock relative to boot in seconds
1795                                    (json-int)
1796                  - "vm-clock-nsec": fractional part in nanoseconds to be used
1797                                     with vm-clock-sec (json-int)
1798              - "backing-image": the detail of the backing image, it is an
1799                                 optional json-object only present when a
1800                                 backing image present for this image
1801
1802 - "io-status": I/O operation status, only present if the device supports it
1803                and the VM is configured to stop on errors. It's always reset
1804                to "ok" when the "cont" command is issued (json_string, optional)
1805              - Possible values: "ok", "failed", "nospace"
1806
1807 Example:
1808
1809 -> { "execute": "query-block" }
1810 <- {
1811       "return":[
1812          {
1813             "io-status": "ok",
1814             "device":"ide0-hd0",
1815             "locked":false,
1816             "removable":false,
1817             "inserted":{
1818                "ro":false,
1819                "drv":"qcow2",
1820                "encrypted":false,
1821                "file":"disks/test.qcow2",
1822                "backing_file_depth":1,
1823                "bps":1000000,
1824                "bps_rd":0,
1825                "bps_wr":0,
1826                "iops":1000000,
1827                "iops_rd":0,
1828                "iops_wr":0,
1829                "image":{
1830                   "filename":"disks/test.qcow2",
1831                   "format":"qcow2",
1832                   "virtual-size":2048000,
1833                   "backing_file":"base.qcow2",
1834                   "full-backing-filename":"disks/base.qcow2",
1835                   "backing-filename-format:"qcow2",
1836                   "snapshots":[
1837                      {
1838                         "id": "1",
1839                         "name": "snapshot1",
1840                         "vm-state-size": 0,
1841                         "date-sec": 10000200,
1842                         "date-nsec": 12,
1843                         "vm-clock-sec": 206,
1844                         "vm-clock-nsec": 30
1845                      }
1846                   ],
1847                   "backing-image":{
1848                       "filename":"disks/base.qcow2",
1849                       "format":"qcow2",
1850                       "virtual-size":2048000
1851                   }
1852                }
1853             },
1854             "type":"unknown"
1855          },
1856          {
1857             "io-status": "ok",
1858             "device":"ide1-cd0",
1859             "locked":false,
1860             "removable":true,
1861             "type":"unknown"
1862          },
1863          {
1864             "device":"floppy0",
1865             "locked":false,
1866             "removable":true,
1867             "type":"unknown"
1868          },
1869          {
1870             "device":"sd0",
1871             "locked":false,
1872             "removable":true,
1873             "type":"unknown"
1874          }
1875       ]
1876    }
1877
1878 EQMP
1879
1880     {
1881         .name       = "query-block",
1882         .args_type  = "",
1883         .mhandler.cmd_new = qmp_marshal_input_query_block,
1884     },
1885
1886 SQMP
1887 query-blockstats
1888 ----------------
1889
1890 Show block device statistics.
1891
1892 Each device statistic information is stored in a json-object and the returned
1893 value is a json-array of all devices.
1894
1895 Each json-object contain the following:
1896
1897 - "device": device name (json-string)
1898 - "stats": A json-object with the statistics information, it contains:
1899     - "rd_bytes": bytes read (json-int)
1900     - "wr_bytes": bytes written (json-int)
1901     - "rd_operations": read operations (json-int)
1902     - "wr_operations": write operations (json-int)
1903     - "flush_operations": cache flush operations (json-int)
1904     - "wr_total_time_ns": total time spend on writes in nano-seconds (json-int)
1905     - "rd_total_time_ns": total time spend on reads in nano-seconds (json-int)
1906     - "flush_total_time_ns": total time spend on cache flushes in nano-seconds (json-int)
1907     - "wr_highest_offset": Highest offset of a sector written since the
1908                            BlockDriverState has been opened (json-int)
1909 - "parent": Contains recursively the statistics of the underlying
1910             protocol (e.g. the host file for a qcow2 image). If there is
1911             no underlying protocol, this field is omitted
1912             (json-object, optional)
1913
1914 Example:
1915
1916 -> { "execute": "query-blockstats" }
1917 <- {
1918       "return":[
1919          {
1920             "device":"ide0-hd0",
1921             "parent":{
1922                "stats":{
1923                   "wr_highest_offset":3686448128,
1924                   "wr_bytes":9786368,
1925                   "wr_operations":751,
1926                   "rd_bytes":122567168,
1927                   "rd_operations":36772
1928                   "wr_total_times_ns":313253456
1929                   "rd_total_times_ns":3465673657
1930                   "flush_total_times_ns":49653
1931                   "flush_operations":61,
1932                }
1933             },
1934             "stats":{
1935                "wr_highest_offset":2821110784,
1936                "wr_bytes":9786368,
1937                "wr_operations":692,
1938                "rd_bytes":122739200,
1939                "rd_operations":36604
1940                "flush_operations":51,
1941                "wr_total_times_ns":313253456
1942                "rd_total_times_ns":3465673657
1943                "flush_total_times_ns":49653
1944             }
1945          },
1946          {
1947             "device":"ide1-cd0",
1948             "stats":{
1949                "wr_highest_offset":0,
1950                "wr_bytes":0,
1951                "wr_operations":0,
1952                "rd_bytes":0,
1953                "rd_operations":0
1954                "flush_operations":0,
1955                "wr_total_times_ns":0
1956                "rd_total_times_ns":0
1957                "flush_total_times_ns":0
1958             }
1959          },
1960          {
1961             "device":"floppy0",
1962             "stats":{
1963                "wr_highest_offset":0,
1964                "wr_bytes":0,
1965                "wr_operations":0,
1966                "rd_bytes":0,
1967                "rd_operations":0
1968                "flush_operations":0,
1969                "wr_total_times_ns":0
1970                "rd_total_times_ns":0
1971                "flush_total_times_ns":0
1972             }
1973          },
1974          {
1975             "device":"sd0",
1976             "stats":{
1977                "wr_highest_offset":0,
1978                "wr_bytes":0,
1979                "wr_operations":0,
1980                "rd_bytes":0,
1981                "rd_operations":0
1982                "flush_operations":0,
1983                "wr_total_times_ns":0
1984                "rd_total_times_ns":0
1985                "flush_total_times_ns":0
1986             }
1987          }
1988       ]
1989    }
1990
1991 EQMP
1992
1993     {
1994         .name       = "query-blockstats",
1995         .args_type  = "",
1996         .mhandler.cmd_new = qmp_marshal_input_query_blockstats,
1997     },
1998
1999 SQMP
2000 query-cpus
2001 ----------
2002
2003 Show CPU information.
2004
2005 Return a json-array. Each CPU is represented by a json-object, which contains:
2006
2007 - "CPU": CPU index (json-int)
2008 - "current": true if this is the current CPU, false otherwise (json-bool)
2009 - "halted": true if the cpu is halted, false otherwise (json-bool)
2010 - Current program counter. The key's name depends on the architecture:
2011      "pc": i386/x86_64 (json-int)
2012      "nip": PPC (json-int)
2013      "pc" and "npc": sparc (json-int)
2014      "PC": mips (json-int)
2015 - "thread_id": ID of the underlying host thread (json-int)
2016
2017 Example:
2018
2019 -> { "execute": "query-cpus" }
2020 <- {
2021       "return":[
2022          {
2023             "CPU":0,
2024             "current":true,
2025             "halted":false,
2026             "pc":3227107138
2027             "thread_id":3134
2028          },
2029          {
2030             "CPU":1,
2031             "current":false,
2032             "halted":true,
2033             "pc":7108165
2034             "thread_id":3135
2035          }
2036       ]
2037    }
2038
2039 EQMP
2040
2041     {
2042         .name       = "query-cpus",
2043         .args_type  = "",
2044         .mhandler.cmd_new = qmp_marshal_input_query_cpus,
2045     },
2046
2047 SQMP
2048 query-pci
2049 ---------
2050
2051 PCI buses and devices information.
2052
2053 The returned value is a json-array of all buses. Each bus is represented by
2054 a json-object, which has a key with a json-array of all PCI devices attached
2055 to it. Each device is represented by a json-object.
2056
2057 The bus json-object contains the following:
2058
2059 - "bus": bus number (json-int)
2060 - "devices": a json-array of json-objects, each json-object represents a
2061              PCI device
2062
2063 The PCI device json-object contains the following:
2064
2065 - "bus": identical to the parent's bus number (json-int)
2066 - "slot": slot number (json-int)
2067 - "function": function number (json-int)
2068 - "class_info": a json-object containing:
2069      - "desc": device class description (json-string, optional)
2070      - "class": device class number (json-int)
2071 - "id": a json-object containing:
2072      - "device": device ID (json-int)
2073      - "vendor": vendor ID (json-int)
2074 - "irq": device's IRQ if assigned (json-int, optional)
2075 - "qdev_id": qdev id string (json-string)
2076 - "pci_bridge": It's a json-object, only present if this device is a
2077                 PCI bridge, contains:
2078      - "bus": bus number (json-int)
2079      - "secondary": secondary bus number (json-int)
2080      - "subordinate": subordinate bus number (json-int)
2081      - "io_range": I/O memory range information, a json-object with the
2082                    following members:
2083                  - "base": base address, in bytes (json-int)
2084                  - "limit": limit address, in bytes (json-int)
2085      - "memory_range": memory range information, a json-object with the
2086                        following members:
2087                  - "base": base address, in bytes (json-int)
2088                  - "limit": limit address, in bytes (json-int)
2089      - "prefetchable_range": Prefetchable memory range information, a
2090                              json-object with the following members:
2091                  - "base": base address, in bytes (json-int)
2092                  - "limit": limit address, in bytes (json-int)
2093      - "devices": a json-array of PCI devices if there's any attached, each
2094                   each element is represented by a json-object, which contains
2095                   the same members of the 'PCI device json-object' described
2096                   above (optional)
2097 - "regions": a json-array of json-objects, each json-object represents a
2098              memory region of this device
2099
2100 The memory range json-object contains the following:
2101
2102 - "base": base memory address (json-int)
2103 - "limit": limit value (json-int)
2104
2105 The region json-object can be an I/O region or a memory region, an I/O region
2106 json-object contains the following:
2107
2108 - "type": "io" (json-string, fixed)
2109 - "bar": BAR number (json-int)
2110 - "address": memory address (json-int)
2111 - "size": memory size (json-int)
2112
2113 A memory region json-object contains the following:
2114
2115 - "type": "memory" (json-string, fixed)
2116 - "bar": BAR number (json-int)
2117 - "address": memory address (json-int)
2118 - "size": memory size (json-int)
2119 - "mem_type_64": true or false (json-bool)
2120 - "prefetch": true or false (json-bool)
2121
2122 Example:
2123
2124 -> { "execute": "query-pci" }
2125 <- {
2126       "return":[
2127          {
2128             "bus":0,
2129             "devices":[
2130                {
2131                   "bus":0,
2132                   "qdev_id":"",
2133                   "slot":0,
2134                   "class_info":{
2135                      "class":1536,
2136                      "desc":"Host bridge"
2137                   },
2138                   "id":{
2139                      "device":32902,
2140                      "vendor":4663
2141                   },
2142                   "function":0,
2143                   "regions":[
2144
2145                   ]
2146                },
2147                {
2148                   "bus":0,
2149                   "qdev_id":"",
2150                   "slot":1,
2151                   "class_info":{
2152                      "class":1537,
2153                      "desc":"ISA bridge"
2154                   },
2155                   "id":{
2156                      "device":32902,
2157                      "vendor":28672
2158                   },
2159                   "function":0,
2160                   "regions":[
2161
2162                   ]
2163                },
2164                {
2165                   "bus":0,
2166                   "qdev_id":"",
2167                   "slot":1,
2168                   "class_info":{
2169                      "class":257,
2170                      "desc":"IDE controller"
2171                   },
2172                   "id":{
2173                      "device":32902,
2174                      "vendor":28688
2175                   },
2176                   "function":1,
2177                   "regions":[
2178                      {
2179                         "bar":4,
2180                         "size":16,
2181                         "address":49152,
2182                         "type":"io"
2183                      }
2184                   ]
2185                },
2186                {
2187                   "bus":0,
2188                   "qdev_id":"",
2189                   "slot":2,
2190                   "class_info":{
2191                      "class":768,
2192                      "desc":"VGA controller"
2193                   },
2194                   "id":{
2195                      "device":4115,
2196                      "vendor":184
2197                   },
2198                   "function":0,
2199                   "regions":[
2200                      {
2201                         "prefetch":true,
2202                         "mem_type_64":false,
2203                         "bar":0,
2204                         "size":33554432,
2205                         "address":4026531840,
2206                         "type":"memory"
2207                      },
2208                      {
2209                         "prefetch":false,
2210                         "mem_type_64":false,
2211                         "bar":1,
2212                         "size":4096,
2213                         "address":4060086272,
2214                         "type":"memory"
2215                      },
2216                      {
2217                         "prefetch":false,
2218                         "mem_type_64":false,
2219                         "bar":6,
2220                         "size":65536,
2221                         "address":-1,
2222                         "type":"memory"
2223                      }
2224                   ]
2225                },
2226                {
2227                   "bus":0,
2228                   "qdev_id":"",
2229                   "irq":11,
2230                   "slot":4,
2231                   "class_info":{
2232                      "class":1280,
2233                      "desc":"RAM controller"
2234                   },
2235                   "id":{
2236                      "device":6900,
2237                      "vendor":4098
2238                   },
2239                   "function":0,
2240                   "regions":[
2241                      {
2242                         "bar":0,
2243                         "size":32,
2244                         "address":49280,
2245                         "type":"io"
2246                      }
2247                   ]
2248                }
2249             ]
2250          }
2251       ]
2252    }
2253
2254 Note: This example has been shortened as the real response is too long.
2255
2256 EQMP
2257
2258     {
2259         .name       = "query-pci",
2260         .args_type  = "",
2261         .mhandler.cmd_new = qmp_marshal_input_query_pci,
2262     },
2263
2264 SQMP
2265 query-kvm
2266 ---------
2267
2268 Show KVM information.
2269
2270 Return a json-object with the following information:
2271
2272 - "enabled": true if KVM support is enabled, false otherwise (json-bool)
2273 - "present": true if QEMU has KVM support, false otherwise (json-bool)
2274
2275 Example:
2276
2277 -> { "execute": "query-kvm" }
2278 <- { "return": { "enabled": true, "present": true } }
2279
2280 EQMP
2281
2282     {
2283         .name       = "query-kvm",
2284         .args_type  = "",
2285         .mhandler.cmd_new = qmp_marshal_input_query_kvm,
2286     },
2287
2288 SQMP
2289 query-status
2290 ------------
2291
2292 Return a json-object with the following information:
2293
2294 - "running": true if the VM is running, or false if it is paused (json-bool)
2295 - "singlestep": true if the VM is in single step mode,
2296                 false otherwise (json-bool)
2297 - "status": one of the following values (json-string)
2298     "debug" - QEMU is running on a debugger
2299     "inmigrate" - guest is paused waiting for an incoming migration
2300     "internal-error" - An internal error that prevents further guest
2301     execution has occurred
2302     "io-error" - the last IOP has failed and the device is configured
2303     to pause on I/O errors
2304     "paused" - guest has been paused via the 'stop' command
2305     "postmigrate" - guest is paused following a successful 'migrate'
2306     "prelaunch" - QEMU was started with -S and guest has not started
2307     "finish-migrate" - guest is paused to finish the migration process
2308     "restore-vm" - guest is paused to restore VM state
2309     "running" - guest is actively running
2310     "save-vm" - guest is paused to save the VM state
2311     "shutdown" - guest is shut down (and -no-shutdown is in use)
2312     "watchdog" - the watchdog action is configured to pause and
2313      has been triggered
2314
2315 Example:
2316
2317 -> { "execute": "query-status" }
2318 <- { "return": { "running": true, "singlestep": false, "status": "running" } }
2319
2320 EQMP
2321
2322     {
2323         .name       = "query-status",
2324         .args_type  = "",
2325         .mhandler.cmd_new = qmp_marshal_input_query_status,
2326     },
2327
2328 SQMP
2329 query-mice
2330 ----------
2331
2332 Show VM mice information.
2333
2334 Each mouse is represented by a json-object, the returned value is a json-array
2335 of all mice.
2336
2337 The mouse json-object contains the following:
2338
2339 - "name": mouse's name (json-string)
2340 - "index": mouse's index (json-int)
2341 - "current": true if this mouse is receiving events, false otherwise (json-bool)
2342 - "absolute": true if the mouse generates absolute input events (json-bool)
2343
2344 Example:
2345
2346 -> { "execute": "query-mice" }
2347 <- {
2348       "return":[
2349          {
2350             "name":"QEMU Microsoft Mouse",
2351             "index":0,
2352             "current":false,
2353             "absolute":false
2354          },
2355          {
2356             "name":"QEMU PS/2 Mouse",
2357             "index":1,
2358             "current":true,
2359             "absolute":true
2360          }
2361       ]
2362    }
2363
2364 EQMP
2365
2366     {
2367         .name       = "query-mice",
2368         .args_type  = "",
2369         .mhandler.cmd_new = qmp_marshal_input_query_mice,
2370     },
2371
2372 SQMP
2373 query-vnc
2374 ---------
2375
2376 Show VNC server information.
2377
2378 Return a json-object with server information. Connected clients are returned
2379 as a json-array of json-objects.
2380
2381 The main json-object contains the following:
2382
2383 - "enabled": true or false (json-bool)
2384 - "host": server's IP address (json-string)
2385 - "family": address family (json-string)
2386          - Possible values: "ipv4", "ipv6", "unix", "unknown"
2387 - "service": server's port number (json-string)
2388 - "auth": authentication method (json-string)
2389          - Possible values: "invalid", "none", "ra2", "ra2ne", "sasl", "tight",
2390                             "tls", "ultra", "unknown", "vencrypt", "vencrypt",
2391                             "vencrypt+plain", "vencrypt+tls+none",
2392                             "vencrypt+tls+plain", "vencrypt+tls+sasl",
2393                             "vencrypt+tls+vnc", "vencrypt+x509+none",
2394                             "vencrypt+x509+plain", "vencrypt+x509+sasl",
2395                             "vencrypt+x509+vnc", "vnc"
2396 - "clients": a json-array of all connected clients
2397
2398 Clients are described by a json-object, each one contain the following:
2399
2400 - "host": client's IP address (json-string)
2401 - "family": address family (json-string)
2402          - Possible values: "ipv4", "ipv6", "unix", "unknown"
2403 - "service": client's port number (json-string)
2404 - "x509_dname": TLS dname (json-string, optional)
2405 - "sasl_username": SASL username (json-string, optional)
2406
2407 Example:
2408
2409 -> { "execute": "query-vnc" }
2410 <- {
2411       "return":{
2412          "enabled":true,
2413          "host":"0.0.0.0",
2414          "service":"50402",
2415          "auth":"vnc",
2416          "family":"ipv4",
2417          "clients":[
2418             {
2419                "host":"127.0.0.1",
2420                "service":"50401",
2421                "family":"ipv4"
2422             }
2423          ]
2424       }
2425    }
2426
2427 EQMP
2428
2429     {
2430         .name       = "query-vnc",
2431         .args_type  = "",
2432         .mhandler.cmd_new = qmp_marshal_input_query_vnc,
2433     },
2434
2435 SQMP
2436 query-spice
2437 -----------
2438
2439 Show SPICE server information.
2440
2441 Return a json-object with server information. Connected clients are returned
2442 as a json-array of json-objects.
2443
2444 The main json-object contains the following:
2445
2446 - "enabled": true or false (json-bool)
2447 - "host": server's IP address (json-string)
2448 - "port": server's port number (json-int, optional)
2449 - "tls-port": server's port number (json-int, optional)
2450 - "auth": authentication method (json-string)
2451          - Possible values: "none", "spice"
2452 - "channels": a json-array of all active channels clients
2453
2454 Channels are described by a json-object, each one contain the following:
2455
2456 - "host": client's IP address (json-string)
2457 - "family": address family (json-string)
2458          - Possible values: "ipv4", "ipv6", "unix", "unknown"
2459 - "port": client's port number (json-string)
2460 - "connection-id": spice connection id.  All channels with the same id
2461                    belong to the same spice session (json-int)
2462 - "channel-type": channel type.  "1" is the main control channel, filter for
2463                   this one if you want track spice sessions only (json-int)
2464 - "channel-id": channel id.  Usually "0", might be different needed when
2465                 multiple channels of the same type exist, such as multiple
2466                 display channels in a multihead setup (json-int)
2467 - "tls": whevener the channel is encrypted (json-bool)
2468
2469 Example:
2470
2471 -> { "execute": "query-spice" }
2472 <- {
2473       "return": {
2474          "enabled": true,
2475          "auth": "spice",
2476          "port": 5920,
2477          "tls-port": 5921,
2478          "host": "0.0.0.0",
2479          "channels": [
2480             {
2481                "port": "54924",
2482                "family": "ipv4",
2483                "channel-type": 1,
2484                "connection-id": 1804289383,
2485                "host": "127.0.0.1",
2486                "channel-id": 0,
2487                "tls": true
2488             },
2489             {
2490                "port": "36710",
2491                "family": "ipv4",
2492                "channel-type": 4,
2493                "connection-id": 1804289383,
2494                "host": "127.0.0.1",
2495                "channel-id": 0,
2496                "tls": false
2497             },
2498             [ ... more channels follow ... ]
2499          ]
2500       }
2501    }
2502
2503 EQMP
2504
2505 #if defined(CONFIG_SPICE)
2506     {
2507         .name       = "query-spice",
2508         .args_type  = "",
2509         .mhandler.cmd_new = qmp_marshal_input_query_spice,
2510     },
2511 #endif
2512
2513 SQMP
2514 query-name
2515 ----------
2516
2517 Show VM name.
2518
2519 Return a json-object with the following information:
2520
2521 - "name": VM's name (json-string, optional)
2522
2523 Example:
2524
2525 -> { "execute": "query-name" }
2526 <- { "return": { "name": "qemu-name" } }
2527
2528 EQMP
2529
2530     {
2531         .name       = "query-name",
2532         .args_type  = "",
2533         .mhandler.cmd_new = qmp_marshal_input_query_name,
2534     },
2535
2536 SQMP
2537 query-uuid
2538 ----------
2539
2540 Show VM UUID.
2541
2542 Return a json-object with the following information:
2543
2544 - "UUID": Universally Unique Identifier (json-string)
2545
2546 Example:
2547
2548 -> { "execute": "query-uuid" }
2549 <- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } }
2550
2551 EQMP
2552
2553     {
2554         .name       = "query-uuid",
2555         .args_type  = "",
2556         .mhandler.cmd_new = qmp_marshal_input_query_uuid,
2557     },
2558
2559 SQMP
2560 query-command-line-options
2561 --------------------------
2562
2563 Show command line option schema.
2564
2565 Return a json-array of command line option schema for all options (or for
2566 the given option), returning an error if the given option doesn't exist.
2567
2568 Each array entry contains the following:
2569
2570 - "option": option name (json-string)
2571 - "parameters": a json-array describes all parameters of the option:
2572     - "name": parameter name (json-string)
2573     - "type": parameter type (one of 'string', 'boolean', 'number',
2574               or 'size')
2575     - "help": human readable description of the parameter
2576               (json-string, optional)
2577
2578 Example:
2579
2580 -> { "execute": "query-command-line-options", "arguments": { "option": "option-rom" } }
2581 <- { "return": [
2582         {
2583             "parameters": [
2584                 {
2585                     "name": "romfile",
2586                     "type": "string"
2587                 },
2588                 {
2589                     "name": "bootindex",
2590                     "type": "number"
2591                 }
2592             ],
2593             "option": "option-rom"
2594         }
2595      ]
2596    }
2597
2598 EQMP
2599
2600     {
2601         .name       = "query-command-line-options",
2602         .args_type  = "option:s?",
2603         .mhandler.cmd_new = qmp_marshal_input_query_command_line_options,
2604     },
2605
2606 SQMP
2607 query-migrate
2608 -------------
2609
2610 Migration status.
2611
2612 Return a json-object. If migration is active there will be another json-object
2613 with RAM migration status and if block migration is active another one with
2614 block migration status.
2615
2616 The main json-object contains the following:
2617
2618 - "status": migration status (json-string)
2619      - Possible values: "active", "completed", "failed", "cancelled"
2620 - "total-time": total amount of ms since migration started.  If
2621                 migration has ended, it returns the total migration
2622                 time (json-int)
2623 - "downtime": only present when migration has finished correctly
2624               total amount in ms for downtime that happened (json-int)
2625 - "expected-downtime": only present while migration is active
2626                 total amount in ms for downtime that was calculated on
2627                 the last bitmap round (json-int)
2628 - "ram": only present if "status" is "active", it is a json-object with the
2629   following RAM information:
2630          - "transferred": amount transferred in bytes (json-int)
2631          - "remaining": amount remaining to transfer in bytes (json-int)
2632          - "total": total amount of memory in bytes (json-int)
2633          - "duplicate": number of pages filled entirely with the same
2634             byte (json-int)
2635             These are sent over the wire much more efficiently.
2636          - "skipped": number of skipped zero pages (json-int)
2637          - "normal" : number of whole pages transferred.  I.e. they
2638             were not sent as duplicate or xbzrle pages (json-int)
2639          - "normal-bytes" : number of bytes transferred in whole
2640             pages. This is just normal pages times size of one page,
2641             but this way upper levels don't need to care about page
2642             size (json-int)
2643 - "disk": only present if "status" is "active" and it is a block migration,
2644   it is a json-object with the following disk information:
2645          - "transferred": amount transferred in bytes (json-int)
2646          - "remaining": amount remaining to transfer in bytes json-int)
2647          - "total": total disk size in bytes (json-int)
2648 - "xbzrle-cache": only present if XBZRLE is active.
2649   It is a json-object with the following XBZRLE information:
2650          - "cache-size": XBZRLE cache size in bytes
2651          - "bytes": number of bytes transferred for XBZRLE compressed pages
2652          - "pages": number of XBZRLE compressed pages
2653          - "cache-miss": number of XBRZRLE page cache misses
2654          - "overflow": number of times XBZRLE overflows.  This means
2655            that the XBZRLE encoding was bigger than just sent the
2656            whole page, and then we sent the whole page instead (as as
2657            normal page).
2658
2659 Examples:
2660
2661 1. Before the first migration
2662
2663 -> { "execute": "query-migrate" }
2664 <- { "return": {} }
2665
2666 2. Migration is done and has succeeded
2667
2668 -> { "execute": "query-migrate" }
2669 <- { "return": {
2670         "status": "completed",
2671         "ram":{
2672           "transferred":123,
2673           "remaining":123,
2674           "total":246,
2675           "total-time":12345,
2676           "downtime":12345,
2677           "duplicate":123,
2678           "normal":123,
2679           "normal-bytes":123456
2680         }
2681      }
2682    }
2683
2684 3. Migration is done and has failed
2685
2686 -> { "execute": "query-migrate" }
2687 <- { "return": { "status": "failed" } }
2688
2689 4. Migration is being performed and is not a block migration:
2690
2691 -> { "execute": "query-migrate" }
2692 <- {
2693       "return":{
2694          "status":"active",
2695          "ram":{
2696             "transferred":123,
2697             "remaining":123,
2698             "total":246,
2699             "total-time":12345,
2700             "expected-downtime":12345,
2701             "duplicate":123,
2702             "normal":123,
2703             "normal-bytes":123456
2704          }
2705       }
2706    }
2707
2708 5. Migration is being performed and is a block migration:
2709
2710 -> { "execute": "query-migrate" }
2711 <- {
2712       "return":{
2713          "status":"active",
2714          "ram":{
2715             "total":1057024,
2716             "remaining":1053304,
2717             "transferred":3720,
2718             "total-time":12345,
2719             "expected-downtime":12345,
2720             "duplicate":123,
2721             "normal":123,
2722             "normal-bytes":123456
2723          },
2724          "disk":{
2725             "total":20971520,
2726             "remaining":20880384,
2727             "transferred":91136
2728          }
2729       }
2730    }
2731
2732 6. Migration is being performed and XBZRLE is active:
2733
2734 -> { "execute": "query-migrate" }
2735 <- {
2736       "return":{
2737          "status":"active",
2738          "capabilities" : [ { "capability": "xbzrle", "state" : true } ],
2739          "ram":{
2740             "total":1057024,
2741             "remaining":1053304,
2742             "transferred":3720,
2743             "total-time":12345,
2744             "expected-downtime":12345,
2745             "duplicate":10,
2746             "normal":3333,
2747             "normal-bytes":3412992
2748          },
2749          "xbzrle-cache":{
2750             "cache-size":67108864,
2751             "bytes":20971520,
2752             "pages":2444343,
2753             "cache-miss":2244,
2754             "overflow":34434
2755          }
2756       }
2757    }
2758
2759 EQMP
2760
2761     {
2762         .name       = "query-migrate",
2763         .args_type  = "",
2764         .mhandler.cmd_new = qmp_marshal_input_query_migrate,
2765     },
2766
2767 SQMP
2768 migrate-set-capabilities
2769 ------------------------
2770
2771 Enable/Disable migration capabilities
2772
2773 - "xbzrle": XBZRLE support
2774
2775 Arguments:
2776
2777 Example:
2778
2779 -> { "execute": "migrate-set-capabilities" , "arguments":
2780      { "capabilities": [ { "capability": "xbzrle", "state": true } ] } }
2781
2782 EQMP
2783
2784     {
2785         .name       = "migrate-set-capabilities",
2786         .args_type  = "capabilities:O",
2787         .params     = "capability:s,state:b",
2788         .mhandler.cmd_new = qmp_marshal_input_migrate_set_capabilities,
2789     },
2790 SQMP
2791 query-migrate-capabilities
2792 --------------------------
2793
2794 Query current migration capabilities
2795
2796 - "capabilities": migration capabilities state
2797          - "xbzrle" : XBZRLE state (json-bool)
2798
2799 Arguments:
2800
2801 Example:
2802
2803 -> { "execute": "query-migrate-capabilities" }
2804 <- { "return": [ { "state": false, "capability": "xbzrle" } ] }
2805
2806 EQMP
2807
2808     {
2809         .name       = "query-migrate-capabilities",
2810         .args_type  = "",
2811         .mhandler.cmd_new = qmp_marshal_input_query_migrate_capabilities,
2812     },
2813
2814 SQMP
2815 query-balloon
2816 -------------
2817
2818 Show balloon information.
2819
2820 Make an asynchronous request for balloon info. When the request completes a
2821 json-object will be returned containing the following data:
2822
2823 - "actual": current balloon value in bytes (json-int)
2824
2825 Example:
2826
2827 -> { "execute": "query-balloon" }
2828 <- {
2829       "return":{
2830          "actual":1073741824,
2831       }
2832    }
2833
2834 EQMP
2835
2836     {
2837         .name       = "query-balloon",
2838         .args_type  = "",
2839         .mhandler.cmd_new = qmp_marshal_input_query_balloon,
2840     },
2841
2842     {
2843         .name       = "query-block-jobs",
2844         .args_type  = "",
2845         .mhandler.cmd_new = qmp_marshal_input_query_block_jobs,
2846     },
2847
2848     {
2849         .name       = "qom-list",
2850         .args_type  = "path:s",
2851         .mhandler.cmd_new = qmp_marshal_input_qom_list,
2852     },
2853
2854     {
2855         .name       = "qom-set",
2856         .args_type  = "path:s,property:s,value:q",
2857         .mhandler.cmd_new = qmp_qom_set,
2858     },
2859
2860     {
2861         .name       = "qom-get",
2862         .args_type  = "path:s,property:s",
2863         .mhandler.cmd_new = qmp_qom_get,
2864     },
2865
2866     {
2867         .name       = "nbd-server-start",
2868         .args_type  = "addr:q",
2869         .mhandler.cmd_new = qmp_marshal_input_nbd_server_start,
2870     },
2871     {
2872         .name       = "nbd-server-add",
2873         .args_type  = "device:B,writable:b?",
2874         .mhandler.cmd_new = qmp_marshal_input_nbd_server_add,
2875     },
2876     {
2877         .name       = "nbd-server-stop",
2878         .args_type  = "",
2879         .mhandler.cmd_new = qmp_marshal_input_nbd_server_stop,
2880     },
2881
2882     {
2883         .name       = "change-vnc-password",
2884         .args_type  = "password:s",
2885         .mhandler.cmd_new = qmp_marshal_input_change_vnc_password,
2886     },
2887     {
2888         .name       = "qom-list-types",
2889         .args_type  = "implements:s?,abstract:b?",
2890         .mhandler.cmd_new = qmp_marshal_input_qom_list_types,
2891     },
2892
2893     {
2894         .name       = "device-list-properties",
2895         .args_type  = "typename:s",
2896         .mhandler.cmd_new = qmp_marshal_input_device_list_properties,
2897     },
2898
2899     {
2900         .name       = "query-machines",
2901         .args_type  = "",
2902         .mhandler.cmd_new = qmp_marshal_input_query_machines,
2903     },
2904
2905     {
2906         .name       = "query-cpu-definitions",
2907         .args_type  = "",
2908         .mhandler.cmd_new = qmp_marshal_input_query_cpu_definitions,
2909     },
2910
2911     {
2912         .name       = "query-target",
2913         .args_type  = "",
2914         .mhandler.cmd_new = qmp_marshal_input_query_target,
2915     },
2916
2917     {
2918         .name       = "query-tpm",
2919         .args_type  = "",
2920         .mhandler.cmd_new = qmp_marshal_input_query_tpm,
2921     },
2922
2923 SQMP
2924 query-tpm
2925 ---------
2926
2927 Return information about the TPM device.
2928
2929 Arguments: None
2930
2931 Example:
2932
2933 -> { "execute": "query-tpm" }
2934 <- { "return":
2935      [
2936        { "model": "tpm-tis",
2937          "options":
2938            { "type": "passthrough",
2939              "data":
2940                { "cancel-path": "/sys/class/misc/tpm0/device/cancel",
2941                  "path": "/dev/tpm0"
2942                }
2943            },
2944          "id": "tpm0"
2945        }
2946      ]
2947    }
2948
2949 EQMP
2950
2951     {
2952         .name       = "query-tpm-models",
2953         .args_type  = "",
2954         .mhandler.cmd_new = qmp_marshal_input_query_tpm_models,
2955     },
2956
2957 SQMP
2958 query-tpm-models
2959 ----------------
2960
2961 Return a list of supported TPM models.
2962
2963 Arguments: None
2964
2965 Example:
2966
2967 -> { "execute": "query-tpm-models" }
2968 <- { "return": [ "tpm-tis" ] }
2969
2970 EQMP
2971
2972     {
2973         .name       = "query-tpm-types",
2974         .args_type  = "",
2975         .mhandler.cmd_new = qmp_marshal_input_query_tpm_types,
2976     },
2977
2978 SQMP
2979 query-tpm-types
2980 ---------------
2981
2982 Return a list of supported TPM types.
2983
2984 Arguments: None
2985
2986 Example:
2987
2988 -> { "execute": "query-tpm-types" }
2989 <- { "return": [ "passthrough" ] }
2990
2991 EQMP
2992
2993     {
2994         .name       = "chardev-add",
2995         .args_type  = "id:s,backend:q",
2996         .mhandler.cmd_new = qmp_marshal_input_chardev_add,
2997     },
2998
2999 SQMP
3000 chardev-add
3001 ----------------
3002
3003 Add a chardev.
3004
3005 Arguments:
3006
3007 - "id": the chardev's ID, must be unique (json-string)
3008 - "backend": chardev backend type + parameters
3009
3010 Examples:
3011
3012 -> { "execute" : "chardev-add",
3013      "arguments" : { "id" : "foo",
3014                      "backend" : { "type" : "null", "data" : {} } } }
3015 <- { "return": {} }
3016
3017 -> { "execute" : "chardev-add",
3018      "arguments" : { "id" : "bar",
3019                      "backend" : { "type" : "file",
3020                                    "data" : { "out" : "/tmp/bar.log" } } } }
3021 <- { "return": {} }
3022
3023 -> { "execute" : "chardev-add",
3024      "arguments" : { "id" : "baz",
3025                      "backend" : { "type" : "pty", "data" : {} } } }
3026 <- { "return": { "pty" : "/dev/pty/42" } }
3027
3028 EQMP
3029
3030     {
3031         .name       = "chardev-remove",
3032         .args_type  = "id:s",
3033         .mhandler.cmd_new = qmp_marshal_input_chardev_remove,
3034     },
3035
3036
3037 SQMP
3038 chardev-remove
3039 --------------
3040
3041 Remove a chardev.
3042
3043 Arguments:
3044
3045 - "id": the chardev's ID, must exist and not be in use (json-string)
3046
3047 Example:
3048
3049 -> { "execute": "chardev-remove", "arguments": { "id" : "foo" } }
3050 <- { "return": {} }
3051
3052 EQMP
3053     {
3054         .name       = "query-rx-filter",
3055         .args_type  = "name:s?",
3056         .mhandler.cmd_new = qmp_marshal_input_query_rx_filter,
3057     },
3058
3059 SQMP
3060 query-rx-filter
3061 ---------------
3062
3063 Show rx-filter information.
3064
3065 Returns a json-array of rx-filter information for all NICs (or for the
3066 given NIC), returning an error if the given NIC doesn't exist, or
3067 given NIC doesn't support rx-filter querying, or given net client
3068 isn't a NIC.
3069
3070 The query will clear the event notification flag of each NIC, then qemu
3071 will start to emit event to QMP monitor.
3072
3073 Each array entry contains the following:
3074
3075 - "name": net client name (json-string)
3076 - "promiscuous": promiscuous mode is enabled (json-bool)
3077 - "multicast": multicast receive state (one of 'normal', 'none', 'all')
3078 - "unicast": unicast receive state  (one of 'normal', 'none', 'all')
3079 - "broadcast-allowed": allow to receive broadcast (json-bool)
3080 - "multicast-overflow": multicast table is overflowed (json-bool)
3081 - "unicast-overflow": unicast table is overflowed (json-bool)
3082 - "main-mac": main macaddr string (json-string)
3083 - "vlan-table": a json-array of active vlan id
3084 - "unicast-table": a json-array of unicast macaddr string
3085 - "multicast-table": a json-array of multicast macaddr string
3086
3087 Example:
3088
3089 -> { "execute": "query-rx-filter", "arguments": { "name": "vnet0" } }
3090 <- { "return": [
3091         {
3092             "promiscuous": true,
3093             "name": "vnet0",
3094             "main-mac": "52:54:00:12:34:56",
3095             "unicast": "normal",
3096             "vlan-table": [
3097                 4,
3098                 0
3099             ],
3100             "unicast-table": [
3101             ],
3102             "multicast": "normal",
3103             "multicast-overflow": false,
3104             "unicast-overflow": false,
3105             "multicast-table": [
3106                 "01:00:5e:00:00:01",
3107                 "33:33:00:00:00:01",
3108                 "33:33:ff:12:34:56"
3109             ],
3110             "broadcast-allowed": false
3111         }
3112       ]
3113    }
3114
3115 EQMP