domalias.exe: Domain Aliases

The domalias.exe utility is designed to manage domain aliases. The utility allows the following operations:

  • creating and deleting domain aliases
  • viewing information about domain aliases
  • enabling and disabling Web and mail services on domain aliases
Location

%plesk_cli%

 

Usage
domalias.exe <command> [<param>] [
<option 1> <param> [<option 2> <param>] ... [<option N> <param>]
]

 

Example

The following command creates domain alias example.com for domain example.net, sets the status of the domain alias to that of the parent domain example.net, and enables mail service on the domain alias.

plesk bin domalias.exe --create example.com -domain example.net -status parent -mail true

 

Commands
Command Parameter Description Example

--create or -c

<alias_name>

Creates a new domain alias.

Requires -domain option.

To create a domain alias example.com for domain example.net

plesk bin domalias.exe --create example.com -domain example.net

--update or -u

<alias_name>

Updates configuration of an existing domain alias with the data specified in the options.

To enable mail service on domain alias example.com:

plesk bin domalias.exe --update example.com -mail true

or

plesk bin domalias.exe -u example.com -mail true

--delete or -d

<alias_name>

Deletes a domain alias.

To delete domain alias example.com:

plesk bin domalias.exe --delete example.com

or

plesk bin domalias.exe -d example.com

--delete-all or -da

<parent_domain>

Deletes all domain aliases for specified domain.

To delete all domain aliases for domain example.net:

plesk bin domalias.exe --delete-all example.net

or

plesk bin domalias.exe -da example.net

--info or -i

<alias_name>

Displays information about domain alias.

To view information about domain alias example.com:

plesk bin domalias.exe --info example.com

or

plesk bin domalias.exe --i example.com

--on

<alias_name>

Enables a domain alias.

To enable domain alias example.com:

plesk bin domalias.exe --on example.com

--off

<alias_name>

Disables a domain alias.

To disable domain alias example.com:

plesk bin domalias.exe --off example.com

--rename

<alias_name>

Renames a domain alias.

Requires new-name option.

To change the name of domain alias example.com to example.org:

plesk bin domalias.exe --rename example.com -new-name example.org

--help or -h

 

Displays help on the use of the utility

To view help on the use of this utility:

plesk bin domalias.exe -help

or

plesk bin domalias.exe -h

 

Options
Option Parameter Description Example

-new-name

<FQDN>

Sets a new name for an existing domain alias.

Required with --rename.

To change the name of domain alias example.com to example.org:

plesk bin domalias.exe --rename example.com -new-name example.org

-mail

true|false

Enables or disables mail service on the domain alias.

To enable mail service on domain alias example.com:

plesk bin domalias.exe -u example.com -mail true

-web

true|false

Enables or disables web service on the domain alias.

To enable Web service on domain alias example.com:

plesk bin domalias.exe -u example.com -web true

-dns

true|false

Enables/Disables DNS zone on a domain alias.

To enable the DNS zone on the domain alias example.net:

plesk bin domalias.exe -u example.net -dns true

-domain

<FQDN>

Specifies the name of the domain for which domain alias is to be created.

Required with --create.

To create a domain alias example.com for domain example.net

plesk bin domalias.exe --create example.com -domain example.net

-status

enabled|disabled

Enables or disables domain alias.

To enable domain alias example.com:

plesk bin domalias.exe -u example.com -status enabled

-tomcat

true|false

Enables/Disables the Tomcat service on a domain alias.

Is false by default.

To enable the Tomcat service on the domain alias example.net:

plesk bin domalias.exe -u example.net -tomcat true

-seo-redirect

non-www|www|none

Turns on the search engine friendly HTTP 301 redirection. Use 'non-www' to redirect from www.domain to domain, 'www' to redirect from domain to www.domain, and 'none' to turn off the redirection (default: non-www).

To turn on redirection for the domain alias example-alias.com to www.example.com:

plesk bin domalias.exe -u example-alias.com -seo-redirect www

 

To turn on redirection for the domain alias example-alias.com to example.com:

plesk bin domalias.exe -u example-alias.com -seo-redirect non-www

-icp-status

true|false

Enables or disables the "ICP approved" status for the domain alias.

To enable the "ICP approved" status for the domain alias example-alias.com and assign the ICP permit with the ID "?ICP?12345678?" to it:

plesk bin domalias.exe -u example-alias.com -icp-status true -icp-permit "?ICP?12345678?"

-icp-permit

<ICP permit ID>

Specifies the ICP permit ID for the domain alias.

 

 

Leave your feedback on this topic here

If you have questions or need support, please visit the Plesk forum or contact your hosting provider.
The comments below are for feedback on the documentation only. No timely answers or help will be provided.