Child pages
  • UAPI Functions - Bandwidth::get_enabled_protocols

Versions Compared

Key

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

Description

Excerpt
This function returns a list of the server's enabled protocols.


Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone


Expand
titlecPanel or Webmail Session URL


Code Block
languagetext
https://hostname.example.com:2083/cpsess##########/execute/Bandwidth/get_enabled_protocols

Include Page
LIB:_CallUAPIFromBrowserLink
LIB:_CallUAPIFromBrowserLink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
//Retrieves the server's enabled protocols.
$get_protocols = $cpanel->uapi(
    'Bandwidth', 'get_enabled_protocols'
);

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.
 
# Retrieves the server's enabled protocols.
my $get_protocols = $cpliveapi->uapi(
    'Bandwidth', 'get_enabled_protocols'
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Template Toolkit


Code Block
languagexml
<!-- Retrieves the server's enabled protocols. -->
[% execute('Bandwidth', 'get_enabled_protocols') %]

Include Page
LIB:_TTLink
LIB:_TTLink


Expand
titleCommand Line


Code Block
languagetext
uapi --user=username Bandwidth get_enabled_protocols

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{  
   "result":{  
      "messages":null,
      "warnings":null,
      "status":1,
      "data":[  
         "imap",
         "pop3",
         "smtp"
      ],
      "metadata":{  
         "transformed":1
      },
      "errors":null
   }


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
dataarray of strings

The bandwidth protocols that the server records.

  • ftp
  • http


    Note
    titleNote:

    This value includes all web traffic for the 80 and 443 ports.


  • imap
  • pop3
  • smtp
imap