VMware Cloud Director API - PUT-Vm

PUT /vApp/{id}

Operation:

PUT /vApp/{id}

Description:

Modify the name or description of a VM.

Since:

0.9

Input parameters

Consume media type(s):: application/vnd.vmware.vcloud.vm+xml
application/vnd.vmware.vcloud.vm+json
Input type:: VmType

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
application/vnd.vmware.vcloud.task+json
Output type:: TaskType

Examples

Request: HTTP 1.1
PUT /api/vApp/vm-89c84bd6-c6f2-4e4c-8a7d-c44a3489e2e4

Headers:
Content-Length: 159
Content-Type: application/vnd.vmware.vcloud.vm+xml; charset=ISO-8859-1
x-vcloud-authorization: uJ13vBx80VGzZ0KcClBqxHNDJr3QI0K5KaQ0YKn2YZ0=

Body:

<?xml version="1.0" encoding="UTF-8"?><vcloud:Vm
    xmlns:vcloud="http://www.vmware.com/vcloud/v1.5"
    name="importedVapp">
    <vcloud:Description/>
</vcloud:Vm>
Response: HTTP/1.1 202 Accepted

Headers:
Content-Length: 1314
Content-Type: application/vnd.vmware.vcloud.task+xml;version=5.5
Location: https://vcloud.example.com/api/task/abf20255-3dcb-419b-be21-f6bfb4acddaf
Vary: Accept-Encoding

Body:

<?xml version="1.0" encoding="UTF-8"?><Task
    xmlns="http://www.vmware.com/vcloud/v1.5"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    cancelRequested="false"
    expiryTime="2013-05-15T13:16:58.808+03:00"
    href="https://vcloud.example.com/api/task/abf20255-3dcb-419b-be21-f6bfb4acddaf"
    id="urn:vcloud:task:abf20255-3dcb-419b-be21-f6bfb4acddaf"
    name="task"
    operation="Updating Virtual Machine (89c84bd6-c6f2-4e4c-8a7d-c44a3489e2e4)"
    operationName="vappUpdateVm"
    serviceNamespace="com.vmware.vcloud"
    startTime="2013-02-14T13:16:58.808+02:00"
    status="running"
    type="application/vnd.vmware.vcloud.task+xml"
    xsi:schemaLocation="http://www.vmware.com/vcloud/v1.5 http://https://vcloud.example.com/api/v1.5/schema/master.xsd">
    <Link
        href="https://vcloud.example.com/api/task/abf20255-3dcb-419b-be21-f6bfb4acddaf/action/cancel"
        rel="task:cancel"/>
    <Owner
        href="https://vcloud.example.com/api/vApp/vm-89c84bd6-c6f2-4e4c-8a7d-c44a3489e2e4"
        name=""
        type="application/vnd.vmware.vcloud.vm+xml"/>
    <User
        href="https://vcloud.example.com/api/admin/user/1260efee-6915-494c-8afa-84e7e6d8a310"
        name="system"
        type="application/vnd.vmware.admin.user+xml"/>
    <Organization
        href="https://vcloud.example.com/api/org/7b832bc5-3d65-45a2-8d35-da28388ab80a"
        name="Default"
        type="application/vnd.vmware.vcloud.org+xml"/>
    <Details/>
</Task>