Edit

Share via

Get-WBVssBackupOption

  • Reference
Module:
WindowsServerBackup

Retrieves a VSS setting from the backup policy.

Syntax

Get-WBVssBackupOption
   [-Policy] <WBPolicy>
   [<CommonParameters>]

Description

The Get-WBVSSBackupOptions cmdlet retrieves a setting that determines whether the backups created through the WBPolicy object are Volume Shadow Copy Service (VSS) copy backups or VSS full backups. For more information about VSS copy backups and VSS full backups, or to change this setting, refer to the Set-WBVSSBackupOptions cmdlet.

To use this cmdlet, you must be a member of the Administrators group or Backup Operators group.

Examples

Example 1: Get the VSS setting from the backup policy

PS C:\>$Policy = Get-WBPolicy
PS C:\> Get-WBVssBackupOption -Policy $Policy

This example gets the VSS setting, either VssCopyBackup or VssFullBackup.

The first command stores the result ofthe Get-WBPolicy cmdlet in the variable named $Policy.

The second command gets the VSS setting from the variable $Policy.

Parameters

-Policy

Specifies the WBPolicy object to display.

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

Inputs

WBPolicy

The Get-WBVssBackupOptions cmdlet queries the WBPolicy object.

Outputs

Microsoft.Windows.ServerBackup.Commands.VssBackupOptions

The Get-WBVssBackupOptions cmdlet returns either VssCopyBackup or VssFullBackup, depending on the option specified in the WBPolicy object.