VMware Cloud Director API - EdgeGateway

GatewayType

Element:

EdgeGateway

Type:

GatewayType

Namespace:

http://www.vmware.com/vcloud/v1.5

Description:

Represents a gateway.

Since:

5.1

Schema:

network.xsd

Media type(s):

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

Extends:

EntityType

XML Representation:

<EdgeGateway xmlns="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
        name="xs:string" status="xs:int">
    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string" model="xs:string"/>
    <Description> xs:string </Description>
    <Tasks>
        <Task href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
                name="xs:string" status="xs:string" operation="xs:string" operationName="xs:string"
                serviceNamespace="xs:string" startTime="xs:dateTime" endTime="xs:dateTime" expiryTime="xs:dateTime"
                cancelRequested="xs:boolean">
            <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string" model="xs:string"/>
            <Description> xs:string </Description>
            <Tasks> TasksInProgressType </Tasks>
            <Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
                    vendorSpecificErrorCode="xs:string">
                <TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"/>
            </Error>
            <User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Progress> xs:int </Progress>
            <Params> ... </Params>
            <Details> xs:string </Details>
            <VcTaskList>
                <VcTask name="xs:string" moref="xs:string" status="xs:string" description="xs:string"
                        errorMessage="xs:string" objectName="xs:string" objectType="xs:string" objectMoref="xs:string"
                        virtualCenterID="xs:string" startTime="xs:dateTime" endTime="xs:dateTime"/>
            </VcTaskList>
            <Result>
                <ResultContent> ... </ResultContent>
                <ResultReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            </Result>
        </Task>
    </Tasks>
    <GatewayBackingRef>
        <gatewayId> xs:string </gatewayId>
        <VCRef id="xs:string" type="xs:string" name="xs:string"/>
    </GatewayBackingRef>
    <EdgeGatewayType> EdgeGatewayType </EdgeGatewayType>
    <Configuration>
        <BackwardCompatibilityMode> xs:boolean </BackwardCompatibilityMode>
        <GatewayBackingConfig> xs:string </GatewayBackingConfig>
        <GatewayInterfaces>
            <GatewayInterface>
                <Name> xs:string </Name>
                <DisplayName> xs:string </DisplayName>
                <Network href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
                <InterfaceType> xs:string </InterfaceType>
                <SubnetParticipation>
                    <Gateway> IpAddressType </Gateway>
                    <Netmask> IpAddressType </Netmask>
                    <SubnetPrefixLength> xs:int </SubnetPrefixLength>
                    <IpAddress> IpAddressType </IpAddress>
                    <IpRanges>
                        <IpRange>
                            <StartAddress> IpAddressType </StartAddress>
                            <EndAddress> IpAddressType </EndAddress>
                        </IpRange>
                    </IpRanges>
                    <UseForDefaultRoute> xs:boolean </UseForDefaultRoute>
                    <TotalIpCount> xs:int </TotalIpCount>
                    <AutoAllocateIpRanges> xs:boolean </AutoAllocateIpRanges>
                </SubnetParticipation>
                <ApplyRateLimit> xs:boolean </ApplyRateLimit>
                <InRateLimit> xs:double </InRateLimit>
                <OutRateLimit> xs:double </OutRateLimit>
                <UseForDefaultRoute> xs:boolean </UseForDefaultRoute>
                <Connected> xs:boolean </Connected>
                <QuickAddAllocatedIpCount> xs:int </QuickAddAllocatedIpCount>
                <NetworkBackingType> xs:string </NetworkBackingType>
            </GatewayInterface>
        </GatewayInterfaces>
        <EdgeGatewayServiceConfiguration>
            <NetworkService>
                <IsEnabled> xs:boolean </IsEnabled>
            </NetworkService>
        </EdgeGatewayServiceConfiguration>
        <HaEnabled> xs:boolean </HaEnabled>
        <UseDefaultRouteForDnsRelay> xs:boolean </UseDefaultRouteForDnsRelay>
        <SyslogServerSettings>
            <TenantSyslogServerSettings>
                <SyslogServerIp> IpAddressType </SyslogServerIp>
            </TenantSyslogServerSettings>
        </SyslogServerSettings>
        <AdvancedNetworkingEnabled> xs:boolean </AdvancedNetworkingEnabled>
        <DistributedRoutingEnabled> xs:boolean </DistributedRoutingEnabled>
        <FipsModeEnabled> xs:boolean </FipsModeEnabled>
        <EdgeClusterConfiguration>
            <