cs4231a: use IsaDma interface instead of global DMA_* functions
[qemu/kevin.git] / qapi-schema.json
blob8d04897922ec6dd8f34dd9425fdcb75847b843da
1 # -*- Mode: Python -*-
3 # QAPI Schema
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' }
17 # Tracing commands
18 { 'include': 'qapi/trace.json' }
20 # QAPI introspection
21 { 'include': 'qapi/introspect.json' }
24 # @LostTickPolicy:
26 # Policy for handling lost ticks in timer devices.
28 # @discard: throw away the missed tick(s) and continue with future injection
29 #           normally.  Guest time may be delayed, unless the OS has explicit
30 #           handling of lost ticks
32 # @delay: continue to deliver ticks at the normal rate.  Guest time will be
33 #         delayed due to the late tick
35 # @merge: merge the missed tick(s) into one tick and inject.  Guest time
36 #         may be delayed, depending on how the OS reacts to the merging
37 #         of ticks
39 # @slew: deliver ticks at a higher rate to catch up with the missed tick. The
40 #        guest time should not be delayed once catchup is complete.
42 # Since: 2.0
44 { 'enum': 'LostTickPolicy',
45   'data': ['discard', 'delay', 'merge', 'slew' ] }
47 # @add_client
49 # Allow client connections for VNC, Spice and socket based
50 # character devices to be passed in to QEMU via SCM_RIGHTS.
52 # @protocol: protocol name. Valid names are "vnc", "spice" or the
53 #            name of a character device (eg. from -chardev id=XXXX)
55 # @fdname: file descriptor name previously passed via 'getfd' command
57 # @skipauth: #optional whether to skip authentication. Only applies
58 #            to "vnc" and "spice" protocols
60 # @tls: #optional whether to perform TLS. Only applies to the "spice"
61 #       protocol
63 # Returns: nothing on success.
65 # Since: 0.14.0
67 { 'command': 'add_client',
68   'data': { 'protocol': 'str', 'fdname': 'str', '*skipauth': 'bool',
69             '*tls': 'bool' } }
72 # @NameInfo:
74 # Guest name information.
76 # @name: #optional The name of the guest
78 # Since 0.14.0
80 { 'struct': 'NameInfo', 'data': {'*name': 'str'} }
83 # @query-name:
85 # Return the name information of a guest.
87 # Returns: @NameInfo of the guest
89 # Since 0.14.0
91 { 'command': 'query-name', 'returns': 'NameInfo' }
94 # @KvmInfo:
96 # Information about support for KVM acceleration
98 # @enabled: true if KVM acceleration is active
100 # @present: true if KVM acceleration is built into this executable
102 # Since: 0.14.0
104 { 'struct': 'KvmInfo', 'data': {'enabled': 'bool', 'present': 'bool'} }
107 # @query-kvm:
109 # Returns information about KVM acceleration
111 # Returns: @KvmInfo
113 # Since: 0.14.0
115 { 'command': 'query-kvm', 'returns': 'KvmInfo' }
118 # @RunState
120 # An enumeration of VM run states.
122 # @debug: QEMU is running on a debugger
124 # @finish-migrate: guest is paused to finish the migration process
126 # @inmigrate: guest is paused waiting for an incoming migration.  Note
127 # that this state does not tell whether the machine will start at the
128 # end of the migration.  This depends on the command-line -S option and
129 # any invocation of 'stop' or 'cont' that has happened since QEMU was
130 # started.
132 # @internal-error: An internal error that prevents further guest execution
133 # has occurred
135 # @io-error: the last IOP has failed and the device is configured to pause
136 # on I/O errors
138 # @paused: guest has been paused via the 'stop' command
140 # @postmigrate: guest is paused following a successful 'migrate'
142 # @prelaunch: QEMU was started with -S and guest has not started
144 # @restore-vm: guest is paused to restore VM state
146 # @running: guest is actively running
148 # @save-vm: guest is paused to save the VM state
150 # @shutdown: guest is shut down (and -no-shutdown is in use)
152 # @suspended: guest is suspended (ACPI S3)
154 # @watchdog: the watchdog action is configured to pause and has been triggered
156 # @guest-panicked: guest has been panicked as a result of guest OS panic
158 { 'enum': 'RunState',
159   'data': [ 'debug', 'inmigrate', 'internal-error', 'io-error', 'paused',
160             'postmigrate', 'prelaunch', 'finish-migrate', 'restore-vm',
161             'running', 'save-vm', 'shutdown', 'suspended', 'watchdog',
162             'guest-panicked' ] }
165 # @StatusInfo:
167 # Information about VCPU run state
169 # @running: true if all VCPUs are runnable, false if not runnable
171 # @singlestep: true if VCPUs are in single-step mode
173 # @status: the virtual machine @RunState
175 # Since:  0.14.0
177 # Notes: @singlestep is enabled through the GDB stub
179 { 'struct': 'StatusInfo',
180   'data': {'running': 'bool', 'singlestep': 'bool', 'status': 'RunState'} }
183 # @query-status:
185 # Query the run status of all VCPUs
187 # Returns: @StatusInfo reflecting all VCPUs
189 # Since:  0.14.0
191 { 'command': 'query-status', 'returns': 'StatusInfo' }
194 # @UuidInfo:
196 # Guest UUID information.
198 # @UUID: the UUID of the guest
200 # Since: 0.14.0
202 # Notes: If no UUID was specified for the guest, a null UUID is returned.
204 { 'struct': 'UuidInfo', 'data': {'UUID': 'str'} }
207 # @query-uuid:
209 # Query the guest UUID information.
211 # Returns: The @UuidInfo for the guest
213 # Since 0.14.0
215 { 'command': 'query-uuid', 'returns': 'UuidInfo' }
218 # @ChardevInfo:
220 # Information about a character device.
222 # @label: the label of the character device
224 # @filename: the filename of the character device
226 # @frontend-open: shows whether the frontend device attached to this backend
227 #                 (eg. with the chardev=... option) is in open or closed state
228 #                 (since 2.1)
230 # Notes: @filename is encoded using the QEMU command line character device
231 #        encoding.  See the QEMU man page for details.
233 # Since: 0.14.0
235 { 'struct': 'ChardevInfo', 'data': {'label': 'str',
236                                   'filename': 'str',
237                                   'frontend-open': 'bool'} }
240 # @query-chardev:
242 # Returns information about current character devices.
244 # Returns: a list of @ChardevInfo
246 # Since: 0.14.0
248 { 'command': 'query-chardev', 'returns': ['ChardevInfo'] }
251 # @ChardevBackendInfo:
253 # Information about a character device backend
255 # @name: The backend name
257 # Since: 2.0
259 { 'struct': 'ChardevBackendInfo', 'data': {'name': 'str'} }
262 # @query-chardev-backends:
264 # Returns information about character device backends.
266 # Returns: a list of @ChardevBackendInfo
268 # Since: 2.0
270 { 'command': 'query-chardev-backends', 'returns': ['ChardevBackendInfo'] }
273 # @DataFormat:
275 # An enumeration of data format.
277 # @utf8: Data is a UTF-8 string (RFC 3629)
279 # @base64: Data is Base64 encoded binary (RFC 3548)
281 # Since: 1.4
283 { 'enum': 'DataFormat',
284   'data': [ 'utf8', 'base64' ] }
287 # @ringbuf-write:
289 # Write to a ring buffer character device.
291 # @device: the ring buffer character device name
293 # @data: data to write
295 # @format: #optional data encoding (default 'utf8').
296 #          - base64: data must be base64 encoded text.  Its binary
297 #            decoding gets written.
298 #          - utf8: data's UTF-8 encoding is written
299 #          - data itself is always Unicode regardless of format, like
300 #            any other string.
302 # Returns: Nothing on success
304 # Since: 1.4
306 { 'command': 'ringbuf-write',
307   'data': {'device': 'str', 'data': 'str',
308            '*format': 'DataFormat'} }
311 # @ringbuf-read:
313 # Read from a ring buffer character device.
315 # @device: the ring buffer character device name
317 # @size: how many bytes to read at most
319 # @format: #optional data encoding (default 'utf8').
320 #          - base64: the data read is returned in base64 encoding.
321 #          - utf8: the data read is interpreted as UTF-8.
322 #            Bug: can screw up when the buffer contains invalid UTF-8
323 #            sequences, NUL characters, after the ring buffer lost
324 #            data, and when reading stops because the size limit is
325 #            reached.
326 #          - The return value is always Unicode regardless of format,
327 #            like any other string.
329 # Returns: data read from the device
331 # Since: 1.4
333 { 'command': 'ringbuf-read',
334   'data': {'device': 'str', 'size': 'int', '*format': 'DataFormat'},
335   'returns': 'str' }
338 # @EventInfo:
340 # Information about a QMP event
342 # @name: The event name
344 # Since: 1.2.0
346 { 'struct': 'EventInfo', 'data': {'name': 'str'} }
349 # @query-events:
351 # Return a list of supported QMP events by this server
353 # Returns: A list of @EventInfo for all supported events
355 # Since: 1.2.0
357 { 'command': 'query-events', 'returns': ['EventInfo'] }
360 # @MigrationStats
362 # Detailed migration status.
364 # @transferred: amount of bytes already transferred to the target VM
366 # @remaining: amount of bytes remaining to be transferred to the target VM
368 # @total: total amount of bytes involved in the migration process
370 # @duplicate: number of duplicate (zero) pages (since 1.2)
372 # @skipped: number of skipped zero pages (since 1.5)
374 # @normal : number of normal pages (since 1.2)
376 # @normal-bytes: number of normal bytes sent (since 1.2)
378 # @dirty-pages-rate: number of pages dirtied by second by the
379 #        guest (since 1.3)
381 # @mbps: throughput in megabits/sec. (since 1.6)
383 # @dirty-sync-count: number of times that dirty ram was synchronized (since 2.1)
385 # Since: 0.14.0
387 { 'struct': 'MigrationStats',
388   'data': {'transferred': 'int', 'remaining': 'int', 'total': 'int' ,
389            'duplicate': 'int', 'skipped': 'int', 'normal': 'int',
390            'normal-bytes': 'int', 'dirty-pages-rate' : 'int',
391            'mbps' : 'number', 'dirty-sync-count' : 'int' } }
394 # @XBZRLECacheStats
396 # Detailed XBZRLE migration cache statistics
398 # @cache-size: XBZRLE cache size
400 # @bytes: amount of bytes already transferred to the target VM
402 # @pages: amount of pages transferred to the target VM
404 # @cache-miss: number of cache miss
406 # @cache-miss-rate: rate of cache miss (since 2.1)
408 # @overflow: number of overflows
410 # Since: 1.2
412 { 'struct': 'XBZRLECacheStats',
413   'data': {'cache-size': 'int', 'bytes': 'int', 'pages': 'int',
414            'cache-miss': 'int', 'cache-miss-rate': 'number',
415            'overflow': 'int' } }
417 # @MigrationStatus:
419 # An enumeration of migration status.
421 # @none: no migration has ever happened.
423 # @setup: migration process has been initiated.
425 # @cancelling: in the process of cancelling migration.
427 # @cancelled: cancelling migration is finished.
429 # @active: in the process of doing migration.
431 # @postcopy-active: like active, but now in postcopy mode. (since 2.5)
433 # @completed: migration is finished.
435 # @failed: some error occurred during migration process.
437 # Since: 2.3
440 { 'enum': 'MigrationStatus',
441   'data': [ 'none', 'setup', 'cancelling', 'cancelled',
442             'active', 'postcopy-active', 'completed', 'failed' ] }
445 # @MigrationInfo
447 # Information about current migration process.
449 # @status: #optional @MigrationStatus describing the current migration status.
450 #          If this field is not returned, no migration process
451 #          has been initiated
453 # @ram: #optional @MigrationStats containing detailed migration
454 #       status, only returned if status is 'active' or
455 #       'completed'(since 1.2)
457 # @disk: #optional @MigrationStats containing detailed disk migration
458 #        status, only returned if status is 'active' and it is a block
459 #        migration
461 # @xbzrle-cache: #optional @XBZRLECacheStats containing detailed XBZRLE
462 #                migration statistics, only returned if XBZRLE feature is on and
463 #                status is 'active' or 'completed' (since 1.2)
465 # @total-time: #optional total amount of milliseconds since migration started.
466 #        If migration has ended, it returns the total migration
467 #        time. (since 1.2)
469 # @downtime: #optional only present when migration finishes correctly
470 #        total downtime in milliseconds for the guest.
471 #        (since 1.3)
473 # @expected-downtime: #optional only present while migration is active
474 #        expected downtime in milliseconds for the guest in last walk
475 #        of the dirty bitmap. (since 1.3)
477 # @setup-time: #optional amount of setup time in milliseconds _before_ the
478 #        iterations begin but _after_ the QMP command is issued. This is designed
479 #        to provide an accounting of any activities (such as RDMA pinning) which
480 #        may be expensive, but do not actually occur during the iterative
481 #        migration rounds themselves. (since 1.6)
483 # @x-cpu-throttle-percentage: #optional percentage of time guest cpus are being
484 #       throttled during auto-converge. This is only present when auto-converge
485 #       has started throttling guest cpus. (Since 2.5)
487 # Since: 0.14.0
489 { 'struct': 'MigrationInfo',
490   'data': {'*status': 'MigrationStatus', '*ram': 'MigrationStats',
491            '*disk': 'MigrationStats',
492            '*xbzrle-cache': 'XBZRLECacheStats',
493            '*total-time': 'int',
494            '*expected-downtime': 'int',
495            '*downtime': 'int',
496            '*setup-time': 'int',
497            '*x-cpu-throttle-percentage': 'int'} }
500 # @query-migrate
502 # Returns information about current migration process.
504 # Returns: @MigrationInfo
506 # Since: 0.14.0
508 { 'command': 'query-migrate', 'returns': 'MigrationInfo' }
511 # @MigrationCapability
513 # Migration capabilities enumeration
515 # @xbzrle: Migration supports xbzrle (Xor Based Zero Run Length Encoding).
516 #          This feature allows us to minimize migration traffic for certain work
517 #          loads, by sending compressed difference of the pages
519 # @rdma-pin-all: Controls whether or not the entire VM memory footprint is
520 #          mlock()'d on demand or all at once. Refer to docs/rdma.txt for usage.
521 #          Disabled by default. (since 2.0)
523 # @zero-blocks: During storage migration encode blocks of zeroes efficiently. This
524 #          essentially saves 1MB of zeroes per block on the wire. Enabling requires
525 #          source and target VM to support this feature. To enable it is sufficient
526 #          to enable the capability on the source VM. The feature is disabled by
527 #          default. (since 1.6)
529 # @compress: Use multiple compression threads to accelerate live migration.
530 #          This feature can help to reduce the migration traffic, by sending
531 #          compressed pages. Please note that if compress and xbzrle are both
532 #          on, compress only takes effect in the ram bulk stage, after that,
533 #          it will be disabled and only xbzrle takes effect, this can help to
534 #          minimize migration traffic. The feature is disabled by default.
535 #          (since 2.4 )
537 # @events: generate events for each migration state change
538 #          (since 2.4 )
540 # @auto-converge: If enabled, QEMU will automatically throttle down the guest
541 #          to speed up convergence of RAM migration. (since 1.6)
543 # @x-postcopy-ram: Start executing on the migration target before all of RAM has
544 #          been migrated, pulling the remaining pages along as needed. NOTE: If
545 #          the migration fails during postcopy the VM will fail.  (since 2.5)
547 # Since: 1.2
549 { 'enum': 'MigrationCapability',
550   'data': ['xbzrle', 'rdma-pin-all', 'auto-converge', 'zero-blocks',
551            'compress', 'events', 'x-postcopy-ram'] }
554 # @MigrationCapabilityStatus
556 # Migration capability information
558 # @capability: capability enum
560 # @state: capability state bool
562 # Since: 1.2
564 { 'struct': 'MigrationCapabilityStatus',
565   'data': { 'capability' : 'MigrationCapability', 'state' : 'bool' } }
568 # @migrate-set-capabilities
570 # Enable/Disable the following migration capabilities (like xbzrle)
572 # @capabilities: json array of capability modifications to make
574 # Since: 1.2
576 { 'command': 'migrate-set-capabilities',
577   'data': { 'capabilities': ['MigrationCapabilityStatus'] } }
580 # @query-migrate-capabilities
582 # Returns information about the current migration capabilities status
584 # Returns: @MigrationCapabilitiesStatus
586 # Since: 1.2
588 { 'command': 'query-migrate-capabilities', 'returns':   ['MigrationCapabilityStatus']}
590 # @MigrationParameter
592 # Migration parameters enumeration
594 # @compress-level: Set the compression level to be used in live migration,
595 #          the compression level is an integer between 0 and 9, where 0 means
596 #          no compression, 1 means the best compression speed, and 9 means best
597 #          compression ratio which will consume more CPU.
599 # @compress-threads: Set compression thread count to be used in live migration,
600 #          the compression thread count is an integer between 1 and 255.
602 # @decompress-threads: Set decompression thread count to be used in live
603 #          migration, the decompression thread count is an integer between 1
604 #          and 255. Usually, decompression is at least 4 times as fast as
605 #          compression, so set the decompress-threads to the number about 1/4
606 #          of compress-threads is adequate.
608 # @x-cpu-throttle-initial: Initial percentage of time guest cpus are throttled
609 #                          when migration auto-converge is activated. The
610 #                          default value is 20. (Since 2.5)
612 # @x-cpu-throttle-increment: throttle percentage increase each time
613 #                            auto-converge detects that migration is not making
614 #                            progress. The default value is 10. (Since 2.5)
615 # Since: 2.4
617 { 'enum': 'MigrationParameter',
618   'data': ['compress-level', 'compress-threads', 'decompress-threads',
619            'x-cpu-throttle-initial', 'x-cpu-throttle-increment'] }
622 # @migrate-set-parameters
624 # Set the following migration parameters
626 # @compress-level: compression level
628 # @compress-threads: compression thread count
630 # @decompress-threads: decompression thread count
632 # @x-cpu-throttle-initial: Initial percentage of time guest cpus are throttled
633 #                          when migration auto-converge is activated. The
634 #                          default value is 20. (Since 2.5)
636 # @x-cpu-throttle-increment: throttle percentage increase each time
637 #                            auto-converge detects that migration is not making
638 #                            progress. The default value is 10. (Since 2.5)
639 # Since: 2.4
641 { 'command': 'migrate-set-parameters',
642   'data': { '*compress-level': 'int',
643             '*compress-threads': 'int',
644             '*decompress-threads': 'int',
645             '*x-cpu-throttle-initial': 'int',
646             '*x-cpu-throttle-increment': 'int'} }
649 # @MigrationParameters
651 # @compress-level: compression level
653 # @compress-threads: compression thread count
655 # @decompress-threads: decompression thread count
657 # @x-cpu-throttle-initial: Initial percentage of time guest cpus are throttled
658 #                          when migration auto-converge is activated. The
659 #                          default value is 20. (Since 2.5)
661 # @x-cpu-throttle-increment: throttle percentage increase each time
662 #                            auto-converge detects that migration is not making
663 #                            progress. The default value is 10. (Since 2.5)
665 # Since: 2.4
667 { 'struct': 'MigrationParameters',
668   'data': { 'compress-level': 'int',
669             'compress-threads': 'int',
670             'decompress-threads': 'int',
671             'x-cpu-throttle-initial': 'int',
672             'x-cpu-throttle-increment': 'int'} }
674 # @query-migrate-parameters
676 # Returns information about the current migration parameters
678 # Returns: @MigrationParameters
680 # Since: 2.4
682 { 'command': 'query-migrate-parameters',
683   'returns': 'MigrationParameters' }
686 # @client_migrate_info
688 # Set migration information for remote display.  This makes the server
689 # ask the client to automatically reconnect using the new parameters
690 # once migration finished successfully.  Only implemented for SPICE.
692 # @protocol:     must be "spice"
693 # @hostname:     migration target hostname
694 # @port:         #optional spice tcp port for plaintext channels
695 # @tls-port:     #optional spice tcp port for tls-secured channels
696 # @cert-subject: #optional server certificate subject
698 # Since: 0.14.0
700 { 'command': 'client_migrate_info',
701   'data': { 'protocol': 'str', 'hostname': 'str', '*port': 'int',
702             '*tls-port': 'int', '*cert-subject': 'str' } }
705 # @migrate-start-postcopy
707 # Followup to a migration command to switch the migration to postcopy mode.
708 # The x-postcopy-ram capability must be set before the original migration
709 # command.
711 # Since: 2.5
712 { 'command': 'migrate-start-postcopy' }
715 # @MouseInfo:
717 # Information about a mouse device.
719 # @name: the name of the mouse device
721 # @index: the index of the mouse device
723 # @current: true if this device is currently receiving mouse events
725 # @absolute: true if this device supports absolute coordinates as input
727 # Since: 0.14.0
729 { 'struct': 'MouseInfo',
730   'data': {'name': 'str', 'index': 'int', 'current': 'bool',
731            'absolute': 'bool'} }
734 # @query-mice:
736 # Returns information about each active mouse device
738 # Returns: a list of @MouseInfo for each device
740 # Since: 0.14.0
742 { 'command': 'query-mice', 'returns': ['MouseInfo'] }
745 # @CpuInfoArch:
747 # An enumeration of cpu types that enable additional information during
748 # @query-cpus.
750 # Since: 2.6
752 { 'enum': 'CpuInfoArch',
753   'data': ['x86', 'sparc', 'ppc', 'mips', 'tricore', 'other' ] }
756 # @CpuInfoBase:
758 # Common information about a virtual CPU
760 # @CPU: the index of the virtual CPU
762 # @current: this only exists for backwards compatibility and should be ignored
764 # @halted: true if the virtual CPU is in the halt state.  Halt usually refers
765 #          to a processor specific low power mode.
767 # @qom_path: path to the CPU object in the QOM tree (since 2.4)
769 # @thread_id: ID of the underlying host thread
771 # @arch: architecture of the cpu, which determines which additional fields
772 #        will be listed (since 2.6)
774 # Since: 0.14.0
776 # Notes: @halted is a transient state that changes frequently.  By the time the
777 #        data is sent to the client, the guest may no longer be halted.
779 { 'struct': 'CpuInfoBase',
780   'data': {'CPU': 'int', 'current': 'bool', 'halted': 'bool',
781            'qom_path': 'str', 'thread_id': 'int', 'arch': 'CpuInfoArch' } }
784 # @CpuInfo:
786 # Information about a virtual CPU
788 # Since: 0.14.0
790 { 'union': 'CpuInfo', 'base': 'CpuInfoBase', 'discriminator': 'arch',
791   'data': { 'x86': 'CpuInfoX86',
792             'sparc': 'CpuInfoSPARC',
793             'ppc': 'CpuInfoPPC',
794             'mips': 'CpuInfoMIPS',
795             'tricore': 'CpuInfoTricore',
796             'other': 'CpuInfoOther' } }
799 # @CpuInfoX86:
801 # Additional information about a virtual i386 or x86_64 CPU
803 # @pc: the 64-bit instruction pointer
805 # Since 2.6
807 { 'struct': 'CpuInfoX86', 'data': { 'pc': 'int' } }
810 # @CpuInfoSPARC:
812 # Additional information about a virtual SPARC CPU
814 # @pc: the PC component of the instruction pointer
816 # @npc: the NPC component of the instruction pointer
818 # Since 2.6
820 { 'struct': 'CpuInfoSPARC', 'data': { 'pc': 'int', 'npc': 'int' } }
823 # @CpuInfoPPC:
825 # Additional information about a virtual PPC CPU
827 # @nip: the instruction pointer
829 # Since 2.6
831 { 'struct': 'CpuInfoPPC', 'data': { 'nip': 'int' } }
834 # @CpuInfoMIPS:
836 # Additional information about a virtual MIPS CPU
838 # @PC: the instruction pointer
840 # Since 2.6
842 { 'struct': 'CpuInfoMIPS', 'data': { 'PC': 'int' } }
845 # @CpuInfoTricore:
847 # Additional information about a virtual Tricore CPU
849 # @PC: the instruction pointer
851 # Since 2.6
853 { 'struct': 'CpuInfoTricore', 'data': { 'PC': 'int' } }
856 # @CpuInfoOther:
858 # No additional information is available about the virtual CPU
860 # Since 2.6
863 { 'struct': 'CpuInfoOther', 'data': { } }
866 # @query-cpus:
868 # Returns a list of information about each virtual CPU.
870 # Returns: a list of @CpuInfo for each virtual CPU
872 # Since: 0.14.0
874 { 'command': 'query-cpus', 'returns': ['CpuInfo'] }
877 # @IOThreadInfo:
879 # Information about an iothread
881 # @id: the identifier of the iothread
883 # @thread-id: ID of the underlying host thread
885 # Since: 2.0
887 { 'struct': 'IOThreadInfo',
888   'data': {'id': 'str', 'thread-id': 'int'} }
891 # @query-iothreads:
893 # Returns a list of information about each iothread.
895 # Note this list excludes the QEMU main loop thread, which is not declared
896 # using the -object iothread command-line option.  It is always the main thread
897 # of the process.
899 # Returns: a list of @IOThreadInfo for each iothread
901 # Since: 2.0
903 { 'command': 'query-iothreads', 'returns': ['IOThreadInfo'] }
906 # @NetworkAddressFamily
908 # The network address family
910 # @ipv4: IPV4 family
912 # @ipv6: IPV6 family
914 # @unix: unix socket
916 # @unknown: otherwise
918 # Since: 2.1
920 { 'enum': 'NetworkAddressFamily',
921   'data': [ 'ipv4', 'ipv6', 'unix', 'unknown' ] }
924 # @VncBasicInfo
926 # The basic information for vnc network connection
928 # @host: IP address
930 # @service: The service name of the vnc port. This may depend on the host
931 #           system's service database so symbolic names should not be relied
932 #           on.
934 # @family: address family
936 # @websocket: true in case the socket is a websocket (since 2.3).
938 # Since: 2.1
940 { 'struct': 'VncBasicInfo',
941   'data': { 'host': 'str',
942             'service': 'str',
943             'family': 'NetworkAddressFamily',
944             'websocket': 'bool' } }
947 # @VncServerInfo
949 # The network connection information for server
951 # @auth: #optional, authentication method
953 # Since: 2.1
955 { 'struct': 'VncServerInfo',
956   'base': 'VncBasicInfo',
957   'data': { '*auth': 'str' } }
960 # @VncClientInfo:
962 # Information about a connected VNC client.
964 # @x509_dname: #optional If x509 authentication is in use, the Distinguished
965 #              Name of the client.
967 # @sasl_username: #optional If SASL authentication is in use, the SASL username
968 #                 used for authentication.
970 # Since: 0.14.0
972 { 'struct': 'VncClientInfo',
973   'base': 'VncBasicInfo',
974   'data': { '*x509_dname': 'str', '*sasl_username': 'str' } }
977 # @VncInfo:
979 # Information about the VNC session.
981 # @enabled: true if the VNC server is enabled, false otherwise
983 # @host: #optional The hostname the VNC server is bound to.  This depends on
984 #        the name resolution on the host and may be an IP address.
986 # @family: #optional 'ipv6' if the host is listening for IPv6 connections
987 #                    'ipv4' if the host is listening for IPv4 connections
988 #                    'unix' if the host is listening on a unix domain socket
989 #                    'unknown' otherwise
991 # @service: #optional The service name of the server's port.  This may depends
992 #           on the host system's service database so symbolic names should not
993 #           be relied on.
995 # @auth: #optional the current authentication type used by the server
996 #        'none' if no authentication is being used
997 #        'vnc' if VNC authentication is being used
998 #        'vencrypt+plain' if VEncrypt is used with plain text authentication
999 #        'vencrypt+tls+none' if VEncrypt is used with TLS and no authentication
1000 #        'vencrypt+tls+vnc' if VEncrypt is used with TLS and VNC authentication
1001 #        'vencrypt+tls+plain' if VEncrypt is used with TLS and plain text auth
1002 #        'vencrypt+x509+none' if VEncrypt is used with x509 and no auth
1003 #        'vencrypt+x509+vnc' if VEncrypt is used with x509 and VNC auth
1004 #        'vencrypt+x509+plain' if VEncrypt is used with x509 and plain text auth
1005 #        'vencrypt+tls+sasl' if VEncrypt is used with TLS and SASL auth
1006 #        'vencrypt+x509+sasl' if VEncrypt is used with x509 and SASL auth
1008 # @clients: a list of @VncClientInfo of all currently connected clients
1010 # Since: 0.14.0
1012 { 'struct': 'VncInfo',
1013   'data': {'enabled': 'bool', '*host': 'str',
1014            '*family': 'NetworkAddressFamily',
1015            '*service': 'str', '*auth': 'str', '*clients': ['VncClientInfo']} }
1018 # @VncPriAuth:
1020 # vnc primary authentication method.
1022 # Since: 2.3
1024 { 'enum': 'VncPrimaryAuth',
1025   'data': [ 'none', 'vnc', 'ra2', 'ra2ne', 'tight', 'ultra',
1026             'tls', 'vencrypt', 'sasl' ] }
1029 # @VncVencryptSubAuth:
1031 # vnc sub authentication method with vencrypt.
1033 # Since: 2.3
1035 { 'enum': 'VncVencryptSubAuth',
1036   'data': [ 'plain',
1037             'tls-none',  'x509-none',
1038             'tls-vnc',   'x509-vnc',
1039             'tls-plain', 'x509-plain',
1040             'tls-sasl',  'x509-sasl' ] }
1043 # @VncInfo2:
1045 # Information about a vnc server
1047 # @id: vnc server name.
1049 # @server: A list of @VncBasincInfo describing all listening sockets.
1050 #          The list can be empty (in case the vnc server is disabled).
1051 #          It also may have multiple entries: normal + websocket,
1052 #          possibly also ipv4 + ipv6 in the future.
1054 # @clients: A list of @VncClientInfo of all currently connected clients.
1055 #           The list can be empty, for obvious reasons.
1057 # @auth: The current authentication type used by the server
1059 # @vencrypt: #optional The vencrypt sub authentication type used by the server,
1060 #            only specified in case auth == vencrypt.
1062 # @display: #optional The display device the vnc server is linked to.
1064 # Since: 2.3
1066 { 'struct': 'VncInfo2',
1067   'data': { 'id'        : 'str',
1068             'server'    : ['VncBasicInfo'],
1069             'clients'   : ['VncClientInfo'],
1070             'auth'      : 'VncPrimaryAuth',
1071             '*vencrypt' : 'VncVencryptSubAuth',
1072             '*display'  : 'str' } }
1075 # @query-vnc:
1077 # Returns information about the current VNC server
1079 # Returns: @VncInfo
1081 # Since: 0.14.0
1083 { 'command': 'query-vnc', 'returns': 'VncInfo' }
1086 # @query-vnc-servers:
1088 # Returns a list of vnc servers.  The list can be empty.
1090 # Returns: a list of @VncInfo2
1092 # Since: 2.3
1094 { 'command': 'query-vnc-servers', 'returns': ['VncInfo2'] }
1097 # @SpiceBasicInfo
1099 # The basic information for SPICE network connection
1101 # @host: IP address
1103 # @port: port number
1105 # @family: address family
1107 # Since: 2.1
1109 { 'struct': 'SpiceBasicInfo',
1110   'data': { 'host': 'str',
1111             'port': 'str',
1112             'family': 'NetworkAddressFamily' } }
1115 # @SpiceServerInfo
1117 # Information about a SPICE server
1119 # @auth: #optional, authentication method
1121 # Since: 2.1
1123 { 'struct': 'SpiceServerInfo',
1124   'base': 'SpiceBasicInfo',
1125   'data': { '*auth': 'str' } }
1128 # @SpiceChannel
1130 # Information about a SPICE client channel.
1132 # @connection-id: SPICE connection id number.  All channels with the same id
1133 #                 belong to the same SPICE session.
1135 # @channel-type: SPICE channel type number.  "1" is the main control
1136 #                channel, filter for this one if you want to track spice
1137 #                sessions only
1139 # @channel-id: SPICE channel ID number.  Usually "0", might be different when
1140 #              multiple channels of the same type exist, such as multiple
1141 #              display channels in a multihead setup
1143 # @tls: true if the channel is encrypted, false otherwise.
1145 # Since: 0.14.0
1147 { 'struct': 'SpiceChannel',
1148   'base': 'SpiceBasicInfo',
1149   'data': {'connection-id': 'int', 'channel-type': 'int', 'channel-id': 'int',
1150            'tls': 'bool'} }
1153 # @SpiceQueryMouseMode
1155 # An enumeration of Spice mouse states.
1157 # @client: Mouse cursor position is determined by the client.
1159 # @server: Mouse cursor position is determined by the server.
1161 # @unknown: No information is available about mouse mode used by
1162 #           the spice server.
1164 # Note: spice/enums.h has a SpiceMouseMode already, hence the name.
1166 # Since: 1.1
1168 { 'enum': 'SpiceQueryMouseMode',
1169   'data': [ 'client', 'server', 'unknown' ] }
1172 # @SpiceInfo
1174 # Information about the SPICE session.
1176 # @enabled: true if the SPICE server is enabled, false otherwise
1178 # @migrated: true if the last guest migration completed and spice
1179 #            migration had completed as well. false otherwise.
1181 # @host: #optional The hostname the SPICE server is bound to.  This depends on
1182 #        the name resolution on the host and may be an IP address.
1184 # @port: #optional The SPICE server's port number.
1186 # @compiled-version: #optional SPICE server version.
1188 # @tls-port: #optional The SPICE server's TLS port number.
1190 # @auth: #optional the current authentication type used by the server
1191 #        'none'  if no authentication is being used
1192 #        'spice' uses SASL or direct TLS authentication, depending on command
1193 #                line options
1195 # @mouse-mode: The mode in which the mouse cursor is displayed currently. Can
1196 #              be determined by the client or the server, or unknown if spice
1197 #              server doesn't provide this information.
1199 #              Since: 1.1
1201 # @channels: a list of @SpiceChannel for each active spice channel
1203 # Since: 0.14.0
1205 { 'struct': 'SpiceInfo',
1206   'data': {'enabled': 'bool', 'migrated': 'bool', '*host': 'str', '*port': 'int',
1207            '*tls-port': 'int', '*auth': 'str', '*compiled-version': 'str',
1208            'mouse-mode': 'SpiceQueryMouseMode', '*channels': ['SpiceChannel']} }
1211 # @query-spice
1213 # Returns information about the current SPICE server
1215 # Returns: @SpiceInfo
1217 # Since: 0.14.0
1219 { 'command': 'query-spice', 'returns': 'SpiceInfo' }
1222 # @BalloonInfo:
1224 # Information about the guest balloon device.
1226 # @actual: the number of bytes the balloon currently contains
1228 # Since: 0.14.0
1231 { 'struct': 'BalloonInfo', 'data': {'actual': 'int' } }
1234 # @query-balloon:
1236 # Return information about the balloon device.
1238 # Returns: @BalloonInfo on success
1239 #          If the balloon driver is enabled but not functional because the KVM
1240 #          kernel module cannot support it, KvmMissingCap
1241 #          If no balloon device is present, DeviceNotActive
1243 # Since: 0.14.0
1245 { 'command': 'query-balloon', 'returns': 'BalloonInfo' }
1248 # @PciMemoryRange:
1250 # A PCI device memory region
1252 # @base: the starting address (guest physical)
1254 # @limit: the ending address (guest physical)
1256 # Since: 0.14.0
1258 { 'struct': 'PciMemoryRange', 'data': {'base': 'int', 'limit': 'int'} }
1261 # @PciMemoryRegion
1263 # Information about a PCI device I/O region.
1265 # @bar: the index of the Base Address Register for this region
1267 # @type: 'io' if the region is a PIO region
1268 #        'memory' if the region is a MMIO region
1270 # @prefetch: #optional if @type is 'memory', true if the memory is prefetchable
1272 # @mem_type_64: #optional if @type is 'memory', true if the BAR is 64-bit
1274 # Since: 0.14.0
1276 { 'struct': 'PciMemoryRegion',
1277   'data': {'bar': 'int', 'type': 'str', 'address': 'int', 'size': 'int',
1278            '*prefetch': 'bool', '*mem_type_64': 'bool' } }
1281 # @PciBusInfo:
1283 # Information about a bus of a PCI Bridge device
1285 # @number: primary bus interface number.  This should be the number of the
1286 #          bus the device resides on.
1288 # @secondary: secondary bus interface number.  This is the number of the
1289 #             main bus for the bridge
1291 # @subordinate: This is the highest number bus that resides below the
1292 #               bridge.
1294 # @io_range: The PIO range for all devices on this bridge
1296 # @memory_range: The MMIO range for all devices on this bridge
1298 # @prefetchable_range: The range of prefetchable MMIO for all devices on
1299 #                      this bridge
1301 # Since: 2.4
1303 { 'struct': 'PciBusInfo',
1304   'data': {'number': 'int', 'secondary': 'int', 'subordinate': 'int',
1305            'io_range': 'PciMemoryRange',
1306            'memory_range': 'PciMemoryRange',
1307            'prefetchable_range': 'PciMemoryRange' } }
1310 # @PciBridgeInfo:
1312 # Information about a PCI Bridge device
1314 # @bus: information about the bus the device resides on
1316 # @devices: a list of @PciDeviceInfo for each device on this bridge
1318 # Since: 0.14.0
1320 { 'struct': 'PciBridgeInfo',
1321   'data': {'bus': 'PciBusInfo', '*devices': ['PciDeviceInfo']} }
1324 # @PciDeviceClass:
1326 # Information about the Class of a PCI device
1328 # @desc: #optional a string description of the device's class
1330 # @class: the class code of the device
1332 # Since: 2.4
1334 { 'struct': 'PciDeviceClass',
1335   'data': {'*desc': 'str', 'class': 'int'} }
1338 # @PciDeviceId:
1340 # Information about the Id of a PCI device
1342 # @device: the PCI device id
1344 # @vendor: the PCI vendor id
1346 # Since: 2.4
1348 { 'struct': 'PciDeviceId',
1349   'data': {'device': 'int', 'vendor': 'int'} }
1352 # @PciDeviceInfo:
1354 # Information about a PCI device
1356 # @bus: the bus number of the device
1358 # @slot: the slot the device is located in
1360 # @function: the function of the slot used by the device
1362 # @class_info: the class of the device
1364 # @id: the PCI device id
1366 # @irq: #optional if an IRQ is assigned to the device, the IRQ number
1368 # @qdev_id: the device name of the PCI device
1370 # @pci_bridge: if the device is a PCI bridge, the bridge information
1372 # @regions: a list of the PCI I/O regions associated with the device
1374 # Notes: the contents of @class_info.desc are not stable and should only be
1375 #        treated as informational.
1377 # Since: 0.14.0
1379 { 'struct': 'PciDeviceInfo',
1380   'data': {'bus': 'int', 'slot': 'int', 'function': 'int',
1381            'class_info': 'PciDeviceClass', 'id': 'PciDeviceId',
1382            '*irq': 'int', 'qdev_id': 'str', '*pci_bridge': 'PciBridgeInfo',
1383            'regions': ['PciMemoryRegion']} }
1386 # @PciInfo:
1388 # Information about a PCI bus
1390 # @bus: the bus index
1392 # @devices: a list of devices on this bus
1394 # Since: 0.14.0
1396 { 'struct': 'PciInfo', 'data': {'bus': 'int', 'devices': ['PciDeviceInfo']} }
1399 # @query-pci:
1401 # Return information about the PCI bus topology of the guest.
1403 # Returns: a list of @PciInfo for each PCI bus
1405 # Since: 0.14.0
1407 { 'command': 'query-pci', 'returns': ['PciInfo'] }
1410 # @quit:
1412 # This command will cause the QEMU process to exit gracefully.  While every
1413 # attempt is made to send the QMP response before terminating, this is not
1414 # guaranteed.  When using this interface, a premature EOF would not be
1415 # unexpected.
1417 # Since: 0.14.0
1419 { 'command': 'quit' }
1422 # @stop:
1424 # Stop all guest VCPU execution.
1426 # Since:  0.14.0
1428 # Notes:  This function will succeed even if the guest is already in the stopped
1429 #         state.  In "inmigrate" state, it will ensure that the guest
1430 #         remains paused once migration finishes, as if the -S option was
1431 #         passed on the command line.
1433 { 'command': 'stop' }
1436 # @system_reset:
1438 # Performs a hard reset of a guest.
1440 # Since: 0.14.0
1442 { 'command': 'system_reset' }
1445 # @system_powerdown:
1447 # Requests that a guest perform a powerdown operation.
1449 # Since: 0.14.0
1451 # Notes: A guest may or may not respond to this command.  This command
1452 #        returning does not indicate that a guest has accepted the request or
1453 #        that it has shut down.  Many guests will respond to this command by
1454 #        prompting the user in some way.
1456 { 'command': 'system_powerdown' }
1459 # @cpu:
1461 # This command is a nop that is only provided for the purposes of compatibility.
1463 # Since: 0.14.0
1465 # Notes: Do not use this command.
1467 { 'command': 'cpu', 'data': {'index': 'int'} }
1470 # @cpu-add
1472 # Adds CPU with specified ID
1474 # @id: ID of CPU to be created, valid values [0..max_cpus)
1476 # Returns: Nothing on success
1478 # Since 1.5
1480 { 'command': 'cpu-add', 'data': {'id': 'int'} }
1483 # @memsave:
1485 # Save a portion of guest memory to a file.
1487 # @val: the virtual address of the guest to start from
1489 # @size: the size of memory region to save
1491 # @filename: the file to save the memory to as binary data
1493 # @cpu-index: #optional the index of the virtual CPU to use for translating the
1494 #                       virtual address (defaults to CPU 0)
1496 # Returns: Nothing on success
1498 # Since: 0.14.0
1500 # Notes: Errors were not reliably returned until 1.1
1502 { 'command': 'memsave',
1503   'data': {'val': 'int', 'size': 'int', 'filename': 'str', '*cpu-index': 'int'} }
1506 # @pmemsave:
1508 # Save a portion of guest physical memory to a file.
1510 # @val: the physical address of the guest to start from
1512 # @size: the size of memory region to save
1514 # @filename: the file to save the memory to as binary data
1516 # Returns: Nothing on success
1518 # Since: 0.14.0
1520 # Notes: Errors were not reliably returned until 1.1
1522 { 'command': 'pmemsave',
1523   'data': {'val': 'int', 'size': 'int', 'filename': 'str'} }
1526 # @cont:
1528 # Resume guest VCPU execution.
1530 # Since:  0.14.0
1532 # Returns:  If successful, nothing
1533 #           If QEMU was started with an encrypted block device and a key has
1534 #              not yet been set, DeviceEncrypted.
1536 # Notes:  This command will succeed if the guest is currently running.  It
1537 #         will also succeed if the guest is in the "inmigrate" state; in
1538 #         this case, the effect of the command is to make sure the guest
1539 #         starts once migration finishes, removing the effect of the -S
1540 #         command line option if it was passed.
1542 { 'command': 'cont' }
1545 # @system_wakeup:
1547 # Wakeup guest from suspend.  Does nothing in case the guest isn't suspended.
1549 # Since:  1.1
1551 # Returns:  nothing.
1553 { 'command': 'system_wakeup' }
1556 # @inject-nmi:
1558 # Injects a Non-Maskable Interrupt into the default CPU (x86/s390) or all CPUs (ppc64).
1560 # Returns:  If successful, nothing
1562 # Since:  0.14.0
1564 # Note: prior to 2.1, this command was only supported for x86 and s390 VMs
1566 { 'command': 'inject-nmi' }
1569 # @set_link:
1571 # Sets the link status of a virtual network adapter.
1573 # @name: the device name of the virtual network adapter
1575 # @up: true to set the link status to be up
1577 # Returns: Nothing on success
1578 #          If @name is not a valid network device, DeviceNotFound
1580 # Since: 0.14.0
1582 # Notes: Not all network adapters support setting link status.  This command
1583 #        will succeed even if the network adapter does not support link status
1584 #        notification.
1586 { 'command': 'set_link', 'data': {'name': 'str', 'up': 'bool'} }
1589 # @balloon:
1591 # Request the balloon driver to change its balloon size.
1593 # @value: the target size of the balloon in bytes
1595 # Returns: Nothing on success
1596 #          If the balloon driver is enabled but not functional because the KVM
1597 #            kernel module cannot support it, KvmMissingCap
1598 #          If no balloon device is present, DeviceNotActive
1600 # Notes: This command just issues a request to the guest.  When it returns,
1601 #        the balloon size may not have changed.  A guest can change the balloon
1602 #        size independent of this command.
1604 # Since: 0.14.0
1606 { 'command': 'balloon', 'data': {'value': 'int'} }
1609 # @Abort
1611 # This action can be used to test transaction failure.
1613 # Since: 1.6
1615 { 'struct': 'Abort',
1616   'data': { } }
1619 # @ActionCompletionMode
1621 # An enumeration of Transactional completion modes.
1623 # @individual: Do not attempt to cancel any other Actions if any Actions fail
1624 #              after the Transaction request succeeds. All Actions that
1625 #              can complete successfully will do so without waiting on others.
1626 #              This is the default.
1628 # @grouped: If any Action fails after the Transaction succeeds, cancel all
1629 #           Actions. Actions do not complete until all Actions are ready to
1630 #           complete. May be rejected by Actions that do not support this
1631 #           completion mode.
1633 # Since: 2.5
1635 { 'enum': 'ActionCompletionMode',
1636   'data': [ 'individual', 'grouped' ] }
1639 # @TransactionAction
1641 # A discriminated record of operations that can be performed with
1642 # @transaction.
1644 # Since 1.1
1646 # drive-backup since 1.6
1647 # abort since 1.6
1648 # blockdev-snapshot-internal-sync since 1.7
1649 # blockdev-backup since 2.3
1650 # blockdev-snapshot since 2.5
1651 # block-dirty-bitmap-add since 2.5
1652 # block-dirty-bitmap-clear since 2.5
1654 { 'union': 'TransactionAction',
1655   'data': {
1656        'blockdev-snapshot': 'BlockdevSnapshot',
1657        'blockdev-snapshot-sync': 'BlockdevSnapshotSync',
1658        'drive-backup': 'DriveBackup',
1659        'blockdev-backup': 'BlockdevBackup',
1660        'abort': 'Abort',
1661        'blockdev-snapshot-internal-sync': 'BlockdevSnapshotInternal',
1662        'block-dirty-bitmap-add': 'BlockDirtyBitmapAdd',
1663        'block-dirty-bitmap-clear': 'BlockDirtyBitmap'
1664    } }
1667 # @TransactionProperties
1669 # Optional arguments to modify the behavior of a Transaction.
1671 # @completion-mode: #optional Controls how jobs launched asynchronously by
1672 #                   Actions will complete or fail as a group.
1673 #                   See @ActionCompletionMode for details.
1675 # Since: 2.5
1677 { 'struct': 'TransactionProperties',
1678   'data': {
1679        '*completion-mode': 'ActionCompletionMode'
1680   }
1684 # @transaction
1686 # Executes a number of transactionable QMP commands atomically. If any
1687 # operation fails, then the entire set of actions will be abandoned and the
1688 # appropriate error returned.
1690 # @actions: List of @TransactionAction;
1691 #           information needed for the respective operations.
1693 # @properties: #optional structure of additional options to control the
1694 #              execution of the transaction. See @TransactionProperties
1695 #              for additional detail.
1697 # Returns: nothing on success
1698 #          Errors depend on the operations of the transaction
1700 # Note: The transaction aborts on the first failure.  Therefore, there will be
1701 # information on only one failed operation returned in an error condition, and
1702 # subsequent actions will not have been attempted.
1704 # Since 1.1
1706 { 'command': 'transaction',
1707   'data': { 'actions': [ 'TransactionAction' ],
1708             '*properties': 'TransactionProperties'
1709           }
1713 # @human-monitor-command:
1715 # Execute a command on the human monitor and return the output.
1717 # @command-line: the command to execute in the human monitor
1719 # @cpu-index: #optional The CPU to use for commands that require an implicit CPU
1721 # Returns: the output of the command as a string
1723 # Since: 0.14.0
1725 # Notes: This command only exists as a stop-gap.  Its use is highly
1726 #        discouraged.  The semantics of this command are not guaranteed.
1728 #        Known limitations:
1730 #        o This command is stateless, this means that commands that depend
1731 #          on state information (such as getfd) might not work
1733 #       o Commands that prompt the user for data (eg. 'cont' when the block
1734 #         device is encrypted) don't currently work
1736 { 'command': 'human-monitor-command',
1737   'data': {'command-line': 'str', '*cpu-index': 'int'},
1738   'returns': 'str' }
1741 # @migrate_cancel
1743 # Cancel the current executing migration process.
1745 # Returns: nothing on success
1747 # Notes: This command succeeds even if there is no migration process running.
1749 # Since: 0.14.0
1751 { 'command': 'migrate_cancel' }
1754 # @migrate_set_downtime
1756 # Set maximum tolerated downtime for migration.
1758 # @value: maximum downtime in seconds
1760 # Returns: nothing on success
1762 # Since: 0.14.0
1764 { 'command': 'migrate_set_downtime', 'data': {'value': 'number'} }
1767 # @migrate_set_speed
1769 # Set maximum speed for migration.
1771 # @value: maximum speed in bytes.
1773 # Returns: nothing on success
1775 # Notes: A value lesser than zero will be automatically round up to zero.
1777 # Since: 0.14.0
1779 { 'command': 'migrate_set_speed', 'data': {'value': 'int'} }
1782 # @migrate-set-cache-size
1784 # Set XBZRLE cache size
1786 # @value: cache size in bytes
1788 # The size will be rounded down to the nearest power of 2.
1789 # The cache size can be modified before and during ongoing migration
1791 # Returns: nothing on success
1793 # Since: 1.2
1795 { 'command': 'migrate-set-cache-size', 'data': {'value': 'int'} }
1798 # @query-migrate-cache-size
1800 # query XBZRLE cache size
1802 # Returns: XBZRLE cache size in bytes
1804 # Since: 1.2
1806 { 'command': 'query-migrate-cache-size', 'returns': 'int' }
1809 # @ObjectPropertyInfo:
1811 # @name: the name of the property
1813 # @type: the type of the property.  This will typically come in one of four
1814 #        forms:
1816 #        1) A primitive type such as 'u8', 'u16', 'bool', 'str', or 'double'.
1817 #           These types are mapped to the appropriate JSON type.
1819 #        2) A child type in the form 'child<subtype>' where subtype is a qdev
1820 #           device type name.  Child properties create the composition tree.
1822 #        3) A link type in the form 'link<subtype>' where subtype is a qdev
1823 #           device type name.  Link properties form the device model graph.
1825 # Since: 1.2
1827 { 'struct': 'ObjectPropertyInfo',
1828   'data': { 'name': 'str', 'type': 'str' } }
1831 # @qom-list:
1833 # This command will list any properties of a object given a path in the object
1834 # model.
1836 # @path: the path within the object model.  See @qom-get for a description of
1837 #        this parameter.
1839 # Returns: a list of @ObjectPropertyInfo that describe the properties of the
1840 #          object.
1842 # Since: 1.2
1844 { 'command': 'qom-list',
1845   'data': { 'path': 'str' },
1846   'returns': [ 'ObjectPropertyInfo' ] }
1849 # @qom-get:
1851 # This command will get a property from a object model path and return the
1852 # value.
1854 # @path: The path within the object model.  There are two forms of supported
1855 #        paths--absolute and partial paths.
1857 #        Absolute paths are derived from the root object and can follow child<>
1858 #        or link<> properties.  Since they can follow link<> properties, they
1859 #        can be arbitrarily long.  Absolute paths look like absolute filenames
1860 #        and are prefixed  with a leading slash.
1862 #        Partial paths look like relative filenames.  They do not begin
1863 #        with a prefix.  The matching rules for partial paths are subtle but
1864 #        designed to make specifying objects easy.  At each level of the
1865 #        composition tree, the partial path is matched as an absolute path.
1866 #        The first match is not returned.  At least two matches are searched
1867 #        for.  A successful result is only returned if only one match is
1868 #        found.  If more than one match is found, a flag is return to
1869 #        indicate that the match was ambiguous.
1871 # @property: The property name to read
1873 # Returns: The property value.  The type depends on the property
1874 #          type. child<> and link<> properties are returned as #str
1875 #          pathnames.  All integer property types (u8, u16, etc) are
1876 #          returned as #int.
1878 # Since: 1.2
1880 { 'command': 'qom-get',
1881   'data': { 'path': 'str', 'property': 'str' },
1882   'returns': 'any' }
1885 # @qom-set:
1887 # This command will set a property from a object model path.
1889 # @path: see @qom-get for a description of this parameter
1891 # @property: the property name to set
1893 # @value: a value who's type is appropriate for the property type.  See @qom-get
1894 #         for a description of type mapping.
1896 # Since: 1.2
1898 { 'command': 'qom-set',
1899   'data': { 'path': 'str', 'property': 'str', 'value': 'any' } }
1902 # @set_password:
1904 # Sets the password of a remote display session.
1906 # @protocol: `vnc' to modify the VNC server password
1907 #            `spice' to modify the Spice server password
1909 # @password: the new password
1911 # @connected: #optional how to handle existing clients when changing the
1912 #                       password.  If nothing is specified, defaults to `keep'
1913 #                       `fail' to fail the command if clients are connected
1914 #                       `disconnect' to disconnect existing clients
1915 #                       `keep' to maintain existing clients
1917 # Returns: Nothing on success
1918 #          If Spice is not enabled, DeviceNotFound
1920 # Since: 0.14.0
1922 { 'command': 'set_password',
1923   'data': {'protocol': 'str', 'password': 'str', '*connected': 'str'} }
1926 # @expire_password:
1928 # Expire the password of a remote display server.
1930 # @protocol: the name of the remote display protocol `vnc' or `spice'
1932 # @time: when to expire the password.
1933 #        `now' to expire the password immediately
1934 #        `never' to cancel password expiration
1935 #        `+INT' where INT is the number of seconds from now (integer)
1936 #        `INT' where INT is the absolute time in seconds
1938 # Returns: Nothing on success
1939 #          If @protocol is `spice' and Spice is not active, DeviceNotFound
1941 # Since: 0.14.0
1943 # Notes: Time is relative to the server and currently there is no way to
1944 #        coordinate server time with client time.  It is not recommended to
1945 #        use the absolute time version of the @time parameter unless you're
1946 #        sure you are on the same machine as the QEMU instance.
1948 { 'command': 'expire_password', 'data': {'protocol': 'str', 'time': 'str'} }
1951 # @change-vnc-password:
1953 # Change the VNC server password.
1955 # @password:  the new password to use with VNC authentication
1957 # Since: 1.1
1959 # Notes:  An empty password in this command will set the password to the empty
1960 #         string.  Existing clients are unaffected by executing this command.
1962 { 'command': 'change-vnc-password', 'data': {'password': 'str'} }
1965 # @change:
1967 # This command is multiple commands multiplexed together.
1969 # @device: This is normally the name of a block device but it may also be 'vnc'.
1970 #          when it's 'vnc', then sub command depends on @target
1972 # @target: If @device is a block device, then this is the new filename.
1973 #          If @device is 'vnc', then if the value 'password' selects the vnc
1974 #          change password command.   Otherwise, this specifies a new server URI
1975 #          address to listen to for VNC connections.
1977 # @arg:    If @device is a block device, then this is an optional format to open
1978 #          the device with.
1979 #          If @device is 'vnc' and @target is 'password', this is the new VNC
1980 #          password to set.  If this argument is an empty string, then no future
1981 #          logins will be allowed.
1983 # Returns: Nothing on success.
1984 #          If @device is not a valid block device, DeviceNotFound
1985 #          If the new block device is encrypted, DeviceEncrypted.  Note that
1986 #          if this error is returned, the device has been opened successfully
1987 #          and an additional call to @block_passwd is required to set the
1988 #          device's password.  The behavior of reads and writes to the block
1989 #          device between when these calls are executed is undefined.
1991 # Notes:  This interface is deprecated, and it is strongly recommended that you
1992 #         avoid using it.  For changing block devices, use
1993 #         blockdev-change-medium; for changing VNC parameters, use
1994 #         change-vnc-password.
1996 # Since: 0.14.0
1998 { 'command': 'change',
1999   'data': {'device': 'str', 'target': 'str', '*arg': 'str'} }
2002 # @ObjectTypeInfo:
2004 # This structure describes a search result from @qom-list-types
2006 # @name: the type name found in the search
2008 # Since: 1.1
2010 # Notes: This command is experimental and may change syntax in future releases.
2012 { 'struct': 'ObjectTypeInfo',
2013   'data': { 'name': 'str' } }
2016 # @qom-list-types:
2018 # This command will return a list of types given search parameters
2020 # @implements: if specified, only return types that implement this type name
2022 # @abstract: if true, include abstract types in the results
2024 # Returns: a list of @ObjectTypeInfo or an empty list if no results are found
2026 # Since: 1.1
2028 { 'command': 'qom-list-types',
2029   'data': { '*implements': 'str', '*abstract': 'bool' },
2030   'returns': [ 'ObjectTypeInfo' ] }
2033 # @DevicePropertyInfo:
2035 # Information about device properties.
2037 # @name: the name of the property
2038 # @type: the typename of the property
2039 # @description: #optional if specified, the description of the property.
2040 #               (since 2.2)
2042 # Since: 1.2
2044 { 'struct': 'DevicePropertyInfo',
2045   'data': { 'name': 'str', 'type': 'str', '*description': 'str' } }
2048 # @device-list-properties:
2050 # List properties associated with a device.
2052 # @typename: the type name of a device
2054 # Returns: a list of DevicePropertyInfo describing a devices properties
2056 # Since: 1.2
2058 { 'command': 'device-list-properties',
2059   'data': { 'typename': 'str'},
2060   'returns': [ 'DevicePropertyInfo' ] }
2063 # @migrate
2065 # Migrates the current running guest to another Virtual Machine.
2067 # @uri: the Uniform Resource Identifier of the destination VM
2069 # @blk: #optional do block migration (full disk copy)
2071 # @inc: #optional incremental disk copy migration
2073 # @detach: this argument exists only for compatibility reasons and
2074 #          is ignored by QEMU
2076 # Returns: nothing on success
2078 # Since: 0.14.0
2080 { 'command': 'migrate',
2081   'data': {'uri': 'str', '*blk': 'bool', '*inc': 'bool', '*detach': 'bool' } }
2084 # @migrate-incoming
2086 # Start an incoming migration, the qemu must have been started
2087 # with -incoming defer
2089 # @uri: The Uniform Resource Identifier identifying the source or
2090 #       address to listen on
2092 # Returns: nothing on success
2094 # Since: 2.3
2095 # Note: It's a bad idea to use a string for the uri, but it needs to stay
2096 # compatible with -incoming and the format of the uri is already exposed
2097 # above libvirt
2099 { 'command': 'migrate-incoming', 'data': {'uri': 'str' } }
2101 # @xen-save-devices-state:
2103 # Save the state of all devices to file. The RAM and the block devices
2104 # of the VM are not saved by this command.
2106 # @filename: the file to save the state of the devices to as binary
2107 # data. See xen-save-devices-state.txt for a description of the binary
2108 # format.
2110 # Returns: Nothing on success
2112 # Since: 1.1
2114 { 'command': 'xen-save-devices-state', 'data': {'filename': 'str'} }
2117 # @xen-set-global-dirty-log
2119 # Enable or disable the global dirty log mode.
2121 # @enable: true to enable, false to disable.
2123 # Returns: nothing
2125 # Since: 1.3
2127 { 'command': 'xen-set-global-dirty-log', 'data': { 'enable': 'bool' } }
2130 # @device_del:
2132 # Remove a device from a guest
2134 # @id: the name or QOM path of the device
2136 # Returns: Nothing on success
2137 #          If @id is not a valid device, DeviceNotFound
2139 # Notes: When this command completes, the device may not be removed from the
2140 #        guest.  Hot removal is an operation that requires guest cooperation.
2141 #        This command merely requests that the guest begin the hot removal
2142 #        process.  Completion of the device removal process is signaled with a
2143 #        DEVICE_DELETED event. Guest reset will automatically complete removal
2144 #        for all devices.
2146 # Since: 0.14.0
2148 { 'command': 'device_del', 'data': {'id': 'str'} }
2151 # @DumpGuestMemoryFormat:
2153 # An enumeration of guest-memory-dump's format.
2155 # @elf: elf format
2157 # @kdump-zlib: kdump-compressed format with zlib-compressed
2159 # @kdump-lzo: kdump-compressed format with lzo-compressed
2161 # @kdump-snappy: kdump-compressed format with snappy-compressed
2163 # Since: 2.0
2165 { 'enum': 'DumpGuestMemoryFormat',
2166   'data': [ 'elf', 'kdump-zlib', 'kdump-lzo', 'kdump-snappy' ] }
2169 # @dump-guest-memory
2171 # Dump guest's memory to vmcore. It is a synchronous operation that can take
2172 # very long depending on the amount of guest memory.
2174 # @paging: if true, do paging to get guest's memory mapping. This allows
2175 #          using gdb to process the core file.
2177 #          IMPORTANT: this option can make QEMU allocate several gigabytes
2178 #                     of RAM. This can happen for a large guest, or a
2179 #                     malicious guest pretending to be large.
2181 #          Also, paging=true has the following limitations:
2183 #             1. The guest may be in a catastrophic state or can have corrupted
2184 #                memory, which cannot be trusted
2185 #             2. The guest can be in real-mode even if paging is enabled. For
2186 #                example, the guest uses ACPI to sleep, and ACPI sleep state
2187 #                goes in real-mode
2188 #             3. Currently only supported on i386 and x86_64.
2190 # @protocol: the filename or file descriptor of the vmcore. The supported
2191 #            protocols are:
2193 #            1. file: the protocol starts with "file:", and the following
2194 #               string is the file's path.
2195 #            2. fd: the protocol starts with "fd:", and the following string
2196 #               is the fd's name.
2198 # @begin: #optional if specified, the starting physical address.
2200 # @length: #optional if specified, the memory size, in bytes. If you don't
2201 #          want to dump all guest's memory, please specify the start @begin
2202 #          and @length
2204 # @format: #optional if specified, the format of guest memory dump. But non-elf
2205 #          format is conflict with paging and filter, ie. @paging, @begin and
2206 #          @length is not allowed to be specified with non-elf @format at the
2207 #          same time (since 2.0)
2209 # Returns: nothing on success
2211 # Since: 1.2
2213 { 'command': 'dump-guest-memory',
2214   'data': { 'paging': 'bool', 'protocol': 'str', '*begin': 'int',
2215             '*length': 'int', '*format': 'DumpGuestMemoryFormat' } }
2218 # @DumpGuestMemoryCapability:
2220 # A list of the available formats for dump-guest-memory
2222 # Since: 2.0
2224 { 'struct': 'DumpGuestMemoryCapability',
2225   'data': {
2226       'formats': ['DumpGuestMemoryFormat'] } }
2229 # @query-dump-guest-memory-capability:
2231 # Returns the available formats for dump-guest-memory
2233 # Returns:  A @DumpGuestMemoryCapability object listing available formats for
2234 #           dump-guest-memory
2236 # Since: 2.0
2238 { 'command': 'query-dump-guest-memory-capability',
2239   'returns': 'DumpGuestMemoryCapability' }
2242 # @dump-skeys
2244 # Dump guest's storage keys
2246 # @filename: the path to the file to dump to
2248 # This command is only supported on s390 architecture.
2250 # Since: 2.5
2252 { 'command': 'dump-skeys',
2253   'data': { 'filename': 'str' } }
2256 # @netdev_add:
2258 # Add a network backend.
2260 # @type: the type of network backend.  Current valid values are 'user', 'tap',
2261 #        'vde', 'socket', 'dump' and 'bridge'
2263 # @id: the name of the new network backend
2265 # Additional arguments depend on the type.
2267 # TODO This command effectively bypasses QAPI completely due to its
2268 # "additional arguments" business.  It shouldn't have been added to
2269 # the schema in this form.  It should be qapified properly, or
2270 # replaced by a properly qapified command.
2272 # Since: 0.14.0
2274 # Returns: Nothing on success
2275 #          If @type is not a valid network backend, DeviceNotFound
2277 { 'command': 'netdev_add',
2278   'data': {'type': 'str', 'id': 'str'},
2279   'gen': false }                # so we can get the additional arguments
2282 # @netdev_del:
2284 # Remove a network backend.
2286 # @id: the name of the network backend to remove
2288 # Returns: Nothing on success
2289 #          If @id is not a valid network backend, DeviceNotFound
2291 # Since: 0.14.0
2293 { 'command': 'netdev_del', 'data': {'id': 'str'} }
2296 # @object-add:
2298 # Create a QOM object.
2300 # @qom-type: the class name for the object to be created
2302 # @id: the name of the new object
2304 # @props: #optional a dictionary of properties to be passed to the backend
2306 # Returns: Nothing on success
2307 #          Error if @qom-type is not a valid class name
2309 # Since: 2.0
2311 { 'command': 'object-add',
2312   'data': {'qom-type': 'str', 'id': 'str', '*props': 'any'} }
2315 # @object-del:
2317 # Remove a QOM object.
2319 # @id: the name of the QOM object to remove
2321 # Returns: Nothing on success
2322 #          Error if @id is not a valid id for a QOM object
2324 # Since: 2.0
2326 { 'command': 'object-del', 'data': {'id': 'str'} }
2329 # @NetdevNoneOptions
2331 # Use it alone to have zero network devices.
2333 # Since 1.2
2335 { 'struct': 'NetdevNoneOptions',
2336   'data': { } }
2339 # @NetLegacyNicOptions
2341 # Create a new Network Interface Card.
2343 # @netdev: #optional id of -netdev to connect to
2345 # @macaddr: #optional MAC address
2347 # @model: #optional device model (e1000, rtl8139, virtio etc.)
2349 # @addr: #optional PCI device address
2351 # @vectors: #optional number of MSI-x vectors, 0 to disable MSI-X
2353 # Since 1.2
2355 { 'struct': 'NetLegacyNicOptions',
2356   'data': {
2357     '*netdev':  'str',
2358     '*macaddr': 'str',
2359     '*model':   'str',
2360     '*addr':    'str',
2361     '*vectors': 'uint32' } }
2364 # @String
2366 # A fat type wrapping 'str', to be embedded in lists.
2368 # Since 1.2
2370 { 'struct': 'String',
2371   'data': {
2372     'str': 'str' } }
2375 # @NetdevUserOptions
2377 # Use the user mode network stack which requires no administrator privilege to
2378 # run.
2380 # @hostname: #optional client hostname reported by the builtin DHCP server
2382 # @restrict: #optional isolate the guest from the host
2384 # @ip: #optional legacy parameter, use net= instead
2386 # @net: #optional IP address and optional netmask
2388 # @host: #optional guest-visible address of the host
2390 # @tftp: #optional root directory of the built-in TFTP server
2392 # @bootfile: #optional BOOTP filename, for use with tftp=
2394 # @dhcpstart: #optional the first of the 16 IPs the built-in DHCP server can
2395 #             assign
2397 # @dns: #optional guest-visible address of the virtual nameserver
2399 # @dnssearch: #optional list of DNS suffixes to search, passed as DHCP option
2400 #             to the guest
2402 # @smb: #optional root directory of the built-in SMB server
2404 # @smbserver: #optional IP address of the built-in SMB server
2406 # @hostfwd: #optional redirect incoming TCP or UDP host connections to guest
2407 #           endpoints
2409 # @guestfwd: #optional forward guest TCP connections
2411 # Since 1.2
2413 { 'struct': 'NetdevUserOptions',
2414   'data': {
2415     '*hostname':  'str',
2416     '*restrict':  'bool',
2417     '*ip':        'str',
2418     '*net':       'str',
2419     '*host':      'str',
2420     '*tftp':      'str',
2421     '*bootfile':  'str',
2422     '*dhcpstart': 'str',
2423     '*dns':       'str',
2424     '*dnssearch': ['String'],
2425     '*smb':       'str',
2426     '*smbserver': 'str',
2427     '*hostfwd':   ['String'],
2428     '*guestfwd':  ['String'] } }
2431 # @NetdevTapOptions
2433 # Connect the host TAP network interface name to the VLAN.
2435 # @ifname: #optional interface name
2437 # @fd: #optional file descriptor of an already opened tap
2439 # @fds: #optional multiple file descriptors of already opened multiqueue capable
2440 # tap
2442 # @script: #optional script to initialize the interface
2444 # @downscript: #optional script to shut down the interface
2446 # @helper: #optional command to execute to configure bridge
2448 # @sndbuf: #optional send buffer limit. Understands [TGMKkb] suffixes.
2450 # @vnet_hdr: #optional enable the IFF_VNET_HDR flag on the tap interface
2452 # @vhost: #optional enable vhost-net network accelerator
2454 # @vhostfd: #optional file descriptor of an already opened vhost net device
2456 # @vhostfds: #optional file descriptors of multiple already opened vhost net
2457 # devices
2459 # @vhostforce: #optional vhost on for non-MSIX virtio guests
2461 # @queues: #optional number of queues to be created for multiqueue capable tap
2463 # Since 1.2
2465 { 'struct': 'NetdevTapOptions',
2466   'data': {
2467     '*ifname':     'str',
2468     '*fd':         'str',
2469     '*fds':        'str',
2470     '*script':     'str',
2471     '*downscript': 'str',
2472     '*helper':     'str',
2473     '*sndbuf':     'size',
2474     '*vnet_hdr':   'bool',
2475     '*vhost':      'bool',
2476     '*vhostfd':    'str',
2477     '*vhostfds':   'str',
2478     '*vhostforce': 'bool',
2479     '*queues':     'uint32'} }
2482 # @NetdevSocketOptions
2484 # Connect the VLAN to a remote VLAN in another QEMU virtual machine using a TCP
2485 # socket connection.
2487 # @fd: #optional file descriptor of an already opened socket
2489 # @listen: #optional port number, and optional hostname, to listen on
2491 # @connect: #optional port number, and optional hostname, to connect to
2493 # @mcast: #optional UDP multicast address and port number
2495 # @localaddr: #optional source address and port for multicast and udp packets
2497 # @udp: #optional UDP unicast address and port number
2499 # Since 1.2
2501 { 'struct': 'NetdevSocketOptions',
2502   'data': {
2503     '*fd':        'str',
2504     '*listen':    'str',
2505     '*connect':   'str',
2506     '*mcast':     'str',
2507     '*localaddr': 'str',
2508     '*udp':       'str' } }
2511 # @NetdevL2TPv3Options
2513 # Connect the VLAN to Ethernet over L2TPv3 Static tunnel
2515 # @src: source address
2517 # @dst: destination address
2519 # @srcport: #optional source port - mandatory for udp, optional for ip
2521 # @dstport: #optional destination port - mandatory for udp, optional for ip
2523 # @ipv6: #optional - force the use of ipv6
2525 # @udp: #optional - use the udp version of l2tpv3 encapsulation
2527 # @cookie64: #optional - use 64 bit coookies
2529 # @counter: #optional have sequence counter
2531 # @pincounter: #optional pin sequence counter to zero -
2532 #              workaround for buggy implementations or
2533 #              networks with packet reorder
2535 # @txcookie: #optional 32 or 64 bit transmit cookie
2537 # @rxcookie: #optional 32 or 64 bit receive cookie
2539 # @txsession: 32 bit transmit session
2541 # @rxsession: #optional 32 bit receive session - if not specified
2542 #             set to the same value as transmit
2544 # @offset: #optional additional offset - allows the insertion of
2545 #          additional application-specific data before the packet payload
2547 # Since 2.1
2549 { 'struct': 'NetdevL2TPv3Options',
2550   'data': {
2551     'src':          'str',
2552     'dst':          'str',
2553     '*srcport':     'str',
2554     '*dstport':     'str',
2555     '*ipv6':        'bool',
2556     '*udp':         'bool',
2557     '*cookie64':    'bool',
2558     '*counter':     'bool',
2559     '*pincounter':  'bool',
2560     '*txcookie':    'uint64',
2561     '*rxcookie':    'uint64',
2562     'txsession':    'uint32',
2563     '*rxsession':   'uint32',
2564     '*offset':      'uint32' } }
2567 # @NetdevVdeOptions
2569 # Connect the VLAN to a vde switch running on the host.
2571 # @sock: #optional socket path
2573 # @port: #optional port number
2575 # @group: #optional group owner of socket
2577 # @mode: #optional permissions for socket
2579 # Since 1.2
2581 { 'struct': 'NetdevVdeOptions',
2582   'data': {
2583     '*sock':  'str',
2584     '*port':  'uint16',
2585     '*group': 'str',
2586     '*mode':  'uint16' } }
2589 # @NetdevDumpOptions
2591 # Dump VLAN network traffic to a file.
2593 # @len: #optional per-packet size limit (64k default). Understands [TGMKkb]
2594 # suffixes.
2596 # @file: #optional dump file path (default is qemu-vlan0.pcap)
2598 # Since 1.2
2600 { 'struct': 'NetdevDumpOptions',
2601   'data': {
2602     '*len':  'size',
2603     '*file': 'str' } }
2606 # @NetdevBridgeOptions
2608 # Connect a host TAP network interface to a host bridge device.
2610 # @br: #optional bridge name
2612 # @helper: #optional command to execute to configure bridge
2614 # Since 1.2
2616 { 'struct': 'NetdevBridgeOptions',
2617   'data': {
2618     '*br':     'str',
2619     '*helper': 'str' } }
2622 # @NetdevHubPortOptions
2624 # Connect two or more net clients through a software hub.
2626 # @hubid: hub identifier number
2628 # Since 1.2
2630 { 'struct': 'NetdevHubPortOptions',
2631   'data': {
2632     'hubid':     'int32' } }
2635 # @NetdevNetmapOptions
2637 # Connect a client to a netmap-enabled NIC or to a VALE switch port
2639 # @ifname: Either the name of an existing network interface supported by
2640 #          netmap, or the name of a VALE port (created on the fly).
2641 #          A VALE port name is in the form 'valeXXX:YYY', where XXX and
2642 #          YYY are non-negative integers. XXX identifies a switch and
2643 #          YYY identifies a port of the switch. VALE ports having the
2644 #          same XXX are therefore connected to the same switch.
2646 # @devname: #optional path of the netmap device (default: '/dev/netmap').
2648 # Since 2.0
2650 { 'struct': 'NetdevNetmapOptions',
2651   'data': {
2652     'ifname':     'str',
2653     '*devname':    'str' } }
2656 # @NetdevVhostUserOptions
2658 # Vhost-user network backend
2660 # @chardev: name of a unix socket chardev
2662 # @vhostforce: #optional vhost on for non-MSIX virtio guests (default: false).
2664 # @queues: #optional number of queues to be created for multiqueue vhost-user
2665 #          (default: 1) (Since 2.5)
2667 # Since 2.1
2669 { 'struct': 'NetdevVhostUserOptions',
2670   'data': {
2671     'chardev':        'str',
2672     '*vhostforce':    'bool',
2673     '*queues':        'int' } }
2676 # @NetClientOptions
2678 # A discriminated record of network device traits.
2680 # Since 1.2
2682 # 'l2tpv3' - since 2.1
2685 { 'union': 'NetClientOptions',
2686   'data': {
2687     'none':     'NetdevNoneOptions',
2688     'nic':      'NetLegacyNicOptions',
2689     'user':     'NetdevUserOptions',
2690     'tap':      'NetdevTapOptions',
2691     'l2tpv3':   'NetdevL2TPv3Options',
2692     'socket':   'NetdevSocketOptions',
2693     'vde':      'NetdevVdeOptions',
2694     'dump':     'NetdevDumpOptions',
2695     'bridge':   'NetdevBridgeOptions',
2696     'hubport':  'NetdevHubPortOptions',
2697     'netmap':   'NetdevNetmapOptions',
2698     'vhost-user': 'NetdevVhostUserOptions' } }
2701 # @NetLegacy
2703 # Captures the configuration of a network device; legacy.
2705 # @vlan: #optional vlan number
2707 # @id: #optional identifier for monitor commands
2709 # @name: #optional identifier for monitor commands, ignored if @id is present
2711 # @opts: device type specific properties (legacy)
2713 # Since 1.2
2715 { 'struct': 'NetLegacy',
2716   'data': {
2717     '*vlan': 'int32',
2718     '*id':   'str',
2719     '*name': 'str',
2720     'opts':  'NetClientOptions' } }
2723 # @Netdev
2725 # Captures the configuration of a network device.
2727 # @id: identifier for monitor commands.
2729 # @opts: device type specific properties
2731 # Since 1.2
2733 { 'struct': 'Netdev',
2734   'data': {
2735     'id':   'str',
2736     'opts': 'NetClientOptions' } }
2739 # @NetFilterDirection
2741 # Indicates whether a netfilter is attached to a netdev's transmit queue or
2742 # receive queue or both.
2744 # @all: the filter is attached both to the receive and the transmit
2745 #       queue of the netdev (default).
2747 # @rx: the filter is attached to the receive queue of the netdev,
2748 #      where it will receive packets sent to the netdev.
2750 # @tx: the filter is attached to the transmit queue of the netdev,
2751 #      where it will receive packets sent by the netdev.
2753 # Since 2.5
2755 { 'enum': 'NetFilterDirection',
2756   'data': [ 'all', 'rx', 'tx' ] }
2759 # @InetSocketAddress
2761 # Captures a socket address or address range in the Internet namespace.
2763 # @host: host part of the address
2765 # @port: port part of the address, or lowest port if @to is present
2767 # @to: highest port to try
2769 # @ipv4: whether to accept IPv4 addresses, default try both IPv4 and IPv6
2770 #        #optional
2772 # @ipv6: whether to accept IPv6 addresses, default try both IPv4 and IPv6
2773 #        #optional
2775 # Since 1.3
2777 { 'struct': 'InetSocketAddress',
2778   'data': {
2779     'host': 'str',
2780     'port': 'str',
2781     '*to': 'uint16',
2782     '*ipv4': 'bool',
2783     '*ipv6': 'bool' } }
2786 # @UnixSocketAddress
2788 # Captures a socket address in the local ("Unix socket") namespace.
2790 # @path: filesystem path to use
2792 # Since 1.3
2794 { 'struct': 'UnixSocketAddress',
2795   'data': {
2796     'path': 'str' } }
2799 # @SocketAddress
2801 # Captures the address of a socket, which could also be a named file descriptor
2803 # Since 1.3
2805 { 'union': 'SocketAddress',
2806   'data': {
2807     'inet': 'InetSocketAddress',
2808     'unix': 'UnixSocketAddress',
2809     'fd': 'String' } }
2812 # @getfd:
2814 # Receive a file descriptor via SCM rights and assign it a name
2816 # @fdname: file descriptor name
2818 # Returns: Nothing on success
2820 # Since: 0.14.0
2822 # Notes: If @fdname already exists, the file descriptor assigned to
2823 #        it will be closed and replaced by the received file
2824 #        descriptor.
2825 #        The 'closefd' command can be used to explicitly close the
2826 #        file descriptor when it is no longer needed.
2828 { 'command': 'getfd', 'data': {'fdname': 'str'} }
2831 # @closefd:
2833 # Close a file descriptor previously passed via SCM rights
2835 # @fdname: file descriptor name
2837 # Returns: Nothing on success
2839 # Since: 0.14.0
2841 { 'command': 'closefd', 'data': {'fdname': 'str'} }
2844 # @MachineInfo:
2846 # Information describing a machine.
2848 # @name: the name of the machine
2850 # @alias: #optional an alias for the machine name
2852 # @default: #optional whether the machine is default
2854 # @cpu-max: maximum number of CPUs supported by the machine type
2855 #           (since 1.5.0)
2857 # Since: 1.2.0
2859 { 'struct': 'MachineInfo',
2860   'data': { 'name': 'str', '*alias': 'str',
2861             '*is-default': 'bool', 'cpu-max': 'int' } }
2864 # @query-machines:
2866 # Return a list of supported machines
2868 # Returns: a list of MachineInfo
2870 # Since: 1.2.0
2872 { 'command': 'query-machines', 'returns': ['MachineInfo'] }
2875 # @CpuDefinitionInfo:
2877 # Virtual CPU definition.
2879 # @name: the name of the CPU definition
2881 # Since: 1.2.0
2883 { 'struct': 'CpuDefinitionInfo',
2884   'data': { 'name': 'str' } }
2887 # @query-cpu-definitions:
2889 # Return a list of supported virtual CPU definitions
2891 # Returns: a list of CpuDefInfo
2893 # Since: 1.2.0
2895 { 'command': 'query-cpu-definitions', 'returns': ['CpuDefinitionInfo'] }
2897 # @AddfdInfo:
2899 # Information about a file descriptor that was added to an fd set.
2901 # @fdset-id: The ID of the fd set that @fd was added to.
2903 # @fd: The file descriptor that was received via SCM rights and
2904 #      added to the fd set.
2906 # Since: 1.2.0
2908 { 'struct': 'AddfdInfo', 'data': {'fdset-id': 'int', 'fd': 'int'} }
2911 # @add-fd:
2913 # Add a file descriptor, that was passed via SCM rights, to an fd set.
2915 # @fdset-id: #optional The ID of the fd set to add the file descriptor to.
2917 # @opaque: #optional A free-form string that can be used to describe the fd.
2919 # Returns: @AddfdInfo on success
2920 #          If file descriptor was not received, FdNotSupplied
2921 #          If @fdset-id is a negative value, InvalidParameterValue
2923 # Notes: The list of fd sets is shared by all monitor connections.
2925 #        If @fdset-id is not specified, a new fd set will be created.
2927 # Since: 1.2.0
2929 { 'command': 'add-fd', 'data': {'*fdset-id': 'int', '*opaque': 'str'},
2930   'returns': 'AddfdInfo' }
2933 # @remove-fd:
2935 # Remove a file descriptor from an fd set.
2937 # @fdset-id: The ID of the fd set that the file descriptor belongs to.
2939 # @fd: #optional The file descriptor that is to be removed.
2941 # Returns: Nothing on success
2942 #          If @fdset-id or @fd is not found, FdNotFound
2944 # Since: 1.2.0
2946 # Notes: The list of fd sets is shared by all monitor connections.
2948 #        If @fd is not specified, all file descriptors in @fdset-id
2949 #        will be removed.
2951 { 'command': 'remove-fd', 'data': {'fdset-id': 'int', '*fd': 'int'} }
2954 # @FdsetFdInfo:
2956 # Information about a file descriptor that belongs to an fd set.
2958 # @fd: The file descriptor value.
2960 # @opaque: #optional A free-form string that can be used to describe the fd.
2962 # Since: 1.2.0
2964 { 'struct': 'FdsetFdInfo',
2965   'data': {'fd': 'int', '*opaque': 'str'} }
2968 # @FdsetInfo:
2970 # Information about an fd set.
2972 # @fdset-id: The ID of the fd set.
2974 # @fds: A list of file descriptors that belong to this fd set.
2976 # Since: 1.2.0
2978 { 'struct': 'FdsetInfo',
2979   'data': {'fdset-id': 'int', 'fds': ['FdsetFdInfo']} }
2982 # @query-fdsets:
2984 # Return information describing all fd sets.
2986 # Returns: A list of @FdsetInfo
2988 # Since: 1.2.0
2990 # Note: The list of fd sets is shared by all monitor connections.
2993 { 'command': 'query-fdsets', 'returns': ['FdsetInfo'] }
2996 # @TargetInfo:
2998 # Information describing the QEMU target.
3000 # @arch: the target architecture (eg "x86_64", "i386", etc)
3002 # Since: 1.2.0
3004 { 'struct': 'TargetInfo',
3005   'data': { 'arch': 'str' } }
3008 # @query-target:
3010 # Return information about the target for this QEMU
3012 # Returns: TargetInfo
3014 # Since: 1.2.0
3016 { 'command': 'query-target', 'returns': 'TargetInfo' }
3019 # @QKeyCode:
3021 # An enumeration of key name.
3023 # This is used by the send-key command.
3025 # Since: 1.3.0
3027 # 'unmapped' and 'pause' since 2.0
3028 # 'ro' and 'kp_comma' since 2.4
3030 { 'enum': 'QKeyCode',
3031   'data': [ 'unmapped',
3032             'shift', 'shift_r', 'alt', 'alt_r', 'altgr', 'altgr_r', 'ctrl',
3033             'ctrl_r', 'menu', 'esc', '1', '2', '3', '4', '5', '6', '7', '8',
3034             '9', '0', 'minus', 'equal', 'backspace', 'tab', 'q', 'w', 'e',
3035             'r', 't', 'y', 'u', 'i', 'o', 'p', 'bracket_left', 'bracket_right',
3036             'ret', 'a', 's', 'd', 'f', 'g', 'h', 'j', 'k', 'l', 'semicolon',
3037             'apostrophe', 'grave_accent', 'backslash', 'z', 'x', 'c', 'v', 'b',
3038             'n', 'm', 'comma', 'dot', 'slash', 'asterisk', 'spc', 'caps_lock',
3039             'f1', 'f2', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9', 'f10',
3040             'num_lock', 'scroll_lock', 'kp_divide', 'kp_multiply',
3041             'kp_subtract', 'kp_add', 'kp_enter', 'kp_decimal', 'sysrq', 'kp_0',
3042             'kp_1', 'kp_2', 'kp_3', 'kp_4', 'kp_5', 'kp_6', 'kp_7', 'kp_8',
3043             'kp_9', 'less', 'f11', 'f12', 'print', 'home', 'pgup', 'pgdn', 'end',
3044             'left', 'up', 'down', 'right', 'insert', 'delete', 'stop', 'again',
3045             'props', 'undo', 'front', 'copy', 'open', 'paste', 'find', 'cut',
3046             'lf', 'help', 'meta_l', 'meta_r', 'compose', 'pause', 'ro',
3047             'kp_comma' ] }
3050 # @KeyValue
3052 # Represents a keyboard key.
3054 # Since: 1.3.0
3056 { 'union': 'KeyValue',
3057   'data': {
3058     'number': 'int',
3059     'qcode': 'QKeyCode' } }
3062 # @send-key:
3064 # Send keys to guest.
3066 # @keys: An array of @KeyValue elements. All @KeyValues in this array are
3067 #        simultaneously sent to the guest. A @KeyValue.number value is sent
3068 #        directly to the guest, while @KeyValue.qcode must be a valid
3069 #        @QKeyCode value
3071 # @hold-time: #optional time to delay key up events, milliseconds. Defaults
3072 #             to 100
3074 # Returns: Nothing on success
3075 #          If key is unknown or redundant, InvalidParameter
3077 # Since: 1.3.0
3080 { 'command': 'send-key',
3081   'data': { 'keys': ['KeyValue'], '*hold-time': 'int' } }
3084 # @screendump:
3086 # Write a PPM of the VGA screen to a file.
3088 # @filename: the path of a new PPM file to store the image
3090 # Returns: Nothing on success
3092 # Since: 0.14.0
3094 { 'command': 'screendump', 'data': {'filename': 'str'} }
3098 # @ChardevCommon:
3100 # Configuration shared across all chardev backends
3102 # @logfile: #optional The name of a logfile to save output
3103 # @logappend: #optional true to append instead of truncate
3104 #             (default to false to truncate)
3106 # Since: 2.6
3108 { 'struct': 'ChardevCommon', 'data': { '*logfile': 'str',
3109                                        '*logappend': 'bool' } }
3112 # @ChardevFile:
3114 # Configuration info for file chardevs.
3116 # @in:  #optional The name of the input file
3117 # @out: The name of the output file
3118 # @append: #optional Open the file in append mode (default false to
3119 #          truncate) (Since 2.6)
3121 # Since: 1.4
3123 { 'struct': 'ChardevFile', 'data': { '*in' : 'str',
3124                                    'out' : 'str',
3125                                    '*append': 'bool' },
3126   'base': 'ChardevCommon' }
3129 # @ChardevHostdev:
3131 # Configuration info for device and pipe chardevs.
3133 # @device: The name of the special file for the device,
3134 #          i.e. /dev/ttyS0 on Unix or COM1: on Windows
3135 # @type: What kind of device this is.
3137 # Since: 1.4
3139 { 'struct': 'ChardevHostdev', 'data': { 'device' : 'str' },
3140   'base': 'ChardevCommon' }
3143 # @ChardevSocket:
3145 # Configuration info for (stream) socket chardevs.
3147 # @addr: socket address to listen on (server=true)
3148 #        or connect to (server=false)
3149 # @tls-creds: #optional the ID of the TLS credentials object (since 2.6)
3150 # @server: #optional create server socket (default: true)
3151 # @wait: #optional wait for incoming connection on server
3152 #        sockets (default: false).
3153 # @nodelay: #optional set TCP_NODELAY socket option (default: false)
3154 # @telnet: #optional enable telnet protocol on server
3155 #          sockets (default: false)
3156 # @reconnect: #optional For a client socket, if a socket is disconnected,
3157 #          then attempt a reconnect after the given number of seconds.
3158 #          Setting this to zero disables this function. (default: 0)
3159 #          (Since: 2.2)
3161 # Since: 1.4
3163 { 'struct': 'ChardevSocket', 'data': { 'addr'       : 'SocketAddress',
3164                                      '*tls-creds'  : 'str',
3165                                      '*server'    : 'bool',
3166                                      '*wait'      : 'bool',
3167                                      '*nodelay'   : 'bool',
3168                                      '*telnet'    : 'bool',
3169                                      '*reconnect' : 'int' },
3170   'base': 'ChardevCommon' }
3173 # @ChardevUdp:
3175 # Configuration info for datagram socket chardevs.
3177 # @remote: remote address
3178 # @local: #optional local address
3180 # Since: 1.5
3182 { 'struct': 'ChardevUdp', 'data': { 'remote' : 'SocketAddress',
3183                                   '*local' : 'SocketAddress' },
3184   'base': 'ChardevCommon' }
3187 # @ChardevMux:
3189 # Configuration info for mux chardevs.
3191 # @chardev: name of the base chardev.
3193 # Since: 1.5
3195 { 'struct': 'ChardevMux', 'data': { 'chardev' : 'str' },
3196   'base': 'ChardevCommon' }
3199 # @ChardevStdio:
3201 # Configuration info for stdio chardevs.
3203 # @signal: #optional Allow signals (such as SIGINT triggered by ^C)
3204 #          be delivered to qemu.  Default: true in -nographic mode,
3205 #          false otherwise.
3207 # Since: 1.5
3209 { 'struct': 'ChardevStdio', 'data': { '*signal' : 'bool' },
3210   'base': 'ChardevCommon' }
3214 # @ChardevSpiceChannel:
3216 # Configuration info for spice vm channel chardevs.
3218 # @type: kind of channel (for example vdagent).
3220 # Since: 1.5
3222 { 'struct': 'ChardevSpiceChannel', 'data': { 'type'  : 'str' },
3223   'base': 'ChardevCommon' }
3226 # @ChardevSpicePort:
3228 # Configuration info for spice port chardevs.
3230 # @fqdn: name of the channel (see docs/spice-port-fqdn.txt)
3232 # Since: 1.5
3234 { 'struct': 'ChardevSpicePort', 'data': { 'fqdn'  : 'str' },
3235   'base': 'ChardevCommon' }
3238 # @ChardevVC:
3240 # Configuration info for virtual console chardevs.
3242 # @width:  console width,  in pixels
3243 # @height: console height, in pixels
3244 # @cols:   console width,  in chars
3245 # @rows:   console height, in chars
3247 # Since: 1.5
3249 { 'struct': 'ChardevVC', 'data': { '*width'  : 'int',
3250                                  '*height' : 'int',
3251                                  '*cols'   : 'int',
3252                                  '*rows'   : 'int' },
3253   'base': 'ChardevCommon' }
3256 # @ChardevRingbuf:
3258 # Configuration info for ring buffer chardevs.
3260 # @size: #optional ring buffer size, must be power of two, default is 65536
3262 # Since: 1.5
3264 { 'struct': 'ChardevRingbuf', 'data': { '*size'  : 'int' },
3265   'base': 'ChardevCommon' }
3268 # @ChardevBackend:
3270 # Configuration info for the new chardev backend.
3272 # Since: 1.4 (testdev since 2.2)
3274 { 'struct': 'ChardevDummy', 'data': { },
3275   'base': 'ChardevCommon' }
3277 { 'union': 'ChardevBackend', 'data': { 'file'   : 'ChardevFile',
3278                                        'serial' : 'ChardevHostdev',
3279                                        'parallel': 'ChardevHostdev',
3280                                        'pipe'   : 'ChardevHostdev',
3281                                        'socket' : 'ChardevSocket',
3282                                        'udp'    : 'ChardevUdp',
3283                                        'pty'    : 'ChardevDummy',
3284                                        'null'   : 'ChardevDummy',
3285                                        'mux'    : 'ChardevMux',
3286                                        'msmouse': 'ChardevDummy',
3287                                        'braille': 'ChardevDummy',
3288                                        'testdev': 'ChardevDummy',
3289                                        'stdio'  : 'ChardevStdio',
3290                                        'console': 'ChardevDummy',
3291                                        'spicevmc' : 'ChardevSpiceChannel',
3292                                        'spiceport' : 'ChardevSpicePort',
3293                                        'vc'     : 'ChardevVC',
3294                                        'ringbuf': 'ChardevRingbuf',
3295                                        # next one is just for compatibility
3296                                        'memory' : 'ChardevRingbuf' } }
3299 # @ChardevReturn:
3301 # Return info about the chardev backend just created.
3303 # @pty: #optional name of the slave pseudoterminal device, present if
3304 #       and only if a chardev of type 'pty' was created
3306 # Since: 1.4
3308 { 'struct' : 'ChardevReturn', 'data': { '*pty' : 'str' } }
3311 # @chardev-add:
3313 # Add a character device backend
3315 # @id: the chardev's ID, must be unique
3316 # @backend: backend type and parameters
3318 # Returns: ChardevReturn.
3320 # Since: 1.4
3322 { 'command': 'chardev-add', 'data': {'id'      : 'str',
3323                                      'backend' : 'ChardevBackend' },
3324   'returns': 'ChardevReturn' }
3327 # @chardev-remove:
3329 # Remove a character device backend
3331 # @id: the chardev's ID, must exist and not be in use
3333 # Returns: Nothing on success
3335 # Since: 1.4
3337 { 'command': 'chardev-remove', 'data': {'id': 'str'} }
3340 # @TpmModel:
3342 # An enumeration of TPM models
3344 # @tpm-tis: TPM TIS model
3346 # Since: 1.5
3348 { 'enum': 'TpmModel', 'data': [ 'tpm-tis' ] }
3351 # @query-tpm-models:
3353 # Return a list of supported TPM models
3355 # Returns: a list of TpmModel
3357 # Since: 1.5
3359 { 'command': 'query-tpm-models', 'returns': ['TpmModel'] }
3362 # @TpmType:
3364 # An enumeration of TPM types
3366 # @passthrough: TPM passthrough type
3368 # Since: 1.5
3370 { 'enum': 'TpmType', 'data': [ 'passthrough' ] }
3373 # @query-tpm-types:
3375 # Return a list of supported TPM types
3377 # Returns: a list of TpmType
3379 # Since: 1.5
3381 { 'command': 'query-tpm-types', 'returns': ['TpmType'] }
3384 # @TPMPassthroughOptions:
3386 # Information about the TPM passthrough type
3388 # @path: #optional string describing the path used for accessing the TPM device
3390 # @cancel-path: #optional string showing the TPM's sysfs cancel file
3391 #               for cancellation of TPM commands while they are executing
3393 # Since: 1.5
3395 { 'struct': 'TPMPassthroughOptions', 'data': { '*path' : 'str',
3396                                              '*cancel-path' : 'str'} }
3399 # @TpmTypeOptions:
3401 # A union referencing different TPM backend types' configuration options
3403 # @passthrough: The configuration options for the TPM passthrough type
3405 # Since: 1.5
3407 { 'union': 'TpmTypeOptions',
3408    'data': { 'passthrough' : 'TPMPassthroughOptions' } }
3411 # @TpmInfo:
3413 # Information about the TPM
3415 # @id: The Id of the TPM
3417 # @model: The TPM frontend model
3419 # @options: The TPM (backend) type configuration options
3421 # Since: 1.5
3423 { 'struct': 'TPMInfo',
3424   'data': {'id': 'str',
3425            'model': 'TpmModel',
3426            'options': 'TpmTypeOptions' } }
3429 # @query-tpm:
3431 # Return information about the TPM device
3433 # Returns: @TPMInfo on success
3435 # Since: 1.5
3437 { 'command': 'query-tpm', 'returns': ['TPMInfo'] }
3440 # @AcpiTableOptions
3442 # Specify an ACPI table on the command line to load.
3444 # At most one of @file and @data can be specified. The list of files specified
3445 # by any one of them is loaded and concatenated in order. If both are omitted,
3446 # @data is implied.
3448 # Other fields / optargs can be used to override fields of the generic ACPI
3449 # table header; refer to the ACPI specification 5.0, section 5.2.6 System
3450 # Description Table Header. If a header field is not overridden, then the
3451 # corresponding value from the concatenated blob is used (in case of @file), or
3452 # it is filled in with a hard-coded value (in case of @data).
3454 # String fields are copied into the matching ACPI member from lowest address
3455 # upwards, and silently truncated / NUL-padded to length.
3457 # @sig: #optional table signature / identifier (4 bytes)
3459 # @rev: #optional table revision number (dependent on signature, 1 byte)
3461 # @oem_id: #optional OEM identifier (6 bytes)
3463 # @oem_table_id: #optional OEM table identifier (8 bytes)
3465 # @oem_rev: #optional OEM-supplied revision number (4 bytes)
3467 # @asl_compiler_id: #optional identifier of the utility that created the table
3468 #                   (4 bytes)
3470 # @asl_compiler_rev: #optional revision number of the utility that created the
3471 #                    table (4 bytes)
3473 # @file: #optional colon (:) separated list of pathnames to load and
3474 #        concatenate as table data. The resultant binary blob is expected to
3475 #        have an ACPI table header. At least one file is required. This field
3476 #        excludes @data.
3478 # @data: #optional colon (:) separated list of pathnames to load and
3479 #        concatenate as table data. The resultant binary blob must not have an
3480 #        ACPI table header. At least one file is required. This field excludes
3481 #        @file.
3483 # Since 1.5
3485 { 'struct': 'AcpiTableOptions',
3486   'data': {
3487     '*sig':               'str',
3488     '*rev':               'uint8',
3489     '*oem_id':            'str',
3490     '*oem_table_id':      'str',
3491     '*oem_rev':           'uint32',
3492     '*asl_compiler_id':   'str',
3493     '*asl_compiler_rev':  'uint32',
3494     '*file':              'str',
3495     '*data':              'str' }}
3498 # @CommandLineParameterType:
3500 # Possible types for an option parameter.
3502 # @string: accepts a character string
3504 # @boolean: accepts "on" or "off"
3506 # @number: accepts a number
3508 # @size: accepts a number followed by an optional suffix (K)ilo,
3509 #        (M)ega, (G)iga, (T)era
3511 # Since 1.5
3513 { 'enum': 'CommandLineParameterType',
3514   'data': ['string', 'boolean', 'number', 'size'] }
3517 # @CommandLineParameterInfo:
3519 # Details about a single parameter of a command line option.
3521 # @name: parameter name
3523 # @type: parameter @CommandLineParameterType
3525 # @help: #optional human readable text string, not suitable for parsing.
3527 # @default: #optional default value string (since 2.1)
3529 # Since 1.5
3531 { 'struct': 'CommandLineParameterInfo',
3532   'data': { 'name': 'str',
3533             'type': 'CommandLineParameterType',
3534             '*help': 'str',
3535             '*default': 'str' } }
3538 # @CommandLineOptionInfo:
3540 # Details about a command line option, including its list of parameter details
3542 # @option: option name
3544 # @parameters: an array of @CommandLineParameterInfo
3546 # Since 1.5
3548 { 'struct': 'CommandLineOptionInfo',
3549   'data': { 'option': 'str', 'parameters': ['CommandLineParameterInfo'] } }
3552 # @query-command-line-options:
3554 # Query command line option schema.
3556 # @option: #optional option name
3558 # Returns: list of @CommandLineOptionInfo for all options (or for the given
3559 #          @option).  Returns an error if the given @option doesn't exist.
3561 # Since 1.5
3563 {'command': 'query-command-line-options', 'data': { '*option': 'str' },
3564  'returns': ['CommandLineOptionInfo'] }
3567 # @X86CPURegister32
3569 # A X86 32-bit register
3571 # Since: 1.5
3573 { 'enum': 'X86CPURegister32',
3574   'data': [ 'EAX', 'EBX', 'ECX', 'EDX', 'ESP', 'EBP', 'ESI', 'EDI' ] }
3577 # @X86CPUFeatureWordInfo
3579 # Information about a X86 CPU feature word
3581 # @cpuid-input-eax: Input EAX value for CPUID instruction for that feature word
3583 # @cpuid-input-ecx: #optional Input ECX value for CPUID instruction for that
3584 #                   feature word
3586 # @cpuid-register: Output register containing the feature bits
3588 # @features: value of output register, containing the feature bits
3590 # Since: 1.5
3592 { 'struct': 'X86CPUFeatureWordInfo',
3593   'data': { 'cpuid-input-eax': 'int',
3594             '*cpuid-input-ecx': 'int',
3595             'cpuid-register': 'X86CPURegister32',
3596             'features': 'int' } }
3599 # @DummyForceArrays
3601 # Not used by QMP; hack to let us use X86CPUFeatureWordInfoList internally
3603 # Since 2.5
3605 { 'struct': 'DummyForceArrays',
3606   'data': { 'unused': ['X86CPUFeatureWordInfo'] } }
3610 # @RxState:
3612 # Packets receiving state
3614 # @normal: filter assigned packets according to the mac-table
3616 # @none: don't receive any assigned packet
3618 # @all: receive all assigned packets
3620 # Since: 1.6
3622 { 'enum': 'RxState', 'data': [ 'normal', 'none', 'all' ] }
3625 # @RxFilterInfo:
3627 # Rx-filter information for a NIC.
3629 # @name: net client name
3631 # @promiscuous: whether promiscuous mode is enabled
3633 # @multicast: multicast receive state
3635 # @unicast: unicast receive state
3637 # @vlan: vlan receive state (Since 2.0)
3639 # @broadcast-allowed: whether to receive broadcast
3641 # @multicast-overflow: multicast table is overflowed or not
3643 # @unicast-overflow: unicast table is overflowed or not
3645 # @main-mac: the main macaddr string
3647 # @vlan-table: a list of active vlan id
3649 # @unicast-table: a list of unicast macaddr string
3651 # @multicast-table: a list of multicast macaddr string
3653 # Since 1.6
3656 { 'struct': 'RxFilterInfo',
3657   'data': {
3658     'name':               'str',
3659     'promiscuous':        'bool',
3660     'multicast':          'RxState',
3661     'unicast':            'RxState',
3662     'vlan':               'RxState',
3663     'broadcast-allowed':  'bool',
3664     'multicast-overflow': 'bool',
3665     'unicast-overflow':   'bool',
3666     'main-mac':           'str',
3667     'vlan-table':         ['int'],
3668     'unicast-table':      ['str'],
3669     'multicast-table':    ['str'] }}
3672 # @query-rx-filter:
3674 # Return rx-filter information for all NICs (or for the given NIC).
3676 # @name: #optional net client name
3678 # Returns: list of @RxFilterInfo for all NICs (or for the given NIC).
3679 #          Returns an error if the given @name doesn't exist, or given
3680 #          NIC doesn't support rx-filter querying, or given net client
3681 #          isn't a NIC.
3683 # Since: 1.6
3685 { 'command': 'query-rx-filter', 'data': { '*name': 'str' },
3686   'returns': ['RxFilterInfo'] }
3689 # @InputButton
3691 # Button of a pointer input device (mouse, tablet).
3693 # Since: 2.0
3695 # Note that the spelling of these values may change when the
3696 # x-input-send-event is promoted out of experimental status.
3698 { 'enum'  : 'InputButton',
3699   'data'  : [ 'Left', 'Middle', 'Right', 'WheelUp', 'WheelDown' ] }
3702 # @InputAxis
3704 # Position axis of a pointer input device (mouse, tablet).
3706 # Since: 2.0
3708 # Note that the spelling of these values may change when the
3709 # x-input-send-event is promoted out of experimental status.
3711 { 'enum'  : 'InputAxis',
3712   'data'  : [ 'X', 'Y' ] }
3715 # @InputKeyEvent
3717 # Keyboard input event.
3719 # @key:    Which key this event is for.
3720 # @down:   True for key-down and false for key-up events.
3722 # Since: 2.0
3724 { 'struct'  : 'InputKeyEvent',
3725   'data'  : { 'key'     : 'KeyValue',
3726               'down'    : 'bool' } }
3729 # @InputBtnEvent
3731 # Pointer button input event.
3733 # @button: Which button this event is for.
3734 # @down:   True for key-down and false for key-up events.
3736 # Since: 2.0
3738 { 'struct'  : 'InputBtnEvent',
3739   'data'  : { 'button'  : 'InputButton',
3740               'down'    : 'bool' } }
3743 # @InputMoveEvent
3745 # Pointer motion input event.
3747 # @axis:   Which axis is referenced by @value.
3748 # @value:  Pointer position.  For absolute coordinates the
3749 #          valid range is 0 -> 0x7ffff
3751 # Since: 2.0
3753 { 'struct'  : 'InputMoveEvent',
3754   'data'  : { 'axis'    : 'InputAxis',
3755               'value'   : 'int' } }
3758 # @InputEvent
3760 # Input event union.
3762 # @key: Input event of Keyboard
3763 # @btn: Input event of pointer buttons
3764 # @rel: Input event of relative pointer motion
3765 # @abs: Input event of absolute pointer motion
3767 # Since: 2.0
3769 { 'union' : 'InputEvent',
3770   'data'  : { 'key'     : 'InputKeyEvent',
3771               'btn'     : 'InputBtnEvent',
3772               'rel'     : 'InputMoveEvent',
3773               'abs'     : 'InputMoveEvent' } }
3776 # @x-input-send-event
3778 # Send input event(s) to guest.
3780 # @console: #optional console to send event(s) to.
3781 #           This parameter can be used to send the input event to
3782 #           specific input devices in case (a) multiple input devices
3783 #           of the same kind are added to the virtual machine and (b)
3784 #           you have configured input routing (see docs/multiseat.txt)
3785 #           for those input devices.  If input routing is not
3786 #           configured this parameter has no effect.
3787 #           If @console is missing, only devices that aren't associated
3788 #           with a console are admissible.
3789 #           If @console is specified, it must exist, and both devices
3790 #           associated with that console and devices not associated with a
3791 #           console are admissible, but the former take precedence.
3794 # @events: List of InputEvent union.
3796 # Returns: Nothing on success.
3798 # Since: 2.2
3800 # Note: this command is experimental, and not a stable API.  Things that
3801 # might change before it becomes stable include the spelling of enum
3802 # values for InputButton and InputAxis, and the notion of how to designate
3803 # which console will receive the event.
3806 { 'command': 'x-input-send-event',
3807   'data': { '*console':'int', 'events': [ 'InputEvent' ] } }
3810 # @NumaOptions
3812 # A discriminated record of NUMA options. (for OptsVisitor)
3814 # Since 2.1
3816 { 'union': 'NumaOptions',
3817   'data': {
3818     'node': 'NumaNodeOptions' }}
3821 # @NumaNodeOptions
3823 # Create a guest NUMA node. (for OptsVisitor)
3825 # @nodeid: #optional NUMA node ID (increase by 1 from 0 if omitted)
3827 # @cpus: #optional VCPUs belonging to this node (assign VCPUS round-robin
3828 #         if omitted)
3830 # @mem: #optional memory size of this node; mutually exclusive with @memdev.
3831 #       Equally divide total memory among nodes if both @mem and @memdev are
3832 #       omitted.
3834 # @memdev: #optional memory backend object.  If specified for one node,
3835 #          it must be specified for all nodes.
3837 # Since: 2.1
3839 { 'struct': 'NumaNodeOptions',
3840   'data': {
3841    '*nodeid': 'uint16',
3842    '*cpus':   ['uint16'],
3843    '*mem':    'size',
3844    '*memdev': 'str' }}
3847 # @HostMemPolicy
3849 # Host memory policy types
3851 # @default: restore default policy, remove any nondefault policy
3853 # @preferred: set the preferred host nodes for allocation
3855 # @bind: a strict policy that restricts memory allocation to the
3856 #        host nodes specified
3858 # @interleave: memory allocations are interleaved across the set
3859 #              of host nodes specified
3861 # Since 2.1
3863 { 'enum': 'HostMemPolicy',
3864   'data': [ 'default', 'preferred', 'bind', 'interleave' ] }
3867 # @Memdev:
3869 # Information about memory backend
3871 # @size: memory backend size
3873 # @merge: enables or disables memory merge support
3875 # @dump: includes memory backend's memory in a core dump or not
3877 # @prealloc: enables or disables memory preallocation
3879 # @host-nodes: host nodes for its memory policy
3881 # @policy: memory policy of memory backend
3883 # Since: 2.1
3886 { 'struct': 'Memdev',
3887   'data': {
3888     'size':       'size',
3889     'merge':      'bool',
3890     'dump':       'bool',
3891     'prealloc':   'bool',
3892     'host-nodes': ['uint16'],
3893     'policy':     'HostMemPolicy' }}
3896 # @query-memdev:
3898 # Returns information for all memory backends.
3900 # Returns: a list of @Memdev.
3902 # Since: 2.1
3904 { 'command': 'query-memdev', 'returns': ['Memdev'] }
3907 # @PCDIMMDeviceInfo:
3909 # PCDIMMDevice state information
3911 # @id: #optional device's ID
3913 # @addr: physical address, where device is mapped
3915 # @size: size of memory that the device provides
3917 # @slot: slot number at which device is plugged in
3919 # @node: NUMA node number where device is plugged in
3921 # @memdev: memory backend linked with device
3923 # @hotplugged: true if device was hotplugged
3925 # @hotpluggable: true if device if could be added/removed while machine is running
3927 # Since: 2.1
3929 { 'struct': 'PCDIMMDeviceInfo',
3930   'data': { '*id': 'str',
3931             'addr': 'int',
3932             'size': 'int',
3933             'slot': 'int',
3934             'node': 'int',
3935             'memdev': 'str',
3936             'hotplugged': 'bool',
3937             'hotpluggable': 'bool'
3938           }
3942 # @MemoryDeviceInfo:
3944 # Union containing information about a memory device
3946 # Since: 2.1
3948 { 'union': 'MemoryDeviceInfo', 'data': {'dimm': 'PCDIMMDeviceInfo'} }
3951 # @query-memory-devices
3953 # Lists available memory devices and their state
3955 # Since: 2.1
3957 { 'command': 'query-memory-devices', 'returns': ['MemoryDeviceInfo'] }
3959 ## @ACPISlotType
3961 # @DIMM: memory slot
3963 { 'enum': 'ACPISlotType', 'data': [ 'DIMM' ] }
3965 ## @ACPIOSTInfo
3967 # OSPM Status Indication for a device
3968 # For description of possible values of @source and @status fields
3969 # see "_OST (OSPM Status Indication)" chapter of ACPI5.0 spec.
3971 # @device: #optional device ID associated with slot
3973 # @slot: slot ID, unique per slot of a given @slot-type
3975 # @slot-type: type of the slot
3977 # @source: an integer containing the source event
3979 # @status: an integer containing the status code
3981 # Since: 2.1
3983 { 'struct': 'ACPIOSTInfo',
3984   'data'  : { '*device': 'str',
3985               'slot': 'str',
3986               'slot-type': 'ACPISlotType',
3987               'source': 'int',
3988               'status': 'int' } }
3991 # @query-acpi-ospm-status
3993 # Lists ACPI OSPM status of ACPI device objects,
3994 # which might be reported via _OST method
3996 # Since: 2.1
3998 { 'command': 'query-acpi-ospm-status', 'returns': ['ACPIOSTInfo'] }
4001 # @WatchdogExpirationAction
4003 # An enumeration of the actions taken when the watchdog device's timer is
4004 # expired
4006 # @reset: system resets
4008 # @shutdown: system shutdown, note that it is similar to @powerdown, which
4009 #            tries to set to system status and notify guest
4011 # @poweroff: system poweroff, the emulator program exits
4013 # @pause: system pauses, similar to @stop
4015 # @debug: system enters debug state
4017 # @none: nothing is done
4019 # @inject-nmi: a non-maskable interrupt is injected into the first VCPU (all
4020 #              VCPUS on x86) (since 2.4)
4022 # Since: 2.1
4024 { 'enum': 'WatchdogExpirationAction',
4025   'data': [ 'reset', 'shutdown', 'poweroff', 'pause', 'debug', 'none',
4026             'inject-nmi' ] }
4029 # @IoOperationType
4031 # An enumeration of the I/O operation types
4033 # @read: read operation
4035 # @write: write operation
4037 # Since: 2.1
4039 { 'enum': 'IoOperationType',
4040   'data': [ 'read', 'write' ] }
4043 # @GuestPanicAction
4045 # An enumeration of the actions taken when guest OS panic is detected
4047 # @pause: system pauses
4049 # Since: 2.1
4051 { 'enum': 'GuestPanicAction',
4052   'data': [ 'pause' ] }
4055 # @rtc-reset-reinjection
4057 # This command will reset the RTC interrupt reinjection backlog.
4058 # Can be used if another mechanism to synchronize guest time
4059 # is in effect, for example QEMU guest agent's guest-set-time
4060 # command.
4062 # Since: 2.1
4064 { 'command': 'rtc-reset-reinjection' }
4066 # Rocker ethernet network switch
4067 { 'include': 'qapi/rocker.json' }
4070 # ReplayMode:
4072 # Mode of the replay subsystem.
4074 # @none: normal execution mode. Replay or record are not enabled.
4076 # @record: record mode. All non-deterministic data is written into the
4077 #          replay log.
4079 # @play: replay mode. Non-deterministic data required for system execution
4080 #        is read from the log.
4082 # Since: 2.5
4084 { 'enum': 'ReplayMode',
4085   'data': [ 'none', 'record', 'play' ] }