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. To modify settings, enter the necessary parameters with new values. The parameters that you omit will remain unchanged.
Parameters
Parameter | Description | Type | Required | Position | Accept | Accept |
|---|---|---|---|---|---|---|
Job | Specifies the application backup policy that you want to modify. | Accepts the VBRApplicationBackupJob variable. | True | Named | True (ByValue) | False |
BackupObject | Specifies an array of protection groups and discovered computers that you want to add to the application backup policy. | Accepts Object type. | False | Named | False | False |
BackupRepository | Specifies the target backup location for the application backup policy. | Accepts CBackupRepository type. | False | Named | False | False |
Name | Specifies the name that you want to assign to the application backup policy. | String | False | Named | False | False |
Description | Specifies the description of the application backup policy. | String | False | Named | False | False |
BackupOptions | Specifies backup settings for the application backup policy. | Accepts VBRApplicationBackupOptions type. | False | Named | False | False |
EnableRetentionPolicy | Enables retention policy. | SwitchParameter | False | Named | False | 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 | False |
EnableSchedule | Indicates that Veeam Backup & Replication will schedule the application backup policy to run on a regular basis. | SwitchParameter | False | Named | False | False |
ScheduleOptions | Specifies the settings for the application backup policy schedule. Accepts the types returned by the following cmdlets:
| Accepts VBRApplicationScheduleOptions type. | False | Named | False | False |
NotificationOptions | Specifies notification settings for the application backup policy. Accepts the VBRNotificationOptions type. | Accepts VBRNotificationOptions type. | False | Named | False | False |
DatabaseProcessingOptions | Specifies database processing settings for the application backup policy. Accepts the VBRDatabaseProcessingOptions type. | Accepts VBRDatabaseProcessingOptions[] type. | False | Named | False | 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:
| Accepts VBRSAPOnOracleMode type. | False | Named | False | 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 VBRSAPOnOracleStorageOptions type. | Accepts VBRSAPOnOracleStorageOptions type. | False | Named | False | 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 type. | Accepts VBRSAPOnOracleOptions type. | False | Named | False | 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 VBROracleRMANStorageOptions type. | False | Named | False | 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 VBROracleRMANOptions type. | False | Named | False | 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 VBRSAPHANAOptions type. | False | Named | False | 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 VBRSAPHANACredentialsOptions[] type. | False | Named | False | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.
Return Type
This cmdlet returns the VBRApplicationBackupJob[] object that contains settings of application backup policies.
Example
This example shows how to create the application backup policy for Veeam Plug-in for SAP HANA and modify description of the application backup policy.
- Run Get-VBRProtectionGroup to get the protection group with Linux computers that you want to back up. Save the result to the $group variable.
- Run Get-VBRBackupRepository to specify the repository. Save the result to the $repository variable.
- Run New-VBRApplicationBackupOptions to get the backup options for application backup policies. Save the result to the $backup_options variable.
- Run New-VBRApplicationScheduleOptions with the $daily variable to create the schedule options for application backup policies. Save the result to the $schedule_options variable.
- Run New-VBRSAPHANAProcessingOptions with the $db_administrator variable to create database processing settings for Veeam Plug-in for SAP HANA. Save the result to the $processing_settings variable.
- Run New-VBRDatabaseProcessingOptions with the $processing_settings variable to create database processing settings for application backup policies. Save the result to the $db_processing_options variable.
- Run New-VBRSAPHANAOptions to create backup policies for Veeam Plug-in for SAP HANA. Save the result to the $hana_options variable.
- Run New-VBRSAPHANACredentialsOptions with the $os_administrator and $db_hana_administrator variables to create credentials settings for Veeam Plug-in for SAP HANA. Save the result to the $hana_credentials variable.
- Run Add-VBRApplicationBackupJob with the $group, $repository, $backup_options, $schedule_options, $db_processing_options, $hana_options and $hana_credentials variables. Use Name and Description parameters to specify name and description for application backup policy. Use EnableSchedule parameter to enable automatic application backup policy run. Save the result to the $policy variable.
- Run the Set-VBRApplicationBackupJob with the $policy variable.Use Description parameter to modify description for application backup policy.
$db_administrator = Get-VBRCredentials $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 -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 Set-VBRApplicationBackupJob Set-VBRApplicationBackupJob -Job $policy -Description "Weekly backup of SAP systems" |
Related Commands
New-VBRApplicationBackupOptions
New-VBRApplicationScheduleOptions
New-VBRSAPHANAProcessingOptions
New-VBRDatabaseProcessingOptions