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 e-mail-based notification of critical system events. A versatile range of message formats are available for optimal compatibility with pager services, standard e-mail, or XML-based automated parsing applications.
Common features may include the following:
-
Paging the network support engineer
-
E-mailing 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 Series 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 e-mail 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.
Call Home Features
The Call Home functionality is available directly through the Cisco MDS 9000 Series 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 e-mail 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.
Note |
Beginning from the Cisco MDS Release 7.3(0)D1(1), all the alerts are classified under the type, Environment and sub type, Minor. |
-
SUP_FAILURE, POWER_SUPPY_FAILURE, LINECARD_FAILURE alerts are classified under the type, Environment and sub type, Major.
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 1 lists the benefits of Smart Call Home.
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 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 e-mail 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:
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 Series 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 Series 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 e-mail destinations in a destination profile only if that Call Home alert belongs to one of the alert groups associated with that destination profile.
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 Series 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 Table 1). 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 Table 1).
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 Series 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 E-Mail 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 Series 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 Series 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 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 E-mail Home Delayed Traps
DCNM-SAN can be configured to generate EMC E-mail Home XML e-mail messages. In SAN-OS Release 3.x or earlier, DCNM-SAN listens to interface traps and generates EMC E-mail Home e-mail 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 e-mail notification.
Cisco NX-OS Release 4.1(3) provides the ability to generate a delayed trap so that the number of generated e-mail messages is reduced. This method filters server reboots and avoids generating unnecessary EMC E-mail Home e-mail 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 1 lists the trigger events.
Event |
Alert Group |
Event Name |
Description |
Call Home Message Level |
||
---|---|---|---|---|---|---|
Call Home |
System and CISCO_TAC |
SW_CRASH |
A software process has crashed with a stateless restart, indicating an interruption of a service. |
5 |
||
Call Home |
System and CISCO_TAC |
CRASH_PROC |
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 |
|||
Environmental and CISCO_TAC |
POWER_SUPPLY_FAILURE |
Power supply failed. |
6 |
|||
Environmental and CISCO_TAC |
FAN_FAILURE |
Cooling fan has failed. |
5 |
|||
Line Card Hardware and CISCO_TAC |
LINECARD_FAILURE |
Line card hardware operation failed. |
7 |
|||
Line Card Hardware and CISCO_TAC |
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.
|
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
Event Category |
Description |
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-supportshow 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 moduleshow 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).
This section discusses the severity levels for a Call Home message when using one or more switches in the Cisco MDS 9000 Series 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 2.
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 Series System Messages Reference. |
Note |
Call Home severity levels are not the same as system message logging severity levels (see the Cisco MDS 9000 Series System Messages Reference). |
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. |
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
-
E-mail 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 1 describes the short text formatting option for all message types.
Data Item |
Description |
---|---|
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 2, Table 3, and Table 4 display the information contained in plain text and XML messages.
Data Item(Plain text and XML) |
Description(Plain text and XML) |
XML Tag (XML only) |
||
---|---|---|---|---|
Time stamp |
Date and time stamp of event in ISO time notation: YYYY-MM-DD THH:MM:SS .
|
/mml/header/time - ch:EventTime |
||
Message name |
Name of message. Specific event names are listed in the Event Triggers. |
/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 2). |
/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:
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@ serial , where:
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 e-mail |
E-mail address of person identified as contact for this unit. |
/mml/body/sysContacte-mail - ch:SystemInfo/Contacte-mail |
||
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 Series 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 Table 1). |
/mml/attachments/attachment/atdata - aml-block:Attachment/Data |
Data Item(Plain text and XML) |
Description(Plain text and XML) |
XML Tag(XML only) |
||
---|---|---|---|---|
Time stamp |
Date and time stamp of event in ISO time notation: YYYY-MM-DD THH:MM:SS .
|
/mml/header/time - ch:EventTime |
||
Message name |
Name of message. Specifically “Inventory Update” Specific event names are listed in the Event Triggers. |
/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 2). |
/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:
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:
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 e-mail |
E-mail address of person identified as contact for this unit. |
/mml/body/sysContacte-mail - ch-inv:SystemInfo/Contacte-mail |
||
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 Series 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). |
/mml/attachments/attachment/atdata - aml-block:Attachment/Data |
Data Item(Plain text and XML) |
Description(Plain text and XML) |
XML Tag(XML only) |
||
---|---|---|---|---|
Time stamp |
Date and time stamp of event in ISO time notation: YYYY-MM-DD THH:MM:SS .
|
/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). |
/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 2). |
/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:
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:
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 e-mail |
E-mail address of person identified as contact for this unit. |
/mml/body/sysContacte-mail - ch:SystemInfo/Contacte-mail |
||
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 Series 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 1. |
/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 |