UiPath Documentation
test-cloud
latest
false
Test Cloud 管理ガイド
重要 :
このコンテンツの一部は機械翻訳によって処理されており、完全な翻訳を保証するものではありません。 新しいコンテンツの翻訳は、およそ 1 ~ 2 週間で公開されます。

Windows への Relay クライアントの導入

Relay クライアントを Windows サービスとしてデプロイし、ネットワークと Test Cloud 間の送信トンネルを確立します。

このページでは、Windows に固有の運用設定について説明します。クロスプラットフォームの前提条件とネットワーク要件については、「 Relay クライアントをデプロイする」をご覧ください。

オペレーティング システムの要件​

Relay クライアントは、 Windows サービス コントロール マネージャー (SCM) を使用してバックグラウンド サービスをインストールおよび管理します。SCM は、サポートされているすべての Windows バージョンに組み込まれています。追加のソフトウェアは必要ありません。

Edition最小バージョン
Windows Server2019 年
Windows デスクトップ10 エンタープライズ

追加要件​

  • PowerShell 5.1+: 既定で含まれています。サービス管理に使用されます (Get-Service、 Test-NetConnection)。検証: $PSVersionTable.PSVersion。
  • 管理者権限: SCM と対話してサービスのインストール、開始、停止、削除を行うために必要です。 C:\ProgramData\UiPathRelay\に書き込み 。バイナリを C:\Program Files\UiPathRelay\にコピーします。

既定では、サービスは LocalSystemとして実行されます。特定のアカウントで実行するには、開始時に --service-account を使用します。詳しくは、「 サービス アカウントと権限」をご覧ください。

前提条件​

システム​

  • Windows Server 2019+ または Windows 10 Enterprise+
  • PowerShell 5.1 以降
  • ターゲット マシンへの管理者アクセス
  • 最小 200 MB の空きディスク領域
  • オンプレミスの Executor を必要とする、サポートされている TCP ベースの接続を使用する場合、以下を実行します。

ネットワーク​

  • Relay クライアント 26.4.2 以降では、 cloud.uipath.com への送信 HTTPS (ポート 443) が許可されます。これには WebSocket のアップグレードも含まれます
  • 26.4.2より前のリレー クライアント バージョンでは、<region>-relay.uipath.com への送信 TLS (ポート 443) が許可され、TLS パススルーが構成されます
  • Relay ホストは、登録されているすべての HTTP または HTTPS エンドポイント、およびサポートされている各 TCP ベースのエンドポイントのホストとポートを解決して接続できます

セキュリティ​

  • サービス アカウントの作成時 ( LocalSystemを使用していない場合) ( 「サービス アカウントと権限」をご覧ください)。
  • Windows Defender とウイルス対策の除外が計画されています (「 ウイルス対策とエンドポイント保護」を参照)
  • オンプレミスの Executor を使用する場合: コネクタの依存関係ディレクトリと Java ランタイム。どちらも管理者のみが変更できる場所にあります (例: C:\Program Filesの )。Executor は、両方からコードを読み込みます

構成​

前提条件を検証する​

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

インストール​

1. ダウンロードして抽出する​

UiPath Customer Portal から、使用しているアーキテクチャ (x86_64 または ARM64) 向けの Relay クライアント アーカイブをダウンロードします。

zip アーカイブを展開します。Relay クライアント 26.4.3以降では、 relay.exe と onprem-executor.jarが含まれます。両方のファイルを一緒に展開されたディレクトリに残し、そのディレクトリからインストール コマンドまたはアップグレード コマンドを実行します。

2. 開始​

開始コマンドを実行する前に、 管理者として PowerShell を開きます。

クライアント設定文字列 ( UiPath Administration で生成。「Relay グループを設定する」の説明を参照) は次の 2 つの方法で指定できます。

オプション A: インライン。構成文字列を直接渡します。作成またはクリーンアップするファイルがない:

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

オプション B: ファイル。構成をファイルに保存してから参照します。これは、シェル履歴にシークレットが記載されないようにするため、推奨されるオプションです。

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

オンプレミスの Executor を必要とするサポート対象の TCP ベースの接続の場合は、「 コネクタ依存関係を追加する」の説明に従い、最初にコネクタ ライブラリをステージングしてから、単一のコマンドでクライアントを起動します。

コネクタの依存関係を追加する​

一部のコネクタでは、Relay クライアントに含まれていないサードパーティ ライブラリが必要です。コネクタ ベンダーから入手し、Relay ホストの専用ディレクトリにすべて配置します。Relay クライアントはディレクトリ パスを格納しますが、ライブラリはコピーしません。C:\Program Files\UiPathRelay\executor-depsなどの C:\Program Filesの下にあるディレクトリは、既定では管理者のみが書き込み可能です。

重要:

オンプレミスの Executor は、Relay サービス アカウントの権限でこれらのライブラリを読み込んで実行します。サービス アカウントが読み取ることができ、管理者のみが書き込み可能な永続ディレクトリを使用します。その内容を変更できる人は誰でも、これらのアクセス許可でコードを実行できます。

SAP BAPI の場合は、SAP から SAP JCo 3 ライブラリを取得し、次のファイルを依存関係ディレクトリに配置します。

必要なファイル目的
sapjco3.jarSAP JCo Java ライブラリ
sapidoc3.jarSAP IDoc Java ライブラリ
sapjco3.dllJava ランタイムアーキテクチャに適合する SAP JCo Windows ネイティブライブラリ

サポートされている別のコネクタの場合は、そのコネクタのドキュメントに記載されているベンダー ライブラリを同じディレクトリに配置します。

オンプレミスの Executor から始めます​

依存関係ディレクトリを作成し、そこにライブラリをコピーして、Executor を有効化した状態で Relay クライアントを起動します。C:\Program Filesでインストールされた Java 21 以降のランタイムを--onprem-executor-java-home指定し、Executor が目的のランタイムを使用するようにします。

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

--config フラグと --config-file フラグは相互に排他的です。バックグラウンド サービスとしてではなくフォアグラウンドで実行する (デバッグに便利) には、 --detach=falseを渡します。

Relay クライアントは、接続の検証、OAuth による認証、Test Cloud への登録、プロキシ構成のダウンロード、Windows サービスのインストールのすべてを 1 つのコマンドで行います。

期待される出力:

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

起動時に、Relayクライアントはバイナリを自動的に C:\Program Files\UiPathRelay\relay.exeにコピーします。マシン上のすべてのリレー グループは、この 1 つのバイナリを共有します。インストール ディレクトリを --bin-dirで上書きします。

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. 確認する​

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

正常なクライアントでは、STATUS 列に ● running が表示されます。表示される ID 値は、後続のすべてのコマンド (.\relay.exe stop <id>、 .\relay.exe logs <id>など) で使用されます。また、UiPath Administration の [リレー グループの詳細] ページにもアクセスできます。

ログで次の login to server successを確認して、トンネルが確立されていることを確認します。

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

オンプレミス Executor が有効化されている場合は、その構成を確認します。

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

[ オンプレミス実行 者] セクションでは、リッスン ポート、ランタイム バージョン、ランタイム パス、Java ホーム、および使用している依存関係ディレクトリとともに Enabled: true が報告されます。Java のホーム ディレクトリと依存関係ディレクトリが意図したディレクトリであることを確認します。

次に、Executor が起動したことを確認します。そのログには、準備ができると Started OnPremRuntimeApplication エントリが含まれます。

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

カスタム ログ ディレクトリを構成した場合は、代わりにその onprem-executor.log パスを使用します。次に、このエンドポイントを使用するコネクタからテスト呼び出しを実行して、フル パスが機能することを確認します。

管理​

list と versionを除き、すべての管理コマンドに管理者 PowerShell が必要です。

リスト (List)​

このマシンにインストールされているすべてのリレー グループを、ステータス、バージョン、およびグループ名とともに表示します (使用可能な場合)。管理者権限は不要です。

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

説明を入力​

注:

Relay クライアント 26.4.2 以降で使用できます。.\relay.exe versionを実行して、インストールされているバージョンを確認します。

サービス設定、設定済みパス、ステータス、バージョン、グループ名(使用可能な場合)など、1 つのリレーグループの詳細情報が表示されます。管理者権限は不要です。

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

停止​

リレー サービスを停止します。構成とログは保持されます。リレーは後で再起動できます。

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

再起動してアップグレードする​

Relay サービスを再起動し、Test Cloud から最新のプロキシ構成を取得します。

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

アップグレード: 新しい Relay クライアント アーカイブを展開します。新しい relay.exe と一致する onprem-executor.jar を一緒に保持してから、抽出されたディレクトリから .\relay.exe restart <id> を実行します。restart コマンドは、インストールされたバイナリを更新し、Executor が有効になっている場合はその JAR を更新します。

すでにインストールされているサービスで Executor を有効化するには、展開されたアーカイブ ディレクトリから .\relay.exe restart <id> --enable-onprem-executor を実行して、一致する onprem-executor.jar が利用可能になるようにします。

シナリオコマンド
Test Cloud でのエンドポイントの追加または削除.\relay.exe restart <id>
クライアント シークレットのローテーション (インライン).\relay.exe restart --config "<new-config>"
クライアント シークレットのローテーション (ファイル).\relay.exe restart --config-file new-config.txt
ログ レベルの変更.\relay.exe restart <id> --log-level debug
ログ ディレクトリまたは保持期間の変更.\relay.exe restart <id> --logs-dir "D:\MyCompany" --log-retention-days 30
オンプレミスの Executor を有効化する.\relay.exe restart <id> --enable-onprem-executor
オンプレミスの Executor を無効化する.\relay.exe restart <id> --disable-onprem-executor
Relay クライアントのアップグレード新しいアーカイブを展開してから、 .\relay.exe restart <id>
注:

--configまたは --config-file を指定する場合、<id>引数は任意です。構成から抽出されます。

削除する​

サービスを停止して Test Cloud から登録を解除し、ローカルの設定ファイルとログ ファイルをすべて削除します。

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

クラウドで登録を解除せずにローカル クリーンアップを強制するには (たとえば、資格情報を失った場合や、クラウド側のリレー グループがすでに削除されている場合):

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

バージョン​

.\relay.exe version
.\relay.exe version
注:

自動アップグレードはありません。新しいアーカイブを抽出し、各グループに対してそのディレクトリから .\relay.exe restart <id> を実行します。

ディレクトリ構造​

すべてのディレクトリは、最初の実行時に自動的に作成されます。

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

Windows サービス名は Relay-<id> で、表示名 ( services.mscで表示) は Relay - <id>です。スタートアップの種類は自動です。既定のアカウントは LocalSystemです。

カスタム パス​

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"
フラグ既定 (Default)説明
--bin-dirC:\Program Files\UiPathRelay共有バイナリのディレクトリ
--data-dirC:\ProgramData構成データのルート
--logs-dirC:\ProgramDataログ ファイルのルート。で変更できます restart

リレークライアントは、カスタムデータルートとログルートの下に UiPathRelay\ を追加します。

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

--bin-dir と --data-dir は、 start コマンドでのみ受け付けられます。--logs-dir は start および restartによって受け入れられます。その他のコマンド (stop、 delete、 list) は、インストールされているサービス構成から自動的にパスを検出します。

サービス アカウントと権限​

このセクションは、既定のLocalSystemではなくカスタム アカウントでサービスを実行する場合にのみ適用されます。

必要なユーザー権限​

右説明設定方法
SeServiceLogonRightサービスとしてログオンするローカル セキュリティ ポリシー > ユーザー権利の割り当て > サービスとしてログオン

ドメイン環境の場合は、グループ ポリシーを使用してこの権限を設定し、サーバー間の一貫性を確保します。

NTFS アクセス許可​

パス必要なアクセス許可
C:\Program Files\UiPathRelay\読み取り&実行
C:\ProgramData\UiPathRelay\読み取り、書き込み、変更
C:\ProgramData\UiPathRelay\logs\読み取り、書き込み、変更、削除
依存関係ディレクトリ (Executor のみ)読み取り および実行です。権限のないユーザーは書き込みできません。既定で C:\Program Files から継承されます。
Java のインストール (Executor のみ)読み取り & 実行、権限のないユーザーは書き込み不可
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

これらのコマンドは、各パスに既に存在する権限にサービス アカウントを追加します。他のアカウントが持つ可能性のある権限は削除されません。依存関係ディレクトリが C:\Program Filesの外部にある場合は、そのアカウントに [読み取り/実行] 権限も付与し、管理者以外のユーザーの書き込みアクセス権を削除します。

カスタム サービス アカウントから開始する​

.\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が必要です。PowerShell はコマンド ラインを履歴ファイルに記録し、パスワードはコマンドの実行中にプロセスのコマンド ラインに表示されるため、パスワードを必要としないグループ管理サービス アカウント (gMSA) を優先します。

オンプレミスの Executor が有効化されている場合は、 LocalSystemではなく専用のアカウントでサービスを実行します。Executor はサービス アカウントの特権でサードパーティのコネクタ ライブラリを読み込み、 LocalSystem が最も高い特権を持つローカル アカウントです。

そのアカウントに対して:

  • NTFS のアクセス許可と、サービスとしてログオンする権限のみを付与します。
  • Administrators グループに追加しないでください。
  • 後でアカウントを変更した場合は、依存関係ディレクトリや Java のインストールなど、これらの権限を再適用してください。

グループ管理サービス アカウント (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

gMSA はパスワードを自動的にローテーションし、資格情報管理のオーバーヘッドを排除します。

Windows サービスの詳細​

サービスのステータスを表示する​

サービス コンソール経由​
  1. [ファイル名を指定して実行] (Win + R) を開き、「services.msc」と入力します。
  2. 表示名が Relay - <id>のサービスを見つけます。
  3. コンテキスト メニューを開くと、プロパティを開始、停止、再起動、または表示できます。
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

サービスの回復​

リレークライアントは、サービスとして自身をインストールすると、自動リカバリを構成します。

  • 最初の失敗: 10 秒後に再起動します
  • 2 回目の失敗: 30 秒後に再起動します
  • 後続の失敗: エスカレートする遅延で再起動

回復設定を確認または調整するには、サービス services.msc > [ プロパティ ] > [ 回復 ] タブを開く>右クリックします。

イベント ビューアー​

イベント ビューアー (eventvwr.msc) を使用して、サービスの問題を診断します。

ログパスイベント
システムWindows ログ > システムサービスの開始、停止、クラッシュ、および回復 (7000 シリーズ)
アプリケーションWindows ログ > アプリケーションアプリケーション エラー

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
Event ID意味
7000サービスを開始できませんでした。アカウントの権限を確認する
7009サービス待機のタイムアウト。ネットワーク接続を確認する
7031サービスがクラッシュし、回復アクションが実行されました。チェック relay.log
7034サービスが予期せず終了しました。リソースが枯渇していないか確認する
7045新しいサービスがインストールされた (インストールが成功したことを確認)

プロキシ構成​

Windows サービスは、システム (HKLM) から環境変数を継承します。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

プロキシ変数をユーザー レベルで設定するだけでは不十分です。システム サービスでは、ユーザー レベルの環境変数が無視されます。

プロキシを更新するには、 システムレベルの変数を変更して .\relay.exe restart <id>を実行します。

プロキシを削除するには、[Environment]::SetEnvironmentVariable("HTTPS_PROXY", $null, "Machine")、次に.\relay.exe restart <id>します。

確認するには、以下の手順を実行します。 [Environment]::GetEnvironmentVariable("HTTPS_PROXY", "Machine")。

サポートされているプロキシスキームと認証については、 リレークライアントのデプロイのプロキシセクションを参照してください。

Windows ファイアウォール​

送信トラフィックが Windows ファイアウォールによって制限されている場合は、Relay クライアント バイナリの送信規則を追加します。

オンプレミスExecutorが有効で、アウトバウンド・プログラム・ルールが適用される場合は、Executorが使用するJava実行可能ファイルが、サポートされている各TCPベースの接続のターゲット・ホストおよびポートに接続することも許可します。ルールのスコープを、すべての送信トラフィックを許可するのではなく、これらの宛先に設定します。

受信ルールは必要ありません。Executor は、ループバック インターフェイスでのみリッスンし、デフォルトではポート 18080 で、ホストの外部からの接続は受け入れません。そのポートは開かないでください。リスナーがループバックにバインドされていることを確認するには、 Get-NetTCPConnection -LocalPort 18080 -State Listen を実行して、 LocalAddress が 127.0.0.1 か ::1か確認します。

設定値 (Value)
方向発信
プログラムC:\Program Files\UiPathRelay\relay.exe
プロトコル/ポートTCP/443
プロファイルドメイン、プライベート

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

GUI経由 (セキュリティが強化されたWindows Defenderファイアウォール):

  1. wf.mscを開きます。
  2. [新しい規則] > [送信規則] を選択します。
  3. [ プログラム ] を選択し、 C:\Program Files\UiPathRelay\relay.exeを指定します。
  4. [ 接続を許可] を選択します。
  5. [Apply to Domain and Private profiles] をクリックします。
  6. ルールに「 UiPath Relay - Outbound HTTPS」という名前を付けます。

組織がグループ ポリシーまたはサードパーティのファイアウォールを使用してファイアウォール ルールを管理している場合は、Windows 管理者と協力して同等のルールを追加してください。

ウイルス対策とエンドポイント保護​

干渉を防ぐために、リレー クライアント バイナリとそのデータ ディレクトリの除外を追加します。

入力パス
バイナリC:\Program Files\UiPathRelay\relay.exe
データとログC:\ProgramData\UiPathRelay\
Java 実行可能ファイル (Executor のみ)Executor が使用する java.exe のフル パスです
コネクタ ライブラリ (Executor のみ)依存関係ディレクトリ

java.exeにプロセスの除外を追加しないでください。これは、サードパーティのコードをロードして内部システムに到達するジョブであるプロセスをエンドポイント保護が検査するのを停止し、ホスト上のすべてのJavaプロセスに裸のファイル名を適用します。パスの除外を使用し、任意のプロセスの除外をフル パスとして指定します。

Windows Defender アプリケーション制御 (WDAC) や AppLocker などのアプリケーション制御を使用する場合、 onprem-executor.jar は Relay クライアントのアップグレードごとに置き換えられるため、特定のファイル ハッシュを許可するルールはアップグレードのたびに一致しなくなることに注意してください。パス・ルールまたはパブリッシャー・ルールを使用し、アップグレード手順の一環としてJARを再承認します。

--bin-dir、--data-dir、または --logs-dirでカスタム パスを使用していた場合、代わりにそれらのパスを除外します。

PowerShell 経由の Windows Defender​

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"

GUI 経由の Windows Defender​

  1. [Windows セキュリティ > ウイルスと脅威の防止] > [設定の管理] を開きます。
  2. [除外] で、[除外を追加または削除] を選択します。
  3. フォルダーの除外を追加します: C:\Program Files\UiPathRelay\ と C:\ProgramData\UiPathRelay\。
  4. プロセスの除外を追加: relay.exe

一元管理されたエンドポイント保護 (CrowdStrike、Symantec、Intune/SCCM 経由の Microsoft Defender for Endpoint) については、セキュリティ管理者と協力して、上記の除外を追加します。

アンインストール​

  1. すべてのRelayクライアントを削除します( .\relay.exe list を使用して、インストールされているグループを表示します)。

    .\relay.exe delete <id>
    .\relay.exe delete <id>
    
  2. 共有バイナリを削除します。

    Remove-Item "C:\Program Files\UiPathRelay" -Recurse
    Remove-Item "C:\Program Files\UiPathRelay" -Recurse
    
  3. 残りのデータ ディレクトリを削除します。

    Remove-Item "C:\ProgramData\UiPathRelay" -Recurse
    Remove-Item "C:\ProgramData\UiPathRelay" -Recurse
    
  4. 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. Windows ファイアウォール ルールを削除します。

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

グループ ポリシーまたはサードパーティのファイアウォールを介して追加されたルールの場合は、Windows 管理者と協力して削除します。

トラブルシューティング​

症状原因解決方法
サービスの開始に失敗する権限が不十分である管理者として PowerShell を開く
permission deniedProgram Files または ProgramData に書き込めない管理者のアクセス権を確認するか、書き込み可能なパスに --bin-dir / --data-dir を使用します
does not have the 'Log on as a service' rightカスタム アカウントが見つからない SeServiceLogonRightローカル セキュリティ ポリシー>ユーザー権利の割り当てを使用して付与するか、グループ ポリシーを使用します
not a valid Windows account形式が正しくない --service-accountローカル アカウントには .\username を、ドメイン アカウントには DOMAIN\username を使用します
marked for deletion / サービスの削除保留中services.msc ハンドルが開いているservices.mscを閉じて再試行してください。問題が解決しない場合は再起動します
service is disabledservices.msc またはグループ ポリシーによって無効化されている再度有効化: Set-Service -Name "Relay-<id>" -StartupType Automatic
file is locked by another process更新中にバイナリが使用されている最初にリレークライアントサービスを停止してから再試行してください
path exceeds Windows path length limitデータ/ログのパスが 260 文字を超えている--data-dirと--logs-dirには短いパスを使用します
ウイルス対策のブロック relay.exeEndpoint Protection 検疫バイナリ除外を追加します ( 「ウイルス対策とエンドポイント保護」を参照)。[検疫と復元の確認]
サービスは実行されていますが、トンネルが確立されていませんネットワークまたは認証の問題relay.loglogin to serverエラーがないか確認します。cloud.uipath.comへの接続を確認します。26.4.2より前の Relay クライアント バージョンの場合、リージョンのリレー ホスト名への TLS パススルーを確認します
DPAPI decrypt failed仮想マシンの複製または再イメージ化後に変更されたマシン IDUiPath Administration からの新しい設定でリレーを再プロビジョニングする
プロキシがサービスで使用されていないシステム レベルではなくユーザー レベルで設定されたプロキシマシン レベルで HTTPS_PROXY を設定します ( 「プロキシの構成」を参照)。サービスを再起動します

診断コマンド​

# 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

プラットフォーム間で共有される認証エラーと接続エラーについては、「 トラブルシューティング」を参照してください。

クイック リファレンス​

操作コマンド
先頭.\relay.exe start --config-file config.txt --accept-license-agreement
停止.\relay.exe stop <id>
再起動/アップグレード.\relay.exe restart <id>
削除する.\relay.exe delete <id>
削除 (強制).\relay.exe delete <id> --force
リスト (List).\relay.exe list
説明を入力.\relay.exe describe <id>
ログ.\relay.exe logs <id> -f
サービスのステータスGet-Service "Relay-<id>"
サービス コンソールservices.msc

このページは役に立ちましたか?

接続

ヘルプ リソース サポート

学習する UiPath アカデミー

質問する UiPath フォーラム

最新情報を取得