UiPath Orchestrator Guide

Command Line Parameters

Command Line Arguments Descriptions

It is possible to install or update the entire UiPath suite using the command line, provided you have the UiPath Orchestrator Windows installer (UiPathOrchestrator.msi). The table below lists all the available parameters you can use with Orchestrator, paired with some examples.

For the command line arguments that can be used with Studio and Robot, please see this topic.

Important!

Changes to your existing instance of the UiPath Orchestrator cannot be made from the Command Prompt, in silent mode. However, changes to what is installed when performing an update are fully supported.

The UiPathPlatformInstaller.exe does not accept command line arguments.

Command
Description

/q

Helps you install the specified UiPath features silently, without displaying the user interface.

/l*vx <LogFile>

Generates an installer log file at the specified path. You can send the file further to our support team if, for any reason, you encounter difficulties during the installation process.

ADDLOCAL

Enables you to add select what features you want to install. It supports the following options:

  • OrchestratorFeature - Indicates that you want to install Orchestrator.

ORCHESTRATORFOLDER

Enables you to install Orchestrator in a custom location. By default, Orchestrator is installed in C:\Program Files (x86)\UiPath\Orchestrator.

WEBSITE_PORT

The port you want to use to enable the communication between the computer and Orchestrator. If not specified, the default value, 443, is used to enable you to use HTTPS.

CERTIFICATE_SUBJECT

The name of the SSL certificate you want to use to secure connections with Orchestrator. If not specified, the default, the full computer name, is used.

APPPOOL_IDENTITY_TYPE

It can only be used with the Orchestrator feature. The type of application pool you are using for Orchestrator. It supports the following values: USER and APPPOOLIDENTITY
with Orchestrator.

APPPOOL_USER_NAME

The username running the application pool. This parameter needs to be included only if APPPOOL_IDENTITY_TYPE was set to USER.

APPPOOL_PASSWORD

The password of the user running the application pool. This parameter needs to be included only if APPPOOL_IDENTITY_TYPE was set to USER.

DB_CONNECTION_STRING

It can only be used on the first Orchestrator installation and with the Orchestrator feature. A connection string that can be used to automatically connect to your SQL database.
In silent mode (/Q) you are required to use the following parameters to connect to an SQL database:

  • DB_SERVER_NAME - the name of the server on which the database you want to use is located. Please note that the following special characters are not supported: an empty space, \, /, *, :, ?, ", <, >, |, and the maximum length is 123 characters.
  • DB_DATABASE_NAME - the name of the database you want to connect to;
  • DB_AUTHENTICATION_MODE - enables you to choose the authentication method for the database.
    It can have the following two parameters WINDOWS or SQL.
  • DB_USER_NAME - To be used only if you chose the SQL authentication method. The SQL database user.
  • DB_PASSWORD - To be used only if you chose the SQL authentication method. The SQL database user password.

ELASTIC_URL

Optional. The Elasticsearch URL to which you want to log information.

ELASTIC_REQUIRES_AUTH

Optional. Enables you to indicate if your Elasticsearch instance requires authentication. If set to true, you are required to also provide the ELASTIC_USER_NAME and ELASTIC_USER_PASSWORD parameters.

ELASTIC_USER_NAME

Optional. Enables you to specify your Elastisearch username. To use this parameter, ensure that you set ELASTIC_REQUIRES_AUTH to true.
For example, ELASTIC_USER_NAME=myuser.

ELASTIC_USER_PASSWORD

Optional. Enables you to specify your Elasticsearch password. To use this parameter, ensure that you set ELASTIC_REQUIRES_AUTH to true.
For example, ELASTIC_USER_PASSWORD=pass.

APP_ENCRYPTION_KEY

Enables you to input the encryption key used in the previous version of Orchestrator.
It is required only when updating an older version of Orchestrator that was installed with the scripts. For more information, click here.

SECONDARY_NODE

Enables you to install Orchestrator secondary nodes. It must be added as follows: SECONDARY_NODE=1.

Examples

These examples have been written considering that you are already in the directory in which the UiPathOrchestrator.msi installer is located. You can do this with the following command, for example: cd D:\UiPathOrchestrator.msi.

  • Install Orchestrator and connect to an SQL database. This can also be used to update a previous installation that did not include Orchestrator - UiPathOrchestrator.msi ADDLOCAL=OrchestratorFeature APPPOOL_IDENTITY_TYPE=USER APPPOOL_USER_NAME=serviceAccount APPPOOL_PASSWORD=1234qwer DB_CONNECTION_STRING="Server=.\sqlexpress;Trusted_Connection=True;Database=UiPath"
  • Sillently install Orchestrator in a custom location and connected to an SQL database with SQL credentials:
    UiPathOrchestrator.msi ADDLOCAL=OrchestratorFeature ORCHESTRATORFOLDER=C:\UiPathOrchestrator APPPOOL_IDENTITY_TYPE=USER APPPOOL_USER_NAME=serviceAccount APPPOOL_PASSWORD=1234qwer DB_SERVER_NAME=.\sqlexpress DB_DATABASE_NAME=UiPath DB_AUTHENTICATION_MODE=SQL DB_USER_NAME=SQLUSER DB_PASSWORD=SQLUSERPASSWORD /Q
  • Update a previous installation that included Orchestrator - UiPathOrchestrator.msi ADDLOCAL=OrchestratorFeature APPPOOL_IDENTITY_TYPE=USER APPPOOL_USER_NAME=serviceAccount APPPOOL_PASSWORD=1234qwer
  • Generate an installer log file:
    UiPathOrchestrator.msi /l*vx log.txt

Important!

It is recommended to update Orchestrator in an attended mode, as the database is created or updated at setup. As a result, during the update process, you are prompted if you want to use an existing database or create a new one.