VdcNetworkDhcpConfig

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

JSON Example 
{
    "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.

Availability
Added in 32.0
Parameter To
Returned By