An Edge Gateway or routed vApp network configuration can define a static routing service that specifies one or more static routes.
You can create static routes between two organization VDC networks, or between routed vApp networks that do not have overlapping IP address spaces. Static routing service details and routes are defined in a StaticRoutingService element contained by the Features element of a vApp network's Configuration or the GatewayFeatures element of an Edge Gateway's Configuration. A StaticRoutingService element can contain zero or more StaticRoute elements. Each StaticRoute specification requires the following elements.
- Name
- Name for the route.
- Network
- Network specification in CIDR notation.
- NextHopIp
- IP address of the next hop on the route. This address is typically the value in the ExternalIp element of the RouterInfo from the network to which this static route connects.
- Interface
- Specify internal if NextHopIp contains an IP address in the same network. Specify external if NextHopIp contains an IP address in a different network.
- GatewayInterface
- Used when configuring a static route in an organization VDC network. Contains a reference to the organization VDC network for which the static route is configured.
Static Routes Between Organization VDC Networks
Assume two routed organization VDC networks, as defined in this fragment of an EdgeGateway element.
<GatewayInterface> <Name>vnic2</Name> <DisplayName>routed1</DisplayName> <Network type="application/vnd.vmware.admin.network+xml" name="routed1" href="https://vcloud.example.com/api/admin/network/29" /> <InterfaceType>internal</InterfaceType> <SubnetParticipation> <Gateway>192.168.3.1</Gateway> <Netmask>255.255.255.0</Netmask> <IpAddress>192.168.3.1</IpAddress> </SubnetParticipation> <IpRanges /> <UseForDefaultRoute>false</UseForDefaultRoute> </GatewayInterface> <GatewayInterface> <Name>vnic3</Name> <DisplayName>routed2</DisplayName> <Network type="application/vnd.vmware.admin.network+xml" name="routed2" href="https://vcloud.example.com/api/admin/network/67" /> <InterfaceType>internal</InterfaceType> <SubnetParticipation> <Gateway>172.168.0.1</Gateway> <Netmask>255.255.255.0</Netmask> <IpAddress>172.168.0.1</IpAddress> </SubnetParticipation> <IpRanges /> <UseForDefaultRoute>false</UseForDefaultRoute> </GatewayInterface>
- The organization VDC network named
routed1
has Gateway address192.168.3.1
. - The organization VDC network named
routed2
has Gateway address172.168.0.1
. - The Configuration of the vApp network in vApp1 has a RouterInfo element whose ExternalIp value is
192.168.2.100
. - The Configuration of the vApp network in vApp2 has a RouterInfo element whose ExternalIp value is
192.168.1.100
.
A StaticRoutingService defined by the following fragment creates a static route to vApp1 from network routed1
, and a static route to vApp2 from network routed2
.
<StaticRoutingService> <IsEnabled>true</IsEnabled> <StaticRoute> <Name>TovApp1</Name> <Network>192.168.2.0/24</Network> <NextHopIp>192.168.3.10</NextHopIp> <Interface>Internal</Interface> <GatewayInterface type="application/vnd.vmware.vcloud.orgVdcNetwork+xml" name="routed1" href="https://vcloud.example.com/api/admin/network/29" /> </StaticRoute> <StaticRoute> <Name>TovApp2</Name> <Network>192.168.1.0/24</Network> <NextHopIp>172.168.0.10</NextHopIp> <Interface>Internal</Interface> <GatewayInterface type="application/vnd.vmware.vcloud.orgVdcNetwork+xml" name="routed2" href="https://vcloud.example.com/api/admin/network/67" /> </StaticRoute> </StaticRoutingService>
To add this service to an Edge Gateway, include it in an EdgeGatewayServiceConfiguration. See Configure Services on an Edge Gateway.
Static Routes Between vApp Networks
For an example of a static routing service in a vApp network, see Network Services in vApp Networks.