| blob | 1772ec890f89e315b1dd16fb3ffc393b13dd2556 |
1 '\" te
2 .\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH WIFICONFIG 1M "Oct 31, 2007"
7 .SH NAME
8 wificonfig \- WLAN configuration
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBwificonfig\fR [\fB-R\fR \fIroot_path\fR] [\fB-i\fR \fIinterface\fR] autoconf
13 [\fIwait\fR={\fIn\fR|\fIforever\fR}]
14 .fi
16 .LP
17 .nf
18 \fBwificonfig\fR [\fB-R\fR \fIroot_path\fR] [\fB-i\fR \fIinterface\fR] connect profile
19 [\fIwait\fR={\fIn\fR|\fIforever\fR}]
20 .fi
22 .LP
23 .nf
24 \fBwificonfig\fR [\fB-R\fR \fIroot_path\fR] [\fB-i\fR \fIinterface\fR] connect essid
25 [\fIwait\fR={\fIn\fR|\fIforever\fR}]
26 .fi
28 .LP
29 .nf
30 \fBwificonfig\fR [\fB-R\fR \fIroot_path\fR] [\fB-i\fR \fIinterface\fR] disconnect
31 .fi
33 .LP
34 .nf
35 \fBwificonfig\fR [\fB-R\fR \fIroot_path\fR] [\fB-i\fR \fIinterface\fR] getparam
36 [\fIparameter\fR []...]
37 .fi
39 .LP
40 .nf
41 \fBwificonfig\fR [\fB-R\fR \fIroot_path\fR] [\fB-i\fR \fIinterface\fR] setparam
42 [\fIparameter\fR=\fIvalue\fR []...]
43 .fi
45 .LP
46 .nf
47 \fBwificonfig\fR [\fB-R\fR \fIroot_path\fR] [\fB-i\fR \fIinterface\fR] restoredef
48 .fi
50 .LP
51 .nf
52 \fBwificonfig\fR [\fB-R\fR \fIroot_path\fR] [\fB-i\fR \fIinterface\fR] scan
53 .fi
55 .LP
56 .nf
57 \fBwificonfig\fR [\fB-R\fR \fIroot_path\fR] [\fB-i\fR \fIinterface\fR] showstatus
58 .fi
60 .LP
61 .nf
62 \fBwificonfig\fR [\fB-R\fR \fIroot_path\fR] [\fB-i\fR \fIinterface\fR] setwepkey 1|2|3|4
63 .fi
65 .LP
66 .nf
67 \fBwificonfig\fR [\fB-R\fR \fIroot_path\fR] createprofile profile
68 [\fIparameter\fR=\fIvalue\fR []...]
69 .fi
71 .LP
72 .nf
73 \fBwificonfig\fR [\fB-R\fR \fIroot_path\fR] deleteprofile \fIprofile1\fR
74 [\fIprofile2\fR []...]
75 .fi
77 .LP
78 .nf
79 \fBwificonfig\fR [\fB-R\fR \fIroot_path\fR] showprofile [\fIprofile\fR]
80 .fi
82 .LP
83 .nf
84 \fBwificonfig\fR [\fB-R\fR \fIroot_path\fR] setprofilewepkey \fIprofile\fR 1|2|3|4
85 .fi
87 .LP
88 .nf
89 \fBwificonfig\fR [\fB-R\fR \fIroot_path\fR] getprofileparam \fIprofile\fR
90 [\fIparameter\fR []...]
91 .fi
93 .LP
94 .nf
95 \fBwificonfig\fR [\fB-R\fR \fIroot_path\fR] setprofileparam
96 [\fIparameter\fR=\fIvalue\fR []...]
97 .fi
99 .LP
100 .nf
101 \fBwificonfig\fR [\fB-R\fR \fIroot_path\fR] history
102 .fi
104 .LP
105 .nf
106 \fBwificonfig\fR [\fB-R\fR \fIroot_path\fR] listprefer
107 .fi
109 .LP
110 .nf
111 \fBwificonfig\fR [\fB-R\fR \fIroot_path\fR] removeprefer \fIprofile\fR
112 .fi
114 .LP
115 .nf
116 \fBwificonfig\fR [\fB-R\fR \fIroot_path\fR] setprefer \fIprofile\fR [\fIn\fR]
117 .fi
119 .SH DESCRIPTION
120 .sp
121 .LP
122 \fBwificonfig\fR defines a set of subcommands and parameters to configure
123 \fBWiFi\fR interfaces in the system. A driver may support all parameters or a
124 subset of these parameters.
125 .sp
126 .LP
127 \fBwificonfig\fR uses \fBrbac\fR(5) to control user access to the interface.
128 Only users with the "solaris.network.wifi.config" authorization can manage a
129 \fBWiFi\fR interface, while only users with
130 "solaris.network.wifi.wep"authorizations can configure the \fBWEP\fR (Wired
131 Equivalent Privacy) key. Other users can only read parameters from the
132 interface. By default, the "solaris.network.wifi.config" and
133 "solaris.network.wifi.wep" authorizations are not granted to any user apart
134 from root.
135 .sp
136 .LP
137 \fBWificonfig\fR comes in two classes of forms. The first class, shown as the
138 first set of synopsis combined with the optional interface name, is the
139 subcommands used to a manipulate a particular \fBWiFi\fR network interface. The
140 second class, shown as the second set of synopsis, is used to create and
141 operate on \fBWiFi\fR Configuration Profiles. A Configuration Profile allows
142 the user to pre-specify a set of parameters which can later be applied to a
143 \fBWiFi\fR network interface using the \fBconnect\fR or \fBautoconf\fR
144 subcommands.
145 .sp
146 .LP
147 In the interface subcommands, if the interface is not specified (that is, the
148 \fB-i\fR option is missing), \fBwificonfig\fR selects a random interface from
149 the known \fBWiFi\fR interfaces on the system. If there are multiple \fBWiFi\fR
150 network interfaces on the system, then the selection will be the same over time
151 as long as the number of and names of the \fBWiFi\fR interfaces does not
152 change.
153 .sp
154 .LP
155 A Configuration Profile can be created for a \fBWLAN\fR by using the
156 \fBcreateprofile\fR subcommand (see the SUBCOMMANDS section). The actual
157 \fBWLAN\fR may be present or not.
158 .sp
159 .LP
160 \fBwificonfig\fR also maintains a list of Configuration Profiles called the
161 Preference List. This list makes automatic configuration possible. When the
162 \fBautoconf\fR subcommand is used, \fBwificonfig\fR tries to connect to each
163 pre-configured \fBWLAN\fR according to the order of the Preference List. If the
164 Preference List is empty or none of the \fBWLAN\fRs in the Preference List can
165 be found, \fBwificonfig\fR uses its built-in heuristics to automatically
166 configure the interface. (See the \fBautoconf\fR subcommand for the
167 heuristics). A few subcommands (\fBlistprefer\fR, \fBsetprefer\fR,
168 \fBremoveprefer\fR) are defined to manipulate the Preference List.
169 .SH OPTIONS
170 .sp
171 .LP
172 The following options are supported:
173 .sp
174 .ne 2
175 .na
176 \fB\fB-i\fR \fIinterface\fR\fR
177 .ad
178 .RS 16n
179 Specifies a wireless network interface to do the configuration.
180 .RE
182 .sp
183 .ne 2
184 .na
185 \fB\fB-R\fR \fIroot_path\fR\fR
186 .ad
187 .RS 16n
188 Defines the full path name of a directory to use as the \fIroot_path\fR. This
189 affects the location of the private files where \fBwificonfig\fR stores the
190 Configuration Profiles and \fBWEP\fR keys.
191 .RE
193 .SS "OPERANDS"
194 .sp
195 .LP
196 The following operand is supported:
197 .sp
198 .ne 2
199 .na
200 \fBprofile\fR
201 .ad
202 .RS 11n
203 The name of a \fBWiFi\fR profile. It can be a string between 1 and 32
204 characters. However, "all", "{preference}", "{history}", "{active_profile}",
205 and any strings contained in brackets, such as "[foo]", are not allowed as a
206 profile name.
207 .RE
209 .SS "SUBCOMMANDS"
210 .sp
211 .LP
212 The following subcommands are supported:
213 .sp
214 .ne 2
215 .na
216 \fB\fBautoconf\fR [wait={\fIn\fR|\fIforever\fR}]\fR
217 .ad
218 .sp .6
219 .RS 4n
220 Configures the interface automatically. The interface is configured according
221 to the previously saved Preference List found in \fB/etc/inet/wifi\fR.
222 \fBwificonfig\fR first gets a list of available \fBWLAN\fRs by scanning the
223 radio. It then compares the list of available \fBWLAN\fRs with the Preference
224 List. If the Preference List is empty, or if none of the \fBWLAN\fRs in the
225 Preference List can be found, \fBwificonfig\fR chooses a \fBWLAN\fR to connect
226 to using the following priorities: 1) the \fBWLAN\fRs without encryption, 2)
227 the \fBWLAN\fRs with stronger signal strength, and 3) the \fBWLAN\fRs with
228 higher transmit rates.
229 .sp
230 If the \fBWLAN\fRs in the Preference list are available, the user can specify
231 the number of seconds to wait before \fBautoconf\fR returns using the wait
232 option. By default (without the wait option), \fBautoconf\fR returns within 10
233 seconds. If "\fIforever\fR" or -1 follows the wait option, \fBwificonfig\fR
234 waits until the \fBNIC\fR is successfully connected to the \fBWLAN\fR specified
235 by the profile in the Preference list.
236 .sp
237 The "solaris.network.wifi.config" authorization is required for this
238 subcommand.
239 .sp
240 The \fBWiFi\fR device driver can not guarantee to retain the state for the
241 connection when it is not held open. For this reason, it is strongly
242 recommended that the \fBplumb\fR subcommand for \fBifconfig\fR(1M) is done
243 before the \fBwificonfig autoconf\fR subcommand is given.
244 .RE
246 .sp
247 .ne 2
248 .na
249 \fB\fBconnect\fR \fIprofile\fR[wait={\fIn\fR|\fIforever\fR}]\fR
250 .ad
251 .br
252 .na
253 \fB\fBconnect\fR \fIessid\fR[wait={\fIn\fR|\fIforever\fR}]\fR
254 .ad
255 .sp .6
256 .RS 4n
257 Connects to a wireless network according to a pre-configured "profile". If the
258 specified Configuration Profile exists in /etc/inet/wifi, the \fBconnect\fR
259 subcommand uses that Configuration Profile to configure the interface. That
260 profile subsequently becomes the current active profile of the interface after
261 the \fBconnect\fR subcommand succeeds. If no existing Configuration Profile
262 matches the specified name, the behavior of the \fBconnect\fR subcommand is
263 equivalent to the \fBrestoredef\fR subcommand, except that the "essid"
264 parameter is set as "profile".
265 .sp
266 If the \fBWLAN\fRs in the Preference list are available, the user can specify
267 the number of seconds to wait before \fBconnect\fR returns using the wait
268 option. By default (without the wait option), \fBconnect\fR trys for 10
269 seconds. If "\fIforever\fR" or -1 follows the wait option, \fBwificonfig\fR
270 tries until the \fBNIC\fR is successfully connected to the profile or essid
271 that was specified.
272 .sp
273 The \fBconnect\fR subcommand prints one of the following lines depending on
274 whether or not a Configuration Profile was found for the specified name:
275 .sp
276 .in +2
277 .nf
278 Connecting to profile <name>
279 Connecting to essid <name>
280 .fi
281 .in -2
282 .sp
284 The "solaris.network.wifi.config" authorization is required for this
285 subcommand.
286 .sp
287 The \fBWiFi\fR device driver can not guarantee to retain the state for the
288 connection when it is not held open. For this reason, it is strongly
289 recommended that the \fBplumb\fR subcommand for \fBifconfig\fR(1M) is done
290 before the \fBwificonfig autoconf\fR subcommand is given.
291 .RE
293 .sp
294 .ne 2
295 .na
296 \fB\fBdisconnect\fR\fR
297 .ad
298 .sp .6
299 .RS 4n
300 Disconnects the interface from the currently associated wireless network. The
301 interface associates with none of the wireless networks.
302 .sp
303 The "solaris.network.wifi.config" authorization is required for this
304 subcommand.
305 .RE
307 .sp
308 .ne 2
309 .na
310 \fB\fBgetparam\fR [parameter [...]]\fR
311 .ad
312 .br
313 .na
314 \fB\fBsetparam\fR [parameter=value [...]]\fR
315 .ad
316 .sp .6
317 .RS 4n
318 Gets or sets parameters in the network interface. This does not affect any
319 profile. The \fBsetprofileparam\fR subcommand can be used to set and change
320 parameters in a profile that has already been created.
321 .sp
322 The \fBsetparam\fR subcommand without any parameters displays the set of
323 parameters supported by the network interface, including whether they are
324 read/write or read only. The \fBgetparam\fR subcommand without any parameters
325 displays all the parameters and their values.
326 .sp
327 The \fBsetparam wepkey1|wepkey2|wepkey3|wepkey4\fR subcommand requires the
328 "solaris.network.wifi.wep" authorization. For all other parameters, the
329 \fBsetparam\fR subcommand requires the
330 "solaris.network.wifi.config"authorization.
331 .sp
332 For example,
333 .sp
334 .in +2
335 .nf
336 $ wificonfig setparam <parameter1=value1> [parameter2=value2 [...]]
337 $ wificonfig getparam <parameter1> [parameter2 [...]]
338 .fi
339 .in -2
340 .sp
342 \fBwificonfig\fR currently supports the following parameters (the values are
343 case insensitive).
344 .sp
345 .ne 2
346 .na
347 \fB\fIbssid\fR\fR
348 .ad
349 .sp .6
350 .RS 4n
351 \fBMAC\fR address of the associated Access Point. The valid value is a hex
352 value of 6 bytes. The \fIbssid\fR can also be the \fBIBSSID\fR in an ad-hoc
353 configuration. If the network interface is not connected to any \fBWLAN\fR,
354 then the string "none" is shown instead of a 6 byte \fBMAC\fR address.
355 Otherwise, the network interface is connected to a \fBWLAN\fR. The default
356 value is "none". This parameter is read-only.
357 .RE
359 .sp
360 .ne 2
361 .na
362 \fB\fIessid\fR\fR
363 .ad
364 .sp .6
365 .RS 4n
366 Network name. The valid value is a string of up to 32 chars. If \fIessid\fR is
367 an empty string, the driver automatically scans and joins the \fBWLAN\fR using
368 the built-in heuristics. The default value is an empty string.
369 .RE
371 .sp
372 .ne 2
373 .na
374 \fB\fIbsstype\fR\fR
375 .ad
376 .sp .6
377 .RS 4n
378 Specifies whether the Infrastructure Mode or Ad-Hoc Mode is used. The valid
379 values are "ap", "bss", or "infrastructure" to join a \fBWLAN\fR through an
380 Access Point, that is, to use infrastructure mode. The valid values are "ibss"
381 or "ad-hoc" to join a peer-to-peer WLAN (also named "ad-hoc"). The valid value
382 of "auto" automatically switches between the two types. The default value is
383 "infrastructure'".
384 .RE
386 .sp
387 .ne 2
388 .na
389 \fB\fIcreateibss\fR\fR
390 .ad
391 .sp .6
392 .RS 4n
393 Specifies whether to create an ad-hoc network (also called an \fIIBSS\fR if the
394 \fBconnect\fR does not result in finding the desired network. This enables the
395 user to start an ad-hoc network so that other hosts can join. The valid values
396 are YES to start a new ad-hoc \fBWLAN\fR (instead of joining one) and NO to not
397 start an ad-hoc \fBWLAN\fR. The default value is NO. The \fBNIC\fR always tries
398 to join a \fBWLAN\fR first. If this is successful, the setting of
399 \fIcreateibss\fR is ignored.
400 .RE
402 .sp
403 .ne 2
404 .na
405 \fB\fIchannel\fR\fR
406 .ad
407 .sp .6
408 .RS 4n
409 An integer indicating the operating frequency. This channel number varies by
410 regulatory domain. When the channel number is obtained by the \fBgetparam\fR
411 subcommand, the value indicates the actual channel the card uses to connect to
412 the network. The channel number is set by the \fBsetparam\fR subcommand, and
413 the value is only applicable when the card is in ad-hoc mode. It indicates the
414 operating channel of the \fIIBSS\fR. The default value is the channel number on
415 the card.
416 .RE
418 .sp
419 .ne 2
420 .na
421 \fB\fIrates\fR\fR
422 .ad
423 .sp .6
424 .RS 4n
425 Specifies the transmission rates. The valid values (in Mbit/s) are 1, 2, 5.5,
426 6, 9, 11, 12, 18, 22, 24, 33, 36, 48, and 54. A \fBNIC\fR may support multiple
427 transmission rates depending on its capability. This is the only parameter that
428 accepts multiple values. When multiple values are supplied to set this
429 parameter, each value must be separated by a comma (,). See the \fBEXAMPLES\fR
430 section for details. The default values are the data rates supported by the
431 chip.
432 .RE
434 .sp
435 .ne 2
436 .na
437 \fB\fIpowermode\fR\fR
438 .ad
439 .sp .6
440 .RS 4n
441 Specifies the power management mode. The valid values are "off" to disable
442 power management, "mps" for maximum power saving, and "fast" for the best
443 combination of speed and power saving. The default value is "off".
444 .RE
446 .sp
447 .ne 2
448 .na
449 \fB\fIauthmode\fR\fR
450 .ad
451 .sp .6
452 .RS 4n
453 Specifies the authorization type. The valid values are "opensystem" for an open
454 system, where anyone can be authenticated and "shared_key" for a Shared Key
455 authentication mode. The default value is "opensystem".
456 .RE
458 .sp
459 .ne 2
460 .na
461 \fB\fIencryption\fR\fR
462 .ad
463 .sp .6
464 .RS 4n
465 Specifies the encryption algorithm to be used. The valid values are "none" for
466 no encryption algorithm and "wep" to turn on \fBWEP\fR encryption. The default
467 value is "none".
468 .RE
470 .sp
471 .ne 2
472 .na
473 \fB\fIwepkey1\fR|\fIwepkey2\fR|\fIwepkey3\fR|\fIwepkey4\fR\fR
474 .ad
475 .sp .6
476 .RS 4n
477 A maximum of 4 \fBWEP\fR keys (indexed 1 through 4) can be set in an \fBNIC\fR.
478 They are write-only parameters which can be set by the \fBsetparam\fR
479 subcommand, but cannot be read back by the \fBgetparam\fR subcommand. \fBWEP\fR
480 keys can either be set by the \fBsetwepkey\fR or the \fBsetparam\fR subcommand.
481 \fBsetparam\fR uses plain text but it's scriptable. See the \fBsetwepkey\fR
482 subcommand for more information about how a \fBWEP\fR key is encoded. Setting
483 \fBWEP\fR keys requires "solaris.network.wifi.wep"authorization.
484 .sp
485 When these subcommands are used to set a \fBWEP\fR key, any user on the system
486 can read the key from the \fBps\fR(1) output. Thus, the \fBsetwepkey\fR
487 subcommand is recommended for setting the \fBWEP\fR keys since it does not
488 allow \fBps\fR(1) to read the keys.
489 .RE
491 .sp
492 .ne 2
493 .na
494 \fB\fIwepkeyindex\fR\fR
495 .ad
496 .sp .6
497 .RS 4n
498 Specifies the encryption keys. The valid values are 1 to use wepkey1, 2 to use
499 wepkey2, 3 to use wepkey3, and 4 to use wepkey4. The default value is 1. This
500 subcommand is only valid when \fBWEP\fR is on.
501 .RE
503 .sp
504 .ne 2
505 .na
506 \fB\fIsignal\fR\fR
507 .ad
508 .sp .6
509 .RS 4n
510 Specifies the strength of the received radio signal. The valid values are 0 -
511 15 , where 0 is the weakest signal and 15 is the strongest signal. This
512 parameter is read-only and indicates the radio signal strength received by the
513 \fBNIC\fR.
514 .RE
516 .sp
517 .ne 2
518 .na
519 \fB\fIradio\fR\fR
520 .ad
521 .sp .6
522 .RS 4n
523 Specifies whether the radio is turned on or off. The valid values are "on" to
524 turn on the radio and "off" to turn off the radio. The default value is "on".
525 .RE
527 .RE
529 .sp
530 .ne 2
531 .na
532 \fB\fBrestoredef\fR\fR
533 .ad
534 .sp .6
535 .RS 4n
536 Forces the \fBNIC\fR to restore the network interface to use the default values
537 for all the parameters. See the \fBgetparam\fR and \fBsetparam\fR subcommands
538 for the default values of the parameters.
539 .sp
540 The "solaris.network.wifi.config" authorization is required for this
541 subcommand.
542 .RE
544 .sp
545 .ne 2
546 .na
547 \fB\fBscan\fR\fR
548 .ad
549 .sp .6
550 .RS 4n
551 Scans and lists the currently available \fBWLAN\fRs.
552 .RE
554 .sp
555 .ne 2
556 .na
557 \fB\fBshowstatus\fR\fR
558 .ad
559 .sp .6
560 .RS 4n
561 Display the basic status of a \fBWLAN\fR interface. If the \fBWLAN\fR interface
562 is connected, the basic status includes: the name of the current active
563 profile, the name of the network, the \fIbssid\fR, whether the network is
564 encrypted or not, and the signal strength.
565 .RE
567 .sp
568 .ne 2
569 .na
570 \fB\fBsetwepkey\fR 1|2|3|4\fR
571 .ad
572 .sp .6
573 .RS 4n
574 Sets one of the 4 \fBWEP\fR encryption keys. \fBWEP\fR keys are used to
575 encrypt the content of the network packets which are transmitted on air. There
576 are 4 \fBWEP\fR keys in the \fBNIC\fR according to the 802.11 standards. The
577 \fBsetwepkey\fR subcommand is used to update one of the 4 keys by prompting the
578 user for the key. The user must enter the key twice. The input is not echoed.
579 For example, to update setwepkey2:
580 .sp
581 .in +2
582 .nf
583 example% wificonfig -i ath0 setwepkey 2
584 input wepkey2: < user input here>
585 confirm wepkey2: < user input here>
586 .fi
587 .in -2
588 .sp
590 A \fBWEP\fR key can be 5 bytes or 13 bytes long. There are two ways to enter a
591 \fBWEP\fR key, by \fBASCII\fR values or by hex values. If the user enters 5 or
592 13 characters, it is considered the \fBASCII\fR representation of the key. If
593 the user enters 10 or 26 characters, it is considered the hex representation of
594 the key. For example "1234" is equivalent to "6162636465". If the user enters
595 other number of characters, the subcommand fails. \fBWEP\fR keys are
596 write-only; they cannot be read back via \fBwificonfig\fR.
597 .sp
598 The \fBWEP\fR keys can also be set in plain text form by the \fBsetparam\fR
599 subcommand. This makes setting \fBWEP\fR keys scriptable (see the parameters of
600 \fBsetparam\fR for the details).
601 .sp
602 The "solaris.network.wifi.wep" authorization is required for this subcommand.
603 .RE
605 .sp
606 .LP
607 The following profile subcommands are supported:
608 .sp
609 .ne 2
610 .na
611 \fB\fBcreateprofile\fR \fIprofile\fR [parameter=value] [...]\fR
612 .ad
613 .sp .6
614 .RS 4n
615 Creates a Configuration Profile named \fIprofile\fR off-line. The specified
616 parameters are saved as items of this Configuration Profile. The user can
617 specify a group of parameters. At a minimum, the \fIessid\fR must be specified.
618 .sp
619 The "solaris.network.wifi.config" authorization is required for this
620 subcommand.
621 .RE
623 .sp
624 .ne 2
625 .na
626 \fB\fBdeleteprofile\fR \fIprofile1\fR [\fIprofile2\fR [...]]\fR
627 .ad
628 .sp .6
629 .RS 4n
630 Deletes one or more Configuration Profiles according to the specified names. If
631 the specified Configuration Profile does not exist, this subcommand fails. The
632 wild-card "all" can be used to delete all profiles.
633 .sp
634 The "solaris.network.wifi.config" authorization is required for this
635 subcommand.
636 .RE
638 .sp
639 .ne 2
640 .na
641 \fB\fBshowprofile\fR [\fIprofile\fR]\fR
642 .ad
643 .sp .6
644 .RS 4n
645 Displays the parameters in the Configuration Profile according to the specified
646 \fIprofile\fR. \fBWEP\fR (wired equivalent privacy) keys are not printed
647 because they are write-only parameters. If no \fIprofile\fR is specified, all
648 the profiles are shown.
649 .RE
651 .sp
652 .ne 2
653 .na
654 \fB\fBsetprofilewepkey\fR 1|2|3|4\fR
655 .ad
656 .sp .6
657 .RS 4n
658 Sets one of the 4 \fBWEP\fR encryption keys in the specified Configuration
659 Profile "profile". Like the other \fBprofile\fR subcommands,
660 \fBsetprofilewepkey\fR does not affect the configuration of a network
661 interface, even if a \fBWiFi\fR interface is currently running with the
662 specified profile. In order for the modified profile to be applied to the
663 network interface, the \fBconnect\fR or \fBautoconf\fR subcommands have to be
664 used after the profile has been updated.
665 .sp
666 Other than that difference, the usage of \fBsetprofilewepkey\fR is the same as
667 the \fBsetwepkey\fR subcommand. For example, to update wepkey 2 in profile
668 "\fIhome\fR":
669 .sp
670 .in +2
671 .nf
672 example% wificonfig setprofilewepkey home 2
673 input wepkey2: < user input here>
674 confirm wepkey2: < user input here>
675 .fi
676 .in -2
677 .sp
679 The "solaris.network.wifi.wep" authorization is required for this subcommand.
680 .RE
682 .sp
683 .ne 2
684 .na
685 \fB\fBgetprofileparam\fR \fIprofile\fR [parameter]\ [...]]\fR
686 .ad
687 .br
688 .na
689 \fB\fBsetprofileparam\fR \fIprofile\fR [parameter=value]\ [...]]\fR
690 .ad
691 .sp .6
692 .RS 4n
693 Gets or sets parameters in the specified Configuration Profile "\fIprofile\fR".
694 Like the other profile subcommands, these subcommands do not affect the
695 configuration of a network interface, even if a \fBWiFi\fR interface is
696 currently running with the specified profile. In order for the modified
697 profile to be applied to the network interface, the \fBconnect\fR or
698 \fBautoconf\fR subcommands have to be used after the profile has been updated.
699 .sp
700 A \fBgetprofileparam\fR without any parameters will display all the parameters
701 and their values.
702 .sp
703 "Solaris.network.wifi.wep" authorization is required when the \fBsetparam\fR
704 subcommand is used with the
705 \fIwepkey1\fR|\fIwepkey2\fR|\fIwepkey3\fR|\fIwepkey4\fR parameter. For all
706 other parameters, the \fBsetparam\fR subcommand requires
707 "solaris.network.wifi.config"authorization.
708 .sp
709 For example, to change the settings for the "\fIhome\fR" Configuration Profile,
710 use:
711 .sp
712 .in +2
713 .nf
714 $ wificonfig setprofileparam home <parameter1=value1> \e
715 [parameter2=value2 [...]]
716 $ wificonfig getprofileparam home <parameter1> [parameter2 [...]]
717 .fi
718 .in -2
719 .sp
721 The set of parameters and their allowed values are the same as those specified
722 for the \fBsetparam\fR subcommand.
723 .RE
725 .sp
726 .ne 2
727 .na
728 \fB\fBhistory\fR\fR
729 .ad
730 .sp .6
731 .RS 4n
732 Lists the \fBWLAN\fRs in the History List. \fBwificonfig\fR automatically
733 records the \fBWLAN\fRs that appear in every scanning attempt. The History List
734 contains a maximum of 10 records of the most recent \fBWLAN\fRs, sorted by
735 time. These records can be listed by using this subcommand.
736 .RE
738 .sp
739 .ne 2
740 .na
741 \fB\fBlistprefer\fR\fR
742 .ad
743 .sp .6
744 .RS 4n
745 Lists the content of the Preference List.
746 .RE
748 .sp
749 .ne 2
750 .na
751 \fB\fBremoveprefer\fR \fIprofile\fR\fR
752 .ad
753 .sp .6
754 .RS 4n
755 Removes one or more profiles from the Preference List. The wild-card "all" can
756 be used to delete all profiles.
757 .sp
758 The "solaris.network.wifi.config" authorization is required for this
759 subcommand.
760 .RE
762 .sp
763 .ne 2
764 .na
765 \fB\fBsetprefer\fR \fIprofile\fR [\fIn\fR]\fR
766 .ad
767 .sp .6
768 .RS 4n
769 Sets the position of a \fIprofile\fR in the Preference List. This may add or
770 change the position of a \fIprofile\fR in the Preference List. The valid values
771 of "\fIn\fR" range from 1 to 10. If "\fIn\fR" is missing, the default value of
772 1 is assumed. If the specified position is already occupied, the occupying
773 \fIprofile\fR is moved lower on the list. If "\fIn\fR" is off the end of the
774 list, \fIprofile\fR is added to the end of the list. The Preference List can
775 also be created by using this subcommand. If the \fBautoconf\fR subcommand is
776 used at a later time, \fBwificonfig\fR tries to join the \fBWLAN\fRs according
777 to the Preference List.
778 .sp
779 The "solaris.network.wifi.config" authorization is required for this
780 subcommand.
781 .RE
783 .SH EXAMPLES
784 .LP
785 \fBExample 1 \fRListing the Parameters Supported by a Driver
786 .sp
787 .LP
788 To display what parameters the \fIath\fR driver supports and the read/write
789 modes of the parameters:
791 .sp
792 .in +2
793 .nf
794 % wificonfig -i ath0 setparam
795 parameter property
796 bssid read only
797 essid read/write
798 bsstype read/write
799 rates read/write
800 authmode read/write
801 encryption read/write
802 wepkeyindex read/write
803 signal read only
805 .fi
806 .in -2
807 .sp
809 .LP
810 \fBExample 2 \fRGetting and Setting Parameters on the WiFi interface
811 .sp
812 .LP
813 To get the current rates and signal strength from the driver:
815 .sp
816 .in +2
817 .nf
818 % wificonfig -i ath0 getparam rates signal
819 ath0:
820 rates = 1,2,5.5,11
821 signal = 10
822 .fi
823 .in -2
824 .sp
826 .LP
827 \fBExample 3 \fRManaging Configuration Profiles
828 .sp
829 .LP
830 A Configuration Profile can be created offline and then connected to the
831 network with the created Configuration Profile. The following series of
832 commands creates the Configuration Profile, displays the contents of that
833 profile, and connects to the network with the Configuration Profile:
835 .sp
836 .in +2
837 .nf
838 % wificonfig createprofile myXXX essid=rover encryption=WEP \e
839 wepkey1=12345
840 % wificonfig showprofile myXXX
841 [myXXX]
842 essid=rover
843 encryption=WEP
844 wepkey1=[secret]
846 % ifconfig ath0 plumb
847 % wificonfig -i ath0 connect myXXX
848 .fi
849 .in -2
850 .sp
852 .LP
853 \fBExample 4 \fRManaging the Preference List
854 .sp
855 .LP
856 A profile can be added to the Preference List and then used by the
857 \fBautoconf\fR subcommand. The following series of commands adds a profile
858 named \fImyXXX\fR to the top of the Preference List, automatically connects
859 \fIath0\fR to the first available \fBWLAN\fR in the Preference List, and
860 removes \fImy_neighbor\fR from the Preference List
862 .sp
863 .in +2
864 .nf
865 % wificonfig setprefer myXXX 1
866 % ifconfig ath0 plumb
867 % wificonfig -i ath0 autoconf
868 % wificonfig removeprefer my_neighbor
869 .fi
870 .in -2
871 .sp
873 .LP
874 \fBExample 5 \fRViewing the History List
875 .sp
876 .LP
877 To display the history of the \fBWLAN\fRs:
879 .sp
880 .in +2
881 .nf
882 % wificonfig history
884 WLAN history:
886 essid bssid encryption last seen
887 myXXX 00:0f:24:11:12:14 WEP Fri Sep 13 09:15:24 2004
888 my_office_ssid 00:0f:24:11:12:15 WEP Fri Sep 13 13:20:04 2004
889 my_neighbor1 00:0f:24:11:12:16 NONE Fri Sep 14 08:01:26 2004
890 my_neighbor2 00:0f:24:11:12:17 WEP Fri Sep 18 21:33:12 2004
891 .fi
892 .in -2
893 .sp
895 .LP
896 \fBExample 6 \fRAutomatic Configuration
897 .sp
898 .LP
899 To configure the interface according to the previously saved Preference List:
901 .sp
902 .in +2
903 .nf
904 % ifconfig ath0 plumb
905 % wificonfig -i ath0 autoconf
906 .fi
907 .in -2
908 .sp
910 .sp
911 .LP
912 If the Preference List is empty, or none of the \fBWLAN\fRs listed by the
913 Proference List can be found, \fBwificonfig\fR uses the default configuration,
914 directs the interface to scan and join the \fBWLAN\fR using the built-in
915 heuristics specified above.
917 .LP
918 \fBExample 7 \fRConnecting To a WLAN
919 .sp
920 .LP
921 To search for a Configuration Profile with the name \fImyXXX\fR and configure
922 the interface accordingly:
924 .sp
925 .in +2
926 .nf
927 % ifconfig ath0 plumb
928 % wificonfig -i ath0 connect myXXX
929 .fi
930 .in -2
931 .sp
933 .sp
934 .LP
935 If the specified Configuration Profile does not exist, \fBwificonfig\fR
936 interprets it as an \fIessid\fR and sets \fIath0\fR to use \fIessid\fR
937 \fImyXXX\fR, and no other parameters are set.
939 .LP
940 \fBExample 8 \fRDisplaying the Content of a Configuration Profile
941 .sp
942 .LP
943 To print the parameters of the previously Configured Profile named
944 \fImy_home_ssid\fR:
946 .sp
947 .in +2
948 .nf
949 % wificonfig showprofile my_home_ssid
950 .fi
951 .in -2
952 .sp
954 .LP
955 \fBExample 9 \fRMonitoring the link status
956 .sp
957 .LP
958 To monitor the link status:
960 .sp
961 .in +2
962 .nf
963 % wificonfig -i ath0 showstatus
964 ath0:
965 linkstatus: not connected,
966 .fi
967 .in -2
968 .sp
970 .sp
971 .LP
972 or
974 .sp
975 .in +2
976 .nf
977 ath0:
978 linkstatus: connected
979 active profile: [home]
980 essid: myhome
981 bssid: 00:0b:0e:12:e2:02
982 encryption: WEP
983 signal: medium(10)
984 .fi
985 .in -2
986 .sp
988 .LP
989 \fBExample 10 \fRScanning for available networks
990 .sp
991 .LP
992 To scan for available networks:
994 .sp
995 .in +2
996 .nf
997 % wificonfig -i ath0 scan
998 essid bssid type encryption signal
999 level
1000 ietf64-secure 00:0b:0e:12:e2:02 access point WEP 9
1001 roomlinx 00:40:96:a1:13:70 access point none 6
1002 ietf64 00:0b:0e:13:32:00 access point none 3
1003 ietf64-secure 00:0b:0e:13:32:02 access point WEP 3
1004 ietf64 00:0b:0e:12:e2:00 access point none 9
1005 ietf64-secure 00:0b:0e:12:e4:c2 access point WEP 8
1006 ietf64 00:0b:0e:12:e4:c0 access point none 8
1007 roomlinx 00:40:96:a0:aa:aa access point none 1
1008 roomlinx 00:40:96:a0:ab:39 access point none 8
1009 .fi
1010 .in -2
1011 .sp
1013 .SH EXIT STATUS
1014 .sp
1015 .ne 2
1016 .na
1017 \fB\fB0\fR\fR
1018 .ad
1019 .RS 5n
1020 Successful operation
1021 .RE
1023 .sp
1024 .ne 2
1025 .na
1026 \fB\fB1\fR\fR
1027 .ad
1028 .RS 5n
1029 Fatal Error; the operation failed. For example, a connect failed to associate
1030 with an Access Point.
1031 .RE
1033 .sp
1034 .ne 2
1035 .na
1036 \fB\fB2\fR\fR
1037 .ad
1038 .RS 5n
1039 Improper Use; help information will be printed
1040 .RE
1042 .sp
1043 .ne 2
1044 .na
1045 \fB\fB3\fR\fR
1046 .ad
1047 .RS 5n
1048 Minor error
1049 .RE
1051 .SH ATTRIBUTES
1052 .sp
1053 .LP
1054 See \fBattributes\fR(5) for descriptions of the following attributes:
1055 .sp
1057 .sp
1058 .TS
1059 box;
1060 c | c
1061 l | l .
1062 ATTRIBUTE TYPE ATTRIBUTE VALUE
1063 _
1064 Interface Stability Unstable
1065 .TE
1067 .SH SEE ALSO
1068 .sp
1069 .LP
1070 \fBps\fR(1), \fBifconfig\fR(1M), \fBattributes\fR(5), \fBath\fR(7D)