Citrix StorageLink Installation Guide

Installation Guide Citrix StorageLink Installation Guide This document describes how to install Citrix StorageLink Version 2.1 Author: Citrix Engineering and Program Management Published: December 2009

Citrix StorageLink Installation Guide Copyright 2009 Citrix All Rights Reserved. Version: 2.1 Citrix, Inc. 851 West Cypress Creek Road Fort Lauderdale, FL 33309 United States of America Disclaimers This document is furnished "AS IS." Citrix,Inc. disclaims all warranties regarding the contents of this document, including, but not limited to, implied warranties of merchantability and fitness for any particular purpose. This document may contain technical or other inaccuracies or typographical errors. Citrix,Inc. reserves the right to revise the information in this document at any time without notice. This document and the software described in this document constitute confidential information of Citrix,Inc. and its licensors, and are furnished under a license from Citrix,Inc. This document and the software may be used and copied only as permitted by such license. Trademarks Citrix, Inc., the Citrix logo, Citrix StorageLink, are trademarks of Citrix,Inc. in the United States and other countries. All other products or services mentioned in this document are trademarks or registered trademarks of their respective companies. This product includes software developed by Apache: http://www.apache.org/licenses/license-2.0.html SSL: http://www.openssl.org/source/license.html Pegasus: http://pegasus.codeplex.com/license ICU: http://source.icu-project.org/repos/icu/icu/trunk/license.html 2

Table of contents Intended Audience 4 Self Service Technical Support 4 Citrix StorageLink Documentation 5 Introduction to Citrix StorageLink 5 Components 6 Site Recovery Express 6 Overview 6 Feature overview 6 System Requirements 7 StorageLink Gateway... 7 StorageLink Manager... 7 Software prerequisites... 8 Installation Process 8 Installing Citrix License Server 9 Getting your license file 11 Installing the license file 11 Installing the StorageLink Gateway 12 Installing StorageLink Manager 14 Getting Started with StorageLink 14 Using SQL Server with StorageLink Gateway 15 Requirements... 15 3

Installation... 15 Switching to SQL Server... 15 Intended Audience The guide is intended for experienced virtual machine administrators, storage administrators, and testers of software applications. Self Service Technical Support Use the following Citrix links for self help resources and technical support information: Citrix StorageLink forum: http://forums.citrix.com/category.jspa?categoryid=172 Citrix Knowledge E Center: Documentation: http://support.citrix.com/product/emhv/esv5.5/#tab doc Tech Notes: http://support.citrix.com/product/emhv/esv5.5/#tab topic Learning (How to videos, whitepapers, Citrix Education courses): http://support.citrix.com/product/emhv/esv5.5/#tab learn Technical support may be purchased from Citrix Solution Advisors or directly from Citrix. For a complete list of Citrix Technical Support options, please refer to the following links on www.citrix.com: Americas o North America: http://www.citrix.com/english/ss/supportthird.asp?slid=25635&tlid=21176 o Latin America: http://www.citrix.com/english/ss/supportthird.asp?slid=25635&tlid=21177 EMEA: http://www.citrix.com/english/ss/supportthird.asp?slid=25635&tlid=21178 APAC: o Asia: http://www.citrix.com/english/ss/supportthird.asp?slid=25635&tlid=21179 o Australia & New Zealand: http://www.citrix.com/english/ss/supportthird.asp?slid=25635&tlid=1535346 Japan: http://www.citrix.com/english/ss/supportthird.asp?slid=25635&tlid=1678868 4

Citrix StorageLink Documentation The following documents are provided with Citrix StorageLink: Citrix StorageLink Installation Guide Citrix StorageLink User's Guide Citrix StorageLink PowerShell Guide Citrix StorageLink Release Notes In addition, StorageLink Manager has a Windows Help system. Introduction to Citrix StorageLink Citrix StorageLink is part of the Citrix Essentials product offering. Citrix Essentials is enterprise class virtual infrastructure that enhances the scalability and agility of Citrix XenServer and Microsoft Hyper V and Virtual Machine Manager with simplified storage set up and operation, powerful virtual machine lifecycle management, and dynamic server provisioning. Citrix StorageLink allows you to leverage the full capabilities of supported storage arrays (thin provisioning, data deduplication, etc.) move applications into production faster with automated lab development, test and deployment tools increase business agility and speed new servers into production quickly with built in virtual machine cloning and snapshot support Citrix Essentials enables IT Professionals to accelerate virtualization projects using XenServer and/or Hyper V quickly, with less effort, and scale as business needs grow. Citrix Essentials is available in three editions: Platinum Edition provides site recovery (for Hyper V virtual machines only), workload lifecycle automation, and dynamic provisioning of server workloads to help reduce server and storage sprawl, and minimize repetitive administrative operations for large lab environments, complex server environments or large server farms Enterprise Edition provides advanced StorageLink technology and dynamic provisioning of virtual machine workloads to improve storage operations and utilization, and deliver server workloads more quickly and efficiently for environments with shared storage architectures and large server farms Express Edition provides Site Recovery Express for Hyper V deployments. It supports up to two Hyper V servers and one storage array on a primary site, and the same configuration on a secondary site for failover. 5

Components The core of Citrix StorageLink is the StorageLink Gateway, which runs on a Windows 2003/2008 server (physical or virtual machine) and serves as a platform for managing your storage and virtual machines. There are three ways to manage and use the rich feature set provided by StorageLink Gateway: the StorageLink Manager, a MMC based graphical user interface the StorageLink CLI, a command line interface that can be used in a Windows Command Prompt the StorageLink PowerShell plug in for Windows PowerShell, the new command line shell and task based scripting technology from Microsoft All components can be installed on the same system, or on separate physical or virtual machines running Windows 2003/2008. This guide is an overview for using Citrix StorageLink Manager. The Citrix StorageLink PowerShell Guide describes the PowerShell plug in. Site Recovery Express Citrix Essentials for Hyper V Express Edition is a free edition of the Citrix Essentials product. Citrix Essentials Express Edition provides a limited version of the Site Recovery feature,, called Site Recovery Express, which entitles you to use StorageLink to provide a framework for replicating and failing over a managed deployment of application storage resources, physical hosts, and Hyper V virtual machines to another location. This free edition allows you to use StorageLink to set up Site Recovery Express for up to two Hyper V servers and a single storage array on the primary site and up to two Hyper V servers and a single storage array on the remote secondary site, without the requirement of a license or installation of the Citrix License server. Overview Feature overview Citrix StorageLink has a number of key features that help simplify the lifecycle management of applications and virtual machines in your virtualized infrastructure. These key features include: Rapid virtual machine creation (UI). StorageLink allows you to form golden images (virtual machine templates) from storage volumes (LUNs) in your storage arrays along with data LUNs to enable rapid virtual machine creation of complex servers by leveraging the cloning and snapshot capabilities of the underlying storage array hardware. 6

Improved storage utilization. This allows administrators to easily add capacity and improve utilization of their storage hardware investment by leveraging thin provisioning capabilities inherent in most modern storage arrays. Lower TCO. StorageLink automates the configuration and provisioning of virtual machine storage; using templates, the provisioned storage is matched to the virtual machine storage resources requirements; StorageLink reduces manual error prone tasks and ensures the virtual machine has the necessary storage it needs. Site Recovery (for Hyper V virtual machines only). StorageLink provides a framework for replicating and switching over a StorageLink managed deployment of application storage resources, physical Hyper V hosts, and Hyper V virtual machines to another location. StorageLink provides the user with a graphical user interface, a command line interface and Windows PowerShell support. StorageLink graphically displays storage assets, virtualization hosts, host HBAs, and fabric information. System Requirements StorageLink Gateway The StorageLink Gateway can be installed on a physical or virtual machine. Note: If you are using the Windows firewall, your firewall will be disabled automatically. If you are using a 3 rd party firewall, you must manually create a firewall rule to open port 21605, or disable your firewall altogether. Another alternative is to run both the Citrix StorageLink Manager and the Citrix StorageLink Gateway service on the same machine. Operating system RAM Disk space Microsoft Windows 2008 (recommended) or Windows 2003 1 GB or more minimum of 100 MB for Gateway installation StorageLink Manager StorageLink Manager can be installed on a physical or virtual machine. Operating system RAM Disk space Microsoft Windows 2008 (recommended) or Windows 2003 1 GB or more minimum of 100 MB 7

Software prerequisites Prerequisite Microsoft Management Console 3.0 SQL SQL lite or Microsoft SQL Server Description (required for StorageLink Manager) http://preview.tinyurl.com/33ge7s StorageLink Gateway supports SQLite and Microsoft SQL Server 2008 databases (for SQL Server, only Windows Authentication mode is supported.) SQLite is installed with StorageLink Gateway and is used by default. If you want to use SQL Server, see the section Using SQL Server with StorageLink Gateway. Microsoft Windows PowerShell Installation Process required to use the StorageLink PowerShell plug in On Windows 2008 the Windows PowerShell feature needs to be added. This can be done from the Windows Server Manager under Features. Previous to Windows 2008, Windows PowerShell needs to be downloaded from Microsoft and installed. See http://preview.tinyurl.com/yk5h8l In summary, the installation process for Citrix StorageLink goes as follows: 1. Install and apply Citrix License Server the StorageLink Gateway and StorageLink Manager require that you install Citrix License Server and apply that license to your host (Platinum and Enterprise editions only Express edition requires no license). 2. Install StorageLink Gateway this is the first step for using StorageLink. The StorageLink Gateway can be installed on Windows 2003 Server or Windows 2008 Server. 3. Install StorageLink Manager the StorageLink Manager is installed next. It is the graphical user interface used to interface with the StorageLink Gateway. Either before or after StorageLink installation, the overall environment needs to be set up for use with StorageLink: One of the supported storage systems must be available One or more hypervisor hosts running Windows 2008 Server must be available Configuration of storage systems and hypervisor hosts is described in detail in the Citrix StorageLink User Guide. To begin the installation process, insert the DVD into the DVD drive. If autorun is disabled on your machine, browse to the drive and launch autorun.exe. 8

Note: If, after installing StorageLink, you want to use a different License Server, use the ls-set command: C:\Program Files (x86)\citrix\storagelink\client>ls-set <license server> <license port> You will need to restart the StorageLink Gateway service after this. There is also a ls-get command which retrieves the License Server settings. Installing Citrix License Server Citrix License Server version 11.6.1 is required for StorageLink Platinum and Enterprise editions. Note: Citrix License Server is not required for the free Citrix Essentials Express edition. If you are installing the Express edition, skip this section. Citrix License Server is not supported on Windows Server 2008 R2. To install Citrix Licensing Server 1. From the autorun home screen, select Install Citrix License Server. 2. When prompted with the security warning, select Run. 3. If prompted with the Internet Explorer Security Warning, message, select Run. 4. Click Next at the bottom of the Welcome screen to continue. 5. Select I accept the license agreement and then click Next to continue. 6. Use the default installation path or click Browse to browse to your preferred installation destination, and then click Next to continue. 7. Select the features you would like to install. All features are selected by default. Click Next to continue. 8. Select the folder where you would like the license files stored or just continue to use the default value C:\Program Files (x86)\citrix\licensing\myfiles\. Click Next to continue. 9

9. Enter the port number for the license server and the port number for the daemon, or just continue to use the default values (recommended). Click Next to continue. 10. The installer has gathered the necessary information and is ready to begin installing the software. Click Next to continue. 11. The installation has completed. Click Finish at the bottom of the screen to exit the installation. 10

Getting your license file When you purchase StorageLink, you are provided with a license code that will allow you to download a license file from the Citrix website. To activate your license, you need an account on the My Citrix website. If you don t already have an account, go to http://citrix.com/english/mycitrix/loginnewuser.asp to create one. the host name of the machine on which you installed Citrix License Server. Note: A Citrix license is required for Citrix Essentials Platinum and Enterprise editions only. It is not required for the free Citrix Essentials Express edition. If you are installing the Express edition, skip this section. To activate your license 1. Log in to your account on My Citrix. 2. Go to https://www.citrix.com/english/mycitrix/appcontext.asp?applicationid=10 3. This is the start page of the Citrix Activation System. Click I Agree to confirm that your company owns the license you are about to activate, and that you are not activating the license on behalf of one of your customers. 4. The next page prompts for your license code. Enter it in the field provided, and then click Continue. 5. The next page prompts you to select a Solution Advisor. You can search for a Solution Advisor by Country, State, and/or Name. Select the Solution Advisor from the list returned by the search, or choose I cannot find my reseller and click Continue. 6. If you chose I cannot find my reseller, browse the list of contacts, or click Add a New Contact. This will open a form that will allow you to add new contact information to the database. Fill it out appropriately and click Continue. 7. The next page prompts you to select licenses to allocate. Follow the instructions on the web page, and enter the hostname of your Citrix License Server in the field provided. Click Continue. 8. The next page gives you a download link for your license file. Download the file to a known location. Installing the license file Once you have downloaded your StorageLink license file, you need to install it. Note: A Citrix license is required for Citrix Essentials Platinum and Enterprise editions only. It is not required for the free Citrix Essentials Express edition. If you are installing the Express edition, skip this section. To install your license 1. Copy the license file to C:\program files\citrix\licensing\myfiles (or wherever you installed License Server). 2. In a Command Prompt, change directories to the license server location C:\program files\citrix\licensing and enter the following command: lmreread c @localhost 11

which triggers the License Server to reread the license file. Note: You will need to modify the Internet Explorer Enhanced Security Configuration (ESC) so that you can download and install required software components, such as Sun s Java runtime environment required by Citrix Licensing Sever, to ensure the Citrix Essentials product works as desired. To temporarily disable IE ESC in order to download these software components, please do the following: 1. Open Administrative Tools -> Server Manager. 2. On the Summary Page, click on Configure IE ESC, and choose the Off radio button for Administrators and Users. 3. Install all required software components. 4. Re enable IE ESC. Installing the StorageLink Gateway 1. Log on to your Microsoft Windows host as the Administrator user or as a user who is a member of the Windows Administrators group. The Gateway installation process will ask you for your Administrator account login information, as the Gateway must run at an elevated permission level in order for it to manage other hosts in the environment. 2. Insert the DVD created from the ISO image downloaded from the Citrix website. 3. Click Install StorageLink Gateway from the autorun screen. 4. The setup wizard starts. Click the Next button at the bottom of the Welcome screen to continue. 5. The License Agreement screen appears. Click I Agree to continue. 6. If installing the Citrix Essentials Platinum or Enterprise Edition, the License Server Setting screen appears: 12

13 If you have a Platinum Edition or Enterprise Edition license, check the Use License Server checkbox and enter the License Host Name and License Port Number in the provided fields. Otherwise, uncheck the checkbox and the Express Edition will be installed. Click Next to continue. If installing the Citrix Essentials Express Edition, the License Server Setting screen is not displayed. 7. The Choose Install Location screen appears. Use the default installation path or click Browse to specify your preferred installation destination, and then click Install at the bottom of the screen to continue. 8. The installer has gathered the necessary information and begins installing the software. 9. When the installation has completed, click the Finish at the bottom of the wizard to complete the installation.

Installing StorageLink Manager 1. Select Install StorageLink Manager from the autorun screen. 2. The setup wizard starts. Click Next at the bottom of the Welcome screen to continue. 3. The License Agreement screen appears. Click I Agree to continue. 4. The Choose Install Location screen appears. Use the default installation path or click Browse to specify your preferred installation destination, and then click Install at the bottom of the screen to continue. 5. The installer has gathered the necessary information and begins installing the software. 6. When the installation has completed, click the Finish at the bottom of the wizard to complete the installation. Getting Started with StorageLink The following tasks need to be performed before using StorageLink. Details can be found in the Citrix StorageLink User Guide. Configure your hypervisor hosts first, enable each server to function as a Hyper V host. To do so, open the Server Manager and click on the Roles node in the tree in the left pane; then in the right, click on Add Role to launch the Add Roles wizard, and select Hyper V from the list of roles the wizard presents. Enabling this role requires a reboot. After the reboot, make sure that you open Hyper V Manager and accept the EULA that it will present to you on first launch. Second, enable the iscsi initiator. From the Start menu, select Administrative Tools > iscsi initiator, and confirm that you do want to enable the iscsi initiator service when so prompted. Connect to the StorageLink Gateway first step is to connect the administrative console to the StorageLink Gateway (can also be done through the StorageLink command line or PowerShell interfaces). Connect to your Hypervisor hosts once the StorageLink Gateway and StorageLink Manager are installed you need to add you hypervisor hosts through the StorageLink Manager (can also be done through the StorageLink command line or PowerShell interfaces). Add Storage Array Adaptor in order to interface with you r storage modules, they must be added to the StorageLink Gateway through the StorageLink GUI (can also be done through the command line or PowerShell interfaces). Create a Storage Repository create a storage repository using the Storage repository Wizard (can also be done through the StorageLink command line or PowerShell interfaces). Please refer to the Citrix StorageLink User Guide for more detailed information about using StorageLink. 14

Using SQL Server with StorageLink Gateway StorageLink Gateway supports SQLite and Microsoft SQL Server 2008 databases (for SQL Server, only Windows Authentication mode is supported.) SQLite is installed with StorageLink Gateway and is used by default. Requirements If you want to use SQL Server, there are a couple of requirements and recommendations for best performance: Use the same server (physical or virtual machine) on which the StorageLink Gateway service and SQL Server both run. SQL Server must be collocated with StorageLink Gateway in order to allow for Windows authentication, which is the only kind of authentication StorageLink Gateway supports. Use a server with two or more CPUs (physical or virtual machine) for best performance. If you do use a single CPU host, run the SQL Server service at a higher process priority than the StorageLink Gateway service. To do this, open the Windows Task Manager and click on the Processes tab. Find the StorageLink Gateway process (listed as cslg_service.exe*32), right click on it, and select Set Priority from the context menu. Set it to Normal if it not already set to that choice. Next, find the SQL Server process (listed as sqlservr.exe *32 or something similar), rightclick and choose Set Priority, and select Above Normal or High. Click Change Priority in the confirmation box that appears, then close the Task Manager. If neither of these recommendations are followed, you will see a heavy slowdown of certain operations (particularly while using Site Recovery and validating virtual machine failover configuration on a secondary site), as well as spurious failures of site recovery plan validation with database timeouts registered in the StorageLink service logs. We also recommend that you install StorageLink Manager on a different host (physical server or virtual machine) than the one running Storagelink Gateway SQL Server. Installation Installation instructions for Microsoft SQL Server 2008 can be found at http://preview.tinyurl.com/yksgsl6 Switching to SQL Server You can change the database used by StorageLink to Microsoft SQL Server 2008 by using the script cslg_db_config.cmd., located in <%StorageLink Gateway Installation Directory%>\Server\ which by default is C:\Program Files (x86)\citrix\storagelink\server For setting up the StorageLink Gateway with Microsoft SQL Server, the script syntax is: cslg_db_config.cmd mssql [Database Server Name] [Database Instance Name] 15

NOTE: The server name and instance name parameters depend on a couple of factors: SQL Server compact edition uses (local) for the Database Server Name. All editions other than the compact edition use a real server name, localhost in most cases. For editions other than SQL Server Compact Edition, the Database Instance Name may or may not exist depending on whether SQL Server was installed as a "named instance" or as an "unnamed default instance." In the case of SQL Server Compact edition, there is no named instance; only the unnamed default instance can be used. Also attach the StorageLink Gateway Microsoft SQL database files (cslg_db.mdf and cslg_db_1.ldf) to your SQL Server database instance. These files are in the <%StorageLink Gateway Data Directory%>\Server\Database directory, which by default is C:\ProgramData\Citrix\StorageLink\Server\Database You can also use this script to switch back to using the default embedded SQLite database. The script syntax is then: cslg_db_config.cmd sqlite <%StorageLink Gateway Data Directory%>\Server where the default StorageLink Gateway data directory is c:\programdata\citrix\storagelink NOTE: The cslg_db_config.cmd script stops and restarts the StorageLink Gateway service. If you run the script with erroneous parameters, the StorageLink Gateway service will be stuck in Starting mode. If this happens, you will need to manually stop the service (Start menu -> Administrative Tools -> Services) and run the script again with correct parameters. 16

Citrix Worldwide Worldwide headquarters Citrix Systems, Inc. 851 West Cypress Creek Road Fort Lauderdale, FL 33309 USA T +1 800 393 1888 T +1 954 267 3000 Regional headquarters Americas Citrix Silicon Valley 4988 Great America Parkway Santa Clara, CA 95054 USA T +1 408 790 8000 Europe Citrix Systems International GmbH Rheinweg 9 8200 Schaffhausen Switzerland T +41 52 635 7700 Asia Pacific Citrix Systems Hong Kong Ltd. Suite 3201, 32nd Floor One International Finance Centre 1 Harbour View Street Central Hong Kong T +852 2100 5000 Citrix Online division 5385 Hollister Avenue Santa Barbara, CA 93111 USA T +1 805 690 6400 www.citrix.com About Citrix Citrix Systems, Inc. (Nasdaq:CTXS) is the global leader and the most trusted name in application delivery infrastructure. More than 200,000 organizations worldwide rely on Citrix to deliver any application to users anywhere with the best performance, highest security and lowest cost. Citrix customers include 100% of the Fortune 100 companies and 98% of the Fortune Global 500, as well as hundreds of thousands of small businesses and prosumers. Citrix has approximately 6,200 channel and alliance partners in more than 100 countries. Annual revenue in 2006 was $1.1 billion. 2009 Citrix Systems, Inc. All rights reserved. Citrix, Citrix Presentation Server, Citrix XenServer are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. Microsoft and Windows are registered trademarks of Microsoft Corporation in the United States and/or other countries. UNIX is a registered trademark of The Open Group in the United States and other countries. All other trademarks and registered trademarks are property of their respective owners.