plugins/random/nbdkit-random-plugin.pod

   1 =head1 NAME
   2
   3 nbdkit-random-plugin - plugin to serve random data
   4
   5 =head1 SYNOPSIS
   6
   7  nbdkit random [size=]SIZE [seed=SEED]
   8
   9 =head1 DESCRIPTION
  10
  11 C<nbdkit-random-plugin> is a plugin for L<nbdkit(1)> which serves
  12 random data, read only.
  13
  14 The size of the virtual disk must be specified using the C<size>
  15 parameter.  If you specify the C<seed> parameter then you will get the
  16 same random data over multiple runs with the same seed.
  17
  18 The random data is generated using an I<insecure> method.  This plugin
  19 is mainly good for testing NBD clients.
  20
  21 =head1 PARAMETERS
  22
  23 =over 4
  24
  25 =item [B<size=>]SIZE
  26
  27 Specify the virtual size of the disk image.
  28
  29 This parameter is required.
  30
  31 C<size=> is a magic config key and may be omitted in most cases.
  32 See L<nbdkit(1)/Magic parameters>.
  33
  34 =item B<seed=>SEED
  35
  36 Specify the random seed to get repeatable data over multiple runs.
  37
  38 If not specified then a random seed is chosen.
  39
  40 =back
  41
  42 =head1 FILES
  43
  44 =over 4
  45
  46 =item F<$plugindir/nbdkit-random-plugin.so>
  47
  48 The plugin.
  49
  50 Use C<nbdkit --dump-config> to find the location of C<$plugindir>.
  51
  52 =back
  53
  54 =head1 VERSION
  55
  56 C<nbdkit-random-plugin> first appeared in nbdkit 1.4.
  57
  58 =head1 SEE ALSO
  59
  60 L<nbdkit(1)>,
  61 L<nbdkit-plugin(3)>,
  62 L<nbdkit-data-plugin(1)>,
  63 L<nbdkit-full-plugin(1)>,
  64 L<nbdkit-null-plugin(1)>,
  65 L<nbdkit-pattern-plugin(1)>,
  66 L<nbdkit-zero-plugin(1)>.
  67
  68 =head1 AUTHORS
  69
  70 Richard W.M. Jones
  71
  72 =head1 COPYRIGHT
  73
  74 Copyright (C) 2018 Red Hat Inc.