Edit

Share via


Set-WBVssBackupOption

Sets a value that determines the VSS setting in the backup policy.

Syntax

Default (Default)

Set-WBVssBackupOption
    [-Policy] <WBPolicy>
    [-VssCopyBackup]
    [-VssFullBackup]
    [<CommonParameters>]

Description

The Set-WBVssBackupOption cmdlet sets a value that determines whether the backups created through the WBPolicy object are Volume Shadow Copy Service (VSS) copy backups or VSS full backups.

Create VSS full backups if you are not using any other product to back up applications. This option updates the backup history of each file and deletes the application log files. Create VSS copy backups if you are using another product to back up applications that are on the volumes included in the backup. This option retains the application log files.

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

Examples

Example 1: Set the VSS backup policy

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

This example sets the backup policy to create backups that are VSS full backups.

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

The second command sets the VSS setting for the backup policy in the $Policy variable.

Parameters

-Policy

Specifies the WBPolicy object to update.

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

-VssCopyBackup

Indicates that the backups in the backup policy are VSS copy backups.

Parameter properties

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

Parameter sets

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

-VssFullBackup

Indicates that the backups in the backup policy are VSS full backups.

Parameter properties

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

Parameter sets

(All)
Position:2
Mandatory:False
Value from pipeline:False
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

Notes

  • The WBPolicy object must be in edit mode. To put the WBPolicy object in edit mode for a policy that you set as the scheduled backup policy, use the New-WBPolicy cmdlet with the Editable parameter. The New-WBPolicy cmdlet creates a new WBPolicy object that is already in edit mode.