Product Documentation

Installing EdgeSight Server

Oct 16, 2015

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.

If required, you can perform a command-line installation using the msiexec command. You must specify public properties to define installation settings. Review "Installing EdgeSight Server Using the Command Line" for a description of installation properties.

If you are upgrading, see Upgrading EdgeSight for more information.

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.

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 Required
.NET Framework 3.5 SP1 Yes
Windows Server 2003 or Windows Server 2008 Yes
Internet Information Services (IIS) 6.0 or later. See “IIS 7.0 Components Required on Windows Server 2008 Systems” in System Requirements for EdgeSight 5.4 for information specific to IIS 7.0 and Windows Server 2008. Yes
Microsoft Message Queuing (MSMQ). The MSMQ service must be running. Yes
SQL Server 2005 SP1 or later (Standard or better). This can be on a different machine from where the installation is being run. Yes

512 megabytes (MB) of RAM

Note that 2GB is recommended.

No. Installation can continue, but performance may be affected.
SSL certificate from a recognized certificate authority. See Install and Configure for more information on SSL certificate considerations. No, installation can continue, but security may be compromised.

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

Installing EdgeSight 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.

Note that not all public installation properties 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. Insert the media or run Autorun.
  2. Select EdgeSight Server to display the Choose Language dialog.
  3. Select the language for the installation and click Continue to display the Welcome screen.
  4. Click Next to continue to display the Select Features screen.
  5. 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 to display the Prerequisite Check screen.
  6. 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 display the End-User License Agreement screen.
  7. After reading the license, select the I accept radio button and click Next to display the Choose Setup Type screen.
  8. 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 to display the Database Server screen.
  9. 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).
  10. 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 to display the next Database Information page.
  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.)
  12. Enter a name for the new database and click Next to display the Database User Information screen.

    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.

  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.
  14. Click Validate to test the user credentials. After the credentials have been successfully validated, click Next to display the Database Properties screen.
  15. Configure the database properties as follows:
    • File Group Size—Accept 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 Options—Select 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.
    Note: The installer uses the default file group and log file creations as configured in the SQL Server installations. A SQL Server administrator can 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. Click Next to display the Server Location screen.
  17. 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 to display the Ready to Install screen.
  18. 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.
  19. 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". (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.

Installing EdgeSight Server Using the Command Line

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.

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 Description
PREREQUISITES_PASSED 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.
DATABASEOPTIONS Specifies whether to install a new Citrix EdgeSight database or upgrade an existing database. Valid values are new or upgrade; the default value is new.
DATABASESERVER The name of the server running an existing Citrix EdgeSight database. It is not necessary to specify a value when running the database locally.
DBUSERNAME The username for the SA user. It is not necessary to specify a value if Windows authentication is enabled (WINDOWS_AUTH=1).
DBPASSWORD The password for the SA user. It is not necessary to specify a value if Windows authentication is enabled (WINDOWS_AUTH=1).
WINDOWS_AUTH Specifies whether to use Windows authentication. Valid values are 1 (use Windows authentication) or 0 (do not use Windows authentication); the default value is 1.
Note: If Windows authentication is not used, the DBUSERNAME and DBPASSWORD properties must be defined.
DBNAME 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 default value is EdgeSight.
ACCOUNTNAME 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.
ACCOUNTPASSWORD The password for the EdgeSight “run as” account.
DATAFILESIZE 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 value is 500 and is sufficient for most installations.
LOGFILESIZE Specifies the initial size in megabytes of the log file. The default value is 500 and is sufficient for most installations.
RECOVERYMODEL Specifies the database recovery model. Valid values are FULL, SIMPLE, and BULK_LOGGED; the default value is SIMPLE.
DATADIR EdgeSight Server uses temporary files for storing data uploads from agents, including crash reports. The default directory is %ProgramFiles%\Citrix\System Monitoring\Server\EdgeSight\Data. Because there may be significant file growth in this directory, it may be desirable to locate this directory on a separate drive or partition.
Note: The data directory cannot be on a mapped drive.
EDGEDIR Contains the web pages, scripts, .Net components and other components that make up the EdgeSight Server Web site. The default value is %ProgramFiles%\Citrix\System Monitoring\.
INSTALLOPTIONS Specifies which 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 install only the database component.

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.

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:
  • 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.

To configure your Citrix EdgeSight Server:

  1. 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.
  2. Enter a name for the company for which data will be displayed on the Web site.
  3. 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.
  4. Select the default display language for new user accounts from the drop-down menu. Click Next to display the Create the Superuser Account page.
  5. 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.
  6. Enter the name of the SMTP server used to route email. The SMTP server can be running locally or remotely.
  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.
  8. 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.
  9. Select which types of agents, if any, to display on the server from the support drop-down menus. For example, if the EdgeSight Server will only be used to monitor XenApp systems, disabling display support for the other types of agents can provide a more streamlined interface. Similarly, if the EdgeSight Server will only be used for license server monitoring, you can disable support for all agents. EdgeSight provides the following types of agents:

    EdgeSight for XenApp, Basic—Basic agents require only that you have a XenApp Enterprise license available on your Citrix License Server.

    EdgeSight for XenApp, Advanced—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 License Server.

    EdgeSight for Endpoints—Endpoint agents provide monitoring and data collection for endpoint devices.

    EdgeSight for XenDesktop—EdgeSight for Virtual Desktops agents provide monitoring and data collection for XenDesktop devices.

    Note: This setting only determines whether reports and administrative pages are displayed on the console; the data continues to be collected, uploaded, and stored even if you have disabled display support. You can change the agent display support at any time after installation using the EdgeSight Server Console.
  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 for more information on licensing.)
  11. 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 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. Click Next to display the Review Citrix EdgeSight Server Settings page.
  13. 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.