New-VBRApplicationProcessingOptions

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	Type	Required	Position	Accept Pipeline Input
BackupObject	Specifies a protection group or a discovered computer, for which you want to set up application-aware processing settings.	Accepts the Object object. To get this object, run the Get-VBRProtectionGroup cmdlet.	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.	VBRAgentType	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.	SwitchParameter	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.	SwitchParameter	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.	VBRGeneralTransactionLogAction	False	Named	False
SQLProcessingOptions	Specifies SQL processing settings.	Accepts the VBRSQLProcessingOptions object. To get this object, run the New-VBRSQLProcessingOptions cmdlet.	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 object. To get this object, run the Get-VBRCredentials cmdlet.	False	Named	False
OracleProcessingOptions	Specifies Oracle processing settings.	Accepts the VBROracleProcessingOptions object. To get this object, run the New-VBROracleProcessingOptions cmdlet.	False	Named	False
ScriptProcessingOptions	Specifies custom script settings. Veeam Agent will run pre-freeze and post-thaw scripts per these settings.	Accepts the VBRScriptProcessingOptions object. To get this object, run the New-VBRScriptProcessingOptions cmdlet.	False	Named	False
MySQLProcessingOptions	Specifies MySQL processing settings. Veeam Agent will apply these settings to a Veeam Agent backup job.	Accepts the VBRMySQLProcessingOptions object. To get this object, run the New-VBRMySQLProcessingOptions cmdlet.	False	Named	False
PostgreSQLProcessingOptions	Specifies PostgreSQL processing settings. Veeam Agent will apply these settings to a Veeam Agent backup job.	Accepts the VBRPostgreSQLProcessingOptions object. To get this object, run the New-VBRPostgreSQLProcessingOptions cmdlet.	False	Named	False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

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

Examples

New-VBRApplicationProcessingOptions Example 1. Specifying Application-Aware Processing Settings for Veeam Agent Backup Job (Linux)

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.

$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

Perform the following steps:

Run the New-VBRScriptProcessingOptions cmdlet. Specify the ProcessingAction, ScriptPrefreezeCommand and ScriptPostthawCommand parameter values. Save the result to the $script variable.
Run the Get-Credential cmdlet to specify credentials for the Oracle database. Save the result to the $creds variable.
Run the New-VBROracleProcessingOptions cmdlet. Set the $creds variable as the Credentials parameter value. Save the result to the $oracle variable.
Run the Get-VBRProtectionGroup cmdlet. Specify the Name parameter value. Save the result to the $group variable.
Run New-VBRApplicationProcessingOptions cmdlet. Specify the following settings:

Set the $group variable as the BackupObject parameter value.
Set the Linux value as the OSPlatform parameter value.
Provide the Enable parameter.
Provide the IgnoreErrors parameter.
Set the $oracle variable as the OracleProcessingOptions parameter value.
Set the $script variable as the ScriptProcessingOptions parameter value.

New-VBRApplicationProcessingOptions Example 2. Specifying Application-Aware Processing Settings for Veeam Agent Backup Job (Windows)

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.

$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

Perform the following steps:

Run the Get-Credential cmdlet. Save the result to the $creds variable.
Run the Get-VBRProtectionGroup cmdlet. Specify the Name parameter value. Save the result to the $group variable.
Run the New-VBRSQLProcessingOptions cmdlet. Specify the TransactionAction, LogBackupPeriod, LogRetainAction and LogRetainPeriod parameter values. Save the result to the $sql variable.
Run the New-VBRApplicationProcessingOptions cmdlet. Specify the following settings:

Set the $group variable as the BackupObject parameter value.
Set the Windows option for the OSPlatform parameter.
Provide the Enable parameter.
Set the ProcessLogsWithJob option for the GeneralTransactionLogAction parameter.
Set the $sql variable as the SQLProcessingOptions parameter value.
Set the $creds variable as the SharePointCredentials parameter value.

Related Commands