Configuring the PCoIP Software Client

This section outlines command line parameters and settings that are available to use and customize. These parameters enable user to configure the PCoIP Client, as well as attain and send information.

Launching PCoIP Software Client with a URI¶

It is possible to launch the PCoIP Software Client with a URI. The Teradici URI uses JSON Web Tokens (JWT). For more information on the use of JWT, see here. The URI is defined as the following:

pcoip://[broker]/connect[?data={jwt}]

When additional parameters are passed through the encoded JWT a session can be launched:

The table below details supported optional JWT payload claims:

Below is an example of a JWT payload:

{
    "usr": "username",
    "dom": "mydomain.com",
    "vm": "mydesktopname"
}

pcoip://fake.broker.com/connect?data=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c3IiOiJ1c2VybmFtZSIsImRvbSI6Im15ZG9tYWluLmNvbSIsInZtIjoibXlkZXNrdG9wbmFtZSJ9.Mf3uoeZT8VQbVq7Gp0QQGbh8EqYtrIlp_E9jF2iI31Q

Configurable Settings¶

The following settings can be configured on the PCoIP Software Client for Windows.

Username¶

This is the username sent to the Connection Broker.

Password¶

This is the password sent to the Connection Broker.

Domain¶

This is the domain sent to the Connection Broker.

Connection Broker¶

This is the connection broker URL.

Log Level¶

This setting will unset and force the log level.

Windowed Mode¶

You can display the PCoIP session in either windowed or fullscreen mode. Windowed mode gives you the flexibility to display multiple application windows in parallel and switch between them quickly. Windowed mode is the default mode, and to activate fullscreen mode use the full-screen parameter, as outlined in the following example:

"c:\Program Files (x86)\Teradici\PCoIP Client\bin\pcoip_client.exe" --full-screen

Fullscreen Mode¶

Fullscreen mode enables the display topology to support multiple monitors as an extended desktop.

Security Mode¶

This is the security mode for verifying connections. By default, the mode will be set to 1.

Locale Language¶

This mode sets the Locale.

Disable USB¶

This setting disables USB connections.

Hard Host¶

This is the hard host URL. This option is ignored if the connection-broker url is provided.

Quit After Disconnection¶

This setting enables the session to be quit after it has been disconnected. You cannot re-enter the pre-session after leaving a PCoIP session.

USB Auto-Forward¶

This setting auto-forwards all non-HID devices.

Vidpid Auto-Forward¶

This is a string of VID,PID hex values separated by spaces.

Vidpid Black List¶

This setting blocks specific VID,PIDs from auto-forwarding regardless of whether the usb-auto-forward parameter or the USB dialog is used.

Disable Menu Bar¶

To enhance the user experience the PCoIP Session Client enables the menu bar by default, however some use cases may require that it be disabled, or hidden, in order to prevent the user from accessing menu functionality. To disable the menu bar feature use the disable-menubar parameter, as outlined in the following example:

"c:\Program Files (x86)\Teradici\PCoIP Client\bin\pcoip_client.exe" --disable-menubar

Disable Hotkeys¶

To improve usability, session hot keys, such as Ctrl+Delete+F12 (which disconnects a PCoIP session) are available to users by default. The parameter for this feature is disable-hotkeys, as outlined in the following example:

"c:\Program Files (x86)\Teradici\PCoIP Client\bin\pcoip_client.exe" --disable-hotkeys

Set Host Resolution¶

This setting locks the resolution of your host application display. This can only be configured on a single display.

Enable Scaling¶

This setting enables scaling on the PCoIP Client without having to specify the desktop resolution. This can only be configured on a single display.

Maintain Aspect Ratio¶

This setting maintains the aspect ratio between the host and the Client. This can only be configured on a single display.

Force Native Resolution¶

This setting sets the resolution of the Client monitor to the native resolution when the session client is launched. This can only be configured on a single display and is only available on the Windows Client.

Session ID¶

This setting launches the JSESSIONID.

Enabling Accessibility Permissions for PCoIP Client¶

The keyboard handling of the PCoIP Client for macOS has be updated to handle new default handling for the CMD key to capture and send to remote systems. In order for this new keyboard handling to function, the PCoIP Client application must be authorized under System Preferences > Security & Privacy > Accessibility, not authorizing the application will result in the Keyboard not functioning in a PCoIP session.

When the PCoIP Client is opened for the first time on a Mac it should prompt the user to authorize the Accessibility permission. This requires the user to accept the prompt and enter the password. If this is declined, the prompt will not appear again and the Accessibility permission must be configured manually from within System Preferences.

The following steps outline how to manually set the accessibility permission:

1. Open System Preferences.
2. Click on Security & Privacy.
3. Select the Privacy tab.
4. Select the Accessibility option.
5. Click the Lock icon on the bottom left corner and authenticate using your password or touch ID.
6. Click the check mark beside PCoIP Client as outlined in the image below.