Configuring PCoIP session variables
search cancel

Configuring PCoIP session variables

book

Article ID: 312980

calendar_today

Updated On:

Products

VMware

Issue/Introduction

You can use PCoIP session variables to control PCoIP session characteristics.


Environment

VMware View Manager 4.5.x
VMware View Manager 4.6.x

Resolution

You can change PCoIP session variables by setting group policies in Active Directory. The Group Policy Administrative (ADM) Template file named pcoip.admx contains group policy settings for PCoIP session variables.
Download the VMware Horizon GPO Bundle .zip file from the VMware download site at https://my.vmware.com/web/vmware/downloads.

Use the Group Policy Object Editor to add the pcoip.admx template to a GPO for your View desktops.
 
When you add the pcoip.admx template to a GPO, the PCoIP Session Variables folder appears under Computer Configuration\Administrative Templates. The Session Variables folder contains two folders:
  • Overridable Administrator Defaults contains settings that specify PCoIP session variable default values, which can be overridden by an administrator. These settings write registry key values to HKLM\Software\Policies\Teradici\PCoIP\pcoip_admin_defaults.
  • Not Overridable Administrator Settings contains the same settings as the Overridable Administrator Defaults folder, but these settings cannot be overridden by an administrator. These settings write registry key values to HKLM\Software\Policies\Teradici\PCoIP\pcoip_admin.

Local machine settings are held in the registry keys in HKLM\Software\Teradici. If the same registry key is present under both HKLM\Software\Teradici and HKLM\Software\Policies\Teradici, the group policy setting in HKLM\Software\Policies\Teradici overrides the local machine value.

This table describes the settings in the Overridable Administrator Defaults and Not Overridable Administrator Settings folders.
 
SettingsDescriptions
Configure PCoIP image quality levels
Controls how PCoIP renders images during periods of network congestion. The Minimum Image Quality and Maximum Initial Image Quality values interoperate to provide fine control in network-bandwidth constrained environments.
 
Use the Minimum Image Quality value to balance image quality and frame rate for limited-bandwidth scenarios. You can specify a value between 0 and 100. The default value is 50. A lower value allows higher frame-rates, but with a potentially lower quality display. A higher value provides higher image quality, but with potentially lower frame rates when network bandwidth is constrained. When network bandwidth is not constrained, PCoIP maintains maximum quality regardless of this value.
 
Use the Maximum Initial Image Quality value to reduce the network bandwidth peaks required by PCoIP by limiting the initial quality of the changed regions of the display image. You can specify a value between 0 and 100. The default value is 90. A lower value reduces the image quality of content changes and decreases peak bandwidth requirements. A higher value increases the image quality of content changes and increases peak bandwidth requirements. Unchanged regions of the image progressively build to a lossless (perfect) quality regardless of this value. A value of 90 or lower best utilizes the available bandwidth.
 
The Minimum Image Quality value must be less than or equal to the Maximum Initial Image Quality value. Both values apply to the soft host only.
Configure PCoIP session encryption algorithmsControls the encryption algorithms advertised by the PCoIP endpoint during session negotiation. You must enable at least one algorithm. The endpoints negotiate the algorithm that is used.
Configure PCoIP USB allowed and unallowed device rules
Specifies the USB devices that are authorized and not authorized for PCoIP sessions that use a hardware portal. USB devices that are used in PCoIP sessions must appear in the USB authorization table. USB devices that appear in the USB unauthorization table cannot be used in PCoIP sessions. You can define a maximum of 10 USB authorization rules and a maximum of 10 USB unauthorization rules. Separate multiple rules with the vertical bar (|) character.
 
Each rule can be a combination of a Vendor ID (VID) and Product ID (PID), or can describe a class of USB devices. A class rule can allow or disallow an entire device class, a single subclass, or a protocol within a subclass.
 
The format of a combination VID/PID rule is 1xxxxyyyy, where xxxx is the VID in hexadecimal format and yyyy is the PID in hexadecimal format. For example, the rule to authorize or block a device with VID 0x1a2b and PID 0x3c4d is 11a2b3c4d.
 
For class rules, use one of these formats:
 
Allow all USB devices
  • Format: 23XXXXXX
  • Example:23XXXXXX

Allow USB devices with a specific class ID

  • Format: 22classXXXX
  • Example: 22aaXXXX

Allow a specific subclass

  • Format: 21class_ subclassXX
  • Example: 21aabbXX

Allow a specific protocol

  • Format: 20class_subclass_protocol
  • Example: 20aabbcc
For example, the USB authorization string to allow USB HID (mouse and keyboard) devices (class ID 0x03) and webcams (class ID 0x0e) is 2203XXXX|220eXXXX. The USB unauthorization string to disallow USB Mass Storage devices (class ID 0x08) is 2208XXXX.
 
An empty USB authorization string means that no USB devices are authorized. An empty USB unauthorization string means that no USB devices are banned.
Configure PCoIP virtual channels
Specifies the virtual channels that can operate and the ones that cannot operate over PCoIP sessions. Virtual channels that are used in PCoIP sessions must appear on the virtual channel authorization list. Virtual channels that appear in the unauthorized virtual channel list cannot be used in PCoIP sessions.
 
Separate multiple channel names with the vertical bar (|) character. For example, the virtual channel authorization string to allow the mksvchan and vdp_rdpvcbridge virtual channels is mksvchan|vdp_vdpvcbridge.
 
If a channel name contains the vertical bar or backslash (\) character, insert a backslash character before it. For example, type the channel name awk|ward\channel as awk\|ward\\channel.
 
When the authorized virtual channel list is empty, all virtual channels are disallowed. When the unauthorized virtual channel list is empty, all virtual channels are allowed.
Configure the Client PCoIP UDP port
Specifies the UDP client port that is used by software PCoIP clients. The UDP port value specifies the base UDP port to use. The UDP port range value determines how many additional ports to try if the base port is not available.
 
This setting has no effect on a host.
Configure the maximum PCoIP session bandwidthSpecifies the maximum bandwidth, in kilobits per second, for PCoIP sessions. A value of 0 specifies no bandwidth constraints.
Configure the PCoIP session bandwidth floorSpecifies the maximum bandwidth floor, in kilobits per second, for PCoIP sessions. A value of 0 specifies no bandwidth floor constraints.
Configure the PCoIP session MTUSpecifies the Maximum Transmission Unit (MTU) size for PCoIP sessions, including IP and UDP or TCP packet headers. If the two endpoints have different MTU size settings, the lowest size is used.
Configure the Server PCoIP UDP port
Specifies the UDP server port bound to by software PCoIP hosts. The UDP port value specifies the base UDP port to use. The UDP port range value determines how many additional ports to try if the base port is not available.
 
This setting has no effect on a client.
Configure the TCP port that the PCoIP host binds and listens toSpecifies the TCP server port bound to by software PCoIP hosts. The TCP port value specifies the base TCP port that the server attempts to bind to. The TCP port range value determines how many additional ports to try if the base port is not available.
Disallow console input behavior when a PCoIP client is connectedDetermines whether console input from the host is disallowed when a client is attached through PCoIP. When this setting is disabled or not configured, console input is allowed.
Enable/disable audio in the PCoIP sessionDetermines whether audio is enabled in PCoIP sessions. Both endpoints must have audio enabled. When this setting is enabled, PCoIP audio is allowed. When it is disabled, PCoIP audio is disabled. When this setting is not configured, audio is enabled by default.
Turn on PCoIP user default input language synchronizationDetermines whether the default input language for the user in the PCoIP session is synchronized with the default input language of the PCoIP client endpoint. When this setting is enabled, synchronization is allowed. When this setting is disabled or not configured, synchronization is disallowed.
Use alternate key for sending Secure Attention Sequence
You can use this setting to preserve the Ctrl-Alt-Insert key sequence in virtual machines that are launched from inside a View desktop during a PCoIP session.
 
When a user launches a virtual machine from inside a View desktop and presses Ctrl-Alt-Insert inside the virtual machine, a Ctrl-Alt-Delete SAS is sent to the virtual machine. When this setting is enabled, you can specify a key other than Insert to use for Ctrl-Alt-Delete.
 
Additional InformationFor translated versions of this article, see: