Product Documentation

Hosted Apps and Desktops

Jun 05, 2015
Updated: 2014-11-20

The Hosted Apps and Desktops service for Services Manager delivers applications, desktops, and resources either directly from XenApp farms and XenDesktop sites, or from farms and sites that are managed by Citrix App Orchestration.

Deploying the Hosted Apps and Desktop service includes the following tasks:

You can install the web service on a XenApp or XenDesktop Controller or on an App Orchestration configuration server using the Services Manager Setup Tool or from the command line.

For more information about the requirements for deploying the service, review the information in Plan to deploy the Hosted Apps and Desktops service.

To install the Hosted Apps and Desktops web service using the graphical interface

The installation process includes preliminary configuration to create the web service account and IIS application pool, 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 one of the following options, depending on the product installed on the server, and then click Next:
    • If you are installing the web service on a XenApp server, select Hosted Apps and Desktop Web Service (XenApp).
    • If you are installing the web service on a XenDesktop server, select Hosted Apps and Desktops Web Service (XenDesktop).
    • If you are preparing an App Orchestration configuration server to work with the Hosted Apps and Desktops service through the control panel, select App Orchestration Configuration Tool.
  6. On the Review Prerequisites page, review the list of software that will be installed to support the component and then click Next. Setup will install any prerequisites that are not already present.
  7. On the Ready to Install page, review your selection and then click Install.
  8. After the installation finishes, click Finish.
  9. On the Add Services page, select Configure Services.
  10. On the Configure Installed Components page, click Configure next to the component you want to configure.
  11. To configure the XenApp or XenDesktop web services, on the Configure IIS page, enter the following information and then click Next:
    • Auto-generate credentials: Select this check box to allow service account credentials to be generated automatically.
    • User name: Enter a user name for the web service account. If you installed the web service on a XenApp server, the default user name is csm_xenapp_svc. If you installed the web service on a XenDesktop server, the default user name is csm_xendesktop_svc. This field is unavailable when you elect to auto-generate credentials.
    • Password: Enter a password for the web service account. This field is unavailable when you elect to auto-generate credentials.
    • Create if doesn't exist: Leave this check box selected to allow the web service account to be created if it does not already exist in Active Directory.
    • Service port: Enter the port used by the web service. The default port is 8095.
  12. To configure the App Orchestration Configuration Tool, perform the following actions:
    1. On the Specify Config Server page, enter the following information and then click Next:
      • Server address: Enter the FQDN of the App Orchestration configuration server if it is not already present. By default, the FQDN of the current server is displayed.
      • Connect as: Enter the username and password of the orchestration service account used to access the App Orchestration configuration server. By default, the username of the current logged-in user is displayed in DOMAINusername format.

      Click Test Connection to test communication with the App Orchestration configuration server.

    2. On the Create Service Account page, enter the following information and then click Next:
      • Username: Enter a user name for the self-service account for App Orchestration. The default user name is csm_haad_selfsvc. This account is added as an administrator to the App Orchestration deployment.
      • Password: Enter a password for the self-service account.
      • Create if doesn't exist: Leave this checkbox selected to allow the self-service account to be created if it does not already exist in Active Directory.
  13. 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 web service and displays progress.
  14. Click Finish and then click Exit to close the Configuration Tool.

To install the Hosted Apps and Desktops web service from the command line

  1. On the server where you are installing the web service, log on as an administrator.
  2. Open a command line window and navigate to the CortexSetup directory on the Services Manager installation media.
  3. To install the web service component, at the command prompt, enter CortexSetupConsole.exe /Install:component.
    Component Description
    CsmXenDesktopWS XenDesktop Web Service
    CsmXenAppWS XenApp Web Service
    CsmAppOrchestration App Orchestration Configuration Tool
    The Setup Tool installs the web service and returns the command prompt.
  4. To perform preliminary configuration, at the command prompt, enter install-locationServicescomponentConfigurationHostedAppsAndDesltopsConfigConsole.exe and specify the following properties:
    Property Description
    /UserName:ctx_svc_acct Valid only when installing the XenApp or XenDesktop component. Username for the web service account . This account must be a XenApp or XenDesktop administrator.
    /Password:password Valid only when installing the XenApp or XenDesktop component. Password for the web service account. This property is optional if /GenerateCredentials is specified.
    /SqlServer:server-address Required. Address of the server where the SQL Server database is deployed.
    /AutoCreateUser:True|False Valid only when installing the XenApp or XenDesktop component. Optional. Creates the service account in Active Directory, if required.
    /GenerateCredentials:True|False Valid only when installing the XenApp or XenDesktop component. Optional. Generates a password for the service account.
    /ServicePort:port Valid only when installing the XenApp or XenDesktop component. Optional. Inbound port to be used/added to the CortexServices web site. Default = 8095.
    /SqlUserName:user-name Optional. SQL Server login username.
    /SqlPassword:password Optional. SQL Server login password.
    /UseSqlAuthentication:True|False Optional. Enables or disables use of SQL authentication mode.

    Install-location is the 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 strings

The following commands install and initially configure of the XenDesktop component of the Hosted Apps and Desktops web service. The default port (8095) will be used.
CortexSetupConsole.exe /Install:CsmXenDesktopWS
install-locationServicesCsmXenDesktopWSConfiguration HostedAppsAndDesktopsConfigConsole.exe /UserName:ctx_svc_acct  /Password:password /SqlServer:server-address