Get-WBBackupTarget
Get-WBBackupTarget
Gets backup storage locations that you specified as part of a backup policy.
Syntax
Parameter Set: Policy
Get-WBBackupTarget [-Policy] <WBPolicy> [ <CommonParameters>]
Detailed Description
The Get-WBBackupTarget cmdlet gets backup storage locations that you specified for a WBPolicy object that contains a backup policy. Valid locations include disks, volumes, or remote shared folders. To view the list of all online disks, use the Get-WBDisk cmdlet.
You can add the locations that the cmdlet returns to a WBPolicy object by specifying them as backup storage locations to the New-WBBackupTarget cmdlet.
To use Windows Server® 2012 Backup cmdlets, you must be a member of the Administrators group or Backup Operators group.
Parameters
-Policy<WBPolicy>
Specifies a backup policy object for which to display information.
Aliases |
InPolicy |
Required? |
true |
Position? |
1 |
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.
WBPolicy
The Get-WBBackupTarget cmdlet queries the backup policy contained in the specified WBPolicy object.
Outputs
The output type is the type of the objects that the cmdlet emits.
WBBackupTarget []
The Get-WBBackupTarget cmdlet displays a list of the storage locations that the backup policy object contains.
Examples
Example 1: Get a list of backup targets
This example gets a list of the storage backup locations from a backup policy.
The first command gets the current backup policy and stores it in a variable named $Policy.
The second command gets the list of storage backup locations from the WBPolicy object that is stored in the $Policy variable.
PS C:\> $Policy = Get-WBPolicy
PS C:\> Get-WBBackupTarget -Policy $Policy