製品ドキュメント

自動構成ツール コマンドレット (バックアップと復元用)

May 31, 2026
寄稿者: 
C

このページには、Web Studio が使用するバックアップおよび復元 API をトリガーするためにツールがサポートするすべてのコマンドレットとパラメーターがリストされています。

バックアップストレージコマンドレット

ゲット-バックリストアストレージ

このコマンドレットはオンプレミスのみに適用されます。バックアップが保存されるストレージの詳細を取得します。

パラメーター:

パラメーター 説明文
CustomerId ベアラートークンを取得するために必要な顧客ID。
CientId ベアラートークンを取得するために必要なクライアントID。
Secret ベアラートークンを取得するために必要なシークレット。
CustomerInforFileSpec セキュリティおよび環境情報を含む顧客情報ファイルの完全修飾ファイル指定。
ProfileName 以前のパラメーターの代わりに使用される既存のセキュリティプロファイルを識別するためのパラメーター。セキュリティプロファイルの設定方法については、XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud を参照してください。
Environment 本番環境のタイプ：プロダクション、プロダクションガブ、プロダクションJP、オンプレミス。
Quiet コンソールへの出力を抑制するためのパラメーター。

Set-BckRstrStorage

このコマンドレットはオンプレミスのみに適用されます。バックアップが保存される新しいストレージを設定します。

パラメーター:

パラメーター Description
CustomerId ベアラートークンを取得するために必要な顧客ID。
CientId ベアラートークンを取得するために必要なクライアントID。
Secret ベアラートークンを取得するために必要なシークレット。
CustomerInforFileSpec セキュリティおよび環境情報を含む顧客情報ファイルの完全修飾ファイル指定。
ProfileName 以前のパラメーターの代わりに使用される既存のセキュリティプロファイルを識別するためのパラメーター。セキュリティプロファイルの設定方法については、XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloudを参照してください。
Environment 本番環境の種類：本番、政府機関向け本番、日本向け本番、オンプレミス。
Quiet コンソールへの出力を抑制するためのパラメーター。
MaximumBackups 新しいバックアップが作成されたときに、バックアップクリーンアッププロセスが最も古いバックアップを削除するまで保持される、固定されていないバックアップの最大数。
MaximumPinnedBackups 保持される固定されたバックアップの最大数。これらのバックアップはクリーンアッププロセスによって削除されません。
BlobStorageType ストレージの種類: FileStorage または CustomerAzureStorage。
FileStoragefolder BlobStorageType FileStorage オプションの完全修飾フォルダー指定。
Info1
FileStorage の場合、オプションの UserName
CustomerAzureStorage の場合、アジュール SAS URL
Info2 FileStorage の場合、オプションのパスワード
Info3 と Info4 使用されていません

テスト-バックリストアストレージ

このコマンドレットはオンプレミスのみに適用されます。定義されたストレージが有効であることを確認するためにテストします。

FileStorage の場合、テストはフォルダーが存在し、書き込み可能であることを確認します。

CustomerAzureStorage の場合、テストは SAS URL が正しい権限を持っていること、および現在の日付が URL の開始日と終了日の範囲内であることを確認します。

有効な場合は true を返し、無効な場合は false を返します。

パラメーター:

パラメーター 説明文
CustomerId ベアラートークンを取得するために必要な顧客ID。
CientId ベアラートークンを取得するために必要なクライアントID。
Secret ベアラートークンを取得するために必要なシークレット。
CustomerInforFileSpec セキュリティおよび環境情報を含む顧客情報ファイルの完全修飾ファイル指定。
ProfileName 以前のパラメーターの代わりに使用される、既存のセキュリティプロファイルを識別するためのパラメーター。セキュリティプロファイルの設定方法については、XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud を参照してください。
Environment 本番環境の種類：本番、本番政府機関向け、本番日本、オンプレミス。
Quiet コンソールへの出力を抑制するパラメーター。

バックアップコマンドレット

ゲット-バックリストアバックアップス

バックアップまたは復元BLOBストレージの場所に保存されているバックアップを列挙します。Citrix Virtual Apps and Desktops™の場合、この場所は管理者がWebStudioを通じて設定します。DaaSの場合、これは既存の顧客Azureストレージです。各バックアップに関する完全な情報については、Get-BckRstrBackupsWithDetiailsを使用してください。バックアップの詳細には、以下が含まれます。

  • バックアップ名
  • メモ
  • ピン留め済み (trueまたはfalse)
  • バックアップの日時
  • 履歴UID
  • 関連UID (最後の復元履歴レコードのUID)
  • 関連する日付と時刻
  • チェックモードで実行された場合に関連付けられます
  • 継続時間 (秒)
  • 管理者の名前
  • 各コンポーネントと、各コンポーネント内のメンバーの数を列挙した詳細。

パラメーター:

パラメーター 説明文
CustomerId ベアラートークンを取得するために必要な顧客ID。
CientId ベアラートークンを取得するために必要なクライアントID。
Secret ベアラートークンを取得するために必要なシークレット。
CustomerInforFileSpec セキュリティおよび環境情報を含む顧客情報ファイルの完全修飾ファイル指定。
ProfileName 以前のパラメータの代わりに使用される、既存のセキュリティプロファイルを識別するためのパラメータ。セキュリティプロファイルの設定方法については、XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloudを参照してください。
Environment 本番環境のタイプ: プロダクション、プロダクションガブ、プロダクションジェイピー、オンプレミス。
Quiet コンソールへの出力を抑制するパラメータ。

ゲット-バックリストアバックアップメンバーズ

選択したバックアップに保存されている単一コンポーネントのメンバーを列挙します。メンバー名は単純なリストで返されます。

コンポーネントは次のとおりです。

  • タグ
  • アドミンスコープ
  • 管理者ロール
  • 管理者 (オンプレミスのみ)
  • ホスト接続
  • アイコン
  • 管理フォルダー
  • マシンカタログ
  • ストアフロント
  • デリバリーグループ
  • アプリケーショングループ
  • アプリケーションフォルダー
  • アプリケーション
  • アップブイサーバー
  • AppLibパッケージ検出
  • App-V分離グループ
  • グループポリシー
  • ユーザーゾーン設定
  • サイトデータ
  • ゾーン (オンプレミスのみ)

パラメーター:

パラメーター 説明内容
CustomerId ベアラートークンを取得するために必要な顧客ID。
CientId ベアラートークンを取得するために必要なクライアントID。
Secret ベアラートークンを取得するために必要なシークレット。
CustomerInforFileSpec セキュリティおよび環境情報を含む顧客情報ファイルの完全修飾ファイル指定。
ProfileName 以前のパラメーターの代わりに使用される既存のセキュリティプロファイルを識別するためのパラメーター。セキュリティプロファイルの設定方法については、XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloudを参照してください。
Environment 本番環境のタイプ：プロダクション、プロダクションガブ、プロダクションJP、オンプレミス。
Quiet コンソールへの出力を抑制するためのパラメーター。
BackupName バックアップの名前。.zip拡張子はオプションです。
Component バックアップに含めるコンポーネント。

New-BckRstrBackup

Delivery Controllerで新しいバックアップアクションを開始します。このアクションは、New-BckRstrBackupコマンドレットに対して非同期です。

パラメータ:

パラメータ Description
CustomerId ベアラートークンを取得するために必要な顧客ID。
CientId ベアラートークンを取得するために必要なクライアントID。
Secret ベアラートークンを取得するために必要なシークレット。
CustomerInforFileSpec セキュリティおよび環境情報を含む顧客情報ファイルの完全修飾ファイル指定。
ProfileName 以前のパラメーターの代わりに使用される既存のセキュリティプロファイルを識別するためのパラメーター。セキュリティプロファイルの設定方法については、XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloudを参照してください。
Environment 本番環境の種類：本番環境、政府機関向け本番環境、日本向け本番環境、オンプレミス
Quiet コンソールへの出力を抑制するためのパラメーター。
Notes バックアップに関するメモ。
PollForCompletion アクションが完了するまで、Delivery Controllerで実行中のアクションをポーリングするためのパラメーター。Quiteパラメーターが指定されていない限り、ポーリングは進行状況と完了結果をコンソールにログ記録します。

バックアップのピン留めコマンドレット

Set-BckRstrPinBackups

Delivery Controllerのバックアップクリーンアッププロセスの一部として削除されないように、バックアップをピン留めします。

パラメーター:

パラメーター Description
CustomerId ベアラートークンを取得するために必要な顧客ID。
CientId ベアラートークンを取得するために必要なクライアントID。
Secret ベアラートークンを取得するために必要なシークレット。
CustomerInforFileSpec セキュリティおよび環境情報を含む顧客情報ファイルの完全修飾ファイル指定。
ProfileName 以前のパラメーターの代わりに使用される既存のセキュリティプロファイルを識別するためのパラメーター。セキュリティプロファイルの設定方法については、XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloudを参照してください。
Environment 本番環境の種類: プロダクション、プロダクションGov、プロダクションJP、オンプレミス。
Quiet コンソールへの出力を抑制するパラメーター。
BackupName バックアップの名前。.zip 拡張子はオプションです。

Set-BckRstrUnpinBackups

バックアップのピン留めを解除し、Delivery Controller のバックアップクリーンアッププロセスで削除できるようにします。

パラメーター:

パラメーター 説明文
CustomerId ベアラートークンを取得するために必要な顧客 ID。
CientId ベアラートークンを取得するために必要なクライアント ID。
Secret ベアラートークンを取得するために必要なシークレット。
CustomerInforFileSpec セキュリティおよび環境情報を含む顧客情報ファイルの完全修飾ファイル指定。
ProfileName 以前のパラメータの代わりに使用される既存のセキュリティプロファイルを識別するためのパラメータ。セキュリティプロファイルの設定方法については、XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloudを参照してください。
Environment 本番環境の種類: 本番、政府機関向け本番、日本向け本番、オンプレミス。
Quiet コンソールへの出力を抑制するためのパラメータ。
BackupName バックアップの名前。.zip拡張子はオプションです。

バックアップコマンドレットの削除

リムーブ-バックリストアバックアップ

1つ以上のバックアップを削除します。

パラメータ:

パラメータ Description
CustomerId ベアラートークンを取得するために必要な顧客ID。
CientId ベアラートークンを取得するために必要なクライアントID。
Secret ベアラートークンを取得するために必要なシークレット。
CustomerInforFileSpec セキュリティおよび環境情報を含む顧客情報ファイルの完全修飾ファイル指定。
ProfileName 以前のパラメーターの代わりに使用される既存のセキュリティプロファイルを識別するためのパラメーター。セキュリティプロファイルの設定方法については、XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloudを参照してください。
Environment 本番環境のタイプ： 本番、政府機関向け本番、日本向け本番、オンプレミス。
Quiet コンソールへの出力を抑制するためのパラメーター。
IncludeByName 復元対象とするコンポーネントメンバーを指定するためのフィルターです。これは、フィルター値のコンマ区切りリストであり、ワイルドカード文字 * および ? を含めることができます。

スケジュールされたバックアップのコマンドレット

Get-BckRstrSchedules

バックアップスケジュールのリストを取得します。

パラメーター:

パラメーター 機能の説明
CustomerId ベアラートークンを取得するために必要な顧客ID。
CientId ベアラートークンを取得するために必要なクライアントID。
Secret ベアラートークンを取得するために必要なシークレット。
CustomerInforFileSpec セキュリティおよび環境情報を含む顧客情報ファイルの完全修飾ファイル指定。
ProfileName 以前のパラメーターの代わりに使用される既存のセキュリティプロファイルを識別するためのパラメーター。セキュリティプロファイルの設定方法については、XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloudを参照してください。
Environment 本番環境のタイプ：プロダクション、プロダクションGov、プロダクションJP、オンプレミス。
Quiet コンソールへの出力を抑制するためのパラメーター。
BackupName バックアップの名前。.zip拡張子はオプションです。
Notes 設定または変更するメモ。

新規バックアップ復元スケジュール

新しいバックアップスケジュールを作成します。

パラメーター:

パラメーター Description
CustomerId ベアラートークンを取得するために必要な顧客ID。
CientId ベアラートークンを取得するために必要なクライアントID。
Secret ベアラートークンを取得するために必要なシークレット。
CustomerInforFileSpec セキュリティおよび環境情報を含む顧客情報ファイルの完全修飾ファイル指定。
ProfileName 以前のパラメーターの代わりに使用される既存のセキュリティプロファイルを識別するためのパラメーター。セキュリティプロファイルの設定方法については、XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloudを参照してください。
Environment 本番環境のタイプ: プロダクション、プロダクションガブ、プロダクションジェイピー、オンプレミス。
Quiet コンソールへの出力を抑制するためのパラメーター。
Name スケジュール名。
Frequency 頻度の種類: 毎日、毎週、または毎月。
Day 頻度が毎日の場合。
DaysInWeek 頻度が毎週の場合。
DayInMonth 頻度が毎月の場合。
WeekInMonth 頻度が毎月の場合。
StartDate 形式は M/d/yy です。
StartTime 24時間形式で指定された開始時刻。
FrequencyFactor 毎日 (値 = 1) または隔日 (値 = 2) のように、n 回ごとに実行します。
Description スケジュールされたバックアップの説明
Enabled このバックアップスケジュールを有効にするパラメーター。有効な場合は True、無効な場合は false。
TimeZoneId ウィンドウズ タイムゾーン識別子

Set-BckRstrSchedule

既存のバックアップスケジュールを変更します。変更するスケジュールを選択するには、名前または Uid を指定します。

パラメーター:

パラメーター 説明文
CustomerId ベアラートークンを取得するために必要な顧客ID。
CientId ベアラートークンを取得するために必要なクライアントID。
Secret ベアラートークンを取得するために必要なシークレット。
CustomerInforFileSpec セキュリティおよび環境情報を含む顧客情報ファイルの完全修飾ファイル指定。
ProfileName 以前のパラメーターの代わりに使用される、既存のセキュリティプロファイルを識別するためのパラメーター。セキュリティプロファイルの設定方法については、XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud を参照してください。
Environment 本番環境の種類: プロダクション、プロダクションGov、プロダクションJP、オンプレミス。
Quiet コンソールへの出力を抑制するためのパラメーター。
Name スケジュール名。
Uid スケジュール名を変更する場合。
Frequency 頻度の種類: 毎日、毎週、または毎月。
Day 頻度が毎日の場合。
DaysInWeek 頻度が毎週の場合。
DayInMonth 頻度が毎月の場合。
WeekInMonth 頻度が毎月の場合。
StartDate 形式は M/d/yy です。
StartTime 24時間形式で指定された開始時刻。
FrequencyFactor n回ごとに実行します。たとえば、毎日（値 = 1）または隔日（値 = 2）などです。
Description スケジュールされたバックアップの説明
Enabled このバックアップスケジュールを有効にするためのパラメーターです。有効な場合はTrue、無効な場合はfalse。
TimeZoneId Windows タイムゾーンの識別子

Set-BckRstrScheduleEnabled

既存のバックアップスケジュールを有効にします。有効にするスケジュールを選択するには、名前またはUidを指定します。

パラメーター:

パラメーター 説明文
CustomerId ベアラートークンを取得するために必要な顧客ID。
CientId ベアラートークンを取得するために必要なクライアントID。
Secret ベアラートークンを取得するために必要なシークレット。
CustomerInforFileSpec セキュリティおよび環境情報を含む顧客情報ファイルの完全修飾ファイル指定。
ProfileName 以前のパラメーターの代わりに使用される既存のセキュリティプロファイルを識別するためのパラメーター。セキュリティプロファイルの設定方法については、XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloudを参照してください。
Environment 本番環境の種類：本番、政府機関向け本番、日本向け本番、オンプレミス。
Quiet コンソールへの出力を抑制するためのパラメーター。
Name スケジュール名。
Uid スケジュール名を変更する場合。

Set-BckRstrScheduleDisabled

既存のバックアップスケジュールを無効にします。無効にするスケジュールを選択するには、名前またはUidを指定します。

パラメーター:

パラメーター 説明文
CustomerId ベアラートークンを取得するために必要な顧客ID。
CientId ベアラートークンを取得するために必要なクライアントID。
Secret ベアラートークンを取得するために必要なシークレット。
CustomerInforFileSpec セキュリティおよび環境情報を含む顧客情報ファイルの完全修飾ファイル指定。
ProfileName 以前のパラメーターの代わりに使用される既存のセキュリティプロファイルを識別するためのパラメーター。セキュリティプロファイルの設定方法については、XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud を参照してください。
Environment 本番環境の種類: プロダクション、政府機関向けプロダクション、日本向けプロダクション、オンプレミス。
Quiet コンソールへの出力を抑制するためのパラメーター。
Name スケジュール名。
Uid スケジュール名を変更する場合。

バックアップの制限コマンドレット

Set-BckRstrOptions

同一のバックアップを避けるため、スケジュールされたバックアップを1日1回に制限します。

パラメーター:

パラメーター Description
CustomerId ベアラートークンを取得するために必要な顧客ID。
CientId ベアラートークンを取得するために必要なクライアントID。
Secret ベアラートークンを取得するために必要なシークレット。
CustomerInforFileSpec セキュリティおよび環境情報を含む顧客情報ファイルの完全修飾ファイル指定。
ProfileName 以前のパラメーターの代わりに使用される既存のセキュリティプロファイルを識別するためのパラメーター。セキュリティプロファイルの設定方法については、XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloudを参照してください。
Environment The type of production environment: Production, ProductionGov, ProductionJP, OnPrem.
Quiet コンソールへの出力を抑制するためのパラメーター。
OneScheduledBackupPerDay 同一のバックアップを避けるため、スケジュールされたバックアップを1日1回に制限するパラメータ。

復元コマンドレット

バックアップの復元

既存のバックアップから、単一のコンポーネントのメンバーを復元します。

パラメータ:

パラメータ 説明文
CustomerId ベアラートークンを取得するために必要な顧客ID。
CientId ベアラートークンを取得するために必要なクライアントID。
Secret ベアラートークンを取得するために必要なシークレット。
CustomerInforFileSpec セキュリティおよび環境情報を含む顧客情報ファイルの完全修飾ファイル指定。
ProfileName 以前のパラメーターの代わりに使用される既存のセキュリティプロファイルを識別するためのパラメーター。セキュリティプロファイルの設定方法については、XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloudを参照してください。
Environment The type of production environment: Production, ProductionGov, ProductionJP, OnPrem.
Quiet コンソールへの出力を抑制するためのパラメーター。
BackupName バックアップの名前。.zip拡張子はオプションです。
Component バックアップに含めるコンポーネント。
Notes バックアップに関するメモ。
CheckMode 復元されるコンポーネントメンバーを識別するパラメーターですが、実際の復元は実行しません。
RestoreType The restore type: MissingOnly or MissingUpdateExisting
IncludeByName 復元対象とするコンポーネントメンバーを指定するためのフィルター。これは、フィルター値のコンマ区切りリストであり、ワイルドカード文字 * および ? を含めることができます。

履歴コマンドレット

Get-BckRstrHistory

すべてのアクションの履歴の詳細リストを取得します。

パラメーター:

パラメーター 説明文
CustomerId ベアラートークンを取得するために必要な顧客ID。
CientId ベアラートークンを取得するために必要なクライアントID。
Secret ベアラートークンを取得するために必要なシークレット。
CustomerInforFileSpec セキュリティ情報と環境情報を含む顧客情報ファイルの完全修飾ファイル指定。
ProfileName 以前のパラメーターの代わりに使用される既存のセキュリティプロファイルを識別するためのパラメーター。セキュリティプロファイルの設定方法については、XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloudを参照してください。
Environment The type of production environment: Production, ProductionGov, ProductionJP, OnPrem.
Quiet コンソールへの出力を抑制するためのパラメーター。

Get-BckRstrSpecificBackupHistory

特定のバックアップの履歴詳細のリストを取得します。

パラメーター:

パラメーター 説明文
CustomerId ベアラートークンを取得するために必要な顧客ID。
CientId ベアラートークンを取得するために必要なクライアントID。
Secret ベアラートークンを取得するために必要なシークレット。
CustomerInforFileSpec セキュリティおよび環境情報を含む顧客情報ファイルの完全修飾ファイル指定。
ProfileName 以前のパラメーターの代わりに使用される既存のセキュリティプロファイルを識別するためのパラメーター。セキュリティプロファイルの設定方法については、XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud を参照してください。
Environment 本番環境のタイプ: プロダクション、プロダクションGov、プロダクションJP、オンプレミス。
Quiet コンソールへの出力を抑制するパラメーター。
BackupName バックアップの名前。.zip 拡張子はオプションです。

Set-BckRstrNotes

履歴レコードのメモを設定または変更します。

パラメーター:

パラメーター 説明内容
CustomerId ベアラートークンを取得するために必要な顧客ID。
CientId ベアラートークンを取得するために必要なクライアントID。
Secret ベアラートークンを取得するために必要なシークレット。
CustomerInforFileSpec セキュリティおよび環境情報を含む顧客情報ファイルの完全修飾ファイル指定。
ProfileName 以前のパラメーターの代わりに使用される既存のセキュリティプロファイルを識別するためのパラメーター。セキュリティプロファイルの設定方法については、XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloudを参照してください。
Environment 本番環境の種類: プロダクション、プロダクションガブ、プロダクションJP、オンプレミス。
Quiet コンソールへの出力を抑制するパラメーター。
BackupName バックアップの名前。.zip 拡張子はオプションです。
Notes 設定または変更するメモ。
自動構成ツール コマンドレット (バックアップと復元用)
May 31, 2026
寄稿者: 
C
May 31, 2026
寄稿者: 
C

この記事の概要

サイトに関するフィードバック | Your privacy choices footer linkプライバシーに関する選択肢 | プライバシーと法令 | Cookieの設定 | 同意設定 | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.