Add-VBRApplicationBackupJob

Short Description

Creates application backup policies.

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

Syntax

Add-VBRApplicationBackupJob [-Name <String>] [-Description <String>] -BackupObject <Object[]>

-BackupRepository <CBackupRepository> [-BackupOptions <VBRApplicationBackupOptions>]

[-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 creates application backup policies.

To create application backup policies, you must specify a container object with discovered application entities (for example, individual computers, databases, protection groups, and so on) that you plan to back up and the target location for storing backups.

Run the Get-VBRProtectionGroup cmdlet to get the protection group.
Run the Get-VBRBackupRepository cmdlet to get the repository.
Run the Add-VBRApplicationBackupJob cmdlet to create application backup policy.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
BackupObject	Specifies an array of discovered application entities: individual computers, databases, protection groups, and so on. The cmdlet will add these entities to the application backup policy. Accepts the `Object[]` object. To get this object, run the `Get-VBRProtectionGroup` cmdlet.	`Object[]`	True	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`	True	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
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
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`. 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
Name	Specifies the name that you want to assign to the application backup policy.	`String`	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 an array of the credentials for Veeam Plug-In for SAP HANA. Accepts the `VBRSAPHANACredentialsOptions[]` object. To define this object, run the `New-VBRSAPHANACredentialsOptions` 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 `VBRSAPHANAOptions` 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

Creating Application Backup Policy for Veeam Plug-In for SAP HANA

This example shows how to create the application backup policy for Veeam Plug-In for SAP HANA.

$group = Get-VBRProtectionGroup -Name "Database Servers"

$repository = Get-VBRBackupRepository -Name "Default Backup Repository"

$backup_options = New-VBRApplicationBackupOptions -FullBackupScheduleType Weekly -WeeklyScheduleType SelectedDays -SelectedDays Sunday, Wednesday

$daily = New-VBRDailyOptions -DayOfWeek Friday -Period 7:00

$schedule_options = New-VBRApplicationScheduleOptions -Type Daily -DailyOptions $daily

$processing_settings = New-VBRSAPHANAProcessingOptions -RedoLogsBackupPeriod 60 -LogBackupMode VeeamManaged

$db_processing_options = New-VBRDatabaseProcessingOptions -BackupObject $group -SAPHANAProcessingOptions $processing_settings

$hana_options = New-VBRSAPHANAOptions -ParallelChannelsCount 3

$os_administrator = Get-VBRCredentials

$db_hana_administrator = Get-VBRCredentials

$hana_credentials = New-VBRSAPHANACredentialsOptions -SAPSystem SH4 -SSHCredentials $os_administrator -BackupCredentials $db_hana_administrator

Add-VBRApplicationBackupJob -BackupObject $group -BackupRepository $repository -Name "Backup Job" -Description "Daily backup of SAP systems" -BackupOptions $backup_options -EnableSchedule -ScheduleOptions $schedule_options -DatabaseProcessingOptions $db_processing_options -SAPHANAOptions $hana_options -SAPHANACredentialsOptions $hana_credentials

Perform the following steps:

Get a protection group and a backup repository:
1. Run the Get-VBRProtectionGroup cmdlet. Specify the Name parameter value. Save the result to the $group variable.
2. Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
Define backup settings and backup schedule:
1. Run the New-VBRApplicationBackupOptions cmdlet. Specify the FullBackupScheduleType, WeeklyScheduleType and the SelectedDays parameter values. Save the result to the $backup_options variable.
2. Run the New-VBRDailyOptions cmdlet. Specify the DayOfWeek and the Period parameter values. Save the result to the $daily variable.
3. Run the New-VBRApplicationScheduleOptions cmdlet. Specify the Type and the DailyOptions parameter values. Save the result to the $schedule_options variable.
Define processing and backup settings:
1. Run the Get-VBRCredentials cmdlet. Save the result to the $db_administrator variable.
2. Run the New-VBRSAPHANAProcessingOptions cmdlet. Specify the RedoLogsBackupPeriod and LogBackupMode parameter values. Save the result to the $processing_settings variable.
3. Run the New-VBRDatabaseProcessingOptions cmdlet. Specify the DayOfWeek and the SAPHANAProcessingOptions parameter values. Save the result to the $db_processing_options variable.
4. Run the New-VBRSAPHANAOptions cmdlet. Specify the ParallelChannelsCount parameter value. Save the result to the $hana_options variable.
Get SAP HANA credentials settings:
1. Run the Get-VBRCredentials cmdlet. Save the result to the $os_administrator variable.
2. Run the Get-VBRCredentials cmdlet. Save the result to the $db_hana_administrator variable.
3. Run the New-VBRSAPHANACredentialsOptions cmdlet. Specify the SAPSystem, SSHCredentials and the BackupCredentials parameter values. Save the result to the $hana_credentials variable.
Run the Add-VBRApplicationBackupJob cmdlet. Specify the following settings:
- Set the $group variable as the BackupObject parameter value.
- Set the $repository variable as the BackupRepository parameter value.
- Specify the Name parameter value.
- Specify the Description parameter value.
- Set the $backup_options variable as the BackupOptions parameter value.
- Provide the EnableSchedule parameter.
- Set the $schedule_options variable as the ScheduleOptions parameter value.
- Set the $db_processing_options variable as the DatabaseProcessingOptions parameter value.
- Set the $hana_options variable as the SAPHANAOptions parameter value.
- Set the $hana_credentials variable as the SAPHANACredentialsOptions parameter value.