Description

This function kills an active FTP session.

Examples


$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$kill_ftp = $cpanel->api1('Ftp','kill_ftp_session',array('12345') ); // Call the function.

 

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.

 

<cpanel Module="Ftp::kill_ftp_session( $FORM('pid'))">
cpapi1 --user=username Ftp kill_ftp_session 12345

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

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.