This API has a deprecated equivalent from v7.0U1.
Update Storage Policy
Updates the storage policy configuration of a virtual machine and/or its associated virtual hard disks.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/storage/policy
Path Parameters
Path Parameters
string
vm
Required
Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
VmStoragePolicyUpdateSpec of mimetype application/json
Required
Storage Policy Specification for updating the virtual machine and virtual disks.
{
"disks": {
"key": {
"policy": "string",
"type": "USE_SPECIFIED_POLICY"
}
},
"vm_home": {
"policy": "string",
"type": "USE_SPECIFIED_POLICY"
}
}
disks
Optional
Storage policy or policies to be used when reconfiguring virtual machine diks. if unset the current storage policy is retained. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.
vm_home
Optional
Storage policy to be used when reconfiguring the virtual machine home. if unset the current storage policy is retained.
Authentication
This operation uses the following authentication methods.
Errors
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required priveleges.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.resource_busy : if the virtual machine or disk is busy performing another operation. | com.vmware.vapi.std.errors.resource_inaccessible : if the virtual machine or disk’s configuration state cannot be accessed.
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$VmStoragePolicyVmHomePolicySpec = Initialize-VmStoragePolicyVmHomePolicySpec -Type "USE_SPECIFIED_POLICY" -Policy "MyPolicy"
$VmStoragePolicyDiskPolicySpec = Initialize-VmStoragePolicyDiskPolicySpec -Type "USE_SPECIFIED_POLICY" -Policy "MyPolicy"
$VmStoragePolicyUpdateSpec = Initialize-VmStoragePolicyUpdateSpec -VmHome $VmStoragePolicyVmHomePolicySpec -Disks @{ key_example = $VmStoragePolicyDiskPolicySpec }
Invoke-UpdateVmStoragePolicy -Vm "MyVm" -VmStoragePolicyUpdateSpec $VmStoragePolicyUpdateSpec
cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"disks":{"key":{"policy":"string","type":"USE_SPECIFIED_POLICY"}},"vm_home":{"policy":"string","type":"USE_SPECIFIED_POLICY"}}' https://{api_host}/api/vcenter/vm/{vm}/storage/policy
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: patch
x-vmw-doc-deprecated-path: /rest/vcenter/vm/{vm}/storage/policy
x-vmw-doc-operation: update
Availability
Added in 7.0U2
On This Page
Storage Policy Operations
patch
