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