VMware Cloud Director API - PUT-EdgeGateway

PUT /admin/edgeGateway/{id}

Operation:

PUT /admin/edgeGateway/{id}

Description:

Update an edge gateway. Can only be used for Edge Gateways owned by an Organization vDC. API Version 35.0 is the last version this API is supported for NSX-T Edges.

Since:

5.1

Input parameters

Consume media type(s):: application/vnd.vmware.admin.edgeGateway+xml
application/vnd.vmware.admin.edgeGateway+json
Input type:: GatewayType

Output parameters

TaskType

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/admin/edgeGateway/a5262305-d51d-4664-b380-827137a321f1

Headers:
Content-Length: 3712
Content-Type: application/vnd.vmware.admin.edgeGateway+xml; charset=ISO-8859-1
x-vcloud-authorization: XRNaH2F+r/YvHG81NXAC/2N+smYdsJBcnFdgNt2ATbg=

Body:

<?xml version="1.0" encoding="UTF-8"?><vcloud:EdgeGateway
    xmlns:vcloud="http://www.vmware.com/vcloud/v1.5"
    href="https://vcloud.example.com/api/admin/edgeGateway/a5262305-d51d-4664-b380-827137a321f1"
    id="urn:vcloud:gateway:a5262305-d51d-4664-b380-827137a321f1"
    name="gateway"
    status="1"
    type="application/vnd.vmware.admin.edgeGateway+xml">
    <vcloud:Link
        href="https://vcloud.example.com/api/admin/edgeGateway/a5262305-d51d-4664-b380-827137a321f1"
        rel="edit"
        type="application/vnd.vmware.admin.edgeGateway+xml"/>
    <vcloud:Link
        href="https://vcloud.example.com/api/admin/edgeGateway/a5262305-d51d-4664-b380-827137a321f1"
        rel="remove"/>
    <vcloud:Link
        href="https://vcloud.example.com/api/admin/vdc/afaafb99-228c-4838-ad07-5bf3aa649d42"
        rel="up"
        type="application/vnd.vmware.admin.vdc+xml"/>
    <vcloud:Link
        href="https://vcloud.example.com/api/admin/edgeGateway/a5262305-d51d-4664-b380-827137a321f1/action/redeploy"
        rel="edgeGateway:redeploy"/>
    <vcloud:Link
        href="https://vcloud.example.com/api/admin/edgeGateway/a5262305-d51d-4664-b380-827137a321f1/action/configureServices"
        rel="edgeGateway:configureServices"
        type="application/vnd.vmware.admin.edgeGatewayServiceConfiguration+xml"/>
    <vcloud:Link
        href="https://vcloud.example.com/api/admin/edgeGateway/a5262305-d51d-4664-b380-827137a321f1/action/reapplyServices"
        rel="edgeGateway:reapplyServices"/>
    <vcloud:Link
        href="https://vcloud.example.com/api/admin/edgeGateway/a5262305-d51d-4664-b380-827137a321f1/action/syncSyslogServerSettings"
        rel="edgeGateway:syncSyslogSettings"/>
    <vcloud:Link
        href="https://vcloud.example.com/api/admin/edgeGateway/a5262305-d51d-4664-b380-827137a321f1/action/upgradeConfig"
        rel="edgeGateway:upgrade"/>
    <vcloud:Description>Edge Gateway description</vcloud:Description>
    <vcloud:Configuration>
        <vcloud:GatewayBackingConfig>compact</vcloud:GatewayBackingConfig>
        <vcloud:GatewayInterfaces>
            <vcloud:GatewayInterface>
                <vcloud:Name>VM Network</vcloud:Name>
                <vcloud:DisplayName>VM Network</vcloud:DisplayName>
                <vcloud:Network
                    href="https://vcloud.example.com/api/admin/network/9c873a71-3645-4821-b1dc-4101d888a1bb"
                    name="VM Network"
                    type="application/vnd.vmware.admin.network+xml"/>
                <vcloud:InterfaceType>uplink</vcloud:InterfaceType>
                <vcloud:SubnetParticipation>
                    <vcloud:Gateway>10.26.47.253</vcloud:Gateway>
                    <vcloud:Netmask>255.255.240.0</vcloud:Netmask>
                    <vcloud:IpAddress>10.26.36.46</vcloud:IpAddress>
                    <vcloud:IpRanges>
                        <vcloud:IpRange>
                            <vcloud:StartAddress>10.26.36.47</vcloud:StartAddress>
                            <vcloud:EndAddress>10.26.36.59</vcloud:EndAddress>
                        </vcloud:IpRange>
                    </vcloud:IpRanges>
                </vcloud:SubnetParticipation>
                <vcloud:ApplyRateLimit>false</vcloud:ApplyRateLimit>
                <vcloud:UseForDefaultRoute>true</vcloud:UseForDefaultRoute>
            </vcloud:GatewayInterface>
        </vcloud:GatewayInterfaces>
        <vcloud:EdgeGatewayServiceConfiguration>
            <vcloud:FirewallService>
                <vcloud:IsEnabled>true</vcloud:IsEnabled>
                <vcloud:DefaultAction>drop</vcloud:DefaultAction>
                <vcloud:LogDefaultAction>false</vcloud:LogDefaultAction>
            </vcloud:FirewallService>
        </vcloud:EdgeGatewayServiceConfiguration>
        <vcloud:HaEnabled>true</vcloud:HaEnabled>
        <vcloud:UseDefaultRouteForDnsRelay>false</vcloud:UseDefaultRouteForDnsRelay>
    </vcloud:Configuration>
</vcloud:EdgeGateway>
Response: HTTP/1.1 202 Accepted

Headers:
Content-Length: 1333
Content-Type: application/vnd.vmware.vcloud.task+xml;version=5.5
Location: https://vcloud.example.com/api/task/e809d7a5-fdb9-4700-88f2-68ff8c1e5c48
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-14T19:20:39.891+03:00"
    href="https://vcloud.example.com/api/task/e809d7a5-fdb9-4700-88f2-68ff8c1e5c48"
    id="urn:vcloud:task:e809d7a5-fdb9-4700-88f2-68ff8c1e5c48"
    name="task"
    operation="Updating EdgeGateway (a5262305-d51d-4664-b380-827137a321f1)"
    operationName="edgeGatewayUpdate"
    serviceNamespace="com.vmware.vcloud"
    startTime="2013-02-13T19:20:39.891+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/e809d7a5-fdb9-4700-88f2-68ff8c1e5c48/action/cancel"
        rel="task:cancel"/>
    <Owner
        href="https://vcloud.example.com/api/admin/edgeGateway/a5262305-d51d-4664-b380-827137a321f1"
        name=""
        type="application/vnd.vmware.admin.edgeGateway+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>