Help Center
Choose product document...
Veeam Backup & Replication 9.5 Update 4
PowerShell Reference

New-VBRApplicationProcessingOptions

Short Description

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

Applies to

Product Edition: Community, Standard, Enterprise, Enterprise Plus

Syntax

New-VBRApplicationProcessingOptions -BackupObject <Object> -OSPlatform <VBRAgentType> {Windows | Linux} [-Enable] [-GeneralTransactionLogAction <VBRGeneralTransactionLogAction> {ProcessLogsWithJob | PerformCopyOnly}][-IgnoreErrors] [-SQLProcessingOptions <VBRSQLProcessingOptions>] [-SharePointCredentials <CCredentials>][-OracleProcessingOptions <VBROracleProcessingOptions>][-ScriptProcessingOptions <VBRScriptProcessingOptions>][<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.

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

 

GeneralTransaction
LogAction

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

 

SQLProcessing
Options

Specifies SQL processing settings.

Accepts the VBRSQLProcessingOptions type.

False

Named

False

 

SharePoint
Credentials

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

 

OracleProcessing
Options

Specifies Oracle processing settings.

Accepts the VBROracleProcessingOptions type.

False

Named

False

 

ScriptProcessing
Options

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

Accepts the VBRScriptProcessingOptions 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.

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

PS C:\PS> $creds = Get-Credential

PS C:\PS> $oracle = New-VBROracleProcessingOptions -Credentials $creds

PS C:\PS> $group = Get-VBRProtectionGroup -Name "LinuxGroup"

PS C:\PS> 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.

PS C:\PS> $creds = Get-Credential

PS C:\PS> $group = Get-VBRProtectionGroup -name "WindowsGroup"

PS C:\PS> $sql = New-VBRSQLProcessingOptions -TransactionAction BackupPeriodically -LogBackupPeriod 25 -LogRetainAction KeepOnlyLastDays -LogRetainPeriod 7

PS C:\PS> New-VBRApplicationProcessingOptions -BackupObject $group -OSPlatform Windows -Enable -GeneralTransactionLogAction ProcessLogsWithJob -SQLProcessingOptions $sql -SharePointCredentials $creds

Related Commands

New-VBRScriptProcessingOptions

New-VBROracleProcessingOptions

Get-VBRProtectionGroup

New-VBRSQLProcessingOptions

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation