The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
This chapter describes how to configure the Smart Call Home feature for Cisco Connected Grid switches. This chapter includes the following sections:
|
|
|
---|---|---|
Cisco Connected Grid 10-port Ethernet Switch Module Interface Card (ESM) |
Cisco Connected Grid Ethernet Switch Module Interface Card Software Configuration Guide |
|
Cisco 2500 Series Connected Grid Switches Configuration Guides |
Smart Call Home provides a notification and alert system for critical system events. A range of message formats are available for compatibility with pager services, standard e-mail, or XML-based automated parsing applications.
Common uses can include direct paging of a network support engineer, e-mail notification to a network operations center, and XML delivery to a support website.
The Smart Call Home feature provides these functions:
– Short text—Suitable for pagers or printed reports.
– Plain text—Full formatted message information suitable for human reading.
– XML—Machine readable format using Extensible Markup Language (XML) and Adaptive Markup Language (AML) document type definitions (DTDs).
|
|
---|---|
Destination message size for a message sent in long text, short text, or XML format |
|
Before you configure Smart Call Home:
Beginning in privileged EXEC mode, follow these steps to configure the customer contact information:
This example shows how to configure contact information:
If an interface configured on the specified VRF can connect to the mail server, the Smart Call Home feature uses it to send e-mail messages. If no appropriate interface is configured on the specified VRF, or if the corresponding VRF table does not exist on the switch, no messages are sent.
Beginning in privileged EXEC mode, follow these steps to use a VRF interface for Smart Call Home e-mail or for HTTP messages:
|
|
|
---|---|---|
This example shows how to configure Smart Call Home to use a VRF interface:
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.
To use the Smart Call Home feature, you need to both enable Smart Call Home and configure a profile. You must configure required fields in the profiles. If a required field is not configured, that profile cannot initiate notification messages.
You can use the predefined destination profile or define a custom profile. If you define a new destination profile, you must assign a profile name.
You can configure these attributes for a destination profile:
– 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 is enabled.
– For user-defined destination profiles, the options are long-text, short-text, or XML. The default is XML.
Beginning in privileged EXEC mode, follow these steps to configure Smart Call Home to use a VRF instance for Smart Call Home e-mail messages:
|
|
|
---|---|---|
Specify the VRF instance to use for Smart Call Home e-mail messages. If a VRF is not specified, the default routing table is used. |
||
This example shows how to configure Smart Call Home to use a VRF interface:
Beginning in privileged EXEC mode, follow these steps to use the e-mail message transport:
This example shows how to configure a primary mail server ( smtp.example.com) and a secondary mail server that is at IP address 192.168.0.1:
Beginning in privileged EXEC mode, follow these steps to configure a destination profile for e-mail transport:
Beginning in privileged EXEC mode, follow these steps to configure other e-mail options:
Note You can configure either a source IP address or a source interface, but not both.
This example shows how to configure the e-mail options with a source IP address:
This example shows how to configure the e-mail options with a source interface:
Beginning in privileged EXEC mode, follow these steps to configure an HTTP client source interface:
|
|
|
---|---|---|
Configure the source interface for the HTTP client. If the interface is associated with a VRF instance, the HTTP messages use the VRF instance. |
Beginning in privileged EXEC mode, follow these steps to configure a destination profile for HTTP transport:
This example shows how to configure a destination profile for HTTP transport:
Beginning in privileged EXEC mode, follow these steps to configure Smart Call Home traffic rate limiting:
|
|
|
---|---|---|
(Optional) Specify the number of messages sent per minute. The range is from 1 to 60. The default is 20. |
This example shows how to configure Smart Call Home traffic rate limiting:
Except for the predefined CiscoTAC-1 profile, all Smart Call Home destination profiles are automatically activated when you create them. If you do not want to use a profile right way, you can deactivate the profile. The CiscoTAC-1 profile is inactive by default and must be activated for use.
Beginning in privileged EXEC mode, follow these steps to activate or deactivate a destination profile:
This example shows how to activate a destination profile:
This example shows how to deactivate a destination profile:
Beginning in privileged EXEC mode, follow these steps to create a new destination profile by copying an existing profile:
|
|
|
---|---|---|
Create a new destination profile with the same configuration settings as the existing destination profile: |
This example shows how to activate a destination profile:
Beginning in privileged EXEC mode, follow these steps to change the name of an existing profile:
|
|
|
---|---|---|
This example shows how to rename a destination profile:
To verify the profile configuration, use the show call-home profile command. See Verifying Smart Call Home Configuration for more information and examples.
An alert group is a predefined subset of Smart Call Home alerts supported on all switches. The alerts are grouped based on their type:
The trigger events for each alert group are listed in Alert Group Trigger Events and Commands, and the contents of the alert group messages are listed in Message Contents.
You can specify one or more alert groups to be received by a destination profile.
Note A Smart Call Home alert is sent only to destination profiles that have subscribed to the alert group containing that Smart Call Home alert. The alert group must also be enabled.
Beginning in privileged EXEC mode, follow these steps to subscribe a destination profile to an alert group:
|
|
|
---|---|---|
alert-group { all | configuration | diagnostic | environment | inventory | syslog } |
Enable the specified alert group. Use the keyword all to enable all alert groups. By default, all alert groups are enabled. |
|
Enter the Smart Call Home destination profile configuration submode for the specified destination profile. |
||
subscribe-to-alert-group configuration [ periodic { daily hh:mm | monthly date hh:mm | weekly day hh:mm }] |
Subscribe this destination profile to the Configuration alert group. To configure the Configuration alert group for periodic notification, see Configuring Periodic Notification. |
|
subscribe-to-alert-group diagnostic [ severity { catastrophic | critical | debugging | disaster | fatal | major | minor | normal | notification | warning }] |
Subscribe this destination profile to the Diagnostic alert group. To configure the Diagnostic alert group to filter messages based on severity, see Configuring Message Severity Threshold. |
|
subscribe-to-alert-group environment [ severity { catastrophic | critical | debugging | disaster | fatal | major | minor | normal | notification | warning }] |
Subscribe this destination profile to the Environment alert group. To configure the Environment alert group to filter messages based on severity, see Configuring Message Severity Threshold. |
|
subscribe-to-alert-group inventory [ periodic { daily hh:mm | monthly date hh:mm | weekly day hh:mm }] |
Subscribe this destination profile to the Inventory alert group. To configure the Inventory alert group for periodic notification, see Configuring Periodic Notification. |
|
subscribe-to-alert-group syslog [ severity { catastrophic | disaster | fatal | critical | major | minor | warning | notification | normal | debugging } [ pattern string ]] |
Subscribe this destination profile to the Syslog alert group. To configure the Syslog alert group to filter messages based on severity, see Configuring Message Severity Threshold. To specify a pattern to be matched in the syslog message, see Configuring Syslog Pattern Matching. If the pattern contains spaces, you must enclose it in quotes (“ ”). |
|
Exit the Smart Call Home destination profile configuration submode. |
When you subscribe a destination profile to either the Configuration or the Inventory alert group (see Configuring Alert Group Subscription), you can receive the alert group messages asynchronously or periodically at a specified time:
When you subscribe a destination profile to the Diagnostic, Environment, or Syslog alert group (see Configuring Alert Group Subscription), you can set a threshold for sending alert group messages based on levels of severity of a message. Any message with a value lower than the threshold specified in the destination profile is not sent to the destination.
The severity threshold is configured using the keywords in Table 7-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 debugging (level 0).
Note Smart Call Home severity levels are not the same as system message logging severity levels.
|
|
|
|
---|---|---|---|
Basic notification and informational messages. Possibly independently insignificant. |
|||
When you subscribe a destination profile to the Syslog alert group (see Configuring Alert Group Subscription), 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 (“ ”) when configuring it. You can specify up to five patterns for each destination profile.
Beginning in privileged EXEC mode, follow these steps to enable or disable the Smart Call Home feature:
|
|
|
---|---|---|
You can test Smart Call Home communications by manually sending messages. To send a user-defined Smart Call Home test message, use the call-home test command. To send a specific alert group message, use the call-home send command.
Beginning in privileged EXEC mode, follow these steps to manually send a Smart Call Home test message:
Beginning in privileged EXEC mode, follow these steps to manually trigger a Smart Call Home alert group message:
When manually sending Smart Call Home alert group messages, note these guidelines:
– An active profile that subscribes to diagnostic events with a severity level of less than 4 receives the message whether or not the module or interface had a diagnostic event.
– An active profile that subscribes to diagnostic events with a severity level of 4 or higher receives the message only if the specified module or interface had a diagnostic event of level 4 or higher. Otherwise, the destination profile receives no diagnostic message.
You can use the call-home request command to submit information about your system to Cisco 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.
Beginning in privileged EXEC mode, follow these steps to submit a request for report and analysis information from the Cisco Output Interpreter tool:
When manually sending a Smart Call Home report and analysis request, note these guidelines:
– config-sanity —Information on best practices for the current running configuration.
– bugs-list —Known bugs in the running version and in the current 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 can affect devices in your network.
This example shows a request for analysis of a user-specified show command:
You can use the call-home send command to enter a command and to e-mail the command output to Cisco or to a specified e-mail address.
Beginning in privileged EXEC mode, follow these steps to enter a command and e-mail the command output:
|
|
---|---|
call-home send "command " [ email email-addr ] [ tac-service-request SR ] |
When sending the command output, note these guidelines:
This example shows how to send the output of a command to an e-mail address that you specify:
Switch# call-home send "show diagnostic result module all" email support@example.com
Beginning in privileged EXEC mode, enter these commands to display the configured Smart Call Home information:
Examples 7-1 to 7-7 show the results when using different options of the show call-home command.
Example 7-1 Configured Smart Call Home Information
Example 7-2 Configured Smart Call Home Information in Detail
Example 7-3 Available Smart Call Home Alert Groups
Example 7-4 E-mail Server Status Information
Example 7-5 Information for All Destination Profiles (Predefined and User-Defined)
Example 7-6 Information for a User-Defined Destination Profile
Example 7-7 Smart Call Home Statistics
Smart Call Home trigger events are grouped into alert groups, with each alert group assigned to execute Cisco IOS commands when an event occurs. The command output is included in the message. These tables list the trigger events included in each alert group, including the severity level of each event and the executed commands for the alert group:
These tables display the content formats of alert group messages:
|
|
---|---|
Number that indicates the severity of the alarm. The range is from 0 (most severe) to 7 (least severe). |
(Plain Text and XML) |
(Plain Text and XML) |
(XML Only) |
---|---|---|
Name of message. Specific event names are listed in Alert Group Trigger Events and Commands. |
||
Specifically reactive or proactive. (The default is reactive.) |
||
Severity level of message. (See Table 7-1.) |
||
Product type for routing, typically the product family name. |
||
Unique device identifier (UDI) for the end device that generated the message. This field is empty if the message is nonspecific to a fabric switch. The format is type @ Sid @ seria l. |
||
Optional user-configurable field used for contract information or other ID by any support service. |
||
Optional user-configurable field used for contract information or other ID by any support service. |
||
Optional user-configurable field used for Cisco-supplied site ID or other data meaningful to alternate support service. |
||
If the message is generated from the fabric switch, this is the unique device identifier (UDI) of the switch. If the message is proxied or originated by a source other than the switch, this field shows the UDI of the source. The format is type @ Sid @ seria l. |
||
Node that experienced the event. This is the hostname of the device. |
||
Name of person to contact for issues associated with the node experiencing the event. |
||
Optional field containing street address for replacement part shipments. |
||
Model name of the switch. This is the specific model as part of a product family name. |
||
These fields can be repeated if multiple commands are executed for this alert group. |
||
Output of command automatically executed. (See Alert Group Trigger Events and Commands.) |
(Plain Text and XML) |
(Plain Text and XML) |
(XML Only) |
---|---|---|
CallHome/Device/Cisco_Chassis/Cisco_Card/SoftwareIdentity/VersionString |
||