Veeam Backup 12 Enterprise Manager User Guide
Veeam Backup 12 Enterprise Manager User Guide
Manager
Version 12
User Guide
August, 2025
© 2025 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 intellectual
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.
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:
Intended Audience
The user guide is intended for IT administrators, consultants, analysts and other IT professionals using t he
product. This guide assumes that you have a good understanding of Veeam Backup & Replication and VMware
vSphere.
The distributed architecture of Veeam Backup & Replication allows you to create a custom backup infrastructure
that meets your company needs. Veeam Backup Enterprise Manager manages backup and replication according
to your administrative, business and security requirements and restrictions. With a number of
Veeam Backup & Replication instances installed on different servers, Veeam Backup Enterprise Manager acts as
a single management point. It allows you to control license distribution, manage backup jobs across the backup
infrastructure, analyze operation statistics of Veeam backup servers, perform restore operations, and so on.
• View on-going reporting data for all jobs running on these servers, set up email notifications to get
information on the status of all jobs.
• Search for machines, file shares, object storage systems, and guest files in backups and replicas.
• Perform recovery operations for VMs and physical machines, including 1-Click restore, 1-click guest OS file
restore and application items restore (for Microsoft Exchange mailboxes, Microsoft SQL Server databases
and Oracle databases); perform 1-Click restore for unstructured data backups.
• Manage VMware Cloud Director organizations and support their administrators with the Veeam Se lf-
Service Backup Portal.
• Manage vSphere user accounts and support them with the vSphere Self-Service Backup Portal.
• Implement data encryption and decryption processes for the Veeam solutions.
• Provide operation automation with Veeam Backup Enterprise Manager REST API.
All backup servers must be based on the same database engine as Veeam Backup Enterprise Manager
(PostgreSQL or Microsoft SQL Server). For more considerations and limitations on adding backup servers, see
Adding Backup Servers.
Sp ecification Requirement
• PostgreSQL 14.x
• PostgreSQL 15.x (PostgreSQL 15.12.1 is included in the
Veeam Backup & Replication 12.3 setup)
Note that Veeam Backup Enterprise Manager does not support PostgreSQL
installations on cloud database services (for example, Amazon Relational
Database Service (RDS).
Microsoft SQL Server Local or remote installation of the following versions of Microsoft SQL Server
(both Full and Express Editions are supported):
Microsoft SQL Server 2012 databases and later with compatibility to Microsoft
SQL Server 2005 are not supported.
All editions of Microsoft SQL Server are supported. The usage of Microsoft SQL
Server Express Edition is limited by the database size up to 10 GB. If you plan
to have larger databases, use other editions of Microsoft SQL Server.
Software During installation and upgrade, the setup wizard system performs
configuration check to determine if all prerequisite software is available on the
machine where you plan to install Enterprise Manager. If some of the required
software components are missing, the setup wizard tries to install missing
software automatically. This refers to the following software:
• Microsoft .NET Framework 4.7.2 (included in the setup)
• Microsoft SQL Server System CLR Types (both for Microsoft SQL Server
and PostgreSQL, included in the setup)
• Microsoft Report Viewer Redistributable 2015 (included in the setup)
• Microsoft Universal C Runtime (included in the setup)
• Microsoft Visual C++ 2015-2022 Redistributable (included in the setup)
• Microsoft Internet Information Services 7.5 or later
• Microsoft URL Rewrite 2.0 for IIS 7
• Windows Installer 4.5 (included in the setup)
Sp ecification Requirement
Browsers Mozilla Firefox, Google Chrome and Microsoft Edge. The browser must have
JavaScript and WebSocket protocol enabled.
Enterprise Manager User Interface may not work correctly in Mozilla Firefox
running on Microsoft Windows 11 22H2.
Microsoft Excel Microsoft Excel (to view reports exported to Microsoft Excel format).
Sp ecification Requirement
Ha rdware and software Refer to hardware system requirements and software system requirements
for Veeam Backup Enterprise Manager.
Sp ecification Requirement
You can use VMware Cloud Director on a backup server that is based on
Microsoft Windows Server 2016 or later.
Other software If your Enterprise Manager deployment uses IIS 8.5, a URL rewrite module is
required to work with Veeam Self-Service Backup Portal for VMware Cloud
Director.
Sp ecification Requirement
Setup accounts The account used to run the setup must have the local Administrator permissions on
the target machine.
[Configuration database on Microsoft SQL Server] Your account must have the
following Microsoft SQL Server permissions:
• To create a new Veeam Backup Enterprise Manager database during the setup
process, the account must have the CREATE ANY DATABASE permission on
the Microsoft SQL Server level. After the database is created, this account
automatically gets the db_owner role and can perform all operations with the
database. If a database is created in advance (by a database administrator or
Microsoft SQL Server administrator), the setup account must have the
db_owner role for the database.
• To upgrade an existing Microsoft SQL Server database, the account must have
the db_owner role.
Veeam Backup Use the Local System account as the Veeam Backup Enterprise Manager Service
E nterprise Manager account. If you set another account to run this service, this account must have the
service account following permissions:
• Local Administrator permissions on the Veeam Backup Enterprise Manager
server.
• Log on as a service permission (granted automatically to the Veeam Backup
Enterprise Manager Service account).
• [Configuration database on PostgreSQL] The PostgreSQL account must be a
superuser.
• [Configuration database on Microsoft SQL Server] Db_datareader and
db_datawriter roles, as well as permissions to execute stored procedures for
the Enterprise Manager configuration database. Alternatively, you can assign
this account the db_owner role for the this database to the service account.
• Full Control NTFS permissions for the VBRCatalog or another folder where
index files are stored.
To add Active Directory user or group accounts to the Veeam Backup Enterprise
Manager roles, the Veeam Backup Enterprise Manager service must be started under
the Active Directory service account that has permissions to enumerate Active
Directory domains. Active Directory users have enough permissions to enumerate
Active Directory domains by default. If you use the local machine account instead,
you will get the " Cannot find user account DOMAIN\username" error.
E nterprise Manager To work with the Veeam Backup Enterprise Manager web UI, users must be assigned
user the Portal Administrator, Portal User, or Restore Operator role. For more
information, see Configuring Accounts and Roles.
vSp here Client Plug- The account used to install the plug-in and the vCenter Server account must belong
in for Veeam Backup to the same Active Directory domain in case of cross-domain access.
& Replication
( op tional) The account used to install the plug-in must be assigned the following vCenter
Server permissions:
• To install the plug-in: E x tension > Register extension
• To uninstall the plug-in: E x tension > Unregister extension
vSp here Self-Service The account used to work with vSphere Self-Service Backup Portal must have
Ba ckup P ortal user interactive logon permissions on the Enterprise Manager server.
NOTE
For more information on ports specific for Veeam Backup & Replication infrastructure components, see the
Ports section of the Veeam Backup & Replication User Guide.
DNS server with UDP 53 Port used for communication with the
forward/reverse DNS Server.
name
resolution of all
backup servers
Active Directory TCP, UDP 389 Port used by Enterprise Manager service
domain to communicate with Active Directory
controller over the LDAP protocol.
• [Link]
• *.[Link]
Veeam Veeam Backup TCP 9394 Default port used by IIS extension to
Backup Enterprise communicate with Veeam Backup
Enterprise Manager Enterprise Manager. Can be customized
Manager service during Veeam Backup Enterprise
website (IIS Manager installation. For more
extension) information, see Specify Service Ports.
Veeam Cloud Veeam Backup TCP 9397 Default port used by IIS extension to
Connect Enterprise communicate with Veeam Backup
Portal Manager Enterprise Manager. This port value is
website (IIS service built-in and cannot be customized during
extension) installation.
Browser Veeam Backup HTTP 9080 Default ports used to communicate with
Enterprise the website. Can be customized during
Manager Veeam Backup Enterprise Manager
website (IIS HTTPS 9443 installation. For more information, see
extension) Specify Service Ports.
Veeam Veeam Backup HTTP 9399 Default ports used to communicate with
Backup Enterprise Veeam Backup Enterprise Manager REST
Enterprise Manager REST API. Can be customized during Veeam
Manager API HTTPS 9398 Backup Enterprise Manager installation.
REST API For more information, see Specify Service
client Ports.
and VMware
vSphere
Client
plug-in
Veeam ONE Veeam Backup TCP Dynamically If you add the Veeam Backup Enterprise
Server Enterprise assigned Manager server to the Veeam ONE
(optional) Manager server ports monitoring scope, you must open ports
required to gather data through WMI. For
more information on enabling and
disabling WMI traffic, see the Connecting
to WMI Remotely with VBScript and
Setting up a Remote WMI Connection
articles of the Microsoft Windows Dev
Center.
• For communication between the Veeam Backup Enterprise Manager server and backup servers,
Kerberos authentication is used by default.
• During installation, Veeam Backup & Replication automatically creates firewall rules for default
ports to allow communication for the application components.
• For more information on Enterprise Manager network connectivity, refer to the Enterprise Manager
article of the Veeam Backup and Replication Best Practices documentation.
Veeam Mount server TCP 2500 to Ports used for file download.
Backup associated 6000
Enterprise with backup
Manager repository
server
Veeam Mount server TCP 2500 to Ports used for file download. For more
Backup (helper host 6000 information on the mount server, see
Enterprise or helper Preparing for File Search and Restore
Manager appliance) (non-Windows machines).
server
NOTE
• For more information on the list of ports used by the mount server associated with the backup
repository during file-level restore, see the Mount Server Connections section of the Veeam Backup
& Replication User Guide.
• For more information on the list of ports used by the components involved in 1-Click Restore to
Original Location, see the Ports section of the Veeam Backup & Replication User Guide.
Machine Target TCP, UDP 135, 445 Ports used to deploy the runtime
running machine with coordination process on the target
mount Microsoft SQL machine.
service1 Server
TCP 1025 to 1034 Default RPC range for the Veeam SQL
Restore Service runtime component
installed on a target or staging Microsoft
SQL Server machine to support restore.
Each runtime component uses the next
available port in the range, and only
during application item restore.
1
Mount server associated with the repository (if restoring from backup), or a backup server (if restoring from replica).
Target Machine TCP 3260 to 3270 Ports used by Veeam Backup and
machine with running Replication for iSCSI traffic. Ports are
Oracle mount open only during the application item
service1 restore session.
1
Mount server associated with the repository (if restoring from backup), or a backup server (if restoring from replica).
NOTE
For more information on 1-Click Database Restore to the original Oracle server machine (remote machine),
see 1-Click Restore to Original Location.
1
Mount server associated with the repository (if restoring from backup), or a backup server (if restoring from replica).
NOTE
For more information on the process of database restore with custom settings, see Restore with Custom
Settings.
For more information on Kerberos authentication and requirements for a Kerberos -only environment, see the
Kerberos Authentication section of the Veeam Backup & Replication User Guide.
NOTE
Backup servers with Veeam Backup & Replication 11a or earlier require NTLM for communication.
Veeam Backup Enterprise Manager collects information about the type of license installed on added backup
servers and the number of instances in the license. When Enterprise Manager collects data from backup servers,
it also synchronizes license data by checking if the license installed on the backup server matches with the
license installed on the Enterprise Manager server. If the licenses do not match, the license on the backup server
is automatically updated to match the license of the Enterprise Manager server.
When you run a job, Enterprise Manager uses instances required for each type of protected workloads for per-
instance licenses or applies a license to the protected hosts for per-socket licenses. If a workload is protected by
multiple backup servers added to the Enterprise Manager infrastructure, the workload will consume the
Enterprise Manager license only once.
NOTE
You cannot use the same Enterprise Manager server to manage backup servers that require different
licenses, for example, a backup server of a Veeam Cloud Connect service provider and a regular backup
server used to process Veeam Backup & Replication jobs. For example, you add to Enterprise Manager a
backup server with the Veeam Cloud Connect service provider license installed. Enterprise Manager will
obtain information about the license and save it to its database. If you then add another backup server with
a different type of license installed, Enterprise Manager will install the Veeam Cloud Connect service
provider license on this backup server. As a result, you will be able to use the second backup server to
configure the Veeam Cloud Connect infrastructure, and will not be able to use this server to run backup
and replication jobs.
For information on Veeam Backup & Replication license types, see the Licensing section of the
Veeam Backup & Replication User Guide.
For information on Veeam Cloud Connect license types and license management tasks, see the Licensing for
Service Providers section of the Veeam Cloud Connect Guide.
If you have a Perpetual Socket license installed, you can install an instance license over it. In this case, the
licenses will be merged. For more information on licenses available for merging, see the Merging Licenses
section of the Veeam Backup & Replication User Guide. After the merge, you can remove an unnecessary part of
the merged license. For details, see Removing License.
NOTE
If a backup server of an earlier version uses a license type that is different from the license type of
Enterprise Manager, the backup server license remains unchanged.
1. Sign in to Veeam Backup Enterprise Manager using an account with the Portal Administrator role.
2. To open the Configuration view, click Configuration in the top right corner.
When you run a job, Enterprise Manager uses instances required for each type of protected workloads for per -
instance licenses or applies a license to the protected hosts for per-socket licenses. If a workload is protected by
multiple backup servers added to the Enterprise Manager infrastructure, the workload will consume the
Enterprise Manager license only once.
1. Sign in to Veeam Backup Enterprise Manager under an account with the Portal Administrator role.
2. To open the Configuration view, click Configuration in the top right corner.
TIP
You can configure Veeam Backup Enterprise Manager to send notifications about expiring license. For more
information on the Veeam Backup Enterprise Manager notification functionality, see the Configuring
Notification Settings section of this guide.
NOTE
Veeam Backup Enterprise Manager does not display information about instances consumed in the Veeam
Cloud Connect service provider license by tenant workloads. This information is available only in the Veeam
backup console on the Veeam backup server of the service provider. For more information, see the
Licensing for Service Providers section of the Veeam Cloud Connect Guide.
NOTE
When updating the license, Veeam Backup Enterprise Manager requires internet access to connect to the
Veeam License Update Server. If your network is not connected to the internet, you can download a new
license file from [Link] and install a new license. For more information on license installation, see
Installing License.
1. Sign in to Veeam Backup Enterprise Manager using an account with the Portal Administrator role.
2. To open the Configuration view, click Configuration in the top right corner.
1. Sign in to Veeam Backup Enterprise Manager using an account with the Portal Administrator role.
2. To open the Configuration view, click Configuration in the top right corner.
5. In the Details window, select the Up date license key automatically check box.
If this option is enabled in Enterprise Manager (even if deactivated in the Veeam backup console),
automatic update will be performed anyway: Enterprise Manager will obtain a new key from Veeam
licensing server and propagate it to all managed Veeam backup servers.
For information on license management in Veeam Backup and Replication, see the Licensing section of the
Veeam Backup & Replication User Guide.
For information on license management for Veeam Cloud Connect Server Providers, see the Licensing for
Service Providers section of the Veeam Cloud Connect Guide.
Grace Period
Veeam Backup Enterprise Manager supports a grace period after the license expiration date. For subscription
license, it lasts for 30 days, for rental license — 2 months. During this period the product will be running, but a
warning about license expiration (grace period) will appear on the Da shboard tab and in the sessions
information.
You must update your license before the end of the grace period.
Messages that can appear in the automatic license update session log are listed in the License Update Session
Data section. Similar messages are received as pop-ups after you force the immediate update.
“New license key has been This sequence of messages You can open the License Information dialog in
received” means automatic license key Veeam backup console or the Licensing
“New license key has been update procedure has section in Enterprise Manager to examine the
installed” completed successfully. details.
“License key has been auto-
updated”
“License key type is not License key generation failed Currently, automatic update is supported only
supported at the moment” due to currently for licenses associated with Hosting Rental
unsupported license type. contract type.
“License key is invalid” License signature (identifier) Contact your Veeam sales representative.
is invalid.
“Your existing license key is License expiration date is This message could probably been issued due
up to date” more than 7 days from now. to an accidental attempt to update the license
manually. Select to update the license key
automatically, and the system will notify you
on time.
“Your contract has expired, Your contract has expired Contact your Veeam sales representative for
so the license key cannot be and needs to be renewed. contract renewal.
updated automatically.
Please contact your Veeam
sales representative to
renew your contract.”
“General license key Web licensing server did not Wait for 24 hours (Veeam will re-try to update
generation error has return a new key upon the key). Retries will take place for 1 month
occurred” request due to some other after key expiration date.
reason.
1. Sign in to Veeam Backup Enterprise Manager using an account with the Portal Administrator role.
2. To open the Configuration view, click Configuration in the top right corner.
If you have a merged license installed, you can remove a part of it: a socket license or an instance license. After
you remove a part of the merged license, Veeam Backup Enterprise Manager and connected backup servers will
operate under the other part of the merged license.
1. Sign in to Veeam Backup Enterprise Manager using an account with the Portal Administrator role.
2. To open the Configuration view, click Configuration in the top right corner.
4. On the Summary tab, click Remove Socket License or Remove Instance License.
Veeam offers two methods of usage reporting: automatic and manual. The automatic reporting is used if
automatic license update is enabled. For more information about how license usage reporting works, see the
License Usage Reporting section of the Veeam Cloud Connect Guide.
Veeam Backup Enterprise Manager generates a monthly usage report on the first day of the month. The report is
based on the number of instances used for backup and replication in the previous month.
To review a report:
1. In the monthly usage report notification, click the sub mit link.
3. In the monthly usage report, check the number of reported instances. The report contains the following
data:
o License information: Veeam Backup & Replication edition, license expiration date, name of the
company to which the license was issued and support ID.
o The number of instances used by each type of protected workloads (VMs, workstations, servers and
file shares) and the total number of used instances.
o For each type of protected workloads, the report displays information about processed workloads and
jobs that process these workloads.
o For each type of protected workloads, the report also displays the number of new objects that are not
included in the report.
To adjust a report:
1. In the monthly usage report notification, click the sub mit link.
4. In the list of VMs, select the VM that you want to remove from the report and click Remove.
By default, the list of VMs contains all managed VMs included in the report. To quick ly find the necessary
VM, you can use the search field at the top of the window. You can also select a backup server and job
from the drop-down lists to view a list of VMs added to a specific job on a specific backup server.
5. In the Remove Instance window, in the Ty p e in note field, provide a reason for removing the VM from the
report.
6. Click OK, then click Finish. The change will be reflected in the report.
TIP
To reset changes introduced in the report, in the Monthly Usage Report window, click Reset.
1. In the monthly usage report notification, click the sub mit link.
2. Download the report. The procedure differs depending on the reporting method. For more information,
see the License Usage Reporting section of the Veeam Cloud Connect Guide.
ii. On the report page, click Download and select the report format: PDF or JSON.
o In case of manual reporting, in the Monthly Usage Report window, click Download and select the
report format: PDF or JSON.
You can also download the report after review. To do this, take the same steps as in case of automatic
reporting.
You can submit a monthly usage report in one of the following ways:
• Automatically
• Manually
For more information about how license usage reporting works, see the License Usage Reporting section of the
Veeam Cloud Connect Guide.
1. In the monthly usage report notification, click the sub mit link.
2. In the Monthly Usage Report window, to check or change the number of used instances, click Review.
For more information, see Reviewing Monthly Usage Report and Adjusting Monthly Usage Report.
You can also postpone the report submission. To do this, click P ostpone. In this case, Veeam Backup
Enterprise Manager closes the Monthly Usage Report window. Until the report is sent to Veeam, on the
Da shboard tab, Enterprise Manager keeps displaying a warning prompting to submit the report.
1. In the monthly usage report notification, click the sub mit link.
2. In the Monthly Usage Report window, to check or change the number of used instances, click Review. For
more information, see Reviewing Monthly Usage Report and Adjusting Monthly Usage Report.
You can also postpone the report submission. To do this, click P ostpone. In this case, Veeam Backup
Enterprise Manager closes the Monthly Usage Report window. Until the report is sent to Veeam, on the
Da shboard tab, Enterprise Manager keeps displaying a warning prompting to submit the report.
You can install Veeam Backup Enterprise Manager either on a physical or virtual machine, co-install it with
Veeam Backup & Replication or install it separately.
In This Section
• Installing Veeam Backup Enterprise Manager
For more information on Veeam Backup Enterprise Manager installation in unattended mode, see the Veeam
Backup Enterprise Manager Server subsection of the Installing Veeam Backup & Replication in Unattended Mode
section of the Veeam Backup & Replication User Guide.
• A machine on which you plan to install Veeam Backup Enterprise Manager must meet the system
requirements. For more information, see System Requirements.
• A user account that you plan to use for installation must have sufficient permissions. For more
information, see Permissions.
• Backup infrastructure components communicate with each other over specific ports. These ports must be
open. For more information, see Ports.
• Local antivirus or antimalware software can interfere with Veeam Backup Enterprise Manager installation.
If you receive the Failed to create website 0x80070020 message, disable your local antivirus or
antimalware software and run the installation process again. You can re-enable your antivirus software
once the installation completes. For more information, see this Veeam KB article.
• .NET 3.5.1 WCF HTTP Activation Windows component prevents Veeam Backup Enterprise Manager from
functioning. Make sure there is no .NET 3.5.1 WCF HTTP Activation Windows component on the Veeam
Backup Enterprise Manager server prior to the installation.
• Make sure there is no Microsoft Search Server installed on the machine. If you have Microsoft Search
Server, uninstall it prior to the Veeam Backup Enterprise Manager installation.
• If you want to use an already installed PostgreSQL instance for the Enterprise Manager configuration
database, make sure the instance can use sufficient resources. For more information, see Configuring
PostgreSQL Instance.
• If you want to use an already installed PostgreSQL instance for the Enterprise Manager configuration
database, make sure the instance contains the default postgres database. If you allow the setup to install
a new PostgreSQL instance, the postgres database will be created on the instance automatically.
Since Enterprise Manager connects to the postgres database to access the configuration database, do not
rename the postgres database upon the Enterprise Manager installation.
• Check the Known Issues section of the Veeam Backup & Replication 12.3 Release Notes.
When installing Veeam Backup Enterprise Manager, you can choose what PostgreSQL instance to use for the
Enterprise Manager configuration database. You can use an existing PostgreSQL instance or create a new one.
• If you let the setup create a new PostgreSQL instance, it will be configured automatically.
• If you want to use an existing PostgreSQL instance, make sure that the instance configuration is sufficient
for the Enterprise Manager performance.
1. On a backup server, run the Set-VBRPSQLDatabaseServerLimits cmdlet. The cmdlet generates the
necessary PostgreSQL configuration and saves it to a dump SQL file.
For example:
2. On the machine with the PostgreSQL instance where you want to deploy the Enterprise Manager
configuration database, use the psql tool to apply the configuration from the dump file.
For example:
3. Include the pg_stat_statements library to the PostgreSQL configuration. To add the library, you can
manually edit the shared_preload_libraries option in the [Link] file.
4. Restart the PostgreSQL service for the new configuration to take effect.
5. Install the pg_stat_statements extension. The extension is used to analyze the PostgreSQL
performance.
1. Download the latest version of the Veeam Backup & Replication installation image from the Veeam
Product Downloads page.
2. Mount the installation image to the machine where you plan to install Veeam Backup Enterprise Manager
or burn the image file to a flash drive or other removable storage device. If you plan to install Veeam
Backup Enterprise Manager on a VM, use built-in tools of the virtualization management software to
mount the installation image to the VM.
To extract the content of the ISO file, you can also use the latest versions of utilities that can properly
extract data from ISO files of large size and can properly work with long file paths.
3. After you mount the image or insert the disk, Autorun opens a splash screen. If Autorun is not available or
disabled, run the [Link] file from the image or disk.
4. Click Install.
IMP ORTANT
It is strongly recommended that you install Veeam Backup Enterprise Manager using Autorun or the
[Link] file. If you run other installation files from the ISO folders, you may miss some components
that need to be installed, and Veeam Backup Enterprise Manager may not work as expected.
To open Veeam Help Center from the setup wizard, click View Documentation.
• Trial license that was sent to you after you downloaded the product.
If a valid license is already installed on the machine, the setup wizard will display the license details. In this case,
you can skip the License step and move on to the next step of the wizard.
b. Enter your credentials for accessing the Veeam website and click Sign in.
c. Select one of the available licenses and click Install selected license.
To install new licenses automatically when you renew or expand your contract, select the Up date license
a utomatically check box. If you enable the automatic license update, and therefore enable usage reporting, you
will double the number of workloads by which you can exceed your installed license. For more information on
license update, see Updating License.
If the setup is not able to install some of the required software automatically, install it manually and click Retry.
NOTE
If all required software is already installed on the machine, the Sy stem Configuration Check step will be
skipped. For more information on the necessary software, see System Requirements.
• To use custom installation settings, click Customize Settings. The setup wizard will include additional
steps that will let you configure installation settings.
Service account LOCAL SYSTEM Account under which the Veeam Backup Enterprise
Manager runs.
Da tabase engine PostgreSQL The setup installs PostgreSQL 15.1 locally on the
Veeam Backup Enterprise Manager server.
Da tabase name VeeamBackupReporting The setup deploys the Veeam Backup Enterprise
Manager configuration database on the locally
installed instance of PostgreSQL.
Ca talog service 9393 The catalog service port is used by the Veeam Guest
p ort Catalog Service to replicate catalog data from
backup servers to Veeam Backup Enterprise
Manager.
W eb UI ports For HTTP protocol: 9080 These ports are used for accessing Veeam Backup
Enterprise Manager web interface.
For HTTPS protocol: 9443
RE ST API service For HTTP protocol: 9399 These ports are used for accessing Veeam Backup
p orts Enterprise Manager REST API.
For HTTPS protocol: 9398
Check for updates Automatically Veeam Backup Enterprise Manager will check for
product updates weekly. When a new product build
is published on the Veeam update server, a
notification is displayed in the Windows Action
Center.
You can select an account under which you want to run the Veeam Backup Enterprise Manager Service:
The user name of the custom account must be specified in the DOMAIN\USERNAME format.
NOTE
The user account must have Veeam Backup Enterprise Manager service account permissions to run the
Veeam Backup Enterprise Manager Service. For more information, see Permissions.
At this step of the wizard, you can choose a database engine (Microsoft SQL Server or PostgreSQL) for the
Enterprise Manager configuration database, specify a new or existing instance where you want to deploy the
configuration database, and specify the authentication mode.
NOTE
Configuration databases of the Enterprise Manager server and backup servers added to the Enterprise
Manager infrastructure must use the same database engine.
1. Select one of the following database engines that you want to use for the configuration database:
o PostgreSQL
o [For PostgreSQL] You can use an existing PostgreSQL instance or create a new one.
▪ To create a new PostgreSQL instance, select the Ins tall new instance option. The setup will
install PostgreSQL on the Enterprise Manager server and create a database with the
VeeamBackupReporting name.
▪ To use an existing PostgreSQL instance, select the Use existing instance option. Enter the
instance name in the HOSTNAME:PORT format. In the Da tabase name field, specify a name for
the Enterprise Manager configuration database.
IMP ORTANT
If you want to use an existing PostgreSQL instance, make sure that the instance can use
sufficient resources. For more information, see Configuring PostgreSQL Instance.
i. In the SQL Server instance field, enter the instance name in the HOSTNAME\INSTANCE format or
select an instance from the drop-down list. You can also click Browse to choose a Microsoft SQL
Server on a remote machine.
3. Select an authentication mode to connect to the database server instance: Microsoft Windows
authentication or native database server authentication. If you select the native authentication, enter
credentials of the database account.
If a configuration database with the specified name already exists (for example, it was created by a previous
installation of Enterprise Manager), the setup wizard will notify about it. To connect to the detected database,
click Y es . If necessary, Enterprise Manager will automatically upgrade the database to the latest version.
At this step of the wizard, you can specify an installation folder and a folder for the guest file system catalog.
Service providers that use Veeam Backup & Replication to offer disaster recovery as a service to their tenants
can also choose to install Veeam Cloud Connect Portal. For more information on the portal, see the Veeam
Cloud Connect Portal section of the Veeam Cloud Connect Guide.
1. To change the default installation folder, click Browse next to the Installation path field.
2. To install Veeam Cloud Connect Portal, select the Ad d Cloud Connect Portal for Service Providers check
box.
3. To change a path to the folder where index files must be stored, click Browse next to the Ca talog location
field. Indexing data is required for browsing and searching for VM guest OS files inside backups and
performing 1-click restore.
By default, the setup wizard creates the VBRCatalog folder on a volume with the maximum amount of
free space, for example: C:\VBRCatalog.
At this step of the wizard, you can customize ports that will be used for communication between backup
infrastructure components. For more information about Veeam Backup Enterprise Manager used ports, see
Ports.
If you are installing Veeam Cloud Connect Portal, you can also specify a port number that will be used by
browser to access its website (the default port is 6443).
2. Specify the certificate to be used by Veeam Backup Enterprise Manager. This certificate is needed to
establish secure communication with the Enterprise Manager website using HTTPS; Veeam plug -in for
vSphere Client and REST API client also will use this certificate to receive data using HTTPS protocol. If the
setup wizard does not find an appropriate certificate, it will generate a self-signed certificate.
3. To enforce TLS 1.2 encryption protocol for network connections, select the Hig h security mode check box.
This option disables using weak ciphers for all communications with the machine on which Veeam Backup
Enterprise Manager runs. This may interfere with the operation of 3rd party software installed on the same
machine.
At this step of the wizard, you can review the Veeam Backup Enterprise Manager installation settings and start
the installation process:
1. If you want Veeam Backup Enterprise Manager to check for product updates weekly, select the Check for
p roduct updates automatically check box. When a new product build is published on the Veeam update
server, a notification will be displayed in the Windows Action Center.
3. Wait for the installation process to complete and click Finish to exit the setup wizard.
9. Begin upgrade.
• To upgrade Veeam Backup Enterprise Manager to version 12.3, you must be running version 11a
(build 11.0.1.1261) or later. To upgrade from earlier versions, contact Veeam Customer Support.
• A machine on which you plan to install Enterprise Manager must meet the system requirements. For more
information, see System Requirements.
• A user account that you plan to use for upgrade must have sufficient permissions. For more informat ion,
see Permissions.
• Backup infrastructure components communicate with each other over specific ports. These ports must be
open. For more information, see Ports.
• Check the Known Issues section of the Veeam Backup & Replication 12.3 Release Notes.
• With Enterprise Manager and connected backup servers, remember to begin the backup infrastructure
upgrade process with Enterprise Manager. Backup servers should be upgraded after that. When you use
different versions of Veeam Backup Enterprise Manager and Veeam Backup & Replication, you may not be
able to leverage all features of Veeam Backup Enterprise Manager. Moreover, data collection from backup
servers of earlier versions takes more time, which can be critical if many backup servers are added to
Enterprise Manager.
If you have a backup server installed on the same machine, upgrade it immediately after completing
upgrade of the Enterprise Manager server. Otherwise, the Configuration Database Connection Settings
utility will not work properly for Veeam Backup & Replication. For more information about the utility, see
Configuration Database Connection Settings Utility.
• In Enterprise Manager, you cannot edit jobs that are managed by backup servers with earlier versions
installed until you upgrade the backup servers. Additionally, you cannot create and edit jobs of such
backup servers in Veeam Self-Service Backup Portal for Cloud Director and vSphere Self-Service Backup
Portal. For example, if you upgrade Enterprise Manager to version 12.3, you will not be able to edit jobs
managed by a backup server with version 12.0 until you upgrade the backup server to version 12.3.
• Upon the upgrade, the size of the Enterprise Manager configuration database may increase significantly. If
your configuration database is based on Microsoft SQL Server Express Edition, ensure you are not about to
exceed the database size limit of 10 GB. To prevent data loss, back up the configuration database before
you upgrade Enterprise Manager.
Additionally, the size of Microsoft SQL Server transaction logs and the tempdb system database may
grow. To avoid the overflow of the tempdb database, set the database to autogrow. After the upgrade is
completed, you can shrink the files using Microsoft SQL Server tools.
• Local antivirus or antimalware software can interfere with Enterprise Manager upgrade. If you receive the
Failed to create website 0x80070020 message, disable your local antivirus or antimalware software and
start the upgrade process again. You can re-enable your antivirus software once the upgrade completes.
For more information, see this Veeam KB article.
• .NET 3.5.1 WCF HTTP Activation Windows component prevents Enterprise Manager from functioning.
Make sure there is no .NET 3.5.1 WCF HTTP Activation Windows component on the Veeam Backup
Enterprise Manager server prior to the installation.
1. Download the latest version of the Veeam Backup & Replication installation image from the Veeam
Product Downloads page.
2. Mount the installation image to the machine where Veeam Backup Enterprise Manager is installed, or burn
the image file to a flash drive or other removable storage device. If you plan to upgrade Veeam Backup
Enterprise Manager on a VM, use built-in tools of the virtualization management software to mount the
image to the VM.
To extract the content of the ISO file, you can also use the latest versions of utilities that ca n properly
extract data from ISO files of large size and can properly work with long file paths.
3. After you mount the image or insert the disk, Autorun opens a splash screen. If Autorun is not available or
disabled, run the [Link] file from the image or disk.
4. Click Up grade.
To open Veeam Help Center from the upgrade wizard, click View Documentation.
b. Enter your credentials for accessing the Veeam website and click Sign in.
c. Select one of the available licenses and click Install selected license.
To install new licenses automatically when you renew or expand your contract, select the Up date license
a utomatically check box. If you enable the automatic license update, and therefore enable usage reporting, you
will double the number of workloads by which you can exceed your installed license. For more information on
license update, see Updating License.
If the setup is not able to install some of the required software automatically, install it manually and click Retry.
NOTE
If all required software is already installed on the machine, the Sy stem Configuration Check step will be
skipped. For more information on the necessary software, see System Requirements.
You can select an account under which you want to run the Veeam Backup Enterprise Manager Service:
The user name of the custom account must be specified in the DOMAIN\USERNAME format.
NOTE
The user account must have Veeam Backup Enterprise Manager service account permissions to run the
Veeam Backup Enterprise Manager Service. For more information, see Permissions.
NOTE
• Configuration databases of the Enterprise Manager server and backup servers added to the
Enterprise Manager infrastructure must use the same database engine.
• After you upgrade Veeam Backup Enterprise Manager, you can migrate its configuration database
from Microsoft SQL Server to PostgreSQL using the Enterprise Manager Database Migration and
Configuration Database Connection Settings utilities. For more information, see Veeam Backup
Enterprise Manager Utilities.
1. Select one of the following database engines that you want to use for the configuration database:
o PostgreSQL
o [For PostgreSQL] You can use an existing PostgreSQL instance or create a new one.
▪ To create a new PostgreSQL instance, select the Install new instance option. The setup will
install PostgreSQL on the Enterprise Manager server and create a database with the
VeeamBackupReporting name.
▪ To use an existing PostgreSQL instance, select the Use existing instance option. Enter the
instance name in the HOSTNAME:PORT format. In the Da tabase name field, specify a name for
the Enterprise Manager configuration database.
IMP ORTANT
If you want to use an existing PostgreSQL instance, make sure that the instance can use
sufficient resources. For more information, see Configuring PostgreSQL Instance.
i. In the SQL Server instance field, enter the instance name in the HOSTNAME\INSTANCE format or
select an instance from the drop-down list. You can also click Browse to choose a Microsoft SQL
Server on a remote machine.
3. Select an authentication mode to connect to the database server instance: Microsoft Windows
authentication or native database server authentication. If you select the native authentication, enter
credentials of the database account.
If a configuration database with the specified name already exists (for example, it was created by a previous
installation of Enterprise Manager), the setup wizard will notify about it. To connect to the detected database,
click Y es . If necessary, Enterprise Manager will automatically upgrade the database to the latest version.
Wait for the upgrade process to complete and click Finish to exit the wizard.
1. If you have Veeam Backup & Replication installed on the same machine, upgrade it immediately after
completing upgrade of the Veeam Backup Enterprise Manager server.
After you upgrade backup servers, Veeam Backup Enterprise Manager starts a maintenance job to optimize
the state of its database. The initial maintenance job session may take significant amount of time (up to an
hour, depending on the database size). After the job finishes, the database will be brought to an optimal
state, and subsequent maintenance job sessions will take much less time.
3. New features of Veeam Backup Enterprise Manager version 12.3 will be available after all connected
backup servers are upgraded, and initial collection of data from these servers in Veeam Backup Enterprise
Manager completes successfully.
4. Download and install the latest available update (if any). For more information, see Updating Veeam
Backup Enterprise Manager.
• Make sure you have Enterprise Manager 12.3 (build 12.3.x.x) of any earlier patch level installed.
For information on how to upgrade from product version 11a or later, see Upgrading to Veeam Backup
Enterprise Manager 12.3.
• With Enterprise Manager and connected backup servers, remember to begin the update process with
Veeam Backup Enterprise Manager. Backup servers should be updated after that. If you have
Veeam Backup & Replication and Veeam Backup Enterprise Manager deployed on the same machine, the
update wizard will update both products at once.
For more information on the backup server update procedure and prerequisites, see the Updating Veeam
Backup & Replication section of the Veeam Backup & Replication User Guide.
Performing Update
To install the latest update for Enterprise Manager, perform the following steps:
1. Review this Veeam KB article to check if a cumulative patch is available for the version of
Veeam Backup & Replication that is installed.
2. If a cumulative patch is listed as available, click the Veeam KB article link for that cumulative patch.
3. In the Download Information section of the Veeam KB article, click DOW NLOAD PATCH.
4. To launch the update wizard, unzip the downloaded file and run the cumulative patch installer.
The Enterprise Manager server is also recorded in configuration databases of added backup servers, which binds
the backup servers to the Enterprise Manager server. If you are not going to use Enterprise Manager on this or
another machine, it is recommended that you unbind the backup servers by removing them from Enterprise
Manager before you uninstall the application. For more information, see Removing Backup Servers.
1. From the Sta rt menu, select Control Panel > P rograms and Features.
2. In the programs list, right-click Veeam Backup & Replication and select Uninstall.
3. In the Uninstall window, make sure the check box next to Veeam Backup Enterprise Manager is sele cted. If
this component is co-installed with the Veeam Backup & Replication server, make sure the check box next
to Veeam Backup & Replication is cleared. Click Remove and wait for the process to complete.
Before you migrate Enterprise Manager, you must export Enterprise Manager keysets and prepare the
credentials stored in the Enterprise Manager configuration database so you will be able to re-enter the
credentials on a new server. If you migrate the Enterprise Manager configuration database only, the credentials
and keysets will remain valid.
You can find the template answer file on the Veeam Backup & Replication installation disk in the
\Setup\Silent\AnswerFiles\EM folder. This folder contains the following templates of answer files:
• The user account that you use to run the silent installation must be in the local Administrators group on
the machine where the silent installation will run. The silent installation cannot be run under the
LocalSystem and NetworkService accounts.
• If the user account that you use to run the silent installation is logged on the machine using the network
logon method, the silent installation will fail. To avoid this, use an additional
/SkipNetworkLogonErrors command line key. For example, it is required when the silent installation
is started using a remote PowerShell session.
• When configuring the answer file, remove or comment out unused [Optional] parameters. Otherwise,
the installation session will fail.
You can find the template answer file on the Veeam Backup & Replication installation disk in the
\Setup\Silent\AnswerFiles\EM folder.
2. Configure installation parameters according to your needs. For details, see Configuration Parameters.
Check that the answer file has the correct bundle (Em) and mode (install) specified in line 2:
3. After you make all the necessary changes in your answer file, start the installation by running the
[Link] file located on the Veeam Backup Enterprise Manager installation disk in
the \Setup\Silent folder. Use the following command line keys in your command:
where:
o /AnswerFile — required key for specifying the path to your custom answer file, for example:
E:\[Link].
o /LogFolder — optional key for specifying the path where the setup should save log files if it is
different from the default path. The default path is: C:\ProgramData\Veeam\Setup\Temp.
Configuration Parameters
The configuration file contains the following parameters:
Result Result
Cod e
0 success
E rror Description
Cod e
• The user account that you use to run the silent upgrade must be in the local Administrators group on the
machine where the silent upgrade will run. The silent upgrade cannot be run under the LocalSystem and
NetworkService accounts.
• If the user account that you use to run the silent upgrade is logged on the machine using the network
logon method, the silent installation will fail. To avoid this, use an additional
/SkipNetworkLogonErrors command line key. For example, it is required when the silent installation
is started using a remote PowerShell session.
• When configuring the answer file, remove or comment out unused [Optional] parameters. Otherwise,
the upgrade session will fail.
You can find the template answer file on the Veeam Backup & Replication installation disk in the
\Setup\Silent\AnswerFiles\EM folder.
2. Configure installation parameters according to your needs. For details, see Configuration Parameters.
Check that the answer file has the correct bundle (Em) and mode (upgrade) specified in line 2:
3. After you make all the necessary changes in your answer file, start the upgrade by running the
[Link] file located on the Veeam Backup Enterprise Manager installation disk in
the \Setup\Silent folder. Use the following command line keys in your command:
where:
o /AnswerFile — required key for specifying the path to your custom answer file, for example:
E:\[Link].
o /LogFolder — optional key for specifying the path where the setup should save log files if it is
different from the default path. The default path is: C:\ProgramData\Veeam\Setup\Temp.
Configuration Parameters
The configuration file contains the following parameters:
Result Result
Cod e
0 success
E rror Description
Cod e
• The user account that you use to run the silent uninstallation must be in the local Administrators group on
the machine where the silent uninstallation will run. The silent uninstallation cannot be run under the
LocalSystem and NetworkService accounts.
• If the user account that you use to run the silent uninstallation is logged on the ma chine using the
network logon method, the silent uninstallation will fail. To avoid this, use an additional
/SkipNetworkLogonErrors command line key. For example, it is required when the silent
uninstallation is started using a remote PowerShell session.
• When configuring the answer file, remove or comment out unused [Optional] parameters. Otherwise,
the uninstallation session will fail.
You can find the template answer file on the Veeam Backup & Replication installation disk in the
\Setup\Silent\AnswerFiles\EM folder.
2. Configure uninstallation parameters according to your needs. For details, see Configuration Parameters.
Check that the answer file has the correct bundle (Em) and mode (uninstall) specified in line 2:
3. After you make all the necessary changes in your answer file, start the uninstallation by running the
[Link] file located on the Veeam Backup Enterprise Manager installation disk in
the \Setup\Silent folder. Use the following command line keys in your command:
where:
o /AnswerFile — required key for specifying the path to your custom answer file, for example:
E:\[Link].
o /LogFolder — optional key for specifying the path where the setup should save log files if it is
different from the default path. The default path is: C:\ProgramData\Veeam\Setup\Temp.
Configuration Parameters
The configuration file contains the following parameters:
Result Result
Cod e
0 success
E rror Description
Cod e
1. Double-click the Veeam Backup Enterprise Manager icon on the desktop or select P rograms > Veeam >
Veeam Backup Enterprise Manager from the Sta rt menu.
Alternatively, open your web browser and enter the following URL in the address bar:
[Link]
For example:
[Link]
i. In the Username and P a ssword fields, specify your Enterprise Manager credentials. Provide the
user account name in the DOMAIN\Username format.
ii. To save the entered credentials for future access, select the Rema in signed in option.
o To log in with single sign-on, click Use Single Sign-On ( SSO). Enterprise Manager will redirect you to
the login webpage of the single sign-on service. Complete the sign-in procedure on the login page. If
the account is already authenticated in the single sign-on service, you will immediately access the
Enterprise Manager website.
NOTE
The Use Single Sign-On (SSO) option is available if SAML authentication is configured for Veeam
Backup Enterprise Manager. For more information, see Configuring SAML Authentication
Settings.
When you log in under a user account which is not assigned a role for Enterprise Manager, you are automatically
redirected to the Veeam Self-Service File Restore Portal. On this portal, you can browse and restore only
machines on which your user account has local administrative rights. For more information on configuring
Enterprise Manager security roles, see Configuring Accounts and Roles.
Veeam Self-Service File Restore Portal is available in the Enterprise Plus edition of Veeam Backup &
Replication.
If you cannot access web UI over HTTPS, this can be due to several reasons. For more information, see this
Veeam KB article.
After you finish working with the Enterprise Manager website, or if you need to switch the user account, click
the user name in the top right corner of the main window and then click Sig n Out.
• The Home view allows you to view on-going statistics on added backup servers, manage jobs and CDP
policies, and perform recovery operations.
• The Configuration view allows you to add backup servers to Enterprise Manager, modify Enterprise
Manager settings, and configure self-service restore portals.
TIP
To open online help, click the question mark at the top-right of the window. You will be redirected to the
section of the user guide that explains the features and options available on the open tab.
Home View
After you log in to Veeam Backup Enterprise Manager, the Home view opens. In the Home view, you can
navigate through tabs to perform management and restore operations. A user can navigate only the tabs they
are authorized to view in accordance with their security role. For more information on the Enterprise Manager
roles and operations allowed to them, see Configuring Accounts and Roles.
Below is the list of operations that you can perform in the Home view of the Veeam Backup Enterprise Manager
UI:
• View on-going statistics for your backup infrastructure using the Da shboard tab. For more information,
see Viewing Statistics.
• View detailed information about backup servers managed by Enterprise Manager using the Rep orts tab.
For more information, see Reports on Backup Servers.
• Manage jobs on all managed backup servers using the Job s tab. For more information, see Managing Jobs.
• Manage CDP policies on all managed backup servers using the P olicies tab. For more information, see
Managing CDP Policies.
• Browse for unstructured data backups, search for specific items, delete file shares and recover items from
unstructured data backups using the Unstructured Data tab. For more information, see Working with
Unstructured Data.
• Browse for machine backups, search for machines, delete machines and perform failover and replication
operations with managed virtual or physical machines using the Ma chines tab. For more information, see
Working with Machines.
• Browse the guest OS file system in a machine backup, search for guest OS files and restore necessary files
using the Files tab. For more information, see Guest OS File Restore.
• Perform item-level recovery from application-aware backups created by Veeam Backup & Replication
using the Items tab. For more information, see Application Item Restore.
Configuration View
If you logged in with an administrative account, on the Home view you can click Configuration to open the
Configuration view.
The tabbed pane, located on the left of the window, allows you to navigate to the configuration settings you
need — for example, notifications, security roles, and others. The working area is located on the right; it allows
you to view data, perform the necessary operations or manage the settings you need.
Below is the list of operations that you can perform in the Configuration view of the Veeam Backup Enterprise
Manager UI:
• Add, edit or remove Veeam Backup servers using the Ba ckup Servers tab. For more information, see
Managing Backup Servers.
• Work with vCenter Servers managed by Enterprise Manager using the vCenter Servers tab. For more
information, see Viewing vCenter Servers.
• Manage VMware Cloud Director organizations and vSphere tenant accounts using the Self-Service tab. For
more information, see Veeam Self-Service Backup Portal for Cloud Director and vSphere Self-Service
Backup Portal.
• View and manage data collection job sessions using the Sessions tab. For more information, see Collecting
Data from Backup Servers.
• Configure Enterprise Manager security roles using the Roles tab. For more information, see Configuring
Accounts and Roles.
• Configure Enterprise Manager settings using the Settings tab. For more information, see Managing
Encryption Keys, Configuring SAML Authentication Settings, Customizing Dashboard Chart and
Configuring Retention Settings for Index and History.
• Set email notifications using the Notifications tab. For more information, see Configuring Notification
Settings.
• View product versions, URLs and log paths using the Ab out tab. For more information, see Viewing
Information About Enterprise Manager.
1. Veeam Backup Enterprise Manager retrieves data from the managed Veeam backup servers using a data
collection job. This job gets information about the backup and replication jobs, processed machines, and
other data from the configuration databases used by Veeam backup servers.
2. Collected data is stored to the Veeam Backup Enterprise Manager database (hosted on PostgreSQL or
Microsoft SQL Server) and can be accessed by multiple users from the web interface. This web interface
also allows for modifying job settings, license management, installing Veeam plug -in on vCenter Server,
and other tasks.
3. When a user modifies a backup job using Veeam Backup Enterprise Manager, these changes are
communicated to the backup server that manages the job and stored in its configuration database.
If you have a Veeam Agent integrated with Veeam Backup & Replication, you can use Veeam Backup Enterprise
Manager to browse and restore guest OS files and application items from a backup stored in a Veeam backup
repository. These processes involve appropriate backup job setup, as well as mount and data transfer
operations. For more information, see Veeam Agents Support.
• Veeam Backup Enterprise Manager Service coordinates all operations performed by Veeam Backup
Enterprise Manager such as backup, replication, recovery verification and restore tasks. The Veeam Backup
Enterprise Manager Service runs under the Local System account or an account that has the Local
Administrator permissions on the backup server. This service is installed and started automatically on the
local Windows server.
• VeeamBackup and VeeamBackup site (IIS extension) application pools are created and displayed in IIS
Manager. These web applications are deployed on the local IIS web server.
• Web interfaces used to access Veeam Backup Enterprise Manager from different infrastructures:
o Ma in web interface is used to browse and perform operations with jobs, backups and machines, to
configure Enterprise Manager functionality and control infrastructure. For more information, see
Getting to Know Veeam Backup Enterprise Manager.
o Veeam Self-Service File Restore Portal that allows administrators to restore files or folders from the
guest OS of a virtual or physical machine. For more information, see Using Self-Service File Restore
Portal to Restore Machine Guest Files.
o Veeam Self-Service Backup Portal and Veeam Plug-in for VMware Cloud Director that provide
members of VMware Cloud Director organizations with a UI for self-service operations on machine
protection. For more information, see Veeam Self-Service Backup Portal for Cloud Director.
o VMwa re vSphere Self-Service Backup Portal that provides Service Providers with a UI for managing
access permissions and vSphere quotas for their customers. For more information, see vSphere Self-
Service Backup Portal.
NOTE
Veeam Self-Service File Restore Portal, Veeam Self-Service Backup Portal, Veeam Plug-in for
VMware Cloud Director and VMware vSphere Self-Service Backup Portal features are available in the
Enterprise Plus edition of Veeam Backup & Replication.
• Microsoft SQL Server database or P ostgreSQL database is used to store configuration and performance
data. For more information, see Deployment.
• Veeam Backup Catalog is used for guest OS file indexing, index data retention and its synchronization with
the information on backup servers. It comprises a Windows service named Veeam Guest Catalog also
installed on the Veeam Backup Enterprise Manager server. For more information, see Veeam Backup
Catalog.
• Veeam Backup Search is an optional component used for guest OS file indexing of protected machines.
This component is included in the installation package to provide backward compatibility with older
existing deployments. For a new deployment, there is no need to install Veeam Backup Search since all
operations related to guest OS file indexing and search will be performed by Veeam proprietary built -in
indexing engine. For more information, see Veeam Backup Search Capabilities.
• Veeam Cloud Connect P ortal is an optional component that comprises the Veeam Cloud Connect Portal
website (IIS extension) and UI. It is intended for the tenants of Service Providers. For more informati on,
see the Veeam Cloud Connect Guide.
• Veeam Plug-in for VMware vSphere Client allows vSphere administrators to manage backup infrastructure
of the virtual environment. For more information, see Veeam Plug-in for VMware vSphere Client.
• Veeam Guest Catalog service on backup server works as a local catalog service. It collects index data for
backup jobs on this specific backup server and stores data locally in the Veeam Backup Catalog folder.
• Veeam Guest Catalog service on the Enterprise Manager server works as a federal catalog service. It
communicates with Veeam Guest Catalog services on backup servers connected to Enterprise Manager and
performs the following tasks:
o Replicates index data from Veeam backup servers to create a federal catalog
NOTE
If Veeam Backup & Replication and Veeam Backup Enterprise Manager are installed on the same machine,
Veeam Backup Catalog works as a federal catalog service. This ma kes it impossible to replicate index data
from this catalog to another Enterprise Manager. If you want to connect the backup server to another
Enterprise Manager, uninstall Enterprise Manager from the current machine first.
NOTE
While browsing and search possibilities are available to all Veeam Backup Enterprise Manager users, file
restore operations can be performed by authorized users only.
1. When a backup job with guest OS files indexing enabled is run, Veeam Backup & Replication creates a
catalog (or index) of the machine guest OS files and stores index files on the Veeam backup server .
2. After that, the Veeam Guest Catalog Service performs index replication — it aggregates index data for all
machine image backups from managed backup servers. This consolidated index is stored on the Veeam
Backup Enterprise Manager server in the C:\VBRCatalog\Index\ folder and is used for search queries.
3. Then you can browse or search through machine guest OS files using the search criteria you need. Once
you find a necessary file, you can use the File-Level Restore feature to recover the file from the machine
backup. For more information, see How Indexing Works.
However, consider that by default, backup repository is the primary destination for the search. This means, in
particular, that if a backup (with indexed guest) is stored in both locations — repository and tape — then
Enterprise Manager search results will only include files from the backup stored on the repository. Files from
tape-archived backup will appear in search results only if not found on the repository. For more information, see
Configuring Retention Settings for Index and History.
NOTE
This capability is supported in the Enterprise and Enterprise Plus editions of Veeam Backup & Replication.
• File System Indexing section of the Veeam Agent for Linux User Guide
• File System Indexing section of the Veeam Agent for Oracle Solaris User Guide
• File System Indexing section of the Veeam Agent for IBM AIX User Guide
1. To provide for browsing and search, Veeam uses index data to represent the file system of the guest OS.
2. If you then select to download the necessary files, Veeam Backup & Replication will mount virtual or
physical machine disks (from the restore point in repository) on the Veeam backup server and then copy
these files from the backup server to the target location.
3. If you select to restore files to the original location, an additional mount point will be created on the
mount server associated with the backup repository storing the backup file. During restore, machine data
will flow from repository to target, keeping the machine traffic in one site and reducing load on the
network.
4. After you download or restore the necessary files, and finish the restore session, the machine (or server)
disks will be unmounted.
When you restore files from the restore point that was created without guest OS file indexing ,
Veeam Backup & Replication uses the following workflow:
1. To provide for browsing, disks of the virtual machine or physical server from the backup file are mounted
to the backup server.
2. If you then select to download the necessary files, Veeam Backup & Replication will copy these files from
the backup server to the destination location, using this mount point.
3. If you select to restore files from the backup to the original location on the production machine, an
additional mount point will be created on the mount server associated with the backup repository storing
the backup file.
4. If you restore machine files from a VM replica, a single mount point for all these operations (browsing,
download, restore to original location) will be created on the backup server.
5. After you download or restore the necessary files, and finish the res tore session, the machine (or server)
disks will be unmounted.
As soon as the backup job completes, Veeam Backup & Replication notifies the local Veeam Backup Catalog
service. The service saves indexing data in the Veeam Backup Catalog folder on the backup server. During the
next catalog replication session started on Veeam Backup Enterprise Manager, indexing data from the backup
server is replicated to the Veeam Backup Catalog on Veeam Backup Enterprise Manager server. By federating
indexing data from all connected backup servers, the Veeam Backup Catalog service on Veeam Backup
Enterprise Manager creates a global catalog for the whole backup infrastructure.
Veeam Backup & Replication supports file-level restore not only for machines included in guest catalog but also
for the machines that are not indexed. Indexing may be disabled at the time of restore point creation, or
indexing operation may fail. In this case, the restore point of a Windows machine is mounted to the backup
server that manages the job, and the restore point of a non-Windows machine is mounted to a helper host or
helper appliance.
Then a user will be able to locate the necessary files and folders and perform restore operation. For more
information, see Guest OS File Restore.
• Machine index
• Session index
Machine Index
Machine index reproduces the structure of files and folders on the machine guest OS.
Veeam Backup & Replication uses the file index to search for guest OS files within machine backups.
For every machine whose file system has been indexed, there is a dedicated folder that contains indexing data
for all restore points available for the machine.
Session Index
Veeam Backup Catalog keeps information for every backup job session. Session indexing data describes which
machine restore points correspond with a specific backup job session and what sets of files are required to
restore a machine to a specific point in time.
• For incremental backup chains, a session indexing file contains information about only one restore point —
the restore point that is created with this backup job session. Additionally, it contains information about a
set of files that is required to restore a machine to this point in time. For example, if a backup chain
contains 5 restore points, the 5th session indexing file will contain information about the 5th restore point
and a group of 5 files that are required to restore the machine to this point in time.
BackupServer=BACKUP01
JobName=srv04
SessionDateUtc=05/13/2014 [Link].081
####################################################
# OIBS
[Link]=srv04
[Link]=05/13/2014 [Link].988
[Link]=f81f790c-103e-4351-81a4-e4ec8a8c290c
[Link]=EVmware
[Link]=grp0
####################################################
# BACKUP FILE GROUPS
[Link]=BACKUP01
[Link]=c:\backup\srv04\[Link]
[Link]=05/13/2014 [Link].293
[Link]=BACKUP01
[Link]=c:\backup\srv04\[Link]
[Link]=05/13/2014 [Link].077
[Link]=BACKUP01
[Link]=c:\backup\srv04\[Link]
[Link]=05/13/2014 [Link].38
[Link]=BACKUP01
[Link]=c:\backup\srv04\[Link]
[Link]=05/13/2014 [Link].003
[Link]=BACKUP01
[Link]=c:\backup\srv04\[Link]
[Link]=05/13/2014 [Link].817
[Link]=BACKUP01
[Link]=c:\backup\srv04\[Link]
[Link]=05/13/2014 [Link].047
• For reverse incremental backup chains, a session indexing file contains information about all restore points
engaged in the backup job session. In a reverse incremental chain, the last restore point is always a full
backup. To produce a full backup and calculate incremental changes, Veeam Backup & Replication needs
to address all points in the job. For this reason, the session indexing file refers not only to the restore
point created with the backup job session, but also to all restore points preceding it. Additionally, a
session indexing file describes groups of files that are required to restore a machine to all possib le restore
points. For every restore point, there is a separate group of files.
For example, if you have a reverse incremental chain of 3 restore points, the session indexing file for the
last backup job session will contain information about 3 restore points and will describe three groups of
files:
o Group 0 will list restore points that are required to restore the machine to the 1st, the earliest restore
point.
o Group 1 will list restore points that are required to restore the machine to the 2nd restore point.
BackupServer=SRV02
JobName=srv01_reversed
SessionDateUtc=05/14/2014 [Link].952
####################################################
# OIBS
[Link]=srv01
[Link]=05/14/2014 [Link].993
[Link]=47c62e82-3066-478c-8272-1fb65a47d601
[Link]=EVmware
[Link]=grp1
[Link]=srv01
[Link]=05/14/2014 [Link].15
[Link]=d39f4a3c-2b5b-415a-ae0d-e9acc49f63a0
[Link]=EVmware
[Link]=grp2
[Link]=srv01
[Link]=05/14/2014 [Link].779
[Link]=1f3c31bf-9541-46ac-9826-62ecfd76a291
[Link]=EVmware
[Link]=grp3
####################################################
# BACKUP FILE GROUPS
[Link]=BACKUP
[Link]=c:\backup\srv01_reversed\srv01_reversed2014-[Link]
[Link]=05/14/2014 [Link].993
[Link]=BACKUP
[Link]=c:\backup\srv01_reversed\srv01_reversed2014-[Link]
[Link]=05/14/2014 [Link].43
[Link]=BACKUP
[Link]=c:\backup\srv01_reversed\srv01_reversed2014-[Link]
[Link]=05/14/2014 [Link].973
[Link]=BACKUP
[Link]=c:\backup\srv01_reversed\srv01_reversed2014-[Link]
[Link]=05/14/2014 [Link].43
[Link]=BACKUP
[Link]=c:\backup\srv01_reversed\srv01_reversed2014-[Link]
[Link]=05/14/2014 [Link].973
[Link]=BACKUP
[Link]=c:\backup\srv01_reversed\srv01_reversed2014-[Link]
[Link]=05/14/2014 [Link].973
BSessionVersion=5
A full backup file “moves forward” with every new backup job run, and Veeam Backup & Replication updates
groups of files. This helps maintain valid groups of files required to restore a machine to a necessary point in
time.
The session indexing files maintain groups of files for all restore points that have ever existed in t he backup
chain. This behavior lets you search and restore machine guest OS files in archived backups.
• Current indexing data stores information for valid restore points that are currently available in the backup
chain in the backup repository. For example, if the retention policy for a backup job is set to 14, Veeam
Backup Catalog will contain indexing data for 14 restore points and 14 backup job sessions.
• Historical indexing data stores information for obsolete restore points: the points that were removed from
the backup chain. When you run a backup job to create a new restore point, the earliest restore point is
marked as obsolete and removed from the backup chain. Indexing data for this restore point in the Veeam
Backup Catalog is not removed. Instead, it is marked as historical.
Historical indexing data helps the user accomplish file search in backup files that were archived to tape or
to a secondary backup repository.
The retention policy for Veeam Backup Catalog is controlled by two values:
• Retention policy for a backup job on the Veeam backup server: the number of restore points in the backup
chain
The retention period is calculated differently for backup chains created with different ba ckup methods:
where:
• Catalog Retention is the retention period specified in Veeam Backup Enterprise Manager.
• X is the amount of time for which restore points are kept by a backup job.
For example, the retention policy settings are specified in the following manner:
• The retention policy for a backup job is set to 5 points. The backup job is run daily.
• The retention period in Veeam Backup Enterprise Manager is set to 1 month, or 30 days.
In this case, Veeam Backup Enterprise Manager will retain indexing data for 30 days, because this value is
greater than the number of restore points in the job.
When Veeam Backup Enterprise Manager deletes indexing data by retention, it removes the whole set of files:
machine indexing data and session indexing data. Before removing indexing data for a specific machine restore
point, Veeam Backup Enterprise Manager makes sure that this restore point is not referenced by any of backup
job sessions:
• If no relations are detected, indexing data for this machine restore point is removed from Veeam Backup
Catalog.
• If the machine restore point is referenced by any backup job session, indexing data for this machine
restore point remains in Veeam Backup Catalog.
For this reason, Veeam Backup Enterprise Manager retains more indexing data for reverse incremental chains.
The retention period is calculated by the following formula:
where:
• Catalog Retention is the retention period specified in Veeam Backup Enterprise Manager.
• X is the amount of time for which restore points are kept by a backup job.
For example, the retention policy settings are specified in the following manner:
• The retention policy for the backup job is set to 3 points. The backup job is run daily.
• The retention period in Veeam Backup Enterprise Manager is set to 1 month, or 30 days.
In this case, Veeam Backup Enterprise Manager will retain in Veeam Backup Catalog indexing data for 30 days
plus indexing data for 3 restore points in the backup chain.
IMP ORTANT
The longer the backup chain, the more indexing data is stored in Veeam Backup Catalog.
In case of long backup chains, indexing data may take a lot of space on the Veeam Backup Enterprise
Manager server. To overcome this situation, you can adjust the retention policy scheme or provide enough
space for indexing data in Veeam Backup Catalog on Veeam Backup Enterprise Manage r.
You can enable SSO for the following Veeam Backup Enterprise Manager components:
SAML authentication scenario in Veeam Backup Enterprise Manager comprises the following parties:
• User that logs in to the Veeam Backup Enterprise Manager website or vSphere Self -Service Backup Portal.
• Service provider (SP) — an application accessed by the user. In the Veeam backup infrastructure, the
service provider is the Veeam Backup Enterprise Manager website or vSphere Self-Service Backup Portal.
• Identity provider (IdP) — an external service (hosted on premises or in the public cloud) that facilitates
SSO. The IdP keeps user identity data in a user store (or attribute store). Upon requests from the SP, the
IdP issues SAML authentication assertions, that is, identifies the user and provides the SP with required
information about the user.
Veeam Backup Enterprise Manager supports identity providers that support the SAML 2.0 protocol, for
example, Active Directory Federation Services (AD FS), Azure Active Directory (Azure AD), Okta, Auth0,
Keycloak and so on.
The SP and IdP exchange information in the XML format in accordance with the SAML V2.0 Standard. The
Enterprise Manager administrator can specify what information is required from the IdP to set up SAML
authentication in Enterprise Manager and how SAML requests and responses are sent.
How It Works
In Veeam Backup Enterprise Manager, SAML authentication is performed in the following way:
1. The user accesses the website under an account of the External type. The account must be registered in
advance in Enterprise Manager by the Enterprise Manager administrator.
2. Veeam Backup Enterprise Manager redirects a SAML authentication request to the IdP.
3. If the user has not previously logged in with the single sign-on service of the IdP, the IdP redirects the
user to the URL of the single sign-on webpage.
Alternatively, if the user is already logged in with the single sign-on service, the user proceeds directly to
the step 6.
4. If the user has not previously logged in with the single sign-on service, the user specifies the password of
their account on the single sign-on webpage.
5. The IdP issues a SAML assertion and redirects it to Veeam Backup Enterprise Manager in the SAML
response. The SAML assertion must meet the following requirements:
o Contain a User Principal Name (UPN) of the user in the <NameID> element of the SAML response.
Getting Started
To set up SAML authentication, the Enterprise Manager administrator must complete the following tasks in
Enterprise Manager:
1. Obtain SAML metadata from the IdP and import this metadata to Veeam Backup Enterprise Manager. The
IdP metadata includes the IdP entity ID, login URL, SAML binding and public key certificate that will be
used to validate authentication assertions sent by the IdP. For more information, see Specifying Identity
Provider Settings.
2. [Optional] If you want to use a digital certificate to encrypt and sign SP SAML requests, specify certificate
settings. For more information, see Selecting SP Certificate.
3. [Optional] Specify advanced settings for SAML authentication. These settings define how the SP and IdP
will exchange SAML information. You may want to adjust the settings to strengthen SAML information
exchange between the SP and IdP. For more information, see Specifying Advanced SAML Authentication
Settings.
4. Export SP SAML metadata in Veeam Backup Enterprise Manager and pass this metadata to the IdP. The SP
metadata includes the SP entity ID, assertion consumer URL and public key certificate that will be used to
encrypt SAML responses sent by the IdP. For more information, see Obtaining Service Provider Settings.
5. Create user accounts. To provide users of a SSO service with access to the Veeam Backup Enterprise
Manager website or vSphere Self-Service Backup Portal, the administrator must create for these users
accounts of the External User or External Group type. For more information, see Configuring Accounts and
Roles and Managing Tenant Accounts.
On the IdP side, the IdP must configure trust relationship with Veeam Backup Enterprise Manager and configure
rules that define what information to provide to the SP. Depending on the IdP, these rules may be configured in
the form of claims, attribute statements and so on. For an example of how to perform this task in AD FS, see
Configuring AD FS for SAML Authentication.
• View vCenter Servers and install Veeam plug-in for vSphere Client on necessary servers
To start working with Veeam Backup Enterprise Manager, you must perform initial configuration. For more
information, see Initial Configuration.
NOTE
Configuration backup and restore is not supported for Veeam Backup Enterprise Manager.
1. Log in to the Veeam Backup Enterprise Manager website. For more information, see Accessing Enterprise
Manager Website.
2. Add backup servers you want to manage. For more information, see Adding Backup Servers.
3. Retrieve data from added backup servers. For more information, see Collecting Data from Backup Servers.
4. Assign the Portal Administrator, Restore Operator or Portal User roles to users who will work with Veeam
Backup Enterprise Manager. For more information, see Configuring Accounts and Roles.
5. Provide email notification settings to be able to receive emails with summary on performed backup and
replication jobs, lab request status changes and file restore operations. For more information, see
Configuring Notification Settings.
Once you have performed initial configuration, you can start working with managed backup servers. You can
change the necessary settings in the Configuration view at any time.
NOTE
The initial configuration tasks can be performed either by the user who installed Veeam Backup Enterprise
Manager or any of the users listed in the local Administrators group (these accounts are automatically
included in the Portal Administrators group).
In This Section
• Adding Backup Servers
• Audit Reports
• Veeam Backup Enterprise Manager supports adding backup servers with Ve eam Backup & Replication 10a
or later. However, when you use different major or minor versions of Veeam Backup Enterprise Manager
and Veeam Backup & Replication, you may not be able to leverage all features of Veeam Backup
Enterprise Manager:
o Enterprise Manager does not support editing jobs that are managed by backup servers of earlier major
or minor versions as well as Veeam Agent backup jobs, file backup jobs, object storage backup jobs,
and backup copy jobs.
o In Veeam Self-Service Backup Portal and vSphere Self-Service Backup Portal, you cannot create and
edit jobs managed by backup servers of earlier major or minor versions.
• Data collection from backup servers of earlier major and minor versions takes more time, which can be
critical if many backup servers are added to Enterprise Manager.
• When communicating with backup servers that have Veeam Backup & Replication 12 installed, Veeam
Backup Enterprise Manager uses a TLS certificate for authentication, so that Veeam Backup Enterprise
Manager does not store backup server account credentials. For connections with backup servers with
earlier versions of Veeam Backup & Replication, Veeam Backup Enterprise Manager uses backup server
account credentials. For more information, see Connecting to Backup Servers.
• All backup servers must be based on the same database engine as Veeam Backup Enterprise Manager
(PostgreSQL or Microsoft SQL Server).
• Do not add the same backup server to multiple instances of Veeam Backup Enterprise Manager, as well as
a backup server cloned from an already added backup server.
• Do not add a backup server that holds the same configuration database as an added backup server, even
after you remove the original backup server from Enterprise Manager.
You may have two backup servers with the same configuration database when, for example, you migrate a
configuration database from one backup server to another. To migrate a configuration database, follow
the steps described in the Migrating Veeam Backup & Replication to Another Backup Server section of the
Veeam Backup & Replication User Guide. In this case, the database will be restored with a d ifferent ID on
the target backup server, and you will avoid conflicts when adding the backup server to Enterprise
Manager.
To add a backup server to the Enterprise Manager infrastructure, take the following steps:
2. To open the Configuration view, click Configuration in the top right corner.
3. Select the Ba ckup Servers section on the left of the Configuration view.
5. In the DNS name or IP address of the Veeam backup server field, enter a full DNS name IPv4 or IPv6
address of the server you want to add. For more information on IPv6 support, see the IPv6 Support
section of the Veeam Backup & Replication User Guide.
7. Provide a name and password of the backup server account. The account must be assigned the Veeam
Backup Administrator role. For more information, see Configuring Backup Server Roles.
o On backup servers with Veeam Backup & Replication 11a or earlier, the port specified in the P ort field
will be used. The default port is 9392.
o On backup servers with Veeam Backup & Replication 12, the port specified in the Certificate port field
will be used. The default port is 9405.
10. [For backup servers with Veeam Backup & Replication 12] In the open window that shows a certificate
thumbprint of the backup server, validate the thumbprint:
o Click No if you do not trust the server. Veeam Backup Enterprise Manager will displa y an error
message, and you will not be able to connect to the server.
All operations on the backup server side are performed by Veeam Backup Service. The service verifies
beforehand if Enterprise Manager has rights to accomplish the necessary actions. The account used by
Enterprise Manager must have the Veeam Backup Administrator role assigned in Veeam Backup & Replication.
2. To open the Configuration view, click Configuration in the top right corner.
3. Select the Ba ckup Servers section on the left of the Configuration view.
4. Select a backup sever from the list and click E d it on the toolbar.
Alternatively, you can right-click the selected backup server and select E d it.
On the backup server side, a record about the Enterprise Manager instance is deleted from the configuration
database. The backup server continues using the license that Enterprise Manager pushed to the backup server
until you remove the license or install a new one.
2. To open the Configuration view, click Configuration in the top right corner.
3. Select the Ba ckup Servers section on the left of the Configuration view.
4. Select a backup sever from the list and click Remove on the toolbar.
Alternatively, you can right-click the selected backup server and select Remove.
There are two options for running the data collection job:
Every run of the data collection job initiates a new job session. For more information, see Data Collection Job
Sessions.
NOTE
• Enterprise Manager automatically starts a data collection job right after you add a backup server.
• Data collection job collects data from all added backup servers at once.
• To ensure periodic update of the information available to Veeam Backup Enterpris e Manager users,
use periodic data collection.
• Data collection from backup servers of earlier versions takes more time, which can be critical if many
backup servers are added to Enterprise Manager. If you notice a low performance of the data
collection job, consider upgrading the backup servers.
2. To open the Configuration view, click Configuration in the top right corner.
3. Select the Ba ckup Servers section on the left of the Configuration view.
5. In the Da ta Collection Settings window, specify the desired interval in the P eriodically every option.
You can also disable periodic data collection. In this case, you can only start the data collection job manually.
1. Select Ba ckup Servers on the left of the Configuration view and click Schedule on the toolbar.
3. Click OK.
3. To view the details on the started job session, click the Sessions link at the top or open the Sessions
section of the Configuration view.
2. In the list of sessions, select the necessary session and click the link in the Sta tus column.
For each backup server, the report contains the following data.
P a rameter Description
Sta tus Status of the last data collection job session for the backup server. For more
information on data collection, see Collecting Data from Backup Servers.
Possible values:
• Never processed — data collection has never been started for the
backup server
• Processing — data collection is in progress
• OK — data was collected successfully
• Warning — data collection completed with a warning
• Error — data collection failed
Ma chines Number of machines processed by the backup server, including the machines
from imported or orphaned backups.
Unstructured Data Number of object storage systems and file shares processed by the backup
server, including the file shares from imported or orphaned backups.
Source Data Size Size of source data processed by the backup server.
Server Description Backup server description that was specified when adding the server to the
Enterprise Manager infrastructure.
You can drill down into this data by clicking a link in the Ba ckup Server column to move through the levels in the
following succession: Backup servers > Jobs > Job sessions > Session details . Each level contains a list of entries
with details for that particular level.
NOTE
You can export displayed information to a file using the E x p ort link on the toolbar. To open the file on your
machine, use the associated application.
• User name
• Operation result
The generated file is also saved on the Enterprise Manager machine. Enterprise Manager does not clean up
these files. You can find all reports in the following folder: %ProgramData%\Veeam\Backup\WebRestore.
2. To open the Configuration view, click Configuration in the top right corner.
3. Select the Ba ckup Servers section on the left of the Configuration view.
The report contains only the audit records whose retention period is not expired. The retention period is
defined by the E vent history setting of Enterprise Manager. For more information on retention settings,
see Configuring Retention Settings for Index and History.
Audited Operations
Audit reports contain records about the following operations performed on a backup server:
IMP ORTANT
Backup window interval that you specify here, effects the job settings that you configure for tenants that
use the following portals:
2. To open the Configuration view, click Configuration in the top right corner.
5. Use the Activity graph scale options to switch between graph types: Linear and Logarithmic.
6. Select the Show b ackup window check box to highlight the backup window on the dashboard chart.
7. Specify time interval for the backup window. Default interval is from 8:00 PM to 8:00 AM. You can
change the interval to correlate with your planned backup window by editing the start and stop time.
• Check version — use this command to request vCenter Server version and operation status. If Veeam Plug-
in for VMware vSphere Client is deployed, its version, status and installation account will be also
displayed.
• Install — use this command to install Veeam Plug-in for VMware vSphere Client on the selected server.
• Remove — use this command to uninstall Veeam Plug-in for VMware vSphere Client from selected server.
For more information on the plug-in, see Veeam Plug-in for VMware vSphere Client.
IMP ORTANT
To perform these operations, you should supply a user account with sufficient permissions to access
vCenter Server. User account information is not imported from the Veeam Backup & Replication
configuration database to the Enterprise Manager database for security reasons.
Administrators grant users and groups access to Enterprise Manager by adding accounts. When adding an
account, administrators assign a role to the account to provide it with permissions.
• Portal Administrator
• Portal User
• Restore Operator
For the Portal User and Restore Operator roles, administrators can also configure restore scope and provide
permissions for guest OS file restore and application item restore.
NOTE
This section describes management of user accounts and roles required to work with the main Enterprise
Manager UI. If you plan to provide a user with access to vSphere Self-Service Backup Portal (and not to the
main Enterprise Manager UI), you do not need to configure an account for this user on the Roles tab of the
Configuration view. Such accounts are configured on the Self-service tab of the Configuration view. For
more information, see Managing Tenant Accounts.
* For more information on the single sign-on capability, see SAML Authentication Support.
Roles
To provide an account with permissions, administrators assign one of the following roles to the account: Portal
Administrator, Portal User or Restore Operator.
• Initially by default to
P ortal Yes Full access to all available
Ad ministrator the users listed in the operations on all tabs of the web
local Administrators UI
group and the user
who installed
Enterprise Manager
• By Portal
Administrator in
Configuration > Roles
Users with the Portal User or Restore Operator role can access their restore scope — a list of objects that can be
recovered by appropriate personnel. For example, the restore scope of database administrators is database
servers (Microsoft SQL Server, Oracle or other), the restore scope of Exchange administra tors is Exchange server
machines, and so on. For more information on configuring restore scope, see Configuring Restore Scope.
IMP ORTANT
You can customize the restore scope if you have the Enterprise Plus edition of Veeam Backup &
Replication. In other editions, this list includes all objects and cannot be customized. However, you can
delegate recovery of entire machines, guest files, or selected file types. For more information, see
Configuring Permissions for File and Application Item Restore.
• Add account
• Edit account
• Remove account
When you add or edit an account, you can configure permissions for restore operations that the user can
perform. The permissions are defined by restore scope and restore type. For more information, see the
following sections:
If you have Veeam ONE deployed in your backup infrastructure, you can view a report that lists Enterprise
Manager users, their roles and restore permissions. For details, see the Delegated Restore Permissions Overview
section of the Veeam ONE Reporting Guide.
Adding Account
To add an account, take the following steps:
2. To open the Configuration view, click Configuration in the top right corner.
5. From the Account type list, select a type of the account: User, Group , External User or External Group . For
more information, see Accounts and Roles Overview.
7. From the Role list, select a role you want to assign to the account: Portal Administrator , Portal User or
Restore Operator . For more information, see Accounts and Roles Overview.
NOTE
To be able to assign any of portal roles to Active Directory domain users or groups, make sure that
Veeam Backup Enterprise Manager service account has sufficient rights to enumerate Active
Directory domains (by default, Active Directory users have enough rights to enumerate Active
Directory domains).
In the Allow restore of section, you can configure additional restrictions for the restore scope. For more
information, see Configuring Permissions for File and Application Item Restore.
Removing Account
To remove an added user or group, select it in the list and click Remove on the toolbar.
To customize the restore scope, perform the following steps when adding or editing a Portal User or Restore
Operator account:
2. To open the Configuration view, click Configuration in the top right corner.
7. In the Ad d Objects window, select the objects you allow the user to restore. Consider that reverse DNS
lookup on the Veeam Backup Enterprise Manager server must be functional. Otherwise, the Ad d Objects
window may display incomplete infrastructure.
To search for an object, type a name or its part in the search field. Specify the type of the object from the
drop-down list next to the search field.
You can also use the buttons in the top right corner to switch between virtual infrastructure views:
o For Microsoft Hyper-V objects, you can switch between the Hosts and VMs , Hosts and Volumes , and
Hosts and VM Groups views.
o For VMware vSphere objects, you can switch between the Hosts and Clusters , VMs and Templates ,
Datastores and VMs and Tags and VMs views.
After the users log in to Enterprise Manager, they will be able to view objects included in their restore scope.
NOTE
The Ma chines and Unstructured Data tabs display only machines and unstructured data (file shares and
object storage systems) that have been backed up. The Files tab displays guest OS files only for machines
that have been backed up with guest file indexing enabled. For more information on indexing, see
Preparing for File Browsing and Searching.
Restore scope is automatically refreshed daily on built-in schedule and after any role modification. It may
happen that some newly created machines, file shares and backups are not yet presented to users in the
Ma chines, Unstructured Data or Files tabs right after the login to Enterprise Manager. If you cannot find an
object after making a search query, click the I d on’t see my VM link to refresh the view. This link, however, is not
visible until you get unsuccessful search results.
By default, users can restore all types of files from available backups and replicas. Files can be restored e ither to
the local machine or the original location. For security purposes, you can configure additional restrictions for the
restore scope. For example, you can specify the list of file types available to the user or prohibit downloading of
restored files at all.
To let users restore application items, you must assign a security role to the user account and allow the account
to access and restore application items. For example, users responsible for Oracle database restore must be
assigned an Enterprise Manager role and be able to restore Oracle databases.
To configure permissions for file and application item restore, take the following steps:
2. To open the Configuration view, click Configuration in the top right corner.
5. In the Allow restore of section, to allow restore of entire machines and VM disks of machines included in
the restore scope, select the E ntire machines and disks check box.
6. To allow restore of guest OS files, select the Files and folders check box. If you select this check box, you
can also select the following options:
o Allow in-place file restores only — select this option to allow file-level restore to the original location
only. Consider that the restored files will be available only to accounts that have access to the original
machine.
7. To allow restore of Microsoft Exchange items (mail, calendars, tasks), select the Microsoft Exchange items
check box.
8. To allow restore of databases, select the Da tabases check box. If you select this check box, you can also
select the following options:
o Select Microsoft SQL Server databases to allow restore of Microsoft SQL databases on machines
included in the user's restore scope.
o Select Ora cle databases to allow restore of Oracle databases on machines included in the user's
restore scope.
o Select P ostgreSQL instances to allow restore of PostgreSQL instances on machines included in the
user's restore scope.
o Select Deny in-place database restores to restrict the user from overwriting the original databases
during the database restore process.
o Select P rompt for AD account credentials e very time to specify an account every time you perform the
restore operation. This allows you to avoid storing account credentials in the Enterprise Manager
configuration database.
This option must be selected if you have Microsoft Exchange servers in different domains.
o Select Alwa ys use the specified AD account to use a specific account every time you restore Microsoft
Exchange items with Veeam Backup Enterprise Manager. This option is useful if you want to delegate
restore operations to a non-administrative user.
With this option selected, Microsoft Exchange servers must belong to the same Microsoft Active
Directory forest.
In this case, specify an Active Directory account name and password. Make sure the account meets the
following requirements:
▪ The account must have sufficient rights to access mailboxes. To assign these rights, you can use
Exchange Impersonation or grant the Full Access permission to the account. For more
information on Exchange Impersonation, see Microsoft Docs.
3. Select Use secure LDAP connection over SSL to set Enterprise Manager to connect to the domain
controller over the SSL or TLS protocol.
2. To open the Configuration view, click Configuration in the top right corner.
6. From the vSphere role list, select a vCenter Server role created in VMware vSphere.
7. From the Role list, select a role you want to assign to the account: Portal Administrator , Portal User or
Restore Operator . For more information, see Roles.
NOTE
To be able to assign any of portal roles to Active Directory domain users or groups, make sure that
Veeam Backup Enterprise Manager service account has sufficient rights to enumerate Active
Directory domains (by default, Active Directory users have enough rights to enumerate Active
Directory domains).
In the Allow restore of section, you can configure additional restrictions for the restore scope. For more
information, see Configuring Permissions for File and Application Item Restore.
When changing the service account, make sure that the new account has the required permissions. F or more
information, see Permissions.
To change the Enterprise Manager service account or service account password, follow these steps:
2. Change the account of the VeeamEnterpriseManagerSvc service or update the account password:
a. Open Services.
c. Right-click the VeeamEnterpriseManagerSvc service again, select P roperties and open the Log on tab.
d. In the This account filed, specify the user name of the service account.
e. In the P a ssword and Confirm password fields, enter the password for the service account.
f. Click OK.
3. To start the VeeamEnterpriseManagerSvc service, right-click the service and select Sta rt.
1. Uninstall Enterprise Manager. For details, see Uninstalling Veeam Backup Enterprise Manager.
2. Re-install Enterprise Manager and specify a new service account during installation. For details, see
Installing Veeam Backup Enterprise Manager.
Note that when you re-install Enterprise Manager, you must link it with the existing Enterprise Manager
configuration database.
NOTE
If SAML authentication is enabled, users can log in to vSphere Self-Service Backup Portal under SSO
accounts only.
2. To open the Configuration view, click Configuration in the top right corner.
6. In the Id entity Provider Configuration section, specify identity provider settings. For more information, see
Specifying Identity Provider Settings.
7. [Optional] If you want to use a certificate to encrypt and sign service provider SAML requests, specify
certificate settings. For more information, see Selecting Service Provider Certificate.
8. [Optional] Click the Ad vanced Settings link and specify advanced SAML authentication settings. For more
information, see Specifying Advanced SAML Authentication Settings.
9. In the E nterprise Manager Configuration section, export or manually copy metadata of the service provider
(the Veeam Backup Enterprise Manager website, vSphere Self-Service Backup Portal, or both) for which
you configure SSO. Use the metadata to register the service provider on the identity provider side. For
more information, see Obtaining Service Provider Settings.
After you configure SAML authentication settings, you can register user accounts that will be able to log in to
the Veeam Backup Enterprise Manager website or vSphere Self-Service Backup Portal using SSO. For more
information, see Configuring Accounts and Roles and Managing Tenant Accounts.
• Import identity provider settings from a SAML metadata file obtained from the identity provider.
To import identity provider settings from the SAML metadata file, in the Id entity P rovider Configuration section
of the SAML Authentication view, click the Imp ort from File link and browse to the metadata file. The metadata
file structure must conform to the SAML 2.0 Metadata Schema.
1. In the Id entity Provider Configuration section, in the E ntity ID field, specify a unique ID of the identity
provider.
2. In the Log in URL field, specify the URL of the single sign-on login page provided by the identity provider.
3. From the Binding list, select a SAML binding used by the identity provider to send SAML responses:
HttpRedirect or HttpPost.
4. In the Id P certificate field, specify a certificate that will be used to validate the signature of the signed
authentication assertions and decrypt assertions sent by the identity provider.
NOTE
Veeam Backup Enterprise Manager does not support identity provider certificate rollover.
1. In the E nterprise Manager Configuration section of the SAML Authentication view, click the Select link
next to the Certificate field.
2. In the Select Service Provider Certificate window, Veeam Backup Enterprise Manager will display
certificates located in the certificate store on the Enterprise Manager server. Choose the necessary
certificate from the list and click Select.
If you use a certificate to sign end encrypt SAML authentication requests, you must pass the public key
certificate to the identity provider. The identity provider will use this certificate to encrypt requests and validate
the request signature. For more information, see Obtaining Service Provider Settings.
• To change the service provider certificate, click the Remove link next to the Certificate field. Then
select another certificate from the certificate store.
• You can choose whether to include the certificate in the service provider metadata. For more
information, see Specifying Advanced SAML Authentication Settings.
1. To include in the service provider SAML metadata a security certificate required to decrypt service
provider authentication requests, select the Include encryption certificate in metadata check box.
2. To validate the signature of the signed requests, select the Include signing certificate in metadata check
box.
3. From the Minimum accepted incoming signing algorithm and Outbound sign algorithm lists, select what
type of signed requests and responses Enterprise Manager will be able to send and receive. By default, the
SHA256 option is selected. With this option selected, Enterprise Manager will send and receive requests
and responses signed using the SHA256 or stronger algorithm.
4. By default, to provide for single sign-on authentication for groups of users, Veeam Backup Enterprise
Manager accepts information about groups from the identity provider in statements of the Group type. If
it is required to use for this purpose statements of a different type, in the Group claim type field, specify
the necessary type.
5. If you want to sign authentication requests sent from Enterprise Manager to the identity provider with a
digital certificate, in the Id entity Provider Settings section, select the Sig n AuthnRequests to IdP check
box.
6. From the Authentication context comparison list, select a comparison method for authentication context:
Exact, Minimum, Maximum or Better.
7. From the Authentication context class list, select one of the classes to specify an authentication method
used by the Identity Provider. By default, the Password option is selected. For details on authentication
context classes, see Authentication Context for the OASIS Security Assertion Markup Language (SAML)
V2.0.
You can obtain service provider settings in one of the following ways:
• To export service provider settings of the Veeam Backup Enterprise Manager website, click the Download
link next to the Veea m Backup Enterprise Manager field.
• To export service provider settings of vSphere Self-Service Backup Portal, click the Download link next to
the vSp here Self-Service Backup P ortal field.
1. Copy the links next to the SP E ntity ID / Issuer and Assertion consumer URL fields.
2. If you have selected a certificate that will be used to sign end encrypt SAML authentication requests, you
must also pass the public key certificate to the identity provider. To copy the certificate, click the
Download link next to the Certificate field.
1. Obtain the service provider metadata exported from Veeam Backup Enterprise Manager. For more
information, see Configuring SAML Authentication Settings.
2. In AD FS, add a Relying Party Trust using the service provider metadata.
3. Edit the Claim Issuance Policy for the added Relying Party Trust to add an issuance transform rule with the
following properties:
4. [Optional] To provide single sign-on capabilities to AD groups, add to the Claim Issuance Policy an
issuance transform rule with the following properties:
where <Name> is a name of the AD group that includes users that will access the service provider.
When a user that belongs to the specified group attempts to access the service provider, the identity
provider will issue an authentication assertion confirming that the user belongs to the group.
Alternatively, if a different value is specified for the Group claim type option of advanced SAML
settings in Enterprise Manager, the same value must be specified as the outgoing claim type in AD FS.
where <Name> is a name of the group that will be returned to the service provider in authentication
assertions.
This value can be different from the User's group value, for example, if you do not want the service
provider to display AD group names. This value must be the same as the name of the account of the
External Group type added in Enterprise Manager. For more information, see Configuring Accounts
and Roles and Adding Tenant Account.
For example, you want to provide single sign-on capabilities to users that belong to the Backup AD group.
In Enterprise Manager, you have the EnterpriseUsers account of the External Group type, and the default
group claim type is specified in advanced SAML settings.
To allow these users to log in to Enterprise Manager with the single sign-on service, you must create an
issuance transform rule with the following properties:
• If you use the Standard edition of Veeam Backup & Replication in your virtual environment, Veeam Backup
Enterprise Manager keeps index files only for those backups that are currently stored on disk (that is, the
backups are available on backup repositories).
• If you use the Enterprise or Enterprise Plus edition, Veeam Backup Enterprise Manager keeps index files
for backups that are currently stored on disk and for archived backups (for example, backups that were
recorded to tape). Thus, you will be able to browse and search through backup contents even if the
backup in repository is no longer available or it was removed by Remove from Backups or Remove from
Disk command in Veeam Backup console. For more information, see Managing Backups and Managing
Replicas sections of the Veeam Backup & Replication User Guide.
IMP ORTANT
Consider that, by default, backup repository is the primary destination for the search. This means, in
particular, that if a backup (with indexed guest) is stored in both locations — repository and tape — then
Enterprise Manager search results will only include files from backup stored in the repository. Files from
tape-archived backup will appear in search results only if not found in the repository.
2. To open the Configuration view, click Configuration in the top right corner.
4. On the Session History tab, in the Guest file system catalog section, specify how long index files must be
stored on the Enterprise Manager server:
a. Enter the desired number of months in the Retention period, months field. The default value is
3 months, the minimum allowed value is 1 month, and the maximum allowed value is 99 months.
b. When finished, click the Sa ve button under the E vent history section. New retention settings will be
saved in the Enterprise Manager database, and a message notifying you on the update will be
displayed at the top of the window.
5. In the E vent history section, specify the period for which Enterprise Manager should keep historical data
available in the main working area of the Enterprise Manager website.
a. Enter the desired number of weeks or select Keep all. By default, the retention period for session data
is set to 13 weeks. The minimum allowed value is 1 week, and the maximum allowed value is
999 weeks.
Before you configure notification settings, specify settings of the server that will send email notifications to
necessary email addresses. For more information, see Mail Server Settings.
• Notifications on licensing
You can allow Veeam Backup Enterprise Manager to send email notifications on behalf of your Google or
Microsoft 365 account using OAuth 2.0 authentication, or you can specify connection settings of your SMTP
server that use basic (with a password) authentication. You can select from the following options:
To connect Veeam Backup Enterprise Manager with your Google account, do the following:
2. To open the Configuration view, click Configuration in the top right corner.
4. On the Server Settings tab, select Google Gmail from the Ma il server list.
You can register Veeam Backup Enterprise Manager in the Google Cloud console.
1. Log in to the Google Cloud console under a Google account that you want to use for sending email
notifications.
2. Create a new project and enable Gmail API for the project.
3. Create the OAuth client ID credentials — a client ID and client secret for the Veeam Backup Enterprise
Manager application.
[Link]
where <EnterpriseManagerServer> is a host name of the host where the Enterprise Manager server
resides.
o Client ID
o Client secret
To connect Veeam Backup Enterprise Manager with your Microsoft 365 account, do the following:
2. To open the Configuration view, click Configuration in the top right corner.
4. On the Server Settings tab, select Microsoft 365 from the Ma il server list.
5. In the Ap p lication client ID field, specify the client ID assigned to your Microsoft Entra application.
7. In the Client secret field, specify the client secret assigned to your Microsoft Entra application.
10. Allow Veeam Backup Enterprise Manager to access your Microsoft 365 account and send email
notifications on your behalf.
1. Log in to the Microsoft Azure portal under an account that you want to use for sending email notifications.
The account must have an active subscription and the permissions to register Microsoft Entra applications.
b. In the Sup ported account types section, select the Accounts in this organizational directory only
option.
c. In the Red irect URI section, select the W eb option from the platform list and specify the following
URI:
[Link]
ns
where <EnterpriseManagerServer> is a host name or IP address of the host where the Enterprise
Manager server resides.
3. Grant the application the [Link] permission of Microsoft Graph. This will allow Veeam Backup
Enterprise Manager to call the Microsoft Graph API for sending email notifications.
4. Add a new client secret. It is used to prove the application identity to the Microsoft identity platform.
o Directory (tenant) ID
o Application (client) ID
NOTE
When you add an SMTP server, Veeam Backup Enterprise Manager saves its TLS certificate thumbprint. If
the SMTP server certificate is changed and the certificate is not trusted, Enterprise Manager stops sending
email notifications until you validate the new certificate.
2. To open the Configuration view, click Configuration in the top right corner.
4. On the Server Settings tab, select Custom SMTP from the Ma il server list.
5. On the Server Settings tab, specify a full DNS name or IP address of the SMTP server. If necessary, change
the port number that will be used to communicate with the mail server. The default port number is 25.
7. If the SMTP server requires SSL connection, select the Use SSL check box.
8. If the SMTP server requires authentication, select the Requires authentication check box and specify
authentication credentials.
9. Click Sa ve.
• Backup jobs
• Replication jobs
• Backup jobs of Veeam Agent for Linux and Veeam Agent for Microsoft Windows (both managed by Veeam
Agent and by the backup server)
2. To open the Configuration view, click Configuration in the top right corner.
7. In the To field, enter an email address of the notification recipient. Use a comma to specify multiple
addresses.
8. In the Sub ject field, enter a subject of email notifications. You can use the following variables in the
subject:
o %1 — number of jobs that ended with errors for the last 24 hours
o %2 — number of jobs that ended with warnings for the last 24 hours
Job retries performed in the last 24 hours are also included in the report.
Jobs which were in Disabled state during the last session are also included in the report.
9. Click Sa ve.
TIP
To verify that you have configured email settings correctly, click Test. Veeam Backup Enterprise Manager
will send a test email to all specified email addresses.
2. To open the Configuration view, click Configuration in the top right corner.
7. In the To field, enter an email address of the notification recipient. Use a comma to specify multiple
addresses.
9. Select request statuses for a report. The notification email will be sent if the request is P ending, Ready,
Ca nceled, Ap proved, Failed or Stopped.
TIP
To verify that you have configured email settings correctly, click Test. Veeam Backup Enterprise Manager
will send a test email to all specified email addresses.
For more information about the universal application item-level restore, see Veeam Universal Application Item
Recovery Guide.
• Instant Recovery
• Entire VM Restore
2. To open the Configuration view, click Configuration in the top right corner.
7. In the To field, enter an email address of the notification recipient. Use a comma to specify multiple
addresses.
8. Click Sa ve.
TIP
To verify that you have configured email settings correctly, click Test. Veeam Backup Enterprise Manager
will send a test email to all specified email addresses.
2. To open the Configuration view, click Configuration in the top right corner.
5. Select the Check for product and hypervisor updates periodically check box.
2. To open the Configuration view, click Configuration in the top right corner.
Enterprise Manager sends notifications on license usage on the first day of the month. If
Veeam Backup & Replication does not perform any backup and replication jobs for the whole month, Enterprise
Manager does not send the notifications.
2. To open the Configuration view, click Configuration in the top right corner.
7. In the To field, enter an email address of the notification recipient. Use a comma to specify multiple
addresses.
8. Click Sa ve.
TIP
To verify that you have configured email settings correctly, click Test. Veeam Backup Enterprise Manager
will send a test email message to all specified email addresses.
You can configure Enterprise Manager to send notifications about the following key management operations:
key expiration, key deletion, key modification.
2. To open the Configuration view, click Configuration in the top right corner.
7. In the To field, enter an email address of the notification recipient. Use a comma to specify multiple
addresses.
8. Click Sa ve.
TIP
To verify that you have configured email settings correctly, click Test. Veeam Backup Enterprise Manager
will send a test email to all specified email addresses.
2. To open the Configuration view, click Configuration in the top right corner.
Log files are stored on the Enterprise Manager server at the following paths:
C:\ProgramData\Veeam\Backup\[Link]
C:\ProgramData\Veeam\Backup\[Link]
C:\ProgramData\Veeam\Backup\[Link]
C:\ProgramData\Veeam\Backup\[Link]
You can use Veeam Backup Enterprise Manager logs to submit a support ticket at the Veeam Customer Support
Portal. To ensure that overall and comprehensive information is provided to Veeam Customer Support, send all
log files when submitting a support ticket.
Initially, Veeam Backup Enterprise Manager uses the same TLS certificate for all connections. If you want to use
different certificates, you can update your current certificate. For more information, see Updating TLS
Certificates.
• Veeam Backup Enterprise Manager Service and Veeam Guest Catalog Service communicate with backup
servers added to the Enterprise Manager infrastructure.
• Veeam Backup Enterprise Manager web app and Veeam vSphere Client plug -in communicate with a
browser.
• Veeam Backup Enterprise Manager REST API service communicates with a REST API client.
1. When adding a backup server, you specify connection settings including an account with Veeam Backup
Administrator role assigned on the backup server.
2. Veeam Backup Enterprise Manager sends the credentials as well as the certificate thumbprint that will be
used by Veeam Backup Enterprise Manager Service and Veeam Guest Cata log Service for authentication.
3. Veeam Backup & Replication validates the credentials and saves Enterprise Manager data including the
certificate thumbprint.
4. Veeam Backup & Replication sends its certificate thumbprint to Enterprise Manager.
For more information on managing backup server certificates, see the Backup Server Certificate section of
the Veeam Backup & Replication User Guide.
5. You validate the certificate. If you trust the certificate, Enterprise Manager adds the backup server to the
infrastructure and saves the thumbprint to the database.
If a backup server is not available at the moment, Enterprise Manager stores the backup server account
credentials until the connection is established. Then the credentials are deleted from the Enterprise
Manager database.
6. The next time Enterprise Manager connects to Veeam Backup & Replication, the Enterprise Manager
certificate is used for authentication.
7. If a backup server certificate is updated, you will have to validate it from Enterprise Manager. Until you
validate the certificate, Enterprise Manager cannot collect data from the backup server.
8. Thirty days before the Enterprise Manager certificate is expired, you are prompted to update it.
• To update the certificate used by Veeam Backup Enterprise Manager Service and Veeam Guest Catalog
Service, go to Configuration > Ba ckup Servers and click Up d ate certificate.
• To update the certificate used by Veeam Backup Enterprise Manager web app and Veeam vSphere Client
plug-in, you can use Internet Information Services (IIS) Manager. For more information, see this Microsoft
Docs article.
If you want to use a certificate obtained from a Certificate Authority, make sure that the fully qualified
domain name of the Enterprise Manager server is specified in the certificate subject or subject alternative
name.
• To update the Veeam Backup Enterprise Manager REST API certificate, use the netsh command. For more
information, see the TLS Certificate section of the Veeam Backup Enterprise Manager REST API Reference.
Available Languages
Veeam Backup Enterprise Manager is available in the following languages:
• English
• French
• German
• Italian
• Japanese
• Spanish
Selecting Language
The first time you visit one of the Veeam Backup Enterprise Manager components, the content is displayed in
the language of your browser. If the website does not support the browser language, the interface is displayed
in English.
You can select a preferred language from the drop -down list on the login page. If the language you need is not
available, you can add it. For more information, see Adding Languages.
All files names must follow the naming conventions. For more information, see File Names.
File Formats
Enterprise Manager languages are stored in text files of the following formats:
• POT files that contain UI texts in the source language. The source language of Enterprise Manager is
English.
• [Optional] PO files that contain UI texts as pairs of strings: source string and its translation. Each language
is stored in a separate file. You can create PO files from the POT files and use them in the translation
process. After you finish the translation, you must convert PO files to the JSON format.
• JSON files that contain UI texts as pairs of strings: source string and its translation. Enterprise Manager
uses these files to display the interface in a language other than English.
File Names
In order for Veeam Backup Enterprise Manager to recognize files within the lang folder as language files, their
names must follow the naming conventions.
• [Link] — file used for the Veeam Backup Enterprise Manager website
• messages.<code>.json — file used for the Veeam Backup Enterprise Manager website
where <code> is an ISO 639-1 code that represents the language. The code consists of a two-letter lowercase
culture code and optional two-letter uppercase region code. For example: en, fr-CA, fr-FR, pt-BR or pt-PT.
where <code> is an ISO 639-1 code that represents the language. The code consists of a two-letter lowercase
culture code and optional two-letter uppercase region code. For example: en, fr-CA, fr-FR, pt-BR or pt-PT.
3. Save the translation files to the lang folder. The default path is the following:
%PROGRAMFILES%\Veeam\Backup and Replication\Enterprise
Manager\WebApp\scripts\build\production\resources\lang.
IMP ORTANT
Make sure the JSON translation files are named as follows: [Link],
vcloud_messages.[Link], vsphere_messages.[Link]. For more information on file
naming, see Language Files Overview.
4. In IIS Manager, restart the VeeamBackup website and recycle the VeeamBackup application pool. For more
information, see the Site <site> and Recycling Settings for an Application Pool <recycling> sections of
Microsoft Docs.
o [Link]
o vcloud_messages.pot
o vsphere_messages.pot
For more information on file names and formats, see Language Files Overview.
o messages.<code>.po
o vcloud_messages.<code>.po
o vsphere_messages.<code>.po
TIP
Although PO files are not used by Veeam Backup Enterprise Manager, you can save them in the lang
folder to keep them together with other language files.
PO File Structure
Each PO file contains the following elements:
• Header
• Translation entries
Header
Header contains meta data of the PO file: language code in the ISO 639-1 format, content type and encoding,
and plural form information.
P a rameter Description
Content-Type Content type and character encoding used for the translation language. Set the
type value to text/plain. You can use the UTF-8 encoding for any language.
P lural-Forms Number of plural forms and the plural form formula of the translation language.
"Project-Id-Version: \n"
"POT-Creation-Date: \n"
"PO-Revision-Date: \n"
"Language-Team: \n"
"Language: de\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Plural-Forms: nplurals=2; plural=(n != 1);\n"
"X-Generator: \n"
For more information on the PO header, see this GNU gettext article.
Translation entries
In a PO file, translation entries are separated with a blank string. Each entry consists of the following elements:
• Do not modify msgid strings. They are references to the source code. Veeam Backup Enterprise Manager
uses them to find their translation.
Variables are placed inside braces. For example, the following entry contains the restoreItemsCount
variable:
• If an msgid string is followed by its plural form msgid_plural, provide translation for each form.
For example:
For more information on translating plural forms, see this GNU gettext article.
Converting PO to JSON
Veeam Backup Enterprise Manager loads translated strings from JSON files. After you finish translating PO files,
convert them to the JSON format.
1. To locate the utility, use the cd command. By default, the utility is located in the Enterprise Manager
folder.
cd '<path>'
For example:
.\[Link] '<po_file>'
For example:
TIP
To view help for the [Link] utility, run the utility with the /help
parameter.
You can view statistics for one of the following time ranges:
• Last 24 hours
• Last 7 days
To switch between the ranges, select the necessary tab in the top left corner.
• Backup servers — number of backup servers added to the Enterprise Manager infrastructure.
• Jobs — number of jobs configured on the added backup servers (including backup, backup copy,
replication, sure backup, backup to tape and file to tape jobs). This number also includes Veeam Agent
backup jobs managed by Veeam Agent.
• Machines — number of machines processed by the backup servers (including VMware VMs, Microsoft
Hyper-V VMs, and Veeam Agent machines) and machines that are processed by Veeam Agent backup jobs
managed by Veeam Agent. If a machine is processed by multiple jobs, it is counted as a single machine.
The Image Data widget contains information about backups of VMware VMs, Microsoft Hyper-V VMs, and
Veeam Agent machines managed by backup servers. Note that the data covers all Veeam Agent backup modes:
image-level, volume-level and file-level.
• Source size — total size of processed machines. If a machine is processed by multiple jobs (including
backup copy jobs), it is counted as a single machine.
• Full backups — total size of full backups. This number does not include backups created by backup copy
jobs.
• Restore points — total size of incremental backups. This number does not include backups created by
backup copy jobs.
The File Data widget contains the following information about unstructured data backups:
• Management server — status of the Veeam Backup Enterprise Manager management server.
You can use the links in these blocks to drill down into detailed reports on specific aspects of the backup
infrastructure.
You can view the chart for one of the time following ranges:
• Last 24 hours
• Last 7 days
To switch between the ranges, select the necessary tab in the top left corner.
• Enterprise Manager does not display backup policies created with the following Veeam solutions for cloud
environments:
• For the following Veeam plug-ins, Enterprise Manager displays only backup copy jobs:
o Veeam Backup for Oracle Linux Virtualization Manager and Red Hat Virtualization
• For physical machines, Enterprise Manager displays the following job types:
o Both Veeam Agent backup jobs managed by Veeam Agent and Veeam Agent backup jobs managed by
the backup server. For more information, see Veeam Agents Support.
To quickly find a job, you can use filters and the search field.
• To view jobs of a specific backup server, select the server from the Ba ckup server drop-down list.
• To filter job by job types or job statuses, use the Filter Options filter.
Once you have selected necessary job types and statuses, click Ap p ly to apply the filter.
Besides the information presented in the list of jobs, the Job s tab allows you to view advanced job data:
• To see a list of job sessions, click the job name link in the Na me column.
• To see detailed statistics on the last job run, click the state link in the Sta tus column.
NOTE
You can export displayed information to a file using the E x p ort link on the toolbar. This file then can be
opened on the client machine using the associated application.
• To start a job, select the job from the list and click Sta rt.
• To stop a job, select the job from the list and click Stop .
• To retry a failed job, select the job from the list and click Retry.
NOTE
• For more information on starting a backup copy job, see the Starting and Stopping Backup Copy Jobs
section of the Veeam Backup & Replication User Guide.
• For more information on starting and stopping a Microsoft SQL Server, Oracle or PostgreSQL backup
job with transaction log processing enabled, see the Starting and Stopping Transaction Log Backup
Jobs section of the Veeam Backup & Replication User Guide.
IMP ORTANT
• You can edit jobs if you have an Enterprise or Enterprise Plus license installed.
• In Enterprise Manager, you cannot edit jobs that are managed by backup servers of earlier versions
as well as Veeam Agent backup jobs, file backup jobs, object storage back up jobs, and backup copy
jobs. To edit settings of such jobs, use the Veeam Backup & Replication console.
In Veeam Backup Enterprise Manager, you can change the following job settings:
• Change a job name, description and retention settings for the restore points.
• Manage a list of machines that the job should process (add and remove machines or containers, exclude
individual machines from containers, change the order in which the job will process machines).
NOTE
If the Location properties of the source object and target object do not match, you will receive a warning
message after you finish editing. For example, you may have a backup job targeted at repository located in
Sydney, and source machines located in London.
To edit a job, use the E d it Backup Job (or E d it Replication Job) wizard.
3. Select E d it.
Alternatively, you can right-click a job and select Job > E d it.
2. In the Description field, provide an optional description for future reference. The default description
contains information about the user who created the job, date and time when the job was created.
o From the Retention p olicy list, select Restore points and specify the number of restore points that you
want to store in the backup repository. When this number is exceeded, the earliest restore point will
be removed from the backup chain.
o From the Retention p olicy list, select Days and specify the number of days for which you want to store
restore points in the backup repository. After this period is over, a restore point will be removed from
the backup chain.
For more information on retention, see the Short-Term Retention Policy section of the Veeam Backup &
Replication User Guide. Also, see this Veeam KB article.
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 often full
backups are retained. For more information, see the Long-Term Retention Policy (GFS) section of the
Veeam Backup & Replication User Guide.
NOTE
• For VMware Cloud Director backup jobs, you can add and remove the following Cloud Director
objects: VMs, vApps, organization VDCs, organizations and the Cloud Director instance. The scope
depends on your Cloud Director access rights.
• For VMware Cloud Director replication jobs, you cannot add or remove single VMs. You can manage
only vApps and other Cloud Director containers.
1. Click the Ad d .
If you select a VM container and later add a new VM to the container, Veeam Backup & Replication will
update job settings automatically to include the VM.
TIP
• Search for objects: type a name or part of a name in the search field. Specify the type of the
object from a scroll list next to the search field.
• Use the buttons in the top right corner to switch between virtual infrastructure views:
o For Microsoft Hyper-V objects, you can switch between the Hosts and VMs , Hosts and
Volumes, and Hosts and VM Groups views.
o For VMware vSphere objects, you can switch between the Hosts and Clusters , VMs and
Templates , Datastores and VMs and Tags and VMs views.
o For VMware Cloud Director, protection groups, unstructured data and Nutanix AHV,
switching the views is not available.
2. In the E x clusions window, click Ad d and select machines that you want to exclude.
To change the VM processing order, select the necessary machines and move them up or down the list using the
Up and Down buttons on the right. In the same manner, you can set the backup order for containers in the
backup list.
NOTE
• VMs inside a VM container are processed at random. To ensure that VMs are processed in the
defined order, add them as standalone VMs, not as a part of containers.
• The processing order may differ from the order that you have defined. For example, if resources of a
VM that is higher in the priority are not available, and resources of a VM that is lower in the priority
are available, the VM with the lower priority will be processed first.
• For VMware Cloud Director backup jobs, you can change the order of the following Cloud Director
objects: VMs, vApps, organization VDCs, organizations and the Cloud Director instance. The scope
depends on your Cloud Director access rights.
• For VMware Cloud Director replication jobs, you cannot change the VM processing ord er. You can
manage only vApps and other Cloud Director containers.
• Application-Aware Processing
• Guest OS Credentials
Application-Aware Processing
At the Guest Processing step of the wizard, you can enable application-aware processing. Application-aware
processing is a Veeam technology based on Microsoft VSS and used to create transactionally consistent backups
or replicas of VMs that run Microsoft Active Directory, Microsoft SQL Server, Microsoft SharePoint, Microsoft
Exchange, Oracle or PostgreSQL. For more information, see the Application-Aware Processing section of the
Veeam Backup & Replication User Guide.
To customize settings of a machine added to the job as part of a container, add the machine as a
standalone instance. For that, click Ad d machine and choose the necessary VM. Next, select the machine
from the list and click E d it to customize VM settings.
To discard custom settings of a machine, select the machine in the list and click Remove.
o General Settings
General Settings
On the General tab, you can specify general application-aware processing settings.
1. In the Ap p lications section, select the option that corresponds to your transactionally-consistent backup
creation scenario.
o Select Require successful processing (default option) if you want Veeam Backup & Replication to stop
the backup job if an error occurs.
o Select Try application processing, but ignore failures if you want to continue the backup process even
if an error occurs. This option guarantees completion of the job. The created backup image will not be
transactionally consistent, but rather crash-consistent.
o Select Disable application processing if you do not want to enable application-aware processing for
the VM. This option makes the Tra nsaction Logs P rocessing section unavailable.
o [For Microsoft Exchange and Microsoft SQL VMs] If you want Veeam Backup & Replication to process
application logs, select P rocess transaction logs with this job and specify settings on the SQL tab. For
more information, see Microsoft SQL Server Transaction Log Settings.
NOTE
[For Microsoft Exchange VMs] If you select this option, Veeam Backup & Replication will back
up the Exchange database and its logs. The non-persistent runtime components or persistent
components that run on the VM guest OS will wait for a backup job to complete successfully.
After that, they will trigger truncation of transaction logs on a Microsoft Exchange server. If the
backup job fails, the logs on this server will remain untouched.
o [For Microsoft Exchange and Microsoft SQL VMs] If you use a third -party backup tool to perform VM
guest level backup, and this tool maintains consistency of the database state, select P erform copy
only . Veeam Backup & Replication will create a copy-only backup for the selected VM. The copy-only
backup preserves the chain of full or differential backup files and transaction logs on the VM. For
more information, see Microsoft Docs.
Note that if you select this option, the SQL tab will not be available in the VM P rocessing Settings
window.
• [For Oracle VMs and PostgreSQL VMs] You must specify settings for application log handling on the
Ora cle and P ostgreSQL tabs of the VM P rocessing Settings window. For more information, see Oracle
Archived Redo Log Settings and PostgreSQL Archive Log Settings.
3. In the P ersistent guest agent section, specify if Veeam Backup & Replication must use persistent guest
agents on each protected VM for application-aware processing.
Select the Use p ersistent guest agent check box to enable persistent agent components for guest
processing. For more information, see the Non-Persistent Runtime Components and Persistent Agent
Components section of the Veeam Backup & Replication User Guide.
IMP ORTANT
If both Microsoft SQL Server and Oracle Server are installed on the same VM, and this VM is processed by a
job with log backup enabled for both applications, Veeam Backup & Replication will back up only Oracle
transaction logs. Microsoft SQL Server transaction logs will not be processed.
1. At the Guest Processing step of the wizard, make sure the E na ble application-aware processing check box
is selected.
3. In the displayed window, select the Microsoft SQL Server VM from the list and click E d it.
4. On the General tab of the VM P rocessing Settings window, make sure the following options are selected:
o In the Ap p lications section, either the Require successful processing or Try application processing, but
ig nore failures option must be selected.
6. Specify how Veeam Backup & Replication will process SQL transaction logs.
o Select Truncate logs to truncate transaction logs after successful backup. The non-persistent runtime
components or persistent components running on the VM guest OS will wait for the backup to
complete successfully and then truncate transaction logs. If the job does not manage to back up the
Microsoft SQL Server VM, the logs will remain untouched on the VM guest OS until the next start of
the non-persistent runtime components or persistent components.
NOTE
If the account specified at the Guest Processing step does not have enough rights,
Veeam Backup & Replication tries to truncate logs using the NT AUTHORITY\SYSTEM account.
Make sure that the account has permissions listed in the Permissions section of the Veeam
Explorers User Guide.
Select this option for databases that use the Simple recovery model. If you enable this option for
databases that use the Full or Bulk-logged recovery model, transaction logs on the VM guest OS may
grow large and consume all disk space. In this case, the database administrators must take care of
transaction logs themselves.
o Select Ba ckup logs periodically to back up transaction logs with Veeam Backup & Replication. Veeam
Backup & Replication will periodically copy transaction logs to the backup repository and store them
together with the image-level backup of the Microsoft SQL Server VM. During the backup job session,
transaction logs on the VM guest OS will be truncated.
For more information, see the Microsoft SQL Server Transaction Log Settings sections of the Veeam
Backup & Replication User Guide.
7. If you have selected the Ba ckup logs periodically option, specify settings for transaction log backup:
a. In the Ba ckup logs every <N> minutes field, specify the frequency for transaction log backup. By
default, transaction logs are backed up every 15 minutes. The maximum log backup interval is 480
minutes.
b. In the Retain log backups section, specify retention policy for transaction logs stored in the backup
repository.
▪ Select Until the corresponding image-level backup is deleted to apply the same retention policy
for image-level backups and transaction log backups.
▪ Select Keep only last <N> days to keep transaction logs for a specific number of days. By
default, transaction logs are kept for 15 days. If you select this option, you must make sure that
retention for transaction logs is not greater than retention for the image-level backups. For
more information, see Retention for Transaction Log Backups section of the Veeam Backup &
Replication User Guide.
NOTE
Using the Veeam Backup & Replication console, you can also specify log shipping servers that you want to
use to transport transaction logs. For more information, see the Microsoft SQL Server Transaction Log
Settings section of the Veeam Backup & Replication User Guide.
1. At the Guest Processing step of the wizard, make sure the E na ble application-aware processing check box
is selected.
3. In the displayed window, select the Oracle VM from the list and click E d it.
4. On the General tab of the VM P rocessing Settings window, make sure that either the Require successful
p rocessing or Try application processing, but ignore failures option is selected.
IMP ORTANT
If both Microsoft SQL Server and Oracle are installed on one machine, and this machine is processed
by a job with log backup enabled for both applications, Veeam Backup & Replication will back up
only Oracle transaction logs. Microsoft SQL Server transaction logs will not be processed.
a. Specify a user account that will connect to the Oracle database and perform Oracle archived logs
backup and deletion.
▪ Select Use guest credentials to use the account specified at the Guest Processing step of the
wizard to access the VM guest OS and connect to the Oracle database.
▪ Specify another account. To do this, select the necessary account from the drop -down list or
click Ad d and add a new account.
Make sure the specified account has sufficient rights. For details, see the Permissions section of the
Veeam Explorers User Guide.
b. Specify how Veeam Backup & Replication must process archived redo logs on the Oracle VM.
▪ Select Do not d elete archived logs to preserve archived redo logs on the original Oracle server.
Select this option for databases in the NOARCHIVELOG mode. If the database is in the
ARCHIVELOG mode, archived logs on the VM guest OS may grow large and consume all disk
space. In this case, database administrators must take care of archived logs themselves.
When the parent backup job (job creating an image-level backup) runs, Veeam Backup &
Replication will wait for the backup to complete successfully, and then trigger archived logs
deletion on the Oracle VM over Oracle Call Interface (OCI). If the primary job does not manage to
back up the Oracle VM, the logs will remain untouched on the VM guest OS until the next start
of the non-persistent runtime components or persistent components.
TIP
Veeam Backup & Replication removes redo logs only after the parent backup job session. To
remove redo logs more often, you can schedule the job to run more often.
c. To back up Oracle archived logs with Veeam Backup & Replication, select the Ba ckup logs every <N>
minutes check box and specify the frequency for archived log backup. By default, archived logs are
backed up every 15 minutes. The maximum log backup interval is 480 minutes.
IMP ORTANT
If you plan to use this option together with archived logs deletion from Oracle machine guest,
make sure that these settings are consistent: logs should be deleted after they are backed up to
repository. Thus, you need to set up backup schedule and log removal conditions appropriately.
d. If you have selected the Ba ckup logs every <N> minutes option, specify retention policy for the
archived logs stored in the backup repository. For the Retain log backups setting, select one of the
following:
▪ Select Until the corresponding image-level backup is deleted to apply the same retention policy
for image-level backups and archived log backups.
▪ Select Keep only last <N> days to keep archived logs for a specific number of days. By default,
archived logs are kept for 15 days. If you select this option, you must make sure that retention
for archived logs is not greater than retention for the image-level backups. For more
information, see the Retention for Archived Log Backups section of the Veeam Backup &
Replication User Guide.
NOTE
Using the Veeam Backup & Replication console, you can also specify log shipping servers that you want to
use to transport archived logs. For more information, see the Oracle Archived Log Settings section of the
Veeam Backup & Replication User Guide.
1. At the Guest Processing step of the wizard, make sure the E na ble application-aware processing check box
is selected.
3. In the displayed window, select the PostgreSQL VM from the list and click E d it.
5. On the P ostgreSQL tab of the VM P rocessing Settings window, specify settings for PostgreSQL logs
processing.
a. Specify an account that will connect to the PostgreSQL instance and perform PostgreSQL archive logs
backup and deletion. The pg_hba.conf configuration file of the PostgreSQL instance must contain a
record with the account.
▪ Select Use guest credentials to use the account specified at the Guest Processing step of the
wizard to access the VM guest OS and connect to the PostgreSQL instance.
▪ Specify another account. To do this, select the necessary account from the drop-down list or
click Ad d and add a new account.
Make sure the specified account has sufficient rights. For details, see the Permissions section of the
Veeam Explorers User Guide.
▪ Select Da tabase user with password file (.pgpass) if you have specified an account with
password-based authentication. In this case, you do not have to specify the account password
when adding the account in Veeam Backup & Replication. Instead, the account password must
be specified in the PGPASS password file stored in the user's home directory.
▪ Select Sy stem user without password (peer) if you have specified a local system account with
peer authentication.
c. To back up PostgreSQL archive logs with Veeam Backup & Replication, select the Ba ck up logs every
< N> minutes check box and specify the frequency for archive log backup. By default, archive logs are
backed up every 15 minutes. The maximum log backup interval is 480 minutes.
d. If you have selected the Ba ckup logs every <N> minutes option, specify retention policy for the
archive logs stored in the backup repository. For the Retain log backups setting, select one of the
following:
▪ Select Until the corresponding image-level backup is deleted to apply the same retention policy
for image-level backups and archived log backups.
▪ Select Keep only last <N> days to keep archive logs for a specific number of days. By default,
archive logs are kept for 15 days. If you select this option, you must make sure that retention for
archive logs is not greater than retention for the image-level backups. For more information, see
the Retention for PostgreSQL WAL Files section of the Veeam Backup & Replication User Guide.
e. In the P ostgreSQL archive logs local temporary storage field, specify a path on the PostgreSQL
machine that Veeam Backup & Replication will use to temporarily store PostgreSQL archive logs until
they are backed up. Veeam Backup & Replication does not create the temporary storage folder so the
folder must exist on the machine. Make sure the temporary location has enough free space for storing
the log files.
NOTE
Using the Veeam Backup & Replication console, you can also specify log shipping servers that you want to
use to transport archive logs. For more information, see the Retention for PostgreSQL WAL Files section of
the Veeam Backup & Replication User Guide.
1. At the Guest Processing step of the wizard, make sure the E na ble application-aware processing check box
is selected.
3. In the displayed window, select a VM from the list and click E d it.
4. On the File Exclusions tab, specify the files that must be excluded from the backup.
o Select E x clude the following files a nd folders to remove individual files and folders from the backup.
o Select Include only the following files and folders to leave only the specified files and folders in the
backup.
To form the list of exclusions or inclusions, you can use full paths to files and folde rs, environmental
variables, and file masks with the asterisk (*) and question mark (?) characters. For more information, see
the VM Guest OS Files section of the Veeam Backup & Replication User Guide.
NOTE
For proper file indexing of Linux machines, Veeam Backup & Replication requires several utilities to be
installed on the machines: mlocate, gzip, and tar. If these utilities are not found, you are prompted to
deploy them to support index creation.
2. In the Guest File System Indexing Options window, select a machine from the list and click E d it.
o To customize settings of a machine added to the job as part of a container, add the machine as a
standalone instance. For that, click Ad d Machine and choose the necessary VM. Next, select the
machine from the list and click E d it to customize VM settings.
o To discard custom settings of a machine, select it from the list and click Remove.
3. In the Ind exing Settings window displayed for the selected machine, go to the W ind ows or Linux tab and
specify what files should be indexed:
o Select Disable indexing if you do not want to index guest OS files of the machine.
o Select Ind ex everything if you want to index all guest OS files inside the machine.
o Select Ind ex everything except folders if you want to index all guest OS files except those defined in
the list. By default, system folders are excluded from indexing. You can add or delete folders to
exclude using the Ad d and Remove buttons.
Guest OS Credentials
If you specify guest OS credentials, Veeam Backup & Replication deploys a runtime process on the VM guest OS
to coordinate guest processing activities. The process runs only during guest processing and is stopped
immediately after the processing is finished.
In the Guest OS credentials section, you can select credentials from the list, or click the Ad d button to add new
credentials.
• For Windows guest OS, specify a user account (name and password) with local administrative rights on
target machine, and optional description. Credentials must be specified in the following format:
• For Linux guest OS, you can choose one of the following options:
o If Management Agent is installed on the VM, you can select the Use management agent option.
o If Management Agent is not installed on the VM, specify a user name, password, and SSH port (by
default, port 22 is used).
If you specify data for a non-root account that does not have root permissions on a Linux server, you
can use the Non-root account section to grant sudo rights to this account.
i. To provide a non-root user with root account privileges, select the E levate specified account to
root check box.
If you do not enable this option, you will have to manually add the user account to the sudoers
file.
iii. If you plan to use the account to connect to Linux servers where the sudo command is not
available or may fail, you have an option to use the su command instead. To enable the su
command, select the Use "su" if "sudo" fails check box and in the Root p assword field, enter the
password for the root account.
Veeam Backup & Replication will first try to use the sudo command. If the attempt fails,
Veeam Backup & Replication will use the su command.
IMP ORTANT
For machine guest OS indexing of Linux-based machines, a user account with root privileges on the
machine is required. It is recommended that you create a separate user account for work with Veeam
Backup & Replication on the Linux-based machine, grant root privileges to this account and specify settings
of this account in the Guest OS credentials section.
It is also recommended to avoid additional commands output for the specified user (like messages echoed
from within ~/.bashrc or command traces before execution), because they may affect Linux machine
processing.
• Private key is stored on the client (user’s) machine — that is, on the machine where Veeam Backup &
Replication runs. The key is usually stored in the encrypted form. To decrypt a private key, you need to
supply a passphrase specified at key creation.
• Public key is stored on the server (Linux machine) in a special authorized_keys file that contains a list
of public keys.
• User name
To customize credentials:
2. Select the necessary machine from the list and click Remove.
NOTE
To customize settings of a machine added as part of a container, the machine should be included in the list
as a standalone instance. For that, click Ad d machine and choose a machine whose settings you want to
customize.
1. Select the Run the job automatically check box. If the check box is not selected, you will need to start the
job manually.
2. Edit the scheduling settings. You can select to run the job daily, monthly, periodically with a specific time
interval, continuously or after a specific job.
3. In the Automatic retry section, define whether Veeam Backup & Replication must attempt to run the
backup job again if the job fails for some reason. During a job retry, Veeam Backup & Replication processes
failed machines only. Enter the number of attempts to run the job and define time intervals between
them. If you select continuous backup, Veeam Backup & Replication will retry the job for the defined
number of times without any time intervals between the job runs.
4. In the Ba ckup window section, edit 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 provide unwanted overhead on the production environment. To set up a backup window for the job:
a. Select the Terminate job if it gets out of a llowed backup window check box and click W indow.
NOTE
If the Location property of the source object and target object do not match, you will receive a warning
message after you click Finish. For example, you may have a backup job targeted at repository located in
Sydney, and source machines located in London.
Schedule Settings
If you have selected to run the job automatically, you can select one of the following options:
• 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.
• 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.
When you configure the job schedule, keep in mind p ossible date and time changes (for example,
related to daylight saving time transition).
• 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. Click Schedule and use the time table
to define the permitted time window for the job. In the Sta rt time within an hour field, specify the exact
time when the job must start.
o Veeam Backup & Replication always starts counting defined intervals from 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.
o If you define permitted hours for the job, after the denied interval is over,
Veeam Backup & Replication will immediately start the job and then run the job 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.
• 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. If you start the first job manually, Veeam Backup Enterprise Manager will
display a notification. You will be able to choose whether to start the chained job as well.
NOTE
You can chain jobs that are processed on the same backup server only.
NOTE
Creating active full backups is unavailable for backup copy jobs, file backup jobs and object storage backup
jobs.
2. Expand the menu commands by clicking Job , then select Active Full .
NOTE
Job cloning is not available for file backup jobs and object storage backup jobs.
Job clone name is created automatically, with the original job name and suffix of the following format:
_clone<n> where <n> is the sequential number of the clone.
Once a job is cloned, you can edit its settings. For details, see Editing Jobs. Note, however, that not all of the
job settings can be changed with the Enterprise Manager web UI. For example, you cannot change the backup
repository and backup proxies used for the job or define advanced job settings.
Configuration details of a created job clone are written to the same database that stores config uration details of
the original job — thus, the job copy is available and can be managed both with the Veeam Backup Enterprise
Manager web UI and the Veeam Backup & Replication console on the backup server that coordinates the job.
The backup file produced by the clone will be located on the same repository as the backup file of the original
job.
If you have backup servers of earlier versions added to Enterprise Manager, the jobs managed by these servers
cannot be deleted using Enterprise Manager.
3. You will be prompted to delete backup files. To delete backup files, select the Delete backup files check
box and click Y es to confirm the operation.
If four-eyes authorization is enabled on the backup server, backup files will remain in the backup
repository and become orphaned.
Users with the Portal Administrator role can view, disable and enable, edit and delete CDP policies. Users with
the Portal User role can only view CDP policies.
For more information on CDP, see the Continuous Data Protection (CDP) section of the
Veeam Backup & Replication User Guide.
• Na me — policy name
• RP O — recovery point objective, that is, how often to create short-term restore points
• Ma x delay — difference between the configured RPO and time required to transfer and save data
To quickly find a CDP policy, you can use filters and the search field.
o Use the Ba ckup server list to view the policies of the selected backup server only.
o Use the Sta tus filter to view the policies with the selected statuses only.
Once you have selected necessary statuses, click the Ap p ly button to apply the filter.
In addition to the information presented in the list of policies, the P olicies tab allows you to view advanced
policy data. To see detailed policy statistics, click the state link in the Sta tus column.
NOTE
You can export displayed information to a file using the E x p ort link on the toolbar. This file then can be
opened on the client machine using the associated application.
• Policy schedule
1. Open the P olicies tab and select the necessary policy from the list.
NOTE
For VMware Cloud Director CDP policies, you cannot add single VMs. You can manage only vApps and other
Cloud Director containers. The scope depends on your Cloud Director access rights.
1. Click Ad d .
If you select a VM container and later add a new VM to the container, Veeam Backup & Replication will
update policy settings automatically to include the VM.
TIP
• Search for objects: type a name or part of a name in the search field. Specify the type of the
object from a scroll list next to the search field.
• Switch between virtual infrastructure views using the buttons in the top right corner: Hosts
a nd Clusters, VMs and Templates, Datastores and VMs and Ta gs and VMs.
2. In the E x clusions window, click Ad d and select machines that you want to exclude.
To change the processing order, select the necessary objects and move them up or down the list using the Up
and Down buttons on the right.
NOTE
• VMs inside a VM container are processed at random. To ensure that VMs are processed in the
defined order, add them as standalone VMs, not as a part of containers.
• The processing order may differ from the order that you have defined. For example, if resources of a
VM that is higher in the priority are not available, and resources of a VM that is lower in the priority
are available, the VM with the lower priority will be processed first.
a. In the Recovery point objective section, specify an RPO in seconds or minutes. You can select the
period from 2 seconds to 60 minutes.
During every specified period, Veeam Backup & Replication will create short-term restore points for
VM replicas and send these restore points to the target destination. Note that short-term restore
points are crash-consistent.
2. To instruct the CDP policy to display a warning or error if a newly created replicated states are not
transferred to the target within the set RPO, click Rep orting. Then specify when the policy must display
errors and warnings.
If you have configured email notification settings, Veeam Backup & Replication will mark the policy with
the Warning or Error status and will also send email notifications.
3. In the Short-term retention section, specify how long you want to store a short-term restore point. The
maximum value is 7 days. Note that the total size of the log files that store incremental changes is a
maximum of 2 TB per VM disk.
4. In the Long -term retention section, configure when to create long-term restore points and for how long
to store them:
a. In the Create additional restore points every field, specify how often you want to create long-term
restore points.
b. In the Keep restore points for field, specify for how long to store these long-term restore points.
To shift the schedule, specify the offset in the Sta rt time within a n hour field. For example, you
schedule creation of crash-consistent restore points from 00:00 to 01:00, and set the offset value to
25. The schedule will be shifted forward, and the crash-consistent restore points will be created from
0:25 and to 01:25.
Application-Aware Processing
If VMs run Microsoft Active Directory, Microsoft SQL Server, Microsoft SharePoint, Microsoft Exchange, or
Oracle, you can enable application-aware processing to create transactionally consistent replicas. The
transactionally consistent replicas guarantee proper recovery of applications without data loss.
3. To define custom settings for a machine in the list, select it and click E d it.
o To customize settings of a machine added as part of a container, add the machine as a standalone
instance. For that, click Ad d machine and choose the necessary VM. Next, select the machine from the
list and click E d it to customize VM settings.
o To discard custom settings of a machine, select the machine in the list and click Remove.
o General Settings
General Settings
On the General tab, you can specify general application-aware processing settings.
1. In the Ap p lications section, select the option that corresponds to your transactionally-consistent backup
creation scenario.
o Select Require successful processing (default option) if you want Veeam Backup & Replication to stop
the CDP replication if an error occurs.
o Select Try application processing, but ignore failures if you want to continue the CDP replication even
if an error occurs. This option guarantees the CDP policy will continue working. The created replica
will not be transactionally consistent, but rather crash consistent.
o Select Disable application processing if you do not want to enable application-aware processing for
the VM. This option makes the Tra nsaction Logs P rocessing section unavailable.
2. [For Microsoft Exchange, Microsoft SQL Server, and Oracle] In the Microsoft VSS section, specify whether
this CDP policy should process transaction logs or create copy-only replicas.
o Select P rocess transaction logs with this job if you want Veeam Backup & Replication to process
transaction logs.
[For Microsoft Exchange] Transaction logs will be truncated after the CDP policy creates a long-term
restore point. If the creation fails, the logs will remain untouched until the next start of the long -term
restore point creation.
[For Microsoft SQL Server, Oracle] Specify settings for transaction log handling:
▪ For Oracle database archived logs processing — on the Ora cle tab. For more information, see
Oracle Archived Log Settings.
o Select P erform copy only if you use another replication tool to perform guest level replication, and
this tool maintains consistency of the database state. Veeam Backup & Replication will create a copy-
only replica for the selected VM. The copy-only replica preserves the chain of full and differential
backup files and transaction logs on the VM. For more information, see Microsoft Docs.
With this option selected, the SQL, Oracle and P ostgreSQL tabs are not available.
3. In the P ersistent guest agent section, specify if Veeam Backup & Replication must use persistent guest
agents on the VM for application-aware processing.
1. At the Guest Processing step of the wizard, make sure the E na ble application-aware processing check box
is selected.
3. In the displayed window, select the Microsoft SQL Server VM from the list and click E d it.
4. On the General tab of the VM P rocessing Settings window, make sure the following options are selected:
o In the Ap p lications section, either the Require successful processing or Try application processing, but
ig nore failures option must be selected.
6. Specify how Veeam Backup & Replication will process Microsoft SQL Server transaction logs.
o Select Truncate logs to truncate transaction logs after the CDP policy creates a long -term restore
point.
In this case, transaction logs will be truncated after the CDP policy creates a long -term restore point.
If the creation fails, the logs will remain untouched until the next start of the long-term restore point
creation.
This option is recommended if you use another tool to perform VM guest-level replication, and this
tool maintains consistency of the database state.
1. At the Guest Processing step of the wizard, make sure the E na ble application-aware processing check box
is selected.
3. In the displayed window, select the Oracle VM from the list and click E d it.
o In the Ap p lications section, either the Require successful processing or Try application processing, but
ig nore failures option must be selected.
o In the Tra nsaction logs processing section, the P rocess transaction logs with this job option must be
selected.
5. On the Ora cle tab of the VM P rocessing Settings window, specify log processing settings.
▪ Select Use guest credentials to use the account specified at the Guest Processing step of the
wizard to access the VM guest OS and connect to the Oracle database.
▪ Specify another account. To do this, select the necessary account from the drop -down list or
click Ad d and add a new account.
Make sure the specified account has sufficient rights. For details, see the Permissions section of the
Veeam Explorers User Guide.
▪ Select Do not d elete archived logs to preserve archived redo logs on the original Oracle server.
Select this option for databases in the NOARCHIVELOG mode. If the database is in the
ARCHIVELOG mode, archived logs on the VM guest OS may grow large and consume all disk
space. In this case, database administrators must take care of archived logs themselves.
▪ Select Delete logs older than < N> hours / Delete logs over <N> GB to delete archived logs that
are older than <N> hours or larger than <N> GB. The log size threshold refers not to the total
size of all logs for all databases, but to the log size of each database on the selected Oracle VM.
Transaction logs will be deleted using Oracle Call Interface after the CDP policy creates a long -term
restore point. If the creation fails, the logs will remain untouched until the next start of the long -term
restore point creation.
If you have Management Agent installed on a Linux VM, you have an option to use it for coordinating guest
processing activities. In this case, guest OS credentials are not stored in the configuration database, which
makes using Management Agent a more secure option. For more information, see the Persistent Agent
Components section of the Veeam Backup & Replication User Guide.
In the Guest OS credentials section, you can select credentials from the list, or click the Ad d button to add new
credentials.
• For Windows guest OS, specify a user account (name and password) with local administrative rights on
target machine, and optional description. Credentials must be specified in the following format:
• For Linux guest OS, you can choose one of the following options:
o If Management Agent is installed on the VM, you can select the Use management agent option.
o If Management Agent is not installed on the VM, specify a user name, password, and SSH port (by
default, port 22 is used).
If you specify data for a non-root account that does not have root permissions on a Linux server, you
can use the Non-root account section to grant sudo rights to this account.
ii. To add the user account to the sudoers file, select the Ad d account to the sudoers file
a utomatically check box. In the Root p assword field, enter the password for the root account.
If you do not enable this option, you will have to manually add the user account to the sudoers
file.
iii. If you plan to use the account to connect to Linux servers where the sudo command is not
available or may fail, you have an option to use the su command instead. To enable the su
command, select the Use "su" if "sudo" fails check box and in the Root p assword field, enter the
password for the root account.
Veeam Backup & Replication will first try to use the sudo command. If the attempt fails,
Veeam Backup & Replication will use the su command.
IMP ORTANT
For machine guest OS indexing of Linux-based machines, a user account with root privileges on the
machine is required. It is recommended that you create a separate user account for work with Veeam
Backup & Replication on the Linux-based machine, grant root privileges to this account and specify settings
of this account in the Guest OS credentials section.
It is also recommended to avoid additional commands output for the specified user (like messages echoed
from within ~/.bashrc or command traces before execution), because they may affect Linux machine
processing.
• Private key is stored on the client (user’s) machine — that is, on the machine where Veeam Backup &
Replication runs. The key is usually stored in the encrypted form. To decrypt a private key, you need to
supply a passphrase specified at key creation.
If you plan to use Linux private key for authentication, make sure you have created private and public keys and
stored them appropriately: private key on the client side (Veeam backup server) and public key on the server
side (Linux machine). You should also have the passphrase for the private key if it is encrypted. If you select to
use Linux private key credentials, you should specify the following:
• User name
2. Select the necessary machine from the list and click Set User.
2. Select the necessary machine from the list and click Remove.
NOTE
To customize settings of a machine added as part of a container, the machine should be included in the list
as a standalone instance. For that, click Ad d machine and choose a machine whose settings you want to
customize.
To delete a policy:
• Delete backups
NOTE
• In the Enterprise Plus edition of Veeam Backup & Replication, users with the Portal Administrator
role can customize the restore scope of other users (list of objects the user can recover). In other
editions, the restore scope includes all objects and cannot be customized. However, you can
delegate recovery of an entire file share, object storage or selected file type. Possible delegation
options are described in the Configuring Permissions for File and Application Item Restore section.
• Veeam Backup Enterprise Manager does not display objects from the unstructured data to tape
backups.
Each entry in the unstructured data list contains the following information:
• Location — name of the backup repository where the restore points a re stored
To quickly find a data source (file share or object storage), you can filter the list of data sources by backup
server or data source.
• To filter data sources by backup server name, from the Ba ckup server list, select the necessary backup
server. Veeam Backup Enterprise Manager will display backups of only those file data sources that are
processed by the selected backup server.
The Ba ckup server filter is only available for users with the Portal Administrator or Portal User role.
• To filter data sources by source name, enter the name or a part of the name in the search field. Veeam
Backup Enterprise Manager will display backups of only those data sources whose names match the text
that you entered.
NOTE
To export displayed information to a file, use the E x port link on the toolbar.
• To see detailed information about a data source, click its name in the Da ta Source column.
• To see detailed information about restore points, click a link in the Restore Points column.
1. On the Unstructured Data tab, select a data source and click Restore.
Alternatively, on the Files tab, in the Sea rch backups of field, enter the name of a data source whose items
you want to browse or click the P ick from List link and select a data source in the Select Object window.
Then click Mount.
2. Wait while Veeam Backup & Replication mounts the content from backup to a backup server. When the
process is completed, Veeam Backup Enterprise Manager displays the content of the data source.
3. You can browse files contained in all restore points created by the backup job or in a specific restore poi nt.
o By default, the All restore points option is selected. With this option selected, you can browse the
content in all restore points created by the backup job.
For each object in the backup, Enterprise Manager displays the number of object versions and the
date when the latest version was created. If an object has more than one version, you can select a
necessary version during the restore process. For more information, see Restoring Specific Files.
For each file in the backup, Enterprise Manager displays file size and the date when the file version is
created. Enterprise Manager displays only the file version contained in the selected restore point. For
more information on file restore, see Restoring Specific Files.
TIP
You can use the search field at the top of the working area to search for specific files and folders.
Depending on the number of files in the file share, the search process may take some time. For more
information, see Searching for Items in Unstructured Data Backups.
IMP ORTANT
When you back up unstructured data, file system indexing is not created. Therefore, advanced search
capabilities using filters are not available.
1. On the Unstructured Data tab, select a data source and click Restore.
Alternatively, on the Files tab, in the Sea rch backups of field, enter the name of a data source whose items
you want to browse or click the P ick from List link and select a data source in the Select Object window.
Then click Mount.
2. In the Sea rch backups of field, enter the name of a data source whose items you want to restore or click
the P ick from List link and select the necessary data source in the Select Object window.
3. In the search field, enter the name of the necessary item or a part of it.
• Instant file share recovery allows you to recover a point-in-time file share state.
• Restore of files and folders allows you to restore specific items located on a file share or object storage.
For NFS file shares, you can use the feature to publish a point-in-time file share state as a read-only SMB
file share. This lets you instantly access all recovered files.
After you have performed instant file share recovery, you have to finalize it. For more information, see Finalizing
Instant File Share Recovery.
To perform instant file share recovery, use the Instant File Share Recovery wizard.
1. Open the Unstructured Data tab and select a file share from the list.
Alternatively, you can right-click a file share and select Instant Recovery.
1. Configure access permissions for the file share. The following options are available:
o Allow to everyone
o Deny to everyone
If you select this option, configure accounts and groups to which you want to grant permissions for
accessing the file share:
i. Next to the Allow to the following accounts or groups only option, click Choose.
ii. In the Accounts and Groups window, click Ad d to add an account or group.
iv. Add other accounts or groups if necessary. Use the Remove button to remove an account or
group.
2. In the Set owner account field, specify the owner account for the file share.
• [For NFS file shares] When you perform instant recovery of an NFS file share, the file share is published as
a read-only SMB file share that lets you instantly access all recovered files. After you finish working with
the files, you must stop publishing the recovered file share.
• [For SMB file shares] When you perform instant recovery of an SMB file share, the published file share is
available for reading and writing. After you finish working with the files, you must stop publishing the
recovered file share or migrate it to the production environment.
To migrate a recovered file share, use the Mig rate to Production wizard.
4. Configure switchover.
1. Open the Instant Recovery tab and select a file share from the list.
Alternatively, you can right-click a file share and select Mig rate to Production.
At the Destination step of the wizard, specify the location to which you want to restore the file share.
• Select Orig inal location to restore data to the location where the file share resided originally. This type of
restore is only possible if the original device is connected to Veeam Backup & Replication and powered on.
a. From the This server drop-down list, select a file share to which the data must be restored.
You can select any file share added to the backup inventory. If the required file share is missing in the
drop-down list, add a new file share to the backup server infrastructure. For more information on how
to add a new file share, see the Adding File Share section of the Veeam Backup & Replication User
Guide.
b. In the P a th to file field, specify a path to the folder on the selected file share where the file s must be
restored.
At the Restore Options step of the wizard, specify overwrite options in case the file with the same name already
exists in the target folder.
• Restore anyway
Select this option if you want to overwrite the existing file with the restored file in all cases.
At the Switchover step of the wizard, select a type of the switchover from the mounted file share to the
migrated file share.
• Automatic — select this option if you want Veeam Backup & Replication to perform the switch
automatically right after the entire file share will be restored.
• Ma nual — select this option if you want to perform the switch manually.
• Scheduled — select this option if you want Veeam Backup & Replication to perform the switchover at a
specified date and time.
At the Summary step of the wizard, review the migration settings and click Finish. Veeam Backup & Replication
will migrate the recovered file share to the specified location.
1. Open the Instant Recovery tab and select a file share from the list.
To change the time when Veeam Backup & Replication will switch from the mounted file share to the production
file share, do the following:
1. Open the Instant Recovery tab and select the necessary file share from the list.
3. At the Switchover step of the E d it Switchover wizard, select a type of the switchover from the mounted to
the migrated file share.
o Automatic — select this option if you want Veeam Backup & Replication to perform the switch
automatically right after the entire file share will be restored.
o Ma nual — select this option if you want to perform the switch manually.
o Scheduled — select this option if you want Veeam Backup & Replication to perform the switchover at
a specified date and time.
1. Open the Unstructured Data tab and select a file share from the list.
Alternatively, you can right-click a file share and select Stop Publishing.
Restore operations are only available to authorized users according to their security settings. Users with the
Portal Administrator role can both restore files to the original location or download them to the local machine.
For users with the non-administrative roles, you can configure additional restriction settings. For example, you
can prohibit restore operators to download files to the local machine so that they will be able to restore files to
the original location only. Additionally, you can specify the types of files that can be restored by operators (this
can be helpful if you want to limit operators’ access to sensitive data). For details, see Configuring Permissions
for File and Application Item Restore.
1. Locate the necessary file using browse or search possibilities of Veeam Backup Enterprise Manager. For
details, see Viewing Unstructured Data Backups and Browsing for Items in Unstructured Data Backups.
You can select multiple files in file shares. Selection of multiple object storage items is not available.
o If you select Overwrite, the item from the backup will replace the original item in the data source.
o If you select Keep, the item from the backup will be restored next to the original item in the data
source. The restored item will have the _RESTORED_<date>_<time> suffix in its file name.
Veeam Backup Enterprise Manager will start the restore operation and display the progress a nd result of the
operation in the File Restore History view.
Downloading Files
If you choose to download a file, Veeam Backup Enterprise Manager interacts with the backup server to extract
the necessary file from the backup. The user who initiated the restore will be able to download the file to the
local machine, that is, the Enterprise Manager server.
1. Locate the necessary file using browse or search possibilities of Enterprise Manager. For details, see
Viewing Unstructured Data Backups and Browsing for Items in Unstructured Data Backups.
3. If you browse items in all restore points created for the data source, and the restore points contain
multiple versions of the item, Enterprise Manager will prompt you to select the item version. In the Select
version window, select the restore point that contains the necessary item version and click OK.
5. Wait for restore session to complete and the item to be retrieved from the backup.
7. On the Log tab of the File Restore History view, click the d ownload link in the Restored files are available
for download record of the session log.
The file is saved to the default download folder on your local machine.
1. Locate the necessary file using browse or search possibilities of Veeam Backup Enterprise Manager. For
details, see Viewing Unstructured Data Backups and Browsing for Items in Unstructured Data Backups.
3. If you browse items in all restore points created for the data source, and the restore points contain
multiple versions of the item, Enterprise Manager will prompt you to select the item version. In the Select
version window, select the restore point that contains the necessary item version and click OK.
NOTE
You cannot add multiple versions of the same file to the restore list using the Select version window. If you
want to restore multiple versions of a file, browse to this file in a specific restore point and add this file to
the restore list.
2. In the P ending Restore window, select check boxes next to the files that you want to restore. Use the
check box next to the header of the Na me column to select all files in the list at once.
If you want to remove a file from the restore list, select the file and click Delete.
3. Click the Restore or Download link to perform the necessary restore operation for the selected files.
5. [For the download operation] Wait for restore session to complete. On the Log tab of the File Restore
History view, click the d ownload link.
The files are saved to the default download folder on your local machine.
Multiple files are also saved in a ZIP file named FLR_<date>_<time>.zip in the
%ProgramData%\Veeam\Backup\WebRestore folder. Veeam Backup Enterprise Manager cleans up the
folder periodically. Files older than 24 hours are automatically deleted. To change the default storage
folder, contact Veeam Customer Support.
TIP
Veeam Backup Enterprise Manager keeps links for downloaded files in the history for one day. To
download a file that was previously restored:
If four-eyes authorization is enabled on the backup server, backup files will remain in the backup repository and
become orphaned.
2. In the list of backups, select the necessary backup and click Delete.
To locate the necessary backup, you can filter backups by backup server name or search by data source
name.
NOTE
If several data sources are processed by the same backup job, deletion of the selected data source backup
will not affect other data sources in the job.
With Veeam Backup Enterprise Manager, you can perform the following operations with machines:
• Run failover plans for VMware vSphere and Microsoft Hyper-V VMs
NOTE
Veeam Backup Enterprise Manager does not display Nutanix AHV VMs, and recovery of Nutanix AHV VMs is
not available. However, you can browse and restore guest OS files of Nutanix AHV VMs. For more
information, see Guest OS File Restore.
NOTE
Veeam Backup Enterprise Manager does not display Nutanix AHV VMs, and recovery of Nutanix AHV VMs is
not available. However, you can browse and restore guest OS files of Nutanix AHV VMs. For more
information, see Guest OS File Restore.
• Machine name
• Job name
You can filter machines in the list by a backup server or search for specific machines by a machine name. To
search for a machine, enter its name or part of the name in the Search field.
NOTE
You can export displayed information to a file using the E x p ort link on the toolbar. This file then can be
opened on the client machine using the associated application.
• To check a report containing a list of job runs for a specific machine, click the machine name in the
Ma chine column.
Note, you cannot open a report for machines processed by backup copy jobs and machines from imported
or orphaned backups.
• To open a list of machine restore points, click a link in the Restore P oints column.
• If four-eyes authorization is enabled on the backup server, you cannot delete a machine from backup using
Enterprise Manager.
• If multiple machines are processed by the same backup job, deletion of a machine will not af fect other
machines in the job.
• The delete operation is not available for replica machines, storage snapshots and machines backed up to
tape.
Deleting Machine
To delete a machine from a backup, do the following:
1. On the Ma chines tab, select the necessary machine backup from the list of machines.
To quickly find a machine, you can filter machines in the list by a backup server or search for specific
machines by machine name.
2. Click Delete.
3. To remove backups marked with weekly, monthly and yearly GFS flags, select the Remove GFS full
b a ckups check box.
• The machine (physical or virtual) must be processed by a regular backup job or Veeam Agent backup job
managed by the backup server.
Quick backup is not available for VMware Cloud Director VMs processed with VMware Cloud Director jobs.
• A backup job processing the machine must exist on the backup server.
• A full backup file for the machine must exist in the backup repository.
• You cannot perform quick backup for multiple machines simultaneously if the machines are proce ssed by
the same backup job.
Alternatively, you can right-click the machine and select Quick Backup.
To view the details of the quick backup operation, open the session of the backup job that processes the
selected machine.
1. On Job s tab, select the backup job that processes the machine.
With Veeam Backup Enterprise Manager, you can perform the following types of recovery:
• Instant Recovery
• Entire VM Restore
• VM Failover
• Failover Plans
Veeam Backup Enterprise Manager supports the following scenarios of Instant Recovery:
Using the Veeam Backup & Replication console, you can instantly recover VMware vSphere VMs to Microsoft
Hyper-V and instantly recover Microsoft Hyper-V VMs to VMware vSphere. For more information, see the VM
Recovery section of the Veeam Backup & Replication User Guide.
IMP ORTANT
Instant Recovery is available in the Enterprise and Enterprise Plus editions of Veeam Backup & Replication.
• Backups of VMware vSphere virtual machines created by Veeam Backup & Replication
• Backups of VMware Cloud Director virtual machines created by Veeam Backup & Replication
• Backups of Microsoft Hyper-V virtual machines created by Veeam Backup & Replication
For more information on Instant Recovery, see the Instant Recovery to VMware vSphere section of the Veeam
Backup & Replication User Guide.
1. On the Ma chines tab, select the necessary VMware vSphere VM from the list.
At the Restore P oints step of the wizard, select a VM restore point from which you want to perform instant
recovery.
At the Restore mode step, select a recovery mode for the VM and choose whether you want to recover VM tags.
o Select Restore to the original location to recover the VM with initial settings to the original location. If
this option is selected, you will pass directly to the Summary step of the wizard.
IMP ORTANT
If you recover a VM with initial settings, and the original VM still exists in the virtual
infrastructure, the original VM will be removed.
o Select Restore to a new location or with different settings to recover the VM to a new location, or to
any location but with different settings. If this option is selected, the Instant Recovery wizard will
include additional steps for customizing VM settings.
2. If you want to recover tags that were assigned to the original VM and assign them to the recovered VM,
select the Restore VM tags check box. Veeam Backup & Replication will recover the VM with original tags
if the following conditions are met:
The Destination step of the wizard is available if you recover a VM to a new location or with different settings.
At this step of the wizard, you configure destination settings such as the recovered VM name, target host, VM
folder and so on.
1. In the Restored VM name field, specify a name under which the workload will be recovered.
3. In the VM folder field, specify a folder to which the recovered VM files will be placed.
4. In the Resource p ool field, specify a resource pool to which the VM will be placed.
5. Choose whether to preserve the BIOS UUID or generate a new BIOS UUID.
If the original workload still resides in the production environment, select the Generate new BIOS UUID
option to prevent conflicts. The BIOS UUID change is not required if the original VM no longer exists, for
example, if it was deleted.
The Da tastore step of the wizard is available if you recover a VM to a new location or with different settings.
At this step of the wizard, you can select where to store redo logs when a VM is running from the backup. Redo
logs are auxiliary files used to keep changes that take place while the recovered VM runs.
By default, redo logs are stored in vPower NFS datastore. You can store redo logs in any datastore in the virtual
environment if necessary. Redirecting redo logs improves recovery performance but makes Storage vMotion not
possible for ESXi 5.5. As soon as a recovery verification job completes, Veeam Backup & Replication deletes redo
logs. For more information on vPower NFS datastore, see the vPower NFS Service section of the
Veeam Backup & Replication User Guide.
At the Summary step of the wizard, specify additional settings for Instant Recovery:
1. If you recover a VM that have failed and want to recover them with initial network settings, select the
Connect VM to network check box.
If you recover a VM for testing disaster recovery while the original VM is still running, leave this check box
unselected. Before you power on the recovered VM, you must disconnect it from the production network
and connect to a non-production network to avoid conflicts.
2. To start the VM right after recovery, select the P ower on target VM after restoring check box. If you
recover the workloads to the production network, make sure that the original VM is powered off.
3. Review the settings that you have specified for Instant Recovery and click Finish.
To view the Instant Recovery progress, on the Ma chines tab, click History.
Testing Recovered VM
To test a recovered VM before you migrate it to production, you can launch the VMware Remote Console
software from the Veeam Backup & Replication console. For more information, see the Finalizing Instant
Recovery to VMware vSphere section of the Veeam Backup & Replication User Guide.
Migrating Recovered VM
If a VM is recovered successfully, you can migrate it to the production environment.
1. Open the Instant Recovery tab and select the necessary VMware vSphere VM from the list.
3. At the Destination step of the VMware Cloud Director Quick Migration wizard, specify destination where
you want to migrate the VM to.
a. Click Choose next to the Host field and select an ESXi host or cluster where the relocated VM must be
registered.
b. Click Choose next to the VM folder field and select the target VM folder.
c. Click Choose next to the Resource pool field and select the target resource pool.
d. Click Choose next to the Da tastore field and select the target datastore.
If you want to change the target datastore for the VM configuration files or disk files, do the
following:
i. Select the P ick datastore for selected virtual disks check box.
ii. Select the configuration files or one of the hard disks and click Cha nge datastore.
Unpublishing Recovered VM
If your tests have failed, you can stop publishing the recovered VM. This will remove the recovered VM from the
host that you selected as the destination for recovery. Note that all changes made in the recovered VMs will be
lost.
1. Open the Instant Recovery tab and select the necessary VMware vSphere VM from the list.
For more information on Instant Recovery, see the Performing Instant Recovery to Cloud Director vApp section
of the Veeam Backup & Replication User Guide.
To launch the Instant Recovery to VMware Cloud Director wizard, do the following:
1. On the Ma chines tab, select the necessary VMware Cloud Director VM from the list.
At the Restore P oints step of the wizard, select a VM restore point from which you want to perform instant
recovery.
At the Restore mode step, select a recovery mode for the VM and choose whether you want to recover VM tags.
o Select Restore to the original location to recover the VM with initial settings and to the original
location. If this option is selected, you will pass directly to the Summary step of the wizard.
IMP ORTANT
If you recover a VM with initial settings, and the original VM still exists in the virtual
infrastructure, the original VM will be removed.
o Select Restore to a new location or with different settings to recover the VM to a new location, or to
any location but with different settings. If this option is selected, the Instant Recovery wizard will
include additional steps for customizing VM settings.
2. If you want to recover tags that were assigned to the original VM and assign them to the recovered VM,
select the Restore VM tags check box. Veeam Backup & Replication will recover the VM with original tags
if the following conditions are met:
The Destination step of the wizard is available if you recover a VM to a new location or with different settings.
At this step of the wizard, you configure destination settings such as the recovered VM name and target vApp.
1. In the vAp p field, specify a vApp to which the VM must be recovered. By default, the original vApp is
specified.
2. In the Restored VM name field, specify a name under which the VM will be recovered. By default, the
original name of the VM is used. If you are restoring the VM to the same vApp where the original VM is
registered and the original VM still resides there, change the VM name to avoid conflicts.
The Da tastore step of the wizard is available if you recover a VM to a new location or with different settings.
At this step of the wizard, you can select where to store redo logs when a VM is running from the backup. Redo
logs are auxiliary files used to keep changes that take place while the recovered VM runs.
By default, redo logs are stored in vPower NFS datastore. You can store redo logs in any datastore in the virtual
environment if necessary. For more information on vPower NFS datastore, see the vPower NFS Service section
of the Veeam Backup & Replication User Guide.
2. Click Choose and select a datastore. You can select only a datastore that is available in the organization
VDC hosting the vApp to which the VM is restored.
The Network step of the wizard is available if you restore a VM to a new location or with different settings.
At this step of the wizard, you can map a network in the original site to the network in the target site. During
the restore process, Veeam Backup & Replication will update VM configuration files to replace the original
networks with the specified networks in the target site. As a result, you will not have to re -configure network
settings manually.
i. Click Network.
ii. In the Select Network window, select a necessary network and click OK.
At the Summary step of the wizard, specify additional settings for Instant Recovery:
1. To start the VM right after recovery, select the P ower on target VM after restoring check box. If you
recover the workloads to the production network, make sure that the original VM is powered off.
2. Review settings that you have specified for Instant Recovery and click Finish.
To view the Instant Recovery progress, on the Ma chines tab, click History.
Until you finalize instant recovery of all recovered VMs, a notification about running ins tant recovery sessions is
displayed on the Da shboard tab.
Migrating Recovered VM
If a VM is recovered successfully, you can migrate it to the production environment.
1. Open the Instant Recovery tab and select the necessary VMware Cloud Director VM from the list.
Unpublishing Recovered VM
If your tests have failed, you can stop publishing the recovered VM. This will remove the recovered VM from the
host that you selected as the destination for recovery. Note that all changes made in the recovered VMs will be
lost.
1. Open the Instant Recovery tab and select the necessary VMware Cloud Director VM from the list.
For more information on Instant Recovery, see the Instant Recovery to Microsoft Hyper-V of the Veeam Backup
& Replication User Guide.
1. On the Ma chines tab, select the necessary Hyper-V VM from the list.
At the Restore P oints step of the wizard, select a VM restore point from which you want to perform instant
recovery.
At the Restore mode step, select a recovery mode for the VM.
• Select Restore to the original location to recover the VM with initial settings to the original location. If this
option is selected, you will pass directly to the Summary step of the wizard.
IMP ORTANT
If you recover a VM with the original settings, and the original VM still exists in the virtual
infrastructure, the original VM will be removed.
• Select Restore to a new location or with different settings to recover the VM to a new location, or to any
location but with different settings. If this option is selected, the Instant Recovery wizard will include
additional steps for customizing VM settings.
The Destination step of the wizard is available if you recover a VM to a new location or with different settings.
1. In the Restored VM name field, specify a name under which the workload will be recovered.
3. If the specified host is a node of a Hyper-V failover cluster, you can register the recovered VM as a cluster
resource by selecting the Reg ister VM as a cluster resource check box. If the target host is brought offline
or fails for any reason, the VM will fail over to another node in the cluster.
The check box is not displayed if the host is not a cluster node.
o Select P reserve virtual machine ID if the original VM no longer exists, for example, if it was deleted. In
this case, it is not required to change the ID.
o Select Generate new virtual machine ID If the original workload still resides in the production
environment. This will prevent conflicts.
The Da tastore step of the wizard is available if you recover a VM to a new location or with different settings.
At this step of the wizard, you can change default paths where VM configuration files and disk files will be
stored.
1. Select the configuration files or one of the disk files and click E d it Path.
2. Type in a path to the folder where the files will be stored. You can specify an existing folder, a new folder
or an SMB3 shared folder. SMB3 shared folder path must be in the UNC format, for example:
\\[Link]\Share01.
The host or cluster on which you register VMs must have access to the specified SMB3 shared folder. If
you are using SCVMM 2012 or later, the server hosting the Microsoft SMB3 shared folder must be
registered in SCVMM as a storage device. For more information, see Microsoft Docs.
The Network step of the wizard is available if you restore a VM to a new location or with different settings.
At this step of the wizard, you can map a network in the original site to the network in the target site. During
the restore process, Veeam Backup & Replication will update VM configuration files to replace the original
networks with the specified networks in the target site. As a result, you will not have to re -configure network
settings manually.
i. Click Network.
ii. In the Select Network window, select a necessary network and click OK.
1. To start the VM right after recovery, select the P ower on target VM after restoring check box. If you
recover the workloads to the production network, make sure that the original VM is powered off.
2. Review settings that you have specified for instant recovery and click Finish.
To view the Instant Recovery progress, on the Ma chines tab, click History.
Until you finalize instant recovery of all recovered VMs, a notification about running instant recovery sessions is
displayed on the Da shboard tab.
Migrating Recovered VM
When Veeam Backup & Replication migrates VMs, it transfers VM disks data to the production storage that you
have selected as a destination for the recovered VMs.
NOTE
After the migration is finished, the original VM still remains if the destination differs from the original
location. If you do not need the VM, you have to manually remove it using the Hyper-V client.
1. Open the Instant Recovery tab and select the necessary Hyper-V VM from the list.
Unpublishing Recovered VM
If you have ensured that the VM is working and you do not need it anymore, or your tests have failed, you can
stop publishing the recovered VM. This will remove the recovered VM from the storage that you selected as the
destination for recovery. Note that all changes made in the recovered VM will be lost.
IMP ORTANT
If the destination is the original location, both the original and recovered VMs are removed.
1. Open the Instant Recovery tab and select the necessary Hyper-V VM from the list.
Veeam Backup Enterprise Manager supports the following scenarios of entire VM restore:
• Veeam Backup Enterprise Manager does not support entire VM Restore from storage snapshots, Veeam
Agent backups and backups created with Veeam Plug -ins for Enterprise Applications.
For more information on entire VM restore of VMware vSphere VMs, see the Entire VM Restore section of the
Veeam Backup & Replication User Guide.
1. Open the Ma chines tab and select the necessary VMware vSphere VM from the list.
When you perform entire VM restore using Veeam Backup Enterprise Manager, Veeam Backup & Replication
automatically selects a backup proxy over which VM data must be transported to the source datastore. You can
select a backup proxy manually from the E ntire VM Restore wizard in the Veeam Backup & Replication console.
For more information, see the Select Restore Mode section of the Veeam Backup & Replication User Guide.
o Restore to the original location — select this option to restore the VM with initial settings and to the
original location. If this option is selected, you will pass directly to the Summary step of the wizard.
During restore to the original location, Veeam Backup & Replication restores only those disks that are
included in the backup file. This means that after the restore finishes, you do not have to update
existing jobs which process the original VMs.
o Restore to a new location, or with different settings — select this option to restore the VM to a new
location, or to any location but with different settings. If this option is selected, the E ntire VM Restore
wizard will include additional steps for customizing VM settings.
During restore to a new location, Veeam Backup & Replication creates new VMs. If you want to
process the restored VMs, you must edit existing jobs or create new jobs to process the restored VMs.
If you restore VMs with the same name and to the same folder as the original VMs, Veeam Backup &
Replication deletes the original VMs. In this case, you must edit existing jobs to exclude original VMs
from them.
NOTE
If you need to run an executable script for the VM before restoring it to the production environment,
you can use the Veeam Backup & Replication console to perform entire VM restore in the Staged
restore mode. For more information, see the Select Restore Mode section of the
Veeam Backup & Replication User Guide.
2. If you want to restore tags that were assigned to the original VM and assign them to the recove red VM,
select the Restore VM tags check box. Veeam Backup & Replication will restore the VM with original tags
if the following conditions are met:
3. [For VM restore to the original location] Select the Quick rollback check box to perform incremental
restore for the VM. Veeam Backup & Replication will query Changed Block Tracking to get data blocks that
are required to revert the VM to the restore point, and will restore only these data blocks. Quick rollback
significantly reduces the restore time and has little impact on the production environment.
Enable this option if you restore a VM after a problem that occurred at the level of the VM guest OS: for
example, there has been an application error or a user has accidentally deleted a file on the VM guest OS.
Do not enable this option if the problem has occurred at the VM hardware level, storage level or due to a
power loss.
At this step of the wizard, you configure destination settings such as a name of the restored VM, target host, VM
folder and resource pool.
1. In the Restored VM name field, specify a name under which the workload will be restored.
3. In the VM folder field, specify a folder to which the recovered VM files will be placed.
4. In the Resource p ool field, specify a resource pool to which the VM will be placed.
At this step of the wizard, you can specify target datastore for VM configuration files and VM disk files, as well
as change the disk type (provisioning policy) for the recovered VM. By default, Veeam Backup & Replication uses
the datastore and disk type settings of the original VM. You can place an entire VM to a particular datastore or
choose to store configuration files and disk files of the restored VM in different locations.
1. To change the target datastore for VM configuration files or disk files, do the following:
a. Select the configuration files or one of the hard disks and click Da tastore.
b. In the Select Datastore window, choose the necessary datastore and click OK.
2. By default, hard disks of the restored VM have the same type as disks of the original VM. To change the
disk type, do the following:
b. In the Restored VM Disk Type window, select a disk format and click OK. For more information about
disk formats, see the Virtual Disk Options section of the VMware vSphere documentation.
NOTE
You can only change disk format for VMs with Virtual Hardware version 7 or later.
At this step of the wizard, you can map a network in the original site to the network in the target site. During
the restore process, Veeam Backup & Replication will update VM configuration files to replace the original
networks with the specified networks in the target site. As a result, you will not have to re-configure network
settings manually.
i. Click Network.
ii. In the Select Network window, select a necessary network and click OK.
For more information on entire VM restore of VMware Cloud Director VMs, see the Restoring VMs to Cloud
Director vApp section of the Veeam Backup & Replication User Guide.
1. Open the Ma chines tab and select the necessary VMware Cloud Director VM from the list.
When you perform entire VM restore using Veeam Backup Enterprise Manager, Veeam Backup & Replication
automatically selects a backup proxy over which VM data must be transported to the source datastore. You can
select a backup proxy manually from the E ntire VM Restore wizard in the Veeam Backup & Replication console.
For more information, see the Select Restore Mode section of the Veeam Backup & Replication User Guide.
o Restore to the original location — select this option to restore the VM with initial settings and to the
original location. If this option is selected, you will pass directly to the Summary step of the wizard.
During restore to the original location, Veeam Backup & Replication restores only those disks that are
included in the backup file. This means that after the restore finishes, you do not have to update
existing jobs which process the original VMs.
o Restore to a new location or with different settings — select this option to restore the VM to a new
location, or to any location but with different settings. If this option is selected, the E ntire VM Restore
wizard will include additional steps for customizing VM settings.
During restore to a new location, Veeam Backup & Replication creates new VMs. If you want to
process the restored VMs, you must edit existing jobs or create new jobs to process the restored VMs.
If you restore VMs with the same name and to the same folder as the original VMs, Veeam Backup &
Replication deletes the original VMs. In this case, you must edit existing jobs to exclude original VMs
from them.
2. If you want to restore tags that were assigned to the original VM and assign them to the recovered VM,
select the Restore VM tags check box. Veeam Backup & Replication will restore the VM with original tags
if the following conditions are met:
At this step of the wizard, you configure destination settings such as a name of the restore d VM, target host, VM
folder and resource pool.
1. In the vAp p field, specify a vApp to which the VM must be restored. By default, the original vApp is
specified. To change the vApp, click Choose.
2. In the Restored VM name field, specify a name under which the VM will be recovered. By default, the
original name of the VM is used. If you are restoring the VM to the same vApp where the original VM is
registered and the original VM still resides there, change the VM name to avoid conflicts.
At this step of the wizard, you can map a network in the original site to the network in the target site. During
the restore process, Veeam Backup & Replication will update VM configuration files to replace the original
networks with the specified networks in the target site. As a result, you will not have to re -configure network
settings manually.
i. Click Network.
ii. In the Select Network window, select a necessary network and click OK.
At this step of the wizard, you can configure fast provisioning for the restored VM.
• To specify a fast provisioning template for the VM, select the VM in the list, click Temp lates, and choose a
template to which the restored VM must be linked.
• To disable fast provisioning for the VM and restore it as a regular VM, select the VM in the list and click
Disable.
At this step of the wizard, you can specify a storage policy and datastore for the restored VM.
b. In the Select Storage P olicy window, select a storage policy and click OK.
For more information on entire VM restore of Microsoft Hyper-V VMs, see the Entire VM Restore section of the
Veeam Backup & Replication User Guide.
1. Open the Ma chines tab and select the necessary Microsoft Hyper-V VM from the list.
When you perform entire VM restore using Veeam Backup Enterprise Manager, Veeam Backup & Replication
automatically selects a backup proxy over which VM data must be transported to the source datastore. You can
select a backup proxy manually from the E ntire VM Restore wizard in the Veeam Backup & Replication console.
For more information, see the Select Restore Mode section of the Veeam Backup & Replication User Guide.
o Restore to the original location — select this option to restore the VM with initial settings and to the
original location. If this option is selected, you will pass directly to the Summary step of the wizard.
During restore to the original location, Veeam Backup & Replication restores only those disks that are
included in the backup file. This means that after the restore finishes, you do not have to update
existing jobs which process the original VMs.
o Restore to a new location or with different settings — select this option to restore the VM to a new
location, or to any location but with different settings. If this option is selected, the E ntire VM Restore
wizard will include additional steps for customizing VM settings.
During restore to a new location, Veeam Backup & Replication creates new VMs. If you want to
process the restored VMs, you must edit existing jobs or create new jobs to process the restored VMs.
If you restore VMs with the same name and to the same folder as the original VMs,
Veeam Backup & Replication deletes the original VMs. In this case, you must edit existing jobs to
exclude original VMs from them.
NOTE
If you need to run an executable script for the VM before restoring it to the production environment,
you can use the Veeam Backup & Replication console to perform entire VM restore in the Staged
restore mode. For more information, see the Select Restore Mode section of the
Veeam Backup & Replication User Guide.
2. [For VM restore to the original location] Select the Quick rollback check box to perform incremental
restore for the VM. Veeam Backup & Replication will query Changed Block Tracking to get data blocks that
are required to revert the VM to the restore point, and will restore only these data blocks. Quick rollback
significantly reduces the restore time and has little impact on the production environment.
Enable this option if you restore a VM after a problem that occurred at the level of the VM guest OS: for
example, there has been an application error or a user has accidentally deleted a file on the VM guest OS.
Do not enable this option if the problem has occurred at the VM hardware level, storage level or due to a
power loss.
At this step of the wizard, you can specify a name of the restored VM and target host, register the VM as a
cluster resource, and generate a new BIOS UUID.
1. In the Restored VM name field, specify a name under which the workload will be restored.
3. If the specified host is a part of a Hyper-V failover cluster, you can register the restored VM as a cluster
resource. In this case, if the target host is brought offline or fails for any reason, the VM will fail over to
another node in the cluster. To do this, select the Reg ister VM as a cluster resource check box.
4. Choose whether to preserve the BIOS UUID or generate a new BIOS UUID.
If the original VM still resides in the production environment, select the Generate new BIOS UUID option
to prevent conflicts. The BIOS UUID change is not required if the original VM no longer exists, for
example, if it was deleted.
At this step of the wizard, you can change default paths where VM configuration files and disk files will be
stored.
1. Select the configuration files or one of the disk files and click E d it Path.
2. Type in a path to the folder where the files will be stored. You can specify an existing folder, a new folder
or an SMB3 shared folder. SMB3 shared folder path must be in the UNC format, for example:
\\[Link]\Share01.
3. Click OK.
IMP ORTANT
The host or cluster on which you register VMs must have access to the specified SMB3 shared folder. If you
are using SCVMM 2012 or later, the server hosting the Microsoft SMB3 shared folder must be registered in
SCVMM as a storage device. For more information, see Microsoft Docs.
At this step of the wizard, you can map a network in the original site to the network in the target site. During
the restore process, Veeam Backup & Replication will update VM configuration files to replace the original
networks with the specified networks in the target site. As a result, you will not have to re -configure network
settings manually.
i. Click Network.
ii. In the Select Network window, select a necessary network and click OK.
Users with the Portal Administrator role have no scope limitations. They can restore VM disks to their original
location. Restore scope for other users is defined as described in the Configuring Restore Scope section.
• Disk restore is available in the Enterprise and Enterprise Plus editions of Veeam Backup & Replication.
• During the virtual disk restore, Veeam Backup & Replication powers off the target VM to reconfigure its
settings and attach restored disks. It is recommended that you stop all activities on the target VM for the
restore period.
To restore a VM disk from backup, use the Virtual Disk Restore wizard.
1. Open the Ma chines tab and select the necessary VMware vSphere VM from the list.
To quickly find a machine, you can filter machines in the list by a backup server or search for a specific
machine by machine name.
1. By default, Veeam Backup Enterprise Manager restores virtual disks to the original VM. To select another
VM, click Choose next to the Virtual machine field and select the necessary VM from the virtual
environment.
You cannot attach restored disks to a VM that has one or more snapshots.
2. In the Disk Mapping section, select check boxes next to the virtual disks that you want to restore.
3. By default, virtual disks are restored in the original format. To change the disk format, select the
necessary option from the Restore disks list: Same as source, Thin, Thick (lazy zeroed) or Thick (eager
zeroed) . For more information about virtual disk formats, see the Virtual Disk Options section of the
VMware vSphere documentation.
Disk format change is supported only for VMs with Virtual Hardware version 7 or later.
Enable this option if you restore a VM disk after a problem that occurred at the level of the VM guest OS:
for example, there has been an application error or a user has accidentally deleted a file on the VM guest
OS. Do not enable this option if the problem has occurred at the VM hardware level, storage level or due
to a power loss.
5. By default, virtual disks are restored to the target machine with the original properties. To change disk
properties, take the following steps for each disk:
a. In the Disk Mapping section, select the necessary virtual disk and click the Cha nge disk mapping link.
b. In the Virtual Disk Properties window, click Choose next to the Da tastore field and select a datastore
where the virtual disk file will be placed.
c. From the Virtual Device Node list, select a virtual device node for the restored disk on the target VM:
▪ If you want to replace an existing virtual disk, select an occupied virtual device node.
1. Select the Sca n the restored disk for malware prior to performing recovery check box.
2. Select the action that Veeam Backup & Replication will take if the antivirus finds a virus threat:
o Select P roceed with recovery but do not attach infected disks to the target VM if you want to
continue the virtual disk restore. In this case, the restored disk will not be attached to the target VM.
o Select Ab ort disk recovery if you want to cancel the restore session.
3. Select the Sca n the entire image check box if you want the antivirus to continue the machine data scan
after the first malware is found.
To view the progress of the virtual disk restore operation, on the Ma chines tab, click History.
Failover is an intermediate step that must be finalized in the Veeam Backup & Replication console. You can
perform the following operations in the console:
• Undo failover to switch back to the source VM and discard all changes made to the replica while it was
running.
• Perform permanent failover to permanently switch from the source VM to the replica and use this replica
as the production VM.
• Perform failback to switch back to the source VM and send to the source VM all changes that took place
while the replica was running.
For more information on finalizing failover, see the Failover and Failback section of the
Veeam Backup & Replication User Guide.
Users with the Portal User and Restore Operator roles can perform failover of machines included in the restore
scope. Users with the Portal Administrator role have no restore scope limitations. For more information on
restore scope, see Configuring Restore Scope.
NOTE
Failover is available in the Enterprise and Enterprise Plus editions of Veeam Backup & Replication.
Failover to VM Replica
If a VM is processed by a regular replication job, you can fail over the VM to its replica. After the failover
operation completes, the VM replica is powered on.
Failover is an intermediate step that you must finalize in the Veeam Backup & Replication console. In the
console, you can undo failover, perform permanent failover or perform failback. For more information, see the
Replica Failover and Failback section of the Veeam Backup & Replication User Guide.
To perform failover:
4. Click Restore.
Failover is an intermediate step that you must finalize in the Veeam Backup & Replication console. In the
console, you can undo failover, perform permanent failover or perform failback. For more information, see the
Replica Failover and Failback section of the Veeam Backup & Replication User Guide.
To perform failover:
3. In the Restore window, select the restore point you need. You can fail over to the latest available crash-
consistent state, to the latest application-consistent state or to a specific point in time.
TIP
• To quickly find a long-term restore point, use the calendar.
• To zoom in or zoom out the time line, use the P lus and Minus buttons or switch between the
Hour and Da y views.
4. Click Fa ilover.
Failover is an intermediate step that you must finalize in the Veeam Backup & Replication console. In the
console, you can undo failover, perform permanent failover or perform failback. For more information, see the
Replica Failover and Failback section of the Veeam Backup & Replication User Guide.
1. On the Ma chines tab, select a machine processed by a Cloud Director replication job.
4. Click Restore.
Failover is an intermediate step that you must finalize in the Veeam Backup & Replication console. In the
console, you can undo failover, perform permanent failover or perform failback. For more information, see the
Replica Failover and Failback section of the Veeam Backup & Replication User Guide.
1. On the Ma chines tab, select a machine processed by a Cloud Director CDP policy.
3. In the Restore Points window, select the restore point you need. You can fail over to the latest available
crash-consistent state, to the latest application-consistent state, or to a specific point in time.
Application consistency is defined for the whole vApp. A vApp restore point is application-consistent if all
VMs have application-consistent restore points. A vApp restore point is mixed if some VMs have crush-
consistent restore points.
TIP
• To quickly find a long-term restore point, use the calendar.
• To zoom in or zoom out the time line, use the P lus and Minus buttons or switch between the
Hour and Da y views.
In Veeam Backup Enterprise Manager, you can run failover plans created in Veeam Backup & Replication console
for VMware vSphere and Microsoft Hyper-V VMs.
• The order in which the machines should be processed: for example, AD domain services server first,
Exchange server after it.
• The delay time needed to start each machine. The delay time helps to ensure that certain machines (AD
domain services server in our example) are already running at the time the dependent machines start.
The failover process is performed in the following way (either ad -hoc or on schedule):
1. For each machine included in the plan, Veeam Backup & Replication detects its replica (the m achines
whose replicas are already in Failover or Failback state are skipped from processing).
2. The replica machines are started sequentially, in the order they appear in the failover plan, within the set
time intervals.
Consider that failover is a temporary intermediate step that needs to be finalized. The finalizing options for a
group failover are similar to a regular failover: undoing failover, permanent failover or failback. To learn more
about failover planning and recommended course of action, refer to Veeam Backup & Replication User Guide.
Veeam Backup Enterprise Manager allows you to carry out a failover following the existing plan, and also to
undo planned failover.
NOTE
For failover plan creation, as well as for permanent failover or failback, use the Veeam Backup &
Replication console.
1. Log in to Enterprise Manager using an administrative account or user account whose restore scope
contains the machines from the failover plan.
3. In the Fa ilover Plan window, select the necessary plan from the list, then specify the starting option you
need.
o Sta rt now — use this option if you need to fail over to the replicas’ latest restore point.
o Sta rt to most recent replica prior to — use this option if you need to fail over to a certain restore point.
For example, you may want your application server to failover to a state prior to the upgrade. I n this
case, for each machine participating in failover, Veeam will find the closest restore point (prior to the
specified date and time) and fail over to it.
• Browsing and restoring processes involve appropriate backup job setup, as well as file system mounting
and data transfer operations. For details, see Preparing for File Browsing and Searching.
• Veeam Backup Enterprise Manager lets you browse and recover guest OS files from backups of Proxmox
VE, Nutanix AHV and oVirt KVM (Oracle Linux Virtualization Manager and Red Hat Virtual ization)
machines. The following operations are supported:
o For Proxmox VE and oVirt KVM, you can browse files and download them to the local machine.
o For Nutanix AHV VMs, you can browse files, download them to the local machine, and restore them to
the original location.
• To browse and restore guest OS files and application items from a physical machine backup stored in a
Veeam backup repository, you need a certain Veeam Agent deployed on the machine and integrated with
Veeam Backup & Replication. For more information, see Veeam Agents Support.
• Enterprise Manager does not support 1-Click restore, 1-Click guest OS file restore, or application item-
level restore for Microsoft Exchange mailbox items or Microsoft SQL Server databases if it is perf ormed
from any storage snapshot.
1. To provide for browsing and search, Veeam Backup Enterprise Manager uses index data to represent the
file system of the machine guest OS.
2. If you then select to download the necessary files, Veeam Backup & Replication will mount machine disks
(from the restore point) on the backup server and copy these files from the backup server to the
destination location.
3. If you select to restore files to the original location, an additional mount point will be created on the
mount server associated with the backup repository storing the backup file. During restor e, machine data
will flow from the repository to the target, keeping the machine traffic in one site and reducing load on
the network.
4. After you download or restore the necessary files, and finish the restore session, the machine disks will be
unmounted.
When you restore files from the restore point that was created without machine guest OS file indexing,
Veeam Backup & Replication uses the following workflow:
1. To provide for browsing, disks of the machine from the backup file are mounted to the backup server. If
you then select to download the necessary files, Veeam Backup & Replication will copy these files from
the backup server to the destination location, using this mount point.
2. If you select to restore files from the backup to the original loca tion on the production machine, an
additional mount point will be created on the mount server associated with the backup repository storing
the backup file.
4. After you download and restore the necessary files and finish the restore session, machine disks will be
unmounted.
1. Enable guest file system indexing on the Guest Processing step of the backup job wizard. For more
information, see Configure Guest Processing Settings.
2. Run the backup job with guest file system indexing enabled.
3. Perform catalog replication. For more information, see Performing Catalog Replication and Indexing.
Alternatively, you can process the machine without guest file system indexing. Indexing may be disabled at the
time of restore point creation, or indexing operation may fail. In this case, the restore point of a Windows
machine is mounted to the backup server that manages the job, and the restore point of a non-Windows
machine is mounted to a helper host or helper appliance.
Then you will be able to locate necessary files and folders and perform restore operat ion. For more information,
see Browsing Machine Backups for Guest OS Files.
NOTE
Catalog replication is performed for the machines with indexed guest OS file systems on all managed
backup servers.
Veeam Backup Enterprise Manager provides two options to perform catalog replication:
• To perform manual catalog replication, open the Settings tab of the Configuration view and click Up date
Now on the Sea rch Catalog tab.
• To automatically run catalog replication after every backup job, open the Settings tab of the Configuration
view. On the Sea rch Catalog tab, select Up d ate catalog automatically after each backup job run and
specify other options as required.
Every run of a catalog replication job initiates a new job session which can be tracked on the Sessions tab of the
Configuration view. To view detailed information for a specific session, select it in the list of sessions and click
the link in the Sta tus column.
1. To enable guest file indexing, use one of the options of the machine backup job: Ind ex everything, Index
everything except, or Ind ex only following folders option. For more information, see the Guest OS File
Indexing section of this guide and the VM Guest OS File Indexing section of the Veeam Backup &
Replication User Guide.
NOTE
Guest file indexing is optional. You can browse and restore files from the restore points created
without guest indexing. For more information, see Browsing Machine Backups for Guest OS Files and
Performing 1-Click File Restore.
If you want Veeam Backup Enterprise Manager to display symbolic links to folders when browsing
through the machine file system at 1-click file restore, enable indexing in the backup job for that
machine.
2. For proper file system indexing, Veeam Backup & Replication requires several utilities to be installed on
the machine: mlocate, gzip, and tar. If these utilities are not found, you are prompted to deploy them
to support index creation.
3. By default, guest file restore to the original location is performed using the account specified in the
machine backup job. If it does not have sufficient access to target machine, you are prompted to specify
another account with sufficient access rights.
For more information, see the Guest OS Credentials section of this guide and the Specify Guest Processing
Settings section of the Veeam Backup & Replication User Guide.
When you start guest OS file restore from Enterprise Manager, the helper host (or appl iance) settings are
obtained from the configuration database of the backup server. If no helper host or helper appliance
configuration is found for the user account, Veeam Backup & Replication uses the configuration that was last
selected at the Helper host step of the Guest File Restore wizard. Thus, before you start file-level restore from
Enterprise Manager, make sure the settings are properly configured on the backup server. For details, see the
Specify Helper Host section of the Veeam Backup & Replication User Guide.
If you are using the Enterprise or Enterprise Plus license edition in your virtual environment, consider that
Veeam Backup Enterprise Manager keeps index files for backups that are currently stored on disk, and for
archived backups (for example, backups that were recorded to tape). Thus, you will be able to browse and
search through backup contents even if the backup in repository is no longer available.
2. In the Sea rch backups of field, enter the name of a machine whose files you want to restore or click the
P ick from List link and select the necessary machine in the Select Object window.
3. To specify a restore point from which to restore guest OS files, click the calendar icon in the restore point
field and select a date and a restore point created on that date. If multiple jobs have processed the
machine, a job name will be also displayed for each restore point.
You can only choose the dates when at least one restore point was created. By default, the latest restore
point is selected in the restore point field.
4. If the machine has been backed up without guest indexing, click Mount. If the machine guest OS
information has not been collected during the backup, you will be also prompted to specify the guest OS
type. Machine disks from the backup will be mounted to Veeam backup server to present machine file
system to you; wait for the process to complete.
If the machine has been backed up with guest indexing enabled, no additional operations are needed.
IMP ORTANT
For machines processed without indexing, you can only use browsing or search to find the necessary files
within the selected restore point. Advanced search capabilities (including search through multiple restore
points) are available only for machines processed with guest indexing enabled.
IMP ORTANT
By default, backup repository is the primary destination for the search. This means, in particular, that if a
backup (with an indexed guest) is stored both in a repository and tape, the Enterprise Manager search
results will only include the files from backup stored in the repository. Files from tape -archived backup will
appear in search results only if nothing is found in the repository (the capability is supported in the
Enterprise and Enterprise Plus editions).
• Simple search — allows you to search for files in a selected restore point of a selected machine backup
• Advanced search — allows you to search for files in all restore points of a selected machine backup and
filter search results by certain criteria
2. In the Sea rch backups of field, enter the name of a machine whose files you want to restore or click the
P ick from List link and select the necessary machine in the Select Object window.
3. In the search field, enter the name of the necessary file or a part of it.
2. If you know the necessary file name or a part of the name, specify it in the search field.
3. To open advanced search options, click No Filter next to the search field.
o La st modification time — specify approximate time when the file was last modified or set a time
interval.
o Ba ckup time — choose to search through the latest backup of the specified machine or all backups of
the machine created within a certain time interval.
IMP ORTANT
• 1-Click file restore capability is available if you have the Enterprise or Enterprise Plus edition.
• 1-Click file restore from a storage snapshot is not supported by Veeam Backup Enterprise Manager.
Restore operations are only available to authorized users according to their security settings. Users with the
Portal Administrator role can restore files both to the original location or download them to the local machine.
For users with the non-administrative roles, you can configure additional restriction settings. For example, you
can prohibit restore operators to download files to the local machine so that they can restore files to the original
location only. Additionally, you can specify the types of files that can be restored by operators (this can be
helpful if you want to limit operators’ access to sensitive data). For details, see Configuring Permissions for File
and Application Item Restore.
NOTE
• If you plan to restore a file from a machine backed up without guest indexing, consider that for
restore operation this machine disk will be mounted directly from the backup in the repository to
the mount server associated with that repository; when restoring from replica, it will be mounted to
the backup server. When restoring from an indexed machine, no interim mount operations are
needed.
• If you want Veeam Backup Enterprise Manager to display symbolic links to folders when br owsing
through the machine file system at 1-click file restore, then you should enable indexing in the
backup job for that machine (running Linux or another non-Windows OS).
IMP ORTANT
• This type of restore is only possible if the original machine is powered on and resides in the original
location.
• By default, guest file restore to the original location is performed using the account specified in the
backup job for guest OS access. If it does not have sufficient rights to access the target machine, you
are prompted for the credentials. Specify user account and password, as required. For more
information, see Guest OS Credentials.
1. Find the objects you want to restore. You can select one or multiple objects . For details, see Browsing
Machine Backups for Guest OS Files and Searching for Guest OS Files in Machine Backups.
o If you select Overwrite, the object from the backup will replace the original object on the target
machine.
o If you select Keep, the object from the backup will be restored next to the original object on the
target machine. The restored object will have the _RESTORED_<DATE>_<TIME> prefix in its name,
where <DATE>_<TIME> is the restore date and time.
o [For Microsoft Windows] If you select P ermissions Only, you will restore file (or folder) permissions
that were granted to users and groups to access the object. You can restore permissions only if the
object exists on the target machine.
1. Find the objects you want to restore. You can select one or multiple objects. For details, see Browsing
Machine Backups for Guest OS Files and Searching for Guest OS Files in Machine Backups.
2. Click Download.
4. Wait for restore session to complete and for the objects to be retrieved from the backup.
5. In the File Restore History view, select the restore session from the list.
1. Find the objects you want to restore. You can select one or multiple objects. For details, see Browsing
Machine Backups for Guest OS Files and Searching for Guest OS Files in Machine Backups.
When a file is added to the restore list, the P ending restore notification appears at the top of the Enterprise
Manager window.
2. In the P ending Restore window, select check boxes next to files in the restore list that you want to
restore. Use the check box next to the header of the Na me column to select all files in the list at once.
If you want to remove a file from the restore list, select the file and click Delete.
3. Click the Restore or Download link to perform the necessary restore operation for the selected files.
The objects are saved to the default download folder on your local machine.
Multiple files are also saved in a ZIP file named FLR_<date>_<time>.zip in the
%ProgramData%\Veeam\Backup\WebRestore folder. Veeam Backup Enterprise Manager cleans up the
folder periodically. Files older than 24 hours are automatically deleted. To change the default storage
folder, contact Veeam Customer Support.
TIP
Veeam Backup Enterprise Manager keeps links for downloaded files in the history for one day. To
download a file that was previously restored:
1. Find the objects you want to restore. You can select one or multiple objects. For details, see Browsing
Machine Backups for Guest OS Files and Searching for Guest OS Files in Machine Backups.
o Select Overwrite, to replace an object with the same name on the target machine with the object from
the backup.
o Select Keep, to restore the object from the backup next to the object on the target machine. The
restored object will have the _RESTORED_<DATE>_<TIME> prefix in its name, where <DATE>_<TIME>
is the restore date and time.
4. In the Restore To window, specify restore location and credentials for connection to the target machine:
a. In the DNS name or IP address of the target server field, specify a DNS name, IPv4 or IPv6 address of
a Microsoft Windows machine.
b. In the Destination path field, specify a path to the folder on the selected host where the files must be
restored. If the destination folder does not exist, it will be created.
c. In the Username and P a ssword fields, specify credentials required for connection to the target
machine.
This capability is supported by the Veeam runtime process which performs guest system indexing and also
identifies local administrative accounts. Communication with the self-service webpage is performed over the
HTTPS protocol. In particular, such delegation capabilities and self-service web portal can be used in enterprise
deployments to elevate the first line support to perform in-place restores without administrative access.
To provide a user account with the ability to access Self-Service File Restore Portal, make sure the following
prerequisites are met:
• The account belongs to the trusted or same domain as the Enterprise Manager server (for the user account
to be resolved to SID). Users from untrusted domains cannot utilize self-restore.
• The account has local administrative rights for the required machine guest OS, local user rights are not
sufficient.
IMP ORTANT
A Self-Service File Restore Portal user has access only to restore points created after the user is assigned
with local administrator rights.
Machine restore points will stay available for self-restore to a user account whose local administrative
rights were revoked after the restore point creation until the next restore point is created (then that user
will not be able to access guest files any longer).
1. Start the Self-Service File Restore Portal by clicking its icon in the list of applications or on the desktop.
Alternatively, in the web browser address bar, enter the portal URL, for example:
[Link]
3. To view guest files as of earlier restore point, click the Ca lendar icon and select the restore point. To view
guest files of another machine (if available to you), use the Sea rch field or the P ick from List link.
4. You can perform all operations supported for machine guest files by Veeam Backup Enterprise Manager.
For more information on file browsing, search and restore, see Browsing Machine Backups for Guest OS
Files, Searching for Guest OS Files in Machine Backups, and Performing 1-Click File Restore.
NOTE
If the Veeam Backup Enterprise Manager server is added to the Veeam ONE monitoring scope, the restore
operations performed with Self-Service File Restore Portal are included in the Restore Operator Activity
report available in Veeam ONE.
If no guest OS files are visible to the user, check the following reasons:
• The backup server that manages the job is not added to the Enterprise Manager infrastructure. For more
information, see Adding Backup Servers.
• The recent backup job data has not been yet collected from the backup server (default time interval is 15
minutes). For more information on how to run data collection manually, see Collecting Data from Backup
Servers.
• The E nable g uest file system indexing option is turned off in the machine backup job. Edit the job setting
and restart the job with indexing enabled.
• When the machine restore point was created, the user was not assigned local administrative rights. To
access the guest OS files the user must be a part of the guest OS local administrator group.
If you cannot find your machine from the P ick from List window, you can select the I d on't see my machine
option to rebuild a security scope for your user account. Once complete, this action will reveal machines that
were added to your security scope.
You can restore application items from restore points created by Veeam Backup & Replication or one of Veeam
Agents. For more information on Veeam Agents support in Enterprise Manager, see Veeam Agents Support.
With Enterprise Manager, you can restore the following application items:
• Oracle databases
• PostgreSQL instances
• Application item restore is available in the Enterprise and Enterprise Plus editions of
Veeam Backup & Replication.
• Enterprise Manager does not support application item restore from storage snapshots.
• Enterprise Manager users can only restore Microsoft Exchange items to the original location within their
restore scope. Users must also have sufficient permissions to restore application ite ms. Users with the
Portal Administrator role have no limitations. For more information, see Configuring Accounts and Roles.
• For details on supported application versions, see the Platform Support section of the Veeam Backup &
Replication User Guide.
• You can restore deleted Microsoft Exchange items to the production mailbox only.
• Enterprise Manager does not support application item restore from backups created by Veeam Plug -in for
Oracle RMAN.
• When you restore application items with Enterprise Manager, restore limitations listed in the Veeam
Explorers User Guide are also applied:
You can restore Microsoft Exchange items located in different domains. To use this feature, you must be able to
provide a specific Microsoft Active Directory account to restore your data in the necessary domain. For that,
select the P rompt for AD account credentials every time option when configuring Active Directory account
settings. For more information, see Configuring Permissions for File and Application Item Restore.
Performing Restore
To restore a Microsoft Exchange item to the production Microsoft Exchange Server, take the following steps:
2. In the Username field, enter the account of Active Directory user whose mailbox you want to restored.
You can leave the Username field empty and click the search icon to display all mailboxes that currently
exist in the production environment, or enter a search criteria.
3. If you have preconfigured a Microsoft Active Directory account for Microsoft Exchange item restore,
Enterprise Manager will use this account for browsing mailbox items and restore. For more information,
see Configuring Permissions for File and Application Item Restore.
If you have not preconfigured the account, specify the following settings in the Ma il Server Credentials
window:
a. In the Doma in field, enter a name of the domain that the Microsoft Exchange machine belongs to.
b. In the Username field, specify an account name in the following format: DOMAIN\USERNAME . The
account must have necessary permissions. For details, see the Permissions section of the Veeam
Explorers User Guide.
Enterprise Manager uses Global Catalog to examine Active Directory database and find the specified user
mailbox, as well as the DNS name for the Exchange Server where the data should be restored. Then it
looks for the VM backup or replica and its restore points.
4. To specify a restore point from which to restore the database, in the Restore p oint field, click the calendar
icon and select the necessary date and a restore point created on that date. By default, the latest valid
restore point is selected.
NOTE
• Restore points on tape are not supported (only those stored in repository can be used).
• If the specified user mailbox does not exist in the restore point, Veeam Backup Enterprise
Manager will display an error message.
5. In the Items section, select the type of item you want to restore:
o Mail
o Calendar
o Contacts
6. To restore only missing items created or received during a certain period, select the Only restore missing
items created or received <time period> check box and select the period from the drop-down list.
7. Click Restore. Items that meet the specified conditions will be restored to the production Exchange
Server.
• Restore to the original location — to restore a Microsoft SQL Server database to the original location with
the same settings.
• Restore with custom settings — restore a Microsoft SQL Server database to a new location, or to any
location but with different settings.
When performing database restore to the original location, a temporary iSCSI connection is established between
the target Microsoft SQL server (it acts as an iSCSI initiator) and mount server associated with the backup
repository (it acts as an iSCSI target). For that, Veeam opens a TCP port from the port range 3260 -3270; it
closes this port after restore session is over.
Consider that user credentials for carrying out the restore procedure will be picked as follows:
1. Veeam Backup Enterprise Manager tries to use the account specified in the backup job that contains the
Microsoft SQL Server machine or the account you are currently logged in.
2. If this account does not have sufficient rights to perform the restore procedure (for example, in case of
imported backup), you will be prompted to provide the necessary credentials.
The security role specified for this account in Enterprise Manager must allow the user to restore Microsoft
SQL Server databases. For more information, see Configuring Permissions for File and Application Item
Restore.
NOTE
If you restore a database that belongs to an AlwaysOn Availability Group, this database will be restored to
the original server and added to the Availability Group.
2. In the SQL Server field, enter a name of Microsoft SQL Server hosting the database you need to restore;
use the server_name\instance_name format.
Alternatively, click the P ick from List link to choose a machine from the list of available Microsoft SQL
Server backups.
3. From the Da tabase to restore list, select the database you need.
4. To specify a restore point from which to restore the database, in the Restore p oint field, click the calendar
icon, and select the necessary date when backup was performed and a restore point created on that date.
By default, the latest valid restore point is selected.
5. For a database backed up with transaction log backup turned on, you can also select the necessary point in
time using the P oint in time slider. The slider displays the following timestamps (relative to the currently
selected restore point):
o The beginning point refers to the previous restore point of the Microsoft SQL Server machine that
contains the selected database backup. If the previous restore point (server backup) is not found, or
the database backup does not exist in it, then the beginning point refers to the current restore point.
o The ending point refers to the next restore point that contains the selected database backup. If the
next restore point (server backup) and the associated transaction log backup are not found, or if the
database backup does not exist in the server backup, then the ending point will re fer to the current
restore point. If the next restore point (server backup) is not found, but the transaction log backup
exists for the preceding period, then the ending point refers to the latest log backup time.
For more information on configuring transaction log backup, see Microsoft SQL Server Transaction Log
Settings.
To restore an Oracle database with custom settings, use the SQL Restore wizard.
2. In the SQL Server field, enter a name of Microsoft SQL Server hosting the database you need to restore;
use the server_name\instance_name format.
Alternatively, click the P ick from List link to a machine from the list of available Microsoft SQL Server
backups.
3. From the Da tabase to restore list, select the database you need. Consider that user credentials for carrying
out the restore procedure will be picked as follows:
a. Veeam Backup Enterprise Manager will try to use the account of the backup job that contains the
Microsoft SQL Server machine.
b. If this account does not have sufficient rights to perform the restore procedure (for exa mple, in case
of imported backup), user will be prompted to provide the necessary credentials.
The security role specified for this account in Enterprise Manager must allow the user to restore
Oracle databases. For more information, see Configuring Permissions for File and Application Item
Restore.
4. To specify a restore point from which to restore the database, in the Restore p oint field, click the calendar
icon and select the necessary date when backup was performed and a restore point created on that date.
By default, the latest valid restore point is selected.
5. For a database backed up with transaction log backup turned on, you can also select the necessary point in
time using the P oint in time slider. The slider displays the following timestamps (relative to the currently
selected restore point):
o The beginning point refers to the previous restore point of the Microsoft SQL Server machine that
contains the selected database backup. If the previous restore point (server b ackup) is not found, or
the database backup does not exist in it, then the beginning point refers to the current restore point.
o The ending point refers to the next restore point that contains the selected database backup. If the
next restore point (server backup) and the associated transaction log backup are not found, or if the
database backup does not exist in the server backup, then the ending point will refer to the current
restore point. If the next restore point (server backup) is not found, but the transaction log backup
exists for the preceding period, then the ending point refers to the latest log backup time.
For more information on configuring transaction log backup, see Microsoft SQL Server Transaction Log
Settings.
1. In the Ta rget Server section, enter the name of the Microsoft SQL Server or Microsoft SQL Server instance
in the <server IP or FQDN>\<instance name> format, and credentials of the account that will be used to
connect to the target server.
If the SQL Server instance is assigned a custom port, and Microsoft SQL Browser is not running on the
machine, specify the instance port in the following format: <server IP or FQDN>,<port> .
2. In the Ta rget Database section, specify the following database connection settings:
b. To use a separate account for connection to the target database, select the Use the following
credentials to access the database check box and specify credentials of the necessary account.
c. To use Microsoft SQL Server authentication when connecting to the database, select the Use SQL
Server authentication check box.
At this step of the wizard, you can add the restored database to an Availability Group.
1. Select the Ad d the database to the following Availability Group check box and select an availability group
from the drop-down list.
2. In the Da tabase will be replicated to the following nodes list, review information about the primary and
secondary nodes of the availability group.
During the restore process, Veeam Backup & Replication will restore the database to the primary server
and then replicate it to secondary nodes.
If you do not plan to use the AlwaysOn capabilities when restoring a database, clear the Ad d the database to the
following Availability Group check box.
To view the status of the restore process, on the Items tab, click History.
• Restore to the original location — to restore an Oracle instance to the original location with the same
settings.
• Restore with custom settings — restore an Oracle instance to a new location, or to any location but with
different settings.
When performing database restore to the original location, a temporary iSCSI connection is established between
the target Oracle server (it acts as an iSCSI initiator) and mount server associated with the backup repository (it
acts as an iSCSI target). For that, Veeam opens a TCP port from the port range 3260-3270; it closes this port
after restore session is over.
Consider that user credentials for carrying out the restore procedure will be picked as follows:
1. Veeam Backup Enterprise Manager will try to use the account of the ba ckup job that contains the Oracle
server machine or the account you are currently logged in.
2. If this account does not have sufficient rights to perform the restore procedure (for example, in case of
imported backup), you will be prompted to supply the necessary credentials. Make sure the account has
access to the original machine guest OS (Windows or Linux); if restoring an Oracle 12 Database on
Windows server, then you may need to enter password for Oracle home.
The security role specified for this account in Enterprise Manager must allow the user to restore Oracle
databases. For more information, see Configuring Permissions for File and Application Item Restore.
2. In the Server field, enter a name of the Oracle server hosting the database you need to restore.
Alternatively, click the P ick from List link to select a machine from the list of available Oracle backups.
3. From the Da tabase to restore list, select Oracle home and the database you need.
4. To specify a restore point from which to restore the database, in the Restore p oint field, click the calendar
icon and select the necessary date when backup was performed and a restore point created on that date.
By default, the latest valid restore point is selected.
5. For a database backed up with transaction log backup turned on, you can also select the necessary point in
time using the P oint in time slider. The slider displays the following timestamps (relative to the currently
selected restore point):
o The beginning point refers to the previous restore point of the Oracle machine that contains the
selected database backup. If the previous restore point (server backup) is not found, or the database
backup does not exist in it, then the beginning point refers to the current restore point.
o The ending point refers to the next restore point that contains the selected database backup. If the
next restore point (server backup) and the associated transaction log backup are not found, or if the
database backup does not exist in the server backup, then the ending point will refer to the current
restore point. If the next restore point (server backup) is not found, but the trans action log backup
exists for the preceding period, then the ending point refers to the latest log backup time.
For more information on configuring transaction log backup, see Oracle Archived Redo Log Settings.
7. Click Restore.
To restore an Oracle database with custom settings, use the Ora cle Restore wizard.
2. In the Server field, enter a name of the Oracle server hosting the database you need to restore.
Alternatively, click the P ick from List link to select a machine from the list of available Oracle backups.
3. From the Da tabase to restore list, select Oracle home and the database you need. Consider that user
credentials for carrying out the restore procedure will be picked as follows:
a. Veeam Backup Enterprise Manager will try to use the account of the backup job that contains the
Oracle server machine, or the account which is currently logged in.
b. If this account does not have sufficient rights to perform the restore procedure (for example, in case
of imported backup), you will be prompted to supply the necessary credentials. Make sure the
account has access to the original machine guest OS (Windows or Linux); if restoring an Oracle 12
Database on Windows server, then you may need to enter password for Oracle home.
4. To specify a restore point from which to restore the database, in the Restore p oint field, click the calendar
icon and select the necessary date when backup was performed and a restore point created on that date.
By default, the latest valid restore point is selected.
5. For a database backed up with transaction log backup turned on, you can also select the necessary point in
time using the P oint in time slider. The slider displays the following timestamps (relative to the currently
selected restore point):
o The beginning point refers to the previous restore point of the Oracle machine that contains the
selected database backup. If the previous restore point (server backup) is not found, or the database
backup does not exist in it, then the beginning point refers to the current restore point.
o The ending point refers to the next restore point that contains the selected database backup. If the
next restore point (server backup) and the associated transaction log backup are not found, or if the
database backup does not exist in the server backup, then the ending point will refer to the current
restore point. If the next restore point (server backup) is not found, but the transaction log backup
exists for the preceding period, then the ending point refers to the latest log backup time.
For more information on configuring transaction log backup, see Oracle Archived Redo Log Settings.
1. In the DNS name or IP address field, enter a DNS name or IP address of the target Microsoft Windows
server.
2. In the Account and P a ssword fields, specify credentials of the account that will be used for connection
with the target Windows-based Oracle server.
• The user account must be a member of the local Administrator group and have sy sdba privileges.
• The user account must be granted appropriate permissions to access Oracle databases; Rea d and W rite are
minimum required, Full Control is recommended.
• To copy archived logs to the specified server, the user account must be granted sufficient permissions to
access the administrative share.
1. In the DNS name or IP address field, enter a DNS name or IP address of the target Linux server.
2. In the SSH p ort field, specify a port number of the target Oracle server (by default, port 22 is used).
3. In the Account filed, specify an account under which to connect to the specified server.
6. If you have specified a non-root account that does not have root permissions on the target server, do the
following.
a. To provide a non-root user with root account privileges, select the E levate specified account to root
check box.
b. To add the user account to the sudoers file, select the Ad d account to the sudoers file automatically
check box. In the Root password field, enter the password for the root account.
If you do not enable this option, you will have to manually add the user account to the sudoers file.
c. If the sudo command is not available or may fail on the target Linux server, you have an option to use
the su command instead. To enable the su command, select the Use "su" if "sudo" fails check box and
in the Root p assword field, enter the password for the root account.
Veeam Backup & Replication will first try to use the sudo command. If the attempt fails, the su
command will be used.
2. In the Global database name field, specify a full name of the database including its network domain.
3. In the Ora cle SID field, specify the database system identifier.
If a database with the specified SID exists on the target Oracle home, the restore process will delete it and
replace with the database from backup. Thus, before starting the restore process, a message will be
displayed, asking you to confirm the operation.
To view the status of the restore process, on the Items tab, click History.
• Restore to the original location — to restore a PostgreSQL instance to the original location with the same
settings.
• Restore with custom settings — restore a PostgreSQL instance to a new location, or to any location but
with different settings.
Consider that user credentials for carrying out the restore procedure will be picked as follows:
1. Veeam Backup Enterprise Manager tries to use the account specified in the backup job that contains the
PostgreSQL machine or the account you are currently logged in.
2. If this account does not have sufficient rights to perform the restore procedure (for example, in case of
imported backup), you will be prompted to provide the necessary credentials.
For more information on the account roles in Veeam Backup Enterprise Manager that allow a use r to
restore PostgreSQL, see Configuring Permissions for File and Application Item Restore.
To restore a PostgreSQL instance to the original location, take the following steps:
2. In the Server field, enter a VM name where the necessary PostgreSQL instance resides.
Alternatively, click the P ick from List link to select from the list of available PostgreSQL machine backups.
3. From the Instance to restore list, select a PostgreSQL instance you need.
4. To specify a restore point from which to restore the instance, in the Restore point field, click the calendar
icon and select the necessary date when backup was performed and a restore point created on that date.
By default, the latest valid restore point is selected.
5. To view a list of databases included in the restore point, click Show d atabases.
6. For PostgreSQL instances with transaction log backup turned on, you can also select the necessary point in
time using the P oint in time slider. The slider displays the following timestamps (relative to the currently
selected restore point):
o The beginning point refers to the previous restore point of the PostgreSQL machine that contains the
selected database backup. If the previous restore point (server backup) is not found, or the database
backup does not exist in it, then the beginning point refers to the current restore point.
o The ending point refers to the next restore point that contains the selected database backup. If the
next restore point (server backup) and the associated transaction log backup are not found, or if the
database backup does not exist in the server backup, then the ending point will refer to the current
restore point. If the next restore point (server backup) is not found, but the transaction log backup
exists for the preceding period, then the ending point refers to the latest log backup time.
For more information on configuring transaction log backup, see PostgreSQL Archive Log Settings.
8. Click Restore.
To restore a PostgreSQL instance with custom settings, use the P ostgreSQL Restore wizard.
2. In the Server field, enter a VM name where the necessary PostgreSQL instance resides.
Alternatively, click the P ick from List link to select from the list of available PostgreSQL machine backups.
3. From the Instance to restore list, select a PostgreSQL instance you need.
4. To specify a restore point from which to restore the instance, in the Restore point field, click the calendar
icon and select the necessary date when backup was performed and a res tore point created on that date.
By default, the latest valid restore point is selected.
5. To view a list of databases included in the restore point, click Show d atabases.
6. For PostgreSQL instances with transaction log backup turned on, you can also sel ect the necessary point in
time using the P oint in time slider. The slider displays the following timestamps (relative to the currently
selected restore point):
o The beginning point refers to the previous restore point of the PostgreSQL machine that conta ins the
selected database backup. If the previous restore point (server backup) is not found, or the database
backup does not exist in it, then the beginning point refers to the current restore point.
o The ending point refers to the next restore point that contains the selected database backup. If the
next restore point (server backup) and the associated transaction log backup are not found, or if the
database backup does not exist in the server backup, then the ending point will refer to the current
restore point. If the next restore point (server backup) is not found, but the transaction log backup
exists for the preceding period, then the ending point refers to the latest log backup time.
For more information on configuring transaction log backup, see PostgreSQL Archive Log Settings.
8. Click Restore.
1. In the Ta rget Server section, enter a DNS name or IP address of the target server, as well as an SSH port
(by default, port 22 is used).
2. Specify credentials of the account that will be used to connect to the target server:
c. If you want to use a Linux private key for this connection, select the P rivate k ey is required for this
connection check box and specify the following private key settings:
i. In the P rivate key field, specify a file that contains a private key.
ii. In the P a ssphrase field, enter the passphrase used to decrypt the private key.
d. If you have specified a non-root account that does not have root permissions on the target server,
select the E levate specified account to root check box.
The account must have root privileges to mount the backed up file system to mount the backed up
file system to the target server and to communicate with PostgreSQL.
i. To add the user account to the sudoers file, select the Ad d account to the sudoers file
a utomatically check box. In the Root p assword field, enter the password for the root account.
If you do not enable this option, you will have to manually add the user account to the sudoers
file.
Veeam Backup & Replication will first try to use the sudo command. If the attempt fails,
Veeam Backup & Replication will use the su command.
1. In the Da ta directory field, specify a path to the directory where the restored instance data will be s tored.
2. In the Instance port field, specify a TCP port that will be used to connect to the instance.
3. Select one of the following post-restore actions that the PostgreSQL server must take after the instance is
restored. For more information, see the Specify Post-Restore Action section of the Veeam Explorers User
Guide.
o Select P romote the instance to accept connections once the recovery is completed to make the
PostgreSQL instance available for connections.
o Select P a use the recovery process and k eep the instance in a recovery mode to make the PostgreSQL
instance run but not accepting incoming remote TCP connections.
o Select Shut d own the instance once recovery is completed to make the PostgreSQL instance stop
upon recovery.
To view the status of the restore process, on the Items tab, click History.
• Veeam Agent for Linux (Veeam Agent for Linux on Power is not supported)
NOTE
File restore from backups of Veeam Agent for Mac, Veeam Agent for Oracle Solaris and Veeam Agent for
IBM AIX to the original location is not available.
• You have the Enterprise or Enterprise Plus edition of Veeam Backup & Replication.
• For 1-Click restore of guest OS files and for restore of application items, you must have the Server edition
of Veeam Agents. For more information, see Product Comparison.
NOTE
You can work with both Veeam Agent backup jobs managed by Veeam Agent and Veeam Agent backup
jobs managed by the backup server. For more information on Veeam Agent backup jobs and policies, see
the Working with Veeam Agent Backup Jobs and Policies section of the Veeam Agent Management Guide.
Windows Server
Preparing Backup
You can restore files from a backup of a physical Windows server created with or without indexing.
1. Enable guest file system indexing on the Guest Processing step of the backup job wizard. For details, see
the File Indexing section of the Veeam Agent for Microsoft Windows User Guide.
2. Run the backup job with guest file system indexing enabled.
3. Make sure the indexing data is imported to the Veeam backup database, and catalog replication is
completed successfully. For details, see the Performing Catalog Replication and Indexing section.
If you restore files from an indexed guest OS, you do not need to mount the restore point for browsing purposes
— file hierarchy is presented using the index. The restore point will be only mounted once (during 1-Click file
restore process itself) — to the mount server associated with backup repository where Veeam Agent backups are
stored.
Alternatively, you can process the backups created without guest file system indexing — for example, if indexing
was disabled at restore point creation time, or if indexing operation failed. For such a server, its selected restore
point first will be mounted (for the browsing and search purposes) to the Veeam backup server integrated with
Veeam Agent. After you locate the necessary file and initiates 1-Click file restore, the restore point will be
mounted to the mount server associated with the repository.
Other Prerequisites
During guest file restore to the original location, you are prompted for the credentials to access the target
Windows server. Enter a user name and password; make sure that the account has sufficient access rights.
Non-Windows Server
Preparing Backup
You can restore files from a backup of a physical server created with or without indexing.
NOTE
Veeam Agent for Mac and Veeam Agent for Linux on Power do not support file system indexing.
1. Check for the following utilities to be installed on the server: mlocate, gzip, and tar. These utilities are
required for file indexing. When you enable file indexing, Veeam Agent will prompt you to deploy them in
case they are not found.
For more information, see the File System Indexing section of the following guides:
3. Run the backup job with guest file system indexing enabled.
4. Make sure the indexing data is imported to Veeam backup database, and catalog data replication is
completed successfully. For more information, see Performing Catalog Replication and Indexing.
Whether you restore from a backup with or without guest file indexing, prepare a machine to operate as a helper
host or helper appliance.
When you start guest OS file restore from Veeam Backup Enterprise Manager, the mount server settings are
obtained from the configuration database of the backup server. If no helper host or helper appliance
configuration is found for the user account, Veeam Backup & Replication uses the configuration set during the
latest file-level restore performed on the backup server. Thus, before you start file -level restore from
Enterprise Manager, make sure the mount server settings are configured on the backup server with which
Veeam Agent is integrated.
NOTE
If you plan to deploy multiple helper appliances to restore machines backed up by Veeam Agents
integrated with different backup servers, their initial configuration must be performed on the backup
servers. Centralized configuration from Veeam Backup Enterprise Manager is not supported.
Other Prerequisites
1. Make sure that the DNS name of the target (original) server where you plan to restore the files is resolved
properly.
2. During guest file restore to the original location, you are prompted for the credentials to access the target
server. Specify a user name and password or private key for the account with s ufficient access rights.
2. Select a necessary server. You can type in a server name or pick it from the list. Note that server icons
indicate server OSes.
3. If the server is backed up without guest indexing, click Mount Backup and wait for the process to
complete.
4. In the Restore point field in the top left corner of the Files tab, select a necessary date of backup and a
restore point. Note that the dates when backup of the selected server was performed are highlighted in
the calendar.
5. To search for a file, take the steps similar to the Searching for Guest OS Files in Machine Backups
procedure.
6. To restore a file, take the steps similar to the Performing 1-Click File Restore procedure.
File restore from backups of Veeam Agent for Mac, Veeam Agent for Oracle Solaris and Veeam Agent for
IBM AIX to the original location is not available.
IMP ORTANT
When restoring files to the original location, you are prompted for user credentials to the target machine.
Make sure the account you provide has sufficient access rights.
To restore application items, take the steps described in the following sections:
For encryption, Veeam Backup Enterprise Manager uses an Enterprise Manager keyset — a pair of matching keys:
• Public Enterprise Manager key encrypts storage keys on backup servers connected to Veeam Backup
Enterprise Manager.
• Private Enterprise Manager key decrypts storage keys in case a password for encrypted backup or tape is
lost.
To let Veeam Backup & Replication encrypt and decrypt data with Enterprise Manager keys, make sure
Enterprise Manager keys are enabled in Veeam Backup Enterprise Manager.
1. In Veeam Backup Enterprise Manager, open the Settings section of the Configuration view.
2. On the Key Management tab, select the E nable encryption password loss protection check box.
During Veeam Backup Enterprise Manager installation, the setup automatically generates an Enterprise Manager
keyset. You can perform the following operations with Enterprise Manager keysets using Enterprise Manager:
Enterprise Manager keys are created in the inactive state. To make the keys active and use them for encryption
and decryption, you need to activate the keys.
1. In Veeam Backup Enterprise Manager, open the Settings section of the Configuration view.
2. On the Key Management tab, in the Ma naged keys section, click Generate.
3. In the Hint field, enter a description for the created keyset. The keyset description will help you to
distinguish the created keyset in the list. Click the Generate button when ready.
• Public Enterprise Manager key is propagated to all Veeam backup servers connected to Veeam Backup
Enterprise Manager.
• Private Enterprise Manager key remains on Veeam Backup Enterprise Manager and marked as active.
1. In Veeam Backup Enterprise Manager, open the Settings section of the Configuration view.
2. On the Key Management tab, in the Ma naged keys section, select an inactive keyset in the list and click
Activate.
Note that manual activation can be performed for any keyset in the list (generated manually or automatically).
If you want your automatically generated keysets to be activated automatically upon crea tion, then you should
configure the retention policy settings. For more information, see Specifying Retention Settings for Enterprise
Manager Keyset.
NOTE
Lifetime of Enterprise Manager keys is controlled by a key retention period. The key retention period defines for
how long Enterprise Manager keys must remain in effect and must be used for encryption and decryption.
1. In Veeam Backup Enterprise Manager, open the Settings section of the Configuration view.
2. On the Key Management tab, in the Ma naged keys section, select the necessary options:
o If you want to set a retention period for Enterprise Manager keysets, select the Key retention period
check box and specify the number of weeks for which Enterprise Manager keys must remain in effect
(default is 4 weeks). After the retention period is over, and with key auto-generation is turned off, a
user will receive a notification email and should then manually create and activate a new keyset. After
a new keyset is ready, old keyset is marked as inactive.
o If you want Veeam Backup Enterprise Manager to automatically generate a new keyset, select the
Auto-generate new keys check box. After the current keyset expires, Veeam Backup Enterprise
Manager will automatically generate a new keyset and mark it as active. During the next data
synchronization session, Veeam Backup Enterprise Manager will propagate the newly created public
Enterprise Manager key to all connected Veeam backup servers. The private Enterprise Manager key
will remain on Veeam Backup Enterprise Manager and will be used for data decryption.
However, in some situations, a matching private Enterprise Manager key may be not available. This can happen,
for example, if your Veeam Backup Enterprise Manager database has failed or you use a new installation of
Veeam Backup Enterprise Manager and a new database. In this case, Veeam Backup Enterprise Manager will not
find a matching private Enterprise Manager key in the database and will be unable to unlock the backup or tape
encrypted with the public Enterprise Manager key.
You can create a backup copy of an Enterprise Manager keyset with the export operation in Veeam Backup
Enterprise Manager. The exported keyset is saved as a file of the PEM format and contains private and public
Enterprise Manager keys. You can save the exported keyset on the local disk or on a network share. An exported
keyset can be imported back to Veeam Backup Enterprise Manager any time you need.
To export a keyset:
1. In Veeam Backup Enterprise Manager, open the Settings section of the Configuration view.
2. On the Key Management tab, in the Ma naged keys section, select a keyset you want to back up and click
E x port.
3. Save the resulting PEM file on the local disk or in a network shared folder.
1. In Veeam Backup Enterprise Manager, open the Settings section of the Configuration view.
2. On the Key Management tab, in the Ma naged keys section, click Imp ort.
3. Click Browse next to the File field and select a previously exported keyset.
4. In the Hint field, Veeam Backup Enterprise Manager displays a hint that you provided when creating the
imported keyset.
When you import a keyset, it is saved to the Veeam Backup Enterprise Manager database and displayed in the
keyset list in Veeam Backup Enterprise Manager.
NOTE
An imported keyset has the Inactive state. You must activate it to be able to use the keys from the keyset
for backup encryption (for restore procedures, activation is not necessary). For more information, see
Activating Enterprise Manager Keyset.
Only keys in the Ina ctive state can be deleted. You cannot delete keys that are currently active.
To delete a keyset:
1. In Veeam Backup Enterprise Manager, open the Settings section of the Configuration view.
2. On the Key Management tab, in the Ma naged keys section, select the necessary keyset in the list and click
Delete Key.
IMP ORTANT
It is strongly recommended that you export a keyset before you delete it. If you delete a keyset and do not
make its backup copy, you will not be able to restore data from a backup or tape encrypted with keys from
this keyset in case a password is lost. For more information, see Exporting and Importing Enterprise
Manager Keyset.
To decrypt your data, use the P a ssword Recovery wizard within the following context:
1. In Veeam Backup & Replication, you generate a request message for password restore. For more
information, see the Create Request for Data Restore section of the Veeam Backup & Replication User
Guide.
2. In Veeam Backup Enterprise Manager, you start the P a ssword Recovery wizard by clicking the P a ssword
Recovery button in Configuration > Key Management , and insert the text of the request to the wizard.
3. Veeam Backup Enterprise Manager finds a matching public backup server key in Veeam Backup Enterprise
Manager database and decrypts the signature with this key.
4. The wizard decrypts storage keys with the private Enterprise Manager key available on Veeam Backup
Enterprise Manager, and generates a response. The response represents a text document and contains
decrypted storage keys. Consider that the response is also encrypted and can be used only on the backup
server where the request was issued.
5. Then you can send the response back to requester, for example, by email. The requester will input this
response to the Enterprise Keys Restore wizard on the Veeam backup server where the request was
issued; Veeam Backup & Replication will process the response, retrieve the decrypted storage keys and
use them to unlock encrypted backups or tapes and retrieve their content.
In case your organization encrypts configuration backups of a backup server, and you want to be able to
serve password restore request for these backups, ensure the original backup server and its public key
(used for configuration backup encryption) are present on the Enterprise Manager server by the moment
you receive such a request. Consider the following:
• If a backup server is removed from Enterprise Manager, its public key will be deleted from the
Enterprise Manager database.
• If a new configuration database is created on a backup server, then a new public key will be
automatically generated for that backup server on Enterprise Manager, replacing its existing key.
For details on Enterprise Manager keysets, encryption passwords and password restore, see the Data Encryption
section of the Veeam Explorers User Guide.
For more information, see Veeam Universal Application Item-Level Restore User Guide.
You can create a Virtual Lab request for VMs from the following sources:
• VM backups
• VM replicas
• Storage snapshots
3. To open the New Lab Request wizard, click the Create link in the top left corner.
4. At the La b Request step of the wizard, specify a name or IP address of the VM you need and other request
settings.
By default, lab usage duration is 30 minutes. If necessary, change this value. Optionally, specify a
description for your request.
If you want to display all restore points that are available for the selected backup, select the Show all
a vailable restore points check box.
By default, the list of jobs displays only those jobs that contain the selected machine. If you want to
display all SureBackup jobs that were created, select the Show a ll available SureBackup jobs check box.
IMP ORTANT
To work with lab requests, the user must have the Portal Administrator role assigned in Veeam Backup
Enterprise Manager. For more information, see Configuring Accounts and Roles.
To approve a lab request, select it in the list and click Ap p rove. Then follow the E d it Lab Request wizard steps:
1. At the La b Request step of the wizard, you can review and, if necessary, edit the virtual lab request (for
example, change the time interval for which the lab should be up). To edit vir tual lab request data, click
the E d it request link at the bottom.
2. At the Ba ckup step of the wizard, select a backup from which you want to restore items. Enterprise
Manager scans all Veeam backup servers connected to it, searches for all backups with the machine
specified at the previous step of the wizard, and displays these backups in the list.
3. At the Restore P oint step of the wizard, select the restore point when the application was in the desired
state. The list of restore points is formed depending on the choice the user made when submitting the
virtual lab request. For example, if the user selected the La st Friday night backup option when creating
the request, Enterprise Manager will display restore points created on the last Friday night, and a number
of restore points closest to the matching point. If you want to display all restore points that are available
for the selected backup, select the Show all available restore points check box.
4. At the SureBackup Job step of the wizard, select one of existing SureBackup jobs that you want to run to
create an isolated sandbox in which the selected machine should be started. The application group and
virtual lab used by this SureBackup job will be displayed in the Selected Job details section.
By default, the list of jobs displays only those jobs that contain the selected machine. If you want to
display all SureBackup jobs that were created, select the Show a ll available SureBackup jobs check box.
5. At the Summary step of the wizard, review the settings you have configured for the virtual lab and click
Finish. Veeam Backup & Replication will perform verification of the selected restore point.
If the specified SureBackup job is already running, Veeam Backup Enterprise Manager will check the resto re
point to which machines from the application groups are started. If the point does not correspond to the point
selected, Enterprise Manager will display a warning. In this case, you may need to start the SureBackup job to an
earlier point in time to make sure the items you need are available there. To do this, open Veeam Backup &
Replication console, and right-click the necessary SureBackup job and select Sta rt job to from the shortcut
menu.
If the SureBackup job is not running, Enterprise Manager will launch the selected SureBackup job, start the
virtual lab and run the machine with the necessary application to the restore point selected.
To define what VMs vSphere users can back up and restore, Veeam Backup Enterprise Manager offers the
concept of delegation mode. The delegation mode specifies conditions that must be met to allow a user to add a
VM to the backup job. The administrator can choose from 3 delegation modes based on vSphere tags, vSph ere
roles or VM privileges. For more information, see Configuring Delegation Mode.
In terms of vSphere Self-Service Backup Portal, a vSphere user that works with the portal is considered a tenant.
To access the portal, a tenant uses the tenant account created by the Enterprise Manager administrator. The
administrator can create tenant accounts for a separate vSphere user and a group of users. Tenant account
settings define storage quota available to the tenant in the backup rep ository and settings for backup jobs
created by the tenant. For more information, see Managing Tenant Accounts.
To simplify backup job management for tenants, advanced job settings (such as backup settings and storage
settings) are automatically populated from job templates. The administrator can assign a separate template to
each tenant account.
When working with vSphere Self-Service Backup Portal, you can perform the following tasks:
• Administrator tasks
• Tenant tasks
Administrator Tasks
To let tenants work with vSphere Self-Service Backup Portal, the Enterprise Manager administrator performs the
following tasks:
The default delegation mode allows tenants to access VMs with the [Link]
privilege. The administrator can change the delegation mode, if necessary.
By default, Veeam Backup Enterprise Manager offers a group tenant account for users of the domain that
includes the Enterprise Manager server. Each user can access the portal and use a 30 GB quota on the
default backup repository to create VM backups. Users can create backup jobs with default advanced
settings and custom schedule. The administrator can edit settings of the default account and create other
accounts to configure granular access to storage quotas and backup settings.
Tenant Tasks
Tenants access the vSphere Self-Service Backup portal using the portal URL obtained from the Veeam Backup
Enterprise Manager administrator. Tenants can log in to the portal under a domain user account or single sign-
on account. For more information, see Using vSphere Self-Service Backup Portal.
Tenants can use the portal to work with vSphere VMs that are available to them according to the selected
delegation mode. VM backup settings are defined by the properties of the tenant account.
• Restore files from indexed and non-indexed guest OS file systems of vSphere VMs.
• Perform item-level restore for Microsoft SQL Server and Oracle databases.
Before you configure the delegation mode, make sure the following requirements are met:
• If you have configured a single sign-on service to access vSphere Self-Service Backup Portal, you must use
the delegation mode based on vSphere tags only. For more information on single sign-on, see SAML
Authentication Support.
• The vSphere tab is not displayed if all your vCenter Servers are added as part of VMware Cloud Director
infrastructure and you do not have any tenant accounts that were previously added for one of the VMware
vCenter Servers.
• If you change the delegation mode when tenants already work with vSphere Self -Service Backup Portal,
tenants can lose access to VMs that were available to them according to the original delegation mode.
Make sure that the necessary tags, roles or privileges are configured in VMware vSphere.
2. To open the Configuration view, click Configuration in the top right corner.
The Self-service section is available if you have added to Enterprise Manager at least one backup server
with a vCenter Server as part of its infrastructure.
4. If a VMware Cloud Director server is added to your backup infrastructure, make sure that the vSp here tab
is selected.
o vSp here tags — to allow tenants to work with VMs to which the specified tags are assigned. If you
select this option, you must specify the necessary tags in the properties of the tenant account. You
can specify tags for each tenant account individually. For more information, see Adding Tenant
Account and Editing Tenant Account.
NOTE
To enable your tenants to restore entire VMs to a new location, you must assign the specified
tags to all VMware vSphere parent objects in the target location, including the host, VM folder,
resource pool, datastore and network.
o vSp here role — to allow tenants to work with VMs that are available to the specified vSphere role.
Alternatively, if you have already selected a role before, click the name of the currently selected
role.
ii. In the Select Role window, select the required vSphere role.
i. In the VM p rivilege field, click the name of the currently selected privilege. By default, the
[Link] privilege is selected.
* For more information on the single sign-on capability, see SAML Authentication Support.
NOTE
You cannot create a vSphere Self-Service Backup Portal tenant account for a local user account.
Veeam Backup Enterprise Manager administrators can perform the following tasks with the tenant accounts:
• If you plan to provide a user with access to vSphere Self-Service Backup Portal only, and not to the main
Enterprise Manager UI, you do not need to configure an account for this user on the Roles tab of the
Configuration view.
• The vSphere tab is not displayed if all your vCenter Servers are added as part of VMware Cloud Director
infrastructure and you do not have any tenant accounts that were previously added for one of the vCenter
Servers.
2. To open the Configuration view, click Configuration in the top right corner.
The Self-service section is available if you have added to Enterprise Manager at least one Veeam backup
server with a vCenter Server as part of its infrastructure.
4. If a VMware Cloud Director server is added to your Veeam backup infrastructure, make sure that the
vSp here tab is selected.
5. Click Ad d .
6. From the Ty p e drop-down list, select a type of the account: User, Group , External User or External Group .
For more information, see Managing Tenant Accounts.
7. In the Account field, specify an account name in the DOMAIN\Username or Username@Suffix format
depending on the account type. For more information, see Managing Tenant Accounts.
You cannot create a vSphere Self-Service Backup Portal tenant account for a local user account.
8. From the Rep ository drop-down list, select a target repository that will contain VM backups created by
the tenant. The list includes repositories configured on Veeam backup servers added to Veeam Backup
Enterprise Manager.
Backup repository settings specified at this step will take priority over backup repository settings
prescribed by the selected job template.
NOTE
You cannot assign to tenants Veeam Cloud Connect repositories, as well as NetApp or Nimble
storage systems storing snapshots created by Veeam snapshot-only jobs.
9. In the Quota field, specify the repository storage quota for the tenant account. Choose GB or TB from the
drop-down list and enter the required quota size.
10. From the Job scheduling drop-down list, select how the job scheduling will be organized. The following
options are available:
o Deny: Creates daily jobs with randomized start time within the backup window
For tenant backup jobs, the backup window is defined by backup window settings specified in Veeam
Backup Enterprise Manager. Backup window settings specified for the job template that you will
select at the step 12 do not affect tenant jobs. For information on how to specify the backup window
in Enterprise Manager, see Customizing Dashboard Chart.
11. From the Job priority drop-down list, select a normal or high priority for backup jobs of the tenant.
12. If you have multiple vCenter Servers in your infrastructure and want to provide the tenant account with
access to VMs of specific vCenter Servers only, from the vCenter scope drop-down list, select the
necessary vCenter Servers. By default, the All vCenter Servers options is selected.
13. If you have selected the delegation mode that is based on vSphere tags, in the vSp here tags field, specify
tags assigned to VMs that will be available to the tenant.
b. In the Ad vanced job settings section, view the currently used backup job settings.
c. From the Cop y from list, select the advanced settings that you want to apply to tenant jobs. For more
information on the specific settings, see the Specify Advanced Backup Settings section of the Veeam
Backup & Replication User Guide.
▪ Select Default settings to use the default advanced settings as they are shown in the
Veeam Backup & Replication console. This option is applied by default.
▪ Select <Job name> to use the advanced settings of an existing backup job as a template for
tenant backup jobs. When a tenant creates a backup job on the vSphere Self -Service Backup
Portal, Enterprise Manager will copy the advanced settings from the template and apply them
to the job.
Note that, in the Cop y from list, Enterprise Manager displays only VMware vSphere backup jobs
that are configured in advance on a backup server added to Enterprise Manager.
Consider the following recommendations for modifying tenant account settings for vSphere Self -Service Backup
Portal:
• Make sure to establish a proper connection between the backup server and Enterprise Manager server.
Otherwise, the changes of the tenant account settings will not be saved to the configuration database.
• If you plan to modify job template for a tenant account, remember that the new settings will be applied
only to the new jobs created by the tenant; the changes will not affect existing jobs.
• If you want an existing backup job to create backups in another backup repository instead of the
repository that is currently specified in the properties of the tenant account, do the following:
a. In Veeam Backup Enterprise Manager, specify the new backup repository in the properties of the
tenant account.
c. In Veeam Backup & Replication, specify the new backup repository in the properties of tenant backup
jobs.
Otherwise, tenant backup jobs will continue creating backups in the former repository.
2. To open the Configuration view, click Configuration in the top right corner.
The Self-service section is available if you have added to Enterprise Manager at least one Veeam backup
server with a vCenter Server as part of its infrastructure.
4. If a VMware Cloud Director server is added to your Veeam backup infrastructure, make sure that the
vSp here tab is selected.
6. In the E d it window, edit tenant account settings as required. For more information, see Adding Tenant
Account.
To generate a report:
2. To open the Configuration view, click Configuration in the top right corner.
The Self-service section is available if you have added to Enterprise Manager at least one Veeam backup
server with a vCenter Server as part of its infrastructure.
4. If a VMware Cloud Director server is added to your Veeam backup infrastructure, make sure that the
vSp here tab is selected.
2. To open the Configuration view, click Configuration in the top right corner.
The Self-service section is available if you have added to Enterprise Manager at least one Veeam backup
server with a vCenter Server as part of its infrastructure.
4. If a VMware Cloud Director server is added to your Veeam backup infrastructure, make sure that the
vSp here tab is selected.
6. Click Remove.
o To delete backup jobs created by the tenant, select the Delete jobs check box.
o To delete all backups created by the tenant, select the Delete backup files check box.
If four-eyes authorization is enabled on the backup server, backup files will remain in the backup
repository and become orphaned.
Accessing Portal
To access vSphere Self-Service Backup Portal:
1. Open your web browser and enter the following address in the address bar:
[Link]
For example:
[Link]
2. From the drop-down list, select a language that you want to use as the display language.
i. In the Username and P a ssword fields, specify credentials of the domain user for which the
Enterprise Manager administrator created a vSphere Self-Service Backup Portal tenant account.
The username must be provided in the DOMAIN\Username format.
ii. To save the entered credentials for future access, select the Rema in signed in option.
o To log in with single sign-on, click Use Single Sign-On ( SSO). You will be redirected to the login
webpage of the single sign-on service. Complete the sign-in procedure on the login page. If the
account is already authenticated in the single sign-on service, you will immediately access the
Enterprise Manager website.
NOTE
The Use Single Sign-On (SSO) option is available if SAML authentication is configured for Veeam
Backup Enterprise Manager. For more information, see Configuring SAML Authentication
Settings.
• View statistics on backups of vSphere VMs. For more information, see Viewing Self-Service Backup Portal
Statistics.
• Work with backup jobs that process vSphere VMs: create and edit backup jobs; examine and export backup
job session data; start, stop and retry backup jobs. For more information, see Managing Backup Jobs.
• Perform backup and restore operations with vSphere VMs. For more information, see Managing VMs.
• Search for files in guest file systems of backed-up VMs and restore the necessary files to the original
location or download them to a local machine. For more information, see Restoring Guest OS Files.
• Perform item-level restore of Microsoft SQL Server and Oracle databases. For more information, see
Restoring Application Items.
NOTE
If the Veeam Backup Enterprise Manager server is added to the Veeam ONE monitoring scope, the restore
operations performed with vSphere Self-Service Backup Portal are included in the Restore Operator
Activity report available in Veeam ONE.
• VMs — number of VMs successfully processed during the selected period. At least one restore point was
created for these VMs.
• Temp lates — number of virtual machine templates successfully protected during the specified period.
• Sta tus — status of the backup storage assigned to the user: Green — more than 10% of storage space is
free; Yellow — less than 10% of storage space is free; Red — no free space on backup storage.
The La st 24 hours / La st 7 days block reports on job session results for the selected period.
To visualize on-going job data, the Da shboard tab also comprises a graph showing time and date when jobs were
performed, and the network throughput rate during the job.
IMP ORTANT
• For the vSphere Self-Service Backup Portal tenants, job cloning is not available.
• In vSphere Self-Service Backup Portal, you cannot create and edit jobs managed by backup servers
of earlier major or minor versions. For example, after you upgrade Enterprise Manager to version
12.3, you will not be able to create and edit jobs managed by a backup server with ver sion 12.0. To
resolve the issue, upgrade the backup server as well.
1. Open the Job s tab of vSphere Self-Service Backup Portal and click Create.
For more information, see the Retention Policy section of the Veeam Backup & Replication User Guide.
3. At the Virtual Machines step of the wizard, select which vSphere VMs the job will process. For more
information, see Edit the List of Virtual Machines.
4. At the Guest Processing step of the wizard, select the guest OS processing options and guest OS
credentials. For more information, see Configure Guest Processing Settings.
5. At the Job Schedule step of the wizard, configure the backup job scheduling options. For more
information, see Schedule the Job.
You can configure backup job scheduling options only if the Enterprise Manager administrator allowed this
in the properties of the tenant account. For more information, see Adding Tenant Account.
6. At the E ma il Notifications step of the wizard, select the E na ble e-mail notifications check box and
configure notification settings:
b. [Optional] In the Sub ject field, specify the subject for notification emails.
c. Select Notify on success to receive an email notification when the job completes successfully.
e. Select Notify on error to receive an email notification when the job fails.
f. 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.
7. Click Finish.
The backup job will create backups in the backup repository that the Enterprise Manager administrator selected
as the target repository in the properties of the tenant account. Advanced job settings such as the backup
settings and storage settings will be obtained from the job template assigned to the tenant by the
administrator. For more information, see Editing Tenant Account.
2. In the working area, select the job you want to edit and click E d it.
3. In the E d it window, edit backup job settings as required. You will follow the same steps as you have
followed when creating the job. For more information, see Creating Backup Job.
4. In the working area of the Job s tab, select the job you want to delete.
5. Click Delete.
6. You will be prompted to delete backup files. To delete backup files, select the Delete backup files check
box and click Y es to confirm the operation.
If four-eyes authorization is enabled on the backup server, backup files will remain in the backup
repository and become orphaned.
• Restore VM disks
• Delete VMs
NOTE
If your delegation mode is set to vSphere tags , the required tags must be assign to all VMware vSphere
parent objects in the target location, including the host, VM folder, resource pool, datastore and network.
For details on delegation modes, see Configuring Delegation Mode.
1. On the VMs tab, select a VM that you want to restore. You can also use the search field to search for the
necessary VM by its name.
3. Follow the steps of the E ntire VM Restore wizard. For details, see Restoring Entire VM to VMware
vSphere.
1. On the VMs tab, select a VM that you want to recover. You can also use the search field to search for the
necessary VM by its name.
3. Follow the steps of the Instant Recovery to VMware vSphere wizard. For details, see Instant Recovery to
VMware vSphere.
1. On the VMs tab, select a VM whose disks you want to restore. You can also use the search field to search
for the necessary VM by its name.
3. Follow the steps of the Virtual Disk Restore wizard. For details, see Virtual Disk Restore.
When you delete a VM, Enterprise Manager removes records about the VM from the UI and configuration
database. In addition, Enterprise Manager removes data of the deleted VM from the backup .
NOTE
If four-eyes authorization is enabled on the backup server, you cannot delete a VM backup using either the
portal or Enterprise Manager.
1. On the VMs tab, select a VM. To quickly find the necessary VM, use the search field at the top of the
window.
2. Click Delete.
To restore guest OS files, follow the steps described in Performing 1-Click File Restore.
NOTE
• When you restore from non-indexed guest OS file system, mount operation is performed using
mount server associated with the backup repository that stores the backup file.
• Before you restore files from a non-Windows VM, make sure that a helper host or helper appliance is
configured on the backup server. For more information, see Preparing for File Search and Restore
(non-Windows machines).
In particular, vSphere administrators can view success, warning and failure counts for all jobs, as well as
cumulative information on used and available storage space, and statistics on processed VMs. They can easily
identify unprotected VMs and perform capacity planning, as well as create restore points for selected VMs using
VeeamZIP and Quick Backup functions, all directly from vSphere Client.
Veeam Backup Enterprise Manager offers the following configurations of the vSphere Client plug -in:
• For vSphere Client 7.0.0 or earlier, the plug-in is installed locally on the vCenter Server. For more
information, see Local vSphere Client Plug-in.
o For vSphere Client versions 6.0 – 6.5, the plug-in is available with the flex/flash interface.
o For vSphere Client versions 6.7 – 7.0.0, the plug-in offers HTML5 user interface. The earlier versions
of the client do not support HTML5.
• For vSphere Client versions 7.0.1 or later, the plug-in is installed remotely on the Veeam Backup
Enterprise Manager server. For more information, see Remote vSphere Client Plug-in.
For more information on VMware vSphere Client, see the vCenter and Host Management section of the VMware
vSphere documentation.
Before you install the plug-in, make sure the following requirements are met:
o For vSphere Client 7.0.0 or earlier, the plug-in is installed locally on the VMware vCenter Server. For
more information, see Local vSphere Client Plug-in.
▪ For vSphere Client versions 6.0 – 6.5, the plug-in is available with the flex/flash interface.
▪ For vSphere Client versions 6.7 – 7.0.0, the plug-in offers HTML5 user interface. The earlier
versions of the client do not support HTML5.
o For vSphere Client versions 7.0.1 and later, plug -in is installed remotely on the Veeam Backup
Enterprise Manager server. For more information, see Remote vSphere Client Plug-in.
For more information, see the Adding VMware vSphere Servers section of the Veeam Backup & Replication
User Guide.
• The backup server that contains the vCenter Server in its infrastructure must be connected to Enterprise
Manager.
• The Enterprise Manager server must be able to resolve the FQDN of the vCenter S erver and must have
access to the vCenter Server over HTTPS. In particular, this is necessary if the plug -in uses the default
vCenter Single Sign-On for authentication.
• Account used to install the plug-in must have sufficient access rights for vCenter Server:
The account must belong to the same domain as the vCenter Server in case of cross -domain access.
• Note that when accessing VMware vSphere Client, you must enter the vCenter Server FQDN (or IP
address) that you specified when adding the vCenter Server to the backup server infrastructure. This
FQDN is stored in the configuration database and used to authenticate the vCenter Server. vC enter Server
alias names are not supported.
1. Log in to Veeam Backup Enterprise Manager using an account with the Portal Administrator role.
4. Select the vCenter Server you need, and click Check version.
5. In the W eb Client Plug-in window, enter a user name and password to connect to the vCenter Server, and
specify a connection port (default port is 443). Veeam Backup Enterprise Manager will use these
credentials to access the vCenter Server and check if Veeam plug -in has been already installed there. If
discovered, the plug-in version will be displayed in the P lug-in Version column.
6. If the connection to vCenter Server is successful, and the plug -in has not been installed yet, then the
Install link will become active. Click it to install the plug-in.
7. After installation, the plug-in will be displayed in the list of vCenter Servers and plug -ins.
1. Log in to Veeam Backup Enterprise Manager using an account with the Portal Administrator role.
NOTE
For details on reinstalling the local vSphere Client plug -in (the plug-in installed on the vSphere Client 7.0
or earlier), see this Veeam KB article.
When using the plug-in, consider that authentication process includes the following stages:
1. A user logs in to VMware vSphere Client. To work with the VMware vCenter Server where Veeam plug -in
runs, this user account requires the following minimal privileges on the vCenter level:
[Link] , [Link], [Link].
2. Veeam plug-in connects to Veeam Backup Enterprise Manager which verifies its account. You can
configure Veeam plug-in to use the account currently logged in, or to use specific account for that
connection. For details, see the procedure description below.
Whatever account is used, it must have sufficient security permissions to perform the necessary backup
operation (VeeamZIP or Quick Backup). The permissions are granted by assigning a security role — Portal
Administrator or Portal User. For more information, see Configuring Accounts and Roles.
Make sure, the account used to connect to the Veeam Backup Enterprise Manager server and (optionally) Veeam
ONE server has required permissions.
• To successfully obtain statistics from Veeam Backup Enterprise Manager, the accounts used to connect to
Enterprise Manager (that is, the account currently logged in to the vSphere Client, or spe cific account
configured in the plug-in settings) must have an Enterprise Manager role.
o To create a VeeamZIP backup or Quick Backup, the Portal Administrator or Portal User role is required.
For more information on Enterprise Manager roles, see Configuring Accounts and Roles.
• If you have Veeam ONE deployed in your environment and you want to open Veeam ONE rep orts from the
plug-in (optional capability), the accounts used to connect to Enterprise Manager must be also included in
the Veeam ONE Power Users , Veeam ONE Read-Only Users or Veeam ONE Administrators group on the
machine where Veeam ONE Server is installed. For more information, see the Security Groups section of
the Veeam ONE Deployment Guide.
1. To open Veeam plug-in for vSphere Client, launch the vSphere Client and select Veeam Backup &
Rep lication from the menu.
2. On the Settings tab, check the plug-in version and specify the following Veeam Backup Enterprise
Manager connection properties:
o Thumbprint of the certificate used to connect to Veeam Backup Enterprise Manager REST API
TIP
You can get the connection properties on the Veeam Backup Enterprise Manager website. To do this,
log in to the website with a Portal Administrator account and go to Configuration > Ab out. For more
information, see Viewing Information About Enterprise Manager.
3. If you plan to connect to Enterprise Manager using a specific account, select the P a ssword based
a uthentication option and provide a user name and password. If this option is not selected, connection to
Enterprise Manager will be performed using the account currently logged in.
Make sure the account intended for connection to Enterprise Manager has the Portal Administrator or
Portal User role assigned. For more information, see Configuring Accounts and Roles.
4. [Optional] If you have Veeam ONE deployed in your environment and you want to open Veeam ONE
reports from the plug-in, specify the Veeam ONE server name and connection port. Default is HTTP
port 1239.
In this case, the account intended for connection to Enterprise Manager must be also a member of the
Veeam ONE Power Users , Veeam ONE Read-Only Users or Veeam ONE Administrators group on the
machine where Veeam ONE Server is installed. For more information, see the Security Groups section of
the Veeam ONE Deployment Guide.
Next to the list, there are three key indicators that inform you how the VMs were protected during the specified
period:
• Successful VM backups
• Failed VMs
In the dashboard pane under the summary information, you can explore backup infrastructure in more details.
• The VMs overview widget gives you the information on how your VMs are protected: number of protected
VMs (backed up or replicated), number of restore points a vailable, source VM size, full and incremental
backup size, replica restore point size, and successful backup sessions ratio. To maximize the widget, click
the Full screen icon in the widget’s top right corner; to change reporting period, click the gear icon and
select the time period you need:
o Last 24 hours
o Last 7 days
o Last 14 days
Additionally, if Veeam ONE is installed, you can click the link and examine the P rotected VMs report that
provides a list of VMs which are protected by Veeam Backup & Replication, and which are not.
• In the Job s statistics widget, all running jobs are displayed, as well as scheduled jobs and max job
duration. Additionally, if Veeam ONE is installed, you can click the link and examine the La test BU Job
Sta tistics report.
• In the Rep ositories widget, detailed information for each backup repository is displayed, including
repository name, overall capacity, free space and backup size. Additionally, if Veeam ONE is installed, you
can click the link and examine the Ca pacity P lanning for Repositories report. It gives you an estimation of
when the repositories may run out of space.
4. In the Destination section, select the Veeam backup server to process the VM and the repository where to
store the VeeamZIP file.
NOTE
To be visible in this list, Veeam backup server should be added to Veeam Backup Enterprise Manager.
Connected repositories from Veeam backup infrastructure will be shown automatically.
6. In the Delete this backup automatically section, specify whether the resulting backup file should be
automatically deleted after a certain time interval.
7. In the Compression level section, select the necessary compression level for the backup.
8. By default, the Disable guest quiescence option is selected, meaning that guest OS quiescence is
deactivated. So, if you want a crash-consistent backup, leave it that way.
If you want, however, an application-consistent backup, then clear the Disable guest quiescence check
box, and Veeam will create a transactionally consistent image of VMs using VMware Tools quiescence for
guest OS.
NOTE
For more information about guest OS quiescence, see the Transaction Consistency section of the Veeam
Backup & Replication User Guide.
o Select Ba ckup > VeeamZIP if you want to create a backup using the default VeeamZIP settings
specified earlier. Alternatively, use the Actions > Ba ckup > VeeamZIP option.
Veeam will start the VeeamZIP backup process using the default VeeamZIP settings.
o Select Ba ckup > VeeamZIP to if you want to create a backup with new VeeamZIP settings.
Alternatively, use the Actions > Ba ckup > VeeamZIP to option.
If you select this option, Veeam plug-in will display the VeeamZIP to window offering to specify
VeeamZIP settings. Specify settings in the same way as described in the Configuring VeeamZIP
Settings section and click VeeamZIP. Veeam will save the specified settings as default settings for
VeeamZIP backup and start the VeeamZIP backup process.
You can view the backup creation progress in the Recent Tasks pane of vSphere Client.
A VeeamZIP backup job fails to start if the Location property of the VM and backup repository do not
match — for example, if you try to use a repository with location set to Sydney to back up a VM with
location set to Helsinki. To read more about location settings, refer to the Veeam Backup & Replication
User Guide.
You can perform quick backup for any VM that meets the following requirements:
1. A backup job processing the VM exists on the Veeam backup server which is added to Veeam Backup
Enterprise Manager.
2. Right-click the VM and select Quick Backup. Alternatively, you can use the Actions menu command.
This will trigger a backup job processing the selected VM to create a new incremental restore point (VIB file) for
the latest full backup found in the repository for this VM. Details of a running quick backup task can be seen in
the Recent Tasks pane on the right.
To learn more about VeeamZIP and Quick Backup, refer to the Veeam Backup & Replication User Guide.
NOTE
A quick backup job fails to start if the Location property of the VM and backup repository do not match —
for example, if you try to use a repository with location set to Sydney to back up a VM with location set to
Helsinki. To read more about location settings, refer to the Veeam Backup & Replication User Guide.
When using the plug-in, consider that authentication process includes the following stages:
1. A user logs in to VMware vSphere Client. To work with the Veeam Plug -in, this user account must be a
member of the vCenter Server role that is paired with an Enterprise Manager role. For more information on
assigning Enterprise Manager roles, see Configuring VMware vSphere Roles.
2. Veeam Plug-in connects to Veeam Backup Enterprise Manager, and Veeam Backup Enterprise Manager
verifies the user account. The account must have sufficient security permissions to perform the necessary
backup operation (VeeamZIP or Quick Backup).
Make sure, the account used to access the plug-in has permissions to connect to the Veeam Backup Enterprise
Manager server and (optionally) Veeam ONE server.
• To launch the plug-in and successfully obtain statistics from Veeam Backup Enterprise Manager, you need
to pair a vCenter Server role with an Enterprise Manager role. Then you can use an account with this
vCenter Server role to log in to the vSphere Client and access the plug -in. For more information on
assigning Enterprise Manager roles, see Configuring VMware vSphere Roles.
o To create a VeeamZIP backup or Quick Backup, the Portal Administrator or Portal User role is required.
• If you have Veeam ONE deployed in your environment and you want to open Veeam ONE reports from the
plug-in (optional capability), the accounts used to log in to the vSphere Client must be also included in the
Veeam ONE Power Users , Veeam ONE Read-Only Users or Veeam ONE Administrators group on the
machine where Veeam ONE Server is installed. For more information, see the Security Groups section of
the Veeam ONE Deployment Guide.
• P rotection Status — statistics on the status of VM backup and replication jobs for the last 24 hours.
o VMs with Warnings — number of VMs that were backed up or replicated with a warning
o Fa iled VMs — number of VMs that were backed up or replicated with an error
• E rrors and Warnings — statistics on backup and replication sessions that completed with a warning or error
for the last 24 hours.
• VMs Overview — statistics about all available VMs for the last 24 hours and last month.
o Not p rotected VMs — number of VMs that were not backed up or replicated
• Rep ositories — information about backup repositories, including repository name, type, overall capacity,
backup size and free space.
• Active Sessions — statistics about all active backup and replication sessions for all vCenter Server VMs.
3. On the Configure tab, select Veeam Plug-in for VMware vSphere Client > VeeamZIP.
Alternatively, you can right-click the VM and select Veea m Web Client plug-in > VeeamZIP.
4. In the Destination section, select the Veeam backup server that will process the VM and the repository
where to store the VeeamZIP file.
The plug-in displays Veeam backup servers added to the Veeam Backup Enterprise Manager infrastructure
and backup repositories created in the backup infrastructure of these backup servers.
6. In the Delete this backup automatically section, specify whether the resulting backup file should be
automatically deleted after a certain time interval.
7. In the Compression level section, select the necessary compression level for the backup.
8. By default, the Disable guest quiescence option is selected, meaning that guest OS quiescence is
deactivated. If you want a crash-consistent backup, leave it that way.
If you want, however, an application-consistent backup, then clear the Disable guest quiescence check
box, and Veeam will create a transactionally consistent image of VMs using VMware Tools quiescence for
guest OS.
For more information about guest OS quiescence, see the VMware Tools Quiescence section of the Veeam
Backup & Replication User Guide.
2. In the inventory tree, right-click the VM that you want to back up and select Veea m Web Client plug-in >
VeeamZIP.
If you have not configured VeeamZIP settings, specify the settings in the VeeamZIP window in the same
way as described in the Configuring VeeamZIP Settings.
You can view the backup creation progress in the Recent Tasks pane of vSphere Client.
NOTE
A VeeamZIP job fails to start if the Location property of the VM and backup repository do not match — for
example, if you try to use a repository with location set to Sydney to back up a VM with location set to
Helsinki. To read more about location settings, refer to the Veeam Backup & Replication User Guide.
You can perform quick backup for any VM that meets the following requirements:
• A backup job processing the VM exists on the backup server that is added to Veeam Backup Enterprise
Manager.
3. Right-click the VM and select Veeam Plug-in for VMware vSphere Client > Quick Backup.
This will trigger a backup job processing the selected VM to create a new incremental restore point (VIB file) for
the latest full backup found in the repository for this VM. Details of a running quick backup task can be seen in
the Recent Tasks pane on the right.
NOTE
A quick backup job fails to start if the Location property of the VM and backup repository do not match —
for example, if you try to use a repository with location set to Sydney to back up a VM with location set to
Helsinki. To read more about location settings, refer to the Veeam Backup & Replication User Guide.
Cloud Director service providers can allow their customers to perform self-service restore operations in the web
UI based on Veeam Backup Enterprise Manager.
• Service provider administrators have administrative rights in Veeam Backup Enterprise Manager. Thus,
they have access to the Configuration view of Enterprise Manager where they can create Cloud Director
organization configurations, including repository quota and backup job template. These administrators
typically have access to Veeam Backup & Replication console that controls VMware Cloud Director as part
of backup infrastructure on the provider side.
• Members of Cloud Director organizations do not need ad ministrative rights for Veeam Backup Enterprise
Manager — instead, they get access to Veeam Self-Service Backup Portal. There they can manage their
Cloud Director jobs, as well as restore VMs, files and application items within their scope.
How It Works
Veeam Backup Enterprise Manager uses native VMware Cloud Director authentication to authorize users that log
in to Enterprise Manager. The authentication process and components interactions are shown in the figure
below.
• Configure settings for their tenants (Cloud Director organizations), includ ing backup job templates to be
used, backup destination, and repository quota.
• Restrict job scheduling for particular tenants, for example, prevent the jobs from running too often.
Administrators can even prohibit the tenant's ability to schedule jobs completely, instead setting the
required schedule themselves (manually or using a script).
These capabilities and the built-in load balancing allow administrators to ensure infrastructure is protected from
excessive resource consumption.
• Create new backup jobs for objects in their scope, based on the predefined templates. Organization
members are allowed to configure essential job settings (such as VMs to back up, retention, schedule,
notifications, and guest OS processing options).
• Restore Cloud Director VMs to the original vApps and vApps to the original VDC.
• Perform application item restore for SQL Server and Oracle databases.
• Restore files from indexed and non-indexed VMs guest file system.
To simplify job management for tenants, advanced job parameters (like backup mode and repository settings)
are automatically populated from the job templates. These templates are assigned by the service provider
administrator to the particular organization.
You can perform the following operations with Cloud Director organizations:
Before you manage Cloud Director organization configurations, check the following prerequisites:
2. All Cloud Director servers must be added to the backup infrastructure of backup servers.
For more information, see the Adding VMware Cloud Director section of the Veeam Backup & Replication
User Guide.
3. Backup servers that contain the Cloud Director servers in their infrastructure must be connected to
Enterprise Manager. Make sure that the version of Veeam Backup & Replication installed on the backup
server matches the version of Enterprise Manager.
4. Enterprise Manager must complete data collection from the ad ded backup server.
5. The account that you will use to manage Cloud Director organization configurations must be assigned the
Portal Administrator role.
Members of Cloud Director organizations can access Veeam Self-Service Backup Portal by the following portal
URLs:
• Full URL that contains the host address where the necessary Cloud Director server resides:
[Link]
In this case, Veeam Self-Service Backup Portal will open right after clicking the Sig n in button.
• Shorter URL that does not contain the host address where the necessary Cloud Director server resides:
[Link]
In this case, after clicking the Sig n in button, Veeam Self-Service Backup Portal will prompt to select a
Cloud Director host from the list of available Cloud Director hosts.
When calculating used quota, Veeam Backup Enterprise Manager takes into account the data compression and
deduplication performed by Veeam Backup & Replication. However, any 3rd party compression and
deduplication performed after the data is transferred to the repository (for example, by ReFS or XFS file
systems, or by cloud services) does not affect the used quota calculation.
The used quota is recalculated every time any of the organization's jobs runs. Note if backup files are removed
from a backup repository, either manually or due to retention, the used quota will be recalculated only after one
of the organization's jobs completes.
NOTE
• Replication jobs and CDP policies do not consume storage quota of backup repositories because
replicas are stored on the target VMware Cloud Director VDC. If you want to set a quota for replicas,
configure storage policies of the target VDC.
• Quota calculation is not currently supported for capacity and archive tiers of scale -out backup
repositories.
You can also manually copy or move an organization backup from one backup repository to another. You may
need to move some backups to another repository, for example, if the quota limit of one of the organization
repositories is reaching. When you copy or move a backup to another repository, the used quota will be
recalculated. For more information on copying and moving backups, see the Copying Backups and Moving
Backups sections of the Veeam Backup & Replication User Guide. Before you copy or move an organization
backup, make sure that the organization has access to the target repository. To provide the access, add a new
organization configuration for this repository. For details, see Adding Organization Configuration.
Veeam Backup Enterprise Manager offers a default configuration that you can use for Cloud Director
organizations. The configuration is applied to each organization that does not have a specific configuration
added for it.
• Quota — 1 TB
• Job scheduling — Allow: Tenant has full access to all job scheduling
You can specify multiple repositories per organization. In this case, users of Veeam Self-Service Backup Portal
will be able to select a backup repository when configuring their jobs. For details, see Creating Jobs. To specify
multiple repositories per organization, add a separate configuration for each repository.
6. From the VMware Cloud Director server drop-down list, select a VMware Cloud Director server you need.
The field is available if you have multiple Cloud Director servers in the Enterprise Manager infrastructure.
7. From the Organization drop-down list, select an organization you need. The list contains organizations
from the selected Cloud Director server processed by the backup server that is added to Enterprise
Manager.
8. From the Rep ository drop-down list, select a repository that will be used for backups. The list includes
repositories configured on backup servers that has a Cloud Director server added to its infrastructure.
You cannot assign cloud-based repositories, as well as NetApp or Nimble storage systems storing
snapshots created by snapshot-only jobs.
9. In the Friendly name field, specify a repository name that will be displayed to organization members.
10. In the Quota section, specify a repository storage quota. You can choose GB or TB from the drop -down list
and enter the required quantity. For details on the quota usage see About Organization Quota.
11. From the Job scheduling drop-down list, select one of the following options:
c. Deny: Creates daily jobs with randomized start time within the backup window
For backup jobs of Cloud Director organizations, the backup window settings are specified in Veeam
Backup Enterprise Manager. Backup window settings specified for the job template that you will
select from the advanced job settings do not affect organization jobs. For information on how to
specify the backup window in Veeam Backup Enterprise Manager, see Customizing Dashboard Chart.
12. Specify advanced settings for backup jobs of the Cloud Director organization.
c. From the Cop y from list, select the advanced settings that you want to apply to backup jobs of the
Cloud Director organization. For more information on the specific settings, see the Specify Advanced
Backup Settings section of the Veeam Backup & Replication User Guide.
▪ Select Default settings to use the default advanced settings as they are shown in the
Veeam Backup & Replication console. This option is applied by default.
▪ Select <Job name> to use the advanced settings of an existing backup job as a template. When
an organization member creates a backup job on the Veeam Self-Service Backup Portal,
Enterprise Manager will copy the advanced settings from the template and apply them to the
job.
Note that, in the Cop y from list, Enterprise Manager displays only VMware Cloud Director
backup jobs that are configured in advance on the backup server added to Enterprise Manager.
IMP ORTANT
The backup repository that is selected from the Rep ository drop-down list for the organization takes
priority over the repository used by the selected job template.
NOTE
Tenants can create their own backup jobs in Veeam Self-Service Backup Portal. However, if a tenant wants
to manage replication jobs and CDP policies in the portal, the service provider must create them and map
to the tenant organization configuration.
1. In Enterprise Manager, create organization configurations for your tenants. For details, see Adding
Organization Configuration.
2. In Veeam Backup & Replication, create jobs or CDP policies for your tenants. Ensure that each job (or
policy) includes only the objects that belong to a particular Cloud Director organization. Otherwise, y ou
will not be able to map the job.
For backup and replication jobs, you can include any objects from the organization, and your tenant can
edit the job later. Editing of CDP policies is not available in Veeam Self -Service Backup Portal.
3. To map the created jobs and policies to the organization configuration, use the Set-
VBRvCloudOrganizationJobMapping cmdlet.
You can also use this cmdlet to unmap jobs and policies from an organization configuration.
• When you change a job template for a Cloud Director organization, the new configuration will be applied
only to the new jobs, existing jobs will not be affected.
• To make an existing backup job save backups to another repository instead of the currently configured for
a specific organization, take the following steps:
a. Add a new configuration for this organization. In the configuration settings, specify the new
repository that you want to move backups to. For details, see Adding Organization Configuration.
b. In the Veeam Backup & Replication console, change the current repository to the new one for each
backup job. When you specify a new repository, Veeam Backup & Replication prompts you to move
the existing backups to the new repository or keep them on the current one. For details, see the
Specify Backup Storage Settings and Backup Move sections of the Veeam Backup & Replication User
Guide.
5. On the Cloud Director tab, select an organization configuration and click E d it.
6. To edit organization settings, follow the same steps as for adding a configuration.
After you remove a configuration, the backup files created by existing backup jobs will remain in the backup
repository. The backup jobs associated with this configuration will also remain but will fail to run because the
backup repository will not be available to the organization. If you add a new configuration with the same backup
repository for this organization, the organization's backup jobs will continue existing backup chains.
If you want to replace an organization configuration with the one that uses a different backup repository and
and you want to keep all created backup chains, create the new configuration first, move backups to the new
repository, and then remove the unnecessary organization configuration. For details, see About Organization
Quota.
5. On the Cloud Director tab, select the default organization configuration and click E d it.
• Jobs
• VMs
• Files
• Items
5. Click Scope and select the tabs that you want to be displayed.
The following organization members have access to Veeam Self-Service Backup Portal:
• Cloud Director organization member that has all of the following rights granted in VMware Cloud Director:
o Organization: View Organization Administrative Details (required for access using Veeam Plug-in for
VMware Cloud Director only)
• Any Cloud Director organization members whose roles (or associated LDAP user roles) are defined in
registry keys and with the Group / User: View right granted in VMware Cloud Director. For more
information, contact Veeam Customer Support.
For details on how to access the portal, see Accessing Veeam Self-Service Backup Portal.
NOTE
Cloud Director system administrators cannot access Veeam Self-Service Backup Portal since they are not
organization members.
• Access by URL
• LDAP authentication
Additionally, if users access Veeam Self-Service Backup Portal from the Cloud Director UI, the following
authentication methods are also supported:
• SAML
1. Open your web browser and enter the following URL in the address bar:
[Link]
where:
o <VCDServer> is a host name or IP address of the host where the Cloud Director server resides.
This URL part is optional. If you do not specify a Cloud Director host here, you may be asked to select
the host when you log in to the portal.
For example:
[Link]
4. To save the entered credentials for future access, select the Remember me check box.
6. From the list of hosts with Cloud Director servers, select the one where your organization has been
created.
The list of hosts is displayed if multiple Cloud Director servers are added to the Enterprise Manager
infrastructure.
Before members of Cloud Director organizations can access Veeam Self-Service Backup Portal from the Cloud
Director UI, the Cloud Director system administrator must upload and configure Veeam Plug-in for VMware
Cloud Director. For more information, see Veeam Plug-in for VMware Cloud Director.
1. Log in to VMware Cloud Director Tenant Portal under a Cloud Director account with proper rights.
If you have a connection error when accessing Veeam Plug -in for VMware Cloud Director, add the Veeam
Backup Enterprise Manager certificate as trusted to your browser.
You can upload and configure the plug-in in VMware Cloud Director Service Provider Admin Portal. When you
upload the plug-in, you specify the scope — a set of Cloud Director organizations that can use the plug -in.
If you need to modify the scope of Cloud Director organizations after you configure the plug -in, update the
plug-in configuration. For more information, see Updating Plug-in Configuration.
IMP ORTANT
In VMware Cloud Director Service Provider Admin Portal, you cannot upgrade plug -ins. To switch to a
newer version of Veeam Plug-in for VMware Cloud Director, delete the current plug-in version and then
upload a newer one. For more information on deleting the plug-in, see the Delete a Plug-in From Your
VMware Cloud Director section of the VMware Cloud Director documentation. For details on uploading the
plug-in, see Uploading and Configuring Plug-in.
Before you delete the plug-in, make a note of the Cloud Director organizations that are allowed to use the
plug-in. For more information on how to view them, see the Publish or Unpublish a Plug-in from an
Organization section of the VMware Cloud Director documentation.
• Veeam Plug-in for VMware Cloud Director requires Veeam Backup & Replication 11 or later to be installed
on the backup server that has the Cloud Director server in its infrastructure.
• Members of Cloud Director organizations using the plug-in must have network access to the Cloud
Director server and Veeam Backup Enterprise Manager server.
You specify the Veeam Backup Enterprise Manager server URL in Cloud Director Service Provider Admin
Portal when you configure the plug-in. For more information, see Uploading and Configuring Plug-in.
• The Veeam Backup Enterprise Manager server should use a certificate issued by a Certificate Authority
instead of a default self-signed certificate. In case of a self-signed certificate, users of the plug-in have to
add the Enterprise Manager certificate as trusted to their browser before they access the plug-in.
Otherwise, they will get a connection error.
For more information on the Enterprise Manager certificate, see Updating TLS Certificates.
1. Log in to VMware Cloud Director Service Provider Admin Portal under a Cloud Director system
administrator account.
2. Upload the [Link] file to the portal. You can find the file on the Veeam Backup & Replication
installation disk in the \Plugins\Cloud Director folder.
For more information, see the Upload a Plug-in to Your VMware Cloud Director section of the VMware
Cloud Director documentation.
If the Da ta Protection with Veeam option is not available, log out from the VMware Cloud Director Service
Provider Admin Portal and log in again.
4. In the P lug-in Configuration section, specify the URL to the Veeam Backup Enterprise Manager server, for
example: [Link]
5. Click Sa ve.
NOTE
When you save the plug-in configuration, it is applied to all Cloud Director organizations. For that, a
separate operation is performed for each organization. If you have operation limits that are set
through the VMware Cloud Director API, the operations may fail with HTTP status 400.
In this case, use the VMware Cloud Director API to set the QueuedOperationsPerOrg and
QueuedOperationsPerUser elements to zero until you save the plug-in configuration. For more
information, see the OperationLimitsSettingsType section of VMware Cloud Director API
documentation.
6. On the Enterprise Manager server in IIS Manager, recycle the VeeamBackup applica tion pool.
For more information, see the Recycling Settings for an Application Pool <recycling> section of Microsoft
Docs.
1. Log in to VMware Cloud Director Service Provider Admin Portal under a Cloud Director system
administrator account.
For more information, see the Publish or Unpublish a Plug-in from an Organization section of the VMware
Cloud Director documentation.
4. In the P lug-in Configuration section, click Sa ve to apply the changes to all Cloud Director organizations.
• On the Jobs tab — examine and export job sessions data, search for jobs, create new jobs and edit jobs.
• On the VMs tab — search by a VM name, restore VMs and vApps to their original location (preserving or
overwriting the production VM or vApp), and delete VM backups.
• On the Files tab — search for the files on the VM guest file system and restore the necessary files to the
original location or download to the local machine.
• On the Items tab — perform application item-level restore (currently, for Microsoft SQL Server and Oracle
databases).
NOTE
If the Veeam Backup Enterprise Manager server is added to the Veeam ONE monitoring scope, the restore
operations performed with Veeam Self-Service Backup Portal are included in the Restore Operator Activity
report available in Veeam ONE.
You can view the chart for one of the time ranges:
• Last 24 hours
• Last 7 days
To switch between the ranges, select a necessary tab in the top left corner.
Veeam Self-Service Backup Portal accessed from Cloud Director using Veeam Plug -in for VMware Cloud Director
• vApps — the number of vApps for which restore points were successfully created during the specified
period.
• VMs — the number of VMs for which restore points were successfully created during the specified period.
• Used — used storage size. Note that replication jobs do not consume storage quota of backup repositories
because replicas are stored on the target VMware Cloud Director VDC.
The La st 24 hours / La st 7 days widget reports on the job session results for the selected period.
To visualize on-going jobs data, the Da shboard tab also comprises a chart showing date and time when jobs
were performed, and the network throughput rate during the job.
The highlighted part of the chart represents the configured backup window if this option is specified in the chart
settings. For more information, see Customizing Dashboard Chart.
• Enable and disable backup jobs, replication jobs, and CDP policies
• Organization members cannot see jobs and CDP policies created by the service provider in
Veeam Backup & Replication if the jobs and policies are not mapped to the organization configuration. For
more information, see Mapping Jobs and CDP Policies to Organization Configurations.
• In Veeam Self-Service Backup Portal, you cannot create and edit jobs managed by backup servers of earlier
major or minor versions. For example, after you upgrade Enterprise Manager to version 12.3, you will not
be able to create and edit jobs managed by a backup server with version 12.0. To resolve the issue,
upgrade the backup server as well.
• The following limitations apply to scenario involving VM backup and subsequent restore using Veeam
Self-Service Backup Portal:
a. You create a backup job that will process a VM added explicitly (that is, not as a part of a vApp
container).
c. Then you restore this VM to the original location by using the portal.
After restore, the VM identifier changes in Cloud Director hierarchy. Due to this reason, the backup
job cannot locate this VM any longer. So, you need to edit job settings, adding this VM anew. To
ensure that job configuration will store this VM with the new metadata (not the old one from Cloud
Director hierarchy cache), you should first click Reload in the Ad d Objects window.
d. At the next job run, a new full backup will be created for this VM. However, if you try to perform file -
level restore with the portal from the restore points created initially for that VM (on step 2), the
restore operation will fail, as that VM identifier does not exist any longer.
Creating Jobs
With Veeam Self-Service Backup Portal, members of a VMware Cloud Director organization can create Cloud
Director backup jobs. The jobs that you create are also shown in the Veeam Backup & Replication console under
the Job s node and in Veeam Backup Enterprise Manager on the Job s tab. The jobs have the <Cloud
Director_org_name> prefix.
To create a Cloud Director backup job, use the Create Backup Job wizard:
1. Log in to the Veeam Self-Service Backup Portal under a Cloud Director account with proper rights.
At the Job Settings step of the wizard, specify a job name, repository, job description, retention policy and job
priority.
2. From the Rep ository list, select a backup repository where the created backup files must be stored.
You can select a repository only if more than one configuration is added for the organization. For more
information, see Adding Organization Configuration.
3. In the Description field, provide an optional description for future reference. The default description
contains information about the user who created the job, date and time when the job was created.
o From the Retention p olicy list, select Restore points and specify the number of restore points that you
want to store in the backup repository. When this number is exceeded, the earliest restore point will
be removed from the backup chain.
o From the Retention p olicy list, select Days and specify the number of days for which you want to store
restore points in the backup repository. After this period is over, a restore point will be removed from
the backup chain.
For more information on retention, see the Short-Term Retention Policy section of the Veeam Backup &
Replication User Guide. Also, see this Veeam KB article.
5. 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 often full
backups are retained. For more information, see the Long-Term Retention Policy (GFS) section of the
Veeam Backup & Replication User Guide.
The Keep certain full backups longer for archival purposes check box is available only if GFS retention
policy can be applied to the job. For more information on GFS limitations, see the Long-Term Retention
Policy (GFS) section of the Veeam Backup & Replication User Guide.
At the Virtual Machines step of the wizard, you can add or remove VMs, vApps and VDCs of the organization.
Jobs with VM containers are dynamic in their nature: if a new machine is added to the container after the job is
created, the job is automatically updated to include the added machine.
1. Click the Ad d .
If you select a VM container and later add a new VM to the container, Veeam Backup & Replication will
update job settings automatically to include the VM.
TIP
• Search for objects: type a name or part of a name in the search field. Specify the type of the
object from a scroll list next to the search field.
• Switch between virtual infrastructure views using the buttons in the top right corner. For
VMware objects, you can switch between the Hosts and Clusters, VMs and Templates,
Da tastores and VMs, and Tags and VMs views.
Excluding VMs
You can also exclude individual VMs from VM containers.
At the Virtual Machines step of the wizard, you can change the VM processing order. It can be helpful if specific
VMs must be processed first, if you want to ensure that processing of a MV does not overlap with other
scheduled activities, or that VM processing is completed before the certain time.
To change the VM processing order, select the necessary machines and move them up or down the list using the
Up and Down buttons on the right. In the same manner, you can set the backup order for containers in the
backup list. You can change the order of the following VMware Cloud Director objects: VMs, vApps, organization
VDCs, organizations and the Cloud Director instance. The scope depends on your Cloud Director access rights.
At the Guest Processing step of the wizard, you can configure the following settings for VM guest OS
processing:
• Application-Aware Processing
• Guest OS Credentials
NOTE
VMware Cloud Director system administrators can access guest OS credentials available for their
organizations. They can also supply new credentials for guest OS processing.
Application-Aware Processing
At the Guest Processing step of the wizard, you can enable application-aware processing. Application-aware
processing is a Veeam technology based on Microsoft VSS and used to create transactionally consistent backups
or replicas of VMs that run Microsoft Active Directory, Microsoft SQL Server, Microsoft SharePoint, Microsoft
Exchange, Oracle or PostgreSQL. For more information, see the Application-Aware Processing section of the
Veeam Backup & Replication User Guide.
To customize settings of a machine added to the job as part of a container, add the machine as a
standalone instance. For that, click Ad d machine and choose the necessary VM. Next, select the machine
from the list and click E d it to customize VM settings.
To discard custom settings of a machine, select the machine in the list and click Remove.
4. Configure the necessary settings for the selected app lication server:
o General Settings
General Settings
On the General tab, you can specify general application-aware processing settings.
1. In the Ap p lications section, select the option that corresponds to your transactionally-consistent backup
creation scenario.
o Select Require successful processing (default option) if you want Veeam Backup & Replication to stop
the backup job if an error occurs.
o Select Try application processing, but ignore failures if you want to continue the backup process even
if an error occurs. This option guarantees completion of the job. The created backup image will not be
transactionally consistent, but rather crash-consistent.
2. [For Microsoft Exchange, Microsoft SQL Server, Oracle and PostgreSQL] In the Tra nsaction Logs
P rocessing section, specify whether this job should process transaction logs upon a successful backup.
o Select P rocess transaction logs with this job if you want Veeam Backup & Replication to process
transaction logs.
[For Microsoft Exchange] With this option selected, the non-persistent runtime components or
persistent components running on the VM guest OS will wait for backup to complete successfully and
then trigger truncation of transaction logs. If the backup job fails, the logs will remain untouched on
the VM guest OS until the next start of the non-persistent runtime components or persistent
components.
[For Microsoft SQL Server, Oracle and PostgreSQL] Specify settings for transaction log handling:
▪ For Microsoft SQL Server transaction log processing — on the SQL tab. For more information, see
Microsoft SQL Server Transaction Log Settings.
▪ For Oracle database archived logs processing — on the Ora cle tab. For more information, see
Oracle Archived Log Settings.
▪ For PostgreSQL database archive logs processing — on the P ostgreSQL tab. For more
information, see PostgreSQL Archive Log Settings.
o Select P erform copy only if you want to use native application means or a third-party tool to process
transaction logs. Veeam Backup & Replication will create a copy-only backup for the selected
machine. The copy-only backup preserves a chain of full/differential backup files and transaction logs,
so Veeam Backup & Replication will not trigger transaction log truncation. This option is
recommended if you are using another backup tool to perform the machine guest-level backup, and
this tool maintains consistency of the database state. To learn more, see the Guest Processing section
of the Veeam Backup & Replication User Guide.
With this option selected, the SQL, Oracle and P ostgreSQL tabs are not available.
3. In the P ersistent guest agent section, specify if Veeam Backup & Replication must use persistent guest
agents on each protected VM for application-aware processing.
Select the Use p ersistent guest agent check box to enable persistent agent components for guest
processing. For more information, see the Non-Persistent Runtime Components and Persistent Agent
Components section of the Veeam Backup & Replication User Guide.
IMP ORTANT
If both Microsoft SQL Server and Oracle Server are installed on the same VM, and this VM is processed by a
job with log backup enabled for both applications, Veeam Backup & Replication will back up only Oracle
transaction logs. Microsoft SQL Server transaction logs will not be processed.
If you back up a Microsoft SQL VM, you can specify how Veeam Backup & Replication must process transaction
logs on this VM.
1. At the Guest Processing step of the wizard, make sure the E na ble application-aware processing check box
is selected.
3. In the displayed window, select the Microsoft SQL Server VM from the list and click E d it.
4. On the General tab of the VM P rocessing Settings window, make sure the following options are selected:
o In the Ap p lications section, either the Require successful processing or Try application processing, but
ig nore failures option must be selected.
6. Specify how Veeam Backup & Replication will process SQL transaction logs.
o Select Truncate logs to truncate transaction logs after successful backup. The non-persistent runtime
components or persistent components running on the VM guest OS will wait for the backup to
complete successfully and then truncate transaction logs. If the job does not manag e to back up the
Microsoft SQL Server VM, the logs will remain untouched on the VM guest OS until the next start of
the non-persistent runtime components or persistent components.
NOTE
If the account specified at the Guest Processing step does not have enough rights,
Veeam Backup & Replication tries to truncate logs using the NT AUTHORITY\SYSTEM account.
Make sure that the account has permissions listed in the Permissions section of the Veeam
Explorers User Guide.
Select this option for databases that use the Simple recovery model. If you enable this option for
databases that use the Full or Bulk-logged recovery model, transaction logs on the VM guest OS may
grow large and consume all disk space. In this case, the database administrators must take care of
transaction logs themselves.
o Select Ba ckup logs periodically to back up transaction logs with Veeam Backup & Replication. Veeam
Backup & Replication will periodically copy transaction logs to the backup repository and store them
together with the image-level backup of the Microsoft SQL Server VM. During the backup job session,
transaction logs on the VM guest OS will be truncated.
For more information, see the Microsoft SQL Server Transaction Log Settings sections of the Veeam
Backup & Replication User Guide.
7. If you have selected the Ba ckup logs periodically option, specify settings for transaction log backup:
a. In the Ba ckup logs every <N> minutes field, specify the frequency for transaction log backup. By
default, transaction logs are backed up every 15 minutes. The maximum log backup interval is 480
minutes.
b. In the Retain log backups section, specify retention policy for transaction logs stored in the backup
repository.
▪ Select Until the corresponding image-level backup is deleted to apply the same retention policy
for image-level backups and transaction log backups.
▪ Select Keep only last <N> days to keep transaction logs for a specific number of days. By
default, transaction logs are kept for 15 days. If you select this option, you must make sure that
retention for transaction logs is not greater than retention for the image-level backups. For
more information, see Retention for Transaction Log Backups section of the Veeam Backup &
Replication User Guide.
NOTE
Using the Veeam Backup & Replication console, you can also specify log shipping servers that you want to
use to transport transaction logs. For more information, see the Microsoft SQL Server Transaction Log
Settings section of the Veeam Backup & Replication User Guide.
If you back up a VM where Oracle Database is deployed, you can specify how Veeam Backup & Replication must
process archived redo logs on this VM.
1. At the Guest Processing step of the wizard, make sure the E na ble application-aware processing check box
is selected.
3. In the displayed window, select the Oracle VM from the list and click E d it.
4. On the General tab of the VM P rocessing Settings window, make sure that either the Require successful
p rocessing or Try application processing, but ignore failures option is selected.
IMP ORTANT
If both Microsoft SQL Server and Oracle are installed on one machine, and this machine is processed
by a job with log backup enabled for both applications, Veeam Backup & Replication will back up
only Oracle transaction logs. Microsoft SQL Server transaction logs will not be processed.
a. Specify a user account that will connect to the Oracle database and perform Oracle archived logs
backup and deletion.
▪ Select Use guest credentials to use the account specified at the Guest Processing step of the
wizard to access the VM guest OS and connect to the Oracle database.
▪ Specify another account. To do this, select the necessary account from the drop -down list or
click Ad d and add a new account.
Make sure the specified account has sufficient rights. For details, see the Permissions section of the
Veeam Explorers User Guide.
b. Specify how Veeam Backup & Replication must process archived redo logs on the Oracle VM.
▪ Select Do not d elete archived logs to preserve archived redo logs on the original Oracle server.
Select this option for databases in the NOARCHIVELOG mode. If the database is in the
ARCHIVELOG mode, archived logs on the VM guest OS may grow large and consume all disk
space. In this case, database administrators must take care of archived logs themselves.
When the parent backup job (job creating an image-level backup) runs, Veeam Backup &
Replication will wait for the backup to complete successfully, and then trigger archived logs
deletion on the Oracle VM over Oracle Call Interface (OCI). If the primary job does not manage to
back up the Oracle VM, the logs will remain untouched on the VM guest OS until the next start
of the non-persistent runtime components or persistent components.
TIP
Veeam Backup & Replication removes redo logs only after the parent backup job session. To
remove redo logs more often, you can schedule the job to run more often.
c. To back up Oracle archived logs with Veeam Backup & Replication, select the Ba ckup logs every <N>
minutes check box and specify the frequency for archived log backup. By default, archived logs are
backed up every 15 minutes. The maximum log backup interval is 480 minutes.
IMP ORTANT
If you plan to use this option together with archived logs deletion from Oracle machine guest,
make sure that these settings are consistent: logs should be deleted after they are backed up to
repository. Thus, you need to set up backup schedule and log removal conditions appropriately.
d. If you have selected the Ba ckup logs every <N> minutes option, specify retention policy for the
archived logs stored in the backup repository. For the Retain log backups setting, select one of the
following:
▪ Select Until the corresponding image-level backup is deleted to apply the same retention policy
for image-level backups and archived log backups.
▪ Select Keep only last <N> days to keep archived logs for a specific number of days. By default,
archived logs are kept for 15 days. If you select this option, you must make sure that retention
for archived logs is not greater than retention for the image-level backups. For more
information, see the Retention for Archived Log Backups section of the Veeam Backup &
Replication User Guide.
NOTE
Using the Veeam Backup & Replication console, you can also specify log shipping servers that you want to
use to transport archived logs. For more information, see the Oracle Archived Log Settings section of the
Veeam Backup & Replication User Guide.
If you back up a VM where PostgreSQL is deployed, you can specify how Veeam Backup & Replication must
process PostgreSQL archive logs on this VM.
1. At the Guest Processing step of the wizard, make sure the E na ble application-aware processing check box
is selected.
3. In the displayed window, select the PostgreSQL VM from the list and click E d it.
5. On the P ostgreSQL tab of the VM P rocessing Settings window, specify settings for PostgreSQL logs
processing.
a. Specify an account that will connect to the PostgreSQL instance and perform PostgreSQL archive logs
backup and deletion. The pg_hba.conf configuration file of the PostgreSQL instance must contain a
record with the account.
▪ Select Use guest credentials to use the account specified at the Guest Processing step of the
wizard to access the VM guest OS and connect to the PostgreSQL instance.
▪ Specify another account. To do this, select the necessary account from the drop-down list or
click Ad d and add a new account.
Make sure the specified account has sufficient rights. For details, see the Permissions section of the
Veeam Explorers User Guide.
▪ Select Da tabase user with password file (.pgpass) if you have specified an account with
password-based authentication. In this case, you do not have to specify the account password
when adding the account in Veeam Backup & Replication. Instead, the account password must
be specified in the PGPASS password file stored in the user's home directory.
▪ Select Sy stem user without password (peer) if you have specified a local system account with
peer authentication.
c. To back up PostgreSQL archive logs with Veeam Backup & Replication, select the Ba ck up logs every
< N> minutes check box and specify the frequency for archive log backup. By default, archive logs are
backed up every 15 minutes. The maximum log backup interval is 480 minutes.
d. If you have selected the Ba ckup logs every <N> minutes option, specify retention policy for the
archive logs stored in the backup repository. For the Retain log backups setting, select one of the
following:
▪ Select Until the corresponding image-level backup is deleted to apply the same retention policy
for image-level backups and archived log backups.
▪ Select Keep only last <N> days to keep archive logs for a specific number of days. By default,
archive logs are kept for 15 days. If you select this option, you must make sure that retention for
archive logs is not greater than retention for the image-level backups. For more information, see
the Retention for PostgreSQL WAL Files section of the Veeam Backup & Replication User Guide.
e. In the P ostgreSQL archive logs local temporary storage field, specify a path on the PostgreSQL
machine that Veeam Backup & Replication will use to temporarily store PostgreSQL archive logs until
they are backed up. Veeam Backup & Replication does not create the temporary storage folder so the
folder must exist on the machine. Make sure the temporary location has enough free space for storing
the log files.
NOTE
Using the Veeam Backup & Replication console, you can also specify log shipping servers that you want to
use to transport archive logs. For more information, see the Retention for PostgreSQL WAL Files section of
the Veeam Backup & Replication User Guide.
If you do not want to back up specific files and folders on the VM guest OS, you can exclude them from the
backup. Exclusions can help decrease the backup file size. However, selective processing takes additional time
that depends on the number of excluded files. It also requires obtaining per-file metadata (stored in backups).
Thus, it is recommended to use this option for excluding large files. By default, exclusions are disabled.
1. At the Guest Processing step of the wizard, make sure the E na ble application-aware processing check box
is selected.
3. In the displayed window, select a VM from the list and click E d it.
4. On the File Exclusions tab, specify the files that must be excluded from the backup.
o Select E x clude the following files a nd folders to remove individual files and folders from the backup.
o Select Include only the following files and folders to leave only the specified files and folders in the
backup.
To form the list of exclusions or inclusions, you can use full paths to files and folders, environmental
variables, and file masks with the asterisk (*) and question mark (?) characters. For more information, see
the VM Guest OS Files section of the Veeam Backup & Replication User Guide.
NOTE
For proper file indexing of Linux machines, Veeam Backup & Replication requires several utilities to be
installed on the machines: mlocate, gzip, and tar. If these utilities are not found, you are prompted to
deploy them to support index creation.
2. In the Guest File System Indexing Options window, select a machine from the list and click E d it.
o To customize settings of a machine added to the job as part of a container, add the machine as a
standalone instance. For that, click Ad d Machine and choose the necessary VM. Next, select the
machine from the list and click E d it to customize VM settings.
o To discard custom settings of a machine, select it from the list and click Remove.
3. In the Ind exing Settings window displayed for the selected machine, go to the W ind ows or Linux tab and
specify what files should be indexed:
o Select Disable indexing if you do not want to index guest OS files of the machine.
o Select Ind ex everything if you want to index all guest OS files inside the machine.
o Select Ind ex everything except folders if you want to index all guest OS files except those defined in
the list. By default, system folders are excluded from indexing. You can add or delete folders to
exclude using the Ad d and Remove buttons.
Guest OS Credentials
If you specify guest OS credentials, Veeam Backup & Replication deploys a runtime process on the VM guest OS
to coordinate guest processing activities. The process runs only during guest processing and is stopped
immediately after the processing is finished.
If you have Management Agent installed on a Linux VM, you have an option to use it for coordinating guest
processing activities. In this case, guest OS credentials are not stored in the configuration database, which
makes using Management Agent a more secure option. For more information, see the Persistent Agent
Components section of the Veeam Backup & Replication User Guide.
NOTE
VMware Cloud Director system administrators can access guest OS credentials available for their
organizations. They can also supply new credentials for guest OS processing.
• For Windows guest OS, specify a user account (name and password) with local administrative rights on
target machine, and optional description. Credentials must be specified in the following format:
• For Linux guest OS, you can choose one of the following options:
o If Management Agent is installed on the VM, you can select the Use management agent option.
o If Management Agent is not installed on the VM, specify a user name, password, and SSH port (by
default, port 22 is used).
If you specify data for a non-root account that does not have root permissions on a Linux server, you
can use the Non-root account section to grant sudo rights to this account.
i. To provide a non-root user with root account privileges, select the E levate specified account to
root check box.
If you do not enable this option, you will have to manually add the user account to the sudoers
file.
iii. If you plan to use the account to connect to Linux servers where the sudo command is not
available or may fail, you have an option to use the su command instead. To enable the su
command, select the Use "su" if "sudo" fails check box and in the Root p assword field, enter the
password for the root account.
Veeam Backup & Replication will first try to use the sudo command. If the attempt fails,
Veeam Backup & Replication will use the su command.
IMP ORTANT
For machine guest OS indexing of Linux-based machines, a user account with root privileges on the
machine is required. It is recommended that you create a separate user account for work with Veeam
Backup & Replication on the Linux-based machine, grant root privileges to this account and specify settings
of this account in the Guest OS credentials section.
It is also recommended to avoid additional commands output for the specified user (like messages echoed
from within ~/.bashrc or command traces before execution), because they may affect Linux machine
processing.
• Private key is stored on the client (user’s) machine — that is, on the machine where Veeam Backup &
Replication runs. The key is usually stored in the encrypted form. To decrypt a private key, you need to
supply a passphrase specified at key creation.
• Public key is stored on the server (Linux machine) in a special authorized_keys file that contains a list
of public keys.
• User name
To customize credentials:
2. Select the necessary machine from the list and click Remove.
NOTE
To customize settings of a machine added as part of a container, the machine should be included in the list
as a standalone instance. For that, click Ad d machine and choose a machine whose settings you want to
customize.
At the Job Schedule step of the wizard, you can select to run the job manually or schedule the job to run on a
regular basis.
1. Select the Run the job automatically check box. If the check box is not selected, you will need to start the
job manually.
2. Edit the scheduling settings. You can select to run the job daily, monthly, periodically with a specific time
interval, continuously or after a specific job.
3. In the Automatic retry section, define whether Veeam Backup & Replication must attempt to run the
backup job again if the job fails for some reason. During a job retry, Veeam Backup & Replication processes
failed machines only. Enter the number of attempts to run the job and define time intervals between
them. If you select continuous backup, Veeam Backup & Replication will retry the job for the defined
number of times without any time intervals between the job runs.
4. In the Ba ckup window section, edit 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 provide unwanted overhead on the production environment. To set up a backup window for the job:
a. Select the Terminate job if it gets out of a llowed backup window check box and click W indow.
b. Define the allowed hours and prohibited hours for backup. If the job exceeds the allowed window, it
will be automatically terminated.
If the Location property of the source object and target object do not match, you will receive a warning
message after you click Finish. For example, you may have a backup job targeted at repository located in
Sydney, and source machines located in London.
Schedule Settings
If you have selected to run the job automatically, you can select one of the following options:
• 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.
• 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.
NOTE
When you configure the job schedule, keep in mind p ossible date and time changes (for example,
related to daylight saving time transition).
• 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. Click Schedule and use the time table
to define the permitted time window for the job. In the Sta rt time within an hour field, specify the exact
time when the job must start.
o Veeam Backup & Replication always starts counting defined intervals from 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.
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.
• To run the job continuously, select the P eriodically every option and choose Continuously from the drop-
down list on the right. A new backup job session will start as soon as the previous backup job session
finishes.
• 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. If you start the first job manually, Veeam Backup
Enterprise Manager will display a notification. You will be able to choose whether to start the
chained job as well.
Email notifications will be sent daily if you configure global notification settings in Veeam Backup Enterprise
Manager. For more information, see Notifications on Job Results. If you want to receive a notification after each
job run, configure notification setting for this job in Veeam Backup & Replication. For details, see the
Notification Settings section of the Veeam Backup & Replication User Guide.
To configure email notifications for this job, take the following steps:
1. Select the E na ble e-mail notifications check box if you want to receive notifications about the job
completion status by email.
2. In the Recipients field, specify recipient’s email address. You can enter several addresses separated by a
semicolon.
3. 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 VMs in the job)
and %Issues% (number of VMs in the job that have finished with the Warning or Failed status).
4. Select Notify on success to receive an email notification when the job completes successfully.
5. Select Notify on warning to receive an email notification when the job completes with a warning.
6. Select Notify on error to receive an email notification when the job fails.
7. 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.
Other job settings are obtained from the job configuration specified for the organization. For more
information, see Adding Organization Configuration.
• To start a job, right-click a job from the list and select Sta rt.
• To stop a job, right-click a job from the list and select Stop .
Alternatively, you can right-click a job or policy and select Job > E nable.
Alternatively, you can right-click a job or policy and select Job > Delete.
3. You will be prompted to delete backup files. To delete backup files, select the Delete backup files check
box and click Y es to confirm the operation.
If four-eyes authorization is enabled on the backup server, backup files will remain in the backup
repository and become orphaned.
• Recover VMs
• Restore vApps
• Restore VM disks
• Instant Recovery
• Entire VM Restore
Instant Recovery
You can instantly recover VMware Cloud Director VMs from backups to the or iginal vApp or another vApp that
belongs your VMware Cloud Director organization.
1. On the VMs tab, select a VM you want to recover. To quickly find the necessary VM, use the search field at
the top of the window.
3. Follow the steps of the Instant Recovery wizard. For more information, see Instant Recovery to VMware
Cloud Director.
Entire VM Restore
You can restore VMware Cloud Director VMs from backups to the original vApp or another vApp that belongs
your VMware Cloud Director organization.
1. On the VMs tab, select a VM you want to restore. To quickly find the necessary VM, use the search field at
the top of the window.
3. Follow the steps of the E ntire VM Restore wizard. For more information, see Restoring Entire VM to
VMware Cloud Director.
Restoring vApps
You can restore a vApp to the original (production) VDC.
To restore a vApp:
1. On the VMs tab, select a vApp. To quickly find the necessary vApp, use the search field at the top of the
window.
o Select Overwrite if you want to restore the vApp from the backup to the original VDC, replacing the
production vApp.
o Select Keep if you want to keep the original vApp in the original VDC. The vApp from the backup will
be located next to the original production vApp and will have the same name with the _restored
suffix. Names of VMs in the vApp will remain the same.
3. Select the restore point that will be used to restore the vApp.
5. Click Finish.
IMP ORTANT
Restore job of a vApp with a standalone VM will return an ordinary and not standalone VM.
vApp Failover
Failover is a process of switching from the original vApp in the production site to its vApp replica in the disaster
recovery site.
Failover is an intermediate step that your service provider must finalize in the Veeam Backup & Replication
console. The service provider can perform the following operations in the console:
• Undo failover to switch back to the source vApp and discard all changes made to the replica while it was
running.
• Perform permanent failover to permanently switch from the source vApp to the replica and use this
replica as the production vApp.
• Perform failback to switch back to the source vApp and send to the source vApp all changes that took
place while the replica was running.
You can perform the following failover operations in Veeam Self-Service Backup Portal:
Failover is an intermediate step that your service provider must finalize in the Veeam Backup & Replication
console. The service provider can perform the following operations in the console:
• Undo failover to switch back to the source vApp and discard all changes made to the replica while it was
running.
• Perform permanent failover to permanently switch from the source vApp to the replica and use this
replica as the production vApp.
• Perform failback to switch back to the source vApp and send to the source vApp all changes that took
place while the replica was running.
For more information on finalizing failover, see the Failover and Failback section of the
Veeam Backup & Replication User Guide.
1. On the Ma chines tab, select a machine processed by a Cloud Director replication job.
4. Click Restore.
Failover is an intermediate step that your service provider must finalize in the Veeam Backup & Replication
console. The service provider can perform the following operations in the cons ole:
• Undo failover to switch back to the source vApp and discard all changes made to the replica while it was
running.
• Perform permanent failover to permanently switch from the source vApp to the replica and use this
replica as the production vApp.
• Perform failback to switch back to the source vApp and send to the source vApp all changes that took
place while the replica was running.
For more information on finalizing failover, see the Failover and Failback section of the
Veeam Backup & Replication User Guide.
1. On the Ma chines tab, select a machine processed by a Cloud Director CDP policy.
Application consistency is defined for the whole vApp. A vApp restore point is application-consistent if all
VMs have application-consistent restore points. A vApp restore point is mixed if some VMs have crush-
consistent restore points.
TIP
• To quickly find a long-term restore point, use the calendar.
• To zoom in or zoom out the time line, use the P lus and Minus buttons or switch between the
Hour and Da y views.
4. Click Fa ilover.
1. On the VMs tab, select a VM with disks you want to restore. To quickly find the necessary VM, use the
search field at the top of the window.
• If four-eyes authorization is enabled on the backup server, you cannot delete a VM backup using either
Veeam Self-Service Backup Portal or Enterprise Manager.
• If the selected VM is the last one in its vApp, the VM will be deleted from the backup with its vApp. If this
vApp is the last one in its backup, the whole backup will be deleted.
• If you delete a VM that has GFS backups, they will not be deleted. You can delete them in Enterprise
Manager. For more information, see Deleting Machine from Backup.
• When you remove data of deleted VMs from per-VM backup chains, it does not mark the space as available
but deletes backup files since they contain data for one VM only. When you remove data of deleted VMs
from regular backup chains, the space is not freed up on the backup repository. It is marked as available to
be overwritten, and this space is overwritten during subsequent job sessions or the backup file compact
operation.
Deleting VMs
To delete a VM, do the following:
1. On the VMs tab, select a VM. To quickly find the necessary VM, use the search field at the top of the
window.
2. Click Delete.
To restore guest OS files, open the the Files tab and follow the steps described in Performing 1-Click File
Restore.
NOTE
• When you restore from non-indexed guest OS file system, mount operation is performed using
mount server associated with the backup repository that stores the backup file.
• Before you restore files from a non-Windows VM, make sure that a helper host or helper appliance is
configured on the backup server. For more information, see Preparing for File Search and Restore
(non-Windows machines).
The Enterprise Manager Database Migration utility supports both local (when the database is located on the
same machine with Enterprise Manager) and remote Microsoft SQL Server databases (when the database is
located on another machine).
The Enterprise Manager Database Migration utility comes with Veeam Backup Enterprise Manager and is located
on the Enterprise Manager server in the installation folder. The default path is the following:
%PROGRAMFILES%\Veeam\Backup and Replication\Enterprise
Manager\[Link]. To run the utility, use a command-line shell.
After you restore the database, connect Veeam Backup Enterprise Manager to the restored database using the
Configuration Database Connection Settings utility. For more information, see Configuration Database
Connection Settings Utility.
Account Permissions
The utility requires access to the registry so you must run the command -line shell as administrator. In addition,
make sure that the accounts used to run the utility and connect to the target PostgreSQL database have the
necessary permissions.
/b a ckupemdatabase The account that runs the /backupemdatabase command must either be the
Enterprise Manager service account or any other account with the following
permissions:
/restoreemdatabase The account that you specify to authenticate against a PostgreSQL server in the
/login parameter must be a superuser. If you don't specify any parameter, the
utility will use the account under which the Veeam Backup Enterprise Manager
Service is running.
• You can perform cross-version configuration database restore with the same database engine only. For
example, if you have Enterprise Manager 12, and you want to upgrade it to version 12.3 and change the
database engine from Microsoft SQL Server to PostgreSQL, upgrade the product first and then migrate the
database.
• Veeam Backup Enterprise Manager collects data from backup servers with configuration databases that
run on the same database engine as the Enterprise Manager configuration database. This means that after
you migrate the Enterprise Manager database, you must migrate Microsoft SQL Server configuration
databases of already added backup servers and add them again to the Enterprise Manager infrastructure.
For more information, see the Migrating Configuration Database to PostgreSQL Server section of the
Veeam Backup & Replication User Guide.
Syntax
With the Enterprise Manager Database Migration utility, you can perform the following operations:
[Link] /?
Parameters
The table below describes parameters that you can use to back up and restore the Enterprise Manager
configuration database.
P a rameter Description
/? Displays help.
/servername:<value> Specifies a name or IP address of the target host with PostgreSQL server.
The default value is localhost. If you skip the parameter, the default value
is used.
If a database with the specified name (or the default name) exists, the
utility adds an increment postfix to the database name, for example:
VeeamBackupReporting_00 , VeeamBackupReporting_01.
/log in:<value> Specifies an account name that the utility uses to authenticate against a
PostgreSQL server. By default, the utility uses the account under which the
Veeam Backup Enterprise Manager Service is running. The chosen
PostgreSQL account must be a superuser.
/verbose Enables verbose logging mode. Logs are stored in the following directory:
%PROGRAMDATA%\Veeam\Backup\Utils\[Link].
where:
• /file:"C:\EM Configuration\[Link]" — file name and location of the backup file. If you specify a
folder that does not exist, the utility will create it. If a file with the specified name already exists, it will be
rewritten.
Microsoft SQL Server connection settings are not required in the command, the utility gets them from the
registry.
Example 2
This example shows how to restore the Enterprise Manager configuration database from an EMCO backup file to
PostgreSQL.
where:
• Connect Enterprise Manager and Veeam Backup & Replication to a different database on the same or
another server.
• Change authentication method for database connection. Possible options are Microsoft Windows
authentication and database server authentication.
NOTE
• With the Configuration Database Connection Settings utility, you can connect Enterprise Manager
(or Veeam Backup & Replication) to a configuration database of the same product version only. For
example, you can connect Enterprise Manager 12.3 to a configuration database of version 12.3.
• The Configuration Database Connection Settings utility is shared between
Veeam Backup & Replication and Veeam Backup Enterprise Manager. If they are installed on the
same machine, make sure these products are of the same version.
To manage connection settings for the Enterprise Manager configuration database, take the following steps:
2. Select a product.
Alternatively, you can run the [Link] file. By default, the path is the following:
%PROGRAMFILES%\Common Files\Veeam\Backup and Replication\DBConfig.
To run the utility, you must have administrative rights on the local machine, as long as the utility makes changes
to the registry. If prompted at the launch, choose Run a s administrator.
If a backup server (or Enterprise Manager server) is not installed on the machine, the P roduct step of the wizard
is skipped.
o PostgreSQL
o [For PostgreSQL] Specify the instance name in the HOSTNAME:PORT format. In the Da tabase name
field, specify a name for the Veeam Backup Enterprise Manager configuration database.
o [For Microsoft SQL Server] Specify the Microsoft SQL Server instance and database name to which you
want the Veeam Backup & Replication installation to connect. Both local and remote Microsoft SQL
Server instances are supported. Microsoft SQL Server instances available on the network are shown in
the Server name list. If necessary, click Refresh to get the latest information.
If a database with the specified name does not exist on the selected Microsoft SQL Server instance, it
will be created anew.
o If you plan to use the Microsoft Windows authentication, consider that the current service account
will be used (that is, the account under which the Veeam Backup Enterprise Manag er Service is
running).
o If you plan to use native database server authentication, provide a login name and password. To view
the entered password, click and hold the eye icon on the right of the P a ssword field.
[For Microsoft SQL Server] When you migrate the configuration database to another server, you must use
the Microsoft SQL Server credentials that have CREATE ANY DATABASE permission on the target
Microsoft SQL Server. For details, see Microsoft Docs. After database creation, this account automatically
gets a db_owner role and can perform all operations with the database. If the current account does not
have this permission, a Database Administrator may create an empty database in advance and grant the
db_owner role to the account that will be used for migration of the configuration database.
5. Before proceeding, the utility validates the specified settings to make sure that the specified user account
has enough privileges to access the database.
To ensure that the account (as well as the account under which the Veeam Backup Enterprise Manager
Service is running) have sufficient privileges for database access, you can contact your database
administrator. Refer to the list of required permissions for detailed information.
NOTE
If you are configuring Veeam Backup & Replication database settings and you want the Veeam backup
management console to start automatically after you finish working with the wizard, select the Sta rt the
p roduct automatically check box. The option is not available for Veeam Backup Enterprise Manager.