Bereitstellen des Relay-Clients

Relay-Client-Voraussetzungen, Mindestanforderungen und plattformübergreifende Einrichtungsschritte für die Verbindung Ihres lokalen Netzwerks mit Test Cloud.

Installieren und starten Sie den Relay-Client auf einem Gerät in Ihrem Netzwerk, um den ausgehenden Tunnel zur Test Cloud zu erstellen. Bevor Sie beginnen, konfigurieren Sie eine Relay-Gruppe und halten Sie den Client-Konfigurationsstring bereit.

Voraussetzungen

Hardwareanforderungen

Profil	vCPU	RAM	Relay-Gruppen	Endpunkte pro Gruppe	Use case
Standard	1	2 GiB	Bis zu 10	Bis zu 50	Die meisten Bereitstellungen
Groß	2	4 GiB	10+	Bis zu 50	Umgebungen mit hohem Durchsatz oder großen Umgebungen

Dies sind die Mindestanforderungen für den Relay-Client, wenn der lokale Executor nicht aktiviert ist. Wenn der Host auch andere Workloads ausführt, fügen Sie zusätzlich zu diesen Zahlen Kapazitäten für diese hinzu. Verwenden Sie für Bereitstellungen, die den Executor aktivieren, stattdessen die Zahlen in der Ressourcenplanung für unterstützte TCP-basierte Verbindungen .

Ressourcenplanung für unterstützte TCP-basierte Verbindungen

Jede Relay-Gruppe, die Sie installieren, wird als eigener Relay-Client-Dienst ausgeführt. Wenn der lokale Executor aktiviert ist, startet und überwacht dieser Dienst einen Java-Prozess. Die folgenden Zahlen beziehen sich auf eine einzelne Relay-Gruppe mit aktiviertem Executor.

Profil	vCPU	RAM	Für den Executor reservierter RAM
Standard (mit Executor)	2	4 GiB	1 GiB
Groß (mit Executor)	4 oder mehr	4 GiB oder mehr	1 GiB oder mehr

RAM umfasst die Executor-Reservierung, das Betriebssystem und die Java-Laufzeit. Fügen Sie Kapazitäten für die Überwachung und andere Workloads auf dem Host hinzu. Wenn sich die Speichernutzung des Executors nach dem Go-Live-Start der Reservierung nähert, erhöhen Sie gemeinsam die Reservierung und den RAM.

Tipp:

Um die Ressourcennutzung zu minimieren, registrieren Sie alle Ihre TCP-basierten Endpunkte unter einer einzigen Relay-Gruppe. Sein Relay-Client führt dann einen lokalen Executor für jeden TCP-basierten Endpunkt aus, sodass Sie Speicher reservieren, den Host dimensionieren und die Executor-Protokolle für einen einzelnen Prozess überwachen.

Wenn Ihre Netzwerksegmentierungs- oder Verfügbarkeitsanforderungen mehr als eine Relay-Gruppe mit dem Executor auf demselben Host erfordern:

• Weisen Sie dem Executor jeder Gruppe einen eindeutigen --onprem-executor-listen-port -Wert zu.
• Reservieren Sie weitere 1 GiB für jeden zusätzlichen Executor-Prozess.
• CPU-Größe für den gesamten Datenverkehr über alle Gruppen hinweg, anstatt die CPU-Zahl pro Gruppe mit der Anzahl der Gruppen zu multiplizieren.
• Lassen Sie den Datenträger für ein separates Executor-JAR und eine Protokolldatei pro Gruppe zu.

Datenträger-Voraussetzungen

Profil	Minimaler freier Datenträger
Standard (1–10 Gruppen)	200 MB
Groß (10 + Gruppen)	1 GB

Die oben genannten Mindestanforderungen gelten nur für den Relay-Client. Wenn Sie den lokalen Executor aktivieren, lassen Sie zusätzlichen Speicherplatz für die Java-Laufzeit, onprem-executor.jar, die von Ihnen bereitgestellten Connector-Bibliotheken und beibehaltene Executor-Protokolle zu. Das Protokollvolumen hängt von Ihrem Datenverkehrsvolumen, der Protokollebene und dem konfigurierten Aufbewahrungszeitraum ab.

Unterstützte Betriebssysteme

Architektur	Linux	Windows
x86_64 (AMD64)	Wird unterstützt	Wird unterstützt
ARM64 (aarch64)	Wird unterstützt	Wird unterstützt

Netzwerkanforderungen

Der Relay-Client benötigt nur ausgehende Verbindungen. Es sind keine eingehenden Firewallregeln erforderlich.

Jede Relay-Clientversion erreicht cloud.uipath.com, um sich zu authentifizieren und zu registrieren. Ab Relay-Client 26.4.2 übertragen neue Konfigurationen auch den persistenten Tunnel über dieselbe URL, sodass für sie kein regionsspezifischer Relay-Hostname auf die Zulassungsliste gesetzt werden muss.

Relay-Client-Konfiguration	Protokoll	Port	Ziel (Destination)	TLS-Password erforderlich	Zweck
Alle Relay-Clientversionen	https	443	cloud.uipath.com	Nicht erforderlich	Authentifizierung und Relay-Registrierung
Relay-Client 26.4.2 oder höher	HTTPS/WSS	443	cloud.uipath.com	Nicht erforderlich	Persistenter Tunnel
Relay-Client-Versionen vor 26.4.2	TLS	443	<region>-relay.uipath.com	Erforderlich	Persistenter Tunnel

Relay-Client-Versionen vor 26.4.2 funktionieren weiterhin mit regionalen Relay-Hostnamen. Lassen Sie diese Hostnamen auf der Zulassungsliste, bis Sie zum Relay-Client 26.4.2 oder später wechseln und eine Verbindung über cloud.uipath.com herstellen.

Ersetzen Sie bei Relay-Client-Versionen vor 26.4.2 <region> durch die Region Ihres Test Cloud-Mandanten. Die vollständige Liste der Regionen finden Sie unter Globale Cloud-Regionen.

Region	Relay-Server-Hostname
uns	us-relay.uipath.com
EU	eu-relay.uipath.com
Kanada	ca-relay.uipath.com
Schweiz	ch-relay.uipath.com
Australien	au-relay.uipath.com
Singapur	sg-relay.uipath.com
Japan	jp-relay.uipath.com
Südkorea	kr-relay.uipath.com
VAE	ae-relay.uipath.com
Vereinigtes Königreich	uk-relay.uipath.com
Europäische Union (verzögerte Region)	gxp-eu-relay.uipath.com
United States (verzögerte Region)	gxp-us-relay.uipath.com

Hinweis:

Wenden Sie sich an den UiPath-Support, um den Hostnamen des Relay-Servers zu bestätigen, wenn Ihre Mandantenregion nicht oben aufgeführt ist.

Wählen Sie die Region aus, die der Region Ihres UiPath Cloud- Mandanten entspricht, nicht den physischen Standort des Relay-Knotens. Wenn Ihr Mandant beispielsweise in der Region der USA bereitgestellt wird, verwenden Sie us-relay.uipath.com auch wenn das Relay selbst in einer anderen Region ausgeführt wird. Relay-Client 26.4.2 -Konfigurationen, die eine Verbindung über cloud.uipath.com herstellen, verwenden diesen regionalen Hostnamen nicht.

Überlegungen zur Latenz: Da der Datenverkehr von der UiPath Cloud über den Relay-Server und den Relay-Knoten zum lokalen Dienst läuft, wird durch die Installation des Relay-Knotens in der Nähe der Region Ihres Mandanten die Round Trip Time minimiert und der Gesamtdurchsatz verbessert.

Konfigurieren Sie bei Relay-Client-Konfigurationen 26.4.2, die eine Verbindung über cloud.uipath.com herstellen, Firewalls und Proxys, um HTTPS-Datenverkehr und WebSocket-Upgrades auf cloud.uipath.com:443 zuzulassen. Wenn ein Proxy TLS für cloud.uipath.com überprüft, installieren Sie die Signaturzertifizierungsstelle des Proxys im OS-Vertrauensspeicher, der vom Relay-Client verwendet wird, und stellen Sie sicher, dass der Proxy WebSocket-Upgrades zulässt.

Konfigurieren Sie für Relay-Clientversionen vor 26.4.2 Ihre Firewall und jeden TLS-Inspektions-Proxy oder jede DLP-Appliance, um TLS-Passthrough für <region>-relay.uipath.com:443 zu ermöglichen; die TLS-Inspektion auf dem regionalen Relay-Hostnamen unterbricht den Relay-Tunnel.

Der Relay-Host muss jeden registrierten HTTP- oder HTTPS-Endpunkt sowie den Host und Port jedes unterstützten TCP-basierten Endpunkts auflösen und eine Verbindung herstellen.

Der Routingpfad ist flexibel. Eine direkte Netzwerkroute, ein ausgehender Unternehmensproxy oder ein Jump Host sind alle akzeptabel, solange die Verbindung über den Relay-Host erfolgreich ist. Planen Sie die Platzierung so, dass jedes Ziel in der Gruppe erreichbar bleibt.

Bandbreite

Der Steuerelementkanal (Heartbeats und Authentifizierung) verbraucht im Leerlauf ca. 1–2 KB/Minute . Der Datenverkehr skaliert mit dem Volumen der Anforderungen, die Ihre Cloud-Dienste an lokale Endpunkte senden. Für HTTP- und HTTPS-Endpunkte fungiert das Relay als transparenter Tunnel ohne zusätzlichen Overhead, der über TLS und das einfache WebSocket-Framework hinausgeht, das für cloud.uipath.com -Verbindungen verwendet wird.

Für unterstützte TCP-basierte Verbindungen übersetzt der lokale Executor jede Anforderung in das Protokoll des Connectors. Der Datenverkehr zwischen dem Executor und dem Zielsystem spiegelt daher dieses Protokoll und nicht die Größe der ursprünglichen Anforderung wider. Der Datenverkehr zwischen dem Relay-Client und dem Executor bleibt auf der Loopback-Schnittstelle und verlässt den Host nicht.

Überprüfen Sie die Verbindung

Bevor Sie den Relay-Client installieren, bestätigen Sie, dass der ausgehende Datenverkehr auf Port 443 zu den erforderlichen Zielen für Ihre Konfiguration zugelassen ist.

Linux

nc -zv cloud.uipath.com 443

# Required only for Relay client versions earlier than 26.4.2
nc -zv <region>-relay.uipath.com 443

Windows (PowerShell)

Test-NetConnection -ComputerName cloud.uipath.com -Port 443

# Required only for Relay client versions earlier than 26.4.2
Test-NetConnection -ComputerName <region>-relay.uipath.com -Port 443

Ein erfolgreiches Ergebnis zeigt TcpTestSucceeded : True unter Windows und succeeded unter Linux. Wenn eine erforderliche Prüfung fehlschlägt, überprüfen Sie Ihre Firewallregeln. Bestätigen Sie bei Relay-Client- 26.4.2 -Konfigurationen, die eine Verbindung über cloud.uipath.com herstellen, dass WebSocket-Upgrades zulässig sind; Bestätigen Sie bei Relay-Client-Versionen vor 26.4.2, dass der TLS-Passwort für den Relay-Server-Hostnamen konfiguriert ist.

Lokaler Executor für unterstützte TCP-basierte Verbindungen

Für unterstützte TCP-basierte Verbindungen wie SAP BAPI werden Anforderungen vom lokalen Executor verarbeitet, einem Java-Prozess, der das Protokoll des Connectors spricht und den Aufruf an das Zielsystem weiterleitet. Bei Linux- und Windows-Dienstbereitstellungen, die unten beschrieben sind, wird der Relay-Client gestartet und überwacht. In Containerbereitstellungen wird sie als separater Container ausgeführt: siehe SAP BAPI und andere TCP-basierte Verbindungen.

Wichtig:

Die Unterstützung des lokalen Executors erfordert den Relay-Client 26.4.3 oder höher.

Der Relay-Client startet einen Executor-Prozess für jeden Relay-Client-Dienst in Linux- und Windows-Dienstbereitstellungen. Der Executor überwacht nur localhost, standardmäßig auf Port 18080 und ist von außerhalb des Hosts nicht erreichbar. Wie jeder Loopback-Dienst ist er von anderen Prozessen auf demselben Host erreichbar, daher behandeln Sie den lokalen Zugriff auf den Relay-Host als vertraulich.

Bevor Sie ihn aktivieren:

• Eine Runtime für Java 21 oder höher verfügbar sein. Eine JRE oder ein JDK ist ausreichend und eine vorhandene Installation funktioniert. Setzen Sie entweder java auf PATH des Kontos, das relay start ausführt, oder übergeben Sie den Speicherort der Runtime mit --onprem-executor-java-home.
• Extrahieren Sie die Relay-Binärdatei relay unter Linux oder relay.exe unter Windows und das gebündelte onprem-executor.jar aus demselben Archiv. Lassen Sie die beiden Dateien zusammen im extrahierten Verzeichnis und führen Sie Installations- oder Upgrade-Befehle von diesem Verzeichnis aus.
• Stellen Sie sicher, dass der Relay-Host den Hostnamen und Port des Zielsystems erreichen kann.
• Wenn ein Connector Bibliotheken erfordert, die UiPath nicht bereitstellt, legen Sie sie alle in einem dauerhaften Verzeichnis ab, das das Relay-Dienstkonto lesen kann, und zeigen Sie dann mit --onprem-executor-dep-dir darauf. Der Relay-Client speichert den Pfad, kopiert die Dateien jedoch nicht.
• Für SAP BAPI enthält dieses Verzeichnis die SAP JCo3-Dateien sapjco3.jar und sapidoc3.jar sowie die native Bibliothek, die dem Hostbetriebssystem und der Java-Laufzeitarchitektur entspricht. Verwenden Sie das SAP JCo-Release, das SAP für Ihr SAP-System und Ihre Java-Runtime unterstützt.
• Das Abhängigkeitsverzeichnis ist ein Code-Ladepfad für den Executor, der mit den Berechtigungen des Relay-Dienstkontos ausgeführt wird. Er muss sich im Besitz des Administrators befinden und darf nicht von Benutzern ohne Berechtigungen geschrieben werden können.
• Verwenden Sie unter Linux 0755 für das Verzeichnis und 0644 für die Dateien. Platzieren Sie es unter Windows unter C:\Program Files, wodurch Administratoren Schreibzugriff und anderen Konten standardmäßig Lese- und Ausführungszugriff erhalten.

Kopierbare Installations- und Verifizierungsbefehle finden Sie unter Linux oder Windows. Nach der Installation meldet relay describe <id>, ob der Executor aktiviert ist und welches Java-Start- und Abhängigkeitsverzeichnis er verwendet.

Wichtig:

Bei einer Containerbereitstellung startet der Relay-Client den Executor nicht, sodass die Java-Laufzeit- und Abhängigkeitsverzeichnisanforderungen für Dienstbereitstellungen nicht gelten und --onprem-executor-java-home und --onprem-executor-dep-dir keine Auswirkungen haben. Führen Sie den Executor stattdessen als separater Container aus, wie unter SAP BAPI und andere TCP-basierte Verbindungen beschrieben.

Konfigurieren eines Proxys (falls zutreffend)

Wenn Ihr Netzwerk ausgehenden Datenverkehr über einen Proxy weiterleitet, legen Sie die folgenden Umgebungsvariablen fest, bevor Sie relay start ausführen. Der Relay-Client verwendet diese Einstellungen für proxy-fähigen ausgehenden Datenverkehr.

Variable	Zweck
HTTPS_PROXY / https_proxy	Proxy-URL (zuerst aktiviert)
HTTP_PROXY / http_proxy	Proxy-URL (Fallback)
NO_PROXY / no_proxy	Durch Kommas getrennte Hosts oder Domänen, die den Proxy umgehen

Die Proxy-URL muss eines dieser Schemas verwenden: http://, https://, socks5:// oder ntlm://. Format: scheme://[user:password@]host:port.

Für https:// -Proxys: Der Relay-Client überprüft das TLS-Zertifikat des Proxys anhand des Vertrauensspeichers des Betriebssystems. Wenn Ihr Proxy eine Unternehmens- oder selbstsignierte Zertifizierungsstelle verwendet, fügen Sie diese Zertifizierungsstelle zum Vertrauensspeicher der Relay-Clientmaschine hinzu, bevor Sie den Relay-Dienst starten; Andernfalls schlägt der TLS-Handshake mit einem Zertifikatüberprüfungsfehler fehl.

Konfigurieren Sie für Konfigurationen der Relay-Clients 26.4.2, die eine Verbindung über cloud.uipath.com herstellen, Ihren Proxy so, dass langlebige HTTPS-Verbindungen und WebSocket-Upgrades auf cloud.uipath.com:443 zulässig sind.Wenn der Proxy TLS für cloud.uipath.com überprüft, installieren Sie die signierende Zertifizierungsstelle des Proxys im Vertrauensspeicher des Betriebssystems, der vom Relay-Client verwendet wird.

Konfigurieren Sie für Relay-Client-Versionen vor 26.4.2 Ihren Proxy so, dass er die TLS-Prüfung für <region>-relay.uipath.com:443 umgibt. PAC-Dateien, die automatische WPAD-Erkennung und die Proxyverkettung werden nicht unterstützt. Legen Sie die Proxy-URL explizit fest. Wenn ein Proxy erkannt wird, zeigen die Voraussetzungsprüfungen via proxy in der Ausgabe an.

Wichtig:

Der Relay-Client zensiert Proxy-Kennwörter in Protokollen. In Umgebungsvariablen festgelegte Anmeldeinformationen können jedoch in Prozessauflistungen und Dateien von Systemeinheiten sichtbar sein. Verwenden Sie dedizierte Dienstanmeldeinformationen und beschränken Sie den Zugriff auf den Relay-Knoten entsprechend.

Vertrauenswürdige IPs konfigurieren (falls zutreffend)

Wenn Ihre Organisation den Zugriff nach IP-Adresse einschränkt, fügen Sie die NAT-IP des Geräts, auf dem der Relay-Client ausgeführt wird, zur Liste der vertrauenswürdigen IPs in der UiPath-Verwaltung hinzu. Der ausgehende Datenverkehr des Relay-Clients erreicht die Test Cloud von dieser IP-Adresse, sodass er ausdrücklich zugelassen werden muss.

Anweisungen finden Sie unter Hinzufügen vertrauenswürdiger IP-Bereiche.

Akzeptieren Sie die Lizenzvereinbarung

Bevor Sie den Relay-Client starten, müssen Sie die Lizenzvereinbarung akzeptieren. Wählen Sie eine der folgenden Methoden aus:

Option 1 (Umgebungsvariable). Legen Sie die Umgebungsvariable LICENSE_AGREEMENT auf accept fest:

Linux

export LICENSE_AGREEMENT=accept

Windows

$env:LICENSE_AGREEMENT=accept

Option 2 (Inline-Parameter). Hängen Sie --accept-license-agreement an den Befehl relay start an:

./relay start --config "<your-config>" --accept-license-agreement

Einrichtungshandbücher

Produktionsbereitstellungen finden Sie im Plattformhandbuch für Ihr Betriebssystem. Es deckt Schnellstartbefehle, Verzeichnisstruktur, Dienstverwaltung, Konfiguration des Sicherheitsframeworks und Deinstallationsverfahren ab:

Plattform	Anleitung (Guide)
Linux	Bereitstellen des Relay-Clients unter Linux
Windows	Bereitstellen des Relay-Clients unter Windows
Container	Bereitstellen des Relay-Clients als Container

Betrieb

Widerstandsfähigkeit der Verbindung

Der Relay-Client verwaltet den Tunnel automatisch:

• Heartbeats Standardmäßig alle 30 Sekunden (konfigurierbar über --heartbeat-interval, mindestens 10 Sekunden). Das Tunnel-Timeout ist das 3-fache des Heartbeat-Intervalls. Verringern Sie das Intervall, wenn Ihre Firewall, Ihr Proxy oder NAT inaktive TCP-Verbindungen vor 30 Sekunden verwirft:

  relay start --config "<config>" --heartbeat-interval 10 --accept-license-agreement
  relay restart <id> --heartbeat-interval 10
  

• Automatisches Wiederherstellen der Verbindung beim Trennen mithilfe einer exponentiellen Backoff-Skalierung auf 20-Sekunden-Intervalle.
• Automatischer Neustart des Dienstes , wenn der Prozess abstürzt, verwaltet von systemd unter Linux und Windows Service Control Manager unter Windows.
• Autostart des Dienstes beim Systemneustart.

Proaktive Verbindung erneut herstellen

Netzwerke hinter einem Unternehmensproxy, einem Lastausgleich oder einer Firewall mit einem Timeout bei Inaktivität der Verbindung können langlebige TLS-Verbindungen im Hintergrund beenden. Proaktive erneute Verbindung stellt die Steuerelementverbindung nach einem festen Zeitplan wieder her, um dies zu verhindern.

Aktivieren Sie es mit dem Flag --reconnect-interval :

relay start --config "<config>" --reconnect-interval 1800 --accept-license-agreement

Das effektive Minimum beträgt 1800 Sekunden (30 Minuten). Legen Sie das Intervall auf etwa die Hälfte des Inaktivitäts-Timeouts Ihres Netzwerkgeräts fest, z. B. 1800 Sekunden für ein 60-minütiges Firewall-Timeout. Lassen Sie in stabilen Netzwerken ohne Zeitüberschreitung bei Inaktivität die Verbindung deaktiviert.

• Gleitende Entleerung. Wenn das Intervall verstreicht, akzeptiert der Relay-Client keine neue Arbeit mehr und wartet bis zu einem Drain-Timeout von 300 Sekunden auf den Abschluss von In-Flight-Verbindungen, bevor die alte Verbindung geschlossen und eine neue geöffnet wird. Anforderungen, die sich bei Erreichen des Timeouts für die Entleerung noch in Bearbeitung befinden, werden beendet.

• Hohe Verfügbarkeit (High Availability). Wenn mehrere Relay-Clients in derselben Gruppe bereitgestellt werden, koordinieren sie sich, sodass jeweils nur ein Client per Drain ausgeführt wird. Die Gruppe stellt weiterhin den Datenverkehr während jedes Wiederverbindungszyklus bereit.

• Zeichen dafür, dass eine proaktive erneute Verbindung erforderlich ist: Protokolle zeigen regelmäßige unexpected EOF -Fehler oder stille Trennungen trotz eines stabilen zugrunde liegenden Netzwerks, die normalerweise durch eine 30-60-minütige Leerlaufzeitüberschreitung auf einer Firewall, einem Proxy oder einem Lastausgleich verursacht werden.

Die Konfiguration neu laden

relay reload <id>

Ruft die Proxykonfiguration erneut aus Test Cloud ab und wendet sie ohne Neustart an. Cloud-seitige Änderungen, wie z. B. neue Endpunkte oder aktualisierte Zustandsprüfungspfade, werden automatisch an einen laufenden Relay-Client gepusht und erfordern normalerweise kein Neuladen. Verwenden Sie diesen Befehl nur dann als Fallback, wenn ein neu hinzugefügter Endpunkt 404 zurückgibt.

Protokollierung

Einstellung	Wert
Standardebene	info
Rotation	Daily
Aufbewahrung	7 Tage
Protokolldatei	relay.log (aktuell), relay.YYYYMMDD-HHMMSS.log (gerotiert)

Überschreiben Sie die Standardprotokollebene mit --log-level trace/debug/info/warn/error. Überschreiben Sie im Relay-Client 26.4.2 oder höher die rotierte Protokollaufbewahrung mit --log-retention-days <days> auf relay start oder relay restart; die Mindestaufbewahrung beträgt 7 Tage.

Befehlsreferenz

Relay-Start

Stellen Sie einen neuen Relay-Client bereit und starten Sie ihn als Hintergrunddienst.

Lizenzvereinbarung (eine erforderlich)

• --accept-license-agreement: Akzeptieren Sie die Endbenutzer-Lizenzvereinbarung inline.
• LICENSE_AGREEMENT=accept: Umgebungsvariable, die dem Flag entspricht. relay start gibt den Endbenutzer-Lizenzvertrag aus und wird beendet, wenn keiner festgelegt ist.

Konfiguration (eine erforderlich)

• -c, --config <string>: Inline-Base64-codierte Konfigurationszeichenfolge.
• --config-file <path>: Pfad zu einer Datei, die die Konfigurationszeichenfolge enthält. Empfohlen: Es hält das Geheimnis aus dem Shell-Verlauf heraus.

Abstimmung (optional)

• --heartbeat-interval <sec>: Tunnel-Heartbeat-Intervall. Der Standardwert ist 30. Mindestens 10. Die Tunnel-Timeout ist 3-mal diesen Wert. Niedriger, wenn Ihre Firewall, NAT oder Proxy TCP im Leerlauf vor 30 Sekunden auslöst.
• --reconnect-interval <sec>: Proaktives Wiederverbindungsintervall. Standard: 0 (deaktiviert); effektives Minimum 1800 (30 Minuten), wenn festgelegt.
• --log-level <level>: trace, debug, info, warn oder error. Standardmäßig: info.
• --log-retention-days <days>: Anzahl der Tage, für die rotierte Protokolldateien aufbewahrt werden sollen. Der Standardwert ist 7. Mindestens 7. Erfordert den Relay-Client 26.4.2 oder höher.
• -d, --detach=false: Wird im Vordergrund statt als Hintergrunddienst ausgeführt. Nützlich für das Debuggen von Startproblemen.

Lokaler Executor (optional)

• --enable-onprem-executor: Aktivieren Sie den lokalen Executor. Bei Linux- und Windows-Dienstbereitstellungen startet der Relay-Client den gebündelten Executor-Prozess. In einer Containerbereitstellung wird eine Verbindung mit dem Executor-Container auf dem Standardport 18080 hergestellt.
• --onprem-executor-listen-port <port>: Port, den der lokale Executor überwacht. Der Standardwert ist 18080. Verwenden Sie in einer Containerbereitstellung den SERVER_PORT -Wert des Executor-Containers. Allein dieses Flag aktiviert auch den Executor.
• --onprem-executor-java-home <path>: JAVA_HOME wird zum Ausführen des lokalen Executors verwendet. Wenn er nicht angegeben wird, wird java von PATH aufgelöst. Keine Auswirkungen in einer Containerbereitstellung.
• --onprem-executor-dep-dir <path>: Einzelnes Verzeichnis, das jede Connector-Abhängigkeit enthält, sowohl die JARs als auch die passenden nativen Betriebssystembibliotheken. Für SAP BAPI sind das sapjco3.jar, sapidoc3.jar und die native SAP JCo-Bibliothek für den Host. Keine Auswirkungen in einer Containerbereitstellung, bei der das Executor-Image diesen Pfad besitzt.

Die Executor-Adresse wird auf localhost festgelegt. Die Einstellungen für die Relay-Protokollebene und die Aufbewahrung gelten auch für onprem-executor.log.

Nicht standardmäßige Installationspfade (optional)

• --data-dir <path>: Konfigurationsverzeichnis.
• --logs-dir <path>: Verzeichnis der Protokolldatei.
• --bin-dir <path>: Binäres Installationsverzeichnis.

Nur Linux

• --user-mode: Als systemd-Benutzerdienst installieren (kein sudo erforderlich, verwendet XDG-Pfade).

Nur Windows

• --service-account <DOMAIN\user>: Führen Sie den Windows-Dienst unter einem bestimmten Konto aus. Die Standardeinstellung ist LocalSystem.
• --service-account-password <password>: Kennwort für --service-account.

Relay-Neustart

Stoppen Sie den Relay-Clientdienst und starten Sie ihn neu. Erkennt aktualisierte Binärdateien und wendet Änderungen an der Servicedefinition an. Die folgenden Flags können beim Neustart überschrieben werden (standardmäßig sind alle unverändert, sofern nicht anders angegeben):

• --config / --config-file: Ersetzen Sie die Clientkonfiguration.
• --accept-license-agreement: Akzeptieren Sie die Lizenzvereinbarung während des Neustarts, was nützlich ist, wenn Sie einen älteren installierten Dienst aktualisieren, der die Lizenzannahme nicht beibehalten hat.
• --log-level: Ändern Sie die Protokollebene.
• --logs-dir <path>: Verschieben Sie das Protokollverzeichnis des installierten Dienstes. Erfordert den Relay-Client 26.4.2 oder höher.
• --log-retention-days <days>: Ändern Sie die rotierte Protokollaufbewahrung. Mindestens 7; Übergeben Sie -1, um unverändert zu lassen. Erfordert den Relay-Client 26.4.2 oder höher.
• --heartbeat-interval: Ändern Sie das Heartbeat-Intervall. Mindestens 10; Übergeben Sie 0, um unverändert zu lassen.
• --reconnect-interval: Ändern Sie das Intervall für die proaktive Wiederverbindung. Mindestens 1800 (30 Minuten), wenn festgelegt. Übergeben Sie 0, um sie zu deaktivieren, oder -1, um unverändert zu bleiben.
• --enable-onprem-executor: Aktivieren oder Aktualisieren der lokalen Executor-Einstellungen für einen installierten Dienst.
• --disable-onprem-executor: Entfernen Sie die beibehaltenen lokalen Executor-Einstellungen und starten Sie ohne den Executor-Prozess neu.
• --onprem-executor-listen-port, --onprem-executor-java-home, --onprem-executor-dep-dir: Aktualisieren Sie bestimmte lokale Executor-Einstellungen. Das Übergeben eines dieser Flags impliziert eine Ausführung des Executor-Updates.

Wenn für den installierten Dienst der lokale Executor bereits aktiviert ist, behält relay restart <id> seine Einstellungen bei. Um Relay und den Executor gemeinsam zu aktualisieren, extrahieren Sie beide Dateien aus dem neuen Archiv und führen Sie relay restart <id> mit der neuen Relay-Binärdatei aus. Java- und Executor-Prüfungen werden ausgeführt, bevor der Dienst angehalten wird.

Relay-Protokolle

Protokollausgabe für einen Relay-Client anzeigen.

• -f, --follow: Streamen Sie kontinuierlich neue Protokollzeilen.
• -n, --lines <N>: Anzahl der Zeilen ab dem Ende. Standardmäßig: 50.

Relay-Liste

Alle Relay-Clients auf dieser Maschine mit Status, Version, Erstellungs- und Aktualisierungszeitstempeln sowie Gruppenname anzeigen, sofern verfügbar. Lange Gruppennamen werden in der Tabellenausgabe abgeschnitten.

• --json: Ausgabe einer JSON-Ausgabe für Automatisierung und Skripterstellung, einschließlich vollständiger Gruppennamen.

Relay-Beschreibung (Relay-Client 26.4.2 oder höher)

Zeigen Sie detaillierte Informationen für einen Relay-Client an, einschließlich Gruppen-ID und -name, geheime ID, Status, Version, Dienstmodus und ausführbarer Pfad, konfigurierte Heartbeat- und erneute Verbindungsintervalle, Protokollebene, lokale Pfade und Zeitstempel.

Ein Abschnitt „Lokaler Executor“ meldet, ob der Executor aktiviert ist, und wenn dies der Fall ist, der Listen-Port, die Runtime-Version, der Runtime-Pfad, das Java-Home und das Abhängigkeitsverzeichnis.

• --json: Ausgabe einer JSON-Ausgabe für Automatisierung und Skripterstellung.

Relay-Neuladen

Rufen Sie die Proxykonfiguration erneut aus der Test Cloud ab und wenden Sie sie ohne Neustart an. Verwenden Sie sie als Ausweichlösung, wenn ein neu hinzugefügter Endpunkt 404 zurückgibt.

Relay anhalten

Beenden Sie den Relay-Clientdienst. Konfiguration und Anmeldeinformationen werden beibehalten. Der Relay-Client kann später neu gestartet werden.

Relay löschen

Halten Sie den Dienst an, melden Sie sich bei der Test Cloud ab und entfernen Sie die gesamte lokale Konfiguration und Anmeldeinformationen.

• -f, --force: Lokal entfernen ohne Cloud-Deregistrierung. Zu verwenden, wenn Anmeldeinformationen nicht lesbar sind oder cloudseitige Ressourcen bereits gelöscht wurden.

Relay-Supportpaket [ID]

Sammeln Sie ein zensiertes Archiv mit Konfigurationen, Protokollen und Systemmetadaten für ein UiPath-Supportticket. Lassen Sie [id] weg, um alle Relay-Clients auf der Maschine zu bündeln. Anmeldeinformationen und Verschlüsselungsschlüssel sind nie enthalten. Ausführliche Informationen finden Sie unter Sammeln eines Supportpakets .

Relay-Version

Geben Sie die Relay-Clientversion, das Builddatum und den Git Commit-Hash aus.

Virenschutz und Endpunktsicherheit

Wenn Ihre Organisation Endpunktschutzsoftware ausführt, fügen Sie Ausfälle für die Relay-Binärdatei und deren Datenverzeichnis hinzu, um zu verhindern, dass der Relay-Client blockiert oder unter Quarantäne gestellt wird. Lassen Sie für Relay-Client 26.4.2 -Konfigurationen, die eine Verbindung über cloud.uipath.com herstellen, cloud.uipath.com:443 zu. Konfigurieren Sie für Relay-Client-Versionen vor 26.4.2 TLS-Inspektionsproxys, DLP-Geräte und IDS/IPS-Systeme, um die Überprüfung für <region>-relay.uipath.com:443 zu umgehen.

Wenn Sie den lokalen Executor aktivieren, erweitern Sie diese Ausdrücke auf die ausführbare Java-Datei, das Abhängigkeitsverzeichnis und onprem-executor.log. Der Relay-Dienst startet einen untergeordneten Java-Prozess, der Connector-Bibliotheken von Drittanbietern lädt, die einige Endpunktschutzprodukte standardmäßig blockieren. Scope die Ausnahmen auf diese Pfade und nicht auf die gesamte Verzeichnisstruktur.

Ziel (Destination)	Port	Protokoll	Aktion
cloud.uipath.com	443	https	Zulassen
<region>-relay.uipath.com	443	TLS	Erlauben und umgehen Sie die TLS-Prüfung für Relay-Client-Versionen vor 26.4.2