Information for Work-in-Progress version: IMPORTANT: This document is not a standard. It does not necessarily reflect the views of DMTF or its members. Because this document is a Work in Progress, this document may still change, perhaps profoundly and without notice. This document is available for public review and comment until superseded. Provide any comments through the DMTF Feedback Portal: https://www.dmtf.org/standards/feedback DMTF Template

Version: 1.3.0

Document Identifier: DSP1000

Date: 2024-08-08

Version History: https://www.dmtf.org/dsp/DSP1000

Supersedes: 1.3.0

Document Class: <Policy | Normative | Informative>

Document Status: <Draft | Work in Progress | Published>

Document Language: en-US

Copyright Notice

Copyright © <yyyy> 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, 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 products, protocols, or testing procedures. DMTF shall have no liability to any party implementing such standards, 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 DMTF that, in their opinion, such patents may relate to or impact implementations of DMTF standards, visit https://www.dmtf.org/about/policies/disclosures.

This document’s normative language is English. Translation into other languages is permitted.

CONTENTS

Instructions — Delete Before Publication	6

1.	How to use this template (general instructions)	6

1.1	General	6

1.2	Storing the template (.dotx) file	6

1.3	Ensuring that your document uses the template	6

1.4	Using the optional macros template	6

1.4.1	Why use the optional macros template	6

1.4.2	How to apply the optional macros template as a global template	7

1.5	Attaching the DSP1000_m.n.u.dotx template to an existing document	7

1.6	Using the organizer to copy the template styles to your document	8

1.7	Using the variables defined in the template	8

1.8	Updating properties and fields in a document	10

1.8.1	To update the value for a single field	10

1.8.2	To update all of a document’s properties and fields	10

1.9	Using bookmarks and hyperlinks for references to other documents	11

1.9.1	To add a bookmark	11

1.9.2	To add a hyperlink	11

1.9.3	Conventions for bookmarks	11

2.	Using this template to create a DMTF profile	12

3.	Using this template to create a DMTF specification	12

4.	Using this template to create a DMTF white paper	13

5.	Guideline for using capital letters in headings and figure and table titles	14

6.	Document footers	14

7.	Helpful Hints for Figures and Tables	14

7.1	Figures	14

7.2	Tables	14

8.	Template support	15

Abstract	16

Foreword	17

Acknowledgments	17

Introduction	18

Document conventions	18

1	Scope	20

2	Normative references	20

3	Terms and definitions	21

4	Symbols and abbreviated terms	21

5	Synopsis	22

5.1	Profile attributes	22

5.2	Summary	22

5.3	Related profiles	22

5.4	Referenced registries	22

5.5	Features	22

5.6	Adaptations	23

5.7	Use cases	23

6	Description	23

7	Implementation	24

7.1	General	24

7.2	Features	24

7.2.1	Feature: <Feature name>	24

7.2.2	Feature: <Feature name>	24

7.3	Adaptations	24

7.3.1	General requirements	24

7.3.2	<Adaptation name>	24

7.3.3	Subclause Level 2 w/ TOC Entry	26

8	Use cases	26

8.1	<Use case name 1>	26

8.1.1	Preconditions	26

8.1.2	Flow of activities	26

8.1.3	Postconditions	26

ANNEX A (normative) <insert annex title here>	27

A.1	Annex Level 2 (w/TOC entry)	27

A.1.1	Annex Level 3 (w/TOC entry)	27

A.2	Annex Level 2 (w/TOC entry)	27

A.2.1	Annex Level 3 (w/TOC entry)	27

ANNEX B (normative) Document version numbering scheme	28

B.1	Normative, Informational and Draft versioning	28

B.2	Work in Progress versioning	28

ANNEX C (informative) Change log	30

Figures

Figure 1 - <Profile Name Here>: Class adaptation diagram	23

Figure 2 – <Figure Title Here>	27

Tables

Table 1 – Related profiles	22

Table 2 – Referenced message registries	22

Table 3 – Features	22

Table 4 – Adaptations	23

Table 5 – Use cases	23

Table 6 – <Adaptation name>: Element requirements	24

Table 7 – <method name>: Error reporting requirements	25

Table 8 – <operation name>: Error reporting requirements	25

Table 9 – <Table Title Here>	27

Table 10 – Work in Progress version numbers	28

Instructions — Delete Before Publication

1.	How to use this template (general instructions)

1.1	General

Use this template for DMTF profiles based on the Management Profile Specification User Guide1.1 (DSP1001), specifications, or white papers. These instructions explain how to use the template in Word 2007. Subsequent clauses explain how to modify the template for a profile, specification, or white paper.

1.2	Storing the template (.dotx) file

You must store this .dotx file in a certain folder to ensure that it is available through Word when you want to create a new document.

To determine where to store template files, follow these steps:

Click the Office button (upper left), and click the Word Options button.

In the left pane, click Advanced.

At the bottom of the dialog, click File Locations.

Select “User templates” to see the path where Word stores and looks for templates.

This is the path where you should store the .dotx file. If you store the file in this directory, the next time you start Word and click the Office button New and select Templates…my templates in the left pane, you can select this template to start a new document.

1.3	Ensuring that your document uses the template

To use the functionality provided by the template, use one of the following approaches:

Start the new document by using the template (as described in 1.2 in these instructions).

Attach the template file to a document (.doc) file. For instructions about how to attach the template and ensure that your document includes the styles used in the newly attached template, see 1.5 and 1.6 below.

1.4	Using the optional macros template

This subclause explains why and how to use the optional macros template.

1.4.1	Why use the optional macros template

A separate template (DSP1000macros_m.n.u.dotm)that provides macros is available to use with this template. This optional macros template provides the following functionality:

A streamlined method for inserting numbered captions for figures, tables, and equations

A button to toggle line numbering on or off

For styles such as Notes and Examples, the macros fill in the label (for example, NOTE or EXAMPLE) and provide automatic numbering for numbered notes or examples.

If automatic numbering is not working properly for your document, you can use one of the macros provided to reset heading and list numbering. (Click Misc. Commands Reset Heading/List Numbering.)

1.4.2	How to apply the optional macros template as a global template

You can take advantage of the macros by applying the macros template (DSP1000macros_m.n.u.dotm) as a “global template” on top of this template (DSP1000_m.n.u.dotx); with this method, macros are not applied as a document template.

Macros from a document template are not copied into the new document to which the macros template is attached. However, when the macros template is applied as a global template, these macros become available.

After applying the macros template as a global template, enabling or disabling the macros for a document is as easy as turning the check mark on or off in the templates dialog. Having that checkmark turned off avoids prompts when opening and closing a document.

Selecting and enabling a global template affects any document currently open in Microsoft Word. Make sure to disable the DSP1000macros_m.n.u.dotm template before closing the document or closing Microsoft Word, or the macros template will affect any new document you start or open.

1.4.2.1	Enable the DSP1000macros_m.n.u.dotm global template

To use the macros, you must enable the macros template. Follow these steps:

Click the Office button (upper left), and then click the Word Options button.

In the left pane, click Add-Ins.

In the Manage pull-down menu at the bottom, select Templates and click Go...

Click Add …

Navigate to where the DSP1000macros_m.n.u.dotm template file is stored.

Select DSP1000macros_m.n.u.dotm, and click OK.

On the Templates and Add-ins dialog, click OK.

1.4.2.2	Disable the DSP1000macros_m.n.u.dotm global template

To disable the macros template, follow these steps:

Click the Office button (upper left), and then click the Word Options button.

In the left pane, click Add-Ins.

In the Manage pull-down menu at the bottom, select Templates and click Go...

Uncheck the checkbox for DSP1000macros_m.n.u.dotm, and click OK.

1.5	Attaching the DSP1000_m.n.u.dotx template to an existing document

Click the Office button (upper left), and then click the Word Options button.

In the left pane, click Add-Ins.

In the Manage pull-down menu at the bottom, select Templates and click Go...

Click the Attach button.

Select the appropriate .dotx file that you want to attach. (If you stored the .dotx file in the proper destination folder as described in 1.2 in these instructions, it should be listed among your template files and you won't have to browse for it.) Make sure the “Automatically update document styles” box is not checked.

Click OK.

1.6	Using the organizer to copy the template styles to your document

Click the Office button (upper left), and then click the Word Options button.

In the left pane, click Add-Ins.

In the Manage pull-down menu at the bottom, select Templates and click Go...

Click the Organizer button in the lower left corner of the dialog.

On the right side of the Organizer dialog box click Close File; this button label changes to Open File.

Click the Open File button.

Traverse to the correct directory and select the DMTF template. Click Open.

In the list of styles in the window on the right side (under the DMTF template name), click on the “code” style (a few styles down from the top) and use the scroll bar to scroll down to the end of the list of styles. Hold down the shift key and click on “zzSTDTitle”. Click on the << Copy button. Select the “Yes to All” button when asked to overwrite existing styles.

Click Close.

1.7	Using the variables defined in the template

The template uses a number of fields associated with the document’s properties to populate elements in the title page, headers, footers, and other places in a document.

You can change the values for any of these fields by modifying the document’s properties. To change the value for a particular field, follow these steps:

Click the Office button (upper left), and then select Prepare → Properties.

Click the down arrow next to Document Properties and select Advanced Properties.

Click the Custom tab.

Click the name of the field in the Properties list in the bottom half of the dialog, and then modify the string in the Value field.

Click Modify to save the change.

Repeat steps 4 and 5 for each property whose value you want to change.

When you have finished modifying properties, click OK.

If you change a value for a field, the change will be propagated the next time you update the document. For details on updating the fields in a document, see 1.8 below.

All of the custom properties are listed in the following table:

Custom Property (Variable) Name	Description	Used In
DocTitle	Document title, which will be displayed on the title page and in the page headers	All documents
DocNumber	Document number, which will be displayed on the title page and in the page headers	All documents
DocVersion	Published version of the document, which will be displayed on the title page and in the page footers. See DSP4014 for guidelines about version numbers, including the conventions for specifying draft level with letters.	All documents
DocClass	The document class determines which approval process is used. Valid values are as follows: Informative Normative Policy	All documents
DocStatus	This is the document status, which will be displayed on the title page in the Document Status line and in the center of all subsequent page footers (directly after the DocConfidentiality variable). The DocStatus values are as follows: Work in Progress Draft Published See DSP4014 for the complete list of values for this property.	All documents
DocLanguage	This property is the document language. For DMTF documents, the value for this property shall be “en-US” for U.S. English. (This value is a combination of language code as defined in ISO 639-1/2/3 and country code as defined in ISO 3166-1/2/3.)	All documents
DocConfidentiality	This property is displayed in the center of all page footers and directly follows the DocStatus property. During document development and the DMTF approval process, the value of this variable should be “DMTF Confidential". After a document is released (including Work in Progress documents released for public review), the value of this variable should be an empty string.	All documents
DocCompTitle	This is the optional document complementary title. For document titles that have two parts, this is the second part of the title.	Specifications or white papers, if needed
DocOwningWG	This is the DMTF working group or editing body that has authored the document. Include the full name of the working group or editing body in the value for this property; do not abbreviate the name.	All documents
DocRegisteredName	This is the profile’s RegisteredName value.	Profiles only
DocWorkGroupVersion	This is the optional Working Group version number, which some WGs use to keep track of their internal version number during document development. If included, the value for this variable is displayed under the Version number on the title page. (This line must be deleted from the title page before a specification is published (including as a Work in Progress), or sent to member review (as a Draft).	All documents
SupersedesVersion	Insert the version number or numbers that the current document supersedes. This value appears in the Supersedes line on the title page and can contain zero (None) or more values.	All documents
DocAlias	An optional short title for use in page headers. For example, if a DocTitle is “Platform Level Data Model (PLDM) for File Transfer Specification”, the DocAlias might be “PLDM for File Transfer Specification” without expanding the abbreviation.	All documents

1.8	Updating properties and fields in a document

You can update either a single value or all of the values for a document’s properties or fields.

1.8.1	To update the value for a single field

To update the value for a single field (for example, the version number in a page footer), follow these steps:

Select the text that you want to update.

Right click and select Update Field.

1.8.2	To update all of a document’s properties and fields

To update all of a document’s properties and fields (as well as the Table of Contents, Figures list, and Tables list), follow these steps:

Open the document.

Either press Ctrl-A or click three times in the left margin to highlight all of the text in the document.

Right click anywhere within the highlighted text and select Update Field.

Various windows are displayed that allow you to update either just the page numbers or both the page numbers and text in the various generated lists that are included in your document (Table of Contents, Figures list, and Tables list). To update these lists:

In the Update Table of Contents window that is displayed, select the Update entire table option.

In the Update Table of Figures window, select the Update entire table option.

In the Update Table of Tables window, select the Update entire table option.

Look for broken references by searching for “Error!” and correct them as needed.

1.9	Using bookmarks and hyperlinks for references to other documents

Within the body of a profile or specification, all references to other documents should be hyperlinked back to the list of references in Clause 2 (“Normative References”) or to the Bibliography rather than to the actual source document on the Web. Each document in the reference list or Bibliography contains a URL with a hyperlink to the source document on the Web. The URL for each reference should be visible in each reference (for example, https://www.dmtf.org/standards/published_documents/DSP1033_1.0.pdf). Links to actual documents (through URLs) should appear only in the list of references or the Bibliography. With this approach, updates to referenced documents’ version, date, or URL need to be made in only one place.

To facilitate this approach, insert a bookmark for each document in the list of references. You can then add a hyperlink back to this bookmark from each reference in the body of the document. The following subclauses provide instructions for how to create bookmarks and hyperlinks, as well as conventions for bookmark names.

1.9.1	To add a bookmark

To add a bookmark, highlight the text (such as a document title) that you want to link to. Go to Insert → Bookmark. Provide a bookmark name according to the conventions described in 1.9.3 in these instructions.

1.9.2	To add a hyperlink

Hyperlinks can link either to a point within the document or to a document on the Web.

To add a hyperlink that references a point within the document (such as a document title within the list of normative references or in the Bibliography):

Highlight the document name or number where you want to insert a hyperlink.

Go to Insert → Hyperlink, and from the Link to: list on the left, select Place in This Document.

In the window, scroll to the bottom for the list of bookmarks that you can link to and select the appropriate bookmark.

To add a hyperlink that points to a document on the Web:

Highlight the document name or number for which you want to insert a link.

Go to Insert → Hyperlink, and from the Link to: list on the left, select Existing File or Web Page.

In the Address field near the bottom of the dialog, type or paste the destination URL for the document or Web site.

1.9.3	Conventions for bookmarks

Adhering to bookmark naming conventions facilitates copying/pasting of bookmark references from one document to another if the respective bookmark definition is already in the target document.

When creating bookmarks, use the following conventions for the bookmark name:

Use “Ref_DMTF_DSPxxxx” for DMTF specifications.

Use “Ref_<ORG>_xxxx” for non-DMTF specifications.

Use “Term_<termword1>”, “Term_<termword2>”, etc. for terms and for symbols and abbreviated terms.

NOTE	Do not include versions or dates in bookmark names.

2.	Using this template to create a DMTF profile

This template is optimized for profile development using the Management Profile Specification User Guide DSP1001 1.1. To create a profile using this template, refer to DSP1001 ver 1.1 and follow these steps:

Fill in the variables (custom properties) as described in 1.7 in these instructions. Fill in the document title for the DocTitle field, and fill in values for all other fields that are not optional.

Delete the “Abstract” clause because it is used only for white papers.

Add or delete information in the “Foreword” and “Acknowledgments” sections as necessary.

Add or delete text in the “Introduction”.

Fill in text for the “Scope”.

In Clause 2, “Normative References”, insert any additional references that are needed, using the format of the references already included.

In Clause 3, add terms and definitions for your document.

In Clause 4, add any abbreviated terms and their spelled-out versions.

Fill in Clauses 5–10 according to DSP1001. Note that the fields in the beginning of Clause 5 will be filled in with the values you entered for the custom properties.

Use the Annex placeholder if you have material for one or more Annexes. In each Annex title, indicate whether the annex is Informative or Normative.

Fill in the Change Log to capture progress. The Change Log should include only one row for each published release. The Change Log should be the last Annex before the Bibliography.

Fill in any entries for the Bibliography. If you have no documents to include in the Bibliography, delete it. The Bibliography is not an annex and should not be labeled as an annex.

Delete the “Instructions” section (all of this green text).

If your document is not a Work in Progress, delete the Work in Progress box (visible in the Print Layout view) from the title page.

Update all fields in the document as described in 1.8.2 in these instructions.

3.	Using this template to create a DMTF specification

Only the first few clauses (through Clause 4) and the Annexes/Bibliography of this template are relevant if you're creating a DMTF specification. To create a specification using this template, follow these steps:

Fill in the variables (custom properties) as described in 1.7 in these instructions. Fill in the document title for the DocTitle field, and fill in values for all other fields that are not optional.

Delete the “Abstract” section because it is used only for white papers.

Add or delete information in the “Foreword” and “Acknowledgments” sections as necessary.

Add or delete text in the “Introduction”.

Fill in text for the “Scope”.

In Clause 2 “Normative References”, delete any references that don’t apply. (The boilerplate list of references applies to DMTF management profiles, so some of these references might not be appropriate for your specification. Retain the reference to the ISO Directives because it applies to all DMTF documents.) Insert any additional references that are needed, using the format of the references already included.

In Clause 3, add terms and definitions for your document.

In Clause 4, add any abbreviated terms.

Delete Clauses 5–10, because they contain boilerplate text that is specific to profiles (based on DSP1001 1.1).

Use the Annex placeholder if you have material for one or more Annexes. In each Annex title, indicate whether it is Informative or Normative.

Fill in the Change Log to capture progress. The Change Log should include only one row for each published release. The Change Log should be the last Annex before the Bibliography.

Fill in any entries for the Bibliography. If you have no documents to include in the Bibliography, delete it. The Bibliography is not an annex and should not be labeled as an annex.

Delete the “Instructions” section (all of this green text).

If your document is not a Work in Progress, delete the Work in Progress box (visible in the Print Layout view) from the title page.

Update all fields in the document as described in section 1.8.2 in these instructions.

4.	Using this template to create a DMTF white paper

Only the first few sections (through Clause2) and the Annexes/Bibliography of this template are relevant if you're creating a DMTF white paper. To create a white paper using this template, follow these steps:

Fill in the variables (custom properties) as described in 1.7 in these instructions. Fill in the document title for the DocTitle field, and fill in values for all other fields that are not optional.

In the “Abstract” section, briefly describe the purpose and the intended audience for the white paper.

Add or delete information in the “Foreword” and “Acknowledgments” sections as necessary.

Review the “Introduction” section, and delete any sections that aren’t relevant. If you use any document conventions, list them here. If you don’t use conventions, delete the “Document conventions” section.

Change the “Scope” heading to “Executive Summary”, and add summary information in this section. The Executive Summary should be no longer than one page.

Delete Clause 2 “Normative References”.

In Clause 2 (“Terms and definitions”), add terms and definitions for your document .Each term is a numbered subclause that is created by using the Term – Ref Num style (followed by the Term – Name and Term – Definition styles).

NOTE	You must adjust the numbering of the first term so that the first part of the term heading number matches the number of the preceding clause. By default, the list of terms starts with 3.1 because the “Terms and definitions” clause is typically Clause 3. If your “Terms and definitions” clause is Clause 2, there will be a mismatch. To adjust this, right click in the first “numbered” paragraph under the “Terms and definitions” heading. Select “Numbering” and then select “Define New Number Format” from the list that pops up; change the first part of the number (3) to match the number of the preceding main clause (probably 2). Click OK. The first number of the term number should now match the preceding clause number.

In Clause 3 (“Symbols and abbreviated terms”), add acronyms or other abbreviations used in your document. Each abbreviation is a numbered subclause created by using the Term – Ref Num style (followed by the Term – Name and Term – Definition styles). Delete Clause 3 if you don't have any symbols or abbreviated terms. (See NOTE above for a tip about numbering.)

Delete Clauses 4–10 because they contain boilerplate text that is specific to profiles (based on DSP1001 1.1).

Add new clause headings and clauses as necessary.

Use the Annex placeholder if you have material for one or more Annexes. In each Annex title, indicate whether it is Informative or Normative. Otherwise, delete the annex placeholder.

Fill in the Change Log to capture progress. The Change Log should include only one row for each published release. The Change Log should be the last Annex before the Bibliography.

Fill in any entries for the Bibliography. If you have no documents to include in the Bibliography, delete it. The Bibliography is not an annex and should not be labeled as an annex.

Delete the “Instructions” section (all of this green text).

If your document is not a Work in Progress, delete the Work in Progress box (visible in the Print Layout view) from the title page.

Update all fields in the document as described in 1.8.2 in these instructions.

5.	Guideline for using capital letters in headings and figure and table titles

The Technical Committee recommends using sentence-style capitalization in headings, figure titles, and table titles. In other words, only the first letter of the heading or title should be a capital letter (except for class names and other words that use a capital letter regardless of the context).

6.	Document footers

A document’s status dictates the text that should be included in a document’s page footers, as follows:

Document status	Required text in footer
Draft	DMTF Confidential Draft
Work in Progress (published)	Work in Progress
Published (such as DMTF Standard)	Published

7.	Helpful Hints for Figures and Tables

7.1	Figures

Sometimes inserting .jpg files into a Word document yields fuzzy figures. For class diagrams and other figures, use this procedure so that your figures have higher resolution:

Select and copy the diagram from the .vsd file so that it’s on the clipboard.

In Word, with your cursor at the diagram insertion point, on the Home menu select the down arrow under Paste and select Paste Special.

Select Picture (Windows Metafile) or Picture (Enhanced Metafile), and then click OK.

Look at the inserted figure to be sure that it’s OK.

NOTE	Use Enhanced Metafile if the .vsd image contains any special symbol-type characters. It takes more storage for enhanced metafiles, so that’s the drawback of using it. It doesn't hurt to specify the Enhanced Metafile format if you're not sure if the art, such as a class diagram, includes special characters.

7.2	Tables

This template contains a default table style called DMTF Table. It has the proper line weights and width pre-defined for typical DMTF tables. Sometimes, during the course of adding and deleting rows, the table formatting gets messed up. To automatically format a table using the DMTF Table table style, follow this procedure:

Select the table that you want to format. (This activates a new menu.)

Under Table Tools, click the Design tab.

In the Table Styles group, click the More button (down arrow with a line over it) and you will see a lot of tables. Scroll to the top of these tables and you will see a Custom label with one table under it. This is the DMTF Table style, though it’s not obviously labeled as such.

Click this table style to apply it to the table.

In the Table Style Options group to the left of the Table Styles group, check all six checkboxes.

NOTE	The text in the table column headings should be bold. Although the DMTF Table style specifies bold text in headings, it doesn’t always work. You might have to highlight the table heading row and click the bold icon.

8.	Template support

If you have questions about how to use this template or requests for updates, send an email to DMTF.Support@brightleafgroup.com.

Abstract

<Provide a short statement (one paragraph) about what the white paper describes.>

<Provide a short statement (one paragraph) about the intended target audience of the white paper.>

Foreword

The DMTF Template (DSP1000) was prepared by the <DMTF Editing Body>.

DMTF is a not-for-profit association of industry members dedicated to promoting enterprise and systems management and interoperability. For information about DMTF, see https://www.dmtf.org.

<Choose one of the following statements and delete the other.>

This version is the first version of this document. Future changes will be recorded in the change log in ANNEX C.

This version supersedes version 1.3.0a. For a list of changes, see the change log in ANNEX C.

Acknowledgments

DMTF acknowledges the following individuals for their contributions to this document:

<first name and last name> – <company name>

<first name and last name> – <company name>

<first name and last name> – <company name>

etc.

<List the editor or editors for the current release first, followed by each contributor’s name and company arranged in alphabetical order by contributors’ last names.>

Introduction

The information in this specification should be sufficient for a provider or consumer of this data to unambiguously identify the classes, properties, methods, and values that shall be instantiated to subscribe, advertise, produce, or consume an indication using the DMTF Common Information Model (CIM) Schema.

The target audience for this specification is implementers who are writing CIM-based providers or consumers of management interfaces that represent the components described in this document.

Document conventions

ABNF usage conventions

Format definitions in this document are specified using ABNF (see RFC5234), with the following deviations:

Literal strings shall be interpreted as case-sensitive Unicode characters, as opposed to the definition in RFC5234 that interprets literal strings as case-insensitive US-ASCII characters.

Typographical conventions

The following typographical conventions are used in this document:

Document titles are marked in italics.

ABNF rules are in monospaced font.

Deprecated material

Deprecated material is not recommended for use in new development efforts. Existing and new implementations may use this material, but they shall move to the favored approach as soon as possible. CIM service shall implement any deprecated elements as required by this document in order to achieve backwards compatibility. Although CIM clients may use deprecated elements, they are directed to use the favored elements instead.

Deprecated material should contain references to the last published version that included the deprecated material as normative material and to a description of the favored approach.

The following typographical convention indicates deprecated material:

DEPRECATED

Deprecated material appears here.

DEPRECATED

In places where this typographical convention cannot be used (for example, tables or figures), the “DEPRECATED” label is used alone.

Experimental material

Experimental material has yet to receive sufficient review to satisfy the adoption requirements set forth by DMTF. Experimental material is included in this document as an aid to implementers who are interested in likely future developments. Experimental material may change as implementation experience is gained. It is likely that experimental material will be included in an upcoming revision of the document. Until that time, experimental material is purely informational.

The following typographical convention indicates experimental material:

EXPERIMENTAL

Experimental material appears here.

EXPERIMENTAL

In places where this typographical convention cannot be used (for example, tables or figures), the “EXPERIMENTAL” label is used alone.

DMTF Template

Scope

<Provide a short statement (one sentence) about what the specification or white paper describes.>

Normative references

The following referenced documents are indispensable for the application of this document. For dated or versioned references, only the edition cited (including any corrigenda or DMTF update versions) applies. For references without a date or version, the latest published edition of the referenced document (including any corrigenda or DMTF update versions) applies.

<DMTF specifications are available at https://www.dmtf.org/standards/published_documents. Unless otherwise specified, values defined in this document apply to all published DMTF Standard versions compliant with this or a later version of DSP1000 in the referenced DMTF specification.>

DMTF DSP0004, CIM Infrastructure Specification 3.0,
https://www.dmtf.org/sites/default/files/standards/documents/DSP0004_3.0.pdf

DMTF DSP0215, Server Management Managed Element Addressing Specification 1.0,
https://www.dmtf.org/sites/default/files/standards/documents/DSP0215_1.0.pdf

DMTF DSP0223, Generic Operations 1.0,
https://www.dmtf.org/sites/default/files/standards/documents/DSP0223_1.0.pdf

DMTF DSP0228, Message Registry XML Schema 1.0,
https://schemas.dmtf.org/wbem/messageregistry/1/dsp0228_1.0.xsd

DMTF DSP1001, Management Profile Specification Usage Guide 1.1,
https://www.dmtf.org/sites/default/files/standards/documents/DSP1001_1.1.pdf

DMTF DSP1033, Profile Registration Profile 1.0,
https://www.dmtf.org/sites/default/files/standards/documents/DSP1033_1.1.pdf

DMTF DSP1053, Base Metrics Profile 1.0,
https://www.dmtf.org/sites/default/files/standards/documents/DSP1053_1.0.pdf

DMTF DSP1054, Indications Profile 1.2,
https://www.dmtf.org/sites/default/files/standards/documents/DSP1054_1.2.pdf

DMTF DSP8016, WBEM Operations Message Registry 1.0,
https://schemas.dmtf.org/wbem/messageregistry/1/dsp8016_1.0.xml

DMTF DSP8020, Metric Registry XML Schema Specification 1.0,
https://schemas.dmtf.org/wbem/metricregistry/1/dsp8020_1.0.xsd

IETF RFC5234, ABNF: Augmented BNF for Syntax Specifications, January 2008,
https://datatracker.ietf.org/doc/html/rfc5234

ISO/IEC Directives, Part 2, Principles and rules for the structure and drafting of ISO and IEC documents,
https://www.iso.org/sites/directives/current/part2/index.xhtml

The Open Group, “Regular Expressions” in The Single UNIX® Specification, Version 2,
https://pubs.opengroup.org/onlinepubs/7908799/xbd/re.html

Terms and definitions

In this document, some terms have a specific meaning beyond the normal English meaning. Those terms are defined in this clause.

The terms “shall” (“required”), “shall not”, “should” (“recommended”), “should not” (“not recommended”), “may”, “need not” (“not required”), “can” and “cannot” in this document are to be interpreted as described in ISO/IEC Directives, Part 2, Clause 7. The terms in parentheses are alternatives for the preceding term, for use in exceptional cases when the preceding term cannot be used for linguistic reasons. Note that ISO/IEC Directives, Part 2, Clause 7 specifies additional alternatives. Occurrences of such additional alternatives shall be interpreted in their normal English meaning.

The terms “clause”, “subclause”, “paragraph”, and “annex” in this document are to be interpreted as described in ISO/IEC Directives, Part 2, Clause 6.

The terms “normative” and “informative” in this document are to be interpreted as described in ISO/IEC Directives, Part 2, Clause 3. In this document, clauses, subclauses, or annexes labeled “(informative)” do not contain normative content. Notes and examples are always informative elements.

The terms defined in DSP0004, DSP0223, and DSP1001 apply to this document. The following additional terms are used in this document.

<term>

<term definition>

conditional

indicates that an item is required under specified conditions

mandatory

indicates that an item is required under all conditions

optional

indicates that an item is not mandatory or conditional

Symbols and abbreviated terms

The abbreviations defined in DSP0004, DSP0223, and DSP1001 apply to this document. The following additional abbreviations are used in this document.

<abbrev. term>

<abbrev. term definition>

Synopsis

Profile attributes

Profile name: <RegisteredProfileName>

Version: 1.0.0

Organization: DMTF

Profile type:

Schema version:

Central class adaptation:

Scoping class adaptation:

Scoping algorithm:

Summary

Related profiles

Table 1 lists profiles that are related to this profile.

Table 1 – Related profiles

Profile reference name	Profile name	Organization	Version	Relationship	Description
<profile reference>	<reg.name of referenced profile>	<reg.org>	<reg.version.m.n>	<requirement>

Referenced registries

Table 2 lists the message registries referenced in this profile.

Table 2 – Referenced message registries

Registry reference name	Registry identifier	Organization	Version	Description
<reg.version.m.n>

Features

Table 3 lists the features defined in this profile.

Table 3 – Features

Feature name	Granularity	Requirement	Description

Adaptations

Table 4 lists the class adaptations that are defined in this profile.

Table 4 – Adaptations

Adaptation	Elements	Requirement	Description
Classes
Indications

Use cases

Table 5 lists the use cases defined in this profile.

Table 5 – Use cases

Use case name	Description

Description

Figure 1 - <Profile Name Here>: Class adaptation diagram

Implementation

General

Features

Feature: <Feature name>

Feature description

Feature discovery

Feature: <Feature name>

Feature description

Feature discovery

Adaptations

General requirements

<Adaptation name>

General

Implementation requirements

Table 6 lists the element requirements of the <Adaptation name> adaptation.

Table 6 – <Adaptation name>: Element requirements

Element	Requirement	Description
Base elements
Properties
Methods
Operations

Property: <property name>

Property: <property name>

Method: <method name>

Table 7 specifies the error reporting requirements for the <method name> method.

Table 7 – <method name>: Error reporting requirements

Error reporting mechanism	Description

Operation: <operation name>

Table 8 specifies the error reporting requirements for the <operation name> operation.

Table 8 – <operation name>: Error reporting requirements

Error reporting mechanism	Description

Subclause Level 2 w/ TOC Entry

Subclause Level 3 w/ TOC Entry

Subclause Level 4 w/ TOC Entry

Subclause Level 5 w/ TOC Entry

Use cases

<Use case name 1>

Preconditions

Flow of activities

Postconditions

Success

Failure

(normative)
<insert annex title here>

Annex Level 2 (w/TOC entry)

Table 9 – <Table Title Here>

Annex Level 3 (w/TOC entry)

Annex Level 2 (w/TOC entry)

Annex Level 3 (w/TOC entry)

Figure 2 – <Figure Title Here>

(normative)
Document version numbering scheme

Normative, Informational and Draft versioning

Versioning of DMTF documents takes the form m.n.u[d[d]], where:

m	represents the major version identifier in numeric form. This number starts at 1 for new documents. A change in this number representing an update to the document indicates that the document contains changes that are not compatible with prior versions.

n	represents the minor version identifier in numeric form. This number starts at 0 for new documents. A change in this number representing an update to the document indicates that the document contains changes that are compatible with prior versions.

u	represents the update (errata or coordination changes) in numeric form. This number starts at 0 for new documents. A change in this number representing an update to the document indicates that the document contains changes that are corrections to errors in prior versions or changes in coordination with other documents. This digit may not be changed for Work in Progress documents.

dd	represents the draft level in alphabetic form. This indicator is required for DMTF draft documents.

Updated versions of documents must have one of these digits or letters changed from prior versions in increasing order; gaps in the order are permitted.

Published documents are represented using only numeric entries (for example, 2.1.0 or 2.2.1).

All DMTF document in draft status must have the draft level identified. Any references to the specification version must include the alpha identifier (dd) appended to the identifying version number. Drafts are denoted starting with a single alpha character and, if necessary, progressing to two-letter notation: a, b, c … x, y, z, aa, ab…zz.

Work in Progress versioning

Versioning of DMTF Work in Progress documents shall adhere to the format defined in the following table:

Table 10 – Work in Progress version numbers

Published File Name	Description of Approximate Stage of Development
DSPXXXX_1.0.0WIP.01-29	First draft with outline and initial text
DSPXXXX_1.0.0WIP.30-49	Base features complete, major updates expected
DSPXXXX_1.0.0WIP.50-59	Most major additions complete, minor changes expected
DSPXXXX_1.0.0WIP.60-89	All major release features included, solicitation for feedback advertised
DSPXXXX_1.0.0WIP.90-98	All major release features complete, minor updates remaining
DSPXXXX_1.0.0WIP.99	Complete in final review and ready for standard or informational release
DSPXXXX_1.0.0WIP	Co-released when a completed document is currently in the approval process

WIP artifacts are released at the discretion of the editing body. The editing body shall determine the WIP version based on the approximate developmental stage of the WIP artifact. Editing bodies are not required to release WIP versions at each stage. The component pieces of a WIP.zip bundle shall reflect the WIP version of the bundle where possible.

(informative)
Change log

Version	Date	Description
<yyyy-mm-dd>	<Include one row for each published release and each member review release (that is: Work in Progress, Draft DMTF Standard, DMTF Standard). In this “Description” column, note the document’s status and provide a summary of the changes since the previous release. The first release should not include a change summary. The summary of changes should be understandable for external readers that have no access to DMTF internal material.>
1.2.2	2013-04-02	Various updates to custom styles (for example, hiding unused styles; removing font size from fixed font and hyperlink to make styles usable in other areas besides normal text; increasing space before/after table text)
1.2.3	2013-11-19	Replaced DMTF logo on cover page with new version created and approved by Marketing Committee.
1.2.4	2014-01-13	Styles: Re-established the “Clean All” entry in styles. Styles: Separated heading styles and annex styles, so the annexes are represented at the correct level in the document outline (Navigation Pane). More specifically, this was done by: Re-established list style “Headings”; Used it for any headings (including the pseudo annexes H7, H8, H9, for backwards compatibility); Created a new list style “Annexes”; Used that for three new Annex styles “Annex 1”, “Annex 2”, “Annex 3”; Updated the TOC options to get the new Annex levels 1 to 3 into the TOC. Styles: Made style “Table Text - Headings” hidden until used, because with DMTF tables, the heading row should have style “Table Text” for all rows, including the header row. Template doc: Replaced text-based figures with small images of the original text, in order to have real figures that have real captions. Template doc: Fixed table of figures and table of tables. Template doc: Changed example term and symbol definitions to use styles “Term - Name” and “Sym - Name”, instead of just line breaking the heading as before. Template doc: Removed “Conformance” heading in template text.
1.2.4a	2014-11-03	Renamed “Document Name” to “Document Identifier” on title page. Changed headers and footers as prescribed in DSP4014: moved DocStatus from footer to centered in the header lines, which left DocConfidentiality centered in all footers. On the title page, DocConfidentiality was added to the center of the footer (by itself, no version or page numbers in the title page footer). Added DocClass field code, added “Document Class” line on title page. Added “Superseded” line on title page. In the custom properties table in 1.7, added a line to describe new DocClass variable, and modified DocStatus and DocConfidentiality descriptions to match new footer and header designs. Modified clause 6, Footers: changed name to Headers, and reworded table contents to reflect changes in footer and header contents.
1.2.4b	2014-11-12	Changed headers and footers to move DocStatus back to footer appearing before DocConfidentiality and centered in all footers. Changed “Superseded” line to “Supersedes” on title page and added a property for version, versions, or None. In the custom properties table in 1.7, added a line to describe new DocClass variable, and modified DocStatus descriptions to match new values. Modified clause 6, Footers: changed name to Headers, and reworded table contents to reflect changes in footer and header contents.
1.2.5	2015-04-21	Removed Document Type field from cover page. Removed information about Document Type field from custom properties table on page 8. At request of Executive Committee, added the following line to page 2: This document’s normative language is English. Translation into other languages is permitted. Cleaned up some incorrect fields in footers. Made numbers for Heading 4 styles and Annex headings bold again.
1.2.6	2019-01-15	Updated references in clause 3, Terms and definitions, to reflect changes made in ISO/IEC Directives, Part 2, 8th edition. Updated ISO/IEC Directives, Part 2 document title in clause 2, Normative references, to reflect update in 8th edition. Provided field options for Document Class and Document Status on cover page. Updated copyright notice to replace Distributed Management Task Force (DMTF) with DMTF. Updated boilerplate reference in Bibliography to latest version of DSP4014.
1.2.7a	2021-02-18	Added a sentence to the Foreword to cover versioning and to add a cross-reference to the annex containing the change log. Added a paragraph to clause 3, Terms and definitions, to include the terms mandatory, optional, and conditional; added a reference to ISO online browsing platform.
1.2.7b	2021-02-24	Added a statement to Normative references that indicates references to DMTF documents are to the latest version unless otherwise specified and includes a link to all published documents, eliminating the need to include a link for each document.
1.3.0a	2021-03-31	Added conditional, mandatory, and optional to Terms and definitions clause. Updated version statement in Foreword to accommodate first versions.
1.3.0b	2024-08-08	On title page: align elements on left margin; relocate Version line to immediately below Title line Document the usage of the DocAlias custom property (variable) Delete “the” before “DMTF” where applicable, per the organization’s preferred nomenclature

Bibliography

DMTF DSP4014, DMTF Process for Working Bodies 2.6,
https://www.dmtf.org/sites/default/files/standards/documents/DSP4014_2.6.pdf

<owning org><doc number>, <doc title and version or date>,
<hyperlink>