UiPath Documentation
test-cloud
latest
false
Guia do administrador do Test Cloud
Importante :
A localização de um conteúdo recém-publicado pode levar de 1 a 2 semanas para ficar disponível.

Implantando o cliente de Relay no Windows

Implante o cliente de Relay como um serviço do Windows para estabelecer um túnel de saída entre sua rede e o Test Cloud.

This page covers production setup details specific to Windows. For cross-platform prerequisites and network requirements, see Deploying the Relay client.

Requisitos do sistema operacional

O cliente de Relay usa o Gerenciador de Controle de Serviço (SCM) do Windows para instalar e gerenciar seu serviço em segundo plano. O SCM é integrado a todas as versões do Windows compatíveis — nenhum software adicional é necessário.

EdiçãoVersão mínima
Windows Server2019
Área de Trabalho do Windows10 Enterprise

Requisitos adicionais

  • PowerShell 5.1+ — incluído por padrão; usado para gerenciamento de serviços (Get-Service, Test-NetConnection). Verificar: $PSVersionTable.PSVersion.
  • Privilégios de administrador — necessários para interagir com o SCM para instalação, início, interrupção e exclusão de serviços; gravar em C:\ProgramData\UiPathRelay\; copie o binário para C:\Program Files\UiPathRelay\.

Por padrão, o serviço é executado como LocalSystem. Para executar em uma conta específica, use --service-account no horário de início — consulte Conta de serviço e permissões.

Pré-requisitos

System

  • Windows Server 2019+ ou Windows 10 Enterprise+
  • PowerShell 5.1 ou posterior
  • Acesso de administrador à máquina de destino
  • Espaço mínimo em disco de 200 MB
  • If you use a supported TCP-based connection that requires the on-prem executor:

Rede

  • Para o cliente de Relay 26.4.2 ou posterior, o HTTPS de saída (porta 443) para cloud.uipath.com é permitido, incluindo atualizações do WebSocket
  • Para versões do cliente de Relay anteriores a 26.4.2, a saída TLS (porta 443) para <region>-relay.uipath.com é permitida e a passagem do TLS está configurada
  • Relay host can resolve and connect to every registered HTTP or HTTPS endpoint, and to the host and port of each supported TCP-based endpoint

Segurança

  • Conta de serviço criada (se não estiver usando LocalSystem) — consulte Conta de serviço e permissões
  • Exclusões do Windows SharePoint e de antivírus planejadas — consulte Proteção de antivírus e ponto de extremidade
  • If you use the on-prem executor: a connector dependencies directory and a Java runtime, both in locations only administrators can modify, such as under C:\Program Files. The executor loads code from both

Configuração

Validate prerequisites

Run the following commands in 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

# Check Java version (must be 21+), only when using the on-prem executor
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

# Check Java version (must be 21+), only when using the on-prem executor
java -version

Instalar

1. Baixe e extraia

Baixe o arquivo do cliente de Relay para sua arquitetura (x86_64 ou ARM64) do UiPath Customer Portal.

Extract the zip archive. Starting with Relay client 26.4.3, it contains relay.exe and onprem-executor.jar. Leave both files together in the extracted directory, and run installation or upgrade commands from that directory.

2. Iniciar

Abra o PowerShell como administrador antes de executar qualquer comando de início.

Você pode fornecer a string de configuração do cliente (da Administração do UiPath — consulte Configuração de um grupo de Relay) de duas maneiras:

Opção A — Em linha. Passe a string de configuração diretamente. Nenhum arquivo para criar ou limpar:

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

Opção B — Arquivo. Salve a configuração em um arquivo e, depois, faça referência a ela. Recomendado — mantém o segredo fora do histórico do 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

For a supported TCP-based connection that requires the on-prem executor, stage the connector libraries first, as described in Add connector dependencies, then start the client with a single command.

Add connector dependencies

Some connectors require third-party libraries that are not included with the Relay client. Obtain them from the connector vendor and place them all in a dedicated directory on the Relay host. The Relay client stores the directory path but does not copy the libraries. A directory under C:\Program Files, such as C:\Program Files\UiPathRelay\executor-deps, is writable only by administrators by default.

Importante:

The on-prem executor loads and executes these libraries with the permissions of the Relay service account. Use a durable directory that the service account can read and that is writable only by administrators. Anyone who can modify its contents can run code with those permissions.

For SAP BAPI, obtain the SAP JCo 3 libraries from SAP and place these files in the dependency directory:

Required fileFinalidade
sapjco3.jarSAP JCo Java library
sapidoc3.jarSAP IDoc Java library
sapjco3.dllSAP JCo Windows native library matching the Java runtime architecture

For another supported connector, place the vendor libraries listed in that connector's documentation in the same directory.

Start with the on-prem executor

Create the dependency directory, copy the libraries into it, and start the Relay client with the executor enabled. Point --onprem-executor-java-home at a Java 21 or later runtime installed under C:\Program Files, so the executor uses the runtime you intend:

.\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"
Observação:

Os sinalizadores --config e --config-file são mutuamente exclusivos. Para executar em primeiro plano em vez de como um serviço em segundo plano (útil para depuração), passe --detach=false.

O cliente de Relay valida a conectividade, autentica-se com o OAuth, registra-se no Test Cloud, baixa a configuração de proxy e instala um serviço do Windows, tudo em um único comando.

Saída 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>")
Observação:

Durante a inicialização, o cliente de Relay copia automaticamente o binário C:\Program Files\UiPathRelay\relay.exe. Todos os grupos de Relay na máquina compartilham esse binário único. Substitua o diretório de instalação por --bin-dir.

Para iniciar em uma conta de serviço personalizada em vez 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

Um cliente íntegro mostra ● running na coluna Status. O valor ID mostrado é usado em todos os comandos subsequentes (.\relay.exe stop <id>, .\relay.exe logs <id>, e assim por diante). Você também pode encontrá-lo na UiPath Administration na página de detalhes do grupo de Relay.

Confirme que o túnel foi estabelecido verificando os logs para login to server success:

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

If the on-prem executor is enabled, confirm its configuration:

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

The On-Prem Executor section reports Enabled: true with the listen port, runtime version, runtime path, Java home, and dependencies directory it is using. Check that the Java home and dependencies directory are the ones you intended.

Then confirm that the executor started. Its log contains a Started OnPremRuntimeApplication entry once it is ready:

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

If you configured a custom log directory, use its onprem-executor.log path instead. Then run a test call from the connector that uses this endpoint, to confirm the full path works.

Gerenciar

Todos os comandos de gerenciamento exigem o Administrator PowerShell, exceto list e version.

List

Mostra todos os grupos de relay instalados nesta máquina com status, versão e nome do grupo, quando disponível. Não requer privilégios de Administrator.

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

Descrever

Observação:

Disponível com o cliente de Relay 26.4.2 e posterior. Execute .\relay.exe version para verificar sua versão instalada.

Mostra informações detalhadas para um grupo de Relay, incluindo configurações de serviço, caminhos configurados, status, versão e nome do grupo quando disponível. Não requer privilégios de Administrator.

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

Parar

Interrompe o Serviço de Relay. A configuração e os logs são retidos — o relay pode ser reiniciado posteriormente.

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

Reiniciar e atualizar

Reinicia o serviço de Relay e busca a configuração de proxy mais recente do Test Cloud.

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

Upgrade: extract the new Relay client archive. Keep the new relay.exe and matching onprem-executor.jar together, then run .\relay.exe restart <id> from the extracted directory. The restart command updates the installed binary and, when the executor is enabled, its JAR.

To enable the executor on a service that is already installed, run .\relay.exe restart <id> --enable-onprem-executor from the extracted archive directory, so the matching onprem-executor.jar is available.

CenárioCommand
Pontos de extremidade adicionados ou removidos no Test Cloud.\relay.exe restart <id>
Rotação de segredo do cliente — em linha.\relay.exe restart --config "<new-config>"
Rotação de segredo do cliente — arquivo.\relay.exe restart --config-file new-config.txt
Alteração do nível de registro.\relay.exe restart <id> --log-level debug
Diretório de logs ou alteração de retenção.\relay.exe restart <id> --logs-dir "D:\MyCompany" --log-retention-days 30
Enable the on-prem executor.\relay.exe restart <id> --enable-onprem-executor
Disable the on-prem executor.\relay.exe restart <id> --disable-onprem-executor
Relay client upgradeExtract the new archive, then run .\relay.exe restart <id>
Observação:

Quando ou --config é fornecido, <id> --config-file opcional — ele é extraído da configuração.

Excluir

Interrompe o serviço, cancela o registro do Test Cloud e remove todas as configurações locais e arquivos de log.

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

Para forçar a limpeza local sem o cancelamento do registro da nuvem — por exemplo, se as credenciais forem perdidas ou o grupo de relay do lado da nuvem já tiver sido excluído:

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

Versão

.\relay.exe version
.\relay.exe version
Observação:

There is no auto-upgrade. Extract the new archive and run .\relay.exe restart <id> from its directory for each group.

Estrutura de diretório

Todos os diretórios são criados automaticamente na primeira execução.

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

O nome de serviço do Windows é Relay-<id> e o nome de exibição (exibido em services.msc) é Relay - <id>. O tipo de inicialização é Automático; a conta padrão é LocalSystem.

Caminhos personalizados

Substitua os diretórios padrão ao instalar o 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"
BandeiraPadrãoDescription
--bin-dirC:\Program Files\UiPathRelayDiretório para o binário compartilhado
--data-dirC:\ProgramDataRaiz dos dados de configuração
--logs-dirC:\ProgramDataRaiz para arquivos de log; pode ser alterado com restart

O cliente de Relay anexa UiPathRelay\ sob os dados personalizados e raiz de log:

--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>\
Observação:

--bin-dir e --data-dir são aceitos apenas pelo comando start . --logs-dir é aceito por start e restart. Outros comandos (stop, delete, list) descobertas de caminhos automaticamente a partir da configuração de serviço instalada.

Conta de serviço e permissões

Esta seção se aplica apenas ao executar o serviço em uma conta personalizada em vez da padrão LocalSystem.

Direitos de usuário necessários

DireitaDescriptionComo configurar
SeServiceLogonRightFazer login como um serviçoPolítica de Segurança Local > Atribuição de Direitos do Usuário > Fazer logon como um serviço

Para ambientes de domínio, configure esse direito por meio da Política de Grupo para garantir a consistência entre os servidores.

Permissões do NTFS

PathPermissões necessárias
C:\Program Files\UiPathRelay\Ler e Executar
C:\ProgramData\UiPathRelay\Ler, Escrever, Modificar
C:\ProgramData\UiPathRelay\logs\Ler, Escrever, Modificar, Excluir
Dependencies directory (executor only)Read & Execute, and not writable by unprivileged users. Inherited from C:\Program Files by default
Java installation (executor only)Read & Execute, and not writable by unprivileged users
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
$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

These commands add the service account to the permissions already on each path. They do not remove permissions other accounts may have. If the dependencies directory is outside C:\Program Files, also grant the account Read & Execute there and remove write access for non-administrators.

Começando com uma conta de serviço 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 is required for domain or local user accounts. PowerShell records the command line in its history file, and the password is visible in the process command line while the command runs, so prefer a Group Managed Service Account (gMSA), which requires no password.

When the on-prem executor is enabled, run the service under a dedicated account rather than LocalSystem. The executor loads third-party connector libraries with the service account's privileges, and LocalSystem is the highest-privilege local account.

For that account:

  • Grant only the permissions in NTFS permissions, plus the right to log on as a service.
  • Do not add it to the Administrators group.
  • Re-apply those permissions, including the dependencies directory and the Java installation, if you change the account later.

Contas de serviço gerenciado por 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

Os gMSAs rotacionam senhas automaticamente e eliminam a sobrecarga de gerenciamento de credenciais.

Detalhes do Serviço do Windows

Visualização do status do serviço

Por meio do console de Serviços
  1. Abra Executar (Win + R) e digite services.msc.
  2. Localize o serviço com o nome de exibição Relay - <id>.
  3. Open the context menu to start, stop, restart, or view properties.
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
# 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

Recuperação de serviço

Quando o cliente de Relay se instala como um serviço, ele configura a recuperação automática:

  • Primeira falha: reiniciar após 10 segundos
  • Segunda falha: reiniciar após 30 segundos
  • Falhas subsequentes: reinicie com atrasos escalonados

Para revisar ou ajustar as configurações de recuperação: services.msc > clique com o botão direito do mouse no serviço > Propriedades > guia Recuperação .

Visualizador de eventos

Use o Visualizador de eventos (eventvwr.msc) para diagnosticar problemas de serviço.

RegistroPathEvents
SystemLogs do Windows > SistemaInício, interrupção, falha e recuperação do serviço (série 7000)
AplicativoLogs do Windows > AplicativoErros do aplicativo

Consultar eventos de relay por meio do 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 do EventoSignificado
7000Falha ao iniciar o serviço. Verifique as permissões da conta
7009Tempo limite aguardando serviço — verifique a conectividade de rede
7031Serviço falhou e ação de recuperação realizada — verificar relay.log
7034O serviço foi encerrado de forma inesperada — verifique se há esgotamento do recurso
7045Novo serviço instalado — confirma a instalação bem-sucedida

Proxy Configuration

Os serviços do Windows herdam variáveis de ambiente do sistema (HKLM). Defina variáveis de proxy no nível da máquina antes de iniciar o 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

Definir variáveis de proxy no nível do usuário não é suficiente — os serviços do sistema ignoram variáveis de ambiente no nível do usuário.

Para atualizar o proxy: altere a variável de nível do sistema e .\relay.exe restart <id>.

Para remover o proxy: [Environment]::SetEnvironmentVariable("HTTPS_PROXY", $null, "Machine"), em seguida, .\relay.exe restart <id>.

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

Para esquemas de proxy e autenticação compatíveis, consulte a seção proxy em Implantação do cliente de Relay.

Firewall do Windows

Se o tráfego de saída for restrito pelo Firewall do Windows, adicione uma regra de saída para o binário do cliente de Relay.

If the on-prem executor is enabled and outbound program rules are enforced, also allow the Java executable used by the executor to connect to the target host and port of each supported TCP-based connection. Scope the rule to those destinations rather than allowing all outbound traffic.

No inbound rule is required. The executor listens on the loopback interface only, on port 18080 by default, and accepts no connections from outside the host. Do not open that port. To confirm the listener is bound to loopback, run Get-NetTCPConnection -LocalPort 18080 -State Listen and check that LocalAddress is 127.0.0.1 or ::1.

ConfiguraçãoValor
DirectionPerdida
ProgramaC:\Program Files\UiPathRelay\relay.exe
Protocolo/PortaTCP/443
PerfisDomínio, Particular

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

Por meio da GUI (Firewall do Windows Firewall com Segurança Avançada):

  1. Abra wf.msc.
  2. Selecione Regras de saída > Nova regra.
  3. Escolha Programa e especifique: C:\Program Files\UiPathRelay\relay.exe.
  4. Selecione Permitir a conexão.
  5. Aplicar aos perfis Domínio e Privado .
  6. Nomeie a regra: UiPath Relay - Outbound HTTPS.

Se sua organização gerenciar regras de firewall por meio da Política de Grupo ou de um firewall de terceiros, trabalhe com seu administrador do Windows para adicionar uma regra equivalente.

Proteção de antivírus e ponto de extremidade

Adicione exclusões para o binário do cliente de Relay e seus diretórios de dados para evitar interferência.

TipoPath
BinárioC:\Program Files\UiPathRelay\relay.exe
Dados e logsC:\ProgramData\UiPathRelay\
Java executable (executor only)The full path of the java.exe the executor uses
Connector libraries (executor only)The dependencies directory

Do not add a process exclusion for java.exe. It stops endpoint protection from inspecting a process whose job is loading third-party code and reaching internal systems, and a bare file name applies to every Java process on the host. Use path exclusions, and give any process exclusion as a full path.

If you use application control such as Windows Defender Application Control (WDAC) or AppLocker, note that onprem-executor.jar is replaced on every Relay client upgrade, so a rule that allows a specific file hash stops matching after each upgrade. Use path or publisher rules, and re-approve the JAR as part of your upgrade procedure.

Se você usou caminhos personalizados por meio de --bin-dir, --data-dir ou --logs-dir, exclua esses caminhos em vez disso.

Windows Dever — por meio do 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 Dever — via GUI

  1. Abra Segurança do Windows > Proteção de email e ameaças > Gerenciar configurações.
  2. Em Exclusões, selecione Adicionar ou remover exclusões.
  3. Adicione as exclusões de pasta: C:\Program Files\UiPathRelay\ e C:\ProgramData\UiPathRelay\.
  4. Adicionar exclusão de processo: relay.exe.

Para proteção de ponto de extremidade gerenciada centralmente (CrowdStrike, Cyber Dindos, Orchestrator

Desinstalar

  1. Exclua todos os clientes do Relay (use .\relay.exe list para ver os grupos instalados):

    .\relay.exe delete <id>
    .\relay.exe delete <id>
    
  2. Remova o binário compartilhado:

    Remove-Item "C:\Program Files\UiPathRelay" -Recurse
    Remove-Item "C:\Program Files\UiPathRelay" -Recurse
    
  3. Remova os diretórios de dados restantes:

    Remove-Item "C:\ProgramData\UiPathRelay" -Recurse
    Remove-Item "C:\ProgramData\UiPathRelay" -Recurse
    
  4. Remova exclusões do Windows Developer:

    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. Remova a regra do Firewall do Windows:

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

Para regras adicionadas por meio da Política de Grupo ou de um firewall de terceiros, trabalhe com o administrador do Windows para removê-las.

Solução de problemas

ProblemaCausaResolution
Falha ao iniciar o serviçoPermissões insuficientesAbra o PowerShell como administrador
permission deniedNão é possível gravar em Arquivos de Programa ou DadosDeProgramaVerifique o acesso do Administrator ou use --bin-dir / --data-dir para caminhos graváveis
does not have the 'Log on as a service' rightConta personalizada ausente SeServiceLogonRightConceda por meio da Política de Segurança Local > Atribuição de Direitos do Usuário ou use a Política de Grupo
not a valid Windows accountFormato incorreto para --service-accountUse .\username para contas locais ou DOMAIN\username para contas de domínio
marked for deletion / serviço pendente de exclusãoservices.msc tem um identificador abertoservices.msc e tente novamente; reinicie se o problema persistir
service is disabledDesabilitado por meio de services.msc ou da Política de GrupoReabilitar: Set-Service -Name "Relay-<id>" -StartupType Automatic
file is locked by another processBinário em uso durante a atualizaçãoInterrompa o serviço do cliente de Relay primeiro e depois tente novamente
path exceeds Windows path length limitO caminho de dados/logs excede 260 caracteresUse caminhos mais curtos para --data-dir e --logs-dir
Bloqueio de antivírus relay.exeBinário em quarentena da proteção do endpointadicionar exclusões (consulte Proteção de antivírus e ponto de extremidade); verificar quarentena e restaurar
Serviço em execução, mas túnel não estabelecidoProblema de rede ou autenticaçãoVerifique se login to server relay.log ; verificar a conectividade com cloud.uipath.com; para versões do cliente do Relay anteriores à 26.4.2, verifique a passagem do TLS para o nome do host do relay regional
DPAPI decrypt failedIdentidade da máquina alterada após clonagem ou nova imagem da VMReprovisione o relay com uma nova configuração da administração do UiPath
Proxy não usado pelo serviçoProxy definido no nível do usuário, não no nível do sistemaDefina HTTPS_PROXY no nível da máquina (consulte Configuração do proxy); reinicie o serviço

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 erros de autenticação e conectividade compartilhados entre plataformas, consulte Solução de problemas.

Referência rápida

AçãoCommand
Iniciar.\relay.exe start --config-file config.txt --accept-license-agreement
Parar.\relay.exe stop <id>
Reiniciar/atualizar.\relay.exe restart <id>
Excluir.\relay.exe delete <id>
Excluir (forçar).\relay.exe delete <id> --force
List.\relay.exe list
Descrever.\relay.exe describe <id>
Logs.\relay.exe logs <id> -f
Status do serviçoGet-Service "Relay-<id>"
Console de serviçosservices.msc

Esta página foi útil?

Conectar

Precisa de ajuda? Suporte

Quer aprender? Academia UiPath

Tem perguntas? Fórum do UiPath

Fique por dentro das novidades