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