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.

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_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.

It can only be used on the first Orchestrator installation, with the Orchestrator feature and all the other database specific parameters. If you want to use the database of a previous installation, do so by specifying the APP_ENCRYPTION_KEY parameter.

DB_DATABASE_NAME

The name of the database you want to connect to.

It can only be used on the first Orchestrator installation, with the Orchestrator feature and all the other database specific parameters. If you want to use the database of a previous installation, do so by specifying the APP_ENCRYPTION_KEY parameter.

DB_AUTHENTICATION_MODE

Enables you to choose the authentication method for the database. It can have the following two parameters WINDOWS or SQL.

It can only be used on the first Orchestrator installation, with the Orchestrator feature and all the other database specific parameters. If you want to use the database of a previous installation, do so by specifying the APP_ENCRYPTION_KEY parameter.

DB_USER_NAME

To be used only if you chose the SQL authentication method. The SQL database user.

It can only be used on the first Orchestrator installation, with the Orchestrator feature and all the other database specific parameters. If you want to use the database of a previous installation, do so by specifying the APP_ENCRYPTION_KEY parameter.

DB_PASSWORD

To be used only if you chose the SQL authentication method. The SQL database user password.

It can only be used on the first Orchestrator installation, with the Orchestrator feature and all the other database specific parameters. If you want to use the database of a previous installation, do so by specifying the APP_ENCRYPTION_KEY parameter.

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 a previous version of Orchestrator. It's relevant for upgrades from v2016.2 or in clean installations when you want to use the same database as before.

You do not need to specify the name of the database, as the installer checks according to the one previously used.

If you do not want to use the database from your previous installation, provide the details of the new one using the DB_SERVER_NAME, DB_DATABASE_NAME, DB_AUTHENTICATION_MODE, DB_USER_NAME, and DB_PASSWORD parameters.

HOSTADMIN_PASSWORD

Mandatory. Enables you to set a custom password for the host administrator. Please note that passwords have to be least 8 characters long, and must have at least one lowercase character and at least one digit.

HOSTADMIN_PASSWORD_ONETIME

Optional. Enables you to enforce a password reset on the first login for the host administrator. This is also called a one-time password.
It can have the following values:

  • 1 - the host administrator password needs to be reset on the first login;
  • 0 - the host admin password does not need to be reset on the first login.

Please note that this parameter can only be used in conjunction with HOSTADMIN_PASSWORD.

If you omit this parameter, the host admin password is not a one-time one.

DEFAULTTENANTADMIN_PASSWORD

Mandatory. Enables you to set a custom password for the default tenant administrator. Please note that passwords have to be least 8 characters long, and must have at least one lowercase character and at least one digit.

DEFAULTTENANTADMIN_PASSWORD_ONETIME

Optional. Enables you to enforce a password reset on the first login for the default tenant administrator. This is also called a one-time password.
It can have the following values:

  • 1 - the default tenant administrator password needs to be reset on the first login;
  • 0 - the default tenant administrator password does not need to be reset on the first login.

Please note that this parameter can only be used in conjunction with DEFAULTTENANTADMIN_PASSWORD.

If you omit this parameter, the default tenant admin password is not a one-time one.

TELEMETRY_ENABLED

Enables or disables the usage and performance data collection that UiPath uses to diagnose problems and improve Orchestrator. For more details about UiPath’s privacy practices, please review the privacy statement.

When used, this parameter changes the value of a web.config key named Telemetry.Enabled.

If set to 0 (TELEMETRY_ENABLED=0), the telemetry feature is disabled, and the Telemetry.Enabled key is set to false.

If set to 1 (TELEMETRY_ENABLED=1), the telemetry feature is enabled, and the Telemetry.Enabled key is set to true.

The TELEMETRY_ENABLED parameter can also be added when updating your Orchestrator instance. If omitted, the previous value is preserved.

If the key was missing in the previous version of Orchestrator and you do not provide the TELEMETRY_ENABLED parameter during the update, Telemetry.Enabled is automatically set to true.

CONFIGURATION_FOLDER

The folder in which you saved your web.config and MigrationHistory.txt files, required in secondary node installations of Orchestrator. For more information on how to deploy Orchestrator in a multi-node environment, please see this page.

SECONDARY_NODE

Enables you to install Orchestrator secondary nodes. It must be added as follows: SECONDARY_NODE=1. For more information on how to deploy Orchestrator in a multi-node environment, please see this page.

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.

  • Silently install Orchestrator in a custom location which is connected to an SQL database with SQL credentials:
    UiPathOrchestrator.msi 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 Orchestrator installation and use the same database as before: UiPathOrchestrator.msi APPPOOL_IDENTITY_TYPE=USER APPPOOL_USER_NAME=serviceAccount APPPOOL_PASSWORD=1234qwer APP_ENCRYPTION_KEY=11111hkaXLwR9LZoBZIuTIxG3GIEB/YMDpUFhD8AR4
  • Clean install Orchestrator and add custom one-time passwords for the default tenant admin and the host admin: UiPathOrchestrator.msi APPPOOL_IDENTITY_TYPE=USER APPPOOL_USER_NAME=serviceAccount APPPOOL_PASSWORD=1234qwer HOSTADMIN_PASSWORD=Pass1234 HOSTADMIN_PASSWORD_ONETIME=1 DEFAULTTENANTADMIN_PASSWORD=Pass0987 DEFAULTTENANTADMIN_PASSWORD_ONETIME=1
  • Generate an installer log file and disable telemetry:
    UiPathOrchestrator.msi TELEMETRY_ENABLED=0 /l*vx log.txt


Command Line Parameters


Suggested Edits are limited on API Reference Pages

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