search
ProductsSupportPartnersDocumentation

Enabling Connection Broker API

It is possible to manage sessions in Parallels RAS without using the RAS Connection Brokers to carry out the management. This is useful for organisations that wish to manage sessions via a third-party method. The steps to enable this are below.

In addition to the steps below, configuration via API is needed. This API is documented herearrow-up-right.

Navigate to Farm > Site > Connection Brokers and follow the instructions below:

  1. Choose Tasks > Site Defaults (or choose the properties of an individual Connection Broker to assign to a specific Connection Broker)

  2. Choose the API tab

  3. Choose Enable API (if configuring on an individual Connection Broker, you will need to deselect Inherit Default Settings)

hashtag
SSL/TLS

  1. Select the API Port option and specify a port number for secure API communication

  2. In the Accepted SSL Versions drop-down list, select the SSL/TLS version required.

  3. In the Cipher Strength field, select a desired cipher strength.

  4. If Custom is chosen in the Cipher Strength field, in the Cipher field, specify the cipher. A stronger cipher allows for stronger encryption, which increases the effort needed to break it.

  5. The Use ciphers according to server preference option is ON by default. You can use client preferences by disabling this option.

  6. In the Certificates drop-down list, select a desired certificate. For the information on how to create a new certificate and make it appear in this list, see the SSL Certificate Management chapter.

hashtag
API Token

To use an API token, set the HTTP Authorization header value set when making API requests.

When the Enable API option is selected, an API Token String is generated. Choosing Regenerate will issue a new API Token String.

hashtag
Encryption Certificate

The chosen encryption certificate will be used by the Connection Broker API when creating runtime data between backend components.

To set this, navigate to Farm > Site > Connection Brokers and select the API tab (if this tab is not visible, it indicates that Enable API has not been selected).

If Automatic is selected, the default method of using the site certificate will be used. The list shows certificates available with the Third-Party Encryption property selected.

For the information on how to create a new certificate and make it appear in this list, see the SSL Certificate Management chapter.

PreviousUsing computer management toolsNextRAS Secure Gateway

Last updated