Child pages
  • cPanel API 1 Functions - Stats::bwbar

Versions Compared

Key

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

Description

Excerpt

This function retrieves a graphical bar that indicates bandwidth usage for the account's domains.

Include Page
LIB:_cPanelAPI1NoEquivalent
LIB:_cPanelAPI1NoEquivalent

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$get_bwbar = $cpanel->api1('Stats','bwbar'); // Call the function.

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

Expand
titleLiveAPI Perl Module
Code Block
languageperl
linenumberstrue
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $get_bwbar = $cpliveapi->api1('Stats','bwbar'); # Call the function.

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 

Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelTagsWarning
LIB:_cPanelTagsWarning

Code Block
languagetext
<cpanel Module="Stats::bwbar()">
Expand
titleCommand Line
Code Block
languagebash
cpapi1 --user=username Stats bwbar

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote

Expand
titleOutput (HTML)
Code Block
languagetext
linenumberstrue
<table><tr><td
 class="barborder"><img src=bar.gif height=8 
width=${barlength}><img src=wbar.gif height=8 
width=${wbarlength}></td><td>${percent}% 
used</td></tr></table>

Parameters

This function does not accept parameters.

Returns

This function displays a bar in HTML that represents the amount of bandwidth that the account's domains use.