Permalink
Fetching contributors…
Cannot retrieve contributors at this time
106 lines (62 sloc) 2.11 KB

NAME

nbdkit-file-plugin - nbdkit file plugin

SYNOPSIS

nbdkit file [file=]FILENAME

DESCRIPTION

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).

PARAMETERS

file=FILENAME

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).

rdelay
wdelay

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.

DUMP-PLUGIN OUTPUT

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.

file_blksszget=yes
file_blkzeroout=yes

If both set, the plugin may be able to efficiently zero ranges of block devices, where the driver and block device itself supports this.

file_falloc_fl_punch_hole=yes

If set, the plugin may be able to punch holes (make sparse) files and block devices.

file_falloc_fl_zero_range=yes

If set, the plugin may be able to efficiently zero ranges of files and block devices.

DEBUG FLAG

-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.

SEE ALSO

nbdkit(1), nbdkit-plugin(3), nbdkit-split-plugin(1), nbdkit-partitioning-plugin(1).

AUTHORS

Eric Blake

Nir Soffer

Richard W.M. Jones

COPYRIGHT

Copyright (C) 2013-2018 Red Hat Inc.