Page tree

Versions Compared

Key

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

Description

Excerpt

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


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



Expand
titleXML API


Code Block
languagexml
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.



Expand
titleCommand Line


Code Block
languagebash
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."

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote


Expand
titleOutput (JSON)


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



Expand
titleOutput (XML)


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


Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote


   

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.