- Index
- Preface
- Product Overview
- Virtual Switching Systems (VSS)
- Layer 2 LAN Port Configuration
- Flex Links
- EtherChannels
- IEEE 802.1ak MVRP and MRP
- VLAN Trunking Protocol (VTP)
- VLANs
- Private VLANs (PVLANs)
- Private Hosts
- IEEE 802.1Q Tunneling
- Layer 2 Protocol Tunneling
- Spanning Tree Protocols (STP, MST)
- Optional STP Features
- IP Unicast Layer 3 Switching
- Multiprotocol Label Switching (MPLS)
- MPLS VPN Support
- Ethernet over MPLS (EoMPLS)
- Virtual Private LAN Services (VPLS)
- Ethernet Virtual Connections (EVC)
- Layer 2 over Multipoint GRE (L2omGRE)
- IPv4 Multicast Layer 3 Features
- IPv4 Multicast IGMP Snooping
- IPv4 PIM Snooping
- IPv4 Multicast VLAN Registration (MVR)
- IPv4 IGMP Filtering
- IPv4 Router Guard
- IPv4 Multicast VPN Support
- IPv6 Multicast Layer 3 Features
- IPv6 MLD Snooping
- NetFlow Hardware Support
- Call Home
- System Event Archive (SEA)
- Backplane Platform Monitoring
- Local SPAN, RSPAN, and ERSPAN
- SNMP IfIndex Persistence
- Top-N Reports
- Layer 2 Traceroute Utility
- Mini Protocol Analyzer
- PFC QoS Overview
- PFC QoS Guidelines and Restrictions
- PFC QoS Classification, Marking, and Policing
- PFC QoS Policy Based Queueing
- PFC QoS Global and Interface Options
- AutoQoS
- MPLS QoS
- PFC QoS Statistics Data Export
- Cisco IOS ACL Support
- Cisco TrustSec (CTS)
- AutoSecure
- MAC Address-Based Traffic Blocking
- Port ACLs (PACLs)
- VLAN ACLs (VACLs)
- Policy-Based Forwarding (PBF)
- Denial of Service (DoS) Protection
- Control Plane Policing (CoPP)
- Dynamic Host Configuration Protocol (DHCP) Snooping
- IP Source Guard
- Dynamic ARP Inspection (DAI)
- Traffic Storm Control
- Unknown Unicast and Multicast Flood Control
- IEEE 802.1X Port-Based Authentication
- Configuring Web-Based Authentication
- Port Security
- Lawful Intercept
- Online Diagnostic Tests
- Migrating From a 12.2SX QoS Configuration
Catalyst 6500 Release 15.0SY Software Configuration Guide
Bias-Free Language
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.
- Updated:
- February 24, 2012
Chapter: Call Home
- Prerequisites for Call Home
- Restrictions for Call Home
- Information About Call Home
- Default Settings for Call Home
- How to Configure Call Home
Call Home
- Prerequisites for Call Home
- Restrictions for Call Home
- Information About Call Home
- Default Settings for Call Home
- How to Configure Call Home
- Verifying the Call Home Configuration
Note ●
For complete syntax and usage information for the commands used in this chapter, see these publications:
http://www.cisco.com/en/US/products/ps11845/prod_command_reference_list.html
- Cisco IOS Release 15.0SY supports only Ethernet interfaces. Cisco IOS Release 15.0SY does not support any WAN features or commands.
– CA certificate auto update for HTTPS connection
http://www.cisco.com/en/US/products/hw/switches/ps708/tsd_products_support_series_home.html
Participate in the Technical Documentation Ideas forum
Prerequisites for Call Home
- Obtain the following information for the Call Home contact that will be configured so that the receiver can determine the origin of messages received:
– Customer contact email (required for full registration with Smart Call Home, optional if Call Home is enabled in anonymous mode)
– Customer phone number (optional)
– Customer street address (optional)
- If using email message delivery, identify the name or IPv4 or IPv6 address of a primary Simple Mail Transfer Protocol (SMTP) server and any backup servers.
- If using secure HTTP (HTTPS) message delivery, configure a trustpoint certificate authority (CA). This procedure is required if you are using the HTTPS server for Cisco Smart Call Home Service in the CiscoTAC-1 profile for Call Home.
- Verify IP connectivity from the router to the email server(s) or the destination HTTP server.
- If servers are specified by name, the switch must have IP connectivity to a domain name server.
- If using Cisco Smart Call Home, verify that an active service contract exists for the device being configured.
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: https://supportforums.cisco.com/community/netpro/solutions/smart_services/smartcallhome
Restrictions for Call Home
Information About Call Home
- Call Home Overview
- Smart Call Home
- Alert Group Trigger Events and Commands
- Message Contents
- Sample Syslog Alert Notification in Long-Text Format
- Sample Syslog Alert Notification in XML Format
Call Home Overview
Call Home provides these notification options of critical system events:
- Email (for example, to a Network Operations Center) or web-based.
- XML delivery to a support website for automated parsing.
- Cisco Smart Call Home supports direct case generation with the Cisco Systems Technical Assistance Center (TAC).
The Call Home alert messages contain information on configuration, diagnostics, environmental conditions, inventory, syslog, snapshot, and crash 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 (CiscoTAC-1) is provided, and you also can define your own destination profiles. The CiscoTAC-1 profile is used to send alerts to the backend server of the Smart Call Home service, which can be used to create service requests to the Cisco TAC (depending on the Smart Call Home service support in place for your device and the severity of the alert).
Flexible message delivery and format options make it easy to integrate specific support requirements. If multiple destination profiles are configured, the system tries to send call-home messages from every configured profile.
The Call Home feature provides these functions:
– Short Text—Suitable for pagers or printed reports.
– Long 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). The XML format enables communication with the Cisco Smart Call Home server.
- 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.
- Continuous device health monitoring and real-time diagnostics alerts.
- Analysis of Call Home messages from your device and, where supported, 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 that provides access to associated Field Notices, Security Advisories and End-of-Life Information.
Smart Call Home
If you have a service contract directly with Cisco Systems, you can register your Call Home devices for the Cisco Smart Call Home service.
Smart Call Home provides these features:
- Continuous device health monitoring and real-time diagnostic alerts.
- Analysis of Smart Call Home messages and, if needed, Automatic Service Request generation routed to the correct TAC team, including detailed diagnostic information to speed problem resolution.
- Secure message transport directly from your device or through an HTTP proxy server or a downloadable Transport Gateway (TG). You can use a TG aggregation point to support multiple devices or in cases where security dictates that your devices may not be connected directly to the Internet.
- Web-based access to Smart Call Home messages and recommendations, inventory, and configuration information for all Smart Call Home devices provides access to associated field notices, security advisories, and end-of-life information.
For issues that can be identified as known, particularly GOLD diagnostics failures, depending on the Smart Call Home service support in place for your device and the severity of the alert, Automatic Service Requests will be generated with the Cisco TAC.
You need the following items to register:
For detailed information on Smart Call Home, see the Smart Call Home page at this location:
https://supportforums.cisco.com/community/netpro/solutions/smart_services/smartcallhome
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. These tables list the trigger events included in each alert group, including the severity level of each event and the executed CLI commands for the alert group:
- Call Home Syslog Alert Group Events and Actions , Table 1-1
- Call Home Environmental Alert Group Events and Actions , Table 1-2
- Call Home Inventory Alert Group Events and Actions , Table 1-3
- Call Home Diagnostic Failure Alert Group Events and Actions , Table 1-4
- Call Home Test Alert Group Events and Actions , Table 1-5
|
|
|||
|---|---|---|---|
|
|
|||
|
|
show logging, show inventory, show switch virtual (VSS mode only) |
||
|
|
|
|
|
|
|
||
|---|---|---|
|
|
||
|
|
||
|
|
||
|
|
|
|
Message Contents
The following tables display the content formats of alert group messages:
- Table 1-6 describes the content fields of a short text message.
- Table 1-7 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 after the common fields.
- Table 1-8 describes the content fields for reactive messages (system failures that require a TAC case) and proactive messages (issues that might result in degraded system performance).
- Table 1-9 describes the content fields for an inventory message.
|
|
|
|---|---|
|
(Plain Text and XML) |
(Plain Text and XML) |
(XML Only) |
|---|---|---|
Name of message. Specific event names are listed in the “Alert Group Trigger Events and Commands” section. |
||
Severity level of message (see Table 1-10). |
||
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 @ 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. The format is type @ Sid @ seria l. |
||
Node that experienced the event. This is the host name of the device. |
||
Name of person to contact for issues associated with the node experiencing the event. |
||
Email address of person identified as contact for this unit. |
||
Phone number of the person identified as the contact for this unit. |
||
Optional field containing street address for RMA part shipments associated with this unit. |
||
Model name of the switch. This is the specific model as part of a product family name. |
||
| The following fields may be repeated if multiple CLI commands are executed for this alert group. |
||
Output of command automatically executed (see the “Alert Group Trigger Events and Commands” section). |
||
|
(Plain Text and XML) |
(Plain Text and XML) |
(XML Only) |
|---|---|---|
CallHome/Device/Cisco_Chassis/Cisco_Card/SoftwareIdentity/VersionString |
||
Sample Syslog Alert Notification in Long-Text Format
Sample Syslog Alert Notification in XML Format
Default Settings for Call Home
- Call Home feature status: disabled
- User-defined profile status: active
- Predefined Cisco TAC profile status: inactive
- Transport method: email
- 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: 0 (debugging)
- Message rate limit for messages per minute: 20
- Call Home syslog message throttling: enabled
- Data privacy level: normal
How to Configure Call Home
- Configuring Call Home Customer Contact Information
- Configuring Destination Profiles
- Subscribing to Alert Groups
- Enabling Call Home
- Configuring Call Home Traffic Rate Limiting
- Configuring Syslog Throttling
- Testing Call Home Communications
- Configuring the Smart Call Home Service
Configuring Call Home Customer Contact Information
To configure the customer contact information, perform this task:
This example shows the configuration of contact information:
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
Configuring Destination Profiles
Destination Profile Overview
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 profile. If you define a new destination profile, you must assign a profile name.
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 email or HTTP (including HTTPS), for delivery of alerts.
– For user-defined destination profiles, email is the default, and you can enable either or both transport mechanisms. If you disable both methods, email will be enabled.
– For the predefined Cisco TAC profile, you can enable either transport mechanism, but not both.
- 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.
– For user-defined destination profiles, the format options are long-text, short-text, or XML. The default is XML.
– The predefined Cisco TAC profile uses 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.
Note ● The Call Home feature provides a predefined profile named CiscoTAC-1 that is inactive by default. The CiscoTAC-1 profile is intended for use with the Smart Call Home service, which requires certain additional configuration steps to enable the service with the Call Home feature. For more information about this profile, see the “Using the Predefined CiscoTAC-1 Destination Profile” section.
- If you use the Cisco Smart Call Home service, the destination profile must use the XML message format.
Configuring Call Home to Use VRF
To configure Call Home to use a VRF interface for Call Home email or for HTTP messages, perform this task:
|
|
|
|
|---|---|---|
Associates the call_home_vrf_name VRF instance with the interface. |
||
This example shows how to configure Call Home to use a VRF interface:
Router(config)# interface gigabitethernet 1/1
Router(config-if)# ip address 10.10.10.10 0.0.0.0
Configuring a Destination Profile to Send Email Messages
- Configuring Call Home to Use VRF for Email Messages (optional)
- Configuring the Mail Server (required)
- Configuring a Destination Profile for Email (required)
Note To send Call Home email messages through a VRF interface, configure Call Home to use VRF (see “Configuring Call Home to Use VRF” section).
Configuring Call Home to Use VRF for Email Messages
To configure Call Home to use a VRF instance for Call Home email messages, perform this task:
|
|
|
|
|---|---|---|
Specifies the VRF instance to use for Call Home email messages. |
This example shows how to configure Call Home to use a VRF interface:
Configuring the Mail Server
To use the email message transport, perform this task:
The following example shows the configuration of a primary mail server (named “smtp.example.com”) and secondary mail server at IP address 192.168.0.1:
Router(cfg-call-home)# mail-server smtp.example.com priority 1
Configuring a Destination Profile for Email
To configure a destination profile for email transport, complete this task:
Configuring an HTTP Proxy Server
To specify an HTTP proxy server for Call Home HTTP(S) messages, perform this task:
|
|
|
|
|---|---|---|
|
|
||
|
|
||
http-proxy { ipv4-address | ipv6-address | name } port port-number |
Configuring a Destination Profile to Send HTTP Messages
Configuring the HTTP Source Interface
To configure an HTTP client source interface, perform this task:
|
|
|
|
|---|---|---|
Configures the source interface for the HTTP client. If the interface is associated with a VRF instance, the HTTP messages use the VRF instance. |
Configuring a Destination Profile for HTTP
To configure a destination profile for HTTP transport, perform this task:
This example shows how to configure a destination profile for HTTP transport:
Configuring a Trustpoint Certificate Authority
If you are using the HTTP transport method and specifying an HTTPS destination URL, then you will also need to configure a trustpoint certificate authority (CA). See the “Declare and Authenticate a CA Trustpoint” section.
Destination Profile Management
Activating and Deactivating a Destination Profile
Except for the predefined CiscoTAC-1 profile, all 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 to be used.
To activate or deactivate a destination profile, perform this task:
This example shows how to activate a destination profile:
This example shows how to deactivate a destination profile:
Copying a Destination Profile
To create a new destination profile by copying an existing profile, perform this task:
This example shows how to activate a destination profile:
Renaming a Destination Profile
To change the name of an existing profile, perform this task:
|
|
|
|
|---|---|---|
Router(cfg-call-home)# rename profile source_profile target_profile |
This example shows how to activate a destination profile:
Using the Predefined CiscoTAC-1 Destination Profile
The CiscoTAC-1 profile is automatically configured in the Call Home feature for your use with the Cisco Smart Call Home service. This profile includes certain information, such as the destination email address and HTTPS URL, and default alert groups for communication with the Smart Call Home service. Some of these attributes, such as the destination email address, HTTPS URL, and message format cannot be modified.
You can use either email or http transport to communicate with the Smart Call Home service backend server. By default, the CiscoTAC-1 profile is inactive and uses email as the default transport method. To use email transport, you only need to enable the profile. However, to use this profile with the Cisco Smart Call Home service secure server (via HTTPS), you not only must enable the profile, but you must also change the transport method to HTTP as shown in the following example:
For more information about additional requirements for Configuring the Smart Call Home service, see the “Smart Call Home Overview” section.
Verifying the Call Home Profile Configuration
To verify the profile configuration for Call Home, use the show call-home profile command. See the “Verifying the Call Home Configuration” section for more information and examples.
Subscribing to Alert Groups
Overview of Alert Group Subscription
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:
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.
Configuring Alert Group Subscription
To subscribe a destination profile to an alert group, perform this task:
|
|
|
|
|---|---|---|
Router(cfg-call-home)# alert-group { all | configuration | 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. |
|
Enters the Call Home destination profile configuration submode for the specified destination profile. |
||
Subscribes this destination profile to all available alert groups using the lowest severity.
|
||
Router(cfg-call-home-profile)# subscribe-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 “Periodic Notification” section. |
|
Router(cfg-call-home-profile)# subscribe-to-alert-group diagnostic [ severity { catastrophic | critical | debugging | disaster | fatal | major | minor | normal | notification | warning }] |
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 “Message Severity Thresholds” section. |
|
Router(cfg-call-home-profile)# subscribe-to-alert-group environment [ severity { catastrophic | critical | debugging | disaster | fatal | major | minor | normal | notification | warning }] |
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 Thresholds” section. |
|
Router(cfg-call-home-profile)# subscribe-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 “Periodic Notification” section. |
|
Router(cfg-call-home-profile)# subscribe-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 “Message Severity Thresholds” section. You can specify a pattern to be matched in the syslog message, as described in the “Configuring Syslog Pattern Matching” section. If the pattern contains spaces, you must enclose it in quotes (“”). |
|
Exits the Call Home destination profile configuration submode. |
Periodic Notification
When you subscribe a destination profile to either the configuration or inventory alert group (see the “Configuring Alert Group Subscription” section), 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.
Message Severity Thresholds
When you subscribe a destination profile to the Diagnostic, Environment, or Syslog alert group (see the “Configuring Alert Group Subscription” section), 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.
The severity threshold is configured using the keywords in Table 1-10 , 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 Call Home severity levels are not the same as system message logging severity levels.
|
|
|
|
|
|---|---|---|---|
Basic notification and informational messages. Possibly independently insignificant. |
|||
Configuring Syslog Pattern Matching
When you subscribe a destination profile to the Syslog alert group (see the “Configuring Alert Group Subscription” section), 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.
Enabling Call Home
To enable the Call Home feature, perform this task:
|
|
|
|
|---|---|---|
Configuring Call Home Traffic Rate Limiting
To configure Call Home traffic rate limiting, perform this task:
|
|
|
|
|---|---|---|
(Optional) Specifies a limit on the number of messages sent per minute, from 1 to 60. The default is 20. |
This example shows how to configure Call Home traffic rate limiting:
Configuring Syslog Throttling
To enable call-home syslog message throttling, which avoids sending repetitive call-home syslog messages, perform this task:
|
|
|
|
|---|---|---|
|
|
||
|
|
||
|
|
Enables call-home syslog message throttling, which avoids sending repetitive call-home syslog messages. By default, syslog message throttling is enabled. |
Testing Call Home Communications
Sending a Call Home Test Message Manually
To manually send a Call Home test message, perform this task:
Sending a Call Home Alert Group Message Manually
To manually trigger a Call Home alert group message, perform this task:
- 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.
Sending a Request for an Analysis and Report
To submit a request for report and analysis information from the Cisco Output Interpreter tool, perform this task:
- If a profile name is specified, the request will be sent to the profile. If no profile is specified, the request will be 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 email address where the transport gateway is configured so that the request message can be forwarded to the Cisco TAC and the user can receive the reply from the Smart Call Home service.
- The ccoid user-id is the registered identifier of the Smart Call Home user. If the user-id is specified, the response will be sent to the email address of the registered user. If no user-id is specified, the response will be sent to the contact email address of the device.
- Based on the keyword specifying the type of report requested, the following information will be 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
To execute one or more CLI commands and send the command output through HTTP or e-mail, perform this task:
The following example shows how to send the output of a command to a user-specified e-mail address:
The following example shows the command output sent in long-text format to attach@cisco.com, with the SR number specified:
The following example shows the command output sent in XML message format to callhome@cisco.com:
The following example shows the command output sent in XML message format to the Cisco TAC backend server, with the SR number specified:
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:
Configuring the Smart Call Home Service
Smart Call Home Overview
For application and configuration information of the Cisco Smart Call Home service, see the “Quick Start for Smart Call Home” section of the Smart Call Home User Guide :
http://www.cisco.com/en/US/docs/switches/lan/smart_call_home/SCH31_Ch1.html#Quick_Start_for_Smart_Call_Home
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.
Tip From the Smart Call Home website, you can download a basic configuration script to assist you in the configuration of the Call Home feature for use with Smart Call Home service and the Cisco TAC. The script also assists 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 a link under the “Smart Call Home Resources” heading at: https://supportforums.cisco.com/community/netpro/solutions/smart_services/smartcallhome
Smart Call Home Service Prerequisites
Enabling the Smart Call Home Service
The CiscoTAC-1 profile is predefined in the Call Home feature to communicate using email to the backend server for the Smart Call Home service. The URL to the Cisco HTTPS backend server is also predefined. This profile is inactive by default.
Unlike other profiles that you can configure in Call Home to support both transport methods, the CiscoTAC-1 profile can only use one transport method at a time. To use this profile with the Cisco Smart Call Home HTTPS server, you must change the transport method from email to HTTP and enable the profile. In addition, you must minimally specify a contact email address and enable the Call Home feature.
To enable the Smart Call Home service, perform this task:
This example shows how to enable the Smart Call Home service:
Declare and Authenticate a CA Trustpoint
To declare and authenticate the Cisco server security certificate and establish communication with the Cisco HTTPS server for Smart Call Home service, perform this task:
The example shows how to declare and authenticate the Cisco server security certificate and establish communication with the Cisco HTTPS server for Smart Call Home service:
(CA certificate text not shown)
Start Smart Call Home Registration
To start the Smart Call Home registration process, perform this task:
|
|
|
|---|---|
Router# call-home send alert-group inventory profile CiscoTAC-1 |
Manually sends an inventory alert group message to the CiscoTAC-1 destination profile. |
After the Smart Call Home service is registered, you will receive an email from Cisco Systems. Follow the instructions in the email. The instructions include these procedures:
- To complete the device registration, launch the Smart Call Home web application at the following URL:
- Accept the Legal Agreement.
- Confirm device registration for Call Home devices with pending registration.
For more information about using the Smart Call Home web application, see the Smart Call Home User Guide. This user guide also 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 must not be connected directly to the Internet.
Verifying the Call Home Configuration
To display the configured Call Home information, perform these tasks:
Examples 1-1 to 1-9 show sample results with Release 15.1(1)SY when using different options of the show call-home command.
Example 1-1 Configured Call Home Information
Example 1-2 Configured Call Home Information in Detail
Example 1-3 Available Call Home Alert Groups
Example 1-4 Email Server Status Information
Example 1-5 Information for All Destination Profiles (Predefined and User-Defined)
Example 1-6 Information for a User-Defined Destination Profile
Example 1-7 Call Home Statistics
Example 1-8 Call Home Statistics Detail
Example 1-9 Call Home Statistics profile campus-noc
http://www.cisco.com/en/US/products/hw/switches/ps708/tsd_products_support_series_home.html
Participate in the Technical Documentation Ideas forum
Feedback