1 a.dunfey 1.1 // ===================================================================
2 // Title: Core_Service
3 // $State: Exp $
4 // $Date: 2004/11/29 18:31:42 $
5 // $RCSfile: Core_Service.mof,v $
6 // $Revision: 1.8.2.3 $
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 a Help Service
48 //
49 // The object classes below are listed in an order that
50 // avoids forward references. Required objects, defined
51 // by other working groups, are omitted.
52 // ==================================================================
53 // Change Log for v2.8 Final
54 // CR1205 - Update ProtocolIFType definitions to match latest
55 // IANAifType-MIB definitions
56 // CR1210 - Removal of experimental Qualifiers for core.
57 //
58 // Change Log for v2.8 Preliminary
59 // CR1092 - Move Service and SAP related classes to their own file
60 // CR1124 - Add CIM_SAPAvailableForElement
61 // CR1128 - Addition of HostedDependency
62 // ==================================================================
63
64 a.dunfey 1.1 #pragma locale ("en_US")
65
66 // ==================================================================
67 // Service
68 // ==================================================================
69 [Abstract, Version ( "2.7.0" ), Description (
70 "A CIM_Service is a Logical Element that contains the "
71 "information necessary to represent and manage the "
72 "functionality provided by a Device and/or SoftwareFeature. A "
73 "Service is a general-purpose object to configure and manage "
74 "the implementation of functionality. It is not the "
75 "functionality itself.")]
76 class CIM_Service : CIM_EnabledLogicalElement {
77
78 [Key, Propagated ( "CIM_System.CreationClassName" ),
79 Description (
80 "The scoping System's CreationClassName."),
81 MaxLen ( 256 )]
82 string SystemCreationClassName;
83
84 [Key, Propagated ( "CIM_System.Name" ), Description (
85 a.dunfey 1.1 "The scoping System's Name."),
86 MaxLen ( 256 )]
87 string SystemName;
88
89 [Key, Description (
90 "CreationClassName indicates the name of the class or the "
91 "subclass used in the creation of an instance. When used "
92 "with the other key properties of this class, this property "
93 "allows all instances of this class and its subclasses to be "
94 "uniquely identified."),
95 MaxLen ( 256 )]
96 string CreationClassName;
97
98 [Key, Override ( "Name" ), Description (
99 "The Name property uniquely identifies the Service and "
100 "provides an indication of the functionality that is "
101 "managed. This functionality is described in more detail in "
102 "the object's Description property."),
103 MaxLen ( 256 )]
104 string Name;
105
106 a.dunfey 1.1 [Write, Description (
107 "The name of the primary owner for the service, if one is "
108 "defined. The primary owner is the initial support contact "
109 "for the Service."),
110 MaxLen ( 64 ),
111 MappingStrings { "MIF.DMTF|General Information|001.3" }]
112 string PrimaryOwnerName;
113
114 [Write, Description (
115 "A string that provides information on how the primary owner "
116 "of the Service can be reached (e.g. phone number, email "
117 "address, ...)."),
118 MaxLen ( 256 ),
119 MappingStrings { "MIF.DMTF|General Information|001.4" }]
120 string PrimaryOwnerContact;
121
122 [Deprecated { "CIM_Service.EnabledDefault" }, Description (
123 "StartMode is a string value indicating whether the Service "
124 "is automatically started by a System, Operating System, "
125 "etc. or only started upon request. This property is "
126 "deprecated in lieu of the EnabledDefault property inherited "
127 a.dunfey 1.1 "from EnabledLogicalElement, which addresses the same "
128 "semantics. The change to a uint16 data type was discussed "
129 "when CIM V2.0 was defined. However, existing V1.0 "
130 "implementations used the string property and did not want "
131 "to modify their code. Therefore, StartMode was "
132 "grandfathered into the Schema. Use of the Deprecated "
133 "qualifier allows the maintenance of the existing property, "
134 "but also permits an improved, clarified definition using "
135 "EnabledDefault."),
136 ValueMap { "Automatic", "Manual" }, MaxLen ( 10 )]
137 string StartMode;
138
139 [Description (
140 "Started is a boolean indicating whether the Service has "
141 "been started (TRUE), or stopped (FALSE).")]
142 boolean Started;
143
144 [Description (
145 "The StartService method places the Service in the started "
146 "state. Note that this method's function overlaps with the "
147 "RequestedState property. RequestedState was added to the "
148 a.dunfey 1.1 "model to maintain a record (i.e., a persisted value) of the "
149 "last state request. Invoking the StartService method should "
150 "set the RequestedState property appropriately. The method "
151 "returns an integer value of 0 if the Service was "
152 "successfully started, 1 if the request is not supported and "
153 "any other number to indicate an error. In a subclass, the "
154 "set of possible return codes could be specified, using a "
155 "ValueMap qualifier on the method. The strings to which the "
156 "ValueMap contents are 'translated' may also be specified in "
157 "the subclass as a Values array qualifier. \n"
158 "\n"
159 "Note that this method overlaps in semantics with the "
160 "RequestStateChange method inherited from "
161 "EnabledLogicalElement. This method is maintained since it "
162 "has been widely implemented, and its simple 'start' "
163 "semantics are convenient to use.")]
164 uint32 StartService();
165
166 [Description (
167 "The StopService method places the Service in the stopped "
168 "state. Note that this method's function overlaps with the "
169 a.dunfey 1.1 "RequestedState property. RequestedState was added to the "
170 "model to maintain a record (i.e., a persisted value) of the "
171 "last state request. Invoking the StopService method should "
172 "set the RequestedState property appropriately. The method "
173 "returns an integer value of 0 if the Service was "
174 "successfully stopped, 1 if the request is not supported and "
175 "any other number to indicate an error. In a subclass, the "
176 "set of possible return codes could be specified, using a "
177 "ValueMap qualifier on the method. The strings to which the "
178 "ValueMap contents are 'translated' may also be specified in "
179 "the subclass as a Values array qualifier. \n"
180 "\n"
181 "Note that this method overlaps in semantics with the "
182 "RequestStateChange method inherited from "
183 "EnabledLogicalElement. This method is maintained since it "
184 "has been widely implemented, and its simple 'stop' "
185 "semantics are convenient to use.")]
186 uint32 StopService();
187 };
188
189
190 a.dunfey 1.1 // ==================================================================
191 // HostedService
192 // ==================================================================
193 [Association, Version ( "2.8.0" ), Description (
194 "CIM_HostedService is an association between a Service and the "
195 "System on which the functionality resides. The cardinality of "
196 "this association is 1-to-many. A System may host many "
197 "Services. Services are weak with respect to their hosting "
198 "System. Heuristic: A Service is hosted on the System where the "
199 "LogicalDevices or SoftwareFeatures that implement the Service "
200 "are located. The model does not represent Services hosted "
201 "across multiple systems. This is modeled as an "
202 "ApplicationSystem that acts as an aggregation point for "
203 "Services, that are each located on a single host.")]
204 class CIM_HostedService : CIM_HostedDependency {
205
206 [Override ( "Antecedent" ), Min ( 1 ), Max ( 1 ), Description (
207 "The hosting System.")]
208 CIM_System REF Antecedent;
209
210 [Override ( "Dependent" ), Weak, Description (
211 a.dunfey 1.1 "The Service hosted on the System.")]
212 CIM_Service REF Dependent;
213 };
214
215
216 // ==================================================================
217 // ProvidesServiceToElement
218 // ==================================================================
219 [Association, Deprecated { "CIM_ServiceAvailableToElement" },
220 Version ( "2.7.0" ), Description (
221 "The use of the CIM_ProvidesServiceToElement class has been "
222 "deprecated. Instead, ServiceAvailableToElement conveys the "
223 "semantics of 'use', while the subclasses of ProvidesService "
224 "ToElement (or the ConcreteDependency association) describe "
225 "dependency relationships. CIM_ProvidesServiceToElement was "
226 "meant to generalize the ServiceServiceDependency association. "
227 "It tried to indicate that ManagedElements may use the "
228 "functionality provided by one or more Services. An example is "
229 "that a Processor and an enclosure (a PhysicalElement) may use "
230 "AlertOnLAN Services to signal an incomplete or erroneous boot. "
231 "In reality, AlertOnLAN is simply a HostedService on a computer "
232 a.dunfey 1.1 "system that is generally 'available for 'use' and not a "
233 "dependency of the processor or enclosure. To describe that use "
234 "of the service may be restricted or have limited availability/ "
235 "applicability, then the CIM_ServiceAvailableToElement "
236 "association would be instantiated.")]
237 class CIM_ProvidesServiceToElement : CIM_Dependency {
238
239 [Deprecated { "CIM_ServiceAvailableToElement.ServiceProvided" },
240 Override ( "Antecedent" ), Description (
241 "The Service provided.")]
242 CIM_Service REF Antecedent;
243
244 [Deprecated { "CIM_ServiceAvailableToElement.UserOfService" },
245 Override ( "Dependent" ), Description (
246 "The ManagedElement dependent on the Service.")]
247 CIM_ManagedElement REF Dependent;
248 };
249
250
251 // ==================================================================
252 // ServiceAvailableToElement
253 a.dunfey 1.1 // ==================================================================
254 [Association, Version ( "2.7.0" ), Description (
255 "CIM_ServiceAvailableToElement conveys the semantics of a "
256 "Service being available for the 'use' of a ManagedElement. An "
257 "example is that a Processor and an enclosure (a "
258 "PhysicalElement) may use AlertOnLAN Services to signal an "
259 "incomplete or erroneous boot. In reality, AlertOnLAN is simply "
260 "a HostedService on a computer system that is generally "
261 "'available for use', and not a dependency of the processor or "
262 "enclosure. To describe that use of this service is restricted "
263 "or has limited availability/applicability, then the "
264 "CIM_ServiceAvailableToElement association would be "
265 "instantiated between the Service and specific CIM_Processors "
266 "and CIM_Chassis .")]
267 class CIM_ServiceAvailableToElement {
268
269 [Key, Description (
270 "The Service that is available.")]
271 CIM_Service REF ServiceProvided;
272
273 [Key, Description (
274 a.dunfey 1.1 "The ManagedElement that may use the Service.")]
275 CIM_ManagedElement REF UserOfService;
276 };
277
278
279 // ===================================================================
280 // ServiceAffectsElement
281 // ===================================================================
282 [Association, Version ( "2.7.0" ), Description (
283 "ServiceAffectsElement represents an association between a "
284 "Service and the ManagedElement(s) that may be affected by its "
285 "execution. Instantiating this association indicates that "
286 "running the service will pose some burden on the "
287 "ManagedElement that may affect performance, throughput, "
288 "availability, etc.")]
289 class CIM_ServiceAffectsElement {
290
291 [Key, Description (
292 "The Managed Element affected by the Service.")]
293 CIM_ManagedElement REF AffectedElement;
294
295 a.dunfey 1.1 [Key, Description (
296 "The Service that is affecting the ManagedElement.")]
297 CIM_Service REF AffectingElement;
298
299 [Description (
300 "An enumeration describing the 'effect' on the "
301 "ManagedElement. This array corresponds to the "
302 "OtherElementEffectsDescriptions array, where the latter "
303 "provides details related to the high-level 'effects' "
304 "enumerated by this property. Additional detail is required "
305 "if the ElementEffects array contains the value 1, "
306 "\"Other\"."),
307 ValueMap { "0", "1", "2", "3", "4" },
308 Values { "Unknown", "Other", "Exclusive Use",
309 "Performance Impact", "Element Integrity" },
310 ArrayType ( "Indexed" ),
311 ModelCorrespondence {
312 "CIM_ServiceAffectsElement.OtherElementEffectsDescriptions" }]
313 uint16 ElementEffects[];
314
315 [Description (
316 a.dunfey 1.1 "Provides details for the 'effect' at the corresponding "
317 "array position in ElementEffects. This information is "
318 "required ElementEffects contains the value 1 (\"Other\")."),
319 ArrayType ( "Indexed" ),
320 ModelCorrespondence { "CIM_ServiceAffectsElement.ElementEffects"
321 }]
322 string OtherElementEffectsDescriptions[];
323 };
324
325
326 // ==================================================================
327 // ServiceServiceDependency
328 // ==================================================================
329 [Association, Version ( "2.7.0" ), Description (
330 "CIM_ServiceServiceDependency is an association between a "
331 "Service and another Service, indicating that the latter is "
332 "required to be present, required to have completed, or must be "
333 "absent for the former Service to provide its functionality. "
334 "For example, Boot Services may be dependent upon underlying "
335 "system initialization Services. In the case of the "
336 "initialization Services, the Boot Service may be dependent on "
337 a.dunfey 1.1 "the init Services completing. \n"
338 "Examining the ServiceServiceDependency class definition, note "
339 "that its superclass ProvidesServiceToElement is deprecated. "
340 "Unfortunately, ProvidesServiceToElement cannot be removed from "
341 "the object hierarchy without a major Schema release. When/if "
342 "this occurs, the ProvidesServiceToElement superclass will be "
343 "removed, and ServiceServiceDependency will subclass from "
344 "CIM_Dependency directly.")]
345 class CIM_ServiceServiceDependency : CIM_ProvidesServiceToElement {
346
347 [Override ( "Antecedent" ), Description (
348 "The required Service.")]
349 CIM_Service REF Antecedent;
350
351 [Override ( "Dependent" ), Description (
352 "The Service that is dependent on an underlying Service.")]
353 CIM_Service REF Dependent;
354
355 [Description (
356 "The nature of the Service to Service dependency. This "
357 "property describes that the associated Service must have "
358 a.dunfey 1.1 "completed (value=2), must be started (3) or must not be "
359 "started (4) in order for the Service to function."),
360 ValueMap { "0", "1", "2", "3", "4" },
361 Values { "Unknown", "Other", "Service Must Have Completed",
362 "Service Must Be Started", "Service Must Not Be Started" }]
363 uint16 TypeOfDependency;
364
365 [Description (
366 "This property describes that the Antecedent Service must be "
367 "restarted after the Dependent operation is complete.")]
368 boolean RestartService;
369 };
370
371
372 // ==================================================================
373 // ServiceComponent
374 // ==================================================================
375 [Association, Aggregation, Version ( "2.6.0" ), Description (
376 "The ServiceComponent aggregation models a set of subordinate "
377 "Services that are aggregated together to form a higher-level "
378 "service.")]
379 a.dunfey 1.1 class CIM_ServiceComponent : CIM_Component {
380
381 [Aggregate, Override ( "GroupComponent" ), Description (
382 "The parent Service.")]
383 CIM_Service REF GroupComponent;
384
385 [Override ( "PartComponent" ), Description (
386 "The component Service.")]
387 CIM_Service REF PartComponent;
388 };
389
390
391 // ==================================================================
392 // ServiceAccessPoint
393 // ==================================================================
394 [Abstract, Version ( "2.6.0" ), Description (
395 "CIM_ServiceAccessPoint represents the ability to utilize or "
396 "invoke a Service. Access points represent that a Service is "
397 "made available to other entities for use.")]
398 class CIM_ServiceAccessPoint : CIM_EnabledLogicalElement {
399
400 a.dunfey 1.1 [Key, Propagated ( "CIM_System.CreationClassName" ),
401 Description (
402 "The scoping System's CreationClassName."),
403 MaxLen ( 256 )]
404 string SystemCreationClassName;
405
406 [Key, Propagated ( "CIM_System.Name" ), Description (
407 "The scoping System's Name."),
408 MaxLen ( 256 )]
409 string SystemName;
410
411 [Key, Description (
412 "CreationClassName indicates the name of the class or the "
413 "subclass used in the creation of an instance. When used "
414 "with the other key properties of this class, this property "
415 "allows all instances of this class and its subclasses to be "
416 "uniquely identified."),
417 MaxLen ( 256 )]
418 string CreationClassName;
419
420 [Key, Override ( "Name" ), Description (
421 a.dunfey 1.1 "The Name property uniquely identifies the "
422 "ServiceAccessPoint and provides an indication of the "
423 "functionality that is managed. This functionality is "
424 "described in more detail in the object's Description "
425 "property."),
426 MaxLen ( 256 )]
427 string Name;
428 };
429
430
431 // ==================================================================
432 // HostedAccessPoint
433 // ==================================================================
434 [Association, Version ( "2.8.0" ), Description (
435 "CIM_HostedAccessPoint is an association between a Service "
436 "AccessPoint and the System on which it is provided. The "
437 "cardinality of this association is 1-to-many and is weak with "
438 "respect to the System. Each System may host many "
439 "ServiceAccessPoints. Heuristic: If the implementation of the "
440 "ServiceAccessPoint is modeled, it must be implemented by a "
441 "Device or SoftwareFeature that is part of the System hosting "
442 a.dunfey 1.1 "the ServiceAccessPoint.")]
443 class CIM_HostedAccessPoint : CIM_HostedDependency {
444
445 [Override ( "Antecedent" ), Min ( 1 ), Max ( 1 ), Description (
446 "The hosting System.")]
447 CIM_System REF Antecedent;
448
449 [Override ( "Dependent" ), Weak, Description (
450 "The SAP(s) that are hosted on this System.")]
451 CIM_ServiceAccessPoint REF Dependent;
452 };
453
454 // ==================================================================
455 // SAPAvailableForElement
456 // ==================================================================
457 [Association, Version ( "2.8.0" ), Description (
458 "CIM_SAPAvailableForElement conveys the semantics of a Service "
459 "Access Point being available for a ManagedElement. When "
460 "CIM_SAPAvailableForElement is not instantiated then the SAP is "
461 "assumed to be generally available. If instantiated, the SAP is "
462 "only available for the associated ManagedElements. For "
463 a.dunfey 1.1 "example, a device might provide management access through a "
464 "URL. This association allows the URL to be advertised for the "
465 "device.")]
466 class CIM_SAPAvailableForElement {
467
468 [Key, Description (
469 "The Service Access Point that is available.")]
470 CIM_ServiceAccessPoint REF AvailableSAP;
471
472 [Key, Description (
473 "The ManagedElement for which the SAP is available.")]
474 CIM_ManagedElement REF ManagedElement;
475 };
476
477 // ==================================================================
478 // ServiceSAPDependency
479 // ==================================================================
480 [Association, Version ( "2.6.0" ), Description (
481 "CIM_ServiceSAPDependency is an association between a Service "
482 "and a ServiceAccessPoint indicating that the referenced SAP is "
483 "utilized by the Service to provide its functionality. For "
484 a.dunfey 1.1 "example, Boot Services may invoke BIOS' Disk Services "
485 "(interrupts) in order to function.")]
486 class CIM_ServiceSAPDependency : CIM_Dependency {
487
488 [Override ( "Antecedent" ), Description (
489 "The required ServiceAccessPoint.")]
490 CIM_ServiceAccessPoint REF Antecedent;
491
492 [Override ( "Dependent" ), Description (
493 "The Service that is dependent on an underlying SAP.")]
494 CIM_Service REF Dependent;
495 };
496
497
498 // ==================================================================
499 // ServiceAccessBySAP
500 // ==================================================================
501 [Association, Version ( "2.6.0" ), Description (
502 "CIM_ServiceAccessBySAP is an association that identifies the "
503 "access points for a Service. For example, a printer may be "
504 "accessed by Netware, MacIntosh or Windows ServiceAccess "
505 a.dunfey 1.1 "Points, potentially hosted on different Systems.")]
506 class CIM_ServiceAccessBySAP : CIM_Dependency {
507
508 [Override ( "Antecedent" ), Description (
509 "The Service.")]
510 CIM_Service REF Antecedent;
511
512 [Override ( "Dependent" ), Description (
513 "An Access Point for a Service. Access points are dependent "
514 "in this relationship since they have no function without a "
515 "corresponding Service.")]
516 CIM_ServiceAccessPoint REF Dependent;
517 };
518
519
520 // ==================================================================
521 // SAPSAPDependency
522 // ==================================================================
523 [Association, Version ( "2.6.0" ), Description (
524 "CIM_SAPSAPDependency is an association between a Service "
525 "AccessPoint and another ServiceAccessPoint indicating that the "
526 a.dunfey 1.1 "latter is required in order for the former ServiceAccess Point "
527 "to utilize or connect with its Service. For example, to print "
528 "at a network printer, local Print Access Points must utilize "
529 "underlying network-related SAPs, or ProtocolEndpoints, in "
530 "order to send the print request.")]
531 class CIM_SAPSAPDependency : CIM_Dependency {
532
533 [Override ( "Antecedent" ), Description (
534 "The required ServiceAccessPoint.")]
535 CIM_ServiceAccessPoint REF Antecedent;
536
537 [Override ( "Dependent" ), Description (
538 "The ServiceAccessPoint that is dependent on an underlying "
539 "SAP.")]
540 CIM_ServiceAccessPoint REF Dependent;
541 };
542
543
544 // ==================================================================
545 // ActiveConnection
546 // ==================================================================
547 a.dunfey 1.1 [Association, Version ( "2.7.0" ), Description (
548 "This association defines a connection that is currently "
549 "communicating, or is configured to communicate, between two "
550 "ServiceAccessPoints. It is used when the connection is not "
551 "treated as a ManagedElement itself (i.e., with Status, "
552 "statistics, etc.), but its existence is known. The SAPs that "
553 "are connected are typically at the same networking or "
554 "application layer.")]
555 class CIM_ActiveConnection : CIM_SAPSAPDependency {
556
557 [Override ( "Antecedent" ), Description (
558 "A ServiceAccessPoint that is configured to communicate "
559 "and/or is actively communicating with the Dependent SAP. In "
560 "a unidirectional connection, this is the SAP which is "
561 "transmitting.")]
562 CIM_ServiceAccessPoint REF Antecedent;
563
564 [Override ( "Dependent" ), Description (
565 "A second SeriveAccessPoint that is/can communicate with the "
566 "Antecedent SAP. In a unidirectional connection, this is the "
567 "SAP that is receiving the communication.")]
568 a.dunfey 1.1 CIM_ServiceAccessPoint REF Dependent;
569
570 [Deprecated { "No value" }, Description (
571 "The type of traffic that is carried over this connection. "
572 "This property is deprecated since it is incorrectly placed "
573 "on the association. Unicast, broadcast or other traffic "
574 "types are not a function of the connection between the "
575 "referenced endpoints, but on the addressing, protocol, and "
576 "basic functionality of the endpoints."),
577 ValueMap { "0", "1", "2", "3", "4", "5" },
578 Values { "Unknown", "Other", "Unicast", "Broadcast",
579 "Multicast", "Anycast" },
580 ModelCorrespondence {
581 "CIM_ActiveConnection.OtherTrafficDescription" }]
582 uint16 TrafficType;
583
584 [Deprecated { "No value" }, Description (
585 "A string describing the type of traffic that is being "
586 "carried over this instance when its Type property is set to "
587 "1 (e.g., 'Other'). This property is deprecated since it is "
588 "incorrectly placed on the association. Unicast, broadcast "
589 a.dunfey 1.1 "or other traffic types are not a function of the connection "
590 "between the referenced endpoints, but on the addressing, "
591 "protocol, and basic functionality of the endpoints."),
592 MaxLen ( 64 ),
593 ModelCorrespondence { "CIM_ActiveConnection.TrafficType" }]
594 string OtherTrafficDescription;
595
596 [Description (
597 "TRUE means that this connection is uni-directional; FALSE "
598 "means that this connection is bi-directional. When the "
599 "connection is unidirectional, the 'speaker' should be "
600 "defined as the Antecedent reference. In a bidirectional "
601 "connection, the selection of which AccessPoint is the "
602 "Antecedent or Dependent is immaterial.")]
603 boolean IsUnidirectional;
604 };
605
606
607 // ==================================================================
608 // RemoteServiceAccessPoint
609 // ==================================================================
610 a.dunfey 1.1 [Version ( "2.8.0" ), Description (
611 "RemoteServiceAccessPoint describes access and/or addressing "
612 "information for a remote connection, that is known to a "
613 "'local' network element. This information is scoped/contained "
614 "by the 'local' network element, since this is the context in "
615 "which it is 'remote'. \n"
616 "\n"
617 "Why the remote access point is relevant and information on its "
618 "use are described by subclassing RemoteService AccessPoint, or "
619 "by associating to it.")]
620 class CIM_RemoteServiceAccessPoint : CIM_ServiceAccessPoint {
621
622 [Description (
623 "Access and/or addressing information for a remote "
624 "connection. This can be a host name, network address or "
625 "similar information."),
626 ModelCorrespondence { "CIM_RemoteServiceAccessPoint.InfoFormat"
627 }]
628 string AccessInfo;
629
630 [Description (
631 a.dunfey 1.1 "An enumerated integer describing the format and "
632 "interpretation of the AccessInfo property."),
633 ValueMap { "1", "2", "3", "4", "5", "6", "7", "8", "9", "10",
634 "11", "12", "13", "100", "101", "102", "103", "104", "200",
635 "201", "202", "203", "204", "205", "..", "32768..65535" },
636 Values { "Other", "Host Name", "IPv4 Address", "IPv6 Address",
637 "IPX Address", "DECnet Address", "SNA Address",
638 "Autonomous System Number", "MPLS Label",
639 "IPv4 Subnet Address", "IPv6 Subnet Address",
640 "IPv4 Address Range", "IPv6 Address Range", "Dial String",
641 "Ethernet Address", "Token Ring Address", "ATM Address",
642 "Frame Relay Address", "URL", "FQDN", "User FQDN",
643 "DER ASN1 DN", "DER ASN1 GN", "Key ID", "DMTF Reserved",
644 "Vendor Reserved" },
645 ModelCorrespondence {
646 "CIM_RemoteServiceAccessPoint.OtherInfoFormatDescription" }]
647 uint16 InfoFormat;
648
649 [Description (
650 "Describes the format when the property InfoFormat is set to "
651 "1 (\"Other\")."),
652 a.dunfey 1.1 ModelCorrespondence { "CIM_RemoteServiceAccessPoint.InfoFormat"
653 }]
654 string OtherInfoFormatDescription;
655 };
656
657
658 // ==================================================================
659 // RemotePort
660 // ==================================================================
661 [Version ( "2.7.0" ), Description (
662 "RemotePort adds port information to the access data (such as "
663 "IP Address), specified in and inherited from "
664 "RemoteServiceAccessPoint. For example, using the additional "
665 "properties in this class, one could indicate that UDP Port 123 "
666 "is accessed at IP Address xyz. The IP Address would be "
667 "specified in the inherited AccessInfo property, while the UDP "
668 "Port number would be specified in this class' property, "
669 "PortInfo.")]
670 class CIM_RemotePort : CIM_RemoteServiceAccessPoint {
671
672 [Description (
673 a.dunfey 1.1 "Port information that may further specify the remote access "
674 "information."),
675 ModelCorrespondence { "CIM_RemotePort.PortProtocol" }]
676 string PortInfo;
677
678 [Description (
679 "An enumerated integer describing the protocol of the port "
680 "addressed by PortInformation."),
681 ValueMap { "1", "2", "3", "32768..65535" },
682 Values { "Other", "TCP", "UDP", "Vendor Specific" },
683 ModelCorrespondence { "CIM_RemotePort.OtherProtocolDescription"
684 }]
685 uint16 PortProtocol;
686
687 [Description (
688 "Describes the protocol when the property PortProtocol is "
689 "set to 1 (\"Other\")."),
690 ModelCorrespondence { "CIM_RemotePort.PortProtocol" }]
691 string OtherProtocolDescription;
692 };
693
694 a.dunfey 1.1
695 // ==================================================================
696 // ServiceAccessURI
697 // ==================================================================
698 [Version ( "2.7.0" ), Description (
699 "CIM_ServiceAccessURI represents the ability to utilize or "
700 "invoke a Service via a uniform resource identifier. RFC 1738 "
701 "describes the Uniform Resource Locator which is a more "
702 "specific form of a URI, and RFC 2396 describes the broader, "
703 "inclusive URI. Quoting from the RFC, 'A Uniform Resource "
704 "Identifier (URI) is a compact string of characters for "
705 "identifying an abstract or physical resource.' In the context "
706 "of a ServiceAccessPoint, a URI contains the information "
707 "necessary to access an associated service (associated via "
708 "ServiceAccessBySAP), using a syntax specific to that service.")]
709 class CIM_ServiceAccessURI : CIM_ServiceAccessPoint {
710
711 [Required, Description (
712 "The LabeledURI property is based on RFC 2079 and its value "
713 "and syntax is service specific."),
714 MaxLen ( 256 )]
715 a.dunfey 1.1 string LabeledURI;
716 };
717
718
719 // ==================================================================
720 // ProtocolEndpoint
721 // ==================================================================
722 [Version ( "2.8.0" ), Description (
723 "A communication point from which data may be sent or received. "
724 "ProtocolEndpoints link system/computer interfaces to "
725 "LogicalNetworks.")]
726 class CIM_ProtocolEndpoint : CIM_ServiceAccessPoint {
727
728 [Override ( "Description" ),
729 MappingStrings { "MIB.IETF|IF-MIB.ifDescr" }]
730 string Description;
731
732 [Override ( "OperationalStatus" ),
733 MappingStrings { "MIB.IETF|IF-MIB.ifOperStatus" }]
734 uint16 OperationalStatus[];
735
736 a.dunfey 1.1 [Override ( "EnabledState" ),
737 MappingStrings { "MIB.IETF|IF-MIB.ifAdminStatus" }]
738 uint16 EnabledState;
739
740 [Override ( "TimeOfLastStateChange" ),
741 MappingStrings { "MIB.IETF|IF-MIB.ifLastChange" }]
742 datetime TimeOfLastStateChange;
743
744 [Override ( "Name" ), Description (
745 "A string which identifies this ProtocolEndpoint with either "
746 "a port or an interface on a device. To ensure uniqueness, "
747 "the Name property should be prepended or appended with "
748 "information from the Type or OtherTypeDescription "
749 "properties. The method chosen is described in the "
750 "NameFormat property of this class."),
751 MaxLen ( 256 )]
752 string Name;
753
754 [Description (
755 "NameFormat contains the naming heuristic that is chosen to "
756 "ensure that the value of the Name property is unique. For "
757 a.dunfey 1.1 "example, one might choose to prepend the name of the port "
758 "or interface with the Type of ProtocolEndpoint that this "
759 "instance is (e.g., IPv4) followed by an underscore."),
760 MaxLen ( 256 )]
761 string NameFormat;
762
763 [Deprecated { "CIM_ProtocolEndpoint.ProtocolIFType" },
764 Description (
765 "ProtocolType is an enumeration providing information to "
766 "categorize and classify different instances of this class. "
767 "For most instances, information in this enumeration and the "
768 "subclass' definition overlap. However, there are several "
769 "cases where a specific subclass of ProtocolEndpoint is not "
770 "required (for example, there is no Fibre Channel subclass "
771 "of ProtocolEndpoint). Hence, this property is needed to "
772 "define the type of Endpoint. \n"
773 "\n"
774 "This property is deprecated in lieu of the ProtocolIFType "
775 "enumeration. This is done to have better alignment between "
776 "the IETF's IF-MIB and this CIM class."),
777 ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "8", "9",
778 a.dunfey 1.1 "10", "11", "12", "13", "14", "15", "16", "17", "18", "19",
779 "20", "21", "22", "23", "24", "25", "26", "27" },
780 Values { "Unknown", "Other", "IPv4", "IPv6", "IPX", "AppleTalk",
781 "DECnet", "SNA", "CONP", "CLNP", "VINES", "XNS", "ATM",
782 "Frame Relay", "Ethernet", "TokenRing", "FDDI", "Infiniband",
783 "Fibre Channel", "ISDN BRI Endpoint",
784 "ISDN B Channel Endpoint", "ISDN D Channel Endpoint",
785 // 22
786 "IPv4/v6", "BGP", "OSPF", "MPLS", "UDP", "TCP" },
787 ModelCorrespondence {
788 "CIM_ProtocolEndpoint.OtherTypeDescription" }]
789 uint16 ProtocolType;
790
791 [Description (
792 "ProtocolIFType is an enumeration synchronized with the IANA "
793 "ifType MIB, maintained at the URL, http: "
794 "//www.iana.org/assignments/ianaiftype-mib. Also, // // // "
795 "// additional values defined by the DMTF are included. The "
796 "property is used to categorize and classify instances of "
797 "the ProtocolEndpoint class. Note that if the ProtocolIFType "
798 "is set to 1 (\"Other\"), then the type information should "
799 a.dunfey 1.1 "be provided in the OtherTypeDescription string property."),
800 ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "8", "9",
801 "10", "11", "12", "13", "14", "15", "16", "17", "18", "19",
802 "20", "21", "22", "23", "24", "25", "26", "27", "28", "29",
803 "30", "31", "32", "33", "34", "35", "36", "37", "38", "39",
804 "40", "41", "42", "43", "44", "45", "46", "47", "48", "49",
805 "50", "51", "52", "53", "54", "55", "56", "57", "58", "59",
806 "60", "61", "62", "63", "64", "65", "66", "67", "68", "69",
807 "70", "71", "72", "73", "74", "75", "76", "77", "78", "79",
808 "80", "81", "82", "83", "84", "85", "86", "87", "88", "89",
809 "90", "91", "92", "93", "94", "95", "96", "97", "98", "99",
810 "100", "101", "102", "103", "104", "105", "106", "107",
811 "108", "109", "110", "111", "112", "113", "114", "115",
812 "116", "117", "118", "119", "120", "121", "122", "123",
813 "124", "125", "126", "127", "128", "129", "130", "131",
814 "132", "133", "134", "135", "136", "137", "138", "139",
815 "140", "141", "142", "143", "144", "145", "146", "147",
816 "148", "149", "150", "151", "152", "153", "154", "155",
817 "156", "157", "158", "159", "160", "161", "162", "163",
818 "164", "165", "166", "167", "168", "169", "170", "171",
819 "172", "173", "174", "175", "176", "177", "178", "179",
820 a.dunfey 1.1 "180", "181", "182", "183", "184", "185", "186", "187",
821 "188", "189", "190", "191", "192", "193", "194", "195",
822 "196", "197", "198", "199", "200", "201", "202", "203",
823 "204", "205", "206", "207", "208", "209", "210", "211",
824 "212", "213", "214", "215", "216", "217", "218", "219",
825 "220", "221", "222", "223", "224", "..4095", "4096", "4097",
826 "4098", "4099", "4100", "4101", "4102", "4103", "4104",
827 "4105", "4106", "4107", "4108", "4109", "4110", "4111",
828 "4112", "4113", "4114", "4115", "..32767", "32768.." },
829 Values { "Unknown", "Other", "Regular 1822", "HDH 1822",
830 "DDN X.25", "RFC877 X.25", "Ethernet CSMA/CD",
831 "ISO 802.3 CSMA/CD", "ISO 802.4 Token Bus",
832 "ISO 802.5 Token Ring", "ISO 802.6 MAN", "StarLAN",
833 "Proteon 10Mbit", "Proteon 80Mbit", "HyperChannel", "FDDI",
834 "LAP-B", "SDLC", "DS1", "E1", "Basic ISDN", "Primary ISDN",
835 "Proprietary Point-to-Point Serial", "PPP",
836 "Software Loopback", "EON", "Ethernet 3Mbit", "NSIP", "SLIP",
837 "Ultra", "DS3", "SIP", "Frame Relay", "RS-232", "Parallel",
838 "ARCNet", "ARCNet Plus", "ATM", "MIO X.25", "SONET",
839 "X.25 PLE", "ISO 802.211c", "LocalTalk", "SMDS DXI",
840 "Frame Relay Service", "V.35", "HSSI", "HIPPI", "Modem",
841 a.dunfey 1.1 "AAL5", "SONET Path", "SONET VT", "SMDS ICIP",
842 "Proprietary Virtual/Internal", "Proprietary Multiplexor",
843 "IEEE 802.12", "Fibre Channel", "HIPPI Interface",
844 "Frame Relay Interconnect", "ATM Emulated LAN for 802.3",
845 "ATM Emulated LAN for 802.5", "ATM Emulated Circuit",
846 "Fast Ethernet (100BaseT)", "ISDN", "V.11", "V.36",
847 "G703 at 64K", "G703 at 2Mb", "QLLC",
848 "Fast Ethernet 100BaseFX", "Channel", "IEEE 802.11",
849 "IBM 260/370 OEMI Channel", "ESCON", "Data Link Switching",
850 "ISDN S/T Interface", "ISDN U Interface", "LAP-D",
851 "IP Switch", "Remote Source Route Bridging", "ATM Logical",
852 "DS0", "DS0 Bundle", "BSC", "Async", "Combat Net Radio",
853 "ISO 802.5r DTR", "Ext Pos Loc Report System",
854 "AppleTalk Remote Access Protocol",
855 "Proprietary Connectionless", "ITU X.29 Host PAD",
856 "ITU X.3 Terminal PAD", "Frame Relay MPI", "ITU X.213",
857 "ADSL", "RADSL", "SDSL", "VDSL", "ISO 802.5 CRFP", "Myrinet",
858 "Voice Receive and Transmit",
859 "Voice Foreign Exchange Office",
860 "Voice Foreign Exchange Service", "Voice Encapsulation",
861 "Voice over IP", "ATM DXI", "ATM FUNI", "ATM IMA",
862 a.dunfey 1.1 "PPP Multilink Bundle", "IP over CDLC", "IP over CLAW",
863 "Stack to Stack", "Virtual IP Address", "MPC", "IP over ATM",
864 "ISO 802.5j Fibre Token Ring", "TDLC", "Gigabit Ethernet",
865 "HDLC", "LAP-F", "V.37", "X.25 MLP", "X.25 Hunt Group",
866 "Transp HDLC", "Interleave Channel", "FAST Channel",
867 "IP (for APPN HPR in IP Networks)", "CATV MAC Layer",
868 "CATV Downstream", "CATV Upstream", "Avalon 12MPP Switch",
869 "Tunnel", "Coffee", "Circuit Emulation Service",
870 "ATM SubInterface", "Layer 2 VLAN using 802.1Q",
871 "Layer 3 VLAN using IP", "Layer 3 VLAN using IPX",
872 "Digital Power Line", "Multimedia Mail over IP", "DTM",
873 "DCN", "IP Forwarding", "MSDSL", "IEEE 1394",
874 "IF-GSN/HIPPI-6400", "DVB-RCC MAC Layer",
875 "DVB-RCC Downstream", "DVB-RCC Upstream", "ATM Virtual",
876 "MPLS Tunnel", "SRP", "Voice over ATM",
877 "Voice over Frame Relay", "ISDL", "Composite Link",
878 "SS7 Signaling Link", "Proprietary P2P Wireless",
879 "Frame Forward", "RFC1483 Multiprotocol over ATM", "USB",
880 "IEEE 802.3ad Link Aggregate", "BGP Policy Accounting",
881 "FRF .16 Multilink FR", "H.323 Gatekeeper", "H.323 Proxy",
882 "MPLS", "Multi-Frequency Signaling Link", "HDSL-2", "S-HDSL",
883 a.dunfey 1.1 "DS1 Facility Data Link", "Packet over SONET/SDH",
884 "DVB-ASI Input", "DVB-ASI Output", "Power Line",
885 "Non Facility Associated Signaling", "TR008", "GR303 RDT",
886 "GR303 IDT", "ISUP", "Proprietary Wireless MAC Layer",
887 "Proprietary Wireless Downstream",
888 "Proprietary Wireless Upstream", "HIPERLAN Type 2",
889 "Proprietary Broadband Wireless Access Point to Mulipoint",
890 "SONET Overhead Channel", "Digital Wrapper Overhead Channel",
891 "ATM Adaptation Layer 2", "Radio MAC", "ATM Radio",
892 "Inter Machine Trunk", "MVL DSL", "Long Read DSL",
893 "Frame Relay DLCI Endpoint", "ATM VCI Endpoint",
894 "Optical Channel", "Optical Transport", "Proprietary ATM",
895 "Voice over Cable", "Infiniband", "TE Link", "Q.2931",
896 "Virtual Trunk Group", "SIP Trunk Group", "SIP Signaling",
897 "CATV Upstream Channel", "Econet", "FSAN 155Mb PON",
898 "FSAN 622Mb PON", "Transparent Bridge", "Line Group",
899 "Voice E&M Feature Group", "Voice FGD EANA", "Voice DID",
900 "MPEG Transport", "6To4", "GTP", "Paradyne EtherLoop 1",
901 "Paradyne EtherLoop 2", "Optical Channel Group", "HomePNA",
902 "GFP", "ciscoISLvlan", "actelisMetaLOOP", "Fcip",
903 "IANA Reserved", "IPv4", "IPv6", "IPv4/v6", "IPX", "DECnet",
904 a.dunfey 1.1 "SNA", "CONP", "CLNP", "VINES", "XNS",
905 "ISDN B Channel Endpoint", "ISDN D Channel Endpoint", "BGP",
906 "OSPF", "UDP", "TCP", "802.11a", "802.11b", "802.11g",
907 "802.11h", "DMTF Reserved", "Vendor Reserved" },
908 MappingStrings { "MIB.IETF|IF-MIB.ifType" },
909 ModelCorrespondence {
910 "CIM_ProtocolEndpoint.OtherTypeDescription" }]
911 uint16 ProtocolIFType;
912
913 [Description (
914 "A string describing the type of ProtocolEndpoint when the "
915 "Type property of this class (or any of its subclasses) is "
916 "set to 1 (i.e., \"Other\"). This property should be set to "
917 "NULL when the Type property is any value other than 1."),
918 MaxLen ( 64 ),
919 ModelCorrespondence { "CIM_ProtocolEndpoint.ProtocolType",
920 "CIM_ProtocolEndpoint.ProtocolIFType" }]
921 string OtherTypeDescription;
922 };
923
924
925 a.dunfey 1.1 // ==================================================================
926 // BindsTo
927 // ==================================================================
928 [Association, Version ( "2.6.0" ), Description (
929 "This association establishes a ServiceAccessPoint as a "
930 "requestor of protocol services from a ProtocolEndpoint. "
931 "Typically, this association runs between SAPs and endpoints on "
932 "a single system. Since a ProtocolEndpoint is a kind of "
933 "ServiceAccessPoint, this binding can be used to establish a "
934 "layering of two protocols, the upper layer represented by the "
935 "Dependent and the lower layer represented by the Antecedent.")]
936 class CIM_BindsTo : CIM_SAPSAPDependency {
937
938 [Override ( "Antecedent" ), Description (
939 "The lower-level endpoint which is accessed by the SAP.")]
940 CIM_ProtocolEndpoint REF Antecedent;
941
942 [Override ( "Dependent" ), Description (
943 "The AccessPoint or ProtocolEndpoint dependent on the lower "
944 "level endpoint.")]
945 CIM_ServiceAccessPoint REF Dependent;
946 a.dunfey 1.1 };
947
948
949 // ==================================================================
950 // ProvidesEndpoint
951 // ==================================================================
952 [Association, Version ( "2.7.0" ), Description (
953 "This association represents a ProtocolEndpoint provided by a "
954 "Service, to allow access to the Service.")]
955 class CIM_ProvidesEndpoint : CIM_ServiceAccessBySAP {
956
957 [Override ( "Antecedent" ), Description (
958 "The Service that is accessed by the ProtocolEndpoint.")]
959 CIM_Service REF Antecedent;
960
961 [Override ( "Dependent" ), Description (
962 "The ProtocolEndpoint that provides access to the Service.")]
963 CIM_ProtocolEndpoint REF Dependent;
964 };
965
966 // ===================================================================
967 a.dunfey 1.1 // end of file
968 // ===================================================================
|