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