1# -*- Mode: Python -*- 2# 3# QAPI block definitions (vm related) 4 5# QAPI block core definitions 6{ 'include': 'block-core.json' } 7 8## 9# @BiosAtaTranslation: 10# 11# Policy that BIOS should use to interpret cylinder/head/sector 12# addresses. Note that Bochs BIOS and SeaBIOS will not actually 13# translate logical CHS to physical; instead, they will use logical 14# block addressing. 15# 16# @auto: If cylinder/heads/sizes are passed, choose between none and LBA 17# depending on the size of the disk. If they are not passed, 18# choose none if QEMU can guess that the disk had 16 or fewer 19# heads, large if QEMU can guess that the disk had 131072 or 20# fewer tracks across all heads (i.e. cylinders*heads<131072), 21# otherwise LBA. 22# 23# @none: The physical disk geometry is equal to the logical geometry. 24# 25# @lba: Assume 63 sectors per track and one of 16, 32, 64, 128 or 255 26# heads (if fewer than 255 are enough to cover the whole disk 27# with 1024 cylinders/head). The number of cylinders/head is 28# then computed based on the number of sectors and heads. 29# 30# @large: The number of cylinders per head is scaled down to 1024 31# by correspondingly scaling up the number of heads. 32# 33# @rechs: Same as @large, but first convert a 16-head geometry to 34# 15-head, by proportionally scaling up the number of 35# cylinders/head. 36# 37# Since: 2.0 38## 39{ 'enum': 'BiosAtaTranslation', 40 'data': ['auto', 'none', 'lba', 'large', 'rechs']} 41 42## 43# @FloppyDriveType 44# 45# Type of Floppy drive to be emulated by the Floppy Disk Controller. 46# 47# @144: 1.44MB 3.5" drive 48# @288: 2.88MB 3.5" drive 49# @120: 1.2MB 5.25" drive 50# @none: No drive connected 51# @auto: Automatically determined by inserted media at boot 52# 53# Since: 2.6 54## 55{ 'enum': 'FloppyDriveType', 56 'data': ['144', '288', '120', 'none', 'auto']} 57 58## 59# @BlockdevSnapshotInternal 60# 61# @device: the name of the device to generate the snapshot from 62# 63# @name: the name of the internal snapshot to be created 64# 65# Notes: In transaction, if @name is empty, or any snapshot matching @name 66# exists, the operation will fail. Only some image formats support it, 67# for example, qcow2, rbd, and sheepdog. 68# 69# Since: 1.7 70## 71{ 'struct': 'BlockdevSnapshotInternal', 72 'data': { 'device': 'str', 'name': 'str' } } 73 74## 75# @blockdev-snapshot-internal-sync 76# 77# Synchronously take an internal snapshot of a block device, when the format 78# of the image used supports it. 79# 80# For the arguments, see the documentation of BlockdevSnapshotInternal. 81# 82# Returns: nothing on success 83# If @device is not a valid block device, DeviceNotFound 84# If any snapshot matching @name exists, or @name is empty, 85# GenericError 86# If the format of the image used does not support it, 87# BlockFormatFeatureNotSupported 88# 89# Since 1.7 90## 91{ 'command': 'blockdev-snapshot-internal-sync', 92 'data': 'BlockdevSnapshotInternal' } 93 94## 95# @blockdev-snapshot-delete-internal-sync 96# 97# Synchronously delete an internal snapshot of a block device, when the format 98# of the image used support it. The snapshot is identified by name or id or 99# both. One of the name or id is required. Return SnapshotInfo for the 100# successfully deleted snapshot. 101# 102# @device: the name of the device to delete the snapshot from 103# 104# @id: optional the snapshot's ID to be deleted 105# 106# @name: optional the snapshot's name to be deleted 107# 108# Returns: SnapshotInfo on success 109# If @device is not a valid block device, DeviceNotFound 110# If snapshot not found, GenericError 111# If the format of the image used does not support it, 112# BlockFormatFeatureNotSupported 113# If @id and @name are both not specified, GenericError 114# 115# Since 1.7 116## 117{ 'command': 'blockdev-snapshot-delete-internal-sync', 118 'data': { 'device': 'str', '*id': 'str', '*name': 'str'}, 119 'returns': 'SnapshotInfo' } 120 121## 122# @eject: 123# 124# Ejects a device from a removable drive. 125# 126# @device: The name of the device 127# 128# @force: @optional If true, eject regardless of whether the drive is locked. 129# If not specified, the default value is false. 130# 131# Returns: Nothing on success 132# If @device is not a valid block device, DeviceNotFound 133# 134# Notes: Ejecting a device will no media results in success 135# 136# Since: 0.14.0 137## 138{ 'command': 'eject', 'data': {'device': 'str', '*force': 'bool'} } 139 140## 141# @nbd-server-start: 142# 143# Start an NBD server listening on the given host and port. Block 144# devices can then be exported using @nbd-server-add. The NBD 145# server will present them as named exports; for example, another 146# QEMU instance could refer to them as "nbd:HOST:PORT:exportname=NAME". 147# 148# @addr: Address on which to listen. 149# 150# Returns: error if the server is already running. 151# 152# Since: 1.3.0 153## 154{ 'command': 'nbd-server-start', 155 'data': { 'addr': 'SocketAddress' } } 156 157## 158# @nbd-server-add: 159# 160# Export a device to QEMU's embedded NBD server. 161# 162# @device: Block device to be exported 163# 164# @writable: Whether clients should be able to write to the device via the 165# NBD connection (default false). #optional 166# 167# Returns: error if the device is already marked for export. 168# 169# Since: 1.3.0 170## 171{ 'command': 'nbd-server-add', 'data': {'device': 'str', '*writable': 'bool'} } 172 173## 174# @nbd-server-stop: 175# 176# Stop QEMU's embedded NBD server, and unregister all devices previously 177# added via @nbd-server-add. 178# 179# Since: 1.3.0 180## 181{ 'command': 'nbd-server-stop' } 182 183## 184# @DEVICE_TRAY_MOVED 185# 186# Emitted whenever the tray of a removable device is moved by the guest or by 187# HMP/QMP commands 188# 189# @device: device name 190# 191# @tray-open: true if the tray has been opened or false if it has been closed 192# 193# Since: 1.1 194## 195{ 'event': 'DEVICE_TRAY_MOVED', 196 'data': { 'device': 'str', 'tray-open': 'bool' } } 197