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 .\" 3. 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
29 .\" $FreeBSD: src/sbin/ifconfig/ifconfig.8,v 1.124 2006/10/10 09:44:08 ru Exp $
36 .Nd configure network interface parameters
39 .Op Fl f Ar type:format Ns Op Ar ,type:format
64 .Op Fl g Ar matchgroup
90 utility is used to assign an address
91 to a network interface and/or configure
92 network interface parameters.
95 utility must be used at boot time to define the network address
96 of each interface present on a machine; it may also be used at
97 a later time to redefine an interface's address
98 or other operating parameters.
101 displays the current configuration for a network interface
102 when no optional parameters are supplied.
103 If a protocol family is specified,
105 will report only the details specific to that protocol family.
106 If no parameters are provided, a summary of all interfaces is provided.
108 Only the super-user may modify the configuration of a network interface.
110 The following options are available:
111 .Bl -tag -width indent
113 Display information about all interfaces on the system.
117 flag may be used instead of the
120 This is the default, if no parameters are given to
123 List all of the interface cloners available on the system,
124 with no additional information.
125 Use of this flag is mutually exclusive with all other flags and commands.
127 Display only the interfaces that are down.
129 .Ar type Ns Cm \&: Ns Ar format Ns
130 .Op Cm \&, Ns Ar type Ns Cm \&: Ns Ar format Ar ...
132 Control the output formats of
134 The format is specified as a comma-separated list of
135 .Ar type Ns Cm \&: Ns Ar format
137 This option can be supplied multiple times.
138 Alternatively, the output formats can be specified via the
140 environment variable.
147 .Bl -tag -width indent
149 Adjust the display of inet and inet6 addresses:
151 .Bl -tag -width default -compact
153 Default format, i.e.,
156 Fully qualified domain names
159 Unqualified hostnames
164 Adjust the display of link-level Ethernet (MAC) addresses:
166 .Bl -tag -width default -compact
168 Separate address segments with a colon.
170 Separate address segments with a dash.
172 Default format, i.e.,
176 Adjust the display of inet address subnet masks:
178 .Bl -tag -width default -compact
180 CIDR notation, for example:
184 Default format, i.e.,
187 Dotted quad notation, for example:
191 Hexidecimal format, for example:
196 Adjust the display of inet6 address prefixes (subnet masks):
198 .Bl -tag -width default -compact
200 CIDR notation, for example:
204 Default format, i.e.,
207 Integer format, for example:
211 .It Fl G Ar groupname
212 Exclude members of the specified group from the output.
216 flag should be specified, as the later one overrides previous ones.
219 argument may contain shell patterns, but should be quoted in that case.
220 .It Fl g Ar groupname
221 Limit the output to the members of the specified group.
225 flag should be specified, as the later one overrides previous ones.
228 argument may contain shell patterns, but should be quoted in that case.
232 flag is specified before any other significant flags (e.g.,
238 only lists the names of interfaces belonging to the specified group.
239 Any other flags and parameters are ignored in that case.
245 selects all interfaces.
247 Print keying information for the interface, if available.
249 For example, the values of 802.11 WEP keys will be printed,
250 if accessible to the current user.
251 This information is not printed by default, as it may be
252 considered sensitive.
254 Display address lifetime for IPv6 addresses as time offset string.
256 List all available interfaces on the system,
257 with no other additional information.
261 is specified, only interfaces of that type will be listed.
266 then this flag will cause
268 to exclude loopback interfaces from the list of Ethernet interfaces.
269 This is a special case, because all other synonyms of the
271 address family will include loopback interfaces in the list.
273 Use of this flag is mutually exclusive with all other flags and
274 parameters, except for
280 Display the capability list,
281 the maximum amount of data that TCP segmentation offloading is
282 allowed to aggregate,
283 and all the supported media for an interface.
285 Disable the automatic loading of network interface drivers.
287 By default, if the network interface driver is not present in the kernel,
290 will attempt to load it.
292 Display only the interfaces that are up.
294 Get more verbose status for an interface.
296 Specify the name of the interface to show or configure.
297 This parameter is usually a string of the form
301 If the interface has been renamed, then this form no longer holds;
302 for example, an interface can be renamed to be
304 .It Ar address_family
305 Specify the address family that affects interpretation of the
306 remaining parameters.
307 Since an interface can receive transmissions in differing protocols
308 with different naming schemes, specifying the address family is
311 The address or protocol families currently supported are:
313 .Bl -tag -width default -compact
317 (with some exceptions, see the
321 Default, if available.
334 family, the address is either a host name present in the host name
337 or an IPv4 address expressed in the Internet standard
341 It is also possible to use the CIDR notation (also known as the
342 slash notation) to include the netmask.
343 That is, one can specify an address like
348 family, it is also possible to specify the prefix length using the
353 parameter below for more information.
357 address is specified as a series of colon-separated hex digits.
358 This can be used to, for example,
359 set a new MAC address on an Ethernet interface,
360 though the mechanism used is not Ethernet-specific.
362 If the interface is already up when the link-level address is modified,
363 it will be briefly brought down and then brought back up again
364 in order to ensure that the receive filter in the underlying
365 Ethernet hardware is properly reprogrammed.
367 Specify the address of the correspondent on the other end
368 of a point-to-point link.
377 .Bl -tag -width indent
382 Introduced for compatibility with
385 Establish an additional network address for this interface.
386 This is sometimes useful when changing network numbers, and
387 one wishes to accept packets addressed to the old interface.
388 If the address is on the same subnet as the first network address
389 for this interface, a non-conflicting netmask must be given.
394 Remove the network address specified.
395 This would be used if you incorrectly specified an alias, or it
396 was no longer needed.
397 If you have incorrectly set an NS address having the side effect
398 of specifying the host portion, removing all NS addresses will
399 allow you to respecify the host portion.
401 Enable the use of the Address Resolution Protocol
404 between network level addresses and link level addresses (default).
405 This is currently implemented for mapping between
406 Internet Protocol addresses and
408 802 48-bit MAC addresses (Ethernet addresses).
410 Disable the use of the Address Resolution Protocol
414 Specify the address to use to represent broadcasts to the network.
415 The default broadcast address is the address with a host part of all 1's.
421 Create the specified network pseudo-device.
422 If the interface is given without a unit number,
423 try to create a new device with an arbitrary unit number.
424 If the creation of an arbitrary device is successful,
425 the new device name is printed,
426 unless the interface is renamed or destroyed in the same
430 Enable driver dependent debugging code; usually, this turns on
431 extra console error logging.
433 Disable driver dependent debugging code.
438 .It Cm descr Ns Oo Cm iption Oc Ar value
439 Specify a description for the interface.
440 This can be used to label interfaces in situations where they may
441 otherwise be difficult to distinguish.
442 .It Cm -descr Ns Op Cm iption
443 Clear the interface description.
445 Destroy the specified network pseudo-device.
449 When an interface is marked
451 the system will not attempt to
452 transmit messages through that interface.
453 If possible, the interface will be reset to disable reception as well.
454 This action does not automatically disable routes using the interface.
455 .It Cm group Ar group-name
456 Assign the interface to the specified group.
457 The name of the group may not be longer than 15 characters and
458 must not end in a digit.
459 An interface can be in multiple groups.
461 Cloned interfaces are members of their interface family group by default.
462 For example, a tunnel interface such as
464 is a member of the TUN interface family group,
466 .\" The interface(s) that the default route(s) point to are members of the
469 .It Cm -group Ar group-name
470 Remove the interface from the given group.
471 .It Cm link0 , link1 , link2
472 Enable special processing of the link level of the interface.
473 These three options are interface specific in actual effect;
474 however, they are in general used to select special modes of operation.
476 An example of this is to enable SLIP compression,
477 or to select the connector type for some Ethernet cards.
478 Refer to the man page for the specific driver for more information.
479 .It Cm -link0 , -link1 , -link2
480 Disable special processing at the link level with the specified interface.
482 If the driver supports the media selection system, set the media type
485 Some interfaces support the mutually exclusive use of one of several
486 different physical media connectors.
487 For example, a 10Mbit/s Ethernet interface might support the use of either
489 or twisted pair connectors.
490 Setting the media type to
492 would change the currently active connector to the AUI port.
495 would activate twisted pair.
496 Refer to the interfaces' driver specific documentation or man page
497 for a complete list of the available types.
498 .It Cm mediaopt Ar opts
499 If the driver supports the media selection system, set the specified
500 media options on the interface.
503 argument is a comma-delimited list of options to apply to the interface.
504 Refer to the interfaces' driver specific man page for a complete
505 list of available options.
506 .It Cm -mediaopt Ar opts
507 If the driver supports the media selection system, disable the
508 specified media options on the interface.
510 Set the routing metric of the interface to
513 The routing metric is used by the routing protocol
515 Higher metrics have the effect of making a route
516 less favorable; metrics are counted as additional hops
517 to the destination network or host.
519 If the driver supports the media selection system, set the specified
520 operating mode on the interface to
522 For IEEE 802.11 wireless interfaces that support multiple operating modes
523 this directive is used to select between 802.11a
531 Put the interface in monitor mode.
532 No packets are transmitted, and received packets are discarded after
536 Take the interface out of monitor mode.
538 Set the maximum transmission unit of the interface to
540 the default is interface specific.
541 The MTU is used to limit the size of packets that are transmitted on an
543 Not all interfaces support setting the MTU, and some interfaces have
546 Set the interface name to
548 .It Cm netmask Ar mask
551 Specify how much of the address to reserve for subdividing
552 networks into sub-networks.
553 The mask includes the network part of the local address
554 and the subnet part, which is taken from the host field of the address.
555 The mask can be specified as a single hexadecimal number
558 with a dot-notation Internet address,
559 or with a pseudo-network name listed in the network table
561 The mask contains 1's for the bit positions in the 32-bit address
562 which are to be used for the network and subnet parts,
563 and 0's for the host part.
564 The mask should contain at least the standard network portion,
565 and the subnet field should be contiguous with the network
568 The netmask can also be specified in CIDR notation after the address.
571 option above for more information.
587 .It Cm pollcpu Ar cpu
593 parameters below instead.
594 .It Cm polling , npolling
597 feature and disable interrupts on the interface, if the driver supports
599 .It Cm -polling , -npolling
602 feature and enable interrupt mode on the interface.
604 Put interface into permanently promiscuous mode.
606 Disable permanently promiscuous mode.
611 Introduced for compatibility
615 If the driver supports Receive Side Scaling (RSS),
616 enable RSS on the interface.
618 If the driver supports Receive Side Scaling (RSS),
619 disable RSS on the interface.
620 .It Cm rxcsum , txcsum
621 If the driver supports user-configurable checksum offloading,
622 enable receive (or transmit) checksum offloading on the interface.
623 Some drivers may not be able to enable these flags independently
624 of each other, so setting one may also set the other.
625 The driver will offload as much checksum work as it can reliably
626 support, the exact level of offloading varies between drivers.
627 .It Cm -rxcsum , -txcsum
628 If the driver supports user-configurable checksum offloading,
629 disable receive (or transmit) checksum offloading on the interface.
630 These settings may not always be independent of each other.
632 If the Address Resolution Protocol is enabled,
633 the host will only reply to requests for its addresses,
634 and will never send any requests.
636 If the Address Resolution Protocol is enabled,
637 the host will perform normally,
638 sending out requests and listening for replies.
640 If the driver supports TCP segmentation offloading (TSO),
641 enable TSO on the interface.
643 If the driver supports TCP segmentation offloading (TSO),
644 disable TSO on the interface.
646 Set the maximum amount of data that TCP segmentation offloading (TSO)
647 is allowed to aggregate to
649 the default value is interface specific.
650 This setting only takes effect on interfaces that support TSO.
661 This may be used to enable an interface after an
663 It happens automatically when setting the first address on an interface.
664 If the interface was reset when previously marked down,
665 the hardware will be re-initialized.
666 .It Cm vlanmtu , vlanhwtag
667 If the driver offers user-configurable VLAN support, enable
668 reception of extended frames or tag processing in hardware,
670 Note that this must be issued on a physical interface associated with
675 .It Cm -vlanmtu , -vlanhwtag
676 If the driver offers user-configurable VLAN support, disable
677 reception of extended frames or tag processing in hardware,
682 The following parameters are specific to IPv6 addresses.
685 argument must be specified as
688 .Bl -tag -width indent
690 Specify that the address configured is an anycast address.
691 Based on the current specification,
692 only routers may configure anycast addresses.
693 Anycast address will not be used as source address of any of
694 outgoing IPv6 packets.
696 Enable IPv6 auto-configuration.
698 Disable IPv6 auto-configuration.
700 Set the IPv6 deprecated address bit.
702 Clear the IPv6 deprecated address bit.
704 Automatically configure the interface identifier
705 (i.e., lowermost 64 bits of an IPv6 address)
706 using the EUI-64 (Extended Unique Identifier) format.
708 Set the preferred lifetime for the address.
709 .It Cm prefixlen Ar len
712 bits are reserved for subdividing networks into sub-networks.
715 must be integer, and for syntactical reason it must be between 0 to 128.
716 It is almost always 64 under the current IPv6 assignment rule.
717 If the parameter is omitted, 64 is used.
719 The prefix length can also be specified using the slash notation
723 option above for more information.
725 Set the IPv6 tentative address bit.
727 Clear the IPv6 tentative address bit.
729 Set the valid lifetime for the address.
732 .Ss IEEE 802.11 Wireless Interface Cloning Parameters
733 The following parameters are specific to cloning
734 IEEE 802.11 wireless interfaces with the
737 .Bl -tag -width indent
738 .It Cm wlandev Ar device
741 as the parent for the cloned device.
742 .It Cm wlanmode Ar mode
743 Specify the operating mode for this cloned device.
761 The operating mode of a cloned interface cannot be changed.
764 mode is actually implemented as an
766 interface with special properties.
767 .It Cm wlanbssid Ar bssid
768 The 802.11 MAC address to use for the bssid.
769 This must be specified at create time for a legacy
772 .It Cm wlanaddr Ar address
773 The local MAC address.
774 If this is not specified then a MAC address will automatically be assigned
775 to the cloned device.
776 Typically this address is the same as the address of the parent device
779 parameter is specified then the driver will craft a unique address for
780 the device (if supported).
784 device as operating in
788 devices have a fixed peer relationship and do not, for example, roam
789 if their peer stops communicating.
790 For completeness, a Dynamic WDS (DWDS) interface may be marked as
793 Request a unique local MAC address for the cloned device.
794 This is only possible if the device supports multiple MAC addresses.
795 To force use of the parent's MAC address, use
798 Mark the cloned interface as depending on hardware support to
799 track received beacons.
800 To have beacons tracked in software, use
806 can also be used to indicate no beacons should be transmitted;
807 this can be useful when creating a WDS configuration but
809 interfaces can only be created as companions to an access point (AP).
812 .Ss IEEE 802.11 Wireless Cloned Interface Parameters
813 The following parameters are specific to IEEE 802.11 wireless interfaces
817 .Bl -tag -width indent
819 Enable sending and receiving AMPDU frames when using 802.11n (default).
820 The 802.11n specification states a compliant station must be capable
821 of receiving AMPDU frames but transmission is optional.
824 to disable all use of AMPDU with 802.11n.
825 For testing and/or to work around interoperability problems one can use
829 to control use of AMPDU in one direction.
830 .It Cm ampdudensity Ar density
831 Set the AMPDU density parameter used when operating with 802.11n.
832 This parameter controls the inter-packet gap for AMPDU frames.
833 The sending device normally controls this setting but a receiving station
834 may request wider gaps.
837 are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds).
840 is treated the same as 0.
841 .It Cm ampdulimit Ar limit
842 Set the limit on packet size for receiving AMPDU frames when operating
846 are 8192, 16384, 32768, and 65536 but one can also specify
847 just the unique prefix: 8, 16, 32, 64.
848 Note the sender may limit the size of AMPDU frames to be less
849 than the maximum specified by the receiving station.
851 Enable sending and receiving AMSDU frames when using 802.11n.
852 By default AMSDU is received but not transmitted.
855 to disable all use of AMSDU with 802.11n.
856 For testing and/or to work around interoperability problems one can use
860 to control use of AMSDU in one direction.
861 .It Cm amsdulimit Ar limit
862 Set the limit on packet size for sending and receiving AMSDU frames
863 when operating with 802.11n.
866 are 7935 and 3839 (bytes).
867 Note the sender may limit the size of AMSDU frames to be less
868 than the maximum specified by the receiving station.
869 Note also that devices are not required to support the 7935 limit,
870 only 3839 is required by the specification and the larger value
871 may require more memory to be dedicated to support functionality
874 When operating as an access point, pass packets between
875 wireless clients directly (default).
876 To instead let them pass up through the
877 system and be forwarded using some other mechanism, use
879 Disabling the internal bridging
880 is useful when traffic is to be processed with
882 .It Cm authmode Ar mode
883 Set the desired authentication mode in infrastructure mode.
884 Not all adapters support all modes.
887 .Cm none , open , shared
893 (IEEE WPA/WPA2/802.11i).
898 modes are only useful when using an authentication service
899 (a supplicant for client operation or an authenticator when
900 operating as an access point).
901 Modes are case insensitive.
903 Enable background scanning when operating as a station.
904 Background scanning is a technique whereby a station associated to
905 an access point will temporarily leave the channel to scan for
906 neighboring stations.
907 This allows a station to maintain a cache of nearby access points
908 so that roaming between access points can be done without
909 a lengthy scan operation.
910 Background scanning is done only when a station is not busy and
911 any outbound traffic will cancel a scan operation.
912 Background scanning should never cause packets to be lost though
913 there may be some small latency if outbound traffic interrupts a
915 By default background scanning is enabled if the device is capable.
916 To disable background scanning, use
918 Background scanning is controlled by the
923 Background scanning must be enabled for roaming; this is an artifact
924 of the current implementation and may not be required in the future.
925 .It Cm bgscanidle Ar idletime
926 Set the minimum time a station must be idle (not transmitting or
927 receiving frames) before a background scan is initiated.
930 parameter is specified in milliseconds.
931 By default a station must be idle at least 250 milliseconds before
932 a background scan is initiated.
933 The idle time may not be set to less than 100 milliseconds.
934 .It Cm bgscanintvl Ar interval
935 Set the interval at which background scanning is attempted.
938 parameter is specified in seconds.
939 By default a background scan is considered every 300 seconds (5 minutes).
942 may not be set to less than 15 seconds.
943 .It Cm bintval Ar interval
944 Set the interval at which beacon frames are sent when operating in
948 parameter is specified in TU's (1024 microseconds).
949 By default beacon frames are transmitted every 100 TU's.
950 .It Cm bmissthreshold Ar count
951 Set the number of consecutive missed beacons at which the station
952 will attempt to roam (i.e., search for a new access point).
955 parameter must be in the range 1 to 255; though the
956 upper bound may be reduced according to device capabilities.
957 The default threshold is 7 consecutive missed beacons; but
958 this may be overridden by the device driver.
963 .It Cm bssid Ar address
964 Specify the MAC address of the access point to use when operating
965 as a station in a BSS network.
966 This overrides any automatic selection done by the system.
967 To disable a previously selected access point, supply
972 This option is useful when more than one access point uses the same SSID.
978 Enable packet bursting.
979 Packet bursting is a transmission technique whereby the wireless
980 medium is acquired once to send multiple frames and the interframe
982 This technique can significantly increase throughput by reducing
983 transmission overhead.
984 Packet bursting is supported by the 802.11e QoS specification
985 and some devices that do not support QoS may still be capable.
986 By default packet bursting is enabled if a device is capable
988 To disable packet bursting, use
990 .It Cm chanlist Ar channels
991 Set the desired channels to use when scanning for access
992 points, neighbors in an IBSS network, or looking for unoccupied
993 channels when operating as an access point.
994 The set of channels is specified as a comma-separated list with
995 each element in the list representing either a single channel number
996 or a range of the form
998 Channel numbers must be in the range 1 to 255 and be permissible
999 according to the operating characteristics of the device.
1000 .It Cm channel Ar number
1001 Set a single desired channel.
1002 Channels range from 1 to 255, but the exact selection available
1003 depends on the region your adapter was manufactured for.
1004 Setting the channel to
1008 will clear any desired channel and, if the device is marked up,
1009 force a scan for a channel to operate on.
1010 Alternatively the frequency, in megahertz, may be specified
1011 instead of the channel number.
1013 When there are several ways to use a channel the channel
1014 number/frequency may be appended with attributes to clarify.
1015 For example, if a device is capable of operating on channel 6
1016 with 802.11n and 802.11g then one can specify that g-only use
1017 should be used by specifying
1019 Similarly the channel width can be specified by appending it with
1023 specifies a 40MHz wide channel,
1024 These attributes can be combined as in
1027 The full set of flags specified following a
1037 Atheros Dynamic Turbo mode
1046 Atheros Static Turbo mode
1048 Atheros Dynamic Turbo mode, or appended to
1054 The full set of channel widths following a
1060 5MHz, aka quarter-rate channel
1062 10MHz, aka half-rate channel
1064 20MHz, mostly for use in specifying
1067 40MHz, mostly for use in specifying
1071 In addition, a 40MHz HT channel specification may include the location
1072 of the extension channel by appending
1076 for above and below, respectively; e.g.,
1078 specifies 40MHz wide HT operation
1079 with the center channel at frequency 2437 and the extension channel above.
1080 .It Cm country Ar name
1081 Set the country code to use in calculating the regulatory constraints
1083 In particular the set of available channels, how the wireless device
1084 will operation on the channels, and the maximum transmit power that
1085 can be used on a channel are defined by this setting.
1086 Country/Region codes are specified as a 2-character abbreviation
1087 defined by ISO 3166 or using a longer, but possibly ambiguous, spelling;
1092 The set of country codes are taken from
1093 .Pa /etc/regdomain.xml
1094 and can also be viewed with the
1097 Note that not all devices support changing the country code from a default
1098 setting; typically stored in EEPROM.
1106 Enable Dynamic Frequency Selection (DFS) as specified in 802.11h.
1107 DFS embodies several facilities including detection of overlapping
1108 radar signals, dynamic transmit power control, and channel selection
1109 according to a least-congested criteria.
1110 DFS support is mandatory for some 5GHz frequencies in certain
1111 locales (e.g.\& ETSI).
1112 By default DFS is enabled according to the regulatory definitions
1114 .Pa /etc/regdomain.xml
1115 and the current country code, regdomain, and channel.
1116 Note the underlying device (and driver) must support radar detection
1117 for full DFS support to work.
1118 To be fully compliant with the local regulatory agency frequencies that
1119 require DFS should not be used unless it is fully supported.
1122 to disable this functionality for testing.
1124 Enable support for the 802.11d specification (default).
1125 When this support is enabled in station mode, beacon frames that advertise
1126 a country code different than the currently configured country code will
1127 cause an event to be dispatched to user applications.
1128 This event can be used by the station to adopt that country code and
1129 operate according to the associated regulatory constraints.
1130 When operating as an access point with 802.11d enabled the beacon and
1131 probe response frames transmitted will advertise the current regulatory
1133 To disable 802.11d, use
1136 Enable 802.11h support including spectrum management.
1137 When 802.11h is enabled beacon and probe response frames will have
1138 the SpectrumMgt bit set in the capabilities field and
1139 country and power constraint information elements will be present.
1140 802.11h support also includes handling Channel Switch Announcements (CSA)
1141 which are a mechanism to coordinate channel changes by an access point.
1142 By default 802.11h is enabled if the device is capable.
1143 To disable 802.11h, use
1145 .It Cm deftxkey Ar index
1146 Set the default key to use for transmission.
1147 Typically this is only set when using WEP encryption.
1148 Note that you must set a default transmit key
1149 for the system to know which key to use in encrypting outbound traffic.
1152 is an alias for this request; it is provided for backwards compatibility.
1153 .It Cm dtimperiod Ar period
1156 period for transmitting buffered multicast data frames when
1157 operating in AP mode.
1160 specifies the number of beacon intervals between DTIM
1161 and must be in the range 1 to 15.
1162 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
1164 Enable the use of Atheros Dynamic Turbo mode when communicating with
1165 another Dynamic Turbo-capable station.
1166 Dynamic Turbo mode is an Atheros-specific mechanism by which
1167 stations switch between normal 802.11 operation and a
1169 mode in which a 40MHz wide channel is used for communication.
1170 Stations using Dynamic Turbo mode operate boosted only when the
1171 channel is free of non-dturbo stations; when a non-dturbo station
1172 is identified on the channel all stations will automatically drop
1173 back to normal operation.
1174 By default, Dynamic Turbo mode is not enabled, even if the device is capable.
1175 Note that turbo mode (dynamic or static) is only allowed on some
1176 channels depending on the regulatory constraints; use the
1178 command to identify the channels where turbo mode may be used.
1179 To disable Dynamic Turbo mode, use
1182 Enable Dynamic WDS (DWDS) support.
1183 DWDS is a facility by which 4-address traffic can be carried between
1184 stations operating in infrastructure mode.
1185 A station first associates to an access point and authenticates using
1186 normal procedures (e.g.\& WPA).
1187 Then 4-address frames are passed to carry traffic for stations
1188 operating on either side of the wireless link.
1189 DWDS extends the normal WDS mechanism by leveraging existing security
1190 protocols and eliminating static binding.
1192 When DWDS is enabled on an access point 4-address frames received from
1193 an authorized station will generate a
1195 event to user applications.
1196 This event should be used to create a WDS interface that is bound
1197 to the remote station (and usually plumbed into a bridge).
1198 Once the WDS interface is up and running 4-address traffic then logically
1199 flows through that interface.
1201 When DWDS is enabled on a station, traffic with a destination address
1202 different from the peer station are encapsulated in a 4-address frame
1203 and transmitted to the peer.
1204 All 4-address traffic uses the security information of the stations
1205 (e.g.\& cryptographic keys).
1206 A station is associated using 802.11n facilities may transport
1207 4-address traffic using these same mechanisms; this depends on available
1208 resources and capabilities of the device.
1209 The DWDS implementation guards against layer 2 routing loops of
1212 Enable the use of Atheros Fast Frames when communicating with
1213 another Fast Frames-capable station.
1214 Fast Frames are an encapsulation technique by which two 802.3
1215 frames are transmitted in a single 802.11 frame.
1216 This can noticeably improve throughput but requires that the
1217 receiving station understand how to decapsulate the frame.
1218 Fast frame use is negotiated using the Atheros 802.11 vendor-specific
1219 protocol extension so enabling use is safe when communicating with
1220 non-Atheros devices.
1221 By default, use of fast frames is enabled if the device is capable.
1222 To explicitly disable fast frames, use
1224 .It Cm fragthreshold Ar length
1225 Set the threshold for which transmitted frames are broken into fragments.
1228 argument is the frame size in bytes and must be in the range 256 to 2346.
1235 disables transmit fragmentation.
1236 Not all adapters honor the fragmentation threshold.
1238 When operating as an access point, do not broadcast the SSID
1239 in beacon frames or respond to probe request frames unless
1240 they are directed to the AP (i.e., they include the AP's SSID).
1241 By default, the SSID is included in beacon frames and
1242 undirected probe request frames are answered.
1243 To re-enable the broadcast of the SSID etc., use
1246 Enable use of High Throughput (HT) when using 802.11n (default).
1247 The 802.11n specification includes mechanisms for operation
1248 on 20MHz and 40MHz wide channels using different signaling mechanisms
1249 than specified in 802.11b, 802.11g, and 802.11a.
1250 Stations negotiate use of these facilities, termed HT20 and HT40,
1251 when they associate.
1252 To disable all use of 802.11n, use
1254 to disable use of HT20 (e.g.\& to force only HT40 use), use
1256 to disable use of HT40, use
1259 HT configuration is used to
1261 operation when several choices are available.
1262 For example, if a station associates to an 11n-capable access point
1263 it controls whether the station uses legacy operation, HT20, or HT40.
1264 When an 11n-capable device is setup as an access point and
1265 Auto Channel Selection is used to locate a channel to operate on,
1266 HT configuration controls whether legacy, HT20, or HT40 operation is setup
1267 on the selected channel.
1268 If a fixed channel is specified for a station then HT configuration can
1269 be given as part of the channel specification; e.g.,
1271 to setup HT20 operation on channel 6.
1273 Enable use of compatibility support for pre-802.11n devices (default).
1274 The 802.11n protocol specification went through several incompatible iterations.
1275 Some vendors implemented 11n support to older specifications that
1276 will not interoperate with a purely 11n-compliant station.
1277 In particular the information elements included in management frames
1278 for old devices are different.
1279 When compatibility support is enabled both standard and compatible data
1281 Stations that associate using the compatibility mechanisms are flagged in
1284 To disable compatibility support, use
1286 .It Cm htprotmode Ar technique
1287 For interfaces operating in 802.11n, use the specified
1289 for protecting HT frames in a mixed legacy/HT network.
1290 The set of valid techniques is
1295 Technique names are case insensitive.
1297 Enable inactivity processing for stations associated to an
1298 access point (default).
1299 When operating as an access point the 802.11 layer monitors
1300 the activity of each associated station.
1301 When a station is inactive for 5 minutes it will send several
1303 to see if the station is still present.
1304 If no response is received then the station is deauthenticated.
1305 Applications that prefer to handle this work can disable this
1309 Set the location to use in calculating regulatory constraints.
1310 The location is also advertised in beacon and probe response frames
1311 when 802.11d is enabled with
1320 Display the list of channels available for use taking into account
1321 any restrictions set with the
1324 See the description of
1326 for more information.
1328 Display the adaptor's capabilities, including the operating
1331 Display the list of channels available for use.
1332 Channels are shown with their IEEE channel number, equivalent
1333 frequency, and usage modes.
1334 Channels identified as
1339 Channels identified as
1341 may be used only for Atheros' Static Turbo mode
1343 .Cm mediaopt turbo ) .
1344 Channels marked with a
1346 have a regulatory constraint that they be passively scanned.
1347 This means a station is not permitted to transmit on the channel until
1348 it identifies the channel is being used for 802.11 communication;
1349 typically by hearing a beacon frame from an access point operating
1352 is another way of requesting this information.
1353 By default a compacted list of channels is displayed; if the
1355 option is specified then all channels are shown.
1356 .It Cm list countries
1357 Display the set of country codes and regulatory domains that can be
1358 used in regulatory configuration.
1360 Display the current MAC Access Control List state.
1361 Each address is prefixed with a character that indicates the
1362 current policy applied to it:
1364 indicates the address is allowed access,
1366 indicates the address is denied access,
1368 indicates the address is present but the current policy open
1369 (so the ACL is not consulted).
1371 Displays the mesh routing table, used for forwarding packets on a mesh
1373 .It Cm list regdomain
1374 Display the current regulatory settings including the available channels
1375 and transmit power caps.
1377 Display the parameters that govern roaming operation.
1379 Display the parameters that govern transmit operation.
1381 Display the transmit power caps for each channel.
1383 Display the access points and/or ad-hoc neighbors
1384 located in the vicinity.
1385 This information may be updated automatically by the adapter
1388 request or through background scanning.
1389 Depending on the capabilities of the stations the following
1390 flags can be included in the output:
1394 Indicates that the station is permitted to send/receive data frames.
1396 Extended Rate Phy (ERP).
1397 Indicates that the station is operating in an 802.11g network
1398 using extended transmit rates.
1400 High Throughput (HT).
1401 Indicates that the station is using HT transmit rates.
1404 follows immediately after then the station associated
1405 using deprecated mechanisms supported only when
1410 Indicates that the station is operating in power save mode.
1412 Quality of Service (QoS).
1413 Indicates that the station is using QoS encapsulation for
1415 QoS encapsulation is enabled only when WME mode is enabled.
1417 Transitional Security Network (TSN).
1418 Indicates that the station associated using TSN; see also
1422 Wi-Fi Protected Setup (WPS).
1423 Indicates that the station associated using WPS.
1426 By default interesting information elements captured from the neighboring
1427 stations are displayed at the end of each row.
1428 Possible elements include:
1430 (station supports WME),
1432 (station supports WPA),
1434 (station supports WPS),
1436 (station supports 802.11i/RSN),
1438 (station supports 802.11n/HT communication),
1440 (station supports Atheros protocol extensions),
1442 (station supports unknown vendor-specific extensions).
1445 flag is used all the information elements and their
1446 contents will be shown.
1449 flag also enables display of long SSIDs.
1452 command is another way of requesting this information.
1454 When operating as an access point display the stations that are
1455 currently associated.
1456 When operating in ad-hoc mode display stations identified as
1457 neighbors in the IBSS.
1458 When operating in mesh mode display stations identified as
1459 neighbors in the MBSS.
1460 When operating in station mode display the access point.
1461 Capabilities advertised by the stations are described under
1465 Depending on the capabilities of the stations the following
1466 flags can be included in the output:
1470 Indicates that the station is permitted to send/receive data frames.
1472 Extended Rate Phy (ERP).
1473 Indicates that the station is operating in an 802.11g network
1474 using extended transmit rates.
1476 High Throughput (HT).
1477 Indicates that the station is using HT transmit rates.
1480 follows immediately after then the station associated
1481 using deprecated mechanisms supported only when
1486 Indicates that the station is operating in power save mode.
1488 Quality of Service (QoS).
1489 Indicates that the station is using QoS encapsulation for
1491 QoS encapsulation is enabled only when WME mode is enabled.
1493 Transitional Security Network (TSN).
1494 Indicates that the station associated using TSN; see also
1498 Wi-Fi Protected Setup (WPS).
1499 Indicates that the station associated using WPS.
1502 By default information elements received from associated stations
1503 are displayed in a short form; the
1505 flag causes this information to be displayed symbolically.
1507 Display the current channel parameters to use when operating in WME mode.
1510 option is specified then both channel and BSS parameters are displayed
1511 for each AC (first channel, then BSS).
1512 When WME mode is enabled for an adapter this information will be
1513 displayed with the regular status; this command is mostly useful
1514 for examining parameters when WME mode is disabled.
1515 See the description of the
1517 directive for information on the various parameters.
1521 (see below) that displays long SSIDs.
1522 .It Cm maxretry Ar count
1523 Set the maximum number of tries to use in sending unicast frames.
1524 The default setting is 6 but drivers may override this with a value
1526 .It Cm mcastrate Ar rate
1527 Set the rate for transmitting multicast/broadcast frames.
1528 Rates are specified as megabits/second in decimal;
1529 e.g.\& 5.5 for 5.5 Mb/s.
1530 This rate should be valid for the current operating conditions;
1531 if an invalid rate is specified drivers are free to choose an
1533 .It Cm mgtrate Ar rate
1534 Set the rate for transmitting management and/or control frames.
1535 Rates are specified as megabits/second in decimal;
1536 e.g.\& 5.5 for 5.5 Mb/s.
1538 Set the location to use in calculating regulatory constraints.
1539 The location is also advertised in beacon and probe response frames
1540 when 802.11d is enabled with
1549 Enable powersave operation.
1550 When operating as a client, the station will conserve power by
1551 periodically turning off the radio and listening for
1552 messages from the access point telling it there are packets waiting.
1553 The station must then retrieve the packets.
1554 Not all devices support power save operation as a client.
1555 The 802.11 specification requires that all access points support
1556 power save but some drivers do not.
1559 to disable powersave operation when operating as a client.
1560 .It Cm powersavemode Ar mode
1562 The set of valid modes is
1573 .It Cm powersavesleep Ar sleep
1574 Set the desired max powersave sleep time in TU's (1024 microseconds).
1575 By default the max powersave sleep time is 100 TU's.
1576 .It Cm protmode Ar technique
1577 For interfaces operating in 802.11g, use the specified
1579 for protecting OFDM frames in a mixed 11b/11g network.
1580 The set of valid techniques is
1586 Technique names are case insensitive.
1587 Not all devices support
1589 as a protection technique.
1591 When operating as an access point in 802.11g mode allow only
1592 11g-capable stations to associate (11b-only stations are not
1593 permitted to associate).
1594 To allow both 11g and 11b-only stations to associate, use
1597 When operating as an access point in 802.11n mode allow only
1598 HT-capable stations to associate (legacy stations are not
1599 permitted to associate).
1600 To allow both HT and legacy stations to associate, use
1602 .It Cm regdomain Ar sku
1603 Set the regulatory domain to use in calculating the regulatory constraints
1605 In particular the set of available channels, how the wireless device
1606 will operation on the channels, and the maximum transmit power that
1607 can be used on a channel are defined by this setting.
1608 Regdomain codes (SKU's) are taken from
1609 .Pa /etc/regdomain.xml
1610 and can also be viewed with the
1613 Note that not all devices support changing the regdomain from a default
1614 setting; typically stored in EEPROM.
1622 Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n
1624 Note that RIFS must be supported by both the station and access point
1626 To disable RIFS, use
1628 .It Cm roam:rate Ar rate
1629 Set the threshold for controlling roaming when operating in a BSS.
1632 parameter specifies the transmit rate in megabits
1633 at which roaming should be considered.
1634 If the current transmit rate drops below this setting and background scanning
1635 is enabled, then the system will check if a more desirable access point is
1636 available and switch over to it.
1637 The current scan cache contents are used if they are considered
1638 valid according to the
1640 parameter; otherwise a background scan operation is triggered before
1641 any selection occurs.
1642 Each channel type has a separate rate threshold; the default values are:
1643 12 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng).
1644 .It Cm roam:rssi Ar rssi
1645 Set the threshold for controlling roaming when operating in a BSS.
1648 parameter specifies the receive signal strength in dBm units
1649 at which roaming should be considered.
1650 If the current rssi drops below this setting and background scanning
1651 is enabled, then the system will check if a more desirable access point is
1652 available and switch over to it.
1653 The current scan cache contents are used if they are considered
1654 valid according to the
1656 parameter; otherwise a background scan operation is triggered before
1657 any selection occurs.
1658 Each channel type has a separate rssi threshold; the default values are
1660 .It Cm roaming Ar mode
1661 When operating as a station, control how the system will
1662 behave when communication with the current access point
1666 argument may be one of
1668 (leave it to the hardware device to decide),
1670 (handle either in the device or the operating system\[em]as appropriate),
1672 (do nothing until explicitly instructed).
1673 By default, the device is left to handle this if it is
1674 capable; otherwise, the operating system will automatically
1675 attempt to reestablish communication.
1676 Manual mode is used by applications such as
1677 .Xr wpa_supplicant 8
1678 that want to control the selection of an access point.
1679 .It Cm rtsthreshold Ar length
1680 Set the threshold for which
1681 transmitted frames are preceded by transmission of an
1687 is the frame size in bytes and must be in the range 1 to 2346.
1694 disables transmission of RTS frames.
1695 Not all adapters support setting the RTS threshold.
1697 Initiate a scan of neighboring stations, wait for it to complete, and
1698 display all stations found.
1699 Only the super-user can initiate a scan.
1702 for information on the display.
1703 By default a background scan is done; otherwise a foreground
1704 scan is done and the station may roam to a different access point.
1707 request can be used to show recent scan results without
1708 initiating a new scan.
1709 .It Cm scanvalid Ar threshold
1710 Set the maximum time the scan cache contents are considered valid;
1711 i.e., will be used without first triggering a scan operation to
1715 parameter is specified in seconds and defaults to 60 seconds.
1716 The minimum setting for
1719 One should take care setting this threshold; if it is set too low
1720 then attempts to roam to another access point may trigger unnecessary
1721 background scan operations.
1723 Enable use of Short Guard Interval when operating in 802.11n
1725 NB: this currently enables Short GI on both HT40 and HT20 channels.
1726 To disable Short GI, use
1729 Enable use of Static Spatial Multiplexing Power Save (SMPS)
1730 when operating in 802.11n.
1731 A station operating with Static SMPS maintains only a single
1732 receive chain active (this can significantly reduce power consumption).
1733 To disable SMPS, use
1736 Enable use of Dynamic Spatial Multiplexing Power Save (SMPS)
1737 when operating in 802.11n.
1738 A station operating with Dynamic SMPS maintains only a single
1739 receive chain active but switches to multiple receive chains when it
1740 receives an RTS frame (this can significantly reduce power consumption).
1741 Note that stations cannot distinguish between RTS/CTS intended to
1742 enable multiple receive chains and those used for other purposes.
1743 To disable SMPS, use
1746 Set the desired Service Set Identifier (aka network name).
1747 The SSID is a string up to 32 characters
1748 in length and may be specified as either a normal string or in
1749 hexadecimal when preceded by
1751 Additionally, the SSID may be cleared by setting it to
1753 .It Cm tdmaslot Ar slot
1754 When operating with TDMA, use the specified
1759 is a number between 0 and the maximum number of slots in the BSS.
1760 Note that a station configured as slot 0 is a master and
1761 will broadcast beacon frames advertising the BSS;
1762 stations configured to use other slots will always
1763 scan to locate a master before they ever transmit.
1767 .It Cm tdmaslotcnt Ar cnt
1768 When operating with TDMA, setup a BSS with
1771 The slot count may be at most 8.
1772 The current implementation is only tested with two stations
1773 (i.e., point-to-point applications).
1774 This setting is only meaningful when a station is configured as slot 0;
1775 other stations adopt this setting from the BSS they join.
1779 .It Cm tdmaslotlen Ar len
1780 When operating with TDMA, setup a BSS such that each station has a slot
1783 The slot length must be at least 150 microseconds (1/8 TU)
1784 and no more than 65 milliseconds.
1785 Note that setting too small a slot length may result in poor channel
1786 bandwidth utilization due to factors such as timer granularity and
1788 This setting is only meaningful when a station is configured as slot 0;
1789 other stations adopt this setting from the BSS they join.
1792 is set to 10 milliseconds.
1793 .It Cm tdmabintval Ar intval
1794 When operating with TDMA, setup a BSS such that beacons are transmitted every
1796 superframes to synchronize the TDMA slot timing.
1797 A superframe is defined as the number of slots times the slot length; e.g.,
1798 a BSS with two slots of 10 milliseconds has a 20 millisecond superframe.
1799 The beacon interval may not be zero.
1802 causes the timers to be resynchronized more often; this can be help if
1803 significant timer drift is observed.
1808 When operating as an access point with WPA/802.11i allow legacy
1809 stations to associate using static key WEP and open authentication.
1810 To disallow legacy station use of WEP, use
1812 .It Cm txpower Ar power
1813 Set the power used to transmit frames.
1816 argument is specified in .5 dBm units.
1817 Out of range values are truncated.
1818 Typically only a few discreet power settings are available and
1819 the driver will use the setting closest to the specified value.
1820 Not all adapters support changing the transmit power.
1821 .It Cm ucastrate Ar rate
1822 Set a fixed rate for transmitting unicast frames.
1823 Rates are specified as megabits/second in decimal;
1824 e.g.\& 5.5 for 5.5 Mb/s.
1825 This rate should be valid for the current operating conditions;
1826 if an invalid rate is specified drivers are free to choose an
1828 .It Cm wepmode Ar mode
1829 Set the desired WEP mode.
1830 Not all adapters support all modes.
1831 The set of valid modes is
1837 mode explicitly tells the adapter to allow association with access
1838 points which allow both encrypted and unencrypted traffic.
1841 means that the access point must only allow encrypted connections.
1844 is generally another name for
1846 Modes are case insensitive.
1847 .It Cm weptxkey Ar index
1848 Set the WEP key to be used for transmission.
1849 This is the same as setting the default transmission key with
1851 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
1852 Set the selected WEP key.
1855 is not given, key 1 is set.
1856 A WEP key will be either 5 or 13
1857 characters (40 or 104 bits) depending on the local network and the
1858 capabilities of the adapter.
1859 It may be specified either as a plain
1860 string or as a string of hexadecimal digits preceded by
1862 For maximum portability, hex keys are recommended;
1863 the mapping of text keys to WEP encryption is usually driver-specific.
1866 drivers do this mapping differently to
1868 A key may be cleared by setting it to
1870 If WEP is supported then there are at least four keys.
1871 Some adapters support more than four keys.
1872 If that is the case, then the first four keys
1873 (1-4) will be the standard temporary keys and any others will be adapter
1874 specific keys such as permanent keys stored in NVRAM.
1876 Note that you must set a default transmit key with
1878 for the system to know which key to use in encrypting outbound traffic.
1880 Enable Wireless Multimedia Extensions (WME) support, if available,
1881 for the specified interface.
1882 WME is a subset of the IEEE 802.11e standard to support the
1883 efficient communication of realtime and multimedia data.
1884 To disable WME support, use
1886 Another name for this parameter is
1889 The following parameters are meaningful only when WME support is in use.
1890 Parameters are specified per-AC (Access Category) and
1891 split into those that are used by a station when acting
1892 as an access point and those for client stations in the BSS.
1893 The latter are received from the access point and may not be changed
1895 The following Access Categories are recognized:
1897 .Bl -tag -width ".Cm AC_BK" -compact
1901 best effort delivery,
1916 AC parameters are case-insensitive.
1917 Traffic classification is done in the operating system using the
1918 vlan priority associated with data frames or the
1919 ToS (Type of Service) indication in IP-encapsulated frames.
1920 If neither information is present, traffic is assigned to the
1921 Best Effort (BE) category.
1922 .Bl -tag -width indent
1924 Set the ACK policy for QoS transmissions by the local station;
1925 this controls whether or not data frames transmitted by a station
1926 require an ACK response from the receiving station.
1927 To disable waiting for an ACK, use
1929 This parameter is applied only to the local station.
1931 Enable the Admission Control Mandatory (ACM) mechanism
1932 for transmissions by the local station.
1933 To disable the ACM, use
1935 On stations in a BSS this parameter is read-only and indicates
1936 the setting received from the access point.
1937 NB: ACM is not supported right now.
1938 .It Cm aifs Ar ac Ar count
1939 Set the Arbitration Inter Frame Spacing (AIFS)
1940 channel access parameter to use for transmissions
1941 by the local station.
1942 On stations in a BSS this parameter is read-only and indicates
1943 the setting received from the access point.
1944 .It Cm cwmin Ar ac Ar count
1945 Set the CWmin channel access parameter to use for transmissions
1946 by the local station.
1947 On stations in a BSS this parameter is read-only and indicates
1948 the setting received from the access point.
1949 .It Cm cwmax Ar ac Ar count
1950 Set the CWmax channel access parameter to use for transmissions
1951 by the local station.
1952 On stations in a BSS this parameter is read-only and indicates
1953 the setting received from the access point.
1954 .It Cm txoplimit Ar ac Ar limit
1955 Set the Transmission Opportunity Limit channel access parameter
1956 to use for transmissions by the local station.
1957 This parameter defines an interval of time when a WME station
1958 has the right to initiate transmissions onto the wireless medium.
1959 On stations in a BSS this parameter is read-only and indicates
1960 the setting received from the access point.
1961 .It Cm bss:aifs Ar ac Ar count
1962 Set the AIFS channel access parameter to send to stations in a BSS.
1963 This parameter is meaningful only when operating in AP mode.
1964 .It Cm bss:cwmin Ar ac Ar count
1965 Set the CWmin channel access parameter to send to stations in a BSS.
1966 This parameter is meaningful only when operating in AP mode.
1967 .It Cm bss:cwmax Ar ac Ar count
1968 Set the CWmax channel access parameter to send to stations in a BSS.
1969 This parameter is meaningful only when operating in AP mode.
1970 .It Cm bss:txoplimit Ar ac Ar limit
1971 Set the TxOpLimit channel access parameter to send to stations in a BSS.
1972 This parameter is meaningful only when operating in AP mode.
1975 Enable Wireless Privacy Subscriber support.
1976 Note that WPS support requires a WPS-capable supplicant.
1977 To disable this function, use
1981 .Ss WLAN ACL Parameters
1982 The following parameters support an optional access control list (ACL)
1983 feature available with some adapters when operating in AP mode;
1986 This facility allows an access point to accept/deny association
1987 requests based on the MAC address of the station.
1988 Note that this feature does not significantly enhance security
1989 as MAC address spoofing is easy to do.
1990 .Bl -tag -width indent
1991 .It Cm mac:add Ar address
1992 Add the specified MAC address to the database.
1993 Depending on the policy setting association requests from the
1994 specified station will be allowed or denied.
1996 Set the ACL policy to permit association only by
1997 stations registered in the database.
1998 .It Cm mac:del Ar address
1999 Delete the specified MAC address from the database.
2001 Set the ACL policy to deny association only by
2002 stations registered in the database.
2003 .It Cm mac:kick Ar address
2004 Force the specified station to be deauthenticated.
2005 This typically is done to block a station after updating the
2008 Set the ACL policy to allow all stations to associate.
2010 Delete all entries in the database.
2012 Set the ACL policy to permit association only by
2013 stations approved by a RADIUS server.
2014 Note that this feature requires the
2016 program be configured to do the right thing
2017 as it handles the RADIUS processing
2018 (and marks stations as authorized).
2021 .Ss WLAN Mesh Mode Parameters
2022 The following parameters are related to a wireless interface
2023 operating in mesh mode:
2024 .Bl -tag -width indent
2025 .It Cm meshid Ar meshid
2026 Set the desired Mesh Identifier.
2027 The Mesh ID is a string up to 32 characters in length.
2028 A mesh interface must have a Mesh Identifier specified
2029 to reach an operational state.
2030 .It Cm meshttl Ar ttl
2033 for mesh forwarded packets; this is the number of hops a packet
2034 may be forwarded before it is discarded.
2035 The default setting for
2039 Enable or disable peering with neighbor mesh stations.
2040 Stations must peer before any data packets can be exchanged.
2045 Enable or disable forwarding packets by a mesh interface.
2049 .It Cm meshmetric Ar protocol
2052 as the link metric protocol used on a mesh network.
2053 The default protocol is called
2055 The mesh interface will restart after changing this setting.
2056 .It Cm meshpath Ar protocol
2059 as the path selection protocol used on a mesh network.
2060 The only available protocol at the moment is called
2062 (Hybrid Wireless Mesh Protocol).
2063 The mesh interface will restart after changing this setting.
2064 .It Cm hwmprootmode Ar mode
2065 Stations on a mesh network can operate as
2067 Root nodes try to find paths to all mesh nodes and advertise themselves
2069 When there is a root mesh node on a network, other mesh nodes can setup
2070 paths between themselves faster because they can use the root node
2071 to find the destination.
2072 This path may not be the best, but on-demand
2073 routing will eventually find the best path.
2074 The following modes are recognized:
2076 .Bl -tag -width ".Cm PROACTIVE" -compact
2080 Send broadcast path requests every two seconds.
2081 Nodes on the mesh without a path to this root mesh station with try to
2082 discover a path to us.
2084 Send broadcast path requests every two seconds and every node must reply
2085 with a path reply even if it already has a path to this root mesh station,
2087 Send broadcast root announcement (RANN) frames.
2088 Nodes on the mesh without a path to this root mesh station with try to
2089 discover a path to us.
2096 .It Cm hwmpmaxhops Ar cnt
2097 Set the maximum number of hops allowed in an HMWP path to
2099 The default setting for
2104 .Ss WLAN Compatibility Parameters
2105 The following parameters are for compatibility with other systems:
2106 .Bl -tag -width indent
2108 Another name for the
2114 .It Cm stationname Ar name
2115 Set the name of this station.
2116 The station name is not part of the IEEE 802.11
2117 protocol though some interfaces support it.
2119 seems to be meaningful to identical or virtually identical equipment.
2120 Setting the station name is identical in syntax to setting the SSID.
2127 Another way of saying
2133 Another way of saying
2139 Another way of saying:
2140 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
2146 .Ar n : k1 , k2 , k3 , k4
2149 Another way of saying:
2150 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
2155 Another way of saying
2162 .Ss Bridge Interface Parameters
2163 The following parameters are specific to bridge interfaces:
2164 .Bl -tag -width indent
2165 .It Cm addm Ar interface
2166 Add the interface named by
2168 as a member of the bridge.
2169 The interface is put into promiscuous mode
2170 so that it can receive every packet sent on the network.
2171 .It Cm deletem Ar interface
2172 Remove the interface named by
2175 Promiscuous mode is disabled on the interface when
2176 it is removed from the bridge.
2177 .It Cm maxaddr Ar size
2178 Set the size of the bridge address cache to
2180 The default is 100 entries.
2181 .It Cm timeout Ar seconds
2182 Set the timeout of address cache entries to
2187 is zero, then address cache entries will not be expired.
2188 The default is 1200 seconds.
2190 Display the addresses that have been learned by the bridge.
2191 .It Cm static Ar interface-name Ar address
2192 Add a static entry into the address cache pointing to
2193 .Ar interface-name .
2194 Static entries are never aged out of the cache or re-placed, even if the
2195 address is seen on a different interface.
2196 .It Cm deladdr Ar address
2199 from the address cache.
2201 Delete all dynamically-learned addresses from the address cache.
2203 Delete all addresses, including static addresses, from the address cache.
2204 .It Cm discover Ar interface
2205 Mark an interface as a
2208 When the bridge has no address cache entry
2209 (either dynamic or static)
2210 for the destination address of a packet,
2211 the bridge will forward the packet to all
2212 member interfaces marked as
2214 This is the default for all interfaces added to a bridge.
2215 .It Cm -discover Ar interface
2218 attribute on a member interface.
2219 For packets without the
2221 attribute, the only packets forwarded on the interface are broadcast
2222 or multicast packets and packets for which the destination address
2223 is known to be on the interface's segment.
2224 .It Cm learn Ar interface
2225 Mark an interface as a
2228 When a packet arrives on such an interface, the source
2229 address of the packet is entered into the address cache as being a
2230 destination address on the interface's segment.
2231 This is the default for all interfaces added to a bridge.
2232 .It Cm -learn Ar interface
2235 attribute on a member interface.
2236 .It Cm span Ar interface
2237 Add the interface named by
2239 as a span port on the bridge.
2240 Span ports transmit a copy of every frame received by the bridge.
2241 This is most useful for snooping a bridged network passively on
2242 another host connected to one of the span ports of the bridge.
2243 .It Cm -span Ar interface
2244 Delete the interface named by
2246 from the list of span ports of the bridge.
2247 .It Cm stp Ar interface
2248 Enable Spanning Tree protocol on
2252 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
2253 Spanning Tree is used to detect and remove loops in a network topology.
2254 .It Cm -stp Ar interface
2255 Disable Spanning Tree protocol on
2257 This is the default for all interfaces added to a bridge.
2258 .It Cm maxage Ar seconds
2259 Set the time that a Spanning Tree protocol configuration is valid.
2260 The default is 20 seconds.
2261 The minimum is 1 second and the maximum is 255 seconds.
2262 .It Cm fwddelay Ar seconds
2263 Set the time that must pass before an interface begins forwarding
2264 packets when Spanning Tree is enabled.
2265 The default is 15 seconds.
2266 The minimum is 1 second and the maximum is 255 seconds.
2267 .It Cm hellotime Ar seconds
2268 Set the time between broadcasting of Spanning Tree protocol
2269 configuration messages.
2270 The default is 2 seconds.
2271 The minimum is 1 second and the maximum is 255 seconds.
2272 .It Cm priority Ar value
2273 Set the bridge priority for Spanning Tree.
2274 The default is 32768.
2275 The minimum is 0 and the maximum is 65536.
2276 .It Cm ifpriority Ar interface Ar value
2277 Set the Spanning Tree priority of
2282 The minimum is 0 and the maximum is 255.
2284 The priority is used to select which interface out of all
2285 forwarding and bonded interfaces with the same MAC
2286 to output a packet on.
2287 The interface with the highest priority will be
2289 When multiple interfaces are valid and share the same (highest) priority,
2292 flag on the bridge interface determines determines operation.
2293 If not set, packets will only be output on one interface.
2294 If set, packets will be round-robined on all valid interfaces sharing the
2295 same priority by counting
2297 packets on each interface, then moving to the next.
2298 Note that interfaces in the
2300 or any other less-than-good state
2301 does not participate in the priority selection.
2302 If the priorities are the same on a non-bonded member, the
2303 designated member will be used.
2304 .It Cm ifpathcost Ar interface Ar value
2305 Set the Spanning Tree path cost of
2310 The minimum is 0 and the maximum is 65535.
2312 The path cost is added to both incoming and outgoing packets on the
2313 member, lower values will make the member more valuable.
2314 .It Cm ifbondweight Ar interface Ar value
2315 Set the number of packets to output on a bonded member before
2316 round-robining to the next member.
2318 Larger values or different values for each member can be used
2319 if bursting would be beneficial or if the outgoing bandwidth
2320 on each of the members is asymmetric.
2321 For example, one specify a value of 6 on tap0 and 4 on tap1
2323 Remember that this also controls packet bursting.
2325 This option enables transparent bridging mode.
2326 The bridge will make every effort to retain the Ethernet header
2327 when forwarding packets between interfaces, making the bridging
2328 function work more like a hardware bridge device.
2330 This option enables keepalive transmission and automatically
2331 places a member into a special blocked mode if no keepalive reception
2333 If either sides of the link uses this option then both sides must use
2335 This option is implemented by sending CFG updates on the hello interval
2337 The link is considered lost after 10 intervals (typically 20 seconds).
2339 This option enables channel bonding (see also
2344 All member interfaces with the same MAC address are considered to
2345 be in a bonding group.
2346 If multiple interfaces in the bonding group share the highest priority via
2348 packets will be round-robined between them.
2351 is used, you can manually control or copy the MAC to create bonding groups.
2352 When interface bonding is enabled normally blocked interfaces belonging
2353 to the same bonding group as an active forwarding interface will be
2354 changed to the bonding state.
2355 Both sides of link the member represents must operate in bonding mode
2356 for this to work, otherwise the remote end may decide to throw away
2360 .Ss Generic IP Tunnel Parameters
2361 The following parameters are specific to
2363 IP tunnel interfaces:
2364 .Bl -tag -width indent
2365 .It Cm tunnel Ar src_addr dest_addr
2366 Configure the physical source and destination address for IP tunnel
2372 are interpreted as the outer source/destination for the encapsulating
2375 Unconfigure the physical source and destination address for IP tunnel
2376 interfaces previously configured with
2379 Another name for the
2385 The following parameters are specific to
2388 .Bl -tag -width indent
2389 .It Cm vlan Ar vlan_tag
2390 Set the VLAN tag value to
2392 This value is a 16-bit number which is used to create an 802.1Q
2393 VLAN header for packets sent from the
2400 must both be set at the same time.
2401 .It Cm vlandev Ar iface
2402 Associate the physical interface
2407 Packets transmitted through the
2410 diverted to the specified physical interface
2412 with 802.1Q VLAN encapsulation.
2413 Packets with 802.1Q encapsulation received
2414 by the parent interface with the correct VLAN tag will be diverted to
2420 interface is assigned a
2421 copy of the parent interface's flags and the parent's Ethernet address.
2426 must both be set at the same time.
2429 interface already has
2430 a physical interface associated with it, this command will fail.
2431 To change the association to another physical interface,
2432 the existing association must be cleared first.
2434 Note: if the hardware tagging capability
2435 is set on the parent interface, the
2438 interface's behavior changes:
2441 interface recognizes that the
2442 parent interface supports insertion and extraction of VLAN tags on its
2443 own (usually in firmware) and that it should pass packets to and from
2444 the parent unaltered.
2445 .It Cm -vlandev Op Ar iface
2448 pseudo device, disassociate the parent interface from it.
2449 This breaks the link between the
2451 interface and its parent, clears its VLAN tag,
2452 flags and its link address and shuts the interface down.
2455 argument is useless and hence deprecated.
2459 The following parameters are specific to
2462 .Bl -tag -width indent
2463 .It Cm advbase Ar seconds
2464 Specifies the base of the advertisement interval in seconds.
2465 The acceptable values are 1 to 255.
2466 The default value is 1.
2467 .\" The default value is
2468 .\" .Dv CARP_DFLTINTV .
2469 .It Cm advskew Ar interval
2470 Specifies the skew to add to the base advertisement interval to
2471 make one host advertise slower than another host.
2472 It is specified in 1/256 of seconds.
2473 The acceptable values are 1 to 254.
2474 The default value is 0.
2475 .It Cm pass Ar phrase
2476 Set the authentication key to
2479 Set the virtual host ID.
2480 This is a required setting.
2481 Acceptable values are 1 to 255.
2484 .Ss WireGuard Parameters
2485 The following parameters are available to
2488 .Bl -tag -width indent
2489 .\" TODO: uncomment this when ipfw/pf is ready ...
2490 .\" .It Cm wgcookie Ar cookie
2493 .\" which is an arbitrary 32-bit unsigned integer,
2494 .\" for the interface's underlying socket.
2495 .\" The cookie can then be used by
2499 .\" to manipulate the traffic of this interface.
2500 .\" .It Cm -wgcookie
2501 .\" Remove the custom cookie from the interface's underlying socket.
2502 .It Cm wgkey Ar privatekey
2503 Set the private key of the interface.
2506 is 32 bytes in base64 encoding.
2507 It can be generated as follows:
2509 .Dl $ openssl rand -base64 32
2511 The corresponding public key will then be displayed
2512 in the interface status for distribution to peers.
2513 By default, the status output will exclude the private key,
2517 .It Cm wgpeer Ar publickey
2518 Add or specify a peer by its
2520 which is also 32 bytes in base64 encoding.
2521 Repeat this parameter to specify multiple peers in a single command.
2522 .It Cm -wgpeer Ar publickey
2523 Remove the peer with the given
2526 Remove all peers from the interface.
2527 .It Cm wgport Ar port
2528 Set the interface's UDP
2530 for exchanging traffic with its peers.
2531 The interface will bind to
2534 .Dv IN6ADDR_ANY_INIT .
2535 By default, the interface will choose a port automatically.
2538 Peer configuration parameters, which apply to the
2540 parameter immediately preceding them,
2542 .Bl -tag -width indent
2543 .It Cm wgdescr Ns Oo Cm iption Oc Ar value
2544 Specify a description for the peer.
2545 This can be used to label peers in situations where they may
2546 otherwise be difficult to distinguish.
2547 .It Cm -wgdescr Ns Op Cm iption
2548 Clear the peer description.
2549 .It Cm wgaip Ar address/prefix
2550 Set the peer's IPv4 or IPv6 address range (in CIDR notation)
2551 allowed for its tunneled traffic.
2552 Repeat this parameter to set multiple ranges.
2553 By default, no address is allowed.
2554 .It Cm wgendpoint Ar address port
2555 Address traffic to the peer's IPv4 or IPv6
2559 The interface will track the peer and update
2561 to the source of its last authenticated packet.
2562 By default, the endpoint is unknown and so the peer cannot
2563 be addressed until it initiates communication.
2564 This implies that at least one peer in each pair must specify
2566 .It Cm wgpka Ar interval
2569 of persistent keepalive packets in seconds.
2570 They can be used to maintain connectivity to a peer otherwise blocked
2571 to unsolicited traffic by an intermediate firewall or NAT device.
2574 of 25 seconds should suffice.
2575 By default, the persistent keepalive is disabled.
2577 Disable the persistent keepalive for this peer.
2578 .It Cm wgpsk Ar presharedkey
2579 Set a unique key pre-shared with the peer.
2580 This strengthens the Diffie-Hellman exchange should in future
2581 an attack on it become feasible.
2584 is also 32 bytes in base64 encoding.
2585 It is optional but recommended;
2586 it can be generated in the same way as the
2590 Remove the pre-shared key for this peer.
2594 The following environment variables affect the execution of
2596 .Bl -tag -width IFCONFIG_FORMAT
2597 .It Ev IFCONFIG_FORMAT
2598 This variable can contain a specification of the output format.
2599 See the description of the
2601 option for more details.
2604 Messages indicating the specified interface does not exist, the
2605 requested address is unknown, or the user is not privileged and
2606 tried to alter an interface's configuration.
2624 Basic IPv6 node operation requires a link-local address on each
2625 interface configured for IPv6.
2626 Normally, such an address is automatically configured by the
2627 kernel on each interface added to the system; this behavior may
2628 be disabled by setting the sysctl MIB variable
2629 .Va net.inet6.ip6.auto_linklocal
2632 If you delete such an address using
2634 the kernel may act very odd.
2635 Do this at your own risk.
projects / dragonfly.git / blob