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 accounts on domains
changing additional FTP account login credentials, hard disk quota, home directory, and user permissions

Note: This utility and all its commands and options are available only for Plesk 8.1 and later.

Syntax

ftpsubaccount.exe <command> [

<option1> <param> [<option2> <param>]…[<option N> <param>]

]

Example

The following command line creates an additional FTP account for the user accountuser on 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 accountuser -domain example.com -passwd userpass -quota 50 -access_read true

Commands

Command	Parameter	Description	Example
`--create or -c *`	`<login_name>`	Creates additional FTP account Requires the use of the `-domain` and `-passwd` options.	To create an additional FTP account with login name accountuser and password userpass on domain example.com: >ftpsubaccount.exe --create accountuser -passwd userpass -domain example.com
`--update or -u`	`<login_name>`	Updates configuration of the existing additional FTP account with data specified in the options.	To change a password to newpassword for additional FTP account for user with login name accountuser: >ftpsubaccount.exe --update accountuser -passwd newpassword or >ftpsubaccount.exe -u accountuser -passwd newpassword
`--remove or -r`	`<login_name>`	Deletes an additional FTP account for the user with the specified login name	To delete the additional FTP account for user with login name accountuser: >ftpsubaccount.exe --remove accountuser or >ftpsubaccount.exe -r accountuser
`--info or -i`	`<login_name>`	Displays information about the specified additional FTP account.	To view information about the additional FTP account for user with login name accountuser: >ftpsubaccount.exe --info accountuser or >ftpsubaccount.exe -i accountuser
`--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 the login name for the user of the additional FTP account (the FTP account name parameter)	To change the login name for the additional FTP account user accountuser to newuser: >ftpsubaccount.exe -u accountuser -login newuser
`-passwd`	`<passwd>`	Sets the password for additional FTP account password	To change the password for the additional FTP account user accountuser to newpassword: >ftpsubaccount.exe -u accountuser -passwd newpassword
`-domain *`	`<domain_name>`	Specifies the domain on which the additional FTP account is to be created. Required with `--create`.	To create a additional FTP account with login name accountuser and password userpass on domain example.com: >ftpsubaccount.exe --create accountuser -passwd userpass -domain example.com
`-quota`	`<number>`	Sets the Hard disk quota parameter for an additional FTP account.	To set the hard disk quota for additional FTP account user accountuser to 50 MB: >ftpsubaccount.exe -u accountuser -quota 50 To set the hard disk quota for additional FTP account user accountuser to Unlimited: >ftpsubaccount.exe -u accountuser -quota 0 or >ftpsubaccount.exe -u accountuser -quota -1 (both 0 and a negative number are interpreted as unlimited)
`-home`	`<home_path>`	Sets the path to the home directory (Home directory) for an additional FTP account. Sets `/httpdocs` by default.	To set the home directory for additional FTP account user accountuser to an existing directory `/httpdocs`: >ftpsubaccount.exe -u accountuser -home /httpdocs The path is defined relative to the domain home directory path. The specified directory must exist.
`-access_read`	`true\|false`	Sets the Read permission parameter. `False` by default.	To set the Read permission for additional FTP account user accountuser: >ftpsubaccount.exe -u accountuser -access_read true
`-access_write`	`true\|false`	Sets the Write permission parameter. `False` by default.	To set the Write permission for the additional FTP account user accountuser: >ftpsubaccount.exe -u accountuser -access_read true