バックアップと復元のための自動構成ツール コマンドレット

最終公開日 : Nov 13, 2026
このページでは、Web Studio が使用するバックアップおよび復元 API をトリガーするためにツールがサポートするすべてのコマンドレットとパラメーターを一覧表示します。
Related information
構成のバックアップまたは移行

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

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 の場合、オプションの Password
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

選択したバックアップに保存されている単一のコンポーネントのメンバーを列挙します。メンバー名は単純なリストで返されます。
コンポーネントは次のとおりです。
  • タグ
  • AdminScopes
  • AdminRoles
  • AdminAdministrators (オンプレミスのみ)
  • HostConnections
  • アイコン
  • AdminFolders
  • MachineCatalogs
  • StoreFronts
  • DeliveryGroups
  • ApplicationGroups
  • ApplicationFolders
  • アプリケーション
  • AppVServers
  • AppLibPackageDiscovery
  • AppVIsolationGroups
  • グループポリシー
  • ユーザーゾーン設定
  • サイトデータ
  • ゾーン (オンプレミスのみ)
パラメーター:
パラメーター 説明
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

Delivery Controllerで新しいバックアップアクションを開始します。このアクションは、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 アクションが完了するまで、Delivery Controllerで実行中のアクションをポーリングするためのパラメーター。Quite パラメーターが指定されていない限り、ポーリングは進行状況と完了結果をコンソールにログ記録します。

バックアップをピン留めするコマンドレット

Set-BckRstrPinBackups

Delivery Controllerのバックアップクリーンアッププロセスの一部として削除されないように、バックアップをピン留めします。
パラメーター:
パラメーター 説明
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

バックアップのピン留めを解除し、Delivery Controllerのバックアップクリーンアッププロセスで削除できるようにします。
パラメーター:
パラメーター 説明
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 毎日（値 = 1）または隔日（値 = 2）のように、n回ごとに実行します。
Description スケジュールされたバックアップの説明
Enabled このバックアップスケジュールを有効にするためのパラメーター。有効な場合はTrue、無効な場合はfalse。
TimeZoneId WindowsタイムゾーンID

Set-BckRstrSchedule

既存のバックアップスケジュールを変更します。変更するスケジュールを選択するために、名前またはUidを指定します。
パラメーター:
パラメーター 説明
CustomerId ベアラートークンを取得するために必要な顧客ID。
CientId ベアラートークンを取得するために必要なクライアントID。
Secret ベアラートークンを取得するために必要なシークレット。
CustomerInforFileSpec セキュリティおよび環境情報を含む顧客情報ファイルの完全修飾ファイル指定。
ProfileName 以前のパラメーターの代わりに使用される、既存のセキュリティプロファイルを識別するためのパラメーター。セキュリティプロファイルの設定方法については、(https://www.citrix.com/blogs/2016/07/01/introducing-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 毎日 (値 = 1) または隔日 (値 = 2) のように、n 回ごとに実行します。
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回に制限するパラメーター。

復元コマンドレット

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

既存のバックアップから単一コンポーネントのメンバーを復元します。
パラメーター:
パラメーター 説明
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 設定または変更するメモ。