5 # QAPI common definitions
6 { 'include': 'qapi/common.json' }
8 # QAPI crypto definitions
9 { 'include': 'qapi/crypto.json' }
11 # QAPI block definitions
12 { 'include': 'qapi/block.json' }
14 # QAPI event definitions
15 { 'include': 'qapi/event.json' }
18 { 'include': 'qapi/trace.json' }
21 { 'include': 'qapi/introspect.json' }
30 # Enable QMP capabilities.
36 # -> { "execute": "qmp_capabilities" }
39 # Notes: This command is valid exactly when first connecting: it must be
40 # issued before any other command will be accepted, and will fail once the
41 # monitor is accepting other commands. (see qemu docs/qmp-spec.txt)
46 { 'command': 'qmp_capabilities' }
51 # Policy for handling lost ticks in timer devices.
53 # @discard: throw away the missed tick(s) and continue with future injection
54 # normally. Guest time may be delayed, unless the OS has explicit
55 # handling of lost ticks
57 # @delay: continue to deliver ticks at the normal rate. Guest time will be
58 # delayed due to the late tick
60 # @merge: merge the missed tick(s) into one tick and inject. Guest time
61 # may be delayed, depending on how the OS reacts to the merging
64 # @slew: deliver ticks at a higher rate to catch up with the missed tick. The
65 # guest time should not be delayed once catchup is complete.
69 { 'enum': 'LostTickPolicy',
70 'data': ['discard', 'delay', 'merge', 'slew' ] }
75 # Allow client connections for VNC, Spice and socket based
76 # character devices to be passed in to QEMU via SCM_RIGHTS.
78 # @protocol: protocol name. Valid names are "vnc", "spice" or the
79 # name of a character device (eg. from -chardev id=XXXX)
81 # @fdname: file descriptor name previously passed via 'getfd' command
83 # @skipauth: #optional whether to skip authentication. Only applies
84 # to "vnc" and "spice" protocols
86 # @tls: #optional whether to perform TLS. Only applies to the "spice"
89 # Returns: nothing on success.
95 # -> { "execute": "add_client", "arguments": { "protocol": "vnc",
96 # "fdname": "myclient" } }
100 { 'command': 'add_client',
101 'data': { 'protocol': 'str', 'fdname': 'str', '*skipauth': 'bool',
107 # Guest name information.
109 # @name: #optional The name of the guest
113 { 'struct': 'NameInfo', 'data': {'*name': 'str'} }
118 # Return the name information of a guest.
120 # Returns: @NameInfo of the guest
126 # -> { "execute": "query-name" }
127 # <- { "return": { "name": "qemu-name" } }
130 { 'command': 'query-name', 'returns': 'NameInfo' }
135 # Information about support for KVM acceleration
137 # @enabled: true if KVM acceleration is active
139 # @present: true if KVM acceleration is built into this executable
143 { 'struct': 'KvmInfo', 'data': {'enabled': 'bool', 'present': 'bool'} }
148 # Returns information about KVM acceleration
156 # -> { "execute": "query-kvm" }
157 # <- { "return": { "enabled": true, "present": true } }
160 { 'command': 'query-kvm', 'returns': 'KvmInfo' }
165 # An enumeration of VM run states.
167 # @debug: QEMU is running on a debugger
169 # @finish-migrate: guest is paused to finish the migration process
171 # @inmigrate: guest is paused waiting for an incoming migration. Note
172 # that this state does not tell whether the machine will start at the
173 # end of the migration. This depends on the command-line -S option and
174 # any invocation of 'stop' or 'cont' that has happened since QEMU was
177 # @internal-error: An internal error that prevents further guest execution
180 # @io-error: the last IOP has failed and the device is configured to pause
183 # @paused: guest has been paused via the 'stop' command
185 # @postmigrate: guest is paused following a successful 'migrate'
187 # @prelaunch: QEMU was started with -S and guest has not started
189 # @restore-vm: guest is paused to restore VM state
191 # @running: guest is actively running
193 # @save-vm: guest is paused to save the VM state
195 # @shutdown: guest is shut down (and -no-shutdown is in use)
197 # @suspended: guest is suspended (ACPI S3)
199 # @watchdog: the watchdog action is configured to pause and has been triggered
201 # @guest-panicked: guest has been panicked as a result of guest OS panic
203 # @colo: guest is paused to save/restore VM state under colo checkpoint,
204 # VM can not get into this state unless colo capability is enabled
205 # for migration. (since 2.8)
207 { 'enum': 'RunState',
208 'data': [ 'debug', 'inmigrate', 'internal-error', 'io-error', 'paused',
209 'postmigrate', 'prelaunch', 'finish-migrate', 'restore-vm',
210 'running', 'save-vm', 'shutdown', 'suspended', 'watchdog',
211 'guest-panicked', 'colo' ] }
216 # Information about VCPU run state
218 # @running: true if all VCPUs are runnable, false if not runnable
220 # @singlestep: true if VCPUs are in single-step mode
222 # @status: the virtual machine @RunState
226 # Notes: @singlestep is enabled through the GDB stub
228 { 'struct': 'StatusInfo',
229 'data': {'running': 'bool', 'singlestep': 'bool', 'status': 'RunState'} }
234 # Query the run status of all VCPUs
236 # Returns: @StatusInfo reflecting all VCPUs
242 # -> { "execute": "query-status" }
243 # <- { "return": { "running": true,
244 # "singlestep": false,
245 # "status": "running" } }
248 { 'command': 'query-status', 'returns': 'StatusInfo' }
253 # Guest UUID information (Universally Unique Identifier).
255 # @UUID: the UUID of the guest
259 # Notes: If no UUID was specified for the guest, a null UUID is returned.
261 { 'struct': 'UuidInfo', 'data': {'UUID': 'str'} }
266 # Query the guest UUID information.
268 # Returns: The @UuidInfo for the guest
274 # -> { "execute": "query-uuid" }
275 # <- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } }
278 { 'command': 'query-uuid', 'returns': 'UuidInfo' }
283 # Information about a character device.
285 # @label: the label of the character device
287 # @filename: the filename of the character device
289 # @frontend-open: shows whether the frontend device attached to this backend
290 # (eg. with the chardev=... option) is in open or closed state
293 # Notes: @filename is encoded using the QEMU command line character device
294 # encoding. See the QEMU man page for details.
298 { 'struct': 'ChardevInfo', 'data': {'label': 'str',
300 'frontend-open': 'bool'} }
305 # Returns information about current character devices.
307 # Returns: a list of @ChardevInfo
313 # -> { "execute": "query-chardev" }
317 # "label": "charchannel0",
318 # "filename": "unix:/var/lib/libvirt/qemu/seabios.rhel6.agent,server",
319 # "frontend-open": false
322 # "label": "charmonitor",
323 # "filename": "unix:/var/lib/libvirt/qemu/seabios.rhel6.monitor,server",
324 # "frontend-open": true
327 # "label": "charserial0",
328 # "filename": "pty:/dev/pts/2",
329 # "frontend-open": true
335 { 'command': 'query-chardev', 'returns': ['ChardevInfo'] }
338 # @ChardevBackendInfo:
340 # Information about a character device backend
342 # @name: The backend name
346 { 'struct': 'ChardevBackendInfo', 'data': {'name': 'str'} }
349 # @query-chardev-backends:
351 # Returns information about character device backends.
353 # Returns: a list of @ChardevBackendInfo
359 # -> { "execute": "query-chardev-backends" }
378 { 'command': 'query-chardev-backends', 'returns': ['ChardevBackendInfo'] }
383 # An enumeration of data format.
385 # @utf8: Data is a UTF-8 string (RFC 3629)
387 # @base64: Data is Base64 encoded binary (RFC 3548)
391 { 'enum': 'DataFormat',
392 'data': [ 'utf8', 'base64' ] }
397 # Write to a ring buffer character device.
399 # @device: the ring buffer character device name
401 # @data: data to write
403 # @format: #optional data encoding (default 'utf8').
404 # - base64: data must be base64 encoded text. Its binary
405 # decoding gets written.
406 # - utf8: data's UTF-8 encoding is written
407 # - data itself is always Unicode regardless of format, like
410 # Returns: Nothing on success
416 # -> { "execute": "ringbuf-write",
417 # "arguments": { "device": "foo",
418 # "data": "abcdefgh",
419 # "format": "utf8" } }
420 # <- { "return": {} }
423 { 'command': 'ringbuf-write',
424 'data': {'device': 'str', 'data': 'str',
425 '*format': 'DataFormat'} }
430 # Read from a ring buffer character device.
432 # @device: the ring buffer character device name
434 # @size: how many bytes to read at most
436 # @format: #optional data encoding (default 'utf8').
437 # - base64: the data read is returned in base64 encoding.
438 # - utf8: the data read is interpreted as UTF-8.
439 # Bug: can screw up when the buffer contains invalid UTF-8
440 # sequences, NUL characters, after the ring buffer lost
441 # data, and when reading stops because the size limit is
443 # - The return value is always Unicode regardless of format,
444 # like any other string.
446 # Returns: data read from the device
452 # -> { "execute": "ringbuf-read",
453 # "arguments": { "device": "foo",
455 # "format": "utf8" } }
456 # <- { "return": "abcdefgh" }
459 { 'command': 'ringbuf-read',
460 'data': {'device': 'str', 'size': 'int', '*format': 'DataFormat'},
466 # Information about a QMP event
468 # @name: The event name
472 { 'struct': 'EventInfo', 'data': {'name': 'str'} }
477 # Return a list of supported QMP events by this server
479 # Returns: A list of @EventInfo for all supported events
485 # -> { "execute": "query-events" }
497 # Note: This example has been shortened as the real response is too long.
500 { 'command': 'query-events', 'returns': ['EventInfo'] }
505 # Detailed migration status.
507 # @transferred: amount of bytes already transferred to the target VM
509 # @remaining: amount of bytes remaining to be transferred to the target VM
511 # @total: total amount of bytes involved in the migration process
513 # @duplicate: number of duplicate (zero) pages (since 1.2)
515 # @skipped: number of skipped zero pages (since 1.5)
517 # @normal: number of normal pages (since 1.2)
519 # @normal-bytes: number of normal bytes sent (since 1.2)
521 # @dirty-pages-rate: number of pages dirtied by second by the
524 # @mbps: throughput in megabits/sec. (since 1.6)
526 # @dirty-sync-count: number of times that dirty ram was synchronized (since 2.1)
528 # @postcopy-requests: The number of page requests received from the destination
533 { 'struct': 'MigrationStats',
534 'data': {'transferred': 'int', 'remaining': 'int', 'total': 'int' ,
535 'duplicate': 'int', 'skipped': 'int', 'normal': 'int',
536 'normal-bytes': 'int', 'dirty-pages-rate' : 'int',
537 'mbps' : 'number', 'dirty-sync-count' : 'int',
538 'postcopy-requests' : 'int' } }
543 # Detailed XBZRLE migration cache statistics
545 # @cache-size: XBZRLE cache size
547 # @bytes: amount of bytes already transferred to the target VM
549 # @pages: amount of pages transferred to the target VM
551 # @cache-miss: number of cache miss
553 # @cache-miss-rate: rate of cache miss (since 2.1)
555 # @overflow: number of overflows
559 { 'struct': 'XBZRLECacheStats',
560 'data': {'cache-size': 'int', 'bytes': 'int', 'pages': 'int',
561 'cache-miss': 'int', 'cache-miss-rate': 'number',
562 'overflow': 'int' } }
567 # An enumeration of migration status.
569 # @none: no migration has ever happened.
571 # @setup: migration process has been initiated.
573 # @cancelling: in the process of cancelling migration.
575 # @cancelled: cancelling migration is finished.
577 # @active: in the process of doing migration.
579 # @postcopy-active: like active, but now in postcopy mode. (since 2.5)
581 # @completed: migration is finished.
583 # @failed: some error occurred during migration process.
585 # @colo: VM is in the process of fault tolerance, VM can not get into this
586 # state unless colo capability is enabled for migration. (since 2.8)
591 { 'enum': 'MigrationStatus',
592 'data': [ 'none', 'setup', 'cancelling', 'cancelled',
593 'active', 'postcopy-active', 'completed', 'failed', 'colo' ] }
598 # Information about current migration process.
600 # @status: #optional @MigrationStatus describing the current migration status.
601 # If this field is not returned, no migration process
604 # @ram: #optional @MigrationStats containing detailed migration
605 # status, only returned if status is 'active' or
606 # 'completed'(since 1.2)
608 # @disk: #optional @MigrationStats containing detailed disk migration
609 # status, only returned if status is 'active' and it is a block
612 # @xbzrle-cache: #optional @XBZRLECacheStats containing detailed XBZRLE
613 # migration statistics, only returned if XBZRLE feature is on and
614 # status is 'active' or 'completed' (since 1.2)
616 # @total-time: #optional total amount of milliseconds since migration started.
617 # If migration has ended, it returns the total migration
620 # @downtime: #optional only present when migration finishes correctly
621 # total downtime in milliseconds for the guest.
624 # @expected-downtime: #optional only present while migration is active
625 # expected downtime in milliseconds for the guest in last walk
626 # of the dirty bitmap. (since 1.3)
628 # @setup-time: #optional amount of setup time in milliseconds _before_ the
629 # iterations begin but _after_ the QMP command is issued. This is designed
630 # to provide an accounting of any activities (such as RDMA pinning) which
631 # may be expensive, but do not actually occur during the iterative
632 # migration rounds themselves. (since 1.6)
634 # @cpu-throttle-percentage: #optional percentage of time guest cpus are being
635 # throttled during auto-converge. This is only present when auto-converge
636 # has started throttling guest cpus. (Since 2.7)
638 # @error-desc: #optional the human readable error description string, when
639 # @status is 'failed'. Clients should not attempt to parse the
640 # error strings. (Since 2.7)
644 { 'struct': 'MigrationInfo',
645 'data': {'*status': 'MigrationStatus', '*ram': 'MigrationStats',
646 '*disk': 'MigrationStats',
647 '*xbzrle-cache': 'XBZRLECacheStats',
648 '*total-time': 'int',
649 '*expected-downtime': 'int',
651 '*setup-time': 'int',
652 '*cpu-throttle-percentage': 'int',
653 '*error-desc': 'str'} }
658 # Returns information about current migration process. If migration
659 # is active there will be another json-object with RAM migration
660 # status and if block migration is active another one with block
663 # Returns: @MigrationInfo
669 # 1. Before the first migration
671 # -> { "execute": "query-migrate" }
672 # <- { "return": {} }
674 # 2. Migration is done and has succeeded
676 # -> { "execute": "query-migrate" }
678 # "status": "completed",
683 # "total-time":12345,
684 # "setup-time":12345,
688 # "normal-bytes":123456,
689 # "dirty-sync-count":15
694 # 3. Migration is done and has failed
696 # -> { "execute": "query-migrate" }
697 # <- { "return": { "status": "failed" } }
699 # 4. Migration is being performed and is not a block migration:
701 # -> { "execute": "query-migrate" }
709 # "total-time":12345,
710 # "setup-time":12345,
711 # "expected-downtime":12345,
714 # "normal-bytes":123456,
715 # "dirty-sync-count":15
720 # 5. Migration is being performed and is a block migration:
722 # -> { "execute": "query-migrate" }
728 # "remaining":1053304,
729 # "transferred":3720,
730 # "total-time":12345,
731 # "setup-time":12345,
732 # "expected-downtime":12345,
735 # "normal-bytes":123456,
736 # "dirty-sync-count":15
740 # "remaining":20880384,
741 # "transferred":91136
746 # 6. Migration is being performed and XBZRLE is active:
748 # -> { "execute": "query-migrate" }
752 # "capabilities" : [ { "capability": "xbzrle", "state" : true } ],
755 # "remaining":1053304,
756 # "transferred":3720,
757 # "total-time":12345,
758 # "setup-time":12345,
759 # "expected-downtime":12345,
762 # "normal-bytes":3412992,
763 # "dirty-sync-count":15
766 # "cache-size":67108864,
770 # "cache-miss-rate":0.123,
777 { 'command': 'query-migrate', 'returns': 'MigrationInfo' }
780 # @MigrationCapability:
782 # Migration capabilities enumeration
784 # @xbzrle: Migration supports xbzrle (Xor Based Zero Run Length Encoding).
785 # This feature allows us to minimize migration traffic for certain work
786 # loads, by sending compressed difference of the pages
788 # @rdma-pin-all: Controls whether or not the entire VM memory footprint is
789 # mlock()'d on demand or all at once. Refer to docs/rdma.txt for usage.
790 # Disabled by default. (since 2.0)
792 # @zero-blocks: During storage migration encode blocks of zeroes efficiently. This
793 # essentially saves 1MB of zeroes per block on the wire. Enabling requires
794 # source and target VM to support this feature. To enable it is sufficient
795 # to enable the capability on the source VM. The feature is disabled by
796 # default. (since 1.6)
798 # @compress: Use multiple compression threads to accelerate live migration.
799 # This feature can help to reduce the migration traffic, by sending
800 # compressed pages. Please note that if compress and xbzrle are both
801 # on, compress only takes effect in the ram bulk stage, after that,
802 # it will be disabled and only xbzrle takes effect, this can help to
803 # minimize migration traffic. The feature is disabled by default.
806 # @events: generate events for each migration state change
809 # @auto-converge: If enabled, QEMU will automatically throttle down the guest
810 # to speed up convergence of RAM migration. (since 1.6)
812 # @postcopy-ram: Start executing on the migration target before all of RAM has
813 # been migrated, pulling the remaining pages along as needed. NOTE: If
814 # the migration fails during postcopy the VM will fail. (since 2.6)
816 # @x-colo: If enabled, migration will never end, and the state of the VM on the
817 # primary side will be migrated continuously to the VM on secondary
818 # side, this process is called COarse-Grain LOck Stepping (COLO) for
819 # Non-stop Service. (since 2.8)
823 { 'enum': 'MigrationCapability',
824 'data': ['xbzrle', 'rdma-pin-all', 'auto-converge', 'zero-blocks',
825 'compress', 'events', 'postcopy-ram', 'x-colo'] }
828 # @MigrationCapabilityStatus:
830 # Migration capability information
832 # @capability: capability enum
834 # @state: capability state bool
838 { 'struct': 'MigrationCapabilityStatus',
839 'data': { 'capability' : 'MigrationCapability', 'state' : 'bool' } }
842 # @migrate-set-capabilities:
844 # Enable/Disable the following migration capabilities (like xbzrle)
846 # @capabilities: json array of capability modifications to make
852 # -> { "execute": "migrate-set-capabilities" , "arguments":
853 # { "capabilities": [ { "capability": "xbzrle", "state": true } ] } }
856 { 'command': 'migrate-set-capabilities',
857 'data': { 'capabilities': ['MigrationCapabilityStatus'] } }
860 # @query-migrate-capabilities:
862 # Returns information about the current migration capabilities status
864 # Returns: @MigrationCapabilitiesStatus
870 # -> { "execute": "query-migrate-capabilities" }
872 # {"state": false, "capability": "xbzrle"},
873 # {"state": false, "capability": "rdma-pin-all"},
874 # {"state": false, "capability": "auto-converge"},
875 # {"state": false, "capability": "zero-blocks"},
876 # {"state": false, "capability": "compress"},
877 # {"state": true, "capability": "events"},
878 # {"state": false, "capability": "postcopy-ram"},
879 # {"state": false, "capability": "x-colo"}
883 { 'command': 'query-migrate-capabilities', 'returns': ['MigrationCapabilityStatus']}
886 # @MigrationParameter:
888 # Migration parameters enumeration
890 # @compress-level: Set the compression level to be used in live migration,
891 # the compression level is an integer between 0 and 9, where 0 means
892 # no compression, 1 means the best compression speed, and 9 means best
893 # compression ratio which will consume more CPU.
895 # @compress-threads: Set compression thread count to be used in live migration,
896 # the compression thread count is an integer between 1 and 255.
898 # @decompress-threads: Set decompression thread count to be used in live
899 # migration, the decompression thread count is an integer between 1
900 # and 255. Usually, decompression is at least 4 times as fast as
901 # compression, so set the decompress-threads to the number about 1/4
902 # of compress-threads is adequate.
904 # @cpu-throttle-initial: Initial percentage of time guest cpus are throttled
905 # when migration auto-converge is activated. The
906 # default value is 20. (Since 2.7)
908 # @cpu-throttle-increment: throttle percentage increase each time
909 # auto-converge detects that migration is not making
910 # progress. The default value is 10. (Since 2.7)
912 # @tls-creds: ID of the 'tls-creds' object that provides credentials for
913 # establishing a TLS connection over the migration data channel.
914 # On the outgoing side of the migration, the credentials must
915 # be for a 'client' endpoint, while for the incoming side the
916 # credentials must be for a 'server' endpoint. Setting this
917 # will enable TLS for all migrations. The default is unset,
918 # resulting in unsecured migration at the QEMU level. (Since 2.7)
920 # @tls-hostname: hostname of the target host for the migration. This is
921 # required when using x509 based TLS credentials and the
922 # migration URI does not already include a hostname. For
923 # example if using fd: or exec: based migration, the
924 # hostname must be provided so that the server's x509
925 # certificate identity can be validated. (Since 2.7)
927 # @max-bandwidth: to set maximum speed for migration. maximum speed in
928 # bytes per second. (Since 2.8)
930 # @downtime-limit: set maximum tolerated downtime for migration. maximum
931 # downtime in milliseconds (Since 2.8)
933 # @x-checkpoint-delay: The delay time (in ms) between two COLO checkpoints in
934 # periodic mode. (Since 2.8)
938 { 'enum': 'MigrationParameter',
939 'data': ['compress-level', 'compress-threads', 'decompress-threads',
940 'cpu-throttle-initial', 'cpu-throttle-increment',
941 'tls-creds', 'tls-hostname', 'max-bandwidth',
942 'downtime-limit', 'x-checkpoint-delay' ] }
945 # @migrate-set-parameters:
947 # Set various migration parameters. See MigrationParameters for details.
953 # -> { "execute": "migrate-set-parameters" ,
954 # "arguments": { "compress-level": 1 } }
957 { 'command': 'migrate-set-parameters', 'boxed': true,
958 'data': 'MigrationParameters' }
961 # @MigrationParameters:
963 # Optional members can be omitted on input ('migrate-set-parameters')
964 # but most members will always be present on output
965 # ('query-migrate-parameters'), with the exception of tls-creds and
968 # @compress-level: #optional compression level
970 # @compress-threads: #optional compression thread count
972 # @decompress-threads: #optional decompression thread count
974 # @cpu-throttle-initial: #optional Initial percentage of time guest cpus are
975 # throttledwhen migration auto-converge is activated.
976 # The default value is 20. (Since 2.7)
978 # @cpu-throttle-increment: #optional throttle percentage increase each time
979 # auto-converge detects that migration is not making
980 # progress. The default value is 10. (Since 2.7)
982 # @tls-creds: #optional ID of the 'tls-creds' object that provides credentials
983 # for establishing a TLS connection over the migration data
984 # channel. On the outgoing side of the migration, the credentials
985 # must be for a 'client' endpoint, while for the incoming side the
986 # credentials must be for a 'server' endpoint. Setting this
987 # will enable TLS for all migrations. The default is unset,
988 # resulting in unsecured migration at the QEMU level. (Since 2.7)
990 # @tls-hostname: #optional hostname of the target host for the migration. This
991 # is required when using x509 based TLS credentials and the
992 # migration URI does not already include a hostname. For
993 # example if using fd: or exec: based migration, the
994 # hostname must be provided so that the server's x509
995 # certificate identity can be validated. (Since 2.7)
997 # @max-bandwidth: to set maximum speed for migration. maximum speed in
998 # bytes per second. (Since 2.8)
1000 # @downtime-limit: set maximum tolerated downtime for migration. maximum
1001 # downtime in milliseconds (Since 2.8)
1003 # @x-checkpoint-delay: the delay time between two COLO checkpoints. (Since 2.8)
1007 { 'struct': 'MigrationParameters',
1008 'data': { '*compress-level': 'int',
1009 '*compress-threads': 'int',
1010 '*decompress-threads': 'int',
1011 '*cpu-throttle-initial': 'int',
1012 '*cpu-throttle-increment': 'int',
1013 '*tls-creds': 'str',
1014 '*tls-hostname': 'str',
1015 '*max-bandwidth': 'int',
1016 '*downtime-limit': 'int',
1017 '*x-checkpoint-delay': 'int'} }
1020 # @query-migrate-parameters:
1022 # Returns information about the current migration parameters
1024 # Returns: @MigrationParameters
1030 # -> { "execute": "query-migrate-parameters" }
1032 # "decompress-threads": 2,
1033 # "cpu-throttle-increment": 10,
1034 # "compress-threads": 8,
1035 # "compress-level": 1,
1036 # "cpu-throttle-initial": 20,
1037 # "max-bandwidth": 33554432,
1038 # "downtime-limit": 300
1043 { 'command': 'query-migrate-parameters',
1044 'returns': 'MigrationParameters' }
1047 # @client_migrate_info:
1049 # Set migration information for remote display. This makes the server
1050 # ask the client to automatically reconnect using the new parameters
1051 # once migration finished successfully. Only implemented for SPICE.
1053 # @protocol: must be "spice"
1054 # @hostname: migration target hostname
1055 # @port: #optional spice tcp port for plaintext channels
1056 # @tls-port: #optional spice tcp port for tls-secured channels
1057 # @cert-subject: #optional server certificate subject
1063 # -> { "execute": "client_migrate_info",
1064 # "arguments": { "protocol": "spice",
1065 # "hostname": "virt42.lab.kraxel.org",
1067 # <- { "return": {} }
1070 { 'command': 'client_migrate_info',
1071 'data': { 'protocol': 'str', 'hostname': 'str', '*port': 'int',
1072 '*tls-port': 'int', '*cert-subject': 'str' } }
1075 # @migrate-start-postcopy:
1077 # Followup to a migration command to switch the migration to postcopy mode.
1078 # The postcopy-ram capability must be set before the original migration
1085 # -> { "execute": "migrate-start-postcopy" }
1086 # <- { "return": {} }
1089 { 'command': 'migrate-start-postcopy' }
1094 # The message transmission between Primary side and Secondary side.
1096 # @checkpoint-ready: Secondary VM (SVM) is ready for checkpointing
1098 # @checkpoint-request: Primary VM (PVM) tells SVM to prepare for checkpointing
1100 # @checkpoint-reply: SVM gets PVM's checkpoint request
1102 # @vmstate-send: VM's state will be sent by PVM.
1104 # @vmstate-size: The total size of VMstate.
1106 # @vmstate-received: VM's state has been received by SVM.
1108 # @vmstate-loaded: VM's state has been loaded by SVM.
1112 { 'enum': 'COLOMessage',
1113 'data': [ 'checkpoint-ready', 'checkpoint-request', 'checkpoint-reply',
1114 'vmstate-send', 'vmstate-size', 'vmstate-received',
1115 'vmstate-loaded' ] }
1122 # @unknown: unknown mode
1124 # @primary: master side
1126 # @secondary: slave side
1130 { 'enum': 'COLOMode',
1131 'data': [ 'unknown', 'primary', 'secondary'] }
1136 # An enumeration of COLO failover status
1138 # @none: no failover has ever happened
1140 # @require: got failover requirement but not handled
1142 # @active: in the process of doing failover
1144 # @completed: finish the process of failover
1148 { 'enum': 'FailoverStatus',
1149 'data': [ 'none', 'require', 'active', 'completed'] }
1152 # @x-colo-lost-heartbeat:
1154 # Tell qemu that heartbeat is lost, request it to do takeover procedures.
1155 # If this command is sent to the PVM, the Primary side will exit COLO mode.
1156 # If sent to the Secondary, the Secondary side will run failover work,
1157 # then takes over server operation to become the service VM.
1161 { 'command': 'x-colo-lost-heartbeat' }
1166 # Information about a mouse device.
1168 # @name: the name of the mouse device
1170 # @index: the index of the mouse device
1172 # @current: true if this device is currently receiving mouse events
1174 # @absolute: true if this device supports absolute coordinates as input
1178 { 'struct': 'MouseInfo',
1179 'data': {'name': 'str', 'index': 'int', 'current': 'bool',
1180 'absolute': 'bool'} }
1185 # Returns information about each active mouse device
1187 # Returns: a list of @MouseInfo for each device
1193 # -> { "execute": "query-mice" }
1196 # "name":"QEMU Microsoft Mouse",
1202 # "name":"QEMU PS/2 Mouse",
1211 { 'command': 'query-mice', 'returns': ['MouseInfo'] }
1216 # An enumeration of cpu types that enable additional information during
1221 { 'enum': 'CpuInfoArch',
1222 'data': ['x86', 'sparc', 'ppc', 'mips', 'tricore', 'other' ] }
1227 # Information about a virtual CPU
1229 # @CPU: the index of the virtual CPU
1231 # @current: this only exists for backwards compatibility and should be ignored
1233 # @halted: true if the virtual CPU is in the halt state. Halt usually refers
1234 # to a processor specific low power mode.
1236 # @qom_path: path to the CPU object in the QOM tree (since 2.4)
1238 # @thread_id: ID of the underlying host thread
1240 # @arch: architecture of the cpu, which determines which additional fields
1241 # will be listed (since 2.6)
1245 # Notes: @halted is a transient state that changes frequently. By the time the
1246 # data is sent to the client, the guest may no longer be halted.
1248 { 'union': 'CpuInfo',
1249 'base': {'CPU': 'int', 'current': 'bool', 'halted': 'bool',
1250 'qom_path': 'str', 'thread_id': 'int', 'arch': 'CpuInfoArch' },
1251 'discriminator': 'arch',
1252 'data': { 'x86': 'CpuInfoX86',
1253 'sparc': 'CpuInfoSPARC',
1254 'ppc': 'CpuInfoPPC',
1255 'mips': 'CpuInfoMIPS',
1256 'tricore': 'CpuInfoTricore',
1257 'other': 'CpuInfoOther' } }
1262 # Additional information about a virtual i386 or x86_64 CPU
1264 # @pc: the 64-bit instruction pointer
1268 { 'struct': 'CpuInfoX86', 'data': { 'pc': 'int' } }
1273 # Additional information about a virtual SPARC CPU
1275 # @pc: the PC component of the instruction pointer
1277 # @npc: the NPC component of the instruction pointer
1281 { 'struct': 'CpuInfoSPARC', 'data': { 'pc': 'int', 'npc': 'int' } }
1286 # Additional information about a virtual PPC CPU
1288 # @nip: the instruction pointer
1292 { 'struct': 'CpuInfoPPC', 'data': { 'nip': 'int' } }
1297 # Additional information about a virtual MIPS CPU
1299 # @PC: the instruction pointer
1303 { 'struct': 'CpuInfoMIPS', 'data': { 'PC': 'int' } }
1308 # Additional information about a virtual Tricore CPU
1310 # @PC: the instruction pointer
1314 { 'struct': 'CpuInfoTricore', 'data': { 'PC': 'int' } }
1319 # No additional information is available about the virtual CPU
1324 { 'struct': 'CpuInfoOther', 'data': { } }
1329 # Returns a list of information about each virtual CPU.
1331 # Returns: a list of @CpuInfo for each virtual CPU
1337 # -> { "execute": "query-cpus" }
1343 # "qom_path":"/machine/unattached/device[0]",
1352 # "qom_path":"/machine/unattached/device[2]",
1361 { 'command': 'query-cpus', 'returns': ['CpuInfo'] }
1366 # Information about an iothread
1368 # @id: the identifier of the iothread
1370 # @thread-id: ID of the underlying host thread
1374 { 'struct': 'IOThreadInfo',
1375 'data': {'id': 'str', 'thread-id': 'int'} }
1380 # Returns a list of information about each iothread.
1382 # Note: this list excludes the QEMU main loop thread, which is not declared
1383 # using the -object iothread command-line option. It is always the main thread
1386 # Returns: a list of @IOThreadInfo for each iothread
1392 # -> { "execute": "query-iothreads" }
1406 { 'command': 'query-iothreads', 'returns': ['IOThreadInfo'] }
1409 # @NetworkAddressFamily:
1411 # The network address family
1413 # @ipv4: IPV4 family
1415 # @ipv6: IPV6 family
1417 # @unix: unix socket
1419 # @vsock: vsock family (since 2.8)
1421 # @unknown: otherwise
1425 { 'enum': 'NetworkAddressFamily',
1426 'data': [ 'ipv4', 'ipv6', 'unix', 'vsock', 'unknown' ] }
1431 # The basic information for vnc network connection
1435 # @service: The service name of the vnc port. This may depend on the host
1436 # system's service database so symbolic names should not be relied
1439 # @family: address family
1441 # @websocket: true in case the socket is a websocket (since 2.3).
1445 { 'struct': 'VncBasicInfo',
1446 'data': { 'host': 'str',
1448 'family': 'NetworkAddressFamily',
1449 'websocket': 'bool' } }
1454 # The network connection information for server
1456 # @auth: #optional, authentication method
1460 { 'struct': 'VncServerInfo',
1461 'base': 'VncBasicInfo',
1462 'data': { '*auth': 'str' } }
1467 # Information about a connected VNC client.
1469 # @x509_dname: #optional If x509 authentication is in use, the Distinguished
1470 # Name of the client.
1472 # @sasl_username: #optional If SASL authentication is in use, the SASL username
1473 # used for authentication.
1477 { 'struct': 'VncClientInfo',
1478 'base': 'VncBasicInfo',
1479 'data': { '*x509_dname': 'str', '*sasl_username': 'str' } }
1484 # Information about the VNC session.
1486 # @enabled: true if the VNC server is enabled, false otherwise
1488 # @host: #optional The hostname the VNC server is bound to. This depends on
1489 # the name resolution on the host and may be an IP address.
1491 # @family: #optional 'ipv6' if the host is listening for IPv6 connections
1492 # 'ipv4' if the host is listening for IPv4 connections
1493 # 'unix' if the host is listening on a unix domain socket
1494 # 'unknown' otherwise
1496 # @service: #optional The service name of the server's port. This may depends
1497 # on the host system's service database so symbolic names should not
1500 # @auth: #optional the current authentication type used by the server
1501 # 'none' if no authentication is being used
1502 # 'vnc' if VNC authentication is being used
1503 # 'vencrypt+plain' if VEncrypt is used with plain text authentication
1504 # 'vencrypt+tls+none' if VEncrypt is used with TLS and no authentication
1505 # 'vencrypt+tls+vnc' if VEncrypt is used with TLS and VNC authentication
1506 # 'vencrypt+tls+plain' if VEncrypt is used with TLS and plain text auth
1507 # 'vencrypt+x509+none' if VEncrypt is used with x509 and no auth
1508 # 'vencrypt+x509+vnc' if VEncrypt is used with x509 and VNC auth
1509 # 'vencrypt+x509+plain' if VEncrypt is used with x509 and plain text auth
1510 # 'vencrypt+tls+sasl' if VEncrypt is used with TLS and SASL auth
1511 # 'vencrypt+x509+sasl' if VEncrypt is used with x509 and SASL auth
1513 # @clients: a list of @VncClientInfo of all currently connected clients
1517 { 'struct': 'VncInfo',
1518 'data': {'enabled': 'bool', '*host': 'str',
1519 '*family': 'NetworkAddressFamily',
1520 '*service': 'str', '*auth': 'str', '*clients': ['VncClientInfo']} }
1525 # vnc primary authentication method.
1529 { 'enum': 'VncPrimaryAuth',
1530 'data': [ 'none', 'vnc', 'ra2', 'ra2ne', 'tight', 'ultra',
1531 'tls', 'vencrypt', 'sasl' ] }
1534 # @VncVencryptSubAuth:
1536 # vnc sub authentication method with vencrypt.
1540 { 'enum': 'VncVencryptSubAuth',
1542 'tls-none', 'x509-none',
1543 'tls-vnc', 'x509-vnc',
1544 'tls-plain', 'x509-plain',
1545 'tls-sasl', 'x509-sasl' ] }
1550 # Information about a vnc server
1552 # @id: vnc server name.
1554 # @server: A list of @VncBasincInfo describing all listening sockets.
1555 # The list can be empty (in case the vnc server is disabled).
1556 # It also may have multiple entries: normal + websocket,
1557 # possibly also ipv4 + ipv6 in the future.
1559 # @clients: A list of @VncClientInfo of all currently connected clients.
1560 # The list can be empty, for obvious reasons.
1562 # @auth: The current authentication type used by the server
1564 # @vencrypt: #optional The vencrypt sub authentication type used by the server,
1565 # only specified in case auth == vencrypt.
1567 # @display: #optional The display device the vnc server is linked to.
1571 { 'struct': 'VncInfo2',
1572 'data': { 'id' : 'str',
1573 'server' : ['VncBasicInfo'],
1574 'clients' : ['VncClientInfo'],
1575 'auth' : 'VncPrimaryAuth',
1576 '*vencrypt' : 'VncVencryptSubAuth',
1577 '*display' : 'str' } }
1582 # Returns information about the current VNC server
1590 # -> { "execute": "query-vnc" }
1594 # "service":"50402",
1599 # "host":"127.0.0.1",
1600 # "service":"50401",
1608 { 'command': 'query-vnc', 'returns': 'VncInfo' }
1611 # @query-vnc-servers:
1613 # Returns a list of vnc servers. The list can be empty.
1615 # Returns: a list of @VncInfo2
1619 { 'command': 'query-vnc-servers', 'returns': ['VncInfo2'] }
1624 # The basic information for SPICE network connection
1628 # @port: port number
1630 # @family: address family
1634 { 'struct': 'SpiceBasicInfo',
1635 'data': { 'host': 'str',
1637 'family': 'NetworkAddressFamily' } }
1642 # Information about a SPICE server
1644 # @auth: #optional, authentication method
1648 { 'struct': 'SpiceServerInfo',
1649 'base': 'SpiceBasicInfo',
1650 'data': { '*auth': 'str' } }
1655 # Information about a SPICE client channel.
1657 # @connection-id: SPICE connection id number. All channels with the same id
1658 # belong to the same SPICE session.
1660 # @channel-type: SPICE channel type number. "1" is the main control
1661 # channel, filter for this one if you want to track spice
1664 # @channel-id: SPICE channel ID number. Usually "0", might be different when
1665 # multiple channels of the same type exist, such as multiple
1666 # display channels in a multihead setup
1668 # @tls: true if the channel is encrypted, false otherwise.
1672 { 'struct': 'SpiceChannel',
1673 'base': 'SpiceBasicInfo',
1674 'data': {'connection-id': 'int', 'channel-type': 'int', 'channel-id': 'int',
1678 # @SpiceQueryMouseMode:
1680 # An enumeration of Spice mouse states.
1682 # @client: Mouse cursor position is determined by the client.
1684 # @server: Mouse cursor position is determined by the server.
1686 # @unknown: No information is available about mouse mode used by
1689 # Note: spice/enums.h has a SpiceMouseMode already, hence the name.
1693 { 'enum': 'SpiceQueryMouseMode',
1694 'data': [ 'client', 'server', 'unknown' ] }
1699 # Information about the SPICE session.
1701 # @enabled: true if the SPICE server is enabled, false otherwise
1703 # @migrated: true if the last guest migration completed and spice
1704 # migration had completed as well. false otherwise. (since 1.4)
1706 # @host: #optional The hostname the SPICE server is bound to. This depends on
1707 # the name resolution on the host and may be an IP address.
1709 # @port: #optional The SPICE server's port number.
1711 # @compiled-version: #optional SPICE server version.
1713 # @tls-port: #optional The SPICE server's TLS port number.
1715 # @auth: #optional the current authentication type used by the server
1716 # 'none' if no authentication is being used
1717 # 'spice' uses SASL or direct TLS authentication, depending on command
1720 # @mouse-mode: The mode in which the mouse cursor is displayed currently. Can
1721 # be determined by the client or the server, or unknown if spice
1722 # server doesn't provide this information. (since: 1.1)
1724 # @channels: a list of @SpiceChannel for each active spice channel
1728 { 'struct': 'SpiceInfo',
1729 'data': {'enabled': 'bool', 'migrated': 'bool', '*host': 'str', '*port': 'int',
1730 '*tls-port': 'int', '*auth': 'str', '*compiled-version': 'str',
1731 'mouse-mode': 'SpiceQueryMouseMode', '*channels': ['SpiceChannel']} }
1736 # Returns information about the current SPICE server
1738 # Returns: @SpiceInfo
1744 # -> { "execute": "query-spice" }
1750 # "host": "0.0.0.0",
1755 # "channel-type": 1,
1756 # "connection-id": 1804289383,
1757 # "host": "127.0.0.1",
1764 # "channel-type": 4,
1765 # "connection-id": 1804289383,
1766 # "host": "127.0.0.1",
1770 # [ ... more channels follow ... ]
1776 { 'command': 'query-spice', 'returns': 'SpiceInfo' }
1781 # Information about the guest balloon device.
1783 # @actual: the number of bytes the balloon currently contains
1788 { 'struct': 'BalloonInfo', 'data': {'actual': 'int' } }
1793 # Return information about the balloon device.
1795 # Returns: @BalloonInfo on success
1797 # If the balloon driver is enabled but not functional because the KVM
1798 # kernel module cannot support it, KvmMissingCap
1800 # If no balloon device is present, DeviceNotActive
1806 # -> { "execute": "query-balloon" }
1808 # "actual": 1073741824,
1813 { 'command': 'query-balloon', 'returns': 'BalloonInfo' }
1818 # A PCI device memory region
1820 # @base: the starting address (guest physical)
1822 # @limit: the ending address (guest physical)
1826 { 'struct': 'PciMemoryRange', 'data': {'base': 'int', 'limit': 'int'} }
1831 # Information about a PCI device I/O region.
1833 # @bar: the index of the Base Address Register for this region
1835 # @type: 'io' if the region is a PIO region
1836 # 'memory' if the region is a MMIO region
1838 # @size: memory size
1840 # @prefetch: #optional if @type is 'memory', true if the memory is prefetchable
1842 # @mem_type_64: #optional if @type is 'memory', true if the BAR is 64-bit
1846 { 'struct': 'PciMemoryRegion',
1847 'data': {'bar': 'int', 'type': 'str', 'address': 'int', 'size': 'int',
1848 '*prefetch': 'bool', '*mem_type_64': 'bool' } }
1853 # Information about a bus of a PCI Bridge device
1855 # @number: primary bus interface number. This should be the number of the
1856 # bus the device resides on.
1858 # @secondary: secondary bus interface number. This is the number of the
1859 # main bus for the bridge
1861 # @subordinate: This is the highest number bus that resides below the
1864 # @io_range: The PIO range for all devices on this bridge
1866 # @memory_range: The MMIO range for all devices on this bridge
1868 # @prefetchable_range: The range of prefetchable MMIO for all devices on
1873 { 'struct': 'PciBusInfo',
1874 'data': {'number': 'int', 'secondary': 'int', 'subordinate': 'int',
1875 'io_range': 'PciMemoryRange',
1876 'memory_range': 'PciMemoryRange',
1877 'prefetchable_range': 'PciMemoryRange' } }
1882 # Information about a PCI Bridge device
1884 # @bus: information about the bus the device resides on
1886 # @devices: a list of @PciDeviceInfo for each device on this bridge
1890 { 'struct': 'PciBridgeInfo',
1891 'data': {'bus': 'PciBusInfo', '*devices': ['PciDeviceInfo']} }
1896 # Information about the Class of a PCI device
1898 # @desc: #optional a string description of the device's class
1900 # @class: the class code of the device
1904 { 'struct': 'PciDeviceClass',
1905 'data': {'*desc': 'str', 'class': 'int'} }
1910 # Information about the Id of a PCI device
1912 # @device: the PCI device id
1914 # @vendor: the PCI vendor id
1918 { 'struct': 'PciDeviceId',
1919 'data': {'device': 'int', 'vendor': 'int'} }
1924 # Information about a PCI device
1926 # @bus: the bus number of the device
1928 # @slot: the slot the device is located in
1930 # @function: the function of the slot used by the device
1932 # @class_info: the class of the device
1934 # @id: the PCI device id
1936 # @irq: #optional if an IRQ is assigned to the device, the IRQ number
1938 # @qdev_id: the device name of the PCI device
1940 # @pci_bridge: if the device is a PCI bridge, the bridge information
1942 # @regions: a list of the PCI I/O regions associated with the device
1944 # Notes: the contents of @class_info.desc are not stable and should only be
1945 # treated as informational.
1949 { 'struct': 'PciDeviceInfo',
1950 'data': {'bus': 'int', 'slot': 'int', 'function': 'int',
1951 'class_info': 'PciDeviceClass', 'id': 'PciDeviceId',
1952 '*irq': 'int', 'qdev_id': 'str', '*pci_bridge': 'PciBridgeInfo',
1953 'regions': ['PciMemoryRegion']} }
1958 # Information about a PCI bus
1960 # @bus: the bus index
1962 # @devices: a list of devices on this bus
1966 { 'struct': 'PciInfo', 'data': {'bus': 'int', 'devices': ['PciDeviceInfo']} }
1971 # Return information about the PCI bus topology of the guest.
1973 # Returns: a list of @PciInfo for each PCI bus. Each bus is
1974 # represented by a json-object, which has a key with a json-array of
1975 # all PCI devices attached to it. Each device is represented by a
1982 # -> { "execute": "query-pci" }
1993 # "desc": "Host bridge"
2009 # "desc": "ISA bridge"
2025 # "desc": "IDE controller"
2047 # "desc": "VGA controller"
2057 # "mem_type_64": false,
2060 # "address": 4026531840,
2064 # "prefetch": false,
2065 # "mem_type_64": false,
2068 # "address": 4060086272,
2072 # "prefetch": false,
2073 # "mem_type_64": false,
2088 # "desc": "RAM controller"
2109 # Note: This example has been shortened as the real response is too long.
2112 { 'command': 'query-pci', 'returns': ['PciInfo'] }
2117 # This command will cause the QEMU process to exit gracefully. While every
2118 # attempt is made to send the QMP response before terminating, this is not
2119 # guaranteed. When using this interface, a premature EOF would not be
2126 # -> { "execute": "quit" }
2127 # <- { "return": {} }
2129 { 'command': 'quit' }
2134 # Stop all guest VCPU execution.
2138 # Notes: This function will succeed even if the guest is already in the stopped
2139 # state. In "inmigrate" state, it will ensure that the guest
2140 # remains paused once migration finishes, as if the -S option was
2141 # passed on the command line.
2145 # -> { "execute": "stop" }
2146 # <- { "return": {} }
2149 { 'command': 'stop' }
2154 # Performs a hard reset of a guest.
2160 # -> { "execute": "system_reset" }
2161 # <- { "return": {} }
2164 { 'command': 'system_reset' }
2167 # @system_powerdown:
2169 # Requests that a guest perform a powerdown operation.
2173 # Notes: A guest may or may not respond to this command. This command
2174 # returning does not indicate that a guest has accepted the request or
2175 # that it has shut down. Many guests will respond to this command by
2176 # prompting the user in some way.
2179 # -> { "execute": "system_powerdown" }
2180 # <- { "return": {} }
2183 { 'command': 'system_powerdown' }
2188 # This command is a nop that is only provided for the purposes of compatibility.
2192 # Notes: Do not use this command.
2194 { 'command': 'cpu', 'data': {'index': 'int'} }
2199 # Adds CPU with specified ID
2201 # @id: ID of CPU to be created, valid values [0..max_cpus)
2203 # Returns: Nothing on success
2207 { 'command': 'cpu-add', 'data': {'id': 'int'} }
2212 # Save a portion of guest memory to a file.
2214 # @val: the virtual address of the guest to start from
2216 # @size: the size of memory region to save
2218 # @filename: the file to save the memory to as binary data
2220 # @cpu-index: #optional the index of the virtual CPU to use for translating the
2221 # virtual address (defaults to CPU 0)
2223 # Returns: Nothing on success
2227 # Notes: Errors were not reliably returned until 1.1
2229 { 'command': 'memsave',
2230 'data': {'val': 'int', 'size': 'int', 'filename': 'str', '*cpu-index': 'int'} }
2235 # Save a portion of guest physical memory to a file.
2237 # @val: the physical address of the guest to start from
2239 # @size: the size of memory region to save
2241 # @filename: the file to save the memory to as binary data
2243 # Returns: Nothing on success
2247 # Notes: Errors were not reliably returned until 1.1
2249 { 'command': 'pmemsave',
2250 'data': {'val': 'int', 'size': 'int', 'filename': 'str'} }
2255 # Resume guest VCPU execution.
2259 # Returns: If successful, nothing
2260 # If QEMU was started with an encrypted block device and a key has
2261 # not yet been set, DeviceEncrypted.
2263 # Notes: This command will succeed if the guest is currently running. It
2264 # will also succeed if the guest is in the "inmigrate" state; in
2265 # this case, the effect of the command is to make sure the guest
2266 # starts once migration finishes, removing the effect of the -S
2267 # command line option if it was passed.
2269 { 'command': 'cont' }
2274 # Wakeup guest from suspend. Does nothing in case the guest isn't suspended.
2280 { 'command': 'system_wakeup' }
2285 # Injects a Non-Maskable Interrupt into the default CPU (x86/s390) or all CPUs (ppc64).
2287 # Returns: If successful, nothing
2291 # Note: prior to 2.1, this command was only supported for x86 and s390 VMs
2293 { 'command': 'inject-nmi' }
2298 # Sets the link status of a virtual network adapter.
2300 # @name: the device name of the virtual network adapter
2302 # @up: true to set the link status to be up
2304 # Returns: Nothing on success
2305 # If @name is not a valid network device, DeviceNotFound
2309 # Notes: Not all network adapters support setting link status. This command
2310 # will succeed even if the network adapter does not support link status
2313 { 'command': 'set_link', 'data': {'name': 'str', 'up': 'bool'} }
2318 # Request the balloon driver to change its balloon size.
2320 # @value: the target size of the balloon in bytes
2322 # Returns: Nothing on success
2323 # If the balloon driver is enabled but not functional because the KVM
2324 # kernel module cannot support it, KvmMissingCap
2325 # If no balloon device is present, DeviceNotActive
2327 # Notes: This command just issues a request to the guest. When it returns,
2328 # the balloon size may not have changed. A guest can change the balloon
2329 # size independent of this command.
2333 { 'command': 'balloon', 'data': {'value': 'int'} }
2338 # This action can be used to test transaction failure.
2342 { 'struct': 'Abort',
2346 # @ActionCompletionMode:
2348 # An enumeration of Transactional completion modes.
2350 # @individual: Do not attempt to cancel any other Actions if any Actions fail
2351 # after the Transaction request succeeds. All Actions that
2352 # can complete successfully will do so without waiting on others.
2353 # This is the default.
2355 # @grouped: If any Action fails after the Transaction succeeds, cancel all
2356 # Actions. Actions do not complete until all Actions are ready to
2357 # complete. May be rejected by Actions that do not support this
2362 { 'enum': 'ActionCompletionMode',
2363 'data': [ 'individual', 'grouped' ] }
2366 # @TransactionAction:
2368 # A discriminated record of operations that can be performed with
2369 # @transaction. Action @type can be:
2371 # - @abort: since 1.6
2372 # - @block-dirty-bitmap-add: since 2.5
2373 # - @block-dirty-bitmap-clear: since 2.5
2374 # - @blockdev-backup: since 2.3
2375 # - @blockdev-snapshot: since 2.5
2376 # - @blockdev-snapshot-internal-sync: since 1.7
2377 # - @blockdev-snapshot-sync: since 1.1
2378 # - @drive-backup: since 1.6
2382 { 'union': 'TransactionAction',
2385 'block-dirty-bitmap-add': 'BlockDirtyBitmapAdd',
2386 'block-dirty-bitmap-clear': 'BlockDirtyBitmap',
2387 'blockdev-backup': 'BlockdevBackup',
2388 'blockdev-snapshot': 'BlockdevSnapshot',
2389 'blockdev-snapshot-internal-sync': 'BlockdevSnapshotInternal',
2390 'blockdev-snapshot-sync': 'BlockdevSnapshotSync',
2391 'drive-backup': 'DriveBackup'
2395 # @TransactionProperties:
2397 # Optional arguments to modify the behavior of a Transaction.
2399 # @completion-mode: #optional Controls how jobs launched asynchronously by
2400 # Actions will complete or fail as a group.
2401 # See @ActionCompletionMode for details.
2405 { 'struct': 'TransactionProperties',
2407 '*completion-mode': 'ActionCompletionMode'
2414 # Executes a number of transactionable QMP commands atomically. If any
2415 # operation fails, then the entire set of actions will be abandoned and the
2416 # appropriate error returned.
2418 # @actions: List of @TransactionAction;
2419 # information needed for the respective operations.
2421 # @properties: #optional structure of additional options to control the
2422 # execution of the transaction. See @TransactionProperties
2423 # for additional detail.
2425 # Returns: nothing on success
2426 # Errors depend on the operations of the transaction
2428 # Note: The transaction aborts on the first failure. Therefore, there will be
2429 # information on only one failed operation returned in an error condition, and
2430 # subsequent actions will not have been attempted.
2434 { 'command': 'transaction',
2435 'data': { 'actions': [ 'TransactionAction' ],
2436 '*properties': 'TransactionProperties'
2441 # @human-monitor-command:
2443 # Execute a command on the human monitor and return the output.
2445 # @command-line: the command to execute in the human monitor
2447 # @cpu-index: #optional The CPU to use for commands that require an implicit CPU
2449 # Returns: the output of the command as a string
2453 # Notes: This command only exists as a stop-gap. Its use is highly
2454 # discouraged. The semantics of this command are not guaranteed.
2456 # Known limitations:
2458 # * This command is stateless, this means that commands that depend
2459 # on state information (such as getfd) might not work
2461 # * Commands that prompt the user for data (eg. 'cont' when the block
2462 # device is encrypted) don't currently work
2464 { 'command': 'human-monitor-command',
2465 'data': {'command-line': 'str', '*cpu-index': 'int'},
2471 # Cancel the current executing migration process.
2473 # Returns: nothing on success
2475 # Notes: This command succeeds even if there is no migration process running.
2479 { 'command': 'migrate_cancel' }
2482 # @migrate_set_downtime:
2484 # Set maximum tolerated downtime for migration.
2486 # @value: maximum downtime in seconds
2488 # Returns: nothing on success
2490 # Notes: This command is deprecated in favor of 'migrate-set-parameters'
2494 { 'command': 'migrate_set_downtime', 'data': {'value': 'number'} }
2497 # @migrate_set_speed:
2499 # Set maximum speed for migration.
2501 # @value: maximum speed in bytes.
2503 # Returns: nothing on success
2505 # Notes: This command is deprecated in favor of 'migrate-set-parameters'
2509 { 'command': 'migrate_set_speed', 'data': {'value': 'int'} }
2512 # @migrate-set-cache-size:
2514 # Set XBZRLE cache size
2516 # @value: cache size in bytes
2518 # The size will be rounded down to the nearest power of 2.
2519 # The cache size can be modified before and during ongoing migration
2521 # Returns: nothing on success
2525 { 'command': 'migrate-set-cache-size', 'data': {'value': 'int'} }
2528 # @query-migrate-cache-size:
2530 # query XBZRLE cache size
2532 # Returns: XBZRLE cache size in bytes
2536 { 'command': 'query-migrate-cache-size', 'returns': 'int' }
2539 # @ObjectPropertyInfo:
2541 # @name: the name of the property
2543 # @type: the type of the property. This will typically come in one of four
2546 # 1) A primitive type such as 'u8', 'u16', 'bool', 'str', or 'double'.
2547 # These types are mapped to the appropriate JSON type.
2549 # 2) A child type in the form 'child<subtype>' where subtype is a qdev
2550 # device type name. Child properties create the composition tree.
2552 # 3) A link type in the form 'link<subtype>' where subtype is a qdev
2553 # device type name. Link properties form the device model graph.
2557 { 'struct': 'ObjectPropertyInfo',
2558 'data': { 'name': 'str', 'type': 'str' } }
2563 # This command will list any properties of a object given a path in the object
2566 # @path: the path within the object model. See @qom-get for a description of
2569 # Returns: a list of @ObjectPropertyInfo that describe the properties of the
2574 { 'command': 'qom-list',
2575 'data': { 'path': 'str' },
2576 'returns': [ 'ObjectPropertyInfo' ] }
2581 # This command will get a property from a object model path and return the
2584 # @path: The path within the object model. There are two forms of supported
2585 # paths--absolute and partial paths.
2587 # Absolute paths are derived from the root object and can follow child<>
2588 # or link<> properties. Since they can follow link<> properties, they
2589 # can be arbitrarily long. Absolute paths look like absolute filenames
2590 # and are prefixed with a leading slash.
2592 # Partial paths look like relative filenames. They do not begin
2593 # with a prefix. The matching rules for partial paths are subtle but
2594 # designed to make specifying objects easy. At each level of the
2595 # composition tree, the partial path is matched as an absolute path.
2596 # The first match is not returned. At least two matches are searched
2597 # for. A successful result is only returned if only one match is
2598 # found. If more than one match is found, a flag is return to
2599 # indicate that the match was ambiguous.
2601 # @property: The property name to read
2603 # Returns: The property value. The type depends on the property
2604 # type. child<> and link<> properties are returned as #str
2605 # pathnames. All integer property types (u8, u16, etc) are
2610 { 'command': 'qom-get',
2611 'data': { 'path': 'str', 'property': 'str' },
2617 # This command will set a property from a object model path.
2619 # @path: see @qom-get for a description of this parameter
2621 # @property: the property name to set
2623 # @value: a value who's type is appropriate for the property type. See @qom-get
2624 # for a description of type mapping.
2628 { 'command': 'qom-set',
2629 'data': { 'path': 'str', 'property': 'str', 'value': 'any' } }
2634 # Sets the password of a remote display session.
2636 # @protocol: `vnc' to modify the VNC server password
2637 # `spice' to modify the Spice server password
2639 # @password: the new password
2641 # @connected: #optional how to handle existing clients when changing the
2642 # password. If nothing is specified, defaults to `keep'
2643 # `fail' to fail the command if clients are connected
2644 # `disconnect' to disconnect existing clients
2645 # `keep' to maintain existing clients
2647 # Returns: Nothing on success
2648 # If Spice is not enabled, DeviceNotFound
2652 { 'command': 'set_password',
2653 'data': {'protocol': 'str', 'password': 'str', '*connected': 'str'} }
2658 # Expire the password of a remote display server.
2660 # @protocol: the name of the remote display protocol `vnc' or `spice'
2662 # @time: when to expire the password.
2663 # `now' to expire the password immediately
2664 # `never' to cancel password expiration
2665 # `+INT' where INT is the number of seconds from now (integer)
2666 # `INT' where INT is the absolute time in seconds
2668 # Returns: Nothing on success
2669 # If @protocol is `spice' and Spice is not active, DeviceNotFound
2673 # Notes: Time is relative to the server and currently there is no way to
2674 # coordinate server time with client time. It is not recommended to
2675 # use the absolute time version of the @time parameter unless you're
2676 # sure you are on the same machine as the QEMU instance.
2678 { 'command': 'expire_password', 'data': {'protocol': 'str', 'time': 'str'} }
2681 # @change-vnc-password:
2683 # Change the VNC server password.
2685 # @password: the new password to use with VNC authentication
2689 # Notes: An empty password in this command will set the password to the empty
2690 # string. Existing clients are unaffected by executing this command.
2692 { 'command': 'change-vnc-password', 'data': {'password': 'str'} }
2697 # This command is multiple commands multiplexed together.
2699 # @device: This is normally the name of a block device but it may also be 'vnc'.
2700 # when it's 'vnc', then sub command depends on @target
2702 # @target: If @device is a block device, then this is the new filename.
2703 # If @device is 'vnc', then if the value 'password' selects the vnc
2704 # change password command. Otherwise, this specifies a new server URI
2705 # address to listen to for VNC connections.
2707 # @arg: If @device is a block device, then this is an optional format to open
2709 # If @device is 'vnc' and @target is 'password', this is the new VNC
2710 # password to set. If this argument is an empty string, then no future
2711 # logins will be allowed.
2713 # Returns: Nothing on success.
2714 # If @device is not a valid block device, DeviceNotFound
2715 # If the new block device is encrypted, DeviceEncrypted. Note that
2716 # if this error is returned, the device has been opened successfully
2717 # and an additional call to @block_passwd is required to set the
2718 # device's password. The behavior of reads and writes to the block
2719 # device between when these calls are executed is undefined.
2721 # Notes: This interface is deprecated, and it is strongly recommended that you
2722 # avoid using it. For changing block devices, use
2723 # blockdev-change-medium; for changing VNC parameters, use
2724 # change-vnc-password.
2728 { 'command': 'change',
2729 'data': {'device': 'str', 'target': 'str', '*arg': 'str'} }
2734 # This structure describes a search result from @qom-list-types
2736 # @name: the type name found in the search
2740 # Notes: This command is experimental and may change syntax in future releases.
2742 { 'struct': 'ObjectTypeInfo',
2743 'data': { 'name': 'str' } }
2748 # This command will return a list of types given search parameters
2750 # @implements: if specified, only return types that implement this type name
2752 # @abstract: if true, include abstract types in the results
2754 # Returns: a list of @ObjectTypeInfo or an empty list if no results are found
2758 { 'command': 'qom-list-types',
2759 'data': { '*implements': 'str', '*abstract': 'bool' },
2760 'returns': [ 'ObjectTypeInfo' ] }
2763 # @DevicePropertyInfo:
2765 # Information about device properties.
2767 # @name: the name of the property
2768 # @type: the typename of the property
2769 # @description: #optional if specified, the description of the property.
2774 { 'struct': 'DevicePropertyInfo',
2775 'data': { 'name': 'str', 'type': 'str', '*description': 'str' } }
2778 # @device-list-properties:
2780 # List properties associated with a device.
2782 # @typename: the type name of a device
2784 # Returns: a list of DevicePropertyInfo describing a devices properties
2788 { 'command': 'device-list-properties',
2789 'data': { 'typename': 'str'},
2790 'returns': [ 'DevicePropertyInfo' ] }
2795 # Migrates the current running guest to another Virtual Machine.
2797 # @uri: the Uniform Resource Identifier of the destination VM
2799 # @blk: #optional do block migration (full disk copy)
2801 # @inc: #optional incremental disk copy migration
2803 # @detach: this argument exists only for compatibility reasons and
2804 # is ignored by QEMU
2806 # Returns: nothing on success
2810 { 'command': 'migrate',
2811 'data': {'uri': 'str', '*blk': 'bool', '*inc': 'bool', '*detach': 'bool' } }
2814 # @migrate-incoming:
2816 # Start an incoming migration, the qemu must have been started
2817 # with -incoming defer
2819 # @uri: The Uniform Resource Identifier identifying the source or
2820 # address to listen on
2822 # Returns: nothing on success
2825 # Note: It's a bad idea to use a string for the uri, but it needs to stay
2826 # compatible with -incoming and the format of the uri is already exposed
2829 { 'command': 'migrate-incoming', 'data': {'uri': 'str' } }
2832 # @xen-save-devices-state:
2834 # Save the state of all devices to file. The RAM and the block devices
2835 # of the VM are not saved by this command.
2837 # @filename: the file to save the state of the devices to as binary
2838 # data. See xen-save-devices-state.txt for a description of the binary
2841 # Returns: Nothing on success
2845 { 'command': 'xen-save-devices-state', 'data': {'filename': 'str'} }
2848 # @xen-set-global-dirty-log:
2850 # Enable or disable the global dirty log mode.
2852 # @enable: true to enable, false to disable.
2858 { 'command': 'xen-set-global-dirty-log', 'data': { 'enable': 'bool' } }
2863 # @driver: the name of the new device's driver
2865 # @bus: #optional the device's parent bus (device tree path)
2867 # @id: #optional the device's ID, must be unique
2869 # Additional arguments depend on the type.
2874 # 1. For detailed information about this command, please refer to the
2875 # 'docs/qdev-device-use.txt' file.
2877 # 2. It's possible to list device properties by running QEMU with the
2878 # "-device DEVICE,help" command-line argument, where DEVICE is the
2883 # -> { "execute": "device_add",
2884 # "arguments": { "driver": "e1000", "id": "net1",
2886 # "mac": "52:54:00:12:34:56" } }
2887 # <- { "return": {} }
2889 # TODO: This command effectively bypasses QAPI completely due to its
2890 # "additional arguments" business. It shouldn't have been added to
2891 # the schema in this form. It should be qapified properly, or
2892 # replaced by a properly qapified command.
2896 { 'command': 'device_add',
2897 'data': {'driver': 'str', '*bus': 'str', '*id': 'str'},
2898 'gen': false } # so we can get the additional arguments
2903 # Remove a device from a guest
2905 # @id: the name or QOM path of the device
2907 # Returns: Nothing on success
2908 # If @id is not a valid device, DeviceNotFound
2910 # Notes: When this command completes, the device may not be removed from the
2911 # guest. Hot removal is an operation that requires guest cooperation.
2912 # This command merely requests that the guest begin the hot removal
2913 # process. Completion of the device removal process is signaled with a
2914 # DEVICE_DELETED event. Guest reset will automatically complete removal
2919 { 'command': 'device_del', 'data': {'id': 'str'} }
2922 # @DumpGuestMemoryFormat:
2924 # An enumeration of guest-memory-dump's format.
2928 # @kdump-zlib: kdump-compressed format with zlib-compressed
2930 # @kdump-lzo: kdump-compressed format with lzo-compressed
2932 # @kdump-snappy: kdump-compressed format with snappy-compressed
2936 { 'enum': 'DumpGuestMemoryFormat',
2937 'data': [ 'elf', 'kdump-zlib', 'kdump-lzo', 'kdump-snappy' ] }
2940 # @dump-guest-memory:
2942 # Dump guest's memory to vmcore. It is a synchronous operation that can take
2943 # very long depending on the amount of guest memory.
2945 # @paging: if true, do paging to get guest's memory mapping. This allows
2946 # using gdb to process the core file.
2948 # IMPORTANT: this option can make QEMU allocate several gigabytes
2949 # of RAM. This can happen for a large guest, or a
2950 # malicious guest pretending to be large.
2952 # Also, paging=true has the following limitations:
2954 # 1. The guest may be in a catastrophic state or can have corrupted
2955 # memory, which cannot be trusted
2956 # 2. The guest can be in real-mode even if paging is enabled. For
2957 # example, the guest uses ACPI to sleep, and ACPI sleep state
2959 # 3. Currently only supported on i386 and x86_64.
2961 # @protocol: the filename or file descriptor of the vmcore. The supported
2964 # 1. file: the protocol starts with "file:", and the following
2965 # string is the file's path.
2966 # 2. fd: the protocol starts with "fd:", and the following string
2969 # @detach: #optional if true, QMP will return immediately rather than
2970 # waiting for the dump to finish. The user can track progress
2971 # using "query-dump". (since 2.6).
2973 # @begin: #optional if specified, the starting physical address.
2975 # @length: #optional if specified, the memory size, in bytes. If you don't
2976 # want to dump all guest's memory, please specify the start @begin
2979 # @format: #optional if specified, the format of guest memory dump. But non-elf
2980 # format is conflict with paging and filter, ie. @paging, @begin and
2981 # @length is not allowed to be specified with non-elf @format at the
2982 # same time (since 2.0)
2984 # Returns: nothing on success
2988 { 'command': 'dump-guest-memory',
2989 'data': { 'paging': 'bool', 'protocol': 'str', '*detach': 'bool',
2990 '*begin': 'int', '*length': 'int',
2991 '*format': 'DumpGuestMemoryFormat'} }
2996 # Describe the status of a long-running background guest memory dump.
2998 # @none: no dump-guest-memory has started yet.
3000 # @active: there is one dump running in background.
3002 # @completed: the last dump has finished successfully.
3004 # @failed: the last dump has failed.
3008 { 'enum': 'DumpStatus',
3009 'data': [ 'none', 'active', 'completed', 'failed' ] }
3014 # The result format for 'query-dump'.
3016 # @status: enum of @DumpStatus, which shows current dump status
3018 # @completed: bytes written in latest dump (uncompressed)
3020 # @total: total bytes to be written in latest dump (uncompressed)
3024 { 'struct': 'DumpQueryResult',
3025 'data': { 'status': 'DumpStatus',
3032 # Query latest dump status.
3034 # Returns: A @DumpStatus object showing the dump status.
3038 { 'command': 'query-dump', 'returns': 'DumpQueryResult' }
3041 # @DumpGuestMemoryCapability:
3043 # A list of the available formats for dump-guest-memory
3047 { 'struct': 'DumpGuestMemoryCapability',
3049 'formats': ['DumpGuestMemoryFormat'] } }
3052 # @query-dump-guest-memory-capability:
3054 # Returns the available formats for dump-guest-memory
3056 # Returns: A @DumpGuestMemoryCapability object listing available formats for
3061 { 'command': 'query-dump-guest-memory-capability',
3062 'returns': 'DumpGuestMemoryCapability' }
3067 # Dump guest's storage keys
3069 # @filename: the path to the file to dump to
3071 # This command is only supported on s390 architecture.
3075 { 'command': 'dump-skeys',
3076 'data': { 'filename': 'str' } }
3081 # Add a network backend.
3083 # @type: the type of network backend. Current valid values are 'user', 'tap',
3084 # 'vde', 'socket', 'dump' and 'bridge'
3086 # @id: the name of the new network backend
3088 # Additional arguments depend on the type.
3090 # TODO: This command effectively bypasses QAPI completely due to its
3091 # "additional arguments" business. It shouldn't have been added to
3092 # the schema in this form. It should be qapified properly, or
3093 # replaced by a properly qapified command.
3097 # Returns: Nothing on success
3098 # If @type is not a valid network backend, DeviceNotFound
3100 { 'command': 'netdev_add',
3101 'data': {'type': 'str', 'id': 'str'},
3102 'gen': false } # so we can get the additional arguments
3107 # Remove a network backend.
3109 # @id: the name of the network backend to remove
3111 # Returns: Nothing on success
3112 # If @id is not a valid network backend, DeviceNotFound
3116 { 'command': 'netdev_del', 'data': {'id': 'str'} }
3121 # Create a QOM object.
3123 # @qom-type: the class name for the object to be created
3125 # @id: the name of the new object
3127 # @props: #optional a dictionary of properties to be passed to the backend
3129 # Returns: Nothing on success
3130 # Error if @qom-type is not a valid class name
3134 { 'command': 'object-add',
3135 'data': {'qom-type': 'str', 'id': 'str', '*props': 'any'} }
3140 # Remove a QOM object.
3142 # @id: the name of the QOM object to remove
3144 # Returns: Nothing on success
3145 # Error if @id is not a valid id for a QOM object
3149 { 'command': 'object-del', 'data': {'id': 'str'} }
3152 # @NetdevNoneOptions:
3154 # Use it alone to have zero network devices.
3158 { 'struct': 'NetdevNoneOptions',
3162 # @NetLegacyNicOptions:
3164 # Create a new Network Interface Card.
3166 # @netdev: #optional id of -netdev to connect to
3168 # @macaddr: #optional MAC address
3170 # @model: #optional device model (e1000, rtl8139, virtio etc.)
3172 # @addr: #optional PCI device address
3174 # @vectors: #optional number of MSI-x vectors, 0 to disable MSI-X
3178 { 'struct': 'NetLegacyNicOptions',
3184 '*vectors': 'uint32' } }
3189 # A fat type wrapping 'str', to be embedded in lists.
3193 { 'struct': 'String',
3198 # @NetdevUserOptions:
3200 # Use the user mode network stack which requires no administrator privilege to
3203 # @hostname: #optional client hostname reported by the builtin DHCP server
3205 # @restrict: #optional isolate the guest from the host
3207 # @ipv4: #optional whether to support IPv4, default true for enabled
3210 # @ipv6: #optional whether to support IPv6, default true for enabled
3213 # @ip: #optional legacy parameter, use net= instead
3215 # @net: #optional IP network address that the guest will see, in the
3216 # form addr[/netmask] The netmask is optional, and can be
3217 # either in the form a.b.c.d or as a number of valid top-most
3218 # bits. Default is 10.0.2.0/24.
3220 # @host: #optional guest-visible address of the host
3222 # @tftp: #optional root directory of the built-in TFTP server
3224 # @bootfile: #optional BOOTP filename, for use with tftp=
3226 # @dhcpstart: #optional the first of the 16 IPs the built-in DHCP server can
3229 # @dns: #optional guest-visible address of the virtual nameserver
3231 # @dnssearch: #optional list of DNS suffixes to search, passed as DHCP option
3234 # @ipv6-prefix: #optional IPv6 network prefix (default is fec0::) (since
3235 # 2.6). The network prefix is given in the usual
3236 # hexadecimal IPv6 address notation.
3238 # @ipv6-prefixlen: #optional IPv6 network prefix length (default is 64)
3241 # @ipv6-host: #optional guest-visible IPv6 address of the host (since 2.6)
3243 # @ipv6-dns: #optional guest-visible IPv6 address of the virtual
3244 # nameserver (since 2.6)
3246 # @smb: #optional root directory of the built-in SMB server
3248 # @smbserver: #optional IP address of the built-in SMB server
3250 # @hostfwd: #optional redirect incoming TCP or UDP host connections to guest
3253 # @guestfwd: #optional forward guest TCP connections
3257 { 'struct': 'NetdevUserOptions',
3260 '*restrict': 'bool',
3268 '*dhcpstart': 'str',
3270 '*dnssearch': ['String'],
3271 '*ipv6-prefix': 'str',
3272 '*ipv6-prefixlen': 'int',
3273 '*ipv6-host': 'str',
3276 '*smbserver': 'str',
3277 '*hostfwd': ['String'],
3278 '*guestfwd': ['String'] } }
3281 # @NetdevTapOptions:
3283 # Connect the host TAP network interface name to the VLAN.
3285 # @ifname: #optional interface name
3287 # @fd: #optional file descriptor of an already opened tap
3289 # @fds: #optional multiple file descriptors of already opened multiqueue capable
3292 # @script: #optional script to initialize the interface
3294 # @downscript: #optional script to shut down the interface
3296 # @br: #optional bridge name (since 2.8)
3298 # @helper: #optional command to execute to configure bridge
3300 # @sndbuf: #optional send buffer limit. Understands [TGMKkb] suffixes.
3302 # @vnet_hdr: #optional enable the IFF_VNET_HDR flag on the tap interface
3304 # @vhost: #optional enable vhost-net network accelerator
3306 # @vhostfd: #optional file descriptor of an already opened vhost net device
3308 # @vhostfds: #optional file descriptors of multiple already opened vhost net
3311 # @vhostforce: #optional vhost on for non-MSIX virtio guests
3313 # @queues: #optional number of queues to be created for multiqueue capable tap
3315 # @poll-us: #optional maximum number of microseconds that could
3316 # be spent on busy polling for tap (since 2.7)
3320 { 'struct': 'NetdevTapOptions',
3326 '*downscript': 'str',
3330 '*vnet_hdr': 'bool',
3334 '*vhostforce': 'bool',
3335 '*queues': 'uint32',
3336 '*poll-us': 'uint32'} }
3339 # @NetdevSocketOptions:
3341 # Connect the VLAN to a remote VLAN in another QEMU virtual machine using a TCP
3342 # socket connection.
3344 # @fd: #optional file descriptor of an already opened socket
3346 # @listen: #optional port number, and optional hostname, to listen on
3348 # @connect: #optional port number, and optional hostname, to connect to
3350 # @mcast: #optional UDP multicast address and port number
3352 # @localaddr: #optional source address and port for multicast and udp packets
3354 # @udp: #optional UDP unicast address and port number
3358 { 'struct': 'NetdevSocketOptions',
3364 '*localaddr': 'str',
3368 # @NetdevL2TPv3Options:
3370 # Connect the VLAN to Ethernet over L2TPv3 Static tunnel
3372 # @src: source address
3374 # @dst: destination address
3376 # @srcport: #optional source port - mandatory for udp, optional for ip
3378 # @dstport: #optional destination port - mandatory for udp, optional for ip
3380 # @ipv6: #optional - force the use of ipv6
3382 # @udp: #optional - use the udp version of l2tpv3 encapsulation
3384 # @cookie64: #optional - use 64 bit coookies
3386 # @counter: #optional have sequence counter
3388 # @pincounter: #optional pin sequence counter to zero -
3389 # workaround for buggy implementations or
3390 # networks with packet reorder
3392 # @txcookie: #optional 32 or 64 bit transmit cookie
3394 # @rxcookie: #optional 32 or 64 bit receive cookie
3396 # @txsession: 32 bit transmit session
3398 # @rxsession: #optional 32 bit receive session - if not specified
3399 # set to the same value as transmit
3401 # @offset: #optional additional offset - allows the insertion of
3402 # additional application-specific data before the packet payload
3406 { 'struct': 'NetdevL2TPv3Options',
3414 '*cookie64': 'bool',
3416 '*pincounter': 'bool',
3417 '*txcookie': 'uint64',
3418 '*rxcookie': 'uint64',
3419 'txsession': 'uint32',
3420 '*rxsession': 'uint32',
3421 '*offset': 'uint32' } }
3424 # @NetdevVdeOptions:
3426 # Connect the VLAN to a vde switch running on the host.
3428 # @sock: #optional socket path
3430 # @port: #optional port number
3432 # @group: #optional group owner of socket
3434 # @mode: #optional permissions for socket
3438 { 'struct': 'NetdevVdeOptions',
3443 '*mode': 'uint16' } }
3446 # @NetdevDumpOptions:
3448 # Dump VLAN network traffic to a file.
3450 # @len: #optional per-packet size limit (64k default). Understands [TGMKkb]
3453 # @file: #optional dump file path (default is qemu-vlan0.pcap)
3457 { 'struct': 'NetdevDumpOptions',
3463 # @NetdevBridgeOptions:
3465 # Connect a host TAP network interface to a host bridge device.
3467 # @br: #optional bridge name
3469 # @helper: #optional command to execute to configure bridge
3473 { 'struct': 'NetdevBridgeOptions',
3476 '*helper': 'str' } }
3479 # @NetdevHubPortOptions:
3481 # Connect two or more net clients through a software hub.
3483 # @hubid: hub identifier number
3487 { 'struct': 'NetdevHubPortOptions',
3489 'hubid': 'int32' } }
3492 # @NetdevNetmapOptions:
3494 # Connect a client to a netmap-enabled NIC or to a VALE switch port
3496 # @ifname: Either the name of an existing network interface supported by
3497 # netmap, or the name of a VALE port (created on the fly).
3498 # A VALE port name is in the form 'valeXXX:YYY', where XXX and
3499 # YYY are non-negative integers. XXX identifies a switch and
3500 # YYY identifies a port of the switch. VALE ports having the
3501 # same XXX are therefore connected to the same switch.
3503 # @devname: #optional path of the netmap device (default: '/dev/netmap').
3507 { 'struct': 'NetdevNetmapOptions',
3510 '*devname': 'str' } }
3513 # @NetdevVhostUserOptions:
3515 # Vhost-user network backend
3517 # @chardev: name of a unix socket chardev
3519 # @vhostforce: #optional vhost on for non-MSIX virtio guests (default: false).
3521 # @queues: #optional number of queues to be created for multiqueue vhost-user
3522 # (default: 1) (Since 2.5)
3526 { 'struct': 'NetdevVhostUserOptions',
3529 '*vhostforce': 'bool',
3530 '*queues': 'int' } }
3535 # Available netdev drivers.
3539 { 'enum': 'NetClientDriver',
3540 'data': [ 'none', 'nic', 'user', 'tap', 'l2tpv3', 'socket', 'vde', 'dump',
3541 'bridge', 'hubport', 'netmap', 'vhost-user' ] }
3546 # Captures the configuration of a network device.
3548 # @id: identifier for monitor commands.
3550 # @type: Specify the driver used for interpreting remaining arguments.
3554 # 'l2tpv3' - since 2.1
3556 { 'union': 'Netdev',
3557 'base': { 'id': 'str', 'type': 'NetClientDriver' },
3558 'discriminator': 'type',
3560 'none': 'NetdevNoneOptions',
3561 'nic': 'NetLegacyNicOptions',
3562 'user': 'NetdevUserOptions',
3563 'tap': 'NetdevTapOptions',
3564 'l2tpv3': 'NetdevL2TPv3Options',
3565 'socket': 'NetdevSocketOptions',
3566 'vde': 'NetdevVdeOptions',
3567 'dump': 'NetdevDumpOptions',
3568 'bridge': 'NetdevBridgeOptions',
3569 'hubport': 'NetdevHubPortOptions',
3570 'netmap': 'NetdevNetmapOptions',
3571 'vhost-user': 'NetdevVhostUserOptions' } }
3576 # Captures the configuration of a network device; legacy.
3578 # @vlan: #optional vlan number
3580 # @id: #optional identifier for monitor commands
3582 # @name: #optional identifier for monitor commands, ignored if @id is present
3584 # @opts: device type specific properties (legacy)
3588 { 'struct': 'NetLegacy',
3593 'opts': 'NetLegacyOptions' } }
3596 # @NetLegacyOptions:
3598 # Like Netdev, but for use only by the legacy command line options
3602 { 'union': 'NetLegacyOptions',
3604 'none': 'NetdevNoneOptions',
3605 'nic': 'NetLegacyNicOptions',
3606 'user': 'NetdevUserOptions',
3607 'tap': 'NetdevTapOptions',
3608 'l2tpv3': 'NetdevL2TPv3Options',
3609 'socket': 'NetdevSocketOptions',
3610 'vde': 'NetdevVdeOptions',
3611 'dump': 'NetdevDumpOptions',
3612 'bridge': 'NetdevBridgeOptions',
3613 'netmap': 'NetdevNetmapOptions',
3614 'vhost-user': 'NetdevVhostUserOptions' } }
3617 # @NetFilterDirection:
3619 # Indicates whether a netfilter is attached to a netdev's transmit queue or
3620 # receive queue or both.
3622 # @all: the filter is attached both to the receive and the transmit
3623 # queue of the netdev (default).
3625 # @rx: the filter is attached to the receive queue of the netdev,
3626 # where it will receive packets sent to the netdev.
3628 # @tx: the filter is attached to the transmit queue of the netdev,
3629 # where it will receive packets sent by the netdev.
3633 { 'enum': 'NetFilterDirection',
3634 'data': [ 'all', 'rx', 'tx' ] }
3637 # @InetSocketAddress:
3639 # Captures a socket address or address range in the Internet namespace.
3641 # @host: host part of the address
3643 # @port: port part of the address, or lowest port if @to is present
3645 # @to: highest port to try
3647 # @ipv4: whether to accept IPv4 addresses, default try both IPv4 and IPv6
3650 # @ipv6: whether to accept IPv6 addresses, default try both IPv4 and IPv6
3655 { 'struct': 'InetSocketAddress',
3664 # @UnixSocketAddress:
3666 # Captures a socket address in the local ("Unix socket") namespace.
3668 # @path: filesystem path to use
3672 { 'struct': 'UnixSocketAddress',
3677 # @VsockSocketAddress:
3679 # Captures a socket address in the vsock namespace.
3681 # @cid: unique host identifier
3684 # Note: string types are used to allow for possible future hostname or
3685 # service resolution support.
3689 { 'struct': 'VsockSocketAddress',
3697 # Captures the address of a socket, which could also be a named file descriptor
3701 { 'union': 'SocketAddress',
3703 'inet': 'InetSocketAddress',
3704 'unix': 'UnixSocketAddress',
3705 'vsock': 'VsockSocketAddress',
3711 # Receive a file descriptor via SCM rights and assign it a name
3713 # @fdname: file descriptor name
3715 # Returns: Nothing on success
3719 # Notes: If @fdname already exists, the file descriptor assigned to
3720 # it will be closed and replaced by the received file
3722 # The 'closefd' command can be used to explicitly close the
3723 # file descriptor when it is no longer needed.
3725 { 'command': 'getfd', 'data': {'fdname': 'str'} }
3730 # Close a file descriptor previously passed via SCM rights
3732 # @fdname: file descriptor name
3734 # Returns: Nothing on success
3738 { 'command': 'closefd', 'data': {'fdname': 'str'} }
3743 # Information describing a machine.
3745 # @name: the name of the machine
3747 # @alias: #optional an alias for the machine name
3749 # @is-default: #optional whether the machine is default
3751 # @cpu-max: maximum number of CPUs supported by the machine type
3754 # @hotpluggable-cpus: cpu hotplug via -device is supported (since 2.7.0)
3758 { 'struct': 'MachineInfo',
3759 'data': { 'name': 'str', '*alias': 'str',
3760 '*is-default': 'bool', 'cpu-max': 'int',
3761 'hotpluggable-cpus': 'bool'} }
3766 # Return a list of supported machines
3768 # Returns: a list of MachineInfo
3772 { 'command': 'query-machines', 'returns': ['MachineInfo'] }
3775 # @CpuDefinitionInfo:
3777 # Virtual CPU definition.
3779 # @name: the name of the CPU definition
3781 # @migration-safe: #optional whether a CPU definition can be safely used for
3782 # migration in combination with a QEMU compatibility machine
3783 # when migrating between different QMU versions and between
3784 # hosts with different sets of (hardware or software)
3785 # capabilities. If not provided, information is not available
3786 # and callers should not assume the CPU definition to be
3787 # migration-safe. (since 2.8)
3789 # @static: whether a CPU definition is static and will not change depending on
3790 # QEMU version, machine type, machine options and accelerator options.
3791 # A static model is always migration-safe. (since 2.8)
3793 # @unavailable-features: #optional List of properties that prevent
3794 # the CPU model from running in the current
3796 # @typename: Type name that can be used as argument to @device-list-properties,
3797 # to introspect properties configurable using -cpu or -global.
3800 # @unavailable-features is a list of QOM property names that
3801 # represent CPU model attributes that prevent the CPU from running.
3802 # If the QOM property is read-only, that means there's no known
3803 # way to make the CPU model run in the current host. Implementations
3804 # that choose not to provide specific information return the
3805 # property name "type".
3806 # If the property is read-write, it means that it MAY be possible
3807 # to run the CPU model in the current host if that property is
3808 # changed. Management software can use it as hints to suggest or
3809 # choose an alternative for the user, or just to generate meaningful
3810 # error messages explaining why the CPU model can't be used.
3811 # If @unavailable-features is an empty list, the CPU model is
3812 # runnable using the current host and machine-type.
3813 # If @unavailable-features is not present, runnability
3814 # information for the CPU is not available.
3818 { 'struct': 'CpuDefinitionInfo',
3819 'data': { 'name': 'str', '*migration-safe': 'bool', 'static': 'bool',
3820 '*unavailable-features': [ 'str' ], 'typename': 'str' } }
3823 # @query-cpu-definitions:
3825 # Return a list of supported virtual CPU definitions
3827 # Returns: a list of CpuDefInfo
3831 { 'command': 'query-cpu-definitions', 'returns': ['CpuDefinitionInfo'] }
3836 # Virtual CPU model.
3838 # A CPU model consists of the name of a CPU definition, to which
3839 # delta changes are applied (e.g. features added/removed). Most magic values
3840 # that an architecture might require should be hidden behind the name.
3841 # However, if required, architectures can expose relevant properties.
3843 # @name: the name of the CPU definition the model is based on
3844 # @props: #optional a dictionary of QOM properties to be applied
3848 { 'struct': 'CpuModelInfo',
3849 'data': { 'name': 'str',
3853 # @CpuModelExpansionType:
3855 # An enumeration of CPU model expansion types.
3857 # @static: Expand to a static CPU model, a combination of a static base
3858 # model name and property delta changes. As the static base model will
3859 # never change, the expanded CPU model will be the same, independant of
3860 # independent of QEMU version, machine type, machine options, and
3861 # accelerator options. Therefore, the resulting model can be used by
3862 # tooling without having to specify a compatibility machine - e.g. when
3863 # displaying the "host" model. static CPU models are migration-safe.
3865 # @full: Expand all properties. The produced model is not guaranteed to be
3866 # migration-safe, but allows tooling to get an insight and work with
3871 { 'enum': 'CpuModelExpansionType',
3872 'data': [ 'static', 'full' ] }
3876 # @CpuModelExpansionInfo:
3878 # The result of a cpu model expansion.
3880 # @model: the expanded CpuModelInfo.
3884 { 'struct': 'CpuModelExpansionInfo',
3885 'data': { 'model': 'CpuModelInfo' } }
3889 # @query-cpu-model-expansion:
3891 # Expands a given CPU model (or a combination of CPU model + additional options)
3892 # to different granularities, allowing tooling to get an understanding what a
3893 # specific CPU model looks like in QEMU under a certain configuration.
3895 # This interface can be used to query the "host" CPU model.
3897 # The data returned by this command may be affected by:
3899 # * QEMU version: CPU models may look different depending on the QEMU version.
3900 # (Except for CPU models reported as "static" in query-cpu-definitions.)
3901 # * machine-type: CPU model may look different depending on the machine-type.
3902 # (Except for CPU models reported as "static" in query-cpu-definitions.)
3903 # * machine options (including accelerator): in some architectures, CPU models
3904 # may look different depending on machine and accelerator options. (Except for
3905 # CPU models reported as "static" in query-cpu-definitions.)
3906 # * "-cpu" arguments and global properties: arguments to the -cpu option and
3907 # global properties may affect expansion of CPU models. Using
3908 # query-cpu-model-expansion while using these is not advised.
3910 # Some architectures may not support all expansion types. s390x supports
3911 # "full" and "static".
3913 # Returns: a CpuModelExpansionInfo. Returns an error if expanding CPU models is
3914 # not supported, if the model cannot be expanded, if the model contains
3915 # an unknown CPU definition name, unknown properties or properties
3916 # with a wrong type. Also returns an error if an expansion type is
3921 { 'command': 'query-cpu-model-expansion',
3922 'data': { 'type': 'CpuModelExpansionType',
3923 'model': 'CpuModelInfo' },
3924 'returns': 'CpuModelExpansionInfo' }
3927 # @CpuModelCompareResult:
3929 # An enumeration of CPU model comparation results. The result is usually
3930 # calculated using e.g. CPU features or CPU generations.
3932 # @incompatible: If model A is incompatible to model B, model A is not
3933 # guaranteed to run where model B runs and the other way around.
3935 # @identical: If model A is identical to model B, model A is guaranteed to run
3936 # where model B runs and the other way around.
3938 # @superset: If model A is a superset of model B, model B is guaranteed to run
3939 # where model A runs. There are no guarantees about the other way.
3941 # @subset: If model A is a subset of model B, model A is guaranteed to run
3942 # where model B runs. There are no guarantees about the other way.
3946 { 'enum': 'CpuModelCompareResult',
3947 'data': [ 'incompatible', 'identical', 'superset', 'subset' ] }
3950 # @CpuModelCompareInfo:
3952 # The result of a CPU model comparison.
3954 # @result: The result of the compare operation.
3955 # @responsible-properties: List of properties that led to the comparison result
3956 # not being identical.
3958 # @responsible-properties is a list of QOM property names that led to
3959 # both CPUs not being detected as identical. For identical models, this
3961 # If a QOM property is read-only, that means there's no known way to make the
3962 # CPU models identical. If the special property name "type" is included, the
3963 # models are by definition not identical and cannot be made identical.
3967 { 'struct': 'CpuModelCompareInfo',
3968 'data': {'result': 'CpuModelCompareResult',
3969 'responsible-properties': ['str']
3974 # @query-cpu-model-comparison:
3976 # Compares two CPU models, returning how they compare in a specific
3977 # configuration. The results indicates how both models compare regarding
3978 # runnability. This result can be used by tooling to make decisions if a
3979 # certain CPU model will run in a certain configuration or if a compatible
3980 # CPU model has to be created by baselining.
3982 # Usually, a CPU model is compared against the maximum possible CPU model
3983 # of a certain configuration (e.g. the "host" model for KVM). If that CPU
3984 # model is identical or a subset, it will run in that configuration.
3986 # The result returned by this command may be affected by:
3988 # * QEMU version: CPU models may look different depending on the QEMU version.
3989 # (Except for CPU models reported as "static" in query-cpu-definitions.)
3990 # * machine-type: CPU model may look different depending on the machine-type.
3991 # (Except for CPU models reported as "static" in query-cpu-definitions.)
3992 # * machine options (including accelerator): in some architectures, CPU models
3993 # may look different depending on machine and accelerator options. (Except for
3994 # CPU models reported as "static" in query-cpu-definitions.)
3995 # * "-cpu" arguments and global properties: arguments to the -cpu option and
3996 # global properties may affect expansion of CPU models. Using
3997 # query-cpu-model-expansion while using these is not advised.
3999 # Some architectures may not support comparing CPU models. s390x supports
4000 # comparing CPU models.
4002 # Returns: a CpuModelBaselineInfo. Returns an error if comparing CPU models is
4003 # not supported, if a model cannot be used, if a model contains
4004 # an unknown cpu definition name, unknown properties or properties
4009 { 'command': 'query-cpu-model-comparison',
4010 'data': { 'modela': 'CpuModelInfo', 'modelb': 'CpuModelInfo' },
4011 'returns': 'CpuModelCompareInfo' }
4014 # @CpuModelBaselineInfo:
4016 # The result of a CPU model baseline.
4018 # @model: the baselined CpuModelInfo.
4022 { 'struct': 'CpuModelBaselineInfo',
4023 'data': { 'model': 'CpuModelInfo' } }
4026 # @query-cpu-model-baseline:
4028 # Baseline two CPU models, creating a compatible third model. The created
4029 # model will always be a static, migration-safe CPU model (see "static"
4030 # CPU model expansion for details).
4032 # This interface can be used by tooling to create a compatible CPU model out
4033 # two CPU models. The created CPU model will be identical to or a subset of
4034 # both CPU models when comparing them. Therefore, the created CPU model is
4035 # guaranteed to run where the given CPU models run.
4037 # The result returned by this command may be affected by:
4039 # * QEMU version: CPU models may look different depending on the QEMU version.
4040 # (Except for CPU models reported as "static" in query-cpu-definitions.)
4041 # * machine-type: CPU model may look different depending on the machine-type.
4042 # (Except for CPU models reported as "static" in query-cpu-definitions.)
4043 # * machine options (including accelerator): in some architectures, CPU models
4044 # may look different depending on machine and accelerator options. (Except for
4045 # CPU models reported as "static" in query-cpu-definitions.)
4046 # * "-cpu" arguments and global properties: arguments to the -cpu option and
4047 # global properties may affect expansion of CPU models. Using
4048 # query-cpu-model-expansion while using these is not advised.
4050 # Some architectures may not support baselining CPU models. s390x supports
4051 # baselining CPU models.
4053 # Returns: a CpuModelBaselineInfo. Returns an error if baselining CPU models is
4054 # not supported, if a model cannot be used, if a model contains
4055 # an unknown cpu definition name, unknown properties or properties
4060 { 'command': 'query-cpu-model-baseline',
4061 'data': { 'modela': 'CpuModelInfo',
4062 'modelb': 'CpuModelInfo' },
4063 'returns': 'CpuModelBaselineInfo' }
4068 # Information about a file descriptor that was added to an fd set.
4070 # @fdset-id: The ID of the fd set that @fd was added to.
4072 # @fd: The file descriptor that was received via SCM rights and
4073 # added to the fd set.
4077 { 'struct': 'AddfdInfo', 'data': {'fdset-id': 'int', 'fd': 'int'} }
4082 # Add a file descriptor, that was passed via SCM rights, to an fd set.
4084 # @fdset-id: #optional The ID of the fd set to add the file descriptor to.
4086 # @opaque: #optional A free-form string that can be used to describe the fd.
4088 # Returns: @AddfdInfo on success
4089 # If file descriptor was not received, FdNotSupplied
4090 # If @fdset-id is a negative value, InvalidParameterValue
4092 # Notes: The list of fd sets is shared by all monitor connections.
4094 # If @fdset-id is not specified, a new fd set will be created.
4098 { 'command': 'add-fd', 'data': {'*fdset-id': 'int', '*opaque': 'str'},
4099 'returns': 'AddfdInfo' }
4104 # Remove a file descriptor from an fd set.
4106 # @fdset-id: The ID of the fd set that the file descriptor belongs to.
4108 # @fd: #optional The file descriptor that is to be removed.
4110 # Returns: Nothing on success
4111 # If @fdset-id or @fd is not found, FdNotFound
4115 # Notes: The list of fd sets is shared by all monitor connections.
4117 # If @fd is not specified, all file descriptors in @fdset-id
4120 { 'command': 'remove-fd', 'data': {'fdset-id': 'int', '*fd': 'int'} }
4125 # Information about a file descriptor that belongs to an fd set.
4127 # @fd: The file descriptor value.
4129 # @opaque: #optional A free-form string that can be used to describe the fd.
4133 { 'struct': 'FdsetFdInfo',
4134 'data': {'fd': 'int', '*opaque': 'str'} }
4139 # Information about an fd set.
4141 # @fdset-id: The ID of the fd set.
4143 # @fds: A list of file descriptors that belong to this fd set.
4147 { 'struct': 'FdsetInfo',
4148 'data': {'fdset-id': 'int', 'fds': ['FdsetFdInfo']} }
4153 # Return information describing all fd sets.
4155 # Returns: A list of @FdsetInfo
4159 # Note: The list of fd sets is shared by all monitor connections.
4162 { 'command': 'query-fdsets', 'returns': ['FdsetInfo'] }
4167 # Information describing the QEMU target.
4169 # @arch: the target architecture (eg "x86_64", "i386", etc)
4173 { 'struct': 'TargetInfo',
4174 'data': { 'arch': 'str' } }
4179 # Return information about the target for this QEMU
4181 # Returns: TargetInfo
4185 { 'command': 'query-target', 'returns': 'TargetInfo' }
4190 # An enumeration of key name.
4192 # This is used by the @send-key command.
4194 # @unmapped: since 2.0
4197 # @kp_comma: since 2.4
4198 # @kp_equals: since 2.6
4200 # @hiragana: since 2.9
4201 # @henkan: since 2.9
4207 { 'enum': 'QKeyCode',
4208 'data': [ 'unmapped',
4209 'shift', 'shift_r', 'alt', 'alt_r', 'altgr', 'altgr_r', 'ctrl',
4210 'ctrl_r', 'menu', 'esc', '1', '2', '3', '4', '5', '6', '7', '8',
4211 '9', '0', 'minus', 'equal', 'backspace', 'tab', 'q', 'w', 'e',
4212 'r', 't', 'y', 'u', 'i', 'o', 'p', 'bracket_left', 'bracket_right',
4213 'ret', 'a', 's', 'd', 'f', 'g', 'h', 'j', 'k', 'l', 'semicolon',
4214 'apostrophe', 'grave_accent', 'backslash', 'z', 'x', 'c', 'v', 'b',
4215 'n', 'm', 'comma', 'dot', 'slash', 'asterisk', 'spc', 'caps_lock',
4216 'f1', 'f2', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9', 'f10',
4217 'num_lock', 'scroll_lock', 'kp_divide', 'kp_multiply',
4218 'kp_subtract', 'kp_add', 'kp_enter', 'kp_decimal', 'sysrq', 'kp_0',
4219 'kp_1', 'kp_2', 'kp_3', 'kp_4', 'kp_5', 'kp_6', 'kp_7', 'kp_8',
4220 'kp_9', 'less', 'f11', 'f12', 'print', 'home', 'pgup', 'pgdn', 'end',
4221 'left', 'up', 'down', 'right', 'insert', 'delete', 'stop', 'again',
4222 'props', 'undo', 'front', 'copy', 'open', 'paste', 'find', 'cut',
4223 'lf', 'help', 'meta_l', 'meta_r', 'compose', 'pause',
4224 'ro', 'hiragana', 'henkan', 'yen',
4225 'kp_comma', 'kp_equals', 'power' ] }
4230 # Represents a keyboard key.
4234 { 'union': 'KeyValue',
4237 'qcode': 'QKeyCode' } }
4242 # Send keys to guest.
4244 # @keys: An array of @KeyValue elements. All @KeyValues in this array are
4245 # simultaneously sent to the guest. A @KeyValue.number value is sent
4246 # directly to the guest, while @KeyValue.qcode must be a valid
4249 # @hold-time: #optional time to delay key up events, milliseconds. Defaults
4252 # Returns: Nothing on success
4253 # If key is unknown or redundant, InvalidParameter
4258 { 'command': 'send-key',
4259 'data': { 'keys': ['KeyValue'], '*hold-time': 'int' } }
4264 # Write a PPM of the VGA screen to a file.
4266 # @filename: the path of a new PPM file to store the image
4268 # Returns: Nothing on success
4272 { 'command': 'screendump', 'data': {'filename': 'str'} }
4278 # Configuration shared across all chardev backends
4280 # @logfile: #optional The name of a logfile to save output
4281 # @logappend: #optional true to append instead of truncate
4282 # (default to false to truncate)
4286 { 'struct': 'ChardevCommon', 'data': { '*logfile': 'str',
4287 '*logappend': 'bool' } }
4292 # Configuration info for file chardevs.
4294 # @in: #optional The name of the input file
4295 # @out: The name of the output file
4296 # @append: #optional Open the file in append mode (default false to
4297 # truncate) (Since 2.6)
4301 { 'struct': 'ChardevFile', 'data': { '*in' : 'str',
4303 '*append': 'bool' },
4304 'base': 'ChardevCommon' }
4309 # Configuration info for device and pipe chardevs.
4311 # @device: The name of the special file for the device,
4312 # i.e. /dev/ttyS0 on Unix or COM1: on Windows
4316 { 'struct': 'ChardevHostdev', 'data': { 'device' : 'str' },
4317 'base': 'ChardevCommon' }
4322 # Configuration info for (stream) socket chardevs.
4324 # @addr: socket address to listen on (server=true)
4325 # or connect to (server=false)
4326 # @tls-creds: #optional the ID of the TLS credentials object (since 2.6)
4327 # @server: #optional create server socket (default: true)
4328 # @wait: #optional wait for incoming connection on server
4329 # sockets (default: false).
4330 # @nodelay: #optional set TCP_NODELAY socket option (default: false)
4331 # @telnet: #optional enable telnet protocol on server
4332 # sockets (default: false)
4333 # @reconnect: #optional For a client socket, if a socket is disconnected,
4334 # then attempt a reconnect after the given number of seconds.
4335 # Setting this to zero disables this function. (default: 0)
4340 { 'struct': 'ChardevSocket', 'data': { 'addr' : 'SocketAddress',
4341 '*tls-creds' : 'str',
4344 '*nodelay' : 'bool',
4346 '*reconnect' : 'int' },
4347 'base': 'ChardevCommon' }
4352 # Configuration info for datagram socket chardevs.
4354 # @remote: remote address
4355 # @local: #optional local address
4359 { 'struct': 'ChardevUdp', 'data': { 'remote' : 'SocketAddress',
4360 '*local' : 'SocketAddress' },
4361 'base': 'ChardevCommon' }
4366 # Configuration info for mux chardevs.
4368 # @chardev: name of the base chardev.
4372 { 'struct': 'ChardevMux', 'data': { 'chardev' : 'str' },
4373 'base': 'ChardevCommon' }
4378 # Configuration info for stdio chardevs.
4380 # @signal: #optional Allow signals (such as SIGINT triggered by ^C)
4381 # be delivered to qemu. Default: true in -nographic mode,
4386 { 'struct': 'ChardevStdio', 'data': { '*signal' : 'bool' },
4387 'base': 'ChardevCommon' }
4391 # @ChardevSpiceChannel:
4393 # Configuration info for spice vm channel chardevs.
4395 # @type: kind of channel (for example vdagent).
4399 { 'struct': 'ChardevSpiceChannel', 'data': { 'type' : 'str' },
4400 'base': 'ChardevCommon' }
4403 # @ChardevSpicePort:
4405 # Configuration info for spice port chardevs.
4407 # @fqdn: name of the channel (see docs/spice-port-fqdn.txt)
4411 { 'struct': 'ChardevSpicePort', 'data': { 'fqdn' : 'str' },
4412 'base': 'ChardevCommon' }
4417 # Configuration info for virtual console chardevs.
4419 # @width: console width, in pixels
4420 # @height: console height, in pixels
4421 # @cols: console width, in chars
4422 # @rows: console height, in chars
4426 { 'struct': 'ChardevVC', 'data': { '*width' : 'int',
4430 'base': 'ChardevCommon' }
4435 # Configuration info for ring buffer chardevs.
4437 # @size: #optional ring buffer size, must be power of two, default is 65536
4441 { 'struct': 'ChardevRingbuf', 'data': { '*size' : 'int' },
4442 'base': 'ChardevCommon' }
4447 # Configuration info for the new chardev backend.
4449 # Since: 1.4 (testdev since 2.2)
4451 { 'union': 'ChardevBackend', 'data': { 'file' : 'ChardevFile',
4452 'serial' : 'ChardevHostdev',
4453 'parallel': 'ChardevHostdev',
4454 'pipe' : 'ChardevHostdev',
4455 'socket' : 'ChardevSocket',
4456 'udp' : 'ChardevUdp',
4457 'pty' : 'ChardevCommon',
4458 'null' : 'ChardevCommon',
4459 'mux' : 'ChardevMux',
4460 'msmouse': 'ChardevCommon',
4461 'braille': 'ChardevCommon',
4462 'testdev': 'ChardevCommon',
4463 'stdio' : 'ChardevStdio',
4464 'console': 'ChardevCommon',
4465 'spicevmc' : 'ChardevSpiceChannel',
4466 'spiceport' : 'ChardevSpicePort',
4468 'ringbuf': 'ChardevRingbuf',
4469 # next one is just for compatibility
4470 'memory' : 'ChardevRingbuf' } }
4475 # Return info about the chardev backend just created.
4477 # @pty: #optional name of the slave pseudoterminal device, present if
4478 # and only if a chardev of type 'pty' was created
4482 { 'struct' : 'ChardevReturn', 'data': { '*pty' : 'str' } }
4487 # Add a character device backend
4489 # @id: the chardev's ID, must be unique
4490 # @backend: backend type and parameters
4492 # Returns: ChardevReturn.
4496 { 'command': 'chardev-add', 'data': {'id' : 'str',
4497 'backend' : 'ChardevBackend' },
4498 'returns': 'ChardevReturn' }
4503 # Remove a character device backend
4505 # @id: the chardev's ID, must exist and not be in use
4507 # Returns: Nothing on success
4511 { 'command': 'chardev-remove', 'data': {'id': 'str'} }
4516 # An enumeration of TPM models
4518 # @tpm-tis: TPM TIS model
4522 { 'enum': 'TpmModel', 'data': [ 'tpm-tis' ] }
4525 # @query-tpm-models:
4527 # Return a list of supported TPM models
4529 # Returns: a list of TpmModel
4533 { 'command': 'query-tpm-models', 'returns': ['TpmModel'] }
4538 # An enumeration of TPM types
4540 # @passthrough: TPM passthrough type
4544 { 'enum': 'TpmType', 'data': [ 'passthrough' ] }
4549 # Return a list of supported TPM types
4551 # Returns: a list of TpmType
4555 { 'command': 'query-tpm-types', 'returns': ['TpmType'] }
4558 # @TPMPassthroughOptions:
4560 # Information about the TPM passthrough type
4562 # @path: #optional string describing the path used for accessing the TPM device
4564 # @cancel-path: #optional string showing the TPM's sysfs cancel file
4565 # for cancellation of TPM commands while they are executing
4569 { 'struct': 'TPMPassthroughOptions', 'data': { '*path' : 'str',
4570 '*cancel-path' : 'str'} }
4575 # A union referencing different TPM backend types' configuration options
4577 # @type: 'passthrough' The configuration options for the TPM passthrough type
4581 { 'union': 'TpmTypeOptions',
4582 'data': { 'passthrough' : 'TPMPassthroughOptions' } }
4587 # Information about the TPM
4589 # @id: The Id of the TPM
4591 # @model: The TPM frontend model
4593 # @options: The TPM (backend) type configuration options
4597 { 'struct': 'TPMInfo',
4598 'data': {'id': 'str',
4599 'model': 'TpmModel',
4600 'options': 'TpmTypeOptions' } }
4605 # Return information about the TPM device
4607 # Returns: @TPMInfo on success
4611 { 'command': 'query-tpm', 'returns': ['TPMInfo'] }
4614 # @AcpiTableOptions:
4616 # Specify an ACPI table on the command line to load.
4618 # At most one of @file and @data can be specified. The list of files specified
4619 # by any one of them is loaded and concatenated in order. If both are omitted,
4622 # Other fields / optargs can be used to override fields of the generic ACPI
4623 # table header; refer to the ACPI specification 5.0, section 5.2.6 System
4624 # Description Table Header. If a header field is not overridden, then the
4625 # corresponding value from the concatenated blob is used (in case of @file), or
4626 # it is filled in with a hard-coded value (in case of @data).
4628 # String fields are copied into the matching ACPI member from lowest address
4629 # upwards, and silently truncated / NUL-padded to length.
4631 # @sig: #optional table signature / identifier (4 bytes)
4633 # @rev: #optional table revision number (dependent on signature, 1 byte)
4635 # @oem_id: #optional OEM identifier (6 bytes)
4637 # @oem_table_id: #optional OEM table identifier (8 bytes)
4639 # @oem_rev: #optional OEM-supplied revision number (4 bytes)
4641 # @asl_compiler_id: #optional identifier of the utility that created the table
4644 # @asl_compiler_rev: #optional revision number of the utility that created the
4647 # @file: #optional colon (:) separated list of pathnames to load and
4648 # concatenate as table data. The resultant binary blob is expected to
4649 # have an ACPI table header. At least one file is required. This field
4652 # @data: #optional colon (:) separated list of pathnames to load and
4653 # concatenate as table data. The resultant binary blob must not have an
4654 # ACPI table header. At least one file is required. This field excludes
4659 { 'struct': 'AcpiTableOptions',
4664 '*oem_table_id': 'str',
4665 '*oem_rev': 'uint32',
4666 '*asl_compiler_id': 'str',
4667 '*asl_compiler_rev': 'uint32',
4672 # @CommandLineParameterType:
4674 # Possible types for an option parameter.
4676 # @string: accepts a character string
4678 # @boolean: accepts "on" or "off"
4680 # @number: accepts a number
4682 # @size: accepts a number followed by an optional suffix (K)ilo,
4683 # (M)ega, (G)iga, (T)era
4687 { 'enum': 'CommandLineParameterType',
4688 'data': ['string', 'boolean', 'number', 'size'] }
4691 # @CommandLineParameterInfo:
4693 # Details about a single parameter of a command line option.
4695 # @name: parameter name
4697 # @type: parameter @CommandLineParameterType
4699 # @help: #optional human readable text string, not suitable for parsing.
4701 # @default: #optional default value string (since 2.1)
4705 { 'struct': 'CommandLineParameterInfo',
4706 'data': { 'name': 'str',
4707 'type': 'CommandLineParameterType',
4709 '*default': 'str' } }
4712 # @CommandLineOptionInfo:
4714 # Details about a command line option, including its list of parameter details
4716 # @option: option name
4718 # @parameters: an array of @CommandLineParameterInfo
4722 { 'struct': 'CommandLineOptionInfo',
4723 'data': { 'option': 'str', 'parameters': ['CommandLineParameterInfo'] } }
4726 # @query-command-line-options:
4728 # Query command line option schema.
4730 # @option: #optional option name
4732 # Returns: list of @CommandLineOptionInfo for all options (or for the given
4733 # @option). Returns an error if the given @option doesn't exist.
4737 {'command': 'query-command-line-options', 'data': { '*option': 'str' },
4738 'returns': ['CommandLineOptionInfo'] }
4741 # @X86CPURegister32:
4743 # A X86 32-bit register
4747 { 'enum': 'X86CPURegister32',
4748 'data': [ 'EAX', 'EBX', 'ECX', 'EDX', 'ESP', 'EBP', 'ESI', 'EDI' ] }
4751 # @X86CPUFeatureWordInfo:
4753 # Information about a X86 CPU feature word
4755 # @cpuid-input-eax: Input EAX value for CPUID instruction for that feature word
4757 # @cpuid-input-ecx: #optional Input ECX value for CPUID instruction for that
4760 # @cpuid-register: Output register containing the feature bits
4762 # @features: value of output register, containing the feature bits
4766 { 'struct': 'X86CPUFeatureWordInfo',
4767 'data': { 'cpuid-input-eax': 'int',
4768 '*cpuid-input-ecx': 'int',
4769 'cpuid-register': 'X86CPURegister32',
4770 'features': 'int' } }
4773 # @DummyForceArrays:
4775 # Not used by QMP; hack to let us use X86CPUFeatureWordInfoList internally
4779 { 'struct': 'DummyForceArrays',
4780 'data': { 'unused': ['X86CPUFeatureWordInfo'] } }
4786 # Packets receiving state
4788 # @normal: filter assigned packets according to the mac-table
4790 # @none: don't receive any assigned packet
4792 # @all: receive all assigned packets
4796 { 'enum': 'RxState', 'data': [ 'normal', 'none', 'all' ] }
4801 # Rx-filter information for a NIC.
4803 # @name: net client name
4805 # @promiscuous: whether promiscuous mode is enabled
4807 # @multicast: multicast receive state
4809 # @unicast: unicast receive state
4811 # @vlan: vlan receive state (Since 2.0)
4813 # @broadcast-allowed: whether to receive broadcast
4815 # @multicast-overflow: multicast table is overflowed or not
4817 # @unicast-overflow: unicast table is overflowed or not
4819 # @main-mac: the main macaddr string
4821 # @vlan-table: a list of active vlan id
4823 # @unicast-table: a list of unicast macaddr string
4825 # @multicast-table: a list of multicast macaddr string
4829 { 'struct': 'RxFilterInfo',
4832 'promiscuous': 'bool',
4833 'multicast': 'RxState',
4834 'unicast': 'RxState',
4836 'broadcast-allowed': 'bool',
4837 'multicast-overflow': 'bool',
4838 'unicast-overflow': 'bool',
4840 'vlan-table': ['int'],
4841 'unicast-table': ['str'],
4842 'multicast-table': ['str'] }}
4847 # Return rx-filter information for all NICs (or for the given NIC).
4849 # @name: #optional net client name
4851 # Returns: list of @RxFilterInfo for all NICs (or for the given NIC).
4852 # Returns an error if the given @name doesn't exist, or given
4853 # NIC doesn't support rx-filter querying, or given net client
4858 { 'command': 'query-rx-filter', 'data': { '*name': 'str' },
4859 'returns': ['RxFilterInfo'] }
4864 # Button of a pointer input device (mouse, tablet).
4868 { 'enum' : 'InputButton',
4869 'data' : [ 'left', 'middle', 'right', 'wheel-up', 'wheel-down' ] }
4874 # Position axis of a pointer input device (mouse, tablet).
4878 { 'enum' : 'InputAxis',
4879 'data' : [ 'x', 'y' ] }
4884 # Keyboard input event.
4886 # @key: Which key this event is for.
4887 # @down: True for key-down and false for key-up events.
4891 { 'struct' : 'InputKeyEvent',
4892 'data' : { 'key' : 'KeyValue',
4898 # Pointer button input event.
4900 # @button: Which button this event is for.
4901 # @down: True for key-down and false for key-up events.
4905 { 'struct' : 'InputBtnEvent',
4906 'data' : { 'button' : 'InputButton',
4912 # Pointer motion input event.
4914 # @axis: Which axis is referenced by @value.
4915 # @value: Pointer position. For absolute coordinates the
4916 # valid range is 0 -> 0x7ffff
4920 { 'struct' : 'InputMoveEvent',
4921 'data' : { 'axis' : 'InputAxis',
4927 # Input event union.
4929 # @type: the input type, one of:
4930 # - 'key': Input event of Keyboard
4931 # - 'btn': Input event of pointer buttons
4932 # - 'rel': Input event of relative pointer motion
4933 # - 'abs': Input event of absolute pointer motion
4937 { 'union' : 'InputEvent',
4938 'data' : { 'key' : 'InputKeyEvent',
4939 'btn' : 'InputBtnEvent',
4940 'rel' : 'InputMoveEvent',
4941 'abs' : 'InputMoveEvent' } }
4944 # @input-send-event:
4946 # Send input event(s) to guest.
4948 # @device: #optional display device to send event(s) to.
4949 # @head: #optional head to send event(s) to, in case the
4950 # display device supports multiple scanouts.
4951 # @events: List of InputEvent union.
4953 # Returns: Nothing on success.
4955 # The @display and @head parameters can be used to send the input
4956 # event to specific input devices in case (a) multiple input devices
4957 # of the same kind are added to the virtual machine and (b) you have
4958 # configured input routing (see docs/multiseat.txt) for those input
4959 # devices. The parameters work exactly like the device and head
4960 # properties of input devices. If @device is missing, only devices
4961 # that have no input routing config are admissible. If @device is
4962 # specified, both input devices with and without input routing config
4963 # are admissible, but devices with input routing config take
4968 { 'command': 'input-send-event',
4969 'data': { '*device': 'str',
4971 'events' : [ 'InputEvent' ] } }
4976 # A discriminated record of NUMA options. (for OptsVisitor)
4980 { 'union': 'NumaOptions',
4982 'node': 'NumaNodeOptions' }}
4987 # Create a guest NUMA node. (for OptsVisitor)
4989 # @nodeid: #optional NUMA node ID (increase by 1 from 0 if omitted)
4991 # @cpus: #optional VCPUs belonging to this node (assign VCPUS round-robin
4994 # @mem: #optional memory size of this node; mutually exclusive with @memdev.
4995 # Equally divide total memory among nodes if both @mem and @memdev are
4998 # @memdev: #optional memory backend object. If specified for one node,
4999 # it must be specified for all nodes.
5003 { 'struct': 'NumaNodeOptions',
5005 '*nodeid': 'uint16',
5006 '*cpus': ['uint16'],
5013 # Host memory policy types
5015 # @default: restore default policy, remove any nondefault policy
5017 # @preferred: set the preferred host nodes for allocation
5019 # @bind: a strict policy that restricts memory allocation to the
5020 # host nodes specified
5022 # @interleave: memory allocations are interleaved across the set
5023 # of host nodes specified
5027 { 'enum': 'HostMemPolicy',
5028 'data': [ 'default', 'preferred', 'bind', 'interleave' ] }
5033 # Information about memory backend
5035 # @id: #optional backend's ID if backend has 'id' property (since 2.9)
5037 # @size: memory backend size
5039 # @merge: enables or disables memory merge support
5041 # @dump: includes memory backend's memory in a core dump or not
5043 # @prealloc: enables or disables memory preallocation
5045 # @host-nodes: host nodes for its memory policy
5047 # @policy: memory policy of memory backend
5051 { 'struct': 'Memdev',
5058 'host-nodes': ['uint16'],
5059 'policy': 'HostMemPolicy' }}
5064 # Returns information for all memory backends.
5066 # Returns: a list of @Memdev.
5070 { 'command': 'query-memdev', 'returns': ['Memdev'] }
5073 # @PCDIMMDeviceInfo:
5075 # PCDIMMDevice state information
5077 # @id: #optional device's ID
5079 # @addr: physical address, where device is mapped
5081 # @size: size of memory that the device provides
5083 # @slot: slot number at which device is plugged in
5085 # @node: NUMA node number where device is plugged in
5087 # @memdev: memory backend linked with device
5089 # @hotplugged: true if device was hotplugged
5091 # @hotpluggable: true if device if could be added/removed while machine is running
5095 { 'struct': 'PCDIMMDeviceInfo',
5096 'data': { '*id': 'str',
5102 'hotplugged': 'bool',
5103 'hotpluggable': 'bool'
5108 # @MemoryDeviceInfo:
5110 # Union containing information about a memory device
5114 { 'union': 'MemoryDeviceInfo', 'data': {'dimm': 'PCDIMMDeviceInfo'} }
5117 # @query-memory-devices:
5119 # Lists available memory devices and their state
5123 { 'command': 'query-memory-devices', 'returns': ['MemoryDeviceInfo'] }
5128 # @DIMM: memory slot
5129 # @CPU: logical CPU slot (since 2.7)
5131 { 'enum': 'ACPISlotType', 'data': [ 'DIMM', 'CPU' ] }
5136 # OSPM Status Indication for a device
5137 # For description of possible values of @source and @status fields
5138 # see "_OST (OSPM Status Indication)" chapter of ACPI5.0 spec.
5140 # @device: #optional device ID associated with slot
5142 # @slot: slot ID, unique per slot of a given @slot-type
5144 # @slot-type: type of the slot
5146 # @source: an integer containing the source event
5148 # @status: an integer containing the status code
5152 { 'struct': 'ACPIOSTInfo',
5153 'data' : { '*device': 'str',
5155 'slot-type': 'ACPISlotType',
5160 # @query-acpi-ospm-status:
5162 # Lists ACPI OSPM status of ACPI device objects,
5163 # which might be reported via _OST method
5167 { 'command': 'query-acpi-ospm-status', 'returns': ['ACPIOSTInfo'] }
5170 # @WatchdogExpirationAction:
5172 # An enumeration of the actions taken when the watchdog device's timer is
5175 # @reset: system resets
5177 # @shutdown: system shutdown, note that it is similar to @powerdown, which
5178 # tries to set to system status and notify guest
5180 # @poweroff: system poweroff, the emulator program exits
5182 # @pause: system pauses, similar to @stop
5184 # @debug: system enters debug state
5186 # @none: nothing is done
5188 # @inject-nmi: a non-maskable interrupt is injected into the first VCPU (all
5189 # VCPUS on x86) (since 2.4)
5193 { 'enum': 'WatchdogExpirationAction',
5194 'data': [ 'reset', 'shutdown', 'poweroff', 'pause', 'debug', 'none',
5200 # An enumeration of the I/O operation types
5202 # @read: read operation
5204 # @write: write operation
5208 { 'enum': 'IoOperationType',
5209 'data': [ 'read', 'write' ] }
5212 # @GuestPanicAction:
5214 # An enumeration of the actions taken when guest OS panic is detected
5216 # @pause: system pauses
5218 # Since: 2.1 (poweroff since 2.8)
5220 { 'enum': 'GuestPanicAction',
5221 'data': [ 'pause', 'poweroff' ] }
5224 # @rtc-reset-reinjection:
5226 # This command will reset the RTC interrupt reinjection backlog.
5227 # Can be used if another mechanism to synchronize guest time
5228 # is in effect, for example QEMU guest agent's guest-set-time
5233 { 'command': 'rtc-reset-reinjection' }
5235 # Rocker ethernet network switch
5236 { 'include': 'qapi/rocker.json' }
5241 # Mode of the replay subsystem.
5243 # @none: normal execution mode. Replay or record are not enabled.
5245 # @record: record mode. All non-deterministic data is written into the
5248 # @play: replay mode. Non-deterministic data required for system execution
5249 # is read from the log.
5253 { 'enum': 'ReplayMode',
5254 'data': [ 'none', 'record', 'play' ] }
5257 # @xen-load-devices-state:
5259 # Load the state of all devices from file. The RAM and the block devices
5260 # of the VM are not loaded by this command.
5262 # @filename: the file to load the state of the devices from as binary
5263 # data. See xen-save-devices-state.txt for a description of the binary
5268 { 'command': 'xen-load-devices-state', 'data': {'filename': 'str'} }
5273 # The struct describes capability for a specific GIC (Generic
5274 # Interrupt Controller) version. These bits are not only decided by
5275 # QEMU/KVM software version, but also decided by the hardware that
5276 # the program is running upon.
5278 # @version: version of GIC to be described. Currently, only 2 and 3
5281 # @emulated: whether current QEMU/hardware supports emulated GIC
5282 # device in user space.
5284 # @kernel: whether current QEMU/hardware supports hardware
5285 # accelerated GIC device in kernel.
5289 { 'struct': 'GICCapability',
5290 'data': { 'version': 'int',
5292 'kernel': 'bool' } }
5295 # @query-gic-capabilities:
5297 # This command is ARM-only. It will return a list of GICCapability
5298 # objects that describe its capability bits.
5300 # Returns: a list of GICCapability objects.
5304 { 'command': 'query-gic-capabilities', 'returns': ['GICCapability'] }
5307 # @CpuInstanceProperties:
5309 # List of properties to be used for hotplugging a CPU instance,
5310 # it should be passed by management with device_add command when
5311 # a CPU is being hotplugged.
5313 # @node-id: #optional NUMA node ID the CPU belongs to
5314 # @socket-id: #optional socket number within node/board the CPU belongs to
5315 # @core-id: #optional core number within socket the CPU belongs to
5316 # @thread-id: #optional thread number within core the CPU belongs to
5318 # Note: currently there are 4 properties that could be present
5319 # but management should be prepared to pass through other
5320 # properties with device_add command to allow for future
5321 # interface extension. This also requires the filed names to be kept in
5322 # sync with the properties passed to -device/device_add.
5326 { 'struct': 'CpuInstanceProperties',
5327 'data': { '*node-id': 'int',
5328 '*socket-id': 'int',
5337 # @type: CPU object type for usage with device_add command
5338 # @props: list of properties to be used for hotplugging CPU
5339 # @vcpus-count: number of logical VCPU threads @HotpluggableCPU provides
5340 # @qom-path: #optional link to existing CPU object if CPU is present or
5341 # omitted if CPU is not present.
5345 { 'struct': 'HotpluggableCPU',
5346 'data': { 'type': 'str',
5347 'vcpus-count': 'int',
5348 'props': 'CpuInstanceProperties',
5354 # @query-hotpluggable-cpus:
5356 # Returns: a list of HotpluggableCPU objects.
5360 { 'command': 'query-hotpluggable-cpus', 'returns': ['HotpluggableCPU'] }