Orchestrator のスクリプト

Orchestrator にパブリッシュ

次の表で、Publish-Orchestrator.ps1 で使用できる全パラメーターについて説明します。

パラメーター	説明
-action	必須。開始するシナリオの種類を指定します。次のオプションを使用できます。 Deploy - クリーン インストールとして指定します。 Update - Orchestrator インスタンスの更新中であることを指定します。
-azureAccountApplicationId	Mandatory. The Azure service principal ID. Please note that the used service principal needs to be assigned the Contributor role to the app service at the subscription scope.
-azureAccountPassword	必須。サービス プリンシパル ID の Azure トークン パスワード。
-azureSubscriptionId	必須。Orchestrator をホストする App Service の Azure サブスクリプション ID。
-azureAccountTenantId	必須。Azure テナント ID。
-resourceGroupName	必須。Orchestrator App Service を含む Azure リソース グループの名前。
-appServiceName	必須。Orchestrator の Azure App Service の名前。
-package	必須。UiPath.Orchestrator.Web.zip アーカイブのフル パスを指定します。
-activitiesPackagePath	任意。UiPathActivities.zip アーカイブへのフル パスを指定します。このアーカイブは、v2018.4.4 以降、既定で UiPathOrchestrator.zip に含まれています。こうすることで、インストール時に Azure のローカル アクティビティ フィードをインストールできます。このパラメーターは、リポジトリの種類 Legacy と併用する必要があります。併用しない場合は、手動で設定してください。
-testAutomationFeatureEnabled	任意です。このパラメーターは、テスト データのキュー、テストの実行およびスケジューリングのために Test Automation モジュールを有効化します。この機能は以下のいずれかのシナリオに基づいて有効化できます。 Orchestrator のクリーン インストールから新規に開始する Configure the following settings for your App Service before running the Publish-Orchestrator.ps1 script using the -testAutomationFeatureEnabled parameter: AppSettings: Key=TestAutomation.ModuleEnabled - Test Automation モジュールを有効化するには True に設定します。 AppSettings: Key=TestAutomation.FeatureEnabledByDefault - Test Automation モジュールを既定で有効化するには True に設定します。既定では、この機能は明示的に有効化しない限り無効化されています。 ConnectionString: Name= TestAutomation - Test Automation データベース接続文字列に設定します。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 :fa-exclamation-circle: 特にホットスワップ スロットを使用している場合は、必ずこれらの設定を Deployment slot setting としてマークしてください。 Orchestrator のインストール後に Test Automation を有効化する Test Automation モジュールを有効化せずに Orchestrator をデプロイ済みの場合は、 アップグレードに使用するのと同じパラメーターを使用して Publish-Orchestrator.ps1 スクリプトを実行し、-testAutomationFeatureEnabled パラメーターを追加します。 Orchestrator をアップグレードする Orchestrator インスタンスをアップグレードする場合は、これを実行する前に、Publish-Orchestrator.ps1 スクリプトに -testAutomationFeatureEnabled パラメーターを追加します。 For more details about upgrading Orchestrator, see Publish-Orchestrator.ps1 Update.
-insightsFeatureEnabled	任意です。このパラメーターは、Insights のモジュールと機能を有効化します。この機能は以下のいずれかのシナリオで有効化できます。 Orchestrator のクリーン インストールから新規に開始する -insightsFeatureEnabled パラメーターを使用して Publish-Orchestrator.ps1 スクリプトを実行する前に、App Service で次の設定を行います。 AppSettings: Key= Insights.ModuleEnabled - Insights モジュールを有効化するには True に設定します。 AppSettings: Key= Insights.FeatureEnabledByDefault - Insights モジュールを既定で有効化するには True に設定します。既定では、この機能は明示的に有効化しない限り無効化されています。 ConnectionString: Name= 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 パラメーターを追加します。 For more details about upgrading Orchestrator, see Publish-Orchestrator.ps1 Update.
-updateServerFeatureEnabled	任意です。このパラメーターは、更新サーバー モジュールを有効化します。この機能は以下のいずれかのシナリオで有効化できます。 Orchestrator のクリーン インストールから新規に開始する Configure the following settings for your App Service before running the Publish-Orchestrator.ps1 script using the -updateServerFeatureEnabled parameter: AppSettings: Key=UpdateServer.ModuleEnabled - 更新サーバー モジュールを有効化するには True に設定します。 AppSettings: Key=UpdateServer.FeatureEnabledByDefault - 更新サーバー モジュールを既定で有効化するには True に設定します。既定では、この機能は明示的に有効化しない限り無効化されています。 ConnectionString: Name=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 パラメーターを追加します。 For more details about upgrading Orchestrator, see Publish-Orchestrator.ps1 Update.
-robotsElasticSearchUrl	任意。ログ用に Elasticsearch を使用する場合にのみ使用します。Elasticsearch URL を "http://elasticserver:9200" のように値として入力します。Orchestrator インスタンスに認証が必要な場合、ElasticSearchUsername、ElasticSearchPassword、elasticSearchDiagnosticsUsername、elasticSearchDiagnosticsPassword の各パラメーターを入力します。
-robotsElasticSearchTargets	任意。このパラメーターでは、設定した Elasticsearch サーバーにのみロボット ログを送信できます。Elasticsearch URL を "http://elasticserver:9200" のように値として入力します。これは、-robotsElasticSearchUrl パラメーターと併用する必要があります。このパラメーターを設定しない場合、ロボット ログは設定した SQL データベースと Elasticsearch の両方に送信されます。
-robotsElasticSearchUsername	任意。Elasticsearch の認証が有効である場合、このパラメーターで Elasticsearch インスタンスのユーザー名を指定できます。
-robotsElasticSearchPassword	任意。Elasticsearch の認証が有効である場合、このパラメーターで Elasticsearch インスタンスのパスワードを指定できます。
-serverElasticSearchDiagnosticsUsername	任意。Elasticsearch の認証が有効である場合、このパラメーターで Elasticsearch インスタンスのユーザー名を指定できます。内部的な Orchestrator のログには、elasticSearchDiagnosticsPassword "Password" と合わせてこのパラメーターが必要です。
-serverElasticSearchDiagnosticsPassword	任意。 - Elasticsearch の認証が有効である場合、このパラメーターで Elasticsearch インスタンスのパスワードを指定できます。内部的な Orchestrator のログには、elasticSearchDiagnosticsUsername "Username" と合わせてこのパラメーターが必要です。
-loadBalancerUseRedis	任意。データベースとして Redis を使用して、ロード バランサー経由で接続しているすべてのマシンとの間でメッセージの配信とキャッシュ処理を行います。-redisConnectionString を指定すると、自動的に true に設定され、それ以外の場合は false に設定されます。
-redisConnectionString	Optional. It can only be used if loadBalancerUseRedis is set to true. A connection string that enables you to set up your Redis server, which contains the URL of the server, the password, and port used with Redis. It is also possible to enable SSL encrypted connections between the Orchestrator nodes and the Redis service. For more information, please click here. 例: SSL が有効な場合 - -redisConnectionString "docs123.redis.cache.windows.net:6380,password=******,ssl=True" SSL が有効でない場合 - -redisConnectionString "docs123.redis.cache.windows.net:6380,password=******,ssl=False"
-azureSignalRConnectionString	任意です。各種ロボットと SignalR Service 間の (Orchestrator の仲介を必要としない) 直接通信を容易にするために Azure SignalR Service を有効化できるようにします。有効化すると、2019.2 より前のバージョンの Robot が Orchestrator との通信にハートビート プロトコルのみを使用することになり、Orchestrator からのコマンドは、30 秒ごとにしか Robot に取り込まれなくなることに注意してください。例: -azureSignalRConnectionString "Endpoint=https://doctest.signalr.net;AccessKey=M1ug+sBu07hyyi12AgyJ52SEd4OgC2Mm6BvllVHCC9c=;Version=1.0;"
-storageType	任意。実行メディアとパッケージの保存先となるターゲットを定義します。次のターゲットを設定できます。 FileSystem - storageType "FileSystem" など。 これは、パラメーターを指定しない場合でも、更新シナリオとクリーン インストールの両方の既定値です。 Azure - storageType "Azure" など。 Amazon - storageType "Amazon" など。 Minio - storageType "Minio" など。 Azure App Service の [設定] セクションで UiPath.Orchestrator.dll.config の Storage.Type パラメーターをオーバーライドした場合、アップグレード時にこの値をスクリプトのパラメーターとして Publish-Orchestrator.ps1 に渡す必要があります。
-storageLocation	任意。実行メディアとパッケージの保存先となる実際の場所を定義します。個別の詳細 : FileSystem - 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")。 More information on these deployments types is available here. Azure App Service の [設定] セクションで UiPath.Orchestrator.dll.config の Storage.Location パラメーターをオーバーライドした場合、アップグレード時にこの値をスクリプトのパラメーターとして Publish-Orchestrator.ps1 に渡す必要があります。
-standbyslotname	任意です。アップグレードのシナリオのみに使用できます。指定すると、スクリプトが Orchestrator を運用環境ではなく指定の App Service スロットにデプロイします。さらに、ダウンタイムなしで運用環境スロットとのスロット交換を行います。 前提条件: スタンバイ App Service スロットが異なる SQL データベースをポイントしていること スタンバイ スロットの接続文字列がスロット固定になっていること (Azure Portal の [スロットの設定] ボックスを選択) 運用環境スロットの UiPath.Orchestrator.dll.config ファイルが運用環境スロットからスタンバイ スロットにコピーされていること
-productionSlotName	任意。Orchestrator App Service のデプロイ スロットが Azure で設定される既定の運用環境 App Service スロットと異なる場合にのみ使用できます。
-appSettings	Optional. Key-value pairs of application settings that are pushed to the Azure App Service Configuration section after deployment. Keep in mind that this only applies to settings from the App Settings section of the UiPath.Orchestrator.dll.config file. You can use this parameter to change specific settings that are not exposed through the Publish-Orchestrator.ps1 script. For the rest, please use their dedicated parameter while deploying the script. 既存の設定は、新規の設定とマージされることに注意してください。
-stopApplicationBeforePublish	任意です。存在する場合は、アプリケーションをデプロイ前に停止し、デプロイの完了後に起動します。
-unattended	任意です。存在する場合は、ユーザーの確認なしにデプロイが続行されます。
-bucketsAvailableProviders	任意です。有効化するバケット プロバイダーのリストをコンマ区切りで記載した文字列です。指定しない場合、既定値は Orchestrator,Amazon,Azure,Minio です。また、FileSystem プロバイダーをそのリストに追加し、有効化することもできます。 注意: FileSystem プロバイダーを使用して 20.10.7 以降のバージョンにアップグレードする場合、このパラメーターに渡す値には FileSystem が含まれている必要があります。値が含まれない場合、このプロバイダーは無効化され、バケットを使用できなくなります。
-bucketsFileSystemAllowlist	FileSystem をバケット プロバイダーとして選択した場合にのみ、必須です。FileSystem プロバイダーに対してバケットの作成を許可する場所のリストです。FileSystem プロバイダーを有効化する場合は、このパラメーターの値も渡す必要があります。この値は UNC パスのリストで、パイプ記号 | で区切って入力します (例:\mysharedstorage\mybyckets\myotherserver\myotherbuckets)。
-noAzureAuthentication	任意です。サービス プリンシパルを作成することなく、ユーザー自身の ID を利用して Azure App Service にパブリッシュを行えます。このパラメーターを使用すると、UseServicePrincipal パラメーター セット (Azure アプリケーション ID、パスワード、サブスクリプション ID、テナント ID などの項目を含む) は不要になります。
-OrchestratorRootUrl	任意です。カスタム URL が使用される場合に Orchestrator App Service の外部 URL を含めることができます。このパラメーターが設定されていない場合は、代わりに App Service の既定の URL が使用されます。
-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 の 1 ノードへのクリーン インストール、Elasticsearch を使ったログ作成、パッケージの Azure Blob Storage への保存、パッケージ メタデータの 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 Storage に、パッケージ メタデータは 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

以下の例を使用すると、Webhooks.Enabled および Telemetry.Enabled パラメーターの値を false に変えるだけで、既存のマルチノード 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" `
-appSettings @{"Webhooks.Enabled"="false"; "Telemetry.Enabled"="false"} `
-verbose