vCD Edge Gateways

A vCloud Director edge gateway is a virtual router for organization vDC (virtualDataCenter) networks. An Edge Gateway provides a routed connection between an organization vDC network and an external network. 

An Edge Gateway can support up to ten interfaces. These interfaces are categorized as uplinks when they connect to an external network and internal interfaces when they connect to an organization vDC network. 

This functionality is available for users with the vCloud Organization Administrator role.

View Edge Gateways



To view edge gateways:

  1. Go to your Control Panel's Edge Gateways menu.
  2. Choose the specific Edge Gateways's label. Click the Overview tab to see the following information:
    • Label - the name of the edge gateway
    • Description - additional info about the edge gateway
    • Edge Gateway Configuration - configuration type of the edge gateway 
    • High Availability - whether high availability option is enabled for this edge gateway or not
    • Use default route for dns relay- whether default route for dns relay is used or not 
  3. Also at this page you will see the following information about external network interfaces, to which this edge gateway is connected:
    • Label - the label of the network
    • Gateway address - the IP address of the gateway
  4. Click the Firewall Service RulesNAT serviceVPN Service tabs for the respective actions.
  5. By clicking the Manage Services button you will be redirected to the vCloud Director where you can manage appropriate edge gateway services if needed.


Create Edge Gateways



To create an edge gateway:

  1. Go to your Control Panel's Edge Gateways menu.
  2. Click the New Edge Gateway button. Indicate the following parameters:

    • vDC - choose the appropriate vDC from the drop-down list
    • Label - indicate the label of the edge gateway
    • Description - write additional info about edge gateway
    • Edge Gateway Configuration - choose configuration type of edge gateway from the drop-down list
    • High Availability -  tick the checkbox to enable high availability option for this edge gateway
    • External Networks - select the external network from the drop-down list
    • Use default route for dns relay - tick the checkbox to use default route for dns relay 
  3. Click the Submit button.


Edit Edge Gateways



To edit edge gateway:

  1. Go to your Control Panel's Edge Gateways menu.
  2. Click the Actions icon next to the edge gateway you want to edit, then choose Edit
  3. Edit the necessary parameters:

    • Label - change the label of edge gateway
    • Description - specify additional info about edge gateway
    • Edge Gateway Configuration - this field cannot be edited, it is set during edge gateway creation
    • High Availability - tick the checkbox to enable high availability option for this edge gateway
    • External Networks - select the external network from the drop-down list
    • Use default route for dns relay - tick the checkbox to use default route for dns relay 
  4. Click the Submit button.


Delete Edge Gateways



To delete edge gateway:

  1. Go to your Control Panel's Edge Gateways menu.
  2. Click the Actions icon next to the edge gateway you want to remove, then choose Delete
  3. Confirm the deletion.


Advanced Edge Gateway Services



Starting with OnApp 5.4, you can manage advanced edge gateway services.  You can check whether an edge gateway is advanced using Edge Gateways API requests (advanced edge gateway has the advanced_enabled parameter set to 'true').

Ensure that the Manage Advanced Edge Gateway Services permission is on before managing advanced edge gateway services. For more information refer to the List of all OnApp Permissions section of the Administration guide.

To manage advanced edge gateway services:

  1. Go to your Control Panel's Edge Gateways menu.
  2. Choose the specific Edge Gateways's label. Click the Services tab. You will be redirected to the vCloud Director where you can manage appropriate advanced edge gateway services. For more information refer to the vCloud Director documentation.