8 { 'include': 'block-core.json' }
11 # == Additional block stuff (VM related)
15 # @BiosAtaTranslation:
17 # Policy that BIOS should use to interpret cylinder/head/sector
18 # addresses. Note that Bochs BIOS and SeaBIOS will not actually
19 # translate logical CHS to physical; instead, they will use logical
22 # @auto: If cylinder/heads/sizes are passed, choose between none and LBA
23 # depending on the size of the disk. If they are not passed,
24 # choose none if QEMU can guess that the disk had 16 or fewer
25 # heads, large if QEMU can guess that the disk had 131072 or
26 # fewer tracks across all heads (i.e. cylinders*heads<131072),
29 # @none: The physical disk geometry is equal to the logical geometry.
31 # @lba: Assume 63 sectors per track and one of 16, 32, 64, 128 or 255
32 # heads (if fewer than 255 are enough to cover the whole disk
33 # with 1024 cylinders/head). The number of cylinders/head is
34 # then computed based on the number of sectors and heads.
36 # @large: The number of cylinders per head is scaled down to 1024
37 # by correspondingly scaling up the number of heads.
39 # @rechs: Same as @large, but first convert a 16-head geometry to
40 # 15-head, by proportionally scaling up the number of
45 { 'enum': 'BiosAtaTranslation',
46 'data': ['auto', 'none', 'lba', 'large', 'rechs']}
51 # Type of Floppy drive to be emulated by the Floppy Disk Controller.
53 # @144: 1.44MB 3.5" drive
54 # @288: 2.88MB 3.5" drive
55 # @120: 1.2MB 5.25" drive
56 # @none: No drive connected
57 # @auto: Automatically determined by inserted media at boot
61 { 'enum': 'FloppyDriveType',
62 'data': ['144', '288', '120', 'none', 'auto']}
67 # Information about a persistent reservation manager
69 # @id: the identifier of the persistent reservation manager
71 # @connected: true if the persistent reservation manager is connected to
72 # the underlying storage or helper
76 { 'struct': 'PRManagerInfo',
77 'data': {'id': 'str', 'connected': 'bool'} }
82 # Returns a list of information about each persistent reservation manager.
84 # Returns: a list of @PRManagerInfo for each persistent reservation manager
88 { 'command': 'query-pr-managers', 'returns': ['PRManagerInfo'],
89 'allow-preconfig': true }
94 # Ejects the medium from a removable drive.
96 # @device: Block device name
98 # @id: The name or QOM path of the guest device (since: 2.8)
100 # @force: If true, eject regardless of whether the drive is locked.
101 # If not specified, the default value is false.
104 # @deprecated: Member @device is deprecated. Use @id instead.
106 # Returns: - Nothing on success
107 # - If @device is not a valid block device, DeviceNotFound
109 # Notes: Ejecting a device with no media results in success
115 # -> { "execute": "eject", "arguments": { "id": "ide1-0-1" } }
116 # <- { "return": {} }
118 { 'command': 'eject',
119 'data': { '*device': { 'type': 'str', 'features': [ 'deprecated' ] },
124 # @blockdev-open-tray:
126 # Opens a block device's tray. If there is a block driver state tree inserted as
127 # a medium, it will become inaccessible to the guest (but it will remain
128 # associated to the block device, so closing the tray will make it accessible
131 # If the tray was already open before, this will be a no-op.
133 # Once the tray opens, a DEVICE_TRAY_MOVED event is emitted. There are cases in
134 # which no such event will be generated, these include:
136 # - if the guest has locked the tray, @force is false and the guest does not
137 # respond to the eject request
138 # - if the BlockBackend denoted by @device does not have a guest device attached
140 # - if the guest device does not have an actual tray
142 # @device: Block device name
144 # @id: The name or QOM path of the guest device (since: 2.8)
146 # @force: if false (the default), an eject request will be sent to
147 # the guest if it has locked the tray (and the tray will not be opened
148 # immediately); if true, the tray will be opened regardless of whether
152 # @deprecated: Member @device is deprecated. Use @id instead.
158 # -> { "execute": "blockdev-open-tray",
159 # "arguments": { "id": "ide0-1-0" } }
161 # <- { "timestamp": { "seconds": 1418751016,
162 # "microseconds": 716996 },
163 # "event": "DEVICE_TRAY_MOVED",
164 # "data": { "device": "ide1-cd0",
166 # "tray-open": true } }
168 # <- { "return": {} }
171 { 'command': 'blockdev-open-tray',
172 'data': { '*device': { 'type': 'str', 'features': [ 'deprecated' ] },
177 # @blockdev-close-tray:
179 # Closes a block device's tray. If there is a block driver state tree associated
180 # with the block device (which is currently ejected), that tree will be loaded
183 # If the tray was already closed before, this will be a no-op.
185 # @device: Block device name
187 # @id: The name or QOM path of the guest device (since: 2.8)
190 # @deprecated: Member @device is deprecated. Use @id instead.
196 # -> { "execute": "blockdev-close-tray",
197 # "arguments": { "id": "ide0-1-0" } }
199 # <- { "timestamp": { "seconds": 1418751345,
200 # "microseconds": 272147 },
201 # "event": "DEVICE_TRAY_MOVED",
202 # "data": { "device": "ide1-cd0",
204 # "tray-open": false } }
206 # <- { "return": {} }
209 { 'command': 'blockdev-close-tray',
210 'data': { '*device': { 'type': 'str', 'features': [ 'deprecated' ] },
214 # @blockdev-remove-medium:
216 # Removes a medium (a block driver state tree) from a block device. That block
217 # device's tray must currently be open (unless there is no attached guest
220 # If the tray is open and there is no medium inserted, this will be a no-op.
222 # @id: The name or QOM path of the guest device
228 # -> { "execute": "blockdev-remove-medium",
229 # "arguments": { "id": "ide0-1-0" } }
231 # <- { "error": { "class": "GenericError",
232 # "desc": "Tray of device 'ide0-1-0' is not open" } }
234 # -> { "execute": "blockdev-open-tray",
235 # "arguments": { "id": "ide0-1-0" } }
237 # <- { "timestamp": { "seconds": 1418751627,
238 # "microseconds": 549958 },
239 # "event": "DEVICE_TRAY_MOVED",
240 # "data": { "device": "ide1-cd0",
242 # "tray-open": true } }
244 # <- { "return": {} }
246 # -> { "execute": "blockdev-remove-medium",
247 # "arguments": { "id": "ide0-1-0" } }
249 # <- { "return": {} }
252 { 'command': 'blockdev-remove-medium',
253 'data': { 'id': 'str' } }
256 # @blockdev-insert-medium:
258 # Inserts a medium (a block driver state tree) into a block device. That block
259 # device's tray must currently be open (unless there is no attached guest
260 # device) and there must be no medium inserted already.
262 # @id: The name or QOM path of the guest device
264 # @node-name: name of a node in the block driver state graph
270 # -> { "execute": "blockdev-add",
272 # "node-name": "node0",
274 # "file": { "driver": "file",
275 # "filename": "fedora.iso" } } }
276 # <- { "return": {} }
278 # -> { "execute": "blockdev-insert-medium",
279 # "arguments": { "id": "ide0-1-0",
280 # "node-name": "node0" } }
282 # <- { "return": {} }
285 { 'command': 'blockdev-insert-medium',
286 'data': { 'id': 'str',
287 'node-name': 'str'} }
291 # @BlockdevChangeReadOnlyMode:
293 # Specifies the new read-only mode of a block device subject to the
294 # @blockdev-change-medium command.
296 # @retain: Retains the current read-only mode
298 # @read-only: Makes the device read-only
300 # @read-write: Makes the device writable
304 { 'enum': 'BlockdevChangeReadOnlyMode',
305 'data': ['retain', 'read-only', 'read-write'] }
309 # @blockdev-change-medium:
311 # Changes the medium inserted into a block device by ejecting the current medium
312 # and loading a new image file which is inserted as the new medium (this command
313 # combines blockdev-open-tray, blockdev-remove-medium, blockdev-insert-medium
314 # and blockdev-close-tray).
316 # @device: Block device name
318 # @id: The name or QOM path of the guest device
321 # @filename: filename of the new image to be loaded
323 # @format: format to open the new image with (defaults to
326 # @read-only-mode: change the read-only mode of the device; defaults
329 # @force: if false (the default), an eject request through blockdev-open-tray
330 # will be sent to the guest if it has locked the tray (and the tray
331 # will not be opened immediately); if true, the tray will be opened
332 # regardless of whether it is locked. (since 7.1)
335 # @deprecated: Member @device is deprecated. Use @id instead.
341 # 1. Change a removable medium
343 # -> { "execute": "blockdev-change-medium",
344 # "arguments": { "id": "ide0-1-0",
345 # "filename": "/srv/images/Fedora-12-x86_64-DVD.iso",
346 # "format": "raw" } }
347 # <- { "return": {} }
349 # 2. Load a read-only medium into a writable drive
351 # -> { "execute": "blockdev-change-medium",
352 # "arguments": { "id": "floppyA",
353 # "filename": "/srv/images/ro.img",
355 # "read-only-mode": "retain" } }
358 # { "class": "GenericError",
359 # "desc": "Could not open '/srv/images/ro.img': Permission denied" } }
361 # -> { "execute": "blockdev-change-medium",
362 # "arguments": { "id": "floppyA",
363 # "filename": "/srv/images/ro.img",
365 # "read-only-mode": "read-only" } }
367 # <- { "return": {} }
370 { 'command': 'blockdev-change-medium',
371 'data': { '*device': { 'type': 'str', 'features': [ 'deprecated' ] },
376 '*read-only-mode': 'BlockdevChangeReadOnlyMode' } }
380 # @DEVICE_TRAY_MOVED:
382 # Emitted whenever the tray of a removable device is moved by the guest or by
385 # @device: Block device name. This is always present for compatibility
386 # reasons, but it can be empty ("") if the image does not
387 # have a device name associated.
389 # @id: The name or QOM path of the guest device (since 2.8)
391 # @tray-open: true if the tray has been opened or false if it has been closed
397 # <- { "event": "DEVICE_TRAY_MOVED",
398 # "data": { "device": "ide1-cd0",
399 # "id": "/machine/unattached/device[22]",
402 # "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
405 { 'event': 'DEVICE_TRAY_MOVED',
406 'data': { 'device': 'str', 'id': 'str', 'tray-open': 'bool' } }
409 # @PR_MANAGER_STATUS_CHANGED:
411 # Emitted whenever the connected status of a persistent reservation
414 # @id: The id of the PR manager object
416 # @connected: true if the PR manager is connected to a backend
422 # <- { "event": "PR_MANAGER_STATUS_CHANGED",
423 # "data": { "id": "pr-helper0",
426 # "timestamp": { "seconds": 1519840375, "microseconds": 450486 } }
429 { 'event': 'PR_MANAGER_STATUS_CHANGED',
430 'data': { 'id': 'str', 'connected': 'bool' } }
433 # @block_set_io_throttle:
435 # Change I/O throttle limits for a block drive.
437 # Since QEMU 2.4, each device with I/O limits is member of a throttle
440 # If two or more devices are members of the same group, the limits
441 # will apply to the combined I/O of the whole group in a round-robin
442 # fashion. Therefore, setting new I/O limits to a device will affect
445 # The name of the group can be specified using the 'group' parameter.
446 # If the parameter is unset, it is assumed to be the current group of
447 # that device. If it's not in any group yet, the name of the device
448 # will be used as the name for its group.
450 # The 'group' parameter can also be used to move a device to a
451 # different group. In this case the limits specified in the parameters
452 # will be applied to the new group only.
454 # I/O limits can be disabled by setting all of them to 0. In this case
455 # the device will be removed from its group and the rest of its
456 # members will not be affected. The 'group' parameter is ignored.
458 # Returns: - Nothing on success
459 # - If @device is not a valid block device, DeviceNotFound
465 # -> { "execute": "block_set_io_throttle",
466 # "arguments": { "id": "virtio-blk-pci0/virtio-backend",
479 # "bps_max_length": 0,
481 # <- { "return": {} }
483 # -> { "execute": "block_set_io_throttle",
484 # "arguments": { "id": "ide0-1-0",
491 # "bps_max": 8000000,
497 # "bps_max_length": 60,
499 # <- { "return": {} }
501 { 'command': 'block_set_io_throttle', 'boxed': true,
502 'data': 'BlockIOThrottle' }
505 # @block-latency-histogram-set:
507 # Manage read, write and flush latency histograms for the device.
509 # If only @id parameter is specified, remove all present latency histograms
510 # for the device. Otherwise, add/reset some of (or all) latency histograms.
512 # @id: The name or QOM path of the guest device.
514 # @boundaries: list of interval boundary values (see description in
515 # BlockLatencyHistogramInfo definition). If specified, all
516 # latency histograms are removed, and empty ones created for all
517 # io types with intervals corresponding to @boundaries (except for
518 # io types, for which specific boundaries are set through the
519 # following parameters).
521 # @boundaries-read: list of interval boundary values for read latency
522 # histogram. If specified, old read latency histogram is
523 # removed, and empty one created with intervals
524 # corresponding to @boundaries-read. The parameter has higher
525 # priority then @boundaries.
527 # @boundaries-write: list of interval boundary values for write latency
530 # @boundaries-flush: list of interval boundary values for flush latency
533 # Returns: error if device is not found or any boundary arrays are invalid.
538 # set new histograms for all io types with intervals
539 # [0, 10), [10, 50), [50, 100), [100, +inf):
541 # -> { "execute": "block-latency-histogram-set",
542 # "arguments": { "id": "drive0",
543 # "boundaries": [10, 50, 100] } }
544 # <- { "return": {} }
547 # set new histogram only for write, other histograms will remain
548 # not changed (or not created):
550 # -> { "execute": "block-latency-histogram-set",
551 # "arguments": { "id": "drive0",
552 # "boundaries-write": [10, 50, 100] } }
553 # <- { "return": {} }
556 # set new histograms with the following intervals:
557 # read, flush: [0, 10), [10, 50), [50, 100), [100, +inf)
558 # write: [0, 1000), [1000, 5000), [5000, +inf)
560 # -> { "execute": "block-latency-histogram-set",
561 # "arguments": { "id": "drive0",
562 # "boundaries": [10, 50, 100],
563 # "boundaries-write": [1000, 5000] } }
564 # <- { "return": {} }
567 # remove all latency histograms:
569 # -> { "execute": "block-latency-histogram-set",
570 # "arguments": { "id": "drive0" } }
571 # <- { "return": {} }
573 { 'command': 'block-latency-histogram-set',
574 'data': {'id': 'str',
575 '*boundaries': ['uint64'],
576 '*boundaries-read': ['uint64'],
577 '*boundaries-write': ['uint64'],
578 '*boundaries-flush': ['uint64'] } }