Get-WBBackupSet
Get-WBBackupSet
Gets backups for a server from a location that you specify.
Syntax
Parameter Set: Default
Get-WBBackupSet [[-BackupTarget] <WBBackupTarget> ] [[-MachineName] <String> ] [ <CommonParameters>]
Detailed Description
The Get-WBBackupSet cmdlet gets a list of WBBackupSet objects that contain backups for a server from a location that you specify. A WBBackupSet object contains information about the backup time and date, the backed-up computer, the backup type, and the items that were part of the backup.
To use Windows Server® 2012 Backup cmdlets, you must be a member of the Administrators group or Backup Operators group.
Parameters
-BackupTarget<WBBackupTarget>
Specifies a WBBackupTarget object. This object includes the storage location that contains the backups for which you want details.
Use this parameter to get information about backups of computers other than the local computer. The cmdlet lists the backup sets from the catalog on the computer that you specify, not from the system catalog of the local computer. Alternate locations can be locally attached disk drives or remote shared folders.
When you specify this parameter along with the MachineName parameter, the cmdlet returns backup information from the storage location that you specify in this parameter. This storage location is on the server that you specify in the MachineName parameter.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-MachineName<String>
Specifies the computer for which you want backup details.
Use this parameter when backups of different computers appear in the same location or when you use the BackupTarget parameter to specify a storage location that contains the backup details.
When you specify this parameter along with the BackupTarget parameter, the cmdlet returns backup information from the storage location that you specify in the BackupTarget parameter. The storage location is on the server that you specify in this parameter.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
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.
WBBackupTarget
The Get-WBBackupSet cmdlet uses a WBBackupTarget object to determine the computer from which to load the catalog and get backup information.
Outputs
The output type is the type of the objects that the cmdlet emits.
WBBackupSet[]
The Get-WBBackupSet cmdlet displays the list of WBBackupSet objects from the local system catalog or from the catalog on the computer that stores the backup sets. The WBBackupTarget parameter specifies the location of this computer.
Examples
Example 1: Get server backups from the system catalog
This command gets server backups from the system catalog and stores them in the $Backups variable.
PS C:\> $Backups = Get-WBBackupSet
Example 2: Get server backups from a specific location
This example queries the catalog at a specific storage location for backups.
The first command creates a backup target on the volume that has the drive letter D: and stores this location in the variable named $BackupLocation.
The second command gets backup data from the backup target in $BackupLocation and then stores this data in the variable named $Backups.
PS C:\> $BackupLocation = New-WBBackupTarget -VolumePath D:
PS C:\> $Backups = Get-WBBackupSet -BackupTarget $BackupLocation