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

DhcpBinding

Describes the DHCP Binding configuration of an Org vDC Network.

Properties

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

dhcpV4BindingConfig Optional

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

DhcpV6BindingConfig

dhcpV6BindingConfig Optional

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

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.

JSON Example

Show optional properties

{
	"bindingType": "string",
	"macAddress": "string",
	"name": "string"
}

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

Vendor Extensions

This class contains the following vendor extensions defined in the spec:

x-vcloud-property-annotations:
    bindingType:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    description:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    dhcpV4BindingConfig:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    dhcpV6BindingConfig:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    dnsServers:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
            - args:
                - arg: IPV4_IP
                - arg: IPV6_IP
              constraint: NetworkAddress
    id:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    ipAddress:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
            - args:
                - arg: IPV4_IP
                - arg: IPV6_IP
              constraint: NetworkAddress
    leaseTime:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    macAddress:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable

vmware-cloud-director

Availability

Added in 36.1

Property Of

DhcpBindings

Parameter To

Create DHCP Binding
Update DHCP Binding

Returned By

Get DHCP Binding

DhcpBinding

Properties

JSON Example

Vendor Extensions

Availability

Property Of

Parameter To

Returned By

What's changed in v37.0?

INTRODUCED

Was this page helpful?