- Index
- Preface
- Product Overview
-
- Configuring Ethernet Interfaces
- Configuring VLANs
- Configuring Private VLANs
- Configuring Rapid PVST+
- Configuring Multiple Spanning Tree
- Configuring STP Extensions
- Configuring EtherChannels
- Configuring Access and Trunk Interfaces
- Configuring the MAC Address Table
- Configuring IGMP Snooping
- Configuring Traffic Storm Control
-
- Configuring Fibre Channel Interfaces
- Configuring Domain Parameters
- Configuring N-Port Virtualization
- Configuring VSAN Trunking
- Configuring SAN PortChannels
- Configuring and Managing VSANs
- Configuring and Managing Zones
- Distributing Device Alias Services
- Configuring Fibre Channel Routing Services and Protocols
- Managing FLOGI, Name Server, FDMI, and RSCN Databases
- Discovering SCSI Targets
- Advanced Fibre Channel Features and Concepts
- Configuring FC-SP and DHCHAP
- Configuring Port Security
- Configuring Fabric Binding
- Configuring Fabric Configuration Servers
- Configuring Port Tracking
- Configuration Limits
- Information About Call Home
- Prerequisites for Call Home
- Configuration Guidelines and Limitations
- Configuring Call Home
- Guidelines for Configuring Call Home
- Configuring Contact Information
- Creating a Destination Profile
- Modifying a Destination Profile
- Associating an Alert Group with a Destination Profile
- Adding show Commands to an Alert Group
- Configuring E-Mail
- Configuring Periodic Inventory Notification
- Disabling Duplicate Message Throttle
- Enabling or Disabling Call Home
- Testing Call Home Communications
- Verifying Call Home Configuration
- Call Home Example Configuration
- Default Settings
- Additional References
Configuring Smart Call Home
This chapter describes how to configure the Smart Call Home feature. This chapter includes the following sections:
Information About Call Home
Call Home provides e-mail-based notification of critical system events. Nexus 5000 Series switches provide a range of message formats for optimal compatibility with pager services, standard e-mail, or XML-based automated parsing applications. You can use this feature to page a network support engineer, e-mail a Network Operations Center, or use Cisco Smart Call Home services to automatically generate a case with the Technical Assistance Center.
This section includes the following topics:
- Call Home Overview
- Destination Profiles
- Call Home Alert Groups
- Call Home Message Levels
- Obtaining Smart Call Home
Call Home Overview
You can use Call Home to notify an external entity when an important event occurs on your device. Call Home delivers alerts to multiple recipients that you configure in destination profiles (see “Destination Profiles” section).
Call Home includes a fixed set of predefined alerts on your switch. These alerts are grouped into alert groups and CLI commands to are assigned to execute when an alert in an alert group occurs. The switch includes the command output in the transmitted Call Home message. See the “Call Home Alert Groups” section for a list of alerts and the predefined set of CLI commands sent when the alert triggers.
The Call Home feature offers the following advantages:
- Automatic execution and attachment of relevant CLI command output.
- Multiple message format options such as the following:
– Short Text—Suitable for pagers or printed reports.
– Full Text—Fully formatted message information suitable for human reading.
– XML—Matching readable format that uses Extensible Markup Language (XML) and Adaptive Messaging Language (AML) XML schema definition (XSD). The AML XSD is published on the Cisco.com web site at http://www.cisco.com/. The XML format enables communication with the Cisco Systems Technical Assistance Center.
Destination Profiles
A destination profile includes the following information:
- One or more alert groups—The group of alerts that trigger a specific Call Home message if the alert occurs.
- One or more e-mail destinations—The list of receipents for the Call Home messages generated by alert groups assigned to this destination profile.
- Message format—The format for the Call Home message (short text, full text, or XML).
- Message severity level—The Call Home severity level that the alert must meet before the switch generates a Call Home message to all e-mail addresses in the destination profile. For more information about Call Home severity levels, see the “Call Home Message Levels” section. The Nexus 5000 Series switch does not generate an alert if the Call Home severity level of the alert is lower than the message severity level set for the destination profile.
You can also configure a destination profile to allow periodic inventory update messages by using the inventory alert group that will send out periodic messages daily, weekly, or monthly.
Nexus 5000 Series switches support the following predefined destination profiles:
- CiscoTAC-1—Supports the Cisco-TAC alert group in XML message format.
- full-text-destination—Supports the full text message format.
- short-text-destination—Supports the short text message format.
See the “Message Formats” section for more information about the message formats.
Call Home Alert Groups
An alert group is a predefined subset of Call Home alerts that are supported in all Nexus 5000 Series switches. Alert groups allow you to select the set of Call Home alerts that you want to send to a predefined or custom destination profile. The switch sends Call Home alerts to e-mail destinations in a destination profile only if that Call Home alert belongs to one of the alert groups associated with that destination profile and if the alert has a Call Home message severity at or above the message severity set in the destination profile (see the “Call Home Message Levels” section).
Table 1-1 lists supported alert groups and the default CLI command output included in Call Home messages generated for the alert group.
Call Home maps the syslog severity level to the corresponding Call Home severity level for syslog port group messages (see the “Call Home Message Levels” section).
You can customize predefined alert groups to execute additional CLI show commands when specific events occur and send that show output with the Call Home message.
You can add show commands only to full text and XML destination profiles. Short text destination profiles do not support additional show commands because they only allow 128 bytes of text.
Call Home Message Levels
Call Home allows you to filter messages based on their level of urgency. You can associate each destination profile (predefined and user defined) with a Call Home message level threshold. The switch does not generate any Call Home messages with a value lower than this threshold for the destination profile. The Call Home message level ranges from 0 (lowest level of urgency) to 9 (highest level of urgency), and the default is 0 (Nexus 5000 Series sends all messages).
Call Home messages that are sent for syslog alert groups have the syslog severity level mapped to the Call Home message level.
Note Call Home does not change the syslog message level in the message text.
Table 1-2 lists each Call Home message level keyword and the corresponding syslog level for the syslog port alert group.
Obtaining Smart Call Home
If you have a service contract directly with Cisco Systems, you can register your devices for the Smart Call Home service. Smart Call Home provides fast resolution of system problems by analyzing Call Home messages sent from your devices and providing background information and recommendations. For issues that can be identified as known, particularly GOLD diagnostics failures, Automatic Service Requests will be generated with the Cisco TAC.
Smart Call Home offers the following features:
- Continuous device health monitoring and real-time diagnostic alerts.
- Analysis of Call Home messages from your device and, where appropriate, Automatic Service Request generation, routed to the appropriate TAC team, including detailed diagnostic information to speed problem resolution.
- Secure message transport directly from your device or through a downloadable Transport Gateway (TG) aggregation point. You can use a TG aggregation point in cases that require support for multiple devices or in cases where security requirements mandate that your devices may not be connected directly to the Internet.
- Web-based access to Call Home messages and recommendations, inventory and configuration information for all Call Home devices. Provides access to associated field notices, security advisories and end-of-life information.
You need the following items to register:
For more information about Smart Call Home, see the Smart Call Home page at this location:
Prerequisites for Call Home
Call Home has the following prerequisites:
- You must configure an e-mail server.
- You must configure the contact name (SNMP server contact), phone, and street address information before you enable Call Home. This step is required to determine the origin of messages received.
- Your switch must have IP connectivity to an e-mail server.
- If you use Smart Call Home, you need an active service contract for the device that you are configuring.
Configuration Guidelines and Limitations
Call Home has the following configuration guidelines and limitations:
Configuring Call Home
This section includes the following topics:
- Guidelines for Configuring Call Home
- Configuring Contact Information
- Creating a Destination Profile
- Modifying a Destination Profile
- Associating an Alert Group with a Destination Profile
- Adding show Commands to an Alert Group
- Configuring E-Mail
- Configuring Periodic Inventory Notification
- Disabling Duplicate Message Throttle
- Enabling or Disabling Call Home
- Testing Call Home Communications
Guidelines for Configuring Call Home
To configure Call Home, perform this task:
Step 1 Assign contact information.
Step 2 Configure destination profiles.
Step 3 Associate one or more alert groups to each profile.
Step 4 (Optional) Add additional show commands to the alert groups.
Step 5 Configure transport options.
Step 7 (Optional) Test Call Home messages.
Configuring Contact Information
You must configure the e-mail, phone, and street address information for Call Home. You can optionally configure the contract ID, customer ID, site ID, and switch priority information.
To configure contact information, perform this task:
This example shows how to configure the contact information for Call Home:
switch# configuration terminal
switch(config)# snmp-server contact personname@companyname.com
switch(config)# callhome
switch(config-callhome)# email-contact admin@Mycompany.com
switch(config-callhome)# phone-contact +1-800-123-4567
switch(config-callhome)# street-address 123 Anystreet st. Anytown,AnyWhere
Creating a Destination Profile
To create a user-defined destination profile and configure the message format for that new destination profile, perform this task:
This example shows how to create a destination profile for Call Home:
switch# configuration terminal
switch(config)# callhome
switch(config-callhome)# destination-profile Noc101 format full-text
Modifying a Destination Profile
You can modify the following attributes for a predefined or user-defined destination profile:
- Destination address—The actual address, pertinent to the transport mechanism, to which the alert should be sent.
- Message formatting—The message format used for sending the alert (full text, short text, or XML).
- Message level—The Call Home message severity level for this destination profile.
- Message size—The allowed length of a Call Home message sent to the e-mail addresses in this destination profile.
See the “Associating an Alert Group with a Destination Profile” section for information on configuring an alert group for a destination profile.
Note You cannot modify or delete the CiscoTAC-1 destination profile.
To modify the attributes for a destination profile, perform this task:
This example shows how to modify a destination profile for Call Home:
switch# configuration terminal
switch(config-callhome)# destination-profile full-text-destination email-addr person@place.com
switch(config-callhome)# destination-profile full-text-destination message-level 5
switch(config-callhome)# destination-profile full-text-destination message-size 10000
Associating an Alert Group with a Destination Profile
To associate one or more alert groups with a destination profile, perform this task:
This example shows how to associate all alert groups with the destination profile Noc101:
switch# configuration terminal
switch(config)# callhome
switch(config-callhome)# destination-profile Noc101 alert-group All
Adding show Commands to an Alert Group
Note You cannot add user-defined CLI show commands to the CiscoTAC-1 destination profile.
To assign a maximum of five user-defined CLI show commands to an alert group, perform this task:
This example shows how to add the show ip routing command o the Cisco-TAC alert group:
switch# configuration terminal
switch(config)# callhome
switch(config-callhome)# alert-group Configuration user-def-cmd “show ip routing”
Configuring E-Mail
You must configure the SMTP server address for the Call Home functionality to work. You can also configure the from and reply-to e-mail addresses.
To configure e-mail, perform this task:
This example shows how to configure the e-mail options for Call Home messages:
switch# configuration terminal
switch(config)# callhome
switch(config-callhome)# transport email smtp-server 192.0.2.10 use-vrf Red
switch(config-callhome)# transport email from person@company.com
switch(config-callhome)# transport email reply-to person@company.com
Configuring Periodic Inventory Notification
You can configure the switch to periodically send a message with an inventory of all software services currently enabled and running on the device along with hardware inventory information. The switch generates two Call Home notifications, periodic configuration messages and periodic inventory messages.
To configure periodic inventory notification, perform this task:
This example shows how to configure the periodic inventory messages to generate every 20 days:
switch# configuration terminal
switch(config)# callhome
switch(config-callhome)# periodic-inventory notification interval 20
Disabling Duplicate Message Throttle
You can limit the number of duplicate messages received for the same event. By default, the switch limits the number of duplicate messages received for the same event. If the number of duplicate messages sent exceeds 30 messages within a 2-hour time frame, then the switch discards further messages for that alert type.
To disable duplicate message throttling in callhome configuration mode, perform this task:
|
|
---|---|
Disables duplicate message throttling for Call Home. Enabled by default. |
Enabling or Disabling Call Home
Once you have configured the contact information, you can enable the Call Home function.
To enable Call Home in callhome configuration mode, perform this task:
|
|
---|---|
To disable Call Home in the callhome configuration mode, perform this task:
|
|
---|---|
To enable Call Home distribution using CFS in the callhome configuration mode, perform this task:
|
|
---|---|
Enables Call Home distribution using CFS. Disabled by default. |
To commit Call Home configuration changes and distribute using CFS in the callhome configuration mode, perform this task:
|
|
---|---|
Commits Call Home configuration changes and distributes the changes to call CFS-enabled devices. |
To discard Call Home configuration changes and release the CFS lock in callhome configuration mode, perform this task:
|
|
---|---|
Discards Call Home configuration changes and releases the CFS lock. Use this command if you are the CFS lock owner or if you are logged into the device that holds the CFS lock |
Testing Call Home Communications
You can generate a test message to test your Call Home communications.
To generate a test Call Home message, perform this task:
Verifying Call Home Configuration
To display Call Home configuration information, perform one of the following tasks:
|
|
---|---|
Displays the Call Home configuration changes in the pending CFS database. |
|
Displays the differences between the pending and running Call Home configuration. |
|
Call Home Example Configuration
The following example uses CFS to create a destination profile called Noc101, associate the Cisco-TAC alert group to that profile, configure contact and e-mail information, and distribute those changes to all CFS-enabled devices:
snmp-server contact person@company.com
email-contact admin@Mycompany.com
street-address 123 Anystreet st. Anytown,AnyWhere
destination-profile Noc101 full-text
destination-profile full-text-destination email-addr person@company.com
destination-profile full-text-destination message-level 5
destination-profile Noc101 alert-group Configuration
alert-group Configuration user-def-cmd “show ip routing”
Default Settings
Table 1-3 lists the default settings for Call Home parameters.
Additional References
For additional information related to implementing Call Home, see the following sections:
- Message Formats
- Sample syslog Alert Notification in Full-Text Format
- Sample syslog Alert Notification in XML Format
Message Formats
Call Home supports the following message formats:
- Short Text Message Format
- Common Fields for All Full Text and XML Messages
- Inserted Fields for a Reactive or Proactive Event Message
- Inserted Fields for an Inventory Event Message
- Inserted Fields for a User-Generated Test Message
Table 1-4 describes the short text formatting option for all message typesTable 1-4.
|
|
---|---|
Table 1-5 describes the common event message format for full text or XML.
(Plain Text and XML) |
(Plain Text and XML) |
(XML Only) |
---|---|---|
Name of message. Specific event names are listed in the Table 1-4 . |
||
Severity level of message (see “Call Home Message Levels” section). |
||
Unique device identifier (UDI) for end device that generated the message. This field should be empty if the message is nonspecific to a device. 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 device, this is the unique device identifier (UDI) of the device. The format is type @ Sid @ seria l. |
||
Name of person to contact for issues associated with the node that experienced the event. |
||
E-mail address of person identified as the contact for this unit. |
||
Phone number of the person identified as the contact for this unit. |
||
Optional field that contains the street address for RMA part shipments associated with this unit. |
||
Model name of the device (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 “Call Home Alert Groups” section). |
Table 1-6 describes the reactive event message format for full text or XML.
Table 1-7 describes the inventory event message format for full text or XML.
(Plain Text and XML) |
(Plain Text and XML) |
(XML Only) |
---|---|---|
Name of the affected FRU that is generating the event message. |
||
Table 1-8 describes the user-generated test message format for full text or XML.
(Plain Text and XML) |
(Plain Text and XML) |
(XML Only) |
---|---|---|
Sample syslog Alert Notification in Full-Text Format
This sample shows the full-text format for a syslog port alert-group notification:
Sample syslog Alert Notification in XML Format
This sample shows the XML format for a syslog port alert-group notification: