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

Update DHCP Forwarder

Description

Updates the DHCP Forwarder configuration on an Edge Gateway.

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
gatewayId Required

Request Body

Request Body

EdgeDhcpForwarder of type(s) application/json Required
{
	"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.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

202 Accepted

The request have been accepted and the task to monitor the request is in the Location header.

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"dhcpServers":["string"],"enabled":false,"version":{"version":0}}' https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/dhcpForwarder


[{"label":"Latest (v37.0)","version":"latest"},{"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
What's changed in v37.0?
INTRODUCED
New in this version
Availability
Added in 36.1
Edge Gateway DHCP Operations
Feedback

Was this page helpful?