Child pages
  • WHM API 1 Functions - ipv6_range_add

Versions Compared

Key

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

Description

Excerpt

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


Note
titleNotes:
  • 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).
  • Include Page
    LIB:_IPv6cpsrvdNote
    LIB:_IPv6cpsrvdNote


Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleJSON API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/ipv6_range_add?api.version=1&enabled=1&name=ExampleRange&range=2001%3Adb8%3A111%3A%3A%2F64



Expand
titleXML API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/ipv6_range_add?api.version=1&enabled=1&name=ExampleRange&range=2001%3Adb8%3A111%3A%3A%2F64



Expand
titleCommand Line


Code Block
languagebash
whmapi1 ipv6_range_add enabled=1 name=ExampleRange range=2001%3Adb8%3A111%3A%3A%2F64

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
    "metadata": {
        "version": 1,
        "reason": "OK",
        "result": 1,
        "command": "ipv6_range_add"
    }
}



Expand
titleOutput (XML)


Code Block
languagetext
linenumberstrue
<result>
   <metadata>
      <version>1</version>
      <reason>OK</reason>
      <result>1</result>
      <command>ipv6_range_add</command>
   </metadata>
</result>


Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote


   

Parameters

ParameterTypeDescriptionPossible valuesExample
range
string

Required

The IPv6 address range.

A valid IPv6 address range and network portion, in CIDR format.
                2001:db8:66ac:cafe::/64
              

name

string

Required

The IPv6 address range's name.

A valid string.

Note
titleNote:

You cannot use SHARED as a range's name. In cPanel & WHM version 54 and later, the system reserves this name for the server's shared IPv6 address. 


ExampleRange
enabledBooleanWhether the IPv6 address range is available.
  • 1 — Available.
  • 0 — Reserved.
1

Returns

This function only returns metadata.