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

スポンサーリンク

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

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

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

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

■名前

Remove-WBPolicy

■概要

バックアップ ポリシーを削除します。

■構文

Remove-WBPolicy [[-Policy] <WBPolicy>] [-All] [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]

■説明

Remove-WBPolicy コマンドレットは、WBPolicy オブジェクトを削除します。このコマンドレットは、実行中からスケジュールされた日時バックアップを停止します。バックアップ記憶域の場所がディスクの場合、コマンドレットはディスクを開放します。システムがスケジュールされたバックアップを持っていない場合、コマンドレットは何もしません。

このコマンドレットを使用するには、Administrators グループ、もしくは Backup Operators グループのメンバーである必要があります。

■パラメーター

-All [<SwitchParameter>]
このコマンドレットが、システムに設定した WBPolicy オブジェクトを削除するかどうかを示します。

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

-Force [<SwitchParameter>]
確認のプロンプトを表示せずに、ポリシーを削除します。既定では、実行前に確認のプロンプトをコマンドレット上に表示します。

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

-Policy <WBPolicy>
更新するバックアップ ポリシーオブジェクトを指定します。

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

-Confirm [<SwitchParameter>]
コマンドを実行する前に確認のプロンプトを表示します。

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

-WhatIf [<SwitchParameter>]
コマンドを実行した際に何が起きるかを出力します。コマンドレットは実行されません。

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

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

■入力

  • WBPolicy
    • This cmdlet specifies the WBPolicy object to remove.

■出力

  • なし
    • なし

■メモ

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

■エイリアス

  • なし

■例

例 1: スケジュールされたすべてのバックアップを削除する。

Remove-WBPolicy -All -Force

このコマンドは、現在設定された WBPolicy オブジェクトを削除し、システム上のスケジュールされたすべてのバックアップを無効にします。コマンドは、確認のメッセージを抑制するために -Force パラメーター使用します。

例 2: 指定したバックアップ ポリシーを削除する。

$Policy = Get-WBPolicy
Remove-WBPolicy -Policy $Policy

このコマンドは、変数 $PolicyGet-WBPolicy コマンドレットの結果を格納し、システム上のスケジュールされたすべてのバックアップを無効にした WBPolicy オブジェクトを削除します。

■関連するトピック

  • Get-WBPolicy
  • New-WBPolicy
  • Set-WBPolicy

[参考]