製品ドキュメント
Citrix DaaS™
PDFを表示

バックアップおよび復元用の自動構成ツールコマンドレット

April 2, 2026
寄稿者: 
C

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

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

Get-BckRstrStorage

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

パラメーター:

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

Set-BckRstrStorage

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

パラメーター:

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

Test-BckRstrStorage

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

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

CustomerAzureStorage の場合、テストは SAS URL が正しいアクセス許可を持ち、現在の日付が URL の開始日と終了日の範囲内であることを確認します。

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

  • パラメーター:

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

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

Get-BckRstrBackups

バックアップまたは復元 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 本番環境のタイプ: Production、ProductionGov、ProductionJP、OnPrem。
  • Quiet コンソールへの出力を抑制するためのパラメーター。

Get-BckRstrBackupsMembers

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

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

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

パラメーター:

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

New-BckRstrBackup

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

パラメーター:

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

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

Set-BckRstrPinBackups

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

パラメーター:

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

Set-BckRstrUnpinBackups

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

パラメーター:

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

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

Remove-BckRstrBackup

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

パラメーター:

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

スケジュール済みバックアップのコマンドレット

Get-BckRstrSchedules

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

パラメーター:

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

New-BckRstrSchedule

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

パラメーター:

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

Set-BckRstrSchedule

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

パラメーター:

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

Set-BckRstrScheduleEnabled

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

パラメーター:

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

Set-BckRstrScheduleDisabled

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

パラメーター:

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

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

Set-BckRstrOptions

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

パラメーター:

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

復元コマンドレット

Restore-BckRstrBackups

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

パラメーター:

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

履歴コマンドレット

Get-BckRstrHistory

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

パラメーター:

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

Set-BckRstrNotes

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

パラメーター:

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

この記事の概要

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