CommVault Monitoring

Last updated on 17 March, 2023


LogicMonitor’s CommVault monitoring package leverages the CommVault API to monitor and alert on the status of backup jobs and other health and performance metrics.


As of November 2020, LogicMonitor’s CommVault package is known to be compatible with:

  • Feature Release 11.20

Setup Requirements

Add Resources Into Monitoring

Add your CommVault hosts into monitoring. For more information on adding resources into monitoring, see Adding Devices.

Assign Properties to Resources

The following custom properties must be set on the CommVault resource within LogicMonitor. For more information on setting properties, see Resource and Instance Properties.

Property Value
commvault.user The name of the CommCell Console user. For Active Directory (AD) users, an email address can be used.
commvault.pass Password for the specified user.
commvault.domain (optional) If the user logging in is a domain user, the domain parameter must be set to the domain associated with the user.
commvault.port (optional) Defaults to port 81 if not set. (optional) Used in CommVault Subclients, CommVault VMware Subclients, and CommVault VMware Subclient VMs DataSources to set the number of days to look back for backup jobs. This determines which jobs are added into monitoring. Defaults to 1 day if not set.
system.categories “CommVault” (this value will be added automatically by the addCategory_CommVault PropertySource)

Import LogicModules

From the LogicMonitor public repository, import all CommVault LogicModules, which are listed next. If these LogicModules are already present, ensure you have the most recent versions.

Once the LogicModules are imported (assuming all previous setup requirements have been met), data collection will automatically commence.​

LogicModules in Package

LogicMonitor’s package for CommVault consists of the following LogicModules. For full coverage, please ensure that all of these LogicModules are imported into your LogicMonitor platform.

Display Name Type Description
addCategory_CommVault PropertySource Adds a value of “CommVault” to the system.categories property for hosts with commvault.user and commvault.pass properties.
CommVault Job Status DataSource Monitors the status of CommVault backup jobs for completion, failure, waiting, etc.
CommVault Subclients DataSource Monitors CommVault subclient backup job metrics.
CommVault VMware Subclients DataSource Monitors CommVault VMware subclient most recent backup job status and backup metrics.
CommVault VMware Subclient VMs DataSource Monitors Commvault VMware subclient virtual machine backup status and metrics.
CommVault Management Console DataSource Monitors CommVault Management Console web page availability.
CommVault Services DataSource Monitors state of CommVault Services on a Windows host.

When setting static datapoint thresholds on the various metrics tracked by this package’s DataSources, LogicMonitor follows CommVault’s best practice KPI recommendations. If necessary, we encourage you to adjust these predefined thresholds to meet the unique needs of your environment. For more information on tuning datapoint thresholds, see Tuning Static Thresholds for Datapoints.

In This Article