...
delete a DHCP Pool | |||||
---|---|---|---|---|---|
Description | To delete a DHCP Pool, use the standard Resource-Delete functionality | ||||
URL | /api/v1/api.php?target=resource&action=delete&id=2165 | ||||
Returns | Examples:
|
assigning an IP address or blocks to a DHCP Pool | |||||
---|---|---|---|---|---|
Description | Assigning IP addresses or blocks to a DHCP Pool resource removes them from the available pool so they cannot be assigned out again. This procedure uses all the standard IPAM assignment functions, so long as the resource assigned from is the DHCP Available resource. | ||||
URL | /api/v1/api.php?target=ipam&action=smartAssign&resourceId=2162&type=ipv4&mask=31&rir=1918&assignedResourceId=1282 | ||||
Returns | Examples:
Return Detail: For a detailed breakdown of this endpoint's return data, please see the IPAM documentation. |
get all DHCP Pool linkages | |||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Description | The association between DHCP Pools and DHCP Modules belongs to the Resource Linkage family of endpoints. The 'relation' field should be set to the 'dhcpPoolLink' type to pull only DHCP Pool linkage information. | ||||||||||||||||||||||||||||
URL | /api/v1/api.php?target=resource&action=getLink&relation=dhcpPoolLink | ||||||||||||||||||||||||||||
Returns | Examples:
Return Detail:
Meta Attributes:
|
add a new DHCP Pool linkage | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Description | Adds a new link between a DHCP Pool and a dhcp_module resource. A single pool can be linked to many dhcp_modules, and a single dhcp_module can have any number of linked pools. | ||||||||||||||||
URL | /api/v1/api.php?target=resource&action=addLink&resource_id1=1292&resource_id2=2162&relation=dhcpPoolLink | ||||||||||||||||
Returns | Examples:
Data Detail:
|
delete DHCP Pool linkages | |||||
---|---|---|---|---|---|
Description | Deletes a link between a dhcp_module and a dhcp_pool. Uses the standard Resource Linkage endpoints. | ||||
URL | /api/v1/api.php?target=resource&action=deleteLink&id=22 | ||||
Returns | Examples:
|
push a DHCP config | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Description | Builds a DHCP configuration from the attributes assigned to a dhcp_module and all of the linked dhcp_pools. Pushes that config to the configured DHCP server, tests it against the config parsing function, then restarts the server with the new configuration. | ||||||||||
URL | /api/v1/api.php?target=dhcp&action=push&id=1292 | ||||||||||
Returns | Examples:
Data Detail
|
Data Attributes
_dhcp_attributes | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Description | The _dhcp_attributes data attribute holds the specific settings used to generate a DHCP configuration file, place it on a server via SCP, and restart that server via a SSH session. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example: | {"type":"ISC", "notes":"notes here", "username":"username", "port":"22", "config_test":"/etc/init.d/dhcpd configtest", "server_stop":"/etc/init.d/dhcpd stop", "server_start":"/etc/init.d/dhcpd start", "config_path":"/tmp/dhcpd.conf", "option_routers":"", "option_domain_name_servers":"", "option_domain_name":"", "authoritative":"1", "default_lease_time":"600", "max_lease_time":"7200", "local_port":"67", "log_facility":"local7", "password":"", "server_ip":"10.0.0.0", "freeLines":0} | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Data Description
|
...