Orchestrator 脚本

发布到 Orchestrator

下表介绍了可与 Publish-Orchestrator.ps1一起使用的所有参数。

参数	描述
-action	Mandatory. Indicates the type of scenario you want to start. The following options are available: Deploy - 指定它为全新安装； Update - 指定要更新 Orchestrator 实例。
-azureAccountApplicationId	必填。Azure 服务主体 ID。请注意，需要在订阅范围内为所用的服务主体分配应用程序服务的"参与者"角色。
-azureAccountPassword	Mandatory. The Azure token password for the service principal ID.
-azureSubscriptionId	Mandatory. The Azure subscription ID for the App Service that hosts Orchestrator.
-azureAccountTenantId	Mandatory. The Azure tenant ID.
-resourceGroupName	Mandatory. The name of the Azure Resource Group that contains the Orchestrator App Service.
-appServiceName	Mandatory. The Orchestrator Azure App Service name.
-package	Mandatory. Indicate the full path of the UiPath.Orchestrator.Web.zip archive.
-activitiesPackagePath	可选。指定UiPathActivities.zip存档的完整路径，从v2018.4.4开始，该路径默认包含在UiPathOrchestrator.zip中。这使您可以在安装时在 Azure 中安装本地活动订阅源。请注意，此参数仅可用于Legacy存储库类型。否则，必须手动设置。
-testAutomationFeatureEnabled	可选。此参数启用测试自动化模块，用于测试数据队列、测试执行和计划。您可以基于以下情况之一启用此功能： 通过 Orchestrator 清洁安装重新启动 在使用 -testAutomationFeatureEnabled 参数运行 Publish-Orchestrator.ps1 脚本之前，请为您的应用程序服务配置以下设置： AppSettings：密钥=TestAutomation.ModuleEnabled - 设置为 True 以启用测试自动化模块。 AppSettings: Key=TestAutomation.FeatureEnabledByDefault - 设置为 True 将默认启用测试自动化模块。默认情况下，除非显式禁用，否则启用此功能 ConnectionString：名称=TestAutomation - 设置测试自动化数据库连接字符串。可以使用与 Orchestrator 相同的连接字符串，也可以使用不同的连接字符串。例如: Server=13.13.13.13;Initial Catalog=UiPath;Persist Security Info=False;User ID=dbUser;Password=pass123; MultipleActiveResultSets=False;Encrypt=True; Connection Timeout=30;TrustServerCertificate=True 确保将这些设置标记为 Deployment slot setting，尤其是在使用热插拔插槽的情况下。 启用 Orchestrator 安装后测试自动化 如果您已经部署了 Orchestrator 而未启用测试自动化模块， 请使用与升级时相同的参数运行 Publish-Orchestrator.ps1 脚本，并添加 -testAutomationFeatureEnabled 参数。 升级 Orchestrator 如果升级 Orchestrator 实例，请在运行 Publish-Orchestrator.ps1 脚本之前将 -testAutomationFeatureEnabled 参数添加到该脚本中。 有关升级 Orchestrator 的更多详细信息，请参阅 Publish-Orchestrator.ps1 更新。
-insightsFeatureEnabled	可选。此参数启用 Insights 模块和功能。您可以在以下任一情况下启用此功能： 使用全新的 Orchestrator 安装重新启动 在使用 -insightsFeatureEnabled 参数运行 Publish-Orchestrator.ps1 脚本之前，请为您的应用程序服务配置以下设置： 应用程序设置：键 = Insights.ModuleEnabled - 设置为 True 以启用 Insights 模块。 应用程序设置：密钥 = Insights.FeatureEnabledByDefault - 设置为 True 以默认启用 Insights 模块。默认情况下，除非显式启用，否则禁用此功能。 ConnectionString：名称 = Insights - 设置 Insights 连接字符串。可以使用与 Orchestrator 相同的连接字符串，也可以使用不同的连接字符串。例如： Server=13.13.13.13;Initial Catalog=Insights;Persist Security Info=False;User ID=dbUser;Password=pass123; MultipleActiveResultSets=False;Encrypt=True; Connection Timeout=30;TrustServerCertificate=True 在 Orchestrator 安装后启用 Insights 如果您已在未启用 Insights 模块的情况下部署了 Orchestrator，请使用与升级相同的参数运行 Publish-Orchestrator.ps1 脚本，并添加 -insightsFeatureEnabled 参数。 升级 Orchestrator 如果升级 Orchestrator 实例，请在运行 Publish-Orchestrator.ps1 脚本之前将 -insightsFeatureEnabled 参数添加到该脚本中。 有关升级 Orchestrator 的更多详细信息，请参阅 Publish-Orchestrator.ps1 更新。
-updateServerFeatureEnabled	可选。此参数启用“更新服务器”模块。您可以在以下任一情况下启用此功能： 使用全新的 Orchestrator 安装重新启动 在使用 -updateServerFeatureEnabled 参数运行 Publish-Orchestrator.ps1 脚本之前，请为您的应用程序服务配置以下设置： AppSettings：密钥=UpdateServer.ModuleEnabled - 设置为 True 以启用更新服务器模块。 AppSettings：密钥=UpdateServer.FeatureEnabledByDefault - 设置为 True 以默认启用更新服务器模块。默认情况下，除非显式启用，否则禁用此功能。 ConnectionString：名称=UpdateServer - 设置更新服务器数据库连接字符串。可以使用与 Orchestrator 相同的连接字符串，也可以使用不同的连接字符串。例如: Server=13.13.13.13;Initial Catalog=UiPath;Persist Security Info=False;User ID=dbUser;Password=pass123; MultipleActiveResultSets=False;Encrypt=True; Connection Timeout=30;TrustServerCertificate=True 在 Orchestrator 安装后启用更新服务器 如果您已经部署了 Orchestrator 而未启用“更新服务器”模块， 请使用与升级时相同的参数运行 Publish-Orchestrator.ps1 脚本，并添加 -updateServerFeatureEnabled 参数。 升级 Orchestrator 如果升级 Orchestrator 实例，请在运行 Publish-Orchestrator.ps1 脚本之前将 -updateServerFeatureEnabled 参数添加到该脚本中。 有关升级 Orchestrator 的更多详细信息，请参阅 Publish-Orchestrator.ps1 更新。
-robotsElasticSearchUrl	可选。仅在要使用 Elasticsearch 进行日志记录时才应使用此选项。提供 Elasticsearch URL 作为值，例如"http://elasticserver:9200" 。如果您的 Orchestrator 实例需要身份验证，请提供ElasticSearchUsername 、 ElasticSearchPassword 、 elasticSearchDiagnosticsUsername和elasticSearchDiagnosticsPassword参数。
-robotsElasticSearchTargets	可选。使用此参数，您可以仅将机器人日志发送到已配置的 Elasticsearch 服务器。提供 Elasticsearch URL 作为值，例如"http://elasticserver:9200" 。请注意，它只能与-robotsElasticSearchUrl参数一起使用。如果不提供此参数，则将机器人日志将发送到已配置的 SQL 数据库和 Elasticsearch。
-robotsElasticSearchUsername	Optional. This parameter enables you to indicate the username for your Elasticsearch instance if its authentication is enabled.
-robotsElasticSearchPassword	Optional. This parameter enables you to indicate the password for your Elasticsearch instance if its authentication is enabled.
-serverElasticSearchDiagnosticsUsername	Optional. This parameter enables you to indicate the username for your Elasticsearch instance if its authentication is enabled. This parameter together with elasticSearchDiagnosticsPassword "Password" are required for internal Orchestrator logs.
-serverElasticSearchDiagnosticsPassword	Optional. This parameter enables you to indicate the password for your Elasticsearch instance if its authentication is enabled. This parameter together with elasticSearchDiagnosticsUsername "Username" are required for internal Orchestrator logs.
-loadBalancerUseRedis	可选。使用 Redis 作为数据库，在通过负载均衡器连接的所有计算机之间分发消息和缓存。如果指定了 -redisConnectionString，则会自动设置为 true，否则会设置为 false。
-redisConnectionString	可选。只有在将 loadBalancerUseRedis 设置为 true 时，才能使用。一个连接字符串，允许您设置 Redis 服务器，其中包含服务器的 URL、密码和与 Redis 一起使用的端口。也可以在协调器节点和 Redis 服务之间启用 SSL 加密连接。有关详细信息，请单击此处。 示例: 启用 SSL - -redisConnectionString "docs123.redis.cache.windows.net:6380,password=******,ssl=True" 未启用 SSL - -redisConnectionString "docs123.redis.cache.windows.net:6380,password=******,ssl=False"
-azureSignalRConnectionString	Optional. Helps you enable Azure SignalR Service, facilitating a direct communication between your Robot fleet and the SignalR Service - Orchestrator no longer intermediates it. Please note that, if enabled, Robots with a version lower than 2019.2 rely only on the Heartbeat protocol to communicate to Orchestrator, meaning that any command given from Orchestrator is picked up by a Robot only every 30 seconds. Example: -azureSignalRConnectionString "Endpoint=https://doctest.signalr.net;AccessKey=M1ug+sBu07hyyi12AgyJ52SEd4OgC2Mm6BvllVHCC9c=;Version=1.0;"
-storageType	Optional. Defines the target where execution media and packages are to be saved. It can be populated with the following targets: FileSystem - 如 storageType "FileSystem"。 这是更新方案和全新安装中的默认值，即使未指定参数也是如此。 Azure - 如 storageType "Azure"。 Amazon - 如 storageType "Amazon"。 Minio - 如 storageType "Minio"。 如果已覆盖 Azure 应用程序服务“配置”部分的 UiPath.Orchestrator.dll.config Storage.Type 参数，则在升级时，需要将此值作为脚本参数传递给 Publish-Orchestrator.ps1。
-storageLocation	Optional. Defines the actual location where execution media and packages are to be saved. Particularities: 文件系统 - 使用 RootPath=.\Storage 格式提供绝对路径，例如 storageLocation "RootPath=C:\FolderName\AnotherFolderName"。这是更新方案和全新安装中的默认值，即使未指定参数也是如此。 Azure - 提供连接字符串，例如 storageLocation "DefaultEndpointsProtocol=https;AccountName=usr;AccountKey=...;EndpointSuffix=core.windows.net"。 Amazon - 提供连接字符串，例如 storageLocation" "EndpointRegion=eu-west-3;accessKey=AKIAZGUEIGXUJ3BBI4MW;secretKey=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;useHttp=false"。 Minio - 提供连接字符串，例如 storageLocation" "host=localhost:9001;accessKey=YVKYFJ0ZY246KDKP0634;secretKey=bdBEk2ubhIFsTNPuQ80PjKL+oqZBj67HoSWBFnw1"。 有关这些部署类型的详细信息，请参阅此处。 如果已覆盖 Azure 应用程序服务“配置”部分的 UiPath.Orchestrator.dll.config Storage.Location 参数，则在升级时，需要将此值作为脚本参数传递给 Publish-Orchestrator.ps1。
-standbyslotname	可选。它只能在升级方案中使用。如果指定，脚本将在指定的应用程序服务槽（而不是生产槽）中部署 Orchestrator。此外，交换槽与生产槽一起执行，没有停机时间。 先决条件： 备用应用程序服务插槽必须指向其他 SQL 数据库。 the standby slot Connection String must be made slot sticky (by selecting the Slot Setting box in Azure Portal). 必须将生产插槽 UiPath.Orchestrator.dll.config 文件从生产插槽复制到备用插槽。
-productionSlotName	Optional. It can be used only if the Orchestrator App Service deployment slot is different from the default Production App Service Slot set by Azure.
-appSettings	可选。部署后推送到 Azure 应用服务配置部分的应用程序设置的键值对。请记住，这仅适用于UiPath.Orchestrator.dll.config 文件 的应用程序设置部分中的设置。您可以使用此参数更改未通过Publish-Orchestrator.ps1脚本公开的特定设置。对于其余部分，请在部署脚本时使用其专用参数。 请注意，现有设置将与新设置合并。
-stopApplicationBeforePublish	可选。如果存在，它会在部署之前停止应用程序，并在部署完成后启动应用程序。
-unattended	可选。 如果存在，则部署将继续，无需任何用户确认。
-bucketsAvailableProviders	可选。一个字符串，其中包含您要启用的存储桶提供程序的列表（以逗号分隔）。如果未指定，则默认为Orchestrator,Amazon,Azure,Minio 。您还可以选择通过将文件系统提供程序添加到该列表中来启用它。注意：如果使用文件系统提供程序并升级到 20.10.7 或更高版本，则必须为此参数传递包含FileSystem值。否则，该提供程序将被禁用，并且您不再能够使用这些存储桶。
-bucketsFileSystemAllowlist	只有当文件系统被选为存储桶提供程序时为必需。您要允许在其中为文件系统提供程序创建存储桶的位置列表。如果启用文件系统提供程序，则还必须为此参数传递一个值。值是一系列 UNC 路径，由管道符号 | 分隔（例如\mysharedstorage\mybyckets\myotherserver\myotherbuckets）。
-noAzureAuthentication	可选。允许您依靠自己的用户身份发布到 Azure 应用程序服务，而无需创建服务主体。如果使用此参数，则不再需要 UseServicePrincipal 参数集（其中包括 Azure 应用程序 ID、密码、订阅 ID 和租户 ID 等项目）。
-OrchestratorRootUrl	Optional. Allows you to include the external URL of the Orchestrator app service in cases where a custom URL is used. If this parameter is not populated, the app service default URL is used instead.
-azureUSGovernmentLogin	可选。此参数仅用于美国政府部署。

更新时保留的参数

执行更新时，系统会自动迁移并保留以下 UiPath.Orchestrator.dll.config 参数值。 要更改它们，请在调用 Publish-Orchestrator.ps1 脚本时提供新值。

-NuGet.Packages.ApiKey
-NuGet.Activities.ApiKey
-NuGet.Packages.Path
-NuGet.Activities.Path
-machineKey/@decryption
-machineKey/@decryptionKey
-machineKey/@validationKey
-EncryptionKey
-NuGet.Repository.Type
-Storage.Type
-Storage.Location
-LoadBalancer.Redis.ConnectionString
-LoadBalancer.UseRedis
-Scalability.AzureSignalR.ConnectionString
-nlog/targets/target/@name=robotElasticBuffer/@name=RobotElastic/@uri
-nlog/targets/target/@name=robotElasticBuffer/@name=RobotElastic/@username
-nlog/targets/target/@name=robotElasticBuffer/@name=RobotElastic/@password
-nlog/rules/logger/@name=Robot.*/@writeTo
-nlog/targets/target/@name=serverElasticBuffer/@name=serverElastic/@uri
-nlog/targets/target/@name=serverElasticBuffer/@name=serverElastic/@username
-nlog/targets/target/@name=serverElasticBuffer/@name=serverElastic/@password
-nlog/targets/target/@name=serverElasticBuffer/@name=serverElastic/@index
-nlog/rules/logger/@name=*/@writeTo

示例

单节点安装

以下示例使您能够在一个节点上执行 Orchestrator 的全新安装，使用 Elasticsearch 进行日志记录，并将包保存在 Azure Blob 存储中，并将其元数据保存在 SQL 数据库中。 该过程以 -unattended 方式进行，并在 -verbose 级别记录其步骤。

.\Publish-Orchestrator.ps1 `
-action "Deploy" `
-unattended `
-package "E:\Work\Orch\Setup\UiPath.Orchestrator.Web.zip" `
-stopApplicationBeforePublish `
-azureSubscriptionId "8e34be72-1937-4aa0-b70e-81bab19gbf0a" `
-azureAccountTenantId "f8350d2a-n153-4d17-8927-902c51f72797" `
-azureAccountApplicationId "$AzureApplicationId" `
-azureAccountPassword "$AzurePassword" `
-resourceGroupName "DocTest-Orch-RG" `
-appServiceName "DocTests123" `
-testAutomationFeatureEnabled
-updateServerFeatureEnabled
-storageType "Azure" `
-storageLocation "DefaultEndpointsProtocol=https;AccountName=usr;AccountKey=...;EndpointSuffix=core.windows.net" `
-robotsElasticSearchUrl "http://docelasticserver:9200" `
-verbose

多节点安装

以下示例使您能够在多个节点上执行 Orchestrator 的全新安装，并使用 Elasticsearch 进行日志记录，使用 Redis 进行缓存和消息分发。 包保存在 Azure Blob 存储中，其元数据保存在 SQL 数据库中。 该过程以 -unattended 方式进行，并在 -verbose 级别记录其步骤。

.\Publish-Orchestrator.ps1 `
-action "Deploy" `
-unattended `
-package "E:\Work\Orch\Setup\UiPath.Orchestrator.Web.zip" `
-stopApplicationBeforePublish `
-azureSubscriptionId "8e34be72-1937-4aa0-b70e-81bab19gbf0a" `
-azureAccountTenantId "f8350d2a-n153-4d17-8927-902c51f72797" `
-azureAccountApplicationId "$AzureApplicationId" `
-azureAccountPassword "$AzurePassword" `
-resourceGroupName "DocTest-Orch-RG" `
-appServiceName "DocTests123" `
-redisConnectionString "docs123.redis.cache.windows.net:6380,passwprd=******,ssl=True" `
-azureSignalRConnectionString "Endpoint=https://doctest.signalr.net;AccessKey=*****;Version=1.0;" `
-robotsElasticSearchUrl "http://docelasticserver:9200" `
-storageType "Azure" `
-storageLocation "DefaultEndpointsProtocol=https;AccountName=usr;AccountKey=...;EndpointSuffix=core.windows.net" `
-verbose

多节点更新

以下示例使您能够将现有的多节点 Orchestrator 升级到最新的可用版本，而无需更改任何预先存在的设置。 该过程以 -unattended 方式进行，并在 -verbose 级别记录其步骤。

Publish-Orchestrator.ps1 `
-action Update `
-unattended `
-package "E:\Work\Orch\Setup\UiPath.Orchestrator.Web.zip" `
-stopApplicationBeforePublish `
-azureSubscriptionId "8e34be72-1937-4aa0-b70e-81bab19gbf0a" `
-azureAccountTenantId "f8350d2a-n153-4d17-8927-902c51f72797" `
-azureAccountApplicationId "$AzureApplicationId" `
-azureAccountPassword "$AzurePassword" `
-resourceGroupName "DocTest-Orch-RG" `
-appServiceName "DocTests123" `
-verbose

以下示例使您能够将现有的多节点 Orchestrator 升级到最新的可用版本，同时仅将 Webhooks.Enabled 和 Telemetry.Enabled 参数的值更改为 false。 该过程以 -unattended 方式进行，并在 -verbose 级别记录其步骤。

Publish-Orchestrator.ps1 `
-action Update `
-unattended `
-package "E:\Work\Orch\Setup\UiPath.Orchestrator.Web.zip" `
-stopApplicationBeforePublish `
-azureSubscriptionId "8e34be72-1937-4aa0-b70e-81bab19gbf0a" `
-azureAccountTenantId "f8350d2a-n153-4d17-8927-902c51f72797" `
-azureAccountApplicationId "$AzureApplicationId" `
-azureAccountPassword "$AzurePassword" `
-resourceGroupName "DocTest-Orch-RG" `
-appServiceName "DocTests123" `
-appSettings @{"Webhooks.Enabled"="false"; "Telemetry.Enabled"="false"} `
-verbose