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