POST /vApp/{id}/power/action/shutdown

Operation:

POST /vApp/{id}/power/action/shutdown

Description:

Shut down a vApp or VM.

If used on a vApp, shuts down all VMs in the vApp. If used on a VM, shuts down the VM. This operation is available only for a vApp or VM that is powered on.

Since:

0.9

Input parameters

Consume media type(s):

None

Input type:

None

Output parameters

TaskType

This operation is asynchronous and returns a task that you can monitor to track the progress of the request.

Produce media type(s):

application/vnd.vmware.vcloud.task+xml

Output type:

TaskType

Examples

Request

HTTP 1.1
POST /api/vApp/vapp-fdc4f510-f962-4e8d-b95e-475e41ef4d4a/power/action/shutdown

Headers:
x-vcloud-authorization: jqr+cXJMh5uEUJnFp/gCkS96FOCHBN7k130AgMQjUx0=

Body:

Response

HTTP/1.1 202 Accepted

Headers:
Content-Length: 1327
Content-Type: application/vnd.vmware.vcloud.task+xml; version=5.5
Location: https://vcloud.example.com/api/task/0b1980a6-1859-4365-a05f-7c575667d4f3
Vary: Accept-Encoding

Body:

<?xml version="1.0" encoding="UTF-8"?>
<Task
    xmlns="http://www.vmware.com/vcloud/v1.5"
    status="running"
    startTime="2013-03-22T12:28:09.575+02:00"
    serviceNamespace="com.vmware.vcloud"
    operationName="vappShutdownGuest"
    operation="Shutting down Virtual Application Small vapp(fdc4f510-f962-4e8d-b95e-475e41ef4d4a)"
    expiryTime="2013-06-20T12:28:09.575+03:00"
    cancelRequested="false"
    name="task"
    id="urn:vcloud:task:0b1980a6-1859-4365-a05f-7c575667d4f3"
    type="application/vnd.vmware.vcloud.task+xml"
    href="https://vcloud.example.com/api/task/0b1980a6-1859-4365-a05f-7c575667d4f3"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.vmware.com/vcloud/v1.5 http://vcloud.example.com/api/v1.5/schema/master.xsd">
    <Link
        rel="task:cancel"
        href="https://vcloud.example.com/api/task/0b1980a6-1859-4365-a05f-7c575667d4f3/action/cancel"/>
    <Owner
        type="application/vnd.vmware.vcloud.vApp+xml"
        name="Small vapp"
        href="https://vcloud.example.com/api/vApp/vapp-fdc4f510-f962-4e8d-b95e-475e41ef4d4a"/>
    <User
        type="application/vnd.vmware.admin.user+xml"
        name="system"
        href="https://vcloud.example.com/api/admin/user/4b36181e-b32d-456e-ad94-8e0a568b1346"/>
    <Organization
        type="application/vnd.vmware.vcloud.org+xml"
        name="Default"
        href="https://vcloud.example.com/api/org/710affad-0212-4e55-b6ae-4818d6e9166e"/>
    <Details/>
</Task>