This section guides you through setting up, configuring, and managing the Commvault integration in OpsRamp.
Prerequisites
- OpsRamp Classic Gateway (Linux) 15.0.0 or above.
- OpsRamp NextGen Gateway 15.0.0 or above. Note: OpsRamp recommends using the latest Gateway version for full coverage of recent bug fixes, and enhancements.
- To access commvault Rest API credentials with master permissions are required.
Configure Commvault Integration
Click here to Configure and Install the Commvault 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 Commvault application.
- In the Configuration screen, click + ADD. The Add Configuration screen appears.
- Enter the following BASIC INFORMATION.
| Field Name | Description | Field Type |
|---|---|---|
| IP Address/ Host Name | Enter the IP address/host name of the Commvault. It should be accessible from Gateway. | String |
| 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 |
| Port | Enter the port number to communicate with OpsRamp's endpoints. It should be accessible from Gateway. Default Value: 8080 | Integer |
| Domain | Enter the commvault domain information. | String |
| Commvault BackupServer Credential | Select the credential associated with your Commvault account. If you want to use the existing credentials, select them from the Select Credentials dropdown. Else, click + Add to create credentials. 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 | Dropdown |
| App Failure Notifications | When selected, you will be notified in case of an application failure such as Connectivity Exception, Authentication Exception. | Checkbox |
| CommCell Type | Select the type of CommCell deployment. The available options are: CommCell - Client: Select this option to configure and discover client-level resources within the Commvault environment. CommCell: Select this option to configure the integration at the CommCell server level, enabling the discovery of the full CommCell hierarchy and additional metrics specific to the CommServer native type. The available metrics and discovery details depend on the selected CommCell Type. | Dropdown |
- 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.
Note
Sample values shown in the configuration fields are for illustration purposes only. Use your actual integration details when configuring.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.- 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. - Click NEXT.
- (Optional) Click +ADD to create a new collector. You can either use the pre-populated name or give the name to your collector.
- 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 Commvault Integration
See Modify an Installed Integration or Application article.
Note: Select the Commvault application.
Discover Resources in Commvault Integration
Click here to View the Commvault Details
To discover resources for Commvault:
- Navigate to Infrastructure > Search > BACKUP AND RECOVERY > Commvault.
- The Commvault page is displayed, select the application name.
- The RESOURCE DETAILS page appears from the right.
- Click the ellipsis (…) on the top right and select View details.
- Navigate to the Attributes tab to view the discovery details.
View resource metrics
To confirm Commvault 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.
- Click the Metrics tab to view the metric details for Commvault.
×![]()