Skip site navigation (1)Skip section navigation (2)

  
 
  

home | help
nbdkit-full-plugin(1)		     NBDKIT		   nbdkit-full-plugin(1)

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-er-
     ror-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=" prefix 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-ones-plugin(1), nbdkit-pattern-plugin(1), nbdkit-random-plugin(1).
     nbdkit-readonly-filter(1), nbdkit-sparse-random-plugin(1), nbdkit-zero-plu-
     gin(1).

AUTHORS
     Richard W.M. Jones

COPYRIGHT
     Copyright Red Hat

LICENSE
     Redistribution and use in source and binary forms, with or without modifi-
     cation, 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 no-
	 tice, this list of conditions and the following disclaimer in the docu-
	 mentation 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 EX-
     PRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DIS-
     CLAIMED. IN NO EVENT SHALL RED HAT OR CONTRIBUTORS BE LIABLE FOR ANY DI-
     RECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SER-
     VICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
     CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABIL-
     ITY, 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 DAM-
     AGE.

nbdkit-1.46.2			   2026-08-30		   nbdkit-full-plugin(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=nbdkit-full-plugin&sektion=1&manpath=FreeBSD+Ports+15.1.quarterly>

home | help