Information About Call Home
The Call Home feature provides message throttling capabilities. Periodic inventory messages, port syslog messages, and RMON alert messages are added to the list of deliverable Call Home messages. If required you can also use the Cisco Fabric Services application to distribute the Call Home configuration to all other switches in the fabric.
The Call Home service provides email-based notification of critical system events. A versatile range of message formats are available for optimal compatibility with pager services, standard email, or XML-based automated parsing applications.
Common features may include the following:
- Paging the network support engineer
- Emailing the Network Operations Center
- Raising a direct case with the Technical Assistance Center
The Call Home functionality is available directly through the Cisco MDS 9000 Family switches and the Cisco Nexus 5000 Series switches. It provides multiple Call Home messages, each with separate potential destinations. You can define your own destination profiles in addition to predefined profiles; you can configure up to 50 email addresses for each destination profile. Flexible message delivery and format options make it easy to integrate specific support requirements.
The Call Home feature offers the following advantages:
- Fixed set of predefined alerts for trigger events on the switch.
- Automatic execution and attachment of relevant command output.
This section includes the following topics:
Call Home Features
The Call Home functionality is available directly through the Cisco MDS 9000 Family switches and the Cisco Nexus 5000 Series switches. It provides multiple Call Home profiles (also referred to as Call Home destination profiles), each with separate potential destinations. You can define your own destination profiles in addition to predefined profiles.
The Call Home function can even leverage support from Cisco Systems or another support partner. Flexible message delivery and format options make it easy to integrate specific support requirements.
The Call Home feature offers the following advantages:
- Fixed set of predefined alerts and trigger events on the switch.
- Automatic execution and attachment of relevant command output.
- Multiple message format options:
– Short Text—Suitable for pagers or printed reports.
– Plain Text—Full formatted message information suitable for human reading.
– XML—Matching readable format using Extensible Markup Language (XML) and document type definitions (DTDs) named Messaging Markup Language (MML). The MML DTD is published on the Cisco.com website at http://www.cisco.com/. The XML format enables communication with the Cisco Systems Technical Assistance Center.
- Multiple concurrent message destinations. You can configure up to 50 email destination addresses for each destination profile.
- Multiple message categories including system, environment, switching module hardware, supervisor module, hardware, inventory, syslog, RMON, and test.
- Secure messages 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 requires that your devices not be connected directly to the Internet.
About Smart Call Home
Smart Call Home is a component of Cisco SMARTnet Service that offers proactive diagnostics, real-time alerts, and personalized web-based reports on select Cisco devices.
Smart Call Home provides fast resolution of system problems by analyzing Call Home messages sent from your devices and providing a direct notification path to Cisco customer support.
Smart Call Home offers the following features:
- Continuous device health monitoring and real-time diagnostics 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.
- 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.
Table 4-1 lists the benefits of Smart Call Home.
Table 4-1 Benefits of Smart Call Home Compared to Autonotify
|
|
|
Low touch registration |
The registration process is considerably streamlined. Customers no longer need to know their device serial number or contract information. They can register devices without manual intervention from Cisco by sending a message from those devices. The procedures are outlined at www.cisco.com/go/smartcall |
Requires the customer to request Cisco to add each specific serial number to the database. |
Recommendations |
Smart Call Home provides recommendations for known issues including those for which SRs are raised and for which SRs are not appropriate but for which customers might want to still take action on. |
Autonotify raises SRs for a set of failure scenarios but no recommendations are provided for these. |
Device report |
Device report includes full inventory and configuration details. Once available, the information in these reports will be mapped to field notices, PSIRTs, EoX notices, configuration best practices and bugs. |
No. |
History report |
The history report is available to look up any message and its contents, including show commands, message processing, analysis results, recommendations and service request numbers for all messages sent over the past three months. |
A basic version is available that does not include contents of message. |
Network summary report |
A report that provides a summary of the make-up of devices and modules in the customer network (for those devices registered with Smart Call home) |
No. |
Cisco device support |
Device Support will be extended across the Cisco product range. See the supported products table at www.cisco.com/go/smartcall |
Deprecated in favor of Smart Call Home in October 2008. |
Obtaining Smart Call Home
If you have a service contract directly with Cisco Systems, you can receive automatic case generation from the Technical Assistance Center by registering with the Smart Call Home service.
You need the following items to register:
- The SMARTnet contract number for your switch.
- Your email address
- Your Cisco.com ID
For detailed information on Smart Call Home, including quick start configuration and registration steps, see the Smart Call Home page at this location:
http://www.cisco.com/go/smartcall/
Call Home Destination Profiles
A destination profile contains the required delivery information for an alert notification. Destination profiles are typically configured by the network administrator.
Using alert groups you can select the set of Call Home alerts to be received by a destination profile (predefined or user defined). Alert groups are predefined subsets of Call Home alerts supported in all switches in the Cisco MDS 9000 Family and the Cisco Nexus 5000 Series. Different types of Call Home alerts are grouped into different alert groups depending on their type. You can associate one or more alert groups to each profile as required by your network.
Call Home Alert Groups
An alert group is a predefined subset of Call Home alerts supported in all switches in the Cisco MDS 9000 Family and Cisco Nexus 5000 Series. Alert groups allow you to select the set of Call Home alerts to be received by a destination profile (predefined or user-defined). A Call Home alert is sent to email destinations in a destination profile only if that Call Home alert belongs to one of the alert groups associated with that destination profile.
Using the predefined Call Home alert groups you can generate notification messages when certain events occur on the switch. You can customize predefined alert groups to execute additional show commands when specific events occur and to notify you of output other than from the predefined show commands.
Customized Alert Group Messages
An alert group is a predefined subset of Call Home alerts supported in all switches in the Cisco MDS 9000 Family and Cisco Nexus 5000 Series switches. Alert groups allow you to select the set of Call Home alerts to be received by a destination profile (predefined or user-defined). The predefined Call Home alert groups generate notification messages when certain events occur on the switch. You can customize predefined alert groups to execute additional show commands when specific events occur.
The output from these additional show commands is included in the notification message along with the output of the predefined show commands.
Call Home Message Level Feature
The Call Home message level feature allows you to filter messages based on their level of urgency. Each destination profile (predefined and user-defined) is associated with a Call Home message level threshold. Any message with a value lower than the urgency threshold is not sent. Call Home severity levels are not the same as system message logging severity levels.
Syslog-Based Alerts
You can configure the switch to send certain syslog messages as Call Home messages. The messages are sent based on the mapping between the destination profile and the alert group mapping, and on the severity level of the generated syslog message.
To receive a syslog-based Call Home alert, you must associate a destination profile with the syslog alert groups (currently there is only one syslog alert group—syslog-group-port) and configure the appropriate message level.
The syslog-group-port alert group selects syslog messages for the port facility. The Call Home application maps the syslog severity level to the corresponding Call Home severity level (see the “Call Home Message Levels” section). For example, if you select level 5 for the Call Home message level, syslog messages at levels 0, 1, and 2 are included in the Call Home log.
Whenever a syslog message is generated, the Call Home application sends a Call Home message depending on the mapping between the destination profile and the alert group mapping and based on the severity level of the generated syslog message. To receive a syslog-based Call Home alert, you must associate a destination profile with the syslog alert groups (currently there is only one syslog alert group—syslog-group-port) and configure the appropriate message level (see the “Call Home Message Levels” section).
Note Call Home does not change the syslog message level in the message text. The syslog message texts in the Call Home log appear as they are described in the Cisco MDS 9000 Family System Messages Reference.
RMON-Based Alerts
You can configure the switch to send Call Home notifications corresponding to RMON alert triggers. All RMON-based Call Home messages have their message level set to NOTIFY (2). The RMON alert group is defined for all RMON-based Call Home alerts. To receive an RMON-based Call Home alert, you must associate a destination profile with the RMON alert group.
General Email Options Using HTTPS Support
The HTTPS support for Call Home provides a transport method called HTTP. HTTPS support is used for a secure communication, and HTTP is used for nonsecure communication. You can configure an HTTP URL for the Call Home destination profile as a destination. The URL link can be from a secure server or nonsecure server. For a destination profile configured with the HTTP URL, the Call Home message is posted to the HTTP URL link.
Note The Call Home HTTP configuration can be distributed over CFS on the switches running NX-OS Release 4.2(1) and later. The Call Home HTTP configuration cannot be distributed to switches that support the nondistributable HTTP configuration. Switches running lower versions than NX-OS Release 4.2(1) and later will ignore the HTTP configuration.
Multiple SMTP Server Support
Cisco MDS NX-OS and Cisco NX-OS 5000 Series switches support multiple SMTP servers for Call Home. Each SMTP server has a priority configured between 1 and 100, with 1 being the highest priority and 100 being the lowest. If the priority is not specified, a default value of 50 is used.
You can configure up to five SMTP servers for Call Home. The servers are contacted based on their priority. The highest priority server is contacted first. If the message fails to be sent, the next server in the list is contacted until the limit is exhausted. If two servers have equal priority, the one that was configured earlier is contacted.
If a high-priority SMTP server fails, the other servers will be contacted. A time delay may occur while sending a message. The delay is minimal if the attempt to send the message through the first SMTP server is successful. The delay may increase depending on the number of unsuccessful attempts with different SMTP servers.
Note The new configuration process is not related to the old configuration. However, if the SMTP servers are configured using both the old and new schemes, the older configuration is of the highest priority.
Multiple SMTP servers can be configured on any MDS 9000 Family switch, Cisco Nexus 5000 Series switches, and Cisco Nexus 7000 Series switches running Release 5.0(1a) or later.
The new configuration will only be distributed to switches that have multiple SMTP servers. The older switches in the fabric will ignore the new configuration received over CFS.
In a mixed fabric that has CFS enabled, the switches running NX-OS Release 5.0 can configure new functionalities and distribute the new configuration to other switches with Release 5.0 in the fabric over CFS. However, if an existing switch running NX-OS Release 4.x upgrades to Release 5.0, the new configurations will not be distributed to that switch as a CFS merge is not triggered on an upgrade. There are two options to upgrade:
- Apply new configuration only when all the switches in the fabric support them. (Recommended option).
- Do an empty commit from an existing NX-OS Release 5.0 switch which has the new configuration
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 switch along with hardware inventory information. The inventory is modified each time the switch is restarted nondisruptively.
Duplicate Message Throttle
You can configure a throttling mechanism to limit the number of Call Home messages received for the same event. If the same message is sent multiple times from the switch within a short period of time, you may be swamped with a large number of duplicate messages.
Call Home Configuration Distribution
You can enable fabric distribution for all Cisco MDS 9000 Family switches and Cisco Nexus 5000 Series switches in the fabric. When you perform Call Home configurations, and distribution is enabled, that configuration is distributed to all the switches in the fabric. However, the switch priority and the Syscontact names are not distributed.
You automatically acquire a fabric-wide lock when you enter the first configuration command operation after you enable distribution in a switch. The Call Home application uses the effective and pending database model to store or commit the configuration changes. When you commit the configuration changes, the effective database is overwritten by the configuration changes in the pending database and all the switches in the fabric receive the same configuration. After making the configuration changes, you can choose to discard the changes by aborting the changes instead of committing them. In either case, the lock is released. See Chapter 2, “Using the CFS Infrastructure” for more information on the CFS application.
Note The switch priority and the Syscontact name are not distributed.
Fabric Lock Override
If you have performed a Call Home task and have forgotten to release the lock by either committing or discarding the changes, an administrator can release the lock from any switch in the fabric. If the administrator performs this task, your changes to the pending database are discarded and the fabric lock is released.
Tip The changes are only available in the volatile directory and are subject to being discarded if the switch is restarted.
Clearing Call Home Name Server Database
When the Call Home name server database is full, a new entry cannot be added. The device is not allowed to come online. To clear the name server database, increase the database size or perform a cleanup by removing unused devices. A total of 20,000 name server entries are supported.
EMC Email Home Delayed Traps
DCNM-SAN can be configured to generate EMC Email Home XML email messages. In SAN-OS Release 3.x or earlier, DCNM-SAN listens to interface traps and generates EMC Email Home email messages. Link traps are generated when an interface goes to down from up or vice versa. For example, if there is a scheduled server reboot, the link goes down and DCNM-SAN generates an email notification.
Cisco NX-OS Release 4.1(3) provides the ability to generate a delayed trap so that the number of generated email messages is reduced. This method filters server reboots and avoids generating unnecessary EMC Email Home email messages. In NX-OS Release 4.1(3), users have the ability to select the current existing feature or this new delayed trap feature.
Event Triggers
This section discusses Call Home trigger events. Trigger events are divided into categories, with each category assigned CLI commands to execute when the event occurs. The command output is included in the transmitted message. Table 4-2 lists the trigger events
Table 4-2 Event Triggers
|
|
|
|
|
Call Home |
System and CISCO_TAC |
SW_CRASH |
A software process has crashed with a stateless restart, indicating an interruption of a service. |
5 |
System and CISCO_TAC |
SW_SYSTEM_INCONSISTENT |
Inconsistency detected in software or file system. |
5 |
Environmental and CISCO_TAC |
TEMPERATURE_ALARM |
Thermal sensor indicates temperature reached operating threshold. |
6 |
POWER_SUPPLY_FAILURE |
Power supply failed. |
6 |
FAN_FAILURE |
Cooling fan has failed. |
5 |
Line Card Hardware and CISCO_TAC |
LINECARD_FAILURE |
Line card hardware operation failed. |
7 |
POWER_UP_DIAGNOSTICS_FAILURE |
Line card hardware failed power-up diagnostics. |
7 |
Line Card Hardware and CISCO_TAC |
PORT_FAILURE |
Hardware failure of interface port(s). |
6 |
Line Card Hardware, Supervisor Hardware, and CISCO_TAC |
BOOTFLASH_FAILURE |
Failure of boot compact flash card. |
6 |
Supervisor Hardware and CISCO_TAC |
NVRAM_FAILURE |
Hardware failure of NVRAM on supervisor hardware. |
6 |
Supervisor Hardware and CISCO_TAC |
FREEDISK_FAILURE |
Free disk space is below a threshold on supervisor hardware. |
6 |
Supervisor Hardware and CISCO_TAC |
SUP_FAILURE |
Supervisor hardware operation failed. Note When the active supervisor is removed, a switch over occurs. A call home notification for this event will not be sent. |
7 |
POWER_UP_DIAGNOSTICS_FAILURE |
Supervisor hardware failed power-up diagnostics. |
7 |
Supervisor Hardware and CISCO_TAC |
INBAND_FAILURE |
Failure of in-band communications path. |
7 |
Supervisor Hardware and CISCO_TAC |
EOBC_FAILURE |
Ethernet out-of-band channel communications failure. |
6 |
Call Home |
Supervisor Hardware and CISCO_TAC |
MGMT_PORT_FAILURE |
Hardware failure of management Ethernet port. |
5 |
License |
LICENSE_VIOLATION |
Feature in use is not licensed, and are turned off after grace period expiration. |
6 |
Inventory |
Inventory and CISCO_TAC |
COLD_BOOT |
Switch is powered up and reset to a cold boot sequence. |
2 |
HARDWARE_INSERTION |
New piece of hardware inserted into the chassis. |
2 |
HARDWARE_REMOVAL |
Hardware removed from the chassis. |
2 |
Test |
Test and CISCO_TAC |
TEST |
User generated test. |
2 |
Port syslog |
Syslog-group- port |
SYSLOG_ALERT |
Syslog messages corresponding to the port facility. |
2 |
RMON |
RMON |
RMON_ALERT |
RMON alert trigger messages. |
2 |
Call Home Message Levels
Table 4-3 Event Categories and Executed Commands
|
|
|
System show module show version show tech-support platform show tech-support sysmgr show hardware show sprom all |
Events generated by failure of a software system that is critical to unit operation. |
show tech-support show system redundancy status |
Environmental show module show version show environment show logging logfile | tail -n 200 |
Events related to power, fan, and environment sensing elements such as temperature alarms. |
show module show environment |
Line Card Hardware show module show version show tech-support platform show tech-support sysmgr show hardware show sprom all |
Events related to standard or intelligent line card hardware. |
show tech-support |
Supervisor Hardware show module show version show tech-support platform show tech-support sysmgr show hardware show sprom all |
Events related to supervisor modules. |
show tech-support |
Inventory show module show version show hardware show inventory show system uptime show sprom all show license usage |
Inventory status is provided whenever a unit is cold booted, or when FRUs are inserted or removed. This is considered a noncritical event, and the information is used for status and entitlement. |
show version |
Test show module show version |
User generated test message. |
show version |
Call Home messages (sent for syslog alert groups) have the syslog severity level mapped to the Call Home message level (see the “Syslog-Based Alerts” section).
This section discusses the severity levels for a Call Home message when using one or more switches in the Cisco MDS 9000 Family and the Cisco Nexus 5000 Series. Call Home message levels are preassigned per event type.
Severity levels range from 0 to 9, with 9 having the highest urgency. Each syslog level has keywords and a corresponding syslog level as listed in Table 4-4 .
Note Call Home does not change the syslog message level in the message text. The syslog message texts in the Call Home log appear as they are described in the Cisco MDS 9000 Family System Messages Reference.
Note Call Home severity levels are not the same as system message logging severity levels (see the Cisco MDS 9000 Family System Messages Reference).
Table 4-4 Severity and Syslog Level Mapping
|
|
|
|
Catastrophic (9) |
Catastrophic |
N/A |
Network wide catastrophic failure. |
Disaster (8) |
Disaster |
N/A |
Significant network impact. |
Fatal (7) |
Fatal |
Emergency (0) |
System is unusable. |
Critical (6) |
Critical |
Alert (1) |
Critical conditions, immediate attention needed. |
Major (5) |
Major |
Critical (2) |
Major conditions. |
Minor (4) |
Minor |
Error (3) |
Minor conditions. |
Warning (3) |
Warning |
Warning (4) |
Warning conditions. |
Notify (2) |
Notification |
Notice (5) |
Basic notification and informational messages. Possibly independently insignificant. |
Normal (1) |
Normal |
Information (6) |
Normal event signifying return to normal state. |
Debug (0) |
Debugging |
Debug (7) |
Debugging messages. |
Message Contents
The following contact information can be configured on the switch:
- Name of the contact person
- Phone number of the contact person
- Email address of the contact person
- Mailing address to which replacement parts must be shipped, if required
- Site ID of the network where the site is deployed
- Contract ID to identify the service contract of the customer with the service provider
Table 4-5 describes the short text formatting option for all message types.
Table 4-5 Short Text Messages
|
|
Device identification |
Configured device name |
Date/time stamp |
Time stamp of the triggering event |
Error isolation message |
Plain English description of triggering event |
Alarm urgency level |
Error level such as that applied to system message |
Table 4-6 , Table 4-7 , and Table 4-8 display the information contained in plain text and XML messages.
Table 4-6 Reactive Event Message Format
Data Item
(Plain text and XML)
|
Description
(Plain text and XML)
|
|
Time stamp |
Date and time stamp of event in ISO time notation: YYYY-MM-DD T HH:MM:SS. Note The time zone or daylight savings time (DST) offset from UTC has already been added or subtracted. T is the hardcoded limiter for the time. |
/mml/header/time - ch:EventTime |
Message name |
Name of message. Specific event names are listed in the “Event Triggers” section. |
/mml/header/name |
Message type |
Specifically “Call Home.” |
/mml/header/type - ch:Type |
Message group |
Specifically “reactive.” |
/mml/header/group |
Severity level |
Severity level of message (see Table 4-4 ). |
/mml/header/level - aml-block:Severity |
Source ID |
Product type for routing. |
/mml/header/source - ch:Series |
Device ID |
Unique device identifier (UDI) for end device generating message. This field should empty if the message is non-specific to a fabric switch. Format is type @ Sid @ seria l, where:
- type is the product model number from backplane SEEPROM.
- @ is a separator character.
- Sid is “C,” identifying the serial ID as a chassis serial number.
- serial is the number identified by the Sid field.
Example: DS-C9509@C@12345678 |
/mml/ header/deviceId |
Customer ID |
Optional user-configurable field used for contract info or other ID by any support service. |
/mml/header/customerID - ch:CustomerId |
Contract ID |
Optional user-configurable field used for contract info or other ID by any support service. |
/mml/header/contractId - ch:ContractId> |
Site ID |
Optional user-configurable field used for Cisco-supplied site ID or other data meaningful to alternate support service. |
/mml/header/siterId - ch:SiteId |
Server ID |
If the message is generated from the fabric switch, it is the unique device identifier (UDI) of the switch. Format is type @ Sid @ seria l, where:
- type is the product model number from backplane SEEPROM.
- @ is a separator character.
- Sid is “C,,” identifying the serial ID as a chassis serial number.
- serial is the number identified by the Sid field.
Example: DS-C9509@C@12345678 |
/mml/header/serverId - -blank- |
Message description |
Short text describing the error. |
/mml/body/msgDesc - ch:MessageDescription |
Device name |
Node that experienced the event. This is the host name of the device. |
/mml/body/sysName - ch:SystemInfo/Name |
Contact name |
Name of person to contact for issues associated with the node experiencing the event. |
/mml/body/sysContact - ch:SystemInfo/Contact |
Contact email |
Email address of person identified as contact for this unit. |
/mml/body/sysContactemail - ch:SystemInfo/Contactemail |
Contact phone number |
Phone number of the person identified as the contact for this unit. |
/mml/body/sysContactPhoneNumber - ch:SystemInfo/ContactPhoneNumber |
Street address |
Optional field containing street address for RMA part shipments associated with this unit. |
/mml/body/sysStreetAddress - ch:SystemInfo/StreetAddress |
Model name |
Model name of the switch. This is the specific model as part of a product family name. |
/mml/body/chassis/name - rme:Chassis/Model |
Serial number |
Chassis serial number of the unit. |
/mml/body/chassis/serialNo - rme:Chassis/SerialNumber |
Chassis part number |
Top assembly number of the chassis. |
/mml/body/fru/partNo - rme:chassis/Card/PartNumber |
Chassis hardware version |
Hardware version of chassis. |
/mml/body/chassis/hwVersion - rme:Chassis/HardwareVersion |
Supervisor module software version |
Top level software version. |
/mml/body/fru/swVersion - rme:chassis/Card/SoftwareIdentity |
Affected FRU name |
Name of the affected FRU generating the event message. |
/mml/body/fru/name - rme:chassis/Card/Model |
Affected FRU serial number |
Serial number of affected FRU. |
/mml/body/fru/serialNo - rme:chassis/Card/SerialNumber |
Affected FRU part number |
Part number of affected FRU. |
/mml/body/fru/partNo - rme:chassis/Card/PartNumber |
FRU slot |
Slot number of FRU generating the event message. |
/mml/body/fru/slot - rme:chassis/Card/LocationWithinContainer |
FRU hardware version |
Hardware version of affected FRU. |
/mml/body/fru/hwVersion - rme:chassis/Card/SoftwareIdentity |
FRU software version |
Software version(s) running on affected FRU. |
/mml/body/fru/swVersion - rme:chassis/Card/SoftwareIdentity |
Command output name |
The exact name of the issued command. |
/mml/attachments/attachment/name - aml-block:Attachment/Name |
Attachment type |
Specifically command output. |
/mml/attachments/attachment/type - aml-block:Attachment type |
MIME type |
Normally text or plain or encoding type. |
/mml/attachments/attachment/mime - aml-block:Attachment/Data encoding |
Command output text |
Output of command automatically executed (see Table 4-3 ). |
/mml/attachments/attachment/atdata - aml-block:Attachment/Data |
Table 4-7 Inventory Event Message Format
Data Item
(Plain text and XML)
|
Description
(Plain text and XML)
|
|
Time stamp |
Date and time stamp of event in ISO time notation: YYYY-MM-DD T HH:MM:SS. Note The time zone or daylight savings time (DST) offset from UTC has already been added or subtracted. T is the hardcoded limiter for the time. |
/mml/header/time - ch:EventTime |
Message name |
Name of message. Specifically “Inventory Update” Specific event names are listed in the “Event Triggers” section. |
/mml/header/name |
Message type |
Specifically “Inventory Update.” |
/mml/header/type - ch-inv:Type |
Message group |
Specifically “proactive.” |
/mml/header/group |
Severity level |
Severity level of inventory event is level 2 (see Table 4-4 ). |
/mml/header/level - aml-block:Severity |
Source ID |
Product type for routing at Cisco. Specifically “MDS 9000.” |
/mml/header/source - ch-inv:Series |
Device ID |
Unique Device Identifier (UDI) for end device generating message. This field should empty if the message is non-specific to a fabric switch. Format is type @ Sid @ seria l, where:
- type is the product model number from backplane SEEPROM.
- @ is a separator character.
- Sid is “C,,” identifying the serial ID as a chassis serial number.
- serial is the number identified by the Sid field.
Example: DS-C9509@C@12345678 |
/mml/ header /deviceId |
Customer ID |
Optional user-configurable field used for contact info or other ID by any support service. |
/mml/header/customerID - ch-inv:CustomerId |
Contract ID |
Optional user-configurable field used for contact info or other ID by any support service. |
/mml/header/contractId - ch-inv:ContractId> |
Site ID |
Optional user-configurable field, can be used for Cisco-supplied site ID or other data meaningful to alternate support service. |
/mml/header/siterId - ch-inv:SiteId |
Server ID |
If the message is generated from the fabric switch, it is the Unique device identifier (UDI) of the switch. Format is type @ Sid @ seria l, where:
- type is the product model number from backplane SEEPROM.
- @ is a separator character.
- Sid is “C,,” identifying the serial ID as a chassis serial number.
- serial is the number identified by the Sid field.
Example: DS-C9509@C@12345678 |
/mml/header/serverId - -blank- |
Message description |
Short text describing the error. |
/mml/body/msgDesc - ch-inv:MessageDescription |
Device name |
Node that experienced the event. |
/mml/body/sysName - ch-inv:SystemInfo/Name |
Contact name |
Name of person to contact for issues associated with the node experiencing the event. |
/mml/body/sysContact - ch-inv:SystemInfo/Contact |
Contact email |
Email address of person identified as contact for this unit. |
/mml/body/sysContactemail - ch-inv:SystemInfo/Contactemail |
Contact phone number |
Phone number of the person identified as the contact for this unit. |
/mml/body/sysContactPhoneNumber - ch-inv:SystemInfo/ContactPhoneNumber |
Street address |
Optional field containing street address for RMA part shipments associated with this unit. |
/mml/body/sysStreetAddress - ch-inv:SystemInfo/StreetAddress |
Model name |
Model name of the unit. This is the specific model as part of a product family name. |
/mml/body/chassis/name - rme:Chassis/Model |
Serial number |
Chassis serial number of the unit. |
/mml/body/chassis/serialNo - rme:Chassis/SerialNumber |
Chassis part number |
Top assembly number of the chassis. |
/mml/body/fru/partNo - rme:chassis/Card/PartNumber |
Chassis hardware version |
Hardware version of chassis. |
/mml/body/fru/hwVersion - rme:chassis/Card/SoftwareIdentity |
Supervisor module software version |
Top level software version. |
/mml/body/fru/swVersion - rme:chassis/Card/SoftwareIdentity |
FRU name |
Name of the affected FRU generating the event message. |
/mml/body/fru/name - rme:chassis/Card/Model |
FRU s/n |
Serial number of FRU. |
/mml/body/fru/serialNo - rme:chassis/Card/SerialNumber |
FRU part number |
Part number of FRU. |
/mml/body/fru/partNo - rme:chassis/Card/PartNumber |
FRU slot |
Slot number of FRU. |
/mml/body/fru/slot - rme:chassis/Card/LocationWithinContainer |
FRU hardware version |
Hardware version of FRU. |
/mml/body/fru/hwVersion - rme:chassis/Card/SoftwareIdentity |
FRU software version |
Software version(s) running on FRU. |
/mml/body/fru/swVersion - rme:chassis/Card/SoftwareIdentity |
Command output name |
The exact name of the issued command. |
/mml/attachments/attachment/name - aml-block:Attachment/Name |
Attachment type |
Specifically command output. |
/mml/attachments/attachment/type - aml-block:Attachment type |
MIME type |
Normally text or plain or encoding type. |
/mml/attachments/attachment/mime - aml-block:Attachment/Data encoding |
Command output text |
Output of command automatically executed after event categories (see “Event Triggers” section). |
/mml/attachments/attachment/atdata - aml-block:Attachment/Data |
Table 4-8 User-Generated Test Message Format
Data Item
(Plain text and XML)
|
Description
(Plain text and XML)
|
|
Time stamp |
Date and time stamp of event in ISO time notation: YYYY-MM-DD T HH:MM:SS. Note The time zone or daylight savings time (DST) offset from UTC has already been added or subtracted. T is the hardcoded limiter for the time. |
/mml/header/time - ch:EventTime |
Message name |
Name of message. Specifically test message for test type message. Specific event names listed in the “Event Triggers” section). |
/mml/header/name |
Message type |
Specifically “Test Call Home.” |
/mml/header/type - ch:Type |
Message group |
This field should be ignored by the receiving Call Home processing application, but may be populated with either “proactive” or “reactive.” |
/mml/header/group |
Severity level |
Severity level of message, test Call Home message (see Table 4-4 ). |
/mml/header/level - aml-block:Severity |
Source ID |
Product type for routing. |
/mml/header/source - ch:Series |
Device ID |
Unique device identifier (UDI) for end device generating message. This field should empty if the message is nonspecific to a fabric switch. Format is type @ Sid @ seria l, where:
- type is the product model number from backplane SEEPROM.
- @ is a separator character.
- Sid is “C” identifying the serial ID as a chassis serial number.
- serial is the number identified by the Sid field.
Example: DS-C9509@C@12345678 |
/mml/ header /deviceId |
Customer ID |
Optional user-configurable field used for contract info or other ID by any support service. |
/mml/header/customerID - ch:CustomerId |
Contract ID |
Optional user-configurable field used for contract info or other ID by any support service. |
/mml/header/contractId - ch:ContractId |
Site ID |
Optional user-configurable field used for Cisco-supplied site ID or other data meaningful to alternate support service. |
/mml/header/siterId - ch:SiteId |
Server ID |
If the message is generated from the fabric switch, it is the Unique device identifier (UDI) of the switch. Format is type @ Sid @ seria l, where:
- type is the product model number from backplane SEEPROM.
- @ is a separator character.
- Sid is “C” identifying the serial ID as a chassis serial number.
- serial is the number identified by the Sid field.
Example: “DS-C9509@C@12345678 |
/mml/header/serverId - -blank- |
Message description |
Short text describing the error. |
/mml/body/msgDesc - ch:MessageDescription |
Device name |
Switch that experienced the event. |
/mml/body/sysName - ch:SystemInfo/Name |
Contact name |
Name of person to contact for issues associated with the node experiencing the event. |
/mml/body/sysContact - ch:SystemInfo/Contact |
Contact email |
Email address of person identified as contact for this unit. |
/mml/body/sysContactemail - ch:SystemInfo/Contactemail |
Contact phone number |
Phone number of the person identified as the contact for this unit. |
/mml/body/sysContactPhoneNumber - ch:SystemInfo/ContactPhoneNumber |
Street address |
Optional field containing street address for RMA part shipments associated with this unit. |
/mml/body/sysStreetAddress - ch:SystemInfo/StreetAddress |
Model name |
Model name of the switch. This is the specific model as part of a product family name. |
/mml/body/chassis/name - rme:Chassis/Model |
Serial number |
Chassis serial number of the unit. |
/mml/body/chassis/serialNo - rme:Chassis/SerialNumber |
Chassis part number |
Top assembly number of the chassis. For example, 800-xxx-xxxx. |
/mml/body/fru/partNo - rme:chassis/Card/PartNumber |
Command output text |
Output of command automatically executed after event categories listed in Table 4-3 . |
/mml/attachments/attachment/atdata - aml-block:Attachment/Data |
MIME type |
Normally text or plain or encoding type. |
/mml/attachments/attachment/mime - aml-block:Attachment/Data encoding |
Attachment type |
Specifically command output. |
/mml/attachments/attachment/type - aml-block:Attachment type |
Command output name |
The exact name of the issued command. |
/mml/attachments/attachment/name - aml-block:Attachment/Name |
Configuring Call Home
How you configure the Call Home process depends on how you intend to use the feature.
This section includes the following topics:
Task Flow for Configuring Call Home
Follow these steps to configure Call Home:
Step 1 Configure contact information.
Step 2 Enable or disable Call Home.
Step 3 Configure destination profiles.
Step 4 Associate one or more alert groups to each profile as required by your network. Customize the alert groups, if desired.
Step 5 Configure email options.
Step 6 Test Call Home messages.
Configuring Contact Information
Switch priority is specific to each switch in the fabric. This priority is used by the operations personnel or TAC support personnel to decide which Call Home message they should respond to first. You can prioritize Call Home alerts of the same severity from each switch.
Prerequisites
- Each switch must include email, phone, and street address information. You can optionally include the contract ID, customer ID, site ID, and switch priority information.
Detailed Steps
To assign the contact information, follow these steps:
|
|
|
Step 1 |
switch# config t |
Enters configuration mode. |
Step 2 |
switch(config)# snmp-server contact personname@companyname.com |
Configures the SNMP contact name. |
Step 3 |
switch(config)# callhome switch(config-callhome)# |
Enters the Call Home configuration submode. |
Step 4 |
switch(config-callhome)# email-contact username@company.com |
Assigns the customer’s email address. Up to 128 alphanumeric characters are accepted in email address format. Note You can use any valid email address. You cannot use spaces. |
Step 5 |
switch(config-callhome)# phone-contact +1-800-123-4567 |
Assigns the customer’s phone number. Up to 20 alphanumeric characters are accepted in international format. Note You cannot use spaces. Be sure to use the + prefix before the number. |
Step 6 |
switch(config-callhome)# streetaddress 1234 Picaboo Street, Any city, Any state, 12345 |
Assigns the customer’s street address where the equipment is located. Up to 256 alphanumeric characters are accepted in free format. |
Step 7 |
switch(config-callhome)# switch-priority 0 |
Assigns the switch priority, with 0 being the highest priority and 7 the lowest.
Tip Use this field to create a hierarchical management structure.
|
Step 8 |
switch(config-callhome)# customer-id Customer1234 |
Optional. Identifies the customer ID. Up to 256 alphanumeric characters are accepted in free format. |
Step 9 |
switch(config-callhome)# site-id Site1ManhattanNY |
Optional. Identifies the customer site ID. Up to 256 alphanumeric characters are accepted in free format. |
Step 10 |
switch(config-callhome)# contract-id Company1234 |
Assigns the customer ID for the switch. Up to 64 alphanumeric characters are accepted in free format. |
Enabling Call Home Function
Once you have configured the contact information, you must enable the Call Home function.
Detailed Steps
To enable the Call Home function, follow these steps:
|
|
|
Step 1 |
switch# config t |
Enters configuration mode. |
Step 2 |
switch(config)# callhome switch(config-callhome)# |
Enters Call Home configuration submode. |
Step 3 |
switch(config-callhome)# enable callhome enabled successfully switch(config-callhome)# |
Enables the Call Home function. |
switch(config-callhome)# disable switch(config-callhome)# |
Disables the Call Home function. When you disable the Call Home function, all input events are ignored. Note Even if Call Home is disabled, basic information for each Call Home event is sent. |
Configuring Destination Profiles
A destination profile contains the required delivery information for an alert notification. Destination profiles are typically configured by the network administrator.
You can configure the following attributes for a destination profile:
- Profile name—A string that uniquely identifies each user-defined destination profile and is limited to 32 alphanumeric characters. The format options for a user-defined destination profile are full-txt, short-txt, or XML (default).
- 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).
Note If you use the Cisco Smart Call Home service, the XML destination profile is required (see http://www.cisco.com/en/US/partner/products/hw/ps4159/ps4358/products_configuration_example09186a0080108e72.shtml).
Prerequisites
- At least one destination profile is required. You can configure multiple destination profiles of one or more types. You can use one of the predefined destination profiles or define a desired profile. If you define a new profile, you must assign a profile name.
Detailed Steps
To configure predefined destination profile messaging options, follow these steps:
|
|
|
Step 1 |
switch# config t |
Enters configuration mode. |
Step 2 |
switch(config)# callhome switch(config-callhome)# |
Enters the Call Home configuration submode. |
Step 3 |
switch(config-callhome)# destination-profile full-txt-destination email-addr person@place.com |
Configures an email address for the predefined full-txt-destination profile. The email addresses in this destination profile receives messages in full-txt format. The full-text format provides the complete, detailed explanation of the failure.
Tip Use a standard email address that does not have any text size restrictions.
|
switch(config-callhome)# destination-profile full-txt-destination message-size 1000000 |
Configures a maximum destination message size for the predefined full-txt-destination profile. The valid range is 0 to 1,000,000 bytes and the default is 500,000. A value of 0 implies that a message of any size can be sent. Note The maximum size of each individual attachment inside the message is 250,000 bytes. If any attachment is more than this maximum size, then the output captured in the attachment will be truncated. |
Step 4 |
switch(config-callhome)# destination-profile short-txt-destination email-addr person@place.com |
Configures an email address for the predefined short-txt-destination profile. The email addresses in this destination profile receive messages in short-txt format. This format provides the basic explanation of the failure in the Call Home message.
Tip Use a pager-related email address for this option.
|
switch(config-callhome)# destination-profile short-txt-destination message-size 100000 |
Configures maximum destination message size for the predefined short-txt-destination profile. The valid range is 0 to 1,000,000 bytes and the default is 4000. A value of 0 implies that a message of any size can be sent. Note The maximum size of each individual attachment inside the message is 250,000 bytes. If any attachment is more than this maximum size, then the output captured in the attachment will be truncated. |
Step 5 |
switch(config-callhome)# destination-profile XML-destination email-addr findout@.cisco.com |
Configures an email address for the predefined XML-destination profile. The email addresses in this destination-profile receives messages in XML format. This format provides information that is compatible with Cisco Systems TAC support.
Tip Do not add a pager-related email address to this destination profile because of the large message size.
|
switch(config-callhome)# destination-profile XML-destination message-size 100000 |
Configures maximum destination message size for the predefined destination profile XML-destination. The valid range is 0 to 1,000,000 bytes and the default is 500,000. A value of 0 implies that a message of any size can be sent. Note The maximum size of each individual attachment inside the message is 250,000 bytes. If any attachment is more than this maximum size, then the output captured in the attachment will be truncated. |
Note Steps 3, 4, and 5 in this procedure can be skipped or configured in any order.
To configure a new destination-profile (and related parameters), follow these steps:
|
|
|
Step 1 |
switch# config t |
Enters configuration mode. |
Step 2 |
switch(config)# callhome switch(config-callhome)# |
Enters the Call Home configuration submode. |
Step 3 |
switch(config-callhome)# destination-profile test |
Configures a new destination profile called test. |
Step 4 |
switch(config-callhome)# destination-profile test email-addr person@place.com |
Configures the email address for the user-defined destination profile (test) sent in default XML format. |
Step 5 |
switch(config-callhome)# destination-profile test message-size 1000000 |
Configures a maximum message size for the destination email addresses in the user-defined destination profile (test) sent in default XML format. The valid range is 0 to 1,000,000 bytes and the default is 500,000. A value of 0 implies that a message of any size can be sent. |
Step 6 |
switch(config-callhome)# destination-profile test format full-txt |
Configures message-format for the user-defined destination profile (test) to be full text format. |
switch(config-callhome)# destination-profile test format short-txt |
Configures message-format for the user-defined destination profile (test) to be short text format. |
Note Steps 4, 5, and 6 in this procedure can be skipped or configured in any order.
Associating an Alert Group
Different types of Call Home alerts are grouped into different alert groups depending on their type. You can associate one or more alert groups to each profile as required by your network.
The alert group feature allows you to select the set of Call Home alerts to be received by a destination profile (either predefined or user-defined). You can associate multiple alert groups with a destination profile.
Restrictions
- A Call Home alert is sent to email destinations in a destination profile only if that Call Home alert belongs to one of the alert groups associated with that destination profile.
Detailed Steps
To associate an alert group with a destination profile, follow these steps:
|
|
|
Step 1 |
switch# config t |
Enters configuration mode. |
Step 2 |
switch(config)# callhome switch(config-callhome)# |
Enters Call Home configuration submode. |
Step 3 |
switch(config-callhome)# destination-profile test1 alert-group test |
Optional. Configures user-defined destination profile (test1) to receive all user-generated Call Home test notifications. |
switch(config-callhome)# destination-profile short-txt-destination alert-group test |
Optional. Configures predefined short-text destination profile to receive all user-generated Call Home test notifications. |
Step 4 |
switch(config-callhome)# destination-profile test1 alert-group all |
Optional. Configures user-defined destination profile (test1) to receive Call Home notifications for all events |
switch(config-callhome)# destination-profile short-txt-destination alert-group all |
Optional. Configures predefined short-text destination message profile to receive Call Home notifications for all (default) events |
Step 5 |
switch(config-callhome)# destination-profile test1 alert-group Cisco-TAC |
Optional. Configures user-defined destination message profile (test1) to receive Call Home notifications for events that are meant only for Cisco TAC or the Auto-notify service. |
switch(config-callhome)# destination-profile xml-destination alert-group Cisco-TAC |
Optional. Configures predefined XML destination message profile to receive Call Home notifications for events that are meant only for Cisco TAC or the auto-notify service. |
Step 6 |
switch(config-callhome)# destination-profile test1 alert-group environmental |
Optional. Configures user-defined destination message profile (test1) to receive Call Home notifications for power, fan, and temperature-related events. |
switch(config-callhome)# destination-profile short-txt-destination alert-group environmental |
Optional. Configures predefined short-text destination message profile to receive Call Home notifications for power, fan, and temperature-related events. |
Step 7 |
switch(config-callhome)# destination-profile test1 alert-group inventory |
Optional. Configures user-defined destination message profile (test1) to receive Call Home notifications for inventory status events. |
switch(config-callhome)# destination-profile short-txt-destination alert-group inventory |
Optional. Configures predefined short-text destination message profile to receive Call Home notifications for inventory status events. |
Step 8 |
switch(config-callhome)# destination-profile test1 alert-group linecard-hardware |
Optional. Configures user-defined destination message profile (test1) to receive Call Home notifications for module-related events. |
switch(config-callhome)# destination-profile short-txt-destination alert-group linecard-hardware |
Optional. Configures predefined short-text destination message profile to receive Call Home notifications for module-related events. |
Step 9 |
switch(config-callhome)# destination-profile test1 alert-group supervisor-hardware |
Optional. Configures user-defined destination message profile (test1) to receive Call Home notifications for supervisor-related events. |
switch(config-callhome)# destination-profile short-txt-destination alert-group supervisor-hardware |
Optional. Configures predefined short-text destination message profile to receive Call Home notifications for supervisor-related events. |
Step 10 |
switch(config-callhome)# destination-profile test1 alert-group system |
Optional. Configures user-defined destination message profile (test1) to receive Call Home notifications for software-related events. |
switch(config-callhome)# destination-profile short-txt-destination alert-group system |
Optional. Configures predefined short-text destination message profile to receive Call Home notifications for software-related events. |
Customizing Alert Group Messages
To assign show commands to be executed when an alert is sent, you must associate the commands with the alert group. When an alert is sent, Call Home associates the alert group with an alert type and attaches the output of the show commands to the alert message.
Note Make sure the destination profiles for a non-Cisco-TAC alert group, with a predefined show command, and the Cisco-TAC alert group are not the same.
Restrictions
- You can assign a maximum of five user-defined show commands to an alert group. Only show commands can be assigned to an alert group.
- Customized show commands are only supported for full text and XML alert groups. Short text alert groups (short-txt-destination) do not support customized show commands because they only allow 128 bytes of text.
Detailed Steps
To customize Call Home alert group messages, follow these steps:
|
|
|
Step 1 |
switch# config t |
Enters configuration mode. |
Step 2 |
switch(config)# callhome switch(config-callhome)# |
Enters Call Home configuration submode. |
Step 3 |
switch(config-callhome)# alert-group license user-def-cmd show license usage |
Configures a user-defined show command for an alert group license. Note Only valid show commands are accepted. |
switch(config-callhome)# no alert-group license user-def-cmd show license usage |
Removes the user-defined show command from the alert group. |
Setting the Call Home Message Levels
Restrictions
- The urgency level ranges from 0 (lowest level of urgency) to 9 (highest level of urgency), and the default is 0 (all messages are sent).
Detailed Steps
To set the message level for each destination profile for Call Home, follow these steps:
|
|
|
Step 1 |
switch# config t |
Enters configuration mode. |
Step 2 |
switch(config)# callhome switch(config-callhome)# |
Enters Call Home configuration submode. |
Step 3 |
switch(config-callhome)# destination-profile test message-level 5 |
Optional. Configures the message level urgency as 5 and above for the user-defined profile (test1). |
switch(config-callhome)# no destination-profile oldtest message-level 7 |
Removes a previously configured urgency level and reverts it to the default of 0 (all messages are sent). |
Configuring the Syslog-Based Alerts
Detailed Steps
To configure the syslog-group-port alert group, follow these steps:
|
|
|
Step 1 |
switch# config t |
Enters configuration mode. |
Step 2 |
switch(config)# callhome switch(config-callhome)# |
Enters Call Home configuration submode. |
Step 3 |
switch(config-callhome)# destination-profile short-txt-destination alert-group syslog-group-port |
Configures the predefined destination profile (short-txt-destination) to receive Call Home Notifications corresponding to syslog messages for the port facility. |
Step 4 |
switch(config-callhome)# destination-profile short-txt-destination message-level 5 |
Optional. Configures the predefined destination-profile (short-txt-destination) to send a Call Home message for syslog messages whose severity levels map to Call Home severity level of 5 or greater. The default is message level 0 (all syslog messages). |
Detailed Steps
To configure RMON alert groups, follow these steps:
|
|
|
Step 1 |
switch# config t |
Enters configuration mode. |
Step 2 |
switch(config)# callhome switch(config-callhome)# |
Enters Call Home configuration submode. |
Step 3 |
switch(config-callhome)# destination-profile xml-destination alert-group rmon |
Optional. Configures a destination message profile (rmon_group) to send Call Home notifications for configured RMON messages. |
Configuring Event Trap Notifications
Detailed Steps
To configure a Call Home event notification trap (except Call Home periodic messages), follow these steps:
|
|
|
Step 1 |
switch# config t |
Enters configuration mode. |
Step 2 |
switch(config)# callhome switch(config-callhome)# |
Enters Call Home configuration submode. |
Step 3 |
switch(config-callhome)# snmp-server enable traps callhome event-notify |
Enables the SNMP notification trap for Call Home. |
Configuring General Email Options
You can configure the from, reply-to, and return-receipt email addresses. While most email address configurations are optional, you must configure the SMTP server address for the Call Home functionality to work.
Detailed Steps
To configure general email options, follow these steps:
|
|
|
Step 1 |
switch# config t |
Enters configuration mode. |
Step 2 |
switch(config)# callhome switch(config-callhome)# |
Enters Call Home configuration submode. |
Step 3 |
switch(config-callhome)# transport email from user@company1.com |
Configures the from email address. |
Step 4 |
switch(config-callhome)# transport email reply-to person@place.com |
Optional. Configures the reply-to email address to which all responses should be sent. |
Configuring HTTPS Support
Any predefined or user-defined destination profiles can be configured with the HTTPS URL address.
Detailed Steps
To configure the HTTPS URL address for any destination profile, follow these steps:
|
|
|
Step 1 |
switch# config t |
Enters configuration mode. |
Step 2 |
switch(config)# callhome switch(config-callhome)# |
Enters Call Home configuration submode. |
Step 3 |
switch(config-callhome)# destination-profile full-txt-destination http https://httpssever.com/Service |
Optional. Configures the predefined full-txt-destination profile with a HTTPS URL address. The Call Home message in full-txt format is uploaded at the configured HTTPS URL address. |
Step 4 |
switch(config-callhome)# destination-profile CiscoTAC-1 http https://httpssever.com/Service |
Optional. Configures the predefined CiscoTAC-1 profile with a HTTPS URL address. The Call Home message in XML format is uploaded at the configured HTTPS URL address. |
Step 5 |
switch(config-callhome)# destination-profile test1 http https://httpssever.com/Service |
Optional. Configures the user-defined destination profile with a HTTPS URL address. The Call Home message in the configured format is uploaded at the configured HTTPS URL address. |
Enable or Disable Transport Method
Any predefined or user-defined destination profiles can be configured to enable or disable a particular transport method. The transport methods are HTTP and email.
Detailed Steps
To enable or disable transport method for a destination profile, follow these steps:
|
|
|
Step 1 |
switch# config t |
Enters configuration mode. |
Step 2 |
switch(config)# callhome switch(config-callhome)# |
Enters Call Home configuration submode. |
Step 3 |
switch(config-callhome)# destination-profile CiscoTAC-1 transport-method http |
Optional. Enables predefined destination profile CiscoTAC-1 for HTTP transport method. Note For user-defined destination profiles, email is the default. You can enable either or both transport mechanisms. If you disable both methods, email will be enabled. |
Step 4 |
switch(config-callhome)# no destination-profile CiscoTAC-1 transport-method email |
Optional. Disables predefined destination profile CiscoTAC-1 for email transport-method. |
Step 5 |
switch(config-callhome)# destination-profile full-txt transport-method http |
Optional. Enables predefined full-txt-destination profile for HTTP transport method. |
Configuring an HTTP Proxy Server
Beginning with Cisco NX-OS Release 5.2, you can configure Smart Call Home to send HTTP messages through an HTTP proxy server. If you do not configure an HTTP proxy server, Smart Call Home sends HTTP messages directly to the Cisco Transport Gateway (TG).
Detailed Steps
To configure an HTTP proxy server, follow these steps:
|
|
|
Step 1 |
switch# config t |
Enters configuration mode. |
Step 2 |
switch(config)# callhome switch(config-callhome)# |
Enters Call Home configuration submode. |
Step 3 |
switch(config-callhome)# transport http proxy server 192.0.2.1 |
Configures the HTTP proxy server domain name server (DNS) name, IPv4 address, or IPv6 address. Optionally configures the port number. The port range is from 1 to 65535. The default port number is 8080. |
Step 4 |
switch(config-callhome)# transport http proxy enable |
Enables Smart Call Home to send all HTTP messages through the HTTP proxy server. Note You can execute this command only after the proxy server address has been configured. |
Step 5 |
switch(config-callhome)# show callhome transport |
(Optional) Displays the transport-related configuration for Smart Call Home. |
Note The default value for full text destination and for XML is 1 MB.
This example shows how to configure Smart Call Home to send HTTP messages through an HTTP proxy server:
Enter configuration commands, one per line. End with CNTL/Z.
switch(config-callhome)# transport http proxy server 10.10.10.1 port 4
switch(config-callhome)# transport http proxy enable
Configuring SMTP Server and Ports
This section includes the following topic:
Detailed Steps
To configure the SMTP server and port, follow these steps:
|
|
|
Step 1 |
switch# config t |
Enters configuration mode. |
Step 2 |
switch(config)# callhome switch(config-callhome)# |
Enters Call Home configuration submode. |
Step 3 |
switch(config-callhome)# transport email smtp-server 192.168.1.1 |
Configures the DNS, IPv4 address, or IPv6 address of the SMTP server to reach the server. The port usage defaults to 25 if no port is specified. Note The port number is optional and, if required, may be changed depending on the server location. |
switch(config-callhome)# transport email smtp-server 192.168.1.1 port 30 |
Configuring Multiple SMTP Server Support
To distribute the SMTP server configuration to devices running software releases prior to NX-OS Release 5.0 and earlier, use the following command:
switch(config-callhome)# transport email smtp-server
For multiple SMTP server capability, use the following command:
switch(config-callhome)# [no] transport email mail-server {ipv4 | IPV6 | hostname} [port port number] [priority priority number]
Example 4-1 shows how to configure multiple SMTP servers for Call Home messages:
Enter configuration commands, one per line. End with CNTL/Z.
switch(config-callhome)# transport email mail-server 192.0.2.10 priority 4
switch(config-callhome)# transport email mail-server 172.21.34.193
switch(config-callhome)# transport email smtp-server 10.1.1.174
switch(config-callhome)# transport email mail-server 64.72.101.213 priority 60
switch(config-callhome)# transport email from person@company.com
switch(config-callhome)# transport email reply-to person@company.com
Based on the configuration above, the SMTP servers would be contacted in this order:
10.1.1.174 (priority 0)
192.0.2.10 (priority 4)
172.21.34.193 (priority 50 - default)
64.72.101.213 (priority 60)
The transport email mail-server command is distributed only to devices running NX-OS Release 5.0(1a) or later. The transport email smtp-server command is distributed only to devices running earlier software releases.
Enabling Periodic Inventory Notifications
When you enable this feature without configuring an interval value, the Call Home message is sent every 7 days. This value ranges from 1 to 30 days. By default, this feature is disabled in all switches in the Cisco MDS 9000 Family and Cisco Nexus 5000 Series switches.
Detailed Steps
To enable periodic inventory notification in a Cisco MDS 9000 Family switch or a Cisco Nexus 5000 Series switch, follow these steps:
|
|
|
Step 1 |
switch# config t |
Enters configuration mode. |
Step 2 |
switch(config)# callhome switch(config-callhome)# |
Enters the Call Home configuration submode. |
Step 3 |
switch(config-callhome)# periodic-inventory notification |
Enables the periodic inventory notification feature. By default, the Call Home message is sent every 7 days. |
switch(config-callhome)# no periodic-inventory notification |
Disables the periodic inventory notification feature (default). |
Step 4 |
switch(config-callhome)# periodic-inventory notification interval 15 |
Configures the periodic inventory notification message to be sent every 15 days. This value ranges from 1 to 30 days. |
switch(config-callhome)# no periodic-inventory notification interval 15 |
Defaults to using the factory default of sending a Call Home message every 7 days. |
Configuring Duplicate Message Throttle
You can configure a throttling mechanism to limit the number of Call Home messages received for the same event. If the same message is sent multiple times from the switch within a short period of time, you may be swamped with a large number of duplicate messages.
Restrictions
- By default, this feature is enabled in all switches in the Cisco MDS 9000 Family and the Cisco Nexus 5000 Series switches. When enabled, if the number of messages sent exceeds the maximum limit of 30 messages within the 2-hour time frame, then additional messages for that alert type are discarded within that time frame. You cannot modify the time frame or the message counter limit.
- If 2 hours have elapsed since the first such message was sent and a new message has to be sent, then the new message is sent and the time frame is reset to the time when the new message was sent and the count is reset to 1.
Detailed Steps
To enable message throttling in a Cisco MDS 9000 Family switch or a Cisco Nexus 5000 Series switch, follow these steps:
|
|
|
Step 1 |
switch# config t |
Enters configuration mode. |
Step 2 |
switch(config)# callhome switch(config-callhome)# |
Enters the Call Home configuration submode. |
Step 3 |
switch(config-callhome)# no duplicate-message throttle |
Disables the duplicate message throttling feature. |
switch(config-callhome)# duplicate-message throttle |
Enables the duplicate message throttling feature (default). |
Enabling Call Home Fabric Distribution
Detailed Steps
To enable Call Home fabric distribution, follow these steps:
|
|
|
Step 1 |
switch# config t |
Enters configuration mode. |
Step 2 |
switch(config)# callhome switch(config-callhome)# |
Enters Call Home configuration submode. |
Step 3 |
switch(config-callhome)# distribute |
Enables Call Home configuration distribution to all switches in the fabric. Acquires a fabric lock and stores all future configuration changes in the pending database. |
switch(config-callhome)# no distribute |
Disables (default) Call Home configuration distribution to all switches in the fabric. |
To commit the Call Home configuration changes, follow these steps:
|
|
|
Step 1 |
switch# config t |
Enters configuration mode. |
Step 2 |
switch(config)# callhome switch(config-callhome)# |
Enters Call Home configuration submode. |
Step 3 |
switch(config-callhome)# commit |
Distributes the configuration changes to all switches in the fabric and releases the lock. Overwrites the effective database with the changes made to the pending database. |
To discard the Call Home configuration changes, follow these steps:
|
|
|
Step 1 |
switch# config t |
Enters configuration mode. |
Step 2 |
switch(config)# callhome switch(config-callhome)# |
Enters Call Home configuration submode. |
Step 3 |
switch(config-callhome)# abort |
Discards the configuration changes in the pending database and releases the fabric lock. |
Fabric Lock Override
To use administrative privileges and release a locked Call Home session, use the clear callhome session command.
switch# clear callhome session
Call Home Communications Test
You can test Call Home communications by sending a test message to the configured destination(s) or sending a test inventory message to the configured destination(s).
Detailed Steps
Use the test command to simulate a message generation.
To test the Call Home function, follow these steps:
|
|
|
Step 1 |
switch# callhome test trying to send test callhome message successfully sent test callhome message |
Sends a test message to the configured destination(s). |
Step 2 |
switch# callhome test inventory trying to send test callhome message successfully sent test callhome message |
Sends a test inventory message to the configured destination(s). |
Configuring Delayed Traps
Detailed Steps
To enable the delayed trap feature, perform this task:
|
|
|
Step 1 |
switch# config t
|
Enters configuration mode. |
Step 2 |
switch(config)# system delayed-traps enable mode FX
|
Enables the system-delayed trap feature. |
Step 3 |
switch(config)# system delayed-traps timer <1-60>
|
Configures the system-delayed trap timeout value. If no value is entered, a default value of 4 minutes is used. You can choose any value between 1 to 60 minutes. |
To disable the delayed trap feature, perform this task:
|
|
|
Step 1 |
switch# config t
|
Enters configuration mode. |
Step 2 |
switch(config)# no system delayed-traps enable mode FX
|
Disables the system-delayed trap feature. This command is used only for the F/FL operationally UP ports. This feature does not apply to E/TE links. By default, this feature is disabled. You have to explicitly enable this feature. Enabling the feature will not affect the existing link-level traps. |
Verifying Call Home Configuration
To display the Call Home configuration information, perform one of the following tasks:
Displaying Call Home Information
Use the show callhome command to display the configured Call Home information (see Examples 4-1 to 4-10 ).
Example 4-1 Displays Configured Call Home Information
contact person name:who@where
contact person's email:person@place.com
contact person's phone number:310-408-4000
street addr:1234 Picaboo Street, Any city, Any state, 12345
site id:Site1ManhattanNewYork
Example 4-2 Displays Information for All Destination Profiles (Predefined and User-Defined)
switch# show callhome destination-profile
XML destination profile information
maximum message size:500000
email addresses configured:
test destination profile information
maximum message size:100000
email addresses configured:
full-txt destination profile information
maximum message size:500000
email addresses configured:
short-txt destination profile information
maximum message size:4000
email addresses configured:
Example 4-3 Displays Information for a User-defined Destination Profile
switch# show callhome destination-profile test
test destination profile information
maximum message size:100000
email addresses configured:
Example 4-4 Displays the Full-Text Profile
switch# show callhome destination-profile profile full-txt-destination
full-txt destination profile information
maximum message size:250000
email addresses configured:
Example 4-5 Displays the Short-Text Profile
switch# show callhome destination-profile profile short-txt-destination
Short-txt destination profile information
maximum message size:4000
email addresses configured:
Example 4-6 Displays the XML Destination Profile
switch# show callhome destination-profile profile XML-destination
XML destination profile information
maximum message size:250000
email addresses configured:
Example 4-7 Displays Email and SMTP Information
switch# show callhome transport-email
from email addr:user@company1.com
reply to email addr:pointer@company.com
return receipt email addr:user@company1.com
smtp server:server.company.com
Example 4-8 Displays the running configuration callhome information
switch# show running-config callhome
!Command: show running-config callhome
!Time: Tue Sep 9 12:16:45 2014
email-contact sakpuri@cisco.com
phone-contact +1-800-000-0000
streetaddress 12345 Cisco Way, San Jose, CA
destination-profile Inventory
destination-profile Inventory format full-txt
destination-profile Inventory message-size 1000000
destination-profile Service
destination-profile Service format full-txt
destination-profile Service message-size 1000000
destination-profile dest1
destination-profile dest1 format XML
destination-profile dest1 message-size 500000
destination-profile full_txt message-size 1000000
destination-profile httpProf
destination-profile httpProf format XML
destination-profile httpProf message-size 0
destination-profile short_txt message-size 4000
destination-profile xml message-size 1000000
destination-profile xml message-size 1000000
destination-profile Inventory email-addr sakpuri@cisco.com
destination-profile Service email-addr sakpuri@cisco.com
destination-profile full_txt email-addr sakpuri@cisco.com
destination-profile short_txt email-addr sakpuri@cisco.com
destination-profile xml email-addr sakpuri@cisco.com
destination-profile Service alert-group environmental
destination-profile xml alert-group environmental
destination-profile Inventory alert-group inventory
destination-profile xml alert-group inventory
destination-profile Service alert-group linecard-hardware
Example 4-9 Displays the running configuration for callhome with defaults
switch# show running-config callhome all
EG-9506-1-176# show running-config callhome all
!Command: show running-config callhome all
!Time: Tue Sep 9 12:18:22 2014
email-contact sakpuri@cisco.com
phone-contact +1-800-000-0000
streetaddress 12345 Cisco Way, San Jose, CA
destination-profile Inventory
destination-profile Inventory format full-txt
destination-profile Inventory transport-method email
no destination-profile Inventory transport-method http
destination-profile Inventory message-size 1000000
destination-profile Inventory message-level 0
destination-profile Service
destination-profile Service format full-txt
destination-profile Service transport-method email
no destination-profile Service transport-method http
destination-profile Service message-size 1000000
destination-profile Service message-level 0
destination-profile dest1
destination-profile dest1 format XML
destination-profile dest1 transport-method email
no destination-profile dest1 transport-method http
destination-profile dest1 message-size 500000
destination-profile dest1 message-level 0
destination-profile full_txt
destination-profile full_txt format full-txt
destination-profile full_txt transport-method email
no destination-profile full_txt transport-method http
destination-profile full_txt message-size 1000000
destination-profile full_txt message-level 0
destination-profile httpProf
Example 4-10 Displays the startup configuration for callhome
switch# show startup-config callhome
!Command: show startup-config callhome
!Time: Tue Sep 9 12:19:27 2014
!Startup config saved at: Fri Sep 5 12:13:53 2014
email-contact sakpuri@cisco.com
phone-contact +1-800-000-0000
streetaddress 12345 Cisco Way, San Jose, CA
destination-profile Inventory
destination-profile Inventory format full-txt
destination-profile Inventory message-size 1000000
destination-profile Service
destination-profile Service format full-txt
destination-profile Service message-size 1000000
destination-profile dest1
destination-profile dest1 format XML
destination-profile dest1 message-size 500000
destination-profile full_txt message-size 1000000
destination-profile httpProf
destination-profile httpProf format XML
destination-profile httpProf message-size 0
destination-profile short_txt message-size 4000
destination-profile xml message-size 1000000
destination-profile xml message-size 1000000
destination-profile Inventory email-addr sakpuri@cisco.com
destination-profile Service email-addr sakpuri@cisco.com
destination-profile full_txt email-addr sakpuri@cisco.com
destination-profile short_txt email-addr sakpuri@cisco.com
destination-profile xml email-addr sakpuri@cisco.com
destination-profile Service alert-group environmental
destination-profile xml alert-group environmental
destination-profile Inventory alert-group inventory
destination-profile xml alert-group inventory
Displaying Delayed Trap Information
Use the show running-config | in delay CLI command to display the system-delayed trap state as shown in Example 4-11 and Example 4-12. If no timer value is specified or if the timer value is set to 4 minutes, the following is displayed:
Example 4-11 Displays the Delayed Trap Information with No Timer Value (Set to the Default 4 Minutes)
switch# show running-config | in delay
system delayed-traps enable mode FX
If the timer value is set to any other value other than 4 minutes, Example 4-12 is displayed:
Example 4-12 Displays the Delayed Trap Information with a Timer Value Other Than 4 Minutes
switch# show running-config | in delay
system delayed-traps enable mode FX
system delayed-traps timer 5
Verifying Alert Group Customization
To verify the alert group customization, use the show callhome user-def-cmds command.
switch# show callhome user-def-cmds
User configured commands for alert groups :
alert-group test user-def-cmd "show version"
Verifying Event Notification Trap
To verify the SNMP event notification trap, use the show snmp trap | inc callhome command.
switch# show snmp trap | inc callhome
callhome : event-notify Yes
callhome : smtp-send-fail No
Verifying Call Home Transport
The show callhome transport command displays all of the transport-related configurations for Call Home.
switch# show callhome transport
from email addr:xyz-1@cisco.com
reply to email addr:xyz-1@cisco.com
smtp server:72.163.62.211
smtp server vrf:management
http proxy server:10.64.65.52
http proxy server port:8080
http proxy status:Enabled
The following example shows how to configure SMTP server port:
switch(config-callhome)# transport email mail-server 192.168.10.23 port 4
The following example shows how to configure SMTP server priority:
switch(config-callhome)# transport email mail-server 192.168.10.23 priority 60