PCoIP Client Parameters¶
The following table outlines command line parameters that are available to use and customize:
Short | Long | Default Description |
---|---|---|
-? | --help |
Display help message. Set to false by default. |
-v | --version |
Print version information. Set to false by default. |
-u | --username |
Username sent to Connection Broker. |
-p | --password |
Password sent to Connection Broker. |
-d | --domain |
Domain sent to Connection Broker. |
-b | --connection-broker |
Connection broker URL. |
-l | --log-level |
Unset force log level (will override config/registry) |
-w | --windowed |
False run inside a window. |
-f | --fullscreen |
False run in full-screen mode. The default is to run in windowed mode. |
-s | --security-mode |
Security mode. |
- | --locale |
Set locale. |
- | --disable-usb |
Disable USB. |
-h | --hard-host |
Hard host URL. This option is ignored if connection-broker is provided |
--quit-after-disconnect |
Do no re-enter the pre-session after leaving the in-session. | |
--usb-auto-forward |
Auto-forward all non-HID devices. | |
--vidpid-auto-forward |
String of VID, PID hex values separated by spaces. | |
--vidpid-black-list |
Blocks specific VID,PIDs from autoforward regardless of whether the usb-auto-forward parameter or the USB dialog is used. |
For example, running the --help
command will have the following format:
pcoip-client --help
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:
Field | Description | Optional vs Required |
---|---|---|
pcoip:// | Scheme registered to operating system so that PCoIP Client can be launched | Required |
broker | Broker through which a pcoip session is supposed to be brokered through | Optional |
/connect | Connecting to a PCoIP Client with the parameters defined in "?data" | Required |
?data | Query parameter to store a jwt encoded user credentials | Optional |
The table below details supported optional JWT payload claims:
Claim | Description |
---|---|
usr | Username |
dom | Domain |
vm | Virtual machine/resource name |
sid | Broker JSESSIONID |
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