Setting Up Alerts and Notifications - SNMP Traps

Table of Contents

Overview

By using the SNMP protocol, alerts can be sent by a CommServe to other computers. An SNMP trap is sent each time an alert is generated by the CommServe. These traps are sent in the Management Information Protocol (MIB) format as shown in the SNMP Trap Example.

SNMP alerts offer the following benefits:

  • A CommServe computer can send SNMP alerts to multiple computers.
  • Computers can receive the SNMP alerts even if they do not have CommServe software installed.
  • SNMP alert notifications 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.

Note: If the connection is lost between the CommServe computer and the remote computer receiving the trap, the trap will not be re-sent once the connection is restored.

SNMP Version Support

Supported SNMP protocols:

  • SNMP Version 1 (SNMPv1)
  • SNMP Version 3 (SNMPv3)

Adding Client Computers to Receive the SNMP Trap Alerts

You must add the host name or IP address of the computer receiving the SNMP traps to the SNMP service.

Before You Begin

  • Install the SNMP Enabler software on the CommServe computer. See Install the CommServe SNMP Enabler for the installation steps.
  • Install SNMP trap receiver software on the computers that will receive the SNMP traps sent by the CommServe.
  • Have the name of the group of computers that will receive the SNMP traps. This is the name you specified during the installation of the CommServe SNMP Enabler.

Procedure

  1. From the CommServe computer, click Start > Administrative Tools > Services.
  2. Right-click the SNMP Service service and then click Properties.
  3. Click the Traps tab.
  4. In the Community Name box, type the name of the group of computers that will receive SNMP traps and then click Add to list.

    This is the group that you specified during the installation of the CommServe SNMP Enabler.

  5. Under Trap destinations, click Add.
  6. Specify the host name or IP address of the computer receiving the SNMP traps and click Add. Repeat this step to add more destination computers.
  7. Click OK.
  8. Right-click the SNMP Service and then click Restart to restart the services.

Configuring SNMP Alert Notifications

Use the following steps to generate SNMP 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 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.

SNMP Trap Example

The following is an example of an SNMP trap:

Part 1 in the preceding example is the Management Information Base (MIB). The MIB file is automatically installed when the SNMP Enabler is installed and is located at software_installation_path\MIB\Simpana.mib. The MIB contains the following fields:

  • Agent Address: Address of the agent generating the trap.
  • Trap OID: The first part of the Trap OID is the vendor’s identification number of the network management system contained in the entity. In the preceding example, this number is the enterprise identification number. The last two digits of the Trap OID indicate products and the software, respectively.
  • Time Stamp: The time in hundredths of a second since the network management portion of the system was last re-initialized.
  • Generic: The generic trap type. The number 6 in the preceding example means it is enterprise specific.
  • Specific: The specific trap type. Each alert type will be sent using a unique identification number. 

Part 2 in the preceding example is the Varbind OID (object identifier) field. The Varbind OID contains the following information:

  • Trap OID: .1.3.6.1.4.4.14604.2.2.2.3.0
  • Software: .1.3.6.1.4.4.14604.2.2.2.3.0
  • Object Type: .1.3.6.1.4.4.14604.2.2.2.3.0

    For a list of possible object types, see Varbind OID Object Types.

Varbind OID Object Types

The following table lists the possible object types for the Varbind OID. The position of the object type is noted by n: .1.3.6.1.4.4.14604.2.2.2.n.0.

Object Type Definition
3 Alert type
4 Date and time of the alert
5 The CommCell user who performed the operation
6 The CommCell that generated the alert
7 The name of the CommCell client
8 The name of the CommCell agent
9 The name of the CommCell instance
10 The name of the CommCell backup set
11 The name of the CommCell subclient
12 The name of the CommCell MediaAgent
13 The name of the library
14 The name of the media
15 The name of the CommCell storage policy
16 The Job ID
17 The CommCell alert description

If you add additional tokens to the alert notification message, the values for the tokens are sent in object type 17. For example, the <STORAGE POLICIES USED> token is added to the notification message for a data protection alert. The names of the storage policies are sent in object type 17. For a list of tokens available for each alert type and notification type, see Alerts and Notifications - Tokens.

Sending All SNMP Trap Varbinds

In Simpana version 9.0, all varbinds are sent for each SNMP trap. To retain this behavior, you must add the SNMPUseDefaultMsg additional setting. Without this additional setting, the varbinds with the following object types are sent: 3, 4, 5, 6, 7, and 17. For a list of object type definitions, see Varbind OID Object Types.

Procedure

  1. From the CommCell Browser, right-click the CommServe and then click Properties.
  2. In the Commcell Properties dialog box, click the Additional Settings tab and then click Add.
  3. In the Add Additional Settings dialog box, enter the additional setting details for the additional setting:
    1. In the Name box, type SNMPUseDefaultMsg.
    2. In the Category box, select EventManager.
    3. In the Type box, select INTEGER.
    4. In the Value box, enter 1.
  4. Click OK.

SNMP Trap Messages

The alert types that support SNMP notifications have a number assigned to them, for example, 1017 is the number assigned to Library Management alerts. The following table lists the number sent in the SNMP trap for each alert type.

Alert Number OID Alert Type Category Alert Criteria
1001 .1.3.6.1.4.1.14604.2.2.2.0.1001 Data Aging Job Management Failed

Job Activity

Job Succeeded with Errors

Skipped

Succeeded (Not trapped)

1002 .1.3.6.1.4.1.14604.2.2.2.0.1002 Auxiliary Copy Job Management Alert every "n" attempts (Network failures)

Alert every "n" attempts (Phase failures)

Auxiliary copy fallen behind alert Delayed by "n" Hrs

Failed

Job Activity

Job Succeeded with Errors

Skipped

Succeeded (Not trapped)

1003 .1.3.6.1.4.1.14604.2.2.2.0.1003 Data Protection Job Management Alert every "n" attempts (Network failures)

Alert every "n" attempts (Phase failures)

ASR Backup has occurred

Decrease in Data size by <1,2,10,0,-1> %

Delayed by "n" Hrs

Failed

Increase in Data size by <1,2,10,0,-1> %

Job Activity

Job Succeeded with Errors

No Data Protection

Skipped

Succeeded (Not trapped)

1004 .1.3.6.1.4.1.14604.2.2.2.0.1004 Data Recovery Job Management Failed

Job Activity

Job Started

Job Succeeded with Errors

List Media

Skipped

1005 .1.3.6.1.4.1.14604.2.2.2.0.1005 Express Recovery Job Management Delayed by "n" Hrs

Failed

Job Activity

Job Succeeded with Errors

Skipped

Succeeded (Not trapped)

1006 .1.3.6.1.4.1.14604.2.2.2.0.1006 Data Verification Job Management Delayed by "n" Hrs

Failed

Job Activity

Job Succeeded with Errors

Skipped

Succeeded (Not trapped)

1007 .1.3.6.1.4.1.14604.2.2.2.0.1007 Media Inventory Job Management Failed

Job Succeeded with Errors

Succeeded (Not trapped)

1009 .1.3.6.1.4.1.14604.2.2.2.0.1009 Media Erase Job Management Failed

Job Activity

Job Succeeded with Errors

Succeeded (Not trapped)

1010 .1.3.6.1.4.1.14604.2.2.2.0.1010 Clients Configuration Disk Space Low

Properties Modified

1012 .1.3.6.1.4.1.14604.2.2.2.0.1012 CommCell Configuration Alert every <1,3,3,1,-1> failed login attempts

Alert Modified

Disk Space Low

Force deconfigured

Properties Modified

1013 .1.3.6.1.4.1.14604.2.2.2.0.1013 MediaAgents Configuration Disk Space Low

MediaAgent went Offline

Properties Modified

1014 .1.3.6.1.4.1.14604.2.2.2.0.1014 Schedules Configuration Scheduler Changes
1015 .1.3.6.1.4.1.14604.2.2.2.0.1015 Storage Policy Configuration Properties Modified
1016 .1.3.6.1.4.1.14604.2.2.2.0.1016 Library Configuration Properties Modified
1017 .1.3.6.1.4.1.14604.2.2.2.0.1017 Library Management Media Management Insufficient Storage

Maintenance Occurred

Maintenance Required

Media Handling Errors

Media Handling Required

Media Mount and Usage Errors

Media Ready in CAP Alert

Media Recalled

User overwrite of Media

1018 .1.3.6.1.4.1.14604.2.2.2.0.1018 Vault Tracker Media Management Failed

Initiated

Job Succeeded with Errors

Media Handling Required

Media Picked up

Media Reached Destination

Media Returned to Source

Rolled Back

Succeeded (Not trapped)

1019 .1.3.6.1.4.1.14604.2.2.2.0.1019 Download Updates Software Updates Failed

Job Succeeded with Errors

Succeeded (Not trapped)

1020 .1.3.6.1.4.1.14604.2.2.2.0.1020 Install Updates Software Updates Failed

Initiated

Job Succeeded with Errors

Succeeded (Not trapped)

1021 .1.3.6.1.4.1.14604.2.2.2.0.1021 Device Status Media Management Drive went Offline

Library went Offline

Mountpath went Offline

1022 .1.3.6.1.4.1.14604.2.2.2.0.1022 Erase Data Job Management Failed

Job Activity

Job Succeeded with Errors

Skipped

Succeeded (Not trapped)

1023 .1.3.6.1.4.1.14604.2.2.2.0.1023 Exchange Agent Specific Alerts Application Management

(Application Management alerts are deprecated, but existing Application Management alerts are supported.)

Journal Mailboxes message Count Exceeded
1024 .1.3.6.1.4.1.14604.2.2.2.0.1024 Updates Available For Download Software Updates Updates Available
1025 .1.3.6.1.4.1.14604.2.2.2.0.1025 File Replication Alerts Application Management

(Application Management alerts are deprecated, but existing Application Management alerts are supported.)

Log file volume reached low watermark

No log transfer activity

1026 .1.3.6.1.4.1.14604.2.2.2.0.1026 Upgrades and Updates Software Updates Release Upgrade Required

Updates Required

1028 .1.3.6.1.4.1.14604.2.2.2.0.1028 Continuous Data Replication Job Management Alert every "n" attempts (Network failures)

Alert every "n" attempts (Phase failures)

Delayed by "n" Hrs

Failed

Job Activity

Job Succeeded with Errors

Skipped

Succeeded (Not trapped)

1029 .1.3.6.1.4.1.14604.2.2.2.0.1029 Offline Content Indexing   Delayed by "n" Hrs

Failed

Job Activity

Job Succeeded with Errors

Skipped

Succeeded (Not trapped)

1030 .1.3.6.1.4.1.14604.2.2.2.0.1030 SharePoint Agent Specific Alerts   Virtual Servers Added

V2 upgraded to V3

1051 .1.3.6.1.4.1.14604.2.2.2.0.1051 Data Collection Job Management Alert every "n" attempts (Network failures)

Alert every "n" attempts (Phase failures)

Failed

Job Activity

Job Succeeded with Errors

No Data Protection

Skipped

Succeeded (Not trapped)

1052 .1.3.6.1.4.1.14604.2.2.2.0.1052 Report Job Management Failed

Job Activity

Job Succeeded with Errors

Skipped

Succeeded (Not trapped)

1053 .1.3.6.1.4.1.14604.2.2.2.0.1053 Information Management Job Management Delayed by "n" Hrs

Failed

Job Activity

Job Succeeded with Errors

Skipped

Succeeded (Not trapped)

1054 .1.3.6.1.4.1.14604.2.2.2.0.1054 Media Refreshing Job Management Alert every "n" attempts (Phase failures)

Alert every "n" attempts (Network failures)

Delayed by "n" Hrs

Job Activity

Job Failed

Job Succeeded with Errors

1055 .1.3.6.1.4.1.14604.2.2.2.0.1055 DeDup DB Reconstruction Job Management Delayed by "n" Hrs

Alert every "n" attempts (Phase failures)

Alert every "n" attempts (Network failures)

Job Failed

Job Skipped

Job Started

Job succeeded with Errors

1056 .1.3.6.1.4.1.14604.2.2.2.0.1056 Report Job Management Job Failed

Job Skipped

Job Succeeded with Errors

1057 .1.3.6.1.4.1.14604.2.2.2.0.1057 Log Monitoring Operation Matched log monitor data
1058 .1.3.6.1.4.1.14604.2.2.2.0.1058 Event Viewer Events Operation Severity

Job ID

Program

CommCell

Event Code

Description

1059 .1.3.6.1.4.1.14604.2.2.2.0.1059 Client Group Configuration Properties Modified
1060 .1.3.6.1.4.1.14604.2.2.2.0.1060 License Configuration Alert CommServe License Expires Within "n" Days

Alert when Licenses Consumed reaches "n" Percent

1061 .1.3.6.1.4.1.14604.2.2.2.0.1061 Backup Copy Workflow Job Management Job Activity

Job Failed

Job Skipped

Job Started

Job Succeeded with Errors

1062 .1.3.6.1.4.1.14604.2.2.2.0.1062 Windows Event Log Monitoring Operation Matched log monitor data
1063 .1.3.6.1.4.1.14604.2.2.2.0.1063 Workflow Job Management Job Failed

Job Skipped

Job Started

Job Succeeded with Errors

1064 .1.3.6.1.4.1.14604.2.2.2.0.1064 Virtualize ME Job Management Job Failed

Job Succeeded

Job Succeeded with Errors