VMware Cloud Director API - GatewayConfigurationType

VMware Cloud Director API - GatewayConfigurationType

GatewayConfigurationType

Type:
GatewayConfigurationType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
Gateway Configuration.
Since:
5.1
Schema:
network.xsd
Media type(s):
None
Extends:
VCloudExtensibleType
XML Representation:
<GatewayConfigurationType xmlns="http://www.vmware.com/vcloud/v1.5">
    <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>
        </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>
        <PrimaryEdgeCluster href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
        <SecondaryEdgeCluster href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </EdgeClusterConfiguration>
</GatewayConfigurationType>

Elements

Element Type Required Modifiable Since Deprecated Description
AdvancedNetworkingEnabled boolean No always 7.0 True if the gateway uses advanced networking
BackwardCompatibilityMode boolean No always 5.1 Compatibility mode. Default is false. If set to true, will allow users to write firewall rules in the old 1.5 format. The new format does not require to use direction in firewall rules. Also, for firewall rules to allow NAT traffic the filter is applied on the original IP addresses. Once set to true cannot be reverted back to false.
DistributedRoutingEnabled boolean No always 29.0 True if gateway is attached to a Distributed Logical Router
EdgeClusterConfiguration EdgeClusterConfigurationType No always 34.0 Represents the Edge Cluster Configuration for a given Edge Gateway. Can be changed if a gateway needs to be placed on a specific set of Edge Clusters. For NSX-V Edges, if nothing is specified on create or update, the Org VDC Default will be used. For NSX-T Edges, Open API must be used and this field is read only. If there is no value, the gateway uses the Edge Cluster of the connected External Network's backing Tier-0 router.
EdgeGatewayServiceConfiguration GatewayFeaturesType No always 5.1 Represents Gateway Features.
FipsModeEnabled boolean No always 30.0 True if FIPS mode is enabled for this gateway
GatewayBackingConfig string Yes always 5.1 Configuration of the vShield edge VM for this gateway. One of: compact, full.
GatewayInterfaces GatewayInterfacesType Yes always 5.1 List of Gateway interfaces.
HaEnabled boolean No always 5.1 True if this gateway is highly available. (Requires two vShield edge VMs.)
SyslogServerSettings SyslogServerType No always 5.11 Syslog server addresses for gateway
UseDefaultRouteForDnsRelay boolean No always 5.1 True if the default gateway on the external network selected for default route should be used as the DNS relay.
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.