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

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

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

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

Edition	最小バージョン
Windows Server	2019 年
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 の空きディスク領域

ネットワーク

• cloud.uipath.com への送信 HTTPS (ポート 443) が許可されます
• <region>-relay.uipath.com への送信 TLS (ポート 443) が許可されます
• リレーエンドポイントに設定されたTLSパススルー(TLSインスペクションなし)
• リレー ノードは、公開する予定のすべてのオンプレミス サービスにネットワーク アクセスできます

セキュリティ

• サービス アカウントの作成時 (LocalSystemを使用していない場合) — 「サービス アカウントと権限」をご覧ください。
• Windows Defender とウイルス対策の除外が計画されています — 「ウイルス対策とエンドポイント保護」を参照してください。

構成

• Relay グループが作成され、クライアント設定文字列が準備完了 — 「Relay グループを設定する」を参照してください。

検証コマンド (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

インストール

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

アーキテクチャ	アーカイブ
x86_64	relay-windows-amd64.zip
ARM64	relay-windows-arm64.zip

zip アーカイブを展開します。すぐに実行できる 1 つの relay.exe バイナリが含まれています。

2. 開始

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

クライアント設定文字列を (UiPath Administration から提供 — 「Relay グループを設定する」を参照) は、次の 2 つの方法で指定できます。

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

.\relay.exe start --config "<your-config>"

オプション B — ファイル。設定をファイルに保存し、参照します。推奨 — シェルの履歴から秘密を隠します。

Set-Content -Path "config.txt" -Value "<your-config>"
.\relay.exe start --config-file C:\path\to\config.txt

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

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

LocalSystemアカウントではなくカスタム サービス アカウントで開始するには、以下の手順を実行します。

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

3. 確認する

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

管理

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

リスト (List)

このマシンにインストールされているすべてのリレー グループのステータスとバージョンが表示されます。管理者権限は不要です。

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

停止

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

.\relay.exe stop <id>

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

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

.\relay.exe restart <id>

バイナリ アップグレード: 新しい relay.exe をダウンロードし、そこから .\relay.exe restart <id> を実行します。restart コマンドは、実行中のバイナリとインストールされたコピーを SHA256 ハッシュで比較し、異なる場合はインストールされたバイナリを自動的に更新します。

シナリオ	コマンド
Test Cloud でのエンドポイントの追加または削除	.\relay.exe restart <id>
クライアント シークレットのローテーション — インライン	.\relay.exe restart --config "<new-config>"
クライアント シークレットのローテーション — ファイル	.\relay.exe restart --config-file new-config.txt
バイナリアップグレード	新しいバイナリをダウンロードし、 .\relay.exe restart <id>

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

削除する

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

.\relay.exe delete <id>

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

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

バージョン

.\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
  logs\<id>\
    relay.log                                # Current log
    relay.YYYYMMDD-HHMMSS.log                # Rotated logs

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

カスタム パス

インストール時に既定のディレクトリを上書きする:

.\relay.exe start --config-file C:\path\to\config.txt `
  --bin-dir "D:\MyCompany\bin" `
  --data-dir "D:\MyCompany" `
  --logs-dir "D:\MyCompany"

フラグ	既定 (Default)	説明
--bin-dir	C:\Program Files\UiPathRelay	共有バイナリのディレクトリ
--data-dir	C:\ProgramData	構成データのルート
--logs-dir	C:\ProgramData	ログ ファイルのルート

リレークライアントは、カスタムデータルートとログルートの下に 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、 --data-dir、および --logs-dir は、 start コマンドでのみ受け付けられます。その他のコマンド (stop、 restart、 delete、 list) は、インストールされているサービス構成から自動的にパスを検出します。

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

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

必要なユーザー権限

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

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

NTFS アクセス許可

パス	必要なアクセス許可
C:\Program Files\UiPathRelay\	読み取り&実行
C:\ProgramData\UiPathRelay\	読み取り、書き込み、変更
C:\ProgramData\UiPathRelay\logs\	読み取り、書き込み、変更、削除

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

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

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

--service-account-password は、ドメインまたはローカル ユーザー アカウントに必要です。管理されたサービス アカウント (gMSA) では、パスワードは必要ありません。

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

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

サービスの回復

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

• 最初の失敗: 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

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

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

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

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

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

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

Windows ファイアウォール

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

設定	値 (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

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\

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

Windows Defender — PowerShell 経由

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

Windows Defender — GUI 経由

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>
   

2. 共有バイナリを削除します。

   Remove-Item "C:\Program Files\UiPathRelay" -Recurse
   

3. 残りのデータ ディレクトリを削除します。

   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"
   

5. Windows ファイアウォール ルールを削除します。

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

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

トラブルシューティング

症状	原因	解決方法
サービスの開始に失敗する	権限が不十分である	管理者として PowerShell を開く
permission denied	Program 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 disabled	services.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.exe	Endpoint Protection 検疫バイナリ	除外を追加します ( 「ウイルス対策とエンドポイント保護」を参照)。[検疫と復元の確認]
サービスは実行されていますが、トンネルが確立されていません	ネットワークまたは認証の問題	relay.loglogin to serverエラーがないか確認します。TLS パススルーの確認
DPAPI decrypt failed	仮想マシンの複製または再イメージ化後に変更されたマシン ID	UiPath Administration からの新しい設定でリレーを再プロビジョニングする
プロキシがサービスで使用されていない	システム レベルではなくユーザー レベルで設定されたプロキシ	マシン レベルで HTTPS_PROXY を設定します ( 「プロキシの構成」を参照)。サービスを再起動します

診断コマンド

# Real-time logs
.\relay.exe logs <id> -f

# Service details
Get-Service "Relay-<id>" | Format-List *

# Connectivity test
Test-NetConnection -ComputerName <region>-relay.uipath.com -Port 443

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

クイック リファレンス

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