Teradici APEX 2800 TER1109003, Teradici APEX 2800 Server Offload card by, APEX 2800 Administrator's Manual
Teradici APEX 2800 Server Offload Card Administrator's Guide
TER1109003 Issue 3
1
Teradici APEX™ 2 800
Server Offload Car d
Administrator's Guide
TER1109003
Issue 3
Teradici APEX 2800 Server Offload Card Administrator's Guide
TER1109003 Issue 3
2
Teradici Corporation
#101-4621 Canada Way, Burnaby, BC V5G 4X8 Canada
p +1 604 451 5800 f +1 604 451 5818
www.teradici.com
The information contained in this document represents the current view of Teradici Corporation as of the date of
publication. Because Teradici must respond to changing market conditions, it should not be interpreted to be a
commitment on the part of Teradici, and Teradici cannot guarantee the accuracy of any information presented after
the date of publication.
This document is for informational purposes only. TERADICI MAKES NO WARRANTIES, EXPRESS, IMPLIED OR
STATUTORY, AS TO THE INFORMATION IN THIS DOCUMENT.
Complying with all applicable copyright laws is the responsibility of the user. Without limiting the rights under
copyright, no part of this document may be reproduced, stored in or introduced into a retrieval system, or transmitted
in any form or by any means (electronic, mechanical, photocopying, recording, or otherwise), or for any purpose,
without the express written permission of Teradici Corporation.
Teradici may have patents, patent applications, trademarks, copyrights, or other int ellectual property rights covering
subject matter in this document. Except as expressly provided in any written license agreement from Teradici, the
furnishing of this document does not give you any license to these patents, trademarks, copyrights, or other
intellectual property. Visit www.teradici.com/teradici/pat
© 2012 Teradici Corporation. All rights reserved.
Teradici, PC-over-IP, and PCoIP are registered trademarks of Teradici Corporation.
The names of actual companies and products mentioned herein may be the trademarks of their respective owners.
for more information.
Teradici APEX 2800 Server Offload Card Administrator's Guide
TER1109003 Issue 3
3
Revision History
Version
Date
Description
3
Sep 25, 2012
2
Feb 24, 2012
1
Jan 27, 2012
Initial release
• Replaced screen shots where new values are now seen
• Updated information as related to new features in the latest
• Updated the document for ESXi 5.0.
• Added Lenovo RD240 to list of tested VDI Server Platforms
• Added information about disabling the ESXi interrupt remapping to
• Removed the information about the PCoIP Imaging Caching Size
• Added hyperlink to Patents webpage from the Copyrights page
software release
the Troubleshooting sectio n
Teradici APEX 2800 Server Offload Card Administrator's Guide
TER1109003 Issue 3
4
Contents
Table of Figures ............................................................................................................................... 6
Definitions ........................................................................................................................................ 7
1 Introduction ......................................................................................................................... 9
Benefits ............................................................................................................................................. 9
System Requirements .................................................................................................................... 10
Virtual Desktop Server Platform...................................................................................................... 10
Client .............................................................................................................................................. 10
Network .......................................................................................................................................... 10
2 Installation and Configuration ........................................................................................... 11
Before you Begin ............................................................................................................................ 11
Installing the APEX 2800 Card ....................................................................................................... 11
Installing the ESXi Driver Package ................................................................................................. 12
Installing the Virtual Machine Driver ............................................................................................... 14
Verifying the Policy Settings ........................................................................................................... 15
Installing Additional APEX 2800 Cards ........................................................................................... 16
3 Administration ................................................................................................................... 17
Setting Priority Levels ..................................................................................................................... 17
Assigning the Priority to the Global Pool ......................................................................................... 17
Assigning the Priority to a Desktop Pool ......................................................................................... 18
Assigning the Priority to an Individual End User ............................................................................. 19
Session Variables ........................................................................................................................... 20
APEX 2800 Command Line Interface (CLI) .................................................................................... 20
Command Structure ........................................................................................................................ 20
Commands ..................................................................................................................................... 20
Enabling/Disabling the APEX 2800 Card ........................................................................................ 22
Working with the Property Settings ................................................................................................. 22
Displaying General Device and Driver Information ......................................................................... 23
Setting the Log Level for the APEX 2800 ESXi Driver and Firmware ............................................. 23
Displaying the APEX 2800 Properties for a VM .............................................................................. 24
Monitoring the VDI Server Load ..................................................................................................... 25
ESXtop PCPU ................................................................................................................................ 25
vCenter Performance Tab .............................................................................................................. 26
Viewing the Status of the APEX 2800 Card .................................................................................... 26
Viewing the Usage and Monitoring Status of the Virtual Machines ................................................. 28
Legend: ........................................................................................................................................... 28
Viewing and Setting the Maximum Display Resolution ................................................................... 29
4 Troubleshooting ................................................................................................................ 31
Teradici APEX 2800 Server Offload Card Administrator's Guide
TER1109003 Issue 3
5
Enabling a Syslog Server ............................................................................................................... 31
Determining the APEX 2800 Card Status ....................................................................................... 32
From an Administrative Console ..................................................................................................... 32
At the User's Desk .......................................................................................................................... 32
Identifying a Failed Card ................................................................................................................. 32
Disabling the ESXi Interrupt Remapping (Communication with PCIe Devices Stops) .................... 33
5 Appendix A: VDI Server Platforms Tested ....................................................................... 34
Teradici APEX 2800 Server Offload Card Administrator's Guide
TER1109003 Issue 3
6
Table of Figures
Figure 1-1: APEX 2800 firmware 2.0 maximum number of display offloads at different resolutions. ................. 9
Figure 2-1: VMware vShpere Client configuration for the Apex 2800 install ..................................................... 11
Figure 2-2: WinSCP Login Window .................................................................................................................... 12
Figure 2-3: WinSCP browser window showing placement of the zip file to the tmp folder. ............................... 13
Figure 2-4: Zip command format for ESXi 4.1. ................................................................................................... 13
Figure 2-5: Successful zip command results for ESXi 4.1 with the reboot command. ........................................ 14
Figure 2-6: Virtua l M a c hine Desktop .................................................................................................................. 14
Figure 2-7: Pcoip-ctrl output with the -V option .................................................................................................. 15
Figure 2-8: Vie w Connection Server Global Po lic ie s configuration window. ..................................................... 16
Figure 3-1: Vie w Connection Server Global Po lic ie s priority settings. ............................................................... 17
Figure 3-2: VCS local inventory pools policies. .................................................................................................. 18
Figure 3-3: VCS lo c a l inventory pools Policies Prior ity setting. ......................................................................... 19
Figure 3-4: VCS Glo bal Policies individual priority options. .............................................................................. 19
Figure 3-5: Esxtop command output .................................................................................................................... 25
Figure 3-6: vCenter Performance Tab .................................................................................................................. 26
Figure 3-7: Pcoip-ctrl output with the -I option, ESXi 5.0 and driver 1.x ............................................................ 27
Figure 3-8: Pcoip-ctrl output with the -I option, ESXi 5.0 and driver 2.x ............................................................ 27
Figure 3-9: Pcoip-ctrl command output with the -V option ................................................................................. 28
Figure 3-10: Pcoip-ctrl output with the --get-max-resolution option ................................................................... 29
Figure 4-1: ESXi Host Advanced Settings (Enabling a Syslog Server ) .............................................................. 31
Figure 4-2: APEX 2800 desktop offload indicator. .............................................................................................. 32
Teradici APEX 2800 Server Offload Card Administrator's Guide
TER1109003 Issue 3
7
Definitions
Definition
AWI
Administrative Web Interface
CLI
Command Line Interface
CPU
Central Processing Unit
ECC
Error Correction Code
FPS
Frames Per Second
GPU
Graphics Processing Unit
GUI
Graphical User Interface presented by the client On Screen
Display when not operating in a PC-over-IP session
MC
Management Console
Mpps
Mega pixels per second
OS
Operating System
OSD
On Screen Display
PCIe
Peripheral Component Interconnect Express
PC-over-IP®
Personal Computer over Internet Protocol
PCoIP®
Personal Computer over Internet Protocol (PC-over-IP)
PCoIP Zero Client
PCoIP Host
Host side of PC-over-IP syste m
QoS
Quality of Service
vCPU
Virtual CPU within a virtual machine
VSC
View Connection Server
VDI
Virtual Desktop Infrastructure
VIB
VMware vSphere Installation Bundle
VM
Virtual Machine
VPN
Virtual Private Network
Description
Desktop side of PC-over-IP system (that is, client). For example,
PCoIP zero client or PCoIP integrated display
Teradici APEX 2800 Server Offload Card Administrator's Guide
TER1109003 Issue 3
8
Definition
Description
Zero Client
See PCoIP zero client
Teradici APEX 2800 Server Offload Card Administrator's Guide
TER1109003 Issue 3
9
1 Introduction
The Teradici APEX™ 2800 server offload card provides hardware-accelerated PCoIP® image
encoding for server-hosted VMwa re View v irtual desk tops (of ten re ferred to as Virtual
Desktop Infrastructure or VDI). Available as a standard PCI Express (PCIe) expansion card
for industry-standard servers, the APEX 2800 card monitors the graphical demands of VDI
displays and automatically offloads the PCoIP encoding tasks of the most demanding
displays from the vCPUs to the APEX 2800 card.
As demands change, the card seamlessly and automatically shifts between hardware
encoding on the APEX 2800 card and software encoding on the virtual desktops' vCPU(s).
This lets the APEX 2800 card support a large number of virtual desktops while providing
optimal use of resources. The APEX 2800 card offloads up to 100 displays depending on the
maximum display resolution set up in the environment, and is described in the table below.
Note: Each virtual machine display is monitored separately. The number of displays
offloaded may vary based on screen resolution and display activity.
Figure 1-1: APEX 2800 firmware 2.0 maximum nu mber of display offloads at different
resolutions.
1.1 Benefits
• Protected end-user experience from pixel-encoding CPU peaks
• Increased VDI consolidation ratios per server
• Full integration into VMware View and managed through View Administrator
• Simple install and setup
Teradici APEX 2800 Server Offload Card Administrator's Guide
TER1109003 Issue 3
10
For more details, see http://www.teradici.com/pcoip/pcoip-products/pcoip-server-offload-
card.php.
1.2 System Requirements
The APEX 2800 card can be used in virtual desktop environments that meet the following
system requirements.
1.2.1 Virtual Desktop Server Platform
• Server platform with an available PCI Express (PCIe) x8, full height, half length
compatible card slot
• ESXi 4.1 Update 1 build 348481, 4.1 Update 2 build 502767, or ESXi 5.0, ESXi 5.0.0 U1
• VMware View 4.6 or View 5.0
• Supported virtual machine operating systems:
o Windows 7 32-bit/64-bit
o Windows Vista 32-bit/64-bit
o Windows XP
• Maximum of two APEX 2800 cards per server with up to 200 displays offloaded.
To get the latest driv e rs , re g is ter at http://techsupport.teradici.com
Knowledge Base article 650.
and subscribe to
1.2.2 Client
• PCoIP zero clients with firmware 3.5 or later
• VMware View 4.6 clients or later
• Displays with a resolution of 2560 x 1600 or less (Displays with a higher resolution
settings may become available in future software releases)
1.2.3 Network
The PCoIP protocol provides a real-time delivery of a rich user desktop experience. To
ensure a responsive desktop, the PCoIP protocol must be deployed across a properly
architected virtual desktop network infrastructure that meets bandwidth, QoS, latency and
packet-loss requirements. For more details, see the PCoIP Protocol Virtual Desktop Network
Design Checklist TER1105004 document at http://techsupport.teradici.com
.
Teradici APEX 2800 Server Offload Card Administrator's Guide
TER1109003 Issue 3
11
2 Installation and Configuration
This section steps you through the process to set up and configure the APEX 2800 card.
Warning:
Power down and disconnect devices from AC power before handling them. Failure to do this
can result in personal injury or equipment damage. Some circuitry on the server PC can
continue to operate even though the front panel power switch is off.
Ensure you observe correct anti-static handling to avoid potential ESD damage to the card.
2.1 Before you Begin
1. Get the latest drivers by registering at the Teradici support website
http://techsupport.teradici.com
2. Download the APEX 2800 drivers to a convenient PC.
2.2 Installing the APEX 2800 Card
1. Make sure all virtual machines hosted by the server are powered down or migrated to
another server.
2. In the VMware vSphere client, right-click on the ESXi server in the inventory, and then
select Enter Maintenance Mod e.
, review and subscribe to Knowledge Base article 650.
Figure 2-1: VMware vShpere Client configuration for the Apex 2800 install
3. Make sure the server is turned off and disconnected from AC power.
4. Insert the APEX 2800 card into an available PCI Express slot and secure the metal
bracket.
5. Plug the server into a surge-protected AC outlet, and then power it on.
Loading...