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 and enhancements.
  • Commvault HyperScale Authentication:
    Commvault HyperScale supports two authentication methods: API Token and Basic (credentials-based).
    • If the authentication type is set to API Token, a valid API token must be provided
    • If set to Basic, valid user credentials must be supplied.
    • For domain users, the domain parameter must also be specified and set to the appropriate domain name.
  • To access commvault hyperscale APIs using Authentication Type as API Token need requirement of an API Token (Key). Refer create-api-token (key).

Configure Commvault Hyperscale

  1. From All Clients, select a client.
  2. Navigate to Setup > Account.
  3. Select the Integrations tab.
  4. The Installed Integrations page, where all the installed integrations are displayed. Click + ADD on the Installed Integrations page.
  5. If you do not have any installed applications, you will be navigated to the Available Integrations page. The Available Integrations 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, use the All Categories option to search.
  6. Click ADD in the Commvault Hyperscale application.
  7. In the Configurations page, click + ADD. The Add Configuration page appears.
  8. Enter the following BASIC INFORMATION:
FunctionalityDescriptionField Type
NameEnter the name for the configuration.String
IP Address/ Host NameProvide the IP address or hostname of the Commvault Hyperscale system.String
PortSpecify the port number to connect to the Commvault server. Default is 443.String
Is SecureIf selected, the integration uses HTTPS (SSL/TLS) to connect securely over the specified port.Checkbox
Authentication TypeSelect the authentication method used to access the Commvault API:
  • Basic: Requires Domain and Credential fields.
  • APIToken: Requires the API Token field.
The form dynamically updates based on the selected method.		Dropdown
DomainApplicable only if Authentication Type is set to Basic. Enter the domain associated with the user credentials.String
CredentialApplicable only if Authentication Type is set to Basic. Select the saved OpsRamp credential profile to authenticate with the Commvault API.Dropdown
API TokenApplicable only if Authentication Type is set to APIToken. Paste a valid API token for authentication with the Commvault server.Integer
App Failure NotificationsIf selected, you will receive alerts or notifications related to application failures discovered via this integration.Checkbox
Custom AttributeOptional. Define custom attributes for the discovered resources. Example: Current Platform Release = 11.28.Key-Value Pair
Resource TypeSelect whether to discover all resources or only specific resource types. When set to All, all existing and future resources will be discovered.Toggle (All / Select)
Discovery ScheduleSet how often the discovery process runs:
  • None: No automatic discovery schedule.
  • Minutes / Hourly / Daily / Weekly / Monthly: Configure scheduled runs.
Radio Buttons
  1. Click ADD.


  1. Select an existing registered profile.
  2. 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 Commvault Hyperscale Details

To discover resources for v:

  1. Navigate to Infrastructure > Search > Hyperconverged Infrastructure > Commvault Hyperscale.
  2. The Commvault Hyperscale page is displayed, select the application name.
  3. The RESOURCE DETAILS page appears from the right.
  4. Click the ellipsis (…) on the top right and select View details.


  1. Navigate to the Attributes tab to view the discovery details.
  2. Click the Metrics tab to view the metric details for HPE OneView.

View resource metrics

To confirm HPE OneView 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.