Create Dhcp Binding

Create Dhcp Binding

Creates a DHCP binding on an Org vDC Network.

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

vdcNetworkId

string
vdcNetworkId
Required

vdcNetworkId


Request Body
DhcpBinding of type(s) application/json
Optional
{
    "id": "string",
    "name": "string",
    "description": "string",
    "macAddress": "string",
    "ipAddress": "string",
    "leaseTime": 0,
    "dnsServers": [
        "string"
    ],
    "bindingType": "string",
    "dhcpV4BindingConfig": {
        "gatewayIpAddress": "string",
        "hostName": "string"
    },
    "dhcpV6BindingConfig": {
        "sntpServers": [
            "string"
        ],
        "domainNames": [
            "string"
        ]
    },
    "version": {
        "version": 0
    }
}
string
id
Optional

The unique id of the DHCP binding.

string
name
Required

Display name for the DHCP binding.

string
description
Optional

Description for the DHCP binding.

string
macAddress
Required

MAC address of the host.

string
ipAddress
Optional

IP Address assigned to host. For IPv4, when not specified, system will automatically allocate an available IP address from the static IP pool of the network. For IPv6, when not specified, Stateless Address Autoconfiguration (SLAAC) is used to auto-assign an IPv6 address to the DHCPv6 clients. Automatic allocation of available static IP address is only allowed for IPv4 bindings. This address must not overlap with the DHCP pool.

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. Default is 24 hours.

array of string
dnsServers
Optional

DNS nameservers to be set to client host.

string
bindingType
Required

The type of DHCP binding.

  • IPV4 - an IPv4 DHCP binding.
  • IPV6 - an IPv6 DHCP binding.
dhcpV4BindingConfig
Optional

Describes the additional configuration for IPv4 DHCP Binding of an Org vDC Network.

dhcpV6BindingConfig
Optional

Describes the additional configuration for IPv6 DHCP Binding of an Org vDC Network.

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.

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