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 Neightbor Discovery Protocol:
608 .Bl -tag -width indent
610 Set a flag to enable accepting ICMPv6 Router Advertisement messages.
615 Set the specified interface as the default route when there is no
621 Set a flag to disable all of IPv6 network communications on the
627 Set a flag to enable Neighbor Unreachability Detection.
632 Set a flag to prefer addesses on the interface as candidates of the
633 source address for outgoing packets.
634 .It Cm -prefer_source
639 The following parameters are specific to cloning
640 IEEE 802.11 wireless interfaces with the
643 .Bl -tag -width indent
644 .It Cm wlandev Ar device
647 as the parent for the cloned device.
648 .It Cm wlanmode Ar mode
649 Specify the operating mode for this cloned device.
667 The operating mode of a cloned interface cannot be changed.
670 mode is actually implemented as an
672 interface with special properties.
673 .It Cm wlanbssid Ar bssid
674 The 802.11 mac address to use for the bssid.
675 This must be specified at create time for a legacy
678 .It Cm wlanaddr Ar address
679 The local mac address.
680 If this is not specified then a mac address will automatically be assigned
681 to the cloned device.
682 Typically this address is the same as the address of the parent device
685 parameter is specified then the driver will craft a unique address for
686 the device (if supported).
690 device as operating in ``legacy mode''.
693 devices have a fixed peer relationship and do not, for example, roam
694 if their peer stops communicating.
695 For completeness a Dynamic WDS (DWDS) interface may marked as
698 Request a unique local mac address for the cloned device.
699 This is only possible if the device supports multiple mac addresses.
700 To force use of the parent's mac address use
703 Mark the cloned interface as depending on hardware support to
704 track received beacons.
705 To have beacons tracked in software use
711 can also be used to indicate no beacons should
712 be transmitted; this can be useful when creating a WDS configuration but
714 interfaces can only be created as companions to an access point.
717 The following parameters are specific to IEEE 802.11 wireless interfaces
721 .Bl -tag -width indent
723 Enable sending and receiving AMPDU frames when using 802.11n (default).
724 The 802.11n specification states a compliant station must be capable
725 of receiving AMPDU frames but transmision is optional.
728 to disable all use of AMPDU with 802.11n.
729 For testing and/or to work around interoperability problems one can use
733 to control use of AMPDU in one direction.
734 .It Cm ampdudensity Ar density
735 Set the AMPDU density parameter used when operating with 802.11n.
736 This parameter controls the inter-packet gap for AMPDU frames.
737 The sending device normally controls this setting but a receiving station
738 may request wider gaps.
741 are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds).
744 is treated the same as 0.
745 .It Cm ampdulimit Ar limit
746 Set the limit on packet size for receiving AMPDU frames when operating
750 are 8192, 16384, 32768, and 65536 but one can also specify
751 just the unique prefix: 8, 16, 32, 64.
752 Note the sender may limit the size of AMPDU frames to be less
753 than the maximum specified by the receiving station.
755 Enable sending and receiving AMSDU frames when using 802.11n.
756 By default AMSDU is received but not transmitted.
759 to disable all use of AMSDU with 802.11n.
760 For testing and/or to work around interoperability problems one can use
764 to control use of AMSDU in one direction.
765 .It Cm amsdulimit Ar limit
766 Set the limit on packet size for sending and receiving AMSDU frames
767 when operating with 802.11n.
770 are 7935 and 3839 (bytes).
771 Note the sender may limit the size of AMSDU frames to be less
772 than the maximum specified by the receiving station.
773 Note also that devices are not required to support the 7935 limit,
774 only 3839 is required by the specification and the larger value
775 may require more memory to be dedicated to support functionality
778 When operating as an access point, pass packets between
779 wireless clients directly (default).
780 To instead let them pass up through the
781 system and be forwarded using some other mechanism, use
783 Disabling the internal bridging
784 is useful when traffic is to be processed with
786 .It Cm authmode Ar mode
787 Set the desired authentication mode in infrastructure mode.
788 Not all adapters support all modes.
791 .Cm none , open , shared
797 (IEEE WPA/WPA2/802.11i).
802 modes are only useful when using an authentication service
803 (a supplicant for client operation or an authenticator when
804 operating as an access point).
805 Modes are case insensitive.
807 Enable background scanning when operating as a station.
808 Background scanning is a technique whereby a station associated to
809 an access point will temporarily leave the channel to scan for
810 neighboring stations.
811 This allows a station to maintain a cache of nearby access points
812 so that roaming between access points can be done without
813 a lengthy scan operation.
814 Background scanning is done only when a station is not busy and
815 any outbound traffic will cancel a scan operation.
816 Background scanning should never cause packets to be lost though
817 there may be some small latency if outbound traffic interrupts a
819 By default background scanning is enabled if the device is capable.
820 To disable background scanning, use
822 Background scanning is controlled by the
827 Background scanning must be enabled for roaming; this is an artifact
828 of the current implementation and may not be required in the future.
829 .It Cm bgscanidle Ar idletime
830 Set the minimum time a station must be idle (not transmitting or
831 receiving frames) before a background scan is initiated.
834 parameter is specified in milliseconds.
835 By default a station must be idle at least 250 milliseconds before
836 a background scan is initiated.
837 The idle time may not be set to less than 100 milliseconds.
838 .It Cm bgscanintvl Ar interval
839 Set the interval at which background scanning is attempted.
842 parameter is specified in seconds.
843 By default a background scan is considered every 300 seconds (5 minutes).
846 may not be set to less than 15 seconds.
847 .It Cm bintval Ar interval
848 Set the interval at which beacon frames are sent when operating in
852 parameter is specified in TU's (1024 usecs).
853 By default beacon frames are transmitted every 100 TU's.
854 .It Cm bmissthreshold Ar count
855 Set the number of consecutive missed beacons at which the station
856 will attempt to roam (i.e., search for a new access point).
859 parameter must be in the range 1 to 255; though the
860 upper bound may be reduced according to device capabilities.
861 The default threshold is 7 consecutive missed beacons; but
862 this may be overridden by the device driver.
867 .It Cm bssid Ar address
868 Specify the MAC address of the access point to use when operating
869 as a station in a BSS network.
870 This overrides any automatic selection done by the system.
871 To disable a previously selected access point, supply
876 This option is useful when more than one access point uses the same SSID.
882 Enable packet bursting.
883 Packet bursting is a transmission technique whereby the wireless
884 medium is acquired once to send multiple frames and the interframe
886 This technique can significantly increase throughput by reducing
887 transmission overhead.
888 Packet bursting is supported by the 802.11e QoS specification
889 and some devices that do not support QoS may still be capable.
890 By default packet bursting is enabled if a device is capable
892 To disable packet bursting, use
894 .It Cm chanlist Ar channels
895 Set the desired channels to use when scanning for access
896 points, neighbors in an IBSS network, or looking for unoccupied
897 channels when operating as an access point.
898 The set of channels is specified as a comma-separated list with
899 each element in the list representing either a single channel number or a range
902 Channel numbers must be in the range 1 to 255 and be permissible
903 according to the operating characteristics of the device.
904 .It Cm channel Ar number
905 Set a single desired channel.
906 Channels range from 1 to 255, but the exact selection available
907 depends on the region your adaptor was manufactured for.
913 will clear any desired channel and, if the device is marked up,
914 force a scan for a channel to operate on.
915 Alternatively the frequency, in megahertz, may be specified
916 instead of the channel number.
918 When there are several ways to use a channel the channel
919 number/frequency may be appended with attributes to clarify.
920 For example, if a device is capable of operating on channel 6
921 with 802.11n and 802.11g then one can specify that g-only use
922 should be used by specifying ``6:g''.
923 Similarly the channel width can be specified by appending it
924 with ``/''; e.g. ``6/40'' specifies a 40MHz wide channel,
925 These attributes can be combined as in: ``6:ht/40''.
926 The full set of flags specified following a `:'' are:
932 (Atheros Dynamic Turbo mode),
940 (Atheros Static Turbo mode),
943 (Atheros Dynamic Turbo mode, or appended to ``st'' and ``dt'').
944 The full set of channel widths following a '/' are:
946 (5MHz aka quarter-rate channel),
948 (10MHz aka half-rate channel),
950 (20MHz mostly for use in specifying ht20),
953 (40MHz mostly for use in specifying ht40),
955 a 40MHz HT channel specification may include the location
956 of the extension channel by appending ``+'' or ``-'' for above and below,
957 respectively; e.g. ``2437:ht/40+'' specifies 40MHz wide HT operation
958 with the center channel at frequency 2437 and the extension channel above.
959 .It Cm country Ar name
960 Set the country code to use in calculating the regulatory constraints
962 In particular the set of available channels, how the wireless device
963 will operation on the channels, and the maximum transmit power that
964 can be used on a channel are defined by this setting.
965 Country/Region codes are specified as a 2-character abbreviation
966 defined by ISO 3166 or using a longer, but possibly ambiguous, spelling;
967 e.g. "ES" and "Spain".
968 The set of country codes are taken from /etc/regdomain.xml and can also
969 be viewed with the ``list countries'' request.
970 Note that not all devices support changing the country code from a default
971 setting; typically stored in EEPROM.
979 Enable Dynamic Frequency Selection (DFS) as specified in 802.11h.
980 DFS embodies several facilities including detection of overlapping
981 radar signals, dynamic transmit power control, and channel selection
982 according to a least-congested criteria.
983 DFS support is mandatory for some 5Ghz frequencies in certain
985 By default DFS is enabled according to the regulatory definitions
986 specified in /etc/regdomain.xml and the curent country code, regdomain,
988 Note the underlying device (and driver) must support radar detection
989 for full DFS support to work.
990 To be fully compliant with the local regulatory agency frequencies that
991 require DFS should not be used unless it is fully supported.
994 to disable this functionality for testing.
996 Enable support for the 802.11d specification (default).
997 When this support is enabled in station mode, beacon frames that advertise
998 a country code different than the currently configured country code will
999 cause an event to be dispatched to user applications.
1000 This event can be used by the station to adopt that country code and
1001 operate according to the associated regulatory constraints.
1002 When operating as an access point with 802.11d enabled the beacon and
1003 probe response frames transmitted will advertise the current regulatory
1005 To disable 802.11d use
1008 Enable 802.11h support including spectrum management.
1009 When 802.11h is enabled beacon and probe response frames will have
1010 the SpectrumMgt bit set in the capabilities field and
1011 country and power constraint information elements will be present.
1012 802.11h support also includes handling Channel Switch Announcements (CSA)
1013 which are a mechanism to coordinate channel changes by an access point.
1014 By default 802.11h is enabled if the device is capable.
1015 To disable 802.11h use
1017 .It Cm deftxkey Ar index
1018 Set the default key to use for transmission.
1019 Typically this is only set when using WEP encryption.
1020 Note that you must set a default transmit key
1021 for the system to know which key to use in encrypting outbound traffic.
1024 is an alias for this request; it is provided for backwards compatibility.
1025 .It Cm dtimperiod Ar period
1028 period for transmitting buffered multicast data frames when
1029 operating in ap mode.
1032 specifies the number of beacon intervals between DTIM
1033 and must be in the range 1 to 15.
1034 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
1036 Enable the use of Atheros Dynamic Turbo mode when communicating with
1037 another Dynamic Turbo-capable station.
1038 Dynamic Turbo mode is an Atheros-specific mechanism by which
1039 stations switch between normal 802.11 operation and a ``boosted''
1040 mode in which a 40MHz wide channel is used for communication.
1041 Stations using Dynamic Turbo mode operate boosted only when the
1042 channel is free of non-dturbo stations; when a non-dturbo station
1043 is identified on the channel all stations will automatically drop
1044 back to normal operation.
1045 By default, Dynamic Turbo mode is not enabled, even if the device is capable.
1046 Note that turbo mode (dynamic or static) is only allowed on some
1047 channels depending on the regulatory constraints; use the
1049 command to identify the channels where turbo mode may be used.
1050 To disable Dynamic Turbo mode use
1053 Enable Dynamic WDS (DWDS) support.
1054 DWDS is a facility by which 4-address traffic can be carried between
1055 stations operating in infrastructure mode.
1056 A station first associates to an access point and authenticates using
1057 normal procedures (e.g. WPA).
1058 Then 4-address frames are passed to carry traffic for stations
1059 operating on either side of the wireless link.
1060 DWDS extends the normal WDS mechanism by leveraging existing security
1061 protocols and eliminating static binding.
1063 When DWDS is enabled on an access point 4-address frames received from
1064 an authorized station will generate a ``DWDS discovery'' event to user
1066 This event should be used to create a WDS interface that is bound
1067 to the remote station (and usually plumbed into a bridge).
1068 Once the WDS interface is up and running 4-address traffic then logically
1069 flows through that interface.
1071 When DWDS is enabled on a station, traffic with a destination address
1072 different from the peer station are encapsulated in a 4-address frame
1073 and transmitted to the peer.
1074 All 4-address traffic uses the security information of the stations
1075 (e.g. cryptographic keys).
1076 A station is associated using 802.11n facilities may transport
1077 4-address traffic using these same mechanisms; this depends on available
1078 resources and capabilities of the device.
1079 The DWDS implementation guards against layer 2 routing loops of
1082 Enable the use of Atheros Fast Frames when communicating with
1083 another Fast Frames-capable station.
1084 Fast Frames are an encapsulation technique by which two 802.3
1085 frames are transmitted in a single 802.11 frame.
1086 This can noticeably improve throughput but requires that the
1087 receiving station understand how to decapsulate the frame.
1088 Fast frame use is negotiated using the Atheros 802.11 vendor-specific
1089 protocol extension so enabling use is safe when communicating with
1090 non-Atheros devices.
1091 By default, use of fast frames is enabled if the device is capable.
1092 To explicitly disable fast frames, use
1094 .It Cm fragthreshold Ar length
1095 Set the threshold for which transmitted frames are broken into fragments.
1098 argument is the frame size in bytes and must be in the range 256 to 2346.
1106 disables transmit fragmentation.
1107 Not all adapters honor the fragmentation threshold.
1109 When operating as an access point, do not broadcast the SSID
1110 in beacon frames or respond to probe request frames unless
1111 they are directed to the ap (i.e., they include the ap's SSID).
1112 By default, the SSID is included in beacon frames and
1113 undirected probe request frames are answered.
1114 To re-enable the broadcast of the SSID etc., use
1117 Enable use of High Throughput (HT) when using 802.11n (default).
1118 The 802.11n specification includes mechanisms for operation
1119 on 20MHz and 40MHz wide channels using different signalling mechanisms
1120 than specified in 802.11b, 802.11g, and 802.11a.
1121 Stations negotiate use of these facilities, termed HT20 and HT40,
1122 when they associate.
1123 To disable all use of 802.11n use
1125 To disable use of HT20 (e.g. to force only HT40 use) use
1127 To disable use of HT40 use
1130 HT configuration is used to ``auto promote'' operation
1131 when several choices are available.
1132 For example, if a station associates to an 11n-capable access point
1133 it controls whether the station uses legacy operation, HT20, or HT40.
1134 When an 11n-capable device is setup as an access point and
1135 Auto Channel Selection is used to locate a channel to operate on,
1136 HT configuration controls whether legacy, HT20, or HT40 operation is setup
1137 on the selected channel.
1138 If a fixed channel is specified for a station then HT configuration can
1139 be given as part of the channel specification; e.g. 6:ht/20 to setup
1140 HT20 operation on channel 6.
1142 Enable use of compatibility support for pre-802.11n devices (default).
1143 The 802.11n protocol specification went through several incompatible iterations.
1144 Some vendors implemented 11n support to older specifications that
1145 will not interoperate with a purely 11n-compliant station.
1146 In particular the information elements included in management frames
1147 for old devices are different.
1148 When compatibility support is enabled both standard and compatible data
1150 Stations that associate using the compatiblity mechanisms are flagged
1152 To disable compatiblity support use
1154 .It Cm htprotmode Ar technique
1155 For interfaces operating in 802.11n, use the specified
1157 for protecting HT frames in a mixed legacy/HT network.
1158 The set of valid techniques is
1163 Technique names are case insensitive.
1165 Enable inactivity processing for stations associated to an
1166 access point (default).
1167 When operating as an access point the 802.11 layer monitors
1168 the activity of each associated station.
1169 When a station is inactive for 5 minutes it will send several
1170 ``probe frames'' to see if the station is still present.
1171 If no response is received then the station is deauthenticated.
1172 Applications that prefer to handle this work can disable this
1176 Set the location to use in calculating regulatory constraints.
1177 The location is also advertised in beacon and probe response frames
1178 when 802.11d is enabled with
1187 Display the list of channels available for use taking into account
1188 any restrictions set with the
1191 See the description of
1193 for more information.
1195 Display the adaptor's capabilities, including the operating
1198 Display the list of channels available for use.
1199 Channels are shown with their IEEE channel number, equivalent
1200 frequency, and usage modes.
1201 Channels identified as
1206 Channels identified as
1208 may be used only for Atheros' Static Turbo mode
1210 . Cm mediaopt turbo ) .
1211 Channels marked with a
1213 have a regulatory constraint that they be passively scanned.
1214 This means a station is not permitted to transmit on the channel until
1215 it identifies the channel is being used for 802.11 communication;
1216 typically by hearing a beacon frame from an access point operating
1219 is another way of requesting this information.
1220 By default a compacted list of channels is displayed; if the
1222 option is specified then all channels are shown.
1223 .It Cm list countries
1224 Display the set of country codes and regulatory domains that can be
1225 used in regulatory configuration.
1227 Display the current MAC Access Control List state.
1228 Each address is prefixed with a character that indicates the
1229 current policy applied to it:
1231 indicates the address is allowed access,
1233 indicates the address is denied access,
1235 indicates the address is present but the current policy open
1236 (so the ACL is not consulted).
1238 Displays the mesh routing table, used for forwarding packets on a mesh
1240 .It Cm list regdomain
1241 Display the current regulatory settings including the available channels
1242 and transmit power caps.
1244 Display the parameters that govern roaming operation.
1246 Display the parameters that govern transmit operation.
1248 Display the transmit power caps for each channel.
1250 Display the access points and/or ad-hoc neighbors
1251 located in the vicinity.
1252 This information may be updated automatically by the adapter
1255 request or through background scanning.
1256 Depending on the capabilities of the stations the following
1257 flags can be included in the output:
1261 Indicates that the station is permitted to send/receive data frames.
1263 Extended Rate Phy (ERP).
1264 Indicates that the station is operating in an 802.11g network
1265 using extended transmit rates.
1267 High Throughput (HT).
1268 Indicates that the station is using HT transmit rates.
1269 If a `+' follows immediately after then the station associated
1270 using deprecated mechanisms supported only when
1275 Indicates that the station is operating in power save mode.
1277 Quality of Service (QoS).
1278 Indicates that the station is using QoS encapsulation for
1280 QoS encapsulation is enabled only when WME mode is enabled.
1282 Transitional Security Network (TSN).
1283 Indicates that the station associated using TSN; see also
1287 Wi-Fi Protected Setup (WPS).
1288 Indicates that the station associated using WPS.
1291 By default interesting information elements captured from the neighboring
1292 stations are displayed at the end of each row.
1293 Possible elements include:
1295 (station supports WME),
1297 (station supports WPA),
1299 (station supports WPS),
1301 (station supports 802.11i/RSN),
1303 (station supports 802.11n/HT communication),
1305 (station supports Atheros protocol extensions),
1307 (station supports unknown vendor-specific extensions).
1310 flag is used all the information elements and their
1311 contents will be shown.
1314 flag also enables display of long SSIDs.
1317 command is another way of requesting this information.
1319 When operating as an access point display the stations that are
1320 currently associated.
1321 When operating in ad-hoc mode display stations identified as
1322 neighbors in the IBSS.
1323 When operating in mesh mode display stations identified as
1324 neighbors in the MBSS.
1325 When operating in station mode display the access point.
1326 Capabilities advertised by the stations are described under
1330 Depending on the capabilities of the stations the following
1331 flags can be included in the output:
1335 Indicates that the station is permitted to send/receive data frames.
1337 Extended Rate Phy (ERP).
1338 Indicates that the station is operating in an 802.11g network
1339 using extended transmit rates.
1341 High Throughput (HT).
1342 Indicates that the station is using HT transmit rates.
1343 If a `+' follows immediately after then the station associated
1344 using deprecated mechanisms supported only when
1349 Indicates that the station is operating in power save mode.
1351 Quality of Service (QoS).
1352 Indicates that the station is using QoS encapsulation for
1354 QoS encapsulation is enabled only when WME mode is enabled.
1356 Transitional Security Network (TSN).
1357 Indicates that the station associated using TSN; see also
1361 Wi-Fi Protected Setup (WPS).
1362 Indicates that the station associated using WPS.
1365 By default information elements received from associated stations
1366 are displayed in a short form; the
1368 flag causes this information to be displayed symbolically.
1370 Display the current channel parameters to use when operating in WME mode.
1373 option is specified then both channel and BSS parameters are displayed
1374 for each AC (first channel, then BSS).
1375 When WME mode is enabled for an adaptor this information will be
1376 displayed with the regular status; this command is mostly useful
1377 for examining parameters when WME mode is disabled.
1378 See the description of the
1380 directive for information on the various parameters.
1381 .It Cm maxretry Ar count
1382 Set the maximum number of tries to use in sending unicast frames.
1383 The default setting is 6 but drivers may override this with a value
1385 .It Cm mcastrate Ar rate
1386 Set the rate for transmitting multicast/broadcast frames.
1387 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
1388 This rate should be valid for the current operating conditions;
1389 if an invalid rate is specified drivers are free to chose an
1391 .It Cm mgtrate Ar rate
1392 Set the rate for transmitting management and/or control frames.
1393 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
1395 Set the location to use in calculating regulatory constraints.
1396 The location is also advertised in beacon and probe response frames
1397 when 802.11d is enabled with
1406 Enable powersave operation.
1407 When operating as a client, the station will conserve power by
1408 periodically turning off the radio and listening for
1409 messages from the access point telling it there are packets waiting.
1410 The station must then retrieve the packets.
1411 Not all devices support power save operation as a client.
1412 The 802.11 specification requires that all access points support
1413 power save but some drivers do not.
1416 to disable powersave operation when operating as a client.
1417 .It Cm powersavesleep Ar sleep
1418 Set the desired max powersave sleep time in TU's (1024 usecs).
1419 By default the max powersave sleep time is 100 TU's.
1420 .It Cm protmode Ar technique
1421 For interfaces operating in 802.11g, use the specified
1423 for protecting OFDM frames in a mixed 11b/11g network.
1424 The set of valid techniques is
1430 Technique names are case insensitive.
1431 Not all devices support
1433 as a protection technique.
1435 When operating as an access point in 802.11g mode allow only
1436 11g-capable stations to associate (11b-only stations are not
1437 permitted to associate).
1438 To allow both 11g and 11b-only stations to associate, use
1441 When operating as an access point in 802.11n mode allow only
1442 HT-capable stations to associate (legacy stations are not
1443 permitted to associate).
1444 To allow both HT and legacy stations to associate, use
1446 .It Cm regdomain Ar sku
1447 Set the regulatory domain to use in calculating the regulatory constraints
1449 In particular the set of available channels, how the wireless device
1450 will operation on the channels, and the maximum transmit power that
1451 can be used on a channel are defined by this setting.
1452 Regdomain codes (SKU's) are taken from /etc/regdomain.xml and can also
1453 be viewed with the ``list countries'' request.
1454 Note that not all devices support changing the regdomain from a default
1455 setting; typically stored in EEPROM.
1463 Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n
1465 Note that RIFS must be supported by both the station and access point
1469 .It Cm roam:rate Ar rate
1470 Set the threshold for controlling roaming when operating in a BSS.
1473 parameter specifies the transmit rate in megabits
1474 at which roaming should be considered.
1475 If the current transmit rate drops below this setting and background scanning
1476 is enabled, then the system will check if a more desirable access point is
1477 available and switch over to it.
1478 The current scan cache contents are used if they are considered
1479 valid according to the
1481 parameter; otherwise a background scan operation is triggered before
1482 any selection occurs.
1483 Each channel type has a separate rate threshold; the default values are:
1484 12 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng).
1485 .It Cm roam:rssi Ar rssi
1486 Set the threshold for controlling roaming when operating in a BSS.
1489 parameter specifies the receive signal strength in dBm units
1490 at which roaming should be considered.
1491 If the current rssi drops below this setting and background scanning
1492 is enabled, then the system will check if a more desirable access point is
1493 available and switch over to it.
1494 The current scan cache contents are used if they are considered
1495 valid according to the
1497 parameter; otherwise a background scan operation is triggered before
1498 any selection occurs.
1499 Each channel type has a separate rssi threshold; the default values are
1501 .It Cm roaming Ar mode
1502 When operating as a station, control how the system will
1503 behave when communication with the current access point
1507 argument may be one of
1509 (leave it to the hardware device to decide),
1511 (handle either in the device or the operating system\[em]as appropriate),
1513 (do nothing until explicitly instructed).
1514 By default, the device is left to handle this if it is
1515 capable; otherwise, the operating system will automatically
1516 attempt to reestablish communication.
1517 Manual mode is used by applications such as
1518 .Xr wpa_supplicant 8
1519 that want to control the selection of an access point.
1520 .It Cm rtsthreshold Ar length
1521 Set the threshold for which
1522 transmitted frames are preceded by transmission of an
1528 is the frame size in bytes and must be in the range 1 to 2346.
1536 disables transmission of RTS frames.
1537 Not all adapters support setting the RTS threshold.
1539 Initiate a scan of neighboring stations, wait for it to complete, and
1540 display all stations found.
1541 Only the super-user can initiate a scan.
1544 for information on the display.
1545 By default a background scan is done; otherwise a foreground
1546 scan is done and the station may roam to a different access point.
1549 request can be used to show recent scan results without
1550 initiating a new scan.
1551 .It Cm scanvalid Ar threshold
1552 Set the maximum time the scan cache contents are considered valid;
1553 i.e. will be used without first triggering a scan operation to
1557 parameter is specified in seconds and defaults to 60 seconds.
1558 The minimum setting for
1561 One should take care setting this threshold; if it is set too low
1562 then attempts to roam to another access point may trigger unnecessary
1563 background scan operations.
1565 Enable use of Short Guard Interval when operating in 802.11n
1567 NB: this currently enables Short GI on both HT40 and HT20 channels.
1568 To disable Short GI use
1571 Enable use of Static Spatial Multiplexing Power Save (SMPS)
1572 when operating in 802.11n.
1573 A station operating with Static SMPS maintains only a single
1574 receive chain active (this can significantly reduce power consumption).
1578 Enable use of Dynamic Spatial Multiplexing Power Save (SMPS)
1579 when operating in 802.11n.
1580 A station operating with Dynamic SMPS maintains only a single
1581 receive chain active but switches to multiple receive chains when it
1582 receives an RTS frame (this can significantly reduce power consumption).
1583 Note that stations cannot distinguish between RTS/CTS intended to
1584 enable multiple receive chains and those used for other purposes.
1588 Set the desired Service Set Identifier (aka network name).
1589 The SSID is a string up to 32 characters
1590 in length and may be specified as either a normal string or in
1591 hexadecimal when preceded by
1593 Additionally, the SSID may be cleared by setting it to
1595 .It Cm tdmaslot Ar slot
1596 When operating with TDMA, use the specified
1601 is a number between 0 and the maximum number of slots in the BSS.
1602 Note that a station configured as slot 0 is a master and
1603 will broadcast beacon frames advertising the BSS;
1604 stations configured to use other slots will always
1605 scan to locate a master before they ever transmit.
1609 .It Cm tdmaslotcnt Ar cnt
1610 When operating with TDMA, setup a BSS with
1613 The slot count may be at most 8.
1614 The current implementation is only tested with two stations
1615 (i.e. point to point applications).
1616 This setting is only meaningful when a station is configured as slot 0;
1617 other stations adopt this setting from the BSS they join.
1621 .It Cm tdmaslotlen Ar len
1622 When operating with TDMA, setup a BSS such that each station has a slot
1625 The slot length must be at least 150 microseconds (1/8 TU)
1626 and no more than 65 milliseconds.
1627 Note that setting too small a slot length may result in poor channel
1628 bandwidth utilization due to factors such as timer granularity and
1630 This setting is only meaningful when a station is configured as slot 0;
1631 other stations adopt this setting from the BSS they join.
1634 is set to 10 milliseconds.
1635 .It Cm tdmabintval Ar intval
1636 When operating with TDMA, setup a BSS such that beacons are transmitted every
1638 superframes to synchronize the TDMA slot timing.
1639 A superframe is defined as the number of slots times the slot length; e.g.
1640 a BSS with two slots of 10 milliseconds has a 20 millisecond superframe.
1641 The beacon interval may not be zero.
1644 causes the timers to be resynchronized more often; this can be help if
1645 significant timer drift is observed.
1650 When operating as an access point with WPA/802.11i allow legacy
1651 stations to associate using static key WEP and open authentication.
1652 To disallow legacy station use of WEP, use
1654 .It Cm txpower Ar power
1655 Set the power used to transmit frames.
1658 argument is specified in .5 dBm units.
1659 Out of range values are truncated.
1660 Typically only a few discreet power settings are available and
1661 the driver will use the setting closest to the specified value.
1662 Not all adapters support changing the transmit power.
1663 .It Cm ucastrate Ar rate
1664 Set a fixed rate for transmitting unicast frames.
1665 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
1666 This rate should be valid for the current operating conditions;
1667 if an invalid rate is specified drivers are free to chose an
1669 .It Cm wepmode Ar mode
1670 Set the desired WEP mode.
1671 Not all adapters support all modes.
1672 The set of valid modes is
1678 mode explicitly tells the adaptor to allow association with access
1679 points which allow both encrypted and unencrypted traffic.
1682 means that the access point must only allow encrypted connections.
1685 is generally another name for
1687 Modes are case insensitive.
1688 .It Cm weptxkey Ar index
1689 Set the WEP key to be used for transmission.
1690 This is the same as setting the default transmission key with
1692 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
1693 Set the selected WEP key.
1696 is not given, key 1 is set.
1697 A WEP key will be either 5 or 13
1698 characters (40 or 104 bits) depending of the local network and the
1699 capabilities of the adaptor.
1700 It may be specified either as a plain
1701 string or as a string of hexadecimal digits preceded by
1703 For maximum portability, hex keys are recommended;
1704 the mapping of text keys to WEP encryption is usually driver-specific.
1707 drivers do this mapping differently to
1709 A key may be cleared by setting it to
1711 If WEP is supported then there are at least four keys.
1712 Some adapters support more than four keys.
1713 If that is the case, then the first four keys
1714 (1-4) will be the standard temporary keys and any others will be adaptor
1715 specific keys such as permanent keys stored in NVRAM.
1717 Note that you must set a default transmit key with
1719 for the system to know which key to use in encrypting outbound traffic.
1721 Enable Wireless Multimedia Extensions (WME) support, if available,
1722 for the specified interface.
1723 WME is a subset of the IEEE 802.11e standard to support the
1724 efficient communication of realtime and multimedia data.
1725 To disable WME support, use
1727 Another name for this parameter is
1730 The following parameters are meaningful only when WME support is in use.
1731 Parameters are specified per-AC (Access Category) and
1732 split into those that are used by a station when acting
1733 as an access point and those for client stations in the BSS.
1734 The latter are received from the access point and may not be changed
1736 The following Access Categories are recognized:
1738 .Bl -tag -width ".Cm AC_BK" -compact
1742 best effort delivery,
1757 AC parameters are case-insensitive.
1758 Traffic classification is done in the operating system using the
1759 vlan priority associated with data frames or the
1760 ToS (Type of Service) indication in IP-encapsulated frames.
1761 If neither information is present, traffic is assigned to the
1762 Best Effort (BE) category.
1763 .Bl -tag -width indent
1765 Set the ACK policy for QoS transmissions by the local station;
1766 this controls whether or not data frames transmitted by a station
1767 require an ACK response from the receiving station.
1768 To disable waiting for an ACK use
1770 This parameter is applied only to the local station.
1772 Enable the Admission Control Mandatory (ACM) mechanism
1773 for transmissions by the local station.
1774 To disable the ACM use
1776 On stations in a BSS this parameter is read-only and indicates
1777 the setting received from the access point.
1778 NB: ACM is not supported right now.
1779 .It Cm aifs Ar ac Ar count
1780 Set the Arbitration Inter Frame Spacing (AIFS)
1781 channel access parameter to use for transmissions
1782 by the local station.
1783 On stations in a BSS this parameter is read-only and indicates
1784 the setting received from the access point.
1785 .It Cm cwmin Ar ac Ar count
1786 Set the CWmin channel access parameter to use for transmissions
1787 by the local station.
1788 On stations in a BSS this parameter is read-only and indicates
1789 the setting received from the access point.
1790 .It Cm cwmax Ar ac Ar count
1791 Set the CWmax channel access parameter to use for transmissions
1792 by the local station.
1793 On stations in a BSS this parameter is read-only and indicates
1794 the setting received from the access point.
1795 .It Cm txoplimit Ar ac Ar limit
1796 Set the Transmission Opportunity Limit channel access parameter
1797 to use for transmissions by the local station.
1798 This parameter defines an interval of time when a WME station
1799 has the right to initiate transmissions onto the wireless medium.
1800 On stations in a BSS this parameter is read-only and indicates
1801 the setting received from the access point.
1802 .It Cm bss:aifs Ar ac Ar count
1803 Set the AIFS channel access parameter to send to stations in a BSS.
1804 This parameter is meaningful only when operating in ap mode.
1805 .It Cm bss:cwmin Ar ac Ar count
1806 Set the CWmin channel access parameter to send to stations in a BSS.
1807 This parameter is meaningful only when operating in ap mode.
1808 .It Cm bss:cwmax Ar ac Ar count
1809 Set the CWmax channel access parameter to send to stations in a BSS.
1810 This parameter is meaningful only when operating in ap mode.
1811 .It Cm bss:txoplimit Ar ac Ar limit
1812 Set the TxOpLimit channel access parameter to send to stations in a BSS.
1813 This parameter is meaningful only when operating in ap mode.
1816 Enable Wireless Privacy Subscriber support.
1817 Note that WPS support requires a WPS-capable supplicant.
1818 To disable this function use
1822 The following parameters support an optional access control list
1823 feature available with some adapters when operating in ap mode; see
1825 This facility allows an access point to accept/deny association
1826 requests based on the MAC address of the station.
1827 Note that this feature does not significantly enhance security
1828 as MAC address spoofing is easy to do.
1829 .Bl -tag -width indent
1830 .It Cm mac:add Ar address
1831 Add the specified MAC address to the database.
1832 Depending on the policy setting association requests from the
1833 specified station will be allowed or denied.
1835 Set the ACL policy to permit association only by
1836 stations registered in the database.
1837 .It Cm mac:del Ar address
1838 Delete the specified MAC address from the database.
1840 Set the ACL policy to deny association only by
1841 stations registered in the database.
1842 .It Cm mac:kick Ar address
1843 Force the specified station to be deauthenticated.
1844 This typically is done to block a station after updating the
1847 Set the ACL policy to allow all stations to associate.
1849 Delete all entries in the database.
1851 Set the ACL policy to permit association only by
1852 stations approved by a RADIUS server.
1853 Note that this feature requires the
1855 program be configured to do the right thing
1856 as it handles the RADIUS processing
1857 (and marks stations as authorized).
1860 The following parameters are related to a wireless interface operating in mesh
1862 .Bl -tag -width indent
1863 .It Cm meshid Ar meshid
1864 Set the desired Mesh Identifier.
1865 The Mesh ID is a string up to 32 characters in length.
1866 A mesh interface must have a Mesh Identifier specified
1867 to reach an operational state.
1868 .It Cm meshttl Ar ttl
1869 Set the desired ``time to live'' for mesh forwarded packets;
1870 this is the number of hops a packet may be forwarded before
1872 The default setting for
1876 Enable or disable peering with neighbor mesh stations.
1877 Stations must peer before any data packets can be exchanged.
1882 Enable or disable forwarding packets by a mesh interface.
1886 .It Cm meshmetric Ar protocol
1889 as the link metric protocol used on a mesh network.
1890 The default protocol is called
1892 The mesh interface will restart after changing this setting.
1893 .It Cm meshpath Ar protocol
1896 as the path selection protocol used on a mesh network.
1897 The only available protocol at the moment is called
1899 (Hybrid Wireless Mesh Protocol).
1900 The mesh interface will restart after changing this setting.
1901 .It Cm hwmprootmode Ar mode
1902 Stations on a mesh network can operate as ``root nodes.''
1903 Root nodes try to find paths to all mesh nodes and advertise themselves
1905 When there is a root mesh node on a network, other mesh nodes can setup
1906 paths between themselves faster because they can use the root node
1907 to find the destination.
1908 This path may not be the best, but on-demand
1909 routing will eventually find the best path.
1910 The following modes are recognized:
1912 .Bl -tag -width ".Cm PROACTIVE" -compact
1916 Send broadcast path requests every two seconds.
1917 Nodes on the mesh without a path to this root mesh station with try to
1918 discover a path to us.
1920 Send broadcast path requests every two seconds and every node must reply with
1921 with a path reply even if it already has a path to this root mesh station,
1923 Send broadcast root annoucement (RANN) frames.
1924 Nodes on the mesh without a path to this root mesh station with try to
1925 discover a path to us.
1931 .It Cm hwmpmaxhops Ar cnt
1932 Set the maximum number of hops allowed in an HMWP path to
1934 The default setting for
1939 The following parameters are for compatibility with other systems:
1940 .Bl -tag -width indent
1942 Another name for the
1948 .It Cm stationname Ar name
1949 Set the name of this station.
1950 The station name is not part of the IEEE 802.11
1951 protocol though some interfaces support it.
1953 seems to be meaningful to identical or virtually identical equipment.
1954 Setting the station name is identical in syntax to setting the SSID.
1961 Another way of saying
1967 Another way of saying
1973 Another way of saying:
1974 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
1980 .Ar n : k1 , k2 , k3 , k4
1983 Another way of saying
1984 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
1989 Another way of saying
1996 The following parameters are specific to bridge interfaces:
1997 .Bl -tag -width indent
1998 .It Cm addm Ar interface
1999 Add the interface named by
2001 as a member of the bridge.
2002 The interface is put into promiscuous mode
2003 so that it can receive every packet sent on the network.
2004 .It Cm deletem Ar interface
2005 Remove the interface named by
2008 Promiscuous mode is disabled on the interface when
2009 it is removed from the bridge.
2010 .It Cm maxaddr Ar size
2011 Set the size of the bridge address cache to
2013 The default is 100 entries.
2014 .It Cm timeout Ar seconds
2015 Set the timeout of address cache entries to
2020 is zero, then address cache entries will not be expired.
2021 The default is 240 seconds.
2023 Display the addresses that have been learned by the bridge.
2024 .It Cm static Ar interface-name Ar address
2025 Add a static entry into the address cache pointing to
2026 .Ar interface-name .
2027 Static entries are never aged out of the cache or re-placed, even if the
2028 address is seen on a different interface.
2029 .It Cm deladdr Ar address
2032 from the address cache.
2034 Delete all dynamically-learned addresses from the address cache.
2036 Delete all addresses, including static addresses, from the address cache.
2037 .It Cm discover Ar interface
2038 Mark an interface as a
2041 When the bridge has no address cache entry
2042 (either dynamic or static)
2043 for the destination address of a packet,
2044 the bridge will forward the packet to all
2045 member interfaces marked as
2047 This is the default for all interfaces added to a bridge.
2048 .It Cm -discover Ar interface
2051 attribute on a member interface.
2052 For packets without the
2054 attribute, the only packets forwarded on the interface are broadcast
2055 or multicast packets and packets for which the destination address
2056 is known to be on the interface's segment.
2057 .It Cm learn Ar interface
2058 Mark an interface as a
2061 When a packet arrives on such an interface, the source
2062 address of the packet is entered into the address cache as being a
2063 destination address on the interface's segment.
2064 This is the default for all interfaces added to a bridge.
2065 .It Cm -learn Ar interface
2068 attribute on a member interface.
2069 .It Cm sticky Ar interface
2070 Mark an interface as a
2073 Dynamically learned address entries are treated at static once entered into
2075 Sticky entries are never aged out of the cache or replaced, even if the
2076 address is seen on a different interface.
2077 .It Cm -sticky Ar interface
2080 attribute on a member interface.
2081 .It Cm private Ar interface
2082 Mark an interface as a
2085 A private interface does not forward any traffic to any other port that is also
2086 a private interface.
2087 .It Cm -private Ar interface
2090 attribute on a member interface.
2091 .It Cm span Ar interface
2092 Add the interface named by
2094 as a span port on the bridge.
2095 Span ports transmit a copy of every frame received by the bridge.
2096 This is most useful for snooping a bridged network passively on
2097 another host connected to one of the span ports of the bridge.
2098 .It Cm -span Ar interface
2099 Delete the interface named by
2101 from the list of span ports of the bridge.
2102 .It Cm stp Ar interface
2103 Enable Spanning Tree protocol on
2107 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
2108 Spanning Tree is used to detect and remove loops in a network topology.
2109 .It Cm -stp Ar interface
2110 Disable Spanning Tree protocol on
2112 This is the default for all interfaces added to a bridge.
2113 .It Cm edge Ar interface
2117 An edge port connects directly to end stations cannot create bridging
2118 loops in the network, this allows it to transition straight to forwarding.
2119 .It Cm -edge Ar interface
2120 Disable edge status on
2122 .It Cm autoedge Ar interface
2125 to automatically detect edge status.
2126 This is the default for all interfaces added to a bridge.
2127 .It Cm -autoedge Ar interface
2128 Disable automatic edge status on
2130 .It Cm ptp Ar interface
2133 as a point to point link.
2134 This is required for straight transitions to forwarding and
2135 should be enabled on a direct link to another RSTP capable switch.
2136 .It Cm -ptp Ar interface
2137 Disable point to point link status on
2139 This should be disabled for a half duplex link and for an interface
2140 connected to a shared network segment,
2141 like a hub or a wireless network.
2142 .It Cm autoptp Ar interface
2143 Automatically detect the point to point status on
2145 by checking the full duplex link status.
2146 This is the default for interfaces added to the bridge.
2147 .It Cm -autoptp Ar interface
2148 Disable automatic point to point link detection on
2150 .It Cm maxage Ar seconds
2151 Set the time that a Spanning Tree protocol configuration is valid.
2152 The default is 20 seconds.
2153 The minimum is 6 seconds and the maximum is 40 seconds.
2154 .It Cm fwddelay Ar seconds
2155 Set the time that must pass before an interface begins forwarding
2156 packets when Spanning Tree is enabled.
2157 The default is 15 seconds.
2158 The minimum is 4 seconds and the maximum is 30 seconds.
2159 .It Cm hellotime Ar seconds
2160 Set the time between broadcasting of Spanning Tree protocol
2161 configuration messages.
2162 The hello time may only be changed when operating in legacy stp mode.
2163 The default is 2 seconds.
2164 The minimum is 1 second and the maximum is 2 seconds.
2165 .It Cm priority Ar value
2166 Set the bridge priority for Spanning Tree.
2167 The default is 32768.
2168 The minimum is 0 and the maximum is 61440.
2169 .It Cm proto Ar value
2170 Set the Spanning Tree protocol.
2171 The default is rstp.
2172 The available options are stp and rstp.
2173 .It Cm holdcnt Ar value
2174 Set the transmit hold count for Spanning Tree.
2175 This is the number of packets transmitted before being rate limited.
2177 The minimum is 1 and the maximum is 10.
2178 .It Cm ifpriority Ar interface Ar value
2179 Set the Spanning Tree priority of
2184 The minimum is 0 and the maximum is 240.
2185 .It Cm ifpathcost Ar interface Ar value
2186 Set the Spanning Tree path cost of
2190 The default is calculated from the link speed.
2191 To change a previously selected path cost back to automatic, set the
2193 The minimum is 1 and the maximum is 200000000.
2194 .It Cm ifmaxaddr Ar interface Ar size
2195 Set the maximum number of hosts allowed from an interface, packets with unknown
2196 source addresses are dropped until an existing host cache entry expires or is
2198 Set to 0 to disable.
2201 The following parameters are specific to lagg interfaces:
2202 .Bl -tag -width indent
2203 .It Cm laggport Ar interface
2204 Add the interface named by
2206 as a port of the aggregation interface.
2207 .It Cm -laggport Ar interface
2208 Remove the interface named by
2210 from the aggregation interface.
2211 .It Cm laggproto Ar proto
2212 Set the aggregation protocol.
2213 The default is failover.
2214 The available options are failover, fec, lacp, loadbalance, roundrobin and
2218 The following parameters are specific to IP tunnel interfaces,
2220 .Bl -tag -width indent
2221 .It Cm tunnel Ar src_addr dest_addr
2222 Configure the physical source and destination address for IP tunnel
2228 are interpreted as the outer source/destination for the encapsulating
2231 Unconfigure the physical source and destination address for IP tunnel
2232 interfaces previously configured with
2235 Another name for the
2238 .It Cm accept_rev_ethip_ver
2239 Set a flag to acccept both correct EtherIP packets and ones
2240 with reversed version field. Enabled by default.
2241 This is for backward compatibility with
2243 6.2, 6.3, 7.0, and 7.1.
2244 .It Cm -accept_rev_ethip_ver
2246 .Cm accept_rev_ethip_ver .
2247 .It Cm send_rev_ethip_ver
2248 Set a flag to send EtherIP packets with reversed version
2249 field intentionally. Disabled by default.
2250 This is for backward compatibility with
2252 6.2, 6.3, 7.0, and 7.1.
2253 .It Cm -send_rev_ethip_ver
2255 .Cm send_rev_ethip_ver .
2258 The following parameters are specific to GRE tunnel interfaces,
2260 .Bl -tag -width indent
2261 .It Cm grekey Ar key
2262 Configure the GRE key to be used for outgoing packets.
2264 .Xr gre 4 will always accept GRE packets with invalid or absent keys.
2265 This command will result in a four byte MTU reduction on the interface.
2268 The following parameters are specific to
2271 .Bl -tag -width indent
2273 Set the maximum number of updates for a single state which
2274 can be collapsed into one.
2275 This is an 8-bit number; the default value is 128.
2278 The following parameters are specific to
2281 .Bl -tag -width indent
2282 .It Cm vlan Ar vlan_tag
2283 Set the VLAN tag value to
2285 This value is a 16-bit number which is used to create an 802.1Q
2286 VLAN header for packets sent from the
2293 must both be set at the same time.
2294 .It Cm vlandev Ar iface
2295 Associate the physical interface
2300 Packets transmitted through the
2303 diverted to the specified physical interface
2305 with 802.1Q VLAN encapsulation.
2306 Packets with 802.1Q encapsulation received
2307 by the parent interface with the correct VLAN tag will be diverted to
2313 interface is assigned a
2314 copy of the parent interface's flags and the parent's ethernet address.
2319 must both be set at the same time.
2322 interface already has
2323 a physical interface associated with it, this command will fail.
2325 change the association to another physical interface, the existing
2326 association must be cleared first.
2328 Note: if the hardware tagging capability
2329 is set on the parent interface, the
2332 interface's behavior changes:
2335 interface recognizes that the
2336 parent interface supports insertion and extraction of VLAN tags on its
2337 own (usually in firmware) and that it should pass packets to and from
2338 the parent unaltered.
2339 .It Fl vlandev Op Ar iface
2342 pseudo device, disassociate the parent interface from it.
2343 This breaks the link between the
2345 interface and its parent,
2346 clears its VLAN tag, flags and its link address and shuts the interface down.
2349 argument is useless and hence deprecated.
2352 The following parameters are specific to
2355 .Bl -tag -width indent
2356 .It Cm advbase Ar seconds
2357 Specifies the base of the advertisement interval in seconds.
2358 The acceptable values are 1 to 255.
2359 The default value is 1.
2360 .\" The default value is
2361 .\" .Dv CARP_DFLTINTV .
2362 .It Cm advskew Ar interval
2363 Specifies the skew to add to the base advertisement interval to
2364 make one host advertise slower than another host.
2365 It is specified in 1/256 of seconds.
2366 The acceptable values are 1 to 254.
2367 The default value is 0.
2368 .It Cm pass Ar phrase
2369 Set the authentication key to
2372 Set the virtual host ID.
2373 This is a required setting.
2374 Acceptable values are 1 to 255.
2379 utility displays the current configuration for a network interface
2380 when no optional parameters are supplied.
2381 If a protocol family is specified,
2383 will report only the details specific to that protocol family.
2387 flag is passed before an interface name,
2389 will display the capability list and all
2390 of the supported media for the specified interface.
2393 flag is supplied, address lifetime is displayed for IPv6 addresses,
2394 as time offset string.
2398 flag may be used instead of an interface name.
2401 to display information about all interfaces in the system.
2404 flag limits this to interfaces that are down, and
2406 limits this to interfaces that are up.
2407 When no arguments are given,
2413 flag may be used to list all available interfaces on the system, with
2414 no other additional information.
2415 Use of this flag is mutually exclusive
2416 with all other flags and commands, except for
2418 (only list interfaces that are down)
2421 (only list interfaces that are up).
2425 flag may be used to get more verbose status for an interface.
2429 flag may be used to list all of the interface cloners available on
2430 the system, with no additional information.
2431 Use of this flag is mutually exclusive with all other flags and commands.
2435 flag causes keying information for the interface, if available, to be
2437 For example, the values of 802.11 WEP keys will be printed, if accessible to
2439 This information is not printed by default, as it may be considered
2442 If the network interface driver is not present in the kernel then
2444 will attempt to load it.
2447 flag disables this behavior.
2449 Only the super-user may modify the configuration of a network interface.
2451 The media selection system is relatively new and only some drivers support
2452 it (or have need for it).
2454 Assign the IPv4 address
2456 with a network mask of
2460 .Dl # ifconfig fxp0 inet 192.0.2.10 netmask 255.255.255.0
2462 Add the IPv4 address
2464 with the CIDR network prefix
2470 as a synonym for the canonical form of the option
2472 .Dl # ifconfig ed0 inet 192.0.2.45/28 add
2474 Remove the IPv4 address
2478 .Dl # ifconfig ed0 inet 192.0.2.45 -alias
2480 Add the IPv6 address
2481 .Li 2001:DB8:DBDB::123/48
2484 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias
2485 Note that lower case hexadecimal IPv6 addresses are acceptable.
2487 Remove the IPv6 address added in the above example,
2490 character as shorthand for the network prefix,
2493 as a synonym for the canonical form of the option
2495 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 delete
2497 Configure the interface
2499 to use 100baseTX, full duplex Ethernet media options:
2500 .Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex
2502 Label the em0 interface as an uplink:
2504 .Dl # ifconfig em0 description \&"Uplink to Gigabit Switch 2\&"
2506 Create the software network interface
2508 .Dl # ifconfig gif1 create
2510 Destroy the software network interface
2512 .Dl # ifconfig gif1 destroy
2514 Messages indicating the specified interface does not exist, the
2515 requested address is unknown, or the user is not privileged and
2516 tried to alter an interface's configuration.
2536 Basic IPv6 node operation requires a link-local address on each
2537 interface configured for IPv6.
2538 Normally, such an address is automatically configured by the
2539 kernel on each interface added to the system; this behaviour may
2540 be disabled by setting the sysctl MIB variable
2541 .Va net.inet6.ip6.auto_linklocal
2544 If you delete such an address using
2546 the kernel may act very odd.
2547 Do this at your own risk.