uip solution deploy

「uip solution deploy」の構文とオプション。このデプロイは、Orchestrator にソリューションのデプロイをインストール、アップグレード、アクティブ化、アンインストールします。

uip solution deploy パブリッシュ済みのソリューション パッケージ (uip solution publishを参照) を Orchestrator にインストールします。フォルダーの作成、リソース (キュー、アセット、プロセス、バケット、コネクション) のプロビジョニング、デプロイのアクティブ化を行います。

このページでは、 のすべてのサブコマンドについて説明します deploy。

注:

run, status, and list accept --feed <name-or-key> to work with a folder feed. Refer to uip solution feeds to list the feeds you can reach. For more information about folder feeds, refer to Solution feed in the Solutions Management documentation.

サブコマンド	目的
run	Install a deployment from a published package.
upgrade	Move an existing deployment to another published version of its package, in place.
status	Check the state of a deployment, by name or key, or the progress of a pipeline deployment run.
list	既存のデプロイを一覧表示します。
activate	自動アクティブ化せずにインストールされたデプロイをアクティブ化します。
uninstall	デプロイとそのプロビジョニングされたリソースを削除します。
delete	Delete a deployment record that uninstall cannot remove.
config get	パッケージの既定のデプロイ設定を取得します。
config set	デプロイ構成ファイルでリソース プロパティを設定します。
config link	ソリューション リソースを既存の Orchestrator リソースにリンクします。
config unlink	デプロイ構成ファイルからリソース リンクを削除します。

すべてのサブコマンドが認証されます。最初に uip login を実行します。

一般的なワークフロー

deploy config get  →  deploy config set / link  →  deploy run  →  deploy status
                                                       │
                                                       ├─→ deploy activate   (if not auto-activated)
                                                       ├─→ deploy upgrade    (new package version, same deployment)
                                                       └─→ deploy uninstall  (tear down)  →  deploy delete

deploy run is keyed on --name. A name that does not exist yet gets a new deployment in a new folder. If the package is already deployed, deploy run stops and points to deploy upgrade, which moves the existing deployment to another version in place. To install a second, separate copy, pass -y, --yes with a different --name.

---

uip solution deploy run

Install a solution deployment in Orchestrator from a published package. Creates a new folder (under --parent-folder-path or --parent-folder-key, or the current user's Personal Workspace), provisions every resource described in the package (or in --config-file), and, unless --skip-activate is set, activates it.

The deployment is keyed on --name. Before installing, the command checks whether the package already has a deployment; if so, it stops and points to deploy upgrade. The check is best-effort: a lookup failure only warns, and under an External Application (client-credentials) login an existing deployment is reported as a warning instead of stopping the deploy.

The package is validated against the target before anything is installed. A validation failure ends the run at ValidationFailed with the errors in Instructions, and nothing is installed. The rejected attempt is kept as a pending draft: fix the configuration and re-run the same command, and the server validates the draft again with the new file. Settings and resource links that the file does not name keep the values the draft was rejected with.

概要

uip solution deploy run \
  --name <deployment-name> \
  --package-name <name> \
  --package-version <version> \
  --folder-name <name> \
  [--parent-folder-path <path> | --parent-folder-key <guid> | --personal-workspace] \
  [--feed <name-or-key>] \
  [--config-file <path>] \
  [--skip-activate] \
  [-y, --yes] \
  [--acknowledge-permanent-deletion] \
  [--timeout <seconds>] \
  [--poll-interval <ms>] \
  [--login-validity <minutes>]

オプション

長押し	値 (Value)	既定 (Default)	説明
-n, --name <deployment-name>	text	—	Required. Name for the deployment. Used by deploy status, deploy upgrade, deploy activate, deploy uninstall, and deploy delete to identify this install.
--package-name <name>	text	—	必須。ソリューション パッケージ名。packages list を使用して使用可能な名前を検索します。
--package-version <version>	text	—	必須。ソリューション パッケージのバージョンです。
--folder-name <name>	text	—	必須。このデプロイ用に作成された新しい Orchestrator フォルダーの名前です。
--parent-folder-path <path>	パス	—	親フォルダーのパス (例: Shared)。その下にデプロイ フォルダーが作成されます。--parent-folder-key および --personal-workspaceと相互に排他的です。
--parent-folder-key <key>	GUID	—	親フォルダー キー。--parent-folder-pathの代替手段です。
--personal-workspace	フラグ	無効	Deploy into the current user's Personal Workspace. The workspace name is resolved from Orchestrator automatically. Requires a user login; an External Application has no Personal Workspace. Mutually exclusive with --parent-folder-path, --parent-folder-key, and --feed.
--feed <name-or-key>	text	テナント フィード	Deploy a package published to this feed (name or folder key, from solution feeds list) instead of the tenant feed. This scopes which feed the package comes from — the --parent-folder-path/--parent-folder-key/--personal-workspace flags still control where the Orchestrator folder is created. Requires a user login; an External Application login is refused instead of deploying to the tenant feed. Mutually exclusive with --personal-workspace.
--config-file <path>	パス	—	JSON または YAML 構成ファイル。deploy config getで生成し、config set / config linkで編集して、ここに渡します。
--skip-activate	フラグ	無効	自動アクティブ化をスキップします。デプロイを Inactive (Ready to activate) ステートのままにします。後で deploy activateでアクティベーションします。
-y, --yes	フラグ	無効	Deploy even when this package already has a deployment. Without it, the command looks the package up and stops if it is already deployed. The check is best-effort: a lookup failure only warns, and under an External Application (client-credentials) login an existing deployment is reported as a warning instead of stopping the deploy. --yes only skips the check. Re-using an existing deployment's --name updates that deployment in place; pass a different --name for a separate copy.
--acknowledge-permanent-deletion	フラグ	無効	Confirm that installed resources this deployment replaces with a link are permanently deleted, along with their data. Without it, the deploy stops at the server's confirmation request, lists those resources, and installs nothing. With it, the CLI acknowledges each listed resource and runs the same install once more, within the same --timeout. Independent of --yes. Refer to Permanent deletion of replaced resources.
--timeout <seconds>	秒	360	ポーリング タイムアウトはフェーズごとに適用されます — デプロイし、(スキップされない場合) アクティブ化します。
--poll-interval <ms>	ミリ秒	5000	デプロイ フェーズとアクティブ化フェーズでのステータス ポーリング間の間隔 (ミリ秒)。
--login-validity <minutes>	分	10	更新をトリガーするまでの最小分単位: トークンの有効期限が切れるまでの最小分単位です。

例

共通

uip solution deploy run \
  --name my-deployment \
  --package-name my-package \
  --package-version 1.0.0 \
  --folder-name MySolution \
  --parent-folder-path "Shared"

自動アクティブ化をスキップ

uip solution deploy run \
  --name my-deployment \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolution --parent-folder-path "Shared" \
  --skip-activate

Into the Personal Workspace

uip solution deploy run \
  --name my-deployment \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolution --personal-workspace

既にデプロイ済みのパッケージの 2 番目の独立したコピー

uip solution deploy run \
  --name my-deployment-2 \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolutionCopy --parent-folder-path "Shared" --yes

フォルダー フィードから

uip solution deploy run \
  --name my-deployment \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolution --feed Finance

カスタマイズされた構成

uip solution deploy config get my-package -d ./deploy-config.json
uip solution deploy config set ./deploy-config.json MyQueue maxNumberOfRetries 5

uip solution deploy run \
  --name my-deployment \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolution --parent-folder-path "Shared" \
  --config-file ./deploy-config.json

スクリプティング — フォローアップ コールのデプロイ ID をキャプチャします。

PIPELINE_ID=$(uip solution deploy run \
  --name my-deployment \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolution --parent-folder-path "Shared" \
  --output-filter "PipelineDeploymentId" --output plain)

uip solution deploy status "$PIPELINE_ID"

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

The command waits for the deployment to finish, bounded by --timeout:

{
  "Code": "SolutionDeployRun",
  "Data": {
    "Status": "DeploymentSucceeded",
    "DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000001",
    "InstanceId": "c3d4e5f6-0000-0000-0000-000000000001",
    "FolderName": "MySolution",
    "FolderPath": "Shared/MySolution",
    "ActivationStatus": "SuccessfulActivate"
  }
}

A deployment that installed but needs Setup activation in Orchestrator before it can be activated returns Result: Success with ActivationStatus: NeedsSetupToActivate. Do not deploy it again; configure the listed resources and activate it:

{
  "Code": "SolutionDeployRun",
  "Data": {
    "Status": "DeploymentSucceeded",
    "DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000003",
    "PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000003",
    "InstanceId": null,
    "FolderName": "MySolution",
    "FolderPath": "Shared/MySolution",
    "ActivationStatus": "NeedsSetupToActivate",
    "PendingResources": [
      {
        "Kind": "connection",
        "Name": "Outlook",
        "Type": "uipath-microsoft-outlook365",
        "Reason": "[CNS1072] You will need to authenticate this connection before proceeding further"
      }
    ],
    "NextSteps": [
      "Deployment 'my-deployment' is installed at version 1.0.0 but not live: it needs 'Setup activation' before it can be activated.",
      "Resources that need configuration: connection 'Outlook' (uipath-microsoft-outlook365): [CNS1072] You will need to authenticate this connection before proceeding further."
    ]
  }
}

With --skip-activate, ActivationStatus is Skipped.

RequestedFolderName と FolderNote は、要求された --folder-name がすでに実行されている場合にのみ表示されます。 Orchestrator はフォルダーを再利用するのではなく競合で名前を変更するため、実際の FolderName/FolderPath は要求されたものとは異なります。 FolderNote は、名前を変更したフォルダーを使用するか、フリー名で再実行するかを選択するためのポインターとともに説明します。

ターミナルのデプロイのステータス: DeploymentSucceeded、DeploymentFailed、ValidationFailed、ConflictFixingError、DeploymentScheduleError非成功 ターミナル ステートは 1 で終了し、検証/競合/スケジュール/ワークフロー エラーを [ Instructions ] フィールドに集約します。

Permanent deletion of replaced resources

When a deployment or upgrade replaces an installed resource with a link — for example after deploy config link — the server permanently deletes the installed resource, with its data, when the run goes ahead. It asks for confirmation first: the run stops at DeploymentScheduleError until the deletion is acknowledged. This section applies to both deploy run and deploy upgrade.

Without --acknowledge-permanent-deletion, the command fails with exit code 1, ErrorCode: invalid_argument, and Retry: RetryWillNotFix. Nothing is installed, and the attempt is kept as a pending draft. The message names each resource that would be deleted. The failure envelope's Data carries PipelineDeploymentId, DeploymentKey (the kept draft), and PermanentDeletionResources, one entry per resource:

フィールド	説明
Key	The resource key on the deployment.
Kind	The resource kind the server reports, or null.
Name	The resource name, or its key when it has no name.

Instructions names both ways forward:

• To confirm the deletion, re-run the same command with --acknowledge-permanent-deletion.
• To keep the installed copies on deploy run, remove those links from the --config-file with deploy config unlink, then re-run. On deploy upgrade, discard the draft and upgrade without those links, or remove the links from the deployment in Orchestrator first.

With --acknowledge-permanent-deletion, the command reads the resources the server wants confirmed, acknowledges each one, and runs the same install once more. It only confirms deletions it can name:

• If the list of resources cannot be read, nothing is acknowledged, nothing is installed, and the command fails.
• If the server refuses an acknowledgement, the install is not run again. Resources acknowledged before the failure stay acknowledged on the draft. A 404 means the server does not offer the acknowledge route yet; confirm the deletion in Orchestrator instead.
• If the deployment changed under the run, the install is not run again, and Instructions asks you to review the deployment in Orchestrator, because the acknowledgement is sent to the deployment by name.
• If the server asks for confirmation again after every listed resource was acknowledged, the command stops instead of looping.

When the re-run install succeeds, the deleted resources appear in Data.PermanentlyDeletedResources. If the re-run is refused before it runs, nothing is deleted yet, but the acknowledgement stays on the kept draft, so running the same command again deletes those resources without asking.

タイムアウト時の動作

--timeout が経過する前にデプロイが終了状態に達しない場合、コマンドは 0 以外の状態を終了し、deploy status <pipeline-deployment-id> へのポインターを付けて監視を続行できます。

故障モード

• The package already has a deployment. Refused unless -y, --yes is passed. Use deploy upgrade to move the existing deployment to a new version, or pass --yes with a different --name to install a second, separate copy.
• Validation failed. The run ends at ValidationFailed and nothing is installed. The rejected attempt is kept as a pending draft; fix the configuration and re-run the command. When the run was an update of an existing deployment, Instructions also names the deploy upgrade <deployment-key> --discard-draft --version <version> command that discards the draft and upgrades the live version instead.
• --name has a pending draft for another version. Refused. Re-run with the draft's --package-version to retry the draft, or discard it with deploy upgrade --discard-draft.
• --name 存在し、別の --package-nameにバインドされています。完全に失敗する — デプロイ名は を介してパッケージを切り替えることができ deploy run。
• --name のデプロイはすでに進行中です。失敗 – 前の操作が最初に完了する必要があります。

---

UIP ソリューションのデプロイのアップグレード

Upgrade an existing deployment to another published version of its package, in place. This is the CLI equivalent of the Upgrade button in Orchestrator. Use it when deploy run stops because the package is already deployed. The deployment's existing configuration is preserved, so values already set on it (for example a credential asset's secret) are not reset to the package defaults.

The package is validated against the target before anything is installed. A validation failure reports the errors and leaves the deployment on its current version. The command waits for the upgrade to finish unless --no-wait is passed; track a running upgrade with deploy status <pipeline-deployment-id>.

概要

uip solution deploy upgrade <deployment-key> [options]
uip solution deploy upgrade --name <deployment-name> --package-name <name> [options]

Address the deployment either by key or by --name with --package-name, not both.

引数

• [deployment-key] — Key of the deployment to upgrade, as deploy list reports it (Key), or a stored InstallDeploymentKey. The deployment's name, package, current version, and feed are read from the server, so --package-name and --personal-workspace are not needed. Use either this or --name with --package-name.

オプション

長押し	値 (Value)	既定 (Default)	説明
-n, --name <deployment-name>	text	—	Name of the deployment to upgrade, as reported by deploy list. Goes with --package-name. The command checks that the name exists before installing, so a mistyped name is refused instead of creating a new deployment.
--package-name <name>	text	—	The deployment's package. Required with --name.
--version <version>	text	newest published	Target package version. Any published version of the same package is accepted, including an older one. An empty value is refused.
--personal-workspace	フラグ	無効	With --name: upgrade a deployment in your Personal Workspace feed instead of the tenant. With a key, the feed is read from the deployment and this flag is not needed.
--acknowledge-permanent-deletion	フラグ	無効	Confirm that installed resources the new version replaces with a link are permanently deleted, along with their data. Without it, the upgrade stops at the server's confirmation request, lists those resources, and installs nothing. With it, the CLI acknowledges each listed resource and runs the same upgrade once more, within the same --timeout, and re-runs a pending draft of the same version that waits for this confirmation instead of refusing it. Has no effect with --no-wait, which never sees the run end. Refer to Permanent deletion of replaced resources.
--discard-draft	フラグ	無効	When the deployment has a pending draft (an earlier attempt that never completed, usually one rejected by validation), discard the draft first and upgrade the live version. Without it, such a deployment is refused, because the server would re-run the draft with the configuration it was rejected for. With --name, the draft is found only under a user login; under an External Application, pass the deployment key.
--no-wait	フラグ	無効	アップグレードが完了するのを待つのではなく、アップグレードが受け入れられたらすぐに戻ってください。
--timeout <seconds>	秒	300	アップグレードが完了するまで待機する時間です (秒)。
--poll-interval <ms>	ミリ秒	5000	ステータス ポーリングの間隔 (ミリ秒)。
--login-validity <minutes>	分	10	更新をトリガーするまでの最小分単位: トークンの有効期限が切れるまでの最小分単位です。

Both forms work under an External Application (client-credentials) login, so they can run from a CI/CD pipeline. A deployment in a Personal Workspace or folder feed requires a user login. The --name form has no --feed option; to upgrade a deployment in a folder feed, pass its key.

例

# By key, to the newest published version
uip solution deploy upgrade c3d4e5f6-0000-0000-0000-000000000003

# By name, to the newest published version
uip solution deploy upgrade --name my-deployment --package-name my-package

# To a specific published version (for example from a CI/CD pipeline)
uip solution deploy upgrade --name my-deployment --package-name my-package --version 1.5.0

# Start the upgrade without waiting
uip solution deploy upgrade --name my-deployment --package-name my-package --no-wait

# Discard the pending draft a rejected attempt left behind, then upgrade the live version
uip solution deploy upgrade c3d4e5f6-0000-0000-0000-000000000003 --version 2.0.0 --discard-draft

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

Upgrade by key:

{
  "Code": "SolutionDeployUpgrade",
  "Data": {
    "Status": "DeploymentSucceeded",
    "Operation": "VersionChange",
    "DeploymentStatus": "SuccessfulActivate",
    "Actions": ["Uninstall", "Upgrade"],
    "DeploymentName": "my-deployment",
    "FromVersion": "1.5.0",
    "ToVersion": "2.0.0",
    "PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000002",
    "DeploymentKey": "d4e5f6a7-0000-0000-0000-000000000004",
    "InstallDeploymentKey": "c3d4e5f6-0000-0000-0000-000000000003"
  }
}

--no-wait:

{
  "Code": "SolutionDeployUpgrade",
  "Data": {
    "Status": "Accepted",
    "DeploymentName": "my-deployment",
    "ToVersion": "2.0.0",
    "PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000002"
  }
}

フィールド	説明
Status	Terminal pipeline status (DeploymentSucceeded), or Accepted when --no-wait returned before the upgrade finished.
Operation	What the server did: VersionChange for a version move, or ConfigurationChange when the requested version was already deployed. Absent with --no-wait.
DeploymentStatus	SuccessfulActivate when the new version runs, or SuccessfulInstall when it is installed but waits for activation setup (the previous version keeps running). Absent with --no-wait.
Actions	Operations available on the deployment next (for example SetupActivation, Uninstall, Upgrade).
ActivationStatusPendingResources、NextSteps	Present when the new version does not run yet, for example ActivationStatus: NeedsSetupToActivate with the resources that need configuration. Same shape as deploy run.
FromVersion	Version deployed before the upgrade. Key form only.
ToVersion	Version the upgrade targeted.
PipelineDeploymentId	ID of the pipeline run that performs the upgrade. Pass it to deploy status.
DeploymentKey	Key of the upgraded deployment record. Absent with --no-wait.
InstallDeploymentKey	Key of the original install. It stays the same across upgrades, so it is the key to store. Key form only.
DiscardedDraftKey	Key of the pending draft that --discard-draft deleted. Present only when one was discarded.

故障モード

• Both a key and --name passed, or --name without --package-name. Refused.
• No deployment found for the key, or for the name in that feed. Refused.
• The deployment is uninstalled. Refused, because an install would create a new deployment. Use deploy run to deploy the package again.
• The deployment has a pending draft. Refused unless --discard-draft is passed.
• The deployment is in a Personal Workspace or folder feed and the login is an External Application. Refused; use a user login.
• The target version is not published in the feed. Refused.
• Validation, conflict fixing, scheduling, or the install failed. The command exits with 1 and reports the errors. The deployment stays on the version it was already running. When the failure left a pending draft, Instructions names the --discard-draft command to retry with.
• The new version replaces installed resources with links. Refused unless --acknowledge-permanent-deletion is passed, as described in Permanent deletion of replaced resources.
• Timeout. The upgrade did not finish within --timeout. It may still be running; check it with deploy status <pipeline-deployment-id>.

---

uip solution deploy status

Check the state of a deployment by name, or by a deployment key from deploy list or deploy upgrade: operation, activation status, and what is left to do before it runs. The command also takes the pipeline deployment ID from deploy run and returns that run's progress and errors.

引数

• <deployment> (required) — Deployment name (preferred), a deployment key, or a pipeline deployment ID. A key is resolved across every feed, and a superseded key is answered with the deployment's current record.

オプション

長押し	値 (Value)	既定 (Default)	説明
--feed <name-or-key>	text	—	For a deployment name: the feed to look it up in (name or folder key, from solution feeds list). Without --feed or --personal-workspace, a name is looked up across the feeds. Mutually exclusive with --personal-workspace.
--personal-workspace	フラグ	無効	For a deployment name: look it up in your Personal Workspace feed instead of the tenant.
--login-validity <minutes>	分	10	更新をトリガーするまでの最小分単位: トークンの有効期限が切れるまでの最小分単位です。

--personal-workspace, and --feed with a deployment name, require a user login; an External Application login is refused.

例

# By deployment name
uip solution deploy status my-deployment

# By deployment key
uip solution deploy status a1b2c3d4-0000-0000-0000-000000000001

# By name, in your Personal Workspace feed
uip solution deploy status my-deployment --personal-workspace

# The pipeline deployment run that deploy run started
uip solution deploy status b2c3d4e5-0000-0000-0000-000000000001

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

A deployment addressed by name or key returns Code: SolutionDeployment. This example is a deployment that is upgraded but not live yet:

{
  "Code": "SolutionDeployment",
  "Data": {
    "DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000002",
    "Superseded": false,
    "CurrentDeploymentKey": "a1b2c3d4-0000-0000-0000-000000000002",
    "InstallDeploymentKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "Name": "my-deployment",
    "PackageName": "my-package",
    "PackageVersion": "2.0.0",
    "NewPackageVersionAvailable": null,
    "Operation": "VersionChange",
    "OperationStatus": "Successful",
    "DeploymentStatus": "SuccessfulInstall",
    "ActivationStatus": "NeedsSetupToActivate",
    "Actions": ["SetupActivation", "Uninstall", "Upgrade"],
    "PendingResources": [
      {
        "Kind": "connection",
        "Name": "Outlook",
        "Type": "uipath-microsoft-outlook365",
        "Reason": "[CNS1072] You will need to authenticate this connection before proceeding further"
      }
    ],
    "NextSteps": [
      "Deployment 'my-deployment' is installed at version 2.0.0 but not live: it needs 'Setup activation' before it can be activated.",
      "Resources that need configuration: connection 'Outlook' (uipath-microsoft-outlook365): [CNS1072] You will need to authenticate this connection before proceeding further."
    ]
  }
}

フィールド	説明
DeploymentKey	The key that was requested.
Superseded	true when a later operation replaced the requested record. The state fields then describe the current record, and NextSteps names the key to use. null when the chain of records could not be read.
CurrentDeploymentKey	Key of the deployment's current record.
InstallDeploymentKey	Key of the original install, stable across upgrades.
DeploymentStatus	SuccessfulActivate when the version runs, SuccessfulInstall when it waits for activation or its setup.
ActivationStatus	Activation state, for example Active, ReadyToActivate, or NeedsSetupToActivate. null when it could not be read.
Actions	Operations available on the deployment. null when they could not be read.
PendingResources	Resources that need configuration before activation. Present only when the deployment waits for setup.
NextSteps	What is left before the deployment runs. Absent when it runs.

A pipeline deployment ID returns Code: SolutionDeployStatus with the run's progress:

{
  "Code": "SolutionDeployStatus",
  "Data": {
    "PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000001",
    "Status": "DeploymentSucceeded",
    "DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "ConfigurationKey": "...",
    "InstanceId": "c3d4e5f6-0000-0000-0000-000000000001",
    "DeploymentResult": {
      "Name": "my-deployment",
      "PackageName": "my-package",
      "PackageVersion": "1.0.0",
      "Status": "Successful",
      "StartDate": "2026-04-15T10:30:00Z",
      "EndDate": "2026-04-15T10:31:12Z",
      "Errors": null
    }
  }
}

The pipeline service tracks a run only while it is active. After the run ends, check the deployment by name or key instead.

---

uip solution deploy list

ソリューションのデプロイのリストを表示します。デプロイ名、現在のパッケージ/ターゲット パッケージのバージョン、保留中の操作、アクティベーション ステータス、フォルダー パスが表示されます。

オプション

長押し	値 (Value)	既定 (Default)	説明
--folder-path <path>	パス	—	Filter by the full path of the folder the deployment was installed into (for example Shared or Shared/Finance). Exact match, not case-sensitive; subfolders are not included. Applied server-side.
--folder-key <key>	GUID	—	Filter by the key of the folder the deployment was installed into. Alternative to --folder-path. Applied server-side.
-l, --limit <number>	Number	50	取得するデプロイの最大数。
--offset <number>	Number	0	Number of deployments to skip.
--sort-by <column>	text	startTime	並べ替えの基準にする列です。
--sort-order <direction>	Ascending | Descending	Descending	並べ替え方向です。
--operation-status <statuses>	コンマ区切り	—	Server-side filter by operation status. One or more of Draft, Successful, Failed, InProgress, FailedRollback.
--activation-status <statuses>	コンマ区切り	—	Server-side filter by activation status. One or more of None, Active, Inactive, ActivationFailed, DeactivationFailed, ReadyToActivate, NeedsSetupToActivate.
--personal-workspace	フラグ	無効	現在のユーザーの個人用ワークスペース フィードからのデプロイのみを表示します。--feedと相互に排他的です。
--feed <name-or-key>	text	—	Only list deployments from this feed (name or folder key, from solution feeds list). Mutually exclusive with --personal-workspace.
--login-validity <minutes>	分	10	更新をトリガーするまでの最小分単位: トークンの有効期限が切れるまでの最小分単位です。

Both --operation-status and --activation-status reject values outside these lists, and the error message lists the valid values.

例

uip solution deploy list --limit 20 --folder-path "Shared/Production"

# Spot a pending in-place upgrade
uip solution deploy list --operation-status InProgress

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

{
  "Code": "SolutionDeployList",
  "Data": [
    {
      "Key": "a1b2c3d4-0000-0000-0000-000000000002",
      "InstallDeploymentKey": "b2c3d4e5-0000-0000-0000-000000000002",
      "Name": "billing-solution",
      "PackageName": "billing-solution",
      "PackageVersion": "1.0.0",
      "CurrentPackageVersion": "1.0.0",
      "TargetPackageVersion": "2.0.0",
      "NewPackageVersionAvailable": "2.0.0",
      "Operation": "VersionChange",
      "OperationStatus": "InProgress",
      "ActivationStatus": "Active",
      "FolderPath": "Shared/Billing",
      "FolderKey": "c3d4e5f6-0000-0000-0000-000000000002",
      "CreatedAt": "2026-04-15T10:30:00Z",
      "Actions": ["Upgrade"]
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 10, "Offset": 0, "Total": 1 }
}

Key is the value deploy upgrade and deploy status accept as a deployment key. NewPackageVersionAvailable is non-null when a newer published version exists than the one currently deployed. Actions lists operations currently available on the deployment (for example ["Upgrade"]).

---

uip solution deploy activate

自動アクティブ化せずにインストールされたデプロイをアクティブ化します。アクティブ化すると、すべてのソリューション コンポーネントがプロビジョニングされます。activate は、最初に Orchestrator によって ( --log-level info経由で stderr に) 報告されたアクティブ化前のステップを出力し、次に activate を呼び出して、終了状態 (SuccessfulActivate または FailedActivate) になるまでポーリングします。

引数

• <deployment-name> (必須) — アクティブ化するデプロイの名前。deploy listを使用してデプロイ名を検索します。

オプション

• --timeout <seconds> — アクティベーションポーリングタイムアウト。既定値は [ 360です。
• --poll-interval <ms> — ステータスポーリング間のミリ秒。既定値は [ 5000です。
• --login-validity <minutes> — デフォルトは 10です。

例

uip solution deploy activate my-deployment

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

{
  "Code": "SolutionDeployActivate",
  "Data": {
    "Status": "SuccessfulActivate",
    "DeploymentName": "my-deployment",
    "InstanceId": "b2c3d4e5-0000-0000-0000-000000000001"
  }
}

Orchestrator が instanceId を報告しない場合 (ポーリングするものがない場合)、 InstanceId は省略され、コマンドは正常に返されます。

---

uip solution deploy uninstall

デプロイしたソリューションをアンインストールします。プロビジョニングされたすべてのリソースとソリューション フォルダーを削除します。これは永続的な操作であり、元に戻すことはできません。

引数

• <deployment-name> (必須) — アンインストールするデプロイの名前。

オプション

• -y, --yes — 必須です。この元に戻せない操作を確認します。CLI はプロンプトを表示しません。
• --timeout <seconds> — ポーリングタイムアウトをアンインストールします。既定値は [ 360です。
• --poll-interval <ms> — ステータスポーリング間のミリ秒。既定値は [ 5000です。
• --login-validity <minutes> — デフォルトは 10です。

例

uip solution deploy uninstall my-deployment --yes

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

{
  "Code": "SolutionDeployUninstall",
  "Data": {
    "Status": "SuccessfulUninstall",
    "DeploymentName": "my-deployment",
    "InstanceId": "b2c3d4e5-0000-0000-0000-000000000001"
  }
}

成功の形態は次の 3 つあり、その形状は表示されるフィールドによって区別されます。

• イミディエイト — Orchestrator は最初の呼び出しで complete: true を報告します。ポーリングは行われません。Status/DeploymentNameのみが表示されます。
• スケジュール設定済み — Orchestrator はインスタンス ID を返すことなく作業をスケジュールします。 Scheduled フィールドが追加されます。
• ポーリング済み — 上記に示すように、 InstanceId が返され、コマンドによってポーリングが完了するまで行われます。

故障モード

• -y, --yesがありません。コマンドは確認せずに拒否します。
• The deployment cannot be uninstalled in its state (inactive after an uninstall, superseded, or left by a failed install). When the record offers Delete, Instructions points to deploy delete.

---

uip solution deploy delete

Delete a deployment record from the tenant. Use this for a deployment that deploy uninstall cannot remove: one left inactive after an uninstall, one superseded by a newer version, or one left behind by a failed install. Orchestrator refuses to uninstall those with error 4007.

The command finds the deployment by name across the feeds, then reads its available actions. When the record lists actions but not Delete, the command refuses and names the state and the actions that are available. When the record lists no actions, the request goes to the server, which decides.

引数

• <deployment-name> (required) — Name of the deployment to delete. Use deploy list to find deployment names.

オプション

• -y, --yes — Required. Confirms this irreversible operation; the CLI never prompts.
• --login-validity <minutes> — デフォルトは 10です。

例

uip solution deploy delete my-deployment --yes

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

{
  "Code": "SolutionDeployDelete",
  "Data": {
    "Status": "Deleted",
    "DeploymentName": "my-deployment",
    "DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000001"
  }
}

故障モード

• -y, --yesがありません。コマンドは確認せずに拒否します。
• No deployment with that name. Refused.
• The deployment offers Uninstall but not Delete. Refused. Run deploy uninstall <deployment-name> --yes first, then retry the delete.
• An operation is in progress on the deployment. Refused. Wait for the operation to finish, then retry.

---

uip solution deploy config get

パブリッシュ済みのソリューション パッケージの既定のデプロイ設定を取得します。この構成には、ソリューションが作成するすべてのリソース (キュー、アセット、プロセス、バケット、コネクションなど) が既定の設定とともにリストされます。ファイルをファイル(-d)に保存し、config set / config linkでカスタマイズして、deploy run --config-fileに渡します。

引数

• <package-name> (必須) — ソリューション パッケージ名。packages listを使用します。

オプション

長押し	値 (Value)	既定 (Default)	説明
--package-version <version>	text	最新	パッケージ バージョン。
-d, --destination <path>	パス	Stdout	stdout ではなくこのファイルに構成を書き込みます。
--format <format>	json | yaml	json	構成形式。
--login-validity <minutes>	分	10	更新をトリガーするまでの最小分単位: トークンの有効期限が切れるまでの最小分単位です。

例

uip solution deploy config get my-package --package-version 1.0.0 -d ./deploy-config.json

# YAML format
uip solution deploy config get my-package -d ./deploy-config.yaml --format yaml

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

-dが指定されている場合:

{
  "Code": "SolutionDeployConfig",
  "Data": {
    "Status": "Configuration written",
    "OutputPath": "/workspace/deploy-config.json",
    "PackageName": "my-package",
    "PackageVersion": "1.0.0",
    "State": "Ready",
    "Format": "json"
  }
}

-d省略すると、構成が応答に埋め込まれます。

{
  "Code": "SolutionDeployConfig",
  "Data": {
    "PackageName": "my-package",
    "PackageVersion": "1.0.0",
    "State": "Ready",
    "Format": "json",
    "Configuration": { "resources": [ "..." ] }
  }
}

---

uip solution deploy config set

デプロイ構成ファイルのリソース プロパティを編集します。ファイルは、deploy run --config-fileに渡すまでローカルのままです。

引数

• <file> (必須) — デプロイ構成ファイル JSON ファイル (config getによって生成) へのパス。
• <args...> (必須) — --allによって異なります。
  • --allなし : <resource> <property> <value> — 例:MyQueue maxNumberOfRetries 5。
  • With --all: <property> <value> — ファイル内のすべてのリソースに適用されます。最上位の conflictFixingAction プロパティに対してのみ有効です。

オプション

• --all - ファイル内のすべてのリソースにプロパティを適用します。conflictFixingAction (例:UseExisting)。

例

変更のリトライは 1 つのキューで行います

uip solution deploy config set ./deploy-config.json MyQueue maxNumberOfRetries 5

すべてのリソースに競合修正ポリシーを設定する

uip solution deploy config set ./deploy-config.json --all conflictFixingAction UseExisting

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

単一リソースの更新:

{
  "Code": "DeployConfigSet",
  "Data": {
    "Resource": "MyQueue",
    "Property": "maxNumberOfRetries",
    "OldValue": 1,
    "NewValue": 5
  }
}

一括更新 (--all):

{
  "Code": "DeployConfigSet",
  "Data": {
    "Resource": "all",
    "Property": "conflictFixingAction",
    "NewValue": "UseExisting",
    "ResourceCount": 12
  }
}

---

uip solution deploy config link

ソリューション リソースを 既存の Orchestrator リソースにリンクし、デプロイで新しいリソースを作成するのではなく再利用する。変更はローカルです — ファイルを deploy run --config-fileに渡して適用します。

引数

• <file> (必須) — デプロイ構成ファイルの JSON ファイルへのパスです。
• <resource> (必須) — 構成ファイルのリソース名または resourceKey 。

オプション

• -n, --name <name> (必須) — リンク先の既存の Orchestrator リソースの名前です。
• --folder-path <path> — 既存のリソースが存在する Orchestrator フォルダーのパスです。

例

uip solution deploy config link ./deploy-config.json MyQueue \
  --name ProductionQueue \
  --folder-path "Shared/Production"

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

{
  "Code": "DeployConfigLink",
  "Data": {
    "Resource": "MyQueue",
    "LinkedTo": {
      "name": "ProductionQueue",
      "folderPath": "Shared/Production"
    }
  }
}

---

uip solution deploy config unlink

Remove a link set with config link. On the next deploy run --config-file, the resource is created instead of reused.

引数

• <file> (必須) — デプロイ構成ファイルの JSON ファイルへのパスです。
• <resource> (必須) — リンクを解除するリソース名または resourceKey 。

例

uip solution deploy config unlink ./deploy-config.json MyQueue

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

{
  "Code": "DeployConfigUnlink",
  "Data": {
    "Resource": "MyQueue",
    "UnlinkedFrom": "ProductionQueue"
  }
}

故障モード

• リソースは現在リンクされていません。このコマンドはリンク解除を拒否し、config linkをポイントします。

---

関連コマンド

• uip solution publish — deploy runの前に必要なステップ 。
• uip solution packages list — パッケージの名前とバージョンを検出します。
• uip or — deploy config link参照する Orchestrator リソースを検査または作成します。

参照

• 最初のパイプライン — パック→パブリッシュ→デプロイの実行ウォークスルー。
• 認証 と 構成 — セッション設定とテナントごとの既定値。
• uip solutionの概要。