Product Documentation


Jun 05, 2015
Updated: 2014-11-20

The MySQL web service is installed on all MySQL servers in your environment that you want to make available for provisioning MySQL databases to customers. You can install the MySQL web service using either the graphical interface of the Services Manager installer or through the command line. After the installation process finishes, you can enable the service and continue configuration through the control panel.

After you install the MySQL web service, you can configure the MySQL service using the Services Manager control panel.

For information about the requirements for deploying the MySQL service, refer to Plan to deploy the MySQL service.

To install the MySQL web service using the graphical interface

The installation process includes preliminary configuration to create the IIS application and define the service port.

This task assumes the Services Manager installer is running and the Select Deployment Task page is displayed.

  1. On the Select Deployment Task page, select Install CloudPortal Services Manager.
  2. On the Install CloudPortal Services Manager page, select Add Services.
  3. On the Add Services page, select Install Services.
  4. Accept the License Agreement and then click Next.
  5. On the Select Web Services page, select MySQL Web Service and then click Next.
  6. On the Review Prerequisites page, review the list of software that will be installed to support the web service and then click Next.
  7. On the Ready to Install page, review your selection and then click Install.
  8. After the installation finishes, click Finish.
  9. On the Installed Services page, click Configure next to the MySQL Web Service item. The Configuration Tool attempts to contact the Encryption Service to retrieve the encrypted key. If the service cannot be contacted, the Configuration Tool prompts you to import the encrypted key using a key file. To generate the key file, see Generate and export keyfiles for the Encryption Service.
  10. If required, import the Encryption Service key file:
    1. In Key File Path, click Browse and locate the key file you generated from the Encryption Service web site.
    2. In Password, enter the password that was specified when the key file was generated. Click Next.
  11. On the Configure IIS page, enter the port used by the MySQL web service. The default port is 8095. Click Next.
  12. On the Summary page, review the configuration information. If you want to change anything, return to the appropriate configuration page. When the summary contains the settings you want, click Next. The Configuration Tool configures the MySQL web service, imports the Encryption Service key, and displays progress.
  13. Click Finish and then click Exit to close the Configuration Tool.

To install the MySQL web service from the command line

  1. On the MySQL server, log on as an administrator.
  2. Open a command line window and navigate to the CortexSetup directory on the Services Manager installation media.
  3. At the command prompt, enter CortexSetupConsole.exe /Install:MySQL. The Setup Tool installs the web service and returns the command prompt.
  4. At the command prompt, enter install-locationServicesMySQLWSConfigurationMySQLConfigConsole.exe and specify the following properties:
    Property Description
    /ServicePort:port Inbound port to be used and added to the CortexServices web site. Default = 8095

    Install-location denotes the web service installation directory on the local computer. The default directory is C:Program Files (x86)CitrixCortex.

    The Configuration Tool performs initial configuration of the web service and returns the command prompt.

Sample command string

The following command performs the initial configuration of the web service.
install-locationServicesMySQLWSConfigurationMySQLConfigConsole.exe /ServicePort:8095

This web service does not require any additional properties to be passed for installation.

After installation is finished, you can configure the MySQL service. For instructions, see To configure the MySQL service.