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.
Configure Veeam Integration
Click here to Configure and Install the Veeam integration
- 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.
Note
By default, the Veeam Type is EnterpriseManager. Click the dropdown and select ServiceProviderConsole to install the integration through the ServiceProviderConsole.
- Enter the following BASIC INFORMATION:
| Field Name | Description | Field Type |
|---|---|---|
| Name | Enter the name for the configuration. | String |
| Veeam Type | Select enterpriseManager or serviceProviderConsole from the dropdown list. Note: When you select serviceProviderConsole, the Veeam Service Provider Console Access Token and SPC Rest API Version section are displayed. | Dropdown |
| IpAddress/HostName | Enter the IpAddress/HostName of Veeam, and it is accessible from Gateway. | Integer |
| Port | Port Note: By default EnterpriseManager Port: 9398 / Service Provider Console Port: 1280 is displayed. | Integer |
| Veeam EnterpriseManager Credentials | Select the Credential from the drop-down list. (Optional): Click + Add to create a credential. The ADD CREDENTIAL window is displayed. Enter the following information.
| Dropdown |
| Is Secure | Select this checkbox if you want the communication between your system and the specified endpoint to be secured using protocols such as HTTPS (HTTP over SSL/TLS). Default Selection: When selected, it signifies that the connection is encrypted, providing an added layer of security to the data being transmitted. | Checkbox |
| Veeam ServiceProvider Console | When turned on, you can provide the Veeam Service Provider Console Access Token | Integer |
| App Failure Notifications | When selected, you will be notified in case of an application failure such as Connectivity Exception, Authentication Exception. | Checkbox |
| SPC Rest API Version | SPC Rest API Version details. Note: By default 3.2 is added | Checkbox |
- 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 | Description | Field Type |
|---|---|---|
| Custom Attribute | Select the custom attribute from the dropdown. You can add attributes by clicking the Add icon (+). | Dropdown |
| Value | Select the value from the dropdown. | 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.
- Click FINISH.
The integration is installed and displayed on the INSTALLED INTEGRATION page. Use the search field to find the installed integration.
Modify the Configuration
Click here to Modify the Configuration
See Modify an Installed Integration or Application article.
Note: Select the Veeam application.
Discover Resources in Veeam Integrations
Click here to View the Veeam Details
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.
