<?xml version="1.0" encoding="UTF-8"?>
<!-- ?xml-stylesheet href="dsp8000_1.0.0.xsl" type="text/xsl"? -->
<!-- The xsl-stylesheet processing instruction above has been disabled because not all web browsers support them when
this XML file is accessed through HTTP.  To enable automatic stylesheet processing, download this XML file to a local
file system, along with the XSL file referenced in the href attribute, and enable the xsl-stylesheet processing
instruction in that local copy.  -->
<!--
DMTF - Distributed Management Task Force, Inc. - http://www.dmtf.org

Document number: DSP2022
Date: 2009-07-28
Version: 1.0.0
Document status: Informational

Title: Sample Message Registry

Document type: Technical Note (XML Instance Document)
Document language: E

Abstract: This document is a sample DMTF message registry.

Contact group: DMTF Infrastructure Sub-Committee, infrastructure-sc@dmtf.org

Acknowledgements: DMTF acknowledges the contributions of the following individuals to this document:
* Jim Davis (WBEM Solutions)
* Steve Hand (Symantec)
* Andreas Maier (IBM) (Editor)
* Linda Martinez (Dell)

Copyright (C) 2008,2009 Distributed Management Task Force, Inc. (DMTF).  All rights reserved.
DMTF is a not-for-profit association of industry members dedicated to promoting enterprise and
systems management and interoperability.  Members and non-members may reproduce DMTF specifications
and documents for uses consistent with this purpose, provided that correct attribution is given.  As
DMTF specifications may be revised from time to time, the particular version and release date should
always be noted.  Implementation of certain elements of this standard or proposed standard may be
subject to third party patent rights, including provisional patent rights (herein "patent rights").
DMTF makes no representations to users of the standard as to the existence of such rights, and is
not responsible to recognize, disclose, or identify any or all such third party patent right, owners
or claimants, nor for any incomplete or inaccurate identification or disclosure of such rights,
owners or claimants.  DMTF shall have no liability to any party, in any manner or circumstance,
under any legal theory whatsoever, for failure to recognize, disclose, or identify any such third
party patent rights, or for such party's reliance on the standard or incorporation thereof in its
product, protocols or testing procedures.  DMTF shall have no liability to any party implementing
such standard, whether such implementation is foreseeable or not, nor to any patent owner or
claimant, and shall have no liability or responsibility for costs or losses incurred if a standard
is withdrawn or modified after publication, and shall be indemnified and held harmless by any party
implementing the standard from any and all claims of infringement by a patent owner for such
implementations.  For information about patents held by third-parties which have notified the DMTF
that, in their opinion, such patent may relate to or impact implementations of DMTF standards, visit
http://www.dmtf.org/about/policies/disclosures.php.

Change log:
1.0.0 - 2009-07-28 - Released as DMTF Standard
-->
<REGISTRY xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.dmtf.org/wbem/messageregistry/1" xsi:schemaLocation="http://schemas.dmtf.org/wbem/messageregistry/1 http://schemas.dmtf.org/wbem/messageregistry/1/dsp0228_1.0.xsd">
    <REGISTRY_DECLARATION>
        <IDENTIFICATION NAME="Sample message registry" LANGUAGE="en" VERSION="1.0.0c"/>
        <CIM_SCHEMA VERSION="2.19"/>
        <OWNING_ENTITY>DMTF</OWNING_ENTITY>
        <DESCRIPTION>This is a sample message registry that includes some examples of common messages
            that can be produced by all CIM/WBEM implementations.</DESCRIPTION>
    </REGISTRY_DECLARATION>
    <REGISTRY_ENTRIES>
        <MESSAGE NAME="Parameter Error">
            <MESSAGE_ID PREFIX="WIP" SEQUENCE_NUMBER="0014"/>
            <MESSAGE_DESCRIPTION>
                A parameter error message is produced when the parameter to an intrisic or extrinsic method are
                incorrect. This message is designed to inform the client what parameters are problematic and
                why.
            </MESSAGE_DESCRIPTION>
            <MESSAGE_COMPONENTS>
                <STATIC_ELEMENT>Parameter </STATIC_ELEMENT>
                <DYNAMIC_ELEMENT NAME="Position" DATATYPE="uint16">
                    <DESCRIPTION>The position the errant argument appears in the declaration of the
                        method, from left to right</DESCRIPTION>
                </DYNAMIC_ELEMENT>
                <STATIC_ELEMENT> of the </STATIC_ELEMENT>
                <DYNAMIC_ELEMENT NAME="Method Type" DATATYPE="string">
                    <POSSIBLE_VALUE>extrinsic</POSSIBLE_VALUE>
                    <POSSIBLE_VALUE>intrinsic</POSSIBLE_VALUE>
                </DYNAMIC_ELEMENT>
                <STATIC_ELEMENT> method, </STATIC_ELEMENT>
                <DYNAMIC_ELEMENT NAME="Method Name" DATATYPE="string"/>
                <STATIC_ELEMENT> , is invalid because </STATIC_ELEMENT>
                <DYNAMIC_ELEMENT NAME="Reason for invalid parameter" DATATYPE="string">
                    <POSSIBLE_VALUE>parameter value out of range</POSSIBLE_VALUE>
                    <POSSIBLE_VALUE>invalid combination</POSSIBLE_VALUE>
                    <POSSIBLE_VALUE>null parameter is not permitted</POSSIBLE_VALUE>
                    <POSSIBLE_VALUE>non-null value is not permitted</POSSIBLE_VALUE>
                    <POSSIBLE_VALUE>empty string is not permitted</POSSIBLE_VALUE>
                    <POSSIBLE_VALUE>empty array is not permitted</POSSIBLE_VALUE>
                </DYNAMIC_ELEMENT>
                <STATIC_ELEMENT>. Please fix the parameter at position </STATIC_ELEMENT>
                <REPEAT_DYNAMIC_ELEMENT NAME="Position"/>
                <STATIC_ELEMENT> and retry. </STATIC_ELEMENT>
                <DYNAMIC_ELEMENT NAME="Protocol Error Code" SOURCE_PROPERTY="CIM_Error.CIMStatusCode" DATATYPE="string" EXPECTED_IN_MESSAGE="false">
                    <DESCRIPTION>Protocol specific error code reported from operation.</DESCRIPTION>
                </DYNAMIC_ELEMENT>
            </MESSAGE_COMPONENTS>
            <FIXED_MESSAGE_INSTANCE_VALUES TYPE="ERROR">
                <CIMSTATUSCODE> 4 <DESCRIPTION>CIM_ERR_INVALID_PARAMETER</DESCRIPTION>
                </CIMSTATUSCODE>
                <ERROR_TYPE> 4 <DESCRIPTION>Software Error</DESCRIPTION>
                </ERROR_TYPE>
                <ERROR_SOURCE EXISTENCE_IS="discouraged">
                    <DESCRIPTION> It is discouraged from specifying any reference here. </DESCRIPTION>
                </ERROR_SOURCE>
                <PERCEIVED_SEVERITY> 2 <DESCRIPTION>Low</DESCRIPTION>
                </PERCEIVED_SEVERITY>
            </FIXED_MESSAGE_INSTANCE_VALUES>
        </MESSAGE>
        <MESSAGE NAME="Shutdown Started">
            <MESSAGE_ID PREFIX="WIP" SEQUENCE_NUMBER="0032"/>
            <MESSAGE_COMPONENTS>
                <STATIC_ELEMENT> The computer system is shutting down in </STATIC_ELEMENT>
                <DYNAMIC_ELEMENT NAME="seconds to shutdown" DATATYPE="uint32">
                    <DESCRIPTION>The number of seconds before the system is shutdown.</DESCRIPTION>
                </DYNAMIC_ELEMENT>
                <STATIC_ELEMENT> seconds. </STATIC_ELEMENT>
            </MESSAGE_COMPONENTS>
            <FIXED_MESSAGE_INSTANCE_VALUES TYPE="ALERT">
                <ALERTING_MANAGED_ELEMENT EXISTENCE_IS="required">
                    <DESCRIPTION> The object name must reference the top-most computer system
                        that is shutting down. If the computer system is cluster, then the cluster
                        computer system must be referenced. </DESCRIPTION>
                </ALERTING_MANAGED_ELEMENT>
                <ALERT_TYPE> 5 <DESCRIPTION>Device Alert</DESCRIPTION>
                </ALERT_TYPE>
                <PERCEIVED_SEVERITY> 4 <DESCRIPTION>High</DESCRIPTION>
                </PERCEIVED_SEVERITY>
            </FIXED_MESSAGE_INSTANCE_VALUES>
        </MESSAGE>
        <!-- An example of using two different message type declarations -->
        <MESSAGE NAME="Component overheat">
            <MESSAGE_ID PREFIX="WIP" SEQUENCE_NUMBER="0043"/>
            <MESSAGE_COMPONENTS>
                <STATIC_ELEMENT>A component has overheated. </STATIC_ELEMENT>
                <DYNAMIC_ELEMENT NAME="Component Type" DATATYPE="string">
                    <POSSIBLE_VALUE>The entire device is affected. Device wide failure has already
                        or can be expected shortly. </POSSIBLE_VALUE>
                    <POSSIBLE_VALUE>Only a single component is affected. Corrective action may be
                        taken. </POSSIBLE_VALUE>
                </DYNAMIC_ELEMENT>
                <STATIC_ELEMENT> The OperationalStatus reported is: </STATIC_ELEMENT>
                <DYNAMIC_ELEMENT NAME="OperationalStatus" DATATYPE="string" IS_ARRAY="true"/>
            </MESSAGE_COMPONENTS>
            <FIXED_MESSAGE_INSTANCE_VALUES TYPE="ALERT">
                <ALERTING_MANAGED_ELEMENT EXISTENCE_IS="required">
                    <DESCRIPTION> The object name must reference the physical element most affected
                        by the over temperature message. </DESCRIPTION>
                </ALERTING_MANAGED_ELEMENT>
                <ALERT_TYPE> 6 <DESCRIPTION>Environmental Alert</DESCRIPTION>
                </ALERT_TYPE>
                <PERCEIVED_SEVERITY> 4 <DESCRIPTION>High</DESCRIPTION>
                </PERCEIVED_SEVERITY>
            </FIXED_MESSAGE_INSTANCE_VALUES>
            <FIXED_MESSAGE_INSTANCE_VALUES TYPE="ERROR">
                <CIMSTATUSCODE> 1 <DESCRIPTION>CIM_ERR_FAILED</DESCRIPTION>
                </CIMSTATUSCODE>
                <ERROR_TYPE> 6 <DESCRIPTION>Environment Error</DESCRIPTION>
                </ERROR_TYPE>
                <ERROR_SOURCE EXISTENCE_IS="required">
                    <DESCRIPTION> The object name must reference the physical element most affected
                        by the over temperature message. </DESCRIPTION>
                </ERROR_SOURCE>
                <PERCEIVED_SEVERITY> 4 <DESCRIPTION>High</DESCRIPTION>
                </PERCEIVED_SEVERITY>
            </FIXED_MESSAGE_INSTANCE_VALUES>
        </MESSAGE>
        <!-- An example using no message type declarations -->
        <MESSAGE NAME="WBEM Management Interface is not available">
            <MESSAGE_ID PREFIX="WIP" SEQUENCE_NUMBER="0044"/>
            <MESSAGE_COMPONENTS>
                <STATIC_ELEMENT>The management interface for the device is not available.</STATIC_ELEMENT>
            </MESSAGE_COMPONENTS>
            <!-- However, it seems that we should return a reference to the management interface in question
                so that a client may try to restart it.
            -->
        </MESSAGE>
    </REGISTRY_ENTRIES>
</REGISTRY>
