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
31 .Dd September 13, 2011
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
376 If the driver supports user-configurable checksum offloading,
377 enable receive (or transmit) checksum offloading on the interface.
378 Some drivers may not be able to enable these flags independently
379 of each other, so setting one may also set the other.
380 The driver will offload as much checksum work as it can reliably
381 support, the exact level of offloading varies between drivers.
382 .It Fl rxcsum , txcsum
383 If the driver supports user-configurable checksum offloading,
384 disable receive (or transmit) checksum offloading on the interface.
385 These settings may not always be independent of each other.
387 If the driver supports
389 segmentation offloading, enable TSO on the interface.
390 Some drivers may not be able to support TSO for
394 packets, so they may enable only one of them.
396 If the driver supports
398 segmentation offloading, disable TSO on the interface.
399 It will always disable TSO for
404 If the driver supports
406 large receive offloading, enable LRO on the interface.
408 If the driver supports
410 large receive offloading, disable LRO on the interface.
411 .It Cm wol , wol_ucast , wol_mcast , wol_magic
412 Enable Wake On Lan (WOL) support, if available.
413 WOL is a facility whereby a machine in a low power state may be woken
414 in response to a received packet.
415 There are three types of packets that may wake a system:
416 ucast (directed solely to the machine's mac address),
417 mcast (directed to a broadcast or multicast address),
419 magic (unicast or multicast frames with a ``magic contents'').
420 Not all devices support WOL, those that do indicate the mechanisms
421 they support in their capabilities.
423 is a synonym for enabling all available WOL mechanisms.
426 .It Cm vlanmtu , vlanhwtag, vlanhwfilter, vlanhwtso
427 If the driver offers user-configurable VLAN support, enable
428 reception of extended frames, tag processing in hardware,
429 frame filtering in hardware, or TSO on VLAN,
431 Note that this must be issued on a physical interface associated with
436 .It Fl vlanmtu , vlanhwtag, vlanhwfilter, vlanhwtso
437 If the driver offers user-configurable VLAN support, disable
438 reception of extended frames, tag processing in hardware,
439 frame filtering in hardware, or TSO on VLAN,
442 Move the interface to the
444 specified by name or JID.
445 If the jail has a virtual network stack, the interface will disappear
446 from the current environment and become visible to the jail.
448 Reclaim the interface from the
450 specified by name or JID.
451 If the jail has a virtual network stack, the interface will disappear
452 from the jail, and become visible to the current network environment.
456 feature and disable interrupts on the interface, if driver supports
461 feature and enable interrupt mode on the interface.
463 Create the specified network pseudo-device.
464 If the interface is given without a unit number, try to create a new
465 device with an arbitrary unit number.
466 If creation of an arbitrary device is successful, the new device name is
467 printed to standard output unless the interface is renamed or destroyed
472 Destroy the specified network pseudo-device.
488 Set the routing metric of the interface to
491 The routing metric is used by the routing protocol
493 Higher metrics have the effect of making a route
494 less favorable; metrics are counted as additional hops
495 to the destination network or host.
497 Set the maximum transmission unit of the interface to
499 default is interface specific.
500 The MTU is used to limit the size of packets that are transmitted on an
502 Not all interfaces support setting the MTU, and some interfaces have
504 .It Cm netmask Ar mask
507 Specify how much of the address to reserve for subdividing
508 networks into sub-networks.
509 The mask includes the network part of the local address
510 and the subnet part, which is taken from the host field of the address.
511 The mask can be specified as a single hexadecimal number
514 with a dot-notation Internet address,
515 or with a pseudo-network name listed in the network table
517 The mask contains 1's for the bit positions in the 32-bit address
518 which are to be used for the network and subnet parts,
519 and 0's for the host part.
520 The mask should contain at least the standard network portion,
521 and the subnet field should be contiguous with the network
524 The netmask can also be specified in CIDR notation after the address.
527 option above for more information.
528 .It Cm prefixlen Ar len
532 bits are reserved for subdividing networks into sub-networks.
535 must be integer, and for syntactical reason it must be between 0 to 128.
536 It is almost always 64 under the current IPv6 assignment rule.
537 If the parameter is omitted, 64 is used.
539 The prefix can also be specified using the slash notation after the address.
542 option above for more information.
545 .\" .It Cm nsellength Ar n
548 .\" This specifies a trailing number of bytes for a received
550 .\" used for local identification, the remaining leading part of which is
553 .\" (Network Entity Title).
554 .\" The default value is 1, which is conformant to US
556 .\" When an ISO address is set in an ifconfig command,
559 .\" which is being specified.
562 .\" 20 hex digits should be
565 .\" to be assigned to the interface.
566 .\" There is some evidence that a number different from 1 may be useful
569 .\" 37 type addresses.
570 .It Cm range Ar netrange
571 Under appletalk, set the interface to respond to a
574 .Ar startnet Ns - Ns Ar endnet .
575 Appletalk uses this scheme instead of
578 implements it internally as a set of netmasks.
583 Introduced for compatibility
587 The argument following this specifies the version (phase) of the
588 Appletalk network attached to the interface.
589 Values of 1 or 2 are permitted.
591 .It Cm link Op Cm 0 No - Cm 2
593 Enable special processing of the link level of the interface.
594 These three options are interface specific in actual effect, however,
595 they are in general used to select special modes of operation.
597 of this is to enable SLIP compression, or to select the connector type
598 for some Ethernet cards.
599 Refer to the man page for the specific driver
600 for more information.
602 .It Fl link Op Cm 0 No - Cm 2
604 Disable special processing at the link level with the specified interface.
606 Put the interface in monitor mode.
607 No packets are transmitted, and received packets are discarded after
611 Take the interface out of monitor mode.
615 This may be used to enable an interface after an
617 It happens automatically when setting the first address on an interface.
618 If the interface was reset when previously marked down,
619 the hardware will be re-initialized.
622 The following parameters are for ICMPv6 Neighbor Discovery Protocol.
623 Note that the address family keyword
626 .Bl -tag -width indent
628 Set a flag to enable accepting ICMPv6 Router Advertisement messages.
632 .Va net.inet6.ip6.accept_rtadv
633 controls whether this flag is set by default or not.
638 Set a flag to control whether routers from which the system accepts
639 Router Advertisement messages will be added to the Default Router List
643 flag is disabled, this flag has no effect.
647 .Va net.inet6.ip6.no_radr
648 controls whether this flag is set by default or not.
652 .It Cm auto_linklocal
653 Set a flag to perform automatic link-local address configuration when
654 the interface becomes available.
658 .Va net.inet6.ip6.auto_linklocal
659 controls whether this flag is set by default or not.
660 .It Cm -auto_linklocal
664 Set the specified interface as the default route when there is no
670 Set a flag to disable all of IPv6 network communications on the
671 specified interface. Note that if there are already configured IPv6
672 addresses on that interface, all of them are marked as
674 and DAD will be performed when this flag is cleared.
678 When this flag is cleared and
680 flag is enabled, automatic configuration of a link-local address is
683 Set a flag to enable Neighbor Unreachability Detection.
688 Set a flag to prefer addresses on the interface as candidates of the
689 source address for outgoing packets.
690 .It Cm -prefer_source
695 The following parameters are specific to cloning
696 IEEE 802.11 wireless interfaces with the
699 .Bl -tag -width indent
700 .It Cm wlandev Ar device
703 as the parent for the cloned device.
704 .It Cm wlanmode Ar mode
705 Specify the operating mode for this cloned device.
723 The operating mode of a cloned interface cannot be changed.
726 mode is actually implemented as an
728 interface with special properties.
729 .It Cm wlanbssid Ar bssid
730 The 802.11 mac address to use for the bssid.
731 This must be specified at create time for a legacy
734 .It Cm wlanaddr Ar address
735 The local mac address.
736 If this is not specified then a mac address will automatically be assigned
737 to the cloned device.
738 Typically this address is the same as the address of the parent device
741 parameter is specified then the driver will craft a unique address for
742 the device (if supported).
746 device as operating in ``legacy mode''.
749 devices have a fixed peer relationship and do not, for example, roam
750 if their peer stops communicating.
751 For completeness a Dynamic WDS (DWDS) interface may marked as
754 Request a unique local mac address for the cloned device.
755 This is only possible if the device supports multiple mac addresses.
756 To force use of the parent's mac address use
759 Mark the cloned interface as depending on hardware support to
760 track received beacons.
761 To have beacons tracked in software use
767 can also be used to indicate no beacons should
768 be transmitted; this can be useful when creating a WDS configuration but
770 interfaces can only be created as companions to an access point.
773 The following parameters are specific to IEEE 802.11 wireless interfaces
777 .Bl -tag -width indent
779 Enable sending and receiving AMPDU frames when using 802.11n (default).
780 The 802.11n specification states a compliant station must be capable
781 of receiving AMPDU frames but transmission is optional.
784 to disable all use of AMPDU with 802.11n.
785 For testing and/or to work around interoperability problems one can use
789 to control use of AMPDU in one direction.
790 .It Cm ampdudensity Ar density
791 Set the AMPDU density parameter used when operating with 802.11n.
792 This parameter controls the inter-packet gap for AMPDU frames.
793 The sending device normally controls this setting but a receiving station
794 may request wider gaps.
797 are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds).
800 is treated the same as 0.
801 .It Cm ampdulimit Ar limit
802 Set the limit on packet size for receiving AMPDU frames when operating
806 are 8192, 16384, 32768, and 65536 but one can also specify
807 just the unique prefix: 8, 16, 32, 64.
808 Note the sender may limit the size of AMPDU frames to be less
809 than the maximum specified by the receiving station.
811 Enable sending and receiving AMSDU frames when using 802.11n.
812 By default AMSDU is received but not transmitted.
815 to disable all use of AMSDU with 802.11n.
816 For testing and/or to work around interoperability problems one can use
820 to control use of AMSDU in one direction.
821 .It Cm amsdulimit Ar limit
822 Set the limit on packet size for sending and receiving AMSDU frames
823 when operating with 802.11n.
826 are 7935 and 3839 (bytes).
827 Note the sender may limit the size of AMSDU frames to be less
828 than the maximum specified by the receiving station.
829 Note also that devices are not required to support the 7935 limit,
830 only 3839 is required by the specification and the larger value
831 may require more memory to be dedicated to support functionality
834 When operating as an access point, pass packets between
835 wireless clients directly (default).
836 To instead let them pass up through the
837 system and be forwarded using some other mechanism, use
839 Disabling the internal bridging
840 is useful when traffic is to be processed with
842 .It Cm authmode Ar mode
843 Set the desired authentication mode in infrastructure mode.
844 Not all adapters support all modes.
847 .Cm none , open , shared
853 (IEEE WPA/WPA2/802.11i).
858 modes are only useful when using an authentication service
859 (a supplicant for client operation or an authenticator when
860 operating as an access point).
861 Modes are case insensitive.
863 Enable background scanning when operating as a station.
864 Background scanning is a technique whereby a station associated to
865 an access point will temporarily leave the channel to scan for
866 neighboring stations.
867 This allows a station to maintain a cache of nearby access points
868 so that roaming between access points can be done without
869 a lengthy scan operation.
870 Background scanning is done only when a station is not busy and
871 any outbound traffic will cancel a scan operation.
872 Background scanning should never cause packets to be lost though
873 there may be some small latency if outbound traffic interrupts a
875 By default background scanning is enabled if the device is capable.
876 To disable background scanning, use
878 Background scanning is controlled by the
883 Background scanning must be enabled for roaming; this is an artifact
884 of the current implementation and may not be required in the future.
885 .It Cm bgscanidle Ar idletime
886 Set the minimum time a station must be idle (not transmitting or
887 receiving frames) before a background scan is initiated.
890 parameter is specified in milliseconds.
891 By default a station must be idle at least 250 milliseconds before
892 a background scan is initiated.
893 The idle time may not be set to less than 100 milliseconds.
894 .It Cm bgscanintvl Ar interval
895 Set the interval at which background scanning is attempted.
898 parameter is specified in seconds.
899 By default a background scan is considered every 300 seconds (5 minutes).
902 may not be set to less than 15 seconds.
903 .It Cm bintval Ar interval
904 Set the interval at which beacon frames are sent when operating in
908 parameter is specified in TU's (1024 usecs).
909 By default beacon frames are transmitted every 100 TU's.
910 .It Cm bmissthreshold Ar count
911 Set the number of consecutive missed beacons at which the station
912 will attempt to roam (i.e., search for a new access point).
915 parameter must be in the range 1 to 255; though the
916 upper bound may be reduced according to device capabilities.
917 The default threshold is 7 consecutive missed beacons; but
918 this may be overridden by the device driver.
923 .It Cm bssid Ar address
924 Specify the MAC address of the access point to use when operating
925 as a station in a BSS network.
926 This overrides any automatic selection done by the system.
927 To disable a previously selected access point, supply
932 This option is useful when more than one access point uses the same SSID.
938 Enable packet bursting.
939 Packet bursting is a transmission technique whereby the wireless
940 medium is acquired once to send multiple frames and the interframe
942 This technique can significantly increase throughput by reducing
943 transmission overhead.
944 Packet bursting is supported by the 802.11e QoS specification
945 and some devices that do not support QoS may still be capable.
946 By default packet bursting is enabled if a device is capable
948 To disable packet bursting, use
950 .It Cm chanlist Ar channels
951 Set the desired channels to use when scanning for access
952 points, neighbors in an IBSS network, or looking for unoccupied
953 channels when operating as an access point.
954 The set of channels is specified as a comma-separated list with
955 each element in the list representing either a single channel number or a range
958 Channel numbers must be in the range 1 to 255 and be permissible
959 according to the operating characteristics of the device.
960 .It Cm channel Ar number
961 Set a single desired channel.
962 Channels range from 1 to 255, but the exact selection available
963 depends on the region your adaptor was manufactured for.
969 will clear any desired channel and, if the device is marked up,
970 force a scan for a channel to operate on.
971 Alternatively the frequency, in megahertz, may be specified
972 instead of the channel number.
974 When there are several ways to use a channel the channel
975 number/frequency may be appended with attributes to clarify.
976 For example, if a device is capable of operating on channel 6
977 with 802.11n and 802.11g then one can specify that g-only use
978 should be used by specifying ``6:g''.
979 Similarly the channel width can be specified by appending it
980 with ``/''; e.g. ``6/40'' specifies a 40MHz wide channel,
981 These attributes can be combined as in: ``6:ht/40''.
982 The full set of flags specified following a ``:'' are:
988 (Atheros Dynamic Turbo mode),
996 (Atheros Static Turbo mode),
999 (Atheros Dynamic Turbo mode, or appended to ``st'' and ``dt'').
1000 The full set of channel widths following a '/' are:
1002 (5MHz aka quarter-rate channel),
1004 (10MHz aka half-rate channel),
1006 (20MHz mostly for use in specifying ht20),
1009 (40MHz mostly for use in specifying ht40).
1011 a 40MHz HT channel specification may include the location
1012 of the extension channel by appending ``+'' or ``-'' for above and below,
1013 respectively; e.g. ``2437:ht/40+'' specifies 40MHz wide HT operation
1014 with the center channel at frequency 2437 and the extension channel above.
1015 .It Cm country Ar name
1016 Set the country code to use in calculating the regulatory constraints
1018 In particular the set of available channels, how the wireless device
1019 will operation on the channels, and the maximum transmit power that
1020 can be used on a channel are defined by this setting.
1021 Country/Region codes are specified as a 2-character abbreviation
1022 defined by ISO 3166 or using a longer, but possibly ambiguous, spelling;
1023 e.g. "ES" and "Spain".
1024 The set of country codes are taken from /etc/regdomain.xml and can also
1025 be viewed with the ``list countries'' request.
1026 Note that not all devices support changing the country code from a default
1027 setting; typically stored in EEPROM.
1035 Enable Dynamic Frequency Selection (DFS) as specified in 802.11h.
1036 DFS embodies several facilities including detection of overlapping
1037 radar signals, dynamic transmit power control, and channel selection
1038 according to a least-congested criteria.
1039 DFS support is mandatory for some 5Ghz frequencies in certain
1040 locales (e.g. ETSI).
1041 By default DFS is enabled according to the regulatory definitions
1042 specified in /etc/regdomain.xml and the current country code, regdomain,
1044 Note the underlying device (and driver) must support radar detection
1045 for full DFS support to work.
1046 To be fully compliant with the local regulatory agency frequencies that
1047 require DFS should not be used unless it is fully supported.
1050 to disable this functionality for testing.
1052 Enable support for the 802.11d specification (default).
1053 When this support is enabled in station mode, beacon frames that advertise
1054 a country code different than the currently configured country code will
1055 cause an event to be dispatched to user applications.
1056 This event can be used by the station to adopt that country code and
1057 operate according to the associated regulatory constraints.
1058 When operating as an access point with 802.11d enabled the beacon and
1059 probe response frames transmitted will advertise the current regulatory
1061 To disable 802.11d use
1064 Enable 802.11h support including spectrum management.
1065 When 802.11h is enabled beacon and probe response frames will have
1066 the SpectrumMgt bit set in the capabilities field and
1067 country and power constraint information elements will be present.
1068 802.11h support also includes handling Channel Switch Announcements (CSA)
1069 which are a mechanism to coordinate channel changes by an access point.
1070 By default 802.11h is enabled if the device is capable.
1071 To disable 802.11h use
1073 .It Cm deftxkey Ar index
1074 Set the default key to use for transmission.
1075 Typically this is only set when using WEP encryption.
1076 Note that you must set a default transmit key
1077 for the system to know which key to use in encrypting outbound traffic.
1080 is an alias for this request; it is provided for backwards compatibility.
1081 .It Cm dtimperiod Ar period
1084 period for transmitting buffered multicast data frames when
1085 operating in ap mode.
1088 specifies the number of beacon intervals between DTIM
1089 and must be in the range 1 to 15.
1090 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
1092 Enable the use of Atheros Dynamic Turbo mode when communicating with
1093 another Dynamic Turbo-capable station.
1094 Dynamic Turbo mode is an Atheros-specific mechanism by which
1095 stations switch between normal 802.11 operation and a ``boosted''
1096 mode in which a 40MHz wide channel is used for communication.
1097 Stations using Dynamic Turbo mode operate boosted only when the
1098 channel is free of non-dturbo stations; when a non-dturbo station
1099 is identified on the channel all stations will automatically drop
1100 back to normal operation.
1101 By default, Dynamic Turbo mode is not enabled, even if the device is capable.
1102 Note that turbo mode (dynamic or static) is only allowed on some
1103 channels depending on the regulatory constraints; use the
1105 command to identify the channels where turbo mode may be used.
1106 To disable Dynamic Turbo mode use
1109 Enable Dynamic WDS (DWDS) support.
1110 DWDS is a facility by which 4-address traffic can be carried between
1111 stations operating in infrastructure mode.
1112 A station first associates to an access point and authenticates using
1113 normal procedures (e.g. WPA).
1114 Then 4-address frames are passed to carry traffic for stations
1115 operating on either side of the wireless link.
1116 DWDS extends the normal WDS mechanism by leveraging existing security
1117 protocols and eliminating static binding.
1119 When DWDS is enabled on an access point 4-address frames received from
1120 an authorized station will generate a ``DWDS discovery'' event to user
1122 This event should be used to create a WDS interface that is bound
1123 to the remote station (and usually plumbed into a bridge).
1124 Once the WDS interface is up and running 4-address traffic then logically
1125 flows through that interface.
1127 When DWDS is enabled on a station, traffic with a destination address
1128 different from the peer station are encapsulated in a 4-address frame
1129 and transmitted to the peer.
1130 All 4-address traffic uses the security information of the stations
1131 (e.g. cryptographic keys).
1132 A station is associated using 802.11n facilities may transport
1133 4-address traffic using these same mechanisms; this depends on available
1134 resources and capabilities of the device.
1135 The DWDS implementation guards against layer 2 routing loops of
1138 Enable the use of Atheros Fast Frames when communicating with
1139 another Fast Frames-capable station.
1140 Fast Frames are an encapsulation technique by which two 802.3
1141 frames are transmitted in a single 802.11 frame.
1142 This can noticeably improve throughput but requires that the
1143 receiving station understand how to decapsulate the frame.
1144 Fast frame use is negotiated using the Atheros 802.11 vendor-specific
1145 protocol extension so enabling use is safe when communicating with
1146 non-Atheros devices.
1147 By default, use of fast frames is enabled if the device is capable.
1148 To explicitly disable fast frames, use
1150 .It Cm fragthreshold Ar length
1151 Set the threshold for which transmitted frames are broken into fragments.
1154 argument is the frame size in bytes and must be in the range 256 to 2346.
1162 disables transmit fragmentation.
1163 Not all adapters honor the fragmentation threshold.
1165 When operating as an access point, do not broadcast the SSID
1166 in beacon frames or respond to probe request frames unless
1167 they are directed to the ap (i.e., they include the ap's SSID).
1168 By default, the SSID is included in beacon frames and
1169 undirected probe request frames are answered.
1170 To re-enable the broadcast of the SSID etc., use
1173 Enable use of High Throughput (HT) when using 802.11n (default).
1174 The 802.11n specification includes mechanisms for operation
1175 on 20MHz and 40MHz wide channels using different signalling mechanisms
1176 than specified in 802.11b, 802.11g, and 802.11a.
1177 Stations negotiate use of these facilities, termed HT20 and HT40,
1178 when they associate.
1179 To disable all use of 802.11n use
1181 To disable use of HT20 (e.g. to force only HT40 use) use
1183 To disable use of HT40 use
1186 HT configuration is used to ``auto promote'' operation
1187 when several choices are available.
1188 For example, if a station associates to an 11n-capable access point
1189 it controls whether the station uses legacy operation, HT20, or HT40.
1190 When an 11n-capable device is setup as an access point and
1191 Auto Channel Selection is used to locate a channel to operate on,
1192 HT configuration controls whether legacy, HT20, or HT40 operation is setup
1193 on the selected channel.
1194 If a fixed channel is specified for a station then HT configuration can
1195 be given as part of the channel specification; e.g. 6:ht/20 to setup
1196 HT20 operation on channel 6.
1198 Enable use of compatibility support for pre-802.11n devices (default).
1199 The 802.11n protocol specification went through several incompatible iterations.
1200 Some vendors implemented 11n support to older specifications that
1201 will not interoperate with a purely 11n-compliant station.
1202 In particular the information elements included in management frames
1203 for old devices are different.
1204 When compatibility support is enabled both standard and compatible data
1206 Stations that associate using the compatibility mechanisms are flagged
1208 To disable compatibility support use
1210 .It Cm htprotmode Ar technique
1211 For interfaces operating in 802.11n, use the specified
1213 for protecting HT frames in a mixed legacy/HT network.
1214 The set of valid techniques is
1219 Technique names are case insensitive.
1221 Enable inactivity processing for stations associated to an
1222 access point (default).
1223 When operating as an access point the 802.11 layer monitors
1224 the activity of each associated station.
1225 When a station is inactive for 5 minutes it will send several
1226 ``probe frames'' to see if the station is still present.
1227 If no response is received then the station is deauthenticated.
1228 Applications that prefer to handle this work can disable this
1232 Set the location to use in calculating regulatory constraints.
1233 The location is also advertised in beacon and probe response frames
1234 when 802.11d is enabled with
1243 Display the list of channels available for use taking into account
1244 any restrictions set with the
1247 See the description of
1249 for more information.
1251 Display the adaptor's capabilities, including the operating
1254 Display the list of channels available for use.
1255 Channels are shown with their IEEE channel number, equivalent
1256 frequency, and usage modes.
1257 Channels identified as
1262 Channels identified as
1264 may be used only for Atheros' Static Turbo mode
1266 . Cm mediaopt turbo ) .
1267 Channels marked with a
1269 have a regulatory constraint that they be passively scanned.
1270 This means a station is not permitted to transmit on the channel until
1271 it identifies the channel is being used for 802.11 communication;
1272 typically by hearing a beacon frame from an access point operating
1275 is another way of requesting this information.
1276 By default a compacted list of channels is displayed; if the
1278 option is specified then all channels are shown.
1279 .It Cm list countries
1280 Display the set of country codes and regulatory domains that can be
1281 used in regulatory configuration.
1283 Display the current MAC Access Control List state.
1284 Each address is prefixed with a character that indicates the
1285 current policy applied to it:
1287 indicates the address is allowed access,
1289 indicates the address is denied access,
1291 indicates the address is present but the current policy open
1292 (so the ACL is not consulted).
1294 Displays the mesh routing table, used for forwarding packets on a mesh
1296 .It Cm list regdomain
1297 Display the current regulatory settings including the available channels
1298 and transmit power caps.
1300 Display the parameters that govern roaming operation.
1302 Display the parameters that govern transmit operation.
1304 Display the transmit power caps for each channel.
1306 Display the access points and/or ad-hoc neighbors
1307 located in the vicinity.
1308 This information may be updated automatically by the adapter
1311 request or through background scanning.
1312 Depending on the capabilities of the stations the following
1313 flags can be included in the output:
1317 Indicates that the station is permitted to send/receive data frames.
1319 Extended Rate Phy (ERP).
1320 Indicates that the station is operating in an 802.11g network
1321 using extended transmit rates.
1323 High Throughput (HT).
1324 Indicates that the station is using HT transmit rates.
1325 If a `+' follows immediately after then the station associated
1326 using deprecated mechanisms supported only when
1331 Indicates that the station is operating in power save mode.
1333 Quality of Service (QoS).
1334 Indicates that the station is using QoS encapsulation for
1336 QoS encapsulation is enabled only when WME mode is enabled.
1339 Indicates that the station is doing short preamble to optionally
1340 improve throughput performance with 802.11g and 802.11b.
1342 Transitional Security Network (TSN).
1343 Indicates that the station associated using TSN; see also
1347 Wi-Fi Protected Setup (WPS).
1348 Indicates that the station associated using WPS.
1351 By default interesting information elements captured from the neighboring
1352 stations are displayed at the end of each row.
1353 Possible elements include:
1355 (station supports WME),
1357 (station supports WPA),
1359 (station supports WPS),
1361 (station supports 802.11i/RSN),
1363 (station supports 802.11n/HT communication),
1365 (station supports Atheros protocol extensions),
1367 (station supports unknown vendor-specific extensions).
1370 flag is used all the information elements and their
1371 contents will be shown.
1374 flag also enables display of long SSIDs.
1377 command is another way of requesting this information.
1379 When operating as an access point display the stations that are
1380 currently associated.
1381 When operating in ad-hoc mode display stations identified as
1382 neighbors in the IBSS.
1383 When operating in mesh mode display stations identified as
1384 neighbors in the MBSS.
1385 When operating in station mode display the access point.
1386 Capabilities advertised by the stations are described under
1390 Depending on the capabilities of the stations the following
1391 flags can be included in the output:
1395 Indicates that the station is permitted to send/receive data frames.
1397 Extended Rate Phy (ERP).
1398 Indicates that the station is operating in an 802.11g network
1399 using extended transmit rates.
1401 High Throughput (HT).
1402 Indicates that the station is using HT transmit rates.
1403 If a `+' follows immediately after then the station associated
1404 using deprecated mechanisms supported only when
1409 Indicates that the station is operating in power save mode.
1411 Quality of Service (QoS).
1412 Indicates that the station is using QoS encapsulation for
1414 QoS encapsulation is enabled only when WME mode is enabled.
1417 Indicates that the station is doing short preamble to optionally
1418 improve throughput performance with 802.11g and 802.11b.
1420 Transitional Security Network (TSN).
1421 Indicates that the station associated using TSN; see also
1425 Wi-Fi Protected Setup (WPS).
1426 Indicates that the station associated using WPS.
1429 By default information elements received from associated stations
1430 are displayed in a short form; the
1432 flag causes this information to be displayed symbolically.
1434 Display the current channel parameters to use when operating in WME mode.
1437 option is specified then both channel and BSS parameters are displayed
1438 for each AC (first channel, then BSS).
1439 When WME mode is enabled for an adaptor this information will be
1440 displayed with the regular status; this command is mostly useful
1441 for examining parameters when WME mode is disabled.
1442 See the description of the
1444 directive for information on the various parameters.
1445 .It Cm maxretry Ar count
1446 Set the maximum number of tries to use in sending unicast frames.
1447 The default setting is 6 but drivers may override this with a value
1449 .It Cm mcastrate Ar rate
1450 Set the rate for transmitting multicast/broadcast frames.
1451 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
1452 This rate should be valid for the current operating conditions;
1453 if an invalid rate is specified drivers are free to chose an
1455 .It Cm mgtrate Ar rate
1456 Set the rate for transmitting management and/or control frames.
1457 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
1459 Set the location to use in calculating regulatory constraints.
1460 The location is also advertised in beacon and probe response frames
1461 when 802.11d is enabled with
1470 Enable powersave operation.
1471 When operating as a client, the station will conserve power by
1472 periodically turning off the radio and listening for
1473 messages from the access point telling it there are packets waiting.
1474 The station must then retrieve the packets.
1475 Not all devices support power save operation as a client.
1476 The 802.11 specification requires that all access points support
1477 power save but some drivers do not.
1480 to disable powersave operation when operating as a client.
1481 .It Cm powersavesleep Ar sleep
1482 Set the desired max powersave sleep time in TU's (1024 usecs).
1483 By default the max powersave sleep time is 100 TU's.
1484 .It Cm protmode Ar technique
1485 For interfaces operating in 802.11g, use the specified
1487 for protecting OFDM frames in a mixed 11b/11g network.
1488 The set of valid techniques is
1494 Technique names are case insensitive.
1495 Not all devices support
1497 as a protection technique.
1499 When operating as an access point in 802.11g mode allow only
1500 11g-capable stations to associate (11b-only stations are not
1501 permitted to associate).
1502 To allow both 11g and 11b-only stations to associate, use
1505 When operating as an access point in 802.11n mode allow only
1506 HT-capable stations to associate (legacy stations are not
1507 permitted to associate).
1508 To allow both HT and legacy stations to associate, use
1510 .It Cm regdomain Ar sku
1511 Set the regulatory domain to use in calculating the regulatory constraints
1513 In particular the set of available channels, how the wireless device
1514 will operation on the channels, and the maximum transmit power that
1515 can be used on a channel are defined by this setting.
1516 Regdomain codes (SKU's) are taken from /etc/regdomain.xml and can also
1517 be viewed with the ``list countries'' request.
1518 Note that not all devices support changing the regdomain from a default
1519 setting; typically stored in EEPROM.
1527 Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n
1529 Note that RIFS must be supported by both the station and access point
1533 .It Cm roam:rate Ar rate
1534 Set the threshold for controlling roaming when operating in a BSS.
1537 parameter specifies the transmit rate in megabits
1538 at which roaming should be considered.
1539 If the current transmit rate drops below this setting and background scanning
1540 is enabled, then the system will check if a more desirable access point is
1541 available and switch over to it.
1542 The current scan cache contents are used if they are considered
1543 valid according to the
1545 parameter; otherwise a background scan operation is triggered before
1546 any selection occurs.
1547 Each channel type has a separate rate threshold; the default values are:
1548 12 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng).
1549 .It Cm roam:rssi Ar rssi
1550 Set the threshold for controlling roaming when operating in a BSS.
1553 parameter specifies the receive signal strength in dBm units
1554 at which roaming should be considered.
1555 If the current rssi drops below this setting and background scanning
1556 is enabled, then the system will check if a more desirable access point is
1557 available and switch over to it.
1558 The current scan cache contents are used if they are considered
1559 valid according to the
1561 parameter; otherwise a background scan operation is triggered before
1562 any selection occurs.
1563 Each channel type has a separate rssi threshold; the default values are
1565 .It Cm roaming Ar mode
1566 When operating as a station, control how the system will
1567 behave when communication with the current access point
1571 argument may be one of
1573 (leave it to the hardware device to decide),
1575 (handle either in the device or the operating system\[em]as appropriate),
1577 (do nothing until explicitly instructed).
1578 By default, the device is left to handle this if it is
1579 capable; otherwise, the operating system will automatically
1580 attempt to reestablish communication.
1581 Manual mode is used by applications such as
1582 .Xr wpa_supplicant 8
1583 that want to control the selection of an access point.
1584 .It Cm rtsthreshold Ar length
1585 Set the threshold for which
1586 transmitted frames are preceded by transmission of an
1592 is the frame size in bytes and must be in the range 1 to 2346.
1600 disables transmission of RTS frames.
1601 Not all adapters support setting the RTS threshold.
1603 Initiate a scan of neighboring stations, wait for it to complete, and
1604 display all stations found.
1605 Only the super-user can initiate a scan.
1608 for information on the display.
1609 By default a background scan is done; otherwise a foreground
1610 scan is done and the station may roam to a different access point.
1613 request can be used to show recent scan results without
1614 initiating a new scan.
1615 .It Cm scanvalid Ar threshold
1616 Set the maximum time the scan cache contents are considered valid;
1617 i.e. will be used without first triggering a scan operation to
1621 parameter is specified in seconds and defaults to 60 seconds.
1622 The minimum setting for
1625 One should take care setting this threshold; if it is set too low
1626 then attempts to roam to another access point may trigger unnecessary
1627 background scan operations.
1629 Enable use of Short Guard Interval when operating in 802.11n
1631 NB: this currently enables Short GI on both HT40 and HT20 channels.
1632 To disable Short GI use
1635 Enable use of Static Spatial Multiplexing Power Save (SMPS)
1636 when operating in 802.11n.
1637 A station operating with Static SMPS maintains only a single
1638 receive chain active (this can significantly reduce power consumption).
1642 Enable use of Dynamic Spatial Multiplexing Power Save (SMPS)
1643 when operating in 802.11n.
1644 A station operating with Dynamic SMPS maintains only a single
1645 receive chain active but switches to multiple receive chains when it
1646 receives an RTS frame (this can significantly reduce power consumption).
1647 Note that stations cannot distinguish between RTS/CTS intended to
1648 enable multiple receive chains and those used for other purposes.
1652 Set the desired Service Set Identifier (aka network name).
1653 The SSID is a string up to 32 characters
1654 in length and may be specified as either a normal string or in
1655 hexadecimal when preceded by
1657 Additionally, the SSID may be cleared by setting it to
1659 .It Cm tdmaslot Ar slot
1660 When operating with TDMA, use the specified
1665 is a number between 0 and the maximum number of slots in the BSS.
1666 Note that a station configured as slot 0 is a master and
1667 will broadcast beacon frames advertising the BSS;
1668 stations configured to use other slots will always
1669 scan to locate a master before they ever transmit.
1673 .It Cm tdmaslotcnt Ar cnt
1674 When operating with TDMA, setup a BSS with
1677 The slot count may be at most 8.
1678 The current implementation is only tested with two stations
1679 (i.e. point to point applications).
1680 This setting is only meaningful when a station is configured as slot 0;
1681 other stations adopt this setting from the BSS they join.
1685 .It Cm tdmaslotlen Ar len
1686 When operating with TDMA, setup a BSS such that each station has a slot
1689 The slot length must be at least 150 microseconds (1/8 TU)
1690 and no more than 65 milliseconds.
1691 Note that setting too small a slot length may result in poor channel
1692 bandwidth utilization due to factors such as timer granularity and
1694 This setting is only meaningful when a station is configured as slot 0;
1695 other stations adopt this setting from the BSS they join.
1698 is set to 10 milliseconds.
1699 .It Cm tdmabintval Ar intval
1700 When operating with TDMA, setup a BSS such that beacons are transmitted every
1702 superframes to synchronize the TDMA slot timing.
1703 A superframe is defined as the number of slots times the slot length; e.g.
1704 a BSS with two slots of 10 milliseconds has a 20 millisecond superframe.
1705 The beacon interval may not be zero.
1708 causes the timers to be resynchronized more often; this can be help if
1709 significant timer drift is observed.
1714 When operating as an access point with WPA/802.11i allow legacy
1715 stations to associate using static key WEP and open authentication.
1716 To disallow legacy station use of WEP, use
1718 .It Cm txpower Ar power
1719 Set the power used to transmit frames.
1722 argument is specified in .5 dBm units.
1723 Out of range values are truncated.
1724 Typically only a few discreet power settings are available and
1725 the driver will use the setting closest to the specified value.
1726 Not all adapters support changing the transmit power.
1727 .It Cm ucastrate Ar rate
1728 Set a fixed rate for transmitting unicast frames.
1729 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
1730 This rate should be valid for the current operating conditions;
1731 if an invalid rate is specified drivers are free to chose an
1733 .It Cm wepmode Ar mode
1734 Set the desired WEP mode.
1735 Not all adapters support all modes.
1736 The set of valid modes is
1742 mode explicitly tells the adaptor to allow association with access
1743 points which allow both encrypted and unencrypted traffic.
1746 means that the access point must only allow encrypted connections.
1749 is generally another name for
1751 Modes are case insensitive.
1752 .It Cm weptxkey Ar index
1753 Set the WEP key to be used for transmission.
1754 This is the same as setting the default transmission key with
1756 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
1757 Set the selected WEP key.
1760 is not given, key 1 is set.
1761 A WEP key will be either 5 or 13
1762 characters (40 or 104 bits) depending on the local network and the
1763 capabilities of the adaptor.
1764 It may be specified either as a plain
1765 string or as a string of hexadecimal digits preceded by
1767 For maximum portability, hex keys are recommended;
1768 the mapping of text keys to WEP encryption is usually driver-specific.
1771 drivers do this mapping differently to
1773 A key may be cleared by setting it to
1775 If WEP is supported then there are at least four keys.
1776 Some adapters support more than four keys.
1777 If that is the case, then the first four keys
1778 (1-4) will be the standard temporary keys and any others will be adaptor
1779 specific keys such as permanent keys stored in NVRAM.
1781 Note that you must set a default transmit key with
1783 for the system to know which key to use in encrypting outbound traffic.
1785 Enable Wireless Multimedia Extensions (WME) support, if available,
1786 for the specified interface.
1787 WME is a subset of the IEEE 802.11e standard to support the
1788 efficient communication of realtime and multimedia data.
1789 To disable WME support, use
1791 Another name for this parameter is
1794 The following parameters are meaningful only when WME support is in use.
1795 Parameters are specified per-AC (Access Category) and
1796 split into those that are used by a station when acting
1797 as an access point and those for client stations in the BSS.
1798 The latter are received from the access point and may not be changed
1800 The following Access Categories are recognized:
1802 .Bl -tag -width ".Cm AC_BK" -compact
1806 best effort delivery,
1821 AC parameters are case-insensitive.
1822 Traffic classification is done in the operating system using the
1823 vlan priority associated with data frames or the
1824 ToS (Type of Service) indication in IP-encapsulated frames.
1825 If neither information is present, traffic is assigned to the
1826 Best Effort (BE) category.
1827 .Bl -tag -width indent
1829 Set the ACK policy for QoS transmissions by the local station;
1830 this controls whether or not data frames transmitted by a station
1831 require an ACK response from the receiving station.
1832 To disable waiting for an ACK use
1834 This parameter is applied only to the local station.
1836 Enable the Admission Control Mandatory (ACM) mechanism
1837 for transmissions by the local station.
1838 To disable the ACM use
1840 On stations in a BSS this parameter is read-only and indicates
1841 the setting received from the access point.
1842 NB: ACM is not supported right now.
1843 .It Cm aifs Ar ac Ar count
1844 Set the Arbitration Inter Frame Spacing (AIFS)
1845 channel access parameter to use for transmissions
1846 by the local station.
1847 On stations in a BSS this parameter is read-only and indicates
1848 the setting received from the access point.
1849 .It Cm cwmin Ar ac Ar count
1850 Set the CWmin channel access parameter to use for transmissions
1851 by the local station.
1852 On stations in a BSS this parameter is read-only and indicates
1853 the setting received from the access point.
1854 .It Cm cwmax Ar ac Ar count
1855 Set the CWmax channel access parameter to use for transmissions
1856 by the local station.
1857 On stations in a BSS this parameter is read-only and indicates
1858 the setting received from the access point.
1859 .It Cm txoplimit Ar ac Ar limit
1860 Set the Transmission Opportunity Limit channel access parameter
1861 to use for transmissions by the local station.
1862 This parameter defines an interval of time when a WME station
1863 has the right to initiate transmissions onto the wireless medium.
1864 On stations in a BSS this parameter is read-only and indicates
1865 the setting received from the access point.
1866 .It Cm bss:aifs Ar ac Ar count
1867 Set the AIFS channel access parameter to send to stations in a BSS.
1868 This parameter is meaningful only when operating in ap mode.
1869 .It Cm bss:cwmin Ar ac Ar count
1870 Set the CWmin channel access parameter to send to stations in a BSS.
1871 This parameter is meaningful only when operating in ap mode.
1872 .It Cm bss:cwmax Ar ac Ar count
1873 Set the CWmax channel access parameter to send to stations in a BSS.
1874 This parameter is meaningful only when operating in ap mode.
1875 .It Cm bss:txoplimit Ar ac Ar limit
1876 Set the TxOpLimit channel access parameter to send to stations in a BSS.
1877 This parameter is meaningful only when operating in ap mode.
1880 Enable Wireless Privacy Subscriber support.
1881 Note that WPS support requires a WPS-capable supplicant.
1882 To disable this function use
1886 The following parameters support an optional access control list
1887 feature available with some adapters when operating in ap mode; see
1889 This facility allows an access point to accept/deny association
1890 requests based on the MAC address of the station.
1891 Note that this feature does not significantly enhance security
1892 as MAC address spoofing is easy to do.
1893 .Bl -tag -width indent
1894 .It Cm mac:add Ar address
1895 Add the specified MAC address to the database.
1896 Depending on the policy setting association requests from the
1897 specified station will be allowed or denied.
1899 Set the ACL policy to permit association only by
1900 stations registered in the database.
1901 .It Cm mac:del Ar address
1902 Delete the specified MAC address from the database.
1904 Set the ACL policy to deny association only by
1905 stations registered in the database.
1906 .It Cm mac:kick Ar address
1907 Force the specified station to be deauthenticated.
1908 This typically is done to block a station after updating the
1911 Set the ACL policy to allow all stations to associate.
1913 Delete all entries in the database.
1915 Set the ACL policy to permit association only by
1916 stations approved by a RADIUS server.
1917 Note that this feature requires the
1919 program be configured to do the right thing
1920 as it handles the RADIUS processing
1921 (and marks stations as authorized).
1924 The following parameters are related to a wireless interface operating in mesh
1926 .Bl -tag -width indent
1927 .It Cm meshid Ar meshid
1928 Set the desired Mesh Identifier.
1929 The Mesh ID is a string up to 32 characters in length.
1930 A mesh interface must have a Mesh Identifier specified
1931 to reach an operational state.
1932 .It Cm meshttl Ar ttl
1933 Set the desired ``time to live'' for mesh forwarded packets;
1934 this is the number of hops a packet may be forwarded before
1936 The default setting for
1940 Enable or disable peering with neighbor mesh stations.
1941 Stations must peer before any data packets can be exchanged.
1946 Enable or disable forwarding packets by a mesh interface.
1950 .It Cm meshmetric Ar protocol
1953 as the link metric protocol used on a mesh network.
1954 The default protocol is called
1956 The mesh interface will restart after changing this setting.
1957 .It Cm meshpath Ar protocol
1960 as the path selection protocol used on a mesh network.
1961 The only available protocol at the moment is called
1963 (Hybrid Wireless Mesh Protocol).
1964 The mesh interface will restart after changing this setting.
1965 .It Cm hwmprootmode Ar mode
1966 Stations on a mesh network can operate as ``root nodes.''
1967 Root nodes try to find paths to all mesh nodes and advertise themselves
1969 When there is a root mesh node on a network, other mesh nodes can setup
1970 paths between themselves faster because they can use the root node
1971 to find the destination.
1972 This path may not be the best, but on-demand
1973 routing will eventually find the best path.
1974 The following modes are recognized:
1976 .Bl -tag -width ".Cm PROACTIVE" -compact
1980 Send broadcast path requests every two seconds.
1981 Nodes on the mesh without a path to this root mesh station with try to
1982 discover a path to us.
1984 Send broadcast path requests every two seconds and every node must reply with
1985 with a path reply even if it already has a path to this root mesh station.
1987 Send broadcast root announcement (RANN) frames.
1988 Nodes on the mesh without a path to this root mesh station with try to
1989 discover a path to us.
1995 .It Cm hwmpmaxhops Ar cnt
1996 Set the maximum number of hops allowed in an HMWP path to
1998 The default setting for
2003 The following parameters are for compatibility with other systems:
2004 .Bl -tag -width indent
2006 Another name for the
2012 .It Cm stationname Ar name
2013 Set the name of this station.
2014 The station name is not part of the IEEE 802.11
2015 protocol though some interfaces support it.
2017 seems to be meaningful to identical or virtually identical equipment.
2018 Setting the station name is identical in syntax to setting the SSID.
2025 Another way of saying
2031 Another way of saying
2037 Another way of saying:
2038 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
2044 .Ar n : k1 , k2 , k3 , k4
2047 Another way of saying
2048 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
2053 Another way of saying
2060 The following parameters are specific to bridge interfaces:
2061 .Bl -tag -width indent
2062 .It Cm addm Ar interface
2063 Add the interface named by
2065 as a member of the bridge.
2066 The interface is put into promiscuous mode
2067 so that it can receive every packet sent on the network.
2068 .It Cm deletem Ar interface
2069 Remove the interface named by
2072 Promiscuous mode is disabled on the interface when
2073 it is removed from the bridge.
2074 .It Cm maxaddr Ar size
2075 Set the size of the bridge address cache to
2077 The default is 100 entries.
2078 .It Cm timeout Ar seconds
2079 Set the timeout of address cache entries to
2084 is zero, then address cache entries will not be expired.
2085 The default is 240 seconds.
2087 Display the addresses that have been learned by the bridge.
2088 .It Cm static Ar interface-name Ar address
2089 Add a static entry into the address cache pointing to
2090 .Ar interface-name .
2091 Static entries are never aged out of the cache or re-placed, even if the
2092 address is seen on a different interface.
2093 .It Cm deladdr Ar address
2096 from the address cache.
2098 Delete all dynamically-learned addresses from the address cache.
2100 Delete all addresses, including static addresses, from the address cache.
2101 .It Cm discover Ar interface
2102 Mark an interface as a
2105 When the bridge has no address cache entry
2106 (either dynamic or static)
2107 for the destination address of a packet,
2108 the bridge will forward the packet to all
2109 member interfaces marked as
2111 This is the default for all interfaces added to a bridge.
2112 .It Cm -discover Ar interface
2115 attribute on a member interface.
2116 For packets without the
2118 attribute, the only packets forwarded on the interface are broadcast
2119 or multicast packets and packets for which the destination address
2120 is known to be on the interface's segment.
2121 .It Cm learn Ar interface
2122 Mark an interface as a
2125 When a packet arrives on such an interface, the source
2126 address of the packet is entered into the address cache as being a
2127 destination address on the interface's segment.
2128 This is the default for all interfaces added to a bridge.
2129 .It Cm -learn Ar interface
2132 attribute on a member interface.
2133 .It Cm sticky Ar interface
2134 Mark an interface as a
2137 Dynamically learned address entries are treated at static once entered into
2139 Sticky entries are never aged out of the cache or replaced, even if the
2140 address is seen on a different interface.
2141 .It Cm -sticky Ar interface
2144 attribute on a member interface.
2145 .It Cm private Ar interface
2146 Mark an interface as a
2149 A private interface does not forward any traffic to any other port that is also
2150 a private interface.
2151 .It Cm -private Ar interface
2154 attribute on a member interface.
2155 .It Cm span Ar interface
2156 Add the interface named by
2158 as a span port on the bridge.
2159 Span ports transmit a copy of every frame received by the bridge.
2160 This is most useful for snooping a bridged network passively on
2161 another host connected to one of the span ports of the bridge.
2162 .It Cm -span Ar interface
2163 Delete the interface named by
2165 from the list of span ports of the bridge.
2166 .It Cm stp Ar interface
2167 Enable Spanning Tree protocol on
2171 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
2172 Spanning Tree is used to detect and remove loops in a network topology.
2173 .It Cm -stp Ar interface
2174 Disable Spanning Tree protocol on
2176 This is the default for all interfaces added to a bridge.
2177 .It Cm edge Ar interface
2181 An edge port connects directly to end stations cannot create bridging
2182 loops in the network, this allows it to transition straight to forwarding.
2183 .It Cm -edge Ar interface
2184 Disable edge status on
2186 .It Cm autoedge Ar interface
2189 to automatically detect edge status.
2190 This is the default for all interfaces added to a bridge.
2191 .It Cm -autoedge Ar interface
2192 Disable automatic edge status on
2194 .It Cm ptp Ar interface
2197 as a point to point link.
2198 This is required for straight transitions to forwarding and
2199 should be enabled on a direct link to another RSTP capable switch.
2200 .It Cm -ptp Ar interface
2201 Disable point to point link status on
2203 This should be disabled for a half duplex link and for an interface
2204 connected to a shared network segment,
2205 like a hub or a wireless network.
2206 .It Cm autoptp Ar interface
2207 Automatically detect the point to point status on
2209 by checking the full duplex link status.
2210 This is the default for interfaces added to the bridge.
2211 .It Cm -autoptp Ar interface
2212 Disable automatic point to point link detection on
2214 .It Cm maxage Ar seconds
2215 Set the time that a Spanning Tree protocol configuration is valid.
2216 The default is 20 seconds.
2217 The minimum is 6 seconds and the maximum is 40 seconds.
2218 .It Cm fwddelay Ar seconds
2219 Set the time that must pass before an interface begins forwarding
2220 packets when Spanning Tree is enabled.
2221 The default is 15 seconds.
2222 The minimum is 4 seconds and the maximum is 30 seconds.
2223 .It Cm hellotime Ar seconds
2224 Set the time between broadcasting of Spanning Tree protocol
2225 configuration messages.
2226 The hello time may only be changed when operating in legacy stp mode.
2227 The default is 2 seconds.
2228 The minimum is 1 second and the maximum is 2 seconds.
2229 .It Cm priority Ar value
2230 Set the bridge priority for Spanning Tree.
2231 The default is 32768.
2232 The minimum is 0 and the maximum is 61440.
2233 .It Cm proto Ar value
2234 Set the Spanning Tree protocol.
2235 The default is rstp.
2236 The available options are stp and rstp.
2237 .It Cm holdcnt Ar value
2238 Set the transmit hold count for Spanning Tree.
2239 This is the number of packets transmitted before being rate limited.
2241 The minimum is 1 and the maximum is 10.
2242 .It Cm ifpriority Ar interface Ar value
2243 Set the Spanning Tree priority of
2248 The minimum is 0 and the maximum is 240.
2249 .It Cm ifpathcost Ar interface Ar value
2250 Set the Spanning Tree path cost of
2254 The default is calculated from the link speed.
2255 To change a previously selected path cost back to automatic, set the
2257 The minimum is 1 and the maximum is 200000000.
2258 .It Cm ifmaxaddr Ar interface Ar size
2259 Set the maximum number of hosts allowed from an interface, packets with unknown
2260 source addresses are dropped until an existing host cache entry expires or is
2262 Set to 0 to disable.
2265 The following parameters are specific to lagg interfaces:
2266 .Bl -tag -width indent
2267 .It Cm laggport Ar interface
2268 Add the interface named by
2270 as a port of the aggregation interface.
2271 .It Cm -laggport Ar interface
2272 Remove the interface named by
2274 from the aggregation interface.
2275 .It Cm laggproto Ar proto
2276 Set the aggregation protocol.
2277 The default is failover.
2278 The available options are failover, fec, lacp, loadbalance, roundrobin and
2282 The following parameters are specific to IP tunnel interfaces,
2284 .Bl -tag -width indent
2285 .It Cm tunnel Ar src_addr dest_addr
2286 Configure the physical source and destination address for IP tunnel
2292 are interpreted as the outer source/destination for the encapsulating
2295 Unconfigure the physical source and destination address for IP tunnel
2296 interfaces previously configured with
2299 Another name for the
2302 .It Cm accept_rev_ethip_ver
2303 Set a flag to accept both correct EtherIP packets and ones
2304 with reversed version field. Enabled by default.
2305 This is for backward compatibility with
2307 6.2, 6.3, 7.0, and 7.1.
2308 .It Cm -accept_rev_ethip_ver
2310 .Cm accept_rev_ethip_ver .
2311 .It Cm send_rev_ethip_ver
2312 Set a flag to send EtherIP packets with reversed version
2313 field intentionally. Disabled by default.
2314 This is for backward compatibility with
2316 6.2, 6.3, 7.0, and 7.1.
2317 .It Cm -send_rev_ethip_ver
2319 .Cm send_rev_ethip_ver .
2322 The following parameters are specific to GRE tunnel interfaces,
2324 .Bl -tag -width indent
2325 .It Cm grekey Ar key
2326 Configure the GRE key to be used for outgoing packets.
2328 .Xr gre 4 will always accept GRE packets with invalid or absent keys.
2329 This command will result in a four byte MTU reduction on the interface.
2332 The following parameters are specific to
2335 .Bl -tag -width indent
2337 Set the maximum number of updates for a single state which
2338 can be collapsed into one.
2339 This is an 8-bit number; the default value is 128.
2342 The following parameters are specific to
2345 .Bl -tag -width indent
2346 .It Cm vlan Ar vlan_tag
2347 Set the VLAN tag value to
2349 This value is a 16-bit number which is used to create an 802.1Q
2350 VLAN header for packets sent from the
2357 must both be set at the same time.
2358 .It Cm vlandev Ar iface
2359 Associate the physical interface
2364 Packets transmitted through the
2367 diverted to the specified physical interface
2369 with 802.1Q VLAN encapsulation.
2370 Packets with 802.1Q encapsulation received
2371 by the parent interface with the correct VLAN tag will be diverted to
2377 interface is assigned a
2378 copy of the parent interface's flags and the parent's ethernet address.
2383 must both be set at the same time.
2386 interface already has
2387 a physical interface associated with it, this command will fail.
2389 change the association to another physical interface, the existing
2390 association must be cleared first.
2392 Note: if the hardware tagging capability
2393 is set on the parent interface, the
2396 interface's behavior changes:
2399 interface recognizes that the
2400 parent interface supports insertion and extraction of VLAN tags on its
2401 own (usually in firmware) and that it should pass packets to and from
2402 the parent unaltered.
2403 .It Fl vlandev Op Ar iface
2406 pseudo device, disassociate the parent interface from it.
2407 This breaks the link between the
2409 interface and its parent,
2410 clears its VLAN tag, flags and its link address and shuts the interface down.
2413 argument is useless and hence deprecated.
2416 The following parameters are specific to
2419 .Bl -tag -width indent
2420 .It Cm advbase Ar seconds
2421 Specifies the base of the advertisement interval in seconds.
2422 The acceptable values are 1 to 255.
2423 The default value is 1.
2424 .\" The default value is
2425 .\" .Dv CARP_DFLTINTV .
2426 .It Cm advskew Ar interval
2427 Specifies the skew to add to the base advertisement interval to
2428 make one host advertise slower than another host.
2429 It is specified in 1/256 of seconds.
2430 The acceptable values are 1 to 254.
2431 The default value is 0.
2432 .It Cm pass Ar phrase
2433 Set the authentication key to
2436 Set the virtual host ID.
2437 This is a required setting.
2438 Acceptable values are 1 to 255.
2443 utility displays the current configuration for a network interface
2444 when no optional parameters are supplied.
2445 If a protocol family is specified,
2447 will report only the details specific to that protocol family.
2451 flag is passed before an interface name,
2453 will display the capability list and all
2454 of the supported media for the specified interface.
2457 flag is supplied, address lifetime is displayed for IPv6 addresses,
2458 as time offset string.
2462 flag may be used instead of an interface name.
2465 to display information about all interfaces in the system.
2468 flag limits this to interfaces that are down, and
2470 limits this to interfaces that are up.
2471 When no arguments are given,
2477 flag may be used to list all available interfaces on the system, with
2478 no other additional information.
2479 Use of this flag is mutually exclusive
2480 with all other flags and commands, except for
2482 (only list interfaces that are down)
2485 (only list interfaces that are up).
2489 flag may be used to get more verbose status for an interface.
2493 flag may be used to list all of the interface cloners available on
2494 the system, with no additional information.
2495 Use of this flag is mutually exclusive with all other flags and commands.
2499 flag causes keying information for the interface, if available, to be
2501 For example, the values of 802.11 WEP keys will be printed, if accessible to
2503 This information is not printed by default, as it may be considered
2506 If the network interface driver is not present in the kernel then
2508 will attempt to load it.
2511 flag disables this behavior.
2513 Only the super-user may modify the configuration of a network interface.
2515 The media selection system is relatively new and only some drivers support
2516 it (or have need for it).
2518 Assign the IPv4 address
2520 with a network mask of
2524 .Dl # ifconfig fxp0 inet 192.0.2.10 netmask 255.255.255.0
2526 Add the IPv4 address
2528 with the CIDR network prefix
2534 as a synonym for the canonical form of the option
2536 .Dl # ifconfig ed0 inet 192.0.2.45/28 add
2538 Remove the IPv4 address
2542 .Dl # ifconfig ed0 inet 192.0.2.45 -alias
2544 Enable IPv6 functionality of the interface:
2545 .Dl # ifconfig em0 inet6 -ifdisabled
2547 Add the IPv6 address
2548 .Li 2001:DB8:DBDB::123/48
2551 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias
2552 Note that lower case hexadecimal IPv6 addresses are acceptable.
2554 Remove the IPv6 address added in the above example,
2557 character as shorthand for the network prefix,
2560 as a synonym for the canonical form of the option
2562 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 delete
2564 Configure the interface
2566 to use 100baseTX, full duplex Ethernet media options:
2567 .Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex
2569 Label the em0 interface as an uplink:
2570 .Dl # ifconfig em0 description \&"Uplink to Gigabit Switch 2\&"
2572 Create the software network interface
2574 .Dl # ifconfig gif1 create
2576 Destroy the software network interface
2578 .Dl # ifconfig gif1 destroy
2580 Display available wireless networks using
2582 .Dl # ifconfig wlan0 list scan
2584 Messages indicating the specified interface does not exist, the
2585 requested address is unknown, or the user is not privileged and
2586 tried to alter an interface's configuration.
2606 Basic IPv6 node operation requires a link-local address on each
2607 interface configured for IPv6.
2608 Normally, such an address is automatically configured by the
2609 kernel on each interface added to the system or enabled; this behavior may
2610 be disabled by setting per-interface flag
2611 .Cm -auto_linklocal .
2612 The default value of this flag is 1 and can be disabled by using the sysctl
2614 .Va net.inet6.ip6.auto_linklocal .
2616 Do not configure IPv6 addresses with no link-local address by using
2618 It can result in unexpected behaviors of the kernel.
projects / FreeBSD / releng / 9.0.git / blob