nbdkit-ones-plugin - Man Page

nbdkit plugin filled with repeated 0xff or other bytes

Synopsis

 nbdkit ones [[size=]SIZE] [byte=N]

Description

nbdkit-ones-plugin is a plugin for nbdkit(1).  Any read returns a repeating pattern of 0xff (all ones) bytes, or another repeating byte if you use the byte parameter.  Everything written to the virtual device is discarded.

Most NBD consumers will be very confused by this device.  It is mainly useful for testing.  nbdkit-data-plugin(1) can be used to create a modifiable RAM disk initialized with fixed data.

Parameters

byte=N

Set the repeating byte to N.  The default is 0xff (all ones).

Instead of byte=0 it is more efficient to use nbdkit-null-plugin(1).

[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-ones-plugin.so

The plugin.

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

Version

nbdkit-ones-plugin first appeared in nbdkit 1.36.

See Also

nbdkit(1), nbdkit-plugin(3), nbdkit-data-plugin(1), nbdkit-full-plugin(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

License

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

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.

Referenced By

nbdkit(1), nbdkit-data-plugin(1), nbdkit-full-plugin(1), nbdkit-null-plugin(1), nbdkit-pattern-plugin(1), nbdkit-plugin(3), nbdkit-random-plugin(1), nbdkit-release-notes-1.36(1), nbdkit-sparse-random-plugin(1), nbdkit-zero-plugin(1).

2024-10-14 nbdkit-1.41.8