UiPath Documentation
test-cloud
latest
false
Guía de administración de Test Cloud
Importante :
La localización de contenidos recién publicados puede tardar entre una y dos semanas en estar disponible.

Implementar el cliente de Relay en Windows

Realiza la implementación del cliente de Relay como servicio de Windows para establecer un túnel saliente entre tu red y Test Cloud.

Esta página cubre los detalles de configuración de producción específicos de Windows. Para conocer los requisitos previos multiplataforma y los requisitos de red, consulta Implementar el cliente de Relay.

Requisitos del sistema operativo

El cliente de Relay utiliza el Gestor de control de servicios de Windows (SCM) para instalar y gestionar su servicio en segundo plano. SCM está integrado en todas las versiones de Windows compatibles. No se requiere software adicional.

EdiciónVersión mínima
Windows Server2019
Escritorio de Windows10 Empresa

Requisitos adicionales

  • PowerShell 5.1+: incluido de forma predeterminada; utilizado para la gestión de servicios (Get-Service, Test-NetConnection). Verificar: $PSVersionTable.PSVersion.
  • Privilegios de administrador: necesarios para interactuar con SCM para la instalación, inicio, detención y eliminación del servicio; escribir en C:\ProgramData\UiPathRelay\; copia el binario a C:\Program Files\UiPathRelay\.

De forma predeterminada, el servicio se ejecuta como LocalSystem. Para ejecutar bajo una cuenta específica, utiliza --service-account en la hora de inicio. Consulta Cuenta de servicio y permisos.

Requisitos previos

System

  • Windows Server 2019+ o Windows 10 Enterprise+
  • PowerShell 5.1 o posterior
  • Acceso de administrador a la máquina de destino
  • 200 MB de espacio libre en disco como mínimo
  • Si utilizas una conexión basada en TCP compatible que requiere el ejecutor local:

Red

  • Para el cliente de Relay 26.4.2 o posterior, se permite el HTTPS saliente (puerto 443) a cloud.uipath.com, incluidas las actualizaciones de WebSocket
  • Para las versiones de cliente de Relay anteriores a 26.4.2, se permite el TLS saliente (puerto 443) a <region>-relay.uipath.com y se configura el paso de TLS
  • El host de Relay puede resolver y conectarse a cada punto final HTTP o HTTPS registrado, y al host y puerto de cada punto final basado en TCP compatible

Seguridad

  • Cuenta de servicio creada (si no se utiliza LocalSystem) (consulta Cuenta de servicio y permisos)
  • Exclusiones de Windows Defender y antivirus planificadas (consulta Protección antivirus y de puntos finales)
  • Si utilizas el ejecutor local: un directorio de dependencias del conector y un runtime de Java, ambos en ubicaciones que solo los administradores pueden modificar, como en C:\Program Files. El ejecutor carga el código de ambos

Configuración

Validar requisitos previos

Ejecuta los siguientes comandos en 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
# 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

Instalar

1. Descargar y extraer

Descargue el archivo del cliente de Relay para su arquitectura (x86_64 o ARM64) desde el Customer Portal de UiPath.

Extrae el archivo zip. Comenzando con el cliente de Relay 26.4.3, contiene relay.exe y onprem-executor.jar. Deja ambos archivos juntos en el directorio extraído y ejecuta los comandos de instalación o actualización desde ese directorio.

2. Iniciar

Abre PowerShell como administrador antes de ejecutar cualquier comando de inicio.

Puedes proporcionar la cadena de configuración del cliente (generada en Administración de UiPath, como se describe en Configurar un grupo de Relay) de dos maneras:

Opción A: en línea. Pasa la cadena de configuración directamente. No hay ningún archivo para crear o limpiar:

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

Opción B: Archivo. Guarda la configuración en un archivo y luego haz referencia a ella. Esta es la opción recomendada porque mantiene el secreto fuera del historial del shell:

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

Para una conexión basada en TCP compatible que requiera el ejecutor local, prepara primero las bibliotecas del conector, como se describe en Añadir dependencias del conector y luego inicia el cliente con un solo comando.

Añadir dependencias del conector

Algunos conectores requieren bibliotecas de terceros que no se incluyen con el cliente de Relay. Obténgalos del proveedor del conector y colóquelos en un directorio dedicado en el host de Relay. El cliente de Relay almacena la ruta del directorio, pero no copia las bibliotecas. Un directorio bajo C:\Program Files, como C:\Program Files\UiPathRelay\executor-deps, solo tiene permisos de escritura para los administradores de forma predeterminada.

Importante:

El ejecutor local carga y ejecuta estas bibliotecas con los permisos de la cuenta de servicio de Relay. Utiliza un directorio duradero que la cuenta de servicio pueda leer y en el que solo los administradores puedan escribir. Cualquiera que pueda modificar su contenido puede ejecutar código con esos permisos.

Para SAP BAPI, obtén las bibliotecas de SAP JCo 3 de SAP y coloca estos archivos en el directorio de dependencias:

Archivo obligatorioPropósito
sapjco3.jarBiblioteca SAP JCo Java
sapidoc3.jarBiblioteca Java de SAP IDOC
sapjco3.dllBiblioteca nativa de Windows de SAP JCo que coincide con la arquitectura de runtime de Java

Para otro conector compatible, coloca las bibliotecas de proveedores enumeradas en la documentación de ese conector en el mismo directorio.

Comenzar con el ejecutor local

Crea el directorio de dependencias, copia las bibliotecas en él e inicia el cliente de Relay con el ejecutor habilitado. Apunta --onprem-executor-java-home a un runtime de Java 21 o posterior instalado en C:\Program Files, para que el ejecutor utilice el runtime que deseas:

.\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"
.\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"
Nota:

Los marcadores --config y --config-file son mutuamente excluyentes. Para ejecutarse en primer plano en lugar de como un servicio en segundo plano (útil para la depuración), pasa --detach=false.

El cliente de Relay valida la conectividad, se autentica con OAuth, se registra con Test Cloud, descarga la configuración del proxy e instala un servicio de Windows, todo en un solo comando.

Salida esperada:

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>")
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>")
Nota:

Durante el inicio, el cliente de Relay copia automáticamente el binario en C:\Program Files\UiPathRelay\relay.exe. Todos los grupos de Relay en la máquina comparten este único binario. Anula el directorio de instalación con --bin-dir.

Para iniciar con una cuenta de servicio personalizada en lugar de LocalSystem:

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

3. Verificar

.\relay.exe list
.\relay.exe list

Un cliente en buen estado muestra ● running en la columna ESTADO. El valor ID que se muestra se utiliza en todos los comandos posteriores (.\relay.exe stop <id>, .\relay.exe logs <id>, etc.). También puedes encontrarlo en Administración de UiPath en la página de detalles del grupo de Relay.

Confirma que el túnel está establecido comprobando los registros de login to server success:

.\relay.exe logs <id> -f
.\relay.exe logs <id> -f

Si el ejecutor local está habilitado, confirma su configuración:

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

La sección Ejecutor local informa Enabled: true con el puerto de escucha, la versión del runtime, la ruta del runtime, el inicio de Java y el directorio de dependencias que está utilizando. Comprueba que el directorio de inicio de Java y las dependencias son los deseados.

A continuación, confirma que el ejecutor se ha iniciado. Su registro contiene una entrada Started OnPremRuntimeApplication una vez que está listo:

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
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 configuraste un directorio de registro personalizado, utiliza su ruta onprem-executor.log en su lugar. A continuación, ejecuta una llamada de prueba desde el conector que utiliza este punto final, para confirmar que la ruta completa funciona.

Administrar

Todos los comandos de gestión requieren Administrator PowerShell, excepto list y version.

Lista

Muestra todos los grupos de Relay instalados en esta máquina con el estado, la versión y el nombre del grupo cuando esté disponible. No requiere privilegios de administrador.

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

Describir

Nota:

Disponible con el cliente de Relay 26.4.2 y posterior. Ejecuta .\relay.exe version para comprobar tu versión instalada.

Muestra información detallada para un grupo de Relay, incluida la configuración del servicio, las rutas configuradas, el estado, la versión y el nombre del grupo cuando esté disponible. No requiere privilegios de administrador.

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

Detener

Detiene el servicio de Relay. La configuración y los registros se conservan. El repetidor puede reiniciarse más tarde.

.\relay.exe stop <id>
.\relay.exe stop <id>

Reiniciar y actualizar

Reinicia el servicio de Relay y obtiene la configuración más reciente del proxy de Test Cloud.

.\relay.exe restart <id>
.\relay.exe restart <id>

Actualizar: extrae el nuevo archivo del cliente de Relay. Mantén juntos el nuevo relay.exe y el onprem-executor.jar coincidente y, a continuación, ejecuta .\relay.exe restart <id> desde el directorio extraído. El comando de reinicio actualiza el binario instalado y, cuando el ejecutor está habilitado, su JAR.

Para habilitar el ejecutor en un servicio que ya está instalado, ejecuta .\relay.exe restart <id> --enable-onprem-executor desde el directorio de archivo extraído, para que el onprem-executor.jar correspondiente esté disponible.

EscenarioComando
Puntos finales añadidos o eliminados en Test Cloud.\relay.exe restart <id>
Rotación de secretos de cliente (en línea).\relay.exe restart --config "<new-config>"
Rotación de secreto de cliente (archivo).\relay.exe restart --config-file new-config.txt
Cambio de nivel de registro.\relay.exe restart <id> --log-level debug
Cambio de directorio o retención de registros.\relay.exe restart <id> --logs-dir "D:\MyCompany" --log-retention-days 30
Habilitar el ejecutor local.\relay.exe restart <id> --enable-onprem-executor
Deshabilitar el ejecutor local.\relay.exe restart <id> --disable-onprem-executor
Actualización del cliente de RelayExtrae el nuevo archivo y ejecuta .\relay.exe restart <id>
Nota:

Cuando se proporciona --config o --config-file, el argumento <id> es opcional. Se extrae de la configuración.

Eliminar

Detiene el servicio, anula el registro de Test Cloud y elimina todos los archivos de configuración y de registro locales.

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

Para forzar la limpieza local sin cancelar el registro en la nube, por ejemplo, si se pierden las credenciales o el grupo de Relay en la nube ya se ha eliminado:

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

Versión

.\relay.exe version
.\relay.exe version
Nota:

No hay actualización automática. Extrae el nuevo archivo y ejecuta .\relay.exe restart <id> desde su directorio para cada grupo.

Estructura del directorio

Todos los directorios se crean automáticamente en la primera ejecución.

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

El nombre del servicio de Windows es Relay-<id> y el nombre para mostrar (que se muestra en services.msc) es Relay - <id>. El tipo de inicio es Automático; la cuenta predeterminada es LocalSystem.

Rutas personalizadas

Anule los directorios predeterminados al instalar el cliente de Relay.

.\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"
.\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"
MarcaPredeterminadoDescripción
--bin-dirC:\Program Files\UiPathRelayDirectorio para el binario compartido
--data-dirC:\ProgramDataRaíz para datos de configuración
--logs-dirC:\ProgramDataRaíz para archivos de registro; se puede cambiar con restart

El cliente de Relay anexa UiPathRelay\ en los datos personalizados y las raíces de registro:

--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>\
--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>\
Nota:

--bin-dir y --data-dir solo son aceptados por el comando start. --logs-dir es aceptado por start y restart. Otros comandos (stop, delete, list) descubren rutas automáticamente desde la configuración del servicio instalado.

Cuenta de servicio y permisos

Esta sección solo se aplica cuando se ejecuta el servicio con una cuenta personalizada en lugar de la LocalSystem.

Derechos de usuario necesarios

DerechaDescripciónCómo configurarlo
SeServiceLogonRightIniciar sesión como servicioPolítica de seguridad local > Asignación de derechos de usuario > Iniciar sesión como servicio

Para entornos de dominio, configura este derecho a través de la Política de grupo para garantizar la coherencia en todos los servidores.

Permisos NTFS

RutaPermisos necesarios
C:\Program Files\UiPathRelay\Leer y ejecutar
C:\ProgramData\UiPathRelay\Leer, Escribir, Modificar
C:\ProgramData\UiPathRelay\logs\Leer, Escribir, Modificar, Eliminar
Directorio de dependencias (solo ejecutor)Leer & Ejecutar, y no puede ser escrito por usuarios sin privilegios. Heredado de C:\Program Files de forma predeterminada
Instalación de Java (solo ejecutor)Leer & Ejecutar y no puede ser escrito por usuarios sin privilegios
A través de 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
$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

Estos comandos añaden la cuenta de servicio a los permisos que ya están en cada ruta. No eliminan los permisos que puedan tener otras cuentas. Si el directorio de dependencias está fuera de C:\Program Files, otorga también a la cuenta Leer & Ejecutar allí y eliminar el acceso de escritura para los no administradores.

Comenzar con una cuenta de servicio personalizada

.\relay.exe start --config-file C:\path\to\config.txt `
  --accept-license-agreement `
  --service-account "DOMAIN\svc-relay" `
  --service-account-password "<password>"
.\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 es obligatorio para las cuentas de dominio o de usuario locales. PowerShell registra la línea de comandos en su archivo de historial, y la contraseña es visible en la línea de comandos del proceso mientras se ejecuta el comando, así que prefiere una cuenta de servicio administrada de grupo (gMSA), que no requiere contraseña.

Cuando el ejecutor local está habilitado, ejecuta el servicio bajo una cuenta dedicada en lugar de LocalSystem. El ejecutor carga bibliotecas de conectores de terceros con los privilegios de la cuenta de servicio y LocalSystem es la cuenta local con los privilegios más altos.

Para esa cuenta:

  • Otorga solo los permisos en Permisos NTFS más el derecho de iniciar sesión como servicio.
  • No lo añadas al grupo Administradores.
  • Vuelve a aplicar esos permisos, incluido el directorio de dependencias y la instalación de Java, si cambias la cuenta más adelante.

Cuentas de servicio administradas de grupo (gMSA)

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

Las gMSA rotan las contraseñas automáticamente y eliminan la sobrecarga de gestión de credenciales.

Detalles del servicio de Windows

Ver el estado del servicio

A través de la consola de servicios
  1. Abre Ejecutar (Win + R) y escribe services.msc.
  2. Localiza el servicio con el nombre para mostrar Relay - <id>.
  3. Abre el menú contextual para iniciar, detener, reiniciar o ver las propiedades.
A través de 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
# 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

Recuperación del servicio

Cuando el cliente de Relay se instala como servicio, configura la recuperación automática:

  • Primer error: reiniciar después de 10 segundos
  • Segundo error: reiniciar después de 30 segundos
  • Fallos posteriores: reiniciar con retrasos crecientes

Para revisar o ajustar la configuración de recuperación: services.msc > haz clic con el botón derecho en el servicio > Propiedades > pestaña Recuperación .

Visor de eventos

Utiliza el Visor de eventos (eventvwr.msc) para diagnosticar problemas de servicio.

AccesoRutaEventos
SystemRegistros de Windows > SistemaInicio, detención, bloqueo y recuperación del servicio (serie 7000)
AplicaciónRegistros de Windows > AplicaciónErrores de aplicación

Consultar eventos de Relay a través de 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
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 del EventoSignificado
7000El servicio no se pudo iniciar. Comprobar los permisos de la cuenta
7009Tiempo de espera de servicio. Comprobar la conectividad de red
7031Servicio bloqueado y acción de recuperación tomada. Marcar relay.log
7034El servicio finalizó inesperadamente. Comprobar si se han agotado los recursos
7045Nuevo servicio instalado (confirma que la instalación se ha realizado correctamente)

Configuración de proxy

Los servicios de Windows heredan las variables de entorno del sistema (HKLM). Establece variables de proxy en el nivel de máquina antes de iniciar el cliente de Relay:

[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
[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

Establecer variables de proxy en el nivel de usuario no es suficiente. Los servicios del sistema ignoran las variables de entorno a nivel de usuario.

Para actualizar el proxy: cambia la variable a nivel de sistema y ejecuta .\relay.exe restart <id>.

Para eliminar el proxy: [Environment]::SetEnvironmentVariable("HTTPS_PROXY", $null, "Machine") y luego .\relay.exe restart <id>.

Para verificar: [Environment]::GetEnvironmentVariable("HTTPS_PROXY", "Machine").

Para ver los esquemas de proxy y la autenticación compatibles, consulta la sección de proxy en Implementar el cliente de Relay.

Cortafuegos de Windows

Si el tráfico saliente está restringido por el Firewall de Windows, añade una regla de salida para el binario del cliente de Relay.

Si el ejecutor local está habilitado y se aplican las reglas del programa saliente, permite también que el ejecutable de Java utilizado por el ejecutor se conecte al host y puerto de destino de cada conexión basada en TCP compatible. Ámbito de la regla a esos destinos en lugar de permitir todo el tráfico saliente.

No se requiere ninguna regla de entrada. El ejecutor escucha solo en la interfaz de bucle invertido, en el puerto 18080 de forma predeterminada, y no acepta conexiones desde fuera del host. No abras ese puerto. Para confirmar que el oyente está vinculado al bucle invertido, ejecuta Get-NetTCPConnection -LocalPort 18080 -State Listen y comprueba que LocalAddress es 127.0.0.1 o ::1.

ConfiguraciónValor
DirecciónSaliente
ProgramaC:\Program Files\UiPathRelay\relay.exe
Protocolo/PuertoTCP/443
PerfilesDominio, privado

A través de 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
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

A través de GUI (Firewall de Windows Defender con seguridad avanzada):

  1. wf.msc.
  2. Selecciona Reglas de salida > Nueva regla.
  3. Elige Programa y especifica: C:\Program Files\UiPathRelay\relay.exe.
  4. Selecciona Permitir la conexión.
  5. Aplicar a los perfiles Dominio y Privado .
  6. Nombra la regla: UiPath Relay - Outbound HTTPS.

Si tu organización gestiona las reglas de firewall a través de la Política de grupo o un firewall de terceros, trabaja con tu administrador de Windows para añadir una regla equivalente.

Protección antivirus y de puntos finales

Añada exclusiones para el binario del cliente de Relay y sus directorios de datos para evitar interferencias.

TipoRuta
BinarioC:\Program Files\UiPathRelay\relay.exe
Datos y registrosC:\ProgramData\UiPathRelay\
Ejecutable de Java (solo ejecutor)La ruta completa de java.exe que utiliza el ejecutor
Bibliotecas de conectores (solo ejecutor)El directorio de dependencias

No añadas una exclusión de proceso para java.exe. Evita que Endpoint Protection inspeccione un proceso cuyo trabajo está cargando código de terceros y llegando a los sistemas internos, y se aplica un nombre de archivo simple a cada proceso Java en el host. Utiliza exclusiones de ruta y da cualquier exclusión de proceso como una ruta completa.

Si utilizas el control de aplicaciones como Control de aplicaciones de Windows Defender (WDAC) o AppLocker, ten en cuenta que onprem-executor.jar se reemplaza en cada actualización del cliente de Relay, por lo que una regla que permite un hash de archivo específico deja de coincidir después de cada actualización. Utilice reglas de ruta o editor y vuelva a aprobar el JAR como parte de su procedimiento de actualización.

Si utilizaste rutas personalizadas a través de --bin-dir, --data-dir o --logs-dir, excluye esas rutas en su lugar.

Windows Defender a través de PowerShell

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

Windows Defender a través de GUI

  1. Abre Seguridad de Windows > Protección antivirus y contra amenazas > Administrar configuración.
  2. En Exclusiones, selecciona Añadir o eliminar exclusiones.
  3. Añadir exclusiones de carpetas: C:\Program Files\UiPathRelay\ y C:\ProgramData\UiPathRelay\.
  4. Añadir exclusión de proceso: relay.exe.

Para la protección de puntos finales gestionada de forma centralizada (CrowdStrike, Symantec, Microsoft Defender para puntos finales a través de Intune/SCCM), trabaja con tu administrador de seguridad para añadir las exclusiones anteriores.

Desinstalar

  1. Elimine todos los clientes de Relay (use .\relay.exe list para ver los grupos instalados):

    .\relay.exe delete <id>
    .\relay.exe delete <id>
    
  2. Eliminar el binario compartido:

    Remove-Item "C:\Program Files\UiPathRelay" -Recurse
    Remove-Item "C:\Program Files\UiPathRelay" -Recurse
    
  3. Eliminar los directorios de datos restantes:

    Remove-Item "C:\ProgramData\UiPathRelay" -Recurse
    Remove-Item "C:\ProgramData\UiPathRelay" -Recurse
    
  4. Eliminar las exclusiones de Windows Defender:

    Remove-MpPreference -ExclusionPath "C:\Program Files\UiPathRelay"
    Remove-MpPreference -ExclusionPath "C:\ProgramData\UiPathRelay"
    Remove-MpPreference -ExclusionProcess "relay.exe"
    Remove-MpPreference -ExclusionPath "C:\Program Files\UiPathRelay"
    Remove-MpPreference -ExclusionPath "C:\ProgramData\UiPathRelay"
    Remove-MpPreference -ExclusionProcess "relay.exe"
    
  5. Elimina la regla del Firewall de Windows:

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

Para las reglas añadidas a través de la Política de grupo o un firewall de terceros, trabaja con tu administrador de Windows para eliminarlas.

Solución de problemas

SíntomaCausaResolución
El servicio no se iniciaPermisos insuficientesAbrir PowerShell como administrador
permission deniedNo se puede escribir en Archivos de programa o DatosDeProgramaVerifique el acceso de administrador o utilice --bin-dir / --data-dir para las rutas de escritura
does not have the 'Log on as a service' rightFalta la cuenta personalizada SeServiceLogonRightConceder a través de Política de seguridad local > Asignación de derechos de usuario, o utilizar Política de grupo
not a valid Windows accountFormato incorrecto para --service-accountUtilice .\username para cuentas locales o DOMAIN\username para cuentas de dominio
marked for deletion / servicio pendiente de eliminaciónservices.msc tiene un manipulador abiertoservices.msc y vuelve a intentarlo; reiniciar si el problema persiste
service is disabledDeshabilitado a través de services.msc o política de grupoVolver a habilitar: Set-Service -Name "Relay-<id>" -StartupType Automatic
file is locked by another processBinario en uso durante la actualizaciónDetenga primero el servicio de cliente de Relay y luego vuelva a intentarlo
path exceeds Windows path length limitLa ruta de datos/registros supera los 260 caracteresUtilice rutas más cortas para --data-dir y --logs-dir
Bloqueo de antivirus relay.exeBinario en cuarentena de Endpoint ProtectionAñade exclusiones (consulta Protección antivirus y de puntos finales); comprobar la cuarentena y restaurar
Servicio en ejecución pero túnel no establecidoProblema de red o autenticaciónCompruebe relay.log para ver si hay login to server errores; verificar la conectividad a cloud.uipath.com; para versiones de cliente de Relay anteriores a 26.4.2, verifique el paso de TLS al nombre de host de Relay regional
DPAPI decrypt failedLa identidad de la máquina ha cambiado después de clonar o volver a crear una imagen de la máquina virtualVuelva a aprovisionar el Relay con una nueva configuración de Administración de UiPath
Proxy no utilizado por el servicioProxy establecido a nivel de usuario, no a nivel de sistemaEstablece HTTPS_PROXY en el nivel de máquina (consulta Configuración de proxy); reiniciar el servicio

Comandos de diagnóstico

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

Para errores de autenticación y conectividad compartidos entre plataformas, consulta Resolución de problemas.

Referencia rápida

AcciónComando
Iniciar.\relay.exe start --config-file config.txt --accept-license-agreement
Detener.\relay.exe stop <id>
Reiniciar/actualizar.\relay.exe restart <id>
Eliminar.\relay.exe delete <id>
Eliminar (forzar).\relay.exe delete <id> --force
Lista.\relay.exe list
Describir.\relay.exe describe <id>
Registros.\relay.exe logs <id> -f
Estado del servicioGet-Service "Relay-<id>"
Consola de serviciosservices.msc

¿Te ha resultado útil esta página?

Conectar

¿Necesita ayuda? Soporte

¿Quiere aprender? UiPath Academy

¿Tiene alguna pregunta? Foro de UiPath

Manténgase actualizado