Set-WBVssBackupOption
Set-WBVssBackupOption
Sets a value that determines the VSS setting in the backup policy.
Syntax
Parameter Set: Default
Set-WBVssBackupOption [-Policy] <WBPolicy> [[-VssCopyBackup]] [[-VssFullBackup]] [ <CommonParameters>]
Detailed Description
The Set-WBVssBackupOptions 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 Windows Server 2012 Backup cmdlets, you must be a member of the Administrators group or Backup Operators group.
Parameters
-Policy<WBPolicy>
Specifies the WBPolicy object to update.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VssCopyBackup
Indicates that the backups in the backup policy are VSS copy backups.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VssFullBackup
Indicates that the backups in the backup policy are VSS full backups.
Aliases |
none |
Required? |
false |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
WBPolicy
The Set-WBVssBackupOptions cmdlet queries the specified WBPolicy object.
Outputs
The output type is the type of the objects that the cmdlet emits.
None
None
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.
Examples
Example 1: Set the VSS backup policy
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.
PS C:\> $Policy = Get-WBPolicy
PS C:\> Set-WBVssBackupOptions -Policy $Policy -VssFullBackup
Related topics
Get-WBVssBackupOptions