A VMware Cloud Director edge gateway is a virtual router for organization vDC (virtual Data Center) networks. NSX-V edge gateway provides a routed connection between an organization vDC network and an external network. 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. 

You can create edge gateway in either a compact or a full configuration. The full configuration provides increased capacity and performance. The compact configuration requires less memory and fewer compute resources. All services are supported in either configuration.

View NSX-V Edge Gateways


  1. Go to your Control Panel > Cloud > Edge Gateways menu > NSX-V.
  2. The page that loads will show the list of VSs together with their: 
    • Label - the name of the edge gateway
    • External address - external firewall IP
    • User group - the user group with which the edge gateway is associated
    • Organization - the organization with which the edge gateway is associated
    • Resource pool - the resource pool with which the edge gateway is associated
    • Status - power status, active or inactive


Create NSX-V Edge Gateway


  1. Go to your Control Panel > Cloud > Edge Gateways menu > NSX-V tab and click the "+" button. This will start an edge gateway creation wizard.
  2. Fill in the wizard step by step. Each of these steps is described in the corresponding sections below.
  3. Click the New Edge Gateway button to start the creation process. You will be taken to the edge gateway details screen. 


  1. Depending of the type of edge gateway, indicate some of the following details:
    • Label - indicate the label of the edge gateway
    • Description - write additional info about the edge gateway
    • Organization - select the organization with which the edge gateway will be associated
    • Resource Pool - choose the appropriate resource pool from the drop-down list
    • Edge Gateway Configuration - choose configuration type of the edge gateway from the drop-down list:
      • Compact - requires less memory and fewer compute resources

      • Large - provides increased capacity and performance compared to the Compact option 

      • Quad large - recommended for high throughput and requires a high connection rate

    • Enable High Availability - move the slider to the right to enable high availability option for this edge gateway
    • Create as Advanced Gateway - move this slider to the right to enable advanced edge gateway services. Note that after you enable this slider, the Enable Distributed Routing slider becomes available to you.
    • Enable Distributed Routing - move this slider to the right to enable distributed routing
    • Configure IP settings - move this slider to the right to manually configure IP settings  
    • Configure Rate Limits - move this slider to the right to manually configure the inbound and outbound rate limits

       2. Click Next to proceed to the following step of the wizard where you can specify the external networks.

At this step, choose external networks to which your edge gateway will be connected:

  • External Networks - select the external network from the drop-down list

Click Next to proceed to the following step of the wizard where you can specify the IP settings configuration.

This step is optional. It becomes available after you move the Configure IP settings slider to the right at the first step of the creation wizard.

     1. Click the label of the external network.

     2. Indicate the following details:

    • Assign - move this slider to the right to assign an IP address for each of the subnets. You may choose not to assign IP addresses to a given subnet at all.
    • Auto - move this slider to the left to indicate the IP address manually. 
    • IP range - select the IP range from the drop-down list
    • IP address - select the IP address from the drop-down list

     3. Click Next to proceed to the following step of the wizard where you can specify the default gateway.


At this step, select a network to be the default gateway:

  • Configure default gateway - move this slider to the right to enable automatic configuration of the default gateway
  • Default gateway - select the default gateway from the drop-down list
  • Use default gateway for DNS relay - move this slider to the right to use default gateway for DNS relay 

Click Next to proceed to the following step of the wizard where you can configure rate limits.


This step is optional. It becomes available after you move the Configure rate limits slider to the right at the first step of the creation wizard.

     1. Click the label of the external network.

     2. Indicate the following details:

    • Enable rate limits - move this slider to the right to enable the inbound and outbound rate limits
    • Incoming rate limit - indicate the inbound rate limit in megabits per second. The default value is 100. The minimal value is 0,001 Mbps.
    • Outgoing rate limit - indicate the outbound rate limit in megabits per second. The default value is 100. The minimal value is 0,001 Mbps.

     3. Click Next to proceed to the next step of the wizard that completes the edge gateway creation process.


At this step, you can find the configuration summary of the edge gateway, which will be created. You can view the external networks with their IP nets, IP addresses, incoming and outgoing rate limits.

The page that loads will provide you with the following information:

  • Label - the label of the edge gateway
  • Description - additional info about the edge gateway
  • Organization - the organization with which the edge gateway will be associated with
  • Resource Pool - the resource pool with which the edge gateway is associated
  • Edge Gateway Configuration - the configuration type of the edge gateway
  • Enable High Availability - whether high availability is enabled for this edge gateway
  • Create as Advanced Gateway - whether advanced edge gateway services are enabled
  • Enable Distributed Routing - whether distributed routing is enabled 
  • Default gateway - the default gateway
  • Use default gateway for DNS relay - whether default gateway for DNS relay is used

After you check all parameters, click Submit to start the creation process.

View NSX-V Edge Gateway Details


To view the details of a specific NSX-V edge gateway:

  1. Go to your Control Panel > CloudEdge Gateways menu > NSX-V tab.
  2. Choose the specific label. Click the Overview tab to see the following information:
    • Label - the name of the edge gateway
    • Description - additional info about the edge gateway
    • Resource Pool - the resource pool with which the edge gateway is associated
    • Organization - the organization with which the edge gateway is associated
    • User Group - the user group with which the edge gateway is associated
    • 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 
    • IP Settings section below includes the following columns:
      • External network
      • IP net
      • IP address 
      • Sub-allocated IP pool - if you have any sub-allocated IP pools on the vCloud side, these will be displayed in this field
  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 FirewallNAT, Load Balancer, IPSec VPN, L2 VPN tabs for the respective actions.
  5. By clicking the Services tab you will be redirected to the VMware Cloud Director where you can manage appropriate edge gateway services if needed.



Edit NSX-V Edge Gateways


Whether you want to change an edge gateway or its components, be sure to select the corresponding action. If you want to edit an edge gateway choose the Edit action. For other components, select among such actions as Edit External Networks, Edit Default Gateway, Edit IP Settings or Edit Rate Limits.

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 the action from the list.
  3. Edit the necessary parameters:

Edit Edge Gateway

    • 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

Edit External Networks
                     Select the external network from the drop-down list

Edit Default Gateway

    • Configure default gateway - move this slider to the left to enable automatic configuration of the default gateway
    • Default gateway - select the default gateway from the drop-down list
    • Use default gateway for DNS relay - move this slider to the right to use default gateway for DNS relay 

Edit IP Settings 

    • Participate - move this slider to the right to assign IP address for each of the subnets. You may choose not to participate in a given subnet.
    • Auto IP assignment - move this slider to the left to indicate the IP address manually. 
    • IP address - indicate the IP address

Edit Rate Limits 

    • Enable rate limits - move this slider to the right to enable the inbound and outbound rate limits
    • Incoming rate limit - indicate the inbound rate limit in megabits per second. The default value is 100. The minimal value is 0,001 Mb/s.
    • Outgoing rate limit - indicate the outbound rate limit in megabits per second. The default value is 100. The minimal value is 0,001 Mb/s. 

       4. Click Submit.



Delete NSX-V Edge Gateways


  1. Go to your Control Panel > CloudEdge Gateways menu > NSX-V tab.
  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'). If your edge gateway is not advanced you can convert it to one as described in the section below.

Ensure that the Manage Advanced Edge Gateway Services permission is on before managing advanced edge gateway services. For more information, refer to the OnApp Permissions page of the Admin guide.

To manage advanced edge gateway services:

  1. Go to your Control Panel > CloudEdge Gateways menu > NSX-V tab.
  2. Choose the specific Edge Gateways' label. Click the Services tab. You will be redirected to the VMware Cloud Director where you can manage appropriate advanced edge gateway services. For more information, refer to the VMware Cloud Director documentation.


Convert Edge Gateways to Advanced Edge Gateways


To convert the non-advanced edge gateway into advanced:

  1. Go to your Control Panel > CloudEdge Gateways menu > NSX-V tab.
  2. Click the Actions icon next to the edge gateway you want to convert and then select Convert to Advanced Edge Gateway.