® PCoIP Management Console User Manual TER0812002 Issue 9...
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.
PCoIP Management Console User Manual Revision History Version Date Description August 13, 2012 Updated for release 1.8 of the Management Console • Added support for Firmware Release 4.0.0 • Added support for Firmware Release 4.0.1 • Added support for Tera2 devices •...
Page 4
PCoIP Management Console User Manual April 3, 2009 Initial release TER0812002 Issue 9...
PCoIP Management Console User Manual Contents Table of Figures ....................9 About this Document ....................... 13 Overview ....................14 PCoIP Deployment Components ................... 14 1.1.1 Managing PCoIP Devices ................. 14 1.1.2 DNS Server ....................... 15 1.1.3 DHCP Server ....................16 Management Console Limitations .................
Page 6
PCoIP Management Console User Manual Change Time Zone ......................40 Restart Management Console Daemon ................ 40 Halt Virtual Machine ....................... 40 Web Interface ..................41 Accessing the Management Console Web User Interface ..........41 4.1.1 Installing the MC Certificate in Internet Explorer ..........42 4.1.2 Installing the MC Certificate in Firefox ..............
PCoIP Management Console User Manual Table of Figures Figure 1-1: PCoIP Deployment Components ................14 Figure 1-2: Management Console Groups and Profiles ............18 Figure 1-3: DNS Service Configuration Menu ................. 20 Figure 1-4: DNS Service Location (SRV) Dialog Box ............. 21 Figure 1-5: Add a new DHCP Vendor Class Configuration .............
Page 9
PCoIP Management Console User Manual Figure 4-25: Profile Management – Certificate Store .............. 69 Figure 4-26: Import Profile Dialog.................... 70 Figure 4-27: Send Device State Change Command Webpage ..........71 Figure 4-28: Schedule Device State Change Command Webpage ........72 Figure 4-29: Power Management Status Webpage ..............
Page 10
PCoIP Management Console User Manual Tables Table 1-1: Management Console and Firmware Version Compatibility ........28 Table 2-1: Potential Problems Associated with Upgrading the MC......... 34 Table 4-1: Example AutoConfig Rules ..................61 Table 4-2: Example AutoConfig Rule Application ..............61 TER0812002 Issue 9...
Page 11
PCoIP Management Console User Manual Definitions Certificate Authorities Connection Management Interface – interface provided by the client or host, used to communicate with an external connection management server Connection Management Server – an external management entity (third party) that manages and controls the client/host through the CMI interface DHCP Dynamic Host Configuration Protocol Domain Name System...
PCoIP Management Console User Manual Introduction The management console for PCoIP® protocol devices (MC) lets you centrally manage a PCoIP deployment. The MC is packaged as a VMware virtual machine (VM) and runs on VMware Player and VMware ESX server. A web browser is used to access and control the The MC lets you: •...
PCoIP Management Console User Manual Overview This section describes the components found in a typical PCoIP deployment. 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). It shows the MC used for peering and configuration.
PCoIP Management Console User Manual PCoIP Management Console The management console for PCoIP protocol devices (MC) lets you centrally manage a PCoIP deployment. It lets you: • Access and update the configuration of your PCoIP devices • Apply the same configuration settings to groups of devices •...
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 have the Enable SLP Discovery configuration setting set to True. •...
PCoIP Management Console User Manual • PCoIP devices managed by the MC must be loaded with firmware release 0.19 or greater. The MC cannot discover devices loaded with older firmware releases. You must use the device web interface to load and activate new firmware on each device running firmware releases less than or equal to 0.18.
PCoIP Management Console User Manual Figure 1-2: Management Console Groups and Profiles Note some important rules regarding groups and profiles: • Each group has only one profile associated with it. • The same profile can be associated with multiple groups. •...
PCoIP Management Console User Manual 1.3.3 Device Discovery The MC must discover PCoIP devices before it can manage them. The MC supports discovering devices in a deployment using one or more discovery mechanisms: Recommended approaches: • Install a MC DNS SRV record. When DNS SRV record discovery is used, the PCoIP devices advertise themselves to the MC.
PCoIP Management Console User Manual Note: If you use this approach, note that if a device has DHCP enabled, the MC loses contact with a device if its IP address changes. Should this occur, you must perform another manual discovery search to find devices that were assigned new IP addresses. See section 1.3.3.4 for more details.
PCoIP Management Console User Manual 5. Fill in the entries as shown in Figure 1-4. (Enter the hostname where the MC is installed under the heading Host offering this service.) Note: The PCoIP devices do not use the Port Number setting. You can choose to set it to 50000 to reflect the listening port of the CMI server.
PCoIP Management Console User Manual Note: For Cisco VXC 2111 and VXC 2211 PCoIP devices with firmware version 4.0.0 or higher use VXC2111 and VXC2211 respectively as the Vendor ID. Figure 1-5: Add a new DHCP Vendor Class Configuration 6. Click OK to save and close the dialog. 7.
PCoIP Management Console User Manual 10. Click OK to save and close the dialog. 11. Expand the tree for the DHCP server, and expand the tree for the Scope to which you want to add options. 12. Right-click Scope Options, and then choose Configure Options… 13.
Page 23
PCoIP Management Console User Manual 2. AutoConfig: None Persistent AutoConfig: None MC AutoConfig Behavior option is only used when MC AutoConfig Group option is configured. It is recommended to configure both options together. See section 1.3.4 for details on using the DHCP options for AutoConfig. 1.3.3.3 PCoIP Management Console DNS-Based Discovery Prefix Each PCoIP device reads the PCoIP MC DNS-Based Discovery Prefix setting when it...
Page 24
PCoIP Management Console User Manual 2. If the transmission times out, the device creates the next FQDN variation by proceeding one level up the domain hierarchy. The last domain name attempted has a single dot in the string. 3. After exhausting the FQDN possibilities (based on the DHCP options 15 string), the device waits for five minutes and then uses hostname variations based on the DHCP options 12 string.
PCoIP Management Console User Manual • When the IP address of a device is known and the device has not been discovered enter the address in the from IP field, and then select Discover Devices. • When a device is on a specific subnet but its IP address is not known, you can command the MC to discover the devices in a range of IP addresses using both the from IP and (optional) to IP fields.
Page 26
PCoIP Management Console User Manual o Password: Add discovered zero clients to this group if they have the identical password configured for the criteria. o IP address range: Add discovered zero clients to this group if the IP address falls within the range configured by the criteria. Not specifying an IP address range adds zero clients that match the password criteria.
PCoIP Management Console User Manual Management Console and Firmware Version Compatibility Table 1-1: Management Console and Firmware Version Compatibility MC Version Supports FW Version Fully Configures FW Versions 1.8.0 0.19-current 0.19-4.0.1 Added the ability to: • Configure certification check mode in View Connection Server mode •...
Page 28
PCoIP Management Console User Manual MC Version Supports FW Version Fully Configures FW Versions 1.7.0 0.19-current 0.19-3.5.0 Added the ability to: • Configure Imprivata OneSign authentication servers • Configure Self Help Link on VMware View login dialogs • Configure session connection type •...
Page 29
PCoIP Management Console User Manual MC Version Supports FW Version Fully Configures FW Versions 1.2.20 0.19-current 0.19-3.1.0 Added the ability to: • Enable/disable SNMP server • Enable/disable host driver function • Configure session encryption modes • Choose the Korean keyboard layout 1.1.20 0.19-current 0.19-2.2...
PCoIP Management Console User Manual Installation and Setup This section describes how to install and set up the MC. It also describes how to migrate from an old version of the MC to a new version. Management Console host System Requirements The MC server machine must meet the requirements of the virtualization environment that the MC VM will run in.
PCoIP Management Console User Manual • TER0904003_Issue_X-PCoIP_MC_Release_Notes.pdf: Teradici PCoIP Management Console Release Notes, where X is the current issue number Installing the Management Console using VMware Player 1. Download the VMware Player application. The MC is distributed as a VMware virtual machine (VM) contained in a zip file.
PCoIP Management Console User Manual As the VM boots, the VMware console shows a series of standard Linux boot messages before the MC console interface shown in Figure 2-1 appears. Once the VM is started, the MC URL (web site address) appears. The URL is equal to http://192.168.50.132 as shown in the following figure.
PCoIP Management Console User Manual Table 2-1: Potential Problems Associated with Upgrading the MC Problem Workaround The database restore feature can only import Do not try to import databases created by a newer databases created by old versions of the MC. version of the MC into older versions of the MC.
Page 34
PCoIP Management Console User Manual 5. Install and begin running to the new version of the MC. 6. Upload the database to the MC from the host computer. See section 4.8.1. 7. Restore the database from the imported database. See section 3.5.2. 8.
PCoIP Management Console User Manual Virtual Machine Features The top-level menu of the management console is shown in Figure 3-1. This menu appears after you open the MC in the VMware Player. This section describes the features accessed and controlled through this interface (referred to as the “MC VM console” throughout this document).
PCoIP Management Console User Manual If the deployment does not install a MC DNS SRV record, you should configure the PCoIP MC DNS-Based Discovery Prefix field of each PCoIP device to equal the hostname prefix of the MC. See section 1.3.3.2 for additional details on this field and the system requirements associated with using it.
PCoIP Management Console User Manual • Static IP addressing: If you choose static IP addressing, you must configure the MC IP address and subnet mask. The gateway address, broadcast address and domain are optional and can be left blank. After you update the IP address settings, the MC restarts the network interface using the new settings.
PCoIP Management Console User Manual Figure 3-3: Manage MC VM Console Database 3.5.1 Back Up Database The Backup database to archive command lets you take a snapshot of the current database contents and store it in an archive. The archive resides within the MC VM. You should use this command with the Download database command on the Database Management webpage to back up and store the contents of the database somewhere outside of the MC VM.
PCoIP Management Console User Manual Change Time Zone The MC retrieves the current time from the host machine. The host machine provides this time in Coordinated Universal Time (UTC) form. Because the host does not provide time zone information, you must configure the time zone. To configure the time zone: 1.
PCoIP Management Console User Manual Web Interface The MC web interface is the primary tool used to manage PCoIP devices in a deployment. This section describes the features accessed and controlled through this interface. Accessing the Management Console Web User Interface To access the MC Web User Interface: 1.
PCoIP Management Console User Manual Figure 4-2: Web Interface Security Warning in Firefox 4.1.1 Installing the MC Certificate in Internet Explorer 1. Right-click on pcoipmc_cacert.p7b, and then select Install Certificate. 2. When the Certificate Import Wizard appears click Next. 3. Select Automatically select the certificate store based on the type of certificate. Click Next.
PCoIP Management Console User Manual Note: In Firefox you can also disable the certificate warnings by adding an exemption for the MC. To do this, click I Understand the Risks on the This Connection is Untrusted warning page and follow the directions given to add an exemption. 4.1.3 Logging into the MC Web User Interface After adding the security exception in Firefox or installing the certificate in either browser,...
PCoIP Management Console User Manual Figure 4-4: Management Console License Agreement 4.1.5 Using the MC Home Page After you log in, the MC Home webpage, shown in Figure 4-5, appears. The Home page lets you: • Manage devices (see section 4.2) •...
PCoIP Management Console User Manual Figure 4-5: Home Webpage Device Management The Device Management webpage, shown in Figure 4-6, lets you: • Discover devices manually • Query devices and update database • Display a subset of devices based on various filter criteria •...
PCoIP Management Console User Manual Figure 4-6: Device Management Webpage 4.2.1 Device Discovery (optional) See section 1.3.3.3 for details about the Device Discovery (optional) feature. 4.2.2 Legend The device management Legend, shown in Figure 4-7, describes the meaning of special symbols and line colors that appear on the Device Management page.
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.
PCoIP Management Console User Manual • Unpeered zero client devices are represented by the symbol 4.2.3 Querying 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. If you want to force the tool to refresh its internal copy of the device settings, you can use the Update box on the upper right hand side of the Device Management webpage.
PCoIP Management Console User Manual • Text field: Lets you enter a text string. The MC displays all devices in which the device Field value matches the string. For example, if the Field menu specifies Firmware Version and you enter the string 1.9 in the Text field, the tool displays all devices loaded with release 1.9.
PCoIP Management Console User Manual Figure 4-8: Adding Devices to a Group 4.2.6 Linking Devices You can link together individual host and zero client devices. After two devices are linked, the zero client always establishes a PCoIP session with the linked host when you initiate a connection.
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 tries to write the new IP address into the zero client session settings.
PCoIP Management Console User Manual 4.2.8 Deleting Devices You can delete one, many, or all PCoIP devices by clicking the Delete button. • Single Device Delete: Select a device from the list of HOSTS or ZERO CLIENTS, and then click the Delete Device button. •...
PCoIP Management Console User Manual 4. Click Save to update the device name. Figure 4-11 displays the summary information dialog box while the device name is being edited. Figure 4-11: Edit Device Name Using Summary Device Information Dialog Box Note: The device must be part of a group before you can configure the name. Note: The device name only supports English characters.
PCoIP Management Console User Manual • Write the current profile settings to the device • Open the device’s profile • Open a web browser connected to device’s webpage • Open a web browser connected to device’s peer webpage • View the device’s event log Figure 4-12: Device Details Webpage for a Zero Client 4.2.11.1 Device Configuration and Status...
Page 54
PCoIP Management Console User Manual • Not in profile: The parameter is not specified in the profile. • Read only: The parameter cannot be specified in the profile. • Not valid for current session configuration: The parameter is not specified in the profile because the currently selected session connection type does not support this parameter.
PCoIP Management Console User Manual Figure 4-13: Device Event Log Webpage Group Management The Group Management webpage, shown in Figure 4-14, lets you view the currently defined groups, view the number of devices in each group, manage AutoConfig rules, and view profile application status information.
PCoIP Management Console User Manual Figure 4-14: Group Management Webpage 4.3.1 Manage Groups The Manage Groups subcategory lets you view, create, edit, 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 way to apply the profile settings to the entire group.
PCoIP Management Console User Manual The following is a description of each status category: • Successful: The profile was successfully written to the device. • Scheduled: The MC has scheduled the profile to be written to the device. • Failed: The MC attempted but failed to write the profile to the device. This problem typically occurs when devices are offline.
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 that represent the expected reboot behavior of devices when the profile is applied.
PCoIP Management Console User Manual • OSD logo done: The MC completed writing the OSD logo to the device. • firmware pending reboot: The MC completed writing the profile’s selected firmware to the device and requires a reboot before the profile properties are written. •...
PCoIP Management Console User Manual The zero client has either a blank password or password protection is disabled and the AutoConfig rule has Add device with no password checked. The zero client's password is one of the rule's passwords. The following examples show how AutoConfig rules are applied. The MC is configured with AutoConfig enabled and has two AutoConfig rules.
PCoIP Management Console User Manual 1. Optionally disable AutoConfig before adding or editing rules. This is recommended practice so interim rule configurations do not result in unexpected group memberships. 2. Choose an existing group from the Choose Group select box, and then click Add rule for group.
Page 62
PCoIP Management Console User Manual more settings are different. Conditions 1, 2 and 3 must be true for Persistent AutoConfig to work. The MC checks these conditions every hour to determine the action of Persistent AutoConfig. • Condition 1 The AutoConfig feature is enabled. •...
PCoIP Management Console User Manual Zero Client DHCP Vendor Group A Rule Group B Rule Group C Rule Persistent Options AutoConfig Result Current AutoConfig AutoConfig Group Group Behavior applied Group B False False True True True False Group B profile applied Group B Group B False...
PCoIP Management Console User Manual • failed error: The device failed to be added to this group for a reason other than AutoConfig criteria. • failed offline: The device could not be reached for verification of AutoConfig rule criteria. • failed IP range check: The device does not match the AutoConfig rule IP range criteria.
PCoIP Management Console User Manual 4.4.5 Modify Profile Properties Click the Set Properties link to configure the properties of a profile. Figure 4-21 shows the Profile Management Set Properties webpage. Figure 4-21: Profile Management – Set Properties Webpage 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.
PCoIP Management Console User Manual • Property Name • Value: The fields in this column determine the value of each profile setting. • Description Figure 4-22: Encryption Configuration Settings Dialog Box 4.4.5.1 OSD Logo in a Profile To upload a logo for the OSD into a profile (the logo is then applied to the devices groups with that profile): 1.
PCoIP Management Console User Manual • Different: Firmware is overwritten on the device if its version is different from the firmware version listed in the select box. • Less than: Firmware is overwritten on the device if its version is less than the x.y.z firmware version you enter in the text entry field.
PCoIP Management Console User Manual Figure 4-26: Import Profile Dialog If the imported profile contains a firmware file, the import process adds a new firmware file to the Update Devices webpage. 4.4.7 Export a Profile Click Export to export a selected profile into a file. You must then confirm the download to start the export process.
PCoIP Management Console User Manual Figure 4-27: Send Device State Change Command Webpage In the Set Device State webpage, reset commands can be sent to both host and zero client devices, while power off commands can only be sent to host devices. To power off zero client devices, see the Set Remote Power Down webpage (section 4.5.3).
PCoIP Management Console User Manual Figure 4-28: Schedule Device State Change Command Webpage You can send the commands immediately or in the future by specifying the date and time the command is sent. The command is sent immediately if the specified date/time is less than or equal to the current time.
PCoIP Management Console User Manual Figure 4-29: Power Management Status Webpage In addition to providing status information, you can cancel commands scheduled to be sent in the future from this webpage. 4.5.3 Schedule Remote Power Down Click the Set Remote Power Down link on the Power Management webpage to schedule remote power down commands to be sent to zero client devices.
PCoIP Management Console User Manual Figure 4-30: Set Remote Power Down Webpage You can schedule remote powerdown by specifying day(s) of a week and time of a day. Ctrl- click on the day-selector to select multiple days in a single schedule. You can schedule different times for each day by adding more schedules.
PCoIP Management Console User Manual 4.5.4 View Remote Power Down Status The View Remote Power Down Status subcategory, shown in Figure 4-30, provides status information that shows if devices have been powered down. The status categories include: • success:The device was successfully powered down by MC. •...
PCoIP Management Console User Manual Figure 4-32: Update Firmware Webpage 4.6.1 Import Firmware Click the Import Firmware link to transfer a firmware release file from the host machine to the MC VM. When prompted, locate the file containing the firmware release on the host machine file system, and assign a description to the firmware release.
PCoIP Management Console User Manual Figure 4-33: Initial Update Devices Webpage Click the View Devices to Update button to display the second update devices webpage that lists the devices that match the specified version number and group name. This new page is shown in Figure 4-33.
PCoIP Management Console User Manual Figure 4-34: Second Update Devices Webpage 4.6.3 View Status Click the View Status link to view the current status of all scheduled and completed firmware updates. Figure 4-34 shows the Firmware Update Status webpage. Figure 4-35: Firmware Update Status Webpage TER0812002 Issue 9...
PCoIP Management Console User Manual Device Log Monitoring The Device Log Monitoring webpage, shown in Figure 4-35, lets you collect logs over time from a selection of PCoIP devices. The Device Log Monitoring webpage lets you: • Choose devices to be monitored •...
PCoIP Management Console User Manual devices being monitored and the event log filter mode until log monitoring is stopped. An attempt to collect logs is made every 300 seconds. Click the Download Collected Logs button to format the logs collected into individual .txt files per device, archive the logs into .tar.gz format, and present them as a downloadable file.
PCoIP Management Console User Manual Figure 4-38: Database Management Webpage Uploading a Database Click Browse and Upload to transfer a database archive from the host PC running the web browser to the MC VM. Click Browse, and then select the database archive to upload. Click Upload to start the transfer of the database file into the VM.
PCoIP Management Console User Manual 4.8.3 Manage Device Naming The device labels used as default device names in the PCoIP MC configuration setting, lets you name newly discovered devices with their labels. By default this setting is disabled and devices are named as “Discovered YYMMDD-XXXX” where XXXX is a unique value. Figure 4-38 shows the confirmation dialog that appears once the setting is enabled.
PCoIP Management Console User Manual Figure 4-40: Home Webpage The following status information appears: • Number of online and offline PCoIP zero clients discovered by the MC • Number of online and offline PCoIP hosts discovered by the MC • Number of active PCoIP sessions •...
PCoIP Management Console User Manual • After a profile is applied (or the application fails) 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.
PCoIP Management Console User Manual Getting Started This section provides instructions on how to begin using the MC. After completing the following steps, you can establish a PCoIP session using a pair of PCoIP host and zero client devices. Start the Management Console Follow the instructions described in sections 2.3 or 2.4 to install the MC, and then read section 2.5 to start using it.
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.
PCoIP Management Console User Manual Figure 5-2: Peering a Pair of Devices Configuring Zero Clients for VMware View You can configure zero clients for VMware View. After a zero client is configured, a PCoIP session can be started from the zero client. To start a PCoIP session, the end user must click the Connect button on the zero client OSD.
PCoIP Management Console User Manual 10. Depending on the Certification Check Mode and the server configuration a valid certificate must be presented by the zero client. Click Add New button in the Certificate Store tab to upload and assign a certificate file to the profile. Note: See Knowledge Base 15134-1020 for details on downloading the View Connection Server trusted root certificate.
Need help?
Do you have a question about the t310 and is the answer not in the manual?
Questions and answers