1 karl  1.1.2.2 // Copyright (c) 2009 DMTF.  All rights reserved.
  2                  [Version ( "2.22.0" ), 
  3                   UMLPackagePath ( "CIM::Device::Ports" ), 
  4                   Description ( 
  5                      "Provides methods for configuring parameters of Wi-Fi ports and "
  6                      "the Wi-Fi protocol endpoints associated with them." )]
  7               class CIM_WiFiPortConfigurationService : CIM_NetworkPortConfigurationService {
  8               
  9               
 10                     [Description ( 
 11                         "Shall atomically create settings that enable a "
 12                         "WiFiEndpoint to connect to a given Wi-Fi network. These "
 13                         "settings include the name (SSID) of the network as well "
 14                         "as the security parameters used by the WiFiEndpoint to "
 15                         "authenticate to the network and encrypt frames it "
 16                         "transmits into the network and decrypt the frames it "
 17                         "receives from the network. Upon successful completion, a "
 18                         "new instance of CIM_WiFiEndpointSettings shall be "
 19                         "associated to the CIM_WiFiEndpoint referenced by the "
 20                         "WiFiEndpoint parameter, through a new instance of "
 21                         "CIM_ElementSettingData. If the IEEE8021xSettingsInput "
 22 karl  1.1.2.2           "parameter is not null, a new instance of "
 23                         "CIM_IEEE8021xSettings containing its property values "
 24                         "shall be associated to the new instance of "
 25                         "CIM_WiFiEndpointSettings through a new instance of "
 26                         "CIM_ConcreteComponent upon successful completion. "
 27                         "Alternatively, if the IEEE8021xSettingsInputReference "
 28                         "parameter is not null, the CIM_IEEE8021xSettings that it "
 29                         "references shall be associated to the new instance of "
 30                         "CIM_WiFiEndpointSettings through a new instance of "
 31                         "CIM_ConcreteComponent upon successful completion. This "
 32                         "method shall not apply the new settings to WiFiEndpoint. "
 33                         "Rather, it shall make them available for subsequent "
 34                         "manual or autonomous application." ), 
 35                      ValueMap { "0", "1", "2", "3", "4", "5..4095", "4096..32767", 
 36                         "32768..65535" }, 
 37                      Values { "Completed with No Error", "Not Supported", 
 38                         "Failed", "Invalid Parameter", "Invalid Reference", 
 39                         "DMTF Reserved", "Method Reserved", "Vendor Specified" }]
 40                  uint32 AddWiFiSettings(
 41                        [Required, IN, Description ( 
 42                            "References the instance of CIM_WiFiEndpoint with "
 43 karl  1.1.2.2              "which the new settings shall be associated." )]
 44                     CIM_WiFiEndpoint REF WiFiEndpoint, 
 45                        [Required, IN, Description ( 
 46                            "Provides the input property values for the "
 47                            "CIM_WiFiEndpointSettings instance that shall be "
 48                            "created by this method. Upon successful completion "
 49                            "of this method, a new instance of "
 50                            "CIM_WiFiEndpointSettings shall be associated to "
 51                            "the CIM_WiFiEndpoint referenced by the "
 52                            "WiFiEndpoint parameter, through a new instance of "
 53                            "CIM_ElementSettingData." ), 
 54                         EmbeddedInstance ( "CIM_WiFiEndpointSettings" )]
 55                     string WiFiEndpointSettingsInput, 
 56                        [IN, Description ( 
 57                            "Provides the property values for a new instance of "
 58                            "CIM_IEEE8021xSettings. If both "
 59                            "IEEE8021xSettingsInput and "
 60                            "IEEE8021xSettingsInputReference are not null, this "
 61                            "method shall return 2 (\"Unknown/Unspecified "
 62                            "Error\").If this parameter is not null and "
 63                            "IEEE8021xSettingsInputReference is null, this "
 64 karl  1.1.2.2              "method shall create a new CIM_IEEE8021xSettings "
 65                            "instance with the values in this parameter, and "
 66                            "shall associate it (through a new instance of "
 67                            "CIM_ConcreteComponent) with the newly created "
 68                            "instance of CIM_WiFiEndpointSettings." ), 
 69                         EmbeddedInstance ( "CIM_IEEE8021xSettings" )]
 70                     string IEEE8021xSettingsInput, 
 71                        [IN, Description ( 
 72                            "References a credential that shall be used to "
 73                            "authenticate the CIM_WiFiEndpoint to a IEEE 802.1x "
 74                            "authentication server. This method shall return 2 "
 75                            "(\"Unknown/Unspecified Error\") if "
 76                            "IEEE8021xSettingsInput is null and "
 77                            "IEEE8021xCredential is not null." )]
 78                     CIM_Credential REF ClientCredential, 
 79                        [IN, Description ( 
 80                            "References a credential that shall be used as a "
 81                            "trusted root certificate by the CIM_WiFiEndpoint "
 82                            "when it authenticates the leaf certificate "
 83                            "provided by the authentication server. This method "
 84                            "shall return 2 (\"Unknown/Unspecified Error\") if "
 85 karl  1.1.2.2              "IEEE8021xSettingsInput is null and "
 86                            "IEEE8021xCredential is not null." )]
 87                     CIM_Credential REF CACredential, 
 88                        [OUT, Description ( 
 89                            "Upon successful completion, shall contain a "
 90                            "reference to the CIM_WiFiEndpointSettings instance "
 91                            "created by this method." )]
 92                     CIM_WiFiEndpointSettings REF WiFiEndpointSettings, 
 93                        [OUT, Description ( 
 94                            "Upon successful completion, shall contain a "
 95                            "reference to the CIM_IEEE8021xSettings instance "
 96                            "created by this method if and only if "
 97                            "IEEE8021xSettingsInput was not null." )]
 98                     CIM_IEEE8021xSettings REF IEEE8021xSettings);
 99               
100                     [Description ( 
101                         "Shall atomically update settings that enable a "
102                         "WiFiEndpoint to connect to a given Wi-Fi network. These "
103                         "settings include the name (SSID) of the network as well "
104                         "as the security parameters used by the WiFiEndpoint to "
105                         "authenticate to the network and encrypt frames it "
106 karl  1.1.2.2           "transmits into the network and decrypt the frames it "
107                         "receives from the network. This method addresses the "
108                         "following update scenarios, each of which is given a tag "
109                         "line that precedes its description. Each tag line is in "
110                         "the form A to B, in which A indicates the type of "
111                         "authentication method in the settings before "
112                         "UpdateWiFiSettings is executed, and B indicates the type "
113                         "of authentication method in the settings after "
114                         "UpdateWiFiSettings is executed. Each of A and B is "
115                         "replaced in the tag lines by either \"IEEE 802.1x\", "
116                         "which indicates that the authentication method in the "
117                         "settings is based on IEEE 802.1x, or \"Non-IEEE-802.1x\", "
118                         "which indicates that the authentication method in the "
119                         "settings is not based on IEEE 802.1x.\n"
120                         "\t* IEEE 802.1x to IEEE 802.1x, update all: Updating the "
121                         "properties of a CIM_WiFiEndpointSettings instance in "
122                         "which the AuthenticationMethod property indicates an "
123                         "IEEE 802.1x authentication method and the properties of "
124                         "the associated CIM_IEEE8021xSettings instance, without "
125                         "reverting to a non-IEEE-802.1x authentication method. In "
126                         "this scenario, all parameters should be not null.\n"
127 karl  1.1.2.2           "\t* IEEE 802.1x to IEEE 802.1x, update WiFi only: "
128                         "Updating the properties of a CIM_WiFiEndpointSettings "
129                         "instance in which the AuthenticationMethod property "
130                         "indicates an IEEE 802.1x authentication method and that "
131                         "accordingly has an associated CIM_IEEE8021xSettings "
132                         "instance, without updating the CIM_IEEE8021xSettings "
133                         "instance, and without reverting to a non-IEEE-802.1x "
134                         "authentication method. In this scenario, the "
135                         "IEEE8021xSettingsInput parameter should be null and all "
136                         "other parameters should be not null.\n"
137                         "\t* IEEE 802.1x to IEEE 802.1x, update IEEE 802.1x only: "
138                         "Updating the properties of a CIM_IEEE8021xSettings "
139                         "instance that has an associated CIM_WiFiEndpointSettings "
140                         "instance without updating the CIM_WiFiEndpointSettings "
141                         "instance. In this scenario, the "
142                         "WiFiEndpointSettingsInput parameter should be null and "
143                         "all other parameters should be not null.\n"
144                         "\t* Non-IEEE-802.1x to Non-IEEE-802.1x: Updating the "
145                         "properties of a CIM_WiFiEndpointSettings instance in "
146                         "which the AuthenticationMethod property indicates a "
147                         "non-IEEE-802.1x authentication method, and that "
148 karl  1.1.2.2           "accordingly does not have an associated "
149                         "CIM_IEEE8021xSettings instance, without changing the "
150                         "authentication method to an IEEE 802.1x method. In this "
151                         "scenario, the WiFiEndpointSettings and "
152                         "WiFiEndpointSettingsInput parameters should be not null, "
153                         "and the IEEE8021xSettings and IEEE8021xSettingsInput "
154                         "parameters should be null.\n"
155                         "\t* Non-IEEE-802.1x to IEEE 802.1x: Updating the "
156                         "properties of a CIM_WiFiEndpointSettings instance in "
157                         "which the AuthenticationMethod property indicates a "
158                         "non-IEEE-802.1x authentication method, and that "
159                         "accordingly does not have an associated "
160                         "CIM_IEEE8021xSettings instance, and changing the "
161                         "authentication method to an IEEE 802.1x method. In this "
162                         "scenario, the IEEE8021xSettingsInput parameter should be "
163                         "null, and all other parameters should be not null. An "
164                         "instance of CIM_IEEE8021xSettings should first be "
165                         "created using the intrinsic method CreateInstance. Then, "
166                         "this method should be used with all parameters except "
167                         "IEEE8021xSettingsInput not null. This method shall "
168                         "update WiFiEndpointSettings and create a new instance of "
169 karl  1.1.2.2           "CIM_ConcreteComponent between WiFiEndpointSettings and IEEE8021xSettings.\n"
170                         "\t* IEEE 802.1x to Non-IEEE-802.1x: Updating the "
171                         "properties of a CIM_WiFiEndpointSettings instance in "
172                         "which the AuthenticationMethod property indicates an "
173                         "IEEE 802.1x authentication method and that accordingly "
174                         "has an associated CIM_IEEE8021xSettings instance, and "
175                         "reverting to a non-IEEE-802.1x authentication method. In "
176                         "this scenario, the IEEE8021xSettingsInput should be "
177                         "null, and all other parameters should be not null. This "
178                         "method shall delete the CIM_ConcreteComponent instance "
179                         "between the instances referenced by the "
180                         "WiFiEndpointSettings and IEEE8021xSettings parameters. "
181                         "If this CIM_ConcreteComponent instance is the last "
182                         "CIM_ConcreteComponent instance that references the "
183                         "CIM_IEEE8021xSettings instance referenced by the "
184                         "IEEE8021xSettings parameter, and the instance of "
185                         "CIM_IEEE8021xSettings referenced by the "
186                         "IEEE8021xSettings parameter was created by "
187                         "AddWiFiEndpointSettings, then this method shall also "
188                         "delete this CIM_IEEE8021xSettings instance.\n"
189                         "This method shall not apply the updated settings to any "
190 karl  1.1.2.2           "instance of CIM_WiFiEndpoint." ), 
191                      ValueMap { "0", "1", "2", "3", "4", "5..4095", "4096..32767", 
192                         "32768..65535" }, 
193                      Values { "Completed with No Error", "Not Supported", 
194                         "Failed", "Invalid Parameter", "Invalid Reference", 
195                         "DMTF Reserved", "Method Reserved", "Vendor Specified" }]
196                  uint32 UpdateWiFiSettings(
197                        [Required, IN, OUT, Description ( 
198                            "Shall reference the CIM_WiFiEndpointSettings "
199                            "instance that shall be updated by this method." )]
200                     CIM_WiFiEndpointSettings REF WiFiEndpointSettings, 
201                        [IN, Description ( 
202                            "If not null, shall provide the new property values "
203                            "for the instance of CIM_WiFiEndpointSettings "
204                            "referenced by the WiFiEndpointSettings parameter." ), 
205                         EmbeddedInstance ( "CIM_WiFiEndpointSettings" )]
206                     string WiFiEndpointSettingsInput, 
207                        [IN, Description ( 
208                            "If not null, shall provide the new property values "
209                            "for the instance of CIM_IEEE8021xSettings "
210                            "referenced by the IEEE8021xSettings parameter. If "
211 karl  1.1.2.2              "the IEEE8021xSettings is null and the "
212                            "IEEE8021xSettingsInput parameter is not null, this "
213                            "method shall return 2 (\"Unknown/Unspecified "
214                            "Error\")." ), 
215                         EmbeddedInstance ( "CIM_IEEE8021xSettings" )]
216                     string IEEE8021xSettingsInput, 
217                        [IN, Description ( 
218                            "References a credential that shall be used to "
219                            "authenticate the CIM_WiFiEndpoint to a IEEE 802.1x "
220                            "authentication server." )]
221                     CIM_Credential REF ClientCredential, 
222                        [IN, Description ( 
223                            "References a credential that shall be used as a "
224                            "trusted root certificate by the CIM_WiFiEndpoint "
225                            "when it authenticates the leaf certificate "
226                            "provided by the authentication server." )]
227                     CIM_Credential REF CACredential, 
228                        [IN, OUT, Description ( 
229                            "If not null, shall reference the "
230                            "CIM_IEEE8021xSettings instance that shall be "
231                            "updated by this method." )]
232 karl  1.1.2.2       CIM_IEEE8021xSettings REF IEEE8021xSettings);
233               
234               };