Vcenter ResourcePool create
Creates a resource pool.
This operation was added in vSphere API 7.0.0.0.
Returns an authorization error if you do not have all of the privileges described as follows:
- The resource
ResourcePoolreferenced by the property Vcenter ResourcePool CreateSpec.parent requiresResource.CreatePool.
Specification of the new resource pool to be created, see Vcenter ResourcePool CreateSpec.
Show optional properties
{
"name": "string",
"parent": "string"
}{
"name": "string",
"parent": "string",
"cpu_allocation": {
"reservation": 0,
"expandable_reservation": false,
"limit": 0,
"shares": {
"level": "string",
"shares": 0
}
},
"memory_allocation": {
"reservation": 0,
"expandable_reservation": false,
"limit": 0,
"shares": {
"level": "string",
"shares": 0
}
}
}Name of the resource pool.
This property was added in vSphere API 7.0.0.0.
Parent of the created resource pool.
This property was added in vSphere API 7.0.0.0.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: ResourcePool. When operations return a value of this schema as a response, the property will be an identifier for the resource type: ResourcePool.
Resource allocation for CPU.
This property was added in vSphere API 7.0.0.0.
if missing or null or empty, use the default CPU allocation specification.
Resource allocation for memory.
This property was added in vSphere API 7.0.0.0.
if missing or null or empty, use the default memory allocation specification.
The identifier of the newly created resource pool.
The response will be an identifier for the resource type: ResourcePool.
If a parameter passed in the spec is invalid.
"Vapi Std Errors InvalidArgument Object"If the user can not be authenticated.
"Vapi Std Errors Unauthenticated Object"Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.
For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"
This property was added in vSphere API 7.0.0.0.
This property is optional because it was added in a newer version than its parent node.
If the user doesn't have the required privileges.
"Vapi Std Errors Unauthorized Object"If the resource specified in parent could not be found
"Vapi Std Errors NotFound Object"Vapi Std Errors Error If the system reports an error while responding to the request.
Vapi Std Errors ResourceInaccessible If the specified resource in parent is not accessible.
Vapi Std Errors UnableToAllocateResource if any of the resources needed to create the resource pool could not be allocated.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
If the system is unable to communicate with a service to complete the request.
"Vapi Std Errors ServiceUnavailable Object" curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string","parent:"string"}' https://{api_host}/api/vcenter/resource-pool