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
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"/>
    <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"/>
            <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>
        </Task>
    </Tasks>
    <GatewayBackingRef>
        <gatewayId> xs:string </gatewayId>
        <VCRef id="xs:string" type="xs:string" name="xs:string"/>
    </GatewayBackingRef>
    <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>
                    <IpAddress> IpAddressType </IpAddress>
                    <IpRanges>
                        <IpRange>
                            <StartAddress> IpAddressType </StartAddress>
                            <EndAddress> IpAddressType </EndAddress>
                        </IpRange>
                    </IpRanges>
                </SubnetParticipation>
                <ApplyRateLimit> xs:boolean </ApplyRateLimit>
                <InRateLimit> xs:double </InRateLimit>
                <OutRateLimit> xs:double </OutRateLimit>
                <UseForDefaultRoute> xs:boolean </UseForDefaultRoute>
            </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>
    </Configuration>
</EdgeGateway>

Attributes

Attribute Type Required Modifiable Since Deprecated Description
href anyURI No always 5.1 The URI of the entity.
type string No always 5.1 The MIME type of the entity.
id string No none 5.1 The entity identifier, expressed in URN format. The value of this attribute uniquely identifies the entity, persists for the life of the entity, and is never reused.
operationKey string No create 5.1 Optional unique identifier to support idempotent semantics for create and delete operations.
name string Yes always 5.1 The name of the entity.
status int No none 5.1 Creation status of the gateway. One of:
0 (The gateway is still being created)
1 (The gateway is ready)
-1 (There was an error while creating the gateway).

Elements

Element Type Required Modifiable Since Deprecated Description
Configuration GatewayConfigurationType Yes always 5.1 Gateway configuration.
Description string No always 5.1 Optional description.
GatewayBackingRef GatewayBackingRefType Yes always 7.0 Provides information to access edge gateway via VC
Link LinkType No none 5.1 A reference to an entity or operation associated with this object.
Tasks TasksInProgressType No none 5.1 A list of queued, running, or recently completed tasks associated with this entity.
VCloudExtension VCloudExtensionType No always 5.1 An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.

Operations

CRUD Operation Description Since Deprecated
as input PUT /admin/edgeGateway/{id} Update an edge gateway 5.1
as input POST /admin/vdc/{id}/edgeGateways Create an edge gateway. 5.1