Message Contents

The following contact information can be configured on the switch:

Table 4-4 describes the short text formatting option for all message types.

Table 4-4 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 system message

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

Table 4-5 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 - ch:EventTime

Message name

Name of message. Specific event names are listed in the "Event Triggers" topic.

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

/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:

    • type is the product model number from backplane SEEPROM.
    • @ is a separator character.
    • Sid is “C,” identifying the serial ID as a chassis serial number.
    • serial is the number identified by the Sid field.

Example: DS-C9509@C@12345678

/mml/ header/deviceId

Customer ID

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

/mml/header/customerID - ch:CustomerId

Contract ID

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

/mml/header/contractId - ch:ContractId>

Site ID

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

/mml/header/siterId - ch:SiteId

Server ID

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

Format is type@Sid@serial, where:

    • type is the product model number from backplane SEEPROM.
    • @ is a separator character.
    • Sid is “C” identifying the serial ID as a chassis serial number.
    • serial is the number identified by the Sid field.

Example: DS-C9509@C@12345678

/mml/header/serverId - -blank-

Message description

Short text describing the error.

/mml/body/msgDesc - ch:MessageDescription

Device name

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

/mml/body/sysName - ch:SystemInfo/Name

Contact name

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

/mml/body/sysContact - ch:SystemInfo/Contact

Contact 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/sysContactPhone Number - ch:SystemInfo/ContactPhone Number

Street address

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

/mml/body/sysStreetAddress - ch:SystemInfo/StreetAddress

Model name

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

/mml/body/chassis/name - rme:Chassis/Model

Serial number

Chassis serial number of the unit.

/mml/body/chassis/serialNo - rme:Chassis/SerialNumber

Chassis part number

Top assembly number of the chassis.

/mml/body/fru/partNo - rme:chassis/Card/PartNumber

Chassis hardware version

Hardware version of chassis.

/mml/body/chassis/hwVersion - rme:Chassis/HardwareVersion

Supervisor module software version

Top level software version.

/mml/body/fru/swVersion - rme:chassis/Card/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

Serial number of affected FRU.

/mml/body/fru/serialNo - rme:chassis/Card/SerialNumb er

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/LocationWit hinContainer

FRU hardware version

Hardware version of affected FRU.

/mml/body/fru/hwVersion - rme:chassis/Card/SoftwareIde ntity

FRU software version

Software version(s) running on affected FRU.

/mml/body/fru/swVersion - rme:chassis/Card/SoftwareIde ntity

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.

/mml/attachments/attachment/ atdata - aml-block:Attachment/Data

Table 4-6 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 - ch:EventTime

Message name

Name of message. Specifically “Inventory Update” Specific event names are listed in the "Event Triggers" topic.

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

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

    • type is the product model number from backplane SEEPROM.
    • @ is a separator character.
    • Sid is “C” identifying the serial ID as a chassis serial number.
    • serial is the number identified by the Sid field.

Example: DS-C9509@C@12345678

/mml/ header /deviceId

Customer ID

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

/mml/header/customerID - ch-inv:CustomerId

Contract ID

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

/mml/header/contractId - ch-inv:ContractId>

Site ID

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

/mml/header/siterId - ch-inv:SiteId

Server ID

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

Format is type@Sid@serial, where:

    • type is the product model number from backplane SEEPROM.
    • @ is a separator character.
    • Sid is “C” identifying the serial ID as a chassis serial number.
    • serial is the number identified by the Sid field.

Example: DS-C9509@C@12345678

/mml/header/serverId - -blank-

Message description

Short text describing the error.

/mml/body/msgDesc - ch-inv:MessageDescription

Device name

Node that experienced the event.

/mml/body/sysName - ch-inv:SystemInfo/Name

Contact name

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

/mml/body/sysContact - ch-inv:SystemInfo/Contact

Contact 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/sysContactPhone Number - ch-inv:SystemInfo/ContactPh oneNumber

Street address

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

/mml/body/sysStreetAddress - ch-inv:SystemInfo/StreetAddr ess

Model name

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

/mml/body/chassis/name - rme:Chassis/Model

Serial number

Chassis serial number of the unit.

/mml/body/chassis/serialNo - rme:Chassis/SerialNumber

Chassis part number

Top assembly number of the chassis.

/mml/body/fru/partNo - rme:chassis/Card/PartNumber

Chassis hardware version

Hardware version of chassis.

/mml/body/fru/hwVersion - rme:chassis/Card/SoftwareIde ntity

Supervisor module software version

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

Hardware version of FRU.

/mml/body/fru/hwVersion - rme:chassis/Card/SoftwareIde ntity

FRU software version

Software version(s) running on FRU.

/mml/body/fru/swVersion - rme:chassis/Card/SoftwareIde ntity

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" topic).

/mml/attachments/attachment /atdata - aml-block:Attachment/Data

Table 4-7 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 - ch:EventTime

Message name

Name of message. Specifically test message for test type message. Specific event names listed in the "Event Triggers" topic).

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

/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:

    • type is the product model number from backplane SEEPROM.
    • @ is a separator character.
    • Sid is “C” identifying the serial ID as a chassis serial number.
    • serial is the number identified by the Sid field.

Example: DS-C9509@C@12345678

/mml/ header /deviceId

Customer ID

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

/mml/header/customerID - ch:CustomerId

Contract ID

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

/mml/header/contractId - ch:ContractId

Site ID

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

/mml/header/siterId - ch:SiteId

Server ID

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

Format is type@Sid@serial, where:

    • type is the product model number from backplane SEEPROM.
    • @ is a separator character.
    • Sid is “C” identifying the serial ID as a chassis serial number.
    • serial is the number identified by the Sid field.

Example: “DS-C9509@C@12345678

/mml/header/serverId - -blank-

Message description

Short text describing the error.

/mml/body/msgDesc - ch:MessageDescription

Device name

Switch that experienced the event.

/mml/body/sysName - ch:SystemInfo/Name

Contact name

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

/mml/body/sysContact - ch:SystemInfo/Contact

Contact e-mail

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

/mml/body/sysContacte-mai l - ch:SystemInfo/Contacte-mai l

Contact phone number

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

/mml/body/sysContactPhone Number - ch:SystemInfo/ContactPhon eNumber

Street address

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

/mml/body/sysStreetAddress - ch:SystemInfo/StreetAddres s

Model name

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

/mml/body/chassis/name - rme:Chassis/Model

Serial number

Chassis serial number of the unit.

/mml/body/chassis/serialNo - rme:Chassis/SerialNumber

Chassis part number

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

/mml/body/fru/partNo - rme:chassis/Card/PartNumb er

Command output text

Output of command automatically executed after event categories.

/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

Command output name

The exact name of the issued command.

/mml/attachments/attachmen t/name - aml-block:Attachment/Nam e



Copyright 2010-2013, Cisco Systems, Inc. All rights reserved.