qmp-commands.hx

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