Edit

Get-WssBackupVolume

  • Reference
Module:
WSSCmdlets

Gets backup volumes from a server, from a scheduled backup policy, or from existing backups.

Syntax

Get-WssBackupVolume
   [-BackupPolicy] <ScheduledBackupPolicy>
   [<CommonParameters>]
Get-WssBackupVolume
   [-CriticalVolumes]
   [<CommonParameters>]
Get-WssBackupVolume
   [-AllVolumes]
   [<CommonParameters>]
Get-WssBackupVolume
   [-VolumeData] <System.Collections.Generic.ICollection`1[Microsoft.WindowsServerSolutions.DataProtection.ServerBackup.ObjectModel.MountVhdData]>
   [<CommonParameters>]

Description

The Get-WssBackupVolume cmdlet gets backup volumes from a server, from a scheduled backup policy, or from an existing backup.

Examples

Example 1: Get critical volumes from a backup

PS C:\> Get-WssBackupVolume -CriticalVolumes

This command gets critical volumes from the server.

Parameters

-AllVolumes

Indicates that the cmdlet gets all backup volumes from a server.

Type:SwitchParameter
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-BackupPolicy

Specifies a scheduled backup policy. The cmdlet gets all backup volumes from this scheduled backup policy.

Type:ScheduledBackupPolicy
Position:0
Default value:None
Required:True
Accept pipeline input:True
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.

Type:SwitchParameter
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-VolumeData

Specifies a virtual hard disk (VHD) from which to retrieve the volumes.

Type:ICollection<T>[Microsoft.WindowsServerSolutions.DataProtection.ServerBackup.ObjectModel.MountVhdData]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

System.string

Outputs

Microsoft.WindowsServerSolutions.DataProtection.PCBackup.BackupUtil.WcfContracts.ClientVolumeInfo

This cmdlet returns backup volumes.