Orchestrator-Skripte

Auf dem Orchestrator veröffentlichen

In der folgenden Tabelle sind alle Parameter beschrieben, die mit Publish-Orchestrator.ps1 verwendet werden können.

Parameter	Beschreibung
-action	Obligatorisch. Gibt den Typ des Szenarios an, das Sie starten möchten. Die folgenden Optionen sind verfügbar: Deploy – Gibt an, dass es sich um eine Neuinstallation handelt; Update – Gibt an, dass Sie Ihre Orchestrator-Instanz aktualisieren.
-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	Obligatorisch. Das Azure-Tokenkennwort für die Dienstprinzipal-ID.
-azureSubscriptionId	Obligatorisch. Die Azure-Abonnement-ID für den App Service, der Orchestrator hostet.
-azureAccountTenantId	Obligatorisch. Die Azure-Mandanten-ID.
-resourceGroupName	Obligatorisch. Der Name der Azure-Ressourcengruppe, die den Orchestrator-App-Dienst enthält.
-appServiceName	Obligatorisch. Der Name des Azure App Service für Orchestrator.
-package	Obligatorisch. Geben Sie den vollständigen Pfad zum Archiv UiPath.Orchestrator.Web.zip an.
-activitiesPackagePath	Optional. Geben Sie den vollständigen Pfad des Archivs UiPathActivities.zip an, das ab v2018.4.4, in UiPathOrchestrator.zip standardmäßig enthalten ist. Auf diese Weise können Sie den lokalen Aktivitätsfeed in Azure zur Installationszeit installieren. Bitte beachten Sie, dass dieser Parameter nur mit dem Repository-Typ Legacy verwendet werden kann. Andernfalls muss er manuell eingerichtet werden.
-testAutomationFeatureEnabled	Optional. Dieser Parameter aktiviert das Modul „Testautomatisierung“ für Testdatenwarteschlangen, Testausführung und Terminplanung. Sie können diese Funktion basierend auf einem der folgenden Szenarien aktivieren: Mit einer Orchestrator-Neuinstallation starten Configure the following settings for your App Service before running the Publish-Orchestrator.ps1 script using the -testAutomationFeatureEnabled parameter: AppSettings: Key=TestAutomation.ModuleEnabled – Legen Sie True fest, um das Modul Testautomatisierungsmodul zu aktivieren. AppSettings: Key=TestAutomation.FeatureEnabledByDefault – Auf True festlegen, um das Testautomatisierungsmodul standardmäßig zu aktivieren. Standardmäßig ist diese Funktion deaktiviert, es sei denn, sie wurde explizit aktiviert. ConnectionString: Name=TestAutomation – Legen Sie die Verbindungszeichenfolge der Testautomatisierungsdatenbank fest. Sie können eine ähnliche Verbindungszeichenfolge wie die für den Orchestrator oder eine ganz andere verwenden. Zum Beispiel: 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: Markieren Sie diese Einstellungen als Deployment slot setting, insbesondere, wenn Sie Hotswap-Steckplätze verwenden. Aktivieren der Testautomatisierung nach der Orchestrator-Installation Wenn Sie Orchestrator bereits bereitgestellt haben, ohne das Modul „Testautomatisierung“ zu aktivieren, führen Sie das Skript Publish-Orchestrator.ps1 mit den gleichen Parametern wie bei einem Upgrade aus, und fügen Sie den Parameter -testAutomationFeatureEnabled hinzu. Upgrade von Orchestrator Wenn Sie Ihre Orchestrator-Instanz upgraden, fügen Sie den Parameter -testAutomationFeatureEnabled zum Skript Publish-Orchestrator.ps1 hinzu, bevor Sie es ausführen. For more details about upgrading Orchestrator, see Publish-Orchestrator.ps1 Update.
-insightsFeatureEnabled	Optional. Dieser Parameter aktiviert das Insights-Modul und die Funktion. Sie können diese Funktion in einem der folgenden Szenarien aktivieren: Starten Sie mit einer Neuinstallation des Orchestrators erneut Konfigurieren Sie die folgenden Einstellungen für Ihren App-Dienst, bevor Sie das Skript Publish-Orchestrator.ps1 mit dem Parameter -insightsFeatureEnabled ausführen: AppSettings: Key= Insights.ModuleEnabled – Auf True festlegen, um das Insights-Modul zu aktivieren. AppSettings: Key= Insights.FeatureEnabledByDefault – Auf True festlegen, um das Insights-Modul standardmäßig zu aktivieren. Standardmäßig ist diese Funktion deaktiviert, es sei denn, sie wurde explizit aktiviert. ConnectionString: Name= Insights – Legt die Verbindungszeichenfolge der Insights-Datenbank fest. Sie können eine ähnliche Verbindungszeichenfolge wie die für den Orchestrator oder eine ganz andere verwenden. Zum Beispiel: 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 Insights nach der Orchestrator-Installation aktivieren Wenn Sie den Orchestrator bereits bereitgestellt haben, ohne das Insights-Modul zu aktivieren, führen Sie das Skript Publish-Orchestrator.ps1 mit denselben Parametern wie für ein Upgrade aus und fügen Sie den Parameter –insightsFeatureEnabled hinzu. Upgrade von Orchestrator Wenn Sie Ihre Orchestrator-Instanz upgraden, fügen Sie den Parameter -insightsFeatureEnabled zum Skript Publish-Orchestrator.ps1 hinzu, bevor Sie es ausführen. For more details about upgrading Orchestrator, see Publish-Orchestrator.ps1 Update.
-updateServerFeatureEnabled	Optional. Mit diesem Parameter wird das Modul für die Aktualisierung des Servers aktiviert. Sie können diese Funktion in einem der folgenden Szenarien aktivieren: Starten Sie mit einer Neuinstallation des Orchestrators erneut Configure the following settings for your App Service before running the Publish-Orchestrator.ps1 script using the -updateServerFeatureEnabled parameter: AppSettings: Key=UpdateServer.ModuleEnabled – Legen Sie True fest, um das Modul zur Aktualisierung des Servers zu aktivieren. AppSettings: Key=UpdateServer.FeatureEnabledByDefault – Legen Sie True fest, um das Modul zur Aktualisierung des Servers standardmäßig zu aktivieren. Standardmäßig ist diese Funktion deaktiviert, es sei denn, sie wurde explizit aktiviert. ConnectionString: Name=UpdateServer – Legen Sie die Verbindungszeichenfolge der Datenbank zur Aktualisierung des Servers fest. Sie können eine ähnliche Verbindungszeichenfolge wie die für den Orchestrator oder eine ganz andere verwenden. Zum Beispiel: 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 Aktivieren Sie die „Aktualisierung des Servers“ nach der Orchestrator-Installation Wenn Sie den Orchestrator bereits bereitgestellt haben, ohne das Modul zur Aktualisierung des Servers zu aktivieren, führen Sie das Skript Publish-Orchestrator.ps1 mit den gleichen Parametern wie bei einem Upgrade aus, und fügen Sie den Parameter -updateServerFeatureEnabled hinzu. Upgrade von Orchestrator Wenn Sie Ihre Orchestrator-Instanz upgraden, fügen Sie den Parameter -updateServerFeatureEnabled zum Skript Publish-Orchestrator.ps1 hinzu, bevor Sie es ausführen. For more details about upgrading Orchestrator, see Publish-Orchestrator.ps1 Update.
-robotsElasticSearchUrl	Optional. Dies sollte nur verwendet werden, wenn Sie Elasticsearch für die Protokollierung verwenden möchten. Geben Sie die Elasticsearch-URL als Wert an, z. B. "http://elasticserver:9200". Wenn Ihre Orchestrator-Instanz eine Authentifizierung erfordert, geben Sie die Parameter ElasticSearchUsername, ElasticSearchPassword, elasticSearchDiagnosticsUsername und elasticSearchDiagnosticsPassword an.
-robotsElasticSearchTargets	Optional. Dieser Parameter ermöglicht Ihnen, Robot-Protokolle nur zu dem konfigurierten Elasticsearch-Server zu senden. Geben Sie die URL von Elasticsearch als Wert an wie zum Beispiel "http://elasticserver:9200". Bitte beachten Sie, dass dieser Wert nur in Verbindung mit dem Parameter -robotsElasticSearchUrl verwendet werden kann. Wenn Sie diesen Parameter nicht angeben, werden Robot-Protokolle sowohl zu der konfigurierten SQL-Datenbank als auch zu Elasticsearch gesendet.
-robotsElasticSearchUsername	Optional. Dieser Parameter ermöglicht Ihnen, den Benutzernamen für Ihre Elasticsearch-Instanz anzugeben, wenn deren Authentifizierung aktiviert ist.
-robotsElasticSearchPassword	Optional. Dieser Parameter ermöglicht Ihnen, das Passwort für Ihre Elasticsearch-Instanz anzugeben, wenn deren Authentifizierung aktiviert ist.
-serverElasticSearchDiagnosticsUsername	Optional. Dieser Parameter ermöglicht Ihnen, den Benutzernamen für Ihre Elasticsearch-Instanz anzugeben, wenn deren Authentifizierung aktiviert ist. Dieser Parameter ist zusammen mit elasticSearchDiagnosticsPassword "Password" für interne Orchestrator-Protokolle erforderlich.
-serverElasticSearchDiagnosticsPassword	Optional. Dieser Parameter ermöglicht Ihnen, das Passwort für Ihre Elasticsearch-Instanz anzugeben, wenn deren Authentifizierung aktiviert ist. Dieser Parameter ist zusammen mit elasticSearchDiagnosticsUsername "Username" für interne Orchestrator-Protokolle erforderlich.
-loadBalancerUseRedis	Optional. Verwenden Sie Redis als Datenbank, um Nachrichten und Cache an und von allen Maschinen zu verteilen, die über Ihren Lastenausgleich verbunden sind. Wenn -redisConnectionString angegeben ist, wird die Option automatisch auf true festgelegt, andernfalls wird sie auf false festgelegt.
-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. Beispiele: mit aktiviertem SSL - -redisConnectionString "docs123.redis.cache.windows.net:6380,password=******,ssl=True" ohne aktiviertes SSL - -redisConnectionString "docs123.redis.cache.windows.net:6380,password=******,ssl=False"
-azureSignalRConnectionString	Optional. Hilft Ihnen dabei, Azure SignalR Service zu aktivieren, wodurch eine direkte Kommunikation zwischen Ihrer Roboterflotte und SignalR Service ermöglicht wird – Orchestrator ist nicht mehr zwischengeschaltet. Bitte beachten Sie, dass bei Aktivierung dieser Option Roboter mit einer niedrigeren Version als 2019.2 für die Kommunikation mit Orchestrator nur das Heartbeat-Protokoll verwenden, d. h. dass ein von Orchestrator gegebener Befehl nur alle 30 Sekunden von einem Roboter aufgenommen wird. Beispiel: -azureSignalRConnectionString "Endpoint=https://doctest.signalr.net;AccessKey=M1ug+sBu07hyyi12AgyJ52SEd4OgC2Mm6BvllVHCC9c=;Version=1.0;"
-storageType	Optional. Definiert das Ziel, in dem Ausführungsmedien und Pakete gespeichert werden sollen. Es kann mit den folgenden Zielen ausgefüllt werden: FileSystem - wie zum Beispiel storageType "FileSystem". Dies ist der Standardwert sowohl bei Aktualisierungen als auch bei Neuinstallationen, auch wenn der Parameter nicht angegeben ist. Azure - wie zum Beispiel storageType "Azure". Amazon - wie zum Beispiel storageType "Amazon". Minio - wie zum Beispiel storageType "Minio". Wenn Sie den Parameter UiPath.Orchestrator.dll.config Storage.Type im Abschnitt Konfiguration von Azure App Service überschrieben haben, müssen Sie diesen Wert beim Aktualisieren als Skriptparameter an Publish-Orchestrator.ps1 übergeben.
-storageLocation	Optional. Gibt den tatsächlichen Speicherort an, an dem die Ausführungsmedien und -pakete abgelegt werden sollen. Besonderheiten: FileSystem – Stellen Sie einen absoluten Pfad im RootPath=.\Storage-Format bereit, z. B. storageLocation "RootPath=C:\FolderName\AnotherFolderName". Dies ist der Standardwert sowohl bei Aktualisierungen als auch bei Neuinstallationen, auch wenn der Parameter nicht angegeben ist. Azure - geben Sie eine Verbindungszeichenfolge wie zum Beispiel storageLocation "DefaultEndpointsProtocol=https;AccountName=usr;AccountKey=...;EndpointSuffix=core.windows.net" an. Amazon - geben Sie eine Verbindungszeichenfolge wie zum Beispiel storageLocation" "EndpointRegion=eu-west-3;accessKey=AKIAZGUEIGXUJ3BBI4MW;secretKey=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;useHttp=false" an. Minio - geben Sie eine Verbindungszeichenfolge wie zum Beispiel storageLocation" "host=localhost:9001;accessKey=YVKYFJ0ZY246KDKP0634;secretKey=bdBEk2ubhIFsTNPuQ80PjKL+oqZBj67HoSWBFnw1" an. More information on these deployments types is available here. Wenn Sie den Parameter UiPath.Orchestrator.dll.config Storage.Location im Abschnitt Konfiguration von Azure App Service überschrieben haben, müssen Sie diesen Wert beim Aktualisieren als Skriptparameter an Publish-Orchestrator.ps1 übergeben.
-standbyslotname	Optional. Kann nur in Upgrade-Szenarien verwendet werden. Wenn angegeben, stellt das Skript Orchestrator im angegebenen App-Service-Slot anstelle des Produktions-Slots bereit. Zusätzlich wird ein Swap-Slot mit dem Produktions-Slot ohne Ausfallzeit ausgeführt. Voraussetzungen: Der Standby-App Service-Slot muss auf eine andere SQL-Datenbank verweisen. the standby slot Connection String must be made slot sticky (by selecting the Slot Setting box in Azure Portal). die Produktions-Slot-Datei UiPath.Orchestrator.dll.config muss aus dem Produktions-Slot in den Standby-Slot kopiert werden.
-productionSlotName	Optional. Kann nur verwendet werden, wenn sich der Bereitstellungs-Slot des App Service für Orchestrator von dem durch Azure festgelegten Standard-Produktionsslot von App-Service unterscheidet.
-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. Bitte beachten Sie, dass vorhandene Einstellungen mit neuen Einstellungen zusammengeführt werden.
-stopApplicationBeforePublish	Optional. Wenn vorhanden, wird die Anwendung vor der Bereitstellung angehalten und nach Abschluss der Bereitstellung gestartet.
-unattended	Optional. Wenn vorhanden, wird die Bereitstellung ohne Benutzerbestätigung fortgesetzt.
-bucketsAvailableProviders	Optional. Ein String, der eine durch Kommas getrennte Liste von Bucket-Anbietern enthält, die Sie aktivieren möchten. Wenn nicht genauer angegeben, wird standardmäßig Orchestrator,Amazon,Azure,Minio eingestellt. Sie haben auch die Möglichkeit, den FileSystem-Anbieter zu aktivieren, indem Sie ihn dieser Liste hinzufügen. Achtung: Wenn Sie den FileSystem-Anbieter verwenden und auf 20.10.7 oder höher aktualisieren, müssen Sie einen Wert übergeben, der FileSystem für diesen Parameter enthält. Andernfalls ist dieser Anbieter deaktiviert und Sie können diese Buckets nicht mehr verwenden.
-bucketsFileSystemAllowlist	Nur obligatorisch, wenn FileSystem als Bucket-Anbietern ausgewählt wird. Die Liste der Speicherorte, an denen Sie die Erstellung von Buckets für den FileSystem-Anbieter zulassen möchten. Wenn Sie den FileSystem-Anbieter aktivieren, müssen Sie auch einen Wert für diesen Parameter übergeben. Werte sind eine Liste von UNC-Pfaden, die durch einen senkrechten Strich | getrennt sind (z. B. \mysharedstorage\mybyckets\myotherserver\myotherbuckets).
-noAzureAuthentication	Optional. Ermöglicht Ihnen die Veröffentlichung im Azure App-Dienst, indem Sie sich auf Ihre eigene Benutzeridentität verlassen, ohne einen Dienstprinzipal erstellen zu müssen. Wenn dieser Parameter verwendet wird, ist der Parametersatz UseServicePrincipal (der Elemente wie die Azure Anwendungs-ID, das Kennwort, die Abonnement-ID und die Mandanten-ID enthält) nicht mehr erforderlich.
-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	Optional. Dieser Parameter wird nur für Bereitstellungen der US-Regierung verwendet.

Parameter bei der Aktualisierung beibehalten

Die folgenden UiPath.Orchestrator.dll.config-Parameterwerte werden beim Durchführen einer Aktualisierung automatisch migriert und beibehalten. Um sie zu ändern, geben Sie beim Aufrufen des Skripts Publish-Orchestrator.ps1 neue Werte an.

-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

Beispiele

Einzelknoten-Installation

Im folgenden Beispiel können Sie eine Neuinstallation von Orchestrator auf einem Knoten durchführen, Elasticsearch für die Protokollierung verwenden und Pakete im Azure-Blobspeicher und deren Metadaten in der SQL-Datenbank speichern. Die Prozedur erfolgt -unattended und protokolliert ihre Schritte auf -verbose-Ebene.

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

Mehrfach-Knoten-Installation

Im folgenden Beispiel können Sie eine Neuinstallation von Orchestrator auf mehreren Knoten durchführen und Elasticsearch für die Protokollierung und Redis für die Zwischenspeicherung und Nachrichtenverteilung verwenden. Pakete werden im Azure-Blobspeicher und deren Metadaten in der SQL-Datenbank gespeichert. Die Prozedur erfolgt -unattended und protokolliert ihre Schritte auf -verbose-Ebene.

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

Aktualisierung mehrerer Knoten

Im folgenden Beispiel können Sie einen vorhandenen Orchestrator mit mehreren Knoten auf die neueste verfügbare Version aktualisieren, ohne dass bereits vorhandene Einstellungen geändert werden müssen. Die Prozedur erfolgt -unattended und protokolliert ihre Schritte auf -verbose-Ebene.

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

Im folgenden Beispiel können Sie einen vorhandenen Orchestrator mit mehreren Knoten auf die neueste verfügbare Version aktualisieren, während nur der Wert der Parameter Webhooks.Enabled und Telemetry.Enabled in false geändert wird. Die Prozedur erfolgt -unattended und protokolliert ihre Schritte auf -verbose-Ebene.

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