VMware Cloud Director API - VdcTemplateSpecificationGatewayConfigurationType
VdcTemplateSpecificationGatewayConfigurationType
- Type:
- VdcTemplateSpecificationGatewayConfigurationType
- Namespace:
- http://www.vmware.com/vcloud/v1.5
- Description:
- Defines a gateway and NAT Routed organization VDC network to be created.
- Since:
- 5.7
- Schema:
- vCloudEntities.xsd
- Media type(s):
- None
- Extends:
- VCloudExtensibleType
- XML Representation:
-
<VdcTemplateSpecificationGatewayConfigurationType xmlns="http://www.vmware.com/vcloud/v1.5">
<Gateway 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>
</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>
</Configuration>
</Gateway>
<Network 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>
<Configuration>
<BackwardCompatibilityMode> xs:boolean </BackwardCompatibilityMode>
<IpScopes>
<IpScope>
<IsInherited> xs:boolean </IsInherited>
<Gateway> IpAddressType </Gateway>
<Netmask> IpAddressType </Netmask>
<SubnetPrefixLength> xs:int </SubnetPrefixLength>
<Dns1> IpAddressType </Dns1>
<Dns2> IpAddressType </Dns2>
<DnsSuffix> xs:string </DnsSuffix>
<IsEnabled> xs:boolean </IsEnabled>
<IpRanges>
<IpRange>
<StartAddress> IpAddressType </StartAddress>
<EndAddress> IpAddressType </EndAddress>
</IpRange>
</IpRanges>
<AllocatedIpAddresses>
<IpAddress> IpAddressType </IpAddress>
</AllocatedIpAddresses>
<SubAllocations href="xs:anyURI" type="xs:string">
<Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<SubAllocation>
<EdgeGateway href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<IpRanges>
<IpRange>
<StartAddress> IpAddressType </StartAddress>
<EndAddress> IpAddressType </EndAddress>
</IpRange>
</IpRanges>
</SubAllocation>
</SubAllocations>
</IpScope>
</IpScopes>
<ParentNetwork href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<FenceMode> xs:string </FenceMode>
<RetainNetInfoAcrossDeployments> xs:boolean </RetainNetInfoAcrossDeployments>
<Features>
<NetworkService>
<IsEnabled> xs:boolean </IsEnabled>
</NetworkService>
</Features>
<SyslogServerSettings>
<SyslogServerIp1> IpAddressType </SyslogServerIp1>
<SyslogServerIp2> IpAddressType </SyslogServerIp2>
</SyslogServerSettings>
<RouterInfo>
<ExternalIp> IpAddressType </ExternalIp>
</RouterInfo>
<SubInterface> xs:boolean </SubInterface>
<DistributedInterface> xs:boolean </DistributedInterface>
<ServiceInterface> xs:boolean </ServiceInterface>
<GuestVlanAllowed> xs:boolean </GuestVlanAllowed>
<Connected> xs:boolean </Connected>
<DualStackNetwork> xs:boolean </DualStackNetwork>
</Configuration>
<ProviderInfo> xs:string </ProviderInfo>
<EdgeGateway href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<ServiceConfig>
<NetworkService>
<IsEnabled> xs:boolean </IsEnabled>
</NetworkService>
</ServiceConfig>
<IsShared> xs:boolean </IsShared>
<VimPortGroupRef>
<VimServerRef href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<MoRef> xs:string </MoRef>
<VimObjectType> xs:string </VimObjectType>
</VimPortGroupRef>
</Network>
</VdcTemplateSpecificationGatewayConfigurationType>
-
Elements
-
Element Type Required Modifiable Since Deprecated Description Gateway GatewayType Yes none 5.7 EdgeGateway configuration for the VDC created by this template. The following restrictions apply: - You may not specify a BackwardCompatibilityMode or an EdgeGatewayServiceConfiguration.
- The GatewayInterfaces element must contain exactly one GatewayInterface. That GatewayInterface must have an InterfaceType of uplink and must not contain a SubnetParticipation element.
Network OrgVdcNetworkType Yes none 5.7 Org VDC network configuration created by this template. The following restrictions apply: - You may not specify a BackwardCompatibilityMode, EdgeGatewayServiceConfiguration, or NetworkFeatures.
- The NetworkConfiguration must specify a FenceMode of natRouted.
VCloudExtension VCloudExtensionType No always 5.7 An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.