Configuring Call Home

Transcription

1 CHAPTER 4 Call Home provides an -based notification of critical system events. A versatile range of message formats are available for optimal compatibility with pager services, standard , or XML-based automated parsing applications. Note Cisco Autonotify is upgraded to a new capability called Smart Call Home. Smart Call Home has significant functionality improvement over Autonotify and is available across the Cisco product range. For detailed information on Smart Call Home, see the Smart Call Home page at this location: This chapter includes the following sections: Information About Call Home, page 4-1 Guidelines and Limitations, page 4-21 Default Settings, page 4-22, page 4-22 Verifying Call Home Configuration, page 4-37 Monitoring Call Home, page 4-40 Additional References, page 4-45 Feature History for Call Home, page 4-46 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 -based notification of critical system events. A versatile range of message formats are available for optimal compatibility with pager services, standard , or XML-based automated parsing applications. Common features may include the following: Paging the network support engineer ing the Network Operations Center 4-1

2 Information About Call Home Chapter 4 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 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, page 4-2 About Smart Call Home, page 4-3 Call Home Destination Profiles, page 4-5 Call Home Alert Groups, page 4-5 Call Home Message Level Feature, page 4-6 Syslog-Based Alerts, page 4-6 RMON-Based Alerts, page 4-7 General Options Using HTTPS Support, page 4-7 Multiple SMTP Server Support, page 4-7 Periodic Inventory Notification, page 4-8 Duplicate Message Throttle, page 4-8 Call Home Configuration Distribution, page 4-8 Fabric Lock Override, page 4-8 Clearing Call Home Name Server Database, page 4-9 EMC Home Delayed Traps, page 4-9 Event Triggers, page 4-10 Call Home Message Levels, page 4-12 Message Contents, page 4-14 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. 4-2

3 Chapter 4 Information About Call Home 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 The XML format enables communication with the Cisco Systems Technical Assistance Center. Multiple concurrent message destinations. You can configure up to 50 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. 4-3

4 Information About Call Home Chapter 4 Table 4-1 lists the benefits of Smart Call Home. Table 4-1 Benefits of Smart Call Home Compared to Autonotify Feature Smart Call Home 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 Requires the customer to request Cisco to add each specific serial number to the database. Recommendations Device report History report 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. 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. 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. Autonotify raises SRs for a set of failure scenarios but no recommendations are provided for these. No. A basic version is available that does not include contents of message. 4-4

5 Chapter 4 Information About Call Home Table 4-1 Benefits of Smart Call Home Compared to Autonotify (continued) Obtaining Smart Call Home Feature Smart Call Home Autonotify Network summary report Cisco device support 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) Device Support will be extended across the Cisco product range. See the supported products table at 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 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: No. Deprecated in favor of Smart Call Home in October 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 destinations in a destination profile only if that Call Home alert belongs to one of the alert groups associated with that destination profile. 4-5

6 Information About Call Home Chapter 4 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 on page 4-12). 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 on page 4-12). 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. 4-6

7 Chapter 4 Information About Call Home 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 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: 4-7

8 Information About Call Home Chapter 4 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. 4-8

9 Chapter 4 Information About Call Home 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 Home Delayed Traps DCNM-SAN can be configured to generate EMC Home XML messages. In SAN-OS Release 3.x or earlier, DCNM-SAN listens to interface traps and generates EMC Home 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 notification. Cisco NX-OS Release 4.1(3) provides the ability to generate a delayed trap so that the number of generated messages is reduced. This method filters server reboots and avoids generating unnecessary EMC Home messages. In NX-OS Release 4.1(3), users have the ability to select the current existing feature or this new delayed trap feature. Beginnig from Cisco NX-OS Release 5.2(2), the Call Home does not send an alerts when a link comes back online (LinkUp). It sends alerts only for LinkDown events. 4-9

10 Information About Call Home Chapter 4 Event Triggers Table 4-2 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 Event Triggers Event Alert Group Event Name Description Call Home System and SW_CRASH A software process has crashed with a CISCO_TAC stateless restart, indicating an interruption of a service. System and CISCO_TAC Environmental and CISCO_TAC Line Card Hardware and CISCO_TAC Line Card Hardware and CISCO_TAC Line Card Hardware, Supervisor Hardware, and CISCO_TAC Supervisor Hardware and CISCO_TAC Supervisor Hardware and CISCO_TAC Supervisor Hardware and CISCO_TAC Supervisor Hardware and CISCO_TAC Supervisor Hardware and CISCO_TAC SW_SYSTEM_INCONSISTEN T Inconsistency detected in software or file system. TEMPERATURE_ALARM Thermal sensor indicates temperature 6 reached operating threshold. POWER_SUPPLY_FAILURE Power supply failed. 6 FAN_FAILURE Cooling fan has failed. 5 LINECARD_FAILURE Line card hardware operation failed. 7 POWER_UP_DIAGNOSTICS_ FAILURE Line card hardware failed power-up diagnostics. PORT_FAILURE Hardware failure of interface port(s). 6 BOOTFLASH_FAILURE Failure of boot compact flash card. 6 NVRAM_FAILURE FREEDISK_FAILURE Hardware failure of NVRAM on supervisor hardware. Free disk space is below a threshold on supervisor hardware. SUP_FAILURE Supervisor hardware operation failed. 7 POWER_UP_DIAGNOSTICS_ FAILURE Supervisor hardware failed power-up diagnostics. INBAND_FAILURE Failure of in-band communications path. 7 EOBC_FAILURE Ethernet out-of-band channel communications failure. Call Home Message Level

11 Chapter 4 Information About Call Home Table 4-2 Event Triggers (continued) Event Alert Group Event Name Description Call Home Supervisor Hardware and CISCO_TAC MGMT_PORT_FAILURE Hardware failure of management Ethernet port. Inventory Test Port syslog License LICENSE_VIOLATION Feature in use is not licensed, and are turned off after grace period expiration. Inventory and CISCO_TAC Test and CISCO_TAC Syslog-groupport COLD_BOOT Switch is powered up and reset to a cold 2 boot sequence. HARDWARE_INSERTION New piece of hardware inserted into the 2 chassis. HARDWARE_REMOVAL Hardware removed from the chassis. 2 TEST User generated test. 2 SYSLOG_ALERT Syslog messages corresponding to the port facility. RMON RMON RMON_ALERT RMON alert trigger messages. 2 Call Home Message Level

12 Information About Call Home Chapter 4 Call Home Message Levels Table 4-3 Event Categories and Executed s Event Category Description Executed s System Events generated by failure of a software system that is critical to unit show tech-support operation. show system redundancy show module status show version show tech-support platform show tech-support sysmgr show hardware show sprom all Environmental show module show version show environment show logging logfile tail -n 200 Line Card Hardware show module show version show tech-support platform show tech-support sysmgr show hardware show sprom all Supervisor Hardware show module show version show tech-support platform show tech-support sysmgr show hardware show sprom all Events related to power, fan, and environment sensing elements such as temperature alarms. Events related to standard or intelligent line card hardware. Events related to supervisor modules. show module show environment show tech-support show tech-support 4-12

13 Chapter 4 Information About Call Home Table 4-3 Event Categories and Executed s (continued) Event Category Description Executed s Inventory show module show version show hardware show inventory show system uptime show sprom all show license usage Test show module show version 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. User generated test message. show version 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 on page 4-6). 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 Call Home Level Keyword Used Syslog Level Description 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. 4-13

14 Information About Call Home Chapter 4 Table 4-4 Severity and Syslog Level Mapping (continued) Call Home Level Keyword Used Syslog Level Description 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 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 Data Item Device identification Date/time stamp Error isolation message Alarm urgency level Description Configured device name Time stamp of the triggering event Plain English description of triggering event 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) Time stamp Description (Plain text and XML) Date and time stamp of event in ISO time notation: YYYY-MM-DDTHH: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. XML Tag (XML only) /mml/header/time - ch:eventtime Message name Name of message. Specific event names are listed in the Event /mml/header/name Triggers section on page Message type Specifically Call Home. /mml/header/type - ch:type Message group Specifically reactive. /mml/header/group 4-14

15 Chapter 4 Information About Call Home Table 4-6 Reactive Event Message Format (continued) Data Item (Plain text and XML) 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@serial, where: /mml/ header/deviceid Customer ID Contract ID Site ID Server ID type is the product model number from backplane 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@ Optional user-configurable field used for contract info or other ID by any support service. Optional user-configurable field used for contract info or other ID by any support service. Optional user-configurable field used for Cisco-supplied site ID or other data meaningful to alternate support service. If the message is generated from the fabric switch, it is the unique device identifier (UDI) of the switch. Format is type@sid@serial, where: type is the product model number from backplane 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@ /mml/header/customerid - ch:customerid /mml/header/contractid - ch:contractid> /mml/header/siterid - ch:siteid /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 address of person identified as contact for this unit. /mml/body/syscontact - ch:systeminfo/contact Contact phone number Description (Plain text and XML) Phone number of the person identified as the contact for this unit. XML Tag (XML only) /mml/body/syscontactphone Number - ch:systeminfo/contactphone Number 4-15

16 Information About Call Home Chapter 4 Table 4-6 Reactive Event Message Format (continued) Data Item (Plain text and XML) Street address Model name Optional field containing street address for RMA part shipments associated with this unit. Model name of the switch. This is the specific model as part of a product family name. /mml/body/sysstreetaddress - ch:systeminfo/streetaddress /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 Supervisor module software version Hardware version of chassis. /mml/body/chassis/hwversion - rme:chassis/hardwareversion Top level software version. /mml/body/fru/swversion - rme:chassis/card/softwareide ntity Affected FRU name Name of the affected FRU generating the event message. /mml/body/fru/name - rme:chassis/card/model Affected FRU serial number Affected FRU part number Serial number of affected FRU. /mml/body/fru/serialno - rme:chassis/card/serialnumb er 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/locationwit hincontainer FRU hardware version FRU software version output name Hardware version of affected FRU. /mml/body/fru/hwversion - rme:chassis/card/softwareide ntity Software version(s) running on affected FRU. /mml/body/fru/swversion - rme:chassis/card/softwareide ntity 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 output text Description (Plain text and XML) Output of command automatically executed (see Table 4-3). XML Tag (XML only) /mml/attachments/attachment/ atdata - aml-block:attachment/data 4-16

17 Chapter 4 Information About Call Home Table 4-7 Inventory Event Message Format Data Item (Plain text and XML) Time stamp Description (Plain text and XML) Date and time stamp of event in ISO time notation: YYYY-MM-DDTHH: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. XML Tag (XML only) /mml/header/time - ch:eventtime Message name Name of message. Specifically Inventory Update Specific event /mml/header/name names are listed in the Event Triggers section on page 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 /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@serial, where: /mml/ header /deviceid Customer ID Contract ID Site ID Server ID type is the product model number from backplane 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@ Optional user-configurable field used for contact info or other ID by any support service. Optional user-configurable field used for contact info or other ID by any support service. Optional user-configurable field, can be used for Cisco-supplied site ID or other data meaningful to alternate support service. If the message is generated from the fabric switch, it is the Unique device identifier (UDI) of the switch. Format is type@sid@serial, where: type is the product model number from backplane is a separator character. Sid is C,, identifying the serial ID as a chassis serial number. /mml/header/customerid - ch-inv:customerid /mml/header/contractid - ch-inv:contractid> /mml/header/siterid - ch-inv:siteid /mml/header/serverid - -blank- serial is the number identified by the Sid field. Example: DS-C9509@C@ Message description Short text describing the error. /mml/body/msgdesc - ch-inv:messagedescription 4-17

18 Information About Call Home Chapter 4 Table 4-7 Inventory Event Message Format (continued) Data Item (Plain text and XML) 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 address of person identified as contact for this unit. /mml/body/syscontact - ch-inv:systeminfo/contact Contact phone number Street address Model name Phone number of the person identified as the contact for this unit. Optional field containing street address for RMA part shipments associated with this unit. Model name of the unit. This is the specific model as part of a product family name. /mml/body/syscontactphone Number - ch-inv:systeminfo/contactph onenumber /mml/body/sysstreetaddress - ch-inv:systeminfo/streetaddr ess /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 Supervisor module software version Hardware version of chassis. /mml/body/fru/hwversion - rme:chassis/card/softwareide ntity Top level software version. /mml/body/fru/swversion - rme:chassis/card/softwareide ntity 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/serialnumb er 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/locationwi thincontainer FRU hardware version FRU software version Description (Plain text and XML) XML Tag (XML only) Hardware version of FRU. /mml/body/fru/hwversion - rme:chassis/card/softwareide ntity Software version(s) running on FRU. /mml/body/fru/swversion - rme:chassis/card/softwareide ntity 4-18

19 Chapter 4 Information About Call Home Table 4-7 Inventory Event Message Format (continued) Data Item (Plain text and XML) 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 output text Description (Plain text and XML) Output of command automatically executed after event categories (see Event Triggers section on page 4-10). XML Tag (XML only) /mml/attachments/attachment /atdata - aml-block:attachment/data Table 4-8 User-Generated Test Message Format Data Item (Plain text and XML) Time stamp Message name Description (Plain text and XML) Date and time stamp of event in ISO time notation: YYYY-MM-DDTHH: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. Name of message. Specifically test message for test type message. Specific event names listed in the Event Triggers section on page 4-10). XML Tag (XML only) /mml/header/time - ch:eventtime /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 /mml/header/group application, but may be populated with either proactive or reactive. 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@serial, where: /mml/ header /deviceid type is the product model number from backplane 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@

20 Information About Call Home Chapter 4 Table 4-8 User-Generated Test Message Format (continued) Data Item (Plain text and XML) Customer ID Contract ID Site ID Server ID Optional user-configurable field used for contract info or other ID by any support service. Optional user-configurable field used for contract info or other ID by any support service. Optional user-configurable field used for Cisco-supplied site ID or other data meaningful to alternate support service. If the message is generated from the fabric switch, it is the Unique device identifier (UDI) of the switch. Format is type@sid@serial, where: type is the product model number from backplane 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@ /mml/header/customerid - ch:customerid /mml/header/contractid - ch:contractid /mml/header/siterid - ch:siteid /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 address of person identified as contact for this unit. /mml/body/syscontacte-mai l - ch:systeminfo/contacte-mai l Contact phone number Street address Model name Description (Plain text and XML) Phone number of the person identified as the contact for this unit. Optional field containing street address for RMA part shipments associated with this unit. Model name of the switch. This is the specific model as part of a product family name. XML Tag (XML only) /mml/body/syscontactphone Number - ch:systeminfo/contactphon enumber /mml/body/sysstreetaddress - ch:systeminfo/streetaddres s /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/partnumb er 4-20

21 Chapter 4 Guidelines and Limitations Table 4-8 User-Generated Test Message Format (continued) Data Item (Plain text and XML) output text Output of command automatically executed after event categories listed in Table 4-3. /mml/attachments/attachmen t/atdata - aml-block:attachment/data MIME type Normally text or plain or encoding type. /mml/attachments/attachmen t/mime - aml-block:attachment/data encoding Attachment type Specifically command output. /mml/attachments/attachmen t/type - aml-block:attachment type output name Description (Plain text and XML) The exact name of the issued command. XML Tag (XML only) /mml/attachments/attachmen t/name - aml-block:attachment/nam e Guidelines and Limitations Call Home Database Merger Guidelines Call Home Configuration Guidelines When merging two Call Home databases, follow these guidelines: Be aware that the merged database contains the following information: A superset of all the destination profiles from the dominant and subordinate switches that take part in the merge protocol. The addresses and alert groups for the destination profiles. Other configuration information (for example, message throttling, periodic inventory) from the switch that existed in the dominant switch before the merge. See the CFS Merge Support section on page 2-6 for detailed concepts. When configuring Call Home, follow these guidelines: An server and at least one destination profile (predefined or user-defined) must be configured. The destination profile(s) used depends on whether the receiving entity is a pager, , or automated service such as Cisco Smart Call Home. Switches can forward events (SNMP traps/informs) up to 10 destinations. The contact name (SNMP server contact), phone, and street address information must be configured before Call Home is enabled. This configuration is required to determine the origin of messages received. The Cisco MDS 9000 Family switch and the Cisco Nexus 5000 Series switch must have IP connectivity to an server. If Cisco Smart Call Home is used, an active service contract must cover the device being configured. 4-21

22 Default Settings Chapter 4 Default Settings Table 4-9 lists the default Call Home settings. Table 4-9 Default Call Home Default Settings Parameters Default Destination message size for a message sent in full text format. 500,000 Destination message size for a message sent in XML format. 500,000 Destination message size for a message sent in short text format DNS or IP address of the SMTP server to reach the server if no 25 port is specified. Alert group association with profile. All Format type. XML Call Home message level. 0 (zero) HTTP proxy server use. Disabled and no proxy server configured. HTTP proxy server message size for full text destination. 1 MB HTTP proxy server message size for XML. 1 MB 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, page 4-23 Enabling Call Home Function, page 4-24 Configuring Destination Profiles, page 4-24 Associating an Alert Group, page 4-26 Customizing Alert Group Messages, page 4-28 Configuring Event Trap Notifications, page 4-30 Configuring General Options, page 4-30 Configuring HTTPS Support, page 4-31 Configuring an HTTP Proxy Server, page 4-32 Enable or Disable Transport Method, page 4-31 Enabling Periodic Inventory Notifications, page 4-34 Configuring Duplicate Message Throttle, page 4-34 Enabling Call Home Fabric Distribution, page 4-35 Fabric Lock Override, page 4-36 Call Home Communications Test, page 4-36 Configuring Delayed Traps, page

23 Chapter 4 Task Flow for Follow these steps to configure Call Home: Step 1 Step 2 Step 3 Step 4 Step 5 Step 6 Configure contact information. Enable or disable Call Home. Configure destination profiles. Associate one or more alert groups to each profile as required by your network. Customize the alert groups, if desired. Configure options. Test Call Home messages. Configuring Contact Information Prerequisites Detailed Steps 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. Each switch must include , phone, and street address information. You can optionally include the contract ID, customer ID, site ID, and switch priority information. To assign the contact information, follow these steps: Step 1 switch# config t Enters configuration mode. Step 2 switch(config)# snmp-server contact Configures the SNMP contact name. personname@companyname.com Step 3 switch(config)# callhome Enters the Call Home configuration submode. Step 4 -contact username@company.com Assigns the customer s address. Up to 128 alphanumeric characters are accepted in address format. Step 5 phone-contact Note You can use any valid address. You cannot use spaces. 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. 4-23

24 Chapter 4 Step 6 streetaddress 1234 Picaboo Street, Any city, Any state, Assigns the customer s street address where the equipment is located. Up to 256 alphanumeric characters are accepted in free format. Step 7 switch-priority 0 Assigns the switch priority, with 0 being the highest priority and 7 the lowest. Step 8 Step 9 Step 10 customer-id Customer1234 site-id Site1ManhattanNY contract-id Company1234 Tip Use this field to create a hierarchical management structure. Optional. Identifies the customer ID. Up to 256 alphanumeric characters are accepted in free format. Optional. Identifies the customer site ID. Up to 256 alphanumeric characters are accepted in free format. Assigns the customer ID for the switch. Up to 64 alphanumeric characters are accepted in free format. Enabling Call Home Function Detailed Steps Once you have configured the contact information, you must enable the Call Home function. To enable the Call Home function, follow these steps: Step 1 switch# config t Enters configuration mode. Step 2 switch(config)# callhome Enters Call Home configuration submode. Step 3 enable callhome enabled successfully Enables the Call Home function. disable 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). 4-24

25 Chapter 4 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 86a e72.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 Enters the Call Home configuration submode. Step 3 Configures an address for the predefined destination-profile full-txt-destination profile. The addresses in this full-txt-destination -addr destination profile receives messages in full-txt format. The person@place.com full-text format provides the complete, detailed explanation of the failure. Step 4 destination-profile full-txt-destination message-size destination-profile short-txt-destination -addr person@place.com destination-profile short-txt-destination message-size Tip Use a standard address that does not have any text size restrictions. 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. Configures an address for the predefined short-txt-destination profile. The 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 address for this option. 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 A value of 0 implies that a message of any size can be sent. 4-25

26 Chapter 4 Step 5 destination-profile XML-destination -addr findout@.cisco.com destination-profile XML-destination message-size Configures an address for the predefined XML-destination profile. The 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 address to this destination profile because of the large message size. 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 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 Enters the Call Home configuration submode. Step 3 destination-profile Configures a new destination profile called test. test Step 4 destination-profile test -addr person@place.com Configures the address for the user-defined destination profile (test) sent in default XML format. Step 5 Step 6 destination-profile test message-size destination-profile test format full-txt destination-profile test format short-txt Configures a maximum message size for the destination 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. Configures message-format for the user-defined destination profile (test) to be full text format. 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. 4-26