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.

Installation Parameters

IIS Parameters

Application Pool Parameters

Database 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 /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
• 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": "0" },
        { "Name": "DOMAIN", "Value": "" },
    ]
}