Applies To:Show Versions
- 2.2 PTF-02, 2.2 PTF-01, 2.2.0
SNMP, MIBs, Traps, and Alerts
Working with SNMP and alerts
Alerts push system information to administrators by sending messages to a user-defined destination IP address or through email. Alerts can let administrators know the status of the machines so that the administrator does not have to monitor all the systems on the machine. Alerts can also be configured to automatically start scripts or executables based on system events so that the administrator does not have to.
Default alerts work with an SNMP agent (snmpd). The GLOBAL-SITE Controller ships with a customized simple network management protocol (SNMP) agent and management information base (MIB). The MIB contains the GLOBAL-SITE Controller's default alerts. The SNMP agent listens for events and triggers alerts when a preconfigured event occurs.
User-defined alerts that can be manually triggered or can be triggered using a Perl script.
This chapter describes the configuration tasks with which you can configure the GLOBAL-SITE Controller SNMP agent and how to customize default and user-defined alerts.
Warning: We assume that you have prior knowledge and experience with SNMP to understand some of the concepts and terminology from this chapter.
You configure the SNMP agent and alerts through the ITCMconsole. If you are unfamiliar with the ITCMconsole, please see Chapter 6, ITCMconsole Command Line Interface for more information on the ITCMconsole and a complete listing of SNMP and alert commands and subcommands.
Note: You configure alerts and the snmpd using the ITCMconsole. While some of the pertinent commands are listed in this chapter, you can find all the commands and subcommands in ITCMconsole Command Line Interface, on page 6-1 of this guide.
By default, the GLOBAL-SITE Controller runs the SNMP agent (snmpd). You can enable and disable, start and stop the agent, and set the SNMP trap values from the ITCMconsole (see Using the ITCMconsole, on page 6-1). If you are going to use default alerts, you have to add values to the SNMP trap:
In this case, public
The destination IP address that the snmpd sends the trap to when it triggers
The port that the default alert uses to communicate with the destination IP address
To configure snmpd
The following commands configure the trap values. At the ITCMconsole prompt, type:
service snmpd trap community public
service snmpd trap dest <ip address>
service snmpd trap port <port>
The GLOBAL-SITE Controller uses several open source MIBs as well as the GLOBAL-SITE MIB, which is a product-specific MIB that polls pertinent data from your GLOBAL-SITE Controller. You can find a text file of the MIB on the Documentation section of the documentation CD, or from the GLOBAL-SITE MIB link on the GLOBAL-SITE Controller main web-based user interface page.
Default and user-defined alerts
There are two kinds of alerts on the GLOBAL-SITE Controller: default alerts and user-defined alerts. Since the snmpd runs by default on your GLOBAL-SITE Controller, the default alerts are already enabled. User-defined alerts are alerts you create to meet your needs. To see all alerts, from the ITCMconsole prompt, type:
show alert all
Figure 7.1 is a sample of the output you receive when you type show alert all from the ITCMconsole prompt.
Using global settings
The alert system was designed with global settings to make modifying default alerts and creating and modifying user-defined alerts faster and easier. For more information on global settings for alerts, please see Changing global settings, on page 6-10 of this guide.
/*DESCRIPTION*/ "A disk drive has failed."
/*DESCRIPTION*/ "There is not enough memory to complete an operation."
/*DESCRIPTION*/ "The CPU usage exceeds its threshold."
/*DESCRIPTION*/ "The data disk is full."
/*DESCRIPTION*/ "The configuration disk is full."
/*DESCRIPTION*/ "Publication succeeded."
/*DESCRIPTION*/ "Publication failed."
/*DESCRIPTION*/ "There is no new version of this publication."
Default alerts consist of a name and a description. Some default alerts also have an OID (object identifier). Default alerts that have an OID are part of the GLOBAL-SITE MIB and are triggered by events. There are eight default alerts that the following events trigger:
- Disk drive failure
- Insufficient memory to complete an operation
- CPU usage exceeding its threshold
- Full data disk
- Full configuration disk
- Successful publication
- Failed publication
- No new version of a publication
Modifying default alerts
You can add actions to or delete user-defined actions from default alerts, but you cannot delete default alerts, change the name of the default alert, or change the OID. Actions can be either named_action, email, or exec. For example, upon successful publication of a site, the snmpd sends the GLOBALSITE.globalsiteTrapPublicationSucceeded default alert "Publication succeeded" to the destination IP address. You can modify the default alert and add an action to send email to additional people informing them of the successful publication, as well.
To modify a default alert
To modify an alert, you first need to know the name of that alert. Default alert names are fairly long and must be typed accurately. You can also find the names of the default alerts in the GLOBAL-SITE MIB. (You can access this from the GLOBAL-SITE Controller home page or from the Documentation section of the product splash screen.)
Tip: If you are accessing the GLOBAL-SITE Controller from an SSH application, and this application allows you to copy and paste, we recommend you do so.
- To get the name of the default alert from the ITCMconsole, type:
show alert all
- If possible, copy the name of the default alert you want to modify.
- From the ITCMconsole, type:
alert modify add_action
- At the prompt for Alert name, paste or type the name of the default alert.
- Choose to add an action.
· A named_action is an user-defined action that you created previously. (Please see named_action, on page 6-7 for information on creating a named action.) At the prompt, type the name of the named action.
· An email action allows you to send an email (please see email, on page 6-6 for more information). At the prompt, type email.
· An exec action allows you to run scripts or executables at the time the alert is sent (please see exec, on page 6-6 ). At the prompt, type exec.
Creating user-defined alerts
From the ITCMconsole, you can create your own user-defined alerts using the alert commands.
The show alert all command displays both default alerts and user-defined alerts. If you modify an alert, you need its name which you get with the show command.
To create or modify a user-defined alert
- From the ITCMconsole, type:
- At the prompt for Alert name, type a name for the alert.
- Choose to add either a named action, email, or exec as your action.
· A named_action is an user-defined action that you created previously. (Please see exec, on page 6-6 for information on creating a named action.) At the prompt, type the name of the named action you created.
· An email action allows you to send an email. At the prompt, type email (see email, on page 6-6 for more information). The steps that follow ask you for the to address, from address, body text, and if you want to add an attachment, the attachment name.
· An exec action allows you to run scripts or executables at the time the alert is sent (see exec, on page 6-6 for more information). At the prompt, type exec. The step that follows asks you for a command to execute when the alert is raised and for a description of the alert.
Triggering user-defined alerts
The alert raise <alert name> <args> command triggers alerts. If you type the command at the ITCMconsole command prompt, the alert triggers right away. You can also put the alert raise command in a bash or a Perl script and have it run that way.