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