Add IPv6 address range

This function adds a range of IPv6 addresses to the server.

Notes:

  • This function cannot modify the server's shared IPv6 address. To update that address, modify the /etc/wwwacct.conf file, or use WHM's Basic WebHost Manager Setup interface (Home >> Server Configuration >> Basic WebHost Manager Setup).
  • For all of cPanel & WHM's features to function properly on IPv6, the cpsrvd daemon must listen on IPv6 addresses. To enable this functionality, select On for the Listen on IPv6 Addresses setting in the System section of WHM's Tweak Settings interface (WHM >> Home >> Server Configuration >> Tweak Settings).

Important:

When you disable the Web Server role, the system disables this function.

SecurityBasicAuth
Request
query Parameters
name
required
string

The IPv6 address range's name.

Note:

You cannot use SHARED as a range's name. It is reserved for the server's shared IPv6 address.

Example: name=ExampleRange
range
required
string

The IPv6 address range and network portion in CIDR format.

Example: range=2001:db8:66ac:cafe::/64
enabled
integer
Default: 1

Whether the IPv6 address range is available.

Note

  • 1 - Available.
  • 0 - Reserved.
Enum: 0 1
Example: enabled=1
note
string or null
Default: null

A note for the IPv6 address range.

Example: note=Initial IPv6 address pool
Responses
200

HTTP Request was successful.

Response Schema: application/json
object
get/ipv6_range_add
Request samples
whmapi1 --output=jsonpretty \
  ipv6_range_add \
  range='2001:db8:66ac:cafe::/64' \
  name='ExampleRange'
Response samples
application/json
{
  • "metadata": {
    • "command": "ipv6_range_add",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}