plugins/vddk/nbdkit-vddk-plugin.pod

   1 =encoding utf8
   2
   3 =head1 NAME
   4
   5 nbdkit-vddk-plugin - VMware VDDK plugin for nbdkit
   6
   7 =head1 SYNOPSIS
   8
   9  nbdkit vddk file=FILENAME
  10
  11 =head1 DESCRIPTION
  12
  13 C<nbdkit-vddk-plugin> is a L<nbdkit(1)> plugin that serves files from
  14 VMware VMDK and other sources by using VMware's proprietary VDDK
  15 library.
  16
  17 Currently it can only serve local VMDK files.  The required
  18 C<file=FILENAME> parameter should point to a VMDK file.  It would be
  19 relatively simple to extend this plugin to access ESX servers or
  20 Virtual Center.
  21
  22 The plugin can serve read-only (if the I<-r> option is used) or
  23 read/write.
  24
  25 =head1 LIBRARY LOCATION
  26
  27 If the VDDK library (C<libvixDiskLib.so>) is located on a non-standard
  28 path, you may need to set C<LD_LIBRARY_PATH> or modify
  29 C</etc/ld.so.conf> before this plugin will work.
  30
  31 The VDDK library may depend on C<libexpat.so.0> which you may have to
  32 install yourself.
  33
  34 =head1 PARAMETERS
  35
  36 =over 4
  37
  38 =item B<config=FILENAME>
  39
  40 This optional parameter lets you specify the name of the VDDK
  41 configuration file.
  42
  43 =item B<file=FILENAME>
  44
  45 Set the name of the VMDK file to serve.  This parameter is required.
  46
  47 =item B<libdir=PATHNAME>
  48
  49 This sets the path of the VMware VDDK library.  It must be an
  50 absolute path.
  51
  52 If the parameter is not given, then a hard-coded path determined at
  53 compile time is used.
  54
  55 =back
  56
  57 =head1 DEBUGGING VDDK
  58
  59 Run nbdkit like this to see all debugging messages:
  60
  61  nbdkit -f -v vddk file=FILENAME
  62
  63 =head1 SEE ALSO
  64
  65 L<vddk.c> in the nbdkit source tree,
  66 L<nbdkit(1)>,
  67 L<nbdkit-plugin(3)>,
  68 L<https://www.vmware.com/support/developer/vddk/>
  69
  70 =head1 AUTHORS
  71
  72 Richard W.M. Jones
  73
  74 =head1 COPYRIGHT
  75
  76 Copyright (C) 2013 Red Hat Inc.
  77
  78 =head1 LICENSE
  79
  80 Redistribution and use in source and binary forms, with or without
  81 modification, are permitted provided that the following conditions are
  82 met:
  83
  84 =over 4
  85
  86 =item *
  87
  88 Redistributions of source code must retain the above copyright
  89 notice, this list of conditions and the following disclaimer.
  90
  91 =item *
  92
  93 Redistributions in binary form must reproduce the above copyright
  94 notice, this list of conditions and the following disclaimer in the
  95 documentation and/or other materials provided with the distribution.
  96
  97 =item *
  98
  99 Neither the name of Red Hat nor the names of its contributors may be
 100 used to endorse or promote products derived from this software without
 101 specific prior written permission.
 102
 103 =back
 104
 105 THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND
 106 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 107 THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 108 PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR
 109 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 110 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 111 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 112 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 113 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 114 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 115 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 116 SUCH DAMAGE.