If you prefer to automate NSX Edge installation, you can use the VMware OVF Tool, which is a command-line utility.

Prerequisites

  • Verify that the system requirements are met. See System Requirements.
  • Verify that the required ports are open. See Ports and Protocols.
  • Verify that a datastore is configured and accessible on the ESXi host.
  • Verify that you have the IP address and gateway, DNS server IP addresses, domain search list, and the NTP server IP address for the NSX Manager to use.
  • If you do not already have one, create the target VM port group network. Place the NSX-T Data Center appliances on a management VM network.

    If you have multiple management networks, you can add static routes to the other networks from the NSX-T Data Center appliance.

  • Plan your NSX Manager IPv4 or IPv6 IP addressing scheme.
  • Verify that you have adequate privileges to deploy an OVF template on the ESXi host.
  • Verify that hostnames do not include underscores. Otherwise, the hostname is set to localhost.
  • OVF Tool version 4.3 or later.

Procedure

  • For a standalone host, run the ovftool command with the appropriate parameters.
    C:\Users\Administrator\Downloads>ovftool 
    --name=nsx-edge-1 
    --deploymentOption=medium
    --X:injectOvfEnv 
    --X:logFile=ovftool.log 
    --allowExtraConfig 
    --datastore=ds1 
    --net:"Network 0=Mgmt" 
    --net:"Network 1=nsx-tunnel" 
    --net:"Network 2=vlan-uplink"  
    --net:"Network 3=vlan-uplink"  
    --acceptAllEulas 
    --noSSLVerify 
    --diskMode=thin 
    --powerOn 
    --prop:nsx_ip_0=192.168.110.37 
    --prop:nsx_netmask_0=255.255.255.0 
    --prop:nsx_gateway_0=192.168.110.1 
    --prop:nsx_dns1_0=192.168.110.10 
    --prop:nsx_domain_0=corp.local 
    --prop:nsx_ntp_0=192.168.110.10 
    --prop:nsx_isSSHEnabled=True 
    --prop:nsx_allowSSHRootLogin=True 
    --prop:nsx_passwd_0=<password> 
    --prop:nsx_cli_passwd_0=<password> 
    --prop:nsx_hostname=nsx-edge 
    <path/url to nsx component ova> 
    vi://root:<password>@192.168.110.51
    
    Opening OVA source: nsx-<component>.ova
    The manifest validates
    Source is signed and the certificate validates
    Opening VI target: vi://root@192.168.110.24
    Deploying to VI: vi://root@192.168.110.24
    Transfer Completed
    Powering on VM: nsx-edge-1
    Task Completed
    Completed successfully
    
    
  • For a host managed by vCenter Server, run the ovftool command with the appropriate parameters.
    C:\Users\Administrator\Downloads>ovftool 
    --name=nsx-edge-1 
    --deploymentOption=medium
    --X:injectOvfEnv 
    --X:logFile=ovftool.log 
    --allowExtraConfig 
    --datastore=ds1 
    --net:"Network 0=Mgmt" 
    --net:"Network 1=nsx-tunnel" 
    --net:"Network 2=vlan-uplink"  
    --net:"Network 3=vlan-uplink"  
    --acceptAllEulas 
    --noSSLVerify 
    --diskMode=thin 
    --powerOn 
    --prop:nsx_ip_0=192.168.110.37 
    --prop:nsx_netmask_0=255.255.255.0 
    --prop:nsx_gateway_0=192.168.110.1 
    --prop:nsx_dns1_0=192.168.110.10 
    --prop:nsx_domain_0=corp.local 
    --prop:nsx_ntp_0=192.168.110.10 
    --prop:nsx_isSSHEnabled=True 
    --prop:nsx_allowSSHRootLogin=True 
    --prop:nsx_passwd_0=<password> 
    --prop:nsx_cli_passwd_0=<password> 
    --prop:nsx_hostname=nsx-edge 
    <path/url to nsx component ova> 
    vi://administrator@vsphere.local:<password>@192.168.110.24/?ip=192.168.210.53
    
    
    Opening OVA source: nsx-<component>.ova
    The manifest validates
    Source is signed and the certificate validates
    Opening VI target: vi://administrator@vsphere.local@192.168.110.24:443/
    Deploying to VI: vi://administrator@vsphere.local@192.168.110.24:443/
    Transfer Completed
    Powering on VM: nsx-edge-1
    Task Completed
    Completed successfully
    
    
  • For an optimal performance, reserve memory for the NSX Manager appliance.

    Set the reservation to ensure that NSX Manager has sufficient memory to run efficiently. See NSX Manager VM System Requirements.

  • Open the console of the NSX Edge to track the boot process.
  • After the NSX Edge starts, log in to the CLI with admin credentials.
  • Run the get interface eth0.<vlan_ID> command to verify that the IP address was applied as expected
    nsx-edge-1> get interface eth0.100 
    
    Interface: eth0.100
      Address: 192.168.110.37/24
      MAC address: 00:50:56:86:62:4d
      MTU: 1500
      Default gateway: 192.168.110.1
      Broadcast address: 192.168.110.255
      ...
    
    Note: When bringing up NSX Edge VMs 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.
  • Verify that the NSX Edge appliance has the required connectivity.

    If you enabled SSH, make sure that you can SSH to your NSX Edge.

    • You can ping your NSX Edge.
    • NSX Edge can ping its default gateway.
    • NSX Edge can ping the hypervisor hosts that are in the same network as the NSX Edge.
    • NSX Edge can ping its DNS server and its NTP server.
  • 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 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 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.

What to do next

Join the NSX Edge with the management plane. See Join NSX Edge with the Management Plane.