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 Atheros Dynamic Turbo mode when communicating with
1125 another Dynamic Turbo-capable station.
1126 Dynamic Turbo mode is an Atheros-specific mechanism by which
1127 stations switch between normal 802.11 operation and a ``boosted''
1128 mode in which a 40MHz wide channel is used for communication.
1129 Stations using Dynamic Turbo mode operate boosted only when the
1130 channel is free of non-dturbo stations; when a non-dturbo station
1131 is identified on the channel all stations will automatically drop
1132 back to normal operation.
1133 By default, Dynamic Turbo mode is not enabled, even if the device is capable.
1134 Note that turbo mode (dynamic or static) is only allowed on some
1135 channels depending on the regulatory constraints; use the
1137 command to identify the channels where turbo mode may be used.
1138 To disable Dynamic Turbo mode use
1141 Enable Dynamic WDS (DWDS) support.
1142 DWDS is a facility by which 4-address traffic can be carried between
1143 stations operating in infrastructure mode.
1144 A station first associates to an access point and authenticates using
1145 normal procedures (e.g. WPA).
1146 Then 4-address frames are passed to carry traffic for stations
1147 operating on either side of the wireless link.
1148 DWDS extends the normal WDS mechanism by leveraging existing security
1149 protocols and eliminating static binding.
1151 When DWDS is enabled on an access point 4-address frames received from
1152 an authorized station will generate a ``DWDS discovery'' event to user
1154 This event should be used to create a WDS interface that is bound
1155 to the remote station (and usually plumbed into a bridge).
1156 Once the WDS interface is up and running 4-address traffic then logically
1157 flows through that interface.
1159 When DWDS is enabled on a station, traffic with a destination address
1160 different from the peer station are encapsulated in a 4-address frame
1161 and transmitted to the peer.
1162 All 4-address traffic uses the security information of the stations
1163 (e.g. cryptographic keys).
1164 A station is associated using 802.11n facilities may transport
1165 4-address traffic using these same mechanisms; this depends on available
1166 resources and capabilities of the device.
1167 The DWDS implementation guards against layer 2 routing loops of
1170 Enable the use of Atheros Fast Frames when communicating with
1171 another Fast Frames-capable station.
1172 Fast Frames are an encapsulation technique by which two 802.3
1173 frames are transmitted in a single 802.11 frame.
1174 This can noticeably improve throughput but requires that the
1175 receiving station understand how to decapsulate the frame.
1176 Fast frame use is negotiated using the Atheros 802.11 vendor-specific
1177 protocol extension so enabling use is safe when communicating with
1178 non-Atheros devices.
1179 By default, use of fast frames is enabled if the device is capable.
1180 To explicitly disable fast frames, use
1182 .It Cm fragthreshold Ar length
1183 Set the threshold for which transmitted frames are broken into fragments.
1186 argument is the frame size in bytes and must be in the range 256 to 2346.
1194 disables transmit fragmentation.
1195 Not all adapters honor the fragmentation threshold.
1197 When operating as an access point, do not broadcast the SSID
1198 in beacon frames or respond to probe request frames unless
1199 they are directed to the ap (i.e., they include the ap's SSID).
1200 By default, the SSID is included in beacon frames and
1201 undirected probe request frames are answered.
1202 To re-enable the broadcast of the SSID etc., use
1205 Enable use of High Throughput (HT) when using 802.11n (default).
1206 The 802.11n specification includes mechanisms for operation
1207 on 20MHz and 40MHz wide channels using different signalling mechanisms
1208 than specified in 802.11b, 802.11g, and 802.11a.
1209 Stations negotiate use of these facilities, termed HT20 and HT40,
1210 when they associate.
1211 To disable all use of 802.11n use
1213 To disable use of HT20 (e.g. to force only HT40 use) use
1215 To disable use of HT40 use
1218 HT configuration is used to ``auto promote'' operation
1219 when several choices are available.
1220 For example, if a station associates to an 11n-capable access point
1221 it controls whether the station uses legacy operation, HT20, or HT40.
1222 When an 11n-capable device is setup as an access point and
1223 Auto Channel Selection is used to locate a channel to operate on,
1224 HT configuration controls whether legacy, HT20, or HT40 operation is setup
1225 on the selected channel.
1226 If a fixed channel is specified for a station then HT configuration can
1227 be given as part of the channel specification; e.g. 6:ht/20 to setup
1228 HT20 operation on channel 6.
1230 Enable use of compatibility support for pre-802.11n devices (default).
1231 The 802.11n protocol specification went through several incompatible iterations.
1232 Some vendors implemented 11n support to older specifications that
1233 will not interoperate with a purely 11n-compliant station.
1234 In particular the information elements included in management frames
1235 for old devices are different.
1236 When compatibility support is enabled both standard and compatible data
1238 Stations that associate using the compatibility mechanisms are flagged
1240 To disable compatibility support use
1242 .It Cm htprotmode Ar technique
1243 For interfaces operating in 802.11n, use the specified
1245 for protecting HT frames in a mixed legacy/HT network.
1246 The set of valid techniques is
1251 Technique names are case insensitive.
1253 Enable inactivity processing for stations associated to an
1254 access point (default).
1255 When operating as an access point the 802.11 layer monitors
1256 the activity of each associated station.
1257 When a station is inactive for 5 minutes it will send several
1258 ``probe frames'' to see if the station is still present.
1259 If no response is received then the station is deauthenticated.
1260 Applications that prefer to handle this work can disable this
1264 Set the location to use in calculating regulatory constraints.
1265 The location is also advertised in beacon and probe response frames
1266 when 802.11d is enabled with
1275 Display the list of channels available for use taking into account
1276 any restrictions set with the
1279 See the description of
1281 for more information.
1283 Display the adaptor's capabilities, including the operating
1286 Display the list of channels available for use.
1287 Channels are shown with their IEEE channel number, equivalent
1288 frequency, and usage modes.
1289 Channels identified as
1294 Channels identified as
1296 may be used only for Atheros' Static Turbo mode
1298 . Cm mediaopt turbo ) .
1299 Channels marked with a
1301 have a regulatory constraint that they be passively scanned.
1302 This means a station is not permitted to transmit on the channel until
1303 it identifies the channel is being used for 802.11 communication;
1304 typically by hearing a beacon frame from an access point operating
1307 is another way of requesting this information.
1308 By default a compacted list of channels is displayed; if the
1310 option is specified then all channels are shown.
1311 .It Cm list countries
1312 Display the set of country codes and regulatory domains that can be
1313 used in regulatory configuration.
1315 Display the current MAC Access Control List state.
1316 Each address is prefixed with a character that indicates the
1317 current policy applied to it:
1319 indicates the address is allowed access,
1321 indicates the address is denied access,
1323 indicates the address is present but the current policy open
1324 (so the ACL is not consulted).
1326 Displays the mesh routing table, used for forwarding packets on a mesh
1328 .It Cm list regdomain
1329 Display the current regulatory settings including the available channels
1330 and transmit power caps.
1332 Display the parameters that govern roaming operation.
1334 Display the parameters that govern transmit operation.
1336 Display the transmit power caps for each channel.
1338 Display the access points and/or ad-hoc neighbors
1339 located in the vicinity.
1340 This information may be updated automatically by the adapter
1343 request or through background scanning.
1344 Depending on the capabilities of the stations the following
1345 flags can be included in the output:
1349 Indicates that the station is permitted to send/receive data frames.
1351 Extended Rate Phy (ERP).
1352 Indicates that the station is operating in an 802.11g network
1353 using extended transmit rates.
1355 High Throughput (HT).
1356 Indicates that the station is using HT transmit rates.
1357 If a `+' follows immediately after then the station associated
1358 using deprecated mechanisms supported only when
1363 Indicates that the station is operating in power save mode.
1365 Quality of Service (QoS).
1366 Indicates that the station is using QoS encapsulation for
1368 QoS encapsulation is enabled only when WME mode is enabled.
1371 Indicates that the station is doing short preamble to optionally
1372 improve throughput performance with 802.11g and 802.11b.
1374 Transitional Security Network (TSN).
1375 Indicates that the station associated using TSN; see also
1379 Wi-Fi Protected Setup (WPS).
1380 Indicates that the station associated using WPS.
1383 By default interesting information elements captured from the neighboring
1384 stations are displayed at the end of each row.
1385 Possible elements include:
1387 (station supports WME),
1389 (station supports WPA),
1391 (station supports WPS),
1393 (station supports 802.11i/RSN),
1395 (station supports 802.11n/HT communication),
1397 (station supports Atheros protocol extensions),
1399 (station supports unknown vendor-specific extensions).
1402 flag is used all the information elements and their
1403 contents will be shown.
1406 flag also enables display of long SSIDs.
1409 command is another way of requesting this information.
1411 When operating as an access point display the stations that are
1412 currently associated.
1413 When operating in ad-hoc mode display stations identified as
1414 neighbors in the IBSS.
1415 When operating in mesh mode display stations identified as
1416 neighbors in the MBSS.
1417 When operating in station mode display the access point.
1418 Capabilities advertised by the stations are described under
1422 Depending on the capabilities of the stations the following
1423 flags can be included in the output:
1427 Indicates that the station is permitted to send/receive data frames.
1429 Extended Rate Phy (ERP).
1430 Indicates that the station is operating in an 802.11g network
1431 using extended transmit rates.
1433 High Throughput (HT).
1434 Indicates that the station is using HT transmit rates.
1435 If a `+' follows immediately after then the station associated
1436 using deprecated mechanisms supported only when
1441 Indicates that the station is operating in power save mode.
1443 Quality of Service (QoS).
1444 Indicates that the station is using QoS encapsulation for
1446 QoS encapsulation is enabled only when WME mode is enabled.
1449 Indicates that the station is doing short preamble to optionally
1450 improve throughput performance with 802.11g and 802.11b.
1452 Transitional Security Network (TSN).
1453 Indicates that the station associated using TSN; see also
1457 Wi-Fi Protected Setup (WPS).
1458 Indicates that the station associated using WPS.
1461 By default information elements received from associated stations
1462 are displayed in a short form; the
1464 flag causes this information to be displayed symbolically.
1466 Display the current channel parameters to use when operating in WME mode.
1469 option is specified then both channel and BSS parameters are displayed
1470 for each AC (first channel, then BSS).
1471 When WME mode is enabled for an adaptor this information will be
1472 displayed with the regular status; this command is mostly useful
1473 for examining parameters when WME mode is disabled.
1474 See the description of the
1476 directive for information on the various parameters.
1477 .It Cm maxretry Ar count
1478 Set the maximum number of tries to use in sending unicast frames.
1479 The default setting is 6 but drivers may override this with a value
1481 .It Cm mcastrate Ar rate
1482 Set the rate for transmitting multicast/broadcast frames.
1483 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
1484 This rate should be valid for the current operating conditions;
1485 if an invalid rate is specified drivers are free to chose an
1487 .It Cm mgtrate Ar rate
1488 Set the rate for transmitting management and/or control frames.
1489 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
1491 Set the location to use in calculating regulatory constraints.
1492 The location is also advertised in beacon and probe response frames
1493 when 802.11d is enabled with
1502 Enable powersave operation.
1503 When operating as a client, the station will conserve power by
1504 periodically turning off the radio and listening for
1505 messages from the access point telling it there are packets waiting.
1506 The station must then retrieve the packets.
1507 Not all devices support power save operation as a client.
1508 The 802.11 specification requires that all access points support
1509 power save but some drivers do not.
1512 to disable powersave operation when operating as a client.
1513 .It Cm powersavesleep Ar sleep
1514 Set the desired max powersave sleep time in TU's (1024 usecs).
1515 By default the max powersave sleep time is 100 TU's.
1516 .It Cm protmode Ar technique
1517 For interfaces operating in 802.11g, use the specified
1519 for protecting OFDM frames in a mixed 11b/11g network.
1520 The set of valid techniques is
1526 Technique names are case insensitive.
1527 Not all devices support
1529 as a protection technique.
1531 When operating as an access point in 802.11g mode allow only
1532 11g-capable stations to associate (11b-only stations are not
1533 permitted to associate).
1534 To allow both 11g and 11b-only stations to associate, use
1537 When operating as an access point in 802.11n mode allow only
1538 HT-capable stations to associate (legacy stations are not
1539 permitted to associate).
1540 To allow both HT and legacy stations to associate, use
1542 .It Cm regdomain Ar sku
1543 Set the regulatory domain to use in calculating the regulatory constraints
1545 In particular the set of available channels, how the wireless device
1546 will operation on the channels, and the maximum transmit power that
1547 can be used on a channel are defined by this setting.
1548 Regdomain codes (SKU's) are taken from /etc/regdomain.xml and can also
1549 be viewed with the ``list countries'' request.
1550 Note that not all devices support changing the regdomain from a default
1551 setting; typically stored in EEPROM.
1559 Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n
1561 Note that RIFS must be supported by both the station and access point
1565 .It Cm roam:rate Ar rate
1566 Set the threshold for controlling roaming when operating in a BSS.
1569 parameter specifies the transmit rate in megabits
1570 at which roaming should be considered.
1571 If the current transmit rate drops below this setting and background scanning
1572 is enabled, then the system will check if a more desirable access point is
1573 available and switch over to it.
1574 The current scan cache contents are used if they are considered
1575 valid according to the
1577 parameter; otherwise a background scan operation is triggered before
1578 any selection occurs.
1579 Each channel type has a separate rate threshold; the default values are:
1580 12 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng).
1581 .It Cm roam:rssi Ar rssi
1582 Set the threshold for controlling roaming when operating in a BSS.
1585 parameter specifies the receive signal strength in dBm units
1586 at which roaming should be considered.
1587 If the current rssi drops below this setting and background scanning
1588 is enabled, then the system will check if a more desirable access point is
1589 available and switch over to it.
1590 The current scan cache contents are used if they are considered
1591 valid according to the
1593 parameter; otherwise a background scan operation is triggered before
1594 any selection occurs.
1595 Each channel type has a separate rssi threshold; the default values are
1597 .It Cm roaming Ar mode
1598 When operating as a station, control how the system will
1599 behave when communication with the current access point
1603 argument may be one of
1605 (leave it to the hardware device to decide),
1607 (handle either in the device or the operating system\[em]as appropriate),
1609 (do nothing until explicitly instructed).
1610 By default, the device is left to handle this if it is
1611 capable; otherwise, the operating system will automatically
1612 attempt to reestablish communication.
1613 Manual mode is used by applications such as
1614 .Xr wpa_supplicant 8
1615 that want to control the selection of an access point.
1616 .It Cm rtsthreshold Ar length
1617 Set the threshold for which
1618 transmitted frames are preceded by transmission of an
1624 is the frame size in bytes and must be in the range 1 to 2346.
1632 disables transmission of RTS frames.
1633 Not all adapters support setting the RTS threshold.
1635 Initiate a scan of neighboring stations, wait for it to complete, and
1636 display all stations found.
1637 Only the super-user can initiate a scan.
1640 for information on the display.
1641 By default a background scan is done; otherwise a foreground
1642 scan is done and the station may roam to a different access point.
1645 request can be used to show recent scan results without
1646 initiating a new scan.
1647 .It Cm scanvalid Ar threshold
1648 Set the maximum time the scan cache contents are considered valid;
1649 i.e. will be used without first triggering a scan operation to
1653 parameter is specified in seconds and defaults to 60 seconds.
1654 The minimum setting for
1657 One should take care setting this threshold; if it is set too low
1658 then attempts to roam to another access point may trigger unnecessary
1659 background scan operations.
1661 Enable use of Short Guard Interval when operating in 802.11n
1663 NB: this currently enables Short GI on both HT40 and HT20 channels.
1664 To disable Short GI use
1667 Enable use of Static Spatial Multiplexing Power Save (SMPS)
1668 when operating in 802.11n.
1669 A station operating with Static SMPS maintains only a single
1670 receive chain active (this can significantly reduce power consumption).
1674 Enable use of Dynamic Spatial Multiplexing Power Save (SMPS)
1675 when operating in 802.11n.
1676 A station operating with Dynamic SMPS maintains only a single
1677 receive chain active but switches to multiple receive chains when it
1678 receives an RTS frame (this can significantly reduce power consumption).
1679 Note that stations cannot distinguish between RTS/CTS intended to
1680 enable multiple receive chains and those used for other purposes.
1684 Set the desired Service Set Identifier (aka network name).
1685 The SSID is a string up to 32 characters
1686 in length and may be specified as either a normal string or in
1687 hexadecimal when preceded by
1689 Additionally, the SSID may be cleared by setting it to
1691 .It Cm tdmaslot Ar slot
1692 When operating with TDMA, use the specified
1697 is a number between 0 and the maximum number of slots in the BSS.
1698 Note that a station configured as slot 0 is a master and
1699 will broadcast beacon frames advertising the BSS;
1700 stations configured to use other slots will always
1701 scan to locate a master before they ever transmit.
1705 .It Cm tdmaslotcnt Ar cnt
1706 When operating with TDMA, setup a BSS with
1709 The slot count may be at most 8.
1710 The current implementation is only tested with two stations
1711 (i.e. point to point applications).
1712 This setting is only meaningful when a station is configured as slot 0;
1713 other stations adopt this setting from the BSS they join.
1717 .It Cm tdmaslotlen Ar len
1718 When operating with TDMA, setup a BSS such that each station has a slot
1721 The slot length must be at least 150 microseconds (1/8 TU)
1722 and no more than 65 milliseconds.
1723 Note that setting too small a slot length may result in poor channel
1724 bandwidth utilization due to factors such as timer granularity and
1726 This setting is only meaningful when a station is configured as slot 0;
1727 other stations adopt this setting from the BSS they join.
1730 is set to 10 milliseconds.
1731 .It Cm tdmabintval Ar intval
1732 When operating with TDMA, setup a BSS such that beacons are transmitted every
1734 superframes to synchronize the TDMA slot timing.
1735 A superframe is defined as the number of slots times the slot length; e.g.
1736 a BSS with two slots of 10 milliseconds has a 20 millisecond superframe.
1737 The beacon interval may not be zero.
1740 causes the timers to be resynchronized more often; this can be help if
1741 significant timer drift is observed.
1746 When operating as an access point with WPA/802.11i allow legacy
1747 stations to associate using static key WEP and open authentication.
1748 To disallow legacy station use of WEP, use
1750 .It Cm txpower Ar power
1751 Set the power used to transmit frames.
1754 argument is specified in .5 dBm units.
1755 Out of range values are truncated.
1756 Typically only a few discreet power settings are available and
1757 the driver will use the setting closest to the specified value.
1758 Not all adapters support changing the transmit power.
1759 .It Cm ucastrate Ar rate
1760 Set a fixed rate for transmitting unicast frames.
1761 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
1762 This rate should be valid for the current operating conditions;
1763 if an invalid rate is specified drivers are free to chose an
1765 .It Cm wepmode Ar mode
1766 Set the desired WEP mode.
1767 Not all adapters support all modes.
1768 The set of valid modes is
1774 mode explicitly tells the adaptor to allow association with access
1775 points which allow both encrypted and unencrypted traffic.
1778 means that the access point must only allow encrypted connections.
1781 is generally another name for
1783 Modes are case insensitive.
1784 .It Cm weptxkey Ar index
1785 Set the WEP key to be used for transmission.
1786 This is the same as setting the default transmission key with
1788 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
1789 Set the selected WEP key.
1792 is not given, key 1 is set.
1793 A WEP key will be either 5 or 13
1794 characters (40 or 104 bits) depending on the local network and the
1795 capabilities of the adaptor.
1796 It may be specified either as a plain
1797 string or as a string of hexadecimal digits preceded by
1799 For maximum portability, hex keys are recommended;
1800 the mapping of text keys to WEP encryption is usually driver-specific.
1803 drivers do this mapping differently to
1805 A key may be cleared by setting it to
1807 If WEP is supported then there are at least four keys.
1808 Some adapters support more than four keys.
1809 If that is the case, then the first four keys
1810 (1-4) will be the standard temporary keys and any others will be adaptor
1811 specific keys such as permanent keys stored in NVRAM.
1813 Note that you must set a default transmit key with
1815 for the system to know which key to use in encrypting outbound traffic.
1817 Enable Wireless Multimedia Extensions (WME) support, if available,
1818 for the specified interface.
1819 WME is a subset of the IEEE 802.11e standard to support the
1820 efficient communication of realtime and multimedia data.
1821 To disable WME support, use
1823 Another name for this parameter is
1826 The following parameters are meaningful only when WME support is in use.
1827 Parameters are specified per-AC (Access Category) and
1828 split into those that are used by a station when acting
1829 as an access point and those for client stations in the BSS.
1830 The latter are received from the access point and may not be changed
1832 The following Access Categories are recognized:
1834 .Bl -tag -width ".Cm AC_BK" -compact
1838 best effort delivery,
1853 AC parameters are case-insensitive.
1854 Traffic classification is done in the operating system using the
1855 vlan priority associated with data frames or the
1856 ToS (Type of Service) indication in IP-encapsulated frames.
1857 If neither information is present, traffic is assigned to the
1858 Best Effort (BE) category.
1859 .Bl -tag -width indent
1861 Set the ACK policy for QoS transmissions by the local station;
1862 this controls whether or not data frames transmitted by a station
1863 require an ACK response from the receiving station.
1864 To disable waiting for an ACK use
1866 This parameter is applied only to the local station.
1868 Enable the Admission Control Mandatory (ACM) mechanism
1869 for transmissions by the local station.
1870 To disable the ACM use
1872 On stations in a BSS this parameter is read-only and indicates
1873 the setting received from the access point.
1874 NB: ACM is not supported right now.
1875 .It Cm aifs Ar ac Ar count
1876 Set the Arbitration Inter Frame Spacing (AIFS)
1877 channel access parameter to use for transmissions
1878 by the local station.
1879 On stations in a BSS this parameter is read-only and indicates
1880 the setting received from the access point.
1881 .It Cm cwmin Ar ac Ar count
1882 Set the CWmin channel access parameter to use for transmissions
1883 by the local station.
1884 On stations in a BSS this parameter is read-only and indicates
1885 the setting received from the access point.
1886 .It Cm cwmax Ar ac Ar count
1887 Set the CWmax channel access parameter to use for transmissions
1888 by the local station.
1889 On stations in a BSS this parameter is read-only and indicates
1890 the setting received from the access point.
1891 .It Cm txoplimit Ar ac Ar limit
1892 Set the Transmission Opportunity Limit channel access parameter
1893 to use for transmissions by the local station.
1894 This parameter defines an interval of time when a WME station
1895 has the right to initiate transmissions onto the wireless medium.
1896 On stations in a BSS this parameter is read-only and indicates
1897 the setting received from the access point.
1898 .It Cm bss:aifs Ar ac Ar count
1899 Set the AIFS channel access parameter to send to stations in a BSS.
1900 This parameter is meaningful only when operating in ap mode.
1901 .It Cm bss:cwmin Ar ac Ar count
1902 Set the CWmin channel access parameter to send to stations in a BSS.
1903 This parameter is meaningful only when operating in ap mode.
1904 .It Cm bss:cwmax Ar ac Ar count
1905 Set the CWmax channel access parameter to send to stations in a BSS.
1906 This parameter is meaningful only when operating in ap mode.
1907 .It Cm bss:txoplimit Ar ac Ar limit
1908 Set the TxOpLimit channel access parameter to send to stations in a BSS.
1909 This parameter is meaningful only when operating in ap mode.
1912 Enable Wireless Privacy Subscriber support.
1913 Note that WPS support requires a WPS-capable supplicant.
1914 To disable this function use
1918 The following parameters support an optional access control list
1919 feature available with some adapters when operating in ap mode; see
1921 This facility allows an access point to accept/deny association
1922 requests based on the MAC address of the station.
1923 Note that this feature does not significantly enhance security
1924 as MAC address spoofing is easy to do.
1925 .Bl -tag -width indent
1926 .It Cm mac:add Ar address
1927 Add the specified MAC address to the database.
1928 Depending on the policy setting association requests from the
1929 specified station will be allowed or denied.
1931 Set the ACL policy to permit association only by
1932 stations registered in the database.
1933 .It Cm mac:del Ar address
1934 Delete the specified MAC address from the database.
1936 Set the ACL policy to deny association only by
1937 stations registered in the database.
1938 .It Cm mac:kick Ar address
1939 Force the specified station to be deauthenticated.
1940 This typically is done to block a station after updating the
1943 Set the ACL policy to allow all stations to associate.
1945 Delete all entries in the database.
1947 Set the ACL policy to permit association only by
1948 stations approved by a RADIUS server.
1949 Note that this feature requires the
1951 program be configured to do the right thing
1952 as it handles the RADIUS processing
1953 (and marks stations as authorized).
1956 The following parameters are related to a wireless interface operating in mesh
1958 .Bl -tag -width indent
1959 .It Cm meshid Ar meshid
1960 Set the desired Mesh Identifier.
1961 The Mesh ID is a string up to 32 characters in length.
1962 A mesh interface must have a Mesh Identifier specified
1963 to reach an operational state.
1964 .It Cm meshttl Ar ttl
1965 Set the desired ``time to live'' for mesh forwarded packets;
1966 this is the number of hops a packet may be forwarded before
1968 The default setting for
1972 Enable or disable peering with neighbor mesh stations.
1973 Stations must peer before any data packets can be exchanged.
1978 Enable or disable forwarding packets by a mesh interface.
1982 .It Cm meshmetric Ar protocol
1985 as the link metric protocol used on a mesh network.
1986 The default protocol is called
1988 The mesh interface will restart after changing this setting.
1989 .It Cm meshpath Ar protocol
1992 as the path selection protocol used on a mesh network.
1993 The only available protocol at the moment is called
1995 (Hybrid Wireless Mesh Protocol).
1996 The mesh interface will restart after changing this setting.
1997 .It Cm hwmprootmode Ar mode
1998 Stations on a mesh network can operate as ``root nodes.''
1999 Root nodes try to find paths to all mesh nodes and advertise themselves
2001 When there is a root mesh node on a network, other mesh nodes can setup
2002 paths between themselves faster because they can use the root node
2003 to find the destination.
2004 This path may not be the best, but on-demand
2005 routing will eventually find the best path.
2006 The following modes are recognized:
2008 .Bl -tag -width ".Cm PROACTIVE" -compact
2012 Send broadcast path requests every two seconds.
2013 Nodes on the mesh without a path to this root mesh station with try to
2014 discover a path to us.
2016 Send broadcast path requests every two seconds and every node must reply with
2017 with a path reply even if it already has a path to this root mesh station.
2019 Send broadcast root announcement (RANN) frames.
2020 Nodes on the mesh without a path to this root mesh station with try to
2021 discover a path to us.
2027 .It Cm hwmpmaxhops Ar cnt
2028 Set the maximum number of hops allowed in an HMWP path to
2030 The default setting for
2035 The following parameters are for compatibility with other systems:
2036 .Bl -tag -width indent
2038 Another name for the
2044 .It Cm stationname Ar name
2045 Set the name of this station.
2046 The station name is not part of the IEEE 802.11
2047 protocol though some interfaces support it.
2049 seems to be meaningful to identical or virtually identical equipment.
2050 Setting the station name is identical in syntax to setting the SSID.
2057 Another way of saying
2063 Another way of saying
2069 Another way of saying:
2070 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
2076 .Ar n : k1 , k2 , k3 , k4
2079 Another way of saying
2080 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
2085 Another way of saying
2092 The following parameters are specific to bridge interfaces:
2093 .Bl -tag -width indent
2094 .It Cm addm Ar interface
2095 Add the interface named by
2097 as a member of the bridge.
2098 The interface is put into promiscuous mode
2099 so that it can receive every packet sent on the network.
2100 .It Cm deletem Ar interface
2101 Remove the interface named by
2104 Promiscuous mode is disabled on the interface when
2105 it is removed from the bridge.
2106 .It Cm maxaddr Ar size
2107 Set the size of the bridge address cache to
2109 The default is 2000 entries.
2110 .It Cm timeout Ar seconds
2111 Set the timeout of address cache entries to
2116 is zero, then address cache entries will not be expired.
2117 The default is 1200 seconds.
2119 Display the addresses that have been learned by the bridge.
2120 .It Cm static Ar interface-name Ar address
2121 Add a static entry into the address cache pointing to
2122 .Ar interface-name .
2123 Static entries are never aged out of the cache or re-placed, even if the
2124 address is seen on a different interface.
2125 .It Cm deladdr Ar address
2128 from the address cache.
2130 Delete all dynamically-learned addresses from the address cache.
2132 Delete all addresses, including static addresses, from the address cache.
2133 .It Cm discover Ar interface
2134 Mark an interface as a
2137 When the bridge has no address cache entry
2138 (either dynamic or static)
2139 for the destination address of a packet,
2140 the bridge will forward the packet to all
2141 member interfaces marked as
2143 This is the default for all interfaces added to a bridge.
2144 .It Cm -discover Ar interface
2147 attribute on a member interface.
2148 For packets without the
2150 attribute, the only packets forwarded on the interface are broadcast
2151 or multicast packets and packets for which the destination address
2152 is known to be on the interface's segment.
2153 .It Cm learn Ar interface
2154 Mark an interface as a
2157 When a packet arrives on such an interface, the source
2158 address of the packet is entered into the address cache as being a
2159 destination address on the interface's segment.
2160 This is the default for all interfaces added to a bridge.
2161 .It Cm -learn Ar interface
2164 attribute on a member interface.
2165 .It Cm sticky Ar interface
2166 Mark an interface as a
2169 Dynamically learned address entries are treated at static once entered into
2171 Sticky entries are never aged out of the cache or replaced, even if the
2172 address is seen on a different interface.
2173 .It Cm -sticky Ar interface
2176 attribute on a member interface.
2177 .It Cm private Ar interface
2178 Mark an interface as a
2181 A private interface does not forward any traffic to any other port that is also
2182 a private interface.
2183 .It Cm -private Ar interface
2186 attribute on a member interface.
2187 .It Cm span Ar interface
2188 Add the interface named by
2190 as a span port on the bridge.
2191 Span ports transmit a copy of every frame received by the bridge.
2192 This is most useful for snooping a bridged network passively on
2193 another host connected to one of the span ports of the bridge.
2194 .It Cm -span Ar interface
2195 Delete the interface named by
2197 from the list of span ports of the bridge.
2198 .It Cm stp Ar interface
2199 Enable Spanning Tree protocol on
2203 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
2204 Spanning Tree is used to detect and remove loops in a network topology.
2205 .It Cm -stp Ar interface
2206 Disable Spanning Tree protocol on
2208 This is the default for all interfaces added to a bridge.
2209 .It Cm edge Ar interface
2213 An edge port connects directly to end stations cannot create bridging
2214 loops in the network, this allows it to transition straight to forwarding.
2215 .It Cm -edge Ar interface
2216 Disable edge status on
2218 .It Cm autoedge Ar interface
2221 to automatically detect edge status.
2222 This is the default for all interfaces added to a bridge.
2223 .It Cm -autoedge Ar interface
2224 Disable automatic edge status on
2226 .It Cm ptp Ar interface
2229 as a point to point link.
2230 This is required for straight transitions to forwarding and
2231 should be enabled on a direct link to another RSTP capable switch.
2232 .It Cm -ptp Ar interface
2233 Disable point to point link status on
2235 This should be disabled for a half duplex link and for an interface
2236 connected to a shared network segment,
2237 like a hub or a wireless network.
2238 .It Cm autoptp Ar interface
2239 Automatically detect the point to point status on
2241 by checking the full duplex link status.
2242 This is the default for interfaces added to the bridge.
2243 .It Cm -autoptp Ar interface
2244 Disable automatic point to point link detection on
2246 .It Cm maxage Ar seconds
2247 Set the time that a Spanning Tree protocol configuration is valid.
2248 The default is 20 seconds.
2249 The minimum is 6 seconds and the maximum is 40 seconds.
2250 .It Cm fwddelay Ar seconds
2251 Set the time that must pass before an interface begins forwarding
2252 packets when Spanning Tree is enabled.
2253 The default is 15 seconds.
2254 The minimum is 4 seconds and the maximum is 30 seconds.
2255 .It Cm hellotime Ar seconds
2256 Set the time between broadcasting of Spanning Tree protocol
2257 configuration messages.
2258 The hello time may only be changed when operating in legacy stp mode.
2259 The default is 2 seconds.
2260 The minimum is 1 second and the maximum is 2 seconds.
2261 .It Cm priority Ar value
2262 Set the bridge priority for Spanning Tree.
2263 The default is 32768.
2264 The minimum is 0 and the maximum is 61440.
2265 .It Cm proto Ar value
2266 Set the Spanning Tree protocol.
2267 The default is rstp.
2268 The available options are stp and rstp.
2269 .It Cm holdcnt Ar value
2270 Set the transmit hold count for Spanning Tree.
2271 This is the number of packets transmitted before being rate limited.
2273 The minimum is 1 and the maximum is 10.
2274 .It Cm ifpriority Ar interface Ar value
2275 Set the Spanning Tree priority of
2280 The minimum is 0 and the maximum is 240.
2281 .It Cm ifpathcost Ar interface Ar value
2282 Set the Spanning Tree path cost of
2286 The default is calculated from the link speed.
2287 To change a previously selected path cost back to automatic, set the
2289 The minimum is 1 and the maximum is 200000000.
2290 .It Cm ifmaxaddr Ar interface Ar size
2291 Set the maximum number of hosts allowed from an interface, packets with unknown
2292 source addresses are dropped until an existing host cache entry expires or is
2294 Set to 0 to disable.
2297 The following parameters are specific to lagg interfaces:
2298 .Bl -tag -width indent
2299 .It Cm laggport Ar interface
2300 Add the interface named by
2302 as a port of the aggregation interface.
2303 .It Cm -laggport Ar interface
2304 Remove the interface named by
2306 from the aggregation interface.
2307 .It Cm laggproto Ar proto
2308 Set the aggregation protocol.
2309 The default is failover.
2310 The available options are failover, fec, lacp, loadbalance, roundrobin and
2312 .It Cm lagghash Ar option Ns Oo , Ns Ar option Oc
2313 Set the packet layers to hash for aggregation protocols which load balance.
2316 The options can be combined using commas.
2318 .Bl -tag -width ".Cm l2" -compact
2320 src/dst mac address and optional vlan number.
2322 src/dst address for IPv4 or IPv6.
2324 src/dst port for TCP/UDP/SCTP.
2329 The following parameters are specific to IP tunnel interfaces,
2331 .Bl -tag -width indent
2332 .It Cm tunnel Ar src_addr dest_addr
2333 Configure the physical source and destination address for IP tunnel
2339 are interpreted as the outer source/destination for the encapsulating
2342 Unconfigure the physical source and destination address for IP tunnel
2343 interfaces previously configured with
2346 Another name for the
2349 .It Cm accept_rev_ethip_ver
2350 Set a flag to accept both correct EtherIP packets and ones
2351 with reversed version field. Enabled by default.
2352 This is for backward compatibility with
2354 6.2, 6.3, 7.0, and 7.1.
2355 .It Cm -accept_rev_ethip_ver
2357 .Cm accept_rev_ethip_ver .
2358 .It Cm send_rev_ethip_ver
2359 Set a flag to send EtherIP packets with reversed version
2360 field intentionally. Disabled by default.
2361 This is for backward compatibility with
2363 6.2, 6.3, 7.0, and 7.1.
2364 .It Cm -send_rev_ethip_ver
2366 .Cm send_rev_ethip_ver .
2369 The following parameters are specific to GRE tunnel interfaces,
2371 .Bl -tag -width indent
2372 .It Cm grekey Ar key
2373 Configure the GRE key to be used for outgoing packets.
2375 .Xr gre 4 will always accept GRE packets with invalid or absent keys.
2376 This command will result in a four byte MTU reduction on the interface.
2379 The following parameters are specific to
2382 .Bl -tag -width indent
2384 Set the maximum number of updates for a single state which
2385 can be collapsed into one.
2386 This is an 8-bit number; the default value is 128.
2389 The following parameters are specific to
2392 .Bl -tag -width indent
2393 .It Cm vlan Ar vlan_tag
2394 Set the VLAN tag value to
2396 This value is a 16-bit number which is used to create an 802.1Q
2397 VLAN header for packets sent from the
2404 must both be set at the same time.
2405 .It Cm vlandev Ar iface
2406 Associate the physical interface
2411 Packets transmitted through the
2414 diverted to the specified physical interface
2416 with 802.1Q VLAN encapsulation.
2417 Packets with 802.1Q encapsulation received
2418 by the parent interface with the correct VLAN tag will be diverted to
2424 interface is assigned a
2425 copy of the parent interface's flags and the parent's ethernet address.
2430 must both be set at the same time.
2433 interface already has
2434 a physical interface associated with it, this command will fail.
2436 change the association to another physical interface, the existing
2437 association must be cleared first.
2439 Note: if the hardware tagging capability
2440 is set on the parent interface, the
2443 interface's behavior changes:
2446 interface recognizes that the
2447 parent interface supports insertion and extraction of VLAN tags on its
2448 own (usually in firmware) and that it should pass packets to and from
2449 the parent unaltered.
2450 .It Fl vlandev Op Ar iface
2453 pseudo device, disassociate the parent interface from it.
2454 This breaks the link between the
2456 interface and its parent,
2457 clears its VLAN tag, flags and its link address and shuts the interface down.
2460 argument is useless and hence deprecated.
2463 The following parameters are specific to
2466 .Bl -tag -width indent
2467 .It Cm advbase Ar seconds
2468 Specifies the base of the advertisement interval in seconds.
2469 The acceptable values are 1 to 255.
2470 The default value is 1.
2471 .\" The default value is
2472 .\" .Dv CARP_DFLTINTV .
2473 .It Cm advskew Ar interval
2474 Specifies the skew to add to the base advertisement interval to
2475 make one host advertise slower than another host.
2476 It is specified in 1/256 of seconds.
2477 The acceptable values are 1 to 254.
2478 The default value is 0.
2479 .It Cm pass Ar phrase
2480 Set the authentication key to
2483 Set the virtual host ID.
2484 This is a required setting.
2485 Acceptable values are 1 to 255.
2486 .It Cm state Ar state
2487 Force the interface into state
2489 Valid states are INIT, BACKUP, and MASTER. Note that manually setting the state
2490 to INIT is ignored by
2492 This state is set automatically when the underlying interface is down.
2497 utility displays the current configuration for a network interface
2498 when no optional parameters are supplied.
2499 If a protocol family is specified,
2501 will report only the details specific to that protocol family.
2505 flag is passed before an interface name,
2507 will display the capability list and all
2508 of the supported media for the specified interface.
2511 flag is supplied, address lifetime is displayed for IPv6 addresses,
2512 as time offset string.
2516 flag may be used instead of an interface name.
2519 to display information about all interfaces in the system.
2522 flag limits this to interfaces that are down, and
2524 limits this to interfaces that are up.
2525 When no arguments are given,
2531 flag may be used to list all available interfaces on the system, with
2532 no other additional information.
2533 Use of this flag is mutually exclusive
2534 with all other flags and commands, except for
2536 (only list interfaces that are down)
2539 (only list interfaces that are up).
2543 flag may be used to get more verbose status for an interface.
2547 flag may be used to list all of the interface cloners available on
2548 the system, with no additional information.
2549 Use of this flag is mutually exclusive with all other flags and commands.
2553 flag causes keying information for the interface, if available, to be
2555 For example, the values of 802.11 WEP keys will be printed, if accessible to
2557 This information is not printed by default, as it may be considered
2560 If the network interface driver is not present in the kernel then
2562 will attempt to load it.
2565 flag disables this behavior.
2567 Only the super-user may modify the configuration of a network interface.
2569 The media selection system is relatively new and only some drivers support
2570 it (or have need for it).
2572 Assign the IPv4 address
2574 with a network mask of
2578 .Dl # ifconfig fxp0 inet 192.0.2.10 netmask 255.255.255.0
2580 Add the IPv4 address
2582 with the CIDR network prefix
2588 as a synonym for the canonical form of the option
2590 .Dl # ifconfig ed0 inet 192.0.2.45/28 add
2592 Remove the IPv4 address
2596 .Dl # ifconfig ed0 inet 192.0.2.45 -alias
2598 Enable IPv6 functionality of the interface:
2599 .Dl # ifconfig em0 inet6 -ifdisabled
2601 Add the IPv6 address
2602 .Li 2001:DB8:DBDB::123/48
2605 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias
2606 Note that lower case hexadecimal IPv6 addresses are acceptable.
2608 Remove the IPv6 address added in the above example,
2611 character as shorthand for the network prefix,
2614 as a synonym for the canonical form of the option
2616 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 delete
2618 Configure the interface
2620 to use 100baseTX, full duplex Ethernet media options:
2621 .Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex
2623 Label the em0 interface as an uplink:
2624 .Dl # ifconfig em0 description \&"Uplink to Gigabit Switch 2\&"
2626 Create the software network interface
2628 .Dl # ifconfig gif1 create
2630 Destroy the software network interface
2632 .Dl # ifconfig gif1 destroy
2634 Display available wireless networks using
2636 .Dl # ifconfig wlan0 list scan
2638 Messages indicating the specified interface does not exist, the
2639 requested address is unknown, or the user is not privileged and
2640 tried to alter an interface's configuration.
2660 Basic IPv6 node operation requires a link-local address on each
2661 interface configured for IPv6.
2662 Normally, such an address is automatically configured by the
2663 kernel on each interface added to the system or enabled; this behavior may
2664 be disabled by setting per-interface flag
2665 .Cm -auto_linklocal .
2666 The default value of this flag is 1 and can be disabled by using the sysctl
2668 .Va net.inet6.ip6.auto_linklocal .
2670 Do not configure IPv6 addresses with no link-local address by using
2672 It can result in unexpected behaviors of the kernel.
projects / FreeBSD / releng / 9.1.git / blob