Working with Veeam Backup

Prerequisites

OpsRamp Classic Gateway(Linux) 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.

Configure Veeam Backup

To select your client, navigate to All Clients, and click the Client/Partner dropdown menu.
Note: You may either type your client’s name in the search bar or select your client from the list.
Navigate to Setup > Account. The Account Details screen is displayed.
Click Integrations. The Installed Integrations screen is displayed with all the installed applications.
Note: If you do not have any installed applications, you will be navigated to the Available Integrations and Apps page with all the available applications along with the newly created application with the version.
Click + ADD on the Installed Integrations page.
Note: Search for the integration either by entering the name of the integration in the search bar or by selecting the category of the integration from the All Categories dropdown list.
Click ADD in the Veeam application.
In the Configuration screen, click + ADD. The Add Configuration screen appears.
Enter the following BASIC INFORMATION:

Field Name	Field Type	Field Dependency	Description
Name	String	NA	Enter the name for the integration.
Persona*	Dropdown	N/A	Determines the type of Veeam system to connect to. Select one of the available personas: Enterprise Manager Backup and Replication Manager Service Provider Console
IpAddress/HostName*	Text	N/A	Enter the IP address or hostname of the target system.
Port*	Text	Appears for all Persona options	Enter the port number used for communication.
Veeam EnterpriseManager Credentials	Dropdown	Appears when Enterprise Manager is selected in the Persona field	Select the credentials for accessing Veeam Enterprise Manager. Enter this information in the ADD CREDENTIAL window: Name: Credential name. Description: Brief description of the credential. User Name: User name. Password: Password. Confirm Password: Confirm password Port: Specify the port number used for communication with the NSX-T Manager. Connection Timeout: Enter the maximum time (in milliseconds) to wait for a connection before timing out.
Veeam BackupServer Credentials	Dropdown	Appears when Backup and Replication Manager is selected in the Persona field.	Specifies the authentication credentials required to connect to the Veeam Backup & Replication server. You can select the credentials for accessing Veeam Backup Server or click +ADD to add new credentials. Enter this information in the ADD CREDENTIAL window. Name: Credential name. Description: Brief description of the credential. User Name: User name. Password: Password. Confirm Password: Confirm password Port: Specify the port number used for communication with the NSX-T Manager. Connection Timeout: Enter the maximum time (in milliseconds) to wait for a connection before timing out.
Veeam ServiceProvider Console Access Token	String	Appears when Service Provider Console is selected in the Persona field.	Enter the access token required to authenticate with the Veeam Service Provider Console.
SPC Rest API Version	Dropdown	Appears when Service Provider Console is selected in the Persona field.	Select the SPC API version used for accessing the Service Provider Console.
BR X-Api-Version	Dropdown	Appears when Backup and Replication Manager is selected in the Persona field.	Select the API version used for communication with Veeam Backup and Replication.
Is Secure	Checkbox	Appears for all Persona options	Enable this option to use secure communication.
App Failure Notifications	Checkbox	Appears for all Persona options	Enable this option to receive failure notifications for the configured integration.

CUSTOM ATTRIBUTES: Custom attributes are the user-defined data fields or properties that can be added to the preexisting attributes to configure the integration.

Field Name	Field Type	Field Dependency	Description
Custom Attribute	Dropdown	Appears for all Persona options	Select the custom attribute from the dropdown. You can add attributes by clicking the Add icon (+).
Value	Dropdown	Appears for all Persona options	Select the value from the dropdown.

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

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.
In the DISCOVERY SCHEDULE section, select recurrence pattern to add one of the following patterns:
- Minutes
- Hourly
- Daily
- Weekly
- Monthly
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.
12. 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.
13. Click NEXT.
14. (Optional) Click +ADD to create a new collector. You can either use the pre-populated name or give the name to your collector.
15. Select an existing registered profile. 16. Click FINISH.
The integration is installed and displayed on the INSTALLED INTEGRATION page. Use the search field to find the installed integration.

Modify the Veeam Backup

See Modify an Installed Integration or Application article.
Note: Select the Veeam application.

Discover Resources in Veeam Backup

To discover resources for Veeam:

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 monitoring, 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.