GET /admin/edgeGateway/{id}

Operation:

GET /admin/edgeGateway/{id}

Description:

Retrieve an edge gateway

Since:

5.1

Input parameters

Consume media type(s):

None

Input type:

None

Output parameters

GATEWAYM

Produce media type(s):

application/vnd.vmware.admin.edgeGateway+xml
application/vnd.vmware.admin.edgeGateway+json

Output type:

javax.ws.rs.core.Response

Examples

Request

HTTP 1.1
GET /api/admin/edgeGateway/a5262305-d51d-4664-b380-827137a321f1

Headers:
x-vcloud-authorization: XRNaH2F+r/YvHG81NXAC/2N+smYdsJBcnFdgNt2ATbg=

Body:

Response

HTTP/1.1 200 OK

Headers:
Content-Length: 3434
Content-Type: application/vnd.vmware.admin.edgegateway+xml;version=5.5
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"
    status="1"
    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>
    <Configuration>
        <GatewayBackingConfig>compact</GatewayBackingConfig>
        <GatewayInterfaces>
            <GatewayInterface>
                <Name>VM Network</Name>
                <DisplayName>VM Network</DisplayName>
                <Network
                    href="https://vcloud.example.com/api/admin/network/9c873a71-3645-4821-b1dc-4101d888a1bb"
                    name="VM Network"
                    type="application/vnd.vmware.admin.network+xml"/>
                <InterfaceType>uplink</InterfaceType>
                <SubnetParticipation>
                    <Gateway>10.26.47.253</Gateway>
                    <Netmask>255.255.240.0</Netmask>
                    <IpAddress>10.26.36.46</IpAddress>
                    <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>