Get Network DHCP Config
DescriptionRetrieves Dhcp configuration of a specific Org vDC network.
Request
URLURL
Path Parameters
Path Parameters
Authentication
Response
Response BodyResponse Body
200 OK
{
"dhcpPools": [
{
"defaultLeaseTime": 0,
"enabled": false,
"ipRange": {
"endAddress": "string",
"startAddress": "string"
},
"maxLeaseTime": 0
}
],
"dnsServers": [
"string"
],
"enabled": false,
"ipAddress": "string",
"leaseTime": 0,
"mode": "string"
}
Range of DHCP IP addresses. These should not be set for RELAY mode.
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.
Whether the DHCP service is currently enabled on network.
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.
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.
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.
Errors
The specified resource was not found
