Update the Storage Profile for a Virtual Machine

You can update a Vm to revalidate the storage profile it uses or specify a different storage profile. Revalidation of a virtual machine's current storage profile is required whenever the datastore that supports the virtual machine changes.

Every Vm element includes a StorageProfile element whose href attribute value specifies the default storage profile consumed by the virtual machine. This default is used for all hard diskItems in the VIrtualHardwareSection that do not specify storageProfileOverrideVmDefault.

If you do not specify a StorageProfile during an instantiate, compose, or recompose operation, it is inherited from the organization VDC in which the virtual machine is deployed. To change the value of an existing StorageProfile, you must update the entire Vm element that contains it.

Important: When the system administrator changes the datastore that stores a virtual machine, you must update the Vm element as shown in Update the Storage Profile for a Virtual Machine.

Prerequisites

This operation requires the rights included in the predefined vApp Author role or an equivalent set of rights.

Procedure

1. Retrieve the Vm element.
   Make a GET request to the URL in the value of the href attribute of the Vm.
2. Modify the retrieved Vm to change the StorageProfile reference.

   Request bodies must contain all required elements and attributes, even if you are not changing their values. Because optional elements and attributes typically revert to default values if they are omitted or empty, it is a best practice to include optional elements in request bodies that modify existing objects. Link elements and href attributes from responses do not need to be included in modified sections. Some elements and attributes are read-only and cannot be modified. See the schema reference for details.

3. Update the Vm with your modifications.
   1. Find the Link element in the Vm where rel="edit".
   2. Make a PUT request to the URL in that link's href attribute value, and supply the modified Vm as the request body.
   The response to this request is a Task element that tracks the relocation of the virtual machine to a datastore in the new storage profile. When the task is complete, the virtual machine's StorageProfile has been updated and the virtual machine has been relocated to the new storage profile.

Example: Update the Storage Profile for a Virtual Machine

This example shows a Vm element containing a StorageProfile. The actual update operation requires the entire Vm element, including the StorageProfile, in the request body. Only a small part of the element appears in this example.

Request:

PUT https://vcloud.example.com/api/vApp/vm-4
Content-type: application/vnd.vmware.vcloud.vm+xml
...
<?xml version="1.0" encoding="UTF-8"?>
<Vm ...>
...
 <StorageProfile
      type="application/vnd.vmware.vcloud.vdcStorageProfile+xml"
      name="Gold"
      href="https://vcloud.example.com/api/vdcStorageProfile/3" />

</Vm>

Response:

202 Accepted
Content-Type: application/vnd.vmware.vcloud.task+xml
...
<Task ... operation="Updating Virtual Application Linux FTP server (7)" ...>
...
</Task>