Veeam Backup 11 0 Enterprise Manager User Guide
Veeam Backup 11 0 Enterprise Manager User Guide
Manager
Version 11
User Guide
October, 2021
© 2021 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:
This document describes the features included in the Veeam Backup Enterprise Manager. It also provides usage
examples and gives step-by-step instructions that will help you better understand how to install the Veeam
Backup Enterprise Manager and monitor your Veeam Backup infrastructure, services and jobs.
Intended Audience
The document is intended for backup administrators and other IT professionals who plan to deploy and use
Veeam Backup Enterprise Manager. 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 Back up 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 vCloud 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.
Localization
Veeam Backup Enterprise Manager 11 is available in the following languages:
• English
• French
• German
• Italian
• Japanese
• Spanish
You can select a preferred language on the login page. If the language you need is not available, you can add it.
Localization is based on the GNU gettext tools, and English strings are used as message IDs. For more
information, see Managing Languages.
Licensing
Now Veeam Backup Enterprise Manager can apply its license to backup servers that have
Veeam Backup & Replication version 10 or later installed.
• In version 11, you can select a display language for Veeam Self-Service Backup Portal when you access the
portal by its URL. In version 11a, the portal is available in the selected language when you open it from the
vCD environment as well. For more information, see Accessing Veeam Self-Service Backup Portal.
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 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 Ma in web interface is used to browse and perform operations with jobs, backups and machines, to
configure Enterprise Manager functionality and control infrastructure. For more information, see
Getting to Know Veeam Backup Enterprise Manager.
o Veeam Self-Service File Restore Portal that allows administrators to restore files or folders from the
guest OS of a virtual or physical machine. For more information, see Using Self-Service Portal to
Restore Machine Guest Files.
o Veeam Self-Service Backup Portal and Veeam Plug-in for VMware vCloud Director that provide
members of vCloud Director organizations with a UI for self-service operations on machine protection.
For more information, see Veeam Self-Service Backup Portal.
o VMwa re vSphere Self-Service Backup Portal that provides Service Providers with a UI for managing
access permissions and vSphere quotas for their customers. For more information, see vSphere Self-
Service Backup Portal.
NOTE
Veeam Self-Service File Restore Portal, Veeam Self-Service Backup Portal, Veeam Plug-in for VMware
vCloud Director and VMware vSphere Self-Service Backup Portal features are available in the Enterprise
Plus edition of Veeam Backup & Replication.
• SQL Server 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 a Veeam backup server. 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 Veea m Backup Search, since all
operations related to guest OS file indexing and search will be performed by Veeam's proprietary built -in
indexing engine. For more information, see Veeam Backup Search Capabilities.
• Veeam Cloud Connect P ortal is an optional component that comprises the Veeam Cloud Connect Portal
website (IIS extension) and UI. It is intended for the tenants of Service Providers. For more information,
see the Veeam Cloud Connect Guide.
• Veeam VMware vSphere Web Client plug-in allows vSphere administrators to manage backup
infrastructure of the virtual environment. For more information, see the Controlling Backup Infrastructure
with vSphere Web Client Plug-in.
• 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 ba ckup 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 the 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 p oints 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 sess ions.
• 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.
IMP ORTANT
The longer the backup chain, the more indexing data is stored in Veeam Backup Catalog.
In case of long backup chains, indexing data may take a lot of space on the Veeam Backup Enterprise
Manager server. To overcome this situation, you can adjust the retention policy scheme or provide enough
space for indexing data in Veeam Backup Catalog on Veeam Backup Enterprise 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
Appendix B. Configuring AD FS for SAML Authentication.
Sp ecification Requirement
SQL Server Local or remote installation of the following versions of Microsoft SQL Server
(both Full and Express Editions are supported):
SQL Server 2008 databases and later with compatibility to SQL Server 2005
are not supported.
For IIS 8.5, the URL rewrite module is required if you plan to use Veeam
Self-Service Backup Portal or vSphere Self-Service Backup Portal.
• Directory Browsing component, Default Document component, HTTPS
Errors component, Static Content component, Windows Authentication
component, WebSocket Protocol component.
• Microsoft .NET Framework 4.7.2 (included in the setup).
• Windows Installer 4.5 (included in the setup).
IMP ORTANT
To restore Microsoft Exchange items with Veeam Backup Enterprise Manager, Microsoft Exchange servers
must be members of the same Microsoft Active Directory forest.
Sp ecification Requirement
Ha rdware and software Refer to hardware system requirements and software system requirements
for Veeam Backup Enterprise Manager.
For portable devices (tablets): latest versions of Apple Safari for iOS or
Google Chrome for Android.
Sp ecification Requirement
VMwa re vCloud Director VMware vCloud Director 9.5–10.2. For vCD replication: 9.7–10.2.
Other software If your Enterprise Manager deployment uses IIS 8.5, then URL rewrite
module is required to work with Veeam Self-Service Backup Portal for
vCloud Director.
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 SQL
Account used to run Server level. After the database is created, this account automatically gets a
the setup db_owner role and can perform all operations with the database.
To upgrade an existing Enterprise Manager 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
E nterprise Manager Manager Service account. If you set another account to run this service, this account
service account must have the following permissions:
To add Active Directory user or group accounts to the Veeam Backup Enterprise
Manager roles, the Veeam Backup Enterprise Manager service must be started under
the Active Directory service account that has permissions to enumerate Active
Directory domains. Active Directory users have enough permissions to enumerate
Active Directory domains by default. If you use the local machine account instead,
you will get the " Cannot find user account DOMAIN\username" error.
E nterprise Manager To 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.
vSp here W eb Client The account used to install the plug-in and the vCenter server account must belong
P lug-in for Veeam to the same Active Directory domain in case of cross-domain access.
Ba ckup & Replication
( op tional) The account used to install the plug-in must be assigned the following vCenter
Server permissions:
vSp here Self-Service The account used to work with vSphere Self-Service Backup Portal must have
Ba ckup P ortal user interactive logon permissions on the Enterprise Manager server.
NOTE
For more information on ports specific for Veeam Backup & Replication infrastructure components, see the
Used Ports section of the Veeam Backup & Replication User Guide.
Veeam Veeam backup server TCP 9392 Default port used by Veeam Backup
Ba ckup Enterprise Manager for collecting data
E nterprise from Veeam backup servers. Can be
Ma nager customized during Veeam Backup &
Replication installation. For more
information, see Specify Service Ports.
SQL Server hosting the TCP 1433 Default port used for communication
Enterprise Manager with Microsoft SQL Server hosting a
configuration database Veeam Backup Enterprise Manager
database. For more information, see
Specify Installation Settings.
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
Ba ckup Enterprise Manager communicate with Veeam Backup
E nterprise service Enterprise Manager. Can be
Ma nager customized during Veeam Backup
website (IIS Enterprise Manager installation. For
ex tension) 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
P ortal built-in and cannot be customized
website (IIS during installation.
ex tension)
HTTP 9399
Veeam Veeam Backup TCP Dynamically If you use Veeam Availability Suite and
ONE Server Enterprise Manager assigned add a Veeam Backup Enterprise
( op tional) ports Manager server to 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
• 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
Veeam Helper TCP 2500 to Ports used for file download. For more
Backup appliance 6000 information on the helper appliance, see
Enterprise Preparing for File Search and Restore
Manager (non-Windows machines).
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 Used Ports section of the Veeam Backup & Replication User Guide.
Target Mount server TCP 3260 to 3270 Ports used for transfer of iSCSI traffic
remote SQL associated during database restore to the original
Server with backup Microsoft SQL Server. These ports are
repository used during the restore process only.
Target Machine TCP 3260 to 3270 Range of ports used by Veeam Backup
remote running and 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.
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 da ta: 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 a nd 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.
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.
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.
On the Summary tab of the Licensing section, you can find information about the license edition, license state
and a spreadsheet of the available and used instances per each type of protected workloads: virtual machines,
physical servers and workstations, cloud machines, applications and file shares.
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.
TIP
You can configure Veeam Backup Enterprise Manager to send notifications if your license expires. 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.
TIP
You can also view detailed information about current license usage. To do this, click the Rep ort link.
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.
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 in the main window 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 Appendix A. Similar
messages are received as pop-ups after you force the immediate update.
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.
Veeam offers two methods of usage reporting: automatic and manual. The automatic reporting is used if
automatic license update is enabled. For more information about how license usage reporting works, see the
License Usage Reporting section of the Veeam Cloud Connect Guide.
Veeam Backup Enterprise Manager generates a monthly usage report on the first day of the month. The report is
based on the number of instances used for backup and replication in the previous month.
To review a report:
1. In the monthly usage report notification, click the sub mit link.
3. In the monthly usage report, check the number of reported instances. The report contains the following
data:
o License information: Veeam Backup & Replication edition, license expiration date, name of the
company to which the license was issued and support ID.
o The number of instances used by each type of protected workloads (VMs, workstations, servers and
file shares) and the total number of used instances.
o For each type of protected workloads, the report displays information about processed workloads and
jobs that process these workloads.
o For each type of protected workloads, the report also displays the number of new objects that are not
included in the report.
To adjust a report:
1. In the monthly usage report notification, click the sub mit link.
4. In the list of VMs, select the VM that you want to remove from the report and click Remove.
By default, the list of VMs contains all managed VMs included in the report. To 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 Ty p e in note field, provide a reason for removing the VM from the
report.
6. Click OK, then click Finish. The change will be reflected in the report.
TIP
To reset changes introduced in the report, in the Monthly Usage Report window, click Reset.
1. In the monthly usage report notification, click the sub mit link.
2. Download the report. The procedure differs depending on the reporting method. For more information,
see the License Usage Reporting section of the Veeam Cloud Connect Guide.
ii. On the report page, click Download and select the report format: PDF or JSON.
o In case of manual reporting, in the Monthly Usage Report window, click Download and select the
report format: PDF or JSON.
You can also download the report after review. To do this, take the same steps as in case of automatic
reporting.
You can submit a monthly usage report in one of the following ways:
• Automatically
• Manually
For more information about how license usage reporting works, see the License Usage Reporting section of the
Veeam Cloud Connect Guide.
1. In the monthly usage report notification, click the sub mit link.
2. In the Monthly Usage Report window, to check or change the number of used instances, click Review.
For more information, see Reviewing Monthly Usage Report and Adjusting Monthly Usage Report.
You can also postpone the report submission. To do this, click P ostpone. In this case, Veeam Backup
Enterprise Manager closes the Monthly Usage Report window. Until the report is sent to Veeam, on the
Da shboard tab, Enterprise Manager keeps displaying a warning prompting to submit the report.
1. In the monthly usage report notification, click the sub mit link.
2. In the Monthly Usage Report window, to check or change the number of used instances, click Review. For
more information, see Reviewing Monthly Usage Report and Adjusting Monthly Usage Report.
You can also postpone the report submission. To do this, click P ostpone. In this case, Veeam Backup
Enterprise Manager closes the Monthly Usage Report window. Until the report is sent to Veeam, on the
Da shboard tab, Enterprise Manager keeps displaying a warning prompting to submit the report.
You can install Veeam Backup Enterprise Manager either on a physical or virtual machine, co-install it with
Veeam Backup & Replication or install it separately.
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 Required Permissions.
• Backup infrastructure components communicate with each other over specific ports. These ports must be
open. For more information, see Used Ports.
• .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.
• Local antivirus or antimalware software can interfere with Veeam Backup Enterprise Manager installation
and upgrade. 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 process completes. For more information, see this Veeam KB article.
• Check the Known Issues section of the Veeam Backup & Replication 11 Release Notes.
1. Download the latest version of the Veeam Backup & Replication installation image from
https://www.veeam.com/downloads.html.
2. Use disk image emulation software to mount the installation image to the machine where you plan to
install Veeam Backup Enterprise Manager or burn the image file to a blank CD/DVD. 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 ISOs of large size and can properly work with long
file paths.
3. After you mount the image or insert the disk, Autorun will open a splash screen with installation options.
If Autorun is not available or disabled, run the Setup.exe file from the image or disk.
4. In the Sta ndalone components section of the splash screen, click Install Veeam Backup Enterprise
Manager.
5. Before installing the product, the setup will analyze the prerequisites and prompt to ins tall .NET
Framework if it is missing on the machine. Click OK to install this component. After you install the
component, you will have to reboot your computer.
IMP ORTANT
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.
1. Read the license agreement. To view the license agreement for 3rd party components, click View.
2. Select the I a ccept the terms of the Veeam license agreement check box.
3. Select the I a ccept the terms of the 3rd party components license agreements check box.
• Trial license that was sent to you after you downloaded the product.
If a valid license is already installed on the machine, the setup wizard will inform you about it. In this case, you
can skip the P rovide License step and move to the next step of the wizard.
To install a license:
1. Next to the License file for Veeam Backup Enterprise Manager field, click Browse.
Selecting Components
For on-site deployments, the setup wizard offers the following components:
Service providers can also install Veeam Cloud Connect Portal. For more information on Veeam Cloud Connect
Portal, see the Veeam Cloud Connect Guide.
2. Select the This feature will be installed on local hard drive option.
If the Veeam Backup Catalog or Cloud Connect Portal for Service Providers component is already installed, the
setup will exclude it from the list of components to install.
The setup wizard also installs components in the background. For more information on the installed
components, see Enterprise Manager Components.
2. In the Browse for Folder window, select the installation folder for the product. The default installation
folder is %ProgramFiles%\Veeam\Backup and Replication.
• To install missing components automatically, click Install. The setup wizard will not interrupt the
installation process and install the missing components during the current work session.
c. Start the setup wizard again, pass to the Sy s tem Configuration Check step of the wizard and click Re-
run to repeat the verification.
NOTE
If all required components are already installed on the machine, the Sy stem Configuration Check step will
be skipped. For more information on the necessary software, see System Requirements.
By default, the setup wizard installs Veeam Backup Enterprise Manager with the following settings:
• Guest catalog folder: the VBRCatalog folder on a volume with the maximum amount of free space, for
example, C:\VBRCatalog.
The guest catalog folder stores indexing data for VM guest OS files. Indexing data is required for browsing
and searching for VM guest OS files inside backups and performing 1-click restore.
• Ca talog service port: 9393. The catalog service port is used by the Veeam Guest Catalog Service to
replicate catalog data from backup servers to Veeam Backup Enterprise Manager.
• Service account: LOCAL SYSTEM. The service account is the account under which the Veeam Backup
Enterprise Manager runs.
• Service port: 9394. The service port is used by Veeam Backup Enterprise Manager to collect data from
backup servers.
o For machines running Microsoft Windows Server 2008 or Microsoft Windows Server 2008 R2, the
setup installs Microsoft SQL Server 2012 SP3 Express Edition.
o For machines running Microsoft Windows Server 2012 and later, the setup installs Microsoft SQL
Server 2016 SP2 Express Edition.
• Da tabase name: VeeamBackupReporting . Veeam Backup Enterprise Manager deploys the Veeam Backup
Enterprise Manager configuration database on the locally installed instance of Microsoft SQL Server.
• W eb UI ports: 9080 (for HTTP protocol) and 9443 (for HTTPS protocol). These ports are used for
accessing Veeam Backup Enterprise Manager web interface.
• RE ST API ports: 9399 (for HTTP protocol) and 9398 (for HTTPS protocol). These ports are used for
accessing Veeam Backup Enterprise Manager REST API.
• Cloud Connect P ortal port : 6443. This port is used for accessing Veeam Cloud Connect Portal by tenants.
1. Leave the Let me specify different settings check box not selected.
You can select an account under which you want to run the Veeam Backup Enterprise Manager Service:
The user name of the custom account must be specified in the DOMAIN\USERNAME format.
NOTE
The user account must have Veeam Backup Enterprise Manager service account permissions to run the
Veeam Backup Enterprise Manager Service. For more information, see Required Permissions.
You can select a Microsoft SQL Server on which you want to deploy the configuration database, and choose the
authentication mode.
o If a Microsoft SQL Server is not installed locally or remotely, select the Install new instance of SQL
Server option. The setup will install Microsoft SQL Server locally on the backup server:
▪ For machines running Microsoft Windows Server 2008 or Microsoft Windows Server 2008 R2,
the setup will install Microsoft SQL Server 2012 SP3 Express Edition.
▪ For machines running Microsoft Windows Server 2012 and later, the setup will install Microsoft
SQL Server 2016 SP2 Express Edition.
o If a Microsoft SQL Server is already installed locally or remotely, select the Use existing instance of
SQL Server option. Enter the instance name in the HOSTNAME \INSTANCE format. In the Da tabase
field, specify a name for the Veeam Backup Enterprise Manager configuration database.
2. Select an authentication mode to connect to the Microsoft SQL Server instance: Microsoft Windows
authentication or Microsoft SQL Server authentication. If you select the SQL Server authentication, enter
credentials for the Microsoft SQL Server account.
If the configuration database already exists on the Microsoft SQL Server (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 Y es . If necessary, Veeam Backup Enterprise Manager will automatically upgrade the
database to the latest version.
You can customize port number values that will be used for communication between backup infrastructure
components.
NOTE
For more information about Veeam Backup Enterprise Manager used ports, see Used Ports.
Provide HTTP and HTTPS port numbers and select 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 (default port 9443); Veeam plug-in for vSphere Web Client and RestAPI client also will use this
certificate to receive data using HTTPS protocol.
If the setup wizard does not find an appropriate certificate to be used, it generates a self -signed certificate.
To enforce TLS 1.2 encryption protocol for network connections, select the Hig h security mode check box.
NOTE
The Hig h security mode 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.
If you are installing Veeam Cloud Connect Portal, you can also provide port number that will be used by browser
to access its website (default port is 6443).
You can specify location for the guest file system catalog folder. Specify a path to the folder where index files
must be stored.
By default, the setup wizard creates the VBRCatalog folder on a volume with the maximum amount of free
space, for example: C:\VBRCatalog. To change the location, click Browse.
You can review the Veeam Backup Enterprise Manager installation settings and start the installation process:
2. 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 Ma intenance Mode step of the setup wizard, select the Repair option and click Nex t.
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 Rea dy 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.
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.
Before starting the upgrade procedure, read and follow the recommendations below:
1. 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 Veeam backup server installed on the same machine, upg rade it
immediately after completing upgrade of the Veeam Backup Enterprise Manager server.
2. It is recommended to disable local antivirus and antimalware software to prevent it from interfering with
Veeam Backup Enterprise Manager setup. You can enable it after the upgrade procedure is completed. For
more information, see this Veeam KB article.
3. Ensure there is no active processes, such as running jobs and restore sessions. We recommend that you do
not stop running jobs and let them complete successfully instead. Disable any periodic and backup copy
jobs, so that they do not start during upgrade.
4. Perform backup of the SQL Server configuration databases used by Veeam backup servers and Veeam
Backup Enterprise Manager server, so that you can easily go back to a previous version in case of issues
with upgrade. Note that built-in configuration backup functionality does not protect Veeam Backup
Enterprise Manager configuration.
Upgrade Procedure
To upgrade Veeam Backup Enterprise Manager, take the following steps:
1. Download the latest version of Veeam Backup & Replication ISO from the Veeam website.
2. Mount the product ISO and use autorun, or run the Setup.exe file.
4. Follow the setup wizard steps. At the SQL Server Instance step, select the SQL server instance and
database that were used by the previous version of Veeam Backup Enterprise Manager.
5. If you have Veeam Backup & Replication installed on the same machine, upgrade it immediately after
completing upgrade of the Veeam Backup Enterprise Manager server, otherwise this local backup server
will not be able to run jobs.
After you upgrade Veeam Backup & Replication servers, Veeam Backup Enterprise Manager starts
maintenance jobs to optimize the state of its database. The initial maintenance jobs session may take
significant amount of time (up to an hour, depending on the database size). After the job finishes,
the database will be brought to an optimal state, and subsequent maintenance job sessions will take
much less time.
7. New features of Veeam Backup Enterprise Manager version 11 will b e available after all managed Veeam
backup servers are upgraded, and initial collection of data from these servers in Veeam Backup Enterprise
Manager completes successfully.
8. Download and install the latest available update (if any) from https://www.veeam.com/updates.html.
1. From the Sta rt menu, select Control Panel > P rograms and Features.
2. In the programs list, right-click Veeam Backup & Replication and select Uninstall.
3. In the Uninstall window, make sure the check box next to Veeam Backup Enterprise Manager is 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.
The Veeam Backup Enterprise Manager configuration database (default name is VeeamBackupReporting ) is not
removed during the uninstall process. All configuration data stored in the database remains as well.
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 P rograms > Veeam >
Veeam Backup Enterprise Manager from the Sta rt menu.
Alternatively, open your web browser and enter the following URL in the address bar:
https://<hostname>:9443
For example:
https://vbr-em:9443
i. In the Username and P a ssword fields, specify your Enterprise Manager credentials. Provide the
user account name in the DOMAIN\Username format.
ii. To save the entered credentials for future access, select the Rema in signed in option.
o To log in with single sign-on, click Use Single Sign-On ( SSO). Enterprise Manager will redirect you to
the login webpage of the single sign-on service. Complete the sign-in procedure on the login page. If
the account is already authenticated in the single sign-on service, you will immediately access the
Enterprise Manager website.
NOTE
The Use Single Sign-On (SSO) option is available if SAML authentication is configured for Veeam
Backup Enterprise Manager. For more information, see Configuring SAML Authentication
Settings.
When you log in under a user account which is not assigned a role for Enterprise Manager, you are automatically
redirected to the Veeam Self-Service File Restore Portal. On this portal, you can browse and restore only
machines on which your user account has local administrative rights. For more information on configuring
Enterprise Manager security roles, see 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 Knowledge Base article.
TIP
If you use Internet Explorer, then to be able to access the Enterprise Manager website using an account
currently logged in to the Microsoft Windows OS, you can add this website to Local intranet sites in the
Internet Options. In case the current user cannot be authenticated using this method, the Enterprise
Manager login window will be displayed. This method works only for Internet Explorer. If you use another
web browser, you may be prompted for login.
After you finish working with the Enterprise Manager website, or if you need to switch the user account, click
the user name in the top right corner of the main window and then click Sig n Out.
Below is the list of operations that you can perform in the Home view of the Veeam Backup Enterprise Manager
UI:
• View on-going statistics for your backup infrastructure using the Da shboard tab. For more information,
see Viewing Operation Statistics.
• View detailed information about Veeam backup servers managed by Enterprise Manager using the Rep orts
tab. For more information, see Reports on Backup Servers.
• Manage jobs on all managed Veeam backup servers using the Job s 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 Ma chines tab. For more information, see
Working with Machines.
• Browse the guest OS file system in a machine backup, search for guest OS files and restore necessary files
using the Files tab. For more information, see Restoring Guest OS Files.
• Perform item-level recovery from application-aware backups created by Veeam Backup & Replication
using the Items tab. For more information, see Backup and Restore of Application Items.
Configuration View
If you logged in with an administrative account, on the Home view you can click Configuration to open the
Configuration view.
The tabbed pane, located on the left of the window, allows you to navigate to the configuration settings you
need — for example, notifications, security roles, and others. The working area is located on the right; it allows
you to view data, perform the necessary operations or manage the settings you need.
Below is the list of operations that you can perform in the Configuration view of the Veeam Backup Enterprise
Manager UI:
• Add, edit or remove Veeam Backup servers using the Ba ckup Servers tab. For more information, see
Managing Backup Servers.
• Work with vCenter servers managed by Enterprise Manager using the vCenter Servers tab. For more
information, see Viewing vCenter Servers.
• Manage vCloud Director organizations and vSphere tenant accounts using the Self-Service tab. For more
information, see Working with VMware vCloud 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.
• Configure Enterprise Manager settings using the Settings tab. For more information, see Managing
Encryption Keys, Configuring SAML Authentication Settings, Customizing Chart Appearance and
Configuring Retention Settings for Index and History.
• Set email notifications using the Notifications tab. For more information, see Configuring Notification
Settings.
• View product versions, URLs and log paths using the Ab out tab. For more information, see Viewing
Information About Enterprise Manager.
• The Summary block shows the total number of managed backup servers, performed jobs, processed
machines and file shares.
• The Image Data block shows the average processing speed, total size of processed machines, full backups
and incremental backups.
• The File Data block shows the average processing speed, total size of processed file shares, backed -up and
archived files.
This block is displayed only if one or more file shares are added on a backup server connected to Veeam
Backup Enterprise Manager.
• The La st 24 hours / Last 7 days block shows the total number of job runs, successful jobs, jobs with
warnings and failed jobs.
To switch between the time ranges, select a necessary tab in the top left corner.
• The Sta tus block shows the status of backup files, managed backup servers, Veeam Backup Enterprise
Manager management server, and licenses.
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 ranges:
• Last 24 hours
• Last 7 days
To switch between the ranges, select a necessary tab in the top left corner.
3. Use the Activity graph scale options on the Cha rt Settings tab to switch between graph types: Linear and
Log arithmic.
4. By default, the time interval specified under the selected Show backup window check box is highlighted
on the activity graph. Default interval is from 8:00 PM to 8:00 AM. You can change the highlighted
interval to correlate with your planned backup window by editing the start and stop time. If you do not
want to highlight the backup window on the graph, clear the Show backup window check box.
• View vCenter servers and install Veeam plug-in for vSphere Web Client on necessary servers
To start working with Veeam Backup Enterprise Manager, you must perform initial configuration. For more
information, see Initial Configuration.
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).
• To open the Configuration view, click Configuration in the top right corner.
• In the Ba ckup Server Settings window, enter a full DNS name or IP address of the server you want to add,
and provide a server description.
• Provide a name and password of the user with administrative rights on the added server. The Veeam
Backup Enterprise Manager user must be assigned the Veeam Backup Administrator role on the backup
server. For more information see Configuring Backup Server Roles.
• Specify the port used by Veeam Backup Service. By default, port 9392 is used.
• 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 added backup 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.
• You must not add more than one backup server that has a vCloud Director server in its infrastructure.
• Install the same product version on the Veeam Backup Enterprise Manager server and Veeam 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 9.5
Update 4 and later.
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 Ba ckup Servers on the left of the Configuration view and click Schedule on the toolbar.
2. In the Da ta Collection Settings window, specify the desired interval in the P eriodically 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 Ba ckup 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 Sta tus 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.
P a rameter Description
Sta tus Status of the last data collection job session for the backup server. For more
information on data collection, see Collecting Data from Backup Servers.
Possible values:
• Never processed — data collection has never been started for the
backup server
• Processing — data collection is in progress
• OK — data was collected successfully
• Warning — data collection completed with a warning
• Error — data collection failed
Ma chines Number of machines processed by the backup server, including the machines
from imported or orphaned backups.
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 Ba ckup Server column to move through the levels in the
following succession: Backup servers > Jobs > Job sessions > Session details . Each level contains a list of entries
with details for that particular level.
You can export displayed information to a file using the E x p ort link on the toolbar. To open the file on your
machine, use the associated application.
• User name
• Operation result
The generated file is also saved on the Enterprise Manager machine. Enterprise Manager does not clean up
these files. You can find all reports in the following folder: %ProgramData%\Veeam\Backup\WebRestore.
2. To open the Configuration view, click Configuration in the top right corner.
3. In the Ba ckup Servers section, select a backup server whose report you want to export.
The report contains only the audit records whose retention period is not expired. The retention period is
defined by the E vent history setting of Enterprise Manager. For more information on retention settings,
see Configuring Retention Settings for Index and History.
• Check version — use this command to request vCenter server version and operation status. If Veeam plug -
in for vSphere Web Client is deployed, its version, status and installation account will be also displayed.
• Install — use this command to install Veeam plug-in for vSphere Web Client on the selected server. For
details, see Controlling Backup Infrastructure with vSphere Web Client.
• Remove — use this command to uninstall Veeam plug-in for vSphere Web Client from selected server.
IMP ORTANT
To perform these operations, you should supply a user account with sufficient permissions to access
vCenter Server. User account information is not imported from the Veeam Backup & Replication
configuration database to the Enterprise Manager database for security reasons.
• 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.
IMP ORTANT
Consider that, by default, backup repository is the primary destination for the search. This means, in
particular, that if a backup (with indexed guest) is stored in both locations — repository and tape — then
Enterprise Manager search results will only include files from b ackup 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 Sa ve button under the E vent 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 E vent 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.
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 restrictions
for delegated 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.
Accounts
Administrators can add accounts to Veeam Backup Enterprise Manager to grant users access to the website.
Enterprise Manager offers the following account types: User, Group, External User and External Group.
* For more information on the single sign-on capability, see SAML Authentication Support.
• Initially by default to
P ortal Yes Full access to all available
Ad ministrator the users listed in the operations on all tabs of the web
local Administrators UI
group and the user who
installed Enterprise
Manager
• By Portal Administrator
in Configuration >
Roles
Users with the Portal User or Restore Operator role can access their restore scope — a list of objects that can be
recovered by appropriate personnel. For example, the restore scope of database administrators is database
servers (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.
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 Restrictions for Delegated Restore.
Managing Accounts
Administrators can perform the following actions with accounts:
• 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.
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).
6. [For Portal User or Restore Operator] In the Restore scope section, you can allow a user to restore all
objects (machines and file shares) processed by managed backup servers or the selected objects only. For
more information, see Configuring Restore Scope.
In the Allow restore of section, you can configure additional restrictions for the restore scope. For more
information, see Configuring Restrictions for Delegated Restore.
Editing Account
To edit settings of an added user or group, select it in the list of roles and click E d it 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 narrow the restore scope, perform the following steps when adding or editing a Portal User or Restore
Operator account:
3. In the Restore scope section, select the Selected objects only option and click Choose.
5. In the Ad d 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
a nd VMs and Ta g s 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.
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 Ad d Objects window will
display incomplete infrastructure.
After a user logs in to Enterprise Manager, they will be able to view objects and files included in their restore
scope.
NOTE
The Ma chines 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
Ma chines, 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 d on’t see my VM to refresh the view. This link, however, will not be visible
until you have made an unsuccessful search.
Administrative user can click Reb uild Roles in the Roles section of Configuration page to refresh all scopes of all
accounts manually. Consider that this operation will affect all configured roles.
Portal Administrators can watch the progress of security scope rebuild process on the Sessions page.
To restrict the restore operator actions, perform the following steps when adding or editing the account:
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.
o Allow restore of files with these extensions only — select this option to define which file types are
allowed for restore. In the text box, enter a list of extensions for allowed file types, separated by
commas.
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 Da tabases check box. If you select this check box, you can also
select the following options:
o Microsoft SQL Server databases — select this option to allow restore of Microsoft SQL databases on
machines included in the user's restore scope.
o Ora cle databases — select this option to allow restore of Oracle databases on machines included in the
user's restore scope.
o Deny in-place database restores — select this option to restrict the restore operator from overwriting
the original databases during the database restore process.
7. Click OK.
All operations on the backup server side are performed by Veeam Backup Service. The service verifies
beforehand if the account used by Enterprise Manager has rights to accomplish the necessary actions. For that,
the account 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.
NOTE
If SAML authentication is enabled, users can log in to vSphere Self-Service Backup Portal under SSO
accounts only.
2. To open the Configuration view, click Configuration in the top right corner.
6. In the Id entity Provider Configuration section, specify identity provider settings. For more information, see
Specifying Identity Provider Settings.
7. [Optional] If you want to use a certificate to encrypt and sign service provider SAML requests, specify
certificate settings. For more information, see Selecting Service Provider Certificate.
8. [Optional] Click the Ad vanced Settings link and specify advanced SAML authentication settings. For more
information, see Specifying Advanced SAML Authentication Settings.
9. In the E nterprise Manager Configuration section, export or manually copy metadata of the service provider
(the Veeam Backup Enterprise Manager website, vSphere Self-Service Backup Portal, or both) for which
you configure SSO. Use the metadata to register the service provider on the identity provider side. For
more information, see Obtaining Service Provider Settings.
After you configure SAML authentication settings, you can register user accounts that will be able to log in to
the Veeam Backup Enterprise Manager website or vSphere Self-Service Backup Portal using SSO. For more
information, see Managing Accounts and Roles and Managing Tenant Accounts.
• Import identity provider settings from a SAML metadata file obtained from the identity provider.
To import identity provider settings from the SAML metadata file, in the Id entity P rovider Configuration section
of the SAML Authentication view, click the Imp ort from File link and browse to the metadata file. The metadata
file structure must conform to the SAML 2.0 Metadata Schema.
1. In the Id entity Provider Configuration section, in the E ntity ID field, specify a unique ID of the identity
provider.
2. In the Log in URL field, specify the URL of the single sign-on login page provided by the identity provider.
3. From the Binding list, select a SAML binding used by the identity provider to send SAML r esponses:
HttpRedirect or HttpPost.
4. In the Id P certificate field, specify a certificate that will be used to validate the signature of the signed
authentication assertions and decrypt assertions sent by the identity provider.
NOTE
Veeam Backup Enterprise Manager does not support identity provider certificate rollover.
1. In the E nterprise Manager Configuration section of the SAML Authentication view, click the Select link
next to the Certificate field.
2. In the Select Service Provider Certificate window, Veeam Backup Enterprise Manager will display
certificates located in the certificate store on the Enterprise Manager server. Choose the necessary
certificate from the list and click Select.
If you use a certificate to sign end encrypt SAML authentication requests, you must pass the public key
certificate to the identity provider. The identity provider will use this certificate to encrypt requests and validate
the request signature. For more information, see Obtaining Service Provider Settings.
• To change the service provider certificate, click the Remove link next to the Certificate field. Then
select another certificate from the certificate store.
• You can choose whether to include the certificate in the service provider metadata. For more
information, see Specifying Advanced SAML Authentication Settings.
1. To include in the service provider SAML metadata a security certificate required to decrypt service
provider authentication requests, select the Include encryption certificate in metadata check box.
2. To validate the signature of the signed requests, select the Include signing certificate in metadata check
box.
3. From the Minimum accepted incoming signing algorithm and Outbound sign algorithm lists, select what
type of signed requests and responses Enterprise Manager will be able to send and receive. By default, the
SHA256 option is selected. With this option selected, Enterprise Manager will send and receive requests
and responses signed using the SHA256 or stronger algorithm.
4. By default, to provide for single sign-on authentication for groups of users, Veeam Backup Enterprise
Manager accepts information about groups from the identity provider in statements of the Group type. If
it is required to use for this purpose statements of a different type, in the Group claim type field, specify
the necessary type.
5. If you want to sign authentication requests sent from Enterprise Manager to the identity provider with a
digital certificate, in the Id entity Provider Settings section, select the Sig n AuthnRequests to IdP check
box.
6. From the Authentication context comparison list, select a comparison method for authentication context:
Exact, Minimum, Maximum or Better.
7. From the Authentication context class list, select one of the classes to specify an authentication method
used by the Identity Provider. 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 Veea m Backup Enterprise Manager field.
• To export service provider settings of vSphere Self-Service Backup Portal, click the Download link next to
the vSp here Self-Service Backup P ortal field.
1. Copy the links next to the SP E ntity ID / Issuer and Assertion consumer URL fields.
2. If you have selected a certificate that will be used to sign end encrypt SAML authentication requests, you
must also pass the public key certificate to the identity provider. To copy the certificate, click the
Download link next to the Certificate field.
• To update the Enterprise Manager certificate, you can use Internet Information Services (IIS) Manager. For
more information, see this Microsoft Docs article.
• To update the 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.
To receive email notifications, configure SMTP server settings. For more information, see Email Server Settings.
After that, you can switch on or off the necessary notifications. You can configure the following notifications:
• Job Summary
• Lab Requests
• Restore Operations
• License Information
• Key Management
2. 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.
3. In the Timeout field, specify a timeout for email server — this should be a value from 1 to 3600 seconds.
Default is 100 seconds.
4. If the SMTP server requires SSL connection, select the Use SSL check box.
5. If the SMTP server requires authentication, select the Requires authentication check box and specify
authentication credentials.
6. Click Sa ve.
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 Sub ject field, enter a subject of email notifications. You can use the following variables in the
subject:
o %1 — number of jobs that ended with errors for the last 24 hours
o %2 — number of jobs that ended with warnings for the last 24 hours
Job retries performed in the last 24 hours are also included in the report.
Jobs which were in Disabled state during the last session are also included in the report.
7. Click Sa ve.
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 P ending, Ready,
Ca nceled, Ap proved, Failed or Stopped.
8. Click Sa ve.
TIP
To verify that you have configured email settings correctly, click Test. Veeam Backup Enterprise Manager
will send a test email to all specified email addresses.
For more information about the universal application item-level restore, see Veeam Universal Application Item
Recovery Guide.
5. In the To field, enter an email address of the notification recipient. Use a comma to specify multiple
addresses.
6. Click Sa ve.
TIP
To verify that you have configured email settings correctly, click Test. Veeam Backup Enterprise Manager
will send a test email to all specified email addresses.
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 Sa ve.
TIP
To verify that you have configured email settings correctly, click Test. Veeam Backup Enterprise Manager
will send a test email message to all specified email addresses.
You can configure Enterprise Manager to send notifications about the following key mana gement 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 Sa ve.
TIP
To verify that you have configured email settings correctly, click Test. Veeam Backup Enterprise Manager
will send a test email to all specified email addresses.
The Enterprise Manager log files are available 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
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.
IMP ORTANT
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 messages.<code>.po
o vcloud_messages.<code>.po
o vsphere_messages.<code>.po
TIP
Although PO files are not used by Veeam Backup Enterprise Manager, you can save them in the lang
folder to keep them together with other language files.
PO File Structure
Each PO file contains the following elements:
• Header
• Translation entries
Header
Header contains meta data of the PO file: language code in the ISO 639-1 format, content type and encoding,
and plural form information.
P a rameter Description
Content-Type Content type and character encoding used for the translation language. Set the
type value to text/plain. You can use the UTF-8 encoding for any language.
P lural-Forms Number of plural forms and the plural form formula of the translation language.
"Project-Id-Version: \n"
"POT-Creation-Date: \n"
"PO-Revision-Date: \n"
"Language-Team: \n"
"Language: de\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Plural-Forms: nplurals=2; plural=(n != 1);\n"
"X-Generator: \n"
For more information on the PO header, see this GNU gettext article.
Translation entries
In a PO file, translation entries are separated with a blank string. Each entry consists of the following elements:
• Do not modify msgid strings. They are references to the source code. Veeam Backup Enterprise Manager
uses them to find their translation.
Variables are placed inside braces. For example, the following entry contains the restoreItemsCount
variable:
• If an msgid string is followed by its plural form msgid_plural, provide translation for each form.
For example:
For more information on translating plural forms, see this GNU gettext article.
Converting PO to JSON
Veeam Backup Enterprise Manager loads translated strings from JSON files. After you finish translating PO files,
convert them to the JSON format.
1. To locate the utility, use the cd command. By default, the utility is located in the Enterprise Manager
folder.
cd '<path>'
For example:
.\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.
• 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 Ba ckup server drop-down list to view the jobs of the selected backup server only.
o Use the Sta tus filter to view the jobs with the selected job statuses.
Once you have selected necessary statuses, click the Ap p ly button to apply the filter.
Besides the information presented in the list of jobs, the Job s tab allows you to view advanced job data:
• To see a list of job sessions, click the job name link in the Na me column.
• To see detailed statistics on the last job run, click the state link in the Sta tus column.
NOTE
You can export displayed information to a file using the E x p ort link on the toolbar. This file then can be
opened on the client machine using the associated application.
• To start a job, select the job from the list and click Sta rt.
• To stop a job, select the job from the list and click Stop .
• To retry a failed job, select the job from the list and click Retry.
NOTE
• For more information on starting a backup copy job, see the Starting Backup Copy Jobs Manually
section of the Veeam Backup & Replication User Guide.
• For more information on starting and stopping an Oracle or SQL server backup job with transaction
log processing enabled, see the Starting and Stopping Transaction Log Backup Jobs section of the
Veeam Backup & Replication User Guide.
IMP ORTANT
• You can edit jobs if you have an Enterprise or Enterprise Plus license installed.
• 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 E d it Backup Job (or E d it Replication Job) wizard.
1. Open the Job s tab and select the necessary job in the list.
3. Select E d it.
2. In the Description field, provide an optional description for future reference. The default description
contains information about the user who created the job, date and time when the job was created.
o From the Retention p olicy list, select Restore points and specify the number of restore points that you
want to store in the backup repository. When this number is exceeded, the earliest restore point will
be removed from the backup chain.
o From the Retention p olicy list, select Days and specify the number of days for which you want to store
restore points in the backup repository. After this period is over, a restore point will be removed from
the backup chain.
For more information on retention, see the Short-Term Retention Policy section of the Veeam Backup &
Replication User Guide. Also, see this Veeam KB article.
4. To use the GFS (Grandfather-Father-Son) retention scheme, select the Keep certain full backups l onger
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 vCD backup jobs, you can add and remove the following vCD objects: VMs, vApps, organization
vDCs, organizations and the vCD instance. The scope depends on your vCD access rights.
• For vCD replication jobs, you cannot add or remove single VMs. You can manage only vApps and
other vCD containers.
1. Click the Ad d .
If you select a VM container and later add a new VM to the container, Veeam Backup & Replication will
update job settings automatically to include the VM.
TIP
• Search for objects: type a name or part of a name in the search field. Specify the type of the
object from a scroll list next to the search field.
• 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,
Da tastores and VMs and Ta gs 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 E x clusions window, click Ad d and select machines that you want to exclude.
To change the VM processing order, select the necessary machines and move them up or down the list using the
Up and Down buttons on the right. In the same manner, you can set the backup order for containers in the
backup list.
NOTE
• VMs inside a VM container are processed at random. To ensure that VMs are processed in the defined
order, add them as standalone VMs, not as a part of containers.
• The processing order may differ from the order that you have defined. For ex ample, 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 vCD backup jobs you can change the order of the following vCD objects: VMs, vApps,
organization vDCs, organizations and the vCD instance. The scope depends on your vCD access rights.
• For vCD replication jobs, you cannot change the VM processing order. You can manage only vApps
and other vCD containers.
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 backups or replicas.
The transactionally consistent replicas guarantee proper recovery of applications without data loss.
3. To define custom settings for a machine in the list, select it and click E d it.
o To customize settings of a machine added to the job as part of a container, add the machine as a
standalone instance. For that, click Ad d machine and choose the necessary VM. Next, select the
machine from the list and click E d it to customize VM settings.
o To discard custom settings of a machine, select the machine in the list and click Remove.
4. Configure the necessary settings for the selected applica tion server:
o General Settings
o File Exclusions
• Select Require successful processing (default option) if you want Veeam Backup & Replication to stop the
backup job if an error occurs.
• 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.
• Select Disable application processing if you do not want to enable application-aware processing for the
VM. This option makes the Tra nsaction Logs Processing section unavailable.
• Select P rocess transaction logs with this job if you want Veeam Backup & Replication to handle transaction
logs. With this option enabled (default setting), Veeam will support log pruning for Microsoft Exchange
and Microsoft SQL Servers, as well as for Oracle databases archived logs:
o Truncation of transaction logs for Microsoft Exchange Server machines will be performed after the job
completes successfully: the Veeam runtime process will wait for the machine backup to complete and
then trigger truncation of transaction logs. If truncation of transaction logs is not possible for some
reason, the logs will remain untouched in the machine guest OS until the next start of the Veeam
runtime process.
o Settings for SQL Server transaction log handling can be configured separately on the SQL tab — it
becomes available to you with this option selected.
o Similarly, you can configure settings for Oracle database archived logs processing on the Ora cle tab.
• Select P erform copy only if you want to use native application means or a third-party tool to process
transaction logs. Veeam Backup & Replication will create a copy-only backup for the selected machine.
The copy-only backup preserves a chain of full/differential backup files and transaction logs, so Veeam
Backup & Replication will not trigger transaction log truncation. This option is recommended if you are
using another backup tool to perform the machine guest-level backup, and this tool maintains consistency
of the database state. To learn more, see the Guest Processing section of the Veeam Backup & Replication
User Guide.
With this option selected, the SQL and Ora cle tabs are not available.
File Exclusions
On the File Exclusions tab, specify whether to exclude or include specific files in the backup. Exclusions can help
decrease the backup file size. However, selective processing takes additional time that depends on the number
of excluded files; also, it requires obtaining per-file metadata (stored in backups). Thus, it is recommended to
use this option for excluding large files. By default, exclusions are disabled.
• E x clude the following files and folders — with this option selected, you can specify what files and folders
must be excluded from the backup.
• Include only the following files and folders — with this option selected, you can specify exactly what files
and folders must be only included in the backup.
To form the list of exclusions or inclusions, you can use full paths to files and folders, environmental variables,
and file masks with the asterisk (*) and question mark (?) characters. For more information, see the VM Guest OS
Files section of the Veeam Backup & Replication User Guide.
NOTE
For proper file indexing of Linux machines, Veeam Backup & Replication requires several utilities to be
installed on the machines: mlocate, gzip, and tar. If these utilities are not found, you are prompted to
deploy them to support index creation.
2. In the Guest File System Indexing Options window, select a machine from the list and click E d it.
o To customize settings of a machine added to the job as part of a container, add the machine as a
standalone instance. For that, click Ad d Machine and choose the necessary VM. Next, select the
machine from the list and click E d it to customize VM settings.
3. In the Ind exing Settings window displayed for the selected machine, go to the W ind ows or Linux tab and
specify what files should be indexed:
o Select Disable indexing if you do not want to index guest OS files of the machine.
o Select Ind ex everything if you want to index all guest OS files inside the machine.
o Select Ind ex everything except folders if you want to index all guest OS files except those defined in
the list. By default, system folders are excluded from indexing. You can add or delete folders to
exclude using the Ad d and Remove buttons.
Guest OS Credentials
To coordinate guest processing activities, Veeam Backup & Replication deploys a runtime process on the VM
guest OS. The process runs only during guest processing and is stopped immediately after the processing is
finished.
In the Guest OS credentials section, you can select credentials from the list, or click the Ad d button to add new
credentials.
• For Windows guest OS, specify a user account (name and password) with local administrative rights on
target machine, and optional description. Credentials must be specified in the following format:
• For Linux guest OS, 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.
a. To provide a non-root user with root account privileges, select the E levate specified account to root
check box.
b. To add the user account to the sudoers file, select the Ad d account to the sudoers file automatically
check box. In the Root password field, enter the password for the root account.
If you do not enable this option, you will have to manually add the user account to the sudoers file.
c. If 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.
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.
If you plan to use Linux private key for authentication, make sure you have created private and public keys and
stored them appropriately: private key on the client side (Veeam backup server) and public key on the server
side (Linux machine). You should also have the passphrase for the private key if it is encrypted. If you select to
use Linux private key credentials, you should specify the following:
• User name
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.
To customize settings of a machine added as part of a container, the machine should be included in the list
as a standalone instance. For that, click Ad d machine and choose a machine whose settings you want to
customize.
1. Select the Run the job automatically check box. If the check box is not selected, you will need to start the
job manually.
2. Edit the scheduling settings. You can select to run the job daily, monthly, periodically with a specific time
interval, continuously or after a specific job.
3. In the Automatic retry section, define whether Veeam Backup & Replication must attempt to run the
backup job again if the job fails for some reason. During a job retry, Veeam Backup & Replication processes
failed machines only. Enter the number of attempts to run the job and define time intervals between
them. If you select continuous backup, Veeam Backup & Replication will retry the job for the defined
number of times without any time intervals between the job runs.
4. In the Ba ckup window section, edit the time interval within which the backup job must complete. The
backup window prevents the job from overlapping with production hours and ensures that the job does
not provide unwanted overhead on the production environment. To set up a backup window for the job:
a. Select the Terminate job if it gets out of a llowed backup window check box and click W indow.
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.
• To run the job at specific time daily, on defined week days or with specific periodicity, select Da ily at this
time. Use the fields on the right to configure the necessary schedule.
• To run the job once a month on specific days, select Monthly at this time. Use the fields on the right to
configure the necessary schedule.
NOTE
When you configure the job schedule, keep in mind 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 P eriodically every. In the
field on the right, select the necessary time unit: Hours or Minutes. Click Schedule and use the time table
to define the permitted time window for the job. In the Sta rt time within an hour field, specify the exact
time when the job must start.
o Veeam Backup & Replication always starts counting defined intervals from 12:00 AM. For example, if
you configure to run a job with a 4-hour interval, the job will start at 12:00 AM, 4:00 AM, 8:00 AM,
12:00 PM, 4:00 PM and so on.
o If you define permitted hours for the job, after the denied interval is over,
Veeam Backup & Replication will immediately start the job and then run the job by the defined
schedule.
For example, you have configured a job to run with a 2-hour interval and defined permitted hours from
9:00 AM to 5:00 PM. According to the rules above, the job will first run at 9:00 AM, when the denied
period is over. After that, the job will run at 10:00 AM, 12:00 PM, 2:00 PM and 4:00 PM.
• To chain jobs, use the After this job field. In the common practice, jobs start one after another: when job A
finishes, job B starts and so on. If you want to create a chain of jobs, you must define the time schedule for
the first job in the chain. For the rest of the jobs in the chain, select the After this job option and choose
the preceding job from the list. If you start the first job manually, Veeam Backup Enterprise Manager will
display a notification. You will be able to choose whether to start the chained job as well.
NOTE
You can chain jobs that are processed on the same backup server only.
NOTE
Creating active full backups is unavailable for backup copy jobs 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 SQL 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 t he
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 Y es to confirm the operation.
To quickly find a CDP policy, you can use filters and the search field.
o Use the Ba ckup server list to view the policies of the selected backup server only.
o Use the Sta tus filter to view the policies with the selected statuses only.
Once you have selected necessary statuses, click the Ap p ly button to apply the filter.
In addition to the information presented in the list of policies, the P olicies tab allows you to view advanced
policy data. To see detailed policy statistics, click the state link in the Sta tus column.
NOTE
You can export displayed information to a file using the E x p ort link on the toolbar. This file then can be
opened on the client machine using the associated application.
• Policy schedule
1. Open the P olicies tab and select the necessary policy from the list.
1. Click Ad d .
If you select a VM container and later add a new VM to the container, Veeam Backup & Replication will
update policy settings automatically to include the VM.
TIP
• Search for objects: type a name or part of a name in the search field. Specify the type of the
object from a scroll list next to the search field.
• Switch between virtual infrastructure views using the buttons in the top right corner: Hosts
a nd Clusters, VMs and Templates, Datastores and VMs and Ta gs and VMs.
2. In the E x clusions window, click Ad d and select machines that you want to exclude.
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.
b. To specify permitted and denied hours for the policy run, click Schedule on the right and use the
timetable.
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.
c. To specify time periods when Veeam Backup & Replication must create application-consistent and
crash-consistent long-term restore points, click VSS. In the Time p eriods window, select the necessary
time area and click Cra sh-consistent or Ap p lication-consistent. By default,
Veeam Backup & Replication creates application-consistent backups if you enable application-aware
processing. If you do not enable application-aware processing, Veeam Backup & Replication will
create crash-consistent long-term restore points.
To shift the schedule, specify the offset in the Sta rt time within a n hour field. For example, you
schedule creation of crash-consistent restore points from 00:00 to 01:00, and set the offset value to
25. The schedule will be shifted forward, and the crash-consistent restore points will be created from
0:25 and to 01:25.
Application-Aware Processing
If VMs run Microsoft Active Directory, Microsoft SQL Server, Microsoft SharePoint, Microsoft Exchange or
Oracle, you can enable application-aware processing to create transactionally consistent replicas. The
transactionally consistent replicas guarantee proper recovery of applications without data loss.
3. To define custom settings for a machine in the list, select it and click E d it.
o To customize settings of a machine added as part of a container, add the machine as a standalone
instance. For that, click Ad d machine and choose the necessary VM. Next, select the machine from the
list and click E d it to customize VM settings.
o To discard custom settings of a machine, select the machine in the list and click Remove.
o General Settings
General Settings
Applications Section
In this section, select the behavior scenario for application-aware processing:
• Select Require successful processing (default option) if you want Veeam Backup & Replication to stop the
CDP replication if an error occurs during application-aware processing.
• Select Try application processing, but ignore failures if you want to continue the CDP replication process
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.
• Select Disable application processing if you do not want to enable application-aware processing for the
VM. This option makes the Tra nsaction logs processing section unavailable.
• Select P rocess transaction logs with this job if you want Veeam Backup & Replication to handle transaction
logs. With this option enabled (default setting), Veeam will support log pruning for Microsoft Exchange
and Microsoft SQL Servers, as well as for Oracle databases archived logs:
o Truncation of transaction logs for Microsoft Exchange Server VMs will be performed after the CDP
policy completes successfully. If the CDP policy fails, the logs will remain untouched until the next
start of the runtime process.
o Settings for SQL Server transaction log handling can be configured separately on the SQL tab — it
becomes available to you with this option selected.
o Similarly, you can configure settings for Oracle database archived logs processing on the Ora cle tab.
NOTE
With this option selected, the SQL and Ora cle tabs are not available.
Guest OS Credentials
To coordinate guest processing activities, Veeam Backup & Replication deploys a runtime process on the VM
guest OS. The process runs only during guest processing and is stopped immediately after the processing is
finished.
In the Guest OS credentials section, you can select credentials from the list, or click the Ad d button to add new
credentials.
• For Windows guest OS, specify a user account (name and password) with local administrative rights on
target machine, and optional description. Credentials must be specified in the following format:
• For Linux guest OS, 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.
a. To provide a non-root user with root account privileges, select the E levate specified account to root
check box.
b. To add the user account to the sudoers file, select the Ad d account to the sudoers file automatically
check box. In the Root password field, enter the password for the root account.
If you do not enable this option, you will have to manually add the user account to the sudoers file.
c. If 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.
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.
If you plan to use Linux private key for authentication, make sure you have created private and public keys and
stored them appropriately: private key on the client side (Veeam backup server) and public key on the server
side (Linux machine). You should also have the passphrase for the private key if it is encrypted. If you select to
use Linux private key credentials, you should specify the following:
• User name
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.
To customize settings of a machine added as part of a container, the machine should be included in the list
as a standalone instance. For that, click Ad d machine and choose a machine whose settings you want to
customize.
To delete a policy:
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 Veeam Availability Suite: 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 initia tes 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 Ag ent will prompt you to deploy them in
case they are not found.
For more information, see the File System Indexing section of the following guides:
3. Run the backup job with guest file system indexing enabled.
4. Make sure the indexing data is imported to Veeam backup database, and catalog data replication is
completed successfully. For more information, see Performing Catalog Replication and Indexing.
Whether you restore from a backup with or without guest file indexing, prepare a machine to operate as an FLR
helper appliance.
When guest file-level restore is started from Veeam Backup Enterprise Manager, FLR helper configuration
settings are obtained from the database of the Veeam backup server. If no FLR helper configuration is found for
the current user account, Veeam Backup & Replication uses the default settings (set during the latest FLR
appliance configuration process in Veeam backup console). Thus, before you start file -level restore from
Enterprise Manager, make sure that FLR helper setting s are configured on Veeam backup server.
NOTE
If you plan to deploy multiple FLR helper appliances to restore machines backed up by Veeam Agents
integrated with different Veeam backup servers, their initial configuration should 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.
IMP ORTANT
When restoring files to the original location, you are prompted for user credentials to the target machine.
Make sure the account you provide has sufficient access rights.
To restore application items, follow the procedures described in the following sections:
IMP ORTANT
Restore scope (list of objects a user can recover) can be customized 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 file shares or selected file types. Possible delegation options
are described in the Configuring Restrictions for Delegated 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 Ba ckup 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 Ba ckup 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 E x p ort 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 Veea m 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 brows e and search through
backup contents even if the backup in the repository is no longer available.
2. In the Sea rch backups of field, enter the name of a file share whose files you want to browse or click the
P ick 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 Performing File Restore.
For each file in the backup, Enterprise Manager displays file size and the date when the file version is
created. Enterprise Manager displays only the file version contained in the selected restore point. For
more information on file restore, see Performing File Restore.
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.
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 Accounts and
Roles.
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.
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.
2. Click Download.
5. Wait for restore session to complete and the file to be retrieved from the backup.
7. In the Log tab of the File Restore History view, click the d ownload link in the Restored files are available
for download record of the session log.
The file is saved to the default download folder on your local machine.
1. Locate the necessary file using browse or search possibilities of Veeam Backup Enterprise Manager. For
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.
When a file is added to the restore list, the P ending restore notification appears at the top of the Enterprise
Manager UI window.
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 d ownload link.
The files are saved to the default download folder on your local machine.
Multiple files are also saved in a ZIP file named FLR_<date>_<time>.zip in the
%ProgramData%\Veeam\Backup\WebRestore folder. Veeam Backup Enterprise Manager cleans up the
folder periodically. Files older than 24 hours are automatically deleted. To change the default storage
folder, contact Veeam Customer Support.
TIP
Veeam Backup Enterprise Manager keeps links for downloaded files in the history for one day. To
download a file that was previously restored:
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.
• Run failover plans for VMware vSphere and Microsoft Hyper-V VMs
IMP ORTANT
Restore scope (list of machines a user can recover) can be customized if you have the Enterprise Plus
edition of Veeam Backup & Replication. In other editions, this list includes all machines and cannot be
customized. However, you can delegate recovery of entire machines, guest files, or selected file types.
Possible delegation options are described in the Configuring Restrictions for Delegated Restore section.
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 Ma chines tab allows you to view advanced data
about each machine:
• To see detailed information about a machine, click its name in the Ma chine 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 E x p ort link on the toolbar. This file then can be
opened on the client machine using the associated application.
1. On the Ma chines tab, select the necessary machine backup from the list of machines.
To quickly find a machine, you can filter machines in the list by a backup server or search for specific
machines by a machine name.
2. Click Delete.
3. To remove backups marked with weekly, monthly and yearly GFS flags, select the Remove GFS full
b a ckups check box.
The deleted machine is not removed from the list of machines immediately. The machine will be removed from
the list after records about the machine are removed from the configuration database on the Veeam backup
server. Once this operation completes, a notification appears at the top of the Enterprise Manager UI window.
NOTE
• If several 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 bac ked up
to tape.
Quick backup can be performed for machines that meet the following requirements:
• A full backup file for the machine exists in the backup repository.
NOTE
Quick backup is not available for vCloud Director VMs and Veeam Agent machines.
To perform quick backup, on the Ma chines tab, select the machine you need and click Quick Backup.
Veeam Backup & Replication will trigger a backup job to create a new incremental restore point for the selected
machines. Details of the running quick backup operation are displayed in the job session window.
IMP ORTANT
• 1-Click Restore is available in the Enterprise and Enterprise Plus editions of Veeam Backup &
Replication.
• 1-Click Restore from any storage snapshots, Veeam Agent backups and backups created with Veeam
Plug-ins for Enterprise Applications are not supported by Veeam Backup Enterprise Manager.
1. On the Ma chines 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.
o Select Overwrite if you want to replace the original machine in the production environment with the
machine from the backup.
o Select Keep if you want to restore the machine from the backup next to the original machine in the
production environment.
NOTE
Veeam Backup Enterprise Manager supports machine restore to the original location only. You
cannot restore a VM to another location or with different settings (such as network settings, format
of restored virtual disks and so on).
3. In the Restore window, select a restore point that will be used to restore the machine.
4. [Optional] Instead of restoring an entire machine from a backup file, you can instruct Enterprise Manager
to recover only those data blocks that are necessary to revert the machine 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.
For more information on quick rollback, see the Quick Rollback section of the Veeam Backup & Replication
User Guide.
5. [Optional] To start a machine immediately after recovery, select the P ower on machine after restoring
check box.
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.
IMP ORTANT
Failover is available in the Enterprise and Enterprise Plus editions of Veeam Backup & Replication.
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 Fa ilover.
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 av ailable crash-
consistent state, to the latest application-consistent state or to a specific point in time.
TIP
• To quickly find a long-term restore point, use the calendar.
• To zoom in or zoom out the time line, use the P lus and Minus buttons or switch between the
Hour and Da y views.
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:
4. Click Fa ilover.
For more information on virtual disk restore, see the Virtual Disks Restore section of the
Veeam Backup & Replication User Guide.
IMP ORTANT
1. This functionality is available in the Enterprise and Enterprise Plus editions of Veeam Backup &
Replication.
2. The disk restore operation 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 Ma chines 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 P oint 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.
5. By default, virtual disks are restored to the target machine with the original properties. To change
properties for the restored disks:
a. In the Disk Mapping section, select the necessary virtual disk and click the Cha nge disk mapping link.
b. In the Virtual Disk Properties window, click Choose next to the Da tastore field and select a datastore
where the virtual disk file will be placed.
c. From the Virtual Device Node list, select a virtual device node for the restored disk on the target VM:
▪ If you want to replace an existing virtual disk, select an occupied virtual device node.
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.
a. Select the Sca n 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:
▪ P roceed with recovery but do not a ttach 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.
▪ Ab ort 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 P ower on target VM after disk is restored check box. Then
click Finish.
To view the progress of the virtual disk restore operation, on the Ma chines tab, click History.
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 app ear in the failover plan, within the set
time intervals.
Consider that failover is a temporary intermediate step that needs to be finalized. The finalizing options for a
group failover are similar to a regular failover: undoing failover, permanent failover or failback. To learn more
about failover planning and recommended course of action, refer to Veeam Backup & Replication User Guide.
Veeam Backup Enterprise Manager allows you to carry out a failover following the existing plan, and also to
undo planned failover.
NOTE
For failover plan creation, as well as for permanent failover or failback, use the Veeam Backup &
Replication console.
1. Log in to Enterprise Manager using an administrative account or user account whose restore scope
contains the machines from the failover plan.
3. In the Fa ilover Plan window, select the necessary plan from the list, then specify the starting option you
need.
o Sta rt now — use this option if you need to fail over to the replicas’ latest restore point.
o Sta rt to most recent replica prior to — use this option if you need to fail over to a certain restore point.
For example, you may want your application server to failover to a state prior to the upgrade. 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.
o Und o — use this option to switch the workload back to source machines discarding the changes that
were made to the replicas during failover.
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.
• In 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 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. 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. I n 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 the helper appliance.
Then a user 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 Up date
Now on the Sea rch Catalog tab.
• To automatically run catalog replication after every backup job, open the Settings tab of the Configuration
view. On the Sea rch Catalog tab, select Up d ate catalog automatically after each backup job run and
specify other options as required.
Every run of a catalog replication job initiates a new job session which can be tracked on the Sessions tab of the
Configuration view. To view detailed information for a specific session, select it in the list of sessions and click
the link in the Sta tus column.
1. To enable guest file indexing, use one of the options of the machine backup job: Ind ex everything, Index
everything except, or Ind ex only following folders option. For more information, see the Guest OS File
Indexing section of this guide and the VM Guest OS File Indexing section of the Veeam Backup &
Replication User Guide.
Keep in mind that indexing is optional. You can browse and restore machine guest 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.
NOTE
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 (running Linux or another non-Windows OS).
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 for the
credentials. Specify user 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 guest file-level restore is started from Veeam Backup Enterprise Manager, FLR helper configuration
settings are obtained from the database of the backup server. If no FLR helper configuration is found for current
user account, Veeam Backup & Replication uses the default settings (set during the latest FLR appliance
configuration process in Veeam backup console). Thus, before starting file-level restore from Enterprise
Manager, make sure that FLR helper settings are configured on Veeam backup server.
If you are using the Enterprise or Enterprise Plus license edition in your vir tual environment, consider that
Veeam Backup Enterprise Manager keeps index files for backups that are currently stored on disk, and for
archived backups (for example, backups that were recorded to tape). Thus, you will be able to browse and
search through backup contents even if the backup in repository is no longer available.
2. In the Sea rch backups of field, enter the name of a machine whose files you want to restore or click the
P ick from List link and select the necessary machine in the Select Object window.
3. To specify a restore point from which to restore guest OS files, click the calendar icon in the restore point
field and select 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.
IMP ORTANT
For machines processed without indexing, you can only use browsing or search to find the necessary files
within the selected restore point. Advanced search capabilities (including search through multiple restore
points) are available only for machines processed with guest indexing enabled.
IMP ORTANT
By default, backup repository is the primary destination for the search. This means, in particular, that if a
backup (with 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 Sea rch backups of field, enter the name of a machine whose files you want to restore or click the
P ick from List link and select the necessary machine in the Select Object window.
3. In the search field, enter the name of the necessary file or a part of it and click Sea rch.
The advanced search allows you to search for guest OS files in all restore points of the sele cted 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 La st modification time — specify approximate time when the file was last modified or set a time
interval.
o Ba ckup time — choose to search through the latest backup of the specified machine or all backups of
the machine created within a certain time interval.
IMP ORTANT
• 1-Click file restore capability is available if you have the Enterprise or Enterprise Plus edition.
• 1-Click 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 wi th 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 Accounts and Roles.
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).
IMP ORTANT
This type of restore is only possible if the original machine is powered on and resides in the original
location.
1. Locate the necessary file 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 file from the backup will replace the original file on the target machine.
o If you select Keep, the file from the backup will be restored next to the original file on the target
machine; the file from machine backup will have the Restored prefix 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.
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 d ownload link in the Restored files are available
for download record of the session log.
The file is saved to the default download folder on your local machine.
1. Locate the necessary file using browse or search possibilities of Veeam Backup Enterprise Manager. For
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 P ending restore notification appears at the top of the Enterprise
Manager window.
2. In the P ending Restore window, select check boxes next to files in the restore list that you want to
restore. Use the check box next to the header of the Na me column to select all files in the list at once.
If you want to remove a file from the restore list, select the file and click Delete.
3. Click the Restore or Download link to perform the necessary restore operation for the selected files.
5. [For the download operation] Wait for restore session to complete. In the Log tab of the File Restore
History view, click the d ownload link.
The files are saved to the default download folder on your local machine.
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.
IMP ORTANT
A Self-Service File Restore Portal user has access only to restore points created after the user is assigned
with local administrator rights.
Machine restore points will stay available for self-restore to a user account whose local administrative
rights were revoked after the restore point creation until the next restore point is created (then that user
will not be able to access guest files any longer).
1. Start the Self-Service File Restore Portal by clicking its icon in the list of applications or on the desktop.
Alternatively, in the web browser address bar, enter the portal URL, for example:
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 ca lendar icon and select the restore point. To view
guest files of another machine (if available to you), use the Sea rch field or the P ick from List link.
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 E nable g uest file system indexing option is turned off in the machine backup job. Edit the job setting
and restart the job with indexing enabled.
• When the machine restore point was created, the user was not assigned local administrative rights. To
access the guest OS files the user must be a part of the guest OS local administrator group.
IMP ORTANT
To be able to restore Microsoft Exchange items from the Veeam Backup Enterprise Manager UI, 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.
• Enterprise Manager supports restore over a network connection only. Restore with PowerShell Direct, VIX
or Sphere API is not supported.
• Enterprise Manager does not support application item restore from storage snapshots.
1. Go to the Job s tab and select your Exchange server backup job.
2. Click Job on the toolbar and select E d it to start the job wizard.
3. Proceed to the Guest Processing step of the wizard and make sure the E na ble application-aware
p rocessing check box is selected.
4. Click the Customize Application link. In the displayed window, select the Exchange server machine from
the list and click E d it.
5. On the General tab, make sure that the Require successful processing option is selected in the
Ap p lications section.
6. In the Tra nsaction logs processing section, the P rocess transaction logs with this job option is selected by
default.
8. In the Guest OS credentials section you can edit the account credentials under which guest OS will be
accessed.
o By default, for all machines in the job Veeam will use common credentials provided in the Guest OS
credentials section — for that, you can select the account from the list, or click the ‘+’ sign and select
Windows (or Linux) OS. Then you will be prompted to enter a user name and password for guest OS
access. Click OK to save the settings and return to the Guest P rocessing page.
For more information on specifying guest OS access credentials, see Guest OS Credentials.
9. At the final step of the wizard, verify job schedule and click Finish.
1. Assign a security role to the necessary user and allow them to restore Microsoft Exchange items:
c. To allow restore of Microsoft Exchange items, select the Microsoft Exchange items check box.
This makes the Items tab become available to these users after they log in to Enterprise Manager.
For more information on Enterprise Manager accounts and roles, see Configuring Accounts and Roles.
2. 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:
1. Sign in to Veeam Backup Enterprise Manager using an account with the sufficient permissions. For more
information, see Providing Access Rights.
3. 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 rest ore
points.
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.
5. In the Items section, select the type of item you want to restore:
o Mail
o Calendar
o Contacts
You can select to Only restore missing items created or received during the certain time period. To specify
the period, use the drop-down list.
6. Click the Restore button. Items that meet specified conditions will be restored to the production Exchange
Server.
• You can use Veeam Backup Enterprise Manager to restore deleted items to the production mailbox
only.
• If the specified mailbox does not exist in the machine restore point that you selected for restore,
Veeam Backup Enterprise Manager will display an error message.
NOTE
This functionality is provided in the Enterprise and Enterprise Plus editions of Veeam Backup & Replication.
• Enterprise Manager supports restore over a network connection only. Restore using PowerShell Direct,
VIX or Sphere API is not supported.
• Enterprise Manager does not support database restore from storage snapshots.
1. Go to the Job s tab and select your SQL server backup job.
2. Click Job on the toolbar and select E d it to start the job wizard.
3. Proceed to the Guest Processing step of the wizard and make sure the E na ble application-aware
p rocessing check box is selected.
4. Click the Customize Application link. In the displayed window, select the SQL server machine from the list
and click E d it.
5. On the General tab, make sure the Require successful processing option is selected in the Ap p lications
section.
6. To be able to specify transaction log handling options, make sure the P rocess transaction logs with this
job option is selected. Otherwise, if you select the P erform copy only option, Veeam Backup & Replication
will create a copy-only backup, and transaction logs will not be purged — that is why the SQL tab with log
handling settings will be deactivated in this case. For more information, see the Microsoft SQL Server
Transaction Log Settings section of the Veeam Backup & Replication User Guide.
7. Open the SQL tab and specify how SQL transaction logs will be handled:
o Select Truncate logs if you want Veeam Backup & Replication to trigger truncation of transaction logs
only after the job is finished successfully. If truncation of transaction logs is not possible f or some
reason, the logs will remain untouched in the machine guest OS until the next start of the Veeam
runtime process responsible for application-aware processing.
o Select Ba ckup logs periodically if you need to backup transaction logs of SQL server machine, storing
them to backup repository next to server backup. After transaction logs are placed to repository, they
will be truncated on guest. With this option selected, you should also specify how often Veeam will
process these transaction logs, uploading them to repository. To set the processing frequency, enter
the required value in the Ba ckup logs every <N> minutes field (default is every 15 minutes).
The last option allows you to restore the SQL database to a selected restore point or to a selected
point in time, using Enterprise Manager. Restore to specific transaction can be performed using
Veeam backup management console. For more information, see the Microsoft SQL Server Transaction
Log Settings sections of the Veeam Backup & Replication User Guide.
IMP ORTANT
• If you select the Do not truncate logs option, make sure the recovery model for the necessary
databases on the SQL server is set to simple (otherwise, logs may drastically increase in size).
• For the Ba ckup logs periodically option to take effect, you should ensure that full or bulk-
logged recovery model is turned on for the required databases on the SQL server machine. If
recovery model is set to simple, no transaction logs will be backed up. If full model is enabled
but neither Ba ckup logs periodically nor Truncate logs option is selected, then logs will
increase in size and occupy disk space.
8. If you selected to back up transaction logs, specify how long they should be kept using options in the
Retain log backups section.
Select the Until the corresponding image-level backup is deleted option, so that you do not have to
manually check and ensure that your database and log backup retention policies are consistent, providing
all the machine restore points and log backups required for database restore.
The Items tab will become available to these users after they log in to Enterprise Manager.
For more information on how to configure user access rights, see Configuring Accounts and Roles.
1. Sign in to Veeam Backup Enterprise Manager using an account with the sufficient permissions. For more
information, see Providing Access Rights.
3. Enter a name of SQL Server hosting the database you need to restore; use the server_name\instance_name
format. Alternatively, click the P ick from List link to select from the list of available SQL Server machine
backups.
4. The list of available databases will be displayed. 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 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.
NOTE
For more information on the account roles in Veeam Backup Enterprise Manager that allow the user
to restore SQL databases, see Providing Access Rights.
5. Perform restore following the required scenario. For information on the possible restore scenarios, see 1-
Click Restore to Original Location and Restore with Custom Settings.
When you restore database items to the original location, Enterprise Manager selects user credentials for the
restore procedure according to the following rules:
1. Veeam Backup Enterprise Manager tries to use the account specified in the backup job that contains the
SQL Server machine.
2. If this account does not have sufficient rights to perform the restore procedure (for example, in case of
imported backup), the Enterprise Manager user will be prompted to provide the necessary credentials.
NOTE
For more information on the account roles in Veeam Backup Enterprise Manager that allow a user to
restore SQL databases, see Providing Access Rights.
When performing database restore to the original location, a temporary iSCSI connection is established between
the target 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.
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.
1. To specify a restore point from which to restore the database, in the Restore p oint field, click the calendar
icon and select the necessary date when backup was performed and a restore point created on that date.
2. For a database backed up with transaction log backup turned on, you can also select the necessary point in
time using the P oint in time slider. The slider displays the following timestamps (relative to the currently
selected SQL server restore point):
o Beginning — refers to the previous restore point of the SQL Server machine that contains the selected
database backup. If the previous restore point (server backup) was not found, or the database backup
does not exist in it, then Beginning will refer to current restore point.
o End — refers to the next restore point which 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 End 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 End will refer to the latest log backup time.
NOTE
For more information on the transaction log backup, see Microsoft SQL Server Logs Backup and
Restore section of the Veeam Backup & Replication User Guide.
4. Click Restore.
5. At the Ta rget Server step of the wizard, specify settings to connect to the target server and database:
a. In the Ta rget Server section, enter the name of the SQL Server or SQL Server instance in the
SERVER\INSTANCE format, and credentials of the account that will be used to connect to the target
server.
c. To use a separate account for connection to the target database, in the Ta rget Database section,
select the Use the following credentials to access the database check box and specify credentials of
the necessary account.
d. If you want to use SQL Server authentication when connecting to the database, select the Use SQL
Server authentication check box.
8. Click Finish. Veeam Backup Enterprise Manager will start the restore operation and display the status of
the restore process on the Items tab.
NOTE
This functionality is provided in the Enterprise and Enterprise Plus editions of Veeam Backup & Replication.
• Enterprise Manager supports restore over a network connection only. Restore using PowerShell Direct,
VIX or Sphere API is not supported.
• Enterprise Manager does not support database restore from storag e snapshots.
1. Go to the Job s tab and select your Oracle server backup job.
2. Click Job on the toolbar and select E d it to start the job wizard.
3. Proceed to the Guest Processing step of the wizard and make sure the E na ble application-aware
p rocessing check box is selected.
4. Click the Customize Application link. In the displayed window, select the Oracle server machine from the
list and click E d it.
5. On the General tab, make sure the Require successful processing option is selected in the Ap p lications
section.
6. To be able to specify transaction log handling options, make sure the P rocess transaction logs with this
job option is selected. Otherwise, if you select the P erform copy only option, Veeam Backup & Replication
will create a copy-only backup, and Oracle archived logs will not be deleted — that is why the Ora cle tab
with log handling settings will be deactivated in this case. For more information, see the Oracle Archived
Log Settings section of the Veeam Backup & Replication User Guide.
IMP ORTANT
If both Microsoft SQL Server and Oracle are installed on one machine, and this machine is processed
by a job with log backup enabled for both applications, Veeam Backup & Replication will back up
only Oracle transaction logs. Microsoft SQL Server transaction logs will not be processed.
a. Specify a user account that will connect to Oracle system and perform Oracle archived logs backup
and\or deletion. You can select Use guest credentials — then Veeam will use the account specified for
guest processing in the job configuration for both guest OS access and for connection to the Oracle
system. You can also specify another account. To do this, select the necessary account from the drop -
down list or click Ad d and add a new account. In any case, make sure the account you specify has
sufficient rights. For details, see the Required Permissions section of the Veeam Explorer for Oracle
guide.
b. Specify whether archived logs should be deleted on the Oracle server machine, and whether Veeam
should back them up them to repository. Veeam Backup & Replication supports the following options:
▪ Do not d elete archived logs — this option instructs Veeam to preserve archived redo logs (if any)
on the original Oracle server. With this option selected, your database administrator will have to
take care of database logs. Applicable restore scenario — database restore to the state as of the
currently selected machine restore point, to the selected point in time and to the selected
transaction.
▪ Delete logs older than <N> hours / Delete logs over < N> GB — with this option selected, Veeam
will wait for the image-level machine backup to complete, and then it will trigger archived log
deletion from guest, using the specified condition (log age or size). If archived logs cannot be
deleted for some reason, these logs will remain untouched in the guest machine until the next
start of the Veeam runtime process.
▪ With any of these options, you can also use the Ba ckup logs every <N> minutes check box. If you
select this check box, Veeam Backup & Replication will periodically ship archived logs to the
backup repository and store them next to the Oracle server machine backup. Make sure that
Oracle ARCHIVELOG mode is turned on (contact your database administrator, if necessary). This
option will support any database restore scenario: to the state as of in currently selected
machine restore point, to any point in time or to the state before particular transaction.
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, not vice versa. Thus, you need to set up backup schedule and log removal conditions
appropriately. Default log backup interval is 15 minutes, maximum interval is 480 minutes.
8. If you selected to back up archived logs, specify how long they should be kept using the Retain log
b a ckups options.
Select the Until the corresponding image-level backup is deleted option, so that you do not have to
manually check and ensure that your database and log backup retention policies are consistent, providing
all the machine restore points and log backups required for database restore.
10. At the Job Schedule step of the wizard, make sure the schedule is enabled for the job. Otherwise, log
backup will not be activated.
To allow users with the Restore Operator or P ortal User role to restore Oracle databases:
1. In the Ad d Role / Edit Role window, select the Da tabases check box.
3. [Optional] If necessary, select the Deny in-place database restores check box.
4. Click OK.
The Items tab will become available to these users after they log in to Enterprise Manager.
For more details on role assignment, see Configuring Accounts and Roles.
1. Sign in to Veeam Backup Enterprise Manager using an account with the sufficient permissions. For more
information, see Providing Access Rights.
3. Enter the name of Oracle server hosting the database you need to restore. Alternatively, click the P ick
from List link to select from the list of available Oracle server machine backups.
4. 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.
NOTE
The security role specified for this account in Enterprise Manager must allow the user to restore
Oracle databases. For more information, see Providing Access Rights.
5. Perform restore following the required scenario. For information on the possible restore scenarios, see
Scenario 1: 1-Click Restore to Original Location and Scenario 2: Restore with Custom Settings.
When performing database restore to the original location, a temporary iSCSI connection is established between
the target Oracle server (it acts as an iSCSI initiator) and mount server associated with the backup repository (it
acts as an iSCSI target). For that, Veeam opens a TCP port from the port range 3260 -3270; it closes this port
after restore session is over.
1. To specify a restore point from which to restore the database, in the Restore p oint field, click the calendar
icon and select the necessary date when backup was performed and a restore point created on that date.
2. If you have backed up archived redo logs for the database, you can also select the necessary point in time
using the P oint in time slider. The slider displays the following timestamps (relative to the currently
selected Oracle database restore point):
o Beginning — refers to the previous restore point of Oracle server machine that contains selected
database backup. If the previous restore point (server backup) was not found, or the database backup
does not exist in it, then Beginning will refer to current restore point.
o End — refers to the next restore point that contains selected database backup. If the next restore
point (server backup) and associated transaction log backup are not found, or if the database backup
does not exist in the server backup, then End will refer to the current restore point. If the next restore
point (server backup) is not found but transaction log backup exists for the preceding period, then
End will refer to the latest log backup time.
NOTE
For more information on log backup, see Preparing and Application-Consistent Backup.
3. To specify a location where you want to restore the database items, select the necessary option in the
Restore to section:
o If you want to restore items to the original database, select Original location. If you select this option,
consider that Enterprise Manager will select user credentials for the restore procedure according to
the following rules:
i. Veeam Backup Enterprise Manager will try to use the account specified in the backup job that
contains the Oracle server machine or the account which is currently logged in.
NOTE
The security role specified for this account in Enterprise Manager must allow the user to restore
Oracle databases. For more information, see Providing Access Rights.
o If you want to restore items to another database, select Alternative location. If you select this option,
you will need to specify restore settings using the Ora cle Restore wizard. For details, see Using Oracle
Restore Wizard.
4. Click Restore.
o In case of restore to the original location, the restore process will start immediately.
o In case of restore to another location, Enterprise Manager will launch the Ora cle Restore wizard. For
more information, see Using Oracle Restore Wizard.
1. At the Ta rget Server step of the wizard, specify settings to connect to the server where the database
should be restored:
o For database restore on a Microsoft Windows server, specify connection settings in the following way:
i. In the DNS name or IP address field, enter a DNS name or IP address of the target Microsoft
Windows server.
o For database restore on a Linux server, specify connection settings in the following way:
i. Server name (or IP address) and SSH port — default port is 22.
ii. Account to be used to access the server. This should be a root account or account elevated to
root and added to the sudoers file. To elevate the account and add it to the sudoers file, click
Settings and select the corresponding options.
You can use authentication by a user name and password or by a private key.
Consider that if database with the specified Oracle SID exists on the target Oracle home, the restore
process by design will delete it and replace with the database from backup. Thus, before starting the
restore process, a message will be displayed, asking you to confirm the operation.
5. At the Da tabase Files step of the wizard, specify paths to database files on the target server.
6. Click Finish. Veeam Backup Enterprise Manager will start the restore operation and display the status of
the restore process on the Items tab.
For encryption, Veeam Backup Enterprise Manager uses an Enterprise Manager keyset — a pair of matching keys:
• Public Enterprise Manager key encrypts storage keys on backup servers connected to Veeam Backup
Enterprise Manager.
• Private Enterprise Manager key decrypts storage keys in case a password for encrypted backup or tape is
lost.
To let Veeam Backup & Replication encrypt and decrypt data with Enterprise Manager keys, make sure
Enterprise Manager keys are enabled in Veeam Backup Enterprise Manager.
1. In Veeam Backup Enterprise Manager, open the Settings section of the Configuration view.
2. On the Key Management tab, select the E nable encryption password loss protection check box.
During Veeam Backup Enterprise Manager installation, the setup automatically generates an Enterprise Manager
keyset. You can perform the following operations with Enterprise Manager keysets using Enterprise Manager:
Enterprise Manager keys are created in the inactive state. To make the keys active and use them for encryption
and decryption, you need to activate the keys.
1. In Veeam Backup Enterprise Manager, open the Settings section of the Configuration view.
2. On the Key Management tab, in the Ma naged keys section, click Generate.
3. In the Hint field, enter a description for the created keyset. The keyset description will help you to
distinguish the created keyset in the list. Click the Generate button when ready.
• Public Enterprise Manager key is propagated to all Veeam backup servers connected to Veeam Backup
Enterprise Manager.
• Private Enterprise Manager key remains on Veeam Backup Enterprise Manager and marke d as active.
1. In Veeam Backup Enterprise Manager, open the Settings section of the Configuration view.
2. On the Key Management tab, in the Ma naged keys section, select an inactive keyset in the list and click
Activate.
Note that manual activation can be performed for any keyset in the list (generated manually or automatically).
If you want your automatically generated keysets to be activated automatically upon 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 Ma naged keys section, select the necessary options:
o If you want to set a retention period for Enterprise Manager keysets, select the Key retention period
check box and specify the number of weeks for which Enterprise Manager keys must remain in effect
(default is 4 weeks). After the retention period is over, and with key auto-generation is turned off, a
user will receive a notification email and should then manually create and activate a new keyset. After
a new keyset is ready, old keyset is marked as inactive.
o If you want Veeam Backup Enterprise Manager to automatically generate a new keyset, select the
Auto-generate new keys check box. After the current keyset expires, Veeam Backup Enterprise
Manager will automatically generate a new keyset and mark it as active. During the next data
synchronization session, Veeam Backup Enterprise Manager will propagate the newly created public
Enterprise Manager key to all connected Veeam backup servers. The private Enterprise Manager key
will remain on Veeam Backup Enterprise Manager and will be used for data decryption.
However, in some situations, a matching private Enterprise Manager key may be not available. This can happen,
for example, if your Veeam Backup Enterprise Manager database has failed or you use a new installation of
Veeam Backup Enterprise Manager and a new database. In this case, Veeam Backup Enterprise Manager will not
find a matching private Enterprise Manager key in the database and will be unable to unlock the backup or tape
encrypted with the public Enterprise Manager key.
You can create a backup copy of an Enterprise Manager keyset with the export operation in Veeam Backup
Enterprise Manager. The exported keyset is saved as a file of the PEM format and contains private and public
Enterprise Manager keys. You can save the exported keyset on the local disk or on a network share. An exported
keyset can be imported back to Veeam Backup Enterprise Manager any time you need.
To export a keyset:
1. In Veeam Backup Enterprise Manager, open the Settings section of the Configuration view.
2. On the Key Management tab, in the Ma naged keys section, select a keyset you want to back up and click
E x port.
3. Save the resulting PEM file on the local disk or in a network shared folder.
1. In Veeam Backup Enterprise Manager, open the Settings section of the Configuration view.
2. On the Key Management tab, in the Ma naged keys section, click Imp ort.
3. Click Browse next to the File field and select a previously exported keyset.
4. In the Hint field, Veeam Backup Enterprise Manager displays a hint that you provided when creating the
imported keyset.
When you import a keyset, it is saved to the Veeam Backup Enterprise Manager database and displayed in the
keyset list in Veeam Backup Enterprise Manager.
An imported keyset has the Inactive state. You must activate it to be able to use the keys from the keyset
for backup encryption (for restore procedures, activation is not necessary). For more information, see
Activating Enterprise Manager Keyset.
Only keys in the Ina ctive state can be deleted. You cannot delete keys that are currently active.
To delete a keyset:
1. In Veeam Backup Enterprise Manager, open the Settings section of the Configuration view.
2. On the Key Management tab, in the Ma naged keys section, select the necessary keyset in the list and click
Delete Key.
IMP ORTANT
It is strongly recommended that you export a keyset before you delete it. If you delete a keyset and do not
make its backup copy, you will not be able to restore data from a backup or tape encrypted with keys from
this keyset in case a password is lost. For more information, see Exporting and Importing Enterprise
Manager Keyset.
1. As a Veeam Backup Enterprise Manager Administrator, you receive a request for password restore, for
example, by email.
2. Then you start the P a ssword Recovery wizard by clicking the P a ssword Recovery button in Configuration >
Key Management, and insert the text of the request to the wizard.
3. Veeam Backup Enterprise Manager finds a matching public backup server key in Veeam Backup Enterprise
Manager database and decrypts the signature with this key.
4. The wizard decrypts storage keys with the private Enterprise Manager key available on Veeam Backup
Enterprise Manager, and generates a response. The response represents a text document and contains
decrypted storage keys. Consider that the response is also encrypted and can be used only on the 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 res tore, 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 La b Request step of the wizard, specify a name or IP address of the VM you need and other request
settings.
By default, lab usage duration is 30 minutes. If necessary, change this value. Optionally, specify a
description for your request.
6. At the Restore P oint 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
a vailable restore points check box.
By default, the list of jobs displays only those jobs that contain the selected machine. If you want to
display all SureBackup jobs that were created, select the Show a ll available SureBackup jobs check box.
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.
IMP ORTANT
To work with lab requests, the user must have the Portal Administrator role assigned in Veeam Backup
Enterprise Manager. For more information, see Configuring Accounts and Roles.
To approve a lab request, select it in the list and click Ap p rove. Then follow the E d it Lab Request wizard steps:
1. At the La b Request step of the wizard, you can review and, if necessary, edit the virtual lab request (for
example, change the time interval for which the lab should be up). To edit virtual lab request data, click
the E d it request link at the bottom.
2. At the Ba ckup step of the wizard, select a backup from which you want to restore items. Enterprise
Manager scans all Veeam backup servers connected to it, searches for all backups with the machine
specified at the previous step of the wizard, and displays these backups in the list.
3. At the Restore P oint step of the wizard, select the restore point when the application was in the desired
state. The list of restore points is formed depending on the choice the user made when submitting the
virtual lab request. For example, if the user selected the La st Friday night backup option when creating
the request, Enterprise Manager will display restore p oints created on the last Friday night, and a number
of restore points closest to the matching point. If you want to display all restore points that are available
for the selected backup, select the Show all available restore points check box.
4. At the SureBackup Job step of the wizard, select one of existing SureBackup jobs that you want to run to
create an isolated sandbox in which the selected machine should be started. The application group and
virtual lab used by this SureBackup job will be displayed in the Selected Job details section.
By default, the list of jobs displays only those jobs that contain the selected machine. If you want to
display all SureBackup jobs that were created, select the Show a ll available SureBackup jobs check box.
5. At the Summary step of the wizard, review the settings you have configured for the virtual lab and click
Finish. Veeam Backup & Replication will perform verification of the selected restore point.
If the specified SureBackup job is already running, Veeam Backup Enterprise Manager will check the 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 Sta rt job to from the shortcut
menu.
If the SureBackup job is not running, Enterprise Manager will launch the selected SureBackup job, start the
virtual lab and run the machine with the necessary application to the restore point selected.
• Replicate vApps and other containers and fail over to their replicas
vCD 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 vCD
organization configurations, including repository quota and backup job template. These administrators
typically have access to Veeam Backup & Replication console that controls vCD as part of backup
infrastructure on the provider side.
• Members of vCD 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 vCD jobs, as
well as restore VMs, files and application items within their scope.
How It Works
Veeam Backup Enterprise Manager uses native vCD authentication to authorize users that log in to Enterprise
Manager. The authentication process and components interactions are shown in the figure below.
This approach helps to streamline administration and management tasks for service providers, as now they need
to configure a tenant account only once in vCD, 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 (vCD 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.
• 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 vCD 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.
Before you manage vCD organization configurations, check the following prerequisites:
2. All vCD servers must be added to the backup infrastructure of the same backup server.
For more information, see the Adding VMware vCloud Director section of the Veeam Backup & Replication
User Guide.
NOTE
Multiple vCD servers are supported starting from Veeam Backup Enterprise Manager 11a (build
11.0.1.1261 or later).
3. The backup server that contains the vCD servers in its 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 Managing Backup Servers.
4. Enterprise Manager must complete data collection from the added backup server.
5. The account that you will use to manage vCD organization configurations must be assigned the Portal
Administrator role.
Members of vCD organizations can access Veeam Self-Service Backup Portal by the following portal URLs:
• Full URL that contains the host address where the necessary vCD server resides:
https://<EnterpriseManagerServer>:9443/vcloud/<vCDServer>/<OrgName>
In this case, Veeam Self-Service Backup Portal will open right after clicking the Sig n in button.
https://<EnterpriseManagerServer>:9443/vcloud/<OrgName>
In this case, after clicking the Sig n in button, Veeam Self-Service Backup Portal will prompt to select a vCD
host from the list of available vCD hosts.
If you do not want vCD organization members to see addresses of all vCD hosts added to the Enterprise
Manager infrastructure, add each vCD server to a separate Enterprise Manager infrastructure.
Veeam Backup Enterprise Manager offers a default configuration that you can use for vCD organizations. The
configuration is applied to each vCD organization that does not have a specific configuration added for it.
Initially the default configuration is not active. To enable it, select a repository for the configuration.
• Quota — 1 TB
• Job scheduling — Allow: Tenant has full access to all job scheduling
6. From the vCloud Director server drop-down list, select a vCD server you need.
The field is available if you have multiple vCD 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 vCD server processed by the backup server that is added to Enterprise Manager.
8. From the Rep ository drop-down list, select a repository that will be used for backups. The list includes
repositories configured on the backup server that has the vCD server added to its infrastructure.
IMP ORTANT
You cannot assign cloud-based repositories, as well as NetApp or Nimble storage systems storing
snapshots created by snapshot-only jobs.
9. In the Friendly name field, specify a repository name that will be displayed to organization members.
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 b ackup window
For backup jobs of vCD 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 vCD organization:
b. From the Cop y from drop-down list, select backup job settings:
▪ Default job settings — default vCD backup job settings as they are shown in the Veeam backup
console
▪ <Job Name> — specific vCD backup job configured in Veeam backup console
IMP ORTANT
The backup repository that is selected from the Rep ository drop-down list for the organization takes
priority over the repository used by the selected job template.
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 vCD backup job to be configured on the
backup server.
• When you change a job template for a vCD organization, the new configuration will be applied only to t he
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:
b. Modify the backup job that is used as a template, and vCD 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.
5. On the vCloud tab, select the default organization configuration and click E d it.
6. From the Rep ository drop-down list, select Disable self-service backup for other organizations .
The following organization members have access to Veeam Self-Service Backup Portal:
• vCD organization members with the following rights granted in VMware vCloud Director:
• Any vCD organization members whose roles (or associated LDAP user roles) are defined in registry keys
and with the Group / User: View right granted in VMware vCloud Director. For more information, contact
Veeam Customer Support.
NOTE
vCD system administrators cannot access Veeam Self-Service Backup Portal since they are not vCD
organization members.
• Access by URL
1. Open your web browser and enter the following URL in the address bar:
https://<EnterpriseManagerServer>:9443/vcloud/<vCDServer>/<OrgName>
where:
o <vCDServer> is a host name or IP address of the host where the vCD server resides.
This URL part is optional. If you do not specify a vCD host here, you may be asked to select the host
when you log in to the portal.
For example:
https://vbr-em:9443/vcloud/172.17.53.16/TechCompanyOrg
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 P a ssword fields, specify credentials of a vCD account with proper rights.
4. To save the entered credentials for future access, select the Remember me check box.
6. From the list of hosts with vCD servers, select the one where your organization has been created.
The list of hosts is displayed if multiple vCD servers are added to the Enterprise Manager infrastructure.
Before members of vCD organizations can access Veeam Self-Service Backup Portal from the vCD UI, the vCD
system administrator must upload and configure Veeam Plug -in for VMware vCloud Director. For more
information, see Uploading and Configuring Veeam Plug-in for VMware vCloud Director.
1. Log in to vCloud Director Tenant Portal under a vCD account with proper rights.
If you have a connection error when accessing Veeam Plug -in for VMware vCloud Director, add the Veeam
Backup Enterprise Manager certificate as trusted to your browser.
You can upload and configure Veeam Plug-in for VMware vCloud Director on vCloud Director Service Provider
Admin Portal using a vCD system administrator account. When you upload the plug -in, you specify the scope — a
set of vCD organizations that can use the plug-in.
If you need to modify the scope of vCD organizations after you configure the plug -in, update the plug-in
configuration. For more information, see Updating Plug-in Configuration
• Veeam Plug-in for VMware vCloud Director requires Veeam Backup & Replication 11 or later to be installed
on the backup server that has the vCD server in its infrastructure.
• Users of the plug-in must have access to the Veeam Backup Enterprise Manager and vCloud Director URLs.
• 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 Security Certificate.
1. Log in to vCloud Director Service Provider Admin Portal under a vCD system administrator account.
For more information, see the Upload a Plug-in section of VMware vCloud Director documentation.
If the Da ta Protection with Veeam option is not available, log out from the vCloud Director Service
Provider Admin Portal and log in again.
4. In the P lug-in Configuration section, specify the URL to the Veeam Backup Enterprise Manager website
and click Sa ve.
NOTE
When you save the plug-in configuration, it is applied to all vCD organizations. For that, a separate
operation is performed for each organization. If you have operation limits that are set through the
vCloud Director API, the operations may fail with HTTP status 400.
In this case, use the vCloud 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 vCloud Director API
documentation.
5. 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 vCloud Director Service Provider Admin Portal under a vCD system administrator account.
For more information, see the Publish or Unpublish a Plug-in from an Organization section of VMware
vCloud Director documentation.
4. In the P lug-in Configuration section, click Sa ve to apply the changes to all vCD 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 La st 24 hours / La st 7 days widget reports on the job session results for the selected period.
To visualize on-going jobs data, the Da shboard tab also comprises a chart showing date and time when jobs
were performed, and the network throughput rate during the job.
NOTE
The dashboard displays only vCD backup jobs of the current vCD organization.
• Edit a job
3. At the Job Settings step, specify a job name, repository, job description and retention policy.
For more information, see Edit Job Name and Retention Settings.
NOTE
You can select a repository only if more than one configuration is added for the organization. For
more information, see Adding Organization Configuration.
For more information, see Edit List of Virtual Machines and Change VM Processing Order.
5. At the Guest Processing step, you can configure transactionally consistent backup, transaction log
handling settings, and enable guest file system indexing.
vCD system administrators can access guest OS credentials available for their organizations. They can
also supply new credentials for guest OS processing.
6. At the Job Schedule step, you can specify job scheduling options.
For more information, see the Notification Settings section of the Veeam Backup & Replication User Guide.
Remaining settings are obtained from the job configuration specified for the organization. For more
information, see Adding Organization Configuration.
The jobs you create are shown in Veeam Backup & Replication console under the Job s node and in Veeam
Backup Enterprise Manager on the Job s tab. The jobs have the <vCloud Director_org_name> prefix.
NOTE
Organization members cannot see the jobs with VMs from their vCD 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.
To delete a job, select it on the Job s tab and then on the toolbar click Job > Delete. After deletion, this job will
be removed and no longer appear in the web portal, Veeam Backup & Replication console and in Veeam Backup
Enterprise Manager.
• The following limitations apply to scenario involving VM backup and subsequent restore using Veeam
Self-Service Backup Portal:
a. You create a backup job that will process a VM added explicitly (that is, not as a part of a vApp
container).
c. Then you restore this VM to the original location by using the portal.
After restore, the VM identifier changes in vCD hierarchy. Due to this reason, the backup job cannot
locate this VM any longer. So, you need to edit job settings, adding this VM anew. To ensure that job
configuration will store this VM with the new metadata (not the old one from vCD hierarchy cache),
you should first click Reload in the Ad d Objects window.
d. At the next job run, a new full backup will be created for this VM. However, if you try to perform file -
level restore with the portal from the restore points created initially for that VM (on step 2), the
restore operation will fail, as that VM identifier does not exist any longer.
• Restore VMs
• Restore vApps
• Restore VM disks
To restore a VM:
1. On the VMs tab, select the necessary VM backup in the list of VMs. To quickly find the necessary VM, use
the search field at the top of the window.
o Select Overwrite to restore the VM from the backup to the original vApp, replacing the production
VM.
In this case, the restored VM hard disks are assigned the storage policies of the original VM hard disks.
o Select Keep to keep both VMs in the original vApp. The VM from the backup will be located next to
the original production VM and will have the same name with the _restored suffix.
In this case, the restored VM hard disks are assigned the storage policy of the VM.
3. Select the restore point that will be used to restore the VM.
4. [Optional] Instead of restoring an entire machine from a backup file, you can instruct Enterprise Manager
to recover only those data blocks that are necessary to revert the machine 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.
For more information on quick rollback, see the Quick Rollback section of the Veeam Backup & Replication
User Guide.
5. [Optional] To start a machine immediately after recovery, select the P ower on machine after restoring
check box.
6. Click Finish.
IMP ORTANT
Restore of a standalone VM to the original location with the Keep option selected results in an
unpredictable behavior and possible failure of the restore job.
Restoring vApps
You can restore a vApp to the original vDC.
To restore a vApp:
1. On the VMs tab, select a vApp. To quickly find the necessary vApp, use the sea rch 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.
4. [Optional] To start VMs in the restored vApp immediately after recovery, select P ower on VM after
restoring.
5. Click Finish.
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 Performing 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 Backups.
To delete a VM:
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 an FLR helper appliance is
configured on the backup server. For more information, see Preparing for File Search and Restore
(non-Windows machines).
To restore application items, open the Items tab and follow the steps described in the Restore Procedure for
SQL Server databases and Restore Procedure for Oracle databases.
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, 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 Web Client.
Before installing the vSphere Web Client plug-in, make sure the following requirements are met:
• The plug-in supports vSphere Web Client v5.1.0 build 880146 and later. For vSphere Web Client versions
5.1.0 build 880146 – 6.5 (including), the plug-in is available with the flex/flash interface. Starting with
vSphere Web Client version 6.7, the plug-in offers HTML 5 user interface. The older versions of the client
do not support the HTML 5 interface.
• Single Sign-On Service must be running on a server with FQDN (to be accessible from Enterprise Manager
server over HTTPS).
• 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):
For more information on vSphere Web Client, see this VMware article.
2. Select the vCenter server you need, and click Check version.
3. In the W eb Client Plug-in window, enter a user name and password to connect to vCenter Server, and
specify connection port (default is 443). Veeam Backup Enterprise Manag er will use these credentials to
access vCenter Server and check if Veeam plug-in has been already installed there. If discovered, plug -in
version will be displayed in the P lug-in Version column.
4. 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.
1. A user logs in to vSphere Web Client. To work with a VMware vCenter server where Veeam plug -in runs,
this user account requires the following minimal privileges on 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, to perform the necessary backup operation (VeeamZIP or Quick Backup) it
should have sufficient security permissions. They are granted by assigning a security role — Portal
Administrator or Portal User. For more information, see Configuring Accounts and Roles.
To configure a connection to the Veeam Backup Enterprise Manager server and (optionally) Veeam ONE server:
2. On the Settings tab, check the plug-in version and specify the following Veeam Backup Enterprise
Manager connection properties:
o Thumbprint of the certificate used to connect to Veeam Backup Enterprise Manager REST API
TIP
You can get the connection properties on the Veeam Backup Enterprise Manager website. To do this,
log in to the website with a Portal Administrator account and go to Configuration > Ab out. For more
information, see Viewing Information About Enterprise Manager.
3. If you plan to connect to Enterprise Manager using a specific account, select the P a ssword based
a uthentication option and provide a user name and password. If this option is not selected, connection to
Enterprise Manager will be performed using the account currently logged in.
Make sure the account intended for connection has an appropriate Enterprise Manager role assigned.
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 P rotected VMs report that
provides a list of VMs which are protected by Veeam Backup & Replication, and which are not.
• In the Job s statistics widget, all running jobs are displayed, as well as scheduled jobs and max job
duration. Additionally, if Veeam ONE is installed, you can click the link and examine the La test BU Job
Sta tistics report.
• The P rocessed VMs widget shows a graphical representation of how the jobs ran (1-week, 2-weeks, 1-
month filters can be applied).
4. In the Destination section, select the Veeam backup server to process the VM and the repository where to
store the VeeamZIP file.
NOTE
To be visible in this list, Veeam backup server should be added to Veeam Backup Enterprise Manager.
Connected repositories from Veeam backup infrastructure will be shown automatically.
6. In the Delete this backup automatically section, specify whether the resulting backup file should be
automatically deleted after a certain time interval.
7. In the Compression level section, select the necessary compression level for the backup.
8. By default, the Disable guest quiescence option is selected, meaning that guest OS quiescence is
deactivated. So, if you want a crash-consistent backup, leave it that way.
If you want, however, an application-consistent backup, then clear the Disable guest quiescence check
box, and Veeam will create a transactionally consistent image of VMs using VMware Tools quiescence for
guest OS.
NOTE
For more information about guest OS quiescence, see the Transaction Consistency section of the Veeam
Backup & Replication User Guide.
o Select Ba ckup > VeeamZIP if you want to create a backup using the default VeeamZIP settings
specified earlier. Alternatively, use the Actions > Ba ckup > VeeamZIP option.
Veeam will start the VeeamZIP backup process using the default VeeamZIP settings.
o Select Ba ckup > VeeamZIP to if you want to create a backup with new VeeamZIP settings.
Alternatively, use the Actions > Ba ckup > VeeamZIP to option.
If you select this option, Veeam plug-in will display the VeeamZIP to window offering to specify
VeeamZIP settings. Specify settings in the same way as described in the Configuring VeeamZIP
Settings section and click VeeamZIP. Veeam will save the specified settings as default settings for
VeeamZIP backup and start the VeeamZIP backup process.
You can view the backup creation progress in the Recent Tasks pane of vSphere Web Client.
1. A backup job processing the VM exists on the Veeam backup server which is added to Veeam Backup
Enterprise Manager.
2. Right-click the VM and select Quick Backup. Alternatively, you can use the Actions menu command.
This will trigger a backup job processing the selected VM to create a new incremental restore point (VIB file) for
the latest full backup found in the repository for this VM. Details of a running quick backup task can be seen in
the Recent Tasks pane on the right.
To learn more about VeeamZIP and Quick Backup, refer to the Veeam Backup & Replication User Guide.
NOTE
A Quick Backup or 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.
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, administrators and tenants 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:
The default delegation mode allows tenants to access VMs with the VirtualMachine.Interact.Backup
privilege. The administrator can change the delegation mode, if necessary.
By default, Veeam Backup Enterprise Manager offers a group tenant account for use rs of the domain that
includes the Enterprise Manager server. Each user can access the portal and use a 30 GB quota on the
default backup repository to create VM backups. Users can create backup jobs with default advanced
settings and custom schedule. The administrator can edit settings of the default account and create other
accounts to configure granular access to storage quotas and backup settings.
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 vCloud 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 vSp here tab is opened. The
vCloud tab is used to work with VMware vCloud Director organizations and their configurations. For more
information, see Working with VMware vCloud 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.
The Self-service section is available if you have added to Enterprise Manager at least one Veeam backup
server with a vCenter server as part of its infrastructure.
4. If a vCloud Director server is added to your Veeam backup infrastructure, make sure that the vSp here tab
is selected.
o vSp here tags — to allow tenants to work with VMs to which the specified tags are assigned. If you
select this option, you must specify the necessary tags in the properties of the tenant account. You
can specify tags for each tenant account individually. For more information, see Adding Tenant
Account and Editing Tenant Account.
o vSp here role — to allow tenants to work with VMs that are available to the specified vSphere role.
Alternatively, if you have already selected a role before, click the name of the currently selected
role.
ii. In the Select Role window, select the required vSphere role.
o VM p rivilege — to allow tenants to work with VMs for which they have the specified vSphere privilege.
i. In the VM p rivilege 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.
The Self-service section is available if you have added to Enterprise Manager at least one Veeam backup
server with a vCenter server as part of its infrastructure.
4. If a vCloud Director server is added to your Veeam backup infrastructure, make sure that the vSp here tab
is selected.
5. Click Ad d .
6. From the Ty p e drop-down list, select a type of the account: User, Group , External User or External Group .
For more information, see Managing Tenant Accounts.
7. In the Account field, specify an account name in the DOMAIN\Username or Username@Suffix format
depending on the account type. For more information, see Managing Tenant Accounts.
You cannot create a vSphere Self-Service Backup Portal tenant account for a local user account.
8. From the Rep ository drop-down list, select a target repository that will contain VM backups created by
the tenant. The list includes repositories configured on Veeam backup servers added to Veeam Backup
Enterprise Manager.
Backup repository settings specified at this step will take priority over backup repository settings
prescribed by the selected job template.
NOTE
You cannot assign to tenants Veeam Cloud Connect repositories, as well as NetApp or Nimble
storage systems storing snapshots created by Veeam snapshot-only jobs.
9. In the Quota field, specify the repository storage quota for the tenant account. Choose GB or TB from the
drop-down list and enter the required quota size.
10. From the Job scheduling drop-down list, select how the job scheduling will be organized. The following
options are available:
o Deny: Creates daily jobs with randomized start time within the backup window
For tenant backup jobs, the backup window is defined by backup window settings specified in Veeam
Backup Enterprise Manager. Backup window settings specified for the job template that you will
select at the step 12 do not affect tenant jobs. For information on how to specify the backup window
in Enterprise Manager, see Customizing 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 vSp here tags field, specify
tags assigned to VMs that will be available to the tenant.
15. [Optional] Specify advanced settings for backup jobs of the tenant:
b. In the Ad vanced job settings section, view the currently used backup job settings.
c. From the Cop y from list, select the 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 Ap p ly.
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.
The Self-service section is available if you have added to Enterprise Manager at least one Veeam backup
server with a vCenter server as part of its infrastructure.
4. If a vCloud Director server is added to your Veeam backup infrastructure, make sure that the vSp here tab
is selected.
6. In the E d it window, edit tenant account settings as required. For more information, see Adding Tenant
Account.
NOTE
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.
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.
The Self-service section is available if you have added to Enterprise Manager at least one Veeam backup
server with a vCenter server as part of its infrastructure.
4. If a vCloud Director server is added to your Veeam backup infrastructure, make sure that the vSp here tab
is selected.
2. To open the Configuration view, click Configuration in the top right corner.
The Self-service section is available if you have added to Enterprise Manager at least one Veeam backup
server with a vCenter server as part of its infrastructure.
4. If a vCloud Director server is added to your Veeam backup infrastructure, make sure that the vSp here tab
is selected.
6. Click Remove.
o To delete backup jobs created by the tenant, select the Delete jobs check box.
o To delete all backups created by the tenant, select the Delete backup files check box.
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://vbr-em: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 P a ssword fields, specify credentials of the domain user for which the
Enterprise Manager administrator created a vSphere Self-Service Backup Portal tenant account.
The username must be provided in the DOMAIN\Username format.
ii. To save the entered credentials for future access, select the Rema in signed in option.
o To log in with single sign-on, click Use Single Sign-On ( SSO). You will be redirected to the login
webpage of the single sign-on service. Complete the sign-in procedure on the login page. If the
account is already authenticated in the single sign-on service, you will immediately access the
Enterprise Manager website.
NOTE
The Use Single Sign-On (SSO) option is available if SAML authentication is configured for Veeam
Backup Enterprise Manager. For more information, see Configuring SAML Authentication
Settings.
• View statistics on backups of vSphere VMs. For more information, see Viewing Self-Service Backup Portal
Statistics.
• Work with backup jobs that process vSphere VMs: create and edit backup jobs; examine and export backup
job session data; start, stop and retry backup jobs. For more information, see Managing Backup Jobs.
• Perform backup and restore operations with vSphere VMs. For more information, see Managing VMs.
• Search for files in guest file systems of backed-up VMs and restore the necessary files to the original
location or download them to a local machine. For more information, see Restoring Guest OS Files.
• Perform item-level restore of Microsoft SQL Server and Oracle databases. For more information, see
Restoring Application Items.
• VMs — number of VMs successfully processed during the selected period. At least one restore point was
created for these VMs.
• Temp lates — number of virtual machine templates successfully protected during the specified period.
• Sta tus — status of the backup storage assigned to the user: Green — more than 10% of storage space is
free; Yellow — less than 10% of storage space is free; Red — no free space on backup storage.
The La st 24 hours / La st 7 days block reports on job session results for the selected period.
To visualize on-going job data, the Da shboard tab also comprises a graph showing time and date when jobs were
performed, and the network throughput rate during the job.
1. Open the Job s 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.
You can configure backup job scheduling options only if the Enterprise Manager administrator allowed this
in the properties of the tenant account. For more information, see Adding Tenant Account.
6. At the E ma il Notifications step of the wizard, select the E na ble e-mail notifications check box and
configure notification settings:
b. [Optional] In the Sub ject field, specify the subject for notification emails.
c. Select the Notify on success, Notify on error and/or Notify on warning options to receive email
notification if the job completes successfully, fails or completes with a warning.
d. Select the Sup press notifications until the last retry check box to receive a notification about the final
job status. If you do not enable this option, Veeam Backup & Replication will send one notification per
every job retry.
7. Click Finish.
The backup job will create backups in the backup repository that the Enterprise Manager administrator selected
as the target repository in the properties of the tenant account. Advanced job settings such as the backup
settings and storage settings will be obtained from the job template assigned to the tenant by the
administrator. For more information, see Editing Tenant Account.
2. In the working area, select the job you want to edit and click E d it.
3. In the E d it window, edit backup job settings as required. You will follow the same steps as you have
followed when creating the job. For more information, see Creating Backup Job.
2. In the working area of the Job s tab, select the job you want to delete.
3. 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.
IMP ORTANT
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 P ower 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 P roceed 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.
Deleting VMs
You can delete a VM on vSp here Self-Service Backup Portal. This operation may be useful if you want to d elete
d a ta of the backed-up VM from the backup repository.
W hen 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 Y es 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 datab ase 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 an FLR helper appliance is
configured on the backup server. For more information, see Preparing for File Search and Restore
(non-Windows machines).
To restore application items, follow the steps described in the following sections:
• To restore Microsoft SQL Server databases, see Restore Procedure for SQL Server.
“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. 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.