1 karl 1.1 // ===================================================================
2 // Title: Core Capabilities
3 // $State: Preliminary $
4 // $Date: 2004/06/25 16:11:06 $
5 // $Source: /home/dmtf2/dotorg/var/cvs/repositories/dev/Schema/MOF/Core_Capabilities.mof,v $
6 // $Revision: 1.6 $
7 // ===================================================================
8 //#pragma inLine ("Includes/copyright.inc")
9 // Copyright 1998-2004 Distributed Management Task Force, Inc. (DMTF).
10 // All rights reserved.
11 // DMTF is a not-for-profit association of industry members dedicated
12 // to promoting enterprise and systems management and interoperability.
13 // DMTF specifications and documents may be reproduced for uses
14 // consistent with this purpose by members and non-members,
15 // provided that correct attribution is given.
16 // As DMTF specifications may be revised from time to time,
17 // the particular version and release date should always be noted.
18 //
19 // Implementation of certain elements of this standard or proposed
20 // standard may be subject to third party patent rights, including
21 // provisional patent rights (herein "patent rights"). DMTF makes
22 karl 1.1 // no representations to users of the standard as to the existence
23 // of such rights, and is not responsible to recognize, disclose, or
24 // identify any or all such third party patent right, owners or
25 // claimants, nor for any incomplete or inaccurate identification or
26 // disclosure of such rights, owners or claimants. DMTF shall have no
27 // liability to any party, in any manner or circumstance, under any
28 // legal theory whatsoever, for failure to recognize, disclose, or
29 // identify any such third party patent rights, or for such party's
30 // reliance on the standard or incorporation thereof in its product,
31 // protocols or testing procedures. DMTF shall have no liability to
32 // any party implementing such standard, whether such implementation
33 // is foreseeable or not, nor to any patent owner or claimant, and shall
34 // have no liability or responsibility for costs or losses incurred if
35 // a standard is withdrawn or modified after publication, and shall be
36 // indemnified and held harmless by any party implementing the
37 // standard from any and all claims of infringement by a patent owner
38 // for such implementations.
39 //
40 // For information about patents held by third-parties which have
41 // notified the DMTF that, in their opinion, such patent may relate to
42 // or impact implementations of DMTF standards, visit
43 karl 1.1 // http://www.dmtf.org/about/policies/disclosures.php.
44 //#pragma inLine
45 // ===================================================================
46 // Description: The Core Model defines basic management concepts.
47 // This file defines the management concepts related
48 // to the Capabilities of a ManagedElement.
49 //
50 // The object classes below are listed in an order that
51 // avoids forward references. Required objects, defined
52 // by other working groups, are omitted.
53 // ==================================================================
54 // Change Log for v2.9 Preliminary
55 // CR1358 - Add EnabledLogicalElementCapabilities.
56 //
57 // Change Log for v2.8 Final
58 // CR1210 - Removal of experimental qualifiers for core.
59 //
60 // Change Log for v2.8 Preliminary
61 // CR937 - Add LocalizationCapabilities
62 // CR1019 - CIM Versioning for 2.8 Preliminary
63 //
64 karl 1.1 // Change Log for v2.7
65 // CR968 - Remove the Experimental qualifier
66 // CR994 - Updates to InstanceID description.
67 //
68 // Change Log for v2.7
69 // CR 730 - Introduce Capabilites and ElementCapabilities
70 // ==================================================================
71
72 #pragma locale ("en_US")
73
74
75 // ==================================================================
76 // Capabilities
77 // ==================================================================
78 [Abstract, Version ( "2.7.0" ), Description (
79 "Capabilities is an abstract class whose subclasses describe "
80 "abilities and/or potential for use. For example, one may "
81 "describe the maximum number of VLANs that can be supported on "
82 "a system using a subclass of Capabilities. Capabilities are "
83 "tied to the elements which they describe using the "
84 "ElementCapabilities association. Note that the cardinality of "
85 karl 1.1 "the ManagedElement reference is Min(1), Max(1). This "
86 "cardinality mandates the instantiation of the "
87 "ElementCapabilities association for the referenced instance of "
88 "Capabilities. ElementCapabilities describes the existence "
89 "requirements and context for the referenced instance of "
90 "ManagedElement. Specifically, the ManagedElement MUST exist "
91 "and provides the context for the Capabilities. Note that "
92 "Capabilities do not indicate what IS configured or "
93 "operational, but what CAN or CANNOT exist, be defined or be "
94 "used. Note that it is possible to describe both supported and "
95 "excluded abilities and functions (both capabilities and "
96 "limitations) using this class.")]
97 class CIM_Capabilities : CIM_ManagedElement {
98
99 [Key, Description (
100 "Within the scope of the instantiating Namespace, InstanceID "
101 "opaquely and uniquely identifies an instance of this class. "
102 "In order to ensure uniqueness within the NameSpace, the "
103 "value of InstanceID SHOULD be constructed using the "
104 "following 'preferred' algorithm: \n"
105 "<OrgID>:<LocalID> \n"
106 karl 1.1 "Where <OrgID> and <LocalID> are separated by a colon ':', "
107 "and where <OrgID> MUST include a copyrighted, trademarked "
108 "or otherwise unique name that is owned by the business "
109 "entity creating/defining the InstanceID, or is a registered "
110 "ID that is assigned to the business entity by a recognized "
111 "global authority (This is similar to the <Schema "
112 "Name>_<Class Name> structure of Schema class names.) In "
113 "addition, to ensure uniqueness <OrgID> MUST NOT contain a "
114 "colon (':'). When using this algorithm, the first colon to "
115 "appear in InstanceID MUST appear between <OrgID> and "
116 "<LocalID>. \n"
117 "<LocalID> is chosen by the business entity and SHOULD not "
118 "be re-used to identify different underlying (real-world) "
119 "elements. If the above 'preferred' algorithm is not used, "
120 "the defining entity MUST assure that the resultant "
121 "InstanceID is not re-used across any InstanceIDs produced "
122 "by this or other providers for this instance's NameSpace. \n"
123 "For DMTF defined instances, the 'preferred' algorithm MUST "
124 "be used with the <OrgID> set to 'CIM'.")]
125 string InstanceID;
126
127 karl 1.1 [Required, Override ( "ElementName" ), Description (
128 "The user friendly name for this instance of Capabilities. "
129 "In addition, the user friendly name can be used as a index "
130 "property for a search of query. (Note: Name does not have "
131 "to be unique within a namespace.)")]
132 string ElementName;
133 };
134
135
136 // ===================================================================
137 // ElementCapabilities
138 // ===================================================================
139 [Association, Version ( "2.7.0" ), Description (
140 "ElementCapabilities represents the association between "
141 "ManagedElements and their Capabilities. Note that the "
142 "cardinality of the ManagedElement reference is Min(1), Max(1). "
143 "This cardinality mandates the instantiation of the "
144 "ElementCapabilities association for the referenced instance of "
145 "Capabilities. ElementCapabilities describes the existence "
146 "requirements and context for the referenced instance of "
147 "ManagedElement. Specifically, the ManagedElement MUST exist "
148 karl 1.1 "and provides the context for the Capabilities.")]
149 class CIM_ElementCapabilities {
150
151 [Key, Min ( 1 ), Max ( 1 ), Description (
152 "The managed element.")]
153 CIM_ManagedElement REF ManagedElement;
154
155 [Key, Description (
156 "The Capabilities object associated with the element.")]
157 CIM_Capabilities REF Capabilities;
158 };
159
160 // ==================================================================
161 // LocalizationCapabilities
162 // ==================================================================
163 [Experimental, Version ( "2.8.1000" ), Description (
164 "Describes the input and output localization capabilities of "
165 "the entity associated via ElementCapabilities.")]
166 class CIM_LocalizationCapabilities : CIM_Capabilities {
167
168 [Description (
169 karl 1.1 "This property, along with locale properties in (for "
170 "example) a SettingData class, specifies the locale for data "
171 "consumed by a ManagedElement. \n"
172 "A locale indicates a particular geographical, political, or "
173 "cultural region. The SupportedInputLocales property is an "
174 "array of strings whose entries specify one or more "
175 "languages that can be used in the formulation of "
176 "information input by a client. It may be defined by the "
177 "ManagedElement or client as an input parameter to a method, "
178 "as a Setting or SettingData property, or via other "
179 "mechanisms. \n"
180 "\n"
181 "The SupportedInputLocales property publishes an element's "
182 "support of various locales for input data. The first array "
183 "entry MUST define the default locale (the natural language "
184 "associated with the ManagedElement). If the "
185 "SupportedInputLocales property is empty, it is assumed that "
186 "the default locale is en_US (English). \n"
187 "Each array entry consists of three sub-strings, separated "
188 "by underscores: \n"
189 "- The first sub-string is the language code, as specified "
190 karl 1.1 "in ISO639. \n"
191 "- The second sub-string is the country code, as specified "
192 "in ISO3166. \n"
193 "- The third sub-string is a variant, which is vendor "
194 "specific. \n"
195 "For example, US English appears as: \"en_US_WIN\", where "
196 "the \"WIN\" variant would specify a Windows "
197 "browser-specific collation (if one exists). Since the "
198 "variant is not standardized, it is not commonly used and is "
199 "generally limited to easily recognizable values (\"WIN\", "
200 "\"UNIX\", \"EURO\", etc.) used in standard environments. \n"
201 "The language and country codes are required; the variant "
202 "may be empty.")]
203 string SupportedInputLocales[];
204
205 [Description (
206 "This property, along with locale properties in (for "
207 "example) a SettingData class, specifies the locale for data "
208 "produced by a ManagedElement. \n"
209 "A locale indicates a particular geographical, political, or "
210 "cultural region. The SupportedOutputLocales property is an "
211 karl 1.1 "array of strings whose entries specify one or more "
212 "languages that can be used in the formulation of "
213 "information requested by and delivered to a client. It may "
214 "be defined by the ManagedElement or client as an input "
215 "parameter to a method, as a Setting or SettingData "
216 "property, or via other mechanisms. Note that more than one "
217 "locale may be specified in this array and later selected "
218 "for output. If multiple locales are selected, information "
219 "MUST be returned in each language specified, and indicated "
220 "as supported by this Capabilities instance. \n"
221 "\n"
222 "The SupportedOutputLocales property publishes an element's "
223 "support of various locales for output data. The first array "
224 "entry MUST define the default locale (the natural language "
225 "associated with the ManagedElement). If the SupportedOutput "
226 "Locales property is empty, it is assumed that the default "
227 "locale is en_US (English). \n"
228 "Each array entry consists of three sub-strings, separated "
229 "by underscores: \n"
230 "- The first sub-string is the language code, as specified "
231 "in ISO639. \n"
232 karl 1.1 "- The second sub-string is the country code, as specified "
233 "in ISO3166. \n"
234 "- The third sub-string is a variant, which is vendor "
235 "specific. \n"
236 "For example, US English appears as: \"en_US_WIN\", where "
237 "the \"WIN\" variant would specify a Windows "
238 "browser-specific collation (if one exists). Since the "
239 "variant is not standardized, it is not commonly used and is "
240 "generally limited to easily recognizable values (\"WIN\", "
241 "\"UNIX\", \"EURO\", etc.) used in standard environments. \n"
242 "The language and country codes are required; the variant "
243 "may be empty.")]
244 string SupportedOutputLocales[];
245 };
246
247 // ==================================================================
248 // EnabledLogicalElementCapabilities
249 // ==================================================================
250 [Experimental, Version ( "2.8.1000" ), Description (
251 "EnabledStateCapabilities describes the capabilities supported "
252 "for changing the state OF THE ASSOCIATED "
253 karl 1.1 "EnabledLogicalElement.")]
254 class CIM_EnabledLogicalElementCapabilities : CIM_Capabilities {
255
256 [Description (
257 "Boolean indicating whether the ElementName can be modified."),
258 MappingStrings {
259 "FC-SWAPI.INCITS-T11|SWAPI_UNIT_CONFIG_CAPS_T|EditName" },
260 ModelCorrespondence { "CIM_ManagedElement.ElementName" }]
261 boolean ElementNameEditSupported;
262
263 [Description (
264 "Maximum supported ElementName length."),
265 MaxValue ( 256 ),
266 MappingStrings {
267 "FC-SWAPI.INCITS-T11|SWAPI_UNIT_CONFIG_CAPS_T|MaxNameChars" },
268 ModelCorrespondence {
269 "CIM_FCSwitchCapabilities.ElementNameEditSupported" }]
270 uint16 MaxElementNameLen;
271
272 [Description (
273 "RequestedStatesSupported indicates the possible states that "
274 karl 1.1 "can be requested when using the method RequestStateChange "
275 "on the EnabledLogicalElement."),
276 ValueMap { "2", "3", "4", "6", "7", "8", "9", "10", "11" },
277 Values { "Enabled", "Disabled", "Shut Down", "Offline", "Test",
278 "Defer", "Quiesce", "Reboot", "Reset" },
279 ModelCorrespondence {
280 "CIM_EnabledLogicalElement.RequestStateChange" }]
281 uint16 RequestedStatesSupported[];
282 };
283
284 // ===================================================================
285 // end of file
286 // ===================================================================
|
Return to
Core_Capabilities.mof
CVS log
Up to [Pegasus] / pegasus / Schemas / CIMPrelim29