How to deploy an NSX Edge Services Gateway

Discover how to deploy an NSX Edge Services Gateway with the vSphere interface

Last updated on 19th November 2021


The NSX Edge Services Gateway is a VMware appliance providing services such as Firewall, NAT, DHCP, VPN, Load Balancer and High Availability.

This guide explains how to deploy such an appliance



You're about to embark in the NSX appliance deployment adventure.

We'll guide you step by step on how to set up an Edge Services Gateway with a connection inside your environment as well as another to communicate with the outside.

First, in the vSphere interface, go to the Networking and Security dashboard.


On the left side, navigate to the NSX Edges section.


Click on + Add then click Edge Services Gateway.


The guided installation window pops up.

Basic Details

Fill in the basic information. Only the name is mandatory, the other fields are optional and will either be automatically created or be ignored if non applicable to your case.

When done, click Next.

Leave Deploy Edge Appliance VMchecked.
Unchecking it would create the rules and settings but nothing would be active until a VM is deployed.
We are leaving High Availibility out of our scope for now.



Now on the to the settings window.

  • The default administrator user name is filled in automatically but you can change it as you need.
  • Create and confirm a compliant password.
  • Auto Rule Generation will add firewall, NAT, and routing to enable control traffic to flow for these services.
  • The SSH access option allows console access on port 22 if needed. We recommend leaving it off by default and only open access as needed.
  • FIPS mode enforces encryption and security levels compliant with the United States Federal Information Processing Standards.
  • The logging level can be adapted to your needs.

Click Next


Deployment Configuration

Select the destination datacenter (if you only have one datacenter in vSphere, there is no choice possible), the size of the appliance (size will determine processing power and resource consumption) and hit the + button.


In the next window, select where the appliance will live within the chosen datacenter.
Only Cluster/Resource Pool and Datastore are mandatory field (vSphere will select the best suited places for the rest if you do not input data).

Click Add.


Back in the Deployment Configuration window, click Next.


The Configure Interfaces is now before you.

Click on + Add


There are 2 types of interfaces:

  • Uplink will communicate with the outside of your network
  • Internal will be confined to your network

Let's name an interface and choose Uplink.

Click on the pencil symbol to select how it will connect out.


Typically, in the Distributed Virtual Port Group tab, the VM Network is the default outside access network (if you customized your environment, select accordingly).

Click OK.


Back in the Interface configuration window, add a primary IP and subnet prefix for the interface.

Click OK.


Add a second interface. This time it will be an Internal one.

Click on the pencil symbol again to select the network the interface will be part of.

Also, add the primary IP and subnet prefix for the vNIC.


Interfaces are ready. Review and click Next.


Default Gateway

Configure the Default Gateway for external access. This is not mandatory and can be disabled to be done later.

Click Next


Firewall Default Policy

Enable or disable Firewall Default Policy and click Next.



Review the configuration and hit that Finish button.


The Gateway will deploy. It will show a "Busy" and "Installing" status until done.
If the deployment fails, it will show you basic error message and link to the full logs in the Failed section.


After some time, your appliance will show as "Deployed".


Congratulations and welcome to the world of NSX!

Go further

Join our community of users on

Did you find this guide useful?

Please feel free to give any suggestions in order to improve this documentation.

Whether your feedback is about images, content, or structure, please share it, so that we can improve it together.

Your support requests will not be processed via this form. To do this, please use the "Create a ticket" form.

Thank you. Your feedback has been received.

These guides might also interest you...

OVHcloud Community

Access your community space. Ask questions, search for information, post content, and interact with other OVHcloud Community members.

Discuss with the OVHcloud community

In accordance with the 2006/112/CE Directive, modified on 01/01/2015, prices exclude VAT. VAT may vary according to the customer's country of residence.