Citrix EdgeSight Installation Guide

Citrix EdgeSight for Endpoints 5.3 Citrix EdgeSight for XenApp 5.3

Copyright and Trademark Notice Use of the product documented in this guide is subject to your prior acceptance of the End User License Agreement. A printable copy of the End User License Agreement is included on your product installation media. Information in this document is subject to change without notice. Companies, names, and data used in examples herein are fictitious unless otherwise noted. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of Citrix Systems, Inc. 2010 Citrix Systems, Inc. All rights reserved. Citrix is a registered trademark, and Citrix Presentation Server, Citrix XenApp, Citrix XenDesktop, and EdgeSight are trademarks of Citrix Systems, Inc. in the United States and other countries. Trademark Acknowledgements
Adobe, Acrobat, and Flash are trademarks or registered trademarks of Adobe Systems Incorporated in the U.S. and/or other countries. Microsoft, System Center, Windows, Windows Server, and Internet Explorer are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.

All other trademarks and registered trademarks are the property of their respective owners. Document Code: July 13, 2010 (MS)

C ONTENTS

Contents

Chapter 1

Installation Overview
Server Installation Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9 Agent Deployment and Installation Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . .10 Active Application Monitoring Installation Overview . . . . . . . . . . . . . . . . . . . . . .10 Pre-Installation Considerations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11 System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13 Agent Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13 Server Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15 IIS 7.0 Components Required on Windows Server 2008 Systems . . . . . . .17 Requirements for Monitoring Session Experience. . . . . . . . . . . . . . . . . . . . . . .18 Requirements for Monitoring Citrix License Servers . . . . . . . . . . . . . . . . . . . .18 Requirements for Forwarding Alerts to System Center Operations Manager. .19 Browser Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19 Operating System Language Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20 Citrix License Server for Windows Requirements. . . . . . . . . . . . . . . . . . . . . . .20 Active Application Monitoring Requirements . . . . . . . . . . . . . . . . . . . . . . . . . .21 Virtual Desktop Monitoring Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . .21 Software Configuration Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22 Configuring Antivirus Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22 Configuring Firewalls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24

Chapter 2

Installing Citrix EdgeSight Server

Installing the Citrix EdgeSight License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25 Installing the Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25 Prerequisite Checking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26 Installing a Server Using the User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . .26 Setting Server Installation Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29 Installing a Server Using the Command-Line Interface. . . . . . . . . . . . . . . . . . .31 Running the Post-Installation Setup Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32 Upgrading Citrix EdgeSight Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34 Upgrading from Versions of EdgeSight Server Prior to 5.0 SP2. . . . . . . . . . . .35

Citrix EdgeSight Installation Guide

Uninstalling Citrix EdgeSight Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35

Chapter 3

Installing Citrix EdgeSight Agents

Installing the Agent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37 Agent Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37 Software Configuration Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38 Antivirus Configuration Checking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38 Installing an Agent Using the User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . .39 Setting Installation Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40 Installing an Agent Using the Command-Line Interface . . . . . . . . . . . . . . . . . .45 Installing the EdgeSight for XenApp Agent in a Streamed Environment . . . . .46 Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46 Installing the EdgeSight Agent on a Master Target Device . . . . . . . . . . . . .47 Configuring Agents Using the Control Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49 Upgrading Agents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50 Uninstalling Agents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51

Chapter 4

Installing EdgeSight for Monitoring Virtual Desktops

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53 Installing EdgeSight Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55 Installing the Agent Database Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56 Setting Up the Agent Data File Share . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57 Before You Install the Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .60 Shutting Down Virtual Desktops . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .61 Setting the vDisk Access Mode to Private . . . . . . . . . . . . . . . . . . . . . . . . . . . . .61 Information Required During Agent Installation . . . . . . . . . . . . . . . . . . . . . . . .62 Installing the Agent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62 Software Configuration Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62 Antivirus Configuration Checking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63 Agent Installation Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63 Installing an Agent Using the User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . .63 Installing an Agent Using the Command-Line Interface . . . . . . . . . . . . . . . . . .65 Deploying the Agent to Virtual Desktops in a Pool . . . . . . . . . . . . . . . . . . . . . .66 Shutting Down the Master image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66 Setting the vDisk Access Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67 Disabling Maintenance Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67 Agent Database Connection Acquisition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68 Configuring Agents Using the Control Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68 Upgrading EdgeSight Installations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69

Contents

Uninstalling Agents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .70

Chapter 5

Installing EdgeSight Active Application Monitoring Software

Active Application Monitoring Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71 Installing the Active Application Monitoring Components. . . . . . . . . . . . . . . . . . .72 Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .75

Citrix EdgeSight Installation Guide

C HAPTER 1

Installation Overview

This document provides requirements and procedures for installing and performing initial configuration of the following Citrix EdgeSight software components: EdgeSight ServerDisplays performance data for monitored devices EdgeSight for XenApp AgentMonitors the performance of XenApp and Presentation Server systems. Multiple versions of the agent are provided to accommodate different XenApp versions. EdgeSight for Endpoints AgentMonitors the performance of physical clients and XenDesktop 3.0 instances EdgeSight for Virtual Desktops AgentMonitors the performance of XenDesktop 4.0 instances. This agent enables the following features: Collection of ICA channel data including XenDesktop multi-media counters Collection of End User Experience metrics Alerting on XenDesktop session performance

EdgeSight Agent Database ServerStores performance data for agents monitoring virtual desktops EdgeSight Active Application Monitoring ComponentsPerforms automated testing to monitor the end user experience of applications in XenApp and Presentation Server environments

Citrix EdgeSight software is installed using Windows Installer (MSI) files. The EdgeSight Server MSI files are invoked using a bootstrapper program (setup.exe). The following table lists the MSI files by EdgeSight component. Separate MSI files are provided for 32-bit and 64-bit systems for EdgeSight Server and EdgeSight Agents.

Citrix EdgeSight Installation Guide

EdgeSight Component EdgeSight Server (32-bit systems) EdgeSight Server (64-bit systems) EdgeSight for XenApp Agent (32-bit systems) EdgeSight for XenApp Agent (64-bit systems) EdgeSight for XenApp Agent for XenApp 6 (64-bit systems) EdgeSight for Endpoints Agent (32-bit systems) EdgeSight for Endpoints Agent (64-bit systems) EdgeSight for Virtual Desktops Agent (32-bit systems) EdgeSight for Virtual Desktops Agent (64-bit systems) EdgeSight Agent Database Server EdgeSight Active Application Monitoring components (Controller, Launcher, and Web Interface) Citrix License Server

MSI Name EdgeSightServer.msi EdgeSightServerx64.msi EdgeSightXAAgent.msi EdgeSightXAAgentx64.msi EdgeSightXA6Agentx64.msi EdgeSightEPAgent.msi EdgeSightEPAgentx64.msi EdgeSightVDAAgent.msi EdgeSightVDAAgentx64.msi EdgeSightAgentDBS.msi EdgeSight Active Application Monitoring.msi CTX_Licensing.msi

Note: Do not modify the base MSI files. Modifying the base MSI files can interfere with support efforts in case of installation issues. You can customize the installation by specifying options and properties on the command line or by creating a transform. The EdgeSight 5.3 media contains the 5.2 SP1 releases of the EdgeSight for XenApp, EdgeSight for Endpoints, and EdgeSight for Virtual Desktops agents. New EdgeSight 5.3 agents are now available for download from the Citrix Downloads page at: http://www.citrix.com/English/ss/downloads/index.asp. See the EdgeSight 5.3 readme file for additional information.

Important EdgeSight 5.3 agents should be installed whenever possible because they include important fixes and enhancements. EdgeSight 5.2 SP1 agents should only be installed in the following cases:
For use with an EdgeSight Server which is still at version 5.2 If other 5.2 SP1 agents are installed and you want to keep all agents at the same version for maintainability reasons

Chapter 1

Installation Overview

Server Installation Overview

Use setup.exe to install an EdgeSight Web server and database server. After you install and configure the server components, deploy the applicable EdgeSight Agent to XenApp Servers, end-user systems, and virtual desktops. In addition to the software listed in Server Requirements on page 15, EdgeSight Server requires the following software. It is highly recommended that you install the following software before installing EdgeSight Server software. Microsoft SQL Server Reporting Servicesrequired for the generation of historical reports. Reporting Services must be in place before reports can be generated and displayed. For information on configuring Reporting Services for use with EdgeSight software, see Configuring Reporting Services for Citrix EdgeSight. Citrix License Server for Windows 11.6 or laterused to supply a license authorizing the agent to upload data to a Citrix EdgeSight Server. The license server can be installed anywhere on the network and can be shared by multiple EdgeSight servers. The license server and EdgeSight license files must be in place before data can be uploaded to the server. A Citrix License Server MSI is included with the EdgeSight media for your convenience. For more information, see Citrix License Server for Windows Requirements on page 20.

When planning your installation, the required server components can be installed on separate physical machines. (The Web server can be installed on the same machine as the database server, but the machine should have at least two processors.) In all cases, ensure that the machines have sufficient memory and processor capabilities (as described in Server Requirements on page 15) and that the machines are in the same domain. The MSI file installs server files for both EdgeSight for XenApp and EdgeSight for Endpoints. Both products use the same underlying server technologies. You can enable or disable agent support for either product after installation.

10

Citrix EdgeSight Installation Guide

Note EdgeSight Server should not be installed on the same system as XenApp in a production environment, but this can be done to support a proof of concept environment.

Agent Deployment and Installation Overview

Use the applicable EdgeSight Agents MSI file to install EdgeSight agents on target machines. Separate MSI files are provided for each type of agent (EdgeSight for XenApp, EdgeSight for Virtual Desktops, and EdgeSight for Endpoints), for each target system architecture (32-bit and 64-bit), and for XenApp versions (Presentation Server / XenApp 5 and XenApp 6). The EdgeSight for XenApp Agent MSI file provides both the Basic and Advanced versions of the agent. You can deploy agents to end-user systems or XenApp Servers in your enterprise using several methods: Direct command-line or GUI-based installations using the MSI file. Define an Active Directory Group Policy Object for software distribution of the MSI file. Note that GPO push to users is supported. Perform a System Management Server (SMS) issuance of the MSI file.

If you are installing the EdgeSight for Endpoints agent or the EdgeSight for Virtual Desktops agent on virtual desktops, additional software components and installation tasks are required, as described in Chapter 4, Installing EdgeSight for Monitoring Virtual Desktops. Discuss your software deployment environment with your Sales Representative; they can assist you in implementing an effective means of deploying the agent.

Active Application Monitoring Installation Overview

EdgeSight Active Application Monitoring is an automated performance testing tool that periodically samples critical application transactions to monitor the availability and responsiveness of virtualized applications, providing insight into application performance and end-user experience. EdgeSight Active Application Monitoring software includes the following components: Citrix EdgeSight Controllerused to record and create virtual user scripts and define tests. When the test is ready for playback, the Controller instructs the Launchers to run the test for a specific period of time. Citrix EdgeSight Launcherreceives commands from the Controller and generates virtual user ICA sessions on the target Presentation Servers and

Chapter 1

Installation Overview

11

XenApp servers. The number of Launchers required will vary based on the target virtual user load. Web Interface Connectorallows users to connect to applications made available through the XML Service. This feature requires the Visual J# Version 2.0 Redistributable Package available from Microsoft.

Launchers are installed on clients of the Servers that will be under test. They can be installed on systems with the Controller and as stand-alone launchers. See Chapter 5, Installing EdgeSight Active Application Monitoring Software,for installation procedures for these components.

Pre-Installation Considerations
Software running in your environment may need to be configured to allow Citrix EdgeSight software to operate properly. Review the following considerations and related actions and determine if they apply to your environment. Also, review the readme file for additional release-specific requirements. Agent Proxy Servers and SettingsIf the EdgeSight Agent will communicate with the EdgeSight Server through a proxy server, ensure that you have the proxy server IP address, port number, and credentials required prior to installing EdgeSight Agent. See Installing the Agent on page 37 for instructions on specifying proxy server information during agent installation. FirewallsIf firewall software is resident on machines on which EdgeSight Agents will be installed, the listen port on the client machine (port 9035) must be open. This is the port on which the agent listens for remote connections from the browser displaying the EdgeSight console. There is an option during agent installation to automatically set a Windows Firewall exception for the listen port if the firewall is running (enabled or disabled). See Setting Installation Properties on page 40 for instructions on specifying the listen port number. Also see Configuring Firewalls on page 24 for information relating to personal firewalls. Virus scanning softwareIf your environment uses virus scanning software, script blocking features must be disabled to allow the EdgeSight Agent to run scripts. Also, exclude agent data files from being scanned. See Configuring Antivirus Software on page 22 for detailed information on which files should be excluded from scans.

12

Citrix EdgeSight Installation Guide

Server Virus scanning softwareIf your environment uses virus scanning software, script blocking features must be disabled to allow EdgeSight Server to run scripts. Also, exclude the server database from being scanned. See Configuring Antivirus Software on page 22 for detailed information on which files should be excluded from scans. IIS Security Lockdown templateAny IIS Security Lockdown templates must allow the IIS components listed in Server Requirements on page 15 to run. Adjust the template as required. Group PolicyEnsure that Group Policies do not prohibit any of the required software components from running on your EdgeSight Server. Also, ensure that policy changes that would prohibit software components from running are not scheduled for deployment after the installation is complete. SQL Server 2005 Password PolicySQL Server 2005 includes an option to enforce Windows password policy. This option is enabled by default and will cause an error if the passwords supplied for accounts during installation do not meet the necessary strength requirements. If an error occurs containing the text, Password validation failed. The password does not meet Windows policy requirements because it is not complex enough, then double check your password requirements, reattempt installation, and supply appropriately complex passwords. SSL CertificateIf you choose to enable SSL for use on the Citrix EdgeSight Web server, you must either use an SSL certificate from a recognized certificate authority or a correctly generated and installed certificate from Microsoft Certificate Server to allow proper software operation. For detailed information, see Configuring EdgeSight Server and Endpoint Agents to use SSL with Microsoft Certificate Services at the Citrix Support site (http://support.citrix.com/article/CTX111924). SSL certificates which do not meet these criteria do not allow remote pages to be displayed or remote scripts to be run. Attempts to perform these actions without a valid certificate result in an error message. SMTP ServerDuring installation, you must specify an SMTP server. It is important that a valid SMTP server name is used. EdgeSight Server uses the SMTP server for many operations, including the distribution of alert notifications, server error conditions, and new user passwords.

Chapter 1

Installation Overview

13

System Requirements
The following section lists the system requirements for Citrix EdgeSight Agents and the Citrix EdgeSight Server.

Agent Requirements
Agents are available for deployment on 32-bit and 64-bit machines. The agents which can upload to the server include: EdgeSight for Endpoints 5.2 or higher EdgeSight for Virtual Desktops 5.2 or higher EdgeSight for XenApp 5.2 or higher running on 5.0 or 5.0 Feature Pack 2 releases of XenApp EdgeSight for XenApp 6 Agent x64 5.3 (64-bit) running on 6.0 release of XenApp. This version of the agent is only supported for installation on XenApp 6.0 systems and cannot be used with previous XenApp versions.

The target XenApp machine must meet the requirements listed in your XenApp documentation. In addition, the Terminal Services service must be running to properly collect process and network data related to user sessions. (If this service is not running, process and network data cannot be associated with a session and reports dependent on this information show no data.) The EdgeSight for Endpoints agent is designed to be deployed on physical machines. It can also be used to monitor XenDesktop 3.0 instances, but only collects system-related performance data. The system requirements for the Citrix EdgeSight for Endpoint agent are listed in the following table.
OS
Microsoft Windows XP SP2 or higher, Microsoft Windows Server 2003, Microsoft Windows Vista (Business edition or above), Windows 2008, Windows 2008 R2, or Windows 7. Both 32-bit and 64-bit systems are supported on all platforms.

CPU Memory Disk

500 MHz or later recommended 128 MB of RAM (256 MB recommended) 100 MB free space (25 MB of disk space for product installation and 75 MB disk space for the database).

The EdgeSight for Virtual Desktops Agent is designed to be deployed on XenDesktop 4.0 instances. The agent collects both system-related and sessionrelated performance data. The system requirements for the Citrix EdgeSight for Virtual Desktops agent are listed in the following table.

14

Citrix EdgeSight Installation Guide

OS

Microsoft Windows XP SP2 or higher, Microsoft Windows Server 2003, Microsoft Windows Vista (Business edition or above), Windows 2008, Windows 2008 R2, or Windows 7. Both 32-bit and 64-bit systems are supported on all platforms.

CPU Memory Disk

500 MHz or later recommended 128 MB of RAM (256 MB recommended) 30 MB free space.

Note The EdgeSight for Virtual Desktops Agent is not designed to monitor the Desktop Delivery Controller (DDC) in a XenDesktop farm.
The EdgeSight agent installers check the operating system on the target machine. This helps ensure that the correct agent is installed on various devices. Attempts to install the Citrix EdgeSight for Endpoint agent on any system running a server operating system will result in a warning notifying you that you may be installing the wrong product. You have the option to continue installation. During a silent installation to a system running a server OS, the install fails unless the ALLOWSERVEROS property is set to 1. A message indicating the cause of installation failure is placed in the install log. Attempts to install the Citrix EdgeSight for Endpoint agent on a virtual desktop running XenDesktop 4.0 will result is a message being displayed notifying you that you may be installing the wrong product. You have the option to continue installation. During a silent installation to a system running a XenDesktop 4.0, the install fails unless the ALLOWVIRTUAL property is set to 1. A message indicating the cause of installation failure is placed in the install log. Any attempt to install the Citrix EdgeSight for XenApp agent on a computer not running Terminal Server in Application Mode will fail. (Note that the agent installation does not check to ensure that the Terminal Server is properly licensed.) There is no override.

Chapter 1

Installation Overview

15

Server Requirements
The system requirements for the Citrix EdgeSight Server are listed in the following table.
Web Server OS Windows Server 2008 R2, Windows Server 2008, or Windows Server 2003 SP1 or later. Both 32-bit and 64-bit systems are supported. Internet Information Services (IIS) 7.0 for Windows Server 2008. See IIS 7.0 Components Required on Windows Server 2008 Systems on page 17 for a list of specific components. Internet Information Services (IIS) 6.0 for Windows Server 2003 Citrix License Server for Windows (This can be installed on a separate system; see Citrix License Server for Windows Requirements on page 20 for more information.) Microsoft Message Queuing (MSMQ), Common components only Microsoft .NET Framework 3.5 SP1 Note: To support the forwarding of alerts to Microsoft System Center Operations Manager (SCOM), the SCOM agent must be installed on the EdgeSight Web server. See Requirements for Forwarding Alerts to System Center Operations Manager on page 19 for more information. Note the following configuration requirements: Default Web Site running ASP.NET allowed in IIS IWAM and IUSR users active and enabled IIS_WPG group enabled and ASPNET user enabled (if using Windows Server 2003) CPU Memory Disk 2 gigahertz (GHz) or faster CPU 2GB of RAM recommended. 512MB of RAM required. Minimum 2 GB free space

16

Citrix EdgeSight Installation Guide

Database Server OS Windows Server 2008 or Windows Server 2003 SP1 or later. Both 32-bit and 64-bit systems are supported on all platforms. The server edition must support SQL Server. See SQL Server Books Online for information on system requirements. SQL Server 2008 (Standard or better) or SQL Server 2005 SP2 or later (Standard or better). Note that SQL Server 2008 R2 is not supported, Important: Note the following configuration requirements: In SQL Server 2008, the Reporting Services Role called Manage Shared Schedules no longer exists as a stand-alone role; it is now part of the System Administrator Role. For more information, see Configuring Reporting Services for Citrix EdgeSight. SQL Server must be configured for case-insensitive collation. Case-sensitive collation is not currently supported for this release. SQL Server should be configured to use Windows Authentication or MixedMode Authentication. Reporting Services is included with SQL Server 2008 and SQL Server 2005. Reporting Services can be installed on a separate machine from the data source. SQL Agent Service running and set to start automatically (if Reporting Services is installed on the machine) CPU Memory Disk 2 GHz or faster CPU 2GB of RAM recommended. At least 1 GB of RAM required. Minimum 20 GB free space

Database

Agent Database Server The agent database server is only required if EdgeSight for Virtual Desktops Agents or EdgeSight for Endpoints Agents are used to monitor virtual desktops. The server can be installed on a physical or a virtual machine. See Virtual Desktop Monitoring Requirements on page 21 and Chapter 4, Installing EdgeSight for Monitoring Virtual Desktops for more information. OS CPU Memory Disk Windows Server 2008 or Windows Server 2003 SP1 or later. 2 GHz or faster CPU 2GB of RAM recommended. At least 1 GB of RAM required. Typical disk space usage is generally 70 MB per virtual desktop for the databases on a single disk.

Chapter 1

Installation Overview

17

Note The Web Server (IIS), Database Server (SQL Server), and Reporting Services can be installed on the same machine. We recommend having at least 2 CPUs in such a configuration.

IIS 7.0 Components Required on Windows Server 2008 Systems

Specific IIS 7.0 components are required on a Windows Server 2008 system which will be hosting an EdgeSight Server. These components are checked by the bootstrapper program. When configuring IIS 7.0, ensure that the following role services are selected under the Web Server role: Static Content Default Document ASP.NET ISAPI Extensions ISAPI Filters Windows Authentication Request Filtering The following Management Tools: IIS 6 Management Compatibility IIS 6 Metabase Compatibility IIS 6 WMI Compatibility IIS 6 Scripting IIS 6 Management Console

18

Citrix EdgeSight Installation Guide

Requirements for Monitoring Session Experience

EdgeSight for XenApp provides highly granular session experience monitoring data collected through XenApp and ICA client instrumentation. This data includes metrics on network bandwidth, ICA round trip time, and client and server startup time. Collection of these metrics depends on the following set of software components: EdgeSight Agent running on the Presentation Server or XenApp server Presentation Server 4.5 (or later) or XenApp 5.0 Enterprise or Platinum Edition ICA client version 10 or later

See the Citrix EdgeSight Administrators Guide for more information on data collection in relation to software component versions.

Requirements for Monitoring Citrix License Servers

The License Server Monitoring feature is designed to monitor Citrix License Server for Windows 11.5 or later. The feature is not dependent on the EdgeSight agents, because license servers are polled directly by EdgeSight Server. License servers must be explicitly identified using the EdgeSight Server Console before they are monitored for license type, usage, and availability.

Chapter 1

Installation Overview

19

Requirements for Forwarding Alerts to System Center Operations Manager

An alert action can be configured to forward EdgeSight alerts generated from EdgeSight for XenApp agents to System Center Operations Manager (SCOM). Currently, SCOM 2007 SP1 and SCOM 2007 R2 are supported. The following software must be installed to enable the forwarding of alerts: The following management packs must be imported to the Operations Manager 2007 Server: Citrix Library Management Pack (Citrix.Library.mp) Citrix XenApp Management Pack (Citrix.PresentationServer.mp) Citrix EdgeSight Management Pack (Citrix.EdgeSight.mp, provided on the Citrix EdgeSight media)

The following software must be installed on the XenApp system being monitored EdgeSight for XenApp Agent Operations Manager Agent

The following software must be installed on the EdgeSight Server from which alerts will be forwarded: Operations Manager Agent Operations Manager Console or Operations Manager Authoring Console.

Currently, only alerts from by EdgeSight for XenApp agents can be forwarded. See the Citrix EdgeSight Administrators Guide for detailed instructions on enabling alert forwarding from EdgeSight to SCOM.

Browser Requirements
EdgeSight Server Console users must have Internet Explorer version 7.0 or greater with JavaScript enabled. The following table lists software components that are required on systems from which users access the EdgeSight Server Console:

20

Citrix EdgeSight Installation Guide

Software Microsoft Excel (as included with Microsoft Office 2003 or Microsoft Office 2007)

Used to... Display remote reports from the EdgeSight Server Console. Note: Ensure that Visual Basic for Applications is selected from Office Shared Features when customizing the Microsoft Excel installation.

Adobe Flash Player 10.0 or Display Flash-based reports and consoles. (Not currently later available on 64-bit browsers.) If you do not have Flash Player installed on your system, you will be prompted to download the software. Adobe Acrobat Reader Display reports exported in a PDF format.

Operating System Language Support

Operating system languages must match in configurations where the EdgeSight database and Web server are installed on separate machines.

Citrix License Server for Windows Requirements

Important If the License Management Console and EdgeSight Server are installed on the same machine, install the EdgeSight Server before installing the License Management Console. Installing the License Management Console before installing the EdgeSight Server will result in the inability to access the EdgeSight Server web site.
EdgeSight requires Citrix License Server for Windows 11.6 or later. The license server can be installed from the EdgeSight media (EdgeSight Component Installers > Install Citrix Licensing). The license server can be installed on the same system as the EdgeSight Web server, or can be installed on another system, as long as it is accessible by the Web server. The license server can be shared by multiple EdgeSight servers. If the license server is not installed and running, license information cannot be obtained and EdgeSight Agents are not allowed to upload data to the EdgeSight Server. You will receive instructions by email for downloading EdgeSight license keys. For documentation on licensing, see the Citrix Licensing documentation on the Knowledge Center (http:// support.citrix.com/) See Getting Started with Citrix Licensing Guide for system requirements and installation instructions. When installing the license server, accept the defaults provided by the MSI file for the destination folder and the license file location. When selecting features, you can choose whether to select the License Management Console; this feature is not required, but may be useful in managing your licenses.

Chapter 1

Installation Overview

21

Active Application Monitoring Requirements

The system requirements for systems running the EdgeSight Active Application Monitoring Controller and Launcher are listed in the following table.
Controller and Launcher Requirements OS Controller Microsoft Windows Vista, Microsoft Windows XP, Microsoft Windows 7, Microsoft Windows Server 2003, Microsoft Windows Server 2008, and Microsoft Windows Server 2008 R2 (32-bit and 64-bit systems on all operating systems) Launcher Microsoft Windows Vista, Microsoft Windows 7, Microsoft Windows Server 2003 (32-bit systems only), Microsoft Windows Server 2008, and Microsoft Windows Server 2008 R2 (32-bit and 64-bit systems on all operating systems except as noted) ICA Client Version 10 or higher Citrix Presentation Server 4.0 or higher, Citrix XenApp 5.0 or 6.0 .NET Framework 2.0 or later is required for all Launchers and Controllers that will be establishing connections using the Web Interface. Visual J# Version 2.0 (if using XML Interface Connector) Citrix EdgeSight for XenApp Agent, Advanced Mode, must be installed on the server under test. If a Basic mode agent is installed, application response alerts will not be generated and no data will be displayed in application response reports. CPU Memory Disk 2 gigahertz (GHz) or faster CPU 1 gigabyte (GB) of RAM Minimum 200 megabytes (MB) of free space

Virtual Desktop Monitoring Requirements

You can use EdgeSight to monitor virtual desktops. The following tables list software components used in such an environment. (As with any EdgeSight deployment, you will also need SQL Server Reporting Services and Citrix License Server for Windows, as specified in this document.) For instructions on installing the EdgeSight components in a virtual desktop environment, see Chapter 4, Installing EdgeSight for Monitoring Virtual Desktops. The EdgeSight agent you install depends on the virtual desktops being monitored. If you are monitoring virtual desktops running XenDesktop 4.0, use the EdgeSight for Virtual Desktops Agent. If you are monitoring virtual desktops running XenDesktop 3.0, use the EdgeSight for Endpoints Agent.

22

Citrix EdgeSight Installation Guide

When monitoring virtual desktops running XenDesktop 3.0, the following software components must be in place.
Software Component XenDesktop 3.0 For more installation information... Citrix XenDesktop 3.0 System Requirements Citrix XenDesktop 3.0 Administrator's Guide

EdgeSight Server 5.0 SP2 Chapter 2, Installing Citrix EdgeSight Server EdgeSight for Endpoints Chapter 4, Installing EdgeSight for Monitoring Virtual Agent 5.0 SP2 Desktops EdgeSight Agent Chapter 4, Installing EdgeSight for Monitoring Virtual Database Server 5.0 SP2 Desktops

When monitoring virtual desktops running XenDesktop 4.0, the following software components must be in place.
Software Component XenDesktop 4.0 EdgeSight Server 5.2 or later EdgeSight for Virtual Desktops Agent 5.2 EdgeSight Agent Database Server 5.2 For more installation information... Citrix XenDesktop 4.0 System Requirements Citrix XenDesktop 4.0 Administrator's Guide Chapter 2, Installing Citrix EdgeSight Server Chapter 4, Installing EdgeSight for Monitoring Virtual Desktops Chapter 4, Installing EdgeSight for Monitoring Virtual Desktops

Software Configuration Tasks

In some cases, you may need to perform software configuration tasks to ensure that EdgeSight works properly in your environment. Review the following guidelines and implement the recommendations as required. In addition, review the applicable release notes for release-specific configuration information.

Configuring Antivirus Software

You must configure antivirus software running on your EdgeSight Server and all managed devices (machines running EdgeSight Agent) to exclude specific processes and files. If these files and processes are not excluded, communications between the agents and the server may be disrupted, and performance on monitored devices can be degraded.

Chapter 1

Installation Overview

23

Note The paths and filenames provided are based on default installation values for EdgeSight and other software components. If you have specified non-default paths and filenames, use the values applicable to your installation. You can use the About page on the EdgeSight Server Console to identify installation paths and filenames on the server.
To configure antivirus software on devices running EdgeSight Agent: Ensure that the following agent service, which is a script host, is not subject to script blocking: %ProgramFiles%\Citrix\System Monitoring\Agent\Core\rscorsvc.exe Exclude the following folder. This folder contains the EdgeSight database, which is highly transactional, along with log files and temporary files: %ALLUSERSPROFILE%\Citrix\System Monitoring\Data\ for Microsoft Vista and Windows Server 2008 systems %ALLUSERSPROFILE%\Application Data\Citrix\System Monitoring\Data\ for all other systems

If you have agents installed in a virtual desktop environment, exclude the following: The data folder on the EdgeSight Agent Database Server %ALLUSERSPROFILE%\Citrix\System Monitoring\Data\ for Windows Server 2008 systems %ALLUSERSPROFILE%\Application Data\Citrix\System Monitoring\Data\ for all other systems Agent data file share. See Setting Up the Agent Data File Share on page 57 for more information on the file share configuration.

To configure antivirus software on your EdgeSight Server: Ensure that the following files, which are script hosts, are not subject to script blocking: %CommonProgramFiles%\Citrix\System Monitoring\Server\RSSH\ RSshApp.exe %CommonProgramFiles%\Citrix\System Monitoring\Server\RSSH\ RSshSvc.exe Exclude the following folder, which contains the Citrix EdgeSight Web server: %ProgramFiles%\Citrix\System Monitoring\Server Exclude the SQL DB folder %ProgramFiles%\Microsoft SQL Server\MSSQL\Data\ Exclude the IIS Web Site Log files %SystemRoot%\SYSTEM32\Logfiles

24

Citrix EdgeSight Installation Guide

Configuring Firewalls
The listen port on the client machine (port 9035) must be open. This is the port on which the agent listens for remote connections from the browser displaying the Citrix EdgeSight console. There is an option during agent installation to automatically set a Windows Firewall exception for the listen port if the firewall is running (enabled or disabled). If a firewall is installed on the machine hosting the EdgeSight Agent Database Server, port 9037 must be open to allow communication with EdgeSight Server. There is an option during agent database server installation to automatically set a Windows Firewall exception for the listen port if the firewall is running (enabled or disabled). The EdgeSight Agent Database Server is only installed when using the EdgeSight for Endpoints agent to monitor virtual desktops. Certain types of ports must be opened to allow EdgeSight Server (specifically the User Troubleshooter) to communicate with XenApp. EdgeSight Server uses MFCOM to communicate with XenApp servers. MFCOM in turn uses DCOM and requires that RPC ports are opened on the XenApp server.

C HAPTER 2

Installing Citrix EdgeSight Server

This chapter provides instructions on installing and configuring the database and Web server that make up Citrix EdgeSight Server. The instructions are based on an initial installation. Before starting an installation, make sure that you have reviewed the prerequisites and system requirements listed in Chapter 1, Installation Overview.

Installing the Citrix EdgeSight License

Citrix EdgeSight licensing is provided by the Citrix License Server for Windows, which is bundled with EdgeSight. See Citrix License Server for Windows Requirements on page 20 for information on obtaining the license server documentation. If you are monitoring endpoint devices, download EdgeSight for Endpoints license files (CES_*.lic), then manually place them in the MyFiles folder of the license server directory, for example: %ProgramFiles%\Citrix\Licensing\MyFiles. These files will need to be in place prior to running the post-installation wizard, as described in Running the Post-Installation Setup Wizard on page 32.

Installing the Server

The server installation is launched using the setup.exe bootstrapper. The installation will fail if the server MSI file is invoked directly. The preferred method of installing EdgeSight Server is to use the bootstrapper and perform the installation using the Citrix EdgeSight Installer user interface. This method offers typical and custom installation options. A typical installation offers only the minimum set of properties required for installation. A custom installation offers the same set of public properties as a command-line installation.

26

Citrix EdgeSight Installation Guide

If required, you can perform a command-line installation using the msiexec command. You must specify public properties to define installation settings. Review Setting Server Installation Properties on page 29 for a description of installation properties. If you are upgrading, see Upgrading Citrix EdgeSight Server on page 34 for more information.

Prerequisite Checking
The bootstrapper performs checks for the following software prerequisites and system characteristics. The conditions checked can be required or recommended. If any of the required conditions is not met, the installation stops. Correct the condition and restart the installation. Recommended conditions are flagged with a warning, but installation can continue at the discretion of the installer.
Condition .NET Framework 3.5 SP1 Windows Server 2003 or Windows Server 2008 Internet Information Services (IIS) 6.0 or later. See IIS 7.0 Components Required on Windows Server 2008 Systems on page 17 for information specific to IIS 7.0 and Windows Server 2008. Microsoft Message Queuing (MSMQ). The MSMQ service must be running. SQL Server 2005 SP1 or later (Standard or better). This can be on a different machine from where the installation is being run. 512 megabytes (MB) of RAM Note that 2GB is recommended. Required? Yes Yes Yes

Yes Yes No. Installation can continue, but performance may be affected.

Note that some requirements for full operation, such as Citrix License Server for Windows and SQL Server Reporting Services, are not checked by the bootstrapper.

Installing a Server Using the User Interface

Before performing an EdgeSight Server installation, set up a run as account for EdgeSight. You will need to supply the account username and password during server installation. Specify the account using the computer name and username (computername\username) or the domain name and username (domainname\username). Do not use a fully qualified domain name (FQDN), as this will result in an installer error.

Chapter 2

Installing Citrix EdgeSight Server

27

Note that not all public properties listed in Setting Server Installation Properties on page 29 are exposed when performing a typical installation using the user interface. Properties not explicitly set from the user interface are set to their default value if one exists. However, performing a custom installation will expose all available properties. The following procedure is based on a custom installation. To install a server using the user interface: 1. 2. 3. 4. 5. Insert the media or run Autorun. Select EdgeSight Server. The Choose Language dialog is displayed. Select the language for the installation and click Continue. The Welcome screen is displayed. Click Next to continue. The Select Features screen is displayed. Select the applicable radio button for the EdgeSight Server components to be installed. You can install a Web server and database, or just a database. In both cases, if there is an existing database, it will be upgraded as necessary. Click Next to continue. The Prerequisite Check screen is displayed. A check for minimum requirements is performed and the result of the check is displayed. If minimum requirements are not met, the installation is stopped and you are notified of missing components. If minimum requirements are met, but limitations are present due to the configuration of the target system, warnings are displayed. (Examples of warning conditions are the not meeting minimum memory requirements.) You can continue the installation even though warnings have been issued. Click Next to continue. The End-User License Agreement screen is displayed. After reading the license, select the I accept radio button and click Next. The Choose Setup Type screen is displayed. Select the applicable radio button for the type of setup to be performed (Typical or Custom). In this case, choose the Custom radio button and click Next. The Database Server screen is displayed. Select an existing server name from the list or enter a server name. The name of the machine on which you are running the installer is preloaded into the entry field. You can also enter a named instance in this field (servername\instancename). Select an authentication method. The method you choose is partially determined by the accounts set up when SQL Server was installed. (Note that you must have administrative privileges on the database server.) Click the Test Connect button to test the connection to the SQL Server. Click Next. The next Database Information page is displayed.

6.

7. 8.

9.

10.

28

Citrix EdgeSight Installation Guide

11.

Select the Install a new EdgeSight database radio button to create a new database. (If you were performing an upgrade, you would select the applicable radio button and choose an existing database from the list.) Enter a name for the new database and click Next to continue. The Database User Information screen is displayed. Database names must be unique within an instance of SQL Server and comply with the rules for identifiers. Also, the database name can not contain hyphens, the pipe character ( | ), single quotes, a period (.), or spaces. For information on identifiers, see SQL Server Books Online for your version of SQL Server.

12.

13.

Enter and confirm the account username and password that the Web server uses when connecting to the database. If you are performing the installation using local machine accounts, enter the computer name and username (computername\username). If you are performing the installation using domain accounts, enter the domain name and username (domainname\username). Do not supply a fully qualified domain name, as this will result in an installer error. Click Validate to test the user credentials. After the credentials have been successfully validated, click Next to continue. The Database Properties screen is displayed. Configure the database properties as follows: File Group SizeAccept the default file size or enter a new file size. Each of the eight files in the file group is created using the specified size. The default value is sufficient space for most installations. A smaller size may be selected for pilot installations. Log File Size Accept the default log file initial size or enter a new file size. The default value is sufficient space for most installations. Recovery Model OptionsSelect a database recovery model (Simple, Bulk-logged, or Full) from the drop-down menu. The default recovery model is Simple. If the recovery model is changed to Full, ensure that a database backup strategy is in place to effectively manage database size. See SQL Server Books Online for more information on recovery models.

14.

15.

Note The installer uses the default file group and log file creations as configured in the SQL Server installations. A SQL Server administrator can

Chapter 2

Installing Citrix EdgeSight Server

29

change the location of the file groups and log files, but the SQL Server service must be restarted before the new locations will take effect. 16. 17. Click Next. The Server Location screen is displayed. Review the default values for the program files root and the data files path. You can accept the default values or click the Browse button to select a different location for the files. To display information about space availability on all system drives, click the Disk Usage button. When you have specified server file locations, click Next. The Ready to Install screen is displayed. Click Install to begin the installation. (If you need to review or change any settings before installing, use the Back button to return to the configuration screens.) Installation status is displayed while the installation is being performed. When the installation is finished, the Complete screen is displayed. The checkbox indicating you want to go to the EdgeSight Server Website (http://servername:port/edgesight/app/suilogin.aspx) is checked by default. You must go to the Website to perform initial configuration tasks, as described in Running the Post-Installation Setup Wizard on page 32. (If you want to perform initial configuration at a later time, deselect the checkbox. However, it is recommended that you complete initial configuration directly after completing the installation.) Click Finish to exit the installer. Note: You will need to communicate with the license server during the initial configuration procedure. If you have not installed the license server, deselect the checkbox, close the installer, install the license server, and then log into the Web site.

18.

19.

Setting Server Installation Properties

The MSI file uses public properties to specify custom install settings. You can edit public properties using the following methods: Run the installer user interface (if the property is exposed). A log file is not created when the user interface is used for installation. Create a transform file using a tool such as Orca. For more information on using Orca with MSI files, see http://support.microsoft.com/kb/255905. Specify key/value pairs on the command line. This method allows you to control the full range of installation options, including specifying a log file, as well as being able to specify public properties. The syntax for key/value pairs is KEY=value.

30

Citrix EdgeSight Installation Guide

See your MSI documentation for syntax rules for property values. The following table lists the public properties available when installing the Citrix EdgeSight Server. You only need to specify properties with default values if you want to specify a value other than the default. Also, whether some properties are specified depends on what other properties are being specified. For example, if Windows authentication is not enabled using the WINDOWS_AUTH property, the DBUSERNAME and DBPASSWORD properties must be defined.

Note Although additional properties are exposed when you examine the MSI file, only the public properties listed in the following table should be explicitly specified.
Property Name PREREQUISITES_ PASSED DATABASEOPTIONS new Default Value Description If this property is specified with any value, the bootstrapper is bypassed and you are allowed to perform a command-line installation of the server. Specifies whether to install a new Citrix EdgeSight database or upgrade an existing database. Valid values are new or upgrade. The name of the server running an existing Citrix EdgeSight database. It is not necessary to specify a value when running the database locally. The username for the SA user. It is not necessary to specify a value if Windows authentication is enabled (WINDOWS_AUTH=1). The password for the SA user. It is not necessary to specify a value if Windows authentication is enabled (WINDOWS_AUTH=1). 1 Specifies whether to use Windows authentication. Valid values are 1 (use Windows authentication) or 0 (do not use Windows authentication). If Windows authentication is not used, the DBUSERNAME and DBPASSWORD properties must be defined. The name of the Citrix EdgeSight database that will be created during installation. Database names must be unique within an instance of SQL Server and comply with the rules for identifiers. Also, the database name can not contain the pipe character ( | ), single quotes, a period (.), a hyphen (-), or spaces. For information on identifiers, see SQL Server Books Online for the your version of SQL Server. The account name for the EdgeSight run as account. Specify the account using the computer name and username (computername\username) or the domain name and username (domainname\username). Do not use an FQDN. The password for the EdgeSight run as account.

DATABASESERVER

DBUSERNAME

DBPASSWORD

WINDOWS_AUTH

DBNAME

EdgeSight

ACCOUNTNAME

ACCOUNTPASSWORD

Chapter 2

Installing Citrix EdgeSight Server

31

DATAFILESIZE

500

Specifies the initial size in megabytes of a data file. Each of the eight files in the file group is created using the specified size. The default size is sufficient for most installations. Specifies the initial size in megabytes of the log file. The default size is sufficient for most installations, Specifies the database recovery model. Valid values are FULL, SIMPLE, and BULK_LOGGED. EdgeSight Server uses temporary files for storing data uploads from agents, including crash reports. There may be significant file growth in this directory. It may be desirable to locate this directory on a separate drive or partition. Note that the data directory cannot be on a mapped drive. Contains the web pages, scripts, .Net components and other components that make up the EdgeSight Server Web site. Specifies what components are to be installed. Set the value to full to install the database, Web server, and script handler components. Set the value to dbonly to only install the database component.

LOGFILESIZE RECOVERYMODEL DATADIR

500 SIMPLE %ProgramFiles%\Citrix\ System Monitoring\ Server\EdgeSight\Data

EDGEDIR

%ProgramFiles%\Citrix\ System Monitoring\ Server\EdgeSight

INSTALLOPTIONS

Installing a Server Using the Command-Line Interface

Use the msiexec command to install the server using the command-line interface. Public properties are specified as KEY=value pairs. Note that path names must be enclosed in quotes. The following is a sample msiexec command line:
Msiexec /i EdgeSightServer.msi /l*v logfile.log /qn PREREQUISITES_PASSED=1 WINDOWS_AUTH=1 ACCOUNTNAME=mydomain\myaccount ACCOUNTPASSWORD=mypass DBNAME=EdgeSight50 DATADIR=D:\Citrix\System Monitoring\Data

The /i flag is used to specify the package being installed. The /l*v flag is used to specify the installation log file name. (Capturing a verbose installation log is strongly recommended.) Use the /qn (quiet) flag to install an agent with no user interaction. For a complete list of standard MSI command-line arguments, open a Command Prompt window and type msiexec /h to invoke help, or refer to The Command-Line Options for the Microsoft Windows Installer Tool Msiexec.exe at http://support.microsoft.com/kb/314881.

32

Citrix EdgeSight Installation Guide

Running the Post-Installation Setup Wizard

After you have completed the Citrix EdgeSight Server installation, you must use the Citrix EdgeSight Post-Installation Setup Wizard to perform initial server configuration. The wizard is displayed the first time you log into the EdgeSight Server Web site (http://servername:port/edgesight/app/suilogin.aspx). The post-installation wizard helps you perform the following tasks: 1. Create a company. A company is the primary organizational unit on an EdgeSight Server. A single server can support multiple companies. Create the Superuser account. This account has access to all companies hosted on the server and can create other users. Configure email settings. This information is used on notification emails generated by the server. Configure agent support. Configure licensing if EdgeSight for Endpoint agent support is enabled. Review the tasks you will perform and ensure that you have the information at hand to specify the settings listed above. Click Next to display the Create an Initial Company page. Enter a name for the company for which data will be displayed on the Web site. Select a time zone from the drop-down menu to be used by the server when displaying the time and triggering jobs. There is a single time zone for each company defined on a Citrix EdgeSight Server. All data for that company is aggregated based on the day boundary for that time zone. This ensures greater data consistency when agent machines are in a number of different time zones. Select the default display language for new user accounts from the dropdown menu. Click Next to display the Create the Superuser Account page. Enter login information for the Superuser account (a universal login ID to be used by the Citrix EdgeSight administrators). This login enables administrators to access data from all companies and perform server administrative tasks. The Superuser account cannot be deleted. Enter a first and last name, a login ID in the form of an email address, and a password. You must confirm the password. Click Next to display the Configure Email Settings page. Enter the name of the SMTP server used to route email. The SMTP server can be running locally or remotely.

To configure your Citrix EdgeSight Server:

2. 3.

4. 5.

6.

Chapter 2

Installing Citrix EdgeSight Server

33

7.

Enter the email address for the person or group who should be notified of important events occurring on the Web site. In most cases, this person is the Citrix EdgeSight Administrator. Enter a display name and email address to be used when email is generated by the Web site. (Once the Web server is installed, you use the EdgeSight Server Console to determine additional criteria for email notifications.) Click Next to display the Configure Agent Support and Licensing page. Select which types of agents, if any, are supported on the server from the support drop-down menus. (Support for all agents would be disabled if the EdgeSight Server is used for license server monitoring only.) EdgeSight provides the following types of agents: EdgeSight for XenApp, BasicBasic agents provide the Resource Management capability that is included in XenApp-Enterprise Edition and require only that you have a XenApp Enterprise license available on your Citrix Licensing Server. EdgeSight for XenApp, AdvancedAdvanced agents provide the fully featured version of EdgeSight for XenApp and require that you have either a XenApp-Platinum Edition license or an EdgeSight for XenApp license available on your Citrix Licensing Server. EdgeSight for EndpointsEndpoint agents provide monitoring and data collection for endpoint devices. EdgeSight for XenDesktopEdgeSight for Virtual Desktops agents provide monitoring and data collection for XenDesktop devices. This setting only determines whether reports and administrative pages are displayed on the console; data continues to be collected, uploaded, and stored even if display support is disabled. You can change the server mode at any time after installation using the EdgeSight Server Console.

8.

9.

10.

Enter the license server name and port number used for communication with the license server which will supply EdgeSight for Endpoints Agent licenses. The license server can be installed on the machine hosting the EdgeSight Web server, or can be installed on another machine as long as it is accessible via the network. (EdgeSight for XenApp Agents obtain their licenses directly from the license server without intervention from EdgeSight Server. They use the license server specified in their agent configuration. See Managing Licenses in the Citrix EdgeSight Administrators Guide for more information on licensing.) This step is optional. After entering the license server name and port, click the Test License Server button to ensure that you can connect to the

11.

34

Citrix EdgeSight Installation Guide

specified license server and that EdgeSight licenses are found. If the test is successful, a success message is displayed, along with the type and number of EdgeSight licenses installed. The test can fail because the license server is not accessible, or because the license server is not the correct version. Verify the license server name and port, or upgrade the license server and retry the test. You may also want to try using the IP address or FQDN of the license server, 12. 13. Click Next to display the Review Citrix EdgeSight Server Settings page. Review the selected configuration settings. Use the Back button to return to previous pages and adjust settings. When you are satisfied with the settings, return to the review screen and click Finish to save the configuration. The Citrix EdgeSight login page is displayed if the checkbox for this option is selected.

Upgrading Citrix EdgeSight Server

Important You should back up your EdgeSight database before performing an EdgeSight Server upgrade. Optionally, you may want to reboot your EdgeSight Server so that all EdgeSight processes are restarted, providing a known state from which to upgrade. Also, the EdgeSight Server should be upgraded before upgrading the associated EdgeSight agents.
You can directly upgrade to EdgeSight Server 5.3 from EdgeSight Server 5.0 SP2 and above. The MSI file checks for existing versions of the Citrix EdgeSight database and Web server components each time you invoke server setup. Note that upgrades from Technology Preview releases are not supported. The time it takes to perform an upgrade may be affected by the distribution of the database file group. Additional time may be required to perform file group moves during the upgrade. In addition, the size of the database will affect the time required to perform an upgrade. If you are performing a database-only upgrade on a system hosting both the EdgeSight Web site and database, turn off IIS on the system before performing the upgrade. This will prevent EdgeSight from attempting to process data uploads and alerts at the same time that the database is being updated. In the case of a full update, IIS must be running to allow an IIS reset as part of the installation process.

Important When you perform a server upgrade, support for EdgeSight for Virtual Desktops Agents (a new feature in EdgeSight 5.2), is not automatically enabled. If you will be monitoring XenDesktop 4.0 instances in your

Chapter 2

Installing Citrix EdgeSight Server

35

environment, perform the following steps to enable support for EdgeSight for Virtual Desktops Agents: 1. 2. 3. 4. Open the EdgeSight Server Console. Select the Configuration tab. Navigate to Server Configuration > Settings and select the Agent Support tab. Set EdgeSight for XenDesktop Support to On.

Upgrading from Versions of EdgeSight Server Prior to 5.0 SP2

To upgrade to EdgeSight Server 5.3 from versions prior to EdgeSight Server 5.0 SP2, you must first perform the required upgrades to reach EdgeSight Server 5.0 SP2, then upgrade to the latest version. See prior version of this manual for information on specific upgrade paths.

Uninstalling Citrix EdgeSight Server

When you uninstall Citrix EdgeSight Server, only the Web Server is removed from your system. The database remains on the system running SQL Server. To remove an EdgeSight database, you must use the SQL Server Management Studio (SQL Server 2005 and SQL Server 2008). The data directory, usually located at %ProgramFiles%\Citrix \System Monitoring\Server\EdgeSight\Data, is not removed when uninstalling Citrix EdgeSight. This directory is used to store data, including crash dumps. Because these files can be quite large, you may want to remove the contents of the data directory manually. To uninstall a Citrix EdgeSight Web Server, use one of the following methods: Use the Add or Remove Programs on the Control Panel to remove the program named EdgeSight Server. Uninstall Citrix EdgeSight Server using the MSI file.

It is recommended that you reboot the machine after uninstalling Citrix EdgeSight if you intend to reinstall the product; rebooting ensures that folders and files marked for deletion are cleaned up properly.

36

Citrix EdgeSight Installation Guide

C HAPTER 3

Installing Citrix EdgeSight Agents

This chapter provides instructions on deploying, installing, upgrading, and uninstalling EdgeSight for Endpoints, EdgeSight for Virtual Desktops, and EdgeSight for XenApp agents. Installation instructions are based on a new installation.

Installing the Agent

In most production environments, the agent is deployed and installed as described in Agent Deployment and Installation Overview on page 10. You can also perform an agent installation on a single client system. You may want to use this method during evaluation or when deploying and installing small numbers of clients. If you are deploying agents for monitoring virtual desktops, see Chapter 4, Installing EdgeSight for Monitoring Virtual Desktops, for information specific to that environment.

Note Whatever deployment and installation methods you choose, you must have administrator privileges on the target machines.

Agent Mode
The EdgeSight for XenApp Agent has two modes of operation, Basic and Advanced: Basic agents provide the Resource Management capability that is included in XenApp-Enterprise Edition and require only that you have a XenApp Enterprise license available on your Citrix Licensing Server. Advanced agents provide the fully featured version of EdgeSight for XenApp and require that you have either a XenApp-Platinum Edition license or an EdgeSight for XenApp license available on your Citrix Licensing Server.

38

Citrix EdgeSight Installation Guide

When a version 5.0 EdgeSight for XenApp Agent is installed on a XenApp or Presentation Server machine, the agent mode enabled by default depends on the version and edition of XenApp or Presentation Server. The following table shows the default agent mode by XenApp and Presentation Server version and edition. The table also shows whether the Mode tab is displayed on the Citrix System Monitoring Agent control panel applet.
XenApp or PS Version 6.0 6.0 5.0 5.0 4.5 4.5 4.5 4.0 4.0 4.0 XenApp or PS Edition Platinum Enterprise Platinum Enterprise Platinum Advanced/Standard Enterprise Platinum Advanced/Standard Enterprise Default Agent Mode Advanced Basic Advanced Basic Advanced Advanced Basic Advanced Advanced Basic Mode Tab Available No Yes No Yes No No Yes No No Yes

Software Configuration Tasks

You may need to change the configuration of some software, such as antivirus software or personal firewalls, on machines which will run the EdgeSight Agent to ensure proper operation. You can perform these configuration tasks before or after installing the EdgeSight Agent. For more information, see Software Configuration Tasks on page 22.

Antivirus Configuration Checking

Due to the manner in which buffer overflow protection was implemented in McAfee VirusScan 8 or 8i with Patch 10, this feature which may conflict with the operation of the EdgeSight Agent. (In later versions of McAfee VirusScan, this feature was implemented differently and does not conflict with EdgeSight Agent operation.) The EdgeSight Agent installer checks for McAfee 8 or 8i with Patch 10 or below on the target machine. If the EntApi.dll file is present with version 8.0.0.277 and below, the installation exits with an error. The check is performed on both full UI and unattended installations. In a command-line installation, the check can be omitted from the installation process by specifying the OVERRIDE_COMPCHECK property with a value of 1.

Chapter 3

Installing Citrix EdgeSight Agents

39

Note The OVERRIDE_COMPCHECK property should only be used if you disable the McAfee buffer overflow protection feature as described in the Release Notes for your EdgeSight product.

Installing an Agent Using the User Interface

Note that not all public properties listed in Setting Installation Properties on page 40 are exposed when installing using the user interface. Properties not explicitly set from the user interface are set to their default value if one exists. To install an agent using the user interface: 1. 2. 3. 4. 5. 6. Insert the media. Select EdgeSight Agent Installers. Select the agent type to be installed. The Welcome screen is displayed. Click Next to continue. The License Agreement screen is displayed. After reading the license, select the I accept radio button and click Next. The Company Information screen is displayed. Enter the company name. This should match the company name specified during EdgeSight Server setup. If you are installing the agent on an endpoint device, enter the department name. If no department name is provided, the agent data will be displayed under the root department. If you are installing the agent on XenApp, select the operational mode from the Mode drop-down menu. If you choose Basic mode, some capabilities are not available and no EdgeSight license is consumed. Basic mode is used when installing an EdgeSight for XenApp agent on an Enterprise Edition system. Click Next. The Agent Location screen is displayed. 7. 8. Enter the installation path for the agent or accept the default value. You can browse to select a non-default location. Enter the installation path for the data files or accept the default. You can browse to select a non-default location. Click Next. The Network Settings screen is displayed. Enter the server name and port number. These are required fields. The Automatically configure Windows Firewall for Port 9035 checkbox is selected by default. Enabling this feature automatically configures the firewall for the listen port (the port on which the agent listens for remote connections from the browser displaying the EdgeSight Server console).

9. 10.

40

Citrix EdgeSight Installation Guide

The firewall must be running, but can either be enabled or disabled. The exclusion is set up for Domain networks. If an exception for Private networks is required, the Domain exception can be used as a template. If you do not want Windows Firewall automatically configured, deselect the checkbox. 11. 12. If an SSL network connection is required, select the Use SSL checkbox. (This is equivalent to setting the CONNECTION_FLAGS property.) If a proxy server is used, select the Use a proxy server checkbox. Then enter the proxy server name and port and the username/password used to access the server. (This is equivalent to setting the PROXY_ADDRESS, PROXY_PORT, and PASSWORD properties.) Click Next. The Advanced Settings screen is displayed The Advanced Settings screen is only used if you are installing the EdgeSight for Endpoints agent or the EdgeSight for Virtual Desktops agent on virtual desktops in a pool. See Chapter 4, Installing EdgeSight for Monitoring Virtual Desktops for instructions on installing and deploying agents in this type of environment. Click Next. The Ready to Install screen is displayed. Click Install to begin the installation. (If you need to review or change any settings before installing, use the Back button to return to the configuration screens.) When the installation is complete, the Setup Complete screen is displayed. Click Finish to complete the installation. The Installer Information dialog is displayed, prompting you to reboot your system so that configuration changes will be applied. Click Yes to reboot your machine.

13.

14.

15.

16.

Setting Installation Properties

The MSI file uses public properties to specify custom install settings. You can edit public properties using the following methods: Run the installer user interface (if the property is exposed). This method offers fewer installation options than using the command-line interface. Also, a log file is not created when the user interface is used for installation. Create a transform file using a tool such as Orca. Specify key/value pairs on the command line. This method allows you to control the full range of installation options, including specifying a log file, as well as being able to specify public properties. The syntax for key/value pairs is KEY=value.

Chapter 3

Installing Citrix EdgeSight Agents

41

See your MSI documentation for syntax rules for property values. The following table lists the public properties used when installing the EdgeSight agent:
Property Name COMPANY Default Value Description The company under which data will be displayed on EdgeSight Server. If this property is not specified, the server considers the device unmanaged, and the agent cannot upload data to the server. The department under which data will be displayed on EdgeSight Server. Special characters are not allowed in the name of an EdgeSight department. If this property is not specified, the device is assigned to the default root department. Note: This property is only available for EdgeSight for Endpoints agents; EdgeSight for Virtual Desktops agents and EdgeSight for XenApp agents use the Farm structure as the department structure. Location of the main Citrix EdgeSight directory. For example: INSTALLROOT=%programfiles% \citrix\system monitoring \Agent Location of the Citrix EdgeSight data directory, within quotation marks. If this property is not specified, data files are placed in the default location: %ALLUSERSPROFILE% \Application Data\Citrix \System Monitoring\Data\ On Microsoft Vista systems, the default path is: %ALLUSERSPROFILE% \Citrix\System Monitoring\Data\ Note that the data directory cannot be on a mapped drive. 1 Controls whether agent data files (database and log files) are deleted when the agent is uninstalled. 0 = Do not delete files on uninstall 1 = Delete files on uninstall Determines whether security is enabled for remote connections from the server. 0 = Security disabled 1 = Security enabled See the REMOTE_SECURITY_GROUP property for more information on remote device security. Note: This option is deprecated and will be removed in a future version.

DEPARTMENT

INSTALLROOT

DATA_DIR

DELETE_DATA_ON_ UNINSTALL

REMOTE_SECURITY

42

Citrix EdgeSight Installation Guide

REMOTE_SECURITY_ GROUP

Local machine group to which the current working user must belong for remote connections from the server. Note that it is the current working user of the machine that is checked, not the user account used to log into the Citrix EdgeSight Server Console. The REMOTE_SECURITY and REMOTE_SECURITY_GROUP properties work together to determine the level of security for remote device access as follows: RemoteSecurity=1, RemoteSecurityGroup=<not set> This is the most secure and restrictive setting. In order to display real-time reports based on the agent database, the EdgeSight Server Console user must be a local administrator on the actual device. RemoteSecurity=1, RemoteSecurityGroup=<Active Directory group> An Active Directory group must exist or be set up in order to use the REMOTE_SECURITY_GROUP property. Add all EdgeSight users to this group who need access to the real-time reports. This approach allows you to carefully control those users with access to real-time reports. RemoteSecurity=0, RemoteSecurityGroup=<any value> This is the least secure setting. This gives all EdgeSight Server Console users the ability to display real-time reports. This setting is generally not recommended.

SYNCH_AD_TREE

Determines whether to synchronize the Active Directory tree with the Citrix EdgeSight department tree. 0 = Synchronization disabled 1 = Synchronization enabled Determine whether to allow an EdgeSight for Endpoints agent to be installed on a system running a server OS. 0=No installation on server OS 1=Install on server OS Note: During a silent installation of an EdgeSight for Endpoints agent on a system running a server OS, the install fails unless the ALLOWSERVEROS property is set to 1. Determine whether to allow an EdgeSight for Endpoints agent to be installed silently on XenDesktop 4.0 instances. 0=No installation on XenDesktop 4.0 instance 1=Install on server XenDesktop 4.0 instance Note: The EdgeSight for Endpoints agent does not collect session-related data on XenDesktop systems. If you wish to collect data relating to XenDesktop, please install the EdgeSight for Virtual Desktop Agent.

ALLOWSERVEROS

ALLOWVIRTUAL

Chapter 3

Installing Citrix EdgeSight Agents

43

NO_CONTROL_PANEL

Determines whether the control panel applet is installed. 0=Install control panel applet. 1=Do not install control panel applet. For more information, see Configuring Agents Using the Control Panel on page 49. The operational mode (Basic or Advanced) for an EdgeSight for XenApp agent, as described in Agent Mode on page 37. The option values as are follows: 1 = Advanced Mode 2 = Basic Mode

FUNCTIONALITY_ MODE

SHOW_SERVICES_TAB

Disabled (0) for EdgeSight for Endpoints Agents. Enabled (1) for EdgeSight for XenApp Agents.

Determines whether the Service Control tab is displayed on the control panel applet. The tab allows users to enable or disable the Citrix System Monitoring Services. 0 = Services tab not displayed. 1 = Services tab displayed. See Configuring Agents Using the Control Panel on page 49 for more information on the control panel applet. Overrides the version check described in Antivirus Configuration Checking on page 38. To override the check, specify this property with a value of 1. Note: This property should only be used if you disable the McAfee buffer overflow protection feature as described in the Release Notes for your Citrix EdgeSight product.

OVERRIDE_ COMPCHECK

Network Settings CONNECTION_FLAGS HTTP_TIMEOUT PROXY_FLAGS 0 30 0 0 = No SSL 1 = Use SSL Determines how long to wait, in seconds, for a connection or other operation to complete. 0 - No proxy settings are selected 1 - Use proxy 3 - Use proxy and non-SSL tunnel (CONNECTION_FLAGS must be set to 0) 5 - Use proxy and require authentication (value must be supplied for PROXY_USER) 7 - Use proxy and require authentication (value must be supplied for PROXY_USER) and non-SSL tunnel (CONNECTION_FLAGS must be set to 0) Port through which the agent communicates with the proxy server. The hostname or IP address for the proxy server. The user name for the account used to access the proxy server. Password for access to the proxy server. The password is encrypted before being stored in the registry.

PROXY_PORT PROXY_ADDRESS PROXY_USER PROXY_PASSWORD

8080

44

Citrix EdgeSight Installation Guide

SERVER_NAME

Server to which the agent will report data. This property is required. If no server name is supplied, the agent is unable to upload data to the server. 80 1 Port through which the agent communicates with the EdgeSight Server. Supply a value of 1 to allow Windows Firewall to be automatically configured to exclude the listen port (9035). The firewall must be running, but can either be enabled or disabled. If you do not want the firewall automatically configured, set the value to 0.

SERVER_PORT FIREWALL_ EXCEPTION_ ALLOWED

Virtual Desktop Environment Properties These properties are only used when installing the EdgeSight for Endpoints Agent on virtual desktops in a pool. See Chapter 4, Installing EdgeSight for Monitoring Virtual Desktops, for more information. POOLED_INSTALL Supply a value of 1 to indicate that the agent is to be installed on virtual desktops in a pool. This property must be set to 1 to enable the remaining virtual desktop environment properties. The UNC path for the agent data file share. The name of the pool in which the virtual desktops will be running. This pool name is case sensitive and must match the pool name specified during the agent database server installation. The fully-qualified domain name or IP address of the EdgeSight Server which will be acting as the database broker. The port associated with the EdgeSight Server which will be acting as the database broker. 0 = No SSL 1 = Use SSL. 0 = No proxy 1 = Proxy is of CERN type 2 = Proxy is a non-SSL tunnel to an SSL server The hostname or IP address of the proxy server. Port through which the agent communicates with the proxy server. The username used when accessing the proxy server. Password for access to the proxy server. The password is encrypted before being stored in the registry.

REMOTE_PATH IMAGE_POOL

DBBROKER_FQDN

BROKER_PORT BROKER_ CONNECTION_FLAGS BROKER_PROXY_ FLAGS BROKER_PROXY_ ADDRESS BROKER_PROXY_PORT BROKER_PROXY_USER BROKER_PROXY_ PASSWORD

Chapter 3

Installing Citrix EdgeSight Agents

45

Installing an Agent Using the Command-Line Interface

Use the msiexec command to install the agent using the command-line interface. Public properties are specified as KEY=value pairs as described in Setting Installation Properties on page 40. If a property has a default value, that value is used if the property is not specified on the command line. When performing an installation using the command line, the following properties should always be specified: SERVER_NAMEIf the server name is not specified, the agent is unable to obtain configuration information or upload data. COMPANYIf the company name is not specified, the device is considered an unmanaged device and cannot upload data to the server.

ALLOWSERVEROS should be specified if you attempt to install an EdgeSight for Endpoints agent on a system running a server OS. If this property is not specified, a warning is issued. During a silent installation to a system running a server OS, the install fails unless the ALLOWSERVEROS property is set to 1. ALLOWVIRTUAL should be specified if you attempt to install an EdgeSight for Endpoints agent on a virtual desktop instance running XenDesktop 4.0. If this property is not specified, a warning is issued. During a silent installation to a virtual desktop instance running XenDesktop 4.0, the install fails unless the ALLOWVIRTUAL property is set to 1. The following is a sample command line for the installation of an EdgeSight for Endpoints agent on a 64-bit desktop system:
Msiexec /i EdgeSightEPAgentx64.msi /l logfile.log /q SERVER_NAME=Myserver COMPANY=Mycompany DEPARTMENT=Mydept

The following is a sample command line for the installation of an EdgeSight for XenApp Agent on a 32-bit system running a server OS:
Msiexec /i EdgeSightXAAgent.msi /l logfile.log /q SERVER_NAME=Myserver COMPANY=Mycompany DEPARTMENT=Mydept ALLOWSERVEROS=1 DATA_DIR=d:\Mydata

The /i flag is used to specify the package being installed. The /l flag is used to specify the installation log file name. (Capturing an installation log is strongly recommended.) Use the /q (quiet) flag to install an agent with no user interaction. For a complete list of standard MSI command-line arguments, open a Command Prompt window and type msiexec /h to invoke help, or refer to The CommandLine Options for the Microsoft Windows Installer Tool Msiexec.exe at http:// support.microsoft.com/kb/314881.

46

Citrix EdgeSight Installation Guide

Installing the EdgeSight for XenApp Agent in a Streamed Environment

Using the EdgeSight for XenApp Agent, you can implement monitoring of XenApp servers running in a streamed environment using Citrix Provisioning Server for Datacenters 4.5. The Provisioning Server solutions streaming infrastructure is based on software streaming technology. It allows administrators to create a virtual disk (vDisk) that represents a computer hard drive, and then relocate that vDisk on an OSProvisioning Server, or on a storage device that has access to a Provisioning Server. Once the vDisk is available, the target device no longer needs its local hard drive to operate; it boots directly across the network. The Provisioning Server streams the contents of the vDisk to the target device on demand, in real time, and the target device behaves as if it is running from its local drive.

Important Although the operating system and applications are streamed to the target device, the EdgeSight Agent requires a persistent local drive to store its database.
Please review the following installation and configuration guidelines before deploying the EdgeSight for XenApp Agent in this environment.

Prerequisites
EdgeSight Server, Provisioning Server 4.5 for Datacenters, and the Citrix License Server for Windows must be installed on their respective machines. For installation instructions, refer to the following product documents: Chapter 2, Installing Citrix EdgeSight Server in this document Citrix Provisioning Server 4.5 Installation and Administration Guide Getting Started with Citrix Licensing Guide

Chapter 3

Installing Citrix EdgeSight Agents

47

Installing the EdgeSight Agent on a Master Target Device

After installing the Provisioning Server Target Device software on the master target device, but prior to imaging the system, install the EdgeSight agent. You can install the agent using the command-line or the user interface. In either case, keep in mind the following: The Citrix System Monitoring Agent service should be installed with a manual start configured. The startup type is changed to automatic after the installation and before the master target device is imaged. All target devices associated with a virtual disk (vDisk) must report to the same EdgeSight Server. If a subset of machines is to report to a different EdgeSight Server, create a new vDisk for these devices. If the master target device has only one disk drive, the installer will not allow a nonexistent drive to be specified. Registry and file system changes are required before master target imaging. See Installation on a Master Target Device with a Single Disk on page 48 for more information.

Installing the Agent Using the Command-Line Interface

The SERVER_NAME and COMPANY parameters should always be specified to ensure that configuration information can be obtained from the server and that data can be uploaded to the server. The following sample command line also shows the use of the DATA_DIR parameter to select the data files folder. Note that the data directory cannot be on a mapped drive.
miexec.exe /i EdgeSightXAAgent.msi /l logfile.log /q SERVER_NAME=rsbetx COMPANY=Mycompany DATA_DIR=d:\Citrix\System Monitoring\Mydata

Installing the Agent Using the User Interface

In the Agent Location dialog, be sure to install the EdgeSight agent on the virtual disk (vDisk). The default location can be used. Change the data folder to a location on the physical disk that will be in each target device. Note that the data directory cannot be on a mapped drive. In the Network Settings dialog, specify the server name and port number for the EdgeSight Server. All target devices that use the vDisk will report to this server. If a subset of target devices is going to report to a different EdgeSight server, a separate vDisk must be created for those devices. (Do not change the network settings on an individual device; these changes are not persisted if the device is rebooted.)

Important Before rebooting the master target device, set the startup type of the Citrix System Monitoring Agent service to manual. Starting the agent service on

48

Citrix EdgeSight Installation Guide

the master target device may result in the generation of registry settings that apply only to the master target but are then pushed out to all targets. If the agent is inadvertently started on the device, perform the following steps: 1. 2. 3. 4. Stop the Citrix System Monitoring Agent service. Uninstall the EdgeSight Agent. Ensure that the HKLM\Software\Citrix\System Monitoring registry hive has been deleted. Ensure that the data folder has been deleted. The default location is %ALLUSERSPROFILE%\Application Data\Citrix\System Monitoring\Data\ or %ALLUSERSPROFILE%\Citrix\System Monitoring\Data\, depending on the type of system. Install the EdgeSight Agent again using the same settings as the original installation. Set the startup type of the Citrix System Monitoring Agent service to manual.

5. 6.

Installation on a Master Target Device with a Single Disk

If the master target device has only one disk drive, the installer will not allow you to specify a data folder on a nonexistent drive. In this case, perform the installation using the default values and then edit the registry and file system when the installation completes: 1. Within the registry, navigate to the key HKLM\Software\Citrix\System Monitoring\Agent\Core\4.00 and change the DataPath to the appropriate location on the physical disk of the target devices. Within the file system, navigate to %ProgramFiles%\Citrix\System Monitoring\Agent\Core\Firebird and locate aliases.conf. Open aliases.conf in a text editor and change the RSDatr entry to match the location of the data folder on the physical disk of the target devices. For example: RSDatr = D:\Citrix\System Monitoring\Data \RSDatr.fdb

2.

3.

Imaging the Master Target Device Disk

Prior to imaging the disk of the master target device, change the startup type of the Citrix System Monitoring Agent service to automatic.

Chapter 3

Installing Citrix EdgeSight Agents

49

Important Change the startup type back to manual after imaging the disk.

Configuring Target Devices

Each target device must have a physical disk drive. The drive must have an NTFS partition that is visible to the streamed OS. Set the boot order of the target device to boot from the network first. Boot the target device from the shared vDisk. After booting the target device, the Citrix System Monitoring Agent service should be running and the service's data should be present on the target device's disk drive. If you need to troubleshoot a specific target device, registry changes for additional tracing should be made on the device, not on the vDisk. Note that these changes are not persisted if the device is rebooted.

Configuring Agents Using the Control Panel

If you need to reconfigure connection settings for agent to server communication after installation, use the Citrix System Monitoring Agent control panel applet. You must have Administrator privileges on the machine to launch the applet. To use the applet: 1. From the Start menu, choose Settings > Control Panel and select Citrix System Monitoring Agent. The Citrix System Monitoring Agent Settings dialog is displayed. Edit the Citrix EdgeSight Server address and port number as required. Select the Use SSL encryption checkbox if the Citrix EdgeSight Server is SSL enabled. To be SSL enabled, a valid SSL certificate issued by a trusted certificate authority must be present on the server running the Citrix EdgeSight Web site. If SSL support is enabled, all agent to server communications must be over SSL. If an agent attempts to connect to an SSL-enabled server without using SSL, an error is generated and the data upload is rejected. Select the Use a proxy server checkbox if a proxy server is used. Enter the proxy server address and port and indicate whether the server is a non-SSL tunnel and whether authentication is required. Supply the authentication username and password if required. If an EdgeSight for XenApp agent is installed on a machine running XenApp Enterprise, you can select the Mode tab and change the agent mode (Basic or Advanced). Note that this tab is not displayed on XenApp Platinum systems. For more information on agent modes, see Agent Mode on page 37.

2. 3.

4.

5.

50

Citrix EdgeSight Installation Guide

6.

When you have made all required settings changes, click OK to apply the changes and close the dialog.

If the Service Control tab has been enabled on the control panel applet, you can disable or enable the Citrix System Monitoring Service and the Firebird Server CSMInstance service. Disabling these services stops the services and sets the startup type to disabled. Enabling the services starts the services and sets the startup type to automatic.

Important The Service Control capability is intended for use in the event that you suspect that an EdgeSight Agent is causing performance or software compatibility problems. By using the Service Control feature, you can disable services and keep them from restarting. If you uninstall the agent when a problem occurs, you may lose data which may help in resolving the problem.
The Service Control tab is enabled by default for EdgeSight for XenApp agents, but it disabled by default for EdgeSight for Endpoints agents. The Service Control tab can be displayed by setting the SHOW_SERVICES_TAB parameter to 1 during agent installation, or by setting the HKEY_LOCAL_MACHINE\SOFTWARE\Citrix\System Monitoring\Agent\Core\4.00\Control Panel\AllowServiceControl registry key to 1.

Upgrading Agents
Important Upgrading from a Technology Preview Release is not supported. Important Perform the EdgeSight Server upgrade before upgrading the associated EdgeSight agents.
There is no upgrade path associated with the EdgeSight for XenApp 6 Agent x64 5.3 (64-bit). This version of the agent is only supported for installation on XenApp 6.0 systems and requires a clean installation. You can directly upgrade to EdgeSight Agent 5.2 from EdgeSight Agent 4.2 or 4.5 using a new MSI file. If you do not have the latest service pack installed for a prior version, install the service packs for the specific version before upgrading to EdgeSight Agent 5.2. Agent data files (agent database and log files) and registry key settings are retained during the upgrade.

Important If agents are not upgraded to a minimum version of 5.2, data for the associated device cannot be uploaded to an EdgeSight 5.3 server, as described in Agent Requirements on page 13.
Direct upgrades of EdgeSight 4.1 agents are not supported. If you are using an EdgeSight 4.1 agent, you can first upgrade to a 4.2 agent and then perform a 5.2 upgrade. This will retain agent data and settings. If you do not need to retain data, you can uninstall the 4.1 agent and reinstall an EdgeSight 5.2 agent.

Chapter 3

Installing Citrix EdgeSight Agents

51

Uninstalling Agents
You can uninstall an agent using any of the following methods: Execute the msiexec command for the EdgeSight MSI with the / uninstall argument Right click on EdgeSight.msi and choose Uninstall from the pop-up menu Use the Add and Remove Programs feature on the Control Panel

You may encounter an error during uninstallation indicating that files cannot be removed from the system. In most cases, clicking Retry will result in a successful uninstallation. After uninstalling an agent, reboot the target machine. If the machine is not rebooted, a subsequent attempt to install an agent will fail. Note that the DELETE_DATA_ON_UNINSTALL property controls whether agent data files (agent database and log files) are deleted when the agent is uninstalled. The default setting is to delete agent data files. See Setting Installation Properties on page 40 for more information.

52

Citrix EdgeSight Installation Guide

C HAPTER 4

Installing EdgeSight for Monitoring Virtual Desktops

This chapter provides instructions on installing EdgeSight Server, EdgeSight Agent Database Servers, and EdgeSight for Endpoints Agents where virtual desktops in a pool are being monitored. Installation instructions are based on a new installation.

Overview
When monitoring physical endpoint machines, EdgeSight Agents store performance and availability data in a local database. Because virtual desktops in a pool are not preserved across reboots, agents must store data externally on a database server and a file share. The following figure shows the components required for virtual desktop monitoring.

54

Citrix EdgeSight Installation Guide

EdgeSight ServerIn addition to displaying reports and providing an interface for administration and configuration, EdgeSight Server includes database broker components which respond to agent requests for a connection string to an EdgeSight Agent Database Server. EdgeSight Agent Database ServerThe EdgeSight Agent Database Server provides storage for data collected by EdgeSight Agents running on virtual desktops in a pool. During installation you will be asked to specify the name of the pool and the name of the EdgeSight Server which will act as the database broker. (Multiple agent database servers can be associated with a pool.) Once the agent database server has been installed, it registers with the EdgeSight Server and regularly reports its operational status. Agent Data File ShareThe agent data file share provides storage for files such as log files and INI files which are not stored on the EdgeSight Agent Database Server. It is recommended that you set up your file share on either the EdgeSight Server or on an agent database server machine. EdgeSight for Virtual Desktops Agent or EdgeSight for Endpoints Agent The agent you install depends on the virtual desktops being monitored. If you are monitoring virtual desktops running XenDesktop 4.0, use the EdgeSight for Virtual Desktops Agent. If you are monitoring virtual desktops running XenDesktop 3.0, use the EdgeSight for Endpoints Agent. Initially, the EdgeSight Agent requests a connection string to an EdgeSight

Chapter 4

Installing EdgeSight for Monitoring Virtual Desktops

55

Agent Database Server. Once the agent is operational, it writes data to the agent database server and copies files to the agent data file share. Installation and configuration tasks should be performed in the following order: 1. 2. 3. 4. Install the EdgeSight Server that will also act as the broker for remote agent databases. See Installing EdgeSight Server on page 55 for details. Install one or more agent database servers for each pool. See Installing the Agent Database Server on page 56 for details. Setup a file share for agent data that does not reside in the database. See Setting Up the Agent Data File Share on page 57 for details. Install the EdgeSight Agent on the disk to be used by virtual desktops. See Installing the Agent on page 62 for details.

For overall system requirements for a virtual desktop environment, see Virtual Desktop Monitoring Requirements on page 21.

Installing EdgeSight Server

EdgeSight Server software includes components that assist agents running on virtual desktops to locate and connect to remote databases. When you install the EdgeSight Server Website, it additionally installs Web services that perform the following operations: Broker database connections for agents running on virtual desktops in a pool Monitor the status of available agent databases

These components are installed by default; you do not have to explicitly select or configure them. This allows you to easily designate a different EdgeSight Server as the database broker. If you have multiple EdgeSight Server installations, you need only select one to act as the database broker, though you may designate others if you wish. The EdgeSight Server that will act as the database broker is selected when you install the agent database server, as described in Installing the Agent Database Server on page 56. Note that if an EdgeSight Server is not brokering database connections, no status information will be displayed on the Agent Database Broker pages of the server console. See Chapter 2, Installing Citrix EdgeSight Server for detailed instructions on installing EdgeSight Server software.

56

Citrix EdgeSight Installation Guide

Installing the Agent Database Server

The agent database server can be installed on a Windows physical or virtual server-class machine. See Chapter 1, Installation Overview for system requirements. The installation creates a database monitor. An agent database is created when an agent is brokered to the agent database server. The database stores data written by an EdgeSight Agent, while the database monitor reports database availability and status to the EdgeSight Server acting as a database broker. If a firewall is installed on the machine, port 9037 must be open to allow communication with EdgeSight agents. Each agent database server can support one image pool. During installation you will be asked to specify the name of the pool and the name of the EdgeSight Server which will act as the database broker. Typical disk space usage is generally 70 MB per virtual desktop for the databases on a single disk. After the installation is complete, the database monitor reports the availability of the agent database server to the database broker. 1. 2. 3. 4. 5. 6. Insert the media. Select EdgeSight Component Installers. Select EdgeSight Agent Database Server. The installer Welcome page is displayed. Click Next. The End User License Agreement page is displayed. After reading the license agreement, select the I accept radio button and click Next. The Network Settings page is displayed. Enter the broker name and port. The broker name is the name of the machine hosting the previously installed EdgeSight Server, which includes the database broker components. You can also enter an IP address or fully qualified domain name. The Automatically configure Windows Firewall for Port 9037 checkbox is selected by default. Enabling this feature automatically configures the firewall for the database listen port (the port on which the agent database server listens for remote connections from the database broker). The firewall must be running, but can either be enabled or disabled. The exclusion is set up for Domain networks. If an exception for Private networks is required, the Domain exception can be used as a template. If you do not want Windows Firewall automatically configured, deselect the checkbox. If an SSL network connection is required, select the Use SSL checkbox. If a proxy server is used, select the Use a proxy server checkbox. Then enter the proxy server name and port and the username/password used to access the server.

7.

8. 9.

Chapter 4

Installing EdgeSight for Monitoring Virtual Desktops

57

10. 11. 12. 13.

After specifying the network settings, click Next. The Agent Location screen is displayed. Enter the installation path for the agent database server or accept the default value. You can browse to select a non-default location. Enter the installation path for the data files or accept the default. You can browse to select a non-default location. Enter a name for the pool hosting the agents which will store data on the agent database server. You can choose any pool name. For ease of use, you may want to choose one that corresponds to the XenDesktop desktop group name. Click Next. The Ready to Install screen is displayed. Click Next to begin the installation. The Performing Installation screen is displayed. When the installation is complete, the Setup Complete page is displayed. Click Finish to exit the setup wizard.

14. 15.

16.

Setting Up the Agent Data File Share

Some agent data are not stored in the agent database, such as log files and INI files. Therefore, agents running on virtual desktops require access to an external file share. The file share must be configured with permissions allowing authenticated users to create subdirectories that will contain the files, plus settings. The disk space needed is minimal and the file copies are small and infrequent. It is recommended that you set up your file share on either the EdgeSight Server or on an agent database server machine. The permissions required include both the file share permissions and the NTFS file system permissions. To create an agent data file share and set all permissions on a Windows 2003 system: 1. Create a new folder. The file share should not be located on a specific users desktop. Record the folder UNC path for use during the agent installation process. Right click on the folder name and select Properties from the popup menu. The Properties dialog is displayed. Select the Sharing tab. Select the Share this folder radio button. Click the Permissions button. The Permissions dialog is displayed. Click Add. The Select Computer, User, or Group dialog is displayed. Enter Authenticated Users in the Enter object name to select field. Click OK.

2. 3. 4. 5. 6.

58

Citrix EdgeSight Installation Guide

7. 8. 9. 10.

Select the Authenticated Users group. Ensure that the Change and Read permissions are selected and click OK. Select the Security tab and click the Advanced button. The Advanced Security Settings dialog is displayed. Deselect the checkbox which enables child objects to inherit permission entries from the parent. (The specific checkbox label may vary based on the operating system.) When this setting is disabled, a Security dialog is displayed advising you that permission entries will no longer be inherited. Click Remove. Click Add. The Select Computer, User, or Group dialog is displayed. Enter Authenticated Users in the Enter object name to select field. Click OK. The Permission Entry dialog is displayed. Select This folder only from the Apply onto drop down menu. Ensure that the following permissions are allowed: List Folder / Read Data Read Attributes Read Extended Attributes Create Folders / Append Data Delete Read Permissions

11. 12. 13. 14.

Chapter 4

Installing EdgeSight for Monitoring Virtual Desktops

59

15.

Click OK on all open dialog boxes.

To create an agent data file share and set all permissions on a Windows 2008 system: 1. Create a new folder. The file share should not be located on a specific users desktop. Record the folder UNC path for use during the agent installation process. Right click on the folder name and select Properties from the popup menu. The Properties dialog is displayed. Select the Sharing tab. Select the Share button. The File Sharing dialog is displayed. Enter Authenticated Users in the text entry field. Click Add. Select the Authenticated Users group and click on Contributor in the drop-down menu. Click Share. When the operation is complete, click Done. Select the Security tab, select Authenticated Users from the list of groups and user names. Click the Advanced button. The Advanced Security Settings dialog is displayed.

2. 3. 4. 5. 6. 7.

60

Citrix EdgeSight Installation Guide

8. 9.

Select Authenticated Users from the list of permission entries and click Edit. The Advanced Security Settings dialog is displayed. Deselect the checkbox which enables child objects to inherit permission entries from the parent. (The specific checkbox label may vary based on the operating system.) When this setting is disabled, a Security dialog is displayed advising you that permission entries will no longer be inherited. Click Remove. Select Authenticated Users from the list of permission entries and click Edit. The Permission Entry dialog is displayed. Select This folder only from the Apply to drop down menu. Ensure that the following permissions are allowed: List Folder / read data Read Attributes Read Extended Attributes Create Folders / append data Delete Read Permissions

10. 11. 12.

13.

Click OK on all open dialog boxes.

Before You Install the Agent

Before installing the agent in a virtual desktop environment, you must perform the following tasks: 1. 2. 3. Ensure that you have the information required during agent installation. Place the group of virtual desktops in maintenance mode and then shut them down. Set the vDisk access mode to private.

Chapter 4

Installing EdgeSight for Monitoring Virtual Desktops

61

Note This procedure assumes that you are working with an existing master image. You can also install the agent as part of creating a master image prior to sharing the image out to the pool.

Shutting Down Virtual Desktops

Important Before shutting down virtual desktops, ensure that they are not in use to avoid loss of data.
Before installing the agent in a virtual desktop environment, you must ensure that the virtual desktops are in maintenance mode and are then shut down. To set the virtual desktops to maintenance mode and shut them down: 1. 2. Log on to the Desktop Delivery Controller (DDC) for the target desktop group and open the Citrix Access Management Console. Navigate to Citrix Resources > Desktop Delivery Controller > FarmName > Desktop Groups and click on the target group. A list of the virtual desktops is displayed. Select all desktops in the group and right click on the group to display the pop-up menu. Select Enable maintenance mode. This temporarily stops connections to the desktops. Right click on the group again and select Shutdown/suspend from the popup menu. The Shutdown/suspend dialog is displayed. Select Shut down from the drop-down menu and click OK. (You may need to refresh the display to update the status displayed for the desktops.)

3.

4. 5.

Setting the vDisk Access Mode to Private

You must set the access mode property for the vDisk associated with the target desktop group. 1. Log on to the Provisioning Server associated with the vDisk on which the EdgeSight Agent will be installed and start the Provisioning Server Console. Navigate to FarmName > Stores and select the store associated with the target vDisk. Right click on the vDisk and select Properties from the pop-up menu. Click on the Edit file properties button. The vdisk File Properties dialog is displayed. Select the Mode tab. Select Private access (single device, R/W access) from the Access Mode drop down menu and click OK.

2. 3. 4. 5. 6.

62

Citrix EdgeSight Installation Guide

7.

Click OK in the vdisk File Properties dialog.

Information Required During Agent Installation

Ensure that you have the following information at hand before installing the agent software on the master image: The UNC path name of the agent data file share. The Network Service that will be running on desktops will need to be able to create directories and copy files to this share. The fully-qualified domain name or IP address of the EdgeSight Server that will be acting as the database broker. In addition to the server name you can specify the port and SSL or proxy server information, if used. The name of the pool in which the virtual desktops will be running. This pool name is case sensitive and must match the pool name specified during the agent database server installation. The pool name corresponds to the XenDesktop desktop group name.

Installing the Agent

You install the EdgeSight for Virtual Desktops Agent or the EdgeSight for Endpoints Agent on the master image. During the installation, you indicate that the agent is being installed on virtual desktops. After the agent installation is complete, you must reboot your master image.

Software Configuration Tasks

You may need to change the configuration of some software, such as antivirus software or personal firewalls, on machines which will run the EdgeSight Agent and will host the agent database server and the agent data file share to ensure proper operation. You can perform these configuration tasks before or after installing the EdgeSight Agent. For more information, see Software Configuration Tasks on page 22. If you are running a firewall on the machine hosting the agent database server, the port used to communicate with EdgeSight agents must be open. The default port is 9037.

Chapter 4

Installing EdgeSight for Monitoring Virtual Desktops

63

Antivirus Configuration Checking

Due to the manner in which buffer overflow protection was implemented in McAfee VirusScan 8 or 8i with Patch 10, this feature which may conflict with the operation of the EdgeSight Agent. (In later versions of McAfee VirusScan, this feature was implemented differently and does not conflict with EdgeSight Agent operation.) The EdgeSight Agent installer checks for McAfee 8 or 8i with Patch 10 or below on the target machine. If the EntApi.dll file is present with version 8.0.0.277 and below, the installation exits with an error. The check is performed on both full UI and unattended installations. In a command-line installation, the check can be omitted from the installation process by specifying the OVERRIDE_COMPCHECK property with a value of 1.

Note The OVERRIDE_COMPCHECK property should only be used if you disable the McAfee buffer overflow protection feature as described in the Release Notes for your EdgeSight product.

Agent Installation Methods

The MSI file uses public properties to specify custom install settings. You can set public properties using the following methods: Run the installer user interface (if the property is exposed). This method offers fewer installation options than using the command-line interface. Also, a log file is not created when the user interface is used for installation. Create a transform file using a tool such as Orca. Specify key/value pairs on the command line. This method allows you to control the full range of installation options, including specifying a log file, as well as being able to specify public properties. The syntax for key/value pairs is KEY=value.

See your MSI documentation for syntax rules for property values. See Setting Installation Properties on page 40 for definitions of the public properties used when installing the EdgeSight agent:

Installing an Agent Using the User Interface

Note that not all public properties listed in Setting Installation Properties on page 40 are exposed when installing using the user interface. Properties not explicitly set from the user interface are set to their default value if one exists. To install an agent using the user interface: 1. 2. Insert the media. Select EdgeSight Agent Installers.

64

Citrix EdgeSight Installation Guide

3. 4. 5. 6.

Select EdgeSight for Virtual Desktops Agent or EdgeSight for Endpoints Agent. The Welcome screen is displayed. Click Next to continue. The License Agreement screen is displayed. After reading the license, select the I accept radio button and click Next. The Company Information screen is displayed. Enter the company name. If you are installing an EdgeSight for Endpoints agent for monitoring XenDesktop 3.0 instances, you can also specify a department. If no department name is provided, the agent data will be displayed under the root department. If you are installing an EdgeSight for Virtual Desktops agent for monitoring XenDesktop 4.0 instances, the department field cannot be set because the department is determined by the XenDesktop Farm structure. Click Next. The Agent Location screen is displayed. Enter the installation path for the agent or accept the default value. You can browse to select a non-default location. Enter the installation path for the data files or accept the default. You can browse to select a non-default location. Click Next. The Network Settings screen is displayed. Enter the server name and port number. These are required fields. If an SSL network connection is required, select the Use SSL checkbox. (This is equivalent to setting the CONNECTION_FLAGS property.) If a proxy server is used, select the Use a proxy server checkbox. Then enter the proxy server name and port and the username/password used to access the server. (This is equivalent to setting the PROXY_ADDRESS, PROXY_PORT, and PASSWORD properties.) Click Next. The Advanced Settings screen is displayed. Select the Configure the agent for virtual desktops checkbox. In the Remote UNC Path field, enter the UNC path for the agent data file share, for example \\Myserver.mydomain.com\AgentFiles. For information on setting up the file share, see Setting Up the Agent Data File Share on page 57. In the Pool Name field, enter the name of the pool in which the virtual desktops will be running. This pool name is case sensitive and must match the pool name specified during the agent database server installation, as described in Installing the Agent Database Server on page 56. In the Database Broker field, enter the fully-qualified domain name of the EdgeSight Server which will be acting as the database broker. (The database broker components are installed on every EdgeSight Server and cannot be installed separately or moved.)

7. 8.

9. 10. 11.

12. 13.

14.

15.

Chapter 4

Installing EdgeSight for Monitoring Virtual Desktops

65

16. 17.

If an SSL network connection is required, select the Use SSL checkbox. If a proxy server is used, select the Use a proxy server checkbox. Then enter the proxy server name and port and the username/password used to access the server. Click Next. The Ready to Install screen is displayed. If you need to review or change any settings before installing, use the Back button to return to the configuration screens. Click Install to begin the installation. When the installation is complete, the Setup Complete screen is displayed. Click Finish to complete the installation. The Installer Information dialog is displayed, prompting you to reboot your system so that configuration changes will be applied. Click Yes to reboot your machine.

18. 19. 20.

21.

It is recommended that you flush the DNS cache after rebooting the machine (ipconfig /flushdns). This can help prevent errors related to DNS caching when the agent initially accesses the network.

Installing an Agent Using the Command-Line Interface

Use the msiexec command to install the agent using the command-line interface. Public properties are specified as KEY=value pairs as described in Setting Installation Properties on page 40. If a property has a default value, that value is used if the property is not specified on the command line. When performing an installation in a virtual desktop environment using the command line, the following properties should always be specified: SERVER_NAMEIf the server name is not specified, the agent is unable to obtain configuration information or upload data. COMPANYIf the company name is not specified, the device is considered an unmanaged device and cannot upload data to the server. POOLED_INSTALLThis flag and the following properties are required so that the agent can communicate with the database broker components of EdgeSight Server and can copy and retrieve files from the agent data file share. REMOTE_PATH IMAGE_POOL DBBROKER_FQDN BROKER_PORT

66

Citrix EdgeSight Installation Guide

ALLOWSERVEROS should be specified if you attempt to install a Citrix EdgeSight for Endpoints agent on a system running a server OS. If this property is not specified, a warning is issued. During a silent installation to a system running a server OS, the install fails unless the ALLOWSERVEROS property is set to 1. ALLOWVIRTUAL should be specified if you attempt to install an EdgeSight for Endpoints agent on a virtual desktop instance running XenDesktop 4.0. If this property is not specified, a warning is issued. During a silent installation to a virtual desktop instance running XenDesktop 4.0, the install fails unless the ALLOWVIRTUAL property is set to 1. The following is a sample command line for the installation of an EdgeSight for Endpoints agent on a 64-bit virtual desktop system:
Msiexec /i EdgeSightEPAgentx64.msi /l logfile.log /q SERVER_NAME=Myserver COMPANY=Mycompany DEPARTMENT=Mydept POOLED_INSTALL=1 REMOTE_PATH=\\Myserver.mydoain.com\AgentFiles IMAGE_POOL=Pool2 DBBROKER_FQDN=Myserver.dom1.com BROKER_PORT=80

The /i flag is used to specify the package being installed. The /l flag is used to specify the installation log file name. (Capturing an installation log is strongly recommended.) Use the /q (quiet) flag to install an agent with no user interaction. For a complete list of standard MSI command-line arguments, open a Command Prompt window and type msiexec /h to invoke help, or refer to The Command-Line Options for the Microsoft Windows Installer Tool Msiexec.exe at http://support.microsoft.com/kb/314881.

Deploying the Agent to Virtual Desktops in a Pool

To deploy the agent to the virtual desktops in a pool, perform the following tasks: 1. 2. 3. Shut down the master image. Set the access mode property for the vDisk associated with the target desktop group to Standard Image. Disable maintenance mode on the desktop group.

Note This procedure assumes that you are working with an existing master image. You can also install the agent as part of creating a master image prior to sharing the image out to the pool. If you are not working with an existing vDisk, create the vDisk at this point in the procedure.

Shutting Down the Master image

The master image must be shut down so that the access mode property for the vDisk can be changed.

Chapter 4

Installing EdgeSight for Monitoring Virtual Desktops

67

Setting the vDisk Access Mode

You must set the access mode property for the vDisk associated with the target desktop group. 1. Log on to the Provisioning Server associated with the master image on which the EdgeSight Agent was installed and start the Provisioning Server Console. Navigate to FarmName > Stores and select the store associated with the target vDisk. Right click on the vDisk and select Properties from the pop-up menu. Click on the Edit file properties button. The vdisk File Properties dialog is displayed. Select the Mode tab. Select Standard Image (multi-device, write-cache enabled) from the Access Mode drop down menu and click OK. Click OK in the vdisk File Properties dialog.

2. 3. 4. 5. 6. 7.

Disabling Maintenance Mode

To enable normal operation by the virtual desktops, you must ensure that maintenance mode is disabled. To disable maintenance mode for the desktop group: 1. 2. Log on to Desktop Delivery Controller (DDC) for the target desktop group and open the Citrix Access Management Console. Navigate to Citrix Resources > Desktop Delivery Controller > FarmName > Desktop Groups and click on the target group. A list of the virtual desktops is displayed. Select all desktops in the group and right click on the group to display the pop-up menu. Select Disable maintenance mode.

3.

68

Citrix EdgeSight Installation Guide

Agent Database Connection Acquisition

When you configure the agent for virtual desktops, file monitor components are installed which manage copying files to and retrieving files from the agent data file share. The agent is configured to contact the database broker to receive a database connection string. If it fails to get a database connection, it shuts down and writes error information to the local SYS_EVENT_TXT.TXT log. If the file monitor components are functioning properly, a copy of the log file will also be placed on the agent data file share. You can change incorrect configuration settings using the agents control panel application. However, you must make those changes on the master image in order for them to be propagated to all desktops.

Configuring Agents Using the Control Panel

If you need to reconfigure connection settings for agent to server communication after installation, use the Citrix System Monitoring Agent control panel applet. You must have Administrator privileges on the machine to launch the applet. In a virtual desktop environment, any changes to these settings must be made on the master image and then deployed to the pool. The Service Control tab is disabled by default for EdgeSight for Virtual Desktops and EdgeSight for Endpoints agents. The Service Control tab can be displayed by setting the SHOW_SERVICES_TAB parameter to 1 during agent installation, or by setting the HKEY_LOCAL_MACHINE\SOFTWARE\Citrix\System
Monitoring\Agent\Core\4.00\Control Panel\AllowServiceControl

registry key to 1. To use the applet: 1. From the Start menu, choose Settings > Control Panel and select Citrix System Monitoring Agent. The Citrix System Monitoring Agent Settings dialog is displayed. Select the Remote Share tab. Edit the UNC path to the agent data file share as required. Select the EdgeSight Server tab. Edit the Citrix EdgeSight Server address and port number as required. Select the Use SSL encryption checkbox if the Citrix EdgeSight Server is SSL enabled. To be SSL enabled, a valid SSL certificate issued by a trusted certificate authority must be present on the server running the Citrix EdgeSight Web site. If SSL support is enabled, all agent to server communications must be over SSL. If an agent attempts to connect to an SSL-enabled server without using SSL, an error is generated and the data upload is rejected.

2. 3. 4.

Chapter 4

Installing EdgeSight for Monitoring Virtual Desktops

69

5.

Select the Use a proxy server checkbox if a proxy server is used. Enter the proxy server address and port and indicate whether the server is a non-SSL tunnel and whether authentication is required. Supply the authentication username and password if required. Select the Broker Server tab. Edit the address and port number for the EdgeSight Server acting as the database broker as required. You can also edit SSL and proxy server settings as described in steps 4 and 5. When you have made all required settings changes, click OK to apply the changes and close the dialog.

6.

7.

Important The Service Control capability is intended for use in the event that you suspect that an EdgeSight Agent is causing performance or software compatibility problems. By using the Service Control feature, you can disable services and keep them from restarting. If you uninstall the agent when a problem occurs, you may lose data which may help in resolving the problem.

Upgrading EdgeSight Installations

The following upgrade information relates to upgrades from EdgeSight 5.0 or 5.1 agents to EdgeSight 5.2 agents: If you have existing EdgeSight Agents running on virtual desktops, you must uninstall and reinstall the agents. The Agent Database Server can be directly upgraded. Any agent databases currently resident on the server are also upgraded. This ensures that no data is lost when EdgeSight for Endpoints Agents are replaced with EdgeSight for Virtual Desktops Agents.

Because all required components must be in place, and because some installation steps are dependent on previous actions, the following task sequence is recommended: 1. 2. 3. 4. Uninstall the agents (Uninstalling Agents on page 70). Upgrade EdgeSight Server (Upgrading Citrix EdgeSight Server on page 34). Upgrade the Agent Database Server (Installing the Agent Database Server on page 56). Install the new agents (Installing the Agent on page 62).

70

Citrix EdgeSight Installation Guide

Uninstalling Agents
You can uninstall an agent using any of the following methods: Execute the msiexec command for the EdgeSight MSI with the /uninstall argument Right click on the EdgeSight Agent MSI file and choose Uninstall from the pop-up menu Use the Add and Remove Programs feature on the Control Panel

You may encounter an error during uninstallation indicating that files cannot be removed from the system. In most cases, clicking Retry will result in a successful uninstallation. After uninstalling an agent, reboot the target machine. If the machine is not rebooted, a subsequent attempt to install an agent will fail.

C HAPTER 5

Installing EdgeSight Active Application Monitoring Software

This chapter provides instructions on installing the EdgeSight Active Application Monitoring (AAM) software. Before starting an installation, make sure that you have reviewed the prerequisites and system requirements listed in Chapter 1, Installation Overview. The Launcher is installed as a service (Citrix EdgeSight Launcher Service). The default location for Launcher installation is:
%ProgramFiles%\Citrix\Citrix EdgeSight Simulation\ LauncherService.exe

Launchers and the Controller use port 18747 to communicate.

Active Application Monitoring Deployment

EdgeSight AAM depends on the deployment of several software components. For AAM component system requirements, see Active Application Monitoring Requirements on page 21.

1.

Install EdgeSight Server, adhering to the system requirements listed in Server Requirements on page 15.

72

Citrix EdgeSight Installation Guide

2.

Install the AAM Controller and Launcher, adhering to the system requirements listed inActive Application Monitoring Requirements on page 21. These components can be installed on the same machine or on different machines. Optionally, install the Web Interface Connector. This component is required if users will be connecting to XenApp systems using the XML service. The Web interface Connector requires the installation of Microsoft Visual J# .NET Redistributable Package. Install the EdgeSight for XenApp Agent on each XenApp system to be tested, adhering to the system requirements listed in Agent Requirements on page 13. The agent must be installed in Advanced Mode to ensure that AAM-related alerts can be generated.

3.

4.

After deploying the software components, you can perform the following tasks, as described in EdgeSight Active Application Monitoring Help and EdgeSight Server Online Help: Configure the systems to be tested, as well as the systems hosting the Controller and Launchers. Using the Controller, create a script, including monitoring points, and create virtual users. Using the EdgeSight Server Console, create Application Response Time and Application Response Failure alerts for real-time notification of application response times that exceed thresholds or application response failures. Using the EdgeSight Server Console, monitor applications under test using the Application Response Time and Application Response Failure historical reports.

Installing the Active Application Monitoring Components

Important If you previously installed the AAM components included with the EdgeSight 5.3 release, you will be prompted to uninstall those components before running the EdgeSight AAM 5.3 Service Pack 1 installer.
Use the following steps to initially install the software: 1. 2. 3. 4. Insert the media or run Autorun. Select EdgeSight Component Installers. Select EdgeSight Active Application Monitoring Installation. The Welcome screen is displayed. Click Next to continue. The License Agreement screen is displayed.

Chapter 5

Installing EdgeSight Active Application Monitoring Software

73

5. 6.

After reading the license, select I accept and click Next. The Installation Type screen is displayed. Select the type of installation you want to perform. If you selected Custom, go to Step 7. If you selected Typical or Complete, skip to Step 8. Typical Install the Controller and Launcher Custom Select the components you want to install from Controller, Launcher, and Web Interface Connector. When you use the Web Interface Connector, it must be installed on the Controller and Launcher. The Web Interface Connector allows users to connect to applications made available through the XML Service. This feature requires the Visual J# Version 2.0 Redistributable Package available from Microsoft at http://msdn2.microsoft.com/en-us/vjsharp/ default.aspx. Complete Install the Controller, Launcher, and Web Interface Connector.

7.

By default, all components are enabled. To disable installation of a component, click the component and select Entire feature will be unavailable. Click Disk Usage to display disk space availability, or click Reset to return to the default component selections. When you have completed feature selection, click Next. The system prompts for a password. This password will be required when using each Launcher and the Controller. The password must be at least 8 characters in length and should match the passwords set on all Launcher machines to be used in the test. Click Install to install the software. The Performing Installation Tasks screen is displayed. The Installation Complete screen is displayed after the software is installed. Click Finish to exit the Setup Wizard.

8.

9. 10.

After the installation is complete, go to Citrix > Citrix EdgeSight Active Application Monitoring > AAM Controller and login using the previously specified password. Select Help Topics from the Help menu to display online help. The help file includes information about configuring Controllers, Launchers, and XenApp systems under test.

74

Citrix EdgeSight Installation Guide

I NDEX

Index

A
AAM See Active Application Monitoring 71 ACCOUNTNAME installation property 30 ACCOUNTPASSWORD installation property 30 Active Application Monitoring installation overview 10 installing 71 MSI file 8 system requirements 21 Active Application Monitoring Controller 10 Active Application Monitoring Launcher 10 Active Application Monitoring Web Interface Connector 11 Agent Data File Share 54 agent data file share creating and configuring 57 Agent Database Server system requirements 16 ALLOWSERVEROS installation property 42 antivirus software configuring 22

C
Citrix EdgeSight Agent command line interface installation 45, 65 deploying 10 MSI files 10 setting installation properties 40, 63 uninstalling 51, 70 upgrading 50 user interface-based installation 39, 63 Citrix EdgeSight Server command line interface installation 31 installation methods 29 installation prerequisites 26 post-installation wizard 32 setting installation properties 29 uninstalling 35 upgrading 34 user interface-based installation 27 Citrix License Server 9 Citrix License Server for Windows 20 Citrix Provisioning Server for Datacenters 46 Citrix System Monitoring Agent control panel applet 49, 68 Citrix System Monitoring Service Service Control tab 50 company creating initial 32 COMPANY installation property 41 CONNECTION_FLAGS installation property 43 CPU for agent 1314 for agent database server 16 for database server 16 for Web server 15 CPU requirements Active Application Monitoring components 21

B
BROKER_ CONNECTION_FLAGS installation property 44 BROKER_PORT installation property 44 BROKER_PROXY_ ADDRESS installation property 44 BROKER_PROXY_ FLAGS installation property 44 BROKER_PROXY_ PASSWORD installation property 44 BROKER_PROXY_PORT installation property 44 BROKER_PROXY_USER installation property 44

76

Citrix EdgeSight Installation Guide

D
Database for database server 16 Database broker components 55 Database monitor components 55 DATABASEOPTIONS installation property 30 DATABASESERVER installation property 30 DATADIR installation property 31 DATAFILESIZE installation property 31 DATA_DIR installation property 41 DBBROKER_FQDN installation property 44 DBNAME installation property 30 DBPASSWORD installation property 30 DBUSERNAME installation property 30 DELETE_DATA_ON_ UNINSTALL installation property 41 DELETE_DATA_ON_UNINSTALL agent installation parameter 51 DEPARTMENT installation property 41 Disk requirements Active Application Monitoring components 21 Disk space for agent 1314 for database server 16 for Web server 15

G
Group Policy 12

H
HTTP_TIMEOUT installation property 43

I
IIS Security Lockdown template 12 IMAGE_POOL installation property 44 INSTALLOPTIONS installation property 31 INSTALLROOT installation property 41

L
language support operating system 20 License installing 25 license 20 license files installing 25 License server monitoring requirements 18 LOGFILESIZE installation property 31

E
EDGEDIR installation property 31 EdgeSight Agent Database Server 54 installing 56 MSI file 8 EdgeSight for Endpoints Agent MSI files 8 EdgeSight for Presentation Server Agent MSI files 8 EdgeSight for Virtual Desktops Agent MSI files 8 EdgeSight Server installing for use in pooled environment 55 MSI files 8 email configuring initial settings 32

M
Memory for agent 1314 for agent database server 16 for database server 16 for web server 15 Memory requirements Active Application Monitoring components 21 MSI file names 7 msiexec command 31, 45, 65 flags 31, 45, 66

N
NO_CONTROL_PANEL installation property 43

F
Firewalls 11 FIREWALL_ EXCEPTION_ ALLOWED installation property 44 FUNCTIONALITY_ MODE installation property 43

O
Operating system for agent 1314 for agent database server 16 for database server 16 for Web server 15

Index
Operating system requirements Active Application Monitoring components 21 OVERRIDE_ COMPCHECK installation property 43

77

W
WINDOWS_AUTH installation property 30

P
POOLED_INSTALL installation property 44 pre-installation tasks for virtual desktop monitoring 60 PREREQUISITES_ PASSED installation property 30 Proxy Servers and Settings 11 PROXY_ADDRESS installation property 43 PROXY_FLAGS installation property 43 PROXY_PASSWORD installation property 43 PROXY_PORT installation property 43 PROXY_USER installation property 43

Z
64-bit support 13

R
RECOVERYMODEL installation property 31 REMOTE_PATH installation property 44 REMOTE_SECURITY installation property 41 REMOTE_SECURITY_ GROUP installation property 42 Reporting Services 9

S
SERVER_NAME installation property 44 SERVER_PORT installation property 44 Session Experience Monitoring system requirements 18 SHOW_SERVICES_TAB agent installation parameter 50, 68 SHOW_SERVICES_TAB installation property 43 SMTP Server 12 SQL Server 2005 Password Policy 12 SSL Certificate 12 streamed environment installing the agent 46 Superuser creating account 32 SYNCH_AD_TREE installation property 42 system requirements agent 13 browser 19 server 15

V
virtual desktop monitoring 53 Virus scanning software 1112

78

Citrix EdgeSight Installation Guide