Set-VBRApplicationBackupJob

Short Description

Modifies application backup policies.

Applies to

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

Syntax

Set-VBRApplicationBackupJob -Job <VBRApplicationBackupJob> [-Description <string>] [-BackupObject <Object[]> ] [-BackupRepository <CBackupRepository>] [-BackupOptions <VBRApplicationBackupOptions>] [-EnableRetentionPolicy] [-RetentionPolicy <int>] [-EnableSchedule] [-ScheduleOptions <VBRApplicationScheduleOptions>] [-NotificationOptions <VBRNotificationOptions>] [-DatabaseProcessingOptions <VBRDatabaseProcessingOptions[]>] [-SAPOnOracleMode {RMAN | BACKINT}] [-SAPOnOracleStorageOptions <VBRSAPOnOracleStorageOptions>] [-SAPOnOracleOptions <VBRSAPOnOracleOptions>] [-OracleRMANStorageOptions <VBROracleRMANStorageOptions>] [-OracleRMANOptions <VBROracleRMANOptions>] [-SAPHANAOptions <VBRSAPHANAOptions>] [-SAPHANACredentialsOptions <VBRSAPHANACredentialsOptions[]>]  [<CommonParameters>]

Detailed Description

This cmdlet modifies settings of application backup policies.

Note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameters values with new values. The parameters that you omit will remain unchanged.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Job

Specifies the application backup policy that you want to modify.

Accepts the VBRApplicationBackupJob object. To get this object, run the Get-VBRApplicationBackupJob group cmdlet.

True

Named

True (ByValue)

BackupObject

Specifies an array of protection groups and discovered computers that you want to add to the application backup policy.

Accepts the Object object. To get this object, run the Get-VBRProtectionGroup cmdlet.

False

Named

False

BackupRepository

Specifies the target backup location for the application backup policy.

Accepts the CBackupRepository object. To get this object, run the Get-VBRBackupRepository cmdlet.

False

Named

False

Name

Specifies the name that you want to assign to the application backup policy.

String

False

Named

False

Description

Specifies the description of the application backup policy.

String

False

Named

False

BackupOptions

Specifies backup settings for the application backup policy.

Accepts the VBRApplicationBackupOptions object. To define this object, run the New-VBRApplicationBackupOptions cmdlet.

False

Named

False

EnableRetentionPolicy

Enables retention policy.

SwitchParameter

False

Named

False

RetentionPolicy

Specifies the retention policy for backups created by Veeam Plug-in.

Note: The retention policy specifies the number of restore points or a number of days.

Int32

False

Named

False

EnableSchedule

Enables the option to schedule the application backup policy to run on a regular basis.

SwitchParameter

False

Named

False

ScheduleOptions

Specifies the settings for the application backup policy schedule.

Accepts the VBRApplicationScheduleOptions object. To get this object, run the one of the following cmdlets:

False

Named

False

NotificationOptions

Specifies notification settings for the application backup policy.

Accepts the VBRNotificationOptions object. To define this object, run the New-VBRNotificationOptions cmdlet.

False

Named

False

DatabaseProcessingOptions

Specifies database processing settings for the application backup policy.

Accepts the VBRDatabaseProcessingOptions object. To define this object, run the New-VBRDatabaseProcessingOptions cmdlet.

False

Named

False

SAPOnOracleMode

Note: This option works only for Veeam Plug-in for SAP on Oracle.

Specifies the backup mode for Veeam Plug-in for SAP on Oracle:

  • RMAN: for BR*Tools with RMAN (rman_util mode).
  • BACKINT: for BR*Tools with BACKINT (util_file_online mode).

VBRSAPOnOracleMode

False

Named

False

SAPOnOracleStorageOptions

Note: This option works only for Veeam Plug-in for SAP on Oracle.

Specifies the storage settings for Veeam Plug-in for SAP on Oracle.

Accepts the VBRDatabaseProcessingOptions object. To define this object, run the New-VBRSAPOnOracleStorageOptions cmdlet.

False

Named

False

SAPOnOracleOptions

Note: This option works only for Veeam Plug-in for SAP on Oracle.

Specifies the backup settings for Veeam Plug-in for SAP on Oracle.

Accepts the VBRSAPOnOracleOptions object. To define this object, run the New-VBRSAPOnOracleOptions cmdlet.

False

Named

False

OracleRMANStorageOptions

Note: This option works only for Veeam Plug-in for Oracle RMAN.

Specifies the storage options for Veeam Plug-in for Oracle RMAN.

Accepts the VBROracleRMANStorageOptions object. To define this object, run the New-VBROracleRMANStorageOptions cmdlet.

False

Named

False

OracleRMANOptions

Note: This option works only for Veeam Plug-in for Oracle RMAN.

Specifies the backup settings for Veeam Plug-in for Oracle RMAN.

Accepts the VBROracleRMANOptions object. To define this object, run the New-VBROracleRMANOptions cmdlet.

False

Named

False

SAPHANAOptions

Note: This option works only for Veeam Plug-in for SAP HANA.

Specifies the backup settings for Veeam Plug-in for SAP HANA.

Accepts the VBROracleRMANOptions object. To define this object, run the New-VBRSAPHANAOptions cmdlet.

False

Named

False

SAPHANACredentialsOptions

Note: This option works only for Veeam Plug-in for SAP HANA.

Specifies the credentials settings for Veeam Plug-in for SAP HANA.

Accepts the VBRSAPHANACredentialsOptions[] object. To define this object, run the New-VBRSAPHANAOptions cmdlet.

False

Named

False

<CommonParameters>

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

Output Objet

This cmdlet returns the VBRApplicationBackupJob[] object that contains settings of application backup policies.

Examples

Modifying SAP HANA Backup Settings for Application Backup Policy.

This example shows how to modify the number of data processing channels that can be assigned to the Plugin Policy 05 application backup policy.

$policy = Get-VBRApplicationBackupJob -Name "Plugin Policy 05"

$hana_options = New-VBRSAPHANAOptions -ParallelChannelsCount 5

Set-VBRApplicationBackupJob -Job $policy -SAPHANAOptions $hana_options

Perform the following steps:

  1. Run the Get-VBRApplicationBackupJob cmdlet. Specify the Name parameter value. Save the result to the $policy variable.
  2. Run the New-VBRSAPHANAOptions cmdlet. Specify the ParallelChannelsCount parameter value. Save the result to the $hana_options variable.
  3. Run the Set-VBRApplicationBackupJob cmdlet. Set the $policy variable as the Job parameter value. Set the $hana_options variable as the SAPHANAOptions parameter value.

Related Commands