Configuring Call Home for Cisco Integrated Services Routers
Available Languages
Table Of Contents
Configuring Call Home for Cisco Integrated Services Routers
Obtaining Smart Call Home Services
Configuring Smart Call Home (Single Command)
Configuring and Enabling Smart Call Home
Enabling and Disabling Call Home
Configuring Contact Information
Configuring Destination Profiles
Creating a New Destination Profile
Setting TAC Profile to Anonymous Mode
Configuring Snapshot Command List
Configuring General E-Mail Options
Specifying Rate Limit for Sending Call Home Messages
Enabling AAA Authorization to Run IOS Commands for Call Home Messages
Configuring Call Home Data Privacy
Sending Call Home Communications Manually
Sending a Call Home Test Message Manually
Sending Call Home Alert Group Messages Manually
Submitting Call Home Analysis and Report Requests
Manually Sending Command Output Message for One Command or a Command List
Displaying Call Home Configuration Information
Alert Group Trigger Events and Commands
Sample Syslog Alert Notification in Long-Text Format
Sample Syslog Alert Notification in XML Format
Feature Information for Call Home
Configuring Call Home for Cisco Integrated Services Routers
First Published: November 18, 2011Revised: April 11, 2012, OL-20763-05The Call Home feature 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 use of Cisco Smart Call Home services for direct case generation with the Cisco Systems Technical Assistance Center (TAC).
This document describes how to configure the Call Home feature in Cisco IOS Release 15.2(2)T and later releases for the following Cisco integrated services routers:
•
Cisco 819
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Finding Feature Information
Your software release may not support all of the features documented in this module. For the latest feature information and caveats, see the release notes for your platform and software release. To find information about the features documented in this module and to see a list of the releases in which each feature is supported, see the "Feature Information for Call Home" section.
Use Cisco Feature Navigator to find information about platform support and Cisco IOS and Catalyst OS software image support. To access Cisco Feature Navigator, see http://www.cisco.com/go/cfn. A Cisco account is not required.
Contents
This document includes the following sections:
•
•
•
Prerequisites for Call Home
Information to consider before you configure Call Home:
•
•
–
–
•
•
Information About Call Home
The Call Home feature can deliver alert messages containing information on configuration, environmental conditions, inventory, syslog, snapshot, and crash events. It provides these alert messages as either e-mail-based or web-based messages. Multiple message formats are available, allowing for compatibility with pager services, standard e-mail, or XML-based automated parsing applications. This 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). You can also define your own destination profiles.
Flexible message delivery and format options make it easy to integrate specific support requirements.
This section contains the following subsections:
•
Benefits of Using Call Home
The Call Home feature offers the following benefits:
•
–
–
–
•
•
•
•
Obtaining Smart Call Home Services
If you have a service contract directly with Cisco, you can register for the Smart Call Home service. Smart Call Home analyzes Smart Call Home messages and provides background information and recommendations. For known issues, particularly online diagnostics failures, Automatic Service Requests are generated with the Cisco TAC.
Smart Call Home offers the following features:
•
•
•
•
You need the following items to register for Smart Call Home:
•
•
•
For detailed information on Smart Call Home, see www.cisco.com/go/smartcallhome/index.html.
Anonymous Reporting
Smart Call Home is a service capability included with many Cisco service contracts and is designed to assist customers resolve problems more quickly. In addition, the information gained from crash messages helps Cisco understand equipment and issues occurring in the field. If you decide not to use Smart Call Home, you can still enable Anonymous Reporting to allow Cisco to securely receive minimal error and health information from the device. If you enable Anonymous Reporting, your customer identity will remain anonymous, and no identifying information will be sent.
Note
When Call Home is configured in an anonymous way, only crash, inventory, and test messages are sent to Cisco. No customer identifying information is sent.
For more information about what is sent in these messages, see the "Alert Group Trigger Events and Commands" section.
How to Configure Call Home
The following section shows how you can configure Call Home using a single command:
•
•
The following sections show detailed or optional configurations:
•
•
•
•
•
•
•
•
•
Configuring Smart Call Home (Single Command)
To enable all Call Home basic configurations using a single command, perform the following steps:
SUMMARY STEPS
1.
2.
Step 1
configure terminal
Example:Router# configure terminal
Enters configuration mode.
Step 2
call-home reporting {anonymous | contact-email-addr email-address} [http-proxy {ipv4-address | ipv6-address | name} port port-number]
Example:Router(config)# call-home reporting contact-email-addr email@company.com
Enables all Call Home basic configurations using a single command.
•
•
•
•
Note
Note
DETAILED STEPS
Configuring and Enabling Smart Call Home
For application and configuration information about the Cisco Smart Call Home service, see the "Getting Started" section of Smart Call Home User Guide.
The user guide includes configuration examples for sending Smart Call Home messages directly from your device or through a transport gateway (TG) aggregation point.
Note
Cisco IOS Release 15.2(2)T and later releases support the trustpool feature (embedded CA certificates in IOS images). The trustpool feature simplifies configuration to enable Smart Call Home service on configured devices. It eliminates the requirement of manually configuring the trustpoint and provides automatic update of the CA certificate should it change in the future.
For releases earlier than Cisco IOS Release 15.2(2)T, see Smart Call Home User Guide.
Enabling and Disabling Call Home
To enable or disable the Call Home feature, perform the following steps:
SUMMARY STEPS
1.
2.
3.
DETAILED STEPS
Configuring Contact Information
Each router must include a contact e-mail address (except if Call Home is enabled in anonymous mode). You can optionally include a phone number, street address, contract ID, customer ID, and site ID.
To assign the contact information, perform the following steps:
SUMMARY STEPS
1.
2.
3.
4.
5.
6.
7.
8.
DETAILED STEPS
Example
The following example shows the configuration of contact information:
Router# configure terminalEnter 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
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 create and define a new destination profile or copy and use the predefined destination profile. If you define a new destination profile, you must assign a profile name.
Note
You can configure the following attributes for a destination profile:
•
•
–
–
•
•
•
This section contains the following subsections:
•
•
•
Creating a New Destination Profile
To create and configure a new destination profile, perform the following steps:
SUMMARY STEPS
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
DETAILED STEPS
Copying a Destination Profile
To create a new destination profile by copying an existing profile, perform the following steps:
SUMMARY STEPS
1.
2.
3.
DETAILED STEPS
Setting TAC Profile to Anonymous Mode
To set an anonymous TAC profile, perform the following steps:
SUMMARY STEPS
1.
2.
3.
4.
DETAILED STEPS
Subscribing to Alert Groups
An alert group is a predefined subset of Call Home alerts supported in all routers. Different types of Call Home alerts are grouped into different alert groups depending on their type. The following alert groups are available:
•
•
•
•
•
•
This section contains the following subsections:
•
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
To subscribe a destination profile to one or more alert groups, perform the following steps:
SUMMARY STEPS
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
DETAILED STEPS
Step 1
configure terminal
Example:Router# configure terminal
Enters configuration mode.
Step 2
call-home
Example:Router(config)# call-home
Enters Call Home configuration submode.
Step 3
alert-group {all | configuration |
environment | inventory | syslog | crash | snapshot}Example:Router(cfg-call-home)# alert-group all
Enables the specified alert group. Use the keyword all to enable all alert groups. By default, all alert groups are enabled.
Step 4
profile name
Example:Router(cfg-call-home)# profile profile1
Enters the Call Home destination profile configuration submode for the specified destination profile.
Step 5
subscribe-to-alert-group all
Example:Router(cfg-call-home-profile)# subscribe-to-alert-group all
Subscribes to all available alert groups using the lowest severity.
You can subscribe to alert groups individually by specific type, as described in Step 6 through Step 11.
Note
Step 6
subscribe-to-alert-group configuration
[periodic {daily hh:mm | monthly date hh:mm | weekly day hh:mm}]Example:Router(cfg-call-home-profile)# subscribe-to-alert-group configuration
periodic daily 12:00Subscribes this destination profile to the Configuration alert group. The Configuration alert group can be configured for periodic notification, as described in the "Periodic Notification" section.
Step 7
subscribe-to-alert-group environment
[severity {catastrophic | disaster |
fatal | critical | major | minor | warning |
notification | normal | debugging}]Example:Router(cfg-call-home-profile)# subscribe-to-alert-group environment severity major
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 "Message Severity Threshold" section.
Step 8
subscribe-to-alert-group inventory [periodic {daily hh:mm | monthly date hh:mm | weekly day hh:mm}]
Example:Router(cfg-call-home-profile)# subscribe-to-alert-group inventory periodic monthly 1 12:00
Subscribes this destination profile to the Inventory alert group. The Inventory alert group can be configured for periodic notification, as described in the "Periodic Notification" section.
Step 9
subscribe-to-alert-group syslog
[severity {catastrophic | disaster |
fatal | critical | major | minor | warning |
notification | normal | debugging}]
[pattern string]Example:Router(cfg-call-home-profile)# subscribe-to-alert-group syslog severity major
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 "Message Severity Threshold" section.
You can specify a text pattern to be matched within each syslog message. If you configure a pattern, a Syslog alert group message is sent only if it contains the specified pattern and meets the severity threshold. If the pattern contains spaces, you must enclose it in quotes (""). You can specify up to five patterns for each destination profile.
Step 10
subscribe-to-alert-group crash
Example:Router(cfg-call-home-profile)# [no | default]
subscribe-to-alert-group crash
Subscribes to the Crash alert group in user profile. By default, TAC profile subscribes to the Crash alert group and cannot be unsubscribed.
Step 11
subscribe-to-alert-group snapshot [periodic {daily hh:mm | hourly mm | interval mm | monthly date hh:mm | weekly day hh:mm}]
Example:Router(cfg-call-home-profile)# subscribe-to-alert-group snapshot periodic daily 12:00
Subscribes this destination profile to the Snapshot alert group. The Snapshot alert group can be configured for periodic notification, as described in the "Periodic Notification" section.
By default, the Snapshot alert group has no command to run. You can add commands into the alert group, as described in the "Configuring Snapshot Command List" section. In doing so, the output of the commands added in the Snapshot alert group will be included in the snapshot message.
Step 12
exit
Example:Router(cfg-call-home-profile)# exit
Exits the Call Home destination profile configuration submode.
Periodic Notification
When you subscribe a destination profile to the Configuration, Inventory, or Snapshot 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:
•
•
•
•
•
Note
Message Severity Threshold
When you subscribe a destination profile to the Environment or Syslog alert group, you can set a threshold for the sending of alert group messages based on the level of severity of the message. Any message with a value lower than the destination profile specified threshold is not sent to the destination.
The severity threshold is configured using the keywords in Table 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 for the Syslog or Environment alert groups, the default is debugging (level 0). The Configuration and Inventory alert groups do not allow severity configuration; severity is always set as normal.
Note
Configuring Snapshot Command List
To configure the snapshot command list, perform the following steps:
SUMMARY STEPS
1.
2.
3.
4.
5.
DETAILED STEPS
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.
Note the following guidelines when configuring general e-mail options:
•
•
To configure general e-mail options, perform the following steps:
SUMMARY STEPS
1.
2.
3.
4.
5.
6.
7.
8.
DETAILED STEPS
Example
The following example shows the configuration of general e-mail parameters, including a primary and secondary e-mail server:
Router# configure terminalEnter 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)# source-interface america
Router(cfg-call-home)# source-ip-address 209.165.200.231
Router(cfg-call-home)# vrf vpn2
Router(cfg-call-home)# exit
Router(config)#
Specifying Rate Limit for Sending Call Home Messages
To specify the rate limit for sending Call Home messages, perform the following steps:
SUMMARY STEPS
1.
2.
3.
DETAILED STEPS
Specifying HTTP Proxy Server
To specify an HTTP proxy server for sending Call Home HTTP(S) messages to a destination, perform the following steps:
SUMMARY STEPS
1.
2.
3.
DETAILED STEPS
Enabling AAA Authorization to Run IOS Commands for Call Home Messages
To enable AAA authorization to run IOS commands that enable the collection of output for a Call Home message, perform the following steps:
SUMMARY STEPS
1.
2.
3.
4.
DETAILED STEPS
Configuring Syslog Throttling
To enable or disable call-home syslog message throttling and avoid sending repetitive call-home syslog messages, perform the following steps:
SUMMARY STEPS
1.
2.
3.
DETAILED STEPS
Configuring Call Home Data Privacy
The data-privacy command scrubs data, such as IP addresses, from running configuration files to protect the privacy of customers. Enabling the data-privacy command can affect CPU utilization when scrubbing a large amount of data. Currently, show command output is not being scrubbed except for configuration messages in the show running-config all and show startup-config data.
SUMMARY STEPS
1.
2.
3.
DETAILED STEPS
Sending Call Home Communications Manually
You can manually send several types of Call Home communications. To send Call Home communications, perform the tasks in this section. This section contains the following subsections:
•
•
•
•
Sending a Call Home Test Message Manually
You can use the call-home test command to send a user-defined Call Home test message.
To manually send a Call Home test message, perform the following step:
SUMMARY STEPS
1.
DETAILED STEPS
Sending Call Home Alert Group Messages Manually
You can use the call-home send command to manually send a specific alert group message.
Note the following guidelines when manually sending a Call Home alert group message:
•
•
•
To manually trigger Call Home alert group messages, perform the following steps:
SUMMARY STEPS
1.
2.
3.
DETAILED STEPS
Submitting Call Home Analysis and Report Requests
You can use the call-home request command to submit information about your system to Cisco to receive helpful analysis and report information specific to your system. You can request a variety of reports, including security alerts, known bugs, best practices, and command references.
Note the following guidelines when manually sending Call Home analysis and report requests:
•
•
•
–
–
–
–
To submit a request for analysis and report information from the Cisco Output Interpreter tool, perform the following steps:
SUMMARY STEPS
1.
2.
DETAILED STEPS
Example
The following example shows a request for analysis of a user-specified show command:
Router# call-home request output-analysis "show diag" profile TGManually Sending Command Output Message for One Command or a Command List
You can use the call-home send command to execute an IOS command or a list of IOS commands and send the command output through HTTP or e-mail protocol.
Note the following guidelines when sending the output of a command:
•
•
•
•
To execute a command and send the command output, perform the following step:
SUMMARY STEPS
1.
DETAILED STEPS
Example
The following example shows how to send the output of a command to a user-specified e-mail address:
Router# call-home send "show diag" email support@example.com
The following example shows the command output sent in long-text format to attach@cisco.com, with the SR number specified:
Router# call-home send "show version; show run" tac-service-request 123456
The following example shows the command output sent in XML message format to callhome@cisco.com:
Router# call-home send "show version; show run" email callhome@cisco.com msg-format xml
The following example shows the command output sent in XML message format to the Cisco TAC backend server, with the SR number specified:
Router# call-home send "show version; show run" http tac-service-request 123456
The following example shows the command output sent to the Cisco TAC backend server through the HTTP protocol and forwarded to a user-specified email address:
Router# call-home send "show version; show run" http destination-email-address user@company.com
Displaying Call Home Configuration Information
You can use variations of the show call-home command to display Call Home configuration information.
To display the configured Call Home information, perform the following:
SUMMARY STEPS
1.
2.
3.
4.
5.
6.
DETAILED STEPS
Examples
Examples 1 to 7 show the sample output when using different options of the show call-home command.
Example 1 Call Home Information in Summary
Router# show call-homeCurrent call home settings:call home feature : enablecall home message's from address: router@example.comcall home message's reply-to address: support@example.comvrf for call-home messages: Not yet set upcontact person's email address: technical@example.comcontact person's phone number: +1-408-555-1234street address: 1234 Picaboo Street, Any city, Any state, 12345customer ID: ExampleCorpcontract ID: X123456789site ID: SantaClarasource ip address: Not yet set upsource interface: GigabitEthernet0/0Mail-server[1]: Address: 192.168.2.1 Priority: 1Mail-server[2]: Address: 223.255.254.254 Priority: 2http proxy: 192.168.1.1:80aaa-authorization: disableaaa-authorization username: callhome (default)data-privacy: normalsyslog throttling: enableRate-limit: 20 message(s) per minuteSnapshot command[0]: show versionSnapshot command[1]: show clockAvailable alert groups:Keyword State Description------------------------ ------- -------------------------------configuration Enable configuration infocrash Enable crash and traceback infoenvironment Enable environmental infoinventory Enable inventory infosnapshot Enable snapshot infosyslog Enable syslog infoProfiles:Profile Name: campus-nocProfile Name: CiscoTAC-1Router#Example 2 Call Home Information in Detail
Router# show call-home detailCurrent call home settings:call home feature : enablecall home message's from address: router@example.comcall home message's reply-to address: support@example.comvrf for call-home messages: Not yet set upcontact person's email address: technical@example.comcontact person's phone number: +1-408-555-1234street address: 1234 Picaboo Street, Any city, Any state, 12345customer ID: ExampleCorpcontract ID: X123456789site ID: SantaClarasource ip address: Not yet set upsource interface: GigabitEthernet0/0Mail-server[1]: Address: 192.168.2.1 Priority: 1Mail-server[2]: Address: 223.255.254.254 Priority: 2http proxy: 192.168.1.1:80aaa-authorization: disableaaa-authorization username: callhome (default)data-privacy: normalsyslog throttling: enableRate-limit: 20 message(s) per minuteSnapshot command[0]: show versionSnapshot command[1]: show clockAvailable alert groups:Keyword State Description------------------------ ------- -------------------------------configuration Enable configuration infocrash Enable crash and traceback infoenvironment Enable environmental infoinventory Enable inventory infosnapshot Enable snapshot infosyslog Enable syslog infoProfiles:Profile Name: campus-nocProfile status: ACTIVEPreferred Message Format: xmlMessage Size Limit: 3145728 BytesTransport Method: emailEmail address(es): noc@example.comHTTP address(es): Not yet set upAlert-group Severity------------------------ ------------configuration normalcrash normalenvironment debuginventory normalSyslog-Pattern Severity------------------------ ------------.*CALL_LOOP.* debugProfile Name: CiscoTAC-1Profile status: INACTIVEProfile mode: Full ReportingPreferred Message Format: xmlMessage Size Limit: 3145728 BytesTransport Method: emailEmail address(es): callhome@cisco.comHTTP address(es): https://tools.cisco.com/its/service/oddce/services/DDCEServicePeriodic configuration info message is scheduled every 14 day of the month at 11:12Periodic inventory info message is scheduled every 14 day of the month at 10:57Alert-group Severity------------------------ ------------crash normalenvironment minorSyslog-Pattern Severity------------------------ ------------.*CALL_LOOP.* debugRouter#Example 3 Available Call Home Alert Groups
Router# show call-home alert-groupAvailable alert groups:Keyword State Description------------------------ ------- -------------------------------configuration Enable configuration infocrash Enable crash and traceback infoenvironment Enable environmental infoinventory Enable inventory infosnapshot Enable snapshot infosyslog Enable syslog infoRouter#Example 4 E-Mail Server Status Information
Router# show call-home mail-server statusPlease wait. Checking for mail server status ...Mail-server[1]: Address: 192.168.2.1 Priority: 1 [Not Available]Mail-server[2]: Address: 223.255.254.254 Priority: 2 [Available]Router#Example 5 Information for All Destination Profiles
Router# show call-home profile allProfile Name: campus-nocProfile status: ACTIVEPreferred Message Format: xmlMessage Size Limit: 3145728 BytesTransport Method: emailEmail address(es): noc@example.comHTTP address(es): Not yet set upAlert-group Severity------------------------ ------------configuration normalcrash normalenvironment debuginventory normalSyslog-Pattern Severity------------------------ ------------.*CALL_LOOP.* debugProfile Name: CiscoTAC-1Profile status: INACTIVEProfile mode: Full ReportingPreferred Message Format: xmlMessage Size Limit: 3145728 BytesTransport Method: emailEmail address(es): callhome@cisco.comHTTP address(es): https://tools.cisco.com/its/service/oddce/services/DDCEServicePeriodic configuration info message is scheduled every 14 day of the month at 11:12Periodic inventory info message is scheduled every 14 day of the month at 10:57Alert-group Severity------------------------ ------------crash normalenvironment minorSyslog-Pattern Severity------------------------ ------------.*CALL_LOOP.* debugRouter#Example 6 Information for a User-Defined Destination Profile
Router# show call-home profile campus-nocProfile Name: campus-nocProfile status: ACTIVEPreferred Message Format: xmlMessage Size Limit: 3145728 BytesTransport Method: emailEmail address(es): noc@example.comHTTP address(es): Not yet set upAlert-group Severity------------------------ ------------configuration normalcrash normalenvironment debuginventory normalSyslog-Pattern Severity------------------------ ------------.*CALL_LOOP.* debugRouter#Example 7 Call Home Statistics
Router# show call-home statisticsMessage Types Total Email HTTP------------- -------------------- -------------------- ------------------Total Success 3 3 0Config 3 3 0Crash 0 0 0Environment 0 0 0Inventory 0 0 0Snapshot 0 0 0SysLog 0 0 0Test 0 0 0Request 0 0 0Send-CLI 0 0 0Total In-Queue 0 0 0Config 0 0 0Crash 0 0 0Environment 0 0 0Inventory 0 0 0Snapshot 0 0 0SysLog 0 0 0Test 0 0 0Request 0 0 0Send-CLI 0 0 0Total Failed 0 0 0Config 0 0 0Crash 0 0 0Environment 0 0 0Inventory 0 0 0Snapshot 0 0 0SysLog 0 0 0Test 0 0 0Request 0 0 0Send-CLI 0 0 0Total Ratelimit-dropped 0 0 0Config 0 0 0Crash 0 0 0Environment 0 0 0Inventory 0 0 0Snapshot 0 0 0SysLog 0 0 0Test 0 0 0Request 0 0 0Send-CLI 0 0 0Last call-home message sent time: 2011-09-26 23:26:50 GMT-08:00Router#Default Settings
Table 2 lists the default Call Home settings.
Alert Group Trigger Events and Commands
Call Home trigger events are grouped into alert groups, with each alert group assigned commands to execute when an event occurs. The command output is included in the transmitted message. Table 3 lists the trigger events included in each alert group, including the severity level of each event and the executed commands for the alert group.
Message Contents
The following tables display the content formats of alert group messages:
•
•
•
•
•
This section also includes the following subsections that provide sample messages:
•
•
Table 5 Common Fields for All Long Text and XML Messages
(Plain Text and XML)
(Plain Text and XML)
(XML Only)Time stamp
Date and time stamp of event in ISO time notation:
YYYY-MM-DD HH:MM:SS GMT+HH:MM.
CallHome/EventTime
Message name
Name of message. Specific event names are listed in the "Alert Group Trigger Events and Commands" section.
For short text message only
Message type
Specifically "Call Home".
CallHome/Event/Type
Message subtype
Specific type of message: full, delta, test
CallHome/Event/SubType
Message group
Specifically "reactive". Optional because default is "reactive".
For long-text message only
Severity level
Severity level of message (see Table 1).
Body/Block/Severity
Source ID
Product type for routing through the workflow engine. This is typically the product family name.
For long-text message only
Device ID
Unique device identifier (UDI) for end device generating message. This field should be empty if the message is nonspecific to a fabric switch. The format is type@Sid@serial.
•
•
•
•
Example: CISCO3845@C@12345678
CallHome/CustomerData/
ContractData/DeviceIdCustomer ID
Optional user-configurable field used for contract information or other ID by any support service.
CallHome/CustomerData/
ContractData/CustomerIdContract ID
Optional user-configurable field used for contract information or other ID by any support service.
CallHome/CustomerData/
ContractData/ContractIdSite ID
Optional user-configurable field used for Cisco-supplied site ID or other data meaningful to alternate support service.
CallHome/CustomerData/
ContractData/SiteIdServer ID
If the message is generated from the fabric switch, this is the unique device identifier (UDI) of the switch.
The format is type@Sid@serial.
•
•
•
•
Example: CISCO3845@C@12345678
For long text message only
Message description
Short text describing the error.
CallHome/MessageDescription
Device name
Node that experienced the event. This is the host name of the device.
CallHome/CustomerData/
SystemInfo/NameNameContact name
Name of person to contact for issues associated with the node experiencing the event.
CallHome/CustomerData/
SystemInfo/ContactContact e-mail
E-mail address of person identified as contact for this unit.
CallHome/CustomerData/
SystemInfo/ContactEmailContact phone number
Phone number of the person identified as the contact for this unit.
CallHome/CustomerData/
SystemInfo/ContactPhoneNumberStreet address
Optional field containing street address for RMA part shipments associated with this unit.
CallHome/CustomerData/
SystemInfo/StreetAddressModel name
Model name of the router. This is the "specific model as part of a product family name.
CallHome/Device/Cisco_Chassis/
ModelSerial number
Chassis serial number of the unit.
CallHome/Device/Cisco_Chassis/
SerialNumberChassis part number
Top assembly number of the chassis.
CallHome/Device/Cisco_Chassis/
AdditionalInformation/AD@name=
"PartNumber"System object ID
System Object ID that uniquely identifies the system.
CallHome/Device/Cisco_Chassis/
AdditionalInformation/AD@name=
"sysObjectID"System description
System description for the managed element.
CallHome/Device/Cisco_Chassis/
AdditionalInformation/AD@name=
"sysDescr"Table 6 Inserted Fields Specific to a Particular Alert Group Message
The following fields may be repeated if multiple commands are executed for this alert group.
Command output name
Exact name of the issued command.
/aml/Attachments/Attachment/Name
Attachment type
Attachment type. Usually "inline".
/aml/Attachments/Attachment@type
MIME type
Normally "text" or "plain" or encoding type.
/aml/Attachments/Attachment/
Data@encodingCommand output text
Output of command automatically executed (see Table 3).
/mml/attachments/attachment/atdata
Sample Syslog Alert Notification in Long-Text Format
The following example shows a Syslog alert notification in long-text format:
TimeStamp : 2009-07-18 16:06 GMT+00:00Message Name : syslogMessage Type : Call HomeMessage Group : reactiveSeverity Level : 2Device ID : CISCO3845@C@FHK0847F2HECustomer ID : ExampleCorpContract ID : X1234Site ID : ACDServer ID : CISCO3845@C@FHK0847F2HEEvent Description : *Jul 18 16:06:08.775: %CLEAR-5-COUNTERS: Clear counter on all interfaces by consoleSystem Name : RouterContact Email : abc@example.comContact Phone : +1-408-123-4567Street Address : 1234 Any street, Any City, Any State 12345Affected Chassis : CISCO3845Affected Chassis Serial Number : FHK0847F2HEAffected Chassis Part No : 73-8799-04Affected Chassis Hardware Version : 1.0Supervisor Software Version : 12.4(24.6.6)PIA12Command Output Name : show loggingAttachment Type : command outputMIME Type : text/plainCommand Output Text :Syslog logging: enabled (0 messages dropped, 4 messages rate-limited,0 flushes, 0 overruns, xml disabled, filtering disabled)No Active Message Discriminator.No Inactive Message Discriminator.Console logging: level debugging, 32 messages logged, xml disabled,filtering disabledMonitor logging: level debugging, 0 messages logged, xml disabled,filtering disabledBuffer logging: level debugging, 32 messages logged, xml disabled,filtering disabledLogging Exception size (4096 bytes)Count and timestamp logging messages: disabledPersistent logging: disabledNo active filter modules.ESM: 0 messages droppedTrap logging: level informational, 35 message lines loggedLog Buffer (100000 bytes):*Jul 18 16:04:29.803: %VPN_HW-6-INFO_LOC: Crypto engine: onboard 0 State changed to: Initialized*Jul 18 16:04:29.807: %VPN_HW-6-INFO_LOC: Crypto engine: onboard 0 State changed to: Enabled*Jul 18 16:04:31.255: %LINK-5-CHANGED: Interface GigabitEthernet0/0, changed state to reset*Jul 18 16:04:31.255: %LINK-5-CHANGED: Interface GigabitEthernet0/1, changed state to reset*Jul 18 16:04:31.255: %LINEPROTO-5-UPDOWN: Line protocol on Interface VoIP-Null0, changed state to up*Jul 18 16:04:31.259: %LINK-3-UPDOWN: Interface FastEthernet1/0, changed state to up*Jul 18 16:04:31.259: %LINK-3-UPDOWN: Interface FastEthernet1/1, changed state to up*Jul 18 16:04:31.259: %LINEPROTO-5-UPDOWN: Line protocol on Interface Onboard VPN, changed state to up*Jul 18 16:04:32.355: %LINEPROTO-5-UPDOWN: Line protocol on Interface GigabitEthernet0/0, changed state to up*Jul 18 16:04:32.355: %LINEPROTO-5-UPDOWN: Line protocol on Interface GigabitEthernet0/1, changed state to up*Jul 18 16:04:32.355: %LINEPROTO-5-UPDOWN: Line protocol on Interface FastEthernet1/0, changed state to down*Jul 18 16:04:32.355: %LINEPROTO-5-UPDOWN: Line protocol on Interface FastEthernet1/1, changed state to down*Jul 18 16:04:33.259: %LINK-3-UPDOWN: Interface GigabitEthernet0/0, changed state to up*Jul 18 16:04:33.259: %LINK-3-UPDOWN: Interface GigabitEthernet0/1, changed state to up*Jul 18 16:04:33.463: %SYS-5-CONFIG_I: Configured from memory by console*Jul 18 16:04:33.979: %SYS-5-RESTART: System restarted --Cisco IOS Software, 3800 Software (C3845-ADVENTERPRISEK9-M), Version 12.4(24.6.6)PIA12 EARLY DEPLOYMENT ENGINEERING WEEKLY BUILD, synced to V124_24_6_PI11ICopyright (c) 1986-2009 by Cisco Systems, Inc.Compiled Thu 16-Jul-09 04:49 by abc*Jul 18 16:04:33.983: %SNMP-5-COLDSTART: SNMP agent on host Router is undergoing a cold start*Jul 18 16:04:34.139: %SYS-6-BOOTTIME: Time taken to reboot after reload = 134 seconds*Jul 18 16:04:34.303: %CRYPTO-6-ISAKMP_ON_OFF: ISAKMP is OFF*Jul 18 16:04:34.303: %CRYPTO-6-GDOI_ON_OFF: GDOI is OFF*Jul 18 16:04:34.303: %CRYPTO-6-ISAKMP_ON_OFF: ISAKMP is OFF*Jul 18 16:04:34.303: %CRYPTO-6-GDOI_ON_OFF: GDOI is OFF*Jul 18 16:04:35.427: %LINK-5-CHANGED: Interface FastEthernet1/0, changed state to administratively down*Jul 18 16:04:35.435: %LINK-5-CHANGED: Interface FastEthernet1/1, changed state to administratively down*Jul 18 16:04:35.799: %LINK-5-CHANGED: Interface GigabitEthernet0/0, changed state to reset*Jul 18 16:04:35.895: %LINK-5-CHANGED: Interface GigabitEthernet0/1, changed state to reset*Jul 18 16:04:36.799: %LINEPROTO-5-UPDOWN: Line protocol on Interface GigabitEthernet0/0, changed state to down*Jul 18 16:04:36.895: %LINEPROTO-5-UPDOWN: Line protocol on Interface GigabitEthernet0/1, changed state to down*Jul 18 16:04:39.511: %LINK-3-UPDOWN: Interface GigabitEthernet0/0, changed state to up*Jul 18 16:04:39.511: %LINK-3-UPDOWN: Interface GigabitEthernet0/1, changed state to up*Jul 18 16:04:40.771: %LINEPROTO-5-UPDOWN: Line protocol on Interface GigabitEthernet0/0, changed state to up*Jul 18 16:04:40.771: %LINEPROTO-5-UPDOWN: Line protocol on Interface GigabitEthernet0/1, changed state to upRouter#Command Output Name : show inventoryAttachment Type : command outputMIME Type : text/plainCommand Output Text : NAME: "3845 chassis", DESCR: "3845 chassis"PID: CISCO3845 , VID: V01 , SN: FHK0847F2HENAME: "c3845 Motherboard with Gigabit Ethernet on Slot 0", DESCR: "c3845 Motherboard with Gigabit Ethernet"PID: CISCO3845-MB , VID: V01 , SN: FOC08441SRVNAME: "WAN Interface Card - T1E1 or ATM (With GSHDSL-F module) on Slot 0 SubSlot 0", DESCR: "WAN Interface Card - T1E1 or ATM (With GSHDSL-F module)"PID: , VID: , SN: FOC07511QGMNAME: "FastEthernet/WAN on Slot 1", DESCR: "FastEthernet/WAN"PID: NM-2FE2W= , VID: 1.0, SN: JAD063904TQRouter#Sample Syslog Alert Notification in XML Format
The following example shows a Syslog alert notification in XML format:
<?xml version="1.0" encoding="UTF-8"?><soap-env:Envelope xmlns:soap-env="http://www.w3.org/2003/05/soap-envelope"><soap-env:Header><aml-session:Session xmlns:aml-session="http://www.cisco.com/2004/01/aml-session" soap-env:mustUnderstand="true" soap-env:role="http://www.w3.org/2003/05/soap-envelope/role/next"><aml-session:To>http://tools.cisco.com/neddce/services/DDCEService</aml-session:To><aml-session:Path><aml-session:Via>http://www.cisco.com/appliance/uri</aml-session:Via></aml-session:Path><aml-session:From>http://www.cisco.com/appliance/uri</aml-session:From><aml-session:MessageId>M4:FTX1217A18E:4E71C47C</aml-session:MessageId></aml-session:Session></soap-env:Header><soap-env:Body><aml-block:Block xmlns:aml-block="http://www.cisco.com/2004/01/aml-block"><aml-block:Header><aml-block:Type>http://www.cisco.com/2005/05/callhome/syslog</aml-block:Type><aml-block:CreationDate>2011-09-15 17:25:16 GMT+08:00</aml-block:CreationDate><aml-block:Builder><aml-block:Name></aml-block:Name><aml-block:Version>2.0</aml-block:Version></aml-block:Builder><aml-block:BlockGroup><aml-block:GroupId>G5:FTX1217A18E:4E71C47C</aml-block:GroupId><aml-block:Number>0</aml-block:Number><aml-block:IsLast>true</aml-block:IsLast><aml-block:IsPrimary>true</aml-block:IsPrimary><aml-block:WaitForPrimary>false</aml-block:WaitForPrimary></aml-block:BlockGroup><aml-block:Severity>2</aml-block:Severity></aml-block:Header><aml-block:Content><ch:CallHome xmlns:ch="http://www.cisco.com/2005/05/callhome" version="1.0"><ch:EventTime>2011-09-15 17:25:15 GMT+08:00</ch:EventTime><ch:MessageDescription>*Sep 15 17:25:15.307 CST: %CLEAR-5-COUNTERS: Clear counter on all interfaces by console</ch:MessageDescription><ch:Event><ch:Type>syslog</ch:Type><ch:SubType></ch:SubType><ch:Brand>Cisco Systems</ch:Brand><ch:Series>Cisco 2800 Series Routers</ch:Series></ch:Event><ch:CustomerData><ch:UserData><ch:Email>abc@example.com</ch:Email></ch:UserData><ch:ContractData><ch:CustomerId>ExampleCorp</ch:CustomerId><ch:SiteId>ACD</ch:SiteId><ch:ContractId>X1234</ch:ContractId><ch:DeviceId>CISCO2821@C@FTX1217A18E</ch:DeviceId></ch:ContractData><ch:SystemInfo><ch:Name>Router</ch:Name><ch:Contact></ch:Contact><ch:ContactEmail>abc@example.com</ch:ContactEmail><ch:ContactPhoneNumber>+1-408-123-4567</ch:ContactPhoneNumber><ch:StreetAddress>1234 Any street, Any City, Any State 12345</ch:StreetAddress></ch:SystemInfo><ch:CCOID></ch:CCOID></ch:CustomerData><ch:Device><rme:Chassis xmlns:rme="http://www.cisco.com/rme/4.0"><rme:Model>CISCO2821</rme:Model><rme:HardwareVersion>1.0</rme:HardwareVersion><rme:SerialNumber>FTX1217A18E</rme:SerialNumber><rme:AdditionalInformation><rme:AD name="PartNumber" value="73-8853-05" /><rme:AD name="SoftwareVersion" value="15.2(20110913:032356)143" /><rme:AD name="SystemObjectId" value="1.3.6.1.4.1.9.1.577" /><rme:AD name="SystemDescription" value="Cisco IOS Software, 2800 Software (C2800NM-ADVENTERPRISEK9-M), Experimental Version 15.2(20110913:032356)Copyright (c) 1986-2011 by Cisco Systems, Inc.Compiled Tue 13-Sep-11 23:56 by abc" /><rme:AD name="ServiceNumber" value="" /><rme:AD name="ForwardAddress" value="" /></rme:AdditionalInformation></rme:Chassis></ch:Device></ch:CallHome></aml-block:Content><aml-block:Attachments><aml-block:Attachment type="inline"><aml-block:Name>show logging</aml-block:Name><aml-block:Data encoding="plain"><![CDATA[show loggingSyslog logging: enabled (0 messages dropped, 3 messages rate-limited, 0 flushes, 0 overruns, xml disabled, filtering disabled)No Active Message Discriminator.No Inactive Message Discriminator.Console logging: disabledMonitor logging: level debugging, 0 messages logged, xml disabled,filtering disabledBuffer logging: level debugging, 33 messages logged, xml disabled,filtering disabledException Logging: size (4096 bytes)Count and timestamp logging messages: disabledPersistent logging: disabledNo active filter modules.Trap logging: level informational, 36 message lines loggedLogging Source-Interface: VRF Name:Log Buffer (256000 bytes):*Sep 15 09:03:11.355: %GT96K_FEWAN-1-UNKNOWN_WIC: slot 0, wic card has an unknown id 64*Sep 15 09:03:28.311: %VPN_HW-6-INFO_LOC: Crypto engine: onboard 0 State changed to: Initialized*Sep 15 09:03:28.315: %VPN_HW-6-INFO_LOC: Crypto engine: onboard 0 State changed to: Enabled*Sep 15 09:03:30.515: %LINEPROTO-5-UPDOWN: Line protocol on Interface VoIP-Null0, changed state to up*Sep 15 09:03:30.515: %LINK-3-UPDOWN: Interface GigabitEthernet0/0, changed state to up*Sep 15 09:03:30.515: %LINK-3-UPDOWN: Interface GigabitEthernet0/1, changed state to up*Sep 15 09:03:31.515: %LINEPROTO-5-UPDOWN: Line protocol on Interface GigabitEthernet0/0, changed state to up*Sep 15 09:03:31.515: %LINEPROTO-5-UPDOWN: Line protocol on Interface GigabitEthernet0/1, changed state to up*Sep 15 17:03:33.131 CST: %SYS-6-CLOCKUPDATE: System clock has been updated from 09:03:33 UTC Thu Sep 15 2011 to 17:03:33 CST Thu Sep 15 2011, configured from console by console.*Sep 15 17:03:33.547 CST: %SYS-5-CONFIG_I: Configured from memory by console*Sep 15 17:03:34.531 CST: %LINEPROTO-5-UPDOWN: Line protocol on Interface Loopback3, changed state to up*Sep 15 17:03:34.531 CST: %LINEPROTO-5-UPDOWN: Line protocol on Interface Loopback6, changed state to up*Sep 15 17:03:34.531 CST: %LINEPROTO-5-UPDOWN: Line protocol on Interface Loopback88, changed state to up*Sep 15 17:03:34.531 CST: %LINEPROTO-5-UPDOWN: Line protocol on Interface Loopback998, changed state to up*Sep 15 17:03:34.531 CST: %LINEPROTO-5-UPDOWN: Line protocol on Interface Loopback999, changed state to up*Sep 15 17:03:35.403 CST: %LINK-5-CHANGED: Interface Loopback100, changed state to administratively down*Sep 15 17:03:35.519 CST: %LINK-5-CHANGED: Interface GigabitEthernet0/1, changed state to administratively down*Sep 15 17:03:36.519 CST: %LINEPROTO-5-UPDOWN: Line protocol on Interface GigabitEthernet0/1, changed state to down*Sep 15 17:03:38.495 CST: %SYS-5-RESTART: System restarted --Cisco IOS Software, 2800 Software (C2800NM-ADVENTERPRISEK9-M), Experimental Version 15.2(20110913:032356)Copyright (c) 1986-2011 by Cisco Systems, Inc.Compiled Tue 13-Sep-11 23:56 by abc*Sep 15 17:03:38.495 CST: %SNMP-5-COLDSTART: SNMP agent on host Router is undergoing a cold start*Sep 15 17:03:38.707 CST: %SYS-6-BOOTTIME: Time taken to reboot after reload = 225 seconds*Sep 15 17:03:38.951 CST: %CRYPTO-6-ISAKMP_ON_OFF: ISAKMP is OFF*Sep 15 17:03:38.951 CST: %CRYPTO-6-GDOI_ON_OFF: GDOI is OFF*Sep 15 17:03:38.951 CST: %CRYPTO-6-ISAKMP_ON_OFF: ISAKMP is OFF*Sep 15 17:03:38.951 CST: %CRYPTO-6-GDOI_ON_OFF: GDOI is OFF*Sep 15 17:12:02.219 CST: %SYS-5-CONFIG_I: Configured from console by console*Sep 15 17:12:07.843 CST: %CLEAR-5-COUNTERS: Clear counter on all interfaces by console*Sep 15 17:13:07.555 CST: %SYS-5-CONFIG_I: Configured from console by console*Sep 15 17:13:14.583 CST: %CLEAR-5-COUNTERS: Clear counter on all interfaces by console*Sep 15 17:21:43.987 CST: %CLEAR-5-COUNTERS: Clear counter on all interfaces by console*Sep 15 17:23:37.947 CST: %SYS-5-CONFIG_I: Configured from console by console*Sep 15 17:23:43.567 CST: %CLEAR-5-COUNTERS: Clear counter on all interfaces by console*Sep 15 17:24:42.603 CST: %SYS-5-CONFIG_I: Configured from console by consoleRouter#]]></aml-block:Data></aml-block:Attachment><aml-block:Attachment type="inline"><aml-block:Name>show inventory</aml-block:Name><aml-block:Data encoding="plain"><![CDATA[show inventoryNAME: "2821 chassis", DESCR: "2821 chassis"PID: CISCO2821 , VID: V04 , SN: FTX1217A18ERouter#]]></aml-block:Data></aml-block:Attachment></aml-block:Attachments></aml-block:Block></soap-env:Body></soap-env:Envelope>Additional References
The following sections provide references related to the Call Home feature.
Related Documents
Technical Assistance
Command Reference
For information about all Cisco IOS commands, use the Command Lookup Tool at http://tools.cisco.com/Support/CLILookup or the Cisco IOS Master Command List, All Releases, at http://www.cisco.com/en/US/docs/ios/mcl/allreleasemcl/all_book.html.
Feature Information for Call Home
Table 9 lists the release history for this feature for Cisco integated services routers.
Not all commands may be available in your Cisco IOS software release. For release information about a specific command, see the command reference documentation.
Use Cisco Feature Navigator to find information about platform support and software image support. Cisco Feature Navigator enables you to determine which Cisco IOS, Catalyst OS, and Cisco IOS XE software images support a specific software release, feature set, or platform. To access Cisco Feature Navigator, see http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R)
Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental.
© 2011-2012 Cisco Systems, Inc. All rights reserved.
Feedback