Previous Topic

Next Topic

Book Contents

Managing Subdomains With Subdomain.exe Utility

Subdomain.exe utility allows you to manage subdomains. Using this utility, you can:

Subdomain.exe is located in %plesk_dir%admin\bin\. Available commands and options are listed in tables below.

Usage:
subdomain.exe command <subdomain> [options]

Example of usage:

subdomain.exe --create subdomain2 -domain domain1.com -hard_quota 50 -ssi true

Available commands:

Command

Parameter

Action

Example

--create or -c

<subdomain>

creates a subdomain for the domain specified with the -domain option

To create subdomain for Somewhere.com:

./subdomain.exe --create subdomain1 -domain somewhere.com

--update or -u

<subdomain>

updates an existing subdomain for the domain specified with the -domain option

Examples of updating various parameters of subdomain are provided further down this table

--remove or -r

<subdomain>

removes the subdomains specified with the -subdomains option from the domain, specified with the -domain option.

To remove subdomain1.somewhere.com from somewhere.com domain:

./subdomain.exe --remove subdomain1 -domain somewhere.com

--info or -i

 

retrieves information on all subdomains

To retrieve information on all subdomains of somewhere.com domain:

./subdomain.exe --info -domain somewhere.com

--help or -h

 

displays help on the utility usage

To see help file on the utility usage:

./subdomain.exe --help

Available options:

Option

Parameter

Note

Example

-domain or -d

<domain_name>

is used for specifying the main (parent) domain the subdomain will be created for

To create subdomain for Somewhere.com:

./subdomain.exe --create subdomain1 -domain somewhere.com

-new_name

<new_subdomain>

changes a subdomain name to the specified one (the option cannot be used when creating new subdomains)

To change the existing subdomain name subdomain1.somewhere.com to the new one - subdomain1_new.somewhere.com

./subdomain.exe --update subdomain1 -domain somewhere.com -new_name subdomain1_new

-ftp_user

<native|main>

uses a separate FTP user account for this subdomain (native) or the same FTP user as for the main domain (main). By default the FTP account of the main (parent) domain is used for managing the subdomain

To use separate FTP account for subdomain (subdomain1.somewhere.com):

./subdomain.exe --update subdomain1 -domain somewhere.com -ftp_user native

-login

<login>

FTP user login name (can be specified if a separate FTP account is used)

To enable user of separate FTP account to login to FTP:

./subdomain.exe --update subdomain1 -domain somewhere.com -ftp_user native -login johndoe

-passwd

<password>

FTP password (no password is set by default, and it may be specified when a separate FTP account is used)

To enable user of separate FTP account to login to FTP using password 'New Password':

./subdomain.exe --update subdomain1 -domain somewhere.com -ftp_user native -login johndoe -passwd 'New Password'

-passwd_type

<plain|crypt>

FTP user password type (default:plain)

 

To set encrypted password for johndoe user of subdomain1.somewhere.com subdomain:

./subdomain.exe --update subdomain1 -domain somewhere.com -ftp_user native -login johndoe -passwd 'New Password' -passwd_type crypt

-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.

To set hard disk quota of 10Mb for separate FTP account:

./subdomain.exe --update subdomain1 -domain somewhere.com -ftp_user native -hard_quota 10

-fp

<true|false>

Turns on/off FrontPage support on subdomain (default: false)

To enable FrontPage support for subdomain1.somewhere.com:

./subdomain.exe --update subdomain1 -domain somewhere.com -fp true

-fpauth

<true|false>

FrontPage authoring (default: false)

To enable FrontPage authoring for subdomain1.somewhere.com:

./subdomain.exe --update subdomain1 -domain somewhere.com -fpauth true

-ssi

<true|false>

SSI support on a subdomain (default: false)

To enable SSI support for subdomain1.somewhere.com:

./subdomain.exe --update subdomain1 -domain somewhere.com -ssi true

-ssi_html

<true|false>

SSI support for *.html, *.htm on a subdomain (default: false)

To enable SSI support for *.html and *.htm for subdomain1.somewhere.com:

./subdomain.exe --update subdomain1 -domain somewhere.com -ssi_html true

-php

<true|false>

PHP support on a subdomain (default: false)

To enable PHP support for subdomain1.somewhere.com:

./subdomain.exe --update subdomain1 -domain somewhere.com -php true

-php_isapi

<true|false>

Run PHP as ISAPI extention (default: false)

To enable PHP running as ISAPI extention for subdomain1.somewhere.com:

./subdomain.exe --update subdomain1 -domain somewhere.com -php_isapi true

-cgi

<true|false>

CGI support on a subdomain (default: false)

To enable CGI support for subdomain1.somewhere.com:

./subdomain.exe --update subdomain1 -domain somewhere.com -cgi true

-perl

<true|false>

PERL support on a subdomain (default: false)

To enable PERL support for subdomain1.somewhere.com:

./subdomain.exe --update subdomain1 -domain somewhere.com -perl true

-asp

<true|false>

ASP support on a subdomain (default: false)

To enable ASP support for subdomain1.somewhere.com:

./subdomain.exe --update subdomain1 -domain somewhere.com -asp true

-asp.net

<true|false>

ASP.NET support on a subdomain (default: false)

To enable ASP.NET support for subdomain1.somewhere.com:

./subdomain.exe --update subdomain1 -domain somewhere.com -asp.net true

-python

<true|false>

Python support on a subdomain (default: false)

To enable Python support for subdomain1.somewhere.com:

./subdomain.exe --update subdomain1 -domain somewhere.com -python true

-coldfusion

<true|false>

Coldfusion support on a subdomain (default: false)

To enable Coldfusion support for subdomain1.somewhere.com:

./subdomain.exe --update subdomain1 -domain somewhere.com -coldfusion true

-subdomains or -s

<subdomain[,...]>

used for specifying the subdomains to be removed or for retrieving subdomain information (the --remove and --info commands respectively). By default, the --info command outputs information on all existing subdomains.

To remove subdomain1.somewhere.com of somewhere.com domain:

./subdomain.exe --remove -subdomains subdomain1 -domain somewhere.com

To retrieve information on subdomain1.somewhere.com:

./subdomain.exe --info subdomain1 -domain somewhere.com

See Also

Creation Utilities

Configuring Server With Init_conf.exe Utility

Changing Control Panel Appearance With Server_pref.exe Utility

Managing IP Addresses With Ipmanage.exe Utility

Client Account Management With Client.exe and Client_pref.exe Utilities

Managing Domains With Domain.exe and Domain_pref.exe Utilities

Managing Web Users With Webuser.exe Utility

Managing Databases With Database.exe Utility

Managing Mail Accounts With Mail.exe Utility

Managing Mailing Lists With Maillist.exe Utility

Managing Spam Filtering With Spamassassin.exe Utility

Managing Web Protection For Domain Directories With Protdir.exe Utility

Managing Anonymous FTP Service With Anonftp.exe Utility