Domain Alias Settings

This section describes settings that can be predefined for a domain alias. These settings can be set on creation of a domain alias, or they can be set for this domain alias later, or read from the database.

Domain alias settings are defined by the settings node and presented by type Settings (plesk_domainalias.xsd). It has the following graphics representation:

• The status node is optional. It specifies the current status of the domain alias. This node is used only in Plesk for Unix. Data type: byte. Allowed values:
  • 0 (alias enabled)
  • 1 (alias disabled)
  • 2 (primary domain disabled)
  • 3 (alias disabled, primary
    domain disabled)
• The pref node is optional. If specified, it defines the alias form. To specify the alias form, choose between the following options:

  (API RPC 1.4.2.0 and earlier versions)

  

  (API RPC 1.5.0.0 and later versions)

  

  • The web node is used when you want to redirect web content from a domain alias to your original domain. This node is required in API RPC v.1.4.2.0 (and earlier) and optional in API RPC v.1.5.0.0 (and later).
    Data type: boolean.
  • The mail node is used when you want to redirect mail from a domain alias to your original domain. This node is required in API RPC v.1.4.2.0 (and earlier) and optional in API RPC v.1.5.0.0 (and later)
    Data type: boolean.
  • The tomcat node is optional. It is used when you want to redirect Java applications from a domain alias to the Tomcat server on the primary domain (Tomcat server port 9080). Tomcat redirection is supported from the 1.4.2.0 version of API RPC. This node is used only in Plesk for Unix. Data type: boolean.
  • The full node is used when you want to create both web, mail and tomcat aliases. Data type: none.
• The manage-dns node is optional. It defines if you can manage DNS zone for the domain alias. This node is supported starting from API RPC v.1.5.0.0. Data type: boolean.

Note: Before performing any operations on domain alias settings, be sure to call operation get-supported-services retrieving from server information on which of them are operable.

AliasInfoType (plesk_domainalias.xsd) is an extension of the Settings type. It contains the following additional nodes:

• The domain_id node is required. It specifies the id of the primary domain. Data type: integer.
• The name node is required. It specifies the name (in Unicode) of the domain alias. Data type: string.
• The ascii_name node is optional. It specifies the name (in ASCII) of the domain alias. Data type: string.