ifconfig(8): Add 'lscan'. Like 'scan', but displays long SSIDs.
[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 .\" 3. 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 .\"
31 .Dd October 14, 2017
32 .Dt IFCONFIG 8
33 .Os
34 .Sh NAME
35 .Nm ifconfig
36 .Nd configure network interface parameters
37 .Sh SYNOPSIS
38 .Nm
39 .Op Fl L
40 .Op Fl k
41 .Op Fl m
42 .Ar interface
43 .Op Cm create
44 .Op Ar address_family
45 .Oo
46 .Ar address
47 .Op Ar dest_address
48 .Oc
49 .Op Ar parameters
50 .Nm
51 .Ar interface
52 .Cm destroy
53 .Nm
54 .Fl a
55 .Op Fl L
56 .Op Fl d
57 .Op Fl m
58 .Op Fl u
59 .Op Fl v
60 .Op Ar address_family
61 .Nm
62 .Fl l
63 .Op Fl d
64 .Op Fl u
65 .Op Ar address_family
66 .Nm
67 .Op Fl L
68 .Op Fl d
69 .Op Fl k
70 .Op Fl m
71 .Op Fl u
72 .Op Fl v
73 .Op Fl C
74 .Sh DESCRIPTION
75 The
76 .Nm
77 utility is used to assign an address
78 to a network interface and/or configure
79 network interface parameters.
80 The
81 .Nm
82 utility must be used at boot time to define the network address
83 of each interface present on a machine; it may also be used at
84 a later time to redefine an interface's address
85 or other operating parameters.
86 .Pp
87 The following options are available:
88 .Bl -tag -width indent
89 .It Ar address
90 For the
91 .Tn DARPA Ns -Internet
92 family,
93 the address is either a host name present in the host name data
94 base,
95 .Xr hosts 5 ,
96 or a
97 .Tn DARPA
98 Internet address expressed in the Internet standard
99 .Dq dot notation .
100 .Pp
101 It is also possible to use the CIDR notation (also known as the
102 slash notation) to include the netmask.
103 That is, one can specify an address like
104 .Li 192.168.0.1/16 .
105 .Pp
106 For
107 .Dq inet6
108 family, it is also possible to specify the prefix length using the slash
109 notation, like
110 .Li ::1/128 .
111 See the
112 .Cm prefixlen
113 parameter below for more information.
114 .\" For the Xerox Network Systems(tm) family,
115 .\" addresses are
116 .\" .Ar net:a.b.c.d.e.f ,
117 .\" where
118 .\" .Ar net
119 .\" is the assigned network number (in decimal),
120 .\" and each of the six bytes of the host number,
121 .\" .Ar a
122 .\" through
123 .\" .Ar f ,
124 .\" are specified in hexadecimal.
125 .\" The host number may be omitted on IEEE 802 protocol
126 .\" (Ethernet, FDDI, and Token Ring) interfaces,
127 .\" which use the hardware physical address,
128 .\" and on interfaces other than the first.
129 .\" For the
130 .\" .Tn ISO
131 .\" family, addresses are specified as a long hexadecimal string,
132 .\" as in the Xerox family.
133 .\" However, two consecutive dots imply a zero
134 .\" byte, and the dots are optional, if the user wishes to (carefully)
135 .\" count out long strings of digits in network byte order.
136 .Pp
137 The link-level
138 .Pq Dq link
139 address
140 is specified as a series of colon-separated hex digits.
141 This can be used to
142 e.g.\& set a new MAC address on an ethernet interface, though the
143 mechanism used is not ethernet-specific.
144 If the interface is already
145 up when this option is used, it will be briefly brought down and
146 then brought back up again in order to ensure that the receive
147 filter in the underlying ethernet hardware is properly reprogrammed.
148 .It Ar address_family
149 Specify the
150 address family
151 which affects interpretation of the remaining parameters.
152 Since an interface can receive transmissions in differing protocols
153 with different naming schemes, specifying the address family is recommended.
154 The address or protocol families currently
155 supported are
156 .Dq inet ,
157 .Dq inet6 ,
158 .Dq atalk ,
159 and
160 .Dq link .
161 The default is
162 .Dq inet .
163 .Dq ether
164 and
165 .Dq lladdr
166 are synonyms for
167 .Dq link .
168 .It Ar dest_address
169 Specify the address of the correspondent on the other end
170 of a point to point link.
171 .It Ar interface
172 This
173 parameter is a string of the form
174 .Dq name unit ,
175 for example,
176 .Dq Li ed0 .
177 .El
178 .Pp
179 The following parameters may be set with
180 .Nm :
181 .Bl -tag -width indent
182 .It Cm add
183 Another name for the
184 .Cm alias
185 parameter.
186 Introduced for compatibility
187 with
188 .Bsx .
189 .It Cm alias
190 Establish an additional network address for this interface.
191 This is sometimes useful when changing network numbers, and
192 one wishes to accept packets addressed to the old interface.
193 If the address is on the same subnet as the first network address
194 for this interface, a non-conflicting netmask must be given.
195 Usually
196 .Li 0xffffffff
197 is most appropriate.
198 .It Fl alias
199 Remove the network address specified.
200 This would be used if you incorrectly specified an alias, or it
201 was no longer needed.
202 If you have incorrectly set an NS address having the side effect
203 of specifying the host portion, removing all NS addresses will
204 allow you to respecify the host portion.
205 .It Cm anycast
206 (Inet6 only.)
207 Specify that the address configured is an anycast address.
208 Based on the current specification,
209 only routers may configure anycast addresses.
210 Anycast address will not be used as source address of any of outgoing
211 IPv6 packets.
212 .It Cm arp
213 Enable the use of the Address Resolution Protocol
214 .Pq Xr arp 4
215 in mapping
216 between network level addresses and link level addresses (default).
217 This is currently implemented for mapping between
218 .Tn DARPA
219 Internet
220 addresses and
221 .Tn IEEE
222 802 48-bit MAC addresses (Ethernet, FDDI, and Token Ring addresses).
223 .It Fl arp
224 Disable the use of the Address Resolution Protocol
225 .Pq Xr arp 4 .
226 .It Cm staticarp
227 If the Address Resolution Protocol is enabled,
228 the host will only reply to requests for its addresses,
229 and will never send any requests.
230 .It Fl staticarp
231 If the Address Resolution Protocol is enabled,
232 the host will perform normally,
233 sending out requests and listening for replies.
234 .It Cm broadcast
235 (Inet only.)
236 Specify the address to use to represent broadcasts to the
237 network.
238 The default broadcast address is the address with a host part of all 1's.
239 .It Cm debug
240 Enable driver dependent debugging code; usually, this turns on
241 extra console error logging.
242 .It Fl debug
243 Disable driver dependent debugging code.
244 .It Cm promisc
245 Put interface into permanently promiscuous mode.
246 .It Fl promisc
247 Disable permanently promiscuous mode.
248 .It Cm delete
249 Another name for the
250 .Fl alias
251 parameter.
252 .It Cm down
253 Mark an interface
254 .Dq down .
255 When an interface is marked
256 .Dq down ,
257 the system will not attempt to
258 transmit messages through that interface.
259 If possible, the interface will be reset to disable reception as well.
260 This action does not automatically disable routes using the interface.
261 .It Cm eui64
262 (Inet6 only.)
263 Fill interface index
264 (lowermost 64bit of an IPv6 address)
265 automatically.
266 .It Cm media Ar type
267 If the driver supports the media selection system, set the media type
268 of the interface to
269 .Ar type .
270 Some interfaces support the mutually exclusive use of one of several
271 different physical media connectors.
272 For example, a 10Mbit/s Ethernet
273 interface might support the use of either
274 .Tn AUI
275 or twisted pair connectors.
276 Setting the media type to
277 .Cm 10base5/AUI
278 would change the currently active connector to the AUI port.
279 Setting it to
280 .Cm 10baseT/UTP
281 would activate twisted pair.
282 Refer to the interfaces' driver
283 specific documentation or man page for a complete list of the
284 available types.
285 .It Cm mediaopt Ar opts
286 If the driver supports the media selection system, set the specified
287 media options on the interface.
288 The
289 .Ar opts
290 argument
291 is a comma delimited list of options to apply to the interface.
292 Refer to the interfaces' driver specific man page for a complete
293 list of available options.
294 .It Fl mediaopt Ar opts
295 If the driver supports the media selection system, disable the
296 specified media options on the interface.
297 .It Cm mode Ar mode
298 If the driver supports the media selection system, set the specified
299 operating mode on the interface to
300 .Ar mode .
301 For IEEE 802.11 wireless interfaces that support multiple operating modes
302 this directive is used to select between 802.11a
303 .Pq Cm 11a ,
304 802.11b
305 .Pq Cm 11b ,
306 and 802.11g
307 .Pq Cm 11g
308 operating modes.
309 .It Cm name Ar name
310 Set the interface name to
311 .Ar name .
312 .It Cm rss
313 If the driver supports receive side scaling,
314 enable receive side scaling on the interface.
315 .It Fl rss
316 If the driver supports receive side scaling,
317 disable receive side scaling on the interface.
318 .It Cm rxcsum , txcsum
319 If the driver supports user-configurable checksum offloading,
320 enable receive (or transmit) checksum offloading on the interface.
321 Some drivers may not be able to enable these flags independently
322 of each other, so setting one may also set the other.
323 The driver will offload as much checksum work as it can reliably
324 support, the exact level of offloading varies between drivers.
325 .It Fl rxcsum , txcsum
326 If the driver supports user-configurable checksum offloading,
327 disable receive (or transmit) checksum offloading on the interface.
328 These settings may not always be independent of each other.
329 .It Cm tso
330 If the driver supports TCP segmentation offloading,
331 enable TCP segmentation offloading on the interface.
332 .It Fl tso
333 If the driver supports TCP segmentation offloading,
334 disable TCP segmentation offloading on the interface.
335 .It Cm vlanmtu , vlanhwtag
336 If the driver offers user-configurable VLAN support, enable
337 reception of extended frames or tag processing in hardware,
338 respectively.
339 Note that this must be issued on a physical interface associated with
340 .Xr vlan 4 ,
341 not on a
342 .Xr vlan 4
343 interface itself.
344 .It Fl vlanmtu , vlanhwtag
345 If the driver offers user-configurable VLAN support, disable
346 reception of extended frames or tag processing in hardware,
347 respectively.
348 .It Cm pollcpu Ar cpu
349 Deprecated, use polling or npolling instead.
350 .It Cm polling , npolling
351 Turn on
352 .Xr polling 4
353 feature and disable interrupts on the interface, if the driver supports
354 this mode.
355 .It Fl polling , npolling
356 Turn off
357 .Xr polling 4
358 feature and enable interrupt mode on the interface.
359 .It Cm create
360 Create the specified network pseudo-device.
361 If the interface is given without a unit number, try to create a new
362 device with an arbitrary unit number.
363 If creation of an arbitrary device is successful, the new device name is
364 printed to standard output unless the interface is renamed or destroyed
365 in the same
366 .Nm
367 invocation.
368 .It Cm destroy
369 Destroy the specified network pseudo-device.
370 .It Cm plumb
371 Another name for the
372 .Cm create
373 parameter.
374 Included for
375 .Tn Solaris
376 compatibility.
377 .It Cm unplumb
378 Another name for the
379 .Cm destroy
380 parameter.
381 Included for
382 .Tn Solaris
383 compatibility.
384 .It Cm metric Ar n
385 Set the routing metric of the interface to
386 .Ar n ,
387 default 0.
388 The routing metric is used by the routing protocol
389 .Pq Xr routed 8 .
390 Higher metrics have the effect of making a route
391 less favorable; metrics are counted as additional hops
392 to the destination network or host.
393 .It Cm mtu Ar n
394 Set the maximum transmission unit of the interface to
395 .Ar n ,
396 default is interface specific.
397 The MTU is used to limit the size of packets that are transmitted on an
398 interface.
399 Not all interfaces support setting the MTU, and some interfaces have
400 range restrictions.
401 .It Cm tsolen Ar n
402 Set the maximum amount of data
403 that TCP segmentation offloading is allowed to aggregate to
404 .Ar n ,
405 the default value is interface specific.
406 This setting only takes effect on interfaces
407 that support TCP segmentation offloading.
408 .It Cm netmask Ar mask
409 .\" (Inet and ISO.)
410 (Inet only.)
411 Specify how much of the address to reserve for subdividing
412 networks into sub-networks.
413 The mask includes the network part of the local address
414 and the subnet part, which is taken from the host field of the address.
415 The mask can be specified as a single hexadecimal number
416 with a leading
417 .Ql 0x ,
418 with a dot-notation Internet address,
419 or with a pseudo-network name listed in the network table
420 .Xr networks 5 .
421 The mask contains 1's for the bit positions in the 32-bit address
422 which are to be used for the network and subnet parts,
423 and 0's for the host part.
424 The mask should contain at least the standard network portion,
425 and the subnet field should be contiguous with the network
426 portion.
427 .Pp
428 The netmask can also be specified in CIDR notation after the address.
429 See the
430 .Ar address
431 option above for more information.
432 .It Cm autoconf
433 (Inet6 only.)
434 Enable autoconfiguration.
435 .It Fl autoconf
436 Disable autoconfiguration.
437 .It Cm pltime Ar n
438 (Inet6 only.)
439 Set preferred lifetime for the address.
440 .It Cm vltime Ar n
441 (Inet6 only.)
442 Set valid lifetime for the address.
443 .It Cm prefixlen Ar len
444 (Inet6 only.)
445 Specify that
446 .Ar len
447 bits are reserved for subdividing networks into sub-networks.
448 The
449 .Ar len
450 must be integer, and for syntactical reason it must be between 0 to 128.
451 It is almost always 64 under the current IPv6 assignment rule.
452 If the parameter is omitted, 64 is used.
453 .Pp
454 The prefix can also be specified using the slash notation after the address.
455 See the
456 .Ar address
457 option above for more information.
458 .It Cm deprecated
459 (Inet6 only.)
460 Set the IPv6 deprecated address bit.
461 .It Fl deprecated
462 (Inet6 only.)
463 Clear the IPv6 deprecated address bit.
464 .It Cm tentative
465 (Inet6 only.)
466 Set the IPv6 tentative address bit.
467 .It Fl tentative
468 (Inet6 only.)
469 Clear the IPv6 tentative address bit.
470 .\" see
471 .\" Xr eon 5 .
472 .\" .It Cm nsellength Ar n
473 .\" .Pf ( Tn ISO
474 .\" only)
475 .\" This specifies a trailing number of bytes for a received
476 .\" .Tn NSAP
477 .\" used for local identification, the remaining leading part of which is
478 .\" taken to be the
479 .\" .Tn NET
480 .\" (Network Entity Title).
481 .\" The default value is 1, which is conformant to US
482 .\" .Tn GOSIP .
483 .\" When an ISO address is set in an ifconfig command,
484 .\" it is really the
485 .\" .Tn NSAP
486 .\" which is being specified.
487 .\" For example, in
488 .\" .Tn US GOSIP ,
489 .\" 20 hex digits should be
490 .\" specified in the
491 .\" .Tn ISO NSAP
492 .\" to be assigned to the interface.
493 .\" There is some evidence that a number different from 1 may be useful
494 .\" for
495 .\" .Tn AFI
496 .\" 37 type addresses.
497 .It Cm range Ar netrange
498 Under appletalk, set the interface to respond to a
499 .Ar netrange
500 of the form
501 .Ar startnet Ns - Ns Ar endnet .
502 Appletalk uses this scheme instead of
503 netmasks though
504 .Dx
505 implements it internally as a set of netmasks.
506 .It Cm remove
507 Another name for the
508 .Fl alias
509 parameter.
510 Introduced for compatibility
511 with
512 .Bsx .
513 .It Cm phase
514 The argument following this specifies the version (phase) of the
515 Appletalk network attached to the interface.
516 Values of 1 or 2 are permitted.
517 .Sm off
518 .It Cm link Op Cm 0 No - Cm 2
519 .Sm on
520 Enable special processing of the link level of the interface.
521 These three options are interface specific in actual effect, however,
522 they are in general used to select special modes of operation.
523 An example
524 of this is to enable SLIP compression, or to select the connector type
525 for some Ethernet cards.
526 Refer to the man page for the specific driver
527 for more information.
528 .Sm off
529 .It Fl link Op Cm 0 No - Cm 2
530 .Sm on
531 Disable special processing at the link level with the specified interface.
532 .It Cm compress
533 Another name for the
534 .Cm link0
535 parameter.
536 .It Cm normal
537 Another name for the
538 .Fl link0
539 parameter.
540 .It Cm noicmp
541 Another name for the
542 .Cm link1
543 parameter.
544 .It Cm monitor
545 Put the interface in monitor mode.
546 No packets are transmitted, and received packets are discarded after
547 .Xr bpf 4
548 processing.
549 .It Fl monitor
550 Take the interface out of monitor mode.
551 .It Cm up
552 Mark an interface
553 .Dq up .
554 This may be used to enable an interface after an
555 .Dq Nm Cm down .
556 It happens automatically when setting the first address on an interface.
557 If the interface was reset when previously marked down,
558 the hardware will be re-initialized.
559 .El
560 .Pp
561 The following parameters are specific to cloning
562 IEEE 802.11 wireless interfaces with the
563 .Cm create
564 request:
565 .Bl -tag -width indent
566 .It Cm wlandev Ar device
567 Use
568 .Ar device
569 as the parent for the cloned device.
570 .It Cm wlanmode Ar mode
571 Specify the operating mode for this cloned device.
572 .Ar mode
573 is one of
574 .Cm sta ,
575 .Cm ahdemo
576 (or
577 .Cm adhoc-demo ),
578 .Cm ibss ,
579 (or
580 .Cm adhoc ),
581 .Cm ap ,
582 (or
583 .Cm hostap ),
584 .Cm wds ,
585 .Cm tdma ,
586 .Cm mesh ,
587 and
588 .Cm monitor .
589 The operating mode of a cloned interface cannot be changed.
590 The
591 .Cm tdma
592 mode is actually implemented as an
593 .Cm adhoc-demo
594 interface with special properties.
595 .It Cm wlanbssid Ar bssid
596 The 802.11 mac address to use for the bssid.
597 This must be specified at create time for a legacy
598 .Cm wds
599 device.
600 .It Cm wlanaddr Ar address
601 The local mac address.
602 If this is not specified then a mac address will automatically be assigned
603 to the cloned device.
604 Typically this address is the same as the address of the parent device
605 but if the
606 .Cm bssid
607 parameter is specified then the driver will craft a unique address for
608 the device (if supported).
609 .It Cm wdslegacy
610 Mark a
611 .Cm wds
612 device as operating in ``legacy mode''.
613 Legacy
614 .Cm wds
615 devices have a fixed peer relationship and do not, for example, roam
616 if their peer stops communicating.
617 For completeness a Dynamic WDS (DWDS) interface may marked as
618 .Fl wdslegacy .
619 .It Cm bssid
620 Request a unique local mac address for the cloned device.
621 This is only possible if the device supports multiple mac addresses.
622 To force use of the parent's mac address use
623 .Fl bssid .
624 .It Cm beacons
625 Mark the cloned interface as depending on hardware support to
626 track received beacons.
627 To have beacons tracked in software use
628 .Fl beacons .
629 For
630 .Cm hostap
631 mode
632 .Fl beacons
633 can also be used to indicate no beacons should
634 be transmitted; this can be useful when creating a WDS configuration but
635 .Cm wds
636 interfaces can only be created as companions to an access point.
637 .El
638 .Pp
639 The following parameters are specific to IEEE 802.11 wireless interfaces
640 cloned with a
641 .Cm create
642 operation:
643 .Bl -tag -width indent
644 .It Cm ampdu
645 Enable sending and receiving AMPDU frames when using 802.11n (default).
646 The 802.11n specification states a compliant station must be capable
647 of receiving AMPDU frames but transmission is optional.
648 Use
649 .Fl ampdu
650 to disable all use of AMPDU with 802.11n.
651 For testing and/or to work around interoperability problems one can use
652 .Cm ampdutx
653 and
654 .Cm ampdurx
655 to control use of AMPDU in one direction.
656 .It Cm ampdudensity Ar density
657 Set the AMPDU density parameter used when operating with 802.11n.
658 This parameter controls the inter-packet gap for AMPDU frames.
659 The sending device normally controls this setting but a receiving station
660 may request wider gaps.
661 Legal values for
662 .Ar density
663 are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds).
664 A value of
665 .Cm -
666 is treated the same as 0.
667 .It Cm ampdulimit Ar limit
668 Set the limit on packet size for receiving AMPDU frames when operating
669 with 802.11n.
670 Legal values for
671 .Ar limit
672 are 8192, 16384, 32768, and 65536 but one can also specify
673 just the unique prefix: 8, 16, 32, 64.
674 Note the sender may limit the size of AMPDU frames to be less
675 than the maximum specified by the receiving station.
676 .It Cm amsdu
677 Enable sending and receiving AMSDU frames when using 802.11n.
678 By default AMSDU is received but not transmitted.
679 Use
680 .Fl amsdu
681 to disable all use of AMSDU with 802.11n.
682 For testing and/or to work around interoperability problems one can use
683 .Cm amsdutx
684 and
685 .Cm amsdurx
686 to control use of AMSDU in one direction.
687 .It Cm amsdulimit Ar limit
688 Set the limit on packet size for sending and receiving AMSDU frames
689 when operating with 802.11n.
690 Legal values for
691 .Ar limit
692 are 7935 and 3839 (bytes).
693 Note the sender may limit the size of AMSDU frames to be less
694 than the maximum specified by the receiving station.
695 Note also that devices are not required to support the 7935 limit,
696 only 3839 is required by the specification and the larger value
697 may require more memory to be dedicated to support functionality
698 that is rarely used.
699 .It Cm apbridge
700 When operating as an access point, pass packets between
701 wireless clients directly (default).
702 To instead let them pass up through the
703 system and be forwarded using some other mechanism, use
704 .Fl apbridge .
705 Disabling the internal bridging
706 is useful when traffic is to be processed with
707 packet filtering.
708 .It Cm authmode Ar mode
709 Set the desired authentication mode in infrastructure mode.
710 Not all adapters support all modes.
711 The set of
712 valid modes is
713 .Cm none , open , shared
714 (shared key),
715 .Cm 8021x
716 (IEEE 802.1x),
717 and
718 .Cm wpa
719 (IEEE WPA/WPA2/802.11i).
720 The
721 .Cm 8021x
722 and
723 .Cm wpa
724 modes are only useful when using an authentication service
725 (a supplicant for client operation or an authenticator when
726 operating as an access point).
727 Modes are case insensitive.
728 .It Cm bgscan
729 Enable background scanning when operating as a station.
730 Background scanning is a technique whereby a station associated to
731 an access point will temporarily leave the channel to scan for
732 neighboring stations.
733 This allows a station to maintain a cache of nearby access points
734 so that roaming between access points can be done without
735 a lengthy scan operation.
736 Background scanning is done only when a station is not busy and
737 any outbound traffic will cancel a scan operation.
738 Background scanning should never cause packets to be lost though
739 there may be some small latency if outbound traffic interrupts a
740 scan operation.
741 By default background scanning is enabled if the device is capable.
742 To disable background scanning, use
743 .Fl bgscan .
744 Background scanning is controlled by the
745 .Cm bgscanidle
746 and
747 .Cm bgscanintvl
748 parameters.
749 Background scanning must be enabled for roaming; this is an artifact
750 of the current implementation and may not be required in the future.
751 .It Cm bgscanidle Ar idletime
752 Set the minimum time a station must be idle (not transmitting or
753 receiving frames) before a background scan is initiated.
754 The
755 .Ar idletime
756 parameter is specified in milliseconds.
757 By default a station must be idle at least 250 milliseconds before
758 a background scan is initiated.
759 The idle time may not be set to less than 100 milliseconds.
760 .It Cm bgscanintvl Ar interval
761 Set the interval at which background scanning is attempted.
762 The
763 .Ar interval
764 parameter is specified in seconds.
765 By default a background scan is considered every 300 seconds (5 minutes).
766 The
767 .Ar interval
768 may not be set to less than 15 seconds.
769 .It Cm bintval Ar interval
770 Set the interval at which beacon frames are sent when operating in
771 ad-hoc or ap mode.
772 The
773 .Ar interval
774 parameter is specified in TU's (1024 usecs).
775 By default beacon frames are transmitted every 100 TU's.
776 .It Cm bmissthreshold Ar count
777 Set the number of consecutive missed beacons at which the station
778 will attempt to roam (i.e., search for a new access point).
779 The
780 .Ar count
781 parameter must be in the range 1 to 255; though the
782 upper bound may be reduced according to device capabilities.
783 The default threshold is 7 consecutive missed beacons; but
784 this may be overridden by the device driver.
785 Another name for the
786 .Cm bmissthreshold
787 parameter is
788 .Cm bmiss .
789 .It Cm bssid Ar address
790 Specify the MAC address of the access point to use when operating
791 as a station in a BSS network.
792 This overrides any automatic selection done by the system.
793 To disable a previously selected access point, supply
794 .Cm any , none ,
795 or
796 .Cm -
797 for the address.
798 This option is useful when more than one access point uses the same SSID.
799 Another name for the
800 .Cm bssid
801 parameter is
802 .Cm ap .
803 .It Cm burst
804 Enable packet bursting.
805 Packet bursting is a transmission technique whereby the wireless
806 medium is acquired once to send multiple frames and the interframe
807 spacing is reduced.
808 This technique can significantly increase throughput by reducing
809 transmission overhead.
810 Packet bursting is supported by the 802.11e QoS specification
811 and some devices that do not support QoS may still be capable.
812 By default packet bursting is enabled if a device is capable
813 of doing it.
814 To disable packet bursting, use
815 .Fl burst .
816 .It Cm chanlist Ar channels
817 Set the desired channels to use when scanning for access
818 points, neighbors in an IBSS network, or looking for unoccupied
819 channels when operating as an access point.
820 The set of channels is specified as a comma-separated list with
821 each element in the list representing either a single channel number or a range
822 of the form
823 .Dq Li a-b .
824 Channel numbers must be in the range 1 to 255 and be permissible
825 according to the operating characteristics of the device.
826 .It Cm channel Ar number
827 Set a single desired channel.
828 Channels range from 1 to 255, but the exact selection available
829 depends on the region your adaptor was manufactured for.
830 Setting
831 the channel to
832 .Li any ,
833 or
834 .Cm -
835 will clear any desired channel and, if the device is marked up,
836 force a scan for a channel to operate on.
837 Alternatively the frequency, in megahertz, may be specified
838 instead of the channel number.
839 .Pp
840 When there are several ways to use a channel the channel
841 number/frequency may be appended with attributes to clarify.
842 For example, if a device is capable of operating on channel 6
843 with 802.11n and 802.11g then one can specify that g-only use
844 should be used by specifying ``6:g''.
845 Similarly the channel width can be specified by appending it
846 with ``/''; e.g. ``6/40'' specifies a 40MHz wide channel,
847 These attributes can be combined as in: ``6:ht/40''.
848 The full set of flags specified following a `:'' are:
849 .Cm a
850 (802.11a),
851 .Cm b
852 (802.11b),
853 .Cm d
854 (Atheros Dynamic Turbo mode),
855 .Cm g
856 (802.11g),
857 .Cm h
858 or
859 .Cm n
860 (802.11n aka HT),
861 .Cm s
862 (Atheros Static Turbo mode),
863 and
864 .Cm t
865 (Atheros Dynamic Turbo mode, or appended to ``st'' and ``dt'').
866 The full set of channel widths following a '/' are:
867 .Cm 5
868 (5MHz aka quarter-rate channel),
869 .Cm 10
870 (10MHz aka half-rate channel),
871 .Cm 20
872 (20MHz mostly for use in specifying ht20),
873 and
874 .Cm 40
875 (40MHz mostly for use in specifying ht40),
876 In addition,
877 a 40MHz HT channel specification may include the location
878 of the extension channel by appending ``+'' or ``-'' for above and below,
879 respectively; e.g. ``2437:ht/40+'' specifies 40MHz wide HT operation
880 with the center channel at frequency 2437 and the extension channel above.
881 .It Cm country Ar name
882 Set the country code to use in calculating the regulatory constraints
883 for operation.
884 In particular the set of available channels, how the wireless device
885 will operation on the channels, and the maximum transmit power that
886 can be used on a channel are defined by this setting.
887 Country/Region codes are specified as a 2-character abbreviation
888 defined by ISO 3166 or using a longer, but possibly ambiguous, spelling;
889 e.g. "ES" and "Spain".
890 The set of country codes are taken from /etc/regdomain.xml and can also
891 be viewed with the ``list countries'' request.
892 Note that not all devices support changing the country code from a default
893 setting; typically stored in EEPROM.
894 See also
895 .Cm regdomain ,
896 .Cm indoor ,
897 .Cm outdoor ,
898 and
899 .Cm anywhere .
900 .It Cm dfs
901 Enable Dynamic Frequency Selection (DFS) as specified in 802.11h.
902 DFS embodies several facilities including detection of overlapping
903 radar signals, dynamic transmit power control, and channel selection
904 according to a least-congested criteria.
905 DFS support is mandatory for some 5Ghz frequencies in certain
906 locales (e.g. ETSI).
907 By default DFS is enabled according to the regulatory definitions
908 specified in /etc/regdomain.xml and the current country code, regdomain,
909 and channel.
910 Note the underlying device (and driver) must support radar detection
911 for full DFS support to work.
912 To be fully compliant with the local regulatory agency frequencies that
913 require DFS should not be used unless it is fully supported.
914 Use
915 .Fl dfs
916 to disable this functionality for testing.
917 .It Cm dotd
918 Enable support for the 802.11d specification (default).
919 When this support is enabled in station mode, beacon frames that advertise
920 a country code different than the currently configured country code will
921 cause an event to be dispatched to user applications.
922 This event can be used by the station to adopt that country code and
923 operate according to the associated regulatory constraints.
924 When operating as an access point with 802.11d enabled the beacon and
925 probe response frames transmitted will advertise the current regulatory
926 domain settings.
927 To disable 802.11d use
928 .Fl dotd .
929 .It Cm doth
930 Enable 802.11h support including spectrum management.
931 When 802.11h is enabled beacon and probe response frames will have
932 the SpectrumMgt bit set in the capabilities field and
933 country and power constraint information elements will be present.
934 802.11h support also includes handling Channel Switch Announcements (CSA)
935 which are a mechanism to coordinate channel changes by an access point.
936 By default 802.11h is enabled if the device is capable.
937 To disable 802.11h use
938 .Fl doth .
939 .It Cm deftxkey Ar index
940 Set the default key to use for transmission.
941 Typically this is only set when using WEP encryption.
942 Note that you must set a default transmit key
943 for the system to know which key to use in encrypting outbound traffic.
944 The
945 .Cm weptxkey
946 is an alias for this request; it is provided for backwards compatibility.
947 .It Cm dtimperiod Ar period
948 Set the
949 DTIM
950 period for transmitting buffered multicast data frames when
951 operating in ap mode.
952 The
953 .Ar period
954 specifies the number of beacon intervals between DTIM
955 and must be in the range 1 to 15.
956 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
957 .It Cm dturbo
958 Enable the use of Atheros Dynamic Turbo mode when communicating with
959 another Dynamic Turbo-capable station.
960 Dynamic Turbo mode is an Atheros-specific mechanism by which
961 stations switch between normal 802.11 operation and a ``boosted''
962 mode in which a 40MHz wide channel is used for communication.
963 Stations using Dynamic Turbo mode operate boosted only when the
964 channel is free of non-dturbo stations; when a non-dturbo station
965 is identified on the channel all stations will automatically drop
966 back to normal operation.
967 By default, Dynamic Turbo mode is not enabled, even if the device is capable.
968 Note that turbo mode (dynamic or static) is only allowed on some
969 channels depending on the regulatory constraints; use the
970 .Cm list chan
971 command to identify the channels where turbo mode may be used.
972 To disable Dynamic Turbo mode use
973 .Fl dturbo .
974 .It Cm dwds
975 Enable Dynamic WDS (DWDS) support.
976 DWDS is a facility by which 4-address traffic can be carried between
977 stations operating in infrastructure mode.
978 A station first associates to an access point and authenticates using
979 normal procedures (e.g. WPA).
980 Then 4-address frames are passed to carry traffic for stations
981 operating on either side of the wireless link.
982 DWDS extends the normal WDS mechanism by leveraging existing security
983 protocols and eliminating static binding.
984 .Pp
985 When DWDS is enabled on an access point 4-address frames received from
986 an authorized station will generate a ``DWDS discovery'' event to user
987 applications.
988 This event should be used to create a WDS interface that is bound
989 to the remote station (and usually plumbed into a bridge).
990 Once the WDS interface is up and running 4-address traffic then logically
991 flows through that interface.
992 .Pp
993 When DWDS is enabled on a station, traffic with a destination address
994 different from the peer station are encapsulated in a 4-address frame
995 and transmitted to the peer.
996 All 4-address traffic uses the security information of the stations
997 (e.g. cryptographic keys).
998 A station is associated using 802.11n facilities may transport
999 4-address traffic using these same mechanisms; this depends on available
1000 resources and capabilities of the device.
1001 The DWDS implementation guards against layer 2 routing loops of
1002 multicast traffic.
1003 .It Cm ff
1004 Enable the use of Atheros Fast Frames when communicating with
1005 another Fast Frames-capable station.
1006 Fast Frames are an encapsulation technique by which two 802.3
1007 frames are transmitted in a single 802.11 frame.
1008 This can noticeably improve throughput but requires that the
1009 receiving station understand how to decapsulate the frame.
1010 Fast frame use is negotiated using the Atheros 802.11 vendor-specific
1011 protocol extension so enabling use is safe when communicating with
1012 non-Atheros devices.
1013 By default, use of fast frames is enabled if the device is capable.
1014 To explicitly disable fast frames, use
1015 .Fl ff .
1016 .It Cm fragthreshold Ar length
1017 Set the threshold for which transmitted frames are broken into fragments.
1018 The
1019 .Ar length
1020 argument is the frame size in bytes and must be in the range 256 to 2346.
1021 Setting
1022 .Ar length
1023 to
1024 .Li 2346 ,
1025 .Cm any ,
1026 or
1027 .Cm -
1028 disables transmit fragmentation.
1029 Not all adapters honor the fragmentation threshold.
1030 .It Cm hidessid
1031 When operating as an access point, do not broadcast the SSID
1032 in beacon frames or respond to probe request frames unless
1033 they are directed to the ap (i.e., they include the ap's SSID).
1034 By default, the SSID is included in beacon frames and
1035 undirected probe request frames are answered.
1036 To re-enable the broadcast of the SSID etc., use
1037 .Fl hidessid .
1038 .It Cm ht
1039 Enable use of High Throughput (HT) when using 802.11n (default).
1040 The 802.11n specification includes mechanisms for operation
1041 on 20MHz and 40MHz wide channels using different signalling mechanisms
1042 than specified in 802.11b, 802.11g, and 802.11a.
1043 Stations negotiate use of these facilities, termed HT20 and HT40,
1044 when they associate.
1045 To disable all use of 802.11n use
1046 .Fl ht .
1047 To disable use of HT20 (e.g. to force only HT40 use) use
1048 .Fl ht20 .
1049 To disable use of HT40 use
1050 .Fl ht40 .
1051 .Pp
1052 HT configuration is used to ``auto promote'' operation
1053 when several choices are available.
1054 For example, if a station associates to an 11n-capable access point
1055 it controls whether the station uses legacy operation, HT20, or HT40.
1056 When an 11n-capable device is setup as an access point and
1057 Auto Channel Selection is used to locate a channel to operate on,
1058 HT configuration controls whether legacy, HT20, or HT40 operation is setup
1059 on the selected channel.
1060 If a fixed channel is specified for a station then HT configuration can
1061 be given as part of the channel specification; e.g. 6:ht/20 to setup
1062 HT20 operation on channel 6.
1063 .It Cm htcompat
1064 Enable use of compatibility support for pre-802.11n devices (default).
1065 The 802.11n protocol specification went through several incompatible iterations.
1066 Some vendors implemented 11n support to older specifications that
1067 will not interoperate with a purely 11n-compliant station.
1068 In particular the information elements included in management frames
1069 for old devices are different.
1070 When compatibility support is enabled both standard and compatible data
1071 will be provided.
1072 Stations that associate using the compatibility mechanisms are flagged
1073 in ``list sta''.
1074 To disable compatibility support use
1075 .Fl htcompat .
1076 .It Cm htprotmode Ar technique
1077 For interfaces operating in 802.11n, use the specified
1078 .Ar technique
1079 for protecting HT frames in a mixed legacy/HT network.
1080 The set of valid techniques is
1081 .Cm off ,
1082 and
1083 .Cm rts
1084 (RTS/CTS, default).
1085 Technique names are case insensitive.
1086 .It Cm inact
1087 Enable inactivity processing for stations associated to an
1088 access point (default).
1089 When operating as an access point the 802.11 layer monitors
1090 the activity of each associated station.
1091 When a station is inactive for 5 minutes it will send several
1092 ``probe frames'' to see if the station is still present.
1093 If no response is received then the station is deauthenticated.
1094 Applications that prefer to handle this work can disable this
1095 facility by using
1096 .Fl inact .
1097 .It Cm indoor
1098 Set the location to use in calculating regulatory constraints.
1099 The location is also advertised in beacon and probe response frames
1100 when 802.11d is enabled with
1101 .Cm dotd .
1102 See also
1103 .Cm outdoor ,
1104 .Cm anywhere ,
1105 .Cm country ,
1106 and
1107 .Cm regdomain .
1108 .It Cm list active
1109 Display the list of channels available for use taking into account
1110 any restrictions set with the
1111 .Cm chanlist
1112 directive.
1113 See the description of
1114 .Cm list chan
1115 for more information.
1116 .It Cm list caps
1117 Display the adaptor's capabilities, including the operating
1118 modes supported.
1119 .It Cm list chan
1120 Display the list of channels available for use.
1121 Channels are shown with their IEEE channel number, equivalent
1122 frequency, and usage modes.
1123 Channels identified as
1124 .Ql 11g
1125 are also usable in
1126 .Ql 11b
1127 mode.
1128 Channels identified as
1129 .Ql 11a Turbo
1130 may be used only for Atheros' Static Turbo mode
1131 (specified with
1132 .Cm mediaopt turbo ) .
1133 Channels marked with a
1134 .Ql *
1135 have a regulatory constraint that they be passively scanned.
1136 This means a station is not permitted to transmit on the channel until
1137 it identifies the channel is being used for 802.11 communication;
1138 typically by hearing a beacon frame from an access point operating
1139 on the channel.
1140 .Cm list freq
1141 is another way of requesting this information.
1142 By default a compacted list of channels is displayed; if the
1143 .Fl v
1144 option is specified then all channels are shown.
1145 .It Cm list countries
1146 Display the set of country codes and regulatory domains that can be
1147 used in regulatory configuration.
1148 .It Cm list mac
1149 Display the current MAC Access Control List state.
1150 Each address is prefixed with a character that indicates the
1151 current policy applied to it:
1152 .Ql +
1153 indicates the address is allowed access,
1154 .Ql -
1155 indicates the address is denied access,
1156 .Ql *
1157 indicates the address is present but the current policy open
1158 (so the ACL is not consulted).
1159 .It Cm list mesh
1160 Displays the mesh routing table, used for forwarding packets on a mesh
1161 network.
1162 .It Cm list regdomain
1163 Display the current regulatory settings including the available channels
1164 and transmit power caps.
1165 .It Cm list roam
1166 Display the parameters that govern roaming operation.
1167 .It Cm list txparam
1168 Display the parameters that govern transmit operation.
1169 .It Cm list txpower
1170 Display the transmit power caps for each channel.
1171 .It Cm list scan
1172 Display the access points and/or ad-hoc neighbors
1173 located in the vicinity.
1174 This information may be updated automatically by the adapter
1175 with a
1176 .Cm scan
1177 request or through background scanning.
1178 Depending on the capabilities of the stations the following
1179 flags can be included in the output:
1180 .Bl -tag -width 3n
1181 .It Li A
1182 Authorized.
1183 Indicates that the station is permitted to send/receive data frames.
1184 .It Li E
1185 Extended Rate Phy (ERP).
1186 Indicates that the station is operating in an 802.11g network
1187 using extended transmit rates.
1188 .It Li H
1189 High Throughput (HT).
1190 Indicates that the station is using HT transmit rates.
1191 If a `+' follows immediately after then the station associated
1192 using deprecated mechanisms supported only when
1193 .Cm htcompat
1194 is enabled.
1195 .It Li P
1196 Power Save.
1197 Indicates that the station is operating in power save mode.
1198 .It Li Q
1199 Quality of Service (QoS).
1200 Indicates that the station is using QoS encapsulation for
1201 data frame.
1202 QoS encapsulation is enabled only when WME mode is enabled.
1203 .It Li T
1204 Transitional Security Network (TSN).
1205 Indicates that the station associated using TSN; see also
1206 .Cm tsn
1207 below.
1208 .It Li W
1209 Wi-Fi Protected Setup (WPS).
1210 Indicates that the station associated using WPS.
1211 .El
1212 .Pp
1213 By default interesting information elements captured from the neighboring
1214 stations are displayed at the end of each row.
1215 Possible elements include:
1216 .Cm WME
1217 (station supports WME),
1218 .Cm WPA
1219 (station supports WPA),
1220 .Cm WPS
1221 (station supports WPS),
1222 .Cm RSN
1223 (station supports 802.11i/RSN),
1224 .Cm HTCAP
1225 (station supports 802.11n/HT communication),
1226 .Cm ATH
1227 (station supports Atheros protocol extensions),
1228 .Cm VEN
1229 (station supports unknown vendor-specific extensions).
1230 If the
1231 .Fl v
1232 flag is used all the information elements and their
1233 contents will be shown.
1234 Specifying the
1235 .Fl v
1236 flag also enables display of long SSIDs.
1237 The
1238 .Cm list ap
1239 command is another way of requesting this information.
1240 .It Cm list sta
1241 When operating as an access point display the stations that are
1242 currently associated.
1243 When operating in ad-hoc mode display stations identified as
1244 neighbors in the IBSS.
1245 When operating in mesh mode display stations identified as
1246 neighbors in the MBSS.
1247 When operating in station mode display the access point.
1248 Capabilities advertised by the stations are described under
1249 the
1250 .Cm scan
1251 request.
1252 Depending on the capabilities of the stations the following
1253 flags can be included in the output:
1254 .Bl -tag -width 3n
1255 .It Li A
1256 Authorized.
1257 Indicates that the station is permitted to send/receive data frames.
1258 .It Li E
1259 Extended Rate Phy (ERP).
1260 Indicates that the station is operating in an 802.11g network
1261 using extended transmit rates.
1262 .It Li H
1263 High Throughput (HT).
1264 Indicates that the station is using HT transmit rates.
1265 If a `+' follows immediately after then the station associated
1266 using deprecated mechanisms supported only when
1267 .Cm htcompat
1268 is enabled.
1269 .It Li P
1270 Power Save.
1271 Indicates that the station is operating in power save mode.
1272 .It Li Q
1273 Quality of Service (QoS).
1274 Indicates that the station is using QoS encapsulation for
1275 data frame.
1276 QoS encapsulation is enabled only when WME mode is enabled.
1277 .It Li T
1278 Transitional Security Network (TSN).
1279 Indicates that the station associated using TSN; see also
1280 .Cm tsn
1281 below.
1282 .It Li W
1283 Wi-Fi Protected Setup (WPS).
1284 Indicates that the station associated using WPS.
1285 .El
1286 .Pp
1287 By default information elements received from associated stations
1288 are displayed in a short form; the
1289 .Fl v
1290 flag causes this information to be displayed symbolically.
1291 .It Cm list wme
1292 Display the current channel parameters to use when operating in WME mode.
1293 If the
1294 .Fl v
1295 option is specified then both channel and BSS parameters are displayed
1296 for each AC (first channel, then BSS).
1297 When WME mode is enabled for an adaptor this information will be
1298 displayed with the regular status; this command is mostly useful
1299 for examining parameters when WME mode is disabled.
1300 See the description of the
1301 .Cm wme
1302 directive for information on the various parameters.
1303 .It Cm lscan
1304 A variant of
1305 .Cm scan
1306 (see below) that displays long SSIDs.
1307 .It Cm maxretry Ar count
1308 Set the maximum number of tries to use in sending unicast frames.
1309 The default setting is 6 but drivers may override this with a value
1310 they choose.
1311 .It Cm mcastrate Ar rate
1312 Set the rate for transmitting multicast/broadcast frames.
1313 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
1314 This rate should be valid for the current operating conditions;
1315 if an invalid rate is specified drivers are free to chose an
1316 appropriate rate.
1317 .It Cm mgtrate Ar rate
1318 Set the rate for transmitting management and/or control frames.
1319 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
1320 .It Cm outdoor
1321 Set the location to use in calculating regulatory constraints.
1322 The location is also advertised in beacon and probe response frames
1323 when 802.11d is enabled with
1324 .Cm dotd .
1325 See also
1326 .Cm anywhere ,
1327 .Cm country ,
1328 .Cm indoor ,
1329 and
1330 .Cm regdomain .
1331 .It Cm powersave
1332 Enable powersave operation.
1333 When operating as a client, the station will conserve power by
1334 periodically turning off the radio and listening for
1335 messages from the access point telling it there are packets waiting.
1336 The station must then retrieve the packets.
1337 Not all devices support power save operation as a client.
1338 The 802.11 specification requires that all access points support
1339 power save but some drivers do not.
1340 Use
1341 .Fl powersave
1342 to disable powersave operation when operating as a client.
1343 .It Cm powersavemode Ar mode
1344 Set powersave mode.
1345 The set of valid modes is
1346 .Cm off
1347 (same as
1348 .Fl powersave ) ,
1349 .Cm on
1350 (same as
1351 .Cm powersave ) ,
1352 and
1353 .Cm cam
1354 (same as
1355 .Cm powersave ) .
1356 .It Cm powersavesleep Ar sleep
1357 Set the desired max powersave sleep time in TU's (1024 usecs).
1358 By default the max powersave sleep time is 100 TU's.
1359 .It Cm protmode Ar technique
1360 For interfaces operating in 802.11g, use the specified
1361 .Ar technique
1362 for protecting OFDM frames in a mixed 11b/11g network.
1363 The set of valid techniques is
1364 .Cm off , cts
1365 (CTS to self),
1366 and
1367 .Cm rtscts
1368 (RTS/CTS).
1369 Technique names are case insensitive.
1370 Not all devices support
1371 .Cm cts
1372 as a protection technique.
1373 .It Cm pureg
1374 When operating as an access point in 802.11g mode allow only
1375 11g-capable stations to associate (11b-only stations are not
1376 permitted to associate).
1377 To allow both 11g and 11b-only stations to associate, use
1378 .Fl pureg .
1379 .It Cm puren
1380 When operating as an access point in 802.11n mode allow only
1381 HT-capable stations to associate (legacy stations are not
1382 permitted to associate).
1383 To allow both HT and legacy stations to associate, use
1384 .Fl puren .
1385 .It Cm regdomain Ar sku
1386 Set the regulatory domain to use in calculating the regulatory constraints
1387 for operation.
1388 In particular the set of available channels, how the wireless device
1389 will operation on the channels, and the maximum transmit power that
1390 can be used on a channel are defined by this setting.
1391 Regdomain codes (SKU's) are taken from /etc/regdomain.xml and can also
1392 be viewed with the ``list countries'' request.
1393 Note that not all devices support changing the regdomain from a default
1394 setting; typically stored in EEPROM.
1395 See also
1396 .Cm country ,
1397 .Cm indoor ,
1398 .Cm outdoor ,
1399 and
1400 .Cm anywhere .
1401 .It Cm rifs
1402 Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n
1403 on an HT channel.
1404 Note that RIFS must be supported by both the station and access point
1405 for it to be used.
1406 To disable RIFS use
1407 .Fl rifs .
1408 .It Cm roam:rate Ar rate
1409 Set the threshold for controlling roaming when operating in a BSS.
1410 The
1411 .Ar rate
1412 parameter specifies the transmit rate in megabits
1413 at which roaming should be considered.
1414 If the current transmit rate drops below this setting and background scanning
1415 is enabled, then the system will check if a more desirable access point is
1416 available and switch over to it.
1417 The current scan cache contents are used if they are considered
1418 valid according to the
1419 .Cm scanvalid
1420 parameter; otherwise a background scan operation is triggered before
1421 any selection occurs.
1422 Each channel type has a separate rate threshold; the default values are:
1423 12 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng).
1424 .It Cm roam:rssi Ar rssi
1425 Set the threshold for controlling roaming when operating in a BSS.
1426 The
1427 .Ar rssi
1428 parameter specifies the receive signal strength in dBm units
1429 at which roaming should be considered.
1430 If the current rssi drops below this setting and background scanning
1431 is enabled, then the system will check if a more desirable access point is
1432 available and switch over to it.
1433 The current scan cache contents are used if they are considered
1434 valid according to the
1435 .Cm scanvalid
1436 parameter; otherwise a background scan operation is triggered before
1437 any selection occurs.
1438 Each channel type has a separate rssi threshold; the default values are
1439 all 7 dBm.
1440 .It Cm roaming Ar mode
1441 When operating as a station, control how the system will
1442 behave when communication with the current access point
1443 is broken.
1444 The
1445 .Ar mode
1446 argument may be one of
1447 .Cm device
1448 (leave it to the hardware device to decide),
1449 .Cm auto
1450 (handle either in the device or the operating system\[em]as appropriate),
1451 .Cm manual
1452 (do nothing until explicitly instructed).
1453 By default, the device is left to handle this if it is
1454 capable; otherwise, the operating system will automatically
1455 attempt to reestablish communication.
1456 Manual mode is used by applications such as
1457 .Xr wpa_supplicant 8
1458 that want to control the selection of an access point.
1459 .It Cm rtsthreshold Ar length
1460 Set the threshold for which
1461 transmitted frames are preceded by transmission of an
1462 RTS
1463 control frame.
1464 The
1465 .Ar length
1466 argument
1467 is the frame size in bytes and must be in the range 1 to 2346.
1468 Setting
1469 .Ar length
1470 to
1471 .Li 2346 ,
1472 .Cm any ,
1473 or
1474 .Cm -
1475 disables transmission of RTS frames.
1476 Not all adapters support setting the RTS threshold.
1477 .It Cm scan
1478 Initiate a scan of neighboring stations, wait for it to complete, and
1479 display all stations found.
1480 Only the super-user can initiate a scan.
1481 See
1482 .Cm list scan
1483 for information on the display.
1484 By default a background scan is done; otherwise a foreground
1485 scan is done and the station may roam to a different access point.
1486 The
1487 .Cm list scan
1488 request can be used to show recent scan results without
1489 initiating a new scan.
1490 .It Cm scanvalid Ar threshold
1491 Set the maximum time the scan cache contents are considered valid;
1492 i.e. will be used without first triggering a scan operation to
1493 refresh the data.
1494 The
1495 .Ar threshold
1496 parameter is specified in seconds and defaults to 60 seconds.
1497 The minimum setting for
1498 .Ar threshold
1499 is 10 seconds.
1500 One should take care setting this threshold; if it is set too low
1501 then attempts to roam to another access point may trigger unnecessary
1502 background scan operations.
1503 .It Cm shortgi
1504 Enable use of Short Guard Interval when operating in 802.11n
1505 on an HT channel.
1506 NB: this currently enables Short GI on both HT40 and HT20 channels.
1507 To disable Short GI use
1508 .Fl shortgi .
1509 .It Cm smps
1510 Enable use of Static Spatial Multiplexing Power Save (SMPS)
1511 when operating in 802.11n.
1512 A station operating with Static SMPS maintains only a single
1513 receive chain active (this can significantly reduce power consumption).
1514 To disable SMPS use
1515 .Fl smps .
1516 .It Cm smpsdyn
1517 Enable use of Dynamic Spatial Multiplexing Power Save (SMPS)
1518 when operating in 802.11n.
1519 A station operating with Dynamic SMPS maintains only a single
1520 receive chain active but switches to multiple receive chains when it
1521 receives an RTS frame (this can significantly reduce power consumption).
1522 Note that stations cannot distinguish between RTS/CTS intended to
1523 enable multiple receive chains and those used for other purposes.
1524 To disable SMPS use
1525 .Fl smps .
1526 .It Cm ssid Ar ssid
1527 Set the desired Service Set Identifier (aka network name).
1528 The SSID is a string up to 32 characters
1529 in length and may be specified as either a normal string or in
1530 hexadecimal when preceded by
1531 .Ql 0x .
1532 Additionally, the SSID may be cleared by setting it to
1533 .Ql - .
1534 .It Cm tdmaslot Ar slot
1535 When operating with TDMA, use the specified
1536 .Ar slot
1537 configuration.
1538 The
1539 .Ar slot
1540 is a number between 0 and the maximum number of slots in the BSS.
1541 Note that a station configured as slot 0 is a master and
1542 will broadcast beacon frames advertising the BSS;
1543 stations configured to use other slots will always
1544 scan to locate a master before they ever transmit.
1545 By default
1546 .Cm tdmaslot
1547 is set to 1.
1548 .It Cm tdmaslotcnt Ar cnt
1549 When operating with TDMA, setup a BSS with
1550 .Ar cnt
1551 slots.
1552 The slot count may be at most 8.
1553 The current implementation is only tested with two stations
1554 (i.e. point to point applications).
1555 This setting is only meaningful when a station is configured as slot 0;
1556 other stations adopt this setting from the BSS they join.
1557 By default
1558 .Cm tdmaslotcnt
1559 is set to 2.
1560 .It Cm tdmaslotlen Ar len
1561 When operating with TDMA, setup a BSS such that each station has a slot
1562 .Ar len
1563 microseconds long.
1564 The slot length must be at least 150 microseconds (1/8 TU)
1565 and no more than 65 milliseconds.
1566 Note that setting too small a slot length may result in poor channel
1567 bandwidth utilization due to factors such as timer granularity and
1568 guard time.
1569 This setting is only meaningful when a station is configured as slot 0;
1570 other stations adopt this setting from the BSS they join.
1571 By default
1572 .Cm tdmaslotlen
1573 is set to 10 milliseconds.
1574 .It Cm tdmabintval Ar intval
1575 When operating with TDMA, setup a BSS such that beacons are transmitted every
1576 .Ar intval
1577 superframes to synchronize the TDMA slot timing.
1578 A superframe is defined as the number of slots times the slot length; e.g.
1579 a BSS with two slots of 10 milliseconds has a 20 millisecond superframe.
1580 The beacon interval may not be zero.
1581 A lower setting of
1582 .Cm tdmabintval
1583 causes the timers to be resynchronized more often; this can be help if
1584 significant timer drift is observed.
1585 By default
1586 .Cm tdmabintval
1587 is set to 5.
1588 .It Cm tsn
1589 When operating as an access point with WPA/802.11i allow legacy
1590 stations to associate using static key WEP and open authentication.
1591 To disallow legacy station use of WEP, use
1592 .Fl tsn .
1593 .It Cm txpower Ar power
1594 Set the power used to transmit frames.
1595 The
1596 .Ar power
1597 argument is specified in .5 dBm units.
1598 Out of range values are truncated.
1599 Typically only a few discreet power settings are available and
1600 the driver will use the setting closest to the specified value.
1601 Not all adapters support changing the transmit power.
1602 .It Cm ucastrate Ar rate
1603 Set a fixed rate for transmitting unicast frames.
1604 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
1605 This rate should be valid for the current operating conditions;
1606 if an invalid rate is specified drivers are free to chose an
1607 appropriate rate.
1608 .It Cm wepmode Ar mode
1609 Set the desired WEP mode.
1610 Not all adapters support all modes.
1611 The set of valid modes is
1612 .Cm off , on ,
1613 and
1614 .Cm mixed .
1615 The
1616 .Cm mixed
1617 mode explicitly tells the adaptor to allow association with access
1618 points which allow both encrypted and unencrypted traffic.
1619 On these adapters,
1620 .Cm on
1621 means that the access point must only allow encrypted connections.
1622 On other adapters,
1623 .Cm on
1624 is generally another name for
1625 .Cm mixed .
1626 Modes are case insensitive.
1627 .It Cm weptxkey Ar index
1628 Set the WEP key to be used for transmission.
1629 This is the same as setting the default transmission key with
1630 .Cm deftxkey .
1631 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
1632 Set the selected WEP key.
1633 If an
1634 .Ar index
1635 is not given, key 1 is set.
1636 A WEP key will be either 5 or 13
1637 characters (40 or 104 bits) depending of the local network and the
1638 capabilities of the adaptor.
1639 It may be specified either as a plain
1640 string or as a string of hexadecimal digits preceded by
1641 .Ql 0x .
1642 For maximum portability, hex keys are recommended;
1643 the mapping of text keys to WEP encryption is usually driver-specific.
1644 In particular, the
1645 .Tn Windows
1646 drivers do this mapping differently to
1647 .Fx .
1648 A key may be cleared by setting it to
1649 .Ql - .
1650 If WEP is supported then there are at least four keys.
1651 Some adapters support more than four keys.
1652 If that is the case, then the first four keys
1653 (1-4) will be the standard temporary keys and any others will be adaptor
1654 specific keys such as permanent keys stored in NVRAM.
1655 .Pp
1656 Note that you must set a default transmit key with
1657 .Cm deftxkey
1658 for the system to know which key to use in encrypting outbound traffic.
1659 .It Cm wme
1660 Enable Wireless Multimedia Extensions (WME) support, if available,
1661 for the specified interface.
1662 WME is a subset of the IEEE 802.11e standard to support the
1663 efficient communication of realtime and multimedia data.
1664 To disable WME support, use
1665 .Fl wme .
1666 Another name for this parameter is
1667 .Cm wmm .
1668 .Pp
1669 The following parameters are meaningful only when WME support is in use.
1670 Parameters are specified per-AC (Access Category) and
1671 split into those that are used by a station when acting
1672 as an access point and those for client stations in the BSS.
1673 The latter are received from the access point and may not be changed
1674 (at the station).
1675 The following Access Categories are recognized:
1676 .Pp
1677 .Bl -tag -width ".Cm AC_BK" -compact
1678 .It Cm AC_BE
1679 (or
1680 .Cm BE )
1681 best effort delivery,
1682 .It Cm AC_BK
1683 (or
1684 .Cm BK )
1685 background traffic,
1686 .It Cm AC_VI
1687 (or
1688 .Cm VI )
1689 video traffic,
1690 .It Cm AC_VO
1691 (or
1692 .Cm VO )
1693 voice traffic.
1694 .El
1695 .Pp
1696 AC parameters are case-insensitive.
1697 Traffic classification is done in the operating system using the
1698 vlan priority associated with data frames or the
1699 ToS (Type of Service) indication in IP-encapsulated frames.
1700 If neither information is present, traffic is assigned to the
1701 Best Effort (BE) category.
1702 .Bl -tag -width indent
1703 .It Cm ack Ar ac
1704 Set the ACK policy for QoS transmissions by the local station;
1705 this controls whether or not data frames transmitted by a station
1706 require an ACK response from the receiving station.
1707 To disable waiting for an ACK use
1708 .Fl ack .
1709 This parameter is applied only to the local station.
1710 .It Cm acm Ar ac
1711 Enable the Admission Control Mandatory (ACM) mechanism
1712 for transmissions by the local station.
1713 To disable the ACM use
1714 .Fl acm .
1715 On stations in a BSS this parameter is read-only and indicates
1716 the setting received from the access point.
1717 NB: ACM is not supported right now.
1718 .It Cm aifs Ar ac Ar count
1719 Set the Arbitration Inter Frame Spacing (AIFS)
1720 channel access parameter to use for transmissions
1721 by the local station.
1722 On stations in a BSS this parameter is read-only and indicates
1723 the setting received from the access point.
1724 .It Cm cwmin Ar ac Ar count
1725 Set the CWmin channel access parameter to use for transmissions
1726 by the local station.
1727 On stations in a BSS this parameter is read-only and indicates
1728 the setting received from the access point.
1729 .It Cm cwmax Ar ac Ar count
1730 Set the CWmax channel access parameter to use for transmissions
1731 by the local station.
1732 On stations in a BSS this parameter is read-only and indicates
1733 the setting received from the access point.
1734 .It Cm txoplimit Ar ac Ar limit
1735 Set the Transmission Opportunity Limit channel access parameter
1736 to use for transmissions by the local station.
1737 This parameter defines an interval of time when a WME station
1738 has the right to initiate transmissions onto the wireless medium.
1739 On stations in a BSS this parameter is read-only and indicates
1740 the setting received from the access point.
1741 .It Cm bss:aifs Ar ac Ar count
1742 Set the AIFS channel access parameter to send to stations in a BSS.
1743 This parameter is meaningful only when operating in ap mode.
1744 .It Cm bss:cwmin Ar ac Ar count
1745 Set the CWmin channel access parameter to send to stations in a BSS.
1746 This parameter is meaningful only when operating in ap mode.
1747 .It Cm bss:cwmax Ar ac Ar count
1748 Set the CWmax channel access parameter to send to stations in a BSS.
1749 This parameter is meaningful only when operating in ap mode.
1750 .It Cm bss:txoplimit Ar ac Ar limit
1751 Set the TxOpLimit channel access parameter to send to stations in a BSS.
1752 This parameter is meaningful only when operating in ap mode.
1753 .El
1754 .It Cm wps
1755 Enable Wireless Privacy Subscriber support.
1756 Note that WPS support requires a WPS-capable supplicant.
1757 To disable this function use
1758 .Fl wps .
1759 .El
1760 .Pp
1761 The following parameters support an optional access control list
1762 feature available with some adapters when operating in ap mode; see
1763 .Xr wlan_acl 4 .
1764 This facility allows an access point to accept/deny association
1765 requests based on the MAC address of the station.
1766 Note that this feature does not significantly enhance security
1767 as MAC address spoofing is easy to do.
1768 .Bl -tag -width indent
1769 .It Cm mac:add Ar address
1770 Add the specified MAC address to the database.
1771 Depending on the policy setting association requests from the
1772 specified station will be allowed or denied.
1773 .It Cm mac:allow
1774 Set the ACL policy to permit association only by
1775 stations registered in the database.
1776 .It Cm mac:del Ar address
1777 Delete the specified MAC address from the database.
1778 .It Cm mac:deny
1779 Set the ACL policy to deny association only by
1780 stations registered in the database.
1781 .It Cm mac:kick Ar address
1782 Force the specified station to be deauthenticated.
1783 This typically is done to block a station after updating the
1784 address database.
1785 .It Cm mac:open
1786 Set the ACL policy to allow all stations to associate.
1787 .It Cm mac:flush
1788 Delete all entries in the database.
1789 .It Cm mac:radius
1790 Set the ACL policy to permit association only by
1791 stations approved by a RADIUS server.
1792 Note that this feature requires the
1793 .Xr hostapd 8
1794 program be configured to do the right thing
1795 as it handles the RADIUS processing
1796 (and marks stations as authorized).
1797 .El
1798 .Pp
1799 The following parameters are related to a wireless interface operating in mesh
1800 mode:
1801 .Bl -tag -width indent
1802 .It Cm meshid Ar meshid
1803 Set the desired Mesh Identifier.
1804 The Mesh ID is a string up to 32 characters in length.
1805 A mesh interface must have a Mesh Identifier specified
1806 to reach an operational state.
1807 .It Cm meshttl Ar ttl
1808 Set the desired ``time to live'' for mesh forwarded packets;
1809 this is the number of hops a packet may be forwarded before
1810 it is discarded.
1811 The default setting for
1812 .Cm meshttl
1813 is 31.
1814 .It Cm meshpeering
1815 Enable or disable peering with neighbor mesh stations.
1816 Stations must peer before any data packets can be exchanged.
1817 By default
1818 .Cm meshpeering
1819 is enabled.
1820 .It Cm meshforward
1821 Enable or disable forwarding packets by a mesh interface.
1822 By default
1823 .Cm meshforward
1824 is enabled.
1825 .It Cm meshmetric Ar protocol
1826 Set the specified
1827 .Ar protocol
1828 as the link metric protocol used on a mesh network.
1829 The default protocol is called
1830 .Ar AIRTIME .
1831 The mesh interface will restart after changing this setting.
1832 .It Cm meshpath Ar protocol
1833 Set the specified
1834 .Ar protocol
1835 as the path selection protocol used on a mesh network.
1836 The only available protocol at the moment is called
1837 .Ar HWMP
1838 (Hybrid Wireless Mesh Protocol).
1839 The mesh interface will restart after changing this setting.
1840 .It Cm hwmprootmode Ar mode
1841 Stations on a mesh network can operate as ``root nodes.''
1842 Root nodes try to find paths to all mesh nodes and advertise themselves
1843 regularly.
1844 When there is a root mesh node on a network, other mesh nodes can setup
1845 paths between themselves faster because they can use the root node
1846 to find the destination.
1847 This path may not be the best, but on-demand
1848 routing will eventually find the best path.
1849 The following modes are recognized:
1850 .Pp
1851 .Bl -tag -width ".Cm PROACTIVE" -compact
1852 .It Cm DISABLED
1853 Disable root mode.
1854 .It Cm NORMAL
1855 Send broadcast path requests every two seconds.
1856 Nodes on the mesh without a path to this root mesh station with try to
1857 discover a path to us.
1858 .It Cm PROACTIVE
1859 Send broadcast path requests every two seconds and every node must reply
1860 with a path reply even if it already has a path to this root mesh station,
1861 .It Cm RANN
1862 Send broadcast root announcement (RANN) frames.
1863 Nodes on the mesh without a path to this root mesh station with try to
1864 discover a path to us.
1865 .El
1866 By default
1867 .Cm hwmprootmode
1868 is set to
1869 .Ar DISABLED .
1870 .It Cm hwmpmaxhops Ar cnt
1871 Set the maximum number of hops allowed in an HMWP path to
1872 .Ar cnt .
1873 The default setting for
1874 .Cm hwmpmaxhops
1875 is 31.
1876 .El
1877 .Pp
1878 The following parameters are for compatibility with other systems:
1879 .Bl -tag -width indent
1880 .It Cm nwid Ar ssid
1881 Another name for the
1882 .Cm ssid
1883 parameter.
1884 Included for
1885 .Nx
1886 compatibility.
1887 .It Cm stationname Ar name
1888 Set the name of this station.
1889 The station name is not part of the IEEE 802.11
1890 protocol though some interfaces support it.
1891 As such it only
1892 seems to be meaningful to identical or virtually identical equipment.
1893 Setting the station name is identical in syntax to setting the SSID.
1894 One can also use
1895 .Cm station
1896 for
1897 .Bsx
1898 compatibility.
1899 .It Cm wep
1900 Another way of saying
1901 .Cm wepmode on .
1902 Included for
1903 .Bsx
1904 compatibility.
1905 .It Fl wep
1906 Another way of saying
1907 .Cm wepmode off .
1908 Included for
1909 .Bsx
1910 compatibility.
1911 .It Cm nwkey key
1912 Another way of saying:
1913 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
1914 Included for
1915 .Nx
1916 compatibility.
1917 .It Cm nwkey Xo
1918 .Sm off
1919 .Ar n : k1 , k2 , k3 , k4
1920 .Sm on
1921 .Xc
1922 Another way of saying
1923 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
1924 Included for
1925 .Nx
1926 compatibility.
1927 .It Fl nwkey
1928 Another way of saying
1929 .Cm wepmode off .
1930 Included for
1931 .Nx
1932 compatibility.
1933 .El
1934 .Pp
1935 The following parameters are specific to bridge interfaces:
1936 .Bl -tag -width indent
1937 .It Cm addm Ar interface
1938 Add the interface named by
1939 .Ar interface
1940 as a member of the bridge.
1941 The interface is put into promiscuous mode
1942 so that it can receive every packet sent on the network.
1943 .It Cm deletem Ar interface
1944 Remove the interface named by
1945 .Ar interface
1946 from the bridge.
1947 Promiscuous mode is disabled on the interface when
1948 it is removed from the bridge.
1949 .It Cm maxaddr Ar size
1950 Set the size of the bridge address cache to
1951 .Ar size .
1952 The default is 100 entries.
1953 .It Cm timeout Ar seconds
1954 Set the timeout of address cache entries to
1955 .Ar seconds
1956 seconds.
1957 If
1958 .Ar seconds
1959 is zero, then address cache entries will not be expired.
1960 The default is 1200 seconds.
1961 .It Cm addr
1962 Display the addresses that have been learned by the bridge.
1963 .It Cm static Ar interface-name Ar address
1964 Add a static entry into the address cache pointing to
1965 .Ar interface-name .
1966 Static entries are never aged out of the cache or re-placed, even if the
1967 address is seen on a different interface.
1968 .It Cm deladdr Ar address
1969 Delete
1970 .Ar address
1971 from the address cache.
1972 .It Cm flush
1973 Delete all dynamically-learned addresses from the address cache.
1974 .It Cm flushall
1975 Delete all addresses, including static addresses, from the address cache.
1976 .It Cm discover Ar interface
1977 Mark an interface as a
1978 .Dq discovering
1979 interface.
1980 When the bridge has no address cache entry
1981 (either dynamic or static)
1982 for the destination address of a packet,
1983 the bridge will forward the packet to all
1984 member interfaces marked as
1985 .Dq discovering .
1986 This is the default for all interfaces added to a bridge.
1987 .It Fl discover Ar interface
1988 Clear the
1989 .Dq discovering
1990 attribute on a member interface.
1991 For packets without the
1992 .Dq discovering
1993 attribute, the only packets forwarded on the interface are broadcast
1994 or multicast packets and packets for which the destination address
1995 is known to be on the interface's segment.
1996 .It Cm learn Ar interface
1997 Mark an interface as a
1998 .Dq learning
1999 interface.
2000 When a packet arrives on such an interface, the source
2001 address of the packet is entered into the address cache as being a
2002 destination address on the interface's segment.
2003 This is the default for all interfaces added to a bridge.
2004 .It Fl learn Ar interface
2005 Clear the
2006 .Dq learning
2007 attribute on a member interface.
2008 .It Cm span Ar interface
2009 Add the interface named by
2010 .Ar interface
2011 as a span port on the bridge.
2012 Span ports transmit a copy of every frame received by the bridge.
2013 This is most useful for snooping a bridged network passively on
2014 another host connected to one of the span ports of the bridge.
2015 .It Fl span Ar interface
2016 Delete the interface named by
2017 .Ar interface
2018 from the list of span ports of the bridge.
2019 .It Cm stp Ar interface
2020 Enable Spanning Tree protocol on
2021 .Ar interface .
2022 The
2023 .Xr bridge 4
2024 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
2025 Spanning Tree is used to detect and remove loops in a network topology.
2026 .It Fl stp Ar interface
2027 Disable Spanning Tree protocol on
2028 .Ar interface .
2029 This is the default for all interfaces added to a bridge.
2030 .It Cm maxage Ar seconds
2031 Set the time that a Spanning Tree protocol configuration is valid.
2032 The default is 20 seconds.
2033 The minimum is 1 second and the maximum is 255 seconds.
2034 .It Cm fwddelay Ar seconds
2035 Set the time that must pass before an interface begins forwarding
2036 packets when Spanning Tree is enabled.
2037 The default is 15 seconds.
2038 The minimum is 1 second and the maximum is 255 seconds.
2039 .It Cm hellotime Ar seconds
2040 Set the time between broadcasting of Spanning Tree protocol
2041 configuration messages.
2042 The default is 2 seconds.
2043 The minimum is 1 second and the maximum is 255 seconds.
2044 .It Cm priority Ar value
2045 Set the bridge priority for Spanning Tree.
2046 The default is 32768.
2047 The minimum is 0 and the maximum is 65536.
2048 .It Cm ifpriority Ar interface Ar value
2049 Set the Spanning Tree priority of
2050 .Ar interface
2051 to
2052 .Ar value .
2053 The default is 128.
2054 The minimum is 0 and the maximum is 255.
2055 .Pp
2056 The priority is used to select which interface out of all
2057 forwarding and bonded interfaces with the same MAC
2058 to output a packet on whe
2059 .Cm link2
2060 mode is not being used.
2061 Note that interfaces in the 'blocking' state do not participate
2062 in the priority selection.
2063 If the priorities are the same on a non-bonded member, the
2064 designated member will be used.
2065 .It Cm ifpathcost Ar interface Ar value
2066 Set the Spanning Tree path cost of
2067 .Ar interface
2068 to
2069 .Ar value .
2070 The default is 55.
2071 The minimum is 0 and the maximum is 65535.
2072 .Pp
2073 The path cost is added to both incoming and outgoing packets on the
2074 member, lower values will make the member more valuable.
2075 .It Cm ifbondweight Ar interface Ar value
2076 Set the number of packets to output on a bonded member before
2077 round-robining to the next member.
2078 The default is 1.
2079 Larger values or different values for each member can be used
2080 if bursting would be beneficial or if the outgoing bandwidth
2081 on each of the members is asymmetric.
2082 For example, one specify a value of 6 on tap0 and 4 on tap1
2083 for a 6:4 ratio.
2084 Remember that this also controls packet bursting.
2085 .It Cm link0
2086 The link0 option enables transparent bridging mode.
2087 The bridge will make every effort to retain the ethernet header
2088 when forwarding packets between interfaces, making the bridging
2089 function work more like a hardware bridge device.
2090 .It Cm link1
2091 The link1 option enables keepalive transmission and automatically
2092 places a member into a special blocked mode if no keepalive reception
2093 occurs.
2094 If either sides of the link uses this option then both sides must use
2095 this option.
2096 This option is impemented by sending CFG updates on the hello interval
2097 to the remote.
2098 The link is considered lost after 10 intervals (typically 20 seconds).
2099 .It Cm link2
2100 The link2 option enables channel bonding (see also ifbondweight).
2101 All member interfaces with the same mac address are considered to
2102 be in a bonding group.
2103 When something like
2104 .Xr tap 4
2105 is used, you can manually control or copy the mac to create bonding groups.
2106 When interface bonding is enabled normally blocked interfaces belonging
2107 to the same bonding group as an active forwarding interface will be
2108 changed to the bonding state.
2109 Both sides of link the member represents must operate in bonding mode
2110 for this to work, otherwise the remote end may decide to throw away
2111 half your packets.
2112 .El
2113 .Pp
2114 The following parameters are specific to IP tunnel interfaces,
2115 .Xr gif 4 :
2116 .Bl -tag -width indent
2117 .It Cm tunnel Ar src_addr dest_addr
2118 Configure the physical source and destination address for IP tunnel
2119 interfaces.
2120 The arguments
2121 .Ar src_addr
2122 and
2123 .Ar dest_addr
2124 are interpreted as the outer source/destination for the encapsulating
2125 IPv4/IPv6 header.
2126 .It Fl tunnel
2127 Unconfigure the physical source and destination address for IP tunnel
2128 interfaces previously configured with
2129 .Cm tunnel .
2130 .It Cm deletetunnel
2131 Another name for the
2132 .Fl tunnel
2133 parameter.
2134 .El
2135 .Pp
2136 The following parameters are specific to
2137 .Xr vlan 4
2138 interfaces:
2139 .Bl -tag -width indent
2140 .It Cm vlan Ar vlan_tag
2141 Set the VLAN tag value to
2142 .Ar vlan_tag .
2143 This value is a 16-bit number which is used to create an 802.1Q
2144 VLAN header for packets sent from the
2145 .Xr vlan 4
2146 interface.
2147 Note that
2148 .Cm vlan
2149 and
2150 .Cm vlandev
2151 must both be set at the same time.
2152 .It Cm vlandev Ar iface
2153 Associate the physical interface
2154 .Ar iface
2155 with a
2156 .Xr vlan 4
2157 interface.
2158 Packets transmitted through the
2159 .Xr vlan 4
2160 interface will be
2161 diverted to the specified physical interface
2162 .Ar iface
2163 with 802.1Q VLAN encapsulation.
2164 Packets with 802.1Q encapsulation received
2165 by the parent interface with the correct VLAN tag will be diverted to
2166 the associated
2167 .Xr vlan 4
2168 pseudo-interface.
2169 The
2170 .Xr vlan 4
2171 interface is assigned a
2172 copy of the parent interface's flags and the parent's ethernet address.
2173 The
2174 .Cm vlandev
2175 and
2176 .Cm vlan
2177 must both be set at the same time.
2178 If the
2179 .Xr vlan 4
2180 interface already has
2181 a physical interface associated with it, this command will fail.
2182 To
2183 change the association to another physical interface, the existing
2184 association must be cleared first.
2185 .Pp
2186 Note: if the hardware tagging capability
2187 is set on the parent interface, the
2188 .Xr vlan 4
2189 pseudo
2190 interface's behavior changes:
2191 the
2192 .Xr vlan 4
2193 interface recognizes that the
2194 parent interface supports insertion and extraction of VLAN tags on its
2195 own (usually in firmware) and that it should pass packets to and from
2196 the parent unaltered.
2197 .It Fl vlandev Op Ar iface
2198 If the driver is a
2199 .Xr vlan 4
2200 pseudo device, disassociate the parent interface from it.
2201 This breaks the link between the
2202 .Xr vlan 4
2203 interface and its parent,
2204 clears its VLAN tag, flags and its link address and shuts the interface down.
2205 The
2206 .Ar iface
2207 argument is useless and hence deprecated.
2208 .El
2209 .Pp
2210 The following parameters are specific to
2211 .Xr carp 4
2212 interfaces:
2213 .Bl -tag -width indent
2214 .It Cm advbase Ar seconds
2215 Specifies the base of the advertisement interval in seconds.
2216 The acceptable values are 1 to 255.
2217 The default value is 1.
2218 .\" The default value is
2219 .\" .Dv CARP_DFLTINTV .
2220 .It Cm advskew Ar interval
2221 Specifies the skew to add to the base advertisement interval to
2222 make one host advertise slower than another host.
2223 It is specified in 1/256 of seconds.
2224 The acceptable values are 1 to 254.
2225 The default value is 0.
2226 .It Cm pass Ar phrase
2227 Set the authentication key to
2228 .Ar phrase .
2229 .It Cm vhid Ar n
2230 Set the virtual host ID.
2231 This is a required setting.
2232 Acceptable values are 1 to 255.
2233 .El
2234 .Pp
2235 The
2236 .Nm
2237 utility displays the current configuration for a network interface
2238 when no optional parameters are supplied.
2239 If a protocol family is specified,
2240 .Nm
2241 will report only the details specific to that protocol family.
2242 .Pp
2243 If the
2244 .Fl m
2245 flag is passed before an interface name,
2246 .Nm
2247 will display the capability list,
2248 the maximum amount of data
2249 that TCP segmentation offloading is allowed to aggregate and
2250 all of the supported media for the specified interface.
2251 If
2252 .Fl L
2253 flag is supplied, address lifetime is displayed for IPv6 addresses,
2254 as time offset string.
2255 .Pp
2256 Optionally, the
2257 .Fl a
2258 flag may be used instead of an interface name.
2259 This flag instructs
2260 .Nm
2261 to display information about all interfaces in the system.
2262 The
2263 .Fl d
2264 flag limits this to interfaces that are down, and
2265 .Fl u
2266 limits this to interfaces that are up.
2267 When no arguments are given,
2268 .Fl a
2269 is implied.
2270 .Pp
2271 The
2272 .Fl l
2273 flag may be used to list all available interfaces on the system, with
2274 no other additional information.
2275 Use of this flag is mutually exclusive
2276 with all other flags and commands, except for
2277 .Fl d
2278 (only list interfaces that are down)
2279 and
2280 .Fl u
2281 (only list interfaces that are up).
2282 .Pp
2283 The
2284 .Fl v
2285 flag may be used to get more verbose status for an interface.
2286 .Pp
2287 The
2288 .Fl C
2289 flag may be used to list all of the interface cloners available on
2290 the system, with no additional information.
2291 Use of this flag is mutually exclusive with all other flags and commands.
2292 .Pp
2293 The
2294 .Fl k
2295 flag causes keying information for the interface, if available, to be
2296 printed.
2297 For example, the values of 802.11 WEP keys will be printed, if accessible to
2298 the current user.
2299 This information is not printed by default, as it may be considered
2300 sensitive.
2301 .Pp
2302 Only the super-user may modify the configuration of a network interface.
2303 .Sh DIAGNOSTICS
2304 Messages indicating the specified interface does not exist, the
2305 requested address is unknown, or the user is not privileged and
2306 tried to alter an interface's configuration.
2307 .Sh SEE ALSO
2308 .Xr netstat 1 ,
2309 .Xr carp 4 ,
2310 .Xr ifmedia 4 ,
2311 .Xr netintro 4 ,
2312 .Xr polling 4 ,
2313 .Xr vlan 4 ,
2314 .\" .Xr eon 5 ,
2315 .Xr rc 8 ,
2316 .Xr routed 8 ,
2317 .Xr sysctl 8
2318 .Sh HISTORY
2319 The
2320 .Nm
2321 utility appeared in
2322 .Bx 4.2 .
2323 .Sh BUGS
2324 Basic IPv6 node operation requires a link-local address on each
2325 interface configured for IPv6.
2326 Normally, such an address is automatically configured by the
2327 kernel on each interface added to the system; this behaviour may
2328 be disabled by setting the sysctl MIB variable
2329 .Va net.inet6.ip6.auto_linklocal
2330 to 0.
2331 .Pp
2332 If you delete such an address using
2333 .Nm ,
2334 the kernel may act very odd.
2335 Do this at your own risk.