Versions Compared

Old Version 3

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version 4

changes.mady.by.user Ribbon Communications

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

REST API Method: POST /rest/dhcpstaticclient/{identifier}

dhcpstaticclient - REST API Methods
Page Tree
rootResource - dhcpstaticclient

Modifies a DHCP Static Client managed object.

URL:

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

HTTP Method

POST

Requires Authentication:

true



Parameters

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
NameYesYesstringnone64 - Max LengthSpecifies 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 LengthSpecifies the name of the interface that this DHCP object is associated with, followed by -1 for primary and -2 for secondary.
PoolIPStartYesYesstringnone46 - Max LengthSpecifies 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 LengthSpecifies 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 LengthSpecifies 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 LengthSpecifies 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 LengthSpecifies the default router IP address for the DHCP-client(s) to use. DHCP option 3. Must be an IPv4 address.
DnsServerIPNoNostringnone46 - Max LengthSpecifies the DNS server IP for the DHCP-client(s) to use. DHCP option 6. Must be an IPv4 address.
DomainNameNoNostringnone256 - Max LengthSpecifies the domain name for the DHCP-client(s) to use. DHCP option 15.
SIPServer1NoNostringnone256 - Max LengthSpecifies the SIP-server for the DHCP-client(s) to use. DHCP option 120. Either FQDN or IPv4 Address.
SIPServer2NoNostringnone256 - Max LengthSpecifies the SIP-server for the DHCP-client(s) to use. DHCP option 120. Either FQDN or IPv4 Address.
NTPServer1IPNoNostringnone46 - Max LengthSpecifies the NTP-server for the DHCP-client(s) to use. DHCP option 42. Must be an IPv4 Address.
NTPServer2IPNoNostringnone46 - Max LengthSpecifies the NTP-server for the DHCP-client(s) to use. DHCP option 42. Must be an IPv4 Address.
TFTPServerNoNostringnone256 - Max LengthSpecifies the TFTP-server for the DHCP-client(s) to use. DHCP option 66. Can be any server name or IP address.
BootfileNoNostringnone128 - Max LengthSpecifies 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 LengthSpecifies 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 LengthSpecifies 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 LengthSpecifies 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 LengthSpecifies 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 LengthSpecifies 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 LengthSpecifies 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 LengthSpecifies 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 LengthSpecifies 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 LengthSpecifies 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 LengthSpecifies 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 LengthSpecifies 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 LengthSpecifies 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 LengthSpecifies 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 LengthSpecifies 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 LengthSpecifies 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 LengthSpecifies 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 LengthSpecifies 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 LengthSpecifies 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 LengthSpecifies 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 LengthSpecifies 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 LengthSpecifies 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 LengthSpecifies 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 LengthSpecifies 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 LengthSpecifies 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.

Tip
titleHelpful Tip

The POST can contain either only the attributes that are being updated, or the full set of attributes for the resource

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

Code Block
languagebash
Put code example here

Response:

Code Block
languagehtml/xml
Put Code response here