Virtual Disk Development Kit Programming Guide

• About   View
• Introduction to the Virtual Disk API   View
• • About the Virtual Disk API   View
  • VDDK Components   View
  • • Virtual Disk Library   View
    • Disk Mount Library   View
    • Virtual Disk Utilities   View
    • Backup and Restore on vSphere   View
    • Backup Design for vCloud Director   View
  • Use Cases for the Virtual Disk Library   View
  • Developing for VMware Platform Products   View
  • • Managed Disk and Hosted Disk   View
    • Advanced Transports   View
    • VDDK and VADP Compared   View
    • Platform Product Compatibility   View
    • Redistributing VDDK Components   View
• Installing the Development Kit   View
• • Prerequisites   View
  • • Development Systems   View
    • Programming Environments   View
    • • Visual Studio on Windows   View
      • C++ and C on Linux   View
      • Java Development for VADP   View
    • VMware Platform Products   View
    • Storage Device Support   View
  • Installing the VDDK Package   View
  • • Repackaging VDDK Libraries   View
    • How to Find VADP Components   View
• Virtual Disk Interfaces   View
• • VMDK File Location   View
  • Virtual Disk Types   View
  • • Persistence Disk Modes   View
    • VMDK File Naming   View
    • Thin Provisioned Disk   View
    • Internationalization and Localization   View
    • Virtual Disk Internal Format   View
    • Grain Directories and Grain Tables   View
  • Data Structures in Virtual Disk API   View
  • • Credentials and Privileges for VMDK Access   View
    • Adapter Types   View
  • Virtual Disk Transport Methods   View
  • • Local File Access   View
    • SAN Transport   View
    • HotAdd Transport   View
    • • About the HotAdd Proxy   View
    • NBDSSL Transport   View
    • • Asynchronous Mode NBDSSL   View
      • NFC Session Limits and Timeouts   View
      • SSL Certificates and Security   View
• Virtual Disk API Functions   View
• • Virtual Disk Library Functions   View
  • • Alphabetic Table of Functions   View
  • Start Up   View
  • • Initialize the Library   View
    • Connect to a Workstation or Server   View
    • VMX Specification   View
  • Disk Operations   View
  • • Create a New Hosted Disk   View
    • Open a Local or Remote Disk   View
    • Read Sectors From a Disk   View
    • Write Sectors To a Disk   View
    • Close a Local or Remote Disk   View
    • Get Information About a Disk   View
    • Free Memory from Get Information   View
  • Metadata Handling   View
  • • Read Metadata Key from Disk   View
    • Get Metadata Table from Disk   View
    • Write Metadata Table to Disk   View
    • Check and Repair Sparse Disk Metadata   View
  • Disk Chaining and Redo Logs   View
  • • Create Child from Parent Disk   View
    • Attach Child to Parent Disk   View
    • Opening in a Chain   View
    • Redo Logs and Linked Clone Backup   View
  • Cloning a Virtual Disk   View
  • • Compute Space Needed for Clone   View
    • Clone a Disk by Copying Data   View
  • Error Handling   View
  • • Return Error Description Text   View
    • Free Error Description Text   View
  • Administrative Disk Operations   View
  • • Rename an Existing Disk   View
    • Grow an Existing Local Disk   View
    • Defragment an Existing Disk   View
    • Shrink an Existing Local Disk   View
    • Unlink Extents to Remove Disk   View
  • Shut Down   View
  • • Disconnect from Server   View
    • Clean Up and Exit   View
  • Advanced Transport APIs   View
  • • Initialize Virtual Disk API   View
    • Phone Home Support   View
    • Location of Log Files   View
    • List Available Transport Methods   View
    • Connect to VMware vSphere   View
    • Get Selected Transport Method   View
    • Prepare For Access and End Access   View
    • SAN Mode on Linux Uses Direct Mode   View
    • Clean Up After Disconnect   View
  • Ordering of Function Calls in Sequence   View
  • Updating Applications for Advanced Transport   View
  • • Algorithm for vSphere Backup   View
    • Backup and Recovery Example   View
  • Multithreading Considerations   View
  • • Multiple Threads and VixDiskLib   View
  • Capabilities of Library Calls   View
  • • Support for Managed Disk   View
    • Support for Hosted Disk   View
• Virtual Disk API Sample Code   View
• • Compiling the Sample Program   View
  • • Visual C++ on Windows   View
    • • SLN and VCPROJ Files   View
    • C++ on Linux Systems   View
    • • Makefile   View
    • Library Files Required   View
  • Usage Message   View
  • Walk-Through of Sample Program   View
  • • Include Files   View
    • Definitions and Structures   View
    • Dynamic Loading   View
    • Wrapper Classes   View
    • Command Functions   View
    • • DoInfo()   View
      • DoCreate()   View
      • DoRedo()   View
      • Write by DoFill()   View
      • DoReadMetadata()   View
      • DoWriteMetadata()   View
      • DoDumpMetadata()   View
      • DoDump()   View
      • DoTestMultiThread()   View
      • DoClone()   View
    • SSL Certificate Thumbprint   View
• Practical Programming Tasks   View
• • Scan VMDK for Virus Signatures   View
  • Creating Virtual Disks   View
  • • Create Local Disk   View
    • Create Remote Disk   View
    • Special Consideration for ESXi Hosts   View
  • VMDK File Versions   View
  • Working with Virtual Disk Data   View
  • • Reading and Writing Local Disk   View
    • Reading and Writing Remote Disk   View
    • Deleting a Disk (Unlink)   View
    • • Effects of Deleting a Virtual Disk   View
    • Renaming a Disk   View
    • • Effects of Renaming a Virtual Disk   View
  • Managing Child Disks   View
  • • Create Redo Logs   View
    • Virtual Disk in Snapshots   View
    • Windows 2000 Read-Only File System   View
  • RDM Disks and Virtual BIOS   View
  • • Restore RDM Disks   View
    • Restore the Virtual BIOS or UEFI   View
  • Interfacing With VMware vSphere   View
  • • The VIX API   View
    • Virus Scan all Hosted Disk   View
    • The vSphere Web Services API   View
    • Virus Scan All Managed Disk   View
    • Read and Write VMDK Using vSphere API   View
    • Improved Virtual Disk (IVD) Backup   View
• Backing Up Virtual Disks in vSphere   View
• • Design and Implementation Overview   View
  • • The Backup Process   View
    • Communicating With the Server   View
    • Information Containers as Managed Objects   View
    • • More About Managed Objects   View
      • Managed Object References   View
      • Unique ID for a Different vCenter   View
    • Gathering Status and Configuration Information   View
    • • PropertyCollector Data   View
      • Useful Property Information   View
    • Doing a Backup Operation   View
    • • Prerequisites for Backup   View
      • Create a Temporary Snapshot on the Target Virtual Machine   View
      • Changed Block Tracking   View
      • Extract Backup Data from the Target Virtual Machine   View
      • Delete the Temporary Snapshot   View
    • Restore a Virtual Machine   View
    • Doing a Restore Operation   View
    • • Prerequisites for Restore   View
      • Restore an Existing Virtual Machine to a Previous State   View
      • Create a New Virtual Machine   View
    • Access Files on Virtual Disks   View
    • More VADP Details   View
  • Low Level Backup Procedures   View
  • • Communicate with the Server   View
    • The PropertyCollector   View
    • • PropertyCollector Arguments   View
      • Getting the Data from the PropertyCollector   View
      • Identifying Virtual Disks for Backup and Restore   View
    • Creating a Snapshot   View
    • Backing Up a Virtual Disk   View
    • Deleting a Snapshot   View
    • New Query Allocated Blocks Function   View
    • Changed Block Tracking on Virtual Disks   View
    • • Enable Changed Block Tracking   View
      • Gathering Changed Block Information   View
      • Troubleshooting   View
      • Limitations on Changed Block Tracking   View
      • Checking for Namespace   View
  • Low Level Restore Procedures   View
  • • Restoring a Virtual Machine and Disk   View
    • • Creating a Virtual Machine   View
      • Using the VirtualMachineConfigInfo   View
      • Editing or Deleting a Device   View
      • Restoring Virtual Disk Data   View
      • Raw Device Mapping (RDM) Disks   View
    • Restore Incremental Backup Data   View
    • Restore with Direct Connection to ESXi Host   View
  • Tips and Best Practices   View
  • • Best Practices for SAN Transport   View
    • Best Practices for HotAdd Transport   View
    • Best Practices for NBDSSL Transport   View
    • General Backup and Restore   View
    • Backup and Restore of Thin-Provisioned Disk   View
    • About Changed Block Tracking   View
    • HotAdd and SCSI Controller IDs   View
    • Encrypted VM Backup and Restore   View
    • Backup and Restore With vTPM   View
  • Windows Backup Implementations   View
  • • Disable Automount in Windows Proxy   View
    • Security and Remote Desktop   View
    • Working with Microsoft Shadow Copy   View
    • Enable Virtual Machine Application Consistent Quiescing   View
    • Application-Consistent Backup and Restore   View
    • New VSS Support Added in vSphere 6.5   View
    • The VMware VSS Implementation   View
  • Linux Backup Implementation   View
• Backing Up vApps in vCloud Director   View
• • Introduction to Tenant vApps   View
  • • Prerequisites   View
    • Other Information   View
  • Conceptual Overview   View
  • • The Backup Process   View
    • The Restore Process   View
  • Use Cases Overview   View
  • • Managing Credentials   View
    • Finding a vApp   View
    • • Inventory Traversal   View
      • Using the Query Service   View
    • Protecting Specified vApps   View
    • Recovering an Older Version of a vApp   View
    • Recovering a Deleted vApp   View
    • Recovering a Single Virtual Machine   View
    • Backing Up vCloud Director   View
  • vCloud API Operations   View
  • • Getting Access to vCloud Director   View
    • Inventory Access   View
    • • Admin Views   View
      • Admin Extensions   View
    • Retrieving Catalog information   View
    • Retrieving vApp Configuration   View
    • • Methods To Retrieve vApp Configuration   View
      • Virtual Machine Information   View
    • Preventing Updates to a vApp During Backup or Restore   View
    • Associating vCloud Resources with vSphere Entities   View
    • Restoring vApps   View
  • Conclusion   View
• Virtual Disk Mount API   View
• • The VixMntapi Library   View
  • • Types and Structures   View
    • • Operating System Information   View
      • Disk Volume Information   View
    • Function Calls   View
    • • VixMntapi_Init()   View
      • VixMntapi_Exit()   View
      • VixMntapi_OpenDiskSet()   View
      • VixMntapi_OpenDisks()   View
      • VixMntapi_GetDiskSetInfo(..   View
      • VixMntapi_FreeDiskSetInfo..   View
      • VixMntapi_CloseDiskSet()   View
      • VixMntapi_GetVolumeHandle..   View
      • VixMntapi_FreeVolumeHandl..   View
      • VixMntapi_GetOsInfo()   View
      • VixMntapi_FreeOsInfo()   View
      • VixMntapi_MountVolume()   View
      • VixMntapi_DismountVolume(..   View
      • VixMntapi_GetVolumeInfo()   View
      • VixMntapi_FreeVolumeInfo(..   View
  • Programming with VixMntapi   View
  • • File System Support   View
    • Diagnostic Logging for VixMntapi   View
    • Read-Only Mount on Linux   View
  • Sample VixMntapi Code   View
  • Restrictions on Virtual Disk Mount   View
• Errors Codes and Open Source   View
• • Recent Changes   View
  • Finding Error Code Documentation   View
  • • Association With VIX API Errors   View
    • Interpreting Errors Codes   View
  • Troubleshooting Dynamic Libraries   View
  • Open Source Components   View