block: check full backing filename when searching protocol filenames
[qemu/ar7.git] / qapi-schema.json
blob61151f34d0cfff3d653782d775ae1e153fb07b7f
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 # Since: 1.2
870 { 'enum': 'MigrationCapability',
871   'data': ['xbzrle', 'rdma-pin-all', 'auto-converge', 'zero-blocks',
872            'compress', 'events', 'postcopy-ram', 'x-colo'] }
875 # @MigrationCapabilityStatus:
877 # Migration capability information
879 # @capability: capability enum
881 # @state: capability state bool
883 # Since: 1.2
885 { 'struct': 'MigrationCapabilityStatus',
886   'data': { 'capability' : 'MigrationCapability', 'state' : 'bool' } }
889 # @migrate-set-capabilities:
891 # Enable/Disable the following migration capabilities (like xbzrle)
893 # @capabilities: json array of capability modifications to make
895 # Since: 1.2
897 # Example:
899 # -> { "execute": "migrate-set-capabilities" , "arguments":
900 #      { "capabilities": [ { "capability": "xbzrle", "state": true } ] } }
903 { 'command': 'migrate-set-capabilities',
904   'data': { 'capabilities': ['MigrationCapabilityStatus'] } }
907 # @query-migrate-capabilities:
909 # Returns information about the current migration capabilities status
911 # Returns: @MigrationCapabilitiesStatus
913 # Since: 1.2
915 # Example:
917 # -> { "execute": "query-migrate-capabilities" }
918 # <- { "return": [
919 #       {"state": false, "capability": "xbzrle"},
920 #       {"state": false, "capability": "rdma-pin-all"},
921 #       {"state": false, "capability": "auto-converge"},
922 #       {"state": false, "capability": "zero-blocks"},
923 #       {"state": false, "capability": "compress"},
924 #       {"state": true, "capability": "events"},
925 #       {"state": false, "capability": "postcopy-ram"},
926 #       {"state": false, "capability": "x-colo"}
927 #    ]}
930 { 'command': 'query-migrate-capabilities', 'returns':   ['MigrationCapabilityStatus']}
933 # @MigrationParameter:
935 # Migration parameters enumeration
937 # @compress-level: Set the compression level to be used in live migration,
938 #          the compression level is an integer between 0 and 9, where 0 means
939 #          no compression, 1 means the best compression speed, and 9 means best
940 #          compression ratio which will consume more CPU.
942 # @compress-threads: Set compression thread count to be used in live migration,
943 #          the compression thread count is an integer between 1 and 255.
945 # @decompress-threads: Set decompression thread count to be used in live
946 #          migration, the decompression thread count is an integer between 1
947 #          and 255. Usually, decompression is at least 4 times as fast as
948 #          compression, so set the decompress-threads to the number about 1/4
949 #          of compress-threads is adequate.
951 # @cpu-throttle-initial: Initial percentage of time guest cpus are throttled
952 #                        when migration auto-converge is activated. The
953 #                        default value is 20. (Since 2.7)
955 # @cpu-throttle-increment: throttle percentage increase each time
956 #                          auto-converge detects that migration is not making
957 #                          progress. The default value is 10. (Since 2.7)
959 # @tls-creds: ID of the 'tls-creds' object that provides credentials for
960 #             establishing a TLS connection over the migration data channel.
961 #             On the outgoing side of the migration, the credentials must
962 #             be for a 'client' endpoint, while for the incoming side the
963 #             credentials must be for a 'server' endpoint. Setting this
964 #             will enable TLS for all migrations. The default is unset,
965 #             resulting in unsecured migration at the QEMU level. (Since 2.7)
967 # @tls-hostname: hostname of the target host for the migration. This is
968 #                required when using x509 based TLS credentials and the
969 #                migration URI does not already include a hostname. For
970 #                example if using fd: or exec: based migration, the
971 #                hostname must be provided so that the server's x509
972 #                certificate identity can be validated. (Since 2.7)
974 # @max-bandwidth: to set maximum speed for migration. maximum speed in
975 #                 bytes per second. (Since 2.8)
977 # @downtime-limit: set maximum tolerated downtime for migration. maximum
978 #                  downtime in milliseconds (Since 2.8)
980 # @x-checkpoint-delay: The delay time (in ms) between two COLO checkpoints in
981 #          periodic mode. (Since 2.8)
983 # Since: 2.4
985 { 'enum': 'MigrationParameter',
986   'data': ['compress-level', 'compress-threads', 'decompress-threads',
987            'cpu-throttle-initial', 'cpu-throttle-increment',
988            'tls-creds', 'tls-hostname', 'max-bandwidth',
989            'downtime-limit', 'x-checkpoint-delay' ] }
992 # @migrate-set-parameters:
994 # Set various migration parameters.  See MigrationParameters for details.
996 # Since: 2.4
998 # Example:
1000 # -> { "execute": "migrate-set-parameters" ,
1001 #      "arguments": { "compress-level": 1 } }
1004 { 'command': 'migrate-set-parameters', 'boxed': true,
1005   'data': 'MigrationParameters' }
1008 # @MigrationParameters:
1010 # Optional members can be omitted on input ('migrate-set-parameters')
1011 # but most members will always be present on output
1012 # ('query-migrate-parameters'), with the exception of tls-creds and
1013 # tls-hostname.
1015 # @compress-level: #optional compression level
1017 # @compress-threads: #optional compression thread count
1019 # @decompress-threads: #optional decompression thread count
1021 # @cpu-throttle-initial: #optional Initial percentage of time guest cpus are
1022 #                        throttledwhen migration auto-converge is activated.
1023 #                        The default value is 20. (Since 2.7)
1025 # @cpu-throttle-increment: #optional throttle percentage increase each time
1026 #                          auto-converge detects that migration is not making
1027 #                          progress. The default value is 10. (Since 2.7)
1029 # @tls-creds: #optional ID of the 'tls-creds' object that provides credentials
1030 #             for establishing a TLS connection over the migration data
1031 #             channel. On the outgoing side of the migration, the credentials
1032 #             must be for a 'client' endpoint, while for the incoming side the
1033 #             credentials must be for a 'server' endpoint. Setting this
1034 #             will enable TLS for all migrations. The default is unset,
1035 #             resulting in unsecured migration at the QEMU level. (Since 2.7)
1037 # @tls-hostname: #optional hostname of the target host for the migration. This
1038 #                is required when using x509 based TLS credentials and the
1039 #                migration URI does not already include a hostname. For
1040 #                example if using fd: or exec: based migration, the
1041 #                hostname must be provided so that the server's x509
1042 #                certificate identity can be validated. (Since 2.7)
1044 # @max-bandwidth: to set maximum speed for migration. maximum speed in
1045 #                 bytes per second. (Since 2.8)
1047 # @downtime-limit: set maximum tolerated downtime for migration. maximum
1048 #                  downtime in milliseconds (Since 2.8)
1050 # @x-checkpoint-delay: the delay time between two COLO checkpoints. (Since 2.8)
1052 # Since: 2.4
1054 { 'struct': 'MigrationParameters',
1055   'data': { '*compress-level': 'int',
1056             '*compress-threads': 'int',
1057             '*decompress-threads': 'int',
1058             '*cpu-throttle-initial': 'int',
1059             '*cpu-throttle-increment': 'int',
1060             '*tls-creds': 'str',
1061             '*tls-hostname': 'str',
1062             '*max-bandwidth': 'int',
1063             '*downtime-limit': 'int',
1064             '*x-checkpoint-delay': 'int'} }
1067 # @query-migrate-parameters:
1069 # Returns information about the current migration parameters
1071 # Returns: @MigrationParameters
1073 # Since: 2.4
1075 # Example:
1077 # -> { "execute": "query-migrate-parameters" }
1078 # <- { "return": {
1079 #          "decompress-threads": 2,
1080 #          "cpu-throttle-increment": 10,
1081 #          "compress-threads": 8,
1082 #          "compress-level": 1,
1083 #          "cpu-throttle-initial": 20,
1084 #          "max-bandwidth": 33554432,
1085 #          "downtime-limit": 300
1086 #       }
1087 #    }
1090 { 'command': 'query-migrate-parameters',
1091   'returns': 'MigrationParameters' }
1094 # @client_migrate_info:
1096 # Set migration information for remote display.  This makes the server
1097 # ask the client to automatically reconnect using the new parameters
1098 # once migration finished successfully.  Only implemented for SPICE.
1100 # @protocol:     must be "spice"
1101 # @hostname:     migration target hostname
1102 # @port:         #optional spice tcp port for plaintext channels
1103 # @tls-port:     #optional spice tcp port for tls-secured channels
1104 # @cert-subject: #optional server certificate subject
1106 # Since: 0.14.0
1108 # Example:
1110 # -> { "execute": "client_migrate_info",
1111 #      "arguments": { "protocol": "spice",
1112 #                     "hostname": "virt42.lab.kraxel.org",
1113 #                     "port": 1234 } }
1114 # <- { "return": {} }
1117 { 'command': 'client_migrate_info',
1118   'data': { 'protocol': 'str', 'hostname': 'str', '*port': 'int',
1119             '*tls-port': 'int', '*cert-subject': 'str' } }
1122 # @migrate-start-postcopy:
1124 # Followup to a migration command to switch the migration to postcopy mode.
1125 # The postcopy-ram capability must be set before the original migration
1126 # command.
1128 # Since: 2.5
1130 # Example:
1132 # -> { "execute": "migrate-start-postcopy" }
1133 # <- { "return": {} }
1136 { 'command': 'migrate-start-postcopy' }
1139 # @COLOMessage:
1141 # The message transmission between Primary side and Secondary side.
1143 # @checkpoint-ready: Secondary VM (SVM) is ready for checkpointing
1145 # @checkpoint-request: Primary VM (PVM) tells SVM to prepare for checkpointing
1147 # @checkpoint-reply: SVM gets PVM's checkpoint request
1149 # @vmstate-send: VM's state will be sent by PVM.
1151 # @vmstate-size: The total size of VMstate.
1153 # @vmstate-received: VM's state has been received by SVM.
1155 # @vmstate-loaded: VM's state has been loaded by SVM.
1157 # Since: 2.8
1159 { 'enum': 'COLOMessage',
1160   'data': [ 'checkpoint-ready', 'checkpoint-request', 'checkpoint-reply',
1161             'vmstate-send', 'vmstate-size', 'vmstate-received',
1162             'vmstate-loaded' ] }
1165 # @COLOMode:
1167 # The colo mode
1169 # @unknown: unknown mode
1171 # @primary: master side
1173 # @secondary: slave side
1175 # Since: 2.8
1177 { 'enum': 'COLOMode',
1178   'data': [ 'unknown', 'primary', 'secondary'] }
1181 # @FailoverStatus:
1183 # An enumeration of COLO failover status
1185 # @none: no failover has ever happened
1187 # @require: got failover requirement but not handled
1189 # @active: in the process of doing failover
1191 # @completed: finish the process of failover
1193 # Since: 2.8
1195 { 'enum': 'FailoverStatus',
1196   'data': [ 'none', 'require', 'active', 'completed'] }
1199 # @x-colo-lost-heartbeat:
1201 # Tell qemu that heartbeat is lost, request it to do takeover procedures.
1202 # If this command is sent to the PVM, the Primary side will exit COLO mode.
1203 # If sent to the Secondary, the Secondary side will run failover work,
1204 # then takes over server operation to become the service VM.
1206 # Since: 2.8
1208 # Example:
1210 # -> { "execute": "x-colo-lost-heartbeat" }
1211 # <- { "return": {} }
1214 { 'command': 'x-colo-lost-heartbeat' }
1217 # @MouseInfo:
1219 # Information about a mouse device.
1221 # @name: the name of the mouse device
1223 # @index: the index of the mouse device
1225 # @current: true if this device is currently receiving mouse events
1227 # @absolute: true if this device supports absolute coordinates as input
1229 # Since: 0.14.0
1231 { 'struct': 'MouseInfo',
1232   'data': {'name': 'str', 'index': 'int', 'current': 'bool',
1233            'absolute': 'bool'} }
1236 # @query-mice:
1238 # Returns information about each active mouse device
1240 # Returns: a list of @MouseInfo for each device
1242 # Since: 0.14.0
1244 # Example:
1246 # -> { "execute": "query-mice" }
1247 # <- { "return": [
1248 #          {
1249 #             "name":"QEMU Microsoft Mouse",
1250 #             "index":0,
1251 #             "current":false,
1252 #             "absolute":false
1253 #          },
1254 #          {
1255 #             "name":"QEMU PS/2 Mouse",
1256 #             "index":1,
1257 #             "current":true,
1258 #             "absolute":true
1259 #          }
1260 #       ]
1261 #    }
1264 { 'command': 'query-mice', 'returns': ['MouseInfo'] }
1267 # @CpuInfoArch:
1269 # An enumeration of cpu types that enable additional information during
1270 # @query-cpus.
1272 # Since: 2.6
1274 { 'enum': 'CpuInfoArch',
1275   'data': ['x86', 'sparc', 'ppc', 'mips', 'tricore', 'other' ] }
1278 # @CpuInfo:
1280 # Information about a virtual CPU
1282 # @CPU: the index of the virtual CPU
1284 # @current: this only exists for backwards compatibility and should be ignored
1286 # @halted: true if the virtual CPU is in the halt state.  Halt usually refers
1287 #          to a processor specific low power mode.
1289 # @qom_path: path to the CPU object in the QOM tree (since 2.4)
1291 # @thread_id: ID of the underlying host thread
1293 # @arch: architecture of the cpu, which determines which additional fields
1294 #        will be listed (since 2.6)
1296 # Since: 0.14.0
1298 # Notes: @halted is a transient state that changes frequently.  By the time the
1299 #        data is sent to the client, the guest may no longer be halted.
1301 { 'union': 'CpuInfo',
1302   'base': {'CPU': 'int', 'current': 'bool', 'halted': 'bool',
1303            'qom_path': 'str', 'thread_id': 'int', 'arch': 'CpuInfoArch' },
1304   'discriminator': 'arch',
1305   'data': { 'x86': 'CpuInfoX86',
1306             'sparc': 'CpuInfoSPARC',
1307             'ppc': 'CpuInfoPPC',
1308             'mips': 'CpuInfoMIPS',
1309             'tricore': 'CpuInfoTricore',
1310             'other': 'CpuInfoOther' } }
1313 # @CpuInfoX86:
1315 # Additional information about a virtual i386 or x86_64 CPU
1317 # @pc: the 64-bit instruction pointer
1319 # Since: 2.6
1321 { 'struct': 'CpuInfoX86', 'data': { 'pc': 'int' } }
1324 # @CpuInfoSPARC:
1326 # Additional information about a virtual SPARC CPU
1328 # @pc: the PC component of the instruction pointer
1330 # @npc: the NPC component of the instruction pointer
1332 # Since: 2.6
1334 { 'struct': 'CpuInfoSPARC', 'data': { 'pc': 'int', 'npc': 'int' } }
1337 # @CpuInfoPPC:
1339 # Additional information about a virtual PPC CPU
1341 # @nip: the instruction pointer
1343 # Since: 2.6
1345 { 'struct': 'CpuInfoPPC', 'data': { 'nip': 'int' } }
1348 # @CpuInfoMIPS:
1350 # Additional information about a virtual MIPS CPU
1352 # @PC: the instruction pointer
1354 # Since: 2.6
1356 { 'struct': 'CpuInfoMIPS', 'data': { 'PC': 'int' } }
1359 # @CpuInfoTricore:
1361 # Additional information about a virtual Tricore CPU
1363 # @PC: the instruction pointer
1365 # Since: 2.6
1367 { 'struct': 'CpuInfoTricore', 'data': { 'PC': 'int' } }
1370 # @CpuInfoOther:
1372 # No additional information is available about the virtual CPU
1374 # Since: 2.6
1377 { 'struct': 'CpuInfoOther', 'data': { } }
1380 # @query-cpus:
1382 # Returns a list of information about each virtual CPU.
1384 # Returns: a list of @CpuInfo for each virtual CPU
1386 # Since: 0.14.0
1388 # Example:
1390 # -> { "execute": "query-cpus" }
1391 # <- { "return": [
1392 #          {
1393 #             "CPU":0,
1394 #             "current":true,
1395 #             "halted":false,
1396 #             "qom_path":"/machine/unattached/device[0]",
1397 #             "arch":"x86",
1398 #             "pc":3227107138,
1399 #             "thread_id":3134
1400 #          },
1401 #          {
1402 #             "CPU":1,
1403 #             "current":false,
1404 #             "halted":true,
1405 #             "qom_path":"/machine/unattached/device[2]",
1406 #             "arch":"x86",
1407 #             "pc":7108165,
1408 #             "thread_id":3135
1409 #          }
1410 #       ]
1411 #    }
1414 { 'command': 'query-cpus', 'returns': ['CpuInfo'] }
1417 # @IOThreadInfo:
1419 # Information about an iothread
1421 # @id: the identifier of the iothread
1423 # @thread-id: ID of the underlying host thread
1425 # Since: 2.0
1427 { 'struct': 'IOThreadInfo',
1428   'data': {'id': 'str', 'thread-id': 'int'} }
1431 # @query-iothreads:
1433 # Returns a list of information about each iothread.
1435 # Note: this list excludes the QEMU main loop thread, which is not declared
1436 # using the -object iothread command-line option.  It is always the main thread
1437 # of the process.
1439 # Returns: a list of @IOThreadInfo for each iothread
1441 # Since: 2.0
1443 # Example:
1445 # -> { "execute": "query-iothreads" }
1446 # <- { "return": [
1447 #          {
1448 #             "id":"iothread0",
1449 #             "thread-id":3134
1450 #          },
1451 #          {
1452 #             "id":"iothread1",
1453 #             "thread-id":3135
1454 #          }
1455 #       ]
1456 #    }
1459 { 'command': 'query-iothreads', 'returns': ['IOThreadInfo'] }
1462 # @NetworkAddressFamily:
1464 # The network address family
1466 # @ipv4: IPV4 family
1468 # @ipv6: IPV6 family
1470 # @unix: unix socket
1472 # @vsock: vsock family (since 2.8)
1474 # @unknown: otherwise
1476 # Since: 2.1
1478 { 'enum': 'NetworkAddressFamily',
1479   'data': [ 'ipv4', 'ipv6', 'unix', 'vsock', 'unknown' ] }
1482 # @VncBasicInfo:
1484 # The basic information for vnc network connection
1486 # @host: IP address
1488 # @service: The service name of the vnc port. This may depend on the host
1489 #           system's service database so symbolic names should not be relied
1490 #           on.
1492 # @family: address family
1494 # @websocket: true in case the socket is a websocket (since 2.3).
1496 # Since: 2.1
1498 { 'struct': 'VncBasicInfo',
1499   'data': { 'host': 'str',
1500             'service': 'str',
1501             'family': 'NetworkAddressFamily',
1502             'websocket': 'bool' } }
1505 # @VncServerInfo:
1507 # The network connection information for server
1509 # @auth: #optional authentication method used for
1510 #        the plain (non-websocket) VNC server
1512 # Since: 2.1
1514 { 'struct': 'VncServerInfo',
1515   'base': 'VncBasicInfo',
1516   'data': { '*auth': 'str' } }
1519 # @VncClientInfo:
1521 # Information about a connected VNC client.
1523 # @x509_dname: #optional If x509 authentication is in use, the Distinguished
1524 #              Name of the client.
1526 # @sasl_username: #optional If SASL authentication is in use, the SASL username
1527 #                 used for authentication.
1529 # Since: 0.14.0
1531 { 'struct': 'VncClientInfo',
1532   'base': 'VncBasicInfo',
1533   'data': { '*x509_dname': 'str', '*sasl_username': 'str' } }
1536 # @VncInfo:
1538 # Information about the VNC session.
1540 # @enabled: true if the VNC server is enabled, false otherwise
1542 # @host: #optional The hostname the VNC server is bound to.  This depends on
1543 #        the name resolution on the host and may be an IP address.
1545 # @family: #optional 'ipv6' if the host is listening for IPv6 connections
1546 #                    'ipv4' if the host is listening for IPv4 connections
1547 #                    'unix' if the host is listening on a unix domain socket
1548 #                    'unknown' otherwise
1550 # @service: #optional The service name of the server's port.  This may depends
1551 #           on the host system's service database so symbolic names should not
1552 #           be relied on.
1554 # @auth: #optional the current authentication type used by the server
1555 #        'none' if no authentication is being used
1556 #        'vnc' if VNC authentication is being used
1557 #        'vencrypt+plain' if VEncrypt is used with plain text authentication
1558 #        'vencrypt+tls+none' if VEncrypt is used with TLS and no authentication
1559 #        'vencrypt+tls+vnc' if VEncrypt is used with TLS and VNC authentication
1560 #        'vencrypt+tls+plain' if VEncrypt is used with TLS and plain text auth
1561 #        'vencrypt+x509+none' if VEncrypt is used with x509 and no auth
1562 #        'vencrypt+x509+vnc' if VEncrypt is used with x509 and VNC auth
1563 #        'vencrypt+x509+plain' if VEncrypt is used with x509 and plain text auth
1564 #        'vencrypt+tls+sasl' if VEncrypt is used with TLS and SASL auth
1565 #        'vencrypt+x509+sasl' if VEncrypt is used with x509 and SASL auth
1567 # @clients: a list of @VncClientInfo of all currently connected clients
1569 # Since: 0.14.0
1571 { 'struct': 'VncInfo',
1572   'data': {'enabled': 'bool', '*host': 'str',
1573            '*family': 'NetworkAddressFamily',
1574            '*service': 'str', '*auth': 'str', '*clients': ['VncClientInfo']} }
1577 # @VncPrimaryAuth:
1579 # vnc primary authentication method.
1581 # Since: 2.3
1583 { 'enum': 'VncPrimaryAuth',
1584   'data': [ 'none', 'vnc', 'ra2', 'ra2ne', 'tight', 'ultra',
1585             'tls', 'vencrypt', 'sasl' ] }
1588 # @VncVencryptSubAuth:
1590 # vnc sub authentication method with vencrypt.
1592 # Since: 2.3
1594 { 'enum': 'VncVencryptSubAuth',
1595   'data': [ 'plain',
1596             'tls-none',  'x509-none',
1597             'tls-vnc',   'x509-vnc',
1598             'tls-plain', 'x509-plain',
1599             'tls-sasl',  'x509-sasl' ] }
1603 # @VncServerInfo2:
1605 # The network connection information for server
1607 # @auth: The current authentication type used by the servers
1609 # @vencrypt: #optional The vencrypt sub authentication type used by the
1610 #            servers, only specified in case auth == vencrypt.
1612 # Since: 2.9
1614 { 'struct': 'VncServerInfo2',
1615   'base': 'VncBasicInfo',
1616   'data': { 'auth'      : 'VncPrimaryAuth',
1617             '*vencrypt' : 'VncVencryptSubAuth' } }
1621 # @VncInfo2:
1623 # Information about a vnc server
1625 # @id: vnc server name.
1627 # @server: A list of @VncBasincInfo describing all listening sockets.
1628 #          The list can be empty (in case the vnc server is disabled).
1629 #          It also may have multiple entries: normal + websocket,
1630 #          possibly also ipv4 + ipv6 in the future.
1632 # @clients: A list of @VncClientInfo of all currently connected clients.
1633 #           The list can be empty, for obvious reasons.
1635 # @auth: The current authentication type used by the non-websockets servers
1637 # @vencrypt: #optional The vencrypt authentication type used by the servers,
1638 #            only specified in case auth == vencrypt.
1640 # @display: #optional The display device the vnc server is linked to.
1642 # Since: 2.3
1644 { 'struct': 'VncInfo2',
1645   'data': { 'id'        : 'str',
1646             'server'    : ['VncServerInfo2'],
1647             'clients'   : ['VncClientInfo'],
1648             'auth'      : 'VncPrimaryAuth',
1649             '*vencrypt' : 'VncVencryptSubAuth',
1650             '*display'  : 'str' } }
1653 # @query-vnc:
1655 # Returns information about the current VNC server
1657 # Returns: @VncInfo
1659 # Since: 0.14.0
1661 # Example:
1663 # -> { "execute": "query-vnc" }
1664 # <- { "return": {
1665 #          "enabled":true,
1666 #          "host":"0.0.0.0",
1667 #          "service":"50402",
1668 #          "auth":"vnc",
1669 #          "family":"ipv4",
1670 #          "clients":[
1671 #             {
1672 #                "host":"127.0.0.1",
1673 #                "service":"50401",
1674 #                "family":"ipv4"
1675 #             }
1676 #          ]
1677 #       }
1678 #    }
1681 { 'command': 'query-vnc', 'returns': 'VncInfo' }
1684 # @query-vnc-servers:
1686 # Returns a list of vnc servers.  The list can be empty.
1688 # Returns: a list of @VncInfo2
1690 # Since: 2.3
1692 { 'command': 'query-vnc-servers', 'returns': ['VncInfo2'] }
1695 # @SpiceBasicInfo:
1697 # The basic information for SPICE network connection
1699 # @host: IP address
1701 # @port: port number
1703 # @family: address family
1705 # Since: 2.1
1707 { 'struct': 'SpiceBasicInfo',
1708   'data': { 'host': 'str',
1709             'port': 'str',
1710             'family': 'NetworkAddressFamily' } }
1713 # @SpiceServerInfo:
1715 # Information about a SPICE server
1717 # @auth: #optional authentication method
1719 # Since: 2.1
1721 { 'struct': 'SpiceServerInfo',
1722   'base': 'SpiceBasicInfo',
1723   'data': { '*auth': 'str' } }
1726 # @SpiceChannel:
1728 # Information about a SPICE client channel.
1730 # @connection-id: SPICE connection id number.  All channels with the same id
1731 #                 belong to the same SPICE session.
1733 # @channel-type: SPICE channel type number.  "1" is the main control
1734 #                channel, filter for this one if you want to track spice
1735 #                sessions only
1737 # @channel-id: SPICE channel ID number.  Usually "0", might be different when
1738 #              multiple channels of the same type exist, such as multiple
1739 #              display channels in a multihead setup
1741 # @tls: true if the channel is encrypted, false otherwise.
1743 # Since: 0.14.0
1745 { 'struct': 'SpiceChannel',
1746   'base': 'SpiceBasicInfo',
1747   'data': {'connection-id': 'int', 'channel-type': 'int', 'channel-id': 'int',
1748            'tls': 'bool'} }
1751 # @SpiceQueryMouseMode:
1753 # An enumeration of Spice mouse states.
1755 # @client: Mouse cursor position is determined by the client.
1757 # @server: Mouse cursor position is determined by the server.
1759 # @unknown: No information is available about mouse mode used by
1760 #           the spice server.
1762 # Note: spice/enums.h has a SpiceMouseMode already, hence the name.
1764 # Since: 1.1
1766 { 'enum': 'SpiceQueryMouseMode',
1767   'data': [ 'client', 'server', 'unknown' ] }
1770 # @SpiceInfo:
1772 # Information about the SPICE session.
1774 # @enabled: true if the SPICE server is enabled, false otherwise
1776 # @migrated: true if the last guest migration completed and spice
1777 #            migration had completed as well. false otherwise. (since 1.4)
1779 # @host: #optional The hostname the SPICE server is bound to.  This depends on
1780 #        the name resolution on the host and may be an IP address.
1782 # @port: #optional The SPICE server's port number.
1784 # @compiled-version: #optional SPICE server version.
1786 # @tls-port: #optional The SPICE server's TLS port number.
1788 # @auth: #optional the current authentication type used by the server
1789 #        'none'  if no authentication is being used
1790 #        'spice' uses SASL or direct TLS authentication, depending on command
1791 #                line options
1793 # @mouse-mode: The mode in which the mouse cursor is displayed currently. Can
1794 #              be determined by the client or the server, or unknown if spice
1795 #              server doesn't provide this information. (since: 1.1)
1797 # @channels: a list of @SpiceChannel for each active spice channel
1799 # Since: 0.14.0
1801 { 'struct': 'SpiceInfo',
1802   'data': {'enabled': 'bool', 'migrated': 'bool', '*host': 'str', '*port': 'int',
1803            '*tls-port': 'int', '*auth': 'str', '*compiled-version': 'str',
1804            'mouse-mode': 'SpiceQueryMouseMode', '*channels': ['SpiceChannel']} }
1807 # @query-spice:
1809 # Returns information about the current SPICE server
1811 # Returns: @SpiceInfo
1813 # Since: 0.14.0
1815 # Example:
1817 # -> { "execute": "query-spice" }
1818 # <- { "return": {
1819 #          "enabled": true,
1820 #          "auth": "spice",
1821 #          "port": 5920,
1822 #          "tls-port": 5921,
1823 #          "host": "0.0.0.0",
1824 #          "channels": [
1825 #             {
1826 #                "port": "54924",
1827 #                "family": "ipv4",
1828 #                "channel-type": 1,
1829 #                "connection-id": 1804289383,
1830 #                "host": "127.0.0.1",
1831 #                "channel-id": 0,
1832 #                "tls": true
1833 #             },
1834 #             {
1835 #                "port": "36710",
1836 #                "family": "ipv4",
1837 #                "channel-type": 4,
1838 #                "connection-id": 1804289383,
1839 #                "host": "127.0.0.1",
1840 #                "channel-id": 0,
1841 #                "tls": false
1842 #             },
1843 #             [ ... more channels follow ... ]
1844 #          ]
1845 #       }
1846 #    }
1849 { 'command': 'query-spice', 'returns': 'SpiceInfo' }
1852 # @BalloonInfo:
1854 # Information about the guest balloon device.
1856 # @actual: the number of bytes the balloon currently contains
1858 # Since: 0.14.0
1861 { 'struct': 'BalloonInfo', 'data': {'actual': 'int' } }
1864 # @query-balloon:
1866 # Return information about the balloon device.
1868 # Returns: @BalloonInfo on success
1870 #          If the balloon driver is enabled but not functional because the KVM
1871 #          kernel module cannot support it, KvmMissingCap
1873 #          If no balloon device is present, DeviceNotActive
1875 # Since: 0.14.0
1877 # Example:
1879 # -> { "execute": "query-balloon" }
1880 # <- { "return": {
1881 #          "actual": 1073741824,
1882 #       }
1883 #    }
1886 { 'command': 'query-balloon', 'returns': 'BalloonInfo' }
1889 # @PciMemoryRange:
1891 # A PCI device memory region
1893 # @base: the starting address (guest physical)
1895 # @limit: the ending address (guest physical)
1897 # Since: 0.14.0
1899 { 'struct': 'PciMemoryRange', 'data': {'base': 'int', 'limit': 'int'} }
1902 # @PciMemoryRegion:
1904 # Information about a PCI device I/O region.
1906 # @bar: the index of the Base Address Register for this region
1908 # @type: 'io' if the region is a PIO region
1909 #        'memory' if the region is a MMIO region
1911 # @size: memory size
1913 # @prefetch: #optional if @type is 'memory', true if the memory is prefetchable
1915 # @mem_type_64: #optional if @type is 'memory', true if the BAR is 64-bit
1917 # Since: 0.14.0
1919 { 'struct': 'PciMemoryRegion',
1920   'data': {'bar': 'int', 'type': 'str', 'address': 'int', 'size': 'int',
1921            '*prefetch': 'bool', '*mem_type_64': 'bool' } }
1924 # @PciBusInfo:
1926 # Information about a bus of a PCI Bridge device
1928 # @number: primary bus interface number.  This should be the number of the
1929 #          bus the device resides on.
1931 # @secondary: secondary bus interface number.  This is the number of the
1932 #             main bus for the bridge
1934 # @subordinate: This is the highest number bus that resides below the
1935 #               bridge.
1937 # @io_range: The PIO range for all devices on this bridge
1939 # @memory_range: The MMIO range for all devices on this bridge
1941 # @prefetchable_range: The range of prefetchable MMIO for all devices on
1942 #                      this bridge
1944 # Since: 2.4
1946 { 'struct': 'PciBusInfo',
1947   'data': {'number': 'int', 'secondary': 'int', 'subordinate': 'int',
1948            'io_range': 'PciMemoryRange',
1949            'memory_range': 'PciMemoryRange',
1950            'prefetchable_range': 'PciMemoryRange' } }
1953 # @PciBridgeInfo:
1955 # Information about a PCI Bridge device
1957 # @bus: information about the bus the device resides on
1959 # @devices: a list of @PciDeviceInfo for each device on this bridge
1961 # Since: 0.14.0
1963 { 'struct': 'PciBridgeInfo',
1964   'data': {'bus': 'PciBusInfo', '*devices': ['PciDeviceInfo']} }
1967 # @PciDeviceClass:
1969 # Information about the Class of a PCI device
1971 # @desc: #optional a string description of the device's class
1973 # @class: the class code of the device
1975 # Since: 2.4
1977 { 'struct': 'PciDeviceClass',
1978   'data': {'*desc': 'str', 'class': 'int'} }
1981 # @PciDeviceId:
1983 # Information about the Id of a PCI device
1985 # @device: the PCI device id
1987 # @vendor: the PCI vendor id
1989 # Since: 2.4
1991 { 'struct': 'PciDeviceId',
1992   'data': {'device': 'int', 'vendor': 'int'} }
1995 # @PciDeviceInfo:
1997 # Information about a PCI device
1999 # @bus: the bus number of the device
2001 # @slot: the slot the device is located in
2003 # @function: the function of the slot used by the device
2005 # @class_info: the class of the device
2007 # @id: the PCI device id
2009 # @irq: #optional if an IRQ is assigned to the device, the IRQ number
2011 # @qdev_id: the device name of the PCI device
2013 # @pci_bridge: if the device is a PCI bridge, the bridge information
2015 # @regions: a list of the PCI I/O regions associated with the device
2017 # Notes: the contents of @class_info.desc are not stable and should only be
2018 #        treated as informational.
2020 # Since: 0.14.0
2022 { 'struct': 'PciDeviceInfo',
2023   'data': {'bus': 'int', 'slot': 'int', 'function': 'int',
2024            'class_info': 'PciDeviceClass', 'id': 'PciDeviceId',
2025            '*irq': 'int', 'qdev_id': 'str', '*pci_bridge': 'PciBridgeInfo',
2026            'regions': ['PciMemoryRegion']} }
2029 # @PciInfo:
2031 # Information about a PCI bus
2033 # @bus: the bus index
2035 # @devices: a list of devices on this bus
2037 # Since: 0.14.0
2039 { 'struct': 'PciInfo', 'data': {'bus': 'int', 'devices': ['PciDeviceInfo']} }
2042 # @query-pci:
2044 # Return information about the PCI bus topology of the guest.
2046 # Returns: a list of @PciInfo for each PCI bus. Each bus is
2047 # represented by a json-object, which has a key with a json-array of
2048 # all PCI devices attached to it. Each device is represented by a
2049 # json-object.
2051 # Since: 0.14.0
2053 # Example:
2055 # -> { "execute": "query-pci" }
2056 # <- { "return": [
2057 #          {
2058 #             "bus": 0,
2059 #             "devices": [
2060 #                {
2061 #                   "bus": 0,
2062 #                   "qdev_id": "",
2063 #                   "slot": 0,
2064 #                   "class_info": {
2065 #                      "class": 1536,
2066 #                      "desc": "Host bridge"
2067 #                   },
2068 #                   "id": {
2069 #                      "device": 32902,
2070 #                      "vendor": 4663
2071 #                   },
2072 #                   "function": 0,
2073 #                   "regions": [
2074 #                   ]
2075 #                },
2076 #                {
2077 #                   "bus": 0,
2078 #                   "qdev_id": "",
2079 #                   "slot": 1,
2080 #                   "class_info": {
2081 #                      "class": 1537,
2082 #                      "desc": "ISA bridge"
2083 #                   },
2084 #                   "id": {
2085 #                      "device": 32902,
2086 #                      "vendor": 28672
2087 #                   },
2088 #                   "function": 0,
2089 #                   "regions": [
2090 #                   ]
2091 #                },
2092 #                {
2093 #                   "bus": 0,
2094 #                   "qdev_id": "",
2095 #                   "slot": 1,
2096 #                   "class_info": {
2097 #                      "class": 257,
2098 #                      "desc": "IDE controller"
2099 #                   },
2100 #                   "id": {
2101 #                      "device": 32902,
2102 #                      "vendor": 28688
2103 #                   },
2104 #                   "function": 1,
2105 #                   "regions": [
2106 #                      {
2107 #                         "bar": 4,
2108 #                         "size": 16,
2109 #                         "address": 49152,
2110 #                         "type": "io"
2111 #                      }
2112 #                   ]
2113 #                },
2114 #                {
2115 #                   "bus": 0,
2116 #                   "qdev_id": "",
2117 #                   "slot": 2,
2118 #                   "class_info": {
2119 #                      "class": 768,
2120 #                      "desc": "VGA controller"
2121 #                   },
2122 #                   "id": {
2123 #                      "device": 4115,
2124 #                      "vendor": 184
2125 #                   },
2126 #                   "function": 0,
2127 #                   "regions": [
2128 #                      {
2129 #                         "prefetch": true,
2130 #                         "mem_type_64": false,
2131 #                         "bar": 0,
2132 #                         "size": 33554432,
2133 #                         "address": 4026531840,
2134 #                         "type": "memory"
2135 #                      },
2136 #                      {
2137 #                         "prefetch": false,
2138 #                         "mem_type_64": false,
2139 #                         "bar": 1,
2140 #                         "size": 4096,
2141 #                         "address": 4060086272,
2142 #                         "type": "memory"
2143 #                      },
2144 #                      {
2145 #                         "prefetch": false,
2146 #                         "mem_type_64": false,
2147 #                         "bar": 6,
2148 #                         "size": 65536,
2149 #                         "address": -1,
2150 #                         "type": "memory"
2151 #                      }
2152 #                   ]
2153 #                },
2154 #                {
2155 #                   "bus": 0,
2156 #                   "qdev_id": "",
2157 #                   "irq": 11,
2158 #                   "slot": 4,
2159 #                   "class_info": {
2160 #                      "class": 1280,
2161 #                      "desc": "RAM controller"
2162 #                   },
2163 #                   "id": {
2164 #                      "device": 6900,
2165 #                      "vendor": 4098
2166 #                   },
2167 #                   "function": 0,
2168 #                   "regions": [
2169 #                      {
2170 #                         "bar": 0,
2171 #                         "size": 32,
2172 #                         "address": 49280,
2173 #                         "type": "io"
2174 #                      }
2175 #                   ]
2176 #                }
2177 #             ]
2178 #          }
2179 #       ]
2180 #    }
2182 # Note: This example has been shortened as the real response is too long.
2185 { 'command': 'query-pci', 'returns': ['PciInfo'] }
2188 # @quit:
2190 # This command will cause the QEMU process to exit gracefully.  While every
2191 # attempt is made to send the QMP response before terminating, this is not
2192 # guaranteed.  When using this interface, a premature EOF would not be
2193 # unexpected.
2195 # Since: 0.14.0
2197 # Example:
2199 # -> { "execute": "quit" }
2200 # <- { "return": {} }
2202 { 'command': 'quit' }
2205 # @stop:
2207 # Stop all guest VCPU execution.
2209 # Since:  0.14.0
2211 # Notes:  This function will succeed even if the guest is already in the stopped
2212 #         state.  In "inmigrate" state, it will ensure that the guest
2213 #         remains paused once migration finishes, as if the -S option was
2214 #         passed on the command line.
2216 # Example:
2218 # -> { "execute": "stop" }
2219 # <- { "return": {} }
2222 { 'command': 'stop' }
2225 # @system_reset:
2227 # Performs a hard reset of a guest.
2229 # Since: 0.14.0
2231 # Example:
2233 # -> { "execute": "system_reset" }
2234 # <- { "return": {} }
2237 { 'command': 'system_reset' }
2240 # @system_powerdown:
2242 # Requests that a guest perform a powerdown operation.
2244 # Since: 0.14.0
2246 # Notes: A guest may or may not respond to this command.  This command
2247 #        returning does not indicate that a guest has accepted the request or
2248 #        that it has shut down.  Many guests will respond to this command by
2249 #        prompting the user in some way.
2250 # Example:
2252 # -> { "execute": "system_powerdown" }
2253 # <- { "return": {} }
2256 { 'command': 'system_powerdown' }
2259 # @cpu:
2261 # This command is a nop that is only provided for the purposes of compatibility.
2263 # Since: 0.14.0
2265 # Notes: Do not use this command.
2267 { 'command': 'cpu', 'data': {'index': 'int'} }
2270 # @cpu-add:
2272 # Adds CPU with specified ID
2274 # @id: ID of CPU to be created, valid values [0..max_cpus)
2276 # Returns: Nothing on success
2278 # Since: 1.5
2280 # Example:
2282 # -> { "execute": "cpu-add", "arguments": { "id": 2 } }
2283 # <- { "return": {} }
2286 { 'command': 'cpu-add', 'data': {'id': 'int'} }
2289 # @memsave:
2291 # Save a portion of guest memory to a file.
2293 # @val: the virtual address of the guest to start from
2295 # @size: the size of memory region to save
2297 # @filename: the file to save the memory to as binary data
2299 # @cpu-index: #optional the index of the virtual CPU to use for translating the
2300 #                       virtual address (defaults to CPU 0)
2302 # Returns: Nothing on success
2304 # Since: 0.14.0
2306 # Notes: Errors were not reliably returned until 1.1
2308 # Example:
2310 # -> { "execute": "memsave",
2311 #      "arguments": { "val": 10,
2312 #                     "size": 100,
2313 #                     "filename": "/tmp/virtual-mem-dump" } }
2314 # <- { "return": {} }
2317 { 'command': 'memsave',
2318   'data': {'val': 'int', 'size': 'int', 'filename': 'str', '*cpu-index': 'int'} }
2321 # @pmemsave:
2323 # Save a portion of guest physical memory to a file.
2325 # @val: the physical address of the guest to start from
2327 # @size: the size of memory region to save
2329 # @filename: the file to save the memory to as binary data
2331 # Returns: Nothing on success
2333 # Since: 0.14.0
2335 # Notes: Errors were not reliably returned until 1.1
2337 # Example:
2339 # -> { "execute": "pmemsave",
2340 #      "arguments": { "val": 10,
2341 #                     "size": 100,
2342 #                     "filename": "/tmp/physical-mem-dump" } }
2343 # <- { "return": {} }
2346 { 'command': 'pmemsave',
2347   'data': {'val': 'int', 'size': 'int', 'filename': 'str'} }
2350 # @cont:
2352 # Resume guest VCPU execution.
2354 # Since:  0.14.0
2356 # Returns:  If successful, nothing
2357 #           If QEMU was started with an encrypted block device and a key has
2358 #              not yet been set, DeviceEncrypted.
2360 # Notes:  This command will succeed if the guest is currently running.  It
2361 #         will also succeed if the guest is in the "inmigrate" state; in
2362 #         this case, the effect of the command is to make sure the guest
2363 #         starts once migration finishes, removing the effect of the -S
2364 #         command line option if it was passed.
2366 # Example:
2368 # -> { "execute": "cont" }
2369 # <- { "return": {} }
2372 { 'command': 'cont' }
2375 # @system_wakeup:
2377 # Wakeup guest from suspend.  Does nothing in case the guest isn't suspended.
2379 # Since:  1.1
2381 # Returns:  nothing.
2383 # Example:
2385 # -> { "execute": "system_wakeup" }
2386 # <- { "return": {} }
2389 { 'command': 'system_wakeup' }
2392 # @inject-nmi:
2394 # Injects a Non-Maskable Interrupt into the default CPU (x86/s390) or all CPUs (ppc64).
2395 # The command fails when the guest doesn't support injecting.
2397 # Returns:  If successful, nothing
2399 # Since:  0.14.0
2401 # Note: prior to 2.1, this command was only supported for x86 and s390 VMs
2403 # Example:
2405 # -> { "execute": "inject-nmi" }
2406 # <- { "return": {} }
2409 { 'command': 'inject-nmi' }
2412 # @set_link:
2414 # Sets the link status of a virtual network adapter.
2416 # @name: the device name of the virtual network adapter
2418 # @up: true to set the link status to be up
2420 # Returns: Nothing on success
2421 #          If @name is not a valid network device, DeviceNotFound
2423 # Since: 0.14.0
2425 # Notes: Not all network adapters support setting link status.  This command
2426 #        will succeed even if the network adapter does not support link status
2427 #        notification.
2429 # Example:
2431 # -> { "execute": "set_link",
2432 #      "arguments": { "name": "e1000.0", "up": false } }
2433 # <- { "return": {} }
2436 { 'command': 'set_link', 'data': {'name': 'str', 'up': 'bool'} }
2439 # @balloon:
2441 # Request the balloon driver to change its balloon size.
2443 # @value: the target size of the balloon in bytes
2445 # Returns: Nothing on success
2446 #          If the balloon driver is enabled but not functional because the KVM
2447 #            kernel module cannot support it, KvmMissingCap
2448 #          If no balloon device is present, DeviceNotActive
2450 # Notes: This command just issues a request to the guest.  When it returns,
2451 #        the balloon size may not have changed.  A guest can change the balloon
2452 #        size independent of this command.
2454 # Since: 0.14.0
2456 # Example:
2458 # -> { "execute": "balloon", "arguments": { "value": 536870912 } }
2459 # <- { "return": {} }
2462 { 'command': 'balloon', 'data': {'value': 'int'} }
2465 # @Abort:
2467 # This action can be used to test transaction failure.
2469 # Since: 1.6
2471 { 'struct': 'Abort',
2472   'data': { } }
2475 # @ActionCompletionMode:
2477 # An enumeration of Transactional completion modes.
2479 # @individual: Do not attempt to cancel any other Actions if any Actions fail
2480 #              after the Transaction request succeeds. All Actions that
2481 #              can complete successfully will do so without waiting on others.
2482 #              This is the default.
2484 # @grouped: If any Action fails after the Transaction succeeds, cancel all
2485 #           Actions. Actions do not complete until all Actions are ready to
2486 #           complete. May be rejected by Actions that do not support this
2487 #           completion mode.
2489 # Since: 2.5
2491 { 'enum': 'ActionCompletionMode',
2492   'data': [ 'individual', 'grouped' ] }
2495 # @TransactionAction:
2497 # A discriminated record of operations that can be performed with
2498 # @transaction. Action @type can be:
2500 # - @abort: since 1.6
2501 # - @block-dirty-bitmap-add: since 2.5
2502 # - @block-dirty-bitmap-clear: since 2.5
2503 # - @blockdev-backup: since 2.3
2504 # - @blockdev-snapshot: since 2.5
2505 # - @blockdev-snapshot-internal-sync: since 1.7
2506 # - @blockdev-snapshot-sync: since 1.1
2507 # - @drive-backup: since 1.6
2509 # Since: 1.1
2511 { 'union': 'TransactionAction',
2512   'data': {
2513        'abort': 'Abort',
2514        'block-dirty-bitmap-add': 'BlockDirtyBitmapAdd',
2515        'block-dirty-bitmap-clear': 'BlockDirtyBitmap',
2516        'blockdev-backup': 'BlockdevBackup',
2517        'blockdev-snapshot': 'BlockdevSnapshot',
2518        'blockdev-snapshot-internal-sync': 'BlockdevSnapshotInternal',
2519        'blockdev-snapshot-sync': 'BlockdevSnapshotSync',
2520        'drive-backup': 'DriveBackup'
2521    } }
2524 # @TransactionProperties:
2526 # Optional arguments to modify the behavior of a Transaction.
2528 # @completion-mode: #optional Controls how jobs launched asynchronously by
2529 #                   Actions will complete or fail as a group.
2530 #                   See @ActionCompletionMode for details.
2532 # Since: 2.5
2534 { 'struct': 'TransactionProperties',
2535   'data': {
2536        '*completion-mode': 'ActionCompletionMode'
2537   }
2541 # @transaction:
2543 # Executes a number of transactionable QMP commands atomically. If any
2544 # operation fails, then the entire set of actions will be abandoned and the
2545 # appropriate error returned.
2547 # For external snapshots, the dictionary contains the device, the file to use for
2548 # the new snapshot, and the format.  The default format, if not specified, is
2549 # qcow2.
2551 # Each new snapshot defaults to being created by QEMU (wiping any
2552 # contents if the file already exists), but it is also possible to reuse
2553 # an externally-created file.  In the latter case, you should ensure that
2554 # the new image file has the same contents as the current one; QEMU cannot
2555 # perform any meaningful check.  Typically this is achieved by using the
2556 # current image file as the backing file for the new image.
2558 # On failure, the original disks pre-snapshot attempt will be used.
2560 # For internal snapshots, the dictionary contains the device and the snapshot's
2561 # name.  If an internal snapshot matching name already exists, the request will
2562 # be rejected.  Only some image formats support it, for example, qcow2, rbd,
2563 # and sheepdog.
2565 # On failure, qemu will try delete the newly created internal snapshot in the
2566 # transaction.  When an I/O error occurs during deletion, the user needs to fix
2567 # it later with qemu-img or other command.
2569 # @actions: List of @TransactionAction;
2570 #           information needed for the respective operations.
2572 # @properties: #optional structure of additional options to control the
2573 #              execution of the transaction. See @TransactionProperties
2574 #              for additional detail.
2576 # Returns: nothing on success
2578 #          Errors depend on the operations of the transaction
2580 # Note: The transaction aborts on the first failure.  Therefore, there will be
2581 # information on only one failed operation returned in an error condition, and
2582 # subsequent actions will not have been attempted.
2584 # Since: 1.1
2586 # Example:
2588 # -> { "execute": "transaction",
2589 #      "arguments": { "actions": [
2590 #          { "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd0",
2591 #                                      "snapshot-file": "/some/place/my-image",
2592 #                                      "format": "qcow2" } },
2593 #          { "type": "blockdev-snapshot-sync", "data" : { "node-name": "myfile",
2594 #                                      "snapshot-file": "/some/place/my-image2",
2595 #                                      "snapshot-node-name": "node3432",
2596 #                                      "mode": "existing",
2597 #                                      "format": "qcow2" } },
2598 #          { "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd1",
2599 #                                      "snapshot-file": "/some/place/my-image2",
2600 #                                      "mode": "existing",
2601 #                                      "format": "qcow2" } },
2602 #          { "type": "blockdev-snapshot-internal-sync", "data" : {
2603 #                                      "device": "ide-hd2",
2604 #                                      "name": "snapshot0" } } ] } }
2605 # <- { "return": {} }
2608 { 'command': 'transaction',
2609   'data': { 'actions': [ 'TransactionAction' ],
2610             '*properties': 'TransactionProperties'
2611           }
2615 # @human-monitor-command:
2617 # Execute a command on the human monitor and return the output.
2619 # @command-line: the command to execute in the human monitor
2621 # @cpu-index: #optional The CPU to use for commands that require an implicit CPU
2623 # Returns: the output of the command as a string
2625 # Since: 0.14.0
2627 # Notes: This command only exists as a stop-gap.  Its use is highly
2628 #        discouraged.  The semantics of this command are not
2629 #        guaranteed: this means that command names, arguments and
2630 #        responses can change or be removed at ANY time.  Applications
2631 #        that rely on long term stability guarantees should NOT
2632 #        use this command.
2634 #        Known limitations:
2636 #        * This command is stateless, this means that commands that depend
2637 #          on state information (such as getfd) might not work
2639 #        * Commands that prompt the user for data (eg. 'cont' when the block
2640 #          device is encrypted) don't currently work
2642 # Example:
2644 # -> { "execute": "human-monitor-command",
2645 #      "arguments": { "command-line": "info kvm" } }
2646 # <- { "return": "kvm support: enabled\r\n" }
2649 { 'command': 'human-monitor-command',
2650   'data': {'command-line': 'str', '*cpu-index': 'int'},
2651   'returns': 'str' }
2654 # @migrate_cancel:
2656 # Cancel the current executing migration process.
2658 # Returns: nothing on success
2660 # Notes: This command succeeds even if there is no migration process running.
2662 # Since: 0.14.0
2664 # Example:
2666 # -> { "execute": "migrate_cancel" }
2667 # <- { "return": {} }
2670 { 'command': 'migrate_cancel' }
2673 # @migrate_set_downtime:
2675 # Set maximum tolerated downtime for migration.
2677 # @value: maximum downtime in seconds
2679 # Returns: nothing on success
2681 # Notes: This command is deprecated in favor of 'migrate-set-parameters'
2683 # Since: 0.14.0
2685 # Example:
2687 # -> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } }
2688 # <- { "return": {} }
2691 { 'command': 'migrate_set_downtime', 'data': {'value': 'number'} }
2694 # @migrate_set_speed:
2696 # Set maximum speed for migration.
2698 # @value: maximum speed in bytes per second.
2700 # Returns: nothing on success
2702 # Notes: This command is deprecated in favor of 'migrate-set-parameters'
2704 # Since: 0.14.0
2706 # Example:
2708 # -> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } }
2709 # <- { "return": {} }
2712 { 'command': 'migrate_set_speed', 'data': {'value': 'int'} }
2715 # @migrate-set-cache-size:
2717 # Set cache size to be used by XBZRLE migration
2719 # @value: cache size in bytes
2721 # The size will be rounded down to the nearest power of 2.
2722 # The cache size can be modified before and during ongoing migration
2724 # Returns: nothing on success
2726 # Since: 1.2
2728 # Example:
2730 # -> { "execute": "migrate-set-cache-size",
2731 #      "arguments": { "value": 536870912 } }
2732 # <- { "return": {} }
2735 { 'command': 'migrate-set-cache-size', 'data': {'value': 'int'} }
2738 # @query-migrate-cache-size:
2740 # Query migration XBZRLE cache size
2742 # Returns: XBZRLE cache size in bytes
2744 # Since: 1.2
2746 # Example:
2748 # -> { "execute": "query-migrate-cache-size" }
2749 # <- { "return": 67108864 }
2752 { 'command': 'query-migrate-cache-size', 'returns': 'int' }
2755 # @ObjectPropertyInfo:
2757 # @name: the name of the property
2759 # @type: the type of the property.  This will typically come in one of four
2760 #        forms:
2762 #        1) A primitive type such as 'u8', 'u16', 'bool', 'str', or 'double'.
2763 #           These types are mapped to the appropriate JSON type.
2765 #        2) A child type in the form 'child<subtype>' where subtype is a qdev
2766 #           device type name.  Child properties create the composition tree.
2768 #        3) A link type in the form 'link<subtype>' where subtype is a qdev
2769 #           device type name.  Link properties form the device model graph.
2771 # Since: 1.2
2773 { 'struct': 'ObjectPropertyInfo',
2774   'data': { 'name': 'str', 'type': 'str' } }
2777 # @qom-list:
2779 # This command will list any properties of a object given a path in the object
2780 # model.
2782 # @path: the path within the object model.  See @qom-get for a description of
2783 #        this parameter.
2785 # Returns: a list of @ObjectPropertyInfo that describe the properties of the
2786 #          object.
2788 # Since: 1.2
2790 { 'command': 'qom-list',
2791   'data': { 'path': 'str' },
2792   'returns': [ 'ObjectPropertyInfo' ] }
2795 # @qom-get:
2797 # This command will get a property from a object model path and return the
2798 # value.
2800 # @path: The path within the object model.  There are two forms of supported
2801 #        paths--absolute and partial paths.
2803 #        Absolute paths are derived from the root object and can follow child<>
2804 #        or link<> properties.  Since they can follow link<> properties, they
2805 #        can be arbitrarily long.  Absolute paths look like absolute filenames
2806 #        and are prefixed  with a leading slash.
2808 #        Partial paths look like relative filenames.  They do not begin
2809 #        with a prefix.  The matching rules for partial paths are subtle but
2810 #        designed to make specifying objects easy.  At each level of the
2811 #        composition tree, the partial path is matched as an absolute path.
2812 #        The first match is not returned.  At least two matches are searched
2813 #        for.  A successful result is only returned if only one match is
2814 #        found.  If more than one match is found, a flag is return to
2815 #        indicate that the match was ambiguous.
2817 # @property: The property name to read
2819 # Returns: The property value.  The type depends on the property
2820 #          type. child<> and link<> properties are returned as #str
2821 #          pathnames.  All integer property types (u8, u16, etc) are
2822 #          returned as #int.
2824 # Since: 1.2
2826 { 'command': 'qom-get',
2827   'data': { 'path': 'str', 'property': 'str' },
2828   'returns': 'any' }
2831 # @qom-set:
2833 # This command will set a property from a object model path.
2835 # @path: see @qom-get for a description of this parameter
2837 # @property: the property name to set
2839 # @value: a value who's type is appropriate for the property type.  See @qom-get
2840 #         for a description of type mapping.
2842 # Since: 1.2
2844 { 'command': 'qom-set',
2845   'data': { 'path': 'str', 'property': 'str', 'value': 'any' } }
2848 # @set_password:
2850 # Sets the password of a remote display session.
2852 # @protocol: `vnc' to modify the VNC server password
2853 #            `spice' to modify the Spice server password
2855 # @password: the new password
2857 # @connected: #optional how to handle existing clients when changing the
2858 #                       password.  If nothing is specified, defaults to `keep'
2859 #                       `fail' to fail the command if clients are connected
2860 #                       `disconnect' to disconnect existing clients
2861 #                       `keep' to maintain existing clients
2863 # Returns: Nothing on success
2864 #          If Spice is not enabled, DeviceNotFound
2866 # Since: 0.14.0
2868 # Example:
2870 # -> { "execute": "set_password", "arguments": { "protocol": "vnc",
2871 #                                                "password": "secret" } }
2872 # <- { "return": {} }
2875 { 'command': 'set_password',
2876   'data': {'protocol': 'str', 'password': 'str', '*connected': 'str'} }
2879 # @expire_password:
2881 # Expire the password of a remote display server.
2883 # @protocol: the name of the remote display protocol `vnc' or `spice'
2885 # @time: when to expire the password.
2886 #        `now' to expire the password immediately
2887 #        `never' to cancel password expiration
2888 #        `+INT' where INT is the number of seconds from now (integer)
2889 #        `INT' where INT is the absolute time in seconds
2891 # Returns: Nothing on success
2892 #          If @protocol is `spice' and Spice is not active, DeviceNotFound
2894 # Since: 0.14.0
2896 # Notes: Time is relative to the server and currently there is no way to
2897 #        coordinate server time with client time.  It is not recommended to
2898 #        use the absolute time version of the @time parameter unless you're
2899 #        sure you are on the same machine as the QEMU instance.
2901 # Example:
2903 # -> { "execute": "expire_password", "arguments": { "protocol": "vnc",
2904 #                                                   "time": "+60" } }
2905 # <- { "return": {} }
2908 { 'command': 'expire_password', 'data': {'protocol': 'str', 'time': 'str'} }
2911 # @change-vnc-password:
2913 # Change the VNC server password.
2915 # @password:  the new password to use with VNC authentication
2917 # Since: 1.1
2919 # Notes:  An empty password in this command will set the password to the empty
2920 #         string.  Existing clients are unaffected by executing this command.
2922 { 'command': 'change-vnc-password', 'data': {'password': 'str'} }
2925 # @change:
2927 # This command is multiple commands multiplexed together.
2929 # @device: This is normally the name of a block device but it may also be 'vnc'.
2930 #          when it's 'vnc', then sub command depends on @target
2932 # @target: If @device is a block device, then this is the new filename.
2933 #          If @device is 'vnc', then if the value 'password' selects the vnc
2934 #          change password command.   Otherwise, this specifies a new server URI
2935 #          address to listen to for VNC connections.
2937 # @arg:    If @device is a block device, then this is an optional format to open
2938 #          the device with.
2939 #          If @device is 'vnc' and @target is 'password', this is the new VNC
2940 #          password to set.  If this argument is an empty string, then no future
2941 #          logins will be allowed.
2943 # Returns: Nothing on success.
2944 #          If @device is not a valid block device, DeviceNotFound
2945 #          If the new block device is encrypted, DeviceEncrypted.  Note that
2946 #          if this error is returned, the device has been opened successfully
2947 #          and an additional call to @block_passwd is required to set the
2948 #          device's password.  The behavior of reads and writes to the block
2949 #          device between when these calls are executed is undefined.
2951 # Notes:  This interface is deprecated, and it is strongly recommended that you
2952 #         avoid using it.  For changing block devices, use
2953 #         blockdev-change-medium; for changing VNC parameters, use
2954 #         change-vnc-password.
2956 # Since: 0.14.0
2958 # Example:
2960 # 1. Change a removable medium
2962 # -> { "execute": "change",
2963 #      "arguments": { "device": "ide1-cd0",
2964 #                     "target": "/srv/images/Fedora-12-x86_64-DVD.iso" } }
2965 # <- { "return": {} }
2967 # 2. Change VNC password
2969 # -> { "execute": "change",
2970 #      "arguments": { "device": "vnc", "target": "password",
2971 #                     "arg": "foobar1" } }
2972 # <- { "return": {} }
2975 { 'command': 'change',
2976   'data': {'device': 'str', 'target': 'str', '*arg': 'str'} }
2979 # @ObjectTypeInfo:
2981 # This structure describes a search result from @qom-list-types
2983 # @name: the type name found in the search
2985 # Since: 1.1
2987 # Notes: This command is experimental and may change syntax in future releases.
2989 { 'struct': 'ObjectTypeInfo',
2990   'data': { 'name': 'str' } }
2993 # @qom-list-types:
2995 # This command will return a list of types given search parameters
2997 # @implements: if specified, only return types that implement this type name
2999 # @abstract: if true, include abstract types in the results
3001 # Returns: a list of @ObjectTypeInfo or an empty list if no results are found
3003 # Since: 1.1
3005 { 'command': 'qom-list-types',
3006   'data': { '*implements': 'str', '*abstract': 'bool' },
3007   'returns': [ 'ObjectTypeInfo' ] }
3010 # @DevicePropertyInfo:
3012 # Information about device properties.
3014 # @name: the name of the property
3015 # @type: the typename of the property
3016 # @description: #optional if specified, the description of the property.
3017 #               (since 2.2)
3019 # Since: 1.2
3021 { 'struct': 'DevicePropertyInfo',
3022   'data': { 'name': 'str', 'type': 'str', '*description': 'str' } }
3025 # @device-list-properties:
3027 # List properties associated with a device.
3029 # @typename: the type name of a device
3031 # Returns: a list of DevicePropertyInfo describing a devices properties
3033 # Since: 1.2
3035 { 'command': 'device-list-properties',
3036   'data': { 'typename': 'str'},
3037   'returns': [ 'DevicePropertyInfo' ] }
3040 # @migrate:
3042 # Migrates the current running guest to another Virtual Machine.
3044 # @uri: the Uniform Resource Identifier of the destination VM
3046 # @blk: #optional do block migration (full disk copy)
3048 # @inc: #optional incremental disk copy migration
3050 # @detach: this argument exists only for compatibility reasons and
3051 #          is ignored by QEMU
3053 # Returns: nothing on success
3055 # Since: 0.14.0
3057 # Notes:
3059 # 1. The 'query-migrate' command should be used to check migration's progress
3060 #    and final result (this information is provided by the 'status' member)
3062 # 2. All boolean arguments default to false
3064 # 3. The user Monitor's "detach" argument is invalid in QMP and should not
3065 #    be used
3067 # Example:
3069 # -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
3070 # <- { "return": {} }
3073 { 'command': 'migrate',
3074   'data': {'uri': 'str', '*blk': 'bool', '*inc': 'bool', '*detach': 'bool' } }
3077 # @migrate-incoming:
3079 # Start an incoming migration, the qemu must have been started
3080 # with -incoming defer
3082 # @uri: The Uniform Resource Identifier identifying the source or
3083 #       address to listen on
3085 # Returns: nothing on success
3087 # Since: 2.3
3089 # Notes:
3091 # 1. It's a bad idea to use a string for the uri, but it needs to stay
3092 #    compatible with -incoming and the format of the uri is already exposed
3093 #    above libvirt.
3095 # 2. QEMU must be started with -incoming defer to allow migrate-incoming to
3096 #    be used.
3098 # 3. The uri format is the same as for -incoming
3100 # Example:
3102 # -> { "execute": "migrate-incoming",
3103 #      "arguments": { "uri": "tcp::4446" } }
3104 # <- { "return": {} }
3107 { 'command': 'migrate-incoming', 'data': {'uri': 'str' } }
3110 # @xen-save-devices-state:
3112 # Save the state of all devices to file. The RAM and the block devices
3113 # of the VM are not saved by this command.
3115 # @filename: the file to save the state of the devices to as binary
3116 # data. See xen-save-devices-state.txt for a description of the binary
3117 # format.
3119 # Returns: Nothing on success
3121 # Since: 1.1
3123 # Example:
3125 # -> { "execute": "xen-save-devices-state",
3126 #      "arguments": { "filename": "/tmp/save" } }
3127 # <- { "return": {} }
3130 { 'command': 'xen-save-devices-state', 'data': {'filename': 'str'} }
3133 # @xen-set-global-dirty-log:
3135 # Enable or disable the global dirty log mode.
3137 # @enable: true to enable, false to disable.
3139 # Returns: nothing
3141 # Since: 1.3
3143 # Example:
3145 # -> { "execute": "xen-set-global-dirty-log",
3146 #      "arguments": { "enable": true } }
3147 # <- { "return": {} }
3150 { 'command': 'xen-set-global-dirty-log', 'data': { 'enable': 'bool' } }
3153 # @device_add:
3155 # @driver: the name of the new device's driver
3157 # @bus: #optional the device's parent bus (device tree path)
3159 # @id: #optional the device's ID, must be unique
3161 # Additional arguments depend on the type.
3163 # Add a device.
3165 # Notes:
3166 # 1. For detailed information about this command, please refer to the
3167 #    'docs/qdev-device-use.txt' file.
3169 # 2. It's possible to list device properties by running QEMU with the
3170 #    "-device DEVICE,help" command-line argument, where DEVICE is the
3171 #    device's name
3173 # Example:
3175 # -> { "execute": "device_add",
3176 #      "arguments": { "driver": "e1000", "id": "net1",
3177 #                     "bus": "pci.0",
3178 #                     "mac": "52:54:00:12:34:56" } }
3179 # <- { "return": {} }
3181 # TODO: This command effectively bypasses QAPI completely due to its
3182 # "additional arguments" business.  It shouldn't have been added to
3183 # the schema in this form.  It should be qapified properly, or
3184 # replaced by a properly qapified command.
3186 # Since: 0.13
3188 { 'command': 'device_add',
3189   'data': {'driver': 'str', '*bus': 'str', '*id': 'str'},
3190   'gen': false } # so we can get the additional arguments
3193 # @device_del:
3195 # Remove a device from a guest
3197 # @id: the device's ID or QOM path
3199 # Returns: Nothing on success
3200 #          If @id is not a valid device, DeviceNotFound
3202 # Notes: When this command completes, the device may not be removed from the
3203 #        guest.  Hot removal is an operation that requires guest cooperation.
3204 #        This command merely requests that the guest begin the hot removal
3205 #        process.  Completion of the device removal process is signaled with a
3206 #        DEVICE_DELETED event. Guest reset will automatically complete removal
3207 #        for all devices.
3209 # Since: 0.14.0
3211 # Example:
3213 # -> { "execute": "device_del",
3214 #      "arguments": { "id": "net1" } }
3215 # <- { "return": {} }
3217 # -> { "execute": "device_del",
3218 #      "arguments": { "id": "/machine/peripheral-anon/device[0]" } }
3219 # <- { "return": {} }
3222 { 'command': 'device_del', 'data': {'id': 'str'} }
3225 # @DumpGuestMemoryFormat:
3227 # An enumeration of guest-memory-dump's format.
3229 # @elf: elf format
3231 # @kdump-zlib: kdump-compressed format with zlib-compressed
3233 # @kdump-lzo: kdump-compressed format with lzo-compressed
3235 # @kdump-snappy: kdump-compressed format with snappy-compressed
3237 # Since: 2.0
3239 { 'enum': 'DumpGuestMemoryFormat',
3240   'data': [ 'elf', 'kdump-zlib', 'kdump-lzo', 'kdump-snappy' ] }
3243 # @dump-guest-memory:
3245 # Dump guest's memory to vmcore. It is a synchronous operation that can take
3246 # very long depending on the amount of guest memory.
3248 # @paging: if true, do paging to get guest's memory mapping. This allows
3249 #          using gdb to process the core file.
3251 #          IMPORTANT: this option can make QEMU allocate several gigabytes
3252 #                     of RAM. This can happen for a large guest, or a
3253 #                     malicious guest pretending to be large.
3255 #          Also, paging=true has the following limitations:
3257 #             1. The guest may be in a catastrophic state or can have corrupted
3258 #                memory, which cannot be trusted
3259 #             2. The guest can be in real-mode even if paging is enabled. For
3260 #                example, the guest uses ACPI to sleep, and ACPI sleep state
3261 #                goes in real-mode
3262 #             3. Currently only supported on i386 and x86_64.
3264 # @protocol: the filename or file descriptor of the vmcore. The supported
3265 #            protocols are:
3267 #            1. file: the protocol starts with "file:", and the following
3268 #               string is the file's path.
3269 #            2. fd: the protocol starts with "fd:", and the following string
3270 #               is the fd's name.
3272 # @detach: #optional if true, QMP will return immediately rather than
3273 #          waiting for the dump to finish. The user can track progress
3274 #          using "query-dump". (since 2.6).
3276 # @begin: #optional if specified, the starting physical address.
3278 # @length: #optional if specified, the memory size, in bytes. If you don't
3279 #          want to dump all guest's memory, please specify the start @begin
3280 #          and @length
3282 # @format: #optional if specified, the format of guest memory dump. But non-elf
3283 #          format is conflict with paging and filter, ie. @paging, @begin and
3284 #          @length is not allowed to be specified with non-elf @format at the
3285 #          same time (since 2.0)
3287 # Note: All boolean arguments default to false
3289 # Returns: nothing on success
3291 # Since: 1.2
3293 # Example:
3295 # -> { "execute": "dump-guest-memory",
3296 #      "arguments": { "protocol": "fd:dump" } }
3297 # <- { "return": {} }
3300 { 'command': 'dump-guest-memory',
3301   'data': { 'paging': 'bool', 'protocol': 'str', '*detach': 'bool',
3302             '*begin': 'int', '*length': 'int',
3303             '*format': 'DumpGuestMemoryFormat'} }
3306 # @DumpStatus:
3308 # Describe the status of a long-running background guest memory dump.
3310 # @none: no dump-guest-memory has started yet.
3312 # @active: there is one dump running in background.
3314 # @completed: the last dump has finished successfully.
3316 # @failed: the last dump has failed.
3318 # Since: 2.6
3320 { 'enum': 'DumpStatus',
3321   'data': [ 'none', 'active', 'completed', 'failed' ] }
3324 # @DumpQueryResult:
3326 # The result format for 'query-dump'.
3328 # @status: enum of @DumpStatus, which shows current dump status
3330 # @completed: bytes written in latest dump (uncompressed)
3332 # @total: total bytes to be written in latest dump (uncompressed)
3334 # Since: 2.6
3336 { 'struct': 'DumpQueryResult',
3337   'data': { 'status': 'DumpStatus',
3338             'completed': 'int',
3339             'total': 'int' } }
3342 # @query-dump:
3344 # Query latest dump status.
3346 # Returns: A @DumpStatus object showing the dump status.
3348 # Since: 2.6
3350 # Example:
3352 # -> { "execute": "query-dump" }
3353 # <- { "return": { "status": "active", "completed": 1024000,
3354 #                  "total": 2048000 } }
3357 { 'command': 'query-dump', 'returns': 'DumpQueryResult' }
3360 # @DumpGuestMemoryCapability:
3362 # A list of the available formats for dump-guest-memory
3364 # Since: 2.0
3366 { 'struct': 'DumpGuestMemoryCapability',
3367   'data': {
3368       'formats': ['DumpGuestMemoryFormat'] } }
3371 # @query-dump-guest-memory-capability:
3373 # Returns the available formats for dump-guest-memory
3375 # Returns:  A @DumpGuestMemoryCapability object listing available formats for
3376 #           dump-guest-memory
3378 # Since: 2.0
3380 # Example:
3382 # -> { "execute": "query-dump-guest-memory-capability" }
3383 # <- { "return": { "formats":
3384 #                  ["elf", "kdump-zlib", "kdump-lzo", "kdump-snappy"] }
3387 { 'command': 'query-dump-guest-memory-capability',
3388   'returns': 'DumpGuestMemoryCapability' }
3391 # @dump-skeys:
3393 # Dump guest's storage keys
3395 # @filename: the path to the file to dump to
3397 # This command is only supported on s390 architecture.
3399 # Since: 2.5
3401 # Example:
3403 # -> { "execute": "dump-skeys",
3404 #      "arguments": { "filename": "/tmp/skeys" } }
3405 # <- { "return": {} }
3408 { 'command': 'dump-skeys',
3409   'data': { 'filename': 'str' } }
3412 # @netdev_add:
3414 # Add a network backend.
3416 # @type: the type of network backend.  Current valid values are 'user', 'tap',
3417 #        'vde', 'socket', 'dump' and 'bridge'
3419 # @id: the name of the new network backend
3421 # Additional arguments depend on the type.
3423 # TODO: This command effectively bypasses QAPI completely due to its
3424 # "additional arguments" business.  It shouldn't have been added to
3425 # the schema in this form.  It should be qapified properly, or
3426 # replaced by a properly qapified command.
3428 # Since: 0.14.0
3430 # Returns: Nothing on success
3431 #          If @type is not a valid network backend, DeviceNotFound
3433 # Example:
3435 # -> { "execute": "netdev_add",
3436 #      "arguments": { "type": "user", "id": "netdev1",
3437 #                     "dnssearch": "example.org" } }
3438 # <- { "return": {} }
3441 { 'command': 'netdev_add',
3442   'data': {'type': 'str', 'id': 'str'},
3443   'gen': false }                # so we can get the additional arguments
3446 # @netdev_del:
3448 # Remove a network backend.
3450 # @id: the name of the network backend to remove
3452 # Returns: Nothing on success
3453 #          If @id is not a valid network backend, DeviceNotFound
3455 # Since: 0.14.0
3457 # Example:
3459 # -> { "execute": "netdev_del", "arguments": { "id": "netdev1" } }
3460 # <- { "return": {} }
3463 { 'command': 'netdev_del', 'data': {'id': 'str'} }
3466 # @object-add:
3468 # Create a QOM object.
3470 # @qom-type: the class name for the object to be created
3472 # @id: the name of the new object
3474 # @props: #optional a dictionary of properties to be passed to the backend
3476 # Returns: Nothing on success
3477 #          Error if @qom-type is not a valid class name
3479 # Since: 2.0
3481 # Example:
3483 # -> { "execute": "object-add",
3484 #      "arguments": { "qom-type": "rng-random", "id": "rng1",
3485 #                     "props": { "filename": "/dev/hwrng" } } }
3486 # <- { "return": {} }
3489 { 'command': 'object-add',
3490   'data': {'qom-type': 'str', 'id': 'str', '*props': 'any'} }
3493 # @object-del:
3495 # Remove a QOM object.
3497 # @id: the name of the QOM object to remove
3499 # Returns: Nothing on success
3500 #          Error if @id is not a valid id for a QOM object
3502 # Since: 2.0
3504 # Example:
3506 # -> { "execute": "object-del", "arguments": { "id": "rng1" } }
3507 # <- { "return": {} }
3510 { 'command': 'object-del', 'data': {'id': 'str'} }
3513 # @NetdevNoneOptions:
3515 # Use it alone to have zero network devices.
3517 # Since: 1.2
3519 { 'struct': 'NetdevNoneOptions',
3520   'data': { } }
3523 # @NetLegacyNicOptions:
3525 # Create a new Network Interface Card.
3527 # @netdev: #optional id of -netdev to connect to
3529 # @macaddr: #optional MAC address
3531 # @model: #optional device model (e1000, rtl8139, virtio etc.)
3533 # @addr: #optional PCI device address
3535 # @vectors: #optional number of MSI-x vectors, 0 to disable MSI-X
3537 # Since: 1.2
3539 { 'struct': 'NetLegacyNicOptions',
3540   'data': {
3541     '*netdev':  'str',
3542     '*macaddr': 'str',
3543     '*model':   'str',
3544     '*addr':    'str',
3545     '*vectors': 'uint32' } }
3548 # @String:
3550 # A fat type wrapping 'str', to be embedded in lists.
3552 # Since: 1.2
3554 { 'struct': 'String',
3555   'data': {
3556     'str': 'str' } }
3559 # @NetdevUserOptions:
3561 # Use the user mode network stack which requires no administrator privilege to
3562 # run.
3564 # @hostname: #optional client hostname reported by the builtin DHCP server
3566 # @restrict: #optional isolate the guest from the host
3568 # @ipv4: #optional whether to support IPv4, default true for enabled
3569 #        (since 2.6)
3571 # @ipv6: #optional whether to support IPv6, default true for enabled
3572 #        (since 2.6)
3574 # @ip: #optional legacy parameter, use net= instead
3576 # @net: #optional IP network address that the guest will see, in the
3577 #       form addr[/netmask] The netmask is optional, and can be
3578 #       either in the form a.b.c.d or as a number of valid top-most
3579 #       bits. Default is 10.0.2.0/24.
3581 # @host: #optional guest-visible address of the host
3583 # @tftp: #optional root directory of the built-in TFTP server
3585 # @bootfile: #optional BOOTP filename, for use with tftp=
3587 # @dhcpstart: #optional the first of the 16 IPs the built-in DHCP server can
3588 #             assign
3590 # @dns: #optional guest-visible address of the virtual nameserver
3592 # @dnssearch: #optional list of DNS suffixes to search, passed as DHCP option
3593 #             to the guest
3595 # @ipv6-prefix: #optional IPv6 network prefix (default is fec0::) (since
3596 #               2.6). The network prefix is given in the usual
3597 #               hexadecimal IPv6 address notation.
3599 # @ipv6-prefixlen: #optional IPv6 network prefix length (default is 64)
3600 #                  (since 2.6)
3602 # @ipv6-host: #optional guest-visible IPv6 address of the host (since 2.6)
3604 # @ipv6-dns: #optional guest-visible IPv6 address of the virtual
3605 #            nameserver (since 2.6)
3607 # @smb: #optional root directory of the built-in SMB server
3609 # @smbserver: #optional IP address of the built-in SMB server
3611 # @hostfwd: #optional redirect incoming TCP or UDP host connections to guest
3612 #           endpoints
3614 # @guestfwd: #optional forward guest TCP connections
3616 # Since: 1.2
3618 { 'struct': 'NetdevUserOptions',
3619   'data': {
3620     '*hostname':  'str',
3621     '*restrict':  'bool',
3622     '*ipv4':      'bool',
3623     '*ipv6':      'bool',
3624     '*ip':        'str',
3625     '*net':       'str',
3626     '*host':      'str',
3627     '*tftp':      'str',
3628     '*bootfile':  'str',
3629     '*dhcpstart': 'str',
3630     '*dns':       'str',
3631     '*dnssearch': ['String'],
3632     '*ipv6-prefix':      'str',
3633     '*ipv6-prefixlen':   'int',
3634     '*ipv6-host':        'str',
3635     '*ipv6-dns':         'str',
3636     '*smb':       'str',
3637     '*smbserver': 'str',
3638     '*hostfwd':   ['String'],
3639     '*guestfwd':  ['String'] } }
3642 # @NetdevTapOptions:
3644 # Connect the host TAP network interface name to the VLAN.
3646 # @ifname: #optional interface name
3648 # @fd: #optional file descriptor of an already opened tap
3650 # @fds: #optional multiple file descriptors of already opened multiqueue capable
3651 # tap
3653 # @script: #optional script to initialize the interface
3655 # @downscript: #optional script to shut down the interface
3657 # @br: #optional bridge name (since 2.8)
3659 # @helper: #optional command to execute to configure bridge
3661 # @sndbuf: #optional send buffer limit. Understands [TGMKkb] suffixes.
3663 # @vnet_hdr: #optional enable the IFF_VNET_HDR flag on the tap interface
3665 # @vhost: #optional enable vhost-net network accelerator
3667 # @vhostfd: #optional file descriptor of an already opened vhost net device
3669 # @vhostfds: #optional file descriptors of multiple already opened vhost net
3670 # devices
3672 # @vhostforce: #optional vhost on for non-MSIX virtio guests
3674 # @queues: #optional number of queues to be created for multiqueue capable tap
3676 # @poll-us: #optional maximum number of microseconds that could
3677 # be spent on busy polling for tap (since 2.7)
3679 # Since: 1.2
3681 { 'struct': 'NetdevTapOptions',
3682   'data': {
3683     '*ifname':     'str',
3684     '*fd':         'str',
3685     '*fds':        'str',
3686     '*script':     'str',
3687     '*downscript': 'str',
3688     '*br':         'str',
3689     '*helper':     'str',
3690     '*sndbuf':     'size',
3691     '*vnet_hdr':   'bool',
3692     '*vhost':      'bool',
3693     '*vhostfd':    'str',
3694     '*vhostfds':   'str',
3695     '*vhostforce': 'bool',
3696     '*queues':     'uint32',
3697     '*poll-us':    'uint32'} }
3700 # @NetdevSocketOptions:
3702 # Connect the VLAN to a remote VLAN in another QEMU virtual machine using a TCP
3703 # socket connection.
3705 # @fd: #optional file descriptor of an already opened socket
3707 # @listen: #optional port number, and optional hostname, to listen on
3709 # @connect: #optional port number, and optional hostname, to connect to
3711 # @mcast: #optional UDP multicast address and port number
3713 # @localaddr: #optional source address and port for multicast and udp packets
3715 # @udp: #optional UDP unicast address and port number
3717 # Since: 1.2
3719 { 'struct': 'NetdevSocketOptions',
3720   'data': {
3721     '*fd':        'str',
3722     '*listen':    'str',
3723     '*connect':   'str',
3724     '*mcast':     'str',
3725     '*localaddr': 'str',
3726     '*udp':       'str' } }
3729 # @NetdevL2TPv3Options:
3731 # Connect the VLAN to Ethernet over L2TPv3 Static tunnel
3733 # @src: source address
3735 # @dst: destination address
3737 # @srcport: #optional source port - mandatory for udp, optional for ip
3739 # @dstport: #optional destination port - mandatory for udp, optional for ip
3741 # @ipv6: #optional - force the use of ipv6
3743 # @udp: #optional - use the udp version of l2tpv3 encapsulation
3745 # @cookie64: #optional - use 64 bit coookies
3747 # @counter: #optional have sequence counter
3749 # @pincounter: #optional pin sequence counter to zero -
3750 #              workaround for buggy implementations or
3751 #              networks with packet reorder
3753 # @txcookie: #optional 32 or 64 bit transmit cookie
3755 # @rxcookie: #optional 32 or 64 bit receive cookie
3757 # @txsession: 32 bit transmit session
3759 # @rxsession: #optional 32 bit receive session - if not specified
3760 #             set to the same value as transmit
3762 # @offset: #optional additional offset - allows the insertion of
3763 #          additional application-specific data before the packet payload
3765 # Since: 2.1
3767 { 'struct': 'NetdevL2TPv3Options',
3768   'data': {
3769     'src':          'str',
3770     'dst':          'str',
3771     '*srcport':     'str',
3772     '*dstport':     'str',
3773     '*ipv6':        'bool',
3774     '*udp':         'bool',
3775     '*cookie64':    'bool',
3776     '*counter':     'bool',
3777     '*pincounter':  'bool',
3778     '*txcookie':    'uint64',
3779     '*rxcookie':    'uint64',
3780     'txsession':    'uint32',
3781     '*rxsession':   'uint32',
3782     '*offset':      'uint32' } }
3785 # @NetdevVdeOptions:
3787 # Connect the VLAN to a vde switch running on the host.
3789 # @sock: #optional socket path
3791 # @port: #optional port number
3793 # @group: #optional group owner of socket
3795 # @mode: #optional permissions for socket
3797 # Since: 1.2
3799 { 'struct': 'NetdevVdeOptions',
3800   'data': {
3801     '*sock':  'str',
3802     '*port':  'uint16',
3803     '*group': 'str',
3804     '*mode':  'uint16' } }
3807 # @NetdevDumpOptions:
3809 # Dump VLAN network traffic to a file.
3811 # @len: #optional per-packet size limit (64k default). Understands [TGMKkb]
3812 # suffixes.
3814 # @file: #optional dump file path (default is qemu-vlan0.pcap)
3816 # Since: 1.2
3818 { 'struct': 'NetdevDumpOptions',
3819   'data': {
3820     '*len':  'size',
3821     '*file': 'str' } }
3824 # @NetdevBridgeOptions:
3826 # Connect a host TAP network interface to a host bridge device.
3828 # @br: #optional bridge name
3830 # @helper: #optional command to execute to configure bridge
3832 # Since: 1.2
3834 { 'struct': 'NetdevBridgeOptions',
3835   'data': {
3836     '*br':     'str',
3837     '*helper': 'str' } }
3840 # @NetdevHubPortOptions:
3842 # Connect two or more net clients through a software hub.
3844 # @hubid: hub identifier number
3846 # Since: 1.2
3848 { 'struct': 'NetdevHubPortOptions',
3849   'data': {
3850     'hubid':     'int32' } }
3853 # @NetdevNetmapOptions:
3855 # Connect a client to a netmap-enabled NIC or to a VALE switch port
3857 # @ifname: Either the name of an existing network interface supported by
3858 #          netmap, or the name of a VALE port (created on the fly).
3859 #          A VALE port name is in the form 'valeXXX:YYY', where XXX and
3860 #          YYY are non-negative integers. XXX identifies a switch and
3861 #          YYY identifies a port of the switch. VALE ports having the
3862 #          same XXX are therefore connected to the same switch.
3864 # @devname: #optional path of the netmap device (default: '/dev/netmap').
3866 # Since: 2.0
3868 { 'struct': 'NetdevNetmapOptions',
3869   'data': {
3870     'ifname':     'str',
3871     '*devname':    'str' } }
3874 # @NetdevVhostUserOptions:
3876 # Vhost-user network backend
3878 # @chardev: name of a unix socket chardev
3880 # @vhostforce: #optional vhost on for non-MSIX virtio guests (default: false).
3882 # @queues: #optional number of queues to be created for multiqueue vhost-user
3883 #          (default: 1) (Since 2.5)
3885 # Since: 2.1
3887 { 'struct': 'NetdevVhostUserOptions',
3888   'data': {
3889     'chardev':        'str',
3890     '*vhostforce':    'bool',
3891     '*queues':        'int' } }
3894 # @NetClientDriver:
3896 # Available netdev drivers.
3898 # Since: 2.7
3900 { 'enum': 'NetClientDriver',
3901   'data': [ 'none', 'nic', 'user', 'tap', 'l2tpv3', 'socket', 'vde', 'dump',
3902             'bridge', 'hubport', 'netmap', 'vhost-user' ] }
3905 # @Netdev:
3907 # Captures the configuration of a network device.
3909 # @id: identifier for monitor commands.
3911 # @type: Specify the driver used for interpreting remaining arguments.
3913 # Since: 1.2
3915 # 'l2tpv3' - since 2.1
3917 { 'union': 'Netdev',
3918   'base': { 'id': 'str', 'type': 'NetClientDriver' },
3919   'discriminator': 'type',
3920   'data': {
3921     'none':     'NetdevNoneOptions',
3922     'nic':      'NetLegacyNicOptions',
3923     'user':     'NetdevUserOptions',
3924     'tap':      'NetdevTapOptions',
3925     'l2tpv3':   'NetdevL2TPv3Options',
3926     'socket':   'NetdevSocketOptions',
3927     'vde':      'NetdevVdeOptions',
3928     'dump':     'NetdevDumpOptions',
3929     'bridge':   'NetdevBridgeOptions',
3930     'hubport':  'NetdevHubPortOptions',
3931     'netmap':   'NetdevNetmapOptions',
3932     'vhost-user': 'NetdevVhostUserOptions' } }
3935 # @NetLegacy:
3937 # Captures the configuration of a network device; legacy.
3939 # @vlan: #optional vlan number
3941 # @id: #optional identifier for monitor commands
3943 # @name: #optional identifier for monitor commands, ignored if @id is present
3945 # @opts: device type specific properties (legacy)
3947 # Since: 1.2
3949 { 'struct': 'NetLegacy',
3950   'data': {
3951     '*vlan': 'int32',
3952     '*id':   'str',
3953     '*name': 'str',
3954     'opts':  'NetLegacyOptions' } }
3957 # @NetLegacyOptions:
3959 # Like Netdev, but for use only by the legacy command line options
3961 # Since: 1.2
3963 { 'union': 'NetLegacyOptions',
3964   'data': {
3965     'none':     'NetdevNoneOptions',
3966     'nic':      'NetLegacyNicOptions',
3967     'user':     'NetdevUserOptions',
3968     'tap':      'NetdevTapOptions',
3969     'l2tpv3':   'NetdevL2TPv3Options',
3970     'socket':   'NetdevSocketOptions',
3971     'vde':      'NetdevVdeOptions',
3972     'dump':     'NetdevDumpOptions',
3973     'bridge':   'NetdevBridgeOptions',
3974     'netmap':   'NetdevNetmapOptions',
3975     'vhost-user': 'NetdevVhostUserOptions' } }
3978 # @NetFilterDirection:
3980 # Indicates whether a netfilter is attached to a netdev's transmit queue or
3981 # receive queue or both.
3983 # @all: the filter is attached both to the receive and the transmit
3984 #       queue of the netdev (default).
3986 # @rx: the filter is attached to the receive queue of the netdev,
3987 #      where it will receive packets sent to the netdev.
3989 # @tx: the filter is attached to the transmit queue of the netdev,
3990 #      where it will receive packets sent by the netdev.
3992 # Since: 2.5
3994 { 'enum': 'NetFilterDirection',
3995   'data': [ 'all', 'rx', 'tx' ] }
3998 # @InetSocketAddress:
4000 # Captures a socket address or address range in the Internet namespace.
4002 # @host: host part of the address
4004 # @port: port part of the address, or lowest port if @to is present
4006 # @numeric: #optional true if the host/port are guaranteed to be numeric,
4007 #           false if name resolution should be attempted. Defaults to false.
4008 #           (Since 2.9)
4010 # @to: highest port to try
4012 # @ipv4: whether to accept IPv4 addresses, default try both IPv4 and IPv6
4013 #        #optional
4015 # @ipv6: whether to accept IPv6 addresses, default try both IPv4 and IPv6
4016 #        #optional
4018 # Since: 1.3
4020 { 'struct': 'InetSocketAddress',
4021   'data': {
4022     'host': 'str',
4023     'port': 'str',
4024     '*numeric':  'bool',
4025     '*to': 'uint16',
4026     '*ipv4': 'bool',
4027     '*ipv6': 'bool' } }
4030 # @UnixSocketAddress:
4032 # Captures a socket address in the local ("Unix socket") namespace.
4034 # @path: filesystem path to use
4036 # Since: 1.3
4038 { 'struct': 'UnixSocketAddress',
4039   'data': {
4040     'path': 'str' } }
4043 # @VsockSocketAddress:
4045 # Captures a socket address in the vsock namespace.
4047 # @cid: unique host identifier
4048 # @port: port
4050 # Note: string types are used to allow for possible future hostname or
4051 # service resolution support.
4053 # Since: 2.8
4055 { 'struct': 'VsockSocketAddress',
4056   'data': {
4057     'cid': 'str',
4058     'port': 'str' } }
4061 # @SocketAddress:
4063 # Captures the address of a socket, which could also be a named file descriptor
4065 # Since: 1.3
4067 { 'union': 'SocketAddress',
4068   'data': {
4069     'inet': 'InetSocketAddress',
4070     'unix': 'UnixSocketAddress',
4071     'vsock': 'VsockSocketAddress',
4072     'fd': 'String' } }
4075 # @getfd:
4077 # Receive a file descriptor via SCM rights and assign it a name
4079 # @fdname: file descriptor name
4081 # Returns: Nothing on success
4083 # Since: 0.14.0
4085 # Notes: If @fdname already exists, the file descriptor assigned to
4086 #        it will be closed and replaced by the received file
4087 #        descriptor.
4089 #        The 'closefd' command can be used to explicitly close the
4090 #        file descriptor when it is no longer needed.
4092 # Example:
4094 # -> { "execute": "getfd", "arguments": { "fdname": "fd1" } }
4095 # <- { "return": {} }
4098 { 'command': 'getfd', 'data': {'fdname': 'str'} }
4101 # @closefd:
4103 # Close a file descriptor previously passed via SCM rights
4105 # @fdname: file descriptor name
4107 # Returns: Nothing on success
4109 # Since: 0.14.0
4111 # Example:
4113 # -> { "execute": "closefd", "arguments": { "fdname": "fd1" } }
4114 # <- { "return": {} }
4117 { 'command': 'closefd', 'data': {'fdname': 'str'} }
4120 # @MachineInfo:
4122 # Information describing a machine.
4124 # @name: the name of the machine
4126 # @alias: #optional an alias for the machine name
4128 # @is-default: #optional whether the machine is default
4130 # @cpu-max: maximum number of CPUs supported by the machine type
4131 #           (since 1.5.0)
4133 # @hotpluggable-cpus: cpu hotplug via -device is supported (since 2.7.0)
4135 # Since: 1.2.0
4137 { 'struct': 'MachineInfo',
4138   'data': { 'name': 'str', '*alias': 'str',
4139             '*is-default': 'bool', 'cpu-max': 'int',
4140             'hotpluggable-cpus': 'bool'} }
4143 # @query-machines:
4145 # Return a list of supported machines
4147 # Returns: a list of MachineInfo
4149 # Since: 1.2.0
4151 { 'command': 'query-machines', 'returns': ['MachineInfo'] }
4154 # @CpuDefinitionInfo:
4156 # Virtual CPU definition.
4158 # @name: the name of the CPU definition
4160 # @migration-safe: #optional whether a CPU definition can be safely used for
4161 #                  migration in combination with a QEMU compatibility machine
4162 #                  when migrating between different QMU versions and between
4163 #                  hosts with different sets of (hardware or software)
4164 #                  capabilities. If not provided, information is not available
4165 #                  and callers should not assume the CPU definition to be
4166 #                  migration-safe. (since 2.8)
4168 # @static: whether a CPU definition is static and will not change depending on
4169 #          QEMU version, machine type, machine options and accelerator options.
4170 #          A static model is always migration-safe. (since 2.8)
4172 # @unavailable-features: #optional List of properties that prevent
4173 #                        the CPU model from running in the current
4174 #                        host. (since 2.8)
4175 # @typename: Type name that can be used as argument to @device-list-properties,
4176 #            to introspect properties configurable using -cpu or -global.
4177 #            (since 2.9)
4179 # @unavailable-features is a list of QOM property names that
4180 # represent CPU model attributes that prevent the CPU from running.
4181 # If the QOM property is read-only, that means there's no known
4182 # way to make the CPU model run in the current host. Implementations
4183 # that choose not to provide specific information return the
4184 # property name "type".
4185 # If the property is read-write, it means that it MAY be possible
4186 # to run the CPU model in the current host if that property is
4187 # changed. Management software can use it as hints to suggest or
4188 # choose an alternative for the user, or just to generate meaningful
4189 # error messages explaining why the CPU model can't be used.
4190 # If @unavailable-features is an empty list, the CPU model is
4191 # runnable using the current host and machine-type.
4192 # If @unavailable-features is not present, runnability
4193 # information for the CPU is not available.
4195 # Since: 1.2.0
4197 { 'struct': 'CpuDefinitionInfo',
4198   'data': { 'name': 'str', '*migration-safe': 'bool', 'static': 'bool',
4199             '*unavailable-features': [ 'str' ], 'typename': 'str' } }
4202 # @query-cpu-definitions:
4204 # Return a list of supported virtual CPU definitions
4206 # Returns: a list of CpuDefInfo
4208 # Since: 1.2.0
4210 { 'command': 'query-cpu-definitions', 'returns': ['CpuDefinitionInfo'] }
4213 # @CpuModelInfo:
4215 # Virtual CPU model.
4217 # A CPU model consists of the name of a CPU definition, to which
4218 # delta changes are applied (e.g. features added/removed). Most magic values
4219 # that an architecture might require should be hidden behind the name.
4220 # However, if required, architectures can expose relevant properties.
4222 # @name: the name of the CPU definition the model is based on
4223 # @props: #optional a dictionary of QOM properties to be applied
4225 # Since: 2.8.0
4227 { 'struct': 'CpuModelInfo',
4228   'data': { 'name': 'str',
4229             '*props': 'any' } }
4232 # @CpuModelExpansionType:
4234 # An enumeration of CPU model expansion types.
4236 # @static: Expand to a static CPU model, a combination of a static base
4237 #          model name and property delta changes. As the static base model will
4238 #          never change, the expanded CPU model will be the same, independant of
4239 #          independent of QEMU version, machine type, machine options, and
4240 #          accelerator options. Therefore, the resulting model can be used by
4241 #          tooling without having to specify a compatibility machine - e.g. when
4242 #          displaying the "host" model. static CPU models are migration-safe.
4244 # @full: Expand all properties. The produced model is not guaranteed to be
4245 #        migration-safe, but allows tooling to get an insight and work with
4246 #        model details.
4248 # Since: 2.8.0
4250 { 'enum': 'CpuModelExpansionType',
4251   'data': [ 'static', 'full' ] }
4255 # @CpuModelExpansionInfo:
4257 # The result of a cpu model expansion.
4259 # @model: the expanded CpuModelInfo.
4261 # Since: 2.8.0
4263 { 'struct': 'CpuModelExpansionInfo',
4264   'data': { 'model': 'CpuModelInfo' } }
4268 # @query-cpu-model-expansion:
4270 # Expands a given CPU model (or a combination of CPU model + additional options)
4271 # to different granularities, allowing tooling to get an understanding what a
4272 # specific CPU model looks like in QEMU under a certain configuration.
4274 # This interface can be used to query the "host" CPU model.
4276 # The data returned by this command may be affected by:
4278 # * QEMU version: CPU models may look different depending on the QEMU version.
4279 #   (Except for CPU models reported as "static" in query-cpu-definitions.)
4280 # * machine-type: CPU model  may look different depending on the machine-type.
4281 #   (Except for CPU models reported as "static" in query-cpu-definitions.)
4282 # * machine options (including accelerator): in some architectures, CPU models
4283 #   may look different depending on machine and accelerator options. (Except for
4284 #   CPU models reported as "static" in query-cpu-definitions.)
4285 # * "-cpu" arguments and global properties: arguments to the -cpu option and
4286 #   global properties may affect expansion of CPU models. Using
4287 #   query-cpu-model-expansion while using these is not advised.
4289 # Some architectures may not support all expansion types. s390x supports
4290 # "full" and "static".
4292 # Returns: a CpuModelExpansionInfo. Returns an error if expanding CPU models is
4293 #          not supported, if the model cannot be expanded, if the model contains
4294 #          an unknown CPU definition name, unknown properties or properties
4295 #          with a wrong type. Also returns an error if an expansion type is
4296 #          not supported.
4298 # Since: 2.8.0
4300 { 'command': 'query-cpu-model-expansion',
4301   'data': { 'type': 'CpuModelExpansionType',
4302             'model': 'CpuModelInfo' },
4303   'returns': 'CpuModelExpansionInfo' }
4306 # @CpuModelCompareResult:
4308 # An enumeration of CPU model comparation results. The result is usually
4309 # calculated using e.g. CPU features or CPU generations.
4311 # @incompatible: If model A is incompatible to model B, model A is not
4312 #                guaranteed to run where model B runs and the other way around.
4314 # @identical: If model A is identical to model B, model A is guaranteed to run
4315 #             where model B runs and the other way around.
4317 # @superset: If model A is a superset of model B, model B is guaranteed to run
4318 #            where model A runs. There are no guarantees about the other way.
4320 # @subset: If model A is a subset of model B, model A is guaranteed to run
4321 #          where model B runs. There are no guarantees about the other way.
4323 # Since: 2.8.0
4325 { 'enum': 'CpuModelCompareResult',
4326   'data': [ 'incompatible', 'identical', 'superset', 'subset' ] }
4329 # @CpuModelCompareInfo:
4331 # The result of a CPU model comparison.
4333 # @result: The result of the compare operation.
4334 # @responsible-properties: List of properties that led to the comparison result
4335 #                          not being identical.
4337 # @responsible-properties is a list of QOM property names that led to
4338 # both CPUs not being detected as identical. For identical models, this
4339 # list is empty.
4340 # If a QOM property is read-only, that means there's no known way to make the
4341 # CPU models identical. If the special property name "type" is included, the
4342 # models are by definition not identical and cannot be made identical.
4344 # Since: 2.8.0
4346 { 'struct': 'CpuModelCompareInfo',
4347   'data': {'result': 'CpuModelCompareResult',
4348            'responsible-properties': ['str']
4349           }
4353 # @query-cpu-model-comparison:
4355 # Compares two CPU models, returning how they compare in a specific
4356 # configuration. The results indicates how both models compare regarding
4357 # runnability. This result can be used by tooling to make decisions if a
4358 # certain CPU model will run in a certain configuration or if a compatible
4359 # CPU model has to be created by baselining.
4361 # Usually, a CPU model is compared against the maximum possible CPU model
4362 # of a certain configuration (e.g. the "host" model for KVM). If that CPU
4363 # model is identical or a subset, it will run in that configuration.
4365 # The result returned by this command may be affected by:
4367 # * QEMU version: CPU models may look different depending on the QEMU version.
4368 #   (Except for CPU models reported as "static" in query-cpu-definitions.)
4369 # * machine-type: CPU model may look different depending on the machine-type.
4370 #   (Except for CPU models reported as "static" in query-cpu-definitions.)
4371 # * machine options (including accelerator): in some architectures, CPU models
4372 #   may look different depending on machine and accelerator options. (Except for
4373 #   CPU models reported as "static" in query-cpu-definitions.)
4374 # * "-cpu" arguments and global properties: arguments to the -cpu option and
4375 #   global properties may affect expansion of CPU models. Using
4376 #   query-cpu-model-expansion while using these is not advised.
4378 # Some architectures may not support comparing CPU models. s390x supports
4379 # comparing CPU models.
4381 # Returns: a CpuModelBaselineInfo. Returns an error if comparing CPU models is
4382 #          not supported, if a model cannot be used, if a model contains
4383 #          an unknown cpu definition name, unknown properties or properties
4384 #          with wrong types.
4386 # Since: 2.8.0
4388 { 'command': 'query-cpu-model-comparison',
4389   'data': { 'modela': 'CpuModelInfo', 'modelb': 'CpuModelInfo' },
4390   'returns': 'CpuModelCompareInfo' }
4393 # @CpuModelBaselineInfo:
4395 # The result of a CPU model baseline.
4397 # @model: the baselined CpuModelInfo.
4399 # Since: 2.8.0
4401 { 'struct': 'CpuModelBaselineInfo',
4402   'data': { 'model': 'CpuModelInfo' } }
4405 # @query-cpu-model-baseline:
4407 # Baseline two CPU models, creating a compatible third model. The created
4408 # model will always be a static, migration-safe CPU model (see "static"
4409 # CPU model expansion for details).
4411 # This interface can be used by tooling to create a compatible CPU model out
4412 # two CPU models. The created CPU model will be identical to or a subset of
4413 # both CPU models when comparing them. Therefore, the created CPU model is
4414 # guaranteed to run where the given CPU models run.
4416 # The result returned by this command may be affected by:
4418 # * QEMU version: CPU models may look different depending on the QEMU version.
4419 #   (Except for CPU models reported as "static" in query-cpu-definitions.)
4420 # * machine-type: CPU model may look different depending on the machine-type.
4421 #   (Except for CPU models reported as "static" in query-cpu-definitions.)
4422 # * machine options (including accelerator): in some architectures, CPU models
4423 #   may look different depending on machine and accelerator options. (Except for
4424 #   CPU models reported as "static" in query-cpu-definitions.)
4425 # * "-cpu" arguments and global properties: arguments to the -cpu option and
4426 #   global properties may affect expansion of CPU models. Using
4427 #   query-cpu-model-expansion while using these is not advised.
4429 # Some architectures may not support baselining CPU models. s390x supports
4430 # baselining CPU models.
4432 # Returns: a CpuModelBaselineInfo. Returns an error if baselining CPU models is
4433 #          not supported, if a model cannot be used, if a model contains
4434 #          an unknown cpu definition name, unknown properties or properties
4435 #          with wrong types.
4437 # Since: 2.8.0
4439 { 'command': 'query-cpu-model-baseline',
4440   'data': { 'modela': 'CpuModelInfo',
4441             'modelb': 'CpuModelInfo' },
4442   'returns': 'CpuModelBaselineInfo' }
4445 # @AddfdInfo:
4447 # Information about a file descriptor that was added to an fd set.
4449 # @fdset-id: The ID of the fd set that @fd was added to.
4451 # @fd: The file descriptor that was received via SCM rights and
4452 #      added to the fd set.
4454 # Since: 1.2.0
4456 { 'struct': 'AddfdInfo', 'data': {'fdset-id': 'int', 'fd': 'int'} }
4459 # @add-fd:
4461 # Add a file descriptor, that was passed via SCM rights, to an fd set.
4463 # @fdset-id: #optional The ID of the fd set to add the file descriptor to.
4465 # @opaque: #optional A free-form string that can be used to describe the fd.
4467 # Returns: @AddfdInfo on success
4469 #          If file descriptor was not received, FdNotSupplied
4471 #          If @fdset-id is a negative value, InvalidParameterValue
4473 # Notes: The list of fd sets is shared by all monitor connections.
4475 #        If @fdset-id is not specified, a new fd set will be created.
4477 # Since: 1.2.0
4479 # Example:
4481 # -> { "execute": "add-fd", "arguments": { "fdset-id": 1 } }
4482 # <- { "return": { "fdset-id": 1, "fd": 3 } }
4485 { 'command': 'add-fd', 'data': {'*fdset-id': 'int', '*opaque': 'str'},
4486   'returns': 'AddfdInfo' }
4489 # @remove-fd:
4491 # Remove a file descriptor from an fd set.
4493 # @fdset-id: The ID of the fd set that the file descriptor belongs to.
4495 # @fd: #optional The file descriptor that is to be removed.
4497 # Returns: Nothing on success
4498 #          If @fdset-id or @fd is not found, FdNotFound
4500 # Since: 1.2.0
4502 # Notes: The list of fd sets is shared by all monitor connections.
4504 #        If @fd is not specified, all file descriptors in @fdset-id
4505 #        will be removed.
4507 # Example:
4509 # -> { "execute": "remove-fd", "arguments": { "fdset-id": 1, "fd": 3 } }
4510 # <- { "return": {} }
4513 { 'command': 'remove-fd', 'data': {'fdset-id': 'int', '*fd': 'int'} }
4516 # @FdsetFdInfo:
4518 # Information about a file descriptor that belongs to an fd set.
4520 # @fd: The file descriptor value.
4522 # @opaque: #optional A free-form string that can be used to describe the fd.
4524 # Since: 1.2.0
4526 { 'struct': 'FdsetFdInfo',
4527   'data': {'fd': 'int', '*opaque': 'str'} }
4530 # @FdsetInfo:
4532 # Information about an fd set.
4534 # @fdset-id: The ID of the fd set.
4536 # @fds: A list of file descriptors that belong to this fd set.
4538 # Since: 1.2.0
4540 { 'struct': 'FdsetInfo',
4541   'data': {'fdset-id': 'int', 'fds': ['FdsetFdInfo']} }
4544 # @query-fdsets:
4546 # Return information describing all fd sets.
4548 # Returns: A list of @FdsetInfo
4550 # Since: 1.2.0
4552 # Note: The list of fd sets is shared by all monitor connections.
4554 # Example:
4556 # -> { "execute": "query-fdsets" }
4557 # <- { "return": [
4558 #        {
4559 #          "fds": [
4560 #            {
4561 #              "fd": 30,
4562 #              "opaque": "rdonly:/path/to/file"
4563 #            },
4564 #            {
4565 #              "fd": 24,
4566 #              "opaque": "rdwr:/path/to/file"
4567 #            }
4568 #          ],
4569 #          "fdset-id": 1
4570 #        },
4571 #        {
4572 #          "fds": [
4573 #            {
4574 #              "fd": 28
4575 #            },
4576 #            {
4577 #              "fd": 29
4578 #            }
4579 #          ],
4580 #          "fdset-id": 0
4581 #        }
4582 #      ]
4583 #    }
4586 { 'command': 'query-fdsets', 'returns': ['FdsetInfo'] }
4589 # @TargetInfo:
4591 # Information describing the QEMU target.
4593 # @arch: the target architecture (eg "x86_64", "i386", etc)
4595 # Since: 1.2.0
4597 { 'struct': 'TargetInfo',
4598   'data': { 'arch': 'str' } }
4601 # @query-target:
4603 # Return information about the target for this QEMU
4605 # Returns: TargetInfo
4607 # Since: 1.2.0
4609 { 'command': 'query-target', 'returns': 'TargetInfo' }
4612 # @QKeyCode:
4614 # An enumeration of key name.
4616 # This is used by the @send-key command.
4618 # @unmapped: since 2.0
4619 # @pause: since 2.0
4620 # @ro: since 2.4
4621 # @kp_comma: since 2.4
4622 # @kp_equals: since 2.6
4623 # @power: since 2.6
4624 # @hiragana: since 2.9
4625 # @henkan: since 2.9
4626 # @yen: since 2.9
4628 # Since: 1.3.0
4631 { 'enum': 'QKeyCode',
4632   'data': [ 'unmapped',
4633             'shift', 'shift_r', 'alt', 'alt_r', 'altgr', 'altgr_r', 'ctrl',
4634             'ctrl_r', 'menu', 'esc', '1', '2', '3', '4', '5', '6', '7', '8',
4635             '9', '0', 'minus', 'equal', 'backspace', 'tab', 'q', 'w', 'e',
4636             'r', 't', 'y', 'u', 'i', 'o', 'p', 'bracket_left', 'bracket_right',
4637             'ret', 'a', 's', 'd', 'f', 'g', 'h', 'j', 'k', 'l', 'semicolon',
4638             'apostrophe', 'grave_accent', 'backslash', 'z', 'x', 'c', 'v', 'b',
4639             'n', 'm', 'comma', 'dot', 'slash', 'asterisk', 'spc', 'caps_lock',
4640             'f1', 'f2', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9', 'f10',
4641             'num_lock', 'scroll_lock', 'kp_divide', 'kp_multiply',
4642             'kp_subtract', 'kp_add', 'kp_enter', 'kp_decimal', 'sysrq', 'kp_0',
4643             'kp_1', 'kp_2', 'kp_3', 'kp_4', 'kp_5', 'kp_6', 'kp_7', 'kp_8',
4644             'kp_9', 'less', 'f11', 'f12', 'print', 'home', 'pgup', 'pgdn', 'end',
4645             'left', 'up', 'down', 'right', 'insert', 'delete', 'stop', 'again',
4646             'props', 'undo', 'front', 'copy', 'open', 'paste', 'find', 'cut',
4647             'lf', 'help', 'meta_l', 'meta_r', 'compose', 'pause',
4648             'ro', 'hiragana', 'henkan', 'yen',
4649             'kp_comma', 'kp_equals', 'power' ] }
4652 # @KeyValue:
4654 # Represents a keyboard key.
4656 # Since: 1.3.0
4658 { 'union': 'KeyValue',
4659   'data': {
4660     'number': 'int',
4661     'qcode': 'QKeyCode' } }
4664 # @send-key:
4666 # Send keys to guest.
4668 # @keys: An array of @KeyValue elements. All @KeyValues in this array are
4669 #        simultaneously sent to the guest. A @KeyValue.number value is sent
4670 #        directly to the guest, while @KeyValue.qcode must be a valid
4671 #        @QKeyCode value
4673 # @hold-time: #optional time to delay key up events, milliseconds. Defaults
4674 #             to 100
4676 # Returns: Nothing on success
4677 #          If key is unknown or redundant, InvalidParameter
4679 # Since: 1.3.0
4681 # Example:
4683 # -> { "execute": "send-key",
4684 #      "arguments": { "keys": [ { "type": "qcode", "data": "ctrl" },
4685 #                               { "type": "qcode", "data": "alt" },
4686 #                               { "type": "qcode", "data": "delete" } ] } }
4687 # <- { "return": {} }
4690 { 'command': 'send-key',
4691   'data': { 'keys': ['KeyValue'], '*hold-time': 'int' } }
4694 # @screendump:
4696 # Write a PPM of the VGA screen to a file.
4698 # @filename: the path of a new PPM file to store the image
4700 # Returns: Nothing on success
4702 # Since: 0.14.0
4704 # Example:
4706 # -> { "execute": "screendump",
4707 #      "arguments": { "filename": "/tmp/image" } }
4708 # <- { "return": {} }
4711 { 'command': 'screendump', 'data': {'filename': 'str'} }
4715 # @ChardevCommon:
4717 # Configuration shared across all chardev backends
4719 # @logfile: #optional The name of a logfile to save output
4720 # @logappend: #optional true to append instead of truncate
4721 #             (default to false to truncate)
4723 # Since: 2.6
4725 { 'struct': 'ChardevCommon', 'data': { '*logfile': 'str',
4726                                        '*logappend': 'bool' } }
4729 # @ChardevFile:
4731 # Configuration info for file chardevs.
4733 # @in:  #optional The name of the input file
4734 # @out: The name of the output file
4735 # @append: #optional Open the file in append mode (default false to
4736 #          truncate) (Since 2.6)
4738 # Since: 1.4
4740 { 'struct': 'ChardevFile', 'data': { '*in' : 'str',
4741                                    'out' : 'str',
4742                                    '*append': 'bool' },
4743   'base': 'ChardevCommon' }
4746 # @ChardevHostdev:
4748 # Configuration info for device and pipe chardevs.
4750 # @device: The name of the special file for the device,
4751 #          i.e. /dev/ttyS0 on Unix or COM1: on Windows
4753 # Since: 1.4
4755 { 'struct': 'ChardevHostdev', 'data': { 'device' : 'str' },
4756   'base': 'ChardevCommon' }
4759 # @ChardevSocket:
4761 # Configuration info for (stream) socket chardevs.
4763 # @addr: socket address to listen on (server=true)
4764 #        or connect to (server=false)
4765 # @tls-creds: #optional the ID of the TLS credentials object (since 2.6)
4766 # @server: #optional create server socket (default: true)
4767 # @wait: #optional wait for incoming connection on server
4768 #        sockets (default: false).
4769 # @nodelay: #optional set TCP_NODELAY socket option (default: false)
4770 # @telnet: #optional enable telnet protocol on server
4771 #          sockets (default: false)
4772 # @reconnect: #optional For a client socket, if a socket is disconnected,
4773 #          then attempt a reconnect after the given number of seconds.
4774 #          Setting this to zero disables this function. (default: 0)
4775 #          (Since: 2.2)
4777 # Since: 1.4
4779 { 'struct': 'ChardevSocket', 'data': { 'addr'       : 'SocketAddress',
4780                                      '*tls-creds'  : 'str',
4781                                      '*server'    : 'bool',
4782                                      '*wait'      : 'bool',
4783                                      '*nodelay'   : 'bool',
4784                                      '*telnet'    : 'bool',
4785                                      '*reconnect' : 'int' },
4786   'base': 'ChardevCommon' }
4789 # @ChardevUdp:
4791 # Configuration info for datagram socket chardevs.
4793 # @remote: remote address
4794 # @local: #optional local address
4796 # Since: 1.5
4798 { 'struct': 'ChardevUdp', 'data': { 'remote' : 'SocketAddress',
4799                                   '*local' : 'SocketAddress' },
4800   'base': 'ChardevCommon' }
4803 # @ChardevMux:
4805 # Configuration info for mux chardevs.
4807 # @chardev: name of the base chardev.
4809 # Since: 1.5
4811 { 'struct': 'ChardevMux', 'data': { 'chardev' : 'str' },
4812   'base': 'ChardevCommon' }
4815 # @ChardevStdio:
4817 # Configuration info for stdio chardevs.
4819 # @signal: #optional Allow signals (such as SIGINT triggered by ^C)
4820 #          be delivered to qemu.  Default: true in -nographic mode,
4821 #          false otherwise.
4823 # Since: 1.5
4825 { 'struct': 'ChardevStdio', 'data': { '*signal' : 'bool' },
4826   'base': 'ChardevCommon' }
4830 # @ChardevSpiceChannel:
4832 # Configuration info for spice vm channel chardevs.
4834 # @type: kind of channel (for example vdagent).
4836 # Since: 1.5
4838 { 'struct': 'ChardevSpiceChannel', 'data': { 'type'  : 'str' },
4839   'base': 'ChardevCommon' }
4842 # @ChardevSpicePort:
4844 # Configuration info for spice port chardevs.
4846 # @fqdn: name of the channel (see docs/spice-port-fqdn.txt)
4848 # Since: 1.5
4850 { 'struct': 'ChardevSpicePort', 'data': { 'fqdn'  : 'str' },
4851   'base': 'ChardevCommon' }
4854 # @ChardevVC:
4856 # Configuration info for virtual console chardevs.
4858 # @width:  console width,  in pixels
4859 # @height: console height, in pixels
4860 # @cols:   console width,  in chars
4861 # @rows:   console height, in chars
4863 # Since: 1.5
4865 { 'struct': 'ChardevVC', 'data': { '*width'  : 'int',
4866                                  '*height' : 'int',
4867                                  '*cols'   : 'int',
4868                                  '*rows'   : 'int' },
4869   'base': 'ChardevCommon' }
4872 # @ChardevRingbuf:
4874 # Configuration info for ring buffer chardevs.
4876 # @size: #optional ring buffer size, must be power of two, default is 65536
4878 # Since: 1.5
4880 { 'struct': 'ChardevRingbuf', 'data': { '*size'  : 'int' },
4881   'base': 'ChardevCommon' }
4884 # @ChardevBackend:
4886 # Configuration info for the new chardev backend.
4888 # Since: 1.4 (testdev since 2.2)
4890 { 'union': 'ChardevBackend', 'data': { 'file'   : 'ChardevFile',
4891                                        'serial' : 'ChardevHostdev',
4892                                        'parallel': 'ChardevHostdev',
4893                                        'pipe'   : 'ChardevHostdev',
4894                                        'socket' : 'ChardevSocket',
4895                                        'udp'    : 'ChardevUdp',
4896                                        'pty'    : 'ChardevCommon',
4897                                        'null'   : 'ChardevCommon',
4898                                        'mux'    : 'ChardevMux',
4899                                        'msmouse': 'ChardevCommon',
4900                                        'braille': 'ChardevCommon',
4901                                        'testdev': 'ChardevCommon',
4902                                        'stdio'  : 'ChardevStdio',
4903                                        'console': 'ChardevCommon',
4904                                        'spicevmc' : 'ChardevSpiceChannel',
4905                                        'spiceport' : 'ChardevSpicePort',
4906                                        'vc'     : 'ChardevVC',
4907                                        'ringbuf': 'ChardevRingbuf',
4908                                        # next one is just for compatibility
4909                                        'memory' : 'ChardevRingbuf' } }
4912 # @ChardevReturn:
4914 # Return info about the chardev backend just created.
4916 # @pty: #optional name of the slave pseudoterminal device, present if
4917 #       and only if a chardev of type 'pty' was created
4919 # Since: 1.4
4921 { 'struct' : 'ChardevReturn', 'data': { '*pty' : 'str' } }
4924 # @chardev-add:
4926 # Add a character device backend
4928 # @id: the chardev's ID, must be unique
4929 # @backend: backend type and parameters
4931 # Returns: ChardevReturn.
4933 # Since: 1.4
4935 # Example:
4937 # -> { "execute" : "chardev-add",
4938 #      "arguments" : { "id" : "foo",
4939 #                      "backend" : { "type" : "null", "data" : {} } } }
4940 # <- { "return": {} }
4942 # -> { "execute" : "chardev-add",
4943 #      "arguments" : { "id" : "bar",
4944 #                      "backend" : { "type" : "file",
4945 #                                    "data" : { "out" : "/tmp/bar.log" } } } }
4946 # <- { "return": {} }
4948 # -> { "execute" : "chardev-add",
4949 #      "arguments" : { "id" : "baz",
4950 #                      "backend" : { "type" : "pty", "data" : {} } } }
4951 # <- { "return": { "pty" : "/dev/pty/42" } }
4954 { 'command': 'chardev-add', 'data': {'id'      : 'str',
4955                                      'backend' : 'ChardevBackend' },
4956   'returns': 'ChardevReturn' }
4959 # @chardev-remove:
4961 # Remove a character device backend
4963 # @id: the chardev's ID, must exist and not be in use
4965 # Returns: Nothing on success
4967 # Since: 1.4
4969 # Example:
4971 # -> { "execute": "chardev-remove", "arguments": { "id" : "foo" } }
4972 # <- { "return": {} }
4975 { 'command': 'chardev-remove', 'data': {'id': 'str'} }
4978 # @TpmModel:
4980 # An enumeration of TPM models
4982 # @tpm-tis: TPM TIS model
4984 # Since: 1.5
4986 { 'enum': 'TpmModel', 'data': [ 'tpm-tis' ] }
4989 # @query-tpm-models:
4991 # Return a list of supported TPM models
4993 # Returns: a list of TpmModel
4995 # Since: 1.5
4997 # Example:
4999 # -> { "execute": "query-tpm-models" }
5000 # <- { "return": [ "tpm-tis" ] }
5003 { 'command': 'query-tpm-models', 'returns': ['TpmModel'] }
5006 # @TpmType:
5008 # An enumeration of TPM types
5010 # @passthrough: TPM passthrough type
5012 # Since: 1.5
5014 { 'enum': 'TpmType', 'data': [ 'passthrough' ] }
5017 # @query-tpm-types:
5019 # Return a list of supported TPM types
5021 # Returns: a list of TpmType
5023 # Since: 1.5
5025 # Example:
5027 # -> { "execute": "query-tpm-types" }
5028 # <- { "return": [ "passthrough" ] }
5031 { 'command': 'query-tpm-types', 'returns': ['TpmType'] }
5034 # @TPMPassthroughOptions:
5036 # Information about the TPM passthrough type
5038 # @path: #optional string describing the path used for accessing the TPM device
5040 # @cancel-path: #optional string showing the TPM's sysfs cancel file
5041 #               for cancellation of TPM commands while they are executing
5043 # Since: 1.5
5045 { 'struct': 'TPMPassthroughOptions', 'data': { '*path' : 'str',
5046                                              '*cancel-path' : 'str'} }
5049 # @TpmTypeOptions:
5051 # A union referencing different TPM backend types' configuration options
5053 # @type: 'passthrough' The configuration options for the TPM passthrough type
5055 # Since: 1.5
5057 { 'union': 'TpmTypeOptions',
5058    'data': { 'passthrough' : 'TPMPassthroughOptions' } }
5061 # @TPMInfo:
5063 # Information about the TPM
5065 # @id: The Id of the TPM
5067 # @model: The TPM frontend model
5069 # @options: The TPM (backend) type configuration options
5071 # Since: 1.5
5073 { 'struct': 'TPMInfo',
5074   'data': {'id': 'str',
5075            'model': 'TpmModel',
5076            'options': 'TpmTypeOptions' } }
5079 # @query-tpm:
5081 # Return information about the TPM device
5083 # Returns: @TPMInfo on success
5085 # Since: 1.5
5087 # Example:
5089 # -> { "execute": "query-tpm" }
5090 # <- { "return":
5091 #      [
5092 #        { "model": "tpm-tis",
5093 #          "options":
5094 #            { "type": "passthrough",
5095 #              "data":
5096 #                { "cancel-path": "/sys/class/misc/tpm0/device/cancel",
5097 #                  "path": "/dev/tpm0"
5098 #                }
5099 #            },
5100 #          "id": "tpm0"
5101 #        }
5102 #      ]
5103 #    }
5106 { 'command': 'query-tpm', 'returns': ['TPMInfo'] }
5109 # @AcpiTableOptions:
5111 # Specify an ACPI table on the command line to load.
5113 # At most one of @file and @data can be specified. The list of files specified
5114 # by any one of them is loaded and concatenated in order. If both are omitted,
5115 # @data is implied.
5117 # Other fields / optargs can be used to override fields of the generic ACPI
5118 # table header; refer to the ACPI specification 5.0, section 5.2.6 System
5119 # Description Table Header. If a header field is not overridden, then the
5120 # corresponding value from the concatenated blob is used (in case of @file), or
5121 # it is filled in with a hard-coded value (in case of @data).
5123 # String fields are copied into the matching ACPI member from lowest address
5124 # upwards, and silently truncated / NUL-padded to length.
5126 # @sig: #optional table signature / identifier (4 bytes)
5128 # @rev: #optional table revision number (dependent on signature, 1 byte)
5130 # @oem_id: #optional OEM identifier (6 bytes)
5132 # @oem_table_id: #optional OEM table identifier (8 bytes)
5134 # @oem_rev: #optional OEM-supplied revision number (4 bytes)
5136 # @asl_compiler_id: #optional identifier of the utility that created the table
5137 #                   (4 bytes)
5139 # @asl_compiler_rev: #optional revision number of the utility that created the
5140 #                    table (4 bytes)
5142 # @file: #optional colon (:) separated list of pathnames to load and
5143 #        concatenate as table data. The resultant binary blob is expected to
5144 #        have an ACPI table header. At least one file is required. This field
5145 #        excludes @data.
5147 # @data: #optional colon (:) separated list of pathnames to load and
5148 #        concatenate as table data. The resultant binary blob must not have an
5149 #        ACPI table header. At least one file is required. This field excludes
5150 #        @file.
5152 # Since: 1.5
5154 { 'struct': 'AcpiTableOptions',
5155   'data': {
5156     '*sig':               'str',
5157     '*rev':               'uint8',
5158     '*oem_id':            'str',
5159     '*oem_table_id':      'str',
5160     '*oem_rev':           'uint32',
5161     '*asl_compiler_id':   'str',
5162     '*asl_compiler_rev':  'uint32',
5163     '*file':              'str',
5164     '*data':              'str' }}
5167 # @CommandLineParameterType:
5169 # Possible types for an option parameter.
5171 # @string: accepts a character string
5173 # @boolean: accepts "on" or "off"
5175 # @number: accepts a number
5177 # @size: accepts a number followed by an optional suffix (K)ilo,
5178 #        (M)ega, (G)iga, (T)era
5180 # Since: 1.5
5182 { 'enum': 'CommandLineParameterType',
5183   'data': ['string', 'boolean', 'number', 'size'] }
5186 # @CommandLineParameterInfo:
5188 # Details about a single parameter of a command line option.
5190 # @name: parameter name
5192 # @type: parameter @CommandLineParameterType
5194 # @help: #optional human readable text string, not suitable for parsing.
5196 # @default: #optional default value string (since 2.1)
5198 # Since: 1.5
5200 { 'struct': 'CommandLineParameterInfo',
5201   'data': { 'name': 'str',
5202             'type': 'CommandLineParameterType',
5203             '*help': 'str',
5204             '*default': 'str' } }
5207 # @CommandLineOptionInfo:
5209 # Details about a command line option, including its list of parameter details
5211 # @option: option name
5213 # @parameters: an array of @CommandLineParameterInfo
5215 # Since: 1.5
5217 { 'struct': 'CommandLineOptionInfo',
5218   'data': { 'option': 'str', 'parameters': ['CommandLineParameterInfo'] } }
5221 # @query-command-line-options:
5223 # Query command line option schema.
5225 # @option: #optional option name
5227 # Returns: list of @CommandLineOptionInfo for all options (or for the given
5228 #          @option).  Returns an error if the given @option doesn't exist.
5230 # Since: 1.5
5232 # Example:
5234 # -> { "execute": "query-command-line-options",
5235 #      "arguments": { "option": "option-rom" } }
5236 # <- { "return": [
5237 #         {
5238 #             "parameters": [
5239 #                 {
5240 #                     "name": "romfile",
5241 #                     "type": "string"
5242 #                 },
5243 #                 {
5244 #                     "name": "bootindex",
5245 #                     "type": "number"
5246 #                 }
5247 #             ],
5248 #             "option": "option-rom"
5249 #         }
5250 #      ]
5251 #    }
5254 {'command': 'query-command-line-options', 'data': { '*option': 'str' },
5255  'returns': ['CommandLineOptionInfo'] }
5258 # @X86CPURegister32:
5260 # A X86 32-bit register
5262 # Since: 1.5
5264 { 'enum': 'X86CPURegister32',
5265   'data': [ 'EAX', 'EBX', 'ECX', 'EDX', 'ESP', 'EBP', 'ESI', 'EDI' ] }
5268 # @X86CPUFeatureWordInfo:
5270 # Information about a X86 CPU feature word
5272 # @cpuid-input-eax: Input EAX value for CPUID instruction for that feature word
5274 # @cpuid-input-ecx: #optional Input ECX value for CPUID instruction for that
5275 #                   feature word
5277 # @cpuid-register: Output register containing the feature bits
5279 # @features: value of output register, containing the feature bits
5281 # Since: 1.5
5283 { 'struct': 'X86CPUFeatureWordInfo',
5284   'data': { 'cpuid-input-eax': 'int',
5285             '*cpuid-input-ecx': 'int',
5286             'cpuid-register': 'X86CPURegister32',
5287             'features': 'int' } }
5290 # @DummyForceArrays:
5292 # Not used by QMP; hack to let us use X86CPUFeatureWordInfoList internally
5294 # Since: 2.5
5296 { 'struct': 'DummyForceArrays',
5297   'data': { 'unused': ['X86CPUFeatureWordInfo'] } }
5301 # @RxState:
5303 # Packets receiving state
5305 # @normal: filter assigned packets according to the mac-table
5307 # @none: don't receive any assigned packet
5309 # @all: receive all assigned packets
5311 # Since: 1.6
5313 { 'enum': 'RxState', 'data': [ 'normal', 'none', 'all' ] }
5316 # @RxFilterInfo:
5318 # Rx-filter information for a NIC.
5320 # @name: net client name
5322 # @promiscuous: whether promiscuous mode is enabled
5324 # @multicast: multicast receive state
5326 # @unicast: unicast receive state
5328 # @vlan: vlan receive state (Since 2.0)
5330 # @broadcast-allowed: whether to receive broadcast
5332 # @multicast-overflow: multicast table is overflowed or not
5334 # @unicast-overflow: unicast table is overflowed or not
5336 # @main-mac: the main macaddr string
5338 # @vlan-table: a list of active vlan id
5340 # @unicast-table: a list of unicast macaddr string
5342 # @multicast-table: a list of multicast macaddr string
5344 # Since: 1.6
5346 { 'struct': 'RxFilterInfo',
5347   'data': {
5348     'name':               'str',
5349     'promiscuous':        'bool',
5350     'multicast':          'RxState',
5351     'unicast':            'RxState',
5352     'vlan':               'RxState',
5353     'broadcast-allowed':  'bool',
5354     'multicast-overflow': 'bool',
5355     'unicast-overflow':   'bool',
5356     'main-mac':           'str',
5357     'vlan-table':         ['int'],
5358     'unicast-table':      ['str'],
5359     'multicast-table':    ['str'] }}
5362 # @query-rx-filter:
5364 # Return rx-filter information for all NICs (or for the given NIC).
5366 # @name: #optional net client name
5368 # Returns: list of @RxFilterInfo for all NICs (or for the given NIC).
5369 #          Returns an error if the given @name doesn't exist, or given
5370 #          NIC doesn't support rx-filter querying, or given net client
5371 #          isn't a NIC.
5373 # Since: 1.6
5375 # Example:
5377 # -> { "execute": "query-rx-filter", "arguments": { "name": "vnet0" } }
5378 # <- { "return": [
5379 #         {
5380 #             "promiscuous": true,
5381 #             "name": "vnet0",
5382 #             "main-mac": "52:54:00:12:34:56",
5383 #             "unicast": "normal",
5384 #             "vlan": "normal",
5385 #             "vlan-table": [
5386 #                 4,
5387 #                 0
5388 #             ],
5389 #             "unicast-table": [
5390 #             ],
5391 #             "multicast": "normal",
5392 #             "multicast-overflow": false,
5393 #             "unicast-overflow": false,
5394 #             "multicast-table": [
5395 #                 "01:00:5e:00:00:01",
5396 #                 "33:33:00:00:00:01",
5397 #                 "33:33:ff:12:34:56"
5398 #             ],
5399 #             "broadcast-allowed": false
5400 #         }
5401 #       ]
5402 #    }
5405 { 'command': 'query-rx-filter', 'data': { '*name': 'str' },
5406   'returns': ['RxFilterInfo'] }
5409 # @InputButton:
5411 # Button of a pointer input device (mouse, tablet).
5413 # @side: front side button of a 5-button mouse (since 2.9)
5415 # @extra: rear side button of a 5-button mouse (since 2.9)
5417 # Since: 2.0
5419 { 'enum'  : 'InputButton',
5420   'data'  : [ 'left', 'middle', 'right', 'wheel-up', 'wheel-down', 'side',
5421   'extra' ] }
5424 # @InputAxis:
5426 # Position axis of a pointer input device (mouse, tablet).
5428 # Since: 2.0
5430 { 'enum'  : 'InputAxis',
5431   'data'  : [ 'x', 'y' ] }
5434 # @InputKeyEvent:
5436 # Keyboard input event.
5438 # @key:    Which key this event is for.
5439 # @down:   True for key-down and false for key-up events.
5441 # Since: 2.0
5443 { 'struct'  : 'InputKeyEvent',
5444   'data'  : { 'key'     : 'KeyValue',
5445               'down'    : 'bool' } }
5448 # @InputBtnEvent:
5450 # Pointer button input event.
5452 # @button: Which button this event is for.
5453 # @down:   True for key-down and false for key-up events.
5455 # Since: 2.0
5457 { 'struct'  : 'InputBtnEvent',
5458   'data'  : { 'button'  : 'InputButton',
5459               'down'    : 'bool' } }
5462 # @InputMoveEvent:
5464 # Pointer motion input event.
5466 # @axis:   Which axis is referenced by @value.
5467 # @value:  Pointer position.  For absolute coordinates the
5468 #          valid range is 0 -> 0x7ffff
5470 # Since: 2.0
5472 { 'struct'  : 'InputMoveEvent',
5473   'data'  : { 'axis'    : 'InputAxis',
5474               'value'   : 'int' } }
5477 # @InputEvent:
5479 # Input event union.
5481 # @type: the input type, one of:
5482 #  - 'key': Input event of Keyboard
5483 #  - 'btn': Input event of pointer buttons
5484 #  - 'rel': Input event of relative pointer motion
5485 #  - 'abs': Input event of absolute pointer motion
5487 # Since: 2.0
5489 { 'union' : 'InputEvent',
5490   'data'  : { 'key'     : 'InputKeyEvent',
5491               'btn'     : 'InputBtnEvent',
5492               'rel'     : 'InputMoveEvent',
5493               'abs'     : 'InputMoveEvent' } }
5496 # @input-send-event:
5498 # Send input event(s) to guest.
5500 # @device: #optional display device to send event(s) to.
5501 # @head: #optional head to send event(s) to, in case the
5502 #        display device supports multiple scanouts.
5503 # @events: List of InputEvent union.
5505 # Returns: Nothing on success.
5507 # The @device and @head parameters can be used to send the input event
5508 # to specific input devices in case (a) multiple input devices of the
5509 # same kind are added to the virtual machine and (b) you have
5510 # configured input routing (see docs/multiseat.txt) for those input
5511 # devices.  The parameters work exactly like the device and head
5512 # properties of input devices.  If @device is missing, only devices
5513 # that have no input routing config are admissible.  If @device is
5514 # specified, both input devices with and without input routing config
5515 # are admissible, but devices with input routing config take
5516 # precedence.
5518 # Since: 2.6
5520 # Note: The consoles are visible in the qom tree, under
5521 # /backend/console[$index]. They have a device link and head property,
5522 # so it is possible to map which console belongs to which device and
5523 # display.
5525 # Example:
5527 # 1. Press left mouse button.
5529 # -> { "execute": "input-send-event",
5530 #     "arguments": { "device": "video0",
5531 #                    "events": [ { "type": "btn",
5532 #                    "data" : { "down": true, "button": "left" } } ] } }
5533 # <- { "return": {} }
5535 # -> { "execute": "input-send-event",
5536 #     "arguments": { "device": "video0",
5537 #                    "events": [ { "type": "btn",
5538 #                    "data" : { "down": false, "button": "left" } } ] } }
5539 # <- { "return": {} }
5541 # 2. Press ctrl-alt-del.
5543 # -> { "execute": "input-send-event",
5544 #      "arguments": { "events": [
5545 #         { "type": "key", "data" : { "down": true,
5546 #           "key": {"type": "qcode", "data": "ctrl" } } },
5547 #         { "type": "key", "data" : { "down": true,
5548 #           "key": {"type": "qcode", "data": "alt" } } },
5549 #         { "type": "key", "data" : { "down": true,
5550 #           "key": {"type": "qcode", "data": "delete" } } } ] } }
5551 # <- { "return": {} }
5553 # 3. Move mouse pointer to absolute coordinates (20000, 400).
5555 # -> { "execute": "input-send-event" ,
5556 #   "arguments": { "events": [
5557 #                { "type": "abs", "data" : { "axis": "x", "value" : 20000 } },
5558 #                { "type": "abs", "data" : { "axis": "y", "value" : 400 } } ] } }
5559 # <- { "return": {} }
5562 { 'command': 'input-send-event',
5563   'data': { '*device': 'str',
5564             '*head'  : 'int',
5565             'events' : [ 'InputEvent' ] } }
5568 # @NumaOptions:
5570 # A discriminated record of NUMA options. (for OptsVisitor)
5572 # Since: 2.1
5574 { 'union': 'NumaOptions',
5575   'data': {
5576     'node': 'NumaNodeOptions' }}
5579 # @NumaNodeOptions:
5581 # Create a guest NUMA node. (for OptsVisitor)
5583 # @nodeid: #optional NUMA node ID (increase by 1 from 0 if omitted)
5585 # @cpus: #optional VCPUs belonging to this node (assign VCPUS round-robin
5586 #         if omitted)
5588 # @mem: #optional memory size of this node; mutually exclusive with @memdev.
5589 #       Equally divide total memory among nodes if both @mem and @memdev are
5590 #       omitted.
5592 # @memdev: #optional memory backend object.  If specified for one node,
5593 #          it must be specified for all nodes.
5595 # Since: 2.1
5597 { 'struct': 'NumaNodeOptions',
5598   'data': {
5599    '*nodeid': 'uint16',
5600    '*cpus':   ['uint16'],
5601    '*mem':    'size',
5602    '*memdev': 'str' }}
5605 # @HostMemPolicy:
5607 # Host memory policy types
5609 # @default: restore default policy, remove any nondefault policy
5611 # @preferred: set the preferred host nodes for allocation
5613 # @bind: a strict policy that restricts memory allocation to the
5614 #        host nodes specified
5616 # @interleave: memory allocations are interleaved across the set
5617 #              of host nodes specified
5619 # Since: 2.1
5621 { 'enum': 'HostMemPolicy',
5622   'data': [ 'default', 'preferred', 'bind', 'interleave' ] }
5625 # @Memdev:
5627 # Information about memory backend
5629 # @id: #optional backend's ID if backend has 'id' property (since 2.9)
5631 # @size: memory backend size
5633 # @merge: enables or disables memory merge support
5635 # @dump: includes memory backend's memory in a core dump or not
5637 # @prealloc: enables or disables memory preallocation
5639 # @host-nodes: host nodes for its memory policy
5641 # @policy: memory policy of memory backend
5643 # Since: 2.1
5645 { 'struct': 'Memdev',
5646   'data': {
5647     '*id':        'str',
5648     'size':       'size',
5649     'merge':      'bool',
5650     'dump':       'bool',
5651     'prealloc':   'bool',
5652     'host-nodes': ['uint16'],
5653     'policy':     'HostMemPolicy' }}
5656 # @query-memdev:
5658 # Returns information for all memory backends.
5660 # Returns: a list of @Memdev.
5662 # Since: 2.1
5664 # Example:
5666 # -> { "execute": "query-memdev" }
5667 # <- { "return": [
5668 #        {
5669 #          "id": "mem1",
5670 #          "size": 536870912,
5671 #          "merge": false,
5672 #          "dump": true,
5673 #          "prealloc": false,
5674 #          "host-nodes": [0, 1],
5675 #          "policy": "bind"
5676 #        },
5677 #        {
5678 #          "size": 536870912,
5679 #          "merge": false,
5680 #          "dump": true,
5681 #          "prealloc": true,
5682 #          "host-nodes": [2, 3],
5683 #          "policy": "preferred"
5684 #        }
5685 #      ]
5686 #    }
5689 { 'command': 'query-memdev', 'returns': ['Memdev'] }
5692 # @PCDIMMDeviceInfo:
5694 # PCDIMMDevice state information
5696 # @id: #optional device's ID
5698 # @addr: physical address, where device is mapped
5700 # @size: size of memory that the device provides
5702 # @slot: slot number at which device is plugged in
5704 # @node: NUMA node number where device is plugged in
5706 # @memdev: memory backend linked with device
5708 # @hotplugged: true if device was hotplugged
5710 # @hotpluggable: true if device if could be added/removed while machine is running
5712 # Since: 2.1
5714 { 'struct': 'PCDIMMDeviceInfo',
5715   'data': { '*id': 'str',
5716             'addr': 'int',
5717             'size': 'int',
5718             'slot': 'int',
5719             'node': 'int',
5720             'memdev': 'str',
5721             'hotplugged': 'bool',
5722             'hotpluggable': 'bool'
5723           }
5727 # @MemoryDeviceInfo:
5729 # Union containing information about a memory device
5731 # Since: 2.1
5733 { 'union': 'MemoryDeviceInfo', 'data': {'dimm': 'PCDIMMDeviceInfo'} }
5736 # @query-memory-devices:
5738 # Lists available memory devices and their state
5740 # Since: 2.1
5742 # Example:
5744 # -> { "execute": "query-memory-devices" }
5745 # <- { "return": [ { "data":
5746 #                       { "addr": 5368709120,
5747 #                         "hotpluggable": true,
5748 #                         "hotplugged": true,
5749 #                         "id": "d1",
5750 #                         "memdev": "/objects/memX",
5751 #                         "node": 0,
5752 #                         "size": 1073741824,
5753 #                         "slot": 0},
5754 #                    "type": "dimm"
5755 #                  } ] }
5758 { 'command': 'query-memory-devices', 'returns': ['MemoryDeviceInfo'] }
5761 # @ACPISlotType:
5763 # @DIMM: memory slot
5764 # @CPU: logical CPU slot (since 2.7)
5766 { 'enum': 'ACPISlotType', 'data': [ 'DIMM', 'CPU' ] }
5769 # @ACPIOSTInfo:
5771 # OSPM Status Indication for a device
5772 # For description of possible values of @source and @status fields
5773 # see "_OST (OSPM Status Indication)" chapter of ACPI5.0 spec.
5775 # @device: #optional device ID associated with slot
5777 # @slot: slot ID, unique per slot of a given @slot-type
5779 # @slot-type: type of the slot
5781 # @source: an integer containing the source event
5783 # @status: an integer containing the status code
5785 # Since: 2.1
5787 { 'struct': 'ACPIOSTInfo',
5788   'data'  : { '*device': 'str',
5789               'slot': 'str',
5790               'slot-type': 'ACPISlotType',
5791               'source': 'int',
5792               'status': 'int' } }
5795 # @query-acpi-ospm-status:
5797 # Return a list of ACPIOSTInfo for devices that support status
5798 # reporting via ACPI _OST method.
5800 # Since: 2.1
5802 # Example:
5804 # -> { "execute": "query-acpi-ospm-status" }
5805 # <- { "return": [ { "device": "d1", "slot": "0", "slot-type": "DIMM", "source": 1, "status": 0},
5806 #                  { "slot": "1", "slot-type": "DIMM", "source": 0, "status": 0},
5807 #                  { "slot": "2", "slot-type": "DIMM", "source": 0, "status": 0},
5808 #                  { "slot": "3", "slot-type": "DIMM", "source": 0, "status": 0}
5809 #    ]}
5812 { 'command': 'query-acpi-ospm-status', 'returns': ['ACPIOSTInfo'] }
5815 # @WatchdogExpirationAction:
5817 # An enumeration of the actions taken when the watchdog device's timer is
5818 # expired
5820 # @reset: system resets
5822 # @shutdown: system shutdown, note that it is similar to @powerdown, which
5823 #            tries to set to system status and notify guest
5825 # @poweroff: system poweroff, the emulator program exits
5827 # @pause: system pauses, similar to @stop
5829 # @debug: system enters debug state
5831 # @none: nothing is done
5833 # @inject-nmi: a non-maskable interrupt is injected into the first VCPU (all
5834 #              VCPUS on x86) (since 2.4)
5836 # Since: 2.1
5838 { 'enum': 'WatchdogExpirationAction',
5839   'data': [ 'reset', 'shutdown', 'poweroff', 'pause', 'debug', 'none',
5840             'inject-nmi' ] }
5843 # @IoOperationType:
5845 # An enumeration of the I/O operation types
5847 # @read: read operation
5849 # @write: write operation
5851 # Since: 2.1
5853 { 'enum': 'IoOperationType',
5854   'data': [ 'read', 'write' ] }
5857 # @GuestPanicAction:
5859 # An enumeration of the actions taken when guest OS panic is detected
5861 # @pause: system pauses
5863 # Since: 2.1 (poweroff since 2.8)
5865 { 'enum': 'GuestPanicAction',
5866   'data': [ 'pause', 'poweroff' ] }
5869 # @rtc-reset-reinjection:
5871 # This command will reset the RTC interrupt reinjection backlog.
5872 # Can be used if another mechanism to synchronize guest time
5873 # is in effect, for example QEMU guest agent's guest-set-time
5874 # command.
5876 # Since: 2.1
5878 # Example:
5880 # -> { "execute": "rtc-reset-reinjection" }
5881 # <- { "return": {} }
5884 { 'command': 'rtc-reset-reinjection' }
5886 # Rocker ethernet network switch
5887 { 'include': 'qapi/rocker.json' }
5890 # @ReplayMode:
5892 # Mode of the replay subsystem.
5894 # @none: normal execution mode. Replay or record are not enabled.
5896 # @record: record mode. All non-deterministic data is written into the
5897 #          replay log.
5899 # @play: replay mode. Non-deterministic data required for system execution
5900 #        is read from the log.
5902 # Since: 2.5
5904 { 'enum': 'ReplayMode',
5905   'data': [ 'none', 'record', 'play' ] }
5908 # @xen-load-devices-state:
5910 # Load the state of all devices from file. The RAM and the block devices
5911 # of the VM are not loaded by this command.
5913 # @filename: the file to load the state of the devices from as binary
5914 # data. See xen-save-devices-state.txt for a description of the binary
5915 # format.
5917 # Since: 2.7
5919 # Example:
5921 # -> { "execute": "xen-load-devices-state",
5922 #      "arguments": { "filename": "/tmp/resume" } }
5923 # <- { "return": {} }
5926 { 'command': 'xen-load-devices-state', 'data': {'filename': 'str'} }
5929 # @GICCapability:
5931 # The struct describes capability for a specific GIC (Generic
5932 # Interrupt Controller) version. These bits are not only decided by
5933 # QEMU/KVM software version, but also decided by the hardware that
5934 # the program is running upon.
5936 # @version:  version of GIC to be described. Currently, only 2 and 3
5937 #            are supported.
5939 # @emulated: whether current QEMU/hardware supports emulated GIC
5940 #            device in user space.
5942 # @kernel:   whether current QEMU/hardware supports hardware
5943 #            accelerated GIC device in kernel.
5945 # Since: 2.6
5947 { 'struct': 'GICCapability',
5948   'data': { 'version': 'int',
5949             'emulated': 'bool',
5950             'kernel': 'bool' } }
5953 # @query-gic-capabilities:
5955 # This command is ARM-only. It will return a list of GICCapability
5956 # objects that describe its capability bits.
5958 # Returns: a list of GICCapability objects.
5960 # Since: 2.6
5962 # Example:
5964 # -> { "execute": "query-gic-capabilities" }
5965 # <- { "return": [{ "version": 2, "emulated": true, "kernel": false },
5966 #                 { "version": 3, "emulated": false, "kernel": true } ] }
5969 { 'command': 'query-gic-capabilities', 'returns': ['GICCapability'] }
5972 # @CpuInstanceProperties:
5974 # List of properties to be used for hotplugging a CPU instance,
5975 # it should be passed by management with device_add command when
5976 # a CPU is being hotplugged.
5978 # @node-id: #optional NUMA node ID the CPU belongs to
5979 # @socket-id: #optional socket number within node/board the CPU belongs to
5980 # @core-id: #optional core number within socket the CPU belongs to
5981 # @thread-id: #optional thread number within core the CPU belongs to
5983 # Note: currently there are 4 properties that could be present
5984 # but management should be prepared to pass through other
5985 # properties with device_add command to allow for future
5986 # interface extension. This also requires the filed names to be kept in
5987 # sync with the properties passed to -device/device_add.
5989 # Since: 2.7
5991 { 'struct': 'CpuInstanceProperties',
5992   'data': { '*node-id': 'int',
5993             '*socket-id': 'int',
5994             '*core-id': 'int',
5995             '*thread-id': 'int'
5996   }
6000 # @HotpluggableCPU:
6002 # @type: CPU object type for usage with device_add command
6003 # @props: list of properties to be used for hotplugging CPU
6004 # @vcpus-count: number of logical VCPU threads @HotpluggableCPU provides
6005 # @qom-path: #optional link to existing CPU object if CPU is present or
6006 #            omitted if CPU is not present.
6008 # Since: 2.7
6010 { 'struct': 'HotpluggableCPU',
6011   'data': { 'type': 'str',
6012             'vcpus-count': 'int',
6013             'props': 'CpuInstanceProperties',
6014             '*qom-path': 'str'
6015           }
6019 # @query-hotpluggable-cpus:
6021 # Returns: a list of HotpluggableCPU objects.
6023 # Since: 2.7
6025 # Example:
6027 # For pseries machine type started with -smp 2,cores=2,maxcpus=4 -cpu POWER8:
6029 # -> { "execute": "query-hotpluggable-cpus" }
6030 # <- {"return": [
6031 #      { "props": { "core": 8 }, "type": "POWER8-spapr-cpu-core",
6032 #        "vcpus-count": 1 },
6033 #      { "props": { "core": 0 }, "type": "POWER8-spapr-cpu-core",
6034 #        "vcpus-count": 1, "qom-path": "/machine/unattached/device[0]"}
6035 #    ]}'
6037 # For pc machine type started with -smp 1,maxcpus=2:
6039 # -> { "execute": "query-hotpluggable-cpus" }
6040 # <- {"return": [
6041 #      {
6042 #         "type": "qemu64-x86_64-cpu", "vcpus-count": 1,
6043 #         "props": {"core-id": 0, "socket-id": 1, "thread-id": 0}
6044 #      },
6045 #      {
6046 #         "qom-path": "/machine/unattached/device[0]",
6047 #         "type": "qemu64-x86_64-cpu", "vcpus-count": 1,
6048 #         "props": {"core-id": 0, "socket-id": 0, "thread-id": 0}
6049 #      }
6050 #    ]}
6053 { 'command': 'query-hotpluggable-cpus', 'returns': ['HotpluggableCPU'] }