1 marek 1.1 // Copyright (c) 2005 DMTF.  All rights reserved.
  2           // <change cr="DMTFCR01299" type = "change"> Add iSCSI support to the enum of ID Types used for SCSI LUN Masking </change>
  3           // <change cr="ArchCR00066.004" type="add">Add UmlPackagePath
  4           // qualifier values to CIM Schema.</change>
  5           // ==================================================================
  6           //  CIM_StorageHardwareIDManagementService 
  7           // ==================================================================
  8              [Version ( "2.8.1000" ), 
  9               UMLPackagePath ( "CIM::User::StorageHardwareID" ), 
 10               Description ( 
 11                  "StorageHardwareIDManagementService provides methods for "
 12                  "manipulating instances of StorageHardwareIDs and manipulating "
 13                  "the trust of these IDs in the underlying storage system." )]
 14           class CIM_StorageHardwareIDManagementService : CIM_AuthenticationService {
 15           
 16           
 17                 [Description ( 
 18                     "This method creates a CIM_StorageHardwareID, it creates "
 19                     "the association CIM_ConcreteDependency between this "
 20                     "service and the new CIM_StorageHardwareID." ), 
 21                  ValueMap { "0", "1", "2", "3", "4", "5", "6..0xFFF", 
 22 marek 1.1           "0x1000", "0x1001", "0x1003..0x7FFF", "0x8000.." }, 
 23                  Values { "Success", "Not Supported", "Unspecified Error", 
 24                     "Timeout", "Failed", "Invalid Parameter", "DMTF Reserved", 
 25                     "ID already created", 
 26                     "Hardware implementation does not support specified IDType", 
 27                     "Method Reserved", "Vendor Specific" }]
 28              uint32 CreateStorageHardwareID(
 29                    [IN, Description ( 
 30                        "The ElementName of the new StorageHardwareID instance."
 31                         )]
 32                 string ElementName, 
 33                    [IN, Description ( 
 34                        "StorageID is the value used by the SecurityService "
 35                        "to represent Identity - in this case, a hardware "
 36                        "worldwide unique name." )]
 37                 string StorageID, 
 38                    [IN, Description ( 
 39                        "The type of the StorageID property. iSCSI IDs may "
 40                        "use one of three iSCSI formats - iqn, eui, or naa. "
 41                        "This three letter format is the name prefix; so a "
 42                        "single iSCSI type is provided here, the prefix can "
 43 marek 1.1              "be used to further refine the format." ), 
 44                     ValueMap { "1", "2", "3", "4", "5" }, 
 45                     Values { "Other", "PortWWN", "NodeWWN", "Hostname", 
 46                        "iSCSI Name" }]
 47                 uint16 IDType, 
 48                    [IN, Description ( 
 49                        "The type of the storage ID, when IDType is \"Other\"."
 50                         )]
 51                 string OtherIDType, 
 52                    [IN, Description ( 
 53                        "REF to the StorageClientSettingData containing the "
 54                        "OSType appropriate for this initiator. If left "
 55                        "NULL, the instrumentation assumes a standard "
 56                        "OSType - i.e., that no OS-specific behavior for "
 57                        "this initiator is defined." )]
 58                 CIM_StorageClientSettingData REF Setting, 
 59                    [IN ( false ), OUT, Description ( 
 60                        "REF to the new StorageHardwareID instance." )]
 61                 CIM_StorageHardwareID REF HardwareID);
 62           
 63                 [Description ( 
 64 marek 1.1           "This method deletes a named CIM_StorageHardwareID, and "
 65                     "also tears down the associations that are no longer "
 66                     "needed, including CIM_ConcreteDependency and "
 67                     "CIM_AuthorizedSubject." ), 
 68                  ValueMap { "0", "1", "2", "3", "4", "5", "6..0xFFF", 
 69                     "0x1000", "0x1001..0x7FFF", "0x8000.." }, 
 70                  Values { "Success", "Not Supported", "Unspecified Error", 
 71                     "Timeout", "Failed", "Invalid Parameter", "DMTF Reserved", 
 72                     "Specified instance not found", "Method Reserved", 
 73                     "Vendor Specific" }]
 74              uint32 DeleteStorageHardwareID(
 75                    [IN, Description ( 
 76                        "The storage hardware ID to be deleted." )]
 77                 CIM_StorageHardwareID REF HardwareID);
 78           
 79                 [Description ( 
 80                     "This method creates a CIM_GatewayPathID and the "
 81                     "association CIM_ConcreteDependency between this service "
 82                     "and the new GatewayPathID." ), 
 83                  ValueMap { "0", "1", "2", "3", "4", "5", "6..0xFFF", 
 84                     "0x1000", "0x1001", "0x1003", "0x1004", "0x1005..0x7FFF", 
 85 marek 1.1           "0x8000.." }, 
 86                  Values { "Success", "Not Supported", "Unspecified Error", 
 87                     "Timeout", "Failed", "Invalid Parameter", "DMTF Reserved", 
 88                     "ID already created", 
 89                     "Hardware implementation does not support specified IDType", 
 90                     "GatewayPathID already created", 
 91                     "Hardware implementation does not support specified GatewayIDType", 
 92                     "Method Reserved", "Vendor Specific" }]
 93              uint32 CreateGatewayPathID(
 94                    [IN, Description ( 
 95                        "The ElementName of the new StorageHardwareID instance."
 96                         )]
 97                 string ElementName, 
 98                    [IN, Description ( 
 99                        "StorageID is the value used by the SecurityService "
100                        "to represent Identity - in this case, a hardware "
101                        "worldwide unique name." )]
102                 string StorageID, 
103                    [IN, Description ( 
104                        "The type of the StorageID property. iSCSI IDs may "
105                        "use one of three iSCSI formats - iqn, eui, or naa. "
106 marek 1.1              "This three letter format is the name prefix; so a "
107                        "single iSCSI type is provided here, the prefix can "
108                        "be used to further refine the format." ), 
109                     ValueMap { "1", "2", "3", "4", "5" }, 
110                     Values { "Other", "PortWWN", "NodeWWN", "Hostname", 
111                        "iSCSI Name" }]
112                 uint16 IDType, 
113                    [IN, Description ( 
114                        "The type of the storage ID, when IDType is \"Other\"."
115                         )]
116                 string OtherIDType, 
117                    [IN, Description ( 
118                        "GatewayID is the value used by the SecurityService "
119                        "to represent identity of a Gateway element." )]
120                 string GatewayID, 
121                    [IN, Description ( 
122                        "The type of the GatewayID property. iSCSI IDs may "
123                        "use one of three iSCSI formats - iqn, eui, or naa. "
124                        "This three letter format is the name prefix; so a "
125                        "single iSCSI type is provided here, the prefix can "
126                        "be used to further refine the format." ), 
127 marek 1.1           ValueMap { "1", "2", "3", "4", "5" }, 
128                     Values { "Other", "PortWWN", "NodeWWN", "Hostname", 
129                        "iSCSI Name" }]
130                 uint16 GatewayIDType, 
131                    [IN, Description ( 
132                        "The type of the storage ID, when GatewayIDType is \"Other\"."
133                         )]
134                 string OtherGatewayIDType, 
135                    [IN ( false ), OUT, Description ( 
136                        "REF to the new GatewayPathID instance." )]
137                 CIM_GatewayPathID REF NewGatewayPathID);
138           
139                 [Description ( 
140                     "Create a group of StorageHardwareIDs as a new instance "
141                     "of SystemSpecificCollection. This is useful to define a "
142                     "set of authorized subjects that can access volumes in a "
143                     "disk array. This method allows the client to make a "
144                     "request of a specific Service instance to create the "
145                     "collection and provide the appropriate class name. When "
146                     "these capabilities are standardized in CIM/WBEM, this "
147                     "method can be deprecated and intrinsic methods used. In "
148 marek 1.1           "addition to creating the collection, this method causes "
149                     "the creation of the HostedCollection association (to "
150                     "this service\'s scoping system) and MemberOfCollection "
151                     "association to members of the IDs parameter." ), 
152                  ValueMap { "0", "1", "2", "3", "4", "5", "6..0xFFF", 
153                     "0x1000", "0x1001", "0x1002", "0x1003..0x7FFF", "0x8000.." }, 
154                  Values { "Success", "Not Supported", "Unspecified Error", 
155                     "Timeout", "Failed", "Invalid Parameter", "DMTF Reserved", 
156                     "Invalid HardwareID instance", 
157                     "Implementation does not support hardware ID collections", 
158                     "Input hardware IDs cannot be used in same collection", 
159                     "Method Reserved", "Vendor Specific" }]
160              uint32 CreateHardwareIDCollection(
161                    [IN, Description ( 
162                        "The ElementName to be assigned to the created collection."
163                         )]
164                 string ElementName, 
165                    [IN, Description ( 
166                        "Array of strings containing representations of "
167                        "references to StorageHardwareID instances that "
168                        "will become members of the new collection." )]
169 marek 1.1       string HardwareIDs[], 
170                    [IN ( false ), OUT, Description ( 
171                        "The new instance of SystemSpecificCollection that is created."
172                         )]
173                 CIM_SystemSpecificCollection REF Collection);
174           
175                 [Description ( 
176                     "Create MemberOfCollection instances between the "
177                     "specified Collection and the StorageHardwareIDs. This "
178                     "method allows the client to make a request of a specific "
179                     "Service instance to create the associations. When these "
180                     "capabilities are standardized in CIM/WBEM, this method "
181                     "can be deprecated and intrinsic methods used." ), 
182                  ValueMap { "0", "1", "2", "3", "4", "5", "6..0xFFF", 
183                     "0x1000", "0x1001", "0x1002", "0x1003..0x7FFF", "0x8000.." }, 
184                  Values { "Success", "Not Supported", "Unspecified Error", 
185                     "Timeout", "Failed", "Invalid Parameter", "DMTF Reserved", 
186                     "Invalid LogicalDevice instance", 
187                     "Implementation does not support device collections", 
188                     "Input devices cannot be used in this collection", 
189                     "Method Reserved", "Vendor Specific" }]
190 marek 1.1    uint32 AddHardwareIDsToCollection(
191                    [IN, Description ( 
192                        "Array of strings containing representations of "
193                        "references to StorageHardwareID instances that "
194                        "will become members of the collection." )]
195                 string HardwareIDs[], 
196                    [IN, Description ( 
197                        "The Collection which groups the StorageHardwareIDs." )]
198                 CIM_SystemSpecificCollection REF Collection);
199           
200           };