Outil de configuration de la plate-forme

Important :

L’outil de configuration de la plate-forme fonctionne pour les mises à niveau réalisées à partir d’une version publiée au cours des trois dernières années par rapport à la version majeure actuelle. Les vérifications et opérations post-installation fonctionnent après l'installation d'Orchestrator.

Vue d'ensemble (Overview)

L’outil de configuration de la plate-forme UiPath est un script PowerShell utilisé pour vous aider durant l’installation et la mise à niveau d’Orchestrator. Il vous aide à vérifier le bon état et la disponibilité de votre environnement avant une mise à niveau, et vous aide à effectuer plusieurs opérations après l’installation.

L’outil peut être téléchargé ci-dessous et est également livré avec le programme d'installation UiPathOrchestrator.msi. Le script groupé peut être trouvé dans le dossier Tools du répertoire d’installation Orchestrator, C:\Program Files (x86)\UiPath\Orchestrator\ par défaut. Le script vérifie la machine Orchestrator. Dans le cas d’une installation multi-nœuds, il suffit d’exécuter l’outil sur un nœud.

L’outil de configuration de plate-forme ne suit pas le même schéma de version que l'installateur UiPathOrchestrator.msi et peut être mis à jour en dehors du cycle de sortie du produit. Nous vous recommandons de toujours télécharger et utiliser la dernière version de l’outil qui est disponible ci-dessous.

Télécharger l'outil

Prérequis

Logiciels	Version compatible
PowerShell	5.1
Module WebAdministration	S/O

Script Cmdlets

Le script se compose de trois cmdlets destinés à exercer des fonctions spécifiques. Une commande d’invocation de cmdlet et ses paramètres pertinents peuvent être entrés dans la ligne de commande pour une exécution immédiate.

Cmdlet	Description
Test-PlatformReadiness	Invoqué à l'aide de-Readiness commande. Vérifie le bon état et l’état de préparation de votre environnement avant une mise à niveau et les exigences du certificat après l’installation.
Update-UiPathUrl	Invoqué à l'aide deUpdateUiPathUrl commande. Met à niveau l'adresse publique d'Orchestrator.
Update-UiPathCertificate	Invoqué à l'aide deUpdateUiPathCertificate commande. Met à jour le certificat SSL Orchestrator ou le certificat de signature de jetons du serveur d'identité.
AddHostAdmin	Invoqué à l'aide deAddHostAdmin commande. Ajoute un administrateur système au locataire hôte.

Vérifications préalables à l’installation

Asp.Net Core

Vérifie si ASP.NET Core IIS module v3.1.x+ est installé et fonctionne. Si ce n’est pas le cas, vous êtes invité à désinstaller et réinstaller le ASP.Net Core Hosting Bundle.

CyberArk AIM

Vérifie si l’agent AIM CyberArk est installé sous le dossier C:\Program Files (x86)\CyberArk. Si ce n’est pas le cas, l’utilisateur est invité à ajouter CLIPasswordSdk.exe dans le fichier UiPath.Orchestrator.dll.config en utilisant la clé Plugins.SecureStores.CyberArk.CLIPasswordSDKExePath après l’installation.

Cette vérification n’est pas effectuée si CyberArk ne se trouve pas dans UiPath.Orchestrator.dll.config.

Cryptage web.config

Vérifie si le fichier web.config est décrypté. S'il est crypté, vous devez le décrypter manuellement avant de le mettre à niveau. Après la mise à niveau, la plupart des paramètres de configuration d’Orchestrator sont déplacés vers UiPath.Orchestrator.dll.config.

Learn how to encrypt the UiPath.Orchestrator.dll.config file.

web.config Sections verrouillées

Vérifie si l'élément <system.webServer> ne contient pas de sections verrouillées. Si de telles sections existent, vous devez les déverrouiller manuellement dans IIS.

Mise à l’échelle de SQL Server

Vérifie si SQL Server Scaleout est utilisé. Vous êtes informé que lors de l’installation Redis Scaleout est activé.

Plug-ins des magasins d'identifiants

Checks that external credential store plugins target a supported framework.

Plugins NLog

Checks that NLog plugins target a supported framework.

Compartiments FileSystem

Ce contrôle vérifie que le paramètre de l'application Buckets.FileSystem.Allowlist est bien présent dans les versions d'Orchestrator à partir de v2020.4. Cela couvre à la fois les vérifications pré-installation (Orchestrator v2022.4) et les vérifications post-installation (Orchestrator v2022.4). Les versions d'Orchestrator antérieures à v2020.4 ne sont pas soumises à cette vérification.

• Pour effectuer les contrôles suivants, vous devez décrypter les sections de configuration connectionStrings et appSettings. Si l’une de ces sections de configuration est cryptée, un avertissement apparaît dans le terminal, et le reste des validations des compartiments est ignoré.

  Could not determine if any buckets with file system provider are in use. Config section 'connectionString' is encrypted, could not find the sql connection string to the UiPath database.
  

• Si, pour une raison quelconque, les compartiments n'ont pas pu être récupérés dans la base de données, un avertissement apparaît dans le terminal, et le reste des validations est également ignoré.

  Could not determine if any buckets with file system provider are in use. Could not connect to the UiPath Database.
  

• Cette vérification est effectuée pour les chemins racine des compartiments récupérés dans la table des compartiments de la base de données Orchestrator. S’il y a des chemins incomplets, alors un avertissement apparaît dans le terminal. Un contrôle similaire sur les chemins non autorisés est effectué pour les chemins dans le paramètre de l'application Buckets.FileSystem.Allowlist du fichier de configuration.

• Si l’un ou l’autre des chemins des deux sources n’est pas valide ou incomplet, il ne sera pas pris en compte dans le reste des validations décrites ci-dessous.

• Si le paramètre de l'application Buckets.FileSystem.Allowlist n’est pas défini dans le fichier de configuration, alors un message d'erreur apparaît dans le terminal vous demandant d’ajouter la liste d'autorisation au fichier de configuration. Les chemins suggérés sont les chemins racine des compartiments qui utilisent le fournisseur de système de fichiers.

  All storage buckets using the file system provider are not on the allowed list. Add the following setting in the configuration file to allow all exiting buckets root paths: <add key="Buckets.FileSystem.Allowlist" value="C:\work\stuff\Bucket\|C:\work\stuff\Bucket1\" />
  

• Si le paramètre de l'application Buckets.FileSystem.Allowlist est défini dans le fichier de configuration, une validation est effectuée sur le chemin racine des compartiments qui utilisent le fournisseur FileSystem. Si un chemin racine de compartiment n’est pas un sous-chemin de l’un des chemins définis dans la liste d'autorisation, alors un un avertissement apparaît dans le terminal vous demandant d’ajouter le chemin racine du compartiment à Buckets.FileSystem.Allowlist .

  There are some storage buckets using the file system provider that are not on the allowed list. The buckets feature will not work for buckets with root paths that are not on the allowed list. Check if any of the following paths are required to be on the allowed list and add them to the 'Buckets.FileSystem.Allowlist' key in configuration file: |C:\work\stuff\Buckets\|C:\work\stuff\Bucket1\
  

• En revanche, si chaque chemin racine des compartiments est un sous-chemin d'un chemin d'accès validé par la liste d'autorisation, alors le terminal affiche un message de réussite.

  All storage buckets using file system provider have the root path on the allow list in the configuration file.
  

Vérifications post-installation

Exigences en matière de certificat

Checks that all certificate requirements are met by your Orchestrator instance after an upgrade.

Vérifications du certificat SSL

• le hostname du site Orchestrator correspond au sujet ou au nom alternatif du sujet (y compris les caractères génériques) sur le certificat,
• dispose d'une chaîne approuvée valide, et
• n’est pas expiré.

Vérifications du certificat de signature de jetons du serveur d’identité

• Le certificat a la taille de clé appropriée (2048 bits ou plus),
• dispose d'une clé privée accessible par l'utilisateur d'AppPool, et
• n’est pas expiré.

Autres considérations

Check the docs on installation considerations for other areas impacted by an upgrade to v2022.4 that you need to be aware of.

Exécution du script

Référence de commande

Commande & Paramètres	Description
-Readiness	Vérifie le bon état et l’état de préparation de votre environnement avant une mise à niveau et les exigences du certificat après l’installation. Paramètres : -SiteName -Help -InstallationDirectory
-UpdateUiPathUrl	Met à niveau l'adresse publique d'Orchestrator. Paramètres : -SiteName -OrchestratorUrl -SqlConnectionString The SQL Server PowerShell module is required to use this command. The module is installed by default with SQL Server. If you’re working on a machine that doesn’t have the module installed, see here how to install it. Utilisez cette commande avec prudence car elle n’a pas de mécanisme de restauration si une étape échoue pendant l’exécution.
-UpdateUiPathCertificate	Met à jour le certificat Orchestrator SSL ou le certificat de signature de jetons du serveur d'identité. Utilisez-le conjointement avec la commande -readiness pour vérifier la validité des nouveaux certificats. Paramètres : -SiteName -NewTokenSigningThumbprint -NewSSLThumbprint
-AddHostAdmin	Si l'accès à l'organisation hôte est perdu (par exemple, si le mot de passe de l'administrateur système est perdu ou si les seuls utilisateurs disposant de comptes d'administrateur système quittent l'entreprise), vous pouvez utiliser cette commande pour ajouter ou restaurer un administrateur système. Paramètres : -SiteName -HostAdminUsername -HostAdminPassword -HostAdminEmail

Paramètres de script

Paramètre	Description
-SiteName	Facultatif. Nom du site Web Orchestrator sur la machine cible. La valeur par défaut est "UiPath Orchestrator". -InstallationDirectory et SiteName sont mutuellement exclusifs.
-Help	Facultatif. Affiche des informations sur les options d’outils ou les commandes disponibles, telles que la syntaxe des commandes ou les contrôles qu’elle effectue.
-InstallationDirectory	Facultatif. Le chemin du répertoire d’installation d’Orchestrator. Habituellement, C:\Program Files (x86)\UiPath\Orchestrator\ -InstallationDirectory et SiteName sont mutuellement exclusifs. Make sure the installation directory path ends with a trailing backslash (\).
-OrchestratorUrl	Obligatoire. La nouvelle adresse publique d'Orchestrator.
-SqlConnectionString	Facultatif. Chaîne de connexion de base de données UiPath. Si elle est laissée vide, la valeur est lue à partir du fichier appsettings.Production.json.
-NewTokenSigningThumbprint	Optional. The thumbprint of the new token signing certificate used by the Orchestrator Identity Server.
-NewSSLThumbprint	Optional.The thumbprint of the new SSL certificate used by the Orchestrator Web App.
-HostAdminUsername	Uniquement obligatoire lors de l'utilisation de la commande -AddHostAdmin. Nom d'utilisateur de l'administrateur de l'hôte à créer ou à restaurer.
-HostAdminPassword	E-mail de l'utilisateur administrateur de l'hôte à créer ou à restaurer lors de l'utilisation de la commande -AddHostAdmin. Obligatoire uniquement si vous utilisez ces fournisseurs d'identité externes : Google Azure Active Directory SAML avec stratégie de mappage des utilisateurs de messagerie
-HostAdminEmail	Mot de passe de l'administrateur de l'hôte à créer lors de l'utilisation de la commande -AddHostAdmin. Le mot de passe n'est obligatoire que si l'utilisateur est un utilisateur nécessitant une authentification de base. Le mot de passe devra être changé lors de la première connexion.

Exemples

Pour travailler avec le script d'outil de configuration de plate-forme, ouvrez un script PowerShell administrateur.

Localisez le répertoire où vous avez décompressé l’archive de l’outil de configuration de la plate-forme et localisez le répertoire à cet emplacement :

cd "C:\Program Files (x86)\UiPath\Orchestrator\Tools\PlatformConfiguration"

Effectuer une vérification de préparation

L’exemple suivant vous permet d’effectuer une validation des exigences préalables à l'installation d’Orchestrator. La procédure consigne ses étapes et produit des informations supplémentaires au niveau de -verbose.

.\Platform.Configuration.Tool.ps1 `
-Readiness `
-SiteName "UiPath Orchestrator"

La pré-installation vérifie la réussite de l'opération.

Validating 22.4 pre-installation requirements... Checking AspNetCore hosting module... AspNetCore hosting module is installed. Checking CyberArk CLIPasswordSDK.exe path... CyberArk CLIPasswordSDK.exe was found at the default installation path 'C:\Program Files (x86)\CyberArk\ApplicationPasswordSdk\CLIPasswordSDK.exe'. Checking Web.config sections encryption... Web.config sections are not encrypted. Checking IIS configuration locked sections... Configuration sections are not locked. Checking Orchestrator ssl certificate subject alternative names... Orchestrator host name is valid for the ssl certificate subject alternative names. Checking sql server scaleout use... Sql server scaleout is not used. Checking external credential store plugins target framework... Credential stores plugins validation is finished. Checking external NLog plugins target framework... NLog plugins validation is finished. Checking buckets with file system storage provider... All storage buckets using file system provider have the root path on the allowed list in the configuration file. Checking platform certificates... Platform certificates validation is finished. All 22.4 pre-installation checks are done. Platform readiness validations: 10 succeeded, 0 failed and 0 warning(s).

Modification des certificats après l’installation

L’exemple suivant vous permet de mettre à jour les certificats Orchestrator SSL et de signature de jetons du Serveur d'identité.

.\Platform.Configuration.Tool.ps1 `
-UpdateUiPathCertificate `
-SiteName "UiPath Orchestrator" `
-NewSSLThumbprint "a1b2c3d4" `
-NewTokenSigningThumbprint "z6y5x4v3"

Remarque :

• Tous les fichiers appsettings doivent être déchiffrés avant utilisation du script.
• Si vous avez plusieurs nœuds Orchestrator, veillez à ce que le certificat soit mis à jour sur tous les nœuds de serveur.
• Make sure the certificates have the appropriate permissions set to prevent an internal server error. Refer to Troubleshooting Certificates for more details.

Modification de l’URL d'Orchestrator

L’exemple suivant vous permet de mettre à jour l’URL Orchestrator.

.\Platform.Configuration.Tool.ps1 `
  -UpdateUiPathUrl `
  -OrchestratorUrl "https://mydomainname" `
  -SiteName "UiPath Orchestrator" `
  -SqlConnectionString "Server=myServerName\myInstanceName;Database=myDataBase;User Id=myUsername;Password=myPassword;"

Création d'un nouvel administrateur système

L'exemple suivant crée un nouvel administrateur système sur le locataire hôte à l'aide de l'authentification de base. Notez que si un fournisseur d'identité externe est défini comme exclusif, l'authentification de base n'est accessible que via l'URL hostlogin .

.\Platform.Configuration.Tool.ps1 <code> `
  -AddHostAdmin </code> `
  -SiteName "UiPath Orchestrator" <code> `
  -HostAdminUsername someuser </code> `
  -HostAdminPassword som3pwd! `
  -HostAdminEmail [e-mail]

Sortie

La sortie dispose d'un code couleur.

Couleur	Description
Rouge	Bloqueurs Des éléments sont manquants ou ne sont pas configurés et empêcheront l’installation.
Jaune	Avertissements (Warnings) Vous pouvez installer Orchestrator, mais des avantages supplémentaires seront absents.
Vert	Messages L’environnement est prêt pour l’installation.