Update Network Dhcp Config

Update Network Dhcp Config

Updates Dhcp configuration of a specific Org vDC network.

Request
URI
PUT
https://{api_host}/cloudapi/1.0.0/orgVdcNetworks/{vdcNetworkId}/dhcp
COPY
Path Parameters
string
vdcNetworkId
Required

vdcNetworkId

string
vdcNetworkId
Required

vdcNetworkId

Request Body
VdcNetworkDhcpConfig of type(s) application/json
Required 
{
    "enabled": false,
    "leaseTime": 0,
    "dhcpPools": [
        {
            "enabled": false,
            "ipRange": {
                "startAddress": "string",
                "endAddress": "string"
            },
            "maxLeaseTime": 0,
            "defaultLeaseTime": 0
        }
    ],
    "mode": "string",
    "ipAddress": "string",
    "dnsServers": [
        "string"
    ]
}
boolean
enabled
Optional

Whether the DHCP service is currently enabled on network.

integer As int64 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.

array of VdcNetworkDhcpPool
dhcpPools
Optional

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

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

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.

Authentication
This operation uses the following authentication methods.
Responses
202

The request have been accepted and the task to monitor the request is in the Location header.

Operation doesn't return any data structure

400

Invalid configuration.

Returns Error of type(s) */*;version=37.1 
{
    "minorErrorCode": "string",
    "message": "string",
    "stackTrace": "string"
}
string
minorErrorCode
Required

minorErrorCode

string
message
Required

message

string
stackTrace
Optional

stackTrace


404

The specified resource was not found

Returns Error of type(s) */*;version=37.1 
{
    "minorErrorCode": "string",
    "message": "string",
    "stackTrace": "string"
}
string
minorErrorCode
Required

minorErrorCode

string
message
Required

message

string
stackTrace
Optional

stackTrace


Availability
Added in 32.0
On This Page
Org Vdc Network Dhcp Operations
POST
Create Dhcp Binding
DELETE
Delete Dhcp Binding
DELETE
Delete Network Dhcp Config
GET
Get Dhcp Binding
GET
Get Dhcp Bindings
GET
Get Network Dhcp Config
PUT
Update Dhcp Binding
PUT
Update Network Dhcp Config