Set-VBRApplicationBackupJob

Short Description

Modifies application backup policies.

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 <Int32>] [-EnableSchedule]

[-ScheduleOptions <VBRApplicationScheduleOptions>] [-NotificationOptions <VBRNotificationOptions>]

[-DatabaseProcessingOptions <VBRDatabaseProcessingOptions[]>] [-GFSOptions <VBRComputerGFSOptions>]

[-SAPOnOracleMode <VBRSAPOnOracleMode>] [-SAPOnOracleStorageOptions <VBRSAPOnOracleStorageOptions>]

[-SAPOnOracleOptions <VBRSAPOnOracleOptions>] [-OracleRMANStorageOptions <VBROracleRMANStorageOptions>]

[-OracleRMANOptions <VBROracleRMANOptions>] [-SAPHANAOptions <VBRSAPHANAOptions>]

[-SAPHANACredentialsOptions <VBRSAPHANACredentialsOptions[]>]

[-SAPHANAStorageOptions <VBRSAPHANAStorageOptions>] [-MSSQLOptions <VBRMSSQLOptions>]

[-MSSQLCredentialsOptions <VBRMSSQLCredentialsOptions[]>] [-MSSQLStorageOptions <VBRMSSQLStorageOptions>] [<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 parameter values with new values. The parameters that you omit will remain unchanged.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
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.	`Object[]`	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.	`VBRApplicationBackupOptions`	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.	`CBackupRepository`	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.	`VBRDatabaseProcessingOptions[]`	False	Named	False
Description	Specifies the description of the application backup policy.	`String`	False	Named	False
EnableRetentionPolicy	Enables retention policy.	`SwitchParameter`	False	Named	False
EnableSchedule	Enables the option to schedule the application backup policy to run on a regular basis.	`SwitchParameter`	False	Named	False
GFSOptions	Specifies GFS retention settings for the application backup policy. Accepts the `VBRComputerGFSOptions` object. To define this object, run the `New-VBRComputerGFSOptions` cmdlet.	`VBRComputerGFSOptions`	False	Named	False
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.	`VBRApplicationBackupJob`	True	Named	True (ByValue)
MSSQLCredentialsOptions	Note: This option works only for Veeam Plug-In for Microsoft SQL Server. Specifies an array of the credentials for Veeam Plug-In for Microsoft SQL Server Accepts the `VBRMSSQLCredentialsOptions[]` object. To define this object, run the `New-VBRMSSQLCredentialsOptions` cmdlet.	`VBRMSSQLCredentialsOptions[]`	False	Named	False
MSSQLOptions	Note: This option works only for Veeam Plug-In for Microsoft SQL Server. Specifies the backup settings for Veeam Plug-In for Microsoft SQL Server. Accepts the `VBRMSSQLOptions` object. To define this object, run the `New-VBRMSSQLOptions` cmdlet.	`VBRMSSQLOptions`	False	Named	False
MSSQLStorageOptions	Note: This option works only for Veeam Plug-In for Microsoft SQL Server. Specifies the storage settings for Veeam Plug-In for Microsoft SQL Server. Accepts the `VBRMSSQLStorageOptions` object. To define this object, run the `New-VBRMSSQLStorageOptions` cmdlet.	`VBRMSSQLStorageOptions`	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.	`VBRNotificationOptions`	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.	`VBROracleRMANOptions`	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.	`VBROracleRMANStorageOptions`	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
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.	`VBRSAPHANACredentialsOptions[]`	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.	`VBRSAPHANAOptions`	False	Named	False
SAPHANAStorageOptions	Note: This option works only for Veeam Plug-In for SAP HANA. Specifies the storage settings for Veeam Plug-In for SAP HANA. Accepts the `VBRSAPHANAStorageOptions` object. To define this object, run the `New-VBRSAPHANAStorageOptions` cmdlet.	`VBRSAPHANAStorageOptions`	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 BRTools with RMAN (rman_util mode). `BACKINT`: for BRTools with BACKINT (util_file_online mode).	`VBRSAPOnOracleMode`	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.	`VBRSAPOnOracleOptions`	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.	`VBRSAPOnOracleStorageOptions`	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: `New-VBRServerScheduleOptions` `New-VBRApplicationScheduleOptions`	`VBRApplicationScheduleOptions`	False	Named	False

<CommonParameters>

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

Output Object

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:

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