Versions Compared

Old Version 9

changes.mady.by.user The Force

Saved on

compared with

New Version 10

changes.mady.by.user The Force

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from this space and version 5.1.3

...

push a DHCP config

DescriptionBuilds 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:

SUCCESSFUL:{"success":1,"message":"Pushes Attempted.","data":[[1,"1292","381 DHCP Module","Configuration successfully pushed."]]}
ERROR:{"success":0, "message":"error message"}

Data Detail

NameTypeDescription
idINTEGERThe id of the dhcp_module resource whose configuration is to be pushed.

DHCP search

DescriptionSearches DHCP information by name, mac, or IP.
URL

/api/v1/api.php?target=dhcp&action=search&searchType=name&searchValue=Blah

/api/v1/api.php?target=dhcp&action=search&searchType=mac&searchValue=22:

/api/v1/api.php?target=dhcp&action=search&searchType=ip&searchValue=13.0.0.255

Returns

Examples:

SUCCESSFUL:{"success":1,"message":"Search Successful","data":[{"id":"1482","name":"BlahBlah","slug":"blah","type":"dhcp_pool","parent_id":"1","category_id":null,"attr":{"_dhcp_type":"subnet","_dhcp_pool_attributes":"{\"mac\":\"\",\"rangeStart\":\"13.0.0.0\",\"rangeEnd\":\"13.0.0.255\",\"freeLines\":0}","_dhcp_ip_id":"80902"},"dhcp_links":["1422","3673"]}]}
ERROR:{"success":0, "message":"error message"}

Return Detail

NameTypeDescription
idINTEGERID of the dhcp_module resource
nameSTRINGThe name of the dhcp_module
slugSTRINGThe unique reference string for this resource
typeSTRINGAlways 'dhcp_pool'
parent_idINTEGERThe resource to which the dhcp_module is attached
category_idINTEGERThe category to which this dhcp_module is associated

Attributes

KeyTypeDescription
_dhcp_typeSTRINGEither 'subnet' or 'host'. Determines whether this DHCP Pool is describing a Subnet or a Host.
_dhcp_pool_attributesJSONA JSON-encoded string containing all the specific configuration parameters which govern this DHCP Pool. An expansion of the JSON object is given below in the Data Attributes section.
_dhcp_ip_idINTEGERThe id of the IPAM subnet or host which is assigned to this DHCP Pool.
_dhcp_linksINTEGERThe id of dhcp links.



 

Required Parameters
NameTypeExampleDescription
searchTypeSTRINGnameType of search performing. Valid values are 'name', 'mac', and 'ip'.
searchValue
STRINGBlah

If searchType is 'IP': searchValue must be a valid IP address or IP Block.

if searchType"is 'mac': searchValue must be a full or partial mac address.

Not required if searchType is 'name', but is recommended to filter results.

Optional Parameters
NameTypeExampleDescription
selectOffsetINTEGER10Start number for the first result to show on the page to set pagination. For example, a selectOffset=15 with a selectCount=10 would return result numbers 15 through 25 on the page. Default value is 0 if not specified.
selectCountINTEGER5The number of results to return on the page, if return results exceed the number of selectCount. Default value is 10
linkedToINTEGER1422The ID of the resource's DHCP link(s)

Data Attributes

_dhcp_attributes

DescriptionThe _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

NameTypeDescription
typeSTRINGThe type of DHCP server being administered. Currently only 'ISC' is supported.
notesSTRINGNotes associated with this DHCP server
server_ipSTRINGThe IP address of the DHCP server
usernameSTRING

The SSH username employed when transferring the DHCP configuration file to the server.

passwordSTRINGThe SSH password employed when transferring the DHCP configuration file to the server.
portINTEGERThe SSH port employed when transferring the DHCP configuration file to the server.
config_testSTRINGThe command to test if a configuration file parses correctly. ex: /etc/init.d/dhcpd configtest
server_stopSTRINGThe command to stop the DHCP server. ex: /etc/init.d/dhcpd stop
server_startSTRINGThe command to start the DHCP server. ex: /etc/init.d/dhcpd start
config_pathSTRINGWhere to place the configuration file on the server.
authoritativeBOOLWhether or not this DHCP server is authoritative.
default_lease_timeINTEGERThe default lease time for IPs distributed by this DHCP server.
max_lease_timeINTEGERThe max lease time for IPs distributed by this DHCP server.
local_portINTEGERThe port on which this DHCP server listens
option_routersSTRINGThe information which populates the "routers" option in the DHCP configuration

option_domain_name_servers

STRINGThe information which populates the "domain_name_servers" option in the DHCP configuration
option_domain_nameSTRINGThe information which populates the "domain_name" option in the DHCP configuration
log_facilitySTRINGThe log facility to which this DHCP Server sends its logging information
freeLinesINTEGERAs this system cannot hope to support all the thousands of different DHCP configurations, ProVision's DHCPv2 system includes a mechanism for adding "free lines" to the end of certain DHCP config sections so that administrators can customize their DHCP config file to their needs. The "freeLines" field indicates how many of these lines exist to be inserted after the general server definition section but before the subnets and hosts are enumerated.
freeLine#STRINGFree line data to be inserted after the general server definition section but before the subnets and hosts are enumerated. There can be multiple instances of this attribute, numbered appropriately. ex: "freeLine1", "freeLine2", "freeLine3", etc. The number of freeLine# entries must match the number in the "freeLines" attribute.

...