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