Scripts Orchestrator

Publier dans Orchestrator

Le tableau suivant décrit tous les paramètres pouvant être utilisés avec Publish-Orchestrator.ps1.

Paramètre	Description
-action	Obligatoire. Indique le type de scénario que vous souhaitez démarrer. Les options suivantes sont disponibles : Deploy : indique qu'il s'agit d'une nouvelle installation ; Update : indique que vous mettez à jour votre instance d'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	Obligatoire. Mot de passe du jeton Azure pour l'ID de principal de service.
-azureSubscriptionId	Obligatoire. ID d'abonnement Azure pour l'application App Service qui héberge Orchestrator.
-azureAccountTenantId	Obligatoire. ID de locataire Azure.
-resourceGroupName	Obligatoire. Nom du groupe de ressources Azure qui contient l'application App Service d'Orchestrator.
-appServiceName	Obligatoire. Nom de l'application Azure App Service d'Orchestrator.
-hostAdminPassword	Obligatoire uniquement pour les nouveaux déploiements, lorsque -action est défini sur Deploy. Spécifiez un mot de passe personnalisé pour l'administrateur hôte. Veuillez noter que les mots de passe doivent comporter au moins 8 caractères, ainsi qu'au moins un caractère minuscule et au moins un chiffre.
-isHostPassOneTime	Facultatif. Permet d'appliquer une réinitialisation du mot de passe à la première connexion de l'administrateur locataire. Si ce paramètre est omis, le mot de passe de l'administrateur locataire n'est pas un mot de passe à usage unique.
-defaultTenantAdminPassword	Obligatoire uniquement pour les nouveaux déploiements, lorsque -action est défini sur Deploy. Spécifiez un mot de passe personnalisé pour l'administrateur locataire par défaut. Veuillez noter que les mots de passe doivent comporter au moins 8 caractères, ainsi qu'au moins un caractère minuscule et au moins un chiffre.
-isDefaultTenantPassOneTime	Facultatif. Permet d'appliquer une réinitialisation du mot de passe à la première connexion de l'administrateur locataire par défaut. Si ce paramètre est omis, le mot de passe de l'administrateur des tenant n'est pas un mot de passe à usage unique.
-package	Obligatoire. Indiquez le chemin d'accès complet de l'archive UiPath.Orchestrator.Web.zip.
-activitiesPackagePath	Facultatif. Spécifiez le chemin complet de l'archive UiPathActivities.zip, qui est incluse par défaut, en commençant par v2018.4.4, dans UiPathOrchestrator.zip. Cela permet d'installer le flux d'activités local dans Azure au moment de l'installation. Notez que ce paramètre ne peut être utilisé qu'avec le type de référentiel Legacy. Sinon, il doit être configuré manuellement.
-testAutomationFeatureEnabled	En option. Ce paramètre active le module d’automatisation de tests, pour les files d’attente de données de test, l’exécution des tests et la planification. Vous pouvez activer cette fonctionnalité en fonction de l’un des scénarios suivants : Prendre un nouveau départ avec une installation Orchestrator de qualité Configure the following settings for your App Service before running the Publish-Orchestrator.ps1 script using the -testAutomationFeatureEnabled parameter: AppSettings : Key=TestAutomation.ModuleEnabled : définissez sur True pour activer le module d'automatisation de test. Paramètres de l'application (AppSettings) : Clé= TestAutomation.FeatureEnabledByDefault - Définissez sur True pour activer le module par défaut Automatisation de test (Test Automation). Par défaut, cette fonctionnalité est désactivée à moins qu'elle ne soit explicitement activée. ConnectionString : Name=TestAutomation - définissez la chaîne de connexion de la base de données Automatisation de test (Test Automation). Vous pouvez soit utiliser une chaîne de connexion similaire à celle utilisée pour Orchestrator, soit une chaîne complètement différente. Par exemple : 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 Assurez-vous de marquer ces paramètres en tant que Deployment slot setting, surtout si vous utilisez des créneaux de hotswap. Activez l'automatisation de test après l'installation d'Orchestrator Si vous avez déjà déployé Orchestrator sans activer le module Automatisation des tests, exécutez le script Publish-Orchestrator.ps1 avec les mêmes paramètres que pour une mise à niveau et ajoutez le paramètre -testAutomationFeatureEnabled . Mise à niveau Orchestrator Si vous mettez à niveau votre instance Orchestrator, exécutez le script Publish-Orchestrator.ps1 avec les mêmes paramètres que pour une mise à niveau, et ajoutez le paramètre -testAutomationFeatureEnabled.
-robotsElasticSearchUrl	Facultatif. Vous devez l'utiliser uniquement si vous souhaitez utiliser Elasticsearch pour la journalisation. Indiquez l'URL d'Elasticsearch comme valeur, telle que "http://elasticserver:9200". Si votre instance d'Orchestrator requiert l'authentification, fournissez les paramètres ElasticSearchUsername, ElasticSearchPassword, elasticSearchDiagnosticsUsername et elasticSearchDiagnosticsPassword.
-robotsElasticSearchTargets	Facultatif. Ce paramètre permet d'envoyer des journaux Robot uniquement au serveur Elasticsearch configuré. Indiquez l'URL d'Elasticsearch comme valeur, telle que "http://elasticserver:9200". Notez qu'il ne peut être utilisé que conjointement avec le paramètre -robotsElasticSearchUrl. Si vous ne fournissez pas ce paramètre, les journaux du Robot sont envoyés à la fois à la base de données SQL configurée et à Elasticsearch.
-robotsElasticSearchUsername	Facultatif. Ce paramètre permet d'indiquer le nom d'utilisateur de votre instance d'Elasticsearch, si son authentification est activée.
-robotsElasticSearchPassword	Facultatif. Ce paramètre permet d'indiquer le mot de passe de votre instance d'Elasticsearch, si son authentification est activée.
-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.
-useQuartzClustered	Facultatif. Switch qui indique que c'est une installation en cluster.
-loadBalancerUseRedis	Facultatif. Utilisez Redis comme base de données pour distribuer les messages et les mettre en cache vers/depuis toutes les machines connectées via votre équilibreur de charge. Si -redisConnectionString est spécifié, il est automatiquement défini sur true, sinon il est défini sur 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. Exemples : avec SSL activé : -redisConnectionString "docs123.redis.cache.windows.net:6380,password=******,ssl=True" sans SSL activé : -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	Facultatif. Définit la cible où les supports d'exécution et les paquets doivent être enregistrés. Vous pouvez la renseigner à l'aide des cibles suivantes : FileSystem - such as storageType "FileSystem" . This is the default value in both update scenarios and clean installations, even if the parameter is not specified. Azure - such as storageType "Azure" . Amazon - such as storageType "Amazon" . Minio - such as storageType "Minio" . Si vous avez remplacé le paramètre UiPath.Orchestrator.dll.config Storage.Type dans la section Configuration du service d’application Azure, lors de la mise à niveau, vous devez définir cette valeur comme paramètre de script sur Publish-Orchestrator.ps1.
-storageLocation	Facultatif. Définit l'emplacement réel de l'enregistrement des supports d'exécution et des paquets. Particularités : FileSystem - provide an absolute path in the RootPath=.\Storage format, such as storageLocation "RootPath=C:\FolderName\AnotherFolderName" . This is the default value in both update scenarios and clean installations, even if the parameter is not specified. Azure - provide a connection string, such as storageLocation "DefaultEndpointsProtocol=https;AccountName=usr;AccountKey=...;EndpointSuffix=core.windows.net" . Amazon - provide a connection string, such as storageLocation" "EndpointRegion=eu-west-3;accessKey=AKIAZGUEIGXUJ3BBI4MW;secretKey=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;useHttp=false" . Minio - provide a connection string, such as storageLocation" "host=localhost:9001;accessKey=YVKYFJ0ZY246KDKP0634;secretKey=bdBEk2ubhIFsTNPuQ80PjKL+oqZBj67HoSWBFnw1" . More information on these deployments types is available here. Si vous avez remplacé le paramètre UiPath.Orchestrator.dll.config Storage.Location dans la section Configuration du service d’application Azure, lors de la mise à niveau, vous devez définir cette valeur comme paramètre de script sur Publish-Orchestrator.ps1.
-standbyslotname	Facultatif. Il ne peut être utilisé que dans des scénarios de mise à niveau. S'il est spécifié, le script déploie Orchestrator dans l'emplacement de service d'application indiqué au lieu de celui de production. De plus, un emplacement d'échange est effectué avec l'emplacement de production, sans temps d'arrêt. Prérequis : l'emplacement d'App Service de secours doit désigner une autre base de données SQL. the standby slot Connection String must be made slot sticky (by selecting the Slot Setting box in Azure Portal). le fichier de l'emplacement de production UiPath.Orchestrator.dll.config doit être copié vers l'emplacement de secours à partir de l'emplacement de production.
-productionSlotName	Facultatif. Il ne peut être utilisé que si l'emplacement de déploiement de l'application App Service d'Orchestrator est différent de l'emplacement par défaut de l'application App Service de production défini par Azure.
-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. Notez que les paramètres existants sont fusionnés avec les nouveaux.
-stopApplicationBeforePublish	Facultatif. S’il est actif, il arrête l’application avant le déploiement et la démarre une fois le déploiement terminé.
-unattended	Facultatif. S'il est actif, le déploiement se poursuit sans confirmation de l'utilisateur.
-bucketsAvailableProviders	En option. Une chaîne contenant une liste, séparée par des virgule, de fournisseurs de compartiment que vous souhaitez activer. Si elle n'est pas spécifiée, la valeur par défaut sera Orchestrator,Amazon,Azure,Minio. Vous avez également la possibilité d’activer le fournisseur FileSystem en l’ajoutant à cette liste. Attention: Si vous utilisez le fournisseur FileSystem et effectuez une mise à niveau vers la version 20.10.7 ou une version ultérieure, vous devez insérer une valeur qui inclut FileSystem pour ce paramètre. Si vous ne faites pas cela, ce fournisseur sera désactivé et vous ne serez plus en mesure d’utiliser ces compartiments.
-bucketsFileSystemAllowlist	Obligatoire uniquement lorsque FileSystem est sélectionné comme fournisseur de compartiment. La liste des emplacements où vous souhaitez autoriser la création de compartiments par le fournisseur FileSystem. Si vous activez le fournisseur FileSystem, vous devez également insérer une valeur pour ce paramètre. Les valeurs sont une liste de chemins UNC, séparés par le symbole de canal | (par exemple, \\mysharedstorage\mybyckets\|\\myotherserver\myotherbuckets).

Paramètres conservés lors de la mise à jour

Les valeurs du paramètre UiPath.Orchestrator.dll.config suivantes sont automatiquement migrées et conservées lors de l'exécution d'une mise à jour. Pour les modifier, fournissez de nouvelles valeurs lors de l'appel du script 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

Exemples

Installation sur un nœud unique

L'exemple suivant permet d'effectuer une nouvelle installation d'Orchestrator sur un nœud, d'utiliser Elasticsearch pour la journalisation et d'enregistrer des paquets dans le stockage d'objets blob Azure et leurs métadonnées dans la base de données SQL. La procédure se déroule d'une manière -unattended et ses étapes sont consignées au niveau de -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" `
-hostAdminPassword "12345qwert" `
-defaultTenantAdminPassword "12345qwert" `
-storageType "Azure" `
-storageLocation "DefaultEndpointsProtocol=https;AccountName=usr;AccountKey=...;EndpointSuffix=core.windows.net" `
-robotsElasticSearchUrl "http://docelasticserver:9200" `
-verbose

Installation à plusieurs nœuds

L'exemple suivant permet d'effectuer une nouvelle installation d'Orchestrator sur plusieurs nœuds, d'utiliser Elasticsearch pour la journalisation et Redis pour la mise en cache et la distribution des messages. Les paquets sont enregistrés dans le stockage d'objets blob Azure et leurs métadonnées dans la base de données SQL. La procédure se déroule de manière -unattended et ses étapes sont consignées au niveau de -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" `
-useQuartzClustered `
-redisConnectionString "docs123.redis.cache.windows.net:6380,passwprd=******,ssl=True" `
-azureSignalRConnectionString "Endpoint=https://doctest.signalr.net;AccessKey=*****;Version=1.0;" `
-robotsElasticSearchUrl "http://docelasticserver:9200" `
-hostAdminPassword "12345qwert" `
-defaultTenantAdminPassword "12345qwert" `
-storageType "Azure" `
-storageLocation "DefaultEndpointsProtocol=https;AccountName=usr;AccountKey=...;EndpointSuffix=core.windows.net" `
-verbose

Mise à jour multinœud

L'exemple suivant permet de mettre à niveau une entité d'Orchestrator multinœud existante vers la dernière version disponible, sans modifier aucun paramètre préexistant. La procédure se déroule dans un mode -unattended et ses étapes sont consignées au niveau de -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

L'exemple suivant permet de mettre à niveau une entité d'Orchestrator multinœud existante vers la dernière version disponible, tout en remplaçant la valeur des paramètres Webhooks.Enabled et Telemetry.Enabled par false. La procédure se déroule dans un mode -unattended et ses étapes sont consignées au niveau de -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