How to Establish a PCoIP Session¶
Brokered Session Connection
If you are using a brokered session, this is handled by the broker libraries automatically.
Before you can establish a PCoIP session with a host desktop, gather the following host desktop details:
- IP address
- Port number
- Session ID
- Server name indication (SNI)
- Connection tag
This information can then be passed to the provided in-session client to establish a
PCoIP session programmatically. See the example code for specific call syntax.
In terms of programming interface, there are two ways that the connection and security
information can be presented to pcoip-client
:
Pass the pieces of information individually to the executable.
The following command invokes pcoip-client
to establish a PCoIP session
and passes the connection and session information as parameters, where:
- Connection tag:
SCS1WsopFJ3iz1l48PTJMXFkcD4b6M9aiakHXH3ellLhUROBceWAifSSn%2b4AV1FC 8IihWVmsISmYFKeA25AtzFrdMpdaCtqlic0zfxAA
-
IP address:
10.64.60.115
-
Log ID:
a1ff3a80-8801-1038-19bd-0005680aded
-
Session ID:
2305843009213693961
Encode all information into a string container (URI) and then pass to the executable. The following command invokes pcoip-client to establish a PCoIP session and passes the connection tag as a parameter and a URI encapsulating the IP address and Session ID in a string container, where:pcoip-client -i connect-tag= SCS1WsopFJ3iz1l48PTJMXFkcD4b6M9aiakHXH3ellLhUROBceWAifSSn%2b4AV1FC 8IihWVmsISmYFKeA25AtzFrdMpdaCtqlic0zfxAA address=10.64.60.115 session-id=2305843009213693961 log-id=a1ff3a80-8801-1038-a9bd-00505680aded
-
Connection tag:
SCS1WsopFJ3iz1l48PTJMXFkcD4b6M9aiakHXH3ellLhUROBceWAifSSn%2b4AV1FC 8IihWVmsISmYFKeA25AtzFrdMpdaCtqlic0zfxAA
- URI: "teradici-pcoip://10.64.60.115:4172?session-id=230584300921369396"
URI Format Documentation
There is a document describing the URI format in the root of the SDK.
'pcoip-client "connect-tag=SCS1WsopFJ3iz1l48PTJMXFkcD4b6M9aiakHXH3ellLhUROBceWAifSSn%2b4AV1FC8IihWVmsISmYFKeA25AtzFrdMpdaCtqlic0zfxAA" "teradici-pcoip://10.64.60.115:4172?session-id=230584300921369396"