Déploiement du client de relais

Prérequis du client Relay, exigences minimales et étapes de configuration multi-plateformes pour la connexion de votre réseau sur site à Test Cloud.

Installez et démarrez le client Relay sur une machine à l'intérieur de votre réseau pour établir le tunnel sortant vers Test Cloud. Avant de commencer, configurez un groupe Relay et préparez la chaîne de configuration du client.

Prérequis

Prérequis matériels

Profil	vCPU	RAM	Groupes de relais	Points de terminaison par groupe	Use case
Standard	1	2 Gio	Jusqu’à 10	Jusqu’à 50	La plupart des déploiements
Grande	2	4 Gio	10+	Jusqu’à 50	Environnements à haut débit ou à grande échelle

Il s'agit de la configuration minimale requise pour le client de relais lorsque l'exécuteur local n'est pas activé. Si l’hôte exécute également d’autres charges de travail, ajoutez de la capacité à ces chiffres en plus de ces chiffres. Pour les déploiements qui activent l'exécuteur, utilisez plutôt les chiffres de la section Planification des ressources pour les connexions basées sur TCP .

Planification des ressources pour les connexions basées sur le protocole TCP

Chaque groupe de relais que vous installez s'exécute sous son propre service client de relais. Lorsque l'exécuteur local est activé, ce service démarre et supervise un processus Java. Les chiffres ci-dessous concernent un groupe de Relay unique avec l'exécuteur activé.

Profil	vCPU	RAM	RAM réservée à l’exécuteur
Standard (avec exécuteur)	2	4 Gio	1 Gio
Grand (avec exécuteur)	4 ou plus	4 Gio ou plus	1 Gio ou plus

La RAM inclut la réservation de l'exécuteur, le système d'exploitation et le runtime Java. Ajoutez de la capacité pour la surveillance et toutes les autres charges de travail sur l'hôte. Après la mise en service, si l'utilisation de la mémoire de l'exécuteur approche de sa réservation, augmentez la réserve et la RAM ensemble.

Astuce :

Pour minimiser l’utilisation des ressources, enregistrez tous vos points de terminaison basés sur TCP sous un seul groupe de Relay. Son client Relay exécute ensuite un exécuteur sur site pour chaque point de terminaison basé sur TCP, ce qui vous permet de réserver de la mémoire, de dimensionner l'hôte et de surveiller les journaux de l'exécuteur pour un seul processus.

Si vos exigences de segmentation réseau ou de disponibilité nécessitent plus d’un groupe de Relay avec l’exécuteur sur le même hôte:

• Attribuez à l'exécuteur de chaque groupe une valeur --onprem-executor-listen-port unique.
• Réservez 1 Gio supplémentaire pour chaque processus d'exécution supplémentaire.
• Dimensionner le CPU pour le trafic total sur tous les groupes, plutôt que de multiplier le chiffre CPU par groupe par le nombre de groupes.
• Autoriser le disque pour un JAR d'exécuteur distinct et un fichier journal par groupe.

Prérequis pour le disque

Profil	Disque libre minimum
Standard (1 à 10 groupes)	200 Mo
Grand (au moins 10 groupes)	1 Go

Les minimaux ci-dessus couvrent uniquement le client de relais. Si vous activez l’exécuteur local, réservez un espace supplémentaire pour le runtime Java, onprem-executor.jar, les bibliothèques de connecteurs que vous fournissez et les journaux de l’exécuteur conservés. La croissance des journaux dépend de votre volume de trafic, du niveau de journalisation et de la période de rétention configurée.

Systèmes d'exploitation pris en charge

Architecture	Linux	Windows
x86_64	Pris en charge	Pris en charge
ARM64	Pris en charge	Pris en charge

Configuration requise pour le réseau

Le client de relais nécessite une connectivité sortante uniquement. Aucune règle de pare-feu entrant n’est nécessaire.

Chaque version de client de relais atteint cloud.uipath.com pour s’authentifier et s’enregistrer. À partir du client de relais 26.4.2, les nouvelles configurations comportent également le tunnel persistant sur cette même URL, de sorte qu’elles n’ont plus besoin d’un nom d’hôte de relais spécifique à la région sur la liste d’autorisation.

Configuration du client de relais	Protocole	Port	Destination	Autorisation TLS requise	Objectif
Toutes les versions du client de relais	https	443	cloud.uipath.com	Non requis	Authentification et enregistrement du Relay
Client de relais 26.4.2 ou version ultérieure	HTTPS/WSS	443	cloud.uipath.com	Non requis	Tunnel persistant
Versions de client de relais antérieures à 26.4.2	TLS	443	<region>-relay.uipath.com	Requis	Tunnel persistant

Les versions du client de relais antérieures à 26.4.2 continuent de fonctionner avec les noms d’hôte de relais régionaux. Conservez ces noms d'hôtes dans la liste d'autorisation jusqu'à ce que vous passiez au client de relais 26.4.2 ou à une version ultérieure, et que vous vous connectiez via cloud.uipath.com.

Pour les versions du client Relay antérieures à 26.4.2, remplacez <region> par la région de votre locataire Test Cloud. Pour obtenir la liste complète des régions, consultez la section Régions Cloud mondiales.

Region	Nom d'hôte du serveur de relais
us	us-relay.uipath.com
UE	eu-relay.uipath.com
Canada	ca-relay.uipath.com
Suisse	ch-relay.uipath.com
Australie	au-relay.uipath.com
Singapour	sg-relay.uipath.com
Japon	jp-relay.uipath.com
Corée du Sud	kr-relay.uipath.com
UAE	ae-relay.uipath.com
Royaume-Uni	uk-relay.uipath.com
Union européenne (région retardée)	gxp-eu-relay.uipath.com
États-Unis (région différée)	gxp-us-relay.uipath.com

Remarque :

Contactez l’assistance UiPath pour confirmer le nom d’hôte du serveur de relais si votre région de locataire n’est pas répertoriée ci-dessus.

Choisissez la région qui correspond à votre région de locataire UiPath Cloud, et non l'emplacement physique du nœud Relay. Par exemple, si votre locataire est enregistré dans la région États-Unis, utilisez us-relay.uipath.com même si le relais s'exécute dans une zone différente. Les configurations du client de relais 26.4.2 qui se connectent via cloud.uipath.com n’utilisent pas ce nom d’hôte régional.

Considérations relatives à la latence: étant donné que le trafic est déplacé depuis UiPath Cloud via le serveur de relais et le nœud de relais vers le service local, placer le nœud de relais à proximité géographique de la région de votre locataire minimise le temps d’aller-retour et améliore le débit global.

Pour les configurations de client de relais 26.4.2 qui se connectent via cloud.uipath.com, configurez les pare-feu et les proxys pour autoriser les mises à niveau du trafic HTTPS et de WebSocket vers cloud.uipath.com:443. Si un proxy inspecte TLS pour cloud.uipath.com, installez l’autorité de signature du proxy dans le magasin d’approbation du système d’exploitation utilisé par le client de relais et assurez-vous que le proxy autorise les mises à niveau de WebSocket.

Pour les versions du client Relay antérieures à 26.4.2, configurez votre pare-feu et tout proxy d'inspection TLS ou appareil DLP pour permettre le passage de TLS pour <region>-relay.uipath.com:443 ; l'inspection TLS sur le nom d'hôte du relais régional interrompt le tunnel de relais.

L'hôte de relais doit 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.

Le chemin de routage est flexible. Un routage réseau direct, un proxy de sortie d’entreprise ou un hôte intermédiaire sont tous acceptables, tant que la connexion réussit à partir de l’hôte de relais. Planifiez l’emplacement afin que chaque destination du groupe reste accessible.

Bande passante

Le canal de contrôle (pulsations et authentification) utilise environ 1 à 2 Ko/minute lorsqu’il est inactif. Le trafic de données évolue avec le volume de requêtes que vos services cloud envoient aux points de terminaison locaux. Pour les points de terminaison HTTP et HTTPS, le Relay agit comme un tunnel transparent, sans frais généraux supplémentaires au-delà de TLS et le framework WebSocket léger utilisé pour les connexions cloud.uipath.com.

Pour les connexions basées sur TCP, l’exécuteur sur site traduit chaque requête dans le protocole du connecteur. Le trafic entre l’exécuteur et le système cible reflète donc ce protocole plutôt que la taille de la requête d’origine. Le trafic entre le client de relais et l’exécuteur reste sur l’interface de bouclage et ne quitte pas l’hôte.

Vérifier la connectivité

Avant d’installer le client de relais, confirmez que le trafic sortant sur le port 443 est autorisé vers les destinations requises pour votre configuration.

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

Un résultat réussi affiche TcpTestSucceeded : True sous Windows et succeeded sous Linux. Si une vérification requise échoue, examinez vos règles de pare-feu. Pour les configurations du client de relais 26.4.2 qui se connectent via cloud.uipath.com, confirmez que les mises à niveau de WebSocket sont autorisées; pour les versions de client de relais antérieures à 26.4.2, confirmez que l’authentification unique TLS est configurée pour le nom d’hôte du serveur de relais.

Exécuteur local pour les connexions basées sur TCP prises en charge

Pour les connexions basées sur le TCP, telles que la SAP BAPI, les demandes sont gérées par l'exécuteur sur site, un processus Java qui interprète le protocole du connecteur et transmet l'appel au système cible. Dans les déploiements de services Linux et Windows, décrits ci-dessous, le client de relais démarre et le supervise. Dans les déploiements de conteneur, vous l'exécutez en tant que conteneur distinct: consultez la section SAP BAPI et autres connexions basées sur TCP.

Important :

La prise en charge de l’exécuteur local nécessite le client de relais 26.4.3 ou une version ultérieure.

Le client de relais démarre un processus d'exécuteur pour chaque service du client de relais, dans les déploiements de service Linux et Windows. L'exécuteur écoute uniquement sur localhost, sur le port 18080 par défaut, et n'est pas accessible depuis l'extérieur de l'hôte. Comme tout service de bouclage, il est accessible par d'autres processus sur le même hôte, traitez donc l'accès local à l'hôte de relais comme sensible.

Avant de l'activer:

• Disposez d'un runtime Java 21 ou d'une version ultérieure. Un JRE ou un JDK est suffisant, et une installation existante fonctionne. Placez java sur le PATH du compte qui exécute relay start, ou transmettez l'emplacement du runtime avec --onprem-executor-java-home.
• Extrayez le fichier binaire du relais relay sous Linux ou relay.exe sous Windows, ainsi que le fichier onprem-executor.jar groupé de la même archive. 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.
• Assurez-vous que l’hôte de relais peut atteindre le nom d’hôte et le port du système cible.
• Si un connecteur nécessite des bibliothèques qu’UiPath ne fournit pas, placez-les toutes dans un répertoire solide que le compte de service de relais peut lire, puis pointez --onprem-executor-dep-dir dessus. Le client de relais stocke le chemin d'accès, mais ne copie pas les fichiers.
• Pour SAP BAPI, ce répertoire contient les fichiers SAP JCo 3 sapjco3.jar et sapidoc3.jar, ainsi que la bibliothèque native correspondant au système d'exploitation hôte et à l'architecture de runtime Java. Utilisez la version SAP JCo prise en charge par SAP pour votre système SAP et votre runtime Java.
• Le répertoire des dépendances est un chemin de chargement de code pour l’exécuteur, qui s’exécute avec les privilèges du compte de service de relais. Il doit être la propriété de l'administrateur et ne doit pas être inscriptible par des utilisateurs non privilégiés.
• Sur Linux, utilisez 0755 pour le répertoire et 0644 pour les fichiers. Sur Windows, placez-le sous C:\Program Files, ce qui accorde aux administrateurs un accès en écriture et aux autres comptes une lecture et une exécution par défaut.

Pour les commandes d’installation et de vérification copiables, consultez la section Linux ou Windows. Après l'installation, relay describe <id> indique si l'exécuteur est activé et indique le répertoire d'accueil et de dépendances Java qu'il utilise.

Important :

Dans un déploiement de conteneur, le client de relais ne démarre pas l'exécuteur, de sorte que les exigences du runtime Java et du répertoire de dépendances pour les déploiements de service ne s'appliquent pas, et --onprem-executor-java-home et --onprem-executor-dep-dir n'ont aucun effet. Exécutez plutôt l'exécuteur en tant que conteneur distinct, comme décrit dans la section SAP BAPI et autres connexions basées sur TCP.

Configurer un proxy (le cas échéant)

Si votre réseau achemine le trafic sortant via un proxy, définissez les variables d’environnement suivantes avant d’exécuter relay start. Le client de relais utilise ces paramètres pour le trafic sortant compatible proxy.

Variable	Objectif
HTTPS_PROXY / https_proxy	URL du proxy (première vérification)
HTTP_PROXY / http_proxy	URL du proxy (de secours)
NO_PROXY / no_proxy	Hôtes ou domaines séparés par des virgules qui contournent le proxy

L’URL du proxy doit utiliser l’un de ces schémas: http://, https://, socks5:// ou ntlm://. Format: scheme://[user:password@]host:port.

Pour les https:// proxys: le client de relais valide le certificat TLS du proxy par rapport au magasin de confiance du système d’exploitation. Si votre proxy utilise une autorité de certification d’entreprise ou auto-signée, ajoutez cette autorité de certification au magasin approuvé de la machine du client de relais avant de démarrer le relais; sinon, l'établissement de la liaison TLS échoue avec une erreur de vérification du certificat.

Pour les configurations 26.4.2 du client Relay qui se connectent via cloud.uipath.com, configurez votre proxy pour autoriser les connexions HTTPS de longue durée et les mises à niveau WebSocket vers cloud.uipath.com:443. Si le proxy inspecte TLS pour cloud.uipath.com, installez l'autorité de certification du proxy dans le magasin de confiance du système d'exploitation utilisé par le client Relay.

Pour les versions du client de relais antérieures à 26.4.2, configurez votre proxy de façon à contourner l’inspection TLS pour <region>-relay.uipath.com:443. Les fichiers PAT, la découverte automatique WPAD et le chaînage de proxys ne sont pas pris en charge. Définissez explicitement l’URL du proxy. Lorsqu’un proxy est détecté, les vérifications des prérequis affichent via proxy dans la sortie.

Important :

Le client de relais caviarde les mots de passe proxy dans les journaux. Cependant, les informations d'identification définies dans les variables d'environnement peuvent être visibles dans les listes de processus et les fichiers d'unités système. Utilisez des informations d’identification de service dédiées et restreignez l’accès au nœud Relay en conséquence.

Configurer les IP approuvées (le cas échéant)

Si votre organisation restreint l'accès par adresse IP, ajoutez l'IP NAT de la machine exécutant le client Relay à la liste d'IP approuvées dans Administration UiPath. Le trafic sortant du client Relay atteint Test Cloud à partir de cette adresse IP, vous devez donc l'autoriser explicitement.

Pour obtenir des instructions, consultez Ajouter des plages d'adresses IP approuvées.

Accepter le contrat de licence

Avant de démarrer le client de relais, vous devez accepter le contrat de licence. Choisissez l’une des méthodes suivantes:

Option 1 (variable d'environnement). Définissez la variable d'environnement LICENSE_AGREEMENT pour qu'elle accepte:

Linux

export LICENSE_AGREEMENT=accept

Windows

$env:LICENSE_AGREEMENT=accept

Option 2 (paramètre en ligne). Ajoutez --accept-license-agreement à la commande relay start:

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

Guides de configuration

Pour les déploiements de production, consultez le guide de la plateforme correspondant à votre système d'exploitation. Il couvre les commandes de démarrage rapide, la structure du répertoire, la gestion des services, la configuration du cadre de sécurité et les procédures de désinstallation:

Plate-forme	Guide
Linux	Déploiement du client de relais sur Linux
Windows	Déploiement du client de relais sous Windows
Conteneur	Déploiement du client de relais en tant que conteneur

Opérations

Résilience de la connexion

Le client de relais maintient automatiquement le tunnel:

• Pulsation toutes les 30 secondes par défaut (configurable via --heartbeat-interval, minimum 10 secondes). Le délai d'expiration du tunnel est de 3 × l'intervalle des pulsations. Réduisez l'intervalle si votre pare-feu, votre proxy ou NAT abandonne les connexions TCP inactives avant 30 secondes:

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

• Reconnexion automatique à la déconnexion à l'aide d'une mise à l'échelle exponentielle du retrait à des intervalles de 20 secondes.
• Redémarrage automatique du service si le processus se bloque, géré par systemd sous Linux et Windows Service Control Manager sous Windows.
• Démarrage automatique du service au redémarrage du système.

Reconnexion proactive

Les réseaux derrière un proxy d'entreprise, un équilibreur de charge ou un pare-feu avec un délai d'expiration de connexion inactif peuvent mettre fin en mode silencieux aux connexions TLS de longue durée. La reconnexion proactive rétablit la connexion de contrôle selon une planification fixe pour éviter cela.

Activez-le avec l'indicateur --reconnect-interval :

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

La durée minimale effective est de 1 800 secondes (30 minutes). Définissez l'intervalle sur la moitié environ du délai d'inactivité de votre appareil réseau, par exemple 1 800 secondes pour un délai d'expiration du pare-feu de 60 minutes. Laissez cette option désactivée sur les réseaux stables sans délai d’inactivité pour la connexion.

• Vidage en douceur. Lorsque l'intervalle s'est écoulé, le client de relais cesse d'accepter le nouveau travail et attend la fin des connexions en cours, jusqu'à ce qu'il se termine un délai d'expiration de 300 secondes, avant de fermer l'ancienne connexion et d'en ouvrir une nouvelle. Les requêtes encore en cours lorsque le délai d’expiration du drainage est atteint sont terminées.

• Haute disponibilité. Lorsque plusieurs clients de relais sont déployés dans le même groupe, ils se coordonnent de sorte qu’un seul client se draine à la fois. Le groupe continue de servir le trafic pendant chaque cycle de reconnexion.

• Signe qu'une reconnexion proactive est nécessaire: les journaux affichent des erreurs périodiques unexpected EOF ou des déconnexions silencieuses malgré un réseau sous-jacent stable, généralement causé par un délai d'inactivité de 30 à 60 minutes sur un pare-feu, un proxy ou un équilibreur de charge.

Recharger la configuration

relay reload <id>

Récupère la configuration du proxy à partir de Test Cloud et l'applique sans redémarrer. Les modifications côté Cloud, comme les nouveaux points de terminaison ou les chemins de vérification de l'état mis à jour se propagent automatiquement vers un client Relay en cours d'exécution et ne nécessitent normalement pas de rechargement. Utilisez cette commande comme solution de secours uniquement si un point de terminaison nouvellement ajouté renvoie 404.

Journalisation

Paramètre	Valeur (Value)
Niveau par défaut	info
Rotation	Daily
Rétention	7 jours
Fichier journal (Log File)	relay.log (actuel), relay.YYYYMMDD-HHMMSS.log ( pivoté)

Remplacez le niveau de journalisation par défaut par --log-level trace/debug/info/warn/error. Dans le client de relais 26.4.2 ou version ultérieure, la rétention des journaux pivotés a été remplacée par --log-retention-days <days> sur relay start ou relay restart; la rétention minimale est de 7 jours.

Référence de commande

Début du relais

Enregistrez un nouveau client de relais et démarrez-le en tant que service d’arrière-plan.

Contrat de licence (un requis)

• --accept-license-agreement: accepter le contrat de licence utilisateur final en ligne.
• LICENSE_AGREEMENT=accept: variable d'environnement équivalente à l'indicateur. relay start imprime le CLUF et se termine si aucun des deux n'est défini.

Configuration (obligatoire)

• -c, --config <string>: chaîne de configuration encodée en base64 en ligne.
• --config-file <path>: chemin d'accès à un fichier contenant la chaîne de configuration. Recommandé: elle conserve le secret en dehors de l’historique du shell.

Ajustement (facultatif)

• --heartbeat-interval <sec>: intervalle de pulsation du tunnel. Par défaut 30. 10 minimum. Le délai d’expiration du tunnel est de 3 × cette valeur. Réduit si votre pare-feu, NAT ou proxy désactive le TCP inactif avant 30 secondes.
• --reconnect-interval <sec>: intervalle de reconnexion proactive. 0 par défaut (désactivé); minimum efficace 1800 (30 minutes) lorsqu'il est défini.
• --log-level <level>: trace, debug, info, warn ou error. Par défaut info.
• --log-retention-days <days>: nombre de jours pendant lesquels conserver les fichiers journaux pivotés. Par défaut 7. 7 minimum. Nécessite le client de relais 26.4.2 ou une version ultérieure.
• -d, --detach=false: exécuté au premier plan plutôt qu'en tant que service d'arrière-plan. Utile pour déboguer les problèmes de démarrage.

Exécuteur local (facultatif)

• --enable-onprem-executor: activez l'exécuteur local. Dans les déploiements de services Linux et Windows, le client de relais démarre le processus d'exécution groupé. Dans un déploiement de conteneur, il se connecte au conteneur de l'exécuteur sur le port par défaut 18080.
• --onprem-executor-listen-port <port>: le port sur lequel l'exécuteur local écoute. Par défaut 18080. Dans un déploiement de conteneur, utilisez la valeur SERVER_PORT du conteneur d'exécuteur. Cet indicateur seul active également l’exécuteur.
• --onprem-executor-java-home <path>: JAVA_HOME utilisé pour exécuter l'exécuteur local. Si omis, java est résolu à partir de PATH. Aucun effet dans un déploiement de conteneur.
• --onprem-executor-dep-dir <path>: répertoire unique contenant chaque dépendance de connecteur, à la fois les JAR et les bibliothèques du système d’exploitation natif correspondantes. Pour SAP BAPI, il s'agit de sapjco3.jar, sapidoc3.jar et la bibliothèque native SAP JCo pour l'hôte. Aucun effet dans un déploiement de conteneur lorsque l’image de l’exécuteur possède ce chemin d’accès.

L'adresse de l'exécuteur est fixée à localhost. Le niveau de journalisation du relais et les paramètres de rétention s’appliquent également à onprem-executor.log.

Chemins d'installation non par défaut (facultatif)

• --data-dir <path>: répertoire de configuration.
• --logs-dir <path>: répertoire du fichier journal.
• --bin-dir <path>: répertoire d'installation binaire.

Linux uniquement

• --user-mode: installez en tant que service utilisateur systemd (aucun sudo requis, utilise des chemins XDG).

Windows uniquement

• --service-account <DOMAIN\user>: exécutez le service Windows sous un compte spécifique. La valeur par défaut est LocalSystem.
• --service-account-password <password>: mot de passe pour --service-account.

Redémarrage du relais

Arrêtez et redémarrez le service du client de relais. Détecte les fichiers binaires mis à jour et applique les modifications de définition du service. Les indicateurs suivants peuvent être remplacés au moment du redémarrage (tous les indicateurs par défaut seront inchangés, sauf indication contraire):

• --config / --config-file: remplace la configuration du client.
• --accept-license-agreement: accepte le contrat de licence lors du redémarrage, utile lors de la mise à niveau d’un service installé plus ancien qui ne persistait pas l’acceptation de la licence.
• --log-level: modifiez le niveau de journalisation.
• --logs-dir <path>: déplacez le répertoire du journal du service installé. Nécessite le client de relais 26.4.2 ou une version ultérieure.
• --log-retention-days <days>: modifiez la rétention du journal pivoté. 7 minimum; transmettez -1 pour laisser inchangé. Nécessite le client de relais 26.4.2 ou une version ultérieure.
• --heartbeat-interval: modifiez l'intervalle des pulsations. 10 minimum; transmettez 0 pour laisser inchangé.
• --reconnect-interval: modifiez l’intervalle de reconnexion proactive. Minimum de 1800 (30 minutes) lorsque défini. Saisissez 0 pour désactiver ou -1 pour laisser inchangé.
• --enable-onprem-executor: activez ou mettez à jour les paramètres de l'exécuteur local sur un service installé.
• --disable-onprem-executor: supprimez les paramètres persistants de l’exécuteur sur site et redémarrez sans le processus de l’exécuteur.
• --onprem-executor-listen-port, --onprem-executor-java-home, --onprem-executor-dep-dir: mettez à jour les paramètres spécifiques de l'exécuteur local. La transmission de l'un de ces indicateurs implique une mise à jour de l'exécuteur.

Si le service installé a déjà activé l'exécuteur sur site, relay restart <id> préserve ses paramètres. Pour mettre à niveau le relais et l’exécuteur ensemble, extrayez les deux fichiers de la nouvelle archive et exécutez relay restart <id> en utilisant le nouveau binaire du relais. Les vérifications de Java et de l'exécuteur sont exécutées avant l'arrêt du service.

journaux de relais

Afficher la sortie du journal pour un client de relais.

• -f, --follow: diffuser en continu de nouvelles lignes de journal.
• -n, --lines <N>: nombre de lignes à partir de la fin. Par défaut 50.

liste de Relay

Affichez tous les clients du relais sur cette machine avec le statut, la version, les horodatages de création et de mise à jour, ainsi que le nom du groupe lorsqu'il est disponible. Les noms de groupe longs sont tronqués dans la sortie de la table.

• --json: émettez une sortie JSON pour l'automatisation et les scripts, y compris les noms de groupe complets.

Description du relais (Client de relais 26.4.2 ou version ultérieure)

Affichez des informations détaillées pour un client de relais, y compris l’ID et le nom du groupe, l’ID du secret, le statut, la version, le mode service et le chemin exécutable, la pulsation et les intervalles de reconnexion configurés, le niveau de journalisation, les chemins locaux et les horodatages.

Une section Exécuteur local indique si l'exécuteur est activé et, lorsqu'il l'est, le port d'écoute, la version du runtime, le chemin du runtime, l'accueil Java et le répertoire des dépendances.

• --json: émettre une sortie JSON pour l'automatisation et les scripts.

Rechargement du relais

Récupérez la configuration du proxy à partir de Test Cloud et appliquez-la sans redémarrer. Utilisez comme solution de secours si un point de terminaison nouvellement ajouté renvoie 404.

arrêt de Relay

Arrêtez le service client de relais. La configuration et les informations d'identification sont conservées. Le client de relais peut être redémarré ultérieurement.

suppression du relais

Arrêtez le service, désinscrivez-vous de Test Cloud et supprimez toutes les configurations et les identifiants locaux.

• -f, --force: supprimez localement sans désenregistrement du cloud. À utiliser lorsque les informations d’identification ne sont pas lisibles ou que les ressources côté cloud ont déjà été supprimées.

pack d’assistance de Relay [id]

Collectez une archive caviardée de configuration, de journaux et de métadonnées système pour un ticket d'assistance UiPath. Omettez [id] pour regrouper tous les clients de relais sur la machine. Les informations d’identification et les clés de chiffrement ne sont jamais incluses. Voir Collecter un pack d'assistance pour tous les détails.

Version du relais

imprimez la version du client de relais, la date de création et le hachage de validation git.

Sécurité antivirus et des points de terminaison

Si votre organisation exécute un logiciel de protection des points de terminaison, ajoutez des exceptions pour le fichier binaire du relais et son répertoire de données afin d’empêcher le client de relais d’être bloqué ou mis en quarantaine. Pour les configurations du client de relais 26.4.2 qui se connectent via cloud.uipath.com, autorisez cloud.uipath.com:443. Pour les versions du client de relais antérieures à 26.4.2, configurez les proxys d’inspection TLS, les appliances DLP et les systèmes IDS/IPS pour contourner l’inspection pour <region>-relay.uipath.com:443.

Si vous activez l'exécuteur local, étendez ces exclues à l'exécutable Java, au répertoire des dépendances et à onprem-executor.log. Le service Relay démarre un processus enfant Java qui charge des bibliothèques de connecteurs tierces, que certains produits de protection des points de terminaison bloquent par défaut. Étenduez les exclues à ces chemins plutôt qu’à l’ensemble de l’arborescence du répertoire.

Destination	Port	Protocole	Action
cloud.uipath.com	443	https	Autoriser
<region>-relay.uipath.com	443	TLS	Autoriser + contourner l’inspection TLS pour les versions de client de relais antérieures à 26.4.2