1 a.dunfey 1.1 // ===================================================================
2 // Title: Core_CoreElements
3 // $State: Exp $
4 // $Date: 2004/11/30 21:26:35 $
5 // $RCSfile: Core_CoreElements.mof,v $
6 // $Revision: 1.12.2.5 $
7 // ===================================================================
8 //#pragma inLine ("Includes/copyright.inc")
9 // Copyright 1998-2005 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 a.dunfey 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 a.dunfey 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 the top of the CIM
48 // object hierarchies (ManagedElement,
49 // ManagedSystemElement,
50 // LogicalElement, Systems, Services, etc.) and the 'top'
51 // associations (Dependency, Component,
52 // LogicalIdentity, ...).
53 //
54 // The object classes below are listed in an order that
55 // avoids forward references. Required objects, defined
56 // by other working groups, are omitted.
57 // ==================================================================
58 // Change Log for v2.9 Final
59 // CR1319 - Add CIM_ConcreteJob.TimeBeforeRemoval
60 // CR1282 - Change the description of Job.PercentComplete
61 //
62 // Change Log for v2.8 Final
63 // CR1181 - Add properties/method to ConcreteJob to support state
64 a.dunfey 1.1 // and enhance kill support
65 // CR1203 - Reserved Range for OperationalStatus
66 // CR1210 - Removal of experimental qualifiers for core.
67 // CR1223 - Sysdev Omnibus CR - Minor MOF corrections.
68 //
69 // Change Log for v2.8 Preliminary
70 // CR932 - Add power mode status to OperationalStatus.
71 // Move the specific power mode states from availability
72 // to a property between the PowerMgmt service and its ME.
73 // Remove the overlapping properties from Logical Device.
74 // CR950 - Add ArrayType to CIM_ManagedSystemElement properties
75 // CR1006 - Improve description of ManagedSystemElement
76 // CR1026 - Update the InfoFormat enum for RemoteAccessPoint
77 // CR1019 - CIM Versioning for 2.8 Preliminary
78 // CR1033 - relax key types for Synchronized
79 // CR1030 - Update AdminDomain.NameFormat for WWN
80 // CR1045 - Add method for requesting a "EnabledState" change in
81 // EnabledLogicalElement class / Deprecate or explain overlap
82 // with LogicalDevice and Service properties and methods
83 // CR1052 - Updates to ProtocolEndpoint and its
84 // subclasses to better align with the IF-MIB
85 a.dunfey 1.1 // CR1081 - Promote CIM_Job and ConcreteJob to the Core Model to
86 // avoid forward reference in EnabledLogicalElement's methods
87 // CR1092 - Move Service and SAP related classes to their own file
88 // CR1127 - Add new enums to RequestedState
89 // CR1128 - Addition of HostedDependency
90 // CR1135 - Job Recovery Properties and the RecoveryJob association
91 //
92 // Change Log for v2.7 Final
93 // CR961 - Rename EnabledLogicalElement. xxxStatus properties to be
94 // State.
95 // - Update description of xxxState properties to reflect the
96 // expected behavior of the state values.
97 // - Change references to EnabledStatus and RequestedStatus to
98 // EnabledState and RequestedState in the Service.
99 // StartService()
100 // StopService()
101 // CR966 - Remove the Terminal qualifier from ConcreteDependency,
102 // ConcreteComponent, and ConcreteIdentity associations and
103 // add text to describe the intent of the original placement
104 // CR968 - Remove the Experimental qualifier
105 // CR993 - Change property name and description of
106 a.dunfey 1.1 // ManagedSystemElement.OtherStatusDescription
107 // CR1009 - Add ServiceAccessURI class
108 // CR1135 - Job Recovery Properties and the RecoveryJob association
109 //
110 // Change Log for v2.7
111 // CR641 - Add ConcreteDependency
112 // CR643 - Promote Component to ManagedElement, and add
113 // ConcreteComponent
114 // CR660 - Add RemoteServiceAccessPoint and RemotePort
115 // CR663 - Update the Description of ActiveConnection and some of
116 // its properties. Deprecate the properties, TrafficType
117 // and OtherTrafficDescription
118 // CR670 - Promote LogicalIdentity to ManagedElement, and add
119 // ConcreteIdentity
120 // CR671 - Deprecate ProvidesServiceToElement
121 // - Add ServiceAvailableToElement
122 // - Update description for ServiceServiceDependency
123 // CR672 - Update description for SystemComponent to clarify its use
124 // CR677 - Add the array property OperationalStatus & OtherStatus
125 // Description, and deprecate the existing Status property of
126 // ManagedSystemElement
127 a.dunfey 1.1 // - Deprecate StartMode in Service
128 // CR717 - Clarify description of System.Roles
129 // CR747 - Add the Write Qualifier and update description of System.
130 // Roles
131 // CR751 - Promote ActiveConnection from ProtocolEndpoint to
132 // ServiceAccessPoint
133 // CR757 - Add EnabledLogicalElement
134 // - Change subclass of System, Service, and ServiceAccessPoint
135 // from LogicalElement to EnabledLogicalElement
136 // - Update the descriptions to Service.StartService() and
137 // Service.StopService() to explain the overlap with
138 // RequestedStatus
139 // - Update the deprecation of Service.StartMode to
140 // EnabledDefault
141 // CR758 - Add ElementName to ManagedElement
142 // CR764 - Add ServiceAffectsElement
143 // CR779 - Extend ManagedSystemElement.OperationalStatus to include
144 // "Completed"
145 // CR804 - Update the enumeration for ProtocolEndpoint.ProtocolType
146 // CR833 - Extend EnabledLogicalElement.EnabledStatus & .Requested
147 // Status to include "In Test" and "Test" respectively
148 a.dunfey 1.1 // CR834 - Extend ManagedSystemElement.OperationalStatus to include
149 // "Aborted", "Dormant", and "Supported Entity in Error"
150 // CR844 - Add PrimaryOwnerName and PrimaryOwnerContact to Service;
151 // Add Write qualifier to the same properties in System
152 // CR894 - Clarify the description for System.
153 // CR898 - Extend MaxLen qualifier on ManagedSystemElement.Name
154 // from 256 to 1024 (to match subclassing requriements)
155 // ==================================================================
156
157 #pragma locale ("en_US")
158
159
160 // ==================================================================
161 // ManagedElement
162 // ==================================================================
163 [Abstract, Version ( "2.7.0" ), Description (
164 "ManagedElement is an abstract class that provides a common "
165 "superclass (or top of the inheritance tree) for the "
166 "non-association classes in the CIM Schema.")]
167 class CIM_ManagedElement {
168
169 a.dunfey 1.1 [Description (
170 "The Caption property is a short textual description (one- "
171 "line string) of the object."),
172 MaxLen ( 64 )]
173 string Caption;
174
175 [Description (
176 "The Description property provides a textual description of "
177 "the object.")]
178 string Description;
179
180 [Description (
181 "A user-friendly name for the object. This property allows "
182 "each instance to define a user-friendly name IN ADDITION TO "
183 "its key properties/identity data, and description "
184 "information. \n"
185 "Note that ManagedSystemElement's Name property is also "
186 "defined as a user-friendly name. But, it is often "
187 "subclassed to be a Key. It is not reasonable that the same "
188 "property can convey both identity and a user friendly name, "
189 "without inconsistencies. Where Name exists and is not a Key "
190 a.dunfey 1.1 "(such as for instances of LogicalDevice), the same "
191 "information MAY be present in both the Name and ElementName "
192 "properties.")]
193 string ElementName;
194 };
195
196
197 // ==================================================================
198 // Dependency
199 // ==================================================================
200 [Association, Abstract, Version ( "2.6.0" ), Description (
201 "CIM_Dependency is a generic association used to establish "
202 "dependency relationships between ManagedElements.")]
203 class CIM_Dependency {
204
205 [Key, Description (
206 "Antecedent represents the independent object in this "
207 "association.")]
208 CIM_ManagedElement REF Antecedent;
209
210 [Key, Description (
211 a.dunfey 1.1 "Dependent represents the object dependent on the "
212 "Antecedent.")]
213 CIM_ManagedElement REF Dependent;
214 };
215
216
217 // ==================================================================
218 // ConcreteDependency
219 // ==================================================================
220 [Association, Version ( "2.7.0" ), Description (
221 "CIM_ConcreteDependency is a generic association used to "
222 "establish dependency relationships between ManagedElements. It "
223 "is defined as a concrete subclass of the abstract "
224 "CIM_Dependency class, to be used in place of many specific "
225 "subclasses of Dependency that add no semantics - i.e., that do "
226 "not clarify the type of dependency, update cardinalities, or "
227 "add/remove qualifiers. Note that when defining additional "
228 "semantics for Dependency that this class MUST NOT be "
229 "subclassed. Specific semantics continue to be defined as "
230 "subclasses of the abstract CIM_Dependency. ConcreteDependency "
231 "is limited in its use as a concrete form of a general "
232 a.dunfey 1.1 "dependency. \n"
233 "\n"
234 "It was deemed more prudent to create this concrete subclass "
235 "than to change Dependency from an abstract to a concrete "
236 "class. Dependency already had multiple abstract subclasses in "
237 "the CIM Schema, and wider industry usage and impact could not "
238 "be anticipated.")]
239 class CIM_ConcreteDependency : CIM_Dependency {
240
241 [Override ( "Antecedent" ), Description (
242 "Antecedent represents the independent object in this "
243 "association.")]
244 CIM_ManagedElement REF Antecedent;
245
246 [Override ( "Dependent" ), Description (
247 "Dependent represents the object dependent on the "
248 "Antecedent.")]
249 CIM_ManagedElement REF Dependent;
250 };
251
252 // ==================================================================
253 a.dunfey 1.1 // Component
254 // ==================================================================
255 [Association, Abstract, Aggregation, Version ( "2.7.0" ),
256 Description (
257 "CIM_Component is a generic association used to establish 'part "
258 "of' relationships between Managed Elements. For example, it "
259 "could be used to define the components or parts of a System.")]
260 class CIM_Component {
261
262 [Key, Aggregate, Description (
263 "The parent element in the association.")]
264 CIM_ManagedElement REF GroupComponent;
265
266 [Key, Description (
267 "The child element in the association.")]
268 CIM_ManagedElement REF PartComponent;
269 };
270
271
272 // ==================================================================
273 // ConcreteComponent
274 a.dunfey 1.1 // ==================================================================
275 [Association, Aggregation, Version ( "2.7.0" ), Description (
276 "CIM_ConcreteComponent is a generic association used to "
277 "establish 'part of' relationships between ManagedElements. It "
278 "is defined as a concrete subclass of the abstract "
279 "CIM_Component class, to be used in place of many specific "
280 "subclasses of Component that add no semantics - i.e., that do "
281 "not clarify the type of composition, update cardinalities, or "
282 "add/remove qualifiers. Note that when defining additional "
283 "semantics for Component that this class MUST NOT be "
284 "subclassed. Specific semantics continue to be defined as "
285 "subclasses of the abstract CIM_Component. ConcreteComponent is "
286 "limited in its use as a concrete form of a general "
287 "composition. \n"
288 "\n"
289 "It was deemed more prudent to create this concrete subclass "
290 "than to change Component from an abstract to a concrete class. "
291 "Industry usage and impact could not be anticipated.")]
292 class CIM_ConcreteComponent : CIM_Component {
293
294 [Aggregate, Override ( "GroupComponent" ), Description (
295 a.dunfey 1.1 "The parent element in the association.")]
296 CIM_ManagedElement REF GroupComponent;
297
298 [Override ( "PartComponent" ), Description (
299 "The child element in the association.")]
300 CIM_ManagedElement REF PartComponent;
301 };
302
303
304 // ==================================================================
305 // LogicalIdentity
306 // ==================================================================
307 [Association, Abstract, Version ( "2.7.0" ), Description (
308 "CIM_LogicalIdentity is an abstract and generic association, "
309 "indicating that two ManagedElements represent different "
310 "aspects of the same underlying entity. This relationship "
311 "conveys what could be defined with multiple inheritance. In "
312 "most scenarios, the Identity relationship is determined by the "
313 "equivalence of Keys or some other identifying properties of "
314 "the related Elements. \n"
315 "\n"
316 a.dunfey 1.1 "One of the scenarios where this relationship is reasonable is "
317 "to represent that a LogicalDevice is both a 'bus' entity and a "
318 "'functional' entity. For example, a Device could be both a USB "
319 "(bus) and a Keyboard (functional) entity.")]
320 class CIM_LogicalIdentity {
321
322 [Key, Description (
323 "SystemElement represents one aspect of the Managed Element. "
324 "The use of 'System' in the role name does not limit the "
325 "scope of the association. The role name was defined in the "
326 "original association, where the referenced elements were "
327 "limited to LogicalElements. Since that time, it has been "
328 "found valuable to instantiate these types of relationships "
329 "for ManagedElements, such as Collections. So, the "
330 "referenced elements of the association were redefined to be "
331 "ManagedElements. Unfortunately, the role name could not be "
332 "changed without deprecating the entire association. This "
333 "was not deemed necessary just to correct the role name.")]
334 CIM_ManagedElement REF SystemElement;
335
336 [Key, Description (
337 a.dunfey 1.1 "SameElement represents an alternate aspect of the "
338 "ManagedElement.")]
339 CIM_ManagedElement REF SameElement;
340 };
341
342
343 // ==================================================================
344 // ConcreteIdentity
345 // ==================================================================
346 [Association, Version ( "2.7.0" ), Description (
347 "CIM_ConcreteIdentity associates two elements representing "
348 "different aspects of the same underlying entity. It is defined "
349 "as a concrete subclass of the abstract CIM_LogicalIdentity "
350 "class, to be used in place of many specific subclasses of "
351 "LogicalIdentity that add no semantics - i.e., that do not "
352 "clarify the type of identity, update cardinalities, or "
353 "add/remove qualifiers. Note -that when defining additional "
354 "semantics for LogicalIdentity that this class should not be "
355 "subclassed. Specifc semantics continue to be defined as "
356 "subclasses of the abstract CIM_LogicalIdentity. "
357 "ConcreteIdentity is limited in its use as a concrete form of a "
358 a.dunfey 1.1 "general identity relationship. \n"
359 "\n"
360 "It was deemed more prudent to create this concrete subclass "
361 "than to change LogicalIdentity from an abstract to a concrete "
362 "class. LogicalIdentity already had multiple abstract "
363 "subclasses in the CIM Schema, and wider industry usage and "
364 "impact could not be anticipated.")]
365 class CIM_ConcreteIdentity : CIM_LogicalIdentity {
366
367 [Override ( "SystemElement" ), Description (
368 "One aspect of the ManagedElement. The use of 'System' in "
369 "the name does not limit the scope of the association. This "
370 "is an artifact of the original definition of the "
371 "association.")]
372 CIM_ManagedElement REF SystemElement;
373
374 [Override ( "SameElement" ), Description (
375 "Another aspect of the ManagedElement.")]
376 CIM_ManagedElement REF SameElement;
377 };
378
379 a.dunfey 1.1
380 // ==================================================================
381 // ManagedSystemElement
382 // ==================================================================
383 [Abstract, Version ( "2.8.0" ), Description (
384 "CIM_ManagedSystemElement is the base class for the System "
385 "Element hierarchy. Any distinguishable component of a System "
386 "is a candidate for inclusion in this class. Examples of system "
387 "components include: \n"
388 "- software components such as application servers, databases, "
389 "and applications \n"
390 "- operating system components such as files, processes, and "
391 "threads \n"
392 "- device components such as disk drives, controllers, "
393 "processors, and printers \n"
394 "- physical components such as chips and cards.")]
395 class CIM_ManagedSystemElement : CIM_ManagedElement {
396
397 [Description (
398 "A datetime value indicating when the object was installed. "
399 "A lack of a value does not indicate that the object is not "
400 a.dunfey 1.1 "installed."),
401 MappingStrings { "MIF.DMTF|ComponentID|001.5" }]
402 datetime InstallDate;
403
404 [Description (
405 "The Name property defines the label by which the object is "
406 "known. When subclassed, the Name property can be overridden "
407 "to be a Key property."),
408 MaxLen ( 1024 )]
409 string Name;
410
411 [Description (
412 "Indicates the current status(es) of the element. Various "
413 "health and operational statuses are defined. Many of the "
414 "enumeration's values are self- explanatory. However, a few "
415 "are not and are described in more detail. \n"
416 "\"Stressed\" indicates that the element is functioning, but "
417 "needs attention. Examples of \"Stressed\" states are "
418 "overload, overheated, etc. \n"
419 "\"Predictive Failure\" indicates that an element is "
420 "functioning nominally but predicting a failure in the near "
421 a.dunfey 1.1 "future. \n"
422 "\"In Service\" describes an element being configured, "
423 "maintained, cleaned, or otherwise administered. \n"
424 "\"No Contact\" indicates that the monitoring system has "
425 "knowledge of this element, but has never been able to "
426 "establish communications with it. \n"
427 "\"Lost Communication\" indicates that the ManagedSystem "
428 "Element is known to exist and has been contacted "
429 "successfully in the past, but is currently unreachable. \n"
430 "\"Stopped\" and \"Aborted\" are similar, although the "
431 "former implies a clean and orderly stop, while the latter "
432 "implies an abrupt stop where the element's state and "
433 "configuration may need to be updated. \n"
434 "\"Dormant\" indicates that the element is inactive or "
435 "quiesced. \n"
436 "\"Supporting Entity in Error\" describes that this element "
437 "may be \"OK\" but that another element, on which it is "
438 "dependent, is in error. An example is a network service or "
439 "endpoint that cannot function due to lower layer networking "
440 "problems. \n"
441 "\"Completed\" indicates the element has completed its "
442 a.dunfey 1.1 "operation. This value should be combined with either OK, "
443 "Error, or Degraded so that a client can till if the "
444 "complete operation passed (Completed with OK), and failure "
445 "(Completed with Error). Completed with Degraded would imply "
446 "the operation finished, but did not complete OK or report "
447 "an error. \n"
448 "\"Power Mode\" indicates the element has additional power "
449 "model information contained in the Associated "
450 "PowerManagementService association. \n"
451 "OperationalStatus replaces the Status property on "
452 "ManagedSystemElement to provide a consistent approach to "
453 "enumerations, to address implementation needs for an array "
454 "property, and to provide a migration path from today's "
455 "environment to the future. This change was not made earlier "
456 "since it required the DEPRECATED qualifier. Due to the "
457 "widespread use of the existing Status property in "
458 "management applications, it is strongly RECOMMENDED that "
459 "providers/instrumentation provide BOTH the Status and "
460 "OperationalStatus properties. Further, the first value of "
461 "OperationalStatus SHOULD contain the primary status for the "
462 "element. When instrumented, Status (since it is "
463 a.dunfey 1.1 "single-valued) SHOULD also provide the primary status of "
464 "the element."),
465 ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "8", "9",
466 "10", "11", "12", "13", "14", "15", "16", "17", "18", "..",
467 "0x8000.." },
468 Values { "Unknown", "Other", "OK", "Degraded", "Stressed",
469 "Predictive Failure", "Error", "Non-Recoverable Error",
470 "Starting", "Stopping", "Stopped", "In Service",
471 "No Contact", "Lost Communication", "Aborted", "Dormant",
472 "Supporting Entity in Error", "Completed", "Power Mode",
473 "DMTF Reserved", "Vendor Reserved" }, ArrayType ( "Indexed" ),
474 ModelCorrespondence {
475 "CIM_ManagedSystemElement.StatusDescriptions" }]
476 uint16 OperationalStatus[];
477
478 [Description (
479 "Strings describing the various OperationalStatus array "
480 "values. For example, if \"Stopping\" is the value assigned "
481 "to OperationalStatus, then this property may contain an "
482 "explanation as to why an object is being stopped. Note that "
483 "entries in this array are correlated with those at the same "
484 a.dunfey 1.1 "array index in OperationalStatus."),
485 ArrayType ( "Indexed" ),
486 ModelCorrespondence {
487 "CIM_ManagedSystemElement.OperationalStatus" }]
488 string StatusDescriptions[];
489
490 [Deprecated { "CIM_ManagedSystemElement.OperationalStatus" },
491 Description (
492 "A string indicating the current status of the object. "
493 "Various operational and non-operational statuses are "
494 "defined. This property is deprecated in lieu of "
495 "OperationalStatus, which includes the same semantics in its "
496 "enumeration. This change is made for 3 reasons: 1) Status "
497 "is more correctly defined as an array. This overcomes the "
498 "limitation of describing status via a single value, when it "
499 "is really a multi-valued property (for example, an element "
500 "may be OK AND Stopped. 2) A MaxLen of 10 is too restrictive "
501 "and leads to unclear enumerated values. And, 3) The change "
502 "to a uint16 data type was discussed when CIM V2.0 was "
503 "defined. However, existing V1.0 implementations used the "
504 "string property and did not want to modify their code. "
505 a.dunfey 1.1 "Therefore, Status was grandfathered into the Schema. Use of "
506 "the Deprecated qualifier allows the maintenance of the "
507 "existing property, but also permits an improved definition "
508 "using OperationalStatus."),
509 ValueMap { "OK", "Error", "Degraded", "Unknown", "Pred Fail",
510 "Starting", "Stopping", "Service", "Stressed", "NonRecover",
511 "No Contact", "Lost Comm", "Stopped" }, MaxLen ( 10 )]
512 string Status;
513 };
514
515 // ===================================================================
516 // HostedDependency
517 // ===================================================================
518 [Association, Version ( "2.8.0" ), Description (
519 "HostedDependency defines a ManagedElement in the context of "
520 "another ManagedElement in which it resides.")]
521 class CIM_HostedDependency : CIM_Dependency {
522
523 [Override ( "Antecedent" ), Max ( 1 ), Description (
524 "The scoping ManagedElement.")]
525 CIM_ManagedElement REF Antecedent;
526 a.dunfey 1.1
527 [Override ( "Dependent" ), Description (
528 "The hosted ManagedElement.")]
529 CIM_ManagedElement REF Dependent;
530 };
531
532 // ==================================================================
533 // LogicalElement
534 // ==================================================================
535 [Abstract, Version ( "2.6.0" ), Description (
536 "CIM_LogicalElement is a base class for all the components of a "
537 "System that represent abstract system components, such as "
538 "Files, Processes, or LogicalDevices.")]
539 class CIM_LogicalElement : CIM_ManagedSystemElement {
540 };
541
542
543 // ===================================================================
544 // Job
545 // ===================================================================
546 [Abstract, Version ( "2.8.0" ), Description (
547 a.dunfey 1.1 "A Job is a LogicalElement representing an executing unit of "
548 "work, such as a script or a print job. A Job is distinct from "
549 "a Process in that a Job can be scheduled, queued, and its "
550 "execution is not limited to a single system.")]
551 class CIM_Job : CIM_LogicalElement {
552
553 [Description (
554 "A free form string representing the Job's status. The "
555 "primary status is reflected in the inherited "
556 "OperationalStatus property. JobStatus provides additional, "
557 "implementation-specific details."),
558 ModelCorrespondence {
559 "CIM_ManagedSystemElement.OperationalStatus" }]
560 string JobStatus;
561
562 [Description (
563 "The time that the Job was submitted to execute. A value of "
564 "all zeroes indicates that the owning element is not capable "
565 "of reporting a date and time. Therefore, the "
566 "ScheduledStartTime and StartTime are reported as intervals "
567 "relative to the time their values are requested.")]
568 a.dunfey 1.1 datetime TimeSubmitted;
569
570 [Deprecated { "CIM_Job.RunMonth", "CIM_Job.RunDay",
571 "CIM_Job.RunDayOfWeek", "CIM_Job.RunStartInterval" }, Write,
572 Description (
573 "The time that the current Job is scheduled to start. This "
574 "may be represented by the actual date and time, or an "
575 "interval relative to the time that this property is "
576 "requested. A value of all zeroes indicates that the Job is "
577 "already executing. The property is deprecated in lieu of "
578 "the more expressive scheduling properties, RunMonth, "
579 "RunDay, RunDayOfWeek and RunStartInterval.")]
580 datetime ScheduledStartTime;
581
582 [Description (
583 "The time that the Job was actually started. This may be "
584 "represented by an actual date and time, or by an interval "
585 "relative to the time that this property is requested. Note "
586 "that this property is also present in the "
587 "JobProcessingStatistics class. This is necessary to capture "
588 "the processing information for recurring Jobs, since only "
589 a.dunfey 1.1 "the 'last' run time can be stored in this single-valued "
590 "property.")]
591 datetime StartTime;
592
593 [Description (
594 "The time interval that the Job has been executing or the "
595 "total execution time if the Job is complete. Note that this "
596 "property is also present in the JobProcessingStatistics "
597 "class. This is necessary to capture the processing "
598 "information for recurring Jobs, since only the 'last' run "
599 "time can be stored in this single-valued property.")]
600 datetime ElapsedTime;
601
602 [Write, Description (
603 "Number of times that the Job should be run. A value of 1 "
604 "indicates that the Job is NOT recurring, while any non-zero "
605 "value indicates a limit to the number of times that the Job "
606 "will recur. Zero indicates that there is no limit to the "
607 "number of times that the Job can be processed, but that it "
608 "is terminated either AFTER the UntilTime, or by manual "
609 "intervention. By default, a Job is processed once.")]
610 a.dunfey 1.1 uint32 JobRunTimes = 1;
611
612 [Write, Description (
613 "The month during which the Job should be processed. Specify "
614 "0 for January, 1 for February, and so on."),
615 ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "8", "9",
616 "10", "11" },
617 Values { "January", "February", "March", "April", "May", "June",
618 "July", "August", "September", "October", "November",
619 "December" },
620 ModelCorrespondence { "CIM_Job.RunDay", "CIM_Job.RunDayOfWeek",
621 "CIM_Job.RunStartInterval" }]
622 uint8 RunMonth;
623
624 [Write, Description (
625 "The day in the month on which the Job should be processed. "
626 "There are two different interpretations for this property, "
627 "depending on the value of DayOfWeek. In one case, RunDay "
628 "defines the day-in-month on which the Job is processed. "
629 "This interpretation is used when the DayOfWeek is 0. A "
630 "positive or negative integer indicates whether the RunDay "
631 a.dunfey 1.1 "should be calculated from the beginning or the end of the "
632 "month. For example, 5 indicates the fifth day in RunMonth "
633 "and -1 indicates the last day in the RunMonth. \n"
634 "\n"
635 "When RunDayOfWeek is not 0, RunDay is the day-in-month on "
636 "which the Job is processed, defined in conjunction with "
637 "RunDayOfWeek. For example, if RunDay is 15 and RunDayOfWeek "
638 "is Saturday, then the Job is processed on the first "
639 "Saturday on or AFTER the 15th day in the RunMonth (e.g., "
640 "the third Saturday in the month). If RunDay is 20 and "
641 "RunDayOfWeek is -Saturday, then this indicates the first "
642 "Saturday on or BEFORE the 20th day in the RunMonth. If "
643 "RunDay is -1 and RunDayOfWeek is -Sunday, then this "
644 "indicates the last Sunday in the RunMonth."),
645 MinValue ( -31 ), MaxValue ( 31 ),
646 ModelCorrespondence { "CIM_Job.RunMonth",
647 "CIM_Job.RunDayOfWeek", "CIM_Job.RunStartInterval" }]
648 sint8 RunDay;
649
650 [Write, Description (
651 "Positive or negative integer used in conjunction with "
652 a.dunfey 1.1 "RunDay to indicate the day of the week on which the Job is "
653 "processed. RunDayOfWeek is set to 0 to indicate an exact "
654 "day of the month, such as March 1. A positive integer "
655 "(representing Sunday, Monday, ..., Saturday) means that the "
656 "day of week is found on or AFTER the specified RunDay. A "
657 "negative integer (representing -Sunday, -Monday, ..., "
658 "-Saturday) means that the day of week is found on or BEFORE "
659 "the RunDay."),
660 ValueMap { "-7", "-6", "-5", "-4", "-3", "-2", "-1", "0", "1",
661 "2", "3", "4", "5", "6", "7" },
662 Values { "-Saturday", "-Friday", "-Thursday", "-Wednesday",
663 "-Tuesday", "-Monday", "-Sunday", "ExactDayOfMonth",
664 "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday",
665 "Friday", "Saturday" },
666 ModelCorrespondence { "CIM_Job.RunMonth", "CIM_Job.RunDay",
667 "CIM_Job.RunStartInterval" }]
668 sint8 RunDayOfWeek;
669
670 [Write, Description (
671 "The time interval after midnight when the Job should be "
672 "processed. For example, \n"
673 a.dunfey 1.1 "00000000020000.000000:000 \n"
674 "indicates that the Job should be run on or after two "
675 "o'clock, local time or UTC time (distinguished using the "
676 "LocalOrUtcTime property."),
677 ModelCorrespondence { "CIM_Job.RunMonth", "CIM_Job.RunDay",
678 "CIM_Job.RunDayOfWeek", "CIM_Job.RunStartInterval" }]
679 datetime RunStartInterval;
680
681 [Write, Description (
682 "This property indicates whether the times represented in "
683 "the RunStartInterval and UntilTime properties represent "
684 "local times or UTC times. Time values are synchronized "
685 "worldwide by using the enumeration value 2, \"UTC Time\"."),
686 ValueMap { "1", "2" },
687 Values { "Local Time", "UTC Time" }]
688 uint16 LocalOrUtcTime;
689
690 [Write, Description (
691 "The time after which the Job is invalid or should be "
692 "stopped. This may be represented by an actual date and "
693 "time, or by an interval relative to the time that this "
694 a.dunfey 1.1 "property is requested. A value of all nines indicates that "
695 "the Job can run indefinitely."),
696 ModelCorrespondence { "CIM_Job.LocalOrUtcTime" }]
697 datetime UntilTime;
698
699 [Write, Description (
700 "User to be notified upon the Job completion or failure.")]
701 string Notify;
702
703 [Description (
704 "The User that submitted the Job or the Service/method "
705 "name/etc. that caused the job to be created."),
706 ModelCorrespondence { "CIM_OwningJobElement" }]
707 string Owner;
708
709 [Write, Description (
710 "Indicates the urgency or importance of execution of the "
711 "Job. The lower the number, the higher the priority. Note "
712 "that this property is also present in the "
713 "JobProcessingStatistics class. This is necessary to capture "
714 "the setting information that would influence a Job's "
715 a.dunfey 1.1 "results.")]
716 uint32 Priority;
717
718 [Description (
719 "The percentage of the job that has completed at the time "
720 "that this value is requested. Note that this property is "
721 "also present in the JobProcessingStatistics class. This is "
722 "necessary to capture the processing information for "
723 "recurring Jobs, since only the 'last' run data can be "
724 "stored in this single-valued property. \n"
725 "Note that the value 101 is undefined and will be not be "
726 "allowed in the next major revision of the specification."),
727 Units ( "Percent" ), MinValue ( 0 ), MaxValue ( 101 )]
728 uint16 PercentComplete;
729
730 [Write, Description (
731 "Indicates whether or not the job should be automatically "
732 "deleted upon completion. Note that the 'completion' of a "
733 "recurring job is defined by its JobRunTimes or UntilTime "
734 "properties, OR when the Job is terminated by manual "
735 "intervention. If this property is set to false and the job "
736 a.dunfey 1.1 "completes, then the extrinsic method DeleteInstance MUST be "
737 "used to delete the job versus updating this property.")]
738 boolean DeleteOnCompletion;
739
740 [Description (
741 "A vendor specific error code. This MUST be set to zero if "
742 "the Job completed without error. Note that this property is "
743 "also present in the JobProcessingStatistics class. This is "
744 "necessary to capture the processing information for "
745 "recurring Jobs, since only the 'last' run error can be "
746 "stored in this single-valued property."),
747 ModelCorrespondence { "CIM_Job.ErrorDescription" }]
748 uint16 ErrorCode;
749
750 [Description (
751 "A free form string containing the vendor error description. "
752 "Note that this property is also present in the "
753 "JobProcessingStatistics class. This is necessary to capture "
754 "the processing information for recurring Jobs, since only "
755 "the 'last' run error can be stored in this single-valued "
756 "property."),
757 a.dunfey 1.1 ModelCorrespondence { "CIM_Job.ErrorCode" }]
758 string ErrorDescription;
759
760 [Description (
761 "Describes the recovery action to be taken for an "
762 "unsuccessfully run Job. The possible values are: \n"
763 "0 = \"Unknown\", meaning it is unknown as to what recovery "
764 "action to take \n"
765 "1 = \"Other\", indicating that the recovery action will be "
766 "specified in the property, OtherRecoveryAction \n"
767 "2 = \"Do Not Continue\", meaning stop the execution of the "
768 "job and appropriately update its status \n"
769 "3 = \"Continue With Next Job\", meaning continue with the "
770 "next job in the queue \n"
771 "4 = \"Re-run Job\", indicating that the job should be "
772 "re-run \n"
773 "5 = \"Run Recovery Job\", meaning run the Job associated "
774 "using the RecoveryJob relationship. Note that the recovery "
775 "Job MUST already be on the queue from which it will run."),
776 ValueMap { "0", "1", "2", "3", "4", "5" },
777 Values { "Unknown", "Other", "Do Not Continue",
778 a.dunfey 1.1 "Continue With Next Job", "Re-run Job", "Run Recovery Job" },
779 ModelCorrespondence { "CIM_Job.OtherRecoveryAction" }]
780 uint16 RecoveryAction;
781
782 [Description (
783 "A string describing the recovery action when the instance's "
784 "RecoveryAction property is 1 (\"Other\")."),
785 ModelCorrespondence { "CIM_Job.RecoveryAction" }]
786 string OtherRecoveryAction;
787
788 [Deprecated { "CIM_ConcreteJob.RequestStateChange()" },
789 Description (
790 "KillJob is being deprecated because there is no distiction "
791 "made between an orderly shutdown and an immediate kill. "
792 "CIM_ConcreteJob.RequestStateChange() provides 'Terminate' "
793 "and 'Kill' options to allow this distinction. \n"
794 "A method to kill this job and any underlying processes, and "
795 "to remove any 'dangling' associations."),
796 ValueMap { "0", "1", "2", "3", "4", "6", "7", "..",
797 "32768..65535" },
798 Values { "Success", "Not Supported", "Unknown", "Timeout",
799 a.dunfey 1.1 "Failed", "Access Denied", "Not Found", "DMTF Reserved",
800 "Vendor Specific" }]
801 uint32 KillJob(
802 [IN, Description (
803 "Indicates whether or not the Job should be automatically "
804 "deleted upon termination. This parameter takes "
805 "precedence over the property, DeleteOnCompletion.")]
806 boolean DeleteOnKill);
807
808 };
809
810
811 // ===================================================================
812 // ConcreteJob
813 // ===================================================================
814 [Version ( "2.9.0" ), Description (
815 "A concrete version of Job. This class represents a generic and "
816 "instantiable unit of work, such as a batch or a print job.")]
817 class CIM_ConcreteJob : CIM_Job {
818
819 [Key, Description (
820 a.dunfey 1.1 "Within the scope of the instantiating Namespace, InstanceID "
821 "opaquely and uniquely identifies an instance of this class. "
822 "In order to ensure uniqueness within the NameSpace, the "
823 "value of InstanceID SHOULD be constructed using the "
824 "following 'preferred' algorithm: \n"
825 "<OrgID>:<LocalID> \n"
826 "Where <OrgID> and <LocalID> are separated by a colon ':', "
827 "and where <OrgID> MUST include a copyrighted, trademarked "
828 "or otherwise unique name that is owned by the business "
829 "entity creating/defining the InstanceID, or is a registered "
830 "ID that is assigned to the business entity by a recognized "
831 "global authority (This is similar to the <Schema "
832 "Name>_<Class Name> structure of Schema class names.) In "
833 "addition, to ensure uniqueness <OrgID> MUST NOT contain a "
834 "colon (':'). When using this algorithm, the first colon to "
835 "appear in InstanceID MUST appear between <OrgID> and "
836 "<LocalID>. \n"
837 "<LocalID> is chosen by the business entity and SHOULD not "
838 "be re-used to identify different underlying (real-world) "
839 "elements. If the above 'preferred' algorithm is not used, "
840 "the defining entity MUST assure that the resultant "
841 a.dunfey 1.1 "InstanceID is not re-used across any InstanceIDs produced "
842 "by this or other providers for this instance's NameSpace. \n"
843 "For DMTF defined instances, the 'preferred' algorithm MUST "
844 "be used with the <OrgID> set to 'CIM'.")]
845 string InstanceID;
846
847 [Required, Override ( "Name" ), Description (
848 "The user friendly name for this instance of Job. In "
849 "addition, the user friendly name can be used as a property "
850 "for a search or query. (Note: Name does not have to be "
851 "unique within a namespace.)")]
852 string Name;
853
854 [Description (
855 "JobState is an integer enumeration that indicates the "
856 "operational state of a Job. It can also indicate "
857 "transitions between these states, for example, 'Shutting "
858 "Down' and 'Starting'. Following is a brief description of "
859 "the states: \n"
860 "New (2) indicates that the job has never been started. \n"
861 "Starting (3) indicates that the job is moving from the "
862 a.dunfey 1.1 "'New', 'Suspended', or 'Service' states into the 'Running' "
863 "state. \n"
864 "Running (4) indicates that the Job is running. \n"
865 "Suspended (5) indicates that the Job is stopped, but may be "
866 "restarted in a seamless manner. \n"
867 "Shutting Down (6) indicates the job is moving to a "
868 "'Completed', 'Terminated', or 'Killed' state. \n"
869 "Completed (7) indicates that the job has completed "
870 "normally. \n"
871 "Terminated (8) indicates that the job has been stopped by a "
872 "'Terminate' state change request. The job and all its "
873 "underlying processes are ended and may be restarted (this "
874 "is job-specific) only as a new job. \n"
875 "Killed (9) indicates that the job has been stopped by a "
876 "'Kill' state change request. Underlying processes may have "
877 "been left running and cleanup may be required to free up "
878 "resources. \n"
879 "Exception (10) indicates that the Job is in an abnormal "
880 "state that may be indicative of an error condition. Actual "
881 "status may be surfaced though job-specific objects. \n"
882 "Service (11) indicates that the Job is in a vendor-specific "
883 a.dunfey 1.1 "state that supports problem discovery and/or resolution."),
884 ValueMap { "2", "3", "4", "5", "6", "7", "8", "9", "10", "11",
885 "12..32767", "32768..65535" },
886 Values { "New", "Starting", "Running", "Suspended",
887 "Shutting Down", "Completed", "Terminated", "Killed",
888 "Exception", "Service", "DMTF Reserved", "Vendor Reserved" }]
889 uint16 JobState;
890
891 [Description (
892 "The date/time when the Job's State last changed. If the "
893 "state of the Job has not changed and this property is "
894 "populated, then it MUST be set to a 0 interval value. If a "
895 "state change was requested, but rejected or not yet "
896 "processed, the property MUST NOT be updated.")]
897 datetime TimeOfLastStateChange;
898
899 [Description (
900 "Requests that the job's state be changed to the value "
901 "specified in the RequestedState parameter. Invoking the "
902 "RequestStateChange method multiple times could result in "
903 "earlier requests being overwritten/lost. \n"
904 a.dunfey 1.1 "If 0 is returned, then the task completed successfully. Any "
905 "other return code indicates an error condition."),
906 ValueMap { "0", "1", "2", "3", "4", "5", "6", "..", "4096",
907 "4097", "4098", "4099", "4100..32767", "32768..65535" },
908 Values { "Completed with No Error", "Not Supported",
909 "Unknown/Unspecified Error",
910 "Can NOT complete within Timeout Period", "Failed",
911 "Invalid Parameter", "In Use", "DMTF Reserved",
912 "Method Parameters Checked - Transition Started",
913 "Invalid State Transition",
914 "Use of Timeout Parameter Not Supported", "Busy",
915 "Method Reserved", "Vendor Specific" }]
916 uint32 RequestStateChange(
917 [IN, Description (
918 "Changes the state of a job. \n"
919 "Start (2) changes the state to 'Running'. \n"
920 "Suspend (3) stops the job temporarily. The intention is "
921 "to subsequently restart the job with 'Start'. It may be "
922 "possible to enter the 'Service' state while suspended - "
923 "this is job-specific. \n"
924 "Terminate (4) stops the job cleanly, saving data, "
925 a.dunfey 1.1 "preserving state, and shutting down all underlying "
926 "processes in an orderly manner. \n"
927 "Kill (5) terminates the job immediately with no "
928 "requirement to save data or preserve state. Service (6) "
929 "puts the job into a vendor-specific service state. The "
930 "job may be able to be restarted."),
931 ValueMap { "2", "3", "4", "5", "6", "7..32767",
932 "32768..65535" },
933 Values { "Start", "Suspend", "Terminate", "Kill", "Service",
934 "DMTF Reserved", "Vendor Reserved" }]
935 uint16 RequestedState,
936 [IN, Description (
937 "A timeout period that specifies the maximum amount of "
938 "time that the client expects the transition to the new "
939 "state to take. The interval format MUST be used to "
940 "specify the TimeoutPeriod. A value of 0 or a null "
941 "parameter indicates that the client has no time "
942 "requirements for the transition. \n"
943 "If this property does not contain 0 or null and the "
944 "implementation doesn't support this parameter. A return "
945 "code of 'Use Of Timeout Parameter Not Supported' MUST be "
946 a.dunfey 1.1 "returned.")]
947 datetime TimeoutPeriod);
948
949 [Required, Description (
950 "The amount of time the Job is retained after it has "
951 "finished executing, either succeeding or failing in that "
952 "execution. The job MUST remain in existence for some period "
953 "of time regardless of the value of the DeleteOnCompletion "
954 "property. \n"
955 "The default is five minutes.") ,
956 Write(true)]
957 datetime TimeBeforeRemoval = "00000000000500.000000:000";
958
959 };
960
961
962 // ==================================================================
963 // EnabledLogicalElement
964 // ==================================================================
965 [Abstract, Version ( "2.8.0" ), Description (
966 "This class extends LogicalElement to abstract the concept of "
967 a.dunfey 1.1 "an element that is enabled and disabled, such as a "
968 "LogicalDevice or a ServiceAccessPoint.")]
969 class CIM_EnabledLogicalElement : CIM_LogicalElement {
970
971 [Description (
972 "EnabledState is an integer enumeration that indicates the "
973 "enabled/disabled states of an element. It can also indicate "
974 "the transitions between these requested states. For "
975 "example, shutting down (value = 4) and starting (value=10) "
976 "are transient states between enabled and disabled. The "
977 "following text briefly summarizes the various "
978 "enabled/disabled states: \n"
979 "Enabled (2) indicates that the element is/could be "
980 "executing commands, will process any queued commands, and "
981 "queues new requests. \n"
982 "Disabled (3) indicates that the element will not execute "
983 "commands and will drop any new requests. \n"
984 "Shutting Down (4) indicates that the element is in the "
985 "process of going to a Disabled state. \n"
986 "Not Applicable (5) indicates the element doesn't support "
987 "being enabled/disabled. \n"
988 a.dunfey 1.1 "Enabled but Offline (6) indicates that the element may be "
989 "completing commands, and will drop any new requests. \n"
990 "Test (7) indicates that the element is in a test state. \n"
991 "Deferred (8) indicates that the element may be completing "
992 "commands, but will queue any new requests. \n"
993 "Quiesce (9) indicates that the element is enabled but in a "
994 "restricted mode. The element's behavior is similar to the "
995 "Enabled state, but it only processes a restricted set of "
996 "commands. All other requests are queued. \n"
997 "Starting (10) indicates that the element is in the process "
998 "of going to an Enabled state. New requests are queued."),
999 ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "8", "9",
1000 "10", "11..32767", "32768..65535" },
1001 Values { "Unknown", "Other", "Enabled", "Disabled",
1002 "Shutting Down", "Not Applicable", "Enabled but Offline",
1003 "In Test", "Deferred", "Quiesce", "Starting",
1004 "DMTF Reserved", "Vendor Reserved" },
1005 ModelCorrespondence {
1006 "CIM_EnabledLogicalElement.OtherEnabledState" }]
1007 uint16 EnabledState = 5;
1008
1009 a.dunfey 1.1 [Description (
1010 "A string describing the element's enabled/disabled state "
1011 "when the EnabledState property is set to 1 (\"Other\"). "
1012 "This property MUST be set to NULL when EnabledState is any "
1013 "value other than 1."),
1014 ModelCorrespondence { "CIM_EnabledLogicalElement.EnabledState" }]
1015 string OtherEnabledState;
1016
1017 [Description (
1018 "RequestedState is an integer enumeration indicating the "
1019 "last requested or desired state for the element. The actual "
1020 "state of the element is represented by EnabledState. This "
1021 "property is provided to compare the last requested and "
1022 "current enabled/disabled states. Note that when "
1023 "EnabledState is set to 5 (\"Not Applicable\"), then this "
1024 "property has no meaning. By default, the element's "
1025 "RequestedState is 5 (\"No Change\"). Refer to the "
1026 "EnabledState's property Description for explanations of the "
1027 "values in the RequestedState enumeration. \n"
1028 "\n"
1029 "It should be noted that there are two new values in "
1030 a.dunfey 1.1 "RequestedState that build on the statuses of EnabledState. "
1031 "These are \"Reboot\" (10) and \"Reset\" (11). The former, "
1032 "Reboot, refers to doing a \"Shut Down\" and then moving to "
1033 "an \"Enabled\" state. The latter, Reset, indicates that the "
1034 "element is first \"Disabled\" and then \"Enabled\". The "
1035 "distinction between requesting \"Shut Down\" and "
1036 "\"Disabled\" should also be noted. The former, Shut Down, "
1037 "requests an orderly transition to the Disabled state, and "
1038 "MAY involve removing power, to completely erase any "
1039 "existing state. The latter, the Disabled state, requests an "
1040 "immediate disabling of the element, such that it will not "
1041 "execute or accept any commands or processing requests. \n"
1042 "\n"
1043 "This property is set as the result of a method invocation "
1044 "(such as Start or StopService on CIM_Service), or may be "
1045 "overridden and defined as WRITEable in a subclass. The "
1046 "method approach is considered superior to a WRITEable "
1047 "property, since it allows an explicit invocation of the "
1048 "operation and the return of a result code."),
1049 ValueMap { "2", "3", "4", "5", "6", "7", "8", "9", "10", "11",
1050 "..", "32768..65535" },
1051 a.dunfey 1.1 Values { "Enabled", "Disabled", "Shut Down", "No Change",
1052 "Offline", "Test", "Deferred", "Quiesce", "Reboot", "Reset",
1053 "DMTF Reserved", "Vendor Reserved" },
1054 ModelCorrespondence { "CIM_EnabledLogicalElement.EnabledState" }]
1055 uint16 RequestedState = 5;
1056
1057 [Write, Description (
1058 "An enumerated value indicating an administrator's "
1059 "default/startup configuration for an element's Enabled "
1060 "State. By default, the element is \"Enabled\" (value=2)."),
1061 ValueMap { "2", "3", "5", "6", "7", "8..32767", "32768..65535" },
1062 Values { "Enabled", "Disabled", "Not Applicable",
1063 "Enabled but Offline", "No Default", "DMTF Reserved",
1064 "Vendor Reserved" }]
1065 uint16 EnabledDefault = 2;
1066
1067 [Description (
1068 "The date/time when the element's EnabledState last changed. "
1069 "If the state of the element has not changed and this "
1070 "property is populated, then it MUST be set to a 0 interval "
1071 "value. If a state change was requested, but rejected or not "
1072 a.dunfey 1.1 "yet processed, the property MUST NOT be updated.")]
1073 datetime TimeOfLastStateChange;
1074
1075 [Description (
1076 "Requests that the element's state be changed to the value "
1077 "specified in the RequestedState parameter. When the "
1078 "requested state change takes place, the element's "
1079 "EnabledState and RequestedState will be the same. Invoking "
1080 "the RequestStateChange method multiple times could result "
1081 "in earlier requests being overwritten/lost. \n"
1082 "If 0 is returned, then the task completed successfully and "
1083 "the use of ConcreteJob was not required. If 4096 (0x1000) "
1084 "is returned, then the task will take some time to complete, "
1085 "ConcreteJob will be created, and its reference returned in "
1086 "the output parameter Job. Any other return code indicates "
1087 "an error condition."),
1088 ValueMap { "0", "1", "2", "3", "4", "5", "6", "..", "4096",
1089 "4097", "4098", "4099", "4100..32767", "32768..65535" },
1090 Values { "Completed with No Error", "Not Supported",
1091 "Unknown/Unspecified Error",
1092 "Can NOT complete within Timeout Period", "Failed",
1093 a.dunfey 1.1 "Invalid Parameter", "In Use", "DMTF Reserved",
1094 "Method Parameters Checked - Job Started",
1095 "Invalid State Transition",
1096 "Use of Timeout Parameter Not Supported", "Busy",
1097 "Method Reserved", "Vendor Specific" },
1098 ModelCorrespondence { "CIM_EnabledLogicalElement.RequestedState"
1099 }]
1100 uint32 RequestStateChange(
1101 [IN, Description (
1102 "The state requested for the element. This information "
1103 "will be placed into the instance's RequestedState "
1104 "property if the RequestStateChange method's return code "
1105 "is 0, 3, or 4096 (0x1000) - 'Completed with No Error', "
1106 "'Timeout', or 'Job Started' respectively. Refer to the "
1107 "description of the EnabledState and RequestedState "
1108 "properties for the detailed meanings of the "
1109 "RequestedState values."),
1110 ValueMap { "2", "3", "4", "6", "7", "8", "9", "10", "11",
1111 "..", "32768..65535" },
1112 Values { "Enabled", "Disabled", "Shut Down", "Offline",
1113 "Test", "Defer", "Quiesce", "Reboot", "Reset",
1114 a.dunfey 1.1 "DMTF Reserved", "Vendor Reserved" },
1115 ModelCorrespondence {
1116 "CIM_EnabledLogicalElement.RequestedState" }]
1117 uint16 RequestedState,
1118 [IN ( false ), OUT, Description (
1119 "Reference to the job (may be null if task completed).")]
1120 CIM_ConcreteJob REF Job,
1121 [IN, Description (
1122 "A timeout period that specifies the maximum amount of "
1123 "time that the client expects the transition to the new "
1124 "state to take. The interval format MUST be used to "
1125 "specify the TimeoutPeriod. A value of 0 or a null "
1126 "parameter indicates that the client has no time "
1127 "requirements for the transition. \n"
1128 "If this property does not contain 0 or null and the "
1129 "implementation doesn't support this parameter. A return "
1130 "code of 'Use Of Timeout Parameter Not Supported' MUST be "
1131 "returned.")]
1132 datetime TimeoutPeriod);
1133 };
1134
1135 a.dunfey 1.1
1136 // ==================================================================
1137 // Synchronized
1138 // ==================================================================
1139 [Association, Version ( "2.8.0" ), Description (
1140 "Indicates that two ManagedElements were aligned or made to be "
1141 "equivalent at the specified point in time. If the boolean "
1142 "property SyncMaintained is TRUE, then synchronization of the "
1143 "Elements is preserved. Both like and unlike objects may be "
1144 "synchronized. For example, two WatchDog timers may be aligned, "
1145 "or the contents of a LogicalFile may be synchronized with the "
1146 "contents of a StorageExtent.")]
1147 class CIM_Synchronized {
1148
1149 [Key, Description (
1150 "SystemElement represents one ManagedElement that is "
1151 "synchronized with the entity referenced as SyncedElement.")]
1152 CIM_ManagedElement REF SystemElement;
1153
1154 [Key, Description (
1155 "SyncedElement represents another ManagedElement that is "
1156 a.dunfey 1.1 "synchronized with the entity referenced as SystemElement.")]
1157 CIM_ManagedElement REF SyncedElement;
1158
1159 [Description (
1160 "The point in time that the Elements were synchronized.")]
1161 datetime WhenSynced;
1162
1163 [Description (
1164 "Boolean indicating whether synchronization is maintained.")]
1165 boolean SyncMaintained;
1166 };
1167
1168
1169 // ==================================================================
1170 // System
1171 // ==================================================================
1172 [Abstract, Version ( "2.7.0" ), Description (
1173 "CIM_System represents an entity made up of component parts "
1174 "(defined by the SystemComponent relationship), that operates "
1175 "as a 'functional whole'. Systems are top level objects in the "
1176 "CIM hierarchy, requiring no scoping or weak relationships in "
1177 a.dunfey 1.1 "order to exist and have context. It should be reasonable to "
1178 "uniquely name and manage a System at an enterprise level. For "
1179 "example, a ComputerSystem is a kind of System that can be "
1180 "uniquely named and independently managed in an enterprise. "
1181 "However, this is not true for the power supply (or the power "
1182 "supply sub-'system') within the computer. \n"
1183 "\n"
1184 "Although a System may be viewed as a Collection, this is not "
1185 "the correct model. A Collection is simply a 'bag' that 'holds' "
1186 "its members. A System is a higher level abstraction, built out "
1187 "of its individual components. It is more than a sum of its "
1188 "parts. Note that System is a subclass of EnabledLogicalElement "
1189 "which allows the entire abstraction to be functionally "
1190 "enabled/disabled - at a higher level than enabling/disabling "
1191 "its component parts.")]
1192 class CIM_System : CIM_EnabledLogicalElement {
1193
1194 [Key, Description (
1195 "CreationClassName indicates the name of the class or the "
1196 "subclass used in the creation of an instance. When used "
1197 "with the other key properties of this class, this property "
1198 a.dunfey 1.1 "allows all instances of this class and its subclasses to be "
1199 "uniquely identified."),
1200 MaxLen ( 256 )]
1201 string CreationClassName;
1202
1203 [Key, Override ( "Name" ), Description (
1204 "The inherited Name serves as key of a System instance in an "
1205 "enterprise environment."),
1206 MaxLen ( 256 )]
1207 string Name;
1208
1209 [Description (
1210 "The System object and its derivatives are Top Level Objects "
1211 "of CIM. They provide the scope for numerous components. "
1212 "Having unique System keys is required. A heuristic can be "
1213 "defined in individual System subclasses to attempt to "
1214 "always generate the same System Name Key. The NameFormat "
1215 "property identifies how the System name was generated, "
1216 "using the subclass' heuristic."),
1217 MaxLen ( 64 )]
1218 string NameFormat;
1219 a.dunfey 1.1
1220 [Write, Description (
1221 "The name of the primary system owner. The system owner is "
1222 "the primary user of the system."),
1223 MaxLen ( 64 ),
1224 MappingStrings { "MIF.DMTF|General Information|001.3" }]
1225 string PrimaryOwnerName;
1226
1227 [Write, Description (
1228 "A string that provides information on how the primary "
1229 "system owner can be reached (e.g. phone number, email "
1230 "address, ...)."),
1231 MaxLen ( 256 ),
1232 MappingStrings { "MIF.DMTF|General Information|001.4" }]
1233 string PrimaryOwnerContact;
1234
1235 [Write, Description (
1236 "An array (bag) of strings that specify the administrator "
1237 "-defined roles this System plays in the managed "
1238 "environment. Examples might be 'Building 8 print server' or "
1239 "'Boise user directories'. A single system may perform "
1240 a.dunfey 1.1 "multiple roles. \n"
1241 "Note that instrumentation's view of a System's 'roles' is "
1242 "defined by instantiating a specific subclass of System and/ "
1243 "or by properties in a subclass. For example, a "
1244 "ComputerSystem's purpose is defined using the Dedicated and "
1245 "OtherDedicatedDescription properties.")]
1246 string Roles[];
1247 };
1248
1249
1250 // ==================================================================
1251 // SystemComponent
1252 // ==================================================================
1253 [Association, Aggregation, Version ( "2.7.0" ), Description (
1254 "CIM_SystemComponent is a specialization of the CIM_Component "
1255 "association that establishes 'part of' relationships between a "
1256 "System and any ManagedSystemElements of which it is composed. "
1257 "\nThe use of this association is cautioned - versus the use of "
1258 "a subclass such as SystemDevice, or a peer association such as "
1259 "HostedService. This class is very broadly defined which can "
1260 "lead to erroneous use. For example, Access Points that are "
1261 a.dunfey 1.1 "dependent on (and hosted on) a System are NOT Components of "
1262 "the System. The System is not made up of any AccessPoint "
1263 "'parts', which is why a Dependency association, "
1264 "HostedAccessPoint, was defined. Similarly, a PhysicalPackage "
1265 "is not a 'part' of a System, since the physical element exists "
1266 "independently of any internal components, software, etc. In "
1267 "fact, again, a Dependency relationship is true - where a "
1268 "ComputerSystem is Dependent on its packaging, as described by "
1269 "the ComputerSystemPackage association.")]
1270 class CIM_SystemComponent : CIM_Component {
1271
1272 [Aggregate, Override ( "GroupComponent" ), Description (
1273 "The parent System in the Association.")]
1274 CIM_System REF GroupComponent;
1275
1276 [Override ( "PartComponent" ), Description (
1277 "The child element that is a component of a System.")]
1278 CIM_ManagedSystemElement REF PartComponent;
1279 };
1280
1281
1282 a.dunfey 1.1 // ==================================================================
1283 // AdminDomain
1284 // ==================================================================
1285
1286 [Version ( "2.8.0" ), Description (
1287 "This is a special grouping of ManagedSystemElements. The "
1288 "grouping is viewed as a single entity, reflecting that all of "
1289 "its components are administered similarly - either by the same "
1290 "user, group of users or policy. It serves as an aggregation "
1291 "point to associate one or more of the following elements: "
1292 "network devices, such as routers and switches, servers, and "
1293 "other resources that can be accessed by end systems. This "
1294 "grouping of devices plays an essential role in ensuring that "
1295 "the same administrative policy and actions are applied to all "
1296 "of the devices in the grouping. The specific behavior and/or "
1297 "semantics of the AdminDomain can be identified through its "
1298 "aggregated and associated entities.")]
1299 class CIM_AdminDomain : CIM_System {
1300
1301 [Override ( "NameFormat" ), Description (
1302 "The NameFormat property identifies how the Name of the "
1303 a.dunfey 1.1 "AdminDomain is generated, using the heuristic specified in "
1304 "the CIM V2 System Model spec. It assumes that the "
1305 "documented rules are traversed in order, to determine and "
1306 "assign a Name. The NameFormat Values list defines the "
1307 "precedence order for assigning the Name of the AdminDomain. "
1308 "\n\n"
1309 "\"FC\" has been deprecated and replaced by \"WWN\" to be "
1310 "consistent with the other ValueMaps."),
1311 ValueMap { "Other", "AS", "NAP", "NOC", "POP", "RNP", "IP",
1312 "IPX", "SNA", "Dial", "WAN", "LAN", "ISDN", "Frame Relay",
1313 "ATM", "E.164", "IB", "FC", "Policy Repository", "WWN" },
1314 Values { "Other", "Autonomous System",
1315 "Network Access Provider", "Network Operations Center",
1316 "Point of Presence", "Regional Network Provider", "IP",
1317 "IPX", "SNA", "Dial", "WAN", "LAN", "ISDN", "Frame Relay",
1318 "ATM", "E.164", "Infiniband", "Fibre Channel",
1319 "Policy Repository", "Fibre Channel Worldwide Name" },
1320 ModelCorrespondence { "CIM_AdminDomain.Name" }]
1321 string NameFormat;
1322 };
1323
1324 a.dunfey 1.1
1325 // ==================================================================
1326 // ContainedDomain
1327 // ==================================================================
1328 [Association, Aggregation, Version ( "2.6.0" ), Description (
1329 "A relationship that aggregates one or more lower-level "
1330 "AdminDomain instances into a higher-level AdminDomain.")]
1331 class CIM_ContainedDomain : CIM_SystemComponent {
1332
1333 [Aggregate, Override ( "GroupComponent" ), Description (
1334 "An AdminDomain that aggregates other AdminDomains.")]
1335 CIM_AdminDomain REF GroupComponent;
1336
1337 [Override ( "PartComponent" ), Description (
1338 "An AdminDomain aggregated by another AdminDomain.")]
1339 CIM_AdminDomain REF PartComponent;
1340 };
1341
1342
1343
1344
1345 a.dunfey 1.1 // ===================================================================
1346 // end of file
1347 // ===================================================================
|
Return to
Core_CoreElements.mof
CVS log
Up to [Pegasus] / pegasus / Schemas / CIM29