Cisco 7600 Series Cisco IOS Software Configuration Guide, 12.2SR
Configuring Call Home

Table Of Contents

Configuring Call Home

Understanding Call Home

Obtaining Smart Call Home

Configuring Call Home

Configuring Contact Information

Configuring Destination Profiles

Copying a Destination Profile

Subscribing to Alert Groups

Configuring Periodic Notification

Configuring Message Severity Threshold

Configuring Syslog Pattern Matching

Configuring General E-Mail Options

Enabling Call Home

Testing Call Home Communications

Sending a Call Home Test Message Manually

Sending a Call Home Alert Group Message Manually

Configuring and Enabling Smart Call Home

Displaying Call Home Configuration Information

Default Settings

Alert Group Trigger Events and Commands

Message Contents

Sample Syslog Alert Notification in Long-Text Format

Sample Syslog Alert Notification in XML Format


Configuring Call Home


This chapter describes how to configure the Call Home feature in Cisco IOS Software Release 12.2SX.


Note For complete syntax and usage information for the commands used in this chapter, see the Cisco IOS Software Releases 12.2SX Command References at this URL: http://www.cisco.com/en/US/products/ps6922/prod_command_reference_list.html


This chapter includes the following sections:

Understanding Call Home

Configuring Call Home

Displaying Call Home Configuration Information

Default Settings

Alert Group Trigger Events and Commands

Message Contents

Understanding Call Home

Call Home provides e-mail-based and web-based notification of critical system events. A versatile range of message formats are available for optimal compatibility with pager services, standard e-mail, or XML-based automated parsing applications. Common uses of this feature may include direct paging of a network support engineer, e-mail notification to a Network Operations Center, XML delivery to a support website, and utilization of Cisco Smart Call Home services for direct case generation with the Cisco Systems Technical Assistance Center (TAC).

The Call Home feature can deliver alert messages containing information on configuration, diagnostics, environmental conditions, inventory, and syslog events.

The Call Home feature can deliver alerts to multiple recipients, referred to as Call Home destination profiles, each with configurable message formats and content categories. A predefined destination profile is provided for sending alerts to the Cisco TAC, and you also can define your own destination profiles.

Flexible message delivery and format options make it easy to integrate specific support requirements.

The Call Home feature offers the following advantages:

Multiple message-format options:

Short Text—Suitable for pagers or printed reports.

Plain Text—Full formatted message information suitable for human reading.

XML—Matching readable format using Extensible Markup Language (XML) and Adaptive Markup Language (AML) document type definitions (DTDs). The XML format enables communication with the Cisco TAC.

Multiple concurrent message destinations.

Multiple message categories including configuration, diagnostics, environmental conditions, inventory, and syslog events.

Filtering of messages by severity and pattern matching.

Scheduling of periodic message sending.

Obtaining Smart Call Home

If you have a service contract directly with Cisco Systems, you can register your devices for the Smart Call Home service. Smart Call Home provides fast resolution of system problems by analyzing Call Home messages sent from your devices and providing background information and recommendations. For issues that can be identified as known, particularly GOLD diagnostics failures, Automatic Service Requests will be generated with the Cisco TAC.

Smart Call Home offers the following features:

Continuous device health monitoring and real-time diagnostics alerts.

Analysis of call home messages from your device and, where appropriate, Automatic Service Request generation, routed to the appropriate TAC team, including detailed diagnostic information to speed problem resolution.

Secure message transport directly from your device or through a downloadable Transport Gateway (TG) aggregation point. You can use a TG aggregation point in cases requiring support for multiple devices or in cases where security requirements mandate that your devices may not be connected directly to the Internet.

Web-based access to Call Home messages and recommendations, inventory and configuration information for all Call Home devices. Provides access to associated Field Notices, Security Advisories and End-of-Life Information.

You need the following items to register:

The SMARTnet contract number for your switch.

Your e-mail address

Your Cisco.com ID

For detailed information on Smart Call Home, see the Smart Call Home page at this location:

http://www.cisco.com/go/smartcall/

Configuring Call Home

How you configure Call Home depends on how you intend to use the feature. Some information to consider before you configure Call Home includes:

At least one destination profile (predefined or user-defined) must be configured. The destination profile(s) used depends on whether the receiving entity is a pager, e-mail, or automated service such as Cisco Smart Call Home.

If the destination profile uses e-mail message delivery, you must specify a Simple Mail Transfer Protocol (SMTP) server.

If the destination profile uses secure HTTP (HTTPS) message transport, you must configure a trustpoint certificate authority (CA).

The contact e-mail, phone, and street address information should be configured so that the receiver can determine the origin of messages received.

The switch must have IP connectivity to an e-mail server or the destination HTTP server.

If Cisco Smart Call Home is used, an active service contract must cover the device being configured.

To configure Call Home, follow these steps:


Step 1 Configure your site's contact information.

Step 2 Configure destination profiles for each of your intended recipients.

Step 3 Subscribe each destination profile to one or more alert groups, and set alert options.

Step 4 Configure e-mail settings or HTTPS settings (including CA certificate), depending on the transport method.

Step 5 Enable the Call Home feature.

Step 6 Test Call Home messages.



Tip From the Smart Call Home web application, you can download a basic configuration script to assist you in the configuration of the Call Home feature for use with Smart Call Home and the Cisco TAC. The script will also assist in configuring the trustpoint CA for secure communications with the Smart Call Home service. The script, provided on an as-is basis, can be downloaded from this URL: http://www.cisco.com/go/smartcall/


Configuring Contact Information

Each switch must include a contact e-mail address. You can optionally include a phone number, street address, contract ID, customer ID, and site ID.

To assign the contact information, perform this task:

 
Command
Purpose

Step 1 

Router# configure terminal

Enters configuration mode.

Step 2 

Router(config)# call-home

Enters the Call Home configuration submode.

Step 3 

Router(cfg-call-home)# contact-email-addr email-address

Assigns the customer's e-mail address. Enter up to 200 characters in e-mail address format with no spaces.

Step 4 

Router(cfg-call-home)# phone-number +phone-number

(Optional) Assigns the customer's phone number.

Note The number must begin with a plus (+) prefix, and may contain only dashes (-) and numbers. Enter up to 16 characters. If you include spaces, you must enclose your entry in quotes ("").

Step 5 

Router(cfg-call-home)# street-address street-address

(Optional) Assigns the customer's street address where RMA equipment can be shipped. Enter up to 200 characters. If you include spaces, you must enclose your entry in quotes ("").

Step 6 

Router(cfg-call-home)# customer-id text

(Optional) Identifies the customer ID. Enter up to 64 characters. If you include spaces, you must enclose your entry in quotes ("").

Step 7 

Router(cfg-call-home)# site-id text

(Optional) Identifies the customer site ID. Enter up to 200 characters. If you include spaces, you must enclose your entry in quotes ("").

Step 8 

Router(cfg-call-home)# contract-id text

(Optional) Identifies the customer's contract ID for the switch. Enter up to 64 characters. If you include spaces, you must enclose your entry in quotes ("").

This example shows the configuration of contact information:

Router# configure terminal 
Enter configuration commands, one per line.  End with CNTL/Z.

Router(config)# call-home

Router(cfg-call-home)# contact-email-addr username@example.com

Router(cfg-call-home)# phone-number +1-800-555-4567

Router(cfg-call-home)# street-address "1234 Picaboo Street, Any city, Any state, 12345"

Router(cfg-call-home)# customer-id Customer1234

Router(cfg-call-home)# site-id Site1ManhattanNY

Router(cfg-call-home)# contract-id Company1234

Router(cfg-call-home)# exit

Router(config)#

Configuring Destination Profiles

A destination profile contains the required delivery information for an alert notification. At least one destination profile is required. You can configure multiple destination profiles of one or more types.

You can use the predefined destination profile or define a desired profile. If you define a new destination profile, you must assign a profile name.


Note If you use the Cisco Smart Call Home service, the destination profile must use the XML message format.


You can configure the following attributes for a destination profile:

Profile name—A string that uniquely identifies each user-defined destination profile. The profile name is limited to 31 characters and is not case-sensitive. You cannot use all as a profile name.

Transport method—The transport mechanism, either e-mail or HTTP (including HTTPS), for delivery of alerts.

For user-defined destination profiles, e-mail is the default, and you can enable either or both transport mechanisms. If you disable both methods, e-mail will be enabled.

For the predefined Cisco TAC profile, HTTP is the only method allowed.

Destination address—The actual address related to the transport method to which the alert should be sent.

Message formatting—The message format used for sending the alert. The format options for a user-defined destination profile are long-text, short-text, or XML. The default is XML.

Message size—The maximum destination message size. The valid range is 50 to 3,145,728 bytes and the default is 3,145,728 bytes.

To create and configure a destination profile, perform this task:

 
Command
Purpose

Step 1 

Router# configure terminal

Enters configuration mode.

Step 2 

Router(config)# call-home

Enters the Call Home configuration submode.

Step 3 

Router(cfg-call-home)# profile name

Enters the Call Home destination profile configuration submode for the specified destination profile. If the specified destination profile does not exist, it is created.

Router(cfg-call-home)# no profile name

Deletes the named user-defined destination profile.

Router(cfg-call-home)# no profile all

Deletes all user-defined destination profiles.

Step 4 

Router(cfg-call-home-profile)# [no] destination transport-method {email | http}

(Optional) Enables the message transport method. The no option disables the method.

Step 5 

Router(cfg-call-home-profile)# des- tination address {email email-ad- dress | http url}

Configures the destination e-mail address or URL to which Call Home messages will be sent.

Note When entering a destination URL, include either http:// or https://, depending on whether the server is a secure server. If the destination is a secure server, you must also configure a trustpoint CA.

Step 6 

Router(cfg-call-home-profile)# des- tination preferred-msg-format {long-text | short-text | xml}

(Optional) Configures a preferred message format. The default is XML.

Step 7 

Router(cfg-call-home-profile)# des- tination message-size bytes

(Optional) Configures a maximum destination message size for the destination profile.

Step 8 

Router(cfg-call-home-profile)# ac- tive

Enables the destination profile. By default, the profile is enabled when it is created.

Router(cfg-call-home-profile)#
no active

Disables the destination profile.

Step 9 

Router(cfg-call-home-profile)# exit

Exits the Call Home destination profile configuration submode and returns to the Call Home configuration submode.

Step 10 

Router(cfg-call-home)# end

Returns to privileged EXEC mode.

Step 11 

Router# show call-home profile {name | all}

Displays destination profile configuration for specified profile or all configured profiles.

Copying a Destination Profile

To create a new destination profile by copying an existing profile, perform this task:

 
Command
Purpose

Step 1 

Router# configure terminal

Enters configuration mode.

Step 2 

Router(config)# call-home

Enters the Call Home configuration submode.

Step 3 

Router(cfg-call-home)# copy profile source-profile target-profile

Creates a new destination profile with the same configuration settings as the existing destination profile.

Subscribing to Alert Groups

An alert group is a predefined subset of Call Home alerts supported in all switches. Different types of Call Home alerts are grouped into different alert groups depending on their type. These alert groups are available:

Configuration

Diagnostic

Environment

Inventory

Syslog

The triggering events for each alert group are listed in the "Alert Group Trigger Events and Commands" section, and the contents of the alert group messages are listed in the "Message Contents" section.

You can select one or more alert groups to be received by a destination profile.


Note A Call Home alert is only sent to destination profiles that have subscribed to the alert group containing that Call Home alert. In addition, the alert group must be enabled.


To subscribe a destination profile to an alert group, perform this task:

 
Command
Purpose

Step 1 

Router# configure terminal

Enters configuration mode.

Step 2 

Router(config)# call-home

Enters Call Home configuration submode.

Step 3 

Router(cfg-call-home)# alert-group {all|con- figuration|diagnostic|
environment|inventory|syslog}

Enables the specified alert group. Use the keyword all to enable all alert groups. By default, all alert groups are enabled.

Router(cfg-call-home)# no alert-group {all|configuration|diagnostic|
environment|inventory|syslog}

Disables the specified alert group. Use the keyword all to disable all alert groups.

Step 4 

Router(cfg-call-home)# profile name

Enters the Call Home destination profile configuration submode for the specified destination profile.

Step 5 

Router(cfg-call-home-profile)# sub- scribe-to-alert-group configuration
[periodic {daily hh:mm | monthly date hh:mm | weekly day hh:mm}]

Subscribes this destination profile to the Configuration alert group. The Configuration alert group can be configured for periodic notification, as described in the "Configuring Periodic Notification" section.

Router(cfg-call-home-profile)# sub- scribe-to-alert-group all

Subscribes to all available alert groups.

Router(cfg-call-home-profile)#
no subscribe-to-alert-group {all|configura- tion|diagnostic|
environment|inventory|syslog}

Unsubscribes to the specified alert group. Use the keyword all to unsubscribe to all alert groups.

Step 6 

Router(cfg-call-home-profile)# sub- scribe-to-alert-group diagnostic
[severity catastrophic|disaster|
fatal|critical|major|minor|warning|
notification|normal|debugging]

Subscribes this destination profile to the Diagnostic alert group. The Diagnostic alert group can be configured to filter messages based on severity, as described in the "Configuring Message Severity Threshold" section.

Step 7 

Router(cfg-call-home-profile)# sub- scribe-to-alert-group environment
[severity catastrophic|disaster|
fatal|critical|major|minor|warning|
notification|normal|debugging]

Subscribes this destination profile to the Environment alert group. The Environment alert group can be configured to filter messages based on severity, as described in the "Configuring Message Severity Threshold" section.

Step 8 

Router(cfg-call-home-profile)# sub- scribe-to-alert-group inventory
[periodic {daily hh:mm | monthly date hh:mm | weekly day hh:mm}]

Subscribes this destination profile to the Inventory alert group. The Inventory alert group can be configured for periodic notification, as described in the "Configuring Periodic Notification" section.

Step 9 

Router(cfg-call-home-profile)# sub- scribe-to-alert-group syslog
[severity catastrophic|disaster|
fatal|critical|major|minor|warning|
notification|normal|debugging]
[pattern string]

Subscribes this destination profile to the Syslog alert group. The Syslog alert group can be configured to filter messages based on severity, as described in the "Configuring Message Severity Threshold" section. You can specify a pattern to be matched in the syslog message. If the pattern contains spaces, you must enclose it in quotes ("").

Step 10 

Router(cfg-call-home-profile)# exit

Exits the Call Home destination profile configuration submode.

Configuring Periodic Notification

When you subscribe a destination profile to either the Configuration or the Inventory alert group, you can choose to receive the alert group messages asynchronously or periodically at a specified time. The sending period can be one of the following:

Daily—Specify the time of day to send, using an hour:minute format hh:mm, with a 24-hour clock (for example, 14:30).

Weekly—Specify the day of the week and time of day in the format day hh:mm, where the day of the week is spelled out (for example, monday).

Monthly—Specify the numeric date, from 1 to 31, and the time of day, in the format date hh:mm.

Configuring Message Severity Threshold

When you subscribe a destination profile to the Diagnostic, Environment, or Syslog alert group, you can set a threshold for the sending of alert group messages based on the message's level of severity. Any message with a value lower than the destination profile's specified threshold is not sent to the destination.

1The severity threshold is configured using the keywords in Table 55-1, and ranges from catastrophic (level 9, highest level of urgency) to debugging (level 0, lowest level of urgency). If no severity threshold is configured, the default is normal (level 1).


Note Call Home severity levels are not the same as system message logging severity levels.


Table 55-1 Severity and Syslog Level Mapping 

Level
Keyword
Syslog Level
Description

9

catastrophic

N/A

Network-wide catastrophic failure.

8

disaster

N/A

Significant network impact.

7

fatal

Emergency (0)

System is unusable.

6

critical

Alert (1)

Critical conditions, immediate attention 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.

0

debugging

Debug (7)

Debugging messages.


Configuring Syslog Pattern Matching

When you subscribe a destination profile to the Syslog alert group, you can optionally specify a text pattern to be matched within each syslog message. If you configure a pattern, a Syslog alert group message will be sent only if it contains the specified pattern and meets the severity threshold. If the pattern contains spaces, you must enclose it in quotes ("") when configuring it. You can specify up to five patterns for each destination profile.

Configuring General E-Mail Options

To use the e-mail message transport, you must configure at least one Simple Mail Transfer Protocol (SMTP) e-mail server address. You can configure the from and reply-to e-mail addresses, and you can specify up to four backup e-mail servers. You can also set a rate limit on e-mail or HTTP messages.

To configure general e-mail options, perform this task:

 
Command
Purpose

Step 1 

Router# configure terminal

Enters configuration mode.

Step 2 

Router(config)# call-home

Enters Call Home configuration submode.

Step 3 

Router(cfg-call-home)# mail-server {ipv4-address | name} priority number

Assigns an e-mail server address and its relative priority among configured e-mail servers.

Provide either:

the e-mail server's IP address or

the e-mail server's fully qualified domain name (FQDN) of 64 characters or less.

Assign a priority number between 1 (highest priority) and 100 (lowest priority).

Router(cfg-call-home)# no mail-serv- er {ipv4-address | name | all}

Removes one e-mail server or all e-mail servers from the configuration.

Step 4 

Router(cfg-call-home)# sender from email-address

(Optional) Assigns the e-mail address that will appear in the from field in Call Home e-mail messages. If no address is specified, the contact e-mail address is used.

Step 5 

Router(cfg-call-home)# sender re- ply-to email-address

(Optional) Assigns the e-mail address that will appear in the reply-to field in Call Home e-mail messages.

Step 6 

Router(cfg-call-home)# rate-limit number

(Optional) Specifies a limit on the number of messages sent per minute, from 1 to 60. The default is 20.

The following notes apply when configuring general e-mail options:

Backup e-mail servers can be defined by repeating the mail-server command using different priority numbers.

The mail-server priority number parameter can be configured from 1 to 100. The server with the highest priority (lowest priority number) will be tried first.

This example shows the configuration of general e-mail parameters, including a primary and secondary e-mail server:

Router# configure terminal 
Enter configuration commands, one per line.  End with CNTL/Z.

Router(config)# call-home

Router(cfg-call-home)# mail-server smtp.example.com priority 1

Router(cfg-call-home)# mail-server 192.168.0.1 priority 2

Router(cfg-call-home)# sender from username@example.com

Router(cfg-call-home)# sender reply-to username@example.com

Router(cfg-call-home)# exit

Router(config)#

Enabling Call Home

To enable or disable the Call Home feature, perform this task:

 
Command
Purpose

Step 1 

Router# configure terminal

Enters configuration mode.

Step 2 

Router(config)# service call-home

Enables the Call Home feature.

Router(config)# no service call-home

Disables the Call Home feature.

Testing Call Home Communications

You can test Call Home communications by sending messages manually using two command types. To send a user-defined Call Home test message, use the call-home test command. To send a specific alert group message, use the call-home send command.

Sending a Call Home Test Message Manually

To manually send a Call Home test message, perform this task:

 
Command
Purpose

Step 1 

Router# call-home test ["test-message"] profile name

Sends a test message to the specified destination profile. The user-defined test message text is optional, but must be enclosed in quotes ("") if it contains spaces. If no user-defined message is configured, a default message will be sent.

Sending a Call Home Alert Group Message Manually

To manually trigger a Call Home alert group message, perform this task:

 
Command
Purpose

Step 1 

Router# call-home send alert-group con- figuration [profile name]

Sends a configuration alert group message to one destination profile if specified, or to all subscribed destination profiles.

Router# call-home send alert-group diag- nostic {module number | slot/subslot | slot/bay_number} [profile name]

Sends a diagnostic alert group message to the configured destination profile if specified, or to all subscribed destination profiles. You must specify the module or port whose diagnostic information should be sent.

Router# call-home send alert-group in- ventory [profile name]

Sends an inventory alert group message to one destination profile if specified, or to all subscribed destination profiles.

When manually sending Call Home alert group messages, note the following guidelines:

Only the configuration, diagnostic, and inventory alert groups can be sent manually.

When you manually trigger a configuration, diagnostic, or inventory alert group message and you specify a destination profile name, a message is sent to the destination profile regardless of the profile's active status, subscription status, or severity setting.

When you manually trigger a configuration or inventory alert group message and do not specify a destination profile name, a message is sent to all active profiles that have either a normal or periodic subscription to the specified alert group.

When you manually trigger a diagnostic alert group message and do not specify a destination profile name, the command will cause the following actions:

For any active profile that subscribes to diagnostic events with a severity level of less than minor, a message is sent regardless of whether the module or interface has observed a diagnostic event.

For any active profile that subscribes to diagnostic events with a severity level of minor or higher, a message is sent only if the specified module or interface has observed a diagnostic event of at least the subscribed severity level; otherwise, no diagnostic message is sent to the destination profile.

Configuring and Enabling Smart Call Home

For application and configuration information of the Cisco Smart Call Home service, see the "FastStart" section of the Smart Call Home User Guide at this location:

http://www.cisco.com/go/smartcall/

The user guide includes configuration examples for sending Smart Call Home messages directly from your device or through a transport gateway (TG) aggregation point. You can use a TG aggregation point in cases requiring support for multiple devices or in cases where security requirements mandate that your devices may not be connected directly to the Internet.

Because the Smart Call Home service uses HTTPS as the transport method, you must also configure its CA as a trustpoint, as described in the Smart Call Home User Guide.

Displaying Call Home Configuration Information

To display the configured Call Home information, perform this task:

 
Command
Purpose

Step 1 

Router# show call-home

Displays the Call Home configuration in summary.

Router# show call-home detail

Displays the Call Home configuration in detail.

Router# show call-home alert-group

Displays the available alert groups and their status.

Router# show call-home mail-server status

Checks and displays the availability of the configured e-mail server(s).

Router# show call-home profile {all | name}

Displays the configuration of the specified destination profile. Use the keyword all to display the configuration of all destination profiles.

Router# show call-home statistics

Displays the statistics of Call Home events.

Examples 55-2 to 55-8 show the results when using different options of the show call-home command.

Example 55-1 Configured Call Home Information

Router# show call-home
Current call home settings:
    call home feature : disable
    call home message's from address: switch@example.com
    call home message's reply-to address: support@example.com

    contact person's email address: technical@example.com

    contact person's phone number: +1-408-555-1234
    street address: 1234 Picaboo Street, Any city, Any state, 12345
    customer ID: ExampleCorp
    contract ID: X123456789
    site ID: SantaClara
    Mail-server[1]: Address: smtp.example.com Priority: 1
    Mail-server[2]: Address: 192.168.0.1 Priority: 2
    Rate-limit: 20 message(s) per minute

Available alert groups:
    Keyword                  State   Description
    ------------------------ ------- -------------------------------
    configuration            Disable configuration info
    diagnostic               Disable diagnostic info
    environment              Disable environmental info
    inventory                Enable  inventory info
    syslog                   Disable syslog info
Profiles:
    Profile Name: campus-noc
    Profile Name: CiscoTAC-1

Router#

Example 55-2 Configured Call Home Information in Detail

Router# show call-home detail 
Current call home settings:
    call home feature : disable
    call home message's from address: switch@example.com
    call home message's reply-to address: support@example.com

    contact person's email address: technical@example.com

    contact person's phone number: +1-408-555-1234
    street address: 1234 Picaboo Street, Any city, Any state, 12345
    customer ID: ExampleCorp
    contract ID: X123456789
    site ID: SantaClara
    Mail-server[1]: Address: smtp.example.com Priority: 1
    Mail-server[2]: Address: 192.168.0.1 Priority: 2
    Rate-limit: 20 message(s) per minute

Available alert groups:
    Keyword                  State   Description
    ------------------------ ------- -------------------------------
    configuration            Disable configuration info
    diagnostic               Disable diagnostic info
    environment              Disable environmental info
    inventory                Enable  inventory info
    syslog                   Disable syslog info

Profiles:

Profile Name: campus-noc
    Profile status: ACTIVE
    Preferred Message Format: long-text
    Message Size Limit: 3145728 Bytes
    Transport Method: email
    Email address(es): noc@example.com
    HTTP  address(es): Not yet set up

    Alert-group               Severity
    ------------------------  ------------
    inventory                 normal      

    Syslog-Pattern            Severity
    ------------------------  ------------
    N/A                       N/A

Profile Name: CiscoTAC-1
    Profile status: ACTIVE
    Preferred Message Format: xml
    Message Size Limit: 3145728 Bytes
    Transport Method: email
    Email address(es): callhome@cisco.com
    HTTP  address(es): https://tools.cisco.com/its/service/oddce/services/DDCEService

    Periodic configuration info message is scheduled every 1 day of the month at
 09:27

    Periodic inventory info message is scheduled every 1 day of the month at 09:
12

    Alert-group               Severity
    ------------------------  ------------
    diagnostic                minor       
    environment               minor       

    Syslog-Pattern            Severity
    ------------------------  ------------
    .*                        major       

Router#

Example 55-3 Available Call Home Alert Groups

Router# show call-home alert-group 
Available alert groups:
    Keyword                  State   Description
    ------------------------ ------- -------------------------------
    configuration            Disable configuration info
    diagnostic               Disable diagnostic info
    environment              Disable environmental info
    inventory                Enable  inventory info
    syslog                   Disable syslog info

Router#

Example 1-4 E-Mail Server Status Information

Router# show call-home mail-server status
Please wait. Checking for mail server status ...

Translating "smtp.example.com"
    Mail-server[1]: Address: smtp.example.com Priority: 1 [Not Available]
    Mail-server[2]: Address: 192.168.0.1 Priority: 2 [Not Available]

Router#

Example 1-5 Information for All Destination Profiles (Predefined and User-Defined)

Router# show call-home profile all

Profile Name: campus-noc
    Profile status: ACTIVE
    Preferred Message Format: long-text
    Message Size Limit: 3145728 Bytes
    Transport Method: email
    Email address(es): noc@example.com
    HTTP  address(es): Not yet set up

    Alert-group               Severity
    ------------------------  ------------
    inventory                 normal      

    Syslog-Pattern            Severity
    ------------------------  ------------
    N/A                       N/A

Profile Name: CiscoTAC-1
    Profile status: ACTIVE
    Preferred Message Format: xml
    Message Size Limit: 3145728 Bytes
    Transport Method: email
    Email address(es): callhome@cisco.com
    HTTP  address(es): https://tools.cisco.com/its/service/oddce/services/DDCEService

    Periodic configuration info message is scheduled every 1 day of the month at 09:27

    Periodic inventory info message is scheduled every 1 day of the month at 09:12

    Alert-group               Severity
    ------------------------  ------------
    diagnostic                minor       
    environment               minor       

    Syslog-Pattern            Severity
    ------------------------  ------------
    .*                        major       

Router#

Example 1-6 Information for a User-Defined Destination Profile

Router# show call-home profile campus-noc

Profile Name: campus-noc
    Profile status: ACTIVE
    Preferred Message Format: long-text
    Message Size Limit: 3145728 Bytes
    Transport Method: email
    Email address(es): noc@example.com
    HTTP  address(es): Not yet set up

    Alert-group               Severity
    ------------------------  ------------
    inventory                 normal      

    Syslog-Pattern            Severity
    ------------------------  ------------
    N/A                       N/A

Router#

Example 1-7 Call Home Statistics

Router# show call-home statistics 
Successful Call-Home Events: 1
Dropped Call-Home Events due to Rate Limiting: 0
Last call-home message sent time: 2007-04-25 11:07:04 GMT+00:00

Default Settings

Table 1-2 lists the default Call Home settings.

Table 1-2 Default Call Home Settings  

Parameters
Default

Call Home feature status

Disabled

User-defined profile status

Active

Predefined Cisco TAC profile status

Inactive

Transport method

E-mail

Message format type

XML

Destination message size for a message sent in long text, short text, or XML format

3,145,728

Alert group status

Enabled

Call Home message severity threshold

1 (normal)

Message rate limit for messages per minute

20


Alert Group Trigger Events and Commands

Call Home trigger events are grouped into alert groups, with each alert group assigned CLI commands to execute when an event occurs. The CLI command output is included in the transmitted message. Table 1-3 lists the trigger events included in each alert group, including the severity level of each event and the executed CLI commands for the alert group.

Table 1-3 Call Home Alert Groups, Events, and Actions 

Alert Group
Call Home Trigger Event
Syslog Event
Severity
Description and CLI Commands Executed

Syslog

     

Event logged to syslog. (Only sent to TAC if syslog level 0, 1, or 2)

CLI commands executed:

show logging

 

SYSLOG

LOG_EMERG

0

System is unusable.

 

SYSLOG

LOG_ALERT

1

Action must be taken immediately.

 

SYSLOG

LOG_CRIT

2

Critical conditions.

 

SYSLOG

LOG_ERR

3

Error conditions.

 

SYSLOG

LOG_WARNING

4

Warning conditions.

 

SYSLOG

LOG_NOTICE

5

Normal but signification condition.

 

SYSLOG

LOG_INFO

6

Informational.

 

SYSLOG

LOG_DEBUG

7

Debug-level messages.

 

SYSLOG

C2PLUSWITHNODB

2

The module in slot %d has no forwarding daughter board. Power denied.

 

SYSLOG

DFCMISMATCH

2

Module %d DFC incompatible with supervisor engine DFC. Power denied.

 

SYSLOG

BADFLOWCTRL

2

Module %d not at an appropriate hardware revision level to support DFC. Power denied.

 

SYSLOG

BADFLOWCTRL_WARN

2

<