Add-VBRApplicationBackupJob
Short Description
Creates application backup policies.
Applies to
Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
Add-VBRApplicationBackupJob -BackupObject <Object[]> -BackupRepository <CBackupRepository> [-Name <string>] [-Description <string>] [-BackupOptions <VBRApplicationBackupOptions>] [-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 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
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. | True | 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. | True | 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 |
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:
| 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 an array of the credentials 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 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 $db_administrator = Get-VBRCredentials $processing_settings = New-VBRSAPHANAProcessingOptions -Credentials $db_administrator -DeleteSourceLogs Keep -ArchiveLogBackupPeriod 15 $db_processing_options = New-VBRDatabaseProcessingOptions -BackupObject $group -SAPOnOracleProcessingOptions $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:
- Run the Get-VBRProtectionGroup cmdlet. Specify the Name parameter value. Save the result to the $group variable.
- Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
- Define backup settings and backup schedule:
- Run the New-VBRApplicationBackupOptions cmdlet. Specify the FullBackupScheduleType, WeeklyScheduleType and the SelectedDays parameter values. Save the result to the $backup_options variable.
- Run the New-VBRDailyOptions cmdlet. Specify the DayOfWeek and the Period parameter values. Save the result to the $daily variable.
- 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:
- Run the Get-VBRCredentials cmdlet. Save the result to the $db_administrator variable.
- Run the New-VBRSAPHANAProcessingOptions cmdlet. Specify the Credentials, DeleteSourceLogs and the ArchiveLogBackupPeriod parameter values. Save the result to the $processing_settings variable.
- Run the New-VBRDatabaseProcessingOptions cmdlet. Specify the DayOfWeek and the SAPOnOracleProcessingOptions parameter values. Save the result to the $db_processing_options variable.
- Run the New-VBRSAPHANAOptions cmdlet. Specify the ParallelChannelsCount parameter value. Save the result to the $hana_options variable.
- Get SAP HANA credentials settings:
- Run the Get-VBRCredentials cmdlet. Save the result to the $os_administrator variable.
- Run the Get-VBRCredentials cmdlet. Save the result to the $db_hana_administrator variable.
- 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.
Related Commands