Citrix DaaS

PDFを表示

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

September 15, 2025

寄稿者:

このページには、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
`Info1`
`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の場合、この場所は管理者がWeb Studioを使用して設定します。 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

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

コンポーネントは以下のとおりです：

タグ
管理者のスコープ
管理者の役割
AdminAdministrators（オンプレミスのみ）
ホスト接続
アイコン
AdminFolders
MachineCatalogs
StoreFront
デリバリーグループ
アプリケーショングループ
ApplicationFolders
アプリケーション
AppVServers
App Libパッケージ検出
AppV分離グループ
グループポリシー
UserZonePreferences
SiteData
Zones（オンプレミスのみ）

パラメーター：

パラメーター	説明
`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`	コンソールへの出力を抑制するパラメーター。
`メモ`	バックアップに関するメモ。
`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`拡張子はオプションです。
`メモ`	設定または変更するためのメモ。

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回ごとに実行します
`説明`	スケジュールされたバックアップの説明
`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`	毎日（値 = 1）または隔日（値 = 2）など、n回ごとに実行します
`説明`	スケジュールされたバックアップの説明
`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

既存のバックアップの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`	バックアップに含めるコンポーネント。
`メモ`	バックアップに関するメモ。
`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`拡張子はオプションです。
`メモ`	設定または変更するためのメモ。

このコンテンツの正式なバージョンは英語で提供されています。Cloud Software Groupドキュメントのコンテンツの一部は、お客様の利便性のみを目的として機械翻訳されています。Cloud Software Groupは機械翻訳されたコンテンツを管理していないため、誤り、不正確な情報、不適切な用語が含まれる場合があります。英語の原文から他言語への翻訳について、精度、信頼性、適合性、正確性、またはお使いのCloud Software Group製品またはサービスと機械翻訳されたコンテンツとの整合性に関する保証、該当するライセンス契約書またはサービス利用規約、あるいはCloud Software Groupとのその他すべての契約に基づき提供される保証、および製品またはサービスのドキュメントとの一致に関する保証は、明示的か黙示的かを問わず、かかるドキュメントの機械翻訳された範囲には適用されないものとします。機械翻訳されたコンテンツの使用に起因する損害または問題について、Cloud Software Groupは責任を負わないものとします。

この情報は役に立ちましたか?

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

September 15, 2025

寄稿者:

September 15, 2025

寄稿者:

この情報は役に立ちましたか?