Page 2
Teradici APEX 2800 Server Offload Card Administrator's Guide 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.
Teradici APEX 2800 Server Offload Card Administrator's Guide Revision History Version Date Description Sep 25, 2012 • Replaced screen shots where new values are now seen • Updated information as related to new features in the latest software release Feb 24, 2012 •...
Teradici APEX 2800 Server Offload Card Administrator's Guide Contents Table of Figures ..........................6 Definitions ............................7 Introduction ......................... 9 Benefits ............................. 9 System Requirements ........................10 Virtual Desktop Server Platform...................... 10 Client .............................. 10 Network ............................10 Installation and Configuration ................... 11 Before you Begin ..........................
Page 5
Teradici APEX 2800 Server Offload Card Administrator's Guide 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) ....
Teradici APEX 2800 Server Offload Card Administrator's Guide 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 ........................
Teradici APEX 2800 Server Offload Card Administrator's Guide Definitions Definition Description Administrative Web Interface Command Line Interface Central Processing Unit Error Correction Code Frames Per Second Graphics Processing Unit Graphical User Interface presented by the client On Screen Display when not operating in a PC-over-IP session Management Console Mpps Mega pixels per second...
Page 8
Teradici APEX 2800 Server Offload Card Administrator's Guide Definition Description Zero Client See PCoIP zero client TER1109003 Issue 3...
Teradici APEX 2800 Server Offload Card Administrator's Guide Introduction ® The Teradici APEX™ 2800 server offload card provides hardware-accelerated PCoIP image encoding for server-hosted VMware View virtual desktops (often referred 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.
Teradici APEX 2800 Server Offload Card Administrator's Guide 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 •...
Teradici APEX 2800 Server Offload Card Administrator's Guide 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.
Teradici APEX 2800 Server Offload Card Administrator's Guide 2.3 Installing the ESXi Driver Package 1. Enable remote login on the VMware ESXi server: a. Press F2 to enter customization. b. Enter your username and password. c. Enable SSH: • ESXi 5.0: Select Troubleshooting Mode Options > Enable SSH. •...
Teradici APEX 2800 Server Offload Card Administrator's Guide Figure 2-3: WinSCP browser window showing placement of the zip file to the tmp folder. 3. Connect to the ESXi server using an SSH client (e.g., PuTTy) from your PC and install the driver package: a.
Teradici APEX 2800 Server Offload Card Administrator's Guide Figure 2-5: Successful zip command results for ESXi 4.1 with the reboot command. 4. Type reboot at the prompt to restart the ESXi server. From the vSphere Client, right-click the ESXi server in the inventory, and then select Exit Maintenance Mode.
Teradici APEX 2800 Server Offload Card Administrator's Guide 3. Run the apex2800-version-xxxxxx.exe on the virtual machine and follow the onscreen steps. Note: You cannot install this package from within a PCoIP session to the virtual machine. You must install it from the vSphere VMConsole. 4.
Teradici APEX 2800 Server Offload Card Administrator's Guide Figure 2-8: View Connection Server Global Policies configuration window. 4. Click OK. 2.6 Installing Additional APEX 2800 Cards When additional APEX 2800 cards are installed on the same server, they act as a single resource and can automatically offload additional displays.
Teradici APEX 2800 Server Offload Card Administrator's Guide Administration This section describes the management functions for your APEX 2800 card(s). To manage the APEX 2800 card, use View Administrator. It does not require the installation of any other management tool. 3.1 Setting Priority Levels You can refine how the APEX 2800 card prioritizes display offloads when the card is operating at full capacity.
Teradici APEX 2800 Server Offload Card Administrator's Guide 2. The PCoIP hardware acceleration drop-down box is set to Allow (by default). You can change the Priority setting to any of the available options. This change is applied to your desktop pools that currently are set up to inherit the global setting. 3.1.2 Assigning the Priority to a Desktop Pool To assign a priority level to a desktop pool:...
Teradici APEX 2800 Server Offload Card Administrator's Guide Figure 3-3: VCS local inventory pools Policies Priority setting. 2. Click OK to save your changes. The new priority setting is applied to all users within the desktop pool (except any users that have a Priority setting applied to them individually). 3.1.3 Assigning the Priority to an Individual End User To assign a priority to a specific end user within a desktop pool:...
Teradici APEX 2800 Server Offload Card Administrator's Guide 3.2 Session Variables Most of the PCoIP session settings configured in View are maintained by the APEX 2800 card. The following table shows common session settings and if they are supported by the APEX 2800 card.
Page 21
Teradici APEX 2800 Server Offload Card Administrator's Guide Null Switches Output the command usage information Specify the device number (bus number) to control Disable the APEX 2800 device specified using the -d option Enable the APEX 2800 device specified using the -d option Output the general driver and device information Output virtual machine and display usage information Output all software and firmware log event categories and...
Teradici APEX 2800 Server Offload Card Administrator's Guide Null Switches Output the command usage information --disable-portrait-mode Disables portrait mode --reset-properties Reset all properties to the manufacturing default (deletes all properties set by the user) --get-encoder-mode-switch- Retrieves the client capability thresholds at which the encoder thresholds mode is switched --set-encoder-mode-switch-...
Teradici APEX 2800 Server Offload Card Administrator's Guide • 2: Disable the offload indicator Default: Disabled bw_disable_threshold Set the enable/disable network bandwidth threshold for offload canceling. To bw_enable_threshold view the enable or disable state for a VM, type pcoip-ctrl -V. Note: This setting applies for VMware View 5.0 clients and later.
Teradici APEX 2800 Server Offload Card Administrator's Guide both the APEX 2800 ESXi driver as well as in the APEX 2800 card firmware. These levels include: Table 3-4: APEX 2800 log levels. Description Level 0-Critical The system can no longer function correctly. This log level only shows the critical event messages in the log.
Teradici APEX 2800 Server Offload Card Administrator's Guide 3.4 Monitoring the VDI Server Load 3.4.1 ESXtop PCPU You can use esxtop to monitor the physical CPU loading for a VDI server by using the PCPU statistics. While you can do this live, we recommend you run esxtop in batch mode to save the values to a file.
Teradici APEX 2800 Server Offload Card Administrator's Guide 3.4.2 vCenter Performance Tab Figure 3-6: vCenter Performance Tab Note: While you can monitor the server CPU resources through vCenter, it is not recommended for benchmarking the APEX 2800 card since the usage is only updated every 20 seconds.
Teradici APEX 2800 Server Offload Card Administrator's Guide Figure 3-7: Pcoip-ctrl output with the -I option, ESXi 5.0 and driver 1.x This outputs the following for driver 2.0 and ESXi 5.0: Figure 3-8: Pcoip-ctrl output with the -I option, ESXi 5.0 and driver 2.x TER1109003 Issue 3...
Teradici APEX 2800 Server Offload Card Administrator's Guide The line containing "(1) APEX2800 device present" indicates that the card is installed correctly. Other information provided includes: • Onboard temperatures (for both the processor and board) • Device utilization: This shows the current activity for the card. The value ranges from 0 to 99 with 0 indicating idle.
Teradici APEX 2800 Server Offload Card Administrator's Guide (HostName) PCoIP Session Closed: Indicates the VM is not currently in an active PCoIP session. If APEX 2800 hardware acceleration is disabled for this user’s VM in View Connection Server, this command also reports the PCoIP session as closed. (HostName)(APEX VM Driver build #) [E] **[0](display #0 resolution) –[1](display #1 resolution) (Not shown in the figure.) •...
Page 30
Teradici APEX 2800 Server Offload Card Administrator's Guide 2. 1920 X 1200 3. 1680 X 1050 4. 1280 X 1024 Example To set a new maximum resolution of 1920 x 1200 use the associated number 2. /opt/teradici/pcoip-ctrl --set-max-resolution 2 TER1109003 Issue 3...
Teradici APEX 2800 Server Offload Card Administrator's Guide Troubleshooting This section describes some troubleshooting procedures specific to the APEX 2800 card. For more details, see the Knowledge Base at http://techsupport.teradici.com. 4.1 Enabling a Syslog Server It is important to enable a syslog server to capture the log data in the event of an issue. Due to the volume of information, the event logs are over-written quickly.
Teradici APEX 2800 Server Offload Card Administrator's Guide 4.2 Determining the APEX 2800 Card Status 4.2.1 From an Administrative Console To view the status of one, or multiple APEX 2800 cards, enter the following command in your SSH session: pcoip-ctrl -I For more information about pcoip-ctrl -I command, see Viewing the Status of the APEX 2800...
Teradici APEX 2800 Server Offload Card Administrator's Guide 4.4 Disabling the ESXi Interrupt Remapping (Communication with PCIe Devices Stops) In some cases unrelated to the APEX 2800 card, enabling the interrupt remapping on the server can cause a loss of communication with PCIe devices. This problem can occur to any other PCIe card.