Cisco MDS 9000 Family Configuration Guide, Release 1.3 (from Release 1.3(1) through Release 1.3(6)) - Configuring Call Home [Cisco MDS 9000 NX-OS and SAN-OS Software]

Table Of Contents

Configuring Call Home

Call Home Features

Call Home Configuration Process

Cisco AutoNotify

Configuring the Call Home Function

Assigning Contact Information

Configuring Destination Profiles

Configuring Alert Groups

Configuring Message Levels

Configuring E-Mail Options

Configuring General E-Mail Options

Configuring SMTP Server and Ports

Enabling or Disabling Call Home

Testing Call Home Communication

Displaying Call Home Information

Default Settings

Event Triggers

Call Home Message Levels

Message Contents

Configuring Call Home

Call Home 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 uses of this feature may include direct paging of a network support engineer, e-mail notification to a Network Operations Center, and utilization of Cisco AutoNotify services for direct case generation with the Technical Assistance Center.

This chapter provides configuration and messaging details on the Call Home feature. It includes the following sections:

•Call Home Features

•Call Home Configuration Process

•Cisco AutoNotify

•Configuring the Call Home Function

•Assigning Contact Information

•Configuring Destination Profiles

•Configuring Alert Groups

•Configuring Message Levels

•Configuring E-Mail Options

•Enabling or Disabling Call Home

•Testing Call Home Communication

•Displaying Call Home Information

•Default Settings

•Event Triggers

•Call Home Message Levels

•Message Contents

Call Home Features

The Call Home functionality is available directly through the Cisco MDS 9000 Family. It provides multiple Call Home profiles (also referred to as Call Home destination profiles), each with separate potential destinations. Each profile may be predefined or user-defined.

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. Up to 50 e-mail destination addresses are allowed for each format type.

•Multiple message categories including system, environment, switching module hardware, supervisor module, hardware, inventory, and test.

Call Home Configuration Process

The actual configuration of Call Home depends on how you intend to use the feature. Some points to consider include:

•An e-mail 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, e-mail, or automated service such as Cisco AutoNotify.

•The contact name (SNMP server contact), phone, and street address information must be configured before Call Home is enabled. This is required to determine the origin of messages received.

•The Cisco MDS 9000 switch must have IP connectivity to an e-mail server.

•If Cisco AutoNotify is used, an active service contract must cover the device being configured.

To configure Call Home, follow these steps:

Step 1 Configure the Call Home function.

Step 2 Assign contact information.

Step 3 Configure destination profiles.

Step 4 Associate one or more alert groups to each profile as required by your network.

Step 5 Enable or disable Call Home.

Step 6 Test Call Home messages..

Cisco AutoNotify

For those who have service contracts directly with Cisco Systems, automatic case generation with the Technical Assistance Center is possible by registering with the AutoNotify service. AutoNotify provides fast time to resolution of system problems by providing a direct notification path to Cisco customer support. The AutoNotify feature requires several Call Home parameters to be configured, including certain contact information, e-mail server, and an XML destination profile as specified in the Service Activation document found on the Cisco.com web site at: http://www.cisco.com/univercd/cc/td/doc/product/voice/c_callmg/3_3/service/serv332/ccmsrvs/sssrvact.htm

To configure a Cisco MDS 9000 Family switch to use the AutoNotify service, an XML destination profile must be configured to send messages to Cisco. Specific setup, activation, and e-mail address information is found on the Cisco.com web site at: http://www.cisco.com/warp/public/cc/serv/mkt/sup/tsssv/opmsup/smton/anoti_ds.htm

To register, the following items are required:

•The SMARTnet contract number covering your Cisco MDS 9000 Family switch.

•Your name, company address, your e-mail address, and your Cisco.com ID.

•The exact product number of your Cisco MDS 9000 Family switch. For example, some valid product numbers include: DS-C6509 and DS-C9216-K9.

•The serial number of your Cisco MDS 9000 Family switch. This can be obtained by looking at the serial number label on the back of the switch (next to the power supply).

You can issue the show sprom backplane 1 command or the show license host-id command to obtain the switch serial number. The contract-id, customer-id, site-id, and switch-priority parameters are not required by the AutoNotify feature. They only provide additional information to Cisco customers and service partners.

Configuring the Call Home Function

To enter the Call Home submode, follow these steps:
Command

Purpose
Step 1
switch# config t
Enters configuration mode.
Step 2
switch(config)# callhome
switch(config-callhome)#
Enters Call Home submode.
Step 3
switch(config-callhome)# ?
  contract-id          Service contract id of the customer
  customer-id          Customer id
  destination-profile  Configure destination profiles
  disable              Disable callhome
  email-contact        Email address of the contact person
  enable               Enable callhome
  exit                 Exit from this submode
  no                   Negate a command or set its defaults
  phone-contact        Contact person's phone number
  site-id              Site id of the network where switch is deployed
  streetaddress        Configure replacement part shipping address.
  switch-priority      Priority of the switch(0-highest 7-lowest)
  transport            Configure transport related configuration
Displays the options available at this prompt.
Assigning Contact Information

It is mandatory for each switch to include e-mail, phone, and street address information. It's optional to include the contract ID, customer ID, site ID, and switch priority information.

To assign the contact information, follow these steps:
Command

Purpose
Step 1
switch# config t
Enters configuration mode.
Step 2
switch# snmp-server contact 
personname@companyname.com 
Configures the SNMP contact e-mail address to receive a test message reply from Cisco.
Step 3
switch(config)# callhome
switch(config-callhome)#
Enters the Call Home submode.
Step 4
switch(config-callhome)# email-contact 
username@company.com
successfully updated the information
switch(config-callhome)#
Assigns the customer's e-mail address. Up to 128 alphanumeric characters are accepted in e-mail address format.

Note You can use any valid e-mail address. You cannot use spaces.
Step 5
switch(config-callhome)# phone-contact 
+1-800-123-4567
successfully updated the information
switch(config-callhome)#
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
successfully updated the information
switch(config-callhome)#
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
successfully updated the information
switch(config-callhome)#
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 
successfully updated the information
switch(config-callhome)#
Optional. Identifies the customer ID. Up to 256 alphanumeric characters are accepted in free format.
Step 9
switch(config-callhome)# site-id 
Site1ManhattanNY
successfully updated the information
switch(config-callhome)#
Optional. Identifies the customer site ID. Up to 256 alphanumeric characters are accepted in free format.
Step 10
switch(config-callhome)# contract-id 
Company1234 
successfully updated the information
switch(config-callhome)#
Assigns the customer ID for the switch. Up to 64 alphanumeric characters are accepted in free format.
Configuring Destination Profiles

A destination profile contains the required delivery information for an alert notification. Destination profiles are typically configured by the network administrator. 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.

Note If you use the Cisco AutoNotify service, the XML destination profile is required (see http://www.cisco.com/warp/public/cc/serv/mkt/sup/tsssv/opmsup/smton/anoti_ds.htm).

•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).

To configure predefined destination profile messaging options, follow these steps:
Command

Purpose
Step 1
switch# config t
Enters configuration mode.
Step 2
switch(config)# callhome
switch(config-callhome)#
Enters the Call Home submode.
Step 3
switch(config-callhome)# 
destination-profile 
full-txt-destination email-addr 
person@place.com
Configures a predefined destination e-mail address for a message sent in full text format. This text provides the complete, detailed explanation of the failure.

Tip Use a standard e-mail address that does not have any text size restrictions.
switch(config-callhome)# 
destination-profile 
full-txt-destination message-size 
1000000
Configures a predefined destination message size for a message sent in full text 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 4
switch(config-callhome)# 
destination-profile 
short-txt-destination email-addr 
person@place.com
Configures a predefined destination e-mail address for a message sent in short text format. This text provides the basic explanation of the failure.

Tip Use a pager-related e-mail address for this option.
switch(config-callhome)# 
destination-profile 
short-txt-destination message-size 
100000
Configures a predefined destination message size for a message sent in short text format. 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.
Step 5
switch(config-callhome)# 
destination-profile XML-destination 
email-addr findout@.cisco.com
Configures a predefined destination e-mail address for a message sent in XML format. This option provides the full information that is compatible with Cisco Systems TAC support.

Tip Do not add a pager-related e-mail address to this destination profile because of the large message size.
switch(config-callhome)# 
destination-profile XML-destination 
message-size 100000
Configures a predefined destination message size for a message sent in 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.
Note Steps 3, 4, and 5 in this procedure can be skipped or configured in any order.

To configure new destination profile messaging options, follow these steps:
Command

Purpose
Step 1
switch# config t
Enters configuration mode.
Step 2
switch(config)# callhome
switch(config-callhome)#
Enters the Call Home 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 e-mail address for the user-defined destination message (test) sent in default XML format.
Step 5
switch(config-callhome)# destination-profile 
test message-size 1000000
Configures a message size for the user-defined destination message (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 a user-defined destination message (test) sent in full text format.
switch(config-callhome)# destination-profile 
test format short-txt
Configures a user-defined destination message (test) sent in short text format.
Note Steps 4, 5, and 6 in this procedure can be skipped or configured in any order.

Configuring Alert Groups

You can associate one or more alert groups to each profile as required by your network. By default, all alert groups are associated with each profile. The alert-group option allows you to select predefined types of Call Home alert notifications for destination profiles (predefined and user-defined). Destination profiles can be associated with multiple alert groups.

To configure alert group options, follow these steps:
Command

Purpose
Step 1
switch# config t
Enters configuration mode.
Step 2
switch(config)# callhome
switch(config-callhome)#
Enters Call Home submode.
Step 3
switch(config-callhome)# destination-profile 
test1 alert-group test 
Optional. Configures user-defined destination message profile (test1) to send Call Home notifications for all user-generated test events.
switch(config-callhome)# destination-profile 
short-txt-destination alert-group test 
Optional. Configures predefined short-text destination message profile to send Call Home notifications for all user-generated test events.
Step 4
switch(config-callhome)# destination-profile 
test1 alert-group all 
Optional. Configures user-defined destination message profile (test1) to send 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 send 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 send 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 send 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 send 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 send 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 send 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 send 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 send 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 send 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 send 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 send 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 send 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 send Call Home notifications for software-related events.
Configuring Message Levels

The message-level option 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 that the urgency threshold is not sent. 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).

To configure alert group options, follow these steps:
Command

Purpose
Step 1
switch# config t
Enters configuration mode.
Step 2
switch(config)# callhome
switch(config-callhome)#
Enters Call Home 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 E-Mail Options

You can configure the from, reply-to, and return-receipt e-mail addresses. While most e-mail address configurations are optional, you must configure the SMTP server address and port number for the Call Home functionality to work.

Configuring General E-Mail Options

To configure general e-mail options, follow these steps:
Command

Purpose
Step 1
switch# config t
Enters configuration mode.
Step 2
switch(config)# callhome
switch(config-callhome)#
Enters Call Home submode.
Step 3
switch(config-callhome)# transport 
email from user@company1.com 
Optional. Configures the from e-mail address.
Step 4
switch(config-callhome)# transport 
email reply-to person@place.com
Optional. Configures the reply-to e-mail address to which all responses should be sent.
Configuring SMTP Server and Ports

To configure the SMTP server and port, follow these steps:
Command

Purpose
Step 1
switch# config t
Enters configuration mode.
Step 2
switch(config)# callhome
switch(config-callhome)#
Enters Call Home submode.
Step 3
switch(config-callhome)# transport 
email smtp-server 192.168.1.1 
successfully updated the information
switch(config-callhome)# 
Configures the DNS or IP 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
successfully updated the information
switch(config-callhome)# 
Enabling or Disabling Call Home

Once you have configured the contact information, you must enable the Call Home function. The enable command is required for the Call Home function to start operating.

To enable the Call Home function, follow these steps:
Command

Purpose
Step 1
switch# config t
Enters configuration mode.
Step 2
switch(config)# callhome
switch(config-callhome)#
Enters Call Home 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 to syslog.
Testing Call Home Communication

You can simulate a message generation by issuing a test command.

To test the Call Home function, follow these steps:
Command

Purpose
Step 1
switch# callhome test
trying to send test callhome message
successfully sent test callhome message
switch#
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
switch#
Sends a test inventory message to the configured destination(s).
Displaying Call Home Information

Use the show callhome command to display the configured Call Home information (see Examples 23-1 to 23-7).

Example 23-1 Displays Configured Call Home Information
switch# show callhome 
callhome enabled
Callhome 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
customer id:Customer1234
contract id:Andiamo1234
switch priority:0
Example 23-2 Displays Information for All Destination Profiles (Predefined and User-Defined)
switch# show callhome destination-profile 
XML destination profile information
maximum message size:500000
message format:XML
message-level:0
email addresses configured:
alert groups configured:
cisco_tac
test destination profile information
maximum message size:100000
message format:full-txt
message-level:5
email addresses configured:
cchetty@isco.com
alert groups configured:
test
full-txt destination profile information
maximum message size:500000
message format:full-txt
message-level:0
email addresses configured:
alert groups configured:
all
short-txt destination profile information
maximum message size:4000
message format:short-txt
message-level:0
email addresses configured:
alert groups configured:
all
Example 23-3 Displays Information for a User-defined Destination Profile
switch# show callhome destination-profile test
test destination profile information
maximum message size:100000
message format:full-txt
message-level:5
email addresses configured:
user@company.com
alert groups configured:
test
Example 23-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:
person2@company2.com
Example 23-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:
person2@company2.com
Example 23-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:
findout@.cisco.com
Example 23-7 Displays E-Mail 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
smtp server port:25
Default Settings

Table 23-1 lists the default Call Home default settings.

Table 23-1 Default Call Home 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.

4,000.

DNS or IP address of the SMTP server to reach the server if no port is specified.

25.

Alert group association with profile.

All.

Format type.

XML.

Call Home message level.

0 (zero).

Event Triggers

This section discusses Call Home trigger events. Trigger events are divided into categories, with each category assigned commands to execute when the event occurs. The command output is included in the transmitted message. Table 23-2 lists the trigger events. Table 23-3 lists event categories and command outputs.

Table 23-2 Event Triggers

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

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

Switching module and CISCO_TAC

LINECARD_FAILURE

Switching module operation failed.

7

POWER_UP_DIAGNOSTICS_FAILURE

Switching module 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 module and CISCO_TAC

SUP_FAILURE

Supervisor module operation failed.

7

POWER_UP_DIAGNOSTICS_FAILURE

Supervisor module failed power-up diagnostics.

7

Call Home

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

Supervisor Hardware and CISCO_TAC

MGMT_PORT_FAILURE

Hardware failure of management Ethernet port.

5

License

LICENSE_VIOLATION

Feature in use is not licensed (Cisco MDS SAN-OS Release 1.3), 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

Table 23-3 Event Categories and Command Outputs

Event Category

Description

Executed Commands

System

Events generated by failure of a software system that is critical to unit operation.

show tech-support
show system redundancy status

Environmental

Events related to power, fan, and environment sensing elements such as temperature alarms.

show module
show environment

Switching module hardware

Events related to standard or intelligent switching modules.

show tech-support

Supervisor hardware

Events related to supervisor modules.

show tech-support

Inventory

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

User generated test message.

show version

Call Home Message Levels

This section discusses the severity levels for a Call Home message when using one or more switches in the Cisco MDS 9000 Family. Call Home Message levels are preassigned per event type.

Note Call Home severity levels are not the same as system message logging severity levels (see "Configuring System Message Logging").

Severity levels range from 0 to 9, with 9 having the highest urgency. Each syslog level has keywords as listed in Table 23-4.

Table 23-4 Severity Levels

Call Home Level

Keyword Used

Description

Catastrophic (9)

Catastrophic

Network wide catastrophic failure.

Disaster (8)

Disaster

Significant network impact.

Fatal (7)

Fatal

System is unusable.

Critical (6)

Critical

Critical conditions, immediate attention needed.

Major (5)

Major

Major conditions.

Minor (4)

Minor

Minor conditions.

Warning (3)

Warning

Warning conditions.

Notify (2)

Notification

Basic notification and informational messages. Possibly independently insignificant.

Normal (1)

Normal

Normal event signifying return to normal state.

Debug (0)

Debugging

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 23-5 describes the short text formatting option for all message types.

Table 23-5 Short Text Messages

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 syslog message

Table 23-6, Table 23-7, and Table 23-8 display the information contained in plain text and XML messages.

Table 23-6 Reactive Event Message Format

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-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.

/mml/header/time

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

Message group

Specifically "reactive."

/mml/header/group

Severity level

Severity level of message (see Table 23-4).

/mml/header/level

Source ID

Product type for routing.

/mml/header/source

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: type@Sid@serial, where

•Type is the product model number from backplane SEEPROM.

•@ is a separator character.

•Sid is "C" identifying serial ID as a chassis serial number·

•Serial number as 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

Contract ID

Optional user-configurable field used for contract info or other ID by any support service.

/mml/ header /contractId

Site ID

Optional user-configurable field used for Cisco-supplied site ID or other data meaningful to alternate support service.

/mml/ header/siteId

Server ID

If the message is generated from the fabric switch, it is the unique device identifier (UDI) of the switch.

Format: type@Sid@serial, where

•Type is the product model number from backplane SEEPROM.

•@ is a separator character.

•Sid is "C" identifying serial ID as a chassis serial number·

•Serial number as identified by the Sid field.

Example: "DS-C9509@C@12345678

/mml/header/serverId

Message description

Short text describing the error.

/mml/body/msgDesc

Device name

Node that experienced the event. This is the host name of the device.

/mml/body/sysName

Contact name

Name of person to contact for issues associated with the node experiencing the event.

/mml/body/sysContact

Contact e-mail

E-mail address of person identified as contact for this unit.

/mml/body/sysContactEmail

Contact phone number

Phone number of the person identified as the contact for this unit.

/mml/body/sysContactPhoneNumber

Street address

Optional field containing street address for RMA part shipments associated with this unit.

/mml/body/sysStreetAddress

Model name

Model name of the switch. This is the specific model as part of a product family name.

/mml/body/chassis/name

Serial number

Chassis serial number of the unit.

/mml/body/chassis/serialNo

Chassis part number

Top assembly number of the chassis.

/mml/body/chassis/partNo

Chassis hardware version

Hardware version of chassis.

/mml/body/chassis/hwVersion

Supervisor module software version

Top level software version.

/mml/body/chassis/swVersion

Affected FRU name

Name of the affected FRU generating the event message.

/mml/body/fru/name

Affected FRU serial number

Serial number of affected FRU.

/mml/body/fru/serialNo

Affected FRU part number

Part number of affected FRU.

/mml/body/fru/partNo

FRU slot

Slot number of FRU generating the event message.

/mml/body/fru/slot

FRU hardware version

Hardware version of affected FRU.

/mml/body/fru/hwVersion

FRU software version

Software version(s) running on affected FRU.

/mml/body/fru/swVersion

Command output name

Exact command that was run. For example, show running-config command.

/mml/attachments/attachment/name

Attachment type

Specifically command output.

/mml/attachments/attachment/type

MIME type

Normally text or plain or encoding type.

/mml/attachments/attachment/mime

Command output text

Output of command automatically executed (see Table 23-3).

/mml/attachments/attachment/atdata

Table 23-7 Inventory Event Message Format

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-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.

/mml/header/time

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

Message group

Specifically "proactive".

/mml/header/group

Severity level

Severity level of inventory event is level 2 (seeTable 23-4).

/mml/header/level

Source ID

Product type for routing at Cisco. Specifically "MDS 9000"

/mml/header/source

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: type@Sid@serial, where

•Type is the product model number from backplane SEEPROM.

•@ is a separator character.

•Sid is "C" identifying serial ID as a chassis serial number·

•Serial: The serial number as 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

Contract ID

Optional user-configurable field used for contact info or other ID by any support service.

/mml/ header /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 /siteId

Server ID

If the message is generated from the fabric switch, it is the Unique device identifier (UDI) of the switch.

Format: type@Sid@serial, where

•Type is the product model number from backplane SEEPROM.

•@ is a separator character.

•Sid is "C" identifying serial ID as a chassis serial number·

•Serial: The serial number as identified by the Sid field.

Example: "DS-C9509@C@12345678

/mml/header/serverId

Message description

Short text describing the error.

/mml/body/msgDesc

Device name

Node that experienced the event.

/mml/body/sysName

Contact name

Name of person to contact for issues associated with the node experiencing the event.

/mml/body/sysContact

Contact e-mail

E-mail address of person identified as contact for this unit.

/mml/body/sysContactEmail

Contact phone number

Phone number of the person identified as the contact for this unit.

/mml/body/sysContactPhoneNumber

Street address

Optional field containing street address for RMA part shipments associated with this unit.

/mml/body/sysStreetAddress

Model name

Model name of the unit. This is the specific model as part of a product family name.

/mml/body/chassis/name

Serial number

Chassis serial number of the unit.

/mml/body/chassis/serialNo

Chassis part number

Top assembly number of the chassis.

/mml/body/chassis/partNo

Chassis hardware version

Hardware version of chassis.

/mml/body/chassis/hwVersion

Supervisor module software version

Top level software version.

/mml/body/chassis/swVersion

FRU name

Name of the affected FRU generating the event message.

/mml/body/fru/name

FRU s/n

Serial number of FRU.

/mml/body/fru/serialNo

FRU part number

Part number of FRU.

/mml/body/fru/partNo

FRU slot

Slot number of FRU.

/mml/body/fru/slot

FRU hardware version

Hardware version of FRU.

/mml/body/fru/hwVersion

FRU software version

Software version(s) running on FRU.

/mml/body/fru/swVersion

Command output name

Exact command that was run. For example, the show running-config command.

/mml/attachments/attachment/name

Attachment type

Specifically command output.

/mml/attachments/attachment/type

MIME type

Normally text or plain or encoding type.

/mml/attachments/attachment/mime

Command output text

Output of command automatically executed after event categories (see "Event Triggers" section).

/mml/attachments/attachment/atdata

Table 23-8 User-Generated Test Message Format

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-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.

/mml/header/time

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

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 23-4).

/mml/header/level

Source ID

Product type for routing.

/mml/header/source

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: type@Sid@serial, where

•Type is the product model number from backplane SEEPROM.

•@ is a separator character.

•Sid is "C" identifying serial ID as a chassis serial number·

•Serial: The serial number as 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

Contract ID

Optional user-configurable field used for contract info or other ID by any support service.

/mml/ header /contractId

Site ID

Optional user-configurable field used for Cisco-supplied site ID or other data meaningful to alternate support service.

/mml/ header /siteId

Server ID

If the message is generated from the fabric switch, it is the Unique device identifier (UDI) of the switch.

Format: type@Sid@serial, where

•Type is the product model number from backplane SEEPROM.

•@ is a separator character.

•Sid is "C" identifying serial ID as a chassis serial number·

•Serial: The serial number as identified by the Sid field.

Example: "DS-C9509@C@12345678

/mml/header/serverId

Message description

Short text describing the error.

/mml/body/msgDesc

Device name

Switch that experienced the event.

/mml/body/sysName

Contact name

Name of person to contact for issues associated with the node experiencing the event.

/mml/body/sysContact

Contact Email

E-mail address of person identified as contact for this unit.

/mml/body/sysContactEmail

Contact phone number

Phone number of the person identified as the contact for this unit.

/mml/body/sysContactPhoneNumber

Street address

Optional field containing street address for RMA part shipments associated with this unit.

/mml/body/sysStreetAddress

Model name

Model name of the switch. This is the specific model as part of a product family name.

/mml/body/chassis/name

Serial number

Chassis serial number of the unit.

/mml/body/chassis/serialNo

Chassis part number

Top assembly number of the chassis. For example, 800-xxx-xxxx.

/mml/body/chassis/partNo

Command output text

Output of command automatically executed after event categories listed in Table 23-3.

/mml/attachments/attachment/atdata

MIME type

Normally text or plain or encoding type.

/mml/attachments/attachment/mime

Attachment type

Specifically command output.

/mml/attachments/attachment/type

Command output name

Exact command that was run. For example, the show running-config command.

/mml/attachments/attachment/name