Configuring Platform Event Filters

Available Languages

Download Options

  • PDF     (450.7 KB)
    View with Adobe Reader on a variety of devices
Updated:March 11, 2011

Bias-Free Language

The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.

Configuring Platform Event Filters

Configuring Platform Event Filters

This chapter includes the following sections:

Platform Event Filters

A platform event filter (PEF) can trigger an action and generate an alert when a critical hardware-related event occurs. For each PEF, you can choose the action to be taken (or take no action) when a platform event occurs. You can also choose to generate and send an alert when a platform event occurs. Alerts are sent as an SNMP trap, so you must configure an SNMP trap destination before the alerts can be sent.

You can globally enable or disable the generation of platform event alerts. When disabled, alerts are not sent even if PEFs are configured to send them.

Enabling Platform Event Alerts

Procedure
  Command or Action Purpose
Step 1 Server# scope fault  

Enters the fault command mode.

 
Step 2 Server /fault # set platform-event-enabled yes  

Enables platform event alerts.

 
Step 3 Server /fault # commit  

Commits the transaction to the system configuration.

 
Step 4 Server /fault # show [detail]  

(Optional) Displays the platform event alert configuration.

 

The following example enables platform event alerts:

Server# scope fault
Server /fault # set platform-event-enabled yes
Server /fault *# commit
Server /fault # show
SNMP Community String Platform Event Enabled  
--------------------- ----------------------- 
public                yes                    

Server /fault #

Disabling Platform Event Alerts

Procedure
  Command or Action Purpose
Step 1 Server# scope fault  

Enters the fault command mode.

 
Step 2 Server /fault # set platform-event-enabled no  

Disables platform event alerts.

 
Step 3 Server /fault # commit  

Commits the transaction to the system configuration.

 
Step 4 Server /fault # show [detail]  

(Optional) Displays the platform event alert configuration.

 

The following example disables platform event alerts:

Server# scope fault
Server /fault # set platform-event-enabled no
Server /fault *# commit
Server /fault # show
SNMP Community String Platform Event Enabled  
--------------------- ----------------------- 
public                no                     

Server /fault #

Configuring Platform Event Filters

You can configure actions and alerts for the following platform event filters:

ID Platform Event Filter

1

Temperature Critical Assert Filter

2

Temperature Warning Assert Filter

3

Voltage Critical Assert Filter

5

Current Assert Filter

6

Fan Critical Assert Filter

8

Processor Assert Filter

9

Power Supply Critical Assert Filter

10

Power Supply Warning Assert Filter

11

Power Supply Redundancy Lost Filter

12

Discrete Power Supply Assert Filter

13

Memory Assert Filter

14

Drive Slot Assert Filter
Procedure
  Command or Action Purpose
Step 1 Server# scope fault  

Enters the fault command mode.

 
Step 2 Server /fault # scope pef id  

Enters the platform event filter command mode for the specified event.

See the Platform Event Filter table for event ID numbers.

 
Step 3 Server /fault/pef # set action {none | reboot | power-cycle | power-off}  

Selects the desired system action when this event occurs. The action can be one of the following:


  • none —No system action is taken.

  • reboot —The server is rebooted.

  • power-cycle —The server is power cycled.

  • power-off —The server is powered off.

 
Step 4 Server /fault/pef # set send-alert {yes | no}  

Enables or disables the sending of a platform event alert for this event.

Note   

For an alert to be sent, the filter trap settings must be configured properly and platform event alerts must be enabled.
 
Step 5 Server /fault/pef # commit  

Commits the transaction to the system configuration.

 

This example configures the platform event alert for an event:

Server# scope fault
Server /fault # scope pef 13
Server /fault/pef # set action reboot
Server /fault/pef *# set send-alert yes
Server /fault/pef *# commit
Server /fault/pef # show
Platform Event Filter Event                       Action      Send Alert         
--------------------- --------------------------- ----------- ------------------ 
13                    Memory Assert Filter        reboot      yes              

Server /fault/pef #
What to Do Next

If you configure any PEFs to send an alert, complete the following tasks:


  • Enable platform event alerts

  • Configure SNMP trap settings

Configuring SNMP Trap Settings

Before You Begin

You must log in with admin privileges to perform this task.


Procedure
  Command or Action Purpose
Step 1 Server# scope fault  

Enters the fault command mode.

 
Step 2 Server /fault # set community-str string  

Enter the name of the SNMP community to which trap information should be sent.

 
Step 3 Server /fault # scope trap-destination number  

Enters the SNMP trap destination command mode for the specified destination. Four SNMP trap destinations are available. The destination number is an integer between 1 and 4.

 
Step 4 Server /fault/trap-destination # set enabled {yes | no}  

Enables or disables the SNMP trap destination.

 
Step 5 Server /fault/trap-destination # set addr ip-address  

Specifies the destination IP address to which SNMP trap information is sent.

 
Step 6 Server /fault/trap-destination # commit  

Commits the transaction to the system configuration.

 

This example configures the SNMP trap destination:

Server# scope fault
Server /fault # set community-str public
Server /fault *# scope trap-destination 1
Server /fault/trap-destination # set enabled yes
Server /fault/trap-destination *# set addr 10.20.30.41
Server /fault/trap-destination *# commit
Server /fault/trap-destination # show
Trap Destination IP Address       Enabled  
---------------- ---------------- -------- 
1                10.20.30.41      yes      

Server /fault/trap-destination #

Sending a Test SNMP Trap Message

Before You Begin

You must log in with admin privileges to perform this task.


Procedure
  Command or Action Purpose
Step 1 Server# scope fault  

Enters the fault command mode.

 
Step 2 Server /fault # scope trap-destination number  

Enters the SNMP trap destination command mode for the specified destination. Four SNMP trap destinations are available. The destination number is an integer between 1 and 4.

 
Step 3 Server /fault/trap-destination # sendSNMPtrap  

Sends a test message to the SNMP trap destination.

Note   

The trap must be configured and enabled in order to send a test message.

 

This example sends a test message to SNMP trap destination 1:

Server# scope fault
Server /fault # scope trap-destination 1
Server /fault/trap-destination # sendSNMPtrap
SNMP Test Trap sent to Destination:1
Server /fault/trap-destination #

Was this Document Helpful?

FeedbackFeedback

Contact Cisco

This Document Applies to These Products