- Created by Documentation, last modified on Nov 01, 2018
disable_authentication_provider
disable_failing_authentication_providers
enable_authentication_provider
get_available_authentication_providers
get_provider_client_configurations
get_provider_configuration_fields
get_provider_display_configurations
get_users_authn_linked_accounts
set_provider_client_configurations
set_provider_display_configurations
twofactorauth_generate_tfa_config
twofactorauth_get_user_configs
cpgreylist_is_server_netblock_trusted
cpgreylist_list_entries_for_common_mail_provider
cpgreylist_load_common_mail_providers_config
cpgreylist_save_common_mail_providers_config
cpgreylist_trust_entries_for_common_mail_provider
cpgreylist_untrust_entries_for_common_mail_provider
create_cpgreylist_trusted_host
delete_cpgreylist_trusted_host
block_incoming_email_from_country
block_incoming_email_from_domain
expunge_messages_for_mailbox_guid
get_unique_recipient_count_per_sender_for_user
get_unique_sender_recipient_count_per_user
get_user_email_forward_destination
list_blocked_incoming_email_countries
list_blocked_incoming_email_domains
set_user_email_forward_destination
unblock_incoming_email_from_country
unblock_incoming_email_from_domain
Description
This function retrieves usage information for IPv6 addresses in an IPv6 range.
Note:
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
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
Notes:
- Unless otherwise noted, 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
{ "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>
Note:
Parameters
Parameter | Type | Description | Possible values | Example |
---|---|---|---|---|
name | string | Required The IPv6 address range's name. |
| WhereTheSkiesAreNotCloudyAllDay |
Returns
Return | Type | Description | Possible values | Example |
---|---|---|---|---|
usage | hash | A hash of the IPv6 address range's information. | This hash includes the forbidden , free , and used returns. | |
| integer | The number of reserved IPv6 addresses. The function returns this value in the | A positive integer. | 65536 |
| integer | The number of available IPv6 addresses. The function returns this value in the | A positive integer. | 1000000 |
| integer | The number of assigned IPv6 addresses. The function returns this value in the | A positive integer. | 20 |
Function information
API Version:
Available in:
WHM 11.40+
Methods:
GET, POST
Required Parameters:
name
Return Formats:
About WHM API 1
WHM API 1 performs functions and accesses data in WHM.
Notes:
- Some functions and parameters may require that you authenticate as the
root
user. - You must use the appropriate WHM ports (
2086
or2087
) to call WHM API functions.
Find a function
Related functions
-
Page:WHM API 1 Functions - ipv6_range_add — This function adds a range of IPv6 addresses to the server.
-
Page:WHM API 1 Functions - ipv6_range_edit — This function changes an IPv6 address range's name and note.
-
Page:WHM API 1 Functions - ipv6_range_remove — This function removes an IPv6 address range from the server.
-
Page:WHM API 1 Functions - ipv6_enable_account — This function assigns an IPv6 address to one or more accounts.
-
Page:WHM API 1 Functions - ipv6_disable_account — This function removes the IPv6 address from an account.