Get-WBBackupVolumeBrowsePath
Get-WBBackupVolumeBrowsePath
Mounts a volume inside a backup so that you can browse the files on the volume.
Syntax
Parameter Set: Default
Get-WBBackupVolumeBrowsePath [-BackupSet] <WBBackupSet> [-VolumeInBackup] <WBVolume> [ <CommonParameters>]
Detailed Description
The Get-WBBackupVolumeBrowsePath cmdlet mounts a volume in a WBBackup object that contains a backup so that you can browse the files on the volume. You can use the path that this cmdlet returns as a parameter to a Start-WBFileRecovery cmdlet to specify a file recovery path.
Parameters
-BackupSet<WBBackupSet>
Specifies a WBBackupSet object that contains the backup set from which to mount the volume.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VolumeInBackup<WBVolume>
Specifies a WBVolume object that contains the volume in the backup set object to mount for browsing. This parameter must be an object from the WBBackupSet.Volume array.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
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.
WBBackup, WBVolume
You must specify the WBBackupSet object that contains the backup set along with the WBVolume object that contains the volume inside the backup set.
Outputs
The output type is the type of the objects that the cmdlet emits.
System.String
Returns the mount path for the volume that you back up if the mount is successful. You can use the mount path with a dir command to browse the volume or specify the file recovery path as a parameter to the Start-WBFileRecovery cmdlet. This path is valid for only 10 minutes, and Windows Server® 2012 Backup deletes the mount path after that. To continue browsing this path, call the Get-WBBackupVolumeBrowsePath cmdlet again with the same parameters within the 10-minute interval to make the path valid again for 10 more minutes, and repeat the process as needed.
Examples
Example 1: Get a mount path for a backup volume
This example gets the mount path for a backup volume.
The first command gets server backups from the system catalog and store them in the variable named $Backups.
The second command mounts the volume in element 1 of the Volume array within the backup object in the variable named $Backup.
PS C:\> $Backups = Get-WBBackupSet
PS C:\> Get-WBBackupVolumeBrowsePath -BackupSet $Backup -VolumeInBackup $Backup.Volume[1]
\\Server01\WsbMountedVolumes\WsbMountedVolumeFile13_6fc68703-1c22-11e1-89cd-806e6f6e6963\