Virtual Disk API Programming Guide - Documentation - VMware

Virtual Disk Programming Guide
Doing a Restore Operation
The two scenarios of restore operation are described below.
“Restoring an Existing Virtual Machine to a Previous State” on page 62
“Creating a New Virtual Machine” on page 62
Prerequisites
To complete a restore, the calling process requires the permissions in Table 7‐2.
Table 7-2. Required permissions to complete a restore
Privilege Category Privilege Subcategory Privilege
Virtual Machine Inventory Create
For security reasons, programs are not granted write access to the disks of a running virtual machine. Before
you shut it down, you should determine the run‐state of the virtual machine.
Run‐state information is available from the PropertyCollector, and if you keep this information up‐to‐date,
your application already knows the run‐state of the virtual machine. To change the run‐state you must have
the moRef of the virtual machine. Use this moRef in a PowerOnVM_Task call through the server connection. For
virtual machine shutdown, call the PowerOffVM_Task method.
Restoring an Existing Virtual Machine to a Previous State
The following steps restore a virtual machine to a certain saved state:
1 Shut down the virtual machine (if it is not already shut down).
2 With SAN transport only, a snapshot is required to restore a virtual machine, so create this snapshot.
3 Restore contents of the virtual disk(s). If there were no pre‐existing snapshots at backup time, just the
snapshot created for backup, restore only the base disks.
Restoring disk data requires that you obtain the current names of virtual disks. This process is similar to
the one described in “Extract Backup Data from the Target Virtual Machine” on page 61, except in this
case you obtain this information directly from the virtual machine and not from a snapshot. The target for
the saved disk data must be the actual disk name (including any sequence number) because the current
incarnation of a virtual machine may be derived from one or more snapshots.
Restoring disk data requires use of the VixDiskLib interface. The VixDiskLib_Write() function allows
you to open the virtual machine’s virtual disks and write your restore data. VixDiskLib functions transfer
data to even‐sector boundaries only, and the transfer length must be an even multiple of the sector size.
Because the virtual disk already exists, it is not necessary to restore the disk configuration information
mentioned in “Extract Backup Data from the Target Virtual Machine” on page 61.
4 With SAN transport mode, revert‐to and delete the snapshot that you created in Step 2. Failing to perform
these steps with SAN could yield a virtual machine that cannot be powered on.
Creating a New Virtual Machine
The process of building a virtual machine from backup data involves the following steps:
1 Create the virtual machine.
Remove
Configuration Settings
Change Resource
Resource Assign Virtual Machine to Resource Pool
To create a new virtual machine, you use the information about virtual machine configuration that you
derived and saved during the backup process.
62 VMware, Inc.