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.
720 Set a flag to prefer addresses on the interface as candidates of the
721 source address for outgoing packets.
722 .It Cm -prefer_source
727 The following parameters are specific to cloning
728 IEEE 802.11 wireless interfaces with the
731 .Bl -tag -width indent
732 .It Cm wlandev Ar device
735 as the parent for the cloned device.
736 .It Cm wlanmode Ar mode
737 Specify the operating mode for this cloned device.
755 The operating mode of a cloned interface cannot be changed.
758 mode is actually implemented as an
760 interface with special properties.
761 .It Cm wlanbssid Ar bssid
762 The 802.11 mac address to use for the bssid.
763 This must be specified at create time for a legacy
766 .It Cm wlanaddr Ar address
767 The local mac address.
768 If this is not specified then a mac address will automatically be assigned
769 to the cloned device.
770 Typically this address is the same as the address of the parent device
773 parameter is specified then the driver will craft a unique address for
774 the device (if supported).
778 device as operating in ``legacy mode''.
781 devices have a fixed peer relationship and do not, for example, roam
782 if their peer stops communicating.
783 For completeness a Dynamic WDS (DWDS) interface may marked as
786 Request a unique local mac address for the cloned device.
787 This is only possible if the device supports multiple mac addresses.
788 To force use of the parent's mac address use
791 Mark the cloned interface as depending on hardware support to
792 track received beacons.
793 To have beacons tracked in software use
799 can also be used to indicate no beacons should
800 be transmitted; this can be useful when creating a WDS configuration but
802 interfaces can only be created as companions to an access point.
805 The following parameters are specific to IEEE 802.11 wireless interfaces
809 .Bl -tag -width indent
811 Enable sending and receiving AMPDU frames when using 802.11n (default).
812 The 802.11n specification states a compliant station must be capable
813 of receiving AMPDU frames but transmission is optional.
816 to disable all use of AMPDU with 802.11n.
817 For testing and/or to work around interoperability problems one can use
821 to control use of AMPDU in one direction.
822 .It Cm ampdudensity Ar density
823 Set the AMPDU density parameter used when operating with 802.11n.
824 This parameter controls the inter-packet gap for AMPDU frames.
825 The sending device normally controls this setting but a receiving station
826 may request wider gaps.
829 are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds).
832 is treated the same as 0.
833 .It Cm ampdulimit Ar limit
834 Set the limit on packet size for receiving AMPDU frames when operating
838 are 8192, 16384, 32768, and 65536 but one can also specify
839 just the unique prefix: 8, 16, 32, 64.
840 Note the sender may limit the size of AMPDU frames to be less
841 than the maximum specified by the receiving station.
843 Enable sending and receiving AMSDU frames when using 802.11n.
844 By default AMSDU is received but not transmitted.
847 to disable all use of AMSDU with 802.11n.
848 For testing and/or to work around interoperability problems one can use
852 to control use of AMSDU in one direction.
853 .It Cm amsdulimit Ar limit
854 Set the limit on packet size for sending and receiving AMSDU frames
855 when operating with 802.11n.
858 are 7935 and 3839 (bytes).
859 Note the sender may limit the size of AMSDU frames to be less
860 than the maximum specified by the receiving station.
861 Note also that devices are not required to support the 7935 limit,
862 only 3839 is required by the specification and the larger value
863 may require more memory to be dedicated to support functionality
866 When operating as an access point, pass packets between
867 wireless clients directly (default).
868 To instead let them pass up through the
869 system and be forwarded using some other mechanism, use
871 Disabling the internal bridging
872 is useful when traffic is to be processed with
874 .It Cm authmode Ar mode
875 Set the desired authentication mode in infrastructure mode.
876 Not all adapters support all modes.
879 .Cm none , open , shared
885 (IEEE WPA/WPA2/802.11i).
890 modes are only useful when using an authentication service
891 (a supplicant for client operation or an authenticator when
892 operating as an access point).
893 Modes are case insensitive.
895 Enable background scanning when operating as a station.
896 Background scanning is a technique whereby a station associated to
897 an access point will temporarily leave the channel to scan for
898 neighboring stations.
899 This allows a station to maintain a cache of nearby access points
900 so that roaming between access points can be done without
901 a lengthy scan operation.
902 Background scanning is done only when a station is not busy and
903 any outbound traffic will cancel a scan operation.
904 Background scanning should never cause packets to be lost though
905 there may be some small latency if outbound traffic interrupts a
907 By default background scanning is enabled if the device is capable.
908 To disable background scanning, use
910 Background scanning is controlled by the
915 Background scanning must be enabled for roaming; this is an artifact
916 of the current implementation and may not be required in the future.
917 .It Cm bgscanidle Ar idletime
918 Set the minimum time a station must be idle (not transmitting or
919 receiving frames) before a background scan is initiated.
922 parameter is specified in milliseconds.
923 By default a station must be idle at least 250 milliseconds before
924 a background scan is initiated.
925 The idle time may not be set to less than 100 milliseconds.
926 .It Cm bgscanintvl Ar interval
927 Set the interval at which background scanning is attempted.
930 parameter is specified in seconds.
931 By default a background scan is considered every 300 seconds (5 minutes).
934 may not be set to less than 15 seconds.
935 .It Cm bintval Ar interval
936 Set the interval at which beacon frames are sent when operating in
940 parameter is specified in TU's (1024 usecs).
941 By default beacon frames are transmitted every 100 TU's.
942 .It Cm bmissthreshold Ar count
943 Set the number of consecutive missed beacons at which the station
944 will attempt to roam (i.e., search for a new access point).
947 parameter must be in the range 1 to 255; though the
948 upper bound may be reduced according to device capabilities.
949 The default threshold is 7 consecutive missed beacons; but
950 this may be overridden by the device driver.
955 .It Cm bssid Ar address
956 Specify the MAC address of the access point to use when operating
957 as a station in a BSS network.
958 This overrides any automatic selection done by the system.
959 To disable a previously selected access point, supply
964 This option is useful when more than one access point uses the same SSID.
970 Enable packet bursting.
971 Packet bursting is a transmission technique whereby the wireless
972 medium is acquired once to send multiple frames and the interframe
974 This technique can significantly increase throughput by reducing
975 transmission overhead.
976 Packet bursting is supported by the 802.11e QoS specification
977 and some devices that do not support QoS may still be capable.
978 By default packet bursting is enabled if a device is capable
980 To disable packet bursting, use
982 .It Cm chanlist Ar channels
983 Set the desired channels to use when scanning for access
984 points, neighbors in an IBSS network, or looking for unoccupied
985 channels when operating as an access point.
986 The set of channels is specified as a comma-separated list with
987 each element in the list representing either a single channel number or a range
990 Channel numbers must be in the range 1 to 255 and be permissible
991 according to the operating characteristics of the device.
992 .It Cm channel Ar number
993 Set a single desired channel.
994 Channels range from 1 to 255, but the exact selection available
995 depends on the region your adaptor was manufactured for.
1001 will clear any desired channel and, if the device is marked up,
1002 force a scan for a channel to operate on.
1003 Alternatively the frequency, in megahertz, may be specified
1004 instead of the channel number.
1006 When there are several ways to use a channel the channel
1007 number/frequency may be appended with attributes to clarify.
1008 For example, if a device is capable of operating on channel 6
1009 with 802.11n and 802.11g then one can specify that g-only use
1010 should be used by specifying ``6:g''.
1011 Similarly the channel width can be specified by appending it
1012 with ``/''; e.g. ``6/40'' specifies a 40MHz wide channel,
1013 These attributes can be combined as in: ``6:ht/40''.
1014 The full set of flags specified following a ``:'' are:
1020 (Atheros Dynamic Turbo mode),
1028 (Atheros Static Turbo mode),
1031 (Atheros Dynamic Turbo mode, or appended to ``st'' and ``dt'').
1032 The full set of channel widths following a '/' are:
1034 (5MHz aka quarter-rate channel),
1036 (10MHz aka half-rate channel),
1038 (20MHz mostly for use in specifying ht20),
1041 (40MHz mostly for use in specifying ht40).
1043 a 40MHz HT channel specification may include the location
1044 of the extension channel by appending ``+'' or ``-'' for above and below,
1045 respectively; e.g. ``2437:ht/40+'' specifies 40MHz wide HT operation
1046 with the center channel at frequency 2437 and the extension channel above.
1047 .It Cm country Ar name
1048 Set the country code to use in calculating the regulatory constraints
1050 In particular the set of available channels, how the wireless device
1051 will operation on the channels, and the maximum transmit power that
1052 can be used on a channel are defined by this setting.
1053 Country/Region codes are specified as a 2-character abbreviation
1054 defined by ISO 3166 or using a longer, but possibly ambiguous, spelling;
1055 e.g. "ES" and "Spain".
1056 The set of country codes are taken from /etc/regdomain.xml and can also
1057 be viewed with the ``list countries'' request.
1058 Note that not all devices support changing the country code from a default
1059 setting; typically stored in EEPROM.
1067 Enable Dynamic Frequency Selection (DFS) as specified in 802.11h.
1068 DFS embodies several facilities including detection of overlapping
1069 radar signals, dynamic transmit power control, and channel selection
1070 according to a least-congested criteria.
1071 DFS support is mandatory for some 5GHz frequencies in certain
1072 locales (e.g. ETSI).
1073 By default DFS is enabled according to the regulatory definitions
1074 specified in /etc/regdomain.xml and the current country code, regdomain,
1076 Note the underlying device (and driver) must support radar detection
1077 for full DFS support to work.
1078 To be fully compliant with the local regulatory agency frequencies that
1079 require DFS should not be used unless it is fully supported.
1082 to disable this functionality for testing.
1084 Enable support for the 802.11d specification (default).
1085 When this support is enabled in station mode, beacon frames that advertise
1086 a country code different than the currently configured country code will
1087 cause an event to be dispatched to user applications.
1088 This event can be used by the station to adopt that country code and
1089 operate according to the associated regulatory constraints.
1090 When operating as an access point with 802.11d enabled the beacon and
1091 probe response frames transmitted will advertise the current regulatory
1093 To disable 802.11d use
1096 Enable 802.11h support including spectrum management.
1097 When 802.11h is enabled beacon and probe response frames will have
1098 the SpectrumMgt bit set in the capabilities field and
1099 country and power constraint information elements will be present.
1100 802.11h support also includes handling Channel Switch Announcements (CSA)
1101 which are a mechanism to coordinate channel changes by an access point.
1102 By default 802.11h is enabled if the device is capable.
1103 To disable 802.11h use
1105 .It Cm deftxkey Ar index
1106 Set the default key to use for transmission.
1107 Typically this is only set when using WEP encryption.
1108 Note that you must set a default transmit key
1109 for the system to know which key to use in encrypting outbound traffic.
1112 is an alias for this request; it is provided for backwards compatibility.
1113 .It Cm dtimperiod Ar period
1116 period for transmitting buffered multicast data frames when
1117 operating in ap mode.
1120 specifies the number of beacon intervals between DTIM
1121 and must be in the range 1 to 15.
1122 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
1124 Enable the use of quiet IE. Hostap will use this to silent other
1125 stations to reduce interference for radar detection when
1126 operating on 5GHz frequency and doth support is enabled.
1129 to disable this functionality.
1130 .It Cm quiet_period Ar period
1133 to the number of beacon intervals between the start of regularly
1134 scheduled quiet intervals defined by Quiet element.
1135 .It Cm quiet_count Ar count
1138 to the number of TBTTs until the beacon interval during which the
1139 next quiet interval shall start. A value of 1 indicates the quiet
1140 interval will start during the beacon interval starting at the next
1141 TBTT. A value 0 is reserved.
1142 .It Cm quiet_offset Ar offset
1145 to the offset of the start of the quiet interval from the TBTT
1146 specified by the Quiet count, expressed in TUs.
1149 shall be less than one beacon interval.
1150 .It Cm quiet_duration Ar dur
1153 to the duration of the Quiet interval, expressed in TUs.
1154 The value should be less than beacon interval.
1156 Enable the use of Atheros Dynamic Turbo mode when communicating with
1157 another Dynamic Turbo-capable station.
1158 Dynamic Turbo mode is an Atheros-specific mechanism by which
1159 stations switch between normal 802.11 operation and a ``boosted''
1160 mode in which a 40MHz wide channel is used for communication.
1161 Stations using Dynamic Turbo mode operate boosted only when the
1162 channel is free of non-dturbo stations; when a non-dturbo station
1163 is identified on the channel all stations will automatically drop
1164 back to normal operation.
1165 By default, Dynamic Turbo mode is not enabled, even if the device is capable.
1166 Note that turbo mode (dynamic or static) is only allowed on some
1167 channels depending on the regulatory constraints; use the
1169 command to identify the channels where turbo mode may be used.
1170 To disable Dynamic Turbo mode use
1173 Enable Dynamic WDS (DWDS) support.
1174 DWDS is a facility by which 4-address traffic can be carried between
1175 stations operating in infrastructure mode.
1176 A station first associates to an access point and authenticates using
1177 normal procedures (e.g. WPA).
1178 Then 4-address frames are passed to carry traffic for stations
1179 operating on either side of the wireless link.
1180 DWDS extends the normal WDS mechanism by leveraging existing security
1181 protocols and eliminating static binding.
1183 When DWDS is enabled on an access point 4-address frames received from
1184 an authorized station will generate a ``DWDS discovery'' event to user
1186 This event should be used to create a WDS interface that is bound
1187 to the remote station (and usually plumbed into a bridge).
1188 Once the WDS interface is up and running 4-address traffic then logically
1189 flows through that interface.
1191 When DWDS is enabled on a station, traffic with a destination address
1192 different from the peer station are encapsulated in a 4-address frame
1193 and transmitted to the peer.
1194 All 4-address traffic uses the security information of the stations
1195 (e.g. cryptographic keys).
1196 A station is associated using 802.11n facilities may transport
1197 4-address traffic using these same mechanisms; this depends on available
1198 resources and capabilities of the device.
1199 The DWDS implementation guards against layer 2 routing loops of
1202 Enable the use of Atheros Fast Frames when communicating with
1203 another Fast Frames-capable station.
1204 Fast Frames are an encapsulation technique by which two 802.3
1205 frames are transmitted in a single 802.11 frame.
1206 This can noticeably improve throughput but requires that the
1207 receiving station understand how to decapsulate the frame.
1208 Fast frame use is negotiated using the Atheros 802.11 vendor-specific
1209 protocol extension so enabling use is safe when communicating with
1210 non-Atheros devices.
1211 By default, use of fast frames is enabled if the device is capable.
1212 To explicitly disable fast frames, use
1214 .It Cm fragthreshold Ar length
1215 Set the threshold for which transmitted frames are broken into fragments.
1218 argument is the frame size in bytes and must be in the range 256 to 2346.
1226 disables transmit fragmentation.
1227 Not all adapters honor the fragmentation threshold.
1229 When operating as an access point, do not broadcast the SSID
1230 in beacon frames or respond to probe request frames unless
1231 they are directed to the ap (i.e., they include the ap's SSID).
1232 By default, the SSID is included in beacon frames and
1233 undirected probe request frames are answered.
1234 To re-enable the broadcast of the SSID etc., use
1237 Enable use of High Throughput (HT) when using 802.11n (default).
1238 The 802.11n specification includes mechanisms for operation
1239 on 20MHz and 40MHz wide channels using different signalling mechanisms
1240 than specified in 802.11b, 802.11g, and 802.11a.
1241 Stations negotiate use of these facilities, termed HT20 and HT40,
1242 when they associate.
1243 To disable all use of 802.11n use
1245 To disable use of HT20 (e.g. to force only HT40 use) use
1247 To disable use of HT40 use
1250 HT configuration is used to ``auto promote'' operation
1251 when several choices are available.
1252 For example, if a station associates to an 11n-capable access point
1253 it controls whether the station uses legacy operation, HT20, or HT40.
1254 When an 11n-capable device is setup as an access point and
1255 Auto Channel Selection is used to locate a channel to operate on,
1256 HT configuration controls whether legacy, HT20, or HT40 operation is setup
1257 on the selected channel.
1258 If a fixed channel is specified for a station then HT configuration can
1259 be given as part of the channel specification; e.g. 6:ht/20 to setup
1260 HT20 operation on channel 6.
1262 Enable use of compatibility support for pre-802.11n devices (default).
1263 The 802.11n protocol specification went through several incompatible iterations.
1264 Some vendors implemented 11n support to older specifications that
1265 will not interoperate with a purely 11n-compliant station.
1266 In particular the information elements included in management frames
1267 for old devices are different.
1268 When compatibility support is enabled both standard and compatible data
1270 Stations that associate using the compatibility mechanisms are flagged
1272 To disable compatibility support use
1274 .It Cm htprotmode Ar technique
1275 For interfaces operating in 802.11n, use the specified
1277 for protecting HT frames in a mixed legacy/HT network.
1278 The set of valid techniques is
1283 Technique names are case insensitive.
1285 Enable inactivity processing for stations associated to an
1286 access point (default).
1287 When operating as an access point the 802.11 layer monitors
1288 the activity of each associated station.
1289 When a station is inactive for 5 minutes it will send several
1290 ``probe frames'' to see if the station is still present.
1291 If no response is received then the station is deauthenticated.
1292 Applications that prefer to handle this work can disable this
1296 Set the location to use in calculating regulatory constraints.
1297 The location is also advertised in beacon and probe response frames
1298 when 802.11d is enabled with
1307 Display the list of channels available for use taking into account
1308 any restrictions set with the
1311 See the description of
1313 for more information.
1315 Display the adaptor's capabilities, including the operating
1318 Display the list of channels available for use.
1319 Channels are shown with their IEEE channel number, equivalent
1320 frequency, and usage modes.
1321 Channels identified as
1326 Channels identified as
1328 may be used only for Atheros' Static Turbo mode
1330 . Cm mediaopt turbo ) .
1331 Channels marked with a
1333 have a regulatory constraint that they be passively scanned.
1334 This means a station is not permitted to transmit on the channel until
1335 it identifies the channel is being used for 802.11 communication;
1336 typically by hearing a beacon frame from an access point operating
1339 is another way of requesting this information.
1340 By default a compacted list of channels is displayed; if the
1342 option is specified then all channels are shown.
1343 .It Cm list countries
1344 Display the set of country codes and regulatory domains that can be
1345 used in regulatory configuration.
1347 Display the current MAC Access Control List state.
1348 Each address is prefixed with a character that indicates the
1349 current policy applied to it:
1351 indicates the address is allowed access,
1353 indicates the address is denied access,
1355 indicates the address is present but the current policy open
1356 (so the ACL is not consulted).
1358 Displays the mesh routing table, used for forwarding packets on a mesh
1360 .It Cm list regdomain
1361 Display the current regulatory settings including the available channels
1362 and transmit power caps.
1364 Display the parameters that govern roaming operation.
1366 Display the parameters that govern transmit operation.
1368 Display the transmit power caps for each channel.
1370 Display the access points and/or ad-hoc neighbors
1371 located in the vicinity.
1372 This information may be updated automatically by the adapter
1375 request or through background scanning.
1376 Depending on the capabilities of the stations the following
1377 flags can be included in the output:
1381 Indicates that the station is permitted to send/receive data frames.
1383 Extended Rate Phy (ERP).
1384 Indicates that the station is operating in an 802.11g network
1385 using extended transmit rates.
1387 High Throughput (HT).
1388 Indicates that the station is using HT transmit rates.
1389 If a `+' follows immediately after then the station associated
1390 using deprecated mechanisms supported only when
1395 Indicates that the station is operating in power save mode.
1397 Quality of Service (QoS).
1398 Indicates that the station is using QoS encapsulation for
1400 QoS encapsulation is enabled only when WME mode is enabled.
1403 Indicates that the station is doing short preamble to optionally
1404 improve throughput performance with 802.11g and 802.11b.
1406 Transitional Security Network (TSN).
1407 Indicates that the station associated using TSN; see also
1411 Wi-Fi Protected Setup (WPS).
1412 Indicates that the station associated using WPS.
1415 By default interesting information elements captured from the neighboring
1416 stations are displayed at the end of each row.
1417 Possible elements include:
1419 (station supports WME),
1421 (station supports WPA),
1423 (station supports WPS),
1425 (station supports 802.11i/RSN),
1427 (station supports 802.11n/HT communication),
1429 (station supports Atheros protocol extensions),
1431 (station supports unknown vendor-specific extensions).
1434 flag is used all the information elements and their
1435 contents will be shown.
1438 flag also enables display of long SSIDs.
1441 command is another way of requesting this information.
1443 When operating as an access point display the stations that are
1444 currently associated.
1445 When operating in ad-hoc mode display stations identified as
1446 neighbors in the IBSS.
1447 When operating in mesh mode display stations identified as
1448 neighbors in the MBSS.
1449 When operating in station mode display the access point.
1450 Capabilities advertised by the stations are described under
1454 Depending on the capabilities of the stations the following
1455 flags can be included in the output:
1459 Indicates that the station is permitted to send/receive data frames.
1461 Extended Rate Phy (ERP).
1462 Indicates that the station is operating in an 802.11g network
1463 using extended transmit rates.
1465 High Throughput (HT).
1466 Indicates that the station is using HT transmit rates.
1467 If a `+' follows immediately after then the station associated
1468 using deprecated mechanisms supported only when
1473 Indicates that the station is operating in power save mode.
1475 Quality of Service (QoS).
1476 Indicates that the station is using QoS encapsulation for
1478 QoS encapsulation is enabled only when WME mode is enabled.
1481 Indicates that the station is doing short preamble to optionally
1482 improve throughput performance with 802.11g and 802.11b.
1484 Transitional Security Network (TSN).
1485 Indicates that the station associated using TSN; see also
1489 Wi-Fi Protected Setup (WPS).
1490 Indicates that the station associated using WPS.
1493 By default information elements received from associated stations
1494 are displayed in a short form; the
1496 flag causes this information to be displayed symbolically.
1498 Display the current channel parameters to use when operating in WME mode.
1501 option is specified then both channel and BSS parameters are displayed
1502 for each AC (first channel, then BSS).
1503 When WME mode is enabled for an adaptor this information will be
1504 displayed with the regular status; this command is mostly useful
1505 for examining parameters when WME mode is disabled.
1506 See the description of the
1508 directive for information on the various parameters.
1509 .It Cm maxretry Ar count
1510 Set the maximum number of tries to use in sending unicast frames.
1511 The default setting is 6 but drivers may override this with a value
1513 .It Cm mcastrate Ar rate
1514 Set the rate for transmitting multicast/broadcast frames.
1515 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
1516 This rate should be valid for the current operating conditions;
1517 if an invalid rate is specified drivers are free to chose an
1519 .It Cm mgtrate Ar rate
1520 Set the rate for transmitting management and/or control frames.
1521 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
1523 Set the location to use in calculating regulatory constraints.
1524 The location is also advertised in beacon and probe response frames
1525 when 802.11d is enabled with
1534 Enable powersave operation.
1535 When operating as a client, the station will conserve power by
1536 periodically turning off the radio and listening for
1537 messages from the access point telling it there are packets waiting.
1538 The station must then retrieve the packets.
1539 Not all devices support power save operation as a client.
1540 The 802.11 specification requires that all access points support
1541 power save but some drivers do not.
1544 to disable powersave operation when operating as a client.
1545 .It Cm powersavesleep Ar sleep
1546 Set the desired max powersave sleep time in TU's (1024 usecs).
1547 By default the max powersave sleep time is 100 TU's.
1548 .It Cm protmode Ar technique
1549 For interfaces operating in 802.11g, use the specified
1551 for protecting OFDM frames in a mixed 11b/11g network.
1552 The set of valid techniques is
1558 Technique names are case insensitive.
1559 Not all devices support
1561 as a protection technique.
1563 When operating as an access point in 802.11g mode allow only
1564 11g-capable stations to associate (11b-only stations are not
1565 permitted to associate).
1566 To allow both 11g and 11b-only stations to associate, use
1569 When operating as an access point in 802.11n mode allow only
1570 HT-capable stations to associate (legacy stations are not
1571 permitted to associate).
1572 To allow both HT and legacy stations to associate, use
1574 .It Cm regdomain Ar sku
1575 Set the regulatory domain to use in calculating the regulatory constraints
1577 In particular the set of available channels, how the wireless device
1578 will operation on the channels, and the maximum transmit power that
1579 can be used on a channel are defined by this setting.
1580 Regdomain codes (SKU's) are taken from /etc/regdomain.xml and can also
1581 be viewed with the ``list countries'' request.
1582 Note that not all devices support changing the regdomain from a default
1583 setting; typically stored in EEPROM.
1591 Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n
1593 Note that RIFS must be supported by both the station and access point
1597 .It Cm roam:rate Ar rate
1598 Set the threshold for controlling roaming when operating in a BSS.
1601 parameter specifies the transmit rate in megabits
1602 at which roaming should be considered.
1603 If the current transmit rate drops below this setting and background scanning
1604 is enabled, then the system will check if a more desirable access point is
1605 available and switch over to it.
1606 The current scan cache contents are used if they are considered
1607 valid according to the
1609 parameter; otherwise a background scan operation is triggered before
1610 any selection occurs.
1611 Each channel type has a separate rate threshold; the default values are:
1612 12 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng).
1613 .It Cm roam:rssi Ar rssi
1614 Set the threshold for controlling roaming when operating in a BSS.
1617 parameter specifies the receive signal strength in dBm units
1618 at which roaming should be considered.
1619 If the current rssi drops below this setting and background scanning
1620 is enabled, then the system will check if a more desirable access point is
1621 available and switch over to it.
1622 The current scan cache contents are used if they are considered
1623 valid according to the
1625 parameter; otherwise a background scan operation is triggered before
1626 any selection occurs.
1627 Each channel type has a separate rssi threshold; the default values are
1629 .It Cm roaming Ar mode
1630 When operating as a station, control how the system will
1631 behave when communication with the current access point
1635 argument may be one of
1637 (leave it to the hardware device to decide),
1639 (handle either in the device or the operating system\[em]as appropriate),
1641 (do nothing until explicitly instructed).
1642 By default, the device is left to handle this if it is
1643 capable; otherwise, the operating system will automatically
1644 attempt to reestablish communication.
1645 Manual mode is used by applications such as
1646 .Xr wpa_supplicant 8
1647 that want to control the selection of an access point.
1648 .It Cm rtsthreshold Ar length
1649 Set the threshold for which
1650 transmitted frames are preceded by transmission of an
1656 is the frame size in bytes and must be in the range 1 to 2346.
1664 disables transmission of RTS frames.
1665 Not all adapters support setting the RTS threshold.
1667 Initiate a scan of neighboring stations, wait for it to complete, and
1668 display all stations found.
1669 Only the super-user can initiate a scan.
1672 for information on the display.
1673 By default a background scan is done; otherwise a foreground
1674 scan is done and the station may roam to a different access point.
1677 request can be used to show recent scan results without
1678 initiating a new scan.
1679 .It Cm scanvalid Ar threshold
1680 Set the maximum time the scan cache contents are considered valid;
1681 i.e. will be used without first triggering a scan operation to
1685 parameter is specified in seconds and defaults to 60 seconds.
1686 The minimum setting for
1689 One should take care setting this threshold; if it is set too low
1690 then attempts to roam to another access point may trigger unnecessary
1691 background scan operations.
1693 Enable use of Short Guard Interval when operating in 802.11n
1695 NB: this currently enables Short GI on both HT40 and HT20 channels.
1696 To disable Short GI use
1699 Enable use of Static Spatial Multiplexing Power Save (SMPS)
1700 when operating in 802.11n.
1701 A station operating with Static SMPS maintains only a single
1702 receive chain active (this can significantly reduce power consumption).
1706 Enable use of Dynamic Spatial Multiplexing Power Save (SMPS)
1707 when operating in 802.11n.
1708 A station operating with Dynamic SMPS maintains only a single
1709 receive chain active but switches to multiple receive chains when it
1710 receives an RTS frame (this can significantly reduce power consumption).
1711 Note that stations cannot distinguish between RTS/CTS intended to
1712 enable multiple receive chains and those used for other purposes.
1716 Set the desired Service Set Identifier (aka network name).
1717 The SSID is a string up to 32 characters
1718 in length and may be specified as either a normal string or in
1719 hexadecimal when preceded by
1721 Additionally, the SSID may be cleared by setting it to
1723 .It Cm tdmaslot Ar slot
1724 When operating with TDMA, use the specified
1729 is a number between 0 and the maximum number of slots in the BSS.
1730 Note that a station configured as slot 0 is a master and
1731 will broadcast beacon frames advertising the BSS;
1732 stations configured to use other slots will always
1733 scan to locate a master before they ever transmit.
1737 .It Cm tdmaslotcnt Ar cnt
1738 When operating with TDMA, setup a BSS with
1741 The slot count may be at most 8.
1742 The current implementation is only tested with two stations
1743 (i.e. point to point applications).
1744 This setting is only meaningful when a station is configured as slot 0;
1745 other stations adopt this setting from the BSS they join.
1749 .It Cm tdmaslotlen Ar len
1750 When operating with TDMA, setup a BSS such that each station has a slot
1753 The slot length must be at least 150 microseconds (1/8 TU)
1754 and no more than 65 milliseconds.
1755 Note that setting too small a slot length may result in poor channel
1756 bandwidth utilization due to factors such as timer granularity and
1758 This setting is only meaningful when a station is configured as slot 0;
1759 other stations adopt this setting from the BSS they join.
1762 is set to 10 milliseconds.
1763 .It Cm tdmabintval Ar intval
1764 When operating with TDMA, setup a BSS such that beacons are transmitted every
1766 superframes to synchronize the TDMA slot timing.
1767 A superframe is defined as the number of slots times the slot length; e.g.
1768 a BSS with two slots of 10 milliseconds has a 20 millisecond superframe.
1769 The beacon interval may not be zero.
1772 causes the timers to be resynchronized more often; this can be help if
1773 significant timer drift is observed.
1778 When operating as an access point with WPA/802.11i allow legacy
1779 stations to associate using static key WEP and open authentication.
1780 To disallow legacy station use of WEP, use
1782 .It Cm txpower Ar power
1783 Set the power used to transmit frames.
1786 argument is specified in .5 dBm units.
1787 Out of range values are truncated.
1788 Typically only a few discreet power settings are available and
1789 the driver will use the setting closest to the specified value.
1790 Not all adapters support changing the transmit power.
1791 .It Cm ucastrate Ar rate
1792 Set a fixed rate for transmitting unicast frames.
1793 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
1794 This rate should be valid for the current operating conditions;
1795 if an invalid rate is specified drivers are free to chose an
1797 .It Cm wepmode Ar mode
1798 Set the desired WEP mode.
1799 Not all adapters support all modes.
1800 The set of valid modes is
1806 mode explicitly tells the adaptor to allow association with access
1807 points which allow both encrypted and unencrypted traffic.
1810 means that the access point must only allow encrypted connections.
1813 is generally another name for
1815 Modes are case insensitive.
1816 .It Cm weptxkey Ar index
1817 Set the WEP key to be used for transmission.
1818 This is the same as setting the default transmission key with
1820 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
1821 Set the selected WEP key.
1824 is not given, key 1 is set.
1825 A WEP key will be either 5 or 13
1826 characters (40 or 104 bits) depending on the local network and the
1827 capabilities of the adaptor.
1828 It may be specified either as a plain
1829 string or as a string of hexadecimal digits preceded by
1831 For maximum portability, hex keys are recommended;
1832 the mapping of text keys to WEP encryption is usually driver-specific.
1835 drivers do this mapping differently to
1837 A key may be cleared by setting it to
1839 If WEP is supported then there are at least four keys.
1840 Some adapters support more than four keys.
1841 If that is the case, then the first four keys
1842 (1-4) will be the standard temporary keys and any others will be adaptor
1843 specific keys such as permanent keys stored in NVRAM.
1845 Note that you must set a default transmit key with
1847 for the system to know which key to use in encrypting outbound traffic.
1849 Enable Wireless Multimedia Extensions (WME) support, if available,
1850 for the specified interface.
1851 WME is a subset of the IEEE 802.11e standard to support the
1852 efficient communication of realtime and multimedia data.
1853 To disable WME support, use
1855 Another name for this parameter is
1858 The following parameters are meaningful only when WME support is in use.
1859 Parameters are specified per-AC (Access Category) and
1860 split into those that are used by a station when acting
1861 as an access point and those for client stations in the BSS.
1862 The latter are received from the access point and may not be changed
1864 The following Access Categories are recognized:
1866 .Bl -tag -width ".Cm AC_BK" -compact
1870 best effort delivery,
1885 AC parameters are case-insensitive.
1886 Traffic classification is done in the operating system using the
1887 vlan priority associated with data frames or the
1888 ToS (Type of Service) indication in IP-encapsulated frames.
1889 If neither information is present, traffic is assigned to the
1890 Best Effort (BE) category.
1891 .Bl -tag -width indent
1893 Set the ACK policy for QoS transmissions by the local station;
1894 this controls whether or not data frames transmitted by a station
1895 require an ACK response from the receiving station.
1896 To disable waiting for an ACK use
1898 This parameter is applied only to the local station.
1900 Enable the Admission Control Mandatory (ACM) mechanism
1901 for transmissions by the local station.
1902 To disable the ACM use
1904 On stations in a BSS this parameter is read-only and indicates
1905 the setting received from the access point.
1906 NB: ACM is not supported right now.
1907 .It Cm aifs Ar ac Ar count
1908 Set the Arbitration Inter Frame Spacing (AIFS)
1909 channel access parameter to use for transmissions
1910 by the local station.
1911 On stations in a BSS this parameter is read-only and indicates
1912 the setting received from the access point.
1913 .It Cm cwmin Ar ac Ar count
1914 Set the CWmin channel access parameter to use for transmissions
1915 by the local station.
1916 On stations in a BSS this parameter is read-only and indicates
1917 the setting received from the access point.
1918 .It Cm cwmax Ar ac Ar count
1919 Set the CWmax channel access parameter to use for transmissions
1920 by the local station.
1921 On stations in a BSS this parameter is read-only and indicates
1922 the setting received from the access point.
1923 .It Cm txoplimit Ar ac Ar limit
1924 Set the Transmission Opportunity Limit channel access parameter
1925 to use for transmissions by the local station.
1926 This parameter defines an interval of time when a WME station
1927 has the right to initiate transmissions onto the wireless medium.
1928 On stations in a BSS this parameter is read-only and indicates
1929 the setting received from the access point.
1930 .It Cm bss:aifs Ar ac Ar count
1931 Set the AIFS channel access parameter to send to stations in a BSS.
1932 This parameter is meaningful only when operating in ap mode.
1933 .It Cm bss:cwmin Ar ac Ar count
1934 Set the CWmin channel access parameter to send to stations in a BSS.
1935 This parameter is meaningful only when operating in ap mode.
1936 .It Cm bss:cwmax Ar ac Ar count
1937 Set the CWmax channel access parameter to send to stations in a BSS.
1938 This parameter is meaningful only when operating in ap mode.
1939 .It Cm bss:txoplimit Ar ac Ar limit
1940 Set the TxOpLimit channel access parameter to send to stations in a BSS.
1941 This parameter is meaningful only when operating in ap mode.
1944 Enable Wireless Privacy Subscriber support.
1945 Note that WPS support requires a WPS-capable supplicant.
1946 To disable this function use
1950 The following parameters support an optional access control list
1951 feature available with some adapters when operating in ap mode; see
1953 This facility allows an access point to accept/deny association
1954 requests based on the MAC address of the station.
1955 Note that this feature does not significantly enhance security
1956 as MAC address spoofing is easy to do.
1957 .Bl -tag -width indent
1958 .It Cm mac:add Ar address
1959 Add the specified MAC address to the database.
1960 Depending on the policy setting association requests from the
1961 specified station will be allowed or denied.
1963 Set the ACL policy to permit association only by
1964 stations registered in the database.
1965 .It Cm mac:del Ar address
1966 Delete the specified MAC address from the database.
1968 Set the ACL policy to deny association only by
1969 stations registered in the database.
1970 .It Cm mac:kick Ar address
1971 Force the specified station to be deauthenticated.
1972 This typically is done to block a station after updating the
1975 Set the ACL policy to allow all stations to associate.
1977 Delete all entries in the database.
1979 Set the ACL policy to permit association only by
1980 stations approved by a RADIUS server.
1981 Note that this feature requires the
1983 program be configured to do the right thing
1984 as it handles the RADIUS processing
1985 (and marks stations as authorized).
1988 The following parameters are related to a wireless interface operating in mesh
1990 .Bl -tag -width indent
1991 .It Cm meshid Ar meshid
1992 Set the desired Mesh Identifier.
1993 The Mesh ID is a string up to 32 characters in length.
1994 A mesh interface must have a Mesh Identifier specified
1995 to reach an operational state.
1996 .It Cm meshttl Ar ttl
1997 Set the desired ``time to live'' for mesh forwarded packets;
1998 this is the number of hops a packet may be forwarded before
2000 The default setting for
2004 Enable or disable peering with neighbor mesh stations.
2005 Stations must peer before any data packets can be exchanged.
2010 Enable or disable forwarding packets by a mesh interface.
2015 This attribute specifies whether or not the mesh STA activates mesh gate
2020 .It Cm meshmetric Ar protocol
2023 as the link metric protocol used on a mesh network.
2024 The default protocol is called
2026 The mesh interface will restart after changing this setting.
2027 .It Cm meshpath Ar protocol
2030 as the path selection protocol used on a mesh network.
2031 The only available protocol at the moment is called
2033 (Hybrid Wireless Mesh Protocol).
2034 The mesh interface will restart after changing this setting.
2035 .It Cm hwmprootmode Ar mode
2036 Stations on a mesh network can operate as ``root nodes.''
2037 Root nodes try to find paths to all mesh nodes and advertise themselves
2039 When there is a root mesh node on a network, other mesh nodes can setup
2040 paths between themselves faster because they can use the root node
2041 to find the destination.
2042 This path may not be the best, but on-demand
2043 routing will eventually find the best path.
2044 The following modes are recognized:
2046 .Bl -tag -width ".Cm PROACTIVE" -compact
2050 Send broadcast path requests every two seconds.
2051 Nodes on the mesh without a path to this root mesh station with try to
2052 discover a path to us.
2054 Send broadcast path requests every two seconds and every node must reply with
2055 with a path reply even if it already has a path to this root mesh station.
2057 Send broadcast root announcement (RANN) frames.
2058 Nodes on the mesh without a path to this root mesh station with try to
2059 discover a path to us.
2065 .It Cm hwmpmaxhops Ar cnt
2066 Set the maximum number of hops allowed in an HMWP path to
2068 The default setting for
2073 The following parameters are for compatibility with other systems:
2074 .Bl -tag -width indent
2076 Another name for the
2082 .It Cm stationname Ar name
2083 Set the name of this station.
2084 The station name is not part of the IEEE 802.11
2085 protocol though some interfaces support it.
2087 seems to be meaningful to identical or virtually identical equipment.
2088 Setting the station name is identical in syntax to setting the SSID.
2095 Another way of saying
2101 Another way of saying
2107 Another way of saying:
2108 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
2114 .Ar n : k1 , k2 , k3 , k4
2117 Another way of saying
2118 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
2123 Another way of saying
2130 The following parameters are specific to bridge interfaces:
2131 .Bl -tag -width indent
2132 .It Cm addm Ar interface
2133 Add the interface named by
2135 as a member of the bridge.
2136 The interface is put into promiscuous mode
2137 so that it can receive every packet sent on the network.
2138 .It Cm deletem Ar interface
2139 Remove the interface named by
2142 Promiscuous mode is disabled on the interface when
2143 it is removed from the bridge.
2144 .It Cm maxaddr Ar size
2145 Set the size of the bridge address cache to
2147 The default is 2000 entries.
2148 .It Cm timeout Ar seconds
2149 Set the timeout of address cache entries to
2154 is zero, then address cache entries will not be expired.
2155 The default is 1200 seconds.
2157 Display the addresses that have been learned by the bridge.
2158 .It Cm static Ar interface-name Ar address
2159 Add a static entry into the address cache pointing to
2160 .Ar interface-name .
2161 Static entries are never aged out of the cache or re-placed, even if the
2162 address is seen on a different interface.
2163 .It Cm deladdr Ar address
2166 from the address cache.
2168 Delete all dynamically-learned addresses from the address cache.
2170 Delete all addresses, including static addresses, from the address cache.
2171 .It Cm discover Ar interface
2172 Mark an interface as a
2175 When the bridge has no address cache entry
2176 (either dynamic or static)
2177 for the destination address of a packet,
2178 the bridge will forward the packet to all
2179 member interfaces marked as
2181 This is the default for all interfaces added to a bridge.
2182 .It Cm -discover Ar interface
2185 attribute on a member interface.
2186 For packets without the
2188 attribute, the only packets forwarded on the interface are broadcast
2189 or multicast packets and packets for which the destination address
2190 is known to be on the interface's segment.
2191 .It Cm learn Ar interface
2192 Mark an interface as a
2195 When a packet arrives on such an interface, the source
2196 address of the packet is entered into the address cache as being a
2197 destination address on the interface's segment.
2198 This is the default for all interfaces added to a bridge.
2199 .It Cm -learn Ar interface
2202 attribute on a member interface.
2203 .It Cm sticky Ar interface
2204 Mark an interface as a
2207 Dynamically learned address entries are treated at static once entered into
2209 Sticky entries are never aged out of the cache or replaced, even if the
2210 address is seen on a different interface.
2211 .It Cm -sticky Ar interface
2214 attribute on a member interface.
2215 .It Cm private Ar interface
2216 Mark an interface as a
2219 A private interface does not forward any traffic to any other port that is also
2220 a private interface.
2221 .It Cm -private Ar interface
2224 attribute on a member interface.
2225 .It Cm span Ar interface
2226 Add the interface named by
2228 as a span port on the bridge.
2229 Span ports transmit a copy of every frame received by the bridge.
2230 This is most useful for snooping a bridged network passively on
2231 another host connected to one of the span ports of the bridge.
2232 .It Cm -span Ar interface
2233 Delete the interface named by
2235 from the list of span ports of the bridge.
2236 .It Cm stp Ar interface
2237 Enable Spanning Tree protocol on
2241 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
2242 Spanning Tree is used to detect and remove loops in a network topology.
2243 .It Cm -stp Ar interface
2244 Disable Spanning Tree protocol on
2246 This is the default for all interfaces added to a bridge.
2247 .It Cm edge Ar interface
2251 An edge port connects directly to end stations cannot create bridging
2252 loops in the network, this allows it to transition straight to forwarding.
2253 .It Cm -edge Ar interface
2254 Disable edge status on
2256 .It Cm autoedge Ar interface
2259 to automatically detect edge status.
2260 This is the default for all interfaces added to a bridge.
2261 .It Cm -autoedge Ar interface
2262 Disable automatic edge status on
2264 .It Cm ptp Ar interface
2267 as a point to point link.
2268 This is required for straight transitions to forwarding and
2269 should be enabled on a direct link to another RSTP capable switch.
2270 .It Cm -ptp Ar interface
2271 Disable point to point link status on
2273 This should be disabled for a half duplex link and for an interface
2274 connected to a shared network segment,
2275 like a hub or a wireless network.
2276 .It Cm autoptp Ar interface
2277 Automatically detect the point to point status on
2279 by checking the full duplex link status.
2280 This is the default for interfaces added to the bridge.
2281 .It Cm -autoptp Ar interface
2282 Disable automatic point to point link detection on
2284 .It Cm maxage Ar seconds
2285 Set the time that a Spanning Tree protocol configuration is valid.
2286 The default is 20 seconds.
2287 The minimum is 6 seconds and the maximum is 40 seconds.
2288 .It Cm fwddelay Ar seconds
2289 Set the time that must pass before an interface begins forwarding
2290 packets when Spanning Tree is enabled.
2291 The default is 15 seconds.
2292 The minimum is 4 seconds and the maximum is 30 seconds.
2293 .It Cm hellotime Ar seconds
2294 Set the time between broadcasting of Spanning Tree protocol
2295 configuration messages.
2296 The hello time may only be changed when operating in legacy stp mode.
2297 The default is 2 seconds.
2298 The minimum is 1 second and the maximum is 2 seconds.
2299 .It Cm priority Ar value
2300 Set the bridge priority for Spanning Tree.
2301 The default is 32768.
2302 The minimum is 0 and the maximum is 61440.
2303 .It Cm proto Ar value
2304 Set the Spanning Tree protocol.
2305 The default is rstp.
2306 The available options are stp and rstp.
2307 .It Cm holdcnt Ar value
2308 Set the transmit hold count for Spanning Tree.
2309 This is the number of packets transmitted before being rate limited.
2311 The minimum is 1 and the maximum is 10.
2312 .It Cm ifpriority Ar interface Ar value
2313 Set the Spanning Tree priority of
2318 The minimum is 0 and the maximum is 240.
2319 .It Cm ifpathcost Ar interface Ar value
2320 Set the Spanning Tree path cost of
2324 The default is calculated from the link speed.
2325 To change a previously selected path cost back to automatic, set the
2327 The minimum is 1 and the maximum is 200000000.
2328 .It Cm ifmaxaddr Ar interface Ar size
2329 Set the maximum number of hosts allowed from an interface, packets with unknown
2330 source addresses are dropped until an existing host cache entry expires or is
2332 Set to 0 to disable.
2335 The following parameters are specific to lagg interfaces:
2336 .Bl -tag -width indent
2337 .It Cm laggport Ar interface
2338 Add the interface named by
2340 as a port of the aggregation interface.
2341 .It Cm -laggport Ar interface
2342 Remove the interface named by
2344 from the aggregation interface.
2345 .It Cm laggproto Ar proto
2346 Set the aggregation protocol.
2347 The default is failover.
2348 The available options are failover, fec, lacp, loadbalance, roundrobin and
2350 .It Cm lagghash Ar option Ns Oo , Ns Ar option Oc
2351 Set the packet layers to hash for aggregation protocols which load balance.
2354 The options can be combined using commas.
2356 .Bl -tag -width ".Cm l2" -compact
2358 src/dst mac address and optional vlan number.
2360 src/dst address for IPv4 or IPv6.
2362 src/dst port for TCP/UDP/SCTP.
2367 The following parameters are specific to IP tunnel interfaces,
2369 .Bl -tag -width indent
2370 .It Cm tunnel Ar src_addr dest_addr
2371 Configure the physical source and destination address for IP tunnel
2377 are interpreted as the outer source/destination for the encapsulating
2380 Unconfigure the physical source and destination address for IP tunnel
2381 interfaces previously configured with
2384 Another name for the
2387 .It Cm accept_rev_ethip_ver
2388 Set a flag to accept both correct EtherIP packets and ones
2389 with reversed version field. Enabled by default.
2390 This is for backward compatibility with
2392 6.2, 6.3, 7.0, and 7.1.
2393 .It Cm -accept_rev_ethip_ver
2395 .Cm accept_rev_ethip_ver .
2396 .It Cm send_rev_ethip_ver
2397 Set a flag to send EtherIP packets with reversed version
2398 field intentionally. Disabled by default.
2399 This is for backward compatibility with
2401 6.2, 6.3, 7.0, and 7.1.
2402 .It Cm -send_rev_ethip_ver
2404 .Cm send_rev_ethip_ver .
2407 The following parameters are specific to GRE tunnel interfaces,
2409 .Bl -tag -width indent
2410 .It Cm grekey Ar key
2411 Configure the GRE key to be used for outgoing packets.
2413 .Xr gre 4 will always accept GRE packets with invalid or absent keys.
2414 This command will result in a four byte MTU reduction on the interface.
2417 The following parameters are specific to
2420 .Bl -tag -width indent
2421 .It Cm syncdev Ar iface
2422 Use the specified interface
2423 to send and receive pfsync state synchronisation messages.
2425 Stop sending pfsync state synchronisation messages over the network.
2426 .It Cm syncpeer Ar peer_address
2427 Make the pfsync link point-to-point rather than using
2428 multicast to broadcast the state synchronisation messages.
2429 The peer_address is the IP address of the other host taking part in
2432 Broadcast the packets using multicast.
2434 Set the maximum number of updates for a single state which
2435 can be collapsed into one.
2436 This is an 8-bit number; the default value is 128.
2438 Defer transmission of the first packet in a state until a peer has
2439 acknowledged that the associated state has been inserted.
2441 Do not defer the first packet in a state.
2442 This is the default.
2445 The following parameters are specific to
2448 .Bl -tag -width indent
2449 .It Cm vlan Ar vlan_tag
2450 Set the VLAN tag value to
2452 This value is a 12-bit VLAN Identifier (VID) which is used to create an 802.1Q
2453 VLAN header for packets sent from the
2460 must both be set at the same time.
2461 .It Cm vlandev Ar iface
2462 Associate the physical interface
2467 Packets transmitted through the
2470 diverted to the specified physical interface
2472 with 802.1Q VLAN encapsulation.
2473 Packets with 802.1Q encapsulation received
2474 by the parent interface with the correct VLAN Identifier will be diverted to
2480 interface is assigned a
2481 copy of the parent interface's flags and the parent's ethernet address.
2486 must both be set at the same time.
2489 interface already has
2490 a physical interface associated with it, this command will fail.
2492 change the association to another physical interface, the existing
2493 association must be cleared first.
2495 Note: if the hardware tagging capability
2496 is set on the parent interface, the
2499 interface's behavior changes:
2502 interface recognizes that the
2503 parent interface supports insertion and extraction of VLAN tags on its
2504 own (usually in firmware) and that it should pass packets to and from
2505 the parent unaltered.
2506 .It Fl vlandev Op Ar iface
2509 pseudo device, disassociate the parent interface from it.
2510 This breaks the link between the
2512 interface and its parent,
2513 clears its VLAN Identifier, flags and its link address and shuts the interface
2517 argument is useless and hence deprecated.
2520 The following parameters are used to configure
2522 protocol on an interface:
2523 .Bl -tag -width indent
2525 Set the virtual host ID.
2526 This is a required setting to initiate
2528 If the virtual host ID doesn't exist yet, it is created and attached to the
2529 interface, otherwise configuration of an existing vhid is adjusted.
2532 keyword is supplied along with an
2536 address, then this address is configured to be run under control of the
2538 Whenever a last address that refers to a particular vhid is removed from an
2539 interface, the vhid is automatically removed from interface and destroyed.
2540 Any other configuration parameters for the
2542 protocol should be supplied along with the
2545 Acceptable values for vhid are 1 to 255.
2546 .It Cm advbase Ar seconds
2547 Specifies the base of the advertisement interval in seconds.
2548 The acceptable values are 1 to 255.
2549 The default value is 1.
2550 .It Cm advskew Ar interval
2551 Specifies the skew to add to the base advertisement interval to
2552 make one host advertise slower than another host.
2553 It is specified in 1/256 of seconds.
2554 The acceptable values are 1 to 254.
2555 The default value is 0.
2556 .It Cm pass Ar phrase
2557 Set the authentication key to
2559 .It Cm state Ar MASTER|BACKUP
2560 Forcibly change state of a given vhid.
2565 utility displays the current configuration for a network interface
2566 when no optional parameters are supplied.
2567 If a protocol family is specified,
2569 will report only the details specific to that protocol family.
2573 flag is passed before an interface name,
2575 will display the capability list and all
2576 of the supported media for the specified interface.
2579 flag is supplied, address lifetime is displayed for IPv6 addresses,
2580 as time offset string.
2584 flag may be used instead of an interface name.
2587 to display information about all interfaces in the system.
2590 flag limits this to interfaces that are down, and
2592 limits this to interfaces that are up.
2593 When no arguments are given,
2599 flag may be used to list all available interfaces on the system, with
2600 no other additional information.
2601 Use of this flag is mutually exclusive
2602 with all other flags and commands, except for
2604 (only list interfaces that are down)
2607 (only list interfaces that are up).
2611 flag may be used to get more verbose status for an interface.
2615 flag may be used to list all of the interface cloners available on
2616 the system, with no additional information.
2617 Use of this flag is mutually exclusive with all other flags and commands.
2621 flag causes keying information for the interface, if available, to be
2623 For example, the values of 802.11 WEP keys and
2625 passphrases will be printed, if accessible to the current user.
2626 This information is not printed by default, as it may be considered
2629 If the network interface driver is not present in the kernel then
2631 will attempt to load it.
2634 flag disables this behavior.
2636 Only the super-user may modify the configuration of a network interface.
2638 The media selection system is relatively new and only some drivers support
2639 it (or have need for it).
2641 Assign the IPv4 address
2643 with a network mask of
2647 .Dl # ifconfig fxp0 inet 192.0.2.10 netmask 255.255.255.0
2649 Add the IPv4 address
2651 with the CIDR network prefix
2657 as a synonym for the canonical form of the option
2659 .Dl # ifconfig ed0 inet 192.0.2.45/28 add
2661 Remove the IPv4 address
2665 .Dl # ifconfig ed0 inet 192.0.2.45 -alias
2667 Enable IPv6 functionality of the interface:
2668 .Dl # ifconfig em0 inet6 -ifdisabled
2670 Add the IPv6 address
2671 .Li 2001:DB8:DBDB::123/48
2674 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias
2675 Note that lower case hexadecimal IPv6 addresses are acceptable.
2677 Remove the IPv6 address added in the above example,
2680 character as shorthand for the network prefix,
2683 as a synonym for the canonical form of the option
2685 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 delete
2687 Configure a single CARP redundant address on igb0, and then switch it
2689 .Dl # ifconfig igb0 vhid 1 10.0.0.1/24 pass foobar
2690 .Dl # ifconfig igb0 vhid 1 state master
2692 Configure the interface
2694 to use 100baseTX, full duplex Ethernet media options:
2695 .Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex
2697 Label the em0 interface as an uplink:
2698 .Dl # ifconfig em0 description \&"Uplink to Gigabit Switch 2\&"
2700 Create the software network interface
2702 .Dl # ifconfig gif1 create
2704 Destroy the software network interface
2706 .Dl # ifconfig gif1 destroy
2708 Display available wireless networks using
2710 .Dl # ifconfig wlan0 list scan
2712 Messages indicating the specified interface does not exist, the
2713 requested address is unknown, or the user is not privileged and
2714 tried to alter an interface's configuration.
2734 Basic IPv6 node operation requires a link-local address on each
2735 interface configured for IPv6.
2736 Normally, such an address is automatically configured by the
2737 kernel on each interface added to the system or enabled; this behavior may
2738 be disabled by setting per-interface flag
2739 .Cm -auto_linklocal .
2740 The default value of this flag is 1 and can be disabled by using the sysctl
2742 .Va net.inet6.ip6.auto_linklocal .
2744 Do not configure IPv6 addresses with no link-local address by using
2746 It can result in unexpected behaviors of the kernel.
projects / FreeBSD / FreeBSD.git / blob