Get-WssBackupVolume.md

external help file	Module Name	ms.date	online version	schema	title
WssCmdlets.dll-Help.xml	WSSCmdlets	12/05/2017	https://learn.microsoft.com/powershell/module/wsscmdlets/get-wssbackupvolume?view=windowsserver2012r2-ps&wt.mc_id=ps-gethelp	2.0.0	Get-WssBackupVolume

Get-WssBackupVolume

SYNOPSIS

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

SYNTAX

Policy

Get-WssBackupVolume [-BackupPolicy] <ScheduledBackupPolicy> [<CommonParameters>]

CriticalVolumes

Get-WssBackupVolume [-CriticalVolumes] [<CommonParameters>]

AllVolumes

Get-WssBackupVolume [-AllVolumes] [<CommonParameters>]

FullVolumesOnBackupSet

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
Parameter Sets: AllVolumes
Aliases: 

Required: True
Position: 0
Default value: None
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
Parameter Sets: Policy
Aliases: 

Required: True
Position: 0
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.

Type: SwitchParameter
Parameter Sets: CriticalVolumes
Aliases: 

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

-VolumeData

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

Type: System.Collections.Generic.ICollection`1[Microsoft.WindowsServerSolutions.DataProtection.ServerBackup.ObjectModel.MountVhdData]
Parameter Sets: FullVolumesOnBackupSet
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

System.string

OUTPUTS

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

This cmdlet returns backup volumes.

NOTES

RELATED LINKS

Add-WssBackupVolume

Remove-WssBackupVolume