Abonnieren

UiPath Installation and Upgrade

Die UiPath-Installations- und Upgrade-Anleitung

Kommandozeilenparameter

Beschreibung der Kommandozeilenargumente

Es ist möglich, die gesamte UiPath Suite über die Befehlszeile zu installieren, vorausgesetzt, Sie verfügen üben den UiPath Orchestrator Windows Installer (UiPathOrchestrator.msi). Die folgende Tabelle listet alle verfügbaren Parameter, die Sie verwenden können, gepaart mit einigen Beispielen.

Für Kommandozeilenargumente, die mit Studio und Robotern verwendet werden können, sehen Sie bitte unter diesem Thema nach.

Installationsparameter

ParameterDescription
/passiveEnables 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.
/qHelps you install the specified UiPath features silently, without displaying the user interface. Silent mode should only be used for unattended installations.
/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.
ADDLOCALEnables you to select what features you want to install.

It supports the following options:

OrchestratorFeature - install Orchestrator (mandatory).

IdentityFeature - install Identity Server(mandatory).

InsightsFeature - enables the Insights feature. This feature may be added/removed after installation by going to Add/Remove Programs and selecting Change on UiPath Orchestrator.

TestAutomationFeature - enables the Test Automation feature. This feature may be added/removed after installation by going to Add/Remove Programs and selecting Change on UiPath Orchestrator.
APP_ENCRYPTION_KEYEnables 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.
APP_NUGET_PACKAGES_KEYThe 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.
APP_NUGET_ACTIVITIES_KEYThe 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.
PARAMETERS_FILEEnables you to pass the following parameters in a .json file:
ORCHESTRATORFOLDER
WEBSITE_NAME
WEBSITE_PORT
WEBSITE_PORT_DO_VALIDATE
WEBSITE_PORT_FIREWALL
CERTIFICATE_SUBJECT
APPPOOL_NAME
APPPOOL_IDENTITY_TYPE
APPPOOL_USER_NAME
APPPOOL_PASSWORD
DB_SERVER_NAME
DB_DATABASE_NAME
DB_AUTHENTICATION_MODE
DB_USER_NAME
DB_PASSWORD
ELASTIC_URL
ELASTIC_REQUIRES_AUTH
ELASTIC_USER_NAME
ELASTIC_USER_PASSWORD
HOSTADMIN_PASSWORD_ONETIME
DEFAULTTENANTADMIN_PASSWORD_ONETIME
SECONDARY_NODE
PUBLIC_URL
DB_CONNECTION_STRING
IS_DB_CONNECTION_STRING
DB_INSIGHTS_CONNECTION_STRING
TA_DB_CONNECTION_STRING
UPDSVR_DB_CONNECTION_STRING
TELEMETRY_ENABLEDEnables 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.

IIS-Parameter

CommandDescription
ORCHESTRATORFOLDEREnables you to install Orchestrator in a custom location. By default, Orchestrator is installed in C:\Program Files (x86)\UiPath\Orchestrator.
WEBSITE_NAMEThe name of your Orchestrator website. Editing this parameter is not recommended.
WEBSITE_PORTThe 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.
WEBSITE_PORT_DO_VALIDATEAllows you to indicate if a validation of the website port availability is performed. The available options are:
0 - No validation is performed.
1 - A validation is performed.

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.
WEBSITE_PORT_FIREWALLEnables you to indicate if firewall rules are automatically added for this port. The available options are:
0 - Firewall rules are not added.
1 - Firewall rules are added.

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

Anwendungspoolparameter

CommandDescription
APPPOOL_NAMEThe name of the Application Pool used for Orchestrator.
APPPOOL_IDENTITY_TYPEIt 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.
APPPOOL_USER_NAMEThe username running the application pool. This parameter needs to be included only if APPPOOL_IDENTITY_TYPE was set to USER.
APPPOOL_PASSWORDThe password of the user running the application pool. This parameter needs to be included only if APPPOOL_IDENTITY_TYPE was set to USER.

Datenbankparameter

ParameterDescription
DB_SERVER_NAMEThe 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.
DB_DATABASE_NAMEThe 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.
DB_AUTHENTICATION_MODEEnables 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.
DB_USER_NAMETo 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.
DB_PASSWORDTo 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.
DB_CONNECTION_STRINGEnables 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.

Identity Server-Parameter

🚧

Wichtig!

Die folgenden Parameter sind nur während der Erstinstallation von Identity Server (d. h. erstmalige Installation von Orchestrator oder erstes Upgrade von Orchestrator-Versionen vor v20.4) und nicht während nachfolgender Upgrades erforderlich.

ParameterDescription
IS_DATABASE_NAMEThe name of the database you want Identity Server to use. The default value is the name of the Orchestrator database.
IS_DB_SERVER_NAMEThe server where the Identity Server database is created. The default value is the Orchestrator server, but it can be changed.
IS_DB_AUTHENTICATION_MODEEnables you to choose the authentication method for the database. It can have the following values: WINDOWS or SQL.
IS_DB_USER_NAMEThe SQL database user. To be used only if you choose the SQL authentication method.
IS_DB_PASSWORDThe SQL database user password. To be used only if you choose the SQL authentication method.
PUBLIC_URLThe 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>
IS_CERTIFICATE_SUBJECTThe name (Subject) of the certificate used to sign access tokens used for authentication between Orchestrator and Identity Server.

:warning: This parameter is mandatory. Orchestrator-Identity Server integration does not work if different certifications are used for Identity Server.
IS_DB_CONNECTION_STRINGEnables 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.

Serverparameter aktualisieren

ParameterDescription
UPDSVR_DATABASE_NAMEThe name of the Update Server database. This may be the same as the Orchestrator database.
UPDSVR_DB_SERVER_NAMEThe name of the server on which the Update Server 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.
UPDSVR_DB_AUTHENTICATION_MODEEnables you to choose the authentication method for the Update Server database. It can have the following two parameters: WINDOWS or SQL.
UPDSVR_DB_USER_NAMEThe SQL database user is used to connect to the Update Server database. Use this only if you chose the SQL authentication method.
UPDSVR_DB_PASSWORDThe SQL database password is used to connect to the Update Server database. Use this only if you chose the SQL authentication method.
UPDSVR_DB_CONNECTION_STRINGEnables you to configure specific settings (such as MultiSubnetFailover=True) for the connection to the Update 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.

Insights-Parameter

ParameterDescription
DB_INSIGHTS_DATABASE_NAMEThe name of the Insights database specified when installing Orchestrator.
DB_INSIGHTS_SERVER_NAMEUsed 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.
DB_INSIGHTS_AUTHENTICATION_MODEEnables you to choose the authentication method for the Insights database. It can have the following two parameters WINDOWS or SQL.
DB_INSIGHTS_USER_NAMETo be used only if you chose the SQL authentication method. The SQL database user.
DB_INSIGHTS_USER_PASSWORDTo be used only if you chose the SQL authentication method. The SQL database user password.
DB_INSIGHTS_CONNECTION_STRINGEnables 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.

Testautomatisierungsparameter

ParameterDescription
TA_DATABASE_NAMEThe name of the Test Automation database. This may be the same as the Orchestrator database.
This parameter is mandatory when installing Test Automation.
TA_DB_SERVER_NAMEThe 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.
TA_DB_AUTHENTICATION_MODEEnables you to choose the authentication method for the Test Automation database. It can have the following two parameters: WINDOWS or SQL.
TA_DB_USER_NAMEThe SQL database user is used to connect to the Test Automation database. Use this only if you chose the SQL authentication method.
TA_DB_PASSWORDThe SQL database password is used to connect to the Test Automation database. Use this only if you chose the SQL authentication method.
TA_DB_CONNECTION_STRINGEnables 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.

Elasticsearch-Parameter

ParameterDescription
ELASTIC_URLThe Elasticsearch URL to which you want to log information.
ELASTIC_REQUIRES_AUTHEnables 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_NAMEEnables 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_PASSWORDEnables 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.

Authentifizierungsparameter

ParameterDescription
HOSTADMIN_PASSWORDMandatory. 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_ONETIMEOptional. 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.
DEFAULTTENANTADMIN_PASSWORDMandatory. 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_ONETIMEOptional. 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.

Konfigurationsparameter für mehrere Knoten

ParameterDescription
REDIS_HOSTThe name of your Redis server, for example my.redis.local.
For multinode deployments: node1.redis.local,node2.redis.local,node3.redis.local.
REDIS_PASSWORDThe password for your Redis server. Required only when using the REDIS_HOST parameter.
REDIS_PORTThe port used for your Redis server. If not provided, the default Redis port (6379) is used.
QUARTZ_CLUSTEREDUsed to indicate if the Quartz scheduling framework used for Jobs scheduling is clustered.
The available options are:
0 - Clustering is not enabled.
1 - Clustering is enabled.
SECONDARY_NODEEnables 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.
STORAGE_TYPEUsed to define where NuGet packages are saved when using a Composite repository type. See here for details.
The available options are:
FileSystem
Azure
Amazon
Minio
Mandatory for silent upgrades, if you previously used a Legacy repository to store packages.
STORAGE_LOCATIONRequired only when using the STORAGE_TYPE parameter.
The location where the NuGet packages are saved. See here for details.
Mandatory for silent upgrades, if you previously used a Legacy repository to store packages.
OUTPUT_PARAMETERS_FILEUsed 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.

Beispiele

Diese Beispiele wurden unter der Annahme erstellt, dass Sie schon in dem Verzeichnis sind, in dem sich der Installer UiPathOrchestrator.msi befindet. Sie können dies mit dem folgenden Befehl machen, zum Beispiel: cd D:\UiPathOrchestrator.msi.

Installieren Sie Orchestrator an einem benutzerdefinierten Ort und verbunden mit einer SQL-Datenbank mit SQL-Zugangsdaten:

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

Aktualisieren Sie eine frühere Orchestrator-Installation, indem Sie die Testautomatisierungsfunktion hinzufügen, und verwenden Sie dieselbe Datenbank wie zuvor:

UiPathOrchestrator.msi ADDLOCAL=TestAutomationFeature APPPOOL_IDENTITY_TYPE=USER APPPOOL_USER_NAME=serviceAccount APPPOOL_PASSWORD=1234qwer TA_DATABASE_NAME=UiPath APP_ENCRYPTION_KEY=11111hkaXLwR9LZoBZIuTIxG3GIEB/YMDpUFhD8AR4

Installieren Sie Orchestrator sauber und fügen Sie benutzerdefinierte einmal-Passwörter für den Standard-Mandanten-Administrator und den Host-Administrator hinzu.

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

Generieren Sie eine Installationsprotokolldatei und deaktivieren Sie die Telemetrie:

UiPathOrchestrator.msi TELEMETRY_ENABLED=0 /l*vx log.txt

Führen Sie eine Orchestrator-Installation mit mehreren Knoten durch:

  1. Knoten 1
UiPathOrchestrator.msi OUTPUT_PARAMETERS_FILE=install.json REDIS_HOST=redis.local REDIS_PASSWORD=1234 STORAGE_LOCATION=\\fileserver\share QUARTZ_CLUSTERED=1

Configure the rest of the parameters from the interface

  1. Knoten 2 ... n
UiPathOrchestrator.msi PARAMETERS_FILE=install.json SECONDARY_NODE=1 /passive
  • Eine Beispielparameterdatei .json:
{
    "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_ONETIME", "Value": "1" },
        { "Name": "DEFAULTTENANTADMIN_PASSWORD_ONETIME", "Value": "0" },
    ]
}

🚧

Wichtig!

Die Datei parameters.json enthält vertrauliche Informationen über die Orchestrator-Installation sowie Anmeldeinformationen, die für nachfolgende Installationen erforderlich sind. Stellen Sie sicher, dass diese Datei an einem sicheren Speicherort aufbewahrt wird.

Installieren Sie den Orchestrator mithilfe von Verbindungszeichenfolgen neu, um eine Verbindung mit allen fünf verfügbaren Datenbanken herzustellen:

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" `
UPDSVR_DB_CONNECTION_STRING="Data Source=.\sqlexpress;Initial Catalog=UiPathUpdateServer;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

Replace the newline character ` with the one specific to your command line shell.

Aktualisieren Sie den Orchestrator (2019.10 auf 2021.10) mithilfe von Verbindungszeichenfolgen, um eine Verbindung mit 4/5 verfügbaren Datenbanken herzustellen:

UiPathOrchestrator.msi ADDLOCAL=OrchestratorFeature,IdentityFeature,TestAutomationFeature,InsightsFeature,UpdateServerFeature `
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" `
UPDSVR_DB_CONNECTION_STRING="Data Source=.\sqlexpress;Initial Catalog=UiPathUpdateServer;User Id=sa;Password=1qazXSW@;MultiSubnetFailover=False" `
APPPOOL_USER_NAME=.\Test APPPOOL_PASSWORD=1qazXSW@ PUBLIC_URL=https://localmachine `
IS_CERTIFICATE_SUBJECT=myCert /q

Replace the newline character ` with the one specific to your command line shell.

Aktualisiert vor 4 Monaten


Kommandozeilenparameter


Auf API-Referenzseiten sind Änderungsvorschläge beschränkt

Sie können nur Änderungen an dem Textkörperinhalt von Markdown, aber nicht an der API-Spezifikation vorschlagen.