Cpanel::Ftp::listftpsessions

This article documents the usage of the Cpanel::Ftp::listftpsessions function in relation to the cPanel interface. This tag can be used inside cPanel pages.


SYNOPSIS

Cpanel::Ftp::listftpsessions


DESCRIPTION

This function will list information about active FTP sessions for a domain.


VARIABLES

INPUT

NONE

OUTPUT

user (string)
User logged into FTP server. Format: user or user@domain.com

host (string)
Hostname where FTP connection originated from. Format: x.domain.com

login (time)
Time FTP connection was opened. Format: xx:xx

status (string)
Status of connection.

pid (integer)
Process ID for user's FTP session.


EXAMPLES

<?cp Ftp::listftpsessions(% % % % %,user,host,login,status,pid) || 'No active FTP sessions' ?>

This example will list the username, host, login time, connection status, and process id for each active FTP session for the domain, or output ``No active FTP sessions'' if none are active.


COPYRIGHT

Copyright 2007 cPanel Inc.