Changed1

[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"version":"v37.0"},{"version":"v36.3"},{"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

URL

get

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

Copy

Path Parameters

string

gatewayId Required

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Response

Response Body

200 OK

Returns EdgeDhcpForwarder of type(s) application/json;version=37.0

{
	"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.

ObjectVersion

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

cURL Command

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

vmware-cloud-director

What's changed in v37.0?

INTRODUCED

Availability

Added in 36.1

Edge Gateway DHCP Operations

get

Get DHCP Forwarder Introduced

put

Update DHCP Forwarder Introduced