uip or

「uip または」ツールを使用して、Orchestrator のジョブ、フォルダー、プロセス、パッケージ、マシン、ユーザー、ロール、ライセンス、ランタイム リソースを管理します。

Orchestrator ツールはuip orです。Orchestrator は、UiPath Orchestrator テナント上で、ジョブ、フォルダー、プロセス、パッケージ、マシン、ユーザー、ロール、ライセンス、フィード、添付ファイル、およびオートメーションが依存する実行時リソース (アセット、バケット、キュー、トリガー、ライブラリ、Webhook) を管理します。uip tools install orを使用してインストールするか、uip or … を呼び出して自動インストールを実行します。インストール モデルについては「 ツール (プラグイン) 」を、ツールのインストールを管理するコマンドについては「 uip tools 」をご覧ください。

リソース

各リソースには、独自のリファレンス ページがあります。各ページに設定された動詞は、 uip or によって登録されたコマンドと一致します— uip or --help を実行して、インストールの完全な表面を確認します。

リソース	目的
ジョブ	プロセスの実行を開始、停止、再開、再開、および検査するログ、トレース、修復データ、ステート履歴を取得する
folders	フォルダーを作成、一覧表示、移動、編集、削除します。ランタイム割り当てを検査します。
プロセス	パッケージを実行可能なプロセスとしてフォルダーにバインドする更新、ロールバック、編集。
パッケージ	.nupkgオートメーション パッケージとそのエントリ ポイントをアップロード、ダウンロード、リスト表示、および調査します。
マシン	マシン テンプレートとスロット割り当てを管理するマシンをフォルダーに割り当てます。
ユーザー	Orchestrator ユーザーを作成、編集、削除、割り当てるテナント レベルのロールの割り当てを管理する
ロール	ロール、権限、ロール ユーザー メンバーシップをテナントおよびフォルダーの範囲で管理します。
ライセンス	ランタイム ライセンスと指定ユーザーライセンスの割り当てのリストマシン ライセンスを切り替えます。テナント ライセンスの概要の表示
フィード	現在のユーザーが利用可能なパッケージ フィードのリストを取得します。
添付ファイル	ジョブの添付ファイルのリストを取得およびダウンロードします。
アセット	オートメーションが実行時に使用する名前付き設定値 (Text、Bool、Integer、Credential、Secret) です。フォルダー範囲。
バケット	オートメーションで使用するファイルのストレージ コンテナーです。フォルダー範囲。
bucket-files	バケット内の個々のファイル署名済み URL のリストを取得、アップロード、ダウンロード、削除、取得します。
ライブラリ	再利用可能な .nupkg パッケージ (共有アクティビティとロジック)テナント範囲です。
キュー	トランザクション作業項目のコンテナー。フォルダー範囲。
queue-items	キュー内の個々のトランザクション (ステートマシンによる完全な制御)フォルダー範囲。
トリガー	ジョブを開始するタイム トリガー、キュー トリガー、および API トリガー。タイム トリガー/キュー トリガーはフォルダー範囲です。API トリガーはテナント範囲です。
Webhook	HTTP コールバックは、プラットフォーム イベント (ジョブの完了、キュー アイテムの失敗など) で発生します。テナント範囲です。
資格情報ストア	Credential/Secret アセットと Azure/Amazon バケットで使用される外部資格情報ストアの構成を一覧表示して検査します。

デプロイ済みパッケージの実行時の評価 (実行の送信、出力のスコアリング、Orchestrator プロセスに対する評価器/評価セット/スケジュールの管理) は、独立したスタンドアロン ツールです。 uip eval (すべての動詞は Orchestrator のプロセス/フォルダーに対して動作しますが、パッケージ @uipath/eval-toolではなく、uip or のサブコマンドではありません)。

概要

uip or <resource> <verb> [options]

常に uip orし、 uip orchestratorすることはありません。orツールのコマンドプレフィックスです(uip tools listの「commandPrefix」列を参照)。

このセクションの読み方

すべてのリソース ページは、次のように同じように構成されています。

1. 書式 — uip or <resource> <verb> コマンド図形。
2. 動詞 — リソースが公開するすべての動詞の 1 行の表。
3. 動詞ごとに 1 つの H2 — 説明、位置引数 (存在する場合)、フラグテーブル、3 つの例 (最も単純で、一般的なケースで、--output-filterでスクリプト化しやすい)、および --output jsonで返されるData形状。
4. 終了コード — 共有 終了コード コントラクトへのポインターで、動詞固有のオーバーライドはインラインで呼び出されます。
5. 関連コマンド と 関連項目 — 兄弟リソースと関連する概念ページへの相互リンク。

既定の出力形式は --output jsonです。すべてのページのデータシェイプは JSON ペイロードを反映しており、テーブル、yaml、プレーンレンダリングは同じ Data オブジェクトから派生しています。

共通フラグ

ほとんどのリソースで、少数のフラグ セットが繰り返されます。彼らはどこに現れても同じように振る舞います。

フラグ	使用者	目的
--folder-path <path>	フォルダーをスコープとするほとんどの動詞	完全修飾パス ( Shared、 Production/EUなど) によるターゲット フォルダー です。
--folder-key <key>	フォルダーをスコープとするほとんどの動詞	GUID によるターゲット フォルダー。--folder-pathと相互に使用可能。どちらも同じフォルダーを解決します。
--all-folders	list 一部のフォルダー範囲のリソース (例: assets、 buckets)	呼び出し元がアクセスできるすべてのフォルダーに範囲を絞るのではなく、フォルダー全体を一覧表示します。サポートされている場合、 --folder-path、 --folder-key、 --all-folders のいずれかが必要です。
-l, --limit <number>	すべてのリスト動詞	ページ サイズデフォルトはCLIの DEFAULT_PAGE_SIZE (執筆時点では50)です。
--offset <number>	すべてのリスト動詞	戻るまでにスキップする項目の数。既定値は [ 0です。
--sort-by <field>	ほとんどのリスト動詞	OData の並べ替え式 ( Name asc、 Id descなど) を使用します。各動詞は、そのデフォルトを文書化します。
--all-fields	多くの list / get 動詞	選定された概要ではなく、生の API 応答を返します。既定の図形で省略されているフィールドが必要な場合に便利です。
-y, --yes	すべての破壊的 (delete) 動詞	操作を確定します。必須 — CLI は、破壊的なアクションを対話的に求めません。

動詞レベルのフラグ (フィルター、入力/出力パス、戦略、優先度) は、各リソース ページに記載されています。

ランタイムとリソースの規則

ランタイム リソース ページ (アセット、バケット、バケット ファイル、ライブラリ、キュー、キュー アイテム、トリガー、Webhook) では、上記の規則に加えていくつかの追加の規則があります。

• フォルダーの範囲設定アセット、バケット、キュー、キュー アイテム、トリガー (タイム/キュー) はフォルダー スコープになります。い ずれかの --folder-path <path> を指定します (例:"Shared")、または list、create、および関連する呼び出しの--folder-key <guid> (または、このフラグがサポートされている--all-folders)。get、 update、および delete 可能な場合は、クロスフォルダーをキーで解決します。リソース ページの各動詞の説明では、その動詞を明示的に呼び出しています。ライブラリ、API トリガー、Webhook はテナントを対象範囲としており、 --folder-*は使用できません。
• キー。ほとんどのリソースは list 出力で返される GUID によって識別されます ( key、 identifier、またはキュー アイテムの場合は 1 回の試行で uniqueKey 、再試行チェーンで key )。数値 id フィールドは内部であり、コマンドに渡さないでください。
• フィルター。サポートされている場合、 -n, --name <name> はリソース名のcontains-matchです。一部のリソースでは、 --enabled、 の --disabled、 --statusなどが追加されます。

グローバルオプションと終了コード

すべての uip or 動詞は、4 つの グローバル オプション (--output、 --output-filter、 --log-level、 --log-file) に従います。終了コードは共有 コントラクトに従います。動詞固有のオーバーライドは、関連するリソース ページで呼び出されます。

参照

• 概念: UiPath CLI の構成方法 — ホスト + ツール モデルの中でツールが適合する場所。
• セッション — テナントとフォルダーのコンテキストがどのように解決されるか。
• 構成 — すべてのツールに影響を与える環境変数と構成ファイル。
• 「クイックスタート 」および 「最初のパイプライン」 — エンドツーエンドのチュートリアルで、 uip orを実践できます。