1 marek 1.1 // Copyright (c) 2009 DMTF.  All rights reserved.
  2              [Version ( "2.23.0" ), 
  3               UMLPackagePath ( "CIM::Device::FC" ), 
  4               Description ( 
  5                  "The ZoneService if responsible for managing the Zone "
  6                  "enforcement for the fabric. The ZoneService is hosted on an "
  7                  "AdminDomain. This relationship is depicted by the "
  8                  "HostedService association." )]
  9           class CIM_ZoneService : CIM_Service {
 10           
 11                 [Description ( 
 12                     "SessionState is an integer enumeration that indicates "
 13                     "whether the session is currently starting (value=2) or "
 14                     "has ended (value=3). It is possible that a particular "
 15                     "instance of a ZoneService might not support sessions. If "
 16                     "sessions are not supported, the value 4 (\"Not "
 17                     "Applicable\") is used." ), 
 18                  ValueMap { "0", "2", "3", "4" }, 
 19                  Values { "Unknown", "Starting", "Ended", "Not Applicable" }]
 20              uint16 SessionState = 4;
 21           
 22 marek 1.1       [Description ( 
 23                     "RequestedSessionState is an integer enumeration that "
 24                     "indicates whether the ZoneService session has been "
 25                     "requested to start (value=2), end (value=3), or "
 26                     "terminate (value=4). Note that when "
 27                     "RequestedSessionState is set to 4 (\"Not Applicable\"), "
 28                     "then this property is not used. By default, the "
 29                     "RequestedSessionState of the element is 5 (\"No "
 30                     "Change\")." ), 
 31                  ValueMap { "2", "3", "4", "5" }, 
 32                  Values { "Start", "End", "Terminate", "No Change" }, 
 33                  ModelCorrespondence { "CIM_ZoneService.SessionState", 
 34                     "CIM_ZoneService.SessionControl()" }]
 35              uint16 RequestedSessionState = 5;
 36           
 37                 [Description ( 
 38                     "DefaultZoningState indicates whether fabric members "
 39                     "(devices) that are not in any other active Zones can "
 40                     "access each other. In particular, if no Zones are "
 41                     "active, a DefaultZoningState \"Allow\" indicates that "
 42                     "all fabric members can access each other." ), 
 43 marek 1.1        ValueMap { "0", "2", "3" }, 
 44                  Values { "Unknown", "Allow", "Deny" }]
 45              uint16 DefaultZoningState;
 46           
 47           
 48                 [Description ( 
 49                     "The method creates a ZoneSet and the association "
 50                     "HostedCollection. The newly created association, "
 51                     "HostedCollection, associates the Zone to the same "
 52                     "AdminDomain that the ZoneService is hosted to. For the "
 53                     "newly created ZoneSet, the Active property is always set "
 54                     "to false. \n"
 55                     "\n"
 56                     "This method might be deprecated in the future in lieu of "
 57                     "intrinsics after limitations in the CIM Operations are "
 58                     "addressed." ), 
 59                  ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", 
 60                     "10..0x0FFF", "0x1000..0x7777", "0x8000.." }, 
 61                  Values { "Success", "Not Supported", "Unspecified Error", 
 62                     "Timeout", "Failed", "Invalid Parameter", "Access_Denied", 
 63                     "Not_Found", "Already_Exists", "Insufficient_Resources", 
 64 marek 1.1           "DMTF_Reserved", "Method_Reserved", "Vendor_Reserved" }]
 65              uint32 CreateZoneSet(
 66                    [Required, IN, Description ( 
 67                        "A user-friendly name for the ZoneSet that is "
 68                        "unique within the AdminDomain." ), 
 69                     ModelCorrespondence { "CIM_ZoneSet.ElementName" }]
 70                 string ZoneSetName, 
 71                    [IN, OUT, Description ( 
 72                        "A reference to the newly created Zone." )]
 73                 CIM_ZoneSet REF ZoneSet);
 74           
 75                 [Description ( 
 76                     "The method creates a Zone and the association "
 77                     "HostedCollection. The newly created association, "
 78                     "HostedCollection, associates the Zone to the same "
 79                     "AdminDomain that the ZoneService is hosted to. For the "
 80                     "newly created Zone, the Active property is always set to "
 81                     "false. \n"
 82                     "\n"
 83                     "This method might be deprecated in the future in lieu of "
 84                     "intrinsics after limitations in the CIM Operations are "
 85 marek 1.1           "addressed." ), 
 86                  ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", 
 87                     "10..0x0FFF", "0x1000..0x7777", "0x8000.." }, 
 88                  Values { "Success", "Not Supported", "Unspecified Error", 
 89                     "Timeout", "Failed", "Invalid Parameter", "Access_Denied", 
 90                     "Not_Found", "Already_Exists", "Insufficient_Resources", 
 91                     "DMTF_Reserved", "Method_Reserved", "Vendor_Reserved" }]
 92              uint32 CreateZone(
 93                    [Required, IN, Description ( 
 94                        "A user-friendly name for the Zone that is unique "
 95                        "within the AdminDomain." ), 
 96                     ModelCorrespondence { "CIM_Zone.ElementName" }]
 97                 string ZoneName, 
 98                    [IN, Description ( "The type of zoning to be enforced." ), 
 99                     ValueMap { "2", "3" }, 
100                     Values { "Default", "Protocol" }, 
101                     ModelCorrespondence { "CIM_Zone.ZoneType" }]
102                 uint16 ZoneType, 
103                    [IN, Description ( 
104                        "Specific clarification to be used when the "
105                        "ZoneType has an enumeration that requires it. "
106 marek 1.1              "Specifically, if ZoneType is \"Protocol\", then "
107                        "SubType is the Fibre Channel FC4 type." ), 
108                     ValueMap { "2", "3", "4" }, 
109                     Values { "SCSI", "VI", "IP" }, 
110                     ModelCorrespondence { "CIM_Zone.ZoneSubType" }]
111                 uint16 ZoneSubType, 
112                    [IN, OUT, Description ( 
113                        "A reference to the newly created Zone." )]
114                 CIM_Zone REF Zone);
115           
116                 [Description ( 
117                     "The method creates a ZoneAlias and the association "
118                     "HostedCollection. The newly created association, "
119                     "HostedCollection, associates the ZoneAlias to the same "
120                     "AdminDomain that the ZoneService is hosted to. For the "
121                     "newly created ZoneAlias, the Active property is always "
122                     "set to false. \n"
123                     "\n"
124                     "This method might be deprecated in the future in lieu of "
125                     "intrinsics after limitations in the CIM Operations are "
126                     "addressed." ), 
127 marek 1.1        ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", 
128                     "10..0x0FFF", "0x1000..0x7777", "0x8000.." }, 
129                  Values { "Success", "Not Supported", "Unspecified Error", 
130                     "Timeout", "Failed", "Invalid Parameter", "Access_Denied", 
131                     "Not_Found", "Already_Exists", "Insufficient_Resources", 
132                     "DMTF_Reserved", "Method_Reserved", "Vendor_Reserved" }]
133              uint32 CreateZoneAlias(
134                    [Required, IN, Description ( 
135                        "A name (alias) for the ZoneAlias that is unique in "
136                        "the context of the hosting System." ), 
137                     ModelCorrespondence { "CIM_ZoneAlias.CollectionAlias" }]
138                 string CollectionAlias, 
139                    [IN, OUT, Description ( 
140                        "A reference to the newly created ZoneAlias." )]
141                 CIM_NamedAddressCollection REF ZoneAlias);
142           
143                 [Description ( 
144                     "CreateZoneMembershipSettingData creates a "
145                     "ZoneMembershipSettingData and adds it to the specified "
146                     "Zone or ZoneAlias by creating a MemberOfCollection "
147                     "association. \n"
148 marek 1.1           "\n"
149                     "This method might be deprecated in the future in lieu of "
150                     "intrinsics after limitations in the CIM Operations are "
151                     "addressed." ), 
152                  ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", 
153                     "10..0x0FFF", "0x1000..0x7777", "0x8000.." }, 
154                  Values { "Success", "Not Supported", "Unspecified Error", 
155                     "Timeout", "Failed", "Invalid Parameter", "Access_Denied", 
156                     "Not_Found", "Already_Exists", "Insufficient_Resources", 
157                     "DMTF_Reserved", "Method_Reserved", "Vendor_Reserved" }]
158              uint32 CreateZoneMembershipSettingData(
159                    [Required, IN, Description ( 
160                        "Identifies the type of identification placed in "
161                        "ConnectivityMemberID." ), 
162                     ValueMap { "0", "1", "2", "3", "4", "5", "..", 
163                        "0x8000.." }, 
164                     Values { "Unknown", "Other", "PermanentAddress", 
165                        "NetworkAddress", "SwitchPortID", 
166                        "LogicalPortGroup", "DMTF_Reserved", 
167                        "Vendor_Reserved" }, 
168                     ModelCorrespondence { 
169 marek 1.1              "CIM_ZoneMembershipSettingData.ZoneMemberType" }]
170                 uint16 ConnectivityMemberType, 
171                    [Required, IN, Description ( 
172                        "This property specifies the type of identification "
173                        "used in the ConnectivityMemberID field. For Fibre "
174                        "Channel: \n"
175                        "* A ConnectivityMemberType of \'PermanentAddress\', "
176                        "the ConnectivityMemberID is the NxPort WWN; \n"
177                        "* A ConnectivityMemberType of \'NetworkAddress\', "
178                        "the ConnectivityMemberID is the NXPort Address ID; \n"
179                        "* A ConnectivityMemberType of \'SwitchPortID\', "
180                        "the ConnectivityMemberID is \'Domain:PortNumber\'." ), 
181                     ModelCorrespondence { 
182                        "CIM_ZoneMembershipSettingData.ConnectivityMemberID" }]
183                 string ConnectivityMemberID, 
184                    [Required, IN, Description ( 
185                        "The collection that the ZoneMembershipSettingData "
186                        "should be added to. The collection is either a "
187                        "Zone or ZoneAlias." )]
188                 CIM_SystemSpecificCollection REF SystemSpecificCollection, 
189                    [IN, OUT, Description ( 
190 marek 1.1              "A reference to the newly created ZoneMembershipSettingData."
191                         )]
192                 CIM_ZoneMembershipSettingData REF ZoneMembershipSettingData);
193           
194                 [Description ( 
195                     "Adds to the ZoneSet the specified Zone. Adding a Zone to "
196                     "a ZoneSet, extends the zone enforcement definition of "
197                     "the ZoneSet to include the members of that Zone. If "
198                     "adding the Zone is successful, the Zone should be "
199                     "associated with the ZoneSet by MemberOfCollection. \n"
200                     "\n"
201                     "This method might be deprecated in the future in lieu of "
202                     "intrinsics after limitations in the CIM Operations are "
203                     "addressed." ), 
204                  ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", 
205                     "10..0x0FFF", "0x1000..0x7777", "0x8000.." }, 
206                  Values { "Success", "Not Supported", "Unspecified Error", 
207                     "Timeout", "Failed", "Invalid Parameter", "Access_Denied", 
208                     "Not_Found", "Already_Exists", "Insufficient_Resources", 
209                     "DMTF_Reserved", "Method_Reserved", "Vendor_Reserved" }]
210              uint32 AddZone(
211 marek 1.1          [Required, IN, Description ( 
212                        "A reference to the ZoneSet that the Zone is added to."
213                         )]
214                 CIM_ZoneSet REF ZoneSet, 
215                    [IN, Description ( 
216                        "A reference to the Zone that is to be added to the ZoneSet."
217                         )]
218                 CIM_Zone REF Zone);
219           
220                 [Description ( 
221                     "Adds to the Zone or ZoneAlias, the specified "
222                     "ZoneMembershipSettingData. If adding the "
223                     "ZoneMembershipSettingData is successful, an "
224                     "ElementSettingData association will be created between "
225                     "the ZoneMembershipSettingData and either the Zone or "
226                     "ZoneAlias. \n"
227                     "\n"
228                     "This method might be deprecated in the future in lieu of "
229                     "intrinsics after limitations in the CIM Operations are "
230                     "addressed." ), 
231                  ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", 
232 marek 1.1           "10..0x0FFF", "0x1000..0x7777", "0x8000.." }, 
233                  Values { "Success", "Not Supported", "Unspecified Error", 
234                     "Timeout", "Failed", "Invalid Parameter", "Access_Denied", 
235                     "Not_Found", "Already_Exists", "Insufficient_Resources", 
236                     "DMTF_Reserved", "Method_Reserved", "Vendor_Reserved" }]
237              uint32 AddZoneMembershipSettingData(
238                    [Required, IN, Description ( 
239                        "A reference to the Zone or ZoneAlias that the "
240                        "ZoneMembershipSettingData is to be added to." )]
241                 CIM_SystemSpecificCollection REF SystemSpecificCollection, 
242                    [IN, Description ( 
243                        "A reference to the ZoneMembershipSettingData that "
244                        "is to be added to the Zone or ZoneAlias." )]
245                 CIM_ZoneMembershipSettingData REF ZoneMembershipSettingData);
246           
247                 [Description ( 
248                     "Adds to the Zone the specified ZoneAlias. \n"
249                     "\n"
250                     "This method might be deprecated in the future in lieu of "
251                     "intrinsics after limitations in the CIM Operations are "
252                     "addressed." ), 
253 marek 1.1        ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", 
254                     "10..0x0FFF", "0x1000..0x7777", "0x8000.." }, 
255                  Values { "Success", "Not Supported", "Unspecified Error", 
256                     "Timeout", "Failed", "Invalid Parameter", "Access_Denied", 
257                     "Not_Found", "Already_Exists", "Insufficient_Resources", 
258                     "DMTF_Reserved", "Method_Reserved", "Vendor_Reserved" }]
259              uint32 AddZoneAlias(
260                    [Required, IN, Description ( 
261                        "A reference to the Zone that the ZoneAlias is to be added to."
262                         )]
263                 CIM_Zone REF Zone, 
264                    [IN, Description ( 
265                        "A reference to the ZoneAlias that is to be added to the Zone."
266                         )]
267                 CIM_NamedAddressCollection REF ZoneAlias);
268           
269                 [Description ( 
270                     "Activates the specified ZoneSet. After the ZoneSet is "
271                     "activated, the ZoneSet, associated Zone, ZoneAliases, "
272                     "and ZoneMembershipSettingData instances will have the "
273                     "active flag set to true. \n"
274 marek 1.1           "\n"
275                     "This method might be deprecated in the future in lieu of "
276                     "intrinsics after limitations in the CIM Operations are "
277                     "addressed." ), 
278                  ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "9", 
279                     "10..0x0FFF", "0x1000..0x7777", "0x8000.." }, 
280                  Values { "Success", "Not Supported", "Unspecified Error", 
281                     "Timeout", "Failed", "Invalid Parameter", "Access_Denied", 
282                     "Not_Found", "Insufficient_Resources", "DMTF_Reserved", 
283                     "Method_Reserved", "Vendor_Reserved" }]
284              uint32 ActivateZoneSet(
285                    [Required, IN, Description ( 
286                        "A reference to the ZoneSet to be activated." )]
287                 CIM_ZoneSet REF ZoneSet, 
288                    [Required, IN, Description ( 
289                        "Activate indicates whether the references to "
290                        "ZoneSet should be activated (Active=true) or "
291                        "deactivated (Active=false)." )]
292                 boolean Activate);
293           
294                 [Description ( 
295 marek 1.1           "SessionControl requests that a session start (value=2), "
296                     "end (value=3), or terminate (value=4)." ), 
297                  ValueMap { "0", "1", "2", "3", "4", "5", "6", "9", 
298                     "10..0x0FFF", "0x1000..0x7777", "0x8000.." }, 
299                  Values { "Success", "Not Supported", "Unspecified Error", 
300                     "Timeout", "Failed", "Invalid Parameter", "Access_Denied", 
301                     "Insufficient_Resources", "DMTF_Reserved", 
302                     "Method_Reserved", "Vendor_Reserved" }]
303              uint32 SessionControl(
304                    [IN, Description ( 
305                        "RequestedSessionState is an integer enumeration "
306                        "that indicates whether the ZoneService session has "
307                        "been requested to start (value=2), end (value=3), "
308                        "or terminate (value=4)." ), 
309                     ValueMap { "2", "3", "4" }, 
310                     Values { "Start", "End", "Terminate" }, 
311                     ModelCorrespondence { 
312                        "CIM_ZoneService.RequestedSessionState" }]
313                 uint16 RequestedSessionState);
314           
315           };