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

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

image 34290

  • The status node is optional. It specifies the current status of the site alias. This node is used only in Plesk for Unix. Data type: byte. Allowed values:

    • 0 (alias enabled)
    • 1 (alias disabled)
    • 2 (primary site disabled)
    • 3 (alias disabled, primary site disabled)
    • 8 (alias disabled)

  • The pref node is optional. If specified, it defines the alias form. To specify the alias form, choose between the following options:

    image 72662

    • The web node is used when you want to redirect web content from a site alias to your original site. This node is optional. Data type: boolean.
    • The mail node is used when you want to redirect mail from a site alias to your original site. This node is optional. Data type: boolean.
    • The tomcat node is optional. It is used when you want to redirect Java applications from a site alias to the Tomcat server on the primary site (Tomcat server port 9080). This node is used only in Plesk for Linux. Data type: boolean.
    • The seo-redirect node is optional. It is used when you want to redirect visitors of the alias’s URL to the primary domain using the search engine friendly HTTP 301 redirection. Data type: boolean.

  • The manage-dns node is optional. It defines if you can manage DNS zone for the site alias. Data type: boolean.

Note: Before performing any operations on site 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:

image 73927

  • The site-id node is required. It specifies the ID of the primary site. Data type: integer.
  • The name node is required. It specifies the name (in Unicode) of the site alias. Data type: string.
  • The ascii-name node is optional. It specifies the name (in ASCII) of the site alias. Data type: string.

Note: When creating request packets, put nodes and elements in the order they follow in the packet structure.