- Getting Started
- Requirements
- Best Practices
- Installation
- Updating
- Identity Server
- High Availability Add-on
Command Line Parameters
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.
UiPathPlatformInstaller.exe
does not accept command line arguments.
Parameter |
Description |
---|---|
|
Enables you to install the specified UiPath features in passive mode. A limited user interface, consisting of a progress bar and error popups, is displayed. Passive installations are the recommended choice. |
|
Helps you install the specified UiPath features silently, without displaying the user interface. Silent mode should only be used for unattended installations. |
|
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. |
|
Enables you to select what features you want to install. It supports the following options:
|
|
Enables you to input the encryption key used by the previous version of Orchestrator when updating and wanting to use the same database as before. Note: Only an existing database from Orchestrator versions prior to
v2020.4 can be used, and requires passing the IS_DATABASE_NAME and PUBLIC_URL parameters for Identity Server.
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 Database Parameters detailed below. |
|
The license key to your NuGet account. If the activities and packages are stored in the same NuGet feed, the value of this parameter and
APP_NUGET_ACTIVITIES_KEY must be the same.
|
|
The license key to your NuGet account. If the activities and packages are stored in the same NuGet feed, the value of this parameter and
APP_NUGET_PACKAGES_KEY must be the same.
|
|
Enables you to pass the following parameters in a
.json file:
|
|
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
UiPath.Orchestrator.dll.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 .
|
Command |
Description |
---|---|
|
Enables you to install Orchestrator in a custom location. By default, Orchestrator is installed in
C:\Program Files (x86)\UiPath\Orchestrator .
|
|
The name of your Orchestrator website. Editing this parameter is not recommended. |
|
The device on which Orchestrator is installed. |
|
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.
If another port is used, be sure to append it to the
PUBLIC_URL Identity Server parameter as detailed below.
|
|
Enables you to indicate if a validation of the website port availability is performed. The available options are:
Note: Submitting any value to this parameter causes the corresponding checkbox in the UI to appear as checked, even though the
port is validated only if the parameter value is 1.
|
|
Enables you to indicate if firewall rules are automatically added for this port. The available options are:
Note: Submitting any value to this parameter causes the corresponding checkbox in the UI to appear as checked, even though the
firewall rule is created only if the parameter value is 1.
|
|
The name of the SSL certificate you want to use to secure connections with Orchestrator. If not specified, by default the full computer name is used. |
Command |
Description |
---|---|
|
The name of the Application Pool used for Orchestrator. |
|
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 .
|
|
The username running the application pool. This parameter needs to be included only if
APPPOOL_IDENTITY_TYPE was set to USER .
|
|
The password of the user running the application pool. This parameter needs to be included only if
APPPOOL_IDENTITY_TYPE was set to USER .
|
Parameter |
Description |
---|---|
|
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.
|
|
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 (pre-v20.4 only) do so by specifying the APP_ENCRYPTION_KEY parameter.
|
|
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.
|
|
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.
|
|
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.
|
|
Enables you to configure specific settings (such as
MultiSubnetFailover=True ) for the connection to the main Orchestrator database.
Use this connection string as an alternative to the existing database parameters (individual server instance, database name, database username, etc.). It can be used either for clean installations or upgrades, in silent mode. |
v20.4
Orchestrator versions) and not during any subsequent upgrade(s).
Parameter |
Description |
---|---|
|
The name of the database you want Identity Server to use. The default value is the name of the Orchestrator database. |
|
The server where the Identity Server database is created. The default value is the Orchestrator server, but it can be changed. |
|
Enables you to choose the authentication method for the database. It can have the following values:
WINDOWS or SQL .
|
|
The SQL database user. To be used only if you choose the SQL authentication method. |
|
The SQL database user password. To be used only if you choose the SQL authentication method. |
|
The Orchestrator URL to which the Identity Server connects. If a port other than the default (
443 ) is used, it must be appended to this URL.
For single node installations, the default value is the name of the machine where Orchestrator is being installed. For example,
PUBLIC_URL = https://mymachine.domain.local:<custom_port> For multi-node installations, it is the URL of the load balancer. For example,
PUBLIC_URL = https://orchestrator.mydomain.local:<custom_port> |
|
The name (
Subject ) of the certificate used to sign access tokens used for authentication between Orchestrator and Identity Server.
Important: This parameter is mandatory. Orchestrator-Identity Server integration does not work if different certifications are used
for Identity Server.
|
|
Enables you to configure specific settings (such as
MultiSubnetFailover=True ) for the connection to the Identity Server database.
Use this connection string as an alternative to the existing database parameters (individual server instance, database name, database username, etc.). It can be used either for clean installations or upgrades, in silent mode. |
Parameter |
Description |
---|---|
|
The name of the Insights database specified when installing Orchestrator. |
|
Used to identify the device on which Insights is installed. By default this is set to the machine host name but can be edited. This name must be resolvable from an external server. |
|
Enables you to choose the authentication method for the Insights database. It can have the following two parameters
WINDOWS or SQL .
|
|
To be used only if you chose the SQL authentication method. The SQL database user. |
|
Enables you to configure specific settings (such as
MultiSubnetFailover=True ) for the connection to the Insights database.
Use this connection string as an alternative to the existing database parameters (individual server instance, database name, database username, etc.). It can be used either for clean installations or upgrades, in silent mode. |
Parameter |
Description |
---|---|
|
The name of the Test Automation database. This may be the same as the Orchestrator database. This parameter is mandatory when installing Test Automation. |
|
The name of the server on which the Test Automation database that you want to use is located. The following special characters
are not supported: an empty space,
\ , / , * , : , ? , " , < , > , | . The maximum length is set to 123 characters.
This parameter is mandatory when installing Test Automation. |
|
Enables you to choose the authentication method for the Test Automation database. It can have the following two parameters:
WINDOWS or SQL .
|
|
The SQL database user is used to connect to the Test Automation database. Use this only if you chose the SQL authentication method. |
|
The SQL database password is used to connect to the Test Automation database. Use this only if you chose the SQL authentication method. |
|
Enables you to configure specific settings (such as
MultiSubnetFailover=True ) for the connection to the Test Automation database.
Use this connection string as an alternative to the existing database parameters (individual server instance, database name, database username, etc.). It can be used either for clean installations or upgrades, in silent mode. |
Parameter |
Description |
---|---|
|
The Elasticsearch URL to which you want to log information. |
|
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.
|
|
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 .
|
|
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 .
|
Parameter |
Description |
---|---|
|
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. |
|
Optional. Enables you to enforce a password reset on the first login for the host administrator . If this parameter is omitted, the host admin password is not a one-time password. Please note that this parameter can only be used in conjunction with
HOSTADMIN_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. |
|
Optional. Enables you to enforce a password reset on the first login for the default tenant administrator. If this parameter is omitted, the tenant admin password is not a one-time password. Please note that this parameter can only be used in conjunction with
DEFAULTTENANTADMIN_PASSWORD .
|
|
Enables you to select whether Orchestrator may be accessed using the Windows credentials. The available options are:
|
|
The Windows domain from which Orchestrator can be accessed. Only required if
WINDOWS_AUTHENTICATION is enabled.
|
Parameter |
Description |
---|---|
|
The name of your Redis server, for example
my.redis.local .
For multinode deployments:
node1.redis.local,node2.redis.local,node3.redis.local .
|
|
The password for your Redis server. Required only when using the
REDIS_HOST parameter.
|
|
The port used for your Redis server. If not provided, the default Redis port (
6379 ) is used.
|
|
Used to indicate if the Quartz scheduling framework used for Jobs scheduling is clustered. The available options are:
|
|
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.
|
|
Used to define where NuGet packages are saved when using a
Composite repository type.
The available options are:
Mandatory for silent upgrades, if you previously used a
Legacy repository to store packages.
|
|
Required only when using the
STORAGE_TYPE parameter.
The location where the NuGet packages are saved. Mandatory for silent upgrades, if you previously used a
Legacy repository to store packages.
|
|
Used to specify the file name (or path) in order for
Orchestrator.msi to generate a json file with all the installation parameters.
In multi-node scenarios, generate this file on the first node and then use it on all the other nodes. |
UiPathOrchestrator.msi
installer is located. You can do this with the following command, for example: cd D:\UiPathOrchestrator.msi
.
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 /passive
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 /passive
Update a previous Orchestrator installation adding Test Automation feature, and use the same database as before:
UiPathOrchestrator.msi ADDLOCAL=TestAutomationFeature APPPOOL_IDENTITY_TYPE=USER APPPOOL_USER_NAME=serviceAccount APPPOOL_PASSWORD=1234qwer TA_DATABASE_NAME=UiPath APP_ENCRYPTION_KEY=11111hkaXLwR9LZoBZIuTIxG3GIEB/YMDpUFhD8AR4
UiPathOrchestrator.msi ADDLOCAL=TestAutomationFeature APPPOOL_IDENTITY_TYPE=USER APPPOOL_USER_NAME=serviceAccount APPPOOL_PASSWORD=1234qwer TA_DATABASE_NAME=UiPath 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
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
- A sample parameters
.json
file:{ { "Properties": [ { "Name": "ADDLOCAL", "Value": "OrchestratorFeature" }, { "Name": "REMOVE", "Value": "" }, { "Name": "ORCHESTRATORFOLDER", "Value": "C:\\or_dir" }, { "Name": "WEBSITE_NAME", "Value": "UiPath Orchestrator" }, { "Name": "WEBSITE_HOST", "Value": "corp.uipath.com" }, { "Name": "WEBSITE_PORT", "Value": "443" }, { "Name": "WEBSITE_PORT_DO_VALIDATE", "Value": "1" }, { "Name": "WEBSITE_PORT_FIREWALL", "Value": "1" }, { "Name": "CERTIFICATE_SUBJECT", "Value": "corp.uipath.com" }, { "Name": "APPPOOL_NAME", "Value": "UiPath Orchestrator" }, { "Name": "APPPOOL_IDENTITY_TYPE", "Value": "APPPOOLIDENTITY" }, { "Name": "APPPOOL_USER_NAME", "Value": "documentation" }, { "Name": "APPPOOL_PASSWORD", "Value": "password" }, { "Name": "DB_SERVER_NAME", "Value": "." }, { "Name": "DB_DATABASE_NAME", "Value": "UiPath" }, { "Name": "DB_AUTHENTICATION_MODE", "Value": "SQL" }, { "Name": "DB_USER_NAME", "Value": "doc" }, { "Name": "DB_PASSWORD", "Value": "db_password" }, { "Name": "ELASTIC_URL", "Value": "" }, { "Name": "ELASTIC_REQUIRES_AUTH", "Value": "" }, { "Name": "ELASTIC_USER_NAME", "Value": "" }, { "Name": "ELASTIC_USER_PASSWORD", "Value": "" }, { "Name": "HOSTADMIN_PASSWORD", "Value": "host_password" }, { "Name": "HOSTADMIN_PASSWORD_ONETIME", "Value": "1" }, { "Name": "DEFAULTTENANTADMIN_PASSWORD", "Value": "tenant_password" }, { "Name": "DEFAULTTENANTADMIN_PASSWORD_ONETIME", "Value": "0" }, { "Name": "WINDOWS_AUTHENTICATION", "Value": "" }, { "Name": "DOMAIN", "Value": "" }, ] }
{ { "Properties": [ { "Name": "ADDLOCAL", "Value": "OrchestratorFeature" }, { "Name": "REMOVE", "Value": "" }, { "Name": "ORCHESTRATORFOLDER", "Value": "C:\\or_dir" }, { "Name": "WEBSITE_NAME", "Value": "UiPath Orchestrator" }, { "Name": "WEBSITE_HOST", "Value": "corp.uipath.com" }, { "Name": "WEBSITE_PORT", "Value": "443" }, { "Name": "WEBSITE_PORT_DO_VALIDATE", "Value": "1" }, { "Name": "WEBSITE_PORT_FIREWALL", "Value": "1" }, { "Name": "CERTIFICATE_SUBJECT", "Value": "corp.uipath.com" }, { "Name": "APPPOOL_NAME", "Value": "UiPath Orchestrator" }, { "Name": "APPPOOL_IDENTITY_TYPE", "Value": "APPPOOLIDENTITY" }, { "Name": "APPPOOL_USER_NAME", "Value": "documentation" }, { "Name": "APPPOOL_PASSWORD", "Value": "password" }, { "Name": "DB_SERVER_NAME", "Value": "." }, { "Name": "DB_DATABASE_NAME", "Value": "UiPath" }, { "Name": "DB_AUTHENTICATION_MODE", "Value": "SQL" }, { "Name": "DB_USER_NAME", "Value": "doc" }, { "Name": "DB_PASSWORD", "Value": "db_password" }, { "Name": "ELASTIC_URL", "Value": "" }, { "Name": "ELASTIC_REQUIRES_AUTH", "Value": "" }, { "Name": "ELASTIC_USER_NAME", "Value": "" }, { "Name": "ELASTIC_USER_PASSWORD", "Value": "" }, { "Name": "HOSTADMIN_PASSWORD", "Value": "host_password" }, { "Name": "HOSTADMIN_PASSWORD_ONETIME", "Value": "1" }, { "Name": "DEFAULTTENANTADMIN_PASSWORD", "Value": "tenant_password" }, { "Name": "DEFAULTTENANTADMIN_PASSWORD_ONETIME", "Value": "0" }, { "Name": "WINDOWS_AUTHENTICATION", "Value": "" }, { "Name": "DOMAIN", "Value": "" }, ] }Important: Theparameters.json
file contains sensitive information about the Orchestrator installation, as well as credentials necessary for subsequent installations. Make sure this file is kept in a secure location.
Clean install Orchestrator using connection strings to connect to all four available databases:
- main Orchestrator database
- Identity Server database
- Insights database
- Test Automation database
UiPathOrchestrator.msi ADDLOCAL=TestAutomationFeature,InsightsFeature ` DB_CONNECTION_STRING="Data Source=.\sqlexpress;Initial Catalog=UiPath;User Id=sa;Password=1qazXSW@;MultiSubnetFailover=True" ` IS_DB_CONNECTION_STRING="Data Source=.\sqlexpress;Initial Catalog=UiPathIdentity;User Id=sa;Password=1qazXSW@;MultiSubnetFailover=True" ` DB_INSIGHTS_CONNECTION_STRING="Data Source=.\sqlexpress;Initial Catalog=UiPathInsights;User Id=sa;Password=1qazXSW@;MultiSubnetFailover=True" ` TA_DB_CONNECTION_STRING="Data Source=.\sqlexpress;Initial Catalog=UiPathTestAutomation;User Id=sa;Password=1qazXSW@;MultiSubnetFailover=True" ` APPPOOL_USER_NAME=.\Test APPPOOL_PASSWORD=1qazXSW@ PUBLIC_URL=https://mymachine ` CERTIFICATE_SUBJECT=mycert IS_CERTIFICATE_SUBJECT=mycert HOSTADMIN_PASSWORD=1234qwer DEFAULTTENANTADMIN_PASSWORD=1234qwer ` /q
UiPathOrchestrator.msi ADDLOCAL=TestAutomationFeature,InsightsFeature ` DB_CONNECTION_STRING="Data Source=.\sqlexpress;Initial Catalog=UiPath;User Id=sa;Password=1qazXSW@;MultiSubnetFailover=True" ` IS_DB_CONNECTION_STRING="Data Source=.\sqlexpress;Initial Catalog=UiPathIdentity;User Id=sa;Password=1qazXSW@;MultiSubnetFailover=True" ` DB_INSIGHTS_CONNECTION_STRING="Data Source=.\sqlexpress;Initial Catalog=UiPathInsights;User Id=sa;Password=1qazXSW@;MultiSubnetFailover=True" ` TA_DB_CONNECTION_STRING="Data Source=.\sqlexpress;Initial Catalog=UiPathTestAutomation;User Id=sa;Password=1qazXSW@;MultiSubnetFailover=True" ` APPPOOL_USER_NAME=.\Test APPPOOL_PASSWORD=1qazXSW@ PUBLIC_URL=https://mymachine ` CERTIFICATE_SUBJECT=mycert IS_CERTIFICATE_SUBJECT=mycert HOSTADMIN_PASSWORD=1234qwer DEFAULTTENANTADMIN_PASSWORD=1234qwer ` /qImportant: Replace the newline character`
with the one specific to your command line shell.
Upgrade Orchestrator (2019.10 to 2020.10) using connection strings to connect to 3/4 available databases:
UiPathOrchestrator.msi ADDLOCAL=OrchestratorFeature,IdentityFeature,TestAutomationFeature,InsightsFeature `
DB_INSIGHTS_CONNECTION_STRING="Data Source=.\sqlexpress;Initial Catalog=UiPathInsights;User Id=sa;Password=1qazXSW@;MultiSubnetFailover=False" `
TA_DB_CONNECTION_STRING="Data Source=.\sqlexpress;Initial Catalog=UiPathTestAutomation;User Id=sa;Password=1qazXSW@;MultiSubnetFailover=False" `
IS_DB_CONNECTION_STRING="Data Source=.\sqlexpress;Initial Catalog=UiPathIdentity;User Id=sa;Password=1qazXSW@;MultiSubnetFailover=False" `
APPPOOL_USER_NAME=.\Test APPPOOL_PASSWORD=1qazXSW@ PUBLIC_URL=https://localmachine `
IS_CERTIFICATE_SUBJECT=myCert /q
UiPathOrchestrator.msi ADDLOCAL=OrchestratorFeature,IdentityFeature,TestAutomationFeature,InsightsFeature `
DB_INSIGHTS_CONNECTION_STRING="Data Source=.\sqlexpress;Initial Catalog=UiPathInsights;User Id=sa;Password=1qazXSW@;MultiSubnetFailover=False" `
TA_DB_CONNECTION_STRING="Data Source=.\sqlexpress;Initial Catalog=UiPathTestAutomation;User Id=sa;Password=1qazXSW@;MultiSubnetFailover=False" `
IS_DB_CONNECTION_STRING="Data Source=.\sqlexpress;Initial Catalog=UiPathIdentity;User Id=sa;Password=1qazXSW@;MultiSubnetFailover=False" `
APPPOOL_USER_NAME=.\Test APPPOOL_PASSWORD=1qazXSW@ PUBLIC_URL=https://localmachine `
IS_CERTIFICATE_SUBJECT=myCert /q
`
with the one specific to your command line shell.
- Command Line Arguments Descriptions
- Installation Parameters
- IIS Parameters
- Application Pool Parameters
- Database Parameters
- Identity Server Parameters
- Insights Parameters
- Test Automation Parameters
- Elasticsearch Parameters
- Authentication Parameters
- Multi-Node Configuration Parameters
- Examples
- Install Orchestrator in a custom location which is connected to an SQL database with SQL credentials:
- Update a previous Orchestrator installation adding Test Automation feature, and use the same database as before:
- Clean install Orchestrator and add custom one-time passwords for the default tenant admin and the host admin:
- Generate an installer log file and disable telemetry:
- Perform a Multi-node Orchestrator Installation