Alerts and Notifications - Advanced

Table of Contents

Generating Alert Notifications

An alert is sent when conditions within the entity have met the selected criteria for the alert. The threshold and notification criteria determine when and at which frequency an alert is generated.

E-Mail Alerts

Alerts can be sent in the form of an e-mail to selected recipients, providing the recipient has a valid SMTP mail server, a valid e-mail address, and is enabled as a CommCell user. An e-mail notification can contain up to 100 alerts.

For details about configuring the Email alert notification, refer to Setting up Alerts and Notifications (E-mail).

  1. From the CommCell Console ribbon, click Alerts.
  2. In the Alerts dialog box, click Add.
  3. On the General Information page, enter a name for the alert in the Display Name box, select a Category and Alert Type, and click Next.
  4. Select the clients or client groups that you want to associate with this alert and click Next.

    To exclude specific client groups from receiving alert notifications, mark the client group with an 'X' mark.

  5. Select the notification criteria to be used and click Next.
  6. On the Notification Type(s) Selection page, click the Select [E-Mail] for notification check box.
  7. By default, the email has an HTML based format. Select TEXT to create a text based email.

    Select a token from the Add Token list, if you wish to customize the e-mail notification and then click Next. See Available Alert Tokens for a list of the available tokens.

  8. Select the CommCell users and/or user groups that will receive the alert and then click Next.
  9. Review your selections on the Summary page.
  10. Click Finish.

SNMP Traps

Alerts can be sent by CommServe to other computers in the form of SNMP traps, using the SNMP protocol, provided that the SNMP Enabler software is installed on the CommServe computer and SNMP is selected as the alert notification type.

For details about configuring the SNMP alert notification, refer to Setting up Alerts and Notifications (SNMP Traps).

  1. From the CommCell Console ribbon, click Alerts.
  2. In the Alerts dialog box, click Add.
  3. On the General Information page, enter a name for the alert in the Display Name box, select a Category and Alert Type, and click Next.
  4. Select the clients or client groups that you want to associate with this alert and click Next.

    To exclude specific client groups from receiving alert notifications, mark the client group with an 'X' mark.

  5. Select the notification criteria to be used and click Next.
  6. On the Notification Type(s) Selection page, click the SNMP tab to send the alert by a SNMP trap.
  7. Click the Select [SNMP] for notification check box.

    Select a token from the Add Token list, if you wish to customize the SNMP notification and then click Next. See Available Alert Tokens for the list of available tokens.

  8. Select the CommCell users and/or user groups that will receive the alert and then click Next.
  9. Review your selections on the Summary page.
  10. Click Finish.

Windows Event Viewer

Alerts can be sent from the CommServe to the Windows Event Viewer of the client computers where the alerts are generated as an event.

For details about configuring Event viewer alert notification, refer to Setting up Alerts and Notifications (Windows Event Viewer).

  1. From the CommCell Console ribbon, click Alerts.
  2. In the Alerts dialog box, click Add.
  3. On the General Information page, enter a name for the alert in the Display Name box, select a Category and Alert Type, and click Next.
  4. Select the clients or client groups that you want to associate with this alert and click Next.

    To exclude specific client groups from receiving alert notifications, mark the client group with an 'X' mark.

  5. Select the notification criteria to be used and click Next.
  6. On the Notification Type(s) Selection page, click the Event Viewer tab to send the alert to the System Event Viewer.
  7. Click the Select [Event Viewer] for notification check box.

    Select a token from the Add Token list, if you wish to customize the System Event Viewer notification then click Next. See Available Alert Tokens for the list of available tokens.

  8. Review your selections on the Summary page.
  9. Click Finish.

SCOM Alerts

Alerts can be sent from the CommServe to the SCOM Server provided an SCOM Server has been configured. Use the following steps to generate SCOM notifications for alerts.

  1. From the CommCell Console ribbon, click Alerts.
  2. In the Alerts dialog box, click Add.
  3. On the General Information page, enter a name for the alert in the Display Name box, select a Category and Alert Type, and click Next.
  4. Select the clients or client groups that you want to associate with this alert and click Next.

    To exclude specific client groups from receiving alert notifications, mark the client group with an 'X' mark.

  5. On the Threshold and Notification Criteria page, select the notification criteria to be used and click Next.
  6. On the Notification Type(s) Selection page, click the SCOM tab and select the Select [SCOM] for notification check box.
  7. Optional: To customize the SCOM notification, in the Add Token box, select a token from the list if you wish to customize the notification then click Next. See Available Alert Tokens for the list of available tokens.
  8. Review your selections on the Summary page.
  9. Click Finish.

Workflow Notifications

Use the following steps to generate workflow notifications for alerts.

  1. From the CommCell Console ribbon, click Alerts.
  2. In the Alerts dialog box, click Add.
  3. On the General Information page, enter a name for the alert in the Display Name box, select a Category and Alert Type, and click Next.
  4. Select the clients or client groups that you want to associate with this alert and click Next.

    To exclude specific client groups from receiving alert notifications, mark the client group with an 'X' mark.

  5. Select the notification criteria to be used and click Next.
  6. On the Notification Type(s) Selection page, click the Workflow tab to enable the alert to execute a workflow.
  7. Click the Select [Workflow] for notification check box.
  8. Select a workflow from the Workflow to run list. A table with Name, Value, and Type columns is displayed. The Name and Type columns are populated with inputs defined in the workflow.
  9. In the Value column, select a value for the input from the drop down list, or type a value for the input. The drop down list is a list of the available alert tokens. See Available Alert Tokens for the list of available tokens.
  10. Click Reset All to reset the value of an input.
  11. Select a workflow engine on which you want to run the workflow, from the Run workflow on list.
  12. Review your selections on the Summary page.
  13. Click Finish.

Command Line

Run Command alert notification is used to send the alert by executing a command script. The Run Command can be located on the CommServe or remote machines, but is executed only on the CommServe machine.

For details about configuring command line alert notification, refer to Setting up Alerts and Notifications (Command Line).

  1. From the CommCell Console ribbon, click Alerts.
  2. In the Alerts dialog box, click Add.
  3. Enter a name for the alert in the Display Name box.
  4. Select a Category and Alert Type and click Next.
  5. Select the clients or client groups that you want to associate with this alert and click Next.

    To exclude specific client groups from receiving alert notifications, mark the client group with an 'X' mark.

  6. Select the notification criteria to be used and click Next.
  7. On the Notification Type(s) Selection page, click the Run Command tab to send the alert by executing a command script.
  8. Click the Select [Run Command] for notification check box and do the following:
    • By default, the command is executed from your local drive. If the command resides in a network share, click Use Network Share and click the Change button to provide the account information to access the network share.
    • Specify the location of the command processor executable file in the Command Script Location box. You can also click Browse to browse the location of the command.
    • Specify the command arguments and manually add quotation marks around the argument values. You can also click Browse to locate the arguments. See Available Alert Tokens for a list of tokens or arguments.
    • Click Next.
  9. On the Summary page, review your selections and click Finish.

Save to Disk

Alert notification messages can be sent in the form of a text file to a designated directory either locally or on a network share. This is useful when it is necessary to quickly obtain a listing of the failed items in an operation.

For details about configuring Save to Disk alert notifications, refer to Setting up Alerts and Notifications (Save to Disk).

  1. From the CommCell Console ribbon, click Alerts.
  2. In the Alerts dialog box, click Add.
  3. On the General Information page, enter a name for the alert in the Display Name box.

    Do not use special characters in the Display Name box because the name of the alert is used in the file path when the alert is saved to the disk. For Windows file naming conventions, go to the Windows Dev Center - Desktop website, Naming Files, Paths, and Namespaces - Naming Conventions.

  4. Select a Category and Alert Type, and click Next.
  5. On the Entities Selection page, select the clients or client groups to associate with this alert and click Next.

    To exclude specific client groups from receiving alert notifications, mark the client group with an 'X' mark.

  6. On the Threshold and Notification Criteria Selection page, select the notification criteria to be used and click Next.
  7. On the Notification Type(s) Selection page, click Save to Disk to send the alert to a local directory or network share.
  8. Click the Select [Save to Disk] for notification check box and do the following:
    • By default, the alert is in HTML format. Select TEXT to create a text based alert.

      Also, in the Add Token box, select the token from the list if you wish to customize the notification. See Available Alert Tokens for the list of available tokens.

    • By default, the alert is saved in the C:\Program Files\Commvault\Simpana\alerts directory.

      If you want to save the alert in a network share, click Use Network Share and specify the Location. Also, click the Change button to provide the account information to access the network share.

    • Click Next.
  9. Review your selections on the Summary page.
  10. Click Finish.

RSS Feeds

Alert notification messages can be sent in the form of an RSS feed, which can be automatically integrated with your Web Browser.

For details about configuring RSS Feeds alert notifications, refer to Setting up Alerts and Notifications (RSS Feeds).

  1. From the CommCell Console ribbon, click Alerts.
  2. In the Alerts dialog box, click Add.
  3. On the General Information page, enter a name for the alert in the Display Name box, select a Category and Alert Type, and click Next.
  4. Select the clients or client groups that you want to associate with this alert and click Next.

    To exclude specific client groups from receiving alert notifications, mark the client group with an 'X' mark.

  5. Select the notification criteria to be used and click Next.
  6. Select the Threshold and Notification Criteria in the Add Alert Wizard and click Next.
  7. On the Notification Type(s) Selection page, click the RSS Feeds tab to send the alert to an RSS feed.
  8. Click the Select [RSS Feeds] for notification check box and do the following:
    • In the Add Token box, select a token from the list to customize the RSS Feeds notification. See Available Alert Tokens for the list of available tokens.
    • If you need to provide a different RSS feed location (other than the default alerts,rss), select the location from the Select/Enter the Feed Location drop-down list.
    • Click Next.
  9. Review your selections on the Summary page.
  10. Click Finish.

Console Alerts

Alert notifications can be sent in the form of an e-mail message to the CommCell Console. You can view and monitor up to 200 alerts.

For details about console alerts, refer to Setting up Alerts and Notifications (Console Alerts).

  1. From the CommCell Console ribbon, click Alerts.
  2. In the Alerts dialog box, click Add.
  3. On the General Information page, enter a name for the alert in the Display Name box, select a Category and Alert Type, and click Next.
  4. Select the clients or client groups that you want to associate with this alert and click Next.

    To exclude specific client groups from receiving alert notifications, mark the client group with an 'X' mark.

  5. Select the notification criteria to be used and click Next.
  6. On the Notification Type(s) Selection page, click the Console Alerts tab to send an alert to the console.
  7. Click the Select [Console Alerts] for notification check box.
  8. By default, the notification message is in HTML format. Select TEXT to create a text based message.

    Select a token from the Add Token list, if you wish to customize the console notification and then click Next. See Available Alert Tokens for the list of available tokens.

  9. Select the CommCell users and/or user groups that will receive the alert and then click Next.
  10. Review your selections on the Summary page and click Finish.
  11. When the alert is triggered by the criteria you specified, an alert pop-up window will be displayed, which you can click to view the notification.

    To view upcoming console notifications, click Alerts from the CommCell Console ribbon and select Console Alerts.

  12. From the Console Alerts window, the details of the latest notification will be displayed in the lower pane.

    You can also right-click a Console alert to perform the following operations:

    • View the alert details in a separate dialog box
    • Delete the alert
    • Mark the alert as read or unread. When unread, the alert will show bolded.
    • Insert a short note
    • Mark the alert as important by clicking the icon next to the alert entry. This will also retain the alert for a longer period of time.

    When an alert is marked important, read or unread, it will be only visible to you and not to all the alert recipients.

Setting Up Alerts for a Job (Immediate or Scheduled)

You can set up alerts for jobs that you commonly perform in the CommCell. Use the following steps to generate an alert for a File System backup job (immediate or scheduled) as an example:

  1. From the CommCell Browser, navigate to Client Computers | <Client> | File System | <BackupSet>.
  2. Right-click the <Subclient> and click Backup.
  3. Select the backup type and then click the Advanced button.
  4. Click the Alert tab and then click Add Alert.
  5. From the Add Alert Wizard dialog box, select the threshold and notification criteria and click Next.
  6. Select the way in which the alert is to be sent to its intended recipient and click Next. For example, you can click Select [Email] for notification to send the alert as an email.
  7. Select the CommCell users and/or user groups that will receive the alert and then click Next.
  8. Review the options that you selected in the Summary tab and click Finish.

Setting Up Alerts for Jobs Using a Schedule Policy

You can configure alerts to generate automatic notifications when the properties of the associated schedule policy are modified.

Use the following steps to create a schedule policy and configure its alert:

  1. From the CommCell Browser, navigate to Policies.
  2. Right-click Schedule Policies and click New Schedule Policy.
  3. Type a name for the schedule policy in the Name box.
  1. Select the type of schedule policy from the Type list.
  2. Click the Associations tab and select the entities that you want to associate with the schedule policy.
  3. Click the Alert tab and click Add Alert.
  4. From the Add Alert Wizard dialog box, select the required threshold and notification criteria and click Next.
  5. Select the way in which the alert is to be sent to its intended recipient and click Next. For example, you can click Select [Email] for notification to send the alert as an email.
  6. Select the CommCell users and/or user groups that will receive the alert and then click Next.
  7. Review the options that you selected in the Summary tab and click Finish.

You must configure new alerts after cloning a schedule policy. The associated alerts are not replicated during the cloning process.

Setting Up Alerts for Workflows

You can configure alerts to generate automatic notifications for workflow events, for example when a workflow completes successfully, or completes with errors.

Use the following steps to configure console alerts for a workflow as an example:

  1. From the CommCell Console ribbon, click Home and then click Alert.
  2. From the Alerts dialog box, click Add.
  3. Type the alert name in the Display Name box.
  4. Select Job Management from the Category pane and Workflow from the Type pane, and then click Next.

  5. Select the workflows that you want to associate to this alert, and then click Next.
  6. Select the alert criteria and then click Next.
  7. Click the Console Alerts tab, click the Select [Console Alerts] for Notification check box, and then click Next.
  8. Select the notification recipients from the Available pane and then click Add.
  9. Alternatively, you can type the recipients email address in the Email to Recipients box. Click Next.

  10. Review the alert selections and then click Finish.

Setting Up Subscription-Based Alerts

You can configure Job Management Data Protection and Data Recovery alerts to be sent to laptop clients. When configuring subscription-based alerts, a CommCell administrator can select the clients or client groups that will receive alert notifications, and client owners of all the clients that are part of the entity selection list, are automatically subscribed to the configured alert notifications as well. Client owners can unsubscribe from these alerts via the Web Console.

By default, the following subscription-based alerts are available in the Web Console:

  • No backup for last 4 days

    This is a Job Management - Data Protection alert which sends an individual email notification to client owners when no backup occurs in the last 4 days.

  • Recovery Job failed Alert

    This is a Job Management - Data Recovery alert which sends an individual email notification to client owners when a restore operation fails.

Subscription-based alerts are only available to laptop clients and client groups.

Use the following steps to create an alert to monitor backup operations as an example:

  1. From the CommCell Console ribbon, click Alerts.
  2. In the Alerts dialog box, click Add.
  3. On the General Information page, enter a name for the alert in the Display Name box.
  4. Select Job Management and Data Protection from the Category and Alert Type panes, respectively.
  5. Click Subscription based alert and then click Next.
  6. Select the laptop clients or client groups that you want to associate with this alert and click Next.
  7. Select the notification criteria to be used and click Next. For example to monitor failed backup jobs, click Job Failed.
  8. Select the way in which the alert is to be sent to its intended recipient and click Next. For example, you can click Select [Email] for notification to send the alert as an email.

    Only email and console alert notifications are supported for subscription-based alerts.

  9. Review your selections on the Summary page and then click Finish.

Generating Alerts from Job Controller

Use the following steps to add an alert for an active job from the Job Controller:

  1. From the CommCell Console toolbar menu, click Job Controller.
  2. Right-click the running job and click Add Alert.
  3. From the Add Alert Wizard dialog box, select the required threshold and notification criteria and click Next.
  4. Select the way in which the alert is to be sent to its intended recipient and click Next. For example, you can click Select [Email] for notification to send the alert as an email.
  5. Select the CommCell users and/or user groups that will receive the alert and then click Next.
  6. Review the options that you selected in the Summary tab and click Finish.

Generating Alerts for Events

The events displayed in the Event Viewer window are great tools for monitoring the activities that occur in a CommCell. You can add alerts for an event based on the event's properties such as event code, severity or description.

Use the following steps to generate an alert for an event:

  1. From the CommCell Console toolbar menu, click Event Viewer.
  2. Right-click an event and then click Add Alert from the shortcut menu.

    Alternatively, you can also right-click the event and then click View Alerts from the shortcut menu. From the Alerts dialog box, click Add.

  3. In the Add Alert Wizard dialog box, type the event name in the Display Name box and click Next.
  4. Select the clients and/or client groups that you want to associate with this alert and click Next.
  5. Select the criteria that will trigger the alert and click Next.

    The conditions displayed in the Alert Criteria area are the event properties displayed in the Event Viewer window.

  6. Select the way in which the alert is to be sent to its intended recipient and click Next. For example, you can click Select [Email] for notification to send the alert as an email.
  7. Select the CommCell users and/or user groups that will receive the alert and then click Next.
  8. Review the options that you selected in the Summary tab and click Finish.

Viewing Existing Alerts

The existing alerts in the CommCell can be viewed from the Alerts dialog box and also from the Event Viewer window. Information about the alert category, alert type, and the CommCell user that created the alert can be viewed for all configured alerts. Detailed information about the alerts can be viewed from the Alert Summary pane.

View All Existing Alerts from the Alert Wizard

Use the following steps to view all the existing alerts in the CommCell:

  1. From the CommCell Console toolbar menu, click Alert.

    Alternatively, click Control Panel, and from the control panel window click Alerts.

  2. In the Alerts dialog box, all existing alerts will be displayed.

    To view detailed information for an alert, select an alert from the list and the details will be displayed in the Alert Summary pane (which is located below the list of alerts).

View Alerts Configured for CommCell Events

You can view existing alerts associated with an event from the Event Viewer window.

Use the following steps to view all the event-based alerts configured in the CommCell:

  1. From the CommCell Console toolbar menu, click Event Viewer.
  2. Right-click an event and then click View Alerts from the shortcut menu.
  3. In the Alerts dialog box, all existing event-based alerts will be displayed.

    To view detailed information for an alert, select an alert from the list and the details will be displayed in the Alert Summary pane (which is located below the list of alerts).

Modifying Existing Alerts

You can modify the options of an alert using the Modify Alert Wizard or from the Job Controller.

Modify Existing Alerts from the Alert Wizard

Use the following steps to modify an existing alerts in the CommCell:

  1. From the CommCell Console toolbar menu, click Alerts.
  2. In the Alerts dialog box, select the alert that you want to modify and then click Edit.
  3. In the Modify Alert Wizard window, make the necessary changes and click Finish.

Modify Alerts for a Specific Job from the Job Controller

Use the following steps to modify an alert configured for an active job in the Job Controller:

  1. From the CommCell Console toolbar menu, click Job Controller.
  2. Right-click on the job associated with the alert you wish to modify and click Modify Alert.
  3. In the Modify Alert Wizard dialog box, make the necessary changes and click Finish.

Deleting Existing Alerts

Delete Alerts from the Alert Wizard

Use the following steps to delete an alert from the CommCell:

  1. From the CommCell Console toolbar menu, click Alerts.
  2. In the Alerts dialog box, select the alert that you want to delete and then click Delete.
  3. Click Yes to confirm the alert deletion.
  4. Click OK.

Delete Alerts for a Specific Job from the Job Controller

Use the following steps to delete an alert configured for an active job in the Job Controller:

  1. From the CommCell Console toolbar menu, click Job Controller.
  2. Right-click on the job associated with the alert you wish to delete and click Delete Alert.
  3. Click Yes in the confirmation window.

    The job-based alert will be deleted.

Delete Alerts from the Command Line.

You can delete alerts from the command line using the qoperation execscript qcommand, see QScripts for more information.

Enabling or Disabling Alerts

Alerts can be enabled or disabled in the CommCell. Disabled alerts appear to be grayed out and italicized. Alerts can also be enabled or disabled from the command line using the qoperation execscript qcommand, see QScripts for more information.

Use the following steps to enable/disable existing alerts in the CommCell:

  1. From the CommCell Console toolbar menu, click Alerts.
  2. In the Alerts dialog box, select the alert and click Enable or Disable, respectively. For example, for an active alert, click Disable to disable it.
  3. Click OK.

Testing Configured Alerts

An alert can be tested to verify if the notification is configured correctly so that all intended recipients of the alert receive the notification messages. The TestSendMail utility in the Resource Pack can also be used from the command line to test the mail connection for sending alerts.

Use the following steps to test an existing alerts in the CommCell:

  1. From the CommCell Console toolbar menu, click Alerts.
  2. In the Alerts dialog box, right-click the alert that you want to test and click Test.

    A test message will be sent to the recipients of the configured alert.

Setting Up Alert Tokens

An alert token is a parameter that can be added to an alert configuration so that when initiated the desired status information will be appended to the alert notification message.

Each alert notification has a different set of tokens available for configuration depending on the criteria selected for the alert. See Available Alerts for more information.

Add Alert Tokens

An alert notification can be customized by adding alert token arguments to the alert configuration. The tokens will be included in the body of the alert notification message.

Use the following steps to add alert tokens to an an existing alert:

  1. From the CommCell Console toolbar menu, click Alerts.
  2. In the Alerts dialog box, select the <Alert> and click Edit.
  3. From the Modify Alert Wizard dialog box, select Notification Type(s) Selection in the left pane.
  4. Select the tokens to be added to the alert notification from the drop down box.

    For each token that you select, click Add Token.

  5. Click Finish.

Alert tokens for the workflow notification can be selected from the drop down list in the Value field of the workflow input parameter table that is displayed once a workflow is selected. You can select any of the available alert tokens for each input parameter.

Available Alert Tokens

The following table describes all the available alert tokens:

Token Description
<AGENT TYPE NAME> The name of the agent.
<ALERT CATEGORY - ALERT TYPE> The alert category and type.
<ALERT NAME> The alert display name.
<ALL CLIENT LIST> A list of all the clients for which updates are selected to be installed.
<BACKUPSET NAME> The name of the backup set.
<CLIENT LIST> The name of the clients included in the operation.
<CLIENT NAME> The name of the client.
<CLIENT RELEASE LIST> A list of client names and releases.
<CLIENT STATUS LIST> A list of client names and the status of the update installation operation on each client.
<COMMCELL NAME> The name of the CommCell.
<COMMENT> Information regarding the detected condition.
<CONDITION CLEARED Y/N> Informs a user if the detected condition has cleared.
<CONTENTS> The list of updates available for download.
<CONTENTS DOWNLOADED> The list of updates downloaded.
<COPIED DATA SIZE> The size of data that was copied.
<COPIED MEDIA LIST> The list of media that was copied.
<COPY NAME> The copy name.
<CS UPGR TIME> The last time the CommServe was upgraded.
<CURRENT BACKUP SIZE> The current size of the backup data.
<DESCRIPTION> Information regarding the condition detected.
<DESTINATION LOCATION> Media destination location.
<DETECTED CRITERIA> Alert criteria that was detected.
<DISK SPACE INFO> Disk space information: volume name, volume size, free space.
<DISK SPACE LOW Y/N> Informs user if the disk space for the software installation directory, CommCell database, Quick Recovery Agent, QSnap, or ContinuousDataReplicator is low.
<DOWNLOAD SIZE (MB)> The size of the files that have been downloaded.
<DRIVE NAME> The name of the drive.
<DRIVEPOOL NAME> The name of the drive pool.
<ELAPSED TIME> The amount of time used for the operation.
<END TIME> The time the operation ended.
<ERR CODE> The error code for the job pending or job failure reason.
<EVENT DATE> The date when the event happened.
<EVENT ID> The event ID number.
<EVENT PROGRAM> The CommCell service involved in the event execution.
<EVENT SEVERITY> The severity level of the event.
<EXPORT LOCATION> The name of the media export location.
<ENTENDED RET.CANDIDATE Y/N> Indicates whether the job qualifies for extended retention.
<FAILED ATTEMPT TIME LIST> The time at which failed login occurred.
<FAILED ATTEMPTS COUNT> The number of failed login attempts.
<FAILED CLIENT LIST> A list of clients that failed to install updates.
<FAILED COUNT> The number of failed objects.
<FAILED OBJECTS> A list of failed objects in an attachment.
<FAILURE REASON> A reason why there was a failure.
<FILES DOWNLOADED> A list of the downloaded files.
<FORCE DECONFIG Y/N> Informs a user if a CommCell object was de-configured.
<FREE SPACE> Free space on related volume.
<GUI CLIENT NAME> Name of the client displayed in the user interface.
<INITIATER> Vault Tracker policy name that initiated the Vault Tracker action.
<INSTANCE NAME> The name of the instance.
<JOB ID> The Job ID assigned by the Job Manager for the job.
<JOBS RUNNING CLIENT LIST> A list of client names that have jobs running at the time of update installation.
<JOBS TOBE COPIED> The number of jobs to be copied.
<LEVEL> The backup level.
Note that for a File Archiver iDataAgent the status of the Index will be displayed for this token.
<LIBRARY NAME> The name of the library.
<LICENSE EXPIRED> The name of the license that will expire.
<LINES ABOVE MATCHED LINE> The number of lines in a log that come before the line that matches the criteria specified in a monitoring policy.
<LINES BELOW MATCHED LINE> The number of lines in a log that come after the line matching that matches the criteria specified in a monitoring policy.
<LOW CACHE CLIENT LIST> A list of client names that have low cache at the time of update installation.
<MAILBOX NAME> The name of the mailbox.
<MATCHED LINE NUMBER> The number of the line in the log which matches the criteria specified in a monitoring policy.
<MATCHED LINE> An output of the line in the log which matches the criteria specified in a monitoring policy.
<MATCHED LOG FILE> The name of the log file where a log event occurred matching the criteria specified in a monitoring policy.
<MESSAGE COUNT> The number of messages in the mailbox.
<MEDIA LABEL> The label/barcode of the media.
<MEDIA FAILED> The media that failed to be erased.
<MEDIA LIST> A list of media used during the operation.
<MEDIA LOCATION LIST> A list of media and their locations.
<MEDIA REQUIRE LIST> The media required for a data recovery operation.
<MEDIA SPACE LEFT> For disk media, the space remaining on a disk. For tape media, the remaining spare media in a scratch pool.
<MEDIA SUCCEEDED> The media that was successfully erased.
<MEDIA TO BE COPIED COUNT> The number of media to be copied.
<MEDIAAGENT NAME> The name of the MediaAgent.
<MONITORING CRITERIA STRING> The filtering criteria to monitor certain operations e.g., events, logs, etc.
<MONITORING POLICY NAME> The name of the monitoring policy.
<MORE MEDIA Y/N> A yes/no token, which specifies whether more media is to be exported.
<MOUNTPATH NAME> The name of the mount path.
<NO. OF DAYS LEFT FOR LICENSE EXPIRY> The number of days remaining until license expires.
<NUMBER OF ITEMS> The number of items restored/recovered during the operation.
<OLDEST JOB ENDDATE> The end date of the oldest job to be copied.
<OPERATION TYPE> The name of the operation.
<OTHER LIBRARY> The library to which the media belongs.
<OWNER EMAIL> The email address of the user who created the alert.
<OWNER NAME> The user who created the alert.
<PERCENTAGE CHANGE> The percentage change of data size from previous job to current job.
<PREVIOUS JOB ID> The previous job identification number.
<PREVIOUS BACKUP SIZE> The previous backup job data size.
<PROPERTY MODIFIED Y/N> A yes/no token, which specifies whether a property has been modified.
<PROTECTED COUNT> The number of protected objects.
<PROTECTED OBJECTS> A list of protected objects and file sizes in an attachment. File sizes are displayed in bytes.
<PRUNED JOB COUNT> The number of jobs that have aged.
<PRUNED MEDIA BARCODE LIST> The barcode list of aged media.
<RETAIN UNTIL> The predicted ending retention date of the job.
<RD JOB Y/N> A yes/no token, which specifies whether a job was initiated to a Recovery Director iDataAgent.
<RECOVERED COUNT> The number of objects recovered.
<RECOVERED OBJECTS> A list of recovered objects in an attachment.
<REPSET NAME> The name of the replication set.
<RESOURCE WAIT TIME> Time elapsed while a job is waiting for a resource.
<RESTORE USER NAME> The user that initiated the restore operation from the Search Console.
<SCHEDULE NAME> The name of the schedule.
<SCHEDULE TIME> The time the operation was scheduled.
<SERVER RELEASE> CommCell release number.
<SIZE> The size of the files restored during the operation.
<SIZE OF DATA TOBE COPIED> The size of the data to be copied.
<SKIPPED COUNT> The number of objects that were skipped during a data recovery operation.
<SKIPPED OBJECTS> A list of skipped objects in an attachment.
<SNAPSHOT VOLUME UNIT> The name of the snapshot volume unit.
<SOURCE LOCATION> The name of the source location.
<SP LIST> A list of the storage policies used in the operation.
<SP NAME> The name of the storage policy.
<SPAREPOOL/MOUNTPATH NAME> The spare media pool or mount path name.
<START TIME> The time the operation started.
<STATUS> The status of the operation.
<STORAGE POLICIES USED> The name of the storage policies associated with the data protection operation.
<SUBCLIENT NAME> The name of the subclient.
<SUBJECT BEGIN> The beginning of the notification.
<SUBJECT END> The end of the notification.
<SUCCESSFUL CLIENT LIST> A list of clients that were updated successfully.
<THRESHOLD> The threshold value for the library, drive and media.
<TIME> The time (as per the time zone of the CommServe) the condition was detected.
<TRANSIT LOCATION> The name of the transient location.
<UNKNOWN CLIENT LIST> A list of clients whose status was unable to be determined after the installation of updates.
<UNREACHABLE CLIENT LIST> A list of clients that are unreachable.
<UP-TO-DATE CLIENT LIST> A list of clients that already have all of the updates required.
<USER NAME> The CommCell user that initiated the operation.
<USER NAME LIST> A list of user names entered for the failed login attempts.
<UTC_TIME> The time the condition was detected as displayed in UTC time.
<VOLUME NAME> The name of the volume.
<VIRTUAL MACHINE HOST NAME> The name of the virtual machine host.
<VIRTUAL MACHINE NAME> The name of the virtual machine.
<VM FAILURE REASON> The reason for the virtual machine failure.
<VM STATUS> The status of the virtual machine.
<WORKFLOW> The name of the Recovery Director workflow.
<XFER BYTES> Data transferred in bytes.
<XFER GB PER HOUR> Data transferred in gigabytes per hour.
<XFER SECS> Number of seconds for the data transfer to occur.
<XFER SIZE> Amount of data transferred automatically displayed in the size unit respective of the size amount. Refer to the following:
amount of data transferred: amount automatically displayed:
Less than 1 MB Bytes
Greater than 1 MB, Less than 1 GB Megabytes
Greater than 1 GB
 
Gigabytes
<AUTOMATED CONTENT CLASSIFICATION_POLICY_NAME> The name of the Automated Content Classification Policy.
<LEGAL HOLD PHASE SELECTED Y/N> A yes/no token, which specifies whether Legal Hold phase is selected.
<NO.OF ITEMS FAILED IN LEGAL HOLD PHASE> Number of items failed in Legal Hold phase.
<NO.OF ITEMS FAILED IN RESTORE TO REVIEW SET PHASE> Number of items failed in Restore to Review Set phase.
<NO.OF ITEMS FAILED TO RESTORE> Number of items failed to restore.
<NO.OF ITEMS SELECTED FOR LEGAL HOLD> Number of items selected for Legal Hold.
<NO.OF ITEMS SELECTED TO RESTORE TO REVIEW SET> Number of items selected for restoring to review set.
<NO.OF ITEMS SELECTED TO RESTORE> Number of items selected for restore.
<NO.OF ITEMS SELECTED TO SEARCH> Number of items selected for search.
<NO.OF ITEMS SUCCEEDED IN LEGAL HOLD PHASE> Number of items succeeded in Legal Hold phase.
<NO.OF ITEMS SUCCEEDED IN RESTORE TO REVIEW SET PHASE> Number of items succeeded in restore to review set phase.
<PHASES_IN_JOB> List of phases for the job.
<RESTORE PHASE SELECTED Y/N> A yes/no token, which specifies whether restore phase is selected.
<RESTORE TO REVIEW SET PHASE SELECTED Y/N> A yes/no token, which specifies whether restore to review set phase is selected.
<STATUS OF LEGAL HOLD PHASE> Status of the Legal Hold phase.
<STATUS OF RESTORE PHASE> Status of the restore phase.
<STATUS OF RESTORE TO REVIEW SET PHASE> Status of the restore to review set phase.

Changing the Alert Locale

By default, alert notification messages are sent in the same language as the one used in the CommCell Console where the alerts were configured. However, they can be displayed in a different language than the one used in the CommCell Console. You can change the locale while configuring the alert.

 When adding or editing an alert, use the following steps to change the alert locale:

  1. From the Notification Type(s) Selection dialog box, select the language in which the alert is to be sent to its intended recipient from the Choose Locale list.
  2. Click OK to the warning message to confirm the change of the locale.
  3. Click Next to continue with the alert configuration.

Configuring the Notification Criteria

This section will help you achieve the following:

  • Set up the notification criteria for an alert
  • Define the alert locale

Depending on the type of alert that you want to create or modify, follow the steps provided in the section that describes the notification criteria that you want to select.

Sending Individual Notifications for an Alert

You can configure an alert to send individual notifications rather than multiple notifications within a single alert notification. This notification criteria is available for all alert types.

During the configuration of the alert, use the following steps to send an individual alert notification:

  1. From the Threshold and Notification Criteria Selection dialog box, click the Send individual notification for this alert check box.

    Note: To send individual notifications for data protection alerts for VSA backup jobs for virtual machines that were identified based on a discovery rule, select Send Individual notification for each backed up Discovered Virtual machine.

  2. Click Next to continue with the alert configuration.

Change Notification Frequency

You can configure an alert to repeat if a condition persists for a certain length of time. The Repeat notification every criteria is available for the following alert types:

  • Configuration - MediaAgents
  • Media Management
    • Device Status
    • Library Management
  • Others - some of the custom rules offer this option.

During the configuration of the alert, use the following steps to change the alert notification frequency:

  1. In the Notification Criteria section of the Threshold and Notification Criteria Selection step, select the Repeat notification every check box.
  2. Enter the time (in hours and minutes) after which the alert notification can be resent. The default time is 1 hour.
  3. Click Next to continue with the alert configuration.

Enable Notification When Condition Clears

You can configure an alert to send a notification when the condition clears. The notification criteria is available for the following alert types:

  • Configuration - MediaAgents
  • Media Management
    • Device Status
    • Library Management
  • Others - some of the custom rules offer this option.

During the configuration of the alert, use the following steps to send an alert notification when the condition clears:

  1. In the Notification Criteria section of the Threshold and Notification Criteria Selection step, select the Notify when the condition clears check box.
  2. Click Next to continue with the alert configuration.

Escalate a Notification

You can add escalation criteria to an alert. The notification criteria is available for the following alert types:

  • Configuration - MediaAgents
  • Media Management
    • Device Status
    • Library Management
  • Others - some of the custom rules offer this option.

During the configuration of the alert, use the following steps to escalate alert notifications:

  1. From the Threshold and Notification Criteria Selection step, select the Escalate Notification Criteria check box.
  2. In the If the condition persists for boxes, enter the hours and minutes after which the alert notification is escalated. The default time is 1 hour.
  3. To escalate the notification multiple times, select the Repeat notification every check box and enter the hours and minutes after which the alert notification is resent. The default time is 1 hour.
  4. Select the Notify when the condition clears check box to send an alert notification when the condition clears.
  5. Click Next to continue with the alert configuration.

Enable Notification When Jobs Qualify for Extended Retention

You can configure a Job Management - Data Protection alert to be notified of jobs that qualify for extended retention. When a data protection job meets the thresholds of the configured alert criteria, users will only be notified of those jobs that are set for extended retention.

During the configuration of the alert, use the following steps to send an alert notification about jobs that qualify for extended retention:

  1. In the Notification Criteria section of the Threshold and Notification Criteria Selection step, select the Notify only when jobs qualify for extended retention check box.
  2. Click Next to continue with the alert configuration.

Enable Notification of Jobs with Failed Objects

You can configure a Job Management - Data Protection alert to be notified of jobs that contains failed objects. When a data protection job meets the thresholds of the configured alert criteria, users will only be notified of those jobs that contain failed objects.

During the configuration of the alert, use the following steps to send an alert notification about jobs containing failed objects:

  1. In the Notification Criteria section of the Threshold and Notification Criteria Selection step, select the Notify only when jobs contains failed objects check box.
  2. Click Next to continue with the alert configuration.

Enable Notification of Deduplication Database Backup Jobs

You can configure a Job Management - Data Protection alert to be notified of DDB backup jobs. This alert will sort through the backup jobs, and users will only be notified of those backup jobs involving the deduplication database.

During the configuration of the alert, use the following steps to send an alert notification about DDB jobs:

  1. In the Notification Criteria section of the Threshold and Notification Criteria Selection step, select the Notify only if job is DDB job check box.
  2. Click Next to continue with the alert configuration.

Setting the Threshold Limit and Time-Out for Exchange Journal Mailbox

The following sections describe the steps to set additional settings for changing the threshold limit and time-out for the Exchange Journal Mailbox.

Setting the Threshold Limit

Use the following steps to set the interval at which the threshold limit is checked for Exchange Journal Mailbox:

  1. From the CommCell Browser, navigate to the Client Computers node.
  2. Right-click the <Client>, and then click Properties.
  3. On the Client Computer Properties dialog box, click Advanced.
  4. Click the Additional Settings tab and then click Add.
  1. In the Name box, type nArcMonitorIntervalInMins. The Category and Type details will be automatically populated.

    Alternatively, you can click Lookup and search for the additional setting using the Find box.

  2. In the Value box, type the interval in minutes.
  3. Click OK to save the additional setting configuration.
  4. Click OK.

Setting the Time-Out

Use the following steps to set the Time-Out for the monitoring process for Exchange Journal Mailbox:

  1. From the CommCell Browser, navigate to the Client Computers node.
  2. Right-click the <Client>, and then click Properties.
  3. On the Client Computer Properties dialog box, click Advanced.
  4. Click the Additional Settings tab and then click Add.
  1. In the Name box, type nArcMonitorTimeOutInMins. The Category and Type details will be automatically populated.

    Alternatively, you can click Lookup and search for the additional setting using the Find box.

  2. In the Value box, type the interval in minutes.
  3. Click OK to save the additional setting configuration.
  4. Click OK.

Related Reports

The CommCell Configuration report provides the option to include information on configured alerts. See CommCell Configuration Report for details.

Use the following steps to generate CommCell Configuration report:

  1. From the CommCell Console toolbar, click the Reports tab and then click Configuration.

    The Report Selection dialog box appears.

  2. From the Reports pane, ensure that the Alerts check box is selected and then click Run.

    The CommCell Configuration report appears in your default Web browser.