Note For complete syntax and usage information for the switch commands used in this chapter, first look at the Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:

If the command is not found in the Catalyst 4500 Series Switch Command Reference, it will be found in the larger Cisco IOS library. Refer to the Cisco IOS Command Reference and related publications at this location:

About 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 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 (callhome@cisco.com), and you also can define your own destination profiles.

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

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:

•Boot-up diagnostics alerts for line cards and supervisor engines in the chassis.

•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 to register the following items:

•The SMARTnet contract number for your switch

•Your e-mail address

•Your Cisco.com ID

For detailed information on Smart Call Home, refer to the Smart Call Home page at this URL:

Configuring Call Home

How you configure Call Home depends on how you intend to use the feature. Consider the following information before you configure Call Home:

•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.

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:

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.

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.

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

Step 9

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

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

Step 10

Switch(cfg-call-home)# end

Returns to privileged EXEC mode.

Step 11

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

Displays the destination profile configuration for a 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

Switch# configure terminal

Enters configuration mode.

Step 2

Switch(config)# call-home

Enters the Call Home configuration submode.

Step 3

Switch(cfg-call-home)# copy profilesource-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 on the switch. Different types of Call Home alerts are grouped into different alert groups depending on their type. These alert groups are available:

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

Switch(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 sending alert group messages based on the message's level of severity. Any message with a value lower than the threshold is not sent to the destination.

The severity threshold is configured using the keywords in Table 66-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 differ from the system message logging severity levels.

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.

Starting with Cisco IOS Release 15.0(2)SG, you can configure the vrf and source interface or source IP address to send the e-mail messages. If you want to configure similar options to send http messages, you must enter the ip http client source-interfaceinterface-name command where the source-interface can be associated with the vrf you want to set.

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

Step 4

Switch(cfg-call-home)# sender fromemail-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

Switch(cfg-call-home)# sender reply-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

Switch(cfg-call-home)# rate-limitnumber

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

Step 7

Switch(cfg-call-home)# vrf vrf-name

(Optional) Specifies the VRF instance to send Call Home e-mail messages. If no VRF is specified, the global routing table is used.

Step 8

Switch(cfg-call-home)# source-interfaceinterface-name

(Optional) Specifies the source interface name to send Call Home e-mail messages. If no source interface name or source ip address is specified, an interface in the routing table is used.

Step 9

Switch(cfg-call-home)# source-ip-addressip-address

(Optional) Specifies the source IP address to send Call Home e-mail messages. If no source IP address or source interface name is specified, an interface in the routing table is used.

Note At one time, you can specify the source-interface name or the source-ip-address, but not both.

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 prioritynumber 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:

Switch# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.

Switch(config)# call-home

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

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

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

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

Switch(cfg-call-home)# exit

Switch(config)#

Enabling Call Home

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

Command

Purpose

Step 1

Switch# configure terminal

Enters configuration mode.

Step 2

Switch(config)# service call-home

Enables 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

Switch# call-home test ["test-message"] profilename

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.

This example shows how to manually send a Call Home test message:

Switch# call-home test "test of the day" profile Ciscotac1

Sending a Call Home Alert Group Message Manually

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

Command

Purpose

Step 1

Switch# call-home send alert-group configuration[profilename]

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

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.

Switch# call-home send alert-group inventory[profilename]

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:

•You can only manually send the configuration, diagnostic, and inventory alert groups.

•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.

This example shows how to send the configuration alert-group message to the destination profile:

Switch# call-home send alert-group configuration

This example shows how to send the diagnostic alert-group message to the destination profile for a specific module, slot/subslot, or slot/bay number.

Switch# call-home send alert-group diagnostic module 3 5/2

This example shows how to send the diagnostic alert-group message to all destination profiles for a specific module, slot/subslot, or slot/bay number.

Sending a Request for an Analysis and Report

You can use the call-home request command to submit information about your system to Cisco in order to receive helpful information specific to your system. You can request a variety of reports, including security alerts, known bugs, best practices, and command references.

To submit a request for report and analysis information from the Cisco Output Interpreter tool, perform one of these tasks:

Command

Purpose

Switch# call-home request output-analysis"show-command"

[profilename] [ccoiduser-id]

Sends the output of the specified show command for analysis. The show command must be contained in quotes ("").

Sends the output of a predetermined set of commands for analysis such as show running-configall, show version, or show module commands. In addition, the call-home request product-advisory command includes all inventory alert group commands.

The keyword specified after the call home request command specifies the type of report required.

When manually sending a Call Home report and analysis request, note the following guidelines:

•If you specify a profilename value, the request is sent to the profile. If you do not specify a profile name, the request is sent to the Cisco TAC profile. The recipient profile does not need to be enabled for the Call Home request. The profile should specify the e-mail address where the transport gateway is configured so that the request message can be forwarded to the Cisco TAC and you can receive the reply from the Smart Call Home service.

•The ccoiduser-id value is the registered identifier of the Smart Call Home user. If you specify a user-id, the response is sent to the e-mail address of the registered user. If do not specify a user-id, the response is sent to the contact e-mail address of the device.

•Based on the keyword specifying the type of report requested, the following information is returned:

–config-sanity—Information on best practices as related to the current running configuration

–bugs-list—Known bugs in the running version and in the currently applied features

–command-reference—Reference links to all commands in the running configuration

–product-advisory—Product Security Incident Response Team (PSIRT) notices, End of Life (EOL) or End of Sales (EOS) notices, or field notices (FN) that may affect devices in your network

This example shows a request for analysis of a user-specified show command:

Sending the Output of a Command

You can use the call-home send command to execute a CLI command and e-mail the command output to Cisco or to an e-mail address that you specify.

To execute a CLI command and e-mail the command output, perform this task:

Command

Purpose

Switch# call-home send"command"

[emailemail-addr] [service-numberSR]

Executes the specified CLI command and e-mails the output.

When sending the output of a command, note the following guidelines:

•The specified CLI command can be any run command, including commands for all modules. The command must be contained in quotes ("").

•If an e-mail address is specified, the command output will be sent to that address. If no e-mail address is specified, the output will be sent to the Cisco TAC (attach@cisco.com). The e-mail will be sent in long text format with the service number, if specified, in the subject line.

•The service number is required only if no e-mail address is specified, or if a Cisco TAC e-mail address is specified.

This example shows how to send the output of a CLI command to a user-specified e-mail address:

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 these tasks:

Command

Purpose

Switch# show call-home

Displays the Call Home configuration in summary.

Switch# show call-home detail

Displays the Call Home configuration in detail.

Switch# show call-home alert-group

Displays the available alert groups and their status.

Switch# show call-home mail-server status

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

Switch# 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.

Switch# show call-home statistics

Displays the statistics of Call Home events.

Examples 66-1 to 66-7 show the results when using different options of the show call-home command.

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 66-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 66-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 loggingshow inventory

SYSLOG

LOG_EMERG

7

System is unusable.

SYSLOG

LOG_ALERT

6

Action must be taken immediately.

SYSLOG

LOG_CRIT

5

Critical conditions.

SYSLOG

LOG_ERR

4

Error conditions.

SYSLOG

LOG_WARNING

3

Warning conditions.

SYSLOG

LOG_NOTICE

2

Normal but signification condition.

SYSLOG

LOG_INFO

1

Informational.

SYSLOG

LOG_DEBUG

0

Debug-level messages.

Environmental

Events related to power, fan, and environment sensing elements, such as temperature alarms. (Sent to TAC.)

CLI commands executed:

show moduleshow environmentshow loggingshow powershow inventory

TEMP_FAILURE

TempHigh

5

The temperature of the chassis is above the normal threshold.

TEMP_FAILURE

Critical Temp

5

The temperature of the chassis has risen above the critical threshold.

TEMP_FAILURE

Shutdown Temp

5

The temperature of the chassis is very high and the system will be shut down.

TEMP_FAILURE

Some Temp Sensors Failed

3

Some of the temperature sensors have failed.

TEMP_FAILURE

All Temp Sensors Failed

5

All temperature sensors have failed.

TEMP_RECOVER

TempOk

5

The temperature of the chassis is normal.

POWER_FAILURE

PowerSupplyBad

5

A power supply has failed or has been turned off.

POWER_RECOVERY

PowerSupplyGood

5

A failed power supply has been fixed.

POWER_FAILURE

PowerSupplyFanBad

3

A power supply fan has failed.

POWER_ RECOVERY

PowerSupplyFanGood

3

A failed power supply fan has been fixed.

POWER_RECOVERY

PowerSupplyOutputIncreased

3

A power supply output has increased.

POWER_FAILURE

PowerSupplyOutputDecreased

3

A power supply output has decreased.

POWER_FAILURE

InlinePowerSupplyBad

3

Inline power source from a power supply has failed or turned off.

POWER_FAILURE

MixedPowerSupplyInChassis

3

Mixed power supplies have been detected in the chassis.

POWER_FAILURE

NotEnoughPowerChassis

6

There is insufficient power to support the system. The system might shut down.

POWER_ RECOVERY

InlinePowerSupplyGood

3

A failed source for inline power has been fixed.

FANTRAY_FAILURE

FanTrayPartialFailure

3

Either a fan or thermistors in system fan tray has failed.

FANTRAY_FAILURE

FanTrayMismatch

3

The fantray, supervisor, chassis combination is disallowed.

FANTRAY_FAILURE

FanTrayBad

5

Fan tray has failed.

FANTRAY_ RECOVERY

FanTrayGood

3/5

Failed fan tray has been fixed.The severity of the notification depends on the failure which has been recovered from.

FANTRAY_ FAILURE

InsufficientFantray

6

There are not enough FanTray to support the system. This may be followed by a system shut down.

CLOCK_ALARM

ClockSwitchover

2

Clock module has switched over to another clock.

CLOCK_ALARM

Clock Faulty

3

The clock module has been found to be faulty.

Inventory

Inventory status should be provided whenever a unit is cold-booted, or when FRUs are inserted or removed. it is considered a noncritical event, and the information is used for status and entitlement.

Message Contents

•Table 66-5 describes the content fields that are common to all long text and XML messages. The fields specific to a particular alert group message are inserted at a point between the common fields. The insertion point is identified in the table.

•Table 66-6 describes the inserted content fields for reactive messages (system failures that require a TAC case) and proactive messages (issues that might result in degraded system performance).