Child pages
  • UAPI Functions - Ftp::allows_anonymous_ftp

Versions Compared

Key

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

 

Description

Excerpt
This function checks whether the account allows anonymous FTP connections.

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/Ftp/allows_anonymous_ftp

Include Page
LIB:_CallUAPIFromBrowserLink
LIB:_CallUAPIFromBrowserLink

Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Check whether anonymous FTP is enabled.
$anon_ftp_enabled = $cpanel->uapi(
    'Ftp', 'allows_anonymous_ftp'
);

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.
 
# Check whether anonymous FTP is enabled.
my $anon_ftp_enabled = $cpliveapi->uapi(
    'Ftp', 'allows_anonymous_ftp',
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 

Expand
titlecPanel Template Toolkit
Code Block
languagexml
linenumberstrue
<!-- Check whether anonymous FTP is enabled. -->
[% execute( 'Ftp', 'allows_anonymous_ftp' ); %]

Include Page
LIB:_TTLink
LIB:_TTLink

 

Expand
titleCommand Line
Code Block
languagexml
uapi --user=username Ftp allows_anonymous_ftp 

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": {
    "allows": 0
  }
}

Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote

   

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
allowsBooleanWhether the cPanel account allows anonymous FTP connections.
  • 1 — Allowed.
  • 0 — Not allowed.
1