Page History
About this Resource
| Excerpt |
|---|
Defines a DHCP Pool managed object. |
REST API Methods for this Resource
Resource Schema
Configuration
| Parameter Name | Required | Service Affecting | Data Type | Default Value | Possible Values | Description |
|---|---|---|---|---|---|---|
| Name | Yes | Yes | string | none | 64 - 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. |
| Type | Yes | Yes | Enum | 0 | Possible values:
| 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. |
| Interface | Yes | Yes | string | none | 64 - Max Length | Specifies the name of the interface that this DHCP object is associated with, followed by -1 for primary and -2 for secondary. |
| PoolIPStart | Yes | Yes | string | none | 46 - 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. |
| PoolIPEnd | Yes | Yes | string | none | 46 - 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. |
| ClientPoolID | No | Yes | int | 0 | Possible values:
| Specifies the DHCP Pool ID that this DHCP Static Client is associated with. Only valid for DHCP Static Client objects. |
| ClientIP | Yes | Yes | string | none | 46 - 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. |
| Netmask | Yes | Yes | string | none | 46 - Max Length | Specifies the network mask for the DHCP-client(s) to use. DHCP option 1. Must be an IPv4 netmask. |
| LeaseDuration | Yes | Yes | int | 86400 | Possible values:
| Specifies the lease duration for the DHCP-clients in number of seconds. Max (i.e. 2147483648) represents infinite lease. |
| DefaultRouterIP | No | No | string | none | 46 - Max Length | Specifies the default router IP address for the DHCP-client(s) to use. DHCP option 3. Must be an IPv4 address. |
| DnsServerIP | No | No | string | none | 46 - Max Length | Specifies the DNS server IP for the DHCP-client(s) to use. DHCP option 6. Must be an IPv4 address. |
| DomainName | No | No | string | none | 256 - Max Length | Specifies the domain name for the DHCP-client(s) to use. DHCP option 15. |
| SIPServer1 | No | No | string | none | 256 - Max Length | Specifies the SIP-server for the DHCP-client(s) to use. DHCP option 120. Either FQDN or IPv4 Address. |
| SIPServer2 | No | No | string | none | 256 - Max Length | Specifies the SIP-server for the DHCP-client(s) to use. DHCP option 120. Either FQDN or IPv4 Address. |
| NTPServer1IP | No | No | string | none | 46 - Max Length | Specifies the NTP-server for the DHCP-client(s) to use. DHCP option 42. Must be an IPv4 Address. |
| NTPServer2IP | No | No | string | none | 46 - Max Length | Specifies the NTP-server for the DHCP-client(s) to use. DHCP option 42. Must be an IPv4 Address. |
| TFTPServer | No | No | string | none | 256 - Max Length | Specifies the TFTP-server for the DHCP-client(s) to use. DHCP option 66. Can be any server name or IP address. |
| Bootfile | No | No | string | none | 128 - Max Length | Specifies the bootfile for the DHCP-client(s) to use. DHCP option 67. |
| VSICount | No | No | int | Possible values:
| Specifies the number of Vendor Specific Information attributes used. Option 43. | |
| VSIName_1 | No | No | string | none | 64 - 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_1 | No | No | int | Possible values:
| Specifies the Vendor Specific Information option code to be sent. | |
| VSIValue_1 | No | No | string | none | 64 - 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_2 | No | No | string | none | 64 - 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_2 | No | No | int | Possible values:
| Specifies the Vendor Specific Information option code to be sent. | |
| VSIValue_2 | No | No | string | none | 64 - 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_3 | No | No | string | none | 64 - 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_3 | No | No | int | Possible values:
| Specifies the Vendor Specific Information option code to be sent. | |
| VSIValue_3 | No | No | string | none | 64 - 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_4 | No | No | string | none | 64 - 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_4 | No | No | int | Possible values:
| Specifies the Vendor Specific Information option code to be sent. | |
| VSIValue_4 | No | No | string | none | 64 - 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_5 | No | No | string | none | 64 - 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_5 | No | No | int | Possible values:
| Specifies the Vendor Specific Information option code to be sent. | |
| VSIValue_5 | No | No | string | none | 64 - 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_6 | No | No | string | none | 64 - 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_6 | No | No | int | Possible values:
| Specifies the Vendor Specific Information option code to be sent. | |
| VSIValue_6 | No | No | string | none | 64 - 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_7 | No | No | string | none | 64 - 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_7 | No | No | int | Possible values:
| Specifies the Vendor Specific Information option code to be sent. | |
| VSIValue_7 | No | No | string | none | 64 - 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_8 | No | No | string | none | 64 - 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_8 | No | No | int | Possible values:
| Specifies the Vendor Specific Information option code to be sent. | |
| VSIValue_8 | No | No | string | none | 64 - 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. |
| VIVOCount | No | No | int | Possible values:
| Specifies the number of Vendor-Identifying Vendor Options used. | |
| VIVOEnterpriseNum_1 | No | No | int | Possible values:
| 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_1 | No | No | int | Possible values:
| Specifies the Vendor-Identifying Vendor Option code to be sent. | |
| VIVOData_1 | No | No | string | none | 64 - 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_2 | No | No | int | Possible values:
| 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_2 | No | No | int | Possible values:
| Specifies the Vendor-Identifying Vendor Option code to be sent. | |
| VIVOData_2 | No | No | string | none | 64 - 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_3 | No | No | int | Possible values:
| 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_3 | No | No | int | Possible values:
| Specifies the Vendor-Identifying Vendor Option code to be sent. | |
| VIVOData_3 | No | No | string | none | 64 - 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_4 | No | No | int | Possible values:
| 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_4 | No | No | int | Possible values:
| Specifies the Vendor-Identifying Vendor Option code to be sent. | |
| VIVOData_4 | No | No | string | none | 64 - 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_5 | No | No | int | Possible values:
| 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_5 | No | No | int | Possible values:
| Specifies the Vendor-Identifying Vendor Option code to be sent. | |
| VIVOData_5 | No | No | string | none | 64 - 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_6 | No | No | int | Possible values:
| 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_6 | No | No | int | Possible values:
| Specifies the Vendor-Identifying Vendor Option code to be sent. | |
| VIVOData_6 | No | No | string | none | 64 - 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_7 | No | No | int | Possible values:
| 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_7 | No | No | int | Possible values:
| Specifies the Vendor-Identifying Vendor Option code to be sent. | |
| VIVOData_7 | No | No | string | none | 64 - 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_8 | No | No | int | Possible values:
| 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_8 | No | No | int | Possible values:
| Specifies the Vendor-Identifying Vendor Option code to be sent. | |
| VIVOData_8 | No | No | string | none | 64 - 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. |
Overview
Content Tools