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

VdcNetworkDhcpConfig

Configuration for the DHCP service that runs for the network. In order to use DHCPv6 in NSX-T, the network must be configured in EDGE mode, the network must be attached to a router, and the router must have a SLAAC profile configured with DHCPv6 mode.

Properties

array of VdcNetworkDhcpPool

dhcpPools Optional

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

array of string

dnsServers 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.

JSON Example

{
	"dhcpPools": [
		{
			"defaultLeaseTime": 0,
			"enabled": false,
			"ipRange": {
				"endAddress": "string",
				"startAddress": "string"
			},
			"maxLeaseTime": 0
		}
	],
	"dnsServers": [
		"string"
	],
	"enabled": false,
	"ipAddress": "string",
	"leaseTime": 0,
	"mode": "string"
}

Vendor Extensions

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

x-vcloud-property-annotations:
    dnsServers:
        x-vcloud-added-in: "36.1"
        x-vcloud-constraints:
            - args:
                - arg: IPV4_IP
                - arg: IPV6_IP
              constraint: NetworkAddress
            - constraint: NonSearchable
            - constraint: NonSortable
    ipAddress:
        x-vcloud-added-in: "35.0"
        x-vcloud-constraints:
            - args:
                - arg: IPV4_IP
                - arg: IPV6_IP
              constraint: NetworkAddress
    leaseTime:
        x-vcloud-added-in: "35.0"
    mode:
        x-vcloud-added-in: "35.0"

vmware-cloud-director

Availability

Added in 32.0

Parameter To

Update Network DHCP Config

Returned By

Get Network DHCP Config