1 2 Document Identifier: DSP0210 3 Date: 2015-03-06 4 Version: 2.0.0 5 CIM-RS Protocol 6 Supersedes: 1.0 7 Document Type: Specification 8 Document Class: Normative 9 Document Status: Published 10 Document Language: en-US 11 CIM-RS Protocol DSP0210 12 Copyright Notice 13 Copyright © 2013–2015 Distributed Management Task Force, Inc. (DMTF). All rights reserved. 14 DMTF is a not-for-profit association of industry members dedicated to promoting enterprise and systems 15 management and interoperability. Members and non-members may reproduce DMTF specifications and 16 documents, provided that correct attribution is given. As DMTF specifications may be revised from time to 17 time, the particular version and release date should always be noted. 18 Implementation of certain elements of this standard or proposed standard may be subject to third party 19 patent rights, including provisional patent rights (herein "patent rights"). DMTF makes no representations 20 to users of the standard as to the existence of such rights, and is not responsible to recognize, disclose, 21 or identify any or all such third party patent right, owners or claimants, nor for any incomplete or 22 inaccurate identification or disclosure of such rights, owners or claimants. DMTF shall have no liability to 23 any party, in any manner or circumstance, under any legal theory whatsoever, for failure to recognize, 24 disclose, or identify any such third party patent rights, or for such party’s reliance on the standard or 25 incorporation thereof in its product, protocols or testing procedures. DMTF shall have no liability to any 26 party implementing such standard, whether such implementation is foreseeable or not, nor to any patent 27 owner or claimant, and shall have no liability or responsibility for costs or losses incurred if a standard is 28 withdrawn or modified after publication, and shall be indemnified and held harmless by any party 29 implementing the standard from any and all claims of infringement by a patent owner for such 30 implementations. 31 For information about patents held by third-parties which have notified the DMTF that, in their opinion, 32 such patent may relate to or impact implementations of DMTF standards, visit 33 http://www.dmtf.org/about/policies/disclosures.php. 2 Published Version 2.0.0 DSP0210 CIM-RS Protocol 34 CONTENTS 35 Foreword ....................................................................................................................................................... 8 36 Acknowledgments ................................................................................................................................. 8 37 Introduction.................................................................................................................................................... 9 38 Document conventions .......................................................................................................................... 9 39 Typographical conventions ......................................................................................................... 9 40 ABNF usage conventions ........................................................................................................... 9 41 1 Scope .................................................................................................................................................. 10 42 2 Normative references .......................................................................................................................... 10 43 3 Terms and definitions .......................................................................................................................... 12 44 4 Symbols and abbreviated terms .......................................................................................................... 16 45 5 Concepts ............................................................................................................................................. 16 46 5.1 CIM-RS protocol participants .................................................................................................... 16 47 5.2 Model independence of CIM-RS ............................................................................................... 17 48 5.3 Mapping model elements to CIM-RS resources (informative) .................................................. 19 49 5.3.1 Classes ........................................................................................................................ 19 50 5.3.2 Instances ...................................................................................................................... 19 51 5.3.3 Properties ..................................................................................................................... 19 52 5.3.4 Methods and operations .............................................................................................. 19 53 5.4 Two-staged mapping approach ................................................................................................ 20 54 5.5 REST architectural style supported by CIM-RS ....................................................................... 21 55 6 Resource identifiers ............................................................................................................................. 22 56 6.1 CIM-RS resource identifier format ............................................................................................ 22 57 6.2 Non-opaqueness ....................................................................................................................... 23 58 6.3 Percent-encoding ...................................................................................................................... 23 59 6.4 Scheme component .................................................................................................................. 25 60 6.5 Authority component ................................................................................................................. 25 61 6.6 Query parameters ..................................................................................................................... 26 62 6.6.1 $associatedclass (associated class filter) .................................................................... 27 63 6.6.2 $associatedrole (associated role filter) ........................................................................ 28 64 6.6.3 $associationclass (association class filter) .................................................................. 29 65 6.6.4 $class (specify class name) ......................................................................................... 29 66 6.6.5 $continueonerror (continue on errors within paged retrieval) ...................................... 30 67 6.6.6 $filter (filter instances in result) .................................................................................... 30 68 6.6.7 $filterlanguage (specify filter language) ....................................................................... 32 69 6.6.8 $max (limit number of collection members in result) ................................................... 32 70 6.6.9 $pagingtimeout (specify inactivity timeout for paged retrieval) .................................... 33 71 6.6.10 $properties (subset properties in result) ...................................................................... 34 72 6.6.11 $qualifiers (include qualifiers in returned classes) ....................................................... 35 73 6.6.12 $sourcerole (source role filter) ..................................................................................... 36 74 6.6.13 $subclasses (include subclasses in class enumeration result) ................................... 36 75 7 Resources, operations and payload elements .................................................................................... 37 76 7.1 Overview ................................................................................................................................... 37 77 7.2 Description conventions ............................................................................................................ 39 78 7.2.1 Data types used in payload element definitions .......................................................... 39 79 7.2.2 Data type names .......................................................................................................... 42 80 7.2.3 Requirement levels used in payload element definitions............................................. 43 81 7.2.4 Requirement levels used in operation definitions ........................................................ 43 82 7.2.5 Description format for operations ................................................................................. 44 83 7.3 Common behaviors for all operations ....................................................................................... 44 84 7.3.1 Content negotiation ...................................................................................................... 44 85 7.3.2 Caching of responses .................................................................................................. 45 Version 2.0.0 Published 3 CIM-RS Protocol DSP0210 86 7.3.3 Success and failure...................................................................................................... 45 87 7.3.4 Errors ..........................................................................................................................