New-VBRApplicationProcessingOptions

In this article

    Short Description

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

    Applies to

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

    Syntax

    New-VBRApplicationProcessingOptions -BackupObject <Object> -OSPlatform <VBRAgentType> {Windows | Linux | Mac} [-Enable] [-GeneralTransactionLogAction <VBRGeneralTransactionLogAction> {ProcessLogsWithJob | PerformCopyOnly}][-IgnoreErrors] [-SQLProcessingOptions <VBRSQLProcessingOptions>] [-SharePointCredentials <CCredentials>][-OracleProcessingOptions <VBROracleProcessingOptions>][-ScriptProcessingOptions <VBRScriptProcessingOptions>][-MySQLProcessingOptions <VBRMySQLProcessingOptions>] [-PostgreSQLProcessingOptions <VBRPostgreSQLProcessingOptions>]  [<CommonParameters>]

    Detailed Description

    This cmdlet creates the VBRApplicationProcessingOptions object. This object contains application-aware processing settings for Veeam Agent backup jobs.

    For more information about job application-aware settings, see the Application-Aware Processing section of the Veeam Agent Management Guide.

    New-VBRApplicationProcessingOptions Note:

    You cannot set up application-aware processing for Veeam Agent jobs that back up workstations.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    BackupObject

    Specifies a protection group or a discovered computer, for which you want to set up application-aware processing settings.

    True

    Named

    True (ByValue)

     

    OSPlatform

    Specifies the OS of the protected computers:

    • Windows: for Windows computers.
    • Linux: for Linux computers.
    • Mac: for macOS computers.
      NOTE: Application-aware processing for macOS computers is not supported in current version of Veeam PowerShell.

    True

    Named

    False

     

    Enable

    Enables application-aware processing. Veeam Backup & Replication will turn on 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

    Indicates 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 jobs that back up Windows computers, this option enables SQL and Oracle logs processing options.
    • PerformCopyOnly: use this option if you have 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 jobs that back up Windows computers.
    • This parameter does not work for Veeam Agent 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 VBROracleProcessingOptions 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 specify application-aware processing settings for a Veeam Agent 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 an Oracle database.
    • In case an error occurs during application-aware processing, Veeam Backup & Replication will proceed with the backup job and will create a crash-consistent backup.

    To create application-aware processing settings, perform the following steps:

    1. Run New-VBRScriptProcessingOptions to specify script processing settings. Save the result to the $script variable.
    2. Run Get-Credential to specify credentials for the Oracle database. Save the result to the $creds variable.
    3. Run New-VBROracleProcessingOptions with the $creds variable to specify Oracle processing settings. Save the result to the $oracle variable.
    4. Run Get-VBRProtectionGroup to get the protection group for which you want to set up application-aware processing settings. Save the result to the $group variable.
    5. Run New-VBRApplicationProcessingOptions with the $script and $oracle variables. Use the IgnoreErrors parameter to proceed with the backup job in case an error occurs.

    $script = New-VBRScriptProcessingOptions -ProcessingAction RequireSuccess -ScriptPrefreezeCommand "C:\scripts\pre-scipt.bat" -ScriptPostthawCommand
    "C:\scripts\post-script.bat"

    $creds = Get-Credential

    $oracle = New-VBROracleProcessingOptions -Credentials $creds

    $group = Get-VBRProtectionGroup -Name "LinuxGroup"

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

    Example 2

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

    • Veeam Backup & Replication will apply SQL processing settings.
    • Veeam Backup & Replication will use SharePoint admin credentials.

    To create application-aware processing settings, perform the following steps:

    1. Run Get-Credential to specify the user credentials for SharePoint. Save the result to the $creds variable.
    2. Run Get-VBRProtectionGroup to get the protection group. Save the result to the $group variable.
    3. Run New-VBRSQLProcessingOptions to specify SQL processing settings. Save the result to the $sql variable.
    4. Run New-VBRApplicationProcessingOptions with the $creds and $sql variables. Set the ProcessLogsWithJob value for the GeneralTransactionLogAction parameter to enable SQL transaction log processing.

    $creds = Get-Credential

    $group = Get-VBRProtectionGroup -name "WindowsGroup"

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

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

    Related Commands

    New-VBRScriptProcessingOptions

    New-VBROracleProcessingOptions

    Get-VBRProtectionGroup

    New-VBRSQLProcessingOptions