1 tony 1.1 // ===================================================================
2 // Title: Device Protocol Controller 2.8
3 // Filename: Device28_ProtocolContoller.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 Device Model extends the management concepts that
45 // are related to LogicalDevices. This file defines
46 // the concepts and classes for Protocol Controllers.
47 //
48 // The object classes below are listed in an order that
49 // avoids forward references. Required objects, defined
50 // by other working groups, are omitted.
51 // ==================================================================
52 // Change Log for v2.8 Final
53 // CR1202 - Experimental to Final for Device
54 //
55 // Change Log for v2.8 Final
56 // CR1201 - Fix use of Privilege/Identity in
57 // CreateProtocolControllerWithPorts()
58 // CR1223 - Fix ambiguity in ProtocolControllerMaskingCapabilities
59 //
60 // Change Log for v2.8 Preliminary
61 // CR1015 - Initial ProtocolController definition
62 // CR1007 - Addition of ControllerConfigurationService and
63 // StorageMaskingService
64 tony 1.1 // CR1040 - Improves CreateProtocolController by allowing
65 // atomic creation with permissions.
66 // CR1055 - Remove ConnectionRole from ProtocolController
67 // Add UsageRestriction to NetworkPort
68 // CR1082 - Change StorageMaskingCapabilities to be
69 // ProtocolControllerMaskingCapabilities
70 // CR1108 - Change CreatePortProtocolController to
71 // CreateProtocolControllerWithPorts
72 //
73 // ==================================================================
74
75 #pragma locale ("en_US")
76
77
78 // ===================================================================
79 // ProtocolController
80 // ===================================================================
81 [Abstract, Version ( "2.8.0" ), Description (
82 "ProtocolController is a superclass for grouping controllers "
83 "that are used to control the operation and function of "
84 "sophisticated devices that instantiate a protocol such as "
85 tony 1.1 "SCSI. Simpler 'bus' and device controllers are modeled using "
86 "the CIM_Controller class.")]
87 class CIM_ProtocolController : CIM_LogicalDevice {
88
89 [Description (
90 "Maximum number of Units that can be controlled by or "
91 "accessed through this ProtocolController.")]
92 uint32 MaxUnitsControlled;
93 };
94
95 // ===================================================================
96 // SCSIProtocolController
97 // ===================================================================
98 [Version ( "2.8.0" ), Description (
99 "SCSIProtocolController is a type of ProtocolController, "
100 "managing a SCSI interface.")]
101 class CIM_SCSIProtocolController : CIM_ProtocolController {
102 };
103
104 // ===================================================================
105 // ProtocolControllerForDevice
106 tony 1.1 // ===================================================================
107 [Association, Abstract, Version ( "2.8.0" ), Description (
108 "This association indicates a subclass of LogicalDevice (for "
109 "example a Storage Volume) is connected through a specific "
110 "ProtocolController. In many situations (for example storage "
111 "LUN masking), there may be many of these associations used to "
112 "relate to different objects. Therefore subclasses have been "
113 "defined to optimize enumeration of the associations.")]
114 class CIM_ProtocolControllerForDevice : CIM_Dependency {
115
116 [Override ( "Antecedent" ), Description (
117 "The ProtocolController.")]
118 CIM_ProtocolController REF Antecedent;
119
120 [Override ( "Dependent" ), Description (
121 "The controlled Device.")]
122 CIM_LogicalDevice REF Dependent;
123
124 [Description (
125 "Address of the associated Device in the context of the "
126 "Antecedent Controller.")]
127 tony 1.1 string DeviceNumber;
128
129 [Description (
130 "This property describes the priority given to accesses of "
131 "the device through this Controller. The highest priority "
132 "path will have the lowest value for this parameter.")]
133 uint16 AccessPriority;
134
135 [Description (
136 "The State property indicates whether the Controller is "
137 "actively commanding or accessing the device (value=2) or "
138 "not (value=3). Also, the value, \"Unknown\" (0), can be "
139 "defined. This information is necessary when a LogicalDevice "
140 "can be commanded by, or accessed through, multiple "
141 "ProtocolControllers."),
142 ValueMap { "0", "2", "3" },
143 Values { "Unknown", "Active", "Inactive" }]
144 uint16 AccessState;
145 };
146
147 // ===================================================================
148 tony 1.1 // AssociatedProtocolController
149 // ===================================================================
150 [Association, Version ( "2.8.0" ), Description (
151 "This association is used to define a hierarchy relationship "
152 "between ProtocolControllers. This subclass is provided so that "
153 "an enumeration of related ProtocolControllers can be performed "
154 "without retrieving any connected StorageVolumes, "
155 "MediaAccessDevices or LogicalPorts.")]
156 class CIM_AssociatedProtocolController : CIM_ProtocolControllerForDevice {
157
158 [Override ( "Antecedent" ), Description (
159 "The 'upstream', Antecedent ProtocolController.")]
160 CIM_ProtocolController REF Antecedent;
161
162 [Override ( "Dependent" ), Description (
163 "The 'downstream' Dependent ProtocolController.")]
164 CIM_ProtocolController REF Dependent;
165 };
166
167 // ===================================================================
168 // ProtocolControllerForPort
169 tony 1.1 // ===================================================================
170 [Association, Version ( "2.8.0" ), Description (
171 "This association is used to define a relationship between a "
172 "ProtocolController and a LogicalPort. This subclass is "
173 "provided so that an enumeration of related controllers and "
174 "ports can be performed without retrieving any other "
175 "controllers or connected units.")]
176 class CIM_ProtocolControllerForPort : CIM_ProtocolControllerForDevice {
177
178 [Override ( "Antecedent" ), Description (
179 "The ProtocolController.")]
180 CIM_ProtocolController REF Antecedent;
181
182 [Override ( "Dependent" ), Description (
183 "The LogicalPort 'behind' the ProtocolController.")]
184 CIM_LogicalPort REF Dependent;
185 };
186
187 // ===================================================================
188 // ProtocolControllerForUnit
189 // ===================================================================
190 tony 1.1 [Association, Version ( "2.8.0" ), Description (
191 "This association is used to define a relationship between a "
192 "ProtocolController and an exposed Logical Unit (for example a "
193 "Storage Volume or a MediaAccessDevice such as a tape drive). "
194 "An example of the use of this association is SCSI, where it "
195 "link the target controller and Logical Units. This subclass is "
196 "provided so that an enumeration of related controllers and "
197 "units can be performed without retrieving any connected ports "
198 "or other controllers.")]
199 class CIM_ProtocolControllerForUnit : CIM_ProtocolControllerForDevice {
200
201 [Override ( "Antecedent" ), Description (
202 "The ProtocolController.")]
203 CIM_ProtocolController REF Antecedent;
204
205 [Override ( "Dependent" ), Description (
206 "The logical unit (eg StorageVolume) 'behind' the "
207 "ProtocolController.")]
208 CIM_LogicalDevice REF Dependent;
209 };
210
211 tony 1.1 // ===================================================================
212 // ProtocolControllerAccessesUnit
213 // ===================================================================
214 [Association, Version ( "2.8.0" ), Description (
215 "This association is used to define a relationship between a "
216 "protocol controllers and a Logical Unit (for example a Storage "
217 "Volume or Media Access Device) controlled by the controller. "
218 "This association is used instead of ProtocolControllerForUnit "
219 "to indicate a 'controlled through' relationship rather than a "
220 "'controlled by' one. An example is SCSI where this association "
221 "is used to indicate a target/initiator relationship.")]
222 class CIM_ProtocolControllerAccessesUnit : CIM_ProtocolControllerForDevice {
223
224 [Override ( "Antecedent" ), Description (
225 "The protocol controller.")]
226 CIM_ProtocolController REF Antecedent;
227
228 [Override ( "Dependent" ), Description (
229 "The logical unit (eg StorageVolume).")]
230 CIM_LogicalDevice REF Dependent;
231
232 tony 1.1 [Description (
233 "The number of the dependent's target protocol controller. "
234 "As an example, in SCSI this is the Target ID.")]
235 string TargetControllerNumber;
236 };
237
238 // ==================================================================
239 // ControllerConfigurationService
240 // ==================================================================
241 [Version ( "2.8.0" ), Description (
242 "The ControllerConfigurationService provides methods that allow "
243 "a client to manipulate LUN Masking in a storage system.")]
244 class CIM_ControllerConfigurationService : CIM_Service {
245
246 [Description (
247 "This method creates an appropriate subclass of "
248 "ProtocolController. In addition to its role of controlling "
249 "downstream devices, a ProtocolControl is used to provide a "
250 "central management point for access control with respect to "
251 "those devices. Certain storage system implementations "
252 "across multiple vendors require permissions to be "
253 tony 1.1 "established atomically with the creation of a "
254 "ProtocolController. This method provides this capability "
255 "via the Privilege and Identity properties. By supplying "
256 "appropriate information in those properties, this method "
257 "will assure that appropriate AuthorizedTarget and "
258 "AuthorizedSubject associations, (as defined in the User and "
259 "Security Model), are instantiated to restrict access to the "
260 "logical devices 'behind' it. \n"
261 "If multiple target ports are specified in the Ports input "
262 "parameter, all expose the same view (i.e., have the same "
263 "unit numbers and permissions). This method does not create "
264 "the port instances, but does create "
265 "ProtocolControllerForPort associations between the "
266 "specified ports and the new ProtocolController. The new "
267 "ProtocolController is defined to be weak to the same System "
268 "as the ControllerConfigurationService."),
269 ValueMap { "0", "1", "2", "3", "4", "5", "6..4095", "4096",
270 "4097", "4098", "4099..32767", "32768..65535" },
271 Values { "Success", "Not Supported", "Unspecified Error",
272 "Timeout", "Failed", "Invalid Parameter", "DMTF Reserved",
273 "ID Parameter Missing or Not Unique",
274 tony 1.1 "Hardware Implementation Requires Null Ports Parameter",
275 "Busy", "Method Reserved", "Vendor Specific" }]
276 uint32 CreateProtocolControllerWithPorts (
277 [IN, Description (
278 "The string to be used in the ElementName of the new "
279 "ProtocolController."),
280 ModelCorrespondence { "CIM_ProtocolController.ElementName" }]
281 string ElementName,
282 [IN, Description (
283 "Array of strings containing representations of "
284 "references to instances of CIM_LogicalPort (or subclass) "
285 "instances. This is the list of target ports that are "
286 "associated to the ProtocolController. "
287 "ProtocolControllerForPort associations are created by "
288 "the instrumentation associating the new "
289 "ProtocolController to these ports. If this parameter is "
290 "null, then all ports in the storage system (this "
291 "Service's 'scoping' System and all its ComponentCS "
292 "Systems) are attached to the new ProtocolController.")]
293 string Ports[],
294 [IN, Description (
295 tony 1.1 "The protocol type for the new ProtocolController."),
296 ValueMap { "0", "1", "2" },
297 Values { "Unknown", "Other", "SCSI" },
298 ModelCorrespondence { "CIM_SCSIProtocolController" }]
299 uint16 Protocol,
300 [IN, Description (
301 "Reference to a CIM_Privilege (or subclass) instance to "
302 "be used as a template. If supplied, it has a 1:1 "
303 "correspondence with the Identity parameter and this "
304 "method will atomically create the new ProtocolController "
305 "instance and related AuthorizedPrivilege, "
306 "AuthorizedTarget and AuthorizedSubject instances. \n"
307 "Note: if ProtocolControllerRequiresAuthorizedIdentity is "
308 "true, then the Identity/Privilege pair MUST be "
309 "specified. If false, then the Identity/Privilege pair "
310 "MUST NOT be specified."),
311 ModelCorrespondence { "CIM_ControllerConfigurationService."
312 "CreateProtocolControllerWithPorts.Identity" }]
313 CIM_Privilege REF Privilege,
314 [Description (
315 "Reference to a CIM_ManagedElement (or subclass) "
316 tony 1.1 "instance. This ManagedElement MUST be either a "
317 "CIM_Identity, or a CIM_Collection (or subclass, eg. "
318 "SystemSpecificCollection, Role, or Group) that has "
319 "CIM_Identities as MemberOfCollection. If "
320 "ProtocolControllerMaskingCapabilities.ProtocolControllerSupportsCollection "
321 "is false, the reference MUST be to a CIM_Identity (or "
322 "subclass). If present, it has a 1:1 correspondence with "
323 "the Privilege property. If present, this method will "
324 "atomically create the new ProtocolController instance "
325 "and instantiate a missing AuthorizedSubject association "
326 "between the Privilege/Identity pair; and instantiate an "
327 "AuthorizedTarget association between the "
328 "AuthorizedPrivilege and the new ProtocolController. \n"
329 "Note: if ProtocolControllerRequiresAuthorizedIdentity is "
330 "true, then at least the Identity/Privilege pair MUST be "
331 "specified."),
332 ModelCorrespondence { "CIM_ControllerConfigurationService."
333 "CreateProtocolControllerWithPorts.Privilege" }]
334 CIM_ManagedElement REF Identity,
335 [IN ( false ), OUT, Description (
336 "A reference to the new ProtocolController that is "
337 tony 1.1 "created.")]
338 CIM_ProtocolController REF ProtocolController);
339
340 [Description (
341 "The method deletes an instance of ProtocolController and "
342 "all associations in which this ProtocolController is "
343 "referenced."),
344 ValueMap { "0", "1", "2", "3", "4", "5", "6..4095", "4096",
345 "4097", "4098..32767", "32768..65535" },
346 Values { "Success", "Not Supported", "Unspecified Error",
347 "Timeout", "Failed", "Invalid Parameter", "DMTF Reserved",
348 "LogicalDevices Associated to Other ProtocolControllers Not "
349 "Deleted", "Busy", "Method Reserved", "Vendor Specific" }]
350 uint32 DeleteProtocolController (
351 [IN, Description (
352 "The ProtocolController to be deleted.")]
353 CIM_ProtocolController REF ProtocolController,
354 [IN, Description (
355 "If true, the management instrumentation provider will "
356 "also delete 'child' ProtocolControllers (i.e., those "
357 "defined as Dependent references in instances of "
358 tony 1.1 "AssociatedProtocolController where this "
359 "ProtocolController is the Antecedent reference). Also, "
360 "all direct associations involving the 'child' "
361 "ProtocolControllers will be removed.")]
362 boolean DeleteChildrenProtocolControllers,
363 [IN, Description (
364 "If true, the management instrumentation provider will "
365 "also delete LogicalDevice instances associated via "
366 "ProtocolControllerForUnit, to this ProtocolController "
367 "and its children. (Note that 'child' controllers will "
368 "only be affected if the "
369 "DeleteChildrenProtocolControllers input parameter is "
370 "TRUE). LogicalDevice instances are only deleted if there "
371 "are NO remaining ProtocolControllerForUnit associations, "
372 "to other ProtocolControllers.")]
373 boolean DeleteUnits );
374
375 [Description (
376 "This method associates a LogicalDevice subclass "
377 "(specifically a StorageVolume or MediaAccessDevice "
378 "subclass) to the referenced ProtocolController. The "
379 tony 1.1 "association is persisted as an instance of "
380 "ProtocolControllerForUnit. The management instrumentation "
381 "provider must verify that the logical unit numbers (defined "
382 "using the DeviceNumber input parameter) are unique for the "
383 "ProtocolController. When the Protocol Controller is "
384 "actively masking a device (i.e. is part of an "
385 "AuthorizedTarget association), the provider should update "
386 "the access configuration in the underlying hardware as "
387 "appropriate."),
388 ValueMap { "0", "1", "2", "3", "4", "5", "6..4095", "4096",
389 "4097", "4098", "4099", "4100", "4101..32767",
390 "32768..65535" },
391 Values { "Success", "Not Supported", "Unspecified Error",
392 "Timeout", "Failed", "Invalid Parameter", "DMTF Reserved",
393 "Invalid LogicalDevice Instance", "Device Number Conflict",
394 "DeviceNumber Parameter Must Be Provided",
395 "Hardware Implementation Requires Null DeviceNumber", "Busy",
396 "Method Reserved", "Vendor Specific" }]
397 uint32 AttachDevice (
398 [IN, Description (
399 "The ProtocolController instance.")]
400 tony 1.1 CIM_ProtocolController REF ProtocolController,
401 [IN, Description (
402 "The LogicalDevice instance to attach.")]
403 CIM_LogicalDevice REF Device,
404 [IN, OUT, Description (
405 "The number assigned to "
406 "ProtocolControllerForUnit.DeviceNumber (if supported by "
407 "the hardware). Hardware support is indicated by "
408 "ProtocolControllerMaskingCapabilities.ClientSelectableDeviceNumbers). "
409 "If the hardware does not support setting the number, but "
410 "the DeviceNumber has not been established in an existing "
411 "ProtocolControllerForDevice subclass, then this "
412 "parameter's value will be used. If the DeviceNumber has "
413 "been established, then the current number will be "
414 "reused."),
415 ModelCorrespondence {
416 "CIM_ProtocolControllerForUnit.DeviceNumber" }]
417 string DeviceNumber );
418
419 [Description (
420 "This method removes the ProtocolControllerForDevice "
421 tony 1.1 "association subclass between the ProtocolController and a "
422 "LogicalDevice, such as a StorageVolume or a "
423 "MediaAccessDevice. When the ProtocolController is actively "
424 "masking a device (i.e. is part of an AuthorizedTarget "
425 "association, the management instrumentation provider should "
426 "update the hardware access configuration when DetachDevice "
427 "is called."),
428 ValueMap { "0", "1", "2", "3", "4", "5", "6..4095", "4096",
429 "4097", "4098..32767", "32768..65535" },
430 Values { "Success", "Not Supported", "Unspecified Error",
431 "Timeout", "Failed", "Invalid Parameter", "DMTF Reserved",
432 "LogicalDevice Instance not Associated with Controller",
433 "Busy", "Method Reserved", "Vendor Specific" }]
434 uint32 DetachDevice (
435 [IN, Description (
436 "The ProtocolController instance.")]
437 CIM_ProtocolController REF ProtocolController,
438 [IN, Description (
439 "The LogicalDevice instance to detach.")]
440 CIM_LogicalDevice REF Device );
441 };
442 tony 1.1
443
444 // ==================================================================
445 // ProtocolControllerMaskingCapabilities
446 // ==================================================================
447 [Version ( "2.8.0" ), Description (
448 "A subclass of Capabilities that defines the Masking-related "
449 "capabilities of a ProtocolController.")]
450 class CIM_ProtocolControllerMaskingCapabilities : CIM_Capabilities {
451
452 [Description (
453 "A list of the valid values for StrorageHardwareID.IDType."),
454 ValueMap { "1", "2", "3", "4" },
455 Values { "Other", "Port WWN", "Node WWN", "Host Name" },
456 ArrayType ( "Indexed" )]
457 uint16 ValidHardwareIdTypes[];
458
459 [Description (
460 "An array of strings describing types for valid "
461 "StorageHardwareID.IDType. Used when the "
462 "ValidHardwareIdTypes includes 1 (\"Other\")."),
463 tony 1.1 ArrayType ( "Indexed" )]
464 string OtherValidHardwareIDTypes[];
465
466 [Description (
467 "An integer enumeration indicating the way that ports per "
468 "view (ProtocolController) are handled by the underlying "
469 "storage system."),
470 ValueMap { "2", "3", "4" },
471 Values { "One Port per View", "Multiple Ports per View",
472 "All Ports share the same View" }]
473 uint16 PortsPerView = 2;
474
475 [Description (
476 "Set to true if this storage system allows the client to "
477 "specify the DeviceNumber parameter when calling "
478 "ControllerConfigurationService.AttachDevice() and "
479 "ControllerConfigurationService.AttachDevice() and Set to "
480 "false if the implementation does not allow unit numbers to "
481 "vary for a ProtocolController. However, if set to false and "
482 "a Device is not the Dependent of a "
483 "ProtocolControllerForUnit association, the client must "
484 tony 1.1 "provide a DeviceNumber parameter in "
485 "ControllerConfigurationService.AttachDevice. If set to "
486 "false and the Device is already the Dependent of a "
487 "ProtocolControllerForUnit association, then the client can "
488 "omit the DeviceNumber parameter (or supply the same value) "
489 "in subsequent ControllerConfigurationService.AttachDevice "
490 "calls.")]
491 boolean ClientSelectableDeviceNumbers = TRUE;
492
493 [Description (
494 "Set to true if this storage system supports the "
495 "AttachDevice method.")]
496 boolean AttachDeviceSupported;
497
498 [Description (
499 "Set to true if this storage system limits configurations to "
500 "a single subject hardware ID per view. Otherwise, multiple "
501 "hardware ID types can be used. The default is FALSE, that "
502 "multiple ID types may be used in a single view.")]
503 boolean OneHardwareIDPerView = FALSE;
504
505 tony 1.1 [Description (
506 "When set to false, different ProtocolContollers attached to "
507 "a LogicalPort can expose the same unit numbers. If true, "
508 "then this storage system requires unique unit numbers "
509 "across all the ProtocolControllers connected to a "
510 "LogicalPort.")]
511 boolean UniqueUnitNumbersPerPort = FALSE;
512
513 [Description (
514 "Set to true if this storage system allows a client to "
515 "create a Privilege instance with PrivilegeGranted set to "
516 "FALSE.")]
517 boolean PrivilegeDeniedSupported = FALSE;
518
519 [Description (
520 "If true, this property indicates that a Privilege/Identity "
521 "pair MUST be specified when "
522 "CreateProtocolControllerWithPorts() is called. If false, "
523 "then the Privilege/Identity pair in "
524 "CreateProtocolControllerWithPorts() MUST NOT be set.")]
525 boolean ProtocolControllerRequiresAuthorizedIdentity = FALSE;
526 tony 1.1
527 [Description (
528 "If true, this property indicates that the Identity "
529 "parameter of CreateProtocolConntrollerWithPorts() MUST "
530 "contain a reference to a CIM_Collection (or subclass) or to "
531 "a CIM_Identity (or subclass).")]
532 boolean ProtocolControllerSupportsCollections = FALSE;
533 };
534
535
536 // ===================================================================
537 // end of file
538 // ===================================================================
|
Return to
Device28_ProtocolController.mof
CVS log
Up to [Pegasus] / pegasus / Schemas / CIM28