Connection Broker Installation - Guide
Connection Broker Installation - Guide
Installation Guide
Chapter 1: Overview
Contacting Leostream
Leostream Corporation 411 Waverley Oaks Rd Suite 316 Waltham, MA 02452 USA http://www.leostream.com Telephone: +1 781 890 2019 Fax: +1 781 688 9338 To submit an enhancement request, email [email protected]. To request product information or inquire about our future directions, email [email protected].
Copyright
Copyright 2002-2013 by Leostream Corporation This software program and documentation are copyrighted by Leostream. The software described in this document is provided under a license agreement and may be used or copied only under the terms of this agreement. No part of this manual may be copied or reproduced in any form without prior written consent from Leostream.
Trademarks
The following are trademarks of Leostream Corporation. Leostream The Leostream graphical logo The absence of a product name or logo from this list does not constitute a waiver of the trademark or other intellectual property rights concerning that product, name, or logo by Leostream. Sun, Sun Microsystems, Sun Ray, and Java are trademarks or registered trademarks of Oracle and/or its affiliates. Linux is the registered trademark of Linus Torvalds in the U.S. and other countries. UNIX is a registered trademark of The Open Group. OpenLDAP is a trademark of The OpenLDAP Foundation. Microsoft, Active Directory, SQL Server, Excel, ActiveX, Hyper-V, Windows, and the Windows logo are trademarks or registered trademarks of Microsoft Corporation in the United States and/or other countries. Other brand and product names are trademarks or registered trademarks of their respective holders. Leostream claims no right to use of these marks.
Patents
Leostream products are patent pending.
Installation Guide
Contents
CONTENTS........................................................................................................................................................... 3 CHAPTER 1: OVERVIEW .................................................................................................................................... 5 LEOSTREAM COMPONENTS ..................................................................................................................... 5 W HAT IS THE CONNECTION BROKER? .......................................................................................................... 5 HARDWARE REQUIREMENTS ....................................................................................................................... 7 VIRTUALIZATION PLATFORM REQUIREMENTS ................................................................................................ 7 CHAPTER 2: DOWNLOADING SOFTWARE AND MANUALS .......................................................................... 8 CHAPTER 3: INSTALLING THE CONNECTION BROKER ................................................................................ 9 INSTALLING INTO VMWARE WORKSTATION ................................................................................................... 9 INSTALLING USING VMWARE VSPHERE CLIENT .......................................................................................... 9 INSTALLING INTO VMWARE ESX/ESXI 3.5 USING VCENTER SERVER .......................................................... 10 MANUALLY INSTALLING INTO VMWARE ESX 3.5 ......................................................................................... 10 INSTALLING INTO CITRIX XENSERVER .................................................................................................... 17 INSTALLING INTO MICROSOFT HYPER-V SERVER 2008 ........................................................................... 19 INSTALLING INTO RED HAT ENTERPRISE VIRTUALIZATION 3.0 ........................................................................ 21 STARTING THE CONNECTION BROKER VIRTUAL MACHINE ............................................................................. 21 MANUALLY CONFIGURING THE CONNECTION BROKER ADDRESS ................................................................... 22 Entering the Connection Broker Address .......................................................................................... 22 Restarting the Connection Broker ..................................................................................................... 24 Returning to the Connection Broker Welcome Screen ...................................................................... 24 CONFIGURING SECOND NETWORK ADAPTER FOR PCOIP ............................................................................. 24 USING FIREWALL PORTS ............................................................................................................................. 24 CHAPTER 4: INSTALLING THE LEOSTREAM AGENT ..................................................................................... 26 INSTALLING ON MICROSOFT W INDOWS OPERATING SYSTEMS .................................................................. 26 Starting and Stopping the Leostream Agent ...................................................................................... 30 Entering the Connection Broker IP Address ...................................................................................... 30 Using the Leostream Agent with Microsoft Hyper-V Server ........................................................ 31 Configuring the Leostream Agent for Citrix XenDesktop Support ............................................... 31 Configuring the Leostream Agent for Citrix XenApp Support ..................................................... 32 INSTALLING ON LINUX OPERATING SYSTEMS ................................................................................................ 33 Prerequisites for Installing USB over IP Support ............................................................................... 34 Using the Graphical Installer ............................................................................................................. 34 Silent Installations using XML-Files ................................................................................................... 38 Installing at the Console .................................................................................................................... 38 Starting the Leostream Agent Service ............................................................................................... 39 Leostream Agent Files ....................................................................................................................... 39 CHAPTER 5: INSTALLING LEOSTREAM CONNECT........................................................................................ 41 INSTALLING ON MICROSOFT W INDOWS OPERATING SYSTEMS .................................................................. 41 Entering the Connection Broker IP Address ...................................................................................... 44 INSTALLING ON LINUX AND APPLE MAC OPERATING SYSTEMS ............................................................... 45 Prerequisites for Installing USB over IP Support ............................................................................... 45 Installation Instructions ...................................................................................................................... 46 Leostream Connect Files ................................................................................................................... 50 SILENT INSTALLATIONS USING XML-FILES .................................................................................................... 51 CHAPTER 6: INSTALLING LEOSTREAM COMPONENTS IN SUN ENVIRONMENTS .................................... 52 SUN RAY SERVER HOST SETUP .................................................................................................................. 52
3
Chapter 1: Overview
SUN SECURE GLOBAL DESKTOP SOFTWARE SETUP ..................................................................................... 52 Installing Leostream Connect ............................................................................................................ 52 Adding a Leostream Application ........................................................................................................ 53 CHAPTER 7: SETTING CONNECTION BROKER DNS SERVICE LOCATION (SRV) ...................................... 59 APPENDIX A: COMMAND LINE OPTIONS FOR LEOSTREAM CONNECT AND LEOSTREAM AGENT ....... 62 INSTALLING FROM THE COMMAND LINE ........................................................................................................ 62 UNINSTALLING FROM THE COMMAND LINE .................................................................................................... 63 ENCODING THE CONNECTION BROKER ADDRESS ......................................................................................... 64
Installation Guide
Chapter 1: Overview
This installation guide provides instructions for installing the Connection Broker, Leostream Agent, and Leostream Connect. See the Quick Start Guides and Administrators Guides for additional information on configuring these components after installation.
Leostream Components
The Leostream Connection Broker consists of the following four components. Connection Broker: The main virtual appliance that manages the hosted desktop infrastructure. The Connection Broker is the central management layer for configuring your deployment, including: inventorying desktops, applications, printers, and other resources, assigning these resources to users, and defining the end-user experience. Leostream Agent: When installed on the remote desktops, the Leostream Agent provides the Connection Broker with insight into the connection status of remote users. On remote desktops running a Microsoft Windows operating system, the Leostream Agent also controls the end-user experience with respect to USB device management and multi-monitor support. Although optional, the Leostream Agent is a critical component when scaling out deployments to a large number of end users. Leostream Connect: A client provided by Leostream that allows users to log into desktops from fat or thin clients. Using Leostream Connect, you can repurpose existing fat desktops and laptops, lowering the cost of VDI deployments. Some thin clients provide built-in Leostream Connect clients. Database: The Connection Broker stores all information in an internal database. A typical installation requires 2 Gbyte of disk space for the internal database. Large scale deployments that require Connection Broker clusters must use an external Microsoft SQL Server 2005, 2008, or 2012 database.
Using the Connection Broker, you define: Authentication Servers: A server that provides authentication services to users logging into the Connection Broker. The Connection Broker supports Microsoft Active Directory, Novell eDirectory, or OpenLDAP directory services. You can specify any number of (trusted or not-trusted) domains, using any combination of authentication server types. In addition, the Connection Broker allows you to manually define users without configuring an authentication server. Centers: The external systems from which the Connection Broker pulls resources, including desktops, applications, and printers. Centers can be created from the following systems: VMware ESX/ESXi, vSphere, and vCenter Server (formerly VirtualCenter); Citrix XenDesktop, XenServer and XenApp (formerly Presentation Server); open source Xen; Microsoft Hyper -V via System Center Virtual Machine Manager (SCVMM), Remote Desktop Services (formerly Terminal Services), and Active Directory.
Chapter 1: Overview
Resources: Desktops, applications, and printers available for assignment to an end user. Desktops: Virtual machines, physical machines, blades, and Microsoft Terminal Services to assign to end users. Desktops can be running either Windows or Linux operating systems. Applications: Applications and desktops hosted in a Citrix XenApp farm. Pools: Collections of desktops or applications, gathered from a single or multiple centers. Clients: An application or system used to access a remote desktop. The Connection Broker supports Linux and Windows fat clients and a variety of thin clients, as well as Web browsers. Locations: A group of clients, defined by client attributes such as manufacturer, device type, OS version, or IP address. You can define the end-users experience, including the desktops, printers, and USB devices they can use, based on the location of their client. Plans: Common sets of rules that can be used as building blocks for defining the end user experience. There are two types of plans: pool-based plans such as protocol, power control, and release plans are applied to pools in a policy and define how the Connection Broker manages the desktops in that pool; location-based plans such as printer and registry plans are applied to desktops based on the location of the users client device. Policies: Rules that assign desktops and applications to users, and define what occurs when the assignment is done. Policies assign plans to desktops based on the desktops pool membership, and mange USB passthrough permissions. Roles: Permissions that control the actions an end user is allowed to take on their desktops and the level of access they have to the Connection Broker Administrator Web interface.
Administrator-defined access control rules that map end users to roles and policies, which determine: Which desktops and applications the Connection Broker offers the user The level of access each user has to the Connection Broker Administrator Web interface
The Connection Broker maps users to these rules via their authentication server attributes and assigns desktops and applications from pools, as depicted in the following figure.
Installation Guide
Users can access their desktops from any of the following devices: A Web browser, including Microsoft Internet Explorer and Mozilla Firefox browsers A variety of thin clients, including Wyse, HP, IGEL, IRIS, and more A Windows or Linux fat or thick client, using Leostream Connect.
Hardware Requirements
The Connection Broker requires virtual resources equivalent to the following hardware: 1500 MHz or faster Intel Pentium IV processor (or equivalent) 2.0 Gbytes of RAM 8 Gbytes of hard drive space Bridged Ethernet adapter, ideally with Internet connectivity
5.
The Resources section of the Leostream Web site contains additional information that you may find useful in getting started with your deployment. Go to the Downloads & Documentation page to download Leostream Connect, the Leostream Agent, or any Leostream documentation. Go to the Training page to download training presentations and videos showing how to get started with your Connection Broker. Go to the Frequently Asked Questions for a list of common tasks and issues.
Installation Guide
2.
3. 4.
5.
You can now start the virtual machine. Once the Connection Broker virtual machine boots up, the remote console displays its IP address. You can point a Web browser to this IP address and configure your Connection Broker. See one of the Quick Start manuals for tutorials on configuring your Connection Broker.
4. 5. 6. 7.
In the first page of the Deploy OVF Template wizard, select the extracted Connection Broker OVA-file. Click Next >. Review the OVF Template Details page and click Next >. Follow through the remainder of the Deploy OVF Template wizard to define the location and configuration for the virtual appliance.
4.
Step through the Import Virtual Appliance Wizard to import the Connection Broker OVF-file and finish the installation.
If you move your ESX environment to a new location, you can simply transfer the Connection Broker image to the new host. The time it takes to download a new appliance to the new location is roughly equivalent to the time it takes to transfer the image. If you are not using vCenter Server 2.5, download the Connection Broker for VMware Server and manually import the disks into the VMFS.
Installation Guide
1. Using a secure shell program, such as Putty, SSH, or SecureCRT, log into the ESX console operating system as root. Use the following command to determine which partition is large enough to hold the Connection Broker virtual disks.
vdf h
2.
3.
Look at the Avail column for a partition with at least 8 GB of free disk space. For this example, the /vmfs/volumes/8da76fa4-ddff2b36 partition has sufficient space to hold the imported vmdf files. Make a note of the import path you want to use, as it is used throughout the remainder of this procedure.
4. 5.
Copy the downloaded ZIP-file into an ESX VMFS partition with enough space. Unpack the ZIP-file, where filename is the name of the Connection Broker archive you downloaded:
unzip filename.zip
6.
7.
Import the virtual disks into a non-local VMFS partition. Clustered ESX hosts may require new virtual machines to be visible to the cluster.
vmkfstools -i LeostreamCB5.vmdk destination/leo.vmdk
Where destination is the partition to import the virtual disks into, determined in step 5. This command creates one .vmdk file. ESX uses one file for each virtual disk. 8. 9. Once the disks are imported, log into your Virtual Infrastructure Client to access this ESX host. Select the ESX host to create the new Connection Broker virtual machine on.
10. Select File > New > Virtual Machine. The New Virtual Machine Wizard opens.
11
12. Click Next. 13. Name the virtual machine, for example Leostream CB, as shown in the following figure.
You may place this virtual machine in any of the given Virtual Machine Inventory Locations. 14. Click Next.
12
Installation Guide
15. Select the data store that holds the imported Connection Broker virtual disks.
16. Click Next. 17. Select Linux in the Guest Operating System section. 18. In the same page, select Version Red Hat Enterprise Linux 5 (32-bit), as shown in the following figure.
If Red Hat Enterprise Linux version 5 is not available, use version 4. 19. Click Next.
13
21. Click Next. 22. Allocate at least 512 MB of RAM to the virtual machine, as shown in the following figure. Allocate 1024MB if your Connection Broker is for production use.
14
Installation Guide
24. Create one network connection. Connect this virtual NIC to a virtual switch that can connect to the target virtual machines and virtual centers. Connect the NIC at power on. The Choose Networks page appears as shown in the following figure.
25. Click Next. 26. The Storage Adapter Type should be LSI Logic.
15
29. Click Next. 30. Click Browse and select the leo.vmdk file imported in step 6, as shown in the following figure.
31. Click Next. 32. Select Node SCSI (0:0) for the Virtual Device Node. Do not select the option to make the mode Independent.
16
Installation Guide
33. Click Next. A summary page opens, as shown in the following figure.
34. Click Finish. The Connection Broker now appears in your vCenter Server inventory.
In XenCenter 5.6, use the Import menu, shown in the following figure.
17
c.
5.
In the next page of the Import wizard: a. b. Select the home server for the Connection Broker VM, as shown in the following figure. Click Next >.
18
Installation Guide
6. In the next page of the Import wizard: a. b. Select the storage for the Connection Broker VM, as shown in the following figure. Click Import >. The LeostreamCB VM now appears in your list of VMs in XenCenter.
7.
In the next page, configure the virtual network for the Connection Broker VM. In general, your Connection Broker requires only one network connection. If you are working with blades that are equipped with Teradici PC-over-IP hardware running on a separate network, configure a second network adaptor on your Connection Broker (see Configuring Second Network Adapter for PCoIP). After your network interfaces are configured, click Next >. In the Complete the import page, ensure that the Start VM after import option is selected and click Finish.
8. 9.
If DHCP is not able to obtain a network address for your Connection Broker, you must manually configure the Connection Broker IP address (see Manually Configuring the Connection Broker Address).
19
A new LeostreamCB object appears in the Library Objects list in the center panel. 8. Right click on the LeostreamCB object appears in the Library Objects list and select Deploy, as shown in the following figure.
9.
In the first page of the Deploy Virtual Machine wizard, select a host for the Connection Broker and click Next.
10. In the Select Path page of the wizard, indicate the full path to the virtual machines on the host, and click Next. 11. In the Select Networks page of the New Virtual Machine wizard, select the appropriate item from the Virtual Network drop-down menu and click Next. 12. In the Summary page, check the Start the virtual machine after deploying it on the host option and click Create. VMM displays warning 13206 when creating the Connection Broker VM. This warning results whenever you create a new VM from a VHD-file with a non-Windows operating system, and can be ignored.
20
Installation Guide
2.
3.
7.
If the physical server hosting the Connection Broker virtual machine is connected to an Ethernet segment with a DHCP server, a second IP address for the Bridged Ethernet port is reported. If the Connection Broker cannot obtain a DHCP supplied address, it defaults to 192.168.100.100. If you cannot connect to this IP address, manually change the IP address within the Connection Broker console.
21
2.
Enter Ctrl-C to go to the Leostream administrator login page, shown in the following figure.
3.
Log into the Administrator console. The default username is leo and password is leo. The Leostream administrator menu, shown in the following figure, opens.
4.
22
Installation Guide
5.
Select Edit a device params and hit <Enter>. The Select a Device menu, shown in the following figure, opens.
6. 7.
Select eth0 (eth0). Press <Enter>. The Devernet Configuration menu, shown in the following figure opens.
8. 9.
Scroll down to the Use DHCP option and hit the spacebar to deselect this option. Enter in the network information for your Connection Broker in the Static IP, Netmask, and Default gateway IP edit fields.
10. Select Ok to accept the changes and return to the Select a Device menu. 11. Select Save to return to the Select Action menu. 12. Select Save&Quit. 13. When prompted to restart the Connection Broker, select OK. This is only a reminder to restart your Connection Broker. You must manually restart your Connection Broker.
23
Installation Guide
To the network, the Connection Broker virtual appliance appears like any other physical appliance. Depending on your installation, different ports are available to the Connection Broker: If you install an SSL certificate into the Connection Broker, port 443 is enabled, and port 80 redirects to port 443. If you enable SSH access (using the Console access to the virtual appliance), port 22 is open. If you enable SLP discovery for Teradici PC-over-IP equipped blades, port 50,000 is open.
The only network facing services that are accessible are Apache and SSH, assuming SSH is enabled. For Sun Sun Ray clients you need a range of network addresses open for the communication between the SRSS server and the DTU clients, See the blog post Opening ports in a firewall for Sun Ray client access for more information. The following figure provides a schematic of Connection Broker ports and their usage.
Leostream Connection Broker Architecture Diagram (Connections are initiated in direction of arrows)
Key: * = Optional component ** = User configurable
Authentication Server Database SNMP Server 162 Syslog Server 1433/1434** 389/636 80** 8080** 514 80/443** Citrix XenDesktop 80/443** Leostream Connect Thin Clients Web browsers 80/443** Leostream Connection Broker 8730** 80/443** 8443 8080** 50,000 80/443** 50,000 Leostream Agent* 50,000 PC-overIP* Remote Desktop Port for USB 20020 Red Hat Enterprise Virtualization Manager Leostream Connect 3389, etc SPICE RDP ICA/HDX RGS VNC NX Exceed Etc... Leostream Agent 8080** 443 Microsoft Terminal Server Leostream Agent Vmware ESX/ ESXi/vSphere and vCenter Server 443
Teradici PC-over-IP*
25
You can download the Leostream Agent and manuals from: http://www.leostream.com/resources/downloads.php. If you uninstalled a previous version of the Leostream Agent, but did not restart the desktop when prompted by the uninstaller, you will not be able to successfully install a new Leostream Agent. If you are unsure if a desktop restart is required, perform the Leostream Agent installation. The installer will indicate if you need to restart the desktop. 26
Installation Guide
To install the Leostream Agent: 1. Run the LeostreamAgentSetupXXXX.exe executable file, where XXXX is the Leostream Agent version number. Appendix A lists options available when running the installation from the command line. The License Agreement page opens, as shown in the following figure.
2.
On the License Agreement page: 1. 2. 3. Read the license agreement. If you accept the license agreement terms, select the I accept the agreement option. Click Next >.
3.
On the next page, enter or browse for the directory to install the Leostream Agent into, as shown in the following figure.
4. 5.
Click Next >. On the page that appears, shown in the following figure, select any additional tasks to run during the installation.
27
If you are installing the Leostream Agent on a Citrix Desktop Studio, select only the Install
Microsoft VC++ runtime task. Do not select any other Leostream Agent installation tasks
Install end-user experience extension: Select this option if you plan to use Leostream display plans, Leostream printer plans, Leostream registry plans, or the disconnect or idle-time functions in Leostream release plans. Extended display support allows end users to split their display across the different monitors. See the Leostream Multiple Display Support document for more information. o Enable multi-display support for Windows logon: Select this option to install the Leostream GINA. This option appears only when installing the Leostream Agent on a Windows operating system that uses the Windows GINA, such as Windows XP. The GINA handles dialog positioning for native Windows logon dialogs when the users session is spanned across multiple displays. The GINA also is required when using the idle-time features in release plans. o Enable multi-display support for 32-bit applications: When installing on a 64-bit operating system, select this task if the user runs legacy 32-bit applications. If this task is not selected, the Leostream Agent cannot successfully position windows associated with 32-bit applications.
Enable USB over IP (may require reboot): Select this task if you want USB devices attached to the client desktop to appear within this remote desktop. Do not select this task if you have another USB over IP solution installed, for example, the HP RGS solution. If two USB solutions are installed side-by-side, you may not be able to predict which solution is managing the USB devices.
Enable single sign-on for PCoIP VNC: Select this task to enable single sign-on for users connecting to their desktops using VNC or PC-over-IP display protocols. The Connection Broker provides native single sign-on for all other display protocols. Do not select this task if your users connect using any protocol other than VNC or PC-over-IP. You can use this task to provide single sign-on for SPICE connections, if you do not want to use the native SPICE single sign-on capabilities. On Windows 7 and Vista, the single sign-on task installs the Leostream Credential Provider. When the Leostream Agent service starts, the Leostream Agent disables the Ctrl-Alt-Del key combination. The Ctrl-Alt-Del function is restored when the Leostream Agent service stops. On older Windows operating systems, this task installs the Leostream GINA.
Install Microsoft VC++ runtime: Select this task if you do not have the latest Microsoft Visual C++ run-time libraries installed on the desktop.
28
Installation Guide
Uncheck this option only if the desktop already has an installed Microsoft VC++ runtime environment. The Leostream Agent requires that MSVC runtime be installed in order to create an SSL certificate and key to use when communicating with the Connection Broker. If you uncheck this option, and do not have an MSVC runtime environment installed, the Leostream Agent produces SSL errors. To resolve this issue, reinstall the Leostream Agent with the Install Microsoft VC++ runtime option selected. 6. 7. Click Next >. Review the installation setup in the next page, shown in the following figure, then click Install.
If the desktop does not prompt for a restart, the installation is complete. If you installed the end-user experience or USB over IP tasks, you may be prompted to restart your machine. In this case, the installation is complete only after you restart the desktop. If you do not restart the desktop when prompted, you may encounter difficulties when subsequently upgrading the Leostream Agent. The installer automatically starts the Leostream Agent when the installation completes. To turn off the Leostream Agent, or configure it to point to a particular Connection Broker IP address, open the Leostream Agent Control Panel dialog. For a 32-bit system, you can find the Leostream Agent icon in the machines Control Panel, as shown in the following figure:
For a 64-bit system, the Leostream Agent icon is located in the x86 Control Panel. To modify the Leostream Agent options, you must be logged into the desktop with administrator privileges,
29
30
Installation Guide
4. 5.
Enter the Connection Broker IP address and port number in the appropriate edit fields. Click Apply to accept the address and leave the Leostream Agent dialog open, or OK to accept the address and close the dialog.
You can click Test to check if the address you entered is valid. A dialog opens indicating if the Leostream Agent can contact the Connection Broker at the specified address.
If you reboot the SCVMM server, the Leostream Agent may not automatically restart. You can manually restart the Leostream Agent using the Leostream Agent Control Panel Options dialog.
31
32
Installation Guide
3. Right-click on the Leostream Windows Agent service, and select Properties. The following dialog opens.
4. 5. 6.
Select the This account option. Enter the account name and associated password. Click OK.
You cannot use the graphical installer if the remote desktop does not have a graphical user interface or the X11 DISPLAY environment variable is not correctly set. In these cases, install the Leostream Agent at the console (see Installing at the Console). Also, if you are connected to the remote desktop using a display protocol such as NoMachine NX, you cannot run the graphical installer.
33
The Leostream Agent provides these header files for kernel versions 2.6.15 to 2.6.34. More recent kernel versions include these files in the kernel source. USB redirection is not supported for kernel version higher than 3.6.0 The Leostream Agent uses files in the kernel source directory to execute the make command that builds the drivers. These files are typically located in /usr/src/kernels. Some operating systems provide the necessary directories. If your operating system does not provide the appropriate kernel files, you must download and install them, using the appropriate distribute method for your operating system. For example, use the following commands for desktops running CentOS. yum install kernel-devel yum install gcc You must install the kernel source that exactly matches your kernel version. To determine which kernel version your Linux desktop is running, execute the following command. uname r
Where x.x.x.x is the version number at the end of the installer file name. Run this command using sudo if you are not logged in with the root account. If the desktop has multiple JRE versions, enter the full path to the correct Java installation. The installer Welcome page, shown in the following figure, opens.
34
Installation Guide
To run the installer with debugging trace turned on, include the following text in the command line:
-DTRACE=true
For example:
java DTRACE=true -jar LeostreamAgentJava-x.x.x.x.jar
3. 4.
Click Next in the Welcome page. The License Agreement page opens, as shown in the following figure.
In this page: a. Read the license agreement. b. If you accept the license agreement terms, select the I accept the terms of the license agreement option. c. Click Next.
5. In the Additional Tasks page, shown in the following figure, select the appropriate tasks to complete
during installation.
35
a. You must select the Leostream Agent task, which installs the core Leostream Agent
components.
b. To use Leostream to manage USB devices, select the Enable USB over IP task. 6. In the Installation Directory page, shown in the following figure, enter or browse for the location to install
the Leostream Agent. If you are installing the Leostream Agent into a Sun Ray environment, ensure that the Leostream Agent installation directory is different from the installation directory used for Leostream Connect.
7. Click Next. 8. If necessary, the installer warns you that it will create or over write the installation directory. Click OK to
accept the warning to move on with the installation, or click Cancel to enter a different directory. 9. In the Agent Configuration page, specify the Connection Broker address to use for this Leostream Agent. If you have a DNS SRV record for your Connection Broker, leave the Connection Broker Address field empty and select the Enable auto-detection of broker using DNS option. To enter a static Connection Broker address, clear the selection in the Enable auto-detection of broker using DNS option and enter the address into the Connection Broker Address field.
36
Installation Guide
You can specify or change the Connection Broker address associated with this Leostream Agent at any time, by modifying the leostreamagent.conf file. See the Leostream Agent Administrators Guide for information on using this file. 10. Click Next. 11. If you selected the Enable USB over IP task, specify the full path to the Linux kernel build directory, as shown in the following figure.
The installer validates this directory by looking for the module.symvers file. If this file does not exist in the specified directory, you cannot continue with the installation. 12. Click Next. 13. The Ready to Install page provides a summary of the settings you provided to the installer. Click Next to begin the installation. 14. The installer displays the progress in the Installing Leostream Agent page. If you are installed the USBover-IP task, the installer appears to pause halfway through the installation. At this point, the installer is building the Linux kernel object for the USB drivers, which may take a couple minutes. When the installation completes, click Next. 15. In the Installation Finished window, click Generate an automatic installation script if you want to generate an XML-file that can be used to perform silent installations of the Leostream Agent on other desktops.
37
This message can be ignored. If you installed the USB drivers, check that the daemon is live by running the following command: cat /proc/modules |grep lsusbd If the daemon is not live, the remote desktop cannot accept USB devices. Contact [email protected] for a resolution.
Where:
java is the full path to the java binary JRE x.x.x.0 is the version number at the end of the installer file name auto-install-xml-path is the full path to your XML-file
2.
Where x.x.x.x is the version number at the end of the installer file name. Run this command using sudo if you are not logged in with the root account. If the desktop has multiple JRE versions, enter the full path to the correct Java installation. The following instructions appear at the console.
3. 4.
Enter 1 to continue the installation. The Leostream End User License Agreement displays. Read through the Leostream End User License Agreement.
38
Installation Guide
a. b. 5. 6. 7. 8. Press <Enter> to go to the next page of the EULA Press X to exit the installation
At the end of the EULA, enter 1 to accept the license agreement and continue the installation. Enter the target path for the installation, typically /opt/leostreamagent. Press 1 to accept the target installation directory. The installer attempts to automatically discover the path to the Linux kernel build, which is required to compile the USB drivers. Currently, you cannot disable the USB redirection feature when running the installer from the console. Enter 1 to continue the installation.
9.
10. The installer next asks if you want to discover the Connection Broker address, as shown in the following figure.
a.
Enter 1 to instruct the Leostream Agent to look for a Connection Broker DNS SRV record, in order to discover the Connection Broker address. Enter 0 to manually configure the Connection Broker address.
b.
11. Enter the Connection Broker address. If you entered 1 in step 10, enter the Connection Broker address to use in the event a DNS SRV record cannot be found. 12. Press 1 to accept the Connection Broker address and complete the installation
39
40
Installation Guide
You can download Leostream Connect and manuals from: http://www.leostream.com/resources/downloads.php. To install Leostream Connect, log into the client device with an account that has Administrator privileges for the desktop. Then, follow through the installation, as follows: 1. Run the LeostreamConnectSetupXXXX.exe executable file, where XXXX is the Leostream Connect version number. Appendix A lists options available when running the installation from the command line. The Encoding the Connection Broker IP Address section shows how to change the name of the executable to encode your Connection Broker IP address into the installation. Select the language to use during installation from the drop-down menu on the Select Setup Language dialog that opens. Click OK. On the page that appears, shown in the following figure: Read the license agreement. If you accept the license agreement terms, select the I accept the agreement option. Click Next >.
2.
3. 4.
41
6. 7.
Click Next >. On the page that appears, shown in the following figure, select any additional tasks to run. If you do not have administrator privileges on the desktop, you cannot select any additional tasks.
Enable USB over IP: Select this task if you want USB devices attached to this client desktop to appear within the connected remote desktop. You must also install the Leostream Agent on the remote desktop. Ensure that the USB over IP task is selected when installing the Leostream Agent. The installer installs either 32-bit or 64-bit drivers depending on the type of operating system that you are running. If you install the files for USB over IP support, you may have to reboot your Windows operating system. Do not install this option if you have another USB-over-IP solution installed, for example, the HP RGS solution. If two USB solutions are installed side-by-side, you may not be able to predict which solution is managing the USB devices.
Enable Run as Shell mode: Select this option to install Leostream Connect in shell mode. In shell mode, Leostream Connect replaces the Winlogon shell command, which is normally the Windows Explorer (explore.exe). See Running Leostream Connect for Windows in Shell Mode in the Leostream Connect Administrators Guide and End Users Manual for for more information on using, configuring, and removing shell mode support. Enable client-side credential passthrough: Select this option to installs the Leostream GINA or Credential Provider on the client device. Client-side credential passthrough allows Leostream Connect to store the users Windows login credentials, and automatically use those credentials when the user launches Leostream Connect. When client-side credential passthrough is used
42
Installation Guide
with shell mode, it supports the following scenario: when the user logs into the client device, Leostream Connect automatically launches, logs the user into the Connection Broker using the credentials provided at login and, if the user is assigned a single desktop, launches the remote viewer session. Do not install client-side credential passthrough on a client device running a Windows 7 or Windows Server 2008 operating system if that client device connects to Windows 7 or Window Server 2008 remote desktops. The Leostream credential provider is incompatible with the Windows credential provider in this configuration, with the result that RDP connections cannot be established. If the Windows 7 or Windows Server 2008 client device connects only to older versions of the Windows operating system, client-side credential passthrough is supported. Install Leostream Update service: Select this task to instruct Leostream Connect to contact the Connection Broker and automatically install any available Leostream Connect updates. Because the Leostream Update service runs in the system context, the user does not require administrator privileges on the client to upgrade Leostream Connect. Install Microsoft VC++ runtime: Select this task if you do not have the latest Microsoft Visual C++ run-time libraries installed on the desktop. Uncheck this option only if the desktop already has an installed Microsoft VC++ runtime environment. 8. 9. Click Next>. Review the installation setup in the Ready to Install page, and click Install.
10. When the installation completes, you may be given the option of restarting your computer, as shown in the following figure. Select an option to restart now or later.
If you do not restart the desktop when prompted, you may encounter difficulties when subsequently upgrading Leostream Connect.
43
12. Click Finish, and the Leostream Connect icon appears on your desktop and in your Start menu.
3. 4.
5. 6.
Enter the Connection Broker address in the Address edit field. Click Apply to accept the address, or OK to accept the address and close the dialog.
You can click Test to check if the Connection Broker address you entered is valid. A dialog opens, indicating if the Leostream Connect client can contact the Connection Broker at the specified address.
44
Installation Guide
You cannot use JRE version 1.6.12 if you enable SSL on Leostream Connect. Attempting to use JRE version 1.6.12 with SSL results in Unconnected sockets not implemented errors. If you require SSL communications, upgrade to JRE version 1.6.24. Leostream Connect is packaged as an installer that runs on the following operating systems. Apple Mac CentOS Debian Fedora Novell SUSE Linux Enterprise Red Hat Enterprise Linux Solaris Ubuntu
For information on installing Leostream Connect onto an HP gt7725 thin client, see the How do I install Leostream Connect on an HP gt7725 Thin Client? article on the Leostream Knowledge Center. You cannot perform a network install of the Java version of Leostream Connect.
Leostream Connect provides these header files for kernel versions 2.6.15 through 2.6.34. Higher kernel versions include these header files in the kernel source. USB redirection is not supported for kernel versions higher than 3.6.0. Leostream Connect uses files in the kernel source directory to execute the make command that builds the drivers. These files are typically located in /usr/src/kernels. Some operating systems provide the necessary directories. If your operating system does not provide the appropriate kernel files, you must download and install them, using the appropriate distribute method for your operating system. For example, use the following commands for desktops running CentOS. yum install kernel-devel yum install gcc 45
Installation Instructions
If you plan to install the Leostream USB over IP feature, you must install Leostream Connect as root. To install Leostream Connect: 1. From the directory that contains the installer, issue the following command:
java -jar LeostreamConnectJava-x.x.x.x.jar
Where x.x.x.x is the version number at the end of the installer file name. If the desktop has multiple JRE versions, enter the full path to the correct Java installation. The installer Welcome page, shown in the following figure, opens.
To run the installer with debugging trace turned on, include the following text in the command line:
-DTRACE=true
For example:
java DTRACE=true -jar LeostreamConnectJava-x.x.x.x.jar
2.
Click Next.
46
Installation Guide
3. The License Agreement page opens, as shown in the following figure.
In this page: a. b. Read the license agreement. If you accept the license agreement terms, select the I accept the terms of the license agreement option. Click Next.
c. 4.
In the Additional Tasks page, shown in the following figure, select the appropriate tasks to complete during installation. By default, you must install the Leostream Connect for Java task.
a.
If you are using Leostream to redirect USB devices from the client to the remote desktop, select the USB over IP integration option. This option is not available when installing into a Sun Ray environment. If you are installing Leostream Connect into an Oracle Secure Global Desktop environment, select the Oracle Secure Global Desktop task. If you are installing Leostream Connect into a Sun Ray environment, select the Sun Ray Agent task. The installer automatically uninstalls any previous instance of the Leostream Sun Ray Session (leostreamd), if it was previously installed.
b.
c.
47
In the Installation Directory page, enter or browse for the location to install Leostream Connect. If you are installing Leostream Connect into a Sun Ray environment and previously installed the Leostream Agent, ensure that Leostream Connect installs into a different directory than Leostream Agent.
6. 7.
Click Next. If necessary, the installer warns you that it will create or over write the installation directory. Click OK to accept the warning and move on with the installation, or Cancel to enter a different directory. In the Configuration page, specify the Connection Broker address to use with Leostream Connect. If you have a DNS SRV record for your Connection Broker, leave the Connection Broker Address field empty and select the Enable auto-detection of broker using DNS option. To enter a static Connection Broker address, clear the selection in the Enable auto-detection of broker using DNS option and enter the address into the Connection Broker Address field.
8.
You can specify or change the Connection Broker address associated with Leostream Connect at any time, by modifying the lc.conf file. See the Leostream Connect Administrators Guide and End Users Manual for information on using this file. 9. Click Next.
48
Installation Guide
10. If you selected the USB over IP integration task, specify the full path to the Linux kernel build directory, as shown in the following figure.
The installer validates this directory by looking for the module.symvers file. If this file does not exist in the specified directory, you cannot continue with the installation. 11. Click Next. 12. The Ready to Install page, shown in the following figure, provides a summary of the settings you set in the installer. Click Next to begin the installation.
13. The installer displays the progress of the installation. If you are installing the USB over IP feature, the installer appears to pause halfway through the installation. At this point, the installer is building the drivers necessary for USB support, which may take a couple minutes. After the installation completes, click Next. 14. In the Installation Finished window, click Generate an automatic installation script if you want to generate an XML-file that can be used to perform silent installations of Leostream Connect on other clients. 15. Click Done to exit the installer. If you installed the USB drivers, check that the daemon is live by running the following command: cat /proc/modules |grep lsusbd
49
User-Specific Files
Leostream Connect creates a .leostream directory in the users home directory. This directory has the following purposes. When Leostream Connect runs, it creates a .lock file in the .leostream directory to prevent simultaneously running multiple instances of Leostream Connect. If no log file or directory was specified for Leostream Connect, or Leostream Connect cannot write logs to the specified file and/or directory, then Leostream Connect creates an lc.log file in the user's .leostream folder to keep track of errors/debugging information. If the user running Leostream Connect cannot write to the lc.conf file found in the installation directory, or cannot write to the lc.conf file in the directory specified when running Leostream Connect, then Leostream Connect creates an lc.conf file in the user's .leostream folder.
SGD Files
/opt/tarantella/var/serverresources/expect/leo_unix.exp If you ran the Sun Secure Global Desktop task, Unix expect script for launching Leostream Connect /opt/tarantella/var/serverresources/expect/leo_procs.exp - If you ran the Sun Secure Global Desktop task, modified procedure definition script for SGD /opt/tarantella/var/serverresources/expect/leo_vars.exp Applies when running the Sun Secure Global Desktop task
50
Installation Guide
Where:
java is the full path to the java binary JRE x.x.x.0 is the version number at the end of the installer file name auto-install-xml-path is the full path to your XML-file
51
3.
4.
52
Installation Guide
1.
Download the Leostream Connect installation file from the Leostream Downloads & Documentation Web site. Run the installer, using the following command:
java -jar LeostreamConnectJava-x.x.x.x.jar
2.
Where x.x.x.x is the version number at the end of the installer file name. 3. Step through the installer as instructed in the Leostream Installation Guide. When you reach the page for Additional Tasks, ensure that you select the SunGlobalDesktop option, as shown in the following figure.
4.
Finish the installation. After you install Leostream Connect, manually configure your SGD server, as described in the following section.
53
3.
In the Create a New Object window: a. b. c. Enter LeostreamConnectJava (or your name of choice) in the Name edit field Select X Application Click Create
The Create a New Object window closes and the new application appears in the All Objects Under Applications list. 4. Click on the LeostreamConnectJava link in the All Objects Under Applications list to edit the application. In the General tab, shown in the following figure, click on the Edit button to modify the icon displayed to the end-user.
5.
6.
Click on the Launch tab and enter the following information: a. In Application Command enter: /opt/tarantella/bin/jdk.i3li_1.6.0_13/jre/bin/java The jdk.i3li_1.6.0_13 portion of the path may differ in your installation. Use the JDK version number associated with the version found on your SGD server b. In Arguments for Command enter the following command, as one line:
-DLeostreamLogDir=/opt/leostream/logs -DLeostreamConfFile=/opt/leostream -jar /opt/leostream/LeostreamConnect.jar
Where the directory /opt/leostream may be different if you installed Leostream Connect in a different directory in your Sun Secure Global Desktop server. The directory used to store the logs must be writeable by all users. You can omit the LeostreamLogDir option. In this case, the log files are stored in the .leostream directory for every user that logs into the SGD server. c. d. e. Select ssh for the Connection Method. Enter X into the Ssh Arguments field. In Login Script, replace the default with leo_unix.exp.
54
Installation Guide
f. g. h. Check the Enabled checkbox associated with Keep Launch Connection Open. In the Session Termination drop-down menu, select No Visible Windows. Click Save. The following figure shows the configured Launch tab.
7.
Click on the Presentation tab and enter the following information: a. b. c. In the Window Type drop-down menu, select Kiosk. Check Enable Kiosk Mode Escape. In the Window Manager edit field, enter the path to the Window Manager to use for this application, for example: /usr/bin/gnome-wm d. Select Custom Color for the Window Color, and enter in your color choice. Leostream recommends entering white or blue. In the Color Depth drop-down menu, select 16-bit - Thousands of colors. Click Save. The configured Presentation tab appears as shown in the following figure.
e. f.
55
8.
Click on the Client Device tab and enter the following information: a. Check the Sent to the Remote Session checkbox in the Window Management Keys section. This checkbox is disabled if you did not set the Window Type to Kiosk in step 6. Click Save. The following figure shows the configured Client Device tab.
b.
9.
Click on the Jump To Navigation View link above the set of tabs.
10. In the All Objects Under Applications list, click on the Applications link, shown in the following figure. It should have the type Group.
56
Installation Guide
12. In the Editable Members section, click Add. 13. In the Add Application Member window that opens, shown in the following figure: a. b. Check the box before your LeostreamConnect application. Click Add, as shown in the following figure.
57
You must mark the LeostreamConnect application as an editable member to automatically assign Leostream Connect as a usable application for all users.
58
Installation Guide
Where yourdomain.com is your domain. A correctly configured DNS server returns the IP address of one Connection Brokers. If you have multiple Connection Brokers, create multiple _connection_broker SRV records. The DNS server returns the weight and priority of each SRV record. Weight: Allocates connection requests between Connection Brokers in the same cluster. The default value of 100 indicates that the load is evenly spread between all Connection Brokers. Setting the weight higher indicates that a particular Connection Broker handles a greater percentage of requests. Priority: Sets the order in which Connection Brokers are queried. A priority of zero means a Connection Broker (or a cluster of brokers that all have the same priority) would be selected first. A priority of 65535 is the lowest possible priority.
Use priority, in conjunction with dividing Connection Brokers up into geographic regions, to ensure that a user is normally connected to a cluster in their region, but, if this cluster is down, they are connected to the next closest region. To achieve this it is necessary to setup Sites within DNS. A site corresponds to a geographic region, in this case. Manually register a Connection Broker with a Microsoft DNS server, as follows: 1. 2. Open the DNS console and click on the Forward Lookup Zone. Right-click on your domain name in the list on the left-hand side of the window, and select Other New Records from the context menu, as shown in the following figure.
59
4. 5.
Click Create Record. The New Resource Record dialog opens. In the New Resource Record dialog, enter the following settings:
Service: Protocol: Priority: Weight: Port Number: Host offering this service: _connection_broker _tcp 100 (This is a temporary value) 100 (This is a temporary value) 80 (or 443) connectionbroker.domainname.com
Where connectionbroker.domainname.com is your Connection Broker address. Your New Resource Record dialog looks something like the following:
6. 7.
Click OK to save the settings and return to the main DNS console window. To configure additional Connection Broker SRV records, in the Resource Record Type dialog, click Create Record and repeat steps 5 and 6. Otherwise, in the Resource Record Type dialog, click Done. 60
Installation Guide
To view your Connection Broker Service Location records, expand the domain name node in the DNS console and select the _tcp node, as shown in the following figure.
You can check for the DNS SRV records using nslookup. At the nslookup prompt, enter the following two commands:
set querytype=SRV _connection_broker._tcp.domain.name
Where domain.name is your domain name. If the record exists, nslookup returns the priority, weight, port, and SRV hostname. Otherwise, it returns a message indicating the record is not found. You can use DNS A records instead of DNS SRV records. However, the Leostream Agents and Leostream Connect clients will not automatically discover the Connection Broker address in a DNS A record. If using DNS A records, you must manually configure the Connection Broker address in every Leostream Agent and Leostream Connect client. In addition, to have the Connection Broker send the name in the A record instead of the Connection Broker IP address, you must enter the A record name into the Connection Broker VIP field (see Setting Network Configuration and Connection Broker VIP in the Connection Broker Administrators Guide). If the Java version of the Leostream Agent is not detecting the DNS SRV record, ensure that the resolve.conf file on the desktop where the Leostream Agent is installed contains information for the correct domain. If the DNS SRV record exists in a different domain from that specified in the resolve.conf file, the Leostream Agent cannot discover the Connection Broker address.
61
Appendix A
Appendix A: Command Line Options for Leostream Connect and Leostream Agent
The following sections pertain to the Windows version of Leostream Connect and the Leostream Agent.
the option is not selected. Default is 1. Each user can individually over ride the default value.
/LOG="path\filename" - Causes the setup to create a log file in the fixed filename specified as "path\filename". /NOCANCEL - Prevents the user from cancelling the installation by disabling the Cancel button and ignoring clicks on the Close button. /NORUN Prevents the installation wizard from prompting the user to start Leostream Connect at the end of the installation process. When used together with the /VERYSILENT parameters, prevents the installer from running Leostream Connect immediately after the installation completes. /NORESTART - Instructs the installer not to reboot, even if a reboot is necessary. /SILENT, /VERYSILENT - Installs without displaying messages. /SUPPRESSMSGBOXES: Instructs setup to suppress message boxes. This option has an effect only when combined with /SILENT and /VERYSILENT. /LANG=language - Specifies the language to use. When a valid /LANG parameter is used, the Select Language dialog is suppressed. Valid /LANG parameter include: o o o
enUS: English frFR: French deDE: German
The /LANG option does not apply to Leostream Agent installations. The Leostream Agent supports only English. /LOADINF="filename" - Instructs the installer to load the settings from the specified file after having checked the command line. This file can be prepared using the /SAVEINF= command. /SAVEINF="filename" - Instructs the installer to save installation settings to the specified file. You must use quotes if the filename contains spaces.
62
Installation Guide
/RESTARTEXITCODE=exit code - Specifies the custom exit code to return when a restart is needed. /DIR="x:\dirname - Overrides the default directory name displayed on the Select Destination Location wizard page. A fully qualified pathname must be specified. /TASKS="comma separated list of tasks names" - Specifies a list of installation tasks. When this option is used, the installer selects only the specified tasks; the remaining tasks are not selected. The Leostream Connect installer supports the following tasks. o o o o o shell singlesignon updateservice usb msvcrt: Include this task if you do not want to install the MSVC runtime files. This task applies to the Leostream Agent, only.
The Leostream Agent installer supports the following tasks. desktop: Installs the end-user experience extension desktop\32: Enables multi-display support for 32-bit applications running on a 64-bit platform. Use this task only when installing the Leostream Agent on a desktop running a 64bit operating system. desktop\gina: Installs the Leostream GINA for managing the Windows logon dialogs over multiple displays. Use this task only when installing the Leostream Agent on a desktop running Windows XP or earlier. This option defaults to on if you enable the desktop task. Set this option to false if you need to install the end-user experience extension but do not want to install the Leostream GINA. usb singlesignon
For example, use the following option to install Leostream Connect with the USB and Single Sign-On tasks: /TASKS=usb,singlesignon Or, use the following option to install the Leostream Agent with the end-user experience extension task selected, but without installing the Leostream GINA. /TASKS=desktop,!desktop\gina Use the /MERGETASKS parameter to keep the default set of tasks selected, while selecting or deselecting other tasks /MERGETASKS="comma separated list of tasks names" - Changes the default set of installation tasks. When this option is used, specified tasks are selected or deselect from the default set of installation tasks. To deselect a task, prefix the task name with an exclamation point (!). For example, the following option turns off the default USB task for Leostream Connect, and turns on the desktop task. /MERGETASKS=!usb,desktop
63
Appendix A
You can call the uninstaller with the following options, listed options in any order. /SILENT, /VERYSILENT: When specified, the uninstaller will not prompt for startup confirmation or display a message when the un-installation is complete. The uninstaller automatically deletes shared files that are no longer in use, without prompting. However, the uninstaller continues to display any critical error messages. When /VERYSILENT is specified, the uninstaller does not display a progress window. If a restart is necessary and the /VERYSILENT option is used without the /NORESTART option, the uninstaller reboots without asking. /SUPPRESSMSGBOXES: Instructs the uninstaller to suppress message boxes. This option applies only when combined with the /SILENT or /VERYSILENT options. /LOG="filename": When specified with an optional filename, allows you to specify a fixed path and filename to use for the log file. If a file with the specified name already exists, the uninstaller over-writes the file. If the file cannot be created, the uninstaller aborts with an error message. When used without a filename, writes a log to the default directory. /NORESTART: Instructs the uninstaller not to reboot, even if a reboot is necessary.
or
LeostreamAgentSetup_xxx.xx.xxx.xxx.exe or LeostreamAgentSetup_xxx.xx.xxx.xxx_80.exe where xxx.xx.xxx.xxx is your Connection Broker IP address and 80 is the Connection Broker
port.
o o
Setup_cb.your-company.com.exe Setup_cb.your-company.com_80.exe
Where cb.your-company.com is the DNS name for your Connection Broker The address entered in the executable is ignored if you have configured a DNS SRV record for the Connection Broker.
64