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.
144 This can be used to, for example,
145 set a new MAC address on an Ethernet interface, though the
146 mechanism used is not Ethernet specific.
147 If the interface is already
148 up when this option is used, it will be briefly brought down and
149 then brought back up again in order to ensure that the receive
150 filter in the underlying Ethernet hardware is properly reprogrammed.
151 .It Ar address_family
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
163 The default if available is
176 address family has special meaning and is no longer synonymous with
182 will list only Ethernet interfaces, excluding all other interface types,
183 including the loopback interface.
185 Specify the address of the correspondent on the other end
186 of a point to point link.
189 parameter is a string of the form
194 List the interfaces in the given group.
197 The following parameters may be set with
199 .Bl -tag -width indent
204 Introduced for compatibility
208 Establish an additional network address for this interface.
209 This is sometimes useful when changing network numbers, and
210 one wishes to accept packets addressed to the old interface.
211 If the address is on the same subnet as the first network address
212 for this interface, a non-conflicting netmask must be given.
217 Remove the network address specified.
218 This would be used if you incorrectly specified an alias, or it
219 was no longer needed.
220 If you have incorrectly set an NS address having the side effect
221 of specifying the host portion, removing all NS addresses will
222 allow you to respecify the host portion.
225 Specify that the address configured is an anycast address.
226 Based on the current specification,
227 only routers may configure anycast addresses.
228 Anycast address will not be used as source address of any of outgoing
231 Enable the use of the Address Resolution Protocol
234 between network level addresses and link level addresses (default).
235 This is currently implemented for mapping between
240 802 48-bit MAC addresses (Ethernet, FDDI, and Token Ring addresses).
242 Disable the use of the Address Resolution Protocol
245 If the Address Resolution Protocol is enabled,
246 the host will only reply to requests for its addresses,
247 and will never send any requests.
249 If the Address Resolution Protocol is enabled,
250 the host will perform normally,
251 sending out requests and listening for replies.
254 Specify the address to use to represent broadcasts to the
256 The default broadcast address is the address with a host part of all 1's.
258 Enable driver dependent debugging code; usually, this turns on
259 extra console error logging.
261 Disable driver dependent debugging code.
263 Put interface into permanently promiscuous mode.
265 Disable permanently promiscuous mode.
270 .It Cm description Ar value , Cm descr Ar value
271 Specify a description of the interface.
272 This can be used to label interfaces in situations where they may
273 otherwise be difficult to distinguish.
274 .It Cm -description , Cm -descr
275 Clear the interface description.
279 When an interface is marked
281 the system will not attempt to
282 transmit messages through that interface.
283 If possible, the interface will be reset to disable reception as well.
284 This action does not automatically disable routes using the interface.
285 .It Cm group Ar group-name
286 Assign the interface to a
288 Any interface can be in multiple groups.
290 Cloned interfaces are members of their interface family group by default.
291 For example, a PPP interface such as
293 is a member of the PPP interface family group,
295 .\" The interface(s) the default route(s) point to are members of the
298 .It Cm -group Ar group-name
299 Remove the interface from the given
304 (lowermost 64bit of an IPv6 address)
306 .It Cm fib Ar fib_number
307 Specify interface FIB.
310 is assigned to all frames or packets received on that interface.
311 The FIB is not inherited, e.g., vlans or other sub-interfaces will use
312 the default FIB (0) irrespective of the parent interface's FIB.
313 The kernel needs to be tuned to support more than the default FIB
316 kernel configuration option, or the
319 .It Cm maclabel Ar label
320 If Mandatory Access Control support is enabled in the kernel,
324 .\" .Xr maclabel 7 ) .
326 If the driver supports the media selection system, set the media type
329 Some interfaces support the mutually exclusive use of one of several
330 different physical media connectors.
331 For example, a 10Mbit/s Ethernet
332 interface might support the use of either
334 or twisted pair connectors.
335 Setting the media type to
337 would change the currently active connector to the AUI port.
340 would activate twisted pair.
341 Refer to the interfaces' driver
342 specific documentation or man page for a complete list of the
344 .It Cm mediaopt Ar opts
345 If the driver supports the media selection system, set the specified
346 media options on the interface.
350 is a comma delimited list of options to apply to the interface.
351 Refer to the interfaces' driver specific man page for a complete
352 list of available options.
353 .It Fl mediaopt Ar opts
354 If the driver supports the media selection system, disable the
355 specified media options on the interface.
357 If the driver supports the media selection system, set the specified
358 operating mode on the interface to
360 For IEEE 802.11 wireless interfaces that support multiple operating modes
361 this directive is used to select between 802.11a
368 .It Cm inst Ar minst , Cm instance Ar minst
369 Set the media instance to
371 This is useful for devices which have multiple physical layer interfaces
374 Set the interface name to
376 .It Cm rxcsum , txcsum , rxcsum6 , txcsum6
377 If the driver supports user-configurable checksum offloading,
378 enable receive (or transmit) checksum offloading on the interface.
379 The feature can be turned on selectively per protocol family.
381 .Cm rxcsum6 , txcsum6
387 Some drivers may not be able to enable these flags independently
388 of each other, so setting one may also set the other.
389 The driver will offload as much checksum work as it can reliably
390 support, the exact level of offloading varies between drivers.
391 .It Fl rxcsum , txcsum , rxcsum6 , txcsum6
392 If the driver supports user-configurable checksum offloading,
393 disable receive (or transmit) checksum offloading on the interface.
394 The feature can be turned off selectively per protocol family.
396 .Fl rxcsum6 , txcsum6
402 These settings may not always be independent of each other.
404 If the driver supports
406 segmentation offloading, enable TSO on the interface.
407 Some drivers may not be able to support TSO for
411 packets, so they may enable only one of them.
413 If the driver supports
415 segmentation offloading, disable TSO on the interface.
416 It will always disable TSO for
421 If the driver supports
423 segmentation offloading for
427 use one of these to selectively enabled it only for one protocol family.
429 If the driver supports
431 segmentation offloading for
435 use one of these to selectively disable it only for one protocol family.
437 If the driver supports
439 large receive offloading, enable LRO on the interface.
441 If the driver supports
443 large receive offloading, disable LRO on the interface.
444 .It Cm wol , wol_ucast , wol_mcast , wol_magic
445 Enable Wake On Lan (WOL) support, if available.
446 WOL is a facility whereby a machine in a low power state may be woken
447 in response to a received packet.
448 There are three types of packets that may wake a system:
449 ucast (directed solely to the machine's mac address),
450 mcast (directed to a broadcast or multicast address),
452 magic (unicast or multicast frames with a ``magic contents'').
453 Not all devices support WOL, those that do indicate the mechanisms
454 they support in their capabilities.
456 is a synonym for enabling all available WOL mechanisms.
459 .It Cm vlanmtu , vlanhwtag, vlanhwfilter, vlanhwcsum, vlanhwtso
460 If the driver offers user-configurable VLAN support, enable
461 reception of extended frames, tag processing in hardware,
462 frame filtering in hardware, checksum offloading, or TSO on VLAN,
464 Note that this must be issued on a physical interface associated with
469 .It Fl vlanmtu , vlanhwtag, vlanhwfilter, vlanhwtso
470 If the driver offers user-configurable VLAN support, disable
471 reception of extended frames, tag processing in hardware,
472 frame filtering in hardware, or TSO on VLAN,
475 Move the interface to the
477 specified by name or JID.
478 If the jail has a virtual network stack, the interface will disappear
479 from the current environment and become visible to the jail.
481 Reclaim the interface from the
483 specified by name or JID.
484 If the jail has a virtual network stack, the interface will disappear
485 from the jail, and become visible to the current network environment.
489 feature and disable interrupts on the interface, if driver supports
494 feature and enable interrupt mode on the interface.
496 Create the specified network pseudo-device.
497 If the interface is given without a unit number, try to create a new
498 device with an arbitrary unit number.
499 If creation of an arbitrary device is successful, the new device name is
500 printed to standard output unless the interface is renamed or destroyed
505 Destroy the specified network pseudo-device.
521 Set the routing metric of the interface to
524 The routing metric is used by the routing protocol
526 Higher metrics have the effect of making a route
527 less favorable; metrics are counted as additional hops
528 to the destination network or host.
530 Set the maximum transmission unit of the interface to
532 default is interface specific.
533 The MTU is used to limit the size of packets that are transmitted on an
535 Not all interfaces support setting the MTU, and some interfaces have
537 .It Cm netmask Ar mask
540 Specify how much of the address to reserve for subdividing
541 networks into sub-networks.
542 The mask includes the network part of the local address
543 and the subnet part, which is taken from the host field of the address.
544 The mask can be specified as a single hexadecimal number
547 with a dot-notation Internet address,
548 or with a pseudo-network name listed in the network table
550 The mask contains 1's for the bit positions in the 32-bit address
551 which are to be used for the network and subnet parts,
552 and 0's for the host part.
553 The mask should contain at least the standard network portion,
554 and the subnet field should be contiguous with the network
557 The netmask can also be specified in CIDR notation after the address.
560 option above for more information.
561 .It Cm prefixlen Ar len
565 bits are reserved for subdividing networks into sub-networks.
568 must be integer, and for syntactical reason it must be between 0 to 128.
569 It is almost always 64 under the current IPv6 assignment rule.
570 If the parameter is omitted, 64 is used.
572 The prefix can also be specified using the slash notation after the address.
575 option above for more information.
580 Introduced for compatibility
584 .It Cm link Op Cm 0 No - Cm 2
586 Enable special processing of the link level of the interface.
587 These three options are interface specific in actual effect, however,
588 they are in general used to select special modes of operation.
590 of this is to enable SLIP compression, or to select the connector type
591 for some Ethernet cards.
592 Refer to the man page for the specific driver
593 for more information.
595 .It Fl link Op Cm 0 No - Cm 2
597 Disable special processing at the link level with the specified interface.
599 Put the interface in monitor mode.
600 No packets are transmitted, and received packets are discarded after
604 Take the interface out of monitor mode.
608 This may be used to enable an interface after an
610 It happens automatically when setting the first address on an interface.
611 If the interface was reset when previously marked down,
612 the hardware will be re-initialized.
615 The following parameters are for ICMPv6 Neighbor Discovery Protocol.
616 Note that the address family keyword
619 .Bl -tag -width indent
621 Set a flag to enable accepting ICMPv6 Router Advertisement messages.
625 .Va net.inet6.ip6.accept_rtadv
626 controls whether this flag is set by default or not.
631 Set a flag to control whether routers from which the system accepts
632 Router Advertisement messages will be added to the Default Router List
636 flag is disabled, this flag has no effect.
640 .Va net.inet6.ip6.no_radr
641 controls whether this flag is set by default or not.
645 .It Cm auto_linklocal
646 Set a flag to perform automatic link-local address configuration when
647 the interface becomes available.
651 .Va net.inet6.ip6.auto_linklocal
652 controls whether this flag is set by default or not.
653 .It Cm -auto_linklocal
657 Set the specified interface as the default route when there is no
663 Set a flag to disable all of IPv6 network communications on the
665 Note that if there are already configured IPv6
666 addresses on that interface, all of them are marked as
668 and DAD will be performed when this flag is cleared.
672 When this flag is cleared and
674 flag is enabled, automatic configuration of a link-local address is
677 Set a flag to enable Neighbor Unreachability Detection.
681 .It Cm no_prefer_iface
682 Set a flag to not honor rule 5 of source address selection in RFC 3484.
683 In practice this means the address on the outgoing interface will not be
684 preferred, effectively yielding the decision to the address selection
685 policy table, configurable with
687 .It Cm -no_prefer_iface
689 .Cm no_prefer_iface .
692 The following parameters are specific for IPv6 addresses.
693 Note that the address family keyword
696 .Bl -tag -width indent
698 Set a flag to prefer address as a candidate of the source address for
700 .It Cm -prefer_source
705 The following parameters are specific to cloning
706 IEEE 802.11 wireless interfaces with the
709 .Bl -tag -width indent
710 .It Cm wlandev Ar device
713 as the parent for the cloned device.
714 .It Cm wlanmode Ar mode
715 Specify the operating mode for this cloned device.
733 The operating mode of a cloned interface cannot be changed.
736 mode is actually implemented as an
738 interface with special properties.
739 .It Cm wlanbssid Ar bssid
740 The 802.11 mac address to use for the bssid.
741 This must be specified at create time for a legacy
744 .It Cm wlanaddr Ar address
745 The local mac address.
746 If this is not specified then a mac address will automatically be assigned
747 to the cloned device.
748 Typically this address is the same as the address of the parent device
751 parameter is specified then the driver will craft a unique address for
752 the device (if supported).
756 device as operating in ``legacy mode''.
759 devices have a fixed peer relationship and do not, for example, roam
760 if their peer stops communicating.
761 For completeness a Dynamic WDS (DWDS) interface may marked as
764 Request a unique local mac address for the cloned device.
765 This is only possible if the device supports multiple mac addresses.
766 To force use of the parent's mac address use
769 Mark the cloned interface as depending on hardware support to
770 track received beacons.
771 To have beacons tracked in software use
777 can also be used to indicate no beacons should
778 be transmitted; this can be useful when creating a WDS configuration but
780 interfaces can only be created as companions to an access point.
783 The following parameters are specific to IEEE 802.11 wireless interfaces
787 .Bl -tag -width indent
789 Enable sending and receiving AMPDU frames when using 802.11n (default).
790 The 802.11n specification states a compliant station must be capable
791 of receiving AMPDU frames but transmission is optional.
794 to disable all use of AMPDU with 802.11n.
795 For testing and/or to work around interoperability problems one can use
799 to control use of AMPDU in one direction.
800 .It Cm ampdudensity Ar density
801 Set the AMPDU density parameter used when operating with 802.11n.
802 This parameter controls the inter-packet gap for AMPDU frames.
803 The sending device normally controls this setting but a receiving station
804 may request wider gaps.
807 are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds).
810 is treated the same as 0.
811 .It Cm ampdulimit Ar limit
812 Set the limit on packet size for receiving AMPDU frames when operating
816 are 8192, 16384, 32768, and 65536 but one can also specify
817 just the unique prefix: 8, 16, 32, 64.
818 Note the sender may limit the size of AMPDU frames to be less
819 than the maximum specified by the receiving station.
821 Enable sending and receiving AMSDU frames when using 802.11n.
822 By default AMSDU is received but not transmitted.
825 to disable all use of AMSDU with 802.11n.
826 For testing and/or to work around interoperability problems one can use
830 to control use of AMSDU in one direction.
831 .It Cm amsdulimit Ar limit
832 Set the limit on packet size for sending and receiving AMSDU frames
833 when operating with 802.11n.
836 are 7935 and 3839 (bytes).
837 Note the sender may limit the size of AMSDU frames to be less
838 than the maximum specified by the receiving station.
839 Note also that devices are not required to support the 7935 limit,
840 only 3839 is required by the specification and the larger value
841 may require more memory to be dedicated to support functionality
844 When operating as an access point, pass packets between
845 wireless clients directly (default).
846 To instead let them pass up through the
847 system and be forwarded using some other mechanism, use
849 Disabling the internal bridging
850 is useful when traffic is to be processed with
852 .It Cm authmode Ar mode
853 Set the desired authentication mode in infrastructure mode.
854 Not all adapters support all modes.
857 .Cm none , open , shared
863 (IEEE WPA/WPA2/802.11i).
868 modes are only useful when using an authentication service
869 (a supplicant for client operation or an authenticator when
870 operating as an access point).
871 Modes are case insensitive.
873 Enable background scanning when operating as a station.
874 Background scanning is a technique whereby a station associated to
875 an access point will temporarily leave the channel to scan for
876 neighboring stations.
877 This allows a station to maintain a cache of nearby access points
878 so that roaming between access points can be done without
879 a lengthy scan operation.
880 Background scanning is done only when a station is not busy and
881 any outbound traffic will cancel a scan operation.
882 Background scanning should never cause packets to be lost though
883 there may be some small latency if outbound traffic interrupts a
885 By default background scanning is enabled if the device is capable.
886 To disable background scanning, use
888 Background scanning is controlled by the
893 Background scanning must be enabled for roaming; this is an artifact
894 of the current implementation and may not be required in the future.
895 .It Cm bgscanidle Ar idletime
896 Set the minimum time a station must be idle (not transmitting or
897 receiving frames) before a background scan is initiated.
900 parameter is specified in milliseconds.
901 By default a station must be idle at least 250 milliseconds before
902 a background scan is initiated.
903 The idle time may not be set to less than 100 milliseconds.
904 .It Cm bgscanintvl Ar interval
905 Set the interval at which background scanning is attempted.
908 parameter is specified in seconds.
909 By default a background scan is considered every 300 seconds (5 minutes).
912 may not be set to less than 15 seconds.
913 .It Cm bintval Ar interval
914 Set the interval at which beacon frames are sent when operating in
918 parameter is specified in TU's (1024 usecs).
919 By default beacon frames are transmitted every 100 TU's.
920 .It Cm bmissthreshold Ar count
921 Set the number of consecutive missed beacons at which the station
922 will attempt to roam (i.e., search for a new access point).
925 parameter must be in the range 1 to 255; though the
926 upper bound may be reduced according to device capabilities.
927 The default threshold is 7 consecutive missed beacons; but
928 this may be overridden by the device driver.
933 .It Cm bssid Ar address
934 Specify the MAC address of the access point to use when operating
935 as a station in a BSS network.
936 This overrides any automatic selection done by the system.
937 To disable a previously selected access point, supply
942 This option is useful when more than one access point uses the same SSID.
948 Enable packet bursting.
949 Packet bursting is a transmission technique whereby the wireless
950 medium is acquired once to send multiple frames and the interframe
952 This technique can significantly increase throughput by reducing
953 transmission overhead.
954 Packet bursting is supported by the 802.11e QoS specification
955 and some devices that do not support QoS may still be capable.
956 By default packet bursting is enabled if a device is capable
958 To disable packet bursting, use
960 .It Cm chanlist Ar channels
961 Set the desired channels to use when scanning for access
962 points, neighbors in an IBSS network, or looking for unoccupied
963 channels when operating as an access point.
964 The set of channels is specified as a comma-separated list with
965 each element in the list representing either a single channel number or a range
968 Channel numbers must be in the range 1 to 255 and be permissible
969 according to the operating characteristics of the device.
970 .It Cm channel Ar number
971 Set a single desired channel.
972 Channels range from 1 to 255, but the exact selection available
973 depends on the region your adaptor was manufactured for.
979 will clear any desired channel and, if the device is marked up,
980 force a scan for a channel to operate on.
981 Alternatively the frequency, in megahertz, may be specified
982 instead of the channel number.
984 When there are several ways to use a channel the channel
985 number/frequency may be appended with attributes to clarify.
986 For example, if a device is capable of operating on channel 6
987 with 802.11n and 802.11g then one can specify that g-only use
988 should be used by specifying ``6:g''.
989 Similarly the channel width can be specified by appending it
990 with ``/''; e.g., ``6/40'' specifies a 40MHz wide channel,
991 These attributes can be combined as in: ``6:ht/40''.
992 The full set of flags specified following a ``:'' are:
998 (Atheros Dynamic Turbo mode),
1006 (Atheros Static Turbo mode),
1009 (Atheros Dynamic Turbo mode, or appended to ``st'' and ``dt'').
1010 The full set of channel widths following a '/' are:
1012 (5MHz aka quarter-rate channel),
1014 (10MHz aka half-rate channel),
1016 (20MHz mostly for use in specifying ht20),
1019 (40MHz mostly for use in specifying ht40).
1021 a 40MHz HT channel specification may include the location
1022 of the extension channel by appending ``+'' or ``-'' for above and below,
1023 respectively; e.g., ``2437:ht/40+'' specifies 40MHz wide HT operation
1024 with the center channel at frequency 2437 and the extension channel above.
1025 .It Cm country Ar name
1026 Set the country code to use in calculating the regulatory constraints
1028 In particular the set of available channels, how the wireless device
1029 will operation on the channels, and the maximum transmit power that
1030 can be used on a channel are defined by this setting.
1031 Country/Region codes are specified as a 2-character abbreviation
1032 defined by ISO 3166 or using a longer, but possibly ambiguous, spelling;
1033 e.g., "ES" and "Spain".
1034 The set of country codes are taken from
1035 .Pa /etc/regdomain.xml
1037 be viewed with the ``list countries'' request.
1038 Note that not all devices support changing the country code from a default
1039 setting; typically stored in EEPROM.
1047 Enable Dynamic Frequency Selection (DFS) as specified in 802.11h.
1048 DFS embodies several facilities including detection of overlapping
1049 radar signals, dynamic transmit power control, and channel selection
1050 according to a least-congested criteria.
1051 DFS support is mandatory for some 5GHz frequencies in certain
1052 locales (e.g., ETSI).
1053 By default DFS is enabled according to the regulatory definitions
1055 .Pa /etc/regdomain.xml
1056 and the current country code, regdomain,
1058 Note the underlying device (and driver) must support radar detection
1059 for full DFS support to work.
1060 To be fully compliant with the local regulatory agency frequencies that
1061 require DFS should not be used unless it is fully supported.
1064 to disable this functionality for testing.
1066 Enable support for the 802.11d specification (default).
1067 When this support is enabled in station mode, beacon frames that advertise
1068 a country code different than the currently configured country code will
1069 cause an event to be dispatched to user applications.
1070 This event can be used by the station to adopt that country code and
1071 operate according to the associated regulatory constraints.
1072 When operating as an access point with 802.11d enabled the beacon and
1073 probe response frames transmitted will advertise the current regulatory
1075 To disable 802.11d use
1078 Enable 802.11h support including spectrum management.
1079 When 802.11h is enabled beacon and probe response frames will have
1080 the SpectrumMgt bit set in the capabilities field and
1081 country and power constraint information elements will be present.
1082 802.11h support also includes handling Channel Switch Announcements (CSA)
1083 which are a mechanism to coordinate channel changes by an access point.
1084 By default 802.11h is enabled if the device is capable.
1085 To disable 802.11h use
1087 .It Cm deftxkey Ar index
1088 Set the default key to use for transmission.
1089 Typically this is only set when using WEP encryption.
1090 Note that you must set a default transmit key
1091 for the system to know which key to use in encrypting outbound traffic.
1094 is an alias for this request; it is provided for backwards compatibility.
1095 .It Cm dtimperiod Ar period
1098 period for transmitting buffered multicast data frames when
1099 operating in ap mode.
1102 specifies the number of beacon intervals between DTIM
1103 and must be in the range 1 to 15.
1104 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
1106 Enable the use of quiet IE.
1107 Hostap will use this to silence other
1108 stations to reduce interference for radar detection when
1109 operating on 5GHz frequency and doth support is enabled.
1112 to disable this functionality.
1113 .It Cm quiet_period Ar period
1116 to the number of beacon intervals between the start of regularly
1117 scheduled quiet intervals defined by Quiet element.
1118 .It Cm quiet_count Ar count
1121 to the number of TBTTs until the beacon interval during which the
1122 next quiet interval shall start.
1123 A value of 1 indicates the quiet
1124 interval will start during the beacon interval starting at the next
1126 A value 0 is reserved.
1127 .It Cm quiet_offset Ar offset
1130 to the offset of the start of the quiet interval from the TBTT
1131 specified by the Quiet count, expressed in TUs.
1134 shall be less than one beacon interval.
1135 .It Cm quiet_duration Ar dur
1138 to the duration of the Quiet interval, expressed in TUs.
1139 The value should be less than beacon interval.
1141 Enable the use of Atheros Dynamic Turbo mode when communicating with
1142 another Dynamic Turbo-capable station.
1143 Dynamic Turbo mode is an Atheros-specific mechanism by which
1144 stations switch between normal 802.11 operation and a ``boosted''
1145 mode in which a 40MHz wide channel is used for communication.
1146 Stations using Dynamic Turbo mode operate boosted only when the
1147 channel is free of non-dturbo stations; when a non-dturbo station
1148 is identified on the channel all stations will automatically drop
1149 back to normal operation.
1150 By default, Dynamic Turbo mode is not enabled, even if the device is capable.
1151 Note that turbo mode (dynamic or static) is only allowed on some
1152 channels depending on the regulatory constraints; use the
1154 command to identify the channels where turbo mode may be used.
1155 To disable Dynamic Turbo mode use
1158 Enable Dynamic WDS (DWDS) support.
1159 DWDS is a facility by which 4-address traffic can be carried between
1160 stations operating in infrastructure mode.
1161 A station first associates to an access point and authenticates using
1162 normal procedures (e.g., WPA).
1163 Then 4-address frames are passed to carry traffic for stations
1164 operating on either side of the wireless link.
1165 DWDS extends the normal WDS mechanism by leveraging existing security
1166 protocols and eliminating static binding.
1168 When DWDS is enabled on an access point 4-address frames received from
1169 an authorized station will generate a ``DWDS discovery'' event to user
1171 This event should be used to create a WDS interface that is bound
1172 to the remote station (and usually plumbed into a bridge).
1173 Once the WDS interface is up and running 4-address traffic then logically
1174 flows through that interface.
1176 When DWDS is enabled on a station, traffic with a destination address
1177 different from the peer station are encapsulated in a 4-address frame
1178 and transmitted to the peer.
1179 All 4-address traffic uses the security information of the stations
1180 (e.g., cryptographic keys).
1181 A station is associated using 802.11n facilities may transport
1182 4-address traffic using these same mechanisms; this depends on available
1183 resources and capabilities of the device.
1184 The DWDS implementation guards against layer 2 routing loops of
1187 Enable the use of Atheros Fast Frames when communicating with
1188 another Fast Frames-capable station.
1189 Fast Frames are an encapsulation technique by which two 802.3
1190 frames are transmitted in a single 802.11 frame.
1191 This can noticeably improve throughput but requires that the
1192 receiving station understand how to decapsulate the frame.
1193 Fast frame use is negotiated using the Atheros 802.11 vendor-specific
1194 protocol extension so enabling use is safe when communicating with
1195 non-Atheros devices.
1196 By default, use of fast frames is enabled if the device is capable.
1197 To explicitly disable fast frames, use
1199 .It Cm fragthreshold Ar length
1200 Set the threshold for which transmitted frames are broken into fragments.
1203 argument is the frame size in bytes and must be in the range 256 to 2346.
1211 disables transmit fragmentation.
1212 Not all adapters honor the fragmentation threshold.
1214 When operating as an access point, do not broadcast the SSID
1215 in beacon frames or respond to probe request frames unless
1216 they are directed to the ap (i.e., they include the ap's SSID).
1217 By default, the SSID is included in beacon frames and
1218 undirected probe request frames are answered.
1219 To re-enable the broadcast of the SSID etc., use
1222 Enable use of High Throughput (HT) when using 802.11n (default).
1223 The 802.11n specification includes mechanisms for operation
1224 on 20MHz and 40MHz wide channels using different signalling mechanisms
1225 than specified in 802.11b, 802.11g, and 802.11a.
1226 Stations negotiate use of these facilities, termed HT20 and HT40,
1227 when they associate.
1228 To disable all use of 802.11n use
1230 To disable use of HT20 (e.g., to force only HT40 use) use
1232 To disable use of HT40 use
1235 HT configuration is used to ``auto promote'' operation
1236 when several choices are available.
1237 For example, if a station associates to an 11n-capable access point
1238 it controls whether the station uses legacy operation, HT20, or HT40.
1239 When an 11n-capable device is setup as an access point and
1240 Auto Channel Selection is used to locate a channel to operate on,
1241 HT configuration controls whether legacy, HT20, or HT40 operation is setup
1242 on the selected channel.
1243 If a fixed channel is specified for a station then HT configuration can
1244 be given as part of the channel specification; e.g., 6:ht/20 to setup
1245 HT20 operation on channel 6.
1247 Enable use of compatibility support for pre-802.11n devices (default).
1248 The 802.11n protocol specification went through several incompatible iterations.
1249 Some vendors implemented 11n support to older specifications that
1250 will not interoperate with a purely 11n-compliant station.
1251 In particular the information elements included in management frames
1252 for old devices are different.
1253 When compatibility support is enabled both standard and compatible data
1255 Stations that associate using the compatibility mechanisms are flagged
1257 To disable compatibility support use
1259 .It Cm htprotmode Ar technique
1260 For interfaces operating in 802.11n, use the specified
1262 for protecting HT frames in a mixed legacy/HT network.
1263 The set of valid techniques is
1268 Technique names are case insensitive.
1270 Enable inactivity processing for stations associated to an
1271 access point (default).
1272 When operating as an access point the 802.11 layer monitors
1273 the activity of each associated station.
1274 When a station is inactive for 5 minutes it will send several
1275 ``probe frames'' to see if the station is still present.
1276 If no response is received then the station is deauthenticated.
1277 Applications that prefer to handle this work can disable this
1281 Set the location to use in calculating regulatory constraints.
1282 The location is also advertised in beacon and probe response frames
1283 when 802.11d is enabled with
1292 Display the list of channels available for use taking into account
1293 any restrictions set with the
1296 See the description of
1298 for more information.
1300 Display the adaptor's capabilities, including the operating
1303 Display the list of channels available for use.
1304 Channels are shown with their IEEE channel number, equivalent
1305 frequency, and usage modes.
1306 Channels identified as
1311 Channels identified as
1313 may be used only for Atheros' Static Turbo mode
1315 . Cm mediaopt turbo ) .
1316 Channels marked with a
1318 have a regulatory constraint that they be passively scanned.
1319 This means a station is not permitted to transmit on the channel until
1320 it identifies the channel is being used for 802.11 communication;
1321 typically by hearing a beacon frame from an access point operating
1324 is another way of requesting this information.
1325 By default a compacted list of channels is displayed; if the
1327 option is specified then all channels are shown.
1328 .It Cm list countries
1329 Display the set of country codes and regulatory domains that can be
1330 used in regulatory configuration.
1332 Display the current MAC Access Control List state.
1333 Each address is prefixed with a character that indicates the
1334 current policy applied to it:
1336 indicates the address is allowed access,
1338 indicates the address is denied access,
1340 indicates the address is present but the current policy open
1341 (so the ACL is not consulted).
1343 Displays the mesh routing table, used for forwarding packets on a mesh
1345 .It Cm list regdomain
1346 Display the current regulatory settings including the available channels
1347 and transmit power caps.
1349 Display the parameters that govern roaming operation.
1351 Display the parameters that govern transmit operation.
1353 Display the transmit power caps for each channel.
1355 Display the access points and/or ad-hoc neighbors
1356 located in the vicinity.
1357 This information may be updated automatically by the adapter
1360 request or through background scanning.
1361 Depending on the capabilities of the stations the following
1362 flags can be included in the output:
1366 Indicates that the station is permitted to send/receive data frames.
1368 Extended Rate Phy (ERP).
1369 Indicates that the station is operating in an 802.11g network
1370 using extended transmit rates.
1372 High Throughput (HT).
1373 Indicates that the station is using HT transmit rates.
1374 If a `+' follows immediately after then the station associated
1375 using deprecated mechanisms supported only when
1380 Indicates that the station is operating in power save mode.
1382 Quality of Service (QoS).
1383 Indicates that the station is using QoS encapsulation for
1385 QoS encapsulation is enabled only when WME mode is enabled.
1388 Indicates that the station is doing short preamble to optionally
1389 improve throughput performance with 802.11g and 802.11b.
1391 Transitional Security Network (TSN).
1392 Indicates that the station associated using TSN; see also
1396 Wi-Fi Protected Setup (WPS).
1397 Indicates that the station associated using WPS.
1400 By default interesting information elements captured from the neighboring
1401 stations are displayed at the end of each row.
1402 Possible elements include:
1404 (station supports WME),
1406 (station supports WPA),
1408 (station supports WPS),
1410 (station supports 802.11i/RSN),
1412 (station supports 802.11n/HT communication),
1414 (station supports Atheros protocol extensions),
1416 (station supports unknown vendor-specific extensions).
1419 flag is used all the information elements and their
1420 contents will be shown.
1423 flag also enables display of long SSIDs.
1426 command is another way of requesting this information.
1428 When operating as an access point display the stations that are
1429 currently associated.
1430 When operating in ad-hoc mode display stations identified as
1431 neighbors in the IBSS.
1432 When operating in mesh mode display stations identified as
1433 neighbors in the MBSS.
1434 When operating in station mode display the access point.
1435 Capabilities advertised by the stations are described under
1439 Depending on the capabilities of the stations the following
1440 flags can be included in the output:
1444 Indicates that the station is permitted to send/receive data frames.
1446 Extended Rate Phy (ERP).
1447 Indicates that the station is operating in an 802.11g network
1448 using extended transmit rates.
1450 High Throughput (HT).
1451 Indicates that the station is using HT transmit rates.
1452 If a `+' follows immediately after then the station associated
1453 using deprecated mechanisms supported only when
1458 Indicates that the station is operating in power save mode.
1460 Quality of Service (QoS).
1461 Indicates that the station is using QoS encapsulation for
1463 QoS encapsulation is enabled only when WME mode is enabled.
1466 Indicates that the station is doing short preamble to optionally
1467 improve throughput performance with 802.11g and 802.11b.
1469 Transitional Security Network (TSN).
1470 Indicates that the station associated using TSN; see also
1474 Wi-Fi Protected Setup (WPS).
1475 Indicates that the station associated using WPS.
1478 By default information elements received from associated stations
1479 are displayed in a short form; the
1481 flag causes this information to be displayed symbolically.
1483 Display the current channel parameters to use when operating in WME mode.
1486 option is specified then both channel and BSS parameters are displayed
1487 for each AC (first channel, then BSS).
1488 When WME mode is enabled for an adaptor this information will be
1489 displayed with the regular status; this command is mostly useful
1490 for examining parameters when WME mode is disabled.
1491 See the description of the
1493 directive for information on the various parameters.
1494 .It Cm maxretry Ar count
1495 Set the maximum number of tries to use in sending unicast frames.
1496 The default setting is 6 but drivers may override this with a value
1498 .It Cm mcastrate Ar rate
1499 Set the rate for transmitting multicast/broadcast frames.
1500 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1501 This rate should be valid for the current operating conditions;
1502 if an invalid rate is specified drivers are free to chose an
1504 .It Cm mgtrate Ar rate
1505 Set the rate for transmitting management and/or control frames.
1506 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1508 Set the location to use in calculating regulatory constraints.
1509 The location is also advertised in beacon and probe response frames
1510 when 802.11d is enabled with
1519 Enable powersave operation.
1520 When operating as a client, the station will conserve power by
1521 periodically turning off the radio and listening for
1522 messages from the access point telling it there are packets waiting.
1523 The station must then retrieve the packets.
1524 Not all devices support power save operation as a client.
1525 The 802.11 specification requires that all access points support
1526 power save but some drivers do not.
1529 to disable powersave operation when operating as a client.
1530 .It Cm powersavesleep Ar sleep
1531 Set the desired max powersave sleep time in TU's (1024 usecs).
1532 By default the max powersave sleep time is 100 TU's.
1533 .It Cm protmode Ar technique
1534 For interfaces operating in 802.11g, use the specified
1536 for protecting OFDM frames in a mixed 11b/11g network.
1537 The set of valid techniques is
1543 Technique names are case insensitive.
1544 Not all devices support
1546 as a protection technique.
1548 When operating as an access point in 802.11g mode allow only
1549 11g-capable stations to associate (11b-only stations are not
1550 permitted to associate).
1551 To allow both 11g and 11b-only stations to associate, use
1554 When operating as an access point in 802.11n mode allow only
1555 HT-capable stations to associate (legacy stations are not
1556 permitted to associate).
1557 To allow both HT and legacy stations to associate, use
1559 .It Cm regdomain Ar sku
1560 Set the regulatory domain to use in calculating the regulatory constraints
1562 In particular the set of available channels, how the wireless device
1563 will operation on the channels, and the maximum transmit power that
1564 can be used on a channel are defined by this setting.
1565 Regdomain codes (SKU's) are taken from
1566 .Pa /etc/regdomain.xml
1568 be viewed with the ``list countries'' request.
1569 Note that not all devices support changing the regdomain from a default
1570 setting; typically stored in EEPROM.
1578 Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n
1580 Note that RIFS must be supported by both the station and access point
1584 .It Cm roam:rate Ar rate
1585 Set the threshold for controlling roaming when operating in a BSS.
1588 parameter specifies the transmit rate in megabits
1589 at which roaming should be considered.
1590 If the current transmit rate drops below this setting and background scanning
1591 is enabled, then the system will check if a more desirable access point is
1592 available and switch over to it.
1593 The current scan cache contents are used if they are considered
1594 valid according to the
1596 parameter; otherwise a background scan operation is triggered before
1597 any selection occurs.
1598 Each channel type has a separate rate threshold; the default values are:
1599 12 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng).
1600 .It Cm roam:rssi Ar rssi
1601 Set the threshold for controlling roaming when operating in a BSS.
1604 parameter specifies the receive signal strength in dBm units
1605 at which roaming should be considered.
1606 If the current rssi drops below this setting and background scanning
1607 is enabled, then the system will check if a more desirable access point is
1608 available and switch over to it.
1609 The current scan cache contents are used if they are considered
1610 valid according to the
1612 parameter; otherwise a background scan operation is triggered before
1613 any selection occurs.
1614 Each channel type has a separate rssi threshold; the default values are
1616 .It Cm roaming Ar mode
1617 When operating as a station, control how the system will
1618 behave when communication with the current access point
1622 argument may be one of
1624 (leave it to the hardware device to decide),
1626 (handle either in the device or the operating system\[em]as appropriate),
1628 (do nothing until explicitly instructed).
1629 By default, the device is left to handle this if it is
1630 capable; otherwise, the operating system will automatically
1631 attempt to reestablish communication.
1632 Manual mode is used by applications such as
1633 .Xr wpa_supplicant 8
1634 that want to control the selection of an access point.
1635 .It Cm rtsthreshold Ar length
1636 Set the threshold for which
1637 transmitted frames are preceded by transmission of an
1643 is the frame size in bytes and must be in the range 1 to 2346.
1651 disables transmission of RTS frames.
1652 Not all adapters support setting the RTS threshold.
1654 Initiate a scan of neighboring stations, wait for it to complete, and
1655 display all stations found.
1656 Only the super-user can initiate a scan.
1659 for information on the display.
1660 By default a background scan is done; otherwise a foreground
1661 scan is done and the station may roam to a different access point.
1664 request can be used to show recent scan results without
1665 initiating a new scan.
1666 .It Cm scanvalid Ar threshold
1667 Set the maximum time the scan cache contents are considered valid;
1668 i.e., will be used without first triggering a scan operation to
1672 parameter is specified in seconds and defaults to 60 seconds.
1673 The minimum setting for
1676 One should take care setting this threshold; if it is set too low
1677 then attempts to roam to another access point may trigger unnecessary
1678 background scan operations.
1680 Enable use of Short Guard Interval when operating in 802.11n
1682 NB: this currently enables Short GI on both HT40 and HT20 channels.
1683 To disable Short GI use
1686 Enable use of Static Spatial Multiplexing Power Save (SMPS)
1687 when operating in 802.11n.
1688 A station operating with Static SMPS maintains only a single
1689 receive chain active (this can significantly reduce power consumption).
1693 Enable use of Dynamic Spatial Multiplexing Power Save (SMPS)
1694 when operating in 802.11n.
1695 A station operating with Dynamic SMPS maintains only a single
1696 receive chain active but switches to multiple receive chains when it
1697 receives an RTS frame (this can significantly reduce power consumption).
1698 Note that stations cannot distinguish between RTS/CTS intended to
1699 enable multiple receive chains and those used for other purposes.
1703 Set the desired Service Set Identifier (aka network name).
1704 The SSID is a string up to 32 characters
1705 in length and may be specified as either a normal string or in
1706 hexadecimal when preceded by
1708 Additionally, the SSID may be cleared by setting it to
1710 .It Cm tdmaslot Ar slot
1711 When operating with TDMA, use the specified
1716 is a number between 0 and the maximum number of slots in the BSS.
1717 Note that a station configured as slot 0 is a master and
1718 will broadcast beacon frames advertising the BSS;
1719 stations configured to use other slots will always
1720 scan to locate a master before they ever transmit.
1724 .It Cm tdmaslotcnt Ar cnt
1725 When operating with TDMA, setup a BSS with
1728 The slot count may be at most 8.
1729 The current implementation is only tested with two stations
1730 (i.e., point to point applications).
1731 This setting is only meaningful when a station is configured as slot 0;
1732 other stations adopt this setting from the BSS they join.
1736 .It Cm tdmaslotlen Ar len
1737 When operating with TDMA, setup a BSS such that each station has a slot
1740 The slot length must be at least 150 microseconds (1/8 TU)
1741 and no more than 65 milliseconds.
1742 Note that setting too small a slot length may result in poor channel
1743 bandwidth utilization due to factors such as timer granularity and
1745 This setting is only meaningful when a station is configured as slot 0;
1746 other stations adopt this setting from the BSS they join.
1749 is set to 10 milliseconds.
1750 .It Cm tdmabintval Ar intval
1751 When operating with TDMA, setup a BSS such that beacons are transmitted every
1753 superframes to synchronize the TDMA slot timing.
1754 A superframe is defined as the number of slots times the slot length; e.g.,
1755 a BSS with two slots of 10 milliseconds has a 20 millisecond superframe.
1756 The beacon interval may not be zero.
1759 causes the timers to be resynchronized more often; this can be help if
1760 significant timer drift is observed.
1765 When operating as an access point with WPA/802.11i allow legacy
1766 stations to associate using static key WEP and open authentication.
1767 To disallow legacy station use of WEP, use
1769 .It Cm txpower Ar power
1770 Set the power used to transmit frames.
1773 argument is specified in .5 dBm units.
1774 Out of range values are truncated.
1775 Typically only a few discreet power settings are available and
1776 the driver will use the setting closest to the specified value.
1777 Not all adapters support changing the transmit power.
1778 .It Cm ucastrate Ar rate
1779 Set a fixed rate for transmitting unicast frames.
1780 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1781 This rate should be valid for the current operating conditions;
1782 if an invalid rate is specified drivers are free to chose an
1784 .It Cm wepmode Ar mode
1785 Set the desired WEP mode.
1786 Not all adapters support all modes.
1787 The set of valid modes is
1793 mode explicitly tells the adaptor to allow association with access
1794 points which allow both encrypted and unencrypted traffic.
1797 means that the access point must only allow encrypted connections.
1800 is generally another name for
1802 Modes are case insensitive.
1803 .It Cm weptxkey Ar index
1804 Set the WEP key to be used for transmission.
1805 This is the same as setting the default transmission key with
1807 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
1808 Set the selected WEP key.
1811 is not given, key 1 is set.
1812 A WEP key will be either 5 or 13
1813 characters (40 or 104 bits) depending on the local network and the
1814 capabilities of the adaptor.
1815 It may be specified either as a plain
1816 string or as a string of hexadecimal digits preceded by
1818 For maximum portability, hex keys are recommended;
1819 the mapping of text keys to WEP encryption is usually driver-specific.
1822 drivers do this mapping differently to
1824 A key may be cleared by setting it to
1826 If WEP is supported then there are at least four keys.
1827 Some adapters support more than four keys.
1828 If that is the case, then the first four keys
1829 (1-4) will be the standard temporary keys and any others will be adaptor
1830 specific keys such as permanent keys stored in NVRAM.
1832 Note that you must set a default transmit key with
1834 for the system to know which key to use in encrypting outbound traffic.
1836 Enable Wireless Multimedia Extensions (WME) support, if available,
1837 for the specified interface.
1838 WME is a subset of the IEEE 802.11e standard to support the
1839 efficient communication of realtime and multimedia data.
1840 To disable WME support, use
1842 Another name for this parameter is
1845 The following parameters are meaningful only when WME support is in use.
1846 Parameters are specified per-AC (Access Category) and
1847 split into those that are used by a station when acting
1848 as an access point and those for client stations in the BSS.
1849 The latter are received from the access point and may not be changed
1851 The following Access Categories are recognized:
1853 .Bl -tag -width ".Cm AC_BK" -compact
1857 best effort delivery,
1872 AC parameters are case-insensitive.
1873 Traffic classification is done in the operating system using the
1874 vlan priority associated with data frames or the
1875 ToS (Type of Service) indication in IP-encapsulated frames.
1876 If neither information is present, traffic is assigned to the
1877 Best Effort (BE) category.
1878 .Bl -tag -width indent
1880 Set the ACK policy for QoS transmissions by the local station;
1881 this controls whether or not data frames transmitted by a station
1882 require an ACK response from the receiving station.
1883 To disable waiting for an ACK use
1885 This parameter is applied only to the local station.
1887 Enable the Admission Control Mandatory (ACM) mechanism
1888 for transmissions by the local station.
1889 To disable the ACM use
1891 On stations in a BSS this parameter is read-only and indicates
1892 the setting received from the access point.
1893 NB: ACM is not supported right now.
1894 .It Cm aifs Ar ac Ar count
1895 Set the Arbitration Inter Frame Spacing (AIFS)
1896 channel access parameter to use for transmissions
1897 by the local station.
1898 On stations in a BSS this parameter is read-only and indicates
1899 the setting received from the access point.
1900 .It Cm cwmin Ar ac Ar count
1901 Set the CWmin channel access parameter to use for transmissions
1902 by the local station.
1903 On stations in a BSS this parameter is read-only and indicates
1904 the setting received from the access point.
1905 .It Cm cwmax Ar ac Ar count
1906 Set the CWmax channel access parameter to use for transmissions
1907 by the local station.
1908 On stations in a BSS this parameter is read-only and indicates
1909 the setting received from the access point.
1910 .It Cm txoplimit Ar ac Ar limit
1911 Set the Transmission Opportunity Limit channel access parameter
1912 to use for transmissions by the local station.
1913 This parameter defines an interval of time when a WME station
1914 has the right to initiate transmissions onto the wireless medium.
1915 On stations in a BSS this parameter is read-only and indicates
1916 the setting received from the access point.
1917 .It Cm bss:aifs Ar ac Ar count
1918 Set the AIFS channel access parameter to send to stations in a BSS.
1919 This parameter is meaningful only when operating in ap mode.
1920 .It Cm bss:cwmin Ar ac Ar count
1921 Set the CWmin channel access parameter to send to stations in a BSS.
1922 This parameter is meaningful only when operating in ap mode.
1923 .It Cm bss:cwmax Ar ac Ar count
1924 Set the CWmax channel access parameter to send to stations in a BSS.
1925 This parameter is meaningful only when operating in ap mode.
1926 .It Cm bss:txoplimit Ar ac Ar limit
1927 Set the TxOpLimit channel access parameter to send to stations in a BSS.
1928 This parameter is meaningful only when operating in ap mode.
1931 Enable Wireless Privacy Subscriber support.
1932 Note that WPS support requires a WPS-capable supplicant.
1933 To disable this function use
1937 The following parameters support an optional access control list
1938 feature available with some adapters when operating in ap mode; see
1940 This facility allows an access point to accept/deny association
1941 requests based on the MAC address of the station.
1942 Note that this feature does not significantly enhance security
1943 as MAC address spoofing is easy to do.
1944 .Bl -tag -width indent
1945 .It Cm mac:add Ar address
1946 Add the specified MAC address to the database.
1947 Depending on the policy setting association requests from the
1948 specified station will be allowed or denied.
1950 Set the ACL policy to permit association only by
1951 stations registered in the database.
1952 .It Cm mac:del Ar address
1953 Delete the specified MAC address from the database.
1955 Set the ACL policy to deny association only by
1956 stations registered in the database.
1957 .It Cm mac:kick Ar address
1958 Force the specified station to be deauthenticated.
1959 This typically is done to block a station after updating the
1962 Set the ACL policy to allow all stations to associate.
1964 Delete all entries in the database.
1966 Set the ACL policy to permit association only by
1967 stations approved by a RADIUS server.
1968 Note that this feature requires the
1970 program be configured to do the right thing
1971 as it handles the RADIUS processing
1972 (and marks stations as authorized).
1975 The following parameters are related to a wireless interface operating in mesh
1977 .Bl -tag -width indent
1978 .It Cm meshid Ar meshid
1979 Set the desired Mesh Identifier.
1980 The Mesh ID is a string up to 32 characters in length.
1981 A mesh interface must have a Mesh Identifier specified
1982 to reach an operational state.
1983 .It Cm meshttl Ar ttl
1984 Set the desired ``time to live'' for mesh forwarded packets;
1985 this is the number of hops a packet may be forwarded before
1987 The default setting for
1991 Enable or disable peering with neighbor mesh stations.
1992 Stations must peer before any data packets can be exchanged.
1997 Enable or disable forwarding packets by a mesh interface.
2002 This attribute specifies whether or not the mesh STA activates mesh gate
2007 .It Cm meshmetric Ar protocol
2010 as the link metric protocol used on a mesh network.
2011 The default protocol is called
2013 The mesh interface will restart after changing this setting.
2014 .It Cm meshpath Ar protocol
2017 as the path selection protocol used on a mesh network.
2018 The only available protocol at the moment is called
2020 (Hybrid Wireless Mesh Protocol).
2021 The mesh interface will restart after changing this setting.
2022 .It Cm hwmprootmode Ar mode
2023 Stations on a mesh network can operate as ``root nodes.''
2024 Root nodes try to find paths to all mesh nodes and advertise themselves
2026 When there is a root mesh node on a network, other mesh nodes can setup
2027 paths between themselves faster because they can use the root node
2028 to find the destination.
2029 This path may not be the best, but on-demand
2030 routing will eventually find the best path.
2031 The following modes are recognized:
2033 .Bl -tag -width ".Cm PROACTIVE" -compact
2037 Send broadcast path requests every two seconds.
2038 Nodes on the mesh without a path to this root mesh station with try to
2039 discover a path to us.
2041 Send broadcast path requests every two seconds and every node must reply
2042 with a path reply even if it already has a path to this root mesh station.
2044 Send broadcast root announcement (RANN) frames.
2045 Nodes on the mesh without a path to this root mesh station with try to
2046 discover a path to us.
2052 .It Cm hwmpmaxhops Ar cnt
2053 Set the maximum number of hops allowed in an HMWP path to
2055 The default setting for
2060 The following parameters are for compatibility with other systems:
2061 .Bl -tag -width indent
2063 Another name for the
2069 .It Cm stationname Ar name
2070 Set the name of this station.
2071 The station name is not part of the IEEE 802.11
2072 protocol though some interfaces support it.
2074 seems to be meaningful to identical or virtually identical equipment.
2075 Setting the station name is identical in syntax to setting the SSID.
2082 Another way of saying
2088 Another way of saying
2094 Another way of saying:
2095 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
2101 .Ar n : k1 , k2 , k3 , k4
2104 Another way of saying
2105 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
2110 Another way of saying
2117 The following parameters are specific to bridge interfaces:
2118 .Bl -tag -width indent
2119 .It Cm addm Ar interface
2120 Add the interface named by
2122 as a member of the bridge.
2123 The interface is put into promiscuous mode
2124 so that it can receive every packet sent on the network.
2125 .It Cm deletem Ar interface
2126 Remove the interface named by
2129 Promiscuous mode is disabled on the interface when
2130 it is removed from the bridge.
2131 .It Cm maxaddr Ar size
2132 Set the size of the bridge address cache to
2134 The default is 2000 entries.
2135 .It Cm timeout Ar seconds
2136 Set the timeout of address cache entries to
2141 is zero, then address cache entries will not be expired.
2142 The default is 1200 seconds.
2144 Display the addresses that have been learned by the bridge.
2145 .It Cm static Ar interface-name Ar address
2146 Add a static entry into the address cache pointing to
2147 .Ar interface-name .
2148 Static entries are never aged out of the cache or re-placed, even if the
2149 address is seen on a different interface.
2150 .It Cm deladdr Ar address
2153 from the address cache.
2155 Delete all dynamically-learned addresses from the address cache.
2157 Delete all addresses, including static addresses, from the address cache.
2158 .It Cm discover Ar interface
2159 Mark an interface as a
2162 When the bridge has no address cache entry
2163 (either dynamic or static)
2164 for the destination address of a packet,
2165 the bridge will forward the packet to all
2166 member interfaces marked as
2168 This is the default for all interfaces added to a bridge.
2169 .It Cm -discover Ar interface
2172 attribute on a member interface.
2173 For packets without the
2175 attribute, the only packets forwarded on the interface are broadcast
2176 or multicast packets and packets for which the destination address
2177 is known to be on the interface's segment.
2178 .It Cm learn Ar interface
2179 Mark an interface as a
2182 When a packet arrives on such an interface, the source
2183 address of the packet is entered into the address cache as being a
2184 destination address on the interface's segment.
2185 This is the default for all interfaces added to a bridge.
2186 .It Cm -learn Ar interface
2189 attribute on a member interface.
2190 .It Cm sticky Ar interface
2191 Mark an interface as a
2194 Dynamically learned address entries are treated at static once entered into
2196 Sticky entries are never aged out of the cache or replaced, even if the
2197 address is seen on a different interface.
2198 .It Cm -sticky Ar interface
2201 attribute on a member interface.
2202 .It Cm private Ar interface
2203 Mark an interface as a
2206 A private interface does not forward any traffic to any other port that is also
2207 a private interface.
2208 .It Cm -private Ar interface
2211 attribute on a member interface.
2212 .It Cm span Ar interface
2213 Add the interface named by
2215 as a span port on the bridge.
2216 Span ports transmit a copy of every frame received by the bridge.
2217 This is most useful for snooping a bridged network passively on
2218 another host connected to one of the span ports of the bridge.
2219 .It Cm -span Ar interface
2220 Delete the interface named by
2222 from the list of span ports of the bridge.
2223 .It Cm stp Ar interface
2224 Enable Spanning Tree protocol on
2228 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
2229 Spanning Tree is used to detect and remove loops in a network topology.
2230 .It Cm -stp Ar interface
2231 Disable Spanning Tree protocol on
2233 This is the default for all interfaces added to a bridge.
2234 .It Cm edge Ar interface
2238 An edge port connects directly to end stations cannot create bridging
2239 loops in the network, this allows it to transition straight to forwarding.
2240 .It Cm -edge Ar interface
2241 Disable edge status on
2243 .It Cm autoedge Ar interface
2246 to automatically detect edge status.
2247 This is the default for all interfaces added to a bridge.
2248 .It Cm -autoedge Ar interface
2249 Disable automatic edge status on
2251 .It Cm ptp Ar interface
2254 as a point to point link.
2255 This is required for straight transitions to forwarding and
2256 should be enabled on a direct link to another RSTP capable switch.
2257 .It Cm -ptp Ar interface
2258 Disable point to point link status on
2260 This should be disabled for a half duplex link and for an interface
2261 connected to a shared network segment,
2262 like a hub or a wireless network.
2263 .It Cm autoptp Ar interface
2264 Automatically detect the point to point status on
2266 by checking the full duplex link status.
2267 This is the default for interfaces added to the bridge.
2268 .It Cm -autoptp Ar interface
2269 Disable automatic point to point link detection on
2271 .It Cm maxage Ar seconds
2272 Set the time that a Spanning Tree protocol configuration is valid.
2273 The default is 20 seconds.
2274 The minimum is 6 seconds and the maximum is 40 seconds.
2275 .It Cm fwddelay Ar seconds
2276 Set the time that must pass before an interface begins forwarding
2277 packets when Spanning Tree is enabled.
2278 The default is 15 seconds.
2279 The minimum is 4 seconds and the maximum is 30 seconds.
2280 .It Cm hellotime Ar seconds
2281 Set the time between broadcasting of Spanning Tree protocol
2282 configuration messages.
2283 The hello time may only be changed when operating in legacy stp mode.
2284 The default is 2 seconds.
2285 The minimum is 1 second and the maximum is 2 seconds.
2286 .It Cm priority Ar value
2287 Set the bridge priority for Spanning Tree.
2288 The default is 32768.
2289 The minimum is 0 and the maximum is 61440.
2290 .It Cm proto Ar value
2291 Set the Spanning Tree protocol.
2292 The default is rstp.
2293 The available options are stp and rstp.
2294 .It Cm holdcnt Ar value
2295 Set the transmit hold count for Spanning Tree.
2296 This is the number of packets transmitted before being rate limited.
2298 The minimum is 1 and the maximum is 10.
2299 .It Cm ifpriority Ar interface Ar value
2300 Set the Spanning Tree priority of
2305 The minimum is 0 and the maximum is 240.
2306 .It Cm ifpathcost Ar interface Ar value
2307 Set the Spanning Tree path cost of
2311 The default is calculated from the link speed.
2312 To change a previously selected path cost back to automatic, set the
2314 The minimum is 1 and the maximum is 200000000.
2315 .It Cm ifmaxaddr Ar interface Ar size
2316 Set the maximum number of hosts allowed from an interface, packets with unknown
2317 source addresses are dropped until an existing host cache entry expires or is
2319 Set to 0 to disable.
2322 The following parameters are specific to lagg interfaces:
2323 .Bl -tag -width indent
2324 .It Cm laggport Ar interface
2325 Add the interface named by
2327 as a port of the aggregation interface.
2328 .It Cm -laggport Ar interface
2329 Remove the interface named by
2331 from the aggregation interface.
2332 .It Cm laggproto Ar proto
2333 Set the aggregation protocol.
2336 The available options are
2344 .It Cm lagghash Ar option Ns Oo , Ns Ar option Oc
2345 Set the packet layers to hash for aggregation protocols which load balance.
2348 The options can be combined using commas.
2350 .Bl -tag -width ".Cm l2" -compact
2352 src/dst mac address and optional vlan number.
2354 src/dst address for IPv4 or IPv6.
2356 src/dst port for TCP/UDP/SCTP.
2359 Enable local hash computation for RSS hash on the interface.
2364 modes will use the RSS hash from the network card if available
2365 to avoid computing one, this may give poor traffic distribution
2366 if the hash is invalid or uses less of the protocol header information.
2368 disables use of RSS hash from the network card.
2369 The default value can be set via the
2370 .Va net.link.lagg.default_use_flowid
2381 Disable local hash computation for RSS hash on the interface.
2382 .It Cm flowid_shift Ar number
2383 Set a shift parameter for RSS local hash computation.
2384 Hash is calculated by using flowid bits in a packet header mbuf
2385 which are shifted by the number of this parameter.
2388 The following parameters are specific to IP tunnel interfaces,
2390 .Bl -tag -width indent
2391 .It Cm tunnel Ar src_addr dest_addr
2392 Configure the physical source and destination address for IP tunnel
2398 are interpreted as the outer source/destination for the encapsulating
2401 Unconfigure the physical source and destination address for IP tunnel
2402 interfaces previously configured with
2405 Another name for the
2408 .It Cm accept_rev_ethip_ver
2409 Set a flag to accept both correct EtherIP packets and ones
2410 with reversed version field.
2412 This is for backward compatibility with
2414 6.2, 6.3, 7.0, and 7.1.
2415 .It Cm -accept_rev_ethip_ver
2417 .Cm accept_rev_ethip_ver .
2418 .It Cm send_rev_ethip_ver
2419 Set a flag to send EtherIP packets with reversed version
2420 field intentionally.
2421 Disabled by default.
2422 This is for backward compatibility with
2424 6.2, 6.3, 7.0, and 7.1.
2425 .It Cm -send_rev_ethip_ver
2427 .Cm send_rev_ethip_ver .
2430 The following parameters are specific to GRE tunnel interfaces,
2432 .Bl -tag -width indent
2433 .It Cm grekey Ar key
2434 Configure the GRE key to be used for outgoing packets.
2436 .Xr gre 4 will always accept GRE packets with invalid or absent keys.
2437 This command will result in a four byte MTU reduction on the interface.
2440 The following parameters are specific to
2443 .Bl -tag -width indent
2444 .It Cm syncdev Ar iface
2445 Use the specified interface
2446 to send and receive pfsync state synchronisation messages.
2448 Stop sending pfsync state synchronisation messages over the network.
2449 .It Cm syncpeer Ar peer_address
2450 Make the pfsync link point-to-point rather than using
2451 multicast to broadcast the state synchronisation messages.
2452 The peer_address is the IP address of the other host taking part in
2455 Broadcast the packets using multicast.
2457 Set the maximum number of updates for a single state which
2458 can be collapsed into one.
2459 This is an 8-bit number; the default value is 128.
2461 Defer transmission of the first packet in a state until a peer has
2462 acknowledged that the associated state has been inserted.
2464 Do not defer the first packet in a state.
2465 This is the default.
2468 The following parameters are specific to
2471 .Bl -tag -width indent
2472 .It Cm vlan Ar vlan_tag
2473 Set the VLAN tag value to
2475 This value is a 12-bit VLAN Identifier (VID) which is used to create an 802.1Q
2476 VLAN header for packets sent from the
2483 must both be set at the same time.
2484 .It Cm vlandev Ar iface
2485 Associate the physical interface
2490 Packets transmitted through the
2493 diverted to the specified physical interface
2495 with 802.1Q VLAN encapsulation.
2496 Packets with 802.1Q encapsulation received
2497 by the parent interface with the correct VLAN Identifier will be diverted to
2503 interface is assigned a
2504 copy of the parent interface's flags and the parent's Ethernet address.
2509 must both be set at the same time.
2512 interface already has
2513 a physical interface associated with it, this command will fail.
2515 change the association to another physical interface, the existing
2516 association must be cleared first.
2518 Note: if the hardware tagging capability
2519 is set on the parent interface, the
2522 interface's behavior changes:
2525 interface recognizes that the
2526 parent interface supports insertion and extraction of VLAN tags on its
2527 own (usually in firmware) and that it should pass packets to and from
2528 the parent unaltered.
2529 .It Fl vlandev Op Ar iface
2532 pseudo device, disassociate the parent interface from it.
2533 This breaks the link between the
2535 interface and its parent,
2536 clears its VLAN Identifier, flags and its link address and shuts the interface
2540 argument is useless and hence deprecated.
2543 The following parameters are used to configure
2546 .Bl -tag -width indent
2547 .It Cm vni Ar identifier
2548 This value is a 24-bit VXLAN Network Identifier (VNI) that identifies the
2549 virtual network segment membership of the interface.
2550 .It Cm local Ar address
2551 The source address used in the encapsulating IPv4/IPv6 header.
2552 The address should already be assigned to an existing interface.
2553 When the interface is configured in unicast mode, the listening socket
2554 is bound to this address.
2555 .It Cm remote Ar address
2556 The interface can be configured in a unicast, or point-to-point, mode
2557 to create a tunnel between two hosts.
2558 This is the IP address of the remote end of the tunnel.
2559 .It Cm group Ar address
2560 The interface can be configured in a multicast mode
2561 to create a virtual network of hosts.
2562 This is the IP multicast group address the interface will join.
2563 .It Cm localport Ar port
2564 The port number the interface will listen on.
2565 The default port number is 4789.
2566 .It Cm remoteport Ar port
2567 The destination port number used in the encapsulating IPv4/IPv6 header.
2568 The remote host should be listening on this port.
2569 The default port number is 4789.
2570 Note some other implementations, such as Linux,
2571 do not default to the IANA assigned port,
2572 but instead listen on port 8472.
2573 .It Cm portrange Ar low high
2574 The range of source ports used in the encapsulating IPv4/IPv6 header.
2575 The port selected within the range is based on a hash of the inner frame.
2576 A range is useful to provide entropy within the outer IP header
2577 for more effective load balancing.
2578 The default range is between the
2581 .Va net.inet.ip.portrange.first
2583 .Va net.inet.ip.portrange.last
2584 .It Cm timeout Ar timeout
2585 The maximum time, in seconds, before an entry in the forwarding table
2587 The default is 1200 seconds (20 minutes).
2588 .It Cm maxaddr Ar max
2589 The maximum number of entries in the forwarding table.
2590 The default is 2000.
2591 .It Cm vxlandev Ar dev
2592 When the interface is configured in multicast mode, the
2594 interface is used to transmit IP multicast packets.
2596 The TTL used in the encapsulating IPv4/IPv6 header.
2599 The source IP address and inner source Ethernet MAC address of
2600 received packets are used to dynamically populate the forwarding table.
2601 When in multicast mode, an entry in the forwarding table allows the
2602 interface to send the frame directly to the remote host instead of
2603 broadcasting the frame to the multicast group.
2604 This is the default.
2606 The forwarding table is not populated by recevied packets.
2608 Delete all dynamically-learned addresses from the forwarding table.
2610 Delete all addresses, including static addresses, from the forwarding table.
2613 The following parameters are used to configure
2615 protocol on an interface:
2616 .Bl -tag -width indent
2618 Set the virtual host ID.
2619 This is a required setting to initiate
2621 If the virtual host ID does not exist yet, it is created and attached to the
2622 interface, otherwise configuration of an existing vhid is adjusted.
2625 keyword is supplied along with an
2629 address, then this address is configured to be run under control of the
2631 Whenever a last address that refers to a particular vhid is removed from an
2632 interface, the vhid is automatically removed from interface and destroyed.
2633 Any other configuration parameters for the
2635 protocol should be supplied along with the
2638 Acceptable values for vhid are 1 to 255.
2639 .It Cm advbase Ar seconds
2640 Specifies the base of the advertisement interval in seconds.
2641 The acceptable values are 1 to 255.
2642 The default value is 1.
2643 .It Cm advskew Ar interval
2644 Specifies the skew to add to the base advertisement interval to
2645 make one host advertise slower than another host.
2646 It is specified in 1/256 of seconds.
2647 The acceptable values are 1 to 254.
2648 The default value is 0.
2649 .It Cm pass Ar phrase
2650 Set the authentication key to
2652 .It Cm state Ar MASTER|BACKUP
2653 Forcibly change state of a given vhid.
2658 utility displays the current configuration for a network interface
2659 when no optional parameters are supplied.
2660 If a protocol family is specified,
2662 will report only the details specific to that protocol family.
2666 flag is passed before an interface name,
2668 will display the capability list and all
2669 of the supported media for the specified interface.
2672 flag is supplied, address lifetime is displayed for IPv6 addresses,
2673 as time offset string.
2677 flag may be used instead of an interface name.
2680 to display information about all interfaces in the system.
2683 flag limits this to interfaces that are down, and
2685 limits this to interfaces that are up.
2686 When no arguments are given,
2692 flag may be used to list all available interfaces on the system, with
2693 no other additional information.
2696 is specified, only interfaces of that type will be listed.
2698 will list only Ethernet adapters, excluding the loopback interface.
2699 Use of this flag is mutually exclusive
2700 with all other flags and commands, except for
2702 (only list interfaces that are down)
2705 (only list interfaces that are up).
2709 flag may be used to get more verbose status for an interface.
2713 flag may be used to list all of the interface cloners available on
2714 the system, with no additional information.
2715 Use of this flag is mutually exclusive with all other flags and commands.
2719 flag causes keying information for the interface, if available, to be
2721 For example, the values of 802.11 WEP keys and
2723 passphrases will be printed, if accessible to the current user.
2724 This information is not printed by default, as it may be considered
2727 If the network interface driver is not present in the kernel then
2729 will attempt to load it.
2732 flag disables this behavior.
2734 Only the super-user may modify the configuration of a network interface.
2736 Assign the IPv4 address
2738 with a network mask of
2742 .Dl # ifconfig fxp0 inet 192.0.2.10 netmask 255.255.255.0
2744 Add the IPv4 address
2746 with the CIDR network prefix
2752 as a synonym for the canonical form of the option
2754 .Dl # ifconfig ed0 inet 192.0.2.45/28 add
2756 Remove the IPv4 address
2760 .Dl # ifconfig ed0 inet 192.0.2.45 -alias
2762 Enable IPv6 functionality of the interface:
2763 .Dl # ifconfig em0 inet6 -ifdisabled
2765 Add the IPv6 address
2766 .Li 2001:DB8:DBDB::123/48
2769 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias
2770 Note that lower case hexadecimal IPv6 addresses are acceptable.
2772 Remove the IPv6 address added in the above example,
2775 character as shorthand for the network prefix,
2778 as a synonym for the canonical form of the option
2780 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 delete
2782 Configure a single CARP redundant address on igb0, and then switch it
2784 .Dl # ifconfig igb0 vhid 1 10.0.0.1/24 pass foobar up
2785 .Dl # ifconfig igb0 vhid 1 state master
2787 Configure the interface
2789 to use 100baseTX, full duplex Ethernet media options:
2790 .Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex
2792 Label the em0 interface as an uplink:
2793 .Dl # ifconfig em0 description \&"Uplink to Gigabit Switch 2\&"
2795 Create the software network interface
2797 .Dl # ifconfig gif1 create
2799 Destroy the software network interface
2801 .Dl # ifconfig gif1 destroy
2803 Display available wireless networks using
2805 .Dl # ifconfig wlan0 list scan
2807 Messages indicating the specified interface does not exist, the
2808 requested address is unknown, or the user is not privileged and
2809 tried to alter an interface's configuration.
2832 Basic IPv6 node operation requires a link-local address on each
2833 interface configured for IPv6.
2834 Normally, such an address is automatically configured by the
2835 kernel on each interface added to the system or enabled; this behavior may
2836 be disabled by setting per-interface flag
2837 .Cm -auto_linklocal .
2838 The default value of this flag is 1 and can be disabled by using the sysctl
2840 .Va net.inet6.ip6.auto_linklocal .
2842 Do not configure IPv6 addresses with no link-local address by using
2844 It can result in unexpected behaviors of the kernel.
projects / FreeBSD / FreeBSD.git / blob