Set-VBRApplicationProcessingOptions

In this article

    Short Description

    Modifies application-aware processing settings for Veeam Agent backup jobs.

    Applies to

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

    Syntax

    Set-VBRApplicationProcessingOptions -Options <VBRApplicationProcessingOptions> [-Enable] [-GeneralTransactionLogAction <VBRGeneralTransactionLogAction> {ProcessLogsWithJob | PerformCopyOnly}][-IgnoreErrors] [-SQLProcessingOptions <VBRSQLProcessingOptions>] [-SharePointCredentials <CCredentials>]    
    [-OracleProcessingOptions <VBROracleProcessingOptions>] [-ScriptProcessingOptions <VBRScriptProcessingOptions>][-MySQLProcessingOptions <VBRMySQLProcessingOptions>] [-PostgreSQLProcessingOptions <VBRPostgreSQLProcessingOptions>]  [<CommonParameters>]

    Detailed Description

    This cmdlet modifies application-aware processing 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

    Accept
    Wildcard
    Characters

    Options

    Specifies application processing settings that you want to modify.

    Accepts the VBRApplicationProcessingOptions type.

    True

    Named

    True (ByValue)

     

    Enable

    Enables application-aware processing. Veeam Backup & Replication will turn on the application-aware processing option for the selected protection group or a discovered computer.

    NOTE: For Veeam Agent jobs that back up Linux computers, this parameter will also stop the backup process if any error occurs during application-aware processing.

    False

    Named

    False

     

    IgnoreErrors

    Defines that Veeam Backup & Replication will ignore application processing errors. In case an error occurs during application-aware processing, Veeam Backup & Replication will continue to run the backup job. The resulting backup will be crash-consistent.

    NOTE: This parameter works for Veeam Agent jobs that back up Linux computers only. You must use the Enable parameter to set up processing options with the IgnoreErrors option.

    False

    Named

    False

     

    GeneralTransactionLogAction

    Specifies transaction logs action:

    • ProcessLogsWithJob: use this option to allow Veeam Backup & Replication to process transaction logs.
      NOTE: For Veeam Agent job that backs up Windows computers this option enables SQL and Oracle logs processing options.
    • PerformCopyOnly: use this option if you use another tool to maintain consistency of the database state. Veeam Agent for Microsoft Windows will create a copy-only backup.

    NOTE:

    • This parameter is required for Veeam Agent backup jobs that back up Windows computers.
    • This parameter does not work for Veeam Agent backup jobs that back up Linux computers.

    False

    Named

    False

     

    SQLProcessingOptions

    Specifies SQL processing settings.

    Accepts the VBRSQLProcessingOptions type.

    False

    Named

    False

     

    SharePointCredentials

    Specifies the credentials for the SharePoint user account that has enough permissions on the application. Veeam Agent for Microsoft Windows will use these credentials to connect to SharePoint and to back up the application.

    Accepts the CCredentials type.

    False

    Named

    False

     

    OracleProcessingOptions

    Specifies Oracle processing settings.

    Accepts the VBRScriptProcessingOptions type.

    False

    Named

    False

     

    ScriptProcessingOptions

    Specifies custom script settings. Veeam Agent will run pre-freeze and post-thaw scripts per these settings.

    Accepts the VBRScriptProcessingOptions type.

    False

    Named

    False

     

    MySQLProcessingOptions

    Specifies MySQL processing settings. Veeam Agent will apply these settings to a Veeam Agent backup job.

    Accepts the VBRMySQLProcessingOptions type.

    False

    Named

    False

     

    PostgreSQLProcessingOptions

    Specifies PostgreSQL processing settings. Veeam Agent will apply these settings to a Veeam Agent backup job.

    Accepts the VBRPostgreSQLProcessingOptions type.

    False

    Named

    False

     

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

    Return Type

    Example 1

    This example shows how to disable Oracle and SQL processing settings for a Veeam Agent job that backs up Windows computers.

    1. Run Get-VBRProtectionGroup to get the protection group, for which you want to modify application-aware processing settings. Save the result to the $group variable.
    2. Run New-VBRApplicationProcessingOptions to specify the application-aware processing settings. Save the result to the $processoptions variable.
    3. Run Set-VBRApplicationProcessingOptions with the $group and $processoptions variables. Set the PerformCopyOnly for the GeneralTransactionLogAction parameter to disable transaction logs processing for both Oracle and SQL.

    $group = Get-VBRProtectionGroup -name "Windows Group"

    $processoptions = New-VBRApplicationProcessingOptions -BackupObject $group -OSPlatform Windows -Enable -GeneralTransactionLogAction ProcessLogsWithJob -SQLProcessingOptions $sql -SharePointCredentials $creds

    Set-VBRApplicationProcessingOptions -Options $processoptions -Enable -GeneralTransactionLogAction PerformCopyOnly -SharePointCredentials $creds -ScriptProcessingOptions $script

    Example 2

    This example shows how to modify application-aware processing settings for a Veeam Agent backup job that backs up Linux computers. The job will run with the following options:

    • Veeam Backup & Replication will run pre-freeze and post-thaw scripts to create a transactionally consistent backup.
    • Veeam Backup & Replication will use a user account that has SYSDBA rights on the database to connect to the Oracle database.
    • In case an error occurs, Veeam Backup & Replication will stop the backup job.

    To modify the settings, perform the following steps:

    1. Run Get-VBRProtectionGroup to get the protection group. Save the result to the $group variable.
    2. Run New-VBRApplicationProcessingOptions to specify the application-aware processing settings. Save the result to the $processoptions variable.
    3. Run Set-VBRApplicationProcessingOptions with the $group and $processoptions variables. Use the Enable parameter to stop the backup job in case an error occurs.

    $group = Get-VBRProtectionGroup -Name "Linux Group"

    $processoptions = New-VBRApplicationProcessingOptions -BackupObject $group -OSPlatform Linux -IgnoreErrors -OracleProcessingOptions $oracle -ScriptProcessingOptions $script

    Set-VBRApplicationProcessingOptions -Options $processoptions -OracleProcessingOptions $oracle -ScriptProcessingOptions $script -Enable

    Related Commands

    Get-VBRProtectionGroup

    New-VBRApplicationProcessingOptions