1 karl 1.1 // ===================================================================
2 // Title: Core Physical
3 // $State: Preliminary $
4 // $Date: 2004/06/25 16:11:06 $
5 // $Source: /home/dmtf2/dotorg/var/cvs/repositories/dev/Schema/MOF/Core_Physical.mof,v $
6 // $Revision: 1.4 $
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 concepts for PhysicalElements
48 // and their Locations.
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 Prelininary
55 // CR1050 - Deprecate FRU in lieu of putting the information in
56 // PhysicalElement
57 //
58 // Change Log for v2.8 Final
59 // CR1210 - Removal of experimental Qualifiers for core.
60
61 // Change Log for v2.8 Preliminary
62 // CR1019 - CIM Versioning for 2.8 Preliminary
63 // CR1071 - Add the following properties of PhyscialElement
64 karl 1.1 // VendorEquipmentType, UserTracking, CanBeFRUed.
65 //
66 // Change Log for v2.7 Final
67 // CR968 - Remove the Experimental qualifier
68 // Remove the following properties of PhyscialElement so
69 // they can remain experimental in 2.8
70 // VendorEquipmentType, UserTracking, CanBeFRUed.
71 //
72 // Change Log for v2.7
73 // CR774 - Add ContainedLocation
74 // CR821 - Add PhysicalElement.VendorEquipmentType, PhysicalElement.
75 // UserTracking, and PhysicalElement.CanBeFRUed properties.
76 // - Add mapping string to indicate the support of the SNMP
77 // Entity MIB
78 // - Add the Write qualifier to PhysicalElement.Other
79 // IdentifyingInfo
80 // CR822 - Add SystemPackaging
81 // CR899 - Expand the MaxLen qualifier on 2 PhysicalElement .Model
82 // and .SerialNumber properties from 64 to 256.
83 // CR902 - Create a general superclass ElementLocation of the
84 // PhysicalElementLocation association.
85 karl 1.1 // ==================================================================
86
87 #pragma locale ("en_US")
88
89
90 // =================================================================
91 // PhysicalElement
92 // ==================================================================
93 [Abstract, Version ( "2.8.1000" ), Description (
94 "Subclasses of CIM_PhysicalElement define any component of a "
95 "System that has a distinct physical identity. Instances of "
96 "this class can be defined as an object that can be seen or "
97 "touched. All Processes, Files, and LogicalDevices are "
98 "considered not to be Physical Elements. For example, it is not "
99 "possible to touch the functionality of a 'modem', only the "
100 "card or package that implements the modem. The same card could "
101 "also implement a LAN adapter. PhysicalElements are tangible "
102 "ManagedSystemElements that have a physical manifestation of "
103 "some sort. \n"
104 "\n"
105 "Note that the properties of PhysicalElement describe a "
106 karl 1.1 "hardware entity. Possible replacement (FRU) information is "
107 "defined by following the ElementFRU association to one or more "
108 "instances of the ReplacementFRU class. This allows a client to "
109 "determine what hardware can be replaced/FRUed and what 'spare' "
110 "parts may be required by a customer or engineer doing the "
111 "replacement. If it can be instrumented or manually determined "
112 "that an element actually replaced/FRUed another, then this can "
113 "be described in the model using the ElementHasBeenFRUed "
114 "association.")]
115 class CIM_PhysicalElement : CIM_ManagedSystemElement {
116
117 [Key, Description (
118 "An arbitrary string that uniquely identifies the Physical "
119 "Element and serves as the Element's key. The Tag property "
120 "can contain information such as asset tag or serial number "
121 "data. The key for PhysicalElement is placed very high in "
122 "the object hierarchy in order to independently identify the "
123 "hardware/entity, regardless of physical placement in or on "
124 "Cabinets, Adapters, etc. For example, a hotswappable or "
125 "removeable component may be taken from its containing "
126 "(scoping) Package and be temporarily unused. The object "
127 karl 1.1 "still continues to exist - and may even be inserted into a "
128 "different scoping container. Therefore, the key for "
129 "Physical Element is an arbitrary string and is defined "
130 "independently of any placement or location-oriented "
131 "hierarchy."),
132 MaxLen ( 256 )]
133 string Tag;
134
135 [Override ( "Description" ), Description (
136 "A textual description of the PhysicalElement."),
137 MappingStrings { "MIF.DMTF|FRU|003.3" }]
138 string Description;
139
140 [Key, Description (
141 "CreationClassName indicates the name of the class or the "
142 "subclass used in the creation of an instance. When used "
143 "with the other key properties of this class, this property "
144 "allows all instances of this class and its subclasses to be "
145 "uniquely identified."),
146 MaxLen ( 256 )]
147 string CreationClassName;
148 karl 1.1
149 [Override ( "ElementName" ),
150 MappingStrings { "MIB.IETF|Entity-MIB.entPhysicalName" }]
151 string ElementName;
152
153 [Description (
154 "The name of the organization responsible for producing the "
155 "PhysicalElement. This may be the entity from whom the "
156 "Element is purchased, but this is not necessarily true. The "
157 "latter information is contained in the Vendor property of "
158 "CIM_Product."),
159 MaxLen ( 256 ),
160 MappingStrings { "MIB.IETF|Entity-MIB.entPhysicalMfgName",
161 "MIF.DMTF|FRU|003.4" }]
162 string Manufacturer;
163
164 [Description (
165 "The name by which the PhysicalElement is generally known."),
166 MaxLen ( 256 ),
167 MappingStrings {
168 "MIB.IETF|Entity-MIB.entPhysicalDescr","MIF.DMTF|FRU|003.5" }]
169 karl 1.1 string Model;
170
171 [Description (
172 "The stock keeping unit number for this PhysicalElement."),
173 MaxLen ( 64 )]
174 string SKU;
175
176 [Description (
177 "A manufacturer-allocated number used to identify the "
178 "Physical Element."),
179 MaxLen ( 256 ),
180 MappingStrings {
181 "MIB.IETF|Entity-MIB.entPhysicalSerialNum",""
182 "MIF.DMTF|FRU|003.7" }]
183 string SerialNumber;
184
185 [Description (
186 "A string indicating the version of the PhysicalElement."),
187 MaxLen ( 64 ),
188 MappingStrings { "MIB.IETF|Entity-MIB.entPhysicalHardwareRev",
189 "MIF.DMTF|FRU|003.8" }]
190 karl 1.1 string Version;
191
192 [Description (
193 "The part number assigned by the organization responsible "
194 "for producing or manufacturing the PhysicalElement."),
195 MaxLen ( 256 ),
196 MappingStrings { "MIB.IETF|Entity-MIB.entPhysicalModelName" }]
197 string PartNumber;
198
199 [Write, Description (
200 "OtherIdentifyingInfo captures additional data, beyond that "
201 "of Tag information, that could be used to identify a "
202 "Physical Element. One example is bar code data associated "
203 "with an Element that also has an asset tag. Note that if "
204 "only bar code data is available and is unique/able to be "
205 "used as an Element key, this property would be NULL and the "
206 "bar code data used as the class key, in the Tag property."),
207 MappingStrings { "MIB.IETF|Entity-MIB.entPhysicalAlias" }]
208 string OtherIdentifyingInfo;
209
210 [Description (
211 karl 1.1 "Boolean indicating that the PhysicalElement is powered on "
212 "(TRUE), or is currently off (FALSE).")]
213 boolean PoweredOn;
214
215 [Description (
216 "Date that this PhysicalElement was manufactured.")]
217 datetime ManufactureDate;
218
219 [Description (
220 "A vendor-specific hardware type for the PhysicalElement. It "
221 "describes the specific equipment type for the element, as "
222 "defined by the vendor/manufacturer."),
223 MappingStrings { "MIB.IETF|Entity-MIB.entPhysicalVendorType" }]
224 string VendorEquipmentType;
225
226 [Write, Description (
227 "User-assigned and writeable asset tracking identifier for "
228 "the PhysicalElement."),
229 MappingStrings { "MIB.IETF|Entity-MIB.entPhysicalAssetID" }]
230 string UserTracking;
231
232 karl 1.1 [Description (
233 "Boolean indicating whether this PhysicalElement can be "
234 "FRUed (TRUE) or not (FALSE)."),
235 MappingStrings { "MIB.IETF|Entity-MIB.entPhysicalIsFRU" }]
236 boolean CanBeFRUed;
237 };
238
239 // ==================================================================
240 // ReplacementFRU
241 // ==================================================================
242 [Experimental, Version ( "2.8.1000" ), Description (
243 "The ReplacementFRU class defines ordering information for "
244 "replacement hardware/PhysicalElements. The element or elements "
245 "that can be replaced are defined via the association, "
246 "ElementFRU. If a FRU is made up of other more specific parts, "
247 "then this can be described by instantiating the "
248 "ConcreteComponent relationship between the grouping FRU and "
249 "its parts.")]
250 class CIM_ReplacementFRU : CIM_ManagedElement {
251
252 [Key, Description (
253 karl 1.1 "Within the scope of the instantiating Namespace, InstanceID "
254 "opaquely and uniquely identifies an instance of this class. "
255 "In order to ensure uniqueness within the NameSpace, the "
256 "value of InstanceID SHOULD be constructed using the "
257 "following 'preferred' algorithm: \n"
258 "<OrgID>:<LocalID> \n"
259 "Where <OrgID> and <LocalID> are separated by a colon ':', "
260 "and where <OrgID> MUST include a copyrighted, trademarked "
261 "or otherwise unique name that is owned by the business "
262 "entity creating/defining the InstanceID, or is a registered "
263 "ID that is assigned to the business entity by a recognized "
264 "global authority (This is similar to the <Schema "
265 "Name>_<Class Name> structure of Schema class names.) In "
266 "addition, to ensure uniqueness <OrgID> MUST NOT contain a "
267 "colon (':'). When using this algorithm, the first colon to "
268 "appear in InstanceID MUST appear between <OrgID> and "
269 "<LocalID>. \n"
270 "<LocalID> is chosen by the business entity and SHOULD not "
271 "be re-used to identify different underlying (real-world) "
272 "elements. If the above 'preferred' algorithm is not used, "
273 "the defining entity MUST assure that the resultant "
274 karl 1.1 "InstanceID is not re-used across any InstanceIDs produced "
275 "by this or other providers for this instance's NameSpace. \n"
276 "For DMTF defined instances, the 'preferred' algorithm MUST "
277 "be used with the <OrgID> set to 'CIM'.")]
278 string InstanceID;
279
280
281 [Description (
282 "Replacement ordering information.")]
283 string OrderNumber;
284
285 [Description (
286 "The name of the vendor/supplier in whose context the "
287 "OrderNumber is defined.")]
288 string Vendor;
289
290 [Override ( "Description" ), Description (
291 "A textual description of the replacement.")]
292 string Description;
293
294 [Description (
295 karl 1.1 "Indicates whether this replacement part is considered "
296 "customer replaceable (TRUE) or not (FALSE).")]
297 boolean CustomerReplaceable;
298 };
299
300 // ==================================================================
301 // ElementFRU
302 // ==================================================================
303 [Association, Experimental, Version ( "2.8.1000" ), Description (
304 "ElementFRU associates a PhysicalElement to information about "
305 "possible replacement parts. The association is many to many, "
306 "describing that an element can have several replacement "
307 "options and that those options can apply to multiple pieces of "
308 "hardware.")]
309 class CIM_ElementFRU {
310
311 [Key, Description (
312 "The PhysicalElement which can be replaced/FRUed.")]
313 CIM_PhysicalElement REF ReplaceableElement;
314
315 [Key, Description (
316 karl 1.1 "Ordering information for a replacement element.")]
317 CIM_ReplacementFRU REF ReplacementElement;
318 };
319
320
321 // ==================================================================
322 // ElementHasBeenFRUed
323 // ==================================================================
324 [Association, Experimental, Version ( "2.8.1000" ), Description (
325 "CIM_ElementHasBeenFRUed is an association between two Physical "
326 "Elements indicating that the entity referenced as the "
327 "ReplacedElement was swapped for/replaced by the entity "
328 "referenced as the ReplacementElement. The association is many "
329 "to many, conveying that an element may require several other "
330 "elements to replace it, and vice-versa. The typical scenario, "
331 "however, is that one PhysicalElement replaces another. It MAY "
332 "NOT be possible to instrument or manually determine that an "
333 "element actually replaced/FRUed another. This is especially "
334 "true if the original element is discarded. However, if this "
335 "information is available, then this association describes this "
336 "scenario.")]
337 karl 1.1 class CIM_ElementHasBeenFRUed {
338
339 [Key, Description (
340 "The PhysicalElement which is being replaced/FRUed.")]
341 CIM_PhysicalElement REF ReplacedElement;
342
343 [Key, Description (
344 "The element that is used as the replacement part.")]
345 CIM_PhysicalElement REF ReplacementElement;
346 };
347 // ===================================================================
348 // Location
349 // ===================================================================
350 [Version ( "2.6.0" ), Description (
351 "The Location class specifies the position and address of a "
352 "PhysicalElement.")]
353 class CIM_Location : CIM_ManagedElement {
354
355 [Key, Description (
356 "Name is a free-form string defining a label for the "
357 "Location. It is a part of the key for the object."),
358 karl 1.1 MaxLen ( 256 )]
359 string Name;
360
361 [Key, Description (
362 "Position is a free-form string indicating the placement of "
363 "a PhysicalElement. It can specify slot information on a "
364 "HostingBoard, mounting site in a Cabinet, or latitude and "
365 "longitude information, for example, from a GPS. It is part "
366 "of the key of the Location object."),
367 MaxLen ( 256 )]
368 string PhysicalPosition;
369
370 [Description (
371 "Address is a free-form string indicating a street, building "
372 "or other type of address for the PhysicalElement's "
373 "Location."),
374 MaxLen ( 1024 )]
375 string Address;
376 };
377
378
379 karl 1.1 // ==================================================================
380 // ElementLocation
381 // ==================================================================
382 [Association, Version ( "2.7.0" ), Description (
383 "ElementLocation associates a ManagedElement with a Location "
384 "for positioning, inventory, maintenance and similar purposes. "
385 "PhysicalElements can certainly have Locations - this is "
386 "explicitly defined in a subclass, PhysicalElement Location. "
387 "However, other ManagedElements may also be associated with "
388 "Locations. For example, Organizations may be 'in' one or more "
389 "Locations, or Services may be restricted to a Location.")]
390 class CIM_ElementLocation {
391
392 [Key, Description (
393 "The ManagedElement whose Location is specified.")]
394 CIM_ManagedElement REF Element;
395
396 [Key, Description (
397 "The element's Location.")]
398 CIM_Location REF PhysicalLocation;
399 };
400 karl 1.1
401
402 // ==================================================================
403 // PhysicalElementLocation
404 // ==================================================================
405 [Association, Version ( "2.7.0" ), Description (
406 "PhysicalElementLocation associates a PhysicalElement with a "
407 "Location object for inventory or replacement purposes.")]
408 class CIM_PhysicalElementLocation : CIM_ElementLocation {
409
410 [Override ( "Element" ), Description (
411 "The PhysicalElement whose Location is specified.")]
412 CIM_PhysicalElement REF Element;
413
414 [Override ( "PhysicalLocation" ), Max ( 1 ), Description (
415 "The PhysicalElement's Location.")]
416 CIM_Location REF PhysicalLocation;
417 };
418
419
420 // ==================================================================
421 karl 1.1 // ContainedLocation
422 // ==================================================================
423 [Association, Aggregation, Composition, Version ( "2.7.0" ),
424 Description (
425 "ContainedLocation defines one location in the context of "
426 "another. For example, a campus may 'contain' a building, which "
427 "in turn 'contains' a floor.")]
428 class CIM_ContainedLocation : CIM_Component {
429
430 [Aggregate, Override ( "GroupComponent" ), Max ( 1 ),
431 Description (
432 "The containing location.")]
433 CIM_Location REF GroupComponent;
434
435 [Override ( "PartComponent" ), Description (
436 "The contained location.")]
437 CIM_Location REF PartComponent;
438 };
439
440
441 // ==================================================================
442 karl 1.1 // SystemPackaging
443 // ==================================================================
444 [Association, Version ( "2.7.0" ), Description (
445 "Similar to the way that LogicalDevices are 'Realized' by "
446 "PhysicalElements, Systems may be associated with specific "
447 "packaging/PhysicalElements. This association explicitly "
448 "defines the relationship between a System and its packaging.")]
449 class CIM_SystemPackaging : CIM_Dependency {
450
451 [Override ( "Antecedent" ), Description (
452 "The PhysicalElement(s) that provide the packaging of a "
453 "System.")]
454 CIM_PhysicalElement REF Antecedent;
455
456 [Override ( "Dependent" ), Description (
457 "The System whose packaging is described.")]
458 CIM_System REF Dependent;
459 };
460
461
462 // ===================================================================
463 karl 1.1 // end of file
464 // ===================================================================
|
Return to
Core_Physical.mof
CVS log
Up to [Pegasus] / pegasus / Schemas / CIMPrelim29