nbdkit-file-plugin - nbdkit file plugin
nbdkit file [file=]FILENAME
nbdkit-file-plugin is a file serving plugin for nbdkit(1).
It serves the named
FILENAME over NBD. Local block devices (eg. /dev/sda) may also be served.
To concatenate multiple files, use nbdkit-split-plugin(1).
Serve the file named
FILENAME. A local block device name can also be used here.
This parameter is required.
In nbdkit ≥ 1.8,
file=may be omitted. To ensure that the filename does not end up being parsed accidentally as
key=value, prefix relative paths with
./(absolute paths do not need modification).
These plugin parameters have been moved to the nbdkit-delay-filter(1) filter. Modify the command line to add --filter=delay in order to use these parameters.
You can obtain extra information about how the file plugin was compiled by doing:
nbdkit file --dump-plugin
Some of the fields which may appear are listed below. Note these are for information only and may be changed or removed at any time in the future.
If both set, the plugin may be able to efficiently zero ranges of block devices, where the driver and block device itself supports this.
If set, the plugin may be able to punch holes (make sparse) files and block devices.
If set, the plugin may be able to efficiently zero ranges of files and block devices.
- -D file.zero=1
This enables very verbose debugging of the NBD zero request. This can be used to tell if the file plugin is able to zero ranges in the file or block device efficiently or not.
Richard W.M. Jones
Copyright (C) 2013-2018 Red Hat Inc.