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!

The UiPathPlatformInstaller.exe does not accept command line arguments.

Installation Parameters

IIS Parameters

Command	Description
ORCHESTRATORFOLDER	Enables you to install Orchestrator in a custom location. By default, Orchestrator is installed in C:\Program Files (x86)\UiPath\Orchestrator.
WEBSITE_NAME	The name of your Orchestrator website, for example UiPath Orchestrator.
WEBSITE_HOST	The device on which Orchestrator is installed.
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.
WEBSITE_PORT_DO_VALIDATE	Enables you to select if a validation of the website port availability is performed. The available options are: 0 - No validation is performed. 1 - A validation is performed.
WEBSITE_PORT_FIREWALL	Enables you to select if firewall rules are automatically added for this port. The available options are: 0 - Firewall rules are not added. 1 - Firewall rules are added.
CERTIFICATE_SUBJECT	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. This parameter is mandatory for multi-node installations. Orchestrator-Identity Server integration does not work if different certificates are used on the different nodes of the installation.

Application Pool Parameters

Database Parameters

Identity Server Parameters

Insights Parameters

Test Automation Parameters

Elasticsearch Parameters

Authentication Parameters

Multi-Node Configuration Parameters

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 IS_CERTIFICATE_SUBJECT=SigningCertificate /Q
• 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 IS_CERTIFICATE_SUBJECT=SigningCertificate PUBLIC_URL=https://orchestrator.local
• 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
• Perform a multi-node Orchestrator installation:
  • Node 1: UiPathOrchestrator.msi OUTPUT_PARAMETERS_FILE=myconfig.json REDIS_HOST=redis.local REDIS_PASSWORD=1234 STORAGE_LOCATION=\\fileserver\share QUARTZ_CLUSTERED=1 and configure the rest of the parameters from the interface
  • Node 2 ... n: UiPathOrchestrator.msi PARAMETERS_FILE=myconfig.json SECONDARY_NODE=1 /Q
• 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_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!

The parameters.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.