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

Get Network DHCP Config

Description

Retrieves Dhcp configuration of a specific Org vDC network.

Request

Request

URL

URL


get
https://{api_host}/cloudapi/1.0.0/orgVdcNetworks/{vdcNetworkId}/dhcp
Copy

Path Parameters

Path Parameters

string
vdcNetworkId Required

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns VdcNetworkDhcpConfig of type(s) application/json;version=37.0
{
	"dhcpPools": [
		{
			"defaultLeaseTime": 0,
			"enabled": false,
			"ipRange": {
				"endAddress": "string",
				"startAddress": "string"
			},
			"maxLeaseTime": 0
		}
	],
	"dnsServers": [
		"string"
	],
	"enabled": false,
	"ipAddress": "string",
	"leaseTime": 0,
	"mode": "string"
}
dhcpPools Optional

Range of DHCP IP addresses. These should not be set for RELAY mode.


array of string
dnsServers Introduced Optional

The DNS server IPs to be assigned by this DHCP service. The IP type must match the IP type of the subnet on which the DHCP config is being created.


boolean
enabled Optional

Whether the DHCP service is currently enabled on network.


string
ipAddress Optional

The IP address of the DHCP service. This is required upon create if using NETWORK mode. This field only applies to networks backed by an NSX-T network provider.


integer as int64
leaseTime Optional

The amount of time in seconds of how long a DHCP IP will be leased out for. The minimum is 60s while the maximum is 4,294,967,295s, which is roughly 49,710 days.


string
mode Optional

This value describes how the DHCP service is configured for this network. Once a DHCP service has been created, the mode attribute cannot be changed. The mode field will default to ‘EDGE’ if it is not provided. This field only applies to networks backed by an NSX-T network provider.

  • The supported values are EDGE ,NETWORK and RELAY.
  • If EDGE is specified, the DHCP service of the edge is used to obtain DHCP IPs.
  • If NETWORK is specified, a DHCP server is created for use by this network.
  • If RELAY is specified, all the DHCP client requests will be relayed to Gateway DHCP Forwarder service. This mode is only supported for Routed Org vDC Networks.
In order to use DHCP for IPV6, NETWORK mode must be used. Routed networks which are using NETWORK DHCP services can be disconnected from the edge gateway and still retain their DHCP configuration, however DHCP configuration will be removed during connection change for networks using EDGE or RELAY DHCP mode.

Errors

Errors

Error
404

The specified resource was not found

Code Samples

Code Samples

cURL Command

curl https://{api_host}/cloudapi/1.0.0/orgVdcNetworks/{vdcNetworkId}/dhcp


[{"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
Availability
Added in 32.0
Org VDC Network DHCP Operations
Feedback

Was this page helpful?