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 , rxcsum6 , txcsum6
376 If the driver supports user-configurable checksum offloading,
377 enable receive (or transmit) checksum offloading on the interface.
378 The feature can be turned on selectively per protocol family.
380 .Cm rxcsum6 , txcsum6
386 Some drivers may not be able to enable these flags independently
387 of each other, so setting one may also set the other.
388 The driver will offload as much checksum work as it can reliably
389 support, the exact level of offloading varies between drivers.
390 .It Fl rxcsum , txcsum , rxcsum6 , txcsum6
391 If the driver supports user-configurable checksum offloading,
392 disable receive (or transmit) checksum offloading on the interface.
393 The feature can be turned off selectively per protocol family.
395 .Fl rxcsum6 , txcsum6
401 These settings may not always be independent of each other.
403 If the driver supports
405 segmentation offloading, enable TSO on the interface.
406 Some drivers may not be able to support TSO for
410 packets, so they may enable only one of them.
412 If the driver supports
414 segmentation offloading, disable TSO on the interface.
415 It will always disable TSO for
420 If the driver supports
422 segmentation offloading for
426 use one of these to selectively enabled it only for one protocol family.
428 If the driver supports
430 segmentation offloading for
434 use one of these to selectively disable it only for one protocol family.
436 If the driver supports
438 large receive offloading, enable LRO on the interface.
440 If the driver supports
442 large receive offloading, disable LRO on the interface.
443 .It Cm wol , wol_ucast , wol_mcast , wol_magic
444 Enable Wake On Lan (WOL) support, if available.
445 WOL is a facility whereby a machine in a low power state may be woken
446 in response to a received packet.
447 There are three types of packets that may wake a system:
448 ucast (directed solely to the machine's mac address),
449 mcast (directed to a broadcast or multicast address),
451 magic (unicast or multicast frames with a ``magic contents'').
452 Not all devices support WOL, those that do indicate the mechanisms
453 they support in their capabilities.
455 is a synonym for enabling all available WOL mechanisms.
458 .It Cm vlanmtu , vlanhwtag, vlanhwfilter, vlanhwcsum, vlanhwtso
459 If the driver offers user-configurable VLAN support, enable
460 reception of extended frames, tag processing in hardware,
461 frame filtering in hardware, checksum offloading, or TSO on VLAN,
463 Note that this must be issued on a physical interface associated with
468 .It Fl vlanmtu , vlanhwtag, vlanhwfilter, vlanhwtso
469 If the driver offers user-configurable VLAN support, disable
470 reception of extended frames, tag processing in hardware,
471 frame filtering in hardware, or TSO on VLAN,
474 Move the interface to the
476 specified by name or JID.
477 If the jail has a virtual network stack, the interface will disappear
478 from the current environment and become visible to the jail.
480 Reclaim the interface from the
482 specified by name or JID.
483 If the jail has a virtual network stack, the interface will disappear
484 from the jail, and become visible to the current network environment.
488 feature and disable interrupts on the interface, if driver supports
493 feature and enable interrupt mode on the interface.
495 Create the specified network pseudo-device.
496 If the interface is given without a unit number, try to create a new
497 device with an arbitrary unit number.
498 If creation of an arbitrary device is successful, the new device name is
499 printed to standard output unless the interface is renamed or destroyed
504 Destroy the specified network pseudo-device.
520 Set the routing metric of the interface to
523 The routing metric is used by the routing protocol
525 Higher metrics have the effect of making a route
526 less favorable; metrics are counted as additional hops
527 to the destination network or host.
529 Set the maximum transmission unit of the interface to
531 default is interface specific.
532 The MTU is used to limit the size of packets that are transmitted on an
534 Not all interfaces support setting the MTU, and some interfaces have
536 .It Cm netmask Ar mask
539 Specify how much of the address to reserve for subdividing
540 networks into sub-networks.
541 The mask includes the network part of the local address
542 and the subnet part, which is taken from the host field of the address.
543 The mask can be specified as a single hexadecimal number
546 with a dot-notation Internet address,
547 or with a pseudo-network name listed in the network table
549 The mask contains 1's for the bit positions in the 32-bit address
550 which are to be used for the network and subnet parts,
551 and 0's for the host part.
552 The mask should contain at least the standard network portion,
553 and the subnet field should be contiguous with the network
556 The netmask can also be specified in CIDR notation after the address.
559 option above for more information.
560 .It Cm prefixlen Ar len
564 bits are reserved for subdividing networks into sub-networks.
567 must be integer, and for syntactical reason it must be between 0 to 128.
568 It is almost always 64 under the current IPv6 assignment rule.
569 If the parameter is omitted, 64 is used.
571 The prefix can also be specified using the slash notation after the address.
574 option above for more information.
577 .\" .It Cm nsellength Ar n
580 .\" This specifies a trailing number of bytes for a received
582 .\" used for local identification, the remaining leading part of which is
585 .\" (Network Entity Title).
586 .\" The default value is 1, which is conformant to US
588 .\" When an ISO address is set in an ifconfig command,
591 .\" which is being specified.
594 .\" 20 hex digits should be
597 .\" to be assigned to the interface.
598 .\" There is some evidence that a number different from 1 may be useful
601 .\" 37 type addresses.
602 .It Cm range Ar netrange
603 Under appletalk, set the interface to respond to a
606 .Ar startnet Ns - Ns Ar endnet .
607 Appletalk uses this scheme instead of
610 implements it internally as a set of netmasks.
615 Introduced for compatibility
619 The argument following this specifies the version (phase) of the
620 Appletalk network attached to the interface.
621 Values of 1 or 2 are permitted.
623 .It Cm link Op Cm 0 No - Cm 2
625 Enable special processing of the link level of the interface.
626 These three options are interface specific in actual effect, however,
627 they are in general used to select special modes of operation.
629 of this is to enable SLIP compression, or to select the connector type
630 for some Ethernet cards.
631 Refer to the man page for the specific driver
632 for more information.
634 .It Fl link Op Cm 0 No - Cm 2
636 Disable special processing at the link level with the specified interface.
638 Put the interface in monitor mode.
639 No packets are transmitted, and received packets are discarded after
643 Take the interface out of monitor mode.
647 This may be used to enable an interface after an
649 It happens automatically when setting the first address on an interface.
650 If the interface was reset when previously marked down,
651 the hardware will be re-initialized.
654 The following parameters are for ICMPv6 Neighbor Discovery Protocol.
655 Note that the address family keyword
658 .Bl -tag -width indent
660 Set a flag to enable accepting ICMPv6 Router Advertisement messages.
664 .Va net.inet6.ip6.accept_rtadv
665 controls whether this flag is set by default or not.
670 Set a flag to control whether routers from which the system accepts
671 Router Advertisement messages will be added to the Default Router List
675 flag is disabled, this flag has no effect.
679 .Va net.inet6.ip6.no_radr
680 controls whether this flag is set by default or not.
684 .It Cm auto_linklocal
685 Set a flag to perform automatic link-local address configuration when
686 the interface becomes available.
690 .Va net.inet6.ip6.auto_linklocal
691 controls whether this flag is set by default or not.
692 .It Cm -auto_linklocal
696 Set the specified interface as the default route when there is no
702 Set a flag to disable all of IPv6 network communications on the
703 specified interface. Note that if there are already configured IPv6
704 addresses on that interface, all of them are marked as
706 and DAD will be performed when this flag is cleared.
710 When this flag is cleared and
712 flag is enabled, automatic configuration of a link-local address is
715 Set a flag to enable Neighbor Unreachability Detection.
719 .It Cm no_prefer_iface
720 Set a flag to not prefer address on the interface as candidates of the
721 source address for outgoing packets, even when the interface is
723 .It Cm -no_prefer_iface
725 .Cm no_prefer_iface .
728 The following parameters are specific to cloning
729 IEEE 802.11 wireless interfaces with the
732 .Bl -tag -width indent
733 .It Cm wlandev Ar device
736 as the parent for the cloned device.
737 .It Cm wlanmode Ar mode
738 Specify the operating mode for this cloned device.
756 The operating mode of a cloned interface cannot be changed.
759 mode is actually implemented as an
761 interface with special properties.
762 .It Cm wlanbssid Ar bssid
763 The 802.11 mac address to use for the bssid.
764 This must be specified at create time for a legacy
767 .It Cm wlanaddr Ar address
768 The local mac address.
769 If this is not specified then a mac address will automatically be assigned
770 to the cloned device.
771 Typically this address is the same as the address of the parent device
774 parameter is specified then the driver will craft a unique address for
775 the device (if supported).
779 device as operating in ``legacy mode''.
782 devices have a fixed peer relationship and do not, for example, roam
783 if their peer stops communicating.
784 For completeness a Dynamic WDS (DWDS) interface may marked as
787 Request a unique local mac address for the cloned device.
788 This is only possible if the device supports multiple mac addresses.
789 To force use of the parent's mac address use
792 Mark the cloned interface as depending on hardware support to
793 track received beacons.
794 To have beacons tracked in software use
800 can also be used to indicate no beacons should
801 be transmitted; this can be useful when creating a WDS configuration but
803 interfaces can only be created as companions to an access point.
806 The following parameters are specific to IEEE 802.11 wireless interfaces
810 .Bl -tag -width indent
812 Enable sending and receiving AMPDU frames when using 802.11n (default).
813 The 802.11n specification states a compliant station must be capable
814 of receiving AMPDU frames but transmission is optional.
817 to disable all use of AMPDU with 802.11n.
818 For testing and/or to work around interoperability problems one can use
822 to control use of AMPDU in one direction.
823 .It Cm ampdudensity Ar density
824 Set the AMPDU density parameter used when operating with 802.11n.
825 This parameter controls the inter-packet gap for AMPDU frames.
826 The sending device normally controls this setting but a receiving station
827 may request wider gaps.
830 are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds).
833 is treated the same as 0.
834 .It Cm ampdulimit Ar limit
835 Set the limit on packet size for receiving AMPDU frames when operating
839 are 8192, 16384, 32768, and 65536 but one can also specify
840 just the unique prefix: 8, 16, 32, 64.
841 Note the sender may limit the size of AMPDU frames to be less
842 than the maximum specified by the receiving station.
844 Enable sending and receiving AMSDU frames when using 802.11n.
845 By default AMSDU is received but not transmitted.
848 to disable all use of AMSDU with 802.11n.
849 For testing and/or to work around interoperability problems one can use
853 to control use of AMSDU in one direction.
854 .It Cm amsdulimit Ar limit
855 Set the limit on packet size for sending and receiving AMSDU frames
856 when operating with 802.11n.
859 are 7935 and 3839 (bytes).
860 Note the sender may limit the size of AMSDU frames to be less
861 than the maximum specified by the receiving station.
862 Note also that devices are not required to support the 7935 limit,
863 only 3839 is required by the specification and the larger value
864 may require more memory to be dedicated to support functionality
867 When operating as an access point, pass packets between
868 wireless clients directly (default).
869 To instead let them pass up through the
870 system and be forwarded using some other mechanism, use
872 Disabling the internal bridging
873 is useful when traffic is to be processed with
875 .It Cm authmode Ar mode
876 Set the desired authentication mode in infrastructure mode.
877 Not all adapters support all modes.
880 .Cm none , open , shared
886 (IEEE WPA/WPA2/802.11i).
891 modes are only useful when using an authentication service
892 (a supplicant for client operation or an authenticator when
893 operating as an access point).
894 Modes are case insensitive.
896 Enable background scanning when operating as a station.
897 Background scanning is a technique whereby a station associated to
898 an access point will temporarily leave the channel to scan for
899 neighboring stations.
900 This allows a station to maintain a cache of nearby access points
901 so that roaming between access points can be done without
902 a lengthy scan operation.
903 Background scanning is done only when a station is not busy and
904 any outbound traffic will cancel a scan operation.
905 Background scanning should never cause packets to be lost though
906 there may be some small latency if outbound traffic interrupts a
908 By default background scanning is enabled if the device is capable.
909 To disable background scanning, use
911 Background scanning is controlled by the
916 Background scanning must be enabled for roaming; this is an artifact
917 of the current implementation and may not be required in the future.
918 .It Cm bgscanidle Ar idletime
919 Set the minimum time a station must be idle (not transmitting or
920 receiving frames) before a background scan is initiated.
923 parameter is specified in milliseconds.
924 By default a station must be idle at least 250 milliseconds before
925 a background scan is initiated.
926 The idle time may not be set to less than 100 milliseconds.
927 .It Cm bgscanintvl Ar interval
928 Set the interval at which background scanning is attempted.
931 parameter is specified in seconds.
932 By default a background scan is considered every 300 seconds (5 minutes).
935 may not be set to less than 15 seconds.
936 .It Cm bintval Ar interval
937 Set the interval at which beacon frames are sent when operating in
941 parameter is specified in TU's (1024 usecs).
942 By default beacon frames are transmitted every 100 TU's.
943 .It Cm bmissthreshold Ar count
944 Set the number of consecutive missed beacons at which the station
945 will attempt to roam (i.e., search for a new access point).
948 parameter must be in the range 1 to 255; though the
949 upper bound may be reduced according to device capabilities.
950 The default threshold is 7 consecutive missed beacons; but
951 this may be overridden by the device driver.
956 .It Cm bssid Ar address
957 Specify the MAC address of the access point to use when operating
958 as a station in a BSS network.
959 This overrides any automatic selection done by the system.
960 To disable a previously selected access point, supply
965 This option is useful when more than one access point uses the same SSID.
971 Enable packet bursting.
972 Packet bursting is a transmission technique whereby the wireless
973 medium is acquired once to send multiple frames and the interframe
975 This technique can significantly increase throughput by reducing
976 transmission overhead.
977 Packet bursting is supported by the 802.11e QoS specification
978 and some devices that do not support QoS may still be capable.
979 By default packet bursting is enabled if a device is capable
981 To disable packet bursting, use
983 .It Cm chanlist Ar channels
984 Set the desired channels to use when scanning for access
985 points, neighbors in an IBSS network, or looking for unoccupied
986 channels when operating as an access point.
987 The set of channels is specified as a comma-separated list with
988 each element in the list representing either a single channel number or a range
991 Channel numbers must be in the range 1 to 255 and be permissible
992 according to the operating characteristics of the device.
993 .It Cm channel Ar number
994 Set a single desired channel.
995 Channels range from 1 to 255, but the exact selection available
996 depends on the region your adaptor was manufactured for.
1002 will clear any desired channel and, if the device is marked up,
1003 force a scan for a channel to operate on.
1004 Alternatively the frequency, in megahertz, may be specified
1005 instead of the channel number.
1007 When there are several ways to use a channel the channel
1008 number/frequency may be appended with attributes to clarify.
1009 For example, if a device is capable of operating on channel 6
1010 with 802.11n and 802.11g then one can specify that g-only use
1011 should be used by specifying ``6:g''.
1012 Similarly the channel width can be specified by appending it
1013 with ``/''; e.g., ``6/40'' specifies a 40MHz wide channel,
1014 These attributes can be combined as in: ``6:ht/40''.
1015 The full set of flags specified following a ``:'' are:
1021 (Atheros Dynamic Turbo mode),
1029 (Atheros Static Turbo mode),
1032 (Atheros Dynamic Turbo mode, or appended to ``st'' and ``dt'').
1033 The full set of channel widths following a '/' are:
1035 (5MHz aka quarter-rate channel),
1037 (10MHz aka half-rate channel),
1039 (20MHz mostly for use in specifying ht20),
1042 (40MHz mostly for use in specifying ht40).
1044 a 40MHz HT channel specification may include the location
1045 of the extension channel by appending ``+'' or ``-'' for above and below,
1046 respectively; e.g., ``2437:ht/40+'' specifies 40MHz wide HT operation
1047 with the center channel at frequency 2437 and the extension channel above.
1048 .It Cm country Ar name
1049 Set the country code to use in calculating the regulatory constraints
1051 In particular the set of available channels, how the wireless device
1052 will operation on the channels, and the maximum transmit power that
1053 can be used on a channel are defined by this setting.
1054 Country/Region codes are specified as a 2-character abbreviation
1055 defined by ISO 3166 or using a longer, but possibly ambiguous, spelling;
1056 e.g., "ES" and "Spain".
1057 The set of country codes are taken from
1058 .Pa /etc/regdomain.xml
1060 be viewed with the ``list countries'' request.
1061 Note that not all devices support changing the country code from a default
1062 setting; typically stored in EEPROM.
1070 Enable Dynamic Frequency Selection (DFS) as specified in 802.11h.
1071 DFS embodies several facilities including detection of overlapping
1072 radar signals, dynamic transmit power control, and channel selection
1073 according to a least-congested criteria.
1074 DFS support is mandatory for some 5GHz frequencies in certain
1075 locales (e.g., ETSI).
1076 By default DFS is enabled according to the regulatory definitions
1078 .Pa /etc/regdomain.xml
1079 and the current country code, regdomain,
1081 Note the underlying device (and driver) must support radar detection
1082 for full DFS support to work.
1083 To be fully compliant with the local regulatory agency frequencies that
1084 require DFS should not be used unless it is fully supported.
1087 to disable this functionality for testing.
1089 Enable support for the 802.11d specification (default).
1090 When this support is enabled in station mode, beacon frames that advertise
1091 a country code different than the currently configured country code will
1092 cause an event to be dispatched to user applications.
1093 This event can be used by the station to adopt that country code and
1094 operate according to the associated regulatory constraints.
1095 When operating as an access point with 802.11d enabled the beacon and
1096 probe response frames transmitted will advertise the current regulatory
1098 To disable 802.11d use
1101 Enable 802.11h support including spectrum management.
1102 When 802.11h is enabled beacon and probe response frames will have
1103 the SpectrumMgt bit set in the capabilities field and
1104 country and power constraint information elements will be present.
1105 802.11h support also includes handling Channel Switch Announcements (CSA)
1106 which are a mechanism to coordinate channel changes by an access point.
1107 By default 802.11h is enabled if the device is capable.
1108 To disable 802.11h use
1110 .It Cm deftxkey Ar index
1111 Set the default key to use for transmission.
1112 Typically this is only set when using WEP encryption.
1113 Note that you must set a default transmit key
1114 for the system to know which key to use in encrypting outbound traffic.
1117 is an alias for this request; it is provided for backwards compatibility.
1118 .It Cm dtimperiod Ar period
1121 period for transmitting buffered multicast data frames when
1122 operating in ap mode.
1125 specifies the number of beacon intervals between DTIM
1126 and must be in the range 1 to 15.
1127 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
1129 Enable the use of quiet IE. Hostap will use this to silence other
1130 stations to reduce interference for radar detection when
1131 operating on 5GHz frequency and doth support is enabled.
1134 to disable this functionality.
1135 .It Cm quiet_period Ar period
1138 to the number of beacon intervals between the start of regularly
1139 scheduled quiet intervals defined by Quiet element.
1140 .It Cm quiet_count Ar count
1143 to the number of TBTTs until the beacon interval during which the
1144 next quiet interval shall start. A value of 1 indicates the quiet
1145 interval will start during the beacon interval starting at the next
1146 TBTT. A value 0 is reserved.
1147 .It Cm quiet_offset Ar offset
1150 to the offset of the start of the quiet interval from the TBTT
1151 specified by the Quiet count, expressed in TUs.
1154 shall be less than one beacon interval.
1155 .It Cm quiet_duration Ar dur
1158 to the duration of the Quiet interval, expressed in TUs.
1159 The value should be less than beacon interval.
1161 Enable the use of Atheros Dynamic Turbo mode when communicating with
1162 another Dynamic Turbo-capable station.
1163 Dynamic Turbo mode is an Atheros-specific mechanism by which
1164 stations switch between normal 802.11 operation and a ``boosted''
1165 mode in which a 40MHz wide channel is used for communication.
1166 Stations using Dynamic Turbo mode operate boosted only when the
1167 channel is free of non-dturbo stations; when a non-dturbo station
1168 is identified on the channel all stations will automatically drop
1169 back to normal operation.
1170 By default, Dynamic Turbo mode is not enabled, even if the device is capable.
1171 Note that turbo mode (dynamic or static) is only allowed on some
1172 channels depending on the regulatory constraints; use the
1174 command to identify the channels where turbo mode may be used.
1175 To disable Dynamic Turbo mode use
1178 Enable Dynamic WDS (DWDS) support.
1179 DWDS is a facility by which 4-address traffic can be carried between
1180 stations operating in infrastructure mode.
1181 A station first associates to an access point and authenticates using
1182 normal procedures (e.g., WPA).
1183 Then 4-address frames are passed to carry traffic for stations
1184 operating on either side of the wireless link.
1185 DWDS extends the normal WDS mechanism by leveraging existing security
1186 protocols and eliminating static binding.
1188 When DWDS is enabled on an access point 4-address frames received from
1189 an authorized station will generate a ``DWDS discovery'' event to user
1191 This event should be used to create a WDS interface that is bound
1192 to the remote station (and usually plumbed into a bridge).
1193 Once the WDS interface is up and running 4-address traffic then logically
1194 flows through that interface.
1196 When DWDS is enabled on a station, traffic with a destination address
1197 different from the peer station are encapsulated in a 4-address frame
1198 and transmitted to the peer.
1199 All 4-address traffic uses the security information of the stations
1200 (e.g., cryptographic keys).
1201 A station is associated using 802.11n facilities may transport
1202 4-address traffic using these same mechanisms; this depends on available
1203 resources and capabilities of the device.
1204 The DWDS implementation guards against layer 2 routing loops of
1207 Enable the use of Atheros Fast Frames when communicating with
1208 another Fast Frames-capable station.
1209 Fast Frames are an encapsulation technique by which two 802.3
1210 frames are transmitted in a single 802.11 frame.
1211 This can noticeably improve throughput but requires that the
1212 receiving station understand how to decapsulate the frame.
1213 Fast frame use is negotiated using the Atheros 802.11 vendor-specific
1214 protocol extension so enabling use is safe when communicating with
1215 non-Atheros devices.
1216 By default, use of fast frames is enabled if the device is capable.
1217 To explicitly disable fast frames, use
1219 .It Cm fragthreshold Ar length
1220 Set the threshold for which transmitted frames are broken into fragments.
1223 argument is the frame size in bytes and must be in the range 256 to 2346.
1231 disables transmit fragmentation.
1232 Not all adapters honor the fragmentation threshold.
1234 When operating as an access point, do not broadcast the SSID
1235 in beacon frames or respond to probe request frames unless
1236 they are directed to the ap (i.e., they include the ap's SSID).
1237 By default, the SSID is included in beacon frames and
1238 undirected probe request frames are answered.
1239 To re-enable the broadcast of the SSID etc., use
1242 Enable use of High Throughput (HT) when using 802.11n (default).
1243 The 802.11n specification includes mechanisms for operation
1244 on 20MHz and 40MHz wide channels using different signalling mechanisms
1245 than specified in 802.11b, 802.11g, and 802.11a.
1246 Stations negotiate use of these facilities, termed HT20 and HT40,
1247 when they associate.
1248 To disable all use of 802.11n use
1250 To disable use of HT20 (e.g., to force only HT40 use) use
1252 To disable use of HT40 use
1255 HT configuration is used to ``auto promote'' operation
1256 when several choices are available.
1257 For example, if a station associates to an 11n-capable access point
1258 it controls whether the station uses legacy operation, HT20, or HT40.
1259 When an 11n-capable device is setup as an access point and
1260 Auto Channel Selection is used to locate a channel to operate on,
1261 HT configuration controls whether legacy, HT20, or HT40 operation is setup
1262 on the selected channel.
1263 If a fixed channel is specified for a station then HT configuration can
1264 be given as part of the channel specification; e.g., 6:ht/20 to setup
1265 HT20 operation on channel 6.
1267 Enable use of compatibility support for pre-802.11n devices (default).
1268 The 802.11n protocol specification went through several incompatible iterations.
1269 Some vendors implemented 11n support to older specifications that
1270 will not interoperate with a purely 11n-compliant station.
1271 In particular the information elements included in management frames
1272 for old devices are different.
1273 When compatibility support is enabled both standard and compatible data
1275 Stations that associate using the compatibility mechanisms are flagged
1277 To disable compatibility support use
1279 .It Cm htprotmode Ar technique
1280 For interfaces operating in 802.11n, use the specified
1282 for protecting HT frames in a mixed legacy/HT network.
1283 The set of valid techniques is
1288 Technique names are case insensitive.
1290 Enable inactivity processing for stations associated to an
1291 access point (default).
1292 When operating as an access point the 802.11 layer monitors
1293 the activity of each associated station.
1294 When a station is inactive for 5 minutes it will send several
1295 ``probe frames'' to see if the station is still present.
1296 If no response is received then the station is deauthenticated.
1297 Applications that prefer to handle this work can disable this
1301 Set the location to use in calculating regulatory constraints.
1302 The location is also advertised in beacon and probe response frames
1303 when 802.11d is enabled with
1312 Display the list of channels available for use taking into account
1313 any restrictions set with the
1316 See the description of
1318 for more information.
1320 Display the adaptor's capabilities, including the operating
1323 Display the list of channels available for use.
1324 Channels are shown with their IEEE channel number, equivalent
1325 frequency, and usage modes.
1326 Channels identified as
1331 Channels identified as
1333 may be used only for Atheros' Static Turbo mode
1335 . Cm mediaopt turbo ) .
1336 Channels marked with a
1338 have a regulatory constraint that they be passively scanned.
1339 This means a station is not permitted to transmit on the channel until
1340 it identifies the channel is being used for 802.11 communication;
1341 typically by hearing a beacon frame from an access point operating
1344 is another way of requesting this information.
1345 By default a compacted list of channels is displayed; if the
1347 option is specified then all channels are shown.
1348 .It Cm list countries
1349 Display the set of country codes and regulatory domains that can be
1350 used in regulatory configuration.
1352 Display the current MAC Access Control List state.
1353 Each address is prefixed with a character that indicates the
1354 current policy applied to it:
1356 indicates the address is allowed access,
1358 indicates the address is denied access,
1360 indicates the address is present but the current policy open
1361 (so the ACL is not consulted).
1363 Displays the mesh routing table, used for forwarding packets on a mesh
1365 .It Cm list regdomain
1366 Display the current regulatory settings including the available channels
1367 and transmit power caps.
1369 Display the parameters that govern roaming operation.
1371 Display the parameters that govern transmit operation.
1373 Display the transmit power caps for each channel.
1375 Display the access points and/or ad-hoc neighbors
1376 located in the vicinity.
1377 This information may be updated automatically by the adapter
1380 request or through background scanning.
1381 Depending on the capabilities of the stations the following
1382 flags can be included in the output:
1386 Indicates that the station is permitted to send/receive data frames.
1388 Extended Rate Phy (ERP).
1389 Indicates that the station is operating in an 802.11g network
1390 using extended transmit rates.
1392 High Throughput (HT).
1393 Indicates that the station is using HT transmit rates.
1394 If a `+' follows immediately after then the station associated
1395 using deprecated mechanisms supported only when
1400 Indicates that the station is operating in power save mode.
1402 Quality of Service (QoS).
1403 Indicates that the station is using QoS encapsulation for
1405 QoS encapsulation is enabled only when WME mode is enabled.
1408 Indicates that the station is doing short preamble to optionally
1409 improve throughput performance with 802.11g and 802.11b.
1411 Transitional Security Network (TSN).
1412 Indicates that the station associated using TSN; see also
1416 Wi-Fi Protected Setup (WPS).
1417 Indicates that the station associated using WPS.
1420 By default interesting information elements captured from the neighboring
1421 stations are displayed at the end of each row.
1422 Possible elements include:
1424 (station supports WME),
1426 (station supports WPA),
1428 (station supports WPS),
1430 (station supports 802.11i/RSN),
1432 (station supports 802.11n/HT communication),
1434 (station supports Atheros protocol extensions),
1436 (station supports unknown vendor-specific extensions).
1439 flag is used all the information elements and their
1440 contents will be shown.
1443 flag also enables display of long SSIDs.
1446 command is another way of requesting this information.
1448 When operating as an access point display the stations that are
1449 currently associated.
1450 When operating in ad-hoc mode display stations identified as
1451 neighbors in the IBSS.
1452 When operating in mesh mode display stations identified as
1453 neighbors in the MBSS.
1454 When operating in station mode display the access point.
1455 Capabilities advertised by the stations are described under
1459 Depending on the capabilities of the stations the following
1460 flags can be included in the output:
1464 Indicates that the station is permitted to send/receive data frames.
1466 Extended Rate Phy (ERP).
1467 Indicates that the station is operating in an 802.11g network
1468 using extended transmit rates.
1470 High Throughput (HT).
1471 Indicates that the station is using HT transmit rates.
1472 If a `+' follows immediately after then the station associated
1473 using deprecated mechanisms supported only when
1478 Indicates that the station is operating in power save mode.
1480 Quality of Service (QoS).
1481 Indicates that the station is using QoS encapsulation for
1483 QoS encapsulation is enabled only when WME mode is enabled.
1486 Indicates that the station is doing short preamble to optionally
1487 improve throughput performance with 802.11g and 802.11b.
1489 Transitional Security Network (TSN).
1490 Indicates that the station associated using TSN; see also
1494 Wi-Fi Protected Setup (WPS).
1495 Indicates that the station associated using WPS.
1498 By default information elements received from associated stations
1499 are displayed in a short form; the
1501 flag causes this information to be displayed symbolically.
1503 Display the current channel parameters to use when operating in WME mode.
1506 option is specified then both channel and BSS parameters are displayed
1507 for each AC (first channel, then BSS).
1508 When WME mode is enabled for an adaptor this information will be
1509 displayed with the regular status; this command is mostly useful
1510 for examining parameters when WME mode is disabled.
1511 See the description of the
1513 directive for information on the various parameters.
1514 .It Cm maxretry Ar count
1515 Set the maximum number of tries to use in sending unicast frames.
1516 The default setting is 6 but drivers may override this with a value
1518 .It Cm mcastrate Ar rate
1519 Set the rate for transmitting multicast/broadcast frames.
1520 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1521 This rate should be valid for the current operating conditions;
1522 if an invalid rate is specified drivers are free to chose an
1524 .It Cm mgtrate Ar rate
1525 Set the rate for transmitting management and/or control frames.
1526 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1528 Set the location to use in calculating regulatory constraints.
1529 The location is also advertised in beacon and probe response frames
1530 when 802.11d is enabled with
1539 Enable powersave operation.
1540 When operating as a client, the station will conserve power by
1541 periodically turning off the radio and listening for
1542 messages from the access point telling it there are packets waiting.
1543 The station must then retrieve the packets.
1544 Not all devices support power save operation as a client.
1545 The 802.11 specification requires that all access points support
1546 power save but some drivers do not.
1549 to disable powersave operation when operating as a client.
1550 .It Cm powersavesleep Ar sleep
1551 Set the desired max powersave sleep time in TU's (1024 usecs).
1552 By default the max powersave sleep time is 100 TU's.
1553 .It Cm protmode Ar technique
1554 For interfaces operating in 802.11g, use the specified
1556 for protecting OFDM frames in a mixed 11b/11g network.
1557 The set of valid techniques is
1563 Technique names are case insensitive.
1564 Not all devices support
1566 as a protection technique.
1568 When operating as an access point in 802.11g mode allow only
1569 11g-capable stations to associate (11b-only stations are not
1570 permitted to associate).
1571 To allow both 11g and 11b-only stations to associate, use
1574 When operating as an access point in 802.11n mode allow only
1575 HT-capable stations to associate (legacy stations are not
1576 permitted to associate).
1577 To allow both HT and legacy stations to associate, use
1579 .It Cm regdomain Ar sku
1580 Set the regulatory domain to use in calculating the regulatory constraints
1582 In particular the set of available channels, how the wireless device
1583 will operation on the channels, and the maximum transmit power that
1584 can be used on a channel are defined by this setting.
1585 Regdomain codes (SKU's) are taken from
1586 .Pa /etc/regdomain.xml
1588 be viewed with the ``list countries'' request.
1589 Note that not all devices support changing the regdomain from a default
1590 setting; typically stored in EEPROM.
1598 Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n
1600 Note that RIFS must be supported by both the station and access point
1604 .It Cm roam:rate Ar rate
1605 Set the threshold for controlling roaming when operating in a BSS.
1608 parameter specifies the transmit rate in megabits
1609 at which roaming should be considered.
1610 If the current transmit rate drops below this setting and background scanning
1611 is enabled, then the system will check if a more desirable access point is
1612 available and switch over to it.
1613 The current scan cache contents are used if they are considered
1614 valid according to the
1616 parameter; otherwise a background scan operation is triggered before
1617 any selection occurs.
1618 Each channel type has a separate rate threshold; the default values are:
1619 12 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng).
1620 .It Cm roam:rssi Ar rssi
1621 Set the threshold for controlling roaming when operating in a BSS.
1624 parameter specifies the receive signal strength in dBm units
1625 at which roaming should be considered.
1626 If the current rssi drops below this setting and background scanning
1627 is enabled, then the system will check if a more desirable access point is
1628 available and switch over to it.
1629 The current scan cache contents are used if they are considered
1630 valid according to the
1632 parameter; otherwise a background scan operation is triggered before
1633 any selection occurs.
1634 Each channel type has a separate rssi threshold; the default values are
1636 .It Cm roaming Ar mode
1637 When operating as a station, control how the system will
1638 behave when communication with the current access point
1642 argument may be one of
1644 (leave it to the hardware device to decide),
1646 (handle either in the device or the operating system\[em]as appropriate),
1648 (do nothing until explicitly instructed).
1649 By default, the device is left to handle this if it is
1650 capable; otherwise, the operating system will automatically
1651 attempt to reestablish communication.
1652 Manual mode is used by applications such as
1653 .Xr wpa_supplicant 8
1654 that want to control the selection of an access point.
1655 .It Cm rtsthreshold Ar length
1656 Set the threshold for which
1657 transmitted frames are preceded by transmission of an
1663 is the frame size in bytes and must be in the range 1 to 2346.
1671 disables transmission of RTS frames.
1672 Not all adapters support setting the RTS threshold.
1674 Initiate a scan of neighboring stations, wait for it to complete, and
1675 display all stations found.
1676 Only the super-user can initiate a scan.
1679 for information on the display.
1680 By default a background scan is done; otherwise a foreground
1681 scan is done and the station may roam to a different access point.
1684 request can be used to show recent scan results without
1685 initiating a new scan.
1686 .It Cm scanvalid Ar threshold
1687 Set the maximum time the scan cache contents are considered valid;
1688 i.e., will be used without first triggering a scan operation to
1692 parameter is specified in seconds and defaults to 60 seconds.
1693 The minimum setting for
1696 One should take care setting this threshold; if it is set too low
1697 then attempts to roam to another access point may trigger unnecessary
1698 background scan operations.
1700 Enable use of Short Guard Interval when operating in 802.11n
1702 NB: this currently enables Short GI on both HT40 and HT20 channels.
1703 To disable Short GI use
1706 Enable use of Static Spatial Multiplexing Power Save (SMPS)
1707 when operating in 802.11n.
1708 A station operating with Static SMPS maintains only a single
1709 receive chain active (this can significantly reduce power consumption).
1713 Enable use of Dynamic Spatial Multiplexing Power Save (SMPS)
1714 when operating in 802.11n.
1715 A station operating with Dynamic SMPS maintains only a single
1716 receive chain active but switches to multiple receive chains when it
1717 receives an RTS frame (this can significantly reduce power consumption).
1718 Note that stations cannot distinguish between RTS/CTS intended to
1719 enable multiple receive chains and those used for other purposes.
1723 Set the desired Service Set Identifier (aka network name).
1724 The SSID is a string up to 32 characters
1725 in length and may be specified as either a normal string or in
1726 hexadecimal when preceded by
1728 Additionally, the SSID may be cleared by setting it to
1730 .It Cm tdmaslot Ar slot
1731 When operating with TDMA, use the specified
1736 is a number between 0 and the maximum number of slots in the BSS.
1737 Note that a station configured as slot 0 is a master and
1738 will broadcast beacon frames advertising the BSS;
1739 stations configured to use other slots will always
1740 scan to locate a master before they ever transmit.
1744 .It Cm tdmaslotcnt Ar cnt
1745 When operating with TDMA, setup a BSS with
1748 The slot count may be at most 8.
1749 The current implementation is only tested with two stations
1750 (i.e., point to point applications).
1751 This setting is only meaningful when a station is configured as slot 0;
1752 other stations adopt this setting from the BSS they join.
1756 .It Cm tdmaslotlen Ar len
1757 When operating with TDMA, setup a BSS such that each station has a slot
1760 The slot length must be at least 150 microseconds (1/8 TU)
1761 and no more than 65 milliseconds.
1762 Note that setting too small a slot length may result in poor channel
1763 bandwidth utilization due to factors such as timer granularity and
1765 This setting is only meaningful when a station is configured as slot 0;
1766 other stations adopt this setting from the BSS they join.
1769 is set to 10 milliseconds.
1770 .It Cm tdmabintval Ar intval
1771 When operating with TDMA, setup a BSS such that beacons are transmitted every
1773 superframes to synchronize the TDMA slot timing.
1774 A superframe is defined as the number of slots times the slot length; e.g.,
1775 a BSS with two slots of 10 milliseconds has a 20 millisecond superframe.
1776 The beacon interval may not be zero.
1779 causes the timers to be resynchronized more often; this can be help if
1780 significant timer drift is observed.
1785 When operating as an access point with WPA/802.11i allow legacy
1786 stations to associate using static key WEP and open authentication.
1787 To disallow legacy station use of WEP, use
1789 .It Cm txpower Ar power
1790 Set the power used to transmit frames.
1793 argument is specified in .5 dBm units.
1794 Out of range values are truncated.
1795 Typically only a few discreet power settings are available and
1796 the driver will use the setting closest to the specified value.
1797 Not all adapters support changing the transmit power.
1798 .It Cm ucastrate Ar rate
1799 Set a fixed rate for transmitting unicast frames.
1800 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1801 This rate should be valid for the current operating conditions;
1802 if an invalid rate is specified drivers are free to chose an
1804 .It Cm wepmode Ar mode
1805 Set the desired WEP mode.
1806 Not all adapters support all modes.
1807 The set of valid modes is
1813 mode explicitly tells the adaptor to allow association with access
1814 points which allow both encrypted and unencrypted traffic.
1817 means that the access point must only allow encrypted connections.
1820 is generally another name for
1822 Modes are case insensitive.
1823 .It Cm weptxkey Ar index
1824 Set the WEP key to be used for transmission.
1825 This is the same as setting the default transmission key with
1827 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
1828 Set the selected WEP key.
1831 is not given, key 1 is set.
1832 A WEP key will be either 5 or 13
1833 characters (40 or 104 bits) depending on the local network and the
1834 capabilities of the adaptor.
1835 It may be specified either as a plain
1836 string or as a string of hexadecimal digits preceded by
1838 For maximum portability, hex keys are recommended;
1839 the mapping of text keys to WEP encryption is usually driver-specific.
1842 drivers do this mapping differently to
1844 A key may be cleared by setting it to
1846 If WEP is supported then there are at least four keys.
1847 Some adapters support more than four keys.
1848 If that is the case, then the first four keys
1849 (1-4) will be the standard temporary keys and any others will be adaptor
1850 specific keys such as permanent keys stored in NVRAM.
1852 Note that you must set a default transmit key with
1854 for the system to know which key to use in encrypting outbound traffic.
1856 Enable Wireless Multimedia Extensions (WME) support, if available,
1857 for the specified interface.
1858 WME is a subset of the IEEE 802.11e standard to support the
1859 efficient communication of realtime and multimedia data.
1860 To disable WME support, use
1862 Another name for this parameter is
1865 The following parameters are meaningful only when WME support is in use.
1866 Parameters are specified per-AC (Access Category) and
1867 split into those that are used by a station when acting
1868 as an access point and those for client stations in the BSS.
1869 The latter are received from the access point and may not be changed
1871 The following Access Categories are recognized:
1873 .Bl -tag -width ".Cm AC_BK" -compact
1877 best effort delivery,
1892 AC parameters are case-insensitive.
1893 Traffic classification is done in the operating system using the
1894 vlan priority associated with data frames or the
1895 ToS (Type of Service) indication in IP-encapsulated frames.
1896 If neither information is present, traffic is assigned to the
1897 Best Effort (BE) category.
1898 .Bl -tag -width indent
1900 Set the ACK policy for QoS transmissions by the local station;
1901 this controls whether or not data frames transmitted by a station
1902 require an ACK response from the receiving station.
1903 To disable waiting for an ACK use
1905 This parameter is applied only to the local station.
1907 Enable the Admission Control Mandatory (ACM) mechanism
1908 for transmissions by the local station.
1909 To disable the ACM use
1911 On stations in a BSS this parameter is read-only and indicates
1912 the setting received from the access point.
1913 NB: ACM is not supported right now.
1914 .It Cm aifs Ar ac Ar count
1915 Set the Arbitration Inter Frame Spacing (AIFS)
1916 channel access parameter to use for transmissions
1917 by the local station.
1918 On stations in a BSS this parameter is read-only and indicates
1919 the setting received from the access point.
1920 .It Cm cwmin Ar ac Ar count
1921 Set the CWmin channel access parameter to use for transmissions
1922 by the local station.
1923 On stations in a BSS this parameter is read-only and indicates
1924 the setting received from the access point.
1925 .It Cm cwmax Ar ac Ar count
1926 Set the CWmax channel access parameter to use for transmissions
1927 by the local station.
1928 On stations in a BSS this parameter is read-only and indicates
1929 the setting received from the access point.
1930 .It Cm txoplimit Ar ac Ar limit
1931 Set the Transmission Opportunity Limit channel access parameter
1932 to use for transmissions by the local station.
1933 This parameter defines an interval of time when a WME station
1934 has the right to initiate transmissions onto the wireless medium.
1935 On stations in a BSS this parameter is read-only and indicates
1936 the setting received from the access point.
1937 .It Cm bss:aifs Ar ac Ar count
1938 Set the AIFS channel access parameter to send to stations in a BSS.
1939 This parameter is meaningful only when operating in ap mode.
1940 .It Cm bss:cwmin Ar ac Ar count
1941 Set the CWmin channel access parameter to send to stations in a BSS.
1942 This parameter is meaningful only when operating in ap mode.
1943 .It Cm bss:cwmax Ar ac Ar count
1944 Set the CWmax channel access parameter to send to stations in a BSS.
1945 This parameter is meaningful only when operating in ap mode.
1946 .It Cm bss:txoplimit Ar ac Ar limit
1947 Set the TxOpLimit channel access parameter to send to stations in a BSS.
1948 This parameter is meaningful only when operating in ap mode.
1951 Enable Wireless Privacy Subscriber support.
1952 Note that WPS support requires a WPS-capable supplicant.
1953 To disable this function use
1957 The following parameters support an optional access control list
1958 feature available with some adapters when operating in ap mode; see
1960 This facility allows an access point to accept/deny association
1961 requests based on the MAC address of the station.
1962 Note that this feature does not significantly enhance security
1963 as MAC address spoofing is easy to do.
1964 .Bl -tag -width indent
1965 .It Cm mac:add Ar address
1966 Add the specified MAC address to the database.
1967 Depending on the policy setting association requests from the
1968 specified station will be allowed or denied.
1970 Set the ACL policy to permit association only by
1971 stations registered in the database.
1972 .It Cm mac:del Ar address
1973 Delete the specified MAC address from the database.
1975 Set the ACL policy to deny association only by
1976 stations registered in the database.
1977 .It Cm mac:kick Ar address
1978 Force the specified station to be deauthenticated.
1979 This typically is done to block a station after updating the
1982 Set the ACL policy to allow all stations to associate.
1984 Delete all entries in the database.
1986 Set the ACL policy to permit association only by
1987 stations approved by a RADIUS server.
1988 Note that this feature requires the
1990 program be configured to do the right thing
1991 as it handles the RADIUS processing
1992 (and marks stations as authorized).
1995 The following parameters are related to a wireless interface operating in mesh
1997 .Bl -tag -width indent
1998 .It Cm meshid Ar meshid
1999 Set the desired Mesh Identifier.
2000 The Mesh ID is a string up to 32 characters in length.
2001 A mesh interface must have a Mesh Identifier specified
2002 to reach an operational state.
2003 .It Cm meshttl Ar ttl
2004 Set the desired ``time to live'' for mesh forwarded packets;
2005 this is the number of hops a packet may be forwarded before
2007 The default setting for
2011 Enable or disable peering with neighbor mesh stations.
2012 Stations must peer before any data packets can be exchanged.
2017 Enable or disable forwarding packets by a mesh interface.
2022 This attribute specifies whether or not the mesh STA activates mesh gate
2027 .It Cm meshmetric Ar protocol
2030 as the link metric protocol used on a mesh network.
2031 The default protocol is called
2033 The mesh interface will restart after changing this setting.
2034 .It Cm meshpath Ar protocol
2037 as the path selection protocol used on a mesh network.
2038 The only available protocol at the moment is called
2040 (Hybrid Wireless Mesh Protocol).
2041 The mesh interface will restart after changing this setting.
2042 .It Cm hwmprootmode Ar mode
2043 Stations on a mesh network can operate as ``root nodes.''
2044 Root nodes try to find paths to all mesh nodes and advertise themselves
2046 When there is a root mesh node on a network, other mesh nodes can setup
2047 paths between themselves faster because they can use the root node
2048 to find the destination.
2049 This path may not be the best, but on-demand
2050 routing will eventually find the best path.
2051 The following modes are recognized:
2053 .Bl -tag -width ".Cm PROACTIVE" -compact
2057 Send broadcast path requests every two seconds.
2058 Nodes on the mesh without a path to this root mesh station with try to
2059 discover a path to us.
2061 Send broadcast path requests every two seconds and every node must reply
2062 with a path reply even if it already has a path to this root mesh station.
2064 Send broadcast root announcement (RANN) frames.
2065 Nodes on the mesh without a path to this root mesh station with try to
2066 discover a path to us.
2072 .It Cm hwmpmaxhops Ar cnt
2073 Set the maximum number of hops allowed in an HMWP path to
2075 The default setting for
2080 The following parameters are for compatibility with other systems:
2081 .Bl -tag -width indent
2083 Another name for the
2089 .It Cm stationname Ar name
2090 Set the name of this station.
2091 The station name is not part of the IEEE 802.11
2092 protocol though some interfaces support it.
2094 seems to be meaningful to identical or virtually identical equipment.
2095 Setting the station name is identical in syntax to setting the SSID.
2102 Another way of saying
2108 Another way of saying
2114 Another way of saying:
2115 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
2121 .Ar n : k1 , k2 , k3 , k4
2124 Another way of saying
2125 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
2130 Another way of saying
2137 The following parameters are specific to bridge interfaces:
2138 .Bl -tag -width indent
2139 .It Cm addm Ar interface
2140 Add the interface named by
2142 as a member of the bridge.
2143 The interface is put into promiscuous mode
2144 so that it can receive every packet sent on the network.
2145 .It Cm deletem Ar interface
2146 Remove the interface named by
2149 Promiscuous mode is disabled on the interface when
2150 it is removed from the bridge.
2151 .It Cm maxaddr Ar size
2152 Set the size of the bridge address cache to
2154 The default is 2000 entries.
2155 .It Cm timeout Ar seconds
2156 Set the timeout of address cache entries to
2161 is zero, then address cache entries will not be expired.
2162 The default is 1200 seconds.
2164 Display the addresses that have been learned by the bridge.
2165 .It Cm static Ar interface-name Ar address
2166 Add a static entry into the address cache pointing to
2167 .Ar interface-name .
2168 Static entries are never aged out of the cache or re-placed, even if the
2169 address is seen on a different interface.
2170 .It Cm deladdr Ar address
2173 from the address cache.
2175 Delete all dynamically-learned addresses from the address cache.
2177 Delete all addresses, including static addresses, from the address cache.
2178 .It Cm discover Ar interface
2179 Mark an interface as a
2182 When the bridge has no address cache entry
2183 (either dynamic or static)
2184 for the destination address of a packet,
2185 the bridge will forward the packet to all
2186 member interfaces marked as
2188 This is the default for all interfaces added to a bridge.
2189 .It Cm -discover Ar interface
2192 attribute on a member interface.
2193 For packets without the
2195 attribute, the only packets forwarded on the interface are broadcast
2196 or multicast packets and packets for which the destination address
2197 is known to be on the interface's segment.
2198 .It Cm learn Ar interface
2199 Mark an interface as a
2202 When a packet arrives on such an interface, the source
2203 address of the packet is entered into the address cache as being a
2204 destination address on the interface's segment.
2205 This is the default for all interfaces added to a bridge.
2206 .It Cm -learn Ar interface
2209 attribute on a member interface.
2210 .It Cm sticky Ar interface
2211 Mark an interface as a
2214 Dynamically learned address entries are treated at static once entered into
2216 Sticky entries are never aged out of the cache or replaced, even if the
2217 address is seen on a different interface.
2218 .It Cm -sticky Ar interface
2221 attribute on a member interface.
2222 .It Cm private Ar interface
2223 Mark an interface as a
2226 A private interface does not forward any traffic to any other port that is also
2227 a private interface.
2228 .It Cm -private Ar interface
2231 attribute on a member interface.
2232 .It Cm span Ar interface
2233 Add the interface named by
2235 as a span port on the bridge.
2236 Span ports transmit a copy of every frame received by the bridge.
2237 This is most useful for snooping a bridged network passively on
2238 another host connected to one of the span ports of the bridge.
2239 .It Cm -span Ar interface
2240 Delete the interface named by
2242 from the list of span ports of the bridge.
2243 .It Cm stp Ar interface
2244 Enable Spanning Tree protocol on
2248 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
2249 Spanning Tree is used to detect and remove loops in a network topology.
2250 .It Cm -stp Ar interface
2251 Disable Spanning Tree protocol on
2253 This is the default for all interfaces added to a bridge.
2254 .It Cm edge Ar interface
2258 An edge port connects directly to end stations cannot create bridging
2259 loops in the network, this allows it to transition straight to forwarding.
2260 .It Cm -edge Ar interface
2261 Disable edge status on
2263 .It Cm autoedge Ar interface
2266 to automatically detect edge status.
2267 This is the default for all interfaces added to a bridge.
2268 .It Cm -autoedge Ar interface
2269 Disable automatic edge status on
2271 .It Cm ptp Ar interface
2274 as a point to point link.
2275 This is required for straight transitions to forwarding and
2276 should be enabled on a direct link to another RSTP capable switch.
2277 .It Cm -ptp Ar interface
2278 Disable point to point link status on
2280 This should be disabled for a half duplex link and for an interface
2281 connected to a shared network segment,
2282 like a hub or a wireless network.
2283 .It Cm autoptp Ar interface
2284 Automatically detect the point to point status on
2286 by checking the full duplex link status.
2287 This is the default for interfaces added to the bridge.
2288 .It Cm -autoptp Ar interface
2289 Disable automatic point to point link detection on
2291 .It Cm maxage Ar seconds
2292 Set the time that a Spanning Tree protocol configuration is valid.
2293 The default is 20 seconds.
2294 The minimum is 6 seconds and the maximum is 40 seconds.
2295 .It Cm fwddelay Ar seconds
2296 Set the time that must pass before an interface begins forwarding
2297 packets when Spanning Tree is enabled.
2298 The default is 15 seconds.
2299 The minimum is 4 seconds and the maximum is 30 seconds.
2300 .It Cm hellotime Ar seconds
2301 Set the time between broadcasting of Spanning Tree protocol
2302 configuration messages.
2303 The hello time may only be changed when operating in legacy stp mode.
2304 The default is 2 seconds.
2305 The minimum is 1 second and the maximum is 2 seconds.
2306 .It Cm priority Ar value
2307 Set the bridge priority for Spanning Tree.
2308 The default is 32768.
2309 The minimum is 0 and the maximum is 61440.
2310 .It Cm proto Ar value
2311 Set the Spanning Tree protocol.
2312 The default is rstp.
2313 The available options are stp and rstp.
2314 .It Cm holdcnt Ar value
2315 Set the transmit hold count for Spanning Tree.
2316 This is the number of packets transmitted before being rate limited.
2318 The minimum is 1 and the maximum is 10.
2319 .It Cm ifpriority Ar interface Ar value
2320 Set the Spanning Tree priority of
2325 The minimum is 0 and the maximum is 240.
2326 .It Cm ifpathcost Ar interface Ar value
2327 Set the Spanning Tree path cost of
2331 The default is calculated from the link speed.
2332 To change a previously selected path cost back to automatic, set the
2334 The minimum is 1 and the maximum is 200000000.
2335 .It Cm ifmaxaddr Ar interface Ar size
2336 Set the maximum number of hosts allowed from an interface, packets with unknown
2337 source addresses are dropped until an existing host cache entry expires or is
2339 Set to 0 to disable.
2342 The following parameters are specific to lagg interfaces:
2343 .Bl -tag -width indent
2344 .It Cm laggport Ar interface
2345 Add the interface named by
2347 as a port of the aggregation interface.
2348 .It Cm -laggport Ar interface
2349 Remove the interface named by
2351 from the aggregation interface.
2352 .It Cm laggproto Ar proto
2353 Set the aggregation protocol.
2354 The default is failover.
2355 The available options are failover, fec, lacp, loadbalance, roundrobin and
2357 .It Cm lagghash Ar option Ns Oo , Ns Ar option Oc
2358 Set the packet layers to hash for aggregation protocols which load balance.
2361 The options can be combined using commas.
2363 .Bl -tag -width ".Cm l2" -compact
2365 src/dst mac address and optional vlan number.
2367 src/dst address for IPv4 or IPv6.
2369 src/dst port for TCP/UDP/SCTP.
2374 The following parameters are specific to IP tunnel interfaces,
2376 .Bl -tag -width indent
2377 .It Cm tunnel Ar src_addr dest_addr
2378 Configure the physical source and destination address for IP tunnel
2384 are interpreted as the outer source/destination for the encapsulating
2387 Unconfigure the physical source and destination address for IP tunnel
2388 interfaces previously configured with
2391 Another name for the
2394 .It Cm accept_rev_ethip_ver
2395 Set a flag to accept both correct EtherIP packets and ones
2396 with reversed version field. Enabled by default.
2397 This is for backward compatibility with
2399 6.2, 6.3, 7.0, and 7.1.
2400 .It Cm -accept_rev_ethip_ver
2402 .Cm accept_rev_ethip_ver .
2403 .It Cm send_rev_ethip_ver
2404 Set a flag to send EtherIP packets with reversed version
2405 field intentionally. Disabled by default.
2406 This is for backward compatibility with
2408 6.2, 6.3, 7.0, and 7.1.
2409 .It Cm -send_rev_ethip_ver
2411 .Cm send_rev_ethip_ver .
2414 The following parameters are specific to GRE tunnel interfaces,
2416 .Bl -tag -width indent
2417 .It Cm grekey Ar key
2418 Configure the GRE key to be used for outgoing packets.
2420 .Xr gre 4 will always accept GRE packets with invalid or absent keys.
2421 This command will result in a four byte MTU reduction on the interface.
2424 The following parameters are specific to
2427 .Bl -tag -width indent
2428 .It Cm syncdev Ar iface
2429 Use the specified interface
2430 to send and receive pfsync state synchronisation messages.
2432 Stop sending pfsync state synchronisation messages over the network.
2433 .It Cm syncpeer Ar peer_address
2434 Make the pfsync link point-to-point rather than using
2435 multicast to broadcast the state synchronisation messages.
2436 The peer_address is the IP address of the other host taking part in
2439 Broadcast the packets using multicast.
2441 Set the maximum number of updates for a single state which
2442 can be collapsed into one.
2443 This is an 8-bit number; the default value is 128.
2445 Defer transmission of the first packet in a state until a peer has
2446 acknowledged that the associated state has been inserted.
2448 Do not defer the first packet in a state.
2449 This is the default.
2452 The following parameters are specific to
2455 .Bl -tag -width indent
2456 .It Cm vlan Ar vlan_tag
2457 Set the VLAN tag value to
2459 This value is a 12-bit VLAN Identifier (VID) which is used to create an 802.1Q
2460 VLAN header for packets sent from the
2467 must both be set at the same time.
2468 .It Cm vlandev Ar iface
2469 Associate the physical interface
2474 Packets transmitted through the
2477 diverted to the specified physical interface
2479 with 802.1Q VLAN encapsulation.
2480 Packets with 802.1Q encapsulation received
2481 by the parent interface with the correct VLAN Identifier will be diverted to
2487 interface is assigned a
2488 copy of the parent interface's flags and the parent's ethernet address.
2493 must both be set at the same time.
2496 interface already has
2497 a physical interface associated with it, this command will fail.
2499 change the association to another physical interface, the existing
2500 association must be cleared first.
2502 Note: if the hardware tagging capability
2503 is set on the parent interface, the
2506 interface's behavior changes:
2509 interface recognizes that the
2510 parent interface supports insertion and extraction of VLAN tags on its
2511 own (usually in firmware) and that it should pass packets to and from
2512 the parent unaltered.
2513 .It Fl vlandev Op Ar iface
2516 pseudo device, disassociate the parent interface from it.
2517 This breaks the link between the
2519 interface and its parent,
2520 clears its VLAN Identifier, flags and its link address and shuts the interface
2524 argument is useless and hence deprecated.
2527 The following parameters are used to configure
2529 protocol on an interface:
2530 .Bl -tag -width indent
2532 Set the virtual host ID.
2533 This is a required setting to initiate
2535 If the virtual host ID does not exist yet, it is created and attached to the
2536 interface, otherwise configuration of an existing vhid is adjusted.
2539 keyword is supplied along with an
2543 address, then this address is configured to be run under control of the
2545 Whenever a last address that refers to a particular vhid is removed from an
2546 interface, the vhid is automatically removed from interface and destroyed.
2547 Any other configuration parameters for the
2549 protocol should be supplied along with the
2552 Acceptable values for vhid are 1 to 255.
2553 .It Cm advbase Ar seconds
2554 Specifies the base of the advertisement interval in seconds.
2555 The acceptable values are 1 to 255.
2556 The default value is 1.
2557 .It Cm advskew Ar interval
2558 Specifies the skew to add to the base advertisement interval to
2559 make one host advertise slower than another host.
2560 It is specified in 1/256 of seconds.
2561 The acceptable values are 1 to 254.
2562 The default value is 0.
2563 .It Cm pass Ar phrase
2564 Set the authentication key to
2566 .It Cm state Ar MASTER|BACKUP
2567 Forcibly change state of a given vhid.
2572 utility displays the current configuration for a network interface
2573 when no optional parameters are supplied.
2574 If a protocol family is specified,
2576 will report only the details specific to that protocol family.
2580 flag is passed before an interface name,
2582 will display the capability list and all
2583 of the supported media for the specified interface.
2586 flag is supplied, address lifetime is displayed for IPv6 addresses,
2587 as time offset string.
2591 flag may be used instead of an interface name.
2594 to display information about all interfaces in the system.
2597 flag limits this to interfaces that are down, and
2599 limits this to interfaces that are up.
2600 When no arguments are given,
2606 flag may be used to list all available interfaces on the system, with
2607 no other additional information.
2608 Use of this flag is mutually exclusive
2609 with all other flags and commands, except for
2611 (only list interfaces that are down)
2614 (only list interfaces that are up).
2618 flag may be used to get more verbose status for an interface.
2622 flag may be used to list all of the interface cloners available on
2623 the system, with no additional information.
2624 Use of this flag is mutually exclusive with all other flags and commands.
2628 flag causes keying information for the interface, if available, to be
2630 For example, the values of 802.11 WEP keys and
2632 passphrases will be printed, if accessible to the current user.
2633 This information is not printed by default, as it may be considered
2636 If the network interface driver is not present in the kernel then
2638 will attempt to load it.
2641 flag disables this behavior.
2643 Only the super-user may modify the configuration of a network interface.
2645 Assign the IPv4 address
2647 with a network mask of
2651 .Dl # ifconfig fxp0 inet 192.0.2.10 netmask 255.255.255.0
2653 Add the IPv4 address
2655 with the CIDR network prefix
2661 as a synonym for the canonical form of the option
2663 .Dl # ifconfig ed0 inet 192.0.2.45/28 add
2665 Remove the IPv4 address
2669 .Dl # ifconfig ed0 inet 192.0.2.45 -alias
2671 Enable IPv6 functionality of the interface:
2672 .Dl # ifconfig em0 inet6 -ifdisabled
2674 Add the IPv6 address
2675 .Li 2001:DB8:DBDB::123/48
2678 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias
2679 Note that lower case hexadecimal IPv6 addresses are acceptable.
2681 Remove the IPv6 address added in the above example,
2684 character as shorthand for the network prefix,
2687 as a synonym for the canonical form of the option
2689 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 delete
2691 Configure a single CARP redundant address on igb0, and then switch it
2693 .Dl # ifconfig igb0 vhid 1 10.0.0.1/24 pass foobar up
2694 .Dl # ifconfig igb0 vhid 1 state master
2696 Configure the interface
2698 to use 100baseTX, full duplex Ethernet media options:
2699 .Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex
2701 Label the em0 interface as an uplink:
2702 .Dl # ifconfig em0 description \&"Uplink to Gigabit Switch 2\&"
2704 Create the software network interface
2706 .Dl # ifconfig gif1 create
2708 Destroy the software network interface
2710 .Dl # ifconfig gif1 destroy
2712 Display available wireless networks using
2714 .Dl # ifconfig wlan0 list scan
2716 Messages indicating the specified interface does not exist, the
2717 requested address is unknown, or the user is not privileged and
2718 tried to alter an interface's configuration.
2740 Basic IPv6 node operation requires a link-local address on each
2741 interface configured for IPv6.
2742 Normally, such an address is automatically configured by the
2743 kernel on each interface added to the system or enabled; this behavior may
2744 be disabled by setting per-interface flag
2745 .Cm -auto_linklocal .
2746 The default value of this flag is 1 and can be disabled by using the sysctl
2748 .Va net.inet6.ip6.auto_linklocal .
2750 Do not configure IPv6 addresses with no link-local address by using
2752 It can result in unexpected behaviors of the kernel.
projects / FreeBSD / releng / 10.0.git / blob