Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 14 Next »

REST API Method: PUT /rest/dhcppool/{identifier}

Creates a DHCP Pool managed object.

URL:

https://134.56.227.163/rest/dhcppool/{identifier}

HTTP Method

PUT

Requires Authentication:

true



Parameters

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
NameYesYesstringnone64 - Max Length Specifies the name of the DHCP pool, if the object is a DHCP Pool. Specifies the MAC address of the DHCP client, if the object is a DHCP static-client. Note this is a create only attribute.
TypeYesYesEnum0Possible values:
  • 0 - DHCP_OBJ_TYPE_POOL
  • 1 - DHCP_OBJ_TYPE_SC
Specifies whether this is a DHCP pool or a static-client. Note this is a create only attribute and isn't visible through the UI.
InterfaceYesYesstringnone64 - Max Length Specifies the name of the interface that this DHCP object is associated with, followed by -1 for primary and -2 for secondary.
PoolIPStartYesYesstringnone46 - Max Length Specifies the starting IP address of the range from which the DHCP-clients will get their IP addresses. Mandatory for DHCP pool type objects. Only valid for DHCP Pool objects. Must be an IPv4 address.
PoolIPEndYesYesstringnone46 - Max Length Specifies the ending IP address of the range from which the DHCP-clients will get their IP addresses. Mandatory for DHCP pool type objects. Only valid for DHCP Pool objects. Must be an IPv4 address.
ClientPoolIDNoYesint0Possible values:
  • 0 - Minimum
  • 65534 - Maximum
Specifies the DHCP Pool ID that this DHCP Static Client is associated with. Only valid for DHCP Static Client objects.
ClientIPYesYesstringnone46 - Max Length Specifies the IP address to be assigned to this DHCP client. Mandatory for DHCP pool type objects. Only valid for DHCP Static-Client objects. Must be an IPv4 address.
NetmaskYesYesstringnone46 - Max Length Specifies the network mask for the DHCP-client(s) to use. DHCP option 1. Must be an IPv4 netmask.
LeaseDurationYesYesint86400Possible values:
  • 120 - Minimum
  • 2147483647 - Maximum
Specifies the lease duration for the DHCP-clients in number of seconds. Max (i.e. 2147483648) represents infinite lease.
DefaultRouterIPNoNostringnone46 - Max Length Specifies the default router IP address for the DHCP-client(s) to use. DHCP option 3. Must be an IPv4 address.
DnsServerIPNoNostringnone46 - Max Length Specifies the DNS server IP for the DHCP-client(s) to use. DHCP option 6. Must be an IPv4 address.
DomainNameNoNostringnone256 - Max Length Specifies the domain name for the DHCP-client(s) to use. DHCP option 15.
SIPServer1NoNostringnone256 - Max Length Specifies the SIP-server for the DHCP-client(s) to use. DHCP option 120. Either FQDN or IPv4 Address.
SIPServer2NoNostringnone256 - Max Length Specifies the SIP-server for the DHCP-client(s) to use. DHCP option 120. Either FQDN or IPv4 Address.
NTPServer1IPNoNostringnone46 - Max Length Specifies the NTP-server for the DHCP-client(s) to use. DHCP option 42. Must be an IPv4 Address.
NTPServer2IPNoNostringnone46 - Max Length Specifies the NTP-server for the DHCP-client(s) to use. DHCP option 42. Must be an IPv4 Address.
TFTPServerNoNostringnone256 - Max Length Specifies the TFTP-server for the DHCP-client(s) to use. DHCP option 66. Can be any server name or IP address.
BootfileNoNostringnone128 - Max Length Specifies the bootfile for the DHCP-client(s) to use. DHCP option 67.
VSICountNoNointPossible values:
  • 0 - Minimum
  • 8 - Maximum
Specifies the number of Vendor Specific Information attributes used. Option 43.
VSIName_1NoNostringnone64 - Max Length Specifies the vendor name for the Vendor Specific Information. Used to match against the client's vendor name and send the vendor attribute if a match occurs.
VSICode_1NoNointPossible values:
  • 0 - Minimum
  • 254 - Maximum
Specifies the Vendor Specific Information option code to be sent.
VSIValue_1NoNostringnone64 - Max Length Specifies the Vendor Specific Information option value to be sent. Can be either an ascii string of the attribute or a hex string of the aa:bb:cc format.
VSIName_2NoNostringnone64 - Max Length Specifies the vendor name for the Vendor Specific Information. Used to match against the client's vendor name and send the vendor attribute if a match occurs.
VSICode_2NoNointPossible values:
  • 0 - Minimum
  • 254 - Maximum
Specifies the Vendor Specific Information option code to be sent.
VSIValue_2NoNostringnone64 - Max Length Specifies the Vendor Specific Information option value to be sent. Can be either an ascii string of the attribute or a hex string of the aa:bb:cc format.
VSIName_3NoNostringnone64 - Max Length Specifies the vendor name for the Vendor Specific Information. Used to match against the client's vendor name and send the vendor attribute if a match occurs.
VSICode_3NoNointPossible values:
  • 0 - Minimum
  • 254 - Maximum
Specifies the Vendor Specific Information option code to be sent.
VSIValue_3NoNostringnone64 - Max Length Specifies the Vendor Specific Information option value to be sent. Can be either an ascii string of the attribute or a hex string of the aa:bb:cc format.
VSIName_4NoNostringnone64 - Max Length Specifies the vendor name for the Vendor Specific Information. Used to match against the client's vendor name and send the vendor attribute if a match occurs.
VSICode_4NoNointPossible values:
  • 0 - Minimum
  • 254 - Maximum
Specifies the Vendor Specific Information option code to be sent.
VSIValue_4NoNostringnone64 - Max Length Specifies the Vendor Specific Information option value to be sent. Can be either an ascii string of the attribute or a hex string of the aa:bb:cc format.
VSIName_5NoNostringnone64 - Max Length Specifies the vendor name for the Vendor Specific Information. Used to match against the client's vendor name and send the vendor attribute if a match occurs.
VSICode_5NoNointPossible values:
  • 0 - Minimum
  • 254 - Maximum
Specifies the Vendor Specific Information option code to be sent.
VSIValue_5NoNostringnone64 - Max Length Specifies the Vendor Specific Information option value to be sent. Can be either an ascii string of the attribute or a hex string of the aa:bb:cc format.
VSIName_6NoNostringnone64 - Max Length Specifies the vendor name for the Vendor Specific Information. Used to match against the client's vendor name and send the vendor attribute if a match occurs.
VSICode_6NoNointPossible values:
  • 0 - Minimum
  • 254 - Maximum
Specifies the Vendor Specific Information option code to be sent.
VSIValue_6NoNostringnone64 - Max Length Specifies the Vendor Specific Information option value to be sent. Can be either an ascii string of the attribute or a hex string of the aa:bb:cc format.
VSIName_7NoNostringnone64 - Max Length Specifies the vendor name for the Vendor Specific Information. Used to match against the client's vendor name and send the vendor attribute if a match occurs.
VSICode_7NoNointPossible values:
  • 0 - Minimum
  • 254 - Maximum
Specifies the Vendor Specific Information option code to be sent.
VSIValue_7NoNostringnone64 - Max Length Specifies the Vendor Specific Information option value to be sent. Can be either an ascii string of the attribute or a hex string of the aa:bb:cc format.
VSIName_8NoNostringnone64 - Max Length Specifies the vendor name for the Vendor Specific Information. Used to match against the client's vendor name and send the vendor attribute if a match occurs.
VSICode_8NoNointPossible values:
  • 0 - Minimum
  • 254 - Maximum
Specifies the Vendor Specific Information option code to be sent.
VSIValue_8NoNostringnone64 - Max Length Specifies the Vendor Specific Information option value to be sent. Can be either an ascii string of the attribute or a hex string of the aa:bb:cc format.
VIVOCountNoNointPossible values:
  • 0 - Minimum
  • 8 - Maximum
Specifies the number of Vendor-Identifying Vendor Options used.
VIVOEnterpriseNum_1NoNointPossible values:
  • 0 - Minimum
  • 2147483647 - Maximum
Specifies the vendor enterprise number for the Vendor-Identifying Vendor Options. Used to match against the client's vendor enterprise number and send a vendor attribute if a match occurs.
VIVOCode_1NoNointPossible values:
  • 0 - Minimum
  • 254 - Maximum
Specifies the Vendor-Identifying Vendor Option code to be sent.
VIVOData_1NoNostringnone64 - Max Length Specifies the Vendor-Identifying Vendor Option data to be sent. Can be either an ascii string of the attribute or a hex string of the aa:bb:cc format.
VIVOEnterpriseNum_2NoNointPossible values:
  • 0 - Minimum
  • 2147483647 - Maximum
Specifies the vendor enterprise number for the Vendor-Identifying Vendor Options. Used to match against the client's vendor enterprise number and send a vendor attribute if a match occurs.
VIVOCode_2NoNointPossible values:
  • 0 - Minimum
  • 254 - Maximum
Specifies the Vendor-Identifying Vendor Option code to be sent.
VIVOData_2NoNostringnone64 - Max Length Specifies the Vendor-Identifying Vendor Option data to be sent. Can be either an ascii string of the attribute or a hex string of the aa:bb:cc format.
VIVOEnterpriseNum_3NoNointPossible values:
  • 0 - Minimum
  • 2147483647 - Maximum
Specifies the vendor enterprise number for the Vendor-Identifying Vendor Options. Used to match against the client's vendor enterprise number and send a vendor attribute if a match occurs.
VIVOCode_3NoNointPossible values:
  • 0 - Minimum
  • 254 - Maximum
Specifies the Vendor-Identifying Vendor Option code to be sent.
VIVOData_3NoNostringnone64 - Max Length Specifies the Vendor-Identifying Vendor Option data to be sent. Can be either an ascii string of the attribute or a hex string of the aa:bb:cc format.
VIVOEnterpriseNum_4NoNointPossible values:
  • 0 - Minimum
  • 2147483647 - Maximum
Specifies the vendor enterprise number for the Vendor-Identifying Vendor Options. Used to match against the client's vendor enterprise number and send a vendor attribute if a match occurs.
VIVOCode_4NoNointPossible values:
  • 0 - Minimum
  • 254 - Maximum
Specifies the Vendor-Identifying Vendor Option code to be sent.
VIVOData_4NoNostringnone64 - Max Length Specifies the Vendor-Identifying Vendor Option data to be sent. Can be either an ascii string of the attribute or a hex string of the aa:bb:cc format.
VIVOEnterpriseNum_5NoNointPossible values:
  • 0 - Minimum
  • 2147483647 - Maximum
Specifies the vendor enterprise number for the Vendor-Identifying Vendor Options. Used to match against the client's vendor enterprise number and send a vendor attribute if a match occurs.
VIVOCode_5NoNointPossible values:
  • 0 - Minimum
  • 254 - Maximum
Specifies the Vendor-Identifying Vendor Option code to be sent.
VIVOData_5NoNostringnone64 - Max Length Specifies the Vendor-Identifying Vendor Option data to be sent. Can be either an ascii string of the attribute or a hex string of the aa:bb:cc format.
VIVOEnterpriseNum_6NoNointPossible values:
  • 0 - Minimum
  • 2147483647 - Maximum
Specifies the vendor enterprise number for the Vendor-Identifying Vendor Options. Used to match against the client's vendor enterprise number and send a vendor attribute if a match occurs.
VIVOCode_6NoNointPossible values:
  • 0 - Minimum
  • 254 - Maximum
Specifies the Vendor-Identifying Vendor Option code to be sent.
VIVOData_6NoNostringnone64 - Max Length Specifies the Vendor-Identifying Vendor Option data to be sent. Can be either an ascii string of the attribute or a hex string of the aa:bb:cc format.
VIVOEnterpriseNum_7NoNointPossible values:
  • 0 - Minimum
  • 2147483647 - Maximum
Specifies the vendor enterprise number for the Vendor-Identifying Vendor Options. Used to match against the client's vendor enterprise number and send a vendor attribute if a match occurs.
VIVOCode_7NoNointPossible values:
  • 0 - Minimum
  • 254 - Maximum
Specifies the Vendor-Identifying Vendor Option code to be sent.
VIVOData_7NoNostringnone64 - Max Length Specifies the Vendor-Identifying Vendor Option data to be sent. Can be either an ascii string of the attribute or a hex string of the aa:bb:cc format.
VIVOEnterpriseNum_8NoNointPossible values:
  • 0 - Minimum
  • 2147483647 - Maximum
Specifies the vendor enterprise number for the Vendor-Identifying Vendor Options. Used to match against the client's vendor enterprise number and send a vendor attribute if a match occurs.
VIVOCode_8NoNointPossible values:
  • 0 - Minimum
  • 254 - Maximum
Specifies the Vendor-Identifying Vendor Option code to be sent.
VIVOData_8NoNostringnone64 - Max Length Specifies the Vendor-Identifying Vendor Option data to be sent. Can be either an ascii string of the attribute or a hex string of the aa:bb:cc format.

Usage Example: (about cURL | requires a session token)

curl --cookie PHPSESSID=cuc2h83fqaispmu6m519sa5642 -s -k -i https://134.56.72.218/rest/dhcppool/1 -X PUT --data "VIVOCount=0&DefaultRouterIP=192.168.129.2&Bootfile=&PoolIPEnd=&VIVOData_5=&VIVOData_6=&DomainName=net.com&VIVOData_7=&VIVOData_8=&VIVOData_1=&VIVOData_2=&VIVOData_3=&VIVOData_4=&VIVOEnterpriseNum_1=0&SIPServer2=&SIPServer1=192.168.129.2&VIVOEnterpriseNum_5=0&VIVOEnterpriseNum_4=0&VIVOEnterpriseNum_3=0&VIVOEnterpriseNum_2=0&Netmask=255.255.255.0&Interface=vlan1.4032-1&VIVOEnterpriseNum_8=0&VIVOEnterpriseNum_6=0&VIVOEnterpriseNum_7=0&PoolIPStart=&ConfigIEState=1&VSIValue_1=&NTPServer1IP=&Type=1&VSIValue_6=&VSIValue_7=&VSIValue_8=&VSIValue_2=&VSIValue_3=&NTPServer2IP=&VSIValue_4=&VSIValue_5=&LeaseDuration=86400&ClientIP=192.168.129.3&VIVOCode_1=0&VIVOCode_2=0&VSICode_6=0&VIVOCode_3=0&VSICode_7=0&VIVOCode_4=0&VSICount=0&VSICode_8=0&VIVOCode_5=0&VSIName_2=&TFTPServer=&VSIName_3=&VSIName_1=&VSIName_6=&VSIName_7=&VSIName_4=&VSIName_5=&Name=00:11:22:33:44:55&ClientPoolID=1&VSIName_8=&DnsServerIP=192.168.129.2&VIVOCode_7=0&VSICode_3=0&VIVOCode_6=0&VSICode_2=0&VSICode_5=0&VIVOCode_8=0&VSICode_4=0&VSICode_1=0"

Response:

<?xml version="1.0"?>
<root>
 <status>
  <http_code>500</http_code>
 <app_status href="https://134.56.72.218/rest/dhcppool/1">
 <app_status_entry code="12070" params="Invalid Pool IP Start: "/>
 </app_status>
  </status>
</root>
  • No labels