Windows Server 2012 / 2012 R2 における Windows Server Backup 関連のコマンドレット (Remove-WBBackupSet) について

スポンサーリンク

規定ではインストールされていませんが、Windows Server 2012 / 2012 R2 標準の機能として Windows Server Backup (WSB) という基本的なバックアップと回復と行うための一連のウィザードや PowerShell コマンドレットなどの関連ツールを提供しています。

WSB 関連の PowerShell コマンドレットは Windows Server 2008 R2 と比較し、機能強化が行われていますが、ヘルプに関しては英語のみとなっており、日本語による情報はあまり公開されていません。

ここでは、WSB に関する PowerShell コマンドレットの 1 つである「Remove-WBBackupSet」について、日本語の情報として纏めてみました ((他の PowerShell コマンドレットについては、「Windows Server 2012 / 2012 R2 における Windows Server Backup 関連のコマンドレットについて」を参照)。

※Windows Server 2012 / 2012 R2 と比較した際、内容の相違がほとんどないことから、Windows Server 2012 R2 (内容については「Get-Help」コマンドレットの -Full オプションを用いて実行した結果を編集したものとなります) の情報を元に編集、意訳したものとなります。

■名前

Remove-WBBackupSet

■概要

ターゲット カタログ、システム カタログ、もしくはその両方からバックアップを削除します。

■構文

Remove-WBBackupSet [[-BackupSet] <WBBackupSet[]>] [[-KeepVersions] <Int32>] [[-DeleteOldest]] [[-MachineName] <String>] [[-Force]] [<CommonParameters>]

Remove-WBBackupSet [[-BackupSet] <WBBackupSet[]>] [[-KeepVersions] <Int32>] [[-DeleteOldest]] [-BackupTarget] <WBBackupTarget> [[-MachineName] <String>] [[-Force]] [<CommonParameters>]

Remove-WBBackupSet [[-BackupSet] <WBBackupSet[]>] [[-KeepVersions] <Int32>] [[-DeleteOldest]] [-NetworkPath] <String> [[-Credential] <PSCredential>] [[-NonInheritAcl]] [[-MachineName] <String>] [[-Force]] [<CommonParameters>]

Remove-WBBackupSet [[-BackupSet] <WBBackupSet[]>] [[-KeepVersions] <Int32>] [[-DeleteOldest]] [-VolumePath] <String> [[-MachineName] <String>] [[-Force]] [<CommonParameters>]

■説明

Remove-WBBackupSet コマンドレットは、ターゲット カタログ、システム カタログ、もしくはその両方からバックアップ設定を削除します。

■パラメーター

-BackupSet <WBBackupSet[]>
削除するバックアップ、もしくはバックアップ設定を決定するためのバックアップ設定オブジェクトの配列を指定します。1 つのバックアップ、もしくはバックアップ設定の配列を指定することが可能です。

必須 false
位置 1
既定値 none
パイプライン入力を許可する True (ByValue)
ワイルドカード文字を許可する false

-BackupTarget <WBBackupTarget>
削除したいバックアップを格納場所を示す、バックアップ対象のオブジェクトを指定します。

ローカル コンピューター以外のコンピューターからバックアップを削除するには、このパラメーターを使用します。コマンドレットは、このパラメータを指定したコンピューター上のカタログ、およびローカル コンピューター上のシステム カタログからバックアップ設定を削除します。これらの場所は、ローカル上に接続されたディスク ドライブ、もしくはリモート共有フォルダーを指定することが可能です。

必須 true
位置 4
既定値 none
パイプライン入力を許可する false
ワイルドカード文字を許可する false

-Credential <PSCredential>
バックアップを保存する場所のアクセス権限を持つユーザーアカウントのユーザー名とパスワードが含まれている PSCredential オブジェクトを指定します。

必須 false
位置 5
既定値 none
パイプライン入力を許可する True (ByValue)
ワイルドカード文字を許可する false

-DeleteOldest [<SwitchParameter>]
コマンドレットが設定から最も古いバックアップを削除するかを示します。

必須 false
位置 3
既定値 none
パイプライン入力を許可する false
ワイルドカード文字を許可する false

-Force [<SwitchParameter>]
確認のプロンプトを表示せずに、コマンドレットがバックアップ設定を削除する場合に指定します。既定では、実行前に確認のプロンプトをコマンドレット上に表示します。

必須 false
位置 8
既定値 none
パイプライン入力を許可する false
ワイルドカード文字を許可する false

-KeepVersions <Int32>
バックアップ ターゲット上に保存された最も最近のバックアップの番号を指定します。コマンドレットは、ターゲットからこの番号を超えるバックアップを削除します。

-BackupTarget および -MachineName パラメータとともにこのパラメーターを指定する場合、コマンドレットは、削除するバックアップに対して指定したコンピューター上のターゲットの場所を調べます。

必須 false
位置 2
既定値 none
パイプライン入力を許可する false
ワイルドカード文字を許可する false

-MachineName <String>
バックアップを削除するためのコンピューター名を指定します。

-BackupTarget パラメーターを指定する、もしくは複数のコンピューターが同じ場所のバックアップに格納する場合、このパラメーターを使用します。

必須 false
位置 7
既定値 none
パイプライン入力を許可する false
ワイルドカード文字を許可する false

-NetworkPath <String>
コマンドレットがバックアップから削除するリモート共有フォルダーへのパスを指定します。

必須 true
位置 4
既定値 none
パイプライン入力を許可する false
ワイルドカード文字を許可する false

-NonInheritAcl [<SwitchParameter>]
使用できません。このパラメーターは、モジュールのコモバージョンでは実行されません。

必須 false
位置 6
既定値 none
パイプライン入力を許可する false
ワイルドカード文字を許可する false

-VolumePath <String>
コマンドレットがバックアップを格納したボリュームのドライブ レターを指定します。

必須 true
位置 4
既定値 none
パイプライン入力を許可する false
ワイルドカード文字を許可する false

<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: –Verbose、-Debug、-ErrorAction-ErrorVariable、-WarningAction、-WarningVariable、-OutBuffer、-PipelineVariable、および -OutVariable。詳細については、about_CommonParameters を参照してください。

■入力

  • Windows.ServerBackup.Commands.WBBackupSet, System.Int32, System.Management.Automation.SwitchParameter, Windows.ServerBackup.Commands.WBBackupTarget, System.String, System.Management.Automation.PSCredential

■出力

  • Windows.ServerBackup.Commands.WBBackupSet
  •  

■メモ

  • 詳細については、「Get-Help Remove-WBBackupSet -detailed」と入力してください。
  • 技術情報については、「Get-Help Remove-WBBackupSet -full」と入力してください。

■エイリアス

  • なし

■例

例 1: 古いバックアップ設定を削除する。

$Ret = Remove-WBBackupSet -DeleteOldest -BackupTarget $WB_BackupTarget -MachineName $MachineName -Force

このコマンドは、バックアップ ターゲットから変数 $MachineName 内にあるコンピューターの最も古いバックアップを削除します。コマンドレットは、-Force パラメーターを含むため、削除の確認メッセージは表示されません。

■関連するトピック

  • Get-WBBackupSet

[参考]

スポンサーリンク
スポンサーリンク
スポンサーリンク