edgesight admin guide - wag the real · 6 citrix edgesight for netscaler administrator’s guide...

Citrix® EdgeSight® for NetScaler® 2.0

Citrix EdgeSight for NetScaler Administrator’s Guide

Copyright and Trademark NoticeUse 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 AcknowledgementsAdobe, Acrobat, and Flash are trademarks or registered trademarks of Adobe Systems Incorporated in the U.S. and/or other countries.

Microsoft, 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: August 13, 2010 (MS)

CONTENTS

Contents

About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5New in This Release . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6Related Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6Getting Service and Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6

Knowledge Center . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7Education and Training . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7

Documentation Feedback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8

Chapter 1 OverviewEdgeSight for NetScaler Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10Administrative Task Roadmap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10

Configure the Connection to Reporting Services . . . . . . . . . . . . . . . . . . . . . . . .10Add Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10Add Authentication Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10Add Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11

Chapter 2 Software Configuration TasksEnabling EdgeSight for NetScaler Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

Enabling the NetScaler HTML Injection Feature. . . . . . . . . . . . . . . . . . . . . . . .13Specifying the EdgeSight for NetScaler Server in the Injection Script . . . . . . .13Configuring HTML Injection for Your Site . . . . . . . . . . . . . . . . . . . . . . . . . . . .14Verifying the HTML Injection Configuration . . . . . . . . . . . . . . . . . . . . . . . . . .15Registering the NetScaler Appliance with the EdgeSight for NetScaler Server16

Chapter 3 Managing Company SettingsManaging Profiles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17Managing Company Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17

Time Zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18Managing Data Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18

2 Citrix EdgeSight for NetScaler Administrator’s Guide

Managing NetScaler Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18Managing Applications and Groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18Managing Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19Managing Geolocations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19Managing Private IP Ranges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19Creating Users and Assigning Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19Managing Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21

Managing Report Subscriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21Uploading Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22

Modifying Existing Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23Defining Report Modification Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . .24Downloading a Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24Modifying a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24Uploading a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24Verifying the Modified Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25

Creating New Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25Defining Reporting Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26Creating a Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26Uploading a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26Verifying the New Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27

Generating Reports for Multiple Citrix EdgeSight Servers. . . . . . . . . . . . . . . . . . .27Establishing a Linked Server Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . .28Issuing Distributed Queries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28Configuration Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29

Chapter 4 Managing Server SettingsMonitoring Server Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31Configuring Server Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32

Geo Data Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33Error Handling and Email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34Timeouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35

Configuring Geolocation Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36Configuring GeoData Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36Running GeoData Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36Enabling Geolocation Data Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37

Creating Companies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37Managing Data Collectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38Managing Authentication Providers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38

Using an Active Directory Authentication Provider . . . . . . . . . . . . . . . . . . . . .38Managing Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41


Configuring the Connection to Reporting Services . . . . . . . . . . . . . . . . . . . . . . . . .42Managing Reporting Services Schedules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42Managing the Database. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43

Grooming Schedule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43Server Database Grooming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43

Displaying and Responding to Server Messages . . . . . . . . . . . . . . . . . . . . . . . . . . .44Displaying and Changing Connection String Properties . . . . . . . . . . . . . . . . . . . . .44

Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47

PREFACE

Preface

Before you begin to configure EdgeSight for NetScaler, take a few minutes to review this chapter and learn about related documentation, other support options, and ways to send us feedback.

In This PrefaceAbout This Guide

New in This Release

Audience

Related Documentation

Getting Service and Support

Documentation Feedback

About This GuideThe Citrix EdgeSight for NetScaler Administrator’s Guide provides a conceptual reference and instructions for administering and configuring the EdgeSight for NetScaler Web Client.

This guide provides the following information:

• Chapter 1, “Overview.” Learn about the EdgeSight for NetScaler components and the administrative task roadmap.

• Chapter 2, “Software Configuration Tasks.” Configure the EdgeSight for NetScaler server.

• Chapter 3, “Managing Company Settings.” Learn how to manage configuration settings related to companies hosted on a Citrix EdgeSight for NetScaler server.

• Chapter 4, “Managing Server Settings.” Learn how to manage global settings on a Citrix EdgeSight for NetScaler Server.


New in This ReleaseFollowing is a list of the new features and enhancements in the 2.0 release of EdgeSight for NetScaler.

• Generate real-time and historical reports based on geographical locations of users. For more information, see “Configuring Geolocation Data,” on page 36.

• Generate real-time and historical reports based on private IP ranges. For more information, see “Enabling Geolocation Data Collection,” on page 37.

AudienceThis guide is intended for the following audience:

• System administrators of the NetScaler appliances

• Network managers

• Network and system analysts

The concepts and tasks described in this guide require you to have a basic understanding of network design, operation, and terminology.

Related DocumentationIn addition to the guide you are currently reading, Citrix EdgeSight for NetScaler Administrator’s Guide, the following guides may contain information that is relevant and useful for your system environment. Citrix documentation is available at http://support.citrix.com/.

For information about Citrix EdgeSight for NetScaler, the following guides are available:

• Citrix EdgeSight for NetScaler Installation Guide. Installation instructions for installing EdgeSight for NetScaler server.

• Citrix EdgeSight for NetScaler Release Notes. Up-to-date information about new features and known issues.

Getting Service and SupportCitrix offers the following support options for EdgeSight for NetScaler.

Preface 7

Knowledge CenterThe Knowledge Center offers a variety of self-service, Web-based technical support tools at http://support.citrix.com/.

Knowledge Center features include:

• A knowledge base containing thousands of technical solutions to support your Citrix environment

• An online product documentation library

• Interactive support forums for every Citrix product

• Access to the latest hotfixes and service packs

• Knowledge Center Alerts that notify you when a topic is updated

Note: To set up an alert, sign in at http://support.citrix.com/ and, under Products, select a specific product. In the upper-right section of the screen, under Tools, click Add to your Hotfix Alerts. To remove an alert, go to the Knowledge Center product and, under Tools, click Remove from your Hotfix Alerts.

• Security bulletins

• Online problem reporting and tracking (for organizations with valid support contracts)

Education and TrainingCitrix offers a variety of instructor-led and Web-based training solutions. Instructor-led courses are offered through Citrix Authorized Learning Centers (CALCs). CALCs provide high-quality classroom learning using professional courseware developed by Citrix. Many of these courses lead to certification.

Web-based training courses are available through CALCs, resellers, and from the Citrix Web site.

Information about programs and courseware for Citrix training and certification is available at http://www.citrixtraining.com.


Documentation FeedbackYou are encouraged to provide feedback and suggestions so that we can enhance the documentation. You can provide feedback by sending email to [email protected] with the subject line “ES4NS Admin Guide Feedback”. Be sure to include the following information in your email: document name, page number, and EdgeSight for NetScaler release version.

CHAPTER 1

Overview

Citrix EdgeSight for NetScaler is an agentless solution to monitor the actual end user experience with the HTML web content served to users in a NetScaler environment. It identifies performance issues for users at any location and provides critical visibility into the origin of the problem.

EdgeSight for NetScaler transparently instruments client HTML pages, which assists in Web application monitoring of response time as experienced by end users. This integrated approach to Web application monitoring provides detailed statistics on the trip duration of requests and responses across the Web application delivery infrastructure and provides IT managers with granular visibility to the components of application performance.

The EdgeSight for NetScaler management console provides real-time and historical views of Web application performance. IT administrators are able to monitor the minimum, average and maximum response time for multiple Web applications in a real-time fashion to proactively identify potential problems before users are affected. By intelligently aggregating and presenting this data on a historical basis, application managers can also better understand how the performance of individual Web pages has changed over time.

This chapter describes the primary EdgeSight for NetScaler components, the software architecture, and an overview of administrative tasks.


EdgeSight for NetScaler ComponentsEdgeSight for NetScaler consists of the following components. Each of these components can be installed on individual servers, or they can be installed on a single server for smaller installations.

• EdgeSight Database Server

• EdgeSight Report and Configuration Web Console

• EdgeSight Data Collector

• Reporting Services

Administrative Task RoadmapWhen you perform the initial configuration of EdgeSight for NetScaler using the Post Installation Wizard, you explicitly specify a number of critical operating parameters. These include an initial (or root) company, a Superuser account that can access all companies on a server and can create new users, email settings used to send server notifications, the Citrix NetScaler device that you will be collection data from, and the server hosting the data collector. In addition to these explicitly set parameters, there are many default settings which enable EdgeSight for NetScaler to be fully operational as quickly as possible. This section outlines the remaining tasks that you perform after installation and initial configuration to reach full operational status. Some of these tasks differ depending on your environment, such as you are using the default email authentication provider or Active Directory for authenticating users.

Configure the Connection to Reporting ServicesMicrosoft SQL Server Reporting Services must be installed and configured in order to generate and display EdgeSight for NetScaler reports. Once EdgeSight for NetScaler is installed, you must configure the connection from the EdgeSight for NetScaler Server to the Report Server. For more information, see “Configuring the Connection to Reporting Services” on page 42.

Add RolesBefore adding users (people who can log on to the EdgeSight for NetScaler Web Client), it is recommended that you add any roles that will be required to determine what actions they can perform on the console. For more information on defining roles, see “Creating Users and Assigning Roles” on page 19.

Add Authentication Provider

Chapter 1 Overview 11

If you want to automatically create users based on an Active Directory tree, you must add an AD authentication provider. Before creating a new provider, make sure you have the LDAP path for your AD authentication provider available. For more information on adding an AD authentication provider, see “Managing Authentication Providers” on page 38.

Add UsersIf you are using the default email authentication provider, you can add users and assign roles to them from the EdgeSight for NetScaler Web Client. For more information, see “Creating Users and Assigning Roles” on page 19.Add new users

CHAPTER 2

Software Configuration Tasks

Enabling EdgeSight for NetScaler ServerEdgeSight for NetScaler is an agentless solution for monitoring the end users’ experience with the HTML Web content proxied by a NetScaler. (EdgeSight for NetScaler software is intended for use with the NetScaler 8.x release and later.) In order for monitoring to occur, certain features within the NetScaler need to be enabled, and specific configuration items documented and entered into the EdgeSight for NetScaler Web Client. Once EdgeSight for NetScaler is installed and initial configuration has been performed, the following tasks must be performed to enable the server to receive and display data:

• Enable the NetScaler HTML Injection feature

• Specify the EdgeSight for NetScaler Server in the injection script

• Configure HTML injection for your site

• Verify the HTML injection configuration

• Registering the NetScaler with the EdgeSight for NetScaler Server

Enabling the NetScaler HTML Injection FeatureThe NetScaler HTML Injection feature must be appropriately enabled to ensure that data is generated for display by EdgeSight for NetScaler. For instructions on enabling this feature, see the chapter “HTML Injection” in the Citrix NetScaler 9.2 Traffic Management Guide.

Specifying the EdgeSight for NetScaler Server in the Injection ScriptMonitoring of the end-users’ Web experience is accomplished by the NetScaler injecting a pair of script files (prebody.js and postbody.js) into the HTML response stream. The prebody.js file is edited to specify an EdgeSight for NetScaler server. The following procedure describes how a NetScaler administrator specifies the EdgeSight for NetScaler server in an injection script.


1. Locate the prebody.js script file to be edited. The file is located in /nsconfig/htmlinjection/ens.

2. Determine which values in the file must be edited. At least one of the following values must be edited, g_csma_ns_server or g_csma_ns_ssl_server, depending on the type of pages to be accessed. If only SSL traffic is expected, edit g_csma_ns_ssl_server. If only non-SSL traffic is expected, edit g_csma_ns_server. If both SSL and non-SSL traffic is expected, edit both values. The correct format for the values is http://edgesight.mydomain.com. Static IP addresses are valid. These values represent the non-SSL and SSL Web sites for the EdgeSight for NetScaler server. Note that if you expect SSL traffic, the EdgeSight for NetScaler server must have a valid SSL certificate.

Configuring HTML Injection for Your SiteIn this section, only those configuration items which are required to enable EdgeSight for NetScaler are described. Review the appropriate sections of the Citrix NetScaler Traffic Management Guide for details relating to complete NetScaler setup and configuration.

EdgeSight for NetScaler depends upon the NetScaler feature HTML Injection. This feature provides a vehicle to insert the measurement script contained in prebody.js and postbody.js into the HTML Web pages. Configuration of all required elements of HTML Injection can be done using the NetScaler CLI or the NetScaler Configuration Utility.

Note In order to define an appropriate NetScaler configuration, you will need to enable the NetScaler HTML Injection feature.

Policy DefinitionImplementation of a successful EdgeSight for NetScaler installation begins with a properly configured NetScaler policy. This policy defines the conditions under which the measurement scripts will be inserted into the HTML response, and ultimately executed in the end users’ browser. In order to appropriately manage the data collected, you should limit the policy to only those pages that you wish to monitor. Additionally, since the measurement script is designed to be inserted into HTML Web pages, the policy should be configured to limit insertion to only content containing a MIME type of text/html. A sample policy matching for all URIs and named ESPolicy is defined as follows:

add policy expression ESPolicy "REQ.HTTP.URL == /* && RES.HTTP.HEADER Content-Type CONTAINS text/html"

Chapter 2 Software Configuration Tasks 15

Content Filter DefinitionIn addition to the policy defining when to insert the measurement scripts, you must also define what to insert. This task is accomplished through the configuration of content filters. The following commands define the content filters and binds then to a vserver named MyServerVIP.

add filter action res_act add " prebody"

add filter action res_act_post add " postbody"

add filter policy ESPrePolicy -rule ESPolicy -resAction res_act

add filter policy ESPostPolicy -rule ESPolicy -resAction res_act_post

bind lb vserver MyServerVIP -policyName ESPrePolicy

bind lb vserver MyServerVIP -policyName ESPostPolicy

Specify Measurement SourceOnce the content filter has been defined, you will need to specify the source files for the measurement scripts. The following commands load the two required files. If the file content should be changed at any point (such as when changing the EdgeSight for NetScaler server location), these commands are also be used to reload file content.

set filter prebodyInjection /nsconfig/htmlinjection/ens/prebody.js

set filter postbodyInjection /nsconfig/htmlinjection/ens/postbody.js

Note Every time you change prebody.js, you must reissue these commands to ensure that the injection script is properly reloaded and the configuration saved.

Verifying the HTML Injection ConfigurationOnce the injection has been configured, verify that it is occurring correctly.

1. Navigate to an injected Web page and view the source of the Web page.

2. Locate the prebody.js contents at the very top of the page.

3. Assuming injection is occurring correctly, please record the value for _csma_NS_IID. This value represents the globally unique identifier for this NetScaler (SYS.IID) and must be entered into the EdgeSight for NetScaler device management page for data to be stored. Alternatively, you can obtain the SYS.IID by using the NetScaler command line interface and issuing the command: show prebodyInjection. In the results from the command, the SYS.IID is shown as System IID.


Registering the NetScaler Appliance with the EdgeSight for NetScaler ServerThe value defined for the NetScaler variable SYS.IID needs to be recorded and then entered into the EdgeSight for NetScaler Report Console when the NetScaler appliance is registered with the server.

1. Using the EdgeSight for NetScaler Report Console, navigate to Company Settings > Server > Device Management.

2. Click the New Registration button.

3. Enter a unique NetScaler device name. This is the name that will appear on the Devices page.

4. Enter the SYS.IID for the NetScaler. This is the value previously recorded for _csma_NS_IID, or from the System IID in the results of the show prebodyInjection command.

5. Enter the IP address for the NetScaler (the NSIP).

6. Enter the FQDN (Fully Qualified Domain Name) for the NetScaler. You can also use the IP address.

7. Click OK. The Data Collector Refresh Complete page is displayed. Click Done to return to the Devices page.

Once the NetScaler appliance is registered, data for the end-user experience is collected as the injected pages are accessed.

CHAPTER 3

Managing Company Settings

This chapter provides guidelines and procedures for managing configuration settings related to companies hosted on a Citrix EdgeSight for NetScaler server. For information on global server configuration, see Chapter 3, “Managing Server Settings.”

Managing ProfilesEach EdgeSight for NetScaler user has a profile stored on the server which includes name, title, and contact information. Users can edit their own profiles. Navigate to Company Settings > My Profile, or click the Settings link in the menu at the top right-hand corner of the console. The My Profile page displays the profile matching the user name under which you logged in to the console.

You can display the profiles of other EdgeSight for NetScaler users on the Users page (Company Settings > Server > Security > Users). For more information on the creating and managing users, see “Creating Users and Assigning Roles” on page 14.

Managing Company SettingsA company is the primary organizational unit EdgeSight for NetScaler. A single server can support multiple companies. If there are multiple companies on the server, use the Company drop-down menu to switch between companies.

Company settings are administered separately from server settings, allowing server administrators to control which users are authorized to display reports or change settings for a specific company. To display company settings, navigate to Company Configuration > Server > Settings.


Time ZoneThere is a time zone for each company on an EdgeSight for NetScaler Server. The time zone is used by the server when displaying times in reports and when scheduling and running maintenance jobs. All data for a company is consolidated 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.

When EdgeSight for NetScaler is installed, an initial company must be created, including a time zone setting. The Company Settings page allows you to change the company time zone as required. When creating new companies using the console, you must specify a time zone. (See “Creating Companies” on page 27 for more information.)

Managing Data CollectionThe data collector has default configurations set for the Maximum User Interaction Time, for enabling Geolocation data collection and for applying governors to the number of pages or Geolocations that data is collected for. Navigate to Company Settings > Server > Data Collection to access these settings.

The default Maximum User Interaction Time determines the upper limit on the collection of user interaction time. Setting the limit eliminates atypical cases of idle users that may skew the overall data. In most cases, you will use the default value unless there is a specific reason for increasing the value.

Managing NetScaler DevicesA NetScaler device that you will be monitoring must be registered with a company. Navigate to Company Settings > Server > Device Management to display devices registered with the company or to register a new device with the company.

In addition, you must enable the NetScaler HTML injection feature and specify the EdgeSight for NetScaler server in the injection script. See “Enabling the NetScaler HTML Injection Feature” on page 13 for more information.

Managing Applications and GroupsApplication management allows you to delete a single application that represents the multiple host names or ports that are used to access a single Web site. To delete an application, navigate to Company Settings > Server > Applications > Manage.

Chapter 3 Managing Company Settings 19

You can also create application groups. Creating application groups allows you to generate reports with a single entry as opposed to multiple entries for a single site. Application groups are created based on the different sites accessed by individual customers. To create application groups, navigate to Company Settings > Server > Applications > Groups.

Managing PagesPage management allows you to display and manage the current working set of pages for which data is being collected. Pages are added to the list as they are encountered by the data collector. Deleting a page deletes all collected data associated with the page.

Managing GeolocationsGeolocation management allows you to display and manage the current working set of geolocations for which data is being collected. Geolocation data is collected based on the Geo Data settings described in “Configuring Geolocation Data” on page 36. The display of geolocation and ISP reports (real-time and historical) is dependent on the configuration of public geolocation data collection

Managing Private IP RangesPrivate IP range management allows you to create private IP ranges and view ranges that are already configured, You can also modify, delete, import, and export private IP ranges. The display of IP range reports (real-time and historical) is dependent on the configuration of private geolocation data collection, as described in “Configuring Geolocation Data” on page 36, and the configuration of one or more private IP ranges

Creating Users and Assigning RolesA user is an individual (or group of individuals) for which an account is created on the Citrix EdgeSight Web Client. When the initial server configuration is performed, a Superuser account is created. This account has access to all companies hosted on the server and can create other users. The Superuser can create an account for one or more administrators for a company, and then the administrators can continue with the creation of additional user accounts as required.


User access to the EdgeSight Web Client is controlled through login authentication, while a user’s capabilities to display and edit data and perform administrative operations are controlled by the assignment of roles and granting of permissions.

User logons are authenticated by either the built-in Citrix EdgeSight provider (user email address and password) or Active Directory (AD). (See “Managing Authentication Providers” on page 27 for information on creating an AD authentication provider.)

The users can be assigned one of the built-in roles (Administrator or Report Viewer) or assigned a custom role. Each role is defined by a set of permissions. Assigning a role to a user automatically grants the associated permissions to that user.

You can also add users, update user permissions, update user roles, and delete users using Management Objects. EdgeSight Server Management Objects allow administrators to perform common setup and management tasks using Visual Basic (VB) scripts instead of the Citrix EdgeSight Web Client. For information on the object model for the ReflectentManager.Manage object, and sample VB scripts, see the Management Objects topic in online help.

The following table lists the full set of permissions which can be assigned using a role and whether the permissions are assigned to the default roles.

Permission Description Admin Report Viewer

Add to Subscriptions Editing a public subscription by adding the user as a recipient

Yes No

Create Private Subscriptions

Creating a new private subscription to a report Yes No

Create Subscriptions Creating a new subscription to a report Yes No

Edit Applications, Pages, and Geolocations

Deleting applications, creating and editing application groups, deleting pages, deleting geolocations.

Yes No

Edit Company Settings Editing of company Time zone, IP Ranges and agent registrations

Yes No

Edit Devices Viewing, moving and deleting devices Yes No

Edit Roles Editing permissions and members of roles Yes No

Edit Users Editing and creating users, user roles and department rooting

Yes No

Upload New Private Report

Uploading of a new private report Yes No

Upload New Report Uploading of a new report Yes No

View Browser Reports View historical browser reports Yes Yes


Note that the View Server Settings permission must be explicitly granted when auser is created or edited rather than granted by role because while otherpermissions allow users to perform operations at the company level, this permission allows a user to view server-wide settings.

Managing ReportsEdgeSight for NetScaler provides a wide range of standard reports. These reports are available once the EdgeSight for NetScaler Server has been installed and configured and the connection to Reporting Services has been configured.

Managing Report SubscriptionsA subscription is a standing request to distribute a report in a selected format at specified times. Report distribution (subscription type) is done by email or by transfer of a file to a file share. A subscription is a useful method of distributing targeted data to people in your organization without having to give them access to the EdgeSight for NetScaler Console.You can create a subscription while viewing the report using the Subscribe link in the filter bar. You can also create a subscription from any report list by displaying report details and selecting the New Subscription button from the Subscriptions tab. See “Working with Reports” in online help for a detailed procedure for creating subscriptions.

View Client Reports View historical client reports Yes Yes

View Geographical Reports

View historical geographical report Yes Yes

View Private Groups Viewing and editing of private groups owned by other users

Yes No

View Private Reports View Private Reports for all users Yes No

View Private Subscriptions

View Private Subscriptions for all users Yes No

View Real Time charts View real time interactive charts Yes Yes

View Site Reports View historical site reports Yes Yes

View Tuning Reports View historical tuning reports Yes Yes


By default, as an administrator, you are granted the following permissions concerning subscriptions:

• Add to Subscriptions

• Create Private Subscriptions

• Create Subscriptions

• View Private Subscriptions.

See “Creating Users and Assigning Roles” on page 14 for descriptions of permissions and their relationship to roles.

This allocation of permissions allows you to control the distribution of data within your organization and also help you manage the impact on the Report Server.

Uploading ReportsUse the Upload a Report page (Company Settings > Server > Reporting > Upload a Report) to transfer the RDL file to the Report Server.

Note that you must have the Upload New Report permission to be able to upload a report to the server. This permission is granted by default to all Administrators.

Always use a unique name when uploading a new report. This ensures that duplicate report names do not appear on the All Reports page. Also, you should define and publish naming conventions for custom reports. Consistent report names can help users find the reports they need. Be consistent when specifying the Data Area and Report Type fields since users sort report lists by these values. The parameters for characterizing and grouping reports are used to generate the list of related reports and are also used when sorting report lists. In general, you can select these parameters based on the way you would name the report. For example, if you are uploading a report showing a chart with memory usage for a device by day, you would perform the following steps:

1. Select Memory as the Data Area parameter. The data area is displayed in the Area column in report lists.

2. Select Memory Usage as the Data Type parameter.

3. Select Device as the Selected Type parameter.

4. Select Day as the Group By parameter.

5. Select Chart as the Report Type parameter. The report type is displayed in the Area column in report lists.

Use the Public or Private radio buttons to determine whether the report is shared within your company. Public reports are displayed to all users with the proper permission. Private reports are only displayed to the user uploading the report.


The Data Area, Report Type, and Public/Private attributes cannot be changed once the report is uploaded. To change any of these attributes, you must delete the report and then upload the report again.

If you make additional changes to the report, use the Update link on the Properties page to upload the RDL file.

Modifying Existing ReportsThis section includes information on modifying existing Citrix EdgeSight reports and saving them as custom reports. This document describes how to edit a Report Definition Language (RDL) file to add or change columns in a report.

Before modifying a report, you should have an understanding of the Report Definition Language standard. For information on the structure of RDL files, see the Report Definition Language Specification at the following location: http://www.microsoft.com/sql/technologies/reporting/rdlspec.mspx In addition, you should have experience developing and working with SQL queries.

The standard reports provided with Citrix EdgeSight Server can be used as the basis for new reports. By modifying an existing report definition (RDL) file instead of creating a new one, you can save time and effort while creating custom reports with a consistent presentation.

Before modifying a report, ensure that there are no existing reports that meet your business needs. This helps avoid the creation of duplicate reports. (Keep in mind that you can customize reports using filters and then bookmark the resulting report using the Add to Favorites feature.) You can use the All Reports page to quickly scan existing reports by name or type of data. The decision to modify a report should be based on a repeatable business need. If you need to view specific data on a regular basis, modifying a report can be the best way to achieve this. For one-time issues, it is preferable to display related reports to gather information.

The basic report modification procedure consists of the following steps:

• Define requirements for report modifications

• Download the report definition file from the report server

• Modify the report definition using the XML editor of your choice

• Upload the modified report definition file to the report server

• Verify that the new report is displayed correctly and shows the intended data


Defining Report Modification RequirementsAs mentioned previously, report modifications should always be based on a repeatable business need. Once the need is identified, you can determine what data needs to be displayed to meet that need. To display the data fields available for use in a report, use the provided database schema information, or use the SQL Server Enterprise Manager to display EdgeSight database tables.

Downloading a ReportUse the Download link on the Report Properties pane to download the report in the form of an RDL file. When displaying a report list, click the information icon next to the report name to display the Report Properties pane. If you are already displaying the report, click the Properties link above the report. When prompted, save the RDL file to a folder.

Modifying a ReportYou can edit an RDL file using the XML editor of your choice. Do not use the Visual Studio Report Designer to modify reports. Editing existing Citrix EdgeSight reports using the Report Designer can, in some cases, render the RDL file unusable. To modify a report:

1. Open the RDL file in your XML editor.

2. Locate the <CommandText> tag in the <Query> section. This section contains the SQL query used to populate the report with data.

3. Edit the SQL query based on the previously defined requirements.

4. Locate the <Fields> section and edit the field names and <DataField> values as required to match the data fields specified in the query.

5. Locate the <Description> tag and edit the report name. The report name should be unique.

6. Save the RDL file with a new name.

Uploading a ReportSee “Uploading Reports” on page 17 for instructions on uploading a report to the Report Server.


Verifying the Modified ReportAfter uploading a report, navigate to the Custom Reports folder to which the report was uploaded. Display the report and verify that the changes are displayed and that the data appears to be correct. If problems appear, review the SQL query and data field portions of the RDL file for accuracy and completeness. Update the report to verify any problem fixes.

Creating New ReportsThis section includes information on creating a new Citrix EdgeSight for NetScaler report and uploading it as a custom report. This information is intended to be used in conjunction with SQL Server Reporting Services documentation.

Before creating a report, you should have a working knowledge of SQL Server Reporting Services and, specifically, the Report Designer. For more information, refer to the documentation for your version of Reporting Services and to additional resources available from Microsoft. If you are using SQL Server 2005, go to Microsoft SQL Server Reporting Services at: http://www.microsoft.com/sql/technologies/reporting/default.mspx.

If you are using SQL Server 2000 and Reporting Services SP2, see Reporting Services Resources on the SQL Server 2000 page at:

http://www.microsoft.com/sql/technologies/reporting/default.mspx.

In planning your report design environment, keep in mind that reports developed on SQL Server 2005 Reporting Services cannot be used on a Citrix EdgeSight Server running a previous version of SQL Server. However, reports developed on SQL Server 2000 Reporting Services SP2 can be used on a Citrix EdgeSight Server running SQL Server 2005.

Before creating a new report, ensure that there are no existing reports that meet your business needs or could be modified to do so. This helps avoid the creation of duplicate reports. (Keep in mind that you can customize reports using filters and then bookmark the resulting report using the Add to Favorites feature.) You can use the All Reports page to quickly scan existing reports by name or type of data. The decision to create a report should be based on a repeatable business need. If you need to view specific data on a regular basis, creating a report can be the best way to achieve this. For one-time issues, it is preferable to display related reports to gather information.


The basic report creation procedure consists of the following steps:

• Define reporting requirements

• Create the report using the Reporting Services Report Designer

• Upload the new report definition file to the report server

• Verify that the new report is displayed correctly and shows the intended data

Defining Reporting RequirementsAs mentioned previously, the decision to create a report should always be based on a repeatable business need. Once the need is identified, you can determine what data needs to be displayed to meet that need. When using the Report Designer, connect to the Citrix EdgeSight database (edgesight) as a shared data source. This will allow you to select the data fields to be displayed in the report.

Creating a ReportWhen creating a new Citrix EdgeSight report, consider the following guidelines:

• Data source—The data source for all reports must be specified as edgesight (all lower case). If a different data source name is specified, the connection to the database will not be established and an error will be displayed.

• QueryParameter names—The QueryParameter names, which correspond to the filters for reports, must match the conventions used in the existing reports. The query parameter names are formatted as @ParamName, such as @Device or @Application. Locate a report which uses the filters you want to include in a new report, and then examine the RDL file for the corresponding QueryParameter names.

• Page width—All reports are designed with a page width of 6.25 inches. If a greater report width is specified, users will need to scroll to see the entire report.

Uploading a ReportSee “Uploading Reports” on page 17 for instructions on uploading a report to the Report Server.


Verifying the New ReportAfter uploading a new report, navigate to the Custom Reports folder to which the report was uploaded. Display the report and verify that the report is displayed correctly and that the data appears to be correct. If problems appear, review the report definition for accuracy and completeness. After resolving any problems, update and re-verify the report.

Generating Reports for Multiple Citrix EdgeSight ServersThis document provides information on generating reports using data from multiple Citrix® EdgeSight® databases.

In some cases, you may want to generate reports using data from multiple Citrix EdgeSight Servers. For example, a corporate procurement initiative may require data about end-user devices consolidated across business groups. Reporting against multiple servers is achieved using standard techniques, including a linked server configuration.

Reporting across multiple Citrix EdgeSight databases requires that you perform the following tasks:

• Establish a linked server configuration from a SQL Server to one or more additional SQL Servers. For information on linking servers, see Linking Servers at http://msdn2.microsoft.com/en-us/library/ms188279.aspx.

• Edit a report definition (RDL) file to include a query against multiple data sources using a UNION operator in the SELECT statement.

The following figure shows the various components involved in performing inter-server reporting.


Establishing a Linked Server ConfigurationA linked server configuration enables Microsoft SQL Server to issue distributed queries against data sources on remote servers. The configuration defines an OLE DB provider and an OLE DB data source. Since the Citrix EdgeSight databases are all resident on SQL Servers, use the Microsoft SQL Native Client OLE DB Provider (PROGID: SQLNCLI). The OLE DB data source is the Citrix EdgeSight database which will be queried. For information on provider configuration, see “Configuring OLE DB Providers for Distributed Queries” at the following location:

http://msdn2.microsoft.com/en-US/library/ms190918.aspx.

You create a linked server configuration by running the stored procedure sp_addlinkedserver. After a linked server is created, distributed queries can be run against this server. For more information on using this stored procedure, see “sp_addlinkedserver (Transact-SQL)” at the following location:


Issuing Distributed QueriesDistributed queries are used to access data from multiple instances of SQL Server, in this case hosting Citrix EdgeSight databases. Note that when you execute a distributed query against a linked server, you must use a fully qualified, four-part table name for each data source to query using the following syntax:


linked_server_name.catalog.schema.object_name

For more information, see “Distributed Queries” at the following location:


In this case, the distributed query in specified in a report definition (RDL) file. You can use a query including the UNION operator in the SELECT statement to combine the results of two or more queries into a single result set consisting of all the rows belonging to all queries in the union. Examples of SELECT statements which use the UNION operator are included in “SELECT Examples” at the following location:

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/tsqlref/ts_sa-ses_9sfo.asp.

Configuration ConsiderationsIn order to ensure the successful execution of distributed queries, the Citrix EdgeSight databases should all be at the same version. Keep in mind that inter-server reporting can be resource intensive and that reports spanning servers will take longer to generate than reports run against a single database.

CHAPTER 4

Managing Server Settings

This chapter describes how to manage global settings on a Citrix EdgeSight for NetScaler Server.

Monitoring Server StatusA number of different screens can be accessed to display the general status of EdgeSight for NetScaler Server.

The System Status page provides an overview of server operations across all companies. The Company table lists how many devices have and have not uploaded data to the server during the current day. The status for messages, warnings, errors and new devices provide a count indicating activity for the current day.

Status Type For detailed information...

System Status Navigate to Server Settings >Status to display an overview of companies, services, and messages for EdgeSight for NetScaler Server.

Devices Navigate to Company Settings > Server > Device Management to display a list of the NetScaler devices monitored by EdgeSight for NetScaler Server. The NetScaler device name, SYS.IID, and IP address (NSIP) are displayed.

Job Status Navigate to Server Settings > Maintenance >Jobs >Status to display the status of EdgeSight for NetScaler Server jobs. Jobs are organized by job schedules.

Server Script Host Navigate to Server Settings > Status, and then click Server Script Host Status to display the Service Shell Status page.

Message Navigate to Server Settings > Messages to display


Configuring Server SettingsThe Server Settings page allows you to control how EdgeSight for NetScaler Server handles the following operations:

• GeoData configuration

• Error Handling and Email

• Timeouts

In most cases, you will not need to adjust the Error Handling and Email or timeout values on this page. Citrix recommends that you use the default settings and observe server performance in production conditions before considering the adjustment of server settings.

Chapter 4 Managing Server Settings 33

Geo Data ConfigurationTo be able to generate reports based on geographical locations, you need to first configure the Geo Data settings. The geo data comprises the IP addresses and geographical data for all publicly assigned IP addresses. This data is available in a CSV format that enables you to load the geo data into the MS SQL database. The following ten geo data formats are supported:

• IP-Country: This is a single file database with the format: Start IP (decimal), End IP (Decimal), Country Code, Country Name

• IP-Country-ISP: This is a single file database with the format: Start IP (decimal), End IP (Decimal), Country Code, Country Name, ISP Name

• IP-Country-Region-City: This is a single file database with the format: Start IP (decimal), End IP (Decimal), Country Code, Country Name, Region Name, City Name

• IP-Country-Region-City-ISP: This is a single file database with the format: Start IP (decimal), End IP (Decimal), Country Code, Country Name, Region Name, City Name, ISP Name

• GeoIP-Country: This is a single file database with the format: Start IP (dotted notation), End IP (dotted notation), Start IP (decimal), End IP (Decimal), Country Code, Country Name

• GeoIP-Country-ISP: This is a single file database with the format: Start IP (dotted notation), End IP (dotted notation), Country Code, ISP Name

• GeoIP-Region: This is a single file database with the format: Start IP (dotted notation), End IP (dotted notation), Start IP (decimal), End IP (Decimal, Country Code, Region Code

• GeoIP-Country-Region-City-Latitude-Longitude: This is a single file database with the format: Start IP (dotted notation), End IP (dotted notation), Country Code, Region Code, City Name, Latitude, Longitude. Note that the first line in the file refers to the column headers.

• GeoIP-Country-Region-City-Latitude-Longitude-ISP-NetSpeed: This is a single file database with the format: Start IP (dotted notation), End IP (dotted notation), Country Code, Region Code, City Name, Latitude, Longitude, ISP Name, NetSpeed Type. Note that the first line in the file refers to the column headers.

• [GeoIP-LocationID][LocationID-Country-Region-City-Latitude-Longitude]: This is a multiple file database comprising a Public IP Block file and a Public IP location file. The format of the public IP block file is: Start IP (decimal), End IP (decimal), Loc ID & Location file: Loc ID, Country Code, Region Code, City Name, Latitude, Longitude. Note that the


first line in the file is the copyright information, and the second line in the file refers to the column headers.

To configure Geo Data settings

1. In the navigation pane, click Server Settings -> Configuration -> Settings.

2. In the Configuration pane, under Geo Data, do the following:

• In Select a format, click the geolocation format you want to use to generate geolocation reports.

• In Public IP Block File, click Browse, and then select the CSV file that contains the geo data.

• In Public IP Location File, click Browse, and then select the location file. This is available only for the multiple files format: [GeoIP-LocationID][LocationID-Country-Region-City-Latitude-Longitude]

• In Continent to collect data for, click the continent for which you want to collect geo data. To collect data from all continents, click All.

• In Default Country to Display ISP/IP Owners for, click the country name for which you want to display the ISP/IP owners. Note that this option is available only for formats with ISP.

Note After you have updated the geo data settings in this pane, you need to upload the geo data by running the Upload Geo Data job from the Server Settings > Maintenance > Jobs > Schedules pane. For more information see “Configuring Geolocation.”

Error Handling and EmailThe EdgeSight for NetScaler server sends error and event notifications to the administrator through emails.

The SMTP server name and Email addresses are specified during server installation, but can be changed as required. It is critical to server operation that a valid SMTP server name is used. EdgeSight for NetScaler Server uses the SMTP server to distribute server error conditions and new user passwords.

The email settings fields (SMTP Server, Admin Email, and From Email) are populated with the values entered in the Post-Installation Setup Wizard during the initial server configuration.


To configure error handling and email


2. In the Configuration pane, under Error Handling & Email, do the following:

• In SMTP Server, type the IP address of the SMTP server you want to use to send email notifications. To test the SMTP server settings, click Test Email.

• In Admin Email, type the email address of the administrator to whom you want to send the email notification.

• In From Email, type the email address from which you want to send email notifications.

• To receive email notification for any server error, select Send an email when a server error occurs. This enables you to detect and resolve configuration issues, and is very useful when setting up EdgeSight for NetScaler server the first time.

TimeoutsTimeouts let you specify the amount of time the server takes to perform certain tasks, such as SQL queries. This ensures that tasks do not take too much time in the event of system or network problems.

Timeouts are specified for common server operations (database queries and ASP page loading and background service queries) to prevent the server from being blocked while waiting for a response to a query. We recommend that you use the following default values unless a specific problem occurs with excessive timeouts:

• Queries and ASP pages—60 seconds

• Queries from background services—6000 seconds

To configure error handling and email



2. In the Configuration pane, under Timeouts, do the following:

• Enter the timeout value, in seconds, for queries and ASP pages. The default value is 60 seconds.

• Enter the timeout value, in seconds, for queries from background services (typically longer running). The default value is 6000 seconds.

Configuring Geolocation DataTo be able to generate reports based on geographical locations, you need to first configure the Geo Data settings, then upload the geo data by running a job, and finally, enable geolocation data collection.

Configuring GeoData SettingsThe geo data comprises the IP addresses and geographical data for all publicly assigned IP addresses. This data is available in a CSV format that enables you to load the geo data into the MS SQL database.

The Geodata public IP mapping file entered in this field identifies the mapping file that will be loaded by the Nightly GEO Data job.

For more information, see “Geo Data Configuration” on page 33.

Running GeoData JobsAfter you have configured the geo data settings, you need to upload the geo data by running the Upload Geo Data job.

You can either schedule the job to run at a specific time, or run it at the current moment. After a job is run successfully, an email notification is sent to the administrator. This email notification is a confirmation that the scheduled job was run; it also contains log of the data uploaded. Note that it may take an hour to load the entire data.

To run GeoData jobs

1. In the navigation pane, click Server Settings -> Maintenance -> Jobs -> Schedules.

2. In the Job Schedules pane, do one of the following:

• Expand Upload Geo Data and in The start time for this schedule is, set the time when you want this job to run.

• For Upload Geo Data, click Run it.


Enabling Geolocation Data CollectionAfter you have uploaded the geolocation data, you need to enable data collection. You can enable data collection for both public and private IP addresses. Public geolocation data is based on externally provided geolocation mapping data that resolves IP addresses to specific geographical locations.

Data for private IP ranges is based on IP addresses belonging to different IP address ranges of a single company. For private IP address ranges, the data is either manually entered or imported from a file.

To enable geolocation data collection

1. In the navigation pane, click Company Settings -> Server -> Data Collection.

2. In the Agent Configuration Properties pane, under Select category, click Geo Data.

3. In Enable Geo Data Collection and Display, click True.

4. In Type of Geo Data to Collect, click Public to enable geo data collection for public IP addresses, and click Private to enable data collection for private IP addresses.

5. In Country to Display ISP/IP Owners for, select the country for which you want to enable geolocation data collection, and then click OK.

Creating CompaniesA company is the primary organizational unit on an EdgeSight for NetScaler Server. A single server can support multiple companies. You create an initial company when installing EdgeSight for NetScaler Server. After installation and post-installation configuration is complete, use the Companies page (Server Settings > Configuration > Companies) to create additional companies as required.

The only information required for creating a company is a unique name and a time zone.

The time zone is used by the server when displaying time stamps and triggering jobs. There is a single time zone for each company defined on an EdgeSight for NetScaler Server. All data for that company is aggregated based on the day boundary for that time zone. This ensures data consistency when agent machines are in a number of different time zones.


Since daylight savings time is adjusted differently depending on time zone and country, you must manually select the Adjust for daylight savings time check box when daylight savings time is in effect for some time zones. The server automatically calculates daylight savings time for all US time zones (Eastern Time, Central Time, Mountain Time, and Pacific Time). If a US time zone is selected, the check box is grayed out.

Managing Data CollectorsThe data collector (engine) continuously captures and collates EdgeSight for NetScaler’s highly scalable data collection environment monitors all Web application users, regardless of traffic volume, or user browser type.

Managing Authentication ProvidersAuthentication providers ensure that only authorized users can log on to an EdgeSight for NetScaler Server. The first step in creating a new user is to select an authentication provider against which a user name and password are verified.

A default authentication provider (Email) is included when you install EdgeSight for NetScaler Server. You cannot edit or delete the default authentication provider. The default authentication provider uses an Email address as the user name. When you create a new user, you specify the Email address for the user. Then, an email is sent to the user explaining the sign in process and providing a temporary password. When the user first logs on, they are requested to change their password.

You can create new authentication providers that use Active Directory (AD) for security and sign-on capabilities. Before creating a new provider, make sure you have the LDAP path for your AD authentication provider available.

Using an Active Directory Authentication ProviderTo set up Active Directory integration with EdgeSight, perform the following three steps:

• Set up an Active Directory provider

• Set up roles and permissions

• Assign users or groups to roles

Before you begin, make sure you have the LDAP path for your authentication provider available.


Create an Active Directory Authentication Provider1. Log into the EdgeSight for NetScaler Web Client.

2. Navigate to Server Settings > Configuration > Authentication in the navigation pane. The Authentication Configuration page is displayed. Note that the Email provider is already listed.

3. Click the New Provider button to invoke the New Authentication Provider wizard.

4. Click Active Directory in the list of authentication providers and then click Next. The Configure the authentication provider page is displayed.

5. Enter a unique Name that identifies the provider, for example, Corporate AD.

6. Enter a Description that includes additional information about the provider. For example, you could list the organizational areas covered by the specific AD server.

7. If you want the new provider to be the default authentication provider for the EdgeSight for NetScaler Server, select the Make this the default authentication provider checkbox.

8. Enter the LDAP Path. The LDAP path should be set to the search base of your Active Directory forest. The LDAP path is formatted as follows: LDAP://yourdomain.com. If you are using a Global Catalog (GC), enter the global catalog path in the following format: GC://yourdomain.com. (The GC is an index of all the AD objects in the entire forest.) A port number may also be required depending on your AD configuration. Refer to your AD documentation for the default port for your configuration.

9. Enter the User Name and Password for the account used to query Active Directory for users and groups. (This account is not used to authenticate users to EdgeSight for NetScaler; the user’s own user name and password is used during the authentication process.) The following user name formats are supported: NT Domain (yourdomain\username) User Principal Name ([email protected]) Distinguished Name(cn=username,dc=yourdomain,dc=com).

10. Click the Test button to verify the information entered is correct. If the test fails, verify the LDAP or GC path and the user name/password for the account and test again.

11. Click Finish. The new provider appears on the Authentication Configuration page. You can now set up roles related to the new provider.


Set Up Roles1. Navigate to Company Settings > Server > Security > Roles in the

navigation pane to display the Roles page. Two built-in roles (Administrator and Report Viewer) are displayed by default.

2. Click the New Role button to display the Add New Role page.

3. Enter a Name and a Description for the new role. The name must be unique.

4. In the Deny list, select all permissions to be granted to the role and then click Allow to place them in the Allow list.

5. If the applicable User Membership exists, highlight the member in the Non-Members list and click Add to add the user or group as a member. (You may also create the user or group later and assign the new role.)

6. Click OK - Add New Role. The new role is displayed on the Manage Role page.

Set Up Users and Groups with Active DirectoryOnce you have added an authentication provider and set up roles, you must also set up users and/or groups. You may want to create multiple groups within your Active Directory, such as an EdgeSight Admin Group, and an EdgeSight Console User Group for ease of Administration. To set up Users/Groups, you must be logged in to the EdgeSight Console.

1. Navigate to Company Settings > Server > Security > Users in the navigation pane to display the Manage Users page.

2. Click the New User button to display the User wizard.

3. Select the new AD provider from the list and select Next. The Add a new user wizard page is displayed.

4. Select Browse in the User Info area to browse Active Directory for users and groups. The Active Directory User or Group Selection dialog box is displayed.

5. Use the Filter drop-down list to filter your search of the Active Directory to Users, Groups, or both. Once you have selected a filter, click Go to display a list of accounts.

6. Find the applicable user or group account and highlight that entry.

7. Click on OK. The selected user or group is displayed in the User of Group Name field.


Note Steps 3 through 7 are not performed if there is only one AD provider.

8. Click the expand button under Company Roles to display the list of company roles that can be assigned to the user or group. The Select User Roles dialog box is displayed.

9. Check the box next to all the Roles you wish to grant to the user or group. Click OK to assign the roles.

10. Determine if this user or group should have access to the Server Settings node in the EdgeSight for NetScaler Web Client and to data for private groups. To grant a permission, select the permission in the Deny list and click the Allow button.

11. Click Finish to complete the addition of the new user or group. The new user or group is displayed in the Users list.

12. Test the new user or group setup. Log out of the EdgeSight for NetScaler Server and log in again. At the Login page, the Provider drop-down menu is now displayed. The user or group member selects the applicable provider and then logs in using their domain user ID and password.

Managing ServicesEdgeSight for NetScaler Server provides a number services that provide database cleanup and system maintenance tasks. The following services are provided:

To display the operations you can perform for each service, click on the drop-down menu icon. You can start and stop a service, view the service log, or clear the service log. You can start or stop all services by starting or stopping the ens_zqueue service.

Service Task Performed

ens_zqueue The overall queue for services.

core_clean_temp Cleans the temp file area.

core_zbatch_run Database maintenance

core_zjob_run Database maintenance

core_zshell_controller Controls the running of services


Configuring the Connection to Reporting ServicesMicrosoft SQL Server Reporting Services must be installed and configured in order to generate and display EdgeSight for NetScaler reports. For detailed installation and configuration procedures for Reporting Services and related software, see “Configuring Reporting Services for Citrix EdgeSight for NetScaler” at: http://support.citrix.com/article/CTX114167After the Reporting Services installation and configuration is complete, you must configure the connection from the EdgeSight for NetScaler Server to the Report Server. The Reporting Services Configuration page allows you to specify the report server, authorization settings, and default actions.

To configure the report server:1. Enter the URL for the server running SQL Server Reporting Services, such

as http://myserver/ReportServer.

2. Enter the user name, password, and domain name associated with the account used to access the report server. The report server administrator must already have defined a user account. The account must have a password that does not expire.

3. Follow the prompts to complete the configuration.

Managing Reporting Services SchedulesReporting Services schedules, in conjunction with the subscription feature, allow you to automate the generation of reports for distribution to users. When an administrator or a user creates a report subscription, they must select an associated schedule.

In some cases, such as a week with a holiday or a scheduled company shutdown, you may want to pause report schedules so that the associated reports are not generated.

Care should be taken when deleting schedules. If the deleted schedule is associated with a report, the report will not be generated. Also, subscriptions using the deleted schedule will not result in a report distribution.

http://support.citrix.com/article/CTX114167


Managing the DatabaseThis section describes how to effectively manage the Citrix EdgeSight for NetScaler database, including the grooming schedule. Grooming is the process of removing older data from a database at regular intervals to make room for new data. Grooming is critical for maintaining efficient database operation. An effective grooming schedule controls database size and helps ensure acceptable performance while retaining sufficient data for business operations.

Grooming ScheduleThe grooming schedule for the server database is specified as part of the server configuration. The server grooming schedule allows you to specify the number of days that data is retained by data type. This allows data used to identify trends, such as performance data, to be retained longer than data which quickly becomes stale, such as real-time data.

The default values for grooming the server database are sufficient for most installations. You may want to use the default values at first and adjust them over time based on user requirements and system performance. In cases where you want to retain more data, consider creating an archive report or performing data warehousing as methods of keeping historical data in preference to relaxing the grooming configuration.

Server Database GroomingTo edit the server grooming schedule, navigate to Server Settings > Maintenance > Grooming > Configuration. The Grooming table contains the following information:

• Data—The type of data to be groomed.

• Table—The database table where the data is stored.

• Groom Days—The default number of days that data of the selected type is retained.

The following table shows the default grooming schedule

Data Table Default Days

Company Devices instance 30

Detailed Performance Data perf_detail 2

Historical Performance Data perf_history 30

Messages messages 30


In most cases, the grooming schedule is configured to retain one month of data. The grooming strategy for a specific data type should take into account how fast the usefulness of the data decreases from time of collection and also how much data is collected on average over a time period.

It is important to ensure that the grooming schedule is taken into account if data is being warehoused or reports are being archived. If data is transferred less frequently than the grooming schedule for a type of data, data loss can occur. Similarly, report archiving schedules must take into account the grooming schedule to avoid introducing gaps in historical reports.

You can monitor the status of grooming jobs by displaying the grooming log. The log displays the following information:

• Data Area—The type of data on which grooming was performed.

• Grooming Job Name—The name of the grooming job run.

• Job Status—The completion status of the job.

• Start Time—The date and time that the grooming job started.

• Duration—The elapsed time taken by the grooming job. Note that in the case of smaller databases, grooming jobs may show a duration of zero time.

Displaying and Responding to Server MessagesThe Messages page (Server Settings > Messages) displays status and event messages for EdgeSight for NetScaler Server. You can filter the list of messages by message type (All Types, Error, Warning, Informational, or New Instance) and by company (All Companies, No Company Specified, or a specific company).

Displaying and Changing Connection String PropertiesNote REVIEWERS This change has not yet been implemented in 2.0, but I’m told it may be.

In some cases, for example when moving the EdgeSight for NetScaler database to a different SQL Server system or when resolving SpectUser password mismatches, you will need to display or change the connection string settings contained in the EdgeSight configuration file. The connection string (ZTECH_CONNECTION) contained in %Programfiles%\Citrix\System Monitoring\Server\EdgeSight 4.0\EdgeSight.cfg is encrypted.

The esconfig.exe utility allows you to display and change connection string properties. To run esconfig.exe, open a Command Prompt window and go to the directory containing the utility. The default location is:


C:\Program Files\Common Files\Citrix\System Monitoring \Server\Components

Enter esconfig with no parameters to display the current connection string. Enter esconfig /? to display the syntax for the utility commands. The command syntax is as follows:

Syntax

esconfig [options]

Options

/cfgfile:FileName—Specifies the name of the configuration file. If this option is omitted, esconfig attempts to locate the current configuration file.

/csserver:ServerName—Set the connection string server name.

/csdb:DatabaseName—Set the connection string database name.

/cspass:Password—Set the connection string SpectUser password.

/cstimeout:Timeout—Set the connection string connect timeout (seconds).

/? or /help—Display this command syntax.

After resetting a property, you are notified that the connection string has been changed and the new connection string is displayed.

Example

The following command specifies a new connection string database name and password:

esconfig /csdb:ESDB /cspass:esa9734

Index 47

Index

AAccess Gateway

alerts 7Active Directory

authentication provider 38Active Directory Authentication Provider

creating 39Administrator role 20alerts

Knowledge Center 7Authentication 20Authentication providers 38

CCompany

creating 37Company Settings 17Configuration

initial 10

DDaylight Savings Time 38Distributed Queries

for multiple server reports 28

EEmail

authentication provider 38

HHTML Injection feature 13

KKnowledge Center

alerts 7

LLinked Server Configuration

for multiple server reports 28Login authentication 20

MManaging 17managing 17Messages

server 44My Profile 17

NNetScaler

registering with EdgeSight for NetScaler 16

OOverview 9

PPermissions

list of 20product alerts 7Profile, user 17

RReport Subscriptions 21Report Viewer role 20Reporting Services

configuring connection to 42schedules 42

Index 48

Reports 21creating 25from multiple servers 27modifying 23uploading 22

Rolesassigning 19built-in 20

Root company 10

SSchedules

Reporting Services 42Server

messages 44Server Settings 32Server Status 31SMTP server 34Status

Devices 31message 31Server Script Hosr 31System Status 31

Superuser 10, 19SYS.IID

used in NetScaler registration 16

TTime Zone

company 18Timeouts

server 36Troubleshooting 45

UUsers

creating 19

Index 49

50 Citrix Presentation Server Administrator’s Guide

edgesight admin guide - wag the real · 6 citrix edgesight for netscaler administrator’s guide...

Documents