#
# Returns:
# - nothing on success
+#
+# Errors:
# - If @device is not a valid block device, DeviceNotFound
#
# Since: 0.14
#
# Returns:
# - nothing on success
+#
+# Errors:
# - If @device is not a valid block device, DeviceNotFound
#
# Since: 0.14
#
# Returns:
# - Nothing on success
+#
+# Errors:
# - If "device" does not exist or cannot be determined,
# DeviceNotFound
#
#
# Returns:
# - Nothing on success
+#
+# Errors:
# - If @device does not exist, DeviceNotFound
# - Any other error returns a GenericError.
#
#
# Returns:
# - nothing on success
+#
+# Errors:
# - If @device is not a valid block device, GenericError
#
# Since: 1.6
#
# Returns:
# - nothing on success
+#
+# Errors:
# - If @device is not a valid block device, DeviceNotFound
#
# Since: 2.3
#
# Returns:
# - nothing on success
+#
+# Errors:
# - If @device is not a valid block device, GenericError
#
# Since: 1.3
#
# Returns:
# - nothing on success
+#
+# Errors:
# - If @node is not a valid block device or node, DeviceNotFound
# - If @name is already taken, GenericError with an explanation
#
#
# Returns:
# - nothing on success
+#
+# Errors:
# - If @node is not a valid block device or node, DeviceNotFound
# - If @name is not found, GenericError with an explanation
# - if @name is frozen by an operation, GenericError
#
# Returns:
# - nothing on success
+#
+# Errors:
# - If @node is not a valid block device, DeviceNotFound
# - If @name is not found, GenericError with an explanation
#
#
# Returns:
# - nothing on success
+#
+# Errors:
# - If @node is not a valid block device, DeviceNotFound
# - If @name is not found, GenericError with an explanation
#
#
# Returns:
# - nothing on success
+#
+# Errors:
# - If @node is not a valid block device, DeviceNotFound
# - If @name is not found, GenericError with an explanation
#
#
# Returns:
# - nothing on success
+#
+# Errors:
# - If @node is not a valid block device, DeviceNotFound
# - If any bitmap in @bitmaps or @target is not found,
# GenericError
#
# Returns:
# - BlockDirtyBitmapSha256 on success
+#
+# Errors:
# - If @node is not a valid block device, DeviceNotFound
# - If @name is not found or if hashing has failed, GenericError
# with an explanation
#
# Returns:
# - Nothing on success.
+#
+# Errors:
# - If @device does not exist, DeviceNotFound.
#
# Since: 1.1
#
# Returns:
# - Nothing on success
+#
+# Errors:
# - If no background operation is active on this device,
# DeviceNotActive
#
#
# Returns:
# - Nothing on success
+#
+# Errors:
# - If no background operation is active on this device,
# DeviceNotActive
#
#
# Returns:
# - Nothing on success
+#
+# Errors:
# - If no background operation is active on this device,
# DeviceNotActive
#
#
# Returns:
# - Nothing on success
+#
+# Errors:
# - If no background operation is active on this device,
# DeviceNotActive
#
#
# Returns:
# - Nothing on success
+#
+# Errors:
# - If no background operation is active on this device,
# DeviceNotActive
#
#
# Returns:
# - nothing on success
+#
+# Errors:
# - If @device is not a valid block device, GenericError
# - If any snapshot matching @name exists, or @name is empty,
# GenericError
#
# Returns:
# - SnapshotInfo on success
+#
+# Errors:
# - If @device is not a valid block device, GenericError
# - If snapshot not found, GenericError
# - If the format of the image used does not support it,
# server from advertising multiple client support (since 5.2;
# default: 0).
#
-# Returns: error if the server is already running.
+# Errors:
+# - if the server is already running
#
# Since: 1.3
##
# @deprecated: This command is deprecated. Use @block-export-add
# instead.
#
-# Returns: error if the server is not running, or export with the same
-# name already exists.
+# Errors:
+# - if the server is not running
+# - if an export with the same name already exists
#
# Since: 1.3
##
# @deprecated: This command is deprecated. Use @block-export-del
# instead.
#
-# Returns: error if
-#
-# - the server is not running
-# - export is not found
-# - mode is 'safe' and there are existing connections
+# Errors:
+# - if the server is not running
+# - if export is not found
+# - if mode is 'safe' and there are existing connections
#
# Since: 2.12
##
# @mode: Mode of command operation. See @BlockExportRemoveMode
# description. Default is 'safe'.
#
-# Returns: Error if the export is not found or @mode is 'safe' and the
-# export is still in use (e.g. by existing client connections)
+# Errors:
+# - if the export is not found
+# - if @mode is 'safe' and the export is still in use (e.g. by
+# existing client connections)
#
# Since: 5.2
##
#
# Returns:
# - Nothing on success
+#
+# Errors:
# - If @device is not a valid block device, DeviceNotFound
#
# Notes: Ejecting a device with no media results in success
#
# Returns:
# - Nothing on success
+#
+# Errors:
# - If @device is not a valid block device, DeviceNotFound
#
# Since: 1.1
# @boundaries-flush: list of interval boundary values for flush
# latency histogram.
#
-# Returns: error if device is not found or any boundary arrays are
-# invalid.
+# Errors:
+# - if device is not found or any boundary arrays are invalid.
#
# Since: 4.0
#
# Some architectures may not support comparing CPU models. s390x
# supports comparing CPU models.
#
-# Returns: a CpuModelBaselineInfo. Returns an error if comparing CPU
-# models is not supported, if a model cannot be used, if a model
-# contains an unknown cpu definition name, unknown properties or
-# properties with wrong types.
+# Returns: a CpuModelBaselineInfo
+#
+# Errors:
+# - if comparing CPU models is not supported
+# - if a model cannot be used
+# - if a model contains an unknown cpu definition name, unknown
+# properties or properties with wrong types.
#
# Note: this command isn't specific to s390x, but is only implemented
# on this architecture currently.
# Some architectures may not support baselining CPU models. s390x
# supports baselining CPU models.
#
-# Returns: a CpuModelBaselineInfo. Returns an error if baselining CPU
-# models is not supported, if a model cannot be used, if a model
-# contains an unknown cpu definition name, unknown properties or
-# properties with wrong types.
+# Returns: a CpuModelBaselineInfo
+#
+# Errors:
+# - if baselining CPU models is not supported
+# - if a model cannot be used
+# - if a model contains an unknown cpu definition name, unknown
+# properties or properties with wrong types.
#
# Note: this command isn't specific to s390x, but is only implemented
# on this architecture currently.
# Some architectures may not support all expansion types. s390x
# supports "full" and "static". Arm only supports "full".
#
-# Returns: a CpuModelExpansionInfo. Returns an error if expanding CPU
-# models is not supported, if the model cannot be expanded, if the
-# model contains an unknown CPU definition name, unknown
-# properties or properties with a wrong type. Also returns an
-# error if an expansion type is not supported.
+# Returns: a CpuModelExpansionInfo
+#
+# Errors:
+# - if expanding CPU models is not supported
+# - if the model cannot be expanded
+# - if the model contains an unknown CPU definition name, unknown
+# properties or properties with a wrong type
+# - if an expansion type is not supported
#
# Since: 2.8
##
#
# Returns:
# - Nothing on success
+#
+# Errors:
# - If the balloon driver is enabled but not functional because
# the KVM kernel module cannot support it, KVMMissingCap
# - If no balloon device is present, DeviceNotActive
#
# Returns:
# - @BalloonInfo on success
+#
+# Errors:
# - If the balloon driver is enabled but not functional because
# the KVM kernel module cannot support it, KVMMissingCap
# - If no balloon device is present, DeviceNotActive
#
# Returns:
# - @HvBalloonInfo on success
+#
+# Errors:
# - If no hv-balloon device is present, guest memory status
# reporting is not enabled or no guest memory status report
# received yet, GenericError
#
# Returns:
# - @AddfdInfo on success
+#
+# Errors:
# - If file descriptor was not received, GenericError
# - If @fdset-id is a negative value, GenericError
#
#
# Returns:
# - Nothing on success
+#
+# Errors:
# - If @fdset-id or @fd is not found, GenericError
#
# Since: 1.2
# @option: option name
#
# Returns: list of @CommandLineOptionInfo for all options (or for the
-# given @option). Returns an error if the given @option doesn't
-# exist.
+# given @option).
+#
+# Errors:
+# - if the given @option doesn't exist
#
# Since: 1.5
#
#
# Returns:
# - Nothing on success
+#
+# Errors:
# - If @name is not a valid network device, DeviceNotFound
#
# Since: 0.14
#
# Returns:
# - Nothing on success
+#
+# Errors:
# - If @type is not a valid network backend, DeviceNotFound
#
# Example:
#
# Returns:
# - Nothing on success
+#
+# Errors:
# - If @id is not a valid network backend, DeviceNotFound
#
# Since: 0.14
# @name: net client name
#
# Returns: list of @RxFilterInfo for all NICs (or for the given NIC).
-# Returns an error if the given @name doesn't exist, or given NIC
-# doesn't support rx-filter querying, or given net client isn't a
-# NIC.
+#
+# Errors:
+# - if the given @name doesn't exist
+# - if the given NIC doesn't support rx-filter querying
+# - if the given net client isn't a NIC
#
# Since: 1.6
#
#
# Returns:
# - Nothing on success
+#
+# Errors:
# - If @id is not a valid device, DeviceNotFound
#
# Notes: When this command completes, the device may not be removed
#
# Returns:
# - Nothing on success
+#
+# Errors:
# - Error if @qom-type is not a valid class name
#
# Since: 2.0
#
# Returns:
# - Nothing on success
+#
+# Errors:
# - Error if @id is not a valid id for a QOM object
#
# Since: 2.0
#
# Returns: nothing on success
#
-# Errors depend on the operations of the transaction
+# Errors:
+# Any errors from commands in the transaction
#
# Note: The transaction aborts on the first failure. Therefore, there
# will be information on only one failed operation returned in an
#
# Returns:
# - Nothing on success
+#
+# Errors:
# - If Spice is not enabled, DeviceNotFound
#
# Since: 0.14
#
# Returns:
# - Nothing on success
+#
+# Errors:
# - If @protocol is 'spice' and Spice is not active,
# DeviceNotFound
#
#
# Returns:
# - Nothing on success
+#
+# Errors:
# - If key is unknown or redundant, GenericError
#
# Since: 1.3
#
# Returns:
# - Nothing on success
+#
+# Errors:
# - @DeviceNotFound error, if any of the YankInstances doesn't exist
#
# Example:
projects / qemu.git / commitdiff