1. Manuals
  2. Brands
  3. Teradici Manuals
  4. Software
  5. PCoIP TER812002
  6. User manual

Teradici PCoIP TER812002 User Manual

Management console
Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
PCoIP
Management Console
®

User Manual

TER0812002
Issue 5
2

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the PCoIP TER812002 and is the answer not in the manual?

Questions and answers

Related Manuals for Teradici PCoIP TER812002

Summary of Contents for Teradici PCoIP TER812002

  • Page 1: User Manual

    PCoIP Management Console ® User Manual TER0812002 Issue 5...
  • Page 2 PCoIP Management Console User Manual Teradici Corporation #101-4621 Canada Way, Burnaby, BC V5G 4X8 Canada +1 604 451 5800 +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.

  • Page 3: Revision History

    PCoIP Management Console User Manual Revision History Version Date Description April 3, 2009 Initial release August 31, 2009 Updated for release 1.1 of the Management Console Updated Management Console Limitations (see Section 1.2) Added Migrating to a New Version of the Management Console (see Section 2.6) March 01, 2010 Updated for release 1.2 of the Management Console...

  • Page 4: Table Of Contents

    PCoIP Management Console User Manual Contents REVISION HISTORY ...................... 3   CONTENTS ........................4   TABLE OF FIGURES ..................... 7   TABLES.......................... 9   DEFINITIONS ....................... 10   INTRODUCTION......................11   OVERVIEW ......................12         PCoIP Deployment Components ..................... 12  ...
  • Page 5 PCoIP Management Console User Manual     Refresh Status..........................29     Set Web Interface Password......................29     Change Hostname ........................... 29     Manage Networking ......................... 30     3.4.1 View Network Configuration...................... 30     3.4.2 Configure IP Address ........................ 30  ...
  • Page 6 PCoIP Management Console User Manual     4.6.2 Update Device Firmware ......................64     4.6.3 View Status ..........................66     Device Log Monitoring........................67     4.7.1 Device Tree..........................67     4.7.2 Logging Controls ........................68     4.7.3 Status ............................

  • Page 7: Table Of Figures

    PCoIP Management Console User Manual Table of Figures   Figure 1-1: PCoIP Deployment Components ..............12   Figure 1-2: Management Console Groups and Profiles ........... 15   Figure 1-3: DNS Service Configuration Menu ..............17   Figure 1-4: DNS Service Location (SRV) Dialog Box ............18  ...
  • Page 8 PCoIP Management Console User Manual   Figure 4-27: Schedule Device State Change Command Web Page........ 62   Figure 4-28: Power Management Status Web Page ............63   Figure 4-29: Update Firmware Web Page ................ 64   Figure 4-30: Initial Update Devices Web Page..............65  ...

  • Page 9: Tables

    PCoIP Management Console User Manual Tables   Table 2-1: Potential Problems Associated with Upgrading the MC   Table 4-1: Example AutoConfig rules   Table 4-2: Example AutoConfig rule application TER0812002 Issue 5...

  • Page 10: Definitions

    PCoIP Management Console User Manual Definitions DHCP Dynamic Host Configuration Protocol Domain Name System DNS SRV Domain Name System Service Record FQDN Fully Qualified Domain Name PCoIP Management Console Operating System On Screen Display ® PC-over-IP Personal Computer over Internet Protocol ®...

  • Page 11: Introduction

    PCoIP Management Console User Manual Introduction The Teradici PCoIP Management Console (MC) enables administrators to centrally manage a PCoIP deployment. The MC is packaged as a VMware® virtual machine (VM) and runs on VMware Player. A web browser is used to access and control the MC. Administrators can use the MC to do the following: •...

  • Page 12: Overview

    PCoIP Management Console User Manual 1 Overview This section describes the components found in a typical PCoIP deployment. It describes some important concepts that help the user understand how to use the MC to manage the PCoIP devices in a deployment. 1.1 PCoIP Deployment Components Figure 1-1 shows the recommended components found in a PCoIP deployment where individual Host and Zero Client devices are statically grouped together (peered).

  • Page 13: Dns Server

    PCoIP Management Console User Manual However, users should avoid changing the configuration settings through the device web interface, especially as the deployment grows. Instead, users are encouraged to use the MC; this ensures that all PCoIP devices are configured uniformly and that the MC database accurately reflects the device configuration settings.

  • Page 14: Management Console Limitations

    PCoIP Management Console User Manual • All PCoIP devices in a deployment reside on the same network subnet as the MC. In this situation the MC can find the devices using SLP discovery. All devices must set the Enable SLP Discovery configuration setting equal to True. •...

  • Page 15: Figure 1-2: Management Console Groups And Profiles

    PCoIP Management Console User Manual could be related to profiles. The figure shows three groups of devices. Two of the groups share the same profile. In this situation all configuration settings defined in the Development Profile will be written to the devices in the R&D and Engineering groups. Figure 1-2: Management Console Groups and Profiles Below are some important rules regarding groups and profiles.

  • Page 16: Fixed Seating

    PCoIP Management Console User Manual 1.3.2 Fixed Seating The MC allows an administrator to link individual Host and Zero Client devices so that each Zero Client always establishes a connection to the same Host. This relationship is called fixed seating. If a PCoIP deployment requires the ability to dynamically assign Hosts to Zero Clients when users login the administrator must install a connection broker.

  • Page 17: Figure 1-3: Dns Service Configuration Menu

    PCoIP Management Console User Manual Add the MC DNS SRV Record to the DNS Server To add the MC DNS SRV record to DNS Server in Windows 2003 Server, perform the following steps: 1. Enter DNS service configuration on domain controller. 2.

  • Page 18: Figure 1-4: Dns Service Location (Srv) Dialog Box

    PCoIP Management Console User Manual Figure 1-4: DNS Service Location (SRV) Dialog Box 1.3.3.2 PCoIP Management Console DNS-Based Discovery Prefix Each PCoIP device reads the PCoIP MC DNS-Based Discovery Prefix setting when it boots. If this setting is non-blank then the device attempts to contact the MC by combining the string stored in this setting with variations of the domain name hierarchy.
  • Page 19 PCoIP Management Console User Manual Algorithm Each time a PCoIP device boots it executes the MC DNS-Based Discovery algorithm if the PCoIP MC DNS-Based Discovery Prefix setting is non-blank. The algorithm uses the setting and the domain name hierarchy to search for a MC. The PCoIP device obtains the domain name string from the DHCP server using DHCP options 15.
  • Page 20 PCoIP Management Console User Manual Attempts 1 to 3 use the domain name from DHCP options 15 string. Failing to contact the MC, the device uses the DHCP options 12 string for attempts 4 to 7. Failing transmissions for attempt 4 to 7, the device cycles back to using DHCP options 15. 1.3.3.3 Manual Device Discovery Manual device discovery is not an automated discovery mechanism.

  • Page 21: Autoconfig

    PCoIP Management Console User Manual Figure 1-5: Management Console Manual Device Discovery Feature 1.3.4 AutoConfig Any PCoIP Zero Clients newly discovered by the MC may be automatically added to a group and have that group’s profile applied without user interaction. One or more AutoConfig rules can be created that allow one group to have one or more criteria defined.

  • Page 22: Management Console And Firmware Version Compatibility

    PCoIP Management Console User Manual If the group‘s profile contains a firmware rule then the firmware is applied if it passes the criteria and the device is rebooted. The remainder of the profile‘s properties are now applied to the device. After applying the profile‘s OSD logo and properties the Zero Client will be rebooted.
  • Page 23 PCoIP Management Console User Manual       1.4.30, 1.4.40 0.19-current 0.19-3.3.0 Added the ability to: • Configure View desktop name to  select  • Enable/disable Zero Client web  interface  • Selective display of Zero Client  On‐Screen Display menu entries  • VMware View Connection Server  address cache behaviour and  content  • Choose the Estonian, Hungarian,  Latvian and Serbian keyboard  layouts  • Configure VMware View auto‐ logon        1.5.20 0.19-current 0.19-3.4.0 Added the ability to:...

  • Page 24: Installation And Setup

    PCoIP Management Console User Manual 2 Installation and Setup This section describes how to install and setup the MC. It also describes how to migrate from an old version of the MC to a new version. 2.1 Management Console Host System Requirements The MC server machine must meet the requirements of the virtualization environment that the MC VM will run in.

  • Page 25: Installing The Management Console Using Vmware Player

    PCoIP Management Console User Manual 2.3 Installing the Management Console using VMware Player 1. The MC is distributed as a VMware virtual machine (VM) contained in a zip file. The VM is run using VMware Player. VMware Player is a free application that can be downloaded from http://www.vmware.com/download/player/.

  • Page 26: Migrating To A New Version Of The Management Console

    PCoIP Management Console User Manual Note: Along the bottom of the window the VMware Player describes how to interact with the VM and how to return to the host OS. Figure 2-1: MC VM Console in VMware Player 2.6 Migrating to a New Version of the Management Console Periodically new releases of the MC will be released.

  • Page 27: What Information Is Imported

    PCoIP Management Console User Manual When a deployment installs a This problem will not occur if the IP address of the new version of the MC the PCoIP new instance of the MC is the same as the old Host and Zero Client devices may version of the MC.
  • Page 28 PCoIP Management Console User Manual 3. Section 2.6.2 above lists the settings that will and will not be imported by the new version of the MC when a database is restored. Prior to shutting down the old version of the MC write down the values of the settings that will not be imported. 4.

  • Page 29: Virtual Machine Features

    PCoIP Management Console User Manual 3 Virtual Machine Features The top level menu of the PCoIP Management Console is shown in Figure 3-1. This menu appears after opening the MC in the VMware Player. This section describes the features accessed and controlled through this interface, which is referred to as the “MC VM console”...

  • Page 30: Manage Networking

    PCoIP Management Console User Manual If the deployment does not install a MC DNS SRV record the administrators should configure the PCoIP MC DNS-Based Discovery Prefix field of each PCoIP device to equal the hostname prefix of the MC. Section 1.3.3.2 provides additional details on this field and the system requirements associated with using it.

  • Page 31: Configure Dns

    PCoIP Management Console User Manual broadcast address and domain are optional and can be left blank. After the IP address settings are updated the MC restarts the network interface using the new settings. 3.4.3 Configure DNS The Configure DNS option allows the user to configure the Domain Name Server(s) and search domain(s) used by the MC.

  • Page 32: Backup Database

    PCoIP Management Console User Manual 3.5.1 Backup Database The Backup database to archive command allows an administrator to take a snapshot of the current database contents and store it in an archive. The archive resides within the MC VM. This command should be used in conjunction with the download database command on the Database Management web page to backup and store the contents of the database somewhere outside of the MC VM.

  • Page 33: Halt Virtual Machine

    PCoIP Management Console User Manual 3.8 Halt Virtual Machine To perform a clean shutdown of the MC VM select the Halt virtual machine option on the MC VM console. The MC VM can be restarted at a later time. When the MC VM is restarted the MC database is restored to the state it was in when the MC VM was last stopped.

  • Page 34: Web Interface

    PCoIP Management Console User Manual 4 Web Interface The MC web interface is the primary mechanism used by administrators to manage all PCoIP devices in a deployment. This section describes the features accessed and controlled through this interface. 4.1 Accessing the Management Console Web User Interface Connect a computer to the same network the MC server machine is connected to.

  • Page 35: Figure 4-1: Web Interface Security Warning In Firefox

    PCoIP Management Console User Manual Figure 4-1: Web Interface Security Warning in Firefox Figure 4-2: Web Interface Security Warning in Internet Explorer After adding the security exception in Firefox or installing the certificate in either browser it will connect to the MC and the user is prompted to accept the MC License Agreement shown in Figure 4-3.

  • Page 36: Figure 4-3: Management Console License Agreement

    PCoIP Management Console User Manual Figure 4-3: Management Console License Agreement After accepting the license agreement the web browser connects to the MC and the user is prompted to enter a password as shown in Figure 4-4. The default password is blank. Section 3.2 describes how to modify this password.

  • Page 37: Device Management

    PCoIP Management Console User Manual • Manage the monitoring of device event logs (see section 4.7) • Upload/Download MC database archives (see section 4.8) • Customize the MC configuration settings (see section 4.8) • View site status information (see section 4.9) •...

  • Page 38: Device Discovery (Optional)

    PCoIP Management Console User Manual Figure 4-6: Device Management Web Page 4.2.1 Device Discovery (optional) Section 1.3.3.3 describes the Device Discovery (optional) feature. 4.2.2 Legend The device management Legend, shown in Figure 4-7, provides information that explains the meaning of special symbols and line colors displayed on the Device Management page.

  • Page 39: Figure 4-7: Device Management Legend Box

    PCoIP Management Console User Manual Figure 4-7: Device Management Legend Box The MC may draw a line between Host and Zero Client devices. The line indicates the two devices are linked. Host and Zero Client devices are considered linked if a PCoIP session was or still is active between the devices.

  • Page 40: Query Devices And Update Database

    PCoIP Management Console User Manual • Unpeered Host devices are represented by the symbol • Unpeered Zero Client devices are represented by the symbol 4.2.3 Query Devices and Update Database The MC database contains a snapshot of each device’s configuration settings. The MC automatically queries each device once an hour and updates its internal database.

  • Page 41: Configure Device Group

    PCoIP Management Console User Manual specifies Firmware Version and the user enters the string 1.9 in the Text field the tool displays all devices loaded with release 1.9. • The Peerings dropdown menu allows administrators to display all devices, peered devices or unpeered devices.

  • Page 42: Linking Devices

    PCoIP Management Console User Manual Figure 4-8: Adding Devices to a Group 4.2.6 Linking Devices Individual Host and Zero Client devices can be linked together. After two devices are linked, the Zero Client will always establish a PCoIP session with the linked Host when a user initiates a connection and the Host will only accept connections from the linked Zero Client.

  • Page 43: Access Device Web Page

    PCoIP Management Console User Manual Figure 4-9: Peering a Pair of Devices Note: After two devices are linked by the MC the MC updates the Zero Client device session configuration data if it detects a change in a peered Host device’s IP address. When the MC detects that a Host’s IP address has changed, it looks up the Host’s peer in the database and attempts to write the new IP address into the Zero Client session settings.

  • Page 44: Summary Device Information

    PCoIP Management Console User Manual 4.2.8 Summary Device Information Administrators can view summary information about each device by clicking on the device Field in the list of HOSTS or ZERO CLIENT devices. After doing this a dialog box appears that provides information about the device. Figure 4-10 displays a summary information dialog box.

  • Page 45: Device Details

    PCoIP Management Console User Manual 4.2.8.2 Access Device Details The MC maintains additional device details not shown on the Device Management page. To access these details for an individual device execute the following steps. 1. Click on the device to display the summary device information dialog box. 2.

  • Page 46: Figure 4-12: Zero Client Device Details Web Page

    PCoIP Management Console User Manual Figure 4-12: Zero Client Device Details Web Page 4.2.9.1 Device Configuration and Status The device details web page displays device configuration and status data in addition to device profile data. When the web page is first displayed the device categories are collapsed.
  • Page 47 PCoIP Management Console User Manual • (Empty string) – The parameter is not configured in the device. Some fields such as the Connection Management System (CMS) address equal this when the device is not configured to use a CMS. • Not supported –...

  • Page 48: Group Management

    PCoIP Management Console User Manual Figure 4-13: Device Event Log Web Page 4.3 Group Management The Group Management web page, shown in Figure 4-14, allows administrators to view the currently defined groups and the number of devices in each group, manage AutoConfig rules and view profile application status information.

  • Page 49: Manage Groups

    PCoIP Management Console User Manual Figure 4-14: Group Management Web Page 4.3.1 Manage Groups The Manage Groups subcategory allows administrators to view, create, edit and delete groups and select a profile to associate with each group. For groups with profiles this page shows an application status summary and provides a method to apply the profile settings to the entire group.
  • Page 50 PCoIP Management Console User Manual the View Profile Application Status page with the filter set to this group. Figure 4-14 shows the summary for the Sales group. Below is a description of each status category: • Successful – The profile was successfully written to the device. •...

  • Page 51: Figure 4-15: Apply Profile Reboot Behavior Options

    PCoIP Management Console User Manual Figure 4-15: Apply Profile reboot behavior options TER0812002 Issue 5...

  • Page 52: View Profile Application Status

    PCoIP Management Console User Manual Figure 4-16: Apply Profile date/time picker 4.3.2 View Profile Application Status The Profile Application Status subcategory, shown in Figure 4-17, provides detailed status information that shows the current state of profile application for grouped devices. The Profile column also displays icons representing the expected reboot behavior of devices when the profile is applied.

  • Page 53: Manage Autoconfig

    PCoIP Management Console User Manual • firmware scheduled – The MC has scheduled the profile’s selected firmware to be written to the device. • complete – The profile along with any included OSD logo and firmware was successfully written to the device. •...
  • Page 54 PCoIP Management Console User Manual Table 4-1: Example AutoConfig rules Group  Device Password Cdn3  IP Range Cdn2  Group A   Add device with no password  <Empty>                       PASSW0RD  ⌧ Add device with no password  Group B  192.168.50.1 ‐ 192.168.50.254  Table 4-2: Example AutoConfig rule application Note: AutoConfig is enabled so condition 1 is always true. Zero Client  Group A Rule  Group B Rule  AutoConfig Result  IP ...

  • Page 55: View Autoconfig Status

    PCoIP Management Console User Manual Figure 4-18: Manage AutoConfig Web Page 4.3.4 View AutoConfig Status The View AutoConfig Status subcategory, shown in Figure 4-19, provides status information that shows if devices have been discovered and fit the criteria of existing AutoConfig rules along with the profile application status.

  • Page 56: Profile Management

    PCoIP Management Console User Manual Figure 4-19: View AutoConfig Status Web Page 4.4 Profile Management The Profile Management web page, shown in Figure 4-20, allows administrators to view the currently defined profiles along with the time each profile was last modified/updated. Administrators can initiate the following actions using this web page.

  • Page 57: Duplicate A Profile

    PCoIP Management Console User Manual 4.4.2 Duplicate a Profile The Duplicate Profile link creates a new profile with the same profile properties as the selected profile. The administrator should select the Edit link to set the profile Name and Description after duplicating a profile. Note: Administrators may find it useful to create an initial profile containing the settings that are common across all devices in the deployment.

  • Page 58: Figure 4-21: Profile Management - Set Properties Web Page

    PCoIP Management Console User Manual Figure 4-21: Profile Management – Set Properties Web Page Each group of devices managed by the MC can have a profile assigned to it. The concepts associated with a MC profile are explained in section 1.3.1. An important thing to be aware of is the fact profiles can be created that do not define values for every profile property.

  • Page 59: Figure 4-22: Bandwidth Configuration Settings Dialog Box

    PCoIP Management Console User Manual Figure 4-22: Bandwidth Configuration Settings Dialog Box 4.4.5.1 OSD Logo in a profile An OSD logo may be uploaded into a profile to be applied to all devices in a group. Choose Profile OSD Logo->Set OSD Logo and have an image file prepared that is a 24bpp bitmap that does not exceed 256 pixels by 64 pixels.

  • Page 60: Power Management

    PCoIP Management Console User Manual • Less than: Firmware will be overwritten on the device if its version is less than the x.y.z firmware version you enter in the following text entry field. Figure 4-24: Link to Imported Firmware property 4.5 Power Management The Power Management web page, shown in Figure 4-25, supports the following actions: •...

  • Page 61: Sending Reset And Power Off Commands

    PCoIP Management Console User Manual 4.5.1 Sending Reset and Power off Commands The Set Device State link on the Power Management web page allows administrators to schedule reset and power off commands to be sent to PCoIP devices. When this link is selected the web page shown in Figure 4-26 appears.

  • Page 62: Power Management Status

    PCoIP Management Console User Manual To send a reset or power off command to a device the administrator must select the command type by selecting one of the radio buttons shown in Figure 4-26. After doing this the administrator can filter the devices the command may be sent to using the Groups dropdown menu.

  • Page 63: Update Firmware

    PCoIP Management Console User Manual Figure 4-28: Power Management Status Web Page In addition to providing status information this web page can also be used to cancel commands that are scheduled to be sent in the future. 4.6 Update Firmware The Update Firmware web page, shown in Figure 4-29, allows administrators to update the firmware running on PCoIP devices.

  • Page 64: Import Firmware

    PCoIP Management Console User Manual Figure 4-29: Update Firmware Web Page 4.6.1 Import Firmware The Import Firmware link allows an administrator to transfer a firmware release file from the host machine to the MC VM. The administrator is prompted to locate the file containing the firmware release on the host machine file system and assign a description to the firmware release.

  • Page 65: Figure 4-30: Initial Update Devices Web Page

    PCoIP Management Console User Manual Figure 4-30: Initial Update Devices Web Page When the View Devices to Update button is selected the MC displays the second update devices web page that lists the devices that match the Version Number and Group Name specified by the user.

  • Page 66: View Status

    PCoIP Management Console User Manual Figure 4-31: Second Update Devices Web Page 4.6.3 View Status The View Status link allows the user to view the current status of all scheduled and completed firmware updates. Figure 4-32 shows the Firmware Update Status web page. Figure 4-32: Firmware Update Status Web Page TER0812002 Issue 5...

  • Page 67: Device Log Monitoring

    PCoIP Management Console User Manual 4.7 Device Log Monitoring The Device Log Monitoring web page, shown in Figure 4-33, allows administrators to collect logs over time from a selection of PCoIP devices. Administrators can initiate the following actions using this web page. •...

  • Page 68: Logging Controls

    PCoIP Management Console User Manual 4.7.2 Logging Controls Once a selection of devices has been made using the device tree, the event log filter mode may be set to verbose or terse. This setting will override profile settings and settings made directly on the device. If the device is set to a different event log filter mode during log monitoring, it will be overwritten to the setting made here the next time logs are retrieved by the log monitoring process.

  • Page 69: Database Management

    PCoIP Management Console User Manual Figure 4-34: Settings Web Page 4.8.1 Database Management The Manage Database link on the Settings web page allows administrators to upload and download database files from the MC VM. When this link is selected the web page shown in Figure 4-35 appears.

  • Page 70: Environment Settings

    PCoIP Management Console User Manual choose database archive to upload. Click the Upload button after selecting the file. This will initiate the transfer of the database file into the VM. After a database is uploaded to the VM the user must restore the database from the imported file to begin using it.

  • Page 71: Figure 4-36: Home Web Page

    PCoIP Management Console User Manual Figure 4-36: Home Web Page The following status information is displayed: • Number of online and offline PCoIP Zero Clients discovered by the MC • Number of online and offline PCoIP Hosts discovered by the MC •...

  • Page 72: Online Help

    PCoIP Management Console User Manual Note: The MC considers sessions to be active only when the host PC/Workstation is powered on (in the S0 state) and a session is active between the Host and Zero Client. If the host PC/Workstation is in a low power state (S3, S4 or S5) the session is considered inactive.

  • Page 73: Getting Started

    PCoIP Management Console User Manual 5 Getting Started This section provides instructions on how to begin using the MC. After completing the following steps an administrator will be able to establish a PCoIP session using a pair of PCoIP Host and Zero Client devices. 5.1 Start the Management Console Follow the instructions described in sections 2.2 and 2.5.

  • Page 74: Peering Devices

    PCoIP Management Console User Manual Figure 5-1: Adding Devices to a Group Note: After a device is successfully added to a group the group name appears in the Group column for each device. In Figure 5-1 the first Zero Client device is part of the Default group and the third Zero Client device is not part of a group.

  • Page 75: Next Steps

    PCoIP Management Console User Manual Figure 5-2: Peering a Pair of Devices 5.5 Next Steps Below is a list of suggestions for the administrator to follow in order to become more familiar with the MC. • Review section 1 of this document to become familiar with the different components in a PCoIP deployment.
  • Page 76 PCoIP Management Console User Manual • Download new firmware to a device. Refer to section 4.6 • Send reset commands to a device and view power management status information. Refer to section 4.5. • Backup the MC database and download it from the MC VM to an external server. Refer to sections 3.5.1 and 4.8.1.

This manual is also suitable for:

Pcoip management console

Table of Contents