Virtual App Suspend V App Task

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.
Responses
200

OK

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

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