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
2209 # -> { "execute": "cpu-add", "arguments": { "id": 2 } }
2210 # <- { "return": {} }
2213 { 'command': 'cpu-add', 'data': {'id': 'int'} }
2218 # Save a portion of guest memory to a file.
2220 # @val: the virtual address of the guest to start from
2222 # @size: the size of memory region to save
2224 # @filename: the file to save the memory to as binary data
2226 # @cpu-index: #optional the index of the virtual CPU to use for translating the
2227 # virtual address (defaults to CPU 0)
2229 # Returns: Nothing on success
2233 # Notes: Errors were not reliably returned until 1.1
2237 # -> { "execute": "memsave",
2238 # "arguments": { "val": 10,
2240 # "filename": "/tmp/virtual-mem-dump" } }
2241 # <- { "return": {} }
2244 { 'command': 'memsave',
2245 'data': {'val': 'int', 'size': 'int', 'filename': 'str', '*cpu-index': 'int'} }
2250 # Save a portion of guest physical memory to a file.
2252 # @val: the physical address of the guest to start from
2254 # @size: the size of memory region to save
2256 # @filename: the file to save the memory to as binary data
2258 # Returns: Nothing on success
2262 # Notes: Errors were not reliably returned until 1.1
2266 # -> { "execute": "pmemsave",
2267 # "arguments": { "val": 10,
2269 # "filename": "/tmp/physical-mem-dump" } }
2270 # <- { "return": {} }
2273 { 'command': 'pmemsave',
2274 'data': {'val': 'int', 'size': 'int', 'filename': 'str'} }
2279 # Resume guest VCPU execution.
2283 # Returns: If successful, nothing
2284 # If QEMU was started with an encrypted block device and a key has
2285 # not yet been set, DeviceEncrypted.
2287 # Notes: This command will succeed if the guest is currently running. It
2288 # will also succeed if the guest is in the "inmigrate" state; in
2289 # this case, the effect of the command is to make sure the guest
2290 # starts once migration finishes, removing the effect of the -S
2291 # command line option if it was passed.
2295 # -> { "execute": "cont" }
2296 # <- { "return": {} }
2299 { 'command': 'cont' }
2304 # Wakeup guest from suspend. Does nothing in case the guest isn't suspended.
2312 # -> { "execute": "system_wakeup" }
2313 # <- { "return": {} }
2316 { 'command': 'system_wakeup' }
2321 # Injects a Non-Maskable Interrupt into the default CPU (x86/s390) or all CPUs (ppc64).
2322 # The command fails when the guest doesn't support injecting.
2324 # Returns: If successful, nothing
2328 # Note: prior to 2.1, this command was only supported for x86 and s390 VMs
2332 # -> { "execute": "inject-nmi" }
2333 # <- { "return": {} }
2336 { 'command': 'inject-nmi' }
2341 # Sets the link status of a virtual network adapter.
2343 # @name: the device name of the virtual network adapter
2345 # @up: true to set the link status to be up
2347 # Returns: Nothing on success
2348 # If @name is not a valid network device, DeviceNotFound
2352 # Notes: Not all network adapters support setting link status. This command
2353 # will succeed even if the network adapter does not support link status
2358 # -> { "execute": "set_link",
2359 # "arguments": { "name": "e1000.0", "up": false } }
2360 # <- { "return": {} }
2363 { 'command': 'set_link', 'data': {'name': 'str', 'up': 'bool'} }
2368 # Request the balloon driver to change its balloon size.
2370 # @value: the target size of the balloon in bytes
2372 # Returns: Nothing on success
2373 # If the balloon driver is enabled but not functional because the KVM
2374 # kernel module cannot support it, KvmMissingCap
2375 # If no balloon device is present, DeviceNotActive
2377 # Notes: This command just issues a request to the guest. When it returns,
2378 # the balloon size may not have changed. A guest can change the balloon
2379 # size independent of this command.
2385 # -> { "execute": "balloon", "arguments": { "value": 536870912 } }
2386 # <- { "return": {} }
2389 { 'command': 'balloon', 'data': {'value': 'int'} }
2394 # This action can be used to test transaction failure.
2398 { 'struct': 'Abort',
2402 # @ActionCompletionMode:
2404 # An enumeration of Transactional completion modes.
2406 # @individual: Do not attempt to cancel any other Actions if any Actions fail
2407 # after the Transaction request succeeds. All Actions that
2408 # can complete successfully will do so without waiting on others.
2409 # This is the default.
2411 # @grouped: If any Action fails after the Transaction succeeds, cancel all
2412 # Actions. Actions do not complete until all Actions are ready to
2413 # complete. May be rejected by Actions that do not support this
2418 { 'enum': 'ActionCompletionMode',
2419 'data': [ 'individual', 'grouped' ] }
2422 # @TransactionAction:
2424 # A discriminated record of operations that can be performed with
2425 # @transaction. Action @type can be:
2427 # - @abort: since 1.6
2428 # - @block-dirty-bitmap-add: since 2.5
2429 # - @block-dirty-bitmap-clear: since 2.5
2430 # - @blockdev-backup: since 2.3
2431 # - @blockdev-snapshot: since 2.5
2432 # - @blockdev-snapshot-internal-sync: since 1.7
2433 # - @blockdev-snapshot-sync: since 1.1
2434 # - @drive-backup: since 1.6
2438 { 'union': 'TransactionAction',
2441 'block-dirty-bitmap-add': 'BlockDirtyBitmapAdd',
2442 'block-dirty-bitmap-clear': 'BlockDirtyBitmap',
2443 'blockdev-backup': 'BlockdevBackup',
2444 'blockdev-snapshot': 'BlockdevSnapshot',
2445 'blockdev-snapshot-internal-sync': 'BlockdevSnapshotInternal',
2446 'blockdev-snapshot-sync': 'BlockdevSnapshotSync',
2447 'drive-backup': 'DriveBackup'
2451 # @TransactionProperties:
2453 # Optional arguments to modify the behavior of a Transaction.
2455 # @completion-mode: #optional Controls how jobs launched asynchronously by
2456 # Actions will complete or fail as a group.
2457 # See @ActionCompletionMode for details.
2461 { 'struct': 'TransactionProperties',
2463 '*completion-mode': 'ActionCompletionMode'
2470 # Executes a number of transactionable QMP commands atomically. If any
2471 # operation fails, then the entire set of actions will be abandoned and the
2472 # appropriate error returned.
2474 # For external snapshots, the dictionary contains the device, the file to use for
2475 # the new snapshot, and the format. The default format, if not specified, is
2478 # Each new snapshot defaults to being created by QEMU (wiping any
2479 # contents if the file already exists), but it is also possible to reuse
2480 # an externally-created file. In the latter case, you should ensure that
2481 # the new image file has the same contents as the current one; QEMU cannot
2482 # perform any meaningful check. Typically this is achieved by using the
2483 # current image file as the backing file for the new image.
2485 # On failure, the original disks pre-snapshot attempt will be used.
2487 # For internal snapshots, the dictionary contains the device and the snapshot's
2488 # name. If an internal snapshot matching name already exists, the request will
2489 # be rejected. Only some image formats support it, for example, qcow2, rbd,
2492 # On failure, qemu will try delete the newly created internal snapshot in the
2493 # transaction. When an I/O error occurs during deletion, the user needs to fix
2494 # it later with qemu-img or other command.
2496 # @actions: List of @TransactionAction;
2497 # information needed for the respective operations.
2499 # @properties: #optional structure of additional options to control the
2500 # execution of the transaction. See @TransactionProperties
2501 # for additional detail.
2503 # Returns: nothing on success
2505 # Errors depend on the operations of the transaction
2507 # Note: The transaction aborts on the first failure. Therefore, there will be
2508 # information on only one failed operation returned in an error condition, and
2509 # subsequent actions will not have been attempted.
2515 # -> { "execute": "transaction",
2516 # "arguments": { "actions": [
2517 # { "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd0",
2518 # "snapshot-file": "/some/place/my-image",
2519 # "format": "qcow2" } },
2520 # { "type": "blockdev-snapshot-sync", "data" : { "node-name": "myfile",
2521 # "snapshot-file": "/some/place/my-image2",
2522 # "snapshot-node-name": "node3432",
2523 # "mode": "existing",
2524 # "format": "qcow2" } },
2525 # { "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd1",
2526 # "snapshot-file": "/some/place/my-image2",
2527 # "mode": "existing",
2528 # "format": "qcow2" } },
2529 # { "type": "blockdev-snapshot-internal-sync", "data" : {
2530 # "device": "ide-hd2",
2531 # "name": "snapshot0" } } ] } }
2532 # <- { "return": {} }
2535 { 'command': 'transaction',
2536 'data': { 'actions': [ 'TransactionAction' ],
2537 '*properties': 'TransactionProperties'
2542 # @human-monitor-command:
2544 # Execute a command on the human monitor and return the output.
2546 # @command-line: the command to execute in the human monitor
2548 # @cpu-index: #optional The CPU to use for commands that require an implicit CPU
2550 # Returns: the output of the command as a string
2554 # Notes: This command only exists as a stop-gap. Its use is highly
2555 # discouraged. The semantics of this command are not
2556 # guaranteed: this means that command names, arguments and
2557 # responses can change or be removed at ANY time. Applications
2558 # that rely on long term stability guarantees should NOT
2561 # Known limitations:
2563 # * This command is stateless, this means that commands that depend
2564 # on state information (such as getfd) might not work
2566 # * Commands that prompt the user for data (eg. 'cont' when the block
2567 # device is encrypted) don't currently work
2571 # -> { "execute": "human-monitor-command",
2572 # "arguments": { "command-line": "info kvm" } }
2573 # <- { "return": "kvm support: enabled\r\n" }
2576 { 'command': 'human-monitor-command',
2577 'data': {'command-line': 'str', '*cpu-index': 'int'},
2583 # Cancel the current executing migration process.
2585 # Returns: nothing on success
2587 # Notes: This command succeeds even if there is no migration process running.
2593 # -> { "execute": "migrate_cancel" }
2594 # <- { "return": {} }
2597 { 'command': 'migrate_cancel' }
2600 # @migrate_set_downtime:
2602 # Set maximum tolerated downtime for migration.
2604 # @value: maximum downtime in seconds
2606 # Returns: nothing on success
2608 # Notes: This command is deprecated in favor of 'migrate-set-parameters'
2614 # -> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } }
2615 # <- { "return": {} }
2618 { 'command': 'migrate_set_downtime', 'data': {'value': 'number'} }
2621 # @migrate_set_speed:
2623 # Set maximum speed for migration.
2625 # @value: maximum speed in bytes per second.
2627 # Returns: nothing on success
2629 # Notes: This command is deprecated in favor of 'migrate-set-parameters'
2635 # -> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } }
2636 # <- { "return": {} }
2639 { 'command': 'migrate_set_speed', 'data': {'value': 'int'} }
2642 # @migrate-set-cache-size:
2644 # Set cache size to be used by XBZRLE migration
2646 # @value: cache size in bytes
2648 # The size will be rounded down to the nearest power of 2.
2649 # The cache size can be modified before and during ongoing migration
2651 # Returns: nothing on success
2657 # -> { "execute": "migrate-set-cache-size",
2658 # "arguments": { "value": 536870912 } }
2659 # <- { "return": {} }
2662 { 'command': 'migrate-set-cache-size', 'data': {'value': 'int'} }
2665 # @query-migrate-cache-size:
2667 # Query migration XBZRLE cache size
2669 # Returns: XBZRLE cache size in bytes
2675 # -> { "execute": "query-migrate-cache-size" }
2676 # <- { "return": 67108864 }
2679 { 'command': 'query-migrate-cache-size', 'returns': 'int' }
2682 # @ObjectPropertyInfo:
2684 # @name: the name of the property
2686 # @type: the type of the property. This will typically come in one of four
2689 # 1) A primitive type such as 'u8', 'u16', 'bool', 'str', or 'double'.
2690 # These types are mapped to the appropriate JSON type.
2692 # 2) A child type in the form 'child<subtype>' where subtype is a qdev
2693 # device type name. Child properties create the composition tree.
2695 # 3) A link type in the form 'link<subtype>' where subtype is a qdev
2696 # device type name. Link properties form the device model graph.
2700 { 'struct': 'ObjectPropertyInfo',
2701 'data': { 'name': 'str', 'type': 'str' } }
2706 # This command will list any properties of a object given a path in the object
2709 # @path: the path within the object model. See @qom-get for a description of
2712 # Returns: a list of @ObjectPropertyInfo that describe the properties of the
2717 { 'command': 'qom-list',
2718 'data': { 'path': 'str' },
2719 'returns': [ 'ObjectPropertyInfo' ] }
2724 # This command will get a property from a object model path and return the
2727 # @path: The path within the object model. There are two forms of supported
2728 # paths--absolute and partial paths.
2730 # Absolute paths are derived from the root object and can follow child<>
2731 # or link<> properties. Since they can follow link<> properties, they
2732 # can be arbitrarily long. Absolute paths look like absolute filenames
2733 # and are prefixed with a leading slash.
2735 # Partial paths look like relative filenames. They do not begin
2736 # with a prefix. The matching rules for partial paths are subtle but
2737 # designed to make specifying objects easy. At each level of the
2738 # composition tree, the partial path is matched as an absolute path.
2739 # The first match is not returned. At least two matches are searched
2740 # for. A successful result is only returned if only one match is
2741 # found. If more than one match is found, a flag is return to
2742 # indicate that the match was ambiguous.
2744 # @property: The property name to read
2746 # Returns: The property value. The type depends on the property
2747 # type. child<> and link<> properties are returned as #str
2748 # pathnames. All integer property types (u8, u16, etc) are
2753 { 'command': 'qom-get',
2754 'data': { 'path': 'str', 'property': 'str' },
2760 # This command will set a property from a object model path.
2762 # @path: see @qom-get for a description of this parameter
2764 # @property: the property name to set
2766 # @value: a value who's type is appropriate for the property type. See @qom-get
2767 # for a description of type mapping.
2771 { 'command': 'qom-set',
2772 'data': { 'path': 'str', 'property': 'str', 'value': 'any' } }
2777 # Sets the password of a remote display session.
2779 # @protocol: `vnc' to modify the VNC server password
2780 # `spice' to modify the Spice server password
2782 # @password: the new password
2784 # @connected: #optional how to handle existing clients when changing the
2785 # password. If nothing is specified, defaults to `keep'
2786 # `fail' to fail the command if clients are connected
2787 # `disconnect' to disconnect existing clients
2788 # `keep' to maintain existing clients
2790 # Returns: Nothing on success
2791 # If Spice is not enabled, DeviceNotFound
2797 # -> { "execute": "set_password", "arguments": { "protocol": "vnc",
2798 # "password": "secret" } }
2799 # <- { "return": {} }
2802 { 'command': 'set_password',
2803 'data': {'protocol': 'str', 'password': 'str', '*connected': 'str'} }
2808 # Expire the password of a remote display server.
2810 # @protocol: the name of the remote display protocol `vnc' or `spice'
2812 # @time: when to expire the password.
2813 # `now' to expire the password immediately
2814 # `never' to cancel password expiration
2815 # `+INT' where INT is the number of seconds from now (integer)
2816 # `INT' where INT is the absolute time in seconds
2818 # Returns: Nothing on success
2819 # If @protocol is `spice' and Spice is not active, DeviceNotFound
2823 # Notes: Time is relative to the server and currently there is no way to
2824 # coordinate server time with client time. It is not recommended to
2825 # use the absolute time version of the @time parameter unless you're
2826 # sure you are on the same machine as the QEMU instance.
2830 # -> { "execute": "expire_password", "arguments": { "protocol": "vnc",
2832 # <- { "return": {} }
2835 { 'command': 'expire_password', 'data': {'protocol': 'str', 'time': 'str'} }
2838 # @change-vnc-password:
2840 # Change the VNC server password.
2842 # @password: the new password to use with VNC authentication
2846 # Notes: An empty password in this command will set the password to the empty
2847 # string. Existing clients are unaffected by executing this command.
2849 { 'command': 'change-vnc-password', 'data': {'password': 'str'} }
2854 # This command is multiple commands multiplexed together.
2856 # @device: This is normally the name of a block device but it may also be 'vnc'.
2857 # when it's 'vnc', then sub command depends on @target
2859 # @target: If @device is a block device, then this is the new filename.
2860 # If @device is 'vnc', then if the value 'password' selects the vnc
2861 # change password command. Otherwise, this specifies a new server URI
2862 # address to listen to for VNC connections.
2864 # @arg: If @device is a block device, then this is an optional format to open
2866 # If @device is 'vnc' and @target is 'password', this is the new VNC
2867 # password to set. If this argument is an empty string, then no future
2868 # logins will be allowed.
2870 # Returns: Nothing on success.
2871 # If @device is not a valid block device, DeviceNotFound
2872 # If the new block device is encrypted, DeviceEncrypted. Note that
2873 # if this error is returned, the device has been opened successfully
2874 # and an additional call to @block_passwd is required to set the
2875 # device's password. The behavior of reads and writes to the block
2876 # device between when these calls are executed is undefined.
2878 # Notes: This interface is deprecated, and it is strongly recommended that you
2879 # avoid using it. For changing block devices, use
2880 # blockdev-change-medium; for changing VNC parameters, use
2881 # change-vnc-password.
2887 # 1. Change a removable medium
2889 # -> { "execute": "change",
2890 # "arguments": { "device": "ide1-cd0",
2891 # "target": "/srv/images/Fedora-12-x86_64-DVD.iso" } }
2892 # <- { "return": {} }
2894 # 2. Change VNC password
2896 # -> { "execute": "change",
2897 # "arguments": { "device": "vnc", "target": "password",
2898 # "arg": "foobar1" } }
2899 # <- { "return": {} }
2902 { 'command': 'change',
2903 'data': {'device': 'str', 'target': 'str', '*arg': 'str'} }
2908 # This structure describes a search result from @qom-list-types
2910 # @name: the type name found in the search
2914 # Notes: This command is experimental and may change syntax in future releases.
2916 { 'struct': 'ObjectTypeInfo',
2917 'data': { 'name': 'str' } }
2922 # This command will return a list of types given search parameters
2924 # @implements: if specified, only return types that implement this type name
2926 # @abstract: if true, include abstract types in the results
2928 # Returns: a list of @ObjectTypeInfo or an empty list if no results are found
2932 { 'command': 'qom-list-types',
2933 'data': { '*implements': 'str', '*abstract': 'bool' },
2934 'returns': [ 'ObjectTypeInfo' ] }
2937 # @DevicePropertyInfo:
2939 # Information about device properties.
2941 # @name: the name of the property
2942 # @type: the typename of the property
2943 # @description: #optional if specified, the description of the property.
2948 { 'struct': 'DevicePropertyInfo',
2949 'data': { 'name': 'str', 'type': 'str', '*description': 'str' } }
2952 # @device-list-properties:
2954 # List properties associated with a device.
2956 # @typename: the type name of a device
2958 # Returns: a list of DevicePropertyInfo describing a devices properties
2962 { 'command': 'device-list-properties',
2963 'data': { 'typename': 'str'},
2964 'returns': [ 'DevicePropertyInfo' ] }
2969 # Migrates the current running guest to another Virtual Machine.
2971 # @uri: the Uniform Resource Identifier of the destination VM
2973 # @blk: #optional do block migration (full disk copy)
2975 # @inc: #optional incremental disk copy migration
2977 # @detach: this argument exists only for compatibility reasons and
2978 # is ignored by QEMU
2980 # Returns: nothing on success
2986 # 1. The 'query-migrate' command should be used to check migration's progress
2987 # and final result (this information is provided by the 'status' member)
2989 # 2. All boolean arguments default to false
2991 # 3. The user Monitor's "detach" argument is invalid in QMP and should not
2996 # -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
2997 # <- { "return": {} }
3000 { 'command': 'migrate',
3001 'data': {'uri': 'str', '*blk': 'bool', '*inc': 'bool', '*detach': 'bool' } }
3004 # @migrate-incoming:
3006 # Start an incoming migration, the qemu must have been started
3007 # with -incoming defer
3009 # @uri: The Uniform Resource Identifier identifying the source or
3010 # address to listen on
3012 # Returns: nothing on success
3018 # 1. It's a bad idea to use a string for the uri, but it needs to stay
3019 # compatible with -incoming and the format of the uri is already exposed
3022 # 2. QEMU must be started with -incoming defer to allow migrate-incoming to
3025 # 3. The uri format is the same as for -incoming
3029 # -> { "execute": "migrate-incoming",
3030 # "arguments": { "uri": "tcp::4446" } }
3031 # <- { "return": {} }
3034 { 'command': 'migrate-incoming', 'data': {'uri': 'str' } }
3037 # @xen-save-devices-state:
3039 # Save the state of all devices to file. The RAM and the block devices
3040 # of the VM are not saved by this command.
3042 # @filename: the file to save the state of the devices to as binary
3043 # data. See xen-save-devices-state.txt for a description of the binary
3046 # Returns: Nothing on success
3052 # -> { "execute": "xen-save-devices-state",
3053 # "arguments": { "filename": "/tmp/save" } }
3054 # <- { "return": {} }
3057 { 'command': 'xen-save-devices-state', 'data': {'filename': 'str'} }
3060 # @xen-set-global-dirty-log:
3062 # Enable or disable the global dirty log mode.
3064 # @enable: true to enable, false to disable.
3072 # -> { "execute": "xen-set-global-dirty-log",
3073 # "arguments": { "enable": true } }
3074 # <- { "return": {} }
3077 { 'command': 'xen-set-global-dirty-log', 'data': { 'enable': 'bool' } }
3082 # @driver: the name of the new device's driver
3084 # @bus: #optional the device's parent bus (device tree path)
3086 # @id: #optional the device's ID, must be unique
3088 # Additional arguments depend on the type.
3093 # 1. For detailed information about this command, please refer to the
3094 # 'docs/qdev-device-use.txt' file.
3096 # 2. It's possible to list device properties by running QEMU with the
3097 # "-device DEVICE,help" command-line argument, where DEVICE is the
3102 # -> { "execute": "device_add",
3103 # "arguments": { "driver": "e1000", "id": "net1",
3105 # "mac": "52:54:00:12:34:56" } }
3106 # <- { "return": {} }
3108 # TODO: This command effectively bypasses QAPI completely due to its
3109 # "additional arguments" business. It shouldn't have been added to
3110 # the schema in this form. It should be qapified properly, or
3111 # replaced by a properly qapified command.
3115 { 'command': 'device_add',
3116 'data': {'driver': 'str', '*bus': 'str', '*id': 'str'},
3117 'gen': false } # so we can get the additional arguments
3122 # Remove a device from a guest
3124 # @id: the device's ID or QOM path
3126 # Returns: Nothing on success
3127 # If @id is not a valid device, DeviceNotFound
3129 # Notes: When this command completes, the device may not be removed from the
3130 # guest. Hot removal is an operation that requires guest cooperation.
3131 # This command merely requests that the guest begin the hot removal
3132 # process. Completion of the device removal process is signaled with a
3133 # DEVICE_DELETED event. Guest reset will automatically complete removal
3140 # -> { "execute": "device_del",
3141 # "arguments": { "id": "net1" } }
3142 # <- { "return": {} }
3144 # -> { "execute": "device_del",
3145 # "arguments": { "id": "/machine/peripheral-anon/device[0]" } }
3146 # <- { "return": {} }
3149 { 'command': 'device_del', 'data': {'id': 'str'} }
3152 # @DumpGuestMemoryFormat:
3154 # An enumeration of guest-memory-dump's format.
3158 # @kdump-zlib: kdump-compressed format with zlib-compressed
3160 # @kdump-lzo: kdump-compressed format with lzo-compressed
3162 # @kdump-snappy: kdump-compressed format with snappy-compressed
3166 { 'enum': 'DumpGuestMemoryFormat',
3167 'data': [ 'elf', 'kdump-zlib', 'kdump-lzo', 'kdump-snappy' ] }
3170 # @dump-guest-memory:
3172 # Dump guest's memory to vmcore. It is a synchronous operation that can take
3173 # very long depending on the amount of guest memory.
3175 # @paging: if true, do paging to get guest's memory mapping. This allows
3176 # using gdb to process the core file.
3178 # IMPORTANT: this option can make QEMU allocate several gigabytes
3179 # of RAM. This can happen for a large guest, or a
3180 # malicious guest pretending to be large.
3182 # Also, paging=true has the following limitations:
3184 # 1. The guest may be in a catastrophic state or can have corrupted
3185 # memory, which cannot be trusted
3186 # 2. The guest can be in real-mode even if paging is enabled. For
3187 # example, the guest uses ACPI to sleep, and ACPI sleep state
3189 # 3. Currently only supported on i386 and x86_64.
3191 # @protocol: the filename or file descriptor of the vmcore. The supported
3194 # 1. file: the protocol starts with "file:", and the following
3195 # string is the file's path.
3196 # 2. fd: the protocol starts with "fd:", and the following string
3199 # @detach: #optional if true, QMP will return immediately rather than
3200 # waiting for the dump to finish. The user can track progress
3201 # using "query-dump". (since 2.6).
3203 # @begin: #optional if specified, the starting physical address.
3205 # @length: #optional if specified, the memory size, in bytes. If you don't
3206 # want to dump all guest's memory, please specify the start @begin
3209 # @format: #optional if specified, the format of guest memory dump. But non-elf
3210 # format is conflict with paging and filter, ie. @paging, @begin and
3211 # @length is not allowed to be specified with non-elf @format at the
3212 # same time (since 2.0)
3214 # Note: All boolean arguments default to false
3216 # Returns: nothing on success
3222 # -> { "execute": "dump-guest-memory",
3223 # "arguments": { "protocol": "fd:dump" } }
3224 # <- { "return": {} }
3227 { 'command': 'dump-guest-memory',
3228 'data': { 'paging': 'bool', 'protocol': 'str', '*detach': 'bool',
3229 '*begin': 'int', '*length': 'int',
3230 '*format': 'DumpGuestMemoryFormat'} }
3235 # Describe the status of a long-running background guest memory dump.
3237 # @none: no dump-guest-memory has started yet.
3239 # @active: there is one dump running in background.
3241 # @completed: the last dump has finished successfully.
3243 # @failed: the last dump has failed.
3247 { 'enum': 'DumpStatus',
3248 'data': [ 'none', 'active', 'completed', 'failed' ] }
3253 # The result format for 'query-dump'.
3255 # @status: enum of @DumpStatus, which shows current dump status
3257 # @completed: bytes written in latest dump (uncompressed)
3259 # @total: total bytes to be written in latest dump (uncompressed)
3263 { 'struct': 'DumpQueryResult',
3264 'data': { 'status': 'DumpStatus',
3271 # Query latest dump status.
3273 # Returns: A @DumpStatus object showing the dump status.
3279 # -> { "execute": "query-dump" }
3280 # <- { "return": { "status": "active", "completed": 1024000,
3281 # "total": 2048000 } }
3284 { 'command': 'query-dump', 'returns': 'DumpQueryResult' }
3287 # @DumpGuestMemoryCapability:
3289 # A list of the available formats for dump-guest-memory
3293 { 'struct': 'DumpGuestMemoryCapability',
3295 'formats': ['DumpGuestMemoryFormat'] } }
3298 # @query-dump-guest-memory-capability:
3300 # Returns the available formats for dump-guest-memory
3302 # Returns: A @DumpGuestMemoryCapability object listing available formats for
3309 # -> { "execute": "query-dump-guest-memory-capability" }
3310 # <- { "return": { "formats":
3311 # ["elf", "kdump-zlib", "kdump-lzo", "kdump-snappy"] }
3314 { 'command': 'query-dump-guest-memory-capability',
3315 'returns': 'DumpGuestMemoryCapability' }
3320 # Dump guest's storage keys
3322 # @filename: the path to the file to dump to
3324 # This command is only supported on s390 architecture.
3330 # -> { "execute": "dump-skeys",
3331 # "arguments": { "filename": "/tmp/skeys" } }
3332 # <- { "return": {} }
3335 { 'command': 'dump-skeys',
3336 'data': { 'filename': 'str' } }
3341 # Add a network backend.
3343 # @type: the type of network backend. Current valid values are 'user', 'tap',
3344 # 'vde', 'socket', 'dump' and 'bridge'
3346 # @id: the name of the new network backend
3348 # Additional arguments depend on the type.
3350 # TODO: This command effectively bypasses QAPI completely due to its
3351 # "additional arguments" business. It shouldn't have been added to
3352 # the schema in this form. It should be qapified properly, or
3353 # replaced by a properly qapified command.
3357 # Returns: Nothing on success
3358 # If @type is not a valid network backend, DeviceNotFound
3362 # -> { "execute": "netdev_add",
3363 # "arguments": { "type": "user", "id": "netdev1",
3364 # "dnssearch": "example.org" } }
3365 # <- { "return": {} }
3368 { 'command': 'netdev_add',
3369 'data': {'type': 'str', 'id': 'str'},
3370 'gen': false } # so we can get the additional arguments
3375 # Remove a network backend.
3377 # @id: the name of the network backend to remove
3379 # Returns: Nothing on success
3380 # If @id is not a valid network backend, DeviceNotFound
3386 # -> { "execute": "netdev_del", "arguments": { "id": "netdev1" } }
3387 # <- { "return": {} }
3390 { 'command': 'netdev_del', 'data': {'id': 'str'} }
3395 # Create a QOM object.
3397 # @qom-type: the class name for the object to be created
3399 # @id: the name of the new object
3401 # @props: #optional a dictionary of properties to be passed to the backend
3403 # Returns: Nothing on success
3404 # Error if @qom-type is not a valid class name
3410 # -> { "execute": "object-add",
3411 # "arguments": { "qom-type": "rng-random", "id": "rng1",
3412 # "props": { "filename": "/dev/hwrng" } } }
3413 # <- { "return": {} }
3416 { 'command': 'object-add',
3417 'data': {'qom-type': 'str', 'id': 'str', '*props': 'any'} }
3422 # Remove a QOM object.
3424 # @id: the name of the QOM object to remove
3426 # Returns: Nothing on success
3427 # Error if @id is not a valid id for a QOM object
3433 # -> { "execute": "object-del", "arguments": { "id": "rng1" } }
3434 # <- { "return": {} }
3437 { 'command': 'object-del', 'data': {'id': 'str'} }
3440 # @NetdevNoneOptions:
3442 # Use it alone to have zero network devices.
3446 { 'struct': 'NetdevNoneOptions',
3450 # @NetLegacyNicOptions:
3452 # Create a new Network Interface Card.
3454 # @netdev: #optional id of -netdev to connect to
3456 # @macaddr: #optional MAC address
3458 # @model: #optional device model (e1000, rtl8139, virtio etc.)
3460 # @addr: #optional PCI device address
3462 # @vectors: #optional number of MSI-x vectors, 0 to disable MSI-X
3466 { 'struct': 'NetLegacyNicOptions',
3472 '*vectors': 'uint32' } }
3477 # A fat type wrapping 'str', to be embedded in lists.
3481 { 'struct': 'String',
3486 # @NetdevUserOptions:
3488 # Use the user mode network stack which requires no administrator privilege to
3491 # @hostname: #optional client hostname reported by the builtin DHCP server
3493 # @restrict: #optional isolate the guest from the host
3495 # @ipv4: #optional whether to support IPv4, default true for enabled
3498 # @ipv6: #optional whether to support IPv6, default true for enabled
3501 # @ip: #optional legacy parameter, use net= instead
3503 # @net: #optional IP network address that the guest will see, in the
3504 # form addr[/netmask] The netmask is optional, and can be
3505 # either in the form a.b.c.d or as a number of valid top-most
3506 # bits. Default is 10.0.2.0/24.
3508 # @host: #optional guest-visible address of the host
3510 # @tftp: #optional root directory of the built-in TFTP server
3512 # @bootfile: #optional BOOTP filename, for use with tftp=
3514 # @dhcpstart: #optional the first of the 16 IPs the built-in DHCP server can
3517 # @dns: #optional guest-visible address of the virtual nameserver
3519 # @dnssearch: #optional list of DNS suffixes to search, passed as DHCP option
3522 # @ipv6-prefix: #optional IPv6 network prefix (default is fec0::) (since
3523 # 2.6). The network prefix is given in the usual
3524 # hexadecimal IPv6 address notation.
3526 # @ipv6-prefixlen: #optional IPv6 network prefix length (default is 64)
3529 # @ipv6-host: #optional guest-visible IPv6 address of the host (since 2.6)
3531 # @ipv6-dns: #optional guest-visible IPv6 address of the virtual
3532 # nameserver (since 2.6)
3534 # @smb: #optional root directory of the built-in SMB server
3536 # @smbserver: #optional IP address of the built-in SMB server
3538 # @hostfwd: #optional redirect incoming TCP or UDP host connections to guest
3541 # @guestfwd: #optional forward guest TCP connections
3545 { 'struct': 'NetdevUserOptions',
3548 '*restrict': 'bool',
3556 '*dhcpstart': 'str',
3558 '*dnssearch': ['String'],
3559 '*ipv6-prefix': 'str',
3560 '*ipv6-prefixlen': 'int',
3561 '*ipv6-host': 'str',
3564 '*smbserver': 'str',
3565 '*hostfwd': ['String'],
3566 '*guestfwd': ['String'] } }
3569 # @NetdevTapOptions:
3571 # Connect the host TAP network interface name to the VLAN.
3573 # @ifname: #optional interface name
3575 # @fd: #optional file descriptor of an already opened tap
3577 # @fds: #optional multiple file descriptors of already opened multiqueue capable
3580 # @script: #optional script to initialize the interface
3582 # @downscript: #optional script to shut down the interface
3584 # @br: #optional bridge name (since 2.8)
3586 # @helper: #optional command to execute to configure bridge
3588 # @sndbuf: #optional send buffer limit. Understands [TGMKkb] suffixes.
3590 # @vnet_hdr: #optional enable the IFF_VNET_HDR flag on the tap interface
3592 # @vhost: #optional enable vhost-net network accelerator
3594 # @vhostfd: #optional file descriptor of an already opened vhost net device
3596 # @vhostfds: #optional file descriptors of multiple already opened vhost net
3599 # @vhostforce: #optional vhost on for non-MSIX virtio guests
3601 # @queues: #optional number of queues to be created for multiqueue capable tap
3603 # @poll-us: #optional maximum number of microseconds that could
3604 # be spent on busy polling for tap (since 2.7)
3608 { 'struct': 'NetdevTapOptions',
3614 '*downscript': 'str',
3618 '*vnet_hdr': 'bool',
3622 '*vhostforce': 'bool',
3623 '*queues': 'uint32',
3624 '*poll-us': 'uint32'} }
3627 # @NetdevSocketOptions:
3629 # Connect the VLAN to a remote VLAN in another QEMU virtual machine using a TCP
3630 # socket connection.
3632 # @fd: #optional file descriptor of an already opened socket
3634 # @listen: #optional port number, and optional hostname, to listen on
3636 # @connect: #optional port number, and optional hostname, to connect to
3638 # @mcast: #optional UDP multicast address and port number
3640 # @localaddr: #optional source address and port for multicast and udp packets
3642 # @udp: #optional UDP unicast address and port number
3646 { 'struct': 'NetdevSocketOptions',
3652 '*localaddr': 'str',
3656 # @NetdevL2TPv3Options:
3658 # Connect the VLAN to Ethernet over L2TPv3 Static tunnel
3660 # @src: source address
3662 # @dst: destination address
3664 # @srcport: #optional source port - mandatory for udp, optional for ip
3666 # @dstport: #optional destination port - mandatory for udp, optional for ip
3668 # @ipv6: #optional - force the use of ipv6
3670 # @udp: #optional - use the udp version of l2tpv3 encapsulation
3672 # @cookie64: #optional - use 64 bit coookies
3674 # @counter: #optional have sequence counter
3676 # @pincounter: #optional pin sequence counter to zero -
3677 # workaround for buggy implementations or
3678 # networks with packet reorder
3680 # @txcookie: #optional 32 or 64 bit transmit cookie
3682 # @rxcookie: #optional 32 or 64 bit receive cookie
3684 # @txsession: 32 bit transmit session
3686 # @rxsession: #optional 32 bit receive session - if not specified
3687 # set to the same value as transmit
3689 # @offset: #optional additional offset - allows the insertion of
3690 # additional application-specific data before the packet payload
3694 { 'struct': 'NetdevL2TPv3Options',
3702 '*cookie64': 'bool',
3704 '*pincounter': 'bool',
3705 '*txcookie': 'uint64',
3706 '*rxcookie': 'uint64',
3707 'txsession': 'uint32',
3708 '*rxsession': 'uint32',
3709 '*offset': 'uint32' } }
3712 # @NetdevVdeOptions:
3714 # Connect the VLAN to a vde switch running on the host.
3716 # @sock: #optional socket path
3718 # @port: #optional port number
3720 # @group: #optional group owner of socket
3722 # @mode: #optional permissions for socket
3726 { 'struct': 'NetdevVdeOptions',
3731 '*mode': 'uint16' } }
3734 # @NetdevDumpOptions:
3736 # Dump VLAN network traffic to a file.
3738 # @len: #optional per-packet size limit (64k default). Understands [TGMKkb]
3741 # @file: #optional dump file path (default is qemu-vlan0.pcap)
3745 { 'struct': 'NetdevDumpOptions',
3751 # @NetdevBridgeOptions:
3753 # Connect a host TAP network interface to a host bridge device.
3755 # @br: #optional bridge name
3757 # @helper: #optional command to execute to configure bridge
3761 { 'struct': 'NetdevBridgeOptions',
3764 '*helper': 'str' } }
3767 # @NetdevHubPortOptions:
3769 # Connect two or more net clients through a software hub.
3771 # @hubid: hub identifier number
3775 { 'struct': 'NetdevHubPortOptions',
3777 'hubid': 'int32' } }
3780 # @NetdevNetmapOptions:
3782 # Connect a client to a netmap-enabled NIC or to a VALE switch port
3784 # @ifname: Either the name of an existing network interface supported by
3785 # netmap, or the name of a VALE port (created on the fly).
3786 # A VALE port name is in the form 'valeXXX:YYY', where XXX and
3787 # YYY are non-negative integers. XXX identifies a switch and
3788 # YYY identifies a port of the switch. VALE ports having the
3789 # same XXX are therefore connected to the same switch.
3791 # @devname: #optional path of the netmap device (default: '/dev/netmap').
3795 { 'struct': 'NetdevNetmapOptions',
3798 '*devname': 'str' } }
3801 # @NetdevVhostUserOptions:
3803 # Vhost-user network backend
3805 # @chardev: name of a unix socket chardev
3807 # @vhostforce: #optional vhost on for non-MSIX virtio guests (default: false).
3809 # @queues: #optional number of queues to be created for multiqueue vhost-user
3810 # (default: 1) (Since 2.5)
3814 { 'struct': 'NetdevVhostUserOptions',
3817 '*vhostforce': 'bool',
3818 '*queues': 'int' } }
3823 # Available netdev drivers.
3827 { 'enum': 'NetClientDriver',
3828 'data': [ 'none', 'nic', 'user', 'tap', 'l2tpv3', 'socket', 'vde', 'dump',
3829 'bridge', 'hubport', 'netmap', 'vhost-user' ] }
3834 # Captures the configuration of a network device.
3836 # @id: identifier for monitor commands.
3838 # @type: Specify the driver used for interpreting remaining arguments.
3842 # 'l2tpv3' - since 2.1
3844 { 'union': 'Netdev',
3845 'base': { 'id': 'str', 'type': 'NetClientDriver' },
3846 'discriminator': 'type',
3848 'none': 'NetdevNoneOptions',
3849 'nic': 'NetLegacyNicOptions',
3850 'user': 'NetdevUserOptions',
3851 'tap': 'NetdevTapOptions',
3852 'l2tpv3': 'NetdevL2TPv3Options',
3853 'socket': 'NetdevSocketOptions',
3854 'vde': 'NetdevVdeOptions',
3855 'dump': 'NetdevDumpOptions',
3856 'bridge': 'NetdevBridgeOptions',
3857 'hubport': 'NetdevHubPortOptions',
3858 'netmap': 'NetdevNetmapOptions',
3859 'vhost-user': 'NetdevVhostUserOptions' } }
3864 # Captures the configuration of a network device; legacy.
3866 # @vlan: #optional vlan number
3868 # @id: #optional identifier for monitor commands
3870 # @name: #optional identifier for monitor commands, ignored if @id is present
3872 # @opts: device type specific properties (legacy)
3876 { 'struct': 'NetLegacy',
3881 'opts': 'NetLegacyOptions' } }
3884 # @NetLegacyOptions:
3886 # Like Netdev, but for use only by the legacy command line options
3890 { 'union': 'NetLegacyOptions',
3892 'none': 'NetdevNoneOptions',
3893 'nic': 'NetLegacyNicOptions',
3894 'user': 'NetdevUserOptions',
3895 'tap': 'NetdevTapOptions',
3896 'l2tpv3': 'NetdevL2TPv3Options',
3897 'socket': 'NetdevSocketOptions',
3898 'vde': 'NetdevVdeOptions',
3899 'dump': 'NetdevDumpOptions',
3900 'bridge': 'NetdevBridgeOptions',
3901 'netmap': 'NetdevNetmapOptions',
3902 'vhost-user': 'NetdevVhostUserOptions' } }
3905 # @NetFilterDirection:
3907 # Indicates whether a netfilter is attached to a netdev's transmit queue or
3908 # receive queue or both.
3910 # @all: the filter is attached both to the receive and the transmit
3911 # queue of the netdev (default).
3913 # @rx: the filter is attached to the receive queue of the netdev,
3914 # where it will receive packets sent to the netdev.
3916 # @tx: the filter is attached to the transmit queue of the netdev,
3917 # where it will receive packets sent by the netdev.
3921 { 'enum': 'NetFilterDirection',
3922 'data': [ 'all', 'rx', 'tx' ] }
3925 # @InetSocketAddress:
3927 # Captures a socket address or address range in the Internet namespace.
3929 # @host: host part of the address
3931 # @port: port part of the address, or lowest port if @to is present
3933 # @to: highest port to try
3935 # @ipv4: whether to accept IPv4 addresses, default try both IPv4 and IPv6
3938 # @ipv6: whether to accept IPv6 addresses, default try both IPv4 and IPv6
3943 { 'struct': 'InetSocketAddress',
3952 # @UnixSocketAddress:
3954 # Captures a socket address in the local ("Unix socket") namespace.
3956 # @path: filesystem path to use
3960 { 'struct': 'UnixSocketAddress',
3965 # @VsockSocketAddress:
3967 # Captures a socket address in the vsock namespace.
3969 # @cid: unique host identifier
3972 # Note: string types are used to allow for possible future hostname or
3973 # service resolution support.
3977 { 'struct': 'VsockSocketAddress',
3985 # Captures the address of a socket, which could also be a named file descriptor
3989 { 'union': 'SocketAddress',
3991 'inet': 'InetSocketAddress',
3992 'unix': 'UnixSocketAddress',
3993 'vsock': 'VsockSocketAddress',
3999 # Receive a file descriptor via SCM rights and assign it a name
4001 # @fdname: file descriptor name
4003 # Returns: Nothing on success
4007 # Notes: If @fdname already exists, the file descriptor assigned to
4008 # it will be closed and replaced by the received file
4011 # The 'closefd' command can be used to explicitly close the
4012 # file descriptor when it is no longer needed.
4016 # -> { "execute": "getfd", "arguments": { "fdname": "fd1" } }
4017 # <- { "return": {} }
4020 { 'command': 'getfd', 'data': {'fdname': 'str'} }
4025 # Close a file descriptor previously passed via SCM rights
4027 # @fdname: file descriptor name
4029 # Returns: Nothing on success
4035 # -> { "execute": "closefd", "arguments": { "fdname": "fd1" } }
4036 # <- { "return": {} }
4039 { 'command': 'closefd', 'data': {'fdname': 'str'} }
4044 # Information describing a machine.
4046 # @name: the name of the machine
4048 # @alias: #optional an alias for the machine name
4050 # @is-default: #optional whether the machine is default
4052 # @cpu-max: maximum number of CPUs supported by the machine type
4055 # @hotpluggable-cpus: cpu hotplug via -device is supported (since 2.7.0)
4059 { 'struct': 'MachineInfo',
4060 'data': { 'name': 'str', '*alias': 'str',
4061 '*is-default': 'bool', 'cpu-max': 'int',
4062 'hotpluggable-cpus': 'bool'} }
4067 # Return a list of supported machines
4069 # Returns: a list of MachineInfo
4073 { 'command': 'query-machines', 'returns': ['MachineInfo'] }
4076 # @CpuDefinitionInfo:
4078 # Virtual CPU definition.
4080 # @name: the name of the CPU definition
4082 # @migration-safe: #optional whether a CPU definition can be safely used for
4083 # migration in combination with a QEMU compatibility machine
4084 # when migrating between different QMU versions and between
4085 # hosts with different sets of (hardware or software)
4086 # capabilities. If not provided, information is not available
4087 # and callers should not assume the CPU definition to be
4088 # migration-safe. (since 2.8)
4090 # @static: whether a CPU definition is static and will not change depending on
4091 # QEMU version, machine type, machine options and accelerator options.
4092 # A static model is always migration-safe. (since 2.8)
4094 # @unavailable-features: #optional List of properties that prevent
4095 # the CPU model from running in the current
4097 # @typename: Type name that can be used as argument to @device-list-properties,
4098 # to introspect properties configurable using -cpu or -global.
4101 # @unavailable-features is a list of QOM property names that
4102 # represent CPU model attributes that prevent the CPU from running.
4103 # If the QOM property is read-only, that means there's no known
4104 # way to make the CPU model run in the current host. Implementations
4105 # that choose not to provide specific information return the
4106 # property name "type".
4107 # If the property is read-write, it means that it MAY be possible
4108 # to run the CPU model in the current host if that property is
4109 # changed. Management software can use it as hints to suggest or
4110 # choose an alternative for the user, or just to generate meaningful
4111 # error messages explaining why the CPU model can't be used.
4112 # If @unavailable-features is an empty list, the CPU model is
4113 # runnable using the current host and machine-type.
4114 # If @unavailable-features is not present, runnability
4115 # information for the CPU is not available.
4119 { 'struct': 'CpuDefinitionInfo',
4120 'data': { 'name': 'str', '*migration-safe': 'bool', 'static': 'bool',
4121 '*unavailable-features': [ 'str' ], 'typename': 'str' } }
4124 # @query-cpu-definitions:
4126 # Return a list of supported virtual CPU definitions
4128 # Returns: a list of CpuDefInfo
4132 { 'command': 'query-cpu-definitions', 'returns': ['CpuDefinitionInfo'] }
4137 # Virtual CPU model.
4139 # A CPU model consists of the name of a CPU definition, to which
4140 # delta changes are applied (e.g. features added/removed). Most magic values
4141 # that an architecture might require should be hidden behind the name.
4142 # However, if required, architectures can expose relevant properties.
4144 # @name: the name of the CPU definition the model is based on
4145 # @props: #optional a dictionary of QOM properties to be applied
4149 { 'struct': 'CpuModelInfo',
4150 'data': { 'name': 'str',
4154 # @CpuModelExpansionType:
4156 # An enumeration of CPU model expansion types.
4158 # @static: Expand to a static CPU model, a combination of a static base
4159 # model name and property delta changes. As the static base model will
4160 # never change, the expanded CPU model will be the same, independant of
4161 # independent of QEMU version, machine type, machine options, and
4162 # accelerator options. Therefore, the resulting model can be used by
4163 # tooling without having to specify a compatibility machine - e.g. when
4164 # displaying the "host" model. static CPU models are migration-safe.
4166 # @full: Expand all properties. The produced model is not guaranteed to be
4167 # migration-safe, but allows tooling to get an insight and work with
4172 { 'enum': 'CpuModelExpansionType',
4173 'data': [ 'static', 'full' ] }
4177 # @CpuModelExpansionInfo:
4179 # The result of a cpu model expansion.
4181 # @model: the expanded CpuModelInfo.
4185 { 'struct': 'CpuModelExpansionInfo',
4186 'data': { 'model': 'CpuModelInfo' } }
4190 # @query-cpu-model-expansion:
4192 # Expands a given CPU model (or a combination of CPU model + additional options)
4193 # to different granularities, allowing tooling to get an understanding what a
4194 # specific CPU model looks like in QEMU under a certain configuration.
4196 # This interface can be used to query the "host" CPU model.
4198 # The data returned by this command may be affected by:
4200 # * QEMU version: CPU models may look different depending on the QEMU version.
4201 # (Except for CPU models reported as "static" in query-cpu-definitions.)
4202 # * machine-type: CPU model may look different depending on the machine-type.
4203 # (Except for CPU models reported as "static" in query-cpu-definitions.)
4204 # * machine options (including accelerator): in some architectures, CPU models
4205 # may look different depending on machine and accelerator options. (Except for
4206 # CPU models reported as "static" in query-cpu-definitions.)
4207 # * "-cpu" arguments and global properties: arguments to the -cpu option and
4208 # global properties may affect expansion of CPU models. Using
4209 # query-cpu-model-expansion while using these is not advised.
4211 # Some architectures may not support all expansion types. s390x supports
4212 # "full" and "static".
4214 # Returns: a CpuModelExpansionInfo. Returns an error if expanding CPU models is
4215 # not supported, if the model cannot be expanded, if the model contains
4216 # an unknown CPU definition name, unknown properties or properties
4217 # with a wrong type. Also returns an error if an expansion type is
4222 { 'command': 'query-cpu-model-expansion',
4223 'data': { 'type': 'CpuModelExpansionType',
4224 'model': 'CpuModelInfo' },
4225 'returns': 'CpuModelExpansionInfo' }
4228 # @CpuModelCompareResult:
4230 # An enumeration of CPU model comparation results. The result is usually
4231 # calculated using e.g. CPU features or CPU generations.
4233 # @incompatible: If model A is incompatible to model B, model A is not
4234 # guaranteed to run where model B runs and the other way around.
4236 # @identical: If model A is identical to model B, model A is guaranteed to run
4237 # where model B runs and the other way around.
4239 # @superset: If model A is a superset of model B, model B is guaranteed to run
4240 # where model A runs. There are no guarantees about the other way.
4242 # @subset: If model A is a subset of model B, model A is guaranteed to run
4243 # where model B runs. There are no guarantees about the other way.
4247 { 'enum': 'CpuModelCompareResult',
4248 'data': [ 'incompatible', 'identical', 'superset', 'subset' ] }
4251 # @CpuModelCompareInfo:
4253 # The result of a CPU model comparison.
4255 # @result: The result of the compare operation.
4256 # @responsible-properties: List of properties that led to the comparison result
4257 # not being identical.
4259 # @responsible-properties is a list of QOM property names that led to
4260 # both CPUs not being detected as identical. For identical models, this
4262 # If a QOM property is read-only, that means there's no known way to make the
4263 # CPU models identical. If the special property name "type" is included, the
4264 # models are by definition not identical and cannot be made identical.
4268 { 'struct': 'CpuModelCompareInfo',
4269 'data': {'result': 'CpuModelCompareResult',
4270 'responsible-properties': ['str']
4275 # @query-cpu-model-comparison:
4277 # Compares two CPU models, returning how they compare in a specific
4278 # configuration. The results indicates how both models compare regarding
4279 # runnability. This result can be used by tooling to make decisions if a
4280 # certain CPU model will run in a certain configuration or if a compatible
4281 # CPU model has to be created by baselining.
4283 # Usually, a CPU model is compared against the maximum possible CPU model
4284 # of a certain configuration (e.g. the "host" model for KVM). If that CPU
4285 # model is identical or a subset, it will run in that configuration.
4287 # The result returned by this command may be affected by:
4289 # * QEMU version: CPU models may look different depending on the QEMU version.
4290 # (Except for CPU models reported as "static" in query-cpu-definitions.)
4291 # * machine-type: CPU model may look different depending on the machine-type.
4292 # (Except for CPU models reported as "static" in query-cpu-definitions.)
4293 # * machine options (including accelerator): in some architectures, CPU models
4294 # may look different depending on machine and accelerator options. (Except for
4295 # CPU models reported as "static" in query-cpu-definitions.)
4296 # * "-cpu" arguments and global properties: arguments to the -cpu option and
4297 # global properties may affect expansion of CPU models. Using
4298 # query-cpu-model-expansion while using these is not advised.
4300 # Some architectures may not support comparing CPU models. s390x supports
4301 # comparing CPU models.
4303 # Returns: a CpuModelBaselineInfo. Returns an error if comparing CPU models is
4304 # not supported, if a model cannot be used, if a model contains
4305 # an unknown cpu definition name, unknown properties or properties
4310 { 'command': 'query-cpu-model-comparison',
4311 'data': { 'modela': 'CpuModelInfo', 'modelb': 'CpuModelInfo' },
4312 'returns': 'CpuModelCompareInfo' }
4315 # @CpuModelBaselineInfo:
4317 # The result of a CPU model baseline.
4319 # @model: the baselined CpuModelInfo.
4323 { 'struct': 'CpuModelBaselineInfo',
4324 'data': { 'model': 'CpuModelInfo' } }
4327 # @query-cpu-model-baseline:
4329 # Baseline two CPU models, creating a compatible third model. The created
4330 # model will always be a static, migration-safe CPU model (see "static"
4331 # CPU model expansion for details).
4333 # This interface can be used by tooling to create a compatible CPU model out
4334 # two CPU models. The created CPU model will be identical to or a subset of
4335 # both CPU models when comparing them. Therefore, the created CPU model is
4336 # guaranteed to run where the given CPU models run.
4338 # The result returned by this command may be affected by:
4340 # * QEMU version: CPU models may look different depending on the QEMU version.
4341 # (Except for CPU models reported as "static" in query-cpu-definitions.)
4342 # * machine-type: CPU model may look different depending on the machine-type.
4343 # (Except for CPU models reported as "static" in query-cpu-definitions.)
4344 # * machine options (including accelerator): in some architectures, CPU models
4345 # may look different depending on machine and accelerator options. (Except for
4346 # CPU models reported as "static" in query-cpu-definitions.)
4347 # * "-cpu" arguments and global properties: arguments to the -cpu option and
4348 # global properties may affect expansion of CPU models. Using
4349 # query-cpu-model-expansion while using these is not advised.
4351 # Some architectures may not support baselining CPU models. s390x supports
4352 # baselining CPU models.
4354 # Returns: a CpuModelBaselineInfo. Returns an error if baselining CPU models is
4355 # not supported, if a model cannot be used, if a model contains
4356 # an unknown cpu definition name, unknown properties or properties
4361 { 'command': 'query-cpu-model-baseline',
4362 'data': { 'modela': 'CpuModelInfo',
4363 'modelb': 'CpuModelInfo' },
4364 'returns': 'CpuModelBaselineInfo' }
4369 # Information about a file descriptor that was added to an fd set.
4371 # @fdset-id: The ID of the fd set that @fd was added to.
4373 # @fd: The file descriptor that was received via SCM rights and
4374 # added to the fd set.
4378 { 'struct': 'AddfdInfo', 'data': {'fdset-id': 'int', 'fd': 'int'} }
4383 # Add a file descriptor, that was passed via SCM rights, to an fd set.
4385 # @fdset-id: #optional The ID of the fd set to add the file descriptor to.
4387 # @opaque: #optional A free-form string that can be used to describe the fd.
4389 # Returns: @AddfdInfo on success
4391 # If file descriptor was not received, FdNotSupplied
4393 # If @fdset-id is a negative value, InvalidParameterValue
4395 # Notes: The list of fd sets is shared by all monitor connections.
4397 # If @fdset-id is not specified, a new fd set will be created.
4403 # -> { "execute": "add-fd", "arguments": { "fdset-id": 1 } }
4404 # <- { "return": { "fdset-id": 1, "fd": 3 } }
4407 { 'command': 'add-fd', 'data': {'*fdset-id': 'int', '*opaque': 'str'},
4408 'returns': 'AddfdInfo' }
4413 # Remove a file descriptor from an fd set.
4415 # @fdset-id: The ID of the fd set that the file descriptor belongs to.
4417 # @fd: #optional The file descriptor that is to be removed.
4419 # Returns: Nothing on success
4420 # If @fdset-id or @fd is not found, FdNotFound
4424 # Notes: The list of fd sets is shared by all monitor connections.
4426 # If @fd is not specified, all file descriptors in @fdset-id
4431 # -> { "execute": "remove-fd", "arguments": { "fdset-id": 1, "fd": 3 } }
4432 # <- { "return": {} }
4435 { 'command': 'remove-fd', 'data': {'fdset-id': 'int', '*fd': 'int'} }
4440 # Information about a file descriptor that belongs to an fd set.
4442 # @fd: The file descriptor value.
4444 # @opaque: #optional A free-form string that can be used to describe the fd.
4448 { 'struct': 'FdsetFdInfo',
4449 'data': {'fd': 'int', '*opaque': 'str'} }
4454 # Information about an fd set.
4456 # @fdset-id: The ID of the fd set.
4458 # @fds: A list of file descriptors that belong to this fd set.
4462 { 'struct': 'FdsetInfo',
4463 'data': {'fdset-id': 'int', 'fds': ['FdsetFdInfo']} }
4468 # Return information describing all fd sets.
4470 # Returns: A list of @FdsetInfo
4474 # Note: The list of fd sets is shared by all monitor connections.
4478 # -> { "execute": "query-fdsets" }
4484 # "opaque": "rdonly:/path/to/file"
4488 # "opaque": "rdwr:/path/to/file"
4508 { 'command': 'query-fdsets', 'returns': ['FdsetInfo'] }
4513 # Information describing the QEMU target.
4515 # @arch: the target architecture (eg "x86_64", "i386", etc)
4519 { 'struct': 'TargetInfo',
4520 'data': { 'arch': 'str' } }
4525 # Return information about the target for this QEMU
4527 # Returns: TargetInfo
4531 { 'command': 'query-target', 'returns': 'TargetInfo' }
4536 # An enumeration of key name.
4538 # This is used by the @send-key command.
4540 # @unmapped: since 2.0
4543 # @kp_comma: since 2.4
4544 # @kp_equals: since 2.6
4546 # @hiragana: since 2.9
4547 # @henkan: since 2.9
4553 { 'enum': 'QKeyCode',
4554 'data': [ 'unmapped',
4555 'shift', 'shift_r', 'alt', 'alt_r', 'altgr', 'altgr_r', 'ctrl',
4556 'ctrl_r', 'menu', 'esc', '1', '2', '3', '4', '5', '6', '7', '8',
4557 '9', '0', 'minus', 'equal', 'backspace', 'tab', 'q', 'w', 'e',
4558 'r', 't', 'y', 'u', 'i', 'o', 'p', 'bracket_left', 'bracket_right',
4559 'ret', 'a', 's', 'd', 'f', 'g', 'h', 'j', 'k', 'l', 'semicolon',
4560 'apostrophe', 'grave_accent', 'backslash', 'z', 'x', 'c', 'v', 'b',
4561 'n', 'm', 'comma', 'dot', 'slash', 'asterisk', 'spc', 'caps_lock',
4562 'f1', 'f2', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9', 'f10',
4563 'num_lock', 'scroll_lock', 'kp_divide', 'kp_multiply',
4564 'kp_subtract', 'kp_add', 'kp_enter', 'kp_decimal', 'sysrq', 'kp_0',
4565 'kp_1', 'kp_2', 'kp_3', 'kp_4', 'kp_5', 'kp_6', 'kp_7', 'kp_8',
4566 'kp_9', 'less', 'f11', 'f12', 'print', 'home', 'pgup', 'pgdn', 'end',
4567 'left', 'up', 'down', 'right', 'insert', 'delete', 'stop', 'again',
4568 'props', 'undo', 'front', 'copy', 'open', 'paste', 'find', 'cut',
4569 'lf', 'help', 'meta_l', 'meta_r', 'compose', 'pause',
4570 'ro', 'hiragana', 'henkan', 'yen',
4571 'kp_comma', 'kp_equals', 'power' ] }
4576 # Represents a keyboard key.
4580 { 'union': 'KeyValue',
4583 'qcode': 'QKeyCode' } }
4588 # Send keys to guest.
4590 # @keys: An array of @KeyValue elements. All @KeyValues in this array are
4591 # simultaneously sent to the guest. A @KeyValue.number value is sent
4592 # directly to the guest, while @KeyValue.qcode must be a valid
4595 # @hold-time: #optional time to delay key up events, milliseconds. Defaults
4598 # Returns: Nothing on success
4599 # If key is unknown or redundant, InvalidParameter
4605 # -> { "execute": "send-key",
4606 # "arguments": { "keys": [ { "type": "qcode", "data": "ctrl" },
4607 # { "type": "qcode", "data": "alt" },
4608 # { "type": "qcode", "data": "delete" } ] } }
4609 # <- { "return": {} }
4612 { 'command': 'send-key',
4613 'data': { 'keys': ['KeyValue'], '*hold-time': 'int' } }
4618 # Write a PPM of the VGA screen to a file.
4620 # @filename: the path of a new PPM file to store the image
4622 # Returns: Nothing on success
4628 # -> { "execute": "screendump",
4629 # "arguments": { "filename": "/tmp/image" } }
4630 # <- { "return": {} }
4633 { 'command': 'screendump', 'data': {'filename': 'str'} }
4639 # Configuration shared across all chardev backends
4641 # @logfile: #optional The name of a logfile to save output
4642 # @logappend: #optional true to append instead of truncate
4643 # (default to false to truncate)
4647 { 'struct': 'ChardevCommon', 'data': { '*logfile': 'str',
4648 '*logappend': 'bool' } }
4653 # Configuration info for file chardevs.
4655 # @in: #optional The name of the input file
4656 # @out: The name of the output file
4657 # @append: #optional Open the file in append mode (default false to
4658 # truncate) (Since 2.6)
4662 { 'struct': 'ChardevFile', 'data': { '*in' : 'str',
4664 '*append': 'bool' },
4665 'base': 'ChardevCommon' }
4670 # Configuration info for device and pipe chardevs.
4672 # @device: The name of the special file for the device,
4673 # i.e. /dev/ttyS0 on Unix or COM1: on Windows
4677 { 'struct': 'ChardevHostdev', 'data': { 'device' : 'str' },
4678 'base': 'ChardevCommon' }
4683 # Configuration info for (stream) socket chardevs.
4685 # @addr: socket address to listen on (server=true)
4686 # or connect to (server=false)
4687 # @tls-creds: #optional the ID of the TLS credentials object (since 2.6)
4688 # @server: #optional create server socket (default: true)
4689 # @wait: #optional wait for incoming connection on server
4690 # sockets (default: false).
4691 # @nodelay: #optional set TCP_NODELAY socket option (default: false)
4692 # @telnet: #optional enable telnet protocol on server
4693 # sockets (default: false)
4694 # @reconnect: #optional For a client socket, if a socket is disconnected,
4695 # then attempt a reconnect after the given number of seconds.
4696 # Setting this to zero disables this function. (default: 0)
4701 { 'struct': 'ChardevSocket', 'data': { 'addr' : 'SocketAddress',
4702 '*tls-creds' : 'str',
4705 '*nodelay' : 'bool',
4707 '*reconnect' : 'int' },
4708 'base': 'ChardevCommon' }
4713 # Configuration info for datagram socket chardevs.
4715 # @remote: remote address
4716 # @local: #optional local address
4720 { 'struct': 'ChardevUdp', 'data': { 'remote' : 'SocketAddress',
4721 '*local' : 'SocketAddress' },
4722 'base': 'ChardevCommon' }
4727 # Configuration info for mux chardevs.
4729 # @chardev: name of the base chardev.
4733 { 'struct': 'ChardevMux', 'data': { 'chardev' : 'str' },
4734 'base': 'ChardevCommon' }
4739 # Configuration info for stdio chardevs.
4741 # @signal: #optional Allow signals (such as SIGINT triggered by ^C)
4742 # be delivered to qemu. Default: true in -nographic mode,
4747 { 'struct': 'ChardevStdio', 'data': { '*signal' : 'bool' },
4748 'base': 'ChardevCommon' }
4752 # @ChardevSpiceChannel:
4754 # Configuration info for spice vm channel chardevs.
4756 # @type: kind of channel (for example vdagent).
4760 { 'struct': 'ChardevSpiceChannel', 'data': { 'type' : 'str' },
4761 'base': 'ChardevCommon' }
4764 # @ChardevSpicePort:
4766 # Configuration info for spice port chardevs.
4768 # @fqdn: name of the channel (see docs/spice-port-fqdn.txt)
4772 { 'struct': 'ChardevSpicePort', 'data': { 'fqdn' : 'str' },
4773 'base': 'ChardevCommon' }
4778 # Configuration info for virtual console chardevs.
4780 # @width: console width, in pixels
4781 # @height: console height, in pixels
4782 # @cols: console width, in chars
4783 # @rows: console height, in chars
4787 { 'struct': 'ChardevVC', 'data': { '*width' : 'int',
4791 'base': 'ChardevCommon' }
4796 # Configuration info for ring buffer chardevs.
4798 # @size: #optional ring buffer size, must be power of two, default is 65536
4802 { 'struct': 'ChardevRingbuf', 'data': { '*size' : 'int' },
4803 'base': 'ChardevCommon' }
4808 # Configuration info for the new chardev backend.
4810 # Since: 1.4 (testdev since 2.2)
4812 { 'union': 'ChardevBackend', 'data': { 'file' : 'ChardevFile',
4813 'serial' : 'ChardevHostdev',
4814 'parallel': 'ChardevHostdev',
4815 'pipe' : 'ChardevHostdev',
4816 'socket' : 'ChardevSocket',
4817 'udp' : 'ChardevUdp',
4818 'pty' : 'ChardevCommon',
4819 'null' : 'ChardevCommon',
4820 'mux' : 'ChardevMux',
4821 'msmouse': 'ChardevCommon',
4822 'braille': 'ChardevCommon',
4823 'testdev': 'ChardevCommon',
4824 'stdio' : 'ChardevStdio',
4825 'console': 'ChardevCommon',
4826 'spicevmc' : 'ChardevSpiceChannel',
4827 'spiceport' : 'ChardevSpicePort',
4829 'ringbuf': 'ChardevRingbuf',
4830 # next one is just for compatibility
4831 'memory' : 'ChardevRingbuf' } }
4836 # Return info about the chardev backend just created.
4838 # @pty: #optional name of the slave pseudoterminal device, present if
4839 # and only if a chardev of type 'pty' was created
4843 { 'struct' : 'ChardevReturn', 'data': { '*pty' : 'str' } }
4848 # Add a character device backend
4850 # @id: the chardev's ID, must be unique
4851 # @backend: backend type and parameters
4853 # Returns: ChardevReturn.
4859 # -> { "execute" : "chardev-add",
4860 # "arguments" : { "id" : "foo",
4861 # "backend" : { "type" : "null", "data" : {} } } }
4862 # <- { "return": {} }
4864 # -> { "execute" : "chardev-add",
4865 # "arguments" : { "id" : "bar",
4866 # "backend" : { "type" : "file",
4867 # "data" : { "out" : "/tmp/bar.log" } } } }
4868 # <- { "return": {} }
4870 # -> { "execute" : "chardev-add",
4871 # "arguments" : { "id" : "baz",
4872 # "backend" : { "type" : "pty", "data" : {} } } }
4873 # <- { "return": { "pty" : "/dev/pty/42" } }
4876 { 'command': 'chardev-add', 'data': {'id' : 'str',
4877 'backend' : 'ChardevBackend' },
4878 'returns': 'ChardevReturn' }
4883 # Remove a character device backend
4885 # @id: the chardev's ID, must exist and not be in use
4887 # Returns: Nothing on success
4893 # -> { "execute": "chardev-remove", "arguments": { "id" : "foo" } }
4894 # <- { "return": {} }
4897 { 'command': 'chardev-remove', 'data': {'id': 'str'} }
4902 # An enumeration of TPM models
4904 # @tpm-tis: TPM TIS model
4908 { 'enum': 'TpmModel', 'data': [ 'tpm-tis' ] }
4911 # @query-tpm-models:
4913 # Return a list of supported TPM models
4915 # Returns: a list of TpmModel
4921 # -> { "execute": "query-tpm-models" }
4922 # <- { "return": [ "tpm-tis" ] }
4925 { 'command': 'query-tpm-models', 'returns': ['TpmModel'] }
4930 # An enumeration of TPM types
4932 # @passthrough: TPM passthrough type
4936 { 'enum': 'TpmType', 'data': [ 'passthrough' ] }
4941 # Return a list of supported TPM types
4943 # Returns: a list of TpmType
4949 # -> { "execute": "query-tpm-types" }
4950 # <- { "return": [ "passthrough" ] }
4953 { 'command': 'query-tpm-types', 'returns': ['TpmType'] }
4956 # @TPMPassthroughOptions:
4958 # Information about the TPM passthrough type
4960 # @path: #optional string describing the path used for accessing the TPM device
4962 # @cancel-path: #optional string showing the TPM's sysfs cancel file
4963 # for cancellation of TPM commands while they are executing
4967 { 'struct': 'TPMPassthroughOptions', 'data': { '*path' : 'str',
4968 '*cancel-path' : 'str'} }
4973 # A union referencing different TPM backend types' configuration options
4975 # @type: 'passthrough' The configuration options for the TPM passthrough type
4979 { 'union': 'TpmTypeOptions',
4980 'data': { 'passthrough' : 'TPMPassthroughOptions' } }
4985 # Information about the TPM
4987 # @id: The Id of the TPM
4989 # @model: The TPM frontend model
4991 # @options: The TPM (backend) type configuration options
4995 { 'struct': 'TPMInfo',
4996 'data': {'id': 'str',
4997 'model': 'TpmModel',
4998 'options': 'TpmTypeOptions' } }
5003 # Return information about the TPM device
5005 # Returns: @TPMInfo on success
5011 # -> { "execute": "query-tpm" }
5014 # { "model": "tpm-tis",
5016 # { "type": "passthrough",
5018 # { "cancel-path": "/sys/class/misc/tpm0/device/cancel",
5019 # "path": "/dev/tpm0"
5028 { 'command': 'query-tpm', 'returns': ['TPMInfo'] }
5031 # @AcpiTableOptions:
5033 # Specify an ACPI table on the command line to load.
5035 # At most one of @file and @data can be specified. The list of files specified
5036 # by any one of them is loaded and concatenated in order. If both are omitted,
5039 # Other fields / optargs can be used to override fields of the generic ACPI
5040 # table header; refer to the ACPI specification 5.0, section 5.2.6 System
5041 # Description Table Header. If a header field is not overridden, then the
5042 # corresponding value from the concatenated blob is used (in case of @file), or
5043 # it is filled in with a hard-coded value (in case of @data).
5045 # String fields are copied into the matching ACPI member from lowest address
5046 # upwards, and silently truncated / NUL-padded to length.
5048 # @sig: #optional table signature / identifier (4 bytes)
5050 # @rev: #optional table revision number (dependent on signature, 1 byte)
5052 # @oem_id: #optional OEM identifier (6 bytes)
5054 # @oem_table_id: #optional OEM table identifier (8 bytes)
5056 # @oem_rev: #optional OEM-supplied revision number (4 bytes)
5058 # @asl_compiler_id: #optional identifier of the utility that created the table
5061 # @asl_compiler_rev: #optional revision number of the utility that created the
5064 # @file: #optional colon (:) separated list of pathnames to load and
5065 # concatenate as table data. The resultant binary blob is expected to
5066 # have an ACPI table header. At least one file is required. This field
5069 # @data: #optional colon (:) separated list of pathnames to load and
5070 # concatenate as table data. The resultant binary blob must not have an
5071 # ACPI table header. At least one file is required. This field excludes
5076 { 'struct': 'AcpiTableOptions',
5081 '*oem_table_id': 'str',
5082 '*oem_rev': 'uint32',
5083 '*asl_compiler_id': 'str',
5084 '*asl_compiler_rev': 'uint32',
5089 # @CommandLineParameterType:
5091 # Possible types for an option parameter.
5093 # @string: accepts a character string
5095 # @boolean: accepts "on" or "off"
5097 # @number: accepts a number
5099 # @size: accepts a number followed by an optional suffix (K)ilo,
5100 # (M)ega, (G)iga, (T)era
5104 { 'enum': 'CommandLineParameterType',
5105 'data': ['string', 'boolean', 'number', 'size'] }
5108 # @CommandLineParameterInfo:
5110 # Details about a single parameter of a command line option.
5112 # @name: parameter name
5114 # @type: parameter @CommandLineParameterType
5116 # @help: #optional human readable text string, not suitable for parsing.
5118 # @default: #optional default value string (since 2.1)
5122 { 'struct': 'CommandLineParameterInfo',
5123 'data': { 'name': 'str',
5124 'type': 'CommandLineParameterType',
5126 '*default': 'str' } }
5129 # @CommandLineOptionInfo:
5131 # Details about a command line option, including its list of parameter details
5133 # @option: option name
5135 # @parameters: an array of @CommandLineParameterInfo
5139 { 'struct': 'CommandLineOptionInfo',
5140 'data': { 'option': 'str', 'parameters': ['CommandLineParameterInfo'] } }
5143 # @query-command-line-options:
5145 # Query command line option schema.
5147 # @option: #optional option name
5149 # Returns: list of @CommandLineOptionInfo for all options (or for the given
5150 # @option). Returns an error if the given @option doesn't exist.
5156 # -> { "execute": "query-command-line-options",
5157 # "arguments": { "option": "option-rom" } }
5162 # "name": "romfile",
5166 # "name": "bootindex",
5170 # "option": "option-rom"
5176 {'command': 'query-command-line-options', 'data': { '*option': 'str' },
5177 'returns': ['CommandLineOptionInfo'] }
5180 # @X86CPURegister32:
5182 # A X86 32-bit register
5186 { 'enum': 'X86CPURegister32',
5187 'data': [ 'EAX', 'EBX', 'ECX', 'EDX', 'ESP', 'EBP', 'ESI', 'EDI' ] }
5190 # @X86CPUFeatureWordInfo:
5192 # Information about a X86 CPU feature word
5194 # @cpuid-input-eax: Input EAX value for CPUID instruction for that feature word
5196 # @cpuid-input-ecx: #optional Input ECX value for CPUID instruction for that
5199 # @cpuid-register: Output register containing the feature bits
5201 # @features: value of output register, containing the feature bits
5205 { 'struct': 'X86CPUFeatureWordInfo',
5206 'data': { 'cpuid-input-eax': 'int',
5207 '*cpuid-input-ecx': 'int',
5208 'cpuid-register': 'X86CPURegister32',
5209 'features': 'int' } }
5212 # @DummyForceArrays:
5214 # Not used by QMP; hack to let us use X86CPUFeatureWordInfoList internally
5218 { 'struct': 'DummyForceArrays',
5219 'data': { 'unused': ['X86CPUFeatureWordInfo'] } }
5225 # Packets receiving state
5227 # @normal: filter assigned packets according to the mac-table
5229 # @none: don't receive any assigned packet
5231 # @all: receive all assigned packets
5235 { 'enum': 'RxState', 'data': [ 'normal', 'none', 'all' ] }
5240 # Rx-filter information for a NIC.
5242 # @name: net client name
5244 # @promiscuous: whether promiscuous mode is enabled
5246 # @multicast: multicast receive state
5248 # @unicast: unicast receive state
5250 # @vlan: vlan receive state (Since 2.0)
5252 # @broadcast-allowed: whether to receive broadcast
5254 # @multicast-overflow: multicast table is overflowed or not
5256 # @unicast-overflow: unicast table is overflowed or not
5258 # @main-mac: the main macaddr string
5260 # @vlan-table: a list of active vlan id
5262 # @unicast-table: a list of unicast macaddr string
5264 # @multicast-table: a list of multicast macaddr string
5268 { 'struct': 'RxFilterInfo',
5271 'promiscuous': 'bool',
5272 'multicast': 'RxState',
5273 'unicast': 'RxState',
5275 'broadcast-allowed': 'bool',
5276 'multicast-overflow': 'bool',
5277 'unicast-overflow': 'bool',
5279 'vlan-table': ['int'],
5280 'unicast-table': ['str'],
5281 'multicast-table': ['str'] }}
5286 # Return rx-filter information for all NICs (or for the given NIC).
5288 # @name: #optional net client name
5290 # Returns: list of @RxFilterInfo for all NICs (or for the given NIC).
5291 # Returns an error if the given @name doesn't exist, or given
5292 # NIC doesn't support rx-filter querying, or given net client
5299 # -> { "execute": "query-rx-filter", "arguments": { "name": "vnet0" } }
5302 # "promiscuous": true,
5304 # "main-mac": "52:54:00:12:34:56",
5305 # "unicast": "normal",
5311 # "unicast-table": [
5313 # "multicast": "normal",
5314 # "multicast-overflow": false,
5315 # "unicast-overflow": false,
5316 # "multicast-table": [
5317 # "01:00:5e:00:00:01",
5318 # "33:33:00:00:00:01",
5319 # "33:33:ff:12:34:56"
5321 # "broadcast-allowed": false
5327 { 'command': 'query-rx-filter', 'data': { '*name': 'str' },
5328 'returns': ['RxFilterInfo'] }
5333 # Button of a pointer input device (mouse, tablet).
5337 { 'enum' : 'InputButton',
5338 'data' : [ 'left', 'middle', 'right', 'wheel-up', 'wheel-down' ] }
5343 # Position axis of a pointer input device (mouse, tablet).
5347 { 'enum' : 'InputAxis',
5348 'data' : [ 'x', 'y' ] }
5353 # Keyboard input event.
5355 # @key: Which key this event is for.
5356 # @down: True for key-down and false for key-up events.
5360 { 'struct' : 'InputKeyEvent',
5361 'data' : { 'key' : 'KeyValue',
5367 # Pointer button input event.
5369 # @button: Which button this event is for.
5370 # @down: True for key-down and false for key-up events.
5374 { 'struct' : 'InputBtnEvent',
5375 'data' : { 'button' : 'InputButton',
5381 # Pointer motion input event.
5383 # @axis: Which axis is referenced by @value.
5384 # @value: Pointer position. For absolute coordinates the
5385 # valid range is 0 -> 0x7ffff
5389 { 'struct' : 'InputMoveEvent',
5390 'data' : { 'axis' : 'InputAxis',
5396 # Input event union.
5398 # @type: the input type, one of:
5399 # - 'key': Input event of Keyboard
5400 # - 'btn': Input event of pointer buttons
5401 # - 'rel': Input event of relative pointer motion
5402 # - 'abs': Input event of absolute pointer motion
5406 { 'union' : 'InputEvent',
5407 'data' : { 'key' : 'InputKeyEvent',
5408 'btn' : 'InputBtnEvent',
5409 'rel' : 'InputMoveEvent',
5410 'abs' : 'InputMoveEvent' } }
5413 # @input-send-event:
5415 # Send input event(s) to guest.
5417 # @device: #optional display device to send event(s) to.
5418 # @head: #optional head to send event(s) to, in case the
5419 # display device supports multiple scanouts.
5420 # @events: List of InputEvent union.
5422 # Returns: Nothing on success.
5424 # The @device and @head parameters can be used to send the input event
5425 # to specific input devices in case (a) multiple input devices of the
5426 # same kind are added to the virtual machine and (b) you have
5427 # configured input routing (see docs/multiseat.txt) for those input
5428 # devices. The parameters work exactly like the device and head
5429 # properties of input devices. If @device is missing, only devices
5430 # that have no input routing config are admissible. If @device is
5431 # specified, both input devices with and without input routing config
5432 # are admissible, but devices with input routing config take
5437 # Note: The consoles are visible in the qom tree, under
5438 # /backend/console[$index]. They have a device link and head property,
5439 # so it is possible to map which console belongs to which device and
5444 # 1. Press left mouse button.
5446 # -> { "execute": "input-send-event",
5447 # "arguments": { "device": "video0",
5448 # "events": [ { "type": "btn",
5449 # "data" : { "down": true, "button": "left" } } ] } }
5450 # <- { "return": {} }
5452 # -> { "execute": "input-send-event",
5453 # "arguments": { "device": "video0",
5454 # "events": [ { "type": "btn",
5455 # "data" : { "down": false, "button": "left" } } ] } }
5456 # <- { "return": {} }
5458 # 2. Press ctrl-alt-del.
5460 # -> { "execute": "input-send-event",
5461 # "arguments": { "events": [
5462 # { "type": "key", "data" : { "down": true,
5463 # "key": {"type": "qcode", "data": "ctrl" } } },
5464 # { "type": "key", "data" : { "down": true,
5465 # "key": {"type": "qcode", "data": "alt" } } },
5466 # { "type": "key", "data" : { "down": true,
5467 # "key": {"type": "qcode", "data": "delete" } } } ] } }
5468 # <- { "return": {} }
5470 # 3. Move mouse pointer to absolute coordinates (20000, 400).
5472 # -> { "execute": "input-send-event" ,
5473 # "arguments": { "events": [
5474 # { "type": "abs", "data" : { "axis": "x", "value" : 20000 } },
5475 # { "type": "abs", "data" : { "axis": "y", "value" : 400 } } ] } }
5476 # <- { "return": {} }
5479 { 'command': 'input-send-event',
5480 'data': { '*device': 'str',
5482 'events' : [ 'InputEvent' ] } }
5487 # A discriminated record of NUMA options. (for OptsVisitor)
5491 { 'union': 'NumaOptions',
5493 'node': 'NumaNodeOptions' }}
5498 # Create a guest NUMA node. (for OptsVisitor)
5500 # @nodeid: #optional NUMA node ID (increase by 1 from 0 if omitted)
5502 # @cpus: #optional VCPUs belonging to this node (assign VCPUS round-robin
5505 # @mem: #optional memory size of this node; mutually exclusive with @memdev.
5506 # Equally divide total memory among nodes if both @mem and @memdev are
5509 # @memdev: #optional memory backend object. If specified for one node,
5510 # it must be specified for all nodes.
5514 { 'struct': 'NumaNodeOptions',
5516 '*nodeid': 'uint16',
5517 '*cpus': ['uint16'],
5524 # Host memory policy types
5526 # @default: restore default policy, remove any nondefault policy
5528 # @preferred: set the preferred host nodes for allocation
5530 # @bind: a strict policy that restricts memory allocation to the
5531 # host nodes specified
5533 # @interleave: memory allocations are interleaved across the set
5534 # of host nodes specified
5538 { 'enum': 'HostMemPolicy',
5539 'data': [ 'default', 'preferred', 'bind', 'interleave' ] }
5544 # Information about memory backend
5546 # @id: #optional backend's ID if backend has 'id' property (since 2.9)
5548 # @size: memory backend size
5550 # @merge: enables or disables memory merge support
5552 # @dump: includes memory backend's memory in a core dump or not
5554 # @prealloc: enables or disables memory preallocation
5556 # @host-nodes: host nodes for its memory policy
5558 # @policy: memory policy of memory backend
5562 { 'struct': 'Memdev',
5569 'host-nodes': ['uint16'],
5570 'policy': 'HostMemPolicy' }}
5575 # Returns information for all memory backends.
5577 # Returns: a list of @Memdev.
5583 # -> { "execute": "query-memdev" }
5587 # "size": 536870912,
5590 # "prealloc": false,
5591 # "host-nodes": [0, 1],
5595 # "size": 536870912,
5599 # "host-nodes": [2, 3],
5600 # "policy": "preferred"
5606 { 'command': 'query-memdev', 'returns': ['Memdev'] }
5609 # @PCDIMMDeviceInfo:
5611 # PCDIMMDevice state information
5613 # @id: #optional device's ID
5615 # @addr: physical address, where device is mapped
5617 # @size: size of memory that the device provides
5619 # @slot: slot number at which device is plugged in
5621 # @node: NUMA node number where device is plugged in
5623 # @memdev: memory backend linked with device
5625 # @hotplugged: true if device was hotplugged
5627 # @hotpluggable: true if device if could be added/removed while machine is running
5631 { 'struct': 'PCDIMMDeviceInfo',
5632 'data': { '*id': 'str',
5638 'hotplugged': 'bool',
5639 'hotpluggable': 'bool'
5644 # @MemoryDeviceInfo:
5646 # Union containing information about a memory device
5650 { 'union': 'MemoryDeviceInfo', 'data': {'dimm': 'PCDIMMDeviceInfo'} }
5653 # @query-memory-devices:
5655 # Lists available memory devices and their state
5661 # -> { "execute": "query-memory-devices" }
5662 # <- { "return": [ { "data":
5663 # { "addr": 5368709120,
5664 # "hotpluggable": true,
5665 # "hotplugged": true,
5667 # "memdev": "/objects/memX",
5669 # "size": 1073741824,
5675 { 'command': 'query-memory-devices', 'returns': ['MemoryDeviceInfo'] }
5680 # @DIMM: memory slot
5681 # @CPU: logical CPU slot (since 2.7)
5683 { 'enum': 'ACPISlotType', 'data': [ 'DIMM', 'CPU' ] }
5688 # OSPM Status Indication for a device
5689 # For description of possible values of @source and @status fields
5690 # see "_OST (OSPM Status Indication)" chapter of ACPI5.0 spec.
5692 # @device: #optional device ID associated with slot
5694 # @slot: slot ID, unique per slot of a given @slot-type
5696 # @slot-type: type of the slot
5698 # @source: an integer containing the source event
5700 # @status: an integer containing the status code
5704 { 'struct': 'ACPIOSTInfo',
5705 'data' : { '*device': 'str',
5707 'slot-type': 'ACPISlotType',
5712 # @query-acpi-ospm-status:
5714 # Return a list of ACPIOSTInfo for devices that support status
5715 # reporting via ACPI _OST method.
5721 # -> { "execute": "query-acpi-ospm-status" }
5722 # <- { "return": [ { "device": "d1", "slot": "0", "slot-type": "DIMM", "source": 1, "status": 0},
5723 # { "slot": "1", "slot-type": "DIMM", "source": 0, "status": 0},
5724 # { "slot": "2", "slot-type": "DIMM", "source": 0, "status": 0},
5725 # { "slot": "3", "slot-type": "DIMM", "source": 0, "status": 0}
5729 { 'command': 'query-acpi-ospm-status', 'returns': ['ACPIOSTInfo'] }
5732 # @WatchdogExpirationAction:
5734 # An enumeration of the actions taken when the watchdog device's timer is
5737 # @reset: system resets
5739 # @shutdown: system shutdown, note that it is similar to @powerdown, which
5740 # tries to set to system status and notify guest
5742 # @poweroff: system poweroff, the emulator program exits
5744 # @pause: system pauses, similar to @stop
5746 # @debug: system enters debug state
5748 # @none: nothing is done
5750 # @inject-nmi: a non-maskable interrupt is injected into the first VCPU (all
5751 # VCPUS on x86) (since 2.4)
5755 { 'enum': 'WatchdogExpirationAction',
5756 'data': [ 'reset', 'shutdown', 'poweroff', 'pause', 'debug', 'none',
5762 # An enumeration of the I/O operation types
5764 # @read: read operation
5766 # @write: write operation
5770 { 'enum': 'IoOperationType',
5771 'data': [ 'read', 'write' ] }
5774 # @GuestPanicAction:
5776 # An enumeration of the actions taken when guest OS panic is detected
5778 # @pause: system pauses
5780 # Since: 2.1 (poweroff since 2.8)
5782 { 'enum': 'GuestPanicAction',
5783 'data': [ 'pause', 'poweroff' ] }
5786 # @rtc-reset-reinjection:
5788 # This command will reset the RTC interrupt reinjection backlog.
5789 # Can be used if another mechanism to synchronize guest time
5790 # is in effect, for example QEMU guest agent's guest-set-time
5797 # -> { "execute": "rtc-reset-reinjection" }
5798 # <- { "return": {} }
5801 { 'command': 'rtc-reset-reinjection' }
5803 # Rocker ethernet network switch
5804 { 'include': 'qapi/rocker.json' }
5809 # Mode of the replay subsystem.
5811 # @none: normal execution mode. Replay or record are not enabled.
5813 # @record: record mode. All non-deterministic data is written into the
5816 # @play: replay mode. Non-deterministic data required for system execution
5817 # is read from the log.
5821 { 'enum': 'ReplayMode',
5822 'data': [ 'none', 'record', 'play' ] }
5825 # @xen-load-devices-state:
5827 # Load the state of all devices from file. The RAM and the block devices
5828 # of the VM are not loaded by this command.
5830 # @filename: the file to load the state of the devices from as binary
5831 # data. See xen-save-devices-state.txt for a description of the binary
5838 # -> { "execute": "xen-load-devices-state",
5839 # "arguments": { "filename": "/tmp/resume" } }
5840 # <- { "return": {} }
5843 { 'command': 'xen-load-devices-state', 'data': {'filename': 'str'} }
5848 # The struct describes capability for a specific GIC (Generic
5849 # Interrupt Controller) version. These bits are not only decided by
5850 # QEMU/KVM software version, but also decided by the hardware that
5851 # the program is running upon.
5853 # @version: version of GIC to be described. Currently, only 2 and 3
5856 # @emulated: whether current QEMU/hardware supports emulated GIC
5857 # device in user space.
5859 # @kernel: whether current QEMU/hardware supports hardware
5860 # accelerated GIC device in kernel.
5864 { 'struct': 'GICCapability',
5865 'data': { 'version': 'int',
5867 'kernel': 'bool' } }
5870 # @query-gic-capabilities:
5872 # This command is ARM-only. It will return a list of GICCapability
5873 # objects that describe its capability bits.
5875 # Returns: a list of GICCapability objects.
5881 # -> { "execute": "query-gic-capabilities" }
5882 # <- { "return": [{ "version": 2, "emulated": true, "kernel": false },
5883 # { "version": 3, "emulated": false, "kernel": true } ] }
5886 { 'command': 'query-gic-capabilities', 'returns': ['GICCapability'] }
5889 # @CpuInstanceProperties:
5891 # List of properties to be used for hotplugging a CPU instance,
5892 # it should be passed by management with device_add command when
5893 # a CPU is being hotplugged.
5895 # @node-id: #optional NUMA node ID the CPU belongs to
5896 # @socket-id: #optional socket number within node/board the CPU belongs to
5897 # @core-id: #optional core number within socket the CPU belongs to
5898 # @thread-id: #optional thread number within core the CPU belongs to
5900 # Note: currently there are 4 properties that could be present
5901 # but management should be prepared to pass through other
5902 # properties with device_add command to allow for future
5903 # interface extension. This also requires the filed names to be kept in
5904 # sync with the properties passed to -device/device_add.
5908 { 'struct': 'CpuInstanceProperties',
5909 'data': { '*node-id': 'int',
5910 '*socket-id': 'int',
5919 # @type: CPU object type for usage with device_add command
5920 # @props: list of properties to be used for hotplugging CPU
5921 # @vcpus-count: number of logical VCPU threads @HotpluggableCPU provides
5922 # @qom-path: #optional link to existing CPU object if CPU is present or
5923 # omitted if CPU is not present.
5927 { 'struct': 'HotpluggableCPU',
5928 'data': { 'type': 'str',
5929 'vcpus-count': 'int',
5930 'props': 'CpuInstanceProperties',
5936 # @query-hotpluggable-cpus:
5938 # Returns: a list of HotpluggableCPU objects.
5944 # For pseries machine type started with -smp 2,cores=2,maxcpus=4 -cpu POWER8:
5946 # -> { "execute": "query-hotpluggable-cpus" }
5948 # { "props": { "core": 8 }, "type": "POWER8-spapr-cpu-core",
5949 # "vcpus-count": 1 },
5950 # { "props": { "core": 0 }, "type": "POWER8-spapr-cpu-core",
5951 # "vcpus-count": 1, "qom-path": "/machine/unattached/device[0]"}
5954 # For pc machine type started with -smp 1,maxcpus=2:
5956 # -> { "execute": "query-hotpluggable-cpus" }
5959 # "type": "qemu64-x86_64-cpu", "vcpus-count": 1,
5960 # "props": {"core-id": 0, "socket-id": 1, "thread-id": 0}
5963 # "qom-path": "/machine/unattached/device[0]",
5964 # "type": "qemu64-x86_64-cpu", "vcpus-count": 1,
5965 # "props": {"core-id": 0, "socket-id": 0, "thread-id": 0}
5970 { 'command': 'query-hotpluggable-cpus', 'returns': ['HotpluggableCPU'] }