Remove-WBVolume
Remove-WBVolume
Removes the volume from the backup policy.
Syntax
Parameter Set: Default
Remove-WBVolume [-Policy] <WBPolicy> [-Volume] <WBVolume> [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-WBVolume cmdlet removes the WBVolume object from the WBPolicy object.
To use this or any other Windows Server 2012 Backup cmdlets, you must be a member of the Administrators group or Backup Operators group.
Parameters
-Policy<WBPolicy>
Specifies the WBPolicy object that contains the policy to update.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Volume<WBVolume>
Specifies the volume to remove from the policy contained in the WBPolicy object.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
WBPolicy,WBVolume
The Remove-WBVolume cmdlet removes the WBVolume object from the policy contained in the WBPolicy object.
Outputs
The output type is the type of the objects that the cmdlet emits.
WBVolume[]
The Remove-WBVolume cmdlet displays 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 new WBPolicy object that is already in edit mode.
Examples
Example 1: Remove a volume from the backup policy
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.
PS C:\> $Policy = Get-WBPolicy
PS C:\> $Volume = Get-WBVolume -VolumePath “E:”
PS C:\> Remove-WBVolume -Policy $Policy -Volume $Volume