Child pages
  • cPanel API 1 Functions - Ftp::kill_ftp_session

Versions Compared

Key

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

 

Description

Excerpt

This function kills an active FTP session.

Warning
titleWarning:

Include Page
LIB:_cPanelAPI1NewerFunctions
LIB:_cPanelAPI1NewerFunctions

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.
$kill_ftp = $cpanel->api1('Ftp','kill_ftp_session',array('12345') ); // 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 $kill_ftp = $cpliveapi->api1('Ftp','kill_ftp_session',['12345'] ); # 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="Ftp::kill_ftp_session( $FORM('pid'))">
Expand
titleCommand Line
Code Block
languagebash
cpapi1 --user=username Ftp kill_ftp_session 12345
Note
titleNote:

For more information and additional output options, read our Guide to cPanel API 1 documentation or run the cpapi1 --help command.  

Expand
titleOutput (none)
This function does not return output.

 

Parameters

ParameterTypeDescriptionPossible valuesExample
pidstring

Required

The FTP session's process identification number (PID).

  • A valid PID number — Kill a single FTP session.
  • all — Kill all of the account's FTP sessions.
12345

Returns

This function does not return output.