Licensing Your PCoIP Standard Agent for Linux

The PCoIP Standard Agent must be assigned a valid PCoIP session license before it will accept a new PCoIP session. The agent can be licensed via Teradici's Cloud Licensing service, or by your own PCoIP license server.

Licensing PCoIP Agents with Cloud Licensing

Cloud licensing requires no configuration beyond providing a registration code for each PCoIP agent. The required registration code is provided by Teradici when PCoIP licenses are purchased. One registration code can be used to activate multiple PCoIP agents.

	Note: Registration code format
	Registration codes look like this: YUOIFUSD32@AB33-H372-D78E-78XX

To provide the registration code:

Invoke pcoip-register-host with the license registration code and proxy settings if required:

                pcoip-register-host --registration-code=<registration-code> [--proxy-server=<proxy-server-address>] [--proxy-port=<proxy-port-number>]

Licensing PCoIP Agents With a Local License Server

In deployments where PCoIP agents cannot access the internet, or where cloud-based licensing is not permitted or desired, a local PCoIP License Server can be used instead. The PCoIP License Server manages PCoIP session licenses within your private environment.

Configuring PCoIP agents to use a local license server is done in one of two ways, depending on whether your deployment uses a PCoIP Connection Manager, or whether your PCoIP clients connect directly to PCoIP agents.

Licensing PCoIP Agents With a Local License Server in a Brokered Environment

In brokered deployments, the license server address is configured in the Connection Manager, which passes it through to its managed PCoIP agents.

When using a Connection Manager, the license server address is only configured once no matter how many PCoIP agents are behind the Connection Manager.

To set the License Server URL in the Connection Manager:

On the Connection Manager machine, use a text editor to open /etc/ConnectionManager.conf.
Set the LicenseServerAddress parameter with the address of your local license server:
- License Server 2.x URL format:
  
  http://<license-server-address>:<port>/request
Save and close the configuration file.
Restart the Connection Manager.

Verifying Your Licensing Configuration

To verify your system's licensing configuration, run pcoip-validate-license from the console on the PCoIP Standard Agent machine. The script will ping the license server and attempt to retrieve information on an available license:

pcoip-validate-license ‑‑license-server-url <license-server-address> [‑‑proxy-server <proxy-server-address>] [‑‑proxy-port <proxy-port-number]

Where <license-server-address> is the address of the license server to ping, formatted for the license server version:

License Server 2.x URL format:

http://<license-server-address>:<port>/request

If the license server is behind a proxy server, provide the proxy information via the ‑‑proxy-server and ‑‑proxy-port parameters.

If successful, the response will show that a valid license was found on the license server, and its expiration date.

If the connection is unsuccessful, investigate the following possibilities:

The license server address is incorrect, or in the wrong format.
The license server is inaccessible.
There are no available licenses on the license server. This command will only return a positive response if there is at least one available session license.
If you have only one license on the license server and you are attempting this command from a PCoIP session, the command will fail because there are no free licenses available. In this scenario, disconnect your PCoIP session and try again from an ssh session instead.

Licensing Agents with a Local License Server in an Unbrokered Environment

In direct, or unbrokered, deployments, each PCoIP agent is configured with the license server address via a local agent setting. When a client initiates a new PCoIP session, the PCoIP agent uses its local configuration to communicate with the license server.

Local license validation using a PCoIP Linux agent and a direct (unbrokered) connection

Each PCoIP agent in your environment must be individually configured with the license server's URL.

To configure the License Server URL on the PCoIP Standard Agent:

Using a text editor, open /etc/pcoip-agent/pcoip-agent.conf.
Add or modify the pcoip.license-server-path directive:
```
pcoip.license-server-path = <license-server-address>
```
Where <license-server-address> is the address of the license server, formatted for the license server version:
- License Server 2.x URL format:
  
  http://<license-server-address>:<port>/request
If the license server is behind a proxy server, provide the proxy information using the pcoip.license_proxy_server and pcoip.license_proxy_port directives.
Save and close pcoip-agent.conf.

The changes will take effect on the next PCoIP session.

Verifying Your Licensing Configuration

To verify your system's licensing configuration, run pcoip-validate-license from the console, including proxy parameters if required. The script will ping the license server using the local pcoip-agent.conf settings and attempt to retrieve information on an available license:

pcoip-validate-license [--proxy-server <proxy-server-address>] [‑‑proxy-port <proxy-port-number]

If successful, the response will show that a valid license was found on the license server, and its expiration date.

If the connection is unsuccessful, investigate the following possibilities:

The license server address is incorrect, or in the wrong format.
The license server is inaccessible.
There are no available licenses on the license server. This command will only return a positive response if there is at least one available session license.
If you have only one license on the license server and you are attempting this command from a PCoIP session, the command will fail because there are no free licenses available. In this scenario, disconnect your PCoIP session and try again from an ssh session instead.