pseries: Update SLOF firmware image
[qemu/opensuse.git] / qapi-schema.json
blob04fa84fbde56a4340a0763fe678cfd90bb429a5f
1 # -*- Mode: Python -*-
3 # QAPI Schema
5 ##
6 # @NameInfo:
8 # Guest name information.
10 # @name: #optional The name of the guest
12 # Since 0.14.0
14 { 'type': 'NameInfo', 'data': {'*name': 'str'} }
17 # @query-name:
19 # Return the name information of a guest.
21 # Returns: @NameInfo of the guest
23 # Since 0.14.0
25 { 'command': 'query-name', 'returns': 'NameInfo' }
28 # @VersionInfo:
30 # A description of QEMU's version.
32 # @qemu.major:  The major version of QEMU
34 # @qemu.minor:  The minor version of QEMU
36 # @qemu.micro:  The micro version of QEMU.  By current convention, a micro
37 #               version of 50 signifies a development branch.  A micro version
38 #               greater than or equal to 90 signifies a release candidate for
39 #               the next minor version.  A micro version of less than 50
40 #               signifies a stable release.
42 # @package:     QEMU will always set this field to an empty string.  Downstream
43 #               versions of QEMU should set this to a non-empty string.  The
44 #               exact format depends on the downstream however it highly
45 #               recommended that a unique name is used.
47 # Since: 0.14.0
49 { 'type': 'VersionInfo',
50   'data': {'qemu': {'major': 'int', 'minor': 'int', 'micro': 'int'},
51            'package': 'str'} }
54 # @query-version:
56 # Returns the current version of QEMU.
58 # Returns:  A @VersionInfo object describing the current version of QEMU.
60 # Since: 0.14.0
62 { 'command': 'query-version', 'returns': 'VersionInfo' }
65 # @KvmInfo:
67 # Information about support for KVM acceleration
69 # @enabled: true if KVM acceleration is active
71 # @present: true if KVM acceleration is built into this executable
73 # Since: 0.14.0
75 { 'type': 'KvmInfo', 'data': {'enabled': 'bool', 'present': 'bool'} }
78 # @query-kvm:
80 # Returns information about KVM acceleration
82 # Returns: @KvmInfo
84 # Since: 0.14.0
86 { 'command': 'query-kvm', 'returns': 'KvmInfo' }
89 # @RunState
91 # An enumation of VM run states.
93 # @debug: QEMU is running on a debugger
95 # @inmigrate: guest is paused waiting for an incoming migration
97 # @internal-error: An internal error that prevents further guest execution
98 # has occurred
100 # @io-error: the last IOP has failed and the device is configured to pause
101 # on I/O errors
103 # @paused: guest has been paused via the 'stop' command
105 # @postmigrate: guest is paused following a successful 'migrate'
107 # @prelaunch: QEMU was started with -S and guest has not started
109 # @finish-migrate: guest is paused to finish the migration process
111 # @restore-vm: guest is paused to restore VM state
113 # @running: guest is actively running
115 # @save-vm: guest is paused to save the VM state
117 # @shutdown: guest is shut down (and -no-shutdown is in use)
119 # @watchdog: the watchdog action is configured to pause and has been triggered
121 { 'enum': 'RunState',
122   'data': [ 'debug', 'inmigrate', 'internal-error', 'io-error', 'paused',
123             'postmigrate', 'prelaunch', 'finish-migrate', 'restore-vm',
124             'running', 'save-vm', 'shutdown', 'watchdog' ] }
127 # @StatusInfo:
129 # Information about VCPU run state
131 # @running: true if all VCPUs are runnable, false if not runnable
133 # @singlestep: true if VCPUs are in single-step mode
135 # @status: the virtual machine @RunState
137 # Since:  0.14.0
139 # Notes: @singlestep is enabled through the GDB stub
141 { 'type': 'StatusInfo',
142   'data': {'running': 'bool', 'singlestep': 'bool', 'status': 'RunState'} }
145 # @query-status:
147 # Query the run status of all VCPUs
149 # Returns: @StatusInfo reflecting all VCPUs
151 # Since:  0.14.0
153 { 'command': 'query-status', 'returns': 'StatusInfo' }
156 # @UuidInfo:
158 # Guest UUID information.
160 # @UUID: the UUID of the guest
162 # Since: 0.14.0
164 # Notes: If no UUID was specified for the guest, a null UUID is returned.
166 { 'type': 'UuidInfo', 'data': {'UUID': 'str'} }
169 # @query-uuid:
171 # Query the guest UUID information.
173 # Returns: The @UuidInfo for the guest
175 # Since 0.14.0
177 { 'command': 'query-uuid', 'returns': 'UuidInfo' }
180 # @ChardevInfo:
182 # Information about a character device.
184 # @label: the label of the character device
186 # @filename: the filename of the character device
188 # Notes: @filename is encoded using the QEMU command line character device
189 #        encoding.  See the QEMU man page for details.
191 # Since: 0.14.0
193 { 'type': 'ChardevInfo', 'data': {'label': 'str', 'filename': 'str'} }
196 # @query-chardev:
198 # Returns information about current character devices.
200 # Returns: a list of @ChardevInfo
202 # Since: 0.14.0
204 { 'command': 'query-chardev', 'returns': ['ChardevInfo'] }
207 # @CommandInfo:
209 # Information about a QMP command
211 # @name: The command name
213 # Since: 0.14.0
215 { 'type': 'CommandInfo', 'data': {'name': 'str'} }
218 # @query-commands:
220 # Return a list of supported QMP commands by this server
222 # Returns: A list of @CommandInfo for all supported commands
224 # Since: 0.14.0
226 { 'command': 'query-commands', 'returns': ['CommandInfo'] }
229 # @MigrationStats
231 # Detailed migration status.
233 # @transferred: amount of bytes already transferred to the target VM
235 # @remaining: amount of bytes remaining to be transferred to the target VM
237 # @total: total amount of bytes involved in the migration process
239 # Since: 0.14.0.
241 { 'type': 'MigrationStats',
242   'data': {'transferred': 'int', 'remaining': 'int', 'total': 'int' } }
245 # @MigrationInfo
247 # Information about current migration process.
249 # @status: #optional string describing the current migration status.
250 #          As of 0.14.0 this can be 'active', 'completed', 'failed' or
251 #          'cancelled'. If this field is not returned, no migration process
252 #          has been initiated
254 # @ram: #optional @MigrationStats containing detailed migration status,
255 #       only returned if status is 'active'
257 # @disk: #optional @MigrationStats containing detailed disk migration
258 #        status, only returned if status is 'active' and it is a block
259 #        migration
261 # Since: 0.14.0
263 { 'type': 'MigrationInfo',
264   'data': {'*status': 'str', '*ram': 'MigrationStats',
265            '*disk': 'MigrationStats'} }
268 # @query-migrate
270 # Returns information about current migration process.
272 # Returns: @MigrationInfo
274 # Since: 0.14.0
276 { 'command': 'query-migrate', 'returns': 'MigrationInfo' }
279 # @MouseInfo:
281 # Information about a mouse device.
283 # @name: the name of the mouse device
285 # @index: the index of the mouse device
287 # @current: true if this device is currently receiving mouse events
289 # @absolute: true if this device supports absolute coordinates as input
291 # Since: 0.14.0
293 { 'type': 'MouseInfo',
294   'data': {'name': 'str', 'index': 'int', 'current': 'bool',
295            'absolute': 'bool'} }
298 # @query-mice:
300 # Returns information about each active mouse device
302 # Returns: a list of @MouseInfo for each device
304 # Since: 0.14.0
306 { 'command': 'query-mice', 'returns': ['MouseInfo'] }
309 # @CpuInfo:
311 # Information about a virtual CPU
313 # @CPU: the index of the virtual CPU
315 # @current: this only exists for backwards compatible and should be ignored
317 # @halted: true if the virtual CPU is in the halt state.  Halt usually refers
318 #          to a processor specific low power mode.
320 # @pc: #optional If the target is i386 or x86_64, this is the 64-bit instruction
321 #                pointer.
322 #                If the target is Sparc, this is the PC component of the
323 #                instruction pointer.
325 # @nip: #optional If the target is PPC, the instruction pointer
327 # @npc: #optional If the target is Sparc, the NPC component of the instruction
328 #                 pointer
330 # @PC: #optional If the target is MIPS, the instruction pointer
332 # @thread_id: ID of the underlying host thread
334 # Since: 0.14.0
336 # Notes: @halted is a transient state that changes frequently.  By the time the
337 #        data is sent to the client, the guest may no longer be halted.
339 { 'type': 'CpuInfo',
340   'data': {'CPU': 'int', 'current': 'bool', 'halted': 'bool', '*pc': 'int',
341            '*nip': 'int', '*npc': 'int', '*PC': 'int', 'thread_id': 'int'} }
344 # @query-cpus:
346 # Returns a list of information about each virtual CPU.
348 # Returns: a list of @CpuInfo for each virtual CPU
350 # Since: 0.14.0
352 { 'command': 'query-cpus', 'returns': ['CpuInfo'] }
355 # @BlockDeviceInfo:
357 # Information about the backing device for a block device.
359 # @file: the filename of the backing device
361 # @ro: true if the backing device was open read-only
363 # @drv: the name of the block format used to open the backing device. As of
364 #       0.14.0 this can be: 'blkdebug', 'bochs', 'cloop', 'cow', 'dmg',
365 #       'file', 'file', 'ftp', 'ftps', 'host_cdrom', 'host_device',
366 #       'host_floppy', 'http', 'https', 'nbd', 'parallels', 'qcow',
367 #       'qcow2', 'raw', 'tftp', 'vdi', 'vmdk', 'vpc', 'vvfat'
369 # @backing_file: #optional the name of the backing file (for copy-on-write)
371 # @encrypted: true if the backing device is encrypted
373 # @bps: total throughput limit in bytes per second is specified
375 # @bps_rd: read throughput limit in bytes per second is specified
377 # @bps_wr: write throughput limit in bytes per second is specified
379 # @iops: total I/O operations per second is specified
381 # @iops_rd: read I/O operations per second is specified
383 # @iops_wr: write I/O operations per second is specified
385 # Since: 0.14.0
387 # Notes: This interface is only found in @BlockInfo.
389 { 'type': 'BlockDeviceInfo',
390   'data': { 'file': 'str', 'ro': 'bool', 'drv': 'str',
391             '*backing_file': 'str', 'encrypted': 'bool',
392             'bps': 'int', 'bps_rd': 'int', 'bps_wr': 'int',
393             'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int'} }
396 # @BlockDeviceIoStatus:
398 # An enumeration of block device I/O status.
400 # @ok: The last I/O operation has succeeded
402 # @failed: The last I/O operation has failed
404 # @nospace: The last I/O operation has failed due to a no-space condition
406 # Since: 1.0
408 { 'enum': 'BlockDeviceIoStatus', 'data': [ 'ok', 'failed', 'nospace' ] }
411 # @BlockInfo:
413 # Block device information.  This structure describes a virtual device and
414 # the backing device associated with it.
416 # @device: The device name associated with the virtual device.
418 # @type: This field is returned only for compatibility reasons, it should
419 #        not be used (always returns 'unknown')
421 # @removable: True if the device supports removable media.
423 # @locked: True if the guest has locked this device from having its media
424 #          removed
426 # @tray_open: #optional True if the device has a tray and it is open
427 #             (only present if removable is true)
429 # @io-status: #optional @BlockDeviceIoStatus. Only present if the device
430 #             supports it and the VM is configured to stop on errors
432 # @inserted: #optional @BlockDeviceInfo describing the device if media is
433 #            present
435 # Since:  0.14.0
437 { 'type': 'BlockInfo',
438   'data': {'device': 'str', 'type': 'str', 'removable': 'bool',
439            'locked': 'bool', '*inserted': 'BlockDeviceInfo',
440            '*tray_open': 'bool', '*io-status': 'BlockDeviceIoStatus'} }
443 # @query-block:
445 # Get a list of BlockInfo for all virtual block devices.
447 # Returns: a list of @BlockInfo describing each virtual block device
449 # Since: 0.14.0
451 { 'command': 'query-block', 'returns': ['BlockInfo'] }
454 # @BlockDeviceStats:
456 # Statistics of a virtual block device or a block backing device.
458 # @rd_bytes:      The number of bytes read by the device.
460 # @wr_bytes:      The number of bytes written by the device.
462 # @rd_operations: The number of read operations performed by the device.
464 # @wr_operations: The number of write operations performed by the device.
466 # @flush_operations: The number of cache flush operations performed by the
467 #                    device (since 0.15.0)
469 # @flush_total_time_ns: Total time spend on cache flushes in nano-seconds
470 #                       (since 0.15.0).
472 # @wr_total_time_ns: Total time spend on writes in nano-seconds (since 0.15.0).
474 # @rd_total_time_ns: Total_time_spend on reads in nano-seconds (since 0.15.0).
476 # @wr_highest_offset: The offset after the greatest byte written to the
477 #                     device.  The intended use of this information is for
478 #                     growable sparse files (like qcow2) that are used on top
479 #                     of a physical device.
481 # Since: 0.14.0
483 { 'type': 'BlockDeviceStats',
484   'data': {'rd_bytes': 'int', 'wr_bytes': 'int', 'rd_operations': 'int',
485            'wr_operations': 'int', 'flush_operations': 'int',
486            'flush_total_time_ns': 'int', 'wr_total_time_ns': 'int',
487            'rd_total_time_ns': 'int', 'wr_highest_offset': 'int' } }
490 # @BlockStats:
492 # Statistics of a virtual block device or a block backing device.
494 # @device: #optional If the stats are for a virtual block device, the name
495 #          corresponding to the virtual block device.
497 # @stats:  A @BlockDeviceStats for the device.
499 # @parent: #optional This may point to the backing block device if this is a
500 #          a virtual block device.  If it's a backing block, this will point
501 #          to the backing file is one is present.
503 # Since: 0.14.0
505 { 'type': 'BlockStats',
506   'data': {'*device': 'str', 'stats': 'BlockDeviceStats',
507            '*parent': 'BlockStats'} }
510 # @query-blockstats:
512 # Query the @BlockStats for all virtual block devices.
514 # Returns: A list of @BlockStats for each virtual block devices.
516 # Since: 0.14.0
518 { 'command': 'query-blockstats', 'returns': ['BlockStats'] }
521 # @VncClientInfo:
523 # Information about a connected VNC client.
525 # @host: The host name of the client.  QEMU tries to resolve this to a DNS name
526 #        when possible.
528 # @family: 'ipv6' if the client is connected via IPv6 and TCP
529 #          'ipv4' if the client is connected via IPv4 and TCP
530 #          'unix' if the client is connected via a unix domain socket
531 #          'unknown' otherwise
533 # @service: The service name of the client's port.  This may depends on the
534 #           host system's service database so symbolic names should not be
535 #           relied on.
537 # @x509_dname: #optional If x509 authentication is in use, the Distinguished
538 #              Name of the client.
540 # @sasl_username: #optional If SASL authentication is in use, the SASL username
541 #                 used for authentication.
543 # Since: 0.14.0
545 { 'type': 'VncClientInfo',
546   'data': {'host': 'str', 'family': 'str', 'service': 'str',
547            '*x509_dname': 'str', '*sasl_username': 'str'} }
550 # @VncInfo:
552 # Information about the VNC session.
554 # @enabled: true if the VNC server is enabled, false otherwise
556 # @host: #optional The hostname the VNC server is bound to.  This depends on
557 #        the name resolution on the host and may be an IP address.
559 # @family: #optional 'ipv6' if the host is listening for IPv6 connections
560 #                    'ipv4' if the host is listening for IPv4 connections
561 #                    'unix' if the host is listening on a unix domain socket
562 #                    'unknown' otherwise
564 # @service: #optional The service name of the server's port.  This may depends
565 #           on the host system's service database so symbolic names should not
566 #           be relied on.
568 # @auth: #optional the current authentication type used by the server
569 #        'none' if no authentication is being used
570 #        'vnc' if VNC authentication is being used
571 #        'vencrypt+plain' if VEncrypt is used with plain text authentication
572 #        'vencrypt+tls+none' if VEncrypt is used with TLS and no authentication
573 #        'vencrypt+tls+vnc' if VEncrypt is used with TLS and VNC authentication
574 #        'vencrypt+tls+plain' if VEncrypt is used with TLS and plain text auth
575 #        'vencrypt+x509+none' if VEncrypt is used with x509 and no auth
576 #        'vencrypt+x509+vnc' if VEncrypt is used with x509 and VNC auth
577 #        'vencrypt+x509+plain' if VEncrypt is used with x509 and plain text auth
578 #        'vencrypt+tls+sasl' if VEncrypt is used with TLS and SASL auth
579 #        'vencrypt+x509+sasl' if VEncrypt is used with x509 and SASL auth
581 # @clients: a list of @VncClientInfo of all currently connected clients
583 # Since: 0.14.0
585 { 'type': 'VncInfo',
586   'data': {'enabled': 'bool', '*host': 'str', '*family': 'str',
587            '*service': 'str', '*auth': 'str', '*clients': ['VncClientInfo']} }
590 # @query-vnc:
592 # Returns information about the current VNC server
594 # Returns: @VncInfo
595 #          If VNC support is not compiled in, FeatureDisabled
597 # Since: 0.14.0
599 { 'command': 'query-vnc', 'returns': 'VncInfo' }
602 # @SpiceChannel
604 # Information about a SPICE client channel.
606 # @host: The host name of the client.  QEMU tries to resolve this to a DNS name
607 #        when possible.
609 # @family: 'ipv6' if the client is connected via IPv6 and TCP
610 #          'ipv4' if the client is connected via IPv4 and TCP
611 #          'unix' if the client is connected via a unix domain socket
612 #          'unknown' otherwise
614 # @port: The client's port number.
616 # @connection-id: SPICE connection id number.  All channels with the same id
617 #                 belong to the same SPICE session.
619 # @connection-type: SPICE channel type number.  "1" is the main control
620 #                   channel, filter for this one if you want to track spice
621 #                   sessions only
623 # @channel-id: SPICE channel ID number.  Usually "0", might be different when
624 #              multiple channels of the same type exist, such as multiple
625 #              display channels in a multihead setup
627 # @tls: true if the channel is encrypted, false otherwise.
629 # Since: 0.14.0
631 { 'type': 'SpiceChannel',
632   'data': {'host': 'str', 'family': 'str', 'port': 'str',
633            'connection-id': 'int', 'channel-type': 'int', 'channel-id': 'int',
634            'tls': 'bool'} }
637 # @SpiceInfo
639 # Information about the SPICE session.
641 # @enabled: true if the SPICE server is enabled, false otherwise
643 # @host: #optional The hostname the SPICE server is bound to.  This depends on
644 #        the name resolution on the host and may be an IP address.
646 # @port: #optional The SPICE server's port number.
648 # @compiled-version: #optional SPICE server version.
650 # @tls-port: #optional The SPICE server's TLS port number.
652 # @auth: #optional the current authentication type used by the server
653 #        'none'  if no authentication is being used
654 #        'spice' uses SASL or direct TLS authentication, depending on command
655 #                line options
657 # @channels: a list of @SpiceChannel for each active spice channel
659 # Since: 0.14.0
661 { 'type': 'SpiceInfo',
662   'data': {'enabled': 'bool', '*host': 'str', '*port': 'int',
663            '*tls-port': 'int', '*auth': 'str', '*compiled-version': 'str',
664            '*channels': ['SpiceChannel']} }
667 # @query-spice
669 # Returns information about the current SPICE server
671 # Returns: @SpiceInfo
673 # Since: 0.14.0
675 { 'command': 'query-spice', 'returns': 'SpiceInfo' }
678 # @BalloonInfo:
680 # Information about the guest balloon device.
682 # @actual: the number of bytes the balloon currently contains
684 # @mem_swapped_in: #optional number of pages swapped in within the guest
686 # @mem_swapped_out: #optional number of pages swapped out within the guest
688 # @major_page_faults: #optional number of major page faults within the guest
690 # @minor_page_faults: #optional number of minor page faults within the guest
692 # @free_mem: #optional amount of memory (in bytes) free in the guest
694 # @total_mem: #optional amount of memory (in bytes) visible to the guest
696 # Since: 0.14.0
698 # Notes: all current versions of QEMU do not fill out optional information in
699 #        this structure.
701 { 'type': 'BalloonInfo',
702   'data': {'actual': 'int', '*mem_swapped_in': 'int',
703            '*mem_swapped_out': 'int', '*major_page_faults': 'int',
704            '*minor_page_faults': 'int', '*free_mem': 'int',
705            '*total_mem': 'int'} }
708 # @query-balloon:
710 # Return information about the balloon device.
712 # Returns: @BalloonInfo on success
713 #          If the balloon driver is enabled but not functional because the KVM
714 #          kernel module cannot support it, KvmMissingCap
715 #          If no balloon device is present, DeviceNotActive
717 # Since: 0.14.0
719 { 'command': 'query-balloon', 'returns': 'BalloonInfo' }
722 # @PciMemoryRange:
724 # A PCI device memory region
726 # @base: the starting address (guest physical)
728 # @limit: the ending address (guest physical)
730 # Since: 0.14.0
732 { 'type': 'PciMemoryRange', 'data': {'base': 'int', 'limit': 'int'} }
735 # @PciMemoryRegion
737 # Information about a PCI device I/O region.
739 # @bar: the index of the Base Address Register for this region
741 # @type: 'io' if the region is a PIO region
742 #        'memory' if the region is a MMIO region
744 # @prefetch: #optional if @type is 'memory', true if the memory is prefetchable
746 # @mem_type_64: #optional if @type is 'memory', true if the BAR is 64-bit
748 # Since: 0.14.0
750 { 'type': 'PciMemoryRegion',
751   'data': {'bar': 'int', 'type': 'str', 'address': 'int', 'size': 'int',
752            '*prefetch': 'bool', '*mem_type_64': 'bool' } }
755 # @PciBridgeInfo:
757 # Information about a PCI Bridge device
759 # @bus.number: primary bus interface number.  This should be the number of the
760 #              bus the device resides on.
762 # @bus.secondary: secondary bus interface number.  This is the number of the
763 #                 main bus for the bridge
765 # @bus.subordinate: This is the highest number bus that resides below the
766 #                   bridge.
768 # @bus.io_range: The PIO range for all devices on this bridge
770 # @bus.memory_range: The MMIO range for all devices on this bridge
772 # @bus.prefetchable_range: The range of prefetchable MMIO for all devices on
773 #                          this bridge
775 # @devices: a list of @PciDeviceInfo for each device on this bridge
777 # Since: 0.14.0
779 { 'type': 'PciBridgeInfo',
780   'data': {'bus': { 'number': 'int', 'secondary': 'int', 'subordinate': 'int',
781                     'io_range': 'PciMemoryRange',
782                     'memory_range': 'PciMemoryRange',
783                     'prefetchable_range': 'PciMemoryRange' },
784            '*devices': ['PciDeviceInfo']} }
787 # @PciDeviceInfo:
789 # Information about a PCI device
791 # @bus: the bus number of the device
793 # @slot: the slot the device is located in
795 # @function: the function of the slot used by the device
797 # @class_info.desc: #optional a string description of the device's class
799 # @class_info.class: the class code of the device
801 # @id.device: the PCI device id
803 # @id.vendor: the PCI vendor id
805 # @irq: #optional if an IRQ is assigned to the device, the IRQ number
807 # @qdev_id: the device name of the PCI device
809 # @pci_bridge: if the device is a PCI bridge, the bridge information
811 # @regions: a list of the PCI I/O regions associated with the device
813 # Notes: the contents of @class_info.desc are not stable and should only be
814 #        treated as informational.
816 # Since: 0.14.0
818 { 'type': 'PciDeviceInfo',
819   'data': {'bus': 'int', 'slot': 'int', 'function': 'int',
820            'class_info': {'*desc': 'str', 'class': 'int'},
821            'id': {'device': 'int', 'vendor': 'int'},
822            '*irq': 'int', 'qdev_id': 'str', '*pci_bridge': 'PciBridgeInfo',
823            'regions': ['PciMemoryRegion']} }
826 # @PciInfo:
828 # Information about a PCI bus
830 # @bus: the bus index
832 # @devices: a list of devices on this bus
834 # Since: 0.14.0
836 { 'type': 'PciInfo', 'data': {'bus': 'int', 'devices': ['PciDeviceInfo']} }
839 # @query-pci:
841 # Return information about the PCI bus topology of the guest.
843 # Returns: a list of @PciInfo for each PCI bus
845 # Since: 0.14.0
847 { 'command': 'query-pci', 'returns': ['PciInfo'] }
850 # @BlockJobInfo:
852 # Information about a long-running block device operation.
854 # @type: the job type ('stream' for image streaming)
856 # @device: the block device name
858 # @len: the maximum progress value
860 # @offset: the current progress value
862 # @speed: the rate limit, bytes per second
864 # Since: 1.1
866 { 'type': 'BlockJobInfo',
867   'data': {'type': 'str', 'device': 'str', 'len': 'int',
868            'offset': 'int', 'speed': 'int'} }
871 # @query-block-jobs:
873 # Return information about long-running block device operations.
875 # Returns: a list of @BlockJobInfo for each active block job
877 # Since: 1.1
879 { 'command': 'query-block-jobs', 'returns': ['BlockJobInfo'] }
882 # @quit:
884 # This command will cause the QEMU process to exit gracefully.  While every
885 # attempt is made to send the QMP response before terminating, this is not
886 # guaranteed.  When using this interface, a premature EOF would not be
887 # unexpected.
889 # Since: 0.14.0
891 { 'command': 'quit' }
894 # @stop:
896 # Stop all guest VCPU execution.
898 # Since:  0.14.0
900 # Notes:  This function will succeed even if the guest is already in the stopped
901 #         state
903 { 'command': 'stop' }
906 # @system_reset:
908 # Performs a hard reset of a guest.
910 # Since: 0.14.0
912 { 'command': 'system_reset' }
915 # @system_powerdown:
917 # Requests that a guest perform a powerdown operation.
919 # Since: 0.14.0
921 # Notes: A guest may or may not respond to this command.  This command
922 #        returning does not indicate that a guest has accepted the request or
923 #        that it has shut down.  Many guests will respond to this command by
924 #        prompting the user in some way.
926 { 'command': 'system_powerdown' }
929 # @cpu:
931 # This command is a nop that is only provided for the purposes of compatibility.
933 # Since: 0.14.0
935 # Notes: Do not use this command.
937 { 'command': 'cpu', 'data': {'index': 'int'} }
940 # @memsave:
942 # Save a portion of guest memory to a file.
944 # @val: the virtual address of the guest to start from
946 # @size: the size of memory region to save
948 # @filename: the file to save the memory to as binary data
950 # @cpu-index: #optional the index of the virtual CPU to use for translating the
951 #                       virtual address (defaults to CPU 0)
953 # Returns: Nothing on success
954 #          If @cpu is not a valid VCPU, InvalidParameterValue
955 #          If @filename cannot be opened, OpenFileFailed
956 #          If an I/O error occurs while writing the file, IOError
958 # Since: 0.14.0
960 # Notes: Errors were not reliably returned until 1.1
962 { 'command': 'memsave',
963   'data': {'val': 'int', 'size': 'int', 'filename': 'str', '*cpu-index': 'int'} }
966 # @pmemsave:
968 # Save a portion of guest physical memory to a file.
970 # @val: the physical address of the guest to start from
972 # @size: the size of memory region to save
974 # @filename: the file to save the memory to as binary data
976 # Returns: Nothing on success
977 #          If @filename cannot be opened, OpenFileFailed
978 #          If an I/O error occurs while writing the file, IOError
980 # Since: 0.14.0
982 # Notes: Errors were not reliably returned until 1.1
984 { 'command': 'pmemsave',
985   'data': {'val': 'int', 'size': 'int', 'filename': 'str'} }
988 # @cont:
990 # Resume guest VCPU execution.
992 # Since:  0.14.0
994 # Returns:  If successful, nothing
995 #           If the QEMU is waiting for an incoming migration, MigrationExpected
996 #           If QEMU was started with an encrypted block device and a key has
997 #              not yet been set, DeviceEncrypted.
999 # Notes:  This command will succeed if the guest is currently running.
1001 { 'command': 'cont' }
1004 # @system_wakeup:
1006 # Wakeup guest from suspend.  Does nothing in case the guest isn't suspended.
1008 # Since:  1.1
1010 # Returns:  nothing.
1012 { 'command': 'system_wakeup' }
1015 # @inject-nmi:
1017 # Injects an Non-Maskable Interrupt into all guest's VCPUs.
1019 # Returns:  If successful, nothing
1020 #           If the Virtual Machine doesn't support NMI injection, Unsupported
1022 # Since:  0.14.0
1024 # Notes: Only x86 Virtual Machines support this command.
1026 { 'command': 'inject-nmi' }
1029 # @set_link:
1031 # Sets the link status of a virtual network adapter.
1033 # @name: the device name of the virtual network adapter
1035 # @up: true to set the link status to be up
1037 # Returns: Nothing on success
1038 #          If @name is not a valid network device, DeviceNotFound
1040 # Since: 0.14.0
1042 # Notes: Not all network adapters support setting link status.  This command
1043 #        will succeed even if the network adapter does not support link status
1044 #        notification.
1046 { 'command': 'set_link', 'data': {'name': 'str', 'up': 'bool'} }
1049 # @block_passwd:
1051 # This command sets the password of a block device that has not been open
1052 # with a password and requires one.
1054 # The two cases where this can happen are a block device is created through
1055 # QEMU's initial command line or a block device is changed through the legacy
1056 # @change interface.
1058 # In the event that the block device is created through the initial command
1059 # line, the VM will start in the stopped state regardless of whether '-S' is
1060 # used.  The intention is for a management tool to query the block devices to
1061 # determine which ones are encrypted, set the passwords with this command, and
1062 # then start the guest with the @cont command.
1064 # @device:   the name of the device to set the password on
1066 # @password: the password to use for the device
1068 # Returns: nothing on success
1069 #          If @device is not a valid block device, DeviceNotFound
1070 #          If @device is not encrypted, DeviceNotEncrypted
1071 #          If @password is not valid for this device, InvalidPassword
1073 # Notes:  Not all block formats support encryption and some that do are not
1074 #         able to validate that a password is correct.  Disk corruption may
1075 #         occur if an invalid password is specified.
1077 # Since: 0.14.0
1079 { 'command': 'block_passwd', 'data': {'device': 'str', 'password': 'str'} }
1082 # @balloon:
1084 # Request the balloon driver to change its balloon size.
1086 # @value: the target size of the balloon in bytes
1088 # Returns: Nothing on success
1089 #          If the balloon driver is enabled but not functional because the KVM
1090 #            kernel module cannot support it, KvmMissingCap
1091 #          If no balloon device is present, DeviceNotActive
1093 # Notes: This command just issues a request to the guest.  When it returns,
1094 #        the balloon size may not have changed.  A guest can change the balloon
1095 #        size independent of this command.
1097 # Since: 0.14.0
1099 { 'command': 'balloon', 'data': {'value': 'int'} }
1102 # @block_resize
1104 # Resize a block image while a guest is running.
1106 # @device:  the name of the device to get the image resized
1108 # @size:  new image size in bytes
1110 # Returns: nothing on success
1111 #          If @device is not a valid block device, DeviceNotFound
1112 #          If @size is negative, InvalidParameterValue
1113 #          If the block device has no medium inserted, DeviceHasNoMedium
1114 #          If the block device does not support resize, Unsupported
1115 #          If the block device is read-only, DeviceIsReadOnly
1116 #          If a long-running operation is using the device, DeviceInUse
1118 # Since: 0.14.0
1120 { 'command': 'block_resize', 'data': { 'device': 'str', 'size': 'int' }}
1123 # @NewImageMode
1125 # An enumeration that tells QEMU how to set the backing file path in
1126 # a new image file.
1128 # @existing: QEMU should look for an existing image file.
1130 # @absolute-paths: QEMU should create a new image with absolute paths
1131 # for the backing file.
1133 # Since: 1.1
1135 { 'enum': 'NewImageMode'
1136   'data': [ 'existing', 'absolute-paths' ] }
1139 # @BlockdevSnapshot
1141 # @device:  the name of the device to generate the snapshot from.
1143 # @snapshot-file: the target of the new image. A new file will be created.
1145 # @format: #optional the format of the snapshot image, default is 'qcow2'.
1147 # @mode: #optional whether and how QEMU should create a new image, default is
1148 # 'absolute-paths'.
1150 { 'type': 'BlockdevSnapshot',
1151   'data': { 'device': 'str', 'snapshot-file': 'str', '*format': 'str',
1152             '*mode': 'NewImageMode' } }
1155 # @BlockdevAction
1157 # A discriminated record of operations that can be performed with
1158 # @transaction.
1160 { 'union': 'BlockdevAction',
1161   'data': {
1162        'blockdev-snapshot-sync': 'BlockdevSnapshot',
1163    } }
1166 # @transaction
1168 # Atomically operate on a group of one or more block devices.  If
1169 # any operation fails, then the entire set of actions will be
1170 # abandoned and the appropriate error returned.  The only operation
1171 # supported is currently blockdev-snapshot-sync.
1173 #  List of:
1174 #  @BlockdevAction: information needed for the device snapshot
1176 # Returns: nothing on success
1177 #          If @device is not a valid block device, DeviceNotFound
1178 #          If @device is busy, DeviceInUse will be returned
1179 #          If @snapshot-file can't be created, OpenFileFailed
1180 #          If @snapshot-file can't be opened, OpenFileFailed
1181 #          If @format is invalid, InvalidBlockFormat
1183 # Note: The transaction aborts on the first failure.  Therefore, there will
1184 # be only one device or snapshot file returned in an error condition, and
1185 # subsequent actions will not have been attempted.
1187 # Since 1.1
1189 { 'command': 'transaction',
1190   'data': { 'actions': [ 'BlockdevAction' ] } }
1193 # @blockdev-snapshot-sync
1195 # Generates a synchronous snapshot of a block device.
1197 # @device:  the name of the device to generate the snapshot from.
1199 # @snapshot-file: the target of the new image. If the file exists, or if it
1200 #                 is a device, the snapshot will be created in the existing
1201 #                 file/device. If does not exist, a new file will be created.
1203 # @format: #optional the format of the snapshot image, default is 'qcow2'.
1205 # @mode: #optional whether and how QEMU should create a new image, default is
1206 # 'absolute-paths'.
1208 # Returns: nothing on success
1209 #          If @device is not a valid block device, DeviceNotFound
1210 #          If @snapshot-file can't be opened, OpenFileFailed
1211 #          If @format is invalid, InvalidBlockFormat
1213 # Since 0.14.0
1215 { 'command': 'blockdev-snapshot-sync',
1216   'data': { 'device': 'str', 'snapshot-file': 'str', '*format': 'str',
1217             '*mode': 'NewImageMode'} }
1220 # @human-monitor-command:
1222 # Execute a command on the human monitor and return the output.
1224 # @command-line: the command to execute in the human monitor
1226 # @cpu-index: #optional The CPU to use for commands that require an implicit CPU
1228 # Returns: the output of the command as a string
1230 # Since: 0.14.0
1232 # Notes: This command only exists as a stop-gap.  It's use is highly
1233 #        discouraged.  The semantics of this command are not guaranteed.
1235 #        Known limitations:
1237 #        o This command is stateless, this means that commands that depend
1238 #          on state information (such as getfd) might not work
1240 #       o Commands that prompt the user for data (eg. 'cont' when the block
1241 #         device is encrypted) don't currently work
1243 { 'command': 'human-monitor-command',
1244   'data': {'command-line': 'str', '*cpu-index': 'int'},
1245   'returns': 'str' } 
1248 # @migrate_cancel
1250 # Cancel the current executing migration process.
1252 # Returns: nothing on success
1254 # Notes: This command succeeds even if there is no migration process running.
1256 # Since: 0.14.0
1258 { 'command': 'migrate_cancel' }
1261 # @migrate_set_downtime
1263 # Set maximum tolerated downtime for migration.
1265 # @value: maximum downtime in seconds
1267 # Returns: nothing on success
1269 # Since: 0.14.0
1271 { 'command': 'migrate_set_downtime', 'data': {'value': 'number'} }
1274 # @migrate_set_speed
1276 # Set maximum speed for migration.
1278 # @value: maximum speed in bytes.
1280 # Returns: nothing on success
1282 # Notes: A value lesser than zero will be automatically round up to zero.
1284 # Since: 0.14.0
1286 { 'command': 'migrate_set_speed', 'data': {'value': 'int'} }
1289 # @ObjectPropertyInfo:
1291 # @name: the name of the property
1293 # @type: the type of the property.  This will typically come in one of four
1294 #        forms:
1296 #        1) A primitive type such as 'u8', 'u16', 'bool', 'str', or 'double'.
1297 #           These types are mapped to the appropriate JSON type.
1299 #        2) A legacy type in the form 'legacy<subtype>' where subtype is the
1300 #           legacy qdev typename.  These types are always treated as strings.
1302 #        3) A child type in the form 'child<subtype>' where subtype is a qdev
1303 #           device type name.  Child properties create the composition tree.
1305 #        4) A link type in the form 'link<subtype>' where subtype is a qdev
1306 #           device type name.  Link properties form the device model graph.
1308 # Since: 1.1
1310 # Notes: This type is experimental.  Its syntax may change in future releases.
1312 { 'type': 'ObjectPropertyInfo',
1313   'data': { 'name': 'str', 'type': 'str' } }
1316 # @qom-list:
1318 # This command will list any properties of a object given a path in the object
1319 # model.
1321 # @path: the path within the object model.  See @qom-get for a description of
1322 #        this parameter.
1324 # Returns: a list of @ObjectPropertyInfo that describe the properties of the
1325 #          object.
1327 # Since: 1.1
1329 # Notes: This command is experimental.  It's syntax may change in future
1330 #        releases.
1332 { 'command': 'qom-list',
1333   'data': { 'path': 'str' },
1334   'returns': [ 'ObjectPropertyInfo' ] }
1337 # @qom-get:
1339 # This command will get a property from a object model path and return the
1340 # value.
1342 # @path: The path within the object model.  There are two forms of supported
1343 #        paths--absolute and partial paths.
1345 #        Absolute paths are derived from the root object and can follow child<>
1346 #        or link<> properties.  Since they can follow link<> properties, they
1347 #        can be arbitrarily long.  Absolute paths look like absolute filenames
1348 #        and are prefixed  with a leading slash.
1350 #        Partial paths look like relative filenames.  They do not begin
1351 #        with a prefix.  The matching rules for partial paths are subtle but
1352 #        designed to make specifying objects easy.  At each level of the
1353 #        composition tree, the partial path is matched as an absolute path.
1354 #        The first match is not returned.  At least two matches are searched
1355 #        for.  A successful result is only returned if only one match is
1356 #        found.  If more than one match is found, a flag is return to
1357 #        indicate that the match was ambiguous.
1359 # @property: The property name to read
1361 # Returns: The property value.  The type depends on the property type.  legacy<>
1362 #          properties are returned as #str.  child<> and link<> properties are
1363 #          returns as #str pathnames.  All integer property types (u8, u16, etc)
1364 #          are returned as #int.
1366 # Since: 1.1
1368 # Notes: This command is experimental and may change syntax in future releases.
1370 { 'command': 'qom-get',
1371   'data': { 'path': 'str', 'property': 'str' },
1372   'returns': 'visitor',
1373   'gen': 'no' }
1376 # @qom-set:
1378 # This command will set a property from a object model path.
1380 # @path: see @qom-get for a description of this parameter
1382 # @property: the property name to set
1384 # @value: a value who's type is appropriate for the property type.  See @qom-get
1385 #         for a description of type mapping.
1387 # Since: 1.1
1389 # Notes: This command is experimental and may change syntax in future releases.
1391 { 'command': 'qom-set',
1392   'data': { 'path': 'str', 'property': 'str', 'value': 'visitor' },
1393   'gen': 'no' }
1396 # @set_password:
1398 # Sets the password of a remote display session.
1400 # @protocol: `vnc' to modify the VNC server password
1401 #            `spice' to modify the Spice server password
1403 # @password: the new password
1405 # @connected: #optional how to handle existing clients when changing the
1406 #                       password.  If nothing is specified, defaults to `keep' 
1407 #                       `fail' to fail the command if clients are connected
1408 #                       `disconnect' to disconnect existing clients
1409 #                       `keep' to maintain existing clients
1411 # Returns: Nothing on success
1412 #          If Spice is not enabled, DeviceNotFound
1413 #          If @protocol does not support connected, InvalidParameter
1414 #          If @protocol is invalid, InvalidParameter
1415 #          If any other error occurs, SetPasswdFailed
1417 # Notes: If VNC is not enabled, SetPasswdFailed is returned.
1419 # Since: 0.14.0
1421 { 'command': 'set_password',
1422   'data': {'protocol': 'str', 'password': 'str', '*connected': 'str'} }
1425 # @expire_password:
1427 # Expire the password of a remote display server.
1429 # @protocol: the name of the remote display protocol `vnc' or `spice'
1431 # @time: when to expire the password.
1432 #        `now' to expire the password immediately
1433 #        `never' to cancel password expiration
1434 #        `+INT' where INT is the number of seconds from now (integer)
1435 #        `INT' where INT is the absolute time in seconds
1437 # Returns: Nothing on success
1438 #          If @protocol is `spice' and Spice is not active, DeviceNotFound
1439 #          If an error occurs setting password expiration, SetPasswdFailed
1440 #          If @protocol is not `spice' or 'vnc', InvalidParameter
1442 # Since: 0.14.0
1444 # Notes: Time is relative to the server and currently there is no way to
1445 #        coordinate server time with client time.  It is not recommended to
1446 #        use the absolute time version of the @time parameter unless you're
1447 #        sure you are on the same machine as the QEMU instance.
1449 { 'command': 'expire_password', 'data': {'protocol': 'str', 'time': 'str'} }
1452 # @eject:
1454 # Ejects a device from a removable drive.
1456 # @device:  The name of the device
1458 # @force:   @optional If true, eject regardless of whether the drive is locked.
1459 #           If not specified, the default value is false.
1461 # Returns:  Nothing on success
1462 #           If @device is not a valid block device, DeviceNotFound
1463 #           If @device is not removable and @force is false, DeviceNotRemovable
1464 #           If @force is false and @device is locked, DeviceLocked
1466 # Notes:    Ejecting a device will no media results in success
1468 # Since: 0.14.0
1470 { 'command': 'eject', 'data': {'device': 'str', '*force': 'bool'} }
1473 # @change-vnc-password:
1475 # Change the VNC server password.
1477 # @target:  the new password to use with VNC authentication
1479 # Since: 1.1
1481 # Notes:  An empty password in this command will set the password to the empty
1482 #         string.  Existing clients are unaffected by executing this command.
1484 { 'command': 'change-vnc-password', 'data': {'password': 'str'} }
1487 # @change:
1489 # This command is multiple commands multiplexed together.
1491 # @device: This is normally the name of a block device but it may also be 'vnc'.
1492 #          when it's 'vnc', then sub command depends on @target
1494 # @target: If @device is a block device, then this is the new filename.
1495 #          If @device is 'vnc', then if the value 'password' selects the vnc
1496 #          change password command.   Otherwise, this specifies a new server URI
1497 #          address to listen to for VNC connections.
1499 # @arg:    If @device is a block device, then this is an optional format to open
1500 #          the device with.
1501 #          If @device is 'vnc' and @target is 'password', this is the new VNC
1502 #          password to set.  If this argument is an empty string, then no future
1503 #          logins will be allowed.
1505 # Returns: Nothing on success.
1506 #          If @device is not a valid block device, DeviceNotFound
1507 #          If @format is not a valid block format, InvalidBlockFormat
1508 #          If the new block device is encrypted, DeviceEncrypted.  Note that
1509 #          if this error is returned, the device has been opened successfully
1510 #          and an additional call to @block_passwd is required to set the
1511 #          device's password.  The behavior of reads and writes to the block
1512 #          device between when these calls are executed is undefined.
1514 # Notes:  It is strongly recommended that this interface is not used especially
1515 #         for changing block devices.
1517 # Since: 0.14.0
1519 { 'command': 'change',
1520   'data': {'device': 'str', 'target': 'str', '*arg': 'str'} }
1523 # @block_set_io_throttle:
1525 # Change I/O throttle limits for a block drive.
1527 # @device: The name of the device
1529 # @bps: total throughput limit in bytes per second
1531 # @bps_rd: read throughput limit in bytes per second
1533 # @bps_wr: write throughput limit in bytes per second
1535 # @iops: total I/O operations per second
1537 # @ops_rd: read I/O operations per second
1539 # @iops_wr: write I/O operations per second
1541 # Returns: Nothing on success
1542 #          If @device is not a valid block device, DeviceNotFound
1543 #          If the argument combination is invalid, InvalidParameterCombination
1545 # Since: 1.1
1546 ## 
1547 { 'command': 'block_set_io_throttle',
1548   'data': { 'device': 'str', 'bps': 'int', 'bps_rd': 'int', 'bps_wr': 'int',
1549             'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int' } }
1551 # @block_stream:
1553 # Copy data from a backing file into a block device.
1555 # The block streaming operation is performed in the background until the entire
1556 # backing file has been copied.  This command returns immediately once streaming
1557 # has started.  The status of ongoing block streaming operations can be checked
1558 # with query-block-jobs.  The operation can be stopped before it has completed
1559 # using the block_job_cancel command.
1561 # If a base file is specified then sectors are not copied from that base file and
1562 # its backing chain.  When streaming completes the image file will have the base
1563 # file as its backing file.  This can be used to stream a subset of the backing
1564 # file chain instead of flattening the entire image.
1566 # On successful completion the image file is updated to drop the backing file
1567 # and the BLOCK_JOB_COMPLETED event is emitted.
1569 # @device: the device name
1571 # @base:   #optional the common backing file name
1573 # Returns: Nothing on success
1574 #          If streaming is already active on this device, DeviceInUse
1575 #          If @device does not exist, DeviceNotFound
1576 #          If image streaming is not supported by this device, NotSupported
1577 #          If @base does not exist, BaseNotFound
1579 # Since: 1.1
1581 { 'command': 'block_stream', 'data': { 'device': 'str', '*base': 'str' } }
1584 # @block_job_set_speed:
1586 # Set maximum speed for a background block operation.
1588 # This command can only be issued when there is an active block job.
1590 # Throttling can be disabled by setting the speed to 0.
1592 # @device: the device name
1594 # @value:  the maximum speed, in bytes per second
1596 # Returns: Nothing on success
1597 #          If the job type does not support throttling, NotSupported
1598 #          If streaming is not active on this device, DeviceNotActive
1600 # Since: 1.1
1602 { 'command': 'block_job_set_speed',
1603   'data': { 'device': 'str', 'value': 'int' } }
1606 # @block_job_cancel:
1608 # Stop an active block streaming operation.
1610 # This command returns immediately after marking the active block streaming
1611 # operation for cancellation.  It is an error to call this command if no
1612 # operation is in progress.
1614 # The operation will cancel as soon as possible and then emit the
1615 # BLOCK_JOB_CANCELLED event.  Before that happens the job is still visible when
1616 # enumerated using query-block-jobs.
1618 # The image file retains its backing file unless the streaming operation happens
1619 # to complete just as it is being cancelled.
1621 # A new block streaming operation can be started at a later time to finish
1622 # copying all data from the backing file.
1624 # @device: the device name
1626 # Returns: Nothing on success
1627 #          If streaming is not active on this device, DeviceNotActive
1628 #          If cancellation already in progress, DeviceInUse
1630 # Since: 1.1
1632 { 'command': 'block_job_cancel', 'data': { 'device': 'str' } }
1635 # @ObjectTypeInfo:
1637 # This structure describes a search result from @qom-list-types
1639 # @name: the type name found in the search
1641 # Since: 1.1
1643 # Notes: This command is experimental and may change syntax in future releases.
1645 { 'type': 'ObjectTypeInfo',
1646   'data': { 'name': 'str' } }
1649 # @qom-list-types:
1651 # This command will return a list of types given search parameters
1653 # @implements: if specified, only return types that implement this type name
1655 # @abstract: if true, include abstract types in the results
1657 # Returns: a list of @ObjectTypeInfo or an empty list if no results are found
1659 # Since: 1.1
1661 # Notes: This command is experimental and may change syntax in future releases.
1663 { 'command': 'qom-list-types',
1664   'data': { '*implements': 'str', '*abstract': 'bool' },
1665   'returns': [ 'ObjectTypeInfo' ] }