1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
|
=head1 NAME
nbdkit-full-plugin - nbdkit plugin which is always full
=head1 SYNOPSIS
nbdkit full [size=]SIZE
=head1 DESCRIPTION
C<nbdkit-full-plugin> is a plugin for L<nbdkit(1)>. Reads from this
virtual disk return zeroes. All writes and similar operations like
zero and trim fail with C<ENOSPC> S<(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.
=head2 Equivalent nbdkit-error-filter command
Although this is a standalone plugin, it is equivalent to using
L<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.
=head1 PARAMETERS
=over 4
=item [B<size=>]SIZE
Specify the virtual size of the disk image.
This parameter is required.
C<size=> __IS_MAGIC__
=back
=head1 FILES
=over 4
=item F<$plugindir/nbdkit-full-plugin.so>
The plugin.
Use C<nbdkit --dump-config> to find the location of C<$plugindir>.
=back
=head1 VERSION
C<nbdkit-full-plugin> first appeared in nbdkit 1.10.
=head1 SEE ALSO
L<nbdkit(1)>,
L<nbdkit-plugin(3)>,
L<nbdkit-error-filter(1)>,
L<nbdkit-null-plugin(1)>,
L<nbdkit-ones-plugin(1)>,
L<nbdkit-pattern-plugin(1)>,
L<nbdkit-random-plugin(1)>.
L<nbdkit-readonly-filter(1)>,
L<nbdkit-sparse-random-plugin(1)>,
L<nbdkit-zero-plugin(1)>.
=head1 AUTHORS
Richard W.M. Jones
=head1 COPYRIGHT
Copyright Red Hat
|