Relay クライアントをデプロイする

オンプレミス ネットワークを Test Cloud に接続するための Relay クライアントの前提条件、最小要件、およびクロスプラットフォームの設定手順。

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

前提条件

ハードウェア要件

プロファイル	vCPU	RAM	リレーグループ	グループあたりのエンドポイント	ユースケース
標準	1	2 ギバーB	10 個まで	最大 50	ほとんどのデプロイ
大	2	4 ギブB	10 以降	最大 50	ハイスループット環境や大規模環境

これらは、オンプレミスの Executor が有効化されていない場合の Relay クライアントの最小要件です。ホストが他のワークロードも実行する場合は、これらの数値に加えてワークロード用の容量を追加します。Executor を使用可能にするデプロイメントの場合は、 代わりに、サポートされている TCP ベースの接続についてのリソース計画 の図を使用してください。

サポートされる TCP ベースの接続のリソース計画

インストールする各 Relay グループは、専用の Relay クライアント サービスとして実行されます。オンプレミス Executor を有効化すると、そのサービスは 1 つの Java プロセスを開始して監視します。以下の図は、Executor が有効化された 1 つの Relay グループについてのものです。

プロファイル	vCPU	RAM	Executor 用に予約された RAM
標準 (Executor 付き)	2	4 ギブB	1 GiB
大規模 (Executor を含む)	4 つ以上	4 GiB 以上	1 GiB 以上

RAM には、Executor 予約、オペレーティング システム、Java ランタイムが含まれます。ホスト上の監視およびその他のワークロードのための容量を追加します。稼働後、Executor のメモリ使用量が予約に近づいたら、予約と RAM を一緒に上げます。

ヒント:

リソースの使用量を最小限に抑えるには、すべての TCP ベースのエンドポイントを 1 つの Relay グループに登録します。Relay クライアントは、TCP ベースのエンドポイントごとに 1 つのオンプレミス Executor を実行するため、1 つのプロセスのメモリーの予約、ホストのサイズ設定、および Executor ログの監視を行うことができます。

ネットワークのセグメンテーションまたは可用性の要件により、同じホスト上の Executor を持つ複数の Relay グループが必要な場合:

• 各グループの Executor に一意の --onprem-executor-listen-port 値を割り当てます。
• 追加の Executor プロセスごとにさらに 1 GiB を予約します。
• グループごとの CPU の数にグループ数を掛けるのではなく、すべてのグループの合計トラフィックの CPU サイズを設定します。
• グループごとに別の Executor JAR とログ ファイルに対してディスクを許可します。

ディスクの要件

プロファイル	最小空きディスク
標準 (1 〜 10 グループ)	200メガバイト
大規模 (10+ グループ)	1 GB

上記の最小値は、Relay クライアントのみを対象としています。オンプレミスの Executor を有効化する場合は、Java ランタイム、 onprem-executor.jar、指定したコネクタ ライブラリ、保持される Executor ログ用に追加の領域を確保します。ログの増加は、トラフィック量、ログ レベル、および設定されている保持期間によって異なります。

サポートされているオペレーティング システム

アーキテクチャ	Linux	Windows
x86_64 (AMD64)	サポート対象	サポート対象
ARM64 (aarch64)	サポート対象	サポート対象

ネットワーク要件

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

Relay クライアントのすべてのバージョンは、認証と登録を行う cloud.uipath.com に達します。Relay クライアント 26.4.2以降、新しい構成でも同じ URL を経由する永続トンネルが伝送されるため、リージョン固有の Relay ホスト名を許可リストに登録する必要がなくなりました。

Relay クライアントの構成	プロトコル	ポート	ターゲット	TLS パススルーが必要	目的
すべての Relay クライアント バージョン	https	443	cloud.uipath.com	必須ではない	認証とリレー登録
26.4.2 以降のリレー クライアント	HTTPS / WSS	443	cloud.uipath.com	必須ではない	永続トンネル
次のバージョンより前のリレー クライアント バージョン 26.4.2	TLS	443	<region>-relay.uipath.com	Required	永続トンネル

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

26.4.2 より前のバージョンの Relay クライアントの場合は、<region> をご自身の Test Cloud テナントのリージョンに置き換えてください。すべてのリージョンを網羅したリストについては、「グローバルなクラウド リージョン」をご覧ください。

リージョン	リレーサーバーのホスト名
米国	us-relay.uipath.com
EU	eu-relay.uipath.com
カナダ	ca-relay.uipath.com
スイス	ch-relay.uipath.com
オーストラリア	au-relay.uipath.com
シンガポール	sg-relay.uipath.com
日本	jp-relay.uipath.com
韓国	kr-relay.uipath.com
アラブ首長国連邦	ae-relay.uipath.com
英国	uk-relay.uipath.com
欧州連合 (遅延リージョン)	gxp-eu-relay.uipath.com
米国 (遅延リージョン)	gxp-us-relay.uipath.com

注:

テナントのリージョンが上記のリストにない場合は、UiPath サポートに連絡してリレー サーバーのホスト名を確認してください。

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

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

cloud.uipath.com経由で接続する Relay クライアント 26.4.2構成の場合、ファイアウォールとプロキシを構成して HTTPS トラフィックと WebSocket のアップグレードを許可cloud.uipath.com:443。プロキシが TLS の cloud.uipath.comを検査する場合は、Relay クライアントで使用される OS 信頼ストアにプロキシの署名 CA をインストールし、プロキシで WebSocket のアップグレードが許可されていることを確認します。

26.4.2 より前の Relay クライアント バージョンの場合、ファイアウォールと、TLS 検査プロキシまたは DLP アプライアンスを、<region>-relay.uipath.com:443 の TLS パススルーを許可するように構成します。リージョンの Relay ホスト名に対して TLS 検査を行うと、Relay トンネルが切断されます。

Relay ホストは、登録されているすべての HTTP または HTTPS エンドポイント、およびサポートされている各 TCP ベースのエンドポイントのホストとポートを解決して接続する必要があります。

ルーティング パスは柔軟です。直接ネットワーク ルート、企業のエグレス プロキシ、またはジャンプ ホストは、Relay ホストからの接続が成功する限り、すべて許容されます。グループ内のすべての宛先に到達可能な状態が維持されるように配置を計画します。

帯域幅

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

サポートされる TCP ベースの接続の場合、オンプレミスの Executor は各要求をコネクタのプロトコルに変換します。したがって、Executor とターゲット システム間のトラフィックには、元の要求のサイズではなく、そのプロトコルが反映されます。Relay クライアントと Executor 間のトラフィックはループバック インターフェイス上にとどまり、ホストを離れません。

接続を確認する

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

Linux

nc -zv cloud.uipath.com 443

# Required only for Relay client versions earlier than 26.4.2
nc -zv <region>-relay.uipath.com 443

Windows (PowerShell)

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

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

サポートされる TCP ベースの接続用のオンプレミス Executor

SAP BAPI などの サポートされている TCP ベースの接続の場合、要求はオンプレミスの Executor によって処理されます。オンプレミスの Executor は、コネクタのプロトコルを読み上げてターゲット システムに呼び出しを転送する Java プロセスです。以下で説明する Linux および Windows サービスのデプロイでは、Relay クライアントが起動して監視します。コンテナー デプロイでは、それを別のコンテナーとして実行します。「 SAP BAPI およびその他の TCP ベースの接続」をご覧ください。

重要:

オンプレミスの Executor をサポートするには、Relay クライアント 26.4.3 以降が必要です。

Relay クライアントは、Linux および Windows サービスのデプロイにおいて、Relay クライアント サービスごとに 1 つの Executor プロセスを開始します。Executor は、既定でポート 18080 の localhost でのみリッスンし、ホストの外部からはアクセスできません。他のループバック サービスと同様に、同じホスト上の他のプロセスからアクセスできるため、Relay ホストへのローカル アクセスは機密性の高いものとして扱います。

有効化する前に、以下が必要です。

• Java 21 以降のランタイムが利用可能である。JRE または JDK で十分であり、既存のインストールで機能します。を実行するアカウントの PATH に java を入力するか、 --onprem-executor-java-homeでランタイムの場所relay start渡します。
• Relay バイナリ (Linux の場合は relay 、Windows の場合は relay.exe ) と、バンドルされている onprem-executor.jar を同じアーカイブから展開します。2 つのファイルを一緒に展開されたディレクトリに残し、そのディレクトリからインストール コマンドまたはアップグレード コマンドを実行します。
• Relay ホストがターゲット システムのホスト名とポートに到達できることを確認してください。
• コネクタで、UiPath が同梱していないライブラリが必要な場合は、それらのライブラリをすべて Relay サービス アカウントが読み取ることができる 1 つの永続的なディレクトリに配置し、そのディレクトリ --onprem-executor-dep-dir を指定します。Relay クライアントはパスを格納しますが、ファイルをコピーしません。
• SAP BAPI の場合、このディレクトリには、 sapjco3.jar と sapidoc3.jarの SAP JCo 3 ファイルに加えて、ホスト オペレーティング システムと Java ランタイム アーキテクチャに一致するネイティブ ライブラリが格納されています。SAP が SAP システムと Java ランタイムに対してサポートしている SAP JCo リリースを使用します。
• dependencies ディレクトリは Executor のコード読み込みパスであり、Relay サービス アカウントの権限で実行されます。管理者が所有する必要があり、特権のないユーザーが書き込み可能であってはなりません。
• Linux では、ディレクトリには 0755 を使用し、ファイルには 0644 を使用します。Windows では、これを の下に配置します C:\Program Filesこれにより、管理者には書き込みアクセス権が付与され、他のアカウントには既定で読み取りおよび実行が付与されます。

コピー可能なインストール コマンドと検証コマンドについては、「 Linux 」または「 Windows」をご覧ください。インストール後、 relay describe <id> は Executor が有効化されているかどうか、および Executor が使用する Java ホームおよび依存関係ディレクトリを報告します。

重要:

コンテナ・デプロイメントでは、Relay クライアントは Executor を開始しないため、サービス・デプロイメントの Java ランタイムおよび依存関係ディレクトリーの要件は適用されず、 --onprem-executor-java-home と --onprem-executor-dep-dir は効果がありません。「 SAP BAPI およびその他の TCP ベースの接続」で説明しているように、Executor を別のコンテナーとして実行します。

プロキシを構成する (該当する場合)

ネットワークで送信トラフィックをプロキシ経由でルーティングする場合は、 を実行する前に以下の環境変数を設定します relay start。Relay クライアントは、プロキシ対応の送信トラフィックにこれらの設定を使用します。

変数	目的
HTTPS_PROXY / https_proxy	プロキシ URL (最初に確認)
HTTP_PROXY / http_proxy	プロキシ URL (フォールバック)
NO_PROXY / no_proxy	プロキシをバイパスするコンマ区切りのホストまたはドメイン

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

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

cloud.uipath.com 経由で接続する Relay クライアント 26.4.2 構成の場合は、cloud.uipath.com:443 への長時間の HTTPS 接続と WebSocket のアップグレードを許可するようにプロキシを設定します。プロキシが TLS を検査して cloud.uipath.com を確認する場合は、Relay クライアントによって使用される OS の信頼ストアにプロキシの署名 CA をインストールします。

26.4.2より前のバージョンの Relay クライアントでは、 の TLS インスペクションをバイパスするようにプロキシを構成<region>-relay.uipath.com:443。PAC ファイル、WPAD 自動検出、およびプロキシ チェーンはサポートされていません。プロキシ URL を明示的に設定します。プロキシが検出された場合、前提条件の確認により出力に via proxy が表示されます。

重要:

Relay クライアントは、ログ内のプロキシ パスワードを墨消しします。ただし、環境変数で設定された資格情報は、プロセス リストや systemd ユニット ファイルに表示される場合があります。専用のサービス資格情報を使用し、それに応じてリレー ノードへのアクセスを制限します。

信頼できる IP を設定する (該当する場合)

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

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

ライセンス契約に同意します

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

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

Linux

export LICENSE_AGREEMENT=accept

Windows

$env:LICENSE_AGREEMENT=accept

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

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

セットアップ ガイド

運用環境のデプロイの場合は、ご使用のオペレーティング システムの『Platform Guide』をご覧ください。クイック スタート コマンド、ディレクトリ構造、サービス管理、セキュリティ フレームワークの構成、およびアンインストール手順について説明します。

プラットフォーム	ガイド
Linux	Linux での Relay クライアントのデプロイ
Windows	Windows への Relay クライアントの導入
コンテナ―	Relay クライアントをコンテナとしてデプロイする

操作

接続の回復性

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

• デフォルトでは30秒ごとのハートビート(--heartbeat-intervalを介して設定可能、最小10秒)。トンネル タイムアウトはハートビート間隔の 3× です。ファイアウォール、プロキシ、または NAT がアイドル状態の TCP 接続を 30 秒前に切断する場合は、間隔を短くします。

  relay start --config "<config>" --heartbeat-interval 10 --accept-license-agreement
  relay restart <id> --heartbeat-interval 10
  

• 20秒間隔への指数バックオフスケーリングを使用して、切断時に自動再接続します。
• プロセスがクラッシュした場合のサービスの自動再起動。Linux では systemd 、Windows では Windows サービス コントロール マネージャーによって管理されます。
• システムの再起動時にサービスが自動的に開始します。

プロアクティブな再接続

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

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

relay start --config "<config>" --reconnect-interval 1800 --accept-license-agreement

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

• 優雅な排水。この間隔が経過すると、Relay クライアントは新しい作業の受け入れを停止し、転送中の接続が完了するまで待機し (最大 300 秒のドレイン タイムアウト) を待ってから、古い接続を閉じて新しい接続を開きます。ドレイン タイムアウトに達したときにまだ進行中の要求は終了されます。

• 高可用性複数の Relay クライアントが同じグループにデプロイされている場合、一度に 1 つのクライアントのみがドレインされるように調整されます。グループは、各再接続サイクルを通じてトラフィックを提供し続けます。

• プロアクティブな再接続が必要であることを示す兆候: ログには、基盤となるネットワークが安定しているにもかかわらず、定期的に発生する unexpected EOF エラーやサイレント切断が表示されます。これは通常、ファイアウォール、プロキシ、またはロード バランサーで 30 分から 60 分のアイドル タイムアウトが原因で発生します。

構成を再読み込みする

relay reload <id>

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

ログ

設定	値 (Value)
既定のレベル	info
回転	毎日
retention	7 日
ログ ファイル	relay.log (現在)、 relay.YYYYMMDD-HHMMSS.log (回転)

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

コマンド リファレンス

リレー開始

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

ライセンス契約 (1 つが必要)

• --accept-license-agreement: エンドユーザー使用許諾契約にインラインで同意します。
• LICENSE_AGREEMENT=accept: フラグと同等の環境変数です。relay start は EULA を出力し、どちらも設定されていない場合は終了します。

構成 (1 つが必要)

• -c、 --config <string>: インラインの Base64 でエンコードされた構成文字列です。
• --config-file <path>: 構成文字列を含むファイルへのパスです。推奨: シェル履歴から秘密を保持します。

チューニング(オプション)

• --heartbeat-interval <sec>: トンネルのハートビート間隔です。既定 30です。最小 10です。トンネル タイムアウトはこの値の 3× です。ファイアウォール、NAT、またはプロキシがアイドル状態の TCP を 30 秒より前にドロップした場合は、この値を下げます。
• --reconnect-interval <sec>: プロアクティブな再接続間隔。既定 0 (無効)。設定した場合の実効最小 1800 (30 分)
• --log-level <level>: trace、debug、info、warn、またはerror既定 infoです。
• --log-retention-days <days>: ローテーションされたログ ファイルを保持する日数です。既定 7です。最小 7です。Relay クライアント 26.4.2 以降が必要です。
• -d、 --detach=false: バックグラウンド サービスとしてではなくフォアグラウンドで実行します。起動時の問題をデバッグするのに役立ちます。

On-prem Executor (任意)

• --enable-onprem-executor: オンプレミスの Executor を有効化します。Linux および Windows サービスのデプロイでは、Relay クライアントはバンドルされた Executor プロセスを開始します。コンテナー デプロイでは、既定のポート 18080で Executor コンテナーに接続します。
• --onprem-executor-listen-port <port>: オンプレミスの Executor がリッスンするポートです。既定 18080です。コンテナー デプロイでは、Executor コンテナーの SERVER_PORT 値を使用します。このフラグだけで Executor も有効化されます。
• --onprem-executor-java-home <path>: オンプレミス Executor を実行するために使用する JAVA_HOME です。省略すると、PATHからjava解決されます。コンテナーのデプロイでは無効です。
• --onprem-executor-dep-dir <path>: すべてのコネクタ依存関係 (JAR と、対応するネイティブ OS ライブラリの両方) を保持する単一のディレクトリです。SAP BAPI の場合は、ホスト用の sapjco3.jar、 sapidoc3.jar、および SAP JCo ネイティブ ライブラリです。Executor イメージがこのパスを所有するコンテナー デプロイでは、効果はありません。

Executor のアドレスは localhostに固定されています。Relay ログのレベルと保持期間の設定は、 onprem-executor.logにも適用されます。

既定以外のインストール パス (任意)

• --data-dir <path>: 構成ディレクトリ。
• --logs-dir <path>: ログ ファイル ディレクトリです。
• --bin-dir <path>: バイナリ インストール ディレクトリです。

Linux のみ

• --user-mode: systemd ユーザー サービスとしてインストールします ( sudo 不要、XDG パスを使用)。

Windows のみ

• --service-account <DOMAIN\user>: 特定のアカウントで Windows サービスを実行します。既定値は LocalSystemです。
• --service-account-password <password>: --service-accountのパスワードです。

リレーの再起動

リレークライアントサービスを停止し、再起動します。更新されたバイナリを検出し、サービス定義の変更を適用します。次のフラグは、再起動時にオーバーライドできます (特に記載がない限り、すべて既定で変更されません)。

• --config / --config-file: クライアント構成を置き換えます。
• --accept-license-agreement: 再起動時にライセンス契約に同意します。これは、ライセンスへの同意を保持しなかった古いインストール済みサービスをアップグレードする場合に便利です。
• --log-level: ログ レベルを変更します。
• --logs-dir <path>: インストールされているサービスのログ ディレクトリを再配置します。Relay クライアント 26.4.2 以降が必要です。
• --log-retention-days <days>: ローテーションされたログの保持期間を変更します。最小 7。渡す -1 変更しないままにします。Relay クライアント 26.4.2 以降が必要です。
• --heartbeat-interval: ハートビート間隔を変更します。最小 10。渡す 0 変更しないままにします。
• --reconnect-interval: プロアクティブな再接続間隔を変更します。設定されている場合の最小 1800 (30 分)。無効化するには 0 を渡し、変更せずに -1 します。
• --enable-onprem-executor: インストール済みのサービスのオンプレミス Executor の設定を有効化または更新します。
• --disable-onprem-executor: 永続化されたオンプレミス Executor の設定を削除し、Executor プロセスを実行せずに再起動します。
• --onprem-executor-listen-port、 --onprem-executor-java-home、 --onprem-executor-dep-dir: 特定のオンプレミス Executor 設定を更新します。これらのフラグのいずれかを渡すと、Executor が更新されます。

インストールされたサービスでオンプレミス Executor がすでに有効化されている場合、 relay restart <id> はその設定を保持します。Relay と Executor を一緒にアップグレードするには、新しいアーカイブから両方のファイルを抽出し、新しい Relay バイナリを使用して relay restart <id> を実行します。Java と Executor のチェックは、サービスが停止する前に実行されます。

リレーログ

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

• -f、 --follow: 新しいログ行を継続的にストリーミングします。
• -n、 --lines <N>: 末尾からの行数です。既定 50です。

リレーのリスト

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

• --json: オートメーションとスクリプティング用の JSON 出力を、完全なグループ名を含めて出力します。

relay describe (Relay クライアント26.4.2以降)

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

オン プレミスの Executor セクションでは、Executor が有効になっているかどうかが報告され、有効になっている場合は、リッスン ポート、ランタイム バージョン、ランタイム パス、Java ホーム、依存関係ディレクトリが報告されます。

• --json: オートメーションとスクリプト用の JSON 出力を出力します。

リレーリロード

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

リレーストップ

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

リレー削除

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

• -f、 --force: クラウドでの登録を解除せずにローカルで削除します。資格情報が判読できない場合や、クラウド側のリソースがすでに削除されている場合に使用します。

relay support-bundle [id]

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

リレーのバージョン

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

ウイルス対策とエンドポイント セキュリティ

組織でエンドポイント保護ソフトウェアを実行している場合は、リレーバイナリとそのデータディレクトリの除外を追加して、リレークライアントがブロックまたは隔離されないようにします。cloud.uipath.com経由で接続する Relay クライアント 26.4.2構成では、cloud.uipath.com:443を許可します。26.4.2より前のリレー クライアント バージョンの場合、TLS 検査プロキシ、DLP アプライアンス、および IDS/IPS システムを設定して、<region>-relay.uipath.com:443の検査をバイパスします。

オンプレミスの Executor を有効化する場合は、これらの除外を Java 実行可能ファイル、依存関係ディレクトリ、および onprem-executor.logに拡張します。Relay サービスは、サードパーティのコネクタ ライブラリを読み込む Java の子プロセスを開始しますが、一部のエンドポイント保護製品では既定でブロックされます。除外のスコープを、ディレクトリ ツリー全体ではなくこれらのパスに設定します。

ターゲット	ポート	プロトコル	操作
cloud.uipath.com	443	https	許可
<region>-relay.uipath.com	443	TLS	次の日付より前の Relay クライアント バージョンのTLS インスペクションを許可 + バイパスする 26.4.2