Supported Target Version
Veeam Enterprise Manager Version 11.0.1.1261 (Need to consider if application is installed through veeam enterprise manager)
​Veeam Service Provider Version 6.0.0.8787, 7.0.0.14314 (Consider installation via the Veeam Service Provider Console).
Notes:
  • Service Provider Version 6.0.0.8787 can be accessed only through SPC API Version 3.2.
  • Service Provider Version 7.0.0.14314 can be accessed through both SPC API Version 3.2 and 3.3.

Application Version Details

Application VersionBug fixes / Enhancements
3.3.0
  • Provided fix for Resource Filtering while selecting regex patterns.
  • Updated code with native type based discovery changes
3.2.1Rename component names for metrics.
3.2.0Provided fix for veeam enterprise manager related PI.
Click here to view the earlier version updates
Application VersionBug fixes / Enhancements
3.1.0Added configuration field SPC Api Version as per client requirement, curated dashboard related changes.
3.0.0Changed Metric names and Monitor names for veeam spc and also added new metrics support for veeam spc.
2.0.0Added support for veeam integration using spc API's and enterprise API's and also removed discovery and monitoring support for veeam virtual machines through enterprise manager API's.
1.0.0Supported veeam integration using veeam enterprise manager API's.

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

Prerequisites

  • OpsRamp Classic Gateway 14.0.0 and above.

  • OpsRamp Nextgen Gateway 14.0.0 and above.
    Note: OpsRamp recommends using the latest Gateway version for full coverage of Recent bug fixes, enhancements, etc.

  • To access Veeam Enterprise Manager API the user should have Portal Administrator access.

  • By default pagination limit parameter is set to 12000 to optimize the number of api calls from app side. But on the veeam spc this parameter is limited to 500.

  • When installing the application using veeam service provider console the limit parameter need to be changed on veeam spc.

    Note: Refer to Veeam Service Provider Console 7.0 document to modify the parameter.

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

Supported Metrics

Supported Metrics through Veeam Enterprise Manager

Click here to view the supported metrics
Native TypeMetric NameDisplay NameUnitsApplication VersionDefault MetricsDescription
Veeam Enterprise Managerveeam_enterprisemanager_APIStatisticsVeeam EnterpriseManager API Statistics3.0.0NoProvides the number of API calls made within the frequency and resources
veeam_enterprisemanager_BackupServersCountBackup Servers Countcount1.0.0NoBackup Servers Count
veeam_enterprisemanager_ProxyServersCountProxy Servers Countcount1.0.0NoProxy Servers Count
veeam_enterprisemanager_RepositoryServersCountRepository Servers Countcount1.0.0NoRepository Servers Count
veeam_enterprisemanager_RunningJobsCountRunning Jobs Countcount1.0.0NoRunning Jobs Count
veeam_enterprisemanager_ScheduledJobsCountScheduled Jobs Countcount1.0.0NoScheduled Jobs Count
veeam_enterprisemanager_ScheduledBackupJobsCountScheduled Backup Jobs Countcount1.0.0NoScheduled Backup Jobs Count
veeam_enterprisemanager_ScheduledReplicaJobsCountScheduled Replica Jobs Countcount1.0.0NoScheduled Replica Jobs Count
veeam_enterprisemanager_TotalJobRunsTotal Job Runscount1.0.0YesTotal Job Runs in last 24 hours
veeam_enterprisemanager_SuccessfulJobRunsSuccessful Job Runscount1.0.0NoSuccessful job runs in last 24 hours
veeam_enterprisemanager_WarningsJobRunsWarnings Job Runscount1.0.0NoWarnings job runs in last 24 hours
veeam_enterprisemanager_FailedJobRunsFailed Job Runscount1.0.0YesFailed job runs in last 24 hours
veeam_enterprisemanager_MaxJobDurationMax Job Durations1.0.0YesMax job duration
veeam_enterprisemanager_MaxBackupJobDurationMax Backup Job Durations1.0.0NoMax backup job duration
veeam_enterprisemanager_MaxReplicaJobDurationMax Replica Job Durations1.0.0NoMax replica job duration
veeam_enterprisemanager_ProtectedVmsCountProtected Vms Countcount1.0.0NoProtected virtual machines count
veeam_enterprisemanager_BackedUpVmsCountBackedUp Vms Countcount1.0.0NoBackedUp virtual machines count
veeam_enterprisemanager_ReplicatedVmsCountReplicated Vms Countcount1.0.0NoReplicated virtual machines count
veeam_enterprisemanager_RestorePointsCountRestorePoints Countcount1.0.0NoRestorePoints count
veeam_enterprisemanager_FullBackupPointsSizeFullBackup Points SizeGB1.0.0NoFullBackup points size
veeam_enterprisemanager_IncrementalBackupPointsSizeIncremental Backup Points SizeGB1.0.0NoIncremental backup points size
veeam_enterprisemanager_ReplicaRestorePointsSizeReplica Restore Points SizeGB1.0.0NoReplica restore points size
veeam_enterprisemanager_SourceVmsSizeSource Vms SizeGB1.0.0NoSource virtual machines size
veeam_enterprisemanager_SuccessBackupPercentsSuccess Backup Percents%1.0.0NoSuccess backup percents
Veeam Backup Serverveeam_backupserver_JobsCountBackup Server Jobs Count.count1.0.0NoNumber of Jobs Configured on BackupServer. Returns a number of jobs related to backup only, not agent backups.
Veeam Jobveeam_job_IsScheduleConfiguredJob Schedule Configuration1.0.0NoDefines whether scheduling options are specified for the job. Possible values are false(0) and true(1)
veeam_job_IsScheduleEnabledJob Schedule Is Enabled1.0.0YesDefines whether scheduling is enabled for the job. Possible values are false(0) and true(1)
veeam_job_NextScheduledTimeJob Next Schedule Timems1.0.0NoReturns the scheduled time of the job in milliseconds.This metric is available for scheduled jobs only.
veeam_job_BackupCompetitionWaitingPeriodMinBackup Competition Waiting Period in Minminutes1.0.0NoTime period in minutes for which the job must wait for the backup job to complete.
veeam_job_CurrentStatusJob Current Status1.0.0NoState of the backup/replication job session. Possible values are Resuming(0), Starting(1), Working(2), Pausing(3), Stopping(4), Stopped(5) and Unknown(6)
veeam_job_LastScanResultJob Last Scan Status1.0.0YesResult of the backup/replication job session. Possible values are Warning(0),Success(1),Failed(2) and NeverStarted(3)
veeam_job_LastRunTimeJob Last Scan RunTimems1.0.0NoReturns time when the backup job session has ended in milliseconds.
veeam_job_ProgressPercentageJob Progress Percentage%1.0.0NoProgress of the backup job session.
Veeam Repositoryveeam_repository_CapacityRepository CapacityGB1.0.0NoTotal space available on the repository.
veeam_repository_FreeSpaceRepository Free SpaceGB1.0.0YesFree space available on the repository.
veeam_repository_BackupSizeBackup Repository Used SpaceGB1.0.0NoTotal space occupied by the data due to backup
veeam_repository_CapacityUtilizationRepository Space Utilization%2.0.0YesAmount of space utilized on the repository in percentage

Supported Metrics through Veeam Service Provider Console

Click here to view the supported metrics
Native TypeMetric NameDisplay NameUnitsApplication VersionDefault MetricsDescription
Veeam ServiceProvider Consoleveeam_spc_APIStatisticsVeeam SPC API Statistics3.0.0NoProvides the number of API calls made within the frequency and resources
veeam_spc_VMCopyJobCountVMware Or Nutanix BackupCopy Job VM Countcount3.0.0YesReturns number of backup copy jobs for a vmware or nutanix vm for a particular organization.
veeam_spc_CloudVMCopyJobCountCloud BackupCopy Job VM Countcount3.0.0YesReturns number of backup copy jobs for a cloud vm for a particular organization.
veeam_spc_AgentVMCopyJobCountAgent BackupCopy Job VM Countcount3.0.0YesReturns number of backup copy jobs for an agent vm for a particular organization.
Veeam Enterprise Managerveeam_spc_enterprisemanager_StatusEnterprise Manager Status3.0.0 (In 2.0.0 metric is available as veeam_enterprisemanager_Status)YesEnterprise Manager Status. Possible values are Unknown(0), Healthy(1), Inaccessible(2), OutofDate(3)
Veeam Backup Serverveeam_spc_backupserver_StatusBackup Server Status3.0.0 (In 2.0.0 metric is available as veeam_backupserver_Status)Backup Server Status. Possible values are Unknown(0), Healthy(1), Warning(2) and Inaccessible(3)
Veeam Jobveeam_spc_job_LatestJobSessionStatusJob Last Scan Status3.0.0 (In 2.0.0 metric is available as veeam_job_LastScanResult)YesResult of the backup/replication job session. Possible values are Warning(0),Success(1),Failed(2) and NeverStarted(3)
veeam_spc_job_LastRunTimeJob Last Scan RunTimems3.0.0 (In 2.0.0 metric is available as veeam_job_LastRunTime)YesReturns time when the backup job session was ended in milliseconds.
veeam_spc_job_DaysSinceLatestRestorePointVeeam Job DaysSinceLatestRestorePointDays3.0.0 (In 2.0.0 metric is available as veeam_job_DaysSinceLatestRestorePoint)YesReturns the Latest Restore Point Time in terms of Days
Veeam Repositoryveeam_spc_repository_StatusRepository Status3.0.0 (In 2.0.0 metric is available as veeam_repository_Status)YesRepository Status. Possible values are Unknown(0), Healthy(1), Warning(2) and Error(3)
veeam_spc_repository_CapacityRepository CapacityGB3.0.0 (In 2.0.0 metric is available as veeam_repository_Capacity)NoTotal space available on the repository.
veeam_spc_repository_FreeSpaceRepository Free SpaceGB3.0.0 (In 2.0.0 metric is available as veeam_repository_FreeSpace)YesFree space available on the repository
veeam_spc_repository_CapacityUtilizationRepository Capacity utilization%3.0.0 s(In 2.0.0 metric is available as veeam_repository_CapacityUtilization)YesRepository Capacity utilization
Veeam Backup Proxyveeam_spc_backupproxy_StatusBackup Proxy Status3.0.0 (In 2.0.0 metric is available as veeam_backupproxy_Status)YesReturns Backup Proxy Status. Possible values are Unknown(0),Healthy(1),Warning(2),Error(3)

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)

Configure and Install Veeam Integration

  1. From All Clients, select a client.
  2. Go to Setup > Account.
  3. Select the Integrations and Apps tab.
  4. The Installed Integrations page, where all the installed applications are displayed. Note: If there are no installed applications, it will navigate to the ADD APP page.
  5. Click + ADD on the Installed Integrations page. The Available Integrations and Apps 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.
    Note: By default, the Veeam Type is EnterpriseManager. Click the dropdown and select ServiceProviderConsole to install the integration through the ServiceProviderConsole.
  3. Enter the below mentioned Basic Information:
FunctionalityDescription
NameEnter the name for the configuration.
Veeam TypeSelect enterpriseManager or serviceProviderConsole from the dropdown list.
IpAddress/HostNameEnter the IpAddress/HostName.
PortPort

Note: By default EnterpriseManager Port: 9398 / Service Provider Console Port: 1280 is displayed.
Veeam EnterpriseManager CredentialsSelect the Credential from the drop-down list.

Notes:
  • Click + Add to create a credential. The ADD CREDENTIAL window is displayed. Enter the following information.
    • Name: Credential name.
    • Description: Brief description of the credential.
    • User Name: User name.
    • Password: Password.
    • Confirm Password: Confirm password

Notes:

  • Veeam ServiceProvider Console: If turned on, you can provide the Veeam Service Provider Console Access Token.
  • By default the Is Secure checkbox is selected.
  • Ip Address/Host Name and Port should be accessible from Gateway.
  • App Failure Notifications: if turned on, you will be notified in case of an application failure that is, Connectivity Exception, Authentication Exception.
  • When you select serviceProviderConsole, the Veeam Service Provider Console Access Token and SPC Rest API Version section are displayed.
    Note: By default SPC Rest API Version is 3.2 by default
  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
Veeam

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.

  1. Under the ADVANCED SETTINGS, Select the Bypass Resource Reconciliation option, if you wish to bypass resource reconciliation when encountering the same resources discovered by multiple applications.

    Note: If two different applications provide identical discovery attributes, two separate resources will be generated with those respective attributes from the individual discoveries.

  2. Click NEXT.

  3. (Optional) Click +ADD to create a new collector by providing a name or use the pre-populated name.

Veeam
  1. Select an existing registered profile.
Veeam
  1. Click FINISH.

The application is installed and displayed on the INSTALLED INTEGRATION page. Use the search field to find the installed integration.

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

Click here to view the Supported Input Keys
Resource TypeSupported Input Keys
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 Alert Custom Macros

Customize the alert subject and description with below macros then it will generate alert based on customisation. Supported macros keys:

Click here to view the alert subject and description with macros

                                ${resource.name}

                                ${resource.ip}

                                ${resource.mac}

                                ${resource.aliasname}

                                ${resource.os}

                                ${resource.type}

                                ${resource.dnsname}

                                ${resource.alternateip}

                                ${resource.make}

                                ${resource.model}

                                ${resource.serialnumber}

                                ${resource.systemId}

                                ${parent.resource.name}

                                    ${Custom attributes on the resource}

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 both Classic Gateway and NextGen Gateway.
  • 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.
  • While adding the configuration, if the user selects Veeam Type as Enterprise Manager, user must give the credentials eventhough Veeam Enterprise Manager Credentials is not a mandatory field.
  • While adding the configuration, if the user selects Veeam Type as ServiceProvider Console, user must provide Veeam Service Provider Console Access Token even though it is not a mandatory field. Without Veeam Service Provider Console Access Token integration does not work.