Child pages
  • WHM API 1 Functions - ipv6_range_usage

Versions Compared

Key

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

Description

Excerpt

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


Note
titleNote:

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_usage?api.version=1&name=WhereTheSkiesAreNotCloudyAllDay



Expand
titleXML API


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



Expand
titleCommand Line


Code Block
languagebash
whmapi1 ipv6_range_usage name=WhereTheSkiesAreNotCloudyAllDay

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote


Expand
titleOutput (JSON)


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



Expand
titleOutput (XML)


Code Block
languagetext
linenumberstrue
<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>


Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote


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