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
725 .It Cm no_prefer_iface
726 Set a flag to not prefer address on the interface as candidates of the
727 source address for outgoing packets, even when the interface is
729 .It Cm -no_prefer_iface
731 .Cm no_prefer_iface .
734 The following parameters are specific to cloning
735 IEEE 802.11 wireless interfaces with the
738 .Bl -tag -width indent
739 .It Cm wlandev Ar device
742 as the parent for the cloned device.
743 .It Cm wlanmode Ar mode
744 Specify the operating mode for this cloned device.
762 The operating mode of a cloned interface cannot be changed.
765 mode is actually implemented as an
767 interface with special properties.
768 .It Cm wlanbssid Ar bssid
769 The 802.11 mac address to use for the bssid.
770 This must be specified at create time for a legacy
773 .It Cm wlanaddr Ar address
774 The local mac address.
775 If this is not specified then a mac address will automatically be assigned
776 to the cloned device.
777 Typically this address is the same as the address of the parent device
780 parameter is specified then the driver will craft a unique address for
781 the device (if supported).
785 device as operating in ``legacy mode''.
788 devices have a fixed peer relationship and do not, for example, roam
789 if their peer stops communicating.
790 For completeness a Dynamic WDS (DWDS) interface may marked as
793 Request a unique local mac address for the cloned device.
794 This is only possible if the device supports multiple mac addresses.
795 To force use of the parent's mac address use
798 Mark the cloned interface as depending on hardware support to
799 track received beacons.
800 To have beacons tracked in software use
806 can also be used to indicate no beacons should
807 be transmitted; this can be useful when creating a WDS configuration but
809 interfaces can only be created as companions to an access point.
812 The following parameters are specific to IEEE 802.11 wireless interfaces
816 .Bl -tag -width indent
818 Enable sending and receiving AMPDU frames when using 802.11n (default).
819 The 802.11n specification states a compliant station must be capable
820 of receiving AMPDU frames but transmission is optional.
823 to disable all use of AMPDU with 802.11n.
824 For testing and/or to work around interoperability problems one can use
828 to control use of AMPDU in one direction.
829 .It Cm ampdudensity Ar density
830 Set the AMPDU density parameter used when operating with 802.11n.
831 This parameter controls the inter-packet gap for AMPDU frames.
832 The sending device normally controls this setting but a receiving station
833 may request wider gaps.
836 are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds).
839 is treated the same as 0.
840 .It Cm ampdulimit Ar limit
841 Set the limit on packet size for receiving AMPDU frames when operating
845 are 8192, 16384, 32768, and 65536 but one can also specify
846 just the unique prefix: 8, 16, 32, 64.
847 Note the sender may limit the size of AMPDU frames to be less
848 than the maximum specified by the receiving station.
850 Enable sending and receiving AMSDU frames when using 802.11n.
851 By default AMSDU is received but not transmitted.
854 to disable all use of AMSDU with 802.11n.
855 For testing and/or to work around interoperability problems one can use
859 to control use of AMSDU in one direction.
860 .It Cm amsdulimit Ar limit
861 Set the limit on packet size for sending and receiving AMSDU frames
862 when operating with 802.11n.
865 are 7935 and 3839 (bytes).
866 Note the sender may limit the size of AMSDU frames to be less
867 than the maximum specified by the receiving station.
868 Note also that devices are not required to support the 7935 limit,
869 only 3839 is required by the specification and the larger value
870 may require more memory to be dedicated to support functionality
873 When operating as an access point, pass packets between
874 wireless clients directly (default).
875 To instead let them pass up through the
876 system and be forwarded using some other mechanism, use
878 Disabling the internal bridging
879 is useful when traffic is to be processed with
881 .It Cm authmode Ar mode
882 Set the desired authentication mode in infrastructure mode.
883 Not all adapters support all modes.
886 .Cm none , open , shared
892 (IEEE WPA/WPA2/802.11i).
897 modes are only useful when using an authentication service
898 (a supplicant for client operation or an authenticator when
899 operating as an access point).
900 Modes are case insensitive.
902 Enable background scanning when operating as a station.
903 Background scanning is a technique whereby a station associated to
904 an access point will temporarily leave the channel to scan for
905 neighboring stations.
906 This allows a station to maintain a cache of nearby access points
907 so that roaming between access points can be done without
908 a lengthy scan operation.
909 Background scanning is done only when a station is not busy and
910 any outbound traffic will cancel a scan operation.
911 Background scanning should never cause packets to be lost though
912 there may be some small latency if outbound traffic interrupts a
914 By default background scanning is enabled if the device is capable.
915 To disable background scanning, use
917 Background scanning is controlled by the
922 Background scanning must be enabled for roaming; this is an artifact
923 of the current implementation and may not be required in the future.
924 .It Cm bgscanidle Ar idletime
925 Set the minimum time a station must be idle (not transmitting or
926 receiving frames) before a background scan is initiated.
929 parameter is specified in milliseconds.
930 By default a station must be idle at least 250 milliseconds before
931 a background scan is initiated.
932 The idle time may not be set to less than 100 milliseconds.
933 .It Cm bgscanintvl Ar interval
934 Set the interval at which background scanning is attempted.
937 parameter is specified in seconds.
938 By default a background scan is considered every 300 seconds (5 minutes).
941 may not be set to less than 15 seconds.
942 .It Cm bintval Ar interval
943 Set the interval at which beacon frames are sent when operating in
947 parameter is specified in TU's (1024 usecs).
948 By default beacon frames are transmitted every 100 TU's.
949 .It Cm bmissthreshold Ar count
950 Set the number of consecutive missed beacons at which the station
951 will attempt to roam (i.e., search for a new access point).
954 parameter must be in the range 1 to 255; though the
955 upper bound may be reduced according to device capabilities.
956 The default threshold is 7 consecutive missed beacons; but
957 this may be overridden by the device driver.
962 .It Cm bssid Ar address
963 Specify the MAC address of the access point to use when operating
964 as a station in a BSS network.
965 This overrides any automatic selection done by the system.
966 To disable a previously selected access point, supply
971 This option is useful when more than one access point uses the same SSID.
977 Enable packet bursting.
978 Packet bursting is a transmission technique whereby the wireless
979 medium is acquired once to send multiple frames and the interframe
981 This technique can significantly increase throughput by reducing
982 transmission overhead.
983 Packet bursting is supported by the 802.11e QoS specification
984 and some devices that do not support QoS may still be capable.
985 By default packet bursting is enabled if a device is capable
987 To disable packet bursting, use
989 .It Cm chanlist Ar channels
990 Set the desired channels to use when scanning for access
991 points, neighbors in an IBSS network, or looking for unoccupied
992 channels when operating as an access point.
993 The set of channels is specified as a comma-separated list with
994 each element in the list representing either a single channel number or a range
997 Channel numbers must be in the range 1 to 255 and be permissible
998 according to the operating characteristics of the device.
999 .It Cm channel Ar number
1000 Set a single desired channel.
1001 Channels range from 1 to 255, but the exact selection available
1002 depends on the region your adaptor was manufactured for.
1008 will clear any desired channel and, if the device is marked up,
1009 force a scan for a channel to operate on.
1010 Alternatively the frequency, in megahertz, may be specified
1011 instead of the channel number.
1013 When there are several ways to use a channel the channel
1014 number/frequency may be appended with attributes to clarify.
1015 For example, if a device is capable of operating on channel 6
1016 with 802.11n and 802.11g then one can specify that g-only use
1017 should be used by specifying ``6:g''.
1018 Similarly the channel width can be specified by appending it
1019 with ``/''; e.g., ``6/40'' specifies a 40MHz wide channel,
1020 These attributes can be combined as in: ``6:ht/40''.
1021 The full set of flags specified following a ``:'' are:
1027 (Atheros Dynamic Turbo mode),
1035 (Atheros Static Turbo mode),
1038 (Atheros Dynamic Turbo mode, or appended to ``st'' and ``dt'').
1039 The full set of channel widths following a '/' are:
1041 (5MHz aka quarter-rate channel),
1043 (10MHz aka half-rate channel),
1045 (20MHz mostly for use in specifying ht20),
1048 (40MHz mostly for use in specifying ht40).
1050 a 40MHz HT channel specification may include the location
1051 of the extension channel by appending ``+'' or ``-'' for above and below,
1052 respectively; e.g., ``2437:ht/40+'' specifies 40MHz wide HT operation
1053 with the center channel at frequency 2437 and the extension channel above.
1054 .It Cm country Ar name
1055 Set the country code to use in calculating the regulatory constraints
1057 In particular the set of available channels, how the wireless device
1058 will operation on the channels, and the maximum transmit power that
1059 can be used on a channel are defined by this setting.
1060 Country/Region codes are specified as a 2-character abbreviation
1061 defined by ISO 3166 or using a longer, but possibly ambiguous, spelling;
1062 e.g., "ES" and "Spain".
1063 The set of country codes are taken from /etc/regdomain.xml and can also
1064 be viewed with the ``list countries'' request.
1065 Note that not all devices support changing the country code from a default
1066 setting; typically stored in EEPROM.
1074 Enable Dynamic Frequency Selection (DFS) as specified in 802.11h.
1075 DFS embodies several facilities including detection of overlapping
1076 radar signals, dynamic transmit power control, and channel selection
1077 according to a least-congested criteria.
1078 DFS support is mandatory for some 5GHz frequencies in certain
1079 locales (e.g., ETSI).
1080 By default DFS is enabled according to the regulatory definitions
1081 specified in /etc/regdomain.xml and the current country code, regdomain,
1083 Note the underlying device (and driver) must support radar detection
1084 for full DFS support to work.
1085 To be fully compliant with the local regulatory agency frequencies that
1086 require DFS should not be used unless it is fully supported.
1089 to disable this functionality for testing.
1091 Enable support for the 802.11d specification (default).
1092 When this support is enabled in station mode, beacon frames that advertise
1093 a country code different than the currently configured country code will
1094 cause an event to be dispatched to user applications.
1095 This event can be used by the station to adopt that country code and
1096 operate according to the associated regulatory constraints.
1097 When operating as an access point with 802.11d enabled the beacon and
1098 probe response frames transmitted will advertise the current regulatory
1100 To disable 802.11d use
1103 Enable 802.11h support including spectrum management.
1104 When 802.11h is enabled beacon and probe response frames will have
1105 the SpectrumMgt bit set in the capabilities field and
1106 country and power constraint information elements will be present.
1107 802.11h support also includes handling Channel Switch Announcements (CSA)
1108 which are a mechanism to coordinate channel changes by an access point.
1109 By default 802.11h is enabled if the device is capable.
1110 To disable 802.11h use
1112 .It Cm deftxkey Ar index
1113 Set the default key to use for transmission.
1114 Typically this is only set when using WEP encryption.
1115 Note that you must set a default transmit key
1116 for the system to know which key to use in encrypting outbound traffic.
1119 is an alias for this request; it is provided for backwards compatibility.
1120 .It Cm dtimperiod Ar period
1123 period for transmitting buffered multicast data frames when
1124 operating in ap mode.
1127 specifies the number of beacon intervals between DTIM
1128 and must be in the range 1 to 15.
1129 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
1131 Enable the use of Atheros Dynamic Turbo mode when communicating with
1132 another Dynamic Turbo-capable station.
1133 Dynamic Turbo mode is an Atheros-specific mechanism by which
1134 stations switch between normal 802.11 operation and a ``boosted''
1135 mode in which a 40MHz wide channel is used for communication.
1136 Stations using Dynamic Turbo mode operate boosted only when the
1137 channel is free of non-dturbo stations; when a non-dturbo station
1138 is identified on the channel all stations will automatically drop
1139 back to normal operation.
1140 By default, Dynamic Turbo mode is not enabled, even if the device is capable.
1141 Note that turbo mode (dynamic or static) is only allowed on some
1142 channels depending on the regulatory constraints; use the
1144 command to identify the channels where turbo mode may be used.
1145 To disable Dynamic Turbo mode use
1148 Enable Dynamic WDS (DWDS) support.
1149 DWDS is a facility by which 4-address traffic can be carried between
1150 stations operating in infrastructure mode.
1151 A station first associates to an access point and authenticates using
1152 normal procedures (e.g., WPA).
1153 Then 4-address frames are passed to carry traffic for stations
1154 operating on either side of the wireless link.
1155 DWDS extends the normal WDS mechanism by leveraging existing security
1156 protocols and eliminating static binding.
1158 When DWDS is enabled on an access point 4-address frames received from
1159 an authorized station will generate a ``DWDS discovery'' event to user
1161 This event should be used to create a WDS interface that is bound
1162 to the remote station (and usually plumbed into a bridge).
1163 Once the WDS interface is up and running 4-address traffic then logically
1164 flows through that interface.
1166 When DWDS is enabled on a station, traffic with a destination address
1167 different from the peer station are encapsulated in a 4-address frame
1168 and transmitted to the peer.
1169 All 4-address traffic uses the security information of the stations
1170 (e.g., cryptographic keys).
1171 A station is associated using 802.11n facilities may transport
1172 4-address traffic using these same mechanisms; this depends on available
1173 resources and capabilities of the device.
1174 The DWDS implementation guards against layer 2 routing loops of
1177 Enable the use of Atheros Fast Frames when communicating with
1178 another Fast Frames-capable station.
1179 Fast Frames are an encapsulation technique by which two 802.3
1180 frames are transmitted in a single 802.11 frame.
1181 This can noticeably improve throughput but requires that the
1182 receiving station understand how to decapsulate the frame.
1183 Fast frame use is negotiated using the Atheros 802.11 vendor-specific
1184 protocol extension so enabling use is safe when communicating with
1185 non-Atheros devices.
1186 By default, use of fast frames is enabled if the device is capable.
1187 To explicitly disable fast frames, use
1189 .It Cm fragthreshold Ar length
1190 Set the threshold for which transmitted frames are broken into fragments.
1193 argument is the frame size in bytes and must be in the range 256 to 2346.
1201 disables transmit fragmentation.
1202 Not all adapters honor the fragmentation threshold.
1204 When operating as an access point, do not broadcast the SSID
1205 in beacon frames or respond to probe request frames unless
1206 they are directed to the ap (i.e., they include the ap's SSID).
1207 By default, the SSID is included in beacon frames and
1208 undirected probe request frames are answered.
1209 To re-enable the broadcast of the SSID etc., use
1212 Enable use of High Throughput (HT) when using 802.11n (default).
1213 The 802.11n specification includes mechanisms for operation
1214 on 20MHz and 40MHz wide channels using different signalling mechanisms
1215 than specified in 802.11b, 802.11g, and 802.11a.
1216 Stations negotiate use of these facilities, termed HT20 and HT40,
1217 when they associate.
1218 To disable all use of 802.11n use
1220 To disable use of HT20 (e.g., to force only HT40 use) use
1222 To disable use of HT40 use
1225 HT configuration is used to ``auto promote'' operation
1226 when several choices are available.
1227 For example, if a station associates to an 11n-capable access point
1228 it controls whether the station uses legacy operation, HT20, or HT40.
1229 When an 11n-capable device is setup as an access point and
1230 Auto Channel Selection is used to locate a channel to operate on,
1231 HT configuration controls whether legacy, HT20, or HT40 operation is setup
1232 on the selected channel.
1233 If a fixed channel is specified for a station then HT configuration can
1234 be given as part of the channel specification; e.g., 6:ht/20 to setup
1235 HT20 operation on channel 6.
1237 Enable use of compatibility support for pre-802.11n devices (default).
1238 The 802.11n protocol specification went through several incompatible iterations.
1239 Some vendors implemented 11n support to older specifications that
1240 will not interoperate with a purely 11n-compliant station.
1241 In particular the information elements included in management frames
1242 for old devices are different.
1243 When compatibility support is enabled both standard and compatible data
1245 Stations that associate using the compatibility mechanisms are flagged
1247 To disable compatibility support use
1249 .It Cm htprotmode Ar technique
1250 For interfaces operating in 802.11n, use the specified
1252 for protecting HT frames in a mixed legacy/HT network.
1253 The set of valid techniques is
1258 Technique names are case insensitive.
1260 Enable inactivity processing for stations associated to an
1261 access point (default).
1262 When operating as an access point the 802.11 layer monitors
1263 the activity of each associated station.
1264 When a station is inactive for 5 minutes it will send several
1265 ``probe frames'' to see if the station is still present.
1266 If no response is received then the station is deauthenticated.
1267 Applications that prefer to handle this work can disable this
1271 Set the location to use in calculating regulatory constraints.
1272 The location is also advertised in beacon and probe response frames
1273 when 802.11d is enabled with
1282 Display the list of channels available for use taking into account
1283 any restrictions set with the
1286 See the description of
1288 for more information.
1290 Display the adaptor's capabilities, including the operating
1293 Display the list of channels available for use.
1294 Channels are shown with their IEEE channel number, equivalent
1295 frequency, and usage modes.
1296 Channels identified as
1301 Channels identified as
1303 may be used only for Atheros' Static Turbo mode
1305 . Cm mediaopt turbo ) .
1306 Channels marked with a
1308 have a regulatory constraint that they be passively scanned.
1309 This means a station is not permitted to transmit on the channel until
1310 it identifies the channel is being used for 802.11 communication;
1311 typically by hearing a beacon frame from an access point operating
1314 is another way of requesting this information.
1315 By default a compacted list of channels is displayed; if the
1317 option is specified then all channels are shown.
1318 .It Cm list countries
1319 Display the set of country codes and regulatory domains that can be
1320 used in regulatory configuration.
1322 Display the current MAC Access Control List state.
1323 Each address is prefixed with a character that indicates the
1324 current policy applied to it:
1326 indicates the address is allowed access,
1328 indicates the address is denied access,
1330 indicates the address is present but the current policy open
1331 (so the ACL is not consulted).
1333 Displays the mesh routing table, used for forwarding packets on a mesh
1335 .It Cm list regdomain
1336 Display the current regulatory settings including the available channels
1337 and transmit power caps.
1339 Display the parameters that govern roaming operation.
1341 Display the parameters that govern transmit operation.
1343 Display the transmit power caps for each channel.
1345 Display the access points and/or ad-hoc neighbors
1346 located in the vicinity.
1347 This information may be updated automatically by the adapter
1350 request or through background scanning.
1351 Depending on the capabilities of the stations the following
1352 flags can be included in the output:
1356 Indicates that the station is permitted to send/receive data frames.
1358 Extended Rate Phy (ERP).
1359 Indicates that the station is operating in an 802.11g network
1360 using extended transmit rates.
1362 High Throughput (HT).
1363 Indicates that the station is using HT transmit rates.
1364 If a `+' follows immediately after then the station associated
1365 using deprecated mechanisms supported only when
1370 Indicates that the station is operating in power save mode.
1372 Quality of Service (QoS).
1373 Indicates that the station is using QoS encapsulation for
1375 QoS encapsulation is enabled only when WME mode is enabled.
1378 Indicates that the station is doing short preamble to optionally
1379 improve throughput performance with 802.11g and 802.11b.
1381 Transitional Security Network (TSN).
1382 Indicates that the station associated using TSN; see also
1386 Wi-Fi Protected Setup (WPS).
1387 Indicates that the station associated using WPS.
1390 By default interesting information elements captured from the neighboring
1391 stations are displayed at the end of each row.
1392 Possible elements include:
1394 (station supports WME),
1396 (station supports WPA),
1398 (station supports WPS),
1400 (station supports 802.11i/RSN),
1402 (station supports 802.11n/HT communication),
1404 (station supports Atheros protocol extensions),
1406 (station supports unknown vendor-specific extensions).
1409 flag is used all the information elements and their
1410 contents will be shown.
1413 flag also enables display of long SSIDs.
1416 command is another way of requesting this information.
1418 When operating as an access point display the stations that are
1419 currently associated.
1420 When operating in ad-hoc mode display stations identified as
1421 neighbors in the IBSS.
1422 When operating in mesh mode display stations identified as
1423 neighbors in the MBSS.
1424 When operating in station mode display the access point.
1425 Capabilities advertised by the stations are described under
1429 Depending on the capabilities of the stations the following
1430 flags can be included in the output:
1434 Indicates that the station is permitted to send/receive data frames.
1436 Extended Rate Phy (ERP).
1437 Indicates that the station is operating in an 802.11g network
1438 using extended transmit rates.
1440 High Throughput (HT).
1441 Indicates that the station is using HT transmit rates.
1442 If a `+' follows immediately after then the station associated
1443 using deprecated mechanisms supported only when
1448 Indicates that the station is operating in power save mode.
1450 Quality of Service (QoS).
1451 Indicates that the station is using QoS encapsulation for
1453 QoS encapsulation is enabled only when WME mode is enabled.
1456 Indicates that the station is doing short preamble to optionally
1457 improve throughput performance with 802.11g and 802.11b.
1459 Transitional Security Network (TSN).
1460 Indicates that the station associated using TSN; see also
1464 Wi-Fi Protected Setup (WPS).
1465 Indicates that the station associated using WPS.
1468 By default information elements received from associated stations
1469 are displayed in a short form; the
1471 flag causes this information to be displayed symbolically.
1473 Display the current channel parameters to use when operating in WME mode.
1476 option is specified then both channel and BSS parameters are displayed
1477 for each AC (first channel, then BSS).
1478 When WME mode is enabled for an adaptor this information will be
1479 displayed with the regular status; this command is mostly useful
1480 for examining parameters when WME mode is disabled.
1481 See the description of the
1483 directive for information on the various parameters.
1484 .It Cm maxretry Ar count
1485 Set the maximum number of tries to use in sending unicast frames.
1486 The default setting is 6 but drivers may override this with a value
1488 .It Cm mcastrate Ar rate
1489 Set the rate for transmitting multicast/broadcast frames.
1490 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1491 This rate should be valid for the current operating conditions;
1492 if an invalid rate is specified drivers are free to chose an
1494 .It Cm mgtrate Ar rate
1495 Set the rate for transmitting management and/or control frames.
1496 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1498 Set the location to use in calculating regulatory constraints.
1499 The location is also advertised in beacon and probe response frames
1500 when 802.11d is enabled with
1509 Enable powersave operation.
1510 When operating as a client, the station will conserve power by
1511 periodically turning off the radio and listening for
1512 messages from the access point telling it there are packets waiting.
1513 The station must then retrieve the packets.
1514 Not all devices support power save operation as a client.
1515 The 802.11 specification requires that all access points support
1516 power save but some drivers do not.
1519 to disable powersave operation when operating as a client.
1520 .It Cm powersavesleep Ar sleep
1521 Set the desired max powersave sleep time in TU's (1024 usecs).
1522 By default the max powersave sleep time is 100 TU's.
1523 .It Cm protmode Ar technique
1524 For interfaces operating in 802.11g, use the specified
1526 for protecting OFDM frames in a mixed 11b/11g network.
1527 The set of valid techniques is
1533 Technique names are case insensitive.
1534 Not all devices support
1536 as a protection technique.
1538 When operating as an access point in 802.11g mode allow only
1539 11g-capable stations to associate (11b-only stations are not
1540 permitted to associate).
1541 To allow both 11g and 11b-only stations to associate, use
1544 When operating as an access point in 802.11n mode allow only
1545 HT-capable stations to associate (legacy stations are not
1546 permitted to associate).
1547 To allow both HT and legacy stations to associate, use
1549 .It Cm regdomain Ar sku
1550 Set the regulatory domain to use in calculating the regulatory constraints
1552 In particular the set of available channels, how the wireless device
1553 will operation on the channels, and the maximum transmit power that
1554 can be used on a channel are defined by this setting.
1555 Regdomain codes (SKU's) are taken from /etc/regdomain.xml and can also
1556 be viewed with the ``list countries'' request.
1557 Note that not all devices support changing the regdomain from a default
1558 setting; typically stored in EEPROM.
1566 Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n
1568 Note that RIFS must be supported by both the station and access point
1572 .It Cm roam:rate Ar rate
1573 Set the threshold for controlling roaming when operating in a BSS.
1576 parameter specifies the transmit rate in megabits
1577 at which roaming should be considered.
1578 If the current transmit rate drops below this setting and background scanning
1579 is enabled, then the system will check if a more desirable access point is
1580 available and switch over to it.
1581 The current scan cache contents are used if they are considered
1582 valid according to the
1584 parameter; otherwise a background scan operation is triggered before
1585 any selection occurs.
1586 Each channel type has a separate rate threshold; the default values are:
1587 12 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng).
1588 .It Cm roam:rssi Ar rssi
1589 Set the threshold for controlling roaming when operating in a BSS.
1592 parameter specifies the receive signal strength in dBm units
1593 at which roaming should be considered.
1594 If the current rssi drops below this setting and background scanning
1595 is enabled, then the system will check if a more desirable access point is
1596 available and switch over to it.
1597 The current scan cache contents are used if they are considered
1598 valid according to the
1600 parameter; otherwise a background scan operation is triggered before
1601 any selection occurs.
1602 Each channel type has a separate rssi threshold; the default values are
1604 .It Cm roaming Ar mode
1605 When operating as a station, control how the system will
1606 behave when communication with the current access point
1610 argument may be one of
1612 (leave it to the hardware device to decide),
1614 (handle either in the device or the operating system\[em]as appropriate),
1616 (do nothing until explicitly instructed).
1617 By default, the device is left to handle this if it is
1618 capable; otherwise, the operating system will automatically
1619 attempt to reestablish communication.
1620 Manual mode is used by applications such as
1621 .Xr wpa_supplicant 8
1622 that want to control the selection of an access point.
1623 .It Cm rtsthreshold Ar length
1624 Set the threshold for which
1625 transmitted frames are preceded by transmission of an
1631 is the frame size in bytes and must be in the range 1 to 2346.
1639 disables transmission of RTS frames.
1640 Not all adapters support setting the RTS threshold.
1642 Initiate a scan of neighboring stations, wait for it to complete, and
1643 display all stations found.
1644 Only the super-user can initiate a scan.
1647 for information on the display.
1648 By default a background scan is done; otherwise a foreground
1649 scan is done and the station may roam to a different access point.
1652 request can be used to show recent scan results without
1653 initiating a new scan.
1654 .It Cm scanvalid Ar threshold
1655 Set the maximum time the scan cache contents are considered valid;
1656 i.e., will be used without first triggering a scan operation to
1660 parameter is specified in seconds and defaults to 60 seconds.
1661 The minimum setting for
1664 One should take care setting this threshold; if it is set too low
1665 then attempts to roam to another access point may trigger unnecessary
1666 background scan operations.
1668 Enable use of Short Guard Interval when operating in 802.11n
1670 NB: this currently enables Short GI on both HT40 and HT20 channels.
1671 To disable Short GI use
1674 Enable use of Static Spatial Multiplexing Power Save (SMPS)
1675 when operating in 802.11n.
1676 A station operating with Static SMPS maintains only a single
1677 receive chain active (this can significantly reduce power consumption).
1681 Enable use of Dynamic Spatial Multiplexing Power Save (SMPS)
1682 when operating in 802.11n.
1683 A station operating with Dynamic SMPS maintains only a single
1684 receive chain active but switches to multiple receive chains when it
1685 receives an RTS frame (this can significantly reduce power consumption).
1686 Note that stations cannot distinguish between RTS/CTS intended to
1687 enable multiple receive chains and those used for other purposes.
1691 Set the desired Service Set Identifier (aka network name).
1692 The SSID is a string up to 32 characters
1693 in length and may be specified as either a normal string or in
1694 hexadecimal when preceded by
1696 Additionally, the SSID may be cleared by setting it to
1698 .It Cm tdmaslot Ar slot
1699 When operating with TDMA, use the specified
1704 is a number between 0 and the maximum number of slots in the BSS.
1705 Note that a station configured as slot 0 is a master and
1706 will broadcast beacon frames advertising the BSS;
1707 stations configured to use other slots will always
1708 scan to locate a master before they ever transmit.
1712 .It Cm tdmaslotcnt Ar cnt
1713 When operating with TDMA, setup a BSS with
1716 The slot count may be at most 8.
1717 The current implementation is only tested with two stations
1718 (i.e., point to point applications).
1719 This setting is only meaningful when a station is configured as slot 0;
1720 other stations adopt this setting from the BSS they join.
1724 .It Cm tdmaslotlen Ar len
1725 When operating with TDMA, setup a BSS such that each station has a slot
1728 The slot length must be at least 150 microseconds (1/8 TU)
1729 and no more than 65 milliseconds.
1730 Note that setting too small a slot length may result in poor channel
1731 bandwidth utilization due to factors such as timer granularity and
1733 This setting is only meaningful when a station is configured as slot 0;
1734 other stations adopt this setting from the BSS they join.
1737 is set to 10 milliseconds.
1738 .It Cm tdmabintval Ar intval
1739 When operating with TDMA, setup a BSS such that beacons are transmitted every
1741 superframes to synchronize the TDMA slot timing.
1742 A superframe is defined as the number of slots times the slot length; e.g.,
1743 a BSS with two slots of 10 milliseconds has a 20 millisecond superframe.
1744 The beacon interval may not be zero.
1747 causes the timers to be resynchronized more often; this can be help if
1748 significant timer drift is observed.
1753 When operating as an access point with WPA/802.11i allow legacy
1754 stations to associate using static key WEP and open authentication.
1755 To disallow legacy station use of WEP, use
1757 .It Cm txpower Ar power
1758 Set the power used to transmit frames.
1761 argument is specified in .5 dBm units.
1762 Out of range values are truncated.
1763 Typically only a few discreet power settings are available and
1764 the driver will use the setting closest to the specified value.
1765 Not all adapters support changing the transmit power.
1766 .It Cm ucastrate Ar rate
1767 Set a fixed rate for transmitting unicast frames.
1768 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1769 This rate should be valid for the current operating conditions;
1770 if an invalid rate is specified drivers are free to chose an
1772 .It Cm wepmode Ar mode
1773 Set the desired WEP mode.
1774 Not all adapters support all modes.
1775 The set of valid modes is
1781 mode explicitly tells the adaptor to allow association with access
1782 points which allow both encrypted and unencrypted traffic.
1785 means that the access point must only allow encrypted connections.
1788 is generally another name for
1790 Modes are case insensitive.
1791 .It Cm weptxkey Ar index
1792 Set the WEP key to be used for transmission.
1793 This is the same as setting the default transmission key with
1795 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
1796 Set the selected WEP key.
1799 is not given, key 1 is set.
1800 A WEP key will be either 5 or 13
1801 characters (40 or 104 bits) depending on the local network and the
1802 capabilities of the adaptor.
1803 It may be specified either as a plain
1804 string or as a string of hexadecimal digits preceded by
1806 For maximum portability, hex keys are recommended;
1807 the mapping of text keys to WEP encryption is usually driver-specific.
1810 drivers do this mapping differently to
1812 A key may be cleared by setting it to
1814 If WEP is supported then there are at least four keys.
1815 Some adapters support more than four keys.
1816 If that is the case, then the first four keys
1817 (1-4) will be the standard temporary keys and any others will be adaptor
1818 specific keys such as permanent keys stored in NVRAM.
1820 Note that you must set a default transmit key with
1822 for the system to know which key to use in encrypting outbound traffic.
1824 Enable Wireless Multimedia Extensions (WME) support, if available,
1825 for the specified interface.
1826 WME is a subset of the IEEE 802.11e standard to support the
1827 efficient communication of realtime and multimedia data.
1828 To disable WME support, use
1830 Another name for this parameter is
1833 The following parameters are meaningful only when WME support is in use.
1834 Parameters are specified per-AC (Access Category) and
1835 split into those that are used by a station when acting
1836 as an access point and those for client stations in the BSS.
1837 The latter are received from the access point and may not be changed
1839 The following Access Categories are recognized:
1841 .Bl -tag -width ".Cm AC_BK" -compact
1845 best effort delivery,
1860 AC parameters are case-insensitive.
1861 Traffic classification is done in the operating system using the
1862 vlan priority associated with data frames or the
1863 ToS (Type of Service) indication in IP-encapsulated frames.
1864 If neither information is present, traffic is assigned to the
1865 Best Effort (BE) category.
1866 .Bl -tag -width indent
1868 Set the ACK policy for QoS transmissions by the local station;
1869 this controls whether or not data frames transmitted by a station
1870 require an ACK response from the receiving station.
1871 To disable waiting for an ACK use
1873 This parameter is applied only to the local station.
1875 Enable the Admission Control Mandatory (ACM) mechanism
1876 for transmissions by the local station.
1877 To disable the ACM use
1879 On stations in a BSS this parameter is read-only and indicates
1880 the setting received from the access point.
1881 NB: ACM is not supported right now.
1882 .It Cm aifs Ar ac Ar count
1883 Set the Arbitration Inter Frame Spacing (AIFS)
1884 channel access parameter to use for transmissions
1885 by the local station.
1886 On stations in a BSS this parameter is read-only and indicates
1887 the setting received from the access point.
1888 .It Cm cwmin Ar ac Ar count
1889 Set the CWmin channel access parameter to use for transmissions
1890 by the local station.
1891 On stations in a BSS this parameter is read-only and indicates
1892 the setting received from the access point.
1893 .It Cm cwmax Ar ac Ar count
1894 Set the CWmax channel access parameter to use for transmissions
1895 by the local station.
1896 On stations in a BSS this parameter is read-only and indicates
1897 the setting received from the access point.
1898 .It Cm txoplimit Ar ac Ar limit
1899 Set the Transmission Opportunity Limit channel access parameter
1900 to use for transmissions by the local station.
1901 This parameter defines an interval of time when a WME station
1902 has the right to initiate transmissions onto the wireless medium.
1903 On stations in a BSS this parameter is read-only and indicates
1904 the setting received from the access point.
1905 .It Cm bss:aifs Ar ac Ar count
1906 Set the AIFS channel access parameter to send to stations in a BSS.
1907 This parameter is meaningful only when operating in ap mode.
1908 .It Cm bss:cwmin Ar ac Ar count
1909 Set the CWmin channel access parameter to send to stations in a BSS.
1910 This parameter is meaningful only when operating in ap mode.
1911 .It Cm bss:cwmax Ar ac Ar count
1912 Set the CWmax channel access parameter to send to stations in a BSS.
1913 This parameter is meaningful only when operating in ap mode.
1914 .It Cm bss:txoplimit Ar ac Ar limit
1915 Set the TxOpLimit channel access parameter to send to stations in a BSS.
1916 This parameter is meaningful only when operating in ap mode.
1919 Enable Wireless Privacy Subscriber support.
1920 Note that WPS support requires a WPS-capable supplicant.
1921 To disable this function use
1925 The following parameters support an optional access control list
1926 feature available with some adapters when operating in ap mode; see
1928 This facility allows an access point to accept/deny association
1929 requests based on the MAC address of the station.
1930 Note that this feature does not significantly enhance security
1931 as MAC address spoofing is easy to do.
1932 .Bl -tag -width indent
1933 .It Cm mac:add Ar address
1934 Add the specified MAC address to the database.
1935 Depending on the policy setting association requests from the
1936 specified station will be allowed or denied.
1938 Set the ACL policy to permit association only by
1939 stations registered in the database.
1940 .It Cm mac:del Ar address
1941 Delete the specified MAC address from the database.
1943 Set the ACL policy to deny association only by
1944 stations registered in the database.
1945 .It Cm mac:kick Ar address
1946 Force the specified station to be deauthenticated.
1947 This typically is done to block a station after updating the
1950 Set the ACL policy to allow all stations to associate.
1952 Delete all entries in the database.
1954 Set the ACL policy to permit association only by
1955 stations approved by a RADIUS server.
1956 Note that this feature requires the
1958 program be configured to do the right thing
1959 as it handles the RADIUS processing
1960 (and marks stations as authorized).
1963 The following parameters are related to a wireless interface operating in mesh
1965 .Bl -tag -width indent
1966 .It Cm meshid Ar meshid
1967 Set the desired Mesh Identifier.
1968 The Mesh ID is a string up to 32 characters in length.
1969 A mesh interface must have a Mesh Identifier specified
1970 to reach an operational state.
1971 .It Cm meshttl Ar ttl
1972 Set the desired ``time to live'' for mesh forwarded packets;
1973 this is the number of hops a packet may be forwarded before
1975 The default setting for
1979 Enable or disable peering with neighbor mesh stations.
1980 Stations must peer before any data packets can be exchanged.
1985 Enable or disable forwarding packets by a mesh interface.
1989 .It Cm meshmetric Ar protocol
1992 as the link metric protocol used on a mesh network.
1993 The default protocol is called
1995 The mesh interface will restart after changing this setting.
1996 .It Cm meshpath Ar protocol
1999 as the path selection protocol used on a mesh network.
2000 The only available protocol at the moment is called
2002 (Hybrid Wireless Mesh Protocol).
2003 The mesh interface will restart after changing this setting.
2004 .It Cm hwmprootmode Ar mode
2005 Stations on a mesh network can operate as ``root nodes.''
2006 Root nodes try to find paths to all mesh nodes and advertise themselves
2008 When there is a root mesh node on a network, other mesh nodes can setup
2009 paths between themselves faster because they can use the root node
2010 to find the destination.
2011 This path may not be the best, but on-demand
2012 routing will eventually find the best path.
2013 The following modes are recognized:
2015 .Bl -tag -width ".Cm PROACTIVE" -compact
2019 Send broadcast path requests every two seconds.
2020 Nodes on the mesh without a path to this root mesh station with try to
2021 discover a path to us.
2023 Send broadcast path requests every two seconds and every node must reply with
2024 with a path reply even if it already has a path to this root mesh station.
2026 Send broadcast root announcement (RANN) frames.
2027 Nodes on the mesh without a path to this root mesh station with try to
2028 discover a path to us.
2034 .It Cm hwmpmaxhops Ar cnt
2035 Set the maximum number of hops allowed in an HMWP path to
2037 The default setting for
2042 The following parameters are for compatibility with other systems:
2043 .Bl -tag -width indent
2045 Another name for the
2051 .It Cm stationname Ar name
2052 Set the name of this station.
2053 The station name is not part of the IEEE 802.11
2054 protocol though some interfaces support it.
2056 seems to be meaningful to identical or virtually identical equipment.
2057 Setting the station name is identical in syntax to setting the SSID.
2064 Another way of saying
2070 Another way of saying
2076 Another way of saying:
2077 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
2083 .Ar n : k1 , k2 , k3 , k4
2086 Another way of saying
2087 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
2092 Another way of saying
2099 The following parameters are specific to bridge interfaces:
2100 .Bl -tag -width indent
2101 .It Cm addm Ar interface
2102 Add the interface named by
2104 as a member of the bridge.
2105 The interface is put into promiscuous mode
2106 so that it can receive every packet sent on the network.
2107 .It Cm deletem Ar interface
2108 Remove the interface named by
2111 Promiscuous mode is disabled on the interface when
2112 it is removed from the bridge.
2113 .It Cm maxaddr Ar size
2114 Set the size of the bridge address cache to
2116 The default is 2000 entries.
2117 .It Cm timeout Ar seconds
2118 Set the timeout of address cache entries to
2123 is zero, then address cache entries will not be expired.
2124 The default is 1200 seconds.
2126 Display the addresses that have been learned by the bridge.
2127 .It Cm static Ar interface-name Ar address
2128 Add a static entry into the address cache pointing to
2129 .Ar interface-name .
2130 Static entries are never aged out of the cache or re-placed, even if the
2131 address is seen on a different interface.
2132 .It Cm deladdr Ar address
2135 from the address cache.
2137 Delete all dynamically-learned addresses from the address cache.
2139 Delete all addresses, including static addresses, from the address cache.
2140 .It Cm discover Ar interface
2141 Mark an interface as a
2144 When the bridge has no address cache entry
2145 (either dynamic or static)
2146 for the destination address of a packet,
2147 the bridge will forward the packet to all
2148 member interfaces marked as
2150 This is the default for all interfaces added to a bridge.
2151 .It Cm -discover Ar interface
2154 attribute on a member interface.
2155 For packets without the
2157 attribute, the only packets forwarded on the interface are broadcast
2158 or multicast packets and packets for which the destination address
2159 is known to be on the interface's segment.
2160 .It Cm learn Ar interface
2161 Mark an interface as a
2164 When a packet arrives on such an interface, the source
2165 address of the packet is entered into the address cache as being a
2166 destination address on the interface's segment.
2167 This is the default for all interfaces added to a bridge.
2168 .It Cm -learn Ar interface
2171 attribute on a member interface.
2172 .It Cm sticky Ar interface
2173 Mark an interface as a
2176 Dynamically learned address entries are treated at static once entered into
2178 Sticky entries are never aged out of the cache or replaced, even if the
2179 address is seen on a different interface.
2180 .It Cm -sticky Ar interface
2183 attribute on a member interface.
2184 .It Cm private Ar interface
2185 Mark an interface as a
2188 A private interface does not forward any traffic to any other port that is also
2189 a private interface.
2190 .It Cm -private Ar interface
2193 attribute on a member interface.
2194 .It Cm span Ar interface
2195 Add the interface named by
2197 as a span port on the bridge.
2198 Span ports transmit a copy of every frame received by the bridge.
2199 This is most useful for snooping a bridged network passively on
2200 another host connected to one of the span ports of the bridge.
2201 .It Cm -span Ar interface
2202 Delete the interface named by
2204 from the list of span ports of the bridge.
2205 .It Cm stp Ar interface
2206 Enable Spanning Tree protocol on
2210 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
2211 Spanning Tree is used to detect and remove loops in a network topology.
2212 .It Cm -stp Ar interface
2213 Disable Spanning Tree protocol on
2215 This is the default for all interfaces added to a bridge.
2216 .It Cm edge Ar interface
2220 An edge port connects directly to end stations cannot create bridging
2221 loops in the network, this allows it to transition straight to forwarding.
2222 .It Cm -edge Ar interface
2223 Disable edge status on
2225 .It Cm autoedge Ar interface
2228 to automatically detect edge status.
2229 This is the default for all interfaces added to a bridge.
2230 .It Cm -autoedge Ar interface
2231 Disable automatic edge status on
2233 .It Cm ptp Ar interface
2236 as a point to point link.
2237 This is required for straight transitions to forwarding and
2238 should be enabled on a direct link to another RSTP capable switch.
2239 .It Cm -ptp Ar interface
2240 Disable point to point link status on
2242 This should be disabled for a half duplex link and for an interface
2243 connected to a shared network segment,
2244 like a hub or a wireless network.
2245 .It Cm autoptp Ar interface
2246 Automatically detect the point to point status on
2248 by checking the full duplex link status.
2249 This is the default for interfaces added to the bridge.
2250 .It Cm -autoptp Ar interface
2251 Disable automatic point to point link detection on
2253 .It Cm maxage Ar seconds
2254 Set the time that a Spanning Tree protocol configuration is valid.
2255 The default is 20 seconds.
2256 The minimum is 6 seconds and the maximum is 40 seconds.
2257 .It Cm fwddelay Ar seconds
2258 Set the time that must pass before an interface begins forwarding
2259 packets when Spanning Tree is enabled.
2260 The default is 15 seconds.
2261 The minimum is 4 seconds and the maximum is 30 seconds.
2262 .It Cm hellotime Ar seconds
2263 Set the time between broadcasting of Spanning Tree protocol
2264 configuration messages.
2265 The hello time may only be changed when operating in legacy stp mode.
2266 The default is 2 seconds.
2267 The minimum is 1 second and the maximum is 2 seconds.
2268 .It Cm priority Ar value
2269 Set the bridge priority for Spanning Tree.
2270 The default is 32768.
2271 The minimum is 0 and the maximum is 61440.
2272 .It Cm proto Ar value
2273 Set the Spanning Tree protocol.
2274 The default is rstp.
2275 The available options are stp and rstp.
2276 .It Cm holdcnt Ar value
2277 Set the transmit hold count for Spanning Tree.
2278 This is the number of packets transmitted before being rate limited.
2280 The minimum is 1 and the maximum is 10.
2281 .It Cm ifpriority Ar interface Ar value
2282 Set the Spanning Tree priority of
2287 The minimum is 0 and the maximum is 240.
2288 .It Cm ifpathcost Ar interface Ar value
2289 Set the Spanning Tree path cost of
2293 The default is calculated from the link speed.
2294 To change a previously selected path cost back to automatic, set the
2296 The minimum is 1 and the maximum is 200000000.
2297 .It Cm ifmaxaddr Ar interface Ar size
2298 Set the maximum number of hosts allowed from an interface, packets with unknown
2299 source addresses are dropped until an existing host cache entry expires or is
2301 Set to 0 to disable.
2304 The following parameters are specific to lagg interfaces:
2305 .Bl -tag -width indent
2306 .It Cm laggport Ar interface
2307 Add the interface named by
2309 as a port of the aggregation interface.
2310 .It Cm -laggport Ar interface
2311 Remove the interface named by
2313 from the aggregation interface.
2314 .It Cm laggproto Ar proto
2315 Set the aggregation protocol.
2316 The default is failover.
2317 The available options are failover, fec, lacp, loadbalance, roundrobin and
2319 .It Cm lagghash Ar option Ns Oo , Ns Ar option Oc
2320 Set the packet layers to hash for aggregation protocols which load balance.
2323 The options can be combined using commas.
2325 .Bl -tag -width ".Cm l2" -compact
2327 src/dst mac address and optional vlan number.
2329 src/dst address for IPv4 or IPv6.
2331 src/dst port for TCP/UDP/SCTP.
2336 The following parameters are specific to IP tunnel interfaces,
2338 .Bl -tag -width indent
2339 .It Cm tunnel Ar src_addr dest_addr
2340 Configure the physical source and destination address for IP tunnel
2346 are interpreted as the outer source/destination for the encapsulating
2349 Unconfigure the physical source and destination address for IP tunnel
2350 interfaces previously configured with
2353 Another name for the
2356 .It Cm accept_rev_ethip_ver
2357 Set a flag to accept both correct EtherIP packets and ones
2358 with reversed version field. Enabled by default.
2359 This is for backward compatibility with
2361 6.2, 6.3, 7.0, and 7.1.
2362 .It Cm -accept_rev_ethip_ver
2364 .Cm accept_rev_ethip_ver .
2365 .It Cm send_rev_ethip_ver
2366 Set a flag to send EtherIP packets with reversed version
2367 field intentionally. Disabled by default.
2368 This is for backward compatibility with
2370 6.2, 6.3, 7.0, and 7.1.
2371 .It Cm -send_rev_ethip_ver
2373 .Cm send_rev_ethip_ver .
2376 The following parameters are specific to GRE tunnel interfaces,
2378 .Bl -tag -width indent
2379 .It Cm grekey Ar key
2380 Configure the GRE key to be used for outgoing packets.
2382 .Xr gre 4 will always accept GRE packets with invalid or absent keys.
2383 This command will result in a four byte MTU reduction on the interface.
2386 The following parameters are specific to
2389 .Bl -tag -width indent
2391 Set the maximum number of updates for a single state which
2392 can be collapsed into one.
2393 This is an 8-bit number; the default value is 128.
2396 The following parameters are specific to
2399 .Bl -tag -width indent
2400 .It Cm vlan Ar vlan_tag
2401 Set the VLAN tag value to
2403 This value is a 16-bit number which is used to create an 802.1Q
2404 VLAN header for packets sent from the
2411 must both be set at the same time.
2412 .It Cm vlandev Ar iface
2413 Associate the physical interface
2418 Packets transmitted through the
2421 diverted to the specified physical interface
2423 with 802.1Q VLAN encapsulation.
2424 Packets with 802.1Q encapsulation received
2425 by the parent interface with the correct VLAN tag will be diverted to
2431 interface is assigned a
2432 copy of the parent interface's flags and the parent's ethernet address.
2437 must both be set at the same time.
2440 interface already has
2441 a physical interface associated with it, this command will fail.
2443 change the association to another physical interface, the existing
2444 association must be cleared first.
2446 Note: if the hardware tagging capability
2447 is set on the parent interface, the
2450 interface's behavior changes:
2453 interface recognizes that the
2454 parent interface supports insertion and extraction of VLAN tags on its
2455 own (usually in firmware) and that it should pass packets to and from
2456 the parent unaltered.
2457 .It Fl vlandev Op Ar iface
2460 pseudo device, disassociate the parent interface from it.
2461 This breaks the link between the
2463 interface and its parent,
2464 clears its VLAN tag, flags and its link address and shuts the interface down.
2467 argument is useless and hence deprecated.
2470 The following parameters are specific to
2473 .Bl -tag -width indent
2474 .It Cm advbase Ar seconds
2475 Specifies the base of the advertisement interval in seconds.
2476 The acceptable values are 1 to 255.
2477 The default value is 1.
2478 .\" The default value is
2479 .\" .Dv CARP_DFLTINTV .
2480 .It Cm advskew Ar interval
2481 Specifies the skew to add to the base advertisement interval to
2482 make one host advertise slower than another host.
2483 It is specified in 1/256 of seconds.
2484 The acceptable values are 1 to 254.
2485 The default value is 0.
2486 .It Cm pass Ar phrase
2487 Set the authentication key to
2490 Set the virtual host ID.
2491 This is a required setting.
2492 Acceptable values are 1 to 255.
2493 .It Cm state Ar state
2494 Force the interface into state
2496 Valid states are INIT, BACKUP, and MASTER. Note that manually setting the state
2497 to INIT is ignored by
2499 This state is set automatically when the underlying interface is down.
2504 utility displays the current configuration for a network interface
2505 when no optional parameters are supplied.
2506 If a protocol family is specified,
2508 will report only the details specific to that protocol family.
2512 flag is passed before an interface name,
2514 will display the capability list and all
2515 of the supported media for the specified interface.
2518 flag is supplied, address lifetime is displayed for IPv6 addresses,
2519 as time offset string.
2523 flag may be used instead of an interface name.
2526 to display information about all interfaces in the system.
2529 flag limits this to interfaces that are down, and
2531 limits this to interfaces that are up.
2532 When no arguments are given,
2538 flag may be used to list all available interfaces on the system, with
2539 no other additional information.
2540 Use of this flag is mutually exclusive
2541 with all other flags and commands, except for
2543 (only list interfaces that are down)
2546 (only list interfaces that are up).
2550 flag may be used to get more verbose status for an interface.
2554 flag may be used to list all of the interface cloners available on
2555 the system, with no additional information.
2556 Use of this flag is mutually exclusive with all other flags and commands.
2560 flag causes keying information for the interface, if available, to be
2562 For example, the values of 802.11 WEP keys will be printed, if accessible to
2564 This information is not printed by default, as it may be considered
2567 If the network interface driver is not present in the kernel then
2569 will attempt to load it.
2572 flag disables this behavior.
2574 Only the super-user may modify the configuration of a network interface.
2576 Assign the IPv4 address
2578 with a network mask of
2582 .Dl # ifconfig fxp0 inet 192.0.2.10 netmask 255.255.255.0
2584 Add the IPv4 address
2586 with the CIDR network prefix
2592 as a synonym for the canonical form of the option
2594 .Dl # ifconfig ed0 inet 192.0.2.45/28 add
2596 Remove the IPv4 address
2600 .Dl # ifconfig ed0 inet 192.0.2.45 -alias
2602 Enable IPv6 functionality of the interface:
2603 .Dl # ifconfig em0 inet6 -ifdisabled
2605 Add the IPv6 address
2606 .Li 2001:DB8:DBDB::123/48
2609 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias
2610 Note that lower case hexadecimal IPv6 addresses are acceptable.
2612 Remove the IPv6 address added in the above example,
2615 character as shorthand for the network prefix,
2618 as a synonym for the canonical form of the option
2620 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 delete
2622 Configure the interface
2624 to use 100baseTX, full duplex Ethernet media options:
2625 .Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex
2627 Label the em0 interface as an uplink:
2628 .Dl # ifconfig em0 description \&"Uplink to Gigabit Switch 2\&"
2630 Create the software network interface
2632 .Dl # ifconfig gif1 create
2634 Destroy the software network interface
2636 .Dl # ifconfig gif1 destroy
2638 Display available wireless networks using
2640 .Dl # ifconfig wlan0 list scan
2642 Messages indicating the specified interface does not exist, the
2643 requested address is unknown, or the user is not privileged and
2644 tried to alter an interface's configuration.
2666 Basic IPv6 node operation requires a link-local address on each
2667 interface configured for IPv6.
2668 Normally, such an address is automatically configured by the
2669 kernel on each interface added to the system or enabled; this behavior may
2670 be disabled by setting per-interface flag
2671 .Cm -auto_linklocal .
2672 The default value of this flag is 1 and can be disabled by using the sysctl
2674 .Va net.inet6.ip6.auto_linklocal .
2676 Do not configure IPv6 addresses with no link-local address by using
2678 It can result in unexpected behaviors of the kernel.
projects / FreeBSD / releng / 9.2.git / blob