ソリューション パッケージと構成をダウンロードする

ソリューション パッケージとデプロイ構成ファイルは、Orchestrator のソリューションからダウンロードできます。これは、障害復旧、環境の昇格、構成管理に役立ちます。

パッケージをダウンロードする

download-package コマンドは、[ソリューション] からソリューション パッケージを取得します。

コマンド構文

uipcli solution download-package <package-name> [options]

パラメーター:

パラメーター	説明	Required
<package-name>	ダウンロードするパッケージの名前です	はい
-d OR --destinationPath	パッケージが保存されるローカルの宛先パス	はい
-v OR --version	バージョン番号 (省略すると最新バージョンがダウンロードされます)	いいえ
-f OR --fileName	ローカルファイル名(省略した場合、ファイル名はパッケージ名+バージョン)	いいえ
-U	Orchestrator URL	はい
-T	テナント名	はい
-A	組織名	はい
-I	外部アプリ ID	はい
-S	外部アプリケーション シークレット	はい
--applicationScope	任意のスコープ (既定値が適用されます)	いいえ
--traceLevel	ログ レベル	いいえ

認証

必要なスコープについては、「 認証とスコープ 」および「外部アプリの設定」をご覧ください。

例

uipcli solution download-package MySolution \
  -d C:\Downloads \
  -v 1.2.3 \
  -U https://cloud.uipath.com/ \
  -T DefaultTenant \
  -A myorg \
  -I 12345678-xxxx-xxxx-xxxx-xxxxxxxxxxxx \
  -S **** \
  --applicationScope "AutomationSolutions Solutions.Deployments Solutions.Deployments.Read Solutions.Deployments.Write Solutions.Packages Solutions.Packages.Read Solutions.Packages.Write" \
  --traceLevel Information

これにより、以下の場合にパッケージがダウンロードされます。

C:\Downloads\MySolution.1.2.3.zip

カスタム ファイル名の例:

uipcli solution download-package MySolution \
  -d C:\Downloads \
  -f CustomPackageName.zip \
  -v 1.2.3 \
  -U https://cloud.uipath.com/ \
  -T DefaultTenant \
  -A myorg \
  -I 12345678-xxxx-xxxx-xxxx-xxxxxxxxxxxx \
  -S **** \
  --applicationScope "AutomationSolutions Solutions.Deployments Solutions.Deployments.Read Solutions.Deployments.Write Solutions.Packages Solutions.Packages.Read Solutions.Packages.Write" \
  --traceLevel Information

パッケージのダウンロードのユース ケース

障害復旧:

• バックアップ用にパッケージをアーカイブする
• Orchestrator が利用できない場合はパッケージを復元する

環境推進:

• テスト環境からダウンロードする
• 運用環境にアップロードする

聴講：

• コンプライアンス レビューのために特定のバージョンを取得する
• パッケージの内容を複数のバージョンで比較する

ローカル テスト:

• 検証用にデプロイ済みのパッケージをダウンロードする
• テスト、解凍、ローカルデプロイ

デプロイの構成をダウンロードする

download-config コマンドは、ソリューションのデプロイ用に環境固有の構成テンプレートを取得します。

コマンド構文

uipcli solution download-config <package-name> [options]

パラメーター:

パラメーター	説明	Required
<package-name>	パッケージの名前	はい
-d OR --destinationPath	構成ファイルが保存されるローカルの宛先パス	はい
-v OR --version	バージョン番号 (省略すると、最新バージョンの設定がダウンロードされます)	いいえ
-f OR --fileName	ローカルファイル名(省略した場合、ファイル名はパッケージ名+バージョン)	いいえ
--format	構成形式: yaml または json (既定値: yaml)	いいえ
-U	Orchestrator URL	はい
-T	テナント名	はい
-A	組織名	はい
-I	外部アプリ ID	はい
-S	外部アプリケーション シークレット	はい
--applicationScope	任意のスコープ (既定値が適用されます)	いいえ
--traceLevel	ログ レベル	いいえ

注:

--applicationScope パラメーターを指定せずに外部アプリケーション認証を使用すると、CLI は以下の既定の AutomationSolution スコープを自動的に適用します。

Solutions.Packages Solutions.Deployments OR.Execution

大事な： 3 つのスコープはすべて、ソリューション関連のすべての CLI コマンドに必要です。これらのスコープは、利用可能なすべてのソリューション コマンドを包括的にカバーするためにグループ化されています。コマンドごとに個別に設定するのではなく、まとめて設定する必要があります。

認証

必要なスコープについては、「 認証とスコープ 」および「外部アプリの設定」をご覧ください。

例

構成を YAML 形式でダウンロードします (既定)。

uipcli solution download-config MySolution \
  -d C:\Configs \
  -v 1.0.0 \
  -U https://cloud.uipath.com/ \
  -T DefaultTenant \
  -A myorg \
  -I 12345678-xxxx-xxxx-xxxx-xxxxxxxxxxxx \
  -S **** \
  --applicationScope "AutomationSolutions Solutions.Deployments Solutions.Deployments.Read Solutions.Deployments.Write Solutions.Packages Solutions.Packages.Read Solutions.Packages.Write" \
  --traceLevel Information

カスタム ファイル名を含む JSON 形式で構成をダウンロードします。

uipcli solution download-config MySolution \
  -d C:\Configs \
  -f CustomConfigFile \
  -v 1.0.0 \
  --format json \
  -U https://cloud.uipath.com/ \
  -T DefaultTenant \
  -A myorg \
  -I 12345678-xxxx-xxxx-xxxx-xxxxxxxxxxxx \
  -S **** \
  --applicationScope "AutomationSolutions Solutions.Deployments Solutions.Deployments.Read Solutions.Deployments.Write Solutions.Packages Solutions.Packages.Read Solutions.Packages.Write" \
  --traceLevel Information

デプロイ構成とは

デプロイの設定では、ソリューションの環境固有の設定を定義します。

• 接続文字列
• API エンドポイント
• 資格情報の参照
• 環境変数
• フォルダーのマッピング

これらの構成は次のとおりです。

• ソリューションのデプロイ時に作成
• ソリューションに保存される
• 複数のデプロイで再利用可能
• パッケージとは別にバージョン管理

構成をダウンロードするユース ケース

マルチ環境パイプライン:

# Download Dev config
uipcli solution download-config MySolution \
  -d C:\Configs\Dev \
  -f dev-config \
  -v 1.0.0 \
  -U https://cloud.uipath.com/ ...

# Download Prod config
uipcli solution download-config MySolution \
  -d C:\Configs\Prod \
  -f prod-config \
  -v 1.0.0 \
  -U https://cloud.uipath.com/ ...

コードとしての構成:

• バージョン管理構成ファイル
• 環境設定の変更を追跡する
• プル要求で構成の差分を確認する

テンプレートの生成:

• 開始点として、作業中の構成をダウンロードします
• 新しい環境用に変更する
• デプロイ パターンを再利用する

監査とコンプライアンス:

• 各デプロイの構成をアーカイブする
• 環境間で設定を比較する
• 運用環境の構成が承認済みテンプレートと一致することを確認する

パイプライン連携の例

ダウンロードとバージョン管理の構成

- name: Download Solution Configs
  run: |
    # Download config from Test environment
    uipcli solution download-config MySolution \
      -d ./configs/test \
      -f test-config \
      --format yaml \
      -U ${{ secrets.ORCHESTRATOR_URL }} \
      -T ${{ secrets.ORCHESTRATOR_TENANT }} \
      -A ${{ secrets.ORG_NAME }} \
      -I ${{ secrets.EXTERNAL_APP_ID }} \
      -S ${{ secrets.EXTERNAL_APP_SECRET }} \
      --applicationScope "AutomationSolutions Solutions.Deployments Solutions.Deployments.Read Solutions.Deployments.Write Solutions.Packages Solutions.Packages.Read Solutions.Packages.Write"

- name: Commit configs to repo
  run: |
    git add ./configs
    git commit -m "Update deployment configs from Test"
    git push

トラブルシューティング

エラー: 「認可されていません」または「403 Forbidden」

• 外部アプリに Solutions.Packages.Read スコープが設定されていることを確認する
• 組織名 ( の-A) が正しいことを確認します
• 外部アプリ ID とシークレットが有効であることを確認します

エラー: 「パッケージが見つかりません。」

• パッケージ名とバージョンが正しいことを確認します (大文字と小文字が区別されます)
• 正しいテナントと組織をターゲットにしていることを確認します
• パッケージが正常にアップロードされたことを確認します

エラー: 「構成が見つかりません。」

• パッケージ名が正しいことを確認する
• バージョンが存在することを確認する (または -v 省略して最新を使用)
• パッケージに利用可能なデプロイ設定があることを確認します

エラー: 「出力ディレクトリにアクセスできません。」

• 宛先パス (-d) が有効で書き込み可能であることを確認します
• エージェントのディレクトリ権限を確認します
• 十分なディスク容量があることを確認してください

次のステップ

パッケージまたは構成をダウンロードすると、以下を実行できます。

1. ターゲット環境にソリューションをデプロイする 。
2. 監査とコンプライアンスのためのバージョン管理構成ファイル。
3. 構成を新しいデプロイのテンプレートとして使用します。