Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
WHM API 1 Functions - ipv6_range_edit - Developer Documentation - cPanel Documentation
Child pages
  • WHM API 1 Functions - ipv6_range_edit
Skip to end of metadata
Go to start of metadata

Description

This function changes an IPv6 address range's name and note.

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).

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/ipv6_range_edit?api.version=1&name=TheNarrator&new_name=TylerDurden&note=The%20first%20rule%20of%20Fight%20Club%20is%20that%20you%20do%20not%20talk%20about%20Fight%20Club.
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/ipv6_range_edit?api.version=1&name=TheNarrator&new_name=TylerDurden&note=The%20first%20rule%20of%20Fight%20Club%20is%20that%20you%20do%20not%20talk%20about%20Fight%20Club.
 Command Line
whmapi1 ipv6_range_edit name=TheNarrator new_name=TylerDurden note="The first rule of Fight Club is that you do not talk about Fight Club."


Notes:

  • Unless otherwise noted, you must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
    "metadata": {
        "version": 1,
        "reason": "OK",
        "result": 1,
        "command": "ipv6_range_edit"
    }
}
 Output (XML)
<result>
   <metadata>
      <version>1</version>
      <reason>OK</reason>
      <result>1</result>
      <command>ipv6_range_edit</command>
   </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

   

Parameters

ParameterTypeDescriptionPossible valuesExample
name
string

Required

The IPv6 address range's current name.

The name of an IPv6 address range on the server.
The Narrator

new_name

string

Required

The IPv6 address range's new name.

A valid string.Tyler Durden
notestring

Required

The IPv6 address range's note.

A valid string.The first rule of Fight Club is that you do not talk about Fight Club.

Returns

This function only returns metadata.