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

スポンサーリンク

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

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

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

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

■名前

Remove-WBFileSpec

■概要

バックアップ ポリシーからバックアップ ファイル仕様を削除します。

■構文

Remove-WBFileSpec [-Policy] <WBPolicy> [-FileSpec] <WBFileSpec> [-Confirm] [-WhatIf] [<CommonParameters>]

■説明

Remove-WBFileSpec コマンドレットは、バックアップ ポリシーが含まれる WBPolicy オブジェクトからバックアップ ファイル仕様が含まれる WBFileSpec オブジェクトを削除します。バックアップ ファイル仕様は、バックアップ ポリシーを使用するバックアップから含まれる、除外する項目の一覧を含みます。

WBPolicy オブジェクトからバックアップ ファイル使用を削除する前に、WBPolicy オブジェクトを編集モードにする必要があります。スケジュールされたバックアップ ポリシーとして設定されたポリシーに対して、WBPolicy オブジェクトを編集モードとするには、-Editable パラメーターとともに Get-WBPolicy コマンドレットを使用します。New-WBPolicy コマンドレットは、すでに編集モードにある新しい WBPolicy オブジェクトを作成します。

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

■パラメーター

-FileSpec <WBFileSpec>
WBPolicy
オブジェクトから削除するバックアップ ファイル仕様オブジェクトを指定します。

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

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

必須true
位置1
既定値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 を参照してください。

■入力

  • WBFileSpec, WBPolicy
    • Remove-WBFileSpec コマンドレットは、WBPolicy オブジェクトから WBFileSpec オブジェクトを削除します。

■出力

  • なし
    • なし

■メモ

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

■エイリアス

  • なし

■例

例 1: バックアップ ポリシーからバックアップ ファイル仕様を削除する。

$Filespeclist = Get-WBFileSpec -Policy $policy
Remove-WBFileSpec -Policy $policy -FileSpec $Filespeclist[1]

この例では、バックアップ ポリシーからバックアップ ファイル仕様を削除します。

最初のコマンドは、変数 $Policy 内のバックアップ ポリシーからバックアップ ファイル仕様の一覧を取得します。コマンドは、変数 $Filespeclist 内の配列へバックアップ ファイル仕様を割り当てます。

2 番目のコマンドは、変数 $Policy 内のポリシーから、変数 $Filespeclist の最初の要素にあるバックアップ ファイル仕様を削除します。

■関連するトピック

  • Get-WBFileSpec
  • Get-WBPolicy

[参考]