An NSX edge gateway capabilities include IP address pooling, one-to-one static IP address allocation, and external DNS server configuration. Static IP address binding is based on the managed object ID and interface ID of the requesting client virtual machine.

The DHCP relay capability provided by NSX in your VMware Cloud Director environment enables you to leverage your existing DHCP infrastructure from within your vCloud Director environment without any interruption to the IP address management in your existing DHCP infrastructure. DHCP messages are relayed from virtual machines to the designated DHCP servers in your physical DHCP infrastructure, which allows IP addresses controlled by the NSX software to continue to be in synch with IP addresses in the rest of your DHCP-controlled environments.
Note:
  • DHCP relay does not support overlapping IP address spaces.
  • DHCP relay and DHCP service cannot run on the same vNIC at the same time. If a relay agent is configured on a vNIC, a DHCP pool cannot be configured on the subnets of that vNIC. See the NSX Administration Guide for details.

In the table below:

  • API-URL is a URL of the form https://vcloud.example.com/network.
  • id is a VMware Cloud Director unique identifier in the form of a UUID, as defined by RFC 4122.
  • # is a small integer used in an NSX object identifier.
Table 1. Summary of NSX Edge DHCP Requests
Operation Request Request Body Response
Retrieve DHCP configuration for the edge with identifier id. GET API-URL/edges/id/dhcp/config None dhcp
Update DHCP configuration for the edge with identifier id. PUT API-URL/edges/id/dhcp/config dhcp 204 No Content
Reset DHCP configuration for the edge with identifier id to factory defaults. DELETE API-URL/edges/id/dhcp/config None 204 No Content
Append an IP address pool to the set of DHCP pools configured for the edge with identifier id. POST API-URL/edges/id/dhcp/config/ippools ipPool 204 No Content
Delete the IP address pool identified by ippool-# from the edge with identifier id. DELETE API-URL/edges/id/config/ippools/ippool-# None 204 No Content
Retrieve the DHCP relay configuration from the edge with identifier id. GET API-URL/edges/id/dhcp/config/relay None relay
Update the DHCP relay configuration for the edge with identifier id. PUT API-URL/edges/id/dhcp/config/relay relay 204 No Content
Reset DHCP relay configuration for the edge with identifier id.to factory defaults. DELETE API-URL/edges/id/dhcp/config/relay None 204 No Content
Retrieve DHCP lease information from the edge with identifier id. GET API-URL/edges/id/dhcp/leaseInfo None dhcpLeases