Veeam Backup

Application Version and Upgrade Details

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.

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

Supported Metrics through Veeam Service Provider Console

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. Navigate 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 Available Integrations and Apps 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: Search for the application using the search option available. Alternatively, you can use the All Categories option to search.

6. Click ADD in the Veeam application.
   Note: Select the version from the drop down menu.
7. 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.
8. Enter the below mentioned Basic Information:

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

9. Select the below mentioned Custom Attribute:

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).

10. 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.

11. In the DISCOVERY SCHEDULE section, select Recurrence Pattern to add one of the following patterns:

    • Minutes
    • Hourly
    • Daily
    • Weekly
    • Monthly

12. Click ADD.

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.

13. 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.

14. Click NEXT.

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

16. Select an existing registered profile.

17. 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

• See Modify an Installed Integration or Application article.

  Note: Select the Veeam application.

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.

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.

Resource Filter Input keys

Supported Alert Custom Macros

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

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 send any duplicate/repeat failure alert notification for every 6 hours.
• Latest snapshot metric is available from Gateway version 14.0.0.
• 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.