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.  This plugin is mainly good for testing NBD clients.
  13 This plugin creates a non-sparse random disk, for a sparse random disk
  14 see L<nbdkit-sparse-random-plugin(1)>.
  15
  16 The size of the virtual disk must be specified using the C<size>
  17 parameter.  If you specify the C<seed> parameter then you will get the
  18 same random data over multiple runs with the same seed.
  19
  20 The random data is generated using an I<insecure> method.
  21
  22 =head2 Writes and testing copying
  23
  24 Writing to the disk is possible.  If you do this the plugin will check
  25 that what you are writing exactly matches what would be read at the
  26 same offset (if not, it returns EIO error).  You can use this to test
  27 copying programs by making the source and destination NBD URIs be the
  28 same:
  29
  30  nbdkit -U - random size=100M --run 'nbdcopy "$uri" "$uri"'
  31
  32 C<qemu-img convert> could be used in place of nbdcopy.
  33 See also L<nbdkit-checkwrite-filter(1)>.
  34
  35 =head1 PARAMETERS
  36
  37 =over 4
  38
  39 =item [B<size=>]SIZE
  40
  41 Specify the virtual size of the disk image.
  42
  43 This parameter is required.
  44
  45 C<size=> is a magic config key and may be omitted in most cases.
  46 See L<nbdkit(1)/Magic parameters>.
  47
  48 =item B<seed=>SEED
  49
  50 Specify the random seed to get repeatable data over multiple runs.
  51
  52 If not specified then a random seed is chosen.
  53
  54 =back
  55
  56 =head1 FILES
  57
  58 =over 4
  59
  60 =item F<$plugindir/nbdkit-random-plugin.so>
  61
  62 The plugin.
  63
  64 Use C<nbdkit --dump-config> to find the location of C<$plugindir>.
  65
  66 =back
  67
  68 =head1 VERSION
  69
  70 C<nbdkit-random-plugin> first appeared in nbdkit 1.4.
  71
  72 =head1 SEE ALSO
  73
  74 L<nbdkit(1)>,
  75 L<nbdkit-plugin(3)>,
  76 L<nbdkit-data-plugin(1)>,
  77 L<nbdkit-full-plugin(1)>,
  78 L<nbdkit-null-plugin(1)>,
  79 L<nbdkit-pattern-plugin(1)>,
  80 L<nbdkit-sparse-random-plugin(1)>,
  81 L<nbdkit-zero-plugin(1)>,
  82 L<nbdcopy(1)>,
  83 L<qemu-img(1)>.
  84
  85 =head1 AUTHORS
  86
  87 Richard W.M. Jones
  88
  89 =head1 COPYRIGHT
  90
  91 Copyright Red Hat