8 # Guest name information.
10 # @name: #optional The name of the guest
14 { 'type': 'NameInfo', 'data': {'*name': 'str'} }
19 # Return the name information of a guest.
21 # Returns: @NameInfo of the guest
25 { 'command': 'query-name', 'returns': 'NameInfo' }
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.
49 { 'type': 'VersionInfo',
50 'data': {'qemu': {'major': 'int', 'minor': 'int', 'micro': 'int'},
56 # Returns the current version of QEMU.
58 # Returns: A @VersionInfo object describing the current version of QEMU.
62 { 'command': 'query-version', 'returns': 'VersionInfo' }
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
75 { 'type': 'KvmInfo', 'data': {'enabled': 'bool', 'present': 'bool'} }
80 # Returns information about KVM acceleration
86 { 'command': 'query-kvm', 'returns': 'KvmInfo' }
91 # An enumation of VM run states.
93 # @debug: QEMU is running on a debugger
95 # @finish-migrate: guest is paused to finish the migration process
97 # @inmigrate: guest is paused waiting for an incoming migration
99 # @internal-error: An internal error that prevents further guest execution
102 # @io-error: the last IOP has failed and the device is configured to pause
105 # @paused: guest has been paused via the 'stop' command
107 # @postmigrate: guest is paused following a successful 'migrate'
109 # @prelaunch: QEMU was started with -S and guest has not started
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 # @suspended: guest is suspended (ACPI S3)
121 # @watchdog: the watchdog action is configured to pause and has been triggered
123 { 'enum': 'RunState',
124 'data': [ 'debug', 'inmigrate', 'internal-error', 'io-error', 'paused',
125 'postmigrate', 'prelaunch', 'finish-migrate', 'restore-vm',
126 'running', 'save-vm', 'shutdown', 'suspended', 'watchdog' ] }
131 # Information about VCPU run state
133 # @running: true if all VCPUs are runnable, false if not runnable
135 # @singlestep: true if VCPUs are in single-step mode
137 # @status: the virtual machine @RunState
141 # Notes: @singlestep is enabled through the GDB stub
143 { 'type': 'StatusInfo',
144 'data': {'running': 'bool', 'singlestep': 'bool', 'status': 'RunState'} }
149 # Query the run status of all VCPUs
151 # Returns: @StatusInfo reflecting all VCPUs
155 { 'command': 'query-status', 'returns': 'StatusInfo' }
160 # Guest UUID information.
162 # @UUID: the UUID of the guest
166 # Notes: If no UUID was specified for the guest, a null UUID is returned.
168 { 'type': 'UuidInfo', 'data': {'UUID': 'str'} }
173 # Query the guest UUID information.
175 # Returns: The @UuidInfo for the guest
179 { 'command': 'query-uuid', 'returns': 'UuidInfo' }
184 # Information about a character device.
186 # @label: the label of the character device
188 # @filename: the filename of the character device
190 # Notes: @filename is encoded using the QEMU command line character device
191 # encoding. See the QEMU man page for details.
195 { 'type': 'ChardevInfo', 'data': {'label': 'str', 'filename': 'str'} }
200 # Returns information about current character devices.
202 # Returns: a list of @ChardevInfo
206 { 'command': 'query-chardev', 'returns': ['ChardevInfo'] }
211 # Information about a QMP command
213 # @name: The command name
217 { 'type': 'CommandInfo', 'data': {'name': 'str'} }
222 # Return a list of supported QMP commands by this server
224 # Returns: A list of @CommandInfo for all supported commands
228 { 'command': 'query-commands', 'returns': ['CommandInfo'] }
233 # Information about a QMP event
235 # @name: The event name
239 { 'type': 'EventInfo', 'data': {'name': 'str'} }
244 # Return a list of supported QMP events by this server
246 # Returns: A list of @EventInfo for all supported events
250 { 'command': 'query-events', 'returns': ['EventInfo'] }
255 # Detailed migration status.
257 # @transferred: amount of bytes already transferred to the target VM
259 # @remaining: amount of bytes remaining to be transferred to the target VM
261 # @total: total amount of bytes involved in the migration process
263 # @total_time: tota0l amount of ms since migration started. If
264 # migration has ended, it returns the total migration
269 { 'type': 'MigrationStats',
270 'data': {'transferred': 'int', 'remaining': 'int', 'total': 'int' ,
271 'total_time': 'int' } }
276 # Information about current migration process.
278 # @status: #optional string describing the current migration status.
279 # As of 0.14.0 this can be 'active', 'completed', 'failed' or
280 # 'cancelled'. If this field is not returned, no migration process
283 # @ram: #optional @MigrationStats containing detailed migration
284 # status, only returned if status is 'active' or
285 # 'completed'. 'comppleted' (since 1.2)
287 # @disk: #optional @MigrationStats containing detailed disk migration
288 # status, only returned if status is 'active' and it is a block
293 { 'type': 'MigrationInfo',
294 'data': {'*status': 'str', '*ram': 'MigrationStats',
295 '*disk': 'MigrationStats'} }
300 # Returns information about current migration process.
302 # Returns: @MigrationInfo
306 { 'command': 'query-migrate', 'returns': 'MigrationInfo' }
309 # @MigrationCapability
311 # Migration capabilities enumeration
313 # @xbzrle: Migration supports xbzrle (Xor Based Zero Run Length Encoding).
314 # This feature allows us to minimize migration traffic for certain work
315 # loads, by sending compressed difference of the pages
319 { 'enum': 'MigrationCapability',
323 # @MigrationCapabilityStatus
325 # Migration capability information
327 # @capability: capability enum
329 # @state: capability state bool
333 { 'type': 'MigrationCapabilityStatus',
334 'data': { 'capability' : 'MigrationCapability', 'state' : 'bool' } }
337 # @migrate-set-capabilities
339 # Enable/Disable the following migration capabilities (like xbzrle)
341 # @capabilities: json array of capability modifications to make
345 { 'command': 'migrate-set-capabilities',
346 'data': { 'capabilities': ['MigrationCapabilityStatus'] } }
349 # @query-migrate-capabilities
351 # Returns information about the current migration capabilities status
353 # Returns: @MigrationCapabilitiesStatus
357 { 'command': 'query-migrate-capabilities', 'returns': ['MigrationCapabilityStatus']}
362 # Information about a mouse device.
364 # @name: the name of the mouse device
366 # @index: the index of the mouse device
368 # @current: true if this device is currently receiving mouse events
370 # @absolute: true if this device supports absolute coordinates as input
374 { 'type': 'MouseInfo',
375 'data': {'name': 'str', 'index': 'int', 'current': 'bool',
376 'absolute': 'bool'} }
381 # Returns information about each active mouse device
383 # Returns: a list of @MouseInfo for each device
387 { 'command': 'query-mice', 'returns': ['MouseInfo'] }
392 # Information about a virtual CPU
394 # @CPU: the index of the virtual CPU
396 # @current: this only exists for backwards compatible and should be ignored
398 # @halted: true if the virtual CPU is in the halt state. Halt usually refers
399 # to a processor specific low power mode.
401 # @pc: #optional If the target is i386 or x86_64, this is the 64-bit instruction
403 # If the target is Sparc, this is the PC component of the
404 # instruction pointer.
406 # @nip: #optional If the target is PPC, the instruction pointer
408 # @npc: #optional If the target is Sparc, the NPC component of the instruction
411 # @PC: #optional If the target is MIPS, the instruction pointer
413 # @thread_id: ID of the underlying host thread
417 # Notes: @halted is a transient state that changes frequently. By the time the
418 # data is sent to the client, the guest may no longer be halted.
421 'data': {'CPU': 'int', 'current': 'bool', 'halted': 'bool', '*pc': 'int',
422 '*nip': 'int', '*npc': 'int', '*PC': 'int', 'thread_id': 'int'} }
427 # Returns a list of information about each virtual CPU.
429 # Returns: a list of @CpuInfo for each virtual CPU
433 { 'command': 'query-cpus', 'returns': ['CpuInfo'] }
438 # Information about the backing device for a block device.
440 # @file: the filename of the backing device
442 # @ro: true if the backing device was open read-only
444 # @drv: the name of the block format used to open the backing device. As of
445 # 0.14.0 this can be: 'blkdebug', 'bochs', 'cloop', 'cow', 'dmg',
446 # 'file', 'file', 'ftp', 'ftps', 'host_cdrom', 'host_device',
447 # 'host_floppy', 'http', 'https', 'nbd', 'parallels', 'qcow',
448 # 'qcow2', 'raw', 'tftp', 'vdi', 'vmdk', 'vpc', 'vvfat'
450 # @backing_file: #optional the name of the backing file (for copy-on-write)
452 # @backing_file_depth: number of files in the backing file chain (since: 1.2)
454 # @encrypted: true if the backing device is encrypted
456 # @bps: total throughput limit in bytes per second is specified
458 # @bps_rd: read throughput limit in bytes per second is specified
460 # @bps_wr: write throughput limit in bytes per second is specified
462 # @iops: total I/O operations per second is specified
464 # @iops_rd: read I/O operations per second is specified
466 # @iops_wr: write I/O operations per second is specified
470 # Notes: This interface is only found in @BlockInfo.
472 { 'type': 'BlockDeviceInfo',
473 'data': { 'file': 'str', 'ro': 'bool', 'drv': 'str',
474 '*backing_file': 'str', 'backing_file_depth': 'int',
475 'encrypted': 'bool', 'bps': 'int', 'bps_rd': 'int',
476 'bps_wr': 'int', 'iops': 'int', 'iops_rd': 'int',
480 # @BlockDeviceIoStatus:
482 # An enumeration of block device I/O status.
484 # @ok: The last I/O operation has succeeded
486 # @failed: The last I/O operation has failed
488 # @nospace: The last I/O operation has failed due to a no-space condition
492 { 'enum': 'BlockDeviceIoStatus', 'data': [ 'ok', 'failed', 'nospace' ] }
497 # Block device information. This structure describes a virtual device and
498 # the backing device associated with it.
500 # @device: The device name associated with the virtual device.
502 # @type: This field is returned only for compatibility reasons, it should
503 # not be used (always returns 'unknown')
505 # @removable: True if the device supports removable media.
507 # @locked: True if the guest has locked this device from having its media
510 # @tray_open: #optional True if the device has a tray and it is open
511 # (only present if removable is true)
513 # @io-status: #optional @BlockDeviceIoStatus. Only present if the device
514 # supports it and the VM is configured to stop on errors
516 # @inserted: #optional @BlockDeviceInfo describing the device if media is
521 { 'type': 'BlockInfo',
522 'data': {'device': 'str', 'type': 'str', 'removable': 'bool',
523 'locked': 'bool', '*inserted': 'BlockDeviceInfo',
524 '*tray_open': 'bool', '*io-status': 'BlockDeviceIoStatus'} }
529 # Get a list of BlockInfo for all virtual block devices.
531 # Returns: a list of @BlockInfo describing each virtual block device
535 { 'command': 'query-block', 'returns': ['BlockInfo'] }
540 # Statistics of a virtual block device or a block backing device.
542 # @rd_bytes: The number of bytes read by the device.
544 # @wr_bytes: The number of bytes written by the device.
546 # @rd_operations: The number of read operations performed by the device.
548 # @wr_operations: The number of write operations performed by the device.
550 # @flush_operations: The number of cache flush operations performed by the
551 # device (since 0.15.0)
553 # @flush_total_time_ns: Total time spend on cache flushes in nano-seconds
556 # @wr_total_time_ns: Total time spend on writes in nano-seconds (since 0.15.0).
558 # @rd_total_time_ns: Total_time_spend on reads in nano-seconds (since 0.15.0).
560 # @wr_highest_offset: The offset after the greatest byte written to the
561 # device. The intended use of this information is for
562 # growable sparse files (like qcow2) that are used on top
563 # of a physical device.
567 { 'type': 'BlockDeviceStats',
568 'data': {'rd_bytes': 'int', 'wr_bytes': 'int', 'rd_operations': 'int',
569 'wr_operations': 'int', 'flush_operations': 'int',
570 'flush_total_time_ns': 'int', 'wr_total_time_ns': 'int',
571 'rd_total_time_ns': 'int', 'wr_highest_offset': 'int' } }
576 # Statistics of a virtual block device or a block backing device.
578 # @device: #optional If the stats are for a virtual block device, the name
579 # corresponding to the virtual block device.
581 # @stats: A @BlockDeviceStats for the device.
583 # @parent: #optional This may point to the backing block device if this is a
584 # a virtual block device. If it's a backing block, this will point
585 # to the backing file is one is present.
589 { 'type': 'BlockStats',
590 'data': {'*device': 'str', 'stats': 'BlockDeviceStats',
591 '*parent': 'BlockStats'} }
596 # Query the @BlockStats for all virtual block devices.
598 # Returns: A list of @BlockStats for each virtual block devices.
602 { 'command': 'query-blockstats', 'returns': ['BlockStats'] }
607 # Information about a connected VNC client.
609 # @host: The host name of the client. QEMU tries to resolve this to a DNS name
612 # @family: 'ipv6' if the client is connected via IPv6 and TCP
613 # 'ipv4' if the client is connected via IPv4 and TCP
614 # 'unix' if the client is connected via a unix domain socket
615 # 'unknown' otherwise
617 # @service: The service name of the client's port. This may depends on the
618 # host system's service database so symbolic names should not be
621 # @x509_dname: #optional If x509 authentication is in use, the Distinguished
622 # Name of the client.
624 # @sasl_username: #optional If SASL authentication is in use, the SASL username
625 # used for authentication.
629 { 'type': 'VncClientInfo',
630 'data': {'host': 'str', 'family': 'str', 'service': 'str',
631 '*x509_dname': 'str', '*sasl_username': 'str'} }
636 # Information about the VNC session.
638 # @enabled: true if the VNC server is enabled, false otherwise
640 # @host: #optional The hostname the VNC server is bound to. This depends on
641 # the name resolution on the host and may be an IP address.
643 # @family: #optional 'ipv6' if the host is listening for IPv6 connections
644 # 'ipv4' if the host is listening for IPv4 connections
645 # 'unix' if the host is listening on a unix domain socket
646 # 'unknown' otherwise
648 # @service: #optional The service name of the server's port. This may depends
649 # on the host system's service database so symbolic names should not
652 # @auth: #optional the current authentication type used by the server
653 # 'none' if no authentication is being used
654 # 'vnc' if VNC authentication is being used
655 # 'vencrypt+plain' if VEncrypt is used with plain text authentication
656 # 'vencrypt+tls+none' if VEncrypt is used with TLS and no authentication
657 # 'vencrypt+tls+vnc' if VEncrypt is used with TLS and VNC authentication
658 # 'vencrypt+tls+plain' if VEncrypt is used with TLS and plain text auth
659 # 'vencrypt+x509+none' if VEncrypt is used with x509 and no auth
660 # 'vencrypt+x509+vnc' if VEncrypt is used with x509 and VNC auth
661 # 'vencrypt+x509+plain' if VEncrypt is used with x509 and plain text auth
662 # 'vencrypt+tls+sasl' if VEncrypt is used with TLS and SASL auth
663 # 'vencrypt+x509+sasl' if VEncrypt is used with x509 and SASL auth
665 # @clients: a list of @VncClientInfo of all currently connected clients
670 'data': {'enabled': 'bool', '*host': 'str', '*family': 'str',
671 '*service': 'str', '*auth': 'str', '*clients': ['VncClientInfo']} }
676 # Returns information about the current VNC server
679 # If VNC support is not compiled in, FeatureDisabled
683 { 'command': 'query-vnc', 'returns': 'VncInfo' }
688 # Information about a SPICE client channel.
690 # @host: The host name of the client. QEMU tries to resolve this to a DNS name
693 # @family: 'ipv6' if the client is connected via IPv6 and TCP
694 # 'ipv4' if the client is connected via IPv4 and TCP
695 # 'unix' if the client is connected via a unix domain socket
696 # 'unknown' otherwise
698 # @port: The client's port number.
700 # @connection-id: SPICE connection id number. All channels with the same id
701 # belong to the same SPICE session.
703 # @connection-type: SPICE channel type number. "1" is the main control
704 # channel, filter for this one if you want to track spice
707 # @channel-id: SPICE channel ID number. Usually "0", might be different when
708 # multiple channels of the same type exist, such as multiple
709 # display channels in a multihead setup
711 # @tls: true if the channel is encrypted, false otherwise.
715 { 'type': 'SpiceChannel',
716 'data': {'host': 'str', 'family': 'str', 'port': 'str',
717 'connection-id': 'int', 'channel-type': 'int', 'channel-id': 'int',
721 # @SpiceQueryMouseMode
723 # An enumation of Spice mouse states.
725 # @client: Mouse cursor position is determined by the client.
727 # @server: Mouse cursor position is determined by the server.
729 # @unknown: No information is available about mouse mode used by
732 # Note: spice/enums.h has a SpiceMouseMode already, hence the name.
736 { 'enum': 'SpiceQueryMouseMode',
737 'data': [ 'client', 'server', 'unknown' ] }
742 # Information about the SPICE session.
744 # @enabled: true if the SPICE server is enabled, false otherwise
746 # @host: #optional The hostname the SPICE server is bound to. This depends on
747 # the name resolution on the host and may be an IP address.
749 # @port: #optional The SPICE server's port number.
751 # @compiled-version: #optional SPICE server version.
753 # @tls-port: #optional The SPICE server's TLS port number.
755 # @auth: #optional the current authentication type used by the server
756 # 'none' if no authentication is being used
757 # 'spice' uses SASL or direct TLS authentication, depending on command
760 # @mouse-mode: The mode in which the mouse cursor is displayed currently. Can
761 # be determined by the client or the server, or unknown if spice
762 # server doesn't provide this information.
766 # @channels: a list of @SpiceChannel for each active spice channel
770 { 'type': 'SpiceInfo',
771 'data': {'enabled': 'bool', '*host': 'str', '*port': 'int',
772 '*tls-port': 'int', '*auth': 'str', '*compiled-version': 'str',
773 'mouse-mode': 'SpiceQueryMouseMode', '*channels': ['SpiceChannel']} }
778 # Returns information about the current SPICE server
780 # Returns: @SpiceInfo
784 { 'command': 'query-spice', 'returns': 'SpiceInfo' }
789 # Information about the guest balloon device.
791 # @actual: the number of bytes the balloon currently contains
793 # @mem_swapped_in: #optional number of pages swapped in within the guest
795 # @mem_swapped_out: #optional number of pages swapped out within the guest
797 # @major_page_faults: #optional number of major page faults within the guest
799 # @minor_page_faults: #optional number of minor page faults within the guest
801 # @free_mem: #optional amount of memory (in bytes) free in the guest
803 # @total_mem: #optional amount of memory (in bytes) visible to the guest
807 # Notes: all current versions of QEMU do not fill out optional information in
810 { 'type': 'BalloonInfo',
811 'data': {'actual': 'int', '*mem_swapped_in': 'int',
812 '*mem_swapped_out': 'int', '*major_page_faults': 'int',
813 '*minor_page_faults': 'int', '*free_mem': 'int',
814 '*total_mem': 'int'} }
819 # Return information about the balloon device.
821 # Returns: @BalloonInfo on success
822 # If the balloon driver is enabled but not functional because the KVM
823 # kernel module cannot support it, KvmMissingCap
824 # If no balloon device is present, DeviceNotActive
828 { 'command': 'query-balloon', 'returns': 'BalloonInfo' }
833 # A PCI device memory region
835 # @base: the starting address (guest physical)
837 # @limit: the ending address (guest physical)
841 { 'type': 'PciMemoryRange', 'data': {'base': 'int', 'limit': 'int'} }
846 # Information about a PCI device I/O region.
848 # @bar: the index of the Base Address Register for this region
850 # @type: 'io' if the region is a PIO region
851 # 'memory' if the region is a MMIO region
853 # @prefetch: #optional if @type is 'memory', true if the memory is prefetchable
855 # @mem_type_64: #optional if @type is 'memory', true if the BAR is 64-bit
859 { 'type': 'PciMemoryRegion',
860 'data': {'bar': 'int', 'type': 'str', 'address': 'int', 'size': 'int',
861 '*prefetch': 'bool', '*mem_type_64': 'bool' } }
866 # Information about a PCI Bridge device
868 # @bus.number: primary bus interface number. This should be the number of the
869 # bus the device resides on.
871 # @bus.secondary: secondary bus interface number. This is the number of the
872 # main bus for the bridge
874 # @bus.subordinate: This is the highest number bus that resides below the
877 # @bus.io_range: The PIO range for all devices on this bridge
879 # @bus.memory_range: The MMIO range for all devices on this bridge
881 # @bus.prefetchable_range: The range of prefetchable MMIO for all devices on
884 # @devices: a list of @PciDeviceInfo for each device on this bridge
888 { 'type': 'PciBridgeInfo',
889 'data': {'bus': { 'number': 'int', 'secondary': 'int', 'subordinate': 'int',
890 'io_range': 'PciMemoryRange',
891 'memory_range': 'PciMemoryRange',
892 'prefetchable_range': 'PciMemoryRange' },
893 '*devices': ['PciDeviceInfo']} }
898 # Information about a PCI device
900 # @bus: the bus number of the device
902 # @slot: the slot the device is located in
904 # @function: the function of the slot used by the device
906 # @class_info.desc: #optional a string description of the device's class
908 # @class_info.class: the class code of the device
910 # @id.device: the PCI device id
912 # @id.vendor: the PCI vendor id
914 # @irq: #optional if an IRQ is assigned to the device, the IRQ number
916 # @qdev_id: the device name of the PCI device
918 # @pci_bridge: if the device is a PCI bridge, the bridge information
920 # @regions: a list of the PCI I/O regions associated with the device
922 # Notes: the contents of @class_info.desc are not stable and should only be
923 # treated as informational.
927 { 'type': 'PciDeviceInfo',
928 'data': {'bus': 'int', 'slot': 'int', 'function': 'int',
929 'class_info': {'*desc': 'str', 'class': 'int'},
930 'id': {'device': 'int', 'vendor': 'int'},
931 '*irq': 'int', 'qdev_id': 'str', '*pci_bridge': 'PciBridgeInfo',
932 'regions': ['PciMemoryRegion']} }
937 # Information about a PCI bus
939 # @bus: the bus index
941 # @devices: a list of devices on this bus
945 { 'type': 'PciInfo', 'data': {'bus': 'int', 'devices': ['PciDeviceInfo']} }
950 # Return information about the PCI bus topology of the guest.
952 # Returns: a list of @PciInfo for each PCI bus
956 { 'command': 'query-pci', 'returns': ['PciInfo'] }
961 # Information about a long-running block device operation.
963 # @type: the job type ('stream' for image streaming)
965 # @device: the block device name
967 # @len: the maximum progress value
969 # @offset: the current progress value
971 # @speed: the rate limit, bytes per second
975 { 'type': 'BlockJobInfo',
976 'data': {'type': 'str', 'device': 'str', 'len': 'int',
977 'offset': 'int', 'speed': 'int'} }
982 # Return information about long-running block device operations.
984 # Returns: a list of @BlockJobInfo for each active block job
988 { 'command': 'query-block-jobs', 'returns': ['BlockJobInfo'] }
993 # This command will cause the QEMU process to exit gracefully. While every
994 # attempt is made to send the QMP response before terminating, this is not
995 # guaranteed. When using this interface, a premature EOF would not be
1000 { 'command': 'quit' }
1005 # Stop all guest VCPU execution.
1009 # Notes: This function will succeed even if the guest is already in the stopped
1012 { 'command': 'stop' }
1017 # Performs a hard reset of a guest.
1021 { 'command': 'system_reset' }
1024 # @system_powerdown:
1026 # Requests that a guest perform a powerdown operation.
1030 # Notes: A guest may or may not respond to this command. This command
1031 # returning does not indicate that a guest has accepted the request or
1032 # that it has shut down. Many guests will respond to this command by
1033 # prompting the user in some way.
1035 { 'command': 'system_powerdown' }
1040 # This command is a nop that is only provided for the purposes of compatibility.
1044 # Notes: Do not use this command.
1046 { 'command': 'cpu', 'data': {'index': 'int'} }
1051 # Save a portion of guest memory to a file.
1053 # @val: the virtual address of the guest to start from
1055 # @size: the size of memory region to save
1057 # @filename: the file to save the memory to as binary data
1059 # @cpu-index: #optional the index of the virtual CPU to use for translating the
1060 # virtual address (defaults to CPU 0)
1062 # Returns: Nothing on success
1063 # If @cpu is not a valid VCPU, InvalidParameterValue
1064 # If @filename cannot be opened, OpenFileFailed
1065 # If an I/O error occurs while writing the file, IOError
1069 # Notes: Errors were not reliably returned until 1.1
1071 { 'command': 'memsave',
1072 'data': {'val': 'int', 'size': 'int', 'filename': 'str', '*cpu-index': 'int'} }
1077 # Save a portion of guest physical memory to a file.
1079 # @val: the physical address of the guest to start from
1081 # @size: the size of memory region to save
1083 # @filename: the file to save the memory to as binary data
1085 # Returns: Nothing on success
1086 # If @filename cannot be opened, OpenFileFailed
1087 # If an I/O error occurs while writing the file, IOError
1091 # Notes: Errors were not reliably returned until 1.1
1093 { 'command': 'pmemsave',
1094 'data': {'val': 'int', 'size': 'int', 'filename': 'str'} }
1099 # Resume guest VCPU execution.
1103 # Returns: If successful, nothing
1104 # If the QEMU is waiting for an incoming migration, MigrationExpected
1105 # If QEMU was started with an encrypted block device and a key has
1106 # not yet been set, DeviceEncrypted.
1108 # Notes: This command will succeed if the guest is currently running.
1110 { 'command': 'cont' }
1115 # Wakeup guest from suspend. Does nothing in case the guest isn't suspended.
1121 { 'command': 'system_wakeup' }
1126 # Injects an Non-Maskable Interrupt into all guest's VCPUs.
1128 # Returns: If successful, nothing
1129 # If the Virtual Machine doesn't support NMI injection, Unsupported
1133 # Notes: Only x86 Virtual Machines support this command.
1135 { 'command': 'inject-nmi' }
1140 # Sets the link status of a virtual network adapter.
1142 # @name: the device name of the virtual network adapter
1144 # @up: true to set the link status to be up
1146 # Returns: Nothing on success
1147 # If @name is not a valid network device, DeviceNotFound
1151 # Notes: Not all network adapters support setting link status. This command
1152 # will succeed even if the network adapter does not support link status
1155 { 'command': 'set_link', 'data': {'name': 'str', 'up': 'bool'} }
1160 # This command sets the password of a block device that has not been open
1161 # with a password and requires one.
1163 # The two cases where this can happen are a block device is created through
1164 # QEMU's initial command line or a block device is changed through the legacy
1165 # @change interface.
1167 # In the event that the block device is created through the initial command
1168 # line, the VM will start in the stopped state regardless of whether '-S' is
1169 # used. The intention is for a management tool to query the block devices to
1170 # determine which ones are encrypted, set the passwords with this command, and
1171 # then start the guest with the @cont command.
1173 # @device: the name of the device to set the password on
1175 # @password: the password to use for the device
1177 # Returns: nothing on success
1178 # If @device is not a valid block device, DeviceNotFound
1179 # If @device is not encrypted, DeviceNotEncrypted
1180 # If @password is not valid for this device, InvalidPassword
1182 # Notes: Not all block formats support encryption and some that do are not
1183 # able to validate that a password is correct. Disk corruption may
1184 # occur if an invalid password is specified.
1188 { 'command': 'block_passwd', 'data': {'device': 'str', 'password': 'str'} }
1193 # Request the balloon driver to change its balloon size.
1195 # @value: the target size of the balloon in bytes
1197 # Returns: Nothing on success
1198 # If the balloon driver is enabled but not functional because the KVM
1199 # kernel module cannot support it, KvmMissingCap
1200 # If no balloon device is present, DeviceNotActive
1202 # Notes: This command just issues a request to the guest. When it returns,
1203 # the balloon size may not have changed. A guest can change the balloon
1204 # size independent of this command.
1208 { 'command': 'balloon', 'data': {'value': 'int'} }
1213 # Resize a block image while a guest is running.
1215 # @device: the name of the device to get the image resized
1217 # @size: new image size in bytes
1219 # Returns: nothing on success
1220 # If @device is not a valid block device, DeviceNotFound
1221 # If @size is negative, InvalidParameterValue
1222 # If the block device has no medium inserted, DeviceHasNoMedium
1223 # If the block device does not support resize, Unsupported
1224 # If the block device is read-only, DeviceIsReadOnly
1225 # If a long-running operation is using the device, DeviceInUse
1229 { 'command': 'block_resize', 'data': { 'device': 'str', 'size': 'int' }}
1234 # An enumeration that tells QEMU how to set the backing file path in
1237 # @existing: QEMU should look for an existing image file.
1239 # @absolute-paths: QEMU should create a new image with absolute paths
1240 # for the backing file.
1244 { 'enum': 'NewImageMode'
1245 'data': [ 'existing', 'absolute-paths' ] }
1250 # @device: the name of the device to generate the snapshot from.
1252 # @snapshot-file: the target of the new image. A new file will be created.
1254 # @format: #optional the format of the snapshot image, default is 'qcow2'.
1256 # @mode: #optional whether and how QEMU should create a new image, default is
1259 { 'type': 'BlockdevSnapshot',
1260 'data': { 'device': 'str', 'snapshot-file': 'str', '*format': 'str',
1261 '*mode': 'NewImageMode' } }
1266 # A discriminated record of operations that can be performed with
1269 { 'union': 'BlockdevAction',
1271 'blockdev-snapshot-sync': 'BlockdevSnapshot',
1277 # Atomically operate on a group of one or more block devices. If
1278 # any operation fails, then the entire set of actions will be
1279 # abandoned and the appropriate error returned. The only operation
1280 # supported is currently blockdev-snapshot-sync.
1283 # @BlockdevAction: information needed for the device snapshot
1285 # Returns: nothing on success
1286 # If @device is not a valid block device, DeviceNotFound
1287 # If @device is busy, DeviceInUse will be returned
1288 # If @snapshot-file can't be created, OpenFileFailed
1289 # If @snapshot-file can't be opened, OpenFileFailed
1290 # If @format is invalid, InvalidBlockFormat
1292 # Note: The transaction aborts on the first failure. Therefore, there will
1293 # be only one device or snapshot file returned in an error condition, and
1294 # subsequent actions will not have been attempted.
1298 { 'command': 'transaction',
1299 'data': { 'actions': [ 'BlockdevAction' ] } }
1302 # @blockdev-snapshot-sync
1304 # Generates a synchronous snapshot of a block device.
1306 # @device: the name of the device to generate the snapshot from.
1308 # @snapshot-file: the target of the new image. If the file exists, or if it
1309 # is a device, the snapshot will be created in the existing
1310 # file/device. If does not exist, a new file will be created.
1312 # @format: #optional the format of the snapshot image, default is 'qcow2'.
1314 # @mode: #optional whether and how QEMU should create a new image, default is
1317 # Returns: nothing on success
1318 # If @device is not a valid block device, DeviceNotFound
1319 # If @snapshot-file can't be opened, OpenFileFailed
1320 # If @format is invalid, InvalidBlockFormat
1324 { 'command': 'blockdev-snapshot-sync',
1325 'data': { 'device': 'str', 'snapshot-file': 'str', '*format': 'str',
1326 '*mode': 'NewImageMode'} }
1329 # @human-monitor-command:
1331 # Execute a command on the human monitor and return the output.
1333 # @command-line: the command to execute in the human monitor
1335 # @cpu-index: #optional The CPU to use for commands that require an implicit CPU
1337 # Returns: the output of the command as a string
1341 # Notes: This command only exists as a stop-gap. It's use is highly
1342 # discouraged. The semantics of this command are not guaranteed.
1344 # Known limitations:
1346 # o This command is stateless, this means that commands that depend
1347 # on state information (such as getfd) might not work
1349 # o Commands that prompt the user for data (eg. 'cont' when the block
1350 # device is encrypted) don't currently work
1352 { 'command': 'human-monitor-command',
1353 'data': {'command-line': 'str', '*cpu-index': 'int'},
1359 # Cancel the current executing migration process.
1361 # Returns: nothing on success
1363 # Notes: This command succeeds even if there is no migration process running.
1367 { 'command': 'migrate_cancel' }
1370 # @migrate_set_downtime
1372 # Set maximum tolerated downtime for migration.
1374 # @value: maximum downtime in seconds
1376 # Returns: nothing on success
1380 { 'command': 'migrate_set_downtime', 'data': {'value': 'number'} }
1383 # @migrate_set_speed
1385 # Set maximum speed for migration.
1387 # @value: maximum speed in bytes.
1389 # Returns: nothing on success
1391 # Notes: A value lesser than zero will be automatically round up to zero.
1395 { 'command': 'migrate_set_speed', 'data': {'value': 'int'} }
1398 # @ObjectPropertyInfo:
1400 # @name: the name of the property
1402 # @type: the type of the property. This will typically come in one of four
1405 # 1) A primitive type such as 'u8', 'u16', 'bool', 'str', or 'double'.
1406 # These types are mapped to the appropriate JSON type.
1408 # 2) A legacy type in the form 'legacy<subtype>' where subtype is the
1409 # legacy qdev typename. These types are always treated as strings.
1411 # 3) A child type in the form 'child<subtype>' where subtype is a qdev
1412 # device type name. Child properties create the composition tree.
1414 # 4) A link type in the form 'link<subtype>' where subtype is a qdev
1415 # device type name. Link properties form the device model graph.
1419 # Notes: This type is experimental. Its syntax may change in future releases.
1421 { 'type': 'ObjectPropertyInfo',
1422 'data': { 'name': 'str', 'type': 'str' } }
1427 # This command will list any properties of a object given a path in the object
1430 # @path: the path within the object model. See @qom-get for a description of
1433 # Returns: a list of @ObjectPropertyInfo that describe the properties of the
1438 # Notes: This command is experimental. It's syntax may change in future
1441 { 'command': 'qom-list',
1442 'data': { 'path': 'str' },
1443 'returns': [ 'ObjectPropertyInfo' ] }
1448 # This command will get a property from a object model path and return the
1451 # @path: The path within the object model. There are two forms of supported
1452 # paths--absolute and partial paths.
1454 # Absolute paths are derived from the root object and can follow child<>
1455 # or link<> properties. Since they can follow link<> properties, they
1456 # can be arbitrarily long. Absolute paths look like absolute filenames
1457 # and are prefixed with a leading slash.
1459 # Partial paths look like relative filenames. They do not begin
1460 # with a prefix. The matching rules for partial paths are subtle but
1461 # designed to make specifying objects easy. At each level of the
1462 # composition tree, the partial path is matched as an absolute path.
1463 # The first match is not returned. At least two matches are searched
1464 # for. A successful result is only returned if only one match is
1465 # found. If more than one match is found, a flag is return to
1466 # indicate that the match was ambiguous.
1468 # @property: The property name to read
1470 # Returns: The property value. The type depends on the property type. legacy<>
1471 # properties are returned as #str. child<> and link<> properties are
1472 # returns as #str pathnames. All integer property types (u8, u16, etc)
1473 # are returned as #int.
1477 # Notes: This command is experimental and may change syntax in future releases.
1479 { 'command': 'qom-get',
1480 'data': { 'path': 'str', 'property': 'str' },
1481 'returns': 'visitor',
1487 # This command will set a property from a object model path.
1489 # @path: see @qom-get for a description of this parameter
1491 # @property: the property name to set
1493 # @value: a value who's type is appropriate for the property type. See @qom-get
1494 # for a description of type mapping.
1498 # Notes: This command is experimental and may change syntax in future releases.
1500 { 'command': 'qom-set',
1501 'data': { 'path': 'str', 'property': 'str', 'value': 'visitor' },
1507 # Sets the password of a remote display session.
1509 # @protocol: `vnc' to modify the VNC server password
1510 # `spice' to modify the Spice server password
1512 # @password: the new password
1514 # @connected: #optional how to handle existing clients when changing the
1515 # password. If nothing is specified, defaults to `keep'
1516 # `fail' to fail the command if clients are connected
1517 # `disconnect' to disconnect existing clients
1518 # `keep' to maintain existing clients
1520 # Returns: Nothing on success
1521 # If Spice is not enabled, DeviceNotFound
1522 # If @protocol does not support connected, InvalidParameter
1523 # If @protocol is invalid, InvalidParameter
1524 # If any other error occurs, SetPasswdFailed
1526 # Notes: If VNC is not enabled, SetPasswdFailed is returned.
1530 { 'command': 'set_password',
1531 'data': {'protocol': 'str', 'password': 'str', '*connected': 'str'} }
1536 # Expire the password of a remote display server.
1538 # @protocol: the name of the remote display protocol `vnc' or `spice'
1540 # @time: when to expire the password.
1541 # `now' to expire the password immediately
1542 # `never' to cancel password expiration
1543 # `+INT' where INT is the number of seconds from now (integer)
1544 # `INT' where INT is the absolute time in seconds
1546 # Returns: Nothing on success
1547 # If @protocol is `spice' and Spice is not active, DeviceNotFound
1548 # If an error occurs setting password expiration, SetPasswdFailed
1549 # If @protocol is not `spice' or 'vnc', InvalidParameter
1553 # Notes: Time is relative to the server and currently there is no way to
1554 # coordinate server time with client time. It is not recommended to
1555 # use the absolute time version of the @time parameter unless you're
1556 # sure you are on the same machine as the QEMU instance.
1558 { 'command': 'expire_password', 'data': {'protocol': 'str', 'time': 'str'} }
1563 # Ejects a device from a removable drive.
1565 # @device: The name of the device
1567 # @force: @optional If true, eject regardless of whether the drive is locked.
1568 # If not specified, the default value is false.
1570 # Returns: Nothing on success
1571 # If @device is not a valid block device, DeviceNotFound
1572 # If @device is not removable and @force is false, DeviceNotRemovable
1573 # If @force is false and @device is locked, DeviceLocked
1575 # Notes: Ejecting a device will no media results in success
1579 { 'command': 'eject', 'data': {'device': 'str', '*force': 'bool'} }
1582 # @change-vnc-password:
1584 # Change the VNC server password.
1586 # @target: the new password to use with VNC authentication
1590 # Notes: An empty password in this command will set the password to the empty
1591 # string. Existing clients are unaffected by executing this command.
1593 { 'command': 'change-vnc-password', 'data': {'password': 'str'} }
1598 # This command is multiple commands multiplexed together.
1600 # @device: This is normally the name of a block device but it may also be 'vnc'.
1601 # when it's 'vnc', then sub command depends on @target
1603 # @target: If @device is a block device, then this is the new filename.
1604 # If @device is 'vnc', then if the value 'password' selects the vnc
1605 # change password command. Otherwise, this specifies a new server URI
1606 # address to listen to for VNC connections.
1608 # @arg: If @device is a block device, then this is an optional format to open
1610 # If @device is 'vnc' and @target is 'password', this is the new VNC
1611 # password to set. If this argument is an empty string, then no future
1612 # logins will be allowed.
1614 # Returns: Nothing on success.
1615 # If @device is not a valid block device, DeviceNotFound
1616 # If @format is not a valid block format, InvalidBlockFormat
1617 # If the new block device is encrypted, DeviceEncrypted. Note that
1618 # if this error is returned, the device has been opened successfully
1619 # and an additional call to @block_passwd is required to set the
1620 # device's password. The behavior of reads and writes to the block
1621 # device between when these calls are executed is undefined.
1623 # Notes: It is strongly recommended that this interface is not used especially
1624 # for changing block devices.
1628 { 'command': 'change',
1629 'data': {'device': 'str', 'target': 'str', '*arg': 'str'} }
1632 # @block_set_io_throttle:
1634 # Change I/O throttle limits for a block drive.
1636 # @device: The name of the device
1638 # @bps: total throughput limit in bytes per second
1640 # @bps_rd: read throughput limit in bytes per second
1642 # @bps_wr: write throughput limit in bytes per second
1644 # @iops: total I/O operations per second
1646 # @ops_rd: read I/O operations per second
1648 # @iops_wr: write I/O operations per second
1650 # Returns: Nothing on success
1651 # If @device is not a valid block device, DeviceNotFound
1652 # If the argument combination is invalid, InvalidParameterCombination
1656 { 'command': 'block_set_io_throttle',
1657 'data': { 'device': 'str', 'bps': 'int', 'bps_rd': 'int', 'bps_wr': 'int',
1658 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int' } }
1663 # Copy data from a backing file into a block device.
1665 # The block streaming operation is performed in the background until the entire
1666 # backing file has been copied. This command returns immediately once streaming
1667 # has started. The status of ongoing block streaming operations can be checked
1668 # with query-block-jobs. The operation can be stopped before it has completed
1669 # using the block-job-cancel command.
1671 # If a base file is specified then sectors are not copied from that base file and
1672 # its backing chain. When streaming completes the image file will have the base
1673 # file as its backing file. This can be used to stream a subset of the backing
1674 # file chain instead of flattening the entire image.
1676 # On successful completion the image file is updated to drop the backing file
1677 # and the BLOCK_JOB_COMPLETED event is emitted.
1679 # @device: the device name
1681 # @base: #optional the common backing file name
1683 # @speed: #optional the maximum speed, in bytes per second
1685 # Returns: Nothing on success
1686 # If streaming is already active on this device, DeviceInUse
1687 # If @device does not exist, DeviceNotFound
1688 # If image streaming is not supported by this device, NotSupported
1689 # If @base does not exist, BaseNotFound
1690 # If @speed is invalid, InvalidParameter
1694 { 'command': 'block-stream', 'data': { 'device': 'str', '*base': 'str',
1698 # @block-job-set-speed:
1700 # Set maximum speed for a background block operation.
1702 # This command can only be issued when there is an active block job.
1704 # Throttling can be disabled by setting the speed to 0.
1706 # @device: the device name
1708 # @speed: the maximum speed, in bytes per second, or 0 for unlimited.
1711 # Returns: Nothing on success
1712 # If the job type does not support throttling, NotSupported
1713 # If the speed value is invalid, InvalidParameter
1714 # If no background operation is active on this device, DeviceNotActive
1718 { 'command': 'block-job-set-speed',
1719 'data': { 'device': 'str', 'speed': 'int' } }
1722 # @block-job-cancel:
1724 # Stop an active background block operation.
1726 # This command returns immediately after marking the active background block
1727 # operation for cancellation. It is an error to call this command if no
1728 # operation is in progress.
1730 # The operation will cancel as soon as possible and then emit the
1731 # BLOCK_JOB_CANCELLED event. Before that happens the job is still visible when
1732 # enumerated using query-block-jobs.
1734 # For streaming, the image file retains its backing file unless the streaming
1735 # operation happens to complete just as it is being cancelled. A new streaming
1736 # operation can be started at a later time to finish copying all data from the
1739 # @device: the device name
1741 # Returns: Nothing on success
1742 # If no background operation is active on this device, DeviceNotActive
1743 # If cancellation already in progress, DeviceInUse
1747 { 'command': 'block-job-cancel', 'data': { 'device': 'str' } }
1752 # This structure describes a search result from @qom-list-types
1754 # @name: the type name found in the search
1758 # Notes: This command is experimental and may change syntax in future releases.
1760 { 'type': 'ObjectTypeInfo',
1761 'data': { 'name': 'str' } }
1766 # This command will return a list of types given search parameters
1768 # @implements: if specified, only return types that implement this type name
1770 # @abstract: if true, include abstract types in the results
1772 # Returns: a list of @ObjectTypeInfo or an empty list if no results are found
1776 # Notes: This command is experimental and may change syntax in future releases.
1778 { 'command': 'qom-list-types',
1779 'data': { '*implements': 'str', '*abstract': 'bool' },
1780 'returns': [ 'ObjectTypeInfo' ] }
1785 # Migrates the current running guest to another Virtual Machine.
1787 # @uri: the Uniform Resource Identifier of the destination VM
1789 # @blk: #optional do block migration (full disk copy)
1791 # @inc: #optional incremental disk copy migration
1793 # @detach: this argument exists only for compatibility reasons and
1794 # is ignored by QEMU
1796 # Returns: nothing on success
1800 { 'command': 'migrate',
1801 'data': {'uri': 'str', '*blk': 'bool', '*inc': 'bool', '*detach': 'bool' } }
1803 # @xen-save-devices-state:
1805 # Save the state of all devices to file. The RAM and the block devices
1806 # of the VM are not saved by this command.
1808 # @filename: the file to save the state of the devices to as binary
1809 # data. See xen-save-devices-state.txt for a description of the binary
1812 # Returns: Nothing on success
1813 # If @filename cannot be opened, OpenFileFailed
1814 # If an I/O error occurs while writing the file, IOError
1818 { 'command': 'xen-save-devices-state', 'data': {'filename': 'str'} }
1823 # Remove a device from a guest
1825 # @id: the name of the device
1827 # Returns: Nothing on success
1828 # If @id is not a valid device, DeviceNotFound
1829 # If the device does not support unplug, BusNoHotplug
1831 # Notes: When this command completes, the device may not be removed from the
1832 # guest. Hot removal is an operation that requires guest cooperation.
1833 # This command merely requests that the guest begin the hot removal
1838 { 'command': 'device_del', 'data': {'id': 'str'} }
1841 # @dump-guest-memory
1843 # Dump guest's memory to vmcore. It is a synchronous operation that can take
1844 # very long depending on the amount of guest memory. This command is only
1845 # supported on i386 and x86_64.
1847 # @paging: if true, do paging to get guest's memory mapping. This allows
1848 # using gdb to process the core file. However, setting @paging to false
1849 # may be desirable because of two reasons:
1851 # 1. The guest may be in a catastrophic state or can have corrupted
1852 # memory, which cannot be trusted
1853 # 2. The guest can be in real-mode even if paging is enabled. For example,
1854 # the guest uses ACPI to sleep, and ACPI sleep state goes in real-mode
1856 # @protocol: the filename or file descriptor of the vmcore. The supported
1859 # 1. file: the protocol starts with "file:", and the following string is
1861 # 2. fd: the protocol starts with "fd:", and the following string is the
1864 # @begin: #optional if specified, the starting physical address.
1866 # @length: #optional if specified, the memory size, in bytes. If you don't
1867 # want to dump all guest's memory, please specify the start @begin and @length
1869 # Returns: nothing on success
1870 # If @begin contains an invalid address, InvalidParameter
1871 # If only one of @begin and @length is specified, MissingParameter
1872 # If @protocol stats with "fd:", and the fd cannot be found, FdNotFound
1873 # If @protocol starts with "file:", and the file cannot be
1874 # opened, OpenFileFailed
1875 # If @protocol does not start with "fd:" or "file:", InvalidParameter
1876 # If an I/O error occurs while writing the file, IOError
1877 # If the target does not support this command, Unsupported
1881 { 'command': 'dump-guest-memory',
1882 'data': { 'paging': 'bool', 'protocol': 'str', '*begin': 'int',
1883 '*length': 'int' } }
1887 # Add a network backend.
1889 # @type: the type of network backend. Current valid values are 'user', 'tap',
1890 # 'vde', 'socket', 'dump' and 'bridge'
1892 # @id: the name of the new network backend
1894 # @props: #optional a list of properties to be passed to the backend in
1895 # the format 'name=value', like 'ifname=tap0,script=no'
1897 # Notes: The semantics of @props is not well defined. Future commands will be
1898 # introduced that provide stronger typing for backend creation.
1902 # Returns: Nothing on success
1903 # If @type is not a valid network backend, DeviceNotFound
1904 # If @id is not a valid identifier, InvalidParameterValue
1905 # if @id already exists, DuplicateId
1906 # If @props contains an invalid parameter for this backend,
1909 { 'command': 'netdev_add',
1910 'data': {'type': 'str', 'id': 'str', '*props': '**'},
1916 # Remove a network backend.
1918 # @id: the name of the network backend to remove
1920 # Returns: Nothing on success
1921 # If @id is not a valid network backend, DeviceNotFound
1925 { 'command': 'netdev_del', 'data': {'id': 'str'} }
1928 # @NetdevNoneOptions
1930 # Use it alone to have zero network devices.
1934 { 'type': 'NetdevNoneOptions',
1938 # @NetLegacyNicOptions
1940 # Create a new Network Interface Card.
1942 # @netdev: #optional id of -netdev to connect to
1944 # @macaddr: #optional MAC address
1946 # @model: #optional device model (e1000, rtl8139, virtio etc.)
1948 # @addr: #optional PCI device address
1950 # @vectors: #optional number of MSI-x vectors, 0 to disable MSI-X
1954 { 'type': 'NetLegacyNicOptions',
1960 '*vectors': 'uint32' } }
1965 # A fat type wrapping 'str', to be embedded in lists.
1974 # @NetdevUserOptions
1976 # Use the user mode network stack which requires no administrator privilege to
1979 # @hostname: #optional client hostname reported by the builtin DHCP server
1981 # @restrict: #optional isolate the guest from the host
1983 # @ip: #optional legacy parameter, use net= instead
1985 # @net: #optional IP address and optional netmask
1987 # @host: #optional guest-visible address of the host
1989 # @tftp: #optional root directory of the built-in TFTP server
1991 # @bootfile: #optional BOOTP filename, for use with tftp=
1993 # @dhcpstart: #optional the first of the 16 IPs the built-in DHCP server can
1996 # @dns: #optional guest-visible address of the virtual nameserver
1998 # @smb: #optional root directory of the built-in SMB server
2000 # @smbserver: #optional IP address of the built-in SMB server
2002 # @hostfwd: #optional redirect incoming TCP or UDP host connections to guest
2005 # @guestfwd: #optional forward guest TCP connections
2009 { 'type': 'NetdevUserOptions',
2012 '*restrict': 'bool',
2018 '*dhcpstart': 'str',
2021 '*smbserver': 'str',
2022 '*hostfwd': ['String'],
2023 '*guestfwd': ['String'] } }
2028 # Connect the host TAP network interface name to the VLAN.
2030 # @ifname: #optional interface name
2032 # @fd: #optional file descriptor of an already opened tap
2034 # @script: #optional script to initialize the interface
2036 # @downscript: #optional script to shut down the interface
2038 # @helper: #optional command to execute to configure bridge
2040 # @sndbuf: #optional send buffer limit. Understands [TGMKkb] suffixes.
2042 # @vnet_hdr: #optional enable the IFF_VNET_HDR flag on the tap interface
2044 # @vhost: #optional enable vhost-net network accelerator
2046 # @vhostfd: #optional file descriptor of an already opened vhost net device
2048 # @vhostforce: #optional vhost on for non-MSIX virtio guests
2052 { 'type': 'NetdevTapOptions',
2057 '*downscript': 'str',
2060 '*vnet_hdr': 'bool',
2063 '*vhostforce': 'bool' } }
2066 # @NetdevSocketOptions
2068 # Connect the VLAN to a remote VLAN in another QEMU virtual machine using a TCP
2069 # socket connection.
2071 # @fd: #optional file descriptor of an already opened socket
2073 # @listen: #optional port number, and optional hostname, to listen on
2075 # @connect: #optional port number, and optional hostname, to connect to
2077 # @mcast: #optional UDP multicast address and port number
2079 # @localaddr: #optional source address and port for multicast and udp packets
2081 # @udp: #optional UDP unicast address and port number
2085 { 'type': 'NetdevSocketOptions',
2091 '*localaddr': 'str',
2097 # Connect the VLAN to a vde switch running on the host.
2099 # @sock: #optional socket path
2101 # @port: #optional port number
2103 # @group: #optional group owner of socket
2105 # @mode: #optional permissions for socket
2109 { 'type': 'NetdevVdeOptions',
2114 '*mode': 'uint16' } }
2117 # @NetdevDumpOptions
2119 # Dump VLAN network traffic to a file.
2121 # @len: #optional per-packet size limit (64k default). Understands [TGMKkb]
2124 # @file: #optional dump file path (default is qemu-vlan0.pcap)
2128 { 'type': 'NetdevDumpOptions',
2134 # @NetdevBridgeOptions
2136 # Connect a host TAP network interface to a host bridge device.
2138 # @br: #optional bridge name
2140 # @helper: #optional command to execute to configure bridge
2144 { 'type': 'NetdevBridgeOptions',
2147 '*helper': 'str' } }
2150 # @NetdevHubPortOptions
2152 # Connect two or more net clients through a software hub.
2154 # @hubid: hub identifier number
2158 { 'type': 'NetdevHubPortOptions',
2160 'hubid': 'int32' } }
2165 # A discriminated record of network device traits.
2169 { 'union': 'NetClientOptions',
2171 'none': 'NetdevNoneOptions',
2172 'nic': 'NetLegacyNicOptions',
2173 'user': 'NetdevUserOptions',
2174 'tap': 'NetdevTapOptions',
2175 'socket': 'NetdevSocketOptions',
2176 'vde': 'NetdevVdeOptions',
2177 'dump': 'NetdevDumpOptions',
2178 'bridge': 'NetdevBridgeOptions',
2179 'hubport': 'NetdevHubPortOptions' } }
2184 # Captures the configuration of a network device; legacy.
2186 # @vlan: #optional vlan number
2188 # @id: #optional identifier for monitor commands
2190 # @name: #optional identifier for monitor commands, ignored if @id is present
2192 # @opts: device type specific properties (legacy)
2196 { 'type': 'NetLegacy',
2201 'opts': 'NetClientOptions' } }
2206 # Captures the configuration of a network device.
2208 # @id: identifier for monitor commands.
2210 # @opts: device type specific properties
2217 'opts': 'NetClientOptions' } }
2222 # Receive a file descriptor via SCM rights and assign it a name
2224 # @fdname: file descriptor name
2226 # Returns: Nothing on success
2227 # If file descriptor was not received, FdNotSupplied
2228 # If @fdname is not valid, InvalidParameterType
2232 # Notes: If @fdname already exists, the file descriptor assigned to
2233 # it will be closed and replaced by the received file
2235 # The 'closefd' command can be used to explicitly close the
2236 # file descriptor when it is no longer needed.
2238 { 'command': 'getfd', 'data': {'fdname': 'str'} }
2243 # Close a file descriptor previously passed via SCM rights
2245 # @fdname: file descriptor name
2247 # Returns: Nothing on success
2248 # If @fdname is not found, FdNotFound
2252 { 'command': 'closefd', 'data': {'fdname': 'str'} }