You can use the vSphere Web Client or vSphere Client to interactively install an NSX Edge on ESXi.

Note: Starting in NSX-T Data Center 2.5.1, the NSX Edge VM supports vMotion.


See NSX Edge network requirements in NSX Edge Installation Requirements.


  1. Locate the NSX Edge node appliance OVA file on the VMware download portal.
    Either copy the download URL or download the OVA file onto your computer.
  2. In the vSphere Client, select the host on which to install NSX Edge node appliance.
  3. Right-click and select Deploy OVF template to start the installation wizard.
  4. Enter the download OVA URL or navigate to the saved OVA file, and click Next.
  5. Enter a name and location for the NSX Edge node , and click Next.

    The name you type appears in the vCenter Server and vSphere inventory.

  6. Select a compute resource for the NSX Edge node appliance, and click Next.
  7. For an optimal performance, reserve memory for the NSX Edge appliance.

    Set the reservation to ensure that NSX Edge has sufficient memory to run efficiently. See NSX Manager VM and Host Transport Node System Requirements.

  8. Review and verify the OVF template details, and click Next.
  9. Select a deployment configuration, Small, Medium, Large, or XLarge and click Next.

    The Description panel on the right side of the wizard shows the details of selected configuration.

  10. Select storage for the configuration and disk files, and click Next.
    1. Select the virtual disk format.
    2. Select the VM storage policy.
    3. Specify the datastore to store the NSX Edge node appliance files.
  11. Select a destination network for each source network.
    1. For network 0, select the VDS management portgroup.
    2. For networks 1, 2, and 3, select the previously configured VDS trunk portgroups.
  12. Configure IP Allocation settings.
    1. For IP allocation, specify Static - Manual.
    2. For IP protocol, select IPv4.
  13. Click Next.
    The following steps are all located in the Customize Template section of the Deploy OVF Template wizard.
  14. Enter the NSX Edge node system root, CLI admin, and audit passwords.
    Note: In the Customize Template window, ignore the message All properties have valid values that is displayed even before you have entered values in any of the fields. This message is displayed because all parameters are optional. The validation passes as you have not entered values in any of the fields.
    When you log in for the first time, you are prompted to change the password. This password change method has strict complexity rules, including the following:
    • At least 12 characters
    • At least one lower-case letter
    • At least one upper-case letter
    • At least one digit
    • At least one special character
    • At least five different characters
    • No dictionary words
    • No palindromes
    • More than four monotonic character sequence is not allowed
    Important: The core services on the appliance do not start until a password with sufficient complexity has been set.
  15. (Optional) If you have an available NSX Manager and want to register the NSX Edge node with the management plane during the OVA deployment, complete the Manager IP, Username, Password, and Thumbprint.
    • Manager IP: Enter the NSX Manager node IP address.
      Note: Do not register the NSX Edge node with the virtual IP (VIP) address of the management plane during the OVA deployment.
    • Manager Username: Enter the NSX Manager username.
    • Manager Password: Enter the NSX Manager password.
    • Manager Thumbprint: Enter the NSX Manager thumbprint.
      Note: An NSX Manager thumbprint is required to join an NSX Edge node to an NSX Manager. To retrieve thumbprint on an NSX Manager node, run get certificate api thumbprint.
    • Node ID: Leave the field blank. The Node UUID field is only for internal use.
  16. (Optional) If you want to deploy the NSX Edge node as an autonomous edge in a L2 VPN topology, enable the option. An autonomous edge is not managed by NSX-T Data Center. Do not enable the option if you want to deploy an NSX Edge node that provides centralized edge services to host transport nodes in an NSX-T Data Center topology.
    Note: The fields in the External and HA sections are required only when you are configure an autonomous edge node.
  17. Enter the hostname of the NSX Edge.
  18. Enter the default gateway, management network IPv4, and management network netmask address.
    Skip any VMC network settings.
  19. Enter the DNS Server list, the Domain Search list, and the NTP Server IP or FQDN list.
  20. (Optional) Do not enable SSH if you prefer to access NSX Edge using the console. However, if you want root SSH login and CLI login to the NSX Edge command line, enable the SSH option.
    By default, SSH access is disabled for security reasons.
  21. Verify that all your custom OVA template specification is accurate and click Finish to initiate the installation.
    The installation might take 7-8 minutes.
  22. Open the console of the NSX Edge node to track the boot process.
    If the console window does not open, make sure that pop-ups are allowed.
  23. After the NSX Edge node starts, log in to the CLI with admin credentials.
    Note: After NSX Edge node starts, if you do not log in with admin credentials for the first time, the data plane service does not automatically start on the NSX Edge node.
  24. Run the get interface eth0 (without VLAN) or get interface eth0.<vlan_ID> (with a VLAN) command to verify that the IP address was applied as expected.
    nsx-edge-1> get interface eth0.100 
    Interface: eth0.100
      MAC address: 00:50:56:86:62:4d
      MTU: 1500
      Default gateway:
      Broadcast address:
    Note: When bringing up NSX Edge nodes on non-NSX managed host, verify that the MTU setting is set to 1600 (instead of 1500) on the physical host switch for the data NIC.
  25. Run the get managers command to verify that the NSX Edge node is registered.
    -  Connected (NSX-RPC)
    - Connected (NSX-RPC) 
    - Connected (NSX-RPC)
  26. If NSX Edge is not registered with the management plane, see Join NSX Edge with the Management Plane.
  27. Verify that the NSX Edge node has the required connectivity.

    If you enabled SSH, make sure that you can SSH to your NSX Edge node and verify the following:

    • You can ping your NSX Edge node management interface.
    • From the NSX Edge node, you can ping the node's default gateway.
    • From the NSX Edge node, you can ping the hypervisor hosts that are either in the same network or a network reachable through routing.
    • From the NSX Edge node, you can ping the DNS server and NTP Server IP or FQDN list.
  28. Troubleshoot connectivity problems.
    Note: If connectivity is not established, make sure the VM network adapter is in the proper network or VLAN.

    By default, the NSX Edge node datapath claims all virtual machine NICs except the management NIC (the one that has an IP address and a default route). If you incorrectly assigned a NIC as the management interface, follow these steps to use DHCP to assign management IP address to the correct NIC.

    1. Log in to the NSX Edge CLI and type the stop service dataplane command.
    2. Type the set interface interface dhcp plane mgmt command.
    3. Place interface into the DHCP network and wait for an IP address to be assigned to that interface.
    4. Type the start service dataplane command.
      The datapath fp-ethX ports used for the VLAN uplink and the tunnel overlay are shown in the get interfaces and get physical-port commands on the NSX Edge node.

What to do next

Configure NSX Edge as a transport node. See Configure an NSX Edge as a Transport Node.