Child pages
  • WHM API 1 Functions - ipv6_enable_account
Skip to end of metadata
Go to start of metadata

Description


This function assigns an IPv6 address to one or more accounts.

Notes:

  • You must perform at least one of the following actions before you call this function:
  • 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_enable_account?api.version=1&user=username&range=WhereTheSkiesAreNotCloudyAllDay
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/ipv6_enable_account?api.version=1&user=username&range=WhereTheSkiesAreNotCloudyAllDay
 Command Line
whmapi1 ipv6_enable_account user=username range=WhereTheSkiesAreNotCloudyAllDay


Notes:

  • 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)
{
    "data": {
        "ipv6": ["0101:ca75:0101:ca75:0101:ca75:0101:ca75"]
    },
    "metadata": {
        "version": 1,
        "reason": "OK",
        "result": 1,
        "command": "ipv6_enable_account"
    }
}

 Output (XML)
<result>
   <data>
      <ipv6>0101:ca75:0101:ca75:0101:ca75:0101:ca75</ipv6>
   </data>
   <metadata>
      <version>1</version>
      <reason>OK</reason>
      <result>1</result>
      <command>ipv6_enable_account</command>
   </metadata>
</result>


Note:

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

   

Parameters

ParameterTypeDescriptionPossible valuesExample
user
string

Required

The user's username.

A valid cPanel account name, or a comma-separated list of account names.
username
rangestring

Required

The IPv6 address range's name.

  • The name of an IPv6 address range on the server.
  • SHARED — Assign the server's shared IPv6 address to the account. cPanel & WHM version 54+ only.
WhereTheSkiesAreNotCloudyAllDay

 

Returns

ReturnTypeDescriptionPossible valuesExample
ipv6arrayAn array of the IPv6 addresses that the system assigned to the account.A list of valid IPv6 addresses on the server.0101:ca75:0101:ca75:0101:ca75:0101:ca75
fain_cntintegerThe number of accounts that failed to enable IPv6.A valid integer.
0
failures
hash

A hash of the function's failures.

This hash includes the used return.
 

used

string

The reason for the function's failures.

The function returns this value in the failures hash.

A valid string.StopPickingAtThat