命令行参数

可用于使用 Windows 安装程序安装或更新 Orchestrator 的命令行参数

命令行参数描述

如果您拥有 UiPath Orchestrator Windows 安装程序 (UiPathOrchestrator.msi)，则可以使用命令行安装或更新整个 UiPath 套件。 下表列出了可用于 Orchestrator 的所有可用参数，并附有一些示例。

要了解可与 Studio 和机器人一起使用的命令行参数，请参阅本主题。

安装参数

参数	描述
/passive	让您能够以被动模式安装指定的 UiPath 功能。 系统将显示有限的用户界面，其中包含进度条和错误弹出窗口。建议选择被动安装。
/q	帮助您静默安装指定的 UiPath 功能，而不显示用户界面。 静默模式仅应用于无人值守的安装。
/l*vx <LogFile>	在指定路径生成安装程序日志文件。如果您在安装过程中遇到困难，不管何种原因，均可将此文件发送给我们的支持团队。
ADDLOCAL	用于选择要安装的功能。 它支持以下选项： Orchestrator 功能 - 安装 Orchestrator（必需）。 身份功能 - 安装 Identity Server（必须）。 Insights 功能 - 启用 Insights 功能。 安装后，可以通过选择“添加/删除程序”并选择 UiPath Orchestrator 上的“更改”来添加/删除此功能。 测试自动化功能 - 启用测试自动化功能。安装后，可以通过选择“添加/删除程序”并选择 UiPath Orchestrator 上的“更改”来添加/删除此功能。
APP_ENCRYPTION_KEY	使您能够在更新和希望使用与以前相同的数据库时，输入早期版本的 Orchestrator 使用的加密密钥。 注意：只能使用 v2020.4 之前的 Orchestrator 版本中的现有数据库，并且需要为 Identity Server 传递 IS_DATABASE_NAME 和 PUBLIC_URL 参数。 您无需指定数据库的名称，因为安装程序会根据先前使用的名称进行检查。 如果不想使用先前安装中的数据库，请使用下面详述的数据库参数提供新数据库的详细信息。
APP_NUGET_PACKAGES_KEY	NuGet 帐户的许可证密钥。 如果活动和包存储在相同的 NuGet 订阅源中，则此参数的值必须与 APP_NUGET_ACTIVITIES_KEY 的值相同。
APP_NUGET_ACTIVITIES_KEY	NuGet 帐户的许可证密钥。 如果活动和包存储在相同的 NuGet 订阅源中，则此参数的值必须与 APP_NUGET_PACKAGES_KEY 的值相同。
PARAMETERS_FILE	使您能够在 .json 文件中传递以下参数： 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_ENABLED	启用或禁用 UiPath 用于诊断问题和改进 Orchestrator 的使用情况和性能数据收集。 有关 UiPath 隐私实践的更多详细信息，请查看隐私声明。 使用时，此参数会更改名为 Telemetry.Enabled 的 UiPath.Orchestrator.dll.config 键的值。 如果设置为 0 (TELEMETRY_ENABLED=0)，遥测功能将被禁用，且 Telemetry.Enabled 键将被设置为 false。如果设置为 1 (TELEMETRY_ENABLED=1)，则启用遥测功能，并将 Telemetry.Enabled 键设置为 true。 在更新 Orchestrator 实例时，也可以添加 TELEMETRY_ENABLED 参数。如果省略，则保留之前的值。如果之前版本的 Orchestrator 中缺少此键，并且您在更新时没有提供 TELEMETRY_ENABLED 参数，Telemetry.Enabled 将自动设为 true。

IIS 参数

命令	描述
ORCHESTRATORFOLDER	用于在自定义位置安装 Orchestrator。 默认情况下，Orchestrator 安装为 C:\Program Files (x86)\UiPath\Orchestrator。
WEBSITE_NAME	Orchestrator 网站的名称。 不建议编辑此参数。
WEBSITE_PORT	要用于启用计算机和 Orchestrator 之间通信的端口。 如果未指定，则使用默认值 443 以启用 HTTPS。 如果使用另一个端口，请确保将它附加到 PUBLIC_URL Identity Server 参数，如下所述。
WEBSITE_PORT_DO_VALIDATE	用于指示是否对网站端口可用性执行验证。 可用的选项包括： 0 - 未执行验证。 1 - 执行验证。 注意：向此参数提交任何值都会导致用户界面中的相应复选框显示为已选中，即使仅在参数值为1时才会验证端口也如此。
WEBSITE_PORT_FIREWALL	用于指示是否自动为此端口添加防火墙规则。 可用的选项包括： 0 - 未添加防火墙规则。 1 - 添加防火墙规则。 注意：向此参数提交任何值都会导致用户界面中的相应复选框显示为已选中，即使仅在参数值为1时才会创建防火墙规则也如此。
CERTIFICATE_SUBJECT	要用于保护与 Orchestrator 的连接的 SSL 证书的名称。 如果未指定，默认情况下将使用完整的计算机名称。

应用程序池参数

命令	描述
APPPOOL_NAME	用于 Orchestrator 的应用程序池的名称。
APPPOOL_IDENTITY_TYPE	它只能与 Orchestrator 功能一起使用。 用于 Orchestrator 的应用程序池类型。 它支持以下值： USER 和 APPPOOLIDENTITY。
APPPOOL_USER_NAME	运行应用程序池的用户名。 仅当 APPPOOL_IDENTITY_TYPE 设置为 USER时，才需要包含此参数。
APPPOOL_PASSWORD	运行应用程序池的用户的密码。 仅当 APPPOOL_IDENTITY_TYPE 设置为 USER时，才需要包含此参数。

数据库参数

参数	描述
DB_SERVER_NAME	您要使用的数据库所在的服务器的名称。请注意，不支持以下特殊字符：空格、 \ 、 / 、 * 、 : 、 ? 、 " 、 < 、 > 、`
DB_DATABASE_NAME	您要连接的数据库的名称。 只能在首次安装 Orchestrator 时使用，且需具有 Orchestrator 功能和所有其他特定于数据库的参数。如果要使用以前安装的数据库（仅限 v20.4 之前的版本），请指定 APP_ENCRYPTION_KEY 参数。
DB_AUTHENTICATION_MODE	用于选择数据库的身份验证方法。它可能包含以下两个参数：WINDOWS 或 SQL。 只能在首次安装 Orchestrator 时使用，且具有 Orchestrator 功能和所有其他特定于数据库的参数。
DB_USER_NAME	仅在选择 SQL 身份验证方法时才使用。SQL 数据库用户。 只能在首次安装 Orchestrator 时使用，且具有 Orchestrator 功能和所有其他特定于数据库的参数。
DB_PASSWORD	仅在选择 SQL 身份验证方法时才使用。SQL 数据库用户密码。只能在首次安装 Orchestrator 时使用，且具有 Orchestrator 功能和所有其他特定于数据库的参数。
DB_CONNECTION_STRING	用于配置连接 Orchestrator 主数据库所需的特定设置（例如 MultiSubnetFailover=True）。 使用此连接字符串替代现有数据库参数（单个服务器实例、数据库名称、数据库用户名等）。 它可用于在静默模式下进行全新安装或升级。

身份服务器参数

重要提示：

以下参数仅在初始安装身份服务器期间（即首次安装 Orchestrator 或从 Orchestrator v20.4 之前的版本进行初始升级）需要，而在任何后续升级期间都不需要。

参数	描述
IS_DATABASE_NAME	您希望身份服务器使用的数据库的名称。 默认值为 Orchestrator 数据库的名称。
IS_DB_SERVER_NAME	用于创建身份服务器数据库的服务器。默认值是 Orchestrator 服务器，但可以更改它。
IS_DB_AUTHENTICATION_MODE	用于选择数据库的身份验证方法。 其中可以包含以下两个参数：WINDOWS 和 SQL。
IS_DB_USER_NAME	SQL 数据库用户。仅在选择 SQL 身份验证方法时使用。
IS_DB_PASSWORD	SQL 数据库用户密码。 仅在选择 SQL 身份验证方法时才使用。
PUBLIC_URL	身份服务器连接到的 Orchestrator URL。如果使用的端口不是默认端口 (443)，则必须将该端口附加到此 URL。 对于单节点安装，默认值是正在安装 Orchestrator 的计算机的名称。 例如： PUBLIC_URL = https://mymachine.domain.local:<custom_port> 对于多节点安装，它是负载均衡器的 URL。 例如： PUBLIC_URL = https://orchestrator.mydomain.local:<custom_port>
IS_CERTIFICATE_SUBJECT	用于对访问令牌（用于服务器之间进行身份验证）进行签名的证书的名称 (Subject)。 重要提示：必须使用此参数。如果对身份服务器使用不同的证书，则Orchestrator-身份服务器集成不起作用。
IS_DB_CONNECTION_STRING	用于配置连接 Identity Server 数据库所需的特定设置（例如 MultiSubnetFailover=True）。 使用此连接字符串替代现有数据库参数（单个服务器实例、数据库名称、数据库用户名等）。 它可用于在静默模式下进行全新安装或升级。

更新服务器参数

参数	描述
UPDSVR_DATABASE_NAME	更新服务器数据库的名称。这可能与 Orchestrator 数据库相同。
UPDSVR_DB_SERVER_NAME	要使用的更新服务器数据库所在的服务器的名称。不支持以下特殊字符：空格、 \ 、 / 、 * 、 : 、 ? 、 " 、 < 、 > 、`
UPDSVR_DB_AUTHENTICATION_MODE	用于选择更新服务器数据库的身份验证方法。它可能包含以下两个参数：WINDOWS 或 SQL。
UPDSVR_DB_USER_NAME	SQL 数据库用户用于连接到更新服务器数据库。仅当您选择 SQL 身份验证方法时，才使用此选项。
UPDSVR_DB_PASSWORD	SQL 数据库密码用于连接到更新服务器数据库。仅当您选择 SQL 身份验证方法时，才使用此选项。
UPDSVR_DB_CONNECTION_STRING	用于配置连接更新服务器数据库所需的特定设置（例如 MultiSubnetFailover=True）。 使用此连接字符串替代现有数据库参数（单个服务器实例、数据库名称、数据库用户名等）。 它可用于在静默模式下进行全新安装或升级。

Insights 参数

参数	描述
DB_INSIGHTS_DATABASE_NAME	安装 Orchestrator 时指定的 Insights 数据库的名称。
DB_INSIGHTS_SERVER_NAME	用于标识安装 Insights 的设备。默认情况下，这设置为计算机主机名，但可以编辑。此名称必须可从外部服务器解析。
DB_INSIGHTS_AUTHENTICATION_MODE	使您能够选择 Insights 数据库的身份验证方法。其中可以包含以下两个参数，即 WINDOWS 或 SQL。
DB_INSIGHTS_USER_NAME	仅在选择 SQL 身份验证方法时才使用。SQL 数据库用户。
DB_INSIGHTS_USER_PASSWORD	仅在选择 SQL 身份验证方法时才使用。SQL 数据库用户密码。
DB_INSIGHTS_CONNECTION_STRING	用于配置连接 Insights 数据库所需的特定设置（例如 MultiSubnetFailover=True）。 使用此连接字符串替代现有数据库参数（单个服务器实例、数据库名称、数据库用户名等）。 它可用于在静默模式下进行全新安装或升级。

测试自动化参数

参数	描述
TA_DATABASE_NAME	测试自动化数据库的名称。这可能与 Orchestrator 数据库相同。 安装测试自动化时，此参数是必需的。
TA_DB_SERVER_NAME	您要使用的测试自动化数据库所在的服务器的名称。不支持以下特殊字符：空格、 \ 、 / 、 * 、 : 、 ? 、 " 、 < 、 > 、`
TA_DB_AUTHENTICATION_MODE	用于选择测试自动化数据库的身份验证方法。它可能包含以下两个参数：WINDOWS 或 SQL。
TA_DB_USER_NAME	SQL 数据库用户用于连接到测试自动化数据库。仅当您选择 SQL 身份验证方法时，才使用此选项。
TA_DB_PASSWORD	SQL 数据库密码用于连接到测试自动化数据库。仅当您选择 SQL 身份验证方法时，才使用此选项。
TA_DB_CONNECTION_STRING	用于配置连接测试自动化数据库的特定设置（例如 MultiSubnetFailover=True）。 使用此连接字符串替代现有数据库参数（单个服务器实例、数据库名称、数据库用户名等）。 它可用于在静默模式下进行全新安装或升级。

Elasticsearch 参数

参数	描述
ELASTIC_URL	要将信息记录到的 Elasticsearch URL。
ELASTIC_REQUIRES_AUTH	用于指示 Elasticsearch 实例是否需要身份验证。如果设置为 true，则还需提供 ELASTIC_USER_NAME 和 ELASTIC_USER_PASSWORD 参数。
ELASTIC_USER_NAME	用于指定 Elasticsearch 用户名。要使用此参数，请确保将 ELASTIC_REQUIRES_AUTH 设置为 true。 例如，ELASTIC_USER_NAME=myuser。
ELASTIC_USER_PASSWORD	用于指定 Elasticsearch 密码。要使用此参数，请确保将 ELASTIC_REQUIRES_AUTH 设置为 true。 例如，ELASTIC_USER_PASSWORD=pass。

身份验证参数

参数	描述
HOSTADMIN_PASSWORD	必填项。 用于为主机管理员设置自定义密码。 请注意，密码长度必须至少为 8 个字符，并且必须包含至少一个小写字符和至少一个数字。
HOSTADMIN_PASSWORD_ONETIME	可选。使您能够在主机管理员首次登录时强制执行密码重置。如果省略此参数，则主机管理员密码不是一次性密码。 请注意，此参数只能与 HOSTADMIN_PASSWORD 一起使用。
DEFAULTTENANTADMIN_PASSWORD	必需。使您能够为默认租户管理员设置自定义密码。请注意，密码必须至少 8 个字符长，并且必须至少有一个小写字符和至少一个数字。
DEFAULTTENANTADMIN_PASSWORD_ONETIME	可选。使您能够在默认租户管理员首次登录时强制执行密码重置。如果省略此参数，则租户管理员密码不是一次性密码。 请注意，此参数只能与 DEFAULTTENANTADMIN_PASSWORD 一起使用。

多节点配置参数

参数	描述
REDIS_HOST	Redis 服务器的名称，例如 my.redis.local。 适用于多节点部署：node1.redis.local,node2.redis.local,node3.redis.local。
REDIS_PASSWORD	Redis 服务器的密码。 仅在使用 REDIS_HOST 参数时才需要。
REDIS_PORT	用于 Redis 服务器的端口。 如果未提供，则使用默认 Redis 端口 (6379)。
SECONDARY_NODE	用于安装 Orchestrator 辅助节点。必须按如下所示添加此命令：SECONDARY_NODE=1。 有关如何在多节点环境中部署 Orchestrator 的信息，请参阅此页。
STORAGE_TYPE	用于定义使用 Composite 存储库类型时 NuGet 包的保存位置。 可用的选项包括： FileSystem Azure Amazon Minio 如果您以前使用 Legacy 存储库来存储包，则必须进行静默升级。
STORAGE_LOCATION	仅在使用 STORAGE_TYPE 参数时才需要。 NuGet 包的保存位置。 如果您以前使用 Legacy 存储库来存储包，则必须进行静默升级。
OUTPUT_PARAMETERS_FILE	用于指定文件名（或路径），以便 Orchestrator.msi 生成包含安装参数的 json 文件。 在多节点方案中，在第一个节点上生成此文件，然后在所有其他节点上使用它。

示例

编写这些示例时，我们假设您已处于 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 TA_DATABASE_NAME=UIPathTestAutomation TA_DB_SERVER_NAME=.\sqlexpress HOSTADMIN_PASSWORD=1234qwer DEFAULTTENANTADMIN_PASSWORD=1234qwer HOSTADMIN_PASSWORD_CONFIRM=1234qwer DEFAULTTENANTADMIN_PASSWORD_CONFIRM=1234qwer IS_CERTIFICATE_SUBJECT=certificateSubject /passive

更新以前的 Orchestrator 安装添加测试自动化功能，并使用与之前相同的数据库：

UiPathOrchestrator.msi ADDLOCAL=TestAutomationFeature APPPOOL_IDENTITY_TYPE=USER APPPOOL_USER_NAME=serviceAccount APPPOOL_PASSWORD=1234qwer TA_DATABASE_NAME=UiPath APP_ENCRYPTION_KEY=<ENCRYPTION_KEY>

全新安装 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. 节点 1

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

   配置接口中的其他参数

2. 节点 2 ... n

   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_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" }, ] }
  

重要提示：

parameters.json 文件包含有关 Orchestrator 安装的敏感信息，以及后续安装所需的凭据。确保将此文件保存在安全的位置。

使用连接字符串全新安装 Orchestrator，以连接到所有五个可用的数据库：

• Orchestrator 主数据库
• Identity Server 数据库
• Insights 数据库
• 测试自动化数据库
• 更新服务器数据库

  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
  

使用连接字符串升级 Orchestrator（2019.10 至 2021.10），以连接到 4 个（共 5 个）可用数据库：

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