コマンド ライン引数の説明
UiPath Orchestrator Windows インストーラー (UiPathOrchestrator.msi) がある場合は、コマンド ラインを使用して UiPath スイート全体のインストールや更新を行えます。以下の表は Orchestrator で使用可能なパラメーターのリストです。また、いくつかの例も紹介しています。
Studio および Robot で使用できるコマンド ライン引数については、こちらのトピックをご覧ください。
重要
UiPathPlatformInstaller.exeではコマンド ライン引数を受け付けません。
インストール パラメーター
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: 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. |
| 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. 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. |
| The license key to your NuGet account. |
| Enables you to pass the following parameters in a |
| 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 If set to If set to The If the key was missing in the previous version of Orchestrator and you do not provide the |
IIS パラメーター
Command | Description |
|---|---|
| Enables you to install Orchestrator in a custom location. By default, Orchestrator is installed in |
| The name of your Orchestrator website, for example |
| 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 If another port is used, be sure to append it to the |
| 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: |
| The username running the application pool. This parameter needs to be included only if |
| The password of the user running the application pool. This parameter needs to be included only if |
データベース パラメーター
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, It can only be used on the first Orchestrator installation, with the |
| The name of the database you want to connect to. It can only be used on the first Orchestrator installation, with the |
| Enables you to choose the authentication method for the database. It can have the following two parameters It can only be used on the first Orchestrator installation, with the |
| 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 |
| 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 |
| Enables you to configure specific settings (such as 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 のパラメーター
重要
以下のパラメーターが必要なのは、Identity Server の初期インストール中のみ (例: Orchestrator の初回インストール、または
v20.4より前のバージョンからの初回アップグレード) で、それ以降のアップグレードには必要ありません。
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: |
| 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 ( For single node installations, the default value is the name of the machine where Orchestrator is being installed. For multi-node installations, it is the URL of the load balancer. |
| The name (
|
| Enables you to configure specific settings (such as 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. |
This parameter is mandatory. Orchestrator-Identity Server integration does not work if different certifications are used for Identity Server.Insights のパラメーター
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 |
| To be used only if you chose the SQL authentication method. The SQL database user. |
| Enables you to configure specific settings (such as 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. |
Test Automation のパラメーター
Parameter | Description |
|---|---|
| The name of the Test Automation database. This may be the same as the Orchestrator database. |
| 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, |
| Enables you to choose the authentication method for the Test Automation database. It can have the following two parameters: |
| 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 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 | Description |
|---|---|
| The Elasticsearch URL to which you want to log information. |
| Enables you to indicate if your Elasticsearch instance requires authentication. If set to |
| Enables you to specify your Elastisearch username. To use this parameter, ensure that you set |
| Enables you to specify your Elasticsearch password. To use this parameter, ensure that you set |
認証パラメーター
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 |
| 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 |
| 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 |
マルチノード構成パラメーター
Parameter | Description |
|---|---|
| The name of your Redis server, for example |
| The password for your Redis server. Required only when using the |
| The port used for your Redis server. If not provided, the default Redis port ( |
| Used to indicate if the Quartz scheduling framework used for Jobs scheduling is clustered. |
| Enables you to install Orchestrator secondary nodes. It must be added as follows: |
| Used to define where NuGet packages are saved when using a |
| Required only when using the |
| Used to specify the file name (or path) in order for In multi-node scenarios, generate this file on the first node and then use it on all the other nodes. |
例
以下の例では、UiPathOrchestrator.msi インストーラーが置かれているディレクトリにいることを前提としています。たとえば、cd D:\UiPathOrchestrator.msi などのコマンドでこれを行うことができます。
SQL データベースに SQL 資格情報で接続された独自の場所に Orchestrator をインストールする
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
Test Automation 機能を追加して Orchestrator の以前のインストールを更新し、以前と同じデータベースを使用する
UiPathOrchestrator.msi ADDLOCAL=TestAutomationFeature APPPOOL_IDENTITY_TYPE=USER APPPOOL_USER_NAME=serviceAccount APPPOOL_PASSWORD=1234qwer TA_DATABASE_NAME=UiPath APP_ENCRYPTION_KEY=11111hkaXLwR9LZoBZIuTIxG3GIEB/YMDpUFhD8AR4
Orchestrator をクリーン インストールして、既定のテナント管理者とホスト管理者のワンタイム パスワードをカスタム設定する場合:
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 TELEMETRY_ENABLED=0 /l*vx log.txt
マルチノードの Orchestrator インストールを実行する場合:
- ノード 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
- ノード 2 以降
UiPathOrchestrator.msi PARAMETERS_FILE=install.json SECONDARY_NODE=1 /passive
- サンプル パラメーター
.jsonファイル:
{
"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": "" },
]
}
重要
The
parameters.jsonfile 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:
UiPathOrchestrator.msi ADDLOCAL=TestAutomationFeature,InsightsFeature `
DB_CONNECTION_STRING="Data Source=.\sqlexpress;Initial Catalog=UiPath;User Id=sa;[email protected];MultiSubnetFailover=True" `
IS_DB_CONNECTION_STRING="Data Source=.\sqlexpress;Initial Catalog=UiPathIdentity;User Id=sa;[email protected];MultiSubnetFailover=True" `
DB_INSIGHTS_CONNECTION_STRING="Data Source=.\sqlexpress;Initial Catalog=UiPathInsights;User Id=sa;[email protected];MultiSubnetFailover=True" `
TA_DB_CONNECTION_STRING="Data Source=.\sqlexpress;Initial Catalog=UiPathTestAutomation;User Id=sa;[email protected];MultiSubnetFailover=True" `
APPPOOL_USER_NAME=.\Test [email protected] 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.
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;[email protected];MultiSubnetFailover=False" `
TA_DB_CONNECTION_STRING="Data Source=.\sqlexpress;Initial Catalog=UiPathTestAutomation;User Id=sa;[email protected];MultiSubnetFailover=False" `
IS_DB_CONNECTION_STRING="Data Source=.\sqlexpress;Initial Catalog=UiPathIdentity;User Id=sa;[email protected];MultiSubnetFailover=False" `
APPPOOL_USER_NAME=.\Test [email protected] PUBLIC_URL=https://localmachine `
IS_CERTIFICATE_SUBJECT=myCert /q
Replace the newline character ` with the one specific to your command line shell.
4 か月前に更新