VMware Cloud Director API - POST-CreateEdgeGateway
POST /admin/vdc/{id}/edgeGateways
- Operation:
- POST /admin/vdc/{id}/edgeGateways
- Description:
- Create an edge gateway. 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
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.admin.edgeGateway+xml
application/vnd.vmware.admin.edgeGateway+json
- Output type:
- GatewayType
- Examples
-
- Request
-
HTTP 1.1
POST /api/admin/vdc/afaafb99-228c-4838-ad07-5bf3aa649d42/edgeGateways
Headers:
Content-Length: 1775
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"
name="gateway"
operationKey="operationKey">
<vcloud:Description>Edge Gateway description</vcloud:Description>
<vcloud:Configuration>
<vcloud:BackwardCompatibilityMode>false</vcloud:BackwardCompatibilityMode>
<vcloud:GatewayBackingConfig>compact</vcloud:GatewayBackingConfig>
<vcloud:GatewayInterfaces>
<vcloud:GatewayInterface>
<vcloud:DisplayName>Gateway interface display name</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: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:HaEnabled>true</vcloud:HaEnabled>
<vcloud:UseDefaultRouteForDnsRelay>false</vcloud:UseDefaultRouteForDnsRelay>
</vcloud:Configuration>
</vcloud:EdgeGateway>
- Response
-
HTTP/1.1 201 Created
Headers:
Content-Length: 4462
Content-Type: application/vnd.vmware.admin.edgegateway+xml;version=5.5
Location: https://vcloud.example.com/api/admin/edgeGateway/a5262305-d51d-4664-b380-827137a321f1
Vary: Accept-Encoding
Body:
<?xml version="1.0" encoding="UTF-8"?><EdgeGateway
xmlns="http://www.vmware.com/vcloud/v1.5"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
href="https://vcloud.example.com/api/admin/edgeGateway/a5262305-d51d-4664-b380-827137a321f1"
id="urn:vcloud:gateway:a5262305-d51d-4664-b380-827137a321f1"
name="gateway"
type="application/vnd.vmware.admin.edgeGateway+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/admin/edgeGateway/a5262305-d51d-4664-b380-827137a321f1"
rel="edit"
type="application/vnd.vmware.admin.edgeGateway+xml"/>
<Link
href="https://vcloud.example.com/api/admin/edgeGateway/a5262305-d51d-4664-b380-827137a321f1"
rel="remove"/>
<Link
href="https://vcloud.example.com/api/admin/vdc/afaafb99-228c-4838-ad07-5bf3aa649d42"
rel="up"
type="application/vnd.vmware.admin.vdc+xml"/>
<Link
href="https://vcloud.example.com/api/admin/edgeGateway/a5262305-d51d-4664-b380-827137a321f1/action/redeploy"
rel="edgeGateway:redeploy"/>
<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"/>
<Link
href="https://vcloud.example.com/api/admin/edgeGateway/a5262305-d51d-4664-b380-827137a321f1/action/reapplyServices"
rel="edgeGateway:reapplyServices"/>
<Link
href="https://vcloud.example.com/api/admin/edgeGateway/a5262305-d51d-4664-b380-827137a321f1/action/syncSyslogServerSettings"
rel="edgeGateway:syncSyslogSettings"/>
<Link
href="https://vcloud.example.com/api/admin/edgeGateway/a5262305-d51d-4664-b380-827137a321f1/action/upgradeConfig"
rel="edgeGateway:upgrade"/>
<Description>Edge Gateway description</Description>
<Tasks>
<Task
cancelRequested="false"
expiryTime="2013-05-14T19:11:58.183+03:00"
href="https://vcloud.example.com/api/task/a52858df-83bd-4788-b933-e796c4decad0"
id="urn:vcloud:task:a52858df-83bd-4788-b933-e796c4decad0"
name="task"
operation="Creating EdgeGateway gateway(a5262305-d51d-4664-b380-827137a321f1)"
operationName="networkEdgeGatewayCreate"
serviceNamespace="com.vmware.vcloud"
startTime="2013-02-13T19:11:58.183+02:00"
status="running"
type="application/vnd.vmware.vcloud.task+xml">
<Link
href="https://vcloud.example.com/api/task/a52858df-83bd-4788-b933-e796c4decad0/action/cancel"
rel="task:cancel"/>
<Owner
href="https://vcloud.example.com/api/admin/edgeGateway/a5262305-d51d-4664-b380-827137a321f1"
name="gateway"
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>
</Tasks>
<Configuration>
<GatewayBackingConfig>compact</GatewayBackingConfig>
<GatewayInterfaces>
<GatewayInterface>
<Network
href="https://vcloud.example.com/api/admin/network/9c873a71-3645-4821-b1dc-4101d888a1bb"
name=""
type="application/vnd.vmware.admin.network+xml"/>
<InterfaceType>uplink</InterfaceType>
<SubnetParticipation>
<Gateway>10.26.47.253</Gateway>
<Netmask>255.255.240.0</Netmask>
<IpRanges>
<IpRange>
<StartAddress>10.26.36.47</StartAddress>
<EndAddress>10.26.36.59</EndAddress>
</IpRange>
</IpRanges>
</SubnetParticipation>
<ApplyRateLimit>false</ApplyRateLimit>
<UseForDefaultRoute>true</UseForDefaultRoute>
</GatewayInterface>
</GatewayInterfaces>
<EdgeGatewayServiceConfiguration>
<FirewallService>
<IsEnabled>true</IsEnabled>
<DefaultAction>drop</DefaultAction>
<LogDefaultAction>false</LogDefaultAction>
</FirewallService>
</EdgeGatewayServiceConfiguration>
<HaEnabled>true</HaEnabled>
<UseDefaultRouteForDnsRelay>false</UseDefaultRouteForDnsRelay>
</Configuration>
</EdgeGateway>