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