Parallels RAS 20 Administrator's Guide
ProductsSupportPartnersDocumentation
English
English
  • Parallels RAS 20 Administrator’s Guide
    • Introduction
      • Parallels RAS release history
      • About Parallels RAS
      • About this guide
      • What's new
      • Terms and abbreviations used in this guide
    • Installing Parallels RAS
      • System requirements
        • Hardware requirements
        • Software requirements
        • Microsoft license requirements
      • Install Parallels RAS
      • Log in and activate Parallels RAS
    • Getting Started with Parallels RAS
      • The Parallels RAS Console
      • Set up a basic Parallels RAS Farm
        • Add an RD Session Host
        • Publish applications
        • Invite users
        • Azure Virtual Desktop
        • Conclusion
    • Farm and Sites
      • Connecting to a Parallels RAS Farm
      • About Sites
      • Sites in the RAS Console
      • Adding a Site to the Farm
      • Replicating Site settings
      • Managing Licensing Site
      • Managing administrator accounts
        • Adding an administrator account
        • Administrator account permissions
        • Managing administrator accounts
        • Configure RAS Console idle sessions
        • Using instant messaging
        • Joining Customer Experience Program
    • RAS Connection Broker
      • Configuring RAS Connection Brokers
      • Secondary Connection Brokers
      • Managing Secondary Connection Brokers
      • Using computer management tools
    • RAS Secure Gateway
      • Overview
      • Adding a RAS Secure Gateway
      • Manually adding a RAS Secure Gateway
      • Checking the RAS Secure Gateway status
      • Configuring a RAS Secure Gateway
        • Enable or disable a Secure Gateway
        • Set public address
        • Set IP addresses for client connections
        • Site defaults (Secure Gateways)
        • Gateway mode and forwarding settings
        • Gateway network options
        • SSL/TLS encryption
          • SSL server configuration
        • Configure User Portal
          • Using Site defaults
          • Enable or disable User Portal
          • Client settings
          • Network load balancers access
        • Wyse ThinOS support
        • Secure Gateway security
        • Web request load balancing
      • Secure Gateway tunneling policies
      • Configure logging
      • Viewing Secure Gateway summary and metrics
      • Using computer management tools
    • RD Session Hosts
      • RD Session Host types
      • Add an RD Session Host
        • Installing the agent manually
      • Add a template-based RD Session Host
      • Manage RD Session Hosts
        • Manage host pools (RD Session Hosts)
          • Add host pools (RD Session Hosts)
          • Upgrading Agents (RD Session Hosts)
        • Manage templates (RD Session Hosts)
          • Creating an RD Session Host template
          • Assigning a template to a host pool (RD Session Host)
          • Managing RD Session Hosts based on a template
        • Manage hosts (RD Session Hosts)
          • Viewing RD Session Hosts
          • Check an RD Session Host Agent status
          • Change RD Session Host Site assignment
          • View and modify RD Session Host properties
            • Using default settings
            • General
            • Agent settings
            • User profile
            • Application Packages
            • Optimization
            • Desktop access
            • RDP printer
          • User profile
            • User Profile Disks
            • FSLogix
              • Configure managing existing profiles by Parallels RAS
              • FSLogix antivirus exclusions
          • Optimization
          • Drive redirection cache
          • Configure logging
        • Manage sessions (RD Session Host)
        • Using scheduler (RD Session Hosts)
      • Planning for high availability
      • Managing logons
      • Using computer management tools
      • Publishing from an RD Session Host
      • Viewing published resources
    • Virtual Desktop Infrastructure (VDI)
      • Supported providers
      • Add a provider
        • RAS Provider Agent information
          • RAS Provider Agent installation options
        • Add a hypervisor provider
        • Add a cloud Provider
          • Microsoft Azure
            • Introduction and prerequisites
            • Create Microsoft Entra ID application
            • Add Microsoft Azure as a Provider
            • Microsoft Azure and templates
          • Amazon Web Services
            • Introduction and prerequisites
            • Design considerations
            • Step 1. Creating an IAM user for programmatic access
            • Step 2. Adding AWS as a Provider
      • Manage VDI
        • Manage providers (VDI)
          • Installing RAS Provider Agent using the installer
          • Checking the RAS Provider Agent status
          • Using a Provider in multiple farms
        • Manage host pools (VDI)
          • Add host pools (VDI)
          • Delete host pools (VDI)
          • Add and delete host pool members
          • Using a wildcard to filter VMs
          • Managing hosts in pools
          • Upgrading Agents (VDI)
        • Manage templates (VDI)
          • Virtual desktop templates
          • Multi-provider template distribution
          • Creating a VM template
            • Step 1: Check and install the Agent
            • Step 2: Configure the template
              • Properties
              • Distribution
              • Advanced
              • Preparation
              • Optimization
              • License keys
              • Summary
              • Host naming
            • Parallels Test Template Wizard
            • Modifying template properties
          • How hosts are created from a template
          • Manually adding a host
          • Assigning a template to a host pool (VDI)
          • Template maintenance
          • Template status
          • Managing multi-provider template distribution
          • Managing template-based hosts
        • Manage hosts (VDI)
          • Persistent hosts
          • Configuring hosts to interact with RAS Provider Agent in a different subnet
        • Manage sessions (VDI)
        • Using scheduler (VDI)
      • Configure logging
      • Enabling high availability for VDI
      • Site defaults (VDI)
      • Using computer management tools
      • Viewing Provider summary
      • Remote PC pools in VDI
        • Adding a Provider
        • Adding Remote PCs to a Provider
        • Adding Remote PCs to a pool
        • Managing Remote PCs in a pool
        • Persistent Remote PCs
        • RAS Guest Agent installation options
    • Azure Virtual Desktop
      • Introduction
      • Prerequisites
      • Deploy Azure Virtual Desktop
        • Enable Azure Virtual Desktop and add a provider
        • Add workspaces
        • Add host pools (Azure Virtual Desktop)
      • Manage Azure Virtual Desktop
        • Manage providers (Azure Virtual Desktop)
        • Manage workspaces (Azure Virtual Desktop)
        • Manage host pools (Azure Virtual Desktop)
          • Upgrading Agents (Azure Virtual Desktop)
        • Manage templates (Azure Virtual Desktop)
          • Create a template
          • Manage existing templates
          • Assigning a template to a host pool (Azure Virtual Desktop)
        • Manage hosts (Azure Virtual Desktop)
        • Manage sessions (Azure Virtual Desktop)
        • Using scheduler (Azure Virtual Desktop)
      • Site defaults (Azure Virtual Desktop)
        • Site defaults for single-session hosts
        • Site defaults for multi-session hosts
      • Using Parallels Client with Azure Virtual Desktop
      • Verify the deployment
    • Remote PCs
      • Overview
      • Manage host pools (Remote PC)
      • Manage hosts (Remote PC)
        • Adding a Remote PC to a Farm
          • Admin-initiated Remote PC enrollment
          • Self-service Remote PC enrollment
        • Configuring a Remote PC
      • Viewing Remote PC summary
      • Using computer management tools
    • Publishing
      • Overview
      • Publishing a desktop
      • Publishing an application
      • Publishing local applications
      • Publishing an application with MSIX app attach
      • Publishing a web application
      • Publishing a network folder
      • Publishing a document
      • General management tasks
      • Manage published applications
      • Manage published desktops
      • Manage published documents
      • Manage folders
      • Site defaults (Publishing)
      • Using filtering rules
      • Configuring preferred routing
      • Understanding session prelaunch
      • Checking effective access
      • Specifying client settings
      • Quick keypad
    • Session Management
      • Overview
      • Session information
      • Monitoring settings
      • Managing sessions
      • The Resources tab
    • SSL Certificate Management
      • Generating a self-signed certificate
      • Generating a certificate signing request (CSR)
      • Let's Encrypt certificates
        • Requesting a Let's Encrypt Certificate
        • How Parallels RAS requests certificates from Let's Encrypt
      • Importing a certificate
      • Exporting a certificate
      • Assigning a certificate to Secure Gateways and HALBs
      • Auditing certificates
      • Permissions to manage certificates
      • Upgrading from an older RAS version
    • Connection and Authentication Settings
      • RAS Connection Broker connection settings
      • Remote session settings
      • Logon hours settings
      • Restricting access by Parallels Client type and build number
      • Multi-factor authentication
        • Adding an MFA provider
        • Using RADIUS
          • Connection
          • Attributes
          • Automation
          • Advanced
          • Configuring Azure MFA
          • Configuring Duo
        • Using TOTP
          • Configuring TOTP
          • Configuring Google Authenticator
          • Configuring Microsoft Authenticator
        • Configuring email OTP
        • Using Deepnet DualShield
          • Supported tokens
          • Configuring DualShield 5.6+ Authentication Platform
          • Configuring Parallels RAS to use the DualShield Authentication Platform
          • Connect to a RAS Farm
        • Using SafeNet
          • Configuring SafeNet
        • Configuring MFA rules
      • Allowing users to change domain password
      • Allowing users to discover RAS connections via email address
    • Load Balancing and HALB
      • Resource based & round robin load balancing
        • Configure CPU optimization
      • High availability load balancing (HALB)
        • Prerequisites
        • Deploying a Parallels HALB appliance
        • Adding a HALB virtual server
        • HALB Device status and version number
        • HALB maintenance
        • HALB connection and session information
        • Changing the HALB appliance password
    • RAS Multi-Tenant Architecture
      • Overview
      • Architecture description
        • Implementation overview
        • User connection flow
      • Deploying Tenant Broker and Tenants
        • Deploying Tenant Broker
        • Deploying a Tenant
          • Join a Tenant to Tenant Broker
          • Joining with a secret key
          • Verify join status
          • Configure network
          • Assign a public domain address
          • Configure an SSL certificate
          • Set up routing for incoming traffic
        • User authentication
        • Unjoining from Tenant Broker
      • Managing Tenants
        • Tenant configuration
        • Deleting a Tenant object
        • Opening a Tenant console
      • Shared Gateways
      • Third-party network load balancers
      • Web Client and Themes
      • Monitoring Tenants
      • Tenant Broker compatibility and updates
      • Upgrading from an older RAS version
      • Configuring notifications
      • Communication ports
    • SAML SSO Authentication
      • Introduction
      • System requirements
      • SAML basics
      • SAML configuration
        • Prerequisites
        • IdP side configuration
        • SP side configuration (RAS side)
        • Active Directory user account configuration
        • Configure certificate authority templates
          • Create an Enrollment Agent template
          • Create a smartcard logon certificate template
        • RAS Enrollment Server configuration
        • RAS Enrollment Server high availability
        • SAML integration examples and tips
          • User account attributes
          • Security tip
      • Parallels Client configuration
      • Parallels client policy configuration
      • Test the SAML SSO deployment
      • Error messages
    • Parallels Web Client and User Portal
      • Configure Web Client
      • Configure Themes
        • General settings
        • Access settings
        • Message settings
        • Web Client settings
          • URLs
          • Branding
          • Colors
          • Language bar
          • Messages
          • Input prompt
          • Gateway
          • Legal policies
        • Parallels Client for Windows settings
        • General Theme tasks
        • Delegating session management permissions
      • Open Parallels Web Client
      • Main menu options
      • Running remote applications and desktops
        • Using drag and drop functionality
        • Native clipboard experience
        • Other useful features
      • Auto login
      • Direct App access
      • Using the toolbar
        • Using the toolbar on desktop computers
        • Using the Toolbar on Mobile Devices
        • Using the remote clipboard
        • Hiding toolbar items
    • Universal Printing
      • Managing Universal Printing Settings
      • Universal Printing drivers
      • Font management
    • Universal Scanning
      • Managing Universal Scanning
      • Adding scanning applications
    • User Device Management and Client Policies
      • Inviting users to connect to Parallels RAS
      • Mass configuring user devices
      • Enabling Help Desk support for users
      • Enabling Help Desk support for custom administrators
      • Monitoring devices
        • Getting additional device information
      • Windows device groups
      • Managing Widows devices
        • Windows desktop replacement
      • Scheduling Windows devices & groups power cycles
      • Client policies
        • Add a new client policy
        • Configure session settings
          • Appearance
          • Connection
          • Display
          • Printing
          • Scanning
          • Audio
          • Keyboard
          • Local devices and resources
          • Experience
          • Network
          • Server authentication
          • Advanced settings
        • Configure client policy options
        • Configure control settings
        • Configure Gateway redirection
        • Client policy backward compatibility
        • Policy information in Parallels Client
      • Configuring remote file transfer
        • Configure file transfer to a server
        • Configure file transfer in User Portal
        • Configure file transfer for a client policy
    • Reporting
      • System requirements
      • Install Microsoft SQL Server
        • Install Microsoft SQL Server 2016 or earlier
        • Install Microsoft SQL Server 2017 or 2019
        • Install Microsoft SQL Server 2022
      • Install Parallels RAS Reporting
      • Running Parallels RAS Reports
      • GDPR compliance
    • Performance monitor
      • Overview
      • Install RAS Performance Monitor
      • Using Parallels RAS Performance Monitor
      • Configure RAS Performance Monitor security
      • Updating RAS Performance Monitor
    • Common Management Tasks
      • Recovery – add a root administrator
      • Host name resolution
      • Computer management tools
      • Site information
      • Site settings
      • Using MSIX application packages
      • Using template versions
      • Settings audit
      • Upgrading RAS agents
      • Licensing
      • Configure HTTP proxy settings
      • System event notifications
        • Configuring notification handlers
        • Configuring notification scripts
        • Configuring SMTP server connection for event notifications
      • RAS session variables
      • Resolving z-order issues
      • Maintenance and backup
        • Importing and exporting Farm settings from the command line
      • Problem reporting and troubleshooting
      • Logging
      • Suggest a feature
    • Parallels RAS Management Portal
      • Overview
      • Prerequisites
      • Installation
      • Log in to RAS Management Portal
      • Configure RAS Web Administration Service
      • RAS Management Portal user interface
    • Parallels RAS APIs
      • RAS PowerShell API
      • RAS REST API
        • Installation
        • Permissions
        • Getting started
        • Logging in and sending requests
        • More information
      • RAS Web Client API and Parallels Client URL scheme
    • Appendix
      • Microsoft license requirements in Parallels RAS
      • Port reference
        • Parallels Client
        • Web browsers
        • HALB
        • RAS Secure Gateway
        • RAS Connection Broker
        • RAS Console
        • SSRS
        • RAS Reporting
        • RAS Web Administration Service (REST/Management Portal)
        • RAS PowerShell
        • RAS Provider Agent
        • RAS Enrollment Server
        • RAS RD Session Host Agent
        • RAS Guest Agent
        • RAS Remote PC Agent
        • Tenant Broker
        • Active Directory and Domain Services ports
        • Azure Virtual Desktop
      • RAS performance counters
Powered by GitBook

© 2025 Parallels International GmbH. All rights reserved.

On this page

Was this helpful?

Export as PDF
  1. Parallels RAS 20 Administrator’s Guide
  2. RAS Multi-Tenant Architecture
  3. Deploying Tenant Broker and Tenants
  4. Deploying a Tenant

Join a Tenant to Tenant Broker

PreviousDeploying a TenantNextJoining with a secret key

Was this helpful?

Once the Tenant Farm is operational, you can join one or more sites in it to the Tenant Broker.

Note: A Tenant is a Site in a separately deployed Parallels RAS Farm. When you join a Tenant to Tenant Broker, you join a Site. When you want to join the whole Farm, you do it one Site at a time. Of course, if you have just one Site in a Farm (and have no plans to create more sites), you are essentially joining the whole Farm.

There are two ways you can join a Tenant: (1) Using an invitation hash or (2) Using a shared secret key. The difference between the two is as follows:

  • Invitation hash. An invitation hash is an automatically generated encrypted string that can be used to join a single Tenant to Tenant Broker. Invitation hash is a property of a Tenant object, which is created in the Tenant Broker console. You email the hash to the Tenant Farm administrator, so they can use it to join the Tenant Broker. Once used, an invitation hash cannot be used again by any other Tenant.

  • Shared secret key. A shared secret key is similar to an invitation hash, with one important difference. It can be used to join an unlimited number of Tenants. A Tenant object is not pre-created for a secret key in the Tenant Broker. Instead, the object is created when the key is used to join a Tenant. Because of its unlimited usage capability, only the Tenant Broker admins should have access to a shared secret key. This scenario is useful when there are multiple Tenants, all managed by the same Tenant Broker administrator.

The invitation hash scenario is described below. For the secret key scenario see .

First, you need to generate an invitation hash and create a Tenant object on the Tenant Broker side:

  1. Log in to the Tenant Broker.

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

  3. Click Tasks > Add.

  4. In the Tenant properties dialog, specify the following:

    • Name: Type a Tenant name (this can be any name that you like).

    • Public domain address: If you've already assigned a public domain address to the Tenant, specify it here. If not, you can leave it blank. The address is not required for the Tenant to join the Tenant Broker. However, without the address specified here, end users will not be able to connect to the Tenant, so you will need to come back and fill it in later. For details, see .

    • Clients in gateway mode connect to published tenant resources by server IP: When selected, clients will use the Tenant IP address instead of the DNS name. You can use this option when a Tenant farm does not share the same DNS provider as the Tenant Broker farm.

    • Do not show billing information: When selected, billing information is not shown in the category of the Tenant.

    • Description: Type an optional description.

    • Connection Brokers: This filed is disabled and will be populated automatically when the Tenant joins the Tenant Broker. See more in .

    • Tenant invitation hash: This is the hash that the admin of the Tenant Farm will need to use to join the Tenant Broker. A hash is generated automatically when you open this dialog. To generate a new hash, click Create new hash.

    • Send via email. You can give the invitation hash to the Tenant admin directly or you can use this button to send it via email. When you click the button, you'll see a dialog where you can enter the recipients and where you can review and modify the email message. By default, the message contains instructions on how to join the Tenant Broker. Please note that SMTP settings must be configured in the RAS Console before you can use the email option. You can configure SMTP first and then return to this screen to complete this step.

  5. Click OK to close the Tenant properties dialog. The new Tenant will appear in the Tenants list in the console. At this time, the Tenant is not joined yet. Read on to learn how to join it.

To join the Tenant to the Tenant Broker:

  1. Log in to the Tenant Farm.

  2. In the RAS console, navigate to Farm > Site. Note that you are joining a Site to the Tenant Broker, not the whole Farm, so if you have more than one Site, you need to join them one by one.

  3. Click Tasks > Join Tenant Broker.

  4. In the Join Tenant Broker dialog, enter the invitation hash that you obtained from the Tenant Broker in the previous steps (or, if you are an admin of a Tenant Farm, the one your received in the invitation email).

  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 Tenant's RAS Connection Broker running.

Overriding Tenant Broker IP address

The Tenant Broker IP address is detected automatically when you generate an invitation hash (or a secret key) and is embedded into the hash. 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.

When done, the specified IP address will be used instead of the auto-detected address when generating an invitation hash or secret key. When the hash is used on the Tenant side to join the Tenant Broker, the Tenant will use this address to connect to the Tenant Broker.

Once used on the Tenant side, an invitation hash binds the Tenant Farm to the corresponding Tenant object in the Tenant Broker and the tenancy becomes effective.

Joining with a secret key
Assign a public domain address
Licensing
Tenant configuration