Joining with a secret key

In addition to an invitation hash, you can join a Tenant to the Tenant Broker using a secret key. As described earlier, a secret key can be used to join an unlimited number of Tenants to the same Tenant Broker.

To create a secret key:

  1. Log in to the Tenant Broker console.

  2. In the RAS Console, navigate to Farm > Settings.

  3. Select the Tenant broker tab.

  4. Select Allow RAS Farms to register in Tenant Broker using a secret key.

  5. Optionally, select Do not show billing information to hide billing information in the Licensing category of Tenants joined with secret keys.

  6. The secret key is generated automatically. To generate a different key, click Generate.

  7. If you want to register Tenants as subdomains, specify the domain part of the hostname in the Domain field. For example, to use "" as a Tenant host name, specify "".

Once you have the key, you can use it to join one or more Tenants to the Tenant Broker.

Note: Due to its unlimited usage capability, only the Tenant Broker administrator should have access to a shared secret key. Secret keys can be practical when the Tenant Broker administrator manages Tenant Farms, so instead of generating a hash for every Tenant, he/she can use a single secret key to join all of them to the Tenant Broker.

To join a Tenant using a secret key:

  1. Log in to the Tenant.

  2. In the RAS Console, navigate to Farm > Site.

  3. Click Tasks > Join Tenant Broker.

  4. In the Join Tenant Broker dialog, specify the following:

    • Enter the secret key in the first field from the top. If the Tenant is able to reach the Tenant Broker, the Tenant Broker field will be populated automatically.

    • The Tenant Name field is populated automatically based on the name of the current Site, but you can specify a Tenant name of your choosing. The name you enter will be used in the Tenant Broker to name the corresponding Tenant object.

    • In the Public domain addresses field, you can specify public domain addresses that will be used to access the Tenant. Configuring this is optional. If the Domain field is configured in the Tenant Broker settings (see above), you may enter subdomain only rather then the full domain address.

  5. Click Join.

On successful join, you will see a message welcoming you to the Tenant Broker. If the primary Connection Broker in your Tenant Farm can't reach the Tenant Broker, you will see a corresponding error message. Make sure that the Tenant Broker computer is reachable from the machine where you have the primary Connection Broker running.

Overriding the Tenant Broker IP address

The Tenant Broker IP address is detected automatically when you generate a secret key and is embedded into it. If a Tenant can't reach the Tenant Broker using this address, you have the ability to override it as follows:

  1. Log in to the Tenant Broker.

  2. In the RAS Console, navigate to Farm > Settings and click the Tenant broker tab.

  3. Select the Override Tenant Broker address in tenant invitations and secret keys option.

  4. Enter the desired IP address in the field provided.

Last updated

© 2024 Parallels International GmbH. All rights reserved.