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

スポンサーリンク

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

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

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

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

■名前

Remove-WBVirtualMachine

■概要

バックアップ ポリシーから仮想マシンのリストを削除します。

■構文

Set-WBSchedule [-Policy] <WBPolicy> [-Schedule] <DateTime[]> [<CommonParameters>]

■説明

Remove-WBVirtualMachine コマンドレットは、WBPolicy オブジェクトに含まれるバックアップ ポリシーから仮想マシンの一覧を削除します。

■パラメーター

-All [<SwitchParameter>]
WBPolicy オブジェクトに含まれるバックアップからすべての仮想マシンを削除するかどうかを示します。

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

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

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

-VirtualMachine <WBVirtualMachine[]>
WBPolicy
オブジェクトに含まれたバックアップ ポリシーから 1 つもしくは複数の削除する仮想マシンの配列を指定します。

必須false
位置2
既定値none
パイプライン入力を許可するTrue (ByValue)
ワイルドカード文字を許可する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 を参照してください。

■入力

  • Windows.ServerBackup.Commands.WBPolicy

■出力

  • Windows.ServerBackup.Commands.WBVirtualMachine[]  

■メモ

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

■エイリアス

  • なし

■例

例 1: バックアップ ポリシーから仮想マシンを削除します。

$Policy = Get-WBPolicy
Remove-WBVirtualMachine $Policy -All

この例では、バックアップ ポリシーからすべての仮想マシンを削除します。

最初のコマンドは、Get-WBPolicy コマンドレットを呼び出し、その結果を変数 $Policy に割り当てます。

2 番目のコマンドは、変数 $Policy のバックアップ ポリシーから仮想マシンを削除します。

■関連するトピック

  • Add-WBVirtualMachine
  • Get-WBVirtualMachine

[参考]