Subscribe

UiPath Orchestrator

The UiPath Orchestrator Guide

Configure-PlatformNode.ps1 Parameters

The Configure-PlatformNode.ps1 script enables you to install Orchestrator in a multi-node environment or revert the load-balancing installation to a standalone one.

After you install Orchestrator on a machine, this script can be found, by default, in the C:\Program Files (x86)\UiPath\Orchestrator\Tools\Configure-PlatformNode.ps1 folder.

ParameterDescription
-mode <String>Required.
The following values are accepted:
ConfigurePrimary - enables you to configure the current installation of Orchestrator as the primary node. This helps you return a set of keys that are required on all secondary nodes.
ConfigureSecondary - enables you to configure the current installation of Orchestrator as a secondary node.
ConfigureStandalone - reverts the installation to a non load-balanced environment.
OutputCommand - prints the command necessary for configuring another node similar to the current one.
-websiteName "<String>"Required.
Enables you to specify the name of the Orchestrator web site.
-nugetPackagesPath <String>The path in which to store the Nuget workflow packages. In a load-balanced environment, this is usually a file share or a mapped drive.
-nugetActivitiesPath <String>The path in which to store the Nuget activities. In a load-balanced environment, this is usually a file share or a mapped drive. By default, it's the Activities subfolder of the nugetPackagesPath parameter.
-nugetPackagesApiKey <String>The Nuget API key for the workflows packages feed. Required for secondary Orchestrator nodes installations, in which the value needs to be the same with the one from the primary node.
-redisServer <String>Required for load-balanced installations, be it a primary or a secondary node.
The hostname of the Redis server shared by the Orchestrator nodes in a load-balanced environment.
-redisPassword <String>Required for load-balanced installations, be it a primary or a secondary node.
The password for the Redis server shared by the Orchestrator nodes in a load-balanced environment.
-redisPort <Nullable>The port for the Redis server shared by the Orchestrator nodes in a load-balanced environment.
Do not specify this parameter unless you want to overwrite the default Redis port.
-encryptionKey <String>Required for secondary node installations.
It represents the encryption key used by Orchestrator, and is returned by the script, after configuring the primary node.
This value needs to be the same as the one returned by the primary node.
-machineKeyDecryptionAlgorythm <String>The decryption algorithm used by the Orchestrator session state. Do not set in order to use the default values.
The following values are accepted:
Auto - the default value.
DES
3DES
AES
-machineKeyDecryptionKey <String>Required for secondary node installations. This value needs to be the same as the one returned by the primary node.
The decryption key used by the Orchestrator session state.
-machineKeyValidationAlgorythm <String>The validation algorithm used by the Orchestrator session state. Do not set in order to use the default values.
The following values are accepted:
SHA1 - the default value.
MD5
3DES
AES
-machineKeyValidationKey <String>Required for secondary node installations. This value needs to be the same as the one returned by the primary node.
The validation key used by the Orchestrator session state.
-leaveWebsiteStopped [<SwitchParameter>]By default, the website and the application pool are started after the configuration phase. Specify this flag to leave them stopped.
-outputCommandFile <String>A file name in which to save the configuration command for subsequent nodes. Used with -mode ConfigurePrimary or OutputCommand.

Examples

  1. Configuring a primary load-balanced Orchestrator node using Redis as common data store:
    PS C:\>.\Configure-PlatformNode.ps1 -mode ConfigurePrimary -websiteName UiPathOrchestrator2018.3 -nugetPackagesPath \\fileshare\NuGetPackages -redisServer redis.domain.local -redisPassword 1234
  2. Configuring a secondary load-balanced Orchestrator node:
    PS C:\>.\Configure-PlatformNode.ps1 -mode ConfigureSecondary -websiteName UiPathOrchestrator2018.3 -nugetPackagesPath \\fileshare\NuGetPackages -nugetPackagesApiKey "1111-PUT-YOUR-GUID-HERE-11111" -redisServer redis.domain.local -redisPassword 1234 -encryptionKey "myPrimaryNodeEncryptionKey" -machineKeyDecryptionKey "myPrimaryNodeMachineDecryptionKey" -machineKeyValidationKey "myPrimaryNodeMachineValidationKey"
  3. Reverting the configuration of an Orchestrator load-balanced node to a standalone installation:
    PS C:\>.\Configure-PlatformNode.ps1 -mode ConfigureStandalone -websiteName UiPathOrchestrator2018.3 -nugetPackagesPath "~/NugetPackages"
  4. Saving the commands necessary for configuring secondary nodes to an indicated file:
    PS C:\>.\Configure-PlatformNode.ps1 -mode OutputCommand -websiteName UiPathOrchestrator2018.3 -outputCommandFile 'Install-Secondary.ps1'

Updated 2 years ago



Configure-PlatformNode.ps1 Parameters


Suggested Edits are limited on API Reference Pages

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