UIP RPA リモート

「uip rpa remote」の構文とオプション。リモートの Orchestrator Unattended ロボットを設定および駆動します。ターゲットの設定、UI Automation セッション、プロセスの実行、ファイル転送を行います。

uip rpa remote はリモートの Orchestrator Unattended ロボットで動作します。対象とするマシン/ロボット/ランタイムの設定、リモートの UI Automation デザイン セッションの開始または停止、シェル コマンドの実行、ロボットとの間のファイルの転送を行います。uip rpa run --remote設定が完了すると、ローカル で実行するのではなく、そのマシンに実行をdebug start --remote ルーティングできます。

すべての動詞に Orchestrator サインイン (uip login) が必要です。

概要

uip rpa remote configure --machine <name> [--folder-path <path>] [--robot <name>] [--runtime <name>] [--live-authoring | --remote-run-only]
uip rpa remote status
uip rpa remote start
uip rpa remote stop
uip rpa remote echo --message <text>
uip rpa remote exec --command <cmd> [--package-id <id> --package-version <v>] [--working-directory <dir>] [--timeout <seconds>]
uip rpa remote upload-file --local-path <path> --remote-path <path>
uip rpa remote download-file --remote-path <path> --local-path <path>

UIP RPA リモート設定

リモート デバッグ ターゲット (ロボット→マシン→実行時→フォルダー) を解決して保存し、そのターゲットでリモート UI Automation デザイン セッションを開始します。remote stop セッションをオフにします。

オプション

長押し	値 (Value)	Required	説明
--machine <name>	string	○	Unattended ロボットを実行する Orchestrator のマシン名です。
--folder-path <path>	string	×	ロボット/マシンが属する完全修飾 Orchestrator フォルダー (例:Shared/Finance) — ロボット、マシン、ランタイムがその中で解決されます。既定では、バックエンドの現在のフォルダーです。
--robot <name>	string	×	実行するロボット/ユーザー アカウントです。既定値はマシンの既定の ID です。
--runtime <name>	string	×	接続済みのランタイム (ホスト/セッション) 名。サーバーレス マシンでは無視されます。クラシック マシン上の特定の接続セッションを対象とするように設定します。
--live-authoring	フラグ	×	ライブ作成にはターゲットを使用します。1 つの長期間のリモート セッション ジョブが、すべてのリモート コマンド、実行、デバッグ セッションを処理します。リモートの UI Automation デザイン セッションが利用可能になり、リモート画面がストリーミングされます。--remote-run-onlyと相互に排他的です。remote echo が機能する前に必須です。
--remote-run-only	フラグ	×	ターゲットはリモート実行にのみ使用します。実行またはデバッグ セッションはそれ自体の Orchestrator ジョブであり、リモートの UI Automation セッションはありません。これは、モードが保存されたことのないターゲットの既定値です。--live-authoringと相互に排他的です。

--live-authoringと--remote-run-onlyの両方を渡すと、クライアント側で失敗します。これらは 1 つの接続の 2 つのモードです。最大で 1 つで合格します。どちらも渡さない場合、ストアド モードは変更されません。

例

uip rpa remote configure --machine BotMachine --folder-path "Shared/Finance"

データシェイプ(--output json)

バックエンドの { success, ...resolved-config } ペイロードの未加工のパススルー — 一致すると、解決されたフォルダー、ロボット、マシン、ランタイムが含まれます。

UIP RPA のリモート ステータス

サインインしているテナントに対して現在設定されているリモート接続 (Orchestrator に対して解決済み) を表示する読み取り専用 — 何も変更したり、開始したりしません。オプションはありません。

例

uip rpa remote status

UIP RPA リモート起動

リモート UI Automation を開始: 構成したリモート エージェントで UIA 設計エクスペリエンス セッションを設定し、 --remote でコマンドがそのマシンを駆動uip rpa uiaするようにします。ターゲットが設定されていない場合は失敗します (最初にremote configure )。すでに実行中のセッションを開始しても操作は不要です。別のターゲットに再設定すると、再起動します。オプションはありません。

例

uip rpa remote start

UIP RPA リモート停止

現在のリモート UIA セッションを破棄して、エージェントを解放します。べき等 — セッションが実行されていない場合や、ターゲットが設定されなくなった場合でも成功します。後で uia --remote 呼び出しを行うと、新しいセッションが自動的に開始されます。オプションはありません。

例

uip rpa remote stop

UIP RPA リモート エコー

構成済みのリモート エージェントで実行されている RemoteSessionAgent からメッセージをラウンドトリップし、応答を出力します (接続チェック)。ライブ オーサリングのみ (remote configure --live-authoring);[リモート実行のみ] に回答するエージェントがありません。エージェントの初回使用時に起動します。すべてのエコーは独自のプライベート チャネル上を移動するため、同時呼び出し元には自分の応答しか表示されません。

オプション

長押し	値 (Value)	Required	説明
--message <text>	string	○	RemoteSessionAgent がエコー バックするテキストです。これは、同時発信者の応答を見分けるのに役立ちます。

例

uip rpa remote echo --message "ping"

UIP RPA リモート実行

構成したリモート エージェントでシェル コマンドを実行し (Windows の場合はcmd.exe /c 、それ以外の場合は /bin/sh -c )、出力をライブでストリーミングして戻します。ローカル モードはありません。これは常にリモート マシンで実行されます。

オプション

長押し	値 (Value)	Required	説明
--command <cmd>	string	○	リモートで実行するためのシェルコマンドライン (例:dir、 ls -la)。パッケージの復元時 (以下を参照) には、パッケージ フォルダーを基準とした相対パスを指定できます。
--package-id <id>	string	条件付き	コマンドを実行する前にリモート マシンに復元する NuGet パッケージ。一緒に --package-version する必要があります。
--package-version <v>	string	条件付き	復元する --package-id のバージョンです。--package-idが設定されている場合は必須です。一方を他方なしで渡すと、クライアント側では失敗します。
--working-directory <dir>	string	×	コマンドの作業ディレクトリ。パッケージの復元時に復元されたパッケージ フォルダーが既定で使用されます。既定値は、リモート マシンの現在のディレクトリです。
--timeout <seconds>	Number	×	この秒数後にコマンドを強制終了します。タイムアウトなしで省略します。

例

uip rpa remote exec --command "dir" --timeout 30

uip rpa リモート upload-file

設定したリモート エージェントにローカル ファイルをアップロードします。このファイルは、Orchestrator の一時的なストレージ バケットを介して転送されます (自動的に作成および削除されます)。

オプション

長押し	値 (Value)	Required	説明
--local-path <path>	string	○	アップロードするローカル ファイルへのパスです。
--remote-path <path>	string	○	リモート マシンのダウンロード先のパス。親ディレクトリが作成されます。

例

uip rpa remote upload-file --local-path ./data.csv --remote-path "C:\Bots\data.csv"

UIP RPA リモート ダウンロード ファイル

設定したリモート エージェントからローカル パスにファイルをダウンロードし、Orchestrator の一時的なストレージ バケットを介して転送します。

オプション

長押し	値 (Value)	Required	説明
--remote-path <path>	string	○	ダウンロードするリモート マシン上のファイルのパスです。
--local-path <path>	string	○	ローカルの宛先パス。親ディレクトリが作成されます。

例

uip rpa remote download-file --remote-path "C:\Bots\output.log" --local-path ./output.log

関連

• uip rpa run/debug — このグループのターゲットが設定する--remoteフラグです。
• uip rpa uia — remote start がアクティブになるとリモートで駆動されます。

参照

• RPA ツールの概要
• グローバル オプション
• 終了コード