UiPath Documentation
uipath-cli
latest
false
UiPath CLI ユーザー ガイド
重要 :
このコンテンツは機械翻訳によって処理されています。 新しいコンテンツの翻訳は、およそ 1 ~ 2 週間で公開されます。

uip solution deploy

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

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

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

サブコマンド目的
runパブリッシュされたパッケージから 新しい デプロイをインストールします。
upgrade既存のデプロイを新しいパッケージ バージョンにアップグレードします。
statusパイプラインのデプロイのステータスを確認します。
list既存のデプロイを一覧表示します。
activate自動アクティブ化せずにインストールされたデプロイをアクティブ化します。
uninstallデプロイとそのプロビジョニングされたリソースを削除します。
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 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 run は常に新しいフォルダー内に新しいデプロイが作成され、既存のデプロイは更新されません。パッケージがすでに指定の--nameでデプロイされている場合は、deploy upgrade を使用して、そのデプロイを新しいバージョンに移動するか、代わりに deploy run に-y, --yes渡して 2 つ目の独立したコピーをインストールします。


uip solution deploy run​

パブリッシュされたパッケージから Orchestrator に 新しい ソリューションのデプロイをインストールします。新しいフォルダー ( --parent-folder-path または --parent-folder-key、または現在のユーザーの個人用ワークスペース) を作成し、パッケージ (または --config-file) で説明されているすべてのリソースをプロビジョニングし、 --skip-activate が設定されていない限り、そのリソースをアクティブ化します。

これによっては常に新しいデプロイが作成されるため、コマンドはまず、パッケージに同じ --nameのデプロイが既にあるかどうかを確認します。その場合は、停止し、サイレントに再インストールするのではなく、 deploy upgrade を指定します。このチェックはベストエフォートであり、保証ではありません。ユーザー セッションを必要とするソリューション検索を読み取るため、アプリケーション (クライアント資格情報) のログインではスキップされ、検索が失敗すると警告が表示されるだけです。

概要​

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] \
  [--wait] \
  [-y, --yes] \
  [--timeout <seconds>] \
  [--poll-interval <ms>] \
  [--login-validity <minutes>]
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] \
  [--wait] \
  [-y, --yes] \
  [--timeout <seconds>] \
  [--poll-interval <ms>] \
  [--login-validity <minutes>]

オプション​

長押し値 (Value)既定 (Default)説明
-n, --name <deployment-name>text—必須。デプロイの名前。deploy status、deploy upgrade、deploy activate、および deploy uninstall がこのインストールを識別するために使用します。
--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フラグ無効現在のユーザーの [個人用ワークスペース] にデプロイします。ワークスペース名は Orchestrator から自動的に解決されます。--parent-folder-path、--parent-folder-key、--feedと相互に排他的です。
--feed <name-or-key>textテナント フィードテナント フィードではなくこのフィード (solution feeds listの名前またはフォルダー キー) にパブリッシュされたパッケージをデプロイします。このスコープは、 パッケージのソース です。 --parent-folder-path/--parent-folder-key/--personal-workspace フラグは、引き続き Orchestrator フォルダーを作成する 場所 を制御します。--personal-workspaceと相互に排他的です。
--config-file <path>パス—JSON または YAML 構成ファイル。deploy config getで生成し、config set / config linkで編集して、ここに渡します。
--skip-activateフラグ無効自動アクティブ化をスキップします。デプロイを Inactive (Ready to activate) ステートのままにします。後で deploy activateでアクティベーションします。
--waitフラグ無効--personal-workspaceまたは--feedデプロイの場合は、開始後すぐに戻るのではなく、完了するまで待機します (--timeoutで囲まれます)。テナント フィードのパスは常に待機するため、このフラグはそこでは何も変更しません。
-y, --yesフラグ無効このパッケージに既に --nameの下にデプロイがある場合でもデプロイし、専用のフォルダーを持つ 2 つ目の独立したコピーをインストールします。
--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"
自動アクティブ化をスキップ​
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
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
個人用ワークスペースへ、完了を待機する​
uip solution deploy run \
  --name my-deployment \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolution --personal-workspace --wait
uip solution deploy run \
  --name my-deployment \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolution --personal-workspace --wait
既にデプロイ済みのパッケージの 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-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 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
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 "Data.PipelineDeploymentId" --output plain)

uip solution deploy status "$PIPELINE_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 "Data.PipelineDeploymentId" --output plain)

uip solution deploy status "$PIPELINE_ID"

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

テナント フィードへのデプロイ (常に待機):

{
  "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"
  }
}
{
  "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"
  }
}

--waitなしの個人用ワークスペース/フォルダー フィードのデプロイ:

{
  "Code": "SolutionDeployRun",
  "Data": {
    "Status": "DeploymentStarted",
    "DeploymentName": "my-deployment",
    "PackageName": "my-package",
    "PackageVersion": "1.0.0",
    "FolderName": "MySolution",
    "FolderPath": "alice@uipath.com/MySolution",
    "ActivationStatus": "Auto",
    "NextSteps": "Deployment created in your Personal Workspace and will auto-activate. Check status with: uip solution deploy list."
  }
}
{
  "Code": "SolutionDeployRun",
  "Data": {
    "Status": "DeploymentStarted",
    "DeploymentName": "my-deployment",
    "PackageName": "my-package",
    "PackageVersion": "1.0.0",
    "FolderName": "MySolution",
    "FolderPath": "alice@uipath.com/MySolution",
    "ActivationStatus": "Auto",
    "NextSteps": "Deployment created in your Personal Workspace and will auto-activate. Check status with: uip solution deploy list."
  }
}

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

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

タイムアウト時の動作​

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

故障モード​

  • デプロイはすでに --nameの下に存在します。-y, --yesが合格しない限り拒否されます (2 つ目の独立したコピーをインストールします) — 既存のデプロイを新しいバージョンに移動する場合は、代わりに deploy upgrade を使用します。
  • --name 存在し、別の --package-nameにバインドされています。完全に失敗する — デプロイ名は を介してパッケージを切り替えることができ deploy run。
  • --name のデプロイはすでに進行中です。失敗 – 前の操作が最初に完了する必要があります。

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

既存のデプロイを新しいパッケージ バージョンにアップグレードします。これは Orchestrator UI の [アップグレード] ボタンと同等の CLI です。ターゲット名でデプロイがすでに存在するために deploy run がブロックされている場合に使用します。デプロイの既存の設定は保持されるため、すでに設定されている値 (資格情報アセットのシークレットなど) は、パッケージの既定値にリセットされません。--no-waitに合格しない限り、アップグレードが完了するまで待機します。

引数​

  • <deployment-key> (必須) — アップグレードするデプロイのキーです。deploy list を使用して検索します ([Keyフィールド)。

オプション​

長押し値 (Value)既定 (Default)説明
--version <version>text利用可能な最新情報移行後の パッケージのバージョンです。現在サポートされているのは、最新のパブリッシュ済みバージョンのみです。
--personal-workspaceフラグ無効テナントではなく個人用ワークスペース フィードでデプロイをアップグレードします。
--no-waitフラグ無効アップグレードが完了するのを待つのではなく、アップグレードが受け入れられたらすぐに戻ってください。
--timeout <seconds>秒300アップグレードが完了するまで待機する時間です (秒)。
--poll-interval <ms>ミリ秒5000ステータス ポーリングの間隔 (ミリ秒)。
--login-validity <minutes>分10更新をトリガーするまでの最小分単位: トークンの有効期限が切れるまでの最小分単位です。

例​

# Upgrade to the newest published version, waiting for completion
uip solution deploy upgrade a1b2c3d4-0000-0000-0000-000000000001

# Start the upgrade without waiting
uip solution deploy upgrade a1b2c3d4-0000-0000-0000-000000000001 --no-wait
# Upgrade to the newest published version, waiting for completion
uip solution deploy upgrade a1b2c3d4-0000-0000-0000-000000000001

# Start the upgrade without waiting
uip solution deploy upgrade a1b2c3d4-0000-0000-0000-000000000001 --no-wait

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

{
  "Code": "SolutionDeployUpgrade",
  "Data": {
    "Status": "Successful",
    "DeploymentName": "billing-solution",
    "FromVersion": "1.0.0",
    "ToVersion": "2.0.0",
    "VersionChangeKey": "b2c3d4e5-0000-0000-0000-000000000002"
  }
}
{
  "Code": "SolutionDeployUpgrade",
  "Data": {
    "Status": "Successful",
    "DeploymentName": "billing-solution",
    "FromVersion": "1.0.0",
    "ToVersion": "2.0.0",
    "VersionChangeKey": "b2c3d4e5-0000-0000-0000-000000000002"
  }
}

--no-waitの場合、Statusは"Draft"され、アップグレードは承認済みのみであり、完了していない状態です。ポーリングdeploy list (Actions/TargetPackageVersion フィールド) を投票して追跡します。


uip solution deploy status​

パイプラインのデプロイの現在のステータスを確認します。デプロイのステート、デプロイの名前/パッケージ/バージョンがある場合はそのバージョン、および連結されたエラーの概要を返します。

引数​

  • <pipeline-deployment-id> (必須) — deploy runによって返されるPipelineDeploymentIdです。

オプション​

  • --login-validity <minutes> — デフォルトは 10です。

例​

uip solution deploy status b2c3d4e5-0000-0000-0000-000000000001
uip solution deploy status b2c3d4e5-0000-0000-0000-000000000001

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

{
  "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
    }
  }
}
{
  "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
    }
  }
}

uip solution deploy list​

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

オプション​

長押し値 (Value)既定 (Default)説明
--folder-path <path>パス—親フォルダーのパスでフィルター処理します。フィルター処理はフェッチ 後に適用されます 。このフィルターの使用時に結果が不完全に見える場合は、 --limit を増やします。
--folder-key <key>GUID—親フォルダー キーでフィルター処理する--folder-pathの代替手段です。
-l, --limit <number>Number50取得するデプロイの最大数。
--offset <number>Number0スキップするデプロイの数 ( --folder-path/--folder-key フィルター処理の前に適用)。
--sort-by <column>textstartTime並べ替えの基準にする列です。
--sort-order <direction>Ascending | DescendingDescending並べ替え方向です。
--operation-status <statuses>コンマ区切り—サーバー側で操作ステータス ( Successful、 InProgress、 Failedなど) でフィルター処理します。
--activation-status <statuses>コンマ区切り—サーバー側でアクティベーション ステータス ( Active、 Inactiveなど) でフィルター処理します。
--personal-workspaceフラグ無効現在のユーザーの個人用ワークスペース フィードからのデプロイのみを表示します。--feedと相互に排他的です。
--feed <name-or-key>text—このフィードのデプロイのみを表示します。--personal-workspaceと相互に排他的です。
--login-validity <minutes>分10更新をトリガーするまでの最小分単位: トークンの有効期限が切れるまでの最小分単位です。

--operation-status と --activation-status はどちらも、SDK の既知のステータス リストの外にある値を拒否します。エラー メッセージには有効な値が列挙されます。

例​

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

# Spot a pending in-place upgrade
uip solution deploy list --operation-status InProgress
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 }
}
{
  "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 は、deploy upgrade が として予期する値です<deployment-key>。現在デプロイされているバージョンよりも新しいパブリッシュ済みバージョンが存在する場合、NewPackageVersionAvailableは null 以外になります。Actions には、デプロイで現在使用可能な操作 ( ["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
uip solution deploy activate my-deployment

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

{
  "Code": "SolutionDeployActivate",
  "Data": {
    "Status": "SuccessfulActivate",
    "DeploymentName": "my-deployment",
    "InstanceId": "b2c3d4e5-0000-0000-0000-000000000001"
  }
}
{
  "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
uip solution deploy uninstall my-deployment --yes

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

{
  "Code": "SolutionDeployUninstall",
  "Data": {
    "Status": "SuccessfulUninstall",
    "DeploymentName": "my-deployment",
    "InstanceId": "b2c3d4e5-0000-0000-0000-000000000001"
  }
}
{
  "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がありません。コマンドは確認せずに拒否します。

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>パスStdoutstdout ではなくこのファイルに構成を書き込みます。
--format <format>json | yamljson構成形式。
--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
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"
  }
}
{
  "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": [ "..." ] }
  }
}
{
  "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 MyQueue maxNumberOfRetries 5
すべてのリソースに競合修正ポリシーを設定する​
uip solution deploy config set ./deploy-config.json --all conflictFixingAction UseExisting
uip solution deploy config set ./deploy-config.json --all conflictFixingAction UseExisting

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

単一リソースの更新:

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

一括更新 (--all):

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

ソリューション リソースを 既存の 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"
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"
    }
  }
}
{
  "Code": "DeployConfigLink",
  "Data": {
    "Resource": "MyQueue",
    "LinkedTo": {
      "name": "ProductionQueue",
      "folderPath": "Shared/Production"
    }
  }
}

以前に config linkで設定したリンクを削除します。次の deploy run --config-fileでは、リソースは再利用されるのではなく、新たに作成されます。

引数​

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

例​

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

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

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

故障モード​

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

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

参照​

このページは役に立ちましたか?

接続

ヘルプ リソース サポート

学習する UiPath アカデミー

質問する UiPath フォーラム

最新情報を取得