Edit

Share via

Get-WBBackupTarget

  • Reference
Module:
WindowsServerBackup

Gets backup storage locations that you specified as part of a backup policy.

Syntax

Get-WBBackupTarget
   [-Policy] <WBPolicy>
   [<CommonParameters>]

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 this cmdlet, you must be a member of the Administrators group or Backup Operators group.

Examples

Example 1: Get a list of backup targets

PS C:\> $Policy = Get-WBPolicy
PS C:\> Get-WBBackupTarget -Policy $Policy

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.

Parameters

-Policy

Specifies a backup policy object for which to display information.

Type:WBPolicy
Aliases:InPolicy
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

WBPolicy

The Get-WBBackupTarget cmdlet queries the backup policy contained in the specified WBPolicy object.

Outputs

WBBackupTarget []

The Get-WBBackupTarget cmdlet displays a list of the storage locations that the backup policy object contains.