Remove-WBVolume
Syntax
Remove-WBVolume
[-Policy] <WBPolicy>
[-Volume] <WBVolume>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Remove-WBVolume cmdlet removes the WBVolume object from the WBPolicy object.
To use this cmdlet, you must be a member of the Administrators group or Backup Operators group.
Examples
Example 1: Remove a volume from the backup policy
PS C:\> $Policy = Get-WBPolicy
PS C:\> $Volume = Get-WBVolume -VolumePath "E:"
PS C:\> Remove-WBVolume -Policy $Policy -Volume $Volume
This example removes the specified volume from the backup policy. The output is the list of volumes left in the WBPolicy object.
The first command stores the output of Get-WBPolicy in the variable named $Policy.
The second command stores the output of Get-WBVolume in the variable $Volume.
The third command uses Remove-WBVolume to remove the volumes in the variable $Volume from the backup policy object.
Required Parameters
Specifies the WBPolicy object that contains the policy that this cmdlet updates.
Type: | WBPolicy |
Position: | 0 |
Default value: | None |
Accept pipeline input: | True (ByPropertyName) |
Accept wildcard characters: | False |
Specifies the volume that this cmdlet removes from the policy contained in the WBPolicy object.
Type: | WBVolume |
Position: | 1 |
Default value: | None |
Accept pipeline input: | True (ByPropertyName, ByValue) |
Accept wildcard characters: | False |
Optional Parameters
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
WBPolicy,WBVolume
This cmdlet removes the WBVolume object from the policy contained in the WBPolicy object.
Outputs
WBVolume[]
This cmdlet returns a the list of WBVolume objects left in WBPolicy after the cmdlet removes the specified WBVolume 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 WBPolicy object that is already in edit mode.