Déploiement du client de relais sous Windows

Déploiement du client Relay en tant que service Windows pour établir un tunnel sortant entre votre réseau et Test Cloud.

Cette page couvre les détails de la configuration de production spécifiques à Windows. Pour les prérequis multiplate-formes et les exigences réseau, consultez Déploiement du client de relais.

Configuration système requise pour le système d’exploitation

Le client de relais utilise Windows Service Control Manager pour installer et gérer son service en arrière-plan. SCM est intégré à toutes les versions Windows prises en charge. Aucun logiciel supplémentaire n’est requis.

Édition	Version minimale
Windows Server	2019
Bureau Windows	10 Entreprise

Exigences supplémentaires

• PowerShell 5.1+: inclus par défaut; utilisé pour la gestion du service (Get-Service, Test-NetConnection). Vérification: $PSVersionTable.PSVersion.
• Privilèges d'administrateur: requis pour interagir avec SCM dans le cadre de l'installation, du démarrage, de l'arrêt et de la suppression du service; écrire dans C:\ProgramData\UiPathRelay\; copiez le binaire dans C:\Program Files\UiPathRelay\.

Par défaut, le service s'exécute sous la forme LocalSystem. Pour exécuter sous un compte spécifique, utilisez --service-account à l'heure de début. Voir Compte de service et autorisations.

Prérequis

Système

• Windows Server 2019+ ou Windows 10 Enterprise+
• PowerShell 5.1 ou version ultérieure
• Accès de l’administrateur à la machine cible
• 200 Mo d’espace disque libre minimum
• Si vous utilisez une connexion basée sur TCP qui nécessite l'exécuteur sur site:
  • Examiner la capacité d’hôte et d’exécuteur recommandée
  • Un JRE ou un JDK Java 21 ou plus récent, soit sur PATH, soit transmis avec --onprem-executor-java-home. Une installation existante fonctionne.

Réseau

• Pour le client de relais 26.4.2 ou version ultérieure, le HTTPS sortant vers cloud.uipath.com est autorisé, y compris les mises à niveau WebSocket
• Pour les versions de client de relais antérieures à 26.4.2, le TLS sortant (port 443) vers <region>-relay.uipath.com est autorisé et l’interception TLS est configurée
• L'hôte de relais peut résoudre et se connecter à chaque point de terminaison HTTP ou HTTPS enregistré, ainsi qu'à l'hôte et au port de chaque point de terminaison basé sur TCP pris en charge

Sécurité

• Compte de service créé (si vous n'utilisez pas LocalSystem) (voir Compte de service et autorisations)
• Exclusions Windows Plus et antivirus planifiées (voir Protection antivirus et protection des points de terminaison)
• Si vous utilisez l'exécuteur sur site: un répertoire des dépendances du connecteur et un runtime Java, aux deux emplacements seuls les administrateurs peuvent modifier, par exemple sous C:\Program Files. L'exécuteur charge le code de ces deux

Configuration

• Groupe de relais créé et chaîne de configuration client prête (voir Configuration d'un groupe de Relay)

Valider les prérequis

Exécutez les commandes suivantes dans PowerShell:

# Check PowerShell version (must be 5.1+)
$PSVersionTable.PSVersion

# Verify Administrator access
([Security.Principal.WindowsPrincipal][Security.Principal.WindowsIdentity]::GetCurrent()).IsInRole([Security.Principal.WindowsBuiltInRole]::Administrator)

# Check available disk space
Get-PSDrive C | Select-Object Used, Free

# On-prem executor only: Java 21+ on PATH, or pass --onprem-executor-java-home
java -version

Installer

1. Télécharger et extraire

Téléchargez l'archive du client Relay pour votre architecture (x86_64 ou ARM64) à partir du Customer Portal UiPath.

Extrayez l'archive zip. À partir du client de relais 26.4.3, il contient relay.exe et onprem-executor.jar. Laissez les deux fichiers ensemble dans le répertoire extrait et exécutez les commandes d'installation ou de mise à niveau depuis ce répertoire.

2. Démarrer

Ouvrez PowerShell en tant qu'administrateur avant d'exécuter une commande de démarrage.

Vous pouvez fournir la chaîne de configuration client (générée dans l’administration UiPath, comme décrit dans Configuration d’un groupe de relais) de deux manières:

Option A: en ligne. Transmettez la chaîne de configuration directement. Aucun fichier à créer ou à nettoyer:

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

Option B: fichier. Enregistrez la configuration dans un fichier, puis référencez-la. Il s’agit de l’option recommandée, car elle permet de maintenir la clé secrète en dehors de l’historique du shell:

Set-Content -Path ".\config.txt" -Value "<your-config>"
.\relay.exe start --config-file ".\config.txt" --accept-license-agreement

Pour une connexion basée sur TCP prise en charge qui nécessite l’exécuteur sur site, stockez d’abord les bibliothèques de connecteurs, comme décrit dans Ajouter des dépendances de connecteur, puis démarrez le client avec une seule commande.

Ajouter des dépendances de connecteurs

Certains connecteurs nécessitent des bibliothèques tierces qui ne sont pas incluses avec le client de relais. Obtenez-les auprès du fournisseur du connecteur et placez-les tous dans un répertoire dédié sur l’hôte de relais. Le client de relais stocke le chemin du répertoire mais ne copie pas les bibliothèques. Un répertoire sous C:\Program Files, tel que C:\Program Files\UiPathRelay\executor-deps, n’est modifiable que par les administrateurs par défaut.

Important :

L'exécuteur local charge et exécute ces bibliothèques avec les autorisations du compte de service de relais. Utilisez un répertoire solide que le compte de service peut lire et qui n’est modifiable que par les administrateurs. Toute personne pouvant modifier son contenu peut exécuter du code avec ces autorisations.

Pour SAP BAPI, obtenez les bibliothèques SAP JCo 3 auprès de SAP et placez ces fichiers dans le répertoire des dépendances:

Fichier requis	Objectif
sapjco3.jar	Bibliothèque Java SAP JCo
sapidoc3.jar	Bibliothèque Java SAP IDoc
sapjco3.dll	Bibliothèque native SAP JCo correspondant à l’architecture du runtime Java

Pour un autre connecteur pris en charge, placez les bibliothèques de fournisseurs répertoriées dans la documentation de ce connecteur dans le même répertoire.

Commencer avec l’exécuteur sur site

Créez le répertoire des dépendances, copiez les bibliothèques et démarrez le client de relais avec l’exécuteur activé. Pointez --onprem-executor-java-home sur un runtime Java 21 ou plus récent installé sous C:\Program Files, afin que l'exécuteur utilise le runtime que vous avez prévu:

.\relay.exe start --config-file ".\config.txt" `
  --accept-license-agreement `
  --enable-onprem-executor `
  --onprem-executor-java-home "C:\Program Files\Java\jdk-21" `
  --onprem-executor-dep-dir "C:\Program Files\UiPathRelay\executor-deps"

Remarque :

Les indicateurs --config et --config-file sont mutuellement exclusifs. Pour exécuter au premier plan plutôt qu'en tant que service d'arrière-plan (utile pour le débogage), saisissez --detach=false.

Le client Relay valide la connectivité, s'authentifie avec OAuth, s'enregistre auprès de Test Cloud, télécharge la configuration du proxy et installe un service Windows, le tout en une seule commande.

Sortie attendue :

Running prerequisite checks...
  ✓ Directory permissions: OK
  ✓ Cloud portal connectivity: OK
✓ All prerequisite checks passed
Waiting for service to start...
  ✓ Service is running

✓ Relay is now running in the background.
Check status:
  PowerShell: Get-Service "Relay-<id>"
  Services:   services.msc (look for "Relay - <id>")

Remarque :

Lors du démarrage, le client de relais copie automatiquement le binaire dans C:\Program Files\UiPathRelay\relay.exe. Tous les groupes de Relay sur la machine partagent ce fichier binaire unique. Remplacez le répertoire d'installation par --bin-dir.

Pour démarrer sous un compte de service personnalisé au lieu de LocalSystem:

.\relay.exe start --config-file C:\path\to\config.txt `
  --accept-license-agreement `
  --service-account "DOMAIN\svc-relay" `
  --service-account-password "<password>"

3. Vérifier

.\relay.exe list

Un client sain affiche ● running dans la colonne STATUT. La valeur ID affichée est utilisée dans toutes les commandes suivantes (.\relay.exe stop <id>, .\relay.exe logs <id>, etc.). Il est également disponible dans l’administration d’UiPath sous la page des détails du groupe de Relay.

Confirmez que le tunnel est établi en vérifiant les journaux pour login to server success:

.\relay.exe logs <id> -f

Si l’exécuteur local est activé, confirmez sa configuration:

.\relay.exe describe <id>

La section Exécuteur local rapporte Enabled: true avec le port d'écoute, la version du runtime, le chemin d'accès au runtime, l'accueil Java et le répertoire des dépendances qu'il utilise. Vérifiez que les répertoires d'accueil et de dépendances Java sont ceux que vous avez prévu.

Vérifiez ensuite que l’exécuteur a démarré. Son journal contient une entrée Started OnPremRuntimeApplication une fois qu'il est prêt:

Select-String -Path "C:\ProgramData\UiPathRelay\logs\<id>\onprem-executor.log" -Pattern "Started OnPremRuntimeApplication"
Get-Content "C:\ProgramData\UiPathRelay\logs\<id>\onprem-executor.log" -Tail 20

Si vous avez configuré un répertoire de journaux personnalisé, utilisez plutôt son chemin d’accès onprem-executor.log. Exécutez ensuite un appel de test depuis le connecteur qui utilise ce point de terminaison pour confirmer que le chemin complet fonctionne.

Gérer (Manage)

Toutes les commandes de gestion nécessitent Administrator PowerShell, à l'exception de list et version.

List

Affiche tous les groupes de Relay installés sur cette machine avec le statut, la version et le nom de groupe lorsqu'il est disponible. Ne nécessite pas de privilèges d’administrateur.

.\relay.exe list
.\relay.exe list --json

Décrire

Remarque :

Disponible avec le client de relais 26.4.2 et versions ultérieures. Exécutez .\relay.exe version pour vérifier votre version installée.

Affiche des informations détaillées sur un groupe de Relay, y compris les paramètres de service, les chemins configurés, le statut, la version et le nom du groupe lorsqu'il est disponible. Ne nécessite pas de privilèges d’administrateur.

.\relay.exe describe <id>
.\relay.exe describe <id> --json

Arrêter

Arrête le service de relais. La configuration et les journaux sont conservés. Le relais peut être redémarré ultérieurement.

.\relay.exe stop <id>

Redémarrer et mettre à niveau

Redémarre le service de Relay et récupère la dernière configuration du proxy à partir de Test Cloud.

.\relay.exe restart <id>

Mettre à niveau: extrayez la nouvelle archive du client de relais. Conservez le nouveau relay.exe et le onprem-executor.jar correspondant, puis exécutez .\relay.exe restart <id> à partir du répertoire extrait. La commande de redémarrage met à jour le fichier binaire installé et, lorsque l'exécuteur est activé, son JAR.

Pour activer l'exécuteur sur un service déjà installé, exécutez .\relay.exe restart <id> --enable-onprem-executor à partir du répertoire d'archives extraites, afin que l'élément onprem-executor.jar correspondant soit disponible.

Scénario	Commande
Ajout ou suppression de points de terminaison dans Test Cloud	.\relay.exe restart <id>
Rotation de la clé secrète du client (en ligne)	.\relay.exe restart --config "<new-config>"
Rotation de la clé secrète du client (fichier)	.\relay.exe restart --config-file new-config.txt
Modification du niveau de journalisation	.\relay.exe restart <id> --log-level debug
Consigner le répertoire ou la modification de la rétention	.\relay.exe restart <id> --logs-dir "D:\MyCompany" --log-retention-days 30
Activer l’exécuteur local	.\relay.exe restart <id> --enable-onprem-executor
Désactiver l’exécuteur local	.\relay.exe restart <id> --disable-onprem-executor
Mise à niveau du client de relais	Extraire la nouvelle archive, puis exécuter .\relay.exe restart <id>

Remarque :

Lorsque --config ou --config-file est fourni, l'argument <id> est facultatif. Il est extrait de la configuration.

Supprimer (Delete)

Arrête le service, se désinscrit de Test Cloud et supprime tous les fichiers de configuration et de journalisation locaux.

.\relay.exe delete <id>

Pour forcer le nettoyage local sans désenregistrement du cloud, par exemple si les informations d’identification sont perdues ou si le groupe de Relay côté cloud a déjà été supprimé:

.\relay.exe delete <id> --force

Version

.\relay.exe version

Remarque :

Il n'y a pas de mise à niveau automatique. Extrayez la nouvelle archive et exécutez .\relay.exe restart <id> depuis son répertoire pour chaque groupe.

Structure du répertoire

Tous les répertoires sont créés automatiquement lors de la première exécution.

C:\Program Files\UiPathRelay\
  relay.exe                                  # Shared binary

C:\ProgramData\UiPathRelay\
  groups\<id>\
    client_config                            # OAuth credentials (encrypted via DPAPI)
    metadata.json                            # State, PID, install timestamps
    .credentials.key                         # Encryption key
    onprem-executor.jar                      # Executor runtime when enabled
  logs\<id>\
    relay.log                                # Current log
    relay.YYYYMMDD-HHMMSS.log                # Rotated logs
    onprem-executor.log                      # Executor log when enabled

Le nom du service Windows est Relay-<id> et le nom complet (affiché dans services.msc) est Relay - <id>. Le type de démarrage est Automatique; le compte par défaut est LocalSystem.

Chemins d’accès personnalisés

Remplacez les répertoires par défaut lors de l’installation du client de relais.

.\relay.exe start --config-file C:\path\to\config.txt `
  --accept-license-agreement `
  --bin-dir "D:\MyCompany\bin" `
  --data-dir "D:\MyCompany" `
  --logs-dir "D:\MyCompany"

Drapeau	Default	Description
--bin-dir	C:\Program Files\UiPathRelay	Répertoire pour le fichier binaire partagé
--data-dir	C:\ProgramData	Racine pour les données de configuration
--logs-dir	C:\ProgramData	Racine pour les fichiers journaux; peut être modifié avec restart

Le client de relais ajoute UiPathRelay\ sous les données personnalisées et les racines du journal:

--bin-dir  D:\MyCompany\bin  =>  D:\MyCompany\bin\relay.exe
--data-dir D:\MyCompany      =>  D:\MyCompany\UiPathRelay\groups\<id>\
--logs-dir D:\MyCompany      =>  D:\MyCompany\UiPathRelay\logs\<id>\

Remarque :

--bin-dir et --data-dir ne sont acceptés que par la commande start . --logs-dir est accepté par start et restart. Les autres commandes (stop, delete, list) permettent de découvrir des chemins automatiquement à partir de la configuration du service installé.

Compte de service et autorisations

Cette section s’applique uniquement lors de l’exécution du service sous un compte personnalisé au lieu du compte par défaut LocalSystem.

Droits d’utilisateur requis

Droite	Description	Comment configurer
SeServiceLogonRight	Ouvrir une session en tant que service	Stratégie de sécurité locale > Attribution des droits d’utilisateur > Se connecter en tant que service

Pour les environnements de domaine, configurez ce droit via la stratégie de groupe pour garantir la cohérence entre les serveurs.

Autorisations NTFS

Chemin d'accès	Autorisations requises
C:\Program Files\UiPathRelay\	Read & Execute
C:\ProgramData\UiPathRelay\	Lire, Écrire, Modifier
C:\ProgramData\UiPathRelay\logs\	Lire, Écrire, Modifier, Supprimer
Répertoire des dépendances (exécuteur uniquement)	Lire & Exécuté et non inscriptible par des utilisateurs non privilégiés. Hérité de C:\Program Files par défaut
Installation de Java (exécuteur uniquement)	Lire & Exécuté et non inscriptible par des utilisateurs non privilégiés

Via PowerShell

$account = "DOMAIN\svc-relay"

$acl = Get-Acl "C:\Program Files\UiPathRelay"
$rule = New-Object System.Security.AccessControl.FileSystemAccessRule($account, "ReadAndExecute", "ContainerInherit,ObjectInherit", "None", "Allow")
$acl.SetAccessRule($rule)
Set-Acl "C:\Program Files\UiPathRelay" $acl

$acl = Get-Acl "C:\ProgramData\UiPathRelay"
$rule = New-Object System.Security.AccessControl.FileSystemAccessRule($account, "Modify", "ContainerInherit,ObjectInherit", "None", "Allow")
$acl.SetAccessRule($rule)
Set-Acl "C:\ProgramData\UiPathRelay" $acl

Ces commandes ajoutent le compte de service aux autorisations déjà présentes sur chaque chemin. Elles ne suppriment pas les autorisations dont peuvent disposer d’autres comptes. Si le répertoire des dépendances se situe en dehors de C:\Program Files, accordez également au compte Read & Exécutez-la et supprimez l’accès en écriture pour les non-administrateurs.

À partir d'un compte de service personnalisé

.\relay.exe start --config-file C:\path\to\config.txt `
  --accept-license-agreement `
  --service-account "DOMAIN\svc-relay" `
  --service-account-password "<password>"

--service-account-password est requis pour le domaine ou les comptes d'utilisateurs locaux. PowerShell enregistre la ligne de commande dans son fichier d'historique, et le mot de passe est visible dans la ligne de commande du processus pendant que la commande s'exécute, préférez donc un compte de service géré de groupe, qui ne nécessite aucun mot de passe.

Lorsque l’exécuteur local est activé, exécutez le service sous un compte dédié plutôt que LocalSystem. L'exécuteur charge les bibliothèques de connecteurs tierces avec les privilèges du compte de service, et LocalSystem est le compte local ayant le plus de privilèges.

Pour ce compte:

• Accordez uniquement les autorisations dans les autorisations NTFS, plus le droit de vous connecter en tant que service.
• Ne l'ajoutez pas au groupe Administrators.
• Réappliquez ces autorisations, y compris le répertoire des dépendances et l’installation Java, si vous modifiez le compte ultérieurement.

Comptes de service gérés de groupe

# Install the gMSA on the server (run once per server)
Install-ADServiceAccount -Identity "gMSA-Relay$"

# Start the Relay client with gMSA (no password required)
.\relay.exe start --config-file config.txt --service-account "DOMAIN\gMSA-Relay$" --accept-license-agreement

Les gMSA font automatiquement pivoter les mots de passe et éliminent les frais généraux liés à la gestion des informations d’identification.

Détails du service Windows

Affichage du statut du service

Via la console de services

1. Ouvrez Exécuter (Win + R) et saisissez services.msc.
2. Localisez le service avec le nom complet Relay - <id>.
3. Ouvrez le menu contextuel pour démarrer, arrêter, redémarrer ou afficher les propriétés.

Via PowerShell

# All Relay services
Get-Service "Relay-*"

# Detailed information
Get-Service "Relay-<id>" | Format-List *

# Service configuration (account, start mode)
Get-CimInstance Win32_Service -Filter "Name LIKE 'Relay-%'" | Select-Object Name, StartMode, State, StartName

Récupération du service

Lorsque le client de relais s'installe en tant que service, il configure la récupération automatique:

• Premier échec: redémarrer après 10 secondes
• Deuxième échec: redémarrer après 30 secondes
• Échecs suivants: redémarrer avec des délais d'escalade

Pour examiner ou ajuster les paramètres de récupération: ouvrez services.msc > cliquez droit sur le service > Propriétés > onglet Récupération .

Visionneuse d'événements

Utilisez l’Observateur d’événements (eventvwr.msc) pour diagnostiquer les problèmes de service.

Journal (Log)	Chemin d'accès	Events
Système	Journaux Windows > Système	Démarrage, arrêt, panne et récupération du service (série 7 000)
Application	Journaux Windows > Application	Erreurs d’application

Interroger les événements de Relay via PowerShell

Get-WinEvent -FilterHashtable @{LogName='System'; ID=7000,7009,7031,7034,7036,7045} -MaxEvents 100 |
  Where-Object { $_.Message -like '*Relay*' } |
  Format-Table TimeCreated, Id, Message -Wrap

ID d'événement	Signification
7000	Le service n’a pas pu démarrer. Vérifier les autorisations du compte
7009	Délai en attente de service. Vérifier la connectivité du réseau
7031	Plantage du service et action de récupération entreprise. Cochez relay.log
7034	Service terminé de manière inattendue. Vérifier l’épuisement des ressources
7045	Nouveau service installé (confirme l'installation réussie)

Configuration du proxy

Les services Windows héritent des variables d’environnement du système. Définissez les variables de proxy au niveau de la machine avant de démarrer le client de relais:

[Environment]::SetEnvironmentVariable("HTTPS_PROXY", "http://proxy.corp.example.com:8080", "Machine")
[Environment]::SetEnvironmentVariable("NO_PROXY", "localhost,127.0.0.1,.corp.example.com", "Machine")
.\relay.exe start --config "<your-config>" --accept-license-agreement

Définir des variables de proxy au niveau de l’utilisateur n’est pas suffisant. Les services système ignorent les variables d’environnement au niveau de l’utilisateur.

Pour mettre à jour le proxy: modifiez la variable au niveau du système et exécutez .\relay.exe restart <id>.

Pour supprimer le proxy: [Environment]::SetEnvironmentVariable("HTTPS_PROXY", $null, "Machine"), puis .\relay.exe restart <id>.

À vérifier: [Environment]::GetEnvironmentVariable("HTTPS_PROXY", "Machine").

Pour les schémas de proxy et l’authentification pris en charge, consultez la section du proxy dans le déploiement du client de relais.

Pare-feu Windows

Si le trafic sortant est restreint par le pare-feu Windows, ajoutez une règle sortante pour le fichier binaire du client de relais.

Si l’exécuteur local est activé et que les règles de programme sortant sont appliquées, autorisez également l’exécutable Java utilisé par l’exécuteur à se connecter à l’hôte et au port cible de chaque connexion TCP prise en charge. Étendue de la règle à ces destinations plutôt que d’autoriser tout le trafic sortant.

Aucune règle entrante n'est requise. L'exécuteur écoute uniquement sur l'interface de bouclage, sur le port 18080 par défaut, et n'accepte aucune connexion de l'extérieur de l'hôte. N'ouvrez pas ce port. Pour confirmer que l'écouteur est lié au bouclage, exécutez Get-NetTCPConnection -LocalPort 18080 -State Listen et vérifiez que LocalAddress est 127.0.0.1 ou ::1.

Paramètre	Valeur (Value)
Direction	Sortant
Programme	C:\Program Files\UiPathRelay\relay.exe
Protocole/Port	TCP/443
Profils	Domaine, privé

Via PowerShell

New-NetFirewallRule -DisplayName "UiPath Relay - Outbound HTTPS" `
  -Direction Outbound `
  -Program "C:\Program Files\UiPathRelay\relay.exe" `
  -Protocol TCP `
  -RemotePort 443 `
  -Action Allow `
  -Profile Domain,Private

# Verify rule
Get-NetFirewallRule -DisplayName "UiPath Relay*" | Format-Table Name, Enabled, Direction, Action

Via GUI (pare-feu Windows Pare-feu avec sécurité avancée):

1. Ouvrez wf.msc.
2. Sélectionnez Règles sortantes > Nouvelle règle.
3. Choisissez Program et spécifiez: C:\Program Files\UiPathRelay\relay.exe.
4. Sélectionnez Autoriser la connexion.
5. Appliquer aux profils de domaine et privés .
6. Nommez la règle: UiPath Relay - Outbound HTTPS.

Si votre organisation gère les règles de pare-feu via une stratégie de groupe ou un pare-feu tiers, adressez-vous à votre administrateur Windows afin d'ajouter une règle équivalente.

Protection antivirus et des points de terminaison

Ajoutez des exceptions pour le fichier binaire du client de relais et ses répertoires de données afin d’éviter toute interférence.

Saisie de texte	Chemin d'accès
Binaire	C:\Program Files\UiPathRelay\relay.exe
Données et journaux	C:\ProgramData\UiPathRelay\
Exécutable Java (exécuteur uniquement)	Le chemin d'accès complet au fichier java.exe utilisé par l'exécuteur
Bibliothèques de connecteurs (exécuteur uniquement)	Le répertoire des dépendances

N’ajoutez pas d’exclusion de processus pour java.exe. Il empêche la protection des points de terminaison d'inspecter un processus dont la tâche charge un code tiers et d'atteindre les systèmes internes, et un nom de fichier à barres s'applique à chaque processus Java sur l'hôte. Utilisez des extractions de chemin et indiquez toute exclue de processus comme chemin complet.

Si vous utilisez un contrôle d'application tel que Windows Window Center Application Control ou AppLocker, notez que onprem-executor.jar est remplacé à chaque mise à niveau du client de relais, de sorte qu'une règle qui autorise un hachage de fichier spécifique arrête la correspondance après chaque mise à niveau. Utilisez des règles d’accès ou d’éditeur et approuvez à nouveau le JAR dans le cadre de votre procédure de mise à niveau.

Si vous avez utilisé des chemins personnalisés via --bin-dir, --data-dir ou --logs-dir, excluez plutôt ces chemins.

Windows Protection via PowerShell

Add-MpPreference -ExclusionPath "C:\Program Files\UiPathRelay"
Add-MpPreference -ExclusionPath "C:\ProgramData\UiPathRelay"
Add-MpPreference -ExclusionProcess "relay.exe"

Windows Définir via GUI

1. Ouvrez Sécurité Windows > Protection contre les virus et les menaces > Gérer les paramètres.
2. Sous Exclusions, sélectionnez Ajouter ou supprimer des exclues.
3. Ajoutez des exceptions de dossier: C:\Program Files\UiPathRelay\ et C:\ProgramData\UiPathRelay\
4. Ajoutez l’exclusion de processus: relay.exe

Pour la protection des points de terminaison gérée de manière centralisée, travaillez avec votre administrateur de sécurité pour ajouter les extractions ci-dessus.

Désinstaller

1. Supprimez tous les clients de relais (utilisez .\relay.exe list pour voir les groupes installés):

   .\relay.exe delete <id>
   

2. Supprimez le fichier binaire partagé:

   Remove-Item "C:\Program Files\UiPathRelay" -Recurse
   

3. Supprimer les répertoires de données restants:

   Remove-Item "C:\ProgramData\UiPathRelay" -Recurse
   

4. Supprimez les exclues Windows Définir:

   Remove-MpPreference -ExclusionPath "C:\Program Files\UiPathRelay"
   Remove-MpPreference -ExclusionPath "C:\ProgramData\UiPathRelay"
   Remove-MpPreference -ExclusionProcess "relay.exe"
   

5. Supprimez la règle Pare-feu Windows:

   Remove-NetFirewallRule -DisplayName "UiPath Relay - Outbound HTTPS"
   

Pour les règles ajoutées via la stratégie de groupe ou un pare-feu tiers, adressez-vous à votre administrateur Windows pour les supprimer.

Résolution des problèmes

Symptôme	Origine	Résolution
Le service ne démarre pas	Autorisations insuffisantes	Ouvrez PowerShell en tant qu'administrateur.
permission denied	Impossible d’écrire dans Fichiers de programme ou DonnéesProgramme	Vérifiez l’accès de l’administrateur ou utilisez --bin-dir / --data-dir pour les chemins inscriptibles
does not have the 'Log on as a service' right	Compte personnalisé manquant SeServiceLogonRight	Accorder via la stratégie de sécurité locale > Attribution des droits d’utilisateur ou utiliser la stratégie de groupe
not a valid Windows account	Format incorrect pour --service-account	Utilisez .\username pour les comptes locaux ou DOMAIN\username pour les comptes de domaine
marked for deletion /service - suppression en attente	services.msc a un handle ouvert	Fermez services.msc et réessayez; redémarrer si le problème persiste
service is disabled	Désactivé via services.msc ou la stratégie de groupe	Réactiver: Set-Service -Name "Relay-<id>" -StartupType Automatic
file is locked by another process	Binaire utilisé lors de la mise à jour	Arrêtez d’abord le service du client de relais, puis réessayez
path exceeds Windows path length limit	Le chemin des données/journaux dépasse la limite de 260 caractères	Utilisez des chemins plus courts pour --data-dir et --logs-dir
Blocage des antivirus relay.exe	Fichier binaire mis en quarantaine par la protection des points de terminaison	Ajoutez des exceptions (voir Protection antivirus et protection des points de terminaison); vérifier la mise en quarantaine et restaurer
Service en cours d’exécution, mais tunnel non établi	Problème de réseau ou d'authentification	Consultez relay.log pour obtenir les erreurs login to server ; vérifiez la connectivité à cloud.uipath.com; pour les versions de client de relais antérieures à 26.4.2, vérifiez la transmission TLS au nom d’hôte du relais régional
DPAPI decrypt failed	L'identité de la machine a été modifiée après le clonage ou le réimage de la machine virtuelle	Réenregistrer le relais avec une nouvelle configuration à partir de l'administration UiPath
Proxy non utilisé par le service	Proxy défini au niveau de l’utilisateur, et non au niveau du système	Définissez HTTPS_PROXY au niveau de la machine (voir Configuration du proxy); redémarrer le service

Commandes de diagnostic

# Real-time logs
.\relay.exe logs <id> -f

# Service details
Get-Service "Relay-<id>" | Format-List *

# Connectivity test
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

Pour les erreurs d'authentification et de connectivité partagées entre les plates-formes, voir Résolution des problèmes.

Référence rapide

Action	Commande
Démarrer (Start)	.\relay.exe start --config-file config.txt --accept-license-agreement
Arrêter	.\relay.exe stop <id>
Redémarrer/Mettre à niveau	.\relay.exe restart <id>
Supprimer (Delete)	.\relay.exe delete <id>
Supprimer (forcer)	.\relay.exe delete <id> --force
List	.\relay.exe list
Décrire	.\relay.exe describe <id>
Journaux (Logs)	.\relay.exe logs <id> -f
État du service	Get-Service "Relay-<id>"
Console des services	services.msc