Test Cloud 管理ガイド

ネットワーク内のマシンに Relay クライアントをインストールして起動し、Test Cloud への送信トンネルを確立します。開始する前に、Relay グループを設定し、クライアント設定文字列を準備しておきます。

これらは、リレークライアントプロセスの最小要件です。マシンで他のワークロードが実行されている場合は、それに応じて追加のリソースをプロビジョニングします。

Relay クライアントには、送信のみの接続が必要です。受信ファイアウォール規則は必要ありません。

Relay クライアント 26.4.2以降、新しい Relay クライアント設定では、標準の Automation Cloud URL cloud.uipath.comを介して永続トンネルを接続できます。これらの構成では、トンネルにリージョン固有のリレー ホスト名許可リストは必要ありません。

26.4.2より前のバージョンのリレークライアントは、引き続き地域のリレーホスト名で動作します。これらのホスト名は、Relay クライアント 26.4.2 以降に移行し、 cloud.uipath.com経由で接続するまで、許可リストに登録したままにしてください。

26.4.2 より前のバージョンの Relay クライアントの場合は、<region> をご自身の Test Cloud テナントのリージョンに置き換えてください。

リレー ノードの物理的な場所ではなく、UiPath Cloud テナント のリージョンに一致するリージョンを選択します。たとえば、テナントが米国リージョンにプロビジョニングされている場合は、リレー自体が別の地域で実行される場合でも、 us-relay.uipath.com を使用します。cloud.uipath.comを介して接続するリレークライアント26.4.2構成では、この地域ホスト名は使用されません。

待機時間に関する考慮事項: トラフィックは UiPath Cloud → リレー サーバー→リレー ノード→オンプレミス サービスを通過するため、テナントのリージョンに地理的に近い場所にリレー ノードを配置すると、ラウンドトリップ時間が最小限に抑えられ、全体的なスループットが向上します。

For Relay client 26.4.2 configurations that connect through cloud.uipath.com, configure firewalls and proxies to allow HTTPS traffic and WebSocket upgrades to cloud.uipath.com:443.

If a proxy inspects TLS for cloud.uipath.com, install the proxy's signing CA in the OS trust store used by the Relay client, and make sure the proxy allows WebSocket upgrades.

For Relay client versions earlier than 26.4.2, configure your firewall and any TLS-inspecting proxy or DLP appliance to allow TLS passthrough for <region>-relay.uipath.com:443; TLS inspection on the regional relay hostname breaks the relay tunnel.

また、Relay クライアントを実行するマシンは、公開する予定のすべてのオンプレミス サービスに直接ネットワーク アクセスできる必要があります。それに応じて、リレー クライアントの配置を計画します。

制御チャネル (ハートビートと認証) は、アイドル時に約 1 〜 2 KB/分 を使用します。データトラフィックは、クラウドサービスがオンプレミスエンドポイントに送信するリクエストの量に応じてスケーリングされ、リレーは透過的なトンネルとして機能し、TLSと cloud.uipath.com 接続用の軽量WebSocketフレーミング以外のオーバーヘッドはありません。

リレークライアントをインストールする前に、ポート443の送信トラフィックが構成に必要な宛先に許可されていることを確認してください。

成功した結果には、Windows では TcpTestSucceeded : True 、Linux では succeeded が表示されます。必要なチェックに失敗した場合は、ファイアウォール ルールを確認してください。cloud.uipath.com経由で接続する Relay クライアント26.4.2構成の場合は、WebSocket のアップグレードが許可されていることを確認します。26.4.2より前のリレークライアントバージョンの場合は、リレーサーバホスト名にTLSパススルーが設定されていることを確認します。

ネットワークが送信トラフィックをプロキシ経由でルーティングする場合は、実行する前に次の環境変数を設定します relay start。リレークライアントは、すべてのアウトバウンド接続にプロキシを適用します。

プロキシ URL は、 http://、 https://、 socks5://、または ntlm://のいずれかのスキームを使用する必要があります。形式: scheme://[user:password@]host:portです。

https://プロキシの場合: Relay クライアントは、プロキシの TLS 証明書を OS 信頼ストアと照合して検証します。プロキシが企業 CA または自己署名 CA を使用している場合は、リレーを開始する前に、その CA をリレー クライアント マシンの信頼ストアに追加します。そうしないと、TLS ハンドシェイクは証明書検証エラーで失敗します。

For Relay client 26.4.2 configurations that connect through cloud.uipath.com, configure your proxy to allow long-lived HTTPS connections and WebSocket upgrades to cloud.uipath.com:443. If the proxy inspects TLS for cloud.uipath.com, install the proxy's signing CA in the OS trust store used by the Relay client.

For Relay client versions earlier than 26.4.2, configure your proxy to bypass TLS inspection for <region>-relay.uipath.com:443. PAC files, WPAD auto-discovery, and proxy chaining are not supported — set the proxy URL explicitly. When a proxy is detected, the prerequisite checks show via proxy in the output.

組織が IP アドレスでアクセスを制限している場合は、[管理] で、Relay クライアントが実行されているマシンの NAT IP を信頼できる IP リストに追加します。Relay クライアントの送信トラフィックはこの IP アドレスから Test Cloud に接続するので、この IP アドレスを明示的に許可する必要があります。

手順については、「 信頼できる IP 範囲を追加する」をご覧ください。

Relayクライアントを起動する前に、ライセンス契約に同意する必要があります。次のいずれかの方法を選択します。

オプション 1 (環境変数) — LICENSE_AGREEMENT 環境変数を accept に設定します。

オプション 2 (インライン パラメーター) — relay start コマンドに --accept-license-agreement を追加します。

運用環境へのデプロイについては、ご使用のオペレーティング システム用のプラットフォーム ガイドをご覧ください。そのガイドでは、ディレクトリ構造、サービスの管理、セキュリティ フレームワークの設定、アンインストール手順について説明されています。

リレークライアントは、トンネルを自動的に維持します。

一部のネットワーク(企業プロキシ、ロードバランサー、またはアイドル接続タイムアウトのあるファイアウォールの背後)は、有効期間の長いTLS接続をサイレントに終了します。プロアクティブ再接続は、これを防ぐために、固定スケジュールで制御接続を再確立します。

--reconnect-interval フラグを付けて有効化します。

有効な最小値は 1800 秒 (30 分) です。間隔をネットワークアプライアンスのアイドルタイムアウトの約半分に設定します(たとえば、60分のファイアウォールタイムアウトの場合は1800秒)。アイドル接続タイムアウトなしで安定したネットワークで無効のままにします。

Test Cloud からプロキシ構成を再取得し、再起動せずに適用します。クラウド側での変更 (新しいエンドポイント、健全性チェックのパスの更新) は、実行中の Relay クライアントに自動的にプッシュされるため、通常は再読み込みは必要ありません。このコマンドは、新しく追加したエンドポイントが 404 を返す場合にのみ、フォールバックとして使用してください。

既定のログ レベルを [ --log-level trace/debug/info/warn/error] で上書きします。Relay クライアント 26.4.2 以降で、ローテーションされたログの保持期間を relay start または relay restartの --log-retention-days <days> で上書きします。最小保持期間は 7 日間です。

新しい Relay クライアントをプロビジョニングし、バックグラウンド サービスとして開始します。

Stop and restart the Relay client service. Detects updated binaries and applies service definition changes.

The following flags can be overridden at restart time (all default to unchanged unless noted):

リレークライアントのログ出力を表示します。

このマシン上のすべての Relay クライアントを、ステータス、バージョン、作成と更新のタイムスタンプ、およびグループ (使用可能な場合) と共に表示します。長いグループ名は、表の出力では切り捨てられます。

グループIDと名前、シークレットID、ステータス、バージョン、サービスモードと実行可能パス、設定されたハートビートと再接続の間隔、ログレベル、ローカルパス、タイムスタンプなど、1つのリレークライアントの詳細情報を表示します。

Test Cloud からプロキシ構成を再取得し、再起動せずに適用します。新しく追加したエンドポイントが 404 を返す場合にフォールバックとして使用します。

リレークライアントサービスを停止します。構成と資格情報は保持され、リレークライアントは後で再起動できます。

サービスを停止して Test Cloud から登録を解除し、ローカルの設定と資格情報をすべて削除します。

UiPath サポート チケット用に、設定、ログ、システム メタデータの墨消し済みのアーカイブを収集します。マシン上のすべての Relay クライアントをバンドルするには、[id] を省略します。資格情報と暗号化キーは一切含まれません。詳しくは、Relay のトラブルシューティングに関するこちらのページをご覧ください。

Relay クライアントのバージョン、ビルド日、および git コミットハッシュを出力します。

If your organization runs endpoint protection software, add exclusions for the relay binary and its data directory to prevent the Relay client from being blocked or quarantined. For Relay client 26.4.2 configurations that connect through cloud.uipath.com, allow cloud.uipath.com:443.

For Relay client versions earlier than 26.4.2, configure TLS-inspecting proxies, DLP appliances, and IDS/IPS systems to bypass inspection for <region>-relay.uipath.com:443.