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
163 The default if available is
173 Specify the address of the correspondent on the other end
174 of a point to point link.
177 parameter is a string of the form
182 List the interfaces in the given group.
185 The following parameters may be set with
187 .Bl -tag -width indent
192 Introduced for compatibility
196 Establish an additional network address for this interface.
197 This is sometimes useful when changing network numbers, and
198 one wishes to accept packets addressed to the old interface.
199 If the address is on the same subnet as the first network address
200 for this interface, a non-conflicting netmask must be given.
205 Remove the network address specified.
206 This would be used if you incorrectly specified an alias, or it
207 was no longer needed.
208 If you have incorrectly set an NS address having the side effect
209 of specifying the host portion, removing all NS addresses will
210 allow you to respecify the host portion.
213 Specify that the address configured is an anycast address.
214 Based on the current specification,
215 only routers may configure anycast addresses.
216 Anycast address will not be used as source address of any of outgoing
219 Enable the use of the Address Resolution Protocol
222 between network level addresses and link level addresses (default).
223 This is currently implemented for mapping between
228 802 48-bit MAC addresses (Ethernet, FDDI, and Token Ring addresses).
230 Disable the use of the Address Resolution Protocol
233 If the Address Resolution Protocol is enabled,
234 the host will only reply to requests for its addresses,
235 and will never send any requests.
237 If the Address Resolution Protocol is enabled,
238 the host will perform normally,
239 sending out requests and listening for replies.
242 Specify the address to use to represent broadcasts to the
244 The default broadcast address is the address with a host part of all 1's.
246 Enable driver dependent debugging code; usually, this turns on
247 extra console error logging.
249 Disable driver dependent debugging code.
251 Put interface into permanently promiscuous mode.
253 Disable permanently promiscuous mode.
258 .It Cm description Ar value , Cm descr Ar value
259 Specify a description of the interface.
260 This can be used to label interfaces in situations where they may
261 otherwise be difficult to distinguish.
262 .It Cm -description , Cm -descr
263 Clear the interface description.
267 When an interface is marked
269 the system will not attempt to
270 transmit messages through that interface.
271 If possible, the interface will be reset to disable reception as well.
272 This action does not automatically disable routes using the interface.
273 .It Cm group Ar group-name
274 Assign the interface to a
276 Any interface can be in multiple groups.
278 Cloned interfaces are members of their interface family group by default.
279 For example, a PPP interface such as
281 is a member of the PPP interface family group,
283 .\" The interface(s) the default route(s) point to are members of the
286 .It Cm -group Ar group-name
287 Remove the interface from the given
292 (lowermost 64bit of an IPv6 address)
294 .It Cm fib Ar fib_number
295 Specify interface FIB.
298 is assigned to all frames or packets received on that interface.
299 The FIB is not inherited, e.g., vlans or other sub-interfaces will use
300 the default FIB (0) irrespective of the parent interface's FIB.
301 The kernel needs to be tuned to support more than the default FIB
304 kernel configuration option, or the
307 .It Cm maclabel Ar label
308 If Mandatory Access Control support is enabled in the kernel,
312 .\" .Xr maclabel 7 ) .
314 If the driver supports the media selection system, set the media type
317 Some interfaces support the mutually exclusive use of one of several
318 different physical media connectors.
319 For example, a 10Mbit/s Ethernet
320 interface might support the use of either
322 or twisted pair connectors.
323 Setting the media type to
325 would change the currently active connector to the AUI port.
328 would activate twisted pair.
329 Refer to the interfaces' driver
330 specific documentation or man page for a complete list of the
332 .It Cm mediaopt Ar opts
333 If the driver supports the media selection system, set the specified
334 media options on the interface.
338 is a comma delimited list of options to apply to the interface.
339 Refer to the interfaces' driver specific man page for a complete
340 list of available options.
341 .It Fl mediaopt Ar opts
342 If the driver supports the media selection system, disable the
343 specified media options on the interface.
345 If the driver supports the media selection system, set the specified
346 operating mode on the interface to
348 For IEEE 802.11 wireless interfaces that support multiple operating modes
349 this directive is used to select between 802.11a
356 .It Cm inst Ar minst , Cm instance Ar minst
357 Set the media instance to
359 This is useful for devices which have multiple physical layer interfaces
362 Set the interface name to
364 .It Cm rxcsum , txcsum , rxcsum6 , txcsum6
365 If the driver supports user-configurable checksum offloading,
366 enable receive (or transmit) checksum offloading on the interface.
367 The feature can be turned on selectively per protocol family.
369 .Cm rxcsum6 , txcsum6
375 Some drivers may not be able to enable these flags independently
376 of each other, so setting one may also set the other.
377 The driver will offload as much checksum work as it can reliably
378 support, the exact level of offloading varies between drivers.
379 .It Fl rxcsum , txcsum , rxcsum6 , txcsum6
380 If the driver supports user-configurable checksum offloading,
381 disable receive (or transmit) checksum offloading on the interface.
382 The feature can be turned off selectively per protocol family.
384 .Fl rxcsum6 , txcsum6
390 These settings may not always be independent of each other.
392 If the driver supports
394 segmentation offloading, enable TSO on the interface.
395 Some drivers may not be able to support TSO for
399 packets, so they may enable only one of them.
401 If the driver supports
403 segmentation offloading, disable TSO on the interface.
404 It will always disable TSO for
409 If the driver supports
411 segmentation offloading for
415 use one of these to selectively enabled it only for one protocol family.
417 If the driver supports
419 segmentation offloading for
423 use one of these to selectively disable it only for one protocol family.
425 If the driver supports
427 large receive offloading, enable LRO on the interface.
429 If the driver supports
431 large receive offloading, disable LRO on the interface.
432 .It Cm wol , wol_ucast , wol_mcast , wol_magic
433 Enable Wake On Lan (WOL) support, if available.
434 WOL is a facility whereby a machine in a low power state may be woken
435 in response to a received packet.
436 There are three types of packets that may wake a system:
437 ucast (directed solely to the machine's mac address),
438 mcast (directed to a broadcast or multicast address),
440 magic (unicast or multicast frames with a ``magic contents'').
441 Not all devices support WOL, those that do indicate the mechanisms
442 they support in their capabilities.
444 is a synonym for enabling all available WOL mechanisms.
447 .It Cm vlanmtu , vlanhwtag, vlanhwfilter, vlanhwcsum, vlanhwtso
448 If the driver offers user-configurable VLAN support, enable
449 reception of extended frames, tag processing in hardware,
450 frame filtering in hardware, checksum offloading, or TSO on VLAN,
452 Note that this must be issued on a physical interface associated with
457 .It Fl vlanmtu , vlanhwtag, vlanhwfilter, vlanhwtso
458 If the driver offers user-configurable VLAN support, disable
459 reception of extended frames, tag processing in hardware,
460 frame filtering in hardware, or TSO on VLAN,
463 Move the interface to the
465 specified by name or JID.
466 If the jail has a virtual network stack, the interface will disappear
467 from the current environment and become visible to the jail.
469 Reclaim the interface from the
471 specified by name or JID.
472 If the jail has a virtual network stack, the interface will disappear
473 from the jail, and become visible to the current network environment.
477 feature and disable interrupts on the interface, if driver supports
482 feature and enable interrupt mode on the interface.
484 Create the specified network pseudo-device.
485 If the interface is given without a unit number, try to create a new
486 device with an arbitrary unit number.
487 If creation of an arbitrary device is successful, the new device name is
488 printed to standard output unless the interface is renamed or destroyed
493 Destroy the specified network pseudo-device.
509 Set the routing metric of the interface to
512 The routing metric is used by the routing protocol
514 Higher metrics have the effect of making a route
515 less favorable; metrics are counted as additional hops
516 to the destination network or host.
518 Set the maximum transmission unit of the interface to
520 default is interface specific.
521 The MTU is used to limit the size of packets that are transmitted on an
523 Not all interfaces support setting the MTU, and some interfaces have
525 .It Cm netmask Ar mask
528 Specify how much of the address to reserve for subdividing
529 networks into sub-networks.
530 The mask includes the network part of the local address
531 and the subnet part, which is taken from the host field of the address.
532 The mask can be specified as a single hexadecimal number
535 with a dot-notation Internet address,
536 or with a pseudo-network name listed in the network table
538 The mask contains 1's for the bit positions in the 32-bit address
539 which are to be used for the network and subnet parts,
540 and 0's for the host part.
541 The mask should contain at least the standard network portion,
542 and the subnet field should be contiguous with the network
545 The netmask can also be specified in CIDR notation after the address.
548 option above for more information.
549 .It Cm prefixlen Ar len
553 bits are reserved for subdividing networks into sub-networks.
556 must be integer, and for syntactical reason it must be between 0 to 128.
557 It is almost always 64 under the current IPv6 assignment rule.
558 If the parameter is omitted, 64 is used.
560 The prefix can also be specified using the slash notation after the address.
563 option above for more information.
568 Introduced for compatibility
572 .It Cm link Op Cm 0 No - Cm 2
574 Enable special processing of the link level of the interface.
575 These three options are interface specific in actual effect, however,
576 they are in general used to select special modes of operation.
578 of this is to enable SLIP compression, or to select the connector type
579 for some Ethernet cards.
580 Refer to the man page for the specific driver
581 for more information.
583 .It Fl link Op Cm 0 No - Cm 2
585 Disable special processing at the link level with the specified interface.
587 Put the interface in monitor mode.
588 No packets are transmitted, and received packets are discarded after
592 Take the interface out of monitor mode.
596 This may be used to enable an interface after an
598 It happens automatically when setting the first address on an interface.
599 If the interface was reset when previously marked down,
600 the hardware will be re-initialized.
603 The following parameters are for ICMPv6 Neighbor Discovery Protocol.
604 Note that the address family keyword
607 .Bl -tag -width indent
609 Set a flag to enable accepting ICMPv6 Router Advertisement messages.
613 .Va net.inet6.ip6.accept_rtadv
614 controls whether this flag is set by default or not.
619 Set a flag to control whether routers from which the system accepts
620 Router Advertisement messages will be added to the Default Router List
624 flag is disabled, this flag has no effect.
628 .Va net.inet6.ip6.no_radr
629 controls whether this flag is set by default or not.
633 .It Cm auto_linklocal
634 Set a flag to perform automatic link-local address configuration when
635 the interface becomes available.
639 .Va net.inet6.ip6.auto_linklocal
640 controls whether this flag is set by default or not.
641 .It Cm -auto_linklocal
645 Set the specified interface as the default route when there is no
651 Set a flag to disable all of IPv6 network communications on the
652 specified interface. Note that if there are already configured IPv6
653 addresses on that interface, all of them are marked as
655 and DAD will be performed when this flag is cleared.
659 When this flag is cleared and
661 flag is enabled, automatic configuration of a link-local address is
664 Set a flag to enable Neighbor Unreachability Detection.
668 .It Cm no_prefer_iface
669 Set a flag to not prefer address on the interface as candidates of the
670 source address for outgoing packets, even when the interface is
672 .It Cm -no_prefer_iface
674 .Cm no_prefer_iface .
677 The following parameters are specific to cloning
678 IEEE 802.11 wireless interfaces with the
681 .Bl -tag -width indent
682 .It Cm wlandev Ar device
685 as the parent for the cloned device.
686 .It Cm wlanmode Ar mode
687 Specify the operating mode for this cloned device.
705 The operating mode of a cloned interface cannot be changed.
708 mode is actually implemented as an
710 interface with special properties.
711 .It Cm wlanbssid Ar bssid
712 The 802.11 mac address to use for the bssid.
713 This must be specified at create time for a legacy
716 .It Cm wlanaddr Ar address
717 The local mac address.
718 If this is not specified then a mac address will automatically be assigned
719 to the cloned device.
720 Typically this address is the same as the address of the parent device
723 parameter is specified then the driver will craft a unique address for
724 the device (if supported).
728 device as operating in ``legacy mode''.
731 devices have a fixed peer relationship and do not, for example, roam
732 if their peer stops communicating.
733 For completeness a Dynamic WDS (DWDS) interface may marked as
736 Request a unique local mac address for the cloned device.
737 This is only possible if the device supports multiple mac addresses.
738 To force use of the parent's mac address use
741 Mark the cloned interface as depending on hardware support to
742 track received beacons.
743 To have beacons tracked in software use
749 can also be used to indicate no beacons should
750 be transmitted; this can be useful when creating a WDS configuration but
752 interfaces can only be created as companions to an access point.
755 The following parameters are specific to IEEE 802.11 wireless interfaces
759 .Bl -tag -width indent
761 Enable sending and receiving AMPDU frames when using 802.11n (default).
762 The 802.11n specification states a compliant station must be capable
763 of receiving AMPDU frames but transmission is optional.
766 to disable all use of AMPDU with 802.11n.
767 For testing and/or to work around interoperability problems one can use
771 to control use of AMPDU in one direction.
772 .It Cm ampdudensity Ar density
773 Set the AMPDU density parameter used when operating with 802.11n.
774 This parameter controls the inter-packet gap for AMPDU frames.
775 The sending device normally controls this setting but a receiving station
776 may request wider gaps.
779 are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds).
782 is treated the same as 0.
783 .It Cm ampdulimit Ar limit
784 Set the limit on packet size for receiving AMPDU frames when operating
788 are 8192, 16384, 32768, and 65536 but one can also specify
789 just the unique prefix: 8, 16, 32, 64.
790 Note the sender may limit the size of AMPDU frames to be less
791 than the maximum specified by the receiving station.
793 Enable sending and receiving AMSDU frames when using 802.11n.
794 By default AMSDU is received but not transmitted.
797 to disable all use of AMSDU with 802.11n.
798 For testing and/or to work around interoperability problems one can use
802 to control use of AMSDU in one direction.
803 .It Cm amsdulimit Ar limit
804 Set the limit on packet size for sending and receiving AMSDU frames
805 when operating with 802.11n.
808 are 7935 and 3839 (bytes).
809 Note the sender may limit the size of AMSDU frames to be less
810 than the maximum specified by the receiving station.
811 Note also that devices are not required to support the 7935 limit,
812 only 3839 is required by the specification and the larger value
813 may require more memory to be dedicated to support functionality
816 When operating as an access point, pass packets between
817 wireless clients directly (default).
818 To instead let them pass up through the
819 system and be forwarded using some other mechanism, use
821 Disabling the internal bridging
822 is useful when traffic is to be processed with
824 .It Cm authmode Ar mode
825 Set the desired authentication mode in infrastructure mode.
826 Not all adapters support all modes.
829 .Cm none , open , shared
835 (IEEE WPA/WPA2/802.11i).
840 modes are only useful when using an authentication service
841 (a supplicant for client operation or an authenticator when
842 operating as an access point).
843 Modes are case insensitive.
845 Enable background scanning when operating as a station.
846 Background scanning is a technique whereby a station associated to
847 an access point will temporarily leave the channel to scan for
848 neighboring stations.
849 This allows a station to maintain a cache of nearby access points
850 so that roaming between access points can be done without
851 a lengthy scan operation.
852 Background scanning is done only when a station is not busy and
853 any outbound traffic will cancel a scan operation.
854 Background scanning should never cause packets to be lost though
855 there may be some small latency if outbound traffic interrupts a
857 By default background scanning is enabled if the device is capable.
858 To disable background scanning, use
860 Background scanning is controlled by the
865 Background scanning must be enabled for roaming; this is an artifact
866 of the current implementation and may not be required in the future.
867 .It Cm bgscanidle Ar idletime
868 Set the minimum time a station must be idle (not transmitting or
869 receiving frames) before a background scan is initiated.
872 parameter is specified in milliseconds.
873 By default a station must be idle at least 250 milliseconds before
874 a background scan is initiated.
875 The idle time may not be set to less than 100 milliseconds.
876 .It Cm bgscanintvl Ar interval
877 Set the interval at which background scanning is attempted.
880 parameter is specified in seconds.
881 By default a background scan is considered every 300 seconds (5 minutes).
884 may not be set to less than 15 seconds.
885 .It Cm bintval Ar interval
886 Set the interval at which beacon frames are sent when operating in
890 parameter is specified in TU's (1024 usecs).
891 By default beacon frames are transmitted every 100 TU's.
892 .It Cm bmissthreshold Ar count
893 Set the number of consecutive missed beacons at which the station
894 will attempt to roam (i.e., search for a new access point).
897 parameter must be in the range 1 to 255; though the
898 upper bound may be reduced according to device capabilities.
899 The default threshold is 7 consecutive missed beacons; but
900 this may be overridden by the device driver.
905 .It Cm bssid Ar address
906 Specify the MAC address of the access point to use when operating
907 as a station in a BSS network.
908 This overrides any automatic selection done by the system.
909 To disable a previously selected access point, supply
914 This option is useful when more than one access point uses the same SSID.
920 Enable packet bursting.
921 Packet bursting is a transmission technique whereby the wireless
922 medium is acquired once to send multiple frames and the interframe
924 This technique can significantly increase throughput by reducing
925 transmission overhead.
926 Packet bursting is supported by the 802.11e QoS specification
927 and some devices that do not support QoS may still be capable.
928 By default packet bursting is enabled if a device is capable
930 To disable packet bursting, use
932 .It Cm chanlist Ar channels
933 Set the desired channels to use when scanning for access
934 points, neighbors in an IBSS network, or looking for unoccupied
935 channels when operating as an access point.
936 The set of channels is specified as a comma-separated list with
937 each element in the list representing either a single channel number or a range
940 Channel numbers must be in the range 1 to 255 and be permissible
941 according to the operating characteristics of the device.
942 .It Cm channel Ar number
943 Set a single desired channel.
944 Channels range from 1 to 255, but the exact selection available
945 depends on the region your adaptor was manufactured for.
951 will clear any desired channel and, if the device is marked up,
952 force a scan for a channel to operate on.
953 Alternatively the frequency, in megahertz, may be specified
954 instead of the channel number.
956 When there are several ways to use a channel the channel
957 number/frequency may be appended with attributes to clarify.
958 For example, if a device is capable of operating on channel 6
959 with 802.11n and 802.11g then one can specify that g-only use
960 should be used by specifying ``6:g''.
961 Similarly the channel width can be specified by appending it
962 with ``/''; e.g., ``6/40'' specifies a 40MHz wide channel,
963 These attributes can be combined as in: ``6:ht/40''.
964 The full set of flags specified following a ``:'' are:
970 (Atheros Dynamic Turbo mode),
978 (Atheros Static Turbo mode),
981 (Atheros Dynamic Turbo mode, or appended to ``st'' and ``dt'').
982 The full set of channel widths following a '/' are:
984 (5MHz aka quarter-rate channel),
986 (10MHz aka half-rate channel),
988 (20MHz mostly for use in specifying ht20),
991 (40MHz mostly for use in specifying ht40).
993 a 40MHz HT channel specification may include the location
994 of the extension channel by appending ``+'' or ``-'' for above and below,
995 respectively; e.g., ``2437:ht/40+'' specifies 40MHz wide HT operation
996 with the center channel at frequency 2437 and the extension channel above.
997 .It Cm country Ar name
998 Set the country code to use in calculating the regulatory constraints
1000 In particular the set of available channels, how the wireless device
1001 will operation on the channels, and the maximum transmit power that
1002 can be used on a channel are defined by this setting.
1003 Country/Region codes are specified as a 2-character abbreviation
1004 defined by ISO 3166 or using a longer, but possibly ambiguous, spelling;
1005 e.g., "ES" and "Spain".
1006 The set of country codes are taken from
1007 .Pa /etc/regdomain.xml
1009 be viewed with the ``list countries'' request.
1010 Note that not all devices support changing the country code from a default
1011 setting; typically stored in EEPROM.
1019 Enable Dynamic Frequency Selection (DFS) as specified in 802.11h.
1020 DFS embodies several facilities including detection of overlapping
1021 radar signals, dynamic transmit power control, and channel selection
1022 according to a least-congested criteria.
1023 DFS support is mandatory for some 5GHz frequencies in certain
1024 locales (e.g., ETSI).
1025 By default DFS is enabled according to the regulatory definitions
1027 .Pa /etc/regdomain.xml
1028 and the current country code, regdomain,
1030 Note the underlying device (and driver) must support radar detection
1031 for full DFS support to work.
1032 To be fully compliant with the local regulatory agency frequencies that
1033 require DFS should not be used unless it is fully supported.
1036 to disable this functionality for testing.
1038 Enable support for the 802.11d specification (default).
1039 When this support is enabled in station mode, beacon frames that advertise
1040 a country code different than the currently configured country code will
1041 cause an event to be dispatched to user applications.
1042 This event can be used by the station to adopt that country code and
1043 operate according to the associated regulatory constraints.
1044 When operating as an access point with 802.11d enabled the beacon and
1045 probe response frames transmitted will advertise the current regulatory
1047 To disable 802.11d use
1050 Enable 802.11h support including spectrum management.
1051 When 802.11h is enabled beacon and probe response frames will have
1052 the SpectrumMgt bit set in the capabilities field and
1053 country and power constraint information elements will be present.
1054 802.11h support also includes handling Channel Switch Announcements (CSA)
1055 which are a mechanism to coordinate channel changes by an access point.
1056 By default 802.11h is enabled if the device is capable.
1057 To disable 802.11h use
1059 .It Cm deftxkey Ar index
1060 Set the default key to use for transmission.
1061 Typically this is only set when using WEP encryption.
1062 Note that you must set a default transmit key
1063 for the system to know which key to use in encrypting outbound traffic.
1066 is an alias for this request; it is provided for backwards compatibility.
1067 .It Cm dtimperiod Ar period
1070 period for transmitting buffered multicast data frames when
1071 operating in ap mode.
1074 specifies the number of beacon intervals between DTIM
1075 and must be in the range 1 to 15.
1076 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
1078 Enable the use of quiet IE. Hostap will use this to silence other
1079 stations to reduce interference for radar detection when
1080 operating on 5GHz frequency and doth support is enabled.
1083 to disable this functionality.
1084 .It Cm quiet_period Ar period
1087 to the number of beacon intervals between the start of regularly
1088 scheduled quiet intervals defined by Quiet element.
1089 .It Cm quiet_count Ar count
1092 to the number of TBTTs until the beacon interval during which the
1093 next quiet interval shall start. A value of 1 indicates the quiet
1094 interval will start during the beacon interval starting at the next
1095 TBTT. A value 0 is reserved.
1096 .It Cm quiet_offset Ar offset
1099 to the offset of the start of the quiet interval from the TBTT
1100 specified by the Quiet count, expressed in TUs.
1103 shall be less than one beacon interval.
1104 .It Cm quiet_duration Ar dur
1107 to the duration of the Quiet interval, expressed in TUs.
1108 The value should be less than beacon interval.
1110 Enable the use of Atheros Dynamic Turbo mode when communicating with
1111 another Dynamic Turbo-capable station.
1112 Dynamic Turbo mode is an Atheros-specific mechanism by which
1113 stations switch between normal 802.11 operation and a ``boosted''
1114 mode in which a 40MHz wide channel is used for communication.
1115 Stations using Dynamic Turbo mode operate boosted only when the
1116 channel is free of non-dturbo stations; when a non-dturbo station
1117 is identified on the channel all stations will automatically drop
1118 back to normal operation.
1119 By default, Dynamic Turbo mode is not enabled, even if the device is capable.
1120 Note that turbo mode (dynamic or static) is only allowed on some
1121 channels depending on the regulatory constraints; use the
1123 command to identify the channels where turbo mode may be used.
1124 To disable Dynamic Turbo mode use
1127 Enable Dynamic WDS (DWDS) support.
1128 DWDS is a facility by which 4-address traffic can be carried between
1129 stations operating in infrastructure mode.
1130 A station first associates to an access point and authenticates using
1131 normal procedures (e.g., WPA).
1132 Then 4-address frames are passed to carry traffic for stations
1133 operating on either side of the wireless link.
1134 DWDS extends the normal WDS mechanism by leveraging existing security
1135 protocols and eliminating static binding.
1137 When DWDS is enabled on an access point 4-address frames received from
1138 an authorized station will generate a ``DWDS discovery'' event to user
1140 This event should be used to create a WDS interface that is bound
1141 to the remote station (and usually plumbed into a bridge).
1142 Once the WDS interface is up and running 4-address traffic then logically
1143 flows through that interface.
1145 When DWDS is enabled on a station, traffic with a destination address
1146 different from the peer station are encapsulated in a 4-address frame
1147 and transmitted to the peer.
1148 All 4-address traffic uses the security information of the stations
1149 (e.g., cryptographic keys).
1150 A station is associated using 802.11n facilities may transport
1151 4-address traffic using these same mechanisms; this depends on available
1152 resources and capabilities of the device.
1153 The DWDS implementation guards against layer 2 routing loops of
1156 Enable the use of Atheros Fast Frames when communicating with
1157 another Fast Frames-capable station.
1158 Fast Frames are an encapsulation technique by which two 802.3
1159 frames are transmitted in a single 802.11 frame.
1160 This can noticeably improve throughput but requires that the
1161 receiving station understand how to decapsulate the frame.
1162 Fast frame use is negotiated using the Atheros 802.11 vendor-specific
1163 protocol extension so enabling use is safe when communicating with
1164 non-Atheros devices.
1165 By default, use of fast frames is enabled if the device is capable.
1166 To explicitly disable fast frames, use
1168 .It Cm fragthreshold Ar length
1169 Set the threshold for which transmitted frames are broken into fragments.
1172 argument is the frame size in bytes and must be in the range 256 to 2346.
1180 disables transmit fragmentation.
1181 Not all adapters honor the fragmentation threshold.
1183 When operating as an access point, do not broadcast the SSID
1184 in beacon frames or respond to probe request frames unless
1185 they are directed to the ap (i.e., they include the ap's SSID).
1186 By default, the SSID is included in beacon frames and
1187 undirected probe request frames are answered.
1188 To re-enable the broadcast of the SSID etc., use
1191 Enable use of High Throughput (HT) when using 802.11n (default).
1192 The 802.11n specification includes mechanisms for operation
1193 on 20MHz and 40MHz wide channels using different signalling mechanisms
1194 than specified in 802.11b, 802.11g, and 802.11a.
1195 Stations negotiate use of these facilities, termed HT20 and HT40,
1196 when they associate.
1197 To disable all use of 802.11n use
1199 To disable use of HT20 (e.g., to force only HT40 use) use
1201 To disable use of HT40 use
1204 HT configuration is used to ``auto promote'' operation
1205 when several choices are available.
1206 For example, if a station associates to an 11n-capable access point
1207 it controls whether the station uses legacy operation, HT20, or HT40.
1208 When an 11n-capable device is setup as an access point and
1209 Auto Channel Selection is used to locate a channel to operate on,
1210 HT configuration controls whether legacy, HT20, or HT40 operation is setup
1211 on the selected channel.
1212 If a fixed channel is specified for a station then HT configuration can
1213 be given as part of the channel specification; e.g., 6:ht/20 to setup
1214 HT20 operation on channel 6.
1216 Enable use of compatibility support for pre-802.11n devices (default).
1217 The 802.11n protocol specification went through several incompatible iterations.
1218 Some vendors implemented 11n support to older specifications that
1219 will not interoperate with a purely 11n-compliant station.
1220 In particular the information elements included in management frames
1221 for old devices are different.
1222 When compatibility support is enabled both standard and compatible data
1224 Stations that associate using the compatibility mechanisms are flagged
1226 To disable compatibility support use
1228 .It Cm htprotmode Ar technique
1229 For interfaces operating in 802.11n, use the specified
1231 for protecting HT frames in a mixed legacy/HT network.
1232 The set of valid techniques is
1237 Technique names are case insensitive.
1239 Enable inactivity processing for stations associated to an
1240 access point (default).
1241 When operating as an access point the 802.11 layer monitors
1242 the activity of each associated station.
1243 When a station is inactive for 5 minutes it will send several
1244 ``probe frames'' to see if the station is still present.
1245 If no response is received then the station is deauthenticated.
1246 Applications that prefer to handle this work can disable this
1250 Set the location to use in calculating regulatory constraints.
1251 The location is also advertised in beacon and probe response frames
1252 when 802.11d is enabled with
1261 Display the list of channels available for use taking into account
1262 any restrictions set with the
1265 See the description of
1267 for more information.
1269 Display the adaptor's capabilities, including the operating
1272 Display the list of channels available for use.
1273 Channels are shown with their IEEE channel number, equivalent
1274 frequency, and usage modes.
1275 Channels identified as
1280 Channels identified as
1282 may be used only for Atheros' Static Turbo mode
1284 . Cm mediaopt turbo ) .
1285 Channels marked with a
1287 have a regulatory constraint that they be passively scanned.
1288 This means a station is not permitted to transmit on the channel until
1289 it identifies the channel is being used for 802.11 communication;
1290 typically by hearing a beacon frame from an access point operating
1293 is another way of requesting this information.
1294 By default a compacted list of channels is displayed; if the
1296 option is specified then all channels are shown.
1297 .It Cm list countries
1298 Display the set of country codes and regulatory domains that can be
1299 used in regulatory configuration.
1301 Display the current MAC Access Control List state.
1302 Each address is prefixed with a character that indicates the
1303 current policy applied to it:
1305 indicates the address is allowed access,
1307 indicates the address is denied access,
1309 indicates the address is present but the current policy open
1310 (so the ACL is not consulted).
1312 Displays the mesh routing table, used for forwarding packets on a mesh
1314 .It Cm list regdomain
1315 Display the current regulatory settings including the available channels
1316 and transmit power caps.
1318 Display the parameters that govern roaming operation.
1320 Display the parameters that govern transmit operation.
1322 Display the transmit power caps for each channel.
1324 Display the access points and/or ad-hoc neighbors
1325 located in the vicinity.
1326 This information may be updated automatically by the adapter
1329 request or through background scanning.
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.
1357 Indicates that the station is doing short preamble to optionally
1358 improve throughput performance with 802.11g and 802.11b.
1360 Transitional Security Network (TSN).
1361 Indicates that the station associated using TSN; see also
1365 Wi-Fi Protected Setup (WPS).
1366 Indicates that the station associated using WPS.
1369 By default interesting information elements captured from the neighboring
1370 stations are displayed at the end of each row.
1371 Possible elements include:
1373 (station supports WME),
1375 (station supports WPA),
1377 (station supports WPS),
1379 (station supports 802.11i/RSN),
1381 (station supports 802.11n/HT communication),
1383 (station supports Atheros protocol extensions),
1385 (station supports unknown vendor-specific extensions).
1388 flag is used all the information elements and their
1389 contents will be shown.
1392 flag also enables display of long SSIDs.
1395 command is another way of requesting this information.
1397 When operating as an access point display the stations that are
1398 currently associated.
1399 When operating in ad-hoc mode display stations identified as
1400 neighbors in the IBSS.
1401 When operating in mesh mode display stations identified as
1402 neighbors in the MBSS.
1403 When operating in station mode display the access point.
1404 Capabilities advertised by the stations are described under
1408 Depending on the capabilities of the stations the following
1409 flags can be included in the output:
1413 Indicates that the station is permitted to send/receive data frames.
1415 Extended Rate Phy (ERP).
1416 Indicates that the station is operating in an 802.11g network
1417 using extended transmit rates.
1419 High Throughput (HT).
1420 Indicates that the station is using HT transmit rates.
1421 If a `+' follows immediately after then the station associated
1422 using deprecated mechanisms supported only when
1427 Indicates that the station is operating in power save mode.
1429 Quality of Service (QoS).
1430 Indicates that the station is using QoS encapsulation for
1432 QoS encapsulation is enabled only when WME mode is enabled.
1435 Indicates that the station is doing short preamble to optionally
1436 improve throughput performance with 802.11g and 802.11b.
1438 Transitional Security Network (TSN).
1439 Indicates that the station associated using TSN; see also
1443 Wi-Fi Protected Setup (WPS).
1444 Indicates that the station associated using WPS.
1447 By default information elements received from associated stations
1448 are displayed in a short form; the
1450 flag causes this information to be displayed symbolically.
1452 Display the current channel parameters to use when operating in WME mode.
1455 option is specified then both channel and BSS parameters are displayed
1456 for each AC (first channel, then BSS).
1457 When WME mode is enabled for an adaptor this information will be
1458 displayed with the regular status; this command is mostly useful
1459 for examining parameters when WME mode is disabled.
1460 See the description of the
1462 directive for information on the various parameters.
1463 .It Cm maxretry Ar count
1464 Set the maximum number of tries to use in sending unicast frames.
1465 The default setting is 6 but drivers may override this with a value
1467 .It Cm mcastrate Ar rate
1468 Set the rate for transmitting multicast/broadcast frames.
1469 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1470 This rate should be valid for the current operating conditions;
1471 if an invalid rate is specified drivers are free to chose an
1473 .It Cm mgtrate Ar rate
1474 Set the rate for transmitting management and/or control frames.
1475 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1477 Set the location to use in calculating regulatory constraints.
1478 The location is also advertised in beacon and probe response frames
1479 when 802.11d is enabled with
1488 Enable powersave operation.
1489 When operating as a client, the station will conserve power by
1490 periodically turning off the radio and listening for
1491 messages from the access point telling it there are packets waiting.
1492 The station must then retrieve the packets.
1493 Not all devices support power save operation as a client.
1494 The 802.11 specification requires that all access points support
1495 power save but some drivers do not.
1498 to disable powersave operation when operating as a client.
1499 .It Cm powersavesleep Ar sleep
1500 Set the desired max powersave sleep time in TU's (1024 usecs).
1501 By default the max powersave sleep time is 100 TU's.
1502 .It Cm protmode Ar technique
1503 For interfaces operating in 802.11g, use the specified
1505 for protecting OFDM frames in a mixed 11b/11g network.
1506 The set of valid techniques is
1512 Technique names are case insensitive.
1513 Not all devices support
1515 as a protection technique.
1517 When operating as an access point in 802.11g mode allow only
1518 11g-capable stations to associate (11b-only stations are not
1519 permitted to associate).
1520 To allow both 11g and 11b-only stations to associate, use
1523 When operating as an access point in 802.11n mode allow only
1524 HT-capable stations to associate (legacy stations are not
1525 permitted to associate).
1526 To allow both HT and legacy stations to associate, use
1528 .It Cm regdomain Ar sku
1529 Set the regulatory domain to use in calculating the regulatory constraints
1531 In particular the set of available channels, how the wireless device
1532 will operation on the channels, and the maximum transmit power that
1533 can be used on a channel are defined by this setting.
1534 Regdomain codes (SKU's) are taken from
1535 .Pa /etc/regdomain.xml
1537 be viewed with the ``list countries'' request.
1538 Note that not all devices support changing the regdomain from a default
1539 setting; typically stored in EEPROM.
1547 Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n
1549 Note that RIFS must be supported by both the station and access point
1553 .It Cm roam:rate Ar rate
1554 Set the threshold for controlling roaming when operating in a BSS.
1557 parameter specifies the transmit rate in megabits
1558 at which roaming should be considered.
1559 If the current transmit rate drops below this setting and background scanning
1560 is enabled, then the system will check if a more desirable access point is
1561 available and switch over to it.
1562 The current scan cache contents are used if they are considered
1563 valid according to the
1565 parameter; otherwise a background scan operation is triggered before
1566 any selection occurs.
1567 Each channel type has a separate rate threshold; the default values are:
1568 12 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng).
1569 .It Cm roam:rssi Ar rssi
1570 Set the threshold for controlling roaming when operating in a BSS.
1573 parameter specifies the receive signal strength in dBm units
1574 at which roaming should be considered.
1575 If the current rssi drops below this setting and background scanning
1576 is enabled, then the system will check if a more desirable access point is
1577 available and switch over to it.
1578 The current scan cache contents are used if they are considered
1579 valid according to the
1581 parameter; otherwise a background scan operation is triggered before
1582 any selection occurs.
1583 Each channel type has a separate rssi threshold; the default values are
1585 .It Cm roaming Ar mode
1586 When operating as a station, control how the system will
1587 behave when communication with the current access point
1591 argument may be one of
1593 (leave it to the hardware device to decide),
1595 (handle either in the device or the operating system\[em]as appropriate),
1597 (do nothing until explicitly instructed).
1598 By default, the device is left to handle this if it is
1599 capable; otherwise, the operating system will automatically
1600 attempt to reestablish communication.
1601 Manual mode is used by applications such as
1602 .Xr wpa_supplicant 8
1603 that want to control the selection of an access point.
1604 .It Cm rtsthreshold Ar length
1605 Set the threshold for which
1606 transmitted frames are preceded by transmission of an
1612 is the frame size in bytes and must be in the range 1 to 2346.
1620 disables transmission of RTS frames.
1621 Not all adapters support setting the RTS threshold.
1623 Initiate a scan of neighboring stations, wait for it to complete, and
1624 display all stations found.
1625 Only the super-user can initiate a scan.
1628 for information on the display.
1629 By default a background scan is done; otherwise a foreground
1630 scan is done and the station may roam to a different access point.
1633 request can be used to show recent scan results without
1634 initiating a new scan.
1635 .It Cm scanvalid Ar threshold
1636 Set the maximum time the scan cache contents are considered valid;
1637 i.e., will be used without first triggering a scan operation to
1641 parameter is specified in seconds and defaults to 60 seconds.
1642 The minimum setting for
1645 One should take care setting this threshold; if it is set too low
1646 then attempts to roam to another access point may trigger unnecessary
1647 background scan operations.
1649 Enable use of Short Guard Interval when operating in 802.11n
1651 NB: this currently enables Short GI on both HT40 and HT20 channels.
1652 To disable Short GI use
1655 Enable use of Static Spatial Multiplexing Power Save (SMPS)
1656 when operating in 802.11n.
1657 A station operating with Static SMPS maintains only a single
1658 receive chain active (this can significantly reduce power consumption).
1662 Enable use of Dynamic Spatial Multiplexing Power Save (SMPS)
1663 when operating in 802.11n.
1664 A station operating with Dynamic SMPS maintains only a single
1665 receive chain active but switches to multiple receive chains when it
1666 receives an RTS frame (this can significantly reduce power consumption).
1667 Note that stations cannot distinguish between RTS/CTS intended to
1668 enable multiple receive chains and those used for other purposes.
1672 Set the desired Service Set Identifier (aka network name).
1673 The SSID is a string up to 32 characters
1674 in length and may be specified as either a normal string or in
1675 hexadecimal when preceded by
1677 Additionally, the SSID may be cleared by setting it to
1679 .It Cm tdmaslot Ar slot
1680 When operating with TDMA, use the specified
1685 is a number between 0 and the maximum number of slots in the BSS.
1686 Note that a station configured as slot 0 is a master and
1687 will broadcast beacon frames advertising the BSS;
1688 stations configured to use other slots will always
1689 scan to locate a master before they ever transmit.
1693 .It Cm tdmaslotcnt Ar cnt
1694 When operating with TDMA, setup a BSS with
1697 The slot count may be at most 8.
1698 The current implementation is only tested with two stations
1699 (i.e., point to point applications).
1700 This setting is only meaningful when a station is configured as slot 0;
1701 other stations adopt this setting from the BSS they join.
1705 .It Cm tdmaslotlen Ar len
1706 When operating with TDMA, setup a BSS such that each station has a slot
1709 The slot length must be at least 150 microseconds (1/8 TU)
1710 and no more than 65 milliseconds.
1711 Note that setting too small a slot length may result in poor channel
1712 bandwidth utilization due to factors such as timer granularity and
1714 This setting is only meaningful when a station is configured as slot 0;
1715 other stations adopt this setting from the BSS they join.
1718 is set to 10 milliseconds.
1719 .It Cm tdmabintval Ar intval
1720 When operating with TDMA, setup a BSS such that beacons are transmitted every
1722 superframes to synchronize the TDMA slot timing.
1723 A superframe is defined as the number of slots times the slot length; e.g.,
1724 a BSS with two slots of 10 milliseconds has a 20 millisecond superframe.
1725 The beacon interval may not be zero.
1728 causes the timers to be resynchronized more often; this can be help if
1729 significant timer drift is observed.
1734 When operating as an access point with WPA/802.11i allow legacy
1735 stations to associate using static key WEP and open authentication.
1736 To disallow legacy station use of WEP, use
1738 .It Cm txpower Ar power
1739 Set the power used to transmit frames.
1742 argument is specified in .5 dBm units.
1743 Out of range values are truncated.
1744 Typically only a few discreet power settings are available and
1745 the driver will use the setting closest to the specified value.
1746 Not all adapters support changing the transmit power.
1747 .It Cm ucastrate Ar rate
1748 Set a fixed rate for transmitting unicast frames.
1749 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1750 This rate should be valid for the current operating conditions;
1751 if an invalid rate is specified drivers are free to chose an
1753 .It Cm wepmode Ar mode
1754 Set the desired WEP mode.
1755 Not all adapters support all modes.
1756 The set of valid modes is
1762 mode explicitly tells the adaptor to allow association with access
1763 points which allow both encrypted and unencrypted traffic.
1766 means that the access point must only allow encrypted connections.
1769 is generally another name for
1771 Modes are case insensitive.
1772 .It Cm weptxkey Ar index
1773 Set the WEP key to be used for transmission.
1774 This is the same as setting the default transmission key with
1776 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
1777 Set the selected WEP key.
1780 is not given, key 1 is set.
1781 A WEP key will be either 5 or 13
1782 characters (40 or 104 bits) depending on the local network and the
1783 capabilities of the adaptor.
1784 It may be specified either as a plain
1785 string or as a string of hexadecimal digits preceded by
1787 For maximum portability, hex keys are recommended;
1788 the mapping of text keys to WEP encryption is usually driver-specific.
1791 drivers do this mapping differently to
1793 A key may be cleared by setting it to
1795 If WEP is supported then there are at least four keys.
1796 Some adapters support more than four keys.
1797 If that is the case, then the first four keys
1798 (1-4) will be the standard temporary keys and any others will be adaptor
1799 specific keys such as permanent keys stored in NVRAM.
1801 Note that you must set a default transmit key with
1803 for the system to know which key to use in encrypting outbound traffic.
1805 Enable Wireless Multimedia Extensions (WME) support, if available,
1806 for the specified interface.
1807 WME is a subset of the IEEE 802.11e standard to support the
1808 efficient communication of realtime and multimedia data.
1809 To disable WME support, use
1811 Another name for this parameter is
1814 The following parameters are meaningful only when WME support is in use.
1815 Parameters are specified per-AC (Access Category) and
1816 split into those that are used by a station when acting
1817 as an access point and those for client stations in the BSS.
1818 The latter are received from the access point and may not be changed
1820 The following Access Categories are recognized:
1822 .Bl -tag -width ".Cm AC_BK" -compact
1826 best effort delivery,
1841 AC parameters are case-insensitive.
1842 Traffic classification is done in the operating system using the
1843 vlan priority associated with data frames or the
1844 ToS (Type of Service) indication in IP-encapsulated frames.
1845 If neither information is present, traffic is assigned to the
1846 Best Effort (BE) category.
1847 .Bl -tag -width indent
1849 Set the ACK policy for QoS transmissions by the local station;
1850 this controls whether or not data frames transmitted by a station
1851 require an ACK response from the receiving station.
1852 To disable waiting for an ACK use
1854 This parameter is applied only to the local station.
1856 Enable the Admission Control Mandatory (ACM) mechanism
1857 for transmissions by the local station.
1858 To disable the ACM use
1860 On stations in a BSS this parameter is read-only and indicates
1861 the setting received from the access point.
1862 NB: ACM is not supported right now.
1863 .It Cm aifs Ar ac Ar count
1864 Set the Arbitration Inter Frame Spacing (AIFS)
1865 channel access parameter to use for transmissions
1866 by the local station.
1867 On stations in a BSS this parameter is read-only and indicates
1868 the setting received from the access point.
1869 .It Cm cwmin Ar ac Ar count
1870 Set the CWmin channel access parameter to use for transmissions
1871 by the local station.
1872 On stations in a BSS this parameter is read-only and indicates
1873 the setting received from the access point.
1874 .It Cm cwmax Ar ac Ar count
1875 Set the CWmax channel access parameter to use for transmissions
1876 by the local station.
1877 On stations in a BSS this parameter is read-only and indicates
1878 the setting received from the access point.
1879 .It Cm txoplimit Ar ac Ar limit
1880 Set the Transmission Opportunity Limit channel access parameter
1881 to use for transmissions by the local station.
1882 This parameter defines an interval of time when a WME station
1883 has the right to initiate transmissions onto the wireless medium.
1884 On stations in a BSS this parameter is read-only and indicates
1885 the setting received from the access point.
1886 .It Cm bss:aifs Ar ac Ar count
1887 Set the AIFS channel access parameter to send to stations in a BSS.
1888 This parameter is meaningful only when operating in ap mode.
1889 .It Cm bss:cwmin Ar ac Ar count
1890 Set the CWmin channel access parameter to send to stations in a BSS.
1891 This parameter is meaningful only when operating in ap mode.
1892 .It Cm bss:cwmax Ar ac Ar count
1893 Set the CWmax channel access parameter to send to stations in a BSS.
1894 This parameter is meaningful only when operating in ap mode.
1895 .It Cm bss:txoplimit Ar ac Ar limit
1896 Set the TxOpLimit channel access parameter to send to stations in a BSS.
1897 This parameter is meaningful only when operating in ap mode.
1900 Enable Wireless Privacy Subscriber support.
1901 Note that WPS support requires a WPS-capable supplicant.
1902 To disable this function use
1906 The following parameters support an optional access control list
1907 feature available with some adapters when operating in ap mode; see
1909 This facility allows an access point to accept/deny association
1910 requests based on the MAC address of the station.
1911 Note that this feature does not significantly enhance security
1912 as MAC address spoofing is easy to do.
1913 .Bl -tag -width indent
1914 .It Cm mac:add Ar address
1915 Add the specified MAC address to the database.
1916 Depending on the policy setting association requests from the
1917 specified station will be allowed or denied.
1919 Set the ACL policy to permit association only by
1920 stations registered in the database.
1921 .It Cm mac:del Ar address
1922 Delete the specified MAC address from the database.
1924 Set the ACL policy to deny association only by
1925 stations registered in the database.
1926 .It Cm mac:kick Ar address
1927 Force the specified station to be deauthenticated.
1928 This typically is done to block a station after updating the
1931 Set the ACL policy to allow all stations to associate.
1933 Delete all entries in the database.
1935 Set the ACL policy to permit association only by
1936 stations approved by a RADIUS server.
1937 Note that this feature requires the
1939 program be configured to do the right thing
1940 as it handles the RADIUS processing
1941 (and marks stations as authorized).
1944 The following parameters are related to a wireless interface operating in mesh
1946 .Bl -tag -width indent
1947 .It Cm meshid Ar meshid
1948 Set the desired Mesh Identifier.
1949 The Mesh ID is a string up to 32 characters in length.
1950 A mesh interface must have a Mesh Identifier specified
1951 to reach an operational state.
1952 .It Cm meshttl Ar ttl
1953 Set the desired ``time to live'' for mesh forwarded packets;
1954 this is the number of hops a packet may be forwarded before
1956 The default setting for
1960 Enable or disable peering with neighbor mesh stations.
1961 Stations must peer before any data packets can be exchanged.
1966 Enable or disable forwarding packets by a mesh interface.
1971 This attribute specifies whether or not the mesh STA activates mesh gate
1976 .It Cm meshmetric Ar protocol
1979 as the link metric protocol used on a mesh network.
1980 The default protocol is called
1982 The mesh interface will restart after changing this setting.
1983 .It Cm meshpath Ar protocol
1986 as the path selection protocol used on a mesh network.
1987 The only available protocol at the moment is called
1989 (Hybrid Wireless Mesh Protocol).
1990 The mesh interface will restart after changing this setting.
1991 .It Cm hwmprootmode Ar mode
1992 Stations on a mesh network can operate as ``root nodes.''
1993 Root nodes try to find paths to all mesh nodes and advertise themselves
1995 When there is a root mesh node on a network, other mesh nodes can setup
1996 paths between themselves faster because they can use the root node
1997 to find the destination.
1998 This path may not be the best, but on-demand
1999 routing will eventually find the best path.
2000 The following modes are recognized:
2002 .Bl -tag -width ".Cm PROACTIVE" -compact
2006 Send broadcast path requests every two seconds.
2007 Nodes on the mesh without a path to this root mesh station with try to
2008 discover a path to us.
2010 Send broadcast path requests every two seconds and every node must reply
2011 with a path reply even if it already has a path to this root mesh station.
2013 Send broadcast root announcement (RANN) frames.
2014 Nodes on the mesh without a path to this root mesh station with try to
2015 discover a path to us.
2021 .It Cm hwmpmaxhops Ar cnt
2022 Set the maximum number of hops allowed in an HMWP path to
2024 The default setting for
2029 The following parameters are for compatibility with other systems:
2030 .Bl -tag -width indent
2032 Another name for the
2038 .It Cm stationname Ar name
2039 Set the name of this station.
2040 The station name is not part of the IEEE 802.11
2041 protocol though some interfaces support it.
2043 seems to be meaningful to identical or virtually identical equipment.
2044 Setting the station name is identical in syntax to setting the SSID.
2051 Another way of saying
2057 Another way of saying
2063 Another way of saying:
2064 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
2070 .Ar n : k1 , k2 , k3 , k4
2073 Another way of saying
2074 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
2079 Another way of saying
2086 The following parameters are specific to bridge interfaces:
2087 .Bl -tag -width indent
2088 .It Cm addm Ar interface
2089 Add the interface named by
2091 as a member of the bridge.
2092 The interface is put into promiscuous mode
2093 so that it can receive every packet sent on the network.
2094 .It Cm deletem Ar interface
2095 Remove the interface named by
2098 Promiscuous mode is disabled on the interface when
2099 it is removed from the bridge.
2100 .It Cm maxaddr Ar size
2101 Set the size of the bridge address cache to
2103 The default is 2000 entries.
2104 .It Cm timeout Ar seconds
2105 Set the timeout of address cache entries to
2110 is zero, then address cache entries will not be expired.
2111 The default is 1200 seconds.
2113 Display the addresses that have been learned by the bridge.
2114 .It Cm static Ar interface-name Ar address
2115 Add a static entry into the address cache pointing to
2116 .Ar interface-name .
2117 Static entries are never aged out of the cache or re-placed, even if the
2118 address is seen on a different interface.
2119 .It Cm deladdr Ar address
2122 from the address cache.
2124 Delete all dynamically-learned addresses from the address cache.
2126 Delete all addresses, including static addresses, from the address cache.
2127 .It Cm discover Ar interface
2128 Mark an interface as a
2131 When the bridge has no address cache entry
2132 (either dynamic or static)
2133 for the destination address of a packet,
2134 the bridge will forward the packet to all
2135 member interfaces marked as
2137 This is the default for all interfaces added to a bridge.
2138 .It Cm -discover Ar interface
2141 attribute on a member interface.
2142 For packets without the
2144 attribute, the only packets forwarded on the interface are broadcast
2145 or multicast packets and packets for which the destination address
2146 is known to be on the interface's segment.
2147 .It Cm learn Ar interface
2148 Mark an interface as a
2151 When a packet arrives on such an interface, the source
2152 address of the packet is entered into the address cache as being a
2153 destination address on the interface's segment.
2154 This is the default for all interfaces added to a bridge.
2155 .It Cm -learn Ar interface
2158 attribute on a member interface.
2159 .It Cm sticky Ar interface
2160 Mark an interface as a
2163 Dynamically learned address entries are treated at static once entered into
2165 Sticky entries are never aged out of the cache or replaced, even if the
2166 address is seen on a different interface.
2167 .It Cm -sticky Ar interface
2170 attribute on a member interface.
2171 .It Cm private Ar interface
2172 Mark an interface as a
2175 A private interface does not forward any traffic to any other port that is also
2176 a private interface.
2177 .It Cm -private Ar interface
2180 attribute on a member interface.
2181 .It Cm span Ar interface
2182 Add the interface named by
2184 as a span port on the bridge.
2185 Span ports transmit a copy of every frame received by the bridge.
2186 This is most useful for snooping a bridged network passively on
2187 another host connected to one of the span ports of the bridge.
2188 .It Cm -span Ar interface
2189 Delete the interface named by
2191 from the list of span ports of the bridge.
2192 .It Cm stp Ar interface
2193 Enable Spanning Tree protocol on
2197 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
2198 Spanning Tree is used to detect and remove loops in a network topology.
2199 .It Cm -stp Ar interface
2200 Disable Spanning Tree protocol on
2202 This is the default for all interfaces added to a bridge.
2203 .It Cm edge Ar interface
2207 An edge port connects directly to end stations cannot create bridging
2208 loops in the network, this allows it to transition straight to forwarding.
2209 .It Cm -edge Ar interface
2210 Disable edge status on
2212 .It Cm autoedge Ar interface
2215 to automatically detect edge status.
2216 This is the default for all interfaces added to a bridge.
2217 .It Cm -autoedge Ar interface
2218 Disable automatic edge status on
2220 .It Cm ptp Ar interface
2223 as a point to point link.
2224 This is required for straight transitions to forwarding and
2225 should be enabled on a direct link to another RSTP capable switch.
2226 .It Cm -ptp Ar interface
2227 Disable point to point link status on
2229 This should be disabled for a half duplex link and for an interface
2230 connected to a shared network segment,
2231 like a hub or a wireless network.
2232 .It Cm autoptp Ar interface
2233 Automatically detect the point to point status on
2235 by checking the full duplex link status.
2236 This is the default for interfaces added to the bridge.
2237 .It Cm -autoptp Ar interface
2238 Disable automatic point to point link detection on
2240 .It Cm maxage Ar seconds
2241 Set the time that a Spanning Tree protocol configuration is valid.
2242 The default is 20 seconds.
2243 The minimum is 6 seconds and the maximum is 40 seconds.
2244 .It Cm fwddelay Ar seconds
2245 Set the time that must pass before an interface begins forwarding
2246 packets when Spanning Tree is enabled.
2247 The default is 15 seconds.
2248 The minimum is 4 seconds and the maximum is 30 seconds.
2249 .It Cm hellotime Ar seconds
2250 Set the time between broadcasting of Spanning Tree protocol
2251 configuration messages.
2252 The hello time may only be changed when operating in legacy stp mode.
2253 The default is 2 seconds.
2254 The minimum is 1 second and the maximum is 2 seconds.
2255 .It Cm priority Ar value
2256 Set the bridge priority for Spanning Tree.
2257 The default is 32768.
2258 The minimum is 0 and the maximum is 61440.
2259 .It Cm proto Ar value
2260 Set the Spanning Tree protocol.
2261 The default is rstp.
2262 The available options are stp and rstp.
2263 .It Cm holdcnt Ar value
2264 Set the transmit hold count for Spanning Tree.
2265 This is the number of packets transmitted before being rate limited.
2267 The minimum is 1 and the maximum is 10.
2268 .It Cm ifpriority Ar interface Ar value
2269 Set the Spanning Tree priority of
2274 The minimum is 0 and the maximum is 240.
2275 .It Cm ifpathcost Ar interface Ar value
2276 Set the Spanning Tree path cost of
2280 The default is calculated from the link speed.
2281 To change a previously selected path cost back to automatic, set the
2283 The minimum is 1 and the maximum is 200000000.
2284 .It Cm ifmaxaddr Ar interface Ar size
2285 Set the maximum number of hosts allowed from an interface, packets with unknown
2286 source addresses are dropped until an existing host cache entry expires or is
2288 Set to 0 to disable.
2291 The following parameters are specific to lagg interfaces:
2292 .Bl -tag -width indent
2293 .It Cm laggport Ar interface
2294 Add the interface named by
2296 as a port of the aggregation interface.
2297 .It Cm -laggport Ar interface
2298 Remove the interface named by
2300 from the aggregation interface.
2301 .It Cm laggproto Ar proto
2302 Set the aggregation protocol.
2303 The default is failover.
2304 The available options are failover, fec, lacp, loadbalance, roundrobin and
2306 .It Cm lagghash Ar option Ns Oo , Ns Ar option Oc
2307 Set the packet layers to hash for aggregation protocols which load balance.
2310 The options can be combined using commas.
2312 .Bl -tag -width ".Cm l2" -compact
2314 src/dst mac address and optional vlan number.
2316 src/dst address for IPv4 or IPv6.
2318 src/dst port for TCP/UDP/SCTP.
2323 The following parameters are specific to IP tunnel interfaces,
2325 .Bl -tag -width indent
2326 .It Cm tunnel Ar src_addr dest_addr
2327 Configure the physical source and destination address for IP tunnel
2333 are interpreted as the outer source/destination for the encapsulating
2336 Unconfigure the physical source and destination address for IP tunnel
2337 interfaces previously configured with
2340 Another name for the
2343 .It Cm accept_rev_ethip_ver
2344 Set a flag to accept both correct EtherIP packets and ones
2345 with reversed version field. Enabled by default.
2346 This is for backward compatibility with
2348 6.2, 6.3, 7.0, and 7.1.
2349 .It Cm -accept_rev_ethip_ver
2351 .Cm accept_rev_ethip_ver .
2352 .It Cm send_rev_ethip_ver
2353 Set a flag to send EtherIP packets with reversed version
2354 field intentionally. Disabled by default.
2355 This is for backward compatibility with
2357 6.2, 6.3, 7.0, and 7.1.
2358 .It Cm -send_rev_ethip_ver
2360 .Cm send_rev_ethip_ver .
2363 The following parameters are specific to GRE tunnel interfaces,
2365 .Bl -tag -width indent
2366 .It Cm grekey Ar key
2367 Configure the GRE key to be used for outgoing packets.
2369 .Xr gre 4 will always accept GRE packets with invalid or absent keys.
2370 This command will result in a four byte MTU reduction on the interface.
2373 The following parameters are specific to
2376 .Bl -tag -width indent
2377 .It Cm syncdev Ar iface
2378 Use the specified interface
2379 to send and receive pfsync state synchronisation messages.
2381 Stop sending pfsync state synchronisation messages over the network.
2382 .It Cm syncpeer Ar peer_address
2383 Make the pfsync link point-to-point rather than using
2384 multicast to broadcast the state synchronisation messages.
2385 The peer_address is the IP address of the other host taking part in
2388 Broadcast the packets using multicast.
2390 Set the maximum number of updates for a single state which
2391 can be collapsed into one.
2392 This is an 8-bit number; the default value is 128.
2394 Defer transmission of the first packet in a state until a peer has
2395 acknowledged that the associated state has been inserted.
2397 Do not defer the first packet in a state.
2398 This is the default.
2401 The following parameters are specific to
2404 .Bl -tag -width indent
2405 .It Cm vlan Ar vlan_tag
2406 Set the VLAN tag value to
2408 This value is a 12-bit VLAN Identifier (VID) which is used to create an 802.1Q
2409 VLAN header for packets sent from the
2416 must both be set at the same time.
2417 .It Cm vlandev Ar iface
2418 Associate the physical interface
2423 Packets transmitted through the
2426 diverted to the specified physical interface
2428 with 802.1Q VLAN encapsulation.
2429 Packets with 802.1Q encapsulation received
2430 by the parent interface with the correct VLAN Identifier will be diverted to
2436 interface is assigned a
2437 copy of the parent interface's flags and the parent's ethernet address.
2442 must both be set at the same time.
2445 interface already has
2446 a physical interface associated with it, this command will fail.
2448 change the association to another physical interface, the existing
2449 association must be cleared first.
2451 Note: if the hardware tagging capability
2452 is set on the parent interface, the
2455 interface's behavior changes:
2458 interface recognizes that the
2459 parent interface supports insertion and extraction of VLAN tags on its
2460 own (usually in firmware) and that it should pass packets to and from
2461 the parent unaltered.
2462 .It Fl vlandev Op Ar iface
2465 pseudo device, disassociate the parent interface from it.
2466 This breaks the link between the
2468 interface and its parent,
2469 clears its VLAN Identifier, flags and its link address and shuts the interface
2473 argument is useless and hence deprecated.
2476 The following parameters are used to configure
2478 protocol on an interface:
2479 .Bl -tag -width indent
2481 Set the virtual host ID.
2482 This is a required setting to initiate
2484 If the virtual host ID does not exist yet, it is created and attached to the
2485 interface, otherwise configuration of an existing vhid is adjusted.
2488 keyword is supplied along with an
2492 address, then this address is configured to be run under control of the
2494 Whenever a last address that refers to a particular vhid is removed from an
2495 interface, the vhid is automatically removed from interface and destroyed.
2496 Any other configuration parameters for the
2498 protocol should be supplied along with the
2501 Acceptable values for vhid are 1 to 255.
2502 .It Cm advbase Ar seconds
2503 Specifies the base of the advertisement interval in seconds.
2504 The acceptable values are 1 to 255.
2505 The default value is 1.
2506 .It Cm advskew Ar interval
2507 Specifies the skew to add to the base advertisement interval to
2508 make one host advertise slower than another host.
2509 It is specified in 1/256 of seconds.
2510 The acceptable values are 1 to 254.
2511 The default value is 0.
2512 .It Cm pass Ar phrase
2513 Set the authentication key to
2515 .It Cm state Ar MASTER|BACKUP
2516 Forcibly change state of a given vhid.
2521 utility displays the current configuration for a network interface
2522 when no optional parameters are supplied.
2523 If a protocol family is specified,
2525 will report only the details specific to that protocol family.
2529 flag is passed before an interface name,
2531 will display the capability list and all
2532 of the supported media for the specified interface.
2535 flag is supplied, address lifetime is displayed for IPv6 addresses,
2536 as time offset string.
2540 flag may be used instead of an interface name.
2543 to display information about all interfaces in the system.
2546 flag limits this to interfaces that are down, and
2548 limits this to interfaces that are up.
2549 When no arguments are given,
2555 flag may be used to list all available interfaces on the system, with
2556 no other additional information.
2557 Use of this flag is mutually exclusive
2558 with all other flags and commands, except for
2560 (only list interfaces that are down)
2563 (only list interfaces that are up).
2567 flag may be used to get more verbose status for an interface.
2571 flag may be used to list all of the interface cloners available on
2572 the system, with no additional information.
2573 Use of this flag is mutually exclusive with all other flags and commands.
2577 flag causes keying information for the interface, if available, to be
2579 For example, the values of 802.11 WEP keys and
2581 passphrases will be printed, if accessible to the current user.
2582 This information is not printed by default, as it may be considered
2585 If the network interface driver is not present in the kernel then
2587 will attempt to load it.
2590 flag disables this behavior.
2592 Only the super-user may modify the configuration of a network interface.
2594 Assign the IPv4 address
2596 with a network mask of
2600 .Dl # ifconfig fxp0 inet 192.0.2.10 netmask 255.255.255.0
2602 Add the IPv4 address
2604 with the CIDR network prefix
2610 as a synonym for the canonical form of the option
2612 .Dl # ifconfig ed0 inet 192.0.2.45/28 add
2614 Remove the IPv4 address
2618 .Dl # ifconfig ed0 inet 192.0.2.45 -alias
2620 Enable IPv6 functionality of the interface:
2621 .Dl # ifconfig em0 inet6 -ifdisabled
2623 Add the IPv6 address
2624 .Li 2001:DB8:DBDB::123/48
2627 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias
2628 Note that lower case hexadecimal IPv6 addresses are acceptable.
2630 Remove the IPv6 address added in the above example,
2633 character as shorthand for the network prefix,
2636 as a synonym for the canonical form of the option
2638 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 delete
2640 Configure a single CARP redundant address on igb0, and then switch it
2642 .Dl # ifconfig igb0 vhid 1 10.0.0.1/24 pass foobar up
2643 .Dl # ifconfig igb0 vhid 1 state master
2645 Configure the interface
2647 to use 100baseTX, full duplex Ethernet media options:
2648 .Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex
2650 Label the em0 interface as an uplink:
2651 .Dl # ifconfig em0 description \&"Uplink to Gigabit Switch 2\&"
2653 Create the software network interface
2655 .Dl # ifconfig gif1 create
2657 Destroy the software network interface
2659 .Dl # ifconfig gif1 destroy
2661 Display available wireless networks using
2663 .Dl # ifconfig wlan0 list scan
2665 Messages indicating the specified interface does not exist, the
2666 requested address is unknown, or the user is not privileged and
2667 tried to alter an interface's configuration.
2689 Basic IPv6 node operation requires a link-local address on each
2690 interface configured for IPv6.
2691 Normally, such an address is automatically configured by the
2692 kernel on each interface added to the system or enabled; this behavior may
2693 be disabled by setting per-interface flag
2694 .Cm -auto_linklocal .
2695 The default value of this flag is 1 and can be disabled by using the sysctl
2697 .Va net.inet6.ip6.auto_linklocal .
2699 Do not configure IPv6 addresses with no link-local address by using
2701 It can result in unexpected behaviors of the kernel.
projects / FreeBSD / FreeBSD.git / blob