citrix branch repeater licensing guide - march 2010

Citrix Branch Repeater

Licensing Guide Citrix Repeater

Citrix Repeater Plug-in for Citrix Receiver

Citrix Branch Repeater

Citrix Branch Repeater with Windows Server

Citrix Branch Repeater VPX

Product Licensing Guide

Citrix Branch Repeater Licensing Guide

Document revision history

Version Date Author Comments

1 02/17/2009 Rajib Ghosh Initial Version

2 03/03/2010 Rajib Ghosh Updated, added Branch Repeater VPX

CITRIX SYSTEMS, INC., 2010. ALL RIGHTS RESERVED. NO PART OF THIS DOCUMENT MAY BE REPRODUCED OR TRANSMITTED IN ANY FORM OR BY ANY MEANS OR USED TO MAKE DERIVATIVE WORK (SUCH AS TRANSLATION, TRANSFORMATION, OR ADAPTATION) WITHOUT THE EXPRESS WRITTEN PERMISSION OF CITRIX SYSTEMS, INC.

FLEXNET OPERATIONS AND FLEXNET PUBLISHER ARE TRADEMARKS AND/OR REGISTERED TRADEMARKS OF ACRESSO SOFTWARE INC. AND/OR INSTALLSHIELD CO. INC.

ALTHOUGH THE MATERIAL PRESENTED IN THIS DOCUMENT IS BELIEVED TO BE ACCURATE, IT IS PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE ALL RESPONSIBILITY FOR THE USE OR APPLICATION OF THE PRODUCT(S) DESCRIBED IN THIS MANUAL. CITRIX SYSTEMS, INC. OR ITS SUPPLIERS DO NOT ASSUME ANY LIABILITY THAT MAY OCCUR DUE TO THE USE OR APPLICATION OF THE PRODUCT(S) DESCRIBED IN THIS DOCUMENT. INFORMATION IN THIS DOCUMENT IS SUBJECT TO CHANGE WITHOUT NOTICE. COMPANIES, NAMES, AND DATA USED IN EXAMPLES ARE FICTITIOUS UNLESS OTHERWISE NOTED


Contents

1. Introduction......................................................................................................................................................2

1.1. Who should read this?..........................................................................................................................................................2

1.2. Prerequisites...........................................................................................................................................................................3

1.3. Licensing overview................................................................................................................................................................3

2. Generating Licenses .......................................................................................................................................4

2.1. Using the Activation System/Manage Licenses tool ...............................................................................................4

2.2. Obtaining the Host ID (MAC Address).............................................................................................................................5

2.2.1. Citrix Branch Repeater with Windows Server ........................................................................................................5

2.2.2. Citrix Repeater and Citrix Branch Repeater............................................................................................................6

2.2.3. Citrix Branch Repeater VPX ....................................................................................................................................6

2.2.4. Citrix License Server ...............................................................................................................................................7

2.3. Repeater Plug-in licenses....................................................................................................................................................7

2.3.1. Handling High-Availability and Disaster Recovery scenarios..................................................................................8

2.3.2. Getting Platinum Edition entitlements...................................................................................................................8

2.4. Partner / Not-for-Resale / Internal-Only-Use Licenses ............................................................................................9

3. Installing Licenses .........................................................................................................................................10

3.1. Citrix Branch Repeater with Windows Server .......................................................................................................... 10

3.2. Citrix Repeater and Citrix Branch Repeater.............................................................................................................. 11

3.3. Citrix Branch Repeater VPX ............................................................................................................................................ 12

3.4. Citrix License Server.......................................................................................................................................................... 13

3.5. Citrix Repeater Plug-in ..................................................................................................................................................... 14

4. Upgrading from Old Software........................................................................................................................15

4.1. Using the Product Upgrades/Fulfillment tool ....................................................................................................... 15

4.2. Installing the License Server on Branch Repeater with Windows Server....................................................... 16

5. For Additional Information .............................................................................................................................17


2

1. Introduction This document describes the current licensing mechanism in the Citrix Branch Repeater product family. Starting with the following software versions, Citrix migrated the Branch Repeater family of products to use standard Citrix Licenses.

Citrix Repeater 5.0

Citrix Repeater Plug-in 5.0

Citrix Branch Repeater 5.0

Citrix Branch Repeater with Windows Server 1.5

Citrix Branch Repeater VPX is the latest addition to the Branch Repeater product family. Branch Repeater VPX 5.6 is the first software version of Branch Repeater VPX and requires standard Citrix licenses.

The various software versions apply to the following products:

Software Product

Repeater 5.0+ Repeater 8310 (1), 8320 (1), 8510 (2), 8520, 8530 (2), 8540, 8810 (2), 8820, 8820 with High Speed Upgrade

Repeater Plug-in 5.0+ Repeater Plug-in for Citrix Receiver

Branch Repeater 5.0+ Branch Repeater 100, 200, 300

Branch Repeater with Windows Server 1.5+ Branch Repeater with Windows Server 100, 200, 300 (3)

Branch Repeater with Windows Server 2008 100, 200, 300

Branch Repeater VPX 5.6+ Branch Repeater VPX

(1) EOL announced for March 31, 2012

(2) EOL announced for September 30, 2012

(3) EOL announced for July 31, 2013

Migrating to Citrix Licenses from the proprietary licenses used in previous versions of the software will provide more flexibility in managing your license entitlements and make the licensing process consistent with other Citrix products.

1.1. Who should read this?

This document is for any Citrix customer or partner who intends to purchase a new Citrix Branch Repeater product, or upgrade the software on their existing products to current software versions. If you already own a Branch Repeater product and do not intend to upgrade the software, you do not need to read this document.


3

1.2. Prerequisites

This document assumes a basic level of familiarity with Citrix Licensing and the My Citrix portal used to manage licenses. If you are not familiar with these, refer to http://support.citrix.com/proddocs/topic/licensing/lic-library-node-wrapper.html for more information.

1.3. Licensing overview

Starting with the software versions listed above, Citrix Branch Repeater appliances will ship from Citrix unlicensed and will require a valid Citrix License. Citrix Branch Repeater VPX software, available to download from My Citrix, is also unlicensed. License entitlements are delivered to your My Citrix account on http://www.mycitrix.com upon completion of your purchase. An Entitlement is a record of the quantity of licenses you have purchased. Use the tools available on the My Citrix portal to convert your entitlements into a Citrix License.

Licenses for Citrix Branch Repeater appliances are installed on the appliances. Licenses for Citrix Branch Repeater VPX can be installed on the Branch Repeater VPX as well as a network / remote Citrix license server. In either case, licenses are bound to the Branch Repeater appliance, Branch Repeater VPX, or Citrix license server using a unique hardware identifier called the Host Id.

IMPORTANT: The above listed software versions will not recognize the proprietary licenses used by previous versions of the software. Therefore, if you are upgrading the software on your Branch Repeater appliances from any previous version, you will need to exchange your previous license for a new Citrix License before starting the upgrade as described in Section 4 of this document.

Note that your Maintenance Agreement or Subscription Advantage membership is not affected by this license change.

This document contains detailed information and instructions for generating and installing licenses for new Branch Repeater product purchases as well as exchanging existing proprietary licenses for new standard Citrix licenses.


4

2. Generating Licenses

Beginning with the software versions listed in Section 1, Citrix Branch Repeater appliances will ship unlicensed from the factory. Citrix Branch Repeater VPX software, available to download from My Citrix, is also unlicensed. Upon completion of your purchase, license entitlements will be made available to you in your My Citrix account on http://www.mycitrix.com. If you dont have a My Citrix account, contact Customer Service.

2.1. Using the Activation System/Manage Licenses tool

Use the Activation System/Manage Licenses tool on My Citrix to convert your license entitlements to license files that you install on the Citrix Branch Repeater appliance.

Figure 1: Navigating to the "Activation System/Manage Licenses" tool on "My Citrix"

Once you login to your account on My Citrix, view your Citrix License entitlements and generate license files from them. The Activation System/Manage Licenses tool also enables you to move (re-allocate) your licenses in the event of an RMA or for High-Availability / Disaster Recovery scenarios. For further instructions on using this tool on My Citrix, refer to license server documentation at http://support.citrix.com/proddocs/topic/licensing/lic-library-node-wrapper.html.


5

2.2. Obtaining the Host ID (MAC Address)

Licenses for Citrix Branch Repeater appliances are installed on the appliances. Licenses for Citrix Branch Repeater VPX can be installed on the Branch Repeater VPX as well as a network / remote Citrix license server. In either case, licenses are bound to the Branch Repeater appliance, Branch Repeater VPX, or Citrix license server using a unique hardware identifier called the Host ID. You will need this Host ID to generate your license file from My Citrix.

IMPORTANT: In Branch Repeater VPX software release 5.6, only Express, Eval, NFR and IOUL licenses can be installed locally. Use a remote / network Citrix license server for Production (RETAIL) licenses.

Follow the steps outlined below to obtain the Host Id (MAC Address).

2.2.1. Citrix Branch Repeater with Windows Server

From the console, log onto the appliance via Remote Desktop and launch the Citrix Branch Repeater application from the shortcut on your desktop. Navigate to Manage Licenses where the License Host Id appears at the top right of the page, below the banner. Use only one (any one) of the Host Ids displayed.

Figure 2: Obtaining the Host Id for Citrix Branch Repeater with Windows Server


6

2.2.2. Citrix Repeater and Citrix Branch Repeater

Log onto the management console of the appliance and navigate to the Manage Licenses page where the License Host Id is displayed.

Figure 3: Obtaining the Host Id for Citrix Repeater and Citrix Branch Repeater

2.2.3. Citrix Branch Repeater VPX

Log onto the management console of the Branch Repeater VPX and navigate to the Manage Licenses page where the Local License Server Host Id is displayed.


7

Figure 4: Obtaining the Host Id for Citrix Branch Repeater VPX

2.2.4. Citrix License Server

To obtain the Host Id (MAC Address) of a Citrix License Server refer to documentation at http://support.citrix.com/proddocs/topic/licensing/lic-library-node-wrapper.html.

2.3. Repeater Plug-in licenses

Citrix Repeater Plug-in licenses are concurrent user-based licenses and are delivered as separate license entitlements in your My Citrix account. You no longer need to associate them with a Repeater appliance when ordering. Repeater Plug-in licenses can be installed on a Repeater appliance, Branch Repeater VPX as well as a remote / network Citrix license server.

Use the Activation System/Manage Licenses tool on My Citrix to allocate the concurrent user licenses across multiple Citrix Repeater appliances, Branch Repeater VPX instances, or remote / network Citrix license servers for complete flexibility. In order to generate a license you will need the Host Id of the Repeater appliance, Branch Repeater VPX, or Citrix license server where you wish to install the license. The generated concurrent user license is then bound to that Repeater appliance, Branch Repeater VPX, or Citrix license server via the Host Id.

IMPORTANT: In Branch Repeater VPX software release 5.6, only Express, Eval, NFR and IOUL licenses can be installed locally. Use a remote / network Citrix license server for Production (RETAIL) licenses.

IMPORTANT: As of the latest Repeater software release 5.5, Citrix Repeater appliances cannot consume licenses installed on a remote / network Citrix license server.

See Figure 5 for an illustration of allocating concurrent user licenses.


8

Figure 5: Illustration of Concurrent User license allocation

2.3.1. Handling High-Availability and Disaster Recovery scenarios

Oftentimes business continuity needs require a backup or Disaster Recovery site. To ensure your Repeater Plug-ins continue to function with your DR site, copy your licenses on to the backup Repeater appliance. This is accomplished by reallocating the licenses using the Activation System/Manage Licenses tool on My Citrix. Reallocating your licenses will not impact the operation of your primary Repeater appliance.

The above procedure also ensures Repeater Plug-in operation in a High-Availability scenario. Repeater Plug-in concurrent user licenses can be reallocated to the secondary Repeater appliance.

Note that reallocating can only be done a fixed number of times (determined by Citrix). As per your Citrix EULA, only one copy of a license should be used at any given time.

For Branch Repeater VPX, it is recommended to use a remote / network Citrix license server to handle high-availability and disaster recovery scenarios. When a central Citrix license server is used to host licenses, the license is only consumed when it is being used. In other words, the license is checked out when it is used by the VPX and checked back in when its not used. Therefore, you do not need to reallocate it.

2.3.2. Getting Platinum Edition entitlements

The Citrix Repeater Plug-in is included as a part of the Citrix NetScaler, Citrix XenApp and Citrix XenDesktop Platinum Editions. However, the Repeater Plug-in requires separate entitlements and licenses as described above. New customers of any of the above Platinum Edition products will receive their Repeater Plug-in concurrent user entitlements in their My Citrix account after their purchase along with their other Platinum entitlements. Customers who purchased the Platinum Edition products prior to this license migration will


9

receive their Repeater Plug-in entitlements in their My Citrix account as a one-time delivery when this license migration happens. If the Repeater Plug-in entitlements do not appear in your My Citrix account, contact Customer Service.

2.4. Partner / Not-for-Resale / Internal-Only-Use Licenses

Partners will have access to their Not for Resale and Internal Only Use licenses via the Partner Use Licenses toolbox on My Citrix. Not for Resale Repeater Plug-in and Branch Repeater VPX licenses are also available via the same toolbox.

Figure 6: Obtaining Not-for-Resale and Internal-Only-Use Licenses via My Citrix


10

3. Installing Licenses

Licenses for Citrix Branch Repeater appliances are installed on the appliances via their respective management consoles. When your license file (*.lic) is generated, download and copy it to the hard disk of your Branch Repeater with Windows Server appliance. For Repeater and Branch Repeater appliances copy the license file onto the hard disk of the computer you use to login to the appliances web-based management console.

Licenses for Citrix Branch Repeater VPX can be installed on the Branch Repeater VPX as well as a network / remote Citrix license server. To install your Branch Repeater VPX license locally, copy the license file onto the hard disk of the computer you use to login to the Branch Repeater VPXs web-based management console. To install your Branch Repeater VPX license on a Citrix License Server refer to documentation at http://support.citrix.com/proddocs/topic/licensing/lic-library-node-wrapper.html.

IMPORTANT: In Branch Repeater VPX software release 5.6, only Express, Eval, NFR and IOUL licenses can be installed locally. Use a remote / network Citrix license server for Production (Retail) licenses.

Follow the steps outlined below to install your license:

3.1. Citrix Branch Repeater with Windows Server

1. Log onto the appliance from the console or via Remote Desktop.

2. Launch the Citrix Branch Repeater utility.

3. Navigate to "Manage Licenses," and click the "Add License" link.

4. Click Load From File to browse and select a license. Optionally, you can edit the license name.

5. Click Finish to complete the license installation.


11

Figure 7: Importing a license into Citrix Branch Repeater with Windows Server

3.2. Citrix Repeater and Citrix Branch Repeater

1. Log onto the web-based management console of the appliance.

2. Navigate to the Manage Licenses page and click the License Configuration tab.

3. Click Add.

4. Click Browse to browse and select a license. Optionally, you can edit the license name.

5. Click Install to complete the license installation.


12

Figure 8: Importing a license into Citrix Repeater or Citrix Branch Repeater

For additional information and details on license management refer to the Citrix Repeater user guide at https://www.citrix.com/English/ss/downloads/results.asp?productID=33886 and the Citrix Branch Repeater user guides at https://www.citrix.com/English/ss/downloads/results.asp?productID=1350184.

3.3. Citrix Branch Repeater VPX

To install licenses locally on Branch Repeater VPX:

1. Log onto the web-based management console of the Branch Repeater VPX.

2. Navigate to the Manage Licenses page and click the License Server tab.

3. For License Server Location, select Local.

4. Click on the Local Licenses tab

5. Click Add.

6. Browse and select the license file. Click Install to complete the license installation.


13

Figure 9: Importing a license locally into Citrix Branch Repeater VPX

To configure Branch Repeater VPX to consume licenses on a remote / network Citrix license server:

1. Log onto the web-based management console of the Branch Repeater VPX.

2. Navigate to the Manage Licenses page and click the License Server tab.

3. For License Server Location, select Remote.

4. Enter the IP address of the remote / network Citrix license server and port (pre-populated with default).

5. Select the license to consume (e.g. VPX-45).

6. Click Apply to finish the configuration.

Figure 10: Configuring Branch Repeater VPX to consume licenses on a Citrix License Server

3.4. Citrix License Server

To install licenses on a Citrix License Server refer to documentation at http://support.citrix.com/proddocs/topic/licensing/lic-library-node-wrapper.html.


14

3.5. Citrix Repeater Plug-in

Citrix Repeater Plug-in licenses can be installed on a Repeater appliance, Branch Repeater VPX as well as a remote / network Citrix license server as described above. Note that Repeater Plug-in licenses are incremental licenses meaning they add-up on any given Repeater appliance, Branch Repeater VPX or Citrix license server. For example, in the Repeater appliance depicted below, the total licensed Repeater Plug-in concurrent user limit would be 5 + 25 = 30.

Figure 11: Illustration of Repeater Plug-in incremental licenses


15

4. Upgrading from Old Software

Beginning with the software versions listed above in Section 1, Citrix is migrating the Branch Repeater family of products to use standard Citrix Licenses. These new software versions will not recognize the proprietary licenses used by previous versions of the software. Therefore, if you are upgrading the software on your Citrix Branch Repeater appliances from earlier versions to the above listed or later versions, you must exchange your previous license for a new Citrix License before starting the upgrade. Note that your Maintenance Agreement or Subscription Advantage membership is not affected by this change.

NOTE: This section does not apply to Branch Repeater VPX. Branch Repeater VPX 5.6 is the first software version of Branch Repeater VPX and requires standard Citrix licenses.

Follow the steps below to exchange your license and upgrade the software on your Branch Repeater appliance.

1. Exchange the current license for a new Citrix License using the Product Upgrade/Fulfillment tool on My Citrix. Your Branch Repeater appliance will continue to function with the current license even after you obtain your new Citrix License.

2. Ensure that you obtain your new license entitlement via email.

3. Download the latest version of Repeater or Branch Repeater software from https://www.citrix.com/English/ss/downloads/results.asp?productID=33886 or https://www.citrix.com/English/ss/downloads/results.asp?productID=1350184 respectively.

4. For Branch Repeater with Windows Server, copy the new software onto the hard disk of the Branch Repeater appliance. For Repeater or Branch Repeater ensure you have the software available on the hard disk of the computer you will use to login to the appliances web-based management console.

5. Upgrade the software on your Repeater or Branch Repeater. Refer to the user guides for instructions on this step. IMPORTANT: For Branch Repeater with Windows Server, if you are prompted to install the license server, install the latest copy of the license server from https://www.citrix.com/English/ss/downloads/results.asp?productID=1679389. Upgrading the software will require a reboot of the appliance.

6. Once the reboot is complete, log back in to My Citrix and generate a license file. You will require the Host ID of the Branch Repeater appliance for this step. The Activation System/Manage Licenses tool will guide you through this. When your license file (*.lic) is generated, download and copy it to the hard disk of your Branch Repeater with Windows Server appliance. For Repeater or Branch Repeater copy the license file onto the hard disk of the computer you will use to login to the Repeater or Branch Repeater appliances web-based management console.

7. Install your new Citrix License. Refer to Section 3 or the user guides for instructions on this step.

4.1. Using the Product Upgrades/Fulfillment tool

Use the Product Upgrades/Fulfillment tool on My Citrix to exchange your previous proprietary license for a new Citrix License for the Citrix Branch Repeater appliances. Navigate to the tool from your toolbox and when prompted select WANScaler (note that it will take some time to change this online utility to reflect the new Repeater name) or Branch Repeater from the product list. Follow the prompts to generate an entitlement for your new Citrix License. You will receive your new license entitlement via email.


16

Figure 12: Navigating to the "Product Upgrades/Fulfillment" tool on My Citrix

4.2. Installing the License Server on Branch Repeater with Windows Server

Citrix Branch Repeater with Windows Server appliances that ship with software version 1.5 or later already include the Citrix License Server. However, if you are upgrading the software on a previously purchased Branch Repeater with Windows Server appliance, you must install the Citrix License Server. The installer for Branch Repeater software version 1.5 or later will prompt you if the Citrix License Server is not installed.

When prompted, install the latest license server from https://www.citrix.com/English/ss/downloads/results.asp?productID=1679389. Follow the installer prompts to install the license server. Note that this is a one-time install and you do not need to install it if you upgrade the software subsequently.

IMPORTANT: De-select the LMC option while installing the Citrix License Server on Branch Repeater with Windows Server appliances. LMC installation requires JRE and IIS. Use the Branch Repeater with Windows Server appliance management console for license management.


17

5. For Additional Information

Refer to additional information at the following locations:

Citrix Licensing Documentation:

http://support.citrix.com/proddocs/topic/licensing/lic-library-node-wrapper.html

Citrix Branch Repeater Software and Documentation: https://www.citrix.com/English/ss/downloads/results.asp?productID=1350184

Citrix License Server Software and Documentation: https://www.citrix.com/English/ss/downloads/results.asp?productID=1679389

citrix branch repeater licensing guide - march 2010

Documents