# ftpsubaccount: Additional FTP Accounts

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

- creating/deleting additional FTP accounts on subscriptions
- changing additional FTP account login credentials and home directory

## Usage

    ftpsubaccount <command> [<login_name>] [
    <option 1> <param> [<option 2> <param>] ... [<option N> <param>]
    ]

## Example

The following command creates an additional FTP account for the user j ohndoe on the subscription example.com, sets password userpass for the user, and specifies the `/httpdocs/about` directory as the default home directory for this account.

    # ./ftpsubaccount --create johndoe -domain example.com -passwd userpass -home /httpdocs/about

Note

The directory `/httpdocs/about` must be created before running the command, or the command will fail.

## 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 subscription example.com:
    plesk bin ftpsubaccount --create JohnDoe -passwd userpass -domain example.com
`--update` or `-u` | `<` `login_name` `>` | Updates configuration of the existing additional FTP account with data specified by the options. | To change the password of additional FTP account for user with the login name JohnDoe to newpass:
    plesk bin ftpsubaccount --update JohnDoe -passwd newpass
or
    plesk bin ftpsubaccount -u JohnDoe -passwd newpass
`--remove` or `-r` | `<` `login_name` `>` | Deletes an additional FTP account specified by login name. | To delete the additional FTP account for the user with the login name JohnDoe:
    plesk bin ftpsubaccount --remove JohnDoe
or
    plesk bin ftpsubaccount -r JohnDoe
`--info` or `-i` | `<` `login_name` `>` | Displays information about specified additional FTP account. | To view information about the additional FTP accounts for user with the login name JohnDoe:
    plesk bin ftpsubaccount --info JohnDoe
or
    plesk bin ftpsubaccount -i JohnDoe
`--help` or `-h` |  | Displays help on the use of the utility. | To view help on the use of this utility:
    plesk bin ftpsubaccount --help
or
    plesk bin ftpsubaccount -h

## Options

Option | Parameter | Description | Example
--- | --- | --- | ---
`-login` | `<` `login_name` `>` | Sets a login name for user of additional FTP account. | To change the login name of the additional FTP account user from JohnDoe to John:
    plesk bin ftpsubaccount -u JohnDoe -login John
`-passwd` | `<` `password` `>` | Sets a password for additional FTP account. | To change the password of the additional FTP account user JohnDoe to newpassword:
    plesk bin ftpsubaccount -u JohnDoe -passwd newpassword
`-passwd_type` | `plain|encrypted` | Defines password type. | To change the password of the additional FTP account user JohnDoe to qweqwe passed in encrypted form:
    plesk bin ftpsubaccount -u JohnDoe -passwd-type encrypted -passwd F.Fs3pYBcRRFQ
`-domain` | `<` `domain name` `>` | Specifies a subscription on which 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 subscription example.com:
    plesk bin ftpsubaccount --create JohnDoe -passwd userpass -domain example.com
`-home` | `<` `path` `>` | Sets a path to the home directory for additional FTP account. Is `/httpdocs` by default. | To set the home directory for the additional FTP account user JohnDoe to directory `/httpdocs/about`:
    plesk bin ftpsubaccount -u JohnDoe -home /httpdocs/about
The path is defined relative to the domain home directory path. The specified directory must exist.