Veeam Backup Enterprise Manager: User Guide
Veeam Backup Enterprise Manager: User Guide
Manager
Version 12
User Guide
March, 2023
© 2023 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 the
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, 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 file share backups.
• Manage VMware Cloud Director organizations and support their administrators with the Veeam Self-
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.
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 Support for Veeam Agents.
• 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 Main 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 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.
o VMware 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 PostgreSQL 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 Portal 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 information,
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 the Veeam backup server works as a local catalog service. It collects index
data for backup jobs on this specific Veeam backup server and stores this data locally in the Veeam Backup
Catalog folder.
• Veeam Guest Catalog service on Veeam Backup Enterprise Manager works as a federal catalog service. It
communicates with Veeam Guest Catalog services on Veeam backup servers connected to Veeam Backup
Enterprise Manager and performs the following tasks:
o Replicates index data from Veeam backup servers to create a federal catalog
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.
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 Veeam backup server.
2. If you then select to download the necessary files, Veeam 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 Veeam backup server.
5. After you download or restore the necessary files, and finish the restore 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 Veeam backup server.
During the next catalog replication session started on Veeam Backup Enterprise Manager, indexing data from
the Veeam backup server is replicated to the Veeam Backup Catalog on Veeam Backup Enterprise Manager
server. By federating indexing data from all connected Veeam 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. To learn more
about mount operation, refer to the Veeam Backup & Replication User Guide and to the Search and Restore of
Machine Guest Files section of this guide.
• 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 08:05:57.081
####################################################
# OIBS
oib0.VmName=srv04
oib0.BackupTimeUtc=05/13/2014 08:02:04.988
oib0.OibUID=f81f790c-103e-4351-81a4-e4ec8a8c290c
oib0.Platform=EVmware
oib0.Group=grp0
####################################################
# BACKUP FILE GROUPS
grp0.file0.Server=BACKUP01
grp0.file0.Path=c:\backup\srv04\srv042014-05-13T010101.vib
grp0.file0.ModifyDateUtc=05/13/2014 08:04:10.293
grp0.file1.Server=BACKUP01
grp0.file1.Path=c:\backup\srv04\srv042014-05-13T004536.vib
grp0.file1.ModifyDateUtc=05/13/2014 07:47:52.077
grp0.file2.Server=BACKUP01
grp0.file2.Path=c:\backup\srv04\srv042014-05-13T000053.vib
grp0.file2.ModifyDateUtc=05/13/2014 07:04:24.38
grp0.file3.Server=BACKUP01
grp0.file3.Path=c:\backup\srv04\srv042014-05-12T230102.vib
grp0.file3.ModifyDateUtc=05/13/2014 06:04:25.003
grp0.file4.Server=BACKUP01
grp0.file4.Path=c:\backup\srv04\srv042014-05-12T220051.vib
grp0.file4.ModifyDateUtc=05/13/2014 05:03:53.817
grp0.file5.Server=BACKUP01
grp0.file5.Path=c:\backup\srv04\srv042014-05-12T210105.vbk
grp0.file5.ModifyDateUtc=05/13/2014 04:07:55.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 possible 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 11:20:18.952
####################################################
# OIBS
oib0.VmName=srv01
oib0.BackupTimeUtc=05/14/2014 10:56:55.993
oib0.OibUID=47c62e82-3066-478c-8272-1fb65a47d601
oib0.Platform=EVmware
oib0.Group=grp1
oib1.VmName=srv01
oib1.BackupTimeUtc=05/14/2014 11:02:20.15
oib1.OibUID=d39f4a3c-2b5b-415a-ae0d-e9acc49f63a0
oib1.Platform=EVmware
oib1.Group=grp2
oib2.VmName=srv01
oib2.BackupTimeUtc=05/14/2014 11:16:52.779
oib2.OibUID=1f3c31bf-9541-46ac-9826-62ecfd76a291
oib2.Platform=EVmware
oib2.Group=grp3
####################################################
# BACKUP FILE GROUPS
grp0.file0.Server=BACKUP
grp0.file0.Path=c:\backup\srv01_reversed\srv01_reversed2014-05-14T035606.vrb
grp0.file0.ModifyDateUtc=05/14/2014 10:56:55.993
grp0.file1.Server=BACKUP
grp0.file1.Path=c:\backup\srv01_reversed\srv01_reversed2014-05-14T040137.vrb
grp0.file1.ModifyDateUtc=05/14/2014 11:18:14.43
grp0.file2.Server=BACKUP
grp0.file2.Path=c:\backup\srv01_reversed\srv01_reversed2014-05-14T041612.vbk
grp0.file2.ModifyDateUtc=05/14/2014 11:18:45.973
grp1.file0.Server=BACKUP
grp1.file0.Path=c:\backup\srv01_reversed\srv01_reversed2014-05-14T040137.vrb
grp1.file0.ModifyDateUtc=05/14/2014 11:18:14.43
grp1.file1.Server=BACKUP
grp1.file1.Path=c:\backup\srv01_reversed\srv01_reversed2014-05-14T041612.vbk
grp1.file1.ModifyDateUtc=05/14/2014 11:18:45.973
grp2.file0.Server=BACKUP
grp2.file0.Path=c:\backup\srv01_reversed\srv01_reversed2014-05-14T041612.vbk
grp2.file0.ModifyDateUtc=05/14/2014 11:18:45.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 the 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 backup 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.
IMPORTANT
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 Manager.
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 Managing 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.
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 Server.
Specification Requirement
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 2022
• Microsoft SQL Server 2019
• Microsoft SQL Server 2017
• Microsoft SQL Server 2016
• Microsoft SQL Server 2014 with Microsoft SQL Server 2014
Management Objects and Microsoft System CLR for Microsoft SQL
Server 2014
• Microsoft SQL Server 2012
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
• Microsoft Visual C++ 2015-2019 Redistributable
• Microsoft SQL Server System CLR Types for SQL Server 2014
• IIS URL Rewrite Module 2
• Microsoft Universal C Runtime
• Microsoft Report Viewer Redistributable 2015
• Microsoft Internet Information Services:
o Default Document Component
o Directory Browser Component
o HTTP Errors Component
o Static Content Component
o Windows Authentication Component
o WebSocket Protocol Component
o ASP.NET 4.5 Component
o .NET Extensibility 4.5 Component
• Windows Installer 4.5 (included in the setup)
IMPORTANT
To restore Microsoft Exchange items with Veeam Backup Enterprise Manager, Microsoft Exchange servers
must be members of the same Microsoft Active Directory forest.
Client Side
Specification 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).
Specification Requirement
Hardware and software Refer to hardware system requirements and software system requirements
for Veeam Backup Enterprise Manager.
Specification Requirement
Note that 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.
Specification Requirement
The account used for product installation must have the local Administrator
permissions on the target machine.
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
Account used to run gets a db_owner role and can perform all operations with the database.
the setup
Note: 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 It is recommended to use the Local System account as the Veeam Backup Enterprise
Enterprise Manager Manager Service account. If you set another account to run this service, this account
service account must have the following permissions:
• Local Administrator permissions on the Veeam Backup Enterprise Manager
server.
• Log on as service right (granted automatically to the Veeam Backup Enterprise
Manager Service account).
• Db_datareader and db_datawriter roles, as well as permissions to execute
stored procedures for the Enterprise Manager database on the Microsoft SQL
Server. Alternatively, you can assign this account the db_owner role for the
Enterprise Manager database.
• 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.
Enterprise Manager To be able to work with the Veeam Backup Enterprise Manager web UI, users must
user be assigned the Portal Administrator, Portal User or Restore Operator role. For more
information, see Configuring Accounts and Roles.
vSphere 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
(optional) The account used to install the plug-in must be assigned the following vCenter
Server permissions:
• To install the plug-in: Extension > Register extension
• To uninstall the plug-in: Extension > Unregister extension
vSphere Self-Service The account used to work with vSphere Self-Service Backup Portal must have
Backup Portal 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.
Microsoft SQL Server TCP 1433 Default port used for communication
hosting the Enterprise with Microsoft SQL Server hosting the
Manager configuration Enterprise Manager configuration
database database.
VMware vCenter Server TCP 443 Default port used for connection to a
vCenter Server and deploying the
Veeam Plug-in for vSphere Client. Can
be customized during Enterprise
Manager installation. For more
information, see Specify Service Ports.
Veeam License Update TCP 443 Default port used for license auto-
Server update.
(vbr.butler.veeam.com,
autolk.veeam.com)
Veeam Veeam Backup TCP 9394 Default port used by IIS extension to
Backup Enterprise Manager communicate with Veeam Backup
Enterprise service Enterprise Manager. Can be
Manager customized during Veeam Backup
website (IIS Enterprise Manager installation. For
extension) more information, see Specify Service
Ports.
Veeam Veeam Backup TCP 9397 Default port used by IIS extension to
Cloud Enterprise Manager communicate with Veeam Backup
Connect service Enterprise Manager. This port value is
Portal built-in and cannot be customized
website (IIS during installation.
extension)
Veeam Veeam Backup TCP Dynamically If you add the Veeam Backup
ONE Server Enterprise Manager assigned Enterprise Manager server to the
(optional) server ports Veeam ONE 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.
NOTE
• 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.
Target Mount server TCP 3260 to 3270 Ports used for transfer of iSCSI traffic
remote associated during database restore to the original
Microsoft SQL with backup Microsoft SQL Server. These ports are
Server repository used during the restore process only.
Target Machine TCP 3260 to 3270 Ports used by Veeam Backup and
remote running Replication for iSCSI traffic. Ports are
machine to mount open only during the application item
which service1 restore session.
application
items are
restored
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.
When you run a job, Veeam Backup & Replication uses a number of instances required for each type of protected
workloads (for per-instance licenses) or applies a license to the protected hosts (for per-socket license).
Veeam Backup Enterprise Manager collects information about the type of license installed on Veeam backup
servers connected to it and the number of instances in the license. When Veeam Enterprise Manager replicates
databases from backup servers, it also synchronizes license data: checks if the license installed on the Veeam
backup server coincides with the license installed on the Veeam Backup Enterprise Manager server. If the
licenses do not coincide, the license on the Veeam backup server is automatically updated with that on the
Veeam Backup Enterprise Manager server.
Keep in mind that you cannot use the same Veeam Backup 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 Veeam Backup Enterprise Manager a backup server with the Veeam Cloud Connect
service provider license installed. Veeam Backup 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,
Veeam Backup 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.
Using Veeam Backup Enterprise Manager to work with Veeam Backup & Replication licenses reduces
administration overhead. You can manage and activate licenses for the entire backup infrastructure from a
single web console. You can view what workloads consume instances in the license, install a new license, or
revoke the license from protected workloads.
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
Starting from Veeam Backup Enterprise Manager 11a (build 11.0.1.1261), Veeam Backup Enterprise Manager
applies its license to connected backup servers that have Veeam Backup & Replication version 10 or later
installed.
To install a 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.
Each type of workloads processed by Veeam Backup & Replication consumes a specific number of instances in
the license. For more information on Veeam licensing, see Veeam Licensing Policy.
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.
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 my.veeam.com 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 Update license key automatically check box.
NOTE
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 Dashboard 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:
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:
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 quickly 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 Type 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.
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.
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.
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 install Veeam Backup Enterprise Manager either on a physical or virtual machine, co-install it with
Veeam Backup & Replication or install it separately.
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.
• Check the Known Issues section of the Veeam Backup & Replication 12 Release Notes.
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, 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 Setup.exe file from the image or disk.
4. Click Install.
IMPORTANT
It is strongly recommended that you install Veeam Backup Enterprise Manager using Autorun or the
Setup.exe 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.
3. To install new licenses automatically when you renew or expand your contract, select the Update license
automatically check box. 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 System 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.
Database engine PostgreSQL The setup installs PostgreSQL 15.1 locally on the
Veeam Backup Enterprise Manager server.
Database name VeeamBackupReporting The setup deploys the Veeam Backup Enterprise
Manager configuration database on the locally
installed instance of PostgreSQL.
Catalog service 9393 The catalog service port is used by the Veeam Guest
port Catalog Service to replicate catalog data from
backup servers to Veeam Backup Enterprise
Manager.
Web UI ports For HTTP protocol: 9080 These ports are used for accessing Veeam Backup
Enterprise Manager web interface.
For HTTPS protocol: 9443
REST API service For HTTP protocol: 9399 These ports are used for accessing Veeam Backup
ports 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:
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
Note that 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 already installed PostgreSQL instance or install a new one.
To install a new PostgreSQL instance, select the Install a new instance option. The setup will
install PostgreSQL 15.1 on the Veeam Backup Enterprise Manager server and create a database
with the VeeamBackupReporting name.
To use an already installed PostgreSQL instance, select the Use the existing instance option.
Enter the instance name in the HOSTNAME:PORT format. In the Database name field, specify a
name for the Veeam Backup Enterprise Manager configuration database.
o [For Microsoft SQL Server] You can use an already installed Microsoft SQL Server database only.
ii. In the Database name field, specify a name for the Veeam Backup Enterprise Manager
configuration database.
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 Veeam Backup Enterprise Manager), the setup wizard will notify about it. To connect to the
detected database, click Yes. If necessary, Veeam Backup 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.
The default installation folder is %ProgramFiles%\Veeam\Backup and Replication.
2. To install Veeam Cloud Connect Portal, select the Add 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 Catalog location
field.
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.
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.
Click View certificate to review the details of the selected certificate.
3. To enforce TLS 1.2 encryption protocol for network connections, select the High 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
product 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.
1. Start the setup wizard on the Veeam Backup Enterprise Manager server. For more information, see Start
Setup Wizard.
2. Read and accept the License Agreement. For more information, see Read and Accept License Agreement.
3. At the Maintenance Mode step of the setup wizard, select the Repair option and click Next.
4. Specify the service account credentials that will be used during the Veeam Backup Enterprise Manager
repair. For more information, see Specify Service Account Settings.
5. At the Ready to Install step of the Setup Wizard check the installation prerequisites and click Install.
The setup wizard will re-install the Veeam Backup Enterprise Manager components. Wait for the installation
process to complete and click Finish to exit the setup wizard.
8. Begin upgrade.
9. Finalize upgrade.
• To upgrade Veeam Backup Enterprise Manager to version 12, you must be running version 10a
(build 10.0.1.4854) or later. To upgrade from earlier versions, contact Veeam Customer Support.
• 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 upgrade 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 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 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.
• Check the Known Issues section of the Veeam Backup & Replication 12 Release Notes.
• With Veeam Backup Enterprise Manager and connected Veeam backup servers, remember to begin the
backup infrastructure upgrade process with Veeam Backup Enterprise Manager. Backup servers should be
upgraded after that. If you have a backup server installed on the same machine, upgrade it immediately
after completing upgrade of the Veeam Backup Enterprise Manager server.
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, 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 Setup.exe file from the image or disk.
4. Click Upgrade.
To open Veeam Help Center from the upgrade wizard, click View Documentation.
3. To install new licenses automatically when you renew or expand your contract, select the Update license
automatically check box. For more information on license update, see Updating License.
You can select an account under which you want to run the Veeam Backup Enterprise Manager Service:
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
After you upgrade Veeam Backup Enterprise Manager, you can migrate its configuration database to
PostgreSQL using the Enterprise Manager Database Migration and Configuration Database Connection
Settings utilities. For more information, see Veeam Backup Enterprise Manager Utilities.
a. 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.
b. In the Database name field, specify a name for the configuration database.
2. 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.
3. If the configuration database is in use by another Enterprise Manager server, the wizard will notify about
it. To continue the installation, click Yes.
4. If the wizard detects a configuration database with the specified name (for example, it was created by a
previous installation of Enterprise Manager), the wizard will notify about it. To connect to the detected
database, click Yes.
Veeam Backup 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.
3. New features of Veeam Backup Enterprise Manager version 12 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 Veeam Backup Enterprise Manager 12 (build 12.0.0.1420) installed.
For information on how to upgrade from product version 10a or later, see Upgrading to Veeam Backup
Enterprise Manager 12.
• With Veeam Backup 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 12 section of the Veeam Backup & Replication User Guide.
Performing Update
To install the latest update for Veeam Backup & Replication, 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 DOWNLOAD 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 Server.
1. From the Start menu, select Control Panel > Programs 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 selected. 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.
1. Double-click the Veeam Backup Enterprise Manager icon on the desktop or select Programs > Veeam >
Veeam Backup Enterprise Manager from the Start menu.
Alternatively, open your web browser and enter the following URL in the address bar:
https://<hostname>:9443
For example:
https://vbr-em:9443
i. In the Username and Password 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 Remain 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 Managing 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 Sign Out.
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 Dashboard tab. For more information,
see Viewing Operation Statistics.
• View detailed information about Veeam backup servers managed by Enterprise Manager using the Reports
tab. For more information, see Reports on Backup Servers.
• Manage jobs on all managed Veeam backup servers using the Jobs tab. For more information, see
Managing Jobs.
• Browse for file share backups, search for file shares, delete file shares and perform tile-level restore from
file share backups using the File Shares tab. For more information, see Working with File Shares.
• Browse for machine backups, search for machines, delete machines and perform failover and replication
operations with managed virtual or physical machines using the Machines 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 Backup 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 Working with VMware 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 Managing
Accounts and Roles.
• Manage licenses and view detailed reports on license consumption using the Licensing tab. For more
information, see Licensing.
• Set email notifications using the Notifications tab. For more information, see Configuring Notification
Settings.
• View product versions, URLs and log paths using the About tab. For more information, see Viewing
Information About Enterprise Manager.
• 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 Server
• Audit Reports
You can add backup servers by specifying its DNS name, IPv4 or IPv6 address. For more information on IPv6
support, see the IPv6 Support section of the Veeam Backup & Replication User Guide.
Before you add backup servers to the Veeam Backup Enterprise Manager infrastructure, consider the following
limitations:
• You must not add a backup server to multiple instances of Veeam Backup Enterprise Manager.
• You must not add a backup server cloned from an already added backup server.
• All backup servers must be based on the same database engine as Veeam Backup Enterprise Manager
(PostgreSQL or Microsoft SQL Server).
• You must 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 restore the configuration database
from one backup server to another. In case you want to manage such a backup server with Enterprise
Manager, contact Veeam Customer Support.
• Install the same product version on the Veeam Backup Enterprise Manager server and backup servers. If
you use different versions of Veeam Backup Enterprise Manager and Veeam Backup & Replication, you
may not be able to leverage all features in Veeam Backup Enterprise Manager.
Veeam Backup Enterprise Manager supports adding backup servers with Veeam Backup & Replication 10a
or later.
• 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.
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.
5. In the DNS name or IP address of the Veeam backup server field, enter a full DNS name or IP address of
the server you want to add.
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 Port 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 display 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.
By default, when you install Veeam Backup & Replication on a backup server, the Veeam Backup Administrator
role is assigned to the Windows Server Administrators group, so you can choose a user from the Administrators
group as an account that will be used to communicate with the backup server. As soon as the group settings can
be changed, it is recommended to explicitly assign the Veeam Backup Administrator role to the user account.
For more information on assigning roles, see the Roles and Users section of the Veeam Backup & Replication
User Guide.
2. To open the Configuration view, click Configuration in the top right corner.
4. Select a backup sever from the list and click Edit on the toolbar.
Alternatively, you can right-click the selected backup server and select Edit.
After you remove a backup server, Enterprise Manager stops collecting data from the backup server and
showing information about the backup server such as jobs, backed up machines and so on.
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.
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 data collection job session. For more information, see Data
Collection Job Sessions.
NOTE
• Data collection job collects data from all added backup servers at once.
• To ensure periodic update of the information available to Veeam Backup Enterprise Manager users,
use periodic data collection.
1. Select Backup Servers on the left of the Configuration view and click Schedule on the toolbar.
2. In the Data Collection Settings window, specify the desired interval in the Periodically every option.
3. Click OK.
You can also disable periodic data collection. In this case, you can only start the data collection job manually.
1. Select Backup Servers on the left of the Configuration view and click Schedule on the toolbar.
3. Click OK.
You can view the details on the started job session in the Sessions section of the Configuration view. For more
information, see Data Collection Job Sessions.
2. In the list of sessions, select the necessary session and click the link in the Status column.
3. In the displayed window, Veeam Backup Enterprise Manager shows the list of the job session events. For
each job session event, Enterprise Manager shows the time of the event, its current status and information
about the event.
For each backup server, the report contains the following data.
Parameter Description
Status 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
Machines Number of machines processed by the backup server, including the machines
from imported or orphaned backups.
File Shares Number of 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 Backup 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.
You can export displayed information to a file using the Export 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. In the Backup Servers section, select a backup server whose report you want to export.
Audited Operations
Audit reports contain records about the following operations performed on a backup server:
IMPORTANT
Backup window interval that you specify here, effects the job settings that you configure for tenants that
use the following portals:
4. Use the Activity graph scale options to switch between graph types: Linear and Logarithmic.
5. Select the Show backup window check box to highlight the backup window on the dashboard chart.
6. 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.
IMPORTANT
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 in the Roles tab of the
Configuration view. Such accounts are configured in 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
Portal Yes Full access to all available
the users listed in the
Administrator 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, Oracle or other), the restore scope of Exchange administrators is Exchange server
machines, and so on. For more information on configuring restore scope, see Configuring Restore Scope.
IMPORTANT
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
Adding Account
To add an account:
3. From the Account type list, select a type of the account: User, Group, External User or External Group. For
more information, see Accounts.
4. 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 Accounts.
5. 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).
Editing Account
To edit settings of an added user or group, select it in the list of roles and click Edit on the toolbar. Then edit
user or group settings as required.
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. Click Add to add an account, or select an existing account and click Edit.
4. In the Manage Scope Objects window, click Add object and select what type of objects to display. You can
select from the following types: Hyper-V, vSphere, vCloud, Protection Group, File share or Nutanix AHV
object.
5. In the Add Objects window, select the objects you allow the user to restore.
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 switch between virtual infrastructure views using the buttons in the top right corner:
o For VMware objects, you can switch between the Hosts and Clusters, VMs and Templates, Datastores
and VMs and Tags and VMs views.
NOTE
For setting up self-service recovery restore scope, consider that reverse DNS lookup on Veeam
Backup Enterprise Manager server must be functional. Otherwise, the Add Objects window will
display incomplete infrastructure.
After the users log in to Enterprise Manager, they will be able to view objects and files included in their restore
scope.
NOTE
The Machines and File Shares tabs display only machines and file shares 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
Machines, File Shares or Files tabs right after the login to Enterprise Manager. If you cannot find an object after
making a search query, click the link I don’t see my VM to refresh the view. This link, however, will not be visible
until you have made an unsuccessful search.
By default, users can restore all types of files from available backups. Files can be restored either 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 when adding or editing
an account.
2. Click Add to add an account, or select an existing account and click Edit.
3. In the Allow restore of section, to allow restore of entire machines and VM disks of machines included in
the restore scope, select the Entire machines and disks check box.
4. 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.
5. To allow restore of Microsoft Exchange items (mail, calendars, tasks), select the Microsoft Exchange items
check box.
6. To allow restore of databases, select the Databases 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 Oracle databases to allow restore of Oracle databases on machines included in the user's
restore scope.
o Select PostgreSQL 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.
8. [For Microsoft Exchange items restore] Specify an Active Directory account that will be used to restore
Exchange items:
b. On the Directory Account tab, specify a user name and password of the necessary account. 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.
4. From the vSphere role list, select a vCenter Server role created in VMware vSphere.
5. 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).
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 Identity 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 Advanced Settings link and specify advanced SAML authentication settings. For more
information, see Specifying Advanced SAML Authentication Settings.
9. In the Enterprise 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 Identity Provider Configuration section
of the SAML Authentication view, click the Import 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 Identity Provider Configuration section, in the Entity ID field, specify a unique ID of the identity
provider.
2. In the Login 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 IdP 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 Enterprise 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 Identity Provider Settings section, select the Sign 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. For example, for VMware Platform Services Controller, select
PasswordProtectedTransport. By default, the Password option is selected.
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 Veeam Backup Enterprise Manager field.
• To export service provider settings of vSphere Self-Service Backup Portal, click the Download link next to
the vSphere Self-Service Backup Portal field.
1. Copy the links next to the SP Entity 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.
• If you are using the Standard edition of Veeam Backup & Replication in your virtual environment, Veeam
Backup Enterprise Manager will keep index files only for those backups that are currently stored on disk
(that is, the backups are available on backup repositories).
• If you are using the Enterprise or Enterprise Plus edition, Veeam Backup Enterprise Manager will keep
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.
IMPORTANT
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.
1. To open the Configuration view, click Configuration in the top right corner.
3. On the Session History tab, in the Guest file system catalog section, specify how long index files must be
stored on the Veeam Backup 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 Save button under the Event history section. New retention settings will be
saved in the Enterprise Manager database, and pop-up message notifying you on the update will be
displayed at the top of the window.
4. In the Event history section, specify the period for which Veeam Backup Enterprise Manager should keep
historical data available in the main working area of the Veeam Backup 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 Keep only last 13 weeks. The minimum allowed value is 1 week, and the maximum allowed
value is 53 weeks.
Note that the retention settings you specify in Veeam Backup Enterprise Manager are propagated to all Veeam
backup servers connected to it. These settings override the Session history retention values specified at the
level of the Veeam backup server.
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. On the Server Settings tab, select Google Gmail from the Mail server list.
7. Allow Veeam Backup Enterprise Manager to have access to your Google account and send email
notifications on your behalf.
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.
3. Create the OAuth client ID credentials — a client ID and client secret for the Veeam Backup Enterprise
Manager application.
As an authorized redirect URI, specify the following:
https://<EnterpriseManagerServer>:9443/api/Notifications/GrantPermissions
where <EnterpriseManagerServer> is a host name or IP address 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. On the Server Settings tab, select Microsoft 365 from the Mail server list.
3. In the Application client ID field, specify the client ID assigned to your Azure Active Directory application.
4. In the Tenant ID field, specify your Azure Active Directory tenant ID.
5. In the Client secret field, specify the client secret assigned to your Azure Active Directory application.
8. Allow Veeam Backup Enterprise Manager to access your Microsoft 365 account and send email
notifications on your behalf.
1. Log in to the Azure portal under an account that you want to use for sending email notifications. The
account must have an active subscription.
https://<EnterpriseManagerServer>:9443/api/Notifications/GrantPermissions
where <EnterpriseManagerServer> is a host name or IP address of the host where the Enterprise
Manager server resides.
3. Grant the application the Mail.Send 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. On the Server Settings tab, select Custom SMTP from the Mail server list.
3. 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.
4. In the Timeout field, specify a timeout for email server — this should be a value from 1 to 3600 seconds.
Default is 100 seconds.
5. If the SMTP server requires SSL connection, select the Use SSL check box.
6. If the SMTP server requires authentication, select the Requires authentication check box and specify
authentication credentials.
7. Click Save.
3. Select the Send daily notification at check box and specify the time when you want a notification email to
be sent.
5. In the To field, enter an email address of the notification recipient. Use a comma to specify multiple
addresses.
6. In the Subject 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.
7. Click Save.
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.
5. In the To field, enter an email address of the notification recipient. Use a comma to specify multiple
addresses.
7. Select request statuses for a report. The notification email will be sent if the request is Pending, Ready,
Canceled, Approved, Failed or Stopped.
8. Click Save.
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 VM Recovery
• Entire VM Restore
5. In the To field, enter an email address of the notification recipient. Use a comma to specify multiple
addresses.
6. Click Save.
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.
3. Select the Check for product and hypervisor updates periodically check box.
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.
6. Click Save.
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.
5. In the To field, enter an email address of the notification recipient. Use a comma to specify multiple
addresses.
6. Click Save.
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.
To download Enterprise Manager logs, in the About section of the Configuration view, click Download support
logs.
Alternatively, you can find the Enterprise Manager log files on the Enterprise Manager server at the following
paths:
C:\ProgramData\Veeam\Backup\Svc.VeeamBES.log
C:\ProgramData\Veeam\Backup\Svc.VeeamCatalog.log
C:\ProgramData\Veeam\Backup\Veeam.WebApp.log
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.
For more information, see Connecting to Backup Servers.
• 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.
For more information, see Adding, Editing and Removing Backup Servers.
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 Catalog 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.
For more information, see Updating TLS Certificates.
• To update the certificate used by Veeam Backup Enterprise Manager Service and Veeam Guest Catalog
Service, go to Configuration > Backup Servers and click Update 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.
• messages.pot — 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.
IMPORTANT
Make sure the JSON translation files are named as follows: messages.xx.json,
vcloud_messages.xx.json, vsphere_messages.xx.json. For more information on file
naming, see File Names.
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 messages.pot
o vcloud_messages.pot
o vsphere_messages.pot
For more information on file names and formats, see Language Files Overview.
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.
Parameter 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.
Plural-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.
To convert a file from the PO format to the JSON format, use the
Veeam.Backup.Localization.PoConverter.exe utility.
1. To locate the utility, use the cd command. By default, the utility is located in the Enterprise Manager
folder.
cd '<path>'
For example:
.\Veeam.Backup.Localization.PoConverter.exe '<po_file>'
For example:
TIP
To view help for the Veeam.Backup.Localization.PoConverter.exe 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).
• Machines — number of machines processed by the backup servers (including VMware VMs, Microsoft
Hyper-V VMs, and Veeam Agent machines managed by backup servers). 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 file share backups:
The Last 24 hours / Last 7 days widget reports on the job session results for the selected period.
• 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.
In the Last 24 hours view, the highlighted part of the chart represents the configured backup window. You can
configure the backup window in the chart settings. For more information, see Customizing Dashboard Chart.
• Enterprise Manager does not display backup policies created with the following Veeam solutions for cloud
environments:
• For Nutanix AHV VMs, Enterprise Manager displays only backup copy jobs.
• For physical machines, Enterprise Manager displays the following job types:
o Veeam Agent backup jobs managed by the backup server. For more information, see Support for
Veeam Agents.
To quickly find a job, you can use filters and the search field.
o Use the Backup server drop-down list to view the jobs of the selected backup server only.
o Use the Status filter to view the jobs with the selected job statuses.
Once you have selected necessary statuses, click the Apply button to apply the filter.
Besides the information presented in the list of jobs, the Jobs tab allows you to view advanced job data:
• To see a list of job sessions, click the job name link in the Name column.
• To see detailed statistics on the last job run, click the state link in the Status column.
NOTE
You can export displayed information to a file using the Export 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 Start.
• 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 Backup Copy Jobs Manually
section of the Veeam Backup & Replication User Guide.
• For more information on starting and stopping an 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.
IMPORTANT
• You can edit jobs if you have an Enterprise or Enterprise Plus license installed.
• From Veeam Backup Enterprise Manager, you cannot edit jobs that are managed by backup servers
of earlier versions as well as Veeam Agent backup jobs, file share backup 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 Edit Backup Job (or Edit Replication Job) wizard.
3. Select Edit.
Alternatively, you can right-click a job and select Job > Edit.
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 policy 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 policy 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.
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:
o For VMware objects, you can switch between the Hosts and Clusters, VMs and
Templates, Datastores and VMs and Tags and VMs views.
o For Hyper-V objects, you can switch between the Hosts and VMs, Hosts and
Volumes, and Hosts and VM Groups views.
Excluding VMs
You can also exclude individual VMs from VM containers (for example, if you need to back up the whole VMware
or Hyper-V server except several machines running on this server).
2. In the Exclusions window, click Add 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 order. 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.
o General Settings
General Settings
On the General tab, you can specify general application-aware processing settings.
1. In the Applications 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 Transaction Logs Processing section unavailable.
o [For Microsoft Exchange and Microsoft SQL VMs] If you want Veeam Backup & Replication to process
application logs, select Process 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 Perform 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 Processing Settings
window.
• [For Oracle VMs and PostgreSQL VMs] You must specify settings for application log handling on the
Oracle and PostgreSQL tabs of the VM Processing Settings window. For more information, see Oracle
Archived Redo Log Settings and PostgreSQL Archive Log Settings.
3. In the Persistent guest agent section, specify if Veeam Backup & Replication must use persistent guest
agents on each protected VM for application-aware processing.
By default, Veeam Backup & Replication uses non-persistent runtime components.
Veeam Backup & Replication deploys runtime components on each protected VM when the backup job
starts, and removes the runtime components as soon as the backup job finishes.
Select the Use persistent 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.
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 Enable application-aware processing check box
is selected.
3. In the displayed window, select the Microsoft SQL Server VM from the list and click Edit.
4. On the General tab of the VM Processing Settings window, make sure the following options are selected:
o In the Applications section, either the Require successful processing or Try application processing, but
ignore 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.
o Select Do not truncate logs to preserve transaction logs. When the backup job completes,
Veeam Backup & Replication will not truncate transaction logs on the Microsoft SQL Server VM.
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.
7. If you have selected the Backup logs periodically option, specify settings for transaction log backup:
a. In the Backup 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 Enable application-aware processing check box
is selected.
3. In the displayed window, select the Oracle VM from the list and click Edit.
4. On the General tab of the VM Processing Settings window, make sure that either the Require successful
processing or Try application processing, but ignore failures option is selected.
IMPORTANT
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.
5. On the Oracle tab of the VM Processing Settings window, specify log processing settings.
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.
b. Specify how Veeam Backup & Replication must process archived redo logs on the Oracle VM.
Select Do not delete 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.
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 Backup 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.
IMPORTANT
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 Backup 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.
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 Enable application-aware processing check box
is selected.
3. In the displayed window, select the PostgreSQL VM from the list and click Edit.
5. On the PostgreSQL tab of the VM Processing 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 Add 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 Database user with password if you have specified an account with password-based
authentication. In this case, you must provide Veeam Backup & Replication with the account
password that will be stored in the Veeam Backup & Replication database.
Select Database 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.
c. To back up PostgreSQL archive logs with Veeam Backup & Replication, select the Backup 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 Backup 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 PostgreSQL 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.
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 Enable application-aware processing check box
is selected.
3. In the displayed window, select a VM from the list and click Edit.
4. On the File Exclusions tab, specify the files that must be excluded from the backup.
o Select Exclude the following files and 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.
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 Edit.
Consider the following:
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 Add Machine and choose the necessary VM. Next, select the
machine from the list and click Edit to customize VM settings.
o To discard custom settings of a machine, select it from the list and click Remove.
3. In the Indexing Settings window displayed for the selected machine, go to the Windows 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 Index everything if you want to index all guest OS files inside the machine.
o Select Index 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 Add and Remove buttons.
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 Add 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 Elevate specified account to
root check box.
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 password 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.
IMPORTANT
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 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 Add 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.
For more information, see Schedule Settings.
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 Backup 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 allowed backup window check box and click Window.
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 Daily 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 possible 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 Periodically 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 Start time within an hour field, specify the exact
time when the job must start.
A repeatedly run job is started by the following rules:
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 and file share backup jobs.
2. Expand the menu commands by clicking Job, then select Active Full.
NOTE
• The job cloning functionality is available only in the Enterprise and Enterprise Plus editions of
Veeam Backup & Replication.
• The job cloning functionality is not available for file share 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 configuration 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 Veeam backup servers of earlier versions added to Enterprise Manager, jobs managed by these
servers cannot be deleted using Enterprise Manager.
To delete a job:
3. You will be prompted to delete backup files. To delete backup files, select the Delete backup files check
box and click Yes to confirm the operation.
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.
• RPO — recovery point objective, that is, how often to create short-term restore points
• Max 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 Backup server list to view the policies of the selected backup server only.
o Use the Status filter to view the policies with the selected statuses only.
Once you have selected necessary statuses, click the Apply button to apply the filter.
In addition to the information presented in the list of policies, the Policies tab allows you to view advanced
policy data. To see detailed policy statistics, click the state link in the Status column.
You can export displayed information to a file using the Export link on the toolbar. This file then can be
opened on the client machine using the associated application.
• Policy schedule
1. Open the Policies 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 Add.
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
and Clusters, VMs and Templates, Datastores and VMs and Tags and VMs.
2. In the Exclusions window, click Add and select machines that you want to exclude.
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 Reporting. 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 for how long to store short-term restore points.
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.
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 Edit.
Consider the following:
o To customize settings of a machine added as part of a container, add the machine as a standalone
instance. For that, click Add machine and choose the necessary VM. Next, select the machine from the
list and click Edit 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 Applications 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 Transaction Logs Processing 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 Process 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 Oracle tab. For more information, see
Oracle Archived Log Settings.
o Select Perform 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 PostgreSQL tabs are not available.
3. In the Persistent guest agent section, specify if Veeam Backup & Replication must use persistent guest
agents on the VM for application-aware processing.
By default, Veeam Backup & Replication uses non-persistent runtime components.
Veeam Backup & Replication deploys runtime components on each protected VM when the backup job
starts, and removes the runtime components as soon as the backup job finishes.
Select Use persistent guest agent 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.
1. At the Guest Processing step of the wizard, make sure the Enable application-aware processing check box
is selected.
3. In the displayed window, select the Microsoft SQL Server VM from the list and click Edit.
4. On the General tab of the VM Processing Settings window, make sure the following options are selected:
o In the Applications section, either the Require successful processing or Try application processing, but
ignore failures option must be selected.
o In the Transaction logs processing section, the Process transaction logs with this job option must be
selected.
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 Enable application-aware processing check box
is selected.
3. In the displayed window, select the Oracle VM from the list and click Edit.
o In the Applications section, either the Require successful processing or Try application processing, but
ignore failures option must be selected.
o In the Transaction logs processing section, the Process transaction logs with this job option must be
selected.
5. On the Oracle tab of the VM Processing 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 Add 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 delete 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.
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 Add 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 Elevate specified account to
root check box.
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 password 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.
IMPORTANT
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 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 Add machine and choose a machine whose settings you want to
customize.
To delete a policy:
IMPORTANT
In the Enterprise Plus edition of Veeam Backup & Replication, users with the Portal Administrator role can
customize a 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 entire file
shares or selected file types. Possible delegation options are described in the Configuring Permissions for
File and Application Item Restore section.
Veeam Backup Enterprise Manager allows you to search for the necessary file share in the list of file shares. This
may be useful in case you manage large backup infrastructure with multiple backup servers that process
multiple file shares.
You can search for file shares in one of the following ways:
• Filter file shares by the backup server. To do this, from the Backup server list, select the necessary backup
server. Veeam Backup Enterprise Manager will display backups of only those file shares that are processed
by the selected backup server.
NOTE
The Backup server filter is only available for users with the Portal Administrator or Portal User role.
• Search file shares by the file share name. To do this, enter the name or a part of the name in the search
field. Veeam Backup Enterprise Manager will display backups of only those file shares whose names match
the text that you entered.
Besides the information presented in the list of file shares, the File Shares tab allows you to view advanced data
about each file share:
• To see detailed information about a file share, click its name in the File Share column.
• To see detailed information about file restore points, click a link in the Restore Points column.
You can export displayed information to a file using the Export link on the toolbar. This file then can be
opened on the client machine using the associated application.
If you use the Enterprise or Enterprise Plus edition of Veeam Backup & Replication in your virtual environment,
consider that 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 the repository is no longer available.
2. In the Search backups of field, enter the name of a file share whose files you want to browse or click the
Pick from List link and select the necessary file share in the Select Object window.
3. Click Mount.
4. Wait while Veeam Backup & Replication mounts the file share from the backup to the backup server. When
the process is completed, Veeam Backup Enterprise Manager displays the content of the backed-up file
share.
5. You can browse files contained in all restore points created by the file share backup job or in a specific
restore point.
o By default, the All restore points option is selected. With this option selected, you can browse files
contained in all restore points created by the file share backup job.
For each file in the backup, Enterprise Manager displays the number of file versions and the date
when the latest file version is created. If a file has more than one version, you can select a necessary
file version during the restore process. For more information, see Restoring Specific Files and Folders.
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.
• Instant file share recovery allows you to recover a point-in-time file share state.
• Restore of files and folders allows you to select files and folders to restore to one of the restore points.
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 File Shares 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 Add 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.
Until you finalize instant recovery of all recovered file shares, a notification about running instant recovery
sessions is displayed on the Dashboard tab.
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 Migrate to Production.
• Select Original 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 Path to file field, specify a path to the folder on the selected file share where the files must be
restored.
Select this option if you want to overwrite the existing file only if it is older than the restored file.
• Restore anyway
Select this option if you want to overwrite the existing file with the restored file in all cases.
• Automatic — select this option if you want Veeam Backup & Replication to perform the switch
automatically right after the entire file share will be restored.
• Manual — 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.
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 Edit 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 Manual — 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 Instant Recovery 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.
Multiple selection is also possible. For details, see Viewing File Share Backups and Browsing File Share
Backups.
o If you select Overwrite, the file from the backup will replace the original file in the file share.
o If you select Keep, the file from the backup will be restored next to the original file in the file share.
The restored file will have the _RESTORED_<date>_<time> suffix in the file name.
Veeam Backup Enterprise Manager will start the restore operation and display the progress and result of the
operation in the File Restore History view.
Downloading Files
If you choose to download the restored file, Veeam Backup Enterprise Manager interacts with the Veeam backup
server to extract the necessary file from the backup. The user who initiated file restore will be able to download
the file to the local machine, that is, the Veeam Backup Enterprise Manager server.
To download a file:
1. Locate the necessary file using browse or search possibilities of Veeam Backup Enterprise Manager. For
details, see Viewing File Share Backups and Browsing File Share Backups.
3. If you browsed for files in all restore points created for the file share, and the restore points contain
multiple versions of the file that you want to restore, Veeam Backup Enterprise Manager will prompt you
to select the file version. In the Select version window, select the restore point that contains the
necessary file version and click OK.
5. Wait for restore session to complete and the file to be retrieved from the backup.
1. Locate the necessary file using browse or search possibilities of Veeam Backup Enterprise Manager. For
more information, see Viewing File Share Backups and Browsing File Share Backups.
3. If you browsed for files in all restore points created for the file share, and the restore points contain
multiple versions of the file that you want to restore, Veeam Backup Enterprise Manager will prompt you
to select the file version. In the Select version window, select the restore point that contains the
necessary file 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 Pending Restore window, select check boxes next to the files that you want to restore. Use the
check box next to the header of the Name 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. In the Log tab of the File Restore
History view, click the download 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.
Veeam Backup Enterprise Manager keeps links for downloaded files in the history for one day. To
download a file that was previously restored:
2. In the list of file share backups, select the necessary backup and click Delete.
To locate the necessary backup, you can filter file share backups by the backup server or search by the file
share name.
NOTE
If several file shares are processed by the same backup job, deletion of the selected file share backup will
not affect other file shares 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
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 from the backups created by
backup copy jobs. For more information, see Restoring Guest OS Files.
• 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.
Besides the information presented in the list of machines, the Machines tab allows you to view advanced data
about each machine:
• To see detailed information about a machine, click its name in the Machine column.
• To see detailed information about machine restore points, click a link in the Restore Points column.
You can export displayed information to a file using the Export link on the toolbar. This file then can be
opened on the client machine using the associated application.
NOTE
• If multiple machines are processed by the same backup job, deletion of the selected machine will
not affect other machines in the job.
• The delete operation is not available for replica machines, storage snapshots and machines backed
up to tape.
1. On the Machines 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 a machine name.
2. Click Delete.
3. To remove backups marked with weekly, monthly, and yearly GFS flags, select the Remove GFS full
backups check box.
The check box is displayed if the machine has GFS backups.
You can perform quick backup for machines that meet the following requirements:
• Physical or virtual machine is processed by a regular backup job or Veeam Agent backup job managed by
the backup server.
• Full backup file for the machine exists in the backup repository.
NOTE
Quick backup is not available for VMware Cloud Director VMs processed with VMware Cloud Director jobs.
Alternatively, you can right-click the machine and select Quick Backup.
To view the details of the quick backup, open the backup job session that processes the selected machine.
1. On Jobs tab, select the backup job that processes the machine.
3. To view the session log, on the opened Reports tab, select 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.
IMPORTANT
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 Machines tab, select the necessary VMware vSphere VM from the list.
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.
IMPORTANT
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:
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 pool 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.
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 Servise section of the
Veeam Backup & Replication User Guide.
IMPORTANT
If the size of recovered VM disks is greater than 2 TB, you must not place redo logs on a VSAN datastore.
Otherwise, Veeam Backup & Replication will fail to create a snapshot for the recovered VMs. For more
information, see VMware Docs.
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 Power 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 Machines tab, click History.
Until you finalize instant recovery of all recovered VMs, a notification about running instant recovery sessions is
displayed on the Dashboard tab.
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.
i. Select the Pick datastore for selected virtual disks check box.
ii. Select the configuration files or one of the hard disks and click Change datastore.
iii. In the Add objects window, choose the necessary datastore and click OK.
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 for VMs section of the Veeam
Backup & Replication User Guide.
1. On the Machines tab, select the necessary VMware Cloud Director VM from the list.
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.
IMPORTANT
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:
At this step of the wizard, you configure destination settings such as the recovered VM name and target vApp.
1. In the vApp 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.
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 Servise 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.
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 Power 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 Machines tab, click History.
Until you finalize instant recovery of all recovered VMs, a notification about running instant recovery sessions is
displayed on the Dashboard tab.
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 Cloud Director VM from the list.
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 Machines tab, select the necessary Hyper-V VM from the list.
• 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.
IMPORTANT
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.
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 Register 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 Preserve 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.
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 Edit Path.
Alternatively, you can double-click a file to edit its 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:
\\172.16.11.38\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.
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 Power 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 Machines tab, click History.
Until you finalize instant recovery of all recovered VMs, a notification about running instant recovery sessions is
displayed on the Dashboard tab.
Testing Recovered VM
To test a recovered VM before you migrate it to production, you can launch the VM console from
Veeam Backup & Replication or open the console from the Hyper-V client. For more information, see the
Finalizing Instant Recovery to Microsoft Hyper-V section of the Veeam Backup & Replication User Guide.
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.
IMPORTANT
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 Machines 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 Entire 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 Entire 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 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:
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 pool 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 Datastore.
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 type and click OK.
For more information about disk types, see VMware Docs.
NOTE
Disk type change is supported only 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 into vCloud
vApp section of the Veeam Backup & Replication User Guide.
1. Open the Machines 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 Entire 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 Entire 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 restored VM, target host, VM
folder and resource pool.
1. In the vApp 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 Templates, 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 Policy 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 Machines 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 Entire 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 Entire 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 Register 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 Edit Path.
Alternatively, you can double-click a file to edit its 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:
\\172.16.11.38\Share01.
3. Click OK.
IMPORTANT
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.
For more information on virtual disk restore, see the Virtual Disk Restore section of the
Veeam Backup & Replication User Guide.
IMPORTANT
• Disk restore is available in the Enterprise and Enterprise Plus editions of Veeam Backup &
Replication.
• Disk restore is supported for backups of VMware vSphere VMs only.
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.
1. On the Machines tab, select the necessary machine backup in 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 a machine name.
3. At the Restore Point step of the wizard, select the restore point that will be used to restore the VM disk.
a. By default, Veeam Backup Enterprise Manager offers you to restore 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.
b. In the Disk Mapping section, select check boxes next to virtual disks that you want to restore.
c. 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 types, see VMware Docs.
NOTE
Disk format change is supported only for VMs with Virtual Hardware version 7 or later.
d. [For disk restore to the original location and with original format] Instead of restoring an entire virtual
disk from a backup file, you can instruct Enterprise Manager to recover only those data blocks that are
necessary to revert the disk to the selected restore point. To do this, select the Quick rollback check
box. Quick rollback significantly reduces the recovery time and has little impact on the production
environment.
a. In the Disk Mapping section, select the necessary virtual disk and click the Change disk mapping link.
b. In the Virtual Disk Properties window, click Choose next to the Datastore 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.
If you want to attach the restored disk to the VM as a new drive, select a node that is not
occupied yet.
d. Repeat steps a–c for every virtual disk that you want to restore.
6. At the Secure Restore step of the wizard, you can instruct Veeam Backup & Replication to perform secure
restore — scan virtual disk data with antivirus software before restoring the disk. For more information on
secure restore, see the Secure Restore section of the Veeam Backup & Replication User Guide.
To specify secure restore settings:
a. Select the Scan the restored disk for malware prior to performing recovery check box.
b. Select the action that Veeam Backup & Replication will take if the antivirus finds a virus threat:
Proceed with recovery but do not attach infected disks to the target VM. Select this option if
you want to continue the virtual disk restore. In this case, the restored disk will not be attached
to the target VM.
Abort disk recovery. Select this option if you want to cancel the restore session.
7. At the Summary step of the wizard, complete the procedure of VM disk restore. To start a VM immediately
after the restore process completes, select the Power on target VM after disk is restored check box. Then
click Finish.
To view the progress of the virtual disk restore operation, on the Machines tab, click History.
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.
• To perform permanent failover, failback, undo failover, or create a failover plan, use the
Veeam Backup & Replication console.
Failover is an intermediate step that needs to be finalized. To do that, you can undo failover, perform
permanent failover or perform failback. You can take the final step in the Veeam Backup & Replication console.
For more information, see the Replica Failover and Failback section of the Veeam Backup & Replication User
Guide.
To perform failover:
2. Click Restore.
4. Click Failover.
Failover is an intermediate step that needs to be finalized. To do that, you can undo failover, perform
permanent failover, or perform failback. The final step you can take in Veeam Backup & Replication console. For
more information, see the Failover and Failback section of the Veeam Backup & Replication User Guide.
To perform failover:
2. Click Restore.
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 Plus and Minus buttons or switch between the
Hour and Day views.
4. Click Failover.
Failover is an intermediate step that needs to be finalized. To do that, you can undo failover, perform
permanent failover or perform failback. The final step you can take in Veeam Backup & Replication console. For
more information, see the Failover and Failback section of the Veeam Backup & Replication User Guide.
To perform failover:
1. On the Machines tab, select a machine processed by a Cloud Director replication job.
4. Click Failover.
Failover is an intermediate step that needs to be finalized. To do that, you can undo failover, perform
permanent failover or perform failback. The final step you can take in Veeam Backup & Replication console. For
more information, see the Failover and Failback section of the Veeam Backup & Replication User Guide.
To perform failover:
1. On the Machines 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 Plus and Minus buttons or switch between the
Hour and Day views.
4. Click Failover.
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 machines
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 Failover Plan window, select the necessary plan from the list, then specify the starting option you
need.
The following options are available for a failover plan:
o Start now — use this option if you need to fail over to the replicas’ latest restore point.
o Start 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. In 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.
NOTE
• 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
performed from any storage snapshot.
• With Enterprise Manager, you can browse and restore guest OS files of Nutanix AHV VMs only from
the backups created by backup copy jobs.
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 Support for Veeam Agents.
Browsing and restoring processes involve appropriate backup job setup, as well as mount and data transfer
operations.
1. To provide for browsing and search, Veeam Backup & Replication 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 Veeam 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 restore, 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 Veeam 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 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.
3. If you restore files from replica, a single mount point for all these operations (browsing, download, restore
to original location) will be created on the Veeam backup server.
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 operation. 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 Update
Now on the Search Catalog tab.
• To automatically run catalog replication after every backup job, open the Settings tab of the Configuration
view. On the Search Catalog tab, select Update 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 Status column.
1. To enable guest file indexing, use one of the options of the machine backup job: Index everything, Index
everything except, or Index 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 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.
If you configure a helper appliance for tenants that will perform self-service restore (from Veeam Self-
Service Backup Portal or vSphere Self-Service Backup Portal), be aware that multiple tenants may run the
restore procedure at the same time. In this case, if you have configured a static IP address for helper
appliances, a tenant will not be able to deploy a helper appliance until the IP address is in use by a helper
appliance of another tenant. To let tenants start multiple helper appliances, use a DHCP server in your
network and configure the helper appliance to obtain an IP address automatically.
If you plan to deploy multiple helper appliances to restore machines backed up by different backup
servers, their initial configuration must be performed on the backup servers. Centralized configuration
from Veeam Backup Enterprise Manager is not supported.
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 Search backups of field, enter the name of a machine whose files you want to restore or click the
Pick 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 the necessary date when backup was performed and a restore point created on that date.
Note that you cannot select dates when backup was not performed. 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.
IMPORTANT
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.
IMPORTANT
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 repository. Files from tape-archived backup will
appear in search results only if not found in the repository. (This capability is supported in the Enterprise
and Enterprise Plus editions.)
You can use one of two available search modes: simple or advanced.
The simple search allows you to search for guest OS files in the latest restore point of the selected machine
backup. To perform simple search:
2. In the Search backups of field, enter the name of a machine whose files you want to restore or click the
Pick 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 and click Search.
The advanced search allows you to search for guest OS files in all restore points of the selected machine backup
and filter search results by certain criteria. To perform advanced search:
1. Open the Files tab and click No Filter next to the search field.
2. In the search field, enter the name of the necessary file or a part of it.
o Last modification time — specify approximate time when the file was last modified or set a time
interval.
o Backup time — choose to search through the latest backup of the specified machine or all backups of
the machine created within a certain time interval.
o Type — select to search for files of specific type or with a certain extension.
IMPORTANT
• 1-Click file restore capability is available if you have the Enterprise or Enterprise Plus edition.
• 1-Click guest OS files restore from any 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; if restoring from replica, it will be mounted to
Veeam backup server. If 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 browsing
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).
IMPORTANT
This type of restore is only possible if the original machine is powered on and resides in the original
location.
1. Locate the necessary object using browse or search possibilities of Veeam Backup Enterprise Manager.
Multiple selection is also possible. For details, see Browsing Machine Backups for Guest OS Files or
Searching Machine Backups for Guest OS Files.
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 Permissions 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.
Veeam Backup Enterprise Manager will start the restore operation and display the progress and result of the
operation in the File Restore History view.
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. Locate the necessary file using browse or search possibilities of Veeam Backup Enterprise Manager. For
details, see Browsing Machine Backups for Guest OS Files or Searching Machine Backups for Guest OS
Files.
2. Click Download.
4. Wait for restore session to complete and for the file to be retrieved from the backup.
6. In the Log tab of the File Restore History view, click the download 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
more information, see Browsing Machine Backups for Guest OS Files or Searching Machine Backups for
Guest OS Files.
When a file is added to the restore list, the Pending restore notification appears at the top of the Enterprise
Manager window.
2. In the Pending 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 Name 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. In the Log tab of the File Restore
History view, click the download link.
The files are saved to the default download folder on your local machine.
TIP
Veeam Backup Enterprise Manager keeps links for downloaded files in the history for one day. To
download a file that was previously restored:
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.
IMPORTANT
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:
https://enterprise_manager_host:9443/selfrestore
2. Enter the account credentials to log in. Use the DOMAIN\USERNAME format to specify the user name. The
Files tab will open. By default, it displays guest OS files as of the latest restore point of the machine to
which you logged in with local administrative rights.
4. To view guest files as of earlier restore point, click the calendar icon and select the restore point. To view
guest files of another machine (if available to you), use the Search field or the Pick from List link.
5. 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 Machine Backups for Guest OS Files, Performing 1-Click File Restore.
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 Enable guest 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.
With Veeam Backup 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 restore items to the original location or a new location within the restore
scope. Users must also have sufficient permissions to restore application items. Users with the Portal
Administrator role have no limitations. For more information, see Configuring Accounts and Roles.
• To be able to restore Microsoft Exchange items, make sure Veeam Backup Enterprise Manager is installed
on the domain member server from the Microsoft Active Directory forest in which Microsoft Exchange
mailboxes are located.
• You can restore deleted Microsoft Exchange items to the production mailbox only.
• When you restore application items with Enterprise Manager, restore limitations listed in the
Considerations and Limitations section of the Veeam Explorers User Guide are also applied.
Performing Restore
To restore a Microsoft Exchange item to the production Exchange Server, take the following steps:
2. In the Username field, enter the account of Active Directory user whose mailbox will be 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. 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.
3. To specify a restore point from which to restore the database, in the Restore point 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).
• Restore to another domain is supported within the same forest only.
• If the specified user mailbox does not exist in the restore point, Veeam Backup Enterprise
Manager will display an error message.
o Mail
o Calendar
o Contacts
5. 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.
6. 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.
• 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 restore items to the original location or a new location within the restore
scope. Users must also have sufficient permissions to restore application items. Users with the Portal
Administrator role have no limitations. For more information, see Configuring Accounts and Roles.
• When you restore application items with Enterprise Manager, restore limitations listed in the
Considerations and Limitations section of the Veeam Explorers User Guide are also applied.
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 Pick from List link to choose a machine from the list of available Microsoft SQL
Server backups.
3. From the Database to restore list, select the database you need.
4. To specify a restore point from which to restore the database, 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. For a database backed up with transaction log backup turned on, you can also select the necessary point in
time using the Point 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 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.
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 Pick from List link to a machine from the list of available Microsoft SQL Server
backups.
3. From the Database 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 example, 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 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. For a database backed up with transaction log backup turned on, you can also select the necessary point in
time using the Point 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 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 Target 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 Target 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 Add the database to the following Availability Group check box and select an availability group
from the drop-down list.
2. In the The database 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 Add 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.
• 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 restore items to the original location or a new location within the restore
scope. Users must also have sufficient permissions to restore application items. Users with the Portal
Administrator role have no limitations. For more information, see Configuring Accounts and Roles.
• When you restore application items with Enterprise Manager, restore limitations listed in the
Considerations and Limitations section of the Veeam Explorers User Guide are also applied.
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 backup 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 Pick from List link to select a machine from the list of available Oracle backups.
3. From the Database 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 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. For a database backed up with transaction log backup turned on, you can also select the necessary point in
time using the Point 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.
7. Click Restore.
To restore an Oracle database with custom settings, use the Oracle Restore wizard.
2. In the Server field, enter a name of the Oracle server hosting the database you need to restore.
Alternatively, click the Pick from List link to select a machine from the list of available Oracle backups.
3. From the Database 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 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. For a database backed up with transaction log backup turned on, you can also select the necessary point in
time using the Point 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 Password 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 sysdba privileges.
• The user account must be granted appropriate permissions to access Oracle databases; Read and Write 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 port field, specify a port number of the target Oracle server (by default, port 22 is used).
a. Select the Private key is required for this connection check box.
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 Elevate specified account to root
check box.
b. To add the user account to the sudoers file, select the Add 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 password 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.
Consider that the user account must be a member of the dba group.
2. In the Global database name field, specify a full name of the database including its network domain.
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.
• 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 restore items to the original location or a new location within the restore
scope. Users must also have sufficient permissions to restore application items. Users with the Portal
Administrator role have no restrictions. For more information, see Configuring Accounts and Roles.
• When you restore application items with Enterprise Manager, restore limitations listed in the
Considerations and Limitations section of the Veeam Explorers User Guide are also applied.
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 user 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 Pick 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 databases.
6. For PostgreSQL instances with transaction log backup turned on, you can also select the necessary point in
time using the Point 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 PostgreSQL Restore wizard.
2. In the Server field, enter a VM name where the necessary PostgreSQL instance resides.
Alternatively, click the Pick 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 databases.
6. For PostgreSQL instances with transaction log backup turned on, you can also select the necessary point in
time using the Point 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.
1. In the Target 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 Private key is required for this
connection check box and specify the following private key settings:
i. In the Private key field, specify a file that contains a private key.
ii. In the Passphrase 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 Elevate 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 Add 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.
1. In the Data directory field, specify a path to the directory where the restored instance data will be stored.
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 Promote the instance to accept connections once the recovery is completed to make the
PostgreSQL instance available for connections.
o Select Pause the recovery process and keep the instance in a recovery mode to make the PostgreSQL
instance run but not accepting incoming remote TCP connections.
o Select Shut down 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.
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.
1. You have the Enterprise or Enterprise Plus edition of Veeam Backup & Replication.
2. 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.
3. Veeam Agent should be integrated with Veeam Backup & Replication. For more information, see the
Integration with Veeam Backup & Replication section of the following user guides:
NOTE
Veeam Agent backup policies, that is, Veeam Agent backup jobs managed by Veeam Agent, are not
displayed in the Enterprise Manager web UI. Enterprise Manager displays only 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 does 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.
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 sufficient 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 Guest OS Files in Machine Backups procedure.
6. To restore a file, take the steps similar to the Performing 1-Click File Restore procedure.
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.
IMPORTANT
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 Enable 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 Managed 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 Managed 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 creation, 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 Managed 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 Managed keys section, select a keyset you want to back up and click
Export.
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 Managed keys section, click Import.
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.
5. Click Import.
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.
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 Inactive 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 Managed keys section, select the necessary keyset in the list and click
Delete Key.
IMPORTANT
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.
1. As a Veeam Backup Enterprise Manager Administrator, you receive a request for password restore, for
example, by email.
2. Then you start the Password Recovery wizard by clicking the Password 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 Veeam
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 Veeam backup server, and you want to be
able to serve password restore request for these backups, ensure the original Veeam 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 Veeam 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 Veeam backup server, then a new public key will be
automatically generated for that Veeam 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 Backup & Replication 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 Lab 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.
6. At the Restore Point step, select the restore point when the application was in the desired state. By
default, Enterprise Manager will display restore points closest to the latest backup.
If you want to display all restore points that are available for the selected backup, select the Show all
available restore points check box.
8. At the Summary step, review the settings you have configured for the virtual lab and click Finish.
Veeam Backup & Replication will perform verification of the selected restore point.
IMPORTANT
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 Approve. Then follow the Edit Lab Request wizard steps:
1. At the Lab 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 virtual lab request data, click
the Edit request link at the bottom.
2. At the Backup 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 Point 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 Last 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 all 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 restore
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 Start 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.
• Replicate vApps and other containers and fail over to their replicas
Cloud Director service providers can allow self-service restore operations to their customers 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 configure 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 administrative 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.
This approach helps to streamline administration and management tasks for service providers, as now they need
to configure a tenant account only once in VMware Cloud Director, and then any change like a new password or
a disable operation will be immediately reflected in Veeam Backup Enterprise Manager.
• Configure settings for their tenants (Cloud Director organizations), including 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 completely prohibit the tenant's ability to schedule jobs, instead setting the
required schedule themselves (manually or using a script).
Together with Veeam built-in load balancing, these capabilities allow administrators to ensure infrastructure is
protected from excessive resource consumption.
For more information, see Managing Configurations for Cloud Director Organizations.
• 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 backup, 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.
For more information, see Adding Backup Servers.
4. Enterprise Manager must complete data collection from the added backup server.
For more information, see Collecting Data from Backup Servers.
5. The account that you will use to manage Cloud Director organization configurations must be assigned the
Portal Administrator role.
For more information, see Configuring Accounts and Roles.
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:
https://<EnterpriseManagerServer>:9443/vcloud/<VCDServer>/<OrgName>
In this case, Veeam Self-Service Backup Portal will open right after clicking the Sign in button.
• Shorter URL that does not contain the host address where the necessary Cloud Director server resides:
https://<EnterpriseManagerServer>:9443/vcloud/<OrgName>
In this case, after clicking the Sign in button, Veeam Self-Service Backup Portal will prompt to select a
Cloud Director host from the list of available Cloud Director hosts.
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
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
and if you have Veeam Backup Enterprise Manager 11a (build 11.0.1.1261) installed.
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 Repository 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.
IMPORTANT
You cannot assign cloud-based repositories, as well as NetApp or Nimble storage systems storing
snapshots created by snapshot-only jobs.
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.
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 Chart Appearance.
12. To specify what backup job will be used as a job template for the Cloud Director organization:
b. From the Copy from drop-down list, select backup job settings:
Default job settings — default Cloud Director backup job settings as they are shown in the
Veeam backup console
<Job Name> — specific Cloud Director backup job configured in Veeam backup console
IMPORTANT
The backup repository that is selected from the Repository drop-down list for the organization takes
priority over the repository used by the selected job template.
13. If you do not use the Show Advanced Job Settings link, the default job settings will be applied to the
template.
NOTE
To populate the list of job templates, you need at least one Cloud Director backup job to be
configured on the backup server.
• 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 to store backups to another repository instead of the currently configured
for the organization:
a. Move already created backups of Cloud Director objects to the new repository.
b. Modify the backup job that is used as a template, and organization configuration so that the job points
to the new repository.
Otherwise, data will be stored to the old repository, exceeding the quota.
6. To edit organization settings, follow the same steps as for adding a configuration.
For more information, see Adding Organization Configuration.
5. On the vCloud tab, select the default organization configuration and click Edit.
6. From the Repository drop-down list, select Disable self-service backup for other organizations.
The following organization members have access to Veeam Self-Service Backup Portal:
• Cloud Director organization members with the following rights granted in VMware Cloud Director:
• 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.
NOTE
Cloud Director system administrators cannot access Veeam Self-Service Backup Portal since they are not
organization members.
• Access by URL
1. Open your web browser and enter the following URL in the address bar:
https://<EnterpriseManagerServer>:9443/vcloud/<OrgName>/<VCDServer>
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:
https://enterprise01.tech.local:9443/vcloud/TechCompanyOrg/172.17.53.16
NOTE
You can select a display language for the portal if Veeam Backup Enterprise Manager 11a (build
11.0.1.1261 or later) is installed on the Enterprise Manager server.
3. In the Username and Password fields, specify credentials of a Cloud Director account with proper rights.
4. To save the entered credentials for future access, select the Remember me check box.
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.
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.
IMPORTANT
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 section of
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 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 plugin.zip 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 section of VMware Cloud Director documentation.
4. In the Plug-in Configuration section, specify the URL to the Veeam Backup Enterprise Manager server, for
example: https://hostname:9443.
5. Click Save.
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 application 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.
4. In the Plug-in Configuration section, click Save 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).
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.
• 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
The Backup Storage / <Repository name> widgets display statistics about backup repositories available to the
organization. Each widget represents a single repository and contains the following information:
The Last 24 hours / Last 7 days widget reports on the job session results for the selected period.
To visualize on-going jobs data, the Dashboard tab also comprises a chart showing date and time when jobs
were performed, and the network throughput rate during the job.
NOTE
The dashboard displays only Cloud Director backup jobs of the current Cloud Director organization.
• Creating jobs
• Deleting jobs
• Organization members cannot see the jobs with VMs from their Cloud Director organization if the jobs are
created using Veeam Backup & Replication. To view these jobs, tenants can map their organization jobs
using a PowerShell command. For more information, see the Set-VBRvCloudOrganizationJobMapping
section of the Veeam Backup & Replication PowerShell Reference. Tenants can map jobs of their own
organization only.
• 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).
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 you create are shown in Veeam Backup & Replication console under the Jobs
node and in Veeam Backup Enterprise Manager on the Jobs tab. The jobs have the <vCloud 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.
For more information on user rights, see Permissions.
2. From the Repository 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 policy 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 policy 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.
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,
Datastores and VMs,and Tags and VMs views.
2. In the Exclusions window, click Add 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. 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.
• 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.
o General Settings
General Settings
On the General tab, you can specify general application-aware processing settings.
1. In the Applications 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 Transaction Logs
Processing section, specify whether this job should process transaction logs upon a successful backup.
o Select Process 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 Oracle tab. For more information, see
Oracle Archived Log Settings.
For PostgreSQL database archive logs processing — on the PostgreSQL tab. For more
information, see PostgreSQL Archive Log Settings.
o Select Perform 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 PostgreSQL tabs are not available.
3. In the Persistent guest agent section, specify if Veeam Backup & Replication must use persistent guest
agents on each protected VM for application-aware processing.
By default, Veeam Backup & Replication uses non-persistent runtime components.
Veeam Backup & Replication deploys runtime components on each protected VM when the backup job
starts, and removes the runtime components as soon as the backup job finishes.
Select the Use persistent 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.
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 Enable application-aware processing check box
is selected.
3. In the displayed window, select the Microsoft SQL Server VM from the list and click Edit.
4. On the General tab of the VM Processing Settings window, make sure the following options are selected:
o In the Applications section, either the Require successful processing or Try application processing, but
ignore 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.
o Select Do not truncate logs to preserve transaction logs. When the backup job completes,
Veeam Backup & Replication will not truncate transaction logs on the Microsoft SQL Server VM.
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.
7. If you have selected the Backup logs periodically option, specify settings for transaction log backup:
a. In the Backup 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 Enable application-aware processing check box
is selected.
3. In the displayed window, select the Oracle VM from the list and click Edit.
4. On the General tab of the VM Processing Settings window, make sure that either the Require successful
processing or Try application processing, but ignore failures option is selected.
IMPORTANT
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.
5. On the Oracle tab of the VM Processing Settings window, specify log processing settings.
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.
b. Specify how Veeam Backup & Replication must process archived redo logs on the Oracle VM.
Select Do not delete 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.
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 Backup 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.
IMPORTANT
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 Backup 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.
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 Enable application-aware processing check box
is selected.
3. In the displayed window, select the PostgreSQL VM from the list and click Edit.
5. On the PostgreSQL tab of the VM Processing 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 Add 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 Database user with password if you have specified an account with password-based
authentication. In this case, you must provide Veeam Backup & Replication with the account
password that will be stored in the Veeam Backup & Replication database.
Select Database 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.
c. To back up PostgreSQL archive logs with Veeam Backup & Replication, select the Backup 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 Backup 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 PostgreSQL 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.
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 Enable application-aware processing check box
is selected.
3. In the displayed window, select a VM from the list and click Edit.
4. On the File Exclusions tab, specify the files that must be excluded from the backup.
o Select Exclude the following files and 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.
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.
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 Add Machine and choose the necessary VM. Next, select the
machine from the list and click Edit to customize VM settings.
o To discard custom settings of a machine, select it from the list and click Remove.
3. In the Indexing Settings window displayed for the selected machine, go to the Windows 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 Index everything if you want to index all guest OS files inside the machine.
o Select Index 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 Add 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.
VMware Cloud Director system administrators can access guest OS credentials available for their
organizations. They can also supply new credentials for guest OS processing.
In the Guest OS credentials section, you can select credentials from the list, or click the Add 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 Add 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.
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 password 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.
IMPORTANT
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 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 Add 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.
For more information, see Schedule Settings.
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 Backup 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 allowed backup window check box and click Window.
b. Define the allowed hours and prohibited hours for backup. If the job exceeds the allowed window, it
will be automatically terminated.
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.
• To run the job at specific time daily, on defined week days or with specific periodicity, select Daily 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 possible 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 Periodically 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 Start time within an hour field, specify the exact
time when the job must start.
A repeatedly run job is started by the following rules:
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 run the job continuously, select the Periodically 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.
Email notifications will be sent if you configure global email notification settings in Veeam Backup Enterprise
Manager. For more information, see Notifications on Job Results.
1. Select the Enable 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 Subject 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 Suppress 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.
To delete a job:
• Restore VMs
• Restore vApps
• Restore VM disks
Recovering VMs
You can recover VMs from backups to the original (production) vApp or another vApp within you organization.
• Instant Recovery
• Entire VM Restore
Instant Recovery
You can instantly recover 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 recover. To quickly find the necessary VM, use the search field at
the top of the window.
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.
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.
IMPORTANT
Restore job of a vApp with a standalone VM will return an ordinary and not standalone VM.
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.
3. Follow the steps of the Virtual Disk Restore wizard. For details, see Virtual Disk Restore.
If you delete a VM that has GFS backups, they will not be deleted. You can delete them in Veeam Backup
Enterprise Manager. For more information, see Deleting Machine from Backup.
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.
When you remove data for 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 for 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.
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).
Information on these restore operations will be available in the Delegated Restore Permissions Overview report
from the Veeam Backup Overview report pack available in Veeam ONE.
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 this VMware article.
Before installing 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.
• The backup server that contains the vCenter Server in its infrastructure must be connected to Enterprise
Manager.
For more information, see Adding Backup Servers.
• The Enterprise Manager server must be able to resolve the FQDN of the vCenter Server and must have
access to the vCenter Server over HTTPS. In particular, this is necessary if the plug-in uses default vCenter
Single Sign-On for authentication.
For more information on the authentication process, see Configuring Plug-in Settings.
• Account used to install the plug-in must have sufficient access rights for vCenter Server (must belong to
the same domain in case of cross-domain access):
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 Web 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 Plug-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:
VirtualMachine.Interact.Backup, Task.Create, Task.Update.
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 specific 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 reports 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 &
Replication 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 > About. For more
information, see Viewing Information About Enterprise Manager.
3. If you plan to connect to Enterprise Manager using a specific account, select the Password based
authentication 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 available, 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 Protected VMs report that
provides a list of VMs which are protected by Veeam Backup & Replication, and which are not.
• In the Jobs 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 Latest BU Job
Statistics report.
• In the Repositories 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 Capacity Planning 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 Backup > VeeamZIP if you want to create a backup using the default VeeamZIP settings
specified earlier. Alternatively, use the Actions > Backup > VeeamZIP option.
Veeam will start the VeeamZIP backup process using the default VeeamZIP settings.
o Select Backup > VeeamZIP to if you want to create a backup with new VeeamZIP settings.
Alternatively, use the Actions > Backup > 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.
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.
• Protection 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 Failed VMs — number of VMs that were backed up or replicated with an error
• Errors 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 protected VMs — number of VMs that were not backed up or replicated
• Repositories — 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 Veeam 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 Veeam Web Client plug-in >
VeeamZIP.
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.
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.
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, vSphere
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. The tenant account
settings define storage quota available to the tenant on the backup repository 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) and schedule 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 Veeam Backup Enterprise Manager
administrator performs the following tasks:
NOTE
Administrators perform tasks with vSphere Self-Service Backup Portal using the Self-service section in the
Configuration view of the Enterprise Manager UI. If a VMware Cloud Director server is added to your Veeam
backup infrastructure, the working area of the Self-service tab will display two inner tabs: vSphere and
vCloud. To work with vSphere Self-Service Backup Portal, make sure the vSphere tab is opened. The
vCloud tab is used to work with VMware Cloud Director organizations and their configurations. For more
information, see Working with VMware Cloud Director.
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.
Tenants can use vSphere Self-Service Backup Portal to perform the following operations:
• 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.
NOTE
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.
2. To open the Configuration view, click Configuration in the top right corner.
4. If a VMware Cloud Director server is added to your Veeam backup infrastructure, make sure that the
vSphere tab is selected.
o vSphere 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.
o vSphere role — to allow tenants to work with VMs that are available to the specified vSphere role.
ii. In the Select Role window, select the required vSphere role.
o VM privilege — to allow tenants to work with VMs for which they have the specified vSphere privilege.
i. In the VM privilege field, click the name of the currently selected privilege. By default, the
VirtualMachine.Interact.Backup privilege is selected.
6. Click OK.
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.
* 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:
NOTE
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 in the Roles tab of the
Configuration view.
2. To open the Configuration view, click Configuration in the top right corner.
4. If a VMware Cloud Director server is added to your Veeam backup infrastructure, make sure that the
vSphere tab is selected.
5. Click Add.
6. From the Type 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 Repository 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 Chart Appearance.
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 vSphere tags field, specify
tags assigned to VMs that will be available to the tenant.
For more information on delegation modes, see Configuring Delegation Mode.
15. [Optional] Specify advanced settings for backup jobs of the tenant:
b. In the Advanced job settings section, view the currently used backup job settings.
c. From the Copy from list, select the backup job settings that will be applied to tenant jobs. You can
select from the following options:
Default settings — this option is selected by default. With this option selected, tenant backup
jobs will be configured with the default settings as they are shown in the Veeam backup
console. For more information, see the Creating Backup Jobs section of the
Veeam Backup & Replication User Guide.
<Job name> — an existing backup job for vSphere VMs. With this option selected, the backup job
will be used as a template for tenant backup jobs. The job must be configured in advance on the
Veeam backup server added to Veeam Backup Enterprise Manager. When a tenant creates a
backup job on the vSphere Self-Service Backup Portal, Enterprise Manager will copy job settings
from the template and apply these settings to the job.
d. Click Apply.
NOTE
To populate the list of job templates, you must have at least one vSphere backup job configured in
the Veeam backup console.
2. To open the Configuration view, click Configuration in the top right corner.
4. If a VMware Cloud Director server is added to your Veeam backup infrastructure, make sure that the
vSphere tab is selected.
6. In the Edit window, edit tenant account settings and click Save. For details, see Adding Tenant Account.
Make sure to establish a proper connection between the Veeam backup server and Enterprise Manager
server. Otherwise, changes of the tenant account settings will not be saved to the Veeam configuration
database.
Consider the following recommendations for modifying tenant account settings for vSphere Self-Service Backup
Portal:
• 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.
To generate a report:
2. To open the Configuration view, click Configuration in the top right corner.
4. If a VMware Cloud Director server is added to your Veeam backup infrastructure, make sure that the
vSphere tab is selected.
2. To open the Configuration view, click Configuration in the top right corner.
4. If a VMware Cloud Director server is added to your Veeam backup infrastructure, make sure that the
vSphere 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.
Accessing Portal
To access vSphere Self-Service Backup Portal:
1. Open your web browser and enter the following address in the address bar:
https://<EnterpriseManagerServer>:9443/backup
For example:
https://enterprise01.tech.local:9443/backup
2. From the drop-down list, select a language that you want to use as the display language.
i. In the Username and Password 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 Remain 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.
• VMs — number of VMs successfully processed during the selected period. At least one restore point was
created for these VMs.
• Templates — number of virtual machine templates successfully protected during the specified period.
• Status — 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 Last 24 hours / Last 7 days block reports on job session results for the selected period.
To visualize on-going job data, the Dashboard tab also comprises a graph showing time and date when jobs were
performed, and the network throughput rate during the job.
1. Open the Jobs tab of vSphere Self-Service Backup Portal and click Create.
2. At the Job Settings step of the wizard, specify the backup job name, description and retention policy
settings. The retention policy defines how many restore points are kept in the backup repository and can
be used for data restore.
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.
6. At the Email Notifications step of the wizard, select the Enable e-mail notifications check box and
configure notification settings:
b. [Optional] In the Subject field, specify the subject for notification emails.
c. Select Notify on success to receive an email notification when the job completes successfully.
d. Select Notify on warning to receive an email notification when the job completes with a warning.
e. Select Notify on error to receive an email notification when the job fails.
f. Select the Suppress 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 Edit.
3. In the Edit 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.
2. In the working area of the Jobs tab, select the job and click Delete.
Information about the deleted job will be removed from the Veeam Backup & Replication configuration
database (and the Enterprise Manager database as well), and the job will no longer appear in the UI. If you
agreed to delete backup files created with the job, they will be removed from backup repository.
IMPORTANT
For vSphere Self-Service Backup Portal tenants, the job cloning operation is not available.
• Restore VMs
• Restore VM disks
• Delete VMs
Restoring VMs
You can restore vSphere VMs to the original (production) location using flexible restore options. To restore a
VM, do the following:
1. On the VMs tab, select the necessary VM in the list of VMs. You can also use the search field to search for
the necessary VM by a VM name.
o Select the Overwrite option if you want to replace the VM in the original location with the VM in the
backup. The current state of the VM will be deleted.
o Select the Keep option if you want to save the current state of the VM. The restored VM will be
located next to the original VM and will have the same name with the _restored suffix added to the
VM name.
3. In the Restore window, select the restore point that will be used to restore the VM.
o Select the Quick rollback check box if you want to restore only the changed data. This option is
available only for VMs that were protected with the Changed Block Tracking (CBT) option.
o Select the Power on VM after restoring check box if you want to turn on the VM once it is restored.
5. Click Finish.
6. Veeam Backup Enterprise Manager will display a message notifying that the VM from the backup will
replace the original VM if this VM is present in the original location. Click Proceed to start the VM restore
operation.
You can view the VM restore progress. To do this, on the VMs tab, click History.
1. On the VMs tab, select the backup of the VM whose disks you want to restore. You can also use the search
field to search for the necessary VM by a VM name.
3. Follow the steps of the Virtual Disk Restore wizard. For details, see Virtual Disk Restore.
Deleting VMs
You can delete a VM on vSphere Self-Service Backup Portal. This operation may be useful if you want to delete
data of the backed-up VM from the backup repository.
When you delete a VM, Veeam Backup 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.
To delete a VM, on the VMs tab, select the necessary VM and click Delete. Then press Yes in the Delete VM
window.
The deleted VM is not removed from the list of VMs immediately. The VM will be removed from the list after
records about the VM are removed from the configuration database on the Veeam backup server.
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).
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 Veeam Configuration Database
Connection Utility.
NOTE
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.
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\Veeam.EM.DB.Migration.exe.
To run the utility, use a command-line shell. The utility requires access to the registry so you must run the shell
as administrator.
Syntax
With the Enterprise Manager Database Migration utility, you can perform the following operations:
Veeam.Backup.Configuration.Tool /?
Parameter Description
/? Displays help.
/servername:<value> Specifies a name or IP address of the target host with PostgreSQL server.
The default value is localhost.
If an instance with the specified name (or the default name) exists, the
utility adds an increment postfix to the instance name, for example:
VeeamBackupReporting_00, VeeamBackupReporting_01.
/login:<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.
/verbose Enables verbose logging mode. Logs are stored in the following directory:
%PROGRAMDATA%\Veeam\Backup\Utils\Util.EmTransfer.
where:
• /file:"C:\EM Configuration\02.emco" — 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 Veeam Backup 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
The Configuration Database Connection Settings utility supports only connection to configuration
databases of the current product version. For example, you can connect Veeam Backup Enterprise Manager
12 to a configuration database of version 12.
To manage connection settings for the Veeam Backup Enterprise Manager configuration database, take the
following steps:
2. Select a product.
Alternatively, you can run the Veeam.Backup.DBConfig.exe 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 as administrator.
If a backup server (or Enterprise Manager server) is not installed on the machine, the Product step of the wizard
is skipped.
o PostgreSQL
o [For PostgreSQL] Specify the instance name in the HOSTNAME:PORT format. In the Database 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 Manager 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 Password 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 Start the
product automatically check box. The option is not available for Veeam Backup Enterprise Manager.