Get-WssBackupVolume
Get-WssBackupVolume
Gets backup volumes from a server, from a scheduled backup policy, or from existing backups.
Syntax
Parameter Set: AllVolumes
Get-WssBackupVolume [-AllVolumes] [ <CommonParameters>]
Parameter Set: CriticalVolumes
Get-WssBackupVolume [-CriticalVolumes] [ <CommonParameters>]
Parameter Set: FullVolumesOnBackupSet
Get-WssBackupVolume [-VolumeData] <ICollection<MountVhdData>> [ <CommonParameters>]
Parameter Set: Policy
Get-WssBackupVolume [-BackupPolicy] <ScheduledBackupPolicy> [ <CommonParameters>]
Detailed Description
The Get-WssBackupVolume cmdlet gets backup volumes from a server, from a scheduled backup policy, or from an existing backup.
Parameters
-AllVolumes
Indicates that the cmdlet gets all backup volumes from a server.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-BackupPolicy<ScheduledBackupPolicy>
Specifies a scheduled backup policy. The cmdlet gets all backup volumes from this scheduled backup policy.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-CriticalVolumes
Indicates that the cmdlet gets all critical volumes from a server. Critical volumes include the operating system volume and the Active Directory (AD) volume.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VolumeData<ICollection<MountVhdData>>
Specifies a virtual hard disk (VHD) from which to retrieve the volumes.
Aliases |
none |
Required? |
true |
Position? |
1 |
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.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Get critical volumes from a backup
This command gets critical volumes from the server.
PS C:\> Get-WssBackupVolume -CriticalVolumes