HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

/system/vrfs/{VRF.name}/dhcp_server/dhcp_server_pools/{DHCP_Server_Pool.pool_name}

Path Params
string
required

Reference Resource: VRF
VRF identifier. Should be alphanumeric. VRF names must be unique.

string
required

Reference Resource: DHCP_Server_Pool
DHCPv4 Server address pools.

Body Params
bootp_options
object

BOOTP options to be transmitted to DHCPv4 clients. Boot file name, either one of TFTP server name or TFTP server address values are mandatory for the transmission of bootp information to the client.

dhcp_server_options
array of strings
length ≤ 9223372036854776000

Reference Resource: DHCP_Server_Option
The desired DHCPv4 options for this pool.

dhcp_server_options
dhcp_server_ranges
array of strings
length ≤ 9223372036854776000

Reference Resource: DHCP_Server_Range
The desired IPv4 address range for this pool.

dhcp_server_ranges
dhcp_server_static_hosts
array of strings
length ≤ 9223372036854776000

Reference Resource: DHCP_Server_Static_Host
The desired static IPv4 address bindings for this pool.

dhcp_server_static_hosts
string
length between 8 and 8

Lease expiry time in the format DD:HH:MM. The minimum lease time is two minutes and '00:00:00' represents an infinite lease.

string
required

Reference Resource: DHCP_Server_Pool
DHCPv4 Server address pools.

Responses
200

OK

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Language
Response
Click Try It! to start a request and see the response here!