UiPath Orchestrator

The UiPath Orchestrator Guide

Cluster Installation

The cluster installation of Orchestrator means creating a farm of 2 or more Orchestrator servers or nodes, under a Network Load Balancer, for a High Availability architecture.

First Node

  1. When running the installation script, if the clusterMode parameter is neither omitted nor set to Off, it should be set to FirstNode on the first machine.



This option creates a .json file at the end of the installation. The name of the file has to be provided as a parameter via -parametersFile in the other installations, which need to use -clusterMode OtherNode.

  1. A cluster installation requires the session information to be saved and shared among the nodes. The session information can be stored either in the SQL Server database or in Redis - an in-memory database. It is strongly recommended to use Redis to store the session because there are several components dependant on it such as notifications, cache permissions and settings, and the NuGet cache.
  2. While installing the first node, the -installRedis switch and the -signalrSessionStore Redis parameter need to be specified. -redisServer and -redisPort can be omitted for the First Node, because they will use the default localhost and 6379 values.
  3. Another parameter that needs to be overwritten is -packagesPath. This should be a shared folder. All the nodes need to have read/write access to it. You can create this shared folder on one of the Orchestrator nodes and use the UNC path on all the nodes. For example: -packagesPath "\\OrchestratorNode1\Artifacts\Packages".
  4. Do not provide the -parametersFile parameter, because a .json file with the parameters.json name is generated automatically.

Examples of usage:
.\Install-Orchestrator.ps1 -clusterMode FirstNode -iisWebSiteName OrchestratorMultiNode -sslCertificate machine.domain.local -redisServer localhost -redisPassword 1234 -useAppPoolIdentity -signalrSessionStore Redis -useSQLAuthentication -dbServerInstance .\sqlexpress -dbServerUsername dbUser -dbServerPassword 1234

Other Nodes

  1. Copy the file that was generated on the first node. Its name is parameters.json. Its location is the folder where the installation script was executed. Place the file in the installation folder of the other nodes.
  2. Use the -clusterMode OtherNode parameter and the full command line when running the installation script, such as:
    .\Install-Orchestrator.ps1 -clusterMode OtherNode -iisWebSiteName OrchestratorMultiNode -sslCertificate machine.domain.local -redisServer localhost -redisPassword 1234 -useAppPoolIdentity -signalrSessionStore Redis -useSQLAuthentication -dbServerInstance .\sqlexpress -dbServerUsername dbUser -dbServerPassword 1234 -parametersFile parameters.json.

Updated 3 years ago

Cluster Installation

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.