1 tony 1.1 // ===================================================================
2 // Title: Device Fibre Channel 2.8
3 // Filename: Device28_FC.mof
4 // Version: 2.8
5 // Release: Preliminary
6 // Date: 08/22/2003
7 // ===================================================================
8 // Copyright 2000-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 the
46 // concepts and classes to manage Fibre Channel devices
47 // and Zones.
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
54 // CR1001 - Update ZoneMembershipSettingData to use
55 // CIM_ConnectivityMembershipSettingData
56 // CR1032 - Add Zoning methods
57 // CR1035 - Add additional properties to FCPortStatistic
58 // CR1082 - Changed ref from CIM_ZoneAlias to
59 // CIM_NamedAddressCollection.
60 // Changed ZoneMemberSettingData to ZoneMembershipSettingData
61 // Corrected ValueMap for the method ActivateZoneSet
62 // CR1122 - Correct type of ZoneService.RequestedSessionState
63 //
64 tony 1.1 // Change Log for v2.7.1
65 // - Fix Value/ValueMap mismatch in FCPort.SupportedCOS and
66 // ActiveCOS
67 //
68 // Change Log for v2.7 Final
69 // CR940 - Fix Value/ValueMap mismatch in FCPort.ActiveFC4Types
70 // CR948 - Add additional value of "G" to FCPort.PortType
71 // CR970 - Removal of the Experimental qualifier
72 // - Move ZoneCapabilities to CIM V2.8, as Experimental
73 // CR975 - Clean up of Zone
74 // CR976 - Remove ZoneAlias in lieu of the Network's class
75 // NamedAddressCollection
76 // CR977 - Update to ZoneMemberSettingData to allow for common
77 // superclass of ConnectivitySettingData
78 //
79 // Change Log for v2.7
80 // CR630 - Add FCPort and FCPortStatistics
81 // CR674 - Add ZoneSet, Zone, ZoneAlias, ZoneMemberSettingData,
82 // ZoneService and ZoneCapabilities
83 // CR783 - Modify FCPort and FCPortStatistics
84 // ==================================================================
85 tony 1.1
86 #pragma locale ("en_US")
87
88
89 // ==================================================================
90 // FCPort
91 // ==================================================================
92 [Version ("2.7.1"), Description (
93 "Capabilities and management of a Fibre Channel Port Device.") ]
94 class CIM_FCPort : CIM_NetworkPort {
95
96 [Override ("PortType"), Description (
97 "The specific mode currently enabled for the Port. The "
98 "values: \"N\" = Node Port, \"NL\" = Node Port supporting FC "
99 "arbitrated loop, \"E\" = Expansion Port connecting fabric "
100 "elements (for example, FC switches), \"F\" = Fabric "
101 "(element) Port, \"FL\" = Fabric (element) Port supporting "
102 "FC arbitrated loop, \"B\" = Bridge and \"G\" = Generic "
103 "Port. PortTypes are defined in the ANSI X3 standards. "
104 "When set to 1 (\"Other\"), the related property "
105 "OtherPortType contains a string description of the port's "
106 tony 1.1 "type."),
107 ValueMap {"0", "1", "10", "11", "12", "13", "14", "15", "16",
108 "17", "18", "16000..65535"},
109 Values {"Unknown", "Other", "N", "NL", "F/NL", "Nx", "E", "F",
110 "FL", "B", "G", "Vendor Reserved"} ]
111 uint16 PortType;
112
113 [Description (
114 "An array of integers indicating the Fibre Channel Classes "
115 "of Service that are supported. The active COS are "
116 "indicated in ActiveCOS."),
117 ValueMap {"0", "1", "2", "3", "4", "5", "6", "7"},
118 Values {"Unknown", "1", "2", "3", "4", "5", "6", "F"} ]
119 uint16 SupportedCOS[];
120
121 [Description (
122 "An array of integers indicating the Classes of Service that "
123 "are active. The Active COS is indicated in ActiveCOS."),
124 ValueMap {"0", "1", "2", "3", "4", "5", "6", "7"},
125 Values {"Unknown", "1", "2", "3", "4", "5", "6", "F"},
126 ModelCorrespondence {"CIM_FCPort.SupportedCOS"} ]
127 tony 1.1 uint16 ActiveCOS[];
128
129 [Description (
130 "An array of integers indicating the Fibre Channel FC-4 "
131 "protocols supported. The protocols that are active and "
132 "running are indicated in the ActiveFC4Types property."),
133 ValueMap {"0", "1", "4", "5", "8", "9", "17", "18", "19", "21",
134 "22", "23", "25", "26", "27", "28", "32", "34", "36", "64",
135 "80", "81", "82", "88", "96", "255"},
136 Values {"Unknown", "Other", "ISO/IEC 8802 - 2 LLC",
137 "IP over FC", "SCSI - FCP", "SCSI - GPP", "IPI - 3 Master",
138 "IPI - 3 Slave", "IPI - 3 Peer", "CP IPI - 3 Master",
139 "CP IPI - 3 Slave", "CP IPI - 3 Peer", "SBCCS Channel",
140 "SBCCS Control Unit", "FC-SB-2 Channel",
141 "FC-SB-2 Control Unit",
142 "Fibre Channel Services (FC-GS, FC-GS-2, FC-GS-3)", "FC-SW",
143 "FC - SNMP", "HIPPI - FP", "BBL Control",
144 "BBL FDDI Encapsulated LAN PDU",
145 "BBL 802.3 Encapsulated LAN PDU", "FC - VI", "FC - AV",
146 "Vendor Unique"} ]
147 uint16 SupportedFC4Types[];
148 tony 1.1
149 [Description (
150 "An array of integers indicating the Fibre Channel FC-4 "
151 "protocols currently running. A list of all protocols "
152 "supported is indicated in the SupportedFC4Types property."),
153 ValueMap {"0", "1", "4", "5", "8", "9", "17", "18", "19", "21",
154 "22", "23", "25", "26", "27", "28", "32", "34", "36", "64",
155 "80", "81", "82", "88", "96", "255"},
156 Values {"Unknown", "Other", "ISO/IEC 8802 - 2 LLC",
157 "IP over FC", "SCSI - FCP", "SCSI - GPP", "IPI - 3 Master",
158 "IPI - 3 Slave", "IPI - 3 Peer", "CP IPI - 3 Master",
159 "CP IPI - 3 Slave", "CP IPI - 3 Peer", "SBCCS Channel",
160 "SBCCS Control Unit", "FC-SB-2 Channel",
161 "FC-SB-2 Control Unit",
162 "Fibre Channel Services (FC-GS, FC-GS-2, FC-GS-3)", "FC-SW",
163 "FC - SNMP", "HIPPI - FP", "BBL Control",
164 "BBL FDDI Encapsulated LAN PDU",
165 "BBL 802.3 Encapsulated LAN PDU", "FC - VI", "FC - AV",
166 "Vendor Unique"},
167 ModelCorrespondence {"CIM_FCPort.SupportedFC4Types"} ]
168 uint16 ActiveFC4Types[];
169 tony 1.1 };
170
171
172 // ==================================================================
173 // ZoneSet
174 // ==================================================================
175 [Version ("2.7.0"), Description (
176 "A ZoneSet is a group of zones that are managed collectively by "
177 "the same domain. The managing domain is indicated by the "
178 "HostedCollection association. For example, for Fibre Channel, "
179 "this would indicate a set of zones that are part of a fabric. "
180 "The zones are only under zone enforcement by the fabric, if "
181 "the zoneset is set to active.") ]
182 class CIM_ZoneSet : CIM_ConnectivityCollection {
183
184 [Required, Override ("ElementName"), Write, Description (
185 "A user-friendly name for the ZoneSet that is unique within "
186 "the AdminDomain.") ]
187 string ElementName;
188
189 [Required, Write, Description (
190 tony 1.1 "Indicates that this ZoneSet is currently active (i.e. "
191 "under enforcement of a fabric). This property can be used "
192 "to distinguish between a ZoneSet that is currently active "
193 "and a snapshot of a ZoneSet (with the same InstanceName) "
194 "that is for \"offline\" editing.") ]
195 boolean Active;
196 };
197
198
199 // ==================================================================
200 // Zone
201 // ==================================================================
202 [Version ("2.7.0"), Description (
203 "A zone is a group of Ports, Endpoints, Nodes, Zones, and/or "
204 "NamedAddressCollections that are managed collectively by the "
205 "same domain. The managing domain is indicated by the "
206 "HostedCollection association. For Fibre Channel, a zone "
207 "indicates a set of members that are participating together in "
208 "the fabric.") ]
209 class CIM_Zone : CIM_ConnectivityCollection {
210
211 tony 1.1 [Required, Override ("ElementName"), Write, Description (
212 "A user-friendly name for the Zone that is unique within the "
213 "AdminDomain.") ]
214 string ElementName;
215
216 [Required, Description (
217 "Indicates that this Zone is currently active (i.e. under "
218 "enforcement of a fabric). This property can be used to "
219 "distinguish between a Zone that is currently active and a "
220 "snapshot of a Zone (with the same InstanceName) that is for "
221 "\"offline\" editing.") ]
222 boolean Active;
223
224 [Required, Description (
225 "The type of zoning to be enforced."),
226 ValueMap {"0", "1", "2", "3", "..", "32768..65535"},
227 Values {"Unknown", "Other", "Default", "Protocol",
228 "DMTF Reserved", "Vendor Reserved"},
229 ModelCorrespondence {"CIM_Zone.OtherZoneTypeDescription"} ]
230 uint16 ZoneType;
231
232 tony 1.1 [Description (
233 "A string describing the ZoneType when the ZoneType value is "
234 "1 \"Other\"."),
235 ModelCorrespondence {"CIM_Zone.ZoneType"} ]
236 string OtherZoneTypeDescription;
237
238 [Description (
239 "Specific clarification when necessary when the ProtocolType "
240 "has an enumeration that requires it. Specifically, if "
241 "ProtocolType is \"Protocol\", then SubType the Fibre "
242 "Channel FC4 type."),
243 ValueMap {"0", "1", "2", "3", "4", "..", "32768..65535"},
244 Values {"Unknown", "Other", "SCSI", "VI", "IP", "DMTF Reserved",
245 "Vendor Reserved"},
246 ModelCorrespondence {"CIM_Zone.OtherZoneSubTypeDescription"} ]
247 uint16 ZoneSubType;
248
249 [Description (
250 "A string describing the ZoneSubType when the ZoneSubType "
251 "value is 1 \"Other\"."),
252 ModelCorrespondence {"CIM_Zone.ZoneSubType"} ]
253 tony 1.1 string OtherZoneSubTypeDescription;
254 };
255
256
257 // ==================================================================
258 // ZoneMembershipSettingData
259 // ==================================================================
260 [Experimental, Version ("2.7.1000"), Description (
261 "ZoneMembershipSettingData provides the identification criteria "
262 "for possible Zone and ZoneAlias members.") ]
263 class CIM_ZoneMembershipSettingData : CIM_ConnectivityMembershipSettingData {
264
265 [Override ("ConnectivityMemberType"), Description (
266 "ConnectivityMemberType specifies the type of identification "
267 "used in the ConnectivityMemberID field. For Fibre Channel, "
268 "several of the enumerated values require additional "
269 "explanation:\n"
270 "* A ConnectivityMemberType equal to 2 (Permanent Address) "
271 "indicates that an NxPort WWN value should be specified in "
272 "the related ConnectivityMemberID property\n"
273 "* A ConnectivityMemberType of 3 (Network Address) indicates "
274 tony 1.1 "that an NxPort Address ID value should be specified in the "
275 "related ConnectivityMemberID property\n"
276 "* A ConnectivityMemberType of 4 (Switch Port ID) indicates "
277 "that a Domain/Port Number value should be specified in the "
278 "related ConnectivityMemberID property\n"
279 "* A ConnectivityMemberType of 5 (Logical Port Group) "
280 "indicates that a Node WWN value should be specified in the "
281 "related ConnectivityMemberID property.") ]
282 uint16 ConnectivityMemberType;
283 };
284
285
286 // ==================================================================
287 // ZoneService
288 // ==================================================================
289 [Experimental, Version ("2.7.1000"), Description (
290 "The ZoneService if responsible for managing the zone "
291 "enforcement for the fabric. The ZoneService is hosted on an "
292 "AdminDomain. This is depicted by the HostedService "
293 "association.") ]
294 class CIM_ZoneService: CIM_Service {
295 tony 1.1
296 [Description (
297 "SessionState is an integer enumeration indicating whether "
298 "the session is currently starting (value = 2), or ended "
299 "(value = 3). It is possible that a particular instance of "
300 "a ZoneService may not support sessions. If this occurs, "
301 "the value 4 (\"Not Applicable\") is used."),
302 ValueMap {"0", "2", "3", "4"},
303 Values {"Unknown", "Starting", "Ended", "Not Applicable"} ]
304 uint16 SessionState = 4;
305
306 [Description (
307 "RequestedSessionState is an integer enumeration indicating "
308 "whether the ZoneService session has been requested to start "
309 "(value = 2), end (3), or terminate (4). Note that when "
310 "RequestedSessionState is set to 4 (\"Not Applicable\"), "
311 "then this property is not used. By default, the element's "
312 "RequestedSessionState is 5 (\"No Change\")."),
313 ValueMap {"2", "3", "4", "5"},
314 Values {"Start", "End", "Terminate", "No Change"},
315 ModelCorrespondence {"CIM_ZoneService.SessionState",
316 tony 1.1 "CIM_ZoneService.SessionControl()"} ]
317 uint16 RequestedSessionState = 5;
318
319 [Description (
320 "The method creates a ZoneSet and the association "
321 "HostedCollection. The newly created association, "
322 "HostedCollection, associates the Zone to the same "
323 "AdminDomain the ZoneService is hosted to. For the newly "
324 "created ZoneSet, the Active property is always set to false.\n\n"
325 "This method maybe deprecated in the future in lieu of "
326 "intrinsics once limitations in the CIM Operations are "
327 "addressed."),
328 ValueMap {"0", "1", "2", "3", "4", "5", "6", "7", "8", "9",
329 "10..0x0FFF", "0x1000..0x7777", "0x8000.."},
330 Values {"Success", "Not Supported", "Unspecified Error",
331 "Timeout", "Failed", "Invalid Parameter", "Access_Denied",
332 "Not_Found", "Already_Exists", "Insufficient_Resources",
333 "DMTF_Reserved", "Method_Reserved", "Vendor_Reserved"} ]
334 uint32 CreateZoneSet(
335 [IN, Required, Description (
336 "A user-friendly name for the ZoneSet that is unique "
337 tony 1.1 "within the AdminDomain."),
338 ModelCorrespondence {"CIM_ZoneSet.ElementName"}]
339 string ZoneSetName,
340 [OUT, IN(false), Description (
341 "A reference to the newly created Zone.")]
342 CIM_ZoneSet ref ZoneSet);
343
344 [Description (
345 "The method creates a Zone and the association "
346 "HostedCollection. The newly created association, "
347 "HostedCollection, associates the Zone to the same "
348 "AdminDomain the ZoneService is hosted to. For the newly "
349 "created Zone, the Active property is always set to false. \n\n"
350 "This method maybe deprecated in the future in lieu of "
351 "intrinsics once limitations in the CIM Operations are "
352 "addressed."),
353 ValueMap {"0", "1", "2", "3", "4", "5", "6", "7", "8", "9",
354 "10..0x0FFF", "0x1000..0x7777", "0x8000.."},
355 Values {"Success", "Not Supported", "Unspecified Error",
356 "Timeout", "Failed", "Invalid Parameter", "Access_Denied",
357 "Not_Found", "Already_Exists", "Insufficient_Resources",
358 tony 1.1 "DMTF_Reserved", "Method_Reserved", "Vendor_Reserved"} ]
359 uint32 CreateZone(
360 [IN, Required, Description (
361 "A user-friendly name for the Zone that is unique "
362 "within the AdminDomain."),
363 ModelCorrespondence {"CIM_Zone.ElementName"}]
364 string ZoneName,
365 [IN, Description (
366 "The type of zoning to be enforced."),
367 ValueMap {"2", "3"},
368 Values {"Default", "Protocol"},
369 ModelCorrespondence {"CIM_Zone.ZoneType"}]
370 uint16 ZoneType,
371 [IN, Description (
372 "Specific clarification when necessary when the ZoneType "
373 "has an enumeration that requires it. Specifically, if "
374 "ZoneType is \"Protocol\", then SubType is the Fibre Channel "
375 "FC4 type."),
376 ValueMap {"2", "3", "4"},
377 Values {"SCSI", "VI", "IP"},
378 ModelCorrespondence {"CIM_Zone.ZoneSubType"}]
379 tony 1.1 uint16 ZoneSubType,
380 [OUT,IN(false), Description (
381 "A reference to the newly created Zone.")]
382 CIM_Zone ref Zone);
383
384 [Description (
385 "The method creates a ZoneAlias and the association "
386 "HostedCollection. The newly created association, "
387 "HostedCollection, associates the ZoneAlias to the same "
388 "AdminDomain the ZoneService is hosted to. For the newly "
389 "created ZoneAlias, the Active property is always set to "
390 "false. \n\n"
391 "This method maybe deprecated in the future in lieu of "
392 "intrinsics once limitations in the CIM Operations are "
393 "addressed."),
394 ValueMap {"0", "1", "2", "3", "4", "5", "6", "7", "8", "9",
395 "10..0x0FFF", "0x1000..0x7777", "0x8000.."},
396 Values {"Success", "Not Supported", "Unspecified Error",
397 "Timeout", "Failed", "Invalid Parameter", "Access_Denied",
398 "Not_Found", "Already_Exists", "Insufficient_Resources",
399 "DMTF_Reserved", "Method_Reserved", "Vendor_Reserved"} ]
400 tony 1.1 uint32 CreateZoneAlias(
401 [IN, Required, Description (
402 "A name (alias) for the ZoneAlias which is unique "
403 "in the context of the hosting System."),
404 ModelCorrespondence {"CIM_ZoneAlias.CollectionAlias"}]
405 string CollectionAlias,
406 [OUT, IN(false), Description (
407 "A reference to the newly created ZoneAlias.")]
408 CIM_NamedAddressCollection ref ZoneAlias);
409
410 [Description (
411 "CreateZoneMembershipSettingData creates a "
412 "ZoneMembershipSettingData and adds it to the specified Zone "
413 "or ZoneAlias by creating a MemberOfCollection association.\n\n"
414 "This method maybe deprecated in the future in lieu of "
415 "intrinsics once limitations in the CIM Operations are "
416 "addressed."),
417 ValueMap {"0", "1", "2", "3", "4", "5", "6", "7", "8", "9",
418 "10..0x0FFF", "0x1000..0x7777", "0x8000.."},
419 Values {"Success", "Not Supported", "Unspecified Error",
420 "Timeout", "Failed", "Invalid Parameter", "Access_Denied",
421 tony 1.1 "Not_Found", "Already_Exists", "Insufficient_Resources",
422 "DMTF_Reserved", "Method_Reserved", "Vendor_Reserved"} ]
423 uint32 CreateZoneMembershipSettingData(
424 [IN, Required, Description (
425 "Identifies the type of identification "
426 "placed in ConnectivityMemberID."),
427 ValueMap {"0", "1", "2", "3", "4", "5", "..", "0x8000.."},
428 Values {"Unknown", "Other", "PermanentAddress",
429 "NetworkAddress", "SwitchPortID", "LogicalPortGroup",
430 "DMTF_Reserved", "Vendor_Reserved"},
431 ModelCorrespondence {"CIM_ZoneMembershipSettingData.ZoneMemberType"}]
432 uint16 ConnectivityMemberType,
433
434 [IN, Required, Description (
435 "This specifies the type of identification "
436 "used in the ConnectivityMemberID field. For Fibre Channel: \n"
437 "* A ConnectivityMemberType of 'PermanentAddress', the "
438 "ConnectivityMemberID is the NxPort WWN; \n"
439 "* A ConnectivityMemberType of 'NetworkAddress', the "
440 "ConnectivityMemberID is the NXPort Address ID; \n"
441 "* A ConnectivityMemberType of 'SwitchPortID', the "
442 tony 1.1 " ConnectivityMemberID is 'Domain:PortNumber'."),
443 ModelCorrespondence {"CIM_ZoneMembershipSettingData.ConnectivityMemberID"}]
444 string ConnectivityMemberID,
445
446 [IN, Required, Description (
447 "The collection that the ZoneMembershipSettingData should be "
448 "added to. The collection is either a Zone or ZoneAlias.") ]
449 CIM_SystemSpecificCollection ref SystemSpecificCollection,
450
451 [OUT, IN(false), Description (
452 "A reference to the newly created "
453 "ZoneMembershipSettingData.") ]
454 CIM_ZoneMembershipSettingData ref ZoneMembershipSettingData);
455
456 [Description (
457 "Adds to the ZoneSet the specified Zone. Adding a Zone to a "
458 "ZoneSet, extends the zone enforcement definition of the "
459 "ZoneSet to include the members of that Zone. If adding the "
460 "Zone is, successful, the Zone should be associated to the "
461 "ZoneSet by MemberOfCollection. \n\n"
462 "This method maybe deprecated in the future in lieu of "
463 tony 1.1 "intrinsics once limitations in the CIM Operations are "
464 "addressed."),
465 ValueMap {"0", "1", "2", "3", "4", "5", "6", "7", "8", "9",
466 "10..0x0FFF", "0x1000..0x7777", "0x8000.."},
467 Values {"Success", "Not Supported", "Unspecified Error",
468 "Timeout", "Failed", "Invalid Parameter", "Access_Denied",
469 "Not_Found", "Already_Exists", "Insufficient_Resources",
470 "DMTF_Reserved", "Method_Reserved", "Vendor_Reserved"} ]
471 uint32 AddZone(
472 [IN, Required, Description (
473 "A reference to the ZoneSet the Zone is added to.")]
474 CIM_ZoneSet ref ZoneSet,
475 [IN, Description (
476 "A reference to the Zone to be added to the ZoneSet.")]
477 CIM_Zone ref Zone);
478
479 [Description (
480 "Adds to the Zone or ZoneAlias the specified "
481 "ZoneMembershipSettingData. If adding the "
482 "ZoneMembershipSettingData is successful, an "
483 "ElementSettingData association will be created between the "
484 tony 1.1 "ZoneMembershipSettingData and either the Zone or "
485 "ZoneAlias. \n\n"
486 "This method maybe deprecated in the future in lieu of "
487 "intrinsics once limitations in the CIM Operations are "
488 "addressed."),
489 ValueMap {"0", "1", "2", "3", "4", "5", "6", "7", "8", "9",
490 "10..0x0FFF", "0x1000..0x7777", "0x8000.."},
491 Values {"Success", "Not Supported", "Unspecified Error",
492 "Timeout", "Failed", "Invalid Parameter", "Access_Denied",
493 "Not_Found", "Already_Exists", "Insufficient_Resources",
494 "DMTF_Reserved", "Method_Reserved", "Vendor_Reserved"} ]
495 uint32 AddZoneMembershipSettingData(
496 [IN, Required, Description (
497 "A reference to the Zone or ZoneAlias the "
498 "ZoneMembershipSettingData is to be added.")]
499 CIM_SystemSpecificCollection ref SystemSpecificCollection,
500 [IN, Description (
501 "A reference to the ZoneMembershipSettingData to be "
502 "added to the Zone or ZoneAlias.")]
503 CIM_ZoneMembershipSettingData ref ZoneMembershipSettingData);
504
505 tony 1.1 [Description (
506 "Adds to the Zone the specified ZoneAlias.\n\n"
507 "This method maybe deprecated in the future in lieu of "
508 "intrinsics once limitations in the CIM Operations are "
509 "addressed."),
510 ValueMap {"0", "1", "2", "3", "4", "5", "6", "7", "8", "9",
511 "10..0x0FFF", "0x1000..0x7777", "0x8000.."},
512 Values {"Success", "Not Supported", "Unspecified Error",
513 "Timeout", "Failed", "Invalid Parameter", "Access_Denied",
514 "Not_Found", "Already_Exists", "Insufficient_Resources",
515 "DMTF_Reserved", "Method_Reserved", "Vendor_Reserved"} ]
516 uint32 AddZoneAlias(
517 [IN, Required, Description (
518 "A reference to the Zone the ZoneAlias "
519 "is to be added")]
520 CIM_Zone ref Zone,
521 [IN, Description (
522 "A reference to the ZoneAlias to be "
523 "added to the Zone.")]
524 CIM_NamedAddressCollection ref ZoneAlias);
525
526 tony 1.1 [Description (
527 "Activates the specified ZoneSet. Once the ZoneSet in "
528 "activated, the ZoneSet and associatiated Zone, ZoneAliases, "
529 "and ZoneMembershipSettingData instances will have the "
530 "active flag set to true. \n\n"
531 "This method maybe deprecated in the future in lieu of "
532 "intrinsics once limitations in the CIM Operations are "
533 "addressed."),
534 ValueMap {"0", "1", "2", "3", "4", "5", "6", "7", "9",
535 "10..0x0FFF", "0x1000..0x7777", "0x8000.."},
536 Values {"Success", "Not Supported", "Unspecified Error",
537 "Timeout", "Failed", "Invalid Parameter", "Access_Denied",
538 "Not_Found", "Insufficient_Resources", "DMTF_Reserved",
539 "Method_Reserved", "Vendor_Reserved"} ]
540 uint32 ActivateZoneSet (
541 [IN, Required, Description (
542 "A reference to the ZoneSet to be activated.")]
543 CIM_ZoneSet ref ZoneSet,
544 [IN, Required, Description (
545 "Activate indicates whether the references ZoneSet "
546 "should be activated (Active=true) or deactivated "
547 tony 1.1 "(Active=false).")]
548 boolean Activate);
549
550 [Description (
551 "SessionControl requests that a session start (value = 2), "
552 "end (3), or terminate (4)."),
553 ValueMap {"0", "1", "2", "3", "4", "5", "6", "9", "10..0x0FFF",
554 "0x1000..0x7777", "0x8000.."},
555 Values {"Success", "Not Supported", "Unspecified Error",
556 "Timeout", "Failed", "Invalid Parameter", "Access_Denied",
557 "Insufficient_Resources", "DMTF_Reserved", "Method_Reserved",
558 "Vendor_Reserved"} ]
559 uint32 SessionControl (
560 [IN,
561 ValueMap {"2", "3", "4"},
562 Values {"Start", "End", "Terminate"},
563 ModelCorrespondence {"CIM_ZoneService.RequestedSessionState"}]
564 uint16 RequestedSessionState);
565 };
566
567
568 tony 1.1 // ==================================================================
569 // FibreProtocolService
570 // ==================================================================
571 [Version ("2.6.0"), Description (
572 "FibreProtocolService abstracts and allows the management of "
573 "the Alias, Management, Time, Security, Directory (Naming) and "
574 "other services and functions available in a Fibre Channel "
575 "network. This class will be further defined in a later "
576 "release of CIM.") ]
577 class CIM_FibreProtocolService : CIM_Service {
578 };
579
580
581 // ==================================================================
582 // FCPortStatistics
583 // ==================================================================
584 [Version ("2.7.1000"), Description (
585 "FCPortStatistics is the statistics for the FCPort.") ]
586 class CIM_FCPortStatistics : CIM_NetworkPortStatistics {
587
588 [Description (
589 tony 1.1 "LIPCount is the number of LIP events that have occurred on "
590 "an arbitrated loop."),
591 Counter ]
592 uint64 LIPCount;
593
594 [Description (
595 "NOSCount is the number of NOS events that have occurred on "
596 "the switched fabric."),
597 Counter ]
598 uint64 NOSCount;
599
600 [Description (
601 "ErrorFrames is the number of frames that have been received "
602 "in error."),
603 Counter ]
604 uint64 ErrorFrames;
605
606 [Description (
607 "DumpedFrames is the number of frames that were lost due to "
608 "a lack of host buffers available."),
609 Counter ]
610 tony 1.1 uint64 DumpedFrames;
611
612 [Description (
613 "LinkFailure is the number of times a link error has "
614 "occurred. This count is part of the Link Error Status "
615 "Block (LESB)."),
616 Counter ]
617 uint64 LinkFailures;
618
619 [Description (
620 "Number of times that signal is lost on the Port since last "
621 "reset of the Device. This count is part of the Link Error "
622 "Status Block (LESB)."),
623 Counter ]
624 uint64 LossOfSignalCounter;
625
626 [Description (
627 "Number of times that synchronization is lost on the Port "
628 "since last reset of the Device. Synchronization is assumed "
629 "lost after a timeout period (identified by the Receiver "
630 "TransmitterTimeout property) is exceeded. This count is "
631 tony 1.1 "part of the Link Error Status Block (LESB)."),
632 Counter ]
633 uint64 LossOfSyncCounter;
634
635 [Description (
636 "Count of primitive sequence protocol errors detected at "
637 "this port. This count is part of the Link Error Status "
638 "Block (LESB)."),
639 Counter ]
640 uint64 PrimitiveSeqProtocolErrCount;
641
642 [Description (
643 "Number of times that the CRC in a frame does not match the "
644 "CRC computed by the receiver. This count is part of the "
645 "Link Error Status Block (LESB)."),
646 Counter ]
647 uint64 CRCErrors;
648
649 [Description (
650 "The number of transmission words that had an invalid "
651 "character (8b10b code violation) in one or more of its "
652 tony 1.1 "characters, had a K28.5 (8b10b control) in its second, "
653 "third or fourth character positions, and/or had an "
654 "incorrect Beginning Running Disparity. This count is part "
655 "of the Link Error Status Block (LESB)."),
656 Counter ]
657 uint64 InvalidTransmissionWords;
658
659 [Description (
660 "The number of frames received that were shorter than 28 "
661 "octets. The value of 28 is calculated based on an "
662 "assumption of 24 header bytes plus 4 CRC bytes. The count "
663 "does not include SOF/EOF bytes which are not data."),
664 Counter ]
665 uint64 FramesTooShort;
666
667 [Description (
668 "The number of frames received that were longer than 2140 "
669 "octets. The value of 2140 is calculated based on an "
670 "assumption of 24 header bytes plus 4 CRC bytes and 2112 "
671 "bytes of payload."),
672 Counter ]
673 tony 1.1 uint64 FramesTooLong;
674
675 [Description (
676 "Count of frames received with unknown addressing. An "
677 "example is an unknown SID or DID. The SID or DID is not "
678 "known to the routing algorithm."),
679 Counter ]
680 uint64 AddressErrors;
681
682 [Description (
683 "Count of occurrences when all input buffers of a port were "
684 "full and outbound buffer-to-buffer credit transitioned to "
685 "zero. There is no credit to provide to other side."),
686 Counter ]
687 uint64 BufferCreditNotProvided;
688
689 [Description (
690 "Count of transitions in/out of BBcredit zero state. The "
691 "other side is not providing any credit."),
692 Counter ]
693 uint64 BufferCreditNotReceived;
694 tony 1.1
695 [Description (
696 "Count of invalid frame delimiters received at this port. "
697 "An example is a frame with a class 2 start and a class 3 at "
698 "the end."),
699 Counter ]
700 uint64 DelimiterErrors;
701
702 [Description (
703 "Count of disparity errors received at this port."),
704 Counter ]
705 uint64 EncodingDisparityErrors;
706
707 [Description (
708 "Count of Link resets. This is the number of LRs received."),
709 Counter ]
710 uint64 LinkResetsReceived;
711
712 [Description (
713 "Count of Link resets. This is the number of LRs "
714 "transmitted."),
715 tony 1.1 Counter ]
716 uint64 LinkResetsTransmitted;
717
718 [Description (
719 "Count of Multicast Frames or Packets received."),
720 Counter ]
721 uint64 MulticastFramesReceived;
722
723 [Description (
724 "Count of Multicast Frames or Packets transmitted."),
725 Counter ]
726 uint64 MulticastFramesTransmitted;
727
728 [Experimental, Description (
729 "FBSYFrames is the count of times that FBSY was returned to "
730 "the port."),
731 Counter,
732 MappingStrings
733 {"FC-SWAPI.T11|ErrorCounters|1.SWAPI_STATS_LBL_FBSY"} ]
734 uint64 FBSYFrames;
735
736 tony 1.1 [Experimental, Description (
737 "PBSYFrames is the count of times that PBSY was returned to "
738 "the port."),
739 Counter,
740 MappingStrings
741 {"FC-SWAPI.T11|ErrorCounters|1.SWAPI_STATS_LBL_PBSY"} ]
742 uint64 PBSYFrames;
743
744 [Experimental, Description (
745 "FRJTFrames is the count of times that FRJT was returned to "
746 "the port."),
747 Counter,
748 MappingStrings
749 {"FC-SWAPI.T11|ErrorCounters|1.SWAPI_STATS_LBL_FRJT"} ]
750 uint64 FRJTFrames;
751
752 [Experimental, Description (
753 "PRJTFrames is the count of times that PRJT was returned to "
754 "the port."),
755 Counter,
756 MappingStrings
757 tony 1.1 {"FC-SWAPI.T11|ErrorCounters|1.SWAPI_STATS_LBL_PRJT"} ]
758 uint64 PRJTFrames;
759
760 [Experimental, Description (
761 "RXClass1Frames is the count of class 1 frames received."),
762 Counter,
763 MappingStrings
764 {"FC-SWAPI.T11|PerformanceCounters|1.SWAPI_STATS_LBL_C1RF"} ]
765 uint64 RXClass1Frames;
766
767 [Experimental, Description (
768 "TXClass1Frames is the count of class 1 frames transmitted."),
769 Counter,
770 MappingStrings
771 {"FC-SWAPI.T11|PerformanceCounters|1.SWAPI_STATS_LBL_C1TF"} ]
772 uint64 TXClass1Frames;
773
774 [Experimental, Description (
775 "Class1FBSY is the count of times that FBSY was returned to "
776 "the port."),
777 Counter,
778 tony 1.1 MappingStrings
779 {"FC-SWAPI.T11|PerformanceCounters|1.SWAPI_STATS_LBL_C1FB"} ]
780 uint64 Class1FBSY;
781
782 [Experimental, Description (
783 "Class1PBSY is the count of times that PBSY was returned to "
784 "the port."),
785 Counter,
786 MappingStrings
787 {"FC-SWAPI.T11|PerformanceCounters|1.SWAPI_STATS_LBL_C1PB"} ]
788 uint64 Class1PBSY;
789
790 [Experimental, Description (
791 "Class1FRJT is the count of times that FRJT was returned to "
792 "the port."),
793 Counter,
794 MappingStrings
795 {"FC-SWAPI.T11|PerformanceCounters|1.SWAPI_STATS_LBL_C1FR"} ]
796 uint64 Class1FRJT;
797
798 [Experimental, Description (
799 tony 1.1 "Class1PRJT is the count of times that PRJT was returned to "
800 "the port."),
801 Counter,
802 MappingStrings
803 {"FC-SWAPI.T11|PerformanceCounters|1.SWAPI_STATS_LBL_C1PR"} ]
804 uint64 Class1PRJT;
805
806 [Experimental, Description (
807 "RXClass2Frames is the count of class 2 frames received."),
808 Counter,
809 MappingStrings
810 {"FC-SWAPI.T11|PerformanceCounters|1.SWAPI_STATS_LBL_C2RF"} ]
811 uint64 RXClass2Frames;
812
813 [Experimental, Description (
814 "TXClass2Frames is the count of class 2 frames transmitted."),
815 Counter,
816 MappingStrings
817 {"FC-SWAPI.T11|PerformanceCounters|1.SWAPI_STATS_LBL_C2LF"} ]
818 uint64 TXClass2Frames;
819
820 tony 1.1 [Experimental, Description (
821 "Class2FBSY is the count of times that FBSY was returned to "
822 "the port."),
823 Counter,
824 MappingStrings
825 {"FC-SWAPI.T11|PerformanceCounters|1.SWAPI_STATS_LBL_C2FB"} ]
826 uint64 Class2FBSY;
827
828 [Experimental, Description (
829 "Class2PBSY is the count of times that PBSY was returned to "
830 "the port."),
831 Counter,
832 MappingStrings
833 {"FC-SWAPI.T11|PerformanceCounters|1.SWAPI_STATS_LBL_C2PB"} ]
834 uint64 Class2PBSY;
835
836 [Experimental, Description (
837 "Class2FRJT is the count of times that FRJT was returned to "
838 "the port."),
839 Counter,
840 MappingStrings
841 tony 1.1 {"FC-SWAPI.T11|PerformanceCounters|1.SWAPI_STATS_LBL_C2FR"} ]
842 uint64 Class2FRJT;
843
844 [Experimental, Description (
845 "Class2PRJT is the count of times that PRJT was returned to "
846 "the port."),
847 Counter,
848 MappingStrings
849 {"FC-SWAPI.T11|PerformanceCounters|1.SWAPI_STATS_LBL_C2PR"} ]
850 uint64 Class2PRJT;
851
852 [Experimental, Description (
853 "RXClass3Frames is the count of class 3 frames received."),
854 Counter,
855 MappingStrings
856 {"FC-SWAPI.T11|PerformanceCounters|1.SWAPI_STATS_LBL_C3RF"} ]
857 uint64 RXClass3Frames;
858
859 [Experimental, Description (
860 "TXClass3Frames is the count of class 3 frames transmitted."),
861 Counter,
862 tony 1.1 MappingStrings
863 {"FC-SWAPI.T11|PerformanceCounters|1.SWAPI_STATS_LBL_C3TF"} ]
864 uint64 TXClass3Frames;
865
866 [Experimental, Description (
867 "Class3FramesDiscarded is the count of class 3 frames that "
868 "were discarded upon reception."),
869 Counter,
870 MappingStrings
871 {"FC-SWAPI.T11|PerformanceCounters|1.SWAPI_STATS_LBL_C3DC"} ]
872 uint64 Class3FramesDiscarded;
873
874 [Experimental, Description (
875 "RXBroadcastFrames is the count of broadcast frames or "
876 "packets received."),
877 Counter,
878 MappingStrings
879 {"FC-SWAPI.T11|PerformanceCounters|1.SWAPI_STATS_LBL_RBCO"} ]
880 uint64 RXBroadcastFrames;
881
882 [Experimental, Description (
883 tony 1.1 "TXBroadcastFrames is the count of broadcast frames or "
884 "packets transmitted."),
885 Counter,
886 MappingStrings
887 {"FC-SWAPI.T11|PerformanceCounters|1.SWAPI_STATS_LBL_TBCO"} ]
888 uint64 TXBroadcastFrames;
889 };
890
891
892 // ==================================================================
893 // FCPortRateStatistics
894 // ==================================================================
895 [Experimental, Version ("2.7.1000"), Description (
896 "FCPortRateStatistics is the performance rates for the FCPort. "
897 "The Frame and Byte rates report the average of a counter "
898 "change per second and the maximum counter change per second "
899 "over a specified interval, the SampleInterval, which is "
900 "defined in the parent class, StatisticalData.") ]
901 class CIM_FCPortRateStatistics : CIM_StatisticalData {
902
903 [Description (
904 tony 1.1 "TxFrameRate is the instantaneous transmit frame rate."),
905 MappingStrings
906 {"FC-SWAPI.T11|PerformanceRates|1.SWAPI_STATS_LBL_TFRR"},
907 ModelCorrespondence {"CIM_StatisticalData.SampleInterval"} ]
908 uint64 TxFrameRate;
909
910 [Description (
911 "RxFrameRate is the instantaneous receive frame rate."),
912 MappingStrings
913 {"FC-SWAPI.T11|PerformanceRates|1.SWAPI_STATS_LBL_RFRR"},
914 ModelCorrespondence {"CIM_StatisticalData.SampleInterval"} ]
915 uint64 RxFrameRate;
916
917 [Description (
918 "MaxTxFrameRate is the maximum transmit frame rate "
919 "achieved."),
920 MappingStrings
921 {"FC-SWAPI.T11|PerformanceRates|1.SWAPI_STATS_LBL_TFPR"},
922 ModelCorrespondence {"CIM_StatisticalData.SampleInterval"} ]
923 uint64 MaxTxFrameRate;
924
925 tony 1.1 [Description (
926 "MaxRxFrameRate is the maximum receive frame rate achieved."),
927 MappingStrings
928 {"FC-SWAPI.T11|PerformanceRates|1.SWAPI_STATS_LBL_RFPR"},
929 ModelCorrespondence {"CIM_StatisticalData.SampleInterval"} ]
930 uint64 MaxRxFrameRate;
931
932 [Description (
933 "TxRate is the instantaneous transmit byte rate."),
934 MappingStrings {"FC-SWAPI.T11|PerformanceRates|1. "
935 "SWAPI_STATS_LBL_TBYR"},
936 ModelCorrespondence {"CIM_StatisticalData.SampleInterval"} ]
937 uint64 TxRate;
938
939 [Description (
940 "RxRate is the instantaneous receive byte rate."),
941 MappingStrings
942 {"FC-SWAPI.T11|PerformanceRates|1.SWAPI_STATS_LBL_RBYR"},
943 ModelCorrespondence {"CIM_StatisticalData.SampleInterval"} ]
944 uint64 RxRate;
945
946 tony 1.1 [Description (
947 "PeakTxRate is the maximum transmit byte rate achieved."),
948 MappingStrings {"FC-SWAPI.T11|PerformanceRates|1. "
949 "SWAPI_STATS_LBL_TBPR"},
950 ModelCorrespondence {"CIM_StatisticalData.SampleInterval"} ]
951 uint64 PeakTxRate;
952
953 [Description (
954 "PeakRxRate is the maximum receive byte rate achieved."),
955 MappingStrings {"FC-SWAPI.T11|PerformanceRates|1. "
956 "SWAPI_STATS_LBL_RBPR"},
957 ModelCorrespondence {"CIM_StatisticalData.SampleInterval"} ]
958 uint64 PeakRxRate;
959 };
960
961
962 // ==================================================================
963 // ZoneCapabilities
964 // ==================================================================
965 [Experimental, Version ("2.7.1000"), Description (
966 "ZoneCapabilities exposes the capabilities for zoning of an "
967 tony 1.1 "AdminDomain.") ]
968 class CIM_ZoneCapabilities : CIM_Capabilities {
969
970 [Description (
971 "The maximum length for the Zone Name that the AdminDomain "
972 "is capable of supporting.") ]
973 uint32 ZoneNameMaxLen;
974
975 [Description (
976 "The ZoneNameFormat supported by the AdminDomain."),
977 ValueMap {"0", "2", "3", "..", "0x8000.."},
978 Values {"Unknown", "Numeric", "Alpha Numeric", "DMTF Reserved",
979 "Vendor Reserved"} ]
980 uint16 ZoneNameFormat;
981
982 [Description (
983 "The maximum number of ZoneSets that the AdminDomain is "
984 "capable of supporting.") ]
985 uint32 MaxNumZoneSets;
986
987 [Description (
988 tony 1.1 "The maximum number of Zones that the AdminDomain is capable "
989 "of supporting.") ]
990 uint32 MaxNumZone;
991
992 [Description (
993 "The maximum number of ZoneMembers that the AdminDomain is "
994 "capable of supporting.") ]
995 uint32 MaxNumZoneMembers;
996
997 [Description (
998 "The maximum number of Zones per ZoneSet that the "
999 "AdminDomain is capable of supporting.") ]
1000 uint32 MaxNumZonesPerZoneSet;
1001
1002 [Description (
1003 "The maximum number of ZoneAliases that the AdminDomain is "
1004 "capable of supporting.") ]
1005 uint32 MaxNumZoneAliases;
1006 };
1007
1008 // ===================================================================
1009 tony 1.1 // end of file
1010 // ===================================================================
|
Return to
Device28_FC.mof
CVS log
Up to [Pegasus] / pegasus / Schemas / CIMPrelim28