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

スポンサーリンク

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

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

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

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

■名前

Add-WBVirtualMachine

■概要

バックアップ ポリシーに、仮想マシンのリストを追加します。

■構文

Add-WBVirtualMachine [-Policy] <WBPolicy> [[-All]] [-Confirm] [-WhatIf] [<CommonParameters>]

Add-WBVirtualMachine [-Policy] <WBPolicy> [[-VirtualMachine] <WBVirtualMachine[]>] [-Confirm] [-WhatIf] [<CommonParameters>]

■説明

Add-WBVirtualMachine コマンドレットは、指定した WBPolicy オブジェクトに含まれたバックアップ ポリシーへ仮想マシンの一覧を追加します。

■パラメーター

-All [<SwitchParameter>]
ポリシーへ追加されるコンピューター上のすべての仮想マシンを示します。

必須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 を参照してください。

■入力

  • なし
    • なし

■出力

  • なし
    • なし

■メモ

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

■エイリアス

  • なし

■例

例 1: バックアップ ポリシーに仮想マシンを追加する。

$Policy = Get-WBPolicy
$VirtualMachines = Get-WBVirtualMachine
Add-WBVirtualMachine -Policy $Policy -VirtualMachine $VirtualMachines

この例では、WBPolicy オブジェクト $Policy へ変数 $VirtualMachines のボリュームの一覧を追加します。

最初のコマンドは、変数 $PolicyGet-WBPolicy コマンドレットの結果を格納します。

2 番目のコマンドは、変数 $VirtualMachinesGet-WBVirtualMachine コマンドレットの結果を格納します。

3 番目のコマンドは、$Policy 変数内のバックアップ ポリシーに変数 $VirtualMachines に一覧化された仮想マシンを追加します。

■関連するトピック

  • Get-WBVirtualMachine
  • Remove-WBVirtualMachine

[参考]