Resource Pool Create V App

Creates a new vApp container.

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.

Required privileges: VApp.Create

Request

URI

POST

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

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

CreateVAppRequestType of type(s) application/json

Required

{
    "name": "string",
    "resSpec": {
        "_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"
    },
    "configSpec": {
        "_typeName": "string",
        "product": [
            {
                "_typeName": "string",
                "operation": "string",
                "removeKey": {
                    "_typeName": "string"
                },
                "info": {
                    "_typeName": "string",
                    "key": 0,
                    "classId": "string",
                    "instanceId": "string",
                    "name": "string",
                    "vendor": "string",
                    "version": "string",
                    "fullVersion": "string",
                    "vendorUrl": "string",
                    "productUrl": "string",
                    "appUrl": "string"
                }
            }
        ],
        "property": [
            {
                "_typeName": "string",
                "operation": "string",
                "removeKey": {
                    "_typeName": "string"
                },
                "info": {
                    "_typeName": "string",
                    "key": 0,
                    "classId": "string",
                    "instanceId": "string",
                    "id": "string",
                    "category": "string",
                    "label": "string",
                    "type": "string",
                    "typeReference": "string",
                    "userConfigurable": false,
                    "defaultValue": "string",
                    "value": "string",
                    "description": "string"
                }
            }
        ],
        "ipAssignment": {
            "_typeName": "string",
            "supportedAllocationScheme": [
                "string"
            ],
            "ipAllocationPolicy": "string",
            "supportedIpProtocol": [
                "string"
            ],
            "ipProtocol": "string"
        },
        "eula": [
            "string"
        ],
        "ovfSection": [
            {
                "_typeName": "string",
                "operation": "string",
                "removeKey": {
                    "_typeName": "string"
                },
                "info": {
                    "_typeName": "string",
                    "key": 0,
                    "namespace": "string",
                    "type": "string",
                    "atEnvelopeLevel": false,
                    "contents": "string"
                }
            }
        ],
        "ovfEnvironmentTransport": [
            "string"
        ],
        "installBootRequired": false,
        "installBootStopDelay": 0,
        "entityConfig": [
            {
                "_typeName": "string",
                "key": {
                    "_typeName": "string",
                    "type": "string",
                    "value": "string"
                },
                "tag": "string",
                "startOrder": 0,
                "startDelay": 0,
                "waitingForGuest": false,
                "startAction": "string",
                "stopDelay": 0,
                "stopAction": "string",
                "destroyWithParent": false
            }
        ],
        "annotation": "string",
        "instanceUuid": "string",
        "managedBy": {
            "_typeName": "string",
            "extensionKey": "string",
            "type": "string"
        }
    },
    "vmFolder": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    }
}

string

name

Required

The name of the vApp container in the inventory

ResourceConfigSpec

resSpec

Required

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

VAppConfigSpec

configSpec

Required

Configuration of a vApp

MoRefFolder

vmFolder

Optional

Reference to an instance of the Folder managed object.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

The created vApp object.

Returns MoRefVirtualApp of type(s) application/json

This response body class contains all of the following: MoRefResourcePool

{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}

500

NotSupported: if the ComputeResource does not support nested resource pools.

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

DuplicateName: if this pool already contains an object with the given name.

InvalidArgument: if the pool specification is invalid.

InsufficientResourcesFault: if the operation would violate a resource usage policy. Typically, a more specific subclass, such as InsufficientCpuResourcesFault will be thrown.

InvalidState: if the resource pool does not support the operation in its current state. This will typically be a subclass such as NoActiveHostInCluster.

VmConfigFault: or a more specific subclass, if errors are found in the supplied in VApp 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

200 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