Resource Pool Update Config

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.3.0 APIs.


Request Body
UpdateConfigRequestType of type(s) application/json
Required
{
    "name": "string",
    "config": {
        "_typeName": "string",
        "entity": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        },
        "changeVersion": "string",
        "lastModified": "string",
        "cpuAllocation": {
            "_typeName": "string",
            "reservation": 0,
            "expandableReservation": false,
            "limit": 0,
            "shares": {
                "_typeName": "string",
                "shares": 0,
                "level": "string"
            },
            "overheadLimit": 0
        },
        "memoryAllocation": {
            "_typeName": "string",
            "reservation": 0,
            "expandableReservation": false,
            "limit": 0,
            "shares": {
                "_typeName": "string",
                "shares": 0,
                "level": "string"
            },
            "overheadLimit": 0
        },
        "scaleDescendantsShares": "string"
    }
}
string
name
Optional

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

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.
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"
        }
    ]
}

Virtual Infrastructure Operations
POST
Resource Pool Create Child VM Task
POST
Resource Pool Create Resource Pool
POST
Resource Pool Create V App
POST
Resource Pool Destroy Task
POST
Resource Pool Destroy Children
GET
Resource Pool Get Alarm Actions Enabled
GET
Resource Pool Get Available Field
GET
Resource Pool Get Child Configuration
GET
Resource Pool Get Config
GET
Resource Pool Get Config Issue
GET
Resource Pool Get Config Status
GET
Resource Pool Get Custom Value
GET
Resource Pool Get Declared Alarm State
GET
Resource Pool Get Disabled Method
GET
Resource Pool Get Effective Role
GET
Resource Pool Get Name
GET
Resource Pool Get Namespace
GET
Resource Pool Get Overall Status
GET
Resource Pool Get Owner
GET
Resource Pool Get Parent
GET
Resource Pool Get Permission
GET
Resource Pool Get Recent Task
GET
Resource Pool Get Resource Pool
GET
Resource Pool Get Runtime
GET
Resource Pool Get Summary
GET
Resource Pool Get Tag
GET
Resource Pool Get Triggered Alarm State
GET
Resource Pool Get Value
GET
Resource Pool Get Vm
POST
Resource Pool Import V App
POST
Resource Pool Move Into Resource Pool
POST
Resource Pool Query Resource Config Option
POST
Resource Pool Refresh Runtime
POST
Resource Pool Register Child VM Task
POST
Resource Pool Reload
POST
Resource Pool Rename Task
POST
Resource Pool Set Custom Value
POST
Resource Pool Update Child Resource Configuration
POST
Resource Pool Update Config