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.

Esta página abrange detalhes de configuração de produção específicos do Windows. Para pré-requisitos multiplataforma e requisitos de rede, consulte Implantando o cliente de Relay.

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 em todas as versões do Windows compatíveis. Não é necessário nenhum software adicional.

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ário para interagir com o SCM para instalação, início, interrupção e exclusão do serviço; 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
  • Se você usar uma conexão baseada em TCP compatível que requer o executor no local:

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
  • O host de relay pode resolver e conectar-se a todos os pontos de extremidade HTTP ou HTTPS registrados, e ao host e à porta de cada ponto de extremidade baseado em TCP compatível

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 antivírus planejadas (consulte Proteção de antivírus e ponto de extremidade)
  • Se você usar o executor local: um diretório de dependências de conector e um tempo de execução Java, ambos em locais que somente os administradores podem modificar, como C:\Program Files em. O executor carrega código de ambos

Configuração

Validar pré-requisitos

Execute os seguintes comandos no 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. Baixe e extraia

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

Extraia o arquivo zip. A partir do cliente de Relay 26.4.3, ele contém relay.exe e onprem-executor.jar. Deixe os dois arquivos juntos no diretório extraído e execute os comandos de instalação ou atualização desse diretório.

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 (gerada na UiPath Administration, conforme descrito em Configuração de um grupo de Relay) de duas maneiras:

Opção A: embutida. 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. Essa é a opção recomendada porque 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

Para uma conexão baseada em TCP compatível que requer o executor no local, prepare as bibliotecas de conector primeiro, conforme descrito em Adicionar dependências do conector, depois inicie o cliente com um único comando.

Adicionar dependências do conector

Alguns conectores exigem bibliotecas de terceiros que não estão incluídas no cliente de Relay. Obtenha-os no fornecedor do conector e coloque-os todos em um diretório dedicado no host do Relay. O cliente de Relay armazena o caminho do diretório, mas não copia as bibliotecas. Um diretório sob C:\Program Files, como C:\Program Files\UiPathRelay\executor-deps, é gravável apenas por administradores por padrão.

Importante:

O executor local carrega e executa essas bibliotecas com as permissões da conta de serviço do Relay. Use um diretório estável que a conta de serviço possa ler e que seja gravável apenas por administradores. Qualquer pessoa que possa modificar seu conteúdo pode executar código com essas permissões.

Para SAP BAPI, obtenha as bibliotecas SAP JCo 3 do SAP e coloque esses arquivos no diretório de dependência:

Arquivo necessárioFinalidade
sapjco3.jarBiblioteca Java SAP JCo
sapidoc3.jarBiblioteca Java SAP IDoc
sapjco3.dllBiblioteca nativa SAP JCo Windows correspondente à arquitetura de runtime Java

Para outro conector compatível, coloque as bibliotecas do fornecedor listadas na documentação desse conector no mesmo diretório.

Comece com o Executor no local

Crie o diretório de dependências, copie as bibliotecas para ele e inicie o cliente de Relay com o executor habilitado. Aponte --onprem-executor-java-home para um runtime Java 21 ou posterior instalado C:\Program Files em, para que o executor use o runtime que você pretende:

.\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 com o OAuth, registra-se no Test Cloud, baixa a configuração do 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

Se o executor no local estiver habilitado, confirme sua configuração:

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

A seção Executor no local relata Enabled: true com a porta de escuta, versão de runtime, caminho de runtime, página inicial do Java e diretório de dependências que está usando. Verifique se o início do Java e o diretório de dependências são aqueles que você pretende.

Em seguida, confirme se o executor foi iniciado. Seu log contém uma entrada Started OnPremRuntimeApplication assim que estiver pronto:

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

Se você configurou um diretório de log personalizado, use seu caminho onprem-executor.log em vez disso. Em seguida, execute uma chamada de teste do conector que usa esse ponto de extremidade para confirmar que o caminho completo funciona.

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 mais tarde.

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

Atualizar: extraia o novo arquivo do cliente de Relay. Mantenha o novo relay.exe e o correspondente onprem-executor.jar juntos e, em seguida, execute .\relay.exe restart <id> a partir do diretório extraído. O comando de reinício atualiza o binário instalado e, quando o Executor é habilitado, seu JAR.

Para habilitar o executor em um serviço que já está instalado, execute .\relay.exe restart <id> --enable-onprem-executor a partir do diretório do arquivo extraído, para que o onprem-executor.jar correspondente fique disponível.

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
Habilitar o Executor no local.\relay.exe restart <id> --enable-onprem-executor
Desabilitar o Executor no local.\relay.exe restart <id> --disable-onprem-executor
Atualização do cliente de RelayExtraia o novo arquivo e, em seguida, execute .\relay.exe restart <id>
Observação:

Quando --config ou --config-file é fornecido, o <id> argumento é 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:

Não há atualização automática. Extraia o novo arquivo e execute .\relay.exe restart <id> a partir de seu diretório para cada grupo.

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
Diretório de dependências (apenas o executor)Ler e ampliar; Executar e não gravável por usuários sem privilégios. Herdado de C:\Program Files por padrão
Instalação Java (apenas executor)Ler e ampliar; Executar e não gravável por usuários sem privilégios
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

Esses comandos adicionam a conta de serviço às permissões já em cada caminho. Elas não removem permissões que outras contas podem ter. Se o diretório de dependências estiver fora de C:\Program Files, conceda também à conta Read & amp; Execute lá e remova o acesso de gravação para não administradores.

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 é necessário para contas de usuário de domínio ou local. O PowerShell registra a linha de comando em seu arquivo de histórico, e a senha fica visível na linha de comando do processo enquanto o comando é executado; portanto, prefira uma Conta de Serviço Gerenciado de Grupo (gMSA), que não requer senha.

Quando o executor local estiver habilitado, execute o serviço em uma conta dedicada em vez LocalSystem de. O executor carrega bibliotecas de conectores de terceiros com os privilégios da conta de serviço, e LocalSystem é a conta local com maior privilégio.

Para essa conta:

  • Conceda apenas as permissões em Permissões do NTFS, mais o direito de fazer logon como um serviço.
  • Não a adicione ao grupo Administradores.
  • Aplique novamente essas permissões, incluindo o diretório de dependências e a instalação do Java, se você alterar a conta posteriormente.

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. Abra o menu de contexto para iniciar, parar, reiniciar ou visualizar as propriedades.
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. Verificar permissões da conta
7009Tempo esgotado para aguardar o serviço. Verifique a conectividade de rede
7031Serviço falhou e ação de recuperação foi realizada. Marcar relay.log
7034O serviço foi encerrado de forma inesperada. Verificar a esgotamento do recurso
7045Novo serviço instalado (confirma 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 as variáveis de ambiente de nível de 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.

Se o executor local estiver habilitado e as regras do programa de saída forem aplicadas, permita também que o executável Java usado pelo executor se conecte ao host de destino e à porta de cada conexão baseada em TCP compatível. Em vez de permitir todo o tráfego de saída, restrinja a regra a esses destinos.

Nenhuma regra de entrada é necessária. O executor ouve apenas na interface de loopback, na porta 18080 por padrão, e não aceita conexões de fora do host. Não abra essa porta. Para confirmar que o ouvinte está associado ao loopback, execute Get-NetTCPConnection -LocalPort 18080 -State Listen e verifique se LocalAddress é 127.0.0.1 ou ::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\
Execuável Java (apenas executor)O caminho completo de java.exe que o executor usa
Bibliotecas de conector (apenas executor)O diretório de dependências

Não adicione uma exclusão de processo para java.exe. Ela impede que a proteção do ponto de extremidade inspecione um processo cujo trabalho é carregar código de terceiros e alcançar sistemas internos, e um nome de arquivo simples se aplica a todos os processos Java no host. Use exclusões de caminho e forneça qualquer exclusão de processo como um caminho completo.

Se você usar o controle de aplicativos, como o Controle de Aplicativos do Windows Juster (WDAC) ou AppLocker, observe que onprem-executor.jar é substituído em cada atualização de cliente de Relay; portanto, uma regra que permite um hash de arquivo específico deixa de corresponder após cada atualização. Use as regras de caminho ou de editor e aprove novamente o JAR como parte do procedimento de atualização.

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

Windows Explorer via 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 Explorer 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