Remove-WBBackupTarget
Remove-WBBackupTarget
Removes the backup storage locations (defined by the WBBackupTarget object) from the backup policy (WBPolicy object).
Syntax
Remove-WBBackupTarget [-Policy] <WBPolicy> [-Target] <WBBackupTarget> [<CommonParameters>]
Detailed Description
The Remove-WBBackupTarget cmdlet removes the backup storage locations (defined by the WBBackupTarget object) from the backup policy (WBPolicy object).
Parameters
-Policy <WBPolicy>
Specifies the backup policy (WBPolicy object) to update.
Attributes
| Name | Value |
|---|---|
Required? |
true |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
true (ByPropertyName) |
Position? |
1 |
-Target <WBBackupTarget>
Specifies the backup storage location to remove from the backup policy (WBPolicy object).
Attributes
| Name | Value |
|---|---|
Required? |
true |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
true (ByPropertyName) |
Position? |
2 |
-CommonParameter
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, and OutVariable. For more information, see about_CommonParameters.
Input and Return Types
The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet emits.
Notes
The WBPolicy object must be in edit mode. To put the WBPolicy object in edit mode for a policy that has been set as the scheduled backup policy, use the Get-WBPolicy cmdlet with the -Editable parameter. The New-WBPolicy cmdlet creates a new WBPolicy object already in edit mode.
To use Windows Server Backup cmdlets, you must be a member of the Administrators group or Backup Operators group.
Examples
EXAMPLE 1
C:\PS>$backupLocations = Get-WBBackupTarget -Policy $policy
Remove-WBBackupTarget -Policy $policy -Target $backupLocations[0]
A list of backup locations left in the WBPolicy object.
Description
-----------
Removes the specified WBBackupTarget object from the WBPolicy object $policy and displays the list of backup locations still left in the policy.