Upgrade to OpenSSH 4.6p1.
[dragonfly.git] / sbin / ifconfig / ifconfig.8
1 .\" Copyright (c) 1983, 1991, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 4. Neither the name of the University nor the names of its contributors
13 .\"    may be used to endorse or promote products derived from this software
14 .\"    without specific prior written permission.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .\" SUCH DAMAGE.
27 .\"
28 .\"     From: @(#)ifconfig.8    8.3 (Berkeley) 1/5/94
29 .\" $FreeBSD: src/sbin/ifconfig/ifconfig.8,v 1.124 2006/10/10 09:44:08 ru Exp $
30 .\" $DragonFly: src/sbin/ifconfig/ifconfig.8,v 1.17 2007/03/06 12:22:39 sephe Exp $
31 .\"
32 .Dd November 19, 2006
33 .Dt IFCONFIG 8
34 .Os
35 .Sh NAME
36 .Nm ifconfig
37 .Nd configure network interface parameters
38 .Sh SYNOPSIS
39 .Nm
40 .Op Fl L
41 .Op Fl k
42 .Op Fl m
43 .Ar interface
44 .Op Cm create
45 .Op Ar address_family
46 .Oo
47 .Ar address
48 .Op Ar dest_address
49 .Oc
50 .Op Ar parameters
51 .Nm
52 .Ar interface
53 .Cm destroy
54 .Nm
55 .Fl a
56 .Op Fl L
57 .Op Fl d
58 .Op Fl m
59 .Op Fl u
60 .Op Fl v
61 .Op Ar address_family
62 .Nm
63 .Fl l
64 .Op Fl d
65 .Op Fl u
66 .Op Ar address_family
67 .Nm
68 .Op Fl L
69 .Op Fl d
70 .Op Fl k
71 .Op Fl m
72 .Op Fl u
73 .Op Fl v
74 .Op Fl C
75 .Sh DESCRIPTION
76 The
77 .Nm
78 utility is used to assign an address
79 to a network interface and/or configure
80 network interface parameters.
81 The
82 .Nm
83 utility must be used at boot time to define the network address
84 of each interface present on a machine; it may also be used at
85 a later time to redefine an interface's address
86 or other operating parameters.
87 .Pp
88 The following options are available:
89 .Bl -tag -width indent
90 .It Ar address
91 For the
92 .Tn DARPA Ns -Internet
93 family,
94 the address is either a host name present in the host name data
95 base,
96 .Xr hosts 5 ,
97 or a
98 .Tn DARPA
99 Internet address expressed in the Internet standard
100 .Dq dot notation .
101 .Pp
102 It is also possible to use the CIDR notation (also known as the
103 slash notation) to include the netmask.
104 That is, one can specify an address like
105 .Li 192.168.0.1/16 .
106 .Pp
107 For
108 .Dq inet6
109 family, it is also possible to specify the prefix length using the slash
110 notation, like
111 .Li ::1/128 .
112 See the
113 .Cm prefixlen
114 parameter below for more information.
115 .\" For the Xerox Network Systems(tm) family,
116 .\" addresses are
117 .\" .Ar net:a.b.c.d.e.f ,
118 .\" where
119 .\" .Ar net
120 .\" is the assigned network number (in decimal),
121 .\" and each of the six bytes of the host number,
122 .\" .Ar a
123 .\" through
124 .\" .Ar f ,
125 .\" are specified in hexadecimal.
126 .\" The host number may be omitted on IEEE 802 protocol
127 .\" (Ethernet, FDDI, and Token Ring) interfaces,
128 .\" which use the hardware physical address,
129 .\" and on interfaces other than the first.
130 .\" For the
131 .\" .Tn ISO
132 .\" family, addresses are specified as a long hexadecimal string,
133 .\" as in the Xerox family.
134 .\" However, two consecutive dots imply a zero
135 .\" byte, and the dots are optional, if the user wishes to (carefully)
136 .\" count out long strings of digits in network byte order.
137 .Pp
138 The link-level
139 .Pq Dq link
140 address
141 is specified as a series of colon-separated hex digits.
142 This can be used to
143 e.g.\& set a new MAC address on an ethernet interface, though the
144 mechanism used is not ethernet-specific.
145 If the interface is already
146 up when this option is used, it will be briefly brought down and
147 then brought back up again in order to ensure that the receive
148 filter in the underlying ethernet hardware is properly reprogrammed.
149 .It Ar address_family
150 Specify the
151 address family
152 which affects interpretation of the remaining parameters.
153 Since an interface can receive transmissions in differing protocols
154 with different naming schemes, specifying the address family is recommended.
155 The address or protocol families currently
156 supported are
157 .Dq inet ,
158 .Dq inet6 ,
159 .Dq atalk ,
160 .Dq ipx ,
161 .\" .Dq iso ,
162 and
163 .Dq link .
164 .\" and
165 .\" .Dq ns .
166 The default is
167 .Dq inet .
168 .Dq ether
169 and
170 .Dq lladdr
171 are synonyms for
172 .Dq link .
173 .It Ar dest_address
174 Specify the address of the correspondent on the other end
175 of a point to point link.
176 .It Ar interface
177 This
178 parameter is a string of the form
179 .Dq name unit ,
180 for example,
181 .Dq Li ed0 .
182 .El
183 .Pp
184 The following parameters may be set with
185 .Nm :
186 .Bl -tag -width indent
187 .It Cm add
188 Another name for the
189 .Cm alias
190 parameter.
191 Introduced for compatibility
192 with
193 .Bsx .
194 .It Cm alias
195 Establish an additional network address for this interface.
196 This is sometimes useful when changing network numbers, and
197 one wishes to accept packets addressed to the old interface.
198 If the address is on the same subnet as the first network address
199 for this interface, a non-conflicting netmask must be given.
200 Usually
201 .Li 0xffffffff
202 is most appropriate.
203 .It Fl alias
204 Remove the network address specified.
205 This would be used if you incorrectly specified an alias, or it
206 was no longer needed.
207 If you have incorrectly set an NS address having the side effect
208 of specifying the host portion, removing all NS addresses will
209 allow you to respecify the host portion.
210 .It Cm anycast
211 (Inet6 only.)
212 Specify that the address configured is an anycast address.
213 Based on the current specification,
214 only routers may configure anycast addresses.
215 Anycast address will not be used as source address of any of outgoing
216 IPv6 packets.
217 .It Cm arp
218 Enable the use of the Address Resolution Protocol
219 .Pq Xr arp 4
220 in mapping
221 between network level addresses and link level addresses (default).
222 This is currently implemented for mapping between
223 .Tn DARPA
224 Internet
225 addresses and
226 .Tn IEEE
227 802 48-bit MAC addresses (Ethernet, FDDI, and Token Ring addresses).
228 .It Fl arp
229 Disable the use of the Address Resolution Protocol
230 .Pq Xr arp 4 .
231 .It Cm broadcast
232 (Inet only.)
233 Specify the address to use to represent broadcasts to the
234 network.
235 The default broadcast address is the address with a host part of all 1's.
236 .It Cm debug
237 Enable driver dependent debugging code; usually, this turns on
238 extra console error logging.
239 .It Fl debug
240 Disable driver dependent debugging code.
241 .It Cm promisc
242 Put interface into permanently promiscuous mode.
243 .It Fl promisc
244 Disable permanently promiscuous mode.
245 .It Cm delete
246 Another name for the
247 .Fl alias
248 parameter.
249 .It Cm down
250 Mark an interface
251 .Dq down .
252 When an interface is marked
253 .Dq down ,
254 the system will not attempt to
255 transmit messages through that interface.
256 If possible, the interface will be reset to disable reception as well.
257 This action does not automatically disable routes using the interface.
258 .It Cm eui64
259 (Inet6 only.)
260 Fill interface index
261 (lowermost 64bit of an IPv6 address)
262 automatically.
263 .It Cm ipdst
264 This is used to specify an Internet host who is willing to receive
265 IP packets encapsulating IPX packets bound for a remote network.
266 An apparent point to point link is constructed, and
267 the address specified will be taken as the IPX address and network
268 of the destination.
269 .It Cm media Ar type
270 If the driver supports the media selection system, set the media type
271 of the interface to
272 .Ar type .
273 Some interfaces support the mutually exclusive use of one of several
274 different physical media connectors.
275 For example, a 10Mbit/s Ethernet
276 interface might support the use of either
277 .Tn AUI
278 or twisted pair connectors.
279 Setting the media type to
280 .Cm 10base5/AUI
281 would change the currently active connector to the AUI port.
282 Setting it to
283 .Cm 10baseT/UTP
284 would activate twisted pair.
285 Refer to the interfaces' driver
286 specific documentation or man page for a complete list of the
287 available types.
288 .It Cm mediaopt Ar opts
289 If the driver supports the media selection system, set the specified
290 media options on the interface.
291 The
292 .Ar opts
293 argument
294 is a comma delimited list of options to apply to the interface.
295 Refer to the interfaces' driver specific man page for a complete
296 list of available options.
297 .It Fl mediaopt Ar opts
298 If the driver supports the media selection system, disable the
299 specified media options on the interface.
300 .It Cm mode Ar mode
301 If the driver supports the media selection system, set the specified
302 operating mode on the interface to
303 .Ar mode .
304 For IEEE 802.11 wireless interfaces that support multiple operating modes
305 this directive is used to select between 802.11a
306 .Pq Cm 11a ,
307 802.11b
308 .Pq Cm 11b ,
309 and 802.11g
310 .Pq Cm 11g
311 operating modes.
312 .It Cm name Ar name
313 Set the interface name to
314 .Ar name .
315 .It Cm rxcsum , txcsum
316 If the driver supports user-configurable checksum offloading,
317 enable receive (or transmit) checksum offloading on the interface.
318 Some drivers may not be able to enable these flags independently
319 of each other, so setting one may also set the other.
320 The driver will offload as much checksum work as it can reliably
321 support, the exact level of offloading varies between drivers.
322 .It Fl rxcsum , txcsum
323 If the driver supports user-configurable checksum offloading,
324 disable receive (or transmit) checksum offloading on the interface.
325 These settings may not always be independent of each other.
326 .It Cm vlanmtu , vlanhwtag
327 If the driver offers user-configurable VLAN support, enable
328 reception of extended frames or tag processing in hardware,
329 respectively.
330 Note that this must be issued on a physical interface associated with
331 .Xr vlan 4 ,
332 not on a
333 .Xr vlan 4
334 interface itself.
335 .It Fl vlanmtu , vlanhwtag
336 If the driver offers user-configurable VLAN support, disable
337 reception of extended frames or tag processing in hardware,
338 respectively.
339 .It Cm polling
340 Turn on
341 .Xr polling 4
342 feature and disable interrupts on the interface, if the driver supports
343 this mode.
344 .It Fl polling
345 Turn off
346 .Xr polling 4
347 feature and enable interrupt mode on the interface.
348 .It Cm create
349 Create the specified network pseudo-device.
350 If the interface is given without a unit number, try to create a new
351 device with an arbitrary unit number.
352 If creation of an arbitrary device is successful, the new device name is
353 printed to standard output unless the interface is renamed or destroyed
354 in the same
355 .Nm
356 invocation.
357 .It Cm destroy
358 Destroy the specified network pseudo-device.
359 .It Cm plumb
360 Another name for the
361 .Cm create
362 parameter.
363 Included for
364 .Tn Solaris
365 compatibility.
366 .It Cm unplumb
367 Another name for the
368 .Cm destroy
369 parameter.
370 Included for
371 .Tn Solaris
372 compatibility.
373 .It Cm metric Ar n
374 Set the routing metric of the interface to
375 .Ar n ,
376 default 0.
377 The routing metric is used by the routing protocol
378 .Pq Xr routed 8 .
379 Higher metrics have the effect of making a route
380 less favorable; metrics are counted as additional hops
381 to the destination network or host.
382 .It Cm mtu Ar n
383 Set the maximum transmission unit of the interface to
384 .Ar n ,
385 default is interface specific.
386 The MTU is used to limit the size of packets that are transmitted on an
387 interface.
388 Not all interfaces support setting the MTU, and some interfaces have
389 range restrictions.
390 .It Cm netmask Ar mask
391 .\" (Inet and ISO.)
392 (Inet only.)
393 Specify how much of the address to reserve for subdividing
394 networks into sub-networks.
395 The mask includes the network part of the local address
396 and the subnet part, which is taken from the host field of the address.
397 The mask can be specified as a single hexadecimal number
398 with a leading
399 .Ql 0x ,
400 with a dot-notation Internet address,
401 or with a pseudo-network name listed in the network table
402 .Xr networks 5 .
403 The mask contains 1's for the bit positions in the 32-bit address
404 which are to be used for the network and subnet parts,
405 and 0's for the host part.
406 The mask should contain at least the standard network portion,
407 and the subnet field should be contiguous with the network
408 portion.
409 .Pp
410 The netmask can also be specified in CIDR notation after the address.
411 See the
412 .Ar address
413 option above for more information.
414 .It Cm autoconf
415 (Inet6 only.)
416 Enable autoconfiguration.
417 .It Fl autoconf
418 Disable autoconfiguration.
419 .It Cm pltime Ar n
420 (Inet6 only.)
421 Set preferred lifetime for the address.
422 .It Cm vltime Ar n
423 (Inet6 only.)
424 Set valid lifetime for the address.
425 .It Cm prefixlen Ar len
426 (Inet6 only.)
427 Specify that
428 .Ar len
429 bits are reserved for subdividing networks into sub-networks.
430 The
431 .Ar len
432 must be integer, and for syntactical reason it must be between 0 to 128.
433 It is almost always 64 under the current IPv6 assignment rule.
434 If the parameter is omitted, 64 is used.
435 .Pp
436 The prefix can also be specified using the slash notation after the address.
437 See the
438 .Ar address
439 option above for more information.
440 .It Cm deprecated
441 (Inet6 only.)
442 Set the IPv6 deprecated address bit.
443 .It Fl deprecated
444 (Inet6 only.)
445 Clear the IPv6 deprecated address bit.
446 .It Cm tentative
447 (Inet6 only.)
448 Set the IPv6 tentative address bit.
449 .It Fl tentative
450 (Inet6 only.)
451 Clear the IPv6 tentative address bit.
452 .\" see
453 .\" Xr eon 5 .
454 .\" .It Cm nsellength Ar n
455 .\" .Pf ( Tn ISO
456 .\" only)
457 .\" This specifies a trailing number of bytes for a received
458 .\" .Tn NSAP
459 .\" used for local identification, the remaining leading part of which is
460 .\" taken to be the
461 .\" .Tn NET
462 .\" (Network Entity Title).
463 .\" The default value is 1, which is conformant to US
464 .\" .Tn GOSIP .
465 .\" When an ISO address is set in an ifconfig command,
466 .\" it is really the
467 .\" .Tn NSAP
468 .\" which is being specified.
469 .\" For example, in
470 .\" .Tn US GOSIP ,
471 .\" 20 hex digits should be
472 .\" specified in the
473 .\" .Tn ISO NSAP
474 .\" to be assigned to the interface.
475 .\" There is some evidence that a number different from 1 may be useful
476 .\" for
477 .\" .Tn AFI
478 .\" 37 type addresses.
479 .It Cm range Ar netrange
480 Under appletalk, set the interface to respond to a
481 .Ar netrange
482 of the form
483 .Ar startnet Ns - Ns Ar endnet .
484 Appletalk uses this scheme instead of
485 netmasks though
486 .Fx
487 implements it internally as a set of netmasks.
488 .It Cm remove
489 Another name for the
490 .Fl alias
491 parameter.
492 Introduced for compatibility
493 with
494 .Bsx .
495 .It Cm phase
496 The argument following this specifies the version (phase) of the
497 Appletalk network attached to the interface.
498 Values of 1 or 2 are permitted.
499 .Sm off
500 .It Cm link Op Cm 0 No - Cm 2
501 .Sm on
502 Enable special processing of the link level of the interface.
503 These three options are interface specific in actual effect, however,
504 they are in general used to select special modes of operation.
505 An example
506 of this is to enable SLIP compression, or to select the connector type
507 for some Ethernet cards.
508 Refer to the man page for the specific driver
509 for more information.
510 .Sm off
511 .It Fl link Op Cm 0 No - Cm 2
512 .Sm on
513 Disable special processing at the link level with the specified interface.
514 .It Cm compress
515 Another name for the
516 .Cm link0
517 parameter.
518 .It Cm normal
519 Another name for the
520 .Fl link0
521 parameter.
522 .It Cm noicmp
523 Another name for the
524 .Cm link1
525 parameter.
526 .It Cm monitor
527 Put the interface in monitor mode.
528 No packets are transmitted, and received packets are discarded after
529 .Xr bpf 4
530 processing.
531 .It Fl monitor
532 Take the interface out of monitor mode.
533 .It Cm up
534 Mark an interface
535 .Dq up .
536 This may be used to enable an interface after an
537 .Dq Nm Cm down .
538 It happens automatically when setting the first address on an interface.
539 If the interface was reset when previously marked down,
540 the hardware will be re-initialized.
541 .El
542 .Pp
543 The following parameters are specific to IEEE 802.11 wireless interfaces:
544 .Bl -tag -width indent
545 .It Cm apbridge
546 When operating as an access point, pass packets between
547 wireless clients directly (default).
548 To instead let them pass up through the
549 system and be forwarded using some other mechanism, use
550 .Fl apbridge .
551 Disabling the internal bridging
552 is useful when traffic is to be processed with
553 packet filtering.
554 .It Cm authmode Ar mode
555 Set the desired authentication mode in infrastructure mode.
556 Not all adaptors support all modes.
557 The set of
558 valid modes is
559 .Cm none , open , shared
560 (shared key),
561 .Cm 8021x
562 (IEEE 802.1x),
563 and
564 .Cm wpa
565 (IEEE WPA/WPA2/802.11i).
566 The
567 .Cm 8021x
568 and
569 .Cm wpa
570 modes are only useful when using an authentication service
571 (a supplicant for client operation or an authenticator when
572 operating as an access point).
573 Modes are case insensitive.
574 .It Cm bintval Ar interval
575 Set the interval at which beacon frames are sent when operating in
576 ad-hoc or ap mode.
577 The
578 .Ar interval
579 parameter is specified in TU's (1024 usecs).
580 By default beacon frames are transmitted every 100 TU's.
581 .It Cm bmissthreshold Ar count
582 Set the number of consecutive missed beacons at which the station
583 will attempt to roam (i.e. search for a new access point).
584 The
585 .Ar count
586 parameter is must be in the range 1 to 255;
587 though the upper bound may be reduced according to device capabilities..
588 The default threshold is 7 consecutive missed beacons;
589 but this may be overridden by the device driver.
590 Another name for the
591 .Cm bmissthreshold
592 parameter is
593 .Cm bmiss .
594 .It Cm bssid Ar address
595 Specify the MAC address of the access point to use when operating
596 as a station in a BSS network.
597 This overrides any automatic selection done by the system.
598 To disable a previously selected access point, supply
599 .Cm any , none ,
600 or
601 .Cm -
602 for the address.
603 This option is useful when more than one access point uses the same SSID.
604 Another name for the
605 .Cm bssid
606 parameter is
607 .Cm ap .
608 .It Cm burst
609 Enable packet bursting.
610 Packet bursting is a transmission technique whereby the wireless
611 medium is acquired once to send multiple frames and the interframe
612 spacing is reduced.
613 This technique can significantly increase throughput by reducing
614 transmission overhead.
615 Packet bursting is supported by the 802.11e QoS specification
616 and some devices that do not support QoS may still be capable.
617 By default packet bursting is enabled if a device is capable
618 of doing it.
619 To disable packet bursting, use
620 .Fl burst .
621 .It Cm chanlist Ar channels
622 Set the desired channels to use when scanning for access
623 points, neighbors in an IBSS network, or looking for unoccupied
624 channels when operating as an access point.
625 The set of channels is specified as a comma-separated list with
626 each element in the list representing either a single channel number or a range
627 of the form
628 .Dq Li a-b .
629 Channel numbers must be in the range 1 to 255 and be permissible
630 according to the operating characteristics of the device.
631 .It Cm channel Ar number
632 Set a single desired channel.
633 Channels range from 1 to 255, but the exact selection available
634 depends on the region your adaptor was manufactured for.
635 Setting
636 the channel to
637 .Li 0 ,
638 .Cm any ,
639 or
640 .Cm -
641 will give you the default for your adaptor.
642 Some
643 adaptors ignore this setting unless you are in ad-hoc mode.
644 Alternatively the frequency, in megahertz, may be specified
645 instead of the channel number.
646 .It Cm deftxkey Ar index
647 Set the default key to use for transmission.
648 Typically this is only set when using WEP encryption.
649 The
650 .Cm weptxkey
651 is an alias for this request; it is provided for backwards compatibility.
652 .It Cm dtimperiod Ar period
653 Set the
654 DTIM
655 period for transmitting buffered multicast data frames when
656 operating in ap mode.
657 The
658 .Ar period
659 specifies the number of beacon intervals between DTIM
660 and must be in the range 1 to 15.
661 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
662 .It Cm fragthreshold Ar length
663 Set the threshold for which transmitted frames are broken into fragments.
664 The
665 .Ar length
666 argument is the frame size in bytes and must be in the range 256 to 2346.
667 Setting
668 .Ar length
669 to
670 .Li 2346 ,
671 .Cm any ,
672 or
673 .Cm -
674 disables transmit fragmentation.
675 Not all adaptors honor the fragmentation threshold.
676 .It Cm hidessid
677 When operating as an access point, do not broadcast the SSID
678 in beacon frames or respond to probe request frames unless
679 they are directed to the ap (i.e., they include the ap's SSID).
680 By default, the SSID is included in beacon frames and
681 undirected probe request frames are answered.
682 To re-enable the broadcast of the SSID etc., use
683 .Fl hidessid .
684 .It Cm list active
685 Display the list of channels available for use taking into account
686 any restrictions set with the
687 .Cm chanlist
688 directive.
689 See the description of
690 .Cm list chan
691 for more information.
692 .It Cm list caps
693 Display the adaptor's capabilities, including the operating
694 modes supported.
695 .It Cm list chan
696 Display the list of channels available for use.
697 Channels are shown with their IEEE channel number, equivalent
698 frequency, and usage modes.
699 Channels identified as
700 .Ql 11g
701 are also usable in
702 .Ql 11b
703 mode.
704 Channels identified as
705 .Ql 11a Turbo
706 may be used only for Atheros' Static Turbo mode
707 specified with
708 .Cm mediaopt turbo ) .
709 Channels marked with a
710 .Ql *
711 have a regulatory constraint that they be passively scanned.
712 This means a station is not permitted to transmit on the channel until
713 it identifies the channel is being used for 802.11 communication;
714 typically by hearing a beacon frame from an access point operating
715 on the channel.
716 .Cm list freq
717 is another way of requesting this information.
718 .It Cm list mac
719 Display the current MAC Access Control List state.
720 Each address is prefixed with a character that indicates the
721 current policy applied to it:
722 .Ql +
723 indicates the address is allowed access,
724 .Ql -
725 indicates the address is denied access,
726 .Ql *
727 indicates the address is present but the current policy open
728 (so the ACL is not consulted).
729 .It Cm list scan
730 Display the access points and/or ad-hoc neighbors
731 located in the vicinity.
732 The
733 .Fl v
734 flag may be used to display long SSIDs.
735 This information may be updated automatically by the adaptor
736 and/or with a
737 .Cm scan
738 request.
739 .Cm list ap
740 is another way of requesting this information.
741 .It Cm list sta
742 When operating as an access point display the stations that are
743 currently associated.
744 When operating in ad-hoc mode display stations identified as
745 neighbors in the IBSS.
746 .It Cm list wme
747 Display the current parameters to use when operating in WME mode.
748 When WME mode is enabled for an adaptor this information will be
749 displayed with the regular status; this command is mostly useful
750 for examining parameters when WME mode is disabled.
751 See the description of the
752 .Cm wme
753 directive for information on the various parameters.
754 .It Cm mcastrate Ar rate
755 Set the rate for transmitting multicast/broadcast frames.
756 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mbit/s.
757 This rate should be valid for the current operating conditions;
758 if an invalid rate is specified drivers are free to chose an
759 appropriate rate.
760 .It Cm powersave
761 Enable powersave operation.
762 When operating as a client, the station will conserve power by
763 periodically turning off the radio and listening for
764 messages from the access point telling it there are packets waiting.
765 The station must then retrieve the packets.
766 When operating as an access point, the station must honor power
767 save operation of associated clients.
768 Not all devices support power save operation, either as a client
769 or as an access point.
770 Use
771 .Fl powersave
772 to disable powersave operation.
773 .It Cm powersavemode Ar mode
774 Set powersave mode.
775 The set of valid modes is
776 .Cm off
777 (same as
778 .Fl powersave),
779 .Cm on
780 (same as
781 .Cm powersave),
782 and
783 .Cm cam
784 (same as
785 .Cm powersave).
786 .It Cm powersavesleep Ar sleep
787 Set the desired max powersave sleep time in TU's (1024 usecs).
788 By default the max powersave sleep time is 100 TU's.
789 .It Cm protmode Ar technique
790 For interfaces operating in 802.11g, use the specified
791 .Ar technique
792 for protecting OFDM frames in a mixed 11b/11g network.
793 The set of valid techniques is
794 .Cm off , cts
795 (CTS to self),
796 and
797 .Cm rtscts
798 (RTS/CTS).
799 Technique names are case insensitive.
800 .It Cm pureg
801 When operating as an access point in 802.11g mode allow only
802 11g-capable stations to associate (11b-only stations are not
803 permitted to associate).
804 To allow both 11g and 11b-only stations to associate, use
805 .Fl pureg .
806 .It Cm roaming Ar mode
807 When operating as a station, control how the system will
808 behave when communication with the current access point
809 is broken.
810 The
811 .Ar mode
812 argument may be one of
813 .Cm device
814 (leave it to the hardware device to decide),
815 .Cm auto
816 (handle either in the device or the operating system\[em]as appropriate),
817 .Cm manual
818 (do nothing until explicitly instructed).
819 By default, the device is left to handle this if it is
820 capable; otherwise, the operating system will automatically
821 attempt to reestablish communication.
822 Manual mode is mostly useful when an application wants to
823 control the selection of an access point.
824 .It Cm ratectl Ar algorithm
825 Set the TX rate control algorithm.
826 The set of valid
827 .Ar algorithm
828 is
829 .Cm onoe
830 (Onoe TX rate control algorithm)
831 and
832 .Cm amrr
833 (AMRR TX rate control algorithm).
834 .Ar Algorithm
835 names are case sensitive.
836 .It Cm rtsthreshold Ar length
837 Set the threshold for which
838 transmitted frames are preceded by transmission of an
839 RTS
840 control frame.
841 The
842 .Ar length
843 argument
844 is the frame size in bytes and must be in the range 1 to 2346.
845 Setting
846 .Ar length
847 to
848 .Li 2346 ,
849 .Cm any ,
850 or
851 .Cm -
852 disables transmission of RTS frames.
853 Not all adaptors support setting the RTS threshold.
854 .It Cm ssid Ar ssid
855 Set the desired Service Set Identifier (aka network name).
856 The SSID is a string up to 32 characters
857 in length and may be specified as either a normal string or in
858 hexadecimal when preceded by
859 .Ql 0x .
860 Additionally, the SSID may be cleared by setting it to
861 .Ql - .
862 .It Cm scan
863 Initiate a scan of neighboring stations, wait for it to complete, and
864 display all stations found.
865 Only the super-user can initiate a scan.
866 Depending on the capabilities of the APs, the following
867 flags can be included in the output:
868 .Bl -tag -width 3n
869 .It Li A
870 Channel Agility.
871 Indicates that the station support channel hopping as described by the
872 IEEE 802.11b specification.
873 .It Li B
874 Packet Binary Convolution Code (PBCC).
875 A modulation alternative to the standard OFDM method.
876 .It Dv C
877 Pollreq
878 .It Dv c
879 Pollable
880 .It Dv D
881 Direct Sequence Spread Spectrum - Orthogonal Frequency Division
882 Multiplexing (DSSS-OFDM).
883 Indicates the the station supports DSSS-OFDM modulation.
884 .It Li E
885 Extended Service Set (ESS).
886 Indicates that the station is part of an infrastructure network
887 (in contrast to an IBSS/ad-hoc network).
888 .It Li I
889 IBSS/ad-hoc network.
890 Indicates that the station is part of an ad-hoc network
891 (in contrast to an ESS network).
892 .It Li P
893 Privacy.
894 Data confidentiality is required for all data frames
895 exchanged within the BSS.
896 This means that this BSS requires the station to
897 use cryptographic means such as WEP, TKIP or AES-CCMP to
898 encrypt/decrypt data frames being exchanged with others.
899 .It Dv R
900 Robust Security Network (RSN).
901 Indicates that the station supports the IEEE 802.11i authentication
902 and key management protocol.
903 .It Li S
904 Short Preamble.
905 Indicates that the network is using short preambles (defined
906 in 802.11b High Rate/DSSS PHY, short preamble utilizes a
907 56 bit sync field in contrast to a 128 bit field used in long
908 preamble mode).
909 .It Li s
910 Short slot time.
911 Indicates that the network is using a short slot time.
912 .El
913 .Pp
914 The
915 .Cm list scan
916 request can be used to show recent scan results without
917 initiating a new scan.
918 .Pp
919 The
920 .Fl v
921 flag may be used to prevent the shortening of long SSIDs.
922 .It Cm stationname Ar name
923 Set the name of this station.
924 It appears that the station name is not really part of the IEEE 802.11
925 protocol though all interfaces seem to support it.
926 As such it only
927 seems to be meaningful to identical or virtually identical equipment.
928 Setting the station name is identical in syntax to setting the SSID.
929 .It Cm txpower Ar power
930 Set the power used to transmit frames.
931 The
932 .Ar power
933 argument
934 is a unitless value in the range 0 to 100 that is interpreted
935 by drivers to derive a device-specific value.
936 Out of range values are truncated.
937 Typically only a few discreet power settings are available and
938 the driver will use the setting closest to the specified value.
939 Not all adaptors support changing the transmit power.
940 .It Cm wepmode Ar mode
941 Set the desired WEP mode.
942 Not all adaptors support all modes.
943 The set of valid modes is
944 .Cm off , on ,
945 and
946 .Cm mixed .
947 The
948 .Cm mixed
949 mode explicitly tells the adaptor to allow association with access
950 points which allow both encrypted and unencrypted traffic.
951 On these adaptors,
952 .Cm on
953 means that the access point must only allow encrypted connections.
954 On other adaptors,
955 .Cm on
956 is generally another name for
957 .Cm mixed .
958 Modes are case insensitive.
959 .It Cm weptxkey Ar index
960 Set the WEP key to be used for transmission.
961 This is the same as setting the default transmission key with
962 .Cm deftxkey .
963 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
964 Set the selected WEP key.
965 If an
966 .Ar index
967 is not given, key 1 is set.
968 A WEP key will be either 5 or 13
969 characters (40 or 104 bits) depending of the local network and the
970 capabilities of the adaptor.
971 It may be specified either as a plain
972 string or as a string of hexadecimal digits preceded by
973 .Ql 0x .
974 For maximum portability, hex keys are recommended;
975 the mapping of text keys to WEP encryption is usually driver-specific.
976 In particular, the
977 .Tn Windows
978 drivers do this mapping differently to
979 .Fx .
980 A key may be cleared by setting it to
981 .Ql - .
982 If WEP is supported then there are at least four keys.
983 Some adaptors support more than four keys.
984 If that is the case, then the first four keys
985 (1-4) will be the standard temporary keys and any others will be adaptor
986 specific keys such as permanent keys stored in NVRAM.
987 .It Cm wme
988 Enable Wireless Multimedia Extensions (WME) support, if available,
989 for the specified interface.
990 WME is a subset of the IEEE 802.11e standard to support the
991 efficient communication of realtime and multimedia data.
992 To disable WME support, use
993 .Fl wme .
994 .Pp
995 The following parameters are meaningful only when WME support is in use.
996 Parameters are specified per-AC (Access Category) and
997 split into those that are used by a station when acting
998 as an access point and those for client stations in the BSS.
999 The latter are received from the access point and may not be changed
1000 (at the station).
1001 The following Access Categories are recognized:
1002 .Pp
1003 .Bl -tag -width ".Cm AC_BK" -compact
1004 .It Cm AC_BE
1005 (or
1006 .Cm BE )
1007 best effort delivery,
1008 .It Cm AC_BK
1009 (or
1010 .Cm BK )
1011 background traffic,
1012 .It Cm AC_VI
1013 (or
1014 .Cm VI )
1015 video traffic,
1016 .It Cm AC_VO
1017 (or
1018 .Cm VO )
1019 voice traffic.
1020 .El
1021 .Pp
1022 AC parameters are case-insensitive.
1023 Traffic classification is done in the operating system using the
1024 vlan priority associated with data frames or the
1025 ToS (Type of Service) indication in IP-encapsulated frames.
1026 If neither information is present, traffic is assigned to the
1027 Best Effort (BE) category.
1028 .Bl -tag -width indent
1029 .It Cm ack Ar ac
1030 Set the ACK policy for QoS transmissions by the local station;
1031 this controls whether or not data frames transmitted by a station
1032 require an ACK response from the receiving station.
1033 To disable waiting for an ACK use
1034 .Fl ack .
1035 This parameter is applied only to the local station.
1036 .It Cm acm Ar ac
1037 Enable the Admission Control Mandatory (ACM) mechanism
1038 for transmissions by the local station.
1039 To disable the ACM use
1040 .Fl acm .
1041 On stations in a BSS this parameter is read-only and indicates
1042 the setting received from the access point.
1043 NB: ACM is not supported right now.
1044 .It Cm aifs Ar ac Ar count
1045 Set the Arbitration Inter Frame Spacing (AIFS)
1046 channel access parameter to use for transmissions
1047 by the local station.
1048 On stations in a BSS this parameter is read-only and indicates
1049 the setting received from the access point.
1050 .It Cm cwmin Ar ac Ar count
1051 Set the CWmin channel access parameter to use for transmissions
1052 by the local station.
1053 On stations in a BSS this parameter is read-only and indicates
1054 the setting received from the access point.
1055 .It Cm cwmax Ar ac Ar count
1056 Set the CWmax channel access parameter to use for transmissions
1057 by the local station.
1058 On stations in a BSS this parameter is read-only and indicates
1059 the setting received from the access point.
1060 .It Cm txoplimit Ar ac Ar limit
1061 Set the Transmission Opportunity Limit channel access parameter
1062 to use for transmissions by the local station.
1063 This parameter defines an interval of time when a WME station
1064 has the right to initiate transmissions onto the wireless medium.
1065 On stations in a BSS this parameter is read-only and indicates
1066 the setting received from the access point.
1067 .It Cm bss:aifs Ar ac Ar count
1068 Set the AIFS channel access parameter to send to stations in a BSS.
1069 This parameter is meaningful only when operating in ap mode.
1070 .It Cm bss:cwmin Ar ac Ar count
1071 Set the CWmin channel access parameter to send to stations in a BSS.
1072 This parameter is meaningful only when operating in ap mode.
1073 .It Cm bss:cwmax Ar ac Ar count
1074 Set the CWmax channel access parameter to send to stations in a BSS.
1075 This parameter is meaningful only when operating in ap mode.
1076 .It Cm bss:txoplimit Ar ac Ar limit
1077 Set the TxOpLimit channel access parameter to send to stations in a BSS.
1078 This parameter is meaningful only when operating in ap mode.
1079 .El
1080 .El
1081 .Pp
1082 The following parameters support an optional access control list
1083 feature available with some adaptors when operating in ap mode; see
1084 .Xr wlan_acl 4 .
1085 This facility allows an access point to accept/deny association
1086 requests based on the MAC address of the station.
1087 Note that this feature does not significantly enhance security
1088 as MAC address spoofing is easy to do.
1089 .Bl -tag -width indent
1090 .It Cm mac:add Ar address
1091 Add the specified MAC address to the database.
1092 Depending on the policy setting association requests from the
1093 specified station will be allowed or denied.
1094 .It Cm mac:allow
1095 Set the ACL policy to permit association only by
1096 stations registered in the database.
1097 .It Cm mac:del Ar address
1098 Delete the specified MAC address from the database.
1099 .It Cm mac:deny
1100 Set the ACL policy to deny association only by
1101 stations registered in the database.
1102 .It Cm mac:kick Ar address
1103 Force the specified station to be deauthenticated.
1104 This typically is done to block a station after updating the
1105 address database.
1106 .It Cm mac:open
1107 Set the ACL policy to allow all stations to associate.
1108 .It Cm mac:flush
1109 Delete all entries in the database.
1110 .El
1111 .Pp
1112 The following parameters are for compatibility with other systems:
1113 .Bl -tag -width indent
1114 .It Cm nwid Ar ssid
1115 Another name for the
1116 .Cm ssid
1117 parameter.
1118 Included for
1119 .Nx
1120 compatibility.
1121 .It Cm station Ar name
1122 Another name for the
1123 .Cm stationname
1124 parameter.
1125 Included for
1126 .Bsx
1127 compatibility.
1128 .It Cm wep
1129 Another way of saying
1130 .Cm wepmode on .
1131 Included for
1132 .Bsx
1133 compatibility.
1134 .It Fl wep
1135 Another way of saying
1136 .Cm wepmode off .
1137 Included for
1138 .Bsx
1139 compatibility.
1140 .It Cm nwkey key
1141 Another way of saying:
1142 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
1143 Included for
1144 .Nx
1145 compatibility.
1146 .It Cm nwkey Xo
1147 .Sm off
1148 .Ar n : k1 , k2 , k3 , k4
1149 .Sm on
1150 .Xc
1151 Another way of saying
1152 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
1153 Included for
1154 .Nx
1155 compatibility.
1156 .It Fl nwkey
1157 Another way of saying
1158 .Cm wepmode off .
1159 Included for
1160 .Nx
1161 compatibility.
1162 .El
1163 .Pp
1164 The following parameters are specific to bridge interfaces:
1165 .Bl -tag -width indent
1166 .It Cm addm Ar interface
1167 Add the interface named by
1168 .Ar interface
1169 as a member of the bridge.
1170 The interface is put into promiscuous mode
1171 so that it can receive every packet sent on the network.
1172 .It Cm deletem Ar interface
1173 Remove the interface named by
1174 .Ar interface
1175 from the bridge.
1176 Promiscuous mode is disabled on the interface when
1177 it is removed from the bridge.
1178 .It Cm maxaddr Ar size
1179 Set the size of the bridge address cache to
1180 .Ar size .
1181 The default is 100 entries.
1182 .It Cm timeout Ar seconds
1183 Set the timeout of address cache entries to
1184 .Ar seconds
1185 seconds.
1186 If
1187 .Ar seconds
1188 is zero, then address cache entries will not be expired.
1189 The default is 240 seconds.
1190 .It Cm addr
1191 Display the addresses that have been learned by the bridge.
1192 .It Cm static Ar interface-name Ar address
1193 Add a static entry into the address cache pointing to
1194 .Ar interface-name .
1195 Static entries are never aged out of the cache or re-placed, even if the
1196 address is seen on a different interface.
1197 .It Cm deladdr Ar address
1198 Delete
1199 .Ar address
1200 from the address cache.
1201 .It Cm flush
1202 Delete all dynamically-learned addresses from the address cache.
1203 .It Cm flushall
1204 Delete all addresses, including static addresses, from the address cache.
1205 .It Cm discover Ar interface
1206 Mark an interface as a
1207 .Dq discovering
1208 interface.
1209 When the bridge has no address cache entry
1210 (either dynamic or static)
1211 for the destination address of a packet,
1212 the bridge will forward the packet to all
1213 member interfaces marked as
1214 .Dq discovering .
1215 This is the default for all interfaces added to a bridge.
1216 .It Fl discover Ar interface
1217 Clear the
1218 .Dq discovering
1219 attribute on a member interface.
1220 For packets without the
1221 .Dq discovering
1222 attribute, the only packets forwarded on the interface are broadcast
1223 or multicast packets and packets for which the destination address
1224 is known to be on the interface's segment.
1225 .It Cm learn Ar interface
1226 Mark an interface as a
1227 .Dq learning
1228 interface.
1229 When a packet arrives on such an interface, the source
1230 address of the packet is entered into the address cache as being a
1231 destination address on the interface's segment.
1232 This is the default for all interfaces added to a bridge.
1233 .It Fl learn Ar interface
1234 Clear the
1235 .Dq learning
1236 attribute on a member interface.
1237 .It Cm span Ar interface
1238 Add the interface named by
1239 .Ar interface
1240 as a span port on the bridge.
1241 Span ports transmit a copy of every frame received by the bridge.
1242 This is most useful for snooping a bridged network passively on
1243 another host connected to one of the span ports of the bridge.
1244 .It Fl span Ar interface
1245 Delete the interface named by
1246 .Ar interface
1247 from the list of span ports of the bridge.
1248 .It Cm stp Ar interface
1249 Enable Spanning Tree protocol on
1250 .Ar interface .
1251 The
1252 .Xr bridge 4
1253 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
1254 Spanning Tree is used to detect and remove loops in a network topology.
1255 .It Fl stp Ar interface
1256 Disable Spanning Tree protocol on
1257 .Ar interface .
1258 This is the default for all interfaces added to a bridge.
1259 .It Cm maxage Ar seconds
1260 Set the time that a Spanning Tree protocol configuration is valid.
1261 The default is 20 seconds.
1262 The minimum is 1 second and the maximum is 255 seconds.
1263 .It Cm fwddelay Ar seconds
1264 Set the time that must pass before an interface begins forwarding
1265 packets when Spanning Tree is enabled.
1266 The default is 15 seconds.
1267 The minimum is 1 second and the maximum is 255 seconds.
1268 .It Cm hellotime Ar seconds
1269 Set the time between broadcasting of Spanning Tree protocol
1270 configuration messages.
1271 The default is 2 seconds.
1272 The minimum is 1 second and the maximum is 255 seconds.
1273 .It Cm priority Ar value
1274 Set the bridge priority for Spanning Tree.
1275 The default is 32768.
1276 The minimum is 0 and the maximum is 65536.
1277 .It Cm ifpriority Ar interface Ar value
1278 Set the Spanning Tree priority of
1279 .Ar interface
1280 to
1281 .Ar value .
1282 The default is 128.
1283 The minimum is 0 and the maximum is 255.
1284 .It Cm ifpathcost Ar interface Ar value
1285 Set the Spanning Tree path cost of
1286 .Ar interface
1287 to
1288 .Ar value .
1289 The default is 55.
1290 The minimum is 0 and the maximum is 65535.
1291 .El
1292 .Pp
1293 The following parameters are specific to IP tunnel interfaces,
1294 .Xr gif 4 :
1295 .Bl -tag -width indent
1296 .It Cm tunnel Ar src_addr dest_addr
1297 Configure the physical source and destination address for IP tunnel
1298 interfaces.
1299 The arguments
1300 .Ar src_addr
1301 and
1302 .Ar dest_addr
1303 are interpreted as the outer source/destination for the encapsulating
1304 IPv4/IPv6 header.
1305 .It Fl tunnel
1306 Unconfigure the physical source and destination address for IP tunnel
1307 interfaces previously configured with
1308 .Cm tunnel .
1309 .It Cm deletetunnel
1310 Another name for the
1311 .Fl tunnel
1312 parameter.
1313 .El
1314 .Pp
1315 The following parameters are specific to
1316 .Xr vlan 4
1317 interfaces:
1318 .Bl -tag -width indent
1319 .It Cm vlan Ar vlan_tag
1320 Set the VLAN tag value to
1321 .Ar vlan_tag .
1322 This value is a 16-bit number which is used to create an 802.1Q
1323 VLAN header for packets sent from the
1324 .Xr vlan 4
1325 interface.
1326 Note that
1327 .Cm vlan
1328 and
1329 .Cm vlandev
1330 must both be set at the same time.
1331 .It Cm vlandev Ar iface
1332 Associate the physical interface
1333 .Ar iface
1334 with a
1335 .Xr vlan 4
1336 interface.
1337 Packets transmitted through the
1338 .Xr vlan 4
1339 interface will be
1340 diverted to the specified physical interface
1341 .Ar iface
1342 with 802.1Q VLAN encapsulation.
1343 Packets with 802.1Q encapsulation received
1344 by the parent interface with the correct VLAN tag will be diverted to
1345 the associated
1346 .Xr vlan 4
1347 pseudo-interface.
1348 The
1349 .Xr vlan 4
1350 interface is assigned a
1351 copy of the parent interface's flags and the parent's ethernet address.
1352 The
1353 .Cm vlandev
1354 and
1355 .Cm vlan
1356 must both be set at the same time.
1357 If the
1358 .Xr vlan 4
1359 interface already has
1360 a physical interface associated with it, this command will fail.
1361 To
1362 change the association to another physical interface, the existing
1363 association must be cleared first.
1364 .Pp
1365 Note: if the hardware tagging capability
1366 is set on the parent interface, the
1367 .Xr vlan 4
1368 pseudo
1369 interface's behavior changes:
1370 the
1371 .Xr vlan 4
1372 interface recognizes that the
1373 parent interface supports insertion and extraction of VLAN tags on its
1374 own (usually in firmware) and that it should pass packets to and from
1375 the parent unaltered.
1376 .It Fl vlandev Op Ar iface
1377 If the driver is a
1378 .Xr vlan 4
1379 pseudo device, disassociate the parent interface from it.
1380 This breaks the link between the
1381 .Xr vlan 4
1382 interface and its parent,
1383 clears its VLAN tag, flags and its link address and shuts the interface down.
1384 The
1385 .Ar iface
1386 argument is useless and hence deprecated.
1387 .El
1388 .Pp
1389 The
1390 .Nm
1391 utility displays the current configuration for a network interface
1392 when no optional parameters are supplied.
1393 If a protocol family is specified,
1394 .Nm
1395 will report only the details specific to that protocol family.
1396 .Pp
1397 If the
1398 .Fl m
1399 flag is passed before an interface name,
1400 .Nm
1401 will display the capability list and all
1402 of the supported media for the specified interface.
1403 If
1404 .Fl L
1405 flag is supplied, address lifetime is displayed for IPv6 addresses,
1406 as time offset string.
1407 .Pp
1408 Optionally, the
1409 .Fl a
1410 flag may be used instead of an interface name.
1411 This flag instructs
1412 .Nm
1413 to display information about all interfaces in the system.
1414 The
1415 .Fl d
1416 flag limits this to interfaces that are down, and
1417 .Fl u
1418 limits this to interfaces that are up.
1419 When no arguments are given,
1420 .Fl a
1421 is implied.
1422 .Pp
1423 The
1424 .Fl l
1425 flag may be used to list all available interfaces on the system, with
1426 no other additional information.
1427 Use of this flag is mutually exclusive
1428 with all other flags and commands, except for
1429 .Fl d
1430 (only list interfaces that are down)
1431 and
1432 .Fl u
1433 (only list interfaces that are up).
1434 .Pp
1435 The
1436 .Fl v
1437 flag may be used to get more verbose status for an interface.
1438 .Pp
1439 The
1440 .Fl C
1441 flag may be used to list all of the interface cloners available on
1442 the system, with no additional information.
1443 Use of this flag is mutually exclusive with all other flags and commands.
1444 .Pp
1445 The
1446 .Fl k
1447 flag causes keying information for the interface, if available, to be
1448 printed.
1449 For example, the values of 802.11 WEP keys will be printed, if accessible to
1450 the current user.
1451 This information is not printed by default, as it may be considered
1452 sensitive.
1453 .Pp
1454 Only the super-user may modify the configuration of a network interface.
1455 .Sh DIAGNOSTICS
1456 Messages indicating the specified interface does not exist, the
1457 requested address is unknown, or the user is not privileged and
1458 tried to alter an interface's configuration.
1459 .Sh SEE ALSO
1460 .Xr netstat 1 ,
1461 .Xr ifmedia 4 ,
1462 .Xr netintro 4 ,
1463 .Xr polling 4 ,
1464 .Xr vlan 4 ,
1465 .\" .Xr eon 5 ,
1466 .Xr rc 8 ,
1467 .Xr routed 8 ,
1468 .Xr sysctl 8
1469 .Sh HISTORY
1470 The
1471 .Nm
1472 utility appeared in
1473 .Bx 4.2 .
1474 .Sh BUGS
1475 Basic IPv6 node operation requires a link-local address on each
1476 interface configured for IPv6.
1477 Normally, such an address is automatically configured by the
1478 kernel on each interface added to the system; this behaviour may
1479 be disabled by setting the sysctl MIB variable
1480 .Va net.inet6.ip6.auto_linklocal
1481 to 0.
1482 .Pp
1483 If you delete such an address using
1484 .Nm ,
1485 the kernel may act very odd.
1486 Do this at your own risk.