Return IPv6 address usage

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

Note:

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

query Parameters

name

required

string

The IPv6 address range's name.

Example: name=TestRange

Responses

200

HTTP Request was successful.

Response Schema: application/json

	object
	object

get/ipv6_range_usage

Request samples

whmapi1 --output=jsonpretty \
  ipv6_range_usage \
  name='TestRange'

Response samples

application/json

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