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
176 Specify the address of the correspondent on the other end
177 of a point to point link.
180 parameter is a string of the form
185 List the interfaces in the given group.
188 The following parameters may be set with
190 .Bl -tag -width indent
195 Introduced for compatibility
199 Establish an additional network address for this interface.
200 This is sometimes useful when changing network numbers, and
201 one wishes to accept packets addressed to the old interface.
202 If the address is on the same subnet as the first network address
203 for this interface, a non-conflicting netmask must be given.
208 Remove the network address specified.
209 This would be used if you incorrectly specified an alias, or it
210 was no longer needed.
211 If you have incorrectly set an NS address having the side effect
212 of specifying the host portion, removing all NS addresses will
213 allow you to respecify the host portion.
216 Specify that the address configured is an anycast address.
217 Based on the current specification,
218 only routers may configure anycast addresses.
219 Anycast address will not be used as source address of any of outgoing
222 Enable the use of the Address Resolution Protocol
225 between network level addresses and link level addresses (default).
226 This is currently implemented for mapping between
231 802 48-bit MAC addresses (Ethernet, FDDI, and Token Ring addresses).
233 Disable the use of the Address Resolution Protocol
236 If the Address Resolution Protocol is enabled,
237 the host will only reply to requests for its addresses,
238 and will never send any requests.
240 If the Address Resolution Protocol is enabled,
241 the host will perform normally,
242 sending out requests and listening for replies.
245 Specify the address to use to represent broadcasts to the
247 The default broadcast address is the address with a host part of all 1's.
249 Enable driver dependent debugging code; usually, this turns on
250 extra console error logging.
252 Disable driver dependent debugging code.
254 Put interface into permanently promiscuous mode.
256 Disable permanently promiscuous mode.
261 .It Cm description Ar value , Cm descr Ar value
262 Specify a description of the interface.
263 This can be used to label interfaces in situations where they may
264 otherwise be difficult to distinguish.
265 .It Cm -description , Cm -descr
266 Clear the interface description.
270 When an interface is marked
272 the system will not attempt to
273 transmit messages through that interface.
274 If possible, the interface will be reset to disable reception as well.
275 This action does not automatically disable routes using the interface.
276 .It Cm group Ar group-name
277 Assign the interface to a
279 Any interface can be in multiple groups.
281 Cloned interfaces are members of their interface family group by default.
282 For example, a PPP interface such as
284 is a member of the PPP interface family group,
286 .\" The interface(s) the default route(s) point to are members of the
289 .It Cm -group Ar group-name
290 Remove the interface from the given
295 (lowermost 64bit of an IPv6 address)
298 This is used to specify an Internet host who is willing to receive
299 IP packets encapsulating IPX packets bound for a remote network.
300 An apparent point to point link is constructed, and
301 the address specified will be taken as the IPX address and network
303 .It Cm maclabel Ar label
304 If Mandatory Access Control support is enabled in the kernel,
308 .\" .Xr maclabel 7 ) .
310 If the driver supports the media selection system, set the media type
313 Some interfaces support the mutually exclusive use of one of several
314 different physical media connectors.
315 For example, a 10Mbit/s Ethernet
316 interface might support the use of either
318 or twisted pair connectors.
319 Setting the media type to
321 would change the currently active connector to the AUI port.
324 would activate twisted pair.
325 Refer to the interfaces' driver
326 specific documentation or man page for a complete list of the
328 .It Cm mediaopt Ar opts
329 If the driver supports the media selection system, set the specified
330 media options on the interface.
334 is a comma delimited list of options to apply to the interface.
335 Refer to the interfaces' driver specific man page for a complete
336 list of available options.
337 .It Fl mediaopt Ar opts
338 If the driver supports the media selection system, disable the
339 specified media options on the interface.
341 If the driver supports the media selection system, set the specified
342 operating mode on the interface to
344 For IEEE 802.11 wireless interfaces that support multiple operating modes
345 this directive is used to select between 802.11a
352 .It Cm inst Ar minst , Cm instance Ar minst
353 Set the media instance to
355 This is useful for devices which have multiple physical layer interfaces
358 Set the interface name to
360 .It Cm rxcsum , txcsum
361 If the driver supports user-configurable checksum offloading,
362 enable receive (or transmit) checksum offloading on the interface.
363 Some drivers may not be able to enable these flags independently
364 of each other, so setting one may also set the other.
365 The driver will offload as much checksum work as it can reliably
366 support, the exact level of offloading varies between drivers.
367 .It Fl rxcsum , txcsum
368 If the driver supports user-configurable checksum offloading,
369 disable receive (or transmit) checksum offloading on the interface.
370 These settings may not always be independent of each other.
372 If the driver supports
374 segmentation offloading, enable TSO on the interface.
375 Some drivers may not be able to support TSO for
379 packets, so they may enable only one of them.
381 If the driver supports
383 segmentation offloading, disable TSO on the interface.
384 It will always disable TSO for
389 If the driver supports
391 large receive offloading, enable LRO on the interface.
393 If the driver supports
395 large receive offloading, disable LRO on the interface.
396 .It Cm wol , wol_ucast , wol_mcast , wol_magic
397 Enable Wake On Lan (WOL) support, if available.
398 WOL is a facility whereby a machine in a low power state may be woken
399 in response to a received packet.
400 There are three types of packets that may wake a system:
401 ucast (directed solely to the machine's mac address),
402 mcast (directed to a broadcast or multicast address),
404 magic (unicast or multicast frames with a ``magic contents'').
405 Not all devices support WOL, those that do indicate the mechanisms
406 they support in their capabilities.
408 is a synonym for enabling all available WOL mechanisms.
411 .It Cm vlanmtu , vlanhwtag, vlanhwfilter, vlanhwtso
412 If the driver offers user-configurable VLAN support, enable
413 reception of extended frames, tag processing in hardware,
414 frame filtering in hardware, or TSO on VLAN,
416 Note that this must be issued on a physical interface associated with
421 .It Fl vlanmtu , vlanhwtag, vlanhwfilter, vlanhwtso
422 If the driver offers user-configurable VLAN support, disable
423 reception of extended frames, tag processing in hardware,
424 frame filtering in hardware, or TSO on VLAN,
427 Move the interface to the
429 specified by name or JID.
430 If the jail has a virtual network stack, the interface will disappear
431 from the current environment and become visible to the jail.
433 Reclaim the interface from the
435 specified by name or JID.
436 If the jail has a virtual network stack, the interface will disappear
437 from the jail, and become visible to the current network environment.
441 feature and disable interrupts on the interface, if driver supports
446 feature and enable interrupt mode on the interface.
448 Create the specified network pseudo-device.
449 If the interface is given without a unit number, try to create a new
450 device with an arbitrary unit number.
451 If creation of an arbitrary device is successful, the new device name is
452 printed to standard output unless the interface is renamed or destroyed
457 Destroy the specified network pseudo-device.
473 Set the routing metric of the interface to
476 The routing metric is used by the routing protocol
478 Higher metrics have the effect of making a route
479 less favorable; metrics are counted as additional hops
480 to the destination network or host.
482 Set the maximum transmission unit of the interface to
484 default is interface specific.
485 The MTU is used to limit the size of packets that are transmitted on an
487 Not all interfaces support setting the MTU, and some interfaces have
489 .It Cm netmask Ar mask
492 Specify how much of the address to reserve for subdividing
493 networks into sub-networks.
494 The mask includes the network part of the local address
495 and the subnet part, which is taken from the host field of the address.
496 The mask can be specified as a single hexadecimal number
499 with a dot-notation Internet address,
500 or with a pseudo-network name listed in the network table
502 The mask contains 1's for the bit positions in the 32-bit address
503 which are to be used for the network and subnet parts,
504 and 0's for the host part.
505 The mask should contain at least the standard network portion,
506 and the subnet field should be contiguous with the network
509 The netmask can also be specified in CIDR notation after the address.
512 option above for more information.
513 .It Cm prefixlen Ar len
517 bits are reserved for subdividing networks into sub-networks.
520 must be integer, and for syntactical reason it must be between 0 to 128.
521 It is almost always 64 under the current IPv6 assignment rule.
522 If the parameter is omitted, 64 is used.
524 The prefix can also be specified using the slash notation after the address.
527 option above for more information.
530 .\" .It Cm nsellength Ar n
533 .\" This specifies a trailing number of bytes for a received
535 .\" used for local identification, the remaining leading part of which is
538 .\" (Network Entity Title).
539 .\" The default value is 1, which is conformant to US
541 .\" When an ISO address is set in an ifconfig command,
544 .\" which is being specified.
547 .\" 20 hex digits should be
550 .\" to be assigned to the interface.
551 .\" There is some evidence that a number different from 1 may be useful
554 .\" 37 type addresses.
555 .It Cm range Ar netrange
556 Under appletalk, set the interface to respond to a
559 .Ar startnet Ns - Ns Ar endnet .
560 Appletalk uses this scheme instead of
563 implements it internally as a set of netmasks.
568 Introduced for compatibility
572 The argument following this specifies the version (phase) of the
573 Appletalk network attached to the interface.
574 Values of 1 or 2 are permitted.
576 .It Cm link Op Cm 0 No - Cm 2
578 Enable special processing of the link level of the interface.
579 These three options are interface specific in actual effect, however,
580 they are in general used to select special modes of operation.
582 of this is to enable SLIP compression, or to select the connector type
583 for some Ethernet cards.
584 Refer to the man page for the specific driver
585 for more information.
587 .It Fl link Op Cm 0 No - Cm 2
589 Disable special processing at the link level with the specified interface.
591 Put the interface in monitor mode.
592 No packets are transmitted, and received packets are discarded after
596 Take the interface out of monitor mode.
600 This may be used to enable an interface after an
602 It happens automatically when setting the first address on an interface.
603 If the interface was reset when previously marked down,
604 the hardware will be re-initialized.
607 The following parameters are for ICMPv6 Neighbor Discovery Protocol.
608 Note that the address family keyword
611 .Bl -tag -width indent
613 Set a flag to enable accepting ICMPv6 Router Advertisement messages.
617 .It Cm auto_linklocal
618 Set a flag to perform automatic link-local address configuration when
619 the interface becomes available.
620 .It Cm -auto_linklocal
624 Set the specified interface as the default route when there is no
630 Set a flag to disable all of IPv6 network communications on the
631 specified interface. Note that if there are already configured IPv6
632 addresses on that interface, all of them are marked as
634 and DAD will be performed when this flag is cleared.
638 When this flag is cleared and
640 flag is enabled, automatic configuration of a link-local address is
643 Set a flag to enable Neighbor Unreachability Detection.
648 Set a flag to prefer addresses on the interface as candidates of the
649 source address for outgoing packets.
650 .It Cm -prefer_source
655 The following parameters are specific to cloning
656 IEEE 802.11 wireless interfaces with the
659 .Bl -tag -width indent
660 .It Cm wlandev Ar device
663 as the parent for the cloned device.
664 .It Cm wlanmode Ar mode
665 Specify the operating mode for this cloned device.
683 The operating mode of a cloned interface cannot be changed.
686 mode is actually implemented as an
688 interface with special properties.
689 .It Cm wlanbssid Ar bssid
690 The 802.11 mac address to use for the bssid.
691 This must be specified at create time for a legacy
694 .It Cm wlanaddr Ar address
695 The local mac address.
696 If this is not specified then a mac address will automatically be assigned
697 to the cloned device.
698 Typically this address is the same as the address of the parent device
701 parameter is specified then the driver will craft a unique address for
702 the device (if supported).
706 device as operating in ``legacy mode''.
709 devices have a fixed peer relationship and do not, for example, roam
710 if their peer stops communicating.
711 For completeness a Dynamic WDS (DWDS) interface may marked as
714 Request a unique local mac address for the cloned device.
715 This is only possible if the device supports multiple mac addresses.
716 To force use of the parent's mac address use
719 Mark the cloned interface as depending on hardware support to
720 track received beacons.
721 To have beacons tracked in software use
727 can also be used to indicate no beacons should
728 be transmitted; this can be useful when creating a WDS configuration but
730 interfaces can only be created as companions to an access point.
733 The following parameters are specific to IEEE 802.11 wireless interfaces
737 .Bl -tag -width indent
739 Enable sending and receiving AMPDU frames when using 802.11n (default).
740 The 802.11n specification states a compliant station must be capable
741 of receiving AMPDU frames but transmission is optional.
744 to disable all use of AMPDU with 802.11n.
745 For testing and/or to work around interoperability problems one can use
749 to control use of AMPDU in one direction.
750 .It Cm ampdudensity Ar density
751 Set the AMPDU density parameter used when operating with 802.11n.
752 This parameter controls the inter-packet gap for AMPDU frames.
753 The sending device normally controls this setting but a receiving station
754 may request wider gaps.
757 are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds).
760 is treated the same as 0.
761 .It Cm ampdulimit Ar limit
762 Set the limit on packet size for receiving AMPDU frames when operating
766 are 8192, 16384, 32768, and 65536 but one can also specify
767 just the unique prefix: 8, 16, 32, 64.
768 Note the sender may limit the size of AMPDU frames to be less
769 than the maximum specified by the receiving station.
771 Enable sending and receiving AMSDU frames when using 802.11n.
772 By default AMSDU is received but not transmitted.
775 to disable all use of AMSDU with 802.11n.
776 For testing and/or to work around interoperability problems one can use
780 to control use of AMSDU in one direction.
781 .It Cm amsdulimit Ar limit
782 Set the limit on packet size for sending and receiving AMSDU frames
783 when operating with 802.11n.
786 are 7935 and 3839 (bytes).
787 Note the sender may limit the size of AMSDU frames to be less
788 than the maximum specified by the receiving station.
789 Note also that devices are not required to support the 7935 limit,
790 only 3839 is required by the specification and the larger value
791 may require more memory to be dedicated to support functionality
794 When operating as an access point, pass packets between
795 wireless clients directly (default).
796 To instead let them pass up through the
797 system and be forwarded using some other mechanism, use
799 Disabling the internal bridging
800 is useful when traffic is to be processed with
802 .It Cm authmode Ar mode
803 Set the desired authentication mode in infrastructure mode.
804 Not all adapters support all modes.
807 .Cm none , open , shared
813 (IEEE WPA/WPA2/802.11i).
818 modes are only useful when using an authentication service
819 (a supplicant for client operation or an authenticator when
820 operating as an access point).
821 Modes are case insensitive.
823 Enable background scanning when operating as a station.
824 Background scanning is a technique whereby a station associated to
825 an access point will temporarily leave the channel to scan for
826 neighboring stations.
827 This allows a station to maintain a cache of nearby access points
828 so that roaming between access points can be done without
829 a lengthy scan operation.
830 Background scanning is done only when a station is not busy and
831 any outbound traffic will cancel a scan operation.
832 Background scanning should never cause packets to be lost though
833 there may be some small latency if outbound traffic interrupts a
835 By default background scanning is enabled if the device is capable.
836 To disable background scanning, use
838 Background scanning is controlled by the
843 Background scanning must be enabled for roaming; this is an artifact
844 of the current implementation and may not be required in the future.
845 .It Cm bgscanidle Ar idletime
846 Set the minimum time a station must be idle (not transmitting or
847 receiving frames) before a background scan is initiated.
850 parameter is specified in milliseconds.
851 By default a station must be idle at least 250 milliseconds before
852 a background scan is initiated.
853 The idle time may not be set to less than 100 milliseconds.
854 .It Cm bgscanintvl Ar interval
855 Set the interval at which background scanning is attempted.
858 parameter is specified in seconds.
859 By default a background scan is considered every 300 seconds (5 minutes).
862 may not be set to less than 15 seconds.
863 .It Cm bintval Ar interval
864 Set the interval at which beacon frames are sent when operating in
868 parameter is specified in TU's (1024 usecs).
869 By default beacon frames are transmitted every 100 TU's.
870 .It Cm bmissthreshold Ar count
871 Set the number of consecutive missed beacons at which the station
872 will attempt to roam (i.e., search for a new access point).
875 parameter must be in the range 1 to 255; though the
876 upper bound may be reduced according to device capabilities.
877 The default threshold is 7 consecutive missed beacons; but
878 this may be overridden by the device driver.
883 .It Cm bssid Ar address
884 Specify the MAC address of the access point to use when operating
885 as a station in a BSS network.
886 This overrides any automatic selection done by the system.
887 To disable a previously selected access point, supply
892 This option is useful when more than one access point uses the same SSID.
898 Enable packet bursting.
899 Packet bursting is a transmission technique whereby the wireless
900 medium is acquired once to send multiple frames and the interframe
902 This technique can significantly increase throughput by reducing
903 transmission overhead.
904 Packet bursting is supported by the 802.11e QoS specification
905 and some devices that do not support QoS may still be capable.
906 By default packet bursting is enabled if a device is capable
908 To disable packet bursting, use
910 .It Cm chanlist Ar channels
911 Set the desired channels to use when scanning for access
912 points, neighbors in an IBSS network, or looking for unoccupied
913 channels when operating as an access point.
914 The set of channels is specified as a comma-separated list with
915 each element in the list representing either a single channel number or a range
918 Channel numbers must be in the range 1 to 255 and be permissible
919 according to the operating characteristics of the device.
920 .It Cm channel Ar number
921 Set a single desired channel.
922 Channels range from 1 to 255, but the exact selection available
923 depends on the region your adaptor was manufactured for.
929 will clear any desired channel and, if the device is marked up,
930 force a scan for a channel to operate on.
931 Alternatively the frequency, in megahertz, may be specified
932 instead of the channel number.
934 When there are several ways to use a channel the channel
935 number/frequency may be appended with attributes to clarify.
936 For example, if a device is capable of operating on channel 6
937 with 802.11n and 802.11g then one can specify that g-only use
938 should be used by specifying ``6:g''.
939 Similarly the channel width can be specified by appending it
940 with ``/''; e.g. ``6/40'' specifies a 40MHz wide channel,
941 These attributes can be combined as in: ``6:ht/40''.
942 The full set of flags specified following a ``:'' are:
948 (Atheros Dynamic Turbo mode),
956 (Atheros Static Turbo mode),
959 (Atheros Dynamic Turbo mode, or appended to ``st'' and ``dt'').
960 The full set of channel widths following a '/' are:
962 (5MHz aka quarter-rate channel),
964 (10MHz aka half-rate channel),
966 (20MHz mostly for use in specifying ht20),
969 (40MHz mostly for use in specifying ht40).
971 a 40MHz HT channel specification may include the location
972 of the extension channel by appending ``+'' or ``-'' for above and below,
973 respectively; e.g. ``2437:ht/40+'' specifies 40MHz wide HT operation
974 with the center channel at frequency 2437 and the extension channel above.
975 .It Cm country Ar name
976 Set the country code to use in calculating the regulatory constraints
978 In particular the set of available channels, how the wireless device
979 will operation on the channels, and the maximum transmit power that
980 can be used on a channel are defined by this setting.
981 Country/Region codes are specified as a 2-character abbreviation
982 defined by ISO 3166 or using a longer, but possibly ambiguous, spelling;
983 e.g. "ES" and "Spain".
984 The set of country codes are taken from /etc/regdomain.xml and can also
985 be viewed with the ``list countries'' request.
986 Note that not all devices support changing the country code from a default
987 setting; typically stored in EEPROM.
995 Enable Dynamic Frequency Selection (DFS) as specified in 802.11h.
996 DFS embodies several facilities including detection of overlapping
997 radar signals, dynamic transmit power control, and channel selection
998 according to a least-congested criteria.
999 DFS support is mandatory for some 5Ghz frequencies in certain
1000 locales (e.g. ETSI).
1001 By default DFS is enabled according to the regulatory definitions
1002 specified in /etc/regdomain.xml and the current country code, regdomain,
1004 Note the underlying device (and driver) must support radar detection
1005 for full DFS support to work.
1006 To be fully compliant with the local regulatory agency frequencies that
1007 require DFS should not be used unless it is fully supported.
1010 to disable this functionality for testing.
1012 Enable support for the 802.11d specification (default).
1013 When this support is enabled in station mode, beacon frames that advertise
1014 a country code different than the currently configured country code will
1015 cause an event to be dispatched to user applications.
1016 This event can be used by the station to adopt that country code and
1017 operate according to the associated regulatory constraints.
1018 When operating as an access point with 802.11d enabled the beacon and
1019 probe response frames transmitted will advertise the current regulatory
1021 To disable 802.11d use
1024 Enable 802.11h support including spectrum management.
1025 When 802.11h is enabled beacon and probe response frames will have
1026 the SpectrumMgt bit set in the capabilities field and
1027 country and power constraint information elements will be present.
1028 802.11h support also includes handling Channel Switch Announcements (CSA)
1029 which are a mechanism to coordinate channel changes by an access point.
1030 By default 802.11h is enabled if the device is capable.
1031 To disable 802.11h use
1033 .It Cm deftxkey Ar index
1034 Set the default key to use for transmission.
1035 Typically this is only set when using WEP encryption.
1036 Note that you must set a default transmit key
1037 for the system to know which key to use in encrypting outbound traffic.
1040 is an alias for this request; it is provided for backwards compatibility.
1041 .It Cm dtimperiod Ar period
1044 period for transmitting buffered multicast data frames when
1045 operating in ap mode.
1048 specifies the number of beacon intervals between DTIM
1049 and must be in the range 1 to 15.
1050 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
1052 Enable the use of Atheros Dynamic Turbo mode when communicating with
1053 another Dynamic Turbo-capable station.
1054 Dynamic Turbo mode is an Atheros-specific mechanism by which
1055 stations switch between normal 802.11 operation and a ``boosted''
1056 mode in which a 40MHz wide channel is used for communication.
1057 Stations using Dynamic Turbo mode operate boosted only when the
1058 channel is free of non-dturbo stations; when a non-dturbo station
1059 is identified on the channel all stations will automatically drop
1060 back to normal operation.
1061 By default, Dynamic Turbo mode is not enabled, even if the device is capable.
1062 Note that turbo mode (dynamic or static) is only allowed on some
1063 channels depending on the regulatory constraints; use the
1065 command to identify the channels where turbo mode may be used.
1066 To disable Dynamic Turbo mode use
1069 Enable Dynamic WDS (DWDS) support.
1070 DWDS is a facility by which 4-address traffic can be carried between
1071 stations operating in infrastructure mode.
1072 A station first associates to an access point and authenticates using
1073 normal procedures (e.g. WPA).
1074 Then 4-address frames are passed to carry traffic for stations
1075 operating on either side of the wireless link.
1076 DWDS extends the normal WDS mechanism by leveraging existing security
1077 protocols and eliminating static binding.
1079 When DWDS is enabled on an access point 4-address frames received from
1080 an authorized station will generate a ``DWDS discovery'' event to user
1082 This event should be used to create a WDS interface that is bound
1083 to the remote station (and usually plumbed into a bridge).
1084 Once the WDS interface is up and running 4-address traffic then logically
1085 flows through that interface.
1087 When DWDS is enabled on a station, traffic with a destination address
1088 different from the peer station are encapsulated in a 4-address frame
1089 and transmitted to the peer.
1090 All 4-address traffic uses the security information of the stations
1091 (e.g. cryptographic keys).
1092 A station is associated using 802.11n facilities may transport
1093 4-address traffic using these same mechanisms; this depends on available
1094 resources and capabilities of the device.
1095 The DWDS implementation guards against layer 2 routing loops of
1098 Enable the use of Atheros Fast Frames when communicating with
1099 another Fast Frames-capable station.
1100 Fast Frames are an encapsulation technique by which two 802.3
1101 frames are transmitted in a single 802.11 frame.
1102 This can noticeably improve throughput but requires that the
1103 receiving station understand how to decapsulate the frame.
1104 Fast frame use is negotiated using the Atheros 802.11 vendor-specific
1105 protocol extension so enabling use is safe when communicating with
1106 non-Atheros devices.
1107 By default, use of fast frames is enabled if the device is capable.
1108 To explicitly disable fast frames, use
1110 .It Cm fragthreshold Ar length
1111 Set the threshold for which transmitted frames are broken into fragments.
1114 argument is the frame size in bytes and must be in the range 256 to 2346.
1122 disables transmit fragmentation.
1123 Not all adapters honor the fragmentation threshold.
1125 When operating as an access point, do not broadcast the SSID
1126 in beacon frames or respond to probe request frames unless
1127 they are directed to the ap (i.e., they include the ap's SSID).
1128 By default, the SSID is included in beacon frames and
1129 undirected probe request frames are answered.
1130 To re-enable the broadcast of the SSID etc., use
1133 Enable use of High Throughput (HT) when using 802.11n (default).
1134 The 802.11n specification includes mechanisms for operation
1135 on 20MHz and 40MHz wide channels using different signalling mechanisms
1136 than specified in 802.11b, 802.11g, and 802.11a.
1137 Stations negotiate use of these facilities, termed HT20 and HT40,
1138 when they associate.
1139 To disable all use of 802.11n use
1141 To disable use of HT20 (e.g. to force only HT40 use) use
1143 To disable use of HT40 use
1146 HT configuration is used to ``auto promote'' operation
1147 when several choices are available.
1148 For example, if a station associates to an 11n-capable access point
1149 it controls whether the station uses legacy operation, HT20, or HT40.
1150 When an 11n-capable device is setup as an access point and
1151 Auto Channel Selection is used to locate a channel to operate on,
1152 HT configuration controls whether legacy, HT20, or HT40 operation is setup
1153 on the selected channel.
1154 If a fixed channel is specified for a station then HT configuration can
1155 be given as part of the channel specification; e.g. 6:ht/20 to setup
1156 HT20 operation on channel 6.
1158 Enable use of compatibility support for pre-802.11n devices (default).
1159 The 802.11n protocol specification went through several incompatible iterations.
1160 Some vendors implemented 11n support to older specifications that
1161 will not interoperate with a purely 11n-compliant station.
1162 In particular the information elements included in management frames
1163 for old devices are different.
1164 When compatibility support is enabled both standard and compatible data
1166 Stations that associate using the compatibility mechanisms are flagged
1168 To disable compatibility support use
1170 .It Cm htprotmode Ar technique
1171 For interfaces operating in 802.11n, use the specified
1173 for protecting HT frames in a mixed legacy/HT network.
1174 The set of valid techniques is
1179 Technique names are case insensitive.
1181 Enable inactivity processing for stations associated to an
1182 access point (default).
1183 When operating as an access point the 802.11 layer monitors
1184 the activity of each associated station.
1185 When a station is inactive for 5 minutes it will send several
1186 ``probe frames'' to see if the station is still present.
1187 If no response is received then the station is deauthenticated.
1188 Applications that prefer to handle this work can disable this
1192 Set the location to use in calculating regulatory constraints.
1193 The location is also advertised in beacon and probe response frames
1194 when 802.11d is enabled with
1203 Display the list of channels available for use taking into account
1204 any restrictions set with the
1207 See the description of
1209 for more information.
1211 Display the adaptor's capabilities, including the operating
1214 Display the list of channels available for use.
1215 Channels are shown with their IEEE channel number, equivalent
1216 frequency, and usage modes.
1217 Channels identified as
1222 Channels identified as
1224 may be used only for Atheros' Static Turbo mode
1226 . Cm mediaopt turbo ) .
1227 Channels marked with a
1229 have a regulatory constraint that they be passively scanned.
1230 This means a station is not permitted to transmit on the channel until
1231 it identifies the channel is being used for 802.11 communication;
1232 typically by hearing a beacon frame from an access point operating
1235 is another way of requesting this information.
1236 By default a compacted list of channels is displayed; if the
1238 option is specified then all channels are shown.
1239 .It Cm list countries
1240 Display the set of country codes and regulatory domains that can be
1241 used in regulatory configuration.
1243 Display the current MAC Access Control List state.
1244 Each address is prefixed with a character that indicates the
1245 current policy applied to it:
1247 indicates the address is allowed access,
1249 indicates the address is denied access,
1251 indicates the address is present but the current policy open
1252 (so the ACL is not consulted).
1254 Displays the mesh routing table, used for forwarding packets on a mesh
1256 .It Cm list regdomain
1257 Display the current regulatory settings including the available channels
1258 and transmit power caps.
1260 Display the parameters that govern roaming operation.
1262 Display the parameters that govern transmit operation.
1264 Display the transmit power caps for each channel.
1266 Display the access points and/or ad-hoc neighbors
1267 located in the vicinity.
1268 This information may be updated automatically by the adapter
1271 request or through background scanning.
1272 Depending on the capabilities of the stations the following
1273 flags can be included in the output:
1277 Indicates that the station is permitted to send/receive data frames.
1279 Extended Rate Phy (ERP).
1280 Indicates that the station is operating in an 802.11g network
1281 using extended transmit rates.
1283 High Throughput (HT).
1284 Indicates that the station is using HT transmit rates.
1285 If a `+' follows immediately after then the station associated
1286 using deprecated mechanisms supported only when
1291 Indicates that the station is operating in power save mode.
1293 Quality of Service (QoS).
1294 Indicates that the station is using QoS encapsulation for
1296 QoS encapsulation is enabled only when WME mode is enabled.
1299 Indicates that the station is doing short preamble to optionally
1300 improve throughput performance with 802.11g and 802.11b.
1302 Transitional Security Network (TSN).
1303 Indicates that the station associated using TSN; see also
1307 Wi-Fi Protected Setup (WPS).
1308 Indicates that the station associated using WPS.
1311 By default interesting information elements captured from the neighboring
1312 stations are displayed at the end of each row.
1313 Possible elements include:
1315 (station supports WME),
1317 (station supports WPA),
1319 (station supports WPS),
1321 (station supports 802.11i/RSN),
1323 (station supports 802.11n/HT communication),
1325 (station supports Atheros protocol extensions),
1327 (station supports unknown vendor-specific extensions).
1330 flag is used all the information elements and their
1331 contents will be shown.
1334 flag also enables display of long SSIDs.
1337 command is another way of requesting this information.
1339 When operating as an access point display the stations that are
1340 currently associated.
1341 When operating in ad-hoc mode display stations identified as
1342 neighbors in the IBSS.
1343 When operating in mesh mode display stations identified as
1344 neighbors in the MBSS.
1345 When operating in station mode display the access point.
1346 Capabilities advertised by the stations are described under
1350 Depending on the capabilities of the stations the following
1351 flags can be included in the output:
1355 Indicates that the station is permitted to send/receive data frames.
1357 Extended Rate Phy (ERP).
1358 Indicates that the station is operating in an 802.11g network
1359 using extended transmit rates.
1361 High Throughput (HT).
1362 Indicates that the station is using HT transmit rates.
1363 If a `+' follows immediately after then the station associated
1364 using deprecated mechanisms supported only when
1369 Indicates that the station is operating in power save mode.
1371 Quality of Service (QoS).
1372 Indicates that the station is using QoS encapsulation for
1374 QoS encapsulation is enabled only when WME mode is enabled.
1377 Indicates that the station is doing short preamble to optionally
1378 improve throughput performance with 802.11g and 802.11b.
1380 Transitional Security Network (TSN).
1381 Indicates that the station associated using TSN; see also
1385 Wi-Fi Protected Setup (WPS).
1386 Indicates that the station associated using WPS.
1389 By default information elements received from associated stations
1390 are displayed in a short form; the
1392 flag causes this information to be displayed symbolically.
1394 Display the current channel parameters to use when operating in WME mode.
1397 option is specified then both channel and BSS parameters are displayed
1398 for each AC (first channel, then BSS).
1399 When WME mode is enabled for an adaptor this information will be
1400 displayed with the regular status; this command is mostly useful
1401 for examining parameters when WME mode is disabled.
1402 See the description of the
1404 directive for information on the various parameters.
1405 .It Cm maxretry Ar count
1406 Set the maximum number of tries to use in sending unicast frames.
1407 The default setting is 6 but drivers may override this with a value
1409 .It Cm mcastrate Ar rate
1410 Set the rate for transmitting multicast/broadcast frames.
1411 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
1412 This rate should be valid for the current operating conditions;
1413 if an invalid rate is specified drivers are free to chose an
1415 .It Cm mgtrate Ar rate
1416 Set the rate for transmitting management and/or control frames.
1417 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
1419 Set the location to use in calculating regulatory constraints.
1420 The location is also advertised in beacon and probe response frames
1421 when 802.11d is enabled with
1430 Enable powersave operation.
1431 When operating as a client, the station will conserve power by
1432 periodically turning off the radio and listening for
1433 messages from the access point telling it there are packets waiting.
1434 The station must then retrieve the packets.
1435 Not all devices support power save operation as a client.
1436 The 802.11 specification requires that all access points support
1437 power save but some drivers do not.
1440 to disable powersave operation when operating as a client.
1441 .It Cm powersavesleep Ar sleep
1442 Set the desired max powersave sleep time in TU's (1024 usecs).
1443 By default the max powersave sleep time is 100 TU's.
1444 .It Cm protmode Ar technique
1445 For interfaces operating in 802.11g, use the specified
1447 for protecting OFDM frames in a mixed 11b/11g network.
1448 The set of valid techniques is
1454 Technique names are case insensitive.
1455 Not all devices support
1457 as a protection technique.
1459 When operating as an access point in 802.11g mode allow only
1460 11g-capable stations to associate (11b-only stations are not
1461 permitted to associate).
1462 To allow both 11g and 11b-only stations to associate, use
1465 When operating as an access point in 802.11n mode allow only
1466 HT-capable stations to associate (legacy stations are not
1467 permitted to associate).
1468 To allow both HT and legacy stations to associate, use
1470 .It Cm regdomain Ar sku
1471 Set the regulatory domain to use in calculating the regulatory constraints
1473 In particular the set of available channels, how the wireless device
1474 will operation on the channels, and the maximum transmit power that
1475 can be used on a channel are defined by this setting.
1476 Regdomain codes (SKU's) are taken from /etc/regdomain.xml and can also
1477 be viewed with the ``list countries'' request.
1478 Note that not all devices support changing the regdomain from a default
1479 setting; typically stored in EEPROM.
1487 Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n
1489 Note that RIFS must be supported by both the station and access point
1493 .It Cm roam:rate Ar rate
1494 Set the threshold for controlling roaming when operating in a BSS.
1497 parameter specifies the transmit rate in megabits
1498 at which roaming should be considered.
1499 If the current transmit rate drops below this setting and background scanning
1500 is enabled, then the system will check if a more desirable access point is
1501 available and switch over to it.
1502 The current scan cache contents are used if they are considered
1503 valid according to the
1505 parameter; otherwise a background scan operation is triggered before
1506 any selection occurs.
1507 Each channel type has a separate rate threshold; the default values are:
1508 12 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng).
1509 .It Cm roam:rssi Ar rssi
1510 Set the threshold for controlling roaming when operating in a BSS.
1513 parameter specifies the receive signal strength in dBm units
1514 at which roaming should be considered.
1515 If the current rssi drops below this setting and background scanning
1516 is enabled, then the system will check if a more desirable access point is
1517 available and switch over to it.
1518 The current scan cache contents are used if they are considered
1519 valid according to the
1521 parameter; otherwise a background scan operation is triggered before
1522 any selection occurs.
1523 Each channel type has a separate rssi threshold; the default values are
1525 .It Cm roaming Ar mode
1526 When operating as a station, control how the system will
1527 behave when communication with the current access point
1531 argument may be one of
1533 (leave it to the hardware device to decide),
1535 (handle either in the device or the operating system\[em]as appropriate),
1537 (do nothing until explicitly instructed).
1538 By default, the device is left to handle this if it is
1539 capable; otherwise, the operating system will automatically
1540 attempt to reestablish communication.
1541 Manual mode is used by applications such as
1542 .Xr wpa_supplicant 8
1543 that want to control the selection of an access point.
1544 .It Cm rtsthreshold Ar length
1545 Set the threshold for which
1546 transmitted frames are preceded by transmission of an
1552 is the frame size in bytes and must be in the range 1 to 2346.
1560 disables transmission of RTS frames.
1561 Not all adapters support setting the RTS threshold.
1563 Initiate a scan of neighboring stations, wait for it to complete, and
1564 display all stations found.
1565 Only the super-user can initiate a scan.
1568 for information on the display.
1569 By default a background scan is done; otherwise a foreground
1570 scan is done and the station may roam to a different access point.
1573 request can be used to show recent scan results without
1574 initiating a new scan.
1575 .It Cm scanvalid Ar threshold
1576 Set the maximum time the scan cache contents are considered valid;
1577 i.e. will be used without first triggering a scan operation to
1581 parameter is specified in seconds and defaults to 60 seconds.
1582 The minimum setting for
1585 One should take care setting this threshold; if it is set too low
1586 then attempts to roam to another access point may trigger unnecessary
1587 background scan operations.
1589 Enable use of Short Guard Interval when operating in 802.11n
1591 NB: this currently enables Short GI on both HT40 and HT20 channels.
1592 To disable Short GI use
1595 Enable use of Static Spatial Multiplexing Power Save (SMPS)
1596 when operating in 802.11n.
1597 A station operating with Static SMPS maintains only a single
1598 receive chain active (this can significantly reduce power consumption).
1602 Enable use of Dynamic Spatial Multiplexing Power Save (SMPS)
1603 when operating in 802.11n.
1604 A station operating with Dynamic SMPS maintains only a single
1605 receive chain active but switches to multiple receive chains when it
1606 receives an RTS frame (this can significantly reduce power consumption).
1607 Note that stations cannot distinguish between RTS/CTS intended to
1608 enable multiple receive chains and those used for other purposes.
1612 Set the desired Service Set Identifier (aka network name).
1613 The SSID is a string up to 32 characters
1614 in length and may be specified as either a normal string or in
1615 hexadecimal when preceded by
1617 Additionally, the SSID may be cleared by setting it to
1619 .It Cm tdmaslot Ar slot
1620 When operating with TDMA, use the specified
1625 is a number between 0 and the maximum number of slots in the BSS.
1626 Note that a station configured as slot 0 is a master and
1627 will broadcast beacon frames advertising the BSS;
1628 stations configured to use other slots will always
1629 scan to locate a master before they ever transmit.
1633 .It Cm tdmaslotcnt Ar cnt
1634 When operating with TDMA, setup a BSS with
1637 The slot count may be at most 8.
1638 The current implementation is only tested with two stations
1639 (i.e. point to point applications).
1640 This setting is only meaningful when a station is configured as slot 0;
1641 other stations adopt this setting from the BSS they join.
1645 .It Cm tdmaslotlen Ar len
1646 When operating with TDMA, setup a BSS such that each station has a slot
1649 The slot length must be at least 150 microseconds (1/8 TU)
1650 and no more than 65 milliseconds.
1651 Note that setting too small a slot length may result in poor channel
1652 bandwidth utilization due to factors such as timer granularity and
1654 This setting is only meaningful when a station is configured as slot 0;
1655 other stations adopt this setting from the BSS they join.
1658 is set to 10 milliseconds.
1659 .It Cm tdmabintval Ar intval
1660 When operating with TDMA, setup a BSS such that beacons are transmitted every
1662 superframes to synchronize the TDMA slot timing.
1663 A superframe is defined as the number of slots times the slot length; e.g.
1664 a BSS with two slots of 10 milliseconds has a 20 millisecond superframe.
1665 The beacon interval may not be zero.
1668 causes the timers to be resynchronized more often; this can be help if
1669 significant timer drift is observed.
1674 When operating as an access point with WPA/802.11i allow legacy
1675 stations to associate using static key WEP and open authentication.
1676 To disallow legacy station use of WEP, use
1678 .It Cm txpower Ar power
1679 Set the power used to transmit frames.
1682 argument is specified in .5 dBm units.
1683 Out of range values are truncated.
1684 Typically only a few discreet power settings are available and
1685 the driver will use the setting closest to the specified value.
1686 Not all adapters support changing the transmit power.
1687 .It Cm ucastrate Ar rate
1688 Set a fixed rate for transmitting unicast frames.
1689 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
1690 This rate should be valid for the current operating conditions;
1691 if an invalid rate is specified drivers are free to chose an
1693 .It Cm wepmode Ar mode
1694 Set the desired WEP mode.
1695 Not all adapters support all modes.
1696 The set of valid modes is
1702 mode explicitly tells the adaptor to allow association with access
1703 points which allow both encrypted and unencrypted traffic.
1706 means that the access point must only allow encrypted connections.
1709 is generally another name for
1711 Modes are case insensitive.
1712 .It Cm weptxkey Ar index
1713 Set the WEP key to be used for transmission.
1714 This is the same as setting the default transmission key with
1716 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
1717 Set the selected WEP key.
1720 is not given, key 1 is set.
1721 A WEP key will be either 5 or 13
1722 characters (40 or 104 bits) depending on the local network and the
1723 capabilities of the adaptor.
1724 It may be specified either as a plain
1725 string or as a string of hexadecimal digits preceded by
1727 For maximum portability, hex keys are recommended;
1728 the mapping of text keys to WEP encryption is usually driver-specific.
1731 drivers do this mapping differently to
1733 A key may be cleared by setting it to
1735 If WEP is supported then there are at least four keys.
1736 Some adapters support more than four keys.
1737 If that is the case, then the first four keys
1738 (1-4) will be the standard temporary keys and any others will be adaptor
1739 specific keys such as permanent keys stored in NVRAM.
1741 Note that you must set a default transmit key with
1743 for the system to know which key to use in encrypting outbound traffic.
1745 Enable Wireless Multimedia Extensions (WME) support, if available,
1746 for the specified interface.
1747 WME is a subset of the IEEE 802.11e standard to support the
1748 efficient communication of realtime and multimedia data.
1749 To disable WME support, use
1751 Another name for this parameter is
1754 The following parameters are meaningful only when WME support is in use.
1755 Parameters are specified per-AC (Access Category) and
1756 split into those that are used by a station when acting
1757 as an access point and those for client stations in the BSS.
1758 The latter are received from the access point and may not be changed
1760 The following Access Categories are recognized:
1762 .Bl -tag -width ".Cm AC_BK" -compact
1766 best effort delivery,
1781 AC parameters are case-insensitive.
1782 Traffic classification is done in the operating system using the
1783 vlan priority associated with data frames or the
1784 ToS (Type of Service) indication in IP-encapsulated frames.
1785 If neither information is present, traffic is assigned to the
1786 Best Effort (BE) category.
1787 .Bl -tag -width indent
1789 Set the ACK policy for QoS transmissions by the local station;
1790 this controls whether or not data frames transmitted by a station
1791 require an ACK response from the receiving station.
1792 To disable waiting for an ACK use
1794 This parameter is applied only to the local station.
1796 Enable the Admission Control Mandatory (ACM) mechanism
1797 for transmissions by the local station.
1798 To disable the ACM use
1800 On stations in a BSS this parameter is read-only and indicates
1801 the setting received from the access point.
1802 NB: ACM is not supported right now.
1803 .It Cm aifs Ar ac Ar count
1804 Set the Arbitration Inter Frame Spacing (AIFS)
1805 channel access parameter to use for transmissions
1806 by the local station.
1807 On stations in a BSS this parameter is read-only and indicates
1808 the setting received from the access point.
1809 .It Cm cwmin Ar ac Ar count
1810 Set the CWmin channel access parameter to use for transmissions
1811 by the local station.
1812 On stations in a BSS this parameter is read-only and indicates
1813 the setting received from the access point.
1814 .It Cm cwmax Ar ac Ar count
1815 Set the CWmax channel access parameter to use for transmissions
1816 by the local station.
1817 On stations in a BSS this parameter is read-only and indicates
1818 the setting received from the access point.
1819 .It Cm txoplimit Ar ac Ar limit
1820 Set the Transmission Opportunity Limit channel access parameter
1821 to use for transmissions by the local station.
1822 This parameter defines an interval of time when a WME station
1823 has the right to initiate transmissions onto the wireless medium.
1824 On stations in a BSS this parameter is read-only and indicates
1825 the setting received from the access point.
1826 .It Cm bss:aifs Ar ac Ar count
1827 Set the AIFS channel access parameter to send to stations in a BSS.
1828 This parameter is meaningful only when operating in ap mode.
1829 .It Cm bss:cwmin Ar ac Ar count
1830 Set the CWmin channel access parameter to send to stations in a BSS.
1831 This parameter is meaningful only when operating in ap mode.
1832 .It Cm bss:cwmax Ar ac Ar count
1833 Set the CWmax channel access parameter to send to stations in a BSS.
1834 This parameter is meaningful only when operating in ap mode.
1835 .It Cm bss:txoplimit Ar ac Ar limit
1836 Set the TxOpLimit channel access parameter to send to stations in a BSS.
1837 This parameter is meaningful only when operating in ap mode.
1840 Enable Wireless Privacy Subscriber support.
1841 Note that WPS support requires a WPS-capable supplicant.
1842 To disable this function use
1846 The following parameters support an optional access control list
1847 feature available with some adapters when operating in ap mode; see
1849 This facility allows an access point to accept/deny association
1850 requests based on the MAC address of the station.
1851 Note that this feature does not significantly enhance security
1852 as MAC address spoofing is easy to do.
1853 .Bl -tag -width indent
1854 .It Cm mac:add Ar address
1855 Add the specified MAC address to the database.
1856 Depending on the policy setting association requests from the
1857 specified station will be allowed or denied.
1859 Set the ACL policy to permit association only by
1860 stations registered in the database.
1861 .It Cm mac:del Ar address
1862 Delete the specified MAC address from the database.
1864 Set the ACL policy to deny association only by
1865 stations registered in the database.
1866 .It Cm mac:kick Ar address
1867 Force the specified station to be deauthenticated.
1868 This typically is done to block a station after updating the
1871 Set the ACL policy to allow all stations to associate.
1873 Delete all entries in the database.
1875 Set the ACL policy to permit association only by
1876 stations approved by a RADIUS server.
1877 Note that this feature requires the
1879 program be configured to do the right thing
1880 as it handles the RADIUS processing
1881 (and marks stations as authorized).
1884 The following parameters are related to a wireless interface operating in mesh
1886 .Bl -tag -width indent
1887 .It Cm meshid Ar meshid
1888 Set the desired Mesh Identifier.
1889 The Mesh ID is a string up to 32 characters in length.
1890 A mesh interface must have a Mesh Identifier specified
1891 to reach an operational state.
1892 .It Cm meshttl Ar ttl
1893 Set the desired ``time to live'' for mesh forwarded packets;
1894 this is the number of hops a packet may be forwarded before
1896 The default setting for
1900 Enable or disable peering with neighbor mesh stations.
1901 Stations must peer before any data packets can be exchanged.
1906 Enable or disable forwarding packets by a mesh interface.
1910 .It Cm meshmetric Ar protocol
1913 as the link metric protocol used on a mesh network.
1914 The default protocol is called
1916 The mesh interface will restart after changing this setting.
1917 .It Cm meshpath Ar protocol
1920 as the path selection protocol used on a mesh network.
1921 The only available protocol at the moment is called
1923 (Hybrid Wireless Mesh Protocol).
1924 The mesh interface will restart after changing this setting.
1925 .It Cm hwmprootmode Ar mode
1926 Stations on a mesh network can operate as ``root nodes.''
1927 Root nodes try to find paths to all mesh nodes and advertise themselves
1929 When there is a root mesh node on a network, other mesh nodes can setup
1930 paths between themselves faster because they can use the root node
1931 to find the destination.
1932 This path may not be the best, but on-demand
1933 routing will eventually find the best path.
1934 The following modes are recognized:
1936 .Bl -tag -width ".Cm PROACTIVE" -compact
1940 Send broadcast path requests every two seconds.
1941 Nodes on the mesh without a path to this root mesh station with try to
1942 discover a path to us.
1944 Send broadcast path requests every two seconds and every node must reply with
1945 with a path reply even if it already has a path to this root mesh station.
1947 Send broadcast root announcement (RANN) frames.
1948 Nodes on the mesh without a path to this root mesh station with try to
1949 discover a path to us.
1955 .It Cm hwmpmaxhops Ar cnt
1956 Set the maximum number of hops allowed in an HMWP path to
1958 The default setting for
1963 The following parameters are for compatibility with other systems:
1964 .Bl -tag -width indent
1966 Another name for the
1972 .It Cm stationname Ar name
1973 Set the name of this station.
1974 The station name is not part of the IEEE 802.11
1975 protocol though some interfaces support it.
1977 seems to be meaningful to identical or virtually identical equipment.
1978 Setting the station name is identical in syntax to setting the SSID.
1985 Another way of saying
1991 Another way of saying
1997 Another way of saying:
1998 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
2004 .Ar n : k1 , k2 , k3 , k4
2007 Another way of saying
2008 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
2013 Another way of saying
2020 The following parameters are specific to bridge interfaces:
2021 .Bl -tag -width indent
2022 .It Cm addm Ar interface
2023 Add the interface named by
2025 as a member of the bridge.
2026 The interface is put into promiscuous mode
2027 so that it can receive every packet sent on the network.
2028 .It Cm deletem Ar interface
2029 Remove the interface named by
2032 Promiscuous mode is disabled on the interface when
2033 it is removed from the bridge.
2034 .It Cm maxaddr Ar size
2035 Set the size of the bridge address cache to
2037 The default is 100 entries.
2038 .It Cm timeout Ar seconds
2039 Set the timeout of address cache entries to
2044 is zero, then address cache entries will not be expired.
2045 The default is 240 seconds.
2047 Display the addresses that have been learned by the bridge.
2048 .It Cm static Ar interface-name Ar address
2049 Add a static entry into the address cache pointing to
2050 .Ar interface-name .
2051 Static entries are never aged out of the cache or re-placed, even if the
2052 address is seen on a different interface.
2053 .It Cm deladdr Ar address
2056 from the address cache.
2058 Delete all dynamically-learned addresses from the address cache.
2060 Delete all addresses, including static addresses, from the address cache.
2061 .It Cm discover Ar interface
2062 Mark an interface as a
2065 When the bridge has no address cache entry
2066 (either dynamic or static)
2067 for the destination address of a packet,
2068 the bridge will forward the packet to all
2069 member interfaces marked as
2071 This is the default for all interfaces added to a bridge.
2072 .It Cm -discover Ar interface
2075 attribute on a member interface.
2076 For packets without the
2078 attribute, the only packets forwarded on the interface are broadcast
2079 or multicast packets and packets for which the destination address
2080 is known to be on the interface's segment.
2081 .It Cm learn Ar interface
2082 Mark an interface as a
2085 When a packet arrives on such an interface, the source
2086 address of the packet is entered into the address cache as being a
2087 destination address on the interface's segment.
2088 This is the default for all interfaces added to a bridge.
2089 .It Cm -learn Ar interface
2092 attribute on a member interface.
2093 .It Cm sticky Ar interface
2094 Mark an interface as a
2097 Dynamically learned address entries are treated at static once entered into
2099 Sticky entries are never aged out of the cache or replaced, even if the
2100 address is seen on a different interface.
2101 .It Cm -sticky Ar interface
2104 attribute on a member interface.
2105 .It Cm private Ar interface
2106 Mark an interface as a
2109 A private interface does not forward any traffic to any other port that is also
2110 a private interface.
2111 .It Cm -private Ar interface
2114 attribute on a member interface.
2115 .It Cm span Ar interface
2116 Add the interface named by
2118 as a span port on the bridge.
2119 Span ports transmit a copy of every frame received by the bridge.
2120 This is most useful for snooping a bridged network passively on
2121 another host connected to one of the span ports of the bridge.
2122 .It Cm -span Ar interface
2123 Delete the interface named by
2125 from the list of span ports of the bridge.
2126 .It Cm stp Ar interface
2127 Enable Spanning Tree protocol on
2131 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
2132 Spanning Tree is used to detect and remove loops in a network topology.
2133 .It Cm -stp Ar interface
2134 Disable Spanning Tree protocol on
2136 This is the default for all interfaces added to a bridge.
2137 .It Cm edge Ar interface
2141 An edge port connects directly to end stations cannot create bridging
2142 loops in the network, this allows it to transition straight to forwarding.
2143 .It Cm -edge Ar interface
2144 Disable edge status on
2146 .It Cm autoedge Ar interface
2149 to automatically detect edge status.
2150 This is the default for all interfaces added to a bridge.
2151 .It Cm -autoedge Ar interface
2152 Disable automatic edge status on
2154 .It Cm ptp Ar interface
2157 as a point to point link.
2158 This is required for straight transitions to forwarding and
2159 should be enabled on a direct link to another RSTP capable switch.
2160 .It Cm -ptp Ar interface
2161 Disable point to point link status on
2163 This should be disabled for a half duplex link and for an interface
2164 connected to a shared network segment,
2165 like a hub or a wireless network.
2166 .It Cm autoptp Ar interface
2167 Automatically detect the point to point status on
2169 by checking the full duplex link status.
2170 This is the default for interfaces added to the bridge.
2171 .It Cm -autoptp Ar interface
2172 Disable automatic point to point link detection on
2174 .It Cm maxage Ar seconds
2175 Set the time that a Spanning Tree protocol configuration is valid.
2176 The default is 20 seconds.
2177 The minimum is 6 seconds and the maximum is 40 seconds.
2178 .It Cm fwddelay Ar seconds
2179 Set the time that must pass before an interface begins forwarding
2180 packets when Spanning Tree is enabled.
2181 The default is 15 seconds.
2182 The minimum is 4 seconds and the maximum is 30 seconds.
2183 .It Cm hellotime Ar seconds
2184 Set the time between broadcasting of Spanning Tree protocol
2185 configuration messages.
2186 The hello time may only be changed when operating in legacy stp mode.
2187 The default is 2 seconds.
2188 The minimum is 1 second and the maximum is 2 seconds.
2189 .It Cm priority Ar value
2190 Set the bridge priority for Spanning Tree.
2191 The default is 32768.
2192 The minimum is 0 and the maximum is 61440.
2193 .It Cm proto Ar value
2194 Set the Spanning Tree protocol.
2195 The default is rstp.
2196 The available options are stp and rstp.
2197 .It Cm holdcnt Ar value
2198 Set the transmit hold count for Spanning Tree.
2199 This is the number of packets transmitted before being rate limited.
2201 The minimum is 1 and the maximum is 10.
2202 .It Cm ifpriority Ar interface Ar value
2203 Set the Spanning Tree priority of
2208 The minimum is 0 and the maximum is 240.
2209 .It Cm ifpathcost Ar interface Ar value
2210 Set the Spanning Tree path cost of
2214 The default is calculated from the link speed.
2215 To change a previously selected path cost back to automatic, set the
2217 The minimum is 1 and the maximum is 200000000.
2218 .It Cm ifmaxaddr Ar interface Ar size
2219 Set the maximum number of hosts allowed from an interface, packets with unknown
2220 source addresses are dropped until an existing host cache entry expires or is
2222 Set to 0 to disable.
2225 The following parameters are specific to lagg interfaces:
2226 .Bl -tag -width indent
2227 .It Cm laggport Ar interface
2228 Add the interface named by
2230 as a port of the aggregation interface.
2231 .It Cm -laggport Ar interface
2232 Remove the interface named by
2234 from the aggregation interface.
2235 .It Cm laggproto Ar proto
2236 Set the aggregation protocol.
2237 The default is failover.
2238 The available options are failover, fec, lacp, loadbalance, roundrobin and
2242 The following parameters are specific to IP tunnel interfaces,
2244 .Bl -tag -width indent
2245 .It Cm tunnel Ar src_addr dest_addr
2246 Configure the physical source and destination address for IP tunnel
2252 are interpreted as the outer source/destination for the encapsulating
2255 Unconfigure the physical source and destination address for IP tunnel
2256 interfaces previously configured with
2259 Another name for the
2262 .It Cm accept_rev_ethip_ver
2263 Set a flag to accept both correct EtherIP packets and ones
2264 with reversed version field. Enabled by default.
2265 This is for backward compatibility with
2267 6.2, 6.3, 7.0, and 7.1.
2268 .It Cm -accept_rev_ethip_ver
2270 .Cm accept_rev_ethip_ver .
2271 .It Cm send_rev_ethip_ver
2272 Set a flag to send EtherIP packets with reversed version
2273 field intentionally. Disabled by default.
2274 This is for backward compatibility with
2276 6.2, 6.3, 7.0, and 7.1.
2277 .It Cm -send_rev_ethip_ver
2279 .Cm send_rev_ethip_ver .
2282 The following parameters are specific to GRE tunnel interfaces,
2284 .Bl -tag -width indent
2285 .It Cm grekey Ar key
2286 Configure the GRE key to be used for outgoing packets.
2288 .Xr gre 4 will always accept GRE packets with invalid or absent keys.
2289 This command will result in a four byte MTU reduction on the interface.
2292 The following parameters are specific to
2295 .Bl -tag -width indent
2297 Set the maximum number of updates for a single state which
2298 can be collapsed into one.
2299 This is an 8-bit number; the default value is 128.
2302 The following parameters are specific to
2305 .Bl -tag -width indent
2306 .It Cm vlan Ar vlan_tag
2307 Set the VLAN tag value to
2309 This value is a 16-bit number which is used to create an 802.1Q
2310 VLAN header for packets sent from the
2317 must both be set at the same time.
2318 .It Cm vlandev Ar iface
2319 Associate the physical interface
2324 Packets transmitted through the
2327 diverted to the specified physical interface
2329 with 802.1Q VLAN encapsulation.
2330 Packets with 802.1Q encapsulation received
2331 by the parent interface with the correct VLAN tag will be diverted to
2337 interface is assigned a
2338 copy of the parent interface's flags and the parent's ethernet address.
2343 must both be set at the same time.
2346 interface already has
2347 a physical interface associated with it, this command will fail.
2349 change the association to another physical interface, the existing
2350 association must be cleared first.
2352 Note: if the hardware tagging capability
2353 is set on the parent interface, the
2356 interface's behavior changes:
2359 interface recognizes that the
2360 parent interface supports insertion and extraction of VLAN tags on its
2361 own (usually in firmware) and that it should pass packets to and from
2362 the parent unaltered.
2363 .It Fl vlandev Op Ar iface
2366 pseudo device, disassociate the parent interface from it.
2367 This breaks the link between the
2369 interface and its parent,
2370 clears its VLAN tag, flags and its link address and shuts the interface down.
2373 argument is useless and hence deprecated.
2376 The following parameters are specific to
2379 .Bl -tag -width indent
2380 .It Cm advbase Ar seconds
2381 Specifies the base of the advertisement interval in seconds.
2382 The acceptable values are 1 to 255.
2383 The default value is 1.
2384 .\" The default value is
2385 .\" .Dv CARP_DFLTINTV .
2386 .It Cm advskew Ar interval
2387 Specifies the skew to add to the base advertisement interval to
2388 make one host advertise slower than another host.
2389 It is specified in 1/256 of seconds.
2390 The acceptable values are 1 to 254.
2391 The default value is 0.
2392 .It Cm pass Ar phrase
2393 Set the authentication key to
2396 Set the virtual host ID.
2397 This is a required setting.
2398 Acceptable values are 1 to 255.
2403 utility displays the current configuration for a network interface
2404 when no optional parameters are supplied.
2405 If a protocol family is specified,
2407 will report only the details specific to that protocol family.
2411 flag is passed before an interface name,
2413 will display the capability list and all
2414 of the supported media for the specified interface.
2417 flag is supplied, address lifetime is displayed for IPv6 addresses,
2418 as time offset string.
2422 flag may be used instead of an interface name.
2425 to display information about all interfaces in the system.
2428 flag limits this to interfaces that are down, and
2430 limits this to interfaces that are up.
2431 When no arguments are given,
2437 flag may be used to list all available interfaces on the system, with
2438 no other additional information.
2439 Use of this flag is mutually exclusive
2440 with all other flags and commands, except for
2442 (only list interfaces that are down)
2445 (only list interfaces that are up).
2449 flag may be used to get more verbose status for an interface.
2453 flag may be used to list all of the interface cloners available on
2454 the system, with no additional information.
2455 Use of this flag is mutually exclusive with all other flags and commands.
2459 flag causes keying information for the interface, if available, to be
2461 For example, the values of 802.11 WEP keys will be printed, if accessible to
2463 This information is not printed by default, as it may be considered
2466 If the network interface driver is not present in the kernel then
2468 will attempt to load it.
2471 flag disables this behavior.
2473 Only the super-user may modify the configuration of a network interface.
2475 The media selection system is relatively new and only some drivers support
2476 it (or have need for it).
2478 Assign the IPv4 address
2480 with a network mask of
2484 .Dl # ifconfig fxp0 inet 192.0.2.10 netmask 255.255.255.0
2486 Add the IPv4 address
2488 with the CIDR network prefix
2494 as a synonym for the canonical form of the option
2496 .Dl # ifconfig ed0 inet 192.0.2.45/28 add
2498 Remove the IPv4 address
2502 .Dl # ifconfig ed0 inet 192.0.2.45 -alias
2504 Enable IPv6 functionality of the interface:
2505 .Dl # ifconfig em0 inet6 -ifdisabled
2507 Add the IPv6 address
2508 .Li 2001:DB8:DBDB::123/48
2511 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias
2512 Note that lower case hexadecimal IPv6 addresses are acceptable.
2514 Remove the IPv6 address added in the above example,
2517 character as shorthand for the network prefix,
2520 as a synonym for the canonical form of the option
2522 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 delete
2524 Configure the interface
2526 to use 100baseTX, full duplex Ethernet media options:
2527 .Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex
2529 Label the em0 interface as an uplink:
2531 .Dl # ifconfig em0 description \&"Uplink to Gigabit Switch 2\&"
2533 Create the software network interface
2535 .Dl # ifconfig gif1 create
2537 Destroy the software network interface
2539 .Dl # ifconfig gif1 destroy
2541 Messages indicating the specified interface does not exist, the
2542 requested address is unknown, or the user is not privileged and
2543 tried to alter an interface's configuration.
2563 Basic IPv6 node operation requires a link-local address on each
2564 interface configured for IPv6.
2565 Normally, such an address is automatically configured by the
2566 kernel on each interface added to the system or enabled; this behavior may
2567 be disabled by setting per-interface flag
2568 .Cm -auto_linklocal .
2569 The default value of this flag is 1 and can be disabled by using the sysctl
2571 .Va net.inet6.ip6.auto_linklocal .
2573 Do not configure IPv6 addresses with no link-local address by using
2575 It can result in unexpected behaviors of the kernel.