Share via


Set-WBVssBackupOptions

Set-WBVssBackupOptions

Sets a value that specifies whether the backups that are created using the backup policy (WBPolicy object) are Volume Shadow Copy Service (VSS) copy backups or VSS full backups.

Syntax

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

Detailed Description

The Set-WBVssBackupOptions cmdlet sets a value that specifies whether the backups that are created using the backup policy (WBPolicy object) are Volume Shadow Copy Service (VSS) copy backups or VSS full backups. Choose to 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 clears the application log files. Choose to 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.

Parameters

-Policy <WBPolicy>

Specifies the backup policy (WBPolicy object) to update.

Attributes

Name Value

Required?

true

Accept wildcard characters?

false

Accept Pipeline Input?

true (ByValue)

Position?

1

-VssCopyBackup <SwitchParameter>

Specifies that the backups in the backup policy should be VSS copy backups.

Attributes

Name Value

Required?

false

Accept wildcard characters?

false

Accept Pipeline Input?

false

Position?

2

-VssFullBackup <SwitchParameter>

Specifies that the backups in the backup policy should be VSS full backups.

Attributes

Name Value

Required?

false

Accept wildcard characters?

false

Accept Pipeline Input?

false

Position?

3

-CommonParameter

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

Input and Return Types

The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet emits.

Notes

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

  • To use Windows Server Backup cmdlets, you must be a member of the Administrators group or Backup Operators group.

Examples

EXAMPLE 1

C:\PS>Set-WBVssBackupOptions -Policy $policy -VssFullBackup

None

Description

-----------

Specifies that the backups created using the WBPolicy object $policy) should be VSS full backups.

EXAMPLE 2

C:\PS>Set-WBVssBackupOptions -Policy $policy -VssCopyBackup

None

Description

-----------

Specifies that the backups created using the WBPolicy object $policy should be VSS copy backups.

See Also

Reference

Get-WBVssBackupOptions