Add-WBBackupTarget
Add-WBBackupTarget
Adds a backup target to a backup policy.
Syntax
Parameter Set: Default
Add-WBBackupTarget [-Policy] <WBPolicy> [-Target] <WBBackupTarget> [[-Force]] [ <CommonParameters>]
Detailed Description
The Add-WBBackupTarget cmdlet adds a WBBackupTarget object, which specifies backup storage locations, to a WBPolicy object that contains a backup policy. To use this cmdlet, you must first use the New-WBBackupTarget cmdlet to create a WBBackupTarget object. You can then use the Add-WBBackupTarget cmdlet to specify the storage location by using a disk, a volume, or a remote shared folder (network) location.
Before you can add a backup target to a WBPolicy object, you must make sure that the WBPolicy object is in edit mode. To put the WBPolicy object in edit mode for a policy that you have 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.
If you specify a disk as a storage location for backups, the server formats the disk before it uses the disk and permanently deletes any existing data on the disk.
You can add only one storage type at a time to a policy. If you specify a shared folder as the storage location, you cannot add more locations because you can specify only one shared folder as a storage location at any time. However, you can specify multiple disks or volumes at one time by calling Add-WBBackupTarget for each location.
To use Windows Server® 2012 Backup cmdlets, you must be a member of the Administrators group or Backup Operators group.
Parameters
-Force
Indicates that the cmdlet adds the backup target without prompting you for confirmation. By default, the cmdlet prompts you for confirmation before it proceeds.
Aliases |
none |
Required? |
false |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Policy<WBPolicy>
Specifies a backup policy object that contains the backup policy to update.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Target<WBBackupTarget>
Specifies a backup target object that contains the backup storage location to add to the backup policy.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
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.
WBBackupTarget, WBPolicy
The Add-WBBackupTarget cmdlet adds a WBBackupTarget object, which contains new backup storage locations, to a WBPolicy object that contains a backup policy. To add more than one storage location, you must call Add-WBBackupTarget separately for each location.
Outputs
The output type is the type of the objects that the cmdlet emits.
WBBackupTarget[]
The Add-WBBackupTarget cmdlet displays a list of storage locations from the WBPolicy objects that contain the backup policies.
Examples
Example 1: Add a backup storage location to a backup policy
This example adds a backup storage location to a backup policy.
The first command gets the current backup policy and stores it in a variable named $Policy.
The second command adds the backup storage location in the variable named $BackupLocation to the WBPolicy object in the variable named $Policy. You can create the backup target that you add to the location in the $BackupLocation variable by using the New-WBBackupTarget cmdlet.
PS C:\> $Policy = Get-WBPolicy
PS C:\> Add-WBBackupTarget -Policy $Policy -Target $BackupLocation