Additional FTP Accounts: ftpsubaccount.exe

The ftpsubaccount.exe utility is designed to manage additional FTP accounts. The utility allows the following operations:

creating/deleting additional FTP account on domain
changing additional FTP account login credentials, hard disk quota, home directory, and user permissions

Location

%plesk_cli%

Usage

ftpsubaccount.exe <command> [<login_name>] [

<option 1> <param> [<option 2> <param>] … [<option N> <param>]

Example

The following command creates an additional FTP account for the user JohnDoe on the domain example.com, sets password userpass for the user, sets the hard disk quota for the additional FTP account to 50 MB, specifies the /httpdocs/ directory as the default home directory for the additional FTP account, and sets the Read permission for the user.

>ftpsubaccount.exe --create JohnDoe -domain example.com -passwd userpass -quota 50 -access_read true

Commands

Command	Parameter	Description	Example
`--create` or `-c`	`<login_name>`	Creates the additional FTP account. Requires `-domain` and `-passwd` options.	To create an additional FTP account with login name JohnDoe and password userpass on the domain example.com: >ftpsubaccount.exe --create JohnDoe -passwd userpass -domain example.com
`--update` or `-u`	`<login_name>`	Updates a configuration of the existing additional FTP account with data specified in the options.	To change the password of additional FTP account for user with the login name JohnDoe to newpass: >ftpsubaccount.exe --update JohnDoe -passwd newpass or >ftpsubaccount.exe -u JohnDoe -passwd newpass
`--remove` or `-r`	`<login_name>`	Deletes an additional FTP account for a user with a specified login name.	To delete the additional FTP account for the user with the login name JohnDoe: >ftpsubaccount.exe --remove JohnDoe or >ftpsubaccount.exe -r JohnDoe
`--info` or `-i`	`<login_name>`	Displays information about a specified additional FTP account.	To view information about the additional FTP account for user with the login name JohnDoe: >ftpsubaccount.exe --info JohnDoe or >ftpsubaccount.exe -i JohnDoe
`--help` or `–h`		Displays help on the use of the utility.	To view help on the use of this utility: >ftpsubaccount.exe --help or >ftpsubaccount.exe -h

Options

Option	Parameter	Description	Example
`-login`	`<login_name>`	Sets a login name for a user of an additional FTP account.	To change the login name of the additional FTP account user from JohnDoe to John: >ftpsubaccount.exe -u JohnDoe -login John
`-passwd`	`<password>`	Sets a password for an additional FTP account.	To change the password of the additional FTP account user JohnDoe to newpassword: >ftpsubaccount.exe -u JohnDoe -passwd newpassword
`-domain`	`<domain name>`	Specifies a domain on which an additional FTP account is to be created. Required with `--create`.	To create the additional FTP account with the login name JohnDoe and password userpass on the domain example.com: >ftpsubaccount.exe --create JohnDoe -passwd userpass -domain example.com
`-quota`	`<MB>`	Limits the amount of available disk space for an additional FTP account. Unlimited if set to `0` or a negative number.	To restrict the hard disk quota for the additional FTP account user JohnDoe to 50 MB: >ftpsubaccount.exe -u JohnDoe -quota 50 To set the hard disk quota for the additional FTP account user JohnDoe to unlimited: >ftpsubaccount.exe -u JohnDoe -quota 0 or >ftpsubaccount.exe -u JohnDoe -quota -1
`-home`	`<home_path>`	Sets a path to the home directory for an additional FTP account. Is `/httpdocs` by default.	To set the home directory for the additional FTP account user JohnDoe to the existing directory `/httpdocs`: >ftpsubaccount.exe -u JohnDoe -home /httpdocs The path is defined relative to the domain home directory path. The specified directory must exist.
`-access_read`	`true\|false`	Allows/Prohibits viewing the content of the home directory and download files from it. Is `false` by default.	To give read permission for the additional FTP account user JohnDoe: >ftpsubaccount.exe -u JohnDoe -access_read true
`-access_write`	`true\|false`	Allows/Prohibits creating, viewing, renaming and deleting directories in the home directory. Is `false` by default.	To give write permission for the additional FTP account user JohnDoe: >ftpsubaccount.exe -u JohnDoe -access_read true