plugins: Wire up rust plugin support for NBD_INFO_INIT_STATE
[nbdkit/ericb.git] / plugins / vddk / README.VDDK
blob5ef51dde8754f81258b5178835bde468a675fb85
1 VDDK (Virtual Disk Development Kit) is a proprietary VMware library
2 for accessing VMDK files and VMware ESX servers.  Note that the
3 license of the VDDK library is highly restrictive, preventing any
4 commercial usage without negotiating a separate license from VMware.
6 In order to obtain the VDDK library you have to register for an
7 account and download it from:
9   https://www.vmware.com/support/developer/vddk/
11 This directory contains an nbdkit plugin which uses this library to
12 export VMDK files and VMware disks over NBD.
14 You do NOT require VDDK to compile the plugin, and the plugin does not
15 contain any VMware code.  You only need VDDK at runtime.  The plugin
16 uses dlopen to load the library from LD_LIBRARY_PATH (or else the
17 standard shared library paths).
19 After building nbdkit-vddk-plugin.so, read the man page to find out
20 how to use it (nbdkit-vddk-plugin(1)).  You'll probably also want to
21 read the VDDK developer documentation.
23 Bugs
24 ----
26 Write calls sometimes return VIX_E_DISK_OUTOFRANGE even for write
27 requests which are well inside the disk.
29 The way we do threading in nbdkit is not congruent with the way you're
30 supposed to call VDDK from multithreaded programs.  For more
31 information see:
32 https://www.redhat.com/archives/libguestfs/2019-October/msg00062.html