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