plugins/full/nbdkit-full-plugin.pod

   1 =head1 NAME
   2
   3 nbdkit-full-plugin - nbdkit plugin which is always full
   4
   5 =head1 SYNOPSIS
   6
   7  nbdkit full [size=]SIZE
   8
   9 =head1 DESCRIPTION
  10
  11 C<nbdkit-full-plugin> is a plugin for L<nbdkit(1)>.  Reads from this
  12 virtual disk return zeroes.  All writes and similar operations like
  13 zero and trim fail with C<ENOSPC> S<(No space left on device)> error.
  14
  15 In other words this behaves like a sparse (thin-provisioned) virtual
  16 disk which has run out of space on the host.
  17
  18 =head2 Equivalent nbdkit-error-filter command
  19
  20 Although this is a standalone plugin, it is equivalent to using
  21 L<nbdkit-error-filter(1)>:
  22
  23  nbdkit --filter=error null SIZE \
  24                        error-pwrite=ENOSPC error-pwrite-rate=100% \
  25                        error-trim=ENOSPC error-trim-rate=100% \
  26                        error-zero=ENOSPC error-zero-rate=100%
  27
  28 nbdkit-error-filter can be more flexible because you can place it on
  29 top of other plugins and you can control when to inject errors.
  30
  31 =head1 PARAMETERS
  32
  33 =over 4
  34
  35 =item [B<size=>]SIZE
  36
  37 Specify the virtual size of the disk image.
  38
  39 This parameter is required.
  40
  41 C<size=> is a magic config key and may be omitted in most cases.
  42 See L<nbdkit(1)/Magic parameters>.
  43
  44 =back
  45
  46 =head1 FILES
  47
  48 =over 4
  49
  50 =item F<$plugindir/nbdkit-full-plugin.so>
  51
  52 The plugin.
  53
  54 Use C<nbdkit --dump-config> to find the location of C<$plugindir>.
  55
  56 =back
  57
  58 =head1 VERSION
  59
  60 C<nbdkit-full-plugin> first appeared in nbdkit 1.10.
  61
  62 =head1 SEE ALSO
  63
  64 L<nbdkit(1)>,
  65 L<nbdkit-plugin(3)>,
  66 L<nbdkit-error-filter(1)>,
  67 L<nbdkit-null-plugin(1)>,
  68 L<nbdkit-pattern-plugin(1)>,
  69 L<nbdkit-random-plugin(1)>.
  70 L<nbdkit-zero-plugin(1)>.
  71
  72 =head1 AUTHORS
  73
  74 Richard W.M. Jones
  75
  76 =head1 COPYRIGHT
  77
  78 Copyright (C) 2017-2018 Red Hat Inc.