You are on page 1of 44

Install and Configure

2011 Citrix Systems, Inc. All rights reserved. Terms of Use | Trademarks | Privacy Statement

Contents

Install and Configure Install and Configure Preparing to Install and Configure XenApp Before Installing XenApp Before Configuring XenApp Installing XenApp Using the Wizard-Based Server Role Manager Installing XenApp from the Command Line Configuring XenApp Server Role License Information Configuring XenApp Using the Wizard-based Server Configuration Tool Configuring XenApp from the Command Line Configuration Command Syntax Preparing for XenApp Imaging and Provisioning Removing Roles and Components Data Store Database Reference Microsoft SQL Server Database Oracle Database

3 5 6 7 9 11 13 16 18 22 24 30 35 38 39 42

Installing and Configuring XenApp


XenApp installation and configuration are separate tasks. This task division provides flexibility when using provisioning tools and disk imaging.
q

For a wizard-based XenApp installation or configuration, use the XenApp Server Role Manager. From the command line, use the XenAppSetupConsole.exe command to install the XenApp server role and the XenAppConfigConsole.exe command to configure the XenApp server role.

XenApp uses roles for XenApp features and related technologies. The wizard-based XenApp Server Role Manager uses the Server Role Installer to help you add certain XenApp roles. It detects the deployment phase for each role and displays the next task required to complete the installation and configuration of that role. From the XenApp Server Role Manager, you can:
q

Install role prerequisites Install fully-integrated server roles (such as XenApp, Citrix licensing, Single sign-on service, and Provisioning Server) Launch installers for partially-integrated roles (such as Power and Capacity Management Administration, SmartAuditor Server, EdgeSight Server) Launch the Citrix License Configuration Tool to configure the XenApp role license parameters (mode, server, and port) Launch the XenApp Server Configuration Tool to configure the XenApp server role Launch configuration tools for other roles Initiate a XenApp server restart (reboot) Remove a server from a farm Prepare a server for imaging and provisioning Remove fully-integrated XenApp 6.5 roles and components Upgrade roles (other than the XenApp server role) in XenApp 6 deployments

For command-line installation or configuration, enter the command with valid options and properties at a Windows Server command prompt.

Install and Configure

Accessing the Server Role Manager


The XenApp Server Role Manager runs initially from the XenApp installation media. After you install a role, the Server Role Manager is installed locally and runs every time you log on to the XenApp server (you can disable this feature by selecting a checkbox on the main Server Role Manager page). You can also run the Server Role Manager from Start > All Programs > Administrative Tools > Citrix > XenApp Server Role Manager, or from its Program Files location (Program Files (x86)\Citrix\XenApp\ServerRoleManager\XenAppServerRoleManager). If a Server Role Manager is installed locally and you invoke a different one from the XenApp installation media, the version on the installation media is used.

Using the XenApp Media to Install and Upgrade


Citrix recommends using the XenApp 6.5 media to perform a clean install of the XenApp server role on a Windows Server 2008 R2 or Windows Server 2008 R2 SP1 server. Clean install means that there is no previous version of the XenApp server role installed on the server. If you have an earlier XenApp version installed (including an early release or Technical Preview version), reimage the server before installing the XenApp 6.5 server role. If you cannot coordinate that recommended process, Citrix provides a XenApp 6.0 to 6.5 Upgrade Utility that you can customize for your servers; see CTX130614. After you install and configure XenApp 6.5, you can migrate settings from a server running a XenApp 5 or XenApp 6.0 to the new XenApp 6.5 farm. For details, see XenApp Migration Center. You can also remove a XenApp server role that was installed using the XenApp 6.5 media; however, you cannot use this functionality to remove an earlier version of the XenApp server role. If you run the Server Role Manager from the XenApp 6.5 media on a XenApp 6.0 server, new software may be available for installed roles and components other than the XenApp server role. In these cases, the Server Role Manager will display Upgrade next to the role or component; clicking that link starts the upgrade process. Important: Do not attempt to upgrade components and features in a XenApp 6.0 deployment using MSIs from the XenApp 6.5 media, unless explicitly instructed to do so.

Preparing to Install and Configure XenApp


Review Known Issues for late-breaking information. You must be in the Administrators group to install and configure the XenApp software. (Elevating your privilege to local administrator through User Account Control is not a substitute for Administrators group membership.) Important:
q

Do not install XenApp on a domain controller. Citrix does not support installing XenApp on a domain controller. Do not join servers running this version of XenApp to a deployment with servers running previous versions of XenApp. You must use the AppCenter from the 6.5 media to manage the XenApp 6.5 farm. Citrix does not support using a console from a previous XenApp release.

To ensure availability of the features and functionality of XenApp to your users, install the most recent version of receivers, plug-ins, and agents you use. When installing roles or role components other than XenApp server, see the role documentation for details about information you must provide during installation and configuration. For items to consider and tasks to complete before installing or configuring XenApp, see:
q

Before Installing XenApp Before Configuring XenApp

Preparing to Install and Configure XenApp


Review Known Issues for late-breaking information. You must be in the Administrators group to install and configure the XenApp software. (Elevating your privilege to local administrator through User Account Control is not a substitute for Administrators group membership.) Important:
q

Do not install XenApp on a domain controller. Citrix does not support installing XenApp on a domain controller. Do not join servers running this version of XenApp to a deployment with servers running previous versions of XenApp. You must use the AppCenter from the 6.5 media to manage the XenApp 6.5 farm. Citrix does not support using a console from a previous XenApp release.

To ensure availability of the features and functionality of XenApp to your users, install the most recent version of receivers, plug-ins, and agents you use. When installing roles or role components other than XenApp server, see the role documentation for details about information you must provide during installation and configuration. For items to consider and tasks to complete before installing or configuring XenApp, see:
q

Before Installing XenApp Before Configuring XenApp

Before Installing XenApp


q

Review the installation topics (wizard-based or command-line) to learn what information you must provide. Review the XenApp System Requirements and the system requirements for other roles you plan to install.
q

In most cases, wizard-based XenApp installations include automatic installation of prerequisite software and required Windows roles.

For command-line XenApp installations, you must install the prerequisite software and Windows roles before installing XenApp. You can deploy prerequisites with PowerShell cmdlets, the Microsoft ServerManagerCmd.exe command, or the Microsoft Deployment Image Servicing and Management (DISM) tool. Deploying prerequisites may require a server restart before you can install the XenApp server role.
q q

Ensure there is no other instance of the XenApp server role installed on the server. Ensure the server has the latest Microsoft hotfixes and that the operating system clock has the correct time. Prepare for Windows Multilingual User Interface (MUI) support, if needed. Before installing XenApp, install the target Windows Language Pack on the server, and change language options (such as system locale and display language) to the target language. For more information, see the Microsoft documentation. (Changing the Windows system locale after installing and configuring the XenApp server role may cause data store issues.)

Citrix XML and IIS Integration


When you install the XenApp role, XML and IIS integration is an optional component.
q

When this component is installed, the Citrix XML Service and IIS share a port (default = 80). You cannot change the Citrix XML port during XenApp configuration. When this component is not installed, the Citrix XML Service defaults to standalone mode with its own port settings, which you can change during XenApp configuration. You must configure a nondefault port only if you do not integrate with IIS and if IIS (or any other software) is using port 80.

The Server Role Installer checks if certain IIS role services are installed on the server, as well as options you specify.
q

In a wizard-based installation, installing the integration XML and IIS integration component is controlled through a checkbox.

Before Installing XenApp


q

In a command-line installation, installing the component is controlled through the /install:XA_IISIntegration and /exclude:XA_IISIntegration options, and their smart defaults. Citrix recommends you use these options to help prevent potential confusion in the future when the presence of IIS role services on the server or image may be unknown.

The following table describes the possible combinations, results, and defaults. For a list of IIS role services, see XenApp System Requirements. IIS role services installed? Yes Wizard-based install Command-line install

Select the XML IIS Integration component checkbox (default). The component is installed. Clear the XML IIS Integration component checkbox. The component is not installed. -

Specify the /install:XA_IISIntegration option. The component is installed. This is the recommended configuration. Do not specify the /install:XA_IISIntegration option. The component is installed (default). Specify the /exclude:XA_IISIntegration option. The component is not installed. Do not specify the /install:XA_IISIntegration option. The component is not installed.

Yes

Yes

No

Do not select the XML IIS Integration component checkbox (default). The component is not installed

Select the XML IIS Integration Specify the /install:XA_IISIntegration component checkbox. The option. The Server Role Installer Server Role Installer installs the installs the IIS role services and the IIS role services and the component. component. When the XML and IIS integration component is installed and the XML Service Policy is disabled, XenApp uses the installed integration component defaults. If the XML Service policy is enabled and contains a different port number setting, unexpected results may occur.

No

Before Configuring XenApp


q

Review the configuration topics (wizard-based or command-line) to learn what information you must provide. During configuration, you specify the database to be used for the XenApp farm data store: Microsoft SQL Server Express, Microsoft SQL Server, or Oracle. See CTX114501 for supported versions. Additional information is available at Data Store Database Reference.
q

If you use a Microsoft SQL Server Express database, XenApp configuration installs it automatically.

If you use a Microsoft SQL Server or Oracle database, install and configure the database before configuring XenApp. For an Oracle database, ensure that you also install an Oracle client on the XenApp server and restart the server. If you use a Microsoft SQL Server or Oracle database for the farm data store, and use command-line XenApp configuration, create a Data Source Name (DSN) file before configuring XenApp. (A wizard-based configuration creates the DSN file for you.) Each server in the farm must have the DSN file. You can create the file and copy it to other servers, or put it on a network share, provided you remove the value for any workstation-specific information (such as the Oracle WSID). Use the /DsnFile:dsn_file option to specify the file location on the XenApp configuration command line.
q

If you are using a custom DSN file, the file must have write permission for the Network Service.
q

If you plan to use the Configuration Logging feature and encrypt the data being logged, you must load the encryption key on servers that join the farm after configuring XenApp but before restarting the server.

XenApp Server Mode


All XenApp servers can host sessions. The XenApp server mode specifies whether the server can only host sessions (session-host only mode, also called session-only) or if it can also perform the controller functions of being elected a data collector and hosting the XML broker (controller and session-host mode, also called controller). While configuring servers as session-only can improve performance (particularly in large farms with multiple zones), ensure you have sufficient servers configured in controller mode that can serve as backup data collectors for your zones.
q

A XenApp server configured in controller mode monitors other controller servers in the XenApp farm and triggers data collector elections when necessary. The Citrix XML Service must run on a server configured in controller mode. Application enumeration and resolution are invoked only on servers configured in controller mode.

Before Configuring XenApp


q

The AppCenter can discover and connect only to servers configured in controller mode. Every zone and every farm must have at least one server configured in controller mode. If you plan to migrate an earlier XenApp version to XenApp 6.5, the migration operation must be run on a XenApp 6.5 server configured in controller mode.

When you create a XenApp farm, the XenApp Server Configuration Tool automatically configures the server in controller mode; you cannot configure session-only on the first server in a XenApp farm. This ensures that the XenApp farm has at least one data collector. When you configure another server to join that farm, you can choose the mode. By default, a server joins the farm in controller mode. (In earlier XenApp versions, server mode was not configurable; all XenApp servers operated in controller mode.) The following table shows how to specify the server mode during XenApp configuration. Server can host sessions, and be a data collector and XML broker (default) Select Enable Controller and Session-host modes Server can host sessions, but cannot be a data collector or XML broker Select Enable Session-host mode only

Wizard-based configuration

Command-line Specify Specify configuration /ImaWorkerMode:False /ImaWorkerMode:True To change the configured server mode, you must leave and then rejoin the XenApp farm, specifying the desired mode.

10

Installing XenApp Using the Wizard-Based Server Role Manager


To install XenApp using the wizard-based Server Role Manager: 1. On the installation media, double-click autorun.exe. The Autorun menu launches. 2. Select Install XenApp Server. The Server Role Manager launches and checks if any roles are already installed. 3. Select Add server roles. If you already installed roles other than XenApp, select Add or remove server roles, then select Add server roles. 4. Select your XenApp edition. 5. Accept the End User License Agreement. 6. Select the roles you want to add. (The Server Role Manager displays only the roles supported in the XenApp edition you selected. Some roles may require current Citrix Subscription Advantage membership.) 7. Select role components. Roles may have default and optional components.
q

When you select a role, its default components are selected automatically. The XenApp role has the following default components:
q

XenApp Management, which includes the Citrix AppCenter.

Windows Desktop Experience Integration, which configures a XenApp server to deliver remote desktops containing Windows 7 features and Microsoft applications. For more information, see Delivering XenApp to Software Services Subscribers. If you do not want to install a default component, clear its checkbox.
q q

For information about the XML Service IIS Integration optional component, see Citrix XML and IIS Integration. If IIS role services are installed on the server, this optional component is selected by default. If you plan to use role agents/plug-ins on this server (EdgeSight Agent, SmartAuditor Agent, Single Sign-on Plug-in, Power and Capacity Management Agent, or Provisioning Services Target Device), install them at the same time you install the XenApp server role. Otherwise, install these components from the packages on the XenApp media. The Citrix Receiver for Windows (formerly the online plug-in) and the Citrix Offline Plug-in are installed automatically when you install the XenApp role. These items do not appear in the components lists, and you cannot disable these installations.

11

Installing XenApp Using the Wizard-Based Server Role Manager 8. Review the prerequisites summary, which indicates which role or component needs the prerequisite, and whether the Server Role Installer installs it or you must install it. For software you must install, the display indicates whether the XenApp installation media contains the software or you must obtain it elsewhere. 9. Review the summary, which lists the selected roles and components to be installed or prepared. It also lists prerequisites which will be automatically deployed for all selected roles. After you click Install, a display indicates installation progress and the result. Important: When installing the XenApp role, the IMA Service is not started, nor are any configuration options set, such as creating or joining a farm and data store database information. After the installation result displays and you click Finish, the Server Role Manager task list displays. For each role you selected, the task list indicates the next task necessary for installation or configuration.
q

If you have not configured the license parameters for the XenApp role, click Specify Licensing, which launches the Licensing Configuration Tool. Run the Licensing Configuration Tool before configuring the XenApp server role. For installed fully integrated roles that require configuration, click Configure to launch the configuration tool for that role. For partially integrated roles, click Install to launch the installer for that role. See the role documentation for details.

12

Installing XenApp from the Command Line


Command Syntax
On the server where you want to install XenApp or other roles, from the "XenApp Server Setup\bin\" directory on the XenApp media, type the following at a command prompt: XenAppSetupConsole.exe options_properties The following table describes installation command options. Installation options and properties /help Displays command help. /logfile:path Path for the log file generated during the installation. Default = c:\Windows\Temp

13

Installing XenApp from the Command Line /install:items Comma-delimited list of roles, components, features, or technologies to install. Valid values are:
q

EdgeSightServer. EdgeSight Server. Licensing. Citrix Licensing Server. PCMAdmin. Power and Capacity Management administration components. Provisioning. Provisioning Services. SecureGateway. Secure Gateway. SmartAuditorServer. SmartAuditor server. SsonService. Single sign-on service. ReceiverStorefront. Receiver Storefront. WebInterface. Web Interface. XenApp. XenApp server. If you specify XenApp, the Server Role Manager automatically installs the Citrix AppCenter, Citrix Receiver for Windows (formerly online plug-in), Citrix Offline Plug-in, and Windows Desktop Experience Integration feature (for more information, see Delivering XenApp to Software Services Subscribers). You can also specify one or more of the following optional components to install, separated by commas. Except as noted, if you do not specify the following optional components, they are not installed.
q

XA_IISIntegration. IIS and XML Service integration. For more information, see Citrix XML and IIS Integration. If IIS role services are installed on the server, this component is installed regardless of whether you specify it on the command line, unless you use the /exclude option to exclude it. EdgeSightAgentFeature. EdgeSight Agent. SmartAuditorAgentFeature. SmartAuditor Agent. SSONAgentFeature. Single Sign-on Plug-in. PCMAgentFeature. Power and Capacity Management Agent. PVDeviceFeature. Provisioning Services Target Device.

14

Installing XenApp from the Command Line /exclude:items (Valid only when installing the XenApp server role) Comma-separated list of components to be omitted from the installation. Valid values are:
q

XA_Console. Excludes installation of the AppCenter. XA_IISIntegration. Excludes installation of the XML IIS Integration component. For more information, see Citrix XML and IIS Integration.

XenAppEnhancedDesktopExperience. Excludes installation of the Windows Desktop Experience Integration feature. You cannot exclude the installation of the Receiver for Windows or the Offline Plug-in.
q

/edition Specifies the XenApp edition. Valid values are:


q

Platinum (default) Enterprise Advanced

INSTALLDIR=directory Specifies where to install the items. Default: C:\Program Files\Citrix ONLINE_PLUGIN_INSTALLDIR=directory Specifies where to install the Citrix Receiver for Windows. Default: C:\Program Files\Citrix\ICA Client

Examples
The following command installs the XenApp server Platinum Edition in its default location. XenAppSetupConsole.exe /install:XenApp /Platinum The following command installs the XenApp server Platinum edition and the Receiver Storefront in C:\Program Files\Citrix (which is the default location). XenAppSetupConsole.exe /install:XenApp,ReceiverStorefront INSTALLDIR=C:\Program Files\Citrix The following command installs the XenApp server Platinum Edition and the Single Sign-on Plug-in, and excludes installation of the AppCenter. XenAppSetupConsole.exe /install:XenApp,SSONAgentFeature /exclude:XA_Console

15

Configuring XenApp Server Role License Information


XenApp server role license information must be specified before a XenApp server can accept connections.
q

From the Server Role Manager, use the wizard-based Licensing Configuration Tool after installing the XenApp server role. From the command line, include license server information in the XenApp server role configuration command (XenAppConfigConsole.exe).

See Licensing Your Product for complete Citrix licensing information.

Configuring XenApp License Information using the Wizard-based Licensing Configuration Tool
If you are using the Server Role Manager, launch the Licensing Configuration Tool before configuring the XenApp role. 1. After installing the XenApp role, access the XenApp Server Role Manager. 2. Click Specify licensing. The Licensing Configuration Tool launches. 3. On the Enter License Server Information page, select one of the following:
q

Connect to existing license server. Specify the case-sensitive license server name. If you do not change the license server port value, the default value 27000 is used. Click Test Connection to verify that the specified license server is running and using a compatible software version, and to check if the license server has any licenses.

q Configure later via a policy. 4. On the Select Licensing Model page, you can select a licensing model option or defer the selection to a later time.

If you clicked Test Connection on the previous page, recommendations are noted on the Select Licensing Model page, based on licenses found on the license server. Important: Select the licensing model best suited to your planned deployment, which may differ from the recommendation, which is based on the licenses currently on the license server.
q

XenApp. Select this model if you plan to use only XenApp licenses. This option is recommended if the Test Connection operation discovered no licenses, only XenApp licenses, or a mixture of unique XenApp and XenDesktop licenses on the license

16

Configuring XenApp Server Role License Information server.


q

XenDesktop concurrent system. Select this model if you plan to use XenDesktop concurrent user licenses. This option is recommended if the Test Connection operation discovered only XenDesktop concurrent licenses on the license server. XenDesktop user/device. Select this model if you plan to use XenDesktop user or device licenses. This option is recommended if the Test Connection operation discovered XenDesktop user/device licenses or both XenDesktop user/device and XenDesktop concurrent licenses.

To change license server and licensing model information later, click Edit Licensing in the XenApp Server Role Manager.

Configuring XenApp License Information from the Command Line


From the command line, you can configure XenApp license information when you configure the XenApp server role with the XenAppConfigConsole.exe command. Use the /LicenseServerName, /LicenseServerPort, and /LicenseModel options. For more information, see License server options.

17

Configuring XenApp Using the Wizard-based Server Configuration Tool


To configure XenApp using the wizard-based XenApp Server Configuration Tool: 1. Access the Server Role Manager. 2. Click Configure under XenApp. The Server Configuration Tool launches. 3. Select the task to perform.
q

Create. After you install XenApp on the first server, that server is where you create a new farm during configuration. Join. After you install XenApp on other servers, you add each server to (join) an existing farm. Prepare this server for imaging and provisioning. (Valid only if the XenApp server role was previously configured) Prepares the server for imaging.

Leave. (Valid only if the XenApp server role was previously configured) Removes the server from the farm. The remainder of this procedure assumes you are creating a new farm or adding a server to a farm.
q

4. When creating a farm, on the Enter basic information page:


q

Enter a farm name, up to 32 characters (can include spaces). If you are using Oracle as your Configuration Logging database, do not use hyphens in the farm name.

Specify the domain and username for a user who will be the first Citrix administrator. The administrator has full permissions to the farm and can create additional administrator accounts. 5. Select the data store database type and connection information.
q

If you choose the entry for New database

Action When creating a farm, the Server Configuration Tool installs the Microsoft SQL Server Express database automatically, with the instance name CITRIX_METAFRAME and database name MF20. The database uses Windows authentication. You are prompted for the instance name, the database name, and the authentication method. This database can be located on a remote SQL server. You are prompted for the Net Service name. (The Oracle entry appears only if the Oracle client is installed on the server where you are configuring the XenApp role.)

Existing Microsoft SQL Server database Existing Oracle database

18

Configuring XenApp Using the Wizard-based Server Configuration Tool 6. Specify the database credentials. Specify the user name in the form <DBMACHINE>\<USER> or <DOMAIN>\<USER>. SQL Server Express requires an existing Windows account, but it does not need to be a server or system administrator. The Server Configuration Tool adds two database administrators to SQL Server Express: (local)\administrators and the supplied credentials for the local or domain user. When adding a server to (joining) a farm, you can optionally test the connection to the database. The result does not affect Server Configuration Tool operations. 7. The default session shadowing settings (which allow shadowing) are recommended for most farms. Shadowing settings supplied during XenApp configuration override system or domain policy for user-to-user shadowing. Important: Shadowing features are permanent and should be changed only if you want to permanently prevent system or domain policy from affecting that setting. If you disable shadowing or change shadowing features during configuration, you cannot reconfigure them later. Option Prohibit shadowing of user session on this server Allow shadowing of user sessions on this server Description Disables user session shadowing on this server. If selected, shadowing cannot be enabled on this server through policies. Default = unselected Enables user session shadowing on this server. Default = selected When you enable shadowing, you can apply the following features (default = all unselected):
q

Prohibit remote control. If selected:


q

Authorized users can view sessions but do not have keyboard and mouse input

Remote control is permanently prohibited; this cannot be enabled on this server through policies. Force a shadow acceptance prompt. If selected:
q q

Authorized users must send an acceptance prompt when attempting to shadow a session.

A shadow acceptance prompt is shown on every shadowing attempt; this cannot be disabled on this server through policies. Force logging of all shadow connections. If selected:
q q

All shadowing attempts, successes, and failures are logged in the Windows event log.

Shadow connections are always logged; this cannot be disabled on this server through policies. 8. If you do not change the following server settings, the Server Configuration Tool uses default values.
q

19

Configuring XenApp Using the Wizard-based Server Configuration Tool Setting Data Collection Description Specify the server mode and zone name.
q

(Displayed only when joining a farm) Select a server mode:


q

Enable controller and Session-host modes (default). This server can host sessions and serve as a data collector or XML broker.

Enable Session-host mode only. This server can host sessions but cannot serve as a data collector or XML broker. For more information about server modes, see XenApp Server Mode.
q q

The default zone name is Default Zone. To create a custom zone name, select the checkbox and enter the name.

XML Service Receiver Remote Desktop Users

Citrix XML Service port. For more information, see Citrix XML and IIS Integration. Server name or URL of the Web Interface server used by the Citrix Receiver. Only members of the Remote Desktop Users group can connect to published applications. Until you add users to this group, only administrators can connect remotely to the server. Select one or more of the following.
q

Add Anonymous users. Adds anonymous users to the Remote Desktop Users group. Default = selected Add the Authenticated users. Adds current (and future) domain accounts in the Windows Users group to the Remote Desktop Users group. Default = unselected

Add the list of users from the Users group. Adds all current users from the Users group to the Remote Desktop Users group. If you add users later, you must add them manually to the Remote Desktop Users group. Default = selected 9. If you installed a plug-in or agent for the Single sign-on, SmartAuditor, EdgeSight, or Power and Capacity Management features on this server, specify the requested information to enable communications with them. (The feature roles use separate tools for their configuration.)
q

10. Review the summary page. After you click Apply, a display indicates configuration progress and the result. If the configuration fails, click View Log to display the configuration log. After configuration completes, you are returned to the XenApp Server Role Manager, which indicates if any requirements remain.

20

Configuring XenApp Using the Wizard-based Server Configuration Tool


q

If you have not yet configured XenApp license information, click Specify licensing. To initiate a server restart, click Reboot.

21

Configuring XenApp from the Command Line


Note: The Configuration Command Syntax topic lists and describes the XenApp configuration command-line options. This topic contains information about using the XenApp configuration command and its options.

Command Conventions
Several options use Boolean values (true or false).
q

If you omit an option that requires a Boolean value, the default value is used. For example, if you do not include the /AddLocalAdmin:True|False option in the command, the default value (false) is used (that is, a local administrator is not added). If you specify an option that requires a Boolean value but you omit the value, the option default value is true. For example, for the /AddLocalAdmin:True|False option, if you specify only /AddLocalAdmin (with no :True or :False value), the option is true (that is, a local administrator is added).

You can use environment variables to represent one or more command-line options. For example, you can group the standard Pause, Confirm, and NotStrict options as a single environment variable. You can also use environment variables in the command-line option values (for example, /ServerName:%currentServer%, where currentServer is defined as an environment variable).

Return Codes
The XenAppConfigConsole command supports the following return codes: Value 0 1 Meaning Success Invalid command-line options - for example, the command includes the options /ServerName:server_name and /ExecutionMode:Create (an option that is valid only when joining a farm was specified when creating a farm) Unmatched parameters - an unrecognized option was specified Invalid parameters - for example, for an option that requires a Boolean value (that is, True or False), you specified 'Bob' Commit failed - the configuration process did not complete; check the log file for details

2 3 4

22

Configuring XenApp from the Command Line

Mapping of Earlier XenApp Version Properties to Options


XenApp versions earlier than 6.0 supported installation and configuration properties. Some of those properties have equivalent options in XenApp 6. Property in Earlier XenApp Version CTX_MF_FARM_SELECTION CTX_MF_NEW_FARM_NAME CTX_MF_DOMAIN_NAME, CTX_MF_USER_NAME CTX_MF_SILENT_DSNFILE CTX_MF_ODBC_USER_NAME CTX_MF_ODBC_PASSWORD CTX_MF_LICENSE_SERVER_NAME CTX_MF_LICENSE_SERVER_PORT CTX_MF_ZONE_NAME CTX_MF_XML_PORT_NUMBER, CTX_MF_XML_CHOICE CTX_MF_SHADOWING_CHOICE:yes CTX_MF_SHADOW_PROHIBIT_REMOTE_ICA CTX_MF_SHADOW_PROHIBIT_NO_NOTIFICATION CTX_MF_SHADOW_PROHIBIT_NO_LOGGING CTX_MF_ADD_ANON_USERS CTX_MF_CREATE_REMOTE_DESKTOP_USERS Option in XenApp 6 /ExecutionMode /FarmName /CitrixAdministratorAccount:domain\user /DsnFile /OdbcUserName /OdbcPassword /LicenseServerName /LicenseServerPort /ZoneName /CustomXmlServicePort /ProhibitShadowing:false /ProhibitRemoteControl /ForceShadowPopup /ForceShadowLogging /AddAnonymousUsersToRemoteDesktopUserGroup /AddUsersGroupToRemoteDesktopUserGroup

23

Configuration Command Syntax


On the server where the XenApp server role is installed, from C:\Program Files (x86)\Citrix\XenApp\ServerConfig, type the following at a command prompt: XenAppConfigConsole.exe [options] The following tables describe configuration command options, grouped by category. Note: You can also use this command to remove the XenApp server role; see Removing Roles and Components.

Configuration process and command-related options /help Displays command help. /NotStrict Allows the executable to continue processing even if options do not apply in the current context. /Confirm Displays a confirmation message before modifying the server. This can be useful when testing for correct use of command options. /Pause Pauses the executable after processing completes. This prevents the command prompt from closing when launching the command from a batch file. /LogFilename:file Logs the progress of the executable to a log file. In the log, the symbols >> indicate a function call; the symbols << indicate a function return. Default: C:\Windows\Temp General farm information options

24

Configuration Command Syntax /ExecutionMode:Create | Join | Leave | ImagePrep (Required) Specifies the task to perform.
q

Create. After you install XenApp on the first server, that server is where you create a new farm during configuration. Join. After you install XenApp on other servers, you add each server to (join) an existing farm. ImagePrep. (Valid only if the XenApp server role was previously configured) Prepares the server for imaging. Leave. (Valid only if the XenApp server role was previously configured) Removes the server from the farm.

/FarmName:name (Required and valid only with /ExecutionMode:Create) Specifies the farm name, up to 32 characters (can include spaces). If you are using Oracle for the Configuration Logging database, do not use hyphens in the farm name. /CitrixAdministratorAccount:domain\user (Required and valid only with /ExecutionMode:Create) Specifies the domain and username for the user who will be the first Citrix administrator. The administrator has full permissions to the farm and can create additional administrator accounts. /ZoneName:name Specifies the zone name. Default = Default Zone /AddLocalAdmin:True | False Enables or disables creation of Citrix administrator accounts for all user accounts in the local Administrators group. Default = False /ImaWorkerMode: True | False (Valid only with /ExecutionMode:Join) Enables or disables ability of the server to be a data collector or XML broker. For more information, see XenApp Server Mode. Default = False (server can be a data collector or XML broker) Database used for farm data store options If you use a Microsoft SQL Server Express database, you can simplify configuration by using the /SimpleDB option when creating the XenApp farm. When joining a farm that uses that database, use the /ServerName option to specify the name of the XenApp server on which you created the farm. /SqlExpressRootDir:ir Specifies the location of the SQL Server Express source installation directory. Default = C:\Program Files (x86)\Citrix\XenApp\ServerConfig\SqlExpress_2008. /SimpleDB Indicates the farm uses a SQL Server Express database for the data store.

25

Configuration Command Syntax /ServerName:name (Valid only with /ExecutionMode:Join and required with /SimpleDB) Specifies the name of the server where the XenApp farm was created (that is, where the SQL Server Express database was installed). /DsnFile:file Specifies the path to the DSN file used to connect to the data store. /AuthenticationType:Windows | Sql (Valid only when using a SQL Server or Oracle database for the farm data store) Specifies the authentication type. Default = Windows /OdbcUserName:name (Required when creating or joining a farm) Specifies the database user name in the form <DBMACHINE>\<USER> or <DOMAIN>\<USER>. SQL Server Express requires an existing Windows account, but it does not need to be a server or system administrator. XenApp configuration adds two database administrators to SQL Server Express: (local)\administrators and the supplied credentials for the local or domain user. Specify the database password with the /OdbcPassword option. /OdbcPassword:password (Required when creating or joining a farm) Specifies the database user password. Specify the database user name with the /OdbcUserName option. License server options For more information, see Licensing Your Product. /LicenseServerName:name Specifies the name of the existing license server. /LicenseServerPort:port Specifies the license server port. Default = 27000 /LicenseModel:model Specifies the licensing model. Valid values are:
q

XA. Specify this model if you plan to use only XenApp licenses. XDC. Specify this model if you plan to use XenDesktop concurrent user licenses.

q XDUD. Specify this model if you plan to use XenDesktop user or device licenses. Default = XA

Session shadowing options

26

Configuration Command Syntax Important: Citrix recommends using the default values (that is, do not specify them in this command). Shadowing settings specified during XenApp configuration override system or domain policy for user-to-user shadowing. Shadowing features are permanent and should be changed only if you wish to permanently prevent system or domain policy from affecting that setting. If you disable shadowing or change shadowing features during configuration, you cannot reconfigure them later. /ProhibitShadowing:True | False Disables or enables session shadowing. Default = False (shadowing is enabled) /ProhibitRemoteControl:True | False (Valid only if shadowing is enabled) Prohibits or allows remote control shadowing. When this option is true, authorized users can view sessions but do not have keyboard and mouse input. Default = False /ForceShadowPopup:True | False (Valid only if shadowing is enabled) Enables or disables sending a shadowing acceptance popup. When this option is true, authorized users must send an acceptance prompt when attempting to shadow a session. Default = False /ForceShadowLogging:True | False (Valid only if shadowing is enabled) Enables or disables logging of all shadow connections. When this option is true, all shadowing attempts, successes, and failures are logged to the Windows event log. Default = False Citrix XML service port options For information about the XML IIS Service Integration component, see Citrix XML and IIS Integration. /CustomXmlServicePort:port Specifies the port number to be used by the Citrix XML Service. Default = 80 /SkipXmlSetting:True | False When this option is true, the Citrix XML service and IIS port numbers are not configured (that is, the default port 80 is not used). Default = False Remote Desktop Users Group options Only members of the Remote Desktop Users Group can connect to published applications. Until you add users to this group, only administrators can connect remotely to the server. Specify one or more of the following options. /AddAnonymousUsersToRemoteDesktopUserGroup:True | False Enables or disables adding anonymous users to the Remote Desktop Users group. Default = True /AddAuthenticatedUsersToRemoteDesktopUserGroup:True | False Enables or disables adding current (and future) domain accounts in the Windows Users group to the Remote Desktop Users group. Default = False

27

Configuration Command Syntax /AddUsersGroupToRemoteDesktopUserGroup:True | False Enables or disables adding all current users from the Users group to the Remote Desktop Users group. If you add users later, you must add them manually to the Remote Desk-top Users group. Default = True Image preparation and provisioning options For more information, see Preparing for XenApp Imaging and Provisioning. /RemoveCurrentServer:True | False (Valid only with /ExecutionMode:ImagePrep) Enables or disables removing the current server instance from the XenApp farm. Default = True /PrepMsmq:True | False (Valid only with /ExecutionMode:ImagePrep) Enables or disables resetting the MSMQ ID during resealing. Default = True /ClearLocalDatabaseInformation:True | False (Valid only with /ExecutionMode:ImagePrep) Enables or disables removing the server, database, and failover partner entries from the DSN file and setting the equivalent LGPO settings to NotConfigured. Default = True Important: If you enable removal of the database information, XenApp assumes an Active Directory policy will provide database settings. If a policy is not applied, the server will not restart. Feature and component options /SmartAuditorServerName:name (Required if you installed the SmartAuditor agent on the XenApp server) Specifies the name of the SmartAuditor server. /SsoPluginUncPath:path UNC path to the Single sign-on central store. Default = use Active Directory /OnlinePluginServerUrl:name_url Server name or URL of the Web Interface server used by the Citrix Receiver. /PcmFarmName:farm Power and Capacity Management farm name. /PcmWorkloadName:name Power and Capacity Management workload name. /EdgeSightCompanyName:name EdgeSight company name.

28

Configuration Command Syntax /EdgeSightServerName:name EdgeSight server name. /EdgeSightServerPort:port EdgeSight server port. Default = 80 Other options /CreateAnonymousUserAccounts:True | False Creates anonymous Citrix accounts Anon000-Anon014. Default = True /RemoveAnonymousCitrixAccounts:True | False Removes anonymous Citrix accounts Anon000-Anon014. Default = False

Example
The following command, issued from the typical XenApp Server Configuration Tool location (C:\Program Files (x86)\Citrix\XenApp\ServerConfig\XenAppConfigConsole.exe), joins the server to the farm, specifying database credentials and the DSN file location, license server and model information, log file location, and Remote Desktop User Group configuration settings. C:\Program Files (x86)\Citrix\XenApp\ServerConfig\ -XenAppConfigConsole.exe" /ExecutionMode:Join /OdbcUserName:administrator /OdbcPassword:somepasswd /LicenseServerName:somelicenseserver /LicenseServerPort:27000 /LicenseModel:XA /ZoneName:some_zone_name /DsnFile:"c:\somepath\to\example.dsn" /Log:c:\SomewhereConfigLog.txt /CustomXmlServicePort:8080 /AddAnonymousUsersToRemoteDesktopUserGroup:True /AddUsersGroupToRemoteDesktopUserGroup:True /AddAuthenticatedUserstoRemoteDesktopUserGroup:True

29

Preparing for XenApp Imaging and Provisioning


Primary deployment methods for XenApp servers include server imaging, virtualization, and provisioning. Separation of the XenApp server role installation and configuration tasks offers flexibility in deciding when to capture (create) XenApp images. Provisioning a XenApp server uses one of three typical approaches; the approach you use depends on when you configure XenApp (earlier or later) in your preparation steps. The XenApp server joins its farm on the first restart (reboot) after configuration; this ensures that the XenApp server image joins or rejoins the farm after it has been cloned with its final identity. Important: Cloning is not supported for the first server in the farm (where you created the farm during configuration), and should be used only for creating new member servers for an existing farm. The following descriptions assume you already created a XenApp farm containing at least one server. You need the data store database information and credentials for the farm.

Approach 1: Capture an image after XenApp installation, but before configuration and restart
In this approach, you install the XenApp server role, but wait to configure XenApp (join a farm) until after the server is cloned and booted. XenApp server configuration is automated, using a script. This approach is not supported in Citrix Provisioning Services using Shared Image mode. 1. Install the XenApp server role, but do not configure the server. You may want to restart the server to ensure the system path is updated properly before installing other applications. 2. Install your applications and configure the settings you want in your image. Deploying prerequisites such as Remote Desktop Services roles may require a server restart before you can install XenApp. 3. Run the generalization tools you normally run. 4. Set up a script to run when each cloned server boots. This script configures the XenApp server (including farm information) using the XenAppConfigConsole.exe command. The script then restarts the server, whereupon the server joins the farm. You can set up scripts using typical methods such as Active Directory startup scripts or the RunOnce registry key.

30

Preparing for XenApp Imaging and Provisioning 5. Capture an image of the server.

Approach 2: Capture an image after XenApp installation and configuration, but before restart
In this approach, you install and configure the XenApp server role, but wait to restart the server until after it is cloned. When the server restarts as a clone of the original image, it joins the farm with its new identity. You do not need direct access to your database server or network during configuration, so this approach can be used to prepare XenApp images for remote deployments. If you do not or cannot verify your database credentials, and they are invalid, XenApp will not join the farm when the server restarts. In that case, run the XenApp Server Configuration Tool, providing correct credentials, and then recapture an image. 1. Install your applications and configure the settings you want in your image. 2. Install the XenApp server role. Deploying prerequisites such as Remote Desktop Services roles may require a server restart before you can install XenApp. 3. Configure the XenApp server to add the server to (join) a farm, but do not restart the server. 4. Run the generalization tools you normally run. 5. Capture an image of the server. Note: If you are using the SmartAuditor agent or other features that depend on Microsoft Messaging Queuing (MSMQ), use Approach 3.

Approach 3: Capture or update an image after XenApp installation, configuration, and restart
If you require XenApp to be installed and working before you create a final image, you must remove the server from the farm, then rejoin the farm before your final shutdown (for example, after sysprep), so that the server will join the farm on the next restart, with its new identity. 1. Install the XenApp server role. Optionally, install the Provisioning Services Target Device software. This software resets your network connection during installation. Failures may occur if you install this component from a network location. Although these failures are not commonly harmful, Citrix recommends installing the Provisioning Services Target Device software from a DVD, mounted ISO, or local copy of the installation media. 2. Configure XenApp to join a farm, and then restart (reboot) the server. 3. Install your applications and configure the settings you want in your image.

31

Preparing for XenApp Imaging and Provisioning 4. Edit your XenApp configuration and select the task Prepare this server for imaging and provisioning. (For a command-line configuration, specify the /ExecutionMode:ImagePrep option.)
q

If you are working with an image template that you do not want to keep in the current farm, select the Remove this current server instance from the farm checkbox. (For a command-line configuration, use the /RemoveCurrentServer:True option.) If you are provisioning the XenApp server with SmartAuditor or other features that depend on MSMQ, selecting the Prepare Microsoft Messaging Queuing provisioning checkbox ensures a new unique machine identifier when the server image boots. (For a command-line configuration, use the /PrepMsmq:True option.) If you select the Clear database location settings from this server checkbox, the default database information is removed from local settings (server, database, and failover partner entries are removed from the DSN file; LGPO is set to NotConfigured). This ensures that cloned servers can join only a XenApp farm that is specified with inherited group policy settings. (For a command-line configuration, use the /ClearLocalDatabaseInformation:True option.)

Important: If you select this checkbox, XenApp assumes an Active Directory policy will provide database settings. If a policy is not applied, the IMA Service will not start. 5. Run the generalization tools you normally run. 6. Capture an image of the server. The server joins the farm when the image boots.

Resealing an image
If a golden image requires updating (for example, with Citrix or Windows hotfixes, or third-party applications and patches), you can reseal the image. This procedure is similar to approach 3. 1. Boot into the image to make modifications. The XenApp server will try to join the farm if it can. 2. Modify the server as needed. 3. Proceed with step 4 in Approach 3. During the resealing process, the Server Configuration Tool:
q

Removes server-specific information, such as WSID in MF20.dsn, WSID in RadeOffline.dsn. Creates a unique Secure Ticket Authority (STA) ID in CtxSta.config, using the MAC address. Resets the local databases and removes the Servers setting from the Independent Management Architecture (IMA) data store by clearing the IMA local host cache and

32

Preparing for XenApp Imaging and Provisioning RadeOffLine databases.


q

Places the following configuration information into the Local Group Policy Object (LGPO) if they have nondefault values (nondefault values appear as Configured, default values appear as NotConfigured).
q

Product feature and server edition License server hostname License server port number XML Service port Database server, database, and failover partners (if that checkbox was selected)

Installation and Configuration Considerations


For provisioning purposes, you can install the XenApp server role using the wizard-based XenApp Server Role Manager or the command line. For wizard-based installations, do not proceed to configuring the XenApp server role until you are ready, based on the approach you select. Configuring the XenApp server after it is instanced (approach 1) should be automated using the command line. You can use the wizard-based XenApp Server Configuration Tool or the command line to configure the XenApp server if you choose approach 2 or 3. When preparing a XenApp server for imaging and provisioning:
q

The server should not be the only server in the XenApp farm. The server should not be the data collector. The server should not have the data store database installed on it. The server should not have the Citrix License Server installed on it.

Important: When provisioning XenApp, you must remove the server SSL certificate before running XenConvert; otherwise, the SSL certificate will be distributed to all provisioned XenApp servers. For example, the following command, issued from the root of the installation media, installs the XenApp server role and the Provisioning Services target device, and excludes installation of the AppCenter. \XenApp Server Setup\bin\XenAppSetupConsole.exe /install:XenApp,PVDeviceFeature /exclude:XA_Console The following command prepares XenApp for imaging and provisioning. The server will be removed from the current farm, and when the server image boots, it will contain a unique MSMQ machine identifier. Database identification information will be removed from the DSN file.

33

Preparing for XenApp Imaging and Provisioning C:\Program Files (x86)\Citrix\XenApp\ServerConfig\ -XenAppConfigConsole.exe" /ExecutionMode:ImagePrep /RemoveCurrentServer:True /PrepMsmq:True /ClearLocalDatabaseInformation:True

34

Removing Roles and Components


You can remove the following XenApp 6.5 roles and some components using the wizard-based Server Role Manager or the command line:
q

XenApp Receiver Storefront Web Interface Licensing Single sign-on service Provisioning server

Important: Although you can use Windows Programs & Features to remove the XenApp 6.5 roles listed above, Citrix strongly recommends using the Server Role Manager. To remove other roles (such as EdgeSight server, SmartAuditor server, Power and Capacity Management administration components, Secure Gateway), use Windows Programs & Features. You cannot use the XenApp 6.5 Server Role Manager to remove fully-integrated roles in an earlier XenApp version deployment (including early release or Technical Preview versions). In those cases, Citrix recommends reimaging the server and then installing XenApp. When you remove the XenApp server role, the process automatically removes the server from the XenApp farm.

35

Removing Roles and Components

Removing Roles and Components Using the Wizard-based Server Role Manager
1. Access the XenApp Server Role Manager. 2. Select Add or remove server roles. 3. On the Select a task page, select Remove server roles. 4. Select one or more roles to remove. If you select a role that has default components, those default components are automatically selected; you cannot change this (that is, you cannot remove the role without also removing its default components). To remove only a default component (for example, to remove the AppCenter but leave the XenApp server role installed), select only the component, not the role. You cannot remove the XenApp XML IIS Integration default component or the Windows Enhanced Desktop Experience optional component. Required role components are not listed. The Receiver for Windows and the Offline Plug-in are automatically installed with the XenApp server role; you cannot remove them using the Server Role Manager unless you also remove the XenApp server role. 5. Review the summary, which lists the roles and components to be removed. After you click Remove, a display indicates the progress and the result.

Removing XenApp Roles and Components Using the Command Line


On the server where you want to remove a role or component, from either the %PROGRAMDATA%\Citrix\XenAppUninstall\ or XenApp Server Setup\bin\ directory, type the following at a command prompt: XenAppSetupConsole.exe options Valid options are:

/help Displays command help. /logfile:path Path for the log file generated during the removal.

36

Removing Roles and Components /uninstall:items Comma-delimited list of roles and components to remove. Valid values are:
q

ReceiverStorefront. Receiver Storefront. WebInterface. Web Interface role. Licensing. License server role. SsonService. Single sign-on service role. Provisioning. Provisioning Services role. XenApp. XenApp server role. XA_Console. AppCenter. EdgeSightAgentFeature. EdgeSight agent. SmartAuditorAgentFeature. SmartAuditor agent. SSONAgentFeature. Single Sign-on Plug-in. PCMAgentFeature. Power and Capacity Management agent. PVDeviceFeature. Provisioning Services target device.

Note: You cannot remove the XenApp XML IIS Integration or Enhanced Desktop Experience components. The Receiver for Windows and the Offline Plug-in are removed when you remove the XenApp server role. Important: When using the XenAppSetupConsole.exe command to remove roles or components, do not specify options that configure the XenApp role.

Examples
The following command removes the XenApp server role and all its default components. XenAppSetupConsole.exe /uninstall:XenApp The following command removes the Receiver Storefront and the XenApp server role. XenAppSetupConsole.exe /uninstall:XenApp,ReceiverStorefront The following command removes the SmartAuditor agent component. XenAppSetupConsole.exe /uninstall:SmartAuditorAgentFeature

37

Data Store Database Reference


See the database vendor documentation before installing, configuring, and using the database software. CTX114501 contains information about supported database versions. If you use a Microsoft SQL Server 2008 Express database for the farm data store, XenApp configuration automatically installs it. Important:
q

Citrix does not support case-sensitive databases. To avoid corruption, do not directly edit data in the data store database with utilities or tools other than those provided by Citrix.

Maintaining, Backing up, and Restoring a XenApp Data Store


Most database maintenance requires running the dsmaint and dscheck server utilities on XenApp farm servers. The XenApp Server Utilities Reference contains syntax and use details. Use dsmaint to:
q

Upgrade the XenApp data store Move the data in the data store to a different database server Change the name of the DSN file

If the data store fails, each farm server can run from the data in its Local Host Cache indefinitely, provided it can contact the license server. However, you cannot make any modifications to the farm or use the AppCenter. Create a backup copy of the data store (dsmaintbackup). Without a backup, you must manually recreate all of the farm policies, settings, accounts, and other persistent data in the data store. To restore a backup database or to migrate to a new server, use the dsmaint migrate utility. Without a backup, prepare a new data store the way you did before configuring XenApp and run the XenApp Server Configuration Tool from any farm server. After running the Server Configuration Tool, manually reenter the lost settings. If you use the same name as the previous data store, you do not need to reconfigure the farm servers.

38

Microsoft SQL Server Database


The server hosting the Microsoft SQL Server database should meet the following minimum requirements:
q

Approximately 100MB of disk space for every 250 servers and 50 published applications in the XenApp farm. Provide more disk space for greater numbers of published applications. Set the "temp" database to automatically grow on a partition with at least 1GB of free disk space. Citrix recommends 4GB if the farm is large and includes multiple print drivers.

The default database installation settings and database sizes usually suffice for XenApp data store needs. Microsoft SQL Server supports Windows and Microsoft SQL Server authentication. For high-security environments, Citrix recommends using Windows authentication only. The user account for installing, upgrading, or applying hotfixes to the data store must have database owner (db_owner) rights to the database. When you finish installing the database with database owner rights, set the user permissions to read/write only to increase the security of the database. Change the rights back to database owner before installing service packs or feature releases; installations can fail if the user account used to authenticate to the data store during Setup does not have database owner rights. When using Microsoft SQL Server in a replicated environment, use the same user account for the data store on each Microsoft SQL Server. Each farm requires a dedicated database. However, multiple databases can be running on a single server running Microsoft SQL Server. Do not configure the farm to use a database that is shared with any other client/server applications. Back up the database regularly and follow Microsoft recommendations for configuring database and transaction logs for recovery (for example, setting the Truncate log on Checkpoint option to control log space).

39

Microsoft SQL Server Database

Using Sockets to Connect to a Microsoft SQL Server Database


Two protocols used to connect to a database are TCP/IP sockets and named pipes. Named pipes is an authenticated communication protocol, so any time you attempt to open a connection to the SQL Server database using this protocol, the Windows authentication process occurs. TCP/IP sockets do not rely on Windows authentication to establish a connection, but do provide user/password authentication to the database after the connection is established. Windows authentication reduces the possibility of an error occurring when the server hosting SQL Server and the XenApp server do not have the correct domain or Active Directory trust relationship. Therefore, Citrix recommends using TCP/IP sockets. If you use named pipes, manually enable the named pipes option on the database server using the Surface Area Configuration tool packaged with SQL Server.

Creating a Microsoft SQL Server Data Source Connection


1. On the Create a New Data Source to SQL Server screen, enter the data source description and select the SQL Server to which to connect. 2. Select Windows NT Authentication or SQL Server Authentication. 3. Click Client Configuration. 4. Select TCP/IP from the available network libraries. 5. After installing XenApp, modify the Data Source Name (DSN) created during configuration and change its client configuration to use TCP/IP. To modify a DSN, use the Windows ODBC Data Source Administrator utility to open the File DSN, which is located by default in the %ProgramFiles(x86)%\Citrix\Independent Management Architecture folder, and select TCP/IP as the connection protocol for the client configuration.

Using Failover with Microsoft SQL Server


For fault tolerance with Microsoft SQL Server, use Microsoft clustering, which provides failover and failback for clustered systems. Failover of the SQL Server database in a clustered environment is transparent to XenApp. The database files for an instance of Microsoft SQL Server are placed in a single cluster group owned by the node on which the instance is installed. If a node running an instance of Microsoft SQL Server fails, the cluster group containing the data files for that instance is switched to another node. The new node already has the executable files and registry information for that instance of Microsoft SQL Server on its local disk drive, so it can start 40

Microsoft SQL Server Database up an instance of Microsoft SQL Server and start accepting connection requests for that instance. Microsoft Cluster Services clustering does not support load balancing among clustered servers because it functions in active/passive mode only.

Using Distributed Databases with Microsoft SQL Server


XenApp supports distributed (replicated) databases. Replicated databases are useful when too many read requests to the data store create a processing bottleneck. Microsoft SQL Server uses replication to create the distributed database environment. XenApp requires data coherency across multiple databases. Therefore, a two-phase commit algorithm is required for storing data in the database. When configuring Microsoft SQL Server for a two-phase commit, use the Immediate Updating Subscriber model. When configuring Microsoft SQL Server, you may need to increase the value of the Max Text Replication Size property to improve replication performance. Caution: To avoid corruption, do not use merged replication. To set up a distributed environment for an existing XenApp farm: 1. Configure a Publisher (the Microsoft SQL Server currently hosting the data store) and Subscribers (remote sites) using Microsoft SQL Server Enterprise Manager. 2. Run the dsmaint publishsqlds command on a server in the farm. This executes the necessary SQL statements to create the published articles on the current Microsoft SQL Server (Publisher). 3. Configure the remote sites (Subscribers) to subscribe to the published articles created in the previous step.

41

Oracle Database
The server hosting the Oracle database should meet the following minimum requirements:
q

Approximately 100MB of disk space for every 250 servers and 50 published applications in the farm. Provide more disk space for greater numbers of published applications. 20 MB minimum tablespace size.

Oracle supports Windows and Oracle authentication. Oracle for Solaris supports Oracle authentication only; it does not support Windows authentication. In the Oracle sqlnet.ora file, set SQLNET.AUTHENTICATION_SERVICES= (NONE). The default setting (NTS) will cause connection failures. Do not install XenApp on a server hosting an Oracle database. Install the Oracle client on the server where you will be installing XenApp and then restart the server before you install XenApp. The Oracle user account must be the same for every server in the farm because all XenApp servers share a common schema. If you are using one database to hold information for multiple farms, each farm represented in the database must have a different user account because the data store information is stored in the Oracle user account. The account used to connect to the data store database has the following Oracle permissions:
q

Connect Resource Unlimited Tablespace (optional)

Consider the following guidelines when configuring an Oracle server.


q

Use Shared/Multi-Threaded Server mode to reduce the number of processes in farms with more than 100 servers (performance may be affected during periods of high data store load). If you are using Multi-Threaded Server mode, verify that values in the Init.ora file are greater than or equal to the following values. If you are running multiple farms on the same Oracle database, include all XenApp servers in the calculations. Round up fractional values. shared_servers = Number of servers / 10 max_shared_servers = Number of servers / 5

42

Oracle Database Where Number of servers is the total number of servers running XenApp.
q

When using an Oracle server in dedicated mode, add one additional process for each server connected directly to the Oracle database. For example, if the Oracle server uses 100 processes before installing XenApp, and the farm has 50 servers, set the processes value to at least 150 in the Init.ora file on the Oracle server. Create online backups using Archivelog mode, which reduces the recovery time of an unresponsive database. If you are using the same Oracle database for multiple server farms, create a unique tablespace with its own user name and password for added security for each farm. Do not use the default system account within Oracle. Maintain a standby database for quick disaster recovery. A standby database maintains a copy of the production database in a permanent state of recovery.

Using Distributed Databases with Oracle


Oracle uses replication to create the distributed database environment. To reduce the load on a single database server, install read/write replicas and distribute the farm servers evenly across the master and replicas. XenApp requires data coherency across multiple databases. Therefore, a two-phase commit algorithm is required for writes to the database. Using Oracle as a distributed database solution has the following requirements:
q

All participating databases must be running Oracle. All participating databases must be running in Multi-Threaded Server/Shared mode (rather than Dedicated mode). All Oracle clients (XenApp servers that connect directly to the Oracle database) must be SQL*Net Version 2 or Net8. Install the farm data store database first on the master site, then configure replication at the sites used for database replication snapshots. Replicate all objects contained in the data store user schema (tables, indexes, and stored procedures).

If the performance at the replicated database site is significantly slower, verify that all the indexes for the users schema are successfully replicated. When configuring Oracle for a two-phase commit:
q

Use synchronous snapshots that can be updated with a single master site. XenApp requires write access to snapshot. Use the Oracle Fast Refresh feature where possible (this requires snapshot logs). When setting up the replication environment, do not configure conflict resolution.

43

Oracle Database
q

Set the replication link interval to be as frequent as the network environment allows. With Oracle replication, if no changes are made, data is not sent over the link. When Oracle is configured in Multi-Threaded Server mode and remote data transfers are initiated from the remote site, they can block local data transfers (because all connections share a set of worker threads). To remedy this, increase the value of the Max_Mts_Servers parameter in the Init.ora file.

44