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