UIP エージェントのデプロイ

uip agent deploy 以前にパブリッシュ済みのエージェント パッケージのバージョンを Orchestrator フォルダーにインストールしてアクティベーションします。ソリューションの完全なデプロイ パイプライン (設定→デプロイ→インストール→プロビジョニング→アクティブ化) を実行し、各フェーズが最終状態になるまでポーリングを行います。

既定では、このコマンドではターゲット フォルダーも プロビジョニング され、すぐに実行できるようになります。テナント レベルのサーバーレス マシン テンプレートを割り当て、 Automation User ロールを持つロボット ユーザーがそのフォルダーにバインドされます。プロビジョニングの失敗は、エラーではなく警告として表示されます (マシンとユーザーは、事後に手動で割り当てることができます)。

アクティブな CLI セッション (uip login) が必要です。

概要

uip agent deploy <packageVersionKey>
                 [-n <name>]
                 [--folder-key <guid>]
                 [--force-activate] [--skip-activate]
                 [-t <tenant>]
                 [--timeout <seconds>]
                 [--login-validity <minutes>]

すべての uip agent deploy 呼び出しでは、 グローバル オプション (--output、 --output-filter、 --log-level、 --log-file) が優先されます。終了コードは 標準コントラクトに従い、デプロイ固有のオーバーライドを次に示します。

引数

• <packageVersionKey> (必須) — uip agent publish によって返されるパッケージ バージョン キー (既定のアップロード パス)。Guid。

オプション

フラグ	既定 (Default)	目的
-n, --name <name>	agent-<timestamp>	デプロイ名。Orchestrator での表示名になり、(自動作成されたフォルダーの場合は) フォルダー名になります。
--folder-key <guid>	— (自動作成)	インストール フォルダー キー (GUID)。省略した場合は、インストール時に新しいフォルダーが自動的に作成されます。
--force-activate	無効	以前のデプロイがこの構成キーに存在する場合でも、強制的にアクティブ化します。
--skip-activate	無効	インストール フェーズが終わったら停止します。アクティベートしないでください。エージェントをリリースする前にインストールを確認する場合に便利です。
-t, --tenant <tenant>	テナントにログイン	対象のテナント。ログイン セッションに既定のテナントがない場合は必須です。
--timeout <seconds>	120	各ポーリング フェーズ (インストール、アクティブ化) が終了状態に達するまで待機する最大秒数。タイムアウト時に、コマンドはコード 2で終了します。
--login-validity <minutes>	10	トークンの有効期間は、最小時間 (分) です。

例

# Deploy to an auto-created folder named "invoice-agent"
uip agent deploy a1b2c3d4-0000-0000-0000-000000000050 --name invoice-agent

# Deploy into an existing folder
uip agent deploy <PackageVersionKey> --folder-key <FolderGuid>

# Install only; do not activate (review in Orchestrator first)
uip agent deploy <PackageVersionKey> --skip-activate

# Force re-activation of a replacement deployment
uip agent deploy <PackageVersionKey> --force-activate

# Longer timeout for slow environments
uip agent deploy <PackageVersionKey> --timeout 600

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

インストール + アクティブ化の完了 (Code: "AgentDeploy"):

{
  "Code": "AgentDeploy",
  "Data": {
    "DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000060",
    "DeploymentName": "invoice-agent",
    "Status": "SuccessfulActivate",
    "FolderKey": "a1b2c3d4-0000-0000-0000-000000000070",
    "FolderId": 42,
    "FolderName": "invoice-agent",
    "ConfigurationKey": "a1b2c3d4-0000-0000-0000-000000000080",
    "PackageVersionKey": "a1b2c3d4-0000-0000-0000-000000000050"
  }
}

インストールのみ (--skip-activate またはアクティブ化の準備ができていない): 同じ形状で、 Status はインストール フェーズ (SuccessfulInstall、 FailedInstall) を反映し、フォルダーを解決できなかった場合は省略 FolderName 。

• FolderId — フォルダーの組織単位の数値 ID です。自動プロビジョニングが成功した場合にのみ表示されます。それを uip agent run list --folder-idに直接渡します。
• FolderKey — インストール フォルダーの GUID。
• ConfigurationKey — このデプロイによって作成されるソリューション Configuration のキーです。
• PackageVersionKey — 便宜上、入力からエコーバックされます。

終了コード

標準のCLIコードに加えて:

• 0 — インストール (およびオプションでアクティベーション) が正常に完了しました。
• 1 — デプロイの失敗 (FailedInstall、 FailedActivate)、ポーリング エラー、またはその他のエラー
• 2 — ポーリング フェーズがタイムアウトしました ( --timeoutを参照)。Orchestrator でデプロイは完了する可能性があります。より長いタイムアウトで再実行するか、Orchestrator UI でステータスを検査します。

共有コントラクト の終了コード を参照してください。

プロビジョニングの詳細

フォルダーが自動作成される ( --folder-keyなし) 場合、デプロイは次のことを試みます。

1. テナントレベルのサーバーレス マシン テンプレートをフォルダーに割り当てます。テナントにサーバーレス テンプレートが存在しない場合、プロビジョニングは失敗し、デプロイ時に警告が表示されます。テンプレートは手動で割り当てる必要があります。
2. 割り当て可能なユーザーを選択し、フォルダーで Automation User ロールを付与します。テナントにそのようなロールが存在しない場合、プロビジョニングは失敗し、警告が表示されます。

マシンまたはユーザーの割り当て中の競合 (HTTP 409) は、べき等な成功として扱われます。

関連

• uip agent publish — このコマンドが使用するPackageVersionKeyを生成します。
• uip agent run start — デプロイされたフォルダー内のリリースに対してジョブを開始します。
• uip agent run list — デプロイで作成されたリリースのリストを表示します。

参照

• Orchestrator: ジョブ — 基になるジョブ モデルです。
• 認証 — セッション、テナント、および --login-validity。
• グローバル オプション、 終了コード。