Veeam Plug-ins for Enterprise

Applications

Version 12
User Guide
December, 2024
© 2024 Veeam Software.

All rights reserved. All trademarks are the property of their respective owners.

No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval system, or
translated into any language in any form by any means, without written permission from Veeam Software
(Veeam). The information contained in this document represents the current view of Veeam on the issue
discussed as of the date of publication and is subject to change without notice. Veeam shall not be liable for
technical or editorial errors or omissions contained herein. Veeam makes no warranties, express or implied, in
this document. Veeam may have patents, patent applications, trademark, copyright, or other intelle ctual
property rights covering the subject matter of this document. All other trademarks mentioned herein are the
property of their respective owners. Except as expressly provided in any written license agreement from Veeam,
the furnishing of this document does not give you any license to these patents, trademarks, copyrights, or other
intellectual property.

NOTE
Read the End User Software License Agreement before using the accompanying software programs. Using
any part of the software indicates that you accept the terms of the End User Software License Agreement.

2 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Contents
CONTACTING VEEAM SOF TWARE ................................ ................................ .......................... 12
ABOUT THIS DOCUMENT ................................ ................................ ................................ .... 13
OVERVIEW ................................ ................................ ................................ ..................... 14
STANDALONE AND MANAGED OPERATIONS MODES................................ ................................ .... 15
VEE AM PLUG -IN FOR SAP HANA ................................ ................................ ........................... 17
Overview.............................................................................................................................................18
How Veeam Plug-in for SAP HANA W orks....................................................................................19
Data Backup ............................................................................................................................. 20
Data Restore ............................................................................................................................. 27
Planning and Preparation .................................................................................................................... 28
System Requirements ............................................................................................................... 29
Permissions .............................................................................................................................. 32
Ports ........................................................................................................................................ 33
Licensing .................................................................................................................................. 37
Veeam Environment Planning .................................................................................................... 39
SAP Environment Planning ........................................................................................................ 43
Deployment and Config uration............................................................................................................ 45
Installing Plug -in for SAP HANA................................................................................................. 46
Access a nd Encryption Settings on Repositories .......................................................................... 49
Granting Permissions to Users .................................................................................................... 51
Configuring Plug-in for SAP HANA ............................................................................................. 53
Specifying Preferred Networks for Veeam Plug -ins ..................................................................... 59
Configuring Performance Throttling............................................................................................61
Automating Configuration of Plug-in for SAP HANA.................................................................... 62
Upgrading Plug-in for SAP HANA ............................................................................................... 63
Importing Backup Files .............................................................................................................. 65
Upgrading Backup Files ............................................................................................................. 67
Uninstalling Plug-in for SAP HANA ............................................................................................ 69
Database Protection ........................................................................................................................... 70
Database Backup (HDBSQL Scripts) ............................................................................................. 71
Database Backup (SAP HANA Studio) ......................................................................................... 73
Database Backup (SAP HANA Cockpit)........................................................................................ 75
Backup Job in Veeam Backup & Replication ................................................................................ 77
Database Recovery ..............................................................................................................................81
Restoring Databases (HDBSQL Commands) ................................................................................ 82
Restoring Databases (SAP HANA Studio) .................................................................................... 83
Restoring SYSTE MDB (SAP HANA Cockpit) ................................................................................. 88

3 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 Restoring Tenant Databases with SAP HANA Cockpit .................................................................. 93
Restore to Another Server (System Copy)................................................................................... 97
Restore from Backup Copy ....................................................................................................... 101
Restore from Hardened Repository ...........................................................................................102
Restore with Veeam Explorer for SAP HANA ............................................................................. 104
Retention of SAP HANA Back ups ........................................................................................................105
Deleting Backups Using SAP HANA Tools ................................................................................. 106
Deleting Backups Manually.......................................................................................................107
Configuring Force Deletion of Backups ..................................................................................... 108
Removing Back ups from Configuration..................................................................................... 109
Backup Copy for SAP HANA Backups ................................................................................................... 110
Creating Backup Copy Job ......................................................................................................... 111
Converting Back up Copy to Back up ........................................................................................... 122
Logs and Support .............................................................................................................................. 123
VEE AM PLUG -IN FOR ORACLE RMAN ................................ ................................ .................... 124
Overview........................................................................................................................................... 125
How Veeam Plug-in for Oracle RMAN Works ............................................................................. 126
Data Backup ............................................................................................................................ 127
Data Restore ............................................................................................................................ 134
Planning and Preparation ................................................................................................................... 135
System Requirements .............................................................................................................. 136
Permissions ............................................................................................................................. 138
Ports ...................................................................................................................................... 140
Licensing .................................................................................................................................144
Veeam Environment Planning ...................................................................................................146
Oracle Environment Planning ...................................................................................................149
Deployment and Config uration........................................................................................................... 154
Installing Veeam Plug -in for Oracle RMAN ................................................................................ 155
Access a nd Encryption Settings on Repositories ......................................................................... 161
Granting Permissions to Users .................................................................................................. 163
Configuring Veeam Plug-in for Oracle RMAN ............................................................................. 167
Specifying Preferred Networks for Veeam Plug -ins ................................................................... 180
Configuring Performance Throttling.......................................................................................... 183
Upgrading Veeam Plug-in for Oracle RMAN...............................................................................184
Importing/Exporting Plug -in Settings ....................................................................................... 187
Importing Backup Files .............................................................................................................188
Upgrading Backup Files ............................................................................................................ 191
Uninstalling Veeam Plug-in for Oracle RMAN ............................................................................ 193
Database Protection ..........................................................................................................................194
Oracle RMAN Full Backup ......................................................................................................... 195

4 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 Oracle RMAN Channel Allocation ..............................................................................................196
Backup Job in Veeam Backup & Replication ..............................................................................200
Database Recovery ........................................................................................................................... 204
Restore to Original Server ....................................................................................................... 205
Restore to Another Server ....................................................................................................... 206
Restore from Backup Copy ........................................................................................................211
Restore with Veeam Explorer for Oracle .................................................................................... 212
Restore of Control File from Autobackup .................................................................................. 213
Restore from Hardened Repository ........................................................................................... 217
Retention of RMAN Backups and Archived Logs................................................................................... 219
Configuring Retention P olicy ................................................................................................... 220
Configuring Archived Redo Log Retention ................................................................................. 221
Configuring Force Deletion of Backups ......................................................................................222
Deleting Backups Manually.......................................................................................................223
Removing Back ups from Configuration..................................................................................... 224
Backup Copy for Oracle RMAN Back ups...............................................................................................225
Creating Backup Copy Job ....................................................................................................... 226
Converting Back up Copy to Back up ...........................................................................................237
Logs and Support ............................................................................................................................. 239
VEE AM PLUG -IN FOR SAP ON ORACLE ................................ ................................ .................. 240
Overview........................................................................................................................................... 241
How Veeam Plug-in for SAP on Oracle W orks ........................................................................... 242
Data Backup ........................................................................................................................... 244
Data Restore ........................................................................................................................... 250
Planning and Preparation ................................................................................................................... 251
System Requirements ..............................................................................................................252
Permissions .............................................................................................................................253
Ports ...................................................................................................................................... 254
Licensing ................................................................................................................................ 258
Veeam Environment Planning .................................................................................................. 260
SAP Environment Planning ...................................................................................................... 263
Deployment and Config uration.......................................................................................................... 264
Installing Veeam Plug -in for SAP on Oracle .............................................................................. 265
Access a nd Encryption Settings on Repositories ........................................................................ 267
Granting Permissions to Users ................................................................................................. 269
Configuring Plug-in for SAP on Oracle ....................................................................................... 271
Specifying Preferred Networks for Veeam Plug -ins ................................................................... 276
Configuring Performance Throttling......................................................................................... 278
Configuring Parallelism for Red o Logs...................................................................................... 279
Importing Backup Files ............................................................................................................ 280

5 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 Upgrading Veeam Plug-in for SAP on Oracle ............................................................................. 282
Uninstalling Veeam Plug-in for SAP on Oracle .......................................................................... 284
Database Protection ......................................................................................................................... 285
Considerations a nd Limitations ................................................................................................ 286
SAP on Oracle Back up Using Backint ........................................................................................ 287
SAP on Oracle Back up Using RMAN_UTIL .................................................................................. 290
Backup Job in Veeam Backup & Replication .............................................................................. 293
Database Recovery ........................................................................................................................... 296
Restore Oracle Databases ........................................................................................................ 297
Restore Redo Logs .................................................................................................................. 298
Restore to Another Server (System Copy)................................................................................. 299
Restore from Backup Copy ...................................................................................................... 303
Restore from Hardened Repository .......................................................................................... 304
Retention of SAP on Oracle Backups .................................................................................................. 306
Configuring Retention P olicy for Back ups ................................................................................. 307
Deleting Backups Manually...................................................................................................... 308
Removing Back ups from Configuration..................................................................................... 309
Backup Copy for SAP on Oracle Backups .............................................................................................310
Creating Backup Copy Job .........................................................................................................311
Converting Back up Copy to Back up ...........................................................................................322
Logs and Support ..............................................................................................................................323
VEE AM PLUG -IN FOR MICROSOFT SQL SERVER ................................ ................................ ........ 324
Overview...........................................................................................................................................325
How Veeam Plug-in for Microsoft SQL Server Works ................................................................. 326
Data Backup ........................................................................................................................... 328
Data Restore ........................................................................................................................... 334
Planning and Preparation ...................................................................................................................335
System Requirements ............................................................................................................. 336
Permissions ............................................................................................................................ 338
Ports ...................................................................................................................................... 339
Licensing ................................................................................................................................ 343
Veeam Environment Planning .................................................................................................. 345
Getting Started................................................................................................................................. 348
Deployment and Config uration.......................................................................................................... 349
Installing Veeam Plug -in for Microsoft SQL Server .................................................................... 350
Access a nd Encryption Settings on Backup Rep ositories ............................................................ 354
Granting Permissions to Users ................................................................................................. 356
Configuring Veeam Plug-in for Microsoft SQL Server ................................................................ 358
Specifying Preferred Networks for Veeam Plug -ins ................................................................... 363
Configuring Performance Throttling......................................................................................... 365

6 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 Upgrading Veeam Plug-in for Microsoft SQL Server .................................................................. 366
Exporting and Importing Plug-in Settings................................................................................. 370
Importing Backup Files ............................................................................................................. 371
Specifying the Version of Microsoft ODBC Driver for SQL Server .................................................373
Uninstalling Veeam Plug-in for Microsoft SQL Server ................................................................ 374
Performing Backup ............................................................................................................................375
About Microsoft SQL Server Backup ......................................................................................... 376
Configuring Backup Settings .................................................................................................... 382
Saving Backup Settings as SQL Agent Job ................................................................................ 389
Exporting Backup Settings to Custom Script .............................................................................. 391
Performing Backup with Command-Line Interface .................................................................... 392
Managing Backup Job in Veeam Backup & Replication ............................................................... 395
Managing Veeam Plug-in Backups in Veeam Back up & Replication............................................. 399
Performing Restore ........................................................................................................................... 403
Restore with Restore Database Wizard .....................................................................................404
Restore with Command -Line Interface ...................................................................................... 411
Backup Copy for Microsoft SQL Server Backups ................................................................................... 415
Creating Backup Copy Job ........................................................................................................416
Converting Back up Copy to Back up .......................................................................................... 428
Logs and Support ............................................................................................................................. 429
VEE AM PLUG -IN FOR IBM DB2................................ ................................ ............................ 430
Overview........................................................................................................................................... 431
How Veeam Plug-in for IBM Db2 W orks.................................................................................... 432
Data Backup ........................................................................................................................... 433
Data Restore ........................................................................................................................... 439
Clusters ..................................................................................................................................440
Planning and Preparation ...................................................................................................................441
System Requirements ............................................................................................................. 442
Permissions ............................................................................................................................ 446
Ports ...................................................................................................................................... 447
Licensing ................................................................................................................................. 451
Environment Planning ............................................................................................................. 453
Getting Started................................................................................................................................. 455
Deployment and Config uration.......................................................................................................... 456
Installing Veeam Plug -in for IBM Db2....................................................................................... 457
Access a nd Encryption Settings on Backup Rep ositories ............................................................ 462
Granting Permissions to Users ................................................................................................. 464
Configuring Plug-in................................................................................................................. 465
Specifying Preferred Networks for Veeam Plug -ins .................................................................... 471
Configuring Performance Throttling......................................................................................... 473

7 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 Upgrading Veeam Plug-in for IBM Db2 ..................................................................................... 474
Exporting and Importing Plug-in Settings................................................................................. 476
Importing Backup Files ............................................................................................................ 477
Uninstalling Plug-in ................................................................................................................ 479
Performing Backup ...........................................................................................................................480
Considerations a nd Limitations .................................................................................................481
Preparing Database ................................................................................................................. 482
Performing Full Backup ........................................................................................................... 483
Performing Incremental Backup ............................................................................................... 485
Managing Backup Jobs in Veeam Back up & Replication ............................................................. 487
Managing Backups in Veeam Backup & Replication ................................................................... 492
Performing Restore ........................................................................................................................... 497
Get Backup Time Stamp .......................................................................................................... 498
Restore to Original Server .......................................................................................................500
Restore to Another Server ....................................................................................................... 503
Restore from Backup Copy ...................................................................................................... 507
Restore from Hardened Repository .......................................................................................... 508
Retention of IBM Db2 Back ups .......................................................................................................... 509
Deleting Backups Using IBM Db2 Tools .....................................................................................510
Deleting Backups Using Veeam Backup & Replication Console .....................................................511
Configuring Force Deletion of Backups ...................................................................................... 513
Backup Copy for IBM Db2 Backups ...................................................................................................... 514
Creating Backup Copy Job ........................................................................................................ 515
Logs and Support ............................................................................................................................. 526
VEE AM PLUG -IN MANAGE MENT................................ ................................ .......................... 527
Veeam Plug -in Management Infrastructure ........................................................................................ 528
Computer Discovery and Veeam Plug -in Deployment .......................................................................... 531
Protection Groups ....................................................................................................................532
Rescan Job ..............................................................................................................................535
Application Back up Policies ............................................................................................................... 540
Planning and Preparation ................................................................................................................... 541
System Requirements ............................................................................................................. 542
Permissions ............................................................................................................................ 546
Licensing ................................................................................................................................ 548
Ports ...................................................................................................................................... 549
Getting Started................................................................................................................................. 554
Configuring Security Settings ............................................................................................................ 556
Managing TLS Certificates ....................................................................................................... 558
Adding Computers to Trusted Hosts List .................................................................................. 566
Deploying Plug-in for Certificate-Based Authentication ...................................................................... 568

8 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 Working with Protection Groups ........................................................................................................ 569
Creating Protection Groups ..................................................................................................... 570
Editing Protection Group Settings ............................................................................................. 612
Rescanning Protection Group ................................................................................................... 613
Assigning Location to Protection Group ....................................................................................614
Disabling Protection Group ....................................................................................................... 615
Removing Protection Group...................................................................................................... 617
Working with Application Policies .......................................................................................................619
Creating SAP HANA Backup P olicy ........................................................................................... 620
Creating Oracle RMAN Backup Policy ....................................................................................... 638
Creating SAP on Oracle Backup P olicy ...................................................................................... 658
Managing Application Backup Policies ............................................................................................... 675
Starting and Stopping Application Backup P olicy ...................................................................... 676
Performing Active Full Backup .................................................................................................680
Editing Backup P olicy Settings ..................................................................................................681
Enabling and Disabling Backup P olicy ...................................................................................... 682
Cloning Backup P olicy ............................................................................................................. 683
Deleting Backup Policy ............................................................................................................ 684
Managing Protected Computers ........................................................................................................ 685
Moving Unmanaged Comp uter to Protection Group .................................................................. 686
Rescanning Protected Computer .............................................................................................. 688
Viewing Properties .................................................................................................................. 689
Managing Plug-in....................................................................................................................690
Specifying Preferred Networks for Veeam Plug -ins in Managed Mode ........................................ 695
Uninstalling Veeam Plug-in and Other Veeam Components ....................................................... 696
Removing Computer from Protection Group ............................................................................. 698
Managing Application Backups ..........................................................................................................700
Restoring from Backup with Veeam Explorer .............................................................................701
Creating Recovery Token ......................................................................................................... 703
Repairing Backup .................................................................................................................... 705
Removing Back up from Configuration ...................................................................................... 708
Deleting Backup from Disk ...................................................................................................... 709
Creating Backup Copy Job ........................................................................................................710
Reporting .......................................................................................................................................... 721
Viewing Resca n Job Statistics ...................................................................................................722
Viewing Resca n Job Report .......................................................................................................723
Viewing Back up Policy Statistics .............................................................................................. 724
Viewing Back up Policy Report ...................................................................................................725
Enabling Email Rep orting ........................................................................................................ 726
MONGODB BACKUP ................................ ................................ ................................ ........ 727

9 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 Overview.......................................................................................................................................... 728
Solution Architecture .............................................................................................................. 729
Computer Discovery and Veeam Components Deployment ........................................................ 730
Application Back up Policies ......................................................................................................733
Data Backup ........................................................................................................................... 736
Data Restore ........................................................................................................................... 739
Planning and Preparation .................................................................................................................. 740
System Requirements .............................................................................................................. 741
Permissions ............................................................................................................................ 743
Ports ...................................................................................................................................... 744
Licensing ................................................................................................................................ 749
Getting Started.................................................................................................................................. 751
Configuring Security Settings .............................................................................................................752
Managing TLS Certificates ....................................................................................................... 754
Adding Computers to Trusted Hosts List .................................................................................. 762
Deploying Veeam Components for Certificate -Based Authentication ................................................... 764
Working with Protection Group ......................................................................................................... 765
Creating Protection Group for MongoDB .................................................................................. 766
Managing Protection Group for MongoDB ................................................................................ 779
Working with Application Backup Policy ............................................................................................. 787
Creating Application Backup P olicy .......................................................................................... 788
Managing Application Backup Policy ........................................................................................804
Managing Protected Replica Sets ........................................................................................................ 813
Rescanning Protected Replica Set .............................................................................................814
Adding Replica Set to Application Backup Policy ........................................................................ 815
Viewing Properties ...................................................................................................................816
Managing Protected Computers ......................................................................................................... 817
Rescanning Protected Computer ...............................................................................................818
Adding Computer to Veeam Agent Backup Job ..........................................................................819
Viewing Properties .................................................................................................................. 820
Managing Veeam Agent ........................................................................................................... 821
Uninstalling Veeam Components ............................................................................................. 826
Managing Application Backups .......................................................................................................... 828
Restoring from Backup with Veeam Explorer ............................................................................ 829
Removing Back up from Configuration ...................................................................................... 830
Deleting Backup from Disk ....................................................................................................... 831
Creating Backup Copy Job ....................................................................................................... 832
Reporting ......................................................................................................................................... 850
Viewing Resca n Job Statistics ................................................................................................... 851
Viewing Resca n Job Report ...................................................................................................... 852

10 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 Viewing Back up Policy Statistics .............................................................................................. 853
Viewing Back up Policy Report .................................................................................................. 854
Enabling Email Rep orting ........................................................................................................ 855
Restoring with Veeam Explorer for MongoDB ..................................................................................... 856
Retention of Mong oDB Backups ........................................................................................................ 857
Logs and Support ............................................................................................................................. 858

11 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Contacting Veeam Software
At Veeam Software we value feedback from our customers. It is important not only to help you quickly with your
technical issues, but it is our mission to listen to your input and build products that incorporate your
suggestions.

Customer Support
Should you have a technical concern, suggestion or question, visit the Veeam Customer Support Portal to open a
case, search our knowledge base, reference documentation, manage your license or obtain the latest product
release.

Company Contacts
For the most up-to-date information about company contacts and office locations, visit the Veeam Contacts
Webpage.

Online Support
If you have any questions about Veeam products, you can use the following resources:

• Full documentation set: veeam.com/documentation-guides-datasheets.html

• Veeam R&D Forums: forums.veeam.com

12 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

About This Document
The document describes how to deploy, configure and use the following solutions for enterprise applications:

• Veeam Plug-in for SAP HANA

• Veeam Plug-in for Oracle RMAN

• Veeam Plug-in for SAP on Oracle

• Veeam Plug-in for Microsoft SQL Server

• Veeam Plug-in for IBM Db2

• MongoDB Backup

Intended Audience
This document is intended for database administrators, backup administrators, and other IT specialists who use
Veeam to back up and restore SAP HANA, Oracle, Microsoft SQL Server, IBM Db2 databases and MongoDB
replica sets.

13 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Overview
Veeam Plug-ins for Enterprise Applications extend the functionality of Veeam Backup & Replication and allow
you to create transactionally-consistent backups of SAP HANA, Oracle and Microsoft SQL Server databases.

• Veeam Plug-in for SAP HANA — an SAP-certified backup and recovery solution that allows you to back up
and restore SAP HANA databases.

• Veeam Plug-in for Oracle RMAN — an Oracle-certified backup and recovery solution that allows you to
back up and restore Oracle databases.

• Veeam Plug-in for SAP on Oracle — an SAP-certified backup and recovery solution that allows you to back
up and restore Oracle databases to which an SAP application is connected.

• Veeam Plug-in for Microsoft SQL Server — a backup and recovery solution that allows you to back up and
restore Microsoft SQL Server databases.

• Veeam Plug-in for IBM Db2 — a backup and recovery solution that allows you to back up and restore IBM
Db2 databases.

• Veeam Plug-in Management — Veeam Backup & Replication allows you to deploy Veeam Plug -ins on
database servers and launch backup policies directly from the Veeam backup console.

• MongoDB Backup — a backup and recovery solution that allows you to back up and restore MongoDB
replica sets.

IMP ORTANT

Veeam Plug-ins store database and log backups in repositories added to the Veeam Backup & Replication
infrastructure. Thus, to use Veeam Plug-ins, you must have a Veeam Backup & Replication server deployed
in your infrastructure. To learn how to deploy Veeam Backup & Replication, see the Deployment section in
the Veeam Backup & Replication User Guide.

14 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Standalone and Managed Operations
Modes
Depending on the available infrastructure, some Veeam Plug -ins can operate in either of two modes to optimize
database protection. Based on the operation mode, Veeam Plug -ins have different functionality and limitations.

Standalone Mode
In this mode, you must manually install Veeam Plug-in that supports standalone mode directly on the computer
whose databases you want to protect.

For Veeam Plug-ins operating in the standalone mode, data protection, disaster recovery and administration
tasks are performed by the user on the computer with Veeam Plug -in installed.

You can use Veeam Plug-in operating in the standalone mode with Veeam Backup & Replication. In this scenario,
you can use backup repositories managed by Veeam Backup & Replication as a target location for backups and
use the Veeam Backup & Replication console to perform a number of tasks with backup jobs and backups.

Managed Mode
In this mode, you can automate management of solutions for enterprise applications on multiple computers i n
your infrastructure in the Veeam Backup & Replication console. You can configure application backup policies
and jobs and perform other data protection and administration tasks on remote computers. To use solutions
operating in the managed mode, you must install Veeam Backup & Replication on the Veeam backup server and
deploy the Veeam components using the Veeam Backup & Replication console.

• For details about managed Veeam Plug-in deployment, see Computer Discovery and Veeam Plug-in
Deployment.

• For details about deployment of Veeam components for MongoDB Backup, see Computer Discovery and
Veeam Components Deployment.

For solutions managed by Veeam Backup & Replication, data protection, data r estore and administration tasks
are performed by a backup administrator in the Veeam Backup & Replication console.

• For details about managed Veeam Plug-ins, see Veeam Plug-in Management.

• For details on how to back up MangoDB items, see MongoDB Backup.

Supported Operation Modes

The following table describes the support of operation modes by solutions for enterprise applications.

Op eration Veeam Plug- Veeam Plug- Veeam Plug- Veeam Plug- Veeam Plug- Mong oDB
Mod e in for SAP in for Oracle in for SAP on in for in for IBM Ba ckup
HANA RMAN Ora cle Microsoft Db 2
SQL Server

Sta ndalone Supported Supported Supported Supported Supported Not

mod e supported

15 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 Op eration Veeam Plug- Veeam Plug- Veeam Plug- Veeam Plug- Veeam Plug- Mong oDB
Mod e in for SAP in for Oracle in for SAP on in for in for IBM Ba ckup
HANA RMAN Ora cle Microsoft Db 2
SQL Server

Ma naged Supported Supported Supported Not Not Supported

mod e supported supported

16 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Veeam Plug-in for SAP HANA
Veeam Plug-in for SAP HANA is an SAP-certified backup tool that integrates with SAP backint and allows you to
store transactionally-consistent SAP HANA database backups and logs in repositories connected to Veeam
Backup & Replication.

NOTE

If you want to protect the SAP HANA server itself, you can use the image-level and file-level backup
functionality of Veeam Backup & Replication or Veeam Agent for Linux. Note that image- and file-level
backups of SAP HANA servers do not guarantee transaction-consistency of database backups.

17 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Overview
Veeam Plug-in for SAP HANA connects SAP HANA servers and Veeam backup repositories by interacting with
databases through the SAP HANA Backint component. Backint for SAP HANA is the backup interface that
enables Veeam Plug-in to communicate with SAP HANA databases and send the database backup files to the
specified Veeam repositories. For details, see How Veeam Plug-in for SAP HANA Works.

Veeam Plug-in for SAP HANA can operate in standalone or managed mode. Depending on the operation mode,
Veeam Plug-in has different functionality and limitations. In standalone mode, you can install Veeam Plug -in
manually on the computer whose databases you want to protect. Veeam Plug-in in standalone mode uses the
Veeam Backup & Replication console to perform backup operations. In managed mode, you can install Veeam
Plug-in using the Veeam Backup & Replication console. The Veeam Backup & Replication console automates the
operation of Veeam Plug-ins running on computers in your infrastructure. For details on Veeam Plug -in
operation modes, see Standalone and Managed Operations Modes.

Veeam Plug-in for SAP HANA transfers backup data to the Veeam backup repository and stores the data in the
Veeam proprietary format for backups. You can use SAP HANA tools or the Veeam Backup & Replication console
to initiate and manage backup operations. Backup processes are performed by the SAP HANA Backint tool. For
details on backup operations with Veeam Plug-in, see Data Backup.

In case of malware activity or unplanned actions, you can perform restore operations based on the backup data
transferred by Veeam Plug-in to the Veeam Backup & Replication backup repositories. You can use SAP HANA
tools or the Veeam Backup & Replication console and Veeam Explorer for SAP HANA to initiate and manage
restore operations. Restore processes managed with SAP HANA tools run on the SAP HANA side. Restore
processes managed in the Veeam Backup & Replication console or in Veeam Explorer for SAP HANA run on the
Veeam Backup & Replication side. For details on restore operations with Veeam Plug -in, see Data Restore.

18 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

How Veeam Plug-in for SAP HANA Works
Veeam Plug-in acts as an agent between an SAP HANA server and Veeam backup repositories. The plug -in
interacts with databases through the SAP HANA Backint component. Backint for SAP HANA is the backup
interface that enables Veeam Plug-in to communicate with the SAP HANA database and send the database
backup files to the specified Veeam repositories.

Veeam Plug-in compresses database backups and transfers them to a backup repository connected to the
Veeam Backup & Replication infrastructure. After you install and configure Veeam Plug -in on the SAP HANA
server, you can perform all backup and restore operations with HDBSQL scripts, with native SAP HANA tools,
such as SAP HANA Studio and SAP HANA Cockpit, and with Veeam Explorer for SAP HANA.

When Veeam Plug-in is configured, SAP Backint performs a database backup in the following way:

1. When you start a database backup, the SAP HANA Backint starts Veeam Plug -in services on the SAP HANA
server.

2. Veeam Plug-in connects to the Veeam Backup & Replication server and creates a backup job (if it has not
been created before). In the Veeam Backup & Replication console, Veeam backup administrators can use
the backup job to monitor SAP HANA backups.

3. Veeam Plug-in starts Veeam Data Mover services on the SAP HANA server and on a backup repository.
According to a specified number of parallel Backint channels, Veeam Data Movers create channels to
transfer backup data.

4. Veeam Data Movers transport backup data to the backup repository.

19 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Data Backup
Veeam Plug-in for SAP HANA transfers backup data to the Veeam backup repository and stores the data in the
Veeam proprietary format for backups.

You can use the SAP HANA tools or the Veeam Backup & Replication console to initiate and manage backup
operations. With the SAP HANA tools, you can schedule and delete backups, configure backup settings, and
back up SAP HANA databases. The SAP HANA Backint tool performs all initiated backup processes on the SAP
HANA side.

For each backup operation, Veeam Plug-in automatically creates and stores database backup files. For each of
the created backup files, Veeam Plug-in also creates separate metadata files. The backup and metadata files
help Veeam Plug-ins to store and manage backup data while ensuring that the data is protected, accessible, and
can be quickly restored when needed. All backup files created for backup jobs reside in a dedicated job folder in
the backup repository. For details on backup files, see Veeam Plug-in Backup Files.

To store backup files, you can add backup repositories to your Veeam Backup & Replication infrastructure. For
details on all supported backup repositories, see Veeam Backup Repositories.

For details on how to use the specific backup tools, see Database Protection.

Veeam Plug-in Backup Files

For every backup job within Veeam Backup & Replication, Veeam Plug -in creates and stores database backup
files, and separate metadata files for each of the backup files. The backup files provide a consistent and
integrated way for Veeam Plug-ins to store and manage backup data, while ensuring that the data is protected,
accessible and can be quickly restored when needed.

All backup files created by the backup job reside in a dedicated job folder in the backup repository.

Backup Files Format

Veeam Plug-in stores backup files in the following formats:

• A .VAB file stores a compressed copy of a SAP HANA database. Veeam Plug-in creates .VAB files for full,
incremental and log backups.

• A .VASM file stores metadata that contain information about the backup. A .VASM file is created for each
.VAB backup file with the same name as the backup file. The .VASM files are used b y Veeam Backup &
Replication to get data about Veeam Plug-in backups.

• A .VACM file stores metadata about the backup job. A .VACM file is created for each backup job. The
.VACM file is used by Veeam Backup & Replication to get data about Veeam Plug -in backup job.

In the initial backup session, Veeam Plug-in writes backup data about each backed-up database in a separate,
newly created backup file. During subsequent backup sessions, Veeam Plug -in can continue writing backup data
in the existing backup file or create a new file. Veeam Plug-in creates a new file only if the previous backup file
was created more than 24 hours ago.

NOTE

Keep in mind that if you use the scale-out backup repository as a backup target, Veeam Plug -in can create
a backup file for the backed-up database on each repository extent.

20 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Reuse of Backup Files
During backup and restore operations, Veeam Plug -in creates and stores backup files in the Veeam Backup &
Replication backup database. Veeam Plug-in can also reuse backup files by placing multiple backups in a single
.VAB file. This approach helps with optimizing the number of objects in the backup database. Veeam Plug -in
reuses backup files considering the following backup file limits:

• Backup file can contain up to 1000 objects.

• Veeam Plug-in can write data to the created backup file for 24 hours.

After one of the limits is reached, Veeam Plug-in closes the backup file and cannot add new data to this
file. Keep in mind that Veeam Plug-in must close the backup file to allow Veeam Backup & Replication to
perform the following operations:

o Set the immutability for the backup file.

o Copy and move backup file to the capacity tier.

Veeam Backup Repositories

Veeam Plug-ins store backup files in repositories added to the Veeam Backup & Replication infrastructure. In
this section, you can find the list of supported backup repositories and limitations for Veeam Plug -in backups.

Before you start performing operations on backup repositories within the Veeam Backup & Replication
infrastructure, consider that you need to set the access permissions for each repository. For details, see Access
and Encryption Settings on Repositories.

Supported Backup Repositories

You can use the following types of repositories added to the Veeam Backup & Replication infrastructure to store
backups created with Veeam Plug-in for SAP HANA:

• Windows Server

• Linux Server

• SMB (CIFS) Share

• NFS Share

• Dell Data Domain with Data Domain Boost (DDBoost)

• Fujitsu ETERNUS CS800

• Infinidat InfiniGuard

• HPE StoreOnce
If you plan to use HPE StoreOnce as a backup repository for Veeam Plug -in backups, the total number of
stored files (data and metadata) must not exceed 3,000,000 per Cataly st store. If necessary, multiple
Catalyst stores may be created on the same StoreOnce system.

• Quantum DXi

• ExaGrid

Make sure the repository is configured as described in the ExaGrid section in the Veeam Backup &
Replication User Guide.

21 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 • Hardened Repository

• Scale-Out Backup Repository

Make sure that the performance extents of the scale-out backup repository contain repositories supported
by Veeam Plug-in for SAP HANA. For example, you cannot use object storage repositories as performance
extents to keep backups created with Veeam Plug-ins.

Backup Repository Limitations

Before you start working with Veeam Plug-in backups, consider the following:

• For Veeam Plug-in backups, the warning which indicates that free space on a storage device has reached a
specified threshold is configured in the veeam_config.xml file of Veeam Plug-in. The warning settings
in the Veeam Backup & Replication console does not affect this setting.

To configure the warning settings, add the following parameter in the

/opt/veeam/VeeamPluginforSAPHANA/veeam_config.xml file.

<PluginParameters repositoryFreeSpacePercentWarning="10" />

Keep in mind that you must add the parameter to the existing line in the veeam_config.xml file. If you
create a new line with the same name as the existing line, Veeam Plug -in will consider parameters only in
the first detected line. Other parameters will be ignored.

• Due to specific design of SAP HANA backups, Veeam Plug -in does not use fast cloning. Backups
transferred to repositories that use ReFS or XFS as a file system are processed the same way as with NTFS
repositories.

• The Veeam Plug-in configuration wizard will not show repositories where the E ncrypt backups stored in
this repository option is enabled. To learn how to disable the encryption option, see Access and
Encryption Settings on Repositories.

• Make sure that Veeam backup repositories have enough free space to store database backups and redo log
backups. If required, you can use a scale-out backup repository.

• Veeam extract utility cannot extract backup files created by Veeam Plug -in.

• Veeam Plug-ins do not support backup operations targeted directly to object storage repositories.

To learn more about object storage repositories, see the Object Storage Repositories section in the Veeam
Backup & Replication User Guide.

• Veeam Plug-ins do not support backup operations to object storage added as a performance extent of a
scale-out backup repository.

Veeam Scale-Out Backup Repositories

If you want to store Veeam Plug-in backups on scale-out backup repositories, consider the following:

• You cannot rename a scale-out backup repository with Veeam Plug-in backups stored on this repository.

22 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 • For Veeam Plug-in backups and backup copies, the Performance policy of a scale-out repository functions
differently:

a. Veeam Backup & Replication checks if there are extents without warning on free space insufficiency.

If there are no extents without the warning, Veeam Backup & Replication uses an extent with the
largest amount of free space that has a free task slot.

b. For the extents without the warning, Veeam Backup & Replication checks if there are incremental
extents with free task slots.

If there are no incremental extents with free task slots, Veeam Backup & Replication uses a full extent
with the least amount of used task slots.

c. For incremental extents with free task slots, Veeam Backup & Replication sends backup files to an
incremental extent with the least amount of used task slots.

If several extents have the same least amount of used tasks, Veeam Backup & Replication uses an
extent with the largest amount of free space.

To learn more about file placement policies of scale-out repositories, see Backup File Placement section in
the Veeam Backup & Replication User Guide.

• For a scale-out repository configured in the Data Locality policy, the repository extents are selected
according to the largest amount of free space for each SAP HANA Backint connection. If the selected
extent does not have free task slots, Veeam Backup & Replication uses the extent with the next largest
amount of free space.
If there are two extents with only one task slot on each extent, the backup is performed using two parallel
streams (one stream per extent).

• If you want to add a backup repository which contains Veeam Plug-in backups as an extent to a scale-out
backup repository, you must do the following:

On the Veeam Backup & Replication console side

a. Select Veeam Plug-in backup files that reside in this backup repository and remove them from
configuration.

To learn more, see the Removing Backups from Configuration section in the Veeam Backup &
Replication User Guide.

b. Delete the Veeam Plug-in backup job.

To learn more, see the Disabling and Deleting Jobs section in the Veeam Backup & Replication User
Guide.

c. Add the repository as an extent to the scale-out repository.

To learn more, see the Extending Scale-Out Repositories section in the Veeam Backup & Replication
User Guide.

d. Rescan the scale-out repository.

To learn more, see the Rescanning Scale-Out Repositories section in the Veeam Backup & Replication
User Guide.

23 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 NOTE

[For imports to the scale-out backup repository] Before importing your backup, consider that
the names of all backup files (.VAB, .VASM, .VACM) and paths to these files contain only the
following allowed characters:

• a-zA-Z0-9
• _-.+=@^

If your backup was initially created on a standalone backup server, the default name of the
backup metadata file (.VACM) contains forbidden characters. Before importing, you must delete
forbidden characters from the file name or replace them with the allowed characters.

On the Veeam Plug-in side

e. Set the scale-out repository as the target for backups using the following command:

SapBackintConfigTool --set-repository

f. Map the imported backups using the following command:

SapBackintConfigTool --map-backup

Capacity Tier
You can configure Veeam Backup & Replication to transfer Veeam Plug -in backup files to a capacity tier. Both
policies (Move policy, Copy policy) are supported for Veeam Plug-in backups with the following limitations:

• For Veeam Plug-in backup files, capacity tier does not verify whether data that is being moved is unique
and has not been offloaded earlier. Thus, it is highly recommended to check the pricing plans of your
cloud storage provider to avoid additional costs for offloading and downloading backup data.

• To offload Veeam Plug-in backup files to the capacity tier, Veeam Backup & Replication splits data into 1
MB objects and compresses the resulting objects. The default object size will be a compressed 1 MB block,
resulting in objects of around 512 KB in size.

• Veeam Backup & Replication offloads Veeam Plug-in for SAP HANA backup files to the capacity tier with
the Copy and Move policies in different ways. With the Copy policy, Veeam Backup & Replication checks
backup files every 1 hour and runs an offload job only if new backup files exist. With the Move policy,
Veeam Backup & Replication checks backup files every 4 hours and runs an offload job, even if ther e are
no new files.

IMP ORTANT

With both the Copy and Move policies, Veeam Backup & Replication copies and moves to the
capacity tier only non-active backup files created more than 24 hours ago, which match the capacity
tier configuration parameters. To learn more about the capacity tier configuration, see Add Capacity
Tier in the Veeam Backup & Replication User Guide.

24 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 • Veeam Plug-in supports encryption of offloaded data to the capacity tier. The E ncrypt data uploaded to
ob ject storage option in the Ca pacity Tier settings of the scale-out backup repository ensures that the
entire collection of blocks along with the metadata will be encrypted while being offloaded. To learn more
about capacity tier encryption, see the Encryption for Capacity Tier section in the Veeam Backup &
Replication User Guide.

• Capacity tier does not track dependencies of full and incremental Veeam Plug-in backup files. Thus,
consider the following:

o [For the Move policy] When backup files are transferred to the capacity tier, Veeam Backup &
Replication takes into account only the creation time of backup files. Make sure that the operational
restore window is not longer than the whole backup chain cycle period. Otherwise, you may
encounter the scenario when full backup files are transferred to the capacity tier and their increment
backup files still remain in the performance tier.

o The capacity tier immutability expiration date does not have the additional block generation period.
The immutability expiration date is based only on the number of days specified in the settings of the
object storage backup repository.

• In case a disaster strikes the scale-out repository and you have a Veeam Plug-in backup file on the capacity
tier, you must re-create the scale-out repository before you restore from this backup file. You must
connect the capacity tier with the Veeam Plug-in backup file to another backup server with Veeam Backup
& Replication and a scale-out repository. After that, you can import the backup files to Veeam Backup &
Replication and then perform data recovery operations.

• If you use a capacity tier that has been created in Veeam Backup & Replication version 10, you cannot
transfer Veeam Plug-in backup files to a capacity tier. However, if you want to transfer them manually, do
the following:

a. If the backup files are created by Veeam Plug-in version 10, upgrade the metadata of backup files as
described in the Upgrading Backup Files section.

b. Run the Set-VBRScaleOutBackupRepository cmdlet with the EnablePluginBackupOffload

parameter to offload backup files to the capacity tier.

• [For SAP HANA 2.0 SPS 02, SPS 03, SPS 04, SPS 05] If you want to restore from backups stored on the
capacity extent, at least one performance extent must be available or you must switch the
catalog_backup_using_backint parameter to the False state in the global.ini file. Otherwise, at
the end of the restore process, SAP Backint will not be able to back up the catalog and restore will fail.

Hardened Repository
You can configure Veeam Backup & Replication to transfer Veeam Plug -in backup files to a hardened repository.
The hardened repository helps to protect Veeam Plug -in backup files from loss as a result of malware activity or
unplanned actions. Backup files in the hardened repository become immutable for the time period specified in
the backup repository settings. During this period, backup files stored in the repository cannot be modified or
deleted.

For Veeam Plug-in for SAP HANA backups, immutability works according to the following rules:

• Immutability is applied to backup files (.VAB) and backup metadata files (.VASM). Backup job metadata
files (.VACM) are not immutable.

• Backup files become immutable for the configured time period (minimum 7 days, maximum 9999 days).

• Backup files become immutable after 24 hours have passed since each file was created. The immutability
service runs in the background at every hour. This service detects and sets immutability flags for any
backup file that can no longer be reused.

25 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 TIP

Contact Veeam Customer Support to change the default 24 hour lifespan of a backup file. To do that,
you can submit a support case on the Veeam Customer Support Portal.

• The immutability period is not extended for the active backup chain.

Data Restore from Hardened Repository

As a result of malware activity or unplanned actions, backup job metadata files (.VACM) may become
unavailable in the hardened repository. In this case, to restore data from the harde ned repository, you must re-
create the .VACM file. For more information, see Restore from Hardened Repository.

26 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Data Restore
With the configured Veeam Plug-in for SAP HANA, you can restore SAP HANA databases from Veeam Plug -in
backups that reside on Veeam backup repositories.

You can use the tools SAP HANA Studio, SAP HANA Cockpit, SAP HANA HDBSQL commands, or the Veeam
Backup & Replication console to restore databases. Restore operations initiated with the SAP HANA tools are
performed on the SAP HANA side. You can also use Veeam Explorer for SAP HANA to restore SAP HANA
databases. Restore operations in Veeam Explorer for SAP HANA are performed on the Veeam Backup &
Replication side.

Depending on the available type of Veeam Plug -in backups that will be the source for the restored databases,
you can perform the following restore operations:

• Restoring from backup.

Restore SAP HANA databases from a Veeam Plug-in backup to the original server by using SAP HANA tools
or the Veeam Backup & Replication console. For details, see Database Recovery.

You can also restore SAP HANA databases from a Veeam Plug-in backup to another server by using SAP
HANA tools or the Veeam Backup & Replication console. For details, see Restoring to Another Server
(System Copy).

• Restoring from a backup copy.

Restore SAP HANA databases from backup copies created for Veeam Plug-in for SAP HANA backups. For
details, see Restore from Backup Copy.

Depending on the location of Veeam Plug-in backups that will be the source for the restored databases, you can
also perform the following restore operations:

• Restoring from simple repositories.

Restore SAP HANA databases from Veeam Plug-in backups stored on supported types of repositories by
using SAP HANA tools or Veeam Explorer for SAP HANA in the Veeam Backup & Re plication console. For
details, see Veeam Backup Repositories.

• Restoring from hardened repositories.

Restore SAP HANA databases from hardened repositories by creating new backup job metadata files
(.VACM) with data from available backup metadata files (.VASM). For details, see Restore from Hardened
Repository.

27 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Planning and Preparation
Before you start to use Veeam Plug-in for SAP HANA, make sure that your environment meets system
requirements and read the environment planning recommendations.

In This Section
• System Requirements

• Permissions

• Ports

• Licensing

• Veeam Environment Planning

• SAP Environment Planning

28 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

System Requirements
System requirements for Veeam Plug-in for SAP HANA depend on the architecture of the Linux OS that runs on
your machine:

• System requirements for x64 Linux

• System requirements for Linux on Power

System Requirements for x64 Linux

Before you start using Veeam Plug-in for SAP HANA on machines running Linux OSes based on the x64
architecture, make sure the following requirements are met.

NOTE

The following system requirements apply to Veeam Plug -in for SAP HANA operating in the standalone
mode.

For more information on system requirements for Veeam Plug -in managed by Veeam Backup & Replication,
see System Requirements for Managed Veeam Plug-ins.

Sp ecification Requirement

OS Veeam Plug-in for SAP HANA supports 64-bit versions of the following distributions:

• SLES 15: GA, SP1, SP2, SP3, SP4, SP5, SP6

• SLES 12: GA, SP1, SP2, SP3, SP4, SP5
• SLES for SAP Applications 15: GA, SP1, SP2, SP3, SP4, SP5, SP6
• SLES for SAP Applications 12: GA, SP1, SP2, SP3, SP4, SP5
• RHEL 9 for SAP HANA: 9.0, 9.2, 9.4
• RHEL 8 for SAP HANA: 8.0, 8.1, 8.2, 8.4, 8.6, 8.8, 8.10
• RHEL 9 for SAP Solutions: 9.0, 9.2, 9.4
• RHEL 8 for SAP Solutions: 8.0, 8.1, 8.2, 8.4, 8.6, 8.8, 8.10
• RHEL 7 for SAP Solutions: 7.2, 7.3, 7.4, 7.5, 7.6, 7.7, 7.9

SAP HANA Veeam Plug-in for SAP HANA supports the following versions of SAP HANA:
Da tabase
• SAP HANA 2.0: SPS 02, SPS 03, SPS 04, SPS 05, SPS 06, SPS 07, SPS 08 (only
with Backint version 1.0). Express Edition is not supported.
• SAP HANA 1.0: SPS 12 and later.

Note:

To check whether an OS version is compatible with the SAP HANA version you want to
use, see the SAP HANA Administration Guide (requires an SAP ID).

29 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 Sp ecification Requirement

Veeam Backup & Veeam Backup & Replication supports two latest versions of Veeam Plug-ins. For
Rep lication example, Veeam Backup & Replication 12.3 supports Veeam Plug -in 12.3 and 12.2.

Keep in mind that if you use an earlier Veeam Plug-in build than the one that is
included in the installation ISO file of your Veeam Backup & Replication version, it may
not have all the features and bug fixes introduced in your Veeam Backup & Replication
version. To learn more about the Veeam Plug-in builds included in Veeam Backup &
Replication installation ISO files, see this Veeam KB article.

Network Veeam Plug-in should be able to establish a direct IP connection to the Veeam Backup
& Replication server. Thus, Veeam Plug-in cannot work with the Veeam Backup &
Replication server that is located behind the NAT gateway.

System Requirements for Linux on Power

Before you start using Veeam Plug-in for SAP HANA on Linux machines running IBM Power Systems, make sure
the following requirements are met.

NOTE

The following system requirements apply to Veeam Plug -in for SAP HANA for Linux on Power operating in
the standalone mode. The managed operation mode is not supported. For details on operation modes, see
Standalone and Managed Operations Modes.

30 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 Sp ecification Requirement

OS a nd IBM Power For IBM Power 9, Veeam Plug-in for SAP HANA for Linux on Power supports little
endian (LE) versions of the following distributions:
• SLES 15: GA, SP1, SP2, SP3, SP4, SP5, SP6
• SLES 12: SP3, SP4, SP5
• SLES for SAP Applications 15: GA, SP1, SP2, SP3, SP4, SP5, SP6
• SLES for SAP Applications 12: SP3, SP4, SP5
• RHEL 9 for SAP HANA: 9.0, 9.2, 9.4
• RHEL 8 for SAP HANA: 8.0, 8.1, 8.2, 8.4, 8.6, 8.8, 8.10
• RHEL 9 for SAP Solutions: 9.0, 9.2, 9.4
• RHEL 8 for SAP Solutions: 8.0, 8.1, 8.2, 8.4, 8.6, 8.8, 8.10

For IBM Power 10, Veeam Plug-in for SAP HANA for Linux on Power supports little
endian (LE) versions of the following distributions:

• SLES 15: SP3, SP4, SP5, SP6

• SLES for SAP Applications 15: SP3, SP4, SP5, SP6
• RHEL 9 for SAP HANA: 9.0, 9.2, 9.4
• RHEL 8 for SAP HANA: 8.4, 8.6, 8.8, 8.10
• RHEL 9 for SAP Solutions: 9.0, 9.2, 9.4
• RHEL 8 for SAP Solutions: 8.4, 8.6, 8.8, 8.10

SAP HANA Veeam Plug-in for SAP HANA supports SAP HANA 2.0: SPS 02, SPS 03, SPS 04, SPS
Da tabase 05, SPS 06, SPS 07, SPS 08 (only with Backint version 1.0). Express Edition is not
supported.

SAP HANA 1.0 is not supported.

Note:

To check whether an OS version is compatible with the SAP HANA version you want to
use, see the SAP HANA Administration Guide (requires an SAP ID).

Veeam Backup & Veeam Backup & Replication supports two latest versions of Veeam Plug -ins. For
Rep lication example, Veeam Backup & Replication 12.3 supports Veeam Plug -in 12.3 and 12.2.

Keep in mind that if you use an earlier Veeam Plug-in build than the one that is
included in the installation ISO file of your Veeam Backup & Replication version, it may
not have all the features and bug fixes introduced in your Veeam Backup & Replication
version. To learn more about the Veeam Plug-in builds included in Veeam Backup &
Replication installation ISO files, see this Veeam KB article.

Network Veeam Plug-in should be able to establish a direct IP connection to the Veeam Backup
& Replication server. Thus, Veeam Plug-in cannot work with the Veeam Backup &
Replication server that is located behind the NAT gateway.

31 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Permissions
This table contains the list of operations that require specific user account permissions.

NOTE

If you plan to restore SAP HANA databases using Veeam Explorer for SAP HANA, consider the required
permissions listed in the Permissions section of Veeam Explorers User Guide.

Op eration Required Roles and Permissions

Installing and updating The account used for installing and updating Veeam Plug-in must have root
Veeam Plug-in privileges.

• The account specified in the Veeam Plug-in configuration settings must be

Connecting to Veeam
able to authenticate against the Veeam Backup & Replication server. For
Backup & Replication,
managing backups details, see Configuring Plug-in for SAP HANA. For enhanced security, we
recommend creating a separate standard user that will be solely dedicated
to performing the backup and restore operations.
• The account specified in the Veeam Plug-in configuration settings must be
granted access rights on the Veeam backup repository where you want to
store backups.

To learn how to grant permissions on Veeam repositories, see Access and

Encryption Settings on Repositories.
• You can work with backups created by Veeam Plug-in only with the account
used for creating the backups. If you want to use another account, see
required permissions in Configuring Plug-in for SAP HANA.

32 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Ports
To enable proper work of Veeam Plug-ins, make sure that the following ports are open.

SAP HANA Server

The following table describes network ports that must be opened to ensure proper communication of the SAP
HANA server and backup infrastructure components.

From To P rotocol P ort Notes

Default port used for communication with

Veeam the Veeam Backup & Replication server.
Backup & Note that data between Veeam Plug-ins
TCP 10006
Replication and backup repositories is transferred
server directly, bypassing the Veeam Backup &
Replication server.
SAP HANA
server
Backup
where Default range of ports used as data
repository
Veeam 2500 to transmission channels. For every TCP
server or TCP
Plug-in is 3300** connection that a backup process uses,
gateway
installed one port from this range is assigned.
server*

Local connections between Veeam Plug-in

SAP HANA 6791+, and source Data Movers.
server (local TCP 2500 to
host) 3300** If port 6791 is occupied, the succeeding
port numbers will be used.

* For NFS share, SMB share repositories, and Dell Data Domain, HPE StoreOnce deduplication storage appliances, Veeam
Backup & Replication uses an auxiliary backup infrastructure component — gateway server. For details, see the Gateway
Server section in the Veeam Backup & Replication User Guide.
** This range of ports applies to newly added backup infrastructure components. If you upgrade to Veeam Backup &
Replication 10.0 from earlier versions of the product, the range of ports from 2500 to 5000 applies to the already added
components.

33 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Backup Repositories and Gateway Servers
On backup infrastructure components, Veeam Backup & Replication automatically creates firewall rules for the
required ports. These rules allow communication between the components. Depending on the type of backup
repositories that you use for Veeam Plug-in backups, the following ports must be open to allow communication
between backup infrastructure components.

From To P rotocol P ort Notes

Backup
Veeam Default range of ports used as data
repository
Backup & 2500 to transmission channels. For every TCP
server or TCP
Replication 3300** connection that a backup process uses,
gateway
server one port from this range is assigned.
server*

Direct Attached Storage

Linux server
used as a
Port used as a control channel from the
backup
TCP 22 Veeam Plug-in server to the target Linux
repository or
host.
gateway
server
Veeam
Backup &
Replication Microsoft Ports used as a management channel from
TCP 135,
server Windows the Veeam Plug-in server to the
137 to 139,
server used UDP Repository/Gateway server. Also, the ports
445
as a backup are used to deploy Veeam components.
repository or
gateway 6160, Default ports used by the Veeam Installer
server TCP
6162 Service and Veeam Data Mover Service

Network Attached Storage

Gateway Default port used by the SMB transport

TCP 445
server protocol.

(specified in
the SMB SMB server SMB/Netbios name resolution for the SMB
share TCP 135, protocol (needed in some cases). For
repository UDP 137 to 139 details, see the Used Ports section in the
settings) Veeam Backup & Replication User Guide.

34 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 From To P rotocol P ort Notes

Gateway
server

(specified in TCP Standard NFS ports used as a transmission

111,
the NFS NFS server channel from the gateway server to the
UDP 2049
share target NFS share.
repository
settings)

Dell Data Domain

Port used to assign a random port for the

mountd service used by NFS and
TCP 111
DDBOOST. Mountd service port can be
statically assigned.
Veeam Dell Data
Backup & Domain Main port used by NFS. To change the
Replication port, you can use the nfs set server-
server For more TCP 2049
information, port command. Note that the command
or
see this Dell requires SE mode.
Gateway
server KB article.
Main port used by NFS MOUNTD. To
change the port, you can use the nfs set
TCP 2052
mountd-port command. Note that the
command requires SE mode.

HP E StoreOnce

Veeam Default command port used for

9387
Backup & communication with HPE StoreOnce.
Replication
HPE
server TCP
StoreOnce
or Default data port used for communication
Gateway 9388
with HPE StoreOnce.
server

E x aGrid

Veeam
Backup & Default command port used for
ExaGrid TCP 22
Replication communication with ExaGrid.
server

Qua ntum DXi

35 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 From To P rotocol P ort Notes

Veeam
Backup & Default command port used for
Quantum DXi TCP 22
Replication communication with Quantum DXi.
server

Fujitsu ETERNUS CS800

Veeam
Fujitsu Default command port used for
Backup &
ETERNUS TCP 22 communication with Fujitsu ETERNUS
Replication
CS800 CS800.
server

Infinidat InfiniGuard

Veeam
Backup & Infinidat Default command port used for
TCP 22
Replication InfiniGuard communication with Infinidat InfiniGuard.
server

For detailed list of ports used by Veeam Backup & Replication server and backup repositories, see the Used Ports
section in the Veeam Backup & Replication User Guide.

36 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Licensing
To use the Veeam Plug-in functionality, you must have a valid Veeam Backup & Replication license. Licenses are
installed and managed on the Veeam Backup & Replication server that is connected to the Veeam Plug -in server.
If the license is not valid or out of resources, Veeam Plug -in backup jobs fail.

This guide provides information only on specifics of Veeam licenses for Veeam Plug-ins. For terminology and
general information about Veeam Licensing, see Veeam Licensing Policy.

Licensed Objects
If you are using any instance-based (Veeam Universal Licensing) license on your Veeam Backup & Replication,
you don't need to install any additional license keys.

A machine where SAP HANA is deployed is assumed protected if it has been proce ssed by a Veeam Plug-in
backup job in the last 31 days. When you back up SAP HANA databases on one host, one License Unit is
consumed from the Veeam Backup & Replication license. A machine protected by both Veeam Plug -in and
Veeam Backup & Replication will consume a License Unit only once. For example, you have an SAP HANA server
that you back up using Veeam Plug-in. You can also back up this server using image-level backup functionality
of Veeam Backup & Replication. In this case, only one License Unit will be consumed.

NOTE

If you are using a legacy perpetual per-socket license, a license is required for each hypervisor CPU socket
occupied by protected SAP HANA servers.

A socket is consumed from the license only if the hypervisor where protected servers r eside is added to the
Veeam Backup & Replication infrastructure. If the hypervisor is not added to the Veeam Backup &
Replication infrastructure, an instance unit will be consumed from the license. To learn how to add a
hypervisor to the Veeam Backup & Replication infrastructure, see the Virtualization Servers and Hosts
section in the Veeam Backup & Replication User Guide.

IMP ORTANT

If you have an SAP HANA Scale-Out Cluster, each node will consume one License Unit. The License Units
are consumed for all cluster nodes, even if Veeam Plug -in is installed only on one of the nodes.

Supported License Types and Packages

You can use Veeam Plug-ins with the following license types and packages. Note that this guide contains
information on specifics of Veeam license packages only for Veeam Plug -ins. For the full list of license packages,
see this Veeam webpage.

• For Veeam Universal license:

You can use Veeam Plug-ins with all license packages ( Veeam Backup Essentials, Veeam Backup &
Replication, Veeam Availability Suite ).
Note that if you use the Rental license type, functionality of Veeam Plug-ins is supported only for the
Enterprise Plus edition of Veeam Backup & Replication.

• For Socket license:

Functionality of Veeam Plug-ins is supported only for the Enterprise Plus edition of Veeam Backup &
Replication.

37 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Obtaining and Managing Licenses
To learn how to install a license and monitor licensed objects, see the Licensing section in the Veeam Backup &
Replication User Guide.

38 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Veeam Environment Planning
The integration of SAP HANA and Veeam Plug-in requires additional environment planning. Before you deploy
Veeam Plug-in, keep in mind the following requirements and limitations.

Hosting Environments and Backup Job Names

By default, Veeam Plug-in uses the server hostname to create a Veeam Backup & Replication job object and
backup folder. To distinguish between servers with the same hostnames, you can assign custom names for these
servers.

To assign a custom name, update the Veeam configuration XML file as follows:

1. On the machine with Veeam Plug-in, open the

/opt/veeam/VeeamPluginforSAPHANA/veeam_config.xml file.

2. Add the customServerName parameter entry to the <PluginParameters /> line in the Veeam
configuration XML file:

<PluginParameters customServerName="hostname.domain.tld" />

where <hostname.domain.tld> is a custom name of the server.

After adding this parameter, Veeam Plug-in will use the specified custom name of the server to name the
backup job and backup folder.

For example:

<PluginParameters customServerName="srv01.tech.local" />

Alternatively, you can use the useFQDNInServerName parameter:

<PluginParameters useFQDNInServerName="true" />

After adding this parameter, Veeam Plug-in will use the fully qualified domain name (FQDN) of the server to
name the backup job and backup folder.

Keep in mind that you must add the parameters to the existing line in the veeam_config.xml file. If you
create a new line with the same name as the existing line, Veeam Plug -in will consider parameters only in the
first detected line. Other parameters will be ignored.

IMP ORTANT

For security reasons, it is recommended to use separate repositories for different customers and limit the
Veeam Repository Authentication to the specific customer.

Veeam User Management

Veeam Plug-in for SAP HANA uses the Windows authentication methods of the Veeam Backup & Replication
server to establish a connection to this server and to the target backup repository. It is recommended to create
one specific user for each Veeam Plug-in server or for each scale-out cluster.

39 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

In case of future manual changes to the user account, the new user must have at least the Veeam Backup
Operator and Veeam Restore Operator rights within the Veeam Backup & Replication user management. To learn
how to assign Veeam Backup & Replication roles, see the Users and Roles section of the Veeam Backup &
Replication Guide.

Network Traffic Encryption

Veeam Plug-in supports network traffic encryption rules set on the Veeam Backup & Replication side. By
default, Veeam Plug-in automatically applies the traffic encryption rules. To decrease the processing load on
the database server, you can disable network traffic encryption by ignoring the rules set on the Veeam Backup &
Replication side.

To ignore network traffic encryption rules, do the following:

1. Locate the Veeam configuration XML file:

/opt/veeam/VeeamPluginforSAPHANA/veeam_config.xml.

2. Add the following parameter to the Veeam configuration XML file:

<IgnoreVBRNetworkRules=true />

To learn more about traffic encryption, see the Enabling Traffic Encryption section in the Veeam Backup &
Replication User Guide.

SAP HANA Backup Channels and Veeam Repository Task Slots

By default, SAP HANA uses one channel per data backup operation. You can configure SAP HANA to use
additional channels. When multiple channels are used, SAP HANA distributes the data equally across available
channels.

Keep in mind that the number of SAP HANA channels must be equal to the number of available task slots in the
repository. To learn more about task slot limitations, see the Limitation of Concurrent Tasks section in the
Veeam Backup & Replication user guide.

When using multiple channels in parallel, the data flow between SAP HANA and the source Veeam Data Mover is
faster. This also improves overall backup performance. However, consider that using multiple channels uses
more resources on the SAP HANA server, the network, the backup source, the target disk systems, and in the
Veeam backup repository. To learn more about backup repository resource usage and limitations, see Veeam
Backup Repositories.

To control the number of parallel channels used for each SAP HANA Backint instance, edit the
parallel_data_backup_backint_channels parameter in the SAP HANA global.ini file. For detailed
instructions on how to edit the number of channels used in parallel, see this SAP article.

NOTE

The application of multiple streaming channels applies to all data backup services larger than 128 GB. Data
backup services smaller than 128 GB use only one channel.

If you use a dedicated backup repository for Veeam Plug -in backups, the following hardware resources are
recommended and are based on tests on Skylake processors:

• SAP HANA server: 1 CPU core and 200 MB of RAM per currently used channel.

• Ba ckup repository server: 1 CPU core and 1 GB of RAM per 5 currently used channels.

40 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

If you use the same backup repository for Veeam Plug -in backups and backups created by Veeam Backup &
Replication or Veeam Agents, consider adding the mentioned above hardware resources based on usual load on
your backup repository.

To learn more about the requirements for backup repositories, see the System Requirements section of the
Veeam Backup & Replication User Guide.

Additionally, consider the following limitations when using of multiple channels:

• It is not recommended to use more than 64 channels in parallel as the overhead will reduce individual
channel performance. Set the max_recovery_backint_channels setting in global.ini to 64 or below
depending on available hardware resources.

• It is recommended to use a separate backup repository for Veeam Plug -in backups.

• If you want to improve backup performance, the SAP HANA buffer must be increased for additional used
channels. For details, consult with your SAP HANA database administrator.

• SAP HANA can back up individual databases and tenants in parallel. To optimize resources, you can back
up databases sequentially.

• If there are not enough available repository task slots, SAP HANA waits till repository task slots become
available.

• During restore, the order of repository task slots is ignored, and channels are used as requested by SAP
HANA.

• Veeam Backup & Replication server: during manual metadata operations such as import of backup files,
the Veeam Backup & Replication server needs additional 15 GB of RAM per 1 million files located in the
same backup job folder.

Example 1: Backing up all databases in parallel

In this example, the system has 2 tenant databases, each database has 4 services. The databases are backed up
in parallel. The SAP HANA channel setting is 6. The following channels are used:

• Up to 4 channels are used by SYSTEMDB and its 4 services (all below 128 GB).

• Up to 6 channels are used for the index service of the tenant database 1 (the database is bigger than 128
GB).

• Up to 3 channels are used for the rest of the 3 remaining services of the tenant database 1 (all below 128
GB).

• Up to 6 channels are used for the index service of the tenant database 2 (the database is bigger than 128
GB).

• Up to 3 channels are used for the rest of the 3 remaining services of the tenant database 2 (all below 128
GB).

• If the log backups are below 128 GB, you must reserve at least 3 channels for the log backup of
SYSTEMDB, tenant database 1, and tenant database 2. These log backups are started automatically on
their own schedule or when the maximum file size of the log file is reached.

In total, 27 channels were used. For backup processes of all databases started in parallel, up to 27 task slots
must be available.

41 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Example 2: Backup of all databases sequentially
In this example, the system has 2 tenant databases, each database has 4 services. The databases are backed up
sequentially. The SAP HANA channel setting is 6. The following maximum repository task slots and SAP
channels are used:

• Up to 6 channels are used for the index service of a tenant database (the database is bigger than 128 GB).

• Up to 3 channels are used for the rest of the 3 remaining services of the same tenant database (all below
128 GB).

• If the log backups are below 128 GB, you must reserve at least 3 channels for the log backup of
SYSTEMDB, tenant database 1, and tenant database 2. These log backups are started automatically on
their own schedule or when the maximum file size of the log file is reached. Assuming that the log file
backups are below 128 GB and do not use additional channels.

In total, 12 channels were used. For backup processes of sequential started database backups, up to 12 task slots
must be available.

Additional Files to Back Up

Veeam Plug-in for SAP HANA and SAP HANA do not include the respective configuration files in backups
automatically. After the installation and configuration, consider the additional manual backup of the following
configuration files:

• Veeam Plug-in configuration file: /opt/veeam/VeeamPluginforSAPHANA/veeam_config.xml

• SAP HANA configuration files:

o /usr/sap/<SID>/SYS/global/hdb/custom/config

o /usr/sap/<SID>/<INSTANCE>/<FQDN>

o /usr/sap/<SID>/SYS/global/hdb/custom/config

To learn more about SAP HANA configuration files, see this SAP article.

42 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

SAP Environment Planning
Keep in mind the following requirements and limitations for your SAP environment, before you deploy Veeam
Plug-in for SAP HANA.

Scheduling
You can schedule backup operations with all SAP HANA relevant scheduling options like SAP HANA Cockpit
(HANA Cockpit 2.0 SPS 06 or later version), SAP DB13 (NW 7.02 SP17 or later version) or external schedulers
like cron, UC4, TWS and others. Veeam Plug-in forwards the backups created by SAP HANA integrated backup
application to a Veeam backup repository.

To learn how to configure external schedulers, see the Veeam Plug-in for SAP HANA Best Practices.

SAP HANA encryption

Veeam Plug-in supports SAP HANA integrated encryption. The encryption processes are performed on the SAP
HANA side. Veeam Plug-in is not involved in encryption processing.

Plan the protection of the encryption environment. In case you loose the encryption keys, Veeam Plug -in can
only provide an access to the encrypted backup file. To regain full access to the backup files, you will have to
decrypt data in your SAP HANA environment. For more information on SAP HANA data encryption, see this SAP
article.

SAP HANA Catalog Backup with Backint

To back up the SAP HANA catalog using Backint, change the settings of the
catalog_backup_using_backint parameter in the backup section of the global.ini file. To learn more,
see this SAP article.

SAP HANA Scale-Out Cluster

Consider the following limitations of Veeam Plug-in support for SAP HANA scale-out clusters:

• All backup tasks across the SAP HANA scale-out cluster are performed in parallel.

• On all cluster nodes, Veeam Plug-in must be configured to transfer backups to the same repository.

• Due to the design of SAP HANA databases, the same Veeam Plug -in configuration must be set on all scale-
out cluster members, including stand-by nodes.

• Each cluster node must use the same credentials to connect to Veeam servers.

SAP HANA System Replication Failover

SAP HANA does not allow you to back up from replicas. You can back up these databases only after a failover.
To prepare the replication target system for backups after the failover, you can configure Veeam Plug -in as
usual for a new scale-up or scale-out system. The Veeam backup job object will be created at first backup run
and reflect the hostname of each system.

43 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 IMP ORTANT

You must perform full database backup at least once after each failover or failback, so that SAP HANA
starts to create automatic log backups.

After the failover, if you want to restore backups created before the failover, you must configure the plug-in to
be able to access the backup files from the original source system:

1. Go to /opt/veeam/VeeamPluginforSAPHANA and run the Veeam Plug-in configuration tool with the
following parameter.

VM2ADM:/opt/veeam/VeeamPluginforSAPHANA> SapBackintConfigTool --set-backup

-for-restore

2. Perform restore.

3. Optional: If you want to restore from the new backup chain created from the system replication server,
you must run the command again and select the system replication server as a source for restore.

44 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Deployment and Configuration
To deploy Veeam Plug-in, you must install the plug-in on an SAP HANA server and configure plug-in integration
settings.

In This Section
• Installing Plug-in for SAP HANA

• Access and Encryption Settings on Repositories

• Granting Permissions to Users

• Configuring Plug-in for SAP HANA

• Specifying Preferred Networks for Veeam Plug-ins

• Configuring Performance Throttling

• Automating Configuration of Plug-in for SAP HANA

• Upgrading Plug-in for SAP HANA

• Importing Backup Files

• Uninstalling Plug-in for SAP HANA

This guide gives instructions on how to deploy Veeam Plug -in assuming that you have already deployed a
Veeam Backup & Replication server and configured a backup repository. If you need instructions on how to
deploy Veeam Backup & Replication, see the Veeam Backup & Replication User Guide for your platform.

You can also manage deployment, configuration and backup policies of Veeam Plug -ins using the Veeam Backup
& Replication console. For details, see Veeam Plug-in Management.

45 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Installing Plug-in for SAP HANA
See one of the following guides depending on Linux OS architecture running on your machine:

• Installing Plug-in for x64 Linux

• Installing Plug-in for Linux on Power

Installing Plug-in for x64 Linux

Veeam Plug-in for SAP HANA is an additional component of Veeam Backup & Replication, and the installation
package of the plug-in is included in the Veeam Backup & Replication installation ISO file.

You can install the plug-in using the .RPM package or extract the plug-in files from the .TAR.GZ archive.
Depending on the type of package suitable for your OS, perform steps in one of the following subsections:

• Installing Plug-in from .RPM Package

• Unpacking Plug-in from .TAR.GZ Archive

IMP ORTANT

Keep in mind the following:

• Veeam Plug-in for SAP HANA must be installed on the SAP HANA server.
• The /opt/veeam directory must be writable.
• The NOEXEC mount option must be disabled for the /var and /tmp directories.
• To install the plug-in, use the sudo command or a user with root privileges.
• If you want to install Veeam Plug-in for SAP HANA scale-out cluster, repeat the described
installation process on all cluster nodes.

Installing Veeam Plug-in from .RPM Package

To install Veeam Plug-in, do the following:

1. Mount the Veeam Backup & Replication installation disk

(VeeamBackup&Replication_12.3.0.310_20241201.iso).

If you deploy Veeam backup infrastructure for the first time, you can download the Veeam Backup &
Replication installation disk image from the Veeam Backup & Replication: Download page.

2. Open the mounted disk image and go to the /Plugins/SAP HANA/x64 directory.

3. Upload the VeeamPluginforSAPHANA-12.3.0.310-1.x86_64.rpm file to the SAP HANA server.

4. To install Veeam Plug-in, run the following command:

rpm -i VeeamPluginforSAPHANA-12.3.0.310-1.x86_64.rpm

46 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Unpacking Veeam Plug-in from .TAR.GZ Archive
To extract plug-in files from the .TAR.GZ archive, perform the following:

1. Mount the Veeam Backup & Replication installation disk

(VeeamBackup&Replication_12.3.0.310_20241201.iso).

If you deploy Veeam backup infrastructure for the first time, you can download the Veeam Backup &
Replication installation disk image from the Veeam Backup & Replication: Download page.

2. Open the mounted disk image and go to the /Plugins/SAP HANA/x64 directory.

3. Upload the VeeamPluginforSAPHANA.tar.gz file to the SAP HANA server.

4. Create the /opt/veeam directory.

mkdir /opt/veeam

5. In the terminal, open the folder that contains the VeeamPluginforSAPHANA.TAR.GZ archive.

6. Unpack the plug-in files from the archive to the /opt/veeam directory.

tar -xzvf VeeamPluginforSAPHANA.tar.gz -C /opt/veeam

Installing Plug-in for Linux on Power

Veeam Plug-in for SAP HANA for Linux on Power is an additional component of Veeam Backup & Replication,
and the installation package of the plug-in is included in the Veeam Backup & Replication installation ISO file.

You can install the plug-in using the .RPM package or extract the plug-in files from the .TAR.GZ archive.
Depending on the type of package suitable for your OS, perform steps in one of the following subsections:

• Installing Plug-in from .RPM Package

• Unpacking Plug-in from .TAR.GZ Archive

IMP ORTANT

Keep in mind the following:

• Veeam Plug-in for SAP HANA for Linux on Power must be installed on the SAP HANA server.
• The /opt/veeam directory must be writable.
• The NOEXEC mount option must be disabled for the /var and /tmp directories.
• To install the plug-in, use the sudo command or a user with root privileges.
• If you want to install Veeam Plug-in for SAP HANA scale-out cluster, repeat the described
installation process on all cluster nodes.

47 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Installing Veeam Plug-in from .RPM Package
To install Veeam Plug-in for SAP HANA for Linux on Power, do the following:

1. Mount the Veeam Backup & Replication installation disk

(VeeamBackup&Replication_12.3.0.310_20241201.iso).

If you deploy Veeam backup infrastructure for the first time, you can download the Veeam Backup &
Replication installation disk image from the Veeam Backup & Replication: Download page.

2. Open the mounted disk image and go to the /Plugins/SAP HANA/ppc64le directory.

3. Upload the VeeamPluginforSAPHANA-12.3.0.310-1.ppc64le.rpm file to the SAP HANA server.

4. To install Veeam Plug-in, run the following command:

rpm -i VeeamPluginforSAPHANA-12.3.0.310-1.ppc64le.rpm

Unpacking Veeam Plug-in from .TAR.GZ Archive

To extract plug-in files from the .TAR.GZ archive, perform the following:

1. Mount the Veeam Backup & Replication installation disk

(VeeamBackup&Replication_12.3.0.310_20241201.iso).

If you deploy Veeam backup infrastructure for the first time, you can download the Veeam Backup &
Replication installation disk image from the Veeam Backup & Replication: Download page.

2. Open the mounted disk image and go to the /Plugins/SAP HANA/ppc64le directory.

3. Upload the VeeamPluginforSAPHANA.tar.gz file to the SAP HANA server.

4. Create the /opt/veeam directory.

mkdir /opt/veeam

5. In the terminal, open the folder that contains the VeeamPluginforSAPHANA.TAR.GZ archive.

6. Unpack the plug-in files from the archive to the /opt/veeam directory.

tar -xzvf VeeamPluginforSAPHANA.tar.gz -C /opt/veeam

48 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Access and Encryption Settings on Repositories
When you configure Veeam Plug-in, you specify an account that must be used to connect to the Veeam Backup
& Replication server.

Before granting access permissions, consider the following:

• Consider supported types of backup repositories and limitations for Veeam Plug-in backups in Veeam
Backup Repositories.

• To store backups in a backup repository, the specified account must have access permissions on the target
backup repository.

To grant access permissions, do the following:

1. In Veeam Backup & Replication, open the Ba ckup Infrastructure view.

2. In the inventory pane, click the Ba ckup Repositories node or the Sca le-out Repositories node.

3. In the working area, select the necessary backup repository and click Set Access Permissions on the ribbon
or right-click the backup repository and select Access permissions.

4. In the Access Permissions window, on the Sta ndalone applications tab specify to whom you want to grant
access permissions on this backup repository:

o Allow to everyone — select this option if you want to grant repository access to any user. This option
is equal to granting access rights to the Everyone group in Microsoft Windows (anonymous users are
excluded). For security reasons, the option is not recommended for production environments.

o Allow to the following accounts or groups only — select this option if you want only specific users to
be able to store backups in this repository. Click Ad d to add the necessary users and groups to the list.

5. Veeam Plug-ins cannot send backups or backup copies to a backup repository where encryption is
enabled. Thus, make sure that the E ncrypt standalone application backups stored in this repository check
box is not selected.

49 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 6. Click OK.

50 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Granting Permissions to Users
When you install Veeam Plug-in for SAP HANA, full access rights to the plug-in configuration file are
automatically granted to all users. To protect sensitive information that is stored in the configuration file from
unwanted access, we recommend limiting access to the configuration file to a dedicated group of users.

Before You Begin

Before you create a user group that will have access to the plug -in configuration file, consider the following:

• To perform this procedure, your OS user account must have root privileges.

• After a user is added to the group, the user must log out, then log in to the Linux OS again to activate the
group permissions.

• Add only trusted users to the group.

IMP ORTANT

The OS user that has access to all local SAP resources (typically, <sid>adm) must be added to the
group.

Granting Permissions to the Plug-In Configuration File

By default, the Veeam Plug-in configuration file (veeam_config.xml) is located in the
/opt/veeam/VeeamPluginforSAPHANA directory on the machine where Veeam Plug-in is installed. To grant
access to the configuration file to a dedicated group of users, do the following:

1. Create a new user group by running the following command:

sudo groupadd <groupName>

where <groupName> is the name of the created group.

2. Add a user to the group with the following command:

sudo usermod -a -G <groupName> <userName>

where:

o <groupName> — the name of the created group.

o <userName> — the name of the account that will be granted access to the configuration file.

3. Change the ownership of the configuration file to enable users from the dedicated group to access the
configuration file. To do this, run the following command:

sudo chgrp <groupName> /opt/veeam/VeeamPluginforSAPHANA/veeam_config.xml

where <groupName> is the name of the created group.

51 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 4. Limit the permissions for the configuration file to allow the read -write access only to the members of the
group. To do this, use the following command:

sudo chmod 660 /opt/veeam/VeeamPluginforSAPHANA/veeam_config.xml

52 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Configuring Plug-in for SAP HANA
When you configure Veeam Plug-in settings, you set up integration settings between an SAP HANA server,
Veeam Backup & Replication server and backup repositories where backup files will be stored. Veeam Plug -in
uses the Sa pBackintConfigTool wizard to configure the integration settings. The wizard configures the SAP
HANA Backint settings and creates the/opt/veeam/VeeamPluginforSAPHANA/veeam_config.xml file.

NOTE

• The configuration of Veeam Plug-in must be performed by a user with database administrator rights
on all SAP HANA instances of the server.

• The SAP HANA High Level Isolation mode is not supported.

See the following instructions:

• Veeam Plug-in Configuration

• Configuration of Veeam Plug-in on Multiple SAP HANA Instances

• Verifying Configuration of Veeam Plug-in for SAP HANA

• Configuration Tool Parameters

Veeam Plug-in Configuration

To configure Veeam Plug-in, do the following:

1. Log in with operating system user ( <sid>adm or a user with similar rights) and run the following command
to launch the Veeam Plug-in configuration tool. You do not need root privileges if you have configured
group access as described in the Permissions section.

SapBackintConfigTool --wizard

If you have extracted files form the .TAR.GZ archive, go to the /opt/veeam/VeeamPluginforSAPHANA
folder and run the following command:

./SapBackintConfigTool --wizard

2. Specify the DNS name or IP address of your Veeam Backup & Replication server.

Enter backup server name or IP address: serv02.tech.local

3. Specify the port which will be used to communicate with the backup server. Default port: 10006.

Enter backup server port number: 10006

53 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 4. Specify credentials to authenticate against the Veeam Backup & Replication server.

Enter username: serv02\administrator

Enter password for serv02\administrator:

IMP ORTANT

Consider the following:

• You can work with backups created by Veeam Plug-in only with the account used for creating
the backups. If you want to use another account, assign the Veeam Backup Administrator role
or Veeam Backup Operator and Veeam Restore Operator roles to the account.

To learn how to assign Veeam Backup & Replication roles, see the Users and Roles section in
the Veeam Backup & Replication User Guide.
• The account must have access permissions on the required backup repository. To learn how to
configure access permissions and encryption settings on repositories, see Access and
Encryption Settings on Repositories.

5. Select the backup repository where you want to store backups. In the terminal dialog, enter the number of
the repository from the list of available repositories.

Available backup repositories:

1. serv10_repo
2. serv07_repo
Enter repository number: 1
Configuration result:
SID SH2 has been configured

IMP ORTANT
• The used account must have access to Veeam backup repositories that you plan to use.
• Encryption must be disabled on the repository.

Otherwise, the repositories will not be listed as available. To learn how to configure access and
encryption settings on repositories, see Access and Encryption Settings on Repositories.

If you start the wizard for the first time on an SAP HANA scale-out cluster, the wizard asks you for a
cluster name. The cluster name will be used by Veeam Backup & Replication to identify the backup job for
the cluster. Further runs of the wizard within the SAP HANA scale-out cluster will not ask for this entry
again.

NOTE

[For SAP HANA 1.0] If the wizard finishes with an error that required hdbbackint symlink cannotbe
created, see this Veeam KB.

54 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Configuration of Veeam Plug-in on Multiple SAP HANA
Instances
Configuration of Veeam Plug-in includes configuration or creation of the SAP HANA Backint symlinks on all SAP
HANA instances. To be able to do this for multiple SAP HANA instances at the same time, the configuration must
be performed by a user with root privileges. Alternatively, you can use an account from the sapsys user group to
configure the plug-in and set the symlink for SAP HANA instances where the account has access rights. You can
repeat the wizard under another account to configure additional SAP HANA instances.

Alternatively, you can configure a Linux security group. To do that, you must add all Veeam Plug -in admins to
this security group and set the following rights:

chown root:<youradmingroup> /opt/veeam/VeeamPluginforSAPHANA/veeam_config.xml

chmod 664 /opt/veeam/VeeamPluginforSAPHANA/veeam_config.xml

To learn about required permissions for backup and restore operations within SAP HANA, see this SAP article.

Verifying Configuration of Veeam Plug-in for SAP HANA

When you finish the plug-in configuration wizard, the plug-in creates a soft link in the
/hana/shared/<SID>/global/hdb/opt directory.

To verify that the Backint Agent is configured correctly, do the following:

1. Connect to the database using SAP HANA Studio.

2. Go to Backup/Configuration.

3. In the Ba ckint Agent field, make sure that the specified path leads to
/opt/veeam/VeeamPluginforSAPHANA/hdbbackint.

55 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Configuration Tool Parameters
Apart from running a configuration wizard, you can use the Sa pBackintConfigTool tool to change a specific
parameter in the veeam_config.xml file or enable/disable Veeam Plug-in features.

IMP ORTANT

When you work with the command-line tool, use one configuration parameter per command. The tool does
not support commands with multiple parameters.

The following table lists available parameters for Sa p BackintConfigTool.

P a rameter Description

--help Shows the list of tool parameters.

--show-config Shows configuration parameters.

Starts the wizard to configure the plug-in settings. The wizard

edits the Veeam Plug-in configuration file
(veeam_config.xml) or creates a new one if the configuration
--wizard
file was removed from the
/opt/veeam/VeeamPluginforSAPHANA directory on the
machine where Veeam Plug-in is installed.

--set-credentials <"serv\username"> Specifies credentials to log in to the Veeam Backup &

< p assword> Replication server.

Specifies the IP address or hostname of the Veeam Backup &

--set-host <hostname>
Replication server.

Specifies a port number that will be used to communicate with

--set-port <port_number>
the Veeam Backup & Replication server.

Launches a wizard to select a backup repository. A backup

--set-repository repository is selected from repositories which are available in
the connected Veeam Backup & Replication instance.

56 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 P a rameter Description

[For System Copy] Specifies the backup that will be used for
restore operations. You can use this parameter if you want to
restore a database to another server or to restore a database
from a backup copy.

When you run the SapBackintConfigTool command with

--set-backup-for-restore this parameter, Veeam Plug-in will prompt you to select an
authentication method to access a backup created for the
original server and then select the backup from which you want
to restore a database.

For more information, see Restore to Another Server (System

Copy).

--ma p-backup Maps the imported backups.

--set-force-delete Deletes backup files after specified days.

Maps the imported backup copy to a regular Veeam Plug-in

--p romote-backup-copy-to-primary
backup chain.

This command is supported for Veeam Plug-in operating in the

managed mode. For more information, see Standalone and
Managed Operations Modes.

Sets the custom name for the cluster. During the Veeam Plug -in
--set-scale-out-cluster-name deployment on the scale-out system nodes, Veeam Backup &
Replication sets the scale-out system name using domain name
and SAP system name. If you want to set a custom name, use
the --set-scale-out-cluster-name command on the
computer side. This custom name will be saved in the
veeam_config.xml file.

Specifies an authentication method for database restore. Use

this parameter if you want to restore a database to another
server using Veeam Explorer for SAP HANA.

--seth-auth-data-for-restore After you run the SapBackintConfigTool command with this

parameter, use the SapBackintConfigTool command with
the --set-backup-for-restore parameter to select a
backup from which you want to restore a database. For more
information, see Restore with Veeam Explorer for SAP HANA.

57 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 P a rameter Description

Shows the list of preferred networks set for Veeam Plug -in data
traffic to the remote backup repository.

The list shows set preferred networks in descending order of

--show-preferred-networks priority. If the list is empty, no networks are set as preferred and
Veeam Plug-in routes data traffic to the preferred networks set
in Veeam Backup & Replication. For more information, see
Specifying Preferred Networks for Veeam Plug-ins.

Adds a network to the list of preferred networks for Veeam

Plug-in data traffic to the remote backup repository.
--a dd-preferred-network To select to which network Veeam Plug-in connects first, you
< network_IP_address> <position_in_list> can set the order number of the network in the list. For more
information, see Specifying Preferred Networks for Veeam Plug-
ins.

--remove-preferred-network Removes a specified network from the list of preferred networks

< network_IP_address> for Veeam Plug-in data traffic to the remote backup repository.

Example
To specify credentials that will be used to log in to the Veeam Backup & Replication server, use the plug -in
configuration tool with the following command:

SapBackintConfigTool --set-credentials "serv02\Administrator" "password"

58 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Specifying Preferred Networks for Veeam Plug-
ins
You can specify networks over which Veeam Plug-in must transport data when you perform data protection and
disaster recovery tasks on remote backup repositories. This setting applies only to Veeam Plug -in network
traffic, without affecting the data traffic of other Veeam Backup & Replication components. Setting a dedicated
network for Veeam Plug-in backup and replication operations can help to reduce heavy network loads.

NOTE

Consider the following:

• By default, if there are no specified preferred networks for Veeam Plug -in data traffic, Veeam Plug-
in will connect to preferred networks specified in Veeam Backup & Replication. To learn more about
setting preferred networks in Veeam Backup & Replication, see the Specifying Preferred Networks
section in the Veeam Backup & Replication User Guide.
• Veeam Plug-in does not save information about failed network connections. If backup or restore
operations fail, Veeam Plug-in tries to connect to the following network from the preferred
networks list to finish the started operations. Regardless of the first unsuccessful connection,
Veeam Plug-in will try to perform the next backup operations first on the failed network.
• Veeam Plug-in network preferences take priority over Veeam Backup & Replication network
preferences. Only if the preferred networks for Veeam Plug -in data traffic are not available for any
reason, Veeam Plug-in will try to connect to the Veeam Backup & Replication preferred networks.

To specify networks for data transfer, you must create a list of preferred networks. When Veeam Plug -in needs
to transfer data, it uses networks from this list. If a connection over any of the preferred networks cannot be
established for any reason, Veeam Plug-in will automatically fail over to the following network from the
preferred networks list.

To create and manage the list of preferred networks that Veeam Plug -in will use, you can perform the following
operations:

• Adding Preferred Networks

• Accessing Preferred Networks

• Removing Preferred Networks

Adding Preferred Networks

1. Access the Veeam Plug-in for SAP HANA directory /opt/veeam/VeeamPluginforSAPHANA on the
server where Veeam Plug-in is installed.

2. Run the Sa pBackintConfigTool command with the following parameter:

SapBackintConfigTool --add-preferred-network <network_IP_address> <positio

n_in_list>

where:

o <network_IP_address> can be either the IP address of a single network or a network mask that
contains a range of network IP addresses. Specify one of the available options to add as preferr ed
networks for Veeam Plug-in data traffic.

59 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 o <position_in_list> is the position number of the network in the preferred networks list. The
position in the list determines in what order Veeam Plug -in will connect to the specified network. If
you do not chose a specific position in the list, newly added networks take the last place in the list
automatically.

For example:

SapBackintConfigTool --add-preferred-network 172.24.29.189 2

Accessing Preferred Networks

1. Access the Veeam Plug-in for SAP HANA directory /opt/veeam/VeeamPluginforSAPHANA on the
server where Veeam Plug-in is installed.

2. Run Sa pBackintConfigTool with the following parameter:

SapBackintConfigTool --show-preferred-networks

The following example shows what the output of the Sa pBackintConfigTool command with the --show-
preferred-networks parameter can look like:

SapBackintConfigTool --show-preferred-networks
Preferred networks:
1. 172.24.29.156
2. 172.24.26.189

Removing Preferred Networks

1. Access the Veeam Plug-in for SAP HANA directory /opt/veeam/VeeamPluginforSAPHANA on the
server where Veeam Plug-in is installed.

2. Run Ora cleRMANConfigTool with the following parameter:

SapBackintConfigTool --remove-preferred-network <network_IP_address>

where <network_IP_address> can be either the IP address of a single network or a network mask that
contains a range of network addresses. Specify one of the available options that you want to remove from
the preferred networks list.

For example:

SapBackintConfigTool --remove-preferred-network 172.24.29.189

60 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Configuring Performance Throttling
You can limit computer processing (CPU) resources assigned for Veeam Plug -in backup jobs. This setting allows
you to reduce the impact of backup operations on the target computer performance. Performance throttling
prevents Veeam Plug-ins from utilizing all computer resources to ensure that enough resources are provided for
other operations. This maybe useful in case you detected that your s ource database responses are slower during
backup operations.

If you throttle performance, Veeam Backup & Replication starts Veeam Plug -in backup operation processes with
low priority and nice value of 19. The nice values are in ascending order of priority ranging from -20 (the highest
priority) to 19 (the lowest priority). Keep in mind that Veeam Plug -ins manage the priority of backup operation
processes only if the system running on the target computer is busy with other tasks.

NOTE
• By default, Veeam Plug-in does not throttle performance.
• Performance throttling does not apply to restore operations.

To throttle Veeam Plug-in performance, do the following:

1. Log into the machine with a user with root or instance owner privileges.

2. Start the Veeam Plug-in configuration wizard with the following parameter:

SapBackintConfigTool --set-throttling

3. To confirm that you want Veeam Plug-in throttle performance, type y .

All backup activities will be throttled if the system is busy. Backup perf
ormance may be affected. Proceed? (y/N): y

61 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Automating Configuration of Plug-in for SAP
HANA
To automate the configuration of Veeam Plug-in for SAP HANA, do the following:

1. From the /opt/veeam/VeeamPluginforSAPHANA directory on the machine where Veeam Plug-in is

installed, copy the Veeam Plug-in configuration file (veeam_config.xml) to other servers where you
want to configure the plug-in.

2. The password stored in the configuration file is encrypted with a machine key. Thus, on each machine,
after the veeam_config.xml file was copied, you must reset the password of the account used to log in
to the Veeam Backup & Replication server. To reset the password, use the following command. Note that
the operation requires root privileges.

SapBackintConfigTool --set-credentials <"serv\username"> <password>

62 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Upgrading Plug-in for SAP HANA
Periodically, Veeam releases a new version of Veeam Backup & Replication that contains new features and bug
fixes. The release package also contains a new version of Veeam Plug -ins.

If you want to upgrade Veeam Plug-in, note that Veeam Backup & Replication must be the same or later than
the version of Veeam Plug-in. If you want to use the latest functionality, you must upgrade both Veeam Backup
& Replication and Veeam Plug-in to the latest version. After the upgrade, you don't need to re-run the Veeam
Plug-in configuration wizard, the plug-in configuration files will be preserved.

IMP ORTANT

Consider the following:

• You must upgrade Veeam Backup & Replication before you upgrade Veeam Plug -ins. To learn how to
upgrade Veeam Backup & Replication, see the Upgrading to Veeam Backup & Replication 12.3 section
the Veeam Backup & Replication User Guide.

• Veeam Backup & Replication supports two latest versions of Veeam Plug -ins. For example, Veeam
Backup & Replication 12.3 supports Veeam Plug-in 12.3 and 12.2.

Keep in mind that if you use an earlier Veeam Plug-in build than the one that is included in the
installation ISO file of your Veeam Backup & Replication version, it may not have all the features and
bug fixes introduced in your Veeam Backup & Replication version. To learn more about the Veeam
Plug-in builds included in Veeam Backup & Replication installation ISO files, see this Veeam KB
article.

• Operations in the terminal of the Linux machine require root privileges.

• If you want to upgrade Veeam Plug-in for SAP HANA scale-out cluster, repeat the described upgrade
process on all cluster nodes.

Before You Begin

Veeam Plug-in installation files are included in the installation disk image of Veeam Backup & Replication. You
must upload the installation file to the SAP HANA server. To do this, perform the following steps:

1. Mount the Veeam Backup & Replication installation disk

(VeeamBackup&Replication_12.3.0.310_20241201.iso).

2. Open the mounted disk image and go to the Plugins\SAP HANA\x64 directory.

3. Select the Veeam Plug-in installation file and upload it to the SAP HANA server.

The upgrade procedure depends on the type of package that you use:

• Upgrading Plug-in on Linux (.RPM)

• Upgrading Plug-in on Linux (.TAR.GZ)

Upgrading Plug-in on Linux (.RPM)

To upgrade Veeam Plug-in for SAP HANA from the .RPM package, perform the following:

1. Upload the new VeeamPluginforSAPHANA-12.3.0.310-1.x86_64.rpm package to the SAP HANA

server.

63 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 2. Run the following command. Note that the operation requires root privileges.

rpm -U VeeamPluginforSAPHANA-12.3.0.310-1.x86_64.rpm

TIP

To find out which version of Veeam Plug-in is installed on your server, you can use the following
command: rpm -qa | grep VeeamPlugin

Upgrading Plug-in on Linux (.TAR.GZ)

To upgrade Veeam Plug-in for SAP HANA on a Linux machine from the .TAR.GZ archive, do the following:

1. Upload the VeeamPluginforSAPHANA.tar.gz file to the SAP HANA server.

2. In the terminal, open the folder that contains the VeeamPluginforSAPHANA.TAR.GZ archive.

3. Unpack the plug-in files from the archive to the /opt/veeam directory. Old Veeam Plug-in files will be
replaced by new files.

tar -xzvf VeeamPluginforSAPHANA.tar.gz -C /opt/veeam

64 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Importing Backup Files
If the Veeam Backup & Replication server has failed and you have restored it in a new location, you can copy the
backup files to a new repository and re-map the Veeam Plug-in backup files.

Limitations and Prerequisites

Consider the following limitations:

• The repository from which you plan to import backups must be added to the Veeam Backup & Replication
infrastructure. Otherwise you will not be able to access backup files.

• [For imports to the scale-out backup repository] Before importing your backup, consider that the names
of all backup files (.VAB, .VASM, .VACM) and paths to these files contain only the following allow ed
characters:

o a-zA-Z0-9

o _-.+=@^

If your backup was initially created on a standalone backup server, the default name of the backup
metadata file (.VACM) contains forbidden characters. Before importing, you must delete forbidden
characters from the file name or replace them with the allowed characters.

• [For backups of scale-out clusters and servers with the customServerName option] To avoid mapping
failure, the cluster name must be the same as the name used before importing backups.

How to Import Veeam Plug-in Backup Files

To import Veeam Plug-in backup files, do the following:

1. Copy the backup file folder to a backup repository or add a new backup repository with this folder as a
subfolder.

TIP

Each Veeam Plug-in backup .VAB file has its own metadata .VASM file. Make sure that you import
backup files and all related metadata files. Also, you must import the backup job metadata .VACM
file which is stored in the same folder.

2. Log in to the Veeam Backup & Replication console.

3. Open the Ba ckup Infrastructure view.

4. In the inventory pane of the Ba ckup Infrastructure view, select the Ba ckup Repositories node.

65 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 5. In the working area, select the required backup repository and click Rescan on the ribbon. Alternatively,
you can right-click the backup repository and select Rescan.

During the rescan operation, Veeam Backup & Replication gathers information about backups that are
currently available in the backup repository and updates the list of backups in the configuration database.
After the rescan operation, backups that were not in this configuration database will be shown on the
Home view in the Ba ckups > Disk (Imported) node.

6. On the SAP HANA server, set the new repository as a target in the Veeam Plug-in settings:

sudo SapBackintConfigTool --set-repositories

Available backup repositories:
1. serv55.tech.local
2. serv07_repo
Enter repository number: 1
Configuration result:
SID SH2 has been configured

7. Start the Veeam Plug-in configuration wizard with the following parameter:

NOTE

Before you re-map your backup to the repository, make sure that there is not an existing backup job
on your machine with Veeam Plug-in that is targeted at the same repository. If there is such a job,
delete this job from the Veeam Backup & Replication console.

sudo SapBackintConfigTool --map-backup

66 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Upgrading Backup Files
Since version 11, Veeam Plug-in uses a new format of backup files: instead of one metadata file for all backup
files there are separate metadata files (.VASM) for each database backup file (.VAB). The new metadata format
allows Veeam Plug-in to optimize the productivity of backup and restore operations.

IMP ORTANT

For Veeam Backup & Replication 12, backup files created by Veeam Plug-in 10 are not supported. After you
upgrade Veeam Backup & Replication and Veeam Plug -in to the 12 version, you must upgrade the backup
files. After that, you can run your backup jobs. Otherwise, backup jobs will fail.

Prerequisites
Before upgrading backup files, make sure the following requirements are met.

• Make sure that you have upgraded Veeam Plug -in on the source server. If the plug-in is not upgraded to
version 11 or later and you upgrade the backup files, then all next backup job runs will fail.

• Make sure that you have disabled the backup job whose backup files you want upgrade. You must also
disable the backup copy jobs that use these backup files as a source.

• If the backup files reside on the scale-out backup repository, all repository extents must be available.
Also, the extents must not be in the seal or maintenance mode.

• If you want to upgrade backup files created by a backup copy job, you must meet the same requirements
as for the backup job files.

• During the process of the metadata upgrade, you cannot run the target backup job and you cannot restore
from the backup files.

The upgrade process duration depends on the number of backup files in the backup set, type of the
backup repository and workload level on the file system.

For example, there are backup files of the SAP HANA server that contains 10 instances and is backed up
every 15 minutes with the retention policy set for 2 weeks. The upgrade of backup files can have the
following duration on not overloaded file systems:

o Microsoft Windows: 30 minutes

o Linux: from 30 minutes to 3 hours

o SMB/NFS: 1.5 hours

o Data Domain Boost/Quantum DXi/ExaGrid/CIFS (SMB)/NFS file share: 3-4 hours

o HPE StoreOnce: up to 10 hours (due to specifics of this repository type for processing large number of
files)

Upgrading Backup Files in Veeam Backup & Replication

Console
To upgrade backup files in the Veeam Backup & Replication console, do the following:

1. Open the Home view.

2. In the inventory pane, expand the Ba ckups view and select Disk.

67 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 3. In the working area, right-click the job or the restore point and select Up g rade.

Alternatively, you can select the job or the restore point and click Up g rade on the ribbon.

68 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Uninstalling Plug-in for SAP HANA
To uninstall Veeam Plug-in for SAP HANA on a Linux machine, go to the directory with the Veeam Plug-in
package and run the following command. Note that the operation requires root privileges.

rpm -e VeeamPluginforSAPHANA

69 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Database Protection
After you configure Veeam Plug-in, you can back up databases with SAP HANA backup tools. Veeam Plug-in will
automatically transfer data to the Veeam backup repository and store this data in Veeam proprietary format.
The backup process itself is performed by SAP HANA Backint.

Keep in mind that examples in this section are provided only for demonstrating purposes. For details on full
backup functionality of SAP HANA tools, see this SAP article.

IMP ORTANT

Veeam Plug-in transfers backup data to the Veeam backup repository only when you perform the backup
using SAP Backint.

NOTE

Backups created by Veeam Plug-ins cannot be used as a source for file to tape or backup to tape jobs.

To back up SAP HANA databases, you can use SQL commands or SAP HANA administration tools. For details, see
the following subsections:

• Database Backup (HDBSQL Scripts)

• Database Backup (SAP HANA Studio)

• Database Backup (SAP HANA Cockpit)

• Backup Job in Veeam Backup & Replication

70 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Database Backup (HDBSQL Scripts)
After you configure Veeam Plug-in settings, you can use HDBSQL to back up and restore SAP HANA databases.
For details on the HDBSQL backup, see this SAP article.

Prerequisites
Before the backup process, you can use the hdbuserstore tool to set secure storage of SAP HANA connection
details.

To configure hdbuserstore, you must log in to SAP HANA HDBSQL as the operating system administrator
(<sid>adm) and run the following commands. For details, see this SAP article.

sh4adm@linux-q0pn:/usr/sap/SH4/HDB01> hdbuserstore SET <key> hostname:30013@SID

<username> <password>
sh4adm@linux-q0pn:/usr/sap/SH4/HDB01> hdbsql -U <key>

Backing Up SAP HANA Databases Using Backint

To back up the database with Backint, use one of the following commands depending on which type of backup
you want to perform:

• Full backup of a tenant database.

backup data for <TENANT_DATABASE_NAME> using backint ('backup_name_prefix'

);

• Differential backup of a tenant database.

backup data differential for <TENANT_DATABASE_NAME> using backint ('backup

_name_prefix');

• Incremental backup of a tenant database.

backup data incremental for <TENANT_DATABASE_NAME> using backint ('backup_

name_prefix');

• Full backup of a tenant database with the ASYNCHRONOUS option. The ASYNCHRONOUS option can be
helpful if you monitor SAP HANA backups on another host and just want to run the backup command from
a script. The option runs the backup job in the background and closes the current script session.

backup data for <TENANT_DATABASE_NAME> using backint ('backup_name_prefix'

) ASYNCHRONOUS;

71 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 • Full backup of SYSTEMDB.

backup data using backint ('backup_name_prefix');

• Differential backup of SYSTEMDB.

backup data differential using backint ('backup_name_prefix');

• Incremental backup of SYSTEMDB.

backup data incremental using backint ('backup_name_prefix');

72 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Database Backup (SAP HANA Studio)
After you configure Veeam Plug-in settings, you can back up your databases using SAP HANA Studio. Veeam
Plug-in will automatically transform backup files to a Veeam backup repository.

The example provided below is for demonstration purposes only. For details on the full backup functionality of
SAP HANA Studio, see this SAP article.

To perform Backint backup with SAP HANA Studio, do the following:

1. In SAP HANA Studio, connect to the database as a user with DATABASE ADMIN privileges.

2. In the Sy stems view, right-click the database.

3. Select Ba ckup and Recovery and then select Ba ck Up System Database or Ba ck Up Tenant Database.

4. In the backup wizard, specify backup settings:

a. Select the required backup type:

▪ Comp lete Data Backup: backup of all data structures required to recover the database.

▪ Incremental Data Backup: backup of data changed since the last full data backup or the last
delta backup.

▪ Differential Data Backup: backup of data changed since the last full data backup.

b. In the Destination Type list, select Backint. With this option selected, Veeam Plug-in will transfer the
backup file to Veeam backup repository.

c. Change the default backup prefix, if needed.

73 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 d. Click Nex t.

5. In the Review Backup Settings step of the wizard, click Finish to start the backup process.

After you launch the backup process, SAP HANA Studio will back up the database, and Veeam Plug -in will
forward backup files to the backup repository that is specified in the Veeam Plug-in settings.

74 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Database Backup (SAP HANA Cockpit)
After you configure Veeam Plug-in settings, you can back up your databases with SAP HANA Cockpit 2.0. You
can perform complete, incremental, and differential backups of SYSTEMDB and tenant databases. Veeam Plug -
in will automatically transform backup files to Veeam backup repository. Keep in mind that you must select the
Backint option as a destination target.

The example provided below is for demonstrating purposes only. For details on the full backup functionality of
SAP HANA Cockpit, see this SAP article.

To perform Backint backup with SAP HANA Cockpit, do the following:

1. In the Sy stem Overview page, go to Da tabase Administration and select Ma nage Database Backups.

2. At the Ba ckup Catalog section, click Create Backup.

3. Specify backup settings:

a. Select the required backup type:

▪ Comp lete Data Backup: backup of all data structures required to recover the database.

▪ Incremental Data Backup: backup of data changed since the last full data backup or the last
delta backup (incremental or differential).

▪ Differential Data Backup: backup of data changed since the last full data backup.

75 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 b. In the Destination Type setting, select Backint. With this option selected, Veeam Plug-in will transfer
the backup to Veeam backup repository.

c. Change the default prefix for the backup file, if needed.

d. To start the backup, click Ba ck Up.

76 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Backup Job in Veeam Backup & Replication
TIP

If you want to configure or manage an application backup policy for Veeam Plug -in operating in the
managed mode, see Working with Application Policies.

After you start a backup process with SAP HANA Backint, Veeam Backup & Replication creates a backup job. You
can use this job to view the statistics on the backup process, generate backup job reports or you can also disable
the backup job. You cannot launch or edit SAP HANA backup jobs in the Veeam Backup & Replication console.
You can manage backup operations only on the SAP HANA side using SAP HANA Studio, SAP HANA Cockpit or
HDBSQL.

Consider the following regarding the naming of SAP HANA backup jobs:

• For a standalone SAP HANA server (scale-up), Veeam Backup & Replication generates the backup job
name based on names of the SAP HANA server and selected repository.

• For a scale-out SAP HANA cluster: When you run the Veeam Plug-in configuration wizard for the first time
in one of the SAP HANA cluster nodes, the wizard asks for the cluster name. The cluster name will be used
in the backup job name along with the repository name.

NOTE

Due to specifics of the SAP HANA backup process, the progress bar of a running SAP HANA backup job is
not available.

To view details of a backup job process, do the following:

1. Open the Veeam Backup & Replication console.

2. In the Home view, expand the Job s node and click Ap p lication Plug-ins.

77 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 3. In the list of jobs, select the SAP HANA backup job to see details of the current backup process or the last
backup job session.

Generating Backup Job Reports

Veeam Backup & Replication can generate reports with details about an SAP HANA backup job session
performance. The session report contains the following session statistics: session duration details, details of the
session performance, amount of read, processed and transferred data, backup size, compression r atio, list of
warnings and errors (if any).

1. Open the Home view.

2. In the inventory pane, select Job s .

78 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 3. In the working area, select the necessary job and click Rep ort on the ribbon. You can also right-click the
job and select Rep ort.

Disabling Backup Job

You can disable SAP HANA backup jobs in the Veeam Backup & Replication console. If you disable the job, you
will not be able to run SAP Backint backup commands on the SAP HANA server.

To disable a backup job:

1. Open the Home view.

2. In the inventory pane, select Job s .

79 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 3. In the working area, select the necessary job and click Disable on the ribbon. You can also right-click the
job and select Disable.

80 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Database Recovery
With the configured Veeam Plug-in you can restore SAP HANA databases from the ba ckups that reside in the
Veeam backup repository.

To restore databases, you can use SAP HANA Cockpit, SAP HANA Studio or HDBSQL commands. Restore
operations using SAP HANA tools are performed on the SAP HANA side. Keep in mind that examples provided in
this section are for demonstrating purposes only. To see the full restore functionality of SAP HANA tools, see
this SAP article.

You can also use Veeam Explorer for SAP HANA to restore databases. Restore operations in Veeam Explorer for
SAP HANA are performed on the Veeam Backup & Replication side.

To learn how to recover SAP HANA databases from backups stored in Veeam backup repositories, see the
following subsections:

• Restoring Databases (HDBSQL Commands)

• Restoring Databases (SAP HANA Studio)

• Restoring SYSTEMDB (SAP HANA Cockpit)

• Restoring Tenant Databases with SAP HANA Cockpit

• Restore to Another Server (System Copy)

• Restore from Backup Copy

• Restore from Hardened Repository

• Restore with Veeam Explorer for SAP HANA

81 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Restoring Databases (HDBSQL Commands)
You can use HDBSQL to restore SAP HANA databases from backups stored on Veeam backup repositories. For
details on the HDBSQL restore, see this SAP article.

To recover SAP HANA databases from backups stored on Veeam backup repositories, do the following:

1. Log in to SAP HANA HDBSQL as the HDB administrator. Use HDBUSERSTORE to securely store connection
details on a client machine. For details, see this SAP article.

sh4adm@linux-q0pn:/usr/sap/SH4/HDB01> hdbuserstore SET <key> hostname:3001

3@SID <username> <password>
sh4adm@linux-q0pn:/usr/sap/SH4/HDB01> hdbsql -U <key>

2. Recover a tenant database to the latest state using Backint. As the timestamp, specify the current data
and time or future date and time.

alter stop database <DATABASE_NAME>;

recover database for <DATABASE_NAME> until timestamp '2020-01-01 12:00:00'
using catalog backint;

82 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Restoring Databases (SAP HANA Studio)
You can restore SAP HANA databases from the Veeam Plug -in backups using SAP HANA Studio.

The example below is provided for demonstration purposes only. For details on the full restore functionality of
SAP HANA tools, see this SAP article.

To perform a Backint recovery from Veeam Plug-in backups, do the following:

1. Log in to SYSTEMDB as a user with DATABASE ADMIN privileges.

2. Right-click the SYSTEMDB database.

3. Click Ba ckup and Recovery and select Recover System Database or Recover Tenant Database.

4. Enter the operating system user credentials.

5. Recovery process requires the database to be shut down. In the pop -up window, click OK to confirm the
database shutdown.

83 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 6. At the Sp ecify Recovery Type step of the recovery wizard, select the required restore point or the option
to restore the database to the most recent state.

7. At the Loca te Backup Catalog step of the wizard, select one of the following options, depending on where
your backup catalogs reside:

o Sea rch for the backup catalog in the file system only

84 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 o Sea rch for the backup catalog in Backint only

8. Select the required backup to restore.

85 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 9. At the Loca te Log Backups step, click Nex t.

10. At the Other Settings step:

a. Switch on the availability check for the Backint backups.

b. If you are recovering the database to a database with a new SID or landscape ID, select the Install
New License Key check box and specify the path to the license file.

86 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 c. Click Nex t.

11. At the Review Recovery Settings step, click Finish.

87 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Restoring SYSTEMDB (SAP HANA Cockpit)
You can restore SAP HANA SYSTEMDB databases from the Veeam Plug -in backups using SAP HANA Cockpit.

The example below is provided for demonstration purposes only. For details on the full restore functionality of
SAP HANA Cockpit, see this SAP article.

Before You Begin

Before you start the recovery, shut down the database that you want to recov er:

1. In the SAP HANA Cockpit console, locate the database that you want to recover.

2. In the Overall Database Status block, click Stop System.

88 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 3. At the Ma nage Services section, click Stop System and select the Softly option to shut down the database
after SAP HANA finishes running statements.

Performing Recovery
To perform a Backint recovery of SYSTEMDB from a Veeam Plug -in backup, do the following:

1. In the Sy stem Overview block, go to the Da tabase Administration section and click Recover database .

89 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 2. At the Recovery Target step, select the required restore point or the option to restore the database to the
most recent state. Then, click Step 2.

3. Specify the location of the latest backup catalog and click Step 3.

4. At the Ba ckup to be Used step, select the backup and click Step 4.

90 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 5. At the Delta Backups step, select Y es to use delta backups.

6. At the Sp ecify Alternative Backup Locations step, if you want to use backups that are not in the backup
catalog, specify their locations. You can also change the location for log backups.

If you you leave the fields empty, SAP HANA will use the locations specified in the backup catalog.

7. At the Check Availability of Backups step, select Y es or No options, to check if the backups are available.
Note that at this step SAP HANA does not check the integrity of the backup content on the block level.

91 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 8. At the Initialize Log Area step, select No to initialize the log area and click Review. You must initialize the
log area only if the log area is unavailable or if you are recovering the database to a different system.

9. Review the recovery options and click Sta rt Recovery.

92 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Restoring Tenant Databases with SAP HANA
Cockpit
You can restore SAP HANA tenant databases from the Veeam Plug -in backups using SAP HANA Cockpit.

The example below is provided for demonstration purposes only. For details on the full restore functionality of
SAP HANA tools, see this SAP article.

To perform a Backint recovery of an SAP HANA tenant database from a Veeam Plug-in backup, do the following:

1. In the Sy stem Overview page of the required system, click Ma nage Databases.

2. In the Ma nage Databases page, expand the toolbar options and select Recover Tenant.

3. After you launch the recovery wizard, SAP HANA will issue the warning that the database must be stopped
for recovery. Click Stop Tenant in the warning window.

4. At the Recovery Target step of the wizard, select the required restore point and click Step 2.

93 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 5. Specify the location of the latest backup catalog and click Step 3.

6. At the Ba ckup to be Used step, select the backup and click Step 4.

7. At the Delta Backups step, select Y es to use delta backups.

94 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 8. At the Sp ecify Alternative Backup Locations step, if you want to use backups that are not included in the
backup catalog, specify their locations. You can also change the location for log backups.

If you leave the fields empty, SAP HANA will use the locations specified in the backup catalog.

9. Select Y es or No, to check if the backups are available. Note that at this stage SAP HANA does not check
the integrity of the backup content on the block level.

10. Select No to initialize the log area and click Review. You must initialize the log area only if the log area is
unavailable or if you are recovering the database to a different system.

95 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 11. Review the recovery options and click Sta rt Recovery.

96 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Restore to Another Server (System Copy)
You can restore SAP HANA databases from Veeam Plug -in backups to another server. To restore databases to
another server, you must specify an authentication method to access the backup created for the original server
and then select the backup from which you want to restore a database.

Veeam Plug-in supports the following authentication methods to access backups:

• Using credentials of the account under which the backup was created. This option is intended for backups
created using SAP HANA backup tools on the SAP HANA server.

• Using a security certificate. This option is intended for backups created using an application backup policy
configured in Veeam Backup & Replication.

• Using a recovery token. This option is intended for backups created using an application backup policy
configured in Veeam Backup & Replication. To use this option, a backup administrator or a restore
operator must create a recovery token for the backup in Veeam Backup & Replication.

You can select the authentication method explicitly or choose to use the same method that was specified during
the Veeam Plug-in configuration process.

Consider the following:

• For restore to another server, you can use either backups or backup copies of SAP HANA databases.

• If you perform restore from a backup that was imported to Veeam Backup & Replication, Veeam Plug-in
will automatically create the backup job in Veeam Backup & Replication.

• During the restore process, backup operations are not disabled on the SAP HANA server.

NOTE

If you perform a system copy from another database to a database that was previously backed up by
Veeam Plug-in, consider the following:

• If the catalog_backup_using_backint parameter is enabled, after performing a system copy, SAP HANA
automatically starts a new log chain and sends it to the backint along with a new catalog backup.
This new catalog backup overwrites the previous catalog, making it impossible to access pre -restore
backups for this database.

• If you plan to restore the older state of this database, you can disable the
catalog_backup_using_backint parameter before performing the system copy.

• Also, to have access to pre-restore backups, you can store a copy of the old backup catalog outside
the default directory and specify this catalog during the restore.

Restore to Another Server Using Configured Authentication

You can restore a database to another server using an account and authentication method that were specified in
the Veeam Plug-in settings during the Veeam Plug-in configuration process. To do this, do the following:

1. Go to /opt/veeam/VeeamPluginforSAPHANA and run the following command:

VM2ADM:/opt/veeam/VeeamPluginforSAPHANA> SapBackintConfigTool --set-backup

-for-restore

97 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 2. Veeam Plug-in will prompt you to select an authentication method to access the backup. To access the
backup using the authentication method that was specified during the Veeam Plug -in configuration
process, type 1:

Select authentication type or disable the functionality:

0. To disable the functionality
1. Currently set authentication data
2. Credentials
3. Recovery token
Enter authentication type number:
1

3. Veeam Plug-in will display backups available for restore under the user account specified in the Veeam
Plug-in configuration. The list of backups depends on the authentication method specified for the user
account:

o For the user account with a security certificate, Veeam Plug -in displays backups created under this
user account.

o For the user account with credentials, if the account has the Veeam Restore Operator role assigned in
Veeam Backup & Replication, Veeam Plug-in displays all backups that reside in the backup repository.
Otherwise, Veeam Plug-in displays backups created under the specified user account.

o For the user account with a recovery token, Veeam Plug -in displays backups for which the recovery
token was generated.

NOTE

Keep in mind that Veeam Plug-in will list only those backups that were made on machines with the
same architecture as the machine you are working on.

For example, if your machine has a x86_64 architecture, only backups made on machines with the
x86_64 architecture will be displayed.

Select a backup to start the restore process:

Select backup to be used:

1. Backup1
2. Backup2
3. Backup3
Enter backup number: 3
The selected backup [Backup3] will be used for all restore operations.

4. Perform the SAP HANA System Copy based restore following this SAP KB article (requires an SAP ID).

Restore to Another Server Using Credentials

To restore a database to another server, you can specify credentials of a user account under which the backup
was created. To do this, do the following:

1. Go to /opt/veeam/VeeamPluginforSAPHANA and run the following command:

VM2ADM:/opt/veeam/VeeamPluginforSAPHANA> SapBackintConfigTool --set-backup

-for-restore

98 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 2. Veeam Plug-in will prompt you to select an authentication method to access the backup. To access the
backup using credentials of the account under which the backup was created, type 2:

Select authentication type or disable the functionality:

0. To disable the functionality
1. Currently set authentication data
2. Credentials
3. Recovery token
Enter authentication type number:
2

3. Veeam Plug-in will prompt you to provide credentials of the user account that under which the backup
was created. Enter a user name and password of the account:

Enter username:
Enter password for <username>:

4. Veeam Plug-in will display backups available for restore under the specified user account. If the account
has the Veeam Restore Operator role assigned in Veeam Backup & Replication, Veeam Plug -in displays all
backups that reside in the backup repository. Otherwise, Veeam Plug-in displays backups created under
the specified user account.

Select a backup to start the restore process:

Select backup to be used:

1. Backup1
2. Backup2
3. Backup3
Enter backup number: 3
The selected backup [Backup3] will be used for all restore operations.

5. Perform the SAP HANA System Copy based restore following this SAP KB article (requires an SAP ID).

Restore to Another Server Using Recovery Token

You can restore a database to another server using a recovery token generated in Veeam Backup & Replication
and provided to you by a backup administrator or by a restore operator. To do this, do the following:

1. Go to /opt/veeam/VeeamPluginforSAPHANA and run the following command:

VM2ADM:/opt/veeam/VeeamPluginforSAPHANA> SapBackintConfigTool --set-backup

-for-restore

99 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 2. Veeam Plug-in will prompt you to select an authentication method to access the backup. To access the
backup using a recovery token, type 3:

Select authentication type or disable the functionality:

0. To disable the functionality
1. Currently set authentication data
2. Credentials
3. Recovery token
Enter authentication type number:
3

3. Veeam Plug-in will display the fingerprint of the Veeam Backup & Replication server and prompt you to
provide a recovery token:

Veeam Backup & Replication server fingerprint: CA4F820F164C02A9AAC75562FC3

5330A93CDAA3C.
Continue? (y/n) : y
Enter recovery token:

4. Veeam Plug-in will display backups for which the recovery token was generated. Select the necessary
backup:

Select backup to be used:

1. Backup1
2. Backup2
3. Backup3
Enter backup number: 3
The selected backup [Backup3] will be used for all restore operations.

5. Perform the SAP HANA System Copy based restore following this SAP KB article (requires an SAP ID).

100 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Restore from Backup Copy
You can restore SAP HANA databases from backup copies created for Veeam Plug-in for SAP HANA backups. The
procedure of database restore from a backup copy is the same as database restore to another server. For more
information, see Restore to Another Server (System Copy).

101 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Restore from Hardened Repository
As a result of malware activity or unplanned actions, backup job metadata files (.VACM) may become
unavailable in the hardened repository. In this case, to restore data from the hardened repository, you must re -
create the .VACM file. To do this, complete the following steps:

1. Run a Veeam Plug-in backup job to create a new Veeam Plug-in backup in a Veeam backup repository. The
backup will consist of the .VAB, .VASM and .VACM files.

2. In the backup repository folder, replace the .VAB and .VASM files created at the step 1 with the .VAB and
.VASM files from the hardened repository.

3. In the Veeam backup console, run the backup repair operation. Veeam Backup & Replication will generate
a new .VACM file using information from the .VASM files. For details, see Repairing Backup.

Once the backup job metadata file is re-created, you can use Veeam Plug-in to restore your data.

Repairing Backup
If you want to restore data from an immutable backup that resides in a hardened repository, you can use the
Rep air operation. During this operation, Veeam Backup & Replication will generate a new backup job metadata
(.VACM) file using information from the backup metadata (.VASM) files.

IMP ORTANT

This operation is intended only for a situation where the backup job metadata file has been lost as a result
of malware activity or unplanned actions. Re-creation of the backup job metadata file for other purposes is
not supported.

Before you start the repair operation, you must disable the backup job that created the backup. Otherwise,
Veeam Backup & Replication will display a message notifying that the job must be disabled.

To repair a backup:

1. In the Veeam Backup & Replication console, open the Home view.

2. In the inventory pane, select Ba ckups.

3. In the working area, select the necessary backup.

4. Press and hold the [Ctrl] key, right-click the backup and select Rep air.

5. If you plan to restore SAP HANA databases using Veeam Explorer for SAP HANA and your backups reside
on a scale-out backup repository expanded with capacity tier, rescan the backup repository. To learn more
about rescan, see the Rescanning Backup Repositories section in the Veeam Backup & Replication guide.

102 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

103 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310
Restore with Veeam Explorer for SAP HANA
You can restore SAP HANA databases from Veeam Plug -in backups in the Veeam Backup & Replication console.
To restore SAP HANA databases Veeam Backup & Replication uses Veeam Explorer for SAP HANA. For details,
see the SAP HANA Data Restore section of the Veeam Explorers User Guide.

TIP

To perform restore from SAP HANA databases, you can also use Veeam Explorer cmdlets. For details, see
the Veeam Explorer for SAP HANA section of the Veeam Explorers PowerShell Reference.

104 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Retention of SAP HANA Backups
In the main scenario, when using Veeam Plug-in for SAP HANA, you must configure the retention policy using
native SAP HANA tools. For details, see Deleting Backups Using SAP HANA Tools.

Also, you can manually delete backups from a backup repository using the Veeam Backup & Replication console
and enable the force deletion functionality of Veeam Plug -in. For details, see the following sections:

• Deleting Backups Manually Using Veeam Backup & Replication Console

• Configuring Force Deletion of Backups

105 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Deleting Backups Using SAP HANA Tools
To configure retention policies for SAP HANA backups, you can use the SAP HANA housekeeping options:

• Manual Deletion of Backups in SAP HANA Studio

• Configuring Retention Policy in SAP HANA Cockpit

• Deletion of Catalog and Backups Using Scripts

IMP ORTANT

If you delete backups from a backup catalog using scripts or SAP HANA Studio and don't select the option
to delete backup physically from the backup location, backups will remain in the backup repository. In this
case, we recommend to enable the options for physical deletion of backups in used SAP HANA retention
tools or you must enable the force deletion feature of Veeam Plug-in for SAP HANA. Otherwise, you will
run out of space on the backup repository.

Manual Deletion of Backups in SAP HANA Studio

For details, see this SAP article.

To physically delete the backups, you must select the Ca talog and Backup Location option. Note that if you have
physical backups in both the file system and a Veeam backup repository, you can choose to delete data backups
in only one location.

Configuring Retention Policy in SAP HANA Cockpit

For details, see this SAP article. Note that the retention policy functionality is supported only in SAP HANA 2.0
SPS03 and later versions.

When you configure a retention policy in SAP HANA Cockpit, make sure that you have selected the Also d elete
p hy sically from Backint check box in the Op tions for Backup Deletion section. Otherwise the backups will not be
deleted from the repository.

Deletion of Catalog and Backups Using Scripts

Deletion of catalog and backups using scripts. For details see this SAP article.

To physically delete backups from the backup repository, you must include the W ITH BACKINT and WITH FILE
options in the script.

106 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Deleting Backups Manually
In the main scenario, when using Veeam Plug-in for SAP HANA, you must configure the retention policy using
native SAP HANA tools. For details on the SAP HANA housekeeping options, see Deleting Backups Using SAP
HANA Tools.

If you have lost the backup catalog, you can delete the backups manually from Veeam backup repositories using
the Veeam Backup & Replication console.

NOTE

If you remove backups from a backup repository manually, the backup catalog will not be updated.

To remove a backup from a backup repository, do the following:

1. In the Veeam Backup & Replication console, open the Home view.

2. In the Inventory pane, select Ba ckups.

3. In the working area, right-click the backup job object name and select Delete from disk.

107 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Configuring Force Deletion of Backups
In the main scenario, when using Veeam Plug-in for SAP HANA, you must configure the retention policy using
native SAP HANA tools. For details, see Retention of SAP HANA Backups.

Veeam Plug-in for SAP HANA has a functionality that automatically force deletes backup files which are older
than specified number of days. For example, you can use it if a backup repository contains backup files that are
no longer in the backup catalog.

If you use SAP HANA 2.0 SPS 7 and you set Veeam Plug -in for SAP HANA to force delete backup files, consider
that Veeam Plug-in will also delete backups that are flagged by as retained using SAP HANA functionality.

To enable force deletion of backup files, do the following:

1. On the SAP HANA server, run the following command.

SapBackintConfigTool --set-force-delete

2. Enter the number of days after which Veeam Plug-in will force delete backup files on all configured
Veeam backup repositories.

Garbage collector automatically deletes backup files older than the specif
ied number of days.
Make sure the number of days value exceeds your retention policy.
To disable this functionality, set the number of days to 0.
Enter the number of days to delete backups after, between 7 and 999 [0]:

By default, the force delete functionality is disabled (set to 0).

IMP ORTANT
• A value for the numb er of days setting must be at least 1 backup generation period longer than the
retention period for your SAP HANA backups. Otherwise, Veeam Plug -in will delete earliest backups
created within the retention period.
• If a backup repository contains backups older than the specified retention period, Veeam Plug-in
removes old backup files only after the next run of the Backint backup.

• If you use SAP HANA 2.0 SPS 7, Veeam Plug-in will be able to force delete backups that are flagged
as retained. To learn more about the flag, see this SAP article.

108 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Removing Backups from Configuration
If you want to remove records about backups from the Veeam Backup & Replication console and configuration
database, you can use the Remove from configuration operation.

When you remove a backup from the configuration, backup files (.VAB, .VASM) remain on the backup repository.
You can import backup files later and restore data from them.

To remove a backup from configuration:

1. Open the Home view.

2. In the inventory pane, select Ba ckups.

3. In the working area, select the necessary backup.

4. Press and hold the [Ctrl] key, right-click the backup and select Remove from configuration.

109 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Backup Copy for SAP HANA Backups
Having just one backup does not provide the necessary level of safety. The primary backup may get destroyed
together with production data, and you will have no backups from which you can restore data.

To build a successful data protection and disaster recovery plan, it is recommended that you follow the 3 -2-1
rule:

• 3: You must have at least three copies of your data: the original production data and two backups.

• 2: You must use at least two different types of media to store the copies of your data, for example, local
disk and cloud.

• 1: You must keep at least one backup offsite, for example, in the cloud or in a remote site.

Thus, you must have at least two backups and they must be in different locations. If a disaster takes out your
production data and local backup, you can still recover from your offsite backup.

In This Section
• Creating Backup Copy Job

• Converting Backup Copy to Backup

110 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Creating Backup Copy Job
Veeam Backup & Replication offers the backup copy functionality that allows you to create several instances of
the same backup in different locations, whether onsite or offsite. Backup copies have the same format as those
created by backup jobs and you can recover your data from them when you need it.

Veeam Backup & Replication fully automates the backup copy process and lets you specify retention settings to
maintain the desired number of restore points, as well as full backups for archival purposes. Backup copy is a
job-driven process. When enabled, the backup copy job for Veeam Plug -in backups runs continuously. For more
details on how it works, see the Backup Copy section in the Veeam Backup & Replication User Guide.

To copy backups to a secondary location, you must configure a backup copy job. The backup copy job defines
how, where and when to copy backups. One job can be used to process b ackups of one or more machines.

You can configure a job and start it immediately or save the job to start it later.

Before creating a job, check prerequisites. Then use the New Backup Copy Job wizard to configure a backup
copy job.

1. Launch Backup Copy Job wizard.

2. Specify a job name and description.

3. Select backups to process.

4. Define backup copy target.

5. Specify advanced settings.

6. Define backup copy schedule.

7. Finish working with the wizard.

Before You Begin

Before you create a backup copy job, check the prerequisites and limitations:

• Backup infrastructure components that will take part in the backup copy process must be added to the
backup infrastructure and properly configured. These include source and target backup repositories
between which backups must be copied.

• The target backup repository must have enough free space to store copied backups. To receive alerts
about low space on the backup repository, configure global notification settings. For more information,
see Specifying Other Notification Settings.

111 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 1. Launch Backup Copy Job Wizard
To create a backup copy job, do the following:

1. In the Veeam Backup & Replication console, open the Home view.

2. Click the Ba ckup Copy tab and select Ap p lication-level backup.

112 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 2. Specify Job Name and Description
At the Job step of the wizard, specify a name and description for the backup copy job.

1. In the Na me field, enter a name for the job.

2. In the Description field, enter a description for the job. The default description contains information about
the user who created the job, date and time when the job was created.

113 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 3. Select Backups to Process
At the Ob ject step of the wizard, select machines whose backups you want to copy to the target repository.

1. Click the Ad d button and select from which entity you want to process the machines.

o From jobs: You can select Veeam Plug-in backup jobs. When a backup copy job runs, Veeam Backup &
Replication will search for backup files created by selected jobs.

o From repositories: You can select repositories where Veeam Plug-in backups are stored. When a
backup copy job runs, Veeam Backup & Replication will search for backup files created by Veea m
Plug-in in selected repositories.

2. Use the Remove button if you want to remove selected jobs or repositories from processing.

3. If you have added jobs from a repository and want to exclude from processing some of the backup jobs on
the selected repository, click E x clusions and select the jobs that you want to exclude.

114 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 4. Define Backup Copy Target
At the Ta rget step of the wizard, configure the target repository settings.

1. From the Ba ckup repository list, select a backup repository in the target site where copied backups must
be stored. When you select a target backup repository, Veeam Backup & Replication automatically checks
how much free space is available on it. Make sure that you have enough free space to store copied
backups.

IMP ORTANT

For Veeam Plug-in backup copy jobs, you cannot select the following repositories as a backup copy
target:

• Veeam Cloud Connect repository

• Object storage repository

2. If the target repository contains a Veeam Plug-in or MongoDB backup that was excluded from the backup
copy job, and if you don't want to transfer duplicate data, you can use the mapping feature.

After you configure mapping, if some of backup files (.VAB) of the source backup are missing in the target
backup copy, these files are uploaded to the target backup copy.

NOTE

Veeam Plug-in backup copy jobs do not use WAN accelerators.

To map a backup copy job to the backup:

a. Click the Ma p backup link.

b. Point the backup copy job to the backup in the target backup repository. Backups in the target backup
repository can be easily identified by backup job names. To facilitate search, you can use the search
field at the bottom of the window.

I MP ORTANT

Keep in mind that repositories must meet the following requirements:

• Used account must have access to Veeam backup repositories that you plan to use.
• Encryption must be disabled on the repository.

Otherwise, the repositories will not be listed as available. To learn how to configure access
permissions and encryption settings on repositories, see Access Permissions in the Veeam Backup &
Replication User Guide.

115 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 3. You can specify the number of days after which the backup copy will be deleted from the repository. Note
that the countdown starts from the moment when source backup has been created.

116 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 5. Specify Advanced Settings
At the Ta rget step of the wizard, click Ad vanced to configure storage, RPO warning, and notifications settings.

• Storage settings

• RPO warning settings

• Notification settings

Storage Settings
At the Storage tab, define compression and deduplication settings.

By default, Veeam Backup & Replication performs deduplication before storing copied data on the target backup
repository. Deduplication provides a smaller size of the resulting backup file but may reduce the job
performance.

1. You can disable data deduplication. To do this, clear the E na ble inline data deduplication check box.

2. From the Compression level list, choose a compression level to be used: Auto, None, Dedupe-friendly,
Op timal, High or E x treme. The recommended level of compression for backup copy jobs is Auto. In this
case, Veeam Backup & Replication uses compression settings of the copied backup files. For more
information, see Compression and Deduplication.

RPO Warning Settings

At the RP O Monitor tab, specify RPO warning settings.

117 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Enable the W a rn me if backup is not copied within check box and specify the time period in minutes, hours, or
d a ys.

If the backup copy is not created within the specified time period, the backup copy job will finish with the
Warning status. The countdown starts from the moment when the required backup is finished and ready to be
copied.

Notification Settings
At the Notifications tab, to specify notification settings for the backup copy job:

1. At the Ta rget step of the wizard, click Ad vanced.

2. Click the Notifications tab.

3. Select the Send SNMP notifications for this job check box if you want to receive SNMP traps when the job
completes successfully. SNMP traps will be sent if you specify global SNMP settings in Veeam Backup &
Replication and configure software on recipient's machine to receive SNMP traps. For more information,
see Specifying SNMP Settings.

4. Select the Send email notifications to the following recipients check box if you want to receive
notifications by email in case of job failure or success. In the field below, specify a recipient email address.
You can enter several addresses separated by a semicolon.

5. Veeam Backup & Replication sends a consolidated email notifica tion once for the specified backup copy
interval. Even if the synchronization process is started several times within the interval, for example, due
to job retries, only one email notification will be sent.

6. Email notifications will be sent if you configure global email notification settings in Veeam Backup &
Replication. For more information, see Configuring Global Email Notification Settings.

118 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 7. At the Send at field, specify the time when you want to receive notifications. Note that you will receive a
notification on the job status once a day.

8. You can choose to use global notification settings or specify custom notification settings.

o To receive a typical notification for the job, select Use global notification settings. In this case, Veeam
Backup & Replication will apply to the job global email notification settings specified for the backup
server. For more information, see Configuring Global Email Notification Settings.

o To configure a custom notification for a job, select Use custom notification settings specified below.
You can specify the following notification settings:

i. In the Sub ject field, specify a notification subject. You can use the following variables in the
subject: %Time% (completion time), %JobName%, %JobResult%, %VmCount% (number of
machines in the job) and %Issues% (number of machines in the job that have been processed
with the W a rning or Fa iled status).

ii. Select the Notify on success, Notify on warning and Notify on error check boxes to receive email
notification if data processing within the backup copy interval completes successfully, fails or
completes with a warning.

119 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 6. Define Backup Copy Schedule
At the Schedule step of the wizard, define a time span in which the backup copy job must not transport data
between source and target backup repositories. For more information, see Backup Copy Window.

To define a backup window for the backup copy job:

1. Select the During the following time p eriods only option.

2. In the schedule box, select the desired time area.

3. Use the E na ble and Disable options to mark the selected area as allowed or prohibited for the backup copy
job.

120 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Step 7. Review Backup Copy Job Settings
At the Summary step of the wizard, complete the procedure of backup copy job configuration.

1. Review details of the backup copy job.

2. Select the E na ble the job when I click Finish check box if you want to start the job right after you finish
working with the wizard.

3. Click Finish to close the wizard.

121 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Converting Backup Copy to Backup
If you have imported Veeam Plug-in backup copies from another server, you can convert them into regular
backup files. When you convert a backup copy to a backup, Veeam Plug -in creates a backup job with the
converted backup. You can use this backup job to continue a backup chain and use the converted backup as a
restore point.

You can convert and unbind Veeam Plug-in backups into regular Veeam Plug-in backup files in the following
cases:

• If you have deleted a backup copy job which created the backup copy.

• If you have excluded a backup job from a backup copy job that used multiple backup jobs as a source.

• If you imported a Veeam Plug-in backup copy from another host.

NOTE

If you want to restore from a backup copy, you don't need to convert the backup copy to backup. For
details, see Restore from Backup Copy.

Converting Backup Copy to Backup for SAP HANA

To convert a backup copy to a primary backup, use the --p romote-backup-copy-to-primary parameter as shown
below:

SapBackintConfigTool --promote-backup-copy-to-primary
Backup copies available for promotion to primary backup:
1. Backup Copy Job 1\saprhel01-localdomain SAP backint backup (Default Backup R
epository)
Select backup: 1
Promotion of backup copy to a primary backup will reconfigure the plug-in to us
e a different repository. Continue? (y/N): y

IMP ORTANT
[For backups of scale-out clusters and servers with the customServerName option] To avoid failure of
conversion of backup copies, the cluster name must be the same as the name used in the backup copy.

122 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Logs and Support
If you have any questions or issues with Veeam Plug-in for SAP HANA or Veeam Backup & Replication, you can
search for a resolution on Veeam Community Forums or submit a support case on the Veeam Customer Support
Portal.

When you submit a support case, we recommend you attach necessary logs related to Veeam Plug -in
operations.

To learn how to collect logs, see this Veeam KB.

123 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Veeam Plug-in for Oracle RMAN
Veeam Plug-in for Oracle RMAN integrates Oracle Recovery Manager (RMAN) with Veeam Backup & Replication,
enables application consistent backup and recovery operations for Oracle databases, ensuring flexible recovery
options to minimize downtime and maximize data integrity.

124 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Overview
Veeam Backup & Replication offers two options to protect Oracle databases:

• Using Veeam Backup & Replication or Veeam Agent for Oracle Solaris for image -level backups of Oracle
servers.

Veeam Backup & Replication and Veeam Agent for Oracle Solaris perform image-level backup and restore
operations of Oracle servers. For example, this may be useful if you do not have Oracle database
administrators.

To learn how to use Veeam Backup & Replication to protect Oracle servers, see the Creating Backup Jobs
section of the Veeam Backup & Replication User Guide.

To learn how to use Veeam Agent for Oracle Solaris to protect Oracle servers, see the Overview section of
the Veeam Agent for Oracle Solaris User Guide.

• Using Veeam Plug-in for Oracle RMAN for transactionally-consistent Oracle Recovery Manager (RMAN)
based backups of Oracle databases.

Veeam Plug-in uses the backup and restore functionality of RMAN and transfers backups to Veeam backup
repositories. Use Veeam Plug-in to back up Oracle databases in the following cases:

o If you want the Oracle database administrator to fully control the backup and recovery processes.

o If you want to use existing Oracle RMAN scripts or external schedulers.

o If you use Real Applications Clusters (Oracle RAC).

o If you use Automatic Storage Management (Oracle ASM) disks on a physical server.

Veeam Plug-in functions as an agent between Oracle RMAN and the Veeam backup repository. With the
configured Veeam Plug-in, the default backup device type is changed and gives control over backup media
management to Veeam Plug-in. Veeam Plug-in compresses and transfers database backups to a backup
repository connected to Veeam Backup & Replication. For details, see How Veeam Plug-in for Oracle RMAN
Works.

Veeam Plug-in for Oracle RMAN can operate in standalone or managed mode. Depending on the operation
mode, Veeam Plug-in has different functionality and limitations. In standalone mode, you can install Veeam
Plug-in manually on the computer whose databases you want to protect. Veeam Plug-in in standalone mode
uses the Veeam Backup & Replication console to perform backup operations. In managed mode, you can install
Veeam Plug-in using the Veeam Backup & Replication console. The Veeam Backup & Replication console
automates the operation of Veeam Plug-ins running on computers in your infrastructure. For details on Veeam
Plug-in operation modes, see Standalone and Managed Operations Modes.

For backup operations, you can use the built-in Oracle RMAN functionality. Veeam Plug-in for Oracle RMAN
transfers backup data to the Veeam backup repository and stores the data in the Veeam proprietary format for
backups. Veeam Backup & Replication creates a backup job for all backup processes started in Oracle R MAN. Use
this job to view the statistics on the backup process, generate backup job reports or disable the backup job. For
details on backup operations, see Data Backup.

In case of malware activity or unplanned actions, you can perform restore operations based on the backup data
transferred by Veeam Plug-in to the Veeam Backup & Replication backup repositories. Use the built-in Oracle
RMAN functionality or Veeam Explorer for Oracle to restore databases. Restore processes run on the Oracle
side. For details on restore operations with Veeam Plug -in, see Data Restore.

125 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

How Veeam Plug-in for Oracle RMAN Works
Veeam Plug-in functions as an agent between Oracle RMAN and Veeam backup repository.

By default, RMAN sends backups to a native RMAN location on disk ( DEFAULT DEVICE TYPE TO DISK). When
you configure Veeam Plug-in, the default device type is changed to SBT_TAPE, which gives control over backup
media management to Veeam Plug-in. Thus, after you deploy Veeam Plug-in on an Oracle server, you can
perform all backup and restore operations in the Oracle RMAN console. Veeam Plug -in compresses database
backups and transfers them to a backup repository connected to Veeam Backup & Replication.

When use Oracle RMAN integrated with Veeam Plug-in, the database backup is performed in the following way:

1. After you launch a database backup process in the Oracle RMAN console, RMAN launches Veeam Plug -in
services.

2. Veeam Plug-in connects to the Veeam Backup & Replication server and creates a backup job (if it hasn't
been created earlier).

3. Veeam Plug-in starts Veeam Data Movers on the Oracle server and on the Veeam backup repository.
Depending on the configured limit of RMAN channels, there will be multiple connections started in
parallel.

4. Veeam Data Movers transport the backup data to the backup repository.

Multiple Repositories Deployment

Veeam Plug-in allows you to add up to 4 backup repositories. The backup process can be run in multiple
channels. For each channel Veeam Plug-in creates a separate agent process.

126 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Data Backup
Veeam Plug-in for Oracle RMAN transfers backup data to the Veeam backup repository and stores the data in
the Veeam proprietary format for backups.

You can use the built-in Oracle functionality to initiate and manage backup operations. Veeam Backup &
Replication creates a backup job for all backup operations started in Oracle RMAN. Use this job to view the
statistics on the backup process, generate backup job reports or disable the backup job. For details on how to
perform backup operations, see Database Protection.

For each backup operation, Veeam Plug-in automatically creates and stores database backup files. For each of
the created backup files, Veeam Plug-in also creates separate metadata files. The backup and metadata files
help Veeam Plug-ins to store and manage backup data while ensuring that the data is protected, accessible, and
can be quickly restored when needed. All backup files created for backup jobs reside in a dedicated job folder in
the backup repository. For details on backup files, see Veeam Plug-in Backup Files.

Veeam Plug-in allows you to authenticate against Oracle database with the credentials of opera tion system or
database user. For details, see Authentication Against Database

To store backup files, you can add backup repositories to your Veeam Backup & Replication infrastructure. For
details on all supported backup repositories, see Veeam Backup Repositories.

Veeam Plug-in Backup Files

For every backup job within Veeam Backup & Replication, Veeam Plug -in creates and stores database backup
files and separate metadata files for each of the backup files. The backup files provide a consistent and
integrated way for Veeam Plug-ins to store and manage backup data, while ensuring that the data is protected,
accessible and can be quickly restored when needed.

All backup files created by the backup job reside in a dedicated job folder in the backup repository.

Backup Files Format

Veeam Plug-in stores backup files in the following formats:

• A .VAB file stores a compressed copy of an Oracle database. Veeam Plug -in creates .VAB files for full,
incremental and log backups.

• A .VASM file stores metadata that contain information about the backup. A .VASM file is created for each
.VAB backup file with the same name as the backup file. The .VASM files are used by Veeam Backup &
Replication to get data about Veeam Plug-in backups.

• A .VACM file stores metadata about the backup job. A .VACM file is created for each backup job. The
.VACM file is used by Veeam Backup & Replication to get data about Veeam Plug -in backup job.

NOTE

Keep in mind that if you use the scale-out backup repository as a backup target, Veeam Plug -in can create
a backup file for the backed-up database on each repository extent.

127 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Reuse of Backup Files
During backup and restore operations, Veeam Plug -in creates and stores backup files in the Veeam Backup &
Replication backup database. Veeam Plug-in can also reuse backup files by placing multiple backups in a single
.VAB file. This approach helps with optimizing the number of objects in the backup database. Veeam Plug -in
reuses backup files considering the following backup file limits:

• Backup file can contain up to 1000 objects.

• Veeam Plug-in can write data to the created backup file for 24 hours.

After one of the limits is reached, Veeam Plug-in closes the backup file and cannot add new data to this
file. Keep in mind that Veeam Plug-in must close the backup file to allow Veeam Backup & Replication to
perform the following operations:

o Set the immutability for the backup file.

o Copy and move backup file to the capacity tier.

Veeam Backup Repositories

Veeam Plug-ins store backup files in repositories added to the Veeam Backup & Replication infrastructure. In
this section, you can find the list of supported backup repositories and limitations for Veeam Plug -in backups.

Before you start performing operations on backup repositories within the Veeam Backup & Replication
infrastructure, consider that you need to set the access permissions for each repository. For details, see Access
and Encryption Settings on Repositories

Supported Backup Repositories

You can use the following types of repositories added to the Veeam Backup & Replication infrastructure to store
backups created with Veeam Plug-in for Oracle RMAN:

• Windows Server

• Linux Server

• SMB (CIFS) Share

• NFS Share

• Dell Data Domain with Data Domain Boost (DDBoost)

• Fujitsu ETERNUS CS800

• Infinidat InfiniGuard

• HPE StoreOnce
If you plan to use HPE StoreOnce as a backup repository for Veeam Plug -in backups, the total number of
stored files (data and metadata) must not exceed 3,000,000 per Catalyst store. If necessary, multiple
Catalyst stores may be created on the same StoreOnce system.

• Quantum DXi

• ExaGrid

Make sure the repository is configured as described in the ExaGrid section in the Veeam Backup &
Replication User Guide.

128 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 • Hardened Repository

• Scale-Out Backup Repository

Make sure that the performance extents of the scale-out backup repository contain repositories supported
by Veeam Plug-in for Oracle RMAN. For example, you cannot use object storage repositories as
performance extents to keep backups created with Veeam Plug -ins.

Backup Repository Limitations

• For Veeam Plug-in backups, the warning which indicates that free space on a storage device has reached a
specified threshold is configured in the veeam_config.xml file of Veeam Plug-in. The warning settings
in the Veeam Backup & Replication console does not affect this setting.

To configure the warning settings, add the following parameter in the veeam_config.xml file.

<PluginParameters repositoryFreeSpacePercentWarning="10" />

Keep in mind that you must add the parameter to the existing line in the veeam_config.xml file. If you
create a new line with the same name as the existing line, Veeam Plug -in will consider parameters only in
the first detected line. Other parameters will be ignored.

• The plug-in configuration wizard will not show repositories where the E ncrypt backups stored in this
rep ository option is enabled. To learn how to disable the encryption option, see Access and Encryption
Settings on Repositories.

If you want to use the same backup target with the repository-based encryption and Veeam Plug-ins,
create a second repository in the subfolder for Veeam Plug -in backups.

• Veeam extract utility cannot extract Veeam Plug-in backup files. By design of Oracle RMAN, these files
cannot be imported “as files” to RMAN as they contain additional metadata bound to the used SBT device.

• Veeam Plug-ins do not support backup operations targeted directly to object storage repositories.
To learn more about object storage repositories, see the Object Storage Repositories section in the Veeam
Backup & Replication User Guide.

• Veeam Plug-ins do not support backup operations to object storage added as a performance extent of a
scale-out backup repository.

Veeam Scale-Out Backup Repositories

If you want to store Veeam Plug-in backups in scale-out backup repositories, consider the following:

• You cannot rename a scale-out backup repository with Veeam Plug-in backups stored on this repository.

• For Veeam Plug-in backups and backup copies, the Performance policy of a scale-out repository functions
differently:

a. Veeam Backup & Replication checks if there are extents without warning on free space insufficiency.

If there is no extents without the warning, Veeam Backup & Replication uses an extent with the
largest amount of free space that has a free task slot.

129 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 b. For the extents without the warning, Veeam Backup & Replication checks if there are incremental
extents with free task slots.

If there are no incremental extents with free task slots, Veeam Backup & Replication uses a full extent
with the least amount of used task slots.

c. For incremental extents with free task slots, Veeam Backup & Replication sends backup files to an
incremental extent with the least amount of used task slots.

If several extents has the same least amount of used tasks, Veeam Backup & Replication uses an
extent with the largest amount of free space.

To learn more about file placement policies of scale-out repositories, see Backup File Placement section in
the Veeam Backup & Replication User Guide.

• If a scale-out repository is configured in the Data locality policy, repository extents are selected according
to the largest amount of free space for each Oracle RMAN connection. If the selected extent does not
have free task slots, Veeam Backup & Replication uses the extent with the next largest amount of free
space.

If there are two extents with only one task slot on each extent, the backup is performed using two parallel
streams (one stream per extent).

• If you want to add a backup repository which contains Veeam Plug -in backups as an extent to a scale-out
backup repository, you must do the following:

On the Veeam Backup & Replication console side

a. Select Veeam Plug-in backup files that reside in this backup repository and remove them from
configuration.

To learn more, see the Removing Backups from Configuration section in the Veeam Backup &
Replication User Guide.

b. Delete the Veeam Plug-in backup job.

To learn more, see the Disabling and Deleting Jobs section in the Veeam Backup & Replication User
Guide.

c. Add the repository as an extent to the scale-out repository.

To learn more, see the Extending Scale-Out Repositories section in the Veeam Backup & Replication
User Guide.

d. Rescan the scale-out repository.

To learn more, see the Rescanning Scale-Out Repositories section in the Veeam Backup & Replication
User Guide.

NOTE

[For imports to the scale-out backup repository] Before importing your backup, consider that
the names of all backup files (.VAB, .VASM, .VACM) and paths to these files contain only the
following allowed characters:

• a-zA-Z0-9
• _-.+=@^

If your backup was initially created on a standalone backup server, the default name of the
backup metadata file (.VACM) contains forbidden characters. Before importing, you must delete
forbidden characters from the file name or replace them with the allowed characters.

130 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 On the Veeam Plug-in side

e. Set the scale-out repository as the target for backups using the following command:

OracleRMANConfigTool --set-repositories

f. Map the imported backups using the following command:

OracleRMANConfigTool --map-backup

Capacity Tier
You can configure Veeam Backup & Replication to transfer Veeam Plug -in backup files to a capacity tier. Both
policies (Move policy, Copy policy) are supported for Veeam Plug -in backups with the following limitations:

• For Veeam Plug-in backup files, capacity tier does not verify whether data that is being moved is unique
and has not been offloaded earlier. Thus, it is highly recommended to check the pricing plans of your
cloud storage provider to avoid additional costs for offloading and downloading backup data.

• To offload Veeam Plug-in backup files to the capacity tier, Veeam Backup & Replication splits data into 1
MB objects and compresses the resulting objects. The default object size will be a compressed 1 MB block,
resulting in objects of around 512 KB in size.

• Veeam Backup & Replication offloads Veeam Plug-in for Oracle RMAN backup files to the capacity tier
with the Copy and Move policies in different ways. With the Copy policy, Veeam Backup & Replication
checks backup files every 1 hour and runs an offload job only if new backup files exist. With the Move
policy, Veeam Backup & Replication checks backup files every 4 hours and runs an offload job, even if
there are no new files.

IMP ORTANT

With both the Copy and Move policies, Veeam Backup & Replication copies and moves to the
capacity tier only non-active backup files created more than 24 hours ago, which match the capacity
tier configuration parameters. To learn more about the capacity tier configuration, see Add Capacity
Tier in the Veeam Backup & Replication User Guide.

• Veeam Plug-in supports encryption of offloaded data to the capacity tier. The E ncrypt data uploaded to
ob ject storage option in the Ca pacity Tier settings of the scale-out backup repository ensures that the
entire collection of blocks along with the metadata will be encrypted while being offloaded. To learn more
about capacity tier encryption, see the Encryption for Capacity Tier section in the Veeam Backup &
Replication User Guide.

• Capacity tier does not track dependencies of full and incremental Veeam Plug-in backup files. Thus,
consider the following:

o [For the Move policy] When backup files are transferred to the capacity tier, Veeam Backup &
Replication takes into account only the creation time of backup files. Make sure that the operational
restore window is either longer than the whole backup chain cycle period or exceeds that period.
Otherwise, you may encounter the scenario when full backup files are transferred to the capacity tier
and their increment backup files still remain in the performance tier.

131 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 o The capacity tier immutability expiration date does not have the additional block generation period.
The immutability expiration date is based only on the number of days specified in the settings of the
object storage backup repository.

• In case a disaster strikes the scale-out repository and you have a Veeam Plug-in backup file on the capacity
tier, you must re-create the scale-out repository before you restore from this backup file. You must
connect the capacity tier with the Veeam Plug-in backup file to another backup server with Veeam Backup
& Replication and a scale-out repository. After that, you can import the backup files to Veeam Backup &
Replication and then perform data recovery operations.

• If you use a capacity tier that has been created in Veeam Backup & Replication version 10, you cannot
transfer Veeam Plug-in backup files to a capacity tier. However, if you want to transfer them manually, do
the following:

a. If the backup files are created by Veeam Plug-in version 10, upgrade the metadata of backup files as
described in the Upgrading Backup Files section.

b. Run the Set-VBRScaleOutBackupRepository cmdlet with the EnablePluginBackupOffload

parameter to offload backup files to the capacity tier.

Hardened Repository
You can configure Veeam Backup & Replication to transfer Veeam Plug-in backup files to a hardened repository.
The hardened repository helps to protect Veeam Plug -in backup files from loss as a result of malware activity or
unplanned actions. Backup files in the hardened repository become immutable for the time p eriod specified in
the backup repository settings. During this period, backup files stored in the repository cannot be modified or
deleted.

For Veeam Plug-in for Oracle RMAN backups, immutability works according to the following rules:

• Immutability is applied to backup (VAB) files and backup metadata (VASM) files. Backup job metadata
(VACM) files are not immutable.

• Backup files become immutable for the configured time period (minimum 7 days, maximum 9999 days).

• Backup files become immutable after 24 hours have passed since each file was created. The immutability
service runs in the background at every hour. This service detects and sets immutability flags for any
backup file that can no longer be reused.

TIP

Contact Veeam Customer Support to change the default 24 hour lifespan of a backup file. To do that,
you can submit a support case on the Veeam Customer Support Portal.

• The immutability period is not extended for the active backup chain.

Data Restore from Hardened Repository

As a result of malware activity or unplanned actions, backup job metadata (VACM) files may become unavailable
in the hardened repository. In this case, to restore data from the hardened repository, you must re-create the
VACM file. For more information, see Restore from Hardened Repository.

132 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Authentication Against Database
When you configure Veeam Plug-in for Oracle RMAN, you can choose between the operating system
authentication and database authentication methods to connect to the database you plan to back up.

• When you use operating system authentication, you can connect to the server and to the database using
only the OS user credentials.

• When you use database authentication, you can connect to the server using OS user credentials and to the
database using database user credentials.

Veeam Plug-in stores all specified credentials in the Veeam Plug -in configuration file.

NOTE

Consider the following:

• If you select the database authentication method, make sure that the database user account has
SYSBACKUP privileges. This applies for Linux, Unix and Microsoft Windows environments.
• All target databases must be active on the Oracle server. If any of the selected databases are not
active, connection attempts will fail.

For more information on setting authentication methods, see Configuring Plug-in on Linux and Unix or
Configuring Plug-in on Microsoft Windows.

133 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Data Restore
With the configured Veeam Plug-in for Oracle RMAN, you can restore Oracle databases from Veeam Plug -in
backups that reside on Veeam backup repositories.

You can use the built-in Oracle functionality or Veeam Explorer for Oracle to restore databases. Restore
operations are performed on the Oracle side.

TIP

For details on how to use Veeam Explorer for Oracle for restore operations, see the Restoring Oracle RMAN
Backups section of the Veeam Explorers User Guide.

Depending on the available type of Veeam Plug -in backups that will be the source for the restored databases,
you can perform the following restore operations:

• Restoring from backup.

Restore Oracle databases from a Veeam Plug-in backup to the original server by using the built-in Oracle
functionality. For details, see Restore to Original Server.

You can also restore Oracle databases from a Veeam Plug -in backup to another server. For details, see
Restore to Another Server.

• Restoring from a backup copy.

Restore Oracle databases from backup copies created for Veeam Plug-in for Oracle RMAN backups. For
details, see Restore from Backup Copy.

Depending on the location of Veeam Plug-in backups that will be the source for the restored databases, you can
also perform the following restore operations:

• Restoring a control file from autobackup.

Restore the Oracle database control file if you want to restore the database to a new location where the
control file does not exist, or if the database control file is lost or corrupted. For details, see Restore of
Control File from Autobackup.

• Restoring from hardened repositories.

Restore Oracle databases from hardened repositories by creating new backup job metadata files (.VACM)
with data from available backup metadata files (.VASM). For details, see Restore from Hardened
Repository.

134 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Planning and Preparation
Before you start to use Veeam Plug-in for Oracle RMAN, read the environment planning recommendations and
make sure that your environment meets system requirements.

In This Section
• System Requirements

• Permissions

• Ports

• Licensing

• Veeam Environment Planning

• Oracle Environment Planning

135 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

System Requirements
Before you start using Veeam Plug-in for Oracle RMAN, make sure the following requirements are met.

NOTE

The following system requirements apply to Veeam Plug -in for Oracle RMAN
operating in the standalone mode.

For more information on system requirements for Veeam Plug -in managed by Veeam
Backup & Replication, see System Requirements for Managed Veeam Plug-ins.

Sp ecification Requirement

OS Veeam Plug-in for Oracle RMAN is supported for the following Microsoft Windows
versions:
• Microsoft Windows Server 2025
• Microsoft Windows Server 2022
• Microsoft Windows Server 2019
• Microsoft Windows Server 2016
• Microsoft Windows Server 2012/2012 R2

Veeam Plug-in for Oracle RMAN is supported for the following Linux distributions:

• SUSE Linux Enterprise Server 11, 12, 15 (x86 and x86_64)

• RHEL 6.4 – 9.x (x86 and x86_64)
• Oracle Linux 6.2 (x86 and x86_64)
• Oracle Linux 6.4 – 9.x (x86 and x86_64)
• CentOS 6.4 – 8.x (x86 and x86_64): For non-production environments, as it is
not officially supported by Oracle for their databases.

Veeam Plug-in for Oracle RMAN is supported for the following Unix versions:

• Oracle Solaris 10, 11 (x86_64, SPARC)

• IBM AIX 6.1, 7.1, 7.2, 7.3

Software [For Microsoft Windows computers] Microsoft .NET Framework 4.6 is included in the
Veeam Plug-in for Oracle RMAN Redistributable. During the deployment process,
Veeam Backup & Replication checks whether Microsoft .NET Framework 4.6 is
available on the target computer. If Microsoft .NET Framework 4.6 is missing, Veeam
Backup & Replication will install missing software automatically.

136 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 NOTE

Ora cle database Veeam Plug-in for Oracle RMAN supports the following Oracle Database versions:

• 11gR2
• 12c
• 18c
• 19c
• 21c: Standard and Enterprise Edition
• 23c: Standard and Enterprise Edition

Notes:

• Oracle Express Edition (XE) is not supported.

• Oracle databases residing in OS-level containerized environments (for example:
Docker, Podman) are not supported.

Sup ported Oracle Veeam Plug-in for Oracle RMAN supports the following Oracle RMAN features:
RMAN features
• Veeam Plug-in for Oracle RMAN will be registered as an SBT_TAPE device. All
Oracle RMAN functionality that is supported with the SBT_TAPE device type
will work. For example, Automatic Storage Management (Oracle ASM) and
Container DBs (CDBs).
• Veeam Plug-in for Oracle RMAN supports Oracle Real Application Clusters
(Oracle RAC). Other cluster databases are not supported.

Veeam Backup & Veeam Backup & Replication supports two latest versions of Veeam Plug -ins. For
Rep lication example, Veeam Backup & Replication 12.3 supports Veeam Plug -in 12.3 and 12.2.

Keep in mind that if you use an earlier Veeam Plug-in build than the one that is
included in the installation ISO file of your Veeam Backup & Replication version, it may
not have all the features and bug fixes introduced in your Veeam Backup & Replication
version. To learn more about the Veeam Plug-in builds included in Veeam Backup &
Replication installation ISO files, see this Veeam KB article.

Network Veeam Plug-in should be able to establish a direct IP connection to the Veeam Backup
& Replication server. Thus, Veeam Plug-in cannot work with the Veeam Backup &
Replication server that is located behind the NAT gateway.

137 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Permissions
This table contains the list of operations that require specific user account permissions.

NOTE

If you plan to restore Oracle databases using Veeam Explorer for Oracle, consider the required permissions
listed in the Permissions section of Veeam Explorers User Guide.

Op eration Required Roles and Permissions

Configuring Veeam The OS user account used for configuring Veeam Plug-in must have the following
Plug-in permissions.
• For Linux and Unix:

To configure Veeam Plug-in on a Linux or Unix machine, use an account

which is a member of the OSDBA (typically called as “dba”) group and has
SYSDBA privileges.

• For Microsoft Windows:

To configure Veeam Plug-in on a Microsoft Windows machine, use an

account which is a member of the ORA_DBA group and has SYSDBA
privileges.

138 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 NOTE

Performing backup The account used for starting Oracle RMAN backup and restore processes Veeam
and restore in Veeam Plug-in must have the following permissions.
Plug-in
• For Linux and Unix:

To launch RMAN backup or restore, you can use any user account that has
required set of privileges for backup operations on the Oracle side. Starting
from Oracle Database 12c, Oracle recommends to use the SYSBACKUP role.
For details, see this Oracle article.

During the backup process, Veeam Plug-in connects to the database to get
database properties. Thus, Linux/Unix user that started the RMAN client
must be a member of the OSDBA (typically called as “dba”) group and has
SYSDBA privileges.

IMP ORTANT: In case you use the operating system authentication method, if
you use the CONNECT command in the RMAN script, the plug -in manager
process will be started by the owner of the Oracle listener, not by the user
that started the RMAN client. Thus, if the listener is owned by a cluster
service user (grid) that is not a member of the OSDBA group and does not
have SYSDBA privileges, the plug-in manager will not be able to collect
database properties and the backup will fail. As a workaround, you can add
DBA privileges to the grid user.

The workaround is not required in case you use the database authentication
method.

• For Microsoft Windows:

To launch RMAN backup or restore, you can use any user account that has
required set of privileges for backup operations on the Oracle side. Starting
from Oracle Database 12c, Oracle recommends to use the SYSBACKUP role.
For details, see this Oracle article.

During the backup process, Veeam Plug-in connects to the database to get
database properties. Thus, the Oracle home user must be a member of the
ORA_DBA group and the OS authentication must be enabled for this user.

Connecting to Veeam The account which is used to authenticate against Veeam Backup & Replication
Backup & Replication, must have access permissions on required Veeam repository servers. To learn how
managing backups to configure permissions on repositories, see Access and Encryption Settings on
Repositories.

To work with backups created by Veeam Plug-in, you can use only the account used
for creating the backup. If you want to use another account, assign the Veeam
Backup Administrator role or Veeam Backup Operator and Veeam Restore Operator
roles to the account. To learn how to assign Veeam Backup & Replication roles, see
the Users and Roles section in the Veeam Backup & Replication User Guide.

139 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Ports
To enable proper work of Veeam Plug-ins, make sure that the following ports are open.

Oracle Database Server

The following table describes network ports that must be opened to ensure proper communication of the Oracle
server and backup infrastructure components.

From To P rotocol P ort Notes

Default port used for communication with

Veeam the Veeam Backup & Replication server.
Backup & Note that data between Veeam Plug-ins
TCP 10006
Replication and backup repositories is transferred
server directly, bypassing the Veeam Backup &
Replication server.
Oracle
server
Backup
where Default range of ports used as data
repository
Veeam 2500 to transmission channels. For every TCP
server or TCP
Plug-in is 3300** connection that a backup process uses,
gateway
installed one port from this range is assigned.
server*

Local connections between Veeam Plug-in

6791+, and source Data Movers.
Oracle server
TCP 2500 to
(localhost) If port 6791 is occupied, the succeeding
3300**
port numbers will be used.

* For NFS share, SMB share repositories, and Dell Data Domain, HPE StoreOnce deduplication storage appliances, Veeam
Backup & Replication uses an auxiliary backup infrastructure component — gateway server. For details, see the Gateway
Server section in the Veeam Backup & Replication User Guide.
** This range of ports applies to newly added backup infrastructure components. If you upgrade to Veeam Backup &
Replication 10.0 from earlier versions of the product, the range of ports from 2500 to 5000 applies to the already added
components.

Backup Repositories and Gateway Servers

Depending on the type of backup repositories that you use for Veeam Plug -in backups, the following ports must
be open to allow communication between backup infrastructure components.

From To P rotocol P ort Notes

Backup
Veeam Default range of ports used as data
repository
Backup & 2500 to transmission channels. For every TCP
server or TCP
Replication 3300** connection that a backup process uses,
gateway
server one port from this range is assigned.
server*

140 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 From To P rotocol P ort Notes

Direct Attached Storage

Linux server
used as a
Port used as a control channel from the
backup
TCP 22 Veeam Plug-in server to the target Linux
repository or
host.
gateway
server
Veeam
Backup &
Replication Microsoft Ports used as a management channel from
TCP 135,
server Windows the Veeam Plug-in server to the
137 to 139,
server used UDP Repository/Gateway server. Also, the ports
445
as a backup are used to deploy Veeam components.
repository or
gateway 6160, Default ports used by the Veeam Installer
server TCP
6162 Service and Veeam Data Mover Service

Network Attached Storage

Gateway Default port used by SMB transport

TCP 445
server protocol.

(specified in
the SMB SMB server SMB/Netbios name resolution for SMB
TCP 135, protocol (needed in some cases). For
share
repository UDP 137 to 139 details, see the Used Ports section in the
settings) Veeam Backup & Replication User Guide.

Gateway
server

(specified in TCP Standard NFS ports used as a transmission

111,
the NFS NFS server channel from the gateway server to the
UDP 2049
share target NFS share.
repository
settings)

Dell Data Domain

Veeam Port used to assign a random port for the

Backup & Dell Data mountd service used by NFS and
TCP 111
Replication Domain DDBOOST. Mountd service port can be
server statically assigned.

141 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 From To P rotocol P ort Notes

or For more
Gateway Main port used by NFS. To change the
information,
server port, you can use the nfs set server-
see this Dell TCP 2049
port command. Note that the command
KB article.
requires SE mode.

Main port used by NFS MOUNTD. To

change the port, you can use the nfs set
TCP 2052
mountd-port command. Note that the
command requires SE mode.

HP E StoreOnce

Veeam Default command port used for

9387
Backup & communication with HPE StoreOnce.
Replication
HPE
server TCP
StoreOnce
or Default data port used for communication
Gateway 9388
with HPE StoreOnce.
server

E x aGrid

Veeam
Backup & Default command port used for
ExaGrid TCP 22
Replication communication with ExaGrid.
server

Qua ntum DXi

Veeam
Backup & Default command port used for
Quantum DXi TCP 22
Replication communication with Quantum DXi.
server

Fujitsu ETERNUS CS800

Veeam
Fujitsu Default command port used for
Backup &
ETERNUS TCP 22 communication with Fujitsu ETERNUS
Replication
CS800 CS800.
server

Infinidat InfiniGuard

142 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 From To P rotocol P ort Notes

Veeam
Backup & Infinidat Default command port used for
TCP 22
Replication InfiniGuard communication with Infinidat InfiniGuard.
server

* For NFS share, SMB share repositories, and Dell Data Domain, HPE StoreOnce deduplication storage appliances, Veeam
Backup & Replication uses an auxiliary backup infrastructure component — gateway server. For details, see the Gateway
Server section in the Veeam Backup & Replication User Guide.
** This range of ports applies to newly added backup infrastructure components. If you upgrade to Veeam Backup &
Replication 10.0 from earlier versions of the product, the range of ports from 2500 to 5000 applies to the already added
components.

For detailed list of ports used by Veeam Backup & Replication server and backup repositories, see the Used Ports
section in the Veeam Backup & Replication User Guide.

143 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Licensing
To use the Veeam Plug-in functionality, you must have a valid Veeam Backup & Replication license. Licenses are
installed and managed on the Veeam Backup & Replication server that is connected to the Veeam Plug -in server.
If the license is not valid or out of resources, Veeam Plug -in backup jobs fail.

This guide provides information only on specifics of Veeam licenses for Veeam Plug-ins. For terminology and
general information about Veeam Licensing, see Veeam Licensing Policy.

Licensed Objects
An Oracle server is assumed protected if it has been processed by a Veeam P lug-in backup job in the last 31
days.

If you are using any instance-based (Veeam Universal Licensing) license on your Veeam Backup & Replication,
you don't need to install any additional licenses. A protected Oracle server consumes one instance unit from the
license. Oracle servers processed by backup copy jobs are not regarded as protected VMs, these types of jobs
provide an additional protection level for VMs that are already protected with Veeam Plug-in backup jobs.

A machine protected by both Veeam Plug-in and Veeam Backup & Replication will consume a license only once.
For example, you have an Oracle server that you back up using Veeam Plug -in. You also back up this server using
image-level backup functionality of Veeam Backup & Replication. In this case, only one license will be
consumed.

NOTE

[For Perpetual per-socket licenses] If you are using a legacy perpetual per-socket license, a license is
required for each hypervisor CPU socket occupied by protected Oracle servers.

A socket is consumed from the license only if the hypervisor where protected servers reside is added to the
Veeam Backup & Replication infrastructure. If the hypervisor is not added to the Veeam Backup &
Replication infrastructure, an instance unit will be consumed from the license. To learn how to add a
hypervisor to the Veeam Backup & Replication infrastructure, see the Virtualization Servers and Hosts
section in the Veeam Backup & Replication User Guide.

IMP ORTANT

[For Oracle RAC] The license is required for all cluster nodes, even if Veeam Plug -in is installed only on one
of the nodes.

Supported License Types

You can use Veeam Plug-ins with the following license types and packages. Note that this guide contains
information on specifics of Veeam license packages only for Veeam Plug -ins. For the full list of license packages,
see this Veeam webpage.

• For Veeam Universal license:

You can use Veeam Plug-ins with all license packages ( Veeam Backup Essentials, Veeam Backup &
Replication, Veeam Availability Suite ).
Note that if you use the Rental license type, functionality of Veeam Plug-ins is supported only for the
Enterprise Plus edition of Veeam Backup & Replication.

144 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 • For Socket license:

Functionality of Veeam Plug-ins is supported only for the Enterprise Plus edition of Veeam Backup &
Replication.

Obtaining and Managing Licenses

To learn how to install a license and monitor licensed objects, see the Licensing section in the Veeam Backup &
Replication User Guide.

145 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Veeam Environment Planning
Before you deploy Veeam Plug-in, keep in mind the following requirements and limitations.

• Hosting Environments

• RMAN Channels and Resource Consumption

• Veeam Backup Job Name

For more information about Veeam Backup & Replication backup jobs, see Backup Job in Veeam Backup &
Replication.

Hosting Environments and Backup Job Names

By default, for standalone servers, Veeam Plug-in uses the Oracle server hostname to create the name for the
Veeam Backup & Replication backup job and backup folder. In some cases, different standalone servers can have
the same hostname in multiple environments. The procedure below describes how to differentiate between
standalone server names.

Keep in mind that for servers in Oracle RAC environments, Veeam Backup & Replication generates the backu p
job name based on the single client access name (SCAN) of the cluster. For more information about backup job
naming methods, see Veeam Backup Job Name.

To identify standalone servers, update the Veeam configuration XML file as follows:

1. Open the Veeam configuration XML file. The path to the file differs depending on the OS of the machine
where Veeam Plug-in is installed:

o On machines running Linux or Unix OS:

/opt/veeam/VeeamPluginforOracleRMAN/veeam_config.xml

o On machines running Windows OS:

%PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN\veeam_config.xml

2. Add one of the following parameters to the <PluginParameters /> line in the Veeam configuration
XML file:

o The customServerName parameter:

<PluginParameters customServerName="<hostname.domain.tld>" />

where <hostname.domain.tld> is a custom name of the server.

After adding this parameter, Veeam Plug-in will use the specified custom name of the server to name
the backup job and backup folder.

For example:

<PluginParameters customServerName="srv01.tech.local" />

o The useFQDNInServerName parameter:

<PluginParameters useFQDNInServerName="true" />

146 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 After adding this parameter, Veeam Plug-in will use the fully qualified domain name (FQDN) of the
server to name the backup job and backup folder.

Keep in mind that you must add the parameters to the existing line in the veeam_config.xml file. If you
create a new line with the same name as the existing line, Veeam Plug -in will consider parameters only in
the first detected line. Other parameters will be ignored.

IMP ORTANT

For security reasons, it is recommended to use separate repositories for different customers and limit the
Veeam Repository Authentication to the specific customer.

Network Traffic Encryption

Veeam Plug-in supports network traffic encryption rules set on the Veeam Backup & Replication side. By
default, Veeam Plug-in automatically applies the traffic encryption rules. To decrease the processing load on
the database server, you can disable network traffic encryption by ignoring the rules set on the Veeam Backup &
Replication side.

To ignore network traffic encryption rules, do the following:

1. Locate the Veeam configuration XML file. The path to the file differs depending on the OS of the machine
where Veeam Plug-in is installed:

o On machines running Linux or Unix OS:

/opt/veeam/VeeamPluginforOracleRMAN/veeam_config.xml

o On machines running Windows OS:

%PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN\veeam_config.xml

2. Add the following parameter to the Veeam configuration XML file:

<IgnoreVBRNetworkRules=true />

To learn more about traffic encryption, see the Enabling Traffic Encryption section in the Veeam Backup &
Replication User Guide.

Veeam Backup Job Name

Consider the following:

• On the Veeam Backup & Replication server, the backup job name will be created automatically based on
the server or cluster name and selected repository.

• For environments that use Oracle RMAN copy processing, one job per repository is created.

RMAN Channels and Resource Consumption

Any parallel channel started by RMAN will use one Veeam backup repository task slot. By design, Oracle
Standard Edition can work with one channel. Oracle Enterprise Edition has the option to use multiple channels
and you can configure them in the Veeam Plug-in configuration wizard or at the ALLOCATE CHANNEL definition
in RMAN scripts. It is recommended to carefully plan repository task slots, so that Oracle RMAN can work with
multiple channels in parallel when configured.

147 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

The following hardware resources are recommended based on tests on Skylake processors:

• Ora cle server: 1 CPU core and a minimum of 200 MB of RAM per currently used channel. Note that
resource consumption on the Oracle server depends on hardware and Oracle settings.

• Ba ckup repository server: 1 CPU core and 1 GB of RAM per 5 currently used channels.

These resources are recommended only if you use a dedicated backup repository for Veeam Plug -in
backups. If you use the same backup repository for Veeam Plug -in backups and backups created by Veeam
Backup & Replication or Veeam Agents, consider adding the mentioned above hardware resources based
on usual load on your backup repository. For details on hardware requirements for a backup repository,
see the System Requirements section of the Veeam Backup & Replication User Guide.

We recommend to contact your Veeam system engineer to optimize the channel settings and resource
allocation. Also, consider the following:

o It is recommended to use a separate backup repository for Veeam Plug -in backups.

o The control file does not use a repository task slot and will be processed even if there are no free task
slots.

• Veeam Backup & Replication server: during manual metadata operations such as import of backup files,
the Veeam Backup & Replication server needs additional 15 GB of RAM per 1 million files located in the
same backup job folder.

148 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Oracle Environment Planning
Before you deploy Veeam Plug-in, consider the following requirements and limitations.

Installation Prerequisites
On machines running Linux or Unix OS, consider the following prerequisites:

• Before you install Veeam Plug-in, make sure that the /opt/veeam directory is writable.

• Before you configure Veeam Plug-in, make sure that the NOEXEC mount option is disabled for the /var
and /tmp directories.

Scheduling
You can schedule backup processes with all Oracle RMAN relevant scheduling options like Cron, Windows Task
Scheduler, UC4 and TWS.

If you use Veeam Backup & Replication or Veeam Agents to create image-level backups of the Oracle server, you
can schedule the backup job and run Oracle RMAN backup scripts along with the backup job. For detailed
instructions on how to add Oracle RMAN scripts to a backup job, see one of the following guides:

• For Veeam Backup & Replication: Pre-Freeze and Post-Thaw Scripts section in the Veeam Backup &
Replication User Guide.

• For Veeam Agent for Windows: Pre-Freeze and Post-Thaw Scripts section of the Veeam Agent for
Windows User Guide.

• For Veeam Agent for Linux: Pre-Freeze and Post-Thaw Scripts section of the Veeam Agent for Linux User
Guide.

NOTE

If you want to use Oracle RMAN scripts within backup jobs of Veeam Backup & Replication or Veeam
Agents, consider the following:

• A backup job does not control the workflow of Oracle RMAN scripts. The backup job invokes the
script and gets an exit status when the script is finished. Backup job logs show if the script was
executed successfully. The script is considered to be executed successfully if the return is "0". To see
if the script failed, configure the script to return the exit status different than "0" in case of any
errors.

• The default timeout for a custom script in a backup job is 10 minutes. If the script runs longer than
the default time, consider submitting a support case on the Veeam Customer Support Portal.

Oracle Temporary Tablespace

Veeam Plug-in runs SQL queries on the Oracle database to collect statistical information about the RMAN job
processes. Based on availability of hardware resources, the Oracle server uses an allocated Or acle Temporary
Tablespace to store the SQL queries.

To avoid lack of storage in the temporary tablespace, configure the Oracle Temporary Tablespace resources. For
more information about creating and managing tablespaces, see this Oracle article.

149 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Oracle RAC
For Oracle Real Application Clusters (RAC) environments, consider the following:

• It is recommended to install Veeam Plug-in for Oracle RMAN on each RAC server that is responsible for the
backup operations. If the plug-in is not installed on all nodes, the backup process may fail when RMAN
selects another node.

• Veeam Plug-in supports parallel execution of all operations supported by Oracle RMAN: backup, restore,
crosscheck, remove. This applies to execution of these commands on one or multiple databases residing
on one or multiple RAC nodes.

• If you use Veeam Explorer for Oracle to restore a RAC database with different settings, it will not be
restored as a cluster database, but as a standalone database. For more information about Oracle settings,
see Specifying Oracle Settings in the Veeam Explorers user guide.

Oracle Backup Encryption

The Oracle Secure Backup SBT library supports RMAN encrypted backups. Veeam Plug -in does not support
encrypted backups of Oracle databases.

If the backup encryption is enabled, Veeam Plug-in backup jobs fail with the following error: ORA-19919:
encrypted backups to tertiary storage require Oracle Secure Backup. For more information
about how you can disable the backup encryption to avoid this error, see this Oracle article.

Alternatively, you can use transparent data encryption (TDE) provided by Oracle. Using TDE, you can encry pt
database data with an encryption key, back up encrypted data with Veeam Plug -in, then restore data with
Veeam Plug-in and decrypt using the same encryption key. Restore with Veeam Explorer for Oracle is not
supported for this scenario. To learn more about Oracle TDE encryption, see this Oracle article.

Naming of Database Files

Veeam Plug-in for Oracle RMAN does not support non-printable ASCII charset symbols that have decimal values
from 0 through 31, and 127 in ASCII table. If Veeam Plug -in processes a database file with one of the mentioned
symbols, the backup operation finishes with an error.

Naming of Backup File

During backup and restore operations, Veeam Plug -in uses the repositoryID parameter from the Veeam
Plug-in configuration file. In the Veeam Plug-in configuration file, the repository ID is stored in the following
format: repositoryID=“xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx”.

By default, Veeam Plug-in uses the following format for backup files naming:

CONFIGURE CHANNEL DEVICE TYPE SBT_TAPE PARMS 'SBT_LIBRARY=/opt/veeam/VeeamPlugi

nforOracleRMAN/libOracleRMANPlugin.so' FORMAT 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx
xxxx/RMAN_%I_%d_%T_%U.vab';
CONFIGURE CONTROLFILE AUTOBACKUP FORMAT FOR DEVICE TYPE SBT_TAPE TO '%F_RMAN_AU
TOBACKUP.vab';

150 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Before selecting multiple backup repositories for naming, consider the following:

• If you select multiple Veeam backup repositories and enable RMAN copy processing, you must use the
repository ID with the “/” sign as a prefix for the backup file names. This allows RMAN to directly access
the requested backup file on one of the copy extents.

• If you select multiple Veeam backup repositories and disable RMAN copy processing, backup files will be
read by default from the first selected repository.

IMP ORTANT

In a backup file name, you cannot use the following symbols, which are reserved by Microsoft Windows:

• <
• >
• :
• ,
• /
• \
• |
• ?
• *

To learn more about file naming conventions, see this Microsoft article.

Backup of Control File and SPFILE

If you set CONFIGURE CONTROLFILE AUTOBACKUP option to ON, after you run the BACKUP command, RMAN
will automatically create a control file and an SPFILE backup. For details about backing up the RMAN control
file, see this Oracle article.

Controlfile Autobackup File Naming

When using the CONTROLFILE AUTOBACKUP option, consider the following for autobackup files naming:

• If you perform a restore operation with Veeam Explorer for Oracle using a different database name and
database settings, you must enable the autobackup of the control file.

If you use the CONTROLFILE AUTOBACKUP option, the Veeam Plug -in configuration wizard creates the
following RMAN configuration entry:

CONFIGURE CONTROLFILE AUTOBACKUP FORMAT FOR DEVICE TYPE SBT_TAPE TO '%F_RM

AN_AUTOBACKUP.vab';

• If after configuring Veeam Plug-in you enable the CONTROLFILE AUTOBACKUP option, you must start the
configuration wizard again. The control file backup naming option will be set to default.

151 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 • If you enable the CONTROLFILE AUTOBACKUP option in a standalone server or an Oracle RAC
environment, RMAN will create autobackup files with the same names for databases with the same
database ID (DBID). This can cause Veeam Plug-in operation errors.

To avoid errors, you must provide unique names for individual databases. See the following example about
how to add a unique identifier to the database using the db_unique_name parameter.

CONFIGURE CONTROLFILE AUTOBACKUP FORMAT FOR DEVICE TYPE SBT_TAPE TO '%F_OR

CLUNIQNAME_RMAN_AUTOBACKUP.vab';

Parallel Processing
Veeam Plug-in supports parallel backup processing for up to 4 backup repositories or scale -out backup
repositories. In the plug-in configuration wizard, if you select more than one repository, the parallelism
functionality will be enabled automatically.

NOTE

The use of RMAN parallel procesing must be enabled for the running Oracle Enterprise Edition.

Additional Files to Back Up

Veeam Plug-in creates backups of databases and logs. Apart from these files,

Oracle Home
• It is recommended to back up the Oracle home folder in addition to RMAN backups. You can back it up
with Veeam Backup & Replication or Veeam Agents.

• If the Oracle home folder is on a shared disk, you can use the file-level backup functionality of Veeam
Backup & Replication or Veeam Agent for Linux. Alternatively, you can copy the Oracle home folder to a
non-shared disk before the backup.

Oracle Recovery Catalog

You can back up the Oracle Recovery Catalog with Veeam Plug -in on the Recovery Catalog server according to
the Oracle procedures. For details, see this Oracle article.

Veeam Plug-in for RMAN Configuration File

You can back up the Veeam Plug-in configuration file. The file is located in the following directories:

• [Linux or Unix]: /opt/veeam/VeeamPluginforOracleRMAN/veeam_config.xml

• [Windows]: %PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN\veeam_config.xml

NOTE

You can also create an image-level backup of the Oracle server using the image-level backup functionality
of Veeam Backup & Replication or Veeam Agents.

152 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Disabling Veeam Explorer Processing
You can disable Veeam Explorer for Oracle based restore for specific Oracle servers. To disable the restore on
the Veeam Explorer for Oracle side, do the following:

• [Linux or Unix] On the Oracle server, log in as a user with the Oracle Administrator rights and create an
empty file in the following directory: /etc/veeam/disablerestore

• [Windows] On the Oracle server, create an empty file in the following d irectory:
%ProgramData%\Veeam\disablerestore

Oracle Data Guard

Veeam Plug-in supports Oracle Data Guard.

Database Recovery
Before you recover your database using Veeam Explorer for Oracle, consider the following:

• If you want to restore a database with a different name and settings, the database must use SPFILE. If
SPFILE is not used, a warning will be displayed during the Veeam Plug -in configuration.

• If you use huge pages, make sure that you allocated enough memory to the system where you want to
restore your database.

153 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Deployment and Configuration
Veeam Plug-in for Oracle RMAN is a feature of Veeam Backup & Replication. This guide gives instructions on
how to deploy Veeam Plug-in assuming that you already have deployed Veeam Backup & Replication and
configured a backup repository. To learn how to deploy Veeam Backup & Replication, see the Veeam Backup &
Replication User Guide for your platform.

To be able to use Veeam Plug-in for Oracle RMAN, you must install the plug-in on the Oracle server and
configure the plug-in settings.

In This Section
• Installing Veeam Plug-in for Oracle RMAN

• Access and Encryption Settings on Repositories

• Granting Permissions to Users

• Configuring Veeam Plug-in for Oracle RMAN

• Specifying Preferred Networks for Veeam Plug-ins

• Configuring Performance Throttling

• Upgrading Veeam Plug-in for Oracle RMAN

• Importing/Exporting Plug-in Settings

• Importing Backup Files

• Upgrading Backup Files

• Uninstalling Veeam Plug-in for Oracle RMAN

154 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Installing Veeam Plug-in for Oracle RMAN
See one of the following guides depending on which OS is installed on the target machine.

• Installing Veeam Plug-in on Linux machines

• Installing Veeam Plug-in on Windows machines

• Installing Veeam Plug-in on Oracle Solaris machines

• Installing Veeam Plug-in on IBM AIX machines

Installing Plug-in on Linux

Veeam Plug-in for Oracle RMAN is an additional component of Veeam Backup & Replication, and the installation
package of the plug-in is included in the Veeam Backup & Replication installation ISO file.

You can install the plug-in using the .RPM package or extract the plug-in files from the .TAR.GZ archive.
Depending on the type of package suitable for your OS, perform steps in one of the following guides:

• Installing Plug-in from .RPM Package

• Unpacking Plug-in from .TAR.GZ Archive

IMP ORTANT

Consider the following:

• Veeam Plug-in for Oracle RMAN must be installed on the Oracle Database server.
• The /opt/veeam directory must be writable.
• The NOEXEC mount option must be disabled for the /var and /tmp directories.
• To install the plug-in, use the sudo command or a user with root privileges.

Installing Plug-in from .RPM Package

To install Veeam Plug-in on a Linux machine, perform the following steps:

1. Mount the Veeam Backup & Replication installation disk

(VeeamBackup&Replication_12.3.0.310_20241201.iso).

If you deploy Veeam backup infrastructure for the first time, you can download the Veeam Backup &
Replication installation disk image from the Veeam Backup & Replication: Download page.

2. Open the mounted disk image and go to the Plugins\Oracle RMAN\Linux directory.

3. Upload the VeeamPluginforOracleRMAN-12.3.0.310-1.x86_64.rpm package to the Oracle server.

If you need the 32-bit version, choose the i386 package.

4. To install Veeam Plug-in, run the following command:

rpm -i VeeamPluginforOracleRMAN-12.3.0.310-1.x86_64.rpm

155 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Unpacking Plug-in from .TAR.GZ Archive
To extract plug-in files from the .TAR.GZ archive, perform the following:

1. Mount the Veeam Backup & Replication installation disk

(VeeamBackup&Replication_12.3.0.310_20241201.iso).

If you deploy Veeam backup infrastructure for the first time, you can download the Veeam Backup &
Replication installation disk image from the Veeam Backup & Replication: Download page.

2. Open the mounted disk image and go to the Plugins\Oracle RMAN\Linux directory .

3. Upload the VeeamPluginforOracleRMAN.tar.gz file to the Oracle server.

4. Create the /opt/veeam directory.

mkdir /opt/veeam

5. Unpack the plug-in files from the archive to the /opt/veeam directory.

tar -xzvf VeeamPluginforOracleRMAN.tar.gz -C /opt/veeam

Installing Plug-in on Microsoft Windows

You can install Veeam Plug-in for Oracle RMAN on Windows machines using a wizard or in an unattended mode.
For instructions, see:

• Installing Veeam Plug-in on Windows machines

• Installing Veeam Plug-in in an unattended mode

NOTE

When you launch the installation file, it also installs Microsoft .NET Framework 4.5.2 if it does not detect
this component on the machine during the product installation. In some cases, installation of .NET
Framework requires a reboot of the machine. This can happen, for example, if you have an earlier version of
.NET Framework installed on the machine and during the installation process it is used by third -party
software.

Installing Plug-in on Windows Machine

Veeam Plug-in for Oracle RMAN is an additional component of Veeam Backup & Replication, and the installation
package of the plug-in is included in the Veeam Backup & Replication installation ISO file.

To install Veeam Plug-in for Oracle RMAN on a Windows machine, do the following:

1. Mount the Veeam Backup & Replication installation disk

(VeeamBackup&Replication_12.3.0.310_20241201.iso).

If you deploy Veeam backup infrastructure for the first time, you can download the Veeam Backup &
Replication installation disk at: https://www.veeam.com/backup-replication-vcp-download.html.

2. In the installation disk folder go to Plugins\Oracle RMAN\Windows.

156 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 3. To launch the installation wizard, run the VeeamPluginforOracleRMAN.exe file.

4. At the welcome screen of the installation wizard, click Nex t.

5. At the License Agreement step of the wizard, accept the terms of license agreements and click Nex t.

157 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 6. At the Custom Setup step of the wizard, specify the installation path for Veeam Plug -in and click Nex t.

7. At the Rea dy to Install the Program step of the wizard, click Install.

4. Wait for the installation process to complete and click Finish to exit the wizard.

Installing Plug-in in Unattended Mode

You can install Veeam Plug-in for Oracle RMAN on a Windows machine in the unattended mode using the
command line. Go to folder where the VeeamPluginforOracleRMAN.exe file resides and run the following
command:

<path_to_exe>\VeeamPluginforOracleRMAN.exe /silent /accepteula /acceptthirdpart

ylicenses /acceptlicensingpolicy /acceptrequiredsoftware

158 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

where <path_to_exe> is a path to the Veeam Plug-in for Oracle RMAN installation file.

P a rameter Description

/silent Enables the silent mode.

/accepteula Accepts EULA terms.

/acceptthirdpartylicenses Accepts terms of third-party licenses.

Veeam Plug-in for Oracle RMAN uses the following codes to report about the installation results :

• 1000 — Veeam Plug-in for Oracle RMAN has been successfully installed.

• 1001 — prerequisite components required for Veeam Plug-in for Oracle RMAN have been installed on the
machine. Veeam Plug-in for Oracle RMAN has not been installed. The machine need s to be rebooted.

• 1002 — Veeam Plug-in for Oracle RMAN installation has failed.

• 1101 — Veeam Plug-in for Oracle RMAN has been installed. The machine needs to be rebooted.

Installing Plug-in on Oracle Solaris

Veeam Plug-in for Oracle RMAN is an additional component of Veeam Backup & Replication, and the installation
package of the plug-in is included in the Veeam Backup & Replication installation ISO file.

IMP ORTANT

Consider the following:

• Veeam Plug-in must be installed on the Oracle Database server.

• The /opt/veeam directory must be writable.
• The NOEXEC mount option must be disabled for the /var and /tmp directories.

To install Veeam Plug-in for Oracle RMAN on a Solaris machine, do the following:

1. Mount the Veeam Backup & Replication installation disk

(VeeamBackup&Replication_12.3.0.310_20241201.iso).

If you deploy Veeam backup infrastructure for the first time, you can download the Veeam Backup &
Replication installation disk image at the Download Veeam Products page.

2. In the installation disk folder, go one of the following folders depending on your system:

o For i386: Plugins\Oracle RMAN\Solaris\i386.

o For SPARC: Plugins\Oracle RMAN\Solaris\SPARC.

3. Copy the following Veeam Plug-in installation package depending on your system:

o For i386: VeeamPluginforOracleRMAN-12.3.0.310-1.i386.pkg.

o For SPARC: VeeamPluginforOracleRMAN-12.3.0.310-1.SPARC.pkg.

159 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 4. Install the plug-in from package with root privileges. Make sure the root user has privileges to add the
PKG file.

pkgadd -d /tmp/VeeamPluginforOracleRMAN-12.3.0.310-1.pkg

5. Once Veeam Plug-in is installed, you can configure the plug-in settings. For details, see Configuring Plug-
in on Linux or Unix.

Installing Plug-in on IBM AIX

Veeam Plug-in for Oracle RMAN is an additional component of Veeam Backup & Replication, and the installation
package of the plug-in is included in the Veeam Backup & Replication installation ISO file.

IMP ORTANT

Consider the following:

• Veeam Plug-in must be installed on the Oracle Database server.

• The /opt/veeam directory must be writable.
• The NOEXEC mount option must be disabled for the /var and /tmp directories.

To install Veeam Plug-in for Oracle RMAN on an IBM AIX machine, do the following:

1. Mount the Veeam Backup & Replication installation disk

(VeeamBackup&Replication_12.3.0.310_20241201.iso).

If you deploy Veeam backup infrastructure for the first time, you can download the Veeam Backup &
Replication installation disk image at the Download Veeam Products page.

2. In the installation disk folder, go to Plugins\Oracle RMAN\AIX\ppc64.

3. Copy the Veeam Plug-in installation package (VeeamPluginforOracleRMAN-12.3.0.310-

1.aix6.1.ppc.rpm) to the AIX server where the target Oracle database is deployed.

4. Install the plug-in from package with root privileges. Make sure the root user has privileges to add the
PKG file.

rpm -i VeeamPluginforOracleRMAN-12.3.0.310-1.aix6.1.ppc.rpm

5. Once Veeam Plug-in is installed, you can configure the plug-in settings. For details, see Configuring Plug-
in on Linux or Unix.

160 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Access and Encryption Settings on Repositories
When you configure Veeam Plug-in, you specify an account that must be used to connect to the Veeam Backup
& Replication server.

Before granting access permissions, consider the following:

• Consider supported types of backup repositories and limitations for Veea m Plug-in backups in Veeam
Backup Repositories.

• To store backups in a backup repository, the specified account must have access permissions on the target
backup repository.

To grant access permissions, do the following:

1. In Veeam Backup & Replication, open the Ba ckup Infrastructure view.

2. In the inventory pane, click the Ba ckup Repositories node or the Sca le-out Repositories node.

3. In the working area, select the necessary backup repository and click Set Access Permissions on the ribbon
or right-click the backup repository and select Access permissions.

4. In the Access Permissions window, on the Sta ndalone applications tab specify to whom you want to grant
access permissions on this backup repository:

o Allow to everyone — select this option if you want to grant repository access to any user. This option
is equal to granting access rights to the Everyone group in Microsoft Windows (anonymous users are
excluded). For security reasons, the option is not recommended for production environments.

o Allow to the following accounts or groups only — select this option if you want only specific users to
be able to store backups in this repository. Click Ad d to add the necessary users and groups to the list.

5. Veeam Plug-ins cannot send backups or backup copies to a backup repository where encryption is
enabled. Thus, make sure that the E ncrypt standalone application backups stored in this repository check
box is not selected.

161 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 6. Click OK.

162 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Granting Permissions to Users
When you install Veeam Plug-in for Oracle RMAN, full access rights to the plug-in configuration file are
automatically granted to all users. To protect sensitive information that is stored in the configuration file from
unwanted access, we recommend limiting access to the configuration file to a dedicated group of users.

Depending on the operating system that runs on the machine with installed Veeam Plug -in, you configure
access to the plug-in configuration file differently. To learn more, see the following subsections:

• Before You Begin

• Granting user permissions on Microsoft Windows machines

• Granting user permissions on Linux and UNIX machines

Before You Begin

Before you create a user group that will have access to the plug -in configuration file, consider the following:

• To perform this procedure, the OS user account must have root privileges (for Linux/UNIX) or local
administrator privileges (for Microsoft Windows).

• After a user is added to the group, they must log out, then log in to the system again to activate the group
permissions.

• Add only trusted users to the group.

IMP ORTANT

The users that configure the plug-in and start the RMAN client must be added to the group.

Granting User Permissions on Microsoft Windows Machines

By default, the Veeam Plug-in configuration file (veeam_config.xml) is located in the
%PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN folder on the machine where Veeam Plug-in is
installed. On Microsoft Windows machines, you can set up access to the plug -in configuration file using graphic
user interface or Windows PowerShell.

Granting Permissions to the Plug-In Configuration File in

Graphic User Interface
1. Create a new user group:

a. Launch Comp uter Management and expand the Tools > Local User and Groups node.

b. Right-click the Groups node and select New Group.

c. Specify group properties and save the group.

2. Add users to the group.

3. In the configuration file properties, remove all permissions for other user groups.

163 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 NOTE

Some permissions can be inherited. To be able to remove such permissions, on the Security tab of the
file P roperties window, select Ad vanced, then click Disable Inheritance.

4. Limit the permissions for the configuration file to allow the Read and Write access only to the members of
the group.

Granting Permissions to the Plug-In Configuration File Using

Windows PowerShell
1. Create a new user group by running the following command:

net localgroup "<groupName>" /comment:"<description>" /add

where:

o <groupName> — the name of the created group.

o <description> — the description of the group.

2. Add a user to the group with the following command:

net localgroup "<groupName>" "<userName>" /add

where:

o <groupName> — the name of the created group.

o <userName> — the name of the account that will be granted access to the configuration file.

3. Create a new access control list (ACL) with Read and Write permissions using this set of commands:

$newACL = New-Object System.Security.AccessControl.FileSecurity #creates a

dedicated ACL
$newACL.SetAccessRuleProtection($true,$false) #disables inheritance and de
letes all inherited permissions
$newACL.AddAccessRule( (New-Object System.Security.AccessControl.FileSyste
mAccessRule("groupName","Read","Allow"))) # allows read
$newACL.AddAccessRule( (New-Object System.Security.AccessControl.FileSyste
mAccessRule("groupName","Write","Allow")))# allows write

where:

o newACL — the name of the new access control list. You can give any name to this temporary variable.

o <groupName> — the name of the created group.

164 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 4. Assign ownership of the new ACL to the previously created user group by running the following command:

$newACL.SetOwner([System.Security.Principal.NTAccount]"groupName") #sets o
wner for the ACL

where:

o newACL — the name of the new access control list.

o <groupName> — the name of the created group.

5. Apply the ACL to the plug-in configuration file using this command:

set-acl -Path:<configFilePath> -AclObject:$newACL #apply ACL to the plug-i

n configuration file

where:

o <configFilePAth> — the path to the plug-in configuration file. The default path is
%PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN\veeam_config.xml.

o newACL — the name of the new access control list.

Granting User Permissions on Linux and UNIX Machines

On Linux and UNIX machines, you can set up access to the plug -in configuration files in command line interface.

By default, the Veeam Plug-in configuration file (veeam_config.xml) is located in the

/opt/veeam/VeeamPluginforOracleRMAN directory on the machine where Veeam Plug-in is installed. To
grant access to the configuration file to a dedicated group of users, do the following:

1. Create a new user group by running the following command:

sudo groupadd <groupName>

where <groupName> is the name of the created group.

2. Add a user to the group with the following command:

sudo usermod -a -G <groupName> <userName>

where:

o <groupName> — the name of the created group.

o <userName> — the name of the account that will be granted access to the configuration file.

3. Change the ownership of the configuration file to enable users from the dedicated group to access the
configuration file. To do this, run the following command:

sudo chgrp <groupName> /opt/veeam/VeeamPluginforOracleRMAN/veeam_config.xm

l

where <groupName> is the name of the created group.

165 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 4. Limit the permissions for the configuration file to allow the read -write access only to the members of the
group. To do this, use the following command:

sudo chmod 660 /opt/veeam/VeeamPluginforOracleRMAN/veeam_config.xml

166 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Configuring Veeam Plug-in for Oracle RMAN
By default, RMAN sends backups to a native RMAN location on disk (DEFAULT DEVICE TYPE TO DISK). When
you configure Veeam Plug-in, the default device type is changed to SBT_TAPE, which gives control over backup
media management to Veeam Plug-in. Thus, after you deploy Veeam Plug-in on an Oracle server, you can
perform all backup and restore operations in the Oracle RMAN console. Veeam Plug -in compresses database
backups and transfers them to a backup repository connected to Veeam Backup & Replication.

To use Veeam Plug-in you must configure the connection between the Oracle server, Veeam Backup &
Replication server and backup repositories where backup files will be stored.

• Configuring Plug-in on Linux or Unix

• Configuring Plug-in on Microsoft Windows

Configuring Plug-in on Linux or Unix

To configure Veeam Plug-in, you can use Ora cleRMANConfigTool. The tool configures Oracle RMAN integration
settings and creates the Veeam Plug-in configuration file (veeam_config.xml) which is stored in the
/opt/veeam/VeeamPluginforOracleRMAN directory on the machine where Veeam Plug-in is installed.

Note that the Veeam Plug-in configuration tool changes the settings of Oracle RMAN. All original settings of
Oracle RMAN are saved in the /opt/veeam/VeeamPluginforOracleRMAN/RMANParameters.xml file.

To configure Veeam Plug-in for Oracle RMAN, do the following:

1. Log in to the Oracle server with an account which is a member of the DBA group.

2. Launch the configuration wizard:

OracleRMANConfigTool --wizard

If you have extracted files form the .TAR.GZ archive, go to the

/opt/veeam/VeeamPluginforOracleRMAN folder and run the following command:

./OracleRMANConfigTool --wizard

3. Specify the DNS name or IP address of the Veeam Backup & Replication server.

Enter backup server name or IP address: 172.24.164.68

4. Specify the port which will be used to communicate with the Veeam Backup & Replication server. Default
port: 10006.

Enter backup server port number: 10006

167 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 5. Specify the OS user credentials to authenticate against the Veeam Backup & Replication server.

Enter username: serv17\administrator

Enter password for serv17\administrator:

IMP ORTANT

Consider the following:

• You can work with backups created by Veeam Plug-in only with the account used for creating
the backups. If you want to use another account, assign the Veeam Backup Administrator role
or Veeam Backup Operator and Veeam Restore Operator roles to the account.

To learn how to assign Veeam Backup & Replication roles, see the Users and Roles section in
the Veeam Backup & Replication User Guide.
• The account must have access permissions on the required backup repository. To learn how to
configure access permissions and encryption settings on repositories, see Access and
Encryption Settings on Repositories.

6. Select the backup repository where you want to store the backups. In the wizard dialog, enter the number
of the repository from the list of available repositories. If you want to add several repositories, enter the
required numbers separated by blank spaces.

If you want to use the Oracle RMAN Backup Duplexing functionality, you can select up to four repositories.
The copies of backups will be sent to all selected repositories. Note that Oracle Database Standard Edition
does not allow using more than one RMAN channel. Thus, if you use Standard Edition, you can select only
one repository.

Available repositories are:

1. serv10_repo
2. serv02_repo
Specify up to 4 Veeam repositories to use as target using whitespace as a
separator: 2

IMP ORTANT
• The account must have access to back up repositories that you plan to use.
• Encryption must be disabled on the repository.

Otherwise, the repositories will not be listed as available. To learn how to configure access
permissions and encryption settings on repositories, see Access and Encryption Settings on
Repositories.

7. Specify the number of parallel data streams for each backup repository. Note that Oracle Database
Standard Edition does not allow using more than one RMAN channel. Thus, if you use Standard Edition,
you can select only one data stream.

Enter the number of data streams (From 1 to 254) to run in parallel for ea
ch repository (RMAN DEVICE PARALLELISM value).
Channel count per device: 4

168 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 8. If you want to enable Veeam compression of backup files, type y . For details, see the Data Compression
and Deduplication section of Veeam Backup & Replication User Guide.

Do you want to use Veeam compression (Y/n):y

9. At the Select the Oracle environment authentication method step of the plug-in wizard, select the
preferred authentication method to connect to the backup database.

You can choose between operating system authentication and database authentication methods. With the
OS authentication method, you can connect to the server and database using only OS user credentials.
With the database authentication method, you can connect to the server using OS user credentials and to
the database using database user credentials. The OS user account must be a user on the Oracle server
with the required permissions to run RMAN.

If you select the database authentication method, you must specify the database user account credentials.
The OS user credentials will be applied automatically.

Note that the Veeam Plug-in configuration tool changes the settings of Oracle RMAN. All original settings
of Oracle RMAN are saved in the /opt/veeam/VeeamPluginforOracleRMAN/RMANParameters.xml
file.

For details, see Authentication Against Database.

o For the OS authentication method, at the Select the Oracle environment authentication method step
of the wizard, select Op erating system authentication. The OS user credentials will be used
automatically.

Select the Oracle environment authentication method :

1. Operating system authentication
2. Database authentication
Enter:1

In the following RMAN settings section, the wizard will display a list of the RMAN settings that have
been configured previously.

o For the database authentication method, at the Select the Oracle environment authentication method
step of the wizard, select Da tabase authentication.

Select the Oracle environment authentication method:

1. Operating system authentication
2. Database authentication
Enter:2

You can configure credentials for each of the target databases or one set of credentials for multiple
databases. You can update all database credentials using the OracleRMANConfigTool command, if
needed.

The database user account must have the SYSBACKUP permission on the database. To learn more
about Oracle permissions, see this Oracle article.

169 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 ▪ To configure credentials for each of the target databases, at the Select the preferred method to
enter credentials step of the wizard, select E nter different credentials for each automatically
d etected database :

Select the preferred method to enter credentials:

0. Do not enter credentials and use already existing ones
1. Enter different credentials for each automatically detected datab
ase
2. Enter common credentials for multiple manually specified database
s
Enter:1

Enter the individual database user account credentials. The OS user account credentials specified
in step 5 will be applied automatically.

Getting databases... 2 databases found

Enter username for ORCL: SYS
Enter password for user SYS in ORCL:
Enter username for ORCL2: SYSBACKUP
Enter password for user SYSBACKUP in ORCL2:

▪ To configure common credentials for multiple target databases, at the Select the preferred
method to enter credentials step of the wizard, select E nter common credentials for multiple
ma nually specified databases:

Select the preferred method to enter credentials:

0. Do not enter credentials and use already existing ones
1. Enter different credentials for each automatically detected datab
ase
2. Enter common credentials for multiple manually specified database
s
Enter:2

Specify all database names for which you want to use common credentials, and enter the user
name and password you want to use:

Getting databases... 2 databases found

Specify database names: ORCL, ORCL2
Enter username: SYS
Enter password:

10. At the Sa ve configuration step of the plug-in wizard, you can export configuration files (the Veeam Plug -
in configuration file and RMAN configuration file). You can import these configuration files to other
servers to apply the same settings.

Save configuration?
1. Apply configuration to the Oracle environment
2. Export configuration into a file for manual setup
3. Cancel without saving
Enter:1
*** Database instance ORCL is configured ***

170 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 NOTE

When you export the configuration files, Veeam Plug -in automatically enables Oracle's Controlfile
Autobackup feature. This feature is required for restoring with different settings using Veeam
Explorer for Oracle.

TIP

It is recommended to save the configuration files, so that you can use it as a reference. For example,
if you are planning to manually allocate channels for backup and restore operations, you will need
the repository UUID. The RMAN configuration file (rman_config.txt) contains an example for
channel allocation definition for the target repository. You can use this statement in your
backup/restore scripts.

Configuration Tool Parameters

Apart from running a configuration wizard, you can use the Ora cleRMANConfigTool tool to change a specific
parameter in the veeam_config.xml file or enable/disable Veeam Plug-in features.

IMP ORTANT

When you work with the command-line tool, use one configuration parameter per command. The tool does
not support commands with multiple parameters.

The following table lists available parameters for Ora cleRMANConfigTool.

P a rameter Description

--help Shows the list of parameters of the plug-in configuration tool.

--show-config Shows configuration parameters.

Starts the wizard to configure the plug-in settings. The wizard

edits the Veeam Plug-in configuration file
(veeam_config.xml) or creates a new one if the configuration
--wizard
file was removed from the
/opt/veeam/VeeamPluginforOracleRMAN directory on the
machine where Veeam Plug-in is installed.

--set-credentials <"serv\username"> Specifies credentials to connect to the Veeam Backup &

< " password"> Replication server.

--set-db-credentials Specifies credentials to connect to a single database.

--set-host <hostname> Specifies the host of the Veeam backup server.

171 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 P a rameter Description

Specifies the host to connect to the Veeam Backup & Replication

--set-port <port_number>
server.

Launches a wizard to select a backup repository. A backup

--set-repositories repository is selected from repositories which are available in
the connected Veeam Backup & Replication instance.

--set-parallelism <number_of_channels> Configures RMAN parallelism settings.

Enables/disables Veeam proprietary feature which compresses

--compression <y/n>
backup files.

--ma p-backup Maps the imported backups.

Configures the auto-deletion of backup files after specified

--set-force-delete
days.

Maps the imported backup copy to a regular Veeam Plug -in

--p romote-backup-copy-to-primary
backup chain.

Specifies an authentication method for database restore. Use

this parameter if you want to restore a database to another
server or to restore a database from a backup copy.

--set-auth-data-for-restore After you run the OracleRMANConfigTool command with this

parameter, use the OracleRMANConfigTool command with
the --set-backup-for-restore parameter to select a
backup from which you want to restore a database. For more
information, see Restore to Another Server.

Selects the backup for database restore. Use this parameter if

you want to restore a database to another server or to restore a
database from a backup copy.

--g et-backup-for-restore You can run the OracleRMANConfigTool command with this
parameter to select a backup after you have specified an
authentication method to access the backup using the
OracleRMANConfigTool --set-backup-for-restore
command. For more information, see Restore to Another Server.

172 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 P a rameter Description

Shows the list of preferred networks set for Veeam Plug -in data
traffic to the remote backup repository.

The list shows set preferred networks in descending order of

--show-preferred-networks priority. If the list is empty, no networks are set as preferred and
Veeam Plug-in routes data traffic to the preferred networks set
in Veeam Backup & Replication. For more information, see
Specifying Preferred Networks for Veeam Plug-ins.

Adds a network to the list of preferred networks for Veeam

Plug-in data traffic to the remote backup repository.
--a dd-preferred-network To select to which network Veeam Plug-in connects first, you
< network_IP_address> <position_in_list> can set the order number of the network in the list. For more
information, see Specifying Preferred Networks for Veeam Plug-
ins.

--remove-preferred-network Removes a specified network from the list of preferred networks

< network_IP_address> for Veeam Plug-in data traffic to the remote backup repository.

Example
To specify credentials that will be used to log in to the Veeam Backup & Replication server, use the plug -in
configuration tool with the following command.

OracleRMANConfigTool --set-credentials 'serv04\joelle' 'password'

Configuring Plug-in on Microsoft Windows

To configure backup, restore and authentication settings, use the Veeam Plug -in for Oracle RMAN configuration
wizard. The wizard configures Oracle RMAN settings and creates the Veeam Plug -in configuration file
(veeam_config.xml) which is stored in the %PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN
folder on the machine where Veeam Plug-in is installed.

Note that configuration wizard of Veeam Plug-in for Oracle RMAN changes the settings of Oracle RMAN. All
original settings of Oracle RMAN are saved in the
%PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN\RMANParameters.xml file.

To configure Veeam Plug-in, do the following:

1. On the Oracle server, click launch the Veeam RMAN Configuration Wizard
(%PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN\Veeam.Backup.RMAN.Configuration.
exe).

173 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 2. At the Ba ckup Server step of the wizard, specify the DNS name of the Veeam Backup & Replication server
and OS user account credentials that will be used to connect to the server.

3. At the Ba ckup Repository step of the wizard:

a. Click Ad d and select the required repository. For Oracle Database Standard Edition, you can select
only one repository. If you want to use the Oracle RMAN Backup Duplexing functionality, you can
select up to four repositories. The copies of backups will be sent to all selected repositories.
You must allow access to Veeam backup repositories that you plan to use. Also, the encryption on the
repository must be disabled. To learn how to configure access and encryption on repositories, see
Access and Encryption Settings on Repositories.

b. If you want to use another repository, select the repository from the list and click Remove. Then, you
can add another repository.

c. At the Cha nnels per repository field, specify the number of allowed parallel data streams for each
repository.

d. If you want to enable Veeam Plug-in compression, select the E na ble backup compression by the plug-
in check box.

Note that if you use Veeam Plug-in compression in combination with Oracle RMAN integrated
compression (BACKUP AS COMPRESSED commands), it can slow down processing.

e. Click Nex t.

174 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 IMP ORTANT

You can work with backups created by Veeam Plug-in only with the account used for creating the
backups. If you want to use another account, assign the Veeam Backup Administrator role or Veeam
Backup Operator and Veeam Restore Operator roles to the account.
To learn how to assign Veeam Backup & Replication roles, see the Users and Roles section in the
Veeam Backup & Replication User Guide.

4. At the Authentication step of the wizard, you can select a preferred authentication method to connect to
the backup database.

You can choose between the operating authentication and database authentication methods. With the OS
authentication method, you can connect to the server and database using OS user credentials. With the
database authentication method, you can connect to the server using OS user credentials and to the
database using database user credentials. The OS user account must be a user on the Oracle server with
the required permissions to run RMAN.

If you select the database authentication method, you must specify the database user account credentials.
The OS user credentials are applied automatically.

Note that the Veeam Plug-in configuration tool changes the settings of Oracle RMAN. All original settings
of Oracle RMAN are saved in the
%PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN\RMANParameters.xml file.

For details, see Authentication Against Database.

o Select Op erating system a uthentication, to choose the OS authentication method.

The OS user credentials are applied automatically.

o Select Da tabase authentication, to choose the database authentication method.

You can configure credentials for each of the target databases or one set of credentials for multiple
databases. You can update all database credentials using the OracleRMANConfigTool command, if
needed. The list of set credentials is stored in the veeam_config.xml configuration file.

The database user account must have the SYSBACKUP permission on the database. To learn more
about Oracle permissions, see this Oracle article.

To set database credentials, perform one of the following:

175 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 ▪ Select an individual database and click Set user to configure the database user account
credentials.

▪ Select multiple databases and click Set user to configure common credentials for multiple target
databases.

4. At the Summary step of the wizard, you can export the plug-in and Oracle RMAN configuration files. You
can use the configuration files to apply the plug-in settings on other servers.

a. To export the veeam_config.xml file click E x p ort and select Veeam Config.

b. Click Finish.

NOTE

When you export the configuration files, Veeam Plug -in automatically enables Oracle's Controlfile
Autobackup feature. This feature is required for restoring with different settings using Veeam
Explorer for Oracle.

176 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 TIP

It is recommended to save the configuration files, so that you can use it as a reference. For example,
if you are planning to manually allocate channels for backup and restore operations, you will need
the repository UUID. The RMAN configuration file (rman_config.txt) contains an example for
channel allocation definition for the target repository. You can use this statement in your
backup/restore scripts.

Configuration Tool Commands

Apart from running a configuration wizard, you can use the Ora cleRMANConfigTool.exe tool to change a specific
parameter in the veeam_config.xml file or enable/disable Veeam Plug-in features.

IMP ORTANT

When you work with the command-line tool, use one configuration parameter per command. The tool does
not support commands with multiple parameters.

To run a specific command, do the following:

1. On the Oracle server, go to %PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN.

2. Run the required Ora cleRMANConfigTool.exe command from the table below.

For example, to specify credentials that will be used to log in to the Veeam Backup & Replication server,
use the plug-in configuration tool with the following command:

OracleRMANConfigTool.exe --set-credentials "serv02\Joelle" "password"

Command Description

--help Shows the list of parameters of the plug-in configuration tool.

--show-config Shows configuration parameters.

Starts the wizard to configure the plug-in settings. This wizard

edits the Veeam Plug-in configuration file
(veeam_config.xml) or creates a new one if the configuration
--wizard
file was removed from the
%PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN
directory on the machine where Veeam Plug-in is installed.

--set-credentials <"serv\username"> Specifies credentials to connect to the Veeam Backup &

< " password"> Replication server.

--set-db-credentials Specifies credentials to connect to a single database.

177 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 Command Description

--set-host <hostname> Specifies the host of the Veeam Backup & Replication server.

Specifies the host to connect to the Veeam Backup & Replication

--set-port <port_number>
server.

Launches a wizard to select a backup repository. A backup

--set-repositories repository is selected from repositories which are available in
the connected Veeam Backup & Replication instance.

--set-parallelism <number_of_channels> Configures Oracle RMAN parallelism settings.

Enables/disables Veeam proprietary feature which compresses

--compression <y/n>
backup files.

Enables/disables network traffic throttling. For more

--set-throttling
information, see Configuring Performance Throttling.

--ma p-backup Maps the imported backups.

--set-force-delete Deletes backup files after specified days.

Maps the imported backup copy to a regular Veeam Plug-in

--p romote-backup-copy-to-primary
backup chain.

Specifies an authentication method for database restore. Use

this parameter if you want to restore a database to another
server or to restore a database from a backup copy.

--set-auth-data-for-restore After you run the OracleRMANConfigTool command with this

parameter, use the OracleRMANConfigTool command with
the --set-backup-for-restore parameter to select a
backup from which you want to restore a database. For more
information, see Restore to Another Server.

Selects the backup for database restore. Use this parameter if

you want to restore a database to another server or to restore a
database from a backup copy.

--g et-backup-for-restore You can run the OracleRMANConfigTool command with this
parameter to select a backup after you have specified an
authentication method to access the backup using the
OracleRMANConfigTool --set-backup-for-restore
command. For more information, see Restore to Another Server.

178 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 Command Description

Shows the list of preferred networks set for Veeam Plug -in data
traffic to the remote backup repository.

The list shows set preferred networks in descending order of

--show-preferred-networks priority. If the list is empty, no networks are set as preferred and
Veeam Plug-in routes data traffic to the preferred networks set
in Veeam Backup & Replication. For more information, see
Specifying Preferred Networks for Veeam Plug-ins.

Adds a network to the list of preferred networks for Veeam

Plug-in data traffic to the remote backup repository.
--a dd-preferred-network To select to which network Veeam Plug-in connects first, you
< network_IP_address> <position_in_list> can set the order number of the network in the list. For more
information, see Specifying Preferred Networks for Veeam Plug-
ins.

--remove-preferred-network Removes a specified network from the list of preferred networks

< network_IP_address> for Veeam Plug-in data traffic to the remote backup repository.

179 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Specifying Preferred Networks for Veeam Plug-
ins
You can specify networks over which Veeam Plug-in must transport data when you perform data protection and
disaster recovery tasks on remote backup repositories. This setting applies only to Veeam Plug-in network
traffic, without affecting the data traffic of other Veeam Backup & Replication components. Setting a dedicated
network for Veeam Plug-in backup and replication operations can help to reduce heavy network loads.

NOTE

Consider the following:

• By default, if there are no specified preferred networks for Veeam Plug -in data traffic, Veeam Plug-
in will connect to preferred networks specified in Veeam Backup & Replication. To learn more about
setting preferred networks in Veeam Backup & Replication, see the Specifying Preferred Networks
section in the Veeam Backup & Replication User Guide.
• Veeam Plug-in does not save information about failed network connections. If backup or restore
operations fail, Veeam Plug-in tries to connect to the following network from the preferred
networks list to finish the started operations. Regardless of the first unsuccessful connection,
Veeam Plug-in will try to perform the next backup operations first on the failed network.
• Veeam Plug-in network preferences take priority over Veeam Backup & Replication network
preferences. Only if the preferred networks for Veeam Plug -in data traffic are not available for any
reason, Veeam Plug-in will try to connect to the Veeam Backup & Replication preferred networks.

To specify networks for data transfer, you must create a list of preferred networks. When Veeam Plug -in needs
to transfer data, it uses networks from this list. If a connection over any of the preferred networks cannot be
established for any reason, Veeam Plug-in will automatically fail over to the following network from the
preferred networks list.

To create and manage the list of preferred networks that Veeam Plug-in will use, you can perform the following
operations:

• Adding Preferred Networks

• Accessing Preferred Networks

• Removing Preferred Networks

Adding Preferred Networks

1. Access the Veeam Plug-in for Oracle RMAN directory on your Oracle server. The path to the directory
differs depending on the OS of the machine where Veeam Plug -in is installed:

o On machines running Linux or Unix OS: /opt/veeam/VeeamPluginforOracleRMAN

o On machines running Microsoft Windows OS:

%PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN

2. Run Ora cleRMANConfigTool command with the following parameter:

o On machines running Linux or Unix OS:

OracleRMANConfigTool --add-preferred-network <network_IP_address> <posi

tion_in_list>

180 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 o On machines running Microsoft Windows OS:

OracleRMANConfigTool.exe --add-preferred-network <network_IP_address> <

position_in_list>

where:

▪ <network_IP_address> can be either the IP address of a single network or a network mask

that contains a range of network IP addresses. Specify one of the available options to add as
preferred networks for Veeam Plug-in data traffic.

▪ <position_in_list> is the position number of the network in the preferred networks list.
The position in the list determines in what order Veeam Plug -in will connect to the specified
network. If you do not chose a specific position in the list, newly added networks take the last
place in the list automatically.

For example:

OracleRMANConfigTool.exe --add-preferred-network 172.24.29.189 2

Accessing Preferred Networks

1. Access the Veeam Plug-in for Oracle RMAN directory on your Oracle server. The path to the directory
differs depending on the OS of the machine where Veeam Plug -in is installed:

o On machines running Linux or Unix OS: /opt/veeam/VeeamPluginforOracleRMAN

o On machines running Microsoft Windows OS:

%PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN

2. Run Ora cleRMANConfigTool with the --show-preferred-networks parameter:

o On machines running Linux or Unix OS:

OracleRMANConfigTool --show-preferred-networks

o On machines running Microsoft Windows OS:

OracleRMANConfigTool.exe --show-preferred-networks

The following example shows what the output of the Ora cleRMANConfigTool command with the --show-
preferred-networks parameter can look like on a machine running Microsoft Windows OS:

OracleRMANConfigTool.exe --show-preferred-networks
Preferred networks:
1. 172.24.29.156
2. 172.24.26.189

181 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Removing Preferred Networks
1. Access the Veeam Plug-in for Oracle RMAN directory on your Oracle server. The path to the directory
differs depending on the OS of the machine where Veeam Plug -in is installed:

o On machines running Linux or Unix OS: /opt/veeam/VeeamPluginforOracleRMAN

o On machines running Microsoft Windows OS:

%PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN

2. Run Ora cleRMANConfigTool with the --remove-preferred-network <network_IP_address>

parameter:

o On machines running Linux or Unix OS:

OracleRMANConfigTool --remove-preferred-network <network_IP_address>

o On machines running Microsoft Windows OS:

OracleRMANConfigTool.exe --remove-preferred-network <network_IP_address

>

where <network_IP_address> can be either the IP address of a single network or a network mask
that contains a range of network IP addresses. Specify one of the available options to remove from
the preferred networks list.

For example:

OracleRMANConfigTool.exe --remove-preferred-network 172.24.29.189

182 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Configuring Performance Throttling
You can limit computer processing (CPU) resources assigned for Veeam Plug -in backup jobs. This setting allows
you to reduce the impact of backup operations on the target computer performance. Performance throttling
prevents Veeam Plug-ins from utilizing all computer resources to ensure that enough resources are provided for
other operations. This maybe useful in case you detected that your source database responses are slower during
backup operations.

If you throttle performance, additional system components help with the throttling process:

• [For Linux and Unix machines] Veeam Backup & Replication starts Veeam Plug -in backup operation
processes with low priority and nice value of 19. The nice values are in ascending order of priority ranging
from -20 (the highest priority) to 19 (the lowest priority).

• [For Microsoft Windows machines] Veeam Plug-in uses the OS process priority system in the background
to lower the priority of backup operation processes. To learn more about the process priority setting, see
this Microsoft article.

Keep in mind that Veeam Plug-ins manage the priority of backup operation processes only if the system running
on the target computer is busy with other tasks.

NOTE
• By default, Veeam Plug-in does not throttle performance.
• Performance throttling does not apply to restore operations.

To throttle Veeam Plug-in performance, do the following:

1. Log into the machine with a user with root or instance owner privileges.

2. Start the Veeam Plug-in configuration wizard with the following parameter:

o On machines running Linux or Unix OS:

OracleRMANConfigTool --set-throttling

o On machines running Windows OS:

OracleRMANConfigTool.exe --set-throttling

3. To confirm that you want Veeam Plug-in throttle performance, type y .

All backup activities will be throttled if the system is busy. Backup perf
ormance may be affected. Proceed? (y/N): y

183 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Upgrading Veeam Plug-in for Oracle RMAN
Periodically, Veeam releases a new version of Veeam Backup & Replication that contains new features and bug
fixes. The release package also contains a new version of Veeam Plug-ins.

If you want to upgrade Veeam Plug-in, note that Veeam Backup & Replication must be the same or later than
the version of Veeam Plug-in. If you want to use the latest functionality, you must upgrade both Veeam Backup
& Replication and Veeam Plug-in to the latest version. After the upgrade, you don't need to re-run the Veeam
Plug-in configuration wizard, the plug-in configuration files will be preserved.

IMP ORTANT

Consider the following:

• You must upgrade Veeam Backup & Replication before you upgrade Veeam Plug -ins. To learn how to
upgrade Veeam Backup & Replication, see the Upgrading to Veeam Backup & Replication 12.3 section
in the Veeam Backup & Replication User Guide.

• Veeam Backup & Replication supports two latest versions of Veeam Plug -ins. For example, Veeam
Backup & Replication 12.3 supports Veeam Plug-in 12.3 and 12.2.

Keep in mind that if you use an earlier Veeam Plug-in build than the one that is included in the
installation ISO file of your Veeam Backup & Replication version, it may not have all the features and
bug fixes introduced in your Veeam Backup & Replication version. To learn more about the Veeam
Plug-in builds included in Veeam Backup & Replication installation ISO files, see this Veeam KB
article.
• [For Linux computers] Operations in the terminal of the machine with the database requir e root
privileges.

Before You Begin

Veeam Plug-in installation files are included in the installation disk image of Veeam Backup & Replication. You
must upload the installation file to the Oracle Database server. To do this, perform the following steps:

1. Mount the Veeam Backup & Replication installation disk

(VeeamBackup&Replication_12.3.0.310_20241201.iso).

2. Open the mounted disk image and go to one of the Plugins\Oracle RMAN folder.

3. Select the Veeam Plug-in installation file suitable for your OS and upload it to the Oracle Database server.

The upgrade procedure depends on the type of package and OS that you use:

• Upgrading Plug-in on Microsoft Windows

• Upgrading Plug-in on Linux (.RPM)

• Upgrading Plug-in on Linux (.TAR.GZ)

• Upgrading Plug-in on Oracle Solaris

• Upgrading Plug-in on IBM AIX

184 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Upgrading Plug-in on Windows
To upgrade Veeam Plug-in for Oracle RMAN on a Windows machine, upload the
VeeamPluginforOracleRMAN.exe file of the new version to the Oracle Database server and install it. The old
version will be replaced with the new version automatically.

You can upgrade Veeam Plug-in for Oracle RMAN to a later version in the unattended mode using the same
command that is used for unattended installation. For details, see Installing Plug-in on Windows Machine in
Unattended Mode.

Upgrading Plug-in on Linux (.RPM)

To upgrade Veeam Plug-in for Oracle RMAN on a Linux machine, do the following:

1. Upload the VeeamPluginforOracleRMAN-12.3.0.310-1.x86_64.rpm package to the Oracle server.

If you need the 32-bit version, choose the i386 package.

2. To upgrade Veeam Plug-in, run the following command. Note that the operation requires root privileges.

rpm -U VeeamPluginforOracleRMAN-12.3.0.310-1.x86_64.rpm

TIP

To find out which version of Veeam Plug-in is installed on your server, you can use the following command:
rpm -qa | grep VeeamPlugin

Upgrading Plug-in on Linux (.TAR.GZ)

To upgrade Veeam Plug-in for Oracle RMAN on a Linux machine from the .TAR.GZ archive, do the following:

1. Upload the VeeamPluginforOracleRMAN.tar.gz file to the Oracle server.

2. Unpack the plug-in files from the archive to the /opt/veeam directory. Old Veeam Plug-in files will be
replaced by new files.

tar -xzvf VeeamPluginforOracleRMAN.tar.gz -C /opt/veeam

Upgrading Plug-in on Oracle Solaris

To upgrade Veeam Plug-in for Oracle RMAN on an Oracle Solaris machine, do the following:

1. Upload the VeeamPluginforOracleRMAN-12.3.0.310-1.SPARC.pkg package to the Oracle server. If

you need the 32-bit version, choose the i386 package.

2. Make sure the pkgadd administration file (admin_file) contains the following entry:
"instance=overwrite". For details, see this Oracle article.

185 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 3. To upgrade Veeam Plug-in, run the following command:

pkgadd -a admin_file -d /tmp/VeeamPluginforOracleRMAN-12.3.0.310-1.SPARC.p

kg

Upgrading Plug-in on IBM AIX

To upgrade Veeam Plug-in for Oracle RMAN on an IBM AIX machine, do the following:

1. Upload the VeeamPluginforOracleRMAN-12.3.0.310-1.aix6.1.ppc.rpm package to the Oracle

server.

2. To upgrade Veeam Plug-in, run the following command. Note that the operation requires root privileges.

rpm -U VeeamPluginforOracleRMAN-12.3.0.310-1.aix6.1.ppc.rpm

186 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Importing/Exporting Plug-in Settings
You can export a Veeam Plug-in configuration file and apply the plug-in settings to other servers.

IMP ORTANT

The password included in the configuration file is encrypted. Thus, after you import the configuration file,
you must set the credentials manually in the Veeam Plug -in configuration wizard.

To export the configuration file to another server, do the following:

For Linux and Unix

1. On the server where Veeam Plug-in is installed, go to /opt/veeam/VeeamPluginforOracleRMAN.

2. Copy the Veeam Plug-in configuration file (veeam_config.xml) to the server where you want to
configure the plug-in.

3. Install Veeam Plug-in on the new server and place the copied XML file in the
/opt/veeam/VeeamPluginforOracleRMAN folder.

4. Set new credentials that Veeam Plug-in will use to log in to the Veeam Backup & Replication server using
the following command:

OracleRMANConfigTool --set-credentials 'serv\username' 'password'

For Microsoft Windows

1. On the server where Veeam Plug-in is installed, go to

%PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN\.

2. Copy the Veeam Plug-in configuration file (veeam_config.xml) to the server where you want to
configure the plug-in.

3. Install Veeam Plug-in on the new server and place the copied XML file in the
%PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN\ folder.

4. Set new credentials that Veeam Plug-in will use to log in to the Veeam Backup & Replication server using
the following command:

%PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN\OracleRMANConfigTool.exe --set-cr
edentials "serv\username" "password"

187 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Importing Backup Files
If the Veeam Backup & Replication server has failed and you have restored it in a new location, you can copy the
backup files to a new repository and re-map the Veeam Plug-in backup files.

Limitations and Prerequisites

Consider the following limitations:

• If backup files are not imported according to instructions given in this section, Veeam Plug -in backup and
restore operations may fail.

• The repository from which you plan to import backups must be added to the Veeam Backup & Replication
infrastructure. Otherwise you will not be able to access backup files.

• [For imports to the scale-out backup repository] Before importing your backup, consider that the names
of all backup files (.VAB, .VASM, .VACM) and paths to these files contain only the following allowed
characters:

o a-zA-Z0-9

o _-.+=@^

If your backup was initially created on a standalone backup server, the default name of the backup
metadata file (.VACM) contains forbidden characters. Before importing, you must delete forbidden
characters from the file name or replace them with the allowed characters.

How to Import Veeam Plug-in Backup Files

To import Veeam Plug-in backup files, do the following:

1. Move the folder with the backup file to the required backup repository or create a new backup repository
with this folder as a subfolder.

TIP

Each Veeam Plug-in backup file (.VAB) has its own metadata file (.VASM). Make sure you import
backup files and all related metadata files. Also, you must import the backup job metadata file
(.VACM) which is stored in the same folder.

2. In the Veeam Backup & Replication console, open the Ba ckup Infrastructure view.

3. In the inventory pane of the Ba ckup Infrastructure view, select the Ba ckup Repositories node.

188 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 4. In the working area, select the required backup repository and click Rescan on the ribbon. Alternatively,
you can right-click the backup repository and select Rescan.

During the rescan operation, Veeam Backup & Replication gathers information about backups that are
currently available in the backup repository and updates the list of backups in the configuration database.
After the rescan operation, backups that were not in this configuration database will be shown on the
Home view in the Ba ckups > Disk (Imported) node.

5. On the Oracle server, use the terminal to set the new repository as a target in the Veeam Plug -in settings:

o For W indows:

"%PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN\OracleRMANConfigTool" --
set-repositories
Available backup repositories:
1. serv55.tech.local
2. serv07_repo
Enter repository number: 1

o For Linux and Unix:

OracleRMANConfigTool --set-repositories
Available backup repositories:
1. serv55.tech.local
2. serv07_repo
Enter repository number: 1

6. Start the Veeam Plug-in configuration wizard with the --map-backup parameter to re-map the plug-in
backups:

189 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 NOTE

Before you re-map your backup to the repository, make sure that there is not an existing backup job
on your machine with Veeam Plug-in that is targeted at the same repository. If there is such a job,
delete this job from the Veeam Backup & Replication console.

o For W indows:

"%PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN\OracleRMANConfigTool" --
map-backup

o For Linux and Unix:

OracleRMANConfigTool --map-backup

190 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Upgrading Backup Files
Since version 11, Veeam Plug-in uses a new format of backup files: instead of one metadata file for all backup
files there are separate metadata files (.VASM) for each database backup file (.VAB). The new metadata format
allows Veeam Plug-in to optimize the productivity of backup and restore operations.

IMP ORTANT

For Veeam Backup & Replication 12, backup files created by Veeam Plug-in 10 are not supported. After you
upgrade Veeam Backup & Replication and Veeam Plug -in to the 12 version, you must upgrade the backup
files. After that, you can run your backup jobs. Otherwise, backup jobs will fail.

Prerequisites
Before upgrading backup files, make sure the following requirements are met.

• Make sure that you have upgraded Veeam Plug -in on the source server. If Veeam Plug-in is not upgraded
to version 11 or later and you upgrade the backup files, then all next backup job runs will f ail.

• Make sure that you have disabled the backup job whose backup files you want upgrade. You must also
disable the backup copy jobs that use these backup files as a source.

• If the backup files reside on the scale-out backup repository, all repository extents must be available.
Also, the extents must not be in the Seal or Maintenance mode.

• If you want to upgrade backup files created by a backup copy job, you must meet the same requirements
as for the backup job files.

• During the process of the metadata upgrade, you cannot run the target backup job and you cannot restore
from the backup files.

The upgrade process duration depends on the number of backup files in the backup set, type of the
backup repository and workload level on the file system.

For example, there are backup files of an Oracle server that contains 10 instances and is backed up every
15 minutes with the retention policy set for 2 weeks. The upgrade of backup files can have the following
duration on not overloaded file systems:

o Microsoft Windows: 30 minutes

o Linux: from 30 minutes to 3 hours

o SMB/NFS: 1.5 hours

o Data Domain Boost/Quantum DXi/ExaGrid/CIFS (SMB)/NFS file share: 3-4 hours

o HPE StoreOnce: up to 10 hours (due to specifics of this repository type for processing large num ber of
files)

Upgrading Backup Files in Veeam Backup & Replication

Console
To upgrade backup files in the Veeam Backup & Replication console, do the following:

1. Open the Home view.

2. In the inventory pane, expand the Ba ckups view and select Disk.

191 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 3. In the working area, right-click the job or the restore point and select Up g rade.

Alternatively, you can select the job or the restore point and click Up g rade on the ribbon.

192 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Uninstalling Veeam Plug-in for Oracle RMAN
You can uninstall the Veeam Plug-in and undo the configuration changes made by Veeam Plug -in.

When you configure Veeam Plug-in, original settings of Oracle RMAN are saved in the
/opt/veeam/VeeamPluginforOracleRMAN/RMANParameters.xml file (or in the
%PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN\RMANParameters.xml for Windows). If you
uninstall Veeam Plug-in for Oracle RMAN, original settings of Oracle RMAN are restored from the
RMANParameters.xml file.

Uninstalling Veeam Plug-in on Linux or IBM AIX Machines

To uninstall Veeam Plug-in and undo the configuration changes, run the following command. Note that the
operation requires root privileges.

rpm -e VeeamPluginforOracleRMAN

Uninstalling Veeam Plug-in on Windows Machines

To uninstall Veeam Plug-in and undo the configuration changes, do the following:

1. Open the Control Panel and click P rograms and Features.

2. In the list of programs, select Veea m Plug-in for Oracle RMAN and click Uninstall.

Uninstalling Veeam Plug-in on Solaris Machines

To uninstall Veeam Plug-in and undo the configuration changes, run the following command:

pkgrm VeeamPluginforOracleRMAN

193 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Database Protection
After you configure Veeam Plug-in, you can use the Oracle RMAN functionality to back up databases. Veeam
Plug-in will automatically transfer the backup files to the Veeam backup repository. For more information about
configuring Veeam Plug-in, see Configuring Veeam Plug-in for Oracle RMAN.

The examples given below are for demonstration purposes only. The backup process is performed on the Oracle
RMAN side. Consider configuring required RMAN-specific parameters that may affect the backup process. For
details on the backup functionality of Oracle RMAN, see this Oracle article.

NOTE

Consider the following:

• In the Veeam Plug-in configuration wizard, you can enable/disable Veeam Plug -in Data Compression
and Deduplication. If you enable the Veeam Plug-in compression, do not use Oracle RMAN
integrated compression as well. It can slow down the backup and restore processes.
• It is Oracle's best practice to add the EXIT; command at the bottom of the script to shut down the
RMAN utility. Without the EXIT; command in the script, it is up to Oracle RMAN to decide when to
close the backup session, which can lead to multiple unclosed RMAN backup sessions.
• Backups created by Veeam Plug-ins cannot be used as a source for file to tape or backup to tape
jobs.

TIP

If you have configured the retention policy, run the DELETE OBSOLETE command after the database
backup to delete obsolete backups from the repository.

In this Section
• Oracle RMAN Full Backup

• Oracle RMAN Channel Allocation

• Backup Job in Veeam Backup & Replication

194 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Oracle RMAN Full Backup
After you configure Veeam Plug-in, you can use the Oracle RMAN functionality to back up databases. Veeam
Plug-in will automatically transfer the backup files to the Veeam backup repository. For more information about
configuring Veeam Plug-in, see Configuring Veeam Plug-in for Oracle RMAN.

You can create a consistent backup of Oracle databases in the ARCHIVELOG mode and in the NOARCHIVELOG
mode. For details on the backup process in different modes, see this Oracle article.

NOTE

The examples given below are for demonstration purposes only. The backup process is performed on the
Oracle RMAN side. Consider configuring required RMAN-specific parameters that may affect the backup
process. For details on the backup functionality of Oracle RMAN, see this Oracle article.

Consistent Backup of Oracle Database in ARCHIVELOG Mode

To create a consistent backup of an Oracle database and redo logs in the ARCHIVE LOG mode, run the following
script. In this example, Oracle RMAN will back up the entire database and available archived redo logs. The
current online redo log will be archived to make sure all redo changes are transferred to the archived redo log
chain. In the ARCHIVELOG mode, there will be no downtime as you do not have to shut down the database.

RUN {
BACKUP DATABASE PLUS ARCHIVELOG;
}
EXIT;

Consistent Backup of Oracle Database in NOARCHIVELOG

Mode
To create a consistent backup of an Oracle database operating in the NOARCHIVELOG mode, start the Oracle
RMAN console and run the following script. In this example, the database instance will be started after the
backup process is complete. Note that the database will be unavailable during the backup.

RUN {
SHUTDOWN TRANSACTIONAL;
STARTUP MOUNT;
BACKUP DATABASE;
STARTUP;
}
EXIT;

195 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Oracle RMAN Channel Allocation
You can manually allocate RMAN channels by using the ALLOCATE CHANNEL command. This approach helps
optimize backup operations and resource allocation. Specify the Veeam backup repository universal unique
identifier (UUID) in the channel parameters to direct backup operations to the intended backup repository.

IMP ORTANT

Keep in mind that the ALLOCATE CHANNEL command must be issued only within a RUN block for a specific
backup operation.

To manually allocate RMAN channels, do the following:

1. Open the RUN block.

2. Use the ALLOCATE CHANNEL command and specify the following parameters:

a. Specify the channel ID. For example: ch1.

b. Specify the SBT_TAPE option for the DEVICE TYPE parameter.

c. Specify PARMS to define other parameters for the sbt_tape channel.

d. Specify which media library must be used for this sbt_tape channel.

▪ [For Linux and Unix] Set the path to the libOracleRMANPlugin.so file as the SBT_LIBRARY.

▪ [For Microsoft Windows] Set the path to

%PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN\OracleRMANPlugin.dll.

e. Specify the Veeam backup repository UUID in the argument for the FORMAT parameter. You can find
the required backup repository UUID in the rman_config.txt file or in log files.

▪ [For Linux and Unix] If you have exported Veeam Plug -in configuration files, run the following
command to see the contents of the configuration file.

cat /tmp/rman_config.txt

Alternatively, you can find the repository UUID in log files:

grep "received repos" /tmp/veeam_plugin_logs/oracle/OracleRMANConfig

Tool.log | tail

▪ [For Microsoft Windows] If you have exported Veeam Plug -in configuration files, find the
channel allocation definition in the configuration file.

Alternatively, you can find the repository UUID in log files. Go to the
%\ProgramData\Veeam\Backup\RmanPluginLogs\SERV_NAME directory and search for
"received repos id" in the OracleRMANConfigToolLib.log file.

3. Use the BACKUP DATABASE command to create a database backup.

4. [Optional] Use the RELEASE CHANNEL command. By default, RMAN automatically releases all channels
when the RUN command terminates.

5. Close the RUN block.

196 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

To learn more about channel allocation, see Oracle documentation.

197 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Examples
Example 1. Allocating Single Channel for Backup Operations

In this example, the RUN block contains the following commands:

• ALLOCATE CHANNEL: this command allocates channel ch1 to the Veeam backup repository with UUID
d8338780-1aec-4c36-b17c-e1ea3ea2ca93.

• BACKUP DATABASE: this command backs up the specified database.

• RELEASE CHANNEL: this command releases the allocated channel ch1 to optimize resources.

RUN {
ALLOCATE CHANNEL ch1 DEVICE TYPE SBT_TAPE
PARMS 'SBT_LIBRARY=/opt/veeam/VeeamPluginforOracleRMAN/libOracleRMA
NPlugin.so' FORMAT 'd8338780-1aec-4c36-b17c-e1ea3ea2ca93/RMAN_%I_%d_%T_%U
.vab';
BACKUP DATABASE;
RELEASE CHANNEL ch1;
}
EXIT;

Example 2. Allocating Multiple Channels for Backup Operations

In this example, the RUN block contains the following commands:

• ALLOCATE CHANNEL: this command allocates channels ch1 and ch2 simultaneously to the Veeam backup
repository with UUID d8338780-1aec-4c36-b17c-e1ea3ea2ca93.

• BACKUP DATABASE: this command backs up the specified database.

• RELEASE CHANNEL: this command releases the allocated channels ch1 and ch2 to optimize resources.

RUN {
ALLOCATE CHANNEL ch1 DEVICE TYPE SBT_TAPE
PARMS 'SBT_LIBRARY=/opt/veeam/VeeamPluginforOracleRMAN/libOracleRMA
NPlugin.so' FORMAT 'd8338780-1aec-4c36-b17c-e1ea3ea2ca93/RMAN_%I_%d_%T_%U
.vab';
ALLOCATE CHANNEL ch2 DEVICE TYPE SBT_TAPE
PARMS 'SBT_LIBRARY=/opt/veeam/VeeamPluginforOracleRMAN/libOracleRMA
NPlugin.so' FORMAT 'd8338780-1aec-4c36-b17c-e1ea3ea2ca93/RMAN_%I_%d_%T_%U
.vab';
BACKUP DATABASE;
RELEASE CHANNEL ch1;
RELEASE CHANNEL ch2;
}
EXIT;

Example 3. Allocating Single Channel and Using Multiple Repositories for Backup
Operations

198 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

In this example, the RUN block contains the following commands:

• ALLOCATE CHANNEL: this command allocates channel ch1 to two Veeam backup repositories with UUIDs
d8338780-1aec-4c36-b17c-e1ea3ea2ca93 and 4f85d62e-bd3c-46da-9cdd-53873faf4214
simultaneously.

• BACKUP DATABASE: this command backs up the specified database.

• RELEASE CHANNEL: this command releases the allocated channel ch1 to optimize resources.

RUN {
ALLOCATE CHANNEL ch1 DEVICE TYPE SBT_TAPE
PARMS 'SBT_LIBRARY=/opt/veeam/VeeamPluginforOracleRMAN/libOracleRMA
NPlugin.so' FORMAT 'd8338780-1aec-4c36-b17c-e1ea3ea2ca93/RMAN_%I_%d_%T_%U
.vab','4f85d62e-bd3c-46da-9cdd-53873faf4214/RMAN_%I_%d_%T_%U.vab';
BACKUP DATABASE;
RELEASE CHANNEL ch1;
}
EXIT;

Example 4. Allocating Single Channel for Backup Operations in Microsoft Windows

Environment

In this example for Microsoft Windows environments, the RUN block contains the following commands:

• ALLOCATE CHANNEL: this command allocates channel ch1 to the Veeam backup repository with UUID
d8338780-1aec-4c36-b17c-e1ea3ea2ca93.

• BACKUP DATABASE: this command backs up the specified database.

• RELEASE CHANNEL: this command releases the allocated channel ch1 to optimize resources.

RUN {
ALLOCATE CHANNEL ch1 DEVICE TYPE SBT_TAPE
PARMS 'SBT_LIBRARY=%PROGRAMFILES%\Veeam\VEEAMP~2\ORACLE~2.DLL' FORMA
T 'd8338780-1aec-4c36-b17c-e1ea3ea2ca93/RMAN_%I_%d_%T_%U.vab';
BACKUP DATABASE;
RELEASE CHANNEL ch1;
}
EXIT;

199 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Backup Job in Veeam Backup & Replication
TIP

If you want to configure or manage an application backup policy for Veeam Plug -in operating in the
managed mode, see Working with Application Policies.

After you start a backup process in Oracle RMAN, Veeam Backup & Replication creates a backup job. You can use
this job to view the statistics on the backup process, generate backup job reports or you can also disable the
backup job.

You cannot start or edit Oracle RMAN backup jobs in the Veeam Backup & Replication console. You can manage
backup operations only on the Oracle side using RMAN.

Consider the following regarding the naming of Oracle RMAN backup jobs:

• For a standalone Oracle RMAN server, Veeam Backup & Replication generates the backup job name based
on names of the Oracle RMAN server and selected repository.

• For Oracle RAC, Veeam Backup & Replication generates the backup job name based on single client access
name (SCAN) of the cluster.

NOTE

The progress bar of a running Oracle database backup job is available onl y for backups of standalone Oracle
databases. It is not available for Oracle RAC backups.

Viewing Backup Job Statistics

To view details of a backup job process, do the following:

1. Open the Veeam Backup & Replication console.

2. In the Home view, expand the Job s node and click Ba ckup.

200 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 3. In the list of jobs, select the Oracle RMAN backup job to see details of the current backup process or the
last backup job session.

Generating Backup Job Reports

Veeam Backup & Replication can generate reports with details about an Oracle RMAN backup job session
performance. The session report contains the following session statistics: session duration details, details of the
session performance, amount of read, processed and transferred data, backup size, compression ratio, list of
warnings and errors (if any).

To generate a report, do the following:

1. Open the Home view.

2. In the inventory pane, select Job s .

201 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 3. In the working area, select the necessary job and click Rep ort on the ribbon. You can also right-click the
job and select Rep ort.

Disabling Backup Job

You can disable Oracle RMAN backup jobs in the Veeam Backup & Replication console. If you disable the job, you
will not be able to run RMAN backup commands on the Oracle server.

To disable a backup job, do the following:

1. Open the Home view.

2. In the inventory pane, select Job s .

202 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 3. In the working area, select the necessary job and click Disable on the ribbon. You can also right-click the
job and select Disable.

203 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Database Recovery
With the configured Veeam Plug-in for Oracle RMAN, you can perform all kinds of database restore operations
available in Oracle RMAN. You can also restore from database backups in the Veeam Backup & Replication
console.

In This Section
• Restore to Original Server

• Restore to Another Server

• Restore from Backup Copy

• Restore with Veeam Explorer for Oracle

• Restore of Control File from Autobackup

• Restore from Hardened Repository

204 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Restore to Original Server
Veeam Plug-in for Oracle RMAN allows you to restore databases using built-in Oracle RMAN functionality. When
you launch a restore, RMAN restores the necessary database from the backup stored in the Veeam backup
repository.

If you want to change the repository or channel settings, you must modify the Veeam Plug -in settings. For
details, see Configuring Veeam Plug-in for Oracle RMAN.

To restore the Oracle database, you must connect to the database with RMAN and run the restore command.
You may need to run additional commands depending on your database infrastructure. Consider configuring
required RMAN-specific parameters that may affect the backup process. For details on all restore capabilities of
Oracle RMAN, see this Oracle article.

RUN {
SHUTDOWN IMMEDIATE;
STARTUP MOUNT;
RESTORE DATABASE;
RECOVER DATABASE;
}
EXIT;

NOTE

If you use the SEND command on the target server to point to the source server, you can run operations
like DUPLICATE. For details, see Restore to Another Server.

205 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Restore to Another Server
If you want to restore Oracle databases from a Veeam Plug -in backup to another server, see this Oracle article
and consider the specifics described in this section.

IMP ORTANT

Consider the following:

• Veeam Plug-in must be installed and configured on the target server.

• You can restore a database to the target server only if it runs the same OS as the original server. For
example, you cannot restore a database from the Windows-based system to the Linux-based system.

This limitation also applies to Linux distributions. The target server must run the same distribution as
the original server. For example, you cannot restore a database from the server running Oracle Linux
to the target server running CentOS.

To restore an Oracle database to another server, use the following commands:

1. ALLOCATE CHANNEL. Use this command to manually allocate a channel or channels between RMAN and
the database instance. Specify the following parameters:

a. Assign an ID for the channel. For example: ch1.

b. Specify the SBT_TAPE option for the DEVICE TYPE or TYPE parameter.

c. Specify PARMS to define other parameters for the sbt_tape channel.

d. Specify which media library must be used for this sbt_tape channel. For Linux or Unix, set the path
to the libOracleRMANPlugin.so file as the SBT_LIBRARY. For Microsoft Windows, set the path to
%PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN\OracleRMANPlugin.dll.

2. SEND. Use this command with the srcBackup=BackupID parameter to specify the ID of the backup from
which you want to restore a database. For example: "srcBackup=6109d377-93b5-4741-a796-
03471d2795cd".

To obtain a backup ID, do the following:

a. Specify an authentication method to access the backup created for the original server. For details, see
Specifying Authentication Settings.

b. Select the backup from which you want to restore a database. For details, see Selecting Backup.

IMP ORTANT

The ALLOCATE CHANNEL and SEND commands must be issued only within a RUN block for a specific
restore operation.

206 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

The following examples show scripts for restoring the control file and restoring the Oracle database to another
server using the SEND command in different OSes:

• For Linux and Unix machines:

RUN {
ALLOCATE CHANNEL ch1 TYPE sbt_tape PARMS "SBT_LIBRARY=/opt/veeam/Veea
mPluginforOracleRMAN/libOracleRMANPlugin.so";
SEND "srcBackup=6109d377-93b5-4741-a796-03471d2795cd";
SET CONTROLFILE AUTOBACKUP FORMAT FOR DEVICE TYPE 'SBT_TAPE' TO '%F_RM
AN_AUTOBACKUP.vab';
RESTORE controlfile FROM 'c-4097408439-20200410-00_RMAN_AUTOBACKUP.vab
';
}
EXIT;

• For Microsoft Windows machines:

RUN {
ALLOCATE CHANNEL ch1 TYPE sbt_tape PARMS "SBT_LIBRARY=%PROGRAMFILES%\
Veeam\VeeamPluginforOracleRMAN\OracleRMANPlugin.dll";
SEND "srcBackup=6109d377-93b5-4741-a796-03471d2795cd";
SET CONTROLFILE AUTOBACKUP FORMAT FOR DEVICE TYPE 'SBT_TAPE' TO '%F_RM
AN_AUTOBACKUP.vab';
RESTORE controlfile FROM 'c-4097408439-20200410-00_RMAN_AUTOBACKUP.vab
';
}
EXIT;

Consider the following:

• If you do not use the SEND command, Veeam Plug-in will restore data from a backup created for the
server on which Veeam Plug-in is currently running instead of restoring data from a backup created on
another server.

• For restore to another server, you can use either backups or backup copies of Oracle databases.

• If you perform restore from a backup that was imported to Veeam Backup & Replication, Veeam Plug -in
will automatically create the backup job in Veeam Backup & Replication.

• During the restore process, backup operations are not disabled on the Oracle server.

Specifying Authentication Settings

To restore databases to another server, you must specify an authentication method to access the backup created
for the original server. Veeam Plug-in for Oracle RMAN supports the following authentication methods to access
backups:

• Using credentials of the account under which the backup was created. For more information, see
Specifying Credentials.

This option is intended for backups created using Oracle RMAN commands on the Oracle server.

207 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 • Using a recovery token. For more information, see Specifying Recovery Token.

This option is intended for backups created using an applica tion backup policy configured in Veeam
Backup & Replication. To use this option, a backup administrator must create a recovery token for the
backup in Veeam Backup & Replication.

Specifying Credentials
To restore a database to another server, you can specify credentials of a user account under which the backup
was created. To do this, do the following:

1. Access the Veeam Plug-in for Oracle RMAN directory on your machine. The path to the directory differs
depending on the OS of the machine where Veeam Plug -in is installed:

o On machines running Linux or Unix OS: /opt/veeam/VeeamPluginforOracleRMAN

o On machines running Microsoft Windows OS:

%PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN

2. Run the following command:

OracleRMANConfigTool --set-auth-data-for-restore

3. Veeam Plug-in will prompt you to select an authentication method to access the backup.

If you want to access the backup using account credentials, the account must meet the following
requirements:

o The account must either have the Veeam Backup Administrator , or both the Veeam Backup Operator
and Veeam Restore Operator roles. You can also use the account under which the backup was created.
For more information on how to assign Veeam Backup & Replication roles, see the Users and Roles
section in the Veeam Backup & Replication User Guide.

o The account must have access permissions to the backup repository where the backup is stored. For
more information, see Access and Encryption Settings on Repositories.

To access the backup using account credentials, type 1:

Select authentication type or disable the functionality:

0. To disable the functionality
1. Credentials
2. Recovery token
Enter authentication type number:
1

4. Veeam Plug-in will prompt you to provide credentials of the user account that under which the backup
was created. Enter a user name and password of the account:

Enter username:
Enter password for <username>:

208 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Specifying Recovery Token
You can restore a database to another server using a recovery token generated in Veeam Backup & Replication
and provided to you by a backup administrator. To do this, do the following:

1. Access the Veeam Plug-in for Oracle RMAN directory on your machine. The path to the directory differs
depending on the OS of the machine where Veeam Plug -in is installed:

o On machines running Linux or Unix OS: /opt/veeam/VeeamPluginforOracleRMAN

o On machines running Microsoft Windows OS:

%PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN

2. Run the following command:

OracleRMANConfigTool --set-auth-data-for-restore

3. Veeam Plug-in will prompt you to select an authentication method to access the backup. To access the
backup using a recovery token, type 2:

Select authentication type or disable the functionality:

0. To disable the functionality
1. Credentials
2. Recovery token
Enter authentication type number:
2

4. Veeam Plug-in will display the fingerprint of the Veeam Backup & Replication server and prompt you to
provide a recovery token:

Veeam Backup & Replication server fingerprint: CA4F820F164C02A9AAC75562FC3

5330A93CDAA3C.
Continue? (y/n) : y
Enter recovery token:
The specified authentication data will be used automatically to access bac
kups over the SEND command

Selecting Backup
After you specify authentication settings to access the backup from which you want to restore a database on
another server, you can select the backup. To do this, do the following:

1. Access the Veeam Plug-in for Oracle RMAN directory on your machine. The path to the directory differs
depending on the OS of the machine where Veeam Plug -in is installed:

o On machines running Linux or Unix OS: /opt/veeam/VeeamPluginforOracleRMAN

o On machines running Microsoft Windows OS:

%PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN

2. Run the following command:

OracleRMANConfigTool --get-backup-for-restore

209 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 3. Veeam Plug-in will display backups available for restore. The list of backups depends on the
authentication settings that you specified:

o If you specified credentials of a user account that has the Veeam Backup Administrator or Veea m
Restore Operator role assigned in Veeam Backup & Replication, Veeam Plug -in displays all backups
that reside in the backup repository. Otherwise, Veeam Plug-in displays backups created under the
specified user account.

o If you specified a recovery token, Veeam Plug-in displays backups for which the recovery token was
generated.

Select the backup to obtain the backup ID:

Select backup to be used:

1. Backup1 Oracle backup (Default Backup Repository)
2. Backup2 Oracle backup (Default Backup Repository)
3. Backup3 Oracle backup (Default Backup Repository)
Enter backup number: 3
To perform restore operations, use ID of the selected backup from the exam
ple below as srcBackup parameter value in SEND command:
ALLOCATE CHANNEL ch1 DEVICE TYPE SBT_TAPE PARMS 'SBT_LIBRARY=/opt/veeam/Ve
eamPluginforOracleRMAN/libOracleRMANPlugin.so';
SEND 'srcBackup=6109d377-93b5-4741-a796-03471d2795cd';

210 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Restore from Backup Copy
You can restore Oracle databases from backup copies created for Veeam Plug -in for Oracle RMAN backups. The
procedure of database restore from a backup copy is the same as database restore to another server. For more
information, see Restore to Another Server.

211 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Restore with Veeam Explorer for Oracle
You can restore Oracle databases from Veeam Plug -in backups in the Veeam Backup & Replication console. To
restore Oracle databases Veeam Backup & Replication uses Veeam Explorer for Oracle. For details, see the
Restoring Oracle RMAN Backups section in the Veeam Explorers User Guide.

IMP ORTANT

Consider the following limitations:

• Veeam Explorer for Oracle does not support restore of encrypted Oracle databases.
• Veeam Explorer for Oracle does not support restore of Oracle databases deployed on Solaris OS and
IBM AIX. You can restore Oracle databases on Solaris OS and IBM AIX only with RMAN. For more
information, see Restore to Original Server.

TIP

Consider the following:

• To perform restore from Oracle databases you can also use Veeam Explorer cmdlets. For details, see
the Veeam Explorer for Oracle section of the Veeam Explorers PowerShell Reference.

• For details on Veeam Explorer for Oracle, see the Veeam Explorer for Oracle section in the Veeam
Explorers User Guide.

212 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Restore of Control File from Autobackup
You may need to restore the Oracle database control file in the following cases:

• If you want to restore the database to a new location where the control file does not exist.

• If the database control file is lost or corrupted.

If you use Veeam Plug-in for Oracle RMAN and want to restore the Oracle database control file from
autobackup, the autobackup format must be set to the SBT_TAPE device type.

To check if persistent configuration for the control file autobackup format is set to the SBT_TAPE device type,
you can run the SHOW ALL or SHOW CONTROLFILE AUTOBACKUP FORMAT commands in the RMAN console. If
the persistent configuration is set, you don't need to set the control file autobackup format before the restore
command. If it is not set, you must run the SET CONTROLFILE AUTOBACKUP command before the restore
process. For more information, see Example 1. Restoring Control File if Persistent Configuration Setting Is NOT
Set.

If you do not have the autobackup file name for the restore script, you can restore using the creation date of the
autobackup file. For more information, see Example 3. Restoring Control File Without Autobackup File Name.

NOTE

To restore the control file from autobackup, the database must be in the NOMOUNT state.

213 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Examples
Example 1. Restoring Control File if Persistent Configuration Setting is NOT Set

If the persistent configuration for the control file autobackup format is not set to the SBT_TAPE device type,
you must set the autobackup format before running the control file restore. To do this, run one of the following
scripts, depending on your OS.

• For Linux and Unix machines:

RUN {
ALLOCATE CHANNEL ch1 DEVICE TYPE SBT_TAPE PARMS 'SBT_LIBRARY=/opt/veeam/Ve
eamPluginforOracleRMAN/libOracleRMANPlugin.so';
SET CONTROLFILE AUTOBACKUP FORMAT FOR DEVICE TYPE 'SBT_TAPE' TO '%F_RMAN_A
UTOBACKUP.vab';
RESTORE controlfile FROM 'c-4097408439-20200410-00_RMAN_AUTOBACKUP.vab';
}
EXIT;

• For Microsoft Windows machines:

RUN {
ALLOCATE CHANNEL ch1 DEVICE TYPE SBT_TAPE PARMS 'SBT_LIBRARY=%PROGRAMFILES
%\Veeam\VEEAMP~2\ORACLE~2.DLL';
SET CONTROLFILE AUTOBACKUP FORMAT FOR DEVICE TYPE 'SBT_TAPE' TO '%F_RMAN_A
UTOBACKUP.vab';
RESTORE controlfile FROM 'c-4097408439-20200410-00_RMAN_AUTOBACKUP.vab';
}
EXIT;

Example 2. Restoring Control File if Persistent Configuration Setting is Set

214 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

If persistent configuration for the control file autobackup format is set to the SBT_TAPE device type, you can
restore with one of the following scripts, depending on your OS.

• For Linux and Unix machines:

RUN {
ALLOCATE CHANNEL ch1 DEVICE TYPE SBT_TAPE PARMS 'SBT_LIBRARY=/opt/veeam/Ve
eamPluginforOracleRMAN/libOracleRMANPlugin.so';
RESTORE controlfile FROM 'c-4097408439-20200410-00_RMAN_AUTOBACKUP.vab';
}
EXIT;

• For Microsoft Windows machines:

RUN {
ALLOCATE CHANNEL ch1 DEVICE TYPE SBT_TAPE PARMS 'SBT_LIBRARY=%PROGRAMFILES
%\Veeam\VEEAMP~2\ORACLE~2.DLL';
RESTORE controlfile FROM 'c-4097408439-20200410-00_RMAN_AUTOBACKUP.vab';
}
EXIT;

Example 3. Restoring Control File Without Autobackup File Name

215 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

If you do not have the autobackup file name to include in the restore script, you can set RMAN to search for the
autobackup file within a certain time period. In this case, you must set the database ID (DBID) before you
restore. To learn how to find DBID, see this Oracle article.

Using one of the example scripts below, depending on your OS, y ou can search for the autobackup file that was
created yesterday. If such autobackup file is not detected, RMAN will search for autobackup files that were
created earlier, up to 30 days ago.

Keep in mind that the example below is applicable only if persistent configuration for the control file
autobackup format is set to the SBT_TAPE device type.

• For Linux and Unix machines:

RUN {
ALLOCATE CHANNEL ch1 DEVICE TYPE SBT_TAPE PARMS 'SBT_LIBRARY=/opt/veeam/Ve
eamPluginforOracleRMAN/libOracleRMANPlugin.so';
RESTORE until time 'sysdate-1' CONTROLFILE FROM AUTOBACKUP maxdays 30;
}
EXIT;

• For Microsoft Windows machines:

RUN {
ALLOCATE CHANNEL ch1 DEVICE TYPE SBT_TAPE PARMS 'SBT_LIBRARY=%PROGRAMFILES
%\Veeam\VEEAMP~2\ORACLE~2.DLL';
RESTORE until time 'sysdate-1' CONTROLFILE FROM AUTOBACKUP maxdays 30;
}
EXIT;

Once the autobackup file is detected, RMAN uses it to restore the control file.

See Also
If you did not find an example that suits your needs, refer to Oracle documentation:

• For details on restoring the control file, see this Oracle article.

• For details on the control file autobackup format, see this Oracle article.

216 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Restore from Hardened Repository
As a result of malware activity or unplanned actions, backup job metadata (VACM) files may become unavaila ble
in the hardened repository. In this case, to restore data from the hardened repository, you must re -create the
VACM file. To do this, complete the following steps:

1. Run a Veeam Plug-in backup job to create a new Veeam Plug-in backup in a Veeam backup repository. The
backup will consist of the .VAB, .VASM and .VACM files.

2. In the backup repository folder, replace the .VAB and .VASM files created at the step 1 with the .VAB and
.VASM files from the hardened repository.

3. In the Veeam backup console, run the backup repair operation. Veeam Backup & Replication will generate
a new .VACM file using information from the .VASM files. For details, see Repairing Backup.

Once the backup job metadata file is re-created, you can use Veeam Plug-in to restore your data.

Repairing Backup
If you want to restore data from an immutable backup that resides in a hardened repository, you can use the
Rep air operation. During this operation, Veeam Backup & Replication will generate a new backup job metadata
(.VACM) file using information from the backup metadata (.VASM) files.

IMP ORTANT

This operation is intended only for a situation where the backup job metadata file has been lost as a result
of malware activity or unplanned actions. Re-creation of the backup job metadata file for other purposes is
not supported.

Before you start the repair operation, you must disable the backup job that created the backup. Otherwise,
Veeam Backup & Replication will display a message notifying that the job must be disabled.

To repair a backup:

1. In the Veeam Backup & Replication console, open the Home view.

2. In the inventory pane, select Ba ckups.

3. In the working area, select the necessary backup.

4. Press and hold the [Ctrl] key, right-click the backup and select Rep air.

217 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 5. If you plan to restore Oracle databases using Veeam Explorer for Oracle and your backups reside on a
scale-out backup repository expanded with capacity tier, rescan the backup repository. To learn more
about rescan, see the Rescanning Backup Repositories section in the Veeam Backup & Replication guide.

218 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Retention of RMAN Backups and Archived
Logs
In the main scenario, when using Veeam Plug-in for Oracle RMAN, you must configure retention policies for
RMAN backups and archived redo logs using native Oracle RMAN functionality:

• Configuring Retention Policy

• Configuring Archived Redo Log Retention

Also, you can manually delete backups from a backup repository using the Veeam Backup & Replication console
and enable the force deletion functionality of Veeam Plug -in for Oracle RMAN. For details, see the following
sections:

• Configuring Force Deletion of Backups

• Deleting Backups Manually

• Removing Backups from Configuration

219 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Configuring Retention Policy
If you want to edit a retention policy for Oracle RMAN backups, you must connect to the target database in
RMAN console and configure one of the following retention policies:

• Red undancy-Based Retention: The redundancy parameter specifies how many full or level 0 backups of
each data file and control file should RMAN keep in the repository. If the number of backups exceeds the
specified value, RMAN considers the oldest backups as obsolete. By default, the redundancy parameter is
set to 1. To configure a redundancy-based retention policy, run the following command:

CONFIGURE RETENTION POLICY TO REDUNDANCY 7;

• Recovery Window-Based Retention: The recovery window parameter specifies the number of days
between the current time and the earliest point of recoverability. RMAN does not consider any full or level
0 incremental backups as obsolete if it falls within the recovery window. To configure a window -based
retention policy, run the following command:

CONFIGURE RETENTION POLICY TO RECOVERY WINDOW OF 7 days;

NOTE

Make sure that the value set for the CONTROL_FILE_RECORD_KEEP_TIME parameter in the control
file is greater than the recovery window. Otherwise, the retention policy will not be applicable as the
backup records will be always overwritten earlier than they can be considered obsolete by the
retention policy. To learn more, see this Oracle article (requires an Oracle Support account).

Deleting Obsolete Backups

To delete obsolete backups, run the following command after each backup:

DELETE OBSOLETE;

Disabling Retention Policy

To disable retention policy for RMAN backups, run the following command:

CONFIGURE RETENTION POLICY TO NONE;

For details, see this Oracle article.

220 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Configuring Archived Redo Log Retention
By default, archivelog deletion policy is disabled.

To configure archivelog deletion policy, run the following command. When the number of archived logs exceeds
the specified number, RMAN deletes the oldest archived log.

CONFIGURE ARCHIVELOG DELETION POLICY TO BACKED UP 3 TIMES TO SBT;

To delete obsolete archivelogs, run the following command. If you do not run this command, the archived logs
will be deleted from the fast recovery area (FRA) only.

DELETE ARCHIVELOG ALL;

To disable archivelog deletion policy, run the following command:

CONFIGURE ARCHIVELOG DELETION POLICY TO NONE;

For details, see this Oracle article.

221 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Configuring Force Deletion of Backups
In the main scenario, when using Veeam Plug-in for Oracle RMAN, you must configure the retention policy using
native Oracle RMAN tools. For details, see Configuring Retention Policy.

Veeam Plug-in for Oracle RMAN has a functionality that automatically force deletes backup files which are older
than specified number of days. For example, you can use it if a backup repository contains backup files that are
no longer in the backup catalog.

To enable force deletion of backup files, do the following:

1. On the Oracle server, run the following command.

o For Linux and Unix:

OracleRMANConfigTool --set-force-delete

o For Microsoft Windows:

OracleRMANConfigTool.exe --set-force-delete

By default, the OracleRMANConfigTool.exe file is located in

%PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN.

2. Enter the number of days after which Veeam Plug-in will force delete backup files on all configured
Veeam backup repositories.

Garbage collector automatically deletes backup files older than the specif
ied number of days.
Make sure the number of days value exceeds your retention policy.
To disable this functionality, set the number of days to 0.
Enter the number of days to delete backups after, between 7 and 999 [0]:

By default, the force delete functionality is disabled (set to 0).

IMP ORTANT
• A value for the numb er of days setting must be at least 1 backup generation period longer than the
retention period for your Oracle Database backups. Otherwise, Veeam Plug -in will delete earliest
backups created within the retention period.
• If a backup repository contains backups older than the specified retention period, Veeam Plug-in
removes old backup files only after the next run of the RMAN backup.

222 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Deleting Backups Manually
If you want to delete backups files, you can use the Oracle RMAN housekeeping functionality. For details, see
this Oracle article.

If you have lost the recovery catalog, you can remove the backups manually from a Veeam backup repository.

IMP ORTANT

If you remove backups from a Veeam backup repository manually, the metadata about these backups is
NOT deleted from the recovery catalog. Thus, if you have a recovery catalog, it is not recommended to
manually delete backup files. Otherwise, the recovery catalog will remain in the outdated state.

To remove a backup from Veeam backups repository, do the following:

1. In the Veeam Backup & Replication console, open the Home view.

2. In the Inventory pane, select Ba ckups.

3. In the working area, right-click the backup job object name and select Delete from disk.

223 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Removing Backups from Configuration
If you want to remove records about backups from the Veeam Backup & Replication console and configuration
database, you can use the Remove from configuration operation.

When you remove a backup from the configuration, backup files (.VAB, .VASM, .VACM) remain on the backup
repository. You can import the backup later and restore data from it.

To remove a backup from configuration:

1. Open the Home view.

2. In the inventory pane, select Ba ckups.

3. In the working area, select the necessary backup.

4. Press and hold the [Ctrl] key, right-click the backup and select Remove from configuration.

224 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Backup Copy for Oracle RMAN Backups
Having just one backup does not provide the necessary level of safety. The primary backup may get destroyed
together with production data, and you will have no backups from which you can restore data.

To build a successful data protection and disaster recovery plan, it is recommended that you follow the 3-2-1
rule:

• 3: You must have at least three copies of your data: the original production data and two backups.

• 2: You must use at least two different types of media to store the copies of your data, for example , local
disk and cloud.

• 1: You must keep at least one backup offsite, for example, in the cloud or in a remote site.

Thus, you must have at least two backups and they must be in different locations. If a disaster takes out your
production data and local backup, you can still recover from your offsite backup.

In This Section
• Creating Backup Copy Job

• Converting Backup Copy to Backup

225 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Creating Backup Copy Job
Veeam Backup & Replication offers the backup copy functionality that allows you to create several instances of
the same backup in different locations, whether onsite or offsite. Backup copies have the same format as those
created by backup jobs and you can recover your data from them when you need it.

Veeam Backup & Replication fully automates the backup copy process and lets you specify retention settings to
maintain the desired number of restore points, as well as full backups for archival purposes. Backup copy is a
job-driven process. When enabled, the backup copy job for Veeam Plug-in backups runs continuously. For more
details on how it works, see the Backup Copy section in the Veeam Backup & Replication User Guide.

To copy backups to a secondary location, you must configure a backup copy job. The backup copy job defines
how, where and when to copy backups. One job can be used to process backups of one or more machines.

You can configure a job and start it immediately or save the job to start it later.

Before creating a job, check prerequisites. Then use the New Backup Copy Job wizard to configure a backup
copy job.

1. Launch Backup Copy Job wizard.

2. Specify a job name and description.

3. Select backups to process.

4. Define backup copy target.

5. Specify advanced settings.

6. Define backup copy schedule.

7. Finish working with the wizard.

Before You Begin

Before you create a backup copy job, check the prerequisites and limitations:

• Backup infrastructure components that will take part in the backup copy process must be added to the
backup infrastructure and properly configured. These include source and target backup repositories
between which backups must be copied.

• The target backup repository must have enough free space to store copied backups. To receive alerts
about low space on the backup repository, configure global notification settings. For more information,
see Specifying Other Notification Settings.

226 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 1. Launch Backup Copy Job Wizard
To create a backup copy job, do the following:

1. In the Veeam Backup & Replication console, open the Home view.

2. Click the Ba ckup Copy tab and select Ap p lication-level backup.

227 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 2. Specify Job Name and Description
At the Job step of the wizard, specify a name and description for the backup copy job.

1. In the Na me field, enter a name for the job.

2. In the Description field, enter a description for the job. The default description contains information about
the user who created the job, date and time when the job was created.

228 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 3. Select Backups to Process
At the Ob ject step of the wizard, select machines whose backups you want to copy to the target repository.

1. Click the Ad d button and select from which entity you want to process the machines.

o From jobs: You can select Veeam Plug-in backup jobs. When a backup copy job runs, Veeam Backup &
Replication will search for backup files created by selected jobs.

o From repositories: You can select repositories where Veeam Plug-in backups are stored. When a
backup copy job runs, Veeam Backup & Replication will search for backup files created by Veeam
Plug-in in selected repositories.

2. Use the Remove button if you want to remove selected jobs or repositories from processing.

3. If you have added jobs from a repository and want to exclude from processing some of the backup jobs on
the selected repository, click E x clusions and select the jobs that you want to exclude.

229 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 4. Define Backup Copy Target
At the Ta rget step of the wizard, configure the target repository settings.

1. From the Ba ckup repository list, select a backup repository in the target site where copied b ackups must
be stored. When you select a target backup repository, Veeam Backup & Replication automatically checks
how much free space is available on it. Make sure that you have enough free space to store copied
backups.

IMP ORTANT

For Veeam Plug-in backup copy jobs, you cannot select the following repositories as a backup copy
target:

• Veeam Cloud Connect repository

• Object storage repository

2. If the target repository contains a Veeam Plug-in or MongoDB backup that was excluded from the backup
copy job, and if you don't want to transfer duplicate data, you can use the mapping feature.

After you configure mapping, if some of backup files (.VAB) of the source backup are missing in the target
backup copy, these files are uploaded to the target backup copy.

NOTE

Veeam Plug-in backup copy jobs do not use WAN accelerators.

To map a backup copy job to the backup:

a. Click the Ma p backup link.

b. Point the backup copy job to the backup in the target backup repository. Backups in the target backup
repository can be easily identified by backup job names. To facilitate search, you can use the search
field at the bottom of the window.

IMP ORTANT

Keep in mind that repositories must meet the following requirements:

• Used account must have access to Veeam backup repositories that you plan to use.
• Encryption must be disabled on the repository.

Otherwise, the repositories will not be listed as available. To learn how to configure access
permissions and encryption settings on repositories, see Access Permissions in the Veeam Backup &
Replication User Guide.

230 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 3. You can specify the number of days after which the backup copy will be deleted from the repository. Note
that the countdown starts from the moment when source backup has been created.

231 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 5. Specify Advanced Settings
At the Ta rget step of the wizard, click Ad vanced to configure storage, RPO warning, and notifications settings.

• Storage settings

• RPO warning settings

• Notification settings

Storage Settings
At the Storage tab, define compression and deduplication settings.

By default, Veeam Backup & Replication performs deduplication before storing copied data on the target backup
repository. Deduplication provides a smaller size of the resulting backup file but may reduce the job
performance.

1. You can disable data deduplication. To do this, clear the E na ble inline data deduplication check box.

2. From the Compression level list, choose a compression level to be used: Auto, None, Dedupe-friendly,
Op timal, High or E x treme. The recommended level of compression for backup copy jobs is Auto. In this
case, Veeam Backup & Replication uses compression settings of the copied backup files. For more
information, see Compression and Deduplication.

RPO Warning Settings

At the RP O Monitor tab, specify RPO warning settings.

232 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Enable the W a rn me if backup is not copied within check box and specify the time period in minutes, hours, or
d a ys.

If the backup copy is not created within the specified time period, the backup copy job will finish with the
Warning status. The countdown starts from the moment when the required backup is finished and ready to be
copied.

Notification Settings
At the Notifications tab, to specify notification settings for the backup copy job:

1. At the Ta rget step of the wizard, click Ad vanced.

2. Click the Notifications tab.

3. Select the Send SNMP notifications for this job check box if you want to receive SNMP traps when the job
completes successfully. SNMP traps will be sent if you specify global SNMP settings in Veeam Backup &
Replication and configure software on recipient's machine to receive SNMP traps. For more information,
see Specifying SNMP Settings.

4. Select the Send email notifications to the following recipients check box if you want to receive
notifications by email in case of job failure or success. In the field below, specify a recipient email address.
You can enter several addresses separated by a semicolon.

5. Veeam Backup & Replication sends a consolidated email notification once for the specified backup copy
interval. Even if the synchronization process is started several times within the interval, for example, due
to job retries, only one email notification will be sent.

6. Email notifications will be sent if you configure global email notification settings in Veeam Backup &
Replication. For more information, see Configuring Global Email Notification Settings.

233 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 7. At the Send at field, specify the time when you want to receive notifications. Note that you will receive a
notification on the job status once a day.

8. You can choose to use global notification settings or specify custom notification settings.

o To receive a typical notification for the job, select Use global notification settings. In this case, Veeam
Backup & Replication will apply to the job global email notification settings specified for the backup
server. For more information, see Configuring Global Email Notification Settings.

o To configure a custom notification for a job, select Use custom notification settings specified below.
You can specify the following notification settings:

i. In the Sub ject field, specify a notification subject. You can use the following variables in the
subject: %Time% (completion time), %JobName%, %JobResult%, %VmCount% (number of
machines in the job) and %Issues% (number of machines in the job that have been processed
with the W a rning or Fa iled status).

ii. Select the Notify on success, Notify on warning and Notify on error check boxes to receive email
notification if data processing within the backup copy interval completes successfully, fails or
completes with a warning.

234 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 6. Define Backup Copy Schedule
At the Schedule step of the wizard, define a time span in which the backup copy job must not transport data
between source and target backup repositories. For more information, see Backup Copy Window.

To define a backup window for the backup copy job:

1. Select the During the following time p eriods only option.

2. In the schedule box, select the desired time area.

3. Use the E na ble and Disable options to mark the selected area as allowed or prohibited for the backup copy
job.

235 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 7. Review Backup Copy Job Settings
At the Summary step of the wizard, complete the procedure of backup copy job configuration.

1. Review details of the backup copy job.

2. Select the E na ble the job when I click Finish check box if you want to start the job right after you finish
working with the wizard.

3. Click Finish to close the wizard.

236 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Converting Backup Copy to Backup
If you have imported Veeam Plug-in backup copies from another server, you can convert them into regular
backup files. When you convert a backup copy to a backup, Veeam Plug -in creates a backup job with the
converted backup. You can use this backup job to continue a backup chain and use the converted backup as a
restore point.

You can convert and unbind Veeam Plug-in backups into regular Veeam Plug-in backup files in the following
cases:

• If you have deleted a backup copy job which created the backup copy.

• If you have excluded a backup job from a backup copy job that used multiple backup jobs as a source.

• If you imported a Veeam Plug-in backup copy from another host.

NOTE

If you want to restore from a backup copy, you don't need to convert the backup copy to backup. For
details, see Restore from Backup Copy.

Procedure
To convert a backup copy to a primary backup, use the --p romote-backup-copy-to-primary parameter as shown
below:

1. Run the Ora cleRMANConfigTool with the --p romote-backup-copy-to-primary parameter and type a
backup copy number from the list of available backup copies.

OracleRMANConfigTool --promote-backup-copy-to-primary
Backup copies available for promotion to the primary backup target:
1. Backup Copy Job 1\ORCLSERV01 Oracle backup (Default Backup Repository)
Select a backup copy: 1
Changes to be applied to the RMAN configuration
CONFIGURE CHANNEL DEVICE TYPE SBT_TAPE
PARMS 'SBT_LIBRARY=%PROGRAMFILES%\Veeam\VEEAMP~1\ORACLE~2.DLL'
FORMAT '94a7ac5a-2cb5-418b-8395-fb362d3aa182/RMAN_%I_%d_%T_%U.vab';
CONFIGURE CONTROLFILE AUTOBACKUP ON;
CONFIGURE CONTROLFILE AUTOBACKUP FORMAT FOR DEVICE TYPE SBT_TAPE TO '%F_RM
AN_AUTOBACKUP.vab';
CONFIGURE ARCHIVELOG BACKUP COPIES FOR DEVICE TYPE SBT_TAPE TO 1;
CONFIGURE DATAFILE BACKUP COPIES FOR DEVICE TYPE SBT_TAPE TO 1;
RMAN configuration to be applied:
SQL "alter system set backup_tape_io_slaves=false deferred scope=both";

237 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 2. Converting a backup copy into regular backup file, requires changes in the RMAN configuration. You can
allow the command to change RMAN configuration automatically, or you can change it manually. Select
one of the options:

Proceed with the action?

1. Promote backup copy destination to the primary backup target and apply
required configuration to RMAN automatically
2. Promote backup copy destination to the primary backup target and export
required RMAN configuration (RMAN will have to be configured manually)
3. Cancel
Enter selection: 1
Promoting backup copy destination
Configuring RMAN
Done

238 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Logs and Support
If you have any questions or issues with Veeam Plug-in for Oracle RMAN or Veeam Backup & Replication, you
can search for a resolution on Veeam Community Forums or submit a support case on the Veeam Customer
Support Portal.

When you submit a support case, we recommend you attach necessary logs related to Veeam Plug -in
operations.

To learn how to collect logs, see this Veeam KB.

239 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Veeam Plug-in for SAP on Oracle
Veeam Plug-in for SAP on Oracle is an SAP-certified backup tool for SAP applications running on Oracle
Database. Veeam Plug-in integrates with SAP BR*Tools and transfers database and log backups to repositories
connected to Veeam Backup & Replication.

TIP

If you want to protect the SAP server itself, you can use the image-level backup functionality of Veeam
Backup & Replication or Veeam Agent for Linux.

240 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Overview
Veeam Plug-in for SAP on Oracle functions as an agent between SAP BR*Tools and Veeam backup repositories.
With the configured Veeam Plug-in, you can use the SAP BR*Tools to perform backup and restore operations.
Veeam Plug-in compresses and transfers database backups to a backup repository connected to Veeam Backup
& Replication. To learn more, see How Veeam Plug-in for SAP on Oracle Works.

Veeam Plug-in for SAP on Oracle can operate in standalone or managed mode. Depending on the operation
mode, Veeam Plug-in has different functionality and limitations. In standalone mode, you can install Veeam
Plug-in manually on the computer whose databases you want to protect. Veeam Plug -in in standalone mode
uses the Veeam Backup & Replication console to perform backup operations. In managed mode, you can install
Veeam Plug-in using the Veeam Backup & Replication console. The Veeam Backup & Replication console
automates the operation of Veeam Plug-ins running on computers in your infrastructure. To learn more about
Veeam Plug-in operation modes, see Standalone and Managed Operations Modes.

For backup operations, use the SAP BR*Tools. Veeam Plug -in for SAP on Oracle transfers backup data to the
Veeam backup repository and stores the data in the Veeam proprietary format for backups. To learn more about
backup operations, see Data Backup.

In case of malware activity or unplanned actions, you can perform restore operations based on the backup dat a
transferred by Veeam Plug-in to the Veeam Backup & Replication backup repositories. All restore operations are
performed on the SAP BR*Tools side. To learn more about restore operations with Veeam Plug -in, see Data
Restore.

241 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

How Veeam Plug-in for SAP on Oracle Works
Veeam Plug-in for SAP on Oracle functions as an agent between SAP BR*Tools and Veeam backup repositories.
After you install and configure Veeam Plug-in, you can perform all backup and restore operations with
BR*Tools. Veeam Plug-in compresses database backups and transfers them to a backup repository connected to
Veeam Backup & Replication.

Veeam Plug-in for SAP on Oracle supports the following tools:

• brtools

• brbackup

• brrestore

• brarchive

For details about these tools, see this SAP article.

How Backup Operations Work

After you configure Veeam Plug-in for SAP on Oracle, SAP BR*Tools performs a backup in the following way:

1. When you launch a database backup, BRTOOLS starts the services of Veeam Plug -in.

2. Veeam Plug-in connects to the Veeam Backup & Replication server and creates a backup job object (if it
has not been created before). Veeam Backup & Replication administrators can use this backup job object
to monitor the backup process, manage backup files and copy the database backup to secondary
repositories.

3. BRTOOLS launches the backint BRBACKUP tool that uses the Veeam Plug -in configuration file as an
initialization profile.

4. Veeam Plug-in starts Veeam Data Mover on the SAP server and on the backup repository. Veeam Data
Movers create communication channels for each backup data stream. Depending on the number of
channels specified in Veeam Plug-in settings, there can be 1 or up to 32 parallel channels.

5. Veeam Data Movers transport database backup files to the backup repository.

242 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 IMP ORTANT

Some backup operations, such as backing up of profiles, log files, control files and performing incremental
backups of databases can be performed only with RMAN_UTIL. For details, see this SAP article.

For detail on how Veeam Plug-in for SAP on Oracle functions along with RMAN see, SAP on Oracle Backup
Using RMAN_UTIL.

243 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Data Backup
Veeam Plug-in for SAP on Oracle transfers backup data to the Veeam backup repository and stores the data in
the Veeam proprietary format for backups.

With Veeam Plug-in for SAP on Oracle, you can create a consistent backup of Oracle databases and
automatically transfer the backup files to the Veeam backup repository. Veeam Backup & Replication creates a
backup job for all backup processes started on the SAP on Oracle side. Use this job to view the statistics on the
backup process, generate backup job reports or disable the Oracle backup jobs. All backup processes are
performed on the SAP on Oracle side and are managed by the SAP BR*Tools. For details on how to back up
Oracle databases with Veeam Plug-in for SAP on Oracle, see Database Protection.

For each backup operation, Veeam Plug-in automatically creates and stores database backup files. For each of
the created backup files, Veeam Plug-in also creates separate metadata files. The backup and metadata files
help Veeam Plug-ins to store and manage backup data while ensuring that the data is protected, accessible, and
can be quickly restored when needed. All backup files created for backup jobs reside in a dedicated job folder in
the backup repository. For details on backup files, see Veeam Plug-in Backup Files.

To store backup files, you can add backup repositories to your Veeam Backup & Replication infrastructure. For
details on all supported backup repositories, see Veeam Backup Repositories.

Veeam Plug-in Backup Files

For every backup job within Veeam Backup & Replication, Veeam Plug -in creates and stores database backup
files and separate metadata files for each of the backup files. The backup files provide a consistent and
integrated way for Veeam Plug-ins to store and manage backup data, while ensuring that the data is protected,
accessible and can be quickly restored when needed.

All backup files created by the backup job reside in a dedicated job folder in the backup repository.

Backup Files Format

Veeam Plug-in stores backup files in the following formats:

• A .VAB file stores a compressed copy of an Oracle database. Veeam Plug -in creates .VAB files for full,
incremental and log backups.

• A .VASM file stores metadata that contain information about the backup. A .VASM file is created for each
.VAB backup file with the same name as the backup file. The .VASM files are used by Veeam Backup &
Replication to get data about Veeam Plug-in backups.

• A .VACM file stores metadata about the backup job. A .VACM file is created for each backup job. The
.VACM file is used by Veeam Backup & Replication to get data about Veeam Plug -in backup job.

In the initial backup session, Veeam Plug-in writes backup data about each backed-up database in a separate,
newly created backup file. During subsequent backup sessions, Veeam Plug -in can continue writing backup data
in the existing backup file or create a new file. Veeam Plug -in creates a new file only if the previous backup file
was created more than 24 hours ago.

NOTE

Keep in mind that if you use the scale-out backup repository as a backup target, Veeam Plug -in can create
a backup file for the backed-up database on each repository extent.

244 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Reuse of Backup Files
During backup and restore operations, Veeam Plug-in creates and stores backup files in the Veeam Backup &
Replication backup database. Veeam Plug-in can also reuse backup files by placing multiple backups from one
database in a single .VAB file. This approach helps with optimizing the number of objects in the backup
database. Veeam Plug-in reuses backup files considering the following backup file limits:

• Backup file can contain up to 1000 objects.

• Veeam Plug-in can write data to the created backup file for 24 hours.

After one of the limits is reached, Veeam Plug-in closes the backup file and cannot add new data to this
file. Keep in mind that Veeam Plug-in must close the backup file to allow Veeam Backup & Replication to
perform the following operations:

o Set the immutability for the backup file.

o Copy and move backup file to the capacity tier.

Veeam Backup Repositories

Veeam Plug-ins store backup files in repositories added to the Veeam Backup & Replication infrastructure. In
this section, you can find the list of supported backup repositories and limitations for Veeam Plug-in backups.

Before you start performing operations on backup repositories within the Veeam Backup & Replication
infrastructure, consider that you need to set the access permissions for each repository. For details, see Access
and Encryption Settings on Repositories.

Supported Backup Repositories

You can use the following types of repositories added to the Veeam Backup & Replication infrastructure to store
backups created with Veeam Plug-in for SAP on Oracle:

• Windows Server

• Linux Server

• SMB (CIFS) Share

• NFS Share

• Dell Data Domain with Data Domain Boost (DDBoost)

• Fujitsu ETERNUS CS800

• Infinidat InfiniGuard

• HPE StoreOnce
If you plan to use HPE StoreOnce as a backup repository for Veeam Plug -in backups, the total number of
stored files (data and metadata) must not exceed 3,000,000 per Catalyst store. If necessary, multiple
Catalyst stores may be created on the same StoreOnce system.

• Quantum DXi

• ExaGrid

Make sure the repository is configured as described in the ExaGrid section in the Veeam Backup &
Replication User Guide.

245 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 • Hardened Repository

• Scale-Out Backup Repository

Make sure that the performance extents of the scale-out backup repository contain repositories supported
by Veeam Plug-in for SAP on Oracle. For example, you cannot use object storage repositories as
performance extents to keep backups created with Veeam Plug -ins.

Backup Repositories Limitations

• For Veeam Plug-in backups, the warning which indicates that free space on a storage device has reached a
specified threshold is configured in the veeam_config.xml file of Veeam Plug-in. The warning settings
in the Veeam Backup & Replication console does not affect this setting.

To configure the warning settings, add the following parameter in the veeam_config.xml file:

<PluginParameters repositoryFreeSpacePercentWarning="10" />

Keep in mind that you must add the parameter to the existing line in the veeam_config.xml file. If you
create a new line with the same name as the existing line, Veeam Plug -in will consider parameters only in
the first detected line. Other parameters will be ignored.

• The plug-in configuration wizard will not show repositories where the E ncrypt backups stored in this
rep ository option is enabled. To learn how to disable the encryption option, see Access and Encryption
Settings on Repositories.

If you want to use the same backup target with the repository-based encryption and Veeam Plug-ins,
create a second repository in the subfolder for Veeam Plug -in backups.

• Veeam extract utility cannot extract Veeam Plug-in backup files.

• Veeam Plug-ins do not support backup operations targeted directly to object storage repositories.
To learn more about object storage repositories, see the Object Storage Repositories section in the Veeam
Backup & Replication User Guide.

• Veeam Plug-ins do not support backup operations to object storage added as a performance extent of a
scale-out backup repository.

Veeam Scale-Out Backup Repositories

If you want to store Veeam Plug-in backups on scale-out backup repositories, consider the following:

• You cannot rename a scale-out backup repository with Veeam Plug-in backups stored on this repository.

• For Veeam Plug-in backups and backup copies, the Performance policy of a scale-out repository functions
differently:

a. Veeam Backup & Replication checks if there are extents without warning on free space insufficiency.

If there is no extents without the warning, Veeam Backup & Replication uses an extent with the
largest amount of free space that has a free task slot.

b. For the extents without the warning, Veeam Backup & Replication checks if there are incremental
extents with free task slots.

If there are no incremental extents with free task slots, Veeam Backup & Replication uses a full extent
with the least amount of used task slots.

246 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 c. For incremental extents with free task slots, Veeam Backup & Replication sends backup files to an
incremental extent with the least amount of used task slots.

If several extents has the same least amount of used tasks, Veeam Backup & Replication uses an
extent with the largest amount of free space.

To learn more about file placement policies of scale-out repositories, see Backup File Placement section in
the Veeam Backup & Replication guide.

• If a scale-out repository is configured in the Data locality policy, each time BR*Tools starts a new channel
for transferring backup files, Veeam Plug-in checks the free space in the extents and selects a scale-out
backup repository extent that has the largest amount of free space.

If there are two extents with only one task slot on each extent, the backup is performed using two para llel
streams (one stream per extent).

• If you want to add a backup repository which contains Veeam Plug -in backups as an extent to a scale-out
backup repository, you must do the following:

On the Veeam Backup & Replication console side

a. Select Veeam Plug-in backup files that reside in this backup repository and remove them from
configuration.

To learn more, see the Removing Backups from Configuration section in the Veeam Backup &
Replication User Guide.

b. Delete the Veeam Plug-in backup job.

To learn more, see the Disabling and Deleting Jobs section in the Veeam Backup & Replication User
Guide.

c. Add the repository as an extent to the scale-out repository.

To learn more, see the Extending Scale-Out Repositories section in the Veeam Backup & Replication
User Guide.

d. Rescan the scale-out repository.

To learn more, see the Rescanning Scale-Out Repositories section in the Veeam Backup & Replication
User Guide.

NOTE

[For imports to the scale-out backup repository] Before importing your backup, consider that
the names of all backup files (.VAB, .VASM, .VACM) and paths to these files contain only the
following allowed characters:

• a-zA-Z0-9
• _-.+=@^

If your backup was initially created on a standalone backup server, the default name of the
backup metadata file (.VACM) contains forbidden characters. Before importing, you must delete
forbidden characters from the file name or replace them with the allowed characters.

247 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 On the Veeam Plug-in side

e. On the Veeam Plug-in server, set the scale-out repository as the target for backups using the
following command:

SapBackintConfigTool --set-repositories

f. Map the imported backups using the following command:

SapBackintConfigTool --map-backup

Capacity Tier
You can configure Veeam Backup & Replication to transfer Veeam Plug -in backup files to a capacity tier. Both
policies (Move policy, Copy policy) are supported for Veeam Plug -in backups with the following limitations:

• For Veeam Plug-in backup files, capacity tier does not verify whether data that is being moved is unique
and has not been offloaded earlier. Thus, it is highly recommended to check the pricing plans of your
cloud storage provider to avoid additional costs for offloading and downloading backup data.

• To offload Veeam Plug-in backup files to the capacity tier, Veeam Backup & Replication splits data into 1
MB objects and compresses the resulting objects. The default object size will be a compressed 1 MB block,
resulting in objects of around 512 KB in size.

• Veeam Backup & Replication offloads Veeam Plug-in for SAP on Oracle backup files to the capacity tier
with the Copy and Move policies in different ways. With the Copy policy, Veeam Backup & Replication
checks backup files every 1 hour and runs an offload job only if new backup files exist. With the Move
policy, Veeam Backup & Replication checks backup files every 4 hours and runs an offload job, even if
there are no new files.

IMP ORTANT

With both the Copy and Move policies, Veeam Backup & Replication copies and moves to the
capacity tier only non-active backup files created more than 24 hours ago, which match the capacity
tier configuration parameters. To learn more about the capacity tier configuration, see Add Capacity
Tier in the Veeam Backup & Replication User Guide.

• Veeam Plug-in supports encryption of offloaded data to the capacity tier. The E ncrypt data uploaded to
ob ject storage option in the Ca pacity Tier settings of the scale-out backup repository ensures that the
entire collection of blocks along with the metadata will be encrypted while being offloaded. To learn more
about capacity tier encryption, see the Encryption for Capacity Tier section in the Veeam Backup &
Replication User Guide.

• Capacity tier does not track dependencies of full and incremental Veeam Plug-in backup files. Thus,
consider the following:

o [For the Move policy] When backup files are transferred to the capacity tier, Veeam Backup &
Replication takes into account only the creation time of backup files. Make sure that the operational
restore window is not longer than the whole backup chain cycle period. Otherwise, you may
encounter the scenario when full backup files are transferred to the capacity tier and their increment
backup files still remain in the performance tier.

248 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 o The capacity tier immutability expiration date does not have the additional block generation period.
The immutability expiration date is based only on the number of days specified in the settings of the
object storage backup repository.

• In case a disaster strikes the scale-out repository and you have a Veeam Plug-in backup file on the capacity
tier, you must re-create the scale-out repository before you restore from this backup file. You must
connect the capacity tier with the Veeam Plug-in backup file to another backup server with Veeam Backup
& Replication and a scale-out repository. After that, you can import the backup files to Veeam Backup &
Replication and then perform data recovery operations.

Hardened Repository
You can configure Veeam Backup & Replication to transfer Veeam Plug -in backup files to a hardened repository.
The hardened repository helps to protect Veeam Plug -in backup files from loss as a result of malware activity or
unplanned actions. Backup files in the hardened repository become immutable for the time period specified in
the backup repository settings. During this period, backup files stored in the repository cannot be modified or
deleted.

For Veeam Plug-in for SAP on Oracle backups, immutability works according to the following rules:

• Immutability is applied to backup (VAB) files and backup metadata (VASM) files. Backup job metadata
(VACM) files are not immutable.

• Backup files become immutable for the configured time period (minimum 7 days, maximum 9999 days).

• Backup files become immutable after 24 hours have passed since each file was created. The immutability
service runs in the background at every hour. This service detects and sets immutability flags for any
backup file that can no longer be reused.

TIP

Contact Veeam Customer Support to change the default 24 hour lifespan of a backup file. To do that,
you can submit a support case on the Veeam Customer Support Portal.

• The immutability period is not extended for the active backup chain.

Data Restore from Hardened Repository

As a result of malware activity or unplanned actions, backup job metadata (VACM) files may become unavailable
in the hardened repository. In this case, to restore data from the hardened repository, you must re -create the
VACM file. For more information, see Restore from Hardened Repository.

249 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Data Restore
With the configured Veeam Plug-in for SAP on Oracle, you can restore Oracle databases from Veeam Plug -in
backups that reside on Veeam backup repositories.

You can use the SAP BR*Tools to restore databases. All restore operations are performed on the SAP BR*Tools
side. For details on how to use specific restore tools, see Database Recovery.

Depending on the available type of Veeam Plug -in backups that will be the source for the restored databases,
you can perform the following restore operations:

• Restoring from backup.

Restore Oracle databases from a Veeam Plug-in backup using the BRRESTORE tool functionality. For more
information, see Restore Oracle Databases.

You can also restore Oracle databases from a Veeam Plug -in backup to another server. For details, see
Restore to Another Server (System Copy).

• Restoring from a backup copy.

Restore Oracle databases from backup copies created for Veeam Plug -in for SAP on Oracle backups. The
procedure of database restore from a backup copy is the same as database restore to another server. For
more information, see Restore from Backup Copy.

Depending on the available Veeam Plug-in backup files, you can also perform the following restore operations:

• Restoring redo logs.

Restore redo log files that were backed up with BRARCHIVE by using the BRRESTORE tool. For details, see
Restore Redo Logs.

• Restoring from hardened repositories.

Restore Oracle databases from hardened repositories by creating new backup job metadata files (.VACM)
with data from available backup metadata files (.VASM). For details, see Restore from Hardened
Repository.

250 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Planning and Preparation
Before you start to use Veeam Plug-in for SAP on Oracle, read the environment planning recommendations and
make sure that your environment meets system requirements.

In This Section
• System Requirements

• Permissions

• Ports

• Licensing

• Veeam Environment Planning

• SAP Environment Planning

251 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

System Requirements
Before you start using Veeam Plug-in for SAP on Oracle, make sure the following requirements are met.

NOTE

The following system requirements apply to Veeam Plug -in for SAP on Oracle operating in the standalone
mode.

For more information on system requirements for Veeam Plug-in managed by Veeam Backup & Replication,
see System Requirements for Managed Veeam Plug-ins.

Sp ecification Requirement

OS Veeam Plug-in for SAP on Oracle is supported for the following distributions:

• SUSE Linux Enterprise Server versions 11, 12, 15 (x86_64)

• RHEL for SAP Applications versions 6, 7, 8 (x86_64)
• Oracle Linux versions 6, 7

BR*Tools Veeam Plug-in for SAP on Oracle supports BR*Tools version 7.20, Patch 42 or later.

Ora cle Database Veeam Plug-in for SAP on Oracle supports the following Oracle Database versions:
• 11gR2
• 12c
• 18c
• 19c: Standard and Enterprise Edition

Note:

Oracle Express Edition (XE) and Oracle Real Application Cluster (RAC) environment are
not supported.

Veeam Backup & Veeam Backup & Replication supports two latest versions of Veeam Plug -ins. For
Rep lication example, Veeam Backup & Replication 12.3 supports Veeam Plug -in 12.3 and 12.2.

Keep in mind that if you use an earlier Veeam Plug-in build than the one that is
included in the installation ISO file of your Veeam Backup & Replication version, it may
not have all the features and bug fixes introduced in your Veeam Backup & Replication
version. To learn more about the Veeam Plug-in builds included in Veeam Backup &
Replication installation ISO files, see this Veeam KB article.

Network Veeam Plug-in should be able to establish a direct IP connection to the Veeam Backup
& Replication server. Thus, Veeam Plug-in cannot work with the Veeam Backup &
Replication server that is located behind the NAT gateway.

252 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Permissions
This table contains the list of operations that require specific user account p ermissions.

Op eration Required Roles and Permissions

Installing and updaing The account used for installing and updating Veeam Plug -in must have root
Veeam Plug-in privileges.

Performing backup The account used to start BR*Tools backup and restore operations must have
and restore operations permissions described in the Starting BR*Tools section in the SAP Database Guide:
in Veeam Plug-in Oracle.

• The account specified in the Veeam Plug-in configuration settings must be

Connecting to Veeam
able to authenticate against the Veeam Backup & Replication server. For
Backup & Replication,
managing backups details, see Configuring Plug-in for SAP on Oracle.
• The account specified in the Veeam Plug-in configuration settings must be
granted access rights on the Veeam backup repository where you want to
store backups.

To learn how to grant permissions on Veeam repositories, see Access and

Encryption Settings on Repositories.
• You can work with backups created by Veeam Plug-in only with the account
used for creating the backups. If you want to use another account, see
required permissions in Configuring Plug-in for SAP on Oracle.

253 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Ports
To enable proper work of Veeam Plug-ins, make sure that the following ports are open.

SAP on Oracle Server

The following table describes network ports that must be opened to ensure proper communication of the SAP
on Oracle server and backup infrastructure components.

From To P rotocol P ort Notes

Default port used for communication with

the Veeam Backup & Replication server.
Veeam Backup
& Replication TCP 10006 Note that data between Veeam Plug-ins
server and backup repositories is transferred
directly, bypassing the Veeam Backup &
Replication server.
SAP on
Oracle
server Backup
Default range of ports used as data
where repository
2500 to transmission channels. For every TCP
Veeam server or TCP
3300** connection that a backup process uses, one
Plug-in is gateway
port from this range is assigned.
installed server*

Local connections between Veeam Plug-in

SAP on Oracle 6791+, and source Data Movers.
server (local TCP 2500 to
host) 3300** If port 6791 is occupied, the succeeding
port numbers will be used.

* For NFS share, SMB share repositories, and Dell Data Domain, HPE StoreOnce deduplication storage appliances, Veeam
Backup & Replication uses an auxiliary backup infrastructure component — gateway server. For details, see the Gateway
Server section in the Veeam Backup & Replication User Guide.
** This range of ports applies to newly added backup infrastructure components. If you upgrade to Veeam Backup &
Replication 10.0 from earlier versions of the product, the range of ports from 2500 to 5000 applies to the already added
components.

Backup Repositories and Gateway Servers

Depending on the type of backup repositories that you use for Veeam Plug -in backups, the following ports must
be open to allow communication between backup infrastructure components.

From To P rotocol P ort Notes

Backup
Veeam Default range of ports used as data
repository
Backup & 2500 to transmission channels. For every TCP
server or TCP
Replication 3300** connection that a backup process uses,
gateway
server one port from this range is assigned.
server*

254 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 From To P rotocol P ort Notes

Direct Attached Storage

Linux server
used as a
Port used as a control channel from the
backup
TCP 22 Veeam Plug-in server to the target Linux
repository or
host.
gateway
server
Veeam
Backup &
Replication Microsoft Ports used as a management channel from
TCP 135,
server Windows the Veeam Plug-in server to the
137 to 139,
server used UDP Repository/Gateway server. Also, the ports
445
as a backup are used to deploy Veeam components.
repository or
gateway 6160, Default ports used by the Veeam Installer
server TCP
6162 Service and Veeam Data Mover Service

Network Attached Storage

Gateway Default port used by the SMB transport

TCP 445
server protocol.

(specified in
the SMB SMB server SMB/Netbios name resolution for the SMB
TCP 135, protocol (needed in some cases). For
share
repository UDP 137 to 139 details, see the Used Ports section in the
settings) Veeam Backup & Replication User Guide.

Gateway
server

(specified in TCP Standard NFS ports used as a transmission

111,
the NFS NFS server channel from the gateway server to the
UDP 2049
share target NFS share.
repository
settings)

Dell Data Domain

Veeam Port used to assign a random port for the

Backup & Dell Data mountd service used by NFS and
TCP 111
Replication Domain DDBOOST. Mountd service port can be
server statically assigned.

255 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 From To P rotocol P ort Notes

or For more
Gateway Main port used by NFS. To change the
information,
server port, you can use the nfs set server-
see this Dell TCP 2049
port command. Note that the command
KB article.
requires SE mode.

Main port used by NFS MOUNTD. To

change the port, you can use the nfs set
TCP 2052
mountd-port command. Note that the
command requires SE mode.

HP E StoreOnce

Veeam Default command port used for

9387
Backup & communication with HPE StoreOnce.
Replication
HPE
server TCP
StoreOnce
or Default data port used for communication
Gateway 9388
with HPE StoreOnce.
server

E x aGrid

Veeam
Backup & Default command port used for
ExaGrid TCP 22
Replication communication with ExaGrid.
server

Qua ntum DXi

Veeam
Backup & Default command port used for
Quantum DXi TCP 22
Replication communication with Quantum DXi.
server

Fujitsu ETERNUS CS800

Veeam
Fujitsu Default command port used for
Backup &
ETERNUS TCP 22 communication with Fujitsu ETERNUS
Replication
CS800 CS800.
server

Infinidat InfiniGuard

256 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 From To P rotocol P ort Notes

Veeam
Backup & Infinidat Default command port used for
TCP 22
Replication InfiniGuard communication with Infinidat InfiniGuard.
server

For detailed list of ports used by Veeam Backup & Replication server and backup repositories, see the Used Ports
section in the Veeam Backup & Replication User Guide.

257 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Licensing
To use the Veeam Plug-in functionality, you must have a valid Veeam Backup & Replication license. Licenses are
installed and managed on the Veeam Backup & Replication server that is connected to the Veeam Plug -in server.
If the license is not valid or out of resources, Veeam Plug -in backup jobs fail.

This guide provides information only on specifics of Veeam licenses for Veeam Plug-ins. For terminology and
general information about Veeam Licensing, see Veeam Licensing Policy.

Licensed Objects
An SAP on Oracle server is assumed protected if it has been processed by a Veeam Plug-in backup job in the last
31 days.

If you are using any instance-based (Veeam Universal Licensing) license on your Veeam Backup & Replication,
you don't need to install any additional licenses. A protected SAP on Oracle server consumes one instance unit
from the license. SAP on Oracle servers processed by backup copy jobs are not regarded as protected VMs, these
types of jobs provide an additional protection level for VMs that are already protected with Veeam Plug -in
backup jobs.

A machine protected by both Veeam Plug-in and Veeam Backup & Replication will consume a license only once.
For example, you have an SAP on Oracle server that you back up using Veeam Plug-in. You also back up this
server using image-level backup functionality of Veeam Backup & Replication. In this case, only one license will
be consumed.

NOTE

[For Perpetual per-socket licenses] If you are using a legacy perpetual per-socket license, a license is
required for each hypervisor CPU socket occupied by protected SAP on Oracle servers.

A socket is consumed from the license only if the hypervisor where protected servers reside is added to the
Veeam Backup & Replication infrastructure. If the hypervisor is not added to the Veeam Backup &
Replication infrastructure, an instance unit will be consumed from the license. To learn how to add a
hypervisor to the Veeam Backup & Replication infrastructure, see the Virtualization Servers and Hosts
section in the Veeam Backup & Replication User Guide.

Supported License Types and Packages

You can use Veeam Plug-ins with the following license types and packages. Note that this guide contains
information on specifics of Veeam license packages only for Veeam Plug -ins. For the full list of license packages,
see this Veeam webpage.

• For Veeam Universal license:

You can use Veeam Plug-ins with all license packages ( Veeam Backup Essentials, Veeam Backup &
Replication, Veeam Availability Suite ).
Note that if you use the Rental license type, functionality of Veeam Plug-ins is supported only for the
Enterprise Plus edition of Veeam Backup & Replication.

• For Socket license:

Functionality of Veeam Plug-ins is supported only for the Enterprise Plus edition of Veeam Backup &
Replication.

258 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Obtaining and Managing Licenses
To learn how to install a license and monitor licensed objects, see the Licensing section in the Veeam Backup &
Replication User Guide.

259 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Veeam Environment Planning
Integration of SAP on Oracle and Veeam Plug-in requires additional environment planning. When you deploy the
plug-in, keep in mind the following requirements and limitations.

Hosting Environments and Backup Job Names

By default, Veeam Plug-in uses the Oracle server hostname to create a Veeam Backup & Replication job object
and backup folder. To distinguish between servers with the same hostnames, you can assign custom names for
these servers.

To assign a custom name, update the Veeam configuration XML file as follows:

1. On the machine with Veeam Plug-in, open the

/opt/veeam/VeeamPluginforSAPOracle/veeam_config.xml file.

2. Add the customServerName parameter entry to the <PluginParameters /> line in the Veeam
configuration XML file:

<PluginParameters customServerName="hostname.domain.tld" />

where <hostname.domain.tld> is a custom name of the server.

After adding this parameter, Veeam Plug-in will use the specified custom name of the server to name the
backup job and backup folder.

For example:

<PluginParameters customServerName="srv01.tech.local" />

Alternatively, you can use the useFQDNInServerName parameter:

<PluginParameters useFQDNInServerName="true" />

After adding this parameter, Veeam Plug-in will use the fully qualified domain name (FQDN) of the server to
name the backup job and backup folder.

Keep in mind that you must add the parameters to the existing line in the veeam_config.xml file. If you
create a new line with the same name as the existing line, Veeam Plug -in will consider parameters only in the
first detected line. Other parameters will be ignored.

IMP ORTANT

For security reasons, it is recommended to use separate repositories for different customers and limit the
Veeam Repository Authentication to the specific customer.

260 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Network Traffic Encryption
Veeam Plug-in supports network traffic encryption rules set on the Veeam Backup & Replication side. By
default, Veeam Plug-in automatically applies the traffic encryption rules. To decrease the processing load on
the database server, you can disable network traffic encryption by ignoring the rules set on the Veeam Backup &
Replication side.

To ignore network traffic encryption rules, do the following:

1. Locate the Veeam configuration XML file:

/opt/veeam/VeeamPluginforSAPOracle/veeam_config.xml.

2. Add the following parameter to the Veeam configuration XML file:

<IgnoreVBRNetworkRules=true />

To learn more about traffic encryption, see the Enabling Traffic Encryption section in the Veeam Backup &
Replication User Guide.

Veeam Backup & Replication Users and Roles

Veeam Plug-in for SAP on Oracle uses the Windows authentication methods of the Veeam Backup & Replication
server to establish a connection to this server and to the backup target.

If this user will be later changed manually, the new user must have at least the Veeam Backup Operator and
Veeam Restore Operator rights within the Veeam Backup & Replication user management. To learn how to
assign Veeam Backup & Replication roles, see the Users and Roles section of the Veeam Backup & Replication
User Guide.

Parallel Data Streams and Backup Repository Task Slots

Any parallel data stream started by SAP Backint will use one backup repository task slot. It is recommended to
carefully plan repository task slots, so that SAP Backint can work with multiple channels in parallel.

The following hardware resources are recommended based on tests on Skylake processors:

• SAP on Oracle server: 1 CPU core and a minimum of 200 MB of RAM per currently used channel. Note that
resource consumption on the SAP on Oracle server depends on hardware and Oracle settings.

• Ba ckup repository server: 1 CPU core and 1 GB of RAM per 5 currently used channels.

These resources are recommended only if you use a dedicated backup repository for Veeam Plug -in
backups. If you use the same backup repository for Veeam Plug -in backups and VM backups created by
Veeam Backup & Replication or Veeam Agents, consider adding the hardware resources based on usual
load on your backup repository. For details on hardware requirements for a backup repository, see the
System Requirements section of the Veeam Backup & Replication User Guide.

It is recommended to contact your Veeam system engineer to optimize the channel settings and resource
allocation.

It is recommended to use a separate backup repository for Veeam Plug -in backups.

• Veeam Backup & Replication server: during manual metadata operations such as import of backup files,
the Veeam Backup & Replication server needs additional 15 GB of RAM per 1 million files located in the
same backup job folder.

261 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Limitation for SAP Detection on Different Host
Veeam Plug-in may not be able to detect SAP instances during the configuration if the Oracle Database and SAP
central instance are running on different hosts. If you work with Veeam Plug -in in the managed mode, this
configuration is not supported. If you work with Veeam Plug -in in the standalone operation mode, see
Configuring Plug-in for SAP on Oracle.

262 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

SAP Environment Planning
The integration of SAP on Oracle and Veeam Plug-in requires additional environment planning. When you
deploy the plug-in, keep in mind the following requirements and limitations.

Limitation for SAP Detection on Different Host

Veeam Plug-in may not be able to detect SAP instances during the configuration if the Oracle Database and SAP
central instance are running on different hosts. If you work with Veeam Plug -in in the managed mode, this
configuration is not supported. If you work with Veeam Plug -in in the standalone operation mode, see
Configuring Plug-in for SAP on Oracle.

Scheduling
You can schedule backup processes using Cron.

Also, you can schedule and run existing SAP BR*Tools backup scripts within image-level or file-level backup job
of Veeam Backup & Replication or Veeam Agent. For details, see the Pre-Freeze and Post-Thaw Scripts section
of the Veeam Backup & Replication User Guide.

263 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Deployment and Configuration
To deploy Veeam Plug-in, you must install the plug-in on an SAP on Oracle server and configure plug -in
integration settings.

In This Section
• Installing Veeam Plug-in for SAP on Oracle

• Access and Encryption Settings on Repositories

• Granting Permissions to Users

• Configuring Plug-in for SAP on Oracle

• Specifying Preferred Networks for Veeam Plug-ins

• Configuring Performance Throttling

• Configuring Parallelism for Redo Logs

• Importing Backup Files

• Upgrading Veeam Plug-in for SAP on Oracle

• Uninstalling Veeam Plug-in for SAP on Oracle

This guide gives instructions on how to deploy Veeam Plug -in assuming that you have already deployed a
Veeam Backup & Replication server and configured a backup repository. If you need instructions on how to
deploy Veeam Backup & Replication, see the Veeam Backup & Replication User Guide for your platform.

264 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Installing Veeam Plug-in for SAP on Oracle
Veeam Plug-in for SAP on Oracle is an additional component of Veeam Backup & Replication, and the
installation package of the plug-in is included in the Veeam Backup & Replication installation ISO file. You must
install the plug-in on the Oracle Database server.

You can install Veeam Plug-in using the .RPM package or extract the plug-in files from the .TAR.GZ archive.
Depending on the type of package suitable for your OS, perform steps in one of the following guides:

• Installing Plug-in from .RPM Package

• Unpacking Plug-in from .TAR.GZ Archive

IMP ORTANT

Consider the following:

• Veeam Plug-in for SAP on Oracle must be installed on the Oracle Database server.
• The /opt/veeam directory must be writable.
• The NOEXEC mount option must be disabled for the /var and /tmp directories.
• To install the Veeam Plug-in, use the sudo command or a user with root privileges.

Installing Plug-in from .RPM Package

To install Veeam Plug-in using the .RPM package, do the following:

1. Mount the Veeam Backup & Replication installation disk

(VeeamBackup&Replication_12.3.0.310_20241201.iso).

If you deploy Veeam backup infrastructure for the first time, you can download the Veeam Backup &
Replication installation disk image from the Veeam Backup & Replication: Download page.

2. Open the mounted disk image and go to /Plugins/SAP on Oracle/x64 directory.

3. Upload the VeeamPluginforSAPOracle-12.3.0.310-1.x86_64.rpm file to the Oracle Database

server.

4. Run the following command to install the plug-in:

rpm -i VeeamPluginforSAPOracle-12.3.0.310-1.x86_64.rpm

Unpacking Plug-in from .TAR.GZ Archive

To extract plug-in files from the .TAR.GZ archive, perform the following:

1. Mount the Veeam Backup & Replication installation disk

(VeeamBackup&Replication_12.3.0.310_20241201.iso).

If you deploy Veeam backup infrastructure for the first time, you can download the Veeam Backup &
Replication installation disk image from the Veeam Backup & Replication: Download page.

2. In the mounted ISO, go to /Plugins/SAP on Oracle/x64.

3. Upload the VeeamPluginforSAPOracle.tar.gz file to the Oracle Database server.

265 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 4. Create the /opt/veeam directory.

mkdir /opt/veeam

5. Unpack the plug-in files from the archive to the /opt/veeam directory:

tar -xzvf -i VeeamPluginforSAPOracle.tar.gz -C /opt/veeam

266 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Access and Encryption Settings on Repositories
When you configure Veeam Plug-in, you specify an account that must be used to connect to the Veeam Backup
& Replication server.

Before granting access permissions, consider the following:

• Consider supported types of backup repositories and limitations for Veeam Plug -in backups in Veeam
Backup Repositories.

• To store backups in a backup repository, the specified account must have access permissions on the target
backup repository.

To grant access permissions, do the following:

1. In Veeam Backup & Replication, open the Ba ckup Infrastructure view.

2. In the inventory pane, click the Ba ckup Repositories node or the Sca le-out Repositories node.

3. In the working area, select the necessary backup repository and click Set Access Permissions on the ribbon
or right-click the backup repository and select Access permissions.

4. In the Access Permissions window, on the Sta ndalone applications tab specify to whom you want to grant
access permissions on this backup repository:

o Allow to everyone — select this option if you want to grant repository access to any user. This option
is equal to granting access rights to the Everyone group in Microsoft Windows (anonymous users are
excluded). For security reasons, the option is not recommended for production environments.

o Allow to the following accounts or groups only — select this option if you want only specific users to
be able to store backups in this repository. Click Ad d to add the necessary users and groups to the list.

5. Veeam Plug-ins cannot send backups or backup copies to a backup repository where encryption is
enabled. Thus, make sure that the E ncrypt standalone application backups stored in this repository check
box is not selected.

267 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 6. Click OK.

268 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Granting Permissions to Users
When you install Veeam Plug-in for SAP on Oracle, full access rights to the plug-in configuration file are
automatically granted to all users. To protect sensitive information that is stored in the configuration file from
unwanted access, we recommend limiting access to the configuration file to a dedicated group of users.

Before You Begin

Before you create a user group that will have access to the plug-in configuration file, consider the following:

• To perform this procedure, your OS user account must have root privileges.

• After a user is added to the group, the user must log out, then log in to the Linux OS again to activate t he
group permissions.

• Add only trusted users to the group.

IMP ORTANT

The user that configures the plug-in must be added to the group. As a rule, this user is ora<dbsid>
or root, but the root user account has access to all files in the system and does not need to be
added to the group.

Granting Permissions to the Plug-In Configuration File

By default, the Veeam Plug-in configuration file (veeam_config.xml) is located in the
/opt/veeam/VeeamPluginforSAPonOracle directory on the machine where Veeam Plug-in is installed. To
grant access to the configuration file to a dedicated group of users, do the following:

1. Create a new user group by running the following command:

sudo groupadd <groupName>

where <groupName> is the name of the created group.

2. Add a user to the group with the following command:

sudo usermod -a -G <groupName> <userName>

where:

o <groupName> — the name of the created group.

o <userName> — the name of the account that will be granted access to the configuration file.

3. Change the ownership of the configuration file to enable users from the dedicated group to access the
configuration file. To do this, run the following command:

sudo chgrp <groupName> /opt/veeam/VeeamPluginforSAPonOracle/veeam_config.x

ml

where <groupName> is the name of the created group.

269 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 4. Limit the permissions for the configuration file to allow the read -write access only to the members of the
group. To do this, use the following command:

sudo chmod 660 /opt/veeam/VeeamPluginforSAPonOracle/veeam_config.xml

270 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Configuring Plug-in for SAP on Oracle
When you configure Veeam Plug-in settings, you set up integration settings between the SAP on Oracle server,
Veeam Backup & Replication server and backup repositories where backup files will be stored.

Veeam Plug-in uses the Sa pOracleBackintConfigTool wizard to configure the integration settings. The wizard
searches for all SAP on Oracle systems deployed on the server and creates the veeam_initSID.sap file for
each system. Then, this file is used as an initialization profile for brbackup, brrestore and brarchive tools.

Depending on the version of Oracle Database, Veeam Plug -in stores the configuration file in one of the
following directories:

• For Oracle 12 and later, the configuration file is stored at SAPDATA_HOME/sapprof.

• For Oracle 11, the configuration file is stored at ORACLE_HOME/dbs.

IMP ORTANT

Veeam Plug-in may not be able to detect SAP instances during the configuration if the Oracle Database and
SAP central instance are running on different hosts. If you work with Veeam Plug-in in the managed mode,
this configuration is not supported. If you work with Veeam Plug -in in the standalone operation mode, you
can do the following:

1. Complete all the steps of the Veeam Plug-in configuration wizard described in the Veeam Plug-in
Configuration section. As a result, Veeam Plug-in will create a new veeam_initSID.sap
initialization profile and save it in the /tmp/ directory.

2. Manually copy all lines from the new initialization profile to the default initialization profile. You can
also specify the path to the veeam_initSID.sap file in each BRBACKUP, BRRESTORE and
BRARCHIVE command.

Note that this approach applies only for Veeam Plug-in in the standalone operation mode. To learn more
about operation modes, see Standalone and Managed Operations Modes.

Veeam Plug-in Configuration

To configure Veeam Plug-in, do the following:

NOTE
The configuration of Veeam Plug-in must be performed by a user with database administrator rights on the
Oracle Database server.

1. Log in to the Oracle Database server as a user with database administrator rights and run the following
command to launch the Veeam Plug-in configuration tool. You do not need root privileges if you have
configured group access as described in the Permissions section.

SapOracleBackintConfigTool --wizard

271 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 If you have extracted files form the .TAR.GZ archive, go to the
/opt/veeam/VeeamPluginforSAPOracle folder and run the following command:

./SapOracleBackintConfigTool --wizard

2. Specify the DNS name or IP address of the Veeam Backup & Replication server that you want to use.

Enter backup server name or IP address: serv02.tech.local

3. Specify the port which will be used to communicate with the Veeam Backup & Replication server. Default
port: 10006.

Enter backup server port number: 10006

4. Specify credentials to authenticate against the Veeam Backup & Replication server.

Enter username: serv02\administrator

Enter password for serv02\administrator:

IMP ORTANT

Consider the following:

• You can work with backups created by Veeam Plug-in only with the account used for creating
the backups. If you want to use another account, assign the Veeam Backup Administrator role
or Veeam Backup Operator and Veeam Restore Operator roles to the account.

To learn how to assign Veeam Backup & Replication roles, see the Users and Roles section in
the Veeam Backup & Replication User Guide.
• The account must have access permissions on the required backup repository. To learn how to
configure access permissions and encryption settings on repositories, see Access and
Encryption Settings on Repositories.

5. Select a backup repository where you want to store backups.

In the wizard dialog, you will see a list of available repositories. Enter the number of the target repository
from the list.

Available backup repositories:

1. serv10_repo
2. serv07_repo
Enter repository number: 1

272 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 IMP ORTANT

Consider the following:

• The account used to connect to the Veeam Backup & Replication server must have access to
the target backup repositories.
• Encryption must be disabled on the target backup repositories.

Otherwise, backup repositories will not be listed as available. To learn how to configure access and
encryption settings on repositories, see Access and Encryption Settings on Repositories.

6. Specify the number of parallel data streams for each backup repository.

Enter number of data streams (From 1 to 32) to run in parallel: 4

Configuration result:
An auxiliary initialization profile has been successfully created for SAP
system "ODB": /oracle/ODB/sapprof/veeam_initODB.sap
The created profile must be leveraged to perform backup and restore tasks
by BR*Tools.

Note that this parallelism setting applies only to backup and restore of Oracle datafiles. If you want to
configure parallel channels for backup and restore of redo logs, see Configuring Parallelism for Redo Logs.

Configuration Tool Parameters

Apart from running a configuration wizard, you can use the Sa pOracleBackintConfigTool tool to change a
specific parameter in the veeam_config.xml file or enable/disable Veeam Plug-in features.

IMP ORTANT

When you work with the command-line tool, use one configuration parameter per command. The tool does
not support commands with multiple parameters.

The following table lists available parameters for Sa p OracleBackintConfigTool.

P a rameter Description

--help Shows the list of tool parameters.

--show-config Shows configuration parameters.

--wizard Starts the wizard to configure the plug-in settings. The wizard
edits the Veeam Plug-in configuration file
(veeam_config.xml) or creates a new one if the configuration
file was removed from the
/opt/veeam/VeeamPluginforSAPOracle directory on the
machine where Veeam Plug-in is installed.

--set-credentials <"serv\username"> Specifies credentials to log in to the Veeam Backup &

< p assword> Replication server.

273 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 P a rameter Description

--set-host <hostname> Specifies the IP address or hostname of the Veeam Backup &
Replication server.

--set-port <port_number> Specifies a port number that will be used to communicate with
the Veeam Backup & Replication server.

--set-repository Launches a wizard to select a backup repository. A backup

repository is selected from repositories which are available in
the connected Veeam Backup & Replication instance.

--set-backup-for-restore [For System Copy] Specifies the backup that will be used for
restore operations. You can use this parameter if you want to
restore a database to another server or to restore a database
from a backup copy.

When you run the SapBackintConfigTool command with

this parameter, Veeam Plug-in will prompt you to select an
authentication method to access a backup created for the
original server and then select the backup from which you want
to restore a database.

For more information, see Restore to Another Server (System

Copy).

--ma p-backup Maps the imported backup.

--set-force-delete Deletes backup files after specified days.

--p romote-backup-copy-to-primary Maps the imported backup copy to a regular Veeam Plug -in
backup chain.

--set-parallelism <number_of_channels> Define the number of parallel channels that must be used to
transfer Oracle datafiles during the backup and restore
operations.

You can set up to 32 channels.

Note that the parallelism for redo logs is configured separately.

For details, see Configuring Parallelism for Redo Logs.

--show-preferred-networks Shows the list of preferred networks set for Veeam Plug -in data
traffic to the remote backup repository.

The list shows set preferred networks in descending order of

priority. If the list is empty, no networks are set as preferred and
Veeam Plug-in routes data traffic to the preferred networks set
in Veeam Backup & Replication. For more information, see
Specifying Preferred Networks for Veeam Plug-ins.

274 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 P a rameter Description

--a dd-preferred-network Adds a network to the list of preferred networks for Veeam
< network_IP_address> <position_in_list> Plug-in data traffic to the remote backup repository.

To select to which network Veeam Plug-in connects first, you

can set the order number of the network in the list. For more
information, see Specifying Preferred Networks for Veeam Plug-
ins.

--remove-preferred-network Removes a specified network from the list of preferred networks

< network_IP_address> for Veeam Plug-in data traffic to the remote backup repository.

Example
The following example shows how to specify credentials that will be used to log in to the Veeam Backup &
Replication server.

SapOracleBackintConfigTool --set-credentials "serv02\Administrator" "password"

275 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Specifying Preferred Networks for Veeam Plug-
ins
You can specify networks over which Veeam Plug-in must transport data when you perform data protection and
disaster recovery tasks on remote backup repositories. This setting applies only to Veeam Plug -in network
traffic, without affecting the data traffic of other Veeam Backup & Replication components. Setting a dedicated
network for Veeam Plug-in backup and replication operations can help to reduce heavy network loads.

NOTE

Consider the following:

• By default, if there are no specified preferred networks for Veeam Plug -in data traffic, Veeam Plug-
in will connect to preferred networks specified in Veeam Backup & Replication. To learn more about
setting preferred networks in Veeam Backup & Replication, see the Specifying Preferred Networks
section in the Veeam Backup & Replication User Guide.
• Veeam Plug-in does not save information about failed network connections. If backup or restore
operations fail, Veeam Plug-in tries to connect to the following network from the preferred
networks list to finish the started operations. Regardless of the first unsuccessful connection,
Veeam Plug-in will try to perform the next backup operations first on the failed network.
• Veeam Plug-in network preferences take priority over Veeam Backup & Replication network
preferences. Only if the preferred networks for Veeam Plug -in data traffic are not available for any
reason, Veeam Plug-in will try to connect to the Veeam Backup & Replication preferred networks.

To specify networks for data transfer, you must create a list of preferred networks. When Veeam Plug -in needs
to transfer data, it uses networks from this list. If a connection over any of the preferred networks cannot be
established for any reason, Veeam Plug-in will automatically fail over to the following network from the
preferred networks list.

To create and manage the list of preferred networks that Veeam Plug -in will use, you can perform the following
operations:

• Adding Preferred Networks

• Accessing Preferred Networks

• Removing Preferred Networks

Adding Preferred Networks

1. Access the Veeam Plug-in for SAP on Oracle directory /opt/veeam/VeeamPluginforSAPOracle on
the server where Veeam Plug-in is installed.

2. Run the Sa pOracleBackintConfigTool command with the following parameter:

SapOracleBackintConfigTool --add-preferred-network <network_IP_address> <p

osition_in_list>

where:

o <network_IP_address> can be either the IP address of a single network or a network mask that
contains a range of network IP addresses. Specify one of the available options to add as preferred
networks for Veeam Plug-in data traffic.

276 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 o <position_in_list> is the position number of the network in the preferred networks list. The
position in the list determines in what order Veeam Plug -in will connect to the specified network. If
you do not chose a specific position in the list, newly added networks take the last place in the list
automatically.

For example:

SapOracleBackintConfigTool --add-preferred-network 172.24.29.189 2

Accessing Preferred Networks

1. Access the Veeam Plug-in for SAP on Oracle directory /opt/veeam/VeeamPluginforSAPOracle on
the server where Veeam Plug-in is installed.

2. Run Sa pOracleBackintConfigTool with the following parameter:

SapOracleBackintConfigTool --show-preferred-networks

The following example shows what the output of the Sa pOracleBackintConfigTool command with the --show-
preferred-networks parameter can look like:

SapOracleBackintConfigTool --show-preferred-networks
Preferred networks:
1. 172.24.29.156
2. 172.24.26.189

Removing Preferred Networks

1. Access the Veeam Plug-in for SAP on Oracle directory /opt/veeam/VeeamPluginforSAPOracle on
the server where Veeam Plug-in is installed.

2. Run Sa pOracleBackintConfigTool with the following parameter:

SapOracleBackintConfigTool --remove-preferred-network <network_IP_address>

where <network_IP_address> can be either the IP address of a single network or a network mask that
contains a range of network IP addresses. Specify one of the available options to remove from the
preferred networks list.

For example:

SapOracleBackintConfigTool --remove-preferred-network 172.24.29.189

277 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Configuring Performance Throttling
You can limit computer processing (CPU) resources assigned for Veeam Plug -in backup jobs. This setting allows
you to reduce the impact of backup operations on the target computer performance. Performance throttling
prevents Veeam Plug-ins from utilizing all computer resources to ensure that enough resources are provided for
other operations. This maybe useful in case you detected that your source database responses are slower during
backup operations.

If you throttle performance, Veeam Backup & Replication starts Veeam Plug -in backup operation processes with
low priority and nice value of 19. The nice values are in ascending order of priority ranging from -20 (the highest
priority) to 19 (the lowest priority). Keep in mind that Veeam Plug-ins manage the priority of backup operation
processes only if the system running on the target computer is busy with other tasks.

NOTE
• By default, Veeam Plug-in does not throttle performance.
• Performance throttling does not apply to restore operations.

To throttle Veeam Plug-in performance, do the following:

1. Log into the machine with a user with root or instance owner privileges.

2. Start the Veeam Plug-in configuration wizard with the following parameter:

SapOracleBackintConfigTool --set-throttling

3. To confirm that you want Veeam Plug-in throttle performance, type y .

All backup activities will be throttled if the system is busy. Backup perf
ormance may be affected. Proceed? (y/N): y

278 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Configuring Parallelism for Redo Logs
To configure backup or restore of redo logs through multiple channels, you can change the parallelism
parameter in the Veeam configuration XML file as follows:

1. On the machine with Veeam Plug-in, open the

/opt/veeam/VeeamPluginforSAPOracle/veeam_config.xml file.

2. Set the necessary values for the parallelism values:

<PluginParameters Parallelism="4" LogsParallelism="4" />

where:

o the LogsParallelism parameter defines the number of parallel channels for backup and restore of
redo logs

o the Parallelism parameter configures the parallelism for backup and restore of Oracle datafiles.
This setting is configured in the Veeam Plug-in configuration wizard

Keep in mind that you must add parameters to the existing line in the veeam_config.xml file. If you
create a new line with the same name as the existing line, Veeam Plug -in will consider parameters only in
the first detected line. Other parameters will be ignored.

279 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Importing Backup Files
If the Veeam Backup & Replication server has failed and you have restored it in a new location, you can copy the
backup files to a new repository and re-map the Veeam Plug-in backup files.

Limitations and Prerequisites

Consider the following limitations:

• If backup files are not imported according to instructions given in this section, Veeam Plug-in backup and
restore operations may fail.

• The repository from which you plan to import backups must be added to the Veeam Backup & Replication
infrastructure. Otherwise you will not be able to access backup files.

• [For imports to the scale-out backup repository] Before importing your backup, consider that the names
of all backup files (.VAB, .VASM, .VACM) and paths to these files contain only the following allowed
characters:

o a-zA-Z0-9

o _-.+=@^

If your backup was initially created on a standalone backup server, the default name of the backup
metadata file (.VACM) contains forbidden characters. Before importing, you must delete forbidden
characters from the file name or replace them with the allowed characters.

How to Import Veeam Plug-in Backup Files

To import Veeam Plug-in backup files, do the following:

1. Move the folder with the backup file to the required backup repository or create a new backup repository
with this folder as a subfolder.

TIP

Each Veeam Plug-in backup file (.VAB) has its own metadata file (.VASM). Make sure you import
backup files and all related metadata files. Also, you must import the backup job metadata file
(.VACM) which is stored in the same folder.

2. Use the Veeam Backup & Replication console to log in to Veeam Backup & Replication.

3. Open the Ba ckup Infrastructure view.

4. In the inventory pane of the Ba ckup Infrastructure view, select the Ba ckup Repositories node.

280 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 5. In the working area, select the required backup repository and click Rescan on the ribbon. Alternatively,
you can right-click the backup repository and select Rescan.

During the rescan operation, Veeam Backup & Replication gathers information about backups that are
currently available in the backup repository and up dates the list of backups in the configuration database.
After the rescan operation, backups that were not in this configuration database will be shown on the
Home view in the Ba ckups > Disk (Imported) node.

6. On the SAP on Oracle server, change the target backup repository in the Veeam Plug-in settings:

sudo SapOracleBackintConfigTool --set-repositories

Available backup repositories:
1. serv55.tech.local
2. serv07_repo
Enter repository number: 1
Configuration result:
SID SH2 has been configured

7. Run the --map-backup command:

NOTE

Before you re-map your backup to the repository, make sure that there is not an existing backup job
on your machine with Veeam Plug-in that is targeted at the same repository. If there is such a job,
delete this job from the Veeam Backup & Replication console.

sudo SapOracleBackintConfigTool --map-backup

281 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Upgrading Veeam Plug-in for SAP on Oracle
Periodically, Veeam releases a new version of Veeam Backup & Replication that contains new features and bug
fixes. The release package also contains a new version of Veeam Plug -ins.

If you want to upgrade Veeam Plug-in, note that Veeam Backup & Replication must be the same or later than
the version of Veeam Plug-in. If you want to use the latest functionality, you must upgrade both Veeam Backup
& Replication and Veeam Plug-in to the latest version. After the upgrade, you don't need to re-run the Veeam
Plug-in configuration wizard, the plug-in configuration files will be preserved.

IMP ORTANT

Consider the following:

• You must upgrade Veeam Backup & Replication before you upgrade Veeam Plug -ins. To learn how to
upgrade Veeam Backup & Replication, see the Upgrading to Veeam Backup & Replication 12.3 section
in the Veeam Backup & Replication User Guide.

• Veeam Backup & Replication supports two latest versions of Veeam Plug -ins. For example, Veeam
Backup & Replication 12.1 supports Veeam Plug-in 12.1 and 12.

Keep in mind that if you use an earlier Veeam Plug-in build than the one that is included in the
installation ISO file of your Veeam Backup & Replication version, it may not have all the features and
bug fixes introduced in your Veeam Backup & Replication version. To learn more ab out the Veeam
Plug-in builds included in Veeam Backup & Replication installation ISO files, see this Veeam KB
article.
• Operations in the terminal of the Linux machine require root privileges .

Before You Begin

Veeam Plug-in installation files are included in the installation disk image of Veeam Backup & Replication. You
must upload the installation file to the SAP HANA server. To do this, perform the following steps:

1. Mount the Veeam Backup & Replication installation disk

(VeeamBackup&Replication_12.3.0.310_20241201.iso).

2. Open the mounted disk image and go to the Plugins\SAP on Oracle\x64 directory.

3. Select the Veeam Plug-in installation file and upload it to the SAP HANA server.

The upgrade procedure depends on the type of package that you use:

• Upgrading Plug-in on Linux (.RPM)

• Upgrading Plug-in on Linux (.TAR.GZ)

Upgrading Plug-in on Linux (.RPM)

To upgrade Veeam Plug-in for SAP on Oracle from the .RPM package, perform the following:

1. Upload the new VeeamPluginforSAPOracle-12.3.0.310-1.x86_64.rpm package to the SAP HANA

server.

2. Run the following command. Note that the operation requires root privileges.

282 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 rpm -U VeeamPluginforSAPOracle-12.3.0.310-1.x86_64.rpm

TIP

To find out which version of Veeam Plug-in is installed on your server, you can use the following
command: rpm -qa | grep VeeamPlugin

Upgrading Plug-in on Linux (.TAR.GZ)

To upgrade Veeam Plug-in for SAP on Oracle on a Linux machine from the .TAR.GZ archive, do the following:

1. Upload the VeeamPluginforSAPOracle.tar.gz file to the Oracle Database server.

2. In the terminal, open the folder that contains the VeeamPluginforSAPOracle.TAR.GZ archive.

3. Unpack the plug-in files from the archive to the /opt/veeam directory. Old Veeam Plug-in files will be
replaced by new files.

tar -xzvf VeeamPluginforSAPOracle.tar.gz -C /opt/veeam

283 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Uninstalling Veeam Plug-in for SAP on Oracle
To uninstall Veeam Plug-in for SAP on Oracle, go to the directory with the Veeam Plug -in installation package
and run the following command. Note that the operation requires root privileges.

rpm -e VeeamPluginforSAPOracle

284 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Database Protection
After you configure Veeam Plug-in for SAP on Oracle, you can back up databases using SAP BR*Tools. Veeam
Plug-in will automatically transfer backup files to a backup repository and store them in the Veeam proprietary
format. The backup process itself is performed by SAP BR*Tools.

Keep in mind that examples in this section are provided only for demonstrating purposes. For details on full
backup functionality of SAP BR*Tools, see this SAP article.

In This Section
• Considerations and Limitations

• SAP on Oracle Backup Using Backint

• SAP on Oracle Backup Using RMAN_UTIL

• Backup Job in Veeam Backup & Replication

NOTE

This guide provides examples for SAP BR*Tools commands. Apart from BR*Tools scripts, you can perform
backup operations using BRTOOLS interactive wizard and BR*Tools Studio. For details, see this SAP article.

285 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Considerations and Limitations
Before you start using Veeam Plug-in for SAP on Oracle, consider the following:

• You can make incremental backups only with the rman_util parameter. For details, see this SAP article.
To learn how to perform an incremental backup, see Incremental Backup.

• Automatic Storage Management (Oracle ASM) is supported only with the rman_util parameter. If you
want to back up Oracle ASM instances, see SAP on Oracle Backup Using RMAN_UTIL.

• You cannot back up Oracle RAC databases using the BRBACKUP tool.

• Volume backup (-d util_vol, util_vol_online) is not supported.

• Backup of directories is not supported.

• Backups created by Veeam Plug-ins cannot be used as a source for file to tape or backup to tape jobs.

286 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

SAP on Oracle Backup Using Backint
Veeam Plug-in for SAP on Oracle integrates with the BRBACKUP tool and transfers backup files to backup
repositories connected to Veeam Backup & Replication. The backup process itself is performed by the
BRBACKUP tool. To perform the backup you can use BR*TOOLS or BR*TOOLS Studio.

For details on how the backup is performed, see How Veeam Plug-in for SAP on Oracle Works.

To back up Oracle databases, you can use the interactive wizard of BRTOOLS or you can directly run the backup
command using BRBACKUP. When you back up the database using the BRBACKUP tool, you must specify the
path to the initialization profile file ($Oracle_HOME/dbs/veeam_initSID.sap) as the argument for the -p
(-profile) parameter.

NOTE

You can make incremental backups only with the rman_util parameter. For details, see this SAP article.
To learn how to perform an incremental backup, see Incremental Backup.

Examples
The following examples are only for demonstration purposes. To see the description of all BRBACKUP
parameters, see the Backing Up the Database with BR*Tools for Oracle DBA Guide.

• Full Backup

• Redo Logs Backup

Full Backup
If you want to create a full backup Oracle databases, you can use the BRBACKUP tool. When Veeam Plug -in for
SAP on Oracle is configured, the plug-in transfers database backup files to a backup repository connected to
Veeam Backup & Replication.

Example 1. Performing Full Database Backup in Offline Mode

brbackup -p $Oracle_HOME/dbs/veeam_initSID.sap -d util_file -t offline_force -m

all -u <user>/<password>

Run the brbackup command with the following parameters:

1. Specify the path to the initialization profile file ($Oracle_HOME/dbs/veeam_initSID.sap) as the

argument for the -p (-profile) parameter.

2. Specify util_file as the argument for the -d (-device) parameter. This option defines that a file-by-
file backup will be performed using Veeam Plug-in.

3. Specify offline_force as the argument for the -t (-type) parameter. With this option, BRBACKUP
shuts down the database and performs an offline backup.

4. Specify the argument for the -m (-mode) parameter. With the all argument, BRBACKUP backs up files in
all tablespaces, but not the control files and online redo log files. For the full list of arguments for the -
mode parameter, see this SAP article.

287 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 5. Specify credentials that will be used to connect to the database as the argument for the -u (-user)
parameter. For details, see this SAP article.

Example 2. Performing Full Database Backup in Online Mode

brbackup -p $Oracle_HOME/dbs/veeam_initSID.sap -d util_file_online -t online_co

ns -m all -u <user>/<password>

Run the brbackup command with the following parameters:

1. Specify the path to the initialization profile file ($Oracle_HOME/dbs/veeam_initSID.sap) as the

argument for the -p (-profile) parameter.

2. Specify util_file_online as the argument for the -d (-device) parameter.

3. Specify online_cons as the argument for the -t (-type) parameter. With this option, BRBACKUP
backs up the database in the online state. Also, BRBACKUP keeps the database open during the backup. If
offline redo log files are generated during the backup, BRBACKUP backs up them to the same backup file.

4. Specify the argument for the -m (-mode) parameter. With the all argument, BRBACKUP backs up files in
all tablespaces, but not the control files and online redo log files. For the full list of arguments for the -
mode parameter, see this SAP article.

5. Specify credentials that will be used to connect to the database as the argument for the -u (-user)
parameter. For details, see this SAP article.

IMP ORTANT

When you use BRBACKUP, you must specify the full directory path to the Veeam Plug-in initialization
profile file (-p $Oracle_HOME/dbs/veeam_initSID.sap). If the profile file is in the default directory,
you can specify only the file name.

Redo Logs Backup

If you want to back up redo log files of Oracle databases separately from the database files, you can use the
BRARCHIVE tool. When Veeam Plug-in for SAP on Oracle is configured, the plug-in transfers the redo logs to a
backup repository connected to Veeam Backup & Replication.

NOTE

For redo log backup operations, it is recommended to set 4 or less parallel channels. For details on
configuring parallel channels, see Configuring Parallelism for Redo Logs.

Example: Performing Backup of Archived Redo Logs

To back up redo log files, run the following command.

brarchive -p $Oracle_HOME/dbs/veeam_initSID.sap -save -d util_file -u <user>/<p

assword>

1. Specify the path to the initialization profile file ($Oracle_HOME/dbs/veeam_initSID.sap) as the

argument for the -p (-profile) parameter.

288 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 2. Specify the archive function. The -save function used in this example archives offline redo log files to a
repository.

3. Specify util_file as the argument for the -d (-device) parameter. This option defines that a file-by-
file backup will be performed using Veeam Plug-in.

4. Specify credentials that will be used to connect to the database as the argument for the -u (-user)
parameter. For details, see this SAP article.

289 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

SAP on Oracle Backup Using RMAN_UTIL
The rman_util parameter allows you to back up Oracle databases using Oracle RMAN in combination with
Veeam Plug-in for Oracle RMAN. BACKINT provides an interface for Veeam Plug-in for Oracle RMAN and is used
to back up profiles, log files, control files and to perform incremental backups of databases.

For full description of the rman_util parameter, see RMAN Backup with an External Backup Library.

In the Veeam Backup & Replication console, the rman_util backup operation will create two backup jobs:
Veeam Plug-in for Oracle RMAN backup job for database file backups and another Veeam Plug -in for SAP on
Oracle backup job that backups up BR*Tools control data files. Note that if you want to create a backup copy job
for SAP on Oracle database, make sure that you have added both jobs to the backup copy job.

Prerequisites
IMP ORTANT
• Before you back up the Oracle database with the rman_util parameter, you must install and
configure Veeam Plug-in for Oracle RMAN on the SAP on Oracle server.
• See Limitations and Considerations.

When you perform the backup using the RMAN_UTIL, RMAN_STAGE or RMAN_DISK parameter, by default,
BR*Tools creates one backup set for each log or datafile. This means that every backup piece will contain only
one file. This results in a large amount of backup files and significantly slows down backup and restore
processes. To avoid this problem, do the following:

1. In the SAP on Oracle server, open the /oracle/ODB/sapprof/veeam_initSID.sap file using a text
editor.

2. Change the default values for the following parameters:

rman_filesperset = 10
rman_filesperset_arch = 100

For example: set the rman_filesperset value to 10 for datafiles and the rman_filesperset_arch
value to 100 for logs.

Also, you must add the SBT_LIBRARY directory to the rman_parms setting in the veeam_initSID.sap file:

1. In the SAP on Oracle server, open the /oracle/ODB/sapprof/veeam_initSID.sap file using a text
editor.

2. Add the following line in the veeam_initSID.sap file:

rman_parms = 'SBT_LIBRARY=/opt/veeam/VeeamPluginforOracleRMAN/libOracleRMA
NPlugin.so'

How SAP on Oracle Backup Using RMAN_UTIL Works

When you launch the BRBACKUP or BRARCHIVE tool with the RMAN_UTIL parameter, the following happens:

1. SAP BR*Tools launches the RMAN backup script.

2. Oracle RMAN launches Veeam Plug-in for Oracle RMAN services.

290 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 3. Oracle RMAN starts the backup process:

a. Veeam Plug-in compresses database backup files or redo logs and sends them to the target backup
repository through one or multiple channels.

b. Veeam Plug-in for Oracle RMAN connects to Veeam Backup & Replication and creates a backup job
object that shows the job progress and logs.

4. BR*Tools launches the Veeam Plug-in for SAP on Oracle services.

5. BR*Tools start the control data files backup:

a. Control file, BR*Tools logs are compressed and sent to a backup repository.

b. Veeam Plug-in for SAP on Oracle connects to Veeam Backup & Replication and creates a backup job
object that shows the job progress and logs.

Full Backup
To back up an SAP on Oracle database using RMAN, you must use the brbackup tool with the rman_util
parameter and with the defined directory for SBT library.

brbackup -p $Oracle_HOME/dbs/veeam_initSID.sap -t online_cons -d rman_util -m f

ull -u <user>/<password>

1. Specify the path to the initialization profile file (veeam_initSID.sap) as the argument for the -p (-
profile) parameter.

2. Specify online_cons as the argument for the -t (-type) parameter. With this option, BRBACKUP
backs up the database in the online state. Also, BRBACKUP keeps the database open during the backup. If
offline redo log files are generated during the backup, BRBACKUP backs up them to the same backup file.

3. Specify rman_util as the argument for the -d (-device) parameter. This option defines that the backup
will be performed using Oracle RMAN.

4. Specify full as the argument for the -m (-mode) parameter. With this option, BRBACKUP performs
backup of files in all tablespaces, control files and redo log files.

291 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 5. Specify credentials that will be used to connect to the database as the argument for the -u (-user)
parameter. For details, see this SAP article.

For the fill list of BRBACKUP parameters, see the Command Options for BRBACKUP section in the SAP Database
Guide: Oracle.

Incremental Backup
You can perform an incremental backup by using the BRBACKUP command with the rman_util parameter. An
incremental backup contains the changed data from the last full back up. Incremental backups use less media
and resources than full backups.

Example: Performing Incremental Backup in Online Mode

brbackup -p $Oracle_HOME/dbs/veeam_initSID.sap -t online_cons -d rman_util -m i

ncr -u <user>/<password>

Run the brbackup command with the following parameters:

1. Specify the path to the initialization profile file ($Oracle_HOME/dbs/veeam_initSID.sap) as the

argument for the -p (-profile) parameter.

2. Specify online_cons as the argument for the -t (-type) parameter. With this option, BRBACKUP
backs up the database in the online state. Also, BRBACKUP keeps the database open during the backup. If
offline redo log files are generated during the backup, BRBACKUP backs up them to the same backup file.

3. Specify rman_util as the argument for the -d (-device) parameter. This option defines that the backup
will be performed using Oracle RMAN.

4. Set incr as the argument for the -m (-mode) parameter.

5. Specify credentials that will be used to connect to the database as the argument for the -u (-user)
parameter. For details, see this SAP article.

To see all brbackup command options, see the Command Options for BRBACKUP section in the SAP Database
Guide: Oracle.

292 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Backup Job in Veeam Backup & Replication
TIP

If you want to configure or manage an application backup policy for Veeam Plug -in operating in the
managed mode, see Working with Application Policies.

After you start a backup process with the BRBACKUP tool, Veeam Backup & Replication creates a backup job
object. You can use this job to view the statistics on the backup process, generate backup job reports or you can
also disable the backup job.

You cannot launch or edit SAP on Oracle backup job objects in the Veeam Backup & Replication console. You can
manage backup operations only on the SAP on Oracle side using BR*Tools.

Consider that Veeam Backup & Replication generates the backup job name based on names of the SAP on Oracle
server and selected repository.

NOTE

Due to specifics of the SAP on Oracle backup process, the progress bar of a running SAP on Oracle backup
job is not available.

To view details of a backup job process, do the following:

1. Open the Veeam Backup & Replication console.

2. In the Home view, expand the Job s node and click Ba ckup.

3. In the list of jobs, select the BR*Tools backup job to see details of the current backup process or the last
backup job session.

293 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Generating Backup Job Reports
Veeam Backup & Replication can generate reports with details about an BR*Tools backup job session
performance. The session report contains the following session statistics: session duration details, details of the
session performance, amount of read, processed and transferred data, backup size, compression ratio, li st of
warnings and errors (if any).

1. Open the Home view.

2. In the inventory pane, select Job s .

3. In the working area, select the necessary job and click Rep ort on the ribbon. You can also right-click the
job and select Rep ort.

Disabling Backup Job

You can disable BR*Tools backup jobs in the Veeam Backup & Replication console. If you disable the job, you
will not be able to run BR*Tools backup commands on the SAP on Oracle server.

To disable a backup job:

1. Open the Home view.

2. In the inventory pane, select Job s .

294 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 3. In the working area, select the necessary job and click Disable on the ribbon. You can also right-click the
job and select Disable.

295 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Database Recovery
With the configured Veeam Plug-in you can restore Oracle databases from the backups that reside on backup
repositories. All restore operations are performed on the SAP BR*Tools side.

Keep in mind that examples provided in this section are for demonstration purposes only. To see the full restore
functionality of SAP BR*Tools, see the BR*Tools for Oracle DBA Guide.

To learn how to recover Oracle databases from backups created by Veeam Plug -in for SAP on Oracle, see the
following subsections:

• Restore Oracle Databases

• Restore Redo Logs

• Restore from Hardened Repository

296 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Restore Oracle Databases
Veeam Plug-in for SAP on Oracle allows you to restore databases using the BRRESTORE tool functionality. When
you launch the restore, BRRESTORE restores the selected database from backup files stored on the backup
repository.

By default, BRRESTORE uses the initSID.sap initialization profile. Thus, you must specify the -p
$Oracle_HOME/dbs/veeam_initSID.sap parameter in the restore commands.

For details on all restore options, see this SAP article.

Example: Performing Full Restore of SAP on Oracle Database

brrestore -d util_file -p $Oracle_HOME/dbs/veeam_initSID.sap -b last -m full

Run the brrestore command with the following parameters:

1. Depending on which backup you want to restore from, use the util_file or rman_util option as the
argument for the -d (-device) parameter. If the backup was created by Backint, use util_file. If the
backup was created by RMAN, use rman_util.

2. Specify the path to the initialization profile file ($Oracle_HOME/dbs/veeam_initSID.sap) as the

argument for the -p (-profile) parameter.

3. Specify last as the argument for the -b (-backup) parameter. With this option, BRRESTORE uses the
last successful database backup for the restore.

4. Specify full as the argument for the -m (-mode) parameter. With this option, BRRESTORE performs
restore of files in all tablespaces, control files and redo log files.

297 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Restore Redo Logs
If you want to restore redo log files that were backed up with BRARCHIVE, you can use the BRRESTORE tool. For
details, see this SAP article.

Example: Performing Restore of SAP on Oracle Redo Logs

brrestore -d util_file -p $Oracle_HOME/dbs/veeam_initSID.sap -a 1-100

Run the brrestore command with the following parameters:

1. Depending on which backup you want to restore from, use the util_file or rman_util option as the
argument for the -d (-device) parameter. If the backup was created by Backint, use util_file. If the
backup was created by RMAN, use rman_util.

2. Specify the path to the initialization profile file ($Oracle_HOME/dbs/veeam_initSID.sap) as the

argument for the -p (-profile) parameter.

3. Specify the log sequence number interval as the argument for the -a (-archive) parameter. This option
defines which log files must be restored.

298 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Restore to Another Server (System Copy)
You can restore Oracle databases from Veeam Plug-in backups to another server. To restore databases to
another server, you must specify an authentication method to access the backup created for the original server
and then select the backup from which you want to restore a database.

Veeam Plug-in supports the following authentication methods to access backups:

• Using credentials of the account under which the backup was created. This option is intended for backups
created using backup tools on the SAP on Oracle server.

• Using a security certificate. This option is intended for backups created using an application backup policy
configured in Veeam Backup & Replication.

• Using a recovery token. This option is intended for backups created using an application backup policy
configured in Veeam Backup & Replication. To use this option, a backup administrator must create a
recovery token for the backup in Veeam Backup & Replication.

You can select the authentication method explicitly or choose to use the same method that was s pecified during
the Veeam Plug-in configuration process.

Consider the following:

• For restore to another server, you can use either backups or backup copies of Oracle databases.

• If you perform restore from a backup that was imported to Veeam Backup & Replication, Veeam Plug-in
will automatically create the backup job in Veeam Backup & Replication.

• During the restore process, backup operations are not disabled on the SAP on Oracle server.

Restore to Another Server Using Configured Authentication

You can restore a database to another server using an account and authentication method that were specified in
the Veeam Plug-in settings during the Veeam Plug-in configuration process. To do this, do the following:

1. Go to /opt/veeam/VeeamPluginforSAPOracle and run the following command:

VM2ADM:/opt/veeam/VeeamPluginforSAPOracle> SapOracleBackintConfigTool --se

t-backup-for-restore

2. Veeam Plug-in will prompt you to select an authentication method to access the backup. To access the
backup using the authentication method that was specified during the Veeam Plug -in configuration
process, type 1:

Select authentication type or disable the functionality:

0. To disable the functionality
1. Currently set authentication data
2. Credentials
3. Recovery token
Enter authentication type number:
1

299 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 3. Veeam Plug-in will display backups available for restore under the user account specified in the Veeam
Plug-in configuration. The list of backups depends on the authentication method specified for the user
account:

o For the user account with a security certificate, Veeam Plug -in displays backups created under this
user account.

o For the user account with credentials, if the account has the Veeam Restore Operator role assigned in
Veeam Backup & Replication, Veeam Plug-in displays all backups that reside in the backup repository.
Otherwise, Veeam Plug-in displays backups created under the specified user account.

o For the user account with a recovery token, Veeam Plug -in displays backups for which the recovery
token was generated.

Select a backup to start the restore process:

Select backup to be used:

1. Backup1
2. Backup2
3. Backup3
Enter backup number: 3
The selected backup [Backup3] will be used for all restore operations.

4. Perform restore to another server.

Restore to Another Server Using Credentials

To restore a database to another server, you can specify credentials of a user account under which the backup
was created. To do this, do the following:

1. Go to /opt/veeam/VeeamPluginforSAPOracle and run the following command:

VM2ADM:/opt/veeam/VeeamPluginforSAPOracle> SapOracleBackintConfigTool --se

t-backup-for-restore

2. Veeam Plug-in will prompt you to select an authentication method to access the backup. To access the
backup using credentials of the account under which the backup was created, type 2:

Select authentication type or disable the functionality:

0. To disable the functionality
1. Currently set authentication data
2. Credentials
3. Recovery token
Enter authentication type number:
2

3. Veeam Plug-in will prompt you to provide credentials of the user account that under which the backup
was created. Enter a user name and password of the account:

Enter username:
Enter password for <username>:

300 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 4. Veeam Plug-in will display backups available for restore under the specified user account. If the account
has the Veeam Restore Operator role assigned in Veeam Backup & Replication, Veeam Plug-in displays all
backups that reside in the backup repository. Otherwise, Veeam Plug -in displays backups created under
the specified user account.

Select a backup to start the restore process:

Select backup to be used:

1. Backup1
2. Backup2
3. Backup3
Enter backup number: 3
The selected backup [Backup3] will be used for all restore operations.

5. Perform restore to another server.

Restore to Another Server Using Recovery Token

You can restore a database to another server using a recovery token generated in Veeam Backup & Replication
and provided to you by a backup administrator. To do this, do the following:

1. Go to /opt/veeam/VeeamPluginforSAPOracle and run the following command:

VM2ADM:/opt/veeam/VeeamPluginforSAPOracle> SapOracleBackintConfigTool --se

t-backup-for-restore

2. Veeam Plug-in will prompt you to select an authentication method to access the backup. To access the
backup using a recovery token, type 3:

Select authentication type or disable the functionality:

0. To disable the functionality
1. Currently set authentication data
2. Credentials
3. Recovery token
Enter authentication type number:
3

3. Veeam Plug-in will display the fingerprint of the Veeam Backup & Replication server and prompt you to
provide a recovery token:

Veeam Backup & Replication server fingerprint: CA4F820F164C02A9AAC75562FC3

5330A93CDAA3C.
Continue? (y/n) : y
Enter recovery token:

301 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 4. Veeam Plug-in will display backups for which the recovery token was generated. Select the necessary
backup:

Select backup to be used:

1. Backup1
2. Backup2
3. Backup3
Enter backup number: 3
The selected backup [Backup3] will be used for all restore operations.

5. Perform restore to another server.

302 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Restore from Backup Copy
You can restore Oracle databases from backup copies created for Veeam Plug-in for SAP on Oracle backups. The
procedure of database restore from a backup copy is the same as database restore to another server. For more
information, see Restore to Another Server (System Copy).

303 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Restore from Hardened Repository
As a result of malware activity or unplanned actions, backup job metadata (VACM) files may become unavailable
in the hardened repository. In this case, to restore data from the hardened repository, you must re -create the
VACM file. To do this, complete the following steps:

1. Run a Veeam Plug-in backup job to create a new Veeam Plug-in backup in a Veeam backup repository. The
backup will consist of the .VAB, .VASM and .VACM files.

2. In the backup repository folder, replace the .VAB and .VASM files created at the step 1 with the .VAB and
.VASM files from the hardened repository.

3. In the Veeam backup console, run the backup repair operation. Veeam Backup & Replication will generate
a new .VACM file using information from the .VASM files. For details, see Repairing Backup.

Once the backup job metadata file is re-created, you can use Veeam Plug-in to restore your data.

Repairing Backup
If you want to restore data from an immutable backup that resides in a hardened repository, you can use the
Rep air operation. During this operation, Veeam Backup & Replication will generate a new backup job metadata
(.VACM) file using information from the backup metadata (.VASM) files.

IMP ORTANT

This operation is intended only for a situation where the backup job metadata file has been lost as a result
of malware activity or unplanned actions. Re-creation of the backup job metadata file for other purposes is
not supported.

Before you start the repair operation, you must disable the backup job that created the backup. Otherwise,
Veeam Backup & Replication will display a message notifying that the job must be disabled.

To repair a backup:

1. In the Veeam Backup & Replication console, open the Home view.

2. In the inventory pane, select Ba ckups.

3. In the working area, select the necessary backup.

304 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 4. Press and hold the [Ctrl] key, right-click the backup and select Rep air.

305 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Retention of SAP on Oracle Backups
To set an automatic removal of old backups, you can use the retention policy of Veeam Plug -in for SAP on
Oracle. The --set-force-delete command of Veeam Plug-in automatically deletes backup files which are
older than specified number of days. For details, see Configuring Retention Policy for Backups.

Also, you can manually delete backups from a backup repository using the Veeam Backup & Replication console.
For details, see Deleting Backups Manually Using Veeam Backup & Replication Console.

306 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Configuring Retention Policy for Backups
Veeam Plug-in for SAP on Oracle has a functionality that automatically deletes backup files which are older than
specified number of days. For example, you can use it if a backup repository contains backup files that are no
longer in the backup catalog.

1. To enable automatic deletion of backup files, run the following command.

SapOracleBackintConfigTool --set-force-delete

2. Enter the number of days after which Veeam Plug-in will delete backup files on all configured backup
repositories.

Garbage collector automatically deletes backup files older than the specif
ied number of days.
Make sure the number of days value exceeds your retention policy.
To disable this functionality, set the number of days to 0.
Enter the number of days to delete backups after, between 7 and 999 [0]:

By default, the force delete functionality is disabled (set to 0).

IMP ORTANT

A value for the numb er of days setting must be at least 1 backup generation period longer than the
retention period for your Oracle Database backups. Otherwise, Veeam Plug -in will delete earliest backups
created within the retention period.

307 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Deleting Backups Manually
Apart from configuring the retention policy, you can delete backups manually from backup repositories using
the Veeam Backup & Replication console.

NOTE

If you remove backups from a backup repository manually, the backup catalog will not be updated.

To remove a backup from a backup repository, do the following:

1. In the Veeam Backup & Replication console, open the Home view.

2. In the Inventory pane, select Ba ckups.

3. In the working area, right-click the backup job object name and select Delete from disk.

308 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Removing Backups from Configuration
If you want to remove records about backups from the Veeam Backup & Replication console and configuration
database, you can use the Remove from configuration operation.

When you remove a backup from the configuration, backup files (.VAB, .VASM) remain on the backup repository.
You can import backup files later and restore from them.

To remove a backup from configuration:

1. Open the Home view.

2. In the inventory pane, select Ba ckups.

3. In the working area, select the necessary backup.

4. Press and hold the [Ctrl] key, right-click the backup and select Remove from configuration.

309 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Backup Copy for SAP on Oracle Backups
Having just one backup does not provide the necessary level of safety. The primary backup may get destroyed
together with production data, and you will have no backups from which you can restore data.

To build a successful data protection and disaster recovery plan, it is recommended that you follow the 3 -2-1
rule:

• 3: You must have at least three copies of your data: the original production data and two backups.

• 2: You must use at least two different types of media to store the copies of your data, for example, local
disk and cloud.

• 1: You must keep at least one backup offsite, for exa mple, in the cloud or in a remote site.

Thus, you must have at least two backups and they must be in different locations. If a disaster takes out your
production data and local backup, you can still recover from your offsite backup.

In This Section
• Creating Backup Copy Job

• Converting Backup Copy to Backup

310 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Creating Backup Copy Job
Veeam Backup & Replication offers the backup copy functionality that allows you to create several instances of
the same backup in different locations, whether onsite or offsite. Backup copies have the same format as those
created by backup jobs and you can recover your data from them when you need it.

Veeam Backup & Replication fully automates the backup copy process and lets you specify retention settings to
maintain the desired number of restore points, as well as full backups for archival purposes. Backup copy is a
job-driven process. When enabled, the backup copy job for Veeam Plug -in backups runs continuously. For more
details on how it works, see the Backup Copy section in the Veeam Backup & Replication User Guide.

To copy backups to a secondary location, you must configure a backup copy job. The backup copy job defines
how, where and when to copy backups. One job can be used to process backups of one or more machines.

You can configure a job and start it immediately or save the job to start it later.

Before creating a job, check prerequisites. Then use the New Backup Copy Job wizard to configure a backup
copy job.

1. Launch Backup Copy Job wizard.

2. Specify a job name and description.

3. Select backups to process.

4. Define backup copy target.

5. Specify advanced settings.

6. Define backup copy schedule.

7. Finish working with the wizard.

Before You Begin

Before you create a backup copy job, check the prerequisites and limitations:

• Backup infrastructure components that will take part in the backup copy process must be added to the
backup infrastructure and properly configured. These include source and target backup repositories
between which backups must be copied.

• The target backup repository must have enough free space to store copied backups. To receive alerts
about low space on the backup repository, configure global notification settings. For more information,
see Specifying Other Notification Settings.

311 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 1. Launch Backup Copy Job Wizard
To create a backup copy job, do the following:

1. In the Veeam Backup & Replication console, open the Home view.

2. Click the Ba ckup Copy tab and select Ap p lication-level backup.

312 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 2. Specify Job Name and Description
At the Job step of the wizard, specify a name and description for the backup copy job.

1. In the Na me field, enter a name for the job.

2. In the Description field, enter a description for the job. The default description contains information about
the user who created the job, date and time when the job was created.

313 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 3. Select Backups to Process
At the Ob ject step of the wizard, select machines whose backups you want to copy to the target repository.

1. Click the Ad d button and select from which entity you want to process the machines.

o From jobs: You can select Veeam Plug-in backup jobs. When a backup copy job runs, Veeam Backup &
Replication will search for backup files created by selected jobs.

o From repositories: You can select repositories where Veeam Plug-in backups are stored. When a
backup copy job runs, Veeam Backup & Replication will search for backup files created by Veeam
Plug-in in selected repositories.

2. Use the Remove button if you want to remove selected jobs or repositories from processing.

3. If you have added jobs from a repository and want to exclude from processing some of the backup jobs on
the selected repository, click E x clusions and select the jobs that you want to exclude.

314 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Step 4. Define Backup Copy Target
At the Ta rget step of the wizard, configure the target repository settings.

1. From the Ba ckup repository list, select a backup repository in the target site where copied backups must
be stored. When you select a target backup repository, Veeam Backup & Replication automatically checks
how much free space is available on it. Make sure that you have enough free space to store copied
backups.

IMP ORTANT

For Veeam Plug-in backup copy jobs, you cannot select the following repositories as a backup copy
target:

• Veeam Cloud Connect repository

• Object storage repository

2. If the target repository contains a Veeam Plug-in or MongoDB backup that was excluded from the backup
copy job, and if you don't want to transfer duplicate data, you can use the mapping feature.

After you configure mapping, if some of backup files (.VAB) of the source backup are missing in the target
backup copy, these files are uploaded to the target backup copy.

NOTE

Veeam Plug-in backup copy jobs do not use WAN accelerators.

To map a backup copy job to the backup:

a. Click the Ma p backup link.

b. Point the backup copy job to the backup in the target backup repository. Backups in the target backup
repository can be easily identified by backup job names. To facilitate search, you can use the search
field at the bottom of the window.

IMP ORTANT

Keep in mind that repositories must meet the following requirements:

• Used account must have access to Veeam backup repositories that you plan to use.
• Encryption must be disabled on the repository.

Otherwise, the repositories will not be listed as available. To learn how to configure access
permissions and encryption settings on repositories, see Access Permissions in the Veeam Backup &
Replication User Guide.

315 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 3. You can specify the number of days after which the backup copy will be deleted from the repository. Note
that the countdown starts from the moment when source backup has been created.

316 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 5. Specify Advanced Settings
At the Ta rget step of the wizard, click Ad vanced to configure storage, RPO warning, and notifications settings.

• Storage settings

• RPO warning settings

• Notification settings

Storage Settings
At the Storage tab, define compression and deduplication settings.

By default, Veeam Backup & Replication performs deduplication before storing copied data on the target backup
repository. Deduplication provides a smaller size of the resulting backup file but may reduce the job
performance.

1. You can disable data deduplication. To do this, clear the E na ble inline data deduplication check box.

2. From the Compression level list, choose a compression level to be used: Auto, None, Dedupe-friendly,
Op timal, High or E x treme. The recommended level of compression for backup copy jobs is Auto. In this
case, Veeam Backup & Replication uses compression settings of the copied backup files. For more
information, see Compression and Deduplication.

RPO Warning Settings

At the RP O Monitor tab, specify RPO warning settings.

317 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Enable the W a rn me if backup is not copied within check box and specify the time period in minutes, hours, or
d a ys.

If the backup copy is not created within the specified time p eriod, the backup copy job will finish with the
Warning status. The countdown starts from the moment when the required backup is finished and ready to be
copied.

Notification Settings
At the Notifications tab, to specify notification settings for the backup copy job:

1. At the Ta rget step of the wizard, click Ad vanced.

2. Click the Notifications tab.

3. Select the Send SNMP notifications for this job check box if you want to receive SNMP traps when the job
completes successfully. SNMP traps will be sent if you specify global SNMP settings in Veeam Backup &
Replication and configure software on recipient's machine to receive SNMP traps. For more information,
see Specifying SNMP Settings.

4. Select the Send email notifications to the following recipients check box if you want to receive
notifications by email in case of job failure or success. In the field below, specify a recipient email address.
You can enter several addresses separated by a semicolon.

5. Veeam Backup & Replication sends a consolidated email notification once for the specified backup copy
interval. Even if the synchronization process is started several times within the interval, for example, due
to job retries, only one email notification will be sent.

6. Email notifications will be sent if you configure global email notification settings in Veeam Backup &
Replication. For more information, see Configuring Global Email Notification Settings.

318 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 7. At the Send at field, specify the time when you want to receive notifications. Note that you will receive a
notification on the job status once a day.

8. You can choose to use global notification settings or specify custom notification settings.

o To receive a typical notification for the job, select Use global notification settings. In this case, Veeam
Backup & Replication will apply to the job global email notification settings specified for the backup
server. For more information, see Configuring Global Email Notification Settings.

o To configure a custom notification for a job, select Use custom notification settings specified below.
You can specify the following notification settings:

i. In the Sub ject field, specify a notification subject. You can use the following variables in the
subject: %Time% (completion time), %JobName%, %JobResult%, %VmCount% (number of
machines in the job) and %Issues% (number of machines in the job that have been processed
with the W a rning or Fa iled status).

ii. Select the Notify on success, Notify on warning and Notify on error check boxes to receive email
notification if data processing within the backup copy interval completes successfully, fails or
completes with a warning.

319 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 6. Define Backup Copy Schedule
At the Schedule step of the wizard, define a time span in which the backup copy job must not transport data
between source and target backup repositories. For more information, see Backup Copy Window.

To define a backup window for the backup copy job:

1. Select the During the following time p eriods only option.

2. In the schedule box, select the desired time area.

3. Use the E na ble and Disable options to mark the selected area as allowed or prohibited for the backup copy
job.

320 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 7. Review Backup Copy Job Settings
At the Summary step of the wizard, complete the procedure of backup copy job configuration.

1. Review details of the backup copy job.

2. Select the E na ble the job when I click Finish check box if you want to start the job right after you finish
working with the wizard.

3. Click Finish to close the wizard.

321 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Converting Backup Copy to Backup
If you have imported backup copy files created by a backup copy job from another repository, you can convert
them into regular backup files. When you convert backup copy files to regular backup files, Veeam Plug -in
creates a backup job and adds attaches the converted backup files to it. You can use this backup job to continue
the backup chain and use converted backup files as a restore point.

If you have imported backups created by a backup copy job from another repository, you can convert them into
regular backup files. When you convert backup copy files to regular backup files, Veeam Plug -in creates a
backup job and adds attaches the converted backup files to it. You can use this backup job to continue the
backup chain and use converted backup files as a restore point.

You can convert imported Veeam Plug-in backups into regular Veeam Plug-in backup files in the following
cases:

• If you have deleted a backup copy job which created the backup copy.

• If you have excluded a backup job from a backup copy job that used multiple backup jobs as a source.

• If you have imported a Veeam Plug-in backup copy from another repository.

NOTE

If you want to restore from a backup copy, you don't need to convert the backup copy to backup. For
details, see Restore from Backup Copy.

Converting Backup Copy to Backup for SAP HANA

To convert a backup copy to a primary backup, use the --p romote-backup-copy-to-primary parameter as shown
below:

SapOracleBackintConfigTool --promote-backup-copy-to-primary
Backup copies available for promotion to primary backup:
1. Backup Copy Job 1\saprhel01-localdomain SAP backint backup (Default Backup R
epository)
Select backup: 1
Promotion of backup copy to a primary backup will reconfigure the plug-in to us
e a different repository. Continue? (y/N): y

IMP ORTANT

[For servers with the customServerName option] To avoid failure of conversion of backup copies, the
server name must be the same as the name used in the backup copy.

322 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Logs and Support
If you have any questions or issues with Veeam Plug-in for SAP on Oracle or Veeam Backup & Replication, you
can search for a resolution on Veeam Community Forums or submit a support case on the Veeam Customer
Support Portal.

When you submit a support case, we recommend that you attach log files related to Veeam Plug -in operations.

Veeam Plug-in Logs

To export Veeam Plug-in logs, do the following:

1. On the Veeam Backup & Replication server, go to %PROGRAMDATA%\Veeam\Backup\Plugin.

2. Copy logs of the required backup or restore process.

SAP Backint Logs

To export SAP Backint logs, on the SAP on Oracle server, go to /tmp/veeam_plugin_logs/<user_name>/
and copy the following files:

• SapOracleBackint.log

• SapBackintOracleManager.log

• Agent.Source.log

BRTools Logs
The Detail and Summary logs of BRTools are stored in the /oracle/SID/sapbackup and
/oracle/SID/saparch directories.

For details, see the following SAP articles:

• BRBACKUP Logs

• BRRESTORE Logs

• BRARCHIVE Logs

• BRRECOVER Logs

323 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Veeam Plug-in for Microsoft SQL Server
Veeam Plug-in for Microsoft SQL Server is a backup tool for Microsoft SQL Server databases. Veeam Plug -in
integrates with Microsoft SQL Server Management Studio and transfers database backups and transaction log
backups to backup repositories configured in Veeam Backup & Replication.

Database administrators can use Veeam Plug-in for Microsoft SQL Server to create native application-level
backups of Microsoft SQL Server data. Compared to image-level backups created by Veeam Backup &
Replication, Veeam Plug-in offers more flexible scenarios for database backup. In particular, Veeam Plug -in
users can back up and restore individual Microsoft SQL Server databases, as well as configure independent
backup schedule for full, differential and log backups using the SQL Agent Job functionality of Microsoft SQL
Server.

324 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Overview
Veeam Plug-in for Microsoft SQL Server integrates Microsoft SQL Server and Veeam Backup & Replication to
manage database backup and restore operations. When configured, Veeam Plug -in for Microsoft SQL Server
allows Microsoft SQL Server to perform backup operations and store backups directly on Veeam Backup &
Replication backup repositories. For details, see How Veeam Plug-in for Microsoft SQL Server Works.

Integrating Microsoft SQL Server and Veeam Backup & Replication enables Veeam Plug -in to use native
Microsoft SQL Server backup features while using Veeam Backup & Replication backup management and storage
capabilities. You can perform full, differential and transaction log backup operations using the Microsoft SQL
Server Management Studio. You can use Microsoft SQL Server Management Studio to initiate backup operations
and manage stored backups. Use the Veeam Backup & Replication console only to view backup operation
processes and create backup job reports. For details, see Data Backup.

In case of malware activity or unplanned actions, you can perform restore operations based on the backup data
transferred by Veeam Plug-in to the Veeam Backup & Replication backup repositories. You can restore entire
databases from a full backup or to a specific point in time, based on transaction logs. Veeam Plug -in for
Microsoft SQL Server supports restoring databases to the original Microsoft SQL Server machine or another
server. For details, see Data Restore.

325 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

How Veeam Plug-in for Microsoft SQL Server
Works
Veeam Plug-in for Microsoft SQL Server performs backup of Microsoft SQL Server databases in the following
way:

1. When the backup process is started for the first time, Veeam Plug -in connects to the Veeam Backup &
Replication server and creates the backup job.

2. At the backup process start (upon schedule or manually), the MSSQLRecoveryManager service of Veeam
Plug-in instructs Microsoft SQL Server to back up a database.

3. The MSSQLRecoveryManager service starts the source Veeam Data Mover on the Microsoft SQL Server
machine, and Veeam Backup Manager in Veeam Backup & Replication starts the target Veeam Data Mov er
on the Veeam backup repository.

4. Microsoft SQL Server starts the database backup process targeted at a VDI Device — a virtual device that
impersonates itself as a backup storage. For each backed -up database, a separate VDI Device is created.
The number of VDI Devices also depends on the number of parallel data streams that you specify when
configuring backup settings. For more information, see Parallel Database Processing.

5. The source Veeam Data Mover reads the backup data from VDI Devices and transfers it to the target
Veeam Data Mover.

6. The target Veeam Data Mover writes the backup data to the backup repository.

Parallel Database Processing

Veeam Plug-in allows you to back up the same Microsoft SQL Server database in multiple parallel streams. To
do this, you must specify the necessary number of data streams when configuring backup settings. For each
data stream, a separate VDI Device is created.

326 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

If you back up multiple databases simultaneously, a separate VDI Device is created for each backed-up database.

327 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Data Backup
Veeam Plug-in for Microsoft SQL Server integrates and uses native Microsoft SQL Server mechanisms to back up
data to the Veeam backup repository.

With the configured Veeam Plug-in, you can back up Microsoft SQL Server databases, as well as configure
backup schedules for full, differential and log backups using built-in tools of Microsoft SQL Server. You can also
perform independent copy-only full backups and copy-only log backups to not affect the database backup
chain. For details on backup operations, see About Microsoft SQL Server Backup.

You can use the following tools to perform backup operations for Microsoft SQL Server databases:

• Back up with the Ba ck Up Database wizard.

When you use the Ba ck Up Database wizard, you can specify the backup settings for Veeam Plug -in
backups of Microsoft SQL Server databases. You can also use Microsoft SQL Server Management Studio or
a third-party scheduling tool to define the schedule for database backup. For details, see Configuring
Backup Settings.

• Back up with the MSSQLRecoveryManager.exe tool in the command-line interface.

When you use the MSSQLRecoveryManager.exe tool, you can specify backup parameters to configure,
perform and schedule all types of backups in the command -line interface. You can also use the backup
parameters to modify Veeam Plug-in for Microsoft SQL Server commands used in custom scripts. For
details, see Performing Backup with Command-Line Interface.

After Veeam Plug-in for Microsoft SQL Server starts the backup process, Veeam Backup & Replication creates
the backup job. You can use this job to monitor backup processes and generate backup job reports. You cannot
start or edit Microsoft SQL Server backup jobs in the Veeam Backup & Replication console. You can manage
backup operations on the Microsoft SQL Server machine only. For details, see Managing Backup Job in Veeam
Backup & Replication.

To store backups, you can add and configure backup repositories to your Veeam Backup & Replication
infrastructure. For details on supported backup repositories, see Veeam Backup Repositories.

Veeam Backup Repositories

Veeam Plug-ins store backup files in repositories added to the Veeam Backup & Replication infrastructure. This
section lists supported types of backup repositories and limitations for Veeam Plug -in for Microsoft SQL Server
backups.

Before you start performing operations on backup repositories within the Veeam Backup & Replication
infrastructure, consider that you need to set the access permissions for each repository. For details, see Access
and Encryption Settings on Backup Repositories.

Supported Backup Repositories

You can use the following types of repositories added to the Veeam Backup & Replication infrastructure to store
backups created with Veeam Plug-in for Microsoft SQL Server:

• Windows Server

• Linux Server

• SMB (CIFS) Share

• NFS Share

328 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 • Dell Data Domain with Data Domain Boost (DDBoost)

• HPE StoreOnce

If you plan to use HPE StoreOnce as a backup repository for Veeam Plug-in backups, the total number of
stored files (data and metadata) must not exceed 3,000,000 per Catalyst store. If necessary, multiple
Catalyst stores may be created on the same StoreOnce system.

• Quantum DXi

• ExaGrid
Make sure the repository is configured as described in the ExaGrid section in the Veeam Backup &
Replication User Guide.

• Hardened Repository

• Scale-Out Backup Repository

Make sure that the performance extents of the scale-out backup repository contain repositories supported
by Veeam Plug-in for Microsoft SQL Server. For example, you cannot use object storage repositories as
performance extents to keep backups created with Veeam Plug -ins.

Backup Repository Limitations

• For Veeam Plug-in backups, the warning which indicates that free space on a storage device has reached a
specified threshold is configured in the veeam_config.xml file of Veeam Plug-in. The warning settings
in the Veeam Backup & Replication console does not affect this setting.

To configure the warning settings, add the following parameter in the veeam_config.xml file:

<PluginParameters repositoryFreeSpacePercentWarning="10" />

Keep in mind that you must add the parameter to the existing line in the veeam_config.xml file. If you
create a new line with the same name as the existing line, Veeam Plug -in will consider parameters only in
the first detected line. Other parameters will be ignored.

• The plug-in configuration wizard will not show repositories where the E ncrypt standalone application
b a ckups stored in this repository option is enabled. To learn how to disable the encryption option, see
Access and Encryption Settings on Backup Repositories.

If you want to use the same backup target with the repository-based encryption and Veeam Plug-ins,
create a second repository in the subfolder for Veeam Plug -in backups.

Alternatively, you can use transparent data encryption (TDE) provided by Microsoft. Using TDE, you can
encrypt database data with an encryption key, back up encrypted data with Veeam Plug -in, then restore
data and decrypt using the same encryption key. To learn more about TDE encryption, see this Microsoft
article.

• Veeam extract utility cannot extract Veeam Plug-in backup files. By design of Microsoft SQL Server, these
files cannot be imported “as files” as they contain additional metad ata bound to the used SBT device.

• Veeam Plug-ins do not support backup operations targeted directly to object storage repositories.

To learn more about object storage repositories, see the Object Storage Repositories section in the Veeam
Backup & Replication User Guide.

• Veeam Plug-ins do not support backup operations to object storage added as a performance extent of a
scale-out backup repository.

329 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Veeam Scale-Out Backup Repositories
If you want to store Veeam Plug-in backups in scale-out backup repositories, consider the following:

• You cannot rename a scale-out backup repository with Veeam Plug-in backups stored on this repository.

• If you want to add a backup repository as an extent to a scale-out backup repository and Veeam Plug-in
backups are present on this backup repository, you must do the following:

a. In the Veeam Backup & Replication console, select Veeam Plug -in backup files that reside in this
backup repository and remove them from configuration. For details, see Removing Backups from
Configuration. Note that this action does not delete the backups from the repository.

b. In the Veeam Backup & Replication console, delete the Veeam Plug-in backup job. For details, see
Deleting Jobs.

c. Add the repository as an extent to the scale-out repository. For details, see Extending Scale-Out
Repositories.

d. Rescan the scale-out repository. For details, see Rescanning Scale-Out Repositories.

NOTE

[For imports to the scale-out backup repository] Before importing your backup, consider that
the names of all backup files (.VAB, .VASM, .VACM) and paths to these files contain only the
following allowed characters:

• a-zA-Z0-9
• _-.+=@^

If your backup was initially created on a standalone backup server, the default name of the
backup metadata file (.VACM) contains forbidden characters. Before importing, you must delete
forbidden characters from the file name or replace them with the allowed characters.

e. On the Veeam Plug-in server, launch the Configure Plug-in wizard and set the scale-out repository as
the target for backups:

330 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 Alternatively, you can use the following command in the command line interface:

MSSQLConfigTool --set-repository

f. At the Ba ckup Repository step of the wizard:

i. From the Ba ckup repository drop-down list, select the scale-out repository.

ii. Click Ma p backups to map the imported backups stored in the backup repository.

NOTE

You can map backups only in the graphic user interface.

• For Veeam Plug-in backups and backup copies, the Performance policy of a scale-out repository functions
differently:

a. Veeam Backup & Replication checks if there are extents without warning on fr ee space insufficiency. If
all extents have the warning, Veeam Backup & Replication uses an extent with the largest amount of
free space that has a free task slot.

b. If there are extents without the warning, Veeam Backup & Replication checks if there are incremental
extents with free task slots. If there are no incremental extents with free task slots, Veeam Backup &
Replication uses a full extent with the least amount of used task slots.

c. If there are incremental extents with free task slots, Veeam Back up & Replication sends backup files
to an incremental extent with the least amount of used task slots. If the amount of used tasks is the
same, an extent with the largest amount of free space.

To learn more about file placement policies of scale-out repositories, see Backup File Placement section in
the Veeam Backup & Replication guide.

• If a scale-out repository is configured in the Data locality policy, repository extents will be selected
according to the largest amount of free space for each Microsoft SQL Server connection. If the selected
extent does not have free task slots, Veeam Backup & Replication uses the extent with the next largest
amount of free space. If there are two extents with only one slot on each extent, the backup will be
launched on two streams (one on each extent).

331 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Capacity Tier
You can configure Veeam Backup & Replication to transfer Veeam Plug -in backup files to the capacity tier. Both
policies (Move policy, Copy policy) are supported for Veeam Plug -in backups with the following limitations:

• For Veeam Plug-in backup files, capacity tier does not verify whether data that is being moved is unique
and has not been offloaded earlier. Thus, it is highly recommended to check the pricing plans of your
cloud storage provider to avoid additional costs for offloading and downloading backup data .

• To offload Veeam Plug-in backup files to the capacity tier, Veeam Backup & Replication splits data into 1
MB objects and compresses the resulting objects. The default object size will be a compressed 1 MB block,
resulting in objects of around 512 KB in size.

• [For the Move policy] For Veeam Plug-in for Microsoft SQL Server backups, capacity tier tracks
dependencies of full and differential backup files. Thus, Veeam Backup & Replication tracks inactive
backup chains and moves them to the capacity tier. No limitations apply to the operational restore
window.

• Veeam Backup & Replication offloads Veeam Plug-in for Microsoft SQL Server backup files to the capacity
tier with the Copy and Move policies in different ways. With the Copy policy, Veeam Backup & Replication
checks backup files every 1 hour and runs an offload job only if new backup files exist. With the Move
policy, Veeam Backup & Replication checks backup files every 4 hours and runs an offload job, even if
there are no new files.

IMP ORTANT

With both the Copy and Move policies, Veeam Backup & Replication copies and moves to the
capacity tier only non-active backup files created more than 24 hours ago, which match the capacity
tier configuration parameters. For details, see Backup Chain. To learn more about the capacity tier
configuration, see Add Capacity Tier in the Veeam Backup & Replication User Guide.

• Veeam Plug-in supports encryption of offloaded data to the capacity tier. The E ncrypt data uploaded to
ob ject storage option in the Ca pacity Tier settings of the scale-out backup repository ensures that the
entire collection of blocks along with the metadata will be encrypted while being offloaded. To learn more
about capacity tier encryption, see the Encryption for Capacity Tier section in the Veeam Backup &
Replication User Guide.

• In case a disaster strikes the scale-out repository and you have a Veeam Plug-in backup file on the capacity
tier, you must re-create the scale-out repository before you restore from this backup file. You must
connect the capacity tier with the Veeam Plug-in backup file to another backup server with Veeam Backup
& Replication and a scale-out repository. After that, you can import the backup files to Veeam Backup &
Replication and then perform data recovery operations.

• If you use a capacity tier that has been created in Veeam Backup & Replication version 10, you cannot
transfer Veeam Plug-in backup files to a capacity tier. However, if you want to transfer them manually, do
the following:

a. If the backup files are created by Veeam Plug-in version 10, upgrade the metadata of backup files as
described in the Upgrading Backup Files section.

b. Run the Set-VBRScaleOutBackupRepository cmdlet with the EnablePluginBackupOffload

parameter to offload backup files to the capacity tier.

332 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Hardened Repository
You can configure Veeam Backup & Replication to transfer Veeam Plug-in backup files to a hardened repository.
The hardened repository helps to protect Veeam Plug -in backup files from loss as a result of malware activity or
unplanned actions. Backup files in the hardened repository become immutable for the time period specified in
the backup repository settings. During this period, backup files stored in the repository cannot be modified or
deleted.

For Veeam Plug-in for Microsoft SQL Server backups, immutability works according to the following rules:

• Immutability is applied to backup (.VAB) files and backup metadata (.VASM) files. Backup job metadata
(.VACM) files are not immutable.

• Backup files become immutable for the configured time period (minimum 7 days, maximum 9999 days).

• Backup files become immutable after 24 hours have passed since each file was created. The immutability
service runs in the background at every hour. This service detects and sets immutability flags for any
backup file that can no longer be reused.

TIP

Contact Veeam Customer Support to change the default 24 hour lifespan of a backup file. To do that,
you can submit a support case on the Veeam Customer Support Portal.

• The immutability period is automatically extended for backup files that contain restore points of the active
chain.

Data Restore from Hardened Repository

As a result of malware activity or unplanned actions, backup job metadata (.VACM) files may become
unavailable in the hardened repository. In this case, to restore data from the hardened repository, you must re-
create the .VACM file. To do this, complete the following steps:

1. Run a Veeam Plug-in backup job to create a new Veeam Plug-in backup in a Veeam backup repository. The
backup will consist of the .VAB, .VASM and .VACM files.

2. In the backup repository folder, replace the .VAB and .VASM files created at the step 1 with the .VAB and
.VASM files from the hardened repository.

3. In the Veeam backup console, run the backup repair operation. Veeam Backup & Replication will generate
a new .VACM file using information from the .VASM files. For details, see Repairing Backup.

Once the backup job metadata file is re-created, you can use Veeam Plug-in to restore your data.

333 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Data Restore
With the configured Veeam Plug-in for Microsoft SQL Server, you can restore Microsoft SQL Server databases
from Veeam Plug-in backups that reside on Veeam backup repositories.

Veeam Plug-in supports restore of entire databases to the original Microsoft SQL Server machine or to another
server. You can specify a point in time to which you want to restore the database. This restore operation is based
on backed up transaction logs. If there are no available backed up transaction logs, Veeam Plug-in restores the
database to the time when the restore point was created. For details, see Performing Restore.

You can use the following tools to perform restore operations for Microsoft SQL Server databases:

• Restore with the Restore Database wizard.

Use the Restore Database wizard to restore Microsoft SQL Server databases based on Veeam Plug -in
backups. For details, see Restore with Restore Database Wizard.

• Restore with MSSQLRecoveryManager.exe tool in the command-line interface.

Use the MSSQLRecoveryManager.exe command-line tool to restore Microsoft SQL Server databases
based on Veeam Plug-in backups. For details, see Restore with Command-Line Interface.

334 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Planning and Preparation
Before you start to use Veeam Plug-in for Microsoft SQL Server, read the environment planning
recommendations and make sure that your environment meets system requirements.

335 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

System Requirements
Before you start using Veeam Plug-in for Microsoft SQL Server, make sure the requirements listed in this section
are met.

Sp ecification Requirement

OS 64-bit versions of the following operating systems are supported:

• Microsoft Windows Server 2025

• Microsoft Windows Server 2022
• Microsoft Windows Server 2019
• Microsoft Windows Server 2016
• Microsoft Windows Server 2012 R2

Note:

Server Core installations of Microsoft Windows Server OSes are not supported.

Microsoft SQL The following Microsoft SQL Server versions are supported:
Server Database
• Microsoft SQL Server 2022
• Microsoft SQL Server 2019
• Microsoft SQL Server 2017
• Microsoft SQL Server 2016
• Microsoft SQL Server 2014 SP3

Notes:

• To connect to the Microsoft SQL Server, Veeam Plug-in requires Microsoft ODBC
Driver for SQL Server versions 17 or 18. Other driver versions are not supported
but can be present in the same system.

By default, Veeam Plug-in uses driver version 17. If driver version 17 is

unavailable in the system, Veeam Plug-in automatically uses driver version 18.
Optionally, you can manually set a preferred driver version in the
veeam_config.xml file for cases when the default driver version is not
suitable for your system.

For details, see Specifying the Version of Microsoft ODBC Driver for SQL Server.

• Standard, Enterprise, Web, Developer editions of Microsoft SQL Server are

supported.
• Express edition of Microsoft SQL Server is not supported.
• Windows Server Failover Clusters are supported, both with shared disks a nd
Cluster Shared Volumes (CSV).
• Always On Availability Groups, Always On Clusterless Availability Groups and
Always On Failover Cluster Instances are supported.
• Distributed Availability Groups are not supported.

336 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 Sp ecification Requirement

Microsoft SQL Veeam Plug-in Toolbar requires Microsoft SQL Server Management Studio 20.x.
Server
Ma nagement Note:
Stud io
Remote connections from Microsoft SQL Server Management Studio are not
supported.

Veeam Backup & Veeam Backup & Replication supports two latest versions of Veeam Plug -ins. For
Rep lication example, Veeam Backup & Replication 12.3 supports Veeam Plug -in 12.3 and 12.2.

Keep in mind that if you use an earlier Veeam Plug-in build than the one that is
included in the installation ISO file of your Veeam Backup & Replication version, it may
not have all the features and bug fixes introduced in your Veeam Backup & Replication
version. To learn more about the Veeam Plug-in builds included in Veeam Backup &
Replication installation ISO files, see this Veeam KB article.

Network Veeam Plug-in should be able to establish a direct IP connection to the Veeam Backup
& Replication server. Thus, Veeam Plug-in cannot work with the Veeam Backup &
Replication server that is located behind the NAT gateway.

337 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Permissions
This table contains the list of operations that require specific user account permissions.

Operation Required Roles and Permissions

Installing and The account used for installing and updating Veeam Plug -in must be a member of
updating Veeam Plug- the local Administrators group. Local administrator permissions are required to
in install and manage Veeam Plug-in Toolbar in Microsoft SQL Server Management
Studio.

Performing backup To be able to connect to a Microsoft SQL Server instance, the account used for
and restore operations starting Microsoft SQL Server backup and restore processes must meet the
in Veeam Plug-in following conditions:

• The account must be added to the following roles: public, sysadmin.

• If the account is not a member of the Administrators group, you must enable
the Create Global Objects security policy for the account. For detailed
instructions on how to manage the Create Global Objects security policy, see
this Microsoft article.

Connecting to Veeam The account that is used to authenticate against Veeam Backup & Replication must
Backup & Replication, have access permissions on required Veeam backup repository servers. To learn how
managing backups to configure permissions on repositories, see Access and Encryption Settings on
Backup Repositories.

Veeam Plug-in for Microsoft SQL Server uses Windows authentication methods of
the Veeam Backup & Replication server to establish a connection to this server and
to the backup target. It is recommended to create one user for each standalone
Microsoft SQL Server or failover cluster with Veeam Plug -in.

To work with backups created by Veeam Plug-in, you can use only the same account
that was used for creating the backup. If you want to use another account, assign
the Veeam Backup Administrator role or Veeam Backup Operator and Veeam
Restore Operator roles to the account. To learn how to assign Veeam Backup &
Replication roles, see the Users and Roles section in the Veeam Backup &
Replication User Guide.

338 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Ports
To enable proper operation of Veeam Plug-in for Microsoft SQL Server, make sure that the following ports are
open.

Microsoft SQL Server

The following table describes network ports that must be opened to ensure proper communication of the
Microsoft SQL Server and backup infrastructure components.

From To P rotocol P ort Notes

Default port used for communication with

Veeam the Veeam Backup & Replication server.
Backup & Note that data between Veeam Plug-ins
TCP 10006
Replication and backup repositories is transferred
server directly, bypassing the Veeam Backup &
Replication server.
Microsoft
SQL Server
Backup
where Default range of ports used as data
repository
Veeam 2500 to transmission channels. For every TCP
server or TCP
Plug-in is 3300** connection that a backup process uses,
gateway
installed one port from this range is assigned.
server*

Local connections between Veeam Plug-in

Microsoft SQL 6791+, and source Data Movers.
Server TCP 2500 to
(localhost) 3300** If port 6791 is occupied, the succeeding
port numbers will be used.

* For NFS share, SMB share repositories, and Dell Data Domain, HPE StoreOnce deduplication storage appliances, V eeam
Backup & Replication uses an auxiliary backup infrastructure component — gateway server. For details, see the Gateway
Server section in the Veeam Backup & Replication User Guide.
** This range of ports applies to newly added backup infrastructure components. If you upgrade to Veeam Backup &
Replication 10.0 from earlier versions of the product, the range of ports from 2500 to 5 000 applies to the already added
components.

339 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Backup Repositories and Gateway Servers
Depending on the type of backup repositories that you use for Veeam Plug -in backups, the following ports must
be open to allow communication between backup infrastructure components.

From To P rotocol P ort Notes

Backup
Veeam Default range of ports used as data
repository
Backup & 2500 to transmission channels. For every TCP
server or TCP
Replication 3300** connection that a backup process uses,
gateway
server one port from this range is assigned.
server*

Direct Attached Storage

Linux server
used as a
Port used as a control channel from the
backup
TCP 22 Veeam Plug-in server to the target Linux
repository or
host.
gateway
server
Veeam
Backup &
Replication Microsoft Ports used as a management channel from
TCP 135,
server Windows the Veeam Plug-in server to the
137 to 139,
server used UDP Repository/Gateway server. Also, the ports
445
as a backup are used to deploy Veeam components.
repository or
gateway 6160, Default ports used by the Veeam Installer
server TCP
6162 Service and Veeam Data Mover Service

Network Attached Storage

Gateway Default port used by SMB transport

TCP 445
server protocol.

(specified in
the SMB SMB server SMB/Netbios name resolution for SMB
share TCP 135, protocol (needed in some cases). For
repository UDP 137 to 139 details, see the Used Ports section in the
settings) Veeam Backup & Replication User Guide.

Gateway
server

(specified in TCP Standard NFS ports used as a transmission

111,
the NFS NFS server channel from the gateway server to the
UDP 2049
share target NFS share.
repository
settings)

340 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 From To P rotocol P ort Notes

Dell Data Domain

Port used to assign a random port for the

mountd service used by NFS and
TCP 111
DDBOOST. Mountd service port can be
statically assigned.
Veeam Dell Data
Backup & Domain Main port used by NFS. To change the
Replication port, you can use the nfs set server-
server For more TCP 2049
information, port command. Note that the command
or
see this Dell requires SE mode.
Gateway
server KB article.
Main port used by NFS MOUNTD. To
change the port, you can use the nfs set
TCP 2052
mountd-port command. Note that the
command requires SE mode.

HP E StoreOnce

Veeam Default command port used for

9387
Backup & communication with HPE StoreOnce.
Replication
HPE
server TCP
StoreOnce
or Default data port used for communication
Gateway 9388
with HPE StoreOnce.
server

E x aGrid

Veeam
Backup & Default command port used for
ExaGrid TCP 22
Replication communication with ExaGrid.
server

Qua ntum
DXi

Veeam
Backup & Default command port used for
Quantum DXi TCP 22
Replication communication with Quantum DXi.
server

* For NFS share, SMB share repositories, and Dell Data Domain, HPE StoreOnce deduplication storage appliances, Veeam
Backup & Replication uses an auxiliary backup infrastructure component — gateway server. For details, see the Gateway
Server section in the Veeam Backup & Replication User Guide.

341 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

** This range of ports applies to newly added backup infrastructure components. If you upgrade to Veeam Backup &
Replication 10.0 from earlier versions of the product, the range of ports from 2500 to 5000 applies to the already added
components.

For detailed list of ports used by Veeam Backup & Replication server and backup repositories, se e the Used Ports
section in the Veeam Backup & Replication User Guide.

342 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Licensing
To use the Veeam Plug-in functionality, you must have a valid Veeam Backup & Replication license. Licenses are
installed and managed on the Veeam Backup & Replication server that is connected to the Veeam Plug -in server.
If the license is not valid or out of resources, Veeam Plug -in backup jobs fail.

This guide provides information only on specifics of Veeam licenses for Veeam Plug-ins. For terminology and
general information about Veeam Licensing, see Veeam Licensing Policy.

Licensed Objects
A Microsoft SQL Server machine with Veeam Plug-in is assumed protected if it has been processed by a Veeam
Plug-in backup job in the last 31 days.

If you use any instance-based (Veeam Universal Licensing) license in Veeam Backup & Replication, you do not
need to install any additional licenses. A protected server with Veeam Plug -in consumes one instance unit from
the license. Servers processed by backup copy jobs are not regarded as protected machines, these types of jobs
provide an additional protection level for machines that are already protected with Veeam Plug -in backup jobs.

A machine protected by both Veeam Plug-in and Veeam Backup & Replication will consume a license only once.
For example, you have Microsoft SQL Server that you back up using Veeam Plug-in. You also back up this server
using image-level backup functionality of Veeam Backup & Replication. In this case, only one license will be
consumed.

NOTE

[For Perpetual per-socket licenses] If you are using a legacy perpetual per-socket license, a license is
required for each hypervisor CPU socket occupied by protected servers.

A socket is consumed from the license only if the hypervisor where protected servers reside is added to the
Veeam Backup & Replication infrastructure. If the hypervisor is not added to the Veeam Backup &
Replication infrastructure, an instance unit will be consumed from the license. To learn how to add a
hypervisor to the Veeam Backup & Replication infrastructure, see the Virtualization Servers and Hosts
section in the Veeam Backup & Replication User Guide.

IMP ORTANT

The license is required for all cluster nodes, even if Veeam Plug -in is installed only on one of the nodes.

Supported License Types

You can use Veeam Plug-ins with the following license types and packages. Note that this guide contains
information on specifics of Veeam license packages only for Veeam Plug -ins. For the full list of license packages,
see this Veeam webpage.

• For Veeam Universal license:

You can use Veeam Plug-ins with all license packages ( Veeam Backup Essentials, Veeam Backup &
Replication, Veeam Availability Suite).
Note that if you use the Rental license type, functionality of Veeam Plug-ins is supported only for the
Enterprise Plus edition of Veeam Backup & Replication.

343 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 • For Socket license:

Functionality of Veeam Plug-ins is supported only for the Enterprise Plus edition of Veeam Backup &
Replication.

Obtaining and Managing Licenses

To learn how to install a license and monitor licensed objects, see the Licensing section in the Veeam Backup &
Replication User Guide.

344 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Veeam Environment Planning
Before you deploy Veeam Plug-in, keep in mind the following requirements and limitations.

Hosting Environments and Backup Job Names

By default, Veeam Plug-in generates names for backup jobs and backup folders according to the hosting
environment where the backup job is created:

• For the standalone server, Veeam Plug-in generates names based on the server hostname.

• For the Microsoft SQL Server failover cluster, Veeam Plug -in generates names based on the Microsoft SQL
server network name.

• For the Always On availability group, Veeam Plug-in generates names based on the group hostname.

You can set Veeam Plug-in to use a custom name instead of the default name. This may be helpful, for example,
if you have servers with the same hostname in multiple environments.

To assign a custom name, update the Veeam configuration XML file as follows:

1. On the machine with Veeam Plug-in, open the

%PROGRAMFILES%\Veeam\VeeamPluginforMSSQL\veeam_config.xml file.

2. Add the customServerName parameter entry in the Veeam configuration XML file: to the
<PluginParameters /> line in the Veeam configuration XML file:

<PluginParameters customServerName="hostname.domain.tld" />

where <hostname.domain.tld> is a custom name of the server.

After adding this parameter, Veeam Plug-in will use the specified custom name of the server to name the
backup job and backup folder.

For example:

<PluginParameters customServerName="srv01.tech.local" />

Alternatively, you can use the useFQDNInServerName parameter:

<PluginParameters useFQDNInServerName="true" />

After adding this parameter, Veeam Plug-in will use the fully qualified domain name (FQDN) of the server to
name the backup job and backup folder.

Keep in mind that you must add the parameters to the existing line in the veeam_config.xml file. If you
create a new line with the same name as the existing line, Veeam Plug -in will consider parameters only in the
first detected line. Other parameters will be ignored.

IMP ORTANT

For security reasons, it is recommended to use separate repositories for different customers and limit the
Veeam Repository Authentication to the specific customer.

345 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Network Traffic Encryption
Veeam Plug-in supports network traffic encryption rules set on the Veeam Backup & Replication side. By
default, Veeam Plug-in automatically applies the traffic encryption rules. To decrease the processing load on
the database server, you can disable network traffic encryption by ignoring the rules set on the Veeam Backup &
Replication side.

To ignore network traffic encryption rules, do the following:

1. Locate the Veeam configuration XML file in the following location:

%PROGRAMFILES%\Veeam\VeeamPluginforMSSQL\veeam_config.xml

2. Add the following parameter to the Veeam configuration XML file:

<IgnoreVBRNetworkRules=true />

To learn more about traffic encryption, see the Enabling Traffic Encryption section in the Veeam Backup &
Replication User Guide.

Data Streams and Resource Consumption

Veeam Plug-in for Microsoft SQL Server transfers backup data from the machine with protected Microsoft SQL
Server to Veeam backup repository using data streams. By default, Veeam Plug-in uses one data stream per
backup operation. You can configure Veeam Plug-in to use additional data streams that will process backup data
in parallel. This may be helpful if you want to reduce time spent on your ba ckup operations.

If you want to use additional data streams, configure the Concurrent backup streams setting at the Ba ckup
Op tions step of the Ba ck Up Database wizard. The Concurrent backup streams setting defines the maximum
allowed number of data streams being used for each database. For details, see Specify Backup Options.

Hardware Resource Recommendations

Additional data streams increase load on the hardware of your infrastructure components. We recommend to
carefully plan hardware resources, so that Microsoft SQL Server can work with multiple streams in parallel. The
following hardware resources are recommended based on tests on Skylake processors:

• Microsoft SQL Server:

o 1 CPU core per 2 parallel backup streams.

o 1 GB of RAM per 5 parallel backup streams.

Besides resource recommendations, Veeam Plug-in may limit the number of data streams assigned to a
certain database. For details, see Data Stream Distribution on Microsoft SQL Server.

• Ba ckup repository server. 1 CPU core and 1 GB of RAM per 5 parallel backup streams.

These resources are recommended only if you use a dedicated backup repository for Veeam Plug -in
backups. If you use the same backup repository for Veeam Plug -in backups and VM backups created by
Veeam Backup & Replication or Veeam Agents, consider adding the mentioned above hardware resources
based on usual load on your backup repository. For details on hardware requirements for a backup
repository, see the System Requirements section of the Veeam Backup & Replication User Guide.

346 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 We recommend to contact your Veeam system engineer to optimize the backup stream setting s and
resource allocation. Also, note that it is recommended to use a separate backup repository for Veeam
Plug-in backups.

• Veeam Backup & Replication server: during manual metadata operations such as import of backup files,
the Veeam Backup & Replication server needs additional 15 GB of RAM per 1 million files located in the
same backup job folder.

Data Stream Distribution on Microsoft SQL Server

Veeam Plug-in for Microsoft SQL Server distributes data streams between databas es that you want to back up in
accordance to the resources available on Microsoft SQL Server and backup repository server. As a result,
available data streams are distributed considering the following:

• Number of CPU cores on Microsoft SQL Server: Veeam Plug-in can assign no more than 2 data streams per
1 CPU core.

• Amount of RAM on Microsoft SQL Server: Veeam Plug-in can assign no more than 5 data streams per 1 GB
RAM.

• Number of available task slots in the backup repository: each parallel data stream uses 1 task slot of the
backup repository. To learn how to edit the number of concurrent tasks allowed for the backup repository,
see the Limitation of Concurrent Tasks section in Veeam Backup & Replication User Guide.

Example:

You want to back up 2 databases. Using the Concurrent backup streams setting, you set a maximum allowed
number of data streams for each database as 5. Thus, you need 10 data streams to back up 2 databases with
parallel data streams.

Your Microsoft SQL Server has 4 CPU cores and 4 GB RAM. Your backup repository has 10 available task slots. In
this example, the number of data streams is limited by the CPU of your Microsoft SQL Server: 8 data streams in
total.

As a result, Veeam Plug-in will split there data streams between 2 databases and process these databases in
parallel: Veeam Plug-in will process the first database using 5 parallel streams and the second database using 3
parallel streams. Keep in mind, if number of available data streams is enough for 1 database only, Veeam Plug -in
will process databases one by one.

347 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Getting Started
To protect Microsoft SQL Server databases with Veeam Plug -in, perform the following operations:

1. Deploy Veeam Plug-in on the machine that runs Microsoft SQL Server. For more information, see Installing
Veeam Plug-in for Microsoft SQL Server.

2. Configure connection between Veeam Plug-in and the backup repository managed by the Veeam Backup &
Replication server. For more information, see Configuring Veeam Plug-in for Microsoft SQL Server.

3. Define what data you want to back up and configure backup settings. For more information, see
Performing Backup.

4. In case of a disaster, you can restore data from a backup. For more information, see Performing Restore.

348 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Deployment and Configuration
Veeam Plug-in for Microsoft SQL Server is a feature of Veeam Backup & Replication. This guide gives
instructions on how to deploy Veeam Plug-in assuming that you already have deployed Veeam Backup &
Replication and configured a backup repository. To learn how to deploy Veeam Backup & Replication, see the
Veeam Backup & Replication User Guide for your platform.

To be able to use Veeam Plug-in for Microsoft SQL Server, you must complete the following steps:

1. Install the plug-in on the Microsoft SQL Server machine.

2. Set the access and encryption settings on backup repositories.

3. Configure the plug-in settings.

349 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Installing Veeam Plug-in for Microsoft SQL
Server
You can install Veeam Plug-in for Microsoft SQL Server using the installation wizard or in an unattended mode
using the command-line interface.

NOTE

When you launch Veeam Plug-in installation, the installation wizard also installs Microsoft .NET Framework
4.5.2 if it does not detect this component on the machine. In some cases, installation of .NET Framework
requires a reboot of the machine. This can happen, for example, if you have an earlier version of .NET
Framework installed on the machine, and during the installation process it is used by third -party software.

Installing Veeam Plug-in

Veeam Plug-in for Microsoft SQL Server is an additional component of Veeam Backup & Replication, and the
installation package of the plug-in is included in the Veeam Backup & Replication installation ISO file.

To install Veeam Plug-in for Microsoft SQL Server, do the following:

1. Mount the Veeam Backup & Replication installation disk

(VeeamBackup&Replication_12.3.0.310_20241201.iso).

If you deploy Veeam backup infrastructure for the first time, you can download the Veeam Backup &
Replication installation disk image at the Download Veeam Products page.

2. In the installation disk folder, navigate to the Plugins\Microsoft SQL\x64\ folder.

3. To launch the installation wizard, run the VeeamPluginforMSSQL.exe file.

350 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 4. At the welcome screen of the installation wizard, click Nex t.

5. At the License Agreement step of the wizard, follow the links to view license agreements and click I
Accept.

351 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 6. At the Da ta Location step of the wizard, specify the installation path for Veeam Plug -in and click Install.

By default, the installation wizard installs the product to the

%PROGRAMFILES%\Veeam\Plugins\Microsoft SQL\ folder.

7. Wait for the installation process to complete and click Finish to exit the wizard.

352 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Installing Veeam Plug-in in Unattended Mode
You can install Veeam Plug-in for Microsoft SQL Server in the unattended mode using the command line
interface. To do this, go to the folder where the VeeamPluginforMSSQL.exe file resides and run the
following command:

<path_to_exe>\VeeamPluginforMSSQL.exe /silent /accepteula /acceptthirdpartylice

nses /acceptlicensingpolicy /acceptrequiredsoftware

where <path_to_exe> is a path to the Veeam Plug-in for Microsoft SQL Server installation file.

P a rameter Description

/silent Enables the silent mode.

/accepteula Accepts EULA terms.

/acceptthirdpartylicenses Accepts terms of third-party licenses.

Enables installation of the required software (Microsoft .NET Framework

/acceptrequiredsoftware
4.5.2) and accepts terms of its license.

/acceptlicensingpolicy Accepts terms of the Veeam licensing policy.

Veeam Plug-in for Microsoft SQL Server uses the following codes to report about the installation results:

• 1000 — Veeam Plug-in for Microsoft SQL Server has been successfully installed.

• 1001 — prerequisite components required for Veeam Plug-in for Microsoft SQL Server have been installed
on the machine. Veeam Plug-in for Microsoft SQL Server has not been installed. The machine needs to be
rebooted.

• 1002 — Veeam Plug-in for Microsoft SQL Server installation has failed.

• 1101 — Veeam Plug-in for Microsoft SQL Server has been installed. The machine needs to be rebooted.

353 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Access and Encryption Settings on Backup
Repositories
When you configure Veeam Plug-in, you specify an account that must be used to connect to the Veeam Backup
& Replication server.

Before granting access permissions, consider the following:

• Consider supported types of backup repositories and limitations for Veeam Plug -in for Microsoft SQL
Server backups in Veeam Backup Repositories.

• To store backups in a backup repository, the specified account must have access permissions on the target
backup repository.

To grant access permissions, do the following:

1. In Veeam Backup & Replication, open the Ba ckup Infrastructure view.

2. In the inventory pane, click the Ba ckup Repositories node or the Sca le-out Repositories node.

3. In the working area, select the necessary backup repository and click Set Access Permissions on the ribbon
or right-click the backup repository and select Access permissions.

4. In the Access Permissions window, on the Sta ndalone applications tab specify to whom you want to grant
access permissions on this backup repository:

o Allow to everyone — select this option if you want to grant repository access to any user. This option
is equal to granting access rights to the Everyone group in Microsoft Windows (anonymous users are
excluded). For security reasons, the option is not recommended for production environments.

o Allow to the following accounts or groups only — select this option if you want only specific users to
be able to store backups in this repository. Click Ad d to add the necessary users and groups to the list.

354 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 5. Veeam Plug-ins cannot send backups or backup copies to a backup repository where encryption is
enabled. Thus, make sure that the E ncrypt standalone application backups stored in this repository check
box is not selected.

6. Click OK.

355 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Granting Permissions to Users
When you install Veeam Plug-in for Microsoft SQL Server, full access rights to the plug -in configuration file are
automatically granted to all users. To protect sensitive information that is stored in the configuration file from
unwanted access, we recommend limiting access to the configuration file to a dedicated group of users.

By default, theVeeam Plug-in configuration file (veeam_config.xml) is located in the

%PROGRAMFILES%\Veeam\Plugins\Microsoft SQL folder on the machine where Veeam Plug-in is
installed.

Before You Begin

Before you create a user group that will have access to the plug -in configuration file, consider the following:

• To perform this procedure, the OS user account must have local administrator privileges.

• Add only trusted users to the group.

• After a user is added to the group, they must log out, then log in to the system again to activate the group
permissions.

Granting Permissions to the Plug-In Configuration File

1. Create a new user group by running the following command:

net localgroup "<groupName>" /comment:"<description>" /add

where:

o <groupName> — the name of the created group.

o <description> — the description of the group.

2. Add a user to the group with the following command:

net localgroup "<groupName>" "<userName>" /add

where:

o <groupName> — the name of the created group.

o <userName> — the name of the account that will be granted access to the configuration file.

356 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 3. Create a new access control list (ACL) with Read and Write permissions using this set of commands:

$newACL = New-Object System.Security.AccessControl.FileSecurity #creates a

dedicated ACL
$newACL.SetAccessRuleProtection($true,$false) #disables inheritance and de
letes all inherited permissions
$newACL.AddAccessRule( (New-Object System.Security.AccessControl.FileSyste
mAccessRule("groupName","Read","Allow"))) # allows read
$newACL.AddAccessRule( (New-Object System.Security.AccessControl.FileSyste
mAccessRule("groupName","Write","Allow")))# allows write

where:

o newACL — the name of the new access control list. You can give any name to this temporary variable.

o <groupName> — the name of the created group.

4. Assign ownership of the new ACL to the previously created user group by running the following command:

$newACL.SetOwner([System.Security.Principal.NTAccount]"groupName") #sets o
wner for the ACL

where:

o newACL — the name of the new access control list.

o <groupName> — the name of the created group.

5. Apply the ACL to the plug-in configuration file using this command:

set-acl -Path:<configFilePath> -AclObject:$newACL #apply ACL to the plug-i

n configuration file

where:

o <configFilePAth> — the path to the plug-in configuration file. The default path is
%PROGRAMFILES%\Veeam\Plugins\Microsoft SQL\veeam_config.xml.

o newACL — the name of the new access control list.

357 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Configuring Veeam Plug-in for Microsoft SQL
Server
To use Veeam Plug-in, you must configure connection between the Microsoft SQL Server machine, Veeam
Backup & Replication server and backup repository where backup files will be stored.

IMP ORTANT

Before you configure Veeam Plug-in, you must allow access to Veeam backup repositories that you plan to
use. Also, the encryption on the backup repository must be disabled. To learn how to configure access and
encryption on backup repositories, see Access and Encryption Settings on Backup Repositories.

To configure connection settings, use the Configure P lug-in wizard. The wizard configuresVeeam Plug-in
settings and saves the settings to the Veeam Plug-in configuration file (veeam_config.xml). The file is
located in the %PROGRAMFILES%\Veeam\Plugins\Microsoft SQL folder on the machine where Veeam
Plug-in is installed.

TIP

You can also configure Veeam Plug-in for Microsoft SQL Server using the MSSQLConfigTool.exe tool. To
learn more, see Configuring Veeam Plug-in with Command-Line Interface.

To configure Veeam Plug-in, do the following:

1. On the Microsoft SQL Server machine, launch the Configure Plug-in wizard. To do this, do either of the
following:

o Click the Configure P lug-in icon on the desktop.

o From the Microsoft Windows Sta rt menu, select All P rograms > Veeam > Configure P lug-in or use the
Microsoft Windows search to find the Configure Plug-in option on your machine.

o In Microsoft SQL Server Management Studio, click the Configure Plug-in button on the toolbar.

o Launch the %PROGRAMFILES%\Veeam\Plugins\Microsoft

SQL\Veeam.Backup.MSSQLPlugin.UI.Configuration.exe file.

IMP ORTANT

You must run the Configure Plug-in wizard with elevated privileges (run as Administrator).

2. At the Ba ckup Server step of the wizard, specify settings to connect to the Veeam Backup & Replication
server:

a. In the Veeam backup server field, specify a DNS name of the Veeam Backup & Replication server.

b. In the P ort field, specify the port number over which Veeam Plug-in for Microsoft SQL Server will
communicate with Veeam Backup & Replication. By default, Veeam Plug -in for Microsoft SQL Server
uses port 10006.

358 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 c. In the Username and P a ssword fields, specify credentials that will be used to connect to the Veeam
Backup & Replication server.

3. At the Ba ckup Repository step of the wizard, do the following:

a. From the Ba ckup repository drop-down list, select the required repository.
You can click Refresh to update the list of backup repositories. This may be helpful, for example, after
you configure access to a backup repository and want to select this repository without the need to re -
run the Configure Plug-in wizard.

b. You can map Veeam Plug-in for Microsoft SQL Server backup jobs to backups stored in the backup
repository. Backup job mapping can be helpful if you moved backup files to a new backup repository
and want to point backup jobs to existing backups in this new backup repository. You can also use
backup job mapping if the configuration database got corrupted and you need to reconfigure backup
jobs.

To map Veeam Plug-in for Microsoft SQL Server backup jobs to backups in the backup repository, click
the Ma p backups link and select one or more backups in the Select Backups window.

You can map Veeam Plug-in for Microsoft SQL Server backup jobs to multiple backups in the backup
repository. This may be helpful, for example, if you want to continue a backup chain for databases
that operate as part of a failover cluster or availability group.

359 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 4. Click Finish to exit the wizard.

IMP ORTANT

You can work with backups created by Veeam Plug-in only under the account that was used for
creating these backups. If you want to use another account, assign the Veeam Backup Administrator
role or Veeam Backup Operator and Veeam Restore Operator roles to the account.

To learn how to assign Veeam Backup & Replication roles, see the Users and Roles section in the
Veeam Backup & Replication User Guide.

Configuring Veeam Plug-in with Command-Line Interface

To specify Veeam Plug-in for Microsoft SQL Server settings, you can use the MSSQLConfigTool.exe
command-line tool. You can use commands to change a specific parameter in the veeam_config.xml file or to
enable or disable Veeam Plug-in features.

To specify Veeam Plug-in settings, do the following:

1. On the Microsoft SQL Server machine, navigate to the %PROGRAMFILES%\Veeam\Plugins\Microsoft

SQL\ folder.

2. Run the MSSQLConfigTool.exe command with the required parameters. For more information, see
Configuration Parameters.

For example, to specify credentials that will be used to connect to the Veeam Backup & Replication server,
use the following command:

MSSQLConfigTool.exe --set-credentials "administrator@srv16" "password"

IMP ORTANT

When you work with the command-line tool, use one configuration parameter per command. The
tool does not support commands with multiple parameters.

360 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Configuration Parameters
You can specify the following parameters for the MSSQLConfigTool.exe command:

P a rameter Description

--help Shows the list of parameters for the plug-in configuration tool.

Shows the current Veeam Plug-in for Microsoft SQL Server

--show-config
configuration.

Specifies credentials to connect to the Veeam Backup &

Replication server. Provide a user name in the
username@domain format and a password in the password
--set-credentials
format. If you do not provide a password as a value for this
parameter, Veeam Plug-in will prompt you to specify a
password.

Specifies the domain name or IP address of the Veeam Backup &

--set-host
Replication server.

Specifies the port over which to connect to the Veeam Backup &
--set-port
Replication server.

Specifies the name of the backup repository. If you do not

provide the name of the backup repository as a value for this
--set-repository parameter, Veeam Plug-in will prompt you to select a backup
repository from the list of repositories managed by the backup
server.

Maps the imported backup copy to a regular Veeam Plug -in

--p romote-backup-copy-to-primary
backup chain.

Limits bandwidth consumption for Veeam Plug-in backup jobs.

--set-throttling
For details, see Configuring Performance Throttling.

Shows the list of preferred networks set for Veeam Plug -in data
traffic to the remote backup repository.

The list shows set preferred networks in descending order of

--show-preferred-networks priority. If the list is empty, no networks are set as preferred and
Veeam Plug-in routes data traffic to the preferred networks set
in Veeam Backup & Replication. For more information, see
Specifying Preferred Networks for Veeam Plug-ins.

361 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 P a rameter Description

Adds a network to the list of preferred networks for Veeam

Plug-in data traffic to the remote backup repository.
--a dd-preferred-network To select to which network Veeam Plug-in connects first, you
< network_IP_address> <position_in_list> can set the order number of the network in the list. For more
information, see Specifying Preferred Networks for Veeam Plug-
ins.

--remove-preferred-network Removes a specified network from the list of preferred networks

< network_IP_address> for Veeam Plug-in data traffic to the remote backup repository.

362 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Specifying Preferred Networks for Veeam Plug-
ins
You can specify networks over which Veeam Plug-in must transport data when you perform data protection and
disaster recovery tasks on remote backup repositories. This setting applies only to Veeam Plug -in network
traffic, without affecting the data traffic of other Veeam Backup & Replication components. Setting a dedicated
network for Veeam Plug-in backup and replication operations can help to reduce heavy network loads.

NOTE

Consider the following:

• By default, if there are no specified preferred networks for Veeam Plug -in data traffic, Veeam Plug-
in will connect to preferred networks specified in Veeam Backup & Replication. To learn more about
setting preferred networks in Veeam Backup & Replication, see the Specifying Preferred Networks
section in the Veeam Backup & Replication User Guide.
• Veeam Plug-in does not save information about failed network connections. If backup or restore
operations fail, Veeam Plug-in tries to connect to the following network from the preferred
networks list to finish the started operations. Regardless of the first unsuccessful connection,
Veeam Plug-in will try to perform the next backup operations first on the failed network.
• Veeam Plug-in network preferences take priority over Veeam Backup & Replication network
preferences. Only if the preferred networks for Veeam Plug -in data traffic are not available for any
reason, Veeam Plug-in will try to connect to the Veeam Backup & Replication preferred networks.

To specify networks for data transfer, you must create a list of preferred networks. When Veeam Plug -in needs
to transfer data, it uses networks from this list. If a connection over any of the preferred networks cannot be
established for any reason, Veeam Plug-in will automatically fail over to the following network from the
preferred networks list.

To create and manage the list of preferred networks that Veeam Plug -in will use, you can perform the following
operations:

• Adding Preferred Networks

• Accessing Preferred Networks

• Removing Preferred Networks

Adding Preferred Networks

1. On the Microsoft SQL Server machine, navigate to the %PROGRAMFILES%\Veeam\Plugins\Microsoft
SQL\ folder.

2. Run the MSSQLConfigTool command with the following parameter:

MSSQLConfigTool.exe --add-preferred-network <network_IP_address> <position

_in_list>

where:

o <network_IP_address> can be either the IP address of a single network or a network mask that
contains a range of network IP addresses. Specify one of the available options to add as preferred
networks for Veeam Plug-in data traffic.

363 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 o <position_in_list> is the position number of the network in the preferred networks list. The
position in the list determines in what order Veeam Plug -in will connect to the specified network. If
you do not chose a specific position in the list, newly added networks take the last place in the list
automatically.

For example:

MSSQLConfigTool.exe --add-preferred-network 172.24.29.189 2

Accessing Preferred Networks

1. On the Microsoft SQL Server machine, navigate to the %PROGRAMFILES%\Veeam\Plugins\Microsoft
SQL\ folder.

2. Run the MSSQLConfigTool command with the following parameter:

MSSQLConfigTool.exe --show-preferred-networks

The following example shows what the output of the MSSQLConfigTool command with the --show-
preferred-networks parameter can look like:

MSSQLConfigTool.exe --show-preferred-networks
Preferred networks:
1. 172.24.29.156
2. 172.24.26.189

Removing Preferred Networks

1. On the Microsoft SQL Server machine, navigate to the %PROGRAMFILES%\Veeam\Plugins\Microsoft
SQL\ folder.

2. Run the MSSQLConfigTool command with the following parameter:

MSSQLConfigTool.exe --remove-preferred-network <network_IP_address>

where <network_IP_address> can be either the IP address of a single network or a network mask that
contains a range of network IP addresses. Specify one of the available options to remove from the
preferred networks list.

For example:

MSSQLConfigTool.exe --remove-preferred-network 172.24.29.189

364 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Configuring Performance Throttling
You can limit computer processing (CPU) resources assigned for Veeam Plug -in backup jobs. This setting allows
you to reduce the impact of backup operations on the target computer performance. Performance throttling
prevents Veeam Plug-ins from utilizing all computer resources to ensure that enough resources are provided for
other operations. This maybe useful in case you detected that your source database responses are slower during
backup operations.

If you throttle performance, Veeam Plug-in uses the OS process priority system in the background to lower the
priority of backup operation processes. Keep in mind that Veeam Plug -ins manage the priority of backup
operation processes only if the system running on the target computer is busy with other tasks. To learn more
about the process priority setting, see this Microsoft article.

NOTE
• By default, Veeam Plug-in does not throttle performance.
• Performance throttling does not apply to restore operations.

To throttle Veeam Plug-in performance, do the following:

1. Log into the machine with a user with root or instance owner privileges.

2. Start the Veeam Plug-in configuration wizard with the following parameter:

MSSQLConfigTool.exe --set-throttling

3. To confirm that you want Veeam Plug-in throttle performance, type y .

All backup activities will be throttled if the system is busy. Backup perf
ormance may be affected. Proceed? (y/N): y

365 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Upgrading Veeam Plug-in for Microsoft SQL
Server
Periodically, Veeam releases a new version of Veeam Backup & Replication that contains new features and bug
fixes. The release package also contains a new version of Veeam Plug-ins.

If you want to upgrade Veeam Plug-in, note that Veeam Backup & Replication must be the same or later than
the version of Veeam Plug-in. If you want to use the latest functionality, you must upgrade both Veeam Backup
& Replication and Veeam Plug-in to the latest version. After the upgrade, you don't need to re-run the Veeam
Plug-in configuration wizard, the plug-in configuration files will be preserved.

Before you upgrade Veeam Plug-in, check System Requirements. Make sure Microsoft SQL Server Management
Studio requirements are met.

For instructions on how to upgrade Veeam Plug-in for Microsoft SQL Server, see:

• Upgrading Veeam Plug-in

• Upgrading Veeam Plug-in in Unattended Mode

Upgrading Veeam Plug-in

To upgrade Veeam Plug-in for Microsoft SQL Server, do the following:

1. Mount the Veeam Backup & Replication installation disk

(VeeamBackup&Replication_12.3.0.310_20241201.iso).

2. In the installation disk folder, navigate to the Plugins\Microsoft SQL\x64\ folder.

3. To launch the installation wizard, run the VeeamPluginforMSSQL.exe file.

366 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 4. At the welcome screen of the installation wizard, click Nex t.

5. At the License Agreement step of the wizard, follow the links to view license agreements and click I
Accept.

367 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 6. At the Up g rade step of the wizard, review Veeam Plug-in for Microsoft SQL Server components to be
upgraded and click Nex t.

7. Wait for the upgrade process to complete and click Finish to exit the wizard.

368 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Upgrading Veeam Plug-in in Unattended Mode
You can upgrade Veeam Plug-in for Microsoft SQL Server to a later version in the unattended mode using the
same command that is used for unattended installation. For details, see Installing Veeam Plug-in in Unattended
Mode.

369 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Exporting and Importing Plug-in Settings
You can export a Veeam Plug-in configuration file and apply the plug-in settings to other servers.

IMP ORTANT

The password included in the configuration file is encrypted. Thus, after you import the configuration file,
you must set the credentials manually in the Veeam Plug -in configuration wizard or using the
MSSQLConfigTool.exe command-line tool.

To export the configuration file to another server, do the following:

1. On the server where Veeam Plug-in is installed, navigate to the

%PROGRAMFILES%\Veeam\Plugins\Microsoft SQL\ folder.

2. Copy the veeam_config.xml file to the server where you want to configure the plug-in.

3. Install Veeam Plug-in on the new server and place the copied XML file in the
%PROGRAMFILES%\Veeam\Plugins\Microsoft SQL\ folder.

4. Set new credentials to connect to the Veeam Backup & Replication server using the following command:

%PROGRAMFILES%\Veeam\Plugins\Microsoft SQL\MSSQLConfigTool.exe --set-crede

ntials "serv\username" "password"

370 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Importing Backup Files
If the Veeam Backup & Replication server has failed and you have restored it in a new location, you can copy the
backup files to a new repository and re-map the Veeam Plug-in backup files.

Limitations and Prerequisites

Consider the following limitations:

• If backup files are not imported according to instructions given in this section, Veeam Plug -in backup and
restore operations may fail.

• The repository from which you plan to import backups must be added to the Veeam Backup & Replication
infrastructure. Otherwise you will not be able to access backup files.

• [For imports to the scale-out backup repository] Before importing your backup, consider that the names
of all backup files (.VAB, .VASM, .VACM) and paths to these files contain only the following allowed
characters:

o a-zA-Z0-9

o _-.+=@^

If your backup was initially created on a standalone backup server, the default name of the backup
metadata file (.VACM) contains forbidden characters. Before importing, you must delete forbidden
characters from the file name or replace them with the allowed characters.

How to Import Veeam Plug-in Backup Files

To import Veeam Plug-in backup files, do the following:

1. Move the folder with the backup file to the required backup repository or create a new backup repository
with this folder as a subfolder.

TIP

Each Veeam Plug-in backup file (.VAB) has its own metadata file (.VASM). Make sure you import
backup files and all related metadata files. You must also import the backup job metadata file
(.VACM) which is stored in the same folder.

2. In the Veeam Backup & Replication console, open the Ba ckup Infrastructure view.

3. In the inventory pane of the Ba ckup Infrastructure view, select the Ba ckup Repositories node.

371 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 4. In the working area, select the required backup repository and click Rescan on the ribbon. Alternatively,
you can right-click the backup repository and select Rescan.

During the rescan operation, Veeam Backup & Replication gathers information about backups that are
currently available in the backup repository and updates the list of backups in the configuration database.
After the rescan operation, backups that were not in this configuration database will be shown on the
Home view in the Ba ckups > Disk (Imported) node.

5. On the Microsoft SQL Server machine, set the new backup repository as a target in the Veeam Plug -in
settings and map Veeam Plug-in to backups in the repository. For more information, see Configuring
Veeam Plug-in for Microsoft SQL Server.

NOTE

Before you re-map your backup to the repository, make sure that there is not an existing backup job
on your machine with Veeam Plug-in that is targeted at the same repository. If there is such a job,
delete this job from the Veeam Backup & Replication console.

372 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Specifying the Version of Microsoft ODBC Driver
for SQL Server
Veeam Plug-in requires Microsoft ODBC Driver for SQL Server version 17 or 18. By default, Veeam Plug -in uses
driver version 17. In some cases, the default driver version may not be available or may fail to work correctly.
You can use the ODBCversion parameter in the Veeam Plug-in configuration file (veeam_config.xml) to set
a driver version more suitable for your environment.

To learn more about the driver, see this Microsoft article.

To set a specific driver version, update the Veeam configuration XML file as follows:

1. On the Microsoft SQL Server machine, open the Veeam Plug -in configuration file (veeam_config.xml) in
the %PROGRAMFILES%\Veeam\Plugins\Microsoft SQL folder.

2. Add the following parameter to the <PluginParameters /> line in the Veeam configuration XML file:

<PluginParameters ODBCversion="<version_number>" />

For example:

<PluginParameters ODBCversion="18" />

The following example shows the use of several parameters in a single <PluginParameters /> line.

<PluginParameters ODBCversion="18" customServerName="srv01.tech.local" use

FQDNInServerName="true" />

Keep in mind that you must add all plug-in parameters to the existing line in the veeam_config.xml
file. If you create a new line with the same name as the existing line, Veeam Plug -in will consider
parameters only in the first detected line. Other parameters will be ignored.

373 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Uninstalling Veeam Plug-in for Microsoft SQL
Server
To uninstall Veeam Plug-in for Microsoft SQL Server, do the following:

1. On the Microsoft SQL Server machine with Veeam Plug-in, open the Control Panel and click P rograms and
Fea tures.

2. In the list of programs, select Veea m Plug-in for Microsoft SQL and click Uninstall.

374 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Performing Backup
After you configure Veeam Plug-in settings, you can use Veeam Plug-in to back up Microsoft SQL Server
databases. Veeam Plug-in uses native Microsoft SQL Server mechanisms to create application-level backups of
Microsoft SQL Server data.

Veeam Plug-in backs up Microsoft SQL Server databases according to backup settings that you specify. You can
specify what databases to back up, the type of database backups you want to create, retention policy for
database backups and processing settings for backed -up data. In addition, you can use Microsoft SQL Server
Management Studio or a third-party scheduling tool to define schedule for database backup.

NOTE

Backups created by Veeam Plug-ins cannot be used as a source for file to tape or backup to tape jobs.

375 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

About Microsoft SQL Server Backup
Veeam Plug-in uses native Microsoft SQL Server mechanisms to create application-level backups of Microsoft
SQL Server data. You can use Veeam Plug-in to create backups of the following types.

• Full backup

• Differential backup

• Log backup

• Copy-only full backup

• Copy-only log backup

For more information about Microsoft SQL Server backup types, see Microsoft Documentation.

To create backups of a specific type, you must configure backup settings for Veeam Plug -in and run the backup
process. You can run the backup process manually, immediately after you configure backup settings, or you can
define schedule according to which Veeam Plug-in will back up Microsoft SQL Server data automatically. For
more information, see Backup Settings and Backup Schedule.

Backup Settings
Veeam Plug-in backs up Microsoft SQL Server databases according to backup settings that you specify. You can
specify what databases to back up, what type of backups you want to create, retention policy for database
backups and processing settings for backed-up data.

To specify backup settings, Veeam Plug-in offers the Ba ck Up Database wizard. Alternatively, you can use the
MSSQLRecoveryManager.exe command-line tool to specify backup settings and start the backup process. For
more information, see Configuring Backup Settings and Performing Backup with Command-Line Interface.

In addition, you can use Microsoft SQL Server Management Studio or a third -party scheduling tool to define
schedule for database backup.

If you want to perform backups of different types periodically, you must configure backup settings and specify
schedule for each backup type. For example, you can specify settings for full backup, settings for differential
backup and settings for log backup, save each of these settings as a separate SQL Agent job, and create
schedule for these SQL Agent jobs in Microsoft SQL Server Management Studio.

Backup Schedule
Veeam Plug-in for Microsoft SQL Server does not offer its own backup schedule mechanisms. Instead, Veeam
Plug-in allows database administrators to use tools of their choice to configure flexible schedule for database
backup. For example, you can use native Microsoft SQL Server schedule settings to configure flexible schedule
for full, differential or log backups, or use an external scheduling tool.

Veeam Plug-in for Microsoft SQL Server offers two scenarios for backup scheduling:

• Scenario 1. You can configure backup schedule in Microsoft SQL Server. To do this, you must save Veeam
Plug-in backup settings as an SQL Agent job. For more information, see Saving Backup Settings as SQL
Agent Job.

After that, you will be able to configure job schedule in the properties of the SQL Agent job in Microsoft
SQL Server Management Studio.

376 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 • Scenario 2. You can use a third-party scheduling tool to create periodic backups of Microsoft SQL Server
data with Veeam Plug-in. To do this, you must configure Veeam Plug-in backup settings and obtain a
command that will be used to start the backup process. For more information, see Exporting Backup
Settings to Custom Script.

After that, you will be able to use the resulting command in a custom backup script or with a scheduling
tool of your choice.

Backup Chain
A sequence of backups created with Veeam Plug-in for a Microsoft SQL Server database makes up a backup
chain. The backup chain can be described at two levels: physical level and logical level.

• At the physical level, the backup chain is a sequence of backup files created by Veeam Plug -in in the
backup repository. In contrast to image-level backups created with Veeam Backup & Replication for which
a separate backup file is created during each backup session, backup files created with Veeam Plug -in
contain data backed up within multiple backup sessions. Thus, instead of a chain of full and incremental
backup files, Veeam Plug-in creates its own set of backup files in the backup repository.

• At the logical level, the backup chain consists of a full backup of a Microsoft SQL Server database and its
dependent differential backups and log backups. Backups in the backup chain form a set of restore points.
Restore points correspond to the time when the backup was performed and let you recover the database
to the necessary state.

To create a backup chain, Veeam Plug-in implements the forward incremental backup method.

Full backup, its dependent differential backups and log backups of a Microsoft SQL Server database reside
in the same backup file. Depending on what backup settings you specify, the backup chain can also span
multiple backup files. This mechanism differs from the one for image-level backups created with Veeam
Backup & Replication where one restore point generally corresponds to one backup file.

The logical sequence of backups is hidden from the user — the user cannot get information about available
restore points from a sequence of backup files in the backup repository. The user can view and select
restore points when restoring a database. For more information, see Performing Restore.

For information about types of backup files that Veeam Plug-in creates and rules for creating the backup chain,
see Backup Files and How Backup Chain Works.

Backup Files
Veeam Plug-in for Microsoft SQL Server creates and maintains the following types of backup files:

• .VAB — backup files that store a copy of Microsoft SQL Server data.

• .VASM — backup metadata files that store information about the backup. A .VASM file is created for each
.VAB file. The .VASM files are used by Veeam Backup & Replication to get information about Veeam Plug-
in backups.

• .VACM — backup metadata files that store information about the backup job. Veeam Plug -in creates one
.VACM file for the backup job.

377 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

All backup files created by the backup job reside in a dedicated job folder in the backup repository. For example,
if the name of the backup job in Veeam Backup & Replication is SRV01 MSSQL backup (Backup Vol 01) , Veeam
Backup & Replication will create the SRV01 MSSQL backup (Backup Vol 01) folder on the target backup
repository and store all backup files created by this job in this folder.

How Backup Chain Works

Veeam Plug-in for Microsoft SQL Server creates the backup chain in the following way:

1. During the first backup session, Veeam Plug-in for Microsoft SQL Server creates a new .VAB file in the
backup repository and writes to this file data of the full backup. This backup becomes a starting point in
the backup chain.

Veeam Plug-in writes data of each backed-up database to a separate backup file. For examp le, if you back
up 2 databases, Veeam Plug-in will create 2 .VAB files in the backup repository.

2. During subsequent backup sessions, Veeam Plug-in for Microsoft SQL Server writes the backup data either
to the same .VAB file or to a new .VAB file. A new .VAB file is created if one of the following cases:

o If Veeam Plug-in performs full backup.

o If the previous backup file created for the database is older than 24 hours.

NOTE

If the backup is targeted at a scale-out backup repository, Veeam Plug-in selects an extent where to
write the backup data according to the placement policy specified for the scale -out backup
repository ( Data locality or Performance). After that, Veeam Plug-in applies the same algorithm to
choose whether to write the backup data to an existing backup file or new backup file.

Retention Policy
Veeam Plug-in allows you to configure retention policy for Microsoft SQL Server backups. The retention policy
helps maintain the life cycle of restore points and make sure that backup files do not consume the entire space
on the backup repository.

Veeam Plug-in for Microsoft SQL Server applies the retention policy at the database level and retains restore
points for a number of days defined in the backup settings. After each full backup or differential backup session,
Veeam Plug-in checks the time when restore points for the backed-up database were created and removes
outdated restore points from the backup chain.

Veeam Plug-in does not remove outdated restore points immediately. Instead, Veea m Plug-in applies the
retention policy to the inactive part of the backup chain — that is, the previous full backup and its dependent
differential and log backups. Only after the last incremental backup in the chain becomes outdated, Veeam
Plug-in will remove the inactive backup chain.

378 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

For example, the retention policy is set to 7 days. Veeam Plug -in is set to create full backups each Sunday, and
differential backups and log backups are created Monday through Saturday. Although a new full backup is
created on Sunday, the previous full backup is not deleted. Without the full backup, the functionality of the
subsequent chain of differential and log backups will be compromised. Veeam Plug -in will wait for the time
when the last restore point in the inactive backup chain becomes outdated, and only then will delete the entire
inactive chain, which will happen next Saturday.

Retention Policy Configuration

To configure the retention policy, select the Ap p ly retention policy check box at the Ba ckup Options step of the
Ba ck Up Database wizard and specify the number of days to keep restore points in the backup chain. For details,
see Specify Backup Options.

In contrast to the retention policy for image-level backups in Veeam Backup & Replication, the retention policy
for backups created with Veeam Plug-in for Microsoft SQL Server is optional. This allows you to easier configure
retention policy for different types of Microsoft SQL Server backups.

For example, you want to configure backup settings to create full, differential, log and copy-only full backups
for the same database. In this case, you can enable retention policy in the backup settings for full backups only.
Differential, log and copy-only full backups that depend on the full backup will be processed according to the
retention policy specified for the full backup.

Alternatively, if you enable retention policy for multiple types of backups of the same database, you must
specify the same number of days to keep restore points in the backup chain for each backup type supported by
Veeam Plug-in. For the list of supported backups, see About Microsoft SQL Server Backup. Otherwise, Veeam
Plug-in will keep restore points according to the lowest number. For example, you set Veeam Plug-in to keep
full backups for 7 days and copy-only full backups for 30 days. In this case, Veeam Plug -in will remove inactive
backup chains whose restore points are older than 7 days during the next full backup session.

If you do not specify the retention policy for any type of Microsoft SQL Server backup, Veeam Plug -in will not
remove outdated restore points, and backup files fill remain in the backup repository.

You can also manually delete Veeam Plug-in backups from a backup repository using the Veeam Backup &
Replication console. For details, see: Deleting Backup.

Support for SQL Server Failover Clusters

Veeam Plug-in supports backup and restore of Microsoft SQL Server databases that operate as part of a failover
cluster. Both Windows Server Failover Clusters with shared disks and Windows Server Failover Clusters with
Cluster Shared Volumes (CSV) are supported.

To back up databases that operate as part of a failover cluster, do the following:

1. Install and configure Veeam Plug-in for Microsoft SQL Server on each node of the cluster. For more
information, see Installing Veeam Plug-in for Microsoft SQL Server and Configuring Veeam Plug-in for
Microsoft SQL Server.

379 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 2. Configure backup settings in Veeam Plug-in on the active cluster node. For more information, see
Configuring Backup Settings.

On the passive node, the Microsoft SQL Server instance that operates as part of the cluster is not
displayed in the Veeam Plug-in UI.

3. Save backup settings as an SQL Agent job in Microsoft SQL Server Management Studio. For more
information, see Saving Backup Settings as SQL Agent Job.

Veeam Plug-in for Microsoft SQL Server will start the backup job on the active cluster node.

To restore a database that operates as part of a failover cluster, you must start the restore process on the active
cluster node. On the passive node, the backed-up Microsoft SQL Server instance is not displayed in the Veeam
Plug-in UI.

Support for Always On Availability Groups

Veeam Plug-in supports backup and restore of Microsoft SQL Server databases that operate as part of an Always
On availability group.

The following types of availability groups are supported:

• Always On Availability Groups

• Always On Clusterless Availability Groups

Backup of Always On Availability Groups

To back up databases that operate as part of an Always On availability group, do the following:

1. Install and configure Veeam Plug-in for Microsoft SQL Server on each node of the cluster that runs Always
On Availability Groups. For more information, see Installing Veeam Plug-in for Microsoft SQL Server and
Configuring Veeam Plug-in for Microsoft SQL Server.

2. Configure backup settings in Veeam Plug-in on each node and save backup settings as SQL Agent jobs in
Microsoft SQL Server Management Studio. For more information, see Configuring Backup Settings and
Saving Backup Settings as SQL Agent Job.

3. In Microsoft SQL Server Management Studio on each node, configure the same schedule settings for SQL
Agent jobs so that database backup will start at the same time on each node.

Veeam Plug-in for Microsoft SQL Server performs backup of Always On Availability Groups in the following way:

1. When the SQL Agent job starts, Veeam Plug-in checks backup preferences specified in the properties of
the Always On availability group.

2. If the node on which the SQL Agent job is running is the preferred node for backup, Veeam Plug -in
performs backup. Otherwise, the backup process stops.

Consider the following:

• Veeam Plug-in does not check backup preferences of the Always On availability group if you start the
backup process manually from the Veeam Plug-in UI.

• On secondary replicas, only full copy-only backup and log backup are supported. Differential backup is not
supported.

• Veeam Plug-in does not add a restored database to an Always On availability group. You must perform
this operation manually after the restore process is completed. For details, see Restore of Always On
Availability Groups.

380 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Restore of Always On Availability Groups
To restore a database that operates as part of an Always On availability group, complete the following steps:

1. Restore the database on the primary replica. During the restore process, Veeam Plug -in will remove the
original database from the availability group and delete it from Microsoft SQL Server.

2. Perform log backup for the restored database.

3. Remove the original database from the secondary replica.

4. Add the restored database to the availability group.

381 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Configuring Backup Settings
To back up Microsoft SQL Server data with Veeam Plug -in, you must configure backup settings. You can select
what databases to back up, choose the backup type, specify data retention and data processing settings.

382 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 1. Launch Backup Wizard
To launch the Ba ck Up Database wizard, on the Microsoft SQL Server machine do either of the following:

• Click the Ba ck Up Database icon on the desktop.

• From the Microsoft Windows Sta rt menu, select All P rograms > Veeam > Back Up Database or use the
Microsoft Windows search to find the Ba ck Up Database option on your machine.

• In Microsoft SQL Server Management Studio, click the Ba ck Up Database button on the toolbar.

• Launch the %PROGRAMFILES%\Veeam\Plugins\Microsoft

SQL\Veeam.Backup.MSSQLPlugin.UI.Backup.exe file.

383 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 2. Select Databases to Back Up
At the Da tabases step of the wizard, select Microsoft SQL Server databases that you want to back up:

1. From the Instance drop-down list, select the Microsoft SQL Server instance whose databases you want to
back up.

2. In the Da tabases section, select check boxes next to the necessary databases. Alternatively, if you want to
back up all databases of the selected instance, select the check box next to the Da tabase Name column
name.

To quickly find the necessary databases, you can type the name of the database in the search field and
click the search icon.

To refresh the list of databases, click Refresh. When you refresh the list of databases, Veeam Plug -in will
clear check boxes next to the selected databases.

3. In the Ba ckup set name field, specify the name for the backup set. This will help you identify databases in
case you need to restore a database from the backup.

4. In the Description field, specify description for the backup set. The name and description of the backup set
will be displayed in the Restore Database wizard during restore.

5. In the Ba ckup type section, select the type of backup you want to create. You can select from the
following native Microsoft SQL Server backup types:

o Full — select this option if you want to create a backup that will contain a full copy of the Microsoft
SQL Server database.

o Differential — select this option if you want to create a backup that will contain changes since the
previous backup was created.

o Log — select this option if you want to create a backup of Microsoft SQL Server transaction logs.

6. If you selected the Full or Log option and want to create a copy-only full backup or copy-only log backup,
select the Cop y-only backup check box. For example, you may want to create copy-only log backups if you
use a separate solution to process Microsoft SQL Server transaction logs.

Keep in mind that differential backups cannot use the copy-only full backup as a starting point. To learn
more, see this Microsoft article.

384 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 TIP

At this step of the wizard, you can also export backup settings to a custom script. You will be able to use
this script with a third-party scheduling tool. For details, see Exporting Backup Settings to Custom Script.

385 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 3. Specify Backup Options
At the Ba ckup Options step of the wizard, specify data retention settings and data processing settings according
to which you want to perform backup, and start the backup process:

1. [Optional] To specify data retention settings, in the Retention section, do the following:

a. Select the Ap p ly retention policy check box.

b. In the Delete backups older than <N> days field, specify the number of days for which you want to
keep backups in the backup repository. By default, Veeam Plug -in keeps backup files for 7 days.

2. [Optional] To specify settings for data processing during the backup process, in the Da tabase processing
section, do the following:

a. In the Concurrent backup streams field, specify the number of data streams over which you want to
back up Microsoft SQL Server data. For each data stream, a separate VDI Device is started on the
Microsoft SQL Server machine. For details about the logic behind concurrent backup streams and
limitations, see Data Streams and Resource Consumption.

b. If you want to apply Veeam Backup & Replication mechanisms of data compression to the backup,
select the Use compression check box. To Veeam Plug-in for Microsoft SQL Server backups, the
Optimal (ZSTD) compression level is applied.

NOTE

Veeam Backup & Replication does not support data compression for databases encrypted with
transparent data encryption (TDE).

3. Click Run to start the backup process.

You can start the backup process if you want to create a backup immediately or if you want to check that
backup process with the specified settings performs successfully.

If you want Veeam Plug-in to perform backup with the specified settings regularly, you can also perform
one of the following operations:

o If you want to save backup settings as an SQL Agent job to be able to specify schedule for the backup
job in Microsoft SQL Server Management Studio, click Sa ve as a SQL Agent Job. For details, see Saving
Backup Settings as SQL Agent Job.

386 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 o If you want to export backup settings to a custom script and use this script with a third -party
scheduling tool, click Script. For details, see Exporting Backup Settings to Custom Script.

If you do not want to start the backup process immediately, click Close to exit the wizard.

387 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 4. Monitor Backup Process
If you started the backup process at the Ba ckup Options step of the wizard, at the Action Log step of the wizard
review the list of backup operations and click Close to exit the wizard.

TIP

At this step of the wizard, you can also save backup settings as an SQL Agent job. You will be able to
specify schedule for the backup job in Microsoft SQL Server Management Studio. For details, see Saving
Backup Settings as SQL Agent Job.

388 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Saving Backup Settings as SQL Agent Job
You can save backup settings specified for Veeam Plug -in for Microsoft SQL Server as an SQL Agent job. This
may be helpful if you have Microsoft SQL Server Management Studio in your environment and w ant to use its
functionality to apply schedule to a Microsoft SQL Server backup job.

To save backup settings as an SQL Agent job:

1. At the Ba ckup Options step of the Ba ck Up Database wizard, click Sa ve as a SQL Agent Job.

2. In the Create SQL Agent Job window, specify the name for the SQL Agent job and click Create.

The SQL Agent job will become available in the Job s node in Microsoft SQL Server Management Studio, and you
will be able to specify schedule in the job properties. During the SQL Agent job conf iguration, Veeam Plug-in for
Microsoft SQL Server creates a step that runs the MSSQLRecoveryManager.exe command with the specific
parameters.

TIP

Consider exit codes that the MSSQLRecoveryManager.exe command can return.

Exit Codes
The MSSQLRecoveryManager.exe command can return the following exit codes:

• -1 — the service returns this code when the backup or restore process fails with an error.

389 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 • 0 — the service returns this code when the backup or restore process is successful.

Make sure that you specify 0 in the P rocess exit code of a successful command field when you configure
the SQL Agent job properties using Microsoft SQL Server Management Studio.

390 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Exporting Backup Settings to Custom Script
You can export backup settings specified for Veeam Plug-in for Microsoft SQL Server to a custom script. This
may be helpful if you want to back up Microsoft SQL Server databases using a third -party scheduling tool.

To export backup settings to a custom script:

1. At the Da tabases, Ba ckup Options or Action Log step of the Ba ck Up Database wizard, click Script.

2. In the CLI Script window, review the command to back up Microsoft SQL Server data and click Cop y to
Clipboard.

You will be able to use the command in a custom script with an external scheduling tool.

TIP

You can modify parameters of the command used to back up Microsoft SQL Server data if necessary. For
information about available backup parameters, see Performing Backup with Command-Line Interface.

Exit Codes
The MSSQLRecoveryManager.exe command can return the following exit codes:

• -1 — the service returns this code when the backup or restore process fails with an error.

• 0 — the service returns this code when the backup or restore process is successful.

391 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Performing Backup with Command-Line
Interface
You can perform backup of Microsoft SQL Server databases with Veeam Plug -in using the command-line
interface.

To perform backup, do the following:

1. On the Microsoft SQL Server machine, navigate to the %PROGRAMFILES%\Veeam\Plugins\Microsoft

SQL\ folder.

2. Run the MSSQLRecoveryManager.exe command with the required parameters. For more information,
see Backup Parameters.

The following example shows a command to perform full backup of Microsoft SQL Server databases:

MSSQLRecoveryManager.exe --backup --d="IT" --d="Sales" --name="Database Ba

ckup" --description="Daily database backup" --type=full --parallelism=2 --
instance="dlsql01\MSSQLSERVER" --retention=5 --use_compression --check_pre
ferred

TIP

You can also use the available backup parameters to modify Veeam Plug -in for Microsoft SQL Server
commands used in custom scripts. For information, see Exporting Backup Settings to Custom Script.

Exit Codes
The MSSQLRecoveryManager.exe command can return the following exit codes:

• -1 — the service returns this code when the backup or restore process fails with an error.

• 0 — the service returns this code when the backup or restore process is successful.

Backup Parameters
You can specify the following parameters for backup of Microsoft SQL Server databases with the
MSSQLRecoveryManager.exe command:

Command Description

--help Shows the list of parameters for the

MSSQLRecoveryManager.exe command.

--b a ckup Defines the backup operation.

392 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 Command Description

--instance Specifies the name of the Microsoft SQL Server instance whose
databases you want to back up.

The following values are possible:

• value is not specified — for default instance that resides
on the standalone server
• <hostname>\<instance_name> — for named instance that
resides on the standalone server
• <cluster_name> — for default instance that resides on the
cluster node
• <cluster_name>\<instance_name> — for named instance
that resides on the cluster node

where:

• <hostname> — name of the host

• <instance_name> — name of the Microsoft SQL Server
instance
• <cluster_name> — name of the cluster

--d Specifies the name of the database to back up.

This parameter is optional. If you do not use this parameter,

Veeam Plug-in will back up all databases of the specified
instance.

Alternatively, if you want to back up all databases of the

instance except for the specified one, you can use the --ed
parameter and specify the necessary database as its value.

--ed Specifies the name of the database that must be excluded from
the backup.

This parameter is optional. If you do not use this parameter,

Veeam Plug-in will back up all databases of the specified
instance.

Alternatively, if you want to back up a specific database, you can

use the --d parameter and specify the necessary database as its
value.

--na me Specifies the name for the backup set.

--d escription Specifies the description for the backup set.

393 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 Command Description

--ty pe Specifies the backup type. Possible values:

• full — full backup
• diff — differential backup
• log — log backup

--cop y_only Defines the copy-only backup mode. You can use this parameter
to create copy-only full backups or copy-only log backups of
Microsoft SQL Server databases.

Keep in mind that differential backups cannot use the copy-only

full backup as a starting point. To learn more, see this Microsoft
article.

--p a rallelism Specifies the number of parallel data streams over which you
want to back up Microsoft SQL Server data. For each backup
stream, a separate VDI Device is started on the Microsoft SQL
Server machine.

--retention Specifies the number of days to keep backups in the backup

repository.

This parameter is optional. If you do not use this parameter,

Veeam Plug-in will not apply the retention policy to the backup.

--check_preferred [For backup of Always On Availability Groups] Defines that

Veeam Plug-in will check whether the availability replica is the
preferred replica for backup.

--use_compression Defines that Veeam Backup & Replication mechanisms of data

compression will be applied to the backup. To Veeam Plug-in for
Microsoft SQL Server backups, the Optimal (ZSTD) compression
level is applied.

394 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Managing Backup Job in Veeam Backup &
Replication
After Veeam Plug-in for Microsoft SQL Server starts the backup process, Veeam Backup & Replication create s
the backup job. You can use this job to view statistics on the backup process and generate backup job reports.
You can also disable the backup job.

You cannot start or edit Microsoft SQL Server backup jobs in the Veeam Backup & Replication console. You c an
manage backup operations on the Microsoft SQL Server machine only.

Consider the following:

• Veeam Backup & Replication creates one backup job for a standalone Microsoft SQL Server, Microsoft SQL
Server failover cluster or Always On availability group. All backup sessions for different databases that
reside on this server, cluster or availability group run within this backup job.

• Veeam Backup & Replication generates names for Microsoft SQL Server backup jobs according to the
following rules:

o For standalone Microsoft SQL Server, Veeam Backup & Replication generates the backup job name
based on the names of the Microsoft SQL Server machine and backup repository where Veeam Plug -in
creates Microsoft SQL Server backups.

o For Microsoft SQL Server that operates as part of a failover cluster or availability group, Veeam
Backup & Replication generates the backup job name based on the name of the cluster or name of the
availability group.

Viewing Backup Job Statistics

To view details of the backup process, do the following:

1. Open the Veeam Backup & Replication console.

2. In the Home view, expand the Job s node in the inventory pane and click Ap p lications Plug-ins.

3. In the working area, select the Microsoft SQL Server backup job to see details of the cur rent backup
process or the last backup job session.

395 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 NOTE

Veeam Backup & Replication does not display the progress bar for a running Veeam Plug -in for Microsoft
SQL Server backup job. Statistics for backup jobs of this type becomes available after the back up job
session is completed.

Generating Backup Job Reports

Veeam Backup & Replication can generate reports with details about Microsoft SQL Server backup job session
performance. The session report contains the following session statistics: session dura tion details, details of the
session performance, amount of read, processed and transferred data, backup size, compression ratio, list of
warnings and errors (if any).

To generate a report, do the following:

1. Open the Veeam Backup & Replication console.

2. In the Home view, expand the Job s node in the inventory pane and click Ap p lications Plug-ins.

396 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 3. In the working area, select the necessary job and click Rep ort on the ribbon. You can also right-click the
job and select Rep ort.

Disabling Backup Job

You can disable Microsoft SQL Server backup jobs in the Veeam Backup & Replication console. If you disable the
job, you will not be able to run Veeam Plug-in backup commands on the Microsoft SQL Server machine.

To disable a backup job, do the following:

1. Open the Veeam Backup & Replication console.

2. In the Home view, expand the Job s node in the inventory pane and click Ap p lications Plug-ins.

397 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 3. In the working area, select the necessary job and click Disable on the ribbon. You can also right-click the
job and select Disable.

398 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Managing Veeam Plug-in Backups in Veeam
Backup & Replication
In the Veeam Backup & Replication console, backups created by Veeam Plug -ins are displayed in the Ba ck ups >
Disk node of the Home view. For backups created by Veeam Plug-in for Microsoft SQL Server, consider the
following:

• In the working area, backups created by Microsoft SQL Server are listed under the Microsoft SQL node.

• In the list of Microsoft SQL Server backups, Veeam Backup & Replication displays one backup for a
standalone Microsoft SQL Server, Microsoft SQL Server failover cluster or Always On availability group.
This backup contains all restore points created for different databases that reside on this server, cluster or
availability group.

• Veeam Backup & Replication generates names for Microsoft SQL Server backups according to the
following rules:

o For standalone Microsoft SQL Server, Veeam Backup & Replication generates the backup name based
on name of the Microsoft SQL Server machine.

o For Microsoft SQL Server that operates as part of a failover cluster or availability group, Veeam
Backup & Replication generates the backup name based on the name of the cluster or name of the
availability group.

You can use the Veeam Backup & Replication console to perform the following operations with Veeam Plug-in
for Microsoft SQL Server backups:

• Delete a backup from the backup repository

• Remove a backup from configuration

• Repair a backup

Deleting Backup
You can use the Veeam Backup & Replication console to delete backups created with Veeam Plug -in for
Microsoft SQL Server from a Veeam backup repository.

To delete a backup, do the following:

1. In the Veeam Backup & Replication console, open the Home view.

2. In the inventory pane, select Ba ckups.

399 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 3. In the working area, right-click the name of the backed-up object and select Delete from disk.

Removing Backup from Configuration

If you want to remove records about backups from the Veeam Backup & Replication console and configuration
database, you can use the Remove from configuration operation.

When you remove a backup from configuration, backup files (.VAB, .VASM, .VACM) remain in the backup
repository. You can import the backup later and restore data from it.

To remove a backup from configuration:

1. Open the Home view.

2. In the inventory pane, select Ba ckups.

3. In the working area, select the necessary backup.

400 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 4. Press and hold the [Ctrl] key, right-click the backup and select Remove from configuration.

Repairing Backup
If you want to restore data from an immutable backup that resides in a hardened repository, you can use the
Rep air operation. During this operation, Veeam Backup & Replication will generate a new backup job metadata
(.VACM) file using information from the backup metadata (.VASM) files.

IMP ORTANT

This operation is intended only for a situation where the backup job metadata file has been lost as a result
of malware activity or unplanned actions. Re-creation of the backup job metadata file for other purposes is
not supported.

For more information about data restore from the hardened repository, see Hardened Repository.

Before you start the repair operation, you must perform the preparation steps. To learn more, see Preparing
Backup Created with Standalone Veeam Plug-in.

To repair a backup:

1. In the Veeam Backup & Replication console, open the Home view.

2. In the inventory pane, select Ba ckups.

3. In the working area, select the necessary backup.

401 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 4. Press and hold the [Ctrl] key, right-click the backup and select Rep air.

402 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Performing Restore
You can restore Microsoft SQL Server databases from backups created with Veeam Plug -in. Veeam Plug-in
supports restore of entire databases to the original Microsoft SQL Server machine or to another server.

You can restore a database to the same or different Microsoft SQL Server instance. If you have backup of
Microsoft SQL Server transaction logs, you can specify a point in time to which you want to restore the
database. Otherwise, Veeam Plug-in will restore the database to the time when the restore point was created.

IMP ORTANT

It is recommended to create a full backup immediately after you restore a database. All subsequent log or
differential backups of the restored database will be based on this full backup. This action helps prevent
potential data loss.

Before you perform database restore, consider the following:

• The backup job that created the backup must be present in Veeam Backup & Replication.

• To restore to another server under another user account, the account must have the Restore operator or
Backup administrator role on the Veeam backup server.

• To restore to another server, you must perform the restore operation on the target server, where you
want to place the new database backup.

To restore Microsoft SQL Server databases, you can use the Restore Database wizard or the
MSSQLRecoveryManager.exe command-line tool.

403 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Restore with Restore Database Wizard
You can restore Microsoft SQL Server databases using the Restore Database wizard.

If you want to restore databases from a Veeam Plug-in backup on another server, launch the wizard on the
target server, where you want to place the new database backup.

404 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 1. Launch Restore Wizard
To launch the Restore Database wizard, on the Microsoft SQL Server machine do either of the following:

• Click the Restore Database icon on the desktop.

• From the Microsoft Windows Sta rt menu, select All P rograms > Veeam > Restore Database or use the
Microsoft Windows search to find the Restore Database option on your machine.

• In Microsoft SQL Server Management Studio, click the Restore Database button on the toolbar.

• Launch the %PROGRAMFILES%\Veeam\Plugins\Microsoft

SQL\Veeam.Backup.MSSQLPlugin.UI.Restore.exe file.

405 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Step 2. Select Database to Restore
At the Source step of the wizard, select a Microsoft SQL Server database that you want to restore and restore
point from which you want to restore the database:

1. From the SQL Server Name drop-down list, select the name of the machine that runs Microsoft SQL
Server.

2. From the Instance drop-down list, select the Microsoft SQL Server instance whose database you want to
restore.

3. From the Da tabases drop-down list, select the database that you want to restore.

4. From the Select backup drop-down list, select the name of the backup that contains the selected
database. If only one backup in the backup repository contains the selected database, Veeam Plug -in will
automatically select and display this backup.

5. From the Select restore p oint list, select the name of the restore point from which you want to recover
data.

406 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Step 3. Specify Restore Point
At the Restore P oint step of the wizard, select a point in time to which you want to restore the database:

• Select Restore to the point in time when the selected backup was taken if you want to restore the
database to the point in time when the restore point that you selected at the Source step was created.

• Select Restore to any point in time if you want to restore the database to a specific point in time between
the selected restore point and a previous restore point. This option is available if you restore data from a
backup that contains Microsoft SQL Server transaction logs.

Use the slider control to choose the point in time you need.

407 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Step 4. Specify Restore Target
At the Ta rget step of the wizard, specify where and how you want to restore the database:

1. From the Instance drop-down list, select the Microsoft SQL Server instance where you want to restore the
database.

2. In the Da tabase field, specify the name for the restored database or select the name of the target
database from the drop-down list. Keep in mind that if you restore a database from the backup to a
database that exists in the Microsoft SQL Server instance, the target database will be overwritten.

3. In the Recovery state section, select the recovery state:

o RE COVERY

Rolls back ( undo) any uncommitted changes.

o NORE COVERY

Skips the undo phase so that uncommitted or incomplete transactions are held open.

This allows further restore stages to carry on from the restore point. When applying this option, the
database will be in the norecovery state and inaccessible to users.

o STANDBY

The database will be in the standby state and therefore available for read operations. You can also
provide a standby file with uncommitted transactions.

For more information on recovery modes, see this Microsoft article.

4. Review the following file locations:

o Primary database file

o Secondary database file and log files

By default, Veeam Plug-in selects the same file locations as for the original database. To specify custom
file locations, do the following:

a. Click Browse next to the necessary database file type.

b. In the Browse For Folder window, browse to the folder where you want to create the restored
database files or click Ma k e New Folder to create a new folder, and click OK.

408 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 5. Click Run to start the restore process.

409 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Step 5. Monitor Restore Process
At the Action Log step of the wizard, review the list of restore operations and click Close to exit the wizard.

410 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Restore with Command-Line Interface
You can restore backup of Microsoft SQL Server databases with Veeam Plug -in using the
MSSQLRecoveryManager.exe command-line tool.

If you want to restore databases from a Veeam Plug-in backup on another server, launch the wizard on the
target server, where you want to place the new database backup.

To perform restore with the command-line interface, do the following:

1. On the Microsoft SQL Server machine, navigate to the %PROGRAMFILES%\Veeam\Plugins\Microsoft

SQL\ folder.

2. Run the MSSQLRecoveryManager.exe command with the required parameters. For more information,
see Configuration Parameters.

For example, to restore a Microsoft SQL Server database, use the following command:

MSSQLRecoveryManager.exe --restore --src_server="srv16" --src_instance="MS

SQLSERVER" --src_database="IT" --src_backup="srv16 SQL Backup (Backup Vol
01)" --date="2022-08-17 09:03:49" --dst_instance="MSSQLSERVER" --dst_datab
ase="IT_restored" --recovery_state="recovery" --f="'IT'::'DC:\Program File
s\Microsoft SQL Server\MSSQL13.MSSQLSERVER\MSSQL\DATA\IT.mdf'" --f="'IT_lo
g'::C:\Program Files\Microsoft SQL Server\MSSQL13.MSSQLSERVER\MSSQL\DATA\I
T_log.ldf'"

Exit Codes
The MSSQLRecoveryManager.exe command can return the following exit codes:

• -1 — the service returns this code when the backup or restore process fails with an error.

• 0 — the service returns this code when the backup or restore process is successful.

Restore Parameters
You can specify the following parameters for database restore with the MSSQLRecoveryManager.exe
command:

Command Description

--help Shows the list of parameters for the

MSSQLRecoveryManager.exe command.

--restore Defines the restore operation.

--src_server Specifies the name of the original server that contained the
backed-up database.

--src_instance Specifies the name of the original Microsoft SQL Server instance
that contained the backed-up database.

411 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 Command Description

--src_cluster Specifies the name of the original Microsoft SQL Server cluster
that contained the backed-up database.

--src_aon Specifies the name of the original Always On availability group

that contained the backed-up database.

--src_database Specifies the name of the database that you want to restore.

--src_backup Specifies the name of the Veeam Backup & Replication job that
created the backup of the database you want to restore.

--src_backup_id Specifies the unique identifier of the Veeam Backup &

Replication job that created the backup of the database you
want to restore.

If the unique identifier of the backup is not specified, you can

use the name of the backup.

Keep in mind that if you specify both or neither the --src_backup

and --src_backup_id parameters when you initiate a restore
script, the restore operation will fail.

--p oint_in_time Specifies the point in time to which you want to restore the
database.

This parameter is optional. If you do not use this parameter,

Veeam Plug-in will restore the database to the time when the
latest restore point was created.

412 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 Command Description

--d st_instance Specifies the name of the target Microsoft SQL Server instance.

The following values are possible:

• value is not specified — for default instance that resides

on the standalone server
• <hostname>\<instance_name> — for named instance that
resides on the standalone server
• <cluster_name> — for default instance that resides on the
cluster node
• <cluster_name>\<instance_name> — for named instance
that resides on the cluster node

where:
• <hostname> — name of the host
• <instance_name> — name of the Microsoft SQL Server
instance
• <cluster_name> — name of the cluster

--d st_database Specifies the name of the restored database.

This parameter is optional. If you do not use this parameter,

Veeam Plug-in will restore the database with its original name.

If you restore the database with its original name to the original
location, the original database will be overwritten.

--recovery_state Specifies the recovery state. Possible values:

• recovery . Rolls back ( undo) any uncommitted changes.
• norecovery . Skips the undo phase so that uncommitted or
incomplete transactions are held open. This allows
further restore stages to carry on from the restore point.
When applying this option, the database will be in the
norecovery state and inaccessible to users.
• standby . The database will be in the standby state and
therefore available for read operations. You can also
provide a standby file with uncommitted transactions.

--standby_file_path Specifies the path to a standby file with uncommitted

transactions.

413 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 Command Description

--f Specifies the rules for database file mapping. Provide mapping
rules in the following format: --
f="'<DisplayName>'::'<TargetFileLocation>'".

For example: --
f="'DB'::'D:\SQLServer\Data\DB.mdf'".

This parameter is optional. If you do not use this parameter,

Veeam Plug-in will place database files to the same location and
with the same name as for the original database.

414 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Backup Copy for Microsoft SQL Server
Backups
Having just one backup does not provide the necessary level of safety. The primary backup may get destroyed
together with production data, and you will have no backups from which you can restore data.

To build a successful data protection and disaster recovery plan, it is recommended that you follow the 3 -2-1
rule:

• 3: You must have at least three copies of your data: the original production data and two backups.

• 2: You must use at least two different types of media to store the copies of your data, for example, local
disk and cloud.

• 1: You must keep at least one backup offsite, for example, in the cloud or in a remote site.

Thus, you must have at least two backups and they must be in different locations. If a disaster takes out your
production data and local backup, you can still recover from your offsite backup.

To help you adopt the 3-2-1 rule, Veeam Backup & Replication offers the backup copy functionality that allows
you to create several instances of the same backup in different locations, whether onsite or offsite. Backup
copies have the same format as those created by backup jobs and you can recover your data from them when
you need it.

Veeam Backup & Replication fully automates the backup copy process and lets you specify retention settings to
maintain the desired number of restore points, as well as full backups for archival purposes. Backup copy is a
job-driven process. When enabled, the backup copy job for Veeam Plug -in backups runs continuously.

415 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Creating Backup Copy Job
To copy backups to a secondary location, you must configure a backup copy job. The backup copy job defines
how, where and when to copy backups. One job can be used to process backups of one or more machines.

You can configure a job and start it immediately or save the job to start it later.

Before creating a job, check prerequisites. Then use the New Backup Copy Job wizard to configure a backup
copy job.

1. Launch Backup Copy Job wizard.

2. Specify a job name and description.

3. Select backups to process.

4. Define backup copy target.

5. Specify advanced settings.

6. Define backup copy schedule.

7. Finish working with the wizard.

Before You Begin

Before you create a backup copy job, check the prerequisites and limitations:

• Backup infrastructure components that will take part in the backup copy process must be added to the
backup infrastructure and properly configured. These include source and target backup repositories
between which backups must be copied.

• The target backup repository must have enough free space to store copied backups. To receive alerts
about low space on the backup repository, configure global notification settings. For more information,
see Specifying Other Notification Settings.

• For Veeam Plug-in backup copy jobs, you cannot select the following repositories as a backup copy target:

o Veeam Cloud Connect repository

o Object storage repository

416 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Step 1. Launch Backup Copy Job Wizard
To create a backup copy job, do the following:

1. In the Veeam Backup & Replication console, open the Home view.

2. Click Ba ckup Copy on the ribbon and select Ap p lication-level backup.

417 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 2. Specify Job Name and Description
At the Job step of the wizard, specify a name and description for the backup copy job.

1. In the Na me field, enter a name for the job.

2. In the Description field, enter a description for the job. The default description contains information about
the user who created the job, date and time when the job was created.

418 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 3. Select Backups to Process
At the Ob ject step of the wizard, select machines whose backups you want to copy to the target repository.

1. Click the Ad d button and select from which entity you want to process the machines.

o From jobs: You can select Veeam Plug-in backup jobs. When a backup copy job runs, Veeam Backup &
Replication will search for backup files created by selected jobs.

o From repositories: You can select repositories where Veeam Plug-in backups are stored. When a
backup copy job runs, Veeam Backup & Replication will search for backup files created by Veeam
Plug-in in selected repositories.

2. Use the Remove button if you want to remove selected jobs or repositories from processing.

3. If you have added jobs from a repository and want to exclude from processing some of the backup jobs on
the selected repository, click E x clusions and select the jobs that you want to exclude.

419 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Step 4. Define Backup Copy Target
At the Ta rget step of the wizard, configure the target repository settings.

1. From the Ba ckup repository list, select a backup repository in the target site where copied backups must
be stored. When you select a target backup repository, Veeam Backup & Replication automatically checks
how much free space is available on it. Make sure that you have enough free space to store copied
backups.

IMP ORTANT

For Veeam Plug-in backup copy jobs, you cannot select the following repositories as a backup copy
target:

• Veeam Cloud Connect repository

• Object storage repository

2. If the target repository contains a Veeam Plug-in backup that was excluded from the backup copy job, and
if you don't want to transfer duplicate data, you can use the mapping feature.

After you configure mapping, if some of backup files (.VAB) of the source backup are missing in the target
backup copy, these files are uploaded to the target backup copy.

NOTE

Veeam Plug-in backup copy jobs do not use WAN accelerators.

To map a backup copy job to the backup:

a. Click the Ma p backup link.

b. Point the backup copy job to the backup in the target backup repository. Backups in the target backup
repository can be easily identified by backup job names. To facilitate search, you can use the search
field at the bottom of the window.

IMP ORTANT
• Used account must have access to Veeam backup repositories that you plan to use.
• Encryption must be disabled on the repository.

Otherwise, the repositories will not be listed as available. To learn how to configure access
permissions and encryption settings on repositories, see Access and Encryption Settings on
Repositories.

420 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 3. You can specify the number of days after which the backup copy will be deleted from the repository. Note
that the countdown starts from the moment when source backup has been created.

421 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Step 5. Specify Advanced Settings
At the Ta rget step of the wizard, click Ad vanced to configure compression, RPO and notifications settings.

• Compression and Deduplication

• RPO

• Notifications

Compression and Deduplication

At the Storage tab, define compression and deduplication settings.

By default, Veeam Backup & Replication performs deduplication before storing copied data on the target backup
repository. Deduplication provides a smaller size of the resulting backup file but may reduce the job
performance.

1. You can disable data deduplication. To do this, clear the E na ble inline data deduplication check box.

2. From the Compression level list, choose a compression level to be used: Auto, None, Dedupe-friendly,
Op timal, High or E x treme. The recommended level of compression for backup copy jobs is Auto. In this
case, Veeam Backup & Replication uses compression settings of the copied backup files. For more
information, see Compression and Deduplication.

422 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 NOTE

Veeam Backup & Replication does not support data compression for databases encrypted with transparent
data encryption (TDE).

RPO Monitor
At the RP O Monitor tab, specify RPO warning settings.

Enable the W a rn me if backup is not copied within check box and specify the time period in minutes, hours, or
d a ys.

423 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

If the backup copy is not created within the specified time period, the backup copy job will finish with the
Warning status. The countdown starts from the moment when the required backup is finished and ready to be
copied.

Notifications
At the Notifications tab, to specify notification settings for the backup copy job:

1. At the Ta rget step of the wizard, click Ad vanced.

2. Click the Notifications tab.

3. Select the Send SNMP notifications for this job check box if you want to receive SNMP traps when the job
completes successfully. SNMP traps will be sent if you specify global SNMP settings in Veeam Backup &
Replication and configure software on recipient's machine to receive SNMP traps. For more inform ation,
see Specifying SNMP Settings.

4. Select the Send email notifications to the following recipients check box if you want to receive
notifications by email in case of job failure or success. In the field below, specify a recipient email address.
You can enter several addresses separated by a semicolon.

5. Veeam Backup & Replication sends a consolidated email notification once for the specified backup copy
interval. Even if the synchronization process is started several times within the interval, for example, due
to job retries, only one email notification will be sent.

6. Email notifications will be sent if you configure global email notification settings in Veeam Backup &
Replication. For more information, see Configuring Global Email Notification Settings.

7. At the Send at field, specify the time when you want to receive notifications. Note that you will receive a
notification on the job status once a day.

424 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 8. You can choose to use global notification settings or specify custom notification settings.

o To receive a typical notification for the job, select Use global notification settings. In this case, Veeam
Backup & Replication will apply to the job global email notification settings specified for the backup
server. For more information, see Configuring Global Email Notification Settings.

o To configure a custom notification for a job, select Use custom notification settings specified below.
You can specify the following notification settings:

i. In the Sub ject field, specify a notification subject. You can use the following variables in the
subject: %Time% (completion time), %JobName%, %JobResult%, %VmCount% (number of
machines in the job) and %Issues% (number of machines in the job that have been processed
with the W a rning or Fa iled status).

ii. Select the Notify on success, Notify on warning and Notify on error check boxes to receive email
notification if data processing within the backup copy interval completes successfully, fails or
completes with a warning.

425 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 6. Define Backup Copy Schedule
At the Schedule step of the wizard, define a time span in which the backup copy job must not transport data
between source and target backup repositories. For more information, see Backup Copy Window.

To define a backup window for the backup copy job:

1. Select the During the following time p eriods only option.

2. In the schedule box, select the desired time area.

3. Use the E na ble and Disable options to mark the selected area as allowed or prohibited for the backup copy
job.

426 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 7. Finish Working with Wizard
At the Summary step of the wizard, complete the procedure of backup copy job configuration.

1. Review details of the backup copy job.

2. Select the E na ble the job when I click Finish check box if you want to start the job right after you finish
working with the wizard.

3. Click Finish to close the wizard.

427 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Converting Backup Copy to Backup
If you have imported Veeam Plug-in backup copies from another server, you can convert them into regular
backup files. When you convert a backup copy to a backup, Veeam Plug -in creates a backup job with the
converted backup. You can use this backup job to continue a backup chain and use the converted backup as a
restore point.

You can convert and unbind Veeam Plug-in backups into regular Veeam Plug-in backup files in the following
cases:

• If you have deleted a backup copy job which created the backup copy.

• If you have excluded a backup job from a backup copy job that used multiple backup jobs as a source.

• If you imported a Veeam Plug-in backup copy from another host.

NOTE

If you want to restore from a backup copy, you do not need to convert the backup copy to the backup.

Procedure
To convert a backup copy to a primary backup, do the following:

1. Run the MSSQLConfigTool.exe command-line tool with the --promote-backup-copy-to-

primary parameter:

MSSQLConfigTool.exe --promote-backup-copy-to-primary

2. Veeam Plug-in will display the list of available backup copies. Type the necessary backup copy number
and press [E nter]. Then follow instructions in the command prompt.

Backup copies available for promotion to the primary backup target:

1. Backup Copy Job 1\SERV01 Microsoft SQL backup (Default Backup Repositor
y)
Select a backup copy: 1
Proceed with the action?
1. Promote backup copy destination to the primary backup target
2. Cancel
Enter selection: 1
Promoting backup copy destination
Done

428 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Logs and Support
If you have any questions or issues with Veeam Plug-in for Microsoft SQL Server or Veeam Backup & Replication,
you can search for a resolution on Veeam R&D Forums or submit a support case on the Veeam Customer Support
Portal.

When you submit a support case, we recommend that you attach logs files related to Veeam Plug -in operations.

To export Veeam Plug-in logs, do the following:

1. On the computer with Microsoft SQL Server, navigate to the

%PROGRAMDATA%\Veeam\Backup\MSSQLPluginLogs directory and copy the contents of the directory.

TIP

Besides Veeam Plug-in logs, Customer Support may need additional information from the computer
with Veeam Plug-in. For example, Microsoft Windows event logs or SQL Server error logs. You can
run a special PowerShell script to collect all the required information. To learn more, see this Veeam
KB article.

2. On the Veeam Backup & Replication server, navigate to the %PROGRAMDATA%\Veeam\Backup\Plugin

directory and copy logs of the required backup or restore process.

429 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Veeam Plug-in for IBM Db2
Veeam Plug-in for IBM Db2 is a backup tool for IBM Db2 databases. Veeam Plug -in integrates with IBM Db2
tools and transfers database and log backups to repositories connected to Veeam Backup & Replication.

Database administrators can use Veeam Plug-in for IBM Db2 to create native application-level backups of IBM
Db2 server data. Compared to image-level backups created by Veeam Backup & Replication or Veeam Agent,
Veeam Plug-in offers more flexible scenarios for database backup. In particular, Veeam Plug -in users can back
up and restore individual IBM Db2 databases, as well as configure indepe ndent backup schedule for full,
incremental and log backups using built-in tools of IBM Db2 servers.

430 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Overview
Veeam Plug-in for IBM Db2 uses the backup and restore functionality of IBM Db2 built-in tools and transfers
backups to Veeam backup repositories. For details, see How Veeam Plug-in for IBM Db2 Works.

With the configured Veeam Plug-in, you can perform full, incremental or log backups for IBM Db2 databases.
Use Veeam Plug-in to back up databases in the following cases:

• If you want the database administrator to fully control the backup and recovery processes.

• If you want to back up and restore individual databases.

• If you want to use existing scripts or external schedulers.

• If you use high availability disaster recovery (HADR).

You can use the Veeam Backup & Replication console to initiate and manage the Veeam Plug -in backup
operations. For details, see Data Backup.

TIP

If you want to protect the server itself, you can use the image-level backup functionality of Veeam Backup
& Replication, Veeam Agent for Linux or Veeam Agent for IBM AIX.

In case of malware activity or unplanned actions, you can perform restore operations based on the backup data
transferred by Veeam Plug-in to the Veeam Backup & Replication backup repositories. You can restore entire
databases from a full backup or to a specific point in time. Veeam Plug-in for IBM Db2 supports restoring
databases to the original IBM Db2 machine or another server. For details, see Data Restore.

431 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

How Veeam Plug-in for IBM Db2 Works
Veeam Plug-in acts as an agent between an IBM Db2 server and Veeam backup repositories.

Veeam Plug-in compresses database backups and transfers them to a backup repository connected to the
Veeam Backup & Replication infrastructure. After you install and configure Veeam Plug -in on the IBM Db2
server, you can perform all backup and restore operations with scripts and with IBM Db2 tools, such as native
IBM Db2 Call Level Interface (CLI).

When Veeam Plug-in is configured, IBM Db2 tools perform a database backup in the following way:

1. When you start a database backup, IBM Db2 loads the configuration provided by Veeam Plug -in. This
configuration is stored in the Veeam Plug-in configuration file (veeam_config.xml) that is located in the
/opt/veeam/VeeamPluginforDB2 directory on the machine where Veeam Plug-in is installed.

2. Veeam Plug-in connects to the backup server specified in the configuration file and creates a backup job.
In the Veeam Backup & Replication console, Veeam backup administrators can use the back up job to
monitor IBM Db2 backups. Keep in mind that all backup jobs that you run on your machine with Veeam
Plug-in are displayed as 1 backup job in the Veeam Backup & Replication console.

3. Veeam Plug-in starts Veeam Data Mover services on the IBM Db2 server and on a backup repository.

4. Veeam Data Movers transport data to the backup repository.

432 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Data Backup
Veeam Plug-in for IBM Db2 integrates and uses native IBM Db2 mechanisms to back up data to the Veeam
backup repository. With the configured Veeam Plug-in, you can create full, incremental or log backups. For
details, see Backup Types.

For each backup operation, Veeam Plug-in automatically creates and stores database backup files. For each of
the created backup files, Veeam Plug-in also creates separate metadata files. The metadata files help Veeam
Plug-in to store and manage backup data while ensuring that the data is protected, accessible, and can be
quickly restored when needed. All backup files created for backup jobs reside in a dedicated job folder in the
backup repository. For details, see Backup Files.

To store backups, you can add and configure backup repositories to your Veeam Backup & Replication
infrastructure. For details on supported backup repositories, see Veeam Backup Repositories.

Backup Types
Veeam Plug-in uses native IBM Db2 mechanisms to create application-level backups of IBM Db2 data. You can
use Veeam Plug-in to create backups of the following types.

• Full backup

• Incremental backup

• Log backup

To create backups of a specific type, you must configure Veeam Plug -in and run the backup process. You can run
the backup process manually, immediately after you configure Veeam Plug -in. Alternatively, using third-party
schedulers, you can define schedule according to which Veeam Plug -in will back up IBM Db2 data automatically.

For details about IBM Db2 database backup, see Performing Backup.

Backup Files
For every backup job within Veeam Backup & Replication, Veeam Plug -in creates and stores database backup
files, and separate metadata files for each of the backup files. The backup files provide a consistent and
integrated way for Veeam Plug-ins to store and manage backup data, while ensuring that the data is protected,
accessible and can be quickly restored when needed.

All backup files created by the backup job reside in a dedicated job folder in the backup repository.

Backup Files
Veeam Plug-in stores backup files in the following formats:

• A .VAB file stores a compressed copy of an IBM Db2 database. Veeam Plug -in creates .VAB files for full,
incremental and log backups. Veeam Plug-in uses the system ID, database name and hostname to
generate the name of the .VAB file.

• A .VASM file stores metadata that contain information about the backup. A .VASM file is created for each
.VAB backup file with the same name as the backup file. The .VASM files are used by Veeam Backup &
Replication to get data about Veeam Plug-in backups.

• A .VACM file stores metadata that contain information about the backup job. A .VACM file is created for
each backup job. The .VACM file is used by Veeam Backup & Replication to get data about Veeam Plug -in
backup job.

433 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

In the initial backup session, Veeam Plug-in writes backup data about each backed-up database in a separate,
newly created backup file. During subsequent backup sessions, Veeam Plug -in can continue writing backup data
in the existing backup file or create a new file. Veeam Plug -in creates a new file in the following cases:

• Veeam Plug-in performs a full backup.

• Veeam Plug-in created the previous backup file more than 24 hours ago.

Keep in mind the following:

If you use the scale-out backup repository as a backup target, Veeam Plug-in can create a backup file for the
backed-up database on each repository extent.

Reuse of Backup Files

During backup and restore operations, Veeam Plug -in creates and stores backup files in the Veeam Backup &
Replication backup database. Veeam Plug-in can also reuse backup files by placing multiple backups in a single
.VAB file. This approach helps with optimizing the number of objects in the backup database. Veeam Plug -in
reuses backup files considering the following backup file limits:

• Backup file can contain up to 1000 objects.

• Veeam Plug-in can write data to the created backup file for 24 hours.

After one of the limits is archived, Veeam Plug-in closes the backup file and cannot add new data to this
file. Keep in mind that Veeam Plug-in must close the backup file to allow Veeam Backup & Replication to
perform the following operations:

o Set the immutability for the backup file.

o Copy and move backup file to the capacity tier.

Veeam Backup Repositories

Veeam Plug-ins store backup files in repositories added to the Veeam Backup & Replication infrastructure. In
this section, you can find the list of supported backup repositories and limitations for Veeam Plug -in backups.

Before you start performing operations on backup repositories within the Veeam Backup & Replication
infrastructure, consider that you need to set the access permissions for each repository. For details, see Access
and Encryption Settings on Backup Repositories.

Supported Backup Repositories

You can use the following types of repositories added to the Veeam Backup & Replication infrastructure to store
backups created with Veeam Plug-in for IBM Db2:

• Windows Server

• Linux Server

• SMB (CIFS) Share

• NFS Share

• Dell Data Domain with Data Domain Boost (DDBoost)

• Fujitsu ETERNUS CS800

• Infinidat InfiniGuard

434 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 • HPE StoreOnce

If you plan to use HPE StoreOnce as a backup repository for Veeam Plug -in backups, the total number of
stored files (data and metadata) must not exceed 3,000,000 per Catalyst store. If necessary, multiple
Catalyst stores may be created on the same StoreOnce system.

• Quantum DXi

• ExaGrid

Make sure the repository is configured as described in the ExaGrid section in the Veeam Backup &
Replication User Guide.

• Hardened Repository

• Scale-Out Backup Repository

Make sure that the performance extents of the scale-out backup repository contain repositories supported
by Veeam Plug-in for IBM Db2. For example, you cannot use object storage repositories as performance
extents to keep backups created with Veeam Plug-ins.

Backup Repository Limitations

Before you start working with Veeam Plug-in backups, consider the following:

• For Veeam Plug-in backups, the warning which indicates that free space on a storage device has reached a
specified threshold is set in the veeam_config.xml file. The warning settings in the Veeam Backup &
Replication console does not affect this setting.

To configure the warning settings, add the following parameter:

<PluginParameters repositoryFreeSpacePercentWarning="10" />

Keep in mind that you must add the parameter to the existing line in the veeam_config.xml file. If you
create a new line with the same name as the existing line, Veeam Plug -in will consider parameters only in
the first detected line. Other parameters will be ignored.

• The Veeam Plug-in configuration wizard will not show repositories where the E ncrypt backups stored in
this repository option is enabled. To learn how to disable the encryption option, see Access and
Encryption Settings on Backup Repositories.

• Make sure that Veeam backup repositories have enough free space to store database b ackups and
transaction log backups. If required, you can use a scale-out backup repository.

• Veeam extract utility cannot extract backup files created by Veeam Plug -in.

• Veeam Plug-ins do not support backup operations targeted directly to object storage repositories.
To learn more about object storage repositories, see the Object Storage Repositories section in the Veeam
Backup & Replication User Guide.

• Veeam Plug-ins do not support backup operations to object storage added as a performance extent of a
scale-out backup repository.

435 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Veeam Scale-Out Backup Repositories
If you want to store Veeam Plug-in backups on scale-out backup repositories, consider the following:

• You cannot rename a scale-out backup repository with Veeam Plug-in backups stored on this repository.

• For Veeam Plug-in backups and backup copies, the Performance policy of a scale-out repository functions
differently:

a. Veeam Backup & Replication checks if there are extents without warning on free space insufficiency.

If there is no extents without the warning, Veeam Backup & Replication uses an extent with the
largest amount of free space that has a free task slot.

b. For the extents without the warning, Veeam Backup & Replication checks if there are incremental
extents with free task slots.

If there are no incremental extents with free task slots, Veeam Backup & Replication uses a full extent
with the least amount of used task slots.

c. For incremental extents with free task slots, Veeam Backup & Replication sends backup files to an
incremental extent with the least amount of used task slots.

If several extents has the same least amount of used tasks, Veeam Backup & Replication uses an
extent with the largest amount of free space.

To learn more about file placement policies of scale-out repositories, see Backup File Placement section in
the Veeam Backup & Replication guide.

• For a scale-out repository configured in the Data Locality policy, the repository extents are selected
according to the largest amount of free space for each connection. If the selected extent does not have
free task slots, Veeam Backup & Replication uses the extent with the next largest amount of free space.

If there are two extents with only one task slot on each extent, the backup is performed using two parallel
streams (one stream per extent).

• If you want to add a backup repository which contains Veeam Plug -in backups as an extent to a scale-out
backup repository, you must do the following:

On the Veeam Backup & Replication console side

a. Select Veeam Plug-in backup files that reside in this backup repository and remove them from
configuration.

To learn more, see the Removing Backups from Configuration section in the Veeam Backup &
Replication User Guide.

b. Delete the Veeam Plug-in backup job.

To learn more, see the Disabling and Deleting Jobs section in the Veeam Backup & Replication User
Guide.

c. Add the repository as an extent to the scale-out repository.

To learn more, see the Extending Scale-Out Repositories section in the Veeam Backup & Replication
User Guide.

d. Rescan the scale-out repository.

To learn more, see the Rescanning Scale-Out Repositories section in the Veeam Backup & Replication
User Guide.

436 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 NOTE

[For imports to the scale-out backup repository] Before importing your backup, consider that
the names of all backup files (.VAB, .VASM, .VACM) and paths to these files contain only the
following allowed characters:

• a-zA-Z0-9
• _-.+=@^

If your backup was initially created on a standalone backup server, the default name of the
backup metadata file (.VACM) contains forbidden characters. Before importing, you must delete
forbidden characters from the file name or replace them with the allowed characters.

On the Veeam Plug-in side

e. Set the scale-out repository as the target for backups using the following command:

DB2ConfigTool --set-repository

f. Map the imported backups using the following command:

DB2ConfigTool --map-backup

Capacity Tier
You can configure Veeam Backup & Replication to transfer Veeam Plug -in backup files to a capacity tier. Both
policies (Move policy, Copy policy) are supported for Veeam Plug -in backups with the following limitations:

• Capacity tier does not verify whether data that is being moved is unique and has not been offloaded
earlier. Thus, it is highly recommended to check the pricing plans of your cloud storage provider to avoid
additional costs for offloading and downloading backup data.

• To offload backup files to the capacity tier, Veeam Backup & Replication splits data into 1 MB objects and
compresses the resulting objects. The default object size will be a compressed 1 MB block, resulting in
objects of around 512 KB in size.

• Veeam Backup & Replication offloads Veeam Plug-in for IBM Db2 backup files to the capacity tier with the
Copy and Move policies in different ways. With the Copy policy, Veeam Backup & Replication checks
backup files every 1 hour and runs an offload job only if new backup files exist. With the Move policy,
Veeam Backup & Replication checks backup files every 4 hours and runs an offload job, even if there are
no new files.

IMP ORTANT

With both the Copy and Move policies, Veeam Backup & Replication copies and moves to the
capacity tier only non-active backup files created more than 24 hours ago, which match the capacity
tier configuration parameters. To learn more about the capacity tier configuration, see Add Capacity
Tier in the Veeam Backup & Replication User Guide.

437 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 • Veeam Plug-in supports encryption of offloaded data to the capacity tier. The E ncrypt data uploaded to
ob ject storage option in the Ca pacity Tier settings of the scale-out backup repository ensures that the
entire collection of blocks along with the metadata will be encrypted while being offloaded. To learn more
about capacity tier encryption, see the Encryption for Capacity Tier section in the Veeam Backup &
Replication User Guide.

• Capacity tier does not track dependencies of full and incremental backup files. Thus, consider the
following:

o [For the Move policy] When backup files are transferred to the capacity tier, Veeam Backup &
Replication takes into account only the creation time of backup files. Make sure that the operational
restore window is not longer than the whole backup chain cycle period. Otherwise, you may
encounter the scenario when full backup files are transferred to the capacity tier and their increment
backup files still remain in the performance tier.

o The capacity tier immutability expiration date does not have the additional block generation period.
The immutability expiration date is based only on the number of days specified in the settings of the
object storage backup repository.

• In case a disaster strikes the scale-out repository and you have a Veeam Plug-in backup file on the capacity
tier, you must re-create the scale-out repository before you restore from this backup file. You must
connect the capacity tier with the Veeam Plug-in backup file to another backup server with Veeam Backup
& Replication and a scale-out repository. After that, you can import the backup files to Veeam Backup &
Replication and then perform data recovery operations.

Hardened Repository
You can configure Veeam Backup & Replication to transfer Veeam Plug -in backup files to a hardened repository.
The hardened repository helps to protect Veeam Plug -in backup files from loss as a result of malware activity or
unplanned actions. Backup files in the hardened repository become immutable for the time period specified in
the backup repository settings. During this period, backup files stored in the repository cannot be modified or
deleted.

For Veeam Plug-in backups, immutability works according to the following rules:

• Immutability is applied to backup .VAB files and backup metadata .VASM files. Backup job metadata
.VACM file are not immutable.

• Backup files become immutable for the configured time period (7 to 9999 days).

• Backup files become immutable after 24 hours have passed since each file was created. The immutability
service runs in the background at every hour. This service detects and sets immutability flags for any
backup file that can no longer be reused.

TIP

Contact Veeam Customer Support to change the default 24 hour lifespan of a backup file. To do that,
you can submit a support case on the Veeam Customer Support Portal.

• The immutability period is not extended for the active backup chain.

Data Restore from Hardened Repository

As a result of malware activity or unplanned actions, backup job metadata .VACM files may become unavailable
in the hardened repository. In this case, to restore data from the hardened repository, you must re -create the
backup job metadata .VACM file. For more information, see Restore from Hardened Repository.

438 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Data Restore
With the configured Veeam Plug-in for IBM Db2, you can restore IBM Db2 databases from Veeam Plug -in
backups that reside on Veeam backup repositories. Restore operations are performed on the Veeam Plug-in side.

Depending on the available type of Veeam Plug -in backups that will be the source for the restored databases,
you can perform the following restore operations:

• Restoring from backup.

Restore IBM Db2 databases from a Veeam Plug-in backup to the original server by using the db2
restore command. For details, see Restore to Original Server.

You can also restore IBM Db2 databases from a Veeam Plug -in backup to another server. For details, see
Restore to Another Server.

• Restoring from a backup copy.

Restore IBM Db2 databases from backup copies created for Veeam Plug -in backups. For details, see
Restore from Backup Copy.

Depending on the location of Veeam Plug-in backups that will be the source for the restored databases, you can
also perform the following restore operations:

• Restoring from simple repositories.

Restore IBM Db2 databases from Veeam Plug-in backups stored on supported types of repositories. For
details, see Veeam Backup Repositories.

• Restoring from hardened repositories.

Restore IBM Db2 databases from hardened repositories by creating new backup job metadata files
(.VACM) with data from available backup metadata files (.VASM). For details, see Restore from Hardened
Repository.

439 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Clusters
Veeam Plug-in supports backup and restore of IBM Db2 databases that operate as part of a failover cluster.

Veeam Plug-in supports data backup and restore for the following types of clusters:

• High availability disaster recovery (HADR)

• Failover clusters

To back up data with Veeam Plug-in, clustered databases must be managed with the following cluster
management software:

• IBM PowerHA (for clusters running IBM AIX only)

• IBM Tivoli System Automation (TSA)

• Pacemaker (for clusters running Linux-based OS only)

Backup of Cluster
To back up databases that operate as part of a failover cluster, do the following:

1. Install and configure Veeam Plug-in for IBM Db2 on each node of the cluster. For more information, see
Installing Veeam Plug-in for IBM Db2 and Configuring Plug-in.

2. Perform the backup on the active cluster node. For more information, see Performing Backup.

Veeam Plug-in will start the backup job on the primary cluster node.

In case of clustered database, Veeam Plug-in can store data from several cluster nodes in the same backup file
on the backup repository. To do this, Veeam Plug-in needs the name of the cluster. Depending on the cluster
management software that you use, Veeam Plug-in gets the cluster name in one of the following names:

• In case of IBM PowerH and IBM TSA, Veeam Plug-in gets the cluster name automatically.

• In case of Pacemaker, you must set the cluster name in the veeam_config.xml file. You must set the name
with the customServerName parameter. The parameter value must be the same as the name of your
cluster.

<PluginParameters customServerName="hostname.domain.tld" />

For example, if your cluster has the name db2 and the domain for the environment is customer1.local, you
have to set the following entry:

<PluginParameters customServerName="db2.customer1.local" />

Keep in mind that you must add the parameter to the existing line in the veeam_config.xml file. If you
create a new line with the same name as the existing line, Veeam Plug -in will consider parameters only in
the first detected line. Other parameters will be ignored.

Restore of Cluster
To restore a database that operates as part of a failover cluster, y ou must start the restore process on the
primary cluster node.

440 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Planning and Preparation
Before you start to use Veeam Plug-in for IBM Db2, read the environment planning recommendations and make
sure that your environment meets system requirements.

In This Section
• System Requirements

• Permissions

• Ports

• Licensing

• Veeam Backup Repositories

• Environment Planning

441 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

System Requirements
System requirements for Veeam Plug-in for IBM Db2 depend on the architecture of the Linux OS that runs on
your machine:

• System requirements for x64 Linux

• System requirements for Linux on Power

• System requirements for IBM AIX

System Requirements for x64 Linux

Before you start using Veeam Plug-in for IBM Db2 on machines running Linux OSes based on the x64
architecture, make sure the requirements listed in this section are met.

Sp ecification Requirement

IBM Db2 Veeam Plug-in supports the following configurations of IBM Db2:
• Versions: 10.5, 11.1, 11.5
• Editions: Standard, Advanced
• Environments: standalone servers, high availability disaster recovery (HADR), failover
clusters

In case of HADR and failover clusters, Veeam Plug-in supports the following cluster
management software: TSA, Pacemaker for Linux OSes, PowerHA for IBM AIX.

OS Veeam Plug-in is supported for the following Linux distributions:

• SLES 12: GA, SP3, SP4, SP5

• SLES 15: GA, SP1, SP4, SP5
• RHEL 6: 6.0, 6.1, 6.7
• RHEL 7: 7.0, 7.1, 7.5, 7.6, 7.9
• RHEL 8: 8.0, 8.1
• RHEL 9: 9.0, 9.2
• CentOS 7: 7.0, 7.5, 7.7, 7.9
• CentOS 8: 8.0, 8.1
• Ubuntu 12.04, 14.04, 16.04, 18.04, 20.04, 22.04 (LTS)

For additional information about supported Linux versions that are listed for supported
configurations of IBM Db2, see this IBM article.

442 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 Sp ecification Requirement

Veeam
Ba ckup & Veeam Backup & Replication supports two latest versions of Veeam Plug -ins. For example,
Rep lication Veeam Backup & Replication 12.3 supports Veeam Plug -in 12.3 and 12.2.

Keep in mind that if you use an earlier Veeam Plug -in build than the one that is included in
the installation ISO file of your Veeam Backup & Replication version, it may not have all the
features and bug fixes introduced in your Veeam Backup & Replication version. To learn more
about the Veeam Plug-in builds included in Veeam Backup & Replication installation ISO files,
see this Veeam KB article.

Network Veeam Plug-in should be able to establish a direct IP connection to the Veeam Backup &
Replication server. Thus, Veeam Plug-in cannot work with the Veeam Backup & Replication
server that is located behind the NAT gateway.

System Requirements for Linux on Power

Before you start using Veeam Plug-in for IBM Db2 on Linux machines running IBM Power Systems, make sure
the following requirements are met.

NOTE

The following system requirements apply to Veeam Plug-in for IBM Db2 for Linux on Power
operating in the standalone mode. The managed operation mode is not supported. For
details on operation modes, see Standalone and Managed Operations Modes.

Sp ecification Requirement

IBM Db2 Veeam Plug-in supports the following configurations of IBM Db2:
• Versions: 10.5, 11.1, 11.5
• Editions: Standard, Advanced
• Environments: standalone servers, high availability disaster recovery (HADR), failover
clusters

In case of HADR and failover clusters, Veeam Plug-in supports the following cluster
management software: TSA, Pacemaker for Linux OSes, PowerHA for IBM AIX.

443 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 NOTE

OS Veeam Plug-in is supported for the following Linux distributions:

• SLES 12: GA, SP3, SP4, SP5

• SLES 15: GA, SP1, SP4, SP5
• RHEL 6: 6.0, 6.1, 6.7
• RHEL 7: 7.0, 7.1, 7.5, 7.6, 7.9
• RHEL 8: 8.0, 8.1
• RHEL 9: 9.0, 9.2
• CentOS 7: 7.0, 7.5, 7.7, 7.9
• CentOS 8: 8.0, 8.1
• Ubuntu 12.04, 14.04, 16.04, 18.04, 20.04, 22.04 (LTS)

For additional information about supported Linux versions that are listed for supported
configurations of IBM Db2, see this IBM article.

Veeam Veeam Backup & Replication supports two latest versions of Veeam Plug -ins: 12.3 and 12.2.
Ba ckup &
Rep lication To learn more about the Veeam Plug-in builds included in Veeam Backup & Replication
installation ISO files, see this Veeam KB article.

Network Veeam Plug-in should be able to establish a direct IP connection to the Veeam Backup &
Replication server. Thus, Veeam Plug-in cannot work with the Veeam Backup & Replication
server that is located behind the NAT gateway.

System Requirements for IBM AIX

Before you start using Veeam Plug-in for IBM Db2 on machines running IBM AIX, make sure the requirements
listed in this section are met.

Sp ecification Requirement

IBM Db2 Veeam Plug-in supports the following configurations of IBM Db2:
• Versions: 10.5, 11.1, 11.5
• Editions: Standard, Advanced
• Environments: standalone servers, high availability disaster recovery (HADR), failover
clusters

In case of HADR and failover clusters, Veeam Plug-in supports the following cluster
management software: TSA, Pacemaker for Linux OSes, PowerHA for IBM AIX.

444 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 Sp ecification Requirement

OS Veeam Plug-in is supported for the following Unix versions:

• IBM AIX 6: 6.1
• IBM AIX 7: 7.1, 7.2, 7.3

For additional information about supported IBM AIX versions that are listed for supported
configurations of IBM Db2, see this IBM article.

Veeam Veeam Backup & Replication supports two latest versions of Veeam Plug -ins. For example,
Ba ckup & Veeam Backup & Replication 12.3 supports Veeam Plug -in 12.3 and 12.2.
Rep lication
Keep in mind that if you use an earlier Veeam Plug -in build than the one that is included in
the installation ISO file of your Veeam Backup & Replication version, it may not have all the
features and bug fixes introduced in your Veeam Backup & Replication version. To learn more
about the Veeam Plug-in builds included in Veeam Backup & Replication installation ISO files,
see this Veeam KB article.

Network Veeam Plug-in should be able to establish a direct IP connection to the Veeam Backup &
Replication server. Thus, Veeam Plug-in cannot work with the Veeam Backup & Replication
server that is located behind the NAT gateway.

445 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Permissions
For general requirements for permissions that must be provided to the user account to install and work with
Veeam Backup & Replication, see the Permissions section in the Veeam Backup & Replication User Guide. In
addition to general port requirements, make sure that user accounts have permissions listed in the following
subsections:

Op eration Required Roles and Permissions

Installing and The account used for installing and updating Veeam Plug -in must have root
updating Veeam Plug- privileges.
in

• The account specified in the Veeam Plug-in configuration settings must be

Connecting to Veeam
Backup & Replication, able to authenticate against the Veeam Backup & Replication server. For
managing backups details, see Configuring Plug-in. For enhanced security, we recommend
creating a separate standard user that will be solely dedicated to performing
the backup and restore operations.
• The account specified in the Veeam Plug-in configuration settings must be
granted access rights on the Veeam backup repository where you want to
store backups.

To learn how to grant permissions on Veeam repositories, see Access and

Encryption Settings on Backup Repositories.

• You can work with backups created by Veeam Plug-in only with the account
used for creating the backups. If you want to use another account, see
required permissions in Configuring Plug-in.

446 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Ports
To enable proper work of Veeam Plug-ins, make sure that the following ports are open.

IBM Db2 Server

The following table describes network ports that must be opened to ensure proper communication of the IBM
Db2 server and backup infrastructure components.

From To P rotocol P ort Notes

Default port used for communication with

Veeam the Veeam Backup & Replication server.
Backup & Note that data between Veeam Plug-ins
TCP 10006
Replication and backup repositories is transferred
server directly, bypassing the Veeam Backup &
Replication server.
IBM Db2
server
Backup
where Default range of ports used as data
repository
Veeam 2500 to transmission channels. For every TCP
server or TCP
Plug-in is 3300** connection that a backup process uses,
gateway
installed one port from this range is assigned.
server*

Local connections between Veeam Plug-in

IBM Db2 6791+, and source Data Movers.
server TCP 2500 to
(localhost) 3300** If port 6791 is occupied, the succeeding
port numbers will be used.

* For NFS share, SMB share repositories, and Dell Data Domain, HPE StoreOnce deduplication storage appliances, Veeam
Backup & Replication uses an auxiliary backup infrastructure component — gateway server. For details, see the Gateway
Server section in the Veeam Backup & Replication User Guide.
** This range of ports applies to newly added backup infrastructure components. If you upgrade to Veeam Backup &
Replication 10.0 from earlier versions of the product, the range of ports from 2500 to 5000 applies to the already added
components.

447 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Backup Repositories and Gateway Servers
On backup infrastructure components, Veeam Backup & Replication automatically creates firewall rules for the
required ports. These rules allow communication between the components. Depending on the type of backup
repositories that you use for Veeam Plug-in backups, the following ports must be open to allow communication
between backup infrastructure components.

From To P rotocol P ort Notes

Backup
Veeam Default range of ports used as data
repository
Backup & 2500 to transmission channels. For every TCP
server or TCP
Replication 3300** connection that a backup process uses,
gateway
server one port from this range is assigned.
server*

Direct Attached Storage

Linux server
used as a
Port used as a control channel from the
backup
TCP 22 Veeam Plug-in server to the target Linux
repository or
host.
gateway
server
Veeam
Backup &
Replication Microsoft Ports used as a management channel from
TCP 135,
server Windows the Veeam Plug-in server to the
137 to 139,
server used UDP Repository/Gateway server. Also, the ports
445
as a backup are used to deploy Veeam components.
repository or
gateway 6160, Default ports used by the Veeam Installer
server TCP
6162 Service and Veeam Data Mover Service

Network Attached Storage

Gateway Default port used by the SMB transport

TCP 445
server protocol.

(specified in
the SMB SMB server SMB/Netbios name resolution for the SMB
share TCP 135, protocol (needed in some cases). For
repository UDP 137 to 139 details, see the Used Ports section in the
settings) Veeam Backup & Replication User Guide.

448 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 From To P rotocol P ort Notes

Gateway
server

(specified in TCP Standard NFS ports used as a transmission

111,
the NFS NFS server channel from the gateway server to the
UDP 2049
share target NFS share.
repository
settings)

Dell Data Domain

Port used to assign a random port for the

mountd service used by NFS and
TCP 111
DDBOOST. Mountd service port can be
statically assigned.
Veeam Dell Data
Backup & Domain Main port used by NFS. To change the
Replication port, you can use the nfs set server-
server For more TCP 2049
information, port command. Note that the command
or
see this Dell requires SE mode.
Gateway
server KB article.
Main port used by NFS MOUNTD. To
change the port, you can use the nfs set
TCP 2052
mountd-port command. Note that the
command requires SE mode.

HP E StoreOnce

Veeam Default command port used for

9387
Backup & communication with HPE StoreOnce.
Replication
HPE
server TCP
StoreOnce
or Default data port used for communication
Gateway 9388
with HPE StoreOnce.
server

E x aGrid

Veeam
Backup & Default command port used for
ExaGrid TCP 22
Replication communication with ExaGrid.
server

Qua ntum DXi

449 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 From To P rotocol P ort Notes

Veeam
Backup & Default command port used for
Quantum DXi TCP 22
Replication communication with Quantum DXi.
server

Fujitsu ETERNUS CS800

Veeam
Fujitsu Default command port used for
Backup &
ETERNUS TCP 22 communication with Fujitsu ETERNUS
Replication
CS800 CS800.
server

Infinidat InfiniGuard

Veeam
Backup & Infinidat Default command port used for
TCP 22
Replication InfiniGuard communication with Infinidat InfiniGuard.
server

For detailed list of ports used by Veeam Backup & Replication server and backup repositories, see the Used Ports
section in the Veeam Backup & Replication User Guide.

450 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Licensing
To use the Veeam Plug-in functionality, you must have a valid Veeam Backup & Replication license. Licenses are
installed and managed on the Veeam Backup & Replication server that is connected to the Veeam Plug -in server.
If the license is not valid or out of resources, Veeam Plug -in backup jobs fail.

This guide provides information only on specifics of Veeam licenses for Veeam Plug-ins. For terminology and
general information about Veeam Licensing, see Veeam Licensing Policy.

Licensed Objects
A machine with Veeam Plug-in is assumed protected if it has been processed by a Veeam Plug-in backup job in
the last 31 days.

If you use any instance-based (Veeam Universal Licensing) license in Veeam Backup & Replication, you do not
need to install any additional licenses. A protected server with Veeam Plug -in consumes one instance unit from
the license. Servers processed by backup copy jobs are not regarded as protected machines, these types of jobs
provide an additional protection level for machines that are already protected with Veeam Plug -in backup jobs.

A machine protected by both Veeam Plug-in and Veeam Backup & Replication will consume a license only once.
For example, you have IBM Db2 server that you back up using Veeam Plug -in. You also back up this server using
image-level backup functionality of Veeam Backup & Replication. In this case, only one license will be
consumed.

NOTE

[For Perpetual per-socket licenses] If you are using a legacy perpetual per-socket license, a license is
required for each hypervisor CPU socket occupied by protected servers.

A socket is consumed from the license only if the hypervisor where protected servers reside is added to the
Veeam Backup & Replication infrastructure. If the hypervisor is not added to the Veeam Backup &
Replication infrastructure, an instance unit will be consumed from the license. To learn how to add a
hypervisor to the Veeam Backup & Replication infrastructure, see the Virtualization Servers and Hosts
section in the Veeam Backup & Replication User Guide.

IMP ORTANT

If you have a clustered database, each node of the cluster will consume one License Unit. The License Units
are consumed for all cluster nodes, even if Veeam Plug-in is installed only on one of the nodes.

Supported License Types

You can use Veeam Plug-ins with the following license types and packages. Note that this guide contains
information on specifics of Veeam license packages only for Veeam Plug-ins. For the full list of license packages,
see this Veeam webpage.

• For Veeam Universal license:

You can use Veeam Plug-ins with all license packages ( Veeam Backup Essentials, Veeam Backup &
Replication, Veeam Availability Suite ).
Note that if you use the Rental license type, functionality of Veeam Plug-ins is supported only for the
Enterprise Plus edition of Veeam Backup & Replication.

451 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 • For Socket license:

Functionality of Veeam Plug-ins is supported only for the Enterprise Plus edition of Veeam Backup &
Replication.

Obtaining and Managing Licenses

To learn how to install a license and monitor licensed objects, see the Licensing section in the Veeam Backup &
Replication User Guide.

452 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Environment Planning
Before you deploy Veeam Plug-in, keep in mind the following requirements and limitations.

Hosting Environments and Backup Job Names

By default, Veeam Plug-in uses the hostname of the IBM Db2 machine or cluster to create a Veeam Backup &
Replication job and backup folder. To distinguish between servers with the same hostnames, you can assign
custom names to these servers.

To assign a custom name, update the Veeam configuration XML file as follows:

1. On the machine with Veeam Plug-in, open the

/opt/veeam/VeeamPluginforDB2/veeam_config.xml file.

2. Add the customServerName parameter entry to the <PluginParameters /> line in the Veeam
configuration XML file:

<PluginParameters customServerName="hostname.domain.tld" />

where <hostname.domain.tld> is a custom name of the server.

After adding this parameter, Veeam Plug-in will use the specified custom name of the server to name the
backup job and backup folder.

For example:

<PluginParameters customServerName="srv01.tech.local" />

Alternatively, you can use the useFQDNInServerName parameter:

<PluginParameters useFQDNInServerName="true" />

After adding this parameter, Veeam Plug-in will use the fully qualified domain name (FQDN) of the server to
name the backup job and backup folder.

Keep in mind that you must add the parameters to the existing line in the veeam_config.xml file. If you
create a new line with the same name as the existing line, Veeam Plug-in will consider parameters only in the
first detected line. Other parameters will be ignored.

IMP ORTANT

For security reasons, it is recommended to use separate repositories for different customers and limit the
Veeam Repository Authentication to the specific customer.

Network Traffic Encryption

Veeam Plug-in supports network traffic encryption rules set on the Veeam Backup & Replication side. By
default, Veeam Plug-in for IBM Db2 automatically applies the traffic encryption rules. To decrease the
processing load on the database server, you can disable network traffic encryption by ignoring the rules set on
the Veeam Backup & Replication side.

453 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

To ignore network traffic encryption rules, do the following:

1. On the machine with Veeam Plug-in, open the

/opt/veeam/VeeamPluginforDB2/veeam_config.xml file.

2. Add the following parameter to the Veeam configuration XML file:

<IgnoreVBRNetworkRules=true />

To learn more about traffic encryption, see the Enabling Traffic Encryption section in the Veeam Backup &
Replication User Guide.

454 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Getting Started
To protect IBM Db2 databases with Veeam Plug-in, perform the following operations:

1. Deploy Veeam Plug-in on the machine that runs IBM Db2. For more information, see Installing Veeam
Plug-in for IBM Db2.

2. Configure connection between Veeam Plug-in and the backup repository managed by the Veeam Backup &
Replication server. For more information, see Configuring Plug-in.

3. Define what data you want to back up and configure backup settings. For more information, see
Performing Backup.

4. In case of a disaster, you can restore data from a backup. For more information, see Performing Restore.

455 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Deployment and Configuration
Veeam Plug-in for IBM Db2 is a feature of Veeam Backup & Replication. This guide gives instructions on how to
deploy Veeam Plug-in assuming that you already have deployed Veeam Backup & Replication and configured a
backup repository. To learn how to deploy Veeam Backup & Replication, see the Veeam Backup & Replication
User Guide for your platform.

To be able to use Veeam Plug-in for IBM Db2, you must complete the following steps:

1. Install Veeam Plug-in on the machine with IBM Db2.

2. Set the access and encryption settings on backup repositories.

3. Configure Veeam Plug-in settings.

456 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Installing Veeam Plug-in for IBM Db2
Installation scenario depends on the OS running on the machine you want to protect:

• Installing Plug-in on Linux.

• Installing Plug-in for Linux on Power.

• Installing Plug-in on IBM AIX.

Installing Plug-in on Linux

Veeam Plug-in for IBM Db2 is a feature of Veeam Backup & Replication, the installation package of the plug -in is
included in the Veeam Backup & Replication installation ISO file.

IMP ORTANT

Keep in mind the following:

• IBM Db2 must be installed on the machine.

• The /opt/veeam directory must be writable.
• The NOEXEC mount option must be disabled for the /var and /tmp directories.
• To install the plug-in, use the sudo command or a user with root privileges.
• If you want to install Veeam Plug-in scale-out cluster, repeat the described installation process on
all cluster nodes.

You can install Veeam Plug-in using the .RPM package, the .DEB package or extract the plug-in files from the
.TAR.GZ archive. Installation steps depend on the type of installation file suitable for your OS:

• Installing plug-in from .RPM package

• Installing plug-in from .DEB package

• Unpacking plug-in from .TAR.GZ archive

Installing Plug-in from .RPM Package

To install Veeam Plug-in, do the following:

1. Mount the Veeam Backup & Replication installation disk

(VeeamBackup&Replication_12.3.0.310_20241201.iso).

If you deploy Veeam backup infrastructure for the first time, you can download the Veeam Backup &
Replication installation disk image at the Download Veeam Products page.

2. In the installation disk folder, navigate to the Plugins\IBM Db2\Linux\x64 folder.

3. Upload the VeeamPluginforDB2-12.3.0.310-1.x86_64.rpm package to the Linux machine with IBM

Db2.

4. To install Veeam Plug-in, run the following command:

rpm -ivh VeeamPluginforDB2-12.3.0.310-1.x86_64.rpm

Once Veeam Plug-in is installed, you must configure the plug-in settings. For details, see Configuring Plug-in.

457 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Installing Plug-in from .DEB Package
To install Veeam Plug-in, do the following:

1. Mount the Veeam Backup & Replication installation disk

(VeeamBackup&Replication_12.3.0.310_20241201.iso).

If you deploy Veeam backup infrastructure for the first time, you can download the Veeam Backup &
Replication installation disk image at the Download Veeam Products page.

2. In the installation disk folder, navigate to the Plugins\IBM Db2\Linux\x64 folder.

3. Upload the VeeamPluginforDB2_12.3.0.310-1_amd64 package to the Linux machine with IBM Db2.

4. To install Veeam Plug-in, run the following command:

apt-get install VeeamPluginforDB2_12.3.0.310-1_amd64.deb

Once Veeam Plug-in is installed, you must configure the plug-in settings. For details, see Configuring Plug-in.

Unpacking Plug-in from .TAR.GZ Archive

To extract plug-in files from the .TAR.GZ archive, do the following:

1. Mount the Veeam Backup & Replication installation disk

(VeeamBackup&Replication_12.3.0.310_20241201.iso).

If you deploy Veeam backup infrastructure for the first time, you can download the Veeam Backup &
Replication installation disk image at the Download Veeam Products page.

2. In the installation disk folder, navigate to the Plugins\IBM Db2\Linux\x64 folder.

3. Upload the VeeamPluginforDB2.tar.gz archive to the Linux machine with IBM Db2.

4. Create the /opt/veeam directory with the following command:

mkdir /opt/veeam

TIP

The /opt/veeam directory is a default directory for the Veeam Plug-in installation. This directory is
used in relevant command examples in this guide.

5. Unpack Veeam Plug-in files from the archive to the /opt/veeam directory with the following command:

tar -xzvf VeeamPluginforDB2.tar.gz -C /opt/veeam

Once Veeam Plug-in is installed, you must configure the plug-in settings. For details, see Configuring Plug-in.

Installing Plug-in for Linux on Power

Veeam Plug-in for IBM Db2 for Linux on Power is an additional component of Veeam Backup & Replication, and
the installation package of the plug-in is included in the Veeam Backup & Replication installation ISO file.

458 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

You can install the plug-in using the .RPM package or extract the plug-in files from the .TAR.GZ archive.
Depending on the type of package suitable for your OS, perform steps in one of the following subsections:

• Installing Plug-in from .RPM Package

• Installing Plug-in from .DEP Package

• Unpacking Plug-in from .TAR.GZ Archive

IMP ORTANT

Keep in mind the following:

• IBM Db2 must be installed on the machine.

• The /opt/veeam directory must be writable.
• The NOEXEC mount option must be disabled for the /var and /tmp directories.
• To install the plug-in, use the sudo command or a user with root privileges.
• If you want to install Veeam Plug-in scale-out cluster, repeat the described installation process on
all cluster nodes.

Installing Veeam Plug-in from .RPM Package

To install Veeam Plug-in for IBM Db2 for Linux on Power, do the following:

1. Mount the Veeam Backup & Replication installation disk

(VeeamBackup&Replication_12.3.0.310_20241201.iso).

If you deploy Veeam backup infrastructure for the first time, you can download the Veeam Backup &
Replication installation disk image from the Veeam Backup & Replication: Download page.

2. Open the mounted disk image and go to the /Plugins/IBM Db2/Linux/ppc64le directory.

3. Upload the VeeamPluginforDB2-12.3.0.310-1.ppc64le.rpm file to the Linux machine with IBM

Db2.

4. To install Veeam Plug-in, run the following command:

rpm -i VeeamPluginforDB2-12.3.0.310-1.ppc64le.rpm

Installing Veeam Plug-in from .DEB Package

To install Veeam Plug-in, do the following:

1. Mount the Veeam Backup & Replication installation disk

(VeeamBackup&Replication_12.3.0.310_20241201.iso).

If you deploy Veeam backup infrastructure for the first time, you can download the Veeam Backup &
Replication installation disk image at the Download Veeam Products page.

2. In the installation disk folder, navigate to the Plugins\IBM Db2\Linux\ppc64le folder.

3. Upload the VeeamPluginforDB2_12.3.0.310-1_ppc64le package to the Linux machine with IBM

Db2.

459 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 4. To install Veeam Plug-in, run the following command:

apt-get install VeeamPluginforDB2_12.3.0.310-1-ppc64le.deb

Once Veeam Plug-in is installed, you must configure the plug-in settings. For details, see Configuring Plug-in.

Unpacking Veeam Plug-in from .TAR.GZ Archive

To extract plug-in files from the .TAR.GZ archive, perform the following:

1. Mount the Veeam Backup & Replication installation disk

(VeeamBackup&Replication_12.3.0.310_20241201.iso).

If you deploy Veeam backup infrastructure for the first time, you can download the Veeam Backup &
Replication installation disk image from the Veeam Backup & Replication: Download page.

2. Open the mounted disk image and go to the /Plugins/IBM Db2/Linux/ppc64le directory.

3. Upload the VeeamPluginforDB2.tar.gz file to the Linux machine with IBM Db2.

4. Create the /opt/veeam directory.

mkdir /opt/veeam

5. In the terminal, open the folder that contains the VeeamPluginforSAPHANA.TAR.GZ archive.

6. Unpack the plug-in files from the archive to the /opt/veeam directory.

tar -xzvf VeeamPluginforDB2.tar.gz -C /opt/veeam

Installing Plug-in on IBM AIX

Veeam Plug-in for IBM Db2 is a feature of Veeam Backup & Replication, the installation package of the plug -in is
included in the Veeam Backup & Replication installation ISO file.

IMP ORTANT

Keep in mind the following:

• IBM Db2 must be installed on the machine.

• The /opt/veeam directory must be writable.
• The NOEXEC mount option must be disabled for the /var and /tmp directories.
• To install Veeam Plug-in, use the sudo command or a user with root privileges. Make sure the root
user has privileges to add the .PKG file.
• If you want to install Veeam Plug-in scale-out cluster, repeat the described installation process on
all cluster nodes.

460 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

To install Veeam Plug-in on an IBM AIX machine, do the following:

1. Mount the Veeam Backup & Replication installation disk

(VeeamBackup&Replication_12.3.0.310_20241201.iso).

If you deploy Veeam backup infrastructure for the first time, you can download the Veeam Backup &
Replication installation disk image at the Download Veeam Products page.

1. In the installation disk folder, navigate to the Plugins\IBM Db2\AIX\ppc64 folder.

3. Upload the VeeamPluginforDB2-12.3.0.310-1.aix6.1.ppc.rpm package to the IBM AIX machine

with IBM Db2.

4. Install Veeam Plug-in with the following command:

rpm -i VeeamPluginforDB2-12.3.0.310-1.aix6.1.ppc.rpm

Once Veeam Plug-in is installed, you must configure the plug-in settings. For details, see Configuring Plug-in.

461 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Access and Encryption Settings on Backup
Repositories
When you configure Veeam Plug-in, you specify an account that must be used to connect to the Veeam Backup
& Replication server.

Before granting access permissions, consider the following:

• Consider supported types of backup repositories and limitations for IBM Db2 backups in Veeam Backup
Repositories.

• To store backups in a backup repository, the specified account must have access permissions on the target
backup repository.

To grant access permissions, do the following:

1. In Veeam Backup & Replication, open the Ba ckup Infrastructure view.

2. In the inventory pane, click the Ba ckup Repositories node or the Sca le-out Repositories node.

3. In the working area, select the necessary backup repository and click Set Access Permissions on the ribbon
or right-click the backup repository and select Access permissions.

4. In the Access Permissions window, on the Sta ndalone applications tab specify to whom you want to grant
access permissions on this backup repository:

o Allow to everyone — select this option if you want to grant repository access to any user. This option
is equal to granting access rights to the Everyone group in Microsoft Windows (anonymous users are
excluded). For security reasons, the option is not recommend ed for production environments.

o Allow to the following accounts or groups only — select this option if you want only specific users to
be able to store backups in this repository. Click Ad d to add the necessary users and groups to the list.

462 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 5. Veeam Plug-ins cannot send backups or backup copies to a backup repository where encryption is
enabled. Thus, make sure that the E ncrypt standalone application backups stored in this repository check
box is not selected.

6. Click OK.

463 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Granting Permissions to Users
When you install Veeam Plug-in for IBM Db2, full access rights to the plug-in configuration file are
automatically granted to all users. To protect sensitive information that is stored in the Veeam Plug -in
configuration file (veeam_config.xml) from unwanted access, we recommend limiting access to the Veeam
Plug-in configuration file to a dedicated group of users.

Before You Begin

Before you create a user group that will have access to the plug -in configuration file, consider the following:

• To perform this procedure, your OS user account must have root privileges.

• After a user is added to the group, the user must log out, then log in to the Linux OS again to activate the
group permissions.

• Add only trusted users to the group.

Granting Permissions to the Plug-In Configuration File

By default, the Veeam Plug-in configuration file (veeam_config.xml) is located in the
/opt/veeam/VeeamPluginforDB2 directory on the machine where Veeam Plug-in is installed. To grant
access to the configuration file to a dedicated group of users, do the following:

1. Create a new user group by running the following command:

sudo groupadd <groupName>

where <groupName> is the name of the created group.

2. Add a user to the group with the following command:

sudo usermod -a -G <groupName> <userName>

where:

o <groupName> — the name of the created group.

o <userName> — the name of the account that will be granted access to the configuration file.

3. Change the ownership of the configuration file to enable users from the dedicated group to access the
configuration file. To do this, run the following command:

sudo chgrp <groupName> /opt/veeam/VeeamPluginforDB2/veeam_config.xml

where <groupName> is the name of the created group.

4. Limit the permissions for the configuration file to allow the read-write access only to the members of the
group. To do this, use the following command:

sudo chmod 660 /opt/veeam/VeeamPluginforDB2/veeam_config.xml

464 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Configuring Plug-in
To configure Veeam Plug-in for IBM Db2, you can use DB2ConfigTool. The tool configures IBM Db2 settings and
saves the settings to the Veeam Plug-in configuration file (veeam_config.xml). The file is located in the
/opt/veeam/VeeamPluginforDB2 directory on the machine where Veeam Plug-in is installed.

To configure Veeam Plug-in, do the following on the machine with IBM Db2:

1. Log into the machine with a user with root or instance owner privileges.

2. To launch the Veeam Plug-in configuration tool, run the following command:

/opt/veeam/VeeamPluginforDB2/DB2ConfigTool --wizard

TIP

You do not need root privileges to launch the Veeam Plug -in configuration tool if you have
configured group access as described in the Permissions section.

If you have extracted files form the .TAR.GZ archive, go to the /opt/veeam/VeeamPluginforDB2
folder and run the following command:

DB2ConfigTool --wizard

3. Specify the fully qualified domain name (FQDN) or IP address of your Veeam Backup & Replication server.

Enter backup server name or IP address: serv02.tech.local

4. Specify the port which will be used to communicate with the backup server. Default port: 10006.

Enter backup server port number [10006]: 10006

5. Specify credentials to authenticate against the Veeam Backup & Replication server.

Enter username: serv02\administrator

Enter password for serv02\administrator: XXXXXXXXX

465 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 IMP ORTANT

Consider the following:

• You can work with backups created by Veeam Plug-in only with the account used for creating
the backups. If you want to use another account, assign the Veeam Backup Administrator role
or Veeam Backup Operator and Veeam Restore Operator roles to the account.

To learn how to assign Veeam Backup & Replication roles, see the Users and Roles section of
the Veeam Backup & Replication Guide.
• The account must have access permissions on the required backup repository. To learn how to
configure access permissions and encryption settings on repositories, see Access and
Encryption Settings on Backup Repositories.

6. Select the backup repository where you want to store backups. In the terminal dialog, enter the number of
the repository from the list of available repositories.

Available backup repositories:

1. Default Backup Repository
2. Off-Site Backup Repository
Enter repository number: 1

IMP ORTANT
• The used account must have access to Veeam backup repositories that you plan to use.
• Encryption must be disabled on the repository.

Otherwise, the repositories will not be listed as available. To learn how to configure access and
encryption settings on repositories, see Access and Encryption Settings on Backup Repositories.

7. Confirm if you want Veeam Plug-in to use built-in compression functionality of Veeam Backup &
Replication.

Do you want to use Veeam compression? (Y/n): Y

8. Confirm if you want Veeam Plug-in to switch the database to archive logging with the logarchmeth1
configuration parameter.

If you confirm, Veeam Plug-in backs up archive logs as specified with the logarchmeth1 parameter. For
details, see this IBM article. Keep in mind that you must set Veeam Plug-in to use the logarchmeth1
parameter to back up IBM Db2 databases online. Otherwise, you can back up databases only offline.

Do you want to apply logarchmeth1 configuration parameter? (Y/n): Y

466 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 9. Apply the Veeam Plug-in configuration. In the terminal dialog, enter 1.

Save configuration?
1. Apply configuration
2. Export configuration into a file for manual setup
3. Cancel without saving
Enter: 1

The plug-in was successfully configured

Alternatively, you can export configurations of Veeam Plug-in and IBM Db2 as an .XML and an .TXT files.
Later, you can use these files for the manual Veeam Plug -in and IBM Db2 configuration.

Enter path to Veeam configuration XML file /tmp/veeam_config.xml: /home/co

nfigurations/veeam_config.xml
Enter path to Db2 configuration TXT file /tmp/Db2_config.txt: /home/config
urations/db2_config.txt

If you confirmed to use the logarchmeth1 parameter and the Veeam Plug-in configuration is completed
successfully, the database switches to the BACKUP PENDING state. Thus, before you can activate the database,
you need to perform a full offline backup. To learn more, see Performing Full Backup.

To learn more about DB2ConfigTool and configuration file:

• Configuration file

• Configuration tool

Configuration File
The DB2ConfigTool configures IBM Db2 settings and saves the settings to the Veeam Plug -in configuration file
(veeam_config.xml). The file is located in the /opt/veeam/VeeamPluginforDB2 directory on the machine
where Veeam Plug-in is installed.

The configuration file has the following structure:

<Config>
<CAVerificationParameters />
<AdditionalCertificatePaths />
<ProxyConfig />
<VBRConnectionParams vbrHostName="172.24.182.188" vbrPort="10006" vbrUser="V
" vbrDomain="" vbrPassword="4SdkECGybVLU+7GMk886ZQ==" />
<Certificate />
<BackupForRestoreParams />
<AgentParams />
<RepositoryParams>
<Repository repositoryName="Default Backup Repository" repositoryID="887
88f9e-d8f5-4eb4-bc4f-9b3f5403bcec" />
</RepositoryParams>
<PluginParameters />
</Config>

467 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Configuration Commands
You can use the DB2ConfigTool tool to change specific parameters in the configuration file, located in the
/opt/veeam/VeeamPluginforDB2 directory.

IMP ORTANT

When you work with the command-line tool, use one configuration parameter per command. The tool does
not support commands with multiple parameters.

You can use the following parameters with DB2ConfigTool:

P a rameter Description

--help Shows the list of tool parameters.

--show-config Shows configuration parameters.

Starts the wizard to configure the plug-in settings. This wizard

edits the Veeam Plug-in configuration file
--wizard (veeam_config.xml) or creates a new one if the configuration
file was removed from the /opt/veeam/VeeamPluginforDB2
directory on the machine where Veeam Plug-in is installed.

--set-credentials <"serv\username"> Specifies credentials to log in to the Veeam Backup &

< p assword> Replication server.

Specifies the IP address or hostname of the Veeam Backup &

--set-host <hostname>
Replication server.

Specifies a port number that Veeam Plug-in will use to

--set-port <port_number>
communicate with the Veeam Backup & Replication server.

Launches a wizard to select a backup repository. A backup

--set-repository repository is selected from repositories which are available in
the connected Veeam Backup & Replication server.

Sets Veeam Plug-in to use built-in compression functionality of

--compression
Veeam Backup & Replication.

Sets Veeam Plug-in to limit network bandwidth consumption.

--set-throttling
For details, see Configuring Performance Throttling.

Sets Veeam Plug-in to use logarchmeth1 configuration

--set-logarchmeth
parameter. For details, see this IBM article.

468 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 P a rameter Description

Maps the imported backups. For details, see Importing Backup

--ma p-backup
Files.

Returns a list of backups of your machine which are available in

the connected Veeam Backup & Replication server.
--g et-restore-points To run the DB2ConfigTool command with this parameter, you
must also specify the --time-range parameter with value in the
yyyymm format. For details, see Get Backup Time Stamp.

--set-force-delete Deletes backup files after specified days.

Maps the imported backup copy to a regular Veeam Plug -in

--p romote-backup-copy-to-primary
backup chain.

[For System Copy] Specifies the backup that will be used for
restore operations. You can use this parameter if you want to
restore a database to another server or to restore a database
from a backup copy.

--set-backup-for-restore When you run the DB2ConfigTool command with this

parameter, Veeam Plug-in will prompt you to select an
authentication method to access a backup created for the
original server and then select the backup from which you want
to restore a database. For details, see Restore to Another
Server.

Shows the list of preferred networks set for Veeam Plug -in data
traffic to the remote backup repository.

The list shows set preferred networks in descending order of

--show-preferred-networks priority. If the list is empty, no networks are set as preferred and
Veeam Plug-in routes data traffic to the preferred networks set
in Veeam Backup & Replication. For more information, see
Specifying Preferred Networks for Veeam Plug-ins.

Adds a network to the list of preferred networks for Veeam

Plug-in data traffic to the remote backup repository.
--a dd-preferred-network To select to which network Veeam Plug-in connects first, you
< network_IP_address> <position_in_list> can set the order number of the network in the list. For more
information, see Specifying Preferred Networks for Veeam Plug-
ins.

--remove-preferred-network Removes a specified network from the list of preferred networks

< network_IP_address> for Veeam Plug-in data traffic to the remote backup repository.

469 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Example
To specify credentials that will be used to log in to the Veeam Backup & Replication server, use the plug-in
configuration tool with the following command:

DB2ConfigTool --set-credentials "serv02\Administrator" password

470 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Specifying Preferred Networks for Veeam Plug-
ins
You can specify networks over which Veeam Plug-in must transport data when you perform data protection and
disaster recovery tasks on remote backup repositories. This setting applies only to Veeam Plug -in network
traffic, without affecting the data traffic of other Veeam Backup & Replication components. Setting a dedicated
network for Veeam Plug-in backup and replication operations can help to reduce heavy network loads.

NOTE

Consider the following:

• By default, if there are no specified preferred networks for Veeam Plug -in data traffic, Veeam Plug-
in will connect to preferred networks specified in Veeam Backup & Replication. To learn more about
setting preferred networks in Veeam Backup & Replication, see the Specifying Preferred Networks
section in the Veeam Backup & Replication User Guide.
• Veeam Plug-in does not save information about failed network connections. If backup or restore
operations fail, Veeam Plug-in tries to connect to the following network from the preferred
networks list to finish the started operations. Regardless of the first unsuccessful connection,
Veeam Plug-in will try to perform the next backup operations first on the failed network.
• Veeam Plug-in network preferences take priority over Veeam Backup & Replication network
preferences. Only if the preferred networks for Veeam Plug -in data traffic are not available for any
reason, Veeam Plug-in will try to connect to the Veeam Backup & Replication preferred networks.

To specify networks for data transfer, you must create a list of preferred networks. When Veeam Plug -in needs
to transfer data, it uses networks from this list. If a connection over any of the preferred networks cannot be
established for any reason, Veeam Plug-in will automatically fail over to the following network from the
preferred networks list.

To create and manage the list of preferred networks that Veeam Plug -in will use, you can perform the following
operations:

• Adding Preferred Networks

• Accessing Preferred Networks

• Removing Preferred Networks

Adding Preferred Networks

1. Access the Veeam Plug-in for IBM Db2 directory /opt/veeam/VeeamPluginforDB2 on the server
where Veeam Plug-in is installed.

2. Run the DB2ConfigTool command with the following parameter:

DB2ConfigTool --add-preferred-network <network_IP_address> <position_in_li

st>

where:

o <network_IP_address> can be either the IP address of a single network or a network mask that
contains a range of network IP addresses. Specify one of the available options to add as preferred
networks for Veeam Plug-in data traffic.

471 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 o <position_in_list> is the position number of the network in the preferred networks list. The
position in the list determines in what order Veeam Plug -in will connect to the specified network. If
you do not chose a specific position in the list, newly added networks take the last place in the list
automatically.

For example:

DB2ConfigTool --add-preferred-network 172.24.29.189 2

Accessing Preferred Networks

1. Access the Veeam Plug-in for IBM Db2 directory /opt/veeam/VeeamPluginforDB2 on the server
where Veeam Plug-in is installed.

2. Run DB2ConfigTool with the following parameter:

DB2ConfigTool --show-preferred-networks

The following example shows what the output of the DB2ConfigTool command with the --show-preferred-
networks parameter can look like:

DB2ConfigTool --show-preferred-networks
Preferred networks:
1. 172.24.29.156
2. 172.24.26.189

Removing Preferred Networks

1. Access the Veeam Plug-in for IBM Db2 directory /opt/veeam/VeeamPluginforDB2 on the server
where Veeam Plug-in is installed.

2. Run DB2ConfigTool with the following parameter:

DB2ConfigTool --remove-preferred-network <network_IP_address>

where <network_IP_address> can be either the IP address of a single network or a network mask that
contains a range of network IP addresses. Specify one of the available options to remove from the
preferred networks list.

For example:

DB2ConfigTool --remove-preferred-network 172.24.29.189

472 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Configuring Performance Throttling
You can limit computer processing (CPU) resources assigned for Veeam Plug -in backup jobs. This setting allows
you to reduce the impact of backup operations on the target computer performance. Performance throttling
prevents Veeam Plug-ins from utilizing all computer resources to ensure that enough resources are provided for
other operations. This maybe useful in case you detected that your source database responses are slower during
backup operations.

If you throttle performance, Veeam Backup & Replication starts Veeam Plug -in backup operation processes with
low priority and nice value of 19. The nice values are in ascending order of priority ranging from -20 (the highest
priority) to 19 (the lowest priority). Keep in mind that Veeam Plug-ins manage the priority of backup operation
processes only if the system running on the target computer is busy with other tasks.

NOTE
• By default, Veeam Plug-in does not throttle performance.
• Performance throttling does not apply to restore operations.

To throttle Veeam Plug-in performance, do the following:

1. Log into the machine with a user with root or instance owner privileges.

2. Start the Veeam Plug-in configuration wizard with the following parameter:

/opt/veeam/VeeamPluginforDB2/DB2ConfigTool --set-throttling

3. To confirm that you want Veeam Plug-in throttle performance, type y .

All backup activities will be throttled if the system is busy. Backup perf
ormance may be affected. Proceed? (y/N): y

473 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Upgrading Veeam Plug-in for IBM Db2
Periodically, Veeam releases a new version of Veeam Backup & Replication that contains new features and bug
fixes. The release package also contains a new version of Veeam Plug -ins.

If you want to upgrade Veeam Plug-in, note that Veeam Backup & Replication must be the same or later than
the version of Veeam Plug-in. If you want to use the latest functionality, you must upgrade both Veeam Backup
& Replication and Veeam Plug-in to the latest version. After the upgrade, you don't need to re-run the Veeam
Plug-in configuration wizard, the plug-in configuration files will be preserved.

IMP ORTANT

Consider the following:

• You must upgrade Veeam Backup & Replication before you upgrade Veeam Plug -ins. To learn how to
upgrade Veeam Backup & Replication, see the Upgrading to Veeam Backup & Replication 12.3 section
in the Veeam Backup & Replication User Guide.

• Veeam Backup & Replication supports two latest versions of Veeam Plug -ins. For example, Veeam
Backup & Replication 12.3 supports Veeam Plug-in 12.3 and 12.2.

Keep in mind that if you use an earlier Veeam Plug-in build than the one that is included in the
installation ISO file of your Veeam Backup & Replication version, it may not have all the features and
bug fixes introduced in your Veeam Backup & Replication version. To learn more about the Veeam
Plug-in builds included in Veeam Backup & Replication installation ISO files, see this Veeam KB
article.
• Operations in the terminal of the machine with the database require root privileges .

Before You Begin

Veeam Plug-in installation files are included in the installation disk image of Veeam Backup & Replication. You
must upload the installation file to the Oracle Database server. To do this, perform the following steps:

1. Mount the Veeam Backup & Replication installation disk

(VeeamBackup&Replication_12.3.0.310_20241201.iso).

2. Open the mounted disk image and go one of the Plugins\IBM Db2 folder.

3. Select the Veeam Plug-in installation file suitable for your OS and upload it to the machine with IBM Db2.

The upgrade procedure depends on the type of package and OS that you use:

• Upgrading Plug-in on Linux (.RPM)

• Upgrading Plug-in on Linux (.DEB)

• Upgrading Plug-in on Linux (.TAR.GZ)

• Upgrading Plug-in on IBM AIX

Upgrading Plug-in on Linux (.RPM)

To upgrade Veeam Plug-in for IBM Db2 on a Linux machine, do the following:

1. Upload the VeeamPluginforDB2-12.3.0.310-1.x86_64.rpm package to the machine with IBM Db2.

474 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 2. To upgrade Veeam Plug-in, run the following command. Note that the operation requires root privileges.

rpm -U VeeamPluginforDB2-12.3.0.310-1.x86_64.rpm

TIP

To find out which version of Veeam Plug-in is installed on your server, you can use the following command:
rpm -qa | grep VeeamPlugin

Upgrading Plug-in on Linux (.DEB)

To upgrade Veeam Plug-in for IBM Db2 on a Linux machine, do the following:

1. Upload the VeeamPluginforDB2-12.3.0.310-1_amd64.deb package to the machine with IBM Db2.

2. To upgrade Veeam Plug-in, run the following command. Note that the operation requires root privileges.

apt-get install VeeamPluginforDB2-12.3.0.310-1_amd64.deb

Upgrading Plug-in on Linux (.TAR.GZ)

To upgrade Veeam Plug-in for IBM Db2 on a Linux machine from the archive, do the following:

1. Upload the VeeamPluginforDB2.tar.gz file to the Oracle server.

2. Unpack the plug-in files from the archive to the /opt/veeam directory. Old Veeam Plug-in files will be
replaced by new files.

tar -xzvf VeeamPluginforDB2.tar.gz -C /opt/veeam

Upgrading Plug-in on IBM AIX

To upgrade Veeam Plug-in for IBM Db2 on an IBM AIX machine, do the following:

1. Upload the VeeamPluginforDB2-12.3.0.310-1.aix6.1.ppc.rpm package to the Oracle server.

2. To upgrade Veeam Plug-in, run the following command. Note that the operation requires root privileges.

rpm -U VeeamPluginforDB2-12.3.0.310-1.aix6.1.ppc.rpm

475 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Exporting and Importing Plug-in Settings
You can export a Veeam Plug-in configuration file and apply the plug-in settings to other servers.

IMP ORTANT

The password included in the configuration file is encrypted. Thus, after you import the configuration file,
you must set the credentials manually in the Veeam Plug -in configuration wizard or using DB2ConfigTool.

To export the configuration file to another server, do the following:

1. On the server where Veeam Plug-in is installed, navigate to the /opt/veeam/VeeamPluginforDB2

directory.

2. Copy the veeam_config.xml file to the server where you want to configure the plug -in.

3. Install Veeam Plug-in on the new server and place the copied XML file in the
/opt/veeam/VeeamPluginforDB2 directory.

4. Set new credentials to connect to the Veeam Backup & Replication server using the following command:

DB2ConfigTool --set-credentials "serv02\Administrator" password

476 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Importing Backup Files
If the Veeam Backup & Replication server has failed and you have restored it in a new location, you can copy the
backup files to a new repository and re-map the Veeam Plug-in backup files.

Limitations and Prerequisites

Consider the following limitations:

• If backup files are not imported according to instructions given in this section, Veeam Plug -in backup and
restore operations may fail.

• The repository from which you plan to import backups must be added to the Veeam Backup & Replication
infrastructure. Otherwise you will not be able to access backup files.

• [For backups of scale-out clusters and servers with the customServerName option] To avoid mapping
failure, the cluster name must be the same as the name used before importing backups.

• [For imports to the scale-out backup repository] Before importing your backup, consider that the names
of all backup files (.VAB, .VASM, .VACM) and paths to these files contain only the following allowed
characters:

o a-zA-Z0-9

o _-.+=@^

If your backup was initially created on a standalone backup server, the default name of the backup
metadata file (.VACM) contains forbidden characters. Before importing, you must delete forbidden
characters from the file name or replace them with the allowed characters.

How to Import Veeam Plug-in Backup Files

To import Veeam Plug-in backup files, do the following:

1. Copy the backup file folder to a backup repository or add a new backup repository with this folder as a
subfolder.

IMP ORTANT

Make sure that you import backup files and all related metadata files.

Keep in mind that each Veeam Plug-in backup file (.VAB) has its own metadata file (.VASM). Also,
you must import the backup job metadata file (.VACM) that is stored in the same folder.

2. Log in to the Veeam Backup & Replication console.

3. Open the Ba ckup Infrastructure view.

4. In the inventory pane of the Ba ckup Infrastructure view, select the Ba ckup Repositories node.

477 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 5. In the working area, select the required backup repository and click Rescan on the ribbon. Alternatively,
you can right-click the backup repository and select Rescan.

During the rescan operation, Veeam Backup & Replication gathers information about backups that are
currently available in the backup repository and up dates the list of backups in the configuration database.
After the rescan operation, backups that were not in this configuration database will be shown on the
Home view in the Ba ckups > Disk (Imported) node.

6. On the IBM Db2 server, set the new repository as a target in the Veeam Plug-in settings:

DB2ConfigTool --set-repositories
Available backup repositories:
1. serv55.tech.local
2. serv07_repo
Enter repository number: 1

7. Start the Veeam Plug-in configuration wizard with the following parameter:

NOTE

Before you re-map your backup to the repository, make sure that there is not an existing backup job
on your machine with Veeam Plug-in that is targeted at the same repository. If there is such a job,
delete this job from the Veeam Backup & Replication console.

DB2ConfigTool --map-backup

478 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Uninstalling Plug-in
Installation scenario depends on the OS you work with:

• Uninstalling Veeam Plug-in on Linux machines.

• Unistalling Veeam Plug-in on IBM AIX machines.

Uninstalling Veeam Plug-in on Linux Machines

On a Linux machine, go to the directory with the Veeam Plug -in package and run the following command. Note
that the operation requires root privileges.

For CentOS / RHEL / Oracle Linux

rpm -e VeeamPluginforDB2

For SLES

zypper rm VeeamPluginforDB2

For Ubuntu

apt-get remove VeeamPluginforDB2

Uninstalling Veeam Plug-in on IBM AIX Machines

To uninstall Veeam Plug-in and undo the configuration changes, run the following command. Note that the
operation requires root privileges.

rpm -e VeeamPluginforDB2

479 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Performing Backup
After you configure Veeam Plug-in settings, you can use Veeam Plug-in to back up IBM Db2 databases.

Veeam Plug-in backs up IBM Db2 databases according to backup settings that you specify. You can specify what
databases to back up, the type of database backups you want to create, and processing set tings for backed-up
data.

480 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Considerations and Limitations
Before you back up IBM Db2 databases, consider the following prerequisites:

• If you reconfigured the logarchmeth1 parameter, IBM Db2 switches the database into the
BACKUP_PENDING state. To resolve this, you must perform a full offline backup of database. After offline
backup is created, you can delete the backup file and back up database online.

• If you plan to back up databases with the HADR replication, make sure that HADR is set up and initialized
for all databases you want to protect. For details, see this IBM article.

• Backups created by Veeam Plug-ins cannot be used as a source for file to tape or backup to tape jobs.

481 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Preparing Database
Before you create a backup of the database, make sure that the database is configured properly. You must re -
configure the database if you plan to perform the following operations:

• Create incremental backups.

• Delete backups using IBM Db2 built-in tools.

• Compress archive log backups.

Preparation for Incremental Backups

If you plan to create incremental backups later, set the trackmod parameter with the following command:

db2 update database cfg for <database_name> using trackmod YES

where <database_name> is a name of the database you want to back up.

If you do not set the trackmod parameter and create a full backup, you will not be able to create incremental
backups for this full backup.

Preparation for Backup Pruning

If you plan to delete backups using the PRUNE HISTORY command later, set the AUTO_DEL_REC_OBJ parameter
with the following command:

db2 update database cfg for <database_name> using AUTO_DEL_REC_OBJ ON

where <database_name> is a name of the database you plan to back up.

If you do not set the AUTO_DEL_REC_OBJ parameter and create backups, you will not be able to delete these
backups using the PRUNE HISTORY command.

Compression of Archive Log Backups

IBM Db2 supports compression of archive log backups. By default, the compression is disabled. You can enable
the compression for the database with the following command:

db2 update database cfg for <database_name> using logarchcompr1 ON

where <database_name> is a name of the database you want to back up.

Alternatively, you can set IBM Db2 to use hardware-accelerated compression. To do this, run the following
command:

db2 update database cfg for <database_name> using logarchcompr1 ZLIB

where <database_name> is a name of the database you want to back up.

482 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Performing Full Backup
IBM Db2 supports the following types of full backups:

• Offline backup

• Online backup

Offline Backup
To back up database offline, do the following steps:

1. Offline backup requires downtime. During the downtime, the database is offline and inaccessible to
applications. To prepare the database, do the following steps:

a. Find all the applications with existing connections to IBM Db2.

db2 list applications

This command returns a list of all existing connections. To stop these connections, you can close the
applications manually or you can disconnect all connections to all IBM Db2 databases with the
following command:

db2 force application all

b. Deactivate the database you want to back up offline with the following commands:

db2 deactivate database <database_name>

where <database_name> is a name of the database you want to deactivate.

2. Back up the database offline with the following command:

db2 backup database <database_name> load /opt/veeam/VeeamPluginforDB2/libD

B2Plugin.so

where <database_name> is a name of the database you want to back up.

3. Re-activate the database.

db2 activate database <database_name>

where <database_name> is a name of the database you want to deactivate.

483 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Online Backup
To back up database online, do the following steps:

1. Before you back up database online, check if you set Veeam Plug -in to use the logarchmeth1 parameter.

If you have not configured the logarchmeth1 parameter during the Veeam Plug-in configuration, you can
configure the parameter using DB2ConfigTool:

DB2ConfigTool --set-logarchmeth yes

Alternatively, you can re-configure the database with the following command:

db2 update database cfg for <database_name> using logarchmeth1 VENDOR:</op

t/veeam/VeeamPluginforDB2/libDB2Plugin.so>

where <database_name> is a name of the database you want to back up.

2. Back up the database online with the following command:

db2 backup database <database_name> online load /opt/veeam/VeeamPluginforD

B2/libDB2Plugin.so

where <database_name> is a name of the database you want to back up.

If you want to include logs in the backup, you can use the INCLUDE LOGS option with the BACKUP DATABASE
command:

db2 backup database <database_name> online load /opt/veeam/VeeamPluginforDB2/li

bDB2Plugin.so include logs

where <database_name> is a name of the database you want to back up.

To learn more about the INCLUDE LOGS option, see this IBM article.

484 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Performing Incremental Backup
After you created a full backup of the database, you can create the following types of incremental backups :

• An incremental backup. The incremental backup contains all database data that has changed since the last
successful full backup.

• An incremental delta (or delta ) backup. The delta backup contains all database data that has changed
since the last successful full, incremental, or delta backup.

IMP ORTANT

To create incremental and delta backups, you must set the trackmod parameter before you create a full
backup. For details, see Preparing Database.

You can create both incremental and delta backups offline and online. For details, see the following
subsections:

• Offline backup

• Online backup

Offline Backup
To back up database offline, do the following steps:

1. Offline backup requires downtime. During the downtime, the database is offline and inaccessible to
applications. To prepare the database, do the following steps:

a. Find all the applications with existing connections to IBM Db2.

db2 list applications

This command returns a list of all existing connections. To stop these connections, you can close the
applications manually or you can disconnect all connections to all IBM Db2 databases with the
following command:

db2 force application all

b. Deactivate the database you want to back up offline with the following commands:

db2 deactivate database <database_name>

where <database_name> is a name of the database you want to deactivate.

2. Depending on the type of the backup you want to create, back up the database offline with one of the
following commands:

o To create an incremental backup, use the following command:

db2 backup database <database_name> incremental load /opt/veeam/VeeamPl

uginforDB2/libDB2Plugin.so

485 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 where <database_name> is a name of the database you want to back up.

o To create a delta backup, use the following command:

db2 backup database <database_name> incremental delta load /opt/veeam/V

eeamPluginforDB2/libDB2Plugin.so

where <database_name> is a name of the database you want to back up.

3. Re-activate the database.

db2 activate database <database_name>

where <database_name> is a name of the database you want to deactivate.

Online Backup
Depending on the type of the backup you want to create, back up the database online with one of the following
commands:

• To create an incremental backup, use the following command:

db2 backup database <database_name> online incremental load /opt/veeam/Vee

amPluginforDB2/libDB2Plugin.so

where <database_name> is a name of the database you want to back up.

• To create a delta backup, use the following command:

db2 backup database <database_name> online incremental delta load /opt/vee

am/VeeamPluginforDB2/libDB2Plugin.so

where <database_name> is a name of the database you want to back up.

If you want to include logs in the backup, you can use the INCLUDE LOGS option with the BACKUP DATABASE
command:

db2 backup database <database_name> online load /opt/veeam/VeeamPluginforDB2/li

bDB2Plugin.so include logs

where <database_name> is a name of the database you want to back up.

To learn more about the INCLUDE LOGS option, see this IBM article.

486 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Managing Backup Jobs in Veeam Backup &
Replication
After Veeam Plug-in for IBM Db2 starts the backup process, Veeam Backup & Replication creates the backup job.
You can use this job to view statistics on the backup process and generate backup job reports. You can also
disable or delete the backup job.

You cannot start or edit Veeam Plug-in backup jobs in the Veeam Backup & Replication console. You can manage
backup operations on the machine with Veeam Plug-in only.

Consider the following:

• Veeam Backup & Replication creates one backup job for a machine with Veeam Plug -in for IBM Db2. All
backup sessions for different databases that reside on this machine run within this backup job.

• Veeam Backup & Replication generates names for IBM Db2 backup jobs according to the names of the
machine with Veeam Plug-in.

You can perform the following operations from the Veeam Backup & Replication console:

• View backup job statistics

• Generate a backup job report

• Disable a backup job

• Delete a backup job

Viewing Backup Job Statistics

To view details of the backup process, do the following:

1. Open the Veeam Backup & Replication console.

2. In the Home view, expand the Job s node in the inventory pane and click Ap p lications Plug-ins.

487 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 3. In the working area, select the Veeam Plug-in backup job to see details of the current backup process or
the last backup job session.

Generating Backup Job Reports

Veeam Backup & Replication can generate reports with details about Veeam Plug -in backup job session
performance. The session report contains the following session statistics: session duration details, details of the
session performance, amount of read, processed and transferred data, backup size, compression ratio, list of
warnings and errors (if any).

To generate a report, do the following:

1. Open the Veeam Backup & Replication console.

2. In the Home view, expand the Job s node in the inventory pane and click Ap p lications Plug-ins.

488 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 3. In the working area, select the necessary job and click Rep ort on the ribbon. You can also right-click the
job and select Rep ort.

Disabling Backup Job

You can disable Veeam Plug-in backup jobs in the Veeam Backup & Replication console. If you disable the job,
you will not be able to run Veeam Plug-in backup commands on the machine with Veeam Plug-in.

To disable a backup job, do the following:

1. Open the Veeam Backup & Replication console.

2. In the Home view, expand the Job s node in the inventory pane and click Ap p lications Plug-ins.

489 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 3. In the working area, select the necessary job and click Disable on the ribbon. You can also right-click the
job and select Disable.

Deleting Backup Job

You can delete Veeam Plug-in backup jobs in the Veeam Backup & Replication console. When you delete a job,
Veeam Backup & Replication removes all records about the job from its database and console. Veeam Plug -in
backups created by this job remain intact on the backup repository. In the Veeam Backup & Replication console,
such backups are displayed in the Home view, under the Ba ckups > Disk (Orphaned) node in the inventory pane.
In case of capacity tier, such backups are displayed under the Ba ckups > Ca pacity Tier ( Orphaned) node in the
inventory pane.

Note that if the user starts a new backup job session from the machine with Veeam Plug -in, the job will appear
in the Veeam Backup & Replication console again, and records about a new job session will be stored in the
Veeam Backup & Replication database.

To delete a backup job, do the following:

1. Open the Veeam Backup & Replication console.

2. In the Home view, expand the Job s node in the inventory pane and click Ap p lications Plug-ins.

490 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 3. In the working area, select the necessary job and click Delete on the ribbon. You can also right-click the
job and select Delete.

491 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Managing Backups in Veeam Backup &
Replication
In the Veeam Backup & Replication console, backups created by Veeam Plug -ins are displayed in the Ba ck ups >
Disk node of the Home view. In the working area, backups created by Veeam Plug -in for IBM Db2 are listed
under the IBM Db2 node.

You can use the Veeam Backup & Replication console to perform the following operations with Veea m Plug-in
backups:

• Create a recovery token for a backup

• Repair a backup

• Remove a backup from configuration

• Delete a backup from the backup repository

Creating Recovery Token

If you want to recover database data from a specific backup, you can use the Create recovery token operation.

You can generate the recovery token on the Veeam Backup & Replication side. Then, on the computer si de, with
this recovery token get access to the backup and recover data that are stored in the backup.

Limitations
Before creating a recovery token, consider the following prerequisites and limitations:

• Recovery tokens stay valid for 24 hours.

• You can recover data only from the backup for that the recovery token is generated.

• During recovery, Veeam Backup & Replication does not stop backup operations.

• You cannot create a recovery token for a whole backup copy job, but you can create a recov ery token for
individual objects included in a backup copy job.

Generating Recovery Token

To create a recovery token on the Veeam Backup & Replication side:

1. Open the Home view.

2. In the inventory pane, click Ba ck ups.

3. In the working area, right-click the backup and select Create recovery token.

You can create a recovery token for several backups. To do this, press and hold [Ctrl], select multiple
backups, right-click one of the selected backups and select Create recovery token.

4. In the Create Recovery Token window, click Create.

You can also create and modify the existing recovery token using the PowerShell console. To learn more, see the
Working with Tokens section in the Veeam PowerShell Reference.

492 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 TIP

Alternatively, you can get access to the backup using user credentials.

Repairing Backup
If you want to restore data from an immutable backup that resides in a hardened repository, you can use the
Rep air operation. During this operation, Veeam Backup & Replication will generate a new backup job metadata
.VACM file using information from the backup metadata .VASM files.

IMP ORTANT

This operation is intended only for a situation where the backup job metadata file has been lost as a result
of malware activity or unplanned actions. Re-creation of the backup job metadata file for other purposes is
not supported. To learn more about restore from the hardened repository, see Restore from Hardened
Repository.

Before you start the repair operation, you must disable the backup job that created the backup. Otherwise,
Veeam Backup & Replication will display a message notifying that the job must be disabled. For details, see
Disabling Backup Job.

To repair a backup:

1. In the Veeam Backup & Replication console, open the Home view.

2. In the inventory pane, select Ba ckups.

3. In the working area, select the necessary backup.

493 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 4. Press and hold the [Ctrl] key, right-click the backup and select Rep air.

Removing Backup from Configuration

If you want to remove records about backups from the Veeam Backup & Replication console and configuration
database, you can use the Remove from configuration operation. When you remove a backup from
configuration, backup files (.VAB, .VASM, .VACM) remain in the backup repository. You can import the backup
later and restore data from it.

To remove a backup from configuration:

1. Open the Home view.

2. In the inventory pane, select Ba ckups.

3. In the working area, select the necessary backup.

494 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 4. Press and hold the [Ctrl] key, right-click the backup and select Remove from configuration.

Deleting Backup
You can use the Veeam Backup & Replication console to delete backups created with Veeam Plug -in from a
Veeam backup repository.

To delete a backup, do the following:

1. In the Veeam Backup & Replication console, open the Home view.

2. In the inventory pane, select Ba ckups.

495 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 3. In the working area, right-click the name of the backed-up object and select Delete from disk.

496 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Performing Restore
With the configured Veeam Plug-in you can restore IBM Db2 databases from the backups that reside in the
Veeam backup repository. All restore operations are performed on the Veeam Plug -in side.

497 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Get Backup Time Stamp
To restore IBM Db2 databases from a backup, you need a backup time stamp. IBM Db2 generates a time stamp
for each backup in the yyyymmddhhmmss format. Using this timestamp, Veeam Plug-in restores the database
from the backup file created at the certain time.

To get backup details, run the -get-restore-points command:

/opt/veeam/VeeamPluginforDB2/DB2ConfigTool --get-restore-points --time-range <t

ime_period> database <database_name> --json > <timestamps.json>

where:

• <time_period> is a time period when the backup you need was created. You must specify this value in a
time stamp format. For details, see Command Parameters.

• <database_name> is a name of a database whose backups you need.

• <timestamps.json> is a name of a .JSON file with the command output.

If the command run is successful, Veeam Plug-in provides the following details of your machine backups that
are available in the connected backup repository:

• Database instance name

• Database name

• Partition number

• Time stamp

• Backup type. Possible values:

o Full

o Incremental

o Delta

Command Parameters
You can specify the following parameters for the --get-restore-points command:

P a rameter Description

--help Shows the list of parameters for the --get-restore-points

command.

498 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 P a rameter Description

--time-range Defines the time period when the backup was created. Veeam
Plug-in will return the list of backups created within the
specified period.

Using the --time-range parameter, you can select the level of

details for a time stamp from yyyymm to yyyymmddhhmmss .
For example, if you use following time stamp, Veeam Plug -in
will return the list of backups created within a certain hour:
2024052417 .

--d a tabase This parameter is optional. Defines the name of the backed-up
database. Veeam Plug-in will return the list of backups only of
the specified database.

--json This parameter is optional. If you use this parameter, Veeam

Plug-in create a .JSON file in your current directory and collect
the command output in this file.

499 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Restore to Original Server
You can restore IBM Db2 databases from backups stored on Veeam backup repositories in the following ways:

• Restore from a full backup.

• Restore from an incremental backup.

• Restoring to the previous state.

Restore from Full Backup

To restore a IBM Db2 database from a full backup, use the following command:

db2 restore db <database_name> load /opt/veeam/VeeamPluginforDB2/libDB2Plugin.s

o taken at <timestamp>

where:

• <database_name> is a name of the database you want to restore.

• <timestamp> is a time stamp that IBM Db2 generates for each backup in the yyyymmddhhmmss format.
Veeam Plug-in will restore database from the backup file created at the time that you specify in the
command.

To learn how to get time stamp, see Get Backup Time Stamp.

Restore from Incremental Backup

To restore a IBM Db2 database from a full backup, use the following command:

db2 restore db <database_name> incremental automatic load /opt/veeam/VeeamPlugi

nforDB2/libDB2Plugin.so taken at <timestamp>

where:

• <database_name> is a name of the database you want to restore.

• <timestamp> is a time stamp that IBM Db2 generates for each backup in the yyyymmddhhmmss format.
Veeam Plug-in will restore database from the backup file created at the time that you specify in the
command.

To learn how to get time stamp, see Get Backup Time Stamp.

Restore to Previous State

You can restore the database to the previous states. In this case, you restore database from a backup, then apply
archive logs that are available in the backup file. With these archive logs, you can restore database to the exact
state when the backup was created.

500 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 IMP ORTANT

To restore database to the previous state, you must use a full online backup of the database. To learn
more, see Performing Full Backup.

To restore database to the previous state, do the following steps:

1. Restore to the previous state requires downtime. Terminate all existing connections and deactivate the
database with the following commands:

db2 terminate
db2 deactivate database <database_name>

where <database_name> is a name of the database you want to deactivate.

2. Extract archive logs from the backup file with the following command:

db2 restore database <database_name> logs load /opt/veeam/VeeamPluginforDB

2/libDB2Plugin.so LOGTARGET <path_to_logs>

where:

o <database_name> is a name of the database you want to deactivate.

o <path_to_logs> is a path to the directory to which Veeam Plug-in will extract archive logs.

3. Return the database to the state recorded in a backup with the following command:

db2 restore database <database_name> load /opt/veeam/VeeamPluginforDB2/lib

DB2Plugin.so taken at <timestamp> replace existing

where:

o <database_name> is a name of the database you want to restore.

o <timestamp> is a time stamp that IBM Db2 generates for each backup in the yyyymmddhhmmss
format. Veeam Plug-in will restore database from the backup file created at the time that you specify
in the command.

To learn how to get time stamp, see Get Backup Time Stamp.

4. Apply archive logs to return database to the exact state when the backup was created with the following
command:

db2 rollforward database <database_name> to end of logs overflow log path

(<path_to_logs>)

where:

o <database_name> is a name of the database you want to deactivate.

o <path_to_logs> is a path to the directory to which Veeam Plug-in will extract archive logs.

501 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 5. Recover the database with the following command:

db2 recover database <database_name>

where <database_name> is a name of the database you want to deactivate.

6. Re-activate the database with the following command:

db2 activate database <database_name>

where <database_name> is a name of the database you want to deactivate.

502 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Restore to Another Server
You can restore IBM Db2 databases from Veeam Plug-in backups to another server. To restore databases to
another server, you must specify an authentication method to access the backup created for the original server
and then select the backup from which you want to restore a database.

Consider the following:

• For restore to another server, you can use backups or backup copies of IBM Db2 databases.

• If you perform restore from a backup that was imported to Veeam Backup & Replication, Veeam Plug -in
will automatically create the backup job in Veeam Backup & Replication, because the backup job is
required for database restore from Veeam Plug -in backups.

• During the restore process, backup operations are not disabled on the IBM Db2 machine.

Veeam Plug-in supports the following authentication methods to access backups:

• Using credentials of the account under which the backup was created. For details, see Restore to Another
Server Using Configured Authentication.

• Using a security certificate. This option is intended for backups created using an application backup policy
configured in Veeam Backup & Replication. For details, see Restore to Another Server Using Credentials.

• Using a recovery token. This option is intended for backups created using an application backup policy
configured in Veeam Backup & Replication. To use this option, a backup administrator must create a
recovery token for the backup in Veeam Backup & Replication. For details, see Restore to Another Server
Using Recovery Token.

You can also perform a redirected restore if you need to restore to a instance with a name that is different from
the backed-up instance. For details, see Restore to Instance with Different Name.

Restore to Another Server Using Configured Authentication

You can restore a database to another server using an account and authentication method that were specified in
the Veeam Plug-in settings during the Veeam Plug-in configuring process.

To restore database, do the following steps:

1. Start the restore operation with the following command:

/opt/veeam/VeeamPluginforDB2/DB2ConfigTool --set-backup-for-restore

2. Veeam Plug-in will prompt you to select an authentication method to access the backup. To access the
backup using the authentication method that was specified during the Veeam Plug -in configuration
process, type 1:

Select authentication type or disable the functionality:

0. To disable the functionality
1. Currently set authentication data
2. Credentials
3. Recovery token
Enter authentication type number: 1

503 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 3. Veeam Plug-in will display backups available for restore under the user account specified in the Veeam
Plug-in configuration. For the user account with a security certificate, Veeam Plug -in displays backups
created under this user account.

Select a backup to start the restore process:

Select backup to be used:

1. Backup1
2. Backup2
3. Backup3
Enter backup number: 3
The selected backup [Backup3] will be used for all restore operations.

4. Depending on the name of the target instance, perform one of the following operations:

o If you restore to another instance with the same name as the backed -up instance, continue the restore
operation in the same way you restore to the original server. For details, see Restore to Original
Server.

o If you plan to restore to another instance with a name that is different from the backed -up instance,
see Restore to Instance with Different Name.

Restore to Another Server Using Credentials

To restore a database to another server, you can specify credentials of a user account under which the backup
was created.

To restore database, do the following steps:

1. Start the restore operation with the following command:

/opt/veeam/VeeamPluginforDB2/DB2ConfigTool --set-backup-for-restore

2. Veeam Plug-in will prompt you to select an authentication method to access the backup. To access the
backup using credentials of the account under which the backup was created, type 2:

Select authentication type or disable the functionality:

0. To disable the functionality
1. Currently set authentication data
2. Credentials
3. Recovery token
Enter authentication type number: 2

3. Veeam Plug-in will prompt you to provide credentials of the user account that under which the backup
was created. Enter a user name and password of the account:

Enter username:
Enter password for <username>:

504 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 4. Depending on the name of the target instane, perform one of the following operations:

o If you restore to to another instance with the same name as the backed -up instance, continue the
restore operation in the same way you restore to the original server. For details, see Restore to
Original Server.

o If you plan to restore to another instance with a name that is different from the backed -up instance,
see Restore to Instance with Different Name.

Restore to Another Server Using Recovery Token

You can restore a database to another server using a recovery token generated in Veeam Backup & Replication
and provided to you by a backup administrator.

To restore database, do the following steps:

1. Start the restore operation with the following command:

/opt/veeam/VeeamPluginforDB2/DB2ConfigTool --set-backup-for-restore

2. Veeam Plug-in will prompt you to select an authentication method to access the backup. To access the
backup using a recovery token, type 3:

Select authentication type or disable the functionality:

0. To disable the functionality
1. Currently set authentication data
2. Credentials
3. Recovery token
Enter authentication type number: 3

3. Veeam Plug-in will display the fingerprint of the Veeam Backup & Replication server and prompt you to
provide a recovery token:

Veeam Backup & Replication server fingerprint: CA4F820F164C02A9AAC75562FC3

5330A93CDAA3C.
Continue? (y/n) : y
Enter recovery token:

4. Veeam Plug-in will display backups for which the recovery token was generated. Select the necessary
backup:

Select backup to be used:

1. Backup1
2. Backup2
3. Backup3
Enter backup number: 3
The selected backup [Backup3] will be used for all restore operations.

505 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 4. Depending on the name of the target instance, perform one of the following operations:

o If you restore to to another instance with the same name as the backed-up instance, continue the
restore operation in the same way you restore to the original server. For details, see Restore to
Original Server.

o If you plan to restore to another instance with a name that is different from the backed -up instance,
see Restore to Instance with Different Name.

Restore to Instance with Different Name

If you plan to restore to a instance with a name that is different from the backed -up instance, see you must
perform a redirected restore. To learn more, see this IBM article.

For example, you can use the SET STOGROUP PATHS command. With this command, you can set storage group
paths for the database you want to restore. If you selected this approach, do the following steps:

1. Run the RESTORE command with the REDIRECT parameter:

db2 restore database <database_name> load /opt/veeam/VeeamPluginforDB2/lib

DB2Plugin.so taken at <timestamp> REDIRECT

where:

o <database_name> is a name of the database you want to restore.

o <timestamp> is a time stamp that IBM Db2 generates for each backup in the yyyymmddhhmmss
format. Veeam Plug-in will restore database from the backup file created at the time that you specify
in the command.

2. Set storage group paths for the database with the following command:

db2 set stogroup paths for IBMSTOGROUP on '/home/<instance_name>'

where: <instance_name> is a name of the target instance to which you want to restore your database.

3. Run the RESTORE command again with the CONTINUE parameter:

db2 restore database <database_name> continue

where <database_name> is a name of the database you want to restore.

After that, your database with be restored and re-configured to comply with the name of the target instance.

506 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Restore from Backup Copy
You can restore IBM Db2 databases from backup copies of backups created with Veeam Plug -in for IBM Db2. The
procedure of database restore from a backup copy is the same as database restore to another server. For more
information, see Restore to Another Server.

507 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Restore from Hardened Repository
As a result of malware activity or unplanned actions, backup job metadata (.VACM) files may become
unavailable in the hardened repository. In this case, to restore data from the hardened r epository, you must re-
create the .VACM file. To do this, complete the following steps:

1. Run a Veeam Plug-in backup job to create a new Veeam Plug-in backup in a Veeam backup repository. The
backup will consist of the .VAB, .VASM and .VACM files.

2. In the backup repository folder, replace the .VAB and .VASM files created at the step 1 with the .VAB and
.VASM files from the hardened repository.

3. In the Veeam Backup & Replication console, run the backup repair operation. Veeam Backup & Replication
will generate a new .VACM file using information from the .VASM files. For details, see Repairing Backup.

Once the backup job metadata file is re-created, you can use Veeam Plug-in to restore your data.

Repairing Backup
Before you start the repair operation, you must disable the backup job that created the backup. Otherwise,
Veeam Backup & Replication will display a message notifying that the job must be disabled. For details, see
Disabling Backup Job.

To repair a backup:

4. In the Veeam Backup & Replication console, open the Home view.

5. In the inventory pane, select Ba ckups.

6. In the working area, select the necessary backup.

7. Press and hold the [Ctrl] key, right-click the backup and select Rep air.

508 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Retention of IBM Db2 Backups
In the main scenario, when using Veeam Plug-in for IBM Db2, you must configure the retention policy using
native IBM Db2 tools. For details, see Deleting Backups Using IBM Db2 Tools.

Alternatively, you can manually delete backups from a backup repository using the Veeam Backup & Replication
console and enable the force deletion functionality of Veeam Plug -in. For details, see the following sections:

• Deleting Backups Manually Using Veeam Backup & Replication Console

• Configuring Force Deletion of Backups

509 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Deleting Backups Using IBM Db2 Tools
To delete backups, you can use the IBM Db2 built-in option: the PRUNE HISTORY command. To learn more
about the command, see this IBM article.

IMP ORTANT

To delete backups using the PRUNE HISTORY command, you must set the AUTO_DEL_REC_OBJ parameter
before you create backups. For details, see Preparing Database.

To delete backup files and log archives from the backup repository, use the following command:

db2 prune history <timestamp> and delete

where <timestamp> is a time stamp that IBM Db2 generates for each backup in the yyyymmddhhmmss format.

With this command, Veeam Plug-in will delete all backup files up to the time that you specified in the command.
Thus, Veeam Plug-in will not delete the backup with the time stamp that you specified. Also, the PRUNE
HISTORY command will not delete to the most recent full backup and associated objects. For example,
incremental and log backups.

If you want to delete the most recent full backup and associated objects, use the WITH FORCE OPTION option
with the PRUNE HISTORY command:

db2 prune history <timestamp> with force option and delete

where <timestamp> is a time stamp that IBM Db2 generates for each backup in the yyyymmddhhmmss format.

With this command, Veeam Plug-in will delete all backup files up to the time and equal the time that you
specified in the command. Thus, Veeam Plug-in will also delete the backup with the time stamp that you
specified from the backup repository. Veeam Plug-in will also delete the most recent full backup and associated
objects.

510 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Deleting Backups Using Veeam Backup &
Replication Console
You can manually delete backups from Veeam backup repositories using the Veeam Backup & Replication
console. You can use the console to delete backups in the following ways:

• Remove backup from the configuration

• Delete backup

Removing Backup from Configuration

If you want to remove records about backups from the Veeam Backup & Replication console and configuration
database, you can use the Remove from configuration operation. When you remove a backup from
configuration, backup files (.VAB, .VASM, .VACM) remain in the backup repository. You can import the backup
later and restore data from it.

To remove a backup from configuration:

1. Open the Home view.

2. In the inventory pane, select Ba ckups.

3. In the working area, select the necessary backup.

4. Press and hold the [Ctrl] key, right-click the backup and select Remove from configuration.

Deleting Backup
You can use the Veeam Backup & Replication console to delete backups created with Veeam Plug-in from a
Veeam backup repository.

511 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

To delete a backup, do the following:

5. In the Veeam Backup & Replication console, open the Home view.

6. In the inventory pane, select Ba ckups.

7. In the working area, right-click the name of the backed-up object and select Delete from disk.

512 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Configuring Force Deletion of Backups
Veeam Plug-in for IBM Db2 has a functionality that automatically force deletes backup files which are older than
specified number of days. For example, you can use it if a backup repository contains backup files that are no
longer in the backup catalog.

To enable force deletion of backup files, do the following:

1. On the machine with Veeam Plug-in, run the following command.

DB2ConfigTool --set-force-delete

2. Enter the number of days after which Veeam Plug-in will force delete backup files on all configured
Veeam backup repositories.

Garbage collector automatically deletes backup files older than the specif
ied number of days.
Make sure the number of days value exceeds your retention policy.
To disable this functionality, set the number of days to 0.
Enter the number of days to delete backups after, between 7 and 999 [0]:

By default, the force delete functionality is disabled (set to 0).

IMP ORTANT

If a backup repository contains backups older than the specified retention period, Veeam Plug -in removes
old backup files only after the next backup run.

513 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Backup Copy for IBM Db2 Backups
One backup does not provide the necessary level of safety. The primary backup may get destroyed together
with production data, and you will have no backups from which you can restore data.

To build a successful data protection and disaster recovery plan, it is recommended that you follow the 3 -2-1
rule:

• 3: You must have at least three copies of your data: the original production data and two backups.

• 2: You must use at least two different types of media to store the copies of your data, for example, local
disk and cloud.

• 1: You must keep at least one backup offsite, for example, in the cloud or in a remote site.

Thus, you must have at least two backups and they must be in different locations. If a disaster takes out your
production data and local backup, you can still recover from your offsite backup.

In This Section
Creating Backup Copy Job

514 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Creating Backup Copy Job
Veeam Backup & Replication offers the backup copy functionality that allows you to create several instances of
the same backup in different locations, whether onsite or offsite. Backup copies have the same format as those
created by backup jobs and you can recover your data from them when you need it.

Veeam Backup & Replication fully automates the backup copy process and lets you specify retention settings to
maintain the desired number of restore points, as well as full backups for archival purposes. Backup copy is a
job-driven process. When enabled, the backup copy job for Veeam Plug -in backups runs continuously. For more
details on how it works, see the Backup Copy section in the Veeam Backup & Replication User Guide.

To copy backups to a secondary location, you must configure a backup copy job. The backup copy job defines
how, where and when to copy backups. One job can be used to process backups of one or more machines.

You can configure a job and start it immediately or save the job to start it later.

Before creating a job, check prerequisites. Then use the New Backup Copy Job wizard to configure a backup
copy job.

1. Launch Backup Copy Job wizard.

2. Specify a job name and description.

3. Select backups to process.

4. Define backup copy target.

5. Specify advanced settings.

6. Define backup copy schedule.

7. Finish working with the wizard.

Before You Begin

Before you create a backup copy job, check the prerequisites and limitations:

• Backup infrastructure components that will take part in the backup copy process must be added to the
backup infrastructure and properly configured. These include source and target backup repositories
between which backups must be copied.

• The target backup repository must have enough free space to store copied backups. To receive alerts
about low space on the backup repository, configure global notification settings. For more infor mation,
see Specifying Other Notification Settings.

515 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 1. Launch Backup Copy Job Wizard
To create a backup copy job, do the following:

1. In the Veeam Backup & Replication console, open the Home view.

2. Click the Ba ckup Copy tab and select Ap p lication-level backup.

516 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 2. Specify Job Name and Description
At the Job step of the wizard, specify a name and description for the backup copy job.

1. In the Na me field, enter a name for the job.

2. In the Description field, enter a description for the job. The default description contains information about
the user who created the job, date and time when the job was created.

517 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Step 3. Select Backups to Process
At the Ob ject step of the wizard, select machines whose backups you want to copy to the target repository.

1. Click the Ad d button and select from which entity you want to process the machines.

o From jobs: You can select Veeam Plug-in backup jobs. When a backup copy job runs, Veeam Backup &
Replication will search for backup files created by selected jobs.

o From repositories: You can select repositories where Veeam Plug-in backups are stored. When a
backup copy job runs, Veeam Backup & Replication will search for backup files created by Veeam
Plug-in in selected repositories.

2. Use the Remove button if you want to remove selected jobs or repositories from processing.

3. If you have added jobs from a repository and want to exclude from processing some of the backup jobs on
the selected repository, click E x clusions and select the jobs that you want to exclude.

518 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Step 4. Define Backup Copy Target
At the Ta rget step of the wizard, configure the target repository settings.

1. From the Ba ckup repository list, select a backup repository in the target site where copied backups must
be stored. When you select a target backup repository, Veeam Backup & Replication automatically checks
how much free space is available on it. Make sure that you have enough free space to s tore copied
backups.

IMP ORTANT

For Veeam Plug-in backup copy jobs, you cannot select the following repositories as a backup copy
target:

• Veeam Cloud Connect repository

• Object storage repository

2. If the target repository contains a Veeam Plug-in or MongoDB backup that was excluded from the backup
copy job, and if you don't want to transfer duplicate data, you can use the mapping feature.

After you configure mapping, if some of backup files (.VAB) of the source backup are missing in the target
backup copy, these files are uploaded to the target backup copy.

NOTE

Veeam Plug-in backup copy jobs do not use WAN accelerators.

To map a backup copy job to the backup:

a. Click the Ma p backup link.

b. Point the backup copy job to the backup in the target backup repository. Backups in the target backup
repository can be easily identified by backup job names. To facilitate search, you can use the search
field at the bottom of the window.

IMP ORTANT

Keep in mind that repositories must meet the following requirements:

• Used account must have access to Veeam backup repositories that you plan to use.
• Encryption must be disabled on the repository.

Otherwise, the repositories will not be listed as available. To learn how to configure access
permissions and encryption settings on repositories, see Access Permissions in the Veeam Backup &
Replication User Guide.

519 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 3. You can specify the number of days after which the backup copy will be deleted from the reposit ory. Note
that the countdown starts from the moment when source backup has been created.

520 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 5. Specify Advanced Settings
At the Ta rget step of the wizard, click Ad vanced to configure storage, RPO warning, and notifications settings.

• Storage settings

• RPO warning settings

• Notification settings

Storage Settings
At the Storage tab, define compression and deduplication settings.

By default, Veeam Backup & Replication performs deduplication before storing copied data on the target backup
repository. Deduplication provides a smaller size of the resulting backup file but may reduce the job
performance.

1. You can disable data deduplication. To do this, clear the E na ble inline data deduplication check box.

2. From the Compression level list, choose a compression level to be used: Auto, None, Dedupe-friendly,
Op timal, High or E x treme. The recommended level of compression for backup copy jobs is Auto. In this
case, Veeam Backup & Replication uses compression settings of the copied backup files. For more
information, see Compression and Deduplication.

RPO Warning Settings

At the RP O Monitor tab, specify RPO warning settings.

521 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Enable the W a rn me if backup is not copied within check box and specify the time period in minutes, hours, or
d a ys.

If the backup copy is not created within the specified time p eriod, the backup copy job will finish with the
Warning status. The countdown starts from the moment when the required backup is finished and ready to be
copied.

Notification Settings
At the Notifications tab, to specify notification settings for the backup copy job:

1. At the Ta rget step of the wizard, click Ad vanced.

2. Click the Notifications tab.

3. Select the Send SNMP notifications for this job check box if you want to receive SNMP traps when the job
completes successfully. SNMP traps will be sent if you specify global SNMP settings in Veeam Backup &
Replication and configure software on recipient's machine to receive SNMP traps. For more information,
see Specifying SNMP Settings.

4. Select the Send email notifications to the following recipients check box if you want to receive
notifications by email in case of job failure or success. In the field below, specify a recipient email address.
You can enter several addresses separated by a semicolon.

5. Veeam Backup & Replication sends a consolidated email notification once for the specified backup copy
interval. Even if the synchronization process is started several times within the interval, for example, due
to job retries, only one email notification will be sent.

6. Email notifications will be sent if you configure global email notification settings in Veeam Backup &
Replication. For more information, see Configuring Global Email Notification Settings.

522 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 7. At the Send at field, specify the time when you want to receive notifications. Note that you will receive a
notification on the job status once a day.

8. You can choose to use global notification settings or specify custom notification settings.

o To receive a typical notification for the job, select Use global notification settings. In this case, Veeam
Backup & Replication will apply to the job global email notification settings specified for the backup
server. For more information, see Configuring Global Email Notification Settings.

o To configure a custom notification for a job, select Use custom notification settings specified below.
You can specify the following notification settings:

i. In the Sub ject field, specify a notification subject. You can use the following variables in the
subject: %Time% (completion time), %JobName%, %JobResult%, %VmCount% (number of
machines in the job) and %Issues% (number of machines in the job that have been processed
with the W a rning or Fa iled status).

ii. Select the Notify on success, Notify on warning and Notify on error check boxes to receive email
notification if data processing within the backup copy interval completes successfully, fails or
completes with a warning.

523 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 6. Define Backup Copy Schedule
At the Schedule step of the wizard, define a time span in which the backup copy job must not transport data
between source and target backup repositories. For more information, see Backup Copy Window.

To define a backup window for the backup copy job:

1. Select the During the following time p eriods only option.

2. In the schedule box, select the desired time area.

3. Use the E na ble and Disable options to mark the selected area as allowed or prohibited for the backup copy
job.

524 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 7. Review Backup Copy Job Settings
At the Summary step of the wizard, complete the procedure of backup copy job configuration.

1. Review details of the backup copy job.

2. Select the E na ble the job when I click Finish check box if you want to start the job right after you finish
working with the wizard.

3. Click Finish to close the wizard.

525 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Logs and Support
If you have any questions or issues with Veeam Plug-in for IBM Db2 or Veeam Backup & Replication, you can
search for a resolution on Veeam R&D Forums or submit a support case on the Veeam Customer Support Portal.

When you submit a support case, attach a file containing logs related to Veeam Plug-in operations. For detailed
instructions on how to collect logs for Veeam Plug-in for IBM Db2, see this Veeam KB article.

526 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Veeam Plug-in Management
Veeam Backup & Replication lets you deploy and manage the following Veeam Plug -ins on computers in your
infrastructure:

• Veeam Plug-in for SAP HANA

• Veeam Plug-in for Oracle RMAN

• Veeam Plug-in for SAP on Oracle

Also, Veeam Backup & Replication lets you to back up MongoDB replica sets. For details, see MongoDB Backup.

IMP ORTANT

Veeam Backup & Replication does not support management of computers whose databases are protected
with Veeam Plug-in for Microsoft SQL Server and Veeam Plug-in for IBM Db2.

You do not need to install, set up and operate Veeam Plug -in on every computer whose databases you want to
protect. Instead, you can perform the set of deployment, administration, and data protection tasks on
computers remotely from the Veeam Backup & Replication console.

Veeam Backup & Replication offers the following management capabilities:

• Automated deployment and management of Veeam P lug -ins. You can set up Veeam Backup & Replication
to automatically discover computers that you want to protect with Veeam Plug-in for SAP HANA, Veeam
Plug-in for Oracle RMAN, and Veeam Plug-in for SAP on Oracle and deploy Veeam Plug-ins on these
computers. Once Veeam Plug-ins are deployed on protected computers, you can use the Veeam Backup &
Replication console to administrate Veeam Plug-ins on multiple computers.

• Centralized configuration a nd management of backup policies on p rotected computers . You can use the
Veeam Backup & Replication console to create and manage backup policies on computers in your
infrastructure whose databases you want to protect. You can configure backup policies to apply settings
on the computer, database system, or database level.

• Centralized backup jobs statistics and monitoring. You can use the Veeam Backup & Replication console to
review reports about backup policies performance on computers in your infrastructure whose databases
you want to protect.

• Centralized management of backups created by backup policies. If you choose to create backups on a
backup repository managed by the Veeam backup server, you can use the Veeam Backup & Replication
console to manage these backups.

• Secure database restore with recovery tokens. If you want to restore database from the backup and you
are not the owner of this backup, you can ask your Backup Administrator to generate a recovery token.
Using this recovery token, you can get access to a certain backup on the Veeam backup repository and
restore database from this backup.

527 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Veeam Plug-in Management Infrastructure
The Veeam Plug-in management infrastructure comprises the following components:

• Veeam backup server

• Computers with Veeam Plug-ins

• Distribution server

• Backup storage

Veeam Backup Server

The Veeam backup server is the core component in the backup infrastructure that fills the role of the
“configuration and control center”. To use the Veeam Plug -in management functionality offered by Veeam
Backup & Replication, you can use the backup server that is already running in your backup infrastructure or
deploy a separate backup server.

To learn more, see the Deployment section in the Veeam Backup & Replication User Guide.

Computers with Veeam Plug-ins

To manage Veeam Plug-ins on computers in your infrastructure, you must add computers that you want to
protect to the inventory in the Veeam Backup & Replication console and deploy Veeam Plug -ins. In Veeam
Backup & Replication, protected computers are organized into protection groups. To learn more, see Protection
Groups.

Veeam Backup & Replication lets you manage Veeam Plug-in on computers of the following types:

• Workstations, servers, and failover clusters running a Microsoft Windows OS

• Workstations and servers running a Linux OS

To learn more, see System Requirements.

If you want to manage Veeam Plug-ins installed on protected computers in Veeam Backup & Replication, you
must set Veeam Plug-ins in the managed mode. In this mode, all data protection and administration tasks are
performed by a backup administrator in Veeam Backup & Replication. In some scenarios, a user can also perform
a limited set of backup and disaster recovery tasks directly on a protected computer.

Veeam Backup & Replication is set up to automatically discover computers added to the inventory and deploy
Veeam Plug-ins on these computers. To learn more, see Computer Discovery and Veeam Plug-in Deployment.

528 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

On every computer added to the inventory, Veeam Backup & Replication installs the Veeam Installer Service.
The service performs the following tasks:

• Collects information about the computer and sends it to Veeam Backup & Replication. The collected data
includes details on the computer (platform, host name, guest OS, IP address, BIOS UUID), databases
(database system name, database hierarchy, names of databases) and Veeam Plug -in (product presence on
the computer and version).

• Downloads Veeam Plug-in setup files from the distribution server and installs Veeam Plug -in on the
protected computer.

• Deploys Veeam Transport Service.

On Microsoft Windows computers, Veeam Backup & Replication connects to a computer using the administrative
share (admin$) of the target computer. An account that you plan to use to connect to a computer included in
the protection group must have access to the administrative share.

On Linux computers, Veeam Backup & Replication also installs Veeam Deployer Service. After that, Veeam
Deployer Service deploys Veeam Transport Service. For the first time, Veeam Backup & Replication connects t o a
computer using SSH. After the first connection, Veeam Backup & Replication can continue using SSH or start
using Veeam Installer Service and Veeam Deployer Service.

Keep in mind that to connect to a Linux computer using SSH, this Linux computer must be added to the list of
trusted hosts. To learn more, see Configuring Security Settings.

Distribution Server
The distribution server is an architecture component in the Veeam Plug -in management infrastructure used for
automated deployment of Veeam Plug-in setup files to protected computers. When you instruct Veeam Backup
& Replication to install Veeam Plug-in on a protected computer, the Veeam backup server communicates to the
distribution server, and Veeam Backup & Replication uploads Veeam Plug-in setup files from the distribution
server to the target computer.

By default, the role of the distribution server is assigned to the backup server. However, you can deploy a
dedicated distribution server to reduce workload on the backup server. To deploy a distribution server, you need
to add a Windows-based server to Veeam Backup & Replication. To learn more, see the Adding Microsoft
Windows Servers section in the Veeam Backup & Replication User Guide. After you assigned the role of
distribution server, you need to select this server in the properties of a protection group. To learn more, see
Specify Discovery and Deployment Options.

A machine performing the role of the distribution server must meet the following requirements:

• The role of the distribution server can be assigned to a physical or virtual machine.

• The machine must run a 64-bit Microsoft Windows OS.

• You must add the machine to the Veeam Backup & Replication console as a managed s erver.

The distribution server comprises the following services and components:

• Veeam Distribution Service

• Veeam Plug-in for SAP HANA Redistributable

• Veeam Plug-in for Oracle RMAN Redistributable

529 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 • Veeam Plug-in for SAP on Oracle Redistributable

Backup storage
The backup storage is an architecture component in the Veeam Plug -in management infrastructure used to store
database backups. Veeam Plug-ins can store backup files in supported repositories added to the Veeam Backup
& Replication infrastructure. The list of supported repositories and limitations differs depending on the Veeam
Plug-in you work with. To learn more, see the following sections:

• Veeam Plug-in for Oracle RMAN

• Veeam Plug-in for SAP HANA

• Veeam Plug-in for SAP on Oracle

530 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Computer Discovery and Veeam Plug-in
Deployment
Veeam Backup & Replication supports automated and manual deployment of Veeam Plug -ins on computers in
your infrastructure.

You can deploy Veeam Plug-in for Oracle RMAN, Veeam Plug-in for SAP HANA, and Veeam Plug-in for SAP on
Oracle from the Veeam Backup & Replication console. To deploy Veeam Plug -ins, Veeam Backup & Replication
needs to discover computers whose data you want to back up. To enable discovery, you organize your
computers into one or more protection groups. Protection group settings define what computers Veeam Backup
& Replication will discover and how the discovery process will run. To learn more, see Protection Groups.

You can also disable automated Veeam Plug-in installation when configuring a protection group. In this case,
you will need to use the Veeam Backup & Replication console to install Veeam Plug -in on every computer
included in the protection group. To learn more, see Installing Plug-in.

In This Section
• Protection Groups

• Rescan Job

531 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Protection Groups
In Veeam Backup & Replication, computers that you want to protect with Veeam Plug -ins are organized into
protection groups. A protection group is a container in the Veeam Backup & Replication inventory aimed to
combine protected computers of a specific type. For example, you can use a dedicated protection group for
computers of the same type or computers running the same OS type to simplify management of such
computers. You can also use a separate protection group for computers that you want to manage in a different
way from other computers in your infrastructure.

To start managing Veeam Plug-ins in Veeam Backup & Replication, you need to create a protection group in the
inventory and specify computers that you want to protect with Veeam Plug -ins in the protection group settings.
You can create one or more protection groups depending on the size and complexity of your infrastructure.
Protection groups appear under the P hy sical Infrastructure node in the Inventory view of the Veeam Backup &
Replication console. To learn more, see Working with Protection Groups.

Protection groups allow you to automate deployment and management of Veeam Plug -ins on computers in your
infrastructure. When you configure a protection group, you can specify scheduling options for protected
computers discovery and Veeam Plug-in deployment. You do not need to perform administrative tasks
individually for every computer that you want to protect with Veeam Plug -in — Veeam Backup & Replication will
perform the specified operations automatically upon the defined schedule.

Veeam Backup & Replication connects to discovered computers using credentials of the account specified in the
protection group settings. You can specify a master account that Veeam Backup & Repl ication will use to
connect to all computers added to the protection group or specify separate accounts to connect to specific
computers in the protection group.

After you create a protection group, Veeam Backup & Replication starts the rescan job to conne ct to computers
added to the protection group and perform the required operations on these computers. To learn more, see
Rescan Job.

Protection Group Types

Veeam Backup & Replication offers several methods to specify computers on which you want to install and
manage Veeam Plug-ins.

TIP

If you plan to back up MongoDB replica sets, you must use a protection group for applications. For details,
see Protection Group for MongoDB. Other protection group types are not supported for MongoDB.

You can create protection groups that include the following types of objects:

• Ind ividual computers

You can organize individual computers into a protection group by specifying the necessary computers in
the protection group settings. This option is recommended for smaller environments that do not have
Microsoft Active Directory deployed.

• Microsoft Active Directory objects

You can create protection groups that include one or more Microsoft Active Directory objects: entire
domain, container, organization unit, group, computer or cluster. This allows you to manage Veeam Plug -
ins on computers being part of an Active Directory domain. Protection groups that include Active Directory
domain, containers, groups and organization units are dynamic in their nature. For example, if a new
computer is added to a container, Veeam Backup & Replication will automatically discover this computer
and start managing this computer as specified in the protection group settings.

532 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 You can specify a protection scope based on Active Directory objects in one of the following ways:

o You can select individual Active Directory objects that you want to include in a protection group, for
example, selected organization units and computers.

o You can include in the protection group an entire domain or other Active Directory object (such as a
container or organization unit) and exclude specific child objects being part of this object, for
example, selected organization units and computers.

• Comp uters listed in a CSV file

You can add multiple computers to a protection group by importing a list of computers from a CSV file.
Protection groups that include computers listed in a CSV file are also dynamic. If a new computer appears
in a CSV file after the protection group is created, during the next protection group rescan session, Veeam
Backup & Replication will automatically update the protection group settings to include the added
computer.

Predefined Protection Groups

In addition to protection groups created by a user, the Veeam Backup & Replication inventory may contain one
or more predefined protection groups.

Unmanaged
The Unmanaged protection group acts as a filter to display computers with unmanaged Veeam Plug -ins, that is,
computers that meet the following conditions:

1. Have Veeam Agent and Veeam Plug-in deployed and configured directly from a computer side.

IMP ORTANT

If Veeam Plug-in only is installed on the computer, this computer will not be displayed in the
Unmanaged protection group.

2. Run a backup job targeted at a backup repository managed by Veeam Backup & Replication.

You cannot perform any operations with the Unmanaged protection group, as well as add computers included in
this group to an application backup policy. However, you can move such computers to a protection group that
you created. To learn more, see Moving Unmanaged Computer to Protection Group.

533 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

After you move an unmanaged computer to a protection group, Veeam Backup & Replication will start managing
Veeam Agent and Veeam Plug-in running on this computer according to discovery settings specified in the
properties of the protection group. If the protection group is added to an application backup policy, Veeam
Backup & Replication will add the new computer to the policy too. You will no longer be able to manage Veeam
Agent and Veeam Plug-in directly on the computer.

Out of Date
The Out of Date protection group is displayed when Veeam Backup & Replication discovers protected computers
on which an outdated version of Veeam Plug-in is installed. For example, this may happen in a situation where
you configure a protection group with Veeam Plug-in deployment options disabled, and Veeam Backup &
Replication detects a newer version of Veeam Plug-in on the distribution server during discovery.

The Out of Date protection group lets you update Veeam Plug-in on multiple computers at once. To learn more,
see Upgrading Plug-in.

Offline
The Offline protection group acts as a filter to display computers to which Veeam Backup & Replication could
not connect during the latest rescan session.

Untrusted
The Untrusted protection group acts as a filter to display Linux-based computers whose fingerprints were not
verified in Veeam Backup & Replication. For computers included in this protection group, you need to check and
validate SSH fingerprints. To learn more, see Adding Computers to Trusted Hosts List.

534 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Rescan Job
For automated discovery of protected computers, Veeam Backup & Replication uses the rescan job that runs on
the backup server. Veeam Backup & Replication automatically creates this job once you create the first
protection group in the inventory. The rescan job runs upon schedule defined individually for every protection
group in the protection group settings. By default, Veeam Backup & Replication is set up to perform discovery at
9:00 PM daily. You can adjust daily schedule in the protection group settings or define per iodic schedule.

The rescan job itself is not displayed in the Veeam Backup & Replication console. However, you can start and
stop rescan job sessions manually for a specific protection group or individual computer in the inventory. This
may be helpful, for example, if new computers appeared in your infrastructure, and you want to discover these
computers without waiting for the next scheduled rescan job session start. To learn more, see Rescanning
Protection Group and Rescanning Protected Computer.

You can view statistics for currently running and already performed rescan job sessions. To learn more, see
Viewing Rescan Job Statistics.

How Rescan Job Works

When the rescan job is started, Veeam Backup & Replication performs the following operations:

1. Obtains settings specified for the protection group from the configuration database. The settings include a
list of computers to scan, an account for connecting to these computers, and so on.

2. Connects to each computer in the list under the specified account:

o On Microsoft Windows computers, Veeam Backup & Replication connects to a computer using the
administrative share (admin$) of the target computer. An account that you plan to use to connect to a
computer included in the protection group must have access to the administrative share.

o On Linux computers, Veeam Backup & Replication connects to a computer using SSH.

Keep in mind that to connect to a Linux computer using SSH, this Linux computer must be added to
the list of trusted hosts. To learn more, see Configuring Security Settings.

3. Deploys Veeam Installer Service on each newly discovered computer.

In case of Linux-based computers, Veeam Backup & Replication also deploys Veeam Deployer Service.

4. If the automatic Veeam Plug-in deployment option is enabled in the protection group settings, Veeam
Backup & Replication deploys Veeam Plug-in on discovered computers. As a part of this process, Veeam
Backup & Replication performs the following operations:

a. Veeam Installer Service running on the computer collects information about the computer and sends
it to Veeam Backup & Replication. The collected data includes details on the computer ( platform, host
name, guest OS, IP address, BIOS UUID) and Veeam Plug -in (product presence on the computer and
version).

b. Veeam Backup & Replication uploads the Veeam Plug -in setup file from the distribution server to the
discovered computer.

c. Veeam Installer Service deploys Veeam Plug-in and accompanying product components (for example,
Plug-in Manager and Data Mover) on the target computer.

If Veeam Installer Service detects that Veeam Plug-in is already deployed on the target computer,
Veeam Backup & Replication becomes the owner of this Veeam Plug-in. To learn more, see Veeam
Plug-in Ownership.

535 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 d. Veeam Installer Service retrieves the TLS certificate with a public key from the backup server and
saves a TLS certificate with a public key in the Veeam Plug-in configuration database on the target
computer. Veeam Plug-in will use this certificate to connect to Veeam Backup & Replication.

e. Plug-in Manager running on the target computer collects information about databases available on
the target computer. To learn more, see Database Detection.

Veeam Plug-in Ownership

To manage Veeam Plug-ins on target computers, you must make Veeam Backup & Replication the owner of
these Veeam Plug-ins. To do this, perform one of the following operations from Veeam Backup & Replication
console:

• Using protection group, deploy Veeam Plug-ins remotely.

• Add computers with standalone Veeam Plug-ins to a protection group that is configured to deploy Veeam
Plug-ins.

If you add a computer with standalone Veeam Plug-in to a protection group that does not deploy Veeam
Plug-ins, Veeam Backup & Replication will not be the owner of this Veeam Plug -in. In this case, you
cannot perform any operations with Veeam Plug-in from the Veeam Backup & Replication console. To
learn more, see Discovery and Deployment Options.

If Veeam Backup & Replication becomes the owner of Veeam Plug -in, this Veeam Plug-in switches to the
managed mode. In the managed mode, a limited set of tasks can be done from the computer side.

You can perform the following tasks from the computer side:

• Create the backup using the backup policy configured in the Veeam Backup & Replication console.

• Restore data from backup to the original and new location.

IMP ORTANT

You cannot perform the following tasks from the computer side:

• Create backup of a database that is not added to the backup policy on the Veeam Backup &
Replication server. You can still create backup of such database on other targets. For example, local
storage or shared folder.

• Edit backup policy settings.

536 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

You can run the following commands from the computer side:

• --show-config

• --help

• --set-force-delete

• [For Veeam Plug-in for SAP HANA] --set-scale-out-cluster-name

• [For Veeam Plug-in for SAP HANA and Veeam Plug-in for SAP on Oracle] --set-backup-for-restore

• [For Veeam Plug-in for Oracle RMAN and Veeam Plug-in for SAP HANA] --set-auth-data-for-
restore

• [For Veeam Plug-in for Oracle RMAN] --get-backup-id

Checking Veeam Plug-in Ownership

On the computer, you can check the current owner of Veeam Plug -in. If Veeam Plug-in is managed by Veeam
Backup & Replication, the following Veeam Backup & Replication connection parameters will be availa ble in the
Veeam Plug-in configuration file:

<VBRConnectionParams vbrHostName=<hostname> vbrPort=<port_number> vbrUser=<user

name> vbrDomain=<domain> vbrPassword=<password> vbrName=<name> vbrId=<ID> />

where:

• <hostname> — IP address or hostname of the Veeam Backup & Replication server.

• <port_number> — port over which Veeam Plug-in must communicate with Veeam Backup & Replication.
The default port used for communication with the Veeam Backup & Replication server is 10006.

• <username> — a name of the account that has access to the Veeam Backup & Replication server.

• <domain> — a name of the domain in which the account that has access to the Veeam Backup &
Replication server is registered.

• <password> — password of the account that has access to the Veeam Backup & Replication server.

• <name> — name of the Veeam Backup & Replication server.

• <ID> — ID of the Veeam Backup & Replication server.

IMP ORTANT

A plug-in can be managed by one Veeam Backup & Replication server only. If Veeam Backup & Replication
tries to become the owner of Veeam Plug-in that is already managed by another Veeam Backup &
Replication, Veeam Backup & Replication will not change the owner and you will get a warning message.

Resetting Veeam Plug-in Ownership

If you do not want Veeam Backup & Replication to be the owner of Veeam Plug -in, you can reset the Veeam
Plug-in ownership to the standalone mode. For example, this may be useful if you want to repair the backup job
metadata .VACM file for the backup.

537 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

To reset the ownership, on the computer with Veeam Plug-in, you must do one of the following operations:

• In the Veeam Plug-in configuration file (veeam_config.xml), delete the Certificate node and all
parameters inside the node.

• Delete Veeam Plug-in configuration file.

Database Detection
After Veeam Plug-in is installed, Plug-in Manager running on the computer collects information about
databases on this computer. Plug-in Manager saves collected information to the XML file and sends to Veeam
Backup & Replication. The way Plug-in Manager collects information differs depending on the system installed
on the computer:

• Oracle

• SAP HANA

• SAP on Oracle

Oracle
On the Oracle server, Plug-in Manager collects information differently depending on the Oracle deployment
way:

• If you install Veeam Plug-in on the standalone Oracle server, the rescan process differs depending on the
OS running on the target computer:

o In case of Oracle server deployed on the Linux computer, Plug -in Manager scans the oratab or
orainventory file. If you use Automatic Storage Management (Oracle ASM), Plug -in Manager rescans
both files ( oratab and orainventory ).

o In case of Oracle server deployed on the Microsoft Windows computer, Plug -in Manager checks
Windows Registry and parses services that are running on the computer.

As a result, Veeam Backup & Replication gets 3 levels of the database hierarchy (from top to bottom):
hostname, Oracle home, Oracle system identifier (SID).

• If you install Veeam Plug-in on Oracle RAC, Plug-in Manager uses the srvctl utility. With this utility, Plug-
in Manager collects information. Plug-in Manager uses, for example, the srvctl config scan and
srvctl config database commands.

For Oracle RAC, Plug-in Manager uses a database unique name instead of SID. As a result, Veeam Backup &
Replication gets 3 levels of the database hierarchy (from top to bottom): scanname, Oracle home,
database unique name.

After rescan completes, you can create an application policy and add any level of the database hierarchy to the
scope of this policy. For example, you can add a certain Oracle database or Oracle home that contains several
databases.

538 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

SAP HANA
On the SAP HANA server, Plug-in Manager collects information depending on the SAP HANA deployment way:

• If you install Veeam Plug-in on the standalone SAP HANA server, Plug-in Manager gets path to the
saphostcrl (SAP Host Agent) utility. With this utility, Plug-in Manager gets the list of database instances.
As a result, Veeam Backup & Replication gets 3 levels of the database hierarchy (from top to bottom):
hostname, SAP system name, database name.

• If you install Plug-in Manager on the SAP HANA scale-out system, Plug-in Manager collects information
from the veeam_config.xml file.

As a result, Veeam Backup & Replication gets 3 levels of the database hierarchy (from top to bottom):
scale-out system name, SAP system name, database name.

TIP

During the Veeam Plug-in deployment on the scale-out system nodes, Veeam Backup & Replication
sets the scale-out system name using domain name and SAP system name. If you want to set a
custom name, use the --set-scale-out-cluster-name command on the computer side. This
custom name will be saved in the veeam_config.xml file.

After rescan completes, you can create an application policy and add any level of the database hierarchy to the
scope of this policy. For example, you can add a certain SAP HANA database or a host that contains several SAP
HANA databases.

SAP on Oracle
On the SAP on Oracle server, Plug-in Manager gets path to the saphostcrl (SAP Host Agent) utility. With this
utility, Plug-in Manager gets the list of database instances.

As a result, Veeam Backup & Replication gets 2 levels of the database hierarchy (from top to bottom):
hostname, Oracle system identifier (SID).

IMP ORTANT

Veeam Backup & Replication does not support cluster deployment of SAP on Oracle.

After rescan completes, you can create an application policy and add any level of the database hierarchy to the
scope of this policy. For example, you can add a certain Oracle database or a host that contains several Oracle
databases.

MongoDB
. The selected mongo daemon resides on a computer. VAL, veeammongoagent and transports are already
installed on it by a recent rescan of Mongo PG.

A customer will need to go through the PG wizard after he changes topology

539 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Application Backup Policies
To back up databases on your computers with Veeam Plug -ins, you must configure an application backup policy.
An application backup policy is a task that defines what data to b ack up, how, where and when to back up data.

After you configure the application backup policy on the Veeam Backup & Replication server side, Veeam Plug -
ins create transport jobs on your computers. Using these transport jobs, Veeam Backup & Replication
orchestrates the backup operations. Transport jobs collect backed -up data and send it from your computers to
the backup repository. Each transport job creates an independent backup. For example, if the application
backup policy orchestrates 3 transport jobs, a backup repository will store 3 backup files, one file per each
transport job.

Backing Up One Computer with Multiple Policies

You can add a database only to one application backup policy. But, you can still configure several application
backup policies to back up different databases on the same computer. For example, if you want to back up a
staging database and a production database according to different schedules, you must create two application
backup policies. In this case, each of these policies will orchestrate its transport job that will produce a backup
and send it to a backup repository.

How Application Backup Policy Works

After you configure an application backup policy, this backup policy functions in the following way:

1. The backup policy is waiting for the next backup run.

The backup policy is running continuously. When there are no active backup activities, the backup policy is
set to an idle state. This state allows the backup policy to catch warnings and display them in the backup
policy statistics.

2. Before starting the next backup run, Veeam Backup & Replication finishes the active session. The backup
policy sends a report to Veeam Backup & Replication. The finished session becomes available in the
History view of the Veeam backup console. To learn more, see Viewing Backup Policy Report and Viewing
Backup Policy Statistics.

3. If database log processing is enabled, the backup policy restarts the database log backup run. Database
log backup is a separate task that runs in parallel with the database backup.

NOTE

For Veeam Plug-in for Oracle RMAN, you cannot disable database log processing. If there is an
existing full backup of the database, the backup policy always restarts the database log backup run.

4. The backup policy creates a list of backup tasks, detects and configure Veeam Plug -ins. Veeam Plug-ins
run the backup operations on computers.

5. Transport jobs on computers send backed-up data from computers to the backup repository.

An application backup policy may consist of several activities. For example, database backup according to
the policy schedule, database logs backup according to a separate schedule, and manual database backup.
In this case, Veeam Plug-in will store the backed-up data for all activities in the same backup.

6. The backup policy sends a report to Veeam Backup & Replication about backed -up and transported data.

After the backup run is completed, the backup policy returns to the idle state and waits for the next backup run.

540 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Planning and Preparation
Before you start using the Veeam Plug-in management functionality in Veeam Backup & Replication, make sure
that the Veeam backup server and computers that you plan to protect with Veeam Plug -ins meet the system
requirements and all required ports are open.

541 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

System Requirements
Make sure that components in the plug-in management infrastructure meet system requirements listed in this
section.

Veeam Backup Server

To learn about system requirements for the Veeam backup server and other Veeam Backup & Replication
components, see the System Requirements section in the Veeam Backup & Replication User Guide.

Computer with Veeam Plug-in for Oracle RMAN

A computer with databases you want to protect using Veeam Plug -in for Oracle RMAN must meet the following
requirements:

Sp ecification Requirement

OS Veeam Plug-in for Oracle RMAN is supported for the following Microsoft
Windows versions:
• Microsoft Windows Server 2025
• Microsoft Windows Server 2022
• Microsoft Windows Server 2019
• Microsoft Windows Server 2016
• Microsoft Windows Server 2012/2012 R2

Veeam Plug-in for Oracle RMAN is supported for the following Linux
distributions:
• SUSE Linux Enterprise Server 11, 12, 15 (x86 and x86_64)
• RHEL 6.4 – 9.x (x86 and x86_64)
• Oracle Linux 6.2 (x86 and x86_64)
• Oracle Linux 6.4 – 9.x (x86 and x86_64)
• CentOS 6.4 – 8.x (x86 and x86_64): For non-production environments,
as it is not officially supported by Oracle for their databases.

Note:

Veeam Plug-in for Oracle RMAN in managed operation mode is not supported
for Oracle Solaris and IBM AIX.

Software [For Microsoft Windows computers] Microsoft .NET Framework 4.6 is

included in the Veeam Plug-in for Oracle RMAN Redistributable. During the
deployment process, Veeam Backup & Replication checks whether Microsoft
.NET Framework 4.6 is available on the target computer. If Microsoft .NET
Framework 4.6 is missing, Veeam Backup & Replication will install missing
software automatically.

542 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 Sp ecification Requirement

Ora cle database Veeam Plug-in for Oracle RMAN supports the following Oracle database
versions:

• 11gR2
• 12c
• 18c
• 19c
• 21c: Standard and Enterprise Edition
• 23c: Standard and Enterprise Edition

The Oracle database configuration must meet the following requirements:

• Oracle database must be in the OPEN state.
• Oracle database must work in the ARCHIVELOG mode.

Notes:

• Oracle Express Edition (XE) is not supported.

• Oracle databases residing in OS-level containerized environments (for
example: Docker, Podman) are not supported.

Ora cle RMAN features The following Oracle RMAN features are supported:
• Veeam Plug-in for Oracle RMAN will be registered as an SBT_TAPE
device. All Oracle RMAN functionality that is supported with the
SBT_TAPE device type will work. For example, Automatic Storage
Management (Oracle ASM) and Container DBs (CDBs).
• Veeam Plug-in for Oracle RMAN supports Oracle Real Application
Clusters (Oracle RAC). Other cluster databases are not supported.

543 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Computer with Veeam Plug-in for SAP HANA
A computer with databases you want to protect using Veeam Plug -in for SAP HANA must meet the following
requirements:

Sp ecification Requirement

OS Veeam Plug-in for SAP HANA supports 64-bit versions of the following
distributions:
• SLES 15: GA, SP1, SP2, SP3, SP4, SP5, SP6
• SLES for SAP Applications 15: GA, SP1, SP2, SP3, SP4, SP5, SP6
• SLES 12: GA, SP1, SP2, SP3, SP4, SP5
• SLES for SAP Applications 12: GA, SP1, SP2, SP3, SP4, SP5
• RHEL 9 for SAP HANA: 9.0, 9.2, 9.4
• RHEL 8 for SAP HANA: 8.0, 8.1, 8.2, 8.4, 8.6, 8.8, 8.10
• RHEL 9 for SAP Solutions: 9.0, 9.2, 9.4
• RHEL 8 for SAP Solutions: 8.0, 8.1, 8.2, 8.4, 8.6, 8.8, 8.10
• RHEL 7 for SAP Solutions: 7.2, 7.3, 7.4, 7.5, 7.6, 7.7, 7.9

Note:

Veeam Plug-in for SAP HANA in managed operation mode is not supported
for Linux on Power.

SAP HANA database Veeam Plug-in for SAP HANA supports SAP HANA 2.0: SPS 02, SPS 03, SPS
04, SPS 05, SPS 06, SPS 07, SPS 08 (only with Backint version 1.0). Express
Edition is not supported.

SAP HANA 1.0 is not supported.

Note:

To check whether an OS version is compatible with the SAP HANA release

you want to use, see the SAP HANA Administration Guide (requires an SAP
ID).

Computer with Veeam Plug-in for SAP on Oracle

A computer with databases you want to protect using Veeam Plug -in for SAP on Oracle must meet the following
requirements:

Sp ecification Requirement

OS The following operating systems are supported:

• SUSE Linux Enterprise Server 11, 12, 15 (x86_64)

• RHEL for SAP Applications 6, 7, 8 (x86_64)

544 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 Sp ecification Requirement

Ora cle database Oracle Database 11gR2, 12c, 18c, 19c: Standard and Enterprise Edition.

Note:

Oracle Express Edition (XE) is not supported.

SAP software In the management scenario, Veeam Plug-in for SAP on Oracle does not
support SAP Java systems.

Network
Veeam Plug-in must be able to establish a direct IP connection to the Veeam Backup & Replication server. Thus,
Veeam Plug-in cannot work with the Veeam Backup & Replication server that is located behind the NAT
gateway.

545 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Permissions
To perform database protection and recovery operations on a computer with Veeam Plug -in, you must specify
the user whose permissions Veeam Backup & Replication will use to access the protected computer and
database management system. Depending on the database system, the specified user accounts must have the
permissions listed in this section.

NOTE

If you plan to restore SAP HANA and Oracle databases using Veeam Explorer for SAP HANA and Veeam
Explorer for Oracle, consider the required permissions in the following sections of Veeam Explorers User
Guide:

• Permissions for Veeam Explorer for SAP HANA

• Permissions for Veeam Explorer for Oracle

Computer with Veeam Plug-in for Oracle RMAN

• The specified user account must belong to the OSDBA system group. The default name of the OSDBA
group depends on the operating system:

o dba in Linux and UNIX.

o ORA_DBA in Microsoft Windows.

To learn more about connecting to a database as administrator using operating system authentication, see
this Oracle article.

• [For Linux and Unix computers] If you use Oracle ASM and distribute system privileges with separate
operating system groups, make sure you follow the Oracle recommendations described in this Oracle
article.

• [For Linux and Unix computers] During application backup policy configuration, when you specify the OS
user account as a database administrator and this OS user account is not the Oracle Software Owner User,
make sure one of the following requirements is met:

o Permissions for Oracle directories are set with the chmod command as 775.

o The OS user account has the primary membership in the Oracle Inventory Group (oinstall) group.

To learn how to configure the Oracle Inventory Group, see this Oracle article.

• [For Microsoft Windows computers] The specified OS user account must have local administrator
privileges.

Computer with Veeam Plug-in for SAP HANA

• The OS user account must have sufficient privileges to run the HDBSQL command line tool — for example,
this can be the <sid>adm user.

• The DB user account used for performing backup and recovery operations with system and tenant
databases must have the following system privileges:

o BACKUP ADMIN

o CATALOG READ

o DATABASE BACKUP ADMIN

546 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Computer with Veeam Plug-in for SAP on Oracle
The specified account must be an OS user who owns the data files of the database system. To learn more about
logon options, see this SAP article.

547 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Licensing
The Veeam Plug-in management functionality is licensed by the number of instances. Instances are units (or
tokens) that you can use to protect your computers with Veeam Plug-ins. If the license is not valid or out of
resources, Veeam Plug-in backup jobs fail.

The number of instances that you can use depends on the type of license installed in Veeam Backup &
Replication:

• For Veeam Universal Licensing (VUL)

You can use Veeam Plug-ins with all license packages ( Veeam Backup Essentials, Veeam Backup &
Replication, Veeam Availability Suite ).
Keep in mind that if you use the Rental license type, functionality of Veeam Plug-ins is supported only for
the Enterprise Plus edition of Veeam Backup & Replication.

• For Perpetual Socket license

Functionality of Veeam Plug-ins is supported only for the Enterprise Plus edition of Veeam Backup &
Replication.

For the full list of license packages, see this Veeam webpage.

Obtaining and Managing Licenses

To learn how to install a license and monitor licensed objects, see the Licensing section in the Veeam Backup &
Replication User Guide.

548 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Ports
The following links lead to tables that list network ports that must be opened to ensure proper communication
of components in the Veeam Plug-in management infrastructure.

Communication Between Veeam Backup & Replication

Components
For general requirements for ports that must be opened to ensure proper communication of the backup server
with backup infrastructure components, see the Ports section in the Veeam Backup & Replication User Guide.

In addition to general port requirements applicable to a Veeam backup server, the backup server used in the
Veeam Plug-in management scenario must have the following ports opened:

From To P rotocol P ort Notes

Veeam Computer TCP 6184+ Default port used for communication with
Backup with Veeam Veeam Plug-in.
Server Plug-in
(Microsoft If port 6184 is already in use, Veeam
Windows) Plug-in Service tries to use the next port
number in the allocated range (6184 to
6194). Once the service takes the next
available port, it makes it the default port
for all subsequent connections.

TCP 135, Default ports used for communication

UDP 137 to 139, with the Veeam Installer Service.
6160,
11731 Port 135 is used for WMI queries. WMI
queries are mandatory to back up failover
clusters and optional to provide faster
Veeam Plug-in deployment.

Ports 137 to 139 are used by backup

infrastructure components to
communicate using NetBIOS.

Ports 6160 and 11731 are used to deploy

Veeam Plug-in on the computer.

If the backup repository server role and

the mount server role are assigned to
different servers in your infrastructure,
you must open ports described in the
Mount Server Connections subsection in
the Veeam Backup & Replication User
Guide.

549 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 From To P rotocol P ort Notes

Computer TCP 22, Port 22 is used to establish an SSH

with Veeam 6160, connection from the Veeam Backup
Plug-in 6162 Server to the computer with Veeam Plug-
(Linux) in.

Ports 6160 and 6162 are used for default

connection to the computer with Veeam
Plug-in using Veeam Transport Service
and Veeam Deployer Service.

TCP 6162 Default port used by the Veeam Data

Mover.

TCP 2500 to Default range of ports used for

3300 communication between Veeam Plug-in
components during data transmission. For
every TCP connection that a backup job
uses, one port from this range is assigned.

Distribution TCP 135, Ports on a Microsoft Windows server used

Server UDP 137 to 139, for deploying the Distribution Server
445, component.
6160,
11731 Port 135 is optional. This port is used to
provide faster Veeam Plug-in
deployment.

Ports 137 to 139 are used by backup

infrastructure components to
communicate using NetBIOS.

Ports 6160 and 11731 are used by the

Veeam Installer Service. These ports
together with port 445 are mandatory to
deploy the Distribution Server
component.

TCP 49152 to Dynamic RPC port range. For more

65535 information, see this Microsoft KB article.

TCP 9380 Default port used for communication with

the Veeam Distribution Service.

Distribution Computer TCP 49152 to Dynamic RPC port range. For more
Server with Veeam 65535 information, see this Microsoft KB article.
Plug-in
(Microsoft The port range is required for
Windows) communication with the Veeam Installer
Service.

550 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 From To P rotocol P ort Notes

TCP 6160, Ports on the computer used for deploying

UDP 11731 Veeam Plug-in.

Computer TCP 22, Port 22 is used to establish an SSH

with Veeam 6160, connection for Veeam Plug-in packages
Plug-in 6162 transmission and deployment control.
(Linux)
After Veeam Plug-in is deployed, ports
6160 and 6162 are used for default
connection to computer with Veeam
Plug-in using Veeam Transport Service
and Veeam Deployer Service.

Computer Veeam TCP 10005 Default port used by Veeam Plug-in

with Veeam Backup operating in the managed mode for
Plug-in Server communication with the Veeam Backup
(Microsoft server.
Windows)
Data between the computer with Veeam
Plug-in and backup repositories is
transferred directly, bypassing Veeam
backup servers.

Computer TCP 10006 Default port used for communication with

with Veeam the Veeam Backup server.
Plug-in
(Linux, Unix) Data between the computer with Veeam
Plug-in and backup repositories is
transferred directly, bypassing Veeam
backup servers.

Communication with Veeam Backup Repositories

The following table describes network ports that must be opened to ensure proper communication between
Veeam Plug-in and Veeam backup repositories.

From To P rotocol P ort Notes

Computer with Linux server TCP 2500 to 3300 Default range of ports used as data
Veeam Plug-in performing the transmission channels. For every
role of a backup TCP connection that a job uses,
repository one port from this range is
assigned.

551 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 From To P rotocol P ort Notes

Microsoft TCP 49152 to Dynamic RPC port range. For more

Windows server 65535 information, see this Microsoft KB
performing the (for Microsoft article.
role of a backup Windows 2008
repository and newer)

TCP 2500 to 3300 Default range of ports used as data

transmission channels. For every
TCP connection that a job uses,
one port from this range is
assigned.

Shared folder TCP 137 to 139, Ports used as a transmission

CIFS (SMB) UDP 445 channel from the Computer with
share Veeam Plug-in to the target CIFS
(SMB) share.

Ports 137 to 139 are used by

backup infrastructure components
to communicate using NetBIOS.

Gateway TCP 137 to 139, If a CIFS (SMB) share is used as a

Microsoft UDP 445 backup repository and a Microsoft
Windows server Windows server is selected as a
gateway server for this CIFS share,
these ports must be opened on the
gateway Microsoft Windows
server.

Ports 137 to 139 are used by

backup infrastructure components
to communicate using NetBIOS.

TCP 49152 to Dynamic RPC port range. For more

65535 information, see this Microsoft KB
article.

TCP 2500 to 3300 Default range of ports used as data

transmission channels. For every
TCP connection that a job uses,
one port from this range is
assigned.

Communication Between Veeam Plug-in Components

The following sections describe network ports that must be opened to enable proper communication between
Veeam Plug-in components:

• Veeam Plug-in for Oracle RMAN

552 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 • Veeam Plug-in for SAP HANA

• Veeam Plug-in for SAP on Oracle

553 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Getting Started
To start using the Veeam Plug-in management functionality in Veeam Backup & Replication, you must perform
the following operations:

1. Deploy Veeam Backup & Replication.

To learn more, see the Deployment section in the Veeam Backup & Replication User Guide.

2. Configure security settings.

By default, Veeam Backup & Replication offers the following settings to establish a secure connection
between the backup server and protected computers:

o To establish a secure connection between parties, Veeam Backup & Replication uses the default self-
signed certificate.

o Veeam Backup & Replication allows all new Linux hosts to establish a connection to the backup
server.

You can use the default security settings or change them if needed. To learn more, see Configuring
Security Settings.

3. Add computers with databases that you want to protect to the Veeam Backup & Replication inventory.

In Veeam Backup & Replication, computers with databases that you want to protect are organized into
protection groups. You can use the Veeam Backup & Replication console to create one or more protection
groups that include individual computers, Microsoft Active Directory objects, or list of computers
imported from a CSV file. To learn more, see Creating Protection Groups.

4. Discover computers and deploy Veeam Plug-ins.

During protection group configuration, you can set Veeam Backup & Replication to automatically discover
computers and install Veeam Plug-ins on discovered computers. In this case, these operations are
performed immediately after you create a protection group. To learn more, see Discovery and Deployment
Options.

You can also run discovery and deployment operations manually for an individual computer in a protection
group. To learn more, see Rescanning Protected Computer.

5. Configure an application backup policy.

You can configure one or more application backup policies and add to these policies one or more
protection groups, Active Directory objects and individual computers. In Veeam Backup & Replication, you
can configure application backup policies for the following Veeam Plug-ins:

o Veeam Plug-in for Oracle RMAN

o Veeam Plug-in for SAP HANA

o Veeam Plug-in for SAP on Oracle

6. Manage application backup policies.

You can start, stop, enable and disable application backup policies to administer data protection
operations on protected computers. To learn more, see Managing Application Backup Policies.

554 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 TIP

After the first successful run of an application backup policy, you can also run the backup job from
the computer with Veeam Plug-in. The procedure is similar as for Veeam Plug-ins running in the
standalone mode. For details, see the following sections:

• Veeam Plug-in for SAP HANA

• Veeam Plug-in for Oracle RMAN
• Veeam Plug-in for SAP on Oracle

7. In case of a disaster, you can use created application backups to restore database data.

To learn more, see Managing Application Backups.

555 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Configuring Security Settings
When you configure the backup infrastructure for enterprise applications in Veeam Backup & Replication, you
can specify what security settings Veeam Backup & Replication will use to establish a secure connection
between the backup server and protected computers. By default, Veeam Backup & Replication offers the
following security settings:

• To establish a secure connection between parties, Veeam Backup & Replication uses the default self-
signed TLS certificate.

• Veeam Backup & Replication allows all computers that run a Linux OS to establish a connection to the
backup server using the SSH fingerprint.

Keep in mind that default security settings are only for testing and evaluation purposes. To prevent potential
security issues, you can change security settings. For example, you can use a custom TLS certificate and
verification of Linux host SSH fingerprints.

To specify the security settings, do the following:

1. From the main menu, select Op tions.

2. Click the Security tab.

3. In the Certificate section, check information about the currently used certificate. By default, Veeam
Backup & Replication uses a self-signed TLS certificate generated during the Veeam Backup & Replication
installation process. If you want to use a custom certificate, click Install and specify a new certificate. To
learn more, see Managing TLS Certificates.

4. In the Linux hosts authentication section, specify how Veeam Backup & Replication will add Linux -based
protected computers to the list of trusted hosts. You can select one of the following options:

o Ad d all discovered hosts to the list automatically — with this option enabled, Veeam Backup &
Replication allows all discovered computers that run a Linux OS to connect to the backup server. This
scenario is recommended for demo environments only.

o Ad d unknown hosts to the list manually (more secure) — with this option enabled, only the following
Linux-based computers can connect to the backup server:

▪ Protected computers that have already established a connection to the backup server and have
their fingerprints stored in the Veeam Backup & Replication database. Veeam Backup &
Replication displays the number of such computers in the Trusted hosts field. You can export
the list of trusted Linux computers to a known_hosts file. To do this, click E x port and specify a
path to the folder to save the file.

▪ Protected computers specified in the known_hosts file imported to Veeam Backup & Replication.
To import a known_hosts file, click Imp ort and specify a path to the folder where the file resides.

▪ Protected computers added to the list of trusted hosts in the Veeam Backup & Replication
console. To learn more, see Adding Computers to Trusted Hosts List.

The computers that are not in the list of trusted hosts cannot connect to the Veeam backup server and
download Veeam components during discovery.

5. Click OK.

556 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 TIP

To learn more about other security settings available on the Security tab, see the Configuring Security
Settings section in the Veeam Backup & Replication User Guide.

557 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Managing TLS Certificates
When you configure the backup infrastructure for enterprise applications management infrastructure, you can
specify what TLS certificate must be used to establish a secure connection between the backup server and
protected computers. Veeam Backup & Replication offers the following options for TLS cer tificates:

• You can choose to keep the default self-signed TLS certificate generated by Veeam Backup & Replication.

• You can use Veeam Backup & Replication to generate a new self-signed TLS certificate. To learn more, see
Generating Self-Signed Certificates.

• You can select an existing TLS certificate from the certificates store. To learn more, see Importing
Certificates from Certificate Store.

• You can import a TLS certificate from a file in the PFX format. To learn more, see Importing Certificates
from PFX Files.

NOTE

If you plan to use a certificate issued by your own Certificate Authority (CA), make sure that the certificate
meets the requirements. To learn more, see Using Certificate Signed by Internal CA.

Generating Self-Signed Certificates

You can use Veeam Backup & Replication to generate a self-signed certificate for authenticating parties in the
backup infrastructure for enterprise applications.

To generate TLS certificates, Veeam Backup & Replication employs the RSA Full cryptograp hic service provider
by Microsoft Windows installed on the Veeam backup server. The created TLS certificate is saved to the Shared
certificate store. The following types of users can access the generated TLS certificate:

• User who created the TLS certificate

• LocalSystem user account

• Local Administrators group

If you use a self-signed TLS certificate generated by Veeam Backup & Replication, you do not need to take any
additional actions to deploy the TLS certificate on a protected computer. When Veeam Backup & Replication
discovers a protected computer, a matching TLS certificate with a public key is installed on the protected
computer automatically. During discovery, Veeam Installer Service deployed on the protected computer
retrieves the TLS certificate with a public key from the backup server and installs a TLS certificate with a public
key on the protected computer.

NOTE

When you generate a self-signed TLS certificate with Veeam Backup & Replication, you cannot include
several aliases to the certificate and specify a custom value in the Subject field. The Subject field value is
taken from the Veeam Backup & Replication license installed on the Veeam backup server.

To generate a self-signed TLS certificate:

1. From the main menu, select Op tions.

2. Click the Security tab.

3. In the Security tab, click Install.

558 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 4. At the Certificate Type step of the wizard, select Generate new certificate.

5. At the Generate Certificate step of the wizard, specify a friendly name for the created self-signed TLS
certificate.

6. At the Summary step of the wizard, review the certificate properties. Use the Cop y to clipboard link to
copy and save information about the generated TLS certificate. You will be able to use the copied
information to verify the TLS certificate with the certificate thumbprint.

559 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 7. Click Finish. Veeam Backup & Replication will save the generated certificate in the Shared certificate store
on the Veeam backup server.

Importing Certificates from Certificate Store

If your organization has a TLS certificate signed by a CA and the TLS certificate is located in the Microsoft
Windows Certificate store, you can use this certificate for authenticating parties in the backup infrastructure for
enterprise applications.

To select a certificate from the Microsoft Windows Certificate store:

1. From the main menu, select Op tions.

2. Click the Security tab.

3. In the Security tab, click Install.

560 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 4. At the Certificate Type step of the wizard, choose Select certificate from the Certificate Store.

5. At the P ick Certificate step of the wizard, select a TLS certificate that you want to use. You can select only
certificates that contain both a public key and a private key. Certificates without private keys are not
displayed in the list.

6. At the Summary step of the wizard, review the certificate properties.

561 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 7. Click Finish to apply the certificate.

Importing Certificates from PFX Files

You can import a TLS certificate in the following situations:

• Your organization uses a TLS certificate signed by a CA and you have a copy of this certificate in a file of
PFX format.

• You have generated a self-signed TLS certificate in the PFX format with a third-party tool and you want to
import it to Veeam Backup & Replication.

IMP ORTANT

The TLS certificate must pass validation on the Veeam backup server. In the opposite case, you will not be
able to import the TLS certificate.

To import a TLS certificate from a PFX file:

1. From the main menu, select Op tions.

2. Click the Security tab.

3. In the Security tab, click Install.

4. At the Certificate Type step of the wizard, choose Imp ort certificate from a file.

5. At the Imp ort Certificate step of the wizard, specify a path to the PXF file.

562 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 6. If the PFX file is protected with a password, specify the password in the field below.

7. At the Summary step of the wizard, review the certificate properties. Use the Cop y to clipboard link to
copy and save information about the TLS certificate. You can use the copied information on a protected
computer to verify the TLS certificate with the certificate thumbprint.

8. Click Finish to apply the certificate.

Using Certificate Signed by Internal CA

To establish a secure connection between the backup server and protected computers, Veeam Backup &
Replication uses a TLS certificate. By default, Veeam Backup & Replication uses a self -signed certificate. Veeam
Backup & Replication generates this certificate when you install the product on the Veeam backup server.

If you want to use a certificate signed by your internal Certification Authority (CA), make sure that the following
requirements are met:

• Veeam product on the protected computer and Veeam Backup & Replication must trust the CA. That is,
the Certification Authority certificate must be added to the Trusted Root Certification Authority store on
the Veeam backup server and computers with Veeam products.

• Certificate Revocation List (CRL) must be accessible from the Veeam backup server and computers with
Veeam products.

• [For Linux-based computers] OpenSSL version 1.0 or later must be installed on the computer with Veeam
products.

563 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

A certificate signed by a CA must meet the following requirements:

1. The certificate subject must be equal to the fully qualified domain name of the Veeam backup server. For
example: vbrserver.tech.local .

2. The following key usage extensions must be enabled in the certificate to sign and deploy child certificate s
for computers with Veeam Plug-ins:

o Digital Signature

o Certificate Signing

o Off-line CRL Signing

o CRL Signing (86)

If you use Windows Server Certification Authority, it is recommended that you issue a Veeam Backup &
Replication certificate based on the built-in "Subordinate Certification Authority" template or templates
similar to it.

3. It is highly recommended to add "pathLen=0" to Basic Constraints.

If you use Windows Server Certification Authority, to do this, enable the Do not allow subject to issue
certificates to other CAs option in the certificate template.

4. The key type in the certificate must be set to Exchange.

If you create a certificate request using the Windows MMC console, to specify the key type, do the
following:

a. At the Request Certificates step of the Certificate Enrollment wizard, select a check box next to the
necessary certificate template and click P roperties.

b. In the Certificate Properties window, click the P rivate Key tab.

c. In the Key Type section, select E x change.

564 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

To start using the signed certificate, you must import it from the certificates store on the Veeam backup server.

After you specify the signed certificate in Veeam Backup & Replication, during the next application backup
policy session Veeam products will receive child certificates from the Veeam backup server.

565 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Adding Computers to Trusted Hosts List
After you enable the Ad d unknown hosts to the list manually (more secure) option in Veeam Backup &
Replication settings, Linux-based computers whose SSH fingerprints are not stored in the Veeam Backup &
Replication database become unable to communicate to the Veeam backup server. During discovery, Veeam
Backup & Replication puts such computers to the Untrusted protection group. To start managing an untrusted
computer, you must manually validate the SSH fingerprint and add the computer to the list of trusted hosts in
the Veeam Backup & Replication console.

To add a computer to the list of trusted hosts:

1. Open the Inventory view.

2. In the inventory pane, expand the P hy sical Infrastructure node and click Untrusted.

3. In the working area, Veeam Backup & Replication will display discovered computers that you can add to
the list of trusted hosts. Check SSH fingerprints of the computers and add them to the list of trusted hosts
in one of the following ways:

o To add all computers at once to the list of trusted hosts, select the Untrusted node in the inventory
pane and click Trust All on the ribbon or right-click the Untrusted node and select Trust a ll.

566 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 o To add a specific computer to the list of trusted hosts, select the necessary computer in the working
area and click Trust on the ribbon or right-click the computer and select Trust.

567 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Deploying Plug-in for Certificate-Based
Authentication
You have an option to install Veeam Plug-in on Linux computers using certificate-based authentication instead
of credentials. To do so, you must install Veeam Deployer Service on the computer and then add the computer
to a protection group of the Individual computers type. In this case, Veeam Backup & Replication does not
require SSH connection to install Veeam Plug-in.

Deploying Veeam Plug-in

To deploy Veeam Plug-in using pre-installed Veeam Deployer Service, perform the following steps:

1. On the Veeam Backup & Replication side, start a Veeam PowerShell session. For more information, see the
Starting Veeam PowerShell Sessions in the Veeam PowerShell Reference.

2. Run the Generate-VBRBackupServerDeployerKit cmdlet to generate the Veeam Deployer Service

certificate and export the Veeam Backup & Replication Deployer Client certificate and Veeam Deployer
Service installation packages.

3. Upload the obtained files on the computer which database you want to protect.

4. On the side of the computer with Veeam Plug-in, navigate to the directory where you have saved the files
and install Veeam Deployer Service using a package manager.

5. Run the following commands to install the certificates:

/opt/veeam/deployment/veeamdeploymentsvc --install-server-certificate serv

er-cert.p12
/opt/veeam/deployment/veeamdeploymentsvc --install-certificate client-cert
.pem
/opt/veeam/deployment/veeamdeploymentsvc --restart

6. On the Veeam Backup & Replication side, create a protection group with the following parameters:

a. At the Ty p e step of the wizard, select Ind ividuals computers.

b. At the Comp uters step of the wizard, specify a computer and select the Connect using certificate-
b a sed authentication method to connect to the computer.

To learn more, see Specifying Computers.

After you create the protection group, Veeam Backup & Replication will rescan the protection group. During the
rescan operation, Veeam Backup & Replication will connect to the Veeam Deployer Service and install Veeam
Plug-in. To learn more, see Rescan Job.

Related Topics
• Protection Group Types

• Creating Protection Group for Individual Computers

• Creating Protection Group for Microsoft Active Directory Objects

• Creating Protection Group for Computers from CSV File

568 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Working with Protection Groups
Veeam Backup & Replication allows you to create and manage protection groups that are intended to organize
your backup scopes.

NOTE

If you want to use a certificate-based authentication to connect to the protected computers, before
creating a protection group, you must install Veeam Plug -in on the computer. For details, see Deploying
Plug-in for Certificate-Based Authentication.

You can perform the following operations with protection groups:

• Create a protection group.

• Edit protection group settings.

• Rescan a protection group.

• Assign location to a protection group.

• Disable a protection group.

• Remove a protection group.

For details, see Creating Protection Group for Individual Computers, Creating Protection Group for Microsoft
Active Directory Objects and Creating Protection Group for Computers from CSV File.

569 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Creating Protection Groups
You must add computers that you plan to protect with Veeam Plug -ins to the inventory in the Veeam Backup &
Replication console. In Veeam Backup & Replication, protected computers are organized into protection groups.
You can create one or more protection groups that contain computers of different types or offer different
discovery and deployment options.

You can create protection groups for the following objects:

IMP ORTANT

Veeam Backup & Replication cannot install Veeam Plug-ins on computers added to the protection groups
for the following types:

• Computers with pre-installed agents

• Cloud machines
• Applications

To learn more about protection groups for computers with pre-installed agents and cloud machines, see
Protection Group Types section in Veeam Agent Management Guide. For details, about protection group
for applications, see Creating Protection Group for MongoDB.

• Individual computers — create a protection group for these objects if you want to define a static
protection scope by adding specific computers to the protection group. This protection group is
recommended for smaller environments that do not have Microsoft Active Directory deployed.

• Microsoft Active Directory objects — create a protection group for these objects if you want to add to the
protection scope one or several Active Directory objects: entire domain, container, organization unit,
group, computer or cluster. Protection groups that include Active Directory containers and organization
units are dynamic in their nature. If a new computer is added to a container or organization unit that you
have specified in the protection group settings, during the next rescan session, Veeam Backup &
Replication will discover this computer and (optionally) deploy Veeam Plug -in on this computer.

• Computers from CSV file — create a protection group for these objects if you want to add to the protection
scope computers listed in a CSV file that resides in a local folder on the backup server or in a network
shared folder. As well as protection groups that include Active Directory containers, protection groups of
this type are also dynamic. If a new computer appears in a CSV file after the protection job is created,
within the next rescan session, Veeam Backup & Replication will automatically update the protection
group settings to include the added computer.

Related Topics
Protection Groups

570 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Creating Protection Group for Individual Computers
Before You Begin
Before creating a protection group, consider the following prerequisites and limitations:

1. When Veeam Backup & Replication performs discovery of protected computers, Veeam Backup &
Replication connects to every computer added to the protection group. If you instruct Veeam Backup &
Replication to perform discovery immediately after the protection group is created, make sure that all
computers added to the protection group are powered on and may be accessed ov er the network.
Otherwise, Veeam Backup & Replication will be unable to connect to a protected computer and perform
the required operations on this computer.

2. Do not add a computer to a protection group by specifying a dynamic IP address assigned to this
computer. If such computer receives another IP address from a DHCP server, Veeam Backup & Replication
will be unable to discover the computer and perform on this computer operations defined in the
protection group settings.

3. We recommend that you include each object you want to protect in one protection group only. For
example, if you have added an Active Directory container to a protection group, it is not recommended to
add a computer that exists in this container to another protection group. Adding computers to multiple
protection groups with different computer discovery and Veeam Plug -in deployment settings will result in
additional load on the backup server.

4. When you configure a protection group for a cluster, do not exclude nodes of this cluster from a
protection scope. Otherwise, Veeam Backup & Replication will not have complete information about all
clustered servers.

5. To deploy Veeam Installer Service and Veeam Plug -in on a protected computer running Microsoft
Windows OS, Veeam Backup & Replication uses the administrative share (admin$) of the target computer.
An account that you plan to use to connect to a computer included in the protection group must have
access to the administrative share.

Note that in client Microsoft Windows OSes access to the administrative share is forbidden by default for
local accounts. You can enable this option with a registry key. For details, see this Microsoft KB article.

6. Veeam Backup & Replication does not support usage of a Linux account for which system settings modify
shell output results to connect to a computer included in the protection group. For example, this includes
Linux accounts with the modified PS1 shell variable.

571 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Step 1. Launch New Protection Group Wizard
To launch the New Protection Group wizard, do the following:

1. Open the Ad d Protection Group window. To open the window, do one of the following:

o Open the Inventory view. Click the P hy sical Infrastructure node in the inventory pane and click Ad d
Group on the ribbon.

o Open the Inventory view. Click the P hy sical Infrastructure node in the inventory pane and click Create
P rotection Group in the working area.

o Open the Inventory view. Right-click the P hy sical Infrastructure node in the inventory pane and select
Ad d protection group.

2. In the Ad d Protection Group window, select the Ind ividual computers option.

572 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 2. Specify Protection Group Name and Description
At the Na me step of the wizard, specify a name and description for the protection group.

1. In the Na me field, specify a name for the protection group.

2. In the Description field, provide a description for future reference. The default descrip tion contains
information about the user who added the protection group, date and time when the protection group
was created.

573 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 3. Specifying Individual Computers
At this step of the wizard, specify computers that you want to add to the protection group.

To add a computer to a protection group:

1. Click Ad d .

2. In the Ad d Computer window, in the Host name or IP address field, enter a full DNS name, NetBIOS name
or IP address of the computer that you want to add to the protection group.

3. Select a method to connect to the computer:

o Connect using admin credentials. In this case, from the Credentials list, select a user account that has
administrative permissions on the computer that you want to add to the protection group. Veeam
Backup & Replication will use this account to connect to the protected computer and perform the
necessary operations on the computer: upload and deploy Veeam Plug -in, and so on.

If you have not set up credentials beforehand, click the Ma nage accounts link or click Ad d on the right
to add credentials.

Veeam Backup & Replication allows you to add the following types of credentials:

▪ Stored credentials. Select stored credentials if you want Veeam Backup & Replication to use the
specified user name and password for each connection to computer with Veeam Plug-in.

▪ [For Linux computers] Single-use credentials. Select single-use credentials if you do not want
Veeam Backup & Replication to store credentials in the configuration database. With this option
selected, Veeam Backup & Replication will use the specified user name and password only for
the first connection to Veeam Agent. After that, Veeam Backup & Replication will use Veeam
Transport Service to communicate with the computer.

Keep in mind that the username must be specified in the down-level logon name format. For example,
DOMAIN\UserName or HOSTNAME\UserName. Use the full domain or hostname name. Do not rep lace
them with a dot.

For more information, see the Credentials Manager section in the Veeam Backup & Replication User
Guide.

o [For Linux computers] Connect using certificate-based authentication. Select this option, if you chose
to pre-install Veeam Deployer Service on the Linux computer you want to add to the protection
group. In this case, Veeam Backup & Replication will communicate with the Linux computer using a
certificate. Veeam Backup & Replication will install Transport Service that will be used to perform the
necessary operations on the computer: upload and install Veeam Plug -in. To learn more, see
Deploying Plug-in for Certificate-Based Authentication.

4. Repeat steps 1–3 for every computer that you want to add to the protection group.

5. To check if Veeam Backup & Replication can communicate with computers added to the protection group,
click Test Now. Veeam Backup & Replication will use the specified credentials to connect to all computers
in the list.

574 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 NOTE

If you chose to manually add Linux-based computers to the list of trusted hosts in Veeam Backup &
Replication, when you test credentials for an unknown Linux-based computer in the protection group
settings, the test operation will complete with the Failed status. This happens because Veeam Backup &
Replication cannot connect to the untrusted computer before you add this computer to the list of trusted
hosts. To learn more, see Adding Computers to Trusted Hosts List.

575 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 4. Specify Discovery and Deployment Options
At the Op tions step of the wizard, specify settings for protected computers discovery and Veeam Plug -in
deployment.

Veeam Backup & Replication regularly connects to protected computers according to the schedule defi ned in
the protection group settings. At this step of the wizard, you can define the discovery schedule and specify
operations that Veeam Backup & Replication must perform on discovered computers. You can also select which
server in your backup infrastructure should act as a distribution server for Veeam Plug -ins.

To specify discovery and deployment options:

1. In the Discovery section, define schedule for automatic computer discovery within the scope of the
protection group:

o To run the rescan job at specific time daily, on defined week days or with specific periodicity, select
Da ily at this time. Use the fields on the right to configure the necessary schedule.

o To run the rescan job repeatedly throughout a day with a specific time interval, select P eriodically
every. In the field on the right, select the necessary time unit: Hours or Minutes. Click Schedule and
use the time table to define the permitted time window for the rescan job. In the Sta rt time within an
hour field, specify the exact time when the job must start.

o To run the rescan job continuously, select the P eriodically every option and choose Continuously from
the list on the right. A new rescan job session will start as soon as the previous rescan job session
finishes.

NOTE

You cannot create a protection group without defining schedule for automatic discovery. However,
you can disable automatic discovery for a specific protection group, if needed. To learn more, see
Disabling Protection Group.

2. In the Dep loyment section, select the object that will be responsible for the Veeam Plug -ins distribution,
select a Microsoft Windows server that you plan to use as a distribution server. Veeam Backup &
Replication will use the distribution server to upload Veeam Plug-in setup files to computers added to the
protection group. By default, Veeam Backup & Replication assigns the distribution server role to the
backup server. To learn more, see Distribution Server.

3. Make sure that the Install backup agent check box is clear. Otherwise, Veeam Backup & Replication will
install Veeam Agent on the target computer.

TIP

To learn how to use protection groups to automatically deploy Veeam Agents, see Veeam Agent
Management Guide.

4. If you want to instruct Veeam Backup & Replication to automatically deploy Veeam Plug -ins on all
discovered computers in the protection group, in the Deployment section, make sure that the Install
a p plication plug-ins: configure plug-ins to be installed check box is selected and click Configure. In the
Ap p lication Plug-ins window, select the check boxes next to the plug-ins that you want to install.

576 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 NOTE

[For Veeam Plug-in for SAP on Oracle] if you plan to use the rman_util parameter, you must install
2 plug-ins on the Oracle server:

• Veeam Plug-in for Oracle RMAN

• Veeam Plug-in for SAP on Oracle
You can also choose to disable automated Veeam Plug -in installation. To do this, in the Ap p lication P lug-
ins window, clear the check boxes next to the plug-ins that you do not want Veeam Backup & Replication
to install. In this case, you will need to install Veeam Plug-in on every computer included in the protection
group and discovered by Veeam Backup & Replication. To learn more, see Installing Plug-in.

5. If you want to instruct Veeam Backup & Replication to automatically up grade Veeam Plug-ins on
discovered computers when a new version of the product appears on the distribution server, in the
Dep loyment section, make sure that the Auto-update backup agents and plug-ins check box is selected.

6. Select the P erform reboot automatically if required check box to allow Veeam Backup & Replication to
reboot a protected computer.

7. Click Ad vanced to specify advanced settings for the protection group. To learn more, see Specify
Advanced Protection Group Settings.

577 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Step 5. Specify Advanced Protection Group Settings
You can specify email notification settings for the protection group. If you enable notification settings, Veeam
Backup & Replication will send a daily email report with protection group statis tics to a specified email address.
The report contains cumulative statistics for rescan job sessions performed for the protection group within the
last 24-hour period.

NOTE

Email reports with protection group statistics will be sent only if you configure global email notification
settings in Veeam Backup & Replication. For more information, see the Configuring Global Email
Notification Settings section in the Veeam Backup & Replication User Guide.

After you enable notification settings for the protection group, in addition to reports sent according to the
global email notification settings, Veeam Backup & Replication will send reports with the protection group
statistics to email addresses specified in the protection group settings. This allows you to fine -tune email
notifications in Veeam Backup & Replication: while one or more backup administrators receive email
notifications according to the global settings, other backup administrators can receive reports for specific
protection groups only.

If you do not enable global email notification settings in Veeam Backup & Replication, notification settings
for the protection group will not be sent even if you enable them in the protection group settings.

To specify notification settings for the protection group:

1. At the Op tions step of the wizard, click Ad vanced.

2. Click the Notifications tab.

3. Select the Send daily agent status report e -mail to the following recipients check box and specify a
recipient email address. You can enter several addresses separated by a semicolon.

4. In the Send daily summary at field, specify the time when Veeam Backup & Replication must send the daily
email report for the protection group.

5. You can choose to use global notification settings or specify custom notification settings.

To receive a typical notification for the protection group, select Use global notification settings. In this
case, Veeam Backup & Replication will apply to the protection group global email notification settings
specified for the backup server.

To configure a custom notification for the protection group, select Use custom notification settings
sp ecified below. You can specify the following notification settings:

o In the Sub ject field, specify a notification subject. You can use the following variables in the subject:

▪ %JobResult% — rescan job result.

▪ %PGName% — protection group name.

▪ %FoundCount% — number of new computers discovered within the last 24-hour period.

▪ %TotalCount% — total number of computers in the protection group.

▪ %SeenCount% — number of computers in the protection group that were online for the last 24
hours. A computer is considered to be online if Veeam Backup & Replication successfully
connected to this computer during the last rescan session.

o You can select one of the following notification triggers for the protection group rescan job:

578 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 ▪ Notify on success — when the job completes successfully.

▪ Notify on warning — when the job completes with a warning.

▪ Notify on error — when the job fails.

579 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 6. Review Components
At the Review step of the wizard, review what Veeam Backup & Replication components are already installed on
the distribution server specified for the protection group and what components will be installed.

1. Review the components.

2. Click Ap p ly to add the configured protection group to the inventory.

NOTE

Veeam Plug-in and Veeam Agent components are installed on the distribution server even if the Install
a p plication plug-ins and Install backup agent check boxes are clear at the Options step of the wizard.

580 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 7. Assess Results
At the Ap p ly step of the wizard, Veeam Backup & Replication will create the configured protection group. Wait
for the operation to complete and click Nex t to continue.

581 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Step 8. Finish Working with Wizard
At the Summary step of the wizard, complete the protection group configuration process.

1. Review information about the created protection group.

2. To start the rescan job after you close the wizard, make sure that the Run d iscovery when I click Finish
option is selected.

If you want to perform computer discovery later, you can clear the Run d iscovery when I click Finish check
box. In this case, the rescan job will start automatically upon the defined schedule. You can also start the
rescan job manually at any time you need. To learn more, see Rescanning Protection Group.

3. Click Finish to close the wizard.

What You Do Next

After you create a protection group, Veeam Backup & Replication automatically rescans computers that y ou
added to the created protection group and deploys Veeam Plug -ins on these computers. To learn more, see
Rescan Job.

After the rescan process completes and Veeam Plug-ins are successfully deployed on target computers, you ca n
create the application backup policy. Application backup policies allow you to protect computers in the
protection group. To learn more, see Working with Application Policies.

Creating Protection Group for Microsoft Active Directory

Objects
Before You Begin
Before creating a protection group, consider the following prerequisites and limitations:

1. When Veeam Backup & Replication performs discovery of protected computers, Veeam Backup &
Replication connects to every computer added to the protection group. If you instruct Veeam Backup &
Replication to perform discovery immediately after the protection group is created, make sure that all
computers added to the protection group are powered on and may be accessed over the network .
Otherwise, Veeam Backup & Replication will be unable to connect to a protected computer and perform
the required operations on this computer.

582 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 2. A protection group that includes Microsoft Active Directory objects can include objects from one domain
only. To add to the inventory computers that reside in another domain, you need to create a separate
protection group and include in this protection group the necessary objects from that domain.

3. Veeam Backup & Replication automatically excludes from the protection scope Active Directory objects of
the Group type that exist in a parent Active Directory object (organization unit, container or entire domain)
specified in the protection group settings. To instruct Veeam Backup & Replication to process a group , you
must select this group explicitly in the protection group settings.

4. You cannot add or exclude universal and domain local groups to/from protection groups that include
Microsoft Active Directory objects. Only global groups are supported.

5. Do not add a computer to a protection group by specifying a dynamic IP address assigned to this
computer. If such computer receives another IP address from a DHCP server, Veeam Backup & Replication
will be unable to discover the computer and perform on this computer operations defined in the
protection group settings.

6. We recommend that you include each object you want to protect in one protection group only. For
example, if you have added an Active Directory container to a protection group, it is not recommende d to
add a computer that exists in this container to another protection group. Adding computers to multiple
protection groups with different computer discovery and Veeam Plug -in deployment settings will result in
additional load on the backup server.

7. When you configure a protection group for a cluster, do not exclude nodes of this cluster from a
protection scope. Otherwise, Veeam Backup & Replication will not have complete information about all
clustered servers.

8. To deploy Veeam Installer Service and Veeam Plug-in on a protected computer running Microsoft
Windows OS, Veeam Backup & Replication uses the administrative share (admin$) of the target computer.
An account that you plan to use to connect to a computer included in the protection group must hav e
access to the administrative share.

Note that in client Microsoft Windows OSes access to the administrative share is forbidden by default for
local accounts. You can enable this option with a registry key. For details, see this Microsoft KB article.

583 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 1. Launch New Protection Group Wizard
To launch the New Protection Group wizard, do the following:

1. Open the Ad d Protection Group window. To open the window, do one of the following:

o Open the Inventory view. Click the P hy sical Infrastructure node in the inventory pane and click Ad d
Group on the ribbon.

o Open the Inventory view. Click the P hy sical Infrastructure node in the inventory pane and click Create
P rotection Group in the working area.

o Open the Inventory view. Right-click the P hy sical Infrastructure node in the inventory pane and select
Ad d protection group.

2. In the Ad d Protection Group window, select the Microsoft Active Directory objects option.

584 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 2. Specify Protection Group Name and Description
At the Na me step of the wizard, specify a name and description for the protection group.

1. In the Na me field, specify a name for the protection group.

2. In the Description field, provide a description for future reference. The default description contains
information about the user who added the protection group, date and time when the protection group
was created.

585 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 3. Specify Active Directory Objects
At this step of the wizard, select Active Directory objects that you want to add to the protection group. You can
add to a protection group the following types of Active Directory objects: domain, organization unit, container,
computer, cluster, or group.

To add Active Directory objects to a protection group:

1. In the Sea rch for objects in this d omain field, click Cha nge.

2. In the Sp ecify Domain window, specify settings of the domain whose objects you want to include in the
protection group:

a. In the Doma in controller or domain DNS name field, type a name of the domain controller or domain
whose objects you want to include in the protection group.

b. In the P ort field, specify a port number over which Veeam Backup & Replication must communicate
with the domain controller. By default, Veeam Backup & Replication uses port 389.

c. From the Account list, select a user account that is a member of the DOMAIN\Administrators group. If
you have not set up credentials beforehand, click the Ma nage accounts link or click Ad d on the right
to add credentials. For more information, see the Credentials Manager section in the Veeam Backup &
Replication User Guide.

d. Click OK to close the Sp ecify Domain window.

NOTE

If you want to include a large number of computers in the protection group but do not want to use
an account with domain administrator permissions in the protection group settings, consider
configuring a protection group based on a list of computers imported from a CSV file. To learn more,
see Launch New Protection Group Wizard.

3. In the Selected objects field, click Ad d .

4. In the Ad d Objects window, select the necessary Active Directory object in the tree and click OK. You can
press and hold [Ctrl] to select multiple objects at once.

To quickly find the necessary object, you can use the search field at the bottom of the Ad d Objects
window.

a. Click the button to the left of the search field and select the necessary type of object to search for:
Everything , Computer, Cluster, Organization Unit, Container or Group .

b. Enter the object name or a part of it in the search field.

586 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 c. Click the Sta rt search button on the right or press [E nter].

587 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 4. Exclude Objects from Protection Group
At this step of the wizard, you can specify which objects you want to exclude from the protection group. You
can exclude the following types of objects:

• All virtual machines — all VMs residing in the domain. You can select this option, for example, if you do not
want to protect VMs with Veeam Plug-ins and want to back up VM data with Veeam Backup & Replication
instead.

• All computers that have been offline for over 30 days — all computers in the domain that have not logged
on to Active Directory for more than 30 days.

• Individual objects: computers, clusters, groups, organization units and containers.

Excluding Individual Active Directory Objects

To exclude Active Directory objects:

1. In the E x clude section, select the The following objects check box.

2. Click Ad d .

3. In the Ad d Objects window, select the necessary Active Directory object in the tree and click OK. You can
press and hold [Ctrl] to select multiple objects at once.

To quickly find the necessary Active Directory object, you can use the search field at the bottom of the Ad d
Ob jects window.

1. Click the button to the left of the search field and select the necessary type of object to search for:
Everything , Computer, Cluster, Group, Organization Unit or Container.

2. Enter the object name or a part of it in the search field.

3. Click the Sta rt search button on the right or press [E nter].

588 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 5. Specify Credentials
At this step of the wizard, specify credentials to connect to computers included in the protection group:

1. If you want to use the same credentials for all computers in the protection group, select the necessary
user account from the Ma ster a ccount list. The account must have local administrator permissions on all
computers that you have added to the protection group.

If you have not set up credentials beforehand, click the Ma nage accounts link or click Ad d on the right to
add credentials. For more information, see the Credentials Manager section in the Veeam Backup &
Replication User Guide.

2. By default, Veeam Backup & Replication uses credentials specified in the Ma ster account field for all
computers in the protection group. If some computer requires a different user account, do the following:

a. Select the Use custom credentials for the following objects check box.

b. Click Ad d next to the list of objects and select the necessary object in the Ad d Objects window.

Objects that you have added to the protection group at the Active Directory step or the wizard are
already displayed in the Use custom credentials for the following objects list. In the Ad d Objects
window, you can also select child objects for which you want to specify custom credentials. For
example, you may want to specify separate credentials for different organization units, containers,
groups or individual computers within the entire domain added to the protection group.

c. In the Use custom credentials for the following objects list, select the necessary object, click E d it and
select custom credentials for the object. Credentials must be specified in the following format:

▪ For Active Directory accounts — DOMAIN\Username

▪ For local accounts — Username or HOST\Username

NOTE

Consider the following:

• Veeam Backup & Replication supports user account names in the SAM-Account-Name format
(DOMAIN\Username). The User-Principal-Name (UPN) format ( username@domain) is not supported.
If you specify credentials in the UPN format, Veeam Backup & Replication will successfully connect
to computers added to the protection group during the Test Now operation. However, the
subsequent protection group rescan operations will fail.
• The master account or custom account specified for an object must be a member of the
DOMAIN\Administrators group.

589 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

To check if Veeam Backup & Replication can connect to computers added to the protection group, click Test
Now. Veeam Backup & Replication will form a list of computers to connect and use the specified credentials to
connect to computers in the list.

590 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 6. Specify Discovery and Deployment Options
At the Op tions step of the wizard, specify settings for protected computers discovery and Veeam Plug-in
deployment.

Veeam Backup & Replication regularly connects to protected computers according to the schedule defined in
the protection group settings. At this step of the wizard, you can define the discovery schedule and specify
operations that Veeam Backup & Replication must perform on discovered computers. You can also select which
server in your backup infrastructure should act as a distribution server for Veeam Plug -ins.

To specify discovery and deployment options:

1. In the Discovery section, define schedule for automatic computer discovery within the scope of the
protection group:

o To run the rescan job at specific time daily, on defined week days or with specific periodicity, select
Da ily at this time. Use the fields on the right to configure the necessary schedule.

o To run the rescan job repeatedly throughout a day with a specific time interval, select P eriodically
every. In the field on the right, select the necessary time unit: Hours or Minutes. Click Schedule and
use the time table to define the permitted time window for the rescan job. In the Sta rt time within an
hour field, specify the exact time when the job must start.

o To run the rescan job continuously, select the P eriodically every option and choose Continuously from
the list on the right. A new rescan job session will start as soon as the previous rescan job session
finishes.

NOTE

You cannot create a protection group without defining schedule for automatic discovery. However,
you can disable automatic discovery for a specific protection group, if needed. To learn more, see
Disabling Protection Group.

2. In the Dep loyment section, select the object that will be responsible for the Veeam Plug -ins distribution,
select a Microsoft Windows server that you plan to use as a distribution server. Veeam Backup &
Replication will use the distribution server to upload Veeam Plug -in setup files to computers added to the
protection group. By default, Veeam Backup & Replication assigns the distrib ution server role to the
backup server. To learn more, see Distribution Server.

3. Make sure that the Install backup agent check box is clear. Otherwise, Veeam Backup & Replication will
install Veeam Agent on the target computer.

TIP

To learn how to use protection groups to automatically deploy Veeam Agents, see Veeam Agent
Management Guide.

4. If you want to instruct Veeam Backup & Replication to automatically deploy Veeam Plug -ins on all
discovered computers in the protection group, in the Deployment section, make sure that the Install
a p plication plug-ins: configure plug-ins to be installed check box is selected and click Configure. In the
Ap p lication Plug-ins window, select the check boxes next to the plug-ins that you want to install.

591 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 NOTE

[For Veeam Plug-in for SAP on Oracle] if you plan to use the rman_util parameter, you must install
2 plug-ins on the Oracle server:

• Veeam Plug-in for Oracle RMAN

• Veeam Plug-in for SAP on Oracle
You can also choose to disable automated Veeam Plug -in installation. To do this, in the Ap p lication P lug-
ins window, clear the check boxes next to the plug-ins that you do not want Veeam Backup & Replication
to install. In this case, you will need to install Veeam Plug -in on every computer included in the protection
group and discovered by Veeam Backup & Replication. To learn more, see Installing Plug-in.

5. If you want to instruct Veeam Backup & Replication to automatically upgrade Veeam Plug -ins on
discovered computers when a new version of the product appears on the distribution server, in the
Dep loyment section, make sure that the Auto-update backup agents and plug-ins check box is selected.

6. Select the P erform reboot automatically if required check box to allow Veeam Backup & Replication to
reboot a protected computer.

7. Click Ad vanced to specify advanced settings for the protection group. To learn more, see Specify
Advanced Protection Group Settings.

592 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 7. Specify Advanced Protection Group Settings
You can specify email notification settings for the protection group. If you enable notification settings, Veeam
Backup & Replication will send a daily email report with protection group statistics to a specified email address.
The report contains cumulative statistics for rescan job sessions performed for the protection group within the
last 24-hour period.

NOTE

Email reports with protection group statistics will be sent only if you configure global email notification
settings in Veeam Backup & Replication. For more information, see the Configuring Global Email
Notification Settings section in the Veeam Backup & Replication User Guide.

After you enable notification settings for the protection group, in addition to reports sent according to the
global email notification settings, Veeam Backup & Replication will send reports with the protection group
statistics to email addresses specified in the protection group settings. This allows you to fine-tune email
notifications in Veeam Backup & Replication: while one or more backup administrators receive email
notifications according to the global settings, other backup administrators can receive reports for specific
protection groups only.

If you do not enable global email notification settings in Veeam Backup & Replication, notification settings
for the protection group will not be sent even if you enable them in the protection group settings.

To specify notification settings for the protection group:

1. At the Op tions step of the wizard, click Ad vanced.

2. Click the Notifications tab.

3. Select the Send daily agent status report e -mail to the following recipients check box and specify a
recipient email address. You can enter several addresses separated by a semicolon.

4. In the Send daily summary at field, specify the time when Veeam Backup & Replication must send the daily
email report for the protection group.

5. You can choose to use global notification settings or specify custom notification settings.

To receive a typical notification for the protection group, select Use global notification settings. In this
case, Veeam Backup & Replication will apply to the protection group global email notification settings
specified for the backup server.

To configure a custom notification for the protection group, select Use custom notification settings
sp ecified below. You can specify the following notification settings:

o In the Sub ject field, specify a notification subject. You can use the following variables in the subject:

▪ %JobResult% — rescan job result.

▪ %PGName% — protection group name.

▪ %FoundCount% — number of new computers discovered within the last 24-hour period.

▪ %TotalCount% — total number of computers in the protection group.

▪ %SeenCount% — number of computers in the protection group that were online for the last 24
hours. A computer is considered to be online if Veeam Backup & Replication successfully
connected to this computer during the last rescan session.

o You can select one of the following notification triggers for the protection group rescan job:

593 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 ▪ Notify on success — when the job completes successfully.

▪ Notify on warning — when the job completes with a warning.

▪ Notify on error — when the job fails.

594 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 8. Review Components
At the Review step of the wizard, review what Veeam Backup & Replication components are already installed on
the distribution server specified for the protection group and what components will be installed.

1. Review the components.

2. Click Ap p ly to add the configured protection group to the inventory.

NOTE

Veeam Plug-in and Veeam Agent components are installed on the distribution server even if the Install
a p plication plug-ins and Install backup agent check boxes are clear at the Options step of the wizard.

595 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 9. Assess Results
At the Ap p ly step of the wizard, Veeam Backup & Replication will create the configured protection group. Wait
for the operation to complete and click Nex t to continue.

596 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 10. Finish Working with Wizard
At the Summary step of the wizard, complete the protection group configuration process.

1. Review information about the created protection group.

2. To start the rescan job after you close the wizard, make sure that the Run d iscovery when I click Finish
option is selected.

If you want to perform computer discovery later, you can clear the Run d iscovery when I click Finish check
box. In this case, the rescan job will start automatically upon the defined schedule. You can also start the
rescan job manually at any time you need. To learn more, see Rescanning Protection Group.

3. Click Finish to close the wizard.

What You Do Next

After you create a protection group, Veeam Backup & Replication automatically rescans computers that y ou
added to the created protection group and deploys Veeam Plug -ins on these computers. To learn more, see
Rescan Job.

After the rescan process completes and Veeam Plug-ins are successfully deployed on target computers, you can
create the application backup policy. Application backup policies allow you to protect computers in the
protection group. To learn more, see Working with Application Policies.

Creating Protection Group for Computers from CSV File

Before You Begin
Before creating a protection group, consider the following prerequisites and limitations:

1. When Veeam Backup & Replication performs discovery of protected computers, Veeam Backup &
Replication connects to every computer added to the protection group. If you instruct Veeam Backup &
Replication to perform discovery immediately after the protection group is created, make sure that all
computers added to the protection group are powered on and may be accessed over the network.
Otherwise, Veeam Backup & Replication will be unable to connect to a protected computer and perform
the required operations on this computer..

597 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 2. Do not add a computer to a protection group by specifying a dynamic IP address assigned to this
computer. If such computer receives another IP address from a DHCP server, Veeam Backup & Replication
will be unable to discover the computer and perform on this computer operations defined in the
protection group settings.

3. We recommend that you include each object you want to protect in one protection group only. For
example, if you have added an Active Directory container to a protection group, it is not recommended to
add a computer that exists in this container to another protection group. Adding computers to multiple
protection groups with different computer discovery and Veeam Plug -in deployment settings will result in
additional load on the backup server.

4. When you configure a protection group for a cluster, do not exclude nodes of this cluster from a
protection scope. Otherwise, Veeam Backup & Replication will not have complete information about all
clustered servers.

5. To deploy Veeam Installer Service and Veeam Plug-in on a protected computer running Microsoft
Windows OS, Veeam Backup & Replication uses the administrative share (admin$) of the target computer.
An account that you plan to use to connect to a computer included in the protection group must have
access to the administrative share.

Note that in client Microsoft Windows OSes access to the administrative share is forbidden by default for
local accounts. You can enable this option with a registry key. For details, see this Microsoft KB article.

6. Veeam Backup & Replication does not support usage of a Linux account for which system settings modify
shell output results to connect to a computer included in the protection group. For example, this includes
Linux accounts with the modified PS1 shell variable.

598 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 1. Launch New Protection Group Wizard
To launch the New Protection Group wizard, do the following:

1. Open the Ad d Protection Group window. To open the window, do one of the following:

o Open the Inventory view. Click the P hy sical Infrastructure node in the inventory pane and click Ad d
Group on the ribbon.

o Open the Inventory view. Click the P hy sical Infrastructure node in the inventory pane and click Create
P rotection Group in the working area.

o Open the Inventory view. Right-click the P hy sical Infrastructure node in the inventory pane and select
Ad d protection group.

2. In the Ad d Protection Group window, select the Comp uters from CSV file option.

599 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 2. Specify Protection Group Name and Description
At the Na me step of the wizard, specify a name and description for the protection group.

1. In the Na me field, specify a name for the protection group.

2. In the Description field, provide a description for future reference. The default description contains
information about the user who added the protection group, date and time when the protection group
was created.

600 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Step 3. Specifying CSV File
At this step of the wizard, specify a file that defines a list of computers that you want to add to the protection
group. You must specify a list of computers in a file of the CSV or TXT format. The file must be created
beforehand. To learn more, see Preparing CSV File.

To specify a CSV file:

1. In the P a th to file field, click Browse and specify a path to a CSV file that contains a list of IP addresses or
domain names of computers that you want to add to the protection group. The CSV file can reside in a
folder on the local drive of the Veeam backup server or in a network shared folder accessible from the
backup server.

2. In the Computers field, review the list of IP addresses or domain names imported from the CSV file.

NOTE

After you finish configuring the protection group, Veeam Backup & Replication will perform discovery of
computers listed in the CSV file upon schedule defined in the protection group settings. If Veeam Backup &
Replication is unable to read the CSV file (for example, after the file was moved or deleted from the
specified location), the rescan job will use the list of computers imported from the CSV file during the
previous rescan job session.

Preparing CSV File

To define a dynamic protection scope based on a list of computers, you must create a CSV file with a list of IP
addresses or domain names to scan during discovery. Veeam Backup & Replication supports IP addresses of IPv4
and IPv6 formats.

Delimit IP addresses or domain names in the list with commas (' ,') or semicolons (';'). For example:

172.17.53.16,172.17.53.19,172.17.53.31,172.17.53.40

601 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Alternatively, you can delimit IP addresses or domain names in the list with the newline character:

172.17.53.16
172.17.53.19
172.17.53.31
172.17.53.40

602 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 4. Specify Credentials
At this step of the wizard, specify credentials to connect to computers included in the protection group:

1. If you want to use the same credentials for all computers in the protection group, select the necessary
user account from the Ma ster a ccount list. The account must have local administrator permissions on all
computers that you have added to the protection group.

If you have not set up credentials beforehand, click the Ma nage accounts link or click Ad d on the right to
add credentials. For more information, see the Credentials Manager section in the Veeam Backup &
Replication User Guide.

2. By default, Veeam Backup & Replication uses credentials specified in the Ma ster account field for all
computers in the protection group. If some computer requires a different user account, do the following:

a. Select the Use custom credentials for the following objects check box.

b. Click Ad d next to the list of objects and select the necessary object in the Ad d Objects window.

You can select in the Ad d Objects window one or more computers listed in a CSV file and add them to
the Use custom credentials for the following objects list.

c. In the Use custom credentials for the following objects list, select the necessary object, click E d it and
select custom credentials for the object. Credentials must be specified in the following format:
Username or HOST\Username

NOTE

Consider the following:

• Veeam Backup & Replication supports user account names in the SAM-Account-Name format
(DOMAIN\Username). The User-Principal-Name (UPN) format ( username@domain) is not supported.
If you specify credentials in the UPN format, Veeam Backup & Replication will successfully connect
to computers added to the protection group during the Test Now operation. However, the
subsequent protection group rescan operations will fail.
• The account that you use to connect to a Linux computer must have a home directory on this
computer.
• If you plan to back up Oracle databases that run on Linux computers, the OS account used to
connect to the computer must be a member of the group that owns configuration files of the Oracle
database (for example, the oinstall group).

603 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

To check if Veeam Backup & Replication can connect to computers added to the protection group, click Test
Now. Veeam Backup & Replication will form a list of computers to connect and use the specified credentials to
connect to computers in the list.

604 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Step 5. Specify Discovery and Deployment Options
At the Op tions step of the wizard, specify settings for protected computers discovery and Veeam Plug-in
deployment.

Veeam Backup & Replication regularly connects to protected computers according to the schedule defined in
the protection group settings. At this step of the wizard, you can define the discovery schedule and spec ify
operations that Veeam Backup & Replication must perform on discovered computers. You can also select which
server in your backup infrastructure should act as a distribution server for Veeam Plug -ins.

To specify discovery and deployment options:

1. In the Discovery section, define schedule for automatic computer discovery within the scope of the
protection group:

o To run the rescan job at specific time daily, on defined week days or with specific periodicity, select
Da ily at this time. Use the fields on the right to configure the necessary schedule.

o To run the rescan job repeatedly throughout a day with a specific time interval, select P eriodically
every. In the field on the right, select the necessary time unit: Hours or Minutes. Click Schedule and
use the time table to define the permitted time window for the rescan job. In the Sta rt time within an
hour field, specify the exact time when the job must start.

o To run the rescan job continuously, select the P eriodically every option and choose Continuously from
the list on the right. A new rescan job session will start as soon as the previous rescan job session
finishes.

NOTE

You cannot create a protection group without defining schedule for automatic discovery. However,
you can disable automatic discovery for a specific protection group, if needed. To learn more, see
Disabling Protection Group.

2. In the Dep loyment section, select the object that will be responsible for the Veeam Plug -ins distribution,
select a Microsoft Windows server that you plan to use as a distribution server. Veeam Backup &
Replication will use the distribution server to upload Veeam Plug -in setup files to computers added to the
protection group. By default, Veeam Backup & Replication assigns the distribution server role to the
backup server. To learn more, see Distribution Server.

3. Make sure that the Install backup agent check box is clear. Otherwise, Veeam Backup & Replication will
install Veeam Agent on the target computer.

TIP

To learn how to use protection groups to automatically deploy Veeam Agents, see Veeam Agent
Management Guide.

4. If you want to instruct Veeam Backup & Replication to automatically deploy Veeam Plug -ins on all
discovered computers in the protection group, in the Deployment section, make sure that the Install
a p plication plug-ins: configure plug-ins to be installed check box is selected and click Configure. In the
Ap p lication Plug-ins window, select the check boxes next to the plug-ins that you want to install.

605 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 NOTE

[For Veeam Plug-in for SAP on Oracle] if you plan to use the rman_util parameter, you must install
2 plug-ins on the Oracle server:

• Veeam Plug-in for Oracle RMAN

• Veeam Plug-in for SAP on Oracle
You can also choose to disable automated Veeam Plug -in installation. To do this, in the Ap p lication P lug-
ins window, clear the check boxes next to the plug-ins that you do not want Veeam Backup & Replication
to install. In this case, you will need to install Veeam Plug-in on every computer included in the protection
group and discovered by Veeam Backup & Replication. To learn more, see Installing Plug-in.

5. If you want to instruct Veeam Backup & Replication to automatically up grade Veeam Plug-ins on
discovered computers when a new version of the product appears on the distribution server, in the
Dep loyment section, make sure that the Auto-update backup agents and plug-ins check box is selected.

6. Select the P erform reboot automatically if required check box to allow Veeam Backup & Replication to
reboot a protected computer.

7. Click Ad vanced to specify advanced settings for the protection group. To learn more, see Specify
Advanced Protection Group Settings.

606 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 6. Specify Advanced Protection Group Settings
You can specify email notification settings for the protection group. If you enable notification settings, Veeam
Backup & Replication will send a daily email report with protection group statis tics to a specified email address.
The report contains cumulative statistics for rescan job sessions performed for the protection group within the
last 24-hour period.

NOTE

Email reports with protection group statistics will be sent only if you configure global email notification
settings in Veeam Backup & Replication. For more information, see the Configuring Global Email
Notification Settings section in the Veeam Backup & Replication User Guide.

After you enable notification settings for the protection group, in addition to reports sent according to the
global email notification settings, Veeam Backup & Replication will send reports with the protection group
statistics to email addresses specified in the protection group settings. This allows you to fine -tune email
notifications in Veeam Backup & Replication: while one or more backup administrators receive email
notifications according to the global settings, other backup administrators can receive reports for specific
protection groups only.

If you do not enable global email notification settings in Veeam Backup & Replication, notification settings
for the protection group will not be sent even if you enable them in the protection group settings.

To specify notification settings for the protection group:

1. At the Op tions step of the wizard, click Ad vanced.

2. Click the Notifications tab.

3. Select the Send daily agent status report e -mail to the following recipients check box and specify a
recipient email address. You can enter several addresses separated by a semicolon.

4. In the Send daily summary at field, specify the time when Veeam Backup & Replication must send the daily
email report for the protection group.

5. You can choose to use global notification settings or specify custom notification settings.

To receive a typical notification for the protection group, select Use global notification settings. In this
case, Veeam Backup & Replication will apply to the protection group global email notification settings
specified for the backup server.

To configure a custom notification for the protection group, select Use custom notification settings
sp ecified below. You can specify the following notification settings:

o In the Sub ject field, specify a notification subject. You can use the following variables in the subject:

▪ %JobResult% — rescan job result.

▪ %PGName% — protection group name.

▪ %FoundCount% — number of new computers discovered within the last 24-hour period.

▪ %TotalCount% — total number of computers in the protection group.

▪ %SeenCount% — number of computers in the protection group that were online for the last 24
hours. A computer is considered to be online if Veeam Backup & Replication successfully
connected to this computer during the last rescan session.

o You can select one of the following notification triggers for the protection group rescan job:

607 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 ▪ Notify on success — when the job completes successfully.

▪ Notify on warning — when the job completes with a warning.

▪ Notify on error — when the job fails.

608 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 7. Review Components
At the Review step of the wizard, review what Veeam Backup & Replication components are already installed on
the distribution server specified for the protection group and what components will be installed.

1. Review the components.

2. Click Ap p ly to add the configured protection group to the inventory.

NOTE

Veeam Plug-in and Veeam Agent components are installed on the distribution server even if the Install
a p plication plug-ins and Install backup agent check boxes are clear at the Options step of the wizard.

609 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 8. Assess Results
At the Ap p ly step of the wizard, Veeam Backup & Replication will create the configured protection group. Wait
for the operation to complete and click Nex t to continue.

610 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Step 9. Finish Working with Wizard
At the Summary step of the wizard, complete the protection group configuration process.

1. Review information about the created protection group.

2. To start the rescan job after you close the wizard, make sure that the Run d iscovery when I click Finish
option is selected.

If you want to perform computer discovery later, you can clear the Run d iscovery when I click Finish check
box. In this case, the rescan job will start automatically upon the defined schedule. You can also start the
rescan job manually at any time you need. To learn more, see Rescanning Protection Group.

3. Click Finish to close the wizard.

What You Do Next

After you create a protection group, Veeam Backup & Replication automatically rescans computers that y ou
added to the created protection group and deploys Veeam Plug -ins on these computers. To learn more, see
Rescan Job.

After the rescan process completes and Veeam Plug-ins are successfully deployed on target computers, you ca n
create the application backup policy. Application backup policies allow you to protect computers in the
protection group. To learn more, see Working with Application Policies.

611 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Editing Protection Group Settings
You can edit the settings of a protection group. This operation may be required, if you want to add/remove
computers to/from a protection group or change settings for protected computers discovery and Veeam
components deployment defined in the properties of the protection group.

NOTE

Consider the following:

• You cannot change the type of a protection group when editing protection group settings.
• For the Manually Added protection group, you can change only a limited number of settings. In
particular, you can edit protected computers discovery and Veeam components deployment options
(except for changing the distribution server for the protection group). You can also remove from this
protection group computers that are no longer included in an application backup policy.
• You cannot edit settings of default protection groups that act as filters used to display protected
computers of a specific type: Unmanaged , Out of Date, Offline and Untrusted .

To edit protection group settings:

1. Open the Inventory view.

2. In the inventory pane, expand the P hy sical Infrastructure node.

3. In the inventory pane, select the protection group that you want to edit and click E d it Group on the ribbon
or right-click the protection group that you want to edit and select P roperties.

4. Edit protection group settings as required.

612 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Rescanning Protection Group
When you perform protection group rescan, you manually start the discovery process for the protection group.
This operation may be required, for example, if you want to discover new computers added to the protection
group without waiting for the next rescan.

During the rescan operation, Veeam Backup & Replication starts the rescan job in the same way as in case of
scheduled discovery. The rescan job connects to computers included in the protection group and performs on
these computers operations specified in the protection group settings. For example, if Veeam Backup &
Replication is set up to automatically install Veeam Plug-in or Veeam Agent on protected computers during
discovery, you can use the rescan operation to deploy Veeam components to computers that have appeared in
the protection group after the previous scheduled rescan job session finished.

To rescan a protection group:

1. Open the Inventory view.

2. In the inventory pane, expand the P hy sical Infrastructure node.

3. In the inventory pane, select the necessary protection group and click Rescan on the ribbon or right-click
the protection group and select Rescan.

613 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Assigning Location to Protection Group
You can assign a location to a protection group configured in Veeam Backup & Replication. To assign a location:

1. Open the Inventory view.

2. In the inventory pane, expand the P hy sical Infrastructure node.

3. In the inventory pane, select the necessary protection group and click Location > <Location name> on the
ribbon or right-click the necessary protection group and select Loca tion > <Location name> .

To learn more about locations, see the Locations section in the Veeam Backup & Replication User Guide.

614 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Disabling Protection Group
You can temporary disable a protection group. When you disable a protection group, you disable scheduled
discovery of protected computers added to this protection group. This may be required, for example, if a new
version of Veeam Agent or Veeam Plug-in appears on the Veeam Backup & Replication server, and you do not
want to deploy a new version of the product to all protected computers at once. Instead, you can disable the
protection group, test the deployment process on a specific computer in this group, and then enable the
protection group to let Veeam Backup & Replication deploy a new version of the product to remaining
computers.

When you disable a protection group, Veeam Backup & Replication does not start the rescan job upon schedule
defined in the protection group settings. However, you can start the discovery process manually. To learn more,
see Rescanning Protection Group.

Disabling a protection group does not affect processing of computers included in this protection group. If a
protected computer is added to an application policy, and the application policy is scheduled to start at the time
when the protection group is in the disabled state, the policy will run as usual.

NOTE

You cannot disable default protection groups that act as filters used to display protected computers of a
specific type: Unmanaged , Out of Date, Offline and Untrusted .

To disable automatic discovery for the protection group:

1. Open the Inventory view.

2. In the inventory pane, expand the P hy sical Infrastructure node.

3. In the inventory pane, select the necessary protection group and click Disable on the ribbon or right-click
the necessary protection group and select Disable.

To enable automatic discovery for the protection group:

1. Open the Inventory view.

2. In the inventory pane, expand the P hy sical Infrastructure node.

615 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 3. In the inventory pane, select the necessary protection group and click E nable on the ribbon or right-click
the necessary protection group and select E na ble.

616 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Removing Protection Group
When you remove a protection group, you can instruct Veeam Backup & Replication to remove Veeam
components from all protected computers included in this protection group, too. The protection group is
removed permanently. You cannot undo this operation.

Backups created for computers that were included in the removed protection group remain intact in the backup
location. You can delete this backup data manually later if needed.

NOTE

Consider the following:

• You cannot remove a protection group if the entire protection group or a computer included in this
protection group is added to an application backup policy, Veeam Agent backup job or policy.
• You cannot remove default protection groups, such as Unmanaged , Out of Date and so on.

To remove a protection group:

1. Open the Inventory view.

2. In the inventory pane, expand the P hy sical Infrastructure node.

3. In the inventory pane, select the protection group that you want to remove and click Remove Group on
the ribbon or right-click the protection group and select Remove.

4. If you want to remove Veeam components deployed on protected computers, in the displayed window,
select the Uninstall Everything check box. With this option selected, Veeam Backup & Replication will
remove the protection group from the configuration database and, in addition, uninstall Veeam Plug -ins
and Veeam Agents and other Veeam components from every computer in the deleted p rotection group.

5. In the displayed window, click Y es .

617 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 TIP

You can also remove individual computers from protection groups. For details, see Removing Computer
from Protection Group.

618 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Working with Application Policies
Veeam Backup & Replication allows you to create application backup policies and jobs for the following Veeam
Plug-ins:

• Creating SAP HANA Backup Policy

• Creating Oracle RMAN Backup Policy

• Creating SAP on Oracle Backup Policy

After you configured an application backup policy in Veeam Backup & Replication, you can manage it in Veeam
Backup & Replication as well. To learn more, see Managing Application Backup Policies.

619 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Creating SAP HANA Backup Policy
To back up databases protected with Veeam Plug-in for SAP HANA, you must configure an application backup
policy in Veeam Backup & Replication.

Before You Begin

Before you create an application backup policy in the Veeam Backup & Replication console, check the following
prerequisites:

• The Veeam Backup & Replication license must have a sufficient number of instances to process computers
that you plan to add to the application backup policy.

• The target location where you plan to store backup files must have enough free space.

• Protection groups that you want to add to the policy must be configured in advance.

• The saphostcrl (SAP Host Agent) utility must be installed in advance on computers with databases that
you want to protect. With this utility, Veeam Plug-in gets the list of database instances. To learn more,
see Database Detection.

Application backup policies have the following limitations:

• One backup object (computer, database system, or database) can be added only to one application backup
policy. Otherwise, the application backup policy will fail.

• You can create application backups on a Veeam backup repository. If you want to save backups in other
target locations, you must configure backup job on the computer side.

• After you start managing a Veeam Plug-in with Veeam Backup & Replication, data backup for the
computer is performed by a backup policy configured in Veeam Backup & Replication. Veeam Plug -in
running on the computer starts a new backup chain on a target location specified in the backup policy
settings. You cannot continue the existing backup chain that was created by Veeam Plug -in operating in
the standalone mode.

620 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 1. Launch New Application Backup Policy Wizard
To create an application policy for Veeam Plug-in for SAP HANA, you must launch the New Application Backup
P olicy wizard. To do this, on the Home tab, click Ba ckup Job > Application > SAP HANA.

621 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 2. Specify Policy Name
At the Na me step of the wizard, specify a name and description for the application backup policy.

1. In the Na me field, enter a name for the application backup policy.

2. In the Description field, provide a description for future reference. The default description contains
information about the user who created the job, date and time when the job was created.

622 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 3. Specify Databases
At the Da tabases step of the wizard, select protection groups, computers, database systems or individual
databases whose data you want to back up.

You can add to the backup scope one or more objects added to inventory in the Veeam Backup & Replication
console.

Application policies with protection groups are dynamic in their nature. If Veeam Backup & Replication discovers
a new computer in a protection group after the policy is created, Veeam Backup & Replication will automatically
update the policy settings to include the added computer.

Adding Objects from Inventory

To add objects to the application backup policy:

1. Click Ad d .

2. In the Select Objects window, select one or more objects in the list and click OK. You can select any of the
following objects:

o Protection group

o Cluster

o Computer

o SAP system

o SAP database

You can press and hold [Ctrl] to select multiple objects at once.

NOTE

In the Select Objects window, Veeam Backup & Replication shows only those computers on which Veeam
Backup & Replication have detected SAP systems during the rescan job. To learn more, see Rescan Job.

To quickly find the necessary object, use the search field at the bottom of the Select Objects window.

1. Enter the object name or a part of it in the search field.

623 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 2. Click the Sta rt search button on the right or press [E nter].

Excluding Objects
You can exclude protection groups, individual computers or databases from the backup scope of the application
backup policy. This may be useful if you want to back up a certain database with another application backup
policy.

To exclude protection groups, individual computers or databases from the backup scope:

3. Click E x clusions.

4. In the E x clusions window, select one or more objects in the list and click OK. You can select any of the
following objects:

o Computer

o Cluster

o SAP system

o SAP database

You can press and hold [Ctrl] to select multiple objects at once.

624 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 NOTE

In the E x clusions window, Veeam Backup & Replication shows only those objects which were already added
to the backup scope. To learn more, see Adding Objects from Inventory.

625 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 4. Specify Storage Settings
At the Storage step of the wizard, specify settings for the target backup repository:

1. From the Ba ckup repository list, select a backup repository where you want to store backups. You can
select from the Veeam backup repositories configured on the backup server that will manage the created
backup policy.

2. In the Retention Policy field, specify the number of days for which you want to store backup files in the
target location. By default, Veeam Backup & Replication keeps backup files for 7 days. After this period is
over, Veeam Backup & Replication will remove the earliest restore points from the backup chain.

3. Click Ad vanced to specify advanced settings for the backup job. To learn more, see Specify Advanced
Backup Settings.

626 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 5. Specify Advanced Backup Settings
In the Advanced Settings window, you can specify advanced settings for the application backup policy:

• Backup settings

• Notification settings

• SAP HANA settings

TIP

After you specify necessary settings for the application backup policy, you can save them as default
settings. To do this, click Sa ve as Default at the bottom left corner of the Ad vanced Settings window.
When you create a new backup policy, Veeam Backup & Replication will automatically apply the default
settings to the new policy.

Backup Settings
To specify settings for a backup chain created with the backup policy:

1. At the Storage step of the wizard, click Ad vanced.

2. Click the Ba ckup tab.

3. In the Ba ckup mode, select one of the following modes for incremental backups:

o Incremental backup. In this mode, Veeam Backup & Replication will create a backup of data changed
since the last incremental data backup.

o Differential backup. In this mode, Veeam Backup & Replication will create a backup of data changed
since the last full data backup.

4. To define the schedule for complete backups, click Configure and define the schedule in the Schedule
Settings window:

o To run the complete backup once a month on specific days, select Monthly on. Use the fields on the
right to configure the necessary schedule.

627 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 o To run the complete backup once a week on specific week days, select W eekly. Use the fields on the
right to select the necessary week days.

Notification Settings
To specify notification settings for the backup policy:

1. At the Storage step of the wizard, click Ad vanced.

2. Click the Notifications tab.

3. Select the Send SNMP notifications for this job check box if you want to receive SNMP traps when the
policy completes successfully.

SNMP traps will be sent if you specify global SNMP settings in Veeam Backup & Replication and configure
software on recipient's machine to receive SNMP traps. For more information, see the Specifying SNMP
Settings section in the Veeam Backup & Replication User Guide.

4. Select the Send email notifications to the follow ing recipients check box if you want to receive
notifications about the policy completion status by email. In the field below, specify a recipient email
address. You can enter several addresses separated by a semicolon.

Email notifications will be sent if you configure global email notification settings in Veeam Backup &
Replication. For more information, see the Configuring Global Email Notification Settings section in Veeam
Backup & Replication User Guide.

628 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 5. You can choose to use global notification settings or specify custom notification settings.

o To receive a typical notification for the backup policy, select Use g lobal notification settings. In this
case, Veeam Backup & Replication will apply to the backup policy global email notification settings
specified for the backup server. Veeam Backup & Replication will send the email report containing
backup policy statistics at 8:00 AM daily.

o To configure a custom notification for the backup policy, select Use custom notification settings
sp ecified below. You can specify the following notification settings:

i. In the Sub ject field, specify a notification subject. You can use the following variables in the
subject: %Time% (completion time), %JobName%, %JobResult%, %ObjectCount% (number of
machines in the backup policy) and %Issues% (number of machines in the backup policy that
have been processed with the Warning or Failed status).

ii. Select the Notify on success, Notify on warning and Notify on error check boxes to receive email
notification if the policy completes successfully, completes with a warning or fails.

SAP HANA Settings

To specify SAP HANA settings for the backup policy:

1. At the Storage step of the wizard, click Ad vanced.

2. Click the SAP HANA tab.

629 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 3. In the Cha nnels field, specify the number of data channels that Veeam Plug -in will use in parallel to back
up databases.

630 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 6. Specify Credentials
At the Credentials step of the wizard, specify credentials that Veeam Plug -in will use to connect to the
database:

1. To specify credentials for the OS user, select the database and click OS user. In the OS user credentials
window, select credentials in the list. If you have not set up credentials beforehand, click Ad d on the right
to add credentials.

2. To specify credentials for the database user, select the database and click DB user. In the Da tabase user
credentials window, select credentials in the list. If you have not set up credentials beforehand, click Ad d
on the right to add credentials.

NOTE

Make sure the specified user accounts have the required permissions.

631 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 7. Specify Log Backup Settings
At the Log Backup step of the wizard, specify log processing settings:

1. In the Ob jects list, select the object and click E d it.

2. Specify log processing settings for the objects in the list. To learn more, see Processing settings.

In the Ob jects list, Veeam Backup & Replication shows only those objects that you added to the backup scope at
the Da tabases step of the wizard. If you added a protection group, but need to specify settings for an individual
computer or database in this protection group, you can add such objects to the list. To learn more, see Adding
Objects from Backup Scope.

Adding Objects from Backup Scope

To add protection groups, individual computers or databases to the Ob jects list:

1. Click Ad d .

2. In the Select Objects window, select one or more objects in the list and click OK. You can select any of the
following objects:

o Protection group

o Cluster

o Computer

o SAP system

o SAP database

You can press and hold [Ctrl] to select multiple objects at once.

To quickly find the necessary object, use the search field at the bottom of the Select Objects window.

1. Enter the object name or a part of it in the search field.

632 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 2. Click the Sta rt search button on the right or press [E nter].

Processing Settings
To specify processing settings for the object:

1. At the Log Backup step of the wizard, select the object and click E d it.

2. In the P rocessing tab, select the way you want to back up logs:

o Select Let SAP HANA manage log backup if you want to back up logs with SAP HANA tools.

With SAP HANA tools, you set to back up logs by Veeam Plug -in and set the log backup interval. In
this case Veeam Plug-in will backup logs with parameters specified with SAP HANA tools. You can
also set SAP HANA tools not to back up logs. In this case Veeam Plug -in will not back up logs too.

633 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 o Select P erform log backup with this policy if you want to back up logs with Veeam Plug-in.

In the Ba ckup logs every <N> minutes field, specify the frequency for logs backup. By default, redo
logs are backed up every 15 minutes. The minimum log backup interval is 5 minutes. The maximum log
backup interval is 480 minutes.

634 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 8. Specify Policy Schedule
At the Schedule step of the wizard, specify the schedule according to which you want to perform backup.

To specify the job schedule:

1. Select the Run the job automatically check box. If this check box is not selected, you will have to start the
backup job manually to create backup.

2. Define scheduling settings for the job:

o To run the job at specific time daily, on defined week days or with specific periodicity, select Da ily at
this time. Use the fields on the right to configure the necessary schedule.

o To run the job once a month on specific days, select Monthly at this time. Use the fields on the right
to configure the necessary schedule.

o To run the job repeatedly throughout a day with a specific time interval, select P eriodically every. In
the field on the right, select the necessary time unit: Hours or Minutes.

o To define the permitted time window for the job, click Schedule and use the time table. In the Sta rt
time within an hour field, specify the exact time when the job must start.

A repeatedly run job is started by the following rules:

▪ The defined interval always starts at 12:00 AM. For example, if you configure to run a job with a
4-hour interval, the job will start at 12:00 AM, 4:00 AM, 8:00 AM, 12:00 PM, 4:00 PM and so
on.

▪ If you define permitted hours for the job, after the denied interval is over, the job will start
immediately and then run by the defined schedule.

For example, you have configured a job to run with a 2-hour interval and defined permitted hours
from 9:00 AM to 5:00 PM. According to the rules above, the job will first run at 9:00 AM, when the
denied period is over. After that, the job will run at 10:00 AM, 12:00 PM, 2:00 PM and 4:00 PM.

o To run the job continuously, select the P eriodically every option and choose Continuously from the
list on the right. A new backup job session will start as soon as the previous backup job session
finishes.

o To chain jobs, use the After this job field. In the common practice, jobs start one after another: when
job A finishes, job B starts and so on. If you want to create a chain of jobs, you must define the time
schedule for the first job in the chain. For the rest of the jobs in the chain, select the After this job
option and choose the preceding job from the list.

NOTE

The After this job option will automatically start a job if the first job in the chain is started
automatically by schedule. If you start the first job manually, Veeam Backup & Replication will
display a notification. You will be able to choose whether Veeam Backup & Replication must
start the chained job as well.

3. In the Automatic retry section, define whether Veeam Backup & Replication or Veeam Plug -in (depending
on the selected job mode) must attempt to run the backup job again if the job fails for some reason. Enter
the number of attempts to run the job and define time intervals between them. If you select continuous
backup, Veeam Backup & Replication or Veeam Plug -in will retry the job for the defined number of times
without any time intervals between the job runs.

635 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 4. In the Ba ckup window section, define the time interval within which the backup job must complete. The
backup window prevents the job from overlapping with production hours and ensures that the job does
not impact performance of your server. To set up a backup window for the job:

a. Select the Terminate job if it exceeds allowed backup window check box and click W ind ow.

b. In the Time P eriods window, define the allowed hours and prohibited hours for backup. If the job
exceeds the allowed window, it will be automatically terminated.

NOTE

If you configure a backup policy, after you click Ap p ly at the Schedule step of the wizard, Veeam Backup &
Replication will immediately apply the backup policy to protected computers.

636 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 9. Review Policy Settings
At the Summary step of the wizard, complete the configuration process for the application backup policy.

1. Review settings of the configured backup policy.

2. Select the E na ble the backup policy when I click Finish check box if you want to enable the policy right
after you finish working with the wizard. After that, you can start the policy manually or wait for the
scheduled start.

3. Click Finish to close the wizard.

637 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Creating Oracle RMAN Backup Policy
To back up databases protected with Veeam Plug-in for Oracle RMAN, you must configure an application backup
policy in Veeam Backup & Replication.

Before You Begin

Before you create an application backup policy in the Veeam Backup & Replication console, check the following
prerequisites:

• The Veeam Backup & Replication license must have a sufficient number of instances to process computers
that you plan to add to the application backup policy.

• The target location where you plan to store backup files must have enough free space.

• Protection groups that you want to add to the policy must be configured in advance.

Application backup policies have the following limitations:

• One backup object (computer, database system, or database) can be added only to one application backup
policy. Otherwise, the application backup policy will fail.

• You can create application backups in a Veeam backup repository. If you want to save backups in other
target locations, you must configure backup job on the computer with Veeam Plug -in installed.

• After you start managing a Veeam Plug-in with Veeam Backup & Replication, data backup for the
computer is performed by a backup policy configured in Veeam Backup & Replication. Veeam Plug -in
running on the computer starts a new backup chain on a target location specified in the backup policy
settings. You cannot continue the existing backup chain that was created by Veeam Plug -in operating in
the standalone mode.

• Application backup policy does not support backup of databases in a mounted state. If Veeam Plug -in
detects a database in the mounted state, the application backup policy will finish with an error.

• If your database resides on a Oracle Exadata Database Machine, you may need to adjust the memory limit
(memlock) for Veeam Transport Service. Otherwise, the application backup policy will fail . To learn more,
see this Veeam KB article.

638 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 1. Launch New Application Backup Policy Wizard
To create an application backup policy for Veeam Plug -in for Oracle RMAN, you must launch the New
Ap p lication Backup Policy wizard. To do this, on the Home tab, click Ba ckup Job > Ap plication > Oracle RMAN.

639 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 2. Specify Policy Name
At the Na me step of the wizard, specify a name and description for the application backup policy.

1. In the Na me field, enter a name for the application backup policy.

2. In the Description field, provide a description for future reference. The default description contains
information about the user who created the policy, date and time when the policy was created.

640 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Step 3. Specify Databases
At the Da tabases step of the wizard, select protection groups, computers, database systems or individual
databases whose data you want to back up.

You can add to the backup scope one or more objects added to inventory in the Vee am Backup & Replication
console.

Application policies with protection groups are dynamic in their nature. If Veeam Backup & Replication discovers
a new computer in a protection group after the policy is created, Veeam Backup & Replication will automaticall y
update the policy settings to include the added computer.

Adding Objects from Inventory

To add objects to the application backup policy:

1. Click Ad d .

2. In the Select Objects window, select one or more objects in the list and click OK. You can select any of the
following objects:

o Protection group

o Computer

o Oracle home

o Oracle database

You can press and hold [Ctrl] to select multiple objects at once.

NOTE

In the Select Objects window, Veeam Backup & Replication shows only those computers on which Veeam
Backup & Replication have detected Oracle database systems during the rescan job. To learn more, see
Rescan Job.

To quickly find the necessary object, use the search field at the bottom of the Select Objects window.

1. Enter the object name or a part of it in the search field.

641 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 2. Click the Sta rt search button on the right or press [E nter].

Excluding Objects
You can exclude protection groups, individual computers or databases from the backup scope of the application
backup policy. This may be useful if you want to back up a certain database with another application backup
policy.

To exclude protection groups, individual computers or databases from the backup scope:

3. Click E x clusions.

4. In the E x clusions window, select one or more objects in the list and click OK. You can select any of the
following objects:

o Computer

o Oracle home

o Oracle database

You can press and hold [Ctrl] to select multiple objects at once.

642 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 NOTE

In the E x clusions window, Veeam Backup & Replication shows only those objects which were already added
to the backup scope. To learn more, see Adding Objects from Inventory.

643 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 4. Specify Storage Settings
At the Storage step of the wizard, specify settings for the target backup repository:

1. From the Ba ckup repository list, select a backup repository where you want to store backups. You can
select from the Veeam backup repositories configured on the backup server that will manage the created
backup policy.

2. In the Retention Policy field, specify the number of days for which you want to store backup files in the
target location. By default, Veeam Backup & Replication keeps backup files for 7 days. After this period is
over, Veeam Backup & Replication will remove the earliest restore points from the backup chain.

NOTE

On the computer with Veeam Plug-in, make sure that the value set for the
CONTROL_FILE_RECORD_KEEP_TIME parameter in the control file is greater than the recovery
window. Otherwise, the retention policy will not be applicable as the backup records will be a lways
overwritten earlier than they can be considered obsolete by the retention policy. To learn more, see
this Oracle article (requires an Oracle Support account).

3. Click Ad vanced to specify advanced settings for the backup job. To learn more, see Specify Advanced
Backup Settings.

644 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Step 5. Specify Advanced Backup Settings
In the Ad vanced Settings window, you can specify advanced settings for the application backup policy:

• Backup settings

• Storage settings

• Notification settings

• Oracle settings

TIP

After you specify necessary settings for the application backup policy, you can save them as default
settings. To do this, click Sa ve as Default at the bottom left corner of the Ad vanced Settings window.
When you create a new backup job, Veeam Backup & Replication will automatically apply the default
settings to the new job.

Backup Settings
To specify settings for a backup chain created with the backup policy:

1. At the Storage step of the wizard, click Ad vanced.

2. Click the Ba ckup tab.

3. In the Ba ckup mode, select one of the following modes for incremental backups:

o Differential backup. In this mode, Veeam Backup & Replication will create a backup of data changed
since the last incremental data backup.

o Cumulative backup. In this mode, Veeam Backup & Replication will create a backup of data changed
since the last full data backup.

4. To define the schedule for full backups, click Configure and define the schedule in the Schedule Settings
window:

o To run the full backup once a month on specific days, select Monthly on. Use the fields on the right to
configure the necessary schedule.

645 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 o To run the full backup once a week on specific week days, select W eekly. Use the fields on the right to
select the necessary week days.

Storage Settings
To specify compression settings for the backup job:

1. At the Storage step of the wizard, click Ad vanced.

2. Click the Storage tab.

3. Select the Comp ress data during backup check box and select the way compression is performed:

o Select Veeam compression if you want to perform default data compression with Data Mover by
Veeam Software. If this option selected, Data Mover will use the ZSTD compression algorithm.

646 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 o Select RMAN compression if you want to perform data compression with Oracle RMAN.

If you selected the RMAN compression option, you can also select the compression level.

Notification Settings
To specify notification settings for the backup policy:

1. At the Storage step of the wizard, click Ad vanced.

2. Click the Notifications tab.

3. Select the Send SNMP notifications for this job check box if you want to receive SNMP traps when the job
completes successfully.

SNMP traps will be sent if you specify global SNMP settings in Veeam Backup & Replication and configure
software on recipient's machine to receive SNMP traps. For more information, see the Specifying SNMP
Settings section in the Veeam Backup & Replication User Guide.

4. Select the Send email notifications to the following recipients check box if you want to receive
notifications about the job completion status by email. In the field below, specify a recipient email
address. You can enter several addresses separated by a semicolon.

Email notifications will be sent if you configure global email notification settings in Veeam Backup &
Replication. For more information, see the Configuring Global Email Notification Settings section in Veeam
Backup & Replication User Guide.

647 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 5. You can choose to use global notification settings or specify custom notification settings.

o To receive a typical notification for the backup policy, select Use g lobal notification settings. In this
case, Veeam Backup & Replication will apply to the backup policy global email notification settings
specified for the backup server. Veeam Backup & Replication will send the email report containing
backup policy statistics at 8:00 AM daily.

o To configure a custom notification for the backup policy, select Use custom notification settings
sp ecified below. You can specify the following notification settings:

i. In the Sub ject field, specify a notification subject. You can use the following variables in the
subject: %Time% (completion time), %JobName%, %JobResult%, %ObjectCount% (number of
machines in the backup policy) and %Issues% (number of machines in the backup policy that
have been processed with the Warning or Failed status).

ii. Select the Notify on success, Notify on warning and Notify on error check boxes to receive email
notification if the policy completes successfully, completes with a warning or fails.

Oracle Settings
To specify Oracle settings for the backup policy:

1. At the Storage step of the wizard, click Ad vanced.

2. Click the Ora cle tab.

648 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 3. In the RMAN channels field, specify the number of data channels that Veeam Plug -in will use in parallel to
back up databases.

649 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 6. Specify Database Processing Settings
At the Da tabase Processing step of the wizard, specify database credentials and log processing settings:

1. In the Credentials list, select the object and click E d it.

2. Specify database credentials and log processing settings for the objects in the list:

o Processing settings

o [Only for databases] Pluggable database settings

In the Credentials list, Veeam Backup & Replication shows only those objects that you added to the backup
scope at the Da tabases step of the wizard. If you added a protection group, but need to specify settings for an
individual computer or database in this protection group, you can add such objects to the list. To learn more, see
Adding Objects from Backup Scope.

Adding Objects from Backup Scope

To add individual computers or databases to the Credentials list:

1. Click Ad d .

2. In the Select Objects window, select one or more objects in the list and click OK. You can select any of the
following objects:

o Computer

o Oracle home

o Oracle database

You can press and hold [Ctrl] to select multiple objects at once.

To quickly find the necessary object, use the search field at the bottom of the Select Objects window.

1. Enter the object name or a part of it in the search field.

650 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 2. Click the Sta rt search button on the right or press [E nter].

Processing Settings
To specify processing settings:

1. At the Da tabase Processing step of the wizard, select the object in the Credentials list and click E d it.

2. In the P rocessing settings window, select the preferred authentication mode from the Select
a uthentication mode list:

o Op erating system authentication

With this authentication method, Veeam Backup & Replication uses the OS user credentials to connect
to the Oracle server. Then, Veeam Plug-in starts Oracle Recovery Manager (RMAN) using the OS user
credentials. After that, RMAN uses the OS user credentials to connect to the Oracle database.

To set the operating system authentication, from the Sp ecify OS user credentials with SYSDBA
p rivileges list, select an OS user account with SYSDBA permissions on the database. The OS user
account must be a user on the Oracle server with the required permissions to run RMAN.

If you have not set up credentials beforehand, click the Ma nage accounts link or click Ad d on the right
to add credentials. For more information, see the Credentials Manager section in the Veeam Backup &
Replication User Guide.

651 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 NOTE

Make sure the specified OS user account has the required permissions.

o Da tabase authentication

With this authentication method, Veeam Backup & Replication uses the OS user credentials to connect
to the Oracle server. Then, Veeam Plug-in starts RMAN using the OS user credentials. After that,
RMAN uses the database user credentials to connect to the Oracle database. This process ensures that
the database access is separate from the OS user access rights.

To set the database authentication, do the following:

i. From the Sp ecify OS user credentials to connect to the server list, select an OS user account that
Veeam Plug-in will use to connect to the Oracle server. The OS user account must be a user on
the Oracle server with the required permissions to run RMAN.

652 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 ii. From the Sp ecify database user credentials list, select a database user account. The database
user account must have the SYSBACKUP permission on the database. To learn more about Oracle
permissions, see this Oracle article.

If you have not set up credentials beforehand, click the Ma nage accounts link or click Ad d on the right
to add credentials. For more information, see the Credentials Manager section in the Veeam Backup &
Replication User Guide.

3. In the Archived logs section, specify if Veeam Plug-in must delete archived logs for the Oracle database:

o Select Do not d elete archived redo logs if you want Veeam Plug-in to preserve archived logs. When
the backup job completes, Veeam Plug-in will not delete archived logs.

Keep in mind that with the ARCHIVELOG mode turned on, archived logs may grow large and consume
all disk space. In this case, the database administrator must take care of archived logs him -/herself.

o Select Delete archived redo logs that were backed up if you want Veeam Plug-in back up logs and
delete logs from the database after the backup operation. Veeam Plug -in will wait for the backup job
to complete successfully and then trigger archived logs truncation using Oracle Call Interface (OCI). If
the backup job fails, the logs will remain untouched until the next successful backup job session.

In the Ba ckup archived redo logs every <N> minutes field, specify the frequency for archived logs
backup. By default, archived logs are backed up every 15 minutes. The minimum log backup interval is
1 minute. The maximum log backup interval is 480 minutes.

4. In the P a rallel processing section, specify the number of data channels that Veeam Plug -in will use in
parallel to back up logs.

Pluggable Database Settings

The P luggable Databases tab is available if you selected an individual database in the Credentials list at the
Da tabase Processing step of the wizard.

To specify settings for pluggable database (PDB) processing:

1. At the Da tabase Processing step of the wizard, select the object in the Credentials list and click E d it.

2. In the P rocessing tab, set credentials for pluggable databases.

3. In the P rocessing Settings window, click the P luggable Databases tab.

653 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 4. Select which pluggable databases you want to process:

o All PDBs — select this option if you want to process all detected pluggable databases.

o All PDBs except — select this option if you want to process all detected pluggable databases
excluding the databases that you specify. Click Add to add the necessary databases or wildcards to
the list.

o Only the following PDBs — select this option if you want to process only those pluggable databases
that you specify. Click Add to add the necessary databases or wildcards to the list.

654 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 7. Specify Policy Schedule
At the Schedule step of the wizard, specify the schedule according to which you want to perform backup.

To specify the job schedule:

1. Select the Run the job automatically check box. If this check box is not selected, you will have to start the
backup job manually to create backup.

2. Define scheduling settings for the job:

o To run the job at specific time daily, on defined week days or with specific periodicity, select Da ily at
this time. Use the fields on the right to configure the necessary schedule.

o To run the job once a month on specific days, select Monthly at this time. Use the fields on the right
to configure the necessary schedule.

o To run the job repeatedly throughout a day with a specific time interval, select P eriodically every. In
the field on the right, select the necessary time unit: Hours or Minutes.

o To define the permitted time window for the job, click Schedule and use the time table. In the Sta rt
time within an hour field, specify the exact time when the job must start.

A repeatedly run job is started by the following rules:

▪ The defined interval always starts at 12:00 AM. For example, if you configure to run a job with a
4-hour interval, the job will start at 12:00 AM, 4:00 AM, 8:00 AM, 12:00 PM, 4:00 PM and so
on.

▪ If you define permitted hours for the job, after the denied interval is over, the job will start
immediately and then run by the defined schedule.

For example, you have configured a job to run with a 2-hour interval and defined permitted hours
from 9:00 AM to 5:00 PM. According to the rules above, the job will first run at 9:00 AM, when the
denied period is over. After that, the job will run at 10:00 AM, 12:00 PM, 2:00 PM and 4:00 PM.

o To run the job continuously, select the P eriodically every option and choose Continuously from the
list on the right. A new backup job session will start as soon as the previous backup job session
finishes.

o To chain jobs, use the After this job field. In the common practice, jobs start one after another: when
job A finishes, job B starts and so on. If you want to create a chain of jobs, you must define the time
schedule for the first job in the chain. For the rest of the jobs in the chain, select the After this job
option and choose the preceding job from the list.

NOTE

The After this job option will automatically start a job if the first job in the chain is started
automatically by schedule. If you start the first job manually, Veeam Backup & Replication will
display a notification. You will be able to choose whether Veeam Backup & Replication must
start the chained job as well.

3. In the Automatic retry section, define whether Veeam Backup & Replication or Veeam Plug -in (depending
on the selected job mode) must attempt to run the backup job again if the job fails for some reason. Enter
the number of attempts to run the job and define time intervals between them. If you select continuous
backup, Veeam Backup & Replication or Veeam Plug -in will retry the job for the defined number of times
without any time intervals between the job runs.

655 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 4. In the Ba ckup window section, define the time interval within which the backup job must complete. The
backup window prevents the job from overlapping with production hours and ensures that the job does
not impact performance of your server. To set up a backup window for the job:

a. Select the Terminate job if it exceeds allowed backup window check box and click W ind ow.

b. In the Time P eriods window, define the allowed hours and prohibited hours for backup. If the job
exceeds the allowed window, it will be automatically terminated.

NOTE

If you configure a backup policy, after you click Ap p ly at the Schedule step of the wizard, Veeam Backup &
Replication will immediately apply the backup policy to protected computers.

656 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 8. Review Policy Settings
At the Summary step of the wizard, complete the configuration process for the application backup policy.

1. Review settings of the configured backup policy.

2. Select the E na ble the backup policy when I click Finish check box if you want to enable the policy right
after you finish working with the wizard. After that, you can start the policy manually or wait for the
scheduled start.

3. Click Finish to close the wizard.

657 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Creating SAP on Oracle Backup Policy
To back up databases protected with Veeam Plug-in for SAP on Oracle, you must configure an application
backup policy in Veeam Backup & Replication.

Before You Begin

Before you create an application backup policy in the Veeam Backup & Replication console, check the following
prerequisites:

• The Veeam Backup & Replication license must have a sufficient number of instances to process computers
that you plan to add to the application backup policy.

• The target location where you plan to store backup files must have enough free space.

• Protection groups that you want to add to the policy must be configured in advance.

• The saphostcrl (SAP Host Agent) utility must be installed in advance on computers with databases that
you want to protect. With this utility, Veeam Plug-in gets the list of database instances. To learn more,
see Database Detection.

Application backup policies have the following limitations:

• One backup object (computer, database system, or database) can be added only to one application backup
policy. Otherwise, the application backup policy will fail.

• You can create application backups on a Veeam backup repository. If you want to save backups in other
target locations, you must configure backup job on the computer side.

• After you start managing a Veeam Plug-in with Veeam Backup & Replication, data backup for the
computer is performed by a backup policy configured in Veeam Backup & Replication. Veeam Plug -in
running on the computer starts a new backup chain on a target location specified in the backup policy
settings. You cannot continue the existing backup chain that was created by Veeam Plug-in operating in
the standalone mode.

• Veeam Plug-in may not be able to detect SAP instances during the configuration if the Oracle Database
and SAP central instance are running on different hosts. If you work with Veeam Plug -in in the managed
mode, this configuration is not supported. If you work with Veeam Plug-in in the standalone operation
mode, see Configuring Plug-in for SAP on Oracle.

• An application backup policy cannot back up Oracle installations with SAP BR*Tools user and password in
secure storage. If you work with Veeam Plug-in in the managed mode, this configuration is not supported.

658 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 1. Launch New Application Backup Policy Wizard
To create an application policy for Veeam Plug-in for SAP on Oracle, you must launch the New Application
Ba ckup P olicy wizard. To do this, on the Home tab, click Ba ckup Job > Ap plication > SAP on Oracle.

659 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 2. Specify Policy Name
At the Na me step of the wizard, specify a name and description for the application backup policy.

1. In the Na me field, enter a name for the application backup policy.

2. In the Description field, provide a description for future reference. The default description contains
information about the user who created the job, date and time when the job was created.

3. In the P olicy mode field, select the job mode. You can select one of the following modes:

o Use BR*Tools with RMAN (rman_util mode)

o Use BR*Tools with BACKINT (util_file_online mode)

660 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 3. Specify Databases
At the Da tabases step of the wizard, select protection groups, computers, database systems or individual
databases whose data you want to back up.

You can add to the backup scope one or more objects added to inventory in the Veeam Backup & Replication
console.

Application policies with protection groups are dynamic in their nature. If Veeam Backup & Replication discovers
a new computer in a protection group after the policy is created, Veeam Backup & Replication will automatically
update the policy settings to include the added computer.

Adding Objects from Inventory

To add objects to the application backup policy:

1. Click Ad d .

2. In the Select Objects window, select one or more objects in the list and click OK. You can select any of the
following objects:

o Protection group

o Computer

o Oracle home

o Oracle database

You can press and hold [Ctrl] to select multiple objects at once.

NOTE

In the Select Objects window, Veeam Backup & Replication shows only those computers on which Veeam
Backup & Replication have detected Oracle database systems during the rescan job. To learn more, see
Rescan Job.

To quickly find the necessary object, use the search field at the bottom of the Select Objects window.

1. Enter the object name or a part of it in the search field.

661 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 2. Click the Sta rt search button on the right or press [E nter].

Excluding Objects
You can exclude protection groups, individual computers or databases from the backup scope of the application
backup policy. This may be useful if you want to back up a certain database with another application backup
policy.

To exclude protection groups, individual computers or databases from the backup scope:

3. Click E x clusions.

4. In the E x clusions window, select one or more objects in the list and click OK. You can select any of the
following objects:

o Computer

o Oracle home

o Oracle database

You can press and hold [Ctrl] to select multiple objects at once.

NOTE

In the E x clusions window, Veeam Backup & Replication shows only those objects which were already added
to the backup scope. To learn more, see Adding Objects from Inventory.

662 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 4. Specify Storage Settings
At the Storage step of the wizard, specify settings for the target backup repository:

1. From the Ba ckup repository list, select a backup repository where you want to store backups. You can
select from the Veeam backup repositories configured on the backup server that will manage the created
backup policy.

2. In the Retention Policy field, specify the number of days for which you want to store backup files in the
target location. By default, Veeam Backup & Replication keeps backup files for 7 days. After this period is
over, Veeam Backup & Replication will remove the earliest restore points from the backup chain.

3. Click Ad vanced to specify advanced settings for the backup job. To learn more, see Specify Advanced
Backup Settings.

663 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 5. Specify Advanced Backup Settings
In the Ad vanced Settings window, you can specify advanced settings for the application backup policy:

• Backup settings

• Storage settings

• Notification settings

• Oracle settings

TIP

After you specify necessary settings for the application backup policy, you can save them as default
settings. To do this, click Sa ve as Default at the bottom left corner of the Ad vanced Settings window.
When you create a new backup policy, Veeam Backup & Replication will automatically apply the default
settings to the new policy.

Backup Settings
To specify settings for a backup chain created with the backup policy:

1. In the Ad vanced Settings window, click the Ba ckup tab.

2. To define the schedule for full backups, click Configure and define the schedule in the Schedule Settings
window:

o To run the job once a month on specific days, select Monthly on. Use the fields on the right to
configure the necessary schedule.

664 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 o To run the job once a week on specific week days, select W eekly. Use the fields on the right to select
the necessary week days.

Storage Settings
To specify compression settings for the backup job:

1. In the Ad vanced Settings window, click the Storage tab.

2. Select the Comp ress data during backup check box and select the way compression is performed:

o Select Veeam compression if you want to perform data compression with Data Mover by Veeam
Software.

665 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 o Select RMAN compression if you want to perform data compression with Oracle.

Notification Settings
To specify notification settings for the backup job:

1. In the Ad vanced Settings window, click the Notifications tab.

2. Select the Send SNMP notifications for this job check box if you want to receive SNMP traps when the job
completes successfully.

SNMP traps will be sent if you specify global SNMP settings in Veeam Backup & Replication and configure
software on recipient's machine to receive SNMP traps. For more information, see the Specifying SNMP
Settings section in the Veeam Backup & Replication User Guide.

3. Select the Send email notifications to the following recipients check box if you want to receive
notifications about the job completion status by email. In the field below, specify a recipient email
address. You can enter several addresses separated by a semicolon.

Email notifications will be sent if you configure global email notification settings in Veeam Ba ckup &
Replication. For more information, see the Configuring Global Email Notification Settings section in Veeam
Backup & Replication User Guide.

4. You can choose to use global notification settings or specify custom notification settings.

o To receive a typical notification for the backup policy, select Use g lobal notification settings. In this
case, Veeam Backup & Replication will apply to the backup policy global email notification settings
specified for the backup server. Veeam Backup & Replication will send the email report containing
backup policy statistics at 8:00 AM daily.

666 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 o To configure a custom notification for the backup policy, select Use custom notification settings
sp ecified below. You can specify the following notification settings:

i. In the Sub ject field, specify a notification subject. You can use the following variables in the
subject: %Time% (completion time), %JobName%, %JobResult%, %ObjectCount% (number of
machines in the backup policy) and %Issues% (number of machines in the backup policy that
have been processed with the Warning or Failed status).

ii. Select the Notify on success, Notify on warning and Notify on error check boxes to receive email
notification if the policy completes successfully, completes with a warning or fails.

Oracle Settings
To specify Oracle settings for the backup policy:

1. In the Ad vanced Settings window, click the Ora cle tab.

667 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 2. In the RMAN channels field, specify the number of data channels that Veeam Plug -in will use to back up
databases in parallel.

668 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 6. Specify Database Processing Settings
At the Da tabase Processing step of the wizard, specify database credentials and log processing settings:

1. Select the object and click E d it.

2. Specify log processing settings for the objects in the list. To learn more, see Processing settings.

In the list, Veeam Backup & Replication shows only those objects that you added to the backup scope at the
Da tabases step of the wizard. If you added a protection group, but need to specify settings for an individual
computer or database in this protection group, you can add such objects to the list. To learn more, see Adding
Objects from Backup Scope.

Adding Objects from Backup Scope

To add protection groups, individual computers or databases to the Credentials list:

1. Click Ad d .

2. In the Select Objects window, select one or more objects in the list and click OK. You can select any of the
following objects:

o Protection group

o Computer

o Oracle home

o Oracle database

You can press and hold [Ctrl] to select multiple objects at once.

To quickly find the necessary object, use the search field at the bottom of the Select Objects window.

1. Enter the object name or a part of it in the search field.

669 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 2. Click the Sta rt search button on the right or press [E nter].

Processing Settings
To specify processing settings:

1. At the Da tabase Processing step of the wizard, select the object and click E d it.

2. In the P rocessing Settings window, click the P rocessing tab.

3. To specify a user account that Veeam Plug-in will use to connect to the Oracle database, select from the
Sp ecify OS user (for example, ora<dbsid>) who owns data files of the database list a user account that has
SYSDBA rights on the database. If you have not set up credentials beforehand, click the Ma nage accounts
link or click Ad d on the right to add credentials.

4. In the Ba ckup archived redo logs every <N> minutes field, specify the frequency for archived logs backup.
By default, archived logs are backed up every 15 minutes. The minimum log backup interval is 5 minutes.
The maximum log backup interval is 480 minutes.

5. Specify if Veeam Plug-in must delete archived logs for the Oracle database:

o Select Do not d elete offline redo logs if you want Veeam Plug-in to preserve archived logs. When the
backup job completes, Veeam Plug-in will not delete archived logs.
It is recommended that you select this option for databases for which the ARCHIVELOG mode is
turned off. If the ARCHIVELOG mode is turned on, archived logs may grow large and consume all disk
space. In this case, the database administrator must take care of archived logs him-/herself.

670 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 o Select Delete offline redo logs that were backed up if you want Veeam Plug-in back up logs and
delete logs from the database after the backup operation. Veeam Plug -in will wait for the backup job
to complete successfully and then trigger archived logs truncation using Oracle Cal l Interface (OCI). If
the backup job fails, the logs will remain untouched until the next successful backup job session.

671 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Step 7. Specify Policy Schedule
At the Schedule step of the wizard, specify the schedule according to which you want to perform backup.

To specify the job schedule:

1. Select the Run the job automatically check box. If this check box is not selected, you will have to start the
backup job manually to create backup.

2. Define scheduling settings for the job:

o To run the job at specific time daily, on defined week days or with specific periodicity, select Da ily at
this time. Use the fields on the right to configure the necessary schedule.

o To run the job once a month on specific days, select Monthly at this time. Use the fields on the right
to configure the necessary schedule.

o To run the job repeatedly throughout a day with a specific time interval, select P eriodically every. In
the field on the right, select the necessary time unit: Hours or Minutes.

o To define the permitted time window for the job, click Schedule and use the time table. In the Sta rt
time within an hour field, specify the exact time when the job must start.

A repeatedly run job is started by the following rules:

▪ The defined interval always starts at 12:00 AM. For example, if you configure to run a job with a
4-hour interval, the job will start at 12:00 AM, 4:00 AM, 8:00 AM, 12:00 PM, 4:00 PM and so
on.

▪ If you define permitted hours for the job, after the denied interval is over, the job will start
immediately and then run by the defined schedule.

For example, you have configured a job to run with a 2-hour interval and defined permitted hours
from 9:00 AM to 5:00 PM. According to the rules above, the job will first run at 9:00 AM, whe n the
denied period is over. After that, the job will run at 10:00 AM, 12:00 PM, 2:00 PM and 4:00 PM.

o To run the job continuously, select the P eriodically every option and choose Continuously from the
list on the right. A new backup job session will start as soon as the previous backup job session
finishes.

o To chain jobs, use the After this job field. In the common practice, jobs start one after another: when
job A finishes, job B starts and so on. If you want to create a chain of jobs, you must define the time
schedule for the first job in the chain. For the rest of the jobs in the chain, select the After this job
option and choose the preceding job from the list.

NOTE

The After this job option will automatically start a job if the first job in the chain is started
automatically by schedule. If you start the first job manually, Veeam Backup & Replication will
display a notification. You will be able to choose whether Veeam Backup & Replication must
start the chained job as well.

3. In the Automatic retry section, define whether Veeam Backup & Replication or Veeam Plug -in (depending
on the selected job mode) must attempt to run the backup job again if the job fails for some reason. Enter
the number of attempts to run the job and define time intervals between them. If you select continuous
backup, Veeam Backup & Replication or Veeam Plug -in will retry the job for the defined number of times
without any time intervals between the job runs.

672 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 4. In the Ba ckup window section, define the time interval within which the backup job must complete. The
backup window prevents the job from overlapping with production hours and ensures that the job does
not impact performance of your server. To set up a backup window for the job:

a. Select the Terminate job if it exceeds allowed backup window check box and click W ind ow.

b. In the Time P eriods window, define the allowed hours and prohibited hours for backup. If the job
exceeds the allowed window, it will be automatically terminated.

NOTE

If you configure a backup policy, after you click Ap p ly at the Schedule step of the wizard, Veeam Backup &
Replication will immediately apply the backup policy to protected computers.

673 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 8. Review Policy Settings
At the Summary step of the wizard, complete the configuration process for the application backup policy.

1. Review settings of the configured backup policy.

2. Select the E na ble the backup policy when I click Finish check box if you want to enable the policy right
after you finish working with the wizard. After that, you can start the policy manually or wait for the
scheduled start.

3. Click Finish to close the wizard.

674 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Managing Application Backup Policies
You can use the Veeam Backup & Replication console to perform the following operations with an application
backup policy:

• Start and stop backup operations on computers added to the backup policy .

• Perform active full backup on computers added to the backup policy.

• Edit backup policy settings.

• Enable and disable a backup policy.

• Clone a backup policy.

• Delete a backup policy.

675 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Starting and Stopping Application Backup Policy
You can manually start an application backup policy. For example, if you want to create an additional restore
point in the backup chain and do not want to change the backup schedule. You can also stop the backup
process, for example, if processing of a computer is about to take long, and you do not want the backup process
to produce workload on the production environment during business hours.

Veeam Backup & Replication does not check whether connection to computers is active at the time when the
command is sent. Keep in mind that the start or stop operation will be performed only on those computers that
received the command from the backup server.

Starting Application Backup Policy

To start an application backup policy on computers added to this backup policy:

1. Open the Home view.

2. In the inventory pane, select Job s .

3. In the working area, select the backup policy and click Sta rt on the ribbon or right-click the job and select
Sta rt.

TIP

You can also start a backup operation from the computer with installed Veeam Plug -in. To learn more, see
Starting Backup Job on Veeam Plug-in Side.

Stopping Application Backup Policy

To stop application backup policy on computers added to this backup policy:

1. Open the Home view.

2. In the inventory pane, select Job s .

676 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 3. In the working area, select the backup policy and click Stop on the ribbon or right-click the job and select
Stop . In the displayed window, click Y es .

Starting Backup Job on Veeam Plug-in Side

In the Veeam Plug-in management scenario, you can still manually start an application backup job from the
computer with Veeam Plug-in installed. For example, this may be useful if you want to create an ad -hoc backup
just before the database maintenance.

Keep in mind the following:

• You can back up only those databases that are added to the application backup policy on the Veeam
Backup & Replication side. If the database is not added to any application backup policy, you cannot back
up this database from the computer with Veeam Plug-in.

• You cannot start an application backup job from the computer with Veeam Plug -in installed, if the
application backup policy on the Veeam Backup & Replication side is in the disabled s tate. To learn how to
enable a disabled backup policy, see Enabling and Disabling Backup Policy.

• When you start an application backup job from the computer with Veeam Plug -in installed, Veeam Backup
& Replication will not start the application backup policy. The policy will stay in the idle state.

The way you configure and start the backup job depends on the Veeam Plug -in you work with:

• Veeam Plug-in for SAP HANA

• Veeam Plug-in for SAP on Oracle

• Veeam Plug-in for Oracle RMAN

677 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Veeam Plug-in for SAP HANA
If you create an application backup policy for Veeam Plug -in for SAP HANA, Veeam Backup & Replication saves
the backup job parameters in the SAP HANA global.ini file on the computer with Veeam Plug-in. As a result,
you can use SQL commands or SAP HANA tools to back up SAP HANA databases. To learn more, see Database
Protection.

Veeam Plug-in for SAP on Oracle

If you create an application backup policy for Veeam Plug -in for SAP on Oracle, Veeam Backup & Replication
saves the backup job configuration on the computer with Veeam Plug -in. Depending on the version of Oracle
Database, Veeam Plug-in stores the configuration file in one of the following directories:

• For Oracle 12 and later, the configuration file is stored at SAPDATA_HOME/sapprof.

• For Oracle 11, the configuration file is stored at ORACLE_HOME/dbs.

The BRBACKUP tool can use this configuration file as an initialization profile. As a result, you can use this file to
start the backup operation from the Veeam Plug-in side. To learn more about configuration file, see Configuring
Plug-in for SAP on Oracle.

Veeam Plug-in for Oracle RMAN

If you create an application backup policy for Veeam Plug -in for Oracle RMAN, Veeam Backup & Replication does
not save the backup job configuration on the computer with Veeam Plug -in. As a result, you can configure and
start the backup job as a command in the Oracle RMAN console.

Consider that the command differs depending on the OS running on the computer with Veeam Plug -in for
Oracle RMAN installed:

• Example for Windows-based computers:

RUN {
ALLOCATE CHANNEL VeeamAgentChannel1
DEVICE TYPE SBT_TAPE PARMS 'SBT_LIBRARY=%PROGRAMFILES%\Veeam\VEEAMP~1\ORAC
LE~2.DLL' FORMAT 'RMAN_%I_%d_%T_%U.vab';
BACKUP INCREMENTAL LEVEL 0 DATABASE;
}
EXIT;

• Example for Linux- or Unix-based computers:

RUN {
ALLOCATE CHANNEL VeeamAgentChannel1
DEVICE TYPE SBT_TAPE PARMS 'SBT_LIBRARY=/opt/veeam/VeeamPluginforOracleRMA
N/libOracleRMANPlugin.so' FORMAT 'RMAN_%I_%d_%T_%U.vab';
BACKUP INCREMENTAL LEVEL 0 DATABASE;
}
EXIT;

678 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 IMP ORTANT

If you selected the database authentication method during the application backup policy
configuration, the backup operation started from the computer with Veeam Plug -in will fail. This
happens because the database credentials are not available on the computer with Veeam Plug-in.
Veeam Backup & Replication stores the database credentials only in the application backup policy
settings. For details, see Authentication Against Database.

As a workaround, you can manually set the database credentials on the computer with Veeam Plug-
in using the OracleRMANConfigTool tool. The command to manually set the database credentials
differs depending on the OS of the machine where Veeam Plug -in is installed:

• On machines running Linux or Unix OS: OracleRMANConfigTool --set-db-credentials

• On machines running Windows OS:

a. On the Oracle server, go to

%PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN.
b. Run the required OracleRMANConfigTool.exe --set-db-credentials
command.

The database credentials that you specified with the tool will be saved in the Veeam Plug -in
configuration file (veeam_config.xml). Veeam Plug-in will use them for backup operations started
from the computer with Veeam Plug-in.

679 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Performing Active Full Backup
You can create an ad-hoc full backup — active full backup, and add it to the backup chain on the backup
repository. The active full backup resets the backup chain. All subsequent incremental backups use the active
full backup as a starting point. The previously used full ba ckup will remain on the backup repository until it is
removed from the backup chain according to the retention policy.

When you start active full backup for a backup policy, Veeam Backup & Replication does not check whether
connection to computers is active at the time when the command is sent. Keep in mind that the active full
backup operation will be performed only on those computers that received the command from the backup
server.

To perform active full backup on computers added to the backup policy:

1. Open the Home view.

2. In the inventory pane, select Job s .

3. In the working area, select the backup policy and click Active full on the ribbon or right-click the job and
select Full. After that, confirm the backup policy start.

680 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Editing Backup Policy Settings
You can edit settings of an application backup policy at any time. For example, you may want to change the
backup scope, target location or scheduling settings for application backup policies running on protected
computers.

NOTE

If you want to change a backup repository, you must disable a policy. To learn more, see Enabling and
Disabling Backup Policy. In this case during the next run the policy will produce a full backup.

To edit backup policy settings:

1. Open the Home view.

2. In the inventory pane, select Job s .

3. In the working area, select the backup policy and click E d it on the ribbon or right-click the policy and
select E d it.

4. Complete the steps of the E d it Application Backup Policy wizard to change the job settings as required.

681 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Enabling and Disabling Backup Policy
You can temporarily disable scheduled application backup policies configured in Veeam Backup & Replication.
When you disable a job, Veeam Backup & Replication does not start the job by the specified schedule. You can
start a disabled job manually at any time you need. You can also enable a disabled job at any time.

To disable an application backup policy:

1. Open the Home view.

2. In the inventory pane, select Job s .

3. In the working area, select the application backup policy and click Disable on the ribbon or right-click the
policy and select Disable.

If you disabled a backup policy in the Veeam Backup & Replication console, this backup policy will not
start by schedule.

To enable a disabled policy, select it in the list and click Disable on the ribbon once again.

682 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Cloning Backup Policy
You can clone application backup policies configured in Veeam Backup & Replication. For example, you may
want to configure a backup policy that will be used as a template, and use this policy to create multiple policies
with similar settings.

To clone a backup policy:

1. Open the Home view.

2. In the inventory pane, select Job s .

3. In the working area, select the backup policy and click Clone on the ribbon or right-click the backup policy
and select Clone.

4. After a backup policy is cloned, you can edit all its settings, including the job name.

NOTE

The backup policy cloning functionality is available only in the Enterprise and Enterprise Plus editions of
Veeam Backup & Replication.

683 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Deleting Backup Policy
You can permanently remove a disabled application backup policy from Veeam Backup & Replication. Backups
created by this backup policy remain on the target location.

To remove an application backup policy:

1. Open the Home view.

2. In the inventory pane, select Job s .

3. In the working area, select the application backup policy and click Disable on the ribbon or right-click the
policy and select Disable.

4. Wait for Veeam Backup & Replication to disable the application backup policy, then select the backup
policy and click Delete on the ribbon or right-click the policy and select Delete.

After the job is deleted, the backups created by this job are displayed under the Ba ckups > Disk ( Orphaned)
node.

684 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Managing Protected Computers
You can perform the following operations with computers added to the inventory in Veeam Backup &
Replication:

• Move an unmanaged computer to a protection group.

• Rescan a protected computer.

• View properties of a protected computer.

• Manage Veeam Plug-in installed on a protected computer:

o Install Veeam Plug-in on a protected computer.

o Upgrade Veeam Plug-in on a protected computer.

o Uninstall Veeam Plug-in on a protected computer.

• Specifying Preferred Networks for Veeam Plug-ins in Managed Mode

• Uninstalling Veeam Plug-in and Other Veeam Components.

• Remove a protected computer from a protection group.

685 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Moving Unmanaged Computer to Protection
Group
You can quickly move an unmanaged computer to a protection group in the Veeam Backup & Replication
inventory. This allows you to start using Veeam Backup & Replication to manage Veeam Plug -in that is already
set up to create backups in the Veeam backup repository.

IMP ORTANT

The computer is displayed in the Unmanaged protection group only if you have Veeam Agent and Veeam
Plug-in deployed and configured directly from a computer side. If Veeam Plug -in only is installed on the
computer, this computer will not be displayed in the Unmanaged protection group.

Keep in mind, that you can move an unmanaged computer only to a protection group that includes individual
computers.

You can move a computer from the Unmanaged protection group to a new protection group or protection group
that you have already created.

• When you move an unmanaged computer to a new protection group, Veeam Backup & Replication creates
the protection group and adds the computer to this group. In the protection group settings, you can
define discovery and deployment options according to which Veeam Backup & Replication will process the
added computer.

• When you move an unmanaged computer to an already existing protection group, Veeam Backup &
Replication adds this computer to the protection group and starts processing the computer according to
discovery and deployment settings defined in the properties of the protection group. Veeam Backup &
Replication discovers the added computer, checks whether Veeam Plug -in running on the computer needs
upgrade and upgrades Veeam Plug-in if needed.

NOTE
• After you move a computer to a protection group, data backup for this computer will be performed
by a backup job configured in Veeam Backup & Replication. Veeam Plug -in running on the computer
will start a new backup chain on a target location specified in the backup job settings. The original
backup job configured on the computer will be removed in Veeam Plug -in, and you will not be able
to continue the backup chain created with this job.
• You cannot map an application backup policy configured in Veeam Backup & Replication to a backup
chain that was created on a backup repository by Veeam Plug -in operating in the standalone mode.
• If you have Veeam Agent and Veeam Plug-in deployed and configured from the computer side, you
can move your computer to two different protection groups: one protection group for Veeam Agent
and another protection group for Veeam Plug-in. But you cannot move this computer to the same
protection group twice.

To move an unmanaged computer to a new protection group:

1. Open the Inventory view.

2. In the inventory pane, expand the P hy sical Infrastructure node and select the Unma naged node.

3. In the working area, select the necessary computer and click Move to > New protection group on the
ribbon or right click the computer and select Move to > New protection group.

To move an unmanaged computer to a protection group that is already created in the inventory:

1. Open the Inventory view.

686 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 2. In the inventory pane, expand the P hy sical Infrastructure node and select the Unma naged node.

3. In the working area, select the necessary computer and click Move to > na me of the protection group on
the ribbon or right click the computer and select Move to > na me of the protection group .

687 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Rescanning Protected Computer
You can rescan protected computers added to the inventory. The rescan operation may be required, for
example, if you want to refresh information about the protected computer in the Veeam Backup & Replication
database. During the rescan operation, Veeam Backup & Replication communicates to Veeam Installer Service
running on the protected computer, retrieves information about the computer and stores this information to the
configuration database.

To rescan a protected computer:

1. Open the Inventory view.

2. In the inventory pane, expand the P hy sical Infrastructure node and select the necessary protection group.

3. In the working area, select the computer and click Rescan on the ribbon or right-click the computer and
select Rescan.

688 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Viewing Properties
You can view detailed information about protected computers. The detailed information provides the following
data:

• Host name

• IP address

• Fingerprint (for computers running a Linux OS)

• Key algorithm (for computers running a Linux OS)

• Operating system

• Veeam product version

To view detailed information about a protected computer:

1. Open the Inventory view.

2. In the inventory pane, expand the P hy sical Infrastructure node.

3. In the working area, select the computer and click Details on the ribbon or right-click the computer and
select Details.

689 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Managing Plug-in
You can use the backup console to manage the following Veeam Plug -ins on a specific computer in the
inventory:

• Veeam Plug-in for Oracle RMAN

• Veeam Plug-in for SAP HANA

• Veeam Plug-in for SAP on Oracle

Installing Veeam Plug-in

You can install Veeam Plug-in on a specific protected computer in the inventory. This operation may be
required, for example, if you want to test the installation process before allowing Veeam Backup & Replication
to deploy Veeam Plug-in to all computers included in the protection group.

Before you install Veeam Plug-in, check the following prerequisites:

• The protected computer must be powered on and able to be connected over the network.

• The required version of Veeam Plug-in must be available on the distribution server.

To install Veeam Plug-in on a protected computer:

1. Open the Inventory view.

2. In the inventory pane, expand the P hy sical Infrastructure node and select the necessary protection group.

3. In the working area, select the necessary computer and click Install Plug-in on the ribbon or right-click the
computer and select P lug-in > Install and select the plug-in you want to install.

690 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Upgrading Veeam Plug-in
You can upgrade Veeam Plug-in running on a specific protected computer. This operation may be required, for
example, if you did not allow Veeam Backup & Replication to automatically upgrade Veeam Plug -in on
computers included in the protection group and want to test the upgrade process on a selected computer first.

Before you upgrade Veeam Plug-in, check the following prerequisites:

• The protected computer must be powered on and able to be connected over the network.

• Veeam Plug-in on the protected computer must be managed by Veeam Backup & Replication. Upgrade of
standalone Veeam Plug-ins must be performed from the Veeam Plug-in side. To learn more, see
Upgrading from Veeam Plug-in Side.

• The required version of Veeam Plug-in must be available on the distribution server.

• There are no running jobs.

We recommend that you do not stop running jobs and let them complete successfully. Disable any
periodic jobs temporarily to prevent them from starting during the upgrade.

TIP

During the protected computers discovery process, Veeam Backup & Replication checks the version of
Veeam Plug-in running on a protected computer and the version of Veeam Plug -in available on the
distribution server. If a newer version of Veeam Plug -in becomes available on the distribution server, and
automatic upgrade of Veeam Plug-in is disabled for a protection group, Veeam Backup & Replication puts a
computer to the Upgrade required state.

In addition, Veeam Backup & Replication includes computers that require upgrade of Veeam Plug-in in the
Out of Date protection group. You can upgrade Veeam Plug-in on all computers that require upgrade at
once. To learn more, see Upgrading Veeam Plug-in on Multiple Computers.

To upgrade Veeam Plug-in on a protected computer:

1. Open the Inventory view.

2. In the inventory pane, expand the P hy sical Infrastructure node and select the necessary protection group.

3. In the working area, select the necessary computer and click Up grade Plug-in on the ribbon or right-click
the computer and select P lug-in > Up grade.

691 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 NOTE

In some cases, upgrade to the new version of Veeam Plug -in may require computer reboot.

Upgrading Veeam Plug-in on Multiple Computers

You can upgrade Veeam Plug-in on all computers that require upgrade at once. To upgrade Veeam Plug -in on
protected computers:

1. Open the Inventory view.

2. In the inventory pane, in the P hy sical Infrastructure node, select the Out of Date protection group and
click Up g rade on the ribbon or right-click the Out of Date protection group and select Up g rade.

692 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 NOTE

In some cases, upgrade to the new version of Veeam Plug -in may require computer reboot.

Upgrading from Veeam Plug-in Side

You can also upgrade Veeam Plug-in from the computer side. This approach is required, for example, for
standalone Veeam Plug-ins that are cannot be upgraded from the Veeam backup console. The process of
upgrading differs depending on the Veeam Plug-in:

• Upgrading Veeam Plug-in for Oracle RMAN

• Upgrading Plug-in for SAP HANA

• Upgrading Veeam Plug-in for SAP on Oracle

Uninstalling Veeam Plug-in

You can remove Veeam Plug-in from a specific protected computer, for example, if you want to reinstall Veeam
Plug-in running on the protected computer.

To uninstall Veeam Plug-in:

1. Open the Inventory view.

2. In the inventory pane, expand the P hy sical Infrastructure node and select the necessary protection group.

3. In the working area, select the necessary computer and click Uninstall Plug-in on the ribbon or right-click
the computer and select P lug-in > Uninstall and select Veeam Plug-in you want to uninstall.

4. In the displayed notification window, click Y es .

693 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 NOTE

Consider the following:

• If automatic installation of Veeam Plug-in is enabled in the protection group settings, after you
remove Veeam Plug-in from a selected computer, Veeam Backup & Replication will install Veeam
Plug-in on this computer during the next rescan job session started by schedule.
• Prerequisite components installed and used by Veeam Plug -in are not removed during the uninstall
process. To remove the remaining components, use the built-in tools directly on this computer (for
example, Microsoft Windows Control Panel on the Microsoft Windows computer).

694 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Specifying Preferred Networks for Veeam Plug-
ins in Managed Mode
You can specify networks over which Veeam Plug-ins in managed mode must transport data when you perform
data protection and disaster recovery tasks on remote backup repositories. This setting applies only to Veeam
Plug-ins network traffic, without affecting the data traffic of other Veeam Backup & Replication components.
Setting a dedicated network for Veeam Plug-ins backup and replication operations can help to reduce heavy
network loads.

NOTE

Consider the following:

• By default, if there are no specified preferred networks for Veeam Plug -in data traffic, Veeam Plug-
in will connect to preferred networks specified in Veeam Backup & Replication. To learn more about
setting preferred networks in Veeam Backup & Replication, see the Specifying Preferred Networks
section in the Veeam Backup & Replication User Guide.
• Veeam Plug-in does not save information about failed network connections. If backup or restore
operations fail, Veeam Plug-in tries to connect to the following network from the preferred
networks list to finish the started operations. Regardless of the first unsuccessful connection,
Veeam Plug-in will try to perform the next backup operations first on the failed network.
• Veeam Plug-in network preferences take priority over Veeam Backup & Replication network
preferences. Only if the preferred networks for Veeam Plug-in data traffic are not available for any
reason, Veeam Plug-in will try to connect to the Veeam Backup & Replication preferred networks.

To specify networks for data transfer, you must create a list of preferred networks. When Veeam Plug-in needs
to transfer data, it uses networks from this list. If a connection over any of the preferred networks cannot be
established for any reason, Veeam Plug-in will automatically fail over to the following network from the
preferred networks list.

For more information on creating and managing the list of preferred networks that specific Veeam Plug -ins will
use, see the following sections:

• Specifying Preferred Networks for Veeam Plug-in for SAP HANA

• Specifying Preferred Networks for Veeam Plug-in for Oracle RMAN

• Specifying Preferred Networks for Veeam Plug-in for SAP on Oracle

695 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Uninstalling Veeam Plug-in and Other Veeam
Components
You can uninstall all Veeam Plug-ins and the following Veeam product components installed on a protected
computer as one operation:

• Veeam Agents

• [For Microsoft Windows computers] Veeam Installer Service

• [For Linux computers] Veeam Deployer Service

• [For Microsoft Windows and Linux computers] Veeam Transport Service

This approach is helpful if Veeam Plug-ins are installed on the protected computer, and you do not want to
uninstall all products and product components individually.

TIP
• To learn about Veeam Agents, see Veeam Agent Management Guide.
• For details on Veeam Installer Service, Veeam Deployer Service and Veeam Transport Service, see
Veeam Plug-in Management Infrastructure.

Before you start the uninstall process, consider the following:

• [For Microsoft Windows and Linux computers] Veeam Installer Service, Veeam Deployer Service and
Veeam Transport Service are not removed from the computer with Veeam Plug -in if the computer is added
to the Veeam backup infrastructure as a managed server. To learn more, see the Virtualization Servers and
Hosts section in the Veeam Backup & Replication User Guide.

• [For Linux computers] Veeam Deployer Service is not removed if Veeam Backup & Replication connects to
the protected computer with single-use credentials.

• If automatic installation of Veeam Plug-in is enabled in the protection group settings, after you remove
Veeam Plug-in from a selected computer, Veeam Backup & Replication will install Veeam Plug -in on this
computer during the next rescan job session started by schedule. For details, see Creating Protection
Groups.

NOTE

[For Microsoft Windows and Linux computers] If automatic installation of Veeam Plug -in is not
enabled in the protection group settings, Veeam Backup & Replication will not install Veeam Plug-in
during the next rescan job session started by schedule but will install the Veeam Installer Service or
Veeam Deployer Service and Veeam Transport Service on the computer.

• Prerequisite components installed and used by Veeam Plug -in are not removed during the uninstall
process. To remove the remaining components, use the built-in tools directly on this computer (for
example, Microsoft Windows Control Panel on the Microsoft Windows computer).

To uninstall Veeam Plug-ins, Veeam Agents and Veeam product components:

1. Open the Inventory view.

2. In the inventory pane, expand the P hy sical Infrastructure node and select the necessary protection group.

3. In the working area, select the necessary computer and click Uninstall Everything on the ribbon or right-
click the computer and select Uninstall everything.

696 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 4. In the displayed notification window, click Y es .

697 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Removing Computer from Protection Group
You can remove one or more computers from a protection group, for example, if you do not want to protect
these computers with Veeam Plug-in any longer but want to back up data of other computers in the protection
group.

When you remove a computer from a protection group, Veeam Backup & Replication removes records about the
computer from the Veeam backup console and configuration database but does not uninstall Veeam Plug -in
from the computer. You can remove Veeam Plug-in from the computer in advance, before you remove the
computer from the protection group. To learn more, see Uninstalling Plug-in.

Alternatively, you can remove a computer from a protection group, and then uninstall Veeam Plug -in from this
computer side. Keep in mind that in this case you will have to uninstall Veeam Plug -in using the built-in tools
directly on this computer (for example, Microsoft Windows Control Panel on the Microsoft Windows computer).

TIP

You can also remove entire protection groups from the Veeam Backup & Replication inventory. When you
remove a protection group, you can instruct Veeam Backup & Replication to uninstall Veeam Plug -ins from
all protected computers included in this protection group. To learn more, see Removing Protection Group.

To remove a computer from a protection group:

1. Open the Inventory view.

2. In the inventory pane, expand the P hy sical Infrastructure node and select the necessary protection group.

3. In the working area, select the necessary computer and click Remove from configuration on the ribbon or
right-click the computer and select Remove from configuration.

Backups created for computers that were removed from a protection group remain intact in the backup location.
You can delete this backup data manually later if needed.

698 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 NOTE

You cannot remove a computer from the protection group if this computer is a failover cluster node.

Alternative Ways to Remove Computer from Protection Group

There are alternative ways to remove computer from protection group that may be suitable for specific
situations. Alternative ways of removing computer from protection group differ depending on the type of the
protection group that contains the computer you want to remove.

• For a protection group that contains individual computers, edit the protection group and remove the
necessary computer at the Computers step of the E d it Protection Group wizard. To learn more, see Editing
Protection Group Settings.

• For a protection group that contains Active Directory objects, edit the protection group and r emove the
necessary computer account at the Active Directory step of the E d it Protection Group wizard.

Alternatively, if the protection group contains a container, organization unit, group or entire domain, you
can exclude the computer at the E x clusions step of the wizard. To learn more, see Exclude Objects from
Protection Group.

• For a protection group that contains computers listed in a CSV file, remove the record about the necessary
computer from the CSV file. During subsequent rescan of the protection group, Veeam Backup &
Replication will remove the computer from the protection group.

699 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Managing Application Backups
You can perform administration tasks with backups created on a Veeam backup repository by application backup
policies configured in Veeam Backup & Replication. For such backups, Veeam Backup & Replication allows you to
perform the same set of operations as for backups created with application policies configured directly on a
protected computer. You can perform the following tasks:

• Restore a database item from an application backup using Veeam Explorer .

• Create a recovery token for a computer.

• Repair a backup.

• Delete an application backup from configuration.

• Delete an application backup from disk.

• Create a backup copy.

NOTE

Backups created by Veeam Plug-ins cannot be used as a source for file to tape or backup to tape jobs.

700 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Restoring from Backup with Veeam Explorer
You can recover SAP HANA and Oracle databases from backups created with Veeam Plug -in for SAP HANA and
Veeam Plug-in for Oracle RMAN:

• To restore SAP HANA databases, Veeam Backup & Replication uses Veeam Explorer for SAP HANA. For
details, see the SAP HANA Data Restore section in the Veeam Explorers User Guide.

Alternatively, to perform restore from SAP HANA databases you can also use Veeam Explorer cmdlets. For
details, see the Veeam Explorer for SAP HANA section in the the Veeam Explorers PowerShell Reference.

• To restore Oracle databases, Veeam Backup & Replication uses Veeam Explorer for Oracle. For details, see
the Restoring Oracle RMAN Backups section in the Veeam Explorers User Guide.

Alternatively, to perform restore from Oracle databases you can also use Veeam Explorer cmdlets. For
details, see the Veeam Explorer for Oracle section in the the Veeam Explorers PowerShell Reference.

Considerations and Limitations

[For Oracle database backup] Before you restore database, consider the following:

• Veeam Explorer for Oracle does not support restore of encrypted Oracle databases.

• [For Solaris OS and IBM AIX] Veeam Explorer for Oracle does not support restore of Oracle databases
deployed on Solaris OS and IBM AIX. You can restore Oracle databases on Solaris OS and IBM AIX only with
RMAN. For details, see Restore to Original Server.

• If you use huge pages, make sure that you allocated enough memory to the system where you want to
restore your database.

Restoring from Backup

To restore database from an application backup:

1. Open the Home view.

2. In the inventory pane, click Ba ck ups.

3. In the working area, select one of the following options depending on the backed -up database type:

o [For Oracle database backup] Click Ora cle Database on the ribbon or right-click the backup and select
Restore from Oracle RMAN backup.

701 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 o [For SAP HANA database backup] Click SAP HANA Database on the ribbon or right-click the backup
and select Restore from SAP HANA backup.

702 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Creating Recovery Token
If you want to recover database from a specific backup, you can use the Create recovery token operation.

You can create a recovery token on the Veeam Backup & Replication side. Then, on the computer side, with this
recovery token get access to the backup and recover the database that is stored in the backup. To learn more
about operations on the computer side, see one of the following sections depending on Veeam Plug -in you work
with:

• Veeam Plug-in for Oracle RMAN

• Veeam Plug-in for SAP HANA

• Veeam Plug-in for SAP on Oracle

Limitations
Before creating a recovery token, consider the following prerequisites and limitations:

• Recovery tokens stay valid for 24 hours.

• You can recover data only from the backup for that the recovery token is generated.

• Parallel restore from several backups is supported only by Veeam Plug -in for Oracle RMAN.

• During recovery, Veeam Backup & Replication does not stop backup operations.

• You cannot create a recovery token for a whole backup copy job, but you can create a recovery token for
individual objects included in a backup copy job.

Generating Recovery Token

To create a recovery token on the Veeam Backup & Replication side:

1. Open the Home view.

2. In the inventory pane, click Ba ck ups.

3. In the working area, right-click the backup and select Create recovery token.

You can create a recovery token for several backups. To do this, press and hold [Ctr l], select multiple
backups, right-click one of the selected backups and select Create recovery token.

4. In the Create Recovery Token window, click Create.

703 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 TIP

Alternatively, you can create and modify the existing recovery token using the PowerShell console. To
learn more, see the Working with Tokens section in the Veeam PowerShell Reference.

704 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Repairing Backup
As a result of malware activity or unplanned actions, backup job metadata (.VACM) files may become
unavailable in the hardened repository. In this case, to restore data from the hardened repository, you must re -
create the .VACM file. To do this, you can use the repair operation. During this operation, Veeam Backup &
Replication will generate a new .VACM file using information from the backup metadata (.VASM) files.

IMP ORTANT

This operation is intended only for a situation where the backup job metadata file has been lost as a result
of malware activity or unplanned actions. Re-creation of the backup job metadata file for other purposes is
not supported.

Before you repair the backup, you must perform the preparation steps. The way you prepare differs depending
on the Veeam Plug-in operation mode:

• Preparing Backup Created with Standalone Veeam Plug -in

• Preparing Backup Created with Managed Veeam Plug-in

Preparing Backup Created with Standalone Veeam Plug-in

To repair the backup created with standalone Veeam Plug -in, complete the following preparation steps:

1. Remove the backup that you want to repair from the Veeam Backup & Replication console and
configuration database. To learn more, see Removing Backup from Configuration.

2. [For the scale-out backup repository] If your backup job is targeted at the scale-out backup repository,
Veeam Plug-in uses a backup server host name to create a folder where the backups will be stored. To
repair your backup, you must create a new backup file in a new folder. The way you create a new folder
depends on the scale-our backup repository configuration:

o If the scale-out backup repository does not contain deduplicating storage appliances, you must
manually delete folders that are already created to store backups in each extent. Keep in mind that
you must delete folders, but keep the backups you want to rep air. Alternatively, you can rename
these folders or move them to another location.

o If the scale-out backup repository contains deduplicating storage appliances, you must set a new host
name in the Veeam configuration XML file (/opt/veeam/VeeamPlugin/veeam_config.xml) to
be able to create a new folder with new backup files:

<PluginParameters customServerName="hostname.domain.tld" />

Keep in mind that you must add the parameter to the existing line in the veeam_config.xml file. If
you create a new line with the same name as the existing line, Veeam Plug-in will consider parameters
only in the first detected line. Other parameters will be ignored.

To learn the list of supported deduplicating storage appliances, see the Deduplicating Storage
Appliances section in the Veeam Backup & Replication User Guide.

3. Run an application backup job. Keep in mind that you must start the job from the computer with Veeam
Plug-in installed. For details, see Starting Backup Job on Veeam Plug-in Side.

After the successful run, Veeam Backup & Replication with create a new backup consisting of the .VAB,
.VASM and .VACM files.

705 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 4. [For the scale-out backup repository] In the backup repository folder, add .VAB and .VASM files of the
backup that you want to repair to the folder with backup files created at the step 3.

5. Disable the application backup job from step 3.

After you completed the preparation steps, you are ready to repair the backup. To learn more, see Repairing
Backup.

Preparing Backup Created with Managed Veeam Plug-in

If you plan to repair the backup created with managed Veeam Plug -in, check if you have access to Veeam
Backup & Replication using which the backup was originally created. If you have access, make sure the Veeam
Backup & Replication configuration database and the application backup policy using which the backup was
created are still available. Depending on your case, complete the following preparation steps:

• If you can use the Veeam Backup & Replication configuration database and the application backup policy
using which the backup was originally created, complete the following steps:

a. Remove the backup that you want to repair from the Veeam Backup & Replication configuration
database. To learn more, see Removing Backup from Configuration.

b. Run the backup policy. To learn more, see Starting Application Backup Policy.

In case of the successful run, Veeam Backup & Replication with create a new backup consisting of the
.VAB, .VASM and .VACM files.

c. Disable the application backup policy from step 2. To learn more, see Enabling and Disabling Backup
Policy.

After you completed the preparation steps, you are ready to repair the backup. To learn more, see
Repairing Backup.

• If you cannot use the Veeam Backup & Replication configuration database or the application backup policy
using which the backup was originally created, complete the following steps:

a. Make sure that the backup that you want to repair is removed from the configuration database of
Veeam Backup & Replication using which the backup was originally created. To learn more, see
Removing Backup from Configuration.

b. Make sure that the Veeam Plug-in using which the backup was originally created is switched to the
standalone operating mode. To learn more, see Resetting Veeam Plug-in Ownership.

c. Start managing Veeam Plug-in from step b with your Veeam Backup & Replication. To do this, you
need to add a computer with Veeam Plug-in to the protection group. To learn more, see Specify
Protection Scope.

d. Create and run a new application backup policy. To learn more, see Working with Application Policies.

In case of the successful run, Veeam Backup & Replication with create a new backup consisting of the
.VAB, .VASM and .VACM files.

e. In the backup repository folder, add .VAB and .VASM files of the backup that you want to repair to the
folder with backup files created at the step c.

f. Disable the application backup job from step c.

After you completed the preparation steps, you are ready to repair the backup. To learn more, see
Repairing Backup.

706 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Repairing Backup
To repair a backup:

1. In the Veeam Backup & Replication console, open the Home view.

2. In the inventory pane, select Ba ckups.

3. In the working area, select the necessary backup.

4. Press and hold the [Ctrl] key, right-click the backup and select Rep air.

Veeam Backup & Replication will generate a new .VACM file using information from the .VASM files. Once
the backup job metadata file is re-created, you can use Veeam Plug-in to restore your data.

5. If you plan to restore databases using Veeam Explorer for SAP HANA or Veeam Explorer for Oracle and
your backups reside on a scale-out backup repository expanded with capacity tier, rescan the backup
repository. To learn more about rescan, see the Rescanning Backup Repositories section in the Veeam
Backup & Replication User Guide.

707 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Removing Backup from Configuration
If you want to remove records about application backups from the Veeam Backup & Replication console and
configuration database, you can use the Remove from configuration operation. When you remove an application
backup from configuration, the actual backup files remain on the backup repository. You can import the backup
to the Veeam Backup & Replication at any time later and restore data from it.

You can remove specific child backups — backups related to individual computers in the backup.

NOTE

You can use the Veeam Backup & Replication console to remove backups created by application backup
policies in the Veeam backup repository. Backups created on a local drive of a protected computer or in a
network shared folder are not displayed in the Veeam backup console.

To remove an application backup from configuration:

1. Open the Home view.

2. In the inventory pane, click Ba ck ups.

3. To remove a backup of a specific computer in the application backup policy, expand the parent backup,
select the necessary computer, press and hold the [Ctrl] key, right-click the backup and select Remove
from configuration.

708 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Deleting Backup from Disk
If you want to delete records about application backups from the Veeam Backup & Replication console and
configuration database and, additionally, delete backup files from the backup repository, you can use the Delete
from disk operation.

You can remove specific child backups — backups related to individual computers in the backup.

To remove an application backup from the backup repository:

1. Open the Home view.

2. In the inventory pane, click Ba ck ups.

3. In the working area, select the backup and click Delete from > Disk on the ribbon or right-click the backup
and select Delete from disk.

709 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Creating Backup Copy Job
Veeam Backup & Replication offers the backup copy functionality that allows you to create several instances of
the same backup in different locations, whether onsite or offsite. Backup copies have the same format as those
created by backup jobs and you can recover your data from them when you need it.

Veeam Backup & Replication fully automates the backup copy process and lets you specify retention settings to
maintain the desired number of restore points, as well as full backups for archival purposes. Backup copy is a
job-driven process. When enabled, the backup copy job for Veeam Plug -in backups runs continuously. For more
details on how it works, see the Backup Copy section in the Veeam Backup & Replication User Guide.

To copy backups to a secondary location, you must configure a backup copy job. The backup copy job defines
how, where and when to copy backups. One job can be used to process backups of one or more machines.

You can configure a job and start it immediately or save the job to start it later.

Before creating a job, check prerequisites. Then use the New Backup Copy Job wizard to configure a backup
copy job.

1. Launch Backup Copy Job wizard.

2. Specify a job name and description.

3. Select backups to process.

4. Define backup copy target.

5. Specify advanced settings.

6. Define backup copy schedule.

7. Finish working with the wizard.

Before You Begin

Before you create a backup copy job, check the prerequisites and limitations:

• Backup infrastructure components that will take part in the backup copy process must be added to the
backup infrastructure and properly configured. These include source and target backup repositories
between which backups must be copied.

• The target backup repository must have enough free space to store copied backups. To receive alerts
about low space on the backup repository, configure global notification settings. For more information,
see Specifying Other Notification Settings.

• For Veeam Plug-in backup copy jobs, you cannot select the following repositories as a backup copy target:

o Veeam Cloud Connect repository

o Object storage repository

710 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 1. Launch Backup Copy Job Wizard
To create a backup copy job, do the following:

1. In the Veeam Backup & Replication console, open the Home view.

2. Click the Ba ckup Copy tab and select Ap p lication-level backup.

711 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 2. Specify Job Name and Description
At the Job step of the wizard, specify a name and description for the backup copy job.

1. In the Na me field, enter a name for the job.

2. In the Description field, enter a description for the job. The default description contains information about
the user who created the job, date and time when the job was created.

712 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Step 3. Select Backups to Process
At the Ob ject step of the wizard, select machines whose backups you want to copy to the target repository.

1. Click the Ad d button and select from which entity you want to process the machines.

o From jobs: You can select Veeam Plug-in backup jobs. When a backup copy job runs, Veeam Backup &
Replication will search for backup files created by selected jobs.

o From repositories: You can select repositories where Veeam Plug-in backups are stored. When a
backup copy job runs, Veeam Backup & Replication will search for backup files created by Veeam
Plug-in in selected repositories.

2. Use the Remove button if you want to remove selected jobs or repositories from processing.

3. If you have added jobs from a repository and want to exclude from processing some of the backup jobs on
the selected repository, click E x clusions and select the jobs that you want to exclude.

713 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Step 4. Define Backup Copy Target
At the Ta rget step of the wizard, configure the target repository settings.

1. From the Ba ckup repository list, select a backup repository in the target site where copied backups must
be stored. When you select a target backup repository, Veeam Backup & Replication automatically checks
how much free space is available on it. Make sure that you have enough free space to store copi ed
backups.

IMP ORTANT

For Veeam Plug-in backup copy jobs, you cannot select the following repositories as a backup copy
target:

• Veeam Cloud Connect repository

• Object storage repository

2. If the target repository contains a Veeam Plug-in or MongoDB backup that was excluded from the backup
copy job, and if you don't want to transfer duplicate data, you can use the mapping feature.

After you configure mapping, if some of backup files (.VAB) of the source backup are missing in the target
backup copy, these files are uploaded to the target backup copy.

NOTE

Veeam Plug-in backup copy jobs do not use WAN accelerators.

To map a backup copy job to the backup:

a. Click the Ma p backup link.

b. Point the backup copy job to the backup in the target backup repository. Backups in the target backup
repository can be easily identified by backup job names. To facilitate search, you can use the search
field at the bottom of the window.

IMP ORTANT

Keep in mind that repositories must meet the following requirements:

• Used account must have access to Veeam backup repositories that you plan to use.
• Encryption must be disabled on the repository.

Otherwise, the repositories will not be listed as available. To learn how to configure access
permissions and encryption settings on repositories, see Access Permissions in the Veeam Backup &
Replication User Guide.

714 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 3. You can specify the number of days after which the backup copy will be deleted from the repository. Note
that the countdown starts from the moment when source backup has been created.

715 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Step 5. Specify Advanced Settings
At the Ta rget step of the wizard, click Ad vanced to configure storage, RPO warning, and notifications settings.

• Storage settings

• RPO warning settings

• Notification settings

Storage Settings
At the Storage tab, define compression and deduplication settings.

By default, Veeam Backup & Replication performs deduplication before storing copied data on the target backup
repository. Deduplication provides a smaller size of the resulting backup file but may reduce the job
performance.

1. You can disable data deduplication. To do this, clear the E na ble inline data deduplication check box.

2. From the Compression level list, choose a compression level to be used: Auto, None, Dedupe-friendly,
Op timal, High or E x treme. The recommended level of compression for backup copy jobs is Auto. In this
case, Veeam Backup & Replication uses compression settings of the copied backup files. For more
information, see Compression and Deduplication.

RPO Warning Settings

At the RP O Monitor tab, specify RPO warning settings.

716 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Enable the W a rn me if backup is not copied within check box and specify the time period in minutes, hours, or
d a ys.

If the backup copy is not created within the specified time period, the backup copy job will finish with the
Warning status. The countdown starts from the moment when the required backup is finished and ready to be
copied.

Notification Settings
At the Notifications tab, to specify notification settings for the backup copy job:

1. At the Ta rget step of the wizard, click Ad vanced.

2. Click the Notifications tab.

3. Select the Send SNMP notifications for this job check box if you want to receive SNMP traps when the job
completes successfully. SNMP traps will be sent if you specify global SNMP settings in Veeam Backup &
Replication and configure software on recipient's machine to receive SNMP traps. For more information,
see Specifying SNMP Settings.

4. Select the Send email notifications to the following recipients check box if you want to receive
notifications by email in case of job failure or success. In the field below, specify a recipient email address.
You can enter several addresses separated by a semicolon.

5. Veeam Backup & Replication sends a consolidated email notification once for the specified backup copy
interval. Even if the synchronization process is started several times within the interval, for example, due
to job retries, only one email notification will be sent.

6. Email notifications will be sent if you configure global email notification settings in Veeam Backup &
Replication. For more information, see Configuring Global Email Notification Settings.

717 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 7. At the Send at field, specify the time when you want to receive notifications. Note that you will receive a
notification on the job status once a day.

8. You can choose to use global notification settings or specify custom notification settings.

o To receive a typical notification for the job, select Use global notification settings. In this case, Veeam
Backup & Replication will apply to the job global email notification settings specified for the backup
server. For more information, see Configuring Global Email Notification Settings.

o To configure a custom notification for a job, select Use custom notification settings specified below.
You can specify the following notification settings:

i. In the Sub ject field, specify a notification subject. You can use the following variables in the
subject: %Time% (completion time), %JobName%, %JobResult%, %VmCount% (number of
machines in the job) and %Issues% (number of machines in the job that have been processed
with the W a rning or Fa iled status).

ii. Select the Notify on success, Notify on warning and Notify on error check boxes to receive email
notification if data processing within the backup copy interval completes successfully, fails or
completes with a warning.

718 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 6. Define Backup Copy Schedule
At the Schedule step of the wizard, define a time span in which the backup copy job must not transport data
between source and target backup repositories. For more information, see Backup Copy Window.

To define a backup window for the backup copy job:

1. Select the During the following time p eriods only option.

2. In the schedule box, select the desired time area.

3. Use the E na ble and Disable options to mark the selected area as allowed or prohibited for the backup copy
job.

719 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Step 7. Review Backup Copy Job Settings
At the Summary step of the wizard, complete the procedure of backup copy job configuration.

1. Review details of the backup copy job.

2. Select the E na ble the job when I click Finish check box if you want to start the job right after you finish
working with the wizard.

3. Click Finish to close the wizard.

720 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Reporting
You can view real-time statistics for rescan jobs, as well as application backup policies configured in Veeam
Backup & Replication. You can also generate reports with statistics data for perfor med rescan job or backup job
sessions. You can generate reports manually in the Veeam Backup & Replication console or set up Veeam Backup
& Replication to send reports automatically by email.

721 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Viewing Rescan Job Statistics
You can view statistics about performed rescan job sessions. When you create a protection group or manually
start the discovery process for a protection group or individual protected computer, Veeam Backup &
Replication displays statistics for the currently running rescan job session. In the statistics window, Veeam
Backup & Replication displays session duration details and a list of operations performed during the job.

In addition to overall rescan job statistics, the statistics window provides information on each protected
computer processed within the rescan job session. To view the processing progress for a specific computer,
select it in the list on the left.

You can also view statistics for any performed rescan job session. To view rescan job statistics, do one of the
following:

• Open the Inventory view. In the inventory pane, select the necessary protection group and click Sta tistics
on the ribbon or right-click the protection group and select Sta tistics.

• Open the History view. In the inventory pane, select the Sy stem node. In the working area, select the
necessary rescan job session and click Sta tistics on the ribbon or right-click the rescan job session and
select Sta tistics.

722 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Viewing Rescan Job Report
You can generate reports with details about rescan job sessions performed for a specific protection group. The
report contains data on the latest rescan job session initiated for the job upon schedule. To generate a report:

1. Open the Inventory view.

2. In the inventory pane, select the necessary protection group and click Rep ort on the ribbon or right-click
the protection group and select Rep ort.

The report contains the following data:

• Cumulative session statistics: details of the session performance, including the number of protected
computers in the protection group and the number of newly discovered computers.

• Detailed statistics for every protected computer processed within the session: DNS name, IP address and
operating system of the protected computer, list of warnings and errors (if any).

TIP

You can also set up Veeam Backup & Replication to send reports automatically by email. To learn more, see
Enabling Email Reporting.

723 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Viewing Backup Policy Statistics
You can view statistics about application backup policies configured in Veeam Backup & Replication. Veeam
Backup & Replication displays statistics in the following way:

After the application backup policy session statistics becomes available in Veeam Backup & Replication, this
statistics appears in the policy statistics window. The job session statistics becomes available in Veeam Backup &
Replication on real-time basis.

TIP

In addition to backup policy statistics, Veeam Backup & Replication displays individual backup session
statistics for each computer in the backup policy. You can view these statistics in the La st 24 Hours node of
the Home view and in the History view of the Veeam backup console.

To view application backup policy statistics:

1. Open the Home view.

2. In the inventory pane, click the Job s node.

3. In the working area, select the necessary statistics:

o To get statistics for database data backup, double-click the necessary application backup policy.
Alternatively, you can select the necessary application backup policy and click Sta tistics > Instance
b a ckup on the ribbon or right-click the backup policy and select Sta tistics > Instance backup.

o To get statistics for database logs backup, select the necessary application backup policy and click
Sta tistics > Da tabase logs backup on the ribbon or right-click the backup policy and select Sta tistics >
Da tabase logs backup.

724 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Viewing Backup Policy Report
You can generate a report with details about application backup job sessions performed on protected databases
added to a backup policy. The report contains data on the latest backup job session initiated for the backup
policy. To generate a report:

1. Open the Home view.

2. In the inventory pane, click the Job s node.

3. In the working area, select the necessary report:

o To get report for database data backup, click Rep ort > Instance backup on the ribbon or right-click the
backup policy and select Rep ort > Instance backup.

o To get report for database logs backup, click Rep ort > Da tabase logs backup on the ribbon or right-
click the backup policy and select Rep ort > Da tabase logs backup.

The report contains data on the latest job session:

• Cumulative session statistics: details on the number of protected databases specified in the backup policy
settings, the number of databases to which settings of the backup policy are applied, and the number of
disconnected databases, details of the session performance, amount of read, processed and transferred
data.

• Detailed statistics for every protected database processed within the session: processing duration details,
backup data size, amount of read and transferred data, list of warnings and errors (if any).

TIP

You can also set up Veeam Backup & Replication to send reports automatically by email. To learn more, see
Enabling Email Reporting.

725 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Enabling Email Reporting
You can set up Veeam Backup & Replication to send reports automatically by email. To do this, you must enable
and configure global email notification settings in Veeam Backup & Replication. To learn more, see the
Configuring Global Email Notification Settings section in the Veeam Backup & Replication User Guide.

In addition, you can enable and configure custom notification settings for a specific protection group or
application backup policy. This may be useful if you want to change subject, notification rules or list of
recipients for some reports.

Rescan Job Report

By default, after you enable and configure global email notification settings in Veeam Backup & Replication,
Veeam Backup & Replication sends rescan job reports at 10:00 PM daily. Veeam Backup & Replication sends a
separate report for every protection group that you configured. The report contains cumulative statistics for
rescan job sessions performed within the last 24-hour period.

You can specify custom notification settings for a specific protection group. To learn more, see Advanced
Settings.

Backup Policy Report

You can specify custom notification settings for a specific backup policy. To learn more, see the following
sections:

• Notification Settings for Veeam Plug-in for Oracle RMAN

• Notification Settings for Veeam Plug-in for SAP HANA

• Notification Settings for Veeam Plug-in for SAP on Oracle

726 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

MongoDB Backup
MongoDB Backup is a backup solution integrated in Veeam Backup & Replication that allows you to back up
MongoDB replica sets. With this solution, Veeam Backup & Replication installs Veeam components on MongoDB
nodes, backs up volumes with MongoDB data and transfers backups to backup repositories configured in Veeam
Backup & Replication.

Database administrators can use Veeam Backup & Replication to create volume-level backups of MongoDB data.
Compared to image-level backups, MongoDB Backup offers more flexible scenarios for database backup. In
particular, MongoDB Backup users can restore individual MongoDB instances and collections, as well as
configure independent backup schedules for full and incremental backups.

727 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Overview
MongoDB Backup uses the backup functionality of Veeam Backup & Replication and Veeam Agent for Linux and
stores backups in Veeam backup repositories. For details, see Solution Architecture.

With the configured application backup policy, you can perform full and incremental backups of MongoDB data.
Use MongoDB Backup to back up databases in the following cases:

• If you want to store MongoDB backups in hardened repositories.

• If you want to perform centralized management of MongoDB backups.

• If you want to restore individual instances and collections.

You must use the Veeam Backup & Replication console for the following tasks:

• Discover computers with MongoDB data and deploy Veeam components on them. For details, see
Computer Discovery and Veeam Components Deployment.

• Configure an application backup policy that contains instructions for Veeam components on how to create
MongoDB backups. For details, see Application Backup Policies.

• Perform and manage the MongoDB backup operations. For details, see MongoDB Backup.

• In case of malware activity or unplanned actions, restore MongoDB items from the backups stored in
Veeam backup repositories. You can restore entire instances or certain collections from a MongoDB
backup. Veeam Backup & Replication supports restoring instances and collections to the original or
another location. For details, see Data Restore.

TIP

If you want to protect the whole server where your databases are located, you can use the image -level
backup functionality of Veeam Backup & Replication or Veeam Agent for Linux. In case of image-level
backup, application-aware processing of MongoDB data is not available.

In This Section
• Solution Architecture

• Computer Discovery and Veeam Components Deployment

• Application Backup Policies

• Data Backup

• Data Restore

728 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Solution Architecture
When you rescan the MongoDB replica set (a group of instances that maintain the same data set) for the first
time, Veeam Backup & Replication deploys the following Veeam components on each computer with the
MongoDB primary daemon process ( mongod ) detected:

• Veeam Transport Service is a service responsible for connection between Veeam Backup & Replication and
Veeam components running on the computer with MongoDB.

• Veeam Mongo Agent is a component that collects information about database hierarchy from the
computer, communicates with mongo daemon for backup operations.

• Veeam Agent for Linux is a component that backs up volumes with MongoDB data and sends the backup
to the target repository.

Veeam Agent for Linux consists of the following components:

o Veeam Agent for Linux Service is a service responsible for managing all tasks and resources in Veeam
Agent. The veeamservice component is registered as a daemon in the Linux OS upon the product
installation. The service is started automatically when you start the OS and runs in the ba ckground.

o Veeam Agent for Linux Job Manager is a process started by Veeam Agent for Linux Service for every
backup policy session.

o Veeam Agent that communicates with the Veeam Agent for Linux Service and Veeam Agent for Linux
Job Manager . Veeam Agent is started by Veeam Agent for Linux Job Manager to perform data transfer
operations of any kind: copy data from the backed-up volume to the backup location during backup,
from the backup location to the target volume during restore, perform data compression, and so on.

o Veeam Agent for Linux Driver is a Veeam driver (Linux kernel module) used to create volume
snapshots in the Linux OS and keep track of changed data blocks.

o To store its configuration data, Veeam Agent uses the SQLite database engine. SQLite requires only
few files to install and takes little resources to run on a Linux OS.

729 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Computer Discovery and Veeam Components
Deployment
Veeam Backup & Replication supports automated deployment of Veeam components on computers with
MongoDB in your infrastructure.

To deploy Veeam components, Veeam Backup & Replication needs to discover MongoDB replica sets whose data
you want to back up. To enable discovery, you must organize your MongoDB replica sets into one or more
protection groups. Protection group settings define what computers Veeam Backup & Replication will discover
and how the discovery process will run. To learn more, see Protection Group for MongoDB.

For automated discovery of protected computers, Veeam Backup & Replication uses the rescan job that runs on
the backup server. To learn more, see Rescan Job.

In This Section
• Protection Group for MongoDB

• Rescan Job

Protection Group for MongoDB

In Veeam Backup & Replication, computers that you want to protect with Veeam Plug -ins or Veeam Agents are
organized into protection groups. A protection group is a container in the Veeam Backup & Replication inventory
aimed to combine protected computers of a specific type.

To start managing computers with MongoDB using Veeam Backup & Replication, you need to create a protection
group for MongoDB in the inventory and specify computers that you want to protect in the protection group
settings. You can create one or more protection groups depending on the size and complexity of your
infrastructure. Protection groups appear under the P hy sical Infrastructure node in the Inventory view of the
Veeam Backup & Replication console.

Keep in mind the following:

• The protection group for MongoDB is designed to back up MongoDB replica sets. Other protection groups
cannot create a volume-level backup of MongoDB data.

• You must add nodes of the same MongoDB replica set to the same protection group.

Veeam Backup & Replication connects to discovered computers using an administrative account or a certificate
specified in the protection group settings. To learn more, see Creating Protection Group for MongoDB.

After you create a protection group, Veeam Backup & Replication starts the rescan job to connect to computers
added to the protection group and perform the required operations on these computers. To learn more, see
Rescan Job.

730 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Rescan Job
For automated discovery of protected computers, Veeam Backup & Replication uses the rescan job that runs on
the backup server. Veeam Backup & Replication automatically creates this job once you create the protection
group in the inventory. The rescan job runs upon schedule defined individually for every protection group in the
protection group settings. By default, Veeam Backup & Replication is set up to perform discovery at 9:00 PM
daily. You can adjust daily schedule in the protection group settings or define periodic schedule.

The rescan job itself is not displayed in the Veeam Backup & Replication console. However, you can start and
stop rescan job sessions manually for a specific protection group, replica set or individual computer in the
inventory. This may be helpful, for example, if new computers appeared in your infrastructure, and you want to
discover these computers without waiting for the next scheduled rescan job session start. For details, see
Rescanning Protection Group and Rescanning Protected Computer.

You can view statistics for currently running and already performed rescan job sessions. For details, see Viewing
Rescan Job Statistics.

How Rescan Job Works

When the rescan job is started, Veeam Backup & Replication performs the following operations:

1. Obtains settings specified for the protection group from the configuration database. The settings include a
list of MongoDB replica sets and computers to scan, accounts to connect to replica sets, and so on.

2. Connects to each computer in a replica set that was added to the backup scope during the protection
group configuration. Veeam Backup & Replication can connect to the added computers using a certificate -
based authentication or using an SSH connection and administrator credentials depending on the
protection group configuration. After the successful connection, Veeam Backup & Replication collects
information about the MongoDB daemon process ( mongod ). To learn about mongod , see MongoDB
documentation.

Keep in mind the following:

o If a computer included in a replica set is not added to the backup scope by the user, Veeam Backup &
Replication does not scan it.

o To connect to a Linux computer using SSH, this Linux computer must be added to the list of trusted
hosts. For details, see Configuring Security Settings.

3. Deploys Veeam components on each newly discovered Linux computer that is added to the backup scope
and has mongod detected.

IMP ORTANT

If the number of nodes in a replica set changes, you must update the protection group configuration
and rescan the protection group. Otherwise, Veeam Backup & Replication does not detect changes of
a replica set. For details, see Editing Protection Group Settings and Rescanning Protection Group.

As a part of component deployment process, Veeam Backup & Replication performs the following
operations:

a. Deploys Veeam Installer Service on each newly discovered computer with the mongod detected.

b. Veeam Installer Service running on the computer collects information about the computer and sends
it to Veeam Backup & Replication. The collected data includes details on the computer (platform, host
name, guest OS, IP address, BIOS UUID) and Veeam Agent for Linux (product presence on the
computer and version).

731 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 c. Veeam Backup & Replication uploads Veeam components from the distribution server to the
discovered computer.

d. Veeam Installer Service deploys Veeam components on the target computer. For example: Veeam
Mongo Agent and Veeam Agent for Linux. For more information on Veeam components required to
back up MongoDB data, see Solution Architecture.

e. Veeam Installer Service retrieves the TLS certificate with a public key from the backup server and
saves the TLS certificate with a public key in the Veeam Agent configuration database on the target
computer. Veeam Backup & Replication will use this certificate to connect to Veeam Agent.

f. Veeam Backup & Replication collects information about mongod on the computer. Veeam Backup &
Replication will use this information for an application backup policy to select the node that will be a
backup source. To learn more, see Backup Source Selection.

4. Connects to each MongoDB replica set using MongoDB Wire Protocol and salted challenge response
authentication mechanism (SCRAM) with or without transport layer security (TLS) d epending on the
protection group configuration. During this step, Veeam Backup & Replication updates information about
nodes in a replica sets that we added to the backup scope. Veeam Backup & Replication will use this
information for an application backup policy to select the node that will be a backup source. For details
about the collected information, see Backup Source Selection.

732 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Application Backup Policies
To back up MongoDB data with Veeam Backup & Replication, you must configure an application backup policy.
With an application backup policy, you can instruct Veeam Backup & Replication to create MongoDB backups in
a Veeam backup repository.

For the application backup policy, all policy management tasks are performed on the Veeam Backup &
Replication server side: Veeam Backup & Replication starts the policy according to the defined schedule,
allocates backup infrastructure resources, and so on. Veeam components running on a protected computer are
controlled by Veeam Backup & Replication and perform data backup operations only. These operations include
creating a volume snapshot, reading the backed-up data and transferring backed-up data to the target location.
For more information, see How Application Backup Policy Works.

To configure an application backup policy, you must launch the New MongoDB Backup Policy wizard. Keep in
mind that this is the only supported policy type for MongoDB backups, as Veeam Backup & Replication provides
settings specific for MongoDB within this policy type. For more information, see Creating Application Backup
Policy.

How Application Backup Policy for MongoDB Works

When you use an application backup policy to create MongoDB backups, Veeam Backup & Replication performs
backup in the following way:

1. When you create an application backup policy in Veeam Backup & Replication, Veeam Backup &
Replication saves the backup policy settings in its database.

2. When a new backup policy session starts, Veeam Backup & Replication collects updated information about
MongoDB nodes. During this step, Veeam Backup & Replication selects the backup source. For details, see
Backup Source Selection.

3. Veeam Backup & Replication starts the Veeam Backup Manager process on the backup server. Veeam
Backup Manager reads policy settings from the configuration database and creates a list of backup tasks
to process.

4. Veeam Backup Manager connects to the Veeam Backup Service. The Veeam Backup Service includes a
resource scheduling component that manages all tasks and resources in the backup infrastructure. The
resource scheduler checks what backup infrastructure resources are available, and assigns backup
repository to process the policy tasks.

5. Veeam Backup Manager connects to Veeam Transport Service on the backup repository. The Veeam
Transport Service starts Veeam Data Mover. A new instance of Veeam Data Mover is started for every
policy task.

6. Veeam Backup Manager establishes a connection with Veeam Agent for Linux that runs on the protected
computer and Veeam Data Mover that runs on the backup repository, and sets a number of rules for data
transfer, such as network traffic throttling rules, and so on.

7. Veeam Agent for Linux that runs on the protected computer and Veeam Data Mover that runs on the
backup repository establish a connection with each other for data transfer.

8. Veeam Backup & Replication connects to protected computers, establishes a connection with Veeam
Mongo Agent running on protected computers and collects MongoDB metadata.

9. Veeam Mongo Agent triggers a WiredTiger checkpoint.

733 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 10. Veeam Agent for Linux creates a snapshot of all volumes with MongoDB data, reads the backed -up data
from the snapshots and transfers data to the backup repository.

To reduce the amount of data transferred and improve the performance of backups, Veeam Agent for
Linux scans the computer disks, detects a MongoDB data directory (for example, /var/lib/mongodb ) and
includes only a disk with this directory into the backup scope.

While transporting backed-up data, Veeam Agent for Linux running on a protected computer performs
additional processing. It filters out zero data blocks, blocks of swap files and blocks of excluded files and
folders. Veeam Agent for Linux compresses backed -up data and transports it to the target Veeam Data
Mover.

11. Veeam Backup & Replication stores backed-up data to the backup file in the backup repository.

Backup Source Selection

During the application backup policy run, Veeam Mongo Agent running on the target computer collects
information about databases included in MongoDB replica sets that were processed during the previous rescan
job. Using this information, Veeam Backup & Replication selects a node in a replica set that will be a backup
source for the backup session.

On the target computer, Veeam Backup & Replication and Veeam Mongo Agent collect information about
MongoDB in the following way:

1. Veeam Backup & Replication connects to each replica set node that was added to the backup scope during
the protection group configuration.

2. Veeam Backup & Replication collects the following node details: topology, health, version. If necessary,
Veeam Backup & Replication also updates mongod and configuration database on the nodes.

3. Veeam Backup & Replication selects a node that will be a backup source. By default, Veeam Backup &
Replication selects the node automatically in the following way:

o If there is a previous backup in a backup chain and the previously selected node is healthy, Veeam
Backup & Replication uses this node as a backup source again.

If the previously selected node is primary, Veeam Backup & Replication will display a warning and
continue to run the job.

734 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 o If there is no previous backups in a backup chain or the previously selected node cannot be selected,
Veeam Backup & Replication selects the node from the replica set as follows:

i. Excludes arbiter nodes.

ii. Excludes unhealthy and unreachable nodes.

iii. Excludes hidden nodes.

iv. From the nodes that are not excluded, Veeam Backup & Replication selects a secondary node
with a call back delay below 30 seconds.

v. If the node is not selected during the previous steps and you allowed Veeam Backup &
Replication to back up from primary nodes, primary nodes are selected.

vi. If several nodes are selected, Veeam Backup & Replication select nodes with the lowest priority
from the set.

vii. If several nodes are still selected, Veeam Backup & Replication removes voting nodes. If all
selected nodes are voting, Veeam Backup & Replication does not remove any nodes.

viii. If several nodes are still selected, Veeam Backup & Replication sorts nodes in the
ascending order by MemberId and selects the first node in the list.

This step does not consider any performance details of a node. It allows Veeam Backup &
Replication to select the node in any configuration.

According to the described logic, Veeam Backup & Replication selects a backup source for each replica set
included in a backup scope.

NOTE

The user can alter the default way Veeam Mongo Agent selects the backup source. For example, the user
can configure Veeam Mongo Agent to use the primary node as a backup source. For more information, see
Specify Backup Preferences.

After the backup source is selected, Veeam Backup & Replication continues the backup operation. For details,
Application Backup Policies.

735 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Data Backup
MongoDB Backup is an integrated solution that uses Veeam Backup & Replication mechanisms to back up data
to the Veeam backup repository. With the configured application backup policy, you can create full and
incremental backups. For details, see Backup Types.

For each backup operation, Veeam Backup & Replication automatically creates and stores database backup files.
For the backup chain, Veeam Backup & Replication also creates a separate metadata file. The metadata file helps
Veeam Backup & Replication to store and manage backup data while ensuring that the data is protected,
accessible, and can be quickly restored when needed. All backup files created for backup policies reside in a
dedicated folder in the backup repository. For details, see Backup Files.

To store backups, you can add and configure backup repositories to your Veeam Backup & Replication
infrastructure. For details on supported backup repositories, see Veeam Backup Repositories.

Backup Types
Veeam Backup & Replication using the Veeam Agent for Linux functionality creates consistent backups of
MongoDB data. Every backup job session produces a new backup file in the target location. Backup files make
up a backup chain. The backup chain can contain files of two types: full backups and incremental backups.

• During the first backup job session, Veeam Backup & Replication performs full backup. It copies all data
that you have chosen to back up (entire volumes) and stores the resulting full back up file (.VBK) in the
target location. The full backup takes significant time to complete and produces a large backup file: you
have to copy the whole amount of data.

• During subsequent backup job sessions, Veeam Backup & Replication performs incremental backups. It
copies only new or changed data relative to the last backup job session and saves this data as an
incremental backup file (.VIB) in the target location. Incremental backups typically take less time than full
backup: you have to copy only changes, not the whole amount of data.

For details about backup files that Veeam Backup & Replication creates, see Backup Files.

After several backup cycles, you have a chain of backup files in the target location: the first full backup file and
subsequent incremental backup files. Every backup file contains a restore point for backed -up data. A restore
point is a "snapshot" of your data at a specific point in time. You can use restore points to roll back your data to
the necessary state.

To recover data to a specific restore point, you need a chain of backup files: a full backup file plus a set of
incremental backup files following this full backup file. If some file from the backup chain is missing, you will
not be able to roll back to the necessary state. For this reason, we recommend that you do not delete separate
backup files manually.

736 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

To create backups, you must configure a protection group and an application backup policy, then run the backup
process. For details about backup of MongoDB data, see Working with Application Backup Policy.

Backup Files
For every application backup policy for MongoDB, Veeam Backup & Replication creates and stores database
backup files, and a separate metadata file for each backup chain. The backup files provide a consistent and
integrated way for Veeam Backup & Replication to store and manage backup data, while ensuring that the data
is protected, accessible and can be quickly restored when needed.

All backup files created by the backup policy reside in a dedicated folder in the backup repository.

Backup Files
Veeam Backup & Replication stores MongoDB backup files in the following formats:

• .VBK — full backup file.

Veeam Backup & Replication creates a full backup file for each replica set in a backup scope.

• .VIB — incremental backup file.

Veeam Backup & Replication creates an incremental backup file for each replica set in a backup scope.

• .VBM — backup metadata file. It contains information about the computer on which the backup was
created, every restore point in the backup chain, how restore points are linked to each other and so on.
The backup metadata file is required for restore operations.

Veeam Backup & Replication creates a backup metadata file for a backup chain. The backup metadata file
is updated with every backup policy session.

Veeam Backup Repositories

You can store MongoDB backup files in repositories added to the Veeam Backup & Replication infrastructure. In
this section, you can find the list of supported backup repositories and limitations for MongoDB backups.

Supported Backup Repositories

You can use the following types of repositories added to the Veeam Backup & Replication infrastructure to store
MongoDB backups:

• Windows Server

• Linux Server

• SMB (CIFS) Share

• NFS Share

• Dell Data Domain with Data Domain Boost (DDBoost)

• Fujitsu ETERNUS CS800

• Infinidat InfiniGuard

737 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 • HPE StoreOnce

If you plan to use HPE StoreOnce as a backup repository for MongoDB backups, the total number of stored
files (data and metadata) must not exceed 3,000,000 per Catalyst store. If necessary, multiple Catalyst
stores may be created on the same StoreOnce system.

• Quantum DXi

• ExaGrid

Make sure the repository is configured as described in the ExaGrid section in the Veeam Backup &
Replication User Guide.

• Hardened Repository

• Object Storage Repository

• Scale-Out Backup Repository

If you plan to use the scale-out backup repository, consider the following:

o Make sure that the scale-out backup repository contains repositories supported by Veeam Backup &
Replication.

o If you plan to store MongoDB backups on scale-out backup repositories, Veeam Backup & Replication
can store MongoDB backup files only in the performance tier. The capacity tier and the archive tier are
not supported for MongoDB backups.

738 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Data Restore
With Veeam Backup & Replication, you can restore MongoDB instances or collections from backups that reside
on Veeam backup repositories. You can restore to the original location or another server. You can also restore
from a backup copy based on MongoDB backups.

Restore operations are performed on the Veeam Backup & Replication side. For all mentioned restore
operations, Veeam Backup & Replication uses the functionality of Veeam Explorer for MongoDB. For details, see
Restoring with Veeam Explorer for MongoDB.

739 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Planning and Preparation
Before you start to use MongoDB Backup, make sure that the Veeam backup server and computers that you plan
to protect meet the system requirements and all required ports are open.

In This Section
• System Requirements

• Permissions Configuring Security Settings

• Ports

• Licensing

740 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

System Requirements
Make sure that components in the plug-in management infrastructure meet the system requirements listed in
this section.

Veeam Backup Server

To learn about system requirements for the Veeam backup server and other Veeam Backup & Replication
components, see the System Requirements section in the Veeam Backup & Replication User Guide.

Computer with MongoDB

A computer with databases you want to protect using MongoDB Backup must meet the following requirements :

Sp ecification Requirement

OS MongoDB Backup supports MongoDB deployments running on the 64-bit

versions of the following distributions:

• Debian 10.13 – 12.5

• Ubuntu 16.04, 18.04, 20.04, 22.04, 22.10, 23.04, 23.10 and 24.04
• RHEL 6.4 – 9.4
• SLES 12 SP4, 12 SP5, 15 SP1 – 15 SP5
• SLES for SAP 12 SP4, 12 SP5, 15 SP1 – 15 SP5

Mong oDB MongoDB Backup supports Enterprise Edition of the following MongoDB
versions 5.0, 6.0, 7.0, 8.0.

For information about what Linux distributions are supported by the

MongoDB version that you use, see MongoDB documentation.

Notes:

• Veeam Backup & Replication connects to MongoDB using MongoDB

Wire Protocol and salted challenge response authentication
mechanism (SCRAM) with or without transport layer security (TLS)
depending on the protection group configuration.
• Community Edition is not supported.
• Standalone servers with MongoDB deployments are not supported.
• MongoDB sharded clusters are not supported.
• The operations log (oplog) backup is not supported. As a result, you
can restore instance or database item only to the moment when
backup is created.

741 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Network
Consider the following:

• A computer with MongoDB must be able to establish a direct IP connection to the Veeam Backup &
Replication server. Thus, a computer with MongoDB cannot work with the Veeam Backup & Replication
server that is located behind the NAT gateway.

• Domain names of the computer with MongoDB deployment, Veeam Backup & Replication server and other
servers in the Veeam backup infrastructure must be resolvable into IPv4 or IPv6 addresses.

742 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Permissions
For general requirements for permissions that must be provided to the user account to install and work with
Veeam Backup & Replication, see the Permissions section in the Veeam Backup & Replication User Guide. In
addition to general requirements, make sure that user accounts have the following permissions:

Op eration Required Roles and Permissions

Connecting to the The account specified in the protection group configuration settings to connect to
MongoDB replica set, the MongoDB replica set must meet the following requirements:
discovering MongoDB
• The account must be able to authenticate against MongoDB admin database.
nodes
• The account must have the the following roles:
o ClusterMonitor role to collect information about replica sets.
o Backup role to perform backup operations.
o HostManager role to lock nodes during backup operations.

To learn more about these roles, see MongoDB documentation.

For details, see Specify Deployments.

The account specified in the protection group configuration settings to connect to

Connecting to
MongoDB nodes must have the following permissions:
MongoDB nodes,
installing and • The account must have root privileges.
updating Veeam • The account must be able to authenticate against the Veeam Backup &
components Replication server.

For enhanced security, we recommend creating a separate standard user that

will be solely dedicated to performing the backup and restore operations.

For details, see Specify Computers.

Restoring MongoDB To restore MongoDB data using Veeam Explorer for MongoDB, consider the required
data permissions in the Permissions section of Veeam Explorers User Guide.

743 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Ports
The following tables describe network ports that must be opened to ensure proper communication of
infrastructure components required for MongoDB Backup.

Communication Between Veeam Backup & Replication

Components
For general requirements for ports that must be opened to ensure proper communication of the backup server
with backup infrastructure components, see the Ports section in the Veeam Backup & Replication User Guide.

In addition to general port requirements applicable to a backup server, the following network ports must be
opened to enable proper communication between Veeam Backup & Replication components.

From To P rotocol P ort Notes

Veeam Computer TCP 22, Port 22 is used to establish an SSH

Backup with 6160, connection from the Veeam Backup
Server MongoDB 6162 Server to the computer with MongoDB.

Ports 6160 and 6162 are used for default

connection to the computer with
MongoDB using Veeam Deployer Service
and Veeam Transport Service.

Note: You can customize ports 6160 and

6162 using registry keys. To learn more,
see this Veeam KB article.

TCP 6162 Default port used by the Veeam Data

Mover.

Note: You can customize port 6162 using

registry keys. To learn more, see this
Veeam KB article.

TCP 2500 to Default range of ports used for

3300 communication between Veeam
components during data transmission. For
every TCP connection that a backup job
uses, one port from this range is assigned.

744 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 From To P rotocol P ort Notes

Distribution TCP 135, Ports on a Microsoft Windows server used

Server UDP 137 to 139, for deploying the Distribution Server
445, component.
6160,
11731 Port 135 is optional. This port is used to
provide faster Veeam components
deployment.

Ports 137 to 139 are used by backup

infrastructure components to
communicate using NetBIOS if you use
NetBIOS in your infrastructure.

Ports 6160 and 11731 are used by the

Veeam Installer Service. These ports
together with port 445 are mandatory to
deploy the Distribution Server
component.

Note: You can customize port 6160 using

registry keys. To learn more, see this
Veeam KB article.

TCP 49152 to Dynamic RPC port range. For more

65535 information, see this Microsoft KB article.

TCP 9380 Default port used for communication with

the Veeam Distribution Service.

Distribution Computer TCP 22, Port 22 is used to establish an SSH

Server with 6160, connection for Veeam components
MongoDB 6162 transmission and deployment control.

After Veeam components are deployed,

ports 6160 and 6162 are used for default
connection to the computer with
MongoDB using Veeam Deployer Service
and Veeam Transport Service.

Note: You can customize ports 6160 and

6162 using registry keys. To learn more,
see this Veeam KB article.

Computer Veeam TCP 10002, Default ports used for communication

with Backup 10006 with the Veeam Backup server.
MongoDB Server
Data between the computer with
MongoDB and backup repositories is
transferred directly, bypassing Veeam
backup servers.

745 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 From To P rotocol P ort Notes

TCP 6160, Default ports used by Veeam Deployer

6162 Service (6160) and Veeam Transport
Service (6162) for communication
between the computer with MongoDB
and Veeam backup server.

Note: You can change the default ports

6160 and 6162 in the respective services'
configuration files. To learn more, see this
Veeam KB article.

Communication with MongoDB Replica Set

The following table describes network ports that must be opened to ensure proper communication between
Veeam backup server and MongoDB replica set that you plan to protect.

From To P rotocol P ort Notes

Veeam Backup & MongoDB TCP 27017 Default port used for
Replication server replica set communication between Veeam
Backup & Replication and
MongoDB.

You can customize the default

port 27017 during the protection
group configuration.

Node in a TCP 27017 Port for communication between

MongoDB Veeam Backup & Replication and
replica set default mongodb configuration.

If you configured a custom port on

the mongod side, Veeam Backup &
Replication will obtain the port
number during the rescan job.

746 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Communication with Veeam Backup Repositories
The following table describes network ports that must be opened to ensure proper communication between
protected computers and Veeam backup repositories.

From To P rotocol P ort Notes

Computer with Linux server TCP 2500 to 3300 Default range of ports used as data
MongoDB performing the transmission channels. For every
role of a backup TCP connection that a job uses,
repository one port from this range is
assigned.

Microsoft TCP 49152 to Dynamic RPC port range. For more

Windows server 65535 information, see this Microsoft KB
performing the (for Microsoft article.
role of a backup Windows 2008
repository and newer)

TCP 2500 to 3300 Default range of ports used as data

transmission channels. For every
TCP connection that a job uses,
one port from this range is
assigned.

SMB (CIFS) TCP 137 to 139, Ports used as a transmission

share UDP 445 channel from the Veeam Agent
performing the computer to the target SMB (CIFS)
role of a backup share.
repository
Ports 137 to 139 are used by
backup infrastructure components
to communicate using NetBIOS if
you use NetBIOS in your
infrastructure.

Gateway TCP 137 to 139, If an SMB (CIFS) share is used as a

Microsoft UDP 445 backup repository and a Microsoft
Windows server Windows server is selected as a
gateway server for this CIFS share,
these ports must be opened on the
gateway Microsoft Windows
server.

Ports 137 to 139 are used by

backup infrastructure components
to communicate using NetBIOS if
you use NetBIOS in your
infrastructure.

747 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 From To P rotocol P ort Notes

TCP 49152 to Dynamic RPC port range. For more

65535 information, see this Microsoft KB
article.

TCP 2500 to 3300 Default range of ports used as data

transmission channels. For every
TCP connection that a job uses,
one port from this range is
assigned.

Communication with 3rd Party Components

The following table describes network ports that must be opened to ensure proper communication between
Veeam backup server and 3rd party infrastructure components.

From To P rotocol P ort Notes

Veeam Microsoft Active TCP 389 LDAP connections.

backup server Directory UDP

TCP 636 LDAP connections.

DNS server with UDP 53 Port used for communication with

forward/reverse the DNS Server.
name resolution of
all backup servers

748 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Licensing
To use the MongoDB Backup functionality, you must have a valid Veeam Backup & Replication license. Licenses
are installed and managed on the Veeam Backup & Replication server that is connected to the MongoDB server.
If the license is not valid or out of resources, application backup policies fail.

This guide provides information only on specifics of Veeam licenses for MongoDB Backup. For terminology and
general information about Veeam Licensing, see Veeam Licensing Policy.

Licensed Objects
All nodes of a MongoDB replica set are assumed protected if the replica set has been processed by an
application backup policy in the last 31 days.

If you use any instance-based (Veeam Universal Licensing) license in Veeam Backup & Replication, you do not
need to install any additional licenses. Each node of the replica set consumes one instance unit from the license.

Servers processed by backup copy jobs are not regarded as protected machines, these types of jobs provide an
additional protection level for machines that are already protected with application backup policies.

A computer protected on both application-level and image-level will consume a license only once. For example,
you create application-level backups of the MongoDB replica set with MongoDB Backup. You also create image -
level backups of Linux servers included as nodes in the replica set with Veeam Agent for Linux. In this case , only
one license per server will be consumed.

NOTE

[For Perpetual per-socket licenses] If you are using a legacy perpetual per-socket license, a license is
required for each hypervisor CPU socket occupied by protected servers.

A socket is consumed from the license only if the hypervisor where protected servers reside is added to the
Veeam Backup & Replication infrastructure. If the hypervisor is not added to the Veeam Backup &
Replication infrastructure, an instance unit will be consumed from the license. To learn how to add a
hypervisor to the Veeam Backup & Replication infrastructure, see the Virtualization Servers and Hosts
section in the Veeam Backup & Replication User Guide.

Supported License Types

You can use MongoDB Backup with the following license types and packages. Note that this guide contains
information on specifics of Veeam license packages only for MongoDB Backup. For the full list of license
packages, see this Veeam webpage.

• For Veeam Universal license:

You can use MongoDB Backup with all license packages ( Veeam Backup Essentials, Veeam Backup &
Replication, Veeam Availability Suite ).
Note that if you use the Rental license type, functionality of MongoDB Backup is supported only for the
Enterprise Plus edition of Veeam Backup & Replication.

• For Socket license:

Functionality of MongoDB Backup is supported only for the Enterprise Plus edition of Veeam Backup &
Replication.

749 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Obtaining and Managing Licenses
To learn how to install a license and monitor licensed objects, see the Licensing section in the Veeam Backup &
Replication User Guide.

750 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Getting Started
To protect MongoDB Backup databases with Veeam Backup & Replication, perform the following operations:

1. Create a protection group for MongoDB. For more information, see Creating Protection Group for
MongoDB.

2. Create an application backup policy to define what data you want to back up and configure backup
settings. For more information, see Creating Application Backup Policy.

3. Run the backup job to create a database backup and store it in the backup repository. To learn more, see
Starting and Stopping Application Backup Policy.

4. In case of a disaster, you can restore data from a backup with Veeam Explorer for MongoDB. For more
information, see Restoring with Veeam Explorer for MongoDB.

751 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Configuring Security Settings
When you configure the backup infrastructure for enterprise applications in Veeam Backup & Replication, you
can specify what security settings Veeam Backup & Replication will use to establish a secure connection
between the backup server and protected computers. By default, Veeam Backup & Replication offers the
following security settings:

• To establish a secure connection between parties, Veeam Backup & Replication uses the default self -
signed TLS certificate.

• Veeam Backup & Replication allows all computers that run a Linux OS to establish a connection to the
backup server using the SSH fingerprint.

Keep in mind that default security settings are only for testing and evaluation purposes. To prevent potential
security issues, you can change security settings. For example, you can use a custom TLS certificate and
verification of Linux host SSH fingerprints.

To specify the security settings, do the following:

1. From the main menu, select Op tions.

2. Click the Security tab.

3. In the Certificate section, check information about the currently used certificate. By default, Veeam
Backup & Replication uses a self-signed TLS certificate generated during the Veeam Backup & Replication
installation process. If you want to use a custom certificate, click Install and specify a new certificate. To
learn more, see Managing TLS Certificates.

4. In the Linux hosts authentication section, specify how Veeam Backup & Replication will add Linux -based
protected computers to the list of trusted hosts. You can select one of the following options:

o Ad d all discovered hosts to the list automatically — with this option enabled, Veeam Backup &
Replication allows all discovered computers that run a Linux OS to connect to the backup server. This
scenario is recommended for demo environments only.

o Ad d unknown hosts to the list manually (more secure) — with this option enabled, only the following
Linux-based computers can connect to the backup server:

▪ Protected computers that have already established a connection to the backup server and have
their fingerprints stored in the Veeam Backup & Replication d atabase. Veeam Backup &
Replication displays the number of such computers in the Trusted hosts field. You can export
the list of trusted Linux computers to a known_hosts file. To do this, click E x port and specify a
path to the folder to save the file.

▪ Protected computers specified in the known_hosts file imported to Veeam Backup & Replication.
To import a known_hosts file, click Imp ort and specify a path to the folder where the file resides.

▪ Protected computers added to the list of trusted hosts in the Veeam Backup & Replication
console. To learn more, see Adding Computers to Trusted Hosts List.

The computers that are not in the list of trusted hosts cannot connect to the Veeam backup server and
download Veeam components during discovery.

5. Click OK.

752 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 TIP

To learn more about other security settings available on the Security tab, see the Configuring Security
Settings section in the Veeam Backup & Replication User Guide.

753 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Managing TLS Certificates
When you configure the backup infrastructure for enterprise applications, you can specify what TLS certificate
must be used to establish a secure connection between the backup server and protected computers. Veeam
Backup & Replication offers the following options for TLS certificates:

• You can choose to keep the default self-signed TLS certificate generated by Veeam Backup & Replication.

• You can use Veeam Backup & Replication to generate a new self-signed TLS certificate. To learn more, see
Generating Self-Signed Certificates.

• You can select an existing TLS certificate from the certificates store. To learn more, see Importing
Certificates from Certificate Store.

• You can import a TLS certificate from a file in the PFX format. To learn more, see Importing Certificates
from PFX Files.

NOTE

If you plan to use a certificate issued by your own Certificate Authority (CA), make sure that the certificate
meets the requirements. To learn more, see Using Certificate Signed by Internal CA.

Generating Self-Signed Certificates

You can use Veeam Backup & Replication to generate a self-signed certificate for authenticating parties in the
backup infrastructure for enterprise applications.

To generate TLS certificates, Veeam Backup & Replication employs the RSA Full cryptographic se rvice provider
by Microsoft Windows installed on the Veeam backup server. The created TLS certificate is saved to the Shared
certificate store. The following types of users can access the generated TLS certificate:

• User who created the TLS certificate

• LocalSystem user account

• Local Administrators group

If you use a self-signed TLS certificate generated by Veeam Backup & Replication, you do not need to take any
additional actions to deploy the TLS certificate on a protected computer. When Veeam Backup & Replication
discovers a protected computer, a matching TLS certificate with a public key is installed on the protected
computer automatically. During discovery, Veeam Installer Service deployed on the protected computer
retrieves the TLS certificate with a public key from the backup server and installs a TLS certificate with a public
key on the protected computer.

NOTE

When you generate a self-signed TLS certificate with Veeam Backup & Replication, you cannot include
several aliases to the certificate and specify a custom value in the Subject field. The Subject field value is
taken from the Veeam Backup & Replication license installed on the Veeam backup server.

To generate a self-signed TLS certificate:

1. From the main menu, select Op tions.

2. Click the Security tab.

3. In the Security tab, click Install.

754 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 4. At the Certificate Type step of the wizard, select Generate new certificate.

5. At the Generate Certificate step of the wizard, specify a friendly name for the created self-signed TLS
certificate.

6. At the Summary step of the wizard, review the certificate properties. Use the Cop y to clipboard link to
copy and save information about the generated TLS certificate. You will be able to use the copied
information to verify the TLS certificate with the certificate thumbprint.

755 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 7. Click Finish. Veeam Backup & Replication will save the generated certificate in the Shared certificate store
on the Veeam backup server.

Importing Certificates from Certificate Store

If your organization has a TLS certificate signed by a CA and the TLS certificate is located in the Microsoft
Windows Certificate store, you can use this certificate for authenticating parties in the backup infrastructure for
enterprise applications.

To select a certificate from the Microsoft Windows Certificate store:

1. From the main menu, select Op tions.

2. Click the Security tab.

3. In the Security tab, click Install.

756 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 4. At the Certificate Type step of the wizard, choose Select certificate from the Certificate Store.

5. At the P ick Certificate step of the wizard, select a TLS certificate that you want to use. You can select only
certificates that contain both a public key and a private key. Certificates without private keys are not
displayed in the list.

6. At the Summary step of the wizard, review the certificate properties.

757 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 7. Click Finish to apply the certificate.

Importing Certificates from PFX Files

You can import a TLS certificate in the following situations:

• Your organization uses a TLS certificate signed by a CA and you have a copy of this certificate in a file of
PFX format.

• You have generated a self-signed TLS certificate in the PFX format with a third-party tool and you want to
import it to Veeam Backup & Replication.

IMP ORTANT

The TLS certificate must pass validation on the Veeam backup server. In the opposite case, you will not be
able to import the TLS certificate.

To import a TLS certificate from a PFX file:

1. From the main menu, select Op tions.

2. Click the Security tab.

3. In the Security tab, click Install.

4. At the Certificate Type step of the wizard, choose Imp ort certificate from a file.

5. At the Imp ort Certificate step of the wizard, specify a path to the PXF file.

758 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 6. If the PFX file is protected with a password, specify the password in the field below.

7. At the Summary step of the wizard, review the certificate properties. Use the Cop y to clipboard link to
copy and save information about the TLS certificate. You can use the copied information on a protected
computer to verify the TLS certificate with the certificate thumbprint.

8. Click Finish to apply the certificate.

Using Certificate Signed by Internal CA

To establish a secure connection between the backup server and protected computers, Veeam Backup &
Replication uses a TLS certificate. By default, Veeam Backup & Replication uses a self -signed certificate. Veeam
Backup & Replication generates this certificate when you install the product on the Veeam backup server.

If you want to use a certificate signed by your internal Certification Authority (CA), make sure that the following
requirements are met:

• Veeam product on the protected computer and Veeam Backup & Replication must trust the CA. That is,
the Certification Authority certificate must be added to the Trusted Root Certification Authority store on
the Veeam backup server and computers with Veeam products.

• Certificate Revocation List (CRL) must be accessible from the Veeam backup server and computers with
Veeam products.

• [For Linux-based computers] OpenSSL version 1.0 or later must be installed on the computer with Veeam
products.

759 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

A certificate signed by a CA must meet the following requirements:

1. The certificate subject must be equal to the fully qualified domain name of the Veeam backup server. For
example: vbrserver.tech.local .

2. The following key usage extensions must be enabled in the certificate to sign and deploy child certifica tes
for computers with Veeam Plug-ins:

o Digital Signature

o Certificate Signing

o Off-line CRL Signing

o CRL Signing (86)

If you use Windows Server Certification Authority, it is recommended that you issue a Veeam Backup &
Replication certificate based on the built-in "Subordinate Certification Authority" template or templates
similar to it.

3. It is highly recommended to add "pathLen=0" to Basic Constraints.

If you use Windows Server Certification Authority, to do this, enable the Do not allow subject to issue
certificates to other CAs option in the certificate template.

4. The key type in the certificate must be set to Exchange.

If you create a certificate request using the Windows MMC console, to specify the key type, do the
following:

a. At the Request Certificates step of the Certificate Enrollment wizard, select a check box next to the
necessary certificate template and click P roperties.

b. In the Certificate Properties window, click the P rivate Key tab.

c. In the Key Type section, select E x change.

760 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

To start using the signed certificate, you must import it from the certificates store on the Veeam backup server.

After you specify the signed certificate in Veeam Backup & Replication, during the next application backup
policy session Veeam products will receive child certificates from the Veeam backup server.

761 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Adding Computers to Trusted Hosts List
After you enable the Ad d unknown hosts to the list manually (more secure) option in Veeam Backup &
Replication settings, Linux-based computers whose SSH fingerprints are not stored in the Veeam Backup &
Replication database become unable to communicate to the Veeam backup server. During discovery, Veeam
Backup & Replication puts such computers to the Untrusted protection group. To start managing an untrusted
computer, you must manually validate the SSH fingerprint and add the computer to the list of trusted hosts in
the Veeam Backup & Replication console.

To add a computer to the list of trusted hosts:

1. Open the Inventory view.

2. In the inventory pane, expand the P hy sical Infrastructure node and click Untrusted.

3. In the working area, Veeam Backup & Replication will display discovered computers that you can add to
the list of trusted hosts. Check SSH fingerprints of the computers and add them to the list of trusted hosts
in one of the following ways:

o To add all computers at once to the list of trusted hosts, select the Untrusted node in the inventory
pane and click Trust All on the ribbon or right-click the Untrusted node and select Trust a ll.

762 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 o To add a specific computer to the list of trusted hosts, select the necessary computer in the working
area and click Trust on the ribbon or right-click the computer and select Trust.

763 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Deploying Veeam Components for
Certificate-Based Authentication
You have an option to install Veeam components on Linux computers using certificate -based authentication
instead of credentials. To do so, you must install Veeam components on the computer, add the computer to a
protection group for MongoDB and configure it to use certificate-based authentication. In this case, Veeam
Backup & Replication does not require SSH connection to install Veeam components.

Deploying Veeam Components

To deploy Veeam components using pre-installed Veeam Deployer Service, perform the following steps:

1. On the Veeam Backup & Replication side, start a Veeam PowerShell session. For more information, see the
Starting Veeam PowerShell Sessions in the Veeam PowerShell Reference.

2. Run the Generate-VBRBackupServerDeployerKit cmdlet to generate the Veeam Deployer Service

temporary certificate and export the Veeam Backup & Replication Deployer Client certificate and Veeam
Deployer Service installation packages.

3. Upload the obtained files on the computer that you want to protect.

4. On the computer side, navigate to the directory where you have saved the files and install Veeam
Deployer Service using a package manager.

5. Run the following commands to install the certificates:

/opt/veeam/deployment/veeamdeploymentsvc --install-server-certificate serv

er-cert.p12
/opt/veeam/deployment/veeamdeploymentsvc --install-certificate client-cert
.pem
/opt/veeam/deployment/veeamdeploymentsvc --restart

6. On the Veeam Backup & Replication side, create a protection group with the following parameters:

a. When launching the New P rotection Group wizard, select a protection group for MongoDB. For
details, see Launch New Protection Group Wizard.

b. At the Comp uters step of the wizard, specify a computer and select the Connect using certificate-
b a sed authentication method to connect to the computer. For details, see Specify Computers.

After you create the protection group, Veeam Backup & Replication will rescan the protection group. During the
rescan operation, Veeam Backup & Replication will replace the Veeam Deployer Service temporary certificate,
connect to the Veeam Deployer Service and install Veeam Agent. To learn more, see Rescan Job.

764 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Working with Protection Group
MongoDB Backup is a feature of Veeam Backup & Replication. This guide gives instructions on how to deploy
Veeam components assuming that you already have deployed Veeam Backup & Replication and configured a
backup repository. To learn how to deploy Veeam Backup & Replication, see the Veeam Backup & Replication
User Guide for your platform.

If you want to use a certificate-based authentication to connect to the protected computers, before configuring
a protection group, you must install Veeam components on the computer. For details, see Deploying Veeam
Components for Certificate-Based Authentication.

To use MongoDB Backup, you must create a protection group dedicated for MongoDB. For details, see Creating
Protection Group for MongoDB.

After you create a protection group, you can perform a certain set of operations with this protection groups. For
details, see Managing Protection Group for MongoDB.

765 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Creating Protection Group for MongoDB
Before You Begin
Before creating a protection group, consider the following prerequisites and limitations:

1. The protection group for MongoDB is designed to back up MongoDB replica sets. Other protection groups
cannot create a volume-level backup of MongoDB data.

2. You must add nodes of a MongoDB replica set to the same protection group. Otherwise, Veeam Backup &
Replication will not have complete information about the MongoDB replica set.

3. After a node of a MongoDB replica set is added to the backup scope of the protection group, Veeam
Backup & Replication automatically deploys Veeam Agent and other Veeam components on this node. If
you do not want to install Veeam components on a particular node, do not include it in the backup scope.
For details, see Specify Computers.

4. When Veeam Backup & Replication performs discovery of protected computers, Veeam Backup &
Replication connects to every computer added to the protection group. If you instruct Veeam Backup &
Replication to perform discovery immediately after the protection group is created, make sure that all
computers added to the protection group are powered on and may be accessed over the network.
Otherwise, Veeam Backup & Replication will be unable to connect to a protected computer and perform
the required operations on this computer.

5. Do not add a computer to a protection group by specifying a dynamic IP address assigned to this
computer. If such computer receives another IP address from a DHCP server, Veeam Backup & Replication
will be unable to discover the computer and perform on this computer operations defined in the
protection group settings.

6. We recommend that you include each object you want to protect in one protection group only. For
example, if you have added a MongoDB replica set to a protection g roup, it is not recommended to add a
computer that is included in this replica set to another protection group. Adding computers to multiple
protection groups with different computer discovery and deployment settings will result in additional load
on the backup server.

7. You cannot back up the same computer with an application backup policy for MongoDB and a Veeam
Agent backup policy. If you plan to create an application-level backup of MongoDB data on the computer
and this computer is already protected with a Veeam Agent backup policy, delete this computer from the
backup scope of the Veeam Agent backup policy. For details, see Editing Veeam Agent Backup Policy
Settings section in Veeam Agent Management Guide.

Alternatively, if you need to create an image-level backup of a node in a MongoDB replica set, you can
exclude this node from the backup scope of the protection group for MongoDB. In this case it can be
backed-up with Veeam Agent backup policy. For details on how to exclude the node from the backup
scope, see Specify Computers.

8. Veeam Backup & Replication does not support usage of a Linux account for which system settings modif y
shell output results to connect to a computer included in the protection group. For example, this includes
Linux accounts with the modified PS1 shell variable.

9. If you plan to use the TLS protocol to connect to the MongoDB replica set, make sure that the Certificate
Authority file of the replica set is added to the Trusted Root Certification Authorities certificate store of
the backup server. To learn more about TLS support by MongoDB, see MongoDB documentation.

766 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 1. Launch New Protection Group Wizard
To launch the New P rotection Group wizard, do the following:

1. Open the Inventory view.

2. Right-click the P hy sical Infrastructure node in the inventory pane and select Ad d protection group.

3. In the Ad d Backup Protection Group window, select Ap p lications > MongoDB.

767 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Step 2. Specify Protection Group Name and Description
At the Na me step of the wizard, specify a name and description for the protection group.

1. In the Na me field, specify a name for the protection group.

2. In the Description field, provide a description for future reference. The default description contains
information about the user who added the protection group, date and time when the protection group
was created.

768 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 3. Specify Deployments
At the Dep loyments step of the wizard, select the MongoDB replica sets that you want to add to the protection
group.

To add a MongoDB replica set to a protection group, do the following:

1. In the DNS name or IP address field, enter a full DNS name, NetBIOS name or IP address of the MongoDB
replica set that you want to add to the protection group.

2. In the P ort field, specify a port number over which Veeam Backup & Replication must communicate with
the MongoDB replica set. By default, Veeam Backup & Replication uses port 27017.

3. From the Account list, select a user account that has administrative permissions on the replica set that you
want to add to the protection group. Veeam Backup & Replication will use this account to connect to the
MongoDB replica set and collect information about replica set configuration. For more information, see
Rescan Job.

If you have not set up credentials beforehand, click the Manage accounts link or click Add on the right to
add credentials. For more information, see the Credentials Manager section in the Veeam Backup &
Replication User Guide.

4. Repeat steps 1–3 for every MongoDB replica set that you want to add to the protection group.

5. Veeam Backup & Replication uses SCRAM authentication mechanism to connect to the MongoDB replica
set. If you also want to use a secure TLS protocol, select the Use TLS check box.

Keep in mind, to use the TLS protocol, the Certificate Authority file of the target replica set must be added
to the Trusted Root Certification Authorities certificate store of the backup server. Otherwise, backup
operations will fail.

769 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 4. Specify Computers
At the Comp uters step of the wizard, select nodes that you want to protect and specify how Veeam Backup &
Replication will connect to them.

To add a node to a backup scope:

1. In the Computers list, select check boxes near computers that you want to include in the backup scope.

2. To configure settings of the computer included in the backup scope, select the computer and click E d it.

TIP

If you want to apply the same settings to several computers, press and hold the [Ctrl] key, select
computers and click E d it.

3. In the E d it Computer window, if necessary, edit the name of the computer that you want to include in the
backup scope using the E nd point field.

4. In the E d it Computer window, select a method to connect to the computer:

o Connect using admin credentials. In this case, from the Credentials list, select a user account that has
administrative permissions on the computer that you want to add to the protection group. Veeam
Backup & Replication will use this account to connect to the protected computer (nodes of a replica
set) and perform the necessary operations on the computer: upload and deploy Veeam components,
and so on.

If you have not set up credentials beforehand, click the Ma nage accounts link or click Ad d on the right
to add credentials.

Veeam Backup & Replication allows you to add the following types of credentials:

▪ Stored credentials. Select stored credentials if you want Veeam Backup & Replication to use the
specified user name and password for each connection to computer.

▪ Single-use credentials. Select single-use credentials if you do not want Veeam Backup &
Replication to store credentials in the configuration database. With this option selected, Veeam
Backup & Replication will use the specified user name and password only for the first connection
to the computer. After that, Veeam Backup & Replication will use Veeam Transport Service to
communicate with the computer.

Keep in mind that the username must be specified in the down-level logon name format. For example,
DOMAIN\UserName or HOSTNAME\UserName. Use the full domain or hostname name. Do not replace
them with a dot.

For more information, see the Credentials Manager section in the Veeam Backup & Replication User
Guide.

o Connect using certificate-based authentication. Select this option, if you chose to pre-install Veeam
Deployer Service on the Linux computer you want to include in the backup scope. In this case, Veeam
Backup & Replication will communicate with the Linux computer using a certificate. Veeam Backup &
Replication will install Transport Service that will be used to perform the necessary operations on the
computer: upload and install Veeam components. To learn more, see Deploying Plug-in for
Certificate-Based Authentication.

770 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 5. To check if Veeam Backup & Replication can communicate with the selected computers, click Test Now.
Veeam Backup & Replication will use the specified credentials to connect to all computers in the list.

771 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 5. Specify Discovery and Deployment Options
At the Op tions step of the wizard, specify settings for protected computers discovery and Veeam components
deployment.

Veeam Backup & Replication regularly connects to protected computers according to the schedule defined in
the protection group settings. At this step of the wizard, you can define the discovery schedule and specify
operations that Veeam Backup & Replication must perform on discovered computers. You can also select which
server in your backup infrastructure should act as a distribution server for Veeam components.

To specify discovery and deployment options:

1. In the Discovery section, define schedule for automatic computer discovery within the scope of the
protection group:

o To run the rescan job at specific time daily, on defined week days or with specific periodicity, select
Da ily at this time. Use the fields on the right to configure the necessary schedule.

o To run the rescan job repeatedly throughout a day with a specific time interval, select P eriodically
every. In the field on the right, select the necessary time unit: Hours or Minutes. Click Schedule and
use the time table to define the permitted time window for the rescan job. In the Sta rt time within an
hour field, specify the exact time when the job must start.

o To run the rescan job continuously, select the P eriodically every option and choose Continuously from
the list on the right. A new rescan job session will start as soon as the previous rescan job session
finishes.

NOTE

You cannot create a protection group without defining schedule for automatic discovery. However,
you can disable automatic discovery for a specific protection group, if needed. To learn more, see
Disabling Protection Group.

2. In the Dep loyment section, select the object that will be responsible for the Veeam components
distribution, select a Microsoft Windows server that you plan to use as a distribution server. Veeam Backup
& Replication will use the distribution server to upload Veeam components setup files to computers added
to the protection group. By default, Veeam Backup & Replication assigns the distribution server role to the
backup server.

3. If you want to instruct Veeam Backup & Replication to automatically upgrade Veeam components on
discovered computers when a new version of the product appears on the Veeam Backup & Replication
server, in the Dep loyment section, make sure that the Auto-update backup agents check box is selected.

772 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 4. Click Ad vanced to specify advanced settings for the protection group. To learn more, see Specify
Advanced Protection Group Settings.

773 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 6. Specify Advanced Protection Group Settings
You can specify email notification settings for the protection group. If you enable notification settings, Veeam
Backup & Replication will send a daily email report with protection group statistics to a specified email address.
The report contains cumulative statistics for rescan job sessions performed for the protection group within the
last 24-hour period.

NOTE

Email reports with protection group statistics will be sent only if you configure global email notification
settings in Veeam Backup & Replication. For more information, see the Configuring Global Email
Notification Settings section in the Veeam Backup & Replication User Guide.

After you enable notification settings for the protection group, in addition to reports sent according to the
global email notification settings, Veeam Backup & Replication will send reports with the protection group
statistics to email addresses specified in the protection group settings. This allows you to fine-tune email
notifications in Veeam Backup & Replication: while one or more backup administrators receive email
notifications according to the global settings, other backup administrators can receive reports for specific
protection groups only.

If you do not enable global email notification settings in Veeam Backup & Replication, notification settings
for the protection group will not be sent even if you enable them in the protection group settings.

To specify notification settings for the protection group:

1. At the Op tions step of the wizard, click Ad vanced.

2. On the Notifications tab, select the Send e-mail notifications to the following recipients check box and
specify a recipient email address. You can enter several addresses separated by a semicolon.

3. In the Send daily summary at field, specify the time when Veeam Backup & Replication must send the daily
email report for the protection group.

4. You can choose to use global notification settings or specify custom notification settings.

To receive a typical notification for the protection group, select Use global notification settings. In this
case, Veeam Backup & Replication will apply to the protection group global email notification settings
specified for the backup server.

To configure a custom notification for the protection group, select Use custom notification settings
sp ecified below. You can specify the following notification settings:

o In the Sub ject field, specify a notification subject. You can use the following variables in the subject:

▪ %JobResult% — rescan job result.

▪ %PGName% — protection group name.

▪ %FoundCount% — number of new computers discovered within the last 24-hour period.

▪ %TotalCount% — total number of computers in the protection group.

▪ %SeenCount% — number of computers in the protection group that were online for the last 24
hours. A computer is considered to be online if Veeam Backup & Replication successfully
connected to this computer during the last rescan session.

o You can select one of the following notification triggers for the protection group rescan job:

▪ Notify on success — when the job completes successfully.

774 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 ▪ Notify on warning — when the job completes with a warning.

▪ Notify on error — when the job fails.

775 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Step 7. Review Components
At the Review step of the wizard, review what Veeam Backup & Replication components are already installed on
the distribution server specified for the protection group and what components will be installed.

1. Review the components.

2. Click Ap p ly to add the configured protection group to the inventory.

776 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Step 8. Assess Results
At the Ap p ly step of the wizard, Veeam Backup & Replication will create the configured protection group. Wait
for the operation to complete and click Nex t to continue.

777 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Step 9. Finish Working with Wizard
At the Summary step of the wizard, complete the protection group configuration process.

1. Review information about the created protection group.

2. To start the rescan job after you close the wizard, make sure that the Run d iscovery when I click Finish
option is selected.

If you want to perform computer discovery later, you can clear the Run d iscovery when I click Finish check
box. In this case, the rescan job will start automatically upon the defined schedule. You can also start the
rescan job manually at any time you need. To learn more, see Rescanning Protection Group.

3. Click Finish to close the wizard.

What You Do Next

After you create a protection group, Veeam Backup & Replication automa tically rescans computers that you
added to the created protection group and deploys Veeam components on these computers. To learn more, see
Rescan Job.

After the rescan process completes and Veeam components are successfully deployed on target computers, you
can create the application backup policy. To learn more, see Creating Application Backup Policy.

778 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Managing Protection Group for MongoDB
In Veeam Backup & Replication, computers with MongoDB are organized into a protection group for
applications. You can perform the following operations with this type of protection groups:

• Add protection group to the existing application backup policy.

• Add protection group to the existing Veeam Agent backup job .

• Edit protection group settings.

• Rescan a protection group.

• Assign location to a protection group.

• Disable a protection group.

• Remove a protection group.

Adding Protection Group to Application Backup Policy

To add a protection group to an application backup policy:

1. Open the Inventory view.

2. In the inventory pane, expand the P hy sical Infrastructure node and do one of the following:

o In the inventory pane, select the protection group that you want to add to the backup policy and click
Ad d to Backup > MongoDB > name of the policy on the ribbon.

o In the inventory pane, right-click the protection group that you want to add to the backup policy and
select Ad d to backup job > Mong oDB > name of the policy .

779 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 NOTE

You can also add a protection group to a new application backup job. To learn more, see Creating
Protection Group for MongoDB.

Adding Protection Group to Veeam Agent Backup Job

You can add a specific protected computer to a Veeam Agent backup job that you have configured in Veeam
Backup & Replication. This may be useful if you want to create an image-level backup of the protected computer
with Veeam Agent for Linux in addition to the application-level backup of MongoDB data. To learn more about
Veeam Agent backup jobs, see the Adding Computer to Backup Job section in the Veeam Agent Management
Guide.

You can add the whole protection group to the Veeam Agent backup job:

1. Open the Inventory view.

2. In the inventory pane, in the P hy sical Infrastructure node, select a protection group you want to add to a
Veeam Agent backup job and do one of the following:

o In the inventory pane, select the protection group that you want to add to the job and click Ad d to
Ba ckup > Linux > name of the job on the ribbon.

o In the working area, right-click the computer that you want to add to the job and select Ad d to
b a ckup job > Linux > name of the job .

780 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 NOTE

Consider the following:

• You can add a protection group to a Veeam Agent backup job configured for computers of the same
platform. For example, you can add a protection group for MongoDB only to a Veeam Agent backup
job for Linux computers.
• You can also add a specific protection group to a new backup job. To learn more, see the Working
with Veeam Agent Backup Jobs and Policies section in Veeam Agent Management Guide.

Editing Protection Group Settings

You can edit the settings of a protection group. This operation may be required, for example, if you added a new
node to the protected MongoDB replica set and you need to add it to a protection group.

To edit protection group settings:

1. Open the Inventory view.

2. In the inventory pane, expand the P hy sical Infrastructure node.

3. In the inventory pane, select the protection group that you want to edit and click E d it Group on the ribbon
or right-click the protection group that you want to edit and select P roperties.

781 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 4. Edit protection group settings as required.

Rescanning Protection Group

When you perform protection group rescan, you manually start the discovery process for the protection group.
This operation may be required, for example, if you want to discover new computers added to the protection
group without waiting for the next rescan.

During the rescan operation, Veeam Backup & Replication starts the rescan job in the same way as in case of
scheduled discovery. The rescan job connects to computers included in the protection group and performs on
these computers operations specified in the protection group settings. For example, you can use the rescan
operation to collect information about configuration updates of the MongoDB replica set added to the backup
scope of the protection group.

To rescan a protection group:

1. Open the Inventory view.

2. In the inventory pane, expand the P hy sical Infrastructure node.

782 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 3. In the inventory pane, select the necessary protection group and click Rescan on the ribbon or right-click
the protection group and select Rescan.

Assigning Location to Protection Group

You can assign a location to a protection group configured in Veeam Backup & Replication. To assign a location:

1. Open the Inventory view.

2. In the inventory pane, expand the P hy sical Infrastructure node.

3. In the inventory pane, select the necessary protection group and click Location > <Location name> on the
ribbon or right-click the necessary protection group and select Loca tion > <Location name> .

783 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

To learn more about locations, see the Locations section in the Veeam Backup & Replication User Guide.

Disabling Protection Group

You can temporary disable a protection group. When you disable a protection group, you disable scheduled
discovery of protected computers added to this protection group. This may be required, for example, if a new
version of Veeam Agent or Veeam Plug-in appears on the Veeam Backup & Replication server, and you do not
want to deploy a new version of the product to all protected computers at once. Instead, you can disable the
protection group, test the deployment process on a specific computer in this group, and then enable the
protection group to let Veeam Backup & Replication deploy a new version of the product to remaining
computers.

When you disable a protection group, Veeam Backup & Replication does not start the rescan job upon schedule
defined in the protection group settings. However, you can start the discovery process manually. To learn more,
see Rescanning Protection Group.

Disabling a protection group does not affect processing of computers included in this protection group. If a
protected computer is added to an application policy, and the application policy is scheduled to start at t he time
when the protection group is in the disabled state, the policy will run as usual.

NOTE

You cannot disable default protection groups that act as filters used to display protected computers of a
specific type: Unmanaged , Out of Date, Offline and Untrusted .

To disable automatic discovery for the protection group:

1. Open the Inventory view.

2. In the inventory pane, expand the P hy sical Infrastructure node.

3. In the inventory pane, select the necessary protection group and click Disable on the ribbon or right-click
the necessary protection group and select Disable.

784 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

To enable automatic discovery for the protection group:

1. Open the Inventory view.

2. In the inventory pane, expand the P hy sical Infrastructure node.

3. In the inventory pane, select the necessary protection group and click E nable on the ribbon or right-click
the necessary protection group and select E na ble.

Removing Protection Group

When you remove a protection group, you can instruct Veeam Backup & Replication to remove Ve eam
components from all protected computers included in this protection group, too. The protection group is
removed permanently. You cannot undo this operation.

Backups created for computers that were included in the removed protection group remain intact in the backup
location. You can delete this backup data manually later if needed.

NOTE

Consider the following:

• You cannot remove a protection group if the entire protection group, a replica set or a computer
included in this protection group is added to an application backup policy, Veeam Agent backup job
or policy.
• You cannot remove default protection groups, such as Unmanaged , Out of Date and so on.

To remove a protection group:

1. Open the Inventory view.

2. In the inventory pane, expand the P hy sical Infrastructure node.

785 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 3. In the inventory pane, select the protection group that you want to remove and click Remove Group on
the ribbon or right-click the protection group and select Remove.

4. If you want to remove Veeam components deployed on protected computers, in the displayed window,
select the Uninstall Everything check box. With this option selected, Veeam Backup & Replication will
remove the protection group from the configuration database and, in addition, uninstall Veeam Plug -ins
and Veeam Agents and other Veeam components from every computer in the deleted protection group.

5. In the displayed window, click Y es .

TIP

If you want to remove a certain node from the protection group, you must exclude it from the backup
scope in the protection group settings. For details, see Specify Computers.

786 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Working with Application Backup Policy
To back up MongoDB items, you must create an application backup policy and add your MongoDB replica sets to
the backup scope. For details, see Creating Application Backup Policy.

After you create a MongoDB backup job, you can back up MongoDB items with this backup job. For details, see
Starting and Stopping Application Backup Policy. Veeam Backup & Replication backs up MongoDB items
according to backup settings that you specify. You can specify what nodes to back up and processing settings
for the backed-up data.

Apart from running, you can perform a certain set of other operations with an application backup job. For
details, see Managing Application Backup Policy.

787 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Creating Application Backup Policy
To back up MongoDB data, you must configure an application backup policy in Veeam Backup & Replication.

Before You Begin

Before you create an application backup policy in the Veeam Backup & Replication console, consider the
following prerequisites and limitations:

• The Veeam Backup & Replication license must have a sufficient number of instances to process computers
that you plan to add to the application backup policy.

• The backup repository where you plan to store backup files must have enough free space.

• A protection groups for MongoDB that you want to add to the policy must be configured in advance. For
details, see Creating Protection Group for MongoDB.

788 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Step 1. Launch New Application Backup Policy Wizard
To create an application policy for MongoDB, you must launch the New MongoDB Backup P olicy wizard. To do
this, on the Home tab, click Ba ck up Job > Ap plication > Mong oDB.

789 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 2. Specify Policy Name
At the Na me step of the wizard, specify a name and description for the application backup policy.

1. In the Na me field, enter a name for the application backup policy.

2. In the Description field, provide a description for future reference. The default description contains
information about the user who created the policy, date and time when the policy was created.

3. Select the Hig h priority check box if you want the resource scheduler of Veeam Backup & Replication to
prioritize this job higher than other similar jobs and to allocate resources to it in the first place. To learn
more, see the Job Priorities section in the Veeam Backup & Replication User Guide.

790 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Step 3. Specify Deployments
At the Dep loyments step of the wizard, select protection groups or replica sets whose data you want to back up.

You can add to the backup scope one or more objects added to inventory in the Veeam Backup & Replication
console.

Application policies with protection groups are dynamic in their nature. If Veeam Backup & Replication discovers
a new computer in a protection group after the policy is created, Veeam Backup & Replication will automatically
update the policy settings to include the added computer.

Adding Objects from Inventory

To add objects to the application backup policy:

1. Click Ad d .

2. In the Select Objects window, select one or more objects in the list and click OK. You can select any of the
following objects:

o Protection group

o MongoDB replica set

You can press and hold [Ctrl] to select multiple objects at once.

NOTE

In the Select Objects window, Veeam Backup & Replication shows only those computers on which Veeam
Backup & Replication have detected MongoDB data during the rescan job. To learn more, see Rescan Job.

To quickly find the necessary object, use the search field at the bottom of the Select Objects window.

1. Enter the object name or a part of it in the search field.

2. Click the Sta rt search button on the right or press [E nter].

791 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Step 4. Specify Storage Settings
At the Storage step of the wizard, specify settings for the target backup repository:

1. From the Ba ckup repository list, select a backup repository where you want to store backups. You can
select from the Veeam backup repositories configured on the backup server that will manage the created
backup policy.

2. You can map the policy to a specific backup stored on the ba ckup repository. Backup job mapping can be
helpful if you have moved backup files to a new backup repository and want to point the policy to existing
backups on this new backup repository. You can also use backup job mapping if the configuration database
got corrupted and you need to reconfigure backup jobs.

To map the job to a backup, click the Ma p backup link and select the backup on the backup repository.
Backups can be easily identified by policy names. To find the backup, you can also use the search fi eld at
the bottom of the window.

NOTE

You can map an application backup policy for MongoDB only to backups created with another
application backup policy for MongoDB. You cannot map your policy to backups created with other
types of backup policies or jobs.

3. In the Retention Policy field, specify the number of days for which you want to store backup files in the
target location. By default, Veeam Backup & Replication keeps backup files for 7 days. After this period is
over, Veeam Backup & Replication will remove the earliest restore points from the backup chain.

4. To use the GFS (Grandfather-Father-Son) retention scheme, select the Keep certain full backups longer
for archival purposes check box and click Configure. In the Configure GFS window, specify how weekly,
monthly and yearly full backups must be retained. To learn more, see the Long-Term Retention Policy
(GFS) section in the Veeam Backup & Replication User Guide.

5. Click Ad vanced to specify advanced settings for the backup policy. To learn more, see Specify Advanced
Backup Settings.

792 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 5. Specify Advanced Backup Settings
In the Ad vanced Settings window, you can specify advanced settings for the application backup policy:

• Backup settings

• Maintenance settings

• Storage settings

• Notification settings

TIP

After you specify necessary settings for the application backup policy, you can save them as default
settings. To do this, click Sa ve as Default at the bottom left corner of the Ad vanced Settings window.
When you create a new backup policy, Veeam Backup & Replication will automatically apply the default
settings to the new policy.

Backup Settings
To specify settings for a backup chain created with the backup policy:

1. In the Ad vanced Settings window, click the Ba ckup tab.

2. To define the schedule for synthetic full backups, select the Create synthetic full backups periodically on
check box and click Configure . In the Schedule Settings window, define the schedule:

o To create a synthetic full backup once a month on specific da ys, select Monthly on. Use the fields on
the right to configure the necessary schedule.

o To create a synthetic full backup once a week on specific week days, select W eekly. Use the fields on
the right to select the necessary week days.

3. To define the schedule for active full backups, select the Create active full backups periodically on check
box and click Configure. In the Schedule Settings window, define the schedule:

o To create a active full backup once a month on specific days, select Monthly on. Use the fields on the
right to configure the necessary schedule.

793 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 o To create a active full backup once a week on specific week days, select W eekly. Use the fields on the
right to select the necessary week days.

Maintenance Settings
To specify maintenance settings for a backup chain created with the backup policy:

1. In the Ad vanced Settings window, click the Ma intenance tab.

2. To periodically perform a health check for the latest restore point in the backup chain, in the Storage-level
corruption guard section, select the P erform backup files health check check box and click Configure to
specify the time schedule for the health check.

An automatic health check can help you avoid a situation where a restore point gets corrupted, making all
dependent restore points corrupted, too. If during the health check Veeam Backup & Replication detects
corrupted data blocks in the latest restore point in the backup chain (or the restore point before the latest
one if the latest restore point is incomplete), it will start the health check retry and transport valid data
blocks from the protected computer to the Veeam backup repository. The transported data blocks are
stored to a new backup file or the latest backup file in the backup chain, depending on the data corruption
scenario. For more information, see the Health Check for Backup Files section in the Veeam Backup &
Replication User Guide.

3. To periodically compact a full backup, select the Defragment and compact full backup file check box and
click Configure to specify the schedule for the compact operation.

794 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 NOTE

The Defragment and compact full backup file option is not available for backup policies targeted at
an object storage repository. For object storage, Veeam Backup & Replication offers a special health
check mechanism as default. To run the health check for object storage, enable the P erform backup
files health check option in the Storage-level corruption guard section and specify the health check
schedule.

For more information, see the Health Check for Object Storage Repositories section in the Veeam
Backup & Replication User Guide.

During the compact operation, Veeam Backup & Replication creates a new empty file and copies to it data
blocks from the full backup file. As a result, the full backup file gets defragmented and the speed of
reading and writing from/to the backup file increases.

If the full backup file contains data blocks for deleted items (protection groups or individual computers),
Veeam Backup & Replication removes these data blocks. For more information, see the Compact of Full
Backup File section in the Veeam Backup & Replication User Guide.

NOTE

Consider the following:

• If you want to periodically compact a full backup, you must make sure that you have enough
free space in the target location. For the compact operation, the amount of free space must
be equal to or more that the size of the full backup file.
• In contrast to the compact operation for a VM backup, during compact of a full MongoDB
backup file, Veeam Backup & Replication does not perform the data take out operation. If the
full backup file contains data for a machine that has only one restore point and this restore
point is older than 7 days, Veeam Backup & Replication will not extract data for this machine
to a separate full backup file.

795 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Storage Settings
To specify compression settings for the backup policy:

1. In the Ad vanced Settings window, click the Storage tab.

2. From the Compression level list, select a compression level for the backup: None, Dedupe-friendly ,
Optimal, High or Extreme. To learn more about the compression levels, see the Data Compression section
in the Veeam Backup & Replication User Guide.

3. From the Storage optimization list, select what type of backup target you plan to use. Depending on the
chosen storage type, Veeam Backup & Replication will use data blocks of different size to optimize the
size of backup files and policy performance: 4 MB, 1 MB, 512 KB or 256 KB.

4. To encrypt the content of backup files, select the E na ble backup file encryption check box. In the
P a ssword field, select a password that you want to use for encryption. If you have not created the
password beforehand, click Ad d or use the Ma nage passwords link to specify a new password. For more
information, see the Password Manager section in the Veeam Backup & Replication User Guide.

If the backup server is not connected to Veeam Backup Enterprise Manager, you will not be able to restore
data from encrypted backups in case you lose the password. Veeam Backup & Replication will display a
warning about it: Loss protection disabled . For more information, see the Decrypting Data Without
Password section in the Veeam Backup & Replication User Guide.

You can also select a Key Management System (KMS) server in the P a ssword field. The KMS server must
be added to Veeam Backup & Replication in advance. If you choose to use KMS keys for backup file
encryption at this step of the wizard, Veeam Backup & Replication immediately starts communication with
the KMS server to retrieve the encryption keys. To learn more, see the Key Management System Keys
section in the Veeam Backup & Replication User Guide.

796 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 NOTE

Consider the following:

• If you plan to encrypt the content of backup files, consider the limitations listed in the Storage
Settings subsection.
• You must encrypt the backup policy if you want to back up data to the storage in Veeam Data
Cloud Vault.

Data Encryption Limitations

If you plan to encrypt the content of backup files, consider the following limitations:

• Encryption is not retroactive. If you enable encryption for an existing backup policy, Veeam Backup &
Replication will encrypt the backup chain starting from the next restore point created with this policy.

• If you enable encryption for an existing backup policy, during the next backup policy session Veeam
Backup & Replication will create a full backup file. The created full backup file and subsequent
incremental backup files in the backup chain will be encrypted with the specified password.

To learn more about data encryption in Veeam Backup & Replication, see the Data Encryption section in the
Veeam Backup & Replication User Guide.

Notification Settings
To specify notification settings for the backup policy:

1. In the Ad vanced Settings window, click the Notifications tab.

797 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 2. Select the Send SNMP notifications for this job check box if you want to receive SNMP traps when the
policy completes successfully.

SNMP traps will be sent if you specify global SNMP settings in Veeam Backup & Replication and configure
software on recipient's machine to receive SNMP traps. For more information, see the Specifying SNMP
Settings section in the Veeam Backup & Replication User Guide.

3. Select the Send e-mail notifications to the following recipients check box if you want to receive
notifications about the job completion status by email. In the field below, specify a recipient email
address. You can enter several addresses separated by a semicolon.

Email notifications will be sent if you configure global email notification settings in Veeam Backup &
Replication. For more information, see the Configuring Global Email Notification Settings section in Veeam
Backup & Replication User Guide.

4. You can choose to use global notification settings or specify custom notification settings.

o To receive a typical notification for the backup policy, select Use g lobal notification settings. In this
case, Veeam Backup & Replication will apply to the backup policy global email notification settings
specified for the backup server. Veeam Backup & Replication will send the email report containing
backup policy statistics at 8:00 AM daily.

o To configure a custom notification for the backup policy, select Use custom notification settings
sp ecified below. You can specify the following notification settings:

i. In the Sub ject field, specify a notification subject. You can use the following variables in the
subject: %Time% (completion time), %JobName%, %JobResult%, %ObjectCount% (number of
machines in the backup policy) and %Issues% (number of machines in the backup policy that
have been processed with the Warning or Failed status).

ii. Select the Notify on success, Notify on warning and Notify on error check boxes to receive email
notification if the policy completes successfully, completes with a warning or fails.

iii. Select the Sup press notifications until the last retry check box to receive a notification about the
final job status. If you do not enable this option, Veeam Backup & Replication will send one
notification per every job retry.

798 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 6. Specify Backup Preferences
At the Ba ckup Preferences step of the wizard, specify processing settings for the nodes of the replica set you
plan to back up:

1. Select the object and click E d it.

2. Specify processing settings for the objects in the list. To learn more, see Processing settings.

In the list, Veeam Backup & Replication shows only those objects that you ad ded to the backup scope at the
Dep loyments step of the wizard. If you added a protection group, but need to specify settings for an individual
replica set in this protection group, you can add such object to the list. To learn more, see Adding Objects from
Backup Scope.

Adding Objects from Backup Scope

To add replica sets to the Credentials list:

1. Click Ad d .

2. In the Select Objects window, select one or more replica sets in the list and click OK.

You can press and hold [Ctrl] to select multiple objects at once.

To quickly find the necessary replica set, use the search field at the bottom of the Select Objects window.

1. Enter the replica set name or a part of it in the search field.

2. Click the Sta rt search button on the right or press [E nter].

Processing Settings
To specify processing settings:

1. At the Ba ckup Preferences step of the wizard, select the object and click E d it.

799 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 2. By default, Veeam Backup & Replication backs up data from a selected secondary node of a replica set. If
this node becomes primary, Veeam Backup & Replication selects another secondary node. If you want
Veeam Backup & Replication to back up data from the primary node, select the Allow data processing
from the primary node check box. In this case, Veeam Backup & Replication will continue backing up data
from the node even if it becomes a primary member of a replica set.

3. If necessary, specify which nodes Veeam Backup & Replication must prefer as a backup source:

o Select Select the preferred node automatically if you want Veeam Backup & Replication to prefer
secondary nodes of a replica set that correspond to requirements described in Backup Source
Selection.

o Select Sp ecify the preferred node and select the node in the drop-down list if you want Veeam
Backup & Replication to prefer a certain node of a replica set. The drop -down list contains all
computers that you added to the backup scope at the Computers step of the New Protection Group
wizard.

If you specified the preferred node but this node becomes unhealthy or unreachable, you can instruct
Veeam Backup & Replication to switch to the automatic node selection. To do so, select the Fa il over
to a utomatic selection if the specified node becomes unavailable check box.

800 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Step 7. Specify Policy Schedule
At the Schedule step of the wizard, specify the schedule according to which you want to perform backup.

To specify the policy schedule:

1. Select the Run the job automatically check box. If this check box is not selected, you will have to start the
backup policy manually to create backup.

2. Define scheduling settings for the policy:

o To run the policy at specific time daily, on defined week days or with specific periodicity, select Da ily
a t this time. Use the fields on the right to configure the necessary schedule.

o To run the policy once a month on specific days, select Monthly at this time. Use the fields on the
right to configure the necessary schedule.

o To run the policy repeatedly throughout a day with a specific time interval, select P eriodically every.
In the field on the right, select the necessary time unit: Hours or Minutes.

o To define the permitted time window for the policy, click Schedule and use the time table. In the Start
time within an hour field, specify the exact time when the policy must start.

A repeatedly run policy is started by the following rules:

▪ The defined interval always starts at 12:00 AM. For example, if you configure to run a policy
with a 4-hour interval, the policy will start at 12:00 AM, 4:00 AM, 8:00 AM, 12:00 PM, 4:00 PM
and so on.

▪ If you define permitted hours for the policy, after the denied interval is over, the policy will start
immediately and then run by the defined schedule.

For example, you have configured a policy to run with a 2-hour interval and defined permitted hours
from 9:00 AM to 5:00 PM. According to the rules above, the policy will first run at 9:00 AM, when
the denied period is over. After that, the policy will run at 10:00 AM, 12:00 PM, 2:00 PM and 4:00
PM.

o To chain jobs and policies, use the After this job field. In the common practice, jobs start one after
another: when item A finishes, item B starts and so on. If you want to create a chain of items, you
must define the time schedule for the first item in the chain. For the rest of the items in the chain,
select the After this job option and choose the preceding item from the list.

NOTE

The After this job option will automatically start a job if the first job in the chain is started
automatically by schedule. If you start the first job manually, Veeam Back up & Replication will
display a notification. You will be able to choose whether Veeam Backup & Replication must
start the chained job as well.

3. In the Automatic retry section, define whether Veeam Backup & Replication must attempt to run the
backup policy again if the policy fails for some reason. Enter the number of attempts to run the policy and
define time intervals between them.

4. In the Ba ckup window section, define the time interval within which the backup policy must complete. The
backup window prevents the policy from overlapping with production hours and ensures that the policy
does not impact performance of your server. To set up a backup window for the policy:

a. Select the Terminate job if it exceeds allowed backup window check box and click W ind ow.

801 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 b. In the Time P eriods window, define the allowed hours and prohibited hours for backup. If the policy
exceeds the allowed window, it will be automatically terminated.

NOTE

If you configure a backup policy, after you click Ap p ly at the Schedule step of the wizard, Veeam Backup &
Replication will immediately apply the backup policy to protected computers.

802 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 8. Review Policy Settings
At the Summary step of the wizard, complete the configuration process for the application backup policy.

1. Review settings of the configured backup policy.

2. Select the Run the job when I click Finish check box if you want to enable the policy right after you finish
working with the wizard. After that, you can start the policy manually or wait for the scheduled start.

3. Click Finish to close the wizard.

803 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Managing Application Backup Policy
You can use the Veeam Backup & Replication console to perform the following operations with an application
backup policy:

• Start and stop backup operations on computers added to the backup policy .

• Retry a backup policy run.

• Perform active full backup on computers added to the backup policy.

• Edit backup policy settings.

• Enable and disable a backup policy.

• Clone a backup policy.

• Delete a backup policy.

Starting and Stopping Application Backup Policy

You can manually start an application backup policy. This may be helpful if you want to create an additional
restore point in the backup chain and do not want to change the backup schedule. You can also stop the backup
process, for example, if processing of a computer is about to take long, and you do not want the backup process
to produce workload on the production environment during business hours.

Veeam Backup & Replication does not check whether connection to computers is active at the time when the
command is sent. Keep in mind that the start or stop operation will be performed only on those computers that
received the command from the backup server.

Running Application Backup Policy

To start an application backup policy on computers added to this backup policy:

1. Open the Home view.

2. In the inventory pane, select Job s .

804 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 3. In the working area, select the backup policy and click Sta rt on the ribbon or right-click the policy and
select Sta rt.

Stopping Application Backup Policy

To stop application backup policy on computers added to this backup policy:

1. Open the Home view.

2. In the inventory pane, select Job s .

805 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 3. In the working area, select the backup policy and click Stop on the ribbon or right-click the policy and
select Stop . In the displayed window, click Y es .

Retrying Backup Policy

You can manually retry an application backup policy configured in Veeam Backup & Replication if the policy
failed during the previous policy session. When you retry a backup policy, Veeam Backup & Replication
processes only those computers in the policy that were not processed successfully during the previous policy
session.

To retry a policy:

1. Open the Home view.

2. In the inventory pane, select Job s .

806 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 3. In the working area, select the application backup policy and click Retry on the ribbon or right-click the
policy and select Retry.

Performing Active Full Backup

You can create an ad-hoc full backup — active full backup, and add it to the backup chain on the backup
repository. The active full backup resets the backup chain. All subsequent incremental backups use the active
full backup as a starting point. The previously used full backup will remain on the backup repository until it is
removed from the backup chain according to the retention job.

When you start active full backup for a backup policy, Veeam Backup & Replication does not check whether
connection to computers is active at the time when the command is sent. Keep in mind that the active full
backup operation will be performed only on those computers that received the command from the backup
server.

To perform active full backup on computers added to the backup policy:

1. Open the Home view.

2. In the inventory pane, select Job s .

807 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 3. In the working area, select the backup policy and click Active full on the ribbon or right-click the policy
and select Active full. After that, confirm the backup policy start.

Editing Backup Policy Settings

You can edit settings of an application backup policy at any time. For example, you may want to change the
backup scope, target location or scheduling settings for application backup policies running on protected
computers.

NOTE

If you want to change a backup repository, you must disable a policy. To learn more, see Enabling and
Disabling Backup Policy. In this case during the next run the policy will produce a full backup.

To edit backup policy settings:

1. Open the Home view.

2. In the inventory pane, select Job s .

3. In the working area, select the backup policy and click E d it on the ribbon or right-click the policy and
select E d it.

808 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 4. Complete the steps of the E d it Application Backup Policy wizard to change the policy settings as required.

Enabling and Disabling Backup Policy

You can temporarily disable scheduled application backup policies configured in Veeam Backup & Replication.
When you disable a job, Veeam Backup & Replication does not start the job by the specified schedule. You can
start a disabled job manually at any time you need. You can also enable a disabled job at any time.

To disable an application backup policy:

1. Open the Home view.

2. In the inventory pane, select Job s .

3. In the working area, select the application backup policy and click Disable on the ribbon or right-click the
policy and select Disable.

If you disabled a backup policy in the Veeam Backup & Replication console, this backup policy will not
start by schedule.

809 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

To enable a disabled policy, select it in the list and click Disable on the ribbon once again.

Cloning Backup Policy

You can clone application backup policies configured in Veeam Backup & Replication. For example, you may
want to configure a backup policy that will be used as a template, and use this policy to create multiple policies
with similar settings.

To clone a backup policy:

1. Open the Home view.

2. In the inventory pane, select Job s .

3. In the working area, select the backup policy and click Clone on the ribbon or right-click the backup policy
and select Clone.

810 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 4. After a backup policy is cloned, you can edit all its settings, including the policy name.

Deleting Backup Policy

You can permanently remove a disabled application backup policy from Veeam Backup & Replication. Backups
created by this backup policy remain on the target location.

To remove an application backup policy:

1. Open the Home view.

2. In the inventory pane, select Job s .

3. In the working area, select the application backup policy and click Disable on the ribbon or right-click the
policy and select Disable.

4. Wait for Veeam Backup & Replication to disable the application backup policy, then select the backup
policy and click Delete on the ribbon or right-click the policy and select Delete.

811 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

After the job is deleted, the backups created by this job are displayed under the Ba ckups > Disk ( Orphaned)
node.

812 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Managing Protected Replica Sets
You can perform the following operations with replica sets added to the inventory in Veeam Backup &
Replication:

• Rescan a protected replica set.

• Add a protected replica set to an application backup policy for MongoDB.

• View properties of a protected replica set.

813 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Rescanning Protected Replica Set
You can rescan protected replica sets added to the inventory. The rescan operation may be required, for
example, if you want to refresh information about the replica set in the Veeam Backup & Replication database.
During the rescan operation, Veeam Backup & Replication communicates with a MongoDB replica set and
collects information about the replica set and computers in the replica set. Then, Veeam Backup & Replication
stores all the collected information in the configuration database.

To rescan a protected computer:

1. Open the Inventory view.

2. In the inventory pane, expand the P hy sical Infrastructure node and select the necessary protection group.

3. In the inventory pane, select the replica set and click Rescan on the ribbon or right-click the replica set
and select Rescan.

814 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Adding Replica Set to Application Backup Policy
To add a replica set to an application backup policy:

1. Open the Inventory view.

2. In the inventory pane, expand the P hy sical Infrastructure node and do one of the following:

o In the inventory pane, select the replica set that you want to add to the backup policy and click Add to
Ba ckup > name of the policy on the ribbon.

o In the inventory pane, right-click the replica set that you want to add to the backup policy and select
Ad d to backup job > name of the policy .

NOTE

You can also add a replica set to a new application backup job. To learn more, see Creating Protection
Group for MongoDB.

815 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Viewing Properties
You can view detailed information about protected replica sets. The detailed infor mation provides the following
data:

• Replica set connection parameters (DNS name, NetBIOS name or IP address and port number)

• MongoDB version

• Date and time of the last successful rescan job

To view detailed information about a protected replica set:

1. Open the Inventory view.

2. In the inventory pane, expand the P hy sical Infrastructure node and select the necessary protection group.

3. In the inventory pane, select the replica and click Details on the ribbon or right-click the replica set and
select Details.

816 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Managing Protected Computers
You can perform the following operations with computers added to the inventory in Veeam Backup &
Replication:

• Rescan a protected computer.

• Add a protected computer to a Veeam Agent backup job.

• View properties of a protected computer.

• Manage Veeam Agent installed on a protected computer:

o Install Veeam Agent on a protected computer.

o Upgrade Veeam Agent on a protected computer.

o Uninstall Veeam Agent on a protected computer.

• Uninstall all Veeam Agents and Veeam Plug-ins on a computer.

817 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Rescanning Protected Computer
You can rescan protected computers added to the inventory. The rescan operation may be required, for
example, if you want to refresh information about the protected computer in the Veeam Backup & Replication
database. During the rescan operation, Veeam Backup & Replication communicates to Veeam Installer Service
running on the protected computer, retrieves information about the computer and stores this information to the
configuration database.

To rescan a protected computer:

1. Open the Inventory view.

2. In the inventory pane, expand the P hy sical Infrastructure node and select the necessary protection group.

3. In the working area, select the computer and click Rescan on the ribbon or right-click the computer and
select Rescan.

818 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Adding Computer to Veeam Agent Backup Job
You can add a specific protected computer to a Veeam Agent backup job that you have configured in Veeam
Backup & Replication. This may be useful if you want to create an image-level backup of the protected computer
with Veeam Agent for Linux in addition to the application-level backup of MongoDB data. To learn more about
Veeam Agent backup jobs, see the Adding Computer to Backup Job section in the Veeam Agent Management
Guide.

To add a protected computer to a Veeam Agent backup job:

1. Open the Inventory view.

2. In the inventory pane, in the P hy sical Infrastructure node, select a protection group whose computers you
want to add to a Veeam Agent backup job and do one of the following:

o In the working area, select the computer that you want to add to the job and click Ad d to Backup >
name of the job on the ribbon.

o In the working area, right-click the computer that you want to add to the job and select Ad d to
b a ckup job > name of the job .

NOTE

Consider the following:

• You can add a computer to a Veeam Agent backup job configured for computers of the same
platform. For example, you can add a Linux computer only to a Veeam Agent backup job for Linux
computers.
• You can also add a specific protected computer to a new backup job. To learn more, see the Working
with Veeam Agent Backup Jobs and Policies section in Veeam Agent Management Guide.

819 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Viewing Properties
You can view detailed information about protected computers. The detailed information provides the following
data:

• Host name

• IP address

• Fingerprint (for computers running a Linux OS)

• Key algorithm (for computers running a Linux OS)

• Operating system

• Veeam product version

To view detailed information about a protected computer:

1. Open the Inventory view.

2. In the inventory pane, expand the P hy sical Infrastructure node.

3. In the working area, select the computer and click Details on the ribbon or right-click the computer and
select Details.

820 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Managing Veeam Agent
You can use the backup console to manage Veeam components on a specific computer in the inventory.

Installing Veeam Agent

You can install Veeam Agent on a specific protected computer in the inventory. This operation may be required,
for example, if you want to test the installation process before allowing Veeam Backup & Replication to deploy
Veeam Agent to all computers included in the protection group.

Before you install Veeam Agent, check that the protected computer is powered on and able to be connected
over the network.

To install Veeam Agent on a protected computer:

1. Open the Inventory view.

2. In the inventory pane, expand the P hy sical Infrastructure node and select the necessary protection group.

3. In the working area, select the necessary computer and click Install Agent on the ribbon or right-click the
computer and select Ag ent > Install agent and select the plug-in you want to install.

Upgrading Veeam Agent

In the Veeam Backup & Replication console, you can upgrade Veeam Agents on the computers that are added to
a protection group for MongoDB.

821 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

From the Veeam Backup & Replication console, you can upgrade Veeam Agent on a protected computer in two
ways:

• Automatically — You can use this method to upgrade all outdated Veeam Agents on computers in a
protection group. To enable automatic update, select the Auto-update backup agents option in the
protection group settings. For more information, see Specify Discovery and Deployment Options.

• Manually — You can upgrade Veeam Agent on an individual computer in a protection group. This method
may be required, for example, if you did not allow Veeam Backup & Replication to automaticall y upgrade
Veeam Agent on computers included in the protection group and want to test the upgrade process on a
selected computer first.

Before You Begin

Before you upgrade Veeam Agent, verify the following:

• The protected computer is powered on and able to be connected over the network.

• There are no running application policies.

We recommend that you do not stop running application policies and let them complete successfully.
Disable any periodic jobs temporarily to prevent them from starting during the upgrade.

TIP

During the protected computers discovery process, Veeam Backup & Replication checks the version of
Veeam Agent running on a protected computer and the version of Veeam Agent available on the
distribution server. If a newer version of Veeam Agent becomes available on the distribution server, and
automatic upgrade of Veeam Agent is disabled for a protection group, Veeam Backup & Replication puts a
computer to the Upgrade required state.

In addition, Veeam Backup & Replication includes computers that require upgrade of Veeam Agent in the
Out of Date protection group. You can upgrade Veeam Agent on all computers that require upgrade at
once. To learn more, see Upgrading Veeam Agents Automatically.

Upgrading Veeam Agents Automatically

You can upgrade Veeam Agent on all computers that require upgrade at once. To upgrade Veeam Agent on
protected computers:

1. Open the Inventory view.

2. In the inventory pane, in the P hy sical Infrastructure node, select the Out of Date protection group and
click Up g rade Agents on the ribbon or right-click the Out of Date protection group and select Up g rade.

822 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 NOTE

In some cases, upgrade to the new version of Veeam Plug -in may require computer reboot.

Upgrading Veeam Agent Manually

To upgrade Veeam Agent manually on a certain protected computer:

1. Open the Inventory view.

2. In the inventory pane, expand the P hy sical Infrastructure node and select the necessary protection group.

3. In the working area, select the necessary computer and click Up grade agent on the ribbon or right-click
the computer and select Ag ent > Up grade agent.

823 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 NOTE

In some cases, upgrade to the new version of Veeam Plug -in may require computer reboot.

Uninstalling Veeam Agent

You can remove Veeam Agent from a specific protected computer, for example, if you want to reinstall Veeam
Agent running on the protected computer.

To uninstall Veeam Agent:

1. Open the Inventory view.

2. In the inventory pane, expand the P hy sical Infrastructure node and select the necessary protection group.

3. In the working area, select the necessary computer and click Uninstall agent on the ribbon or right-click
the computer and select Ag ent > Uninstall and select Veeam Agent you want to uninstall.

4. In the displayed notification window, click Y es .

824 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 NOTE

Consider the following:

• If automatic installation of Veeam Agent is enabled in the protection group settings, after you
remove Veeam Agent from a selected computer, Veeam Backup & Replication will install Veeam
Agent on this computer during the next rescan job session started by schedule.
• Prerequisite components installed and used by MongoDB Backup are not removed during the
uninstall process. To remove the remaining components, use the built-in tools directly on this
computer.

825 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Uninstalling Veeam Components
You can uninstall all the following Veeam product components installed on a protected computer as one
operation:

• Veeam Agents

• Veeam Plug-ins

• Veeam Deployer Service

• Veeam Transport Service

This approach is helpful if several products are installed on the protected computer, and you do not want to
uninstall the products individually.

TIP
• To learn about Veeam Agents, see Veeam Agent Management Guide.
• For details on Veeam Plug-ins, Veeam Installer Service, Veeam Deployer Service and Veeam
Transport Service, see Veeam Plug-in Management Infrastructure.

Before you start the uninstall process, consider the following:

• Veeam Deployer Service and Veeam Transport Service are not removed from the computer with Veeam
Plug-in if the computer is added to the Veeam backup infrastructure as a managed server. To learn more,
see the Virtualization Servers and Hosts section in the Veeam Backup & Replication User Guide.

• Veeam Deployer Service is not removed if Veeam Backup & Replication connects to the protected
computer with single-use credentials.

• Prerequisite components installed and used by Veeam Products are not removed during the uninstall
process. To remove the remaining components, use the built-in tools directly on this computer.

To uninstall Veeam Agents, Veeam Plug-ins and other Veeam product components:

1. Open the Inventory view.

2. In the inventory pane, expand the P hy sical Infrastructure node and select the necessary protection group.

3. In the working area, select the necessary computer and click Uninstall Everything on the ribbon or right-
click the computer and select Uninstall everything.

826 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 4. In the displayed notification window, click Y es .

827 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Managing Application Backups
You can perform administration tasks with backups created on a Veeam backup repository by application backup
policies configured in Veeam Backup & Replication. You can perform the following tasks:

• Restore a database item from an application backup using Veeam Explorer.

• Delete an application backup from configuration.

• Delete an application backup from disk.

• Create a backup copy.

828 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Restoring from Backup with Veeam Explorer
You can recover MongoDB instance or collection items from backups created with the MongoDB Backup feature
of Veeam Backup & Replication.

To restore MongoDB data items, Veeam Backup & Replication uses Veeam Explorer for MongoDB. For details,
see the Restoring MongoDB Backups section in the Veeam Explorers User Guide.

Alternatively, to perform restore from the MongoDB backup, you can also use Veeam Explorer cmdlets. For
details, see the Veeam Explorer for MongoDB section in the the Veeam Explorers PowerShell Reference.

Restoring from Backup

To restore database from an application backup:

1. Open the Home view.

2. In the inventory pane, click Ba ck ups.

3. In the working area, click Mong oDB Items on the ribbon or right-click the backup and select Restore
Mong oDB items.

829 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Removing Backup from Configuration
If you want to remove records about application backups from the Veeam Backup & Replication console and
configuration database, you can use the Remove from configuration operation. When you remove an application
backup from configuration, the actual backup files remain on the backup repository. You can import the backup
to the Veeam Backup & Replication at any time later and restore data from it.

You can remove specific child backups — backups related to individual computers in the backup.

NOTE

You can use the Veeam Backup & Replication console to remove backups created by application backup
policies in the Veeam backup repository. Backups created on a local drive of a protected computer or in a
network shared folder are not displayed in the Veeam backup console.

To remove an application backup from configuration:

1. Open the Home view.

2. In the inventory pane, click Ba ck ups.

3. To remove a backup of a specific computer in the application backup policy, expand the parent backup,
select the necessary computer, press and hold the [Ctrl] key, right-click the backup and select Remove
from configuration.

830 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Deleting Backup from Disk
If you want to delete records about application backups from the Veeam Backup & Replication console and
configuration database and, additionally, delete backup files from the backup repository, you can use the Delete
from disk operation.

You can remove specific child backups — backups related to individual computers in the backup.

To remove an application backup from the backup repository:

1. Open the Home view.

2. In the inventory pane, click Ba ck ups.

3. In the working area, select the backup and click Delete from > Disk on the ribbon or right-click the backup
and select Delete from disk.

831 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Creating Backup Copy Job
The main backup purpose is to protect your data against disasters and virtual or physical machine failures.
However, having just one backup does not provide the necessary level of safety. The primary backup may get
destroyed together with production data, and you will have no backups from which you can restore data.

To build a successful data protection and disaster recovery plan, it is recommended that you follow the 3-2-1
rule:

• 3: You must have at least three copies of your data: the original production data and two backups.

• 2: You must use at least two different types of media to store the copies of your data, for example, local
disk and cloud.

• 1: You must keep at least one backup off-site, for example, in the cloud or in a remote site.

Thus, you must have at least two backups and they must be in different locations. If a disaster takes out your
production data and local backup, you can still recover from your off-site backup.

To help you adopt the 3-2-1 rule, Veeam Backup & Replication offers backup copy capabilities. Backup copy
allows you to create several instances of the same backup data in different locations, whether on-site or off-
site. Backup copies have the same format as those created by backup jobs and you can recover your data from
them when you need it.

Backup copy is a job-driven process. Veeam Backup & Replication fully automates the backup copy process and
lets you specify retention settings to maintain the desired number of restore points, as well as full backups for
archival purposes.

Before creating a job, check prerequisites. Then use the New Backup Copy Job wizard to configure a backup
copy job.

1. Launch Backup Copy Job wizard.

2. Specify a job name and description.

3. Select backups to process.

4. Define backup copy target.

5. Map a backup file.

6. Specify advanced settings.

7. Specify data path settings.

8. Define backup copy schedule.

9. Finish working with the wizard.

Before You Begin

Before you create a backup copy job, check the prerequisites and limitations:

• Backup infrastructure components that will take part in the backup copy process must be added to the
backup infrastructure and properly configured. These include source and target backup repositories
between which backups must be copied.

• The target backup repository must have enough free space to store copied backups. To receive alerts
about low space on the backup repository, configure global notification settings. For more information,
see Specifying Other Notification Settings.

832 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 • If you plan to create backup copy job for a backup created with MongoDB Backup and target this backup
copy job at the scale-out backup repository, note that Veeam Backup & Replication can store files of such
backup copy job only in the performance tier. The capacity tier and the archive tier a re not supported as a
target for backup copies containing MongoDB backups.

• Veeam Cloud Connect repositories are not supported as a target for backup copies containing MongoDB
backups.

833 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 1. Launch Backup Copy Job Wizard
To create a backup copy job, do one of the following:

• If you do not have backups created with Veeam Plug -ins, on the Home tab, click Ba ckup Copy.

• If you have backups created with Veeam Plug-ins, on the Home tab, click Ba ckup Copy and click Ima ge-
level backup copy.

834 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 2. Specify Job Name and Description
At the Job step of the wizard, specify basic settings for the backup copy job:

1. In the Na me field, specify a name for the job.

2. In the Description field, provide a description for the job.

The default description contains information on a user who created the job, date and time when the job
was created.

3. Select a backup copy mode. For more information on copy modes and backup types supported in each
mode, see the Backup Copy Modes section in the Veeam Backup & Replication User Guide.

o Select Immediate copy to copy new restore points as soon as they appear.

o Select P eriodic copy to copy the most recent restore points.

835 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 3. Select Backups to Process
At the Ob jects step of the wizard, select workloads whose restore points you want to copy to the target backup
repository:

1. Click Ad d .

2. Select a type of a source from which you want to copy restore points:

o From jobs. You will see existing backup jobs. Veeam Backup & Replication will copy restore points
created by the selected backup jobs.

[For the periodic copy mode] Note that if multiple jobs process one workload, Veeam Backup &
Replication copies only restore points created by the first job in the Ob jects to process list.

o From repositories. You will see all backup repositories in the backup infrastructure. Veeam Backup &
Replication will copy restore points stored on the selected backup repositories.

If you select repositories as sources, and target new jobs to the repositories in future, Veeam Backup
& Replication will update backup copy job settings automatically to include these jobs to be copied.

3. In the Ad d Objects window, select the necessary sources or workloads.

4. Click Ad d .

5. [For the immediate copy mode] If you have configured processing of transaction log backups in the source
backup jobs, and want to copy these log backups to the target repository, select the Include database
tra nsaction log backups check box.

NOTE

If you delete the source backup job after creating the backup copy job, backup files will become orphaned.
The orphaned backup files are displayed under the Ba ckups > Disk (Orphaned) node.

836 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 4. Define Backup Copy Target
At the Ta rget step of the wizard, define a target backup repository and configure retention policy:

1. From the Ba ckup repository list, select a backup repository where copied backups must be stored.

IMP ORTANT

If you plan to create backup copy job for a backup created with MongoDB Backup, you cannot select
Veeam Cloud Connect repository as a backup copy target. Otherwise, the backup copy process for
MongoDB workloads will fail.

2. In the Retention Policy field, configure the short-term retention policy for restore points:

o If you want to keep the last <N> restore points, select restore points from the drop-down list and
specify the number of restore points.

o If you want to keep all restore points created during the last <N> days, select days from the drop-
down list and specify the number of days.

When the specified number is exceeded, the earliest restore point will be removed from the backup chain
or will be merged with the next closest restore point. For more information on how Veeam Backup &
Replication retains the desired number of restore points, see the Short-Term Retention Policy section in
the Veeam Backup & Replication User Guide.

NOTE

If you enable the GFS retention, the short-term retention policy will not be able to delete and merge
the GFS backup files. Thus, the backup copy chain will have more restore points than specified in the
short-term retention policy.

3. If you want to create weekly, monthly and yearly full backups, you can configure long -term retention
policy (GFS retention policy). GFS full backups will not be deleted or modified until the specified retention
period expires. For more information on the GFS retention policy and its limitations, see the Long-Term
Retention Policy (GFS) section in the Veeam Backup & Replication User Guide.

To configure GFS retention policy, do the following:

a. Select the Keep certain full backups longer for archival purposes check box.

b. Click Configure.

c. In the Configure GFS window, select the necessary GFS backup options. You can configure Veeam
Backup & Replication to create weekly, monthly and yearly restore points. For details on settings of
the GFS retention, see the Backup Copy GFS Cycles section in the Veeam Backup & Replication User
Guide.

NOTE

Before you implement the GFS retention policy, see the Limitations and Considerations section in the
Veeam Backup & Replication User Guide.

837 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 4. You can define a way to create weekly, monthly and yearly full backups:

o Synthetic Full Method: With this method, during the GFS backup copy creation, Veeam Backup &
Replication does not copy data from the source backup repository but synthesizes full backups from
backup files that are already stored in the target backup repository. This approach helps to reduce
load on the network and production environment.

The synthetic full method is used by default. To use this method, leave the Rea d the entire restore
p oint from source instead of synthesizing it from increments option unselected.

o Active Full Method: With this method, Veeam Backup & Replication copies data for archive full
backups from the source backup repository. This method decreases load on the target repository but
increases load on the network and production environment.

To use this method, select the Rea d the entire restore point from source instead of synthesizing it
from increments option.

838 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 5. Map Backup File
If the target backup repository already stores a backup of workloads that you want to copy, you can map the
backup copy job to this backup.

The backup copy job will use the backup as a seed. As a result, Veeam Backup & Replication will transfer less
data over network. For more information, see the Backup Copy Job Mapping section in the Veeam Backup &
Replication User Guide.

To map the backup copy job to a backup:

1. At the Ta rget step of the wizard, click the Ma p backup link.

2. In the Select Backup window, select a backup that contains restore points of workloads that you want to
copy.

NOTE

If a backup that you plan to use as a seed is encrypted, you must enable encryption for the backup copy
job. The password that you use for the backup copy job can differ from the password used for the init ial
job.

839 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 6. Specify Advanced Settings
At the Ta rget step of the wizard, click Ad vanced to configure maintenance, storage, RPO warning, notifications
and scripts settings.

• Maintenance Settings

• Storage settings

• RPO warning settings

• Notification settings

• Scripts settings

TIP

After you specify advanced settings for the backup copy job, you can save them as default settings. For
this, click Sa ve as Default at the bottom left corner of the Ad vanced Settings window. When you create a
new backup copy job, Veeam Backup & Replication will automatically apply the default settings to the new
job.

Maintenance Settings
To specify settings for backup files stored in the target backup repository:

1. At the Ta rget step of the wizard, click Ad vanced.

2. If you want to periodically perform a health check of the most recent restore point in the backup chain,
select the P erform backup files health check check box. To specify the schedule for the health check, click
Configure.

By default, the health check is scheduled to start at 5:00 on last Sunday of every month. For more
information on the health check, see the Health Check for Backup Files section in the Veeam Backup &
Replication User Guide.

3. Select the Remove deleted items data after check box and specify the retention policy settings for deleted
workloads.

By default, the deleted item retention period is 30 days. It is recommended that you set the retention
period to 3 days or more to prevent unwanted data loss. For more information on the retention policy and
its limitations, see the Deleted Items Retention section in the Veeam Backup & Replication User Guide.

4. To periodically compact a full backup, select the Defragment and compact full backup file check box. To
specify the schedule for the compacting operation, click Configure.

By default, the compact operation is disabled. For more information on compact of full backup files, see
the Compact of Full Backup File section in the Veeam Backup & Replication User Guide.

840 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 IMP ORTANT

When enabling the Defragment and compact full backup file option, consider the following:

• The Defragment and compact full backup file option can be enabled only if GFS retention
policy is disabled.
• The target backup repository must have enough space to store a file of the full backup size.
During the compact process, Veeam Backup & Replication creates an auxiliary .VBK file that
exists in the backup repository until the end of the compact operation.

Storage Settings
To specify compression, deduplication and encryption settings for backup files stored in the target backup
repository, do the following:

1. At the Ta rget step of the wizard, click Ad vanced.

2. Click the Storage tab.

3. In the Da ta reduction section, specify data compression and deduplication settings:

o By default, Veeam Backup & Replication performs deduplication before storing copied data in the
target backup repository. To disable data deduplication, clear the E na ble inline data deduplication
check box.

For more information on deduplication, see the Deduplication section in the Veeam Backup &
Replication User Guide.

o From the Compression level list, select a compression level.

For more information on data compression levels, see the Data Compression section in the Veeam
Backup & Replication User Guide.

841 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 4. In the E ncryption section, specify encryption settings:

o To encrypt the backup file created by the backup copy job, select the E na ble backup file encryption
check box.

o From the P a ssword field, select a password that you want to use to encrypt the backup file. If you
have not created a password beforehand, click Ad d or use the Ma nage passwords link to specify a new
password. For more information, see Password Manager.

NOTE

When specifying encryption settings, consider the following:

• If you enable encryption for an existing backup copy job, Veeam Backup & Replication applies new
settings only starting from the next active full backup (created manually or by the GFS schedule).
The active full backup file and subsequent incremental backup files in the backup chain will be
encrypted with the specified password.
Note that if you disable the Rea d the entire restore point from source backup instead of synthesizing
it from increments option in the backup copy job, you will have synthetic full backups, not active full
backups. For details, see Define Backup Copy Target.
• Encryption is not retroactive. If you enable encryption for an existing job, Veeam Backup &
Replication does not encrypt the previous backup chain created with this job. If you want to start a
new chain so that the unencrypted previous chain can be separated from the encrypted new chain,
follow the scenario described in this Veeam KB article.

RPO Warning Settings

You can instruct a backup copy job to display a warning if a newly created restore point or transaction log is not
copied within the desired recovery point objective (RPO). The RPO is counted down from the moment when the
source backup job finishes and is ready to be copied.

To mark a job with the Warning status when the RPO is exceeded, do the following:

1. At the Ta rget step of the wizard, click Ad vanced.

842 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 2. Click the RP O Monitor tab.

3. Select the W hen new backup is not copied within check box.

4. In the fields on the right, specify the desired RPO in minutes, hours or days. If you specify days, RPO
monitor will consider calendar days instead of the 24 hours period.

5. If you have enabled copying of log backups, select the W hen new log backup is not copied within check
box.

6. In the fields on the right, specify the desired RPO in minutes, hours or days.

Notification Settings
To specify notification settings for the backup copy job:

1. At the Ta rget step of the wizard, click Ad vanced.

2. Click the Notifications tab.

3. Select the Send SNMP notifications for this job check box if you want to receive SNMP traps when the job
completes successfully. In the periodic copy mode, you will receive notifications when the entire backup
copy job finishes. In the immediate copy mode — when copying of each source backup job finishes.

SNMP traps will be sent if you specify global SNMP settings in Veeam Backup & Replication and configure
software on the recipient workload to receive SNMP traps. For more information, see the Specifying SNMP
Settings section in the Veeam Backup & Replication User Guide.

4. Select the Send email notifications to the following recipients check box if you want to receive
notifications by email in case of job failure or success. In the field under the check box, specify the
recipient email address. You can enter several addresses separated by a semicolon.

Veeam Backup & Replication sends notifications when copying of each source backup job finishes. For
example, if your backup copy job contains two source backup jobs, you will receive two emails. For more
information on how to configure global notification settings, see the Configuring Global Email Notification
Settings section in the Veeam Backup & Replication User Guide.

843 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

 5. In the Send daily summary at field, specify when you want to send notifications about backup copy jobs
that process log backups. Veeam Backup & Replication sends a consolidated report once a day at the
specified time.

6. You can choose to use global notification settings or specify custom notification settings.

o To receive a typical notification for the job, select Use global notification settings. In this case, Veeam
Backup & Replication will apply to the job global email notification settings specified for the backup
server. For more information, see the Configuring Global Email Notification Settings section in the
Veeam Backup & Replication User Guide.

o To configure a custom notification for a job, select Use custom notification settings specified below.
You can specify the following notification settings:

i. In the Sub ject field, specify a notification subject. You can use the following variables in the
subject: %Time% (completion time), %JobName% (the backup copy job name and source
backup job name in the CopyJobName\SourceJobName format), %JobResult%,
%ObjectCount% (number of workloads in the job) and %Issues% (number of workloads in the
job that have been processed with the Warning or Failed status).

ii. Select the Notify on success, Notify on warning and Notify on error check boxes to receive
email notification if data processing completes successfully, completes with a warning or
fails.

7. [For the immediate copy mode] Select when you want to receive notifications, Immediately after each
cop ied backup option or Da ily as a summary.

Scripts Settings
To specify script settings for the backup copy job:

1. At the Ta rget step of the wizard, click Ad vanced.

2. Click the Scripts tab.

844 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

 3. Select the Run the following script before the job and Run the following script after the job check boxes
to execute custom scripts before and after the backup copy job. Note that in the immediate copy mode,
scripts are executed for every source backup job.

Then click Browse and select executable files from a local folder on the backup server. The scripts will be
executed on the backup server after the transformation processes are completed on the target repository

4. You can change how often the scripts must be executed:

o To run the scripts after a specific number of backup copy sessions, select Run scripts every... backup
session option and specify the number of sessions.

o To run the scripts on specific days, select the Run scripts on selected days only option and click the
Da y s button to specify week days.

NOTE

If you select the Run scripts on the selected days only option, Veeam Backup & Replication
executes scripts only once on each selected day — when the job runs for the first time. During
subsequent job runs, scripts are not executed.

845 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 7. Specify Data Path Settings
At this step of the wizard, you can select how Veeam Backup & Replication will transport backed up data —
directly or through WAN accelerators. By default, during the backup copy job Veeam Backup & Replication
transports data directly from the source backup repository to target backup repository . This type of transport is
recommended if you plan to copy backup files over high-speed connections.

If you plan to copy backup files over WAN or slow connections, it is recommended that you configure source and
target WAN accelerators in the backup infrastructure and copy backups through these WAN accelerators. For
more information, see the WAN Acceleration section in the Veeam Backup & Replication User Guide.

To use WAN acceleration for the backup copy job:

1. At the Da ta Transfer step of the wizard, select the Through built-in W AN accelerators option.

2. From the Source WAN accelerator list, select a WAN accelerator configured in the source site.

3. From the Ta rget WAN accelerator list, select a WAN accelerator configured in the target site.

Requirements and Limitations for WAN Accelerators

• You must not assign one source WAN accelerator to several backup copy jobs that you plan to run
simultaneously.

The source WAN accelerator requires a lot of CPU and RAM resources and does not process multiple
backup copy tasks in parallel. As an alternative, you can create one backup copy job for all workloads you
plan to process over one source WAN accelerator. The target WAN accelerator, however, can be assigned
to several backup copy jobs.

• [For WAN accelerators with the high bandwidth mode disabled] It is recommended that you pre -populate
the global cache on the target WAN accelerator before you start the backup copy job. Global cache
population helps reduce the amount of traffic transferred over WAN. For more information, see the
Manually Populating Global Cache section in the Veeam Backup & Replication User Guide.

• You cannot use WAN accelerators for backup copy jobs that copy backups of Amazon EC2 instances.

846 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Step 8. Define Backup Copy Schedule
At the Schedule step of the wizard, you can define a time span in which the b ackup copy job will transport data
between source and target backup repositories.

The way you can configure the schedule depends on the selected backup copy mode:

• Periodic

• Immediate

To define a backup window for the periodic backup copy job:

1. Select the Run the job automatically check box.

2. Select the required schedule option:

o Da ily at this time. You can specify the time and select the days option from the drop -down list on
which the backup copy job will run: E veryday, On weekdays or On these days. If you select the On
these days option, click Da ys to specify them.

o Monthly at this time. You can specify the time and select the day options from the drop -down lists on
which the backup copy job will run. Click Months to specify months on which the backup copy job will
run.

o P eriodically every. You can select the time options from the drop-down list or click Schedule to select
the desired time area. Use the P ermitted and the Denied options to mark the selected time segments.
Use the Sta rt time within an hour option to specify minutes.

o After this job. If you choose this option, select the job from the drop-down list after which the backup
copy job will start.

3. To configure the backup copy job automatic retries, select the Retry failed items processing check box and
specify the amount of retries and time intervals between them.

4. Select the Terminate job if it exceeds allowed backup window check box if you want the job to terminate
itself to prevent performance impact during production hours. Click W indow to select the desired backup
window time area. Use the P ermitted and Denied options to mark the selected time segments.

847 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

To define a backup window for the immediate backup copy job:

1. Select when the job can transfer data:

o Any time

o During the following time periods only

2. If you selected the During the following time periods only option, specify the required backup window
option. Use the E na ble and Disable options to mark the selected time segments as allowed or prohibited
for the backup copy job.

848 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Step 9. Review Backup Copy Job Settings
At the Summary step of the wizard, complete the procedure of backup copy job configuration:

1. Review details of the backup copy job.

2. Select the Run the job when I click Finish check box if you want to start the job right after you finish
working with the wizard.

3. Click Finish to close the wizard.

849 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Reporting
You can view real-time statistics for rescan jobs, as well as application backup policies configured in Veeam
Backup & Replication. You can also generate reports with statistics data for performed rescan job or backup job
sessions. You can generate reports manually in the Veeam Backup & Replication console or set up Veeam Backup
& Replication to send reports automatically by email.

850 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Viewing Rescan Job Statistics
You can view statistics about performed rescan job sessions. When you create a protection group or manually
start the discovery process for a protection group or individual protected computer, Veeam Backup &
Replication displays statistics for the currently running rescan job session. In the statistics window, Veeam
Backup & Replication displays session duration details and a list of operations performed during the job.

In addition to overall rescan job statistics, the statistics window provides information on each protected
computer processed within the rescan job session. To view the processing progress for a specific computer,
select it in the list on the left.

You can also view statistics for any performed rescan job session. To view rescan job statistics, do one of the
following:

• Open the Inventory view. In the inventory pane, select the necessary protection group and click Sta tistics
on the ribbon or right-click the protection group and select Sta tistics.

• Open the History view. In the inventory pane, select the Sy stem node. In the working area, select the
necessary rescan job session and click Sta tistics on the ribbon or right-click the rescan job session and
select Sta tistics.

851 | V eeam Plug-ins for Enterprise A pplications | User Guide | 12.3.0.310

Viewing Rescan Job Report
You can generate reports with details about rescan job sessions performed for a specific protection group. The
report contains data on the latest rescan job session initiated for the job upon schedule. To generate a report:

1. Open the Inventory view.

2. In the inventory pane, select the necessary protection group and click Rep ort on the ribbon or right-click
the protection group and select Rep ort.

The report contains the following data:

• Cumulative session statistics: details of the session performance, including the number of protected
computers in the protection group and the number of newly discovered computers.

• Detailed statistics for every protected computer processed within the session: DNS name, IP address and
operating system of the protected computer, list of warnings and errors (if any).

TIP

You can also set up Veeam Backup & Replication to send reports automatically by email. To learn more, see
Enabling Email Reporting.

852 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Viewing Backup Policy Statistics
You can view statistics about application backup policies configured in Veeam Backup & Replication. Veeam
Backup & Replication displays statistics in the following way:

After the application backup policy session statistics becomes available in Veeam Backup & Replication, this
statistics appears in the policy statistics window. The policy session statistics becomes available in Veeam
Backup & Replication on real-time basis.

TIP

In addition to backup policy statistics, Veeam Backup & Replication displays individual backup session
statistics for each computer in the backup policy. You can view these statistics in the La st 24 Hours node of
the Home view and in the History view of the Veeam backup console.

To view application backup policy statistics:

1. Open the Home view.

2. In the inventory pane, click the Job s node.

3. In the working area, double-click the necessary application backup policy. Alternatively, you can select the
necessary application backup policy and click Sta tistics on the ribbon or right-click the backup policy and
select Sta tistics.

853 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Viewing Backup Policy Report
You can generate a report with details about application backup policy sessions performed on protected replica
sets added to a backup policy. The report contains data on the latest backup policy session initiated for the
backup policy. To generate a report:

1. Open the Home view.

2. In the inventory pane, click the Job s node.

3. In the working area, select the necessary report, click Rep ort on the ribbon or right-click the backup policy
and select Rep ort.

The report contains data on the latest policy session:

• Cumulative session statistics: details on the number of protected replica sets specified in the backup
policy settings and the number of disconnected replica sets, details of the session performance, amount of
read, processed and transferred data.

• Detailed statistics for every protected replica sets processed within the session: processing duration
details, backup data size, amount of read and transferred data, list of warnings and errors (if any).

TIP

You can also set up Veeam Backup & Replication to send reports automatically by email. To learn more, see
Enabling Email Reporting.

854 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Enabling Email Reporting
You can set up Veeam Backup & Replication to send reports automatically by email. To do this, you must enable
and configure global email notification settings in Veeam Backup & Replication. To learn more, see the
Configuring Global Email Notification Settings section in the Veeam Backup & Replication User Guide.

In addition, you can enable and configure custom notification settings for a specific protection group or
application backup policy. This may be useful if you want to change subject, notification rules or list of
recipients for some reports.

Rescan Job Report

By default, after you enable and configure global email notification settings in Veeam Backup & Replication,
Veeam Backup & Replication sends rescan job reports at 10:00 PM daily. Veeam Backup & Replication sends a
separate report for every protection group that you configured. The report contains cumulative statistics for
rescan job sessions performed within the last 24-hour period.

You can specify custom notification settings for a specific protection group. For details, see Advanced Settings.

Backup Policy Report

You can specify custom notification settings for a specific backup policy. For details, see Notification Settings.

855 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Restoring with Veeam Explorer for
MongoDB
You can restore MongoDB data from backups created with the MongoDB Backup feature of Veeam Backup &
Replication. Veeam Backup & Replication supports restore of entire instances or cer tain collections to the
original or to another location. Veeam Backup & Replication restores MongoDB data to the time when the
restore point was created.

IMP ORTANT

It is recommended to create a full backup immediately after you restore a database. All subsequent log or
differential backups of the restored database will be based on this full backup. This action helps prevent
potential data loss.

Before you perform database restore, consider the following:

• The backup policy that created the backup must be present in Veeam Backup & Replication.

• To restore to another location under another user account, the account must have the Restore operator or
Backup administrator role on the Veeam backup server.

• To restore to another location, you must perform the restore operation on the target server, where you
want to place the restored instance or collection.

To restore MongoDB data, Veeam Backup & Replication uses Veeam Explorer for MongoDB for restore
operations. To learn more about restore operations, see the following sections in Veeam Explorers User Guide:

1. Restoring Single Collection

2. Restoring Multiple Collections

3. Restoring Instance

856 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Retention of MongoDB Backups
To set an automatic removal of old backups, you can set the retention policy for MongoDB backups during the
application backup policy configuration. After that, Veeam Backup & Replication automatically deletes backup
files which are older than specified number of days. For details, see Storage Settings.

In the storage settings, you can also set the GFS (Grandfather-Father-Son) retention scheme. This scheme
allows you to store MongoDB backups for long periods of time — for weeks, months and years. To learn more,
see the Long-Term Retention Policy (GFS) section in the Veeam Backup & Replication User Guide.

Also, you can manually delete backups from a backup repository using the Veeam Backup & Replication console.
For details, see Deleting Backups Manually Using Veeam Backup & Replication Console.

857 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310

Logs and Support
If you have any questions or issues with Veeam Backup & Replication, you can search for a resolution on Veeam
R&D Forums or submit a support case on the Veeam Customer Support Portal.

When you submit a support case, attach a file containing logs related to Veeam Backup & Replication and Veeam
Agent for Linux operations.

Veeam Agent for Linux Logs

To export Veeam Agent for Linux logs, run the following command on the protected computer with MongoDB:

veeamconfig grablogs

Veeam Agent will collect logs, export them to an archive file with the name
veeam_logs_<date>_<time>.tar.gz, and save the archive to the current working directory.

For example:

user@srv01:~$ veeamconfig grablogs

Logs have been exported successfully.

Veeam Backup & Replication Logs

For details on how to collect Veeam Backup & Replication logs, see the Exporting Logs section in the Veeam
Backup & Replication User Guide.

858 | V eeam Plug-ins for Enterprise Applications | User Guide | 12.3.0.310