Supported Versions
Veeam Enterprise Manager Version 11.0.1.1261

Introduction

Veeam® Backup & Replication™ is a comprehensive data protection and disaster recovery solution.

You can create image-level backups of virtual, physical, and cloud machines, and restore them. Technology used in the product optimizes data transfer and resource consumption, which helps minimize storage costs and recovery time in case of a disaster.

Veeam® Backup & Replication™ provides a centralized console for administering backup, restore and replication operations in all supported platforms (virtual, physical, and cloud). This console allows you to automate and schedule routine data protection operations to integrate with solutions for alerting and generating compliance reports.

Veeam

Key functionality of Veeam® Backup & Replication™:

  • Backup: Creating image-level backups of virtual, physical, cloud machines, and NAS share files.
  • Restore: Restore backup files to the original or a new location. Veeam® Backup & Replication™ offers a number of recovery options for various disaster recovery scenarios, including instant recovery, image level restore, file level restore, restore of application items and so on.
  • Replication: Creating an exact copy of a virtual machine and maintaining the copy in sync with the original virtual machine.
  • Continuous Data Protection (CDP): Replication technology that helps you protect mission-critical virtual machines and reach recovery point objective (RPO) up to seconds.
  • Backup Copy: Copying backup files to a secondary repository.
  • Storage Systems Support: Backing up and restoring virtual machines using capabilities of native snapshots created on storage systems.
  • Tape Device Support: Storing copies of backups in tape devices.
  • Recovery Verification: Testing virtual machine backups and replicas before recovery.

Introduction to Veeam Enterprise Manager Rest API’s

The Web Service API for Veeam Backup Enterprise Manager, which is built on the REST (Representational State Transfer) architecture, exposes its objects. Developers may interact with Veeam Backup Enterprise Manager utilizing the HTTPS protocol, REST principles, and the Veeam Backup Enterprise Manager REST API to query data about Veeam Backup Enterprise Manager objects and carry out simple activities with them.

See, REST API WorkFlow to know about accessing Veeam Enterprise Manager API’s.

Introduction to Veeam Service Provider Console Rest API’s

The Web Service API built on the REST (Representational State Transfer) architecture is used by Veeam Service Provider Console to expose its entities. The client-server architecture is utilized by the Veeam Service Provider Console REST API. The server receives a request from the client. With the help of the Veeam Service Provider Console REST API, developers may interact with Veeam Service Provider Console to make simple queries for information on Veeam Service Provider Console entities and carry out basic operations on them using HTTP requests and standard HTTP methods.

See, Service Provider Console Rest API to know about accessing Veeam Service Provider Console Rest API’s.

Key Use Cases

Discovery Use Cases

  • Provides resource visibility to the administrator to view and manage resources available (Ex: Enterprise Manager, Backup Server, Jobs and Repositories) under the resource type Server.
  • Publishes relationships between resources to have a topological view and ease of maintenance.

Monitoring Use Cases

  • Provides metrics related to job scheduling time and status etc..
  • Concern alerts will be generated for each metric to notify the administrator regarding the issue with the resource

Resource Hierarchy

OpsRamp supports both Enterprise Manager REST API and Service Provider Console REST API’s. The Resource Hierarchy is different for both the API’s.

The following is the Resource Hierarchy while using Veeam® Enterprise Manager REST API’s

Veeam Enterprise Manager

      → Veeam Backup Server

               → Veeam Jobs

               → Veeam Repositories

The following is the Resource Hierarchy while using Veeam® Service Provider Console REST API’s

Veeam ServiceProvider Console

      → Veeam Enterprise Manager
      → Veeam Backup Server
      → Veeam Jobs
      → Veeam Repositories
      → Veeam BackupProxy

Pre-requisites

  • OpsRamp Classic Gateway 13.0.1 and above.
  • To access Veeam Enterprise Manager API the user should have Portal Administrator access.

Default Monitoring Configurations

Veeam application has default Global Device Management Policies, Global Templates, Global Monitors, and Global metrics in OpsRamp. You can customize these default monitoring configurations as per your business use cases by cloning respective global templates and Global Device Management Policies. OpsRamp recommends performing the below activity before installing the application to avoid noise alerts and data.

  1. Default Global Device Management Policies

    OpsRamp has a Global Device Management Policy for each Native Type of Veeam. You can find these Device Management Policies by navigating to Setup -> Resources -> Device Management Policies, search with suggested names in global scope. Each Device Management Policy follows below naming convention:

    {appName nativeType - version}

    Ex: netapp-ontap NetApp Cluster - 1 (i.e, appName = veeam, nativeType = Veeam Enterprise Manager, version = 1)

  2. Default Global Templates

    OpsRamp has a Global Template for each Native Type of Veeam. You can find those templates by navigating to Setup -> Monitoring -> Templates, search with suggested names in global scope. Each template follows below naming convention:

    {appName nativeType 'Template' - version}

    Ex: veeam Veeam Enterprise Manager Template - 1 (i.e, appName = veeam, nativeType = Veeam Enterprise Manager, version = 1)

  3. Default Global Monitors

    OpsRamp has a Global Monitors for each Native Type which has monitoring support. You can find these monitors by navigating to Setup -> Monitoring -> Monitors, search with suggested names in global scope. Each Monitors follows below naming convention:

    {monitorKey appName nativeType - version}

    Ex: Veeam Enterprise Manager Monitor veeam Veeam Enterprise Manager 1 (i.e, monitorKey = Veeam Enterprise Manager Monitor, appName = veeam, nativeType = Veeam Enterprise Manager version = 1)

Configuration and installation

  1. From All Clients, select a client.
  2. Go to Setup > Integrations and Apps > Integrations.
  3. Click Manage Apps.
    Notes:
    • If there are already installed applications, it will redirect to the INSTALLED APPS page where all the installed applications are displayed.
    • If there are no installed applications, it will navigate to the ADD APP page.
Veeam
  1. Click + ADD on the INSTALLED APP page. The ADD APP page displays all the available applications along with the newly created application with the version. Note: You can even search for the application using the search option available. Also you can use the All Categories option to search.
Veeam
  1. Click ADD in the Veeam application.
    Note: Select the version from the drop down menu.
  2. In the Configurations page, click + ADD. The Add Configuration page appears.
  3. Enter the below mentioned BASIC INFORMATION:
FuntionalityDescription
NameEnter the name for the configuration.
Veeam Service Provider Console (Or) Veeam Enterprise Manager IpAddress/HostNameVeeam Service provider console or Enterprise manager ip address or host name.
PortPort

Note: By default EnterpriseManager Port: 9398 / Service Provider Console Port: 1280 is displayed.
Veeam CredentialsSelect the credentials from the drop-down list.
Note: Click + Add to create a credential.

Notes:

  • Veeam Service Provider Console: if turned on, you can provide the Veeam Service Provider Console Access Token.
  • By default the Is Secure checkbox is selected.
  • App Failure Notifications: if turned on, you will be notified in case of an application failure that is, Connectivity Exception, Authentication Exception.
  1. Select the below mentioned Custom Attribute:
FunctionalityDescription
Custom AttributeSelect the custom attribute from the drop down list box.
ValueSelect the value from the drop down list box.

Note: The custom attribute that you add here will be assigned to all the resources that are created by the integration. You can add a maximum of five custom attributes (key and value pair).

  1. In the RESOURCE TYPE section, select:

    • ALL: All the existing and future resources will be discovered.
    • SELECT: You can select one or multiple resources to be discovered.
  2. In the DISCOVERY SCHEDULE section, select Recurrence Pattern to add one of the following patterns:

    • Minutes
    • Hourly
    • Daily
    • Weekly
    • Monthly
  3. Click ADD.

Veeam
  1. Now the configuration is saved and displayed on the configurations page after you save it. Note: From the same page, you may Edit and Remove the created configuration.

  2. Click NEXT

  3. In the Installation page, select an existing registered gateway profile, and click FINISH.

Veeam

The application is now installed and displayed on the Installed Integration page. Use the search field to find the installed application.

Modify the Configuration

View the Veeam details

The discovered resource(s) are displayed in Infrastructure > Resources > Server, with Native Resource Type as Veeam Job. You can navigate to the Attributes tab to view the discovery details, and Metrics tab to view the metric details for Veeam.

Veeam

View resource metrics

To confirm Veeam backup, review the following:

  • Metric graphs: A graph is plotted for each metric that is enabled in the configuration.
  • Alerts: Alerts are generated for metrics that are configured as defined for integration.
Veeam

Resource Filter Input keys

Resource TypeResource Type
All TypesresourceName
hostName
aliasName
dnsName
ipAddress
macAddress
os
make
model
serialNumber
Resource TypeVeeam Service Provider ConsoleVeeam Enterprise Manager
Veeam Enterprise Manager
Veeam Backup ServerBackupServer Role TypePort
Description
Veeam JobDestination Repository NameDescription
BackupServerPlatform
JobTypeJobType
VMware Or Nutanix VMs
Cloud VMs
Agent VMs
Veeam RepositoryRepositoryTypeRepositoryType
Repository PathDescription
Veeam BackupProxyBackupProxy Type

Note: The above keys can be used in alert description while cloning the dmp.

Supported Metrics through Veeam Enterprise Manager

Metric NameDisplay NameDescriptionUnitsDefault Metrics
veeam_enterprisemanager_BackupServersCountBackup Servers CountBackup Servers CountcountNo
veeam_enterprisemanager_ProxyServersCountProxy Servers CountProxy Servers CountcountNo
veeam_enterprisemanager_RepositoryServersCountRepository Servers CountRepository Servers CountcountNo
veeam_enterprisemanager_RunningJobsCountRunning Jobs CountRunning Jobs CountcountNo
veeam_enterprisemanager_ScheduledJobsCountScheduled Jobs CountScheduled Jobs CountcountNo
veeam_enterprisemanager_ScheduledBackupJobsCountScheduled Backup Jobs CountScheduled Backup Jobs CountcountNo
veeam_enterprisemanager_ScheduledReplicaJobsCountScheduled Replica Jobs CountScheduled Replica Jobs CountcountNo
veeam_enterprisemanager_TotalJobRunsTotal Job RunsTotal Job Runs in last 24 hourscountYes
veeam_enterprisemanager_SuccessfulJobRunsSuccessful Job RunsSuccessful job runs in last 24 hourscountNo
veeam_enterprisemanager_WarningsJobRunsWarnings Job RunsWarnings job runs in last 24 hourscountNo
veeam_enterprisemanager_FailedJobRunsFailed Job RunsFailed job runs in last 24 hourscountYes
veeam_enterprisemanager_MaxJobDurationMax Job DurationMax job durationsYes
veeam_enterprisemanager_MaxBackupJobDurationMax Backup Job DurationMax backup job durationsNo
veeam_enterprisemanager_MaxReplicaJobDurationMax Replica Job DurationMax replica job durationsNo
veeam_enterprisemanager_ProtectedVmsCountProtected Vms CountProtected virtual machines countcountNo
veeam_enterprisemanager_BackedUpVmsCountBackedUp Vms CountBackedUp virtual machines countcountNo
veeam_enterprisemanager_ReplicatedVmsCountReplicated Vms CountReplicated virtual machines countcountNo
veeam_enterprisemanager_RestorePointsCountRestorePoints CountRestorePoints countcountNo
veeam_enterprisemanager_FullBackupPointsSizeFullBackup Points SizeFullBackup points sizeGBNo
veeam_enterprisemanager_IncrementalBackupPointsSizeIncremental Backup Points SizeIncremental backup points sizeGBNo
veeam_enterprisemanager_ReplicaRestorePointsSizeReplica Restore Points SizeReplica restore points sizeGBNo
veeam_enterprisemanager_SourceVmsSizeSource Vms SizeSource virtual machines sizeGBNo
veeam_enterprisemanager_SuccessBackupPercentsSuccess Backup PercentsSuccess backup percents%No
veeam_backupserver_JobsCountBackup Server Jobs Count.Number of Jobs Configured on BackupServer. Returns a number of jobs related to backup only, not agent backups.countNo
veeam_job_IsScheduleConfiguredJob Schedule ConfigurationDefines whether scheduling options are specified for the job. Possible values are false(0) and true(1)No
veeam_job_IsScheduleEnabledJob Schedule Is EnabledDefines whether scheduling is enabled for the job. Possible values are false(0) and true(1)Yes
veeam_job_NextScheduledTimeJob Next Schedule TimeReturns the scheduled time of the job in milliseconds.This metric is available for scheduled jobs only.msNo
veeam_job_BackupCompetitionWaitingPeriodMinBackup Competition Waiting Period in MinTime period in minutes for which the job must wait for the backup job to complete.minutesNo
veeam_job_CurrentStatusJob Current StatusState of the backup/replication job session. Possible values are Resuming(0), Starting(1), Working(2), Pausing(3), Stopping(4), Stopped(5) and Unknown(6)No
veeam_job_LastScanResultJob Last Scan StatusResult of the backup/replication job session. Possible values are Warning(0),Success(1),Failed(2) and NeverStarted(3)Yes
veeam_job_LastRunTimeJob Last Scan RunTimeReturns time when the backup job session has ended in milliseconds.msNo
veeam_job_ProgressPercentageJob Progress PercentageProgress of the backup job session.%No
veeam_repository_CapacityRepository CapacityTotal space available on the repository.GBNo
veeam_repository_FreeSpaceRepository Free SpaceFree space available on the repository.GBYes
veeam_repository_BackupSizeBackup Repository Used SpaceTotal space occupied by the data due to backupGBNo
veeam_repository_CapacityUtilizationRepository Space UtilizationAmount of space utilized on the repository in percentage%Yes
veeam_backup_machine_RestorePointsCountBackup Machine Restore Points CountBackup Machine Restore Points CountcountNo
veeam_backup_machine_LastSucessBackupTimeMachine Last Successful Backup TimeBLast Success Time at which backup of a machine is successful.msNo

Supported Metrics through Veeam Service Provider Console

Metric NameDisplay NameDescriptionUnitsDefault Metrics
veeam_enterprisemanager_StatusEnterprise Manager StatusEnterprise Manager Status. Possible values are Unknown(0), Healthy(1), Inaccessible(2), OutofDate(3)Yes
veeam_backupserver_StatusBackup Server StatusBackup Server Status. Possible values are Unknown(0), Healthy(1), Warning(2) and Inaccessible(3)
veeam_job_LastScanResultJob Last Scan StatusResult of the backup/replication job session. Possible values are Warning(0),Success(1),Failed(2) and NeverStarted(3)Yes
veeam_job_LastRunTimeJob Last Scan RunTimeReturns time when the backup job session was ended in milliseconds.msYes
veeam_job_DaysSinceLatestRestorePointVeeam Job DaysSinceLatestRestorePointReturns the Latest Restore Point Time in terms of DaysDaysYes
veeam_repository_StatusRepository StatusRepository Status. Possible values are Unknown(0), Healthy(1), Warning(2) and Error(3)Yes
veeam_repository_CapacityRepository CapacityTotal space available on the repository.GBNo
veeam_repository_FreeSpaceRepository Free SpaceFree space available on the repositoryGBYes
veeam_repository_CapacityUtilizationRepository Capacity utilizationRepository Capacity utilization%Yes
veeam_backupproxy_StatusBackup Proxy StatusReturns Backup Proxy Status. Possible values are Unknown(0),Healthy(1),Warning(2),Error(3)Yes

Risks, Limitations & Assumptions

  • Application can handle Critical/Recovery failure notifications for below two cases when user enables App Failure Notifications in configuration
    • Connectivity Exception
    • Authentication Exception
  • Application will not send any duplicate/repeat failure alert notification until the already existing critical alert is recovered.
  • Using metrics for monitoring the resources and generating alerts when the threshold values are breached.
  • Application cannot control monitoring pause/resume actions based on above alerts.
  • This application supports only Classic gateway. Not supported with Cluster gateway.
  • Component level thresholds can be configured on each resource level.
  • No support of showing activity log and applied time.
  • No support for the option to get Latest snapshot metric.
  • There is a chance of creating duplicate resources for certain resources like Veeam Enterprise Manager and Veeam BackupServer, due to lack of information like mac address, serialnumber, ip address from the Veeam API’s.