Virtual App Suspend V App Task

Suspends this vApp.

Suspends all powered-on virtual machines in a vApp, including virtual machines in child vApps. The virtual machines are suspended in the same order as used for a power-off operation (reverse power-on sequence).

While a vApp is being suspended, all power operations performed on sub entities are disabled through the VIM API. They will throw TaskInProgress.

Required privileges: VApp.Suspend

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/VirtualApp/{moId}/SuspendVApp_Task

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 VirtualApp/{moId}.

string

release

Required

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

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Returns MoRefTask of type(s) application/json

This response body class contains all of the following: MoRefExtensibleManagedObject

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

500

InvalidPowerState: if the vApp is not running

TaskInProgress: if the vApp is busy.

InvalidState: if the operation cannot be performed because of the vApp's current state. For example, if the vApp is in the process of being started.

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

Authentication

Response

200 Response Body

Errors

Virtual App Operations

POST

Virtual App Clone V App Task

POST