Get Dhcp Forwarder

Get Dhcp Forwarder

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
URI
GET
https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/dhcpForwarder
COPY
Path Parameters
string
gatewayId
Required

gatewayId

string
gatewayId
Required

gatewayId

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns EdgeDhcpForwarder of type(s) application/json;version=39.0 
{
    "enabled": false,
    "dhcpServers": [
        "string"
    ],
    "version": {
        "version": 0
    }
}
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.

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.

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.


Availability
Added in 36.1
On This Page
Edge Gateway Dhcp Operations
GET
Get Dhcp Forwarder
PUT
Update Dhcp Forwarder