System Management Configuration Guide for Cisco 8000 Series Routers, Cisco IOS XR Releases

PDF

System Management Configuration Guide for Cisco 8000 Series Routers, Cisco IOS XR Releases

Call Home Alert Groups

Want to summarize with AI?

Log in

Describes Call Home alert groups, which categorize system events into predefined subsets to trigger targeted notifications based on severity levels and associated CLI command outputs, ensuring relevant diagnostic data reaches the appropriate support destinations.


An alert group is a predefined subset of alerts or events that Call Home detects and reports to one or more destinations. Alert groups allow you to select the set of alerts that you want to send to a predefined or custom destination profile. Alerts are sent to e-mail or HTTP destinations in a destination profile only if that alert belongs to one of the alert groups associated with that destination profile and if the alert has a Call Home message severity at or above the message severity set in the destination profile. The inventory and configuration alert groups do not have the severity limit.

The following table lists supported alert groups and the default CLI command output included in Call Home messages generated for the alert group.

Table 1. Alert Groups and Executed Commands

Alert Group

Description

Executed Commands

Environmental

Events related to power, fan, and environment-sensing elements such as temperature alarms.

  • show environment

  • show logging

  • show inventory

  • show environment trace

  • show diag

Inventory

Inventory status that is provided whenever a unit is cold booted, or when FRUs are inserted or removed. This alert is considered a noncritical event, and the information is used for status and entitlement.

  • show platform

  • show version

  • show diag

  • show inventory oid

Syslog

Events generated by specific interesting syslog messages

  • show version

  • show logging

  • show inventory

Configuration

User-generated request for configuration or configuration change event.

  • show version

  • show running config all

  • show inventory

  • show configuration history last 30

  • show configuration commit changes last 1

Snapshot

This alert group can be configured for periodic notifications

By default, this alert group has no commands to be run. You can add the required commands that need to be run.

Call Home maps the syslog severity level to the corresponding Call Home severity level for syslog port group messages.


Call Home Message Levels

Call Home allows you to filter messages based on their level of urgency. You can associate each destination profile (predefined and user-defined) with a Call Home message level threshold. The Call Home message level ranges from 0 (lowest level of urgency) to 9 (highest level of urgency). Call Home messages are generated if they have a severity level equal to or greater than the Call Home message level threshold for the destination profile.

Call Home messages that are sent for syslog alert groups have the syslog severity level mapped to the Call Home message level.

Note

Call Home does not change the syslog message level in the message text.

The following table lists each Call Home message level keyword and the corresponding syslog level for the syslog port alert group.

Table 2. Severity and syslog Level Mapping

Call Home Level

Keyword

syslog Level

Description

9

Catastrophic

Not-Applicable

Network-wide catastrophic failure.

8

Disaster

Not-Applicable

Significant network impact.

7

Fatal

Emergency (0)

System is unusable.

6

Critical

Alert (1)

Critical conditions that indicate that immediate attention is needed.

5

Major

Critical (2)

Major conditions.

4

Minor

Error (3)

Minor conditions.

3

Warning

Warning (4)

Warning conditions.

2

Notification

Notice (5)

Basic notification and informational messages. Possibly independently insignificant.

1

Normal

Information (6)

Normal event signifying return to normal state.

Debugging

Debug (7)

Debugging messages.


Associating an Alert Group with a Destination Profile

An alert is sent only to destination profiles that have subscribed to the Call Home alert group.

Before you begin

Use the show call-home alert-group command to view available alert groups.

Procedure

1.

call-home

Example:

Router#configure
Router(config)# call-home
Router(config-call-home)#

Enters call home configuration mode.

2.

profile profile-name

Example:


Router(config-call-home)# profile my_profile
Router(config-call-home-profile)#

Enters call home profile configuration mode to configure a new or existing profile.

3.

subscribe-to-alert-group inventory [periodic {daily | monthly day-of-month | weekly day-of-week} hh:mm

Example:


Router(config-call-home-profile)# subscribe-to-alert-group 
inventory periodic monthly 1 10:00

Configures a destination profile to receive messages for the inventory alert group. Either alerts are sent periodically, or any non-normal event triggers an alert.

4.

subscribe-to-alert-group syslog severity severity-level pattern string

Example:


Router(config-call-home-profile)# subscribe-to-alert-group 
syslog severity major pattern 

Configures a destination profile to receive messages for the syslog alert group. Alerts with a severity the same or greater than the specified severity level are sent.

  • catastrophic —Includes network-wide catastrophic events in the alert. This is the highest severity.

  • critical —Includes events requiring immediate attention (system log level 1).

  • disaster —Includes events with significant network impact.

  • fatal —Includes events where the system is unusable (system log level 0).

  • major —Includes events classified as major conditions (system log level 2).

  • minor —Includes events classified as minor conditions (system log level 3)

  • normal —Specifies the normal state and includes events classified as informational (system log level 6). This is the default.

  • notification —Includes events informational message events (system log level 5).

  • warning —Includes events classified as warning conditions (system log level 4).

You can specify a pattern to be matched in the syslog message. If the pattern contains spaces, you must enclose it in quotes ("").

5.

subscribe-to-alert-group snapshot severity severity-level pattern string

Example:


Router(config-call-home-profile)# subscribe-to-alert-group 
snapshot severity major pattern 

Configures a destination profile to receive messages for the snapshot alert group. Alerts with a severity the same or greater than the specified severity level are sent.

You can specify a pattern to be matched in the syslog message. If the pattern contains spaces, you must enclose it in quotes ("").

6.

subscribe-to-alert-group configuration severity severity-level pattern string

Example:


Router(config-call-home-profile)# subscribe-to-alert-group configuration severity major pattern 

Configures a destination profile to receive messages for the configuration alert group. Alerts with a severity the same or greater than the specified severity level are sent.

You can specify a pattern to be matched in the syslog message. If the pattern contains spaces, you must enclose it in quotes ("").

7.

Use the commit or end command.

What to do next

Use the show call-home profile command to view the profile configurations.