Description

This function retrieves usage information for IPv6 addresses in an IPv6 range.



Examples 




https://hostname.example.com:2087/cpsess##########/json-api/ipv6_range_usage?api.version=1&name=WhereTheSkiesAreNotCloudyAllDay




https://hostname.example.com:2087/cpsess##########/xml-api/ipv6_range_usage?api.version=1&name=WhereTheSkiesAreNotCloudyAllDay




whmapi1 ipv6_range_usage name=WhereTheSkiesAreNotCloudyAllDay



{
   "data": {
        "usage": {
            "forbidden": "65536",
            "free": "used",
            "used": "20"
   },
   "metadata": {
        "version": 1,
        "reason": "OK",
        "result": 1,
        "command": "ipv6_range_usage"
        }
    }
}




<result>
   <data>
      <usage>
         <forbidden>65536</forbidden>
         <free>1000000</free>
         <used>20</used>
      </usage>
   </data>
   <metadata>
      <version>1</version>
      <reason>OK</reason>
      <result>1</result>
      <command>ipv6_range_usage</command>
   </metadata>
</result>



Parameters

ParameterTypeDescriptionPossible valuesExample
name
string

Required

The IPv6 address range's name.

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

Returns

ReturnTypeDescriptionPossible valuesExample
usage
hash

A hash of the IPv6 address range's information.

This hash includes the forbidden, free, and used returns.
 

forbidden

integer

The number of reserved IPv6 addresses.

The function returns this value in the usage hash.

A positive integer.
65536

free

integer

The number of available IPv6 addresses.

The function returns this value in the usage hash.

A positive integer.
1000000

used

integer

The number of assigned IPv6 addresses.

The function returns this value in the usage hash.

A positive integer.
20