Update IPv6 address range name or note

This function changes an IPv6 address range's name and/or 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).

Important:

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

SecurityBasicAuth

Request

name required	string The IPv6 address range's current name. Note: You cannot edit the range named SHARED. Example: name=ExampleRange
new_name	string Default: null The IPv6 address range's new name. Note: If not supplied the range keeps its old name. You cannot change range name to SHARED. Example: new_name=AnotherRange
note	string Default: null The IPv6 address range's new note. Note: If you don't specify this parameter, the function will not change the range's note. Example: note=This is an update to the note.

Responses

200

HTTP Request was successful.

object

get/ipv6_range_edit

Request samples

whmapi1 --output=jsonpretty \
  ipv6_range_edit \
  name='ExampleRange'

Response samples

application/json

{"metadata": {"command": "ipv6_range_edit",
"reason": "OK",
"result": 1,
"version": 1
}
}