1 .\" Copyright (c) 1983, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 4. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
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
28 .\" From: @(#)ifconfig.8 8.3 (Berkeley) 1/5/94
36 .Nd configure network interface parameters
80 utility is used to assign an address
81 to a network interface and/or configure
82 network interface parameters.
85 utility must be used at boot time to define the network address
86 of each interface present on a machine; it may also be used at
87 a later time to redefine an interface's address
88 or other operating parameters.
90 The following options are available:
91 .Bl -tag -width indent
94 .Tn DARPA Ns -Internet
96 the address is either a host name present in the host name data
101 Internet address expressed in the Internet standard
104 It is also possible to use the CIDR notation (also known as the
105 slash notation) to include the netmask.
106 That is, one can specify an address like
111 family, it is also possible to specify the prefix length using the slash
116 parameter below for more information.
117 .\" For the Xerox Network Systems(tm) family,
119 .\" .Ar net:a.b.c.d.e.f ,
122 .\" is the assigned network number (in decimal),
123 .\" and each of the six bytes of the host number,
127 .\" are specified in hexadecimal.
128 .\" The host number may be omitted on IEEE 802 protocol
129 .\" (Ethernet, FDDI, and Token Ring) interfaces,
130 .\" which use the hardware physical address,
131 .\" and on interfaces other than the first.
134 .\" family, addresses are specified as a long hexadecimal string,
135 .\" as in the Xerox family.
136 .\" However, two consecutive dots imply a zero
137 .\" byte, and the dots are optional, if the user wishes to (carefully)
138 .\" count out long strings of digits in network byte order.
143 is specified as a series of colon-separated hex digits.
145 e.g.\& set a new MAC address on an ethernet interface, though the
146 mechanism used is not ethernet-specific.
147 If the interface is already
148 up when this option is used, it will be briefly brought down and
149 then brought back up again in order to ensure that the receive
150 filter in the underlying ethernet hardware is properly reprogrammed.
151 .It Ar address_family
154 which affects interpretation of the remaining parameters.
155 Since an interface can receive transmissions in differing protocols
156 with different naming schemes, specifying the address family is recommended.
157 The address or protocol families currently
168 The default if available is
178 Specify the address of the correspondent on the other end
179 of a point to point link.
182 parameter is a string of the form
187 List the interfaces in the given group.
190 The following parameters may be set with
192 .Bl -tag -width indent
197 Introduced for compatibility
201 Establish an additional network address for this interface.
202 This is sometimes useful when changing network numbers, and
203 one wishes to accept packets addressed to the old interface.
204 If the address is on the same subnet as the first network address
205 for this interface, a non-conflicting netmask must be given.
210 Remove the network address specified.
211 This would be used if you incorrectly specified an alias, or it
212 was no longer needed.
213 If you have incorrectly set an NS address having the side effect
214 of specifying the host portion, removing all NS addresses will
215 allow you to respecify the host portion.
218 Specify that the address configured is an anycast address.
219 Based on the current specification,
220 only routers may configure anycast addresses.
221 Anycast address will not be used as source address of any of outgoing
224 Enable the use of the Address Resolution Protocol
227 between network level addresses and link level addresses (default).
228 This is currently implemented for mapping between
233 802 48-bit MAC addresses (Ethernet, FDDI, and Token Ring addresses).
235 Disable the use of the Address Resolution Protocol
238 If the Address Resolution Protocol is enabled,
239 the host will only reply to requests for its addresses,
240 and will never send any requests.
242 If the Address Resolution Protocol is enabled,
243 the host will perform normally,
244 sending out requests and listening for replies.
247 Specify the address to use to represent broadcasts to the
249 The default broadcast address is the address with a host part of all 1's.
251 Enable driver dependent debugging code; usually, this turns on
252 extra console error logging.
254 Disable driver dependent debugging code.
256 Put interface into permanently promiscuous mode.
258 Disable permanently promiscuous mode.
263 .It Cm description Ar value , Cm descr Ar value
264 Specify a description of the interface.
265 This can be used to label interfaces in situations where they may
266 otherwise be difficult to distinguish.
267 .It Cm -description , Cm -descr
268 Clear the interface description.
272 When an interface is marked
274 the system will not attempt to
275 transmit messages through that interface.
276 If possible, the interface will be reset to disable reception as well.
277 This action does not automatically disable routes using the interface.
278 .It Cm group Ar group-name
279 Assign the interface to a
281 Any interface can be in multiple groups.
283 Cloned interfaces are members of their interface family group by default.
284 For example, a PPP interface such as
286 is a member of the PPP interface family group,
288 .\" The interface(s) the default route(s) point to are members of the
291 .It Cm -group Ar group-name
292 Remove the interface from the given
297 (lowermost 64bit of an IPv6 address)
299 .It Cm fib Ar fib_number
300 Specify interface FIB.
303 is assigned to all frames or packets received on that interface.
304 The FIB is not inherited, e.g. vlans or other sub-interfaces will use
305 the default FIB (0) irrespective of the parent interface's FIB.
306 The kernel needs to be tuned to support more than the default FIB
309 kernel configuration option, or the
313 This is used to specify an Internet host who is willing to receive
314 IP packets encapsulating IPX packets bound for a remote network.
315 An apparent point to point link is constructed, and
316 the address specified will be taken as the IPX address and network
318 .It Cm maclabel Ar label
319 If Mandatory Access Control support is enabled in the kernel,
323 .\" .Xr maclabel 7 ) .
325 If the driver supports the media selection system, set the media type
328 Some interfaces support the mutually exclusive use of one of several
329 different physical media connectors.
330 For example, a 10Mbit/s Ethernet
331 interface might support the use of either
333 or twisted pair connectors.
334 Setting the media type to
336 would change the currently active connector to the AUI port.
339 would activate twisted pair.
340 Refer to the interfaces' driver
341 specific documentation or man page for a complete list of the
343 .It Cm mediaopt Ar opts
344 If the driver supports the media selection system, set the specified
345 media options on the interface.
349 is a comma delimited list of options to apply to the interface.
350 Refer to the interfaces' driver specific man page for a complete
351 list of available options.
352 .It Fl mediaopt Ar opts
353 If the driver supports the media selection system, disable the
354 specified media options on the interface.
356 If the driver supports the media selection system, set the specified
357 operating mode on the interface to
359 For IEEE 802.11 wireless interfaces that support multiple operating modes
360 this directive is used to select between 802.11a
367 .It Cm inst Ar minst , Cm instance Ar minst
368 Set the media instance to
370 This is useful for devices which have multiple physical layer interfaces
373 Set the interface name to
375 .It Cm rxcsum , txcsum
376 If the driver supports user-configurable checksum offloading,
377 enable receive (or transmit) checksum offloading on the interface.
378 Some drivers may not be able to enable these flags independently
379 of each other, so setting one may also set the other.
380 The driver will offload as much checksum work as it can reliably
381 support, the exact level of offloading varies between drivers.
382 .It Fl rxcsum , txcsum
383 If the driver supports user-configurable checksum offloading,
384 disable receive (or transmit) checksum offloading on the interface.
385 These settings may not always be independent of each other.
387 If the driver supports
389 segmentation offloading, enable TSO on the interface.
390 Some drivers may not be able to support TSO for
394 packets, so they may enable only one of them.
396 If the driver supports
398 segmentation offloading, disable TSO on the interface.
399 It will always disable TSO for
404 If the driver supports
406 large receive offloading, enable LRO on the interface.
408 If the driver supports
410 large receive offloading, disable LRO on the interface.
411 .It Cm wol , wol_ucast , wol_mcast , wol_magic
412 Enable Wake On Lan (WOL) support, if available.
413 WOL is a facility whereby a machine in a low power state may be woken
414 in response to a received packet.
415 There are three types of packets that may wake a system:
416 ucast (directed solely to the machine's mac address),
417 mcast (directed to a broadcast or multicast address),
419 magic (unicast or multicast frames with a ``magic contents'').
420 Not all devices support WOL, those that do indicate the mechanisms
421 they support in their capabilities.
423 is a synonym for enabling all available WOL mechanisms.
426 .It Cm vlanmtu , vlanhwtag, vlanhwfilter, vlanhwtso
427 If the driver offers user-configurable VLAN support, enable
428 reception of extended frames, tag processing in hardware,
429 frame filtering in hardware, or TSO on VLAN,
431 Note that this must be issued on a physical interface associated with
436 .It Fl vlanmtu , vlanhwtag, vlanhwfilter, vlanhwtso
437 If the driver offers user-configurable VLAN support, disable
438 reception of extended frames, tag processing in hardware,
439 frame filtering in hardware, or TSO on VLAN,
442 Move the interface to the
444 specified by name or JID.
445 If the jail has a virtual network stack, the interface will disappear
446 from the current environment and become visible to the jail.
448 Reclaim the interface from the
450 specified by name or JID.
451 If the jail has a virtual network stack, the interface will disappear
452 from the jail, and become visible to the current network environment.
456 feature and disable interrupts on the interface, if driver supports
461 feature and enable interrupt mode on the interface.
463 Create the specified network pseudo-device.
464 If the interface is given without a unit number, try to create a new
465 device with an arbitrary unit number.
466 If creation of an arbitrary device is successful, the new device name is
467 printed to standard output unless the interface is renamed or destroyed
472 Destroy the specified network pseudo-device.
488 Set the routing metric of the interface to
491 The routing metric is used by the routing protocol
493 Higher metrics have the effect of making a route
494 less favorable; metrics are counted as additional hops
495 to the destination network or host.
497 Set the maximum transmission unit of the interface to
499 default is interface specific.
500 The MTU is used to limit the size of packets that are transmitted on an
502 Not all interfaces support setting the MTU, and some interfaces have
504 .It Cm netmask Ar mask
507 Specify how much of the address to reserve for subdividing
508 networks into sub-networks.
509 The mask includes the network part of the local address
510 and the subnet part, which is taken from the host field of the address.
511 The mask can be specified as a single hexadecimal number
514 with a dot-notation Internet address,
515 or with a pseudo-network name listed in the network table
517 The mask contains 1's for the bit positions in the 32-bit address
518 which are to be used for the network and subnet parts,
519 and 0's for the host part.
520 The mask should contain at least the standard network portion,
521 and the subnet field should be contiguous with the network
524 The netmask can also be specified in CIDR notation after the address.
527 option above for more information.
528 .It Cm prefixlen Ar len
532 bits are reserved for subdividing networks into sub-networks.
535 must be integer, and for syntactical reason it must be between 0 to 128.
536 It is almost always 64 under the current IPv6 assignment rule.
537 If the parameter is omitted, 64 is used.
539 The prefix can also be specified using the slash notation after the address.
542 option above for more information.
545 .\" .It Cm nsellength Ar n
548 .\" This specifies a trailing number of bytes for a received
550 .\" used for local identification, the remaining leading part of which is
553 .\" (Network Entity Title).
554 .\" The default value is 1, which is conformant to US
556 .\" When an ISO address is set in an ifconfig command,
559 .\" which is being specified.
562 .\" 20 hex digits should be
565 .\" to be assigned to the interface.
566 .\" There is some evidence that a number different from 1 may be useful
569 .\" 37 type addresses.
570 .It Cm range Ar netrange
571 Under appletalk, set the interface to respond to a
574 .Ar startnet Ns - Ns Ar endnet .
575 Appletalk uses this scheme instead of
578 implements it internally as a set of netmasks.
583 Introduced for compatibility
587 The argument following this specifies the version (phase) of the
588 Appletalk network attached to the interface.
589 Values of 1 or 2 are permitted.
591 .It Cm link Op Cm 0 No - Cm 2
593 Enable special processing of the link level of the interface.
594 These three options are interface specific in actual effect, however,
595 they are in general used to select special modes of operation.
597 of this is to enable SLIP compression, or to select the connector type
598 for some Ethernet cards.
599 Refer to the man page for the specific driver
600 for more information.
602 .It Fl link Op Cm 0 No - Cm 2
604 Disable special processing at the link level with the specified interface.
606 Put the interface in monitor mode.
607 No packets are transmitted, and received packets are discarded after
611 Take the interface out of monitor mode.
615 This may be used to enable an interface after an
617 It happens automatically when setting the first address on an interface.
618 If the interface was reset when previously marked down,
619 the hardware will be re-initialized.
622 The following parameters are for ICMPv6 Neighbor Discovery Protocol.
623 Note that the address family keyword
626 .Bl -tag -width indent
628 Set a flag to enable accepting ICMPv6 Router Advertisement messages.
632 .It Cm auto_linklocal
633 Set a flag to perform automatic link-local address configuration when
634 the interface becomes available.
635 .It Cm -auto_linklocal
639 Set the specified interface as the default route when there is no
645 Set a flag to disable all of IPv6 network communications on the
646 specified interface. Note that if there are already configured IPv6
647 addresses on that interface, all of them are marked as
649 and DAD will be performed when this flag is cleared.
653 When this flag is cleared and
655 flag is enabled, automatic configuration of a link-local address is
658 Set a flag to enable Neighbor Unreachability Detection.
663 Set a flag to prefer addresses on the interface as candidates of the
664 source address for outgoing packets.
665 .It Cm -prefer_source
670 The following parameters are specific to cloning
671 IEEE 802.11 wireless interfaces with the
674 .Bl -tag -width indent
675 .It Cm wlandev Ar device
678 as the parent for the cloned device.
679 .It Cm wlanmode Ar mode
680 Specify the operating mode for this cloned device.
698 The operating mode of a cloned interface cannot be changed.
701 mode is actually implemented as an
703 interface with special properties.
704 .It Cm wlanbssid Ar bssid
705 The 802.11 mac address to use for the bssid.
706 This must be specified at create time for a legacy
709 .It Cm wlanaddr Ar address
710 The local mac address.
711 If this is not specified then a mac address will automatically be assigned
712 to the cloned device.
713 Typically this address is the same as the address of the parent device
716 parameter is specified then the driver will craft a unique address for
717 the device (if supported).
721 device as operating in ``legacy mode''.
724 devices have a fixed peer relationship and do not, for example, roam
725 if their peer stops communicating.
726 For completeness a Dynamic WDS (DWDS) interface may marked as
729 Request a unique local mac address for the cloned device.
730 This is only possible if the device supports multiple mac addresses.
731 To force use of the parent's mac address use
734 Mark the cloned interface as depending on hardware support to
735 track received beacons.
736 To have beacons tracked in software use
742 can also be used to indicate no beacons should
743 be transmitted; this can be useful when creating a WDS configuration but
745 interfaces can only be created as companions to an access point.
748 The following parameters are specific to IEEE 802.11 wireless interfaces
752 .Bl -tag -width indent
754 Enable sending and receiving AMPDU frames when using 802.11n (default).
755 The 802.11n specification states a compliant station must be capable
756 of receiving AMPDU frames but transmission is optional.
759 to disable all use of AMPDU with 802.11n.
760 For testing and/or to work around interoperability problems one can use
764 to control use of AMPDU in one direction.
765 .It Cm ampdudensity Ar density
766 Set the AMPDU density parameter used when operating with 802.11n.
767 This parameter controls the inter-packet gap for AMPDU frames.
768 The sending device normally controls this setting but a receiving station
769 may request wider gaps.
772 are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds).
775 is treated the same as 0.
776 .It Cm ampdulimit Ar limit
777 Set the limit on packet size for receiving AMPDU frames when operating
781 are 8192, 16384, 32768, and 65536 but one can also specify
782 just the unique prefix: 8, 16, 32, 64.
783 Note the sender may limit the size of AMPDU frames to be less
784 than the maximum specified by the receiving station.
786 Enable sending and receiving AMSDU frames when using 802.11n.
787 By default AMSDU is received but not transmitted.
790 to disable all use of AMSDU with 802.11n.
791 For testing and/or to work around interoperability problems one can use
795 to control use of AMSDU in one direction.
796 .It Cm amsdulimit Ar limit
797 Set the limit on packet size for sending and receiving AMSDU frames
798 when operating with 802.11n.
801 are 7935 and 3839 (bytes).
802 Note the sender may limit the size of AMSDU frames to be less
803 than the maximum specified by the receiving station.
804 Note also that devices are not required to support the 7935 limit,
805 only 3839 is required by the specification and the larger value
806 may require more memory to be dedicated to support functionality
809 When operating as an access point, pass packets between
810 wireless clients directly (default).
811 To instead let them pass up through the
812 system and be forwarded using some other mechanism, use
814 Disabling the internal bridging
815 is useful when traffic is to be processed with
817 .It Cm authmode Ar mode
818 Set the desired authentication mode in infrastructure mode.
819 Not all adapters support all modes.
822 .Cm none , open , shared
828 (IEEE WPA/WPA2/802.11i).
833 modes are only useful when using an authentication service
834 (a supplicant for client operation or an authenticator when
835 operating as an access point).
836 Modes are case insensitive.
838 Enable background scanning when operating as a station.
839 Background scanning is a technique whereby a station associated to
840 an access point will temporarily leave the channel to scan for
841 neighboring stations.
842 This allows a station to maintain a cache of nearby access points
843 so that roaming between access points can be done without
844 a lengthy scan operation.
845 Background scanning is done only when a station is not busy and
846 any outbound traffic will cancel a scan operation.
847 Background scanning should never cause packets to be lost though
848 there may be some small latency if outbound traffic interrupts a
850 By default background scanning is enabled if the device is capable.
851 To disable background scanning, use
853 Background scanning is controlled by the
858 Background scanning must be enabled for roaming; this is an artifact
859 of the current implementation and may not be required in the future.
860 .It Cm bgscanidle Ar idletime
861 Set the minimum time a station must be idle (not transmitting or
862 receiving frames) before a background scan is initiated.
865 parameter is specified in milliseconds.
866 By default a station must be idle at least 250 milliseconds before
867 a background scan is initiated.
868 The idle time may not be set to less than 100 milliseconds.
869 .It Cm bgscanintvl Ar interval
870 Set the interval at which background scanning is attempted.
873 parameter is specified in seconds.
874 By default a background scan is considered every 300 seconds (5 minutes).
877 may not be set to less than 15 seconds.
878 .It Cm bintval Ar interval
879 Set the interval at which beacon frames are sent when operating in
883 parameter is specified in TU's (1024 usecs).
884 By default beacon frames are transmitted every 100 TU's.
885 .It Cm bmissthreshold Ar count
886 Set the number of consecutive missed beacons at which the station
887 will attempt to roam (i.e., search for a new access point).
890 parameter must be in the range 1 to 255; though the
891 upper bound may be reduced according to device capabilities.
892 The default threshold is 7 consecutive missed beacons; but
893 this may be overridden by the device driver.
898 .It Cm bssid Ar address
899 Specify the MAC address of the access point to use when operating
900 as a station in a BSS network.
901 This overrides any automatic selection done by the system.
902 To disable a previously selected access point, supply
907 This option is useful when more than one access point uses the same SSID.
913 Enable packet bursting.
914 Packet bursting is a transmission technique whereby the wireless
915 medium is acquired once to send multiple frames and the interframe
917 This technique can significantly increase throughput by reducing
918 transmission overhead.
919 Packet bursting is supported by the 802.11e QoS specification
920 and some devices that do not support QoS may still be capable.
921 By default packet bursting is enabled if a device is capable
923 To disable packet bursting, use
925 .It Cm chanlist Ar channels
926 Set the desired channels to use when scanning for access
927 points, neighbors in an IBSS network, or looking for unoccupied
928 channels when operating as an access point.
929 The set of channels is specified as a comma-separated list with
930 each element in the list representing either a single channel number or a range
933 Channel numbers must be in the range 1 to 255 and be permissible
934 according to the operating characteristics of the device.
935 .It Cm channel Ar number
936 Set a single desired channel.
937 Channels range from 1 to 255, but the exact selection available
938 depends on the region your adaptor was manufactured for.
944 will clear any desired channel and, if the device is marked up,
945 force a scan for a channel to operate on.
946 Alternatively the frequency, in megahertz, may be specified
947 instead of the channel number.
949 When there are several ways to use a channel the channel
950 number/frequency may be appended with attributes to clarify.
951 For example, if a device is capable of operating on channel 6
952 with 802.11n and 802.11g then one can specify that g-only use
953 should be used by specifying ``6:g''.
954 Similarly the channel width can be specified by appending it
955 with ``/''; e.g. ``6/40'' specifies a 40MHz wide channel,
956 These attributes can be combined as in: ``6:ht/40''.
957 The full set of flags specified following a ``:'' are:
963 (Atheros Dynamic Turbo mode),
971 (Atheros Static Turbo mode),
974 (Atheros Dynamic Turbo mode, or appended to ``st'' and ``dt'').
975 The full set of channel widths following a '/' are:
977 (5MHz aka quarter-rate channel),
979 (10MHz aka half-rate channel),
981 (20MHz mostly for use in specifying ht20),
984 (40MHz mostly for use in specifying ht40).
986 a 40MHz HT channel specification may include the location
987 of the extension channel by appending ``+'' or ``-'' for above and below,
988 respectively; e.g. ``2437:ht/40+'' specifies 40MHz wide HT operation
989 with the center channel at frequency 2437 and the extension channel above.
990 .It Cm country Ar name
991 Set the country code to use in calculating the regulatory constraints
993 In particular the set of available channels, how the wireless device
994 will operation on the channels, and the maximum transmit power that
995 can be used on a channel are defined by this setting.
996 Country/Region codes are specified as a 2-character abbreviation
997 defined by ISO 3166 or using a longer, but possibly ambiguous, spelling;
998 e.g. "ES" and "Spain".
999 The set of country codes are taken from /etc/regdomain.xml and can also
1000 be viewed with the ``list countries'' request.
1001 Note that not all devices support changing the country code from a default
1002 setting; typically stored in EEPROM.
1010 Enable Dynamic Frequency Selection (DFS) as specified in 802.11h.
1011 DFS embodies several facilities including detection of overlapping
1012 radar signals, dynamic transmit power control, and channel selection
1013 according to a least-congested criteria.
1014 DFS support is mandatory for some 5Ghz frequencies in certain
1015 locales (e.g. ETSI).
1016 By default DFS is enabled according to the regulatory definitions
1017 specified in /etc/regdomain.xml and the current country code, regdomain,
1019 Note the underlying device (and driver) must support radar detection
1020 for full DFS support to work.
1021 To be fully compliant with the local regulatory agency frequencies that
1022 require DFS should not be used unless it is fully supported.
1025 to disable this functionality for testing.
1027 Enable support for the 802.11d specification (default).
1028 When this support is enabled in station mode, beacon frames that advertise
1029 a country code different than the currently configured country code will
1030 cause an event to be dispatched to user applications.
1031 This event can be used by the station to adopt that country code and
1032 operate according to the associated regulatory constraints.
1033 When operating as an access point with 802.11d enabled the beacon and
1034 probe response frames transmitted will advertise the current regulatory
1036 To disable 802.11d use
1039 Enable 802.11h support including spectrum management.
1040 When 802.11h is enabled beacon and probe response frames will have
1041 the SpectrumMgt bit set in the capabilities field and
1042 country and power constraint information elements will be present.
1043 802.11h support also includes handling Channel Switch Announcements (CSA)
1044 which are a mechanism to coordinate channel changes by an access point.
1045 By default 802.11h is enabled if the device is capable.
1046 To disable 802.11h use
1048 .It Cm deftxkey Ar index
1049 Set the default key to use for transmission.
1050 Typically this is only set when using WEP encryption.
1051 Note that you must set a default transmit key
1052 for the system to know which key to use in encrypting outbound traffic.
1055 is an alias for this request; it is provided for backwards compatibility.
1056 .It Cm dtimperiod Ar period
1059 period for transmitting buffered multicast data frames when
1060 operating in ap mode.
1063 specifies the number of beacon intervals between DTIM
1064 and must be in the range 1 to 15.
1065 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
1067 Enable the use of Atheros Dynamic Turbo mode when communicating with
1068 another Dynamic Turbo-capable station.
1069 Dynamic Turbo mode is an Atheros-specific mechanism by which
1070 stations switch between normal 802.11 operation and a ``boosted''
1071 mode in which a 40MHz wide channel is used for communication.
1072 Stations using Dynamic Turbo mode operate boosted only when the
1073 channel is free of non-dturbo stations; when a non-dturbo station
1074 is identified on the channel all stations will automatically drop
1075 back to normal operation.
1076 By default, Dynamic Turbo mode is not enabled, even if the device is capable.
1077 Note that turbo mode (dynamic or static) is only allowed on some
1078 channels depending on the regulatory constraints; use the
1080 command to identify the channels where turbo mode may be used.
1081 To disable Dynamic Turbo mode use
1084 Enable Dynamic WDS (DWDS) support.
1085 DWDS is a facility by which 4-address traffic can be carried between
1086 stations operating in infrastructure mode.
1087 A station first associates to an access point and authenticates using
1088 normal procedures (e.g. WPA).
1089 Then 4-address frames are passed to carry traffic for stations
1090 operating on either side of the wireless link.
1091 DWDS extends the normal WDS mechanism by leveraging existing security
1092 protocols and eliminating static binding.
1094 When DWDS is enabled on an access point 4-address frames received from
1095 an authorized station will generate a ``DWDS discovery'' event to user
1097 This event should be used to create a WDS interface that is bound
1098 to the remote station (and usually plumbed into a bridge).
1099 Once the WDS interface is up and running 4-address traffic then logically
1100 flows through that interface.
1102 When DWDS is enabled on a station, traffic with a destination address
1103 different from the peer station are encapsulated in a 4-address frame
1104 and transmitted to the peer.
1105 All 4-address traffic uses the security information of the stations
1106 (e.g. cryptographic keys).
1107 A station is associated using 802.11n facilities may transport
1108 4-address traffic using these same mechanisms; this depends on available
1109 resources and capabilities of the device.
1110 The DWDS implementation guards against layer 2 routing loops of
1113 Enable the use of Atheros Fast Frames when communicating with
1114 another Fast Frames-capable station.
1115 Fast Frames are an encapsulation technique by which two 802.3
1116 frames are transmitted in a single 802.11 frame.
1117 This can noticeably improve throughput but requires that the
1118 receiving station understand how to decapsulate the frame.
1119 Fast frame use is negotiated using the Atheros 802.11 vendor-specific
1120 protocol extension so enabling use is safe when communicating with
1121 non-Atheros devices.
1122 By default, use of fast frames is enabled if the device is capable.
1123 To explicitly disable fast frames, use
1125 .It Cm fragthreshold Ar length
1126 Set the threshold for which transmitted frames are broken into fragments.
1129 argument is the frame size in bytes and must be in the range 256 to 2346.
1137 disables transmit fragmentation.
1138 Not all adapters honor the fragmentation threshold.
1140 When operating as an access point, do not broadcast the SSID
1141 in beacon frames or respond to probe request frames unless
1142 they are directed to the ap (i.e., they include the ap's SSID).
1143 By default, the SSID is included in beacon frames and
1144 undirected probe request frames are answered.
1145 To re-enable the broadcast of the SSID etc., use
1148 Enable use of High Throughput (HT) when using 802.11n (default).
1149 The 802.11n specification includes mechanisms for operation
1150 on 20MHz and 40MHz wide channels using different signalling mechanisms
1151 than specified in 802.11b, 802.11g, and 802.11a.
1152 Stations negotiate use of these facilities, termed HT20 and HT40,
1153 when they associate.
1154 To disable all use of 802.11n use
1156 To disable use of HT20 (e.g. to force only HT40 use) use
1158 To disable use of HT40 use
1161 HT configuration is used to ``auto promote'' operation
1162 when several choices are available.
1163 For example, if a station associates to an 11n-capable access point
1164 it controls whether the station uses legacy operation, HT20, or HT40.
1165 When an 11n-capable device is setup as an access point and
1166 Auto Channel Selection is used to locate a channel to operate on,
1167 HT configuration controls whether legacy, HT20, or HT40 operation is setup
1168 on the selected channel.
1169 If a fixed channel is specified for a station then HT configuration can
1170 be given as part of the channel specification; e.g. 6:ht/20 to setup
1171 HT20 operation on channel 6.
1173 Enable use of compatibility support for pre-802.11n devices (default).
1174 The 802.11n protocol specification went through several incompatible iterations.
1175 Some vendors implemented 11n support to older specifications that
1176 will not interoperate with a purely 11n-compliant station.
1177 In particular the information elements included in management frames
1178 for old devices are different.
1179 When compatibility support is enabled both standard and compatible data
1181 Stations that associate using the compatibility mechanisms are flagged
1183 To disable compatibility support use
1185 .It Cm htprotmode Ar technique
1186 For interfaces operating in 802.11n, use the specified
1188 for protecting HT frames in a mixed legacy/HT network.
1189 The set of valid techniques is
1194 Technique names are case insensitive.
1196 Enable inactivity processing for stations associated to an
1197 access point (default).
1198 When operating as an access point the 802.11 layer monitors
1199 the activity of each associated station.
1200 When a station is inactive for 5 minutes it will send several
1201 ``probe frames'' to see if the station is still present.
1202 If no response is received then the station is deauthenticated.
1203 Applications that prefer to handle this work can disable this
1207 Set the location to use in calculating regulatory constraints.
1208 The location is also advertised in beacon and probe response frames
1209 when 802.11d is enabled with
1218 Display the list of channels available for use taking into account
1219 any restrictions set with the
1222 See the description of
1224 for more information.
1226 Display the adaptor's capabilities, including the operating
1229 Display the list of channels available for use.
1230 Channels are shown with their IEEE channel number, equivalent
1231 frequency, and usage modes.
1232 Channels identified as
1237 Channels identified as
1239 may be used only for Atheros' Static Turbo mode
1241 . Cm mediaopt turbo ) .
1242 Channels marked with a
1244 have a regulatory constraint that they be passively scanned.
1245 This means a station is not permitted to transmit on the channel until
1246 it identifies the channel is being used for 802.11 communication;
1247 typically by hearing a beacon frame from an access point operating
1250 is another way of requesting this information.
1251 By default a compacted list of channels is displayed; if the
1253 option is specified then all channels are shown.
1254 .It Cm list countries
1255 Display the set of country codes and regulatory domains that can be
1256 used in regulatory configuration.
1258 Display the current MAC Access Control List state.
1259 Each address is prefixed with a character that indicates the
1260 current policy applied to it:
1262 indicates the address is allowed access,
1264 indicates the address is denied access,
1266 indicates the address is present but the current policy open
1267 (so the ACL is not consulted).
1269 Displays the mesh routing table, used for forwarding packets on a mesh
1271 .It Cm list regdomain
1272 Display the current regulatory settings including the available channels
1273 and transmit power caps.
1275 Display the parameters that govern roaming operation.
1277 Display the parameters that govern transmit operation.
1279 Display the transmit power caps for each channel.
1281 Display the access points and/or ad-hoc neighbors
1282 located in the vicinity.
1283 This information may be updated automatically by the adapter
1286 request or through background scanning.
1287 Depending on the capabilities of the stations the following
1288 flags can be included in the output:
1292 Indicates that the station is permitted to send/receive data frames.
1294 Extended Rate Phy (ERP).
1295 Indicates that the station is operating in an 802.11g network
1296 using extended transmit rates.
1298 High Throughput (HT).
1299 Indicates that the station is using HT transmit rates.
1300 If a `+' follows immediately after then the station associated
1301 using deprecated mechanisms supported only when
1306 Indicates that the station is operating in power save mode.
1308 Quality of Service (QoS).
1309 Indicates that the station is using QoS encapsulation for
1311 QoS encapsulation is enabled only when WME mode is enabled.
1314 Indicates that the station is doing short preamble to optionally
1315 improve throughput performance with 802.11g and 802.11b.
1317 Transitional Security Network (TSN).
1318 Indicates that the station associated using TSN; see also
1322 Wi-Fi Protected Setup (WPS).
1323 Indicates that the station associated using WPS.
1326 By default interesting information elements captured from the neighboring
1327 stations are displayed at the end of each row.
1328 Possible elements include:
1330 (station supports WME),
1332 (station supports WPA),
1334 (station supports WPS),
1336 (station supports 802.11i/RSN),
1338 (station supports 802.11n/HT communication),
1340 (station supports Atheros protocol extensions),
1342 (station supports unknown vendor-specific extensions).
1345 flag is used all the information elements and their
1346 contents will be shown.
1349 flag also enables display of long SSIDs.
1352 command is another way of requesting this information.
1354 When operating as an access point display the stations that are
1355 currently associated.
1356 When operating in ad-hoc mode display stations identified as
1357 neighbors in the IBSS.
1358 When operating in mesh mode display stations identified as
1359 neighbors in the MBSS.
1360 When operating in station mode display the access point.
1361 Capabilities advertised by the stations are described under
1365 Depending on the capabilities of the stations the following
1366 flags can be included in the output:
1370 Indicates that the station is permitted to send/receive data frames.
1372 Extended Rate Phy (ERP).
1373 Indicates that the station is operating in an 802.11g network
1374 using extended transmit rates.
1376 High Throughput (HT).
1377 Indicates that the station is using HT transmit rates.
1378 If a `+' follows immediately after then the station associated
1379 using deprecated mechanisms supported only when
1384 Indicates that the station is operating in power save mode.
1386 Quality of Service (QoS).
1387 Indicates that the station is using QoS encapsulation for
1389 QoS encapsulation is enabled only when WME mode is enabled.
1392 Indicates that the station is doing short preamble to optionally
1393 improve throughput performance with 802.11g and 802.11b.
1395 Transitional Security Network (TSN).
1396 Indicates that the station associated using TSN; see also
1400 Wi-Fi Protected Setup (WPS).
1401 Indicates that the station associated using WPS.
1404 By default information elements received from associated stations
1405 are displayed in a short form; the
1407 flag causes this information to be displayed symbolically.
1409 Display the current channel parameters to use when operating in WME mode.
1412 option is specified then both channel and BSS parameters are displayed
1413 for each AC (first channel, then BSS).
1414 When WME mode is enabled for an adaptor this information will be
1415 displayed with the regular status; this command is mostly useful
1416 for examining parameters when WME mode is disabled.
1417 See the description of the
1419 directive for information on the various parameters.
1420 .It Cm maxretry Ar count
1421 Set the maximum number of tries to use in sending unicast frames.
1422 The default setting is 6 but drivers may override this with a value
1424 .It Cm mcastrate Ar rate
1425 Set the rate for transmitting multicast/broadcast frames.
1426 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
1427 This rate should be valid for the current operating conditions;
1428 if an invalid rate is specified drivers are free to chose an
1430 .It Cm mgtrate Ar rate
1431 Set the rate for transmitting management and/or control frames.
1432 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
1434 Set the location to use in calculating regulatory constraints.
1435 The location is also advertised in beacon and probe response frames
1436 when 802.11d is enabled with
1445 Enable powersave operation.
1446 When operating as a client, the station will conserve power by
1447 periodically turning off the radio and listening for
1448 messages from the access point telling it there are packets waiting.
1449 The station must then retrieve the packets.
1450 Not all devices support power save operation as a client.
1451 The 802.11 specification requires that all access points support
1452 power save but some drivers do not.
1455 to disable powersave operation when operating as a client.
1456 .It Cm powersavesleep Ar sleep
1457 Set the desired max powersave sleep time in TU's (1024 usecs).
1458 By default the max powersave sleep time is 100 TU's.
1459 .It Cm protmode Ar technique
1460 For interfaces operating in 802.11g, use the specified
1462 for protecting OFDM frames in a mixed 11b/11g network.
1463 The set of valid techniques is
1469 Technique names are case insensitive.
1470 Not all devices support
1472 as a protection technique.
1474 When operating as an access point in 802.11g mode allow only
1475 11g-capable stations to associate (11b-only stations are not
1476 permitted to associate).
1477 To allow both 11g and 11b-only stations to associate, use
1480 When operating as an access point in 802.11n mode allow only
1481 HT-capable stations to associate (legacy stations are not
1482 permitted to associate).
1483 To allow both HT and legacy stations to associate, use
1485 .It Cm regdomain Ar sku
1486 Set the regulatory domain to use in calculating the regulatory constraints
1488 In particular the set of available channels, how the wireless device
1489 will operation on the channels, and the maximum transmit power that
1490 can be used on a channel are defined by this setting.
1491 Regdomain codes (SKU's) are taken from /etc/regdomain.xml and can also
1492 be viewed with the ``list countries'' request.
1493 Note that not all devices support changing the regdomain from a default
1494 setting; typically stored in EEPROM.
1502 Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n
1504 Note that RIFS must be supported by both the station and access point
1508 .It Cm roam:rate Ar rate
1509 Set the threshold for controlling roaming when operating in a BSS.
1512 parameter specifies the transmit rate in megabits
1513 at which roaming should be considered.
1514 If the current transmit rate drops below this setting and background scanning
1515 is enabled, then the system will check if a more desirable access point is
1516 available and switch over to it.
1517 The current scan cache contents are used if they are considered
1518 valid according to the
1520 parameter; otherwise a background scan operation is triggered before
1521 any selection occurs.
1522 Each channel type has a separate rate threshold; the default values are:
1523 12 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng).
1524 .It Cm roam:rssi Ar rssi
1525 Set the threshold for controlling roaming when operating in a BSS.
1528 parameter specifies the receive signal strength in dBm units
1529 at which roaming should be considered.
1530 If the current rssi drops below this setting and background scanning
1531 is enabled, then the system will check if a more desirable access point is
1532 available and switch over to it.
1533 The current scan cache contents are used if they are considered
1534 valid according to the
1536 parameter; otherwise a background scan operation is triggered before
1537 any selection occurs.
1538 Each channel type has a separate rssi threshold; the default values are
1540 .It Cm roaming Ar mode
1541 When operating as a station, control how the system will
1542 behave when communication with the current access point
1546 argument may be one of
1548 (leave it to the hardware device to decide),
1550 (handle either in the device or the operating system\[em]as appropriate),
1552 (do nothing until explicitly instructed).
1553 By default, the device is left to handle this if it is
1554 capable; otherwise, the operating system will automatically
1555 attempt to reestablish communication.
1556 Manual mode is used by applications such as
1557 .Xr wpa_supplicant 8
1558 that want to control the selection of an access point.
1559 .It Cm rtsthreshold Ar length
1560 Set the threshold for which
1561 transmitted frames are preceded by transmission of an
1567 is the frame size in bytes and must be in the range 1 to 2346.
1575 disables transmission of RTS frames.
1576 Not all adapters support setting the RTS threshold.
1578 Initiate a scan of neighboring stations, wait for it to complete, and
1579 display all stations found.
1580 Only the super-user can initiate a scan.
1583 for information on the display.
1584 By default a background scan is done; otherwise a foreground
1585 scan is done and the station may roam to a different access point.
1588 request can be used to show recent scan results without
1589 initiating a new scan.
1590 .It Cm scanvalid Ar threshold
1591 Set the maximum time the scan cache contents are considered valid;
1592 i.e. will be used without first triggering a scan operation to
1596 parameter is specified in seconds and defaults to 60 seconds.
1597 The minimum setting for
1600 One should take care setting this threshold; if it is set too low
1601 then attempts to roam to another access point may trigger unnecessary
1602 background scan operations.
1604 Enable use of Short Guard Interval when operating in 802.11n
1606 NB: this currently enables Short GI on both HT40 and HT20 channels.
1607 To disable Short GI use
1610 Enable use of Static Spatial Multiplexing Power Save (SMPS)
1611 when operating in 802.11n.
1612 A station operating with Static SMPS maintains only a single
1613 receive chain active (this can significantly reduce power consumption).
1617 Enable use of Dynamic Spatial Multiplexing Power Save (SMPS)
1618 when operating in 802.11n.
1619 A station operating with Dynamic SMPS maintains only a single
1620 receive chain active but switches to multiple receive chains when it
1621 receives an RTS frame (this can significantly reduce power consumption).
1622 Note that stations cannot distinguish between RTS/CTS intended to
1623 enable multiple receive chains and those used for other purposes.
1627 Set the desired Service Set Identifier (aka network name).
1628 The SSID is a string up to 32 characters
1629 in length and may be specified as either a normal string or in
1630 hexadecimal when preceded by
1632 Additionally, the SSID may be cleared by setting it to
1634 .It Cm tdmaslot Ar slot
1635 When operating with TDMA, use the specified
1640 is a number between 0 and the maximum number of slots in the BSS.
1641 Note that a station configured as slot 0 is a master and
1642 will broadcast beacon frames advertising the BSS;
1643 stations configured to use other slots will always
1644 scan to locate a master before they ever transmit.
1648 .It Cm tdmaslotcnt Ar cnt
1649 When operating with TDMA, setup a BSS with
1652 The slot count may be at most 8.
1653 The current implementation is only tested with two stations
1654 (i.e. point to point applications).
1655 This setting is only meaningful when a station is configured as slot 0;
1656 other stations adopt this setting from the BSS they join.
1660 .It Cm tdmaslotlen Ar len
1661 When operating with TDMA, setup a BSS such that each station has a slot
1664 The slot length must be at least 150 microseconds (1/8 TU)
1665 and no more than 65 milliseconds.
1666 Note that setting too small a slot length may result in poor channel
1667 bandwidth utilization due to factors such as timer granularity and
1669 This setting is only meaningful when a station is configured as slot 0;
1670 other stations adopt this setting from the BSS they join.
1673 is set to 10 milliseconds.
1674 .It Cm tdmabintval Ar intval
1675 When operating with TDMA, setup a BSS such that beacons are transmitted every
1677 superframes to synchronize the TDMA slot timing.
1678 A superframe is defined as the number of slots times the slot length; e.g.
1679 a BSS with two slots of 10 milliseconds has a 20 millisecond superframe.
1680 The beacon interval may not be zero.
1683 causes the timers to be resynchronized more often; this can be help if
1684 significant timer drift is observed.
1689 When operating as an access point with WPA/802.11i allow legacy
1690 stations to associate using static key WEP and open authentication.
1691 To disallow legacy station use of WEP, use
1693 .It Cm txpower Ar power
1694 Set the power used to transmit frames.
1697 argument is specified in .5 dBm units.
1698 Out of range values are truncated.
1699 Typically only a few discreet power settings are available and
1700 the driver will use the setting closest to the specified value.
1701 Not all adapters support changing the transmit power.
1702 .It Cm ucastrate Ar rate
1703 Set a fixed rate for transmitting unicast frames.
1704 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
1705 This rate should be valid for the current operating conditions;
1706 if an invalid rate is specified drivers are free to chose an
1708 .It Cm wepmode Ar mode
1709 Set the desired WEP mode.
1710 Not all adapters support all modes.
1711 The set of valid modes is
1717 mode explicitly tells the adaptor to allow association with access
1718 points which allow both encrypted and unencrypted traffic.
1721 means that the access point must only allow encrypted connections.
1724 is generally another name for
1726 Modes are case insensitive.
1727 .It Cm weptxkey Ar index
1728 Set the WEP key to be used for transmission.
1729 This is the same as setting the default transmission key with
1731 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
1732 Set the selected WEP key.
1735 is not given, key 1 is set.
1736 A WEP key will be either 5 or 13
1737 characters (40 or 104 bits) depending on the local network and the
1738 capabilities of the adaptor.
1739 It may be specified either as a plain
1740 string or as a string of hexadecimal digits preceded by
1742 For maximum portability, hex keys are recommended;
1743 the mapping of text keys to WEP encryption is usually driver-specific.
1746 drivers do this mapping differently to
1748 A key may be cleared by setting it to
1750 If WEP is supported then there are at least four keys.
1751 Some adapters support more than four keys.
1752 If that is the case, then the first four keys
1753 (1-4) will be the standard temporary keys and any others will be adaptor
1754 specific keys such as permanent keys stored in NVRAM.
1756 Note that you must set a default transmit key with
1758 for the system to know which key to use in encrypting outbound traffic.
1760 Enable Wireless Multimedia Extensions (WME) support, if available,
1761 for the specified interface.
1762 WME is a subset of the IEEE 802.11e standard to support the
1763 efficient communication of realtime and multimedia data.
1764 To disable WME support, use
1766 Another name for this parameter is
1769 The following parameters are meaningful only when WME support is in use.
1770 Parameters are specified per-AC (Access Category) and
1771 split into those that are used by a station when acting
1772 as an access point and those for client stations in the BSS.
1773 The latter are received from the access point and may not be changed
1775 The following Access Categories are recognized:
1777 .Bl -tag -width ".Cm AC_BK" -compact
1781 best effort delivery,
1796 AC parameters are case-insensitive.
1797 Traffic classification is done in the operating system using the
1798 vlan priority associated with data frames or the
1799 ToS (Type of Service) indication in IP-encapsulated frames.
1800 If neither information is present, traffic is assigned to the
1801 Best Effort (BE) category.
1802 .Bl -tag -width indent
1804 Set the ACK policy for QoS transmissions by the local station;
1805 this controls whether or not data frames transmitted by a station
1806 require an ACK response from the receiving station.
1807 To disable waiting for an ACK use
1809 This parameter is applied only to the local station.
1811 Enable the Admission Control Mandatory (ACM) mechanism
1812 for transmissions by the local station.
1813 To disable the ACM use
1815 On stations in a BSS this parameter is read-only and indicates
1816 the setting received from the access point.
1817 NB: ACM is not supported right now.
1818 .It Cm aifs Ar ac Ar count
1819 Set the Arbitration Inter Frame Spacing (AIFS)
1820 channel access parameter to use for transmissions
1821 by the local station.
1822 On stations in a BSS this parameter is read-only and indicates
1823 the setting received from the access point.
1824 .It Cm cwmin Ar ac Ar count
1825 Set the CWmin channel access parameter to use for transmissions
1826 by the local station.
1827 On stations in a BSS this parameter is read-only and indicates
1828 the setting received from the access point.
1829 .It Cm cwmax Ar ac Ar count
1830 Set the CWmax channel access parameter to use for transmissions
1831 by the local station.
1832 On stations in a BSS this parameter is read-only and indicates
1833 the setting received from the access point.
1834 .It Cm txoplimit Ar ac Ar limit
1835 Set the Transmission Opportunity Limit channel access parameter
1836 to use for transmissions by the local station.
1837 This parameter defines an interval of time when a WME station
1838 has the right to initiate transmissions onto the wireless medium.
1839 On stations in a BSS this parameter is read-only and indicates
1840 the setting received from the access point.
1841 .It Cm bss:aifs Ar ac Ar count
1842 Set the AIFS channel access parameter to send to stations in a BSS.
1843 This parameter is meaningful only when operating in ap mode.
1844 .It Cm bss:cwmin Ar ac Ar count
1845 Set the CWmin channel access parameter to send to stations in a BSS.
1846 This parameter is meaningful only when operating in ap mode.
1847 .It Cm bss:cwmax Ar ac Ar count
1848 Set the CWmax channel access parameter to send to stations in a BSS.
1849 This parameter is meaningful only when operating in ap mode.
1850 .It Cm bss:txoplimit Ar ac Ar limit
1851 Set the TxOpLimit channel access parameter to send to stations in a BSS.
1852 This parameter is meaningful only when operating in ap mode.
1855 Enable Wireless Privacy Subscriber support.
1856 Note that WPS support requires a WPS-capable supplicant.
1857 To disable this function use
1861 The following parameters support an optional access control list
1862 feature available with some adapters when operating in ap mode; see
1864 This facility allows an access point to accept/deny association
1865 requests based on the MAC address of the station.
1866 Note that this feature does not significantly enhance security
1867 as MAC address spoofing is easy to do.
1868 .Bl -tag -width indent
1869 .It Cm mac:add Ar address
1870 Add the specified MAC address to the database.
1871 Depending on the policy setting association requests from the
1872 specified station will be allowed or denied.
1874 Set the ACL policy to permit association only by
1875 stations registered in the database.
1876 .It Cm mac:del Ar address
1877 Delete the specified MAC address from the database.
1879 Set the ACL policy to deny association only by
1880 stations registered in the database.
1881 .It Cm mac:kick Ar address
1882 Force the specified station to be deauthenticated.
1883 This typically is done to block a station after updating the
1886 Set the ACL policy to allow all stations to associate.
1888 Delete all entries in the database.
1890 Set the ACL policy to permit association only by
1891 stations approved by a RADIUS server.
1892 Note that this feature requires the
1894 program be configured to do the right thing
1895 as it handles the RADIUS processing
1896 (and marks stations as authorized).
1899 The following parameters are related to a wireless interface operating in mesh
1901 .Bl -tag -width indent
1902 .It Cm meshid Ar meshid
1903 Set the desired Mesh Identifier.
1904 The Mesh ID is a string up to 32 characters in length.
1905 A mesh interface must have a Mesh Identifier specified
1906 to reach an operational state.
1907 .It Cm meshttl Ar ttl
1908 Set the desired ``time to live'' for mesh forwarded packets;
1909 this is the number of hops a packet may be forwarded before
1911 The default setting for
1915 Enable or disable peering with neighbor mesh stations.
1916 Stations must peer before any data packets can be exchanged.
1921 Enable or disable forwarding packets by a mesh interface.
1925 .It Cm meshmetric Ar protocol
1928 as the link metric protocol used on a mesh network.
1929 The default protocol is called
1931 The mesh interface will restart after changing this setting.
1932 .It Cm meshpath Ar protocol
1935 as the path selection protocol used on a mesh network.
1936 The only available protocol at the moment is called
1938 (Hybrid Wireless Mesh Protocol).
1939 The mesh interface will restart after changing this setting.
1940 .It Cm hwmprootmode Ar mode
1941 Stations on a mesh network can operate as ``root nodes.''
1942 Root nodes try to find paths to all mesh nodes and advertise themselves
1944 When there is a root mesh node on a network, other mesh nodes can setup
1945 paths between themselves faster because they can use the root node
1946 to find the destination.
1947 This path may not be the best, but on-demand
1948 routing will eventually find the best path.
1949 The following modes are recognized:
1951 .Bl -tag -width ".Cm PROACTIVE" -compact
1955 Send broadcast path requests every two seconds.
1956 Nodes on the mesh without a path to this root mesh station with try to
1957 discover a path to us.
1959 Send broadcast path requests every two seconds and every node must reply with
1960 with a path reply even if it already has a path to this root mesh station.
1962 Send broadcast root announcement (RANN) frames.
1963 Nodes on the mesh without a path to this root mesh station with try to
1964 discover a path to us.
1970 .It Cm hwmpmaxhops Ar cnt
1971 Set the maximum number of hops allowed in an HMWP path to
1973 The default setting for
1978 The following parameters are for compatibility with other systems:
1979 .Bl -tag -width indent
1981 Another name for the
1987 .It Cm stationname Ar name
1988 Set the name of this station.
1989 The station name is not part of the IEEE 802.11
1990 protocol though some interfaces support it.
1992 seems to be meaningful to identical or virtually identical equipment.
1993 Setting the station name is identical in syntax to setting the SSID.
2000 Another way of saying
2006 Another way of saying
2012 Another way of saying:
2013 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
2019 .Ar n : k1 , k2 , k3 , k4
2022 Another way of saying
2023 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
2028 Another way of saying
2035 The following parameters are specific to bridge interfaces:
2036 .Bl -tag -width indent
2037 .It Cm addm Ar interface
2038 Add the interface named by
2040 as a member of the bridge.
2041 The interface is put into promiscuous mode
2042 so that it can receive every packet sent on the network.
2043 .It Cm deletem Ar interface
2044 Remove the interface named by
2047 Promiscuous mode is disabled on the interface when
2048 it is removed from the bridge.
2049 .It Cm maxaddr Ar size
2050 Set the size of the bridge address cache to
2052 The default is 100 entries.
2053 .It Cm timeout Ar seconds
2054 Set the timeout of address cache entries to
2059 is zero, then address cache entries will not be expired.
2060 The default is 240 seconds.
2062 Display the addresses that have been learned by the bridge.
2063 .It Cm static Ar interface-name Ar address
2064 Add a static entry into the address cache pointing to
2065 .Ar interface-name .
2066 Static entries are never aged out of the cache or re-placed, even if the
2067 address is seen on a different interface.
2068 .It Cm deladdr Ar address
2071 from the address cache.
2073 Delete all dynamically-learned addresses from the address cache.
2075 Delete all addresses, including static addresses, from the address cache.
2076 .It Cm discover Ar interface
2077 Mark an interface as a
2080 When the bridge has no address cache entry
2081 (either dynamic or static)
2082 for the destination address of a packet,
2083 the bridge will forward the packet to all
2084 member interfaces marked as
2086 This is the default for all interfaces added to a bridge.
2087 .It Cm -discover Ar interface
2090 attribute on a member interface.
2091 For packets without the
2093 attribute, the only packets forwarded on the interface are broadcast
2094 or multicast packets and packets for which the destination address
2095 is known to be on the interface's segment.
2096 .It Cm learn Ar interface
2097 Mark an interface as a
2100 When a packet arrives on such an interface, the source
2101 address of the packet is entered into the address cache as being a
2102 destination address on the interface's segment.
2103 This is the default for all interfaces added to a bridge.
2104 .It Cm -learn Ar interface
2107 attribute on a member interface.
2108 .It Cm sticky Ar interface
2109 Mark an interface as a
2112 Dynamically learned address entries are treated at static once entered into
2114 Sticky entries are never aged out of the cache or replaced, even if the
2115 address is seen on a different interface.
2116 .It Cm -sticky Ar interface
2119 attribute on a member interface.
2120 .It Cm private Ar interface
2121 Mark an interface as a
2124 A private interface does not forward any traffic to any other port that is also
2125 a private interface.
2126 .It Cm -private Ar interface
2129 attribute on a member interface.
2130 .It Cm span Ar interface
2131 Add the interface named by
2133 as a span port on the bridge.
2134 Span ports transmit a copy of every frame received by the bridge.
2135 This is most useful for snooping a bridged network passively on
2136 another host connected to one of the span ports of the bridge.
2137 .It Cm -span Ar interface
2138 Delete the interface named by
2140 from the list of span ports of the bridge.
2141 .It Cm stp Ar interface
2142 Enable Spanning Tree protocol on
2146 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
2147 Spanning Tree is used to detect and remove loops in a network topology.
2148 .It Cm -stp Ar interface
2149 Disable Spanning Tree protocol on
2151 This is the default for all interfaces added to a bridge.
2152 .It Cm edge Ar interface
2156 An edge port connects directly to end stations cannot create bridging
2157 loops in the network, this allows it to transition straight to forwarding.
2158 .It Cm -edge Ar interface
2159 Disable edge status on
2161 .It Cm autoedge Ar interface
2164 to automatically detect edge status.
2165 This is the default for all interfaces added to a bridge.
2166 .It Cm -autoedge Ar interface
2167 Disable automatic edge status on
2169 .It Cm ptp Ar interface
2172 as a point to point link.
2173 This is required for straight transitions to forwarding and
2174 should be enabled on a direct link to another RSTP capable switch.
2175 .It Cm -ptp Ar interface
2176 Disable point to point link status on
2178 This should be disabled for a half duplex link and for an interface
2179 connected to a shared network segment,
2180 like a hub or a wireless network.
2181 .It Cm autoptp Ar interface
2182 Automatically detect the point to point status on
2184 by checking the full duplex link status.
2185 This is the default for interfaces added to the bridge.
2186 .It Cm -autoptp Ar interface
2187 Disable automatic point to point link detection on
2189 .It Cm maxage Ar seconds
2190 Set the time that a Spanning Tree protocol configuration is valid.
2191 The default is 20 seconds.
2192 The minimum is 6 seconds and the maximum is 40 seconds.
2193 .It Cm fwddelay Ar seconds
2194 Set the time that must pass before an interface begins forwarding
2195 packets when Spanning Tree is enabled.
2196 The default is 15 seconds.
2197 The minimum is 4 seconds and the maximum is 30 seconds.
2198 .It Cm hellotime Ar seconds
2199 Set the time between broadcasting of Spanning Tree protocol
2200 configuration messages.
2201 The hello time may only be changed when operating in legacy stp mode.
2202 The default is 2 seconds.
2203 The minimum is 1 second and the maximum is 2 seconds.
2204 .It Cm priority Ar value
2205 Set the bridge priority for Spanning Tree.
2206 The default is 32768.
2207 The minimum is 0 and the maximum is 61440.
2208 .It Cm proto Ar value
2209 Set the Spanning Tree protocol.
2210 The default is rstp.
2211 The available options are stp and rstp.
2212 .It Cm holdcnt Ar value
2213 Set the transmit hold count for Spanning Tree.
2214 This is the number of packets transmitted before being rate limited.
2216 The minimum is 1 and the maximum is 10.
2217 .It Cm ifpriority Ar interface Ar value
2218 Set the Spanning Tree priority of
2223 The minimum is 0 and the maximum is 240.
2224 .It Cm ifpathcost Ar interface Ar value
2225 Set the Spanning Tree path cost of
2229 The default is calculated from the link speed.
2230 To change a previously selected path cost back to automatic, set the
2232 The minimum is 1 and the maximum is 200000000.
2233 .It Cm ifmaxaddr Ar interface Ar size
2234 Set the maximum number of hosts allowed from an interface, packets with unknown
2235 source addresses are dropped until an existing host cache entry expires or is
2237 Set to 0 to disable.
2240 The following parameters are specific to lagg interfaces:
2241 .Bl -tag -width indent
2242 .It Cm laggport Ar interface
2243 Add the interface named by
2245 as a port of the aggregation interface.
2246 .It Cm -laggport Ar interface
2247 Remove the interface named by
2249 from the aggregation interface.
2250 .It Cm laggproto Ar proto
2251 Set the aggregation protocol.
2252 The default is failover.
2253 The available options are failover, fec, lacp, loadbalance, roundrobin and
2257 The following parameters are specific to IP tunnel interfaces,
2259 .Bl -tag -width indent
2260 .It Cm tunnel Ar src_addr dest_addr
2261 Configure the physical source and destination address for IP tunnel
2267 are interpreted as the outer source/destination for the encapsulating
2270 Unconfigure the physical source and destination address for IP tunnel
2271 interfaces previously configured with
2274 Another name for the
2277 .It Cm accept_rev_ethip_ver
2278 Set a flag to accept both correct EtherIP packets and ones
2279 with reversed version field. Enabled by default.
2280 This is for backward compatibility with
2282 6.2, 6.3, 7.0, and 7.1.
2283 .It Cm -accept_rev_ethip_ver
2285 .Cm accept_rev_ethip_ver .
2286 .It Cm send_rev_ethip_ver
2287 Set a flag to send EtherIP packets with reversed version
2288 field intentionally. Disabled by default.
2289 This is for backward compatibility with
2291 6.2, 6.3, 7.0, and 7.1.
2292 .It Cm -send_rev_ethip_ver
2294 .Cm send_rev_ethip_ver .
2297 The following parameters are specific to GRE tunnel interfaces,
2299 .Bl -tag -width indent
2300 .It Cm grekey Ar key
2301 Configure the GRE key to be used for outgoing packets.
2303 .Xr gre 4 will always accept GRE packets with invalid or absent keys.
2304 This command will result in a four byte MTU reduction on the interface.
2307 The following parameters are specific to
2310 .Bl -tag -width indent
2312 Set the maximum number of updates for a single state which
2313 can be collapsed into one.
2314 This is an 8-bit number; the default value is 128.
2317 The following parameters are specific to
2320 .Bl -tag -width indent
2321 .It Cm vlan Ar vlan_tag
2322 Set the VLAN tag value to
2324 This value is a 16-bit number which is used to create an 802.1Q
2325 VLAN header for packets sent from the
2332 must both be set at the same time.
2333 .It Cm vlandev Ar iface
2334 Associate the physical interface
2339 Packets transmitted through the
2342 diverted to the specified physical interface
2344 with 802.1Q VLAN encapsulation.
2345 Packets with 802.1Q encapsulation received
2346 by the parent interface with the correct VLAN tag will be diverted to
2352 interface is assigned a
2353 copy of the parent interface's flags and the parent's ethernet address.
2358 must both be set at the same time.
2361 interface already has
2362 a physical interface associated with it, this command will fail.
2364 change the association to another physical interface, the existing
2365 association must be cleared first.
2367 Note: if the hardware tagging capability
2368 is set on the parent interface, the
2371 interface's behavior changes:
2374 interface recognizes that the
2375 parent interface supports insertion and extraction of VLAN tags on its
2376 own (usually in firmware) and that it should pass packets to and from
2377 the parent unaltered.
2378 .It Fl vlandev Op Ar iface
2381 pseudo device, disassociate the parent interface from it.
2382 This breaks the link between the
2384 interface and its parent,
2385 clears its VLAN tag, flags and its link address and shuts the interface down.
2388 argument is useless and hence deprecated.
2391 The following parameters are specific to
2394 .Bl -tag -width indent
2395 .It Cm advbase Ar seconds
2396 Specifies the base of the advertisement interval in seconds.
2397 The acceptable values are 1 to 255.
2398 The default value is 1.
2399 .\" The default value is
2400 .\" .Dv CARP_DFLTINTV .
2401 .It Cm advskew Ar interval
2402 Specifies the skew to add to the base advertisement interval to
2403 make one host advertise slower than another host.
2404 It is specified in 1/256 of seconds.
2405 The acceptable values are 1 to 254.
2406 The default value is 0.
2407 .It Cm pass Ar phrase
2408 Set the authentication key to
2411 Set the virtual host ID.
2412 This is a required setting.
2413 Acceptable values are 1 to 255.
2418 utility displays the current configuration for a network interface
2419 when no optional parameters are supplied.
2420 If a protocol family is specified,
2422 will report only the details specific to that protocol family.
2426 flag is passed before an interface name,
2428 will display the capability list and all
2429 of the supported media for the specified interface.
2432 flag is supplied, address lifetime is displayed for IPv6 addresses,
2433 as time offset string.
2437 flag may be used instead of an interface name.
2440 to display information about all interfaces in the system.
2443 flag limits this to interfaces that are down, and
2445 limits this to interfaces that are up.
2446 When no arguments are given,
2452 flag may be used to list all available interfaces on the system, with
2453 no other additional information.
2454 Use of this flag is mutually exclusive
2455 with all other flags and commands, except for
2457 (only list interfaces that are down)
2460 (only list interfaces that are up).
2464 flag may be used to get more verbose status for an interface.
2468 flag may be used to list all of the interface cloners available on
2469 the system, with no additional information.
2470 Use of this flag is mutually exclusive with all other flags and commands.
2474 flag causes keying information for the interface, if available, to be
2476 For example, the values of 802.11 WEP keys will be printed, if accessible to
2478 This information is not printed by default, as it may be considered
2481 If the network interface driver is not present in the kernel then
2483 will attempt to load it.
2486 flag disables this behavior.
2488 Only the super-user may modify the configuration of a network interface.
2490 The media selection system is relatively new and only some drivers support
2491 it (or have need for it).
2493 Assign the IPv4 address
2495 with a network mask of
2499 .Dl # ifconfig fxp0 inet 192.0.2.10 netmask 255.255.255.0
2501 Add the IPv4 address
2503 with the CIDR network prefix
2509 as a synonym for the canonical form of the option
2511 .Dl # ifconfig ed0 inet 192.0.2.45/28 add
2513 Remove the IPv4 address
2517 .Dl # ifconfig ed0 inet 192.0.2.45 -alias
2519 Enable IPv6 functionality of the interface:
2520 .Dl # ifconfig em0 inet6 -ifdisabled
2522 Add the IPv6 address
2523 .Li 2001:DB8:DBDB::123/48
2526 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias
2527 Note that lower case hexadecimal IPv6 addresses are acceptable.
2529 Remove the IPv6 address added in the above example,
2532 character as shorthand for the network prefix,
2535 as a synonym for the canonical form of the option
2537 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 delete
2539 Configure the interface
2541 to use 100baseTX, full duplex Ethernet media options:
2542 .Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex
2544 Label the em0 interface as an uplink:
2545 .Dl # ifconfig em0 description \&"Uplink to Gigabit Switch 2\&"
2547 Create the software network interface
2549 .Dl # ifconfig gif1 create
2551 Destroy the software network interface
2553 .Dl # ifconfig gif1 destroy
2555 Display available wireless networks using
2557 .Dl # ifconfig wlan0 list scan
2559 Messages indicating the specified interface does not exist, the
2560 requested address is unknown, or the user is not privileged and
2561 tried to alter an interface's configuration.
2581 Basic IPv6 node operation requires a link-local address on each
2582 interface configured for IPv6.
2583 Normally, such an address is automatically configured by the
2584 kernel on each interface added to the system or enabled; this behavior may
2585 be disabled by setting per-interface flag
2586 .Cm -auto_linklocal .
2587 The default value of this flag is 1 and can be disabled by using the sysctl
2589 .Va net.inet6.ip6.auto_linklocal .
2591 Do not configure IPv6 addresses with no link-local address by using
2593 It can result in unexpected behaviors of the kernel.