Set-WBVssBackupOption
Sets a value that determines the VSS setting in the backup policy.
Syntax
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.
Type: | WBPolicy |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-VssCopyBackup
Indicates that the backups in the backup policy are VSS copy backups.
Type: | SwitchParameter |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-VssFullBackup
Indicates that the backups in the backup policy are VSS full backups.
Type: | SwitchParameter |
Position: | 2 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Microsoft.Windows.ServerBackup.Commands.WBPolicy
Outputs
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.