This API has a deprecated equivalent from v7.0U1.
Update Resource Pool
Updates the configuration of a resource pool. if you do not have all of the privileges described as follows: - The resource ResourcePool referenced by the parameter resourcePool requires Resource.EditPool.
Request
URLURL
https://{api_host}/api/vcenter/resource-pool/{resource_pool}
Path Parameters
Path Parameters
string
resource_pool
Required
Identifier of the resource pool. The parameter must be an identifier for the resource type: ResourcePool.
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
ResourcePoolUpdateSpec of mimetype application/json
Required
Specification for updating the configuration of the resource pool.
{
"cpu_allocation": {
"expandable_reservation": false,
"limit": 0,
"reservation": 0,
"shares": {
"level": "LOW",
"shares": 0
}
},
"memory_allocation": {
"expandable_reservation": false,
"limit": 0,
"reservation": 0,
"shares": {
"level": "LOW",
"shares": 0
}
},
"name": "string"
}
cpu_allocation
Optional
Resource allocation for CPU. if unset or empty, the CPU allocation of the resource pool will not be changed.
memory_allocation
Optional
Resource allocation for memory. if unset or empty, the memory allocation of the resource pool will not be changed.
string
name
Optional
Name of the resource pool. if unset or empty, the name of the resource pool will not be changed.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.invalid_argument : If any of the specified parameters is invalid.
403
com.vmware.vapi.std.errors.unauthorized : If the user doesn’t have the required privileges.
500
com.vmware.vapi.std.errors.error : If the system reports an error while responding to the request. | com.vmware.vapi.std.errors.unable_to_allocate_resource : If any of the resources needed to reconfigure the resource pool could not be allocated.
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
$ResourcePoolSharesInfo = Initialize-ResourcePoolSharesInfo -Level "LOW" -Shares 0
$ResourcePoolResourceAllocationUpdateSpec = Initialize-ResourcePoolResourceAllocationUpdateSpec -Reservation 0 -ExpandableReservation $false -Limit 0 -Shares $ResourcePoolSharesInfo
$ResourcePoolUpdateSpec = Initialize-ResourcePoolUpdateSpec -Name "MyName" -CpuAllocation $ResourcePoolResourceAllocationUpdateSpec -MemoryAllocation $ResourcePoolResourceAllocationUpdateSpec
Invoke-UpdateResourcePool -ResourcePool "MyResourcePool" -ResourcePoolUpdateSpec $ResourcePoolUpdateSpec
cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"cpu_allocation":{"expandable_reservation":false,"limit":0,"reservation":0,"shares":{"level":"LOW","shares":0}},"memory_allocation":{"expandable_reservation":false,"limit":0,"reservation":0,"shares":{"level":"LOW","shares":0}},"name":"string"}' https://{api_host}/api/vcenter/resource-pool/{resource_pool}
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/resource-pool/{resource_pool}
x-vmw-doc-operation: update
Availability
Added in 7.0U2
On This Page
Resource Pool Operations
post
patch
delete
