sheepdog: Use SocketAddress and socket_connect()
[qemu/ar7.git] / qapi-schema.json
blob6febfa7b9050a728aa99882d82c0fefa071add42
1 # -*- Mode: Python -*-
2 ##
3 # = Introduction
5 # This document describes all commands currently supported by QMP.
7 # Most of the time their usage is exactly the same as in the user Monitor, this
8 # means that any other document which also describe commands (the manpage,
9 # QEMU's manual, etc) can and should be consulted.
11 # QMP has two types of commands: regular and query commands. Regular commands
12 # usually change the Virtual Machine's state someway, while query commands just
13 # return information. The sections below are divided accordingly.
15 # It's important to observe that all communication examples are formatted in
16 # a reader-friendly way, so that they're easier to understand. However, in real
17 # protocol usage, they're emitted as a single line.
19 # Also, the following notation is used to denote data flow:
21 # Example:
23 # | -> data issued by the Client
24 # | <- Server data response
26 # Please, refer to the QMP specification (docs/qmp-spec.txt) for
27 # detailed information on the Server command and response formats.
29 # = Stability Considerations
31 # The current QMP command set (described in this file) may be useful for a
32 # number of use cases, however it's limited and several commands have bad
33 # defined semantics, specially with regard to command completion.
35 # These problems are going to be solved incrementally in the next QEMU releases
36 # and we're going to establish a deprecation policy for badly defined commands.
38 # If you're planning to adopt QMP, please observe the following:
40 #     1. The deprecation policy will take effect and be documented soon, please
41 #        check the documentation of each used command as soon as a new release of
42 #        QEMU is available
44 #     2. DO NOT rely on anything which is not explicit documented
46 #     3. Errors, in special, are not documented. Applications should NOT check
47 #        for specific errors classes or data (it's strongly recommended to only
48 #        check for the "error" key)
52 # QAPI common definitions
53 { 'include': 'qapi/common.json' }
55 # QAPI crypto definitions
56 { 'include': 'qapi/crypto.json' }
58 # QAPI block definitions
59 { 'include': 'qapi/block.json' }
61 # QAPI event definitions
62 { 'include': 'qapi/event.json' }
64 # Tracing commands
65 { 'include': 'qapi/trace.json' }
67 # QAPI introspection
68 { 'include': 'qapi/introspect.json' }
71 # = QMP commands
75 # @qmp_capabilities:
77 # Enable QMP capabilities.
79 # Arguments: None.
81 # Example:
83 # -> { "execute": "qmp_capabilities" }
84 # <- { "return": {} }
86 # Notes: This command is valid exactly when first connecting: it must be
87 # issued before any other command will be accepted, and will fail once the
88 # monitor is accepting other commands. (see qemu docs/qmp-spec.txt)
90 # Since: 0.13
93 { 'command': 'qmp_capabilities' }
96 # @LostTickPolicy:
98 # Policy for handling lost ticks in timer devices.
100 # @discard: throw away the missed tick(s) and continue with future injection
101 #           normally.  Guest time may be delayed, unless the OS has explicit
102 #           handling of lost ticks
104 # @delay: continue to deliver ticks at the normal rate.  Guest time will be
105 #         delayed due to the late tick
107 # @merge: merge the missed tick(s) into one tick and inject.  Guest time
108 #         may be delayed, depending on how the OS reacts to the merging
109 #         of ticks
111 # @slew: deliver ticks at a higher rate to catch up with the missed tick. The
112 #        guest time should not be delayed once catchup is complete.
114 # Since: 2.0
116 { 'enum': 'LostTickPolicy',
117   'data': ['discard', 'delay', 'merge', 'slew' ] }
120 # @add_client:
122 # Allow client connections for VNC, Spice and socket based
123 # character devices to be passed in to QEMU via SCM_RIGHTS.
125 # @protocol: protocol name. Valid names are "vnc", "spice" or the
126 #            name of a character device (eg. from -chardev id=XXXX)
128 # @fdname: file descriptor name previously passed via 'getfd' command
130 # @skipauth: #optional whether to skip authentication. Only applies
131 #            to "vnc" and "spice" protocols
133 # @tls: #optional whether to perform TLS. Only applies to the "spice"
134 #       protocol
136 # Returns: nothing on success.
138 # Since: 0.14.0
140 # Example:
142 # -> { "execute": "add_client", "arguments": { "protocol": "vnc",
143 #                                              "fdname": "myclient" } }
144 # <- { "return": {} }
147 { 'command': 'add_client',
148   'data': { 'protocol': 'str', 'fdname': 'str', '*skipauth': 'bool',
149             '*tls': 'bool' } }
152 # @NameInfo:
154 # Guest name information.
156 # @name: #optional The name of the guest
158 # Since: 0.14.0
160 { 'struct': 'NameInfo', 'data': {'*name': 'str'} }
163 # @query-name:
165 # Return the name information of a guest.
167 # Returns: @NameInfo of the guest
169 # Since: 0.14.0
171 # Example:
173 # -> { "execute": "query-name" }
174 # <- { "return": { "name": "qemu-name" } }
177 { 'command': 'query-name', 'returns': 'NameInfo' }
180 # @KvmInfo:
182 # Information about support for KVM acceleration
184 # @enabled: true if KVM acceleration is active
186 # @present: true if KVM acceleration is built into this executable
188 # Since: 0.14.0
190 { 'struct': 'KvmInfo', 'data': {'enabled': 'bool', 'present': 'bool'} }
193 # @query-kvm:
195 # Returns information about KVM acceleration
197 # Returns: @KvmInfo
199 # Since: 0.14.0
201 # Example:
203 # -> { "execute": "query-kvm" }
204 # <- { "return": { "enabled": true, "present": true } }
207 { 'command': 'query-kvm', 'returns': 'KvmInfo' }
210 # @RunState:
212 # An enumeration of VM run states.
214 # @debug: QEMU is running on a debugger
216 # @finish-migrate: guest is paused to finish the migration process
218 # @inmigrate: guest is paused waiting for an incoming migration.  Note
219 # that this state does not tell whether the machine will start at the
220 # end of the migration.  This depends on the command-line -S option and
221 # any invocation of 'stop' or 'cont' that has happened since QEMU was
222 # started.
224 # @internal-error: An internal error that prevents further guest execution
225 # has occurred
227 # @io-error: the last IOP has failed and the device is configured to pause
228 # on I/O errors
230 # @paused: guest has been paused via the 'stop' command
232 # @postmigrate: guest is paused following a successful 'migrate'
234 # @prelaunch: QEMU was started with -S and guest has not started
236 # @restore-vm: guest is paused to restore VM state
238 # @running: guest is actively running
240 # @save-vm: guest is paused to save the VM state
242 # @shutdown: guest is shut down (and -no-shutdown is in use)
244 # @suspended: guest is suspended (ACPI S3)
246 # @watchdog: the watchdog action is configured to pause and has been triggered
248 # @guest-panicked: guest has been panicked as a result of guest OS panic
250 # @colo: guest is paused to save/restore VM state under colo checkpoint,
251 #        VM can not get into this state unless colo capability is enabled
252 #        for migration. (since 2.8)
254 { 'enum': 'RunState',
255   'data': [ 'debug', 'inmigrate', 'internal-error', 'io-error', 'paused',
256             'postmigrate', 'prelaunch', 'finish-migrate', 'restore-vm',
257             'running', 'save-vm', 'shutdown', 'suspended', 'watchdog',
258             'guest-panicked', 'colo' ] }
261 # @StatusInfo:
263 # Information about VCPU run state
265 # @running: true if all VCPUs are runnable, false if not runnable
267 # @singlestep: true if VCPUs are in single-step mode
269 # @status: the virtual machine @RunState
271 # Since:  0.14.0
273 # Notes: @singlestep is enabled through the GDB stub
275 { 'struct': 'StatusInfo',
276   'data': {'running': 'bool', 'singlestep': 'bool', 'status': 'RunState'} }
279 # @query-status:
281 # Query the run status of all VCPUs
283 # Returns: @StatusInfo reflecting all VCPUs
285 # Since:  0.14.0
287 # Example:
289 # -> { "execute": "query-status" }
290 # <- { "return": { "running": true,
291 #                  "singlestep": false,
292 #                  "status": "running" } }
295 { 'command': 'query-status', 'returns': 'StatusInfo' }
298 # @UuidInfo:
300 # Guest UUID information (Universally Unique Identifier).
302 # @UUID: the UUID of the guest
304 # Since: 0.14.0
306 # Notes: If no UUID was specified for the guest, a null UUID is returned.
308 { 'struct': 'UuidInfo', 'data': {'UUID': 'str'} }
311 # @query-uuid:
313 # Query the guest UUID information.
315 # Returns: The @UuidInfo for the guest
317 # Since: 0.14.0
319 # Example:
321 # -> { "execute": "query-uuid" }
322 # <- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } }
325 { 'command': 'query-uuid', 'returns': 'UuidInfo' }
328 # @ChardevInfo:
330 # Information about a character device.
332 # @label: the label of the character device
334 # @filename: the filename of the character device
336 # @frontend-open: shows whether the frontend device attached to this backend
337 #                 (eg. with the chardev=... option) is in open or closed state
338 #                 (since 2.1)
340 # Notes: @filename is encoded using the QEMU command line character device
341 #        encoding.  See the QEMU man page for details.
343 # Since: 0.14.0
345 { 'struct': 'ChardevInfo', 'data': {'label': 'str',
346                                   'filename': 'str',
347                                   'frontend-open': 'bool'} }
350 # @query-chardev:
352 # Returns information about current character devices.
354 # Returns: a list of @ChardevInfo
356 # Since: 0.14.0
358 # Example:
360 # -> { "execute": "query-chardev" }
361 # <- {
362 #       "return": [
363 #          {
364 #             "label": "charchannel0",
365 #             "filename": "unix:/var/lib/libvirt/qemu/seabios.rhel6.agent,server",
366 #             "frontend-open": false
367 #          },
368 #          {
369 #             "label": "charmonitor",
370 #             "filename": "unix:/var/lib/libvirt/qemu/seabios.rhel6.monitor,server",
371 #             "frontend-open": true
372 #          },
373 #          {
374 #             "label": "charserial0",
375 #             "filename": "pty:/dev/pts/2",
376 #             "frontend-open": true
377 #          }
378 #       ]
379 #    }
382 { 'command': 'query-chardev', 'returns': ['ChardevInfo'] }
385 # @ChardevBackendInfo:
387 # Information about a character device backend
389 # @name: The backend name
391 # Since: 2.0
393 { 'struct': 'ChardevBackendInfo', 'data': {'name': 'str'} }
396 # @query-chardev-backends:
398 # Returns information about character device backends.
400 # Returns: a list of @ChardevBackendInfo
402 # Since: 2.0
404 # Example:
406 # -> { "execute": "query-chardev-backends" }
407 # <- {
408 #       "return":[
409 #          {
410 #             "name":"udp"
411 #          },
412 #          {
413 #             "name":"tcp"
414 #          },
415 #          {
416 #             "name":"unix"
417 #          },
418 #          {
419 #             "name":"spiceport"
420 #          }
421 #       ]
422 #    }
425 { 'command': 'query-chardev-backends', 'returns': ['ChardevBackendInfo'] }
428 # @DataFormat:
430 # An enumeration of data format.
432 # @utf8: Data is a UTF-8 string (RFC 3629)
434 # @base64: Data is Base64 encoded binary (RFC 3548)
436 # Since: 1.4
438 { 'enum': 'DataFormat',
439   'data': [ 'utf8', 'base64' ] }
442 # @ringbuf-write:
444 # Write to a ring buffer character device.
446 # @device: the ring buffer character device name
448 # @data: data to write
450 # @format: #optional data encoding (default 'utf8').
451 #          - base64: data must be base64 encoded text.  Its binary
452 #            decoding gets written.
453 #          - utf8: data's UTF-8 encoding is written
454 #          - data itself is always Unicode regardless of format, like
455 #            any other string.
457 # Returns: Nothing on success
459 # Since: 1.4
461 # Example:
463 # -> { "execute": "ringbuf-write",
464 #      "arguments": { "device": "foo",
465 #                     "data": "abcdefgh",
466 #                     "format": "utf8" } }
467 # <- { "return": {} }
470 { 'command': 'ringbuf-write',
471   'data': {'device': 'str', 'data': 'str',
472            '*format': 'DataFormat'} }
475 # @ringbuf-read:
477 # Read from a ring buffer character device.
479 # @device: the ring buffer character device name
481 # @size: how many bytes to read at most
483 # @format: #optional data encoding (default 'utf8').
484 #          - base64: the data read is returned in base64 encoding.
485 #          - utf8: the data read is interpreted as UTF-8.
486 #            Bug: can screw up when the buffer contains invalid UTF-8
487 #            sequences, NUL characters, after the ring buffer lost
488 #            data, and when reading stops because the size limit is
489 #            reached.
490 #          - The return value is always Unicode regardless of format,
491 #            like any other string.
493 # Returns: data read from the device
495 # Since: 1.4
497 # Example:
499 # -> { "execute": "ringbuf-read",
500 #      "arguments": { "device": "foo",
501 #                     "size": 1000,
502 #                     "format": "utf8" } }
503 # <- { "return": "abcdefgh" }
506 { 'command': 'ringbuf-read',
507   'data': {'device': 'str', 'size': 'int', '*format': 'DataFormat'},
508   'returns': 'str' }
511 # @EventInfo:
513 # Information about a QMP event
515 # @name: The event name
517 # Since: 1.2.0
519 { 'struct': 'EventInfo', 'data': {'name': 'str'} }
522 # @query-events:
524 # Return a list of supported QMP events by this server
526 # Returns: A list of @EventInfo for all supported events
528 # Since: 1.2.0
530 # Example:
532 # -> { "execute": "query-events" }
533 # <- {
534 #      "return": [
535 #          {
536 #             "name":"SHUTDOWN"
537 #          },
538 #          {
539 #             "name":"RESET"
540 #          }
541 #       ]
542 #    }
544 # Note: This example has been shortened as the real response is too long.
547 { 'command': 'query-events', 'returns': ['EventInfo'] }
550 # @MigrationStats:
552 # Detailed migration status.
554 # @transferred: amount of bytes already transferred to the target VM
556 # @remaining: amount of bytes remaining to be transferred to the target VM
558 # @total: total amount of bytes involved in the migration process
560 # @duplicate: number of duplicate (zero) pages (since 1.2)
562 # @skipped: number of skipped zero pages (since 1.5)
564 # @normal: number of normal pages (since 1.2)
566 # @normal-bytes: number of normal bytes sent (since 1.2)
568 # @dirty-pages-rate: number of pages dirtied by second by the
569 #        guest (since 1.3)
571 # @mbps: throughput in megabits/sec. (since 1.6)
573 # @dirty-sync-count: number of times that dirty ram was synchronized (since 2.1)
575 # @postcopy-requests: The number of page requests received from the destination
576 #        (since 2.7)
578 # Since: 0.14.0
580 { 'struct': 'MigrationStats',
581   'data': {'transferred': 'int', 'remaining': 'int', 'total': 'int' ,
582            'duplicate': 'int', 'skipped': 'int', 'normal': 'int',
583            'normal-bytes': 'int', 'dirty-pages-rate' : 'int',
584            'mbps' : 'number', 'dirty-sync-count' : 'int',
585            'postcopy-requests' : 'int' } }
588 # @XBZRLECacheStats:
590 # Detailed XBZRLE migration cache statistics
592 # @cache-size: XBZRLE cache size
594 # @bytes: amount of bytes already transferred to the target VM
596 # @pages: amount of pages transferred to the target VM
598 # @cache-miss: number of cache miss
600 # @cache-miss-rate: rate of cache miss (since 2.1)
602 # @overflow: number of overflows
604 # Since: 1.2
606 { 'struct': 'XBZRLECacheStats',
607   'data': {'cache-size': 'int', 'bytes': 'int', 'pages': 'int',
608            'cache-miss': 'int', 'cache-miss-rate': 'number',
609            'overflow': 'int' } }
612 # @MigrationStatus:
614 # An enumeration of migration status.
616 # @none: no migration has ever happened.
618 # @setup: migration process has been initiated.
620 # @cancelling: in the process of cancelling migration.
622 # @cancelled: cancelling migration is finished.
624 # @active: in the process of doing migration.
626 # @postcopy-active: like active, but now in postcopy mode. (since 2.5)
628 # @completed: migration is finished.
630 # @failed: some error occurred during migration process.
632 # @colo: VM is in the process of fault tolerance, VM can not get into this
633 #        state unless colo capability is enabled for migration. (since 2.8)
635 # Since: 2.3
638 { 'enum': 'MigrationStatus',
639   'data': [ 'none', 'setup', 'cancelling', 'cancelled',
640             'active', 'postcopy-active', 'completed', 'failed', 'colo' ] }
643 # @MigrationInfo:
645 # Information about current migration process.
647 # @status: #optional @MigrationStatus describing the current migration status.
648 #          If this field is not returned, no migration process
649 #          has been initiated
651 # @ram: #optional @MigrationStats containing detailed migration
652 #       status, only returned if status is 'active' or
653 #       'completed'(since 1.2)
655 # @disk: #optional @MigrationStats containing detailed disk migration
656 #        status, only returned if status is 'active' and it is a block
657 #        migration
659 # @xbzrle-cache: #optional @XBZRLECacheStats containing detailed XBZRLE
660 #                migration statistics, only returned if XBZRLE feature is on and
661 #                status is 'active' or 'completed' (since 1.2)
663 # @total-time: #optional total amount of milliseconds since migration started.
664 #        If migration has ended, it returns the total migration
665 #        time. (since 1.2)
667 # @downtime: #optional only present when migration finishes correctly
668 #        total downtime in milliseconds for the guest.
669 #        (since 1.3)
671 # @expected-downtime: #optional only present while migration is active
672 #        expected downtime in milliseconds for the guest in last walk
673 #        of the dirty bitmap. (since 1.3)
675 # @setup-time: #optional amount of setup time in milliseconds _before_ the
676 #        iterations begin but _after_ the QMP command is issued. This is designed
677 #        to provide an accounting of any activities (such as RDMA pinning) which
678 #        may be expensive, but do not actually occur during the iterative
679 #        migration rounds themselves. (since 1.6)
681 # @cpu-throttle-percentage: #optional percentage of time guest cpus are being
682 #        throttled during auto-converge. This is only present when auto-converge
683 #        has started throttling guest cpus. (Since 2.7)
685 # @error-desc: #optional the human readable error description string, when
686 #              @status is 'failed'. Clients should not attempt to parse the
687 #              error strings. (Since 2.7)
689 # Since: 0.14.0
691 { 'struct': 'MigrationInfo',
692   'data': {'*status': 'MigrationStatus', '*ram': 'MigrationStats',
693            '*disk': 'MigrationStats',
694            '*xbzrle-cache': 'XBZRLECacheStats',
695            '*total-time': 'int',
696            '*expected-downtime': 'int',
697            '*downtime': 'int',
698            '*setup-time': 'int',
699            '*cpu-throttle-percentage': 'int',
700            '*error-desc': 'str'} }
703 # @query-migrate:
705 # Returns information about current migration process. If migration
706 # is active there will be another json-object with RAM migration
707 # status and if block migration is active another one with block
708 # migration status.
710 # Returns: @MigrationInfo
712 # Since: 0.14.0
714 # Example:
716 # 1. Before the first migration
718 # -> { "execute": "query-migrate" }
719 # <- { "return": {} }
721 # 2. Migration is done and has succeeded
723 # -> { "execute": "query-migrate" }
724 # <- { "return": {
725 #         "status": "completed",
726 #         "ram":{
727 #           "transferred":123,
728 #           "remaining":123,
729 #           "total":246,
730 #           "total-time":12345,
731 #           "setup-time":12345,
732 #           "downtime":12345,
733 #           "duplicate":123,
734 #           "normal":123,
735 #           "normal-bytes":123456,
736 #           "dirty-sync-count":15
737 #         }
738 #      }
739 #    }
741 # 3. Migration is done and has failed
743 # -> { "execute": "query-migrate" }
744 # <- { "return": { "status": "failed" } }
746 # 4. Migration is being performed and is not a block migration:
748 # -> { "execute": "query-migrate" }
749 # <- {
750 #       "return":{
751 #          "status":"active",
752 #          "ram":{
753 #             "transferred":123,
754 #             "remaining":123,
755 #             "total":246,
756 #             "total-time":12345,
757 #             "setup-time":12345,
758 #             "expected-downtime":12345,
759 #             "duplicate":123,
760 #             "normal":123,
761 #             "normal-bytes":123456,
762 #             "dirty-sync-count":15
763 #          }
764 #       }
765 #    }
767 # 5. Migration is being performed and is a block migration:
769 # -> { "execute": "query-migrate" }
770 # <- {
771 #       "return":{
772 #          "status":"active",
773 #          "ram":{
774 #             "total":1057024,
775 #             "remaining":1053304,
776 #             "transferred":3720,
777 #             "total-time":12345,
778 #             "setup-time":12345,
779 #             "expected-downtime":12345,
780 #             "duplicate":123,
781 #             "normal":123,
782 #             "normal-bytes":123456,
783 #             "dirty-sync-count":15
784 #          },
785 #          "disk":{
786 #             "total":20971520,
787 #             "remaining":20880384,
788 #             "transferred":91136
789 #          }
790 #       }
791 #    }
793 # 6. Migration is being performed and XBZRLE is active:
795 # -> { "execute": "query-migrate" }
796 # <- {
797 #       "return":{
798 #          "status":"active",
799 #          "capabilities" : [ { "capability": "xbzrle", "state" : true } ],
800 #          "ram":{
801 #             "total":1057024,
802 #             "remaining":1053304,
803 #             "transferred":3720,
804 #             "total-time":12345,
805 #             "setup-time":12345,
806 #             "expected-downtime":12345,
807 #             "duplicate":10,
808 #             "normal":3333,
809 #             "normal-bytes":3412992,
810 #             "dirty-sync-count":15
811 #          },
812 #          "xbzrle-cache":{
813 #             "cache-size":67108864,
814 #             "bytes":20971520,
815 #             "pages":2444343,
816 #             "cache-miss":2244,
817 #             "cache-miss-rate":0.123,
818 #             "overflow":34434
819 #          }
820 #       }
821 #    }
824 { 'command': 'query-migrate', 'returns': 'MigrationInfo' }
827 # @MigrationCapability:
829 # Migration capabilities enumeration
831 # @xbzrle: Migration supports xbzrle (Xor Based Zero Run Length Encoding).
832 #          This feature allows us to minimize migration traffic for certain work
833 #          loads, by sending compressed difference of the pages
835 # @rdma-pin-all: Controls whether or not the entire VM memory footprint is
836 #          mlock()'d on demand or all at once. Refer to docs/rdma.txt for usage.
837 #          Disabled by default. (since 2.0)
839 # @zero-blocks: During storage migration encode blocks of zeroes efficiently. This
840 #          essentially saves 1MB of zeroes per block on the wire. Enabling requires
841 #          source and target VM to support this feature. To enable it is sufficient
842 #          to enable the capability on the source VM. The feature is disabled by
843 #          default. (since 1.6)
845 # @compress: Use multiple compression threads to accelerate live migration.
846 #          This feature can help to reduce the migration traffic, by sending
847 #          compressed pages. Please note that if compress and xbzrle are both
848 #          on, compress only takes effect in the ram bulk stage, after that,
849 #          it will be disabled and only xbzrle takes effect, this can help to
850 #          minimize migration traffic. The feature is disabled by default.
851 #          (since 2.4 )
853 # @events: generate events for each migration state change
854 #          (since 2.4 )
856 # @auto-converge: If enabled, QEMU will automatically throttle down the guest
857 #          to speed up convergence of RAM migration. (since 1.6)
859 # @postcopy-ram: Start executing on the migration target before all of RAM has
860 #          been migrated, pulling the remaining pages along as needed. NOTE: If
861 #          the migration fails during postcopy the VM will fail.  (since 2.6)
863 # @x-colo: If enabled, migration will never end, and the state of the VM on the
864 #        primary side will be migrated continuously to the VM on secondary
865 #        side, this process is called COarse-Grain LOck Stepping (COLO) for
866 #        Non-stop Service. (since 2.8)
868 # @release-ram: if enabled, qemu will free the migrated ram pages on the source
869 #        during postcopy-ram migration. (since 2.9)
871 # Since: 1.2
873 { 'enum': 'MigrationCapability',
874   'data': ['xbzrle', 'rdma-pin-all', 'auto-converge', 'zero-blocks',
875            'compress', 'events', 'postcopy-ram', 'x-colo', 'release-ram'] }
878 # @MigrationCapabilityStatus:
880 # Migration capability information
882 # @capability: capability enum
884 # @state: capability state bool
886 # Since: 1.2
888 { 'struct': 'MigrationCapabilityStatus',
889   'data': { 'capability' : 'MigrationCapability', 'state' : 'bool' } }
892 # @migrate-set-capabilities:
894 # Enable/Disable the following migration capabilities (like xbzrle)
896 # @capabilities: json array of capability modifications to make
898 # Since: 1.2
900 # Example:
902 # -> { "execute": "migrate-set-capabilities" , "arguments":
903 #      { "capabilities": [ { "capability": "xbzrle", "state": true } ] } }
906 { 'command': 'migrate-set-capabilities',
907   'data': { 'capabilities': ['MigrationCapabilityStatus'] } }
910 # @query-migrate-capabilities:
912 # Returns information about the current migration capabilities status
914 # Returns: @MigrationCapabilitiesStatus
916 # Since: 1.2
918 # Example:
920 # -> { "execute": "query-migrate-capabilities" }
921 # <- { "return": [
922 #       {"state": false, "capability": "xbzrle"},
923 #       {"state": false, "capability": "rdma-pin-all"},
924 #       {"state": false, "capability": "auto-converge"},
925 #       {"state": false, "capability": "zero-blocks"},
926 #       {"state": false, "capability": "compress"},
927 #       {"state": true, "capability": "events"},
928 #       {"state": false, "capability": "postcopy-ram"},
929 #       {"state": false, "capability": "x-colo"}
930 #    ]}
933 { 'command': 'query-migrate-capabilities', 'returns':   ['MigrationCapabilityStatus']}
936 # @MigrationParameter:
938 # Migration parameters enumeration
940 # @compress-level: Set the compression level to be used in live migration,
941 #          the compression level is an integer between 0 and 9, where 0 means
942 #          no compression, 1 means the best compression speed, and 9 means best
943 #          compression ratio which will consume more CPU.
945 # @compress-threads: Set compression thread count to be used in live migration,
946 #          the compression thread count is an integer between 1 and 255.
948 # @decompress-threads: Set decompression thread count to be used in live
949 #          migration, the decompression thread count is an integer between 1
950 #          and 255. Usually, decompression is at least 4 times as fast as
951 #          compression, so set the decompress-threads to the number about 1/4
952 #          of compress-threads is adequate.
954 # @cpu-throttle-initial: Initial percentage of time guest cpus are throttled
955 #                        when migration auto-converge is activated. The
956 #                        default value is 20. (Since 2.7)
958 # @cpu-throttle-increment: throttle percentage increase each time
959 #                          auto-converge detects that migration is not making
960 #                          progress. The default value is 10. (Since 2.7)
962 # @tls-creds: ID of the 'tls-creds' object that provides credentials for
963 #             establishing a TLS connection over the migration data channel.
964 #             On the outgoing side of the migration, the credentials must
965 #             be for a 'client' endpoint, while for the incoming side the
966 #             credentials must be for a 'server' endpoint. Setting this
967 #             will enable TLS for all migrations. The default is unset,
968 #             resulting in unsecured migration at the QEMU level. (Since 2.7)
970 # @tls-hostname: hostname of the target host for the migration. This is
971 #                required when using x509 based TLS credentials and the
972 #                migration URI does not already include a hostname. For
973 #                example if using fd: or exec: based migration, the
974 #                hostname must be provided so that the server's x509
975 #                certificate identity can be validated. (Since 2.7)
977 # @max-bandwidth: to set maximum speed for migration. maximum speed in
978 #                 bytes per second. (Since 2.8)
980 # @downtime-limit: set maximum tolerated downtime for migration. maximum
981 #                  downtime in milliseconds (Since 2.8)
983 # @x-checkpoint-delay: The delay time (in ms) between two COLO checkpoints in
984 #          periodic mode. (Since 2.8)
986 # Since: 2.4
988 { 'enum': 'MigrationParameter',
989   'data': ['compress-level', 'compress-threads', 'decompress-threads',
990            'cpu-throttle-initial', 'cpu-throttle-increment',
991            'tls-creds', 'tls-hostname', 'max-bandwidth',
992            'downtime-limit', 'x-checkpoint-delay' ] }
995 # @migrate-set-parameters:
997 # Set various migration parameters.  See MigrationParameters for details.
999 # Since: 2.4
1001 # Example:
1003 # -> { "execute": "migrate-set-parameters" ,
1004 #      "arguments": { "compress-level": 1 } }
1007 { 'command': 'migrate-set-parameters', 'boxed': true,
1008   'data': 'MigrationParameters' }
1011 # @MigrationParameters:
1013 # Optional members can be omitted on input ('migrate-set-parameters')
1014 # but most members will always be present on output
1015 # ('query-migrate-parameters'), with the exception of tls-creds and
1016 # tls-hostname.
1018 # @compress-level: #optional compression level
1020 # @compress-threads: #optional compression thread count
1022 # @decompress-threads: #optional decompression thread count
1024 # @cpu-throttle-initial: #optional Initial percentage of time guest cpus are
1025 #                        throttledwhen migration auto-converge is activated.
1026 #                        The default value is 20. (Since 2.7)
1028 # @cpu-throttle-increment: #optional throttle percentage increase each time
1029 #                          auto-converge detects that migration is not making
1030 #                          progress. The default value is 10. (Since 2.7)
1032 # @tls-creds: #optional ID of the 'tls-creds' object that provides credentials
1033 #             for establishing a TLS connection over the migration data
1034 #             channel. On the outgoing side of the migration, the credentials
1035 #             must be for a 'client' endpoint, while for the incoming side the
1036 #             credentials must be for a 'server' endpoint. Setting this
1037 #             will enable TLS for all migrations. The default is unset,
1038 #             resulting in unsecured migration at the QEMU level. (Since 2.7)
1040 # @tls-hostname: #optional hostname of the target host for the migration. This
1041 #                is required when using x509 based TLS credentials and the
1042 #                migration URI does not already include a hostname. For
1043 #                example if using fd: or exec: based migration, the
1044 #                hostname must be provided so that the server's x509
1045 #                certificate identity can be validated. (Since 2.7)
1047 # @max-bandwidth: to set maximum speed for migration. maximum speed in
1048 #                 bytes per second. (Since 2.8)
1050 # @downtime-limit: set maximum tolerated downtime for migration. maximum
1051 #                  downtime in milliseconds (Since 2.8)
1053 # @x-checkpoint-delay: the delay time between two COLO checkpoints. (Since 2.8)
1055 # Since: 2.4
1057 { 'struct': 'MigrationParameters',
1058   'data': { '*compress-level': 'int',
1059             '*compress-threads': 'int',
1060             '*decompress-threads': 'int',
1061             '*cpu-throttle-initial': 'int',
1062             '*cpu-throttle-increment': 'int',
1063             '*tls-creds': 'str',
1064             '*tls-hostname': 'str',
1065             '*max-bandwidth': 'int',
1066             '*downtime-limit': 'int',
1067             '*x-checkpoint-delay': 'int'} }
1070 # @query-migrate-parameters:
1072 # Returns information about the current migration parameters
1074 # Returns: @MigrationParameters
1076 # Since: 2.4
1078 # Example:
1080 # -> { "execute": "query-migrate-parameters" }
1081 # <- { "return": {
1082 #          "decompress-threads": 2,
1083 #          "cpu-throttle-increment": 10,
1084 #          "compress-threads": 8,
1085 #          "compress-level": 1,
1086 #          "cpu-throttle-initial": 20,
1087 #          "max-bandwidth": 33554432,
1088 #          "downtime-limit": 300
1089 #       }
1090 #    }
1093 { 'command': 'query-migrate-parameters',
1094   'returns': 'MigrationParameters' }
1097 # @client_migrate_info:
1099 # Set migration information for remote display.  This makes the server
1100 # ask the client to automatically reconnect using the new parameters
1101 # once migration finished successfully.  Only implemented for SPICE.
1103 # @protocol:     must be "spice"
1104 # @hostname:     migration target hostname
1105 # @port:         #optional spice tcp port for plaintext channels
1106 # @tls-port:     #optional spice tcp port for tls-secured channels
1107 # @cert-subject: #optional server certificate subject
1109 # Since: 0.14.0
1111 # Example:
1113 # -> { "execute": "client_migrate_info",
1114 #      "arguments": { "protocol": "spice",
1115 #                     "hostname": "virt42.lab.kraxel.org",
1116 #                     "port": 1234 } }
1117 # <- { "return": {} }
1120 { 'command': 'client_migrate_info',
1121   'data': { 'protocol': 'str', 'hostname': 'str', '*port': 'int',
1122             '*tls-port': 'int', '*cert-subject': 'str' } }
1125 # @migrate-start-postcopy:
1127 # Followup to a migration command to switch the migration to postcopy mode.
1128 # The postcopy-ram capability must be set before the original migration
1129 # command.
1131 # Since: 2.5
1133 # Example:
1135 # -> { "execute": "migrate-start-postcopy" }
1136 # <- { "return": {} }
1139 { 'command': 'migrate-start-postcopy' }
1142 # @COLOMessage:
1144 # The message transmission between Primary side and Secondary side.
1146 # @checkpoint-ready: Secondary VM (SVM) is ready for checkpointing
1148 # @checkpoint-request: Primary VM (PVM) tells SVM to prepare for checkpointing
1150 # @checkpoint-reply: SVM gets PVM's checkpoint request
1152 # @vmstate-send: VM's state will be sent by PVM.
1154 # @vmstate-size: The total size of VMstate.
1156 # @vmstate-received: VM's state has been received by SVM.
1158 # @vmstate-loaded: VM's state has been loaded by SVM.
1160 # Since: 2.8
1162 { 'enum': 'COLOMessage',
1163   'data': [ 'checkpoint-ready', 'checkpoint-request', 'checkpoint-reply',
1164             'vmstate-send', 'vmstate-size', 'vmstate-received',
1165             'vmstate-loaded' ] }
1168 # @COLOMode:
1170 # The colo mode
1172 # @unknown: unknown mode
1174 # @primary: master side
1176 # @secondary: slave side
1178 # Since: 2.8
1180 { 'enum': 'COLOMode',
1181   'data': [ 'unknown', 'primary', 'secondary'] }
1184 # @FailoverStatus:
1186 # An enumeration of COLO failover status
1188 # @none: no failover has ever happened
1190 # @require: got failover requirement but not handled
1192 # @active: in the process of doing failover
1194 # @completed: finish the process of failover
1196 # @relaunch: restart the failover process, from 'none' -> 'completed' (Since 2.9)
1198 # Since: 2.8
1200 { 'enum': 'FailoverStatus',
1201   'data': [ 'none', 'require', 'active', 'completed', 'relaunch' ] }
1204 # @x-colo-lost-heartbeat:
1206 # Tell qemu that heartbeat is lost, request it to do takeover procedures.
1207 # If this command is sent to the PVM, the Primary side will exit COLO mode.
1208 # If sent to the Secondary, the Secondary side will run failover work,
1209 # then takes over server operation to become the service VM.
1211 # Since: 2.8
1213 # Example:
1215 # -> { "execute": "x-colo-lost-heartbeat" }
1216 # <- { "return": {} }
1219 { 'command': 'x-colo-lost-heartbeat' }
1222 # @MouseInfo:
1224 # Information about a mouse device.
1226 # @name: the name of the mouse device
1228 # @index: the index of the mouse device
1230 # @current: true if this device is currently receiving mouse events
1232 # @absolute: true if this device supports absolute coordinates as input
1234 # Since: 0.14.0
1236 { 'struct': 'MouseInfo',
1237   'data': {'name': 'str', 'index': 'int', 'current': 'bool',
1238            'absolute': 'bool'} }
1241 # @query-mice:
1243 # Returns information about each active mouse device
1245 # Returns: a list of @MouseInfo for each device
1247 # Since: 0.14.0
1249 # Example:
1251 # -> { "execute": "query-mice" }
1252 # <- { "return": [
1253 #          {
1254 #             "name":"QEMU Microsoft Mouse",
1255 #             "index":0,
1256 #             "current":false,
1257 #             "absolute":false
1258 #          },
1259 #          {
1260 #             "name":"QEMU PS/2 Mouse",
1261 #             "index":1,
1262 #             "current":true,
1263 #             "absolute":true
1264 #          }
1265 #       ]
1266 #    }
1269 { 'command': 'query-mice', 'returns': ['MouseInfo'] }
1272 # @CpuInfoArch:
1274 # An enumeration of cpu types that enable additional information during
1275 # @query-cpus.
1277 # Since: 2.6
1279 { 'enum': 'CpuInfoArch',
1280   'data': ['x86', 'sparc', 'ppc', 'mips', 'tricore', 'other' ] }
1283 # @CpuInfo:
1285 # Information about a virtual CPU
1287 # @CPU: the index of the virtual CPU
1289 # @current: this only exists for backwards compatibility and should be ignored
1291 # @halted: true if the virtual CPU is in the halt state.  Halt usually refers
1292 #          to a processor specific low power mode.
1294 # @qom_path: path to the CPU object in the QOM tree (since 2.4)
1296 # @thread_id: ID of the underlying host thread
1298 # @arch: architecture of the cpu, which determines which additional fields
1299 #        will be listed (since 2.6)
1301 # Since: 0.14.0
1303 # Notes: @halted is a transient state that changes frequently.  By the time the
1304 #        data is sent to the client, the guest may no longer be halted.
1306 { 'union': 'CpuInfo',
1307   'base': {'CPU': 'int', 'current': 'bool', 'halted': 'bool',
1308            'qom_path': 'str', 'thread_id': 'int', 'arch': 'CpuInfoArch' },
1309   'discriminator': 'arch',
1310   'data': { 'x86': 'CpuInfoX86',
1311             'sparc': 'CpuInfoSPARC',
1312             'ppc': 'CpuInfoPPC',
1313             'mips': 'CpuInfoMIPS',
1314             'tricore': 'CpuInfoTricore',
1315             'other': 'CpuInfoOther' } }
1318 # @CpuInfoX86:
1320 # Additional information about a virtual i386 or x86_64 CPU
1322 # @pc: the 64-bit instruction pointer
1324 # Since: 2.6
1326 { 'struct': 'CpuInfoX86', 'data': { 'pc': 'int' } }
1329 # @CpuInfoSPARC:
1331 # Additional information about a virtual SPARC CPU
1333 # @pc: the PC component of the instruction pointer
1335 # @npc: the NPC component of the instruction pointer
1337 # Since: 2.6
1339 { 'struct': 'CpuInfoSPARC', 'data': { 'pc': 'int', 'npc': 'int' } }
1342 # @CpuInfoPPC:
1344 # Additional information about a virtual PPC CPU
1346 # @nip: the instruction pointer
1348 # Since: 2.6
1350 { 'struct': 'CpuInfoPPC', 'data': { 'nip': 'int' } }
1353 # @CpuInfoMIPS:
1355 # Additional information about a virtual MIPS CPU
1357 # @PC: the instruction pointer
1359 # Since: 2.6
1361 { 'struct': 'CpuInfoMIPS', 'data': { 'PC': 'int' } }
1364 # @CpuInfoTricore:
1366 # Additional information about a virtual Tricore CPU
1368 # @PC: the instruction pointer
1370 # Since: 2.6
1372 { 'struct': 'CpuInfoTricore', 'data': { 'PC': 'int' } }
1375 # @CpuInfoOther:
1377 # No additional information is available about the virtual CPU
1379 # Since: 2.6
1382 { 'struct': 'CpuInfoOther', 'data': { } }
1385 # @query-cpus:
1387 # Returns a list of information about each virtual CPU.
1389 # Returns: a list of @CpuInfo for each virtual CPU
1391 # Since: 0.14.0
1393 # Example:
1395 # -> { "execute": "query-cpus" }
1396 # <- { "return": [
1397 #          {
1398 #             "CPU":0,
1399 #             "current":true,
1400 #             "halted":false,
1401 #             "qom_path":"/machine/unattached/device[0]",
1402 #             "arch":"x86",
1403 #             "pc":3227107138,
1404 #             "thread_id":3134
1405 #          },
1406 #          {
1407 #             "CPU":1,
1408 #             "current":false,
1409 #             "halted":true,
1410 #             "qom_path":"/machine/unattached/device[2]",
1411 #             "arch":"x86",
1412 #             "pc":7108165,
1413 #             "thread_id":3135
1414 #          }
1415 #       ]
1416 #    }
1419 { 'command': 'query-cpus', 'returns': ['CpuInfo'] }
1422 # @IOThreadInfo:
1424 # Information about an iothread
1426 # @id: the identifier of the iothread
1428 # @thread-id: ID of the underlying host thread
1430 # @poll-max-ns: maximum polling time in ns, 0 means polling is disabled
1431 #               (since 2.9)
1433 # @poll-grow: how many ns will be added to polling time, 0 means that it's not
1434 #             configured (since 2.9)
1436 # @poll-shrink: how many ns will be removed from polling time, 0 means that
1437 #               it's not configured (since 2.9)
1439 # Since: 2.0
1441 { 'struct': 'IOThreadInfo',
1442   'data': {'id': 'str',
1443            'thread-id': 'int',
1444            'poll-max-ns': 'int',
1445            'poll-grow': 'int',
1446            'poll-shrink': 'int' } }
1449 # @query-iothreads:
1451 # Returns a list of information about each iothread.
1453 # Note: this list excludes the QEMU main loop thread, which is not declared
1454 # using the -object iothread command-line option.  It is always the main thread
1455 # of the process.
1457 # Returns: a list of @IOThreadInfo for each iothread
1459 # Since: 2.0
1461 # Example:
1463 # -> { "execute": "query-iothreads" }
1464 # <- { "return": [
1465 #          {
1466 #             "id":"iothread0",
1467 #             "thread-id":3134
1468 #          },
1469 #          {
1470 #             "id":"iothread1",
1471 #             "thread-id":3135
1472 #          }
1473 #       ]
1474 #    }
1477 { 'command': 'query-iothreads', 'returns': ['IOThreadInfo'] }
1480 # @NetworkAddressFamily:
1482 # The network address family
1484 # @ipv4: IPV4 family
1486 # @ipv6: IPV6 family
1488 # @unix: unix socket
1490 # @vsock: vsock family (since 2.8)
1492 # @unknown: otherwise
1494 # Since: 2.1
1496 { 'enum': 'NetworkAddressFamily',
1497   'data': [ 'ipv4', 'ipv6', 'unix', 'vsock', 'unknown' ] }
1500 # @VncBasicInfo:
1502 # The basic information for vnc network connection
1504 # @host: IP address
1506 # @service: The service name of the vnc port. This may depend on the host
1507 #           system's service database so symbolic names should not be relied
1508 #           on.
1510 # @family: address family
1512 # @websocket: true in case the socket is a websocket (since 2.3).
1514 # Since: 2.1
1516 { 'struct': 'VncBasicInfo',
1517   'data': { 'host': 'str',
1518             'service': 'str',
1519             'family': 'NetworkAddressFamily',
1520             'websocket': 'bool' } }
1523 # @VncServerInfo:
1525 # The network connection information for server
1527 # @auth: #optional authentication method used for
1528 #        the plain (non-websocket) VNC server
1530 # Since: 2.1
1532 { 'struct': 'VncServerInfo',
1533   'base': 'VncBasicInfo',
1534   'data': { '*auth': 'str' } }
1537 # @VncClientInfo:
1539 # Information about a connected VNC client.
1541 # @x509_dname: #optional If x509 authentication is in use, the Distinguished
1542 #              Name of the client.
1544 # @sasl_username: #optional If SASL authentication is in use, the SASL username
1545 #                 used for authentication.
1547 # Since: 0.14.0
1549 { 'struct': 'VncClientInfo',
1550   'base': 'VncBasicInfo',
1551   'data': { '*x509_dname': 'str', '*sasl_username': 'str' } }
1554 # @VncInfo:
1556 # Information about the VNC session.
1558 # @enabled: true if the VNC server is enabled, false otherwise
1560 # @host: #optional The hostname the VNC server is bound to.  This depends on
1561 #        the name resolution on the host and may be an IP address.
1563 # @family: #optional 'ipv6' if the host is listening for IPv6 connections
1564 #                    'ipv4' if the host is listening for IPv4 connections
1565 #                    'unix' if the host is listening on a unix domain socket
1566 #                    'unknown' otherwise
1568 # @service: #optional The service name of the server's port.  This may depends
1569 #           on the host system's service database so symbolic names should not
1570 #           be relied on.
1572 # @auth: #optional the current authentication type used by the server
1573 #        'none' if no authentication is being used
1574 #        'vnc' if VNC authentication is being used
1575 #        'vencrypt+plain' if VEncrypt is used with plain text authentication
1576 #        'vencrypt+tls+none' if VEncrypt is used with TLS and no authentication
1577 #        'vencrypt+tls+vnc' if VEncrypt is used with TLS and VNC authentication
1578 #        'vencrypt+tls+plain' if VEncrypt is used with TLS and plain text auth
1579 #        'vencrypt+x509+none' if VEncrypt is used with x509 and no auth
1580 #        'vencrypt+x509+vnc' if VEncrypt is used with x509 and VNC auth
1581 #        'vencrypt+x509+plain' if VEncrypt is used with x509 and plain text auth
1582 #        'vencrypt+tls+sasl' if VEncrypt is used with TLS and SASL auth
1583 #        'vencrypt+x509+sasl' if VEncrypt is used with x509 and SASL auth
1585 # @clients: a list of @VncClientInfo of all currently connected clients
1587 # Since: 0.14.0
1589 { 'struct': 'VncInfo',
1590   'data': {'enabled': 'bool', '*host': 'str',
1591            '*family': 'NetworkAddressFamily',
1592            '*service': 'str', '*auth': 'str', '*clients': ['VncClientInfo']} }
1595 # @VncPrimaryAuth:
1597 # vnc primary authentication method.
1599 # Since: 2.3
1601 { 'enum': 'VncPrimaryAuth',
1602   'data': [ 'none', 'vnc', 'ra2', 'ra2ne', 'tight', 'ultra',
1603             'tls', 'vencrypt', 'sasl' ] }
1606 # @VncVencryptSubAuth:
1608 # vnc sub authentication method with vencrypt.
1610 # Since: 2.3
1612 { 'enum': 'VncVencryptSubAuth',
1613   'data': [ 'plain',
1614             'tls-none',  'x509-none',
1615             'tls-vnc',   'x509-vnc',
1616             'tls-plain', 'x509-plain',
1617             'tls-sasl',  'x509-sasl' ] }
1621 # @VncServerInfo2:
1623 # The network connection information for server
1625 # @auth: The current authentication type used by the servers
1627 # @vencrypt: #optional The vencrypt sub authentication type used by the
1628 #            servers, only specified in case auth == vencrypt.
1630 # Since: 2.9
1632 { 'struct': 'VncServerInfo2',
1633   'base': 'VncBasicInfo',
1634   'data': { 'auth'      : 'VncPrimaryAuth',
1635             '*vencrypt' : 'VncVencryptSubAuth' } }
1639 # @VncInfo2:
1641 # Information about a vnc server
1643 # @id: vnc server name.
1645 # @server: A list of @VncBasincInfo describing all listening sockets.
1646 #          The list can be empty (in case the vnc server is disabled).
1647 #          It also may have multiple entries: normal + websocket,
1648 #          possibly also ipv4 + ipv6 in the future.
1650 # @clients: A list of @VncClientInfo of all currently connected clients.
1651 #           The list can be empty, for obvious reasons.
1653 # @auth: The current authentication type used by the non-websockets servers
1655 # @vencrypt: #optional The vencrypt authentication type used by the servers,
1656 #            only specified in case auth == vencrypt.
1658 # @display: #optional The display device the vnc server is linked to.
1660 # Since: 2.3
1662 { 'struct': 'VncInfo2',
1663   'data': { 'id'        : 'str',
1664             'server'    : ['VncServerInfo2'],
1665             'clients'   : ['VncClientInfo'],
1666             'auth'      : 'VncPrimaryAuth',
1667             '*vencrypt' : 'VncVencryptSubAuth',
1668             '*display'  : 'str' } }
1671 # @query-vnc:
1673 # Returns information about the current VNC server
1675 # Returns: @VncInfo
1677 # Since: 0.14.0
1679 # Example:
1681 # -> { "execute": "query-vnc" }
1682 # <- { "return": {
1683 #          "enabled":true,
1684 #          "host":"0.0.0.0",
1685 #          "service":"50402",
1686 #          "auth":"vnc",
1687 #          "family":"ipv4",
1688 #          "clients":[
1689 #             {
1690 #                "host":"127.0.0.1",
1691 #                "service":"50401",
1692 #                "family":"ipv4"
1693 #             }
1694 #          ]
1695 #       }
1696 #    }
1699 { 'command': 'query-vnc', 'returns': 'VncInfo' }
1702 # @query-vnc-servers:
1704 # Returns a list of vnc servers.  The list can be empty.
1706 # Returns: a list of @VncInfo2
1708 # Since: 2.3
1710 { 'command': 'query-vnc-servers', 'returns': ['VncInfo2'] }
1713 # @SpiceBasicInfo:
1715 # The basic information for SPICE network connection
1717 # @host: IP address
1719 # @port: port number
1721 # @family: address family
1723 # Since: 2.1
1725 { 'struct': 'SpiceBasicInfo',
1726   'data': { 'host': 'str',
1727             'port': 'str',
1728             'family': 'NetworkAddressFamily' } }
1731 # @SpiceServerInfo:
1733 # Information about a SPICE server
1735 # @auth: #optional authentication method
1737 # Since: 2.1
1739 { 'struct': 'SpiceServerInfo',
1740   'base': 'SpiceBasicInfo',
1741   'data': { '*auth': 'str' } }
1744 # @SpiceChannel:
1746 # Information about a SPICE client channel.
1748 # @connection-id: SPICE connection id number.  All channels with the same id
1749 #                 belong to the same SPICE session.
1751 # @channel-type: SPICE channel type number.  "1" is the main control
1752 #                channel, filter for this one if you want to track spice
1753 #                sessions only
1755 # @channel-id: SPICE channel ID number.  Usually "0", might be different when
1756 #              multiple channels of the same type exist, such as multiple
1757 #              display channels in a multihead setup
1759 # @tls: true if the channel is encrypted, false otherwise.
1761 # Since: 0.14.0
1763 { 'struct': 'SpiceChannel',
1764   'base': 'SpiceBasicInfo',
1765   'data': {'connection-id': 'int', 'channel-type': 'int', 'channel-id': 'int',
1766            'tls': 'bool'} }
1769 # @SpiceQueryMouseMode:
1771 # An enumeration of Spice mouse states.
1773 # @client: Mouse cursor position is determined by the client.
1775 # @server: Mouse cursor position is determined by the server.
1777 # @unknown: No information is available about mouse mode used by
1778 #           the spice server.
1780 # Note: spice/enums.h has a SpiceMouseMode already, hence the name.
1782 # Since: 1.1
1784 { 'enum': 'SpiceQueryMouseMode',
1785   'data': [ 'client', 'server', 'unknown' ] }
1788 # @SpiceInfo:
1790 # Information about the SPICE session.
1792 # @enabled: true if the SPICE server is enabled, false otherwise
1794 # @migrated: true if the last guest migration completed and spice
1795 #            migration had completed as well. false otherwise. (since 1.4)
1797 # @host: #optional The hostname the SPICE server is bound to.  This depends on
1798 #        the name resolution on the host and may be an IP address.
1800 # @port: #optional The SPICE server's port number.
1802 # @compiled-version: #optional SPICE server version.
1804 # @tls-port: #optional The SPICE server's TLS port number.
1806 # @auth: #optional the current authentication type used by the server
1807 #        'none'  if no authentication is being used
1808 #        'spice' uses SASL or direct TLS authentication, depending on command
1809 #                line options
1811 # @mouse-mode: The mode in which the mouse cursor is displayed currently. Can
1812 #              be determined by the client or the server, or unknown if spice
1813 #              server doesn't provide this information. (since: 1.1)
1815 # @channels: a list of @SpiceChannel for each active spice channel
1817 # Since: 0.14.0
1819 { 'struct': 'SpiceInfo',
1820   'data': {'enabled': 'bool', 'migrated': 'bool', '*host': 'str', '*port': 'int',
1821            '*tls-port': 'int', '*auth': 'str', '*compiled-version': 'str',
1822            'mouse-mode': 'SpiceQueryMouseMode', '*channels': ['SpiceChannel']} }
1825 # @query-spice:
1827 # Returns information about the current SPICE server
1829 # Returns: @SpiceInfo
1831 # Since: 0.14.0
1833 # Example:
1835 # -> { "execute": "query-spice" }
1836 # <- { "return": {
1837 #          "enabled": true,
1838 #          "auth": "spice",
1839 #          "port": 5920,
1840 #          "tls-port": 5921,
1841 #          "host": "0.0.0.0",
1842 #          "channels": [
1843 #             {
1844 #                "port": "54924",
1845 #                "family": "ipv4",
1846 #                "channel-type": 1,
1847 #                "connection-id": 1804289383,
1848 #                "host": "127.0.0.1",
1849 #                "channel-id": 0,
1850 #                "tls": true
1851 #             },
1852 #             {
1853 #                "port": "36710",
1854 #                "family": "ipv4",
1855 #                "channel-type": 4,
1856 #                "connection-id": 1804289383,
1857 #                "host": "127.0.0.1",
1858 #                "channel-id": 0,
1859 #                "tls": false
1860 #             },
1861 #             [ ... more channels follow ... ]
1862 #          ]
1863 #       }
1864 #    }
1867 { 'command': 'query-spice', 'returns': 'SpiceInfo' }
1870 # @BalloonInfo:
1872 # Information about the guest balloon device.
1874 # @actual: the number of bytes the balloon currently contains
1876 # Since: 0.14.0
1879 { 'struct': 'BalloonInfo', 'data': {'actual': 'int' } }
1882 # @query-balloon:
1884 # Return information about the balloon device.
1886 # Returns: @BalloonInfo on success
1888 #          If the balloon driver is enabled but not functional because the KVM
1889 #          kernel module cannot support it, KvmMissingCap
1891 #          If no balloon device is present, DeviceNotActive
1893 # Since: 0.14.0
1895 # Example:
1897 # -> { "execute": "query-balloon" }
1898 # <- { "return": {
1899 #          "actual": 1073741824,
1900 #       }
1901 #    }
1904 { 'command': 'query-balloon', 'returns': 'BalloonInfo' }
1907 # @PciMemoryRange:
1909 # A PCI device memory region
1911 # @base: the starting address (guest physical)
1913 # @limit: the ending address (guest physical)
1915 # Since: 0.14.0
1917 { 'struct': 'PciMemoryRange', 'data': {'base': 'int', 'limit': 'int'} }
1920 # @PciMemoryRegion:
1922 # Information about a PCI device I/O region.
1924 # @bar: the index of the Base Address Register for this region
1926 # @type: 'io' if the region is a PIO region
1927 #        'memory' if the region is a MMIO region
1929 # @size: memory size
1931 # @prefetch: #optional if @type is 'memory', true if the memory is prefetchable
1933 # @mem_type_64: #optional if @type is 'memory', true if the BAR is 64-bit
1935 # Since: 0.14.0
1937 { 'struct': 'PciMemoryRegion',
1938   'data': {'bar': 'int', 'type': 'str', 'address': 'int', 'size': 'int',
1939            '*prefetch': 'bool', '*mem_type_64': 'bool' } }
1942 # @PciBusInfo:
1944 # Information about a bus of a PCI Bridge device
1946 # @number: primary bus interface number.  This should be the number of the
1947 #          bus the device resides on.
1949 # @secondary: secondary bus interface number.  This is the number of the
1950 #             main bus for the bridge
1952 # @subordinate: This is the highest number bus that resides below the
1953 #               bridge.
1955 # @io_range: The PIO range for all devices on this bridge
1957 # @memory_range: The MMIO range for all devices on this bridge
1959 # @prefetchable_range: The range of prefetchable MMIO for all devices on
1960 #                      this bridge
1962 # Since: 2.4
1964 { 'struct': 'PciBusInfo',
1965   'data': {'number': 'int', 'secondary': 'int', 'subordinate': 'int',
1966            'io_range': 'PciMemoryRange',
1967            'memory_range': 'PciMemoryRange',
1968            'prefetchable_range': 'PciMemoryRange' } }
1971 # @PciBridgeInfo:
1973 # Information about a PCI Bridge device
1975 # @bus: information about the bus the device resides on
1977 # @devices: a list of @PciDeviceInfo for each device on this bridge
1979 # Since: 0.14.0
1981 { 'struct': 'PciBridgeInfo',
1982   'data': {'bus': 'PciBusInfo', '*devices': ['PciDeviceInfo']} }
1985 # @PciDeviceClass:
1987 # Information about the Class of a PCI device
1989 # @desc: #optional a string description of the device's class
1991 # @class: the class code of the device
1993 # Since: 2.4
1995 { 'struct': 'PciDeviceClass',
1996   'data': {'*desc': 'str', 'class': 'int'} }
1999 # @PciDeviceId:
2001 # Information about the Id of a PCI device
2003 # @device: the PCI device id
2005 # @vendor: the PCI vendor id
2007 # Since: 2.4
2009 { 'struct': 'PciDeviceId',
2010   'data': {'device': 'int', 'vendor': 'int'} }
2013 # @PciDeviceInfo:
2015 # Information about a PCI device
2017 # @bus: the bus number of the device
2019 # @slot: the slot the device is located in
2021 # @function: the function of the slot used by the device
2023 # @class_info: the class of the device
2025 # @id: the PCI device id
2027 # @irq: #optional if an IRQ is assigned to the device, the IRQ number
2029 # @qdev_id: the device name of the PCI device
2031 # @pci_bridge: if the device is a PCI bridge, the bridge information
2033 # @regions: a list of the PCI I/O regions associated with the device
2035 # Notes: the contents of @class_info.desc are not stable and should only be
2036 #        treated as informational.
2038 # Since: 0.14.0
2040 { 'struct': 'PciDeviceInfo',
2041   'data': {'bus': 'int', 'slot': 'int', 'function': 'int',
2042            'class_info': 'PciDeviceClass', 'id': 'PciDeviceId',
2043            '*irq': 'int', 'qdev_id': 'str', '*pci_bridge': 'PciBridgeInfo',
2044            'regions': ['PciMemoryRegion']} }
2047 # @PciInfo:
2049 # Information about a PCI bus
2051 # @bus: the bus index
2053 # @devices: a list of devices on this bus
2055 # Since: 0.14.0
2057 { 'struct': 'PciInfo', 'data': {'bus': 'int', 'devices': ['PciDeviceInfo']} }
2060 # @query-pci:
2062 # Return information about the PCI bus topology of the guest.
2064 # Returns: a list of @PciInfo for each PCI bus. Each bus is
2065 # represented by a json-object, which has a key with a json-array of
2066 # all PCI devices attached to it. Each device is represented by a
2067 # json-object.
2069 # Since: 0.14.0
2071 # Example:
2073 # -> { "execute": "query-pci" }
2074 # <- { "return": [
2075 #          {
2076 #             "bus": 0,
2077 #             "devices": [
2078 #                {
2079 #                   "bus": 0,
2080 #                   "qdev_id": "",
2081 #                   "slot": 0,
2082 #                   "class_info": {
2083 #                      "class": 1536,
2084 #                      "desc": "Host bridge"
2085 #                   },
2086 #                   "id": {
2087 #                      "device": 32902,
2088 #                      "vendor": 4663
2089 #                   },
2090 #                   "function": 0,
2091 #                   "regions": [
2092 #                   ]
2093 #                },
2094 #                {
2095 #                   "bus": 0,
2096 #                   "qdev_id": "",
2097 #                   "slot": 1,
2098 #                   "class_info": {
2099 #                      "class": 1537,
2100 #                      "desc": "ISA bridge"
2101 #                   },
2102 #                   "id": {
2103 #                      "device": 32902,
2104 #                      "vendor": 28672
2105 #                   },
2106 #                   "function": 0,
2107 #                   "regions": [
2108 #                   ]
2109 #                },
2110 #                {
2111 #                   "bus": 0,
2112 #                   "qdev_id": "",
2113 #                   "slot": 1,
2114 #                   "class_info": {
2115 #                      "class": 257,
2116 #                      "desc": "IDE controller"
2117 #                   },
2118 #                   "id": {
2119 #                      "device": 32902,
2120 #                      "vendor": 28688
2121 #                   },
2122 #                   "function": 1,
2123 #                   "regions": [
2124 #                      {
2125 #                         "bar": 4,
2126 #                         "size": 16,
2127 #                         "address": 49152,
2128 #                         "type": "io"
2129 #                      }
2130 #                   ]
2131 #                },
2132 #                {
2133 #                   "bus": 0,
2134 #                   "qdev_id": "",
2135 #                   "slot": 2,
2136 #                   "class_info": {
2137 #                      "class": 768,
2138 #                      "desc": "VGA controller"
2139 #                   },
2140 #                   "id": {
2141 #                      "device": 4115,
2142 #                      "vendor": 184
2143 #                   },
2144 #                   "function": 0,
2145 #                   "regions": [
2146 #                      {
2147 #                         "prefetch": true,
2148 #                         "mem_type_64": false,
2149 #                         "bar": 0,
2150 #                         "size": 33554432,
2151 #                         "address": 4026531840,
2152 #                         "type": "memory"
2153 #                      },
2154 #                      {
2155 #                         "prefetch": false,
2156 #                         "mem_type_64": false,
2157 #                         "bar": 1,
2158 #                         "size": 4096,
2159 #                         "address": 4060086272,
2160 #                         "type": "memory"
2161 #                      },
2162 #                      {
2163 #                         "prefetch": false,
2164 #                         "mem_type_64": false,
2165 #                         "bar": 6,
2166 #                         "size": 65536,
2167 #                         "address": -1,
2168 #                         "type": "memory"
2169 #                      }
2170 #                   ]
2171 #                },
2172 #                {
2173 #                   "bus": 0,
2174 #                   "qdev_id": "",
2175 #                   "irq": 11,
2176 #                   "slot": 4,
2177 #                   "class_info": {
2178 #                      "class": 1280,
2179 #                      "desc": "RAM controller"
2180 #                   },
2181 #                   "id": {
2182 #                      "device": 6900,
2183 #                      "vendor": 4098
2184 #                   },
2185 #                   "function": 0,
2186 #                   "regions": [
2187 #                      {
2188 #                         "bar": 0,
2189 #                         "size": 32,
2190 #                         "address": 49280,
2191 #                         "type": "io"
2192 #                      }
2193 #                   ]
2194 #                }
2195 #             ]
2196 #          }
2197 #       ]
2198 #    }
2200 # Note: This example has been shortened as the real response is too long.
2203 { 'command': 'query-pci', 'returns': ['PciInfo'] }
2206 # @quit:
2208 # This command will cause the QEMU process to exit gracefully.  While every
2209 # attempt is made to send the QMP response before terminating, this is not
2210 # guaranteed.  When using this interface, a premature EOF would not be
2211 # unexpected.
2213 # Since: 0.14.0
2215 # Example:
2217 # -> { "execute": "quit" }
2218 # <- { "return": {} }
2220 { 'command': 'quit' }
2223 # @stop:
2225 # Stop all guest VCPU execution.
2227 # Since:  0.14.0
2229 # Notes:  This function will succeed even if the guest is already in the stopped
2230 #         state.  In "inmigrate" state, it will ensure that the guest
2231 #         remains paused once migration finishes, as if the -S option was
2232 #         passed on the command line.
2234 # Example:
2236 # -> { "execute": "stop" }
2237 # <- { "return": {} }
2240 { 'command': 'stop' }
2243 # @system_reset:
2245 # Performs a hard reset of a guest.
2247 # Since: 0.14.0
2249 # Example:
2251 # -> { "execute": "system_reset" }
2252 # <- { "return": {} }
2255 { 'command': 'system_reset' }
2258 # @system_powerdown:
2260 # Requests that a guest perform a powerdown operation.
2262 # Since: 0.14.0
2264 # Notes: A guest may or may not respond to this command.  This command
2265 #        returning does not indicate that a guest has accepted the request or
2266 #        that it has shut down.  Many guests will respond to this command by
2267 #        prompting the user in some way.
2268 # Example:
2270 # -> { "execute": "system_powerdown" }
2271 # <- { "return": {} }
2274 { 'command': 'system_powerdown' }
2277 # @cpu:
2279 # This command is a nop that is only provided for the purposes of compatibility.
2281 # Since: 0.14.0
2283 # Notes: Do not use this command.
2285 { 'command': 'cpu', 'data': {'index': 'int'} }
2288 # @cpu-add:
2290 # Adds CPU with specified ID
2292 # @id: ID of CPU to be created, valid values [0..max_cpus)
2294 # Returns: Nothing on success
2296 # Since: 1.5
2298 # Example:
2300 # -> { "execute": "cpu-add", "arguments": { "id": 2 } }
2301 # <- { "return": {} }
2304 { 'command': 'cpu-add', 'data': {'id': 'int'} }
2307 # @memsave:
2309 # Save a portion of guest memory to a file.
2311 # @val: the virtual address of the guest to start from
2313 # @size: the size of memory region to save
2315 # @filename: the file to save the memory to as binary data
2317 # @cpu-index: #optional the index of the virtual CPU to use for translating the
2318 #                       virtual address (defaults to CPU 0)
2320 # Returns: Nothing on success
2322 # Since: 0.14.0
2324 # Notes: Errors were not reliably returned until 1.1
2326 # Example:
2328 # -> { "execute": "memsave",
2329 #      "arguments": { "val": 10,
2330 #                     "size": 100,
2331 #                     "filename": "/tmp/virtual-mem-dump" } }
2332 # <- { "return": {} }
2335 { 'command': 'memsave',
2336   'data': {'val': 'int', 'size': 'int', 'filename': 'str', '*cpu-index': 'int'} }
2339 # @pmemsave:
2341 # Save a portion of guest physical memory to a file.
2343 # @val: the physical address of the guest to start from
2345 # @size: the size of memory region to save
2347 # @filename: the file to save the memory to as binary data
2349 # Returns: Nothing on success
2351 # Since: 0.14.0
2353 # Notes: Errors were not reliably returned until 1.1
2355 # Example:
2357 # -> { "execute": "pmemsave",
2358 #      "arguments": { "val": 10,
2359 #                     "size": 100,
2360 #                     "filename": "/tmp/physical-mem-dump" } }
2361 # <- { "return": {} }
2364 { 'command': 'pmemsave',
2365   'data': {'val': 'int', 'size': 'int', 'filename': 'str'} }
2368 # @cont:
2370 # Resume guest VCPU execution.
2372 # Since:  0.14.0
2374 # Returns:  If successful, nothing
2375 #           If QEMU was started with an encrypted block device and a key has
2376 #              not yet been set, DeviceEncrypted.
2378 # Notes:  This command will succeed if the guest is currently running.  It
2379 #         will also succeed if the guest is in the "inmigrate" state; in
2380 #         this case, the effect of the command is to make sure the guest
2381 #         starts once migration finishes, removing the effect of the -S
2382 #         command line option if it was passed.
2384 # Example:
2386 # -> { "execute": "cont" }
2387 # <- { "return": {} }
2390 { 'command': 'cont' }
2393 # @system_wakeup:
2395 # Wakeup guest from suspend.  Does nothing in case the guest isn't suspended.
2397 # Since:  1.1
2399 # Returns:  nothing.
2401 # Example:
2403 # -> { "execute": "system_wakeup" }
2404 # <- { "return": {} }
2407 { 'command': 'system_wakeup' }
2410 # @inject-nmi:
2412 # Injects a Non-Maskable Interrupt into the default CPU (x86/s390) or all CPUs (ppc64).
2413 # The command fails when the guest doesn't support injecting.
2415 # Returns:  If successful, nothing
2417 # Since:  0.14.0
2419 # Note: prior to 2.1, this command was only supported for x86 and s390 VMs
2421 # Example:
2423 # -> { "execute": "inject-nmi" }
2424 # <- { "return": {} }
2427 { 'command': 'inject-nmi' }
2430 # @set_link:
2432 # Sets the link status of a virtual network adapter.
2434 # @name: the device name of the virtual network adapter
2436 # @up: true to set the link status to be up
2438 # Returns: Nothing on success
2439 #          If @name is not a valid network device, DeviceNotFound
2441 # Since: 0.14.0
2443 # Notes: Not all network adapters support setting link status.  This command
2444 #        will succeed even if the network adapter does not support link status
2445 #        notification.
2447 # Example:
2449 # -> { "execute": "set_link",
2450 #      "arguments": { "name": "e1000.0", "up": false } }
2451 # <- { "return": {} }
2454 { 'command': 'set_link', 'data': {'name': 'str', 'up': 'bool'} }
2457 # @balloon:
2459 # Request the balloon driver to change its balloon size.
2461 # @value: the target size of the balloon in bytes
2463 # Returns: Nothing on success
2464 #          If the balloon driver is enabled but not functional because the KVM
2465 #            kernel module cannot support it, KvmMissingCap
2466 #          If no balloon device is present, DeviceNotActive
2468 # Notes: This command just issues a request to the guest.  When it returns,
2469 #        the balloon size may not have changed.  A guest can change the balloon
2470 #        size independent of this command.
2472 # Since: 0.14.0
2474 # Example:
2476 # -> { "execute": "balloon", "arguments": { "value": 536870912 } }
2477 # <- { "return": {} }
2480 { 'command': 'balloon', 'data': {'value': 'int'} }
2483 # @Abort:
2485 # This action can be used to test transaction failure.
2487 # Since: 1.6
2489 { 'struct': 'Abort',
2490   'data': { } }
2493 # @ActionCompletionMode:
2495 # An enumeration of Transactional completion modes.
2497 # @individual: Do not attempt to cancel any other Actions if any Actions fail
2498 #              after the Transaction request succeeds. All Actions that
2499 #              can complete successfully will do so without waiting on others.
2500 #              This is the default.
2502 # @grouped: If any Action fails after the Transaction succeeds, cancel all
2503 #           Actions. Actions do not complete until all Actions are ready to
2504 #           complete. May be rejected by Actions that do not support this
2505 #           completion mode.
2507 # Since: 2.5
2509 { 'enum': 'ActionCompletionMode',
2510   'data': [ 'individual', 'grouped' ] }
2513 # @TransactionAction:
2515 # A discriminated record of operations that can be performed with
2516 # @transaction. Action @type can be:
2518 # - @abort: since 1.6
2519 # - @block-dirty-bitmap-add: since 2.5
2520 # - @block-dirty-bitmap-clear: since 2.5
2521 # - @blockdev-backup: since 2.3
2522 # - @blockdev-snapshot: since 2.5
2523 # - @blockdev-snapshot-internal-sync: since 1.7
2524 # - @blockdev-snapshot-sync: since 1.1
2525 # - @drive-backup: since 1.6
2527 # Since: 1.1
2529 { 'union': 'TransactionAction',
2530   'data': {
2531        'abort': 'Abort',
2532        'block-dirty-bitmap-add': 'BlockDirtyBitmapAdd',
2533        'block-dirty-bitmap-clear': 'BlockDirtyBitmap',
2534        'blockdev-backup': 'BlockdevBackup',
2535        'blockdev-snapshot': 'BlockdevSnapshot',
2536        'blockdev-snapshot-internal-sync': 'BlockdevSnapshotInternal',
2537        'blockdev-snapshot-sync': 'BlockdevSnapshotSync',
2538        'drive-backup': 'DriveBackup'
2539    } }
2542 # @TransactionProperties:
2544 # Optional arguments to modify the behavior of a Transaction.
2546 # @completion-mode: #optional Controls how jobs launched asynchronously by
2547 #                   Actions will complete or fail as a group.
2548 #                   See @ActionCompletionMode for details.
2550 # Since: 2.5
2552 { 'struct': 'TransactionProperties',
2553   'data': {
2554        '*completion-mode': 'ActionCompletionMode'
2555   }
2559 # @transaction:
2561 # Executes a number of transactionable QMP commands atomically. If any
2562 # operation fails, then the entire set of actions will be abandoned and the
2563 # appropriate error returned.
2565 # For external snapshots, the dictionary contains the device, the file to use for
2566 # the new snapshot, and the format.  The default format, if not specified, is
2567 # qcow2.
2569 # Each new snapshot defaults to being created by QEMU (wiping any
2570 # contents if the file already exists), but it is also possible to reuse
2571 # an externally-created file.  In the latter case, you should ensure that
2572 # the new image file has the same contents as the current one; QEMU cannot
2573 # perform any meaningful check.  Typically this is achieved by using the
2574 # current image file as the backing file for the new image.
2576 # On failure, the original disks pre-snapshot attempt will be used.
2578 # For internal snapshots, the dictionary contains the device and the snapshot's
2579 # name.  If an internal snapshot matching name already exists, the request will
2580 # be rejected.  Only some image formats support it, for example, qcow2, rbd,
2581 # and sheepdog.
2583 # On failure, qemu will try delete the newly created internal snapshot in the
2584 # transaction.  When an I/O error occurs during deletion, the user needs to fix
2585 # it later with qemu-img or other command.
2587 # @actions: List of @TransactionAction;
2588 #           information needed for the respective operations.
2590 # @properties: #optional structure of additional options to control the
2591 #              execution of the transaction. See @TransactionProperties
2592 #              for additional detail.
2594 # Returns: nothing on success
2596 #          Errors depend on the operations of the transaction
2598 # Note: The transaction aborts on the first failure.  Therefore, there will be
2599 # information on only one failed operation returned in an error condition, and
2600 # subsequent actions will not have been attempted.
2602 # Since: 1.1
2604 # Example:
2606 # -> { "execute": "transaction",
2607 #      "arguments": { "actions": [
2608 #          { "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd0",
2609 #                                      "snapshot-file": "/some/place/my-image",
2610 #                                      "format": "qcow2" } },
2611 #          { "type": "blockdev-snapshot-sync", "data" : { "node-name": "myfile",
2612 #                                      "snapshot-file": "/some/place/my-image2",
2613 #                                      "snapshot-node-name": "node3432",
2614 #                                      "mode": "existing",
2615 #                                      "format": "qcow2" } },
2616 #          { "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd1",
2617 #                                      "snapshot-file": "/some/place/my-image2",
2618 #                                      "mode": "existing",
2619 #                                      "format": "qcow2" } },
2620 #          { "type": "blockdev-snapshot-internal-sync", "data" : {
2621 #                                      "device": "ide-hd2",
2622 #                                      "name": "snapshot0" } } ] } }
2623 # <- { "return": {} }
2626 { 'command': 'transaction',
2627   'data': { 'actions': [ 'TransactionAction' ],
2628             '*properties': 'TransactionProperties'
2629           }
2633 # @human-monitor-command:
2635 # Execute a command on the human monitor and return the output.
2637 # @command-line: the command to execute in the human monitor
2639 # @cpu-index: #optional The CPU to use for commands that require an implicit CPU
2641 # Returns: the output of the command as a string
2643 # Since: 0.14.0
2645 # Notes: This command only exists as a stop-gap.  Its use is highly
2646 #        discouraged.  The semantics of this command are not
2647 #        guaranteed: this means that command names, arguments and
2648 #        responses can change or be removed at ANY time.  Applications
2649 #        that rely on long term stability guarantees should NOT
2650 #        use this command.
2652 #        Known limitations:
2654 #        * This command is stateless, this means that commands that depend
2655 #          on state information (such as getfd) might not work
2657 #        * Commands that prompt the user for data (eg. 'cont' when the block
2658 #          device is encrypted) don't currently work
2660 # Example:
2662 # -> { "execute": "human-monitor-command",
2663 #      "arguments": { "command-line": "info kvm" } }
2664 # <- { "return": "kvm support: enabled\r\n" }
2667 { 'command': 'human-monitor-command',
2668   'data': {'command-line': 'str', '*cpu-index': 'int'},
2669   'returns': 'str' }
2672 # @migrate_cancel:
2674 # Cancel the current executing migration process.
2676 # Returns: nothing on success
2678 # Notes: This command succeeds even if there is no migration process running.
2680 # Since: 0.14.0
2682 # Example:
2684 # -> { "execute": "migrate_cancel" }
2685 # <- { "return": {} }
2688 { 'command': 'migrate_cancel' }
2691 # @migrate_set_downtime:
2693 # Set maximum tolerated downtime for migration.
2695 # @value: maximum downtime in seconds
2697 # Returns: nothing on success
2699 # Notes: This command is deprecated in favor of 'migrate-set-parameters'
2701 # Since: 0.14.0
2703 # Example:
2705 # -> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } }
2706 # <- { "return": {} }
2709 { 'command': 'migrate_set_downtime', 'data': {'value': 'number'} }
2712 # @migrate_set_speed:
2714 # Set maximum speed for migration.
2716 # @value: maximum speed in bytes per second.
2718 # Returns: nothing on success
2720 # Notes: This command is deprecated in favor of 'migrate-set-parameters'
2722 # Since: 0.14.0
2724 # Example:
2726 # -> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } }
2727 # <- { "return": {} }
2730 { 'command': 'migrate_set_speed', 'data': {'value': 'int'} }
2733 # @migrate-set-cache-size:
2735 # Set cache size to be used by XBZRLE migration
2737 # @value: cache size in bytes
2739 # The size will be rounded down to the nearest power of 2.
2740 # The cache size can be modified before and during ongoing migration
2742 # Returns: nothing on success
2744 # Since: 1.2
2746 # Example:
2748 # -> { "execute": "migrate-set-cache-size",
2749 #      "arguments": { "value": 536870912 } }
2750 # <- { "return": {} }
2753 { 'command': 'migrate-set-cache-size', 'data': {'value': 'int'} }
2756 # @query-migrate-cache-size:
2758 # Query migration XBZRLE cache size
2760 # Returns: XBZRLE cache size in bytes
2762 # Since: 1.2
2764 # Example:
2766 # -> { "execute": "query-migrate-cache-size" }
2767 # <- { "return": 67108864 }
2770 { 'command': 'query-migrate-cache-size', 'returns': 'int' }
2773 # @ObjectPropertyInfo:
2775 # @name: the name of the property
2777 # @type: the type of the property.  This will typically come in one of four
2778 #        forms:
2780 #        1) A primitive type such as 'u8', 'u16', 'bool', 'str', or 'double'.
2781 #           These types are mapped to the appropriate JSON type.
2783 #        2) A child type in the form 'child<subtype>' where subtype is a qdev
2784 #           device type name.  Child properties create the composition tree.
2786 #        3) A link type in the form 'link<subtype>' where subtype is a qdev
2787 #           device type name.  Link properties form the device model graph.
2789 # Since: 1.2
2791 { 'struct': 'ObjectPropertyInfo',
2792   'data': { 'name': 'str', 'type': 'str' } }
2795 # @qom-list:
2797 # This command will list any properties of a object given a path in the object
2798 # model.
2800 # @path: the path within the object model.  See @qom-get for a description of
2801 #        this parameter.
2803 # Returns: a list of @ObjectPropertyInfo that describe the properties of the
2804 #          object.
2806 # Since: 1.2
2808 { 'command': 'qom-list',
2809   'data': { 'path': 'str' },
2810   'returns': [ 'ObjectPropertyInfo' ] }
2813 # @qom-get:
2815 # This command will get a property from a object model path and return the
2816 # value.
2818 # @path: The path within the object model.  There are two forms of supported
2819 #        paths--absolute and partial paths.
2821 #        Absolute paths are derived from the root object and can follow child<>
2822 #        or link<> properties.  Since they can follow link<> properties, they
2823 #        can be arbitrarily long.  Absolute paths look like absolute filenames
2824 #        and are prefixed  with a leading slash.
2826 #        Partial paths look like relative filenames.  They do not begin
2827 #        with a prefix.  The matching rules for partial paths are subtle but
2828 #        designed to make specifying objects easy.  At each level of the
2829 #        composition tree, the partial path is matched as an absolute path.
2830 #        The first match is not returned.  At least two matches are searched
2831 #        for.  A successful result is only returned if only one match is
2832 #        found.  If more than one match is found, a flag is return to
2833 #        indicate that the match was ambiguous.
2835 # @property: The property name to read
2837 # Returns: The property value.  The type depends on the property
2838 #          type. child<> and link<> properties are returned as #str
2839 #          pathnames.  All integer property types (u8, u16, etc) are
2840 #          returned as #int.
2842 # Since: 1.2
2844 { 'command': 'qom-get',
2845   'data': { 'path': 'str', 'property': 'str' },
2846   'returns': 'any' }
2849 # @qom-set:
2851 # This command will set a property from a object model path.
2853 # @path: see @qom-get for a description of this parameter
2855 # @property: the property name to set
2857 # @value: a value who's type is appropriate for the property type.  See @qom-get
2858 #         for a description of type mapping.
2860 # Since: 1.2
2862 { 'command': 'qom-set',
2863   'data': { 'path': 'str', 'property': 'str', 'value': 'any' } }
2866 # @set_password:
2868 # Sets the password of a remote display session.
2870 # @protocol: `vnc' to modify the VNC server password
2871 #            `spice' to modify the Spice server password
2873 # @password: the new password
2875 # @connected: #optional how to handle existing clients when changing the
2876 #                       password.  If nothing is specified, defaults to `keep'
2877 #                       `fail' to fail the command if clients are connected
2878 #                       `disconnect' to disconnect existing clients
2879 #                       `keep' to maintain existing clients
2881 # Returns: Nothing on success
2882 #          If Spice is not enabled, DeviceNotFound
2884 # Since: 0.14.0
2886 # Example:
2888 # -> { "execute": "set_password", "arguments": { "protocol": "vnc",
2889 #                                                "password": "secret" } }
2890 # <- { "return": {} }
2893 { 'command': 'set_password',
2894   'data': {'protocol': 'str', 'password': 'str', '*connected': 'str'} }
2897 # @expire_password:
2899 # Expire the password of a remote display server.
2901 # @protocol: the name of the remote display protocol `vnc' or `spice'
2903 # @time: when to expire the password.
2904 #        `now' to expire the password immediately
2905 #        `never' to cancel password expiration
2906 #        `+INT' where INT is the number of seconds from now (integer)
2907 #        `INT' where INT is the absolute time in seconds
2909 # Returns: Nothing on success
2910 #          If @protocol is `spice' and Spice is not active, DeviceNotFound
2912 # Since: 0.14.0
2914 # Notes: Time is relative to the server and currently there is no way to
2915 #        coordinate server time with client time.  It is not recommended to
2916 #        use the absolute time version of the @time parameter unless you're
2917 #        sure you are on the same machine as the QEMU instance.
2919 # Example:
2921 # -> { "execute": "expire_password", "arguments": { "protocol": "vnc",
2922 #                                                   "time": "+60" } }
2923 # <- { "return": {} }
2926 { 'command': 'expire_password', 'data': {'protocol': 'str', 'time': 'str'} }
2929 # @change-vnc-password:
2931 # Change the VNC server password.
2933 # @password:  the new password to use with VNC authentication
2935 # Since: 1.1
2937 # Notes:  An empty password in this command will set the password to the empty
2938 #         string.  Existing clients are unaffected by executing this command.
2940 { 'command': 'change-vnc-password', 'data': {'password': 'str'} }
2943 # @change:
2945 # This command is multiple commands multiplexed together.
2947 # @device: This is normally the name of a block device but it may also be 'vnc'.
2948 #          when it's 'vnc', then sub command depends on @target
2950 # @target: If @device is a block device, then this is the new filename.
2951 #          If @device is 'vnc', then if the value 'password' selects the vnc
2952 #          change password command.   Otherwise, this specifies a new server URI
2953 #          address to listen to for VNC connections.
2955 # @arg:    If @device is a block device, then this is an optional format to open
2956 #          the device with.
2957 #          If @device is 'vnc' and @target is 'password', this is the new VNC
2958 #          password to set.  If this argument is an empty string, then no future
2959 #          logins will be allowed.
2961 # Returns: Nothing on success.
2962 #          If @device is not a valid block device, DeviceNotFound
2963 #          If the new block device is encrypted, DeviceEncrypted.  Note that
2964 #          if this error is returned, the device has been opened successfully
2965 #          and an additional call to @block_passwd is required to set the
2966 #          device's password.  The behavior of reads and writes to the block
2967 #          device between when these calls are executed is undefined.
2969 # Notes:  This interface is deprecated, and it is strongly recommended that you
2970 #         avoid using it.  For changing block devices, use
2971 #         blockdev-change-medium; for changing VNC parameters, use
2972 #         change-vnc-password.
2974 # Since: 0.14.0
2976 # Example:
2978 # 1. Change a removable medium
2980 # -> { "execute": "change",
2981 #      "arguments": { "device": "ide1-cd0",
2982 #                     "target": "/srv/images/Fedora-12-x86_64-DVD.iso" } }
2983 # <- { "return": {} }
2985 # 2. Change VNC password
2987 # -> { "execute": "change",
2988 #      "arguments": { "device": "vnc", "target": "password",
2989 #                     "arg": "foobar1" } }
2990 # <- { "return": {} }
2993 { 'command': 'change',
2994   'data': {'device': 'str', 'target': 'str', '*arg': 'str'} }
2997 # @ObjectTypeInfo:
2999 # This structure describes a search result from @qom-list-types
3001 # @name: the type name found in the search
3003 # Since: 1.1
3005 # Notes: This command is experimental and may change syntax in future releases.
3007 { 'struct': 'ObjectTypeInfo',
3008   'data': { 'name': 'str' } }
3011 # @qom-list-types:
3013 # This command will return a list of types given search parameters
3015 # @implements: if specified, only return types that implement this type name
3017 # @abstract: if true, include abstract types in the results
3019 # Returns: a list of @ObjectTypeInfo or an empty list if no results are found
3021 # Since: 1.1
3023 { 'command': 'qom-list-types',
3024   'data': { '*implements': 'str', '*abstract': 'bool' },
3025   'returns': [ 'ObjectTypeInfo' ] }
3028 # @DevicePropertyInfo:
3030 # Information about device properties.
3032 # @name: the name of the property
3033 # @type: the typename of the property
3034 # @description: #optional if specified, the description of the property.
3035 #               (since 2.2)
3037 # Since: 1.2
3039 { 'struct': 'DevicePropertyInfo',
3040   'data': { 'name': 'str', 'type': 'str', '*description': 'str' } }
3043 # @device-list-properties:
3045 # List properties associated with a device.
3047 # @typename: the type name of a device
3049 # Returns: a list of DevicePropertyInfo describing a devices properties
3051 # Since: 1.2
3053 { 'command': 'device-list-properties',
3054   'data': { 'typename': 'str'},
3055   'returns': [ 'DevicePropertyInfo' ] }
3058 # @migrate:
3060 # Migrates the current running guest to another Virtual Machine.
3062 # @uri: the Uniform Resource Identifier of the destination VM
3064 # @blk: #optional do block migration (full disk copy)
3066 # @inc: #optional incremental disk copy migration
3068 # @detach: this argument exists only for compatibility reasons and
3069 #          is ignored by QEMU
3071 # Returns: nothing on success
3073 # Since: 0.14.0
3075 # Notes:
3077 # 1. The 'query-migrate' command should be used to check migration's progress
3078 #    and final result (this information is provided by the 'status' member)
3080 # 2. All boolean arguments default to false
3082 # 3. The user Monitor's "detach" argument is invalid in QMP and should not
3083 #    be used
3085 # Example:
3087 # -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
3088 # <- { "return": {} }
3091 { 'command': 'migrate',
3092   'data': {'uri': 'str', '*blk': 'bool', '*inc': 'bool', '*detach': 'bool' } }
3095 # @migrate-incoming:
3097 # Start an incoming migration, the qemu must have been started
3098 # with -incoming defer
3100 # @uri: The Uniform Resource Identifier identifying the source or
3101 #       address to listen on
3103 # Returns: nothing on success
3105 # Since: 2.3
3107 # Notes:
3109 # 1. It's a bad idea to use a string for the uri, but it needs to stay
3110 #    compatible with -incoming and the format of the uri is already exposed
3111 #    above libvirt.
3113 # 2. QEMU must be started with -incoming defer to allow migrate-incoming to
3114 #    be used.
3116 # 3. The uri format is the same as for -incoming
3118 # Example:
3120 # -> { "execute": "migrate-incoming",
3121 #      "arguments": { "uri": "tcp::4446" } }
3122 # <- { "return": {} }
3125 { 'command': 'migrate-incoming', 'data': {'uri': 'str' } }
3128 # @xen-save-devices-state:
3130 # Save the state of all devices to file. The RAM and the block devices
3131 # of the VM are not saved by this command.
3133 # @filename: the file to save the state of the devices to as binary
3134 # data. See xen-save-devices-state.txt for a description of the binary
3135 # format.
3137 # Returns: Nothing on success
3139 # Since: 1.1
3141 # Example:
3143 # -> { "execute": "xen-save-devices-state",
3144 #      "arguments": { "filename": "/tmp/save" } }
3145 # <- { "return": {} }
3148 { 'command': 'xen-save-devices-state', 'data': {'filename': 'str'} }
3151 # @xen-set-global-dirty-log:
3153 # Enable or disable the global dirty log mode.
3155 # @enable: true to enable, false to disable.
3157 # Returns: nothing
3159 # Since: 1.3
3161 # Example:
3163 # -> { "execute": "xen-set-global-dirty-log",
3164 #      "arguments": { "enable": true } }
3165 # <- { "return": {} }
3168 { 'command': 'xen-set-global-dirty-log', 'data': { 'enable': 'bool' } }
3171 # @device_add:
3173 # @driver: the name of the new device's driver
3175 # @bus: #optional the device's parent bus (device tree path)
3177 # @id: #optional the device's ID, must be unique
3179 # Additional arguments depend on the type.
3181 # Add a device.
3183 # Notes:
3184 # 1. For detailed information about this command, please refer to the
3185 #    'docs/qdev-device-use.txt' file.
3187 # 2. It's possible to list device properties by running QEMU with the
3188 #    "-device DEVICE,help" command-line argument, where DEVICE is the
3189 #    device's name
3191 # Example:
3193 # -> { "execute": "device_add",
3194 #      "arguments": { "driver": "e1000", "id": "net1",
3195 #                     "bus": "pci.0",
3196 #                     "mac": "52:54:00:12:34:56" } }
3197 # <- { "return": {} }
3199 # TODO: This command effectively bypasses QAPI completely due to its
3200 # "additional arguments" business.  It shouldn't have been added to
3201 # the schema in this form.  It should be qapified properly, or
3202 # replaced by a properly qapified command.
3204 # Since: 0.13
3206 { 'command': 'device_add',
3207   'data': {'driver': 'str', '*bus': 'str', '*id': 'str'},
3208   'gen': false } # so we can get the additional arguments
3211 # @device_del:
3213 # Remove a device from a guest
3215 # @id: the device's ID or QOM path
3217 # Returns: Nothing on success
3218 #          If @id is not a valid device, DeviceNotFound
3220 # Notes: When this command completes, the device may not be removed from the
3221 #        guest.  Hot removal is an operation that requires guest cooperation.
3222 #        This command merely requests that the guest begin the hot removal
3223 #        process.  Completion of the device removal process is signaled with a
3224 #        DEVICE_DELETED event. Guest reset will automatically complete removal
3225 #        for all devices.
3227 # Since: 0.14.0
3229 # Example:
3231 # -> { "execute": "device_del",
3232 #      "arguments": { "id": "net1" } }
3233 # <- { "return": {} }
3235 # -> { "execute": "device_del",
3236 #      "arguments": { "id": "/machine/peripheral-anon/device[0]" } }
3237 # <- { "return": {} }
3240 { 'command': 'device_del', 'data': {'id': 'str'} }
3243 # @DumpGuestMemoryFormat:
3245 # An enumeration of guest-memory-dump's format.
3247 # @elf: elf format
3249 # @kdump-zlib: kdump-compressed format with zlib-compressed
3251 # @kdump-lzo: kdump-compressed format with lzo-compressed
3253 # @kdump-snappy: kdump-compressed format with snappy-compressed
3255 # Since: 2.0
3257 { 'enum': 'DumpGuestMemoryFormat',
3258   'data': [ 'elf', 'kdump-zlib', 'kdump-lzo', 'kdump-snappy' ] }
3261 # @dump-guest-memory:
3263 # Dump guest's memory to vmcore. It is a synchronous operation that can take
3264 # very long depending on the amount of guest memory.
3266 # @paging: if true, do paging to get guest's memory mapping. This allows
3267 #          using gdb to process the core file.
3269 #          IMPORTANT: this option can make QEMU allocate several gigabytes
3270 #                     of RAM. This can happen for a large guest, or a
3271 #                     malicious guest pretending to be large.
3273 #          Also, paging=true has the following limitations:
3275 #             1. The guest may be in a catastrophic state or can have corrupted
3276 #                memory, which cannot be trusted
3277 #             2. The guest can be in real-mode even if paging is enabled. For
3278 #                example, the guest uses ACPI to sleep, and ACPI sleep state
3279 #                goes in real-mode
3280 #             3. Currently only supported on i386 and x86_64.
3282 # @protocol: the filename or file descriptor of the vmcore. The supported
3283 #            protocols are:
3285 #            1. file: the protocol starts with "file:", and the following
3286 #               string is the file's path.
3287 #            2. fd: the protocol starts with "fd:", and the following string
3288 #               is the fd's name.
3290 # @detach: #optional if true, QMP will return immediately rather than
3291 #          waiting for the dump to finish. The user can track progress
3292 #          using "query-dump". (since 2.6).
3294 # @begin: #optional if specified, the starting physical address.
3296 # @length: #optional if specified, the memory size, in bytes. If you don't
3297 #          want to dump all guest's memory, please specify the start @begin
3298 #          and @length
3300 # @format: #optional if specified, the format of guest memory dump. But non-elf
3301 #          format is conflict with paging and filter, ie. @paging, @begin and
3302 #          @length is not allowed to be specified with non-elf @format at the
3303 #          same time (since 2.0)
3305 # Note: All boolean arguments default to false
3307 # Returns: nothing on success
3309 # Since: 1.2
3311 # Example:
3313 # -> { "execute": "dump-guest-memory",
3314 #      "arguments": { "protocol": "fd:dump" } }
3315 # <- { "return": {} }
3318 { 'command': 'dump-guest-memory',
3319   'data': { 'paging': 'bool', 'protocol': 'str', '*detach': 'bool',
3320             '*begin': 'int', '*length': 'int',
3321             '*format': 'DumpGuestMemoryFormat'} }
3324 # @DumpStatus:
3326 # Describe the status of a long-running background guest memory dump.
3328 # @none: no dump-guest-memory has started yet.
3330 # @active: there is one dump running in background.
3332 # @completed: the last dump has finished successfully.
3334 # @failed: the last dump has failed.
3336 # Since: 2.6
3338 { 'enum': 'DumpStatus',
3339   'data': [ 'none', 'active', 'completed', 'failed' ] }
3342 # @DumpQueryResult:
3344 # The result format for 'query-dump'.
3346 # @status: enum of @DumpStatus, which shows current dump status
3348 # @completed: bytes written in latest dump (uncompressed)
3350 # @total: total bytes to be written in latest dump (uncompressed)
3352 # Since: 2.6
3354 { 'struct': 'DumpQueryResult',
3355   'data': { 'status': 'DumpStatus',
3356             'completed': 'int',
3357             'total': 'int' } }
3360 # @query-dump:
3362 # Query latest dump status.
3364 # Returns: A @DumpStatus object showing the dump status.
3366 # Since: 2.6
3368 # Example:
3370 # -> { "execute": "query-dump" }
3371 # <- { "return": { "status": "active", "completed": 1024000,
3372 #                  "total": 2048000 } }
3375 { 'command': 'query-dump', 'returns': 'DumpQueryResult' }
3378 # @DumpGuestMemoryCapability:
3380 # A list of the available formats for dump-guest-memory
3382 # Since: 2.0
3384 { 'struct': 'DumpGuestMemoryCapability',
3385   'data': {
3386       'formats': ['DumpGuestMemoryFormat'] } }
3389 # @query-dump-guest-memory-capability:
3391 # Returns the available formats for dump-guest-memory
3393 # Returns:  A @DumpGuestMemoryCapability object listing available formats for
3394 #           dump-guest-memory
3396 # Since: 2.0
3398 # Example:
3400 # -> { "execute": "query-dump-guest-memory-capability" }
3401 # <- { "return": { "formats":
3402 #                  ["elf", "kdump-zlib", "kdump-lzo", "kdump-snappy"] }
3405 { 'command': 'query-dump-guest-memory-capability',
3406   'returns': 'DumpGuestMemoryCapability' }
3409 # @dump-skeys:
3411 # Dump guest's storage keys
3413 # @filename: the path to the file to dump to
3415 # This command is only supported on s390 architecture.
3417 # Since: 2.5
3419 # Example:
3421 # -> { "execute": "dump-skeys",
3422 #      "arguments": { "filename": "/tmp/skeys" } }
3423 # <- { "return": {} }
3426 { 'command': 'dump-skeys',
3427   'data': { 'filename': 'str' } }
3430 # @netdev_add:
3432 # Add a network backend.
3434 # @type: the type of network backend.  Current valid values are 'user', 'tap',
3435 #        'vde', 'socket', 'dump' and 'bridge'
3437 # @id: the name of the new network backend
3439 # Additional arguments depend on the type.
3441 # TODO: This command effectively bypasses QAPI completely due to its
3442 # "additional arguments" business.  It shouldn't have been added to
3443 # the schema in this form.  It should be qapified properly, or
3444 # replaced by a properly qapified command.
3446 # Since: 0.14.0
3448 # Returns: Nothing on success
3449 #          If @type is not a valid network backend, DeviceNotFound
3451 # Example:
3453 # -> { "execute": "netdev_add",
3454 #      "arguments": { "type": "user", "id": "netdev1",
3455 #                     "dnssearch": "example.org" } }
3456 # <- { "return": {} }
3459 { 'command': 'netdev_add',
3460   'data': {'type': 'str', 'id': 'str'},
3461   'gen': false }                # so we can get the additional arguments
3464 # @netdev_del:
3466 # Remove a network backend.
3468 # @id: the name of the network backend to remove
3470 # Returns: Nothing on success
3471 #          If @id is not a valid network backend, DeviceNotFound
3473 # Since: 0.14.0
3475 # Example:
3477 # -> { "execute": "netdev_del", "arguments": { "id": "netdev1" } }
3478 # <- { "return": {} }
3481 { 'command': 'netdev_del', 'data': {'id': 'str'} }
3484 # @object-add:
3486 # Create a QOM object.
3488 # @qom-type: the class name for the object to be created
3490 # @id: the name of the new object
3492 # @props: #optional a dictionary of properties to be passed to the backend
3494 # Returns: Nothing on success
3495 #          Error if @qom-type is not a valid class name
3497 # Since: 2.0
3499 # Example:
3501 # -> { "execute": "object-add",
3502 #      "arguments": { "qom-type": "rng-random", "id": "rng1",
3503 #                     "props": { "filename": "/dev/hwrng" } } }
3504 # <- { "return": {} }
3507 { 'command': 'object-add',
3508   'data': {'qom-type': 'str', 'id': 'str', '*props': 'any'} }
3511 # @object-del:
3513 # Remove a QOM object.
3515 # @id: the name of the QOM object to remove
3517 # Returns: Nothing on success
3518 #          Error if @id is not a valid id for a QOM object
3520 # Since: 2.0
3522 # Example:
3524 # -> { "execute": "object-del", "arguments": { "id": "rng1" } }
3525 # <- { "return": {} }
3528 { 'command': 'object-del', 'data': {'id': 'str'} }
3531 # @NetdevNoneOptions:
3533 # Use it alone to have zero network devices.
3535 # Since: 1.2
3537 { 'struct': 'NetdevNoneOptions',
3538   'data': { } }
3541 # @NetLegacyNicOptions:
3543 # Create a new Network Interface Card.
3545 # @netdev: #optional id of -netdev to connect to
3547 # @macaddr: #optional MAC address
3549 # @model: #optional device model (e1000, rtl8139, virtio etc.)
3551 # @addr: #optional PCI device address
3553 # @vectors: #optional number of MSI-x vectors, 0 to disable MSI-X
3555 # Since: 1.2
3557 { 'struct': 'NetLegacyNicOptions',
3558   'data': {
3559     '*netdev':  'str',
3560     '*macaddr': 'str',
3561     '*model':   'str',
3562     '*addr':    'str',
3563     '*vectors': 'uint32' } }
3566 # @String:
3568 # A fat type wrapping 'str', to be embedded in lists.
3570 # Since: 1.2
3572 { 'struct': 'String',
3573   'data': {
3574     'str': 'str' } }
3577 # @NetdevUserOptions:
3579 # Use the user mode network stack which requires no administrator privilege to
3580 # run.
3582 # @hostname: #optional client hostname reported by the builtin DHCP server
3584 # @restrict: #optional isolate the guest from the host
3586 # @ipv4: #optional whether to support IPv4, default true for enabled
3587 #        (since 2.6)
3589 # @ipv6: #optional whether to support IPv6, default true for enabled
3590 #        (since 2.6)
3592 # @ip: #optional legacy parameter, use net= instead
3594 # @net: #optional IP network address that the guest will see, in the
3595 #       form addr[/netmask] The netmask is optional, and can be
3596 #       either in the form a.b.c.d or as a number of valid top-most
3597 #       bits. Default is 10.0.2.0/24.
3599 # @host: #optional guest-visible address of the host
3601 # @tftp: #optional root directory of the built-in TFTP server
3603 # @bootfile: #optional BOOTP filename, for use with tftp=
3605 # @dhcpstart: #optional the first of the 16 IPs the built-in DHCP server can
3606 #             assign
3608 # @dns: #optional guest-visible address of the virtual nameserver
3610 # @dnssearch: #optional list of DNS suffixes to search, passed as DHCP option
3611 #             to the guest
3613 # @ipv6-prefix: #optional IPv6 network prefix (default is fec0::) (since
3614 #               2.6). The network prefix is given in the usual
3615 #               hexadecimal IPv6 address notation.
3617 # @ipv6-prefixlen: #optional IPv6 network prefix length (default is 64)
3618 #                  (since 2.6)
3620 # @ipv6-host: #optional guest-visible IPv6 address of the host (since 2.6)
3622 # @ipv6-dns: #optional guest-visible IPv6 address of the virtual
3623 #            nameserver (since 2.6)
3625 # @smb: #optional root directory of the built-in SMB server
3627 # @smbserver: #optional IP address of the built-in SMB server
3629 # @hostfwd: #optional redirect incoming TCP or UDP host connections to guest
3630 #           endpoints
3632 # @guestfwd: #optional forward guest TCP connections
3634 # Since: 1.2
3636 { 'struct': 'NetdevUserOptions',
3637   'data': {
3638     '*hostname':  'str',
3639     '*restrict':  'bool',
3640     '*ipv4':      'bool',
3641     '*ipv6':      'bool',
3642     '*ip':        'str',
3643     '*net':       'str',
3644     '*host':      'str',
3645     '*tftp':      'str',
3646     '*bootfile':  'str',
3647     '*dhcpstart': 'str',
3648     '*dns':       'str',
3649     '*dnssearch': ['String'],
3650     '*ipv6-prefix':      'str',
3651     '*ipv6-prefixlen':   'int',
3652     '*ipv6-host':        'str',
3653     '*ipv6-dns':         'str',
3654     '*smb':       'str',
3655     '*smbserver': 'str',
3656     '*hostfwd':   ['String'],
3657     '*guestfwd':  ['String'] } }
3660 # @NetdevTapOptions:
3662 # Connect the host TAP network interface name to the VLAN.
3664 # @ifname: #optional interface name
3666 # @fd: #optional file descriptor of an already opened tap
3668 # @fds: #optional multiple file descriptors of already opened multiqueue capable
3669 # tap
3671 # @script: #optional script to initialize the interface
3673 # @downscript: #optional script to shut down the interface
3675 # @br: #optional bridge name (since 2.8)
3677 # @helper: #optional command to execute to configure bridge
3679 # @sndbuf: #optional send buffer limit. Understands [TGMKkb] suffixes.
3681 # @vnet_hdr: #optional enable the IFF_VNET_HDR flag on the tap interface
3683 # @vhost: #optional enable vhost-net network accelerator
3685 # @vhostfd: #optional file descriptor of an already opened vhost net device
3687 # @vhostfds: #optional file descriptors of multiple already opened vhost net
3688 # devices
3690 # @vhostforce: #optional vhost on for non-MSIX virtio guests
3692 # @queues: #optional number of queues to be created for multiqueue capable tap
3694 # @poll-us: #optional maximum number of microseconds that could
3695 # be spent on busy polling for tap (since 2.7)
3697 # Since: 1.2
3699 { 'struct': 'NetdevTapOptions',
3700   'data': {
3701     '*ifname':     'str',
3702     '*fd':         'str',
3703     '*fds':        'str',
3704     '*script':     'str',
3705     '*downscript': 'str',
3706     '*br':         'str',
3707     '*helper':     'str',
3708     '*sndbuf':     'size',
3709     '*vnet_hdr':   'bool',
3710     '*vhost':      'bool',
3711     '*vhostfd':    'str',
3712     '*vhostfds':   'str',
3713     '*vhostforce': 'bool',
3714     '*queues':     'uint32',
3715     '*poll-us':    'uint32'} }
3718 # @NetdevSocketOptions:
3720 # Connect the VLAN to a remote VLAN in another QEMU virtual machine using a TCP
3721 # socket connection.
3723 # @fd: #optional file descriptor of an already opened socket
3725 # @listen: #optional port number, and optional hostname, to listen on
3727 # @connect: #optional port number, and optional hostname, to connect to
3729 # @mcast: #optional UDP multicast address and port number
3731 # @localaddr: #optional source address and port for multicast and udp packets
3733 # @udp: #optional UDP unicast address and port number
3735 # Since: 1.2
3737 { 'struct': 'NetdevSocketOptions',
3738   'data': {
3739     '*fd':        'str',
3740     '*listen':    'str',
3741     '*connect':   'str',
3742     '*mcast':     'str',
3743     '*localaddr': 'str',
3744     '*udp':       'str' } }
3747 # @NetdevL2TPv3Options:
3749 # Connect the VLAN to Ethernet over L2TPv3 Static tunnel
3751 # @src: source address
3753 # @dst: destination address
3755 # @srcport: #optional source port - mandatory for udp, optional for ip
3757 # @dstport: #optional destination port - mandatory for udp, optional for ip
3759 # @ipv6: #optional - force the use of ipv6
3761 # @udp: #optional - use the udp version of l2tpv3 encapsulation
3763 # @cookie64: #optional - use 64 bit coookies
3765 # @counter: #optional have sequence counter
3767 # @pincounter: #optional pin sequence counter to zero -
3768 #              workaround for buggy implementations or
3769 #              networks with packet reorder
3771 # @txcookie: #optional 32 or 64 bit transmit cookie
3773 # @rxcookie: #optional 32 or 64 bit receive cookie
3775 # @txsession: 32 bit transmit session
3777 # @rxsession: #optional 32 bit receive session - if not specified
3778 #             set to the same value as transmit
3780 # @offset: #optional additional offset - allows the insertion of
3781 #          additional application-specific data before the packet payload
3783 # Since: 2.1
3785 { 'struct': 'NetdevL2TPv3Options',
3786   'data': {
3787     'src':          'str',
3788     'dst':          'str',
3789     '*srcport':     'str',
3790     '*dstport':     'str',
3791     '*ipv6':        'bool',
3792     '*udp':         'bool',
3793     '*cookie64':    'bool',
3794     '*counter':     'bool',
3795     '*pincounter':  'bool',
3796     '*txcookie':    'uint64',
3797     '*rxcookie':    'uint64',
3798     'txsession':    'uint32',
3799     '*rxsession':   'uint32',
3800     '*offset':      'uint32' } }
3803 # @NetdevVdeOptions:
3805 # Connect the VLAN to a vde switch running on the host.
3807 # @sock: #optional socket path
3809 # @port: #optional port number
3811 # @group: #optional group owner of socket
3813 # @mode: #optional permissions for socket
3815 # Since: 1.2
3817 { 'struct': 'NetdevVdeOptions',
3818   'data': {
3819     '*sock':  'str',
3820     '*port':  'uint16',
3821     '*group': 'str',
3822     '*mode':  'uint16' } }
3825 # @NetdevDumpOptions:
3827 # Dump VLAN network traffic to a file.
3829 # @len: #optional per-packet size limit (64k default). Understands [TGMKkb]
3830 # suffixes.
3832 # @file: #optional dump file path (default is qemu-vlan0.pcap)
3834 # Since: 1.2
3836 { 'struct': 'NetdevDumpOptions',
3837   'data': {
3838     '*len':  'size',
3839     '*file': 'str' } }
3842 # @NetdevBridgeOptions:
3844 # Connect a host TAP network interface to a host bridge device.
3846 # @br: #optional bridge name
3848 # @helper: #optional command to execute to configure bridge
3850 # Since: 1.2
3852 { 'struct': 'NetdevBridgeOptions',
3853   'data': {
3854     '*br':     'str',
3855     '*helper': 'str' } }
3858 # @NetdevHubPortOptions:
3860 # Connect two or more net clients through a software hub.
3862 # @hubid: hub identifier number
3864 # Since: 1.2
3866 { 'struct': 'NetdevHubPortOptions',
3867   'data': {
3868     'hubid':     'int32' } }
3871 # @NetdevNetmapOptions:
3873 # Connect a client to a netmap-enabled NIC or to a VALE switch port
3875 # @ifname: Either the name of an existing network interface supported by
3876 #          netmap, or the name of a VALE port (created on the fly).
3877 #          A VALE port name is in the form 'valeXXX:YYY', where XXX and
3878 #          YYY are non-negative integers. XXX identifies a switch and
3879 #          YYY identifies a port of the switch. VALE ports having the
3880 #          same XXX are therefore connected to the same switch.
3882 # @devname: #optional path of the netmap device (default: '/dev/netmap').
3884 # Since: 2.0
3886 { 'struct': 'NetdevNetmapOptions',
3887   'data': {
3888     'ifname':     'str',
3889     '*devname':    'str' } }
3892 # @NetdevVhostUserOptions:
3894 # Vhost-user network backend
3896 # @chardev: name of a unix socket chardev
3898 # @vhostforce: #optional vhost on for non-MSIX virtio guests (default: false).
3900 # @queues: #optional number of queues to be created for multiqueue vhost-user
3901 #          (default: 1) (Since 2.5)
3903 # Since: 2.1
3905 { 'struct': 'NetdevVhostUserOptions',
3906   'data': {
3907     'chardev':        'str',
3908     '*vhostforce':    'bool',
3909     '*queues':        'int' } }
3912 # @NetClientDriver:
3914 # Available netdev drivers.
3916 # Since: 2.7
3918 { 'enum': 'NetClientDriver',
3919   'data': [ 'none', 'nic', 'user', 'tap', 'l2tpv3', 'socket', 'vde', 'dump',
3920             'bridge', 'hubport', 'netmap', 'vhost-user' ] }
3923 # @Netdev:
3925 # Captures the configuration of a network device.
3927 # @id: identifier for monitor commands.
3929 # @type: Specify the driver used for interpreting remaining arguments.
3931 # Since: 1.2
3933 # 'l2tpv3' - since 2.1
3935 { 'union': 'Netdev',
3936   'base': { 'id': 'str', 'type': 'NetClientDriver' },
3937   'discriminator': 'type',
3938   'data': {
3939     'none':     'NetdevNoneOptions',
3940     'nic':      'NetLegacyNicOptions',
3941     'user':     'NetdevUserOptions',
3942     'tap':      'NetdevTapOptions',
3943     'l2tpv3':   'NetdevL2TPv3Options',
3944     'socket':   'NetdevSocketOptions',
3945     'vde':      'NetdevVdeOptions',
3946     'dump':     'NetdevDumpOptions',
3947     'bridge':   'NetdevBridgeOptions',
3948     'hubport':  'NetdevHubPortOptions',
3949     'netmap':   'NetdevNetmapOptions',
3950     'vhost-user': 'NetdevVhostUserOptions' } }
3953 # @NetLegacy:
3955 # Captures the configuration of a network device; legacy.
3957 # @vlan: #optional vlan number
3959 # @id: #optional identifier for monitor commands
3961 # @name: #optional identifier for monitor commands, ignored if @id is present
3963 # @opts: device type specific properties (legacy)
3965 # Since: 1.2
3967 { 'struct': 'NetLegacy',
3968   'data': {
3969     '*vlan': 'int32',
3970     '*id':   'str',
3971     '*name': 'str',
3972     'opts':  'NetLegacyOptions' } }
3975 # @NetLegacyOptionsType:
3977 # Since: 1.2
3979 { 'enum': 'NetLegacyOptionsType',
3980   'data': ['none', 'nic', 'user', 'tap', 'l2tpv3', 'socket', 'vde',
3981            'dump', 'bridge', 'netmap', 'vhost-user'] }
3984 # @NetLegacyOptions:
3986 # Like Netdev, but for use only by the legacy command line options
3988 # Since: 1.2
3990 { 'union': 'NetLegacyOptions',
3991   'base': { 'type': 'NetLegacyOptionsType' },
3992   'discriminator': 'type',
3993   'data': {
3994     'none':     'NetdevNoneOptions',
3995     'nic':      'NetLegacyNicOptions',
3996     'user':     'NetdevUserOptions',
3997     'tap':      'NetdevTapOptions',
3998     'l2tpv3':   'NetdevL2TPv3Options',
3999     'socket':   'NetdevSocketOptions',
4000     'vde':      'NetdevVdeOptions',
4001     'dump':     'NetdevDumpOptions',
4002     'bridge':   'NetdevBridgeOptions',
4003     'netmap':   'NetdevNetmapOptions',
4004     'vhost-user': 'NetdevVhostUserOptions' } }
4007 # @NetFilterDirection:
4009 # Indicates whether a netfilter is attached to a netdev's transmit queue or
4010 # receive queue or both.
4012 # @all: the filter is attached both to the receive and the transmit
4013 #       queue of the netdev (default).
4015 # @rx: the filter is attached to the receive queue of the netdev,
4016 #      where it will receive packets sent to the netdev.
4018 # @tx: the filter is attached to the transmit queue of the netdev,
4019 #      where it will receive packets sent by the netdev.
4021 # Since: 2.5
4023 { 'enum': 'NetFilterDirection',
4024   'data': [ 'all', 'rx', 'tx' ] }
4027 # @InetSocketAddress:
4029 # Captures a socket address or address range in the Internet namespace.
4031 # @host: host part of the address
4033 # @port: port part of the address, or lowest port if @to is present
4035 # @numeric: #optional true if the host/port are guaranteed to be numeric,
4036 #           false if name resolution should be attempted. Defaults to false.
4037 #           (Since 2.9)
4039 # @to: highest port to try
4041 # @ipv4: whether to accept IPv4 addresses, default try both IPv4 and IPv6
4042 #        #optional
4044 # @ipv6: whether to accept IPv6 addresses, default try both IPv4 and IPv6
4045 #        #optional
4047 # Since: 1.3
4049 { 'struct': 'InetSocketAddress',
4050   'data': {
4051     'host': 'str',
4052     'port': 'str',
4053     '*numeric':  'bool',
4054     '*to': 'uint16',
4055     '*ipv4': 'bool',
4056     '*ipv6': 'bool' } }
4059 # @UnixSocketAddress:
4061 # Captures a socket address in the local ("Unix socket") namespace.
4063 # @path: filesystem path to use
4065 # Since: 1.3
4067 { 'struct': 'UnixSocketAddress',
4068   'data': {
4069     'path': 'str' } }
4072 # @VsockSocketAddress:
4074 # Captures a socket address in the vsock namespace.
4076 # @cid: unique host identifier
4077 # @port: port
4079 # Note: string types are used to allow for possible future hostname or
4080 # service resolution support.
4082 # Since: 2.8
4084 { 'struct': 'VsockSocketAddress',
4085   'data': {
4086     'cid': 'str',
4087     'port': 'str' } }
4090 # @SocketAddress:
4092 # Captures the address of a socket, which could also be a named file descriptor
4094 # Since: 1.3
4096 { 'union': 'SocketAddress',
4097   'data': {
4098     'inet': 'InetSocketAddress',
4099     'unix': 'UnixSocketAddress',
4100     'vsock': 'VsockSocketAddress',
4101     'fd': 'String' } }
4104 # @getfd:
4106 # Receive a file descriptor via SCM rights and assign it a name
4108 # @fdname: file descriptor name
4110 # Returns: Nothing on success
4112 # Since: 0.14.0
4114 # Notes: If @fdname already exists, the file descriptor assigned to
4115 #        it will be closed and replaced by the received file
4116 #        descriptor.
4118 #        The 'closefd' command can be used to explicitly close the
4119 #        file descriptor when it is no longer needed.
4121 # Example:
4123 # -> { "execute": "getfd", "arguments": { "fdname": "fd1" } }
4124 # <- { "return": {} }
4127 { 'command': 'getfd', 'data': {'fdname': 'str'} }
4130 # @closefd:
4132 # Close a file descriptor previously passed via SCM rights
4134 # @fdname: file descriptor name
4136 # Returns: Nothing on success
4138 # Since: 0.14.0
4140 # Example:
4142 # -> { "execute": "closefd", "arguments": { "fdname": "fd1" } }
4143 # <- { "return": {} }
4146 { 'command': 'closefd', 'data': {'fdname': 'str'} }
4149 # @MachineInfo:
4151 # Information describing a machine.
4153 # @name: the name of the machine
4155 # @alias: #optional an alias for the machine name
4157 # @is-default: #optional whether the machine is default
4159 # @cpu-max: maximum number of CPUs supported by the machine type
4160 #           (since 1.5.0)
4162 # @hotpluggable-cpus: cpu hotplug via -device is supported (since 2.7.0)
4164 # Since: 1.2.0
4166 { 'struct': 'MachineInfo',
4167   'data': { 'name': 'str', '*alias': 'str',
4168             '*is-default': 'bool', 'cpu-max': 'int',
4169             'hotpluggable-cpus': 'bool'} }
4172 # @query-machines:
4174 # Return a list of supported machines
4176 # Returns: a list of MachineInfo
4178 # Since: 1.2.0
4180 { 'command': 'query-machines', 'returns': ['MachineInfo'] }
4183 # @CpuDefinitionInfo:
4185 # Virtual CPU definition.
4187 # @name: the name of the CPU definition
4189 # @migration-safe: #optional whether a CPU definition can be safely used for
4190 #                  migration in combination with a QEMU compatibility machine
4191 #                  when migrating between different QMU versions and between
4192 #                  hosts with different sets of (hardware or software)
4193 #                  capabilities. If not provided, information is not available
4194 #                  and callers should not assume the CPU definition to be
4195 #                  migration-safe. (since 2.8)
4197 # @static: whether a CPU definition is static and will not change depending on
4198 #          QEMU version, machine type, machine options and accelerator options.
4199 #          A static model is always migration-safe. (since 2.8)
4201 # @unavailable-features: #optional List of properties that prevent
4202 #                        the CPU model from running in the current
4203 #                        host. (since 2.8)
4204 # @typename: Type name that can be used as argument to @device-list-properties,
4205 #            to introspect properties configurable using -cpu or -global.
4206 #            (since 2.9)
4208 # @unavailable-features is a list of QOM property names that
4209 # represent CPU model attributes that prevent the CPU from running.
4210 # If the QOM property is read-only, that means there's no known
4211 # way to make the CPU model run in the current host. Implementations
4212 # that choose not to provide specific information return the
4213 # property name "type".
4214 # If the property is read-write, it means that it MAY be possible
4215 # to run the CPU model in the current host if that property is
4216 # changed. Management software can use it as hints to suggest or
4217 # choose an alternative for the user, or just to generate meaningful
4218 # error messages explaining why the CPU model can't be used.
4219 # If @unavailable-features is an empty list, the CPU model is
4220 # runnable using the current host and machine-type.
4221 # If @unavailable-features is not present, runnability
4222 # information for the CPU is not available.
4224 # Since: 1.2.0
4226 { 'struct': 'CpuDefinitionInfo',
4227   'data': { 'name': 'str', '*migration-safe': 'bool', 'static': 'bool',
4228             '*unavailable-features': [ 'str' ], 'typename': 'str' } }
4231 # @query-cpu-definitions:
4233 # Return a list of supported virtual CPU definitions
4235 # Returns: a list of CpuDefInfo
4237 # Since: 1.2.0
4239 { 'command': 'query-cpu-definitions', 'returns': ['CpuDefinitionInfo'] }
4242 # @CpuModelInfo:
4244 # Virtual CPU model.
4246 # A CPU model consists of the name of a CPU definition, to which
4247 # delta changes are applied (e.g. features added/removed). Most magic values
4248 # that an architecture might require should be hidden behind the name.
4249 # However, if required, architectures can expose relevant properties.
4251 # @name: the name of the CPU definition the model is based on
4252 # @props: #optional a dictionary of QOM properties to be applied
4254 # Since: 2.8.0
4256 { 'struct': 'CpuModelInfo',
4257   'data': { 'name': 'str',
4258             '*props': 'any' } }
4261 # @CpuModelExpansionType:
4263 # An enumeration of CPU model expansion types.
4265 # @static: Expand to a static CPU model, a combination of a static base
4266 #          model name and property delta changes. As the static base model will
4267 #          never change, the expanded CPU model will be the same, independant of
4268 #          independent of QEMU version, machine type, machine options, and
4269 #          accelerator options. Therefore, the resulting model can be used by
4270 #          tooling without having to specify a compatibility machine - e.g. when
4271 #          displaying the "host" model. static CPU models are migration-safe.
4273 # @full: Expand all properties. The produced model is not guaranteed to be
4274 #        migration-safe, but allows tooling to get an insight and work with
4275 #        model details.
4277 # Note: When a non-migration-safe CPU model is expanded in static mode, some
4278 # features enabled by the CPU model may be omitted, because they can't be
4279 # implemented by a static CPU model definition (e.g. cache info passthrough and
4280 # PMU passthrough in x86). If you need an accurate representation of the
4281 # features enabled by a non-migration-safe CPU model, use @full. If you need a
4282 # static representation that will keep ABI compatibility even when changing QEMU
4283 # version or machine-type, use @static (but keep in mind that some features may
4284 # be omitted).
4286 # Since: 2.8.0
4288 { 'enum': 'CpuModelExpansionType',
4289   'data': [ 'static', 'full' ] }
4293 # @CpuModelExpansionInfo:
4295 # The result of a cpu model expansion.
4297 # @model: the expanded CpuModelInfo.
4299 # Since: 2.8.0
4301 { 'struct': 'CpuModelExpansionInfo',
4302   'data': { 'model': 'CpuModelInfo' } }
4306 # @query-cpu-model-expansion:
4308 # Expands a given CPU model (or a combination of CPU model + additional options)
4309 # to different granularities, allowing tooling to get an understanding what a
4310 # specific CPU model looks like in QEMU under a certain configuration.
4312 # This interface can be used to query the "host" CPU model.
4314 # The data returned by this command may be affected by:
4316 # * QEMU version: CPU models may look different depending on the QEMU version.
4317 #   (Except for CPU models reported as "static" in query-cpu-definitions.)
4318 # * machine-type: CPU model  may look different depending on the machine-type.
4319 #   (Except for CPU models reported as "static" in query-cpu-definitions.)
4320 # * machine options (including accelerator): in some architectures, CPU models
4321 #   may look different depending on machine and accelerator options. (Except for
4322 #   CPU models reported as "static" in query-cpu-definitions.)
4323 # * "-cpu" arguments and global properties: arguments to the -cpu option and
4324 #   global properties may affect expansion of CPU models. Using
4325 #   query-cpu-model-expansion while using these is not advised.
4327 # Some architectures may not support all expansion types. s390x supports
4328 # "full" and "static".
4330 # Returns: a CpuModelExpansionInfo. Returns an error if expanding CPU models is
4331 #          not supported, if the model cannot be expanded, if the model contains
4332 #          an unknown CPU definition name, unknown properties or properties
4333 #          with a wrong type. Also returns an error if an expansion type is
4334 #          not supported.
4336 # Since: 2.8.0
4338 { 'command': 'query-cpu-model-expansion',
4339   'data': { 'type': 'CpuModelExpansionType',
4340             'model': 'CpuModelInfo' },
4341   'returns': 'CpuModelExpansionInfo' }
4344 # @CpuModelCompareResult:
4346 # An enumeration of CPU model comparation results. The result is usually
4347 # calculated using e.g. CPU features or CPU generations.
4349 # @incompatible: If model A is incompatible to model B, model A is not
4350 #                guaranteed to run where model B runs and the other way around.
4352 # @identical: If model A is identical to model B, model A is guaranteed to run
4353 #             where model B runs and the other way around.
4355 # @superset: If model A is a superset of model B, model B is guaranteed to run
4356 #            where model A runs. There are no guarantees about the other way.
4358 # @subset: If model A is a subset of model B, model A is guaranteed to run
4359 #          where model B runs. There are no guarantees about the other way.
4361 # Since: 2.8.0
4363 { 'enum': 'CpuModelCompareResult',
4364   'data': [ 'incompatible', 'identical', 'superset', 'subset' ] }
4367 # @CpuModelCompareInfo:
4369 # The result of a CPU model comparison.
4371 # @result: The result of the compare operation.
4372 # @responsible-properties: List of properties that led to the comparison result
4373 #                          not being identical.
4375 # @responsible-properties is a list of QOM property names that led to
4376 # both CPUs not being detected as identical. For identical models, this
4377 # list is empty.
4378 # If a QOM property is read-only, that means there's no known way to make the
4379 # CPU models identical. If the special property name "type" is included, the
4380 # models are by definition not identical and cannot be made identical.
4382 # Since: 2.8.0
4384 { 'struct': 'CpuModelCompareInfo',
4385   'data': {'result': 'CpuModelCompareResult',
4386            'responsible-properties': ['str']
4387           }
4391 # @query-cpu-model-comparison:
4393 # Compares two CPU models, returning how they compare in a specific
4394 # configuration. The results indicates how both models compare regarding
4395 # runnability. This result can be used by tooling to make decisions if a
4396 # certain CPU model will run in a certain configuration or if a compatible
4397 # CPU model has to be created by baselining.
4399 # Usually, a CPU model is compared against the maximum possible CPU model
4400 # of a certain configuration (e.g. the "host" model for KVM). If that CPU
4401 # model is identical or a subset, it will run in that configuration.
4403 # The result returned by this command may be affected by:
4405 # * QEMU version: CPU models may look different depending on the QEMU version.
4406 #   (Except for CPU models reported as "static" in query-cpu-definitions.)
4407 # * machine-type: CPU model may look different depending on the machine-type.
4408 #   (Except for CPU models reported as "static" in query-cpu-definitions.)
4409 # * machine options (including accelerator): in some architectures, CPU models
4410 #   may look different depending on machine and accelerator options. (Except for
4411 #   CPU models reported as "static" in query-cpu-definitions.)
4412 # * "-cpu" arguments and global properties: arguments to the -cpu option and
4413 #   global properties may affect expansion of CPU models. Using
4414 #   query-cpu-model-expansion while using these is not advised.
4416 # Some architectures may not support comparing CPU models. s390x supports
4417 # comparing CPU models.
4419 # Returns: a CpuModelBaselineInfo. Returns an error if comparing CPU models is
4420 #          not supported, if a model cannot be used, if a model contains
4421 #          an unknown cpu definition name, unknown properties or properties
4422 #          with wrong types.
4424 # Since: 2.8.0
4426 { 'command': 'query-cpu-model-comparison',
4427   'data': { 'modela': 'CpuModelInfo', 'modelb': 'CpuModelInfo' },
4428   'returns': 'CpuModelCompareInfo' }
4431 # @CpuModelBaselineInfo:
4433 # The result of a CPU model baseline.
4435 # @model: the baselined CpuModelInfo.
4437 # Since: 2.8.0
4439 { 'struct': 'CpuModelBaselineInfo',
4440   'data': { 'model': 'CpuModelInfo' } }
4443 # @query-cpu-model-baseline:
4445 # Baseline two CPU models, creating a compatible third model. The created
4446 # model will always be a static, migration-safe CPU model (see "static"
4447 # CPU model expansion for details).
4449 # This interface can be used by tooling to create a compatible CPU model out
4450 # two CPU models. The created CPU model will be identical to or a subset of
4451 # both CPU models when comparing them. Therefore, the created CPU model is
4452 # guaranteed to run where the given CPU models run.
4454 # The result returned by this command may be affected by:
4456 # * QEMU version: CPU models may look different depending on the QEMU version.
4457 #   (Except for CPU models reported as "static" in query-cpu-definitions.)
4458 # * machine-type: CPU model may look different depending on the machine-type.
4459 #   (Except for CPU models reported as "static" in query-cpu-definitions.)
4460 # * machine options (including accelerator): in some architectures, CPU models
4461 #   may look different depending on machine and accelerator options. (Except for
4462 #   CPU models reported as "static" in query-cpu-definitions.)
4463 # * "-cpu" arguments and global properties: arguments to the -cpu option and
4464 #   global properties may affect expansion of CPU models. Using
4465 #   query-cpu-model-expansion while using these is not advised.
4467 # Some architectures may not support baselining CPU models. s390x supports
4468 # baselining CPU models.
4470 # Returns: a CpuModelBaselineInfo. Returns an error if baselining CPU models is
4471 #          not supported, if a model cannot be used, if a model contains
4472 #          an unknown cpu definition name, unknown properties or properties
4473 #          with wrong types.
4475 # Since: 2.8.0
4477 { 'command': 'query-cpu-model-baseline',
4478   'data': { 'modela': 'CpuModelInfo',
4479             'modelb': 'CpuModelInfo' },
4480   'returns': 'CpuModelBaselineInfo' }
4483 # @AddfdInfo:
4485 # Information about a file descriptor that was added to an fd set.
4487 # @fdset-id: The ID of the fd set that @fd was added to.
4489 # @fd: The file descriptor that was received via SCM rights and
4490 #      added to the fd set.
4492 # Since: 1.2.0
4494 { 'struct': 'AddfdInfo', 'data': {'fdset-id': 'int', 'fd': 'int'} }
4497 # @add-fd:
4499 # Add a file descriptor, that was passed via SCM rights, to an fd set.
4501 # @fdset-id: #optional The ID of the fd set to add the file descriptor to.
4503 # @opaque: #optional A free-form string that can be used to describe the fd.
4505 # Returns: @AddfdInfo on success
4507 #          If file descriptor was not received, FdNotSupplied
4509 #          If @fdset-id is a negative value, InvalidParameterValue
4511 # Notes: The list of fd sets is shared by all monitor connections.
4513 #        If @fdset-id is not specified, a new fd set will be created.
4515 # Since: 1.2.0
4517 # Example:
4519 # -> { "execute": "add-fd", "arguments": { "fdset-id": 1 } }
4520 # <- { "return": { "fdset-id": 1, "fd": 3 } }
4523 { 'command': 'add-fd', 'data': {'*fdset-id': 'int', '*opaque': 'str'},
4524   'returns': 'AddfdInfo' }
4527 # @remove-fd:
4529 # Remove a file descriptor from an fd set.
4531 # @fdset-id: The ID of the fd set that the file descriptor belongs to.
4533 # @fd: #optional The file descriptor that is to be removed.
4535 # Returns: Nothing on success
4536 #          If @fdset-id or @fd is not found, FdNotFound
4538 # Since: 1.2.0
4540 # Notes: The list of fd sets is shared by all monitor connections.
4542 #        If @fd is not specified, all file descriptors in @fdset-id
4543 #        will be removed.
4545 # Example:
4547 # -> { "execute": "remove-fd", "arguments": { "fdset-id": 1, "fd": 3 } }
4548 # <- { "return": {} }
4551 { 'command': 'remove-fd', 'data': {'fdset-id': 'int', '*fd': 'int'} }
4554 # @FdsetFdInfo:
4556 # Information about a file descriptor that belongs to an fd set.
4558 # @fd: The file descriptor value.
4560 # @opaque: #optional A free-form string that can be used to describe the fd.
4562 # Since: 1.2.0
4564 { 'struct': 'FdsetFdInfo',
4565   'data': {'fd': 'int', '*opaque': 'str'} }
4568 # @FdsetInfo:
4570 # Information about an fd set.
4572 # @fdset-id: The ID of the fd set.
4574 # @fds: A list of file descriptors that belong to this fd set.
4576 # Since: 1.2.0
4578 { 'struct': 'FdsetInfo',
4579   'data': {'fdset-id': 'int', 'fds': ['FdsetFdInfo']} }
4582 # @query-fdsets:
4584 # Return information describing all fd sets.
4586 # Returns: A list of @FdsetInfo
4588 # Since: 1.2.0
4590 # Note: The list of fd sets is shared by all monitor connections.
4592 # Example:
4594 # -> { "execute": "query-fdsets" }
4595 # <- { "return": [
4596 #        {
4597 #          "fds": [
4598 #            {
4599 #              "fd": 30,
4600 #              "opaque": "rdonly:/path/to/file"
4601 #            },
4602 #            {
4603 #              "fd": 24,
4604 #              "opaque": "rdwr:/path/to/file"
4605 #            }
4606 #          ],
4607 #          "fdset-id": 1
4608 #        },
4609 #        {
4610 #          "fds": [
4611 #            {
4612 #              "fd": 28
4613 #            },
4614 #            {
4615 #              "fd": 29
4616 #            }
4617 #          ],
4618 #          "fdset-id": 0
4619 #        }
4620 #      ]
4621 #    }
4624 { 'command': 'query-fdsets', 'returns': ['FdsetInfo'] }
4627 # @TargetInfo:
4629 # Information describing the QEMU target.
4631 # @arch: the target architecture (eg "x86_64", "i386", etc)
4633 # Since: 1.2.0
4635 { 'struct': 'TargetInfo',
4636   'data': { 'arch': 'str' } }
4639 # @query-target:
4641 # Return information about the target for this QEMU
4643 # Returns: TargetInfo
4645 # Since: 1.2.0
4647 { 'command': 'query-target', 'returns': 'TargetInfo' }
4650 # @QKeyCode:
4652 # An enumeration of key name.
4654 # This is used by the @send-key command.
4656 # @unmapped: since 2.0
4657 # @pause: since 2.0
4658 # @ro: since 2.4
4659 # @kp_comma: since 2.4
4660 # @kp_equals: since 2.6
4661 # @power: since 2.6
4662 # @hiragana: since 2.9
4663 # @henkan: since 2.9
4664 # @yen: since 2.9
4666 # Since: 1.3.0
4669 { 'enum': 'QKeyCode',
4670   'data': [ 'unmapped',
4671             'shift', 'shift_r', 'alt', 'alt_r', 'altgr', 'altgr_r', 'ctrl',
4672             'ctrl_r', 'menu', 'esc', '1', '2', '3', '4', '5', '6', '7', '8',
4673             '9', '0', 'minus', 'equal', 'backspace', 'tab', 'q', 'w', 'e',
4674             'r', 't', 'y', 'u', 'i', 'o', 'p', 'bracket_left', 'bracket_right',
4675             'ret', 'a', 's', 'd', 'f', 'g', 'h', 'j', 'k', 'l', 'semicolon',
4676             'apostrophe', 'grave_accent', 'backslash', 'z', 'x', 'c', 'v', 'b',
4677             'n', 'm', 'comma', 'dot', 'slash', 'asterisk', 'spc', 'caps_lock',
4678             'f1', 'f2', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9', 'f10',
4679             'num_lock', 'scroll_lock', 'kp_divide', 'kp_multiply',
4680             'kp_subtract', 'kp_add', 'kp_enter', 'kp_decimal', 'sysrq', 'kp_0',
4681             'kp_1', 'kp_2', 'kp_3', 'kp_4', 'kp_5', 'kp_6', 'kp_7', 'kp_8',
4682             'kp_9', 'less', 'f11', 'f12', 'print', 'home', 'pgup', 'pgdn', 'end',
4683             'left', 'up', 'down', 'right', 'insert', 'delete', 'stop', 'again',
4684             'props', 'undo', 'front', 'copy', 'open', 'paste', 'find', 'cut',
4685             'lf', 'help', 'meta_l', 'meta_r', 'compose', 'pause',
4686             'ro', 'hiragana', 'henkan', 'yen',
4687             'kp_comma', 'kp_equals', 'power' ] }
4690 # @KeyValue:
4692 # Represents a keyboard key.
4694 # Since: 1.3.0
4696 { 'union': 'KeyValue',
4697   'data': {
4698     'number': 'int',
4699     'qcode': 'QKeyCode' } }
4702 # @send-key:
4704 # Send keys to guest.
4706 # @keys: An array of @KeyValue elements. All @KeyValues in this array are
4707 #        simultaneously sent to the guest. A @KeyValue.number value is sent
4708 #        directly to the guest, while @KeyValue.qcode must be a valid
4709 #        @QKeyCode value
4711 # @hold-time: #optional time to delay key up events, milliseconds. Defaults
4712 #             to 100
4714 # Returns: Nothing on success
4715 #          If key is unknown or redundant, InvalidParameter
4717 # Since: 1.3.0
4719 # Example:
4721 # -> { "execute": "send-key",
4722 #      "arguments": { "keys": [ { "type": "qcode", "data": "ctrl" },
4723 #                               { "type": "qcode", "data": "alt" },
4724 #                               { "type": "qcode", "data": "delete" } ] } }
4725 # <- { "return": {} }
4728 { 'command': 'send-key',
4729   'data': { 'keys': ['KeyValue'], '*hold-time': 'int' } }
4732 # @screendump:
4734 # Write a PPM of the VGA screen to a file.
4736 # @filename: the path of a new PPM file to store the image
4738 # Returns: Nothing on success
4740 # Since: 0.14.0
4742 # Example:
4744 # -> { "execute": "screendump",
4745 #      "arguments": { "filename": "/tmp/image" } }
4746 # <- { "return": {} }
4749 { 'command': 'screendump', 'data': {'filename': 'str'} }
4753 # @ChardevCommon:
4755 # Configuration shared across all chardev backends
4757 # @logfile: #optional The name of a logfile to save output
4758 # @logappend: #optional true to append instead of truncate
4759 #             (default to false to truncate)
4761 # Since: 2.6
4763 { 'struct': 'ChardevCommon', 'data': { '*logfile': 'str',
4764                                        '*logappend': 'bool' } }
4767 # @ChardevFile:
4769 # Configuration info for file chardevs.
4771 # @in:  #optional The name of the input file
4772 # @out: The name of the output file
4773 # @append: #optional Open the file in append mode (default false to
4774 #          truncate) (Since 2.6)
4776 # Since: 1.4
4778 { 'struct': 'ChardevFile', 'data': { '*in' : 'str',
4779                                    'out' : 'str',
4780                                    '*append': 'bool' },
4781   'base': 'ChardevCommon' }
4784 # @ChardevHostdev:
4786 # Configuration info for device and pipe chardevs.
4788 # @device: The name of the special file for the device,
4789 #          i.e. /dev/ttyS0 on Unix or COM1: on Windows
4791 # Since: 1.4
4793 { 'struct': 'ChardevHostdev', 'data': { 'device' : 'str' },
4794   'base': 'ChardevCommon' }
4797 # @ChardevSocket:
4799 # Configuration info for (stream) socket chardevs.
4801 # @addr: socket address to listen on (server=true)
4802 #        or connect to (server=false)
4803 # @tls-creds: #optional the ID of the TLS credentials object (since 2.6)
4804 # @server: #optional create server socket (default: true)
4805 # @wait: #optional wait for incoming connection on server
4806 #        sockets (default: false).
4807 # @nodelay: #optional set TCP_NODELAY socket option (default: false)
4808 # @telnet: #optional enable telnet protocol on server
4809 #          sockets (default: false)
4810 # @reconnect: #optional For a client socket, if a socket is disconnected,
4811 #          then attempt a reconnect after the given number of seconds.
4812 #          Setting this to zero disables this function. (default: 0)
4813 #          (Since: 2.2)
4815 # Since: 1.4
4817 { 'struct': 'ChardevSocket', 'data': { 'addr'       : 'SocketAddress',
4818                                      '*tls-creds'  : 'str',
4819                                      '*server'    : 'bool',
4820                                      '*wait'      : 'bool',
4821                                      '*nodelay'   : 'bool',
4822                                      '*telnet'    : 'bool',
4823                                      '*reconnect' : 'int' },
4824   'base': 'ChardevCommon' }
4827 # @ChardevUdp:
4829 # Configuration info for datagram socket chardevs.
4831 # @remote: remote address
4832 # @local: #optional local address
4834 # Since: 1.5
4836 { 'struct': 'ChardevUdp', 'data': { 'remote' : 'SocketAddress',
4837                                   '*local' : 'SocketAddress' },
4838   'base': 'ChardevCommon' }
4841 # @ChardevMux:
4843 # Configuration info for mux chardevs.
4845 # @chardev: name of the base chardev.
4847 # Since: 1.5
4849 { 'struct': 'ChardevMux', 'data': { 'chardev' : 'str' },
4850   'base': 'ChardevCommon' }
4853 # @ChardevStdio:
4855 # Configuration info for stdio chardevs.
4857 # @signal: #optional Allow signals (such as SIGINT triggered by ^C)
4858 #          be delivered to qemu.  Default: true in -nographic mode,
4859 #          false otherwise.
4861 # Since: 1.5
4863 { 'struct': 'ChardevStdio', 'data': { '*signal' : 'bool' },
4864   'base': 'ChardevCommon' }
4868 # @ChardevSpiceChannel:
4870 # Configuration info for spice vm channel chardevs.
4872 # @type: kind of channel (for example vdagent).
4874 # Since: 1.5
4876 { 'struct': 'ChardevSpiceChannel', 'data': { 'type'  : 'str' },
4877   'base': 'ChardevCommon' }
4880 # @ChardevSpicePort:
4882 # Configuration info for spice port chardevs.
4884 # @fqdn: name of the channel (see docs/spice-port-fqdn.txt)
4886 # Since: 1.5
4888 { 'struct': 'ChardevSpicePort', 'data': { 'fqdn'  : 'str' },
4889   'base': 'ChardevCommon' }
4892 # @ChardevVC:
4894 # Configuration info for virtual console chardevs.
4896 # @width:  console width,  in pixels
4897 # @height: console height, in pixels
4898 # @cols:   console width,  in chars
4899 # @rows:   console height, in chars
4901 # Since: 1.5
4903 { 'struct': 'ChardevVC', 'data': { '*width'  : 'int',
4904                                  '*height' : 'int',
4905                                  '*cols'   : 'int',
4906                                  '*rows'   : 'int' },
4907   'base': 'ChardevCommon' }
4910 # @ChardevRingbuf:
4912 # Configuration info for ring buffer chardevs.
4914 # @size: #optional ring buffer size, must be power of two, default is 65536
4916 # Since: 1.5
4918 { 'struct': 'ChardevRingbuf', 'data': { '*size'  : 'int' },
4919   'base': 'ChardevCommon' }
4922 # @ChardevBackend:
4924 # Configuration info for the new chardev backend.
4926 # Since: 1.4 (testdev since 2.2, wctablet since 2.9)
4928 { 'union': 'ChardevBackend', 'data': { 'file'   : 'ChardevFile',
4929                                        'serial' : 'ChardevHostdev',
4930                                        'parallel': 'ChardevHostdev',
4931                                        'pipe'   : 'ChardevHostdev',
4932                                        'socket' : 'ChardevSocket',
4933                                        'udp'    : 'ChardevUdp',
4934                                        'pty'    : 'ChardevCommon',
4935                                        'null'   : 'ChardevCommon',
4936                                        'mux'    : 'ChardevMux',
4937                                        'msmouse': 'ChardevCommon',
4938                                        'wctablet' : 'ChardevCommon',
4939                                        'braille': 'ChardevCommon',
4940                                        'testdev': 'ChardevCommon',
4941                                        'stdio'  : 'ChardevStdio',
4942                                        'console': 'ChardevCommon',
4943                                        'spicevmc' : 'ChardevSpiceChannel',
4944                                        'spiceport' : 'ChardevSpicePort',
4945                                        'vc'     : 'ChardevVC',
4946                                        'ringbuf': 'ChardevRingbuf',
4947                                        # next one is just for compatibility
4948                                        'memory' : 'ChardevRingbuf' } }
4951 # @ChardevReturn:
4953 # Return info about the chardev backend just created.
4955 # @pty: #optional name of the slave pseudoterminal device, present if
4956 #       and only if a chardev of type 'pty' was created
4958 # Since: 1.4
4960 { 'struct' : 'ChardevReturn', 'data': { '*pty' : 'str' } }
4963 # @chardev-add:
4965 # Add a character device backend
4967 # @id: the chardev's ID, must be unique
4968 # @backend: backend type and parameters
4970 # Returns: ChardevReturn.
4972 # Since: 1.4
4974 # Example:
4976 # -> { "execute" : "chardev-add",
4977 #      "arguments" : { "id" : "foo",
4978 #                      "backend" : { "type" : "null", "data" : {} } } }
4979 # <- { "return": {} }
4981 # -> { "execute" : "chardev-add",
4982 #      "arguments" : { "id" : "bar",
4983 #                      "backend" : { "type" : "file",
4984 #                                    "data" : { "out" : "/tmp/bar.log" } } } }
4985 # <- { "return": {} }
4987 # -> { "execute" : "chardev-add",
4988 #      "arguments" : { "id" : "baz",
4989 #                      "backend" : { "type" : "pty", "data" : {} } } }
4990 # <- { "return": { "pty" : "/dev/pty/42" } }
4993 { 'command': 'chardev-add', 'data': {'id'      : 'str',
4994                                      'backend' : 'ChardevBackend' },
4995   'returns': 'ChardevReturn' }
4998 # @chardev-remove:
5000 # Remove a character device backend
5002 # @id: the chardev's ID, must exist and not be in use
5004 # Returns: Nothing on success
5006 # Since: 1.4
5008 # Example:
5010 # -> { "execute": "chardev-remove", "arguments": { "id" : "foo" } }
5011 # <- { "return": {} }
5014 { 'command': 'chardev-remove', 'data': {'id': 'str'} }
5017 # @TpmModel:
5019 # An enumeration of TPM models
5021 # @tpm-tis: TPM TIS model
5023 # Since: 1.5
5025 { 'enum': 'TpmModel', 'data': [ 'tpm-tis' ] }
5028 # @query-tpm-models:
5030 # Return a list of supported TPM models
5032 # Returns: a list of TpmModel
5034 # Since: 1.5
5036 # Example:
5038 # -> { "execute": "query-tpm-models" }
5039 # <- { "return": [ "tpm-tis" ] }
5042 { 'command': 'query-tpm-models', 'returns': ['TpmModel'] }
5045 # @TpmType:
5047 # An enumeration of TPM types
5049 # @passthrough: TPM passthrough type
5051 # Since: 1.5
5053 { 'enum': 'TpmType', 'data': [ 'passthrough' ] }
5056 # @query-tpm-types:
5058 # Return a list of supported TPM types
5060 # Returns: a list of TpmType
5062 # Since: 1.5
5064 # Example:
5066 # -> { "execute": "query-tpm-types" }
5067 # <- { "return": [ "passthrough" ] }
5070 { 'command': 'query-tpm-types', 'returns': ['TpmType'] }
5073 # @TPMPassthroughOptions:
5075 # Information about the TPM passthrough type
5077 # @path: #optional string describing the path used for accessing the TPM device
5079 # @cancel-path: #optional string showing the TPM's sysfs cancel file
5080 #               for cancellation of TPM commands while they are executing
5082 # Since: 1.5
5084 { 'struct': 'TPMPassthroughOptions', 'data': { '*path' : 'str',
5085                                              '*cancel-path' : 'str'} }
5088 # @TpmTypeOptions:
5090 # A union referencing different TPM backend types' configuration options
5092 # @type: 'passthrough' The configuration options for the TPM passthrough type
5094 # Since: 1.5
5096 { 'union': 'TpmTypeOptions',
5097    'data': { 'passthrough' : 'TPMPassthroughOptions' } }
5100 # @TPMInfo:
5102 # Information about the TPM
5104 # @id: The Id of the TPM
5106 # @model: The TPM frontend model
5108 # @options: The TPM (backend) type configuration options
5110 # Since: 1.5
5112 { 'struct': 'TPMInfo',
5113   'data': {'id': 'str',
5114            'model': 'TpmModel',
5115            'options': 'TpmTypeOptions' } }
5118 # @query-tpm:
5120 # Return information about the TPM device
5122 # Returns: @TPMInfo on success
5124 # Since: 1.5
5126 # Example:
5128 # -> { "execute": "query-tpm" }
5129 # <- { "return":
5130 #      [
5131 #        { "model": "tpm-tis",
5132 #          "options":
5133 #            { "type": "passthrough",
5134 #              "data":
5135 #                { "cancel-path": "/sys/class/misc/tpm0/device/cancel",
5136 #                  "path": "/dev/tpm0"
5137 #                }
5138 #            },
5139 #          "id": "tpm0"
5140 #        }
5141 #      ]
5142 #    }
5145 { 'command': 'query-tpm', 'returns': ['TPMInfo'] }
5148 # @AcpiTableOptions:
5150 # Specify an ACPI table on the command line to load.
5152 # At most one of @file and @data can be specified. The list of files specified
5153 # by any one of them is loaded and concatenated in order. If both are omitted,
5154 # @data is implied.
5156 # Other fields / optargs can be used to override fields of the generic ACPI
5157 # table header; refer to the ACPI specification 5.0, section 5.2.6 System
5158 # Description Table Header. If a header field is not overridden, then the
5159 # corresponding value from the concatenated blob is used (in case of @file), or
5160 # it is filled in with a hard-coded value (in case of @data).
5162 # String fields are copied into the matching ACPI member from lowest address
5163 # upwards, and silently truncated / NUL-padded to length.
5165 # @sig: #optional table signature / identifier (4 bytes)
5167 # @rev: #optional table revision number (dependent on signature, 1 byte)
5169 # @oem_id: #optional OEM identifier (6 bytes)
5171 # @oem_table_id: #optional OEM table identifier (8 bytes)
5173 # @oem_rev: #optional OEM-supplied revision number (4 bytes)
5175 # @asl_compiler_id: #optional identifier of the utility that created the table
5176 #                   (4 bytes)
5178 # @asl_compiler_rev: #optional revision number of the utility that created the
5179 #                    table (4 bytes)
5181 # @file: #optional colon (:) separated list of pathnames to load and
5182 #        concatenate as table data. The resultant binary blob is expected to
5183 #        have an ACPI table header. At least one file is required. This field
5184 #        excludes @data.
5186 # @data: #optional colon (:) separated list of pathnames to load and
5187 #        concatenate as table data. The resultant binary blob must not have an
5188 #        ACPI table header. At least one file is required. This field excludes
5189 #        @file.
5191 # Since: 1.5
5193 { 'struct': 'AcpiTableOptions',
5194   'data': {
5195     '*sig':               'str',
5196     '*rev':               'uint8',
5197     '*oem_id':            'str',
5198     '*oem_table_id':      'str',
5199     '*oem_rev':           'uint32',
5200     '*asl_compiler_id':   'str',
5201     '*asl_compiler_rev':  'uint32',
5202     '*file':              'str',
5203     '*data':              'str' }}
5206 # @CommandLineParameterType:
5208 # Possible types for an option parameter.
5210 # @string: accepts a character string
5212 # @boolean: accepts "on" or "off"
5214 # @number: accepts a number
5216 # @size: accepts a number followed by an optional suffix (K)ilo,
5217 #        (M)ega, (G)iga, (T)era
5219 # Since: 1.5
5221 { 'enum': 'CommandLineParameterType',
5222   'data': ['string', 'boolean', 'number', 'size'] }
5225 # @CommandLineParameterInfo:
5227 # Details about a single parameter of a command line option.
5229 # @name: parameter name
5231 # @type: parameter @CommandLineParameterType
5233 # @help: #optional human readable text string, not suitable for parsing.
5235 # @default: #optional default value string (since 2.1)
5237 # Since: 1.5
5239 { 'struct': 'CommandLineParameterInfo',
5240   'data': { 'name': 'str',
5241             'type': 'CommandLineParameterType',
5242             '*help': 'str',
5243             '*default': 'str' } }
5246 # @CommandLineOptionInfo:
5248 # Details about a command line option, including its list of parameter details
5250 # @option: option name
5252 # @parameters: an array of @CommandLineParameterInfo
5254 # Since: 1.5
5256 { 'struct': 'CommandLineOptionInfo',
5257   'data': { 'option': 'str', 'parameters': ['CommandLineParameterInfo'] } }
5260 # @query-command-line-options:
5262 # Query command line option schema.
5264 # @option: #optional option name
5266 # Returns: list of @CommandLineOptionInfo for all options (or for the given
5267 #          @option).  Returns an error if the given @option doesn't exist.
5269 # Since: 1.5
5271 # Example:
5273 # -> { "execute": "query-command-line-options",
5274 #      "arguments": { "option": "option-rom" } }
5275 # <- { "return": [
5276 #         {
5277 #             "parameters": [
5278 #                 {
5279 #                     "name": "romfile",
5280 #                     "type": "string"
5281 #                 },
5282 #                 {
5283 #                     "name": "bootindex",
5284 #                     "type": "number"
5285 #                 }
5286 #             ],
5287 #             "option": "option-rom"
5288 #         }
5289 #      ]
5290 #    }
5293 {'command': 'query-command-line-options', 'data': { '*option': 'str' },
5294  'returns': ['CommandLineOptionInfo'] }
5297 # @X86CPURegister32:
5299 # A X86 32-bit register
5301 # Since: 1.5
5303 { 'enum': 'X86CPURegister32',
5304   'data': [ 'EAX', 'EBX', 'ECX', 'EDX', 'ESP', 'EBP', 'ESI', 'EDI' ] }
5307 # @X86CPUFeatureWordInfo:
5309 # Information about a X86 CPU feature word
5311 # @cpuid-input-eax: Input EAX value for CPUID instruction for that feature word
5313 # @cpuid-input-ecx: #optional Input ECX value for CPUID instruction for that
5314 #                   feature word
5316 # @cpuid-register: Output register containing the feature bits
5318 # @features: value of output register, containing the feature bits
5320 # Since: 1.5
5322 { 'struct': 'X86CPUFeatureWordInfo',
5323   'data': { 'cpuid-input-eax': 'int',
5324             '*cpuid-input-ecx': 'int',
5325             'cpuid-register': 'X86CPURegister32',
5326             'features': 'int' } }
5329 # @DummyForceArrays:
5331 # Not used by QMP; hack to let us use X86CPUFeatureWordInfoList internally
5333 # Since: 2.5
5335 { 'struct': 'DummyForceArrays',
5336   'data': { 'unused': ['X86CPUFeatureWordInfo'] } }
5340 # @RxState:
5342 # Packets receiving state
5344 # @normal: filter assigned packets according to the mac-table
5346 # @none: don't receive any assigned packet
5348 # @all: receive all assigned packets
5350 # Since: 1.6
5352 { 'enum': 'RxState', 'data': [ 'normal', 'none', 'all' ] }
5355 # @RxFilterInfo:
5357 # Rx-filter information for a NIC.
5359 # @name: net client name
5361 # @promiscuous: whether promiscuous mode is enabled
5363 # @multicast: multicast receive state
5365 # @unicast: unicast receive state
5367 # @vlan: vlan receive state (Since 2.0)
5369 # @broadcast-allowed: whether to receive broadcast
5371 # @multicast-overflow: multicast table is overflowed or not
5373 # @unicast-overflow: unicast table is overflowed or not
5375 # @main-mac: the main macaddr string
5377 # @vlan-table: a list of active vlan id
5379 # @unicast-table: a list of unicast macaddr string
5381 # @multicast-table: a list of multicast macaddr string
5383 # Since: 1.6
5385 { 'struct': 'RxFilterInfo',
5386   'data': {
5387     'name':               'str',
5388     'promiscuous':        'bool',
5389     'multicast':          'RxState',
5390     'unicast':            'RxState',
5391     'vlan':               'RxState',
5392     'broadcast-allowed':  'bool',
5393     'multicast-overflow': 'bool',
5394     'unicast-overflow':   'bool',
5395     'main-mac':           'str',
5396     'vlan-table':         ['int'],
5397     'unicast-table':      ['str'],
5398     'multicast-table':    ['str'] }}
5401 # @query-rx-filter:
5403 # Return rx-filter information for all NICs (or for the given NIC).
5405 # @name: #optional net client name
5407 # Returns: list of @RxFilterInfo for all NICs (or for the given NIC).
5408 #          Returns an error if the given @name doesn't exist, or given
5409 #          NIC doesn't support rx-filter querying, or given net client
5410 #          isn't a NIC.
5412 # Since: 1.6
5414 # Example:
5416 # -> { "execute": "query-rx-filter", "arguments": { "name": "vnet0" } }
5417 # <- { "return": [
5418 #         {
5419 #             "promiscuous": true,
5420 #             "name": "vnet0",
5421 #             "main-mac": "52:54:00:12:34:56",
5422 #             "unicast": "normal",
5423 #             "vlan": "normal",
5424 #             "vlan-table": [
5425 #                 4,
5426 #                 0
5427 #             ],
5428 #             "unicast-table": [
5429 #             ],
5430 #             "multicast": "normal",
5431 #             "multicast-overflow": false,
5432 #             "unicast-overflow": false,
5433 #             "multicast-table": [
5434 #                 "01:00:5e:00:00:01",
5435 #                 "33:33:00:00:00:01",
5436 #                 "33:33:ff:12:34:56"
5437 #             ],
5438 #             "broadcast-allowed": false
5439 #         }
5440 #       ]
5441 #    }
5444 { 'command': 'query-rx-filter', 'data': { '*name': 'str' },
5445   'returns': ['RxFilterInfo'] }
5448 # @InputButton:
5450 # Button of a pointer input device (mouse, tablet).
5452 # @side: front side button of a 5-button mouse (since 2.9)
5454 # @extra: rear side button of a 5-button mouse (since 2.9)
5456 # Since: 2.0
5458 { 'enum'  : 'InputButton',
5459   'data'  : [ 'left', 'middle', 'right', 'wheel-up', 'wheel-down', 'side',
5460   'extra' ] }
5463 # @InputAxis:
5465 # Position axis of a pointer input device (mouse, tablet).
5467 # Since: 2.0
5469 { 'enum'  : 'InputAxis',
5470   'data'  : [ 'x', 'y' ] }
5473 # @InputKeyEvent:
5475 # Keyboard input event.
5477 # @key:    Which key this event is for.
5478 # @down:   True for key-down and false for key-up events.
5480 # Since: 2.0
5482 { 'struct'  : 'InputKeyEvent',
5483   'data'  : { 'key'     : 'KeyValue',
5484               'down'    : 'bool' } }
5487 # @InputBtnEvent:
5489 # Pointer button input event.
5491 # @button: Which button this event is for.
5492 # @down:   True for key-down and false for key-up events.
5494 # Since: 2.0
5496 { 'struct'  : 'InputBtnEvent',
5497   'data'  : { 'button'  : 'InputButton',
5498               'down'    : 'bool' } }
5501 # @InputMoveEvent:
5503 # Pointer motion input event.
5505 # @axis:   Which axis is referenced by @value.
5506 # @value:  Pointer position.  For absolute coordinates the
5507 #          valid range is 0 -> 0x7ffff
5509 # Since: 2.0
5511 { 'struct'  : 'InputMoveEvent',
5512   'data'  : { 'axis'    : 'InputAxis',
5513               'value'   : 'int' } }
5516 # @InputEvent:
5518 # Input event union.
5520 # @type: the input type, one of:
5521 #  - 'key': Input event of Keyboard
5522 #  - 'btn': Input event of pointer buttons
5523 #  - 'rel': Input event of relative pointer motion
5524 #  - 'abs': Input event of absolute pointer motion
5526 # Since: 2.0
5528 { 'union' : 'InputEvent',
5529   'data'  : { 'key'     : 'InputKeyEvent',
5530               'btn'     : 'InputBtnEvent',
5531               'rel'     : 'InputMoveEvent',
5532               'abs'     : 'InputMoveEvent' } }
5535 # @input-send-event:
5537 # Send input event(s) to guest.
5539 # @device: #optional display device to send event(s) to.
5540 # @head: #optional head to send event(s) to, in case the
5541 #        display device supports multiple scanouts.
5542 # @events: List of InputEvent union.
5544 # Returns: Nothing on success.
5546 # The @device and @head parameters can be used to send the input event
5547 # to specific input devices in case (a) multiple input devices of the
5548 # same kind are added to the virtual machine and (b) you have
5549 # configured input routing (see docs/multiseat.txt) for those input
5550 # devices.  The parameters work exactly like the device and head
5551 # properties of input devices.  If @device is missing, only devices
5552 # that have no input routing config are admissible.  If @device is
5553 # specified, both input devices with and without input routing config
5554 # are admissible, but devices with input routing config take
5555 # precedence.
5557 # Since: 2.6
5559 # Note: The consoles are visible in the qom tree, under
5560 # /backend/console[$index]. They have a device link and head property,
5561 # so it is possible to map which console belongs to which device and
5562 # display.
5564 # Example:
5566 # 1. Press left mouse button.
5568 # -> { "execute": "input-send-event",
5569 #     "arguments": { "device": "video0",
5570 #                    "events": [ { "type": "btn",
5571 #                    "data" : { "down": true, "button": "left" } } ] } }
5572 # <- { "return": {} }
5574 # -> { "execute": "input-send-event",
5575 #     "arguments": { "device": "video0",
5576 #                    "events": [ { "type": "btn",
5577 #                    "data" : { "down": false, "button": "left" } } ] } }
5578 # <- { "return": {} }
5580 # 2. Press ctrl-alt-del.
5582 # -> { "execute": "input-send-event",
5583 #      "arguments": { "events": [
5584 #         { "type": "key", "data" : { "down": true,
5585 #           "key": {"type": "qcode", "data": "ctrl" } } },
5586 #         { "type": "key", "data" : { "down": true,
5587 #           "key": {"type": "qcode", "data": "alt" } } },
5588 #         { "type": "key", "data" : { "down": true,
5589 #           "key": {"type": "qcode", "data": "delete" } } } ] } }
5590 # <- { "return": {} }
5592 # 3. Move mouse pointer to absolute coordinates (20000, 400).
5594 # -> { "execute": "input-send-event" ,
5595 #   "arguments": { "events": [
5596 #                { "type": "abs", "data" : { "axis": "x", "value" : 20000 } },
5597 #                { "type": "abs", "data" : { "axis": "y", "value" : 400 } } ] } }
5598 # <- { "return": {} }
5601 { 'command': 'input-send-event',
5602   'data': { '*device': 'str',
5603             '*head'  : 'int',
5604             'events' : [ 'InputEvent' ] } }
5607 # @NumaOptionsType:
5609 # Since: 2.1
5611 { 'enum': 'NumaOptionsType',
5612   'data': [ 'node' ] }
5615 # @NumaOptions:
5617 # A discriminated record of NUMA options. (for OptsVisitor)
5619 # Since: 2.1
5621 { 'union': 'NumaOptions',
5622   'base': { 'type': 'NumaOptionsType' },
5623   'discriminator': 'type',
5624   'data': {
5625     'node': 'NumaNodeOptions' }}
5628 # @NumaNodeOptions:
5630 # Create a guest NUMA node. (for OptsVisitor)
5632 # @nodeid: #optional NUMA node ID (increase by 1 from 0 if omitted)
5634 # @cpus: #optional VCPUs belonging to this node (assign VCPUS round-robin
5635 #         if omitted)
5637 # @mem: #optional memory size of this node; mutually exclusive with @memdev.
5638 #       Equally divide total memory among nodes if both @mem and @memdev are
5639 #       omitted.
5641 # @memdev: #optional memory backend object.  If specified for one node,
5642 #          it must be specified for all nodes.
5644 # Since: 2.1
5646 { 'struct': 'NumaNodeOptions',
5647   'data': {
5648    '*nodeid': 'uint16',
5649    '*cpus':   ['uint16'],
5650    '*mem':    'size',
5651    '*memdev': 'str' }}
5654 # @HostMemPolicy:
5656 # Host memory policy types
5658 # @default: restore default policy, remove any nondefault policy
5660 # @preferred: set the preferred host nodes for allocation
5662 # @bind: a strict policy that restricts memory allocation to the
5663 #        host nodes specified
5665 # @interleave: memory allocations are interleaved across the set
5666 #              of host nodes specified
5668 # Since: 2.1
5670 { 'enum': 'HostMemPolicy',
5671   'data': [ 'default', 'preferred', 'bind', 'interleave' ] }
5674 # @Memdev:
5676 # Information about memory backend
5678 # @id: #optional backend's ID if backend has 'id' property (since 2.9)
5680 # @size: memory backend size
5682 # @merge: enables or disables memory merge support
5684 # @dump: includes memory backend's memory in a core dump or not
5686 # @prealloc: enables or disables memory preallocation
5688 # @host-nodes: host nodes for its memory policy
5690 # @policy: memory policy of memory backend
5692 # Since: 2.1
5694 { 'struct': 'Memdev',
5695   'data': {
5696     '*id':        'str',
5697     'size':       'size',
5698     'merge':      'bool',
5699     'dump':       'bool',
5700     'prealloc':   'bool',
5701     'host-nodes': ['uint16'],
5702     'policy':     'HostMemPolicy' }}
5705 # @query-memdev:
5707 # Returns information for all memory backends.
5709 # Returns: a list of @Memdev.
5711 # Since: 2.1
5713 # Example:
5715 # -> { "execute": "query-memdev" }
5716 # <- { "return": [
5717 #        {
5718 #          "id": "mem1",
5719 #          "size": 536870912,
5720 #          "merge": false,
5721 #          "dump": true,
5722 #          "prealloc": false,
5723 #          "host-nodes": [0, 1],
5724 #          "policy": "bind"
5725 #        },
5726 #        {
5727 #          "size": 536870912,
5728 #          "merge": false,
5729 #          "dump": true,
5730 #          "prealloc": true,
5731 #          "host-nodes": [2, 3],
5732 #          "policy": "preferred"
5733 #        }
5734 #      ]
5735 #    }
5738 { 'command': 'query-memdev', 'returns': ['Memdev'] }
5741 # @PCDIMMDeviceInfo:
5743 # PCDIMMDevice state information
5745 # @id: #optional device's ID
5747 # @addr: physical address, where device is mapped
5749 # @size: size of memory that the device provides
5751 # @slot: slot number at which device is plugged in
5753 # @node: NUMA node number where device is plugged in
5755 # @memdev: memory backend linked with device
5757 # @hotplugged: true if device was hotplugged
5759 # @hotpluggable: true if device if could be added/removed while machine is running
5761 # Since: 2.1
5763 { 'struct': 'PCDIMMDeviceInfo',
5764   'data': { '*id': 'str',
5765             'addr': 'int',
5766             'size': 'int',
5767             'slot': 'int',
5768             'node': 'int',
5769             'memdev': 'str',
5770             'hotplugged': 'bool',
5771             'hotpluggable': 'bool'
5772           }
5776 # @MemoryDeviceInfo:
5778 # Union containing information about a memory device
5780 # Since: 2.1
5782 { 'union': 'MemoryDeviceInfo', 'data': {'dimm': 'PCDIMMDeviceInfo'} }
5785 # @query-memory-devices:
5787 # Lists available memory devices and their state
5789 # Since: 2.1
5791 # Example:
5793 # -> { "execute": "query-memory-devices" }
5794 # <- { "return": [ { "data":
5795 #                       { "addr": 5368709120,
5796 #                         "hotpluggable": true,
5797 #                         "hotplugged": true,
5798 #                         "id": "d1",
5799 #                         "memdev": "/objects/memX",
5800 #                         "node": 0,
5801 #                         "size": 1073741824,
5802 #                         "slot": 0},
5803 #                    "type": "dimm"
5804 #                  } ] }
5807 { 'command': 'query-memory-devices', 'returns': ['MemoryDeviceInfo'] }
5810 # @ACPISlotType:
5812 # @DIMM: memory slot
5813 # @CPU: logical CPU slot (since 2.7)
5815 { 'enum': 'ACPISlotType', 'data': [ 'DIMM', 'CPU' ] }
5818 # @ACPIOSTInfo:
5820 # OSPM Status Indication for a device
5821 # For description of possible values of @source and @status fields
5822 # see "_OST (OSPM Status Indication)" chapter of ACPI5.0 spec.
5824 # @device: #optional device ID associated with slot
5826 # @slot: slot ID, unique per slot of a given @slot-type
5828 # @slot-type: type of the slot
5830 # @source: an integer containing the source event
5832 # @status: an integer containing the status code
5834 # Since: 2.1
5836 { 'struct': 'ACPIOSTInfo',
5837   'data'  : { '*device': 'str',
5838               'slot': 'str',
5839               'slot-type': 'ACPISlotType',
5840               'source': 'int',
5841               'status': 'int' } }
5844 # @query-acpi-ospm-status:
5846 # Return a list of ACPIOSTInfo for devices that support status
5847 # reporting via ACPI _OST method.
5849 # Since: 2.1
5851 # Example:
5853 # -> { "execute": "query-acpi-ospm-status" }
5854 # <- { "return": [ { "device": "d1", "slot": "0", "slot-type": "DIMM", "source": 1, "status": 0},
5855 #                  { "slot": "1", "slot-type": "DIMM", "source": 0, "status": 0},
5856 #                  { "slot": "2", "slot-type": "DIMM", "source": 0, "status": 0},
5857 #                  { "slot": "3", "slot-type": "DIMM", "source": 0, "status": 0}
5858 #    ]}
5861 { 'command': 'query-acpi-ospm-status', 'returns': ['ACPIOSTInfo'] }
5864 # @WatchdogExpirationAction:
5866 # An enumeration of the actions taken when the watchdog device's timer is
5867 # expired
5869 # @reset: system resets
5871 # @shutdown: system shutdown, note that it is similar to @powerdown, which
5872 #            tries to set to system status and notify guest
5874 # @poweroff: system poweroff, the emulator program exits
5876 # @pause: system pauses, similar to @stop
5878 # @debug: system enters debug state
5880 # @none: nothing is done
5882 # @inject-nmi: a non-maskable interrupt is injected into the first VCPU (all
5883 #              VCPUS on x86) (since 2.4)
5885 # Since: 2.1
5887 { 'enum': 'WatchdogExpirationAction',
5888   'data': [ 'reset', 'shutdown', 'poweroff', 'pause', 'debug', 'none',
5889             'inject-nmi' ] }
5892 # @IoOperationType:
5894 # An enumeration of the I/O operation types
5896 # @read: read operation
5898 # @write: write operation
5900 # Since: 2.1
5902 { 'enum': 'IoOperationType',
5903   'data': [ 'read', 'write' ] }
5906 # @GuestPanicAction:
5908 # An enumeration of the actions taken when guest OS panic is detected
5910 # @pause: system pauses
5912 # Since: 2.1 (poweroff since 2.8)
5914 { 'enum': 'GuestPanicAction',
5915   'data': [ 'pause', 'poweroff' ] }
5918 # @GuestPanicInformationType:
5920 # An enumeration of the guest panic information types
5922 # Since: 2.9
5924 { 'enum': 'GuestPanicInformationType',
5925   'data': [ 'hyper-v'] }
5928 # @GuestPanicInformation:
5930 # Information about a guest panic
5932 # Since: 2.9
5934 {'union': 'GuestPanicInformation',
5935  'base': {'type': 'GuestPanicInformationType'},
5936  'discriminator': 'type',
5937  'data': { 'hyper-v': 'GuestPanicInformationHyperV' } }
5940 # @GuestPanicInformationHyperV:
5942 # Hyper-V specific guest panic information (HV crash MSRs)
5944 # Since: 2.9
5946 {'struct': 'GuestPanicInformationHyperV',
5947  'data': { 'arg1': 'uint64',
5948            'arg2': 'uint64',
5949            'arg3': 'uint64',
5950            'arg4': 'uint64',
5951            'arg5': 'uint64' } }
5954 # @rtc-reset-reinjection:
5956 # This command will reset the RTC interrupt reinjection backlog.
5957 # Can be used if another mechanism to synchronize guest time
5958 # is in effect, for example QEMU guest agent's guest-set-time
5959 # command.
5961 # Since: 2.1
5963 # Example:
5965 # -> { "execute": "rtc-reset-reinjection" }
5966 # <- { "return": {} }
5969 { 'command': 'rtc-reset-reinjection' }
5971 # Rocker ethernet network switch
5972 { 'include': 'qapi/rocker.json' }
5975 # @ReplayMode:
5977 # Mode of the replay subsystem.
5979 # @none: normal execution mode. Replay or record are not enabled.
5981 # @record: record mode. All non-deterministic data is written into the
5982 #          replay log.
5984 # @play: replay mode. Non-deterministic data required for system execution
5985 #        is read from the log.
5987 # Since: 2.5
5989 { 'enum': 'ReplayMode',
5990   'data': [ 'none', 'record', 'play' ] }
5993 # @xen-load-devices-state:
5995 # Load the state of all devices from file. The RAM and the block devices
5996 # of the VM are not loaded by this command.
5998 # @filename: the file to load the state of the devices from as binary
5999 # data. See xen-save-devices-state.txt for a description of the binary
6000 # format.
6002 # Since: 2.7
6004 # Example:
6006 # -> { "execute": "xen-load-devices-state",
6007 #      "arguments": { "filename": "/tmp/resume" } }
6008 # <- { "return": {} }
6011 { 'command': 'xen-load-devices-state', 'data': {'filename': 'str'} }
6014 # @xen-set-replication:
6016 # Enable or disable replication.
6018 # @enable: true to enable, false to disable.
6020 # @primary: true for primary or false for secondary.
6022 # @failover: #optional true to do failover, false to stop. but cannot be
6023 #            specified if 'enable' is true. default value is false.
6025 # Returns: nothing.
6027 # Example:
6029 # -> { "execute": "xen-set-replication",
6030 #      "arguments": {"enable": true, "primary": false} }
6031 # <- { "return": {} }
6033 # Since: 2.9
6035 { 'command': 'xen-set-replication',
6036   'data': { 'enable': 'bool', 'primary': 'bool', '*failover' : 'bool' } }
6039 # @ReplicationStatus:
6041 # The result format for 'query-xen-replication-status'.
6043 # @error: true if an error happened, false if replication is normal.
6045 # @desc: #optional the human readable error description string, when
6046 #        @error is 'true'.
6048 # Since: 2.9
6050 { 'struct': 'ReplicationStatus',
6051   'data': { 'error': 'bool', '*desc': 'str' } }
6054 # @query-xen-replication-status:
6056 # Query replication status while the vm is running.
6058 # Returns: A @ReplicationResult object showing the status.
6060 # Example:
6062 # -> { "execute": "query-xen-replication-status" }
6063 # <- { "return": { "error": false } }
6065 # Since: 2.9
6067 { 'command': 'query-xen-replication-status',
6068   'returns': 'ReplicationStatus' }
6071 # @xen-colo-do-checkpoint:
6073 # Xen uses this command to notify replication to trigger a checkpoint.
6075 # Returns: nothing.
6077 # Example:
6079 # -> { "execute": "xen-colo-do-checkpoint" }
6080 # <- { "return": {} }
6082 # Since: 2.9
6084 { 'command': 'xen-colo-do-checkpoint' }
6087 # @GICCapability:
6089 # The struct describes capability for a specific GIC (Generic
6090 # Interrupt Controller) version. These bits are not only decided by
6091 # QEMU/KVM software version, but also decided by the hardware that
6092 # the program is running upon.
6094 # @version:  version of GIC to be described. Currently, only 2 and 3
6095 #            are supported.
6097 # @emulated: whether current QEMU/hardware supports emulated GIC
6098 #            device in user space.
6100 # @kernel:   whether current QEMU/hardware supports hardware
6101 #            accelerated GIC device in kernel.
6103 # Since: 2.6
6105 { 'struct': 'GICCapability',
6106   'data': { 'version': 'int',
6107             'emulated': 'bool',
6108             'kernel': 'bool' } }
6111 # @query-gic-capabilities:
6113 # This command is ARM-only. It will return a list of GICCapability
6114 # objects that describe its capability bits.
6116 # Returns: a list of GICCapability objects.
6118 # Since: 2.6
6120 # Example:
6122 # -> { "execute": "query-gic-capabilities" }
6123 # <- { "return": [{ "version": 2, "emulated": true, "kernel": false },
6124 #                 { "version": 3, "emulated": false, "kernel": true } ] }
6127 { 'command': 'query-gic-capabilities', 'returns': ['GICCapability'] }
6130 # @CpuInstanceProperties:
6132 # List of properties to be used for hotplugging a CPU instance,
6133 # it should be passed by management with device_add command when
6134 # a CPU is being hotplugged.
6136 # @node-id: #optional NUMA node ID the CPU belongs to
6137 # @socket-id: #optional socket number within node/board the CPU belongs to
6138 # @core-id: #optional core number within socket the CPU belongs to
6139 # @thread-id: #optional thread number within core the CPU belongs to
6141 # Note: currently there are 4 properties that could be present
6142 # but management should be prepared to pass through other
6143 # properties with device_add command to allow for future
6144 # interface extension. This also requires the filed names to be kept in
6145 # sync with the properties passed to -device/device_add.
6147 # Since: 2.7
6149 { 'struct': 'CpuInstanceProperties',
6150   'data': { '*node-id': 'int',
6151             '*socket-id': 'int',
6152             '*core-id': 'int',
6153             '*thread-id': 'int'
6154   }
6158 # @HotpluggableCPU:
6160 # @type: CPU object type for usage with device_add command
6161 # @props: list of properties to be used for hotplugging CPU
6162 # @vcpus-count: number of logical VCPU threads @HotpluggableCPU provides
6163 # @qom-path: #optional link to existing CPU object if CPU is present or
6164 #            omitted if CPU is not present.
6166 # Since: 2.7
6168 { 'struct': 'HotpluggableCPU',
6169   'data': { 'type': 'str',
6170             'vcpus-count': 'int',
6171             'props': 'CpuInstanceProperties',
6172             '*qom-path': 'str'
6173           }
6177 # @query-hotpluggable-cpus:
6179 # Returns: a list of HotpluggableCPU objects.
6181 # Since: 2.7
6183 # Example:
6185 # For pseries machine type started with -smp 2,cores=2,maxcpus=4 -cpu POWER8:
6187 # -> { "execute": "query-hotpluggable-cpus" }
6188 # <- {"return": [
6189 #      { "props": { "core": 8 }, "type": "POWER8-spapr-cpu-core",
6190 #        "vcpus-count": 1 },
6191 #      { "props": { "core": 0 }, "type": "POWER8-spapr-cpu-core",
6192 #        "vcpus-count": 1, "qom-path": "/machine/unattached/device[0]"}
6193 #    ]}'
6195 # For pc machine type started with -smp 1,maxcpus=2:
6197 # -> { "execute": "query-hotpluggable-cpus" }
6198 # <- {"return": [
6199 #      {
6200 #         "type": "qemu64-x86_64-cpu", "vcpus-count": 1,
6201 #         "props": {"core-id": 0, "socket-id": 1, "thread-id": 0}
6202 #      },
6203 #      {
6204 #         "qom-path": "/machine/unattached/device[0]",
6205 #         "type": "qemu64-x86_64-cpu", "vcpus-count": 1,
6206 #         "props": {"core-id": 0, "socket-id": 0, "thread-id": 0}
6207 #      }
6208 #    ]}
6211 { 'command': 'query-hotpluggable-cpus', 'returns': ['HotpluggableCPU'] }
6214 # @GuidInfo:
6216 # GUID information.
6218 # @guid: the globally unique identifier
6220 # Since: 2.9
6222 { 'struct': 'GuidInfo', 'data': {'guid': 'str'} }
6225 # @query-vm-generation-id:
6227 # Show Virtual Machine Generation ID
6229 # Since 2.9
6231 { 'command': 'query-vm-generation-id', 'returns': 'GuidInfo' }