The anonftp.exe utility serves to manage the anonymous FTP service. The utility allows the following operations:

  • enabling/disabling anonymous FTP access
  • restricting the download bandwidth and the maximum number of simultaneous connections
  • managing incoming directory parameters and login message options

Location

%plesk_cli%

Usage 

anonftp.exe <command> [<domain name>] [
<option 1> <param> [<option 2> <param>] ... [<option N> <param>]
]

Example

The following command enables the anonymous FTP service on the domain example.com, restricts the number of simultaneous FTP connections to 15, allows creating subdirectories within the incoming directory, and restricts the download bandwidth to 500 KB.

plesk bin anonftp.exe --update example.com -status true -max-connects 15 -incoming true -bandwidth 500

Commands

Command Parameter Description Example
--update or -u <domain name> Updates the anonymous FTP settings.

To enable the anonymous FTP service on the domain example.com:

plesk bin anonftp.exe --update example.com -status true

or

plesk bin anonftp.exe -u example.com -status true

--info or -i <domain name> Retrieves the information about anonymous FTP settings.

To get the info about anonymous FTP settings on example.com:

plesk bin anonftp.exe --info example.com

or

plesk bin anonftp.exe -i example.com

--help or -h   Displays help on the use of the utility.

To see the help info on the use of this utility:

plesk bin anonftp.exe --help

or

plesk bin anonftp.exe -h

Options

Option Parameter Description Example
-status true|false Enables/Disables the anonymous FTP service on the specified domain.

To enable the anonymous FTP service on example.com:

plesk bin anonftp.exe --update example.com -status true

-message true|false

Enables/Disables displaying a login message.

Is false by default.

To display the ‘Welcome!’ login message when logging to the anonymous FTP service on example.com:

plesk bin anonftp.exe --update example.com -status true -message true -message-text "Welcome!"

-message-text <string> Specifies a login message text.  
-incoming true|false

Enables/Disables upload to the incoming directory.

Is false by default.

To enable uploading files to the incoming directory:

plesk bin anonftp.exe --update example.com -status true -incoming true

-incoming-dirs true|false

Allows/Prohibit creating directories in the incoming directory.

Is false by default.

To allow creating directories in the incoming directory:

plesk bin anonftp.exe --update example.com -status true -incoming-dirs true

-incoming-downloads true|false

Enables/Disables downloading from the incoming directory.

Is false by default.

To allow downloading from the incoming directory:

plesk bin anonftp.exe --update example.com -status true -incoming-downloads true

-incoming-limit <number>[B|K|M|G|T]

Restricts the disk space used by the incoming directory.

Unlimited if set to -1.

To restrict the disk space for the incoming directory to 10 MB:

plesk bin anonftp.exe --update example.com -status true -incoming-limit 10M

-max-connects <number>

Restricts the number of available simultaneous connections.

Unlimited if set to -1.

To restrict the number of simultaneous FTP connections to 40:

plesk bin anonftp.exe --update example.com -status true -max-connects 40

-bandwidth <number>[B|K|M|G|T]

Restricts the download bandwidth.

Unlimited if set to -1.

Note:

Use this option only if the anonymous FTP service on the domain supports download restriction. For example, the MS FTP server doesn’t support this feature.

To restrict the download bandwidth to 1 MB:

plesk bin anonftp.exe --update example.com -status true -bandwidth 1M