Software Development Kit
cPanel & WHM's API [+] cPanel & WHM's API [-]Modules and Plugins [+] Modules and Plugins [-]
cPanel Modules
Writing cPanel Modules PHP Accounting Module cPanel::Accounting Perl Module Writing cPanel Plugins
Writing cPanel Plugins PHP in cPanel Plugin Interfaces cPanel CGI Scripts Live PHP in cPanel Plugins Plugin Variables Installing cPanel Plugins Adding Icons and Groups Plugin Installation File Generator Plugin Security Policy (
.pdf)
WHM Plugins
Creating WHM Plugins ACL Reference Table The swapip Utility cPanel Logger Module Pluggable dnsadmin Modules EasyApache Modules
Custom Modules?
cPanel & WHM Hooks [+] cPanel & WHM Hooks [-]
Standardized Hooks Introduction Taxonomy Getting Started Hooks Management Interface Hookable Events Advanced Usage Troubleshooting
Legacy Hooks Introduction Writing Function Hooks Script Hooks Custom Event Handlers cPanel Logger Module Universal Password Trap Hooking into EasyApache
EasyApache Hooks?
cPAddons (Site Software) [+] cPAddons (Site Software) [-]
System Administration [+] System Administration [-]
Developer Software [+] Developer Software [-]
Back to All Documentation
StatsBar Module Documentation
You can use the StatsBar module to pull information from the back end about a specific account. This information includes an account's disk space used, IP address, and more. The functions within this module may or may not be governed by a feature list. The required feature list may vary from function to function, to review a total list of the available features sets on a cPanel server, please see "Feature Manager" in WHM.StatsBar::stat
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Retrieve statistics about an account. This will include software versions, program paths, and resource usage. |
| Parameters: | |
| display (string, see notes) | |
| A list of the statistics you would like to view. Each of these values should be separated by a pipe (|). (e.g. 'ftpaccounts|perlversion|cpanelrevision') Possible values include: 'ftpaccounts' => Information about your FTP accounts. 'perlversion' => Your server's Perl version. 'dedicatedip' => Websites associated with your cPanel account that use dedicated IP addresses. 'hostname' => Your server's hostname. 'operatingsystem' => Your server's operating system. 'sendmailpath' => The path to the system's sendmail binary. 'autoresponders' => Information about auto-responders associated with your cPanel account. 'perlpath' => The absolute path to your Perl binary. 'emailforwarders' => Information about forwarders associated with your cPanel account. 'bandwidthusage' => Information about how much bandwidth your website has used. 'emailfilters' => Information about email filters configured for your cPanel account. 'mailinglists' => Information about mailing lists associated with your cPanel account. 'diskusage' => Information about how much disk space your website is using. 'phpversion' => Your server's PHP version. 'sqldatabases' => Information about SQL databases. 'apacheversion' => Your server's Apache version. 'kernelversion' => The version of your operating system's kernel. 'shorthostname' => The short version of your server's hostname. 'parkeddomains' => Information about parked domains associated with your cPanel account. 'cpanelbuild' => The cPanel build your server is using. (e.g. EDGE, STABLE, CURRENT, RELEASE) 'theme' => Your cPanel account's theme. 'addondomains' => Information about addon domains associated with your cPanel account. 'cpanelrevision' => The build of cPanel running on the server. 'machinetype' => The type of operating system your server runs, Linux or FreeBSD. 'cpanelversion' => Your server's cPanel version. 'mysqldiskusage' => The amount of disk space your MySQL databases are using. 'mysqlversion' => Your server's MySQL version. 'subdomains' => Information about subdomains associated with your cPanel account. 'postgresdiskusage' => The amount of disk space used by your PostgreSQL databases. 'sharedip' => Any websites associated with your cPanel account that use a shared IP address. 'hostingpackage' => The hosting package your cPanel account is using. 'emailaccounts' => Information about email accounts associated with your cPanel account . |
|
| Returns: | |
<data> <displaykey> <zeroisunlimited> A boolean value that indicates whether a value of '0' means unlimited or zero.</zeroisunlimited> <item> A string value that contains a human readable version of the item.</item> <max> A string value that contains the limit of parameter being queried. (e.g. max email accounts)</max> <langkey> A string value that contains the language key used for displaying the value.</langkey> <rowtype> A string value that contains 'even' or 'odd', alternating between values.</rowtype> <id> A string value that contains the display key passed to the module.</id> <module> A string value that contains the name of the module used to retrieve the information.</module> <count> Value of data being returned (e.g number of email accounts)</count> <units> A string value that contains the unit of value being checked. (e.g. 'MB' for megabytes)</units> <percent> A string value that contains the percentage of value, when applicable.</percent> <percent5> A string value that contains the percentage of value rounded to the nearest 5, when applicable.</percent5> <percent10> A string value that contains the percentage of value rounded to the nearest 10, when applicable.</percent10> <percent20> A string value that contains the percentage of value rounded to the nearest 20, when applicable.</percent20> </displaykey> </data> |
Edit | Attach | Print version | History: r2 < r1 | Backlinks | Raw View | More topic actions
Topic revision: r2 - 27 Mar 2012 - 16:48:22 - Main.JenniferDoubrava