qemu/qapi/block-export.json

1 # -*- Mode: Python -*-
9 { 'include': 'block-core.json' }
14 # @handshake-max-seconds: Time limit, in seconds, at which a client
16 #     disconnected, or 0 for no limit (since 10.0; default: 10).
18 # @tls-creds: ID of the TLS credentials object (since 2.6).
20 # @tls-authz: ID of the QAuthZ authorization object used to validate
23 #     fly while the NBD server is active.  If missing, it will default
26 # @max-connections: The maximum number of connections to allow at the
29 #     default: 100).
32   'data': { '*handshake-max-seconds': 'uint32',
33             '*tls-creds': 'str',
34             '*tls-authz': 'str',
35             '*max-connections': 'uint32' } }
64 # @nbd-server-start:
67 # devices can then be exported using @nbd-server-add.  The NBD server
72 #     - if the server is already running
76 { 'command': 'nbd-server-start',
78   'allow-preconfig': true }
83 # An NBD block export (common options shared between nbd-server-add
84 # and the NBD branch of block-export-add).
89 # @description: Free-form description of the export, up to 4096 bytes.
101 # block-export-add).
105 #     the metadata context name "qemu:dirty-bitmap:BITMAP" to inspect
109 # @allocation-depth: Also export the allocation depth map for @device,
111 #     metadata context name "qemu:allocation-depth" to inspect
119             '*allocation-depth': 'bool' } }
124 # A vhost-user-blk block export.
126 # @addr: The vhost-user socket on which to listen.  Both 'unix' and
130 # @logical-block-size: Logical block size in bytes.  Defaults to 512
133 # @num-queues: Number of request virtqueues.  Must be greater than 0.
140 	    '*logical-block-size': 'size',
141             '*num-queues': 'uint16'} }
153 #     without allow_other.
170 #     accordingly.  (default: false)
172 # @allow-other: If this is off, only QEMU's user is allowed access to
176 #     allow_other as a non-root user requires user_allow_other to be
178 #     mode (the default), the FUSE export driver will first attempt to
180 #     without.  (since 6.1; default: auto)
187             '*allow-other': 'FuseExportAllowOther' },
193 # A vduse-blk block export.
197 # @num-queues: the number of virtqueues.  Defaults to 1.
199 # @queue-size: the size of virtqueue.  Defaults to 256.
201 # @logical-block-size: Logical block size in bytes.  Range [512,
211             '*num-queues': 'uint16',
212             '*queue-size': 'uint16',
213             '*logical-block-size': 'size',
219 # An NBD block export, per legacy nbd-server-add command.
224 #     the NBD connection (default false).
228 #     metadata context name "qemu:dirty-bitmap:BITMAP" to inspect the
239 # @nbd-server-add:
246 # Features:
248 # @deprecated: This command is deprecated.  Use @block-export-add
252 #     - if the server is not running
253 #     - if an export with the same name already exists
257 { 'command': 'nbd-server-add',
258   'data': 'NbdServerAddOptions', 'boxed': true, 'features': ['deprecated'],
259   'allow-preconfig': true }
273 #     - hide: Just hide export from new clients, leave existing
277 #     - soft: Hide export from new clients, answer with ESHUTDOWN for
285 # @nbd-server-remove:
292 #     description.  Default is 'safe'.
294 # Features:
296 # @deprecated: This command is deprecated.  Use @block-export-del
300 #     - if the server is not running
301 #     - if export is not found
302 #     - if mode is 'safe' and there are existing connections
306 { 'command': 'nbd-server-remove',
308   'features': ['deprecated'],
309   'allow-preconfig': true }
312 # @nbd-server-stop:
315 # previously added via @nbd-server-add.
319 { 'command': 'nbd-server-stop',
320   'allow-preconfig': true }
329 # @vhost-user-blk: vhost-user-blk export (since 5.2)
333 # @vduse-blk: vduse-blk export (since 7.1)
339             { 'name': 'vhost-user-blk',
342             { 'name': 'vduse-blk', 'if': 'CONFIG_VDUSE_BLK_EXPORT' } ] }
355 # @node-name: The node name of the block node to be exported
359 #     (default false)
363 #     default: false)
366 #     run.  The default is to use the thread currently associated with
369 # @fixed-iothread: True prevents the block node from being moved to
372 #     cannot be moved to the iothread.  The default is false.
375 # @allow-inactive: If true, the export allows the exported node to be inactive.
380 #     (since: 10.0; default: false)
387             '*fixed-iothread': 'bool',
389             'node-name': 'str',
392             '*allow-inactive': 'bool' },
396       'vhost-user-blk': { 'type': 'BlockExportOptionsVhostUserBlk',
400       'vduse-blk': { 'type': 'BlockExportOptionsVduseBlk',
405 # @block-export-add:
411 { 'command': 'block-export-add',
413   'allow-preconfig': true }
416 # @block-export-del:
425 #     description.  Default is 'safe'.
428 #     - if the export is not found
429 #     - if @mode is 'safe' and the export is still in use (e.g. by
434 { 'command': 'block-export-del',
436   'allow-preconfig': true }
459 # @node-name: The node name of the block node that is exported
461 # @shutting-down: True if the export is shutting down (e.g. after a
462 #     block-export-del command, but before the shutdown has completed)
469             'node-name': 'str',
470             'shutting-down': 'bool' } }
473 # @query-block-exports:
479 { 'command': 'query-block-exports', 'returns': ['BlockExportInfo'],
480   'allow-preconfig': true }