Changed2
[{"label":"Latest (v36.3)","version":"latest"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director

Get DHCP Forwarder

Description

Retrieves the DHCP Forwarder configuration on an Edge Gateway. A routed Org vDC network connected to this edge can choose to configure its DHCP configuration in RELAY mode which will use this DHCP forwarder.

Request

Request

URL

URL


get
https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/dhcpForwarder
Copy

Path Parameters

Path Parameters

string
gatewayId Required

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns EdgeDhcpForwarder of type(s) application/json;version=36.3
{
	"dhcpServers": [
		"string"
	],
	"enabled": false,
	"version": {
		"version": 0
	}
}
array of string
dhcpServers Optional

DHCP server IP addresses. Both IPv4 and IPv6 addresses are supported. The DHCP servers can be in any subnet, outside the SDDC, or in the physical network.


boolean
enabled Optional

A flag indicating whether DHCP Forwarder is enabled or not. This should be enabled in order to use the DHCP relay on routed Org vDC networks.


version Optional

This property describes the current version of the entity. To prevent clients from overwriting each other’s changes, update operations must include the version which can be obtained by issuing a GET operation. If the version number on an update call is missing, the operation will be rejected. This is only needed on update calls.

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/dhcpForwarder


[{"label":"Latest (v36.3)","version":"latest"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
What's changed in v36.3?
INTRODUCED
New in this version
Availability
Added in 36.1
Edge Gateway DHCP Operations
Feedback

Was this page helpful?