Install and Configure

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

Contents

Install and Configure 3

Install and Configure 5

Preparing to Install and Configure XenApp 6

Before Installing XenApp 7

Before Configuring XenApp 9

Installing XenApp Using the Wizard-Based Server Role Manager 11

Installing XenApp from the Command Line 13

Configuring XenApp Server Role License Information 16

Configuring XenApp Using the Wizard-based Server Configuration Tool 18

Configuring XenApp from the Command Line 22

Configuration Command Syntax 24

Preparing for XenApp Imaging and Provisioning 30

Removing Roles and Components 35

Data Store Database Reference 38

Microsoft SQL Server Database 39

Oracle Database 42

2

3

Installing and Configuring XenApp

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

● For a wizard-based XenApp installation or configuration, use the XenApp Server RoleManager.

● From the command line, use the XenAppSetupConsole.exe command to install theXenApp server role and the XenAppConfigConsole.exe command to configure theXenApp server role.

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

● Install role prerequisites

● Install fully-integrated server roles (such as XenApp, Citrix licensing, Single sign-onservice, and Provisioning Server)

● Launch installers for partially-integrated roles (such as Power and Capacity ManagementAdministration, SmartAuditor Server, EdgeSight Server)

● Launch the Citrix License Configuration Tool to configure the XenApp role licenseparameters (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 andproperties at a Windows Server command prompt.

Accessing the Server Role ManagerThe XenApp Server Role Manager runs initially from the XenApp installation media. Afteryou install a role, the Server Role Manager is installed locally and runs every time you logon to the XenApp server (you can disable this feature by selecting a checkbox on the mainServer Role Manager page). You can also run the Server Role Manager from Start > AllPrograms > Administrative Tools > Citrix > XenApp Server Role Manager, or from itsProgram Files location (Program Files(x86)\Citrix\XenApp\ServerRoleManager\XenAppServerRoleManager). If a Server RoleManager is installed locally and you invoke a different one from the XenApp installationmedia, the version on the installation media is used.

Using the XenApp Media to Install and UpgradeCitrix recommends using the XenApp 6.5 media to perform a clean install of the XenAppserver role on a Windows Server 2008 R2 or Windows Server 2008 R2 SP1 server. Cleaninstall means that there is no previous version of the XenApp server role installed on theserver. If you have an earlier XenApp version installed (including an early release orTechnical 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.5Upgrade 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 aXenApp 5 or XenApp 6.0 to the new XenApp 6.5 farm. For details, see XenApp MigrationCenter.

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 XenAppserver role.

If you run the Server Role Manager from the XenApp 6.5 media on a XenApp 6.0 server, newsoftware may be available for installed roles and components other than the XenApp serverrole. In these cases, the Server Role Manager will display Upgrade next to the role orcomponent; clicking that link starts the upgrade process.

Important: Do not attempt to upgrade components and features in a XenApp 6.0deployment using MSIs from the XenApp 6.5 media, unless explicitly instructed to do so.

Install and Configure

4

5

Preparing to Install and ConfigureXenApp

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 asubstitute for Administrators group membership.)

Important:

● Do not install XenApp on a domain controller. Citrix does not support installing XenAppon a domain controller.

● Do not join servers running this version of XenApp to a deployment with servers runningprevious versions of XenApp.

● You must use the AppCenter from the 6.5 media to manage the XenApp 6.5 farm. Citrixdoes not support using a console from a previous XenApp release.

To ensure availability of the features and functionality of XenApp to your users, install themost recent version of receivers, plug-ins, and agents you use.

When installing roles or role components other than XenApp server, see the roledocumentation for details about information you must provide during installation andconfiguration.

For items to consider and tasks to complete before installing or configuring XenApp, see:

● Before Installing XenApp

● Before Configuring XenApp

6

Preparing to Install and ConfigureXenApp

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 asubstitute for Administrators group membership.)

Important:

● Do not install XenApp on a domain controller. Citrix does not support installing XenAppon a domain controller.

● Do not join servers running this version of XenApp to a deployment with servers runningprevious versions of XenApp.

● You must use the AppCenter from the 6.5 media to manage the XenApp 6.5 farm. Citrixdoes not support using a console from a previous XenApp release.

To ensure availability of the features and functionality of XenApp to your users, install themost recent version of receivers, plug-ins, and agents you use.

When installing roles or role components other than XenApp server, see the roledocumentation for details about information you must provide during installation andconfiguration.

For items to consider and tasks to complete before installing or configuring XenApp, see:

● Before Installing XenApp

● Before Configuring XenApp

7

Before Installing XenApp

● Review the installation topics (wizard-based or command-line) to learn whatinformation you must provide.

● Review the XenApp System Requirements and the system requirements for other rolesyou plan to install.

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

● For command-line XenApp installations, you must install the prerequisite softwareand Windows roles before installing XenApp. You can deploy prerequisites withPowerShell cmdlets, the Microsoft ServerManagerCmd.exe command, or theMicrosoft Deployment Image Servicing and Management (DISM) tool.

Deploying prerequisites may require a server restart before you can install the XenAppserver role.

● 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 clockhas the correct time.

● Prepare for Windows Multilingual User Interface (MUI) support, if needed. Beforeinstalling XenApp, install the target Windows Language Pack on the server, and changelanguage options (such as system locale and display language) to the target language.For more information, see the Microsoft documentation. (Changing the Windows systemlocale after installing and configuring the XenApp server role may cause data storeissues.)

Citrix XML and IIS IntegrationWhen you install the XenApp role, XML and IIS integration is an optional component.

● 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 standalonemode 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 (orany other software) is using port 80.

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

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

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

The following table describes the possible combinations, results, and defaults. For a list ofIIS role services, see XenApp System Requirements.

IIS roleservicesinstalled?

Wizard-based install Command-line install

Yes Select the XML IIS Integrationcomponent checkbox (default).The component is installed.

Specify the /install:XA_IISIntegrationoption. The component is installed.This is the recommendedconfiguration.

Yes Clear the XML IIS Integrationcomponent checkbox. Thecomponent is not installed.

Do not specify the/install:XA_IISIntegration option. Thecomponent is installed (default).

Yes - Specify the/exclude:XA_IISIntegration option.The component is not installed.

No Do not select the XML IISIntegration componentcheckbox (default). Thecomponent is not installed

Do not specify the/install:XA_IISIntegration option. Thecomponent is not installed.

No Select the XML IIS Integrationcomponent checkbox. TheServer Role Installer installs theIIS role services and thecomponent.

Specify the /install:XA_IISIntegrationoption. The Server Role Installerinstalls the IIS role services and thecomponent.

When the XML and IIS integration component is installed and the XML Service Policy isdisabled, XenApp uses the installed integration component defaults. If the XML Servicepolicy is enabled and contains a different port number setting, unexpected results mayoccur.

Before Installing XenApp

8

9

Before Configuring XenApp

● Review the configuration topics (wizard-based or command-line) to learn whatinformation you must provide.

● During configuration, you specify the database to be used for the XenApp farm datastore: Microsoft SQL Server Express, Microsoft SQL Server, or Oracle. See CTX114501 forsupported versions. Additional information is available at Data Store DatabaseReference.

● If you use a Microsoft SQL Server Express database, XenApp configuration installs itautomatically.

● If you use a Microsoft SQL Server or Oracle database, install and configure thedatabase before configuring XenApp. For an Oracle database, ensure that you alsoinstall 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 usecommand-line XenApp configuration, create a Data Source Name (DSN) file beforeconfiguring XenApp. (A wizard-based configuration creates the DSN file for you.) Eachserver in the farm must have the DSN file. You can create the file and copy it to otherservers, or put it on a network share, provided you remove the value for anyworkstation-specific information (such as the Oracle WSID). Use the /DsnFile:dsn_fileoption to specify the file location on the XenApp configuration command line.

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

● 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 XenAppbut before restarting the server.

XenApp Server ModeAll XenApp servers can host sessions. The XenApp server mode specifies whether the servercan only host sessions (session-host only mode, also called session-only) or if it can alsoperform the controller functions of being elected a data collector and hosting the XMLbroker (controller and session-host mode, also called controller).

While configuring servers as session-only can improve performance (particularly in largefarms with multiple zones), ensure you have sufficient servers configured in controllermode that can serve as backup data collectors for your zones.

● A XenApp server configured in controller mode monitors other controller servers in theXenApp 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 incontroller mode.

● 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 operationmust be run on a XenApp 6.5 server configured in controller mode.

When you create a XenApp farm, the XenApp Server Configuration Tool automaticallyconfigures the server in controller mode; you cannot configure session-only on the firstserver 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 notconfigurable; 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 andXML broker (default)

Server can host sessions,but cannot be a datacollector or XML broker

Wizard-based configuration Select Enable Controllerand Session-host modes

Select Enable Session-hostmode only

Command-lineconfiguration

Specify/ImaWorkerMode:False

Specify/ImaWorkerMode:True

To change the configured server mode, you must leave and then rejoin the XenApp farm,specifying the desired mode.

Before Configuring XenApp

10

11

Installing XenApp Using theWizard-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 rolesare 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 rolessupported in the XenApp edition you selected. Some roles may require current CitrixSubscription Advantage membership.)

7. Select role components. Roles may have default and optional components.

● When you select a role, its default components are selected automatically. TheXenApp role has the following default components:

● XenApp Management, which includes the Citrix AppCenter.

● Windows Desktop Experience Integration, which configures a XenApp server todeliver remote desktops containing Windows 7 features and Microsoftapplications. For more information, see Delivering XenApp to Software ServicesSubscribers.

If you do not want to install a default component, clear its checkbox.

● For information about the XML Service IIS Integration optional component, seeCitrix XML and IIS Integration. If IIS role services are installed on the server, thisoptional component is selected by default.

● If you plan to use role agents/plug-ins on this server (EdgeSight Agent, SmartAuditorAgent, Single Sign-on Plug-in, Power and Capacity Management Agent, orProvisioning Services Target Device), install them at the same time you install theXenApp server role. Otherwise, install these components from the packages on theXenApp media.

● The Citrix Receiver for Windows (formerly the online plug-in) and the Citrix OfflinePlug-in are installed automatically when you install the XenApp role. These itemsdo not appear in the components lists, and you cannot disable these installations.

8. Review the prerequisites summary, which indicates which role or component needs theprerequisite, and whether the Server Role Installer installs it or you must install it. Forsoftware you must install, the display indicates whether the XenApp installation mediacontains the software or you must obtain it elsewhere.

9. Review the summary, which lists the selected roles and components to be installed orprepared. It also lists prerequisites which will be automatically deployed for allselected 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 anyconfiguration options set, such as creating or joining a farm and data store databaseinformation.

After the installation result displays and you click Finish, the Server Role Manager task listdisplays. For each role you selected, the task list indicates the next task necessary forinstallation or configuration.

● If you have not configured the license parameters for the XenApp role, click SpecifyLicensing, which launches the Licensing Configuration Tool. Run the LicensingConfiguration Tool before configuring the XenApp server role.

● For installed fully integrated roles that require configuration, click Configure to launchthe configuration tool for that role.

● For partially integrated roles, click Install to launch the installer for that role. See therole documentation for details.

Installing XenApp Using the Wizard-Based Server Role Manager

12

13

Installing XenApp from the CommandLine

Command SyntaxOn the server where you want to install XenApp or other roles, from the "XenApp ServerSetup\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

/install:items

Comma-delimited list of roles, components, features, or technologies to install. Validvalues are:

● 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 CitrixAppCenter, Citrix Receiver for Windows (formerly online plug-in), Citrix OfflinePlug-in, and Windows Desktop Experience Integration feature (for moreinformation, see Delivering XenApp to Software Services Subscribers). You can alsospecify one or more of the following optional components to install, separated bycommas. Except as noted, if you do not specify the following optionalcomponents, they are not installed.

● XA_IISIntegration. IIS and XML Service integration. For more information, seeCitrix XML and IIS Integration. If IIS role services are installed on the server,this component is installed regardless of whether you specify it on thecommand 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.

Installing XenApp from the Command Line

14

/exclude:items

(Valid only when installing the XenApp server role) Comma-separated list ofcomponents to be omitted from the installation. Valid values are:

● XA_Console. Excludes installation of the AppCenter.

● XA_IISIntegration. Excludes installation of the XML IIS Integration component. Formore information, see Citrix XML and IIS Integration.

● XenAppEnhancedDesktopExperience. Excludes installation of the Windows DesktopExperience Integration feature.

You cannot exclude the installation of the Receiver for Windows or the Offline Plug-in.

/edition

Specifies the XenApp edition. Valid values are:

● 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:\ProgramFiles\Citrix\ICA Client

ExamplesThe 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 ReceiverStorefront 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-onPlug-in, and excludes installation of the AppCenter.

XenAppSetupConsole.exe /install:XenApp,SSONAgentFeature /exclude:XA_Console

Installing XenApp from the Command Line

15

16

Configuring XenApp Server Role LicenseInformation

XenApp server role license information must be specified before a XenApp server canaccept connections.

● From the Server Role Manager, use the wizard-based Licensing Configuration Tool afterinstalling the XenApp server role.

● From the command line, include license server information in the XenApp server roleconfiguration command (XenAppConfigConsole.exe).

See Licensing Your Product for complete Citrix licensing information.

Configuring XenApp License Information using theWizard-based Licensing Configuration Tool

If you are using the Server Role Manager, launch the Licensing Configuration Tool beforeconfiguring 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:

● 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 andusing a compatible software version, and to check if the license server has anylicenses.

● 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 onthe Select Licensing Model page, based on licenses found on the license server.

Important: Select the licensing model best suited to your planned deployment, whichmay differ from the recommendation, which is based on the licenses currently on thelicense server.

● 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

server.

● XenDesktop concurrent system. Select this model if you plan to use XenDesktopconcurrent user licenses. This option is recommended if the Test Connectionoperation discovered only XenDesktop concurrent licenses on the license server.

● XenDesktop user/device. Select this model if you plan to use XenDesktop user ordevice licenses. This option is recommended if the Test Connection operationdiscovered XenDesktop user/device licenses or both XenDesktop user/device andXenDesktop concurrent licenses.

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

Configuring XenApp License Information from theCommand Line

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

Configuring XenApp Server Role License Information

17

18

Configuring XenApp Using theWizard-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.

● Create. After you install XenApp on the first server, that server is where you createa new farm during configuration.

● Join. After you install XenApp on other servers, you add each server to (join) anexisting farm.

● Prepare this server for imaging and provisioning. (Valid only if the XenApp serverrole was previously configured) Prepares the server for imaging.

● Leave. (Valid only if the XenApp server role was previously configured) Removesthe server from the farm.

The remainder of this procedure assumes you are creating a new farm or adding aserver to a farm.

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

● Enter a farm name, up to 32 characters (can include spaces). If you are using Oracleas 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 Citrixadministrator. The administrator has full permissions to the farm and can createadditional administrator accounts.

5. Select the data store database type and connection information.

If you choose theentry for

Action

New database When creating a farm, the Server Configuration Tool installs theMicrosoft SQL Server Express database automatically, with theinstance name CITRIX_METAFRAME and database name MF20.The database uses Windows authentication.

Existing MicrosoftSQL Serverdatabase

You are prompted for the instance name, the database name,and the authentication method. This database can be locatedon a remote SQL server.

Existing Oracledatabase

You are prompted for the Net Service name. (The Oracle entryappears only if the Oracle client is installed on the server whereyou are configuring the XenApp role.)

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 aserver or system administrator. The Server Configuration Tool adds two databaseadministrators to SQL Server Express: (local)\administrators and the suppliedcredentials for the local or domain user.

When adding a server to (joining) a farm, you can optionally test the connection to thedatabase. The result does not affect Server Configuration Tool operations.

7. The default session shadowing settings (which allow shadowing) are recommended formost farms. Shadowing settings supplied during XenApp configuration override systemor domain policy for user-to-user shadowing.

Important: Shadowing features are permanent and should be changed only if youwant to permanently prevent system or domain policy from affecting that setting. Ifyou disable shadowing or change shadowing features during configuration, you cannotreconfigure them later.

Option Description

Prohibit shadowing ofuser session on thisserver

Disables user session shadowing on this server. If selected,shadowing cannot be enabled on this server throughpolicies. Default = unselected

Allow shadowing ofuser sessions on thisserver

Enables user session shadowing on this server. Default =selected

When you enable shadowing, you can apply the followingfeatures (default = all unselected):

● Prohibit remote control. If selected:

● Authorized users can view sessions but do not havekeyboard and mouse input

● Remote control is permanently prohibited; thiscannot be enabled on this server through policies.

● Force a shadow acceptance prompt. If selected:

● Authorized users must send an acceptance promptwhen attempting to shadow a session.

● A shadow acceptance prompt is shown on everyshadowing attempt; this cannot be disabled on thisserver through policies.

● Force logging of all shadow connections. If selected:

● All shadowing attempts, successes, and failures arelogged in the Windows event log.

● Shadow connections are always logged; this cannotbe disabled on this server through policies.

8. If you do not change the following server settings, the Server Configuration Tool usesdefault values.

Configuring XenApp Using the Wizard-based Server Configuration Tool

19

Setting Description

Data Collection Specify the server mode and zone name.

● (Displayed only when joining a farm) Select a servermode:

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

● Enable Session-host mode only. This server canhost sessions but cannot serve as a data collectoror XML broker.

For more information about server modes, see XenAppServer Mode.

● The default zone name is ‘Default Zone.’ To create acustom zone name, select the checkbox and enter thename.

XML Service Citrix XML Service port. For more information, see CitrixXML and IIS Integration.

Receiver Server name or URL of the Web Interface server used bythe Citrix Receiver.

Remote DesktopUsers

Only members of the Remote Desktop Users group canconnect to published applications. Until you add users tothis group, only administrators can connect remotely to theserver. Select one or more of the following.

● Add Anonymous users. Adds anonymous users to theRemote Desktop Users group. Default = selected

● Add the Authenticated users. Adds current (andfuture) domain accounts in the Windows Users group tothe Remote Desktop Users group. Default = unselected

● Add the list of users from the Users group. Adds allcurrent users from the Users group to the RemoteDesktop Users group. If you add users later, you mustadd 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, orPower and Capacity Management features on this server, specify the requestedinformation to enable communications with them. (The feature roles use separate toolsfor their configuration.)

10. Review the summary page.

After you click Apply, a display indicates configuration progress and the result. If theconfiguration fails, click View Log to display the configuration log.

After configuration completes, you are returned to the XenApp Server Role Manager, whichindicates if any requirements remain.

Configuring XenApp Using the Wizard-based Server Configuration Tool

20

● If you have not yet configured XenApp license information, click Specify licensing.

● To initiate a server restart, click Reboot.

Configuring XenApp Using the Wizard-based Server Configuration Tool

21

22

Configuring XenApp from the CommandLine

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

Command ConventionsSeveral options use Boolean values (true or false).

● If you omit an option that requires a Boolean value, the default value is used. Forexample, 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, theoption default value is true. For example, for the /AddLocalAdmin:True|False option, ifyou 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. Forexample, you can group the standard Pause, Confirm, and NotStrict options as a singleenvironment variable. You can also use environment variables in the command-line optionvalues (for example, /ServerName:%currentServer%, where currentServer is defined as anenvironment variable).

Return CodesThe XenAppConfigConsole command supports the following return codes:

Value Meaning

0 Success

1 Invalid command-line options - for example, the command includes theoptions /ServerName:server_name and /ExecutionMode:Create (an optionthat is valid only when joining a farm was specified when creating a farm)

2 Unmatched parameters - an unrecognized option was specified

3 Invalid parameters - for example, for an option that requires a Boolean value(that is, True or False), you specified 'Bob'

4 Commit failed - the configuration process did not complete; check the logfile for details

Mapping of Earlier XenApp Version Properties toOptions

XenApp versions earlier than 6.0 supported installation and configuration properties. Someof those properties have equivalent options in XenApp 6.

Property in Earlier XenApp Version Option in XenApp 6

CTX_MF_FARM_SELECTION /ExecutionMode

CTX_MF_NEW_FARM_NAME /FarmName

CTX_MF_DOMAIN_NAME, CTX_MF_USER_NAME /CitrixAdministratorAccount:domain\user

CTX_MF_SILENT_DSNFILE /DsnFile

CTX_MF_ODBC_USER_NAME /OdbcUserName

CTX_MF_ODBC_PASSWORD /OdbcPassword

CTX_MF_LICENSE_SERVER_NAME /LicenseServerName

CTX_MF_LICENSE_SERVER_PORT /LicenseServerPort

CTX_MF_ZONE_NAME /ZoneName

CTX_MF_XML_PORT_NUMBER,CTX_MF_XML_CHOICE

/CustomXmlServicePort

CTX_MF_SHADOWING_CHOICE:yes /ProhibitShadowing:false

CTX_MF_SHADOW_PROHIBIT_REMOTE_ICA /ProhibitRemoteControl

CTX_MF_SHADOW_PROHIBIT_NO_NOTIFICATION /ForceShadowPopup

CTX_MF_SHADOW_PROHIBIT_NO_LOGGING /ForceShadowLogging

CTX_MF_ADD_ANON_USERS /AddAnonymousUsersToRemoteDesktopUserGroup

CTX_MF_CREATE_REMOTE_DESKTOP_USERS /AddUsersGroupToRemoteDesktopUserGroup

Configuring XenApp from the Command Line

23

24

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 RemovingRoles 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 thecurrent context.

/Confirm

Displays a confirmation message before modifying the server. This can be useful whentesting for correct use of command options.

/Pause

Pauses the executable after processing completes. This prevents the command promptfrom 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 afunction call; the symbols << indicate a function return. Default: C:\Windows\Temp

General farm information options

/ExecutionMode:Create | Join | Leave | ImagePrep

(Required) Specifies the task to perform.

● Create. After you install XenApp on the first server, that server is where youcreate a new farm during configuration.

● Join. After you install XenApp on other servers, you add each server to (join) anexisting 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) Removesthe server from the farm.

/FarmName:name

(Required and valid only with /ExecutionMode:Create) Specifies the farm name, up to32 characters (can include spaces). If you are using Oracle for the ConfigurationLogging database, do not use hyphens in the farm name.

/CitrixAdministratorAccount:domain\user

(Required and valid only with /ExecutionMode:Create) Specifies the domain andusername for the user who will be the first Citrix administrator. The administrator hasfull 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 inthe local Administrators group. Default = False

/ImaWorkerMode: True | False

(Valid only with /ExecutionMode:Join) Enables or disables ability of the server to be adata 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 byusing the /SimpleDB option when creating the XenApp farm. When joining a farm thatuses that database, use the /ServerName option to specify the name of the XenAppserver 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.

Configuration Command Syntax

25

/ServerName:name

(Valid only with /ExecutionMode:Join and required with /SimpleDB) Specifies thename of the server where the XenApp farm was created (that is, where the SQL ServerExpress 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 theform <DBMACHINE>\<USER> or <DOMAIN>\<USER>. SQL Server Express requires anexisting 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:

● 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.

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

Session shadowing options

Configuration Command Syntax

26

Important: Citrix recommends using the default values (that is, do not specify them inthis command). Shadowing settings specified during XenApp configuration overridesystem or domain policy for user-to-user shadowing. Shadowing features arepermanent and should be changed only if you wish to permanently prevent system ordomain policy from affecting that setting. If you disable shadowing or changeshadowing 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 keyboardand mouse input. Default = False

/ForceShadowPopup:True | False

(Valid only if shadowing is enabled) Enables or disables sending a shadowingacceptance popup. When this option is true, authorized users must send anacceptance prompt when attempting to shadow a session. Default = False

/ForceShadowLogging:True | False

(Valid only if shadowing is enabled) Enables or disables logging of all shadowconnections. When this option is true, all shadowing attempts, successes, and failuresare 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 IISIntegration.

/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 notconfigured (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 theserver. 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 Usersgroup to the Remote Desktop Users group. Default = False

Configuration Command Syntax

27

/AddUsersGroupToRemoteDesktopUserGroup:True | False

Enables or disables adding all current users from the Users group to the RemoteDesktop Users group. If you add users later, you must add them manually to theRemote 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 currentserver instance from the XenApp farm. Default = True

/PrepMsmq:True | False

(Valid only with /ExecutionMode:ImagePrep) Enables or disables resetting the MSMQ IDduring 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 equivalentLGPO settings to NotConfigured. Default = True

Important: If you enable removal of the database information, XenApp assumes anActive Directory policy will provide database settings. If a policy is not applied, theserver will not restart.

Feature and component options

/SmartAuditorServerName:name

(Required if you installed the SmartAuditor agent on the XenApp server) Specifies thename 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.

Configuration Command Syntax

28

/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

ExampleThe following command, issued from the typical XenApp Server Configuration Tool location(C:\Program Files (x86)\Citrix\XenApp\ServerConfig\XenAppConfigConsole.exe), joins theserver to the farm, specifying database credentials and the DSN file location, license serverand model information, log file location, and Remote Desktop User Group configurationsettings.

“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

Configuration Command Syntax

29

30

Preparing for XenApp Imaging andProvisioning

Primary deployment methods for XenApp servers include server imaging, virtualization, andprovisioning. Separation of the XenApp server role installation and configuration tasks offersflexibility in deciding when to capture (create) XenApp images.

Provisioning a XenApp server uses one of three typical approaches; the approach you usedepends on when you configure XenApp (earlier or later) in your preparation steps. TheXenApp server joins its farm on the first restart (reboot) after configuration; this ensuresthat the XenApp server image joins or rejoins the farm after it has been cloned with itsfinal identity.

Important: Cloning is not supported for the first server in the farm (where you createdthe farm during configuration), and should be used only for creating new member serversfor an existing farm.

The following descriptions assume you already created a XenApp farm containing at leastone server. You need the data store database information and credentials for the farm.

Approach 1: Capture an image after XenAppinstallation, but before configuration and restart

In this approach, you install the XenApp server role, but wait to configure XenApp (join afarm) until after the server is cloned and booted. XenApp server configuration isautomated, 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 restartthe server to ensure the system path is updated properly before installing otherapplications.

2. Install your applications and configure the settings you want in your image. Deployingprerequisites such as Remote Desktop Services roles may require a server restart beforeyou 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 XenAppserver (including farm information) using the XenAppConfigConsole.exe command. Thescript then restarts the server, whereupon the server joins the farm.

You can set up scripts using typical methods such as Active Directory startup scripts orthe RunOnce registry key.

5. Capture an image of the server.

Approach 2: Capture an image after XenAppinstallation and configuration, but before restart

In this approach, you install and configure the XenApp server role, but wait to restart theserver until after it is cloned. When the server restarts as a clone of the original image, itjoins the farm with its new identity.

You do not need direct access to your database server or network during configuration, sothis approach can be used to prepare XenApp images for remote deployments. If you do notor cannot verify your database credentials, and they are invalid, XenApp will not join thefarm 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 Servicesroles 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 theserver.

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 MicrosoftMessaging Queuing (MSMQ), use Approach 3.

Approach 3: Capture or update an image after XenAppinstallation, configuration, and restart

If you require XenApp to be installed and working before you create a final image, you mustremove the server from the farm, then rejoin the farm before your final shutdown (forexample, after sysprep), so that the server will join the farm on the next restart, with itsnew identity.

1. Install the XenApp server role.

Optionally, install the Provisioning Services Target Device software. This softwareresets your network connection during installation. Failures may occur if you install thiscomponent from a network location. Although these failures are not commonly harmful,Citrix recommends installing the Provisioning Services Target Device software from aDVD, 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.

Preparing for XenApp Imaging and Provisioning

31

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

● If you are working with an image template that you do not want to keep in thecurrent farm, select the Remove this current server instance from the farmcheckbox. (For a command-line configuration, use the /RemoveCurrentServer:Trueoption.)

● If you are provisioning the XenApp server with SmartAuditor or other features thatdepend on MSMQ, selecting the Prepare Microsoft Messaging Queuing provisioningcheckbox 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, thedefault database information is removed from local settings (server, database, andfailover partner entries are removed from the DSN file; LGPO is set toNotConfigured). This ensures that cloned servers can join only a XenApp farm thatis 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 Directorypolicy will provide database settings. If a policy is not applied, the IMA Servicewill 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 imageIf a golden image requires updating (for example, with Citrix or Windows hotfixes, orthird-party applications and patches), you can reseal the image. This procedure is similar toapproach 3.

1. Boot into the image to make modifications. The XenApp server will try to join the farmif it can.

2. Modify the server as needed.

3. Proceed with step 4 in Approach 3.

During the resealing process, the Server Configuration Tool:

● Removes server-specific information, such as WSID in MF20.dsn, WSID inRadeOffline.dsn.

● Creates a unique Secure Ticket Authority (STA) ID in CtxSta.config, using the MACaddress.

● Resets the local databases and removes the Servers setting from the IndependentManagement Architecture (IMA) data store by clearing the IMA local host cache and

Preparing for XenApp Imaging and Provisioning

32

RadeOffLine databases.

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

● 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 ConsiderationsFor provisioning purposes, you can install the XenApp server role using the wizard-basedXenApp Server Role Manager or the command line. For wizard-based installations, do notproceed to configuring the XenApp server role until you are ready, based on the approachyou select.

Configuring the XenApp server after it is instanced (approach 1) should be automated usingthe command line. You can use the wizard-based XenApp Server Configuration Tool or thecommand line to configure the XenApp server if you choose approach 2 or 3.

When preparing a XenApp server for imaging and provisioning:

● 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 beforerunning XenConvert; otherwise, the SSL certificate will be distributed to all provisionedXenApp 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 excludesinstallation 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 beremoved from the current farm, and when the server image boots, it will contain a uniqueMSMQ machine identifier. Database identification information will be removed from the DSNfile.

Preparing for XenApp Imaging and Provisioning

33

“C:\Program Files (x86)\Citrix\XenApp\ServerConfig\-XenAppConfigConsole.exe" /ExecutionMode:ImagePrep /RemoveCurrentServer:True /PrepMsmq:True /ClearLocalDatabaseInformation:True

Preparing for XenApp Imaging and Provisioning

34

35

Removing Roles and Components

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

● XenApp

● Receiver Storefront

● Web Interface

● Licensing

● Single sign-on service

● Provisioning server

Important: Although you can use Windows Programs & Features to remove the XenApp6.5 roles listed above, Citrix strongly recommends using the Server Role Manager.

To remove other roles (such as EdgeSight server, SmartAuditor server, Power and CapacityManagement administration components, Secure Gateway), use Windows Programs &Features.

You cannot use the XenApp 6.5 Server Role Manager to remove fully-integrated roles in anearlier 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 serverfrom the XenApp farm.

Removing Roles and Components Using theWizard-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 areautomatically selected; you cannot change this (that is, you cannot remove the rolewithout 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 IISIntegration default component or the Windows Enhanced Desktop Experience optionalcomponent.

Required role components are not listed. The Receiver for Windows and the OfflinePlug-in are automatically installed with the XenApp server role; you cannot removethem 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 theCommand 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, typethe 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.

Removing Roles and Components

36

/uninstall:items

Comma-delimited list of roles and components to remove. Valid values are:

● 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 DesktopExperience components. The Receiver for Windows and the Offline Plug-in areremoved when you remove the XenApp server role.

Important: When using the XenAppSetupConsole.exe command to remove roles orcomponents, do not specify options that configure the XenApp role.

ExamplesThe 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

Removing Roles and Components

37

38

Data Store Database Reference

See the database vendor documentation before installing, configuring, and using thedatabase software. CTX114501 contains information about supported database versions.

If you use a Microsoft SQL Server 2008 Express database for the farm data store, XenAppconfiguration automatically installs it.

Important:

● Citrix does not support case-sensitive databases.

● To avoid corruption, do not directly edit data in the data store database with utilitiesor tools other than those provided by Citrix.

Maintaining, Backing up, and Restoring a XenAppData Store

Most database maintenance requires running the dsmaint and dscheck server utilities onXenApp farm servers. The XenApp Server Utilities Reference contains syntax and usedetails.

Use dsmaint to:

● 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 Cacheindefinitely, provided it can contact the license server. However, you cannot make anymodifications to the farm or use the AppCenter.

Create a backup copy of the data store (dsmaint backup). Without a backup, you mustmanually recreate all of the farm policies, settings, accounts, and other persistent data inthe data store.

To restore a backup database or to migrate to a new server, use the dsmaint migrateutility. Without a backup, prepare a new data store the way you did before configuringXenApp and run the XenApp Server Configuration Tool from any farm server. After runningthe Server Configuration Tool, manually reenter the lost settings. If you use the same nameas the previous data store, you do not need to reconfigure the farm servers.

39

Microsoft SQL Server Database

The server hosting the Microsoft SQL Server database should meet the following minimumrequirements:

● Approximately 100MB of disk space for every 250 servers and 50 published applicationsin the XenApp farm. Provide more disk space for greater numbers of publishedapplications.

● Set the "temp" database to automatically grow on a partition with at least 1GB of freedisk space. Citrix recommends 4GB if the farm is large and includes multiple printdrivers.

The default database installation settings and database sizes usually suffice for XenAppdata store needs.

Microsoft SQL Server supports Windows and Microsoft SQL Server authentication. Forhigh-security environments, Citrix recommends using Windows authentication only.

The user account for installing, upgrading, or applying hotfixes to the data store must havedatabase owner (db_owner) rights to the database. When you finish installing the databasewith database owner rights, set the user permissions to read/write only to increase thesecurity of the database. Change the rights back to database owner before installing servicepacks or feature releases; installations can fail if the user account used to authenticate tothe data store during Setup does not have database owner rights.

When using Microsoft SQL Server in a replicated environment, use the same user accountfor the data store on each Microsoft SQL Server.

Each farm requires a dedicated database. However, multiple databases can be running on asingle server running Microsoft SQL Server. Do not configure the farm to use a database thatis shared with any other client/server applications.

Back up the database regularly and follow Microsoft recommendations for configuringdatabase and transaction logs for recovery (for example, setting the Truncate log onCheckpoint option to control log space).

Using Sockets to Connect to a Microsoft SQL ServerDatabase

Two protocols used to connect to a database are TCP/IP sockets and named pipes. Namedpipes is an authenticated communication protocol, so any time you attempt to open aconnection to the SQL Server database using this protocol, the Windows authenticationprocess occurs. TCP/IP sockets do not rely on Windows authentication to establish aconnection, but do provide user/password authentication to the database after theconnection is established. Windows authentication reduces the possibility of an erroroccurring when the server hosting SQL Server and the XenApp server do not have thecorrect domain or Active Directory trust relationship. Therefore, Citrix recommends usingTCP/IP sockets.

If you use named pipes, manually enable the named pipes option on the database serverusing the Surface Area Configuration tool packaged with SQL Server.

Creating a Microsoft SQL Server Data SourceConnection

1. On the Create a New Data Source to SQL Server screen, enter the data sourcedescription 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 duringconfiguration and change its client configuration to use TCP/IP.

To modify a DSN, use the Windows ODBC Data Source Administrator utility to open theFile DSN, which is located by default in the %ProgramFiles(x86)%\Citrix\IndependentManagement Architecture folder, and select TCP/IP as the connection protocol for theclient configuration.

Using Failover with Microsoft SQL ServerFor fault tolerance with Microsoft SQL Server, use Microsoft clustering, which providesfailover and failback for clustered systems. Failover of the SQL Server database in aclustered environment is transparent to XenApp.

The database files for an instance of Microsoft SQL Server are placed in a single clustergroup owned by the node on which the instance is installed. If a node running an instance ofMicrosoft SQL Server fails, the cluster group containing the data files for that instance isswitched to another node. The new node already has the executable files and registryinformation for that instance of Microsoft SQL Server on its local disk drive, so it can start

Microsoft SQL Server Database

40

up an instance of Microsoft SQL Server and start accepting connection requests for thatinstance.

Microsoft Cluster Services clustering does not support load balancing among clusteredservers because it functions in active/passive mode only.

Using Distributed Databases with Microsoft SQLServer

XenApp supports distributed (replicated) databases. Replicated databases are useful whentoo many read requests to the data store create a processing bottleneck. Microsoft SQLServer uses replication to create the distributed database environment.

XenApp requires data coherency across multiple databases. Therefore, a two-phase commitalgorithm is required for storing data in the database. When configuring Microsoft SQLServer 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 TextReplication 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) andSubscribers (remote sites) using Microsoft SQL Server Enterprise Manager.

2. Run the dsmaint publishsqlds command on a server in the farm. This executes thenecessary SQL statements to create the published articles on the current Microsoft SQLServer (Publisher).

3. Configure the remote sites (Subscribers) to subscribe to the published articles createdin the previous step.

Microsoft SQL Server Database

41

42

Oracle Database

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

● Approximately 100MB of disk space for every 250 servers and 50 published applicationsin 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 Oracleauthentication only; it does not support Windows authentication.

In the Oracle sqlnet.ora file, set SQLNET.AUTHENTICATION_SERVICES= (NONE). The defaultsetting (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 restartthe server before you install XenApp.

The Oracle user account must be the same for every server in the farm because all XenAppservers share a common schema.

If you are using one database to hold information for multiple farms, each farm representedin the database must have a different user account because the data store information isstored in the Oracle user account.

The account used to connect to the data store database has the following Oraclepermissions:

● Connect

● Resource

● Unlimited Tablespace (optional)

Consider the following guidelines when configuring an Oracle server.

● Use Shared/Multi-Threaded Server mode to reduce the number of processes in farmswith more than 100 servers (performance may be affected during periods of high datastore load).

● If you are using Multi-Threaded Server mode, verify that values in the Init.ora file aregreater than or equal to the following values. If you are running multiple farms on thesame Oracle database, include all XenApp servers in the calculations. Round upfractional values.

shared_servers = Number of servers / 10

max_shared_servers = Number of servers / 5

Where Number of servers is the total number of servers running XenApp.

● When using an Oracle server in dedicated mode, add one additional process for eachserver connected directly to the Oracle database. For example, if the Oracle serveruses 100 processes before installing XenApp, and the farm has 50 servers, set theprocesses 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 anunresponsive database.

● If you are using the same Oracle database for multiple server farms, create a uniquetablespace with its own user name and password for added security for each farm. Donot use the default system account within Oracle.

● Maintain a standby database for quick disaster recovery. A standby database maintainsa copy of the production database in a permanent state of recovery.

Using Distributed Databases with OracleOracle uses replication to create the distributed database environment. To reduce the loadon a single database server, install read/write replicas and distribute the farm serversevenly across the master and replicas.

XenApp requires data coherency across multiple databases. Therefore, a two-phase commitalgorithm is required for writes to the database.

Using Oracle as a distributed database solution has the following requirements:

● 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 beSQL*Net Version 2 or Net8.

● Install the farm data store database first on the master site, then configure replicationat the sites used for database replication snapshots.

● Replicate all objects contained in the data store user schema (tables, indexes, andstored procedures).

If the performance at the replicated database site is significantly slower, verify that all theindexes for the user’s schema are successfully replicated.

When configuring Oracle for a two-phase commit:

● Use synchronous snapshots that can be updated with a single master site. XenApprequires 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.

Oracle Database

43

● 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 areinitiated from the remote site, they can block local data transfers (because allconnections share a set of worker threads). To remedy this, increase the value of theMax_Mts_Servers parameter in the Init.ora file.

Oracle Database

44