Create DHCP Server Configuration for Subnet (v2.2)

POST 
/sdwan/v2.2/api/sites/:site_id/dhcpservers

Create a new DHCP server configuration for a subnet.

Request

Path Parameters

site_id stringrequired

ID of the site. More details on the site can be retrieved by querying the sites API.

application/json

Body

Details of dhcp server config to be created

address_family stringrequired

Possible values: [IPV4, IPV6]

The DHCP config address values.

broadcast_address string

The address of the site.

custom_options CustomDHCPOptions[]
Custom options defined for the DHCP server.
Array [
option_definition stringrequired
Custom option definition. Max length supported is 1024.
option_value stringrequired
Custom option value. Max length supported is 8192.
vendor_class_identifier string
Vendor Class Identifier
]
default_lease_time int64

The lease time each client will get if a user does not request a particular lease time.

description

Description of each instance of the DHCP server, per subnet.

disabled boolean

Uncheck to enable the configuration.

dns_servers string[]

The domain name servers for clients to resolve DNS requests. Max number is 3.

domain_name string

The domain name for clients. Max length is 256.

gateway string

The default gateway for clients.

id string

The DHCP server ID.

ip_ranges IPRange[]required
The valid IPv4 address range for defined subnet.
Array [
end_ip stringrequired
The original end IP address for the defined subnet.
start_ip stringrequired
The original start IP address for the defined subnet.
]
max_lease_time int64

The maximum lease time the clients can use.

network_context_id string

ID of the network context, if configured.

static_mappings StaticMappingV2[]
IP addresses assigned to clients by statically mapping IPs to MAC addresses of the clients.
Array [
client_duid string
The DHCP server config duid provided for static mapping.
ip_address stringrequired
IP addresses assigned mapped to MAC addresses of the clients.
mac string
The mac addresses that need to be mapped.
name stringrequired
The name of the static mapping. Max length supported is 256.
]
subnet stringrequired

The subnet for which the DHCP server is being configured.

tags string[]

An information field that can be added to identify the DHCP server.

Responses

200

Successful Operation

application/json

Schema

Schema

address_family stringrequired

Possible values: [IPV4, IPV6]

The DHCP config address values.

broadcast_address string

The address of the site.

custom_options CustomDHCPOptions[]
Custom options defined for the DHCP server.
Array [
option_definition stringrequired
Custom option definition. Max length supported is 1024.
option_value stringrequired
Custom option value. Max length supported is 8192.
vendor_class_identifier string
Vendor Class Identifier
]
default_lease_time int64

The lease time each client will get if a user does not request a particular lease time.

description

Description of each instance of the DHCP server, per subnet.

disabled boolean

Uncheck to enable the configuration.

dns_servers string[]

The domain name servers for clients to resolve DNS requests. Max number is 3.

domain_name string

The domain name for clients. Max length is 256.

gateway string

The default gateway for clients.

id string

The DHCP server ID.

ip_ranges IPRange[]required
The valid IPv4 address range for defined subnet.
Array [
end_ip stringrequired
The original end IP address for the defined subnet.
start_ip stringrequired
The original start IP address for the defined subnet.
]
max_lease_time int64

The maximum lease time the clients can use.

network_context_id string

ID of the network context, if configured.

static_mappings StaticMappingV2[]
IP addresses assigned to clients by statically mapping IPs to MAC addresses of the clients.
Array [
client_duid string
The DHCP server config duid provided for static mapping.
ip_address stringrequired
IP addresses assigned mapped to MAC addresses of the clients.
mac string
The mac addresses that need to be mapped.
name stringrequired
The name of the static mapping. Max length supported is 256.
]
subnet stringrequired

The subnet for which the DHCP server is being configured.

tags string[]

An information field that can be added to identify the DHCP server.

Example (from schema)

{
  "address_family": "IPV4",
  "broadcast_address": "string",
  "custom_options": [
    {
      "option_definition": "string",
      "option_value": "string",
      "vendor_class_identifier": "string"
    }
  ],
  "default_lease_time": 0,
  "disabled": true,
  "dns_servers": [
    "string"
  ],
  "domain_name": "string",
  "gateway": "string",
  "id": "string",
  "ip_ranges": [
    {
      "end_ip": "string",
      "start_ip": "string"
    }
  ],
  "max_lease_time": 0,
  "network_context_id": "string",
  "static_mappings": [
    {
      "client_duid": "string",
      "ip_address": "string",
      "mac": "string",
      "name": "string"
    }
  ],
  "subnet": "string",
  "tags": [
    "string"
  ]
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "DHCPSERVER_CONFIG_INVALID_SUBNET_ADDR"
      },
      {
        "code": "DHCPSERVER_CONFIG_INVALID_BROADCAST_ADDR"
      },
      {
        "code": "DHCPSERVER_CONFIG_INVALID_DOMAIN_NAME"
      },
      {
        "code": "DHCPSERVER_CONFIG_INVALID_GATEWAY_ADDR"
      },
      {
        "code": "INVALID_NETWORK_CTX_ID"
      },
      {
        "code": "DHCPSERVER_CONFIG_UNSUPPORTED_DEFAULT_LEASE_TIME"
      },
      {
        "code": "DHCPSERVER_CONFIG_INVALID_DNS_LIST"
      },
      {
        "code": "DHCPSERVER_CONFIG_DNS_ENTRIES_EXCEEDS_LIMIT"
      },
      {
        "code": "DHCPSERVER_CONFIG_UNSUPPORTED_MAX_LEASE_TIME"
      },
      {
        "code": "DHCPSERVER_CONFIG_IP_RANGE_MISSING"
      },
      {
        "code": "DHCPSERVER_CONFIG_INVALID_TAGS"
      },
      {
        "code": "DHCPSERVER_CONFIG_DESCRIPTION_EXCEEDS_LIMIT"
      },
      {
        "code": "DHCPSERVER_CONFIG_GATEWAY_NOT_SUPPORTED_FOR_IPV6_FAMILY"
      },
      {
        "code": "DHCPSERVER_CONFIG_INVALID_IPV6_SUBNET_ADDR"
      },
      {
        "code": "DHCPSERVER_CONFIG_BROADCAST_ADDRESS_NOT_SUPPORTED_FOR_IPV6_FAMILY"
      },
      {
        "code": "DHCPSERVER_CONFIG_IP_RANGE_INVALID_IPV6"
      },
      {
        "code": "DHCPSERVER_CONFIG_INVALID_STATIC_MAPPING_IPV6"
      },
      {
        "code": "DHCPSERVER_CONFIG_INVALID_STATIC_MAPPING_MAC_NOT_SUPPORTED"
      },
      {
        "code": "DHCPSERVER_CONFIG_INVALID_STATIC_MAPPING_DUID_NOT_SUPPORTED"
      },
      {
        "code": "DHCPSERVER_CONFIG_INVALID_STATIC_MAPPING_DUID"
      }
    ]
  }
}

Loading...