NAME

       nbdkit-full-plugin - nbdkit plugin which is always full

SYNOPSIS

        nbdkit full [size=]SIZE

DESCRIPTION

       "nbdkit-full-plugin" is a plugin for nbdkit(1).  Reads from this virtual disk return
       zeroes.  All writes and similar operations like zero and trim fail with "ENOSPC"
       (No space left on device) error.

       In other words this behaves like a sparse (thin-provisioned) virtual disk which has run
       out of space on the host.

   Equivalent nbdkit-error-filter command
       Although this is a standalone plugin, it is equivalent to using nbdkit-error-filter(1):

        nbdkit --filter=error null SIZE \
                              error-pwrite=ENOSPC error-pwrite-rate=100% \
                              error-trim=ENOSPC error-trim-rate=100% \
                              error-zero=ENOSPC error-zero-rate=100%

       nbdkit-error-filter can be more flexible because you can place it on top of other plugins
       and you can control when to inject errors.

PARAMETERS

       [size=]SIZE
           Specify the virtual size of the disk image.

           This parameter is required.

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

FILES

       $plugindir/nbdkit-full-plugin.so
           The plugin.

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

VERSION

       "nbdkit-full-plugin" first appeared in nbdkit 1.10.

SEE ALSO

       nbdkit(1), nbdkit-plugin(3), nbdkit-error-filter(1), nbdkit-null-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-2020 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.