Edit

Share via

Add-WBVolume

  • Reference
Module:
WindowsServerBackup

Adds the list of source volumes to the backup policy.

Syntax

Add-WBVolume
   [-Policy] <WBPolicy>
   [-Volume] <WBVolume[]>
   [<CommonParameters>]

Description

The Add-WBVolume cmdlet adds a list of source volumes to a WBPolicy object.

To use this cmdlet, you must be a member of the Administrators group or Backup Operators group.

Examples

Example 1: Add a list of volumes to a backup policy

PS C:\> $Volumes = Get-WBVolume
PS C:\> $Policy = Get-WBPolicy
PS C:\> Add-WBVolume -Policy $Policy -Volume $Volumes

This example adds a list of volumes for backup to the WBPolicy object.

The first command stores the output of the Get-WBVolume cmdlet in the variable named $Volumes.

The second command calls the Get-WBPolicy cmdlet and assigns the result to the $Policy variable.

The third command adds the volumes in the $Volumes variable to the backup policy.

Parameters

-Policy

Specifies a WBPolicy object that contains the backup policy to update.

Type:WBPolicy
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Volume

Specifies an array of volumes to add to the WBPolicy object.

Type:WBVolume[]
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

Microsoft.Windows.ServerBackup.Commands.WBPolicy

Microsoft.Windows.ServerBackup.Commands.WBVolume[]

Ths cmdlet accepts WBVolume objects, which contain a new list of source volumes for the backup, and WBPolicy objects as input.

Outputs

Object

Notes

  • The WBPolicy object must be in edit mode. To put the WBPolicy object in edit mode for a policy that you set as the scheduled backup policy, use the Get-WBPolicy cmdlet with the Editable parameter. The New-WBPolicy cmdlet creates a new WBPolicy object that is already in edit mode.