Edit

Share via


Get-WBVssBackupOption

Gets a VSS setting from the backup policy.

Syntax

Default (Default)

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

Description

The Get-WBVSSBackupOption cmdlet gets 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-WBVssBackupOption 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 of the 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 that this cmdlet gets.

Parameter properties

Type:WBPolicy
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.Windows.ServerBackup.Commands.WBPolicy

Outputs

Object