Resource Pool Update Config

Updates the configuration of the resource pool.

Any % (percent) character used in this name parameter must be escaped, unless it is used to start an escape sequence. Clients may also escape any other characters in this name parameter.

The privilege checks for this operation are as follows:

If this is a resource pool, the privilege Resource.EditPool is required on this and on the parent pool or vApp.
If this is a vApp, the privilege VApp.ResourceConfig is required on this and on the parent pool or vApp.

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/ResourcePool/{moId}/UpdateConfig

COPY

Path Parameters

string

moId

Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case ResourcePool/{moId}.

string

release

Required

The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.

Request Body

UpdateConfigRequestType of type(s) application/json

Required

{
    "name": "string",
    "config": {
        "entity": {
            "type": "string",
            "value": "string"
        },
        "changeVersion": "string",
        "lastModified": "string",
        "cpuAllocation": {
            "reservation": 0,
            "expandableReservation": false,
            "limit": 0,
            "shares": {
                "shares": 0,
                "level": "string"
            },
            "overheadLimit": 0
        },
        "memoryAllocation": {
            "reservation": 0,
            "expandableReservation": false,
            "limit": 0,
            "shares": {
                "shares": 0,
                "level": "string"
            },
            "overheadLimit": 0
        },
        "scaleDescendantsShares": "string"
    }
}

string

name

Optional

If set, then the new name of the resource pool.

ResourceConfigSpec

config

Optional

This data object type is a specification for a set of resources allocated to a virtual machine or a resource pool.

Authentication

This operation uses the following authentication methods.

Session

Responses

204

No Content

Operation doesn't return any data structure

500

InvalidName: if the name is not a valid entity name.

DuplicateName: if the name is changed to an already existing name.

InvalidArgument: if the parameters are out of range, or if the reservationLimit field is set.

InsufficientResourcesFault: if the pool specification cannot be supported by the parent resource pool or vApp.

ConcurrentAccess: if the changeVersion does not match the server's changeVersion for the configuration.

Returns VimFault of type(s) application/json

This response body class contains all of the following: MethodFault

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

204 Response Body

Errors

Resource Pool Operations

POST

Resource Pool Create Child VM Task

POST

Resource Pool Create Resource Pool

POST

Resource Pool Create V App