Domain Aliases: domalias.exe

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.

>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 new domain alias example.com for domain example.net >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: >domalias.exe --update example.com -mail true or >domalias.exe -u example.com -mail true
`--delete` or `-d`	`<alias_name>`	Deletes a domain alias.	To delete domain alias example.com: >domalias.exe --delete example.com or >domalias.exe -d example.com
`--delete-all` or `-ra`	`<parent_domain>`	Deletes all domain aliases for specified domain.	To delete all domain aliases for domain example.net: >domalias.exe --delete-all example.net or >domalias.exe -da example.net
`--info` or `-i`	`<alias_name>`	Displays information about domain alias.	To view information about domain alias example.com: >domalias.exe --info example.com or >domalias.exe --i example.com
`--on`	`<alias_name>`	Enables a domain alias.	To enable domain alias example.com: >domalias.exe --on example.com
`--off`	`<alias_name>`	Disables a domain alias.	To disable domain alias example.com: >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: >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: >domalias.exe –help or >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: >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: >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: >domalias.exe -u example.com -web true
`-domain`	`<FQDN>`	Specifies the name of the domain for which domain alias is to be created. Required with `--create`.	To create a new domain alias example.com for domain example.net >domalias.exe --create example.com -domain example.net
`-status`	`enabled\|disabled`	Enables or disables domain alias.	To enable domain alias example.com: >domalias.exe -u example.com -status enabled