This is an archive version of the document. To get the most up-to-date information, see the current version.

Set-VBRSQLProcessingOptions

Short Description

Modifies settings for processing Microsoft SQL database transaction logs.

Applies to

Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Set-VBRSQLProcessingOptions -Options <VBRSQLProcessingOptions> [-Credentials <CCredentials>] [-TransactionAction <VBRSQLTransactionLogAction> {Truncate | NotTruncate | BackupPeriodically}] [-LogBackupPeriod <int>][-LogRetainAction <VBRLogRetainAction> {WaitForBackupDeletion | KeepOnlyLastDays}] [-LogRetainPeriod <int>] [<CommonParameters>]

Detailed Description

This cmdlet modifies Microsoft SQL database transaction logs settings for Veeam Agent backup jobs. To modify settings, enter the necessary parameters with new values. The parameters that you omit will remain unchanged.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input
Options	Specifies SQL transaction logs processing settings that you want to modify. Accepts the VBRSQLProcessingOptions type.	True	Named	True (ByValue)
Credentials	Specifies the credentials that Veeam Agent for Microsoft Windows will use to connect to the Microsoft SQL Server.	False	Named	False
TransactionAction	Specifies transaction logs processing. Truncate: use this option to truncate transaction logs after the successful backup job. NotTruncate: use this option to preserve transaction logs after the backup job completes. BackupPeriodically: use this option to back up transaction logs periodically.	False	Named	False
LogBackupPeriod	For the BackupPeriodically action. Specifies the number of minutes for transaction logs backups.	False	Named	False
LogRetainAction	For the BackupPeriodically action. Specifies retention policy for transaction logs stored in the backup location. WaitForBackupDeletion: use this option to keep transaction logs backups the same period as image-level backups. KeepOnlyLastDays: use this option to keep transaction log backups for a specific number of days.	False	Named	False
LogRetainPeriod	For the BackupPeriodically action. Specifies the number of days to keep the transaction logs.	False	Named	False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Return Type

Example

This example shows how to modify the existing SQL processing settings for a Veeam Agent job that backs up Windows computers. The job will run with the following options:

Veeam Backup & Replication will back up the transaction logs every 30 minutes.
Veeam Backup & Replication will keep the transaction logs backups until the image-level backup is deleted.

To modify the settings, perform the following steps:

Run New-VBRSQLProcessingOptions to specify SQL processing settings. Save the result to the $sql variable.
Run Set-VBRSQLProcessingOptions with the $sql variable. Specify the WaitForBackupDeletion value for the LogRetainAction parameter to keep the transaction logs until the image-level backup is deleted.

$sql = New-VBRSQLProcessingOptions -TransactionAction BackupPeriodically -LogBackupPeriod 25 -LogRetainAction KeepOnlyLastDays -LogRetainPeriod 7

Set-VBRSQLProcessingOptions -Options $sql -TransactionAction BackupPeriodically -LogBackupPeriod 30 -LogRetainAction WaitForBackupDeletion

Related Commands

New-VBRSQLProcessingOptions