summaryrefslogtreecommitdiffstats
path: root/Schemas/CIM236/DMTF/Device/CIM_WiFiPortConfigurationService.mof
blob: ed361da05b094a46f6c4e39a438df864dea1584d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
// Copyright (c) 2009 DMTF.  All rights reserved.
   [Version ( "2.22.0" ), 
    UMLPackagePath ( "CIM::Device::Ports" ), 
    Description ( 
       "Provides methods for configuring parameters of Wi-Fi ports and "
       "the Wi-Fi protocol endpoints associated with them." )]
class CIM_WiFiPortConfigurationService : CIM_NetworkPortConfigurationService {


      [Description ( 
          "Shall atomically create settings that enable a "
          "WiFiEndpoint to connect to a given Wi-Fi network. These "
          "settings include the name (SSID) of the network as well "
          "as the security parameters used by the WiFiEndpoint to "
          "authenticate to the network and encrypt frames it "
          "transmits into the network and decrypt the frames it "
          "receives from the network. Upon successful completion, a "
          "new instance of CIM_WiFiEndpointSettings shall be "
          "associated to the CIM_WiFiEndpoint referenced by the "
          "WiFiEndpoint parameter, through a new instance of "
          "CIM_ElementSettingData. If the IEEE8021xSettingsInput "
          "parameter is not null, a new instance of "
          "CIM_IEEE8021xSettings containing its property values "
          "shall be associated to the new instance of "
          "CIM_WiFiEndpointSettings through a new instance of "
          "CIM_ConcreteComponent upon successful completion. "
          "Alternatively, if the IEEE8021xSettingsInputReference "
          "parameter is not null, the CIM_IEEE8021xSettings that it "
          "references shall be associated to the new instance of "
          "CIM_WiFiEndpointSettings through a new instance of "
          "CIM_ConcreteComponent upon successful completion. This "
          "method shall not apply the new settings to WiFiEndpoint. "
          "Rather, it shall make them available for subsequent "
          "manual or autonomous application." ), 
       ValueMap { "0", "1", "2", "3", "4", "5..4095", "4096..32767", 
          "32768..65535" }, 
       Values { "Completed with No Error", "Not Supported", 
          "Failed", "Invalid Parameter", "Invalid Reference", 
          "DMTF Reserved", "Method Reserved", "Vendor Specified" }]
   uint32 AddWiFiSettings(
         [Required, IN, Description ( 
             "References the instance of CIM_WiFiEndpoint with "
             "which the new settings shall be associated." )]
      CIM_WiFiEndpoint REF WiFiEndpoint, 
         [Required, IN, Description ( 
             "Provides the input property values for the "
             "CIM_WiFiEndpointSettings instance that shall be "
             "created by this method. Upon successful completion "
             "of this method, a new instance of "
             "CIM_WiFiEndpointSettings shall be associated to "
             "the CIM_WiFiEndpoint referenced by the "
             "WiFiEndpoint parameter, through a new instance of "
             "CIM_ElementSettingData." ), 
          EmbeddedInstance ( "CIM_WiFiEndpointSettings" )]
      string WiFiEndpointSettingsInput, 
         [IN, Description ( 
             "Provides the property values for a new instance of "
             "CIM_IEEE8021xSettings. If both "
             "IEEE8021xSettingsInput and "
             "IEEE8021xSettingsInputReference are not null, this "
             "method shall return 2 (\"Unknown/Unspecified "
             "Error\").If this parameter is not null and "
             "IEEE8021xSettingsInputReference is null, this "
             "method shall create a new CIM_IEEE8021xSettings "
             "instance with the values in this parameter, and "
             "shall associate it (through a new instance of "
             "CIM_ConcreteComponent) with the newly created "
             "instance of CIM_WiFiEndpointSettings." ), 
          EmbeddedInstance ( "CIM_IEEE8021xSettings" )]
      string IEEE8021xSettingsInput, 
         [IN, Description ( 
             "References a credential that shall be used to "
             "authenticate the CIM_WiFiEndpoint to a IEEE 802.1x "
             "authentication server. This method shall return 2 "
             "(\"Unknown/Unspecified Error\") if "
             "IEEE8021xSettingsInput is null and "
             "IEEE8021xCredential is not null." )]
      CIM_Credential REF ClientCredential, 
         [IN, Description ( 
             "References a credential that shall be used as a "
             "trusted root certificate by the CIM_WiFiEndpoint "
             "when it authenticates the leaf certificate "
             "provided by the authentication server. This method "
             "shall return 2 (\"Unknown/Unspecified Error\") if "
             "IEEE8021xSettingsInput is null and "
             "IEEE8021xCredential is not null." )]
      CIM_Credential REF CACredential, 
         [OUT, Description ( 
             "Upon successful completion, shall contain a "
             "reference to the CIM_WiFiEndpointSettings instance "
             "created by this method." )]
      CIM_WiFiEndpointSettings REF WiFiEndpointSettings, 
         [OUT, Description ( 
             "Upon successful completion, shall contain a "
             "reference to the CIM_IEEE8021xSettings instance "
             "created by this method if and only if "
             "IEEE8021xSettingsInput was not null." )]
      CIM_IEEE8021xSettings REF IEEE8021xSettings);

      [Description ( 
          "Shall atomically update settings that enable a "
          "WiFiEndpoint to connect to a given Wi-Fi network. These "
          "settings include the name (SSID) of the network as well "
          "as the security parameters used by the WiFiEndpoint to "
          "authenticate to the network and encrypt frames it "
          "transmits into the network and decrypt the frames it "
          "receives from the network. This method addresses the "
          "following update scenarios, each of which is given a tag "
          "line that precedes its description. Each tag line is in "
          "the form A to B, in which A indicates the type of "
          "authentication method in the settings before "
          "UpdateWiFiSettings is executed, and B indicates the type "
          "of authentication method in the settings after "
          "UpdateWiFiSettings is executed. Each of A and B is "
          "replaced in the tag lines by either \"IEEE 802.1x\", "
          "which indicates that the authentication method in the "
          "settings is based on IEEE 802.1x, or \"Non-IEEE-802.1x\", "
          "which indicates that the authentication method in the "
          "settings is not based on IEEE 802.1x.\n"
          "\t* IEEE 802.1x to IEEE 802.1x, update all: Updating the "
          "properties of a CIM_WiFiEndpointSettings instance in "
          "which the AuthenticationMethod property indicates an "
          "IEEE 802.1x authentication method and the properties of "
          "the associated CIM_IEEE8021xSettings instance, without "
          "reverting to a non-IEEE-802.1x authentication method. In "
          "this scenario, all parameters should be not null.\n"
          "\t* IEEE 802.1x to IEEE 802.1x, update WiFi only: "
          "Updating the properties of a CIM_WiFiEndpointSettings "
          "instance in which the AuthenticationMethod property "
          "indicates an IEEE 802.1x authentication method and that "
          "accordingly has an associated CIM_IEEE8021xSettings "
          "instance, without updating the CIM_IEEE8021xSettings "
          "instance, and without reverting to a non-IEEE-802.1x "
          "authentication method. In this scenario, the "
          "IEEE8021xSettingsInput parameter should be null and all "
          "other parameters should be not null.\n"
          "\t* IEEE 802.1x to IEEE 802.1x, update IEEE 802.1x only: "
          "Updating the properties of a CIM_IEEE8021xSettings "
          "instance that has an associated CIM_WiFiEndpointSettings "
          "instance without updating the CIM_WiFiEndpointSettings "
          "instance. In this scenario, the "
          "WiFiEndpointSettingsInput parameter should be null and "
          "all other parameters should be not null.\n"
          "\t* Non-IEEE-802.1x to Non-IEEE-802.1x: Updating the "
          "properties of a CIM_WiFiEndpointSettings instance in "
          "which the AuthenticationMethod property indicates a "
          "non-IEEE-802.1x authentication method, and that "
          "accordingly does not have an associated "
          "CIM_IEEE8021xSettings instance, without changing the "
          "authentication method to an IEEE 802.1x method. In this "
          "scenario, the WiFiEndpointSettings and "
          "WiFiEndpointSettingsInput parameters should be not null, "
          "and the IEEE8021xSettings and IEEE8021xSettingsInput "
          "parameters should be null.\n"
          "\t* Non-IEEE-802.1x to IEEE 802.1x: Updating the "
          "properties of a CIM_WiFiEndpointSettings instance in "
          "which the AuthenticationMethod property indicates a "
          "non-IEEE-802.1x authentication method, and that "
          "accordingly does not have an associated "
          "CIM_IEEE8021xSettings instance, and changing the "
          "authentication method to an IEEE 802.1x method. In this "
          "scenario, the IEEE8021xSettingsInput parameter should be "
          "null, and all other parameters should be not null. An "
          "instance of CIM_IEEE8021xSettings should first be "
          "created using the intrinsic method CreateInstance. Then, "
          "this method should be used with all parameters except "
          "IEEE8021xSettingsInput not null. This method shall "
          "update WiFiEndpointSettings and create a new instance of "
          "CIM_ConcreteComponent between WiFiEndpointSettings and IEEE8021xSettings.\n"
          "\t* IEEE 802.1x to Non-IEEE-802.1x: Updating the "
          "properties of a CIM_WiFiEndpointSettings instance in "
          "which the AuthenticationMethod property indicates an "
          "IEEE 802.1x authentication method and that accordingly "
          "has an associated CIM_IEEE8021xSettings instance, and "
          "reverting to a non-IEEE-802.1x authentication method. In "
          "this scenario, the IEEE8021xSettingsInput should be "
          "null, and all other parameters should be not null. This "
          "method shall delete the CIM_ConcreteComponent instance "
          "between the instances referenced by the "
          "WiFiEndpointSettings and IEEE8021xSettings parameters. "
          "If this CIM_ConcreteComponent instance is the last "
          "CIM_ConcreteComponent instance that references the "
          "CIM_IEEE8021xSettings instance referenced by the "
          "IEEE8021xSettings parameter, and the instance of "
          "CIM_IEEE8021xSettings referenced by the "
          "IEEE8021xSettings parameter was created by "
          "AddWiFiEndpointSettings, then this method shall also "
          "delete this CIM_IEEE8021xSettings instance.\n"
          "This method shall not apply the updated settings to any "
          "instance of CIM_WiFiEndpoint." ), 
       ValueMap { "0", "1", "2", "3", "4", "5..4095", "4096..32767", 
          "32768..65535" }, 
       Values { "Completed with No Error", "Not Supported", 
          "Failed", "Invalid Parameter", "Invalid Reference", 
          "DMTF Reserved", "Method Reserved", "Vendor Specified" }]
   uint32 UpdateWiFiSettings(
         [Required, IN, OUT, Description ( 
             "Shall reference the CIM_WiFiEndpointSettings "
             "instance that shall be updated by this method." )]
      CIM_WiFiEndpointSettings REF WiFiEndpointSettings, 
         [IN, Description ( 
             "If not null, shall provide the new property values "
             "for the instance of CIM_WiFiEndpointSettings "
             "referenced by the WiFiEndpointSettings parameter." ), 
          EmbeddedInstance ( "CIM_WiFiEndpointSettings" )]
      string WiFiEndpointSettingsInput, 
         [IN, Description ( 
             "If not null, shall provide the new property values "
             "for the instance of CIM_IEEE8021xSettings "
             "referenced by the IEEE8021xSettings parameter. If "
             "the IEEE8021xSettings is null and the "
             "IEEE8021xSettingsInput parameter is not null, this "
             "method shall return 2 (\"Unknown/Unspecified "
             "Error\")." ), 
          EmbeddedInstance ( "CIM_IEEE8021xSettings" )]
      string IEEE8021xSettingsInput, 
         [IN, Description ( 
             "References a credential that shall be used to "
             "authenticate the CIM_WiFiEndpoint to a IEEE 802.1x "
             "authentication server." )]
      CIM_Credential REF ClientCredential, 
         [IN, Description ( 
             "References a credential that shall be used as a "
             "trusted root certificate by the CIM_WiFiEndpoint "
             "when it authenticates the leaf certificate "
             "provided by the authentication server." )]
      CIM_Credential REF CACredential, 
         [IN, OUT, Description ( 
             "If not null, shall reference the "
             "CIM_IEEE8021xSettings instance that shall be "
             "updated by this method." )]
      CIM_IEEE8021xSettings REF IEEE8021xSettings);

};