Windows Server 2008 R2のWindows Serverバックアップで使用できるPowerShellコマンドレット (Remove-WBBackupTarget) について

スポンサーリンク

Windows Server 2008 R2では、Active Directory (AD) やフェールオーバー クラスタリング (WSFC)、グループ ポリシーといった役割および機能がインストールされたサーバーの管理、もしくは管理したい役割および機能についてリモート サーバー管理ツールをインストールしたサーバー上で、PowerShellコマンドレットを用いて管理することが可能です。

各役割および機能に関するPowerShellコマンドレットのヘルプについて、オンライン上で公開されていますが、主に英語のみで日本語の情報はあまり公開されていないようです。

ここでは、Windows Serverバックアップ (WSB) に関するPowerShellコマンドレットの情報について、備忘録という意味でも日本語としてオンライン上で確認したいと思い、本ブログ上で纏めてみました (内容については「Get-Help」コマンドレットの-Fullオプションを用いて実行した結果を編集したものとなります)。

この記事では、「Remove-WBBackupTarget」コマンドレットについて記載します (他のコマンドレットについては、「Windows Server 2008 R2のWindows Serverバックアップで使用できるPowerShellコマンドレットについて」を参照)。

■名前

Remove-WBBackupTarget

■概要

バックアップの保存場所 (WBBackupTargetオブジェクトで定義) をバックアップ ポリシー (WBPolicyオブジェクト) から削除します。

■構文

Remove-WBBackupTarget [-Policy] <WBPolicy> [-Target] <WBBackupTarget>
     [<CommonParameters>]

■説明

Remove-WBBackupTargetコマンドレットは、バックアップの保存場所 (WBBackupTargetオブジェクトで定義) をバックアップ ポリシー (WBPolicyオブジェクト) から削除します。

■パラメーター

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

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

-Target <WBBackupTarget>
バックアップ ポリシー (WBPolicyオブジェクト) から削除するバックアップの保存場所を指定します。

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

<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: VerboseDebugErrorActionErrorVariableWarningActionWarningVariableOutBuffer、およびOutVariable。詳細については、「get-help about_commonparameters」と入力してヘルプを参照してください。

■入力

WBBackupTarget, WBPolicy

  • Remove-WBBackupTargetコマンドレットは、WBBackupTargetオブジェクトをバックアップ ポリシー (WBPolicyオブジェクト) から削除します。

■出力

WBBackupTarget[]

  • Remove-WBBackupTargetコマンドレットは、ポリシーに残っているWBBackupTargetオブジェクトの一覧を表示します。

■メモ

  • WBPolicyオブジェクトは編集モードでなければなりません。スケジュール指定バックアップ ポリシーとして設定されているポリシーのWBPolicyオブジェクトを編集モードに切り替えるには、Get-WBPolicyコマンドレットを-Editableパラメーターと共に使用します。New-WBPolicyコマンドレットでは、既に編集モードの状態で新しい WBPolicyオブジェクトが作成されます。
  • Windows Serverバックアップの各コマンドレットを使用するには、Administratorsグループまたは Backup Operatorsグループのメンバーであることが必要です。

■例

例1

$backupLocations = Get-WBBackupTarget -Policy $policy
Remove-WBBackupTarget -Policy $policy -Target $backupLocations[0]

例1:説明

このコマンドは、指定されたWBBackupTargetオブジェクトをWBPolicyオブジェクト$policyから削除し、ポリシーにまだ残っているバックアップ場所の一覧を表示します。

■関連するリンク

  • Get-WBBackupTarget
  • Get-WBPolicy

[参考]