The creation utilities allow to create and manage client accounts, domains, hosting accounts, and manage domain preferences and services from the command line.
To manage client accounts, use the client.sh utility located in /usr/local/psa/bin/. The following commands and options can be used:
| Command | Parameter | Action |
|---|---|---|
| --create or -c | <login_name> | creates a new client account |
| --update or -u | <login_name> | updates client account |
| --remove or -r | <login_name> | removes client account |
| --info or -i | <login_name> | retrieves client information |
| --on | <login_name> | enables client account |
| --off | <login_name> | disables client account |
| --help or -h | displays the help on utility usage | |
| Option | Parameter | Note |
| -status | <true|false> | enables/disables client account (default: true) |
| -company | <string> | company name |
| -name | <string> | contact name (required for creation) |
| -login | <login_name> | control panel login name (may be used only with update command) |
| -passwd | <passwd> | control panel password (required for creation) |
| -phone | <number> | phone number |
| -fax | <number> | fax |
| <string> | e-mail address | |
| -addr | <string> | street |
| -city | <string> | city |
| -state | <string> | state/province |
| -pcode | <string> | postal/zip code |
| -country | <string> | country |
| -notify | <true|false> | enables|disables notifying of client account creation |
To edit client accounts, use the client_pref.sh utility located in /usr/local/psa/bin/. The following commands and options can be used:
| Command | Parameter | Action |
|---|---|---|
| --update or -u | login_name | updates an existing client account |
| --info or -i | login_name | retrieves client information |
| --help or -h | displays the help on utility usage | |
| Option | Parameter | Note |
| -create_domains | <true | false> | allows client to create domains |
| -manage_phosting | <true | false> | allows managing physical hosting |
| -change_limits | <true | false> | allows changing domain limits |
| -manage_dns | <true | false> | allows managing DNS |
| -manage_log | <true | false> | allows managing log rotation |
| -manage_crontab | <true | false> | allows managing Crontab (Scheduler) |
| -manage_anonftp | <true | false> | allows managing Anonymous FTP |
| -manage_webapps | <true | false> | allows managing Tomcat web applications |
| -manage_maillists | <true | false> | allows managing mailing lists |
| -manage_sh_access | <true | false> | allows managing system access |
| -manage_subdomains | <true | false> | allows managing subdomains |
| -manage_quota | <true | false> | allows changing hard disk quota |
| -make_dumps | <true | false> | allows the use of backup/restore functions |
| -max_dom | <number> | limits number of available domains (-1 is unlimited) |
| -disk_space | <number> | limits amount of available disk space to the specified value (in Megabytes) |
| -max_traffic | <number> | limits the amount of available traffic to the specified value (in Megabytes) |
| -max_box | <number> | limits the allowed number of mailboxes to the specified value |
| -mbox_quota | <number> | limits the mailbox quota to the specified size (in Kilobytes) |
| -max_redir | <number> | limits the number of mail redirects |
| -max_mg | <number> | limits the number of mail groups |
| -max_resp | <number> | limits the number of mail autoresponders |
| -max_wu | <number> | limits the number of web users |
| -max_db | <number> | limits the number of databases |
| -max_maillists | <number> | limits the number of mailing lists |
| -max_webapps | <number> | limits the number of Tomcat web applications allowed |
| -max_subdom | <number> | limits the number of subdomains |
| -expiration | <date> | limits the validity period of client account |
| -ip_pool | <add|del>:<ip1>,<ip2>,..,<ipN> | adds/deletes ip addresses to/from client's IP pool. |
The <number> tag means any positive (or zero) integer value. The <date> tag implies date in the following format: 'YYYY-MM-DD'.
You may use the '-1' value for "unlimited" when defining any limit applicable to a client account.
You may specify any number of -ip_pool options to achieve the desired results, for example: client_pref.sh -u 'c1' -ip_pool add:127.0.0.1,127.0.0.2 -ip_pool del:127.0.0.3
To manage domains, use the domain.sh utility located in /usr/local/psa/bin/. The following commands and options can be used:
| Command | Parameter | Action |
|---|---|---|
| --create or -c | <domain_name> | creates a new domain |
| --update or -u | <domain_name> | updates an existing domain |
| --remove or -r | <domain_name> | removes an existing domain |
| --info or -i | <domain_name> | retrieves domain information |
| --on | <domain_name> | enables domain |
| --off | <domain_name> | disables domain |
| --shells or -s | lists available shells | |
| --help or -h | displays help on utility usage | |
| Option | Parameter | Note |
| -status | <true|false> | turns domain on/off (default: true) |
| -dom_user | <true|false> | turns the domain level user account on/off (default: false) |
| -du_passwd | <passwd> | sets up password for domain level user |
| -dns | <true|false> | turns DNS zone for the domain on/off (by default DNS template status) |
| -www | <true|false> | adds www prefix (default: true) |
| -hosting | <true|false> | enables/disables hosting for the domain (default: false) |
| -hst_type | <phys|std|frm> | sets up the specified hosting type (default: physical) |
| -target_url | <URL> | sets up target URL (required if hst_type is "std" or "frm") |
| -ip | <ip_address> | ip address |
| -login | <login> | FTP user login name (required if hosting is physical) |
| -passwd_type | <plain|crypt> | FTP user password type (default: plain) |
| -passwd | <password> | FTP password (no password is set by default) |
| -shell | <shell_name|help> | system shell (you can use the --shells command to list available shells) |
| -hard_quota | <MB> | hard disk quota (0 is unlimited) |
| -fp | <true|false> | turns on/off FrontPage support on domain (default: false) |
| -fp_ssl | <true|false> | turns on/off frontpage over ssl support on domain (default: false) |
| -fpauth | <true|false> | FrontPage authoring (default: false) |
| -fplogin | <login> | FrontPage login name |
| -fppasswd | <password> | FrontPage password |
| -ssi | <true|false> | SSI support on domain (default: false) |
| -php | <true|false> | PHP support on domain (default: false) |
| -cgi | <true|false> | CGI support on domain (default: false) |
| -perl | <true|false> | Perl support on domain (default: false) |
| -asp | <true|false> | ASP support on domain (default: false) |
| -python | <true|false> | Python support on domain (default: false) |
| -coldfusion | <true|false> | ColdFusion support on domain (default: false) |
| -ssl | <true|false> | SSL support on domain (default: false) |
| -webstat | <true|false> | Webalizer support on domain (default: false) |
| -err_docs | <true|false> | custom error documents support on domain (default: false) |
| -log_rotate | <true|false> | log rotation status (default: true) |
| -log_bysize | <KB> | enables log rotation by size |
| -log_bytime | <daily|weekly|monthly> | enables log rotation by time (default: daily) |
| -log_max_num | <number> | defines maximum number of log file instances (default: 3) |
| -log_compress | <true|false> | enables log files compression (default: true) |
| -log_email | <email> | enables sending log files to e-mail |
| -clogin | <login> | login of existing client the domain will belong to (required for domain creation) |
| -mail_service | <true|false> | turns on/off the mail service for the domain (default: true) |
| -notify | <true|false> | enables|disables notifying of domain creation |
To manage domain level preferences, use the domain_pref.sh utility located in /usr/local/psa/bin/. The following commands and options can be used:
| Command | Parameter | Action |
|---|---|---|
| --update or -u | domain_name | sets domain preferences |
| --info or -i | domain_name | retrieves domain preferences information |
| --help or -h | displays the help on utility usage | |
| Option | Parameter | Note |
| -disk_space | <MB> | limits amount of available disk space |
| -max_traffic | <MB/Month> | limits the amount of traffic for a domain |
| -max_box | <number> | limits number of mailboxes |
| -mbox_quota | <KB> | limits mailbox quota |
| -max_redir | <number> | limits the number of mail redirects |
| -max_mg | <number> | limits number of mail groups |
| -max_resp | <number> | limits the number of mail autoresponders |
| -max_wu | <number> | limits the number of web users |
| -max_db | <number> | limits the number of databases |
| -max_maillists | <number> | limits the number of mailing lists |
| -max_webapps | <number> | limits the number of allowed web applications |
| -max_subdom | <number> | limits the number of subdomains |
| -expiration | <YYYY-MM-DD> | limits a validity period for the domain |
| -www | <true|false> | www prefix for the domain |
| -wuscripts | <true|false> | enables web users' scripting support |
| -webmail | <true|false> | allows use of webmail |
| -no_usr | <bounce:txt|email> | sets up bounce or catch-all for nonexisting user mail (obsolete and will be removed from future releases) |
| -keep_traf_stat | <number> | sets the system to retain traffic statistics for N months (specify 0 if you wish not to delete statistics) |
To manage mail accounts, use the mail.sh utility located in /usr/local/psa/bin. The following commands and options can be used:
| Command | Parameter | Action |
|---|---|---|
| --create or -c | <mail_name>@<domain> | creates mail account |
| --update or -u | <mail_name>@<domain> | updates mail account parameters |
| --remove or -r | <mail_name>@<domain> | removes mail account |
| --on | <domain> | enables mail service for domain |
| --off | <domain> | disables mail service for domain |
| --info or -i | <mail_name>@<domain> | retrieves mail account information |
| --help or -h | displays help on utility usage | |
| Option | Parameter | Note |
| -cp_access | <true|false> | enables control panel access |
| -mailbox | <true|false> | creates/removes mailbox |
| -passwd | <passwd> | sets mailbox password |
| -boxpass | <passwd> | obsolete alias for option "passwd" (this option may be removed from future releases) |
| -passwd_type | <plain|crypt> | specifies the type of mailbox password, ignored if no password specified |
| -mbox_quota | <KB> | limits the mailbox quota to the desired amount |
| -aliases | <add|del>:<name1[,name2]> | Adds or deletes mail alias(es) to/from mail name |
| -mgroups | <add|del>:<list1[,list2]> | adds or removes mail name to/from mail group |
| -redirect | <true|false> | switches mail redirect on/off |
| -rediraddr | <addr> | sets redirect to address (required if redirect is enabled) |
| -group | <true|false> | switches mail group on/off |
| -groupmem | <add|del>:<addr1[,addr2]> | adds/removes address(-es) to/from mail group |
| -repo | <add|del>:<file1[,file2]> | adds/removes file to/from attachments repository |
| -autorsp | <true|false> | switches all autoresponders on/off |
| -autoname | <name> | autoresponder name (required for all autoresponder options) |
| -autostatus | <true|false> | switches on/off autoresponder with specified name |
| -autoreq | <subj|body>:<string> or <always> | defines the condition for the autoresponder to be activated whether the specified pattern is encountered in the subject or body, or to respond always. |
| -autosubj | <original|string> | the subject line to be set up into autoresponder ("Re: <incoming subject>") or a custom string. |
| -auto_replyto | <string> | return address that will be set up into the autoresponder's messages |
| -autotext | <string> | autoresponder message text |
| -autoatch | <add|del>:<file1[,file2]> | adds/removes autoresponder attachment files |
| -autofrq | <number> | defines the maximum number of responses to a unique e-mail address per day |
| -autostor | <number> | defines the number of unique addresses to be stored for autoresponder |
| -autored | <addr> | defines the e-mail address to forward all incoming mail to |
| -drweb | <in|out|inout|off> | manages antivirus filtering |
For managing subdomains, use the subdomain.sh utility located in /usr/local/psa/bin. The following commands and options can be used:
| Command | Parameter | Action |
|---|---|---|
| --create or -c | <subdomain> | creates a subdomain for domain specified with -domain option |
| --update or -u | <subdomain> | updates an existing subdomain for domain specified with -domain option |
| --remove or -r | <subdomain> | removes subdomains specified with -subdomains option from the domain, specified with -domain option. |
| --info or -i | retrieves information on subdomains | |
| --help or -h | displays help on utility usage | |
| Option | Parameter | Note |
| -domain or -d | <domain_name> | use to specify the main (parent) domain for creating the subdomain for |
| -new_name | <new_subdomain> | change the subdomain name to the specified one (the option cannot be used when creating new subdomains) |
| -ftp_user | <native|main> | use a separate FTP user account for this subdomain (native) or the same FTP user as that of the main domain (main). By default the FTP account of the main (parent) domain is used for managing the subdomain |
| -login | <login> | FTP user login name (can be specified if separate FTP account is used) |
| -passwd | <password> | FTP password (no password is set by default, and it may be specified when separate FTP account is used) |
| -hard_quota | <MB> | hard disk quota (use 0 for тАЬunlimitedтАЭ, which is set by default). You can specify this option when using a separate FTP account. |
| -ssi | <true|false> | SSI support on subdomain (default: false) |
| -php | <true|false> | PHP support on subdomain (default: false) |
| -cgi | <true|false> | CGI support on subdomain (default: false) |
| -perl | <true|false> | Perl support on subdomain (default: false) |
| -asp | <true|false> | ASP support on subdomain (default: false) |
| -python | <true|false> | Python support on subdomain (default: false) |
| -coldfusion | <true|false> | ColdFusion support on subdomain (default: false) |
| -subdomains or -s | <subdomain[,...]> | use for specifying the subdomains to be removed or to retrieve subdomain information (--remove and --info commands respectively). By default, the --info command outputs information on all existing subdomains. |
For managing mailing lists, use the maillist.sh utility located in /usr/local/psa/bin. The following commands and options can be used:
| Command | Parameter | Action |
|---|---|---|
| --create or -c | <maillist> | creates a mailing list |
| --update or -u | <maillist> | updates mailing list properties |
| --remove or -r | <maillist> | removes mailing list |
| --info or -i | <maillist> | displays mailing list subscribers |
| --help or -h | displays help on utility usage | |
| Option | Parameter | Note |
| -domain or -d | <domain_name> | use to specify the main (parent) domain for creating the subdomain for |
| -passwd | <password> | Set mailing list administrator's password (may be specified only with the 'create' command) |
| <email> | Set mailing lists administrator's email (may be specified only with the 'create' command) | |
| -notify | <true|false> | Notify mailing list administrator about mailing list creation (default: true, may be specified only with the 'create' command) |
| -status | <true|false> | Turns mailing list on/off (default: true) |
| -members | <add|del>:<email1>,..,<emailN> | Adds/deletes email addresses to/from mailing list |
For managing databases, use the database.sh utility located in /usr/local/psa/bin. The following commands and options can be used:
| Command | Parameter | Action |
|---|---|---|
| --create or -c | <db_name> | creates a database |
| --update or -u | <db_name> | updates database: add, edit, remove db user |
| --remove or -r | <db_name> | deletes database |
| --help or -h | displays help on utility usage | |
| Option | Parameter | Note |
| -domain | <domain_name> | domain name |
| -type | <mysql> | Type of database |
| -passwd | <passwd> | Set user password |
| -add_user | <login_name> | Add user with given name |
| -update_user | <login_name> | Update user with given name |
| -remove_user | <login_name> | Remove user with given name |
| -user_name | <login_name> | Set login name (may be specified with "update_user" option) |