Plattform-Konfigurationstool

Wichtig:

Das Plattform-Konfigurationstool funktioniert für Upgrades von Versionen, die innerhalb der letzten drei Jahre erschienen sind, im Vergleich zur aktuellen Hauptversion.Prüfungen und Vorgänge nach der Installation funktionieren nach der Installation des Orchestrators.

Überblick

Das UiPath Platform Configuration Tool ist ein PowerShell-Skript, das Sie bei der erfolgreichen Installation/Aktualisierung von Orchestrator unterstützt. Es hilft Ihnen, die Gesundheit und Bereitschaft Ihrer Umgebung vor einem Upgrade zu überprüfen, und unterstützt Sie bei der Durchführung mehrerer Vorgänge nach der Installation.

Das Tool steht unten zum Download zur Verfügung und ist auch mit dem Installationsprogramm UiPathOrchestrator.msi gebündelt. Das gebündelte Skript befindet sich im Ordner Tools des Orchestrator-Installationsverzeichnisses, standardmäßig C:\Program Files (x86)\UiPath\Orchestrator\. Das Skript überprüft die Orchestrator-Maschine. Bei einer Installation mit mehreren Knoten reicht es aus, das Tool auf einem Knoten auszuführen.

Das Plattform-Konfigurationstool folgt nicht dem gleichen Versionsschema wie das Installationsprogramm UiPathOrchestrator.msi und kann außerhalb des Produktversionszyklus aktualisiert werden. Wir empfehlen Ihnen, immer die neueste Version des Tools herunterzuladen und zu verwenden, die unten verfügbar ist.

Laden Sie das Tool herunter

Voraussetzungen

Software	Kompatible Version
PowerShell	5.1
WebAdministration-Modul	Keine Angabe

Skript-Cmdlets

Das Skript besteht aus drei Cmdlets, die bestimmte Funktionen ausführen sollen. Ein Befehl zum Aufrufen eines Cmdlets und seine relevanten Parameter können zur sofortigen Ausführung in die Befehlszeile eingegeben werden.

Cmdlet	Beschreibung
Test-PlatformReadiness	Aufruf mit-Readiness Befehl. Überprüft die Integrität und Bereitschaft Ihrer Umgebung vor einem Upgrade und die Zertifikatanforderungen nach der Installation.
Update-UiPathUrl	Aufruf mitUpdateUiPathUrl Befehl. Aktualisiert die öffentliche Adresse von Orchestrator.
Update-UiPathCertificate	Aufruf mitUpdateUiPathCertificate Befehl. Aktualisiert das Orchestrator-SSL-Zertifikat oder das Identity Server-Tokensignaturzertifikat.
AddHostAdmin	Aufruf mitAddHostAdmin Befehl. Fügt dem Hostmandanten einen Systemadministrator hinzu.

Überprüfungen vor der Installation

Asp.Net Core

Überprüft, ob ASP.NET Core IIS-Modul v3.1.x+ installiert und funktionsfähig ist. Wenn dies nicht der Fall ist, werden Sie aufgefordert, das ASP.Net Core Hosting Bundle zu deinstallieren und neu zu installieren.

CyberArk AIM

Überprüft, ob der CyberArk AIM-Agent unter dem Ordner C:\Program Files (x86)\CyberArk installiert ist. Ist dies nicht der Fall, wird der Benutzer aufgefordert, CLIPasswordSdk.exe in der Datei UiPath.Orchestrator.dll.config mit dem Schlüssel Plugins.SecureStores.CyberArk.CLIPasswordSDKExePath nach der Installation hinzuzufügen.

Diese Überprüfung wird nicht durchgeführt, wenn CyberArk nicht in UiPath.Orchestrator.dll.config gefunden wird.

web.config-Verschlüsselung

Überprüft, ob die web.config-Datei entschlüsselt ist. Wenn verschlüsselt, müssen Sie sie vor dem Upgrade manuell entschlüsseln. Nach dem Upgrade werden die meisten Konfigurationseinstellungen von Orchestrator in UiPath.Orchestrator.dll.config verschoben.

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

Gesperrte Abschnitte von web.config

Überprüft, ob das <system.webServer>-Element gesperrte Abschnitte enthält. Wenn solche Abschnitte vorhanden sind, müssen Sie sie manuell in IIS entsperren.

SQL Server Scaleout

Überprüft, ob SQL Server Scaleout verwendet wird. Sie werden darüber informiert, dass während der Installation Redis Scaleout aktiviert ist.

Anmeldeinformationsspeicher-Plugins

Checks that external credential store plugins target a supported framework.

NLog-Plugins

Checks that NLog plugins target a supported framework.

FileSystem-Buckets

Überprüft das Vorhandensein der App-Einstellung Buckets.FileSystem.Allowlist in Orchestrator-Versionen, beginnend bei v2020.4. Dies gilt sowohl für Überprüfungen vor der Installation (Orchestrator v2022.4) als auch für Überprüfungen nach der Installation (Orchestrator v2022.4). Orchestrator-Versionen vor v2020.4 überspringen diese Überprüfung.

• Um die folgenden Überprüfungen durchzuführen, müssen Sie die Konfigurationsabschnitte connectionStrings und appSettings entschlüsseln. Wenn einer dieser Konfigurationsabschnitte verschlüsselt ist, erscheint eine Warnung im Terminal und die restlichen Bucket-Validierungen werden übersprungen.

  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.
  

• Wenn die Buckets aus irgendeinem Grund nicht aus der Datenbank abgerufen werden konnten, erscheint eine Warnung im Terminal und auch die restlichen Validierungen werden übersprungen.

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

• Diese Validierung wird für die abgerufenen Bucket-Stammpfade aus der Tabelle der Orchestrator-Datenbank-Buckets durchgeführt. Falls unqualifizierte Pfade vorhanden sind, erscheint im Terminal eine Warnung. Eine ähnliche Überprüfung der unqualifizierten Pfade wird für die Pfade in der App-Einstellung Buckets.FileSystem.Allowlist in der Konfigurationsdatei durchgeführt.

• Wenn einer der Pfade in den beiden Quellen ungültig oder unqualifiziert ist, wird er für die restlichen der unten beschriebenen Validierungen nicht berücksichtigt.

• Wenn die App-Einstellung Buckets.FileSystem.Allowlist nicht in der Konfigurationsdatei festgelegt ist, erfolgt vom Terminal eine Fehlermeldung mit der Aufforderung, die Zulassungsliste zur Konfigurationsdatei hinzuzufügen. Die vorgeschlagenen Pfade sind der Stammpfad der Buckets, die den Dateisystemanbieter verwenden.

  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\" />
  

• Wenn die App-Einstellung Buckets.FileSystem.Allowlist in der Konfigurationsdatei festgelegt ist, wird eine Validierung für den Bucket-Stammpfad durchgeführt, der den FileSystem-Anbieter verwendet. Falls ein Bucket-Stammpfad kein Unterpfad eines der in der Zulassungsliste definierten Pfade ist, erscheint im Terminal eine Warnung mit der Aufforderung, den Bucket-Stammpfad zu Buckets.FileSystem.Allowlist hinzuzufügen.

  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\
  

• Falls jedoch jeder Bucket-Stammpfad ein Unterpfad eines beliebigen Pfads in der Zulassungsliste ist, erscheint im Terminal eine Erfolgsmeldung.

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

Checks nach der Installation

Zertifikatsanforderungen

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

SSL-Zertifikatsprüfungen

• der hostname der Orchestrator-Site stimmt mit dem Antragsteller oder einem alternativen Antragstellernamen (einschließlich Platzhaltern) auf dem Zertifikat überein,
• hat eine gültige Vertrauenskette und
• ist nicht abgelaufen.

Überprüfungen des Identity Server-Tokensignaturzertifikats

• Das Zertifikat hat die entsprechende Schlüsselgröße (2048 Bit oder größer),
• verfügt über einen privaten Schlüssel, auf den der AppPool-Benutzer zugreifen kann, und
• ist nicht abgelaufen.

Andere Überlegungen

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

Ausführen des Skripts

Befehlsreferenz

Befehl und Parameter	Beschreibung
-Readiness	Überprüft die Integrität und Bereitschaft Ihrer Umgebung vor einem Upgrade und die Zertifikatanforderungen nach der Installation. Parameter: -SiteName -Help -InstallationDirectory
-UpdateUiPathUrl	Aktualisiert die öffentliche Adresse von Orchestrator. Parameter: -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. Verwenden Sie diesen Befehl mit Vorsicht, da er keinen Rollback-Mechanismus hat, wenn ein Schritt während der Ausführung fehlschlägt.
-UpdateUiPathCertificate	Aktualisiert das Orchestrator-SSL-Zertifikat oder das Identity Server-Tokensignaturzertifikat. Verwenden Sie es in Verbindung mit dem Befehl -readiness, um die Gültigkeit der neuen Zertifikate zu überprüfen. Parameter: -SiteName -NewTokenSigningThumbprint -NewSSLThumbprint
-AddHostAdmin	Falls der Zugriff auf die Hostorganisation verloren geht, z. B. wenn das Kennwort für den Systemadministrator verloren geht oder die einzigen Benutzer mit Systemadministratorkonten das Unternehmen verlassen, können Sie diesen Befehl zum Hinzufügen oder Wiederherstellen eines Systemadministrators nutzen. Parameter: -SiteName -HostAdminUsername -HostAdminPassword -HostAdminEmail

Skriptparameter

Parameter	Beschreibung
-SiteName	Optional. Der Name der Orchestrator Website auf der Zielmaschine. Die Standardeinstellung ist "UiPath Orchestrator". -InstallationDirectory und SiteName schließen sich gegenseitig aus.
-Help	Optional. Zeigt Informationen zu den Tooloptionen oder verfügbaren Befehlen an, z. B. die Syntax der Befehle oder die von ihm ausgeführten Prüfungen.
-InstallationDirectory	Optional. Der Pfad des Installationsverzeichnisses von Orchestrator. In der Regel C:\Program Files (x86)\UiPath\Orchestrator\. -InstallationDirectory und SiteName schließen sich gegenseitig aus. Make sure the installation directory path ends with a trailing backslash (\).
-OrchestratorUrl	Obligatorisch.. Die neue öffentliche Adresse von Orchestrator.
-SqlConnectionString	Optional. UiPath-Datenbankverbindungszeichenfolge. Wenn der Wert leer bleibt, wird er aus der Datei appsettings.Production.json gelesen.
-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	Nur obligatorisch, wenn der Befehl -AddHostAdmin verwendet wird. Benutzername des Hostadministratorbenutzers, der erstellt oder wiederhergestellt werden soll.
-HostAdminPassword	E-Mail des Hostadministratorbenutzers, der bei der Verwendung des Befehls -AddHostAdmin erstellt oder wiederhergestellt werden soll. Nur obligatorisch, wenn diese externen Identitätsanbieter verwendet werden: Google Azure Active Directory SAML mit E-Mail-Benutzerzuordnungsstrategie
-HostAdminEmail	Kennwort des Hostadministratorbenutzers, das erstellt werden soll, wenn der Befehl -AddHostAdmin verwendet wird. Das Kennwort ist nur obligatorisch, wenn der Benutzer ein einfacher Authentifizierungsbenutzer ist. Das Kennwort muss bei der ersten Anmeldung geändert werden.

Beispiele

Um mit dem Skript des Plattformkonfigurationstools zu arbeiten, öffnen Sie ein PowerShell-Administratorskript.

Suchen Sie das Verzeichnis, in dem Sie das Archiv des Plattformkonfigurationstools entpackt haben, und ändern Sie das Verzeichnis in diesen Speicherort:

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

Durchführen einer Bereitschaftsprüfung

Im folgenden Beispiel können Sie eine Überprüfung der Installationsvoraussetzungen von Orchestrator durchführen. Der Vorgang protokolliert die Schritte und das Ergebnis mit zusätzlichen Informationen auf der Ebene -verbose.

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

Die Vorinstallation überprüft eine erfolgreiche Ausgabe.

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

Ändern von Zertifikaten nach der Installation

Im folgenden Beispiel können Sie die Orchestrator-SSL und die Identity Server-Tokensignaturzertifikate aktualisieren.

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

Hinweis:

• Alle appsettings-Dateien müssen vor der Verwendung des Skripts entschlüsselt werden.
• Wenn Sie mehrere Orchestrator-Knoten haben, stellen Sie bitte sicher, dass Sie das Zertifikat auf allen Server-Knoten aktualisieren.
• Make sure the certificates have the appropriate permissions set to prevent an internal server error. Refer to Troubleshooting Certificates for more details.

Ändern der Orchestrator-URL

Im folgenden Beispiel können Sie die Orchestrator-URL aktualisieren.

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

Erstellen eines neuen Systemadministrators

Im folgenden Beispiel wird ein neuer Systemadministrator auf dem Hostmandanten mithilfe der Standardauthentifizierung erstellt. Beachten Sie, dass die Standardauthentifizierung nur über die hostlogin -URL zugänglich ist, wenn ein externer Identitätsanbieter als exklusiv festgelegt ist.

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

Ausgabe

Die Ausgabe ist farbcodiert.

Farbe	Beschreibung
Rot	Blocker Elemente fehlen oder sind nicht konfiguriert und verhindern die Installation.
Gelb	Warnungen Sie können Orchestrator installieren, aber zusätzliche Vorteile fehlen.
Grün	Messages Die Umgebung ist für die Installation bereit.