NAME

nbdkit-null-plugin - nbdkit bitbucket plugin

SYNOPSIS

 nbdkit null [[size=]SIZE]

DESCRIPTION

"nbdkit-null-plugin" is a null plugin for nbdkit(1). Everything written to the virtual device is discarded, and reads back as zeroes.

Most NBD consumers will be very confused by this device. Trying to create filesystems etc on it will likely fail badly. If the client is caching writes locally then you will get inconsistent read behaviour.

The null plugin is also used when probing for installed filters, see "Detect if a filter is installed" in nbdkit-probing(1).

PARAMETERS

[size=]SIZE

Specify the virtual size of the disk image.

This parameter is optional. If omitted then a zero-sized device is created.

"size=" is a magic config key and may be omitted in most cases. See "Magic parameters" in nbdkit(1).

FILES

$plugindir/nbdkit-null-plugin.so

The plugin.

Use "nbdkit --dump-config" to find the location of $plugindir.

VERSION

"nbdkit-null-plugin" first appeared in nbdkit 1.2.

SEE ALSO

nbdkit(1), nbdkit-plugin(3), nbdkit-full-plugin(1), nbdkit-pattern-plugin(1), nbdkit-random-plugin(1). nbdkit-sparse-random-plugin(1), nbdkit-zero-plugin(1).

AUTHORS

Richard W.M. Jones

COPYRIGHT

Copyright (C) 2017 Red Hat Inc.

LICENSE

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
• Neither the name of Red Hat nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.