VMware Cloud Director API - GatewayInterfaceType

VMware Cloud Director API - GatewayInterfaceType

GatewayInterfaceType

Type:
GatewayInterfaceType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
Gateway Interface configuration.
Since:
5.1
Schema:
network.xsd
Media type(s):
None
Extends:
VCloudExtensibleType
XML Representation:
<GatewayInterfaceType xmlns="http://www.vmware.com/vcloud/v1.5">
    <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>
</GatewayInterfaceType>

Elements

Element Type Required Modifiable Since Deprecated Description
ApplyRateLimit boolean No always 5.1 True if rate limiting is applied on this interface.
Connected boolean No always 33.0 True if interface is marked as connected in NSX
DisplayName string No none 5.1 Gateway Interface display name.
InRateLimit double No always 5.1 Incoming rate limit expressed as Gbps.
InterfaceType string Yes always 5.1 The type of interface: One of: Uplink, Internal
Name string No none 5.1 Internally generated name for the Gateway Interface.
Network ReferenceType Yes always 5.1 A reference to the network connected to the gateway interface.
OutRateLimit double No always 5.1 Outgoing rate limit expressed as Gbps.
QuickAddAllocatedIpCount int No always 33.0 If set on create or update api calls, the specified number of IP addresses will be additionally allocated for this uplink. IPs will be allocated from multiple subnets if needed.
SubnetParticipation SubnetParticipationType No always 5.1 IP allocation per subnet.
UseForDefaultRoute boolean No always 5.1 True if this network is default route for the gateway.
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.