qemu/qapi/block-export.json

1 # -*- Mode: Python -*-
10 { 'include': 'block-core.json' }
15 # @handshake-max-seconds: Time limit, in seconds, at which a client
17 #     disconnected, or 0 for no limit (since 10.0; default: 10).
19 # @tls-creds: ID of the TLS credentials object (since 2.6).
21 # @tls-authz: ID of the QAuthZ authorization object used to validate
24 #     fly while the NBD server is active.  If missing, it will default
27 # @max-connections: The maximum number of connections to allow at the
30 #     default: 100).
33   'data': { '*handshake-max-seconds': 'uint32',
34             '*tls-creds': 'str',
35             '*tls-authz': 'str',
36             '*max-connections': 'uint32' } }
65 # @nbd-server-start:
68 # devices can then be exported using `nbd-server-add`.  The NBD server
73 #     - if the server is already running
77 { 'command': 'nbd-server-start',
79   'allow-preconfig': true }
84 # An NBD block export (common options shared between `nbd-server-add`
85 # and the NBD branch of `block-export-add`).
90 # @description: Free-form description of the export, up to 4096 bytes.
102 # `block-export-add`).
106 #     the metadata context name "qemu:dirty-bitmap:BITMAP" to inspect
110 # @allocation-depth: Also export the allocation depth map for @device,
112 #     metadata context name "qemu:allocation-depth" to inspect
120             '*allocation-depth': 'bool' } }
125 # A vhost-user-blk block export.
127 # @addr: The vhost-user socket on which to listen.  Both 'unix' and
131 # @logical-block-size: Logical block size in bytes.  Defaults to 512
134 # @num-queues: Number of request virtqueues.  Must be greater than 0.
141 	    '*logical-block-size': 'size',
142             '*num-queues': 'uint16'} }
154 #     without allow_other.
171 #     accordingly.  (default: false)
173 # @allow-other: If this is off, only QEMU's user is allowed access to
177 #     allow_other as a non-root user requires user_allow_other to be
179 #     mode (the default), the FUSE export driver will first attempt to
181 #     without.  (since 6.1; default: auto)
188             '*allow-other': 'FuseExportAllowOther' },
194 # A vduse-blk block export.
198 # @num-queues: the number of virtqueues.  Defaults to 1.
200 # @queue-size: the size of virtqueue.  Defaults to 256.
202 # @logical-block-size: Logical block size in bytes.  Range [512,
212             '*num-queues': 'uint16',
213             '*queue-size': 'uint16',
214             '*logical-block-size': 'size',
220 # An NBD block export, per legacy `nbd-server-add` command.
225 #     the NBD connection (default false).
229 #     metadata context name "qemu:dirty-bitmap:BITMAP" to inspect the
240 # @nbd-server-add:
247 # Features:
249 # @deprecated: This command is deprecated.  Use `block-export-add`
253 #     - if the server is not running
254 #     - if an export with the same name already exists
258 { 'command': 'nbd-server-add',
259   'data': 'NbdServerAddOptions', 'boxed': true, 'features': ['deprecated'],
260   'allow-preconfig': true }
274 #     - hide: Just hide export from new clients, leave existing
278 #     - soft: Hide export from new clients, answer with ESHUTDOWN for
286 # @nbd-server-remove:
293 #     description.  Default is 'safe'.
295 # Features:
297 # @deprecated: This command is deprecated.  Use `block-export-del`
301 #     - if the server is not running
302 #     - if export is not found
303 #     - if mode is 'safe' and there are existing connections
307 { 'command': 'nbd-server-remove',
309   'features': ['deprecated'],
310   'allow-preconfig': true }
313 # @nbd-server-stop:
316 # previously added via `nbd-server-add`.
320 { 'command': 'nbd-server-stop',
321   'allow-preconfig': true }
330 # @vhost-user-blk: vhost-user-blk export (since 5.2)
334 # @vduse-blk: vduse-blk export (since 7.1)
340             { 'name': 'vhost-user-blk',
343             { 'name': 'vduse-blk', 'if': 'CONFIG_VDUSE_BLK_EXPORT' } ] }
356 # @node-name: The node name of the block node to be exported
360 #     (default false)
364 #     default: false)
367 #     run.  The default is to use the thread currently associated with
370 # @fixed-iothread: True prevents the block node from being moved to
373 #     cannot be moved to the iothread.  The default is false.
376 # @allow-inactive: If true, the export allows the exported node to be inactive.
381 #     (since: 10.0; default: false)
388             '*fixed-iothread': 'bool',
390             'node-name': 'str',
393             '*allow-inactive': 'bool' },
397       'vhost-user-blk': { 'type': 'BlockExportOptionsVhostUserBlk',
401       'vduse-blk': { 'type': 'BlockExportOptionsVduseBlk',
406 # @block-export-add:
412 { 'command': 'block-export-add',
414   'allow-preconfig': true }
417 # @block-export-del:
426 #     description.  Default is 'safe'.
429 #     - if the export is not found
430 #     - if @mode is 'safe' and the export is still in use (e.g. by
435 { 'command': 'block-export-del',
437   'allow-preconfig': true }
460 # @node-name: The node name of the block node that is exported
462 # @shutting-down: True if the export is shutting down (e.g. after a
463 #     `block-export-del` command, but before the shutdown has completed)
470             'node-name': 'str',
471             'shutting-down': 'bool' } }
474 # @query-block-exports:
480 { 'command': 'query-block-exports', 'returns': ['BlockExportInfo'],
481   'allow-preconfig': true }