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 Binding

Description

Retrieve a specific DHCP binding of the Org vDC Network.

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
vdcNetworkId Required

string
bindingId Required

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns DhcpBinding of type(s) application/json;version=36.3
{
	"bindingType": "string",
	"description": "string",
	"dhcpV4BindingConfig": {
		"gatewayIpAddress": "string",
		"hostName": "string"
	},
	"dhcpV6BindingConfig": {
		"domainNames": [
			"string"
		],
		"sntpServers": [
			"string"
		]
	},
	"dnsServers": [
		"string"
	],
	"id": "string",
	"ipAddress": "string",
	"leaseTime": 0,
	"macAddress": "string",
	"name": "string",
	"version": {
		"version": 0
	}
}
string
bindingType Required

The type of DHCP binding.

  • IPV4 - an IPv4 DHCP binding.
  • IPV6 - an IPv6 DHCP binding.


string
macAddress Required

MAC address of the host.


string
name Required

Display name for the DHCP binding.


string
description Optional

Description for the DHCP binding.


array of string
dnsServers Optional

DNS nameservers to be set to client host.


string
id Optional

The unique id of the DHCP binding.


string
ipAddress Optional

IP Address assigned to host. This address must belong to the subnet of Org vDC network. For IPv4, this is required. For IPv6, when not specified, Stateless Address Autoconfiguration (SLAAC) is used to auto-assign an IPv6 address to the DHCPv6 clients.


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. Default is 24 hours.


dhcpV4BindingConfig Optional

Additional configuration for IPv4 DHCP binding. This is ignored for IPV6 binding.


dhcpV6BindingConfig Optional

Additional configuration for IPv6 DHCP binding. This is ignored for IPV4 binding.


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/orgVdcNetworks/{vdcNetworkId}/dhcp/bindings/{bindingId}


[{"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
What's changed in v36.3?
INTRODUCED
Availability
Added in 36.1
Org VDC Network DHCP Operations
Feedback

Was this page helpful?