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.
144 This can be used to, for example,
145 set a new MAC address on an Ethernet interface, though the
146 mechanism used is not Ethernet specific.
147 If the interface is already
148 up when this option is used, it will be briefly brought down and
149 then brought back up again in order to ensure that the receive
150 filter in the underlying Ethernet hardware is properly reprogrammed.
151 .It Ar address_family
154 which affects interpretation of the remaining parameters.
155 Since an interface can receive transmissions in differing protocols
156 with different naming schemes, specifying the address family is recommended.
157 The address or protocol families currently
168 The default if available is
181 address family has special meaning and is no longer synonymous with
187 will list only Ethernet interfaces, excluding all other interface types,
188 including the loopback interface.
190 Specify the address of the correspondent on the other end
191 of a point to point link.
194 parameter is a string of the form
199 List the interfaces in the given group.
202 The following parameters may be set with
204 .Bl -tag -width indent
209 Introduced for compatibility
213 Establish an additional network address for this interface.
214 This is sometimes useful when changing network numbers, and
215 one wishes to accept packets addressed to the old interface.
216 If the address is on the same subnet as the first network address
217 for this interface, a non-conflicting netmask must be given.
222 Remove the network address specified.
223 This would be used if you incorrectly specified an alias, or it
224 was no longer needed.
225 If you have incorrectly set an NS address having the side effect
226 of specifying the host portion, removing all NS addresses will
227 allow you to respecify the host portion.
230 Specify that the address configured is an anycast address.
231 Based on the current specification,
232 only routers may configure anycast addresses.
233 Anycast address will not be used as source address of any of outgoing
236 Enable the use of the Address Resolution Protocol
239 between network level addresses and link level addresses (default).
240 This is currently implemented for mapping between
245 802 48-bit MAC addresses (Ethernet, FDDI, and Token Ring addresses).
247 Disable the use of the Address Resolution Protocol
250 If the Address Resolution Protocol is enabled,
251 the host will only reply to requests for its addresses,
252 and will never send any requests.
254 If the Address Resolution Protocol is enabled,
255 the host will perform normally,
256 sending out requests and listening for replies.
259 Specify the address to use to represent broadcasts to the
261 The default broadcast address is the address with a host part of all 1's.
263 Enable driver dependent debugging code; usually, this turns on
264 extra console error logging.
266 Disable driver dependent debugging code.
268 Put interface into permanently promiscuous mode.
270 Disable permanently promiscuous mode.
275 .It Cm description Ar value , Cm descr Ar value
276 Specify a description of the interface.
277 This can be used to label interfaces in situations where they may
278 otherwise be difficult to distinguish.
279 .It Cm -description , Cm -descr
280 Clear the interface description.
284 When an interface is marked
286 the system will not attempt to
287 transmit messages through that interface.
288 If possible, the interface will be reset to disable reception as well.
289 This action does not automatically disable routes using the interface.
290 .It Cm group Ar group-name
291 Assign the interface to a
293 Any interface can be in multiple groups.
295 Cloned interfaces are members of their interface family group by default.
296 For example, a PPP interface such as
298 is a member of the PPP interface family group,
300 .\" The interface(s) the default route(s) point to are members of the
303 .It Cm -group Ar group-name
304 Remove the interface from the given
309 (lowermost 64bit of an IPv6 address)
311 .It Cm fib Ar fib_number
312 Specify interface FIB.
315 is assigned to all frames or packets received on that interface.
316 The FIB is not inherited, e.g., vlans or other sub-interfaces will use
317 the default FIB (0) irrespective of the parent interface's FIB.
318 The kernel needs to be tuned to support more than the default FIB
321 kernel configuration option, or the
324 .It Cm tunnelfib Ar fib_number
328 is assigned to all packets encapsulated by tunnel interface, e.g.,
333 This is used to specify an Internet host who is willing to receive
334 IP packets encapsulating IPX packets bound for a remote network.
335 An apparent point to point link is constructed, and
336 the address specified will be taken as the IPX address and network
338 .It Cm maclabel Ar label
339 If Mandatory Access Control support is enabled in the kernel,
343 .\" .Xr maclabel 7 ) .
345 If the driver supports the media selection system, set the media type
348 Some interfaces support the mutually exclusive use of one of several
349 different physical media connectors.
350 For example, a 10Mbit/s Ethernet
351 interface might support the use of either
353 or twisted pair connectors.
354 Setting the media type to
356 would change the currently active connector to the AUI port.
359 would activate twisted pair.
360 Refer to the interfaces' driver
361 specific documentation or man page for a complete list of the
363 .It Cm mediaopt Ar opts
364 If the driver supports the media selection system, set the specified
365 media options on the interface.
369 is a comma delimited list of options to apply to the interface.
370 Refer to the interfaces' driver specific man page for a complete
371 list of available options.
372 .It Fl mediaopt Ar opts
373 If the driver supports the media selection system, disable the
374 specified media options on the interface.
376 If the driver supports the media selection system, set the specified
377 operating mode on the interface to
379 For IEEE 802.11 wireless interfaces that support multiple operating modes
380 this directive is used to select between 802.11a
387 .It Cm inst Ar minst , Cm instance Ar minst
388 Set the media instance to
390 This is useful for devices which have multiple physical layer interfaces
393 Set the interface name to
395 .It Cm rxcsum , txcsum , rxcsum6 , txcsum6
396 If the driver supports user-configurable checksum offloading,
397 enable receive (or transmit) checksum offloading on the interface.
398 The feature can be turned on selectively per protocol family.
400 .Cm rxcsum6 , txcsum6
406 Some drivers may not be able to enable these flags independently
407 of each other, so setting one may also set the other.
408 The driver will offload as much checksum work as it can reliably
409 support, the exact level of offloading varies between drivers.
410 .It Fl rxcsum , txcsum , rxcsum6 , txcsum6
411 If the driver supports user-configurable checksum offloading,
412 disable receive (or transmit) checksum offloading on the interface.
413 The feature can be turned off selectively per protocol family.
415 .Fl rxcsum6 , txcsum6
421 These settings may not always be independent of each other.
423 If the driver supports
425 segmentation offloading, enable TSO on the interface.
426 Some drivers may not be able to support TSO for
430 packets, so they may enable only one of them.
432 If the driver supports
434 segmentation offloading, disable TSO on the interface.
435 It will always disable TSO for
440 If the driver supports
442 segmentation offloading for
446 use one of these to selectively enabled it only for one protocol family.
448 If the driver supports
450 segmentation offloading for
454 use one of these to selectively disable it only for one protocol family.
456 If the driver supports
458 large receive offloading, enable LRO on the interface.
460 If the driver supports
462 large receive offloading, disable LRO on the interface.
463 .It Cm wol , wol_ucast , wol_mcast , wol_magic
464 Enable Wake On Lan (WOL) support, if available.
465 WOL is a facility whereby a machine in a low power state may be woken
466 in response to a received packet.
467 There are three types of packets that may wake a system:
468 ucast (directed solely to the machine's mac address),
469 mcast (directed to a broadcast or multicast address),
471 magic (unicast or multicast frames with a ``magic contents'').
472 Not all devices support WOL, those that do indicate the mechanisms
473 they support in their capabilities.
475 is a synonym for enabling all available WOL mechanisms.
478 .It Cm vlanmtu , vlanhwtag, vlanhwfilter, vlanhwcsum, vlanhwtso
479 If the driver offers user-configurable VLAN support, enable
480 reception of extended frames, tag processing in hardware,
481 frame filtering in hardware, checksum offloading, or TSO on VLAN,
483 Note that this must be issued on a physical interface associated with
488 .It Fl vlanmtu , vlanhwtag, vlanhwfilter, vlanhwtso
489 If the driver offers user-configurable VLAN support, disable
490 reception of extended frames, tag processing in hardware,
491 frame filtering in hardware, or TSO on VLAN,
494 Move the interface to the
496 specified by name or JID.
497 If the jail has a virtual network stack, the interface will disappear
498 from the current environment and become visible to the jail.
500 Reclaim the interface from the
502 specified by name or JID.
503 If the jail has a virtual network stack, the interface will disappear
504 from the jail, and become visible to the current network environment.
508 feature and disable interrupts on the interface, if driver supports
513 feature and enable interrupt mode on the interface.
515 Create the specified network pseudo-device.
516 If the interface is given without a unit number, try to create a new
517 device with an arbitrary unit number.
518 If creation of an arbitrary device is successful, the new device name is
519 printed to standard output unless the interface is renamed or destroyed
524 Destroy the specified network pseudo-device.
540 Set the routing metric of the interface to
543 The routing metric is used by the routing protocol
545 Higher metrics have the effect of making a route
546 less favorable; metrics are counted as additional hops
547 to the destination network or host.
549 Set the maximum transmission unit of the interface to
551 default is interface specific.
552 The MTU is used to limit the size of packets that are transmitted on an
554 Not all interfaces support setting the MTU, and some interfaces have
556 .It Cm netmask Ar mask
559 Specify how much of the address to reserve for subdividing
560 networks into sub-networks.
561 The mask includes the network part of the local address
562 and the subnet part, which is taken from the host field of the address.
563 The mask can be specified as a single hexadecimal number
566 with a dot-notation Internet address,
567 or with a pseudo-network name listed in the network table
569 The mask contains 1's for the bit positions in the 32-bit address
570 which are to be used for the network and subnet parts,
571 and 0's for the host part.
572 The mask should contain at least the standard network portion,
573 and the subnet field should be contiguous with the network
576 The netmask can also be specified in CIDR notation after the address.
579 option above for more information.
580 .It Cm prefixlen Ar len
584 bits are reserved for subdividing networks into sub-networks.
587 must be integer, and for syntactical reason it must be between 0 to 128.
588 It is almost always 64 under the current IPv6 assignment rule.
589 If the parameter is omitted, 64 is used.
591 The prefix can also be specified using the slash notation after the address.
594 option above for more information.
597 .\" .It Cm nsellength Ar n
600 .\" This specifies a trailing number of bytes for a received
602 .\" used for local identification, the remaining leading part of which is
605 .\" (Network Entity Title).
606 .\" The default value is 1, which is conformant to US
608 .\" When an ISO address is set in an ifconfig command,
611 .\" which is being specified.
614 .\" 20 hex digits should be
617 .\" to be assigned to the interface.
618 .\" There is some evidence that a number different from 1 may be useful
621 .\" 37 type addresses.
622 .It Cm range Ar netrange
623 Under appletalk, set the interface to respond to a
626 .Ar startnet Ns - Ns Ar endnet .
627 Appletalk uses this scheme instead of
630 implements it internally as a set of netmasks.
635 Introduced for compatibility
639 The argument following this specifies the version (phase) of the
640 Appletalk network attached to the interface.
641 Values of 1 or 2 are permitted.
643 .It Cm link Op Cm 0 No - Cm 2
645 Enable special processing of the link level of the interface.
646 These three options are interface specific in actual effect, however,
647 they are in general used to select special modes of operation.
649 of this is to enable SLIP compression, or to select the connector type
650 for some Ethernet cards.
651 Refer to the man page for the specific driver
652 for more information.
654 .It Fl link Op Cm 0 No - Cm 2
656 Disable special processing at the link level with the specified interface.
658 Put the interface in monitor mode.
659 No packets are transmitted, and received packets are discarded after
663 Take the interface out of monitor mode.
667 This may be used to enable an interface after an
669 It happens automatically when setting the first address on an interface.
670 If the interface was reset when previously marked down,
671 the hardware will be re-initialized.
674 The following parameters are for ICMPv6 Neighbor Discovery Protocol.
675 Note that the address family keyword
678 .Bl -tag -width indent
680 Set a flag to enable accepting ICMPv6 Router Advertisement messages.
684 .Va net.inet6.ip6.accept_rtadv
685 controls whether this flag is set by default or not.
690 Set a flag to control whether routers from which the system accepts
691 Router Advertisement messages will be added to the Default Router List
695 flag is disabled, this flag has no effect.
699 .Va net.inet6.ip6.no_radr
700 controls whether this flag is set by default or not.
704 .It Cm auto_linklocal
705 Set a flag to perform automatic link-local address configuration when
706 the interface becomes available.
710 .Va net.inet6.ip6.auto_linklocal
711 controls whether this flag is set by default or not.
712 .It Cm -auto_linklocal
716 Set the specified interface as the default route when there is no
722 Set a flag to disable all of IPv6 network communications on the
724 Note that if there are already configured IPv6
725 addresses on that interface, all of them are marked as
727 and DAD will be performed when this flag is cleared.
731 When this flag is cleared and
733 flag is enabled, automatic configuration of a link-local address is
736 Set a flag to enable Neighbor Unreachability Detection.
740 .It Cm no_prefer_iface
741 Set a flag to not prefer address on the interface as candidates of the
742 source address for outgoing packets, even when the interface is
744 .It Cm -no_prefer_iface
746 .Cm no_prefer_iface .
748 Set a flag to disable Duplicate Address Detection.
753 Set a flag to disable loopback detection in Enhanced Duplicate Address
755 When this flag is set,
756 Duplicate Address Detection will stop in a finite number of probings
757 even if a loopback configuration is detected.
763 The following parameters are specific for IPv6 addresses.
764 Note that the address family keyword
767 .Bl -tag -width indent
769 Set a flag to prefer address as a candidate of the source address for
771 .It Cm -prefer_source
776 The following parameters are specific to cloning
777 IEEE 802.11 wireless interfaces with the
780 .Bl -tag -width indent
781 .It Cm wlandev Ar device
784 as the parent for the cloned device.
785 .It Cm wlanmode Ar mode
786 Specify the operating mode for this cloned device.
804 The operating mode of a cloned interface cannot be changed.
807 mode is actually implemented as an
809 interface with special properties.
810 .It Cm wlanbssid Ar bssid
811 The 802.11 mac address to use for the bssid.
812 This must be specified at create time for a legacy
815 .It Cm wlanaddr Ar address
816 The local mac address.
817 If this is not specified then a mac address will automatically be assigned
818 to the cloned device.
819 Typically this address is the same as the address of the parent device
822 parameter is specified then the driver will craft a unique address for
823 the device (if supported).
827 device as operating in ``legacy mode''.
830 devices have a fixed peer relationship and do not, for example, roam
831 if their peer stops communicating.
832 For completeness a Dynamic WDS (DWDS) interface may marked as
835 Request a unique local mac address for the cloned device.
836 This is only possible if the device supports multiple mac addresses.
837 To force use of the parent's mac address use
840 Mark the cloned interface as depending on hardware support to
841 track received beacons.
842 To have beacons tracked in software use
848 can also be used to indicate no beacons should
849 be transmitted; this can be useful when creating a WDS configuration but
851 interfaces can only be created as companions to an access point.
854 The following parameters are specific to IEEE 802.11 wireless interfaces
858 .Bl -tag -width indent
860 Enable sending and receiving AMPDU frames when using 802.11n (default).
861 The 802.11n specification states a compliant station must be capable
862 of receiving AMPDU frames but transmission is optional.
865 to disable all use of AMPDU with 802.11n.
866 For testing and/or to work around interoperability problems one can use
870 to control use of AMPDU in one direction.
871 .It Cm ampdudensity Ar density
872 Set the AMPDU density parameter used when operating with 802.11n.
873 This parameter controls the inter-packet gap for AMPDU frames.
874 The sending device normally controls this setting but a receiving station
875 may request wider gaps.
878 are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds).
881 is treated the same as 0.
882 .It Cm ampdulimit Ar limit
883 Set the limit on packet size for receiving AMPDU frames when operating
887 are 8192, 16384, 32768, and 65536 but one can also specify
888 just the unique prefix: 8, 16, 32, 64.
889 Note the sender may limit the size of AMPDU frames to be less
890 than the maximum specified by the receiving station.
892 Enable sending and receiving AMSDU frames when using 802.11n.
893 By default AMSDU is received but not transmitted.
896 to disable all use of AMSDU with 802.11n.
897 For testing and/or to work around interoperability problems one can use
901 to control use of AMSDU in one direction.
902 .It Cm amsdulimit Ar limit
903 Set the limit on packet size for sending and receiving AMSDU frames
904 when operating with 802.11n.
907 are 7935 and 3839 (bytes).
908 Note the sender may limit the size of AMSDU frames to be less
909 than the maximum specified by the receiving station.
910 Note also that devices are not required to support the 7935 limit,
911 only 3839 is required by the specification and the larger value
912 may require more memory to be dedicated to support functionality
915 When operating as an access point, pass packets between
916 wireless clients directly (default).
917 To instead let them pass up through the
918 system and be forwarded using some other mechanism, use
920 Disabling the internal bridging
921 is useful when traffic is to be processed with
923 .It Cm authmode Ar mode
924 Set the desired authentication mode in infrastructure mode.
925 Not all adapters support all modes.
928 .Cm none , open , shared
934 (IEEE WPA/WPA2/802.11i).
939 modes are only useful when using an authentication service
940 (a supplicant for client operation or an authenticator when
941 operating as an access point).
942 Modes are case insensitive.
944 Enable background scanning when operating as a station.
945 Background scanning is a technique whereby a station associated to
946 an access point will temporarily leave the channel to scan for
947 neighboring stations.
948 This allows a station to maintain a cache of nearby access points
949 so that roaming between access points can be done without
950 a lengthy scan operation.
951 Background scanning is done only when a station is not busy and
952 any outbound traffic will cancel a scan operation.
953 Background scanning should never cause packets to be lost though
954 there may be some small latency if outbound traffic interrupts a
956 By default background scanning is enabled if the device is capable.
957 To disable background scanning, use
959 Background scanning is controlled by the
964 Background scanning must be enabled for roaming; this is an artifact
965 of the current implementation and may not be required in the future.
966 .It Cm bgscanidle Ar idletime
967 Set the minimum time a station must be idle (not transmitting or
968 receiving frames) before a background scan is initiated.
971 parameter is specified in milliseconds.
972 By default a station must be idle at least 250 milliseconds before
973 a background scan is initiated.
974 The idle time may not be set to less than 100 milliseconds.
975 .It Cm bgscanintvl Ar interval
976 Set the interval at which background scanning is attempted.
979 parameter is specified in seconds.
980 By default a background scan is considered every 300 seconds (5 minutes).
983 may not be set to less than 15 seconds.
984 .It Cm bintval Ar interval
985 Set the interval at which beacon frames are sent when operating in
989 parameter is specified in TU's (1024 usecs).
990 By default beacon frames are transmitted every 100 TU's.
991 .It Cm bmissthreshold Ar count
992 Set the number of consecutive missed beacons at which the station
993 will attempt to roam (i.e., search for a new access point).
996 parameter must be in the range 1 to 255; though the
997 upper bound may be reduced according to device capabilities.
998 The default threshold is 7 consecutive missed beacons; but
999 this may be overridden by the device driver.
1000 Another name for the
1004 .It Cm bssid Ar address
1005 Specify the MAC address of the access point to use when operating
1006 as a station in a BSS network.
1007 This overrides any automatic selection done by the system.
1008 To disable a previously selected access point, supply
1013 This option is useful when more than one access point uses the same SSID.
1014 Another name for the
1019 Enable packet bursting.
1020 Packet bursting is a transmission technique whereby the wireless
1021 medium is acquired once to send multiple frames and the interframe
1023 This technique can significantly increase throughput by reducing
1024 transmission overhead.
1025 Packet bursting is supported by the 802.11e QoS specification
1026 and some devices that do not support QoS may still be capable.
1027 By default packet bursting is enabled if a device is capable
1029 To disable packet bursting, use
1031 .It Cm chanlist Ar channels
1032 Set the desired channels to use when scanning for access
1033 points, neighbors in an IBSS network, or looking for unoccupied
1034 channels when operating as an access point.
1035 The set of channels is specified as a comma-separated list with
1036 each element in the list representing either a single channel number or a range
1039 Channel numbers must be in the range 1 to 255 and be permissible
1040 according to the operating characteristics of the device.
1041 .It Cm channel Ar number
1042 Set a single desired channel.
1043 Channels range from 1 to 255, but the exact selection available
1044 depends on the region your adaptor was manufactured for.
1050 will clear any desired channel and, if the device is marked up,
1051 force a scan for a channel to operate on.
1052 Alternatively the frequency, in megahertz, may be specified
1053 instead of the channel number.
1055 When there are several ways to use a channel the channel
1056 number/frequency may be appended with attributes to clarify.
1057 For example, if a device is capable of operating on channel 6
1058 with 802.11n and 802.11g then one can specify that g-only use
1059 should be used by specifying ``6:g''.
1060 Similarly the channel width can be specified by appending it
1061 with ``/''; e.g., ``6/40'' specifies a 40MHz wide channel,
1062 These attributes can be combined as in: ``6:ht/40''.
1063 The full set of flags specified following a ``:'' are:
1069 (Atheros Dynamic Turbo mode),
1077 (Atheros Static Turbo mode),
1080 (Atheros Dynamic Turbo mode, or appended to ``st'' and ``dt'').
1081 The full set of channel widths following a '/' are:
1083 (5MHz aka quarter-rate channel),
1085 (10MHz aka half-rate channel),
1087 (20MHz mostly for use in specifying ht20),
1090 (40MHz mostly for use in specifying ht40).
1092 a 40MHz HT channel specification may include the location
1093 of the extension channel by appending ``+'' or ``-'' for above and below,
1094 respectively; e.g., ``2437:ht/40+'' specifies 40MHz wide HT operation
1095 with the center channel at frequency 2437 and the extension channel above.
1096 .It Cm country Ar name
1097 Set the country code to use in calculating the regulatory constraints
1099 In particular the set of available channels, how the wireless device
1100 will operation on the channels, and the maximum transmit power that
1101 can be used on a channel are defined by this setting.
1102 Country/Region codes are specified as a 2-character abbreviation
1103 defined by ISO 3166 or using a longer, but possibly ambiguous, spelling;
1104 e.g., "ES" and "Spain".
1105 The set of country codes are taken from
1106 .Pa /etc/regdomain.xml
1108 be viewed with the ``list countries'' request.
1109 Note that not all devices support changing the country code from a default
1110 setting; typically stored in EEPROM.
1118 Enable Dynamic Frequency Selection (DFS) as specified in 802.11h.
1119 DFS embodies several facilities including detection of overlapping
1120 radar signals, dynamic transmit power control, and channel selection
1121 according to a least-congested criteria.
1122 DFS support is mandatory for some 5GHz frequencies in certain
1123 locales (e.g., ETSI).
1124 By default DFS is enabled according to the regulatory definitions
1126 .Pa /etc/regdomain.xml
1127 and the current country code, regdomain,
1129 Note the underlying device (and driver) must support radar detection
1130 for full DFS support to work.
1131 To be fully compliant with the local regulatory agency frequencies that
1132 require DFS should not be used unless it is fully supported.
1135 to disable this functionality for testing.
1137 Enable support for the 802.11d specification (default).
1138 When this support is enabled in station mode, beacon frames that advertise
1139 a country code different than the currently configured country code will
1140 cause an event to be dispatched to user applications.
1141 This event can be used by the station to adopt that country code and
1142 operate according to the associated regulatory constraints.
1143 When operating as an access point with 802.11d enabled the beacon and
1144 probe response frames transmitted will advertise the current regulatory
1146 To disable 802.11d use
1149 Enable 802.11h support including spectrum management.
1150 When 802.11h is enabled beacon and probe response frames will have
1151 the SpectrumMgt bit set in the capabilities field and
1152 country and power constraint information elements will be present.
1153 802.11h support also includes handling Channel Switch Announcements (CSA)
1154 which are a mechanism to coordinate channel changes by an access point.
1155 By default 802.11h is enabled if the device is capable.
1156 To disable 802.11h use
1158 .It Cm deftxkey Ar index
1159 Set the default key to use for transmission.
1160 Typically this is only set when using WEP encryption.
1161 Note that you must set a default transmit key
1162 for the system to know which key to use in encrypting outbound traffic.
1165 is an alias for this request; it is provided for backwards compatibility.
1166 .It Cm dtimperiod Ar period
1169 period for transmitting buffered multicast data frames when
1170 operating in ap mode.
1173 specifies the number of beacon intervals between DTIM
1174 and must be in the range 1 to 15.
1175 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
1177 Enable the use of quiet IE.
1178 Hostap will use this to silence other
1179 stations to reduce interference for radar detection when
1180 operating on 5GHz frequency and doth support is enabled.
1183 to disable this functionality.
1184 .It Cm quiet_period Ar period
1187 to the number of beacon intervals between the start of regularly
1188 scheduled quiet intervals defined by Quiet element.
1189 .It Cm quiet_count Ar count
1192 to the number of TBTTs until the beacon interval during which the
1193 next quiet interval shall start.
1194 A value of 1 indicates the quiet
1195 interval will start during the beacon interval starting at the next
1197 A value 0 is reserved.
1198 .It Cm quiet_offset Ar offset
1201 to the offset of the start of the quiet interval from the TBTT
1202 specified by the Quiet count, expressed in TUs.
1205 shall be less than one beacon interval.
1206 .It Cm quiet_duration Ar dur
1209 to the duration of the Quiet interval, expressed in TUs.
1210 The value should be less than beacon interval.
1212 Enable the use of Atheros Dynamic Turbo mode when communicating with
1213 another Dynamic Turbo-capable station.
1214 Dynamic Turbo mode is an Atheros-specific mechanism by which
1215 stations switch between normal 802.11 operation and a ``boosted''
1216 mode in which a 40MHz wide channel is used for communication.
1217 Stations using Dynamic Turbo mode operate boosted only when the
1218 channel is free of non-dturbo stations; when a non-dturbo station
1219 is identified on the channel all stations will automatically drop
1220 back to normal operation.
1221 By default, Dynamic Turbo mode is not enabled, even if the device is capable.
1222 Note that turbo mode (dynamic or static) is only allowed on some
1223 channels depending on the regulatory constraints; use the
1225 command to identify the channels where turbo mode may be used.
1226 To disable Dynamic Turbo mode use
1229 Enable Dynamic WDS (DWDS) support.
1230 DWDS is a facility by which 4-address traffic can be carried between
1231 stations operating in infrastructure mode.
1232 A station first associates to an access point and authenticates using
1233 normal procedures (e.g., WPA).
1234 Then 4-address frames are passed to carry traffic for stations
1235 operating on either side of the wireless link.
1236 DWDS extends the normal WDS mechanism by leveraging existing security
1237 protocols and eliminating static binding.
1239 When DWDS is enabled on an access point 4-address frames received from
1240 an authorized station will generate a ``DWDS discovery'' event to user
1242 This event should be used to create a WDS interface that is bound
1243 to the remote station (and usually plumbed into a bridge).
1244 Once the WDS interface is up and running 4-address traffic then logically
1245 flows through that interface.
1247 When DWDS is enabled on a station, traffic with a destination address
1248 different from the peer station are encapsulated in a 4-address frame
1249 and transmitted to the peer.
1250 All 4-address traffic uses the security information of the stations
1251 (e.g., cryptographic keys).
1252 A station is associated using 802.11n facilities may transport
1253 4-address traffic using these same mechanisms; this depends on available
1254 resources and capabilities of the device.
1255 The DWDS implementation guards against layer 2 routing loops of
1258 Enable the use of Atheros Fast Frames when communicating with
1259 another Fast Frames-capable station.
1260 Fast Frames are an encapsulation technique by which two 802.3
1261 frames are transmitted in a single 802.11 frame.
1262 This can noticeably improve throughput but requires that the
1263 receiving station understand how to decapsulate the frame.
1264 Fast frame use is negotiated using the Atheros 802.11 vendor-specific
1265 protocol extension so enabling use is safe when communicating with
1266 non-Atheros devices.
1267 By default, use of fast frames is enabled if the device is capable.
1268 To explicitly disable fast frames, use
1270 .It Cm fragthreshold Ar length
1271 Set the threshold for which transmitted frames are broken into fragments.
1274 argument is the frame size in bytes and must be in the range 256 to 2346.
1282 disables transmit fragmentation.
1283 Not all adapters honor the fragmentation threshold.
1285 When operating as an access point, do not broadcast the SSID
1286 in beacon frames or respond to probe request frames unless
1287 they are directed to the ap (i.e., they include the ap's SSID).
1288 By default, the SSID is included in beacon frames and
1289 undirected probe request frames are answered.
1290 To re-enable the broadcast of the SSID etc., use
1293 Enable use of High Throughput (HT) when using 802.11n (default).
1294 The 802.11n specification includes mechanisms for operation
1295 on 20MHz and 40MHz wide channels using different signalling mechanisms
1296 than specified in 802.11b, 802.11g, and 802.11a.
1297 Stations negotiate use of these facilities, termed HT20 and HT40,
1298 when they associate.
1299 To disable all use of 802.11n use
1301 To disable use of HT20 (e.g., to force only HT40 use) use
1303 To disable use of HT40 use
1306 HT configuration is used to ``auto promote'' operation
1307 when several choices are available.
1308 For example, if a station associates to an 11n-capable access point
1309 it controls whether the station uses legacy operation, HT20, or HT40.
1310 When an 11n-capable device is setup as an access point and
1311 Auto Channel Selection is used to locate a channel to operate on,
1312 HT configuration controls whether legacy, HT20, or HT40 operation is setup
1313 on the selected channel.
1314 If a fixed channel is specified for a station then HT configuration can
1315 be given as part of the channel specification; e.g., 6:ht/20 to setup
1316 HT20 operation on channel 6.
1318 Enable use of compatibility support for pre-802.11n devices (default).
1319 The 802.11n protocol specification went through several incompatible iterations.
1320 Some vendors implemented 11n support to older specifications that
1321 will not interoperate with a purely 11n-compliant station.
1322 In particular the information elements included in management frames
1323 for old devices are different.
1324 When compatibility support is enabled both standard and compatible data
1326 Stations that associate using the compatibility mechanisms are flagged
1328 To disable compatibility support use
1330 .It Cm htprotmode Ar technique
1331 For interfaces operating in 802.11n, use the specified
1333 for protecting HT frames in a mixed legacy/HT network.
1334 The set of valid techniques is
1339 Technique names are case insensitive.
1341 Enable inactivity processing for stations associated to an
1342 access point (default).
1343 When operating as an access point the 802.11 layer monitors
1344 the activity of each associated station.
1345 When a station is inactive for 5 minutes it will send several
1346 ``probe frames'' to see if the station is still present.
1347 If no response is received then the station is deauthenticated.
1348 Applications that prefer to handle this work can disable this
1352 Set the location to use in calculating regulatory constraints.
1353 The location is also advertised in beacon and probe response frames
1354 when 802.11d is enabled with
1363 Display the list of channels available for use taking into account
1364 any restrictions set with the
1367 See the description of
1369 for more information.
1371 Display the adaptor's capabilities, including the operating
1374 Display the list of channels available for use.
1375 Channels are shown with their IEEE channel number, equivalent
1376 frequency, and usage modes.
1377 Channels identified as
1382 Channels identified as
1384 may be used only for Atheros' Static Turbo mode
1386 . Cm mediaopt turbo ) .
1387 Channels marked with a
1389 have a regulatory constraint that they be passively scanned.
1390 This means a station is not permitted to transmit on the channel until
1391 it identifies the channel is being used for 802.11 communication;
1392 typically by hearing a beacon frame from an access point operating
1395 is another way of requesting this information.
1396 By default a compacted list of channels is displayed; if the
1398 option is specified then all channels are shown.
1399 .It Cm list countries
1400 Display the set of country codes and regulatory domains that can be
1401 used in regulatory configuration.
1403 Display the current MAC Access Control List state.
1404 Each address is prefixed with a character that indicates the
1405 current policy applied to it:
1407 indicates the address is allowed access,
1409 indicates the address is denied access,
1411 indicates the address is present but the current policy open
1412 (so the ACL is not consulted).
1414 Displays the mesh routing table, used for forwarding packets on a mesh
1416 .It Cm list regdomain
1417 Display the current regulatory settings including the available channels
1418 and transmit power caps.
1420 Display the parameters that govern roaming operation.
1422 Display the parameters that govern transmit operation.
1424 Display the transmit power caps for each channel.
1426 Display the access points and/or ad-hoc neighbors
1427 located in the vicinity.
1428 This information may be updated automatically by the adapter
1431 request or through background scanning.
1432 Depending on the capabilities of the stations the following
1433 flags can be included in the output:
1437 Indicates that the station is permitted to send/receive data frames.
1439 Extended Rate Phy (ERP).
1440 Indicates that the station is operating in an 802.11g network
1441 using extended transmit rates.
1443 High Throughput (HT).
1444 Indicates that the station is using HT transmit rates.
1445 If a `+' follows immediately after then the station associated
1446 using deprecated mechanisms supported only when
1451 Indicates that the station is operating in power save mode.
1453 Quality of Service (QoS).
1454 Indicates that the station is using QoS encapsulation for
1456 QoS encapsulation is enabled only when WME mode is enabled.
1459 Indicates that the station is doing short preamble to optionally
1460 improve throughput performance with 802.11g and 802.11b.
1462 Transitional Security Network (TSN).
1463 Indicates that the station associated using TSN; see also
1467 Wi-Fi Protected Setup (WPS).
1468 Indicates that the station associated using WPS.
1471 By default interesting information elements captured from the neighboring
1472 stations are displayed at the end of each row.
1473 Possible elements include:
1475 (station supports WME),
1477 (station supports WPA),
1479 (station supports WPS),
1481 (station supports 802.11i/RSN),
1483 (station supports 802.11n/HT communication),
1485 (station supports Atheros protocol extensions),
1487 (station supports unknown vendor-specific extensions).
1490 flag is used all the information elements and their
1491 contents will be shown.
1494 flag also enables display of long SSIDs.
1497 command is another way of requesting this information.
1499 When operating as an access point display the stations that are
1500 currently associated.
1501 When operating in ad-hoc mode display stations identified as
1502 neighbors in the IBSS.
1503 When operating in mesh mode display stations identified as
1504 neighbors in the MBSS.
1505 When operating in station mode display the access point.
1506 Capabilities advertised by the stations are described under
1510 Depending on the capabilities of the stations the following
1511 flags can be included in the output:
1515 Indicates that the station is permitted to send/receive data frames.
1517 Extended Rate Phy (ERP).
1518 Indicates that the station is operating in an 802.11g network
1519 using extended transmit rates.
1521 High Throughput (HT).
1522 Indicates that the station is using HT transmit rates.
1523 If a `+' follows immediately after then the station associated
1524 using deprecated mechanisms supported only when
1529 Indicates that the station is operating in power save mode.
1531 Quality of Service (QoS).
1532 Indicates that the station is using QoS encapsulation for
1534 QoS encapsulation is enabled only when WME mode is enabled.
1537 Indicates that the station is doing short preamble to optionally
1538 improve throughput performance with 802.11g and 802.11b.
1540 Transitional Security Network (TSN).
1541 Indicates that the station associated using TSN; see also
1545 Wi-Fi Protected Setup (WPS).
1546 Indicates that the station associated using WPS.
1549 By default information elements received from associated stations
1550 are displayed in a short form; the
1552 flag causes this information to be displayed symbolically.
1554 Display the current channel parameters to use when operating in WME mode.
1557 option is specified then both channel and BSS parameters are displayed
1558 for each AC (first channel, then BSS).
1559 When WME mode is enabled for an adaptor this information will be
1560 displayed with the regular status; this command is mostly useful
1561 for examining parameters when WME mode is disabled.
1562 See the description of the
1564 directive for information on the various parameters.
1565 .It Cm maxretry Ar count
1566 Set the maximum number of tries to use in sending unicast frames.
1567 The default setting is 6 but drivers may override this with a value
1569 .It Cm mcastrate Ar rate
1570 Set the rate for transmitting multicast/broadcast frames.
1571 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1572 This rate should be valid for the current operating conditions;
1573 if an invalid rate is specified drivers are free to chose an
1575 .It Cm mgtrate Ar rate
1576 Set the rate for transmitting management and/or control frames.
1577 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1579 Set the location to use in calculating regulatory constraints.
1580 The location is also advertised in beacon and probe response frames
1581 when 802.11d is enabled with
1590 Enable powersave operation.
1591 When operating as a client, the station will conserve power by
1592 periodically turning off the radio and listening for
1593 messages from the access point telling it there are packets waiting.
1594 The station must then retrieve the packets.
1595 Not all devices support power save operation as a client.
1596 The 802.11 specification requires that all access points support
1597 power save but some drivers do not.
1600 to disable powersave operation when operating as a client.
1601 .It Cm powersavesleep Ar sleep
1602 Set the desired max powersave sleep time in TU's (1024 usecs).
1603 By default the max powersave sleep time is 100 TU's.
1604 .It Cm protmode Ar technique
1605 For interfaces operating in 802.11g, use the specified
1607 for protecting OFDM frames in a mixed 11b/11g network.
1608 The set of valid techniques is
1614 Technique names are case insensitive.
1615 Not all devices support
1617 as a protection technique.
1619 When operating as an access point in 802.11g mode allow only
1620 11g-capable stations to associate (11b-only stations are not
1621 permitted to associate).
1622 To allow both 11g and 11b-only stations to associate, use
1625 When operating as an access point in 802.11n mode allow only
1626 HT-capable stations to associate (legacy stations are not
1627 permitted to associate).
1628 To allow both HT and legacy stations to associate, use
1630 .It Cm regdomain Ar sku
1631 Set the regulatory domain to use in calculating the regulatory constraints
1633 In particular the set of available channels, how the wireless device
1634 will operation on the channels, and the maximum transmit power that
1635 can be used on a channel are defined by this setting.
1636 Regdomain codes (SKU's) are taken from
1637 .Pa /etc/regdomain.xml
1639 be viewed with the ``list countries'' request.
1640 Note that not all devices support changing the regdomain from a default
1641 setting; typically stored in EEPROM.
1649 Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n
1651 Note that RIFS must be supported by both the station and access point
1655 .It Cm roam:rate Ar rate
1656 Set the threshold for controlling roaming when operating in a BSS.
1659 parameter specifies the transmit rate in megabits
1660 at which roaming should be considered.
1661 If the current transmit rate drops below this setting and background scanning
1662 is enabled, then the system will check if a more desirable access point is
1663 available and switch over to it.
1664 The current scan cache contents are used if they are considered
1665 valid according to the
1667 parameter; otherwise a background scan operation is triggered before
1668 any selection occurs.
1669 Each channel type has a separate rate threshold; the default values are:
1670 12 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng).
1671 .It Cm roam:rssi Ar rssi
1672 Set the threshold for controlling roaming when operating in a BSS.
1675 parameter specifies the receive signal strength in dBm units
1676 at which roaming should be considered.
1677 If the current rssi drops below this setting and background scanning
1678 is enabled, then the system will check if a more desirable access point is
1679 available and switch over to it.
1680 The current scan cache contents are used if they are considered
1681 valid according to the
1683 parameter; otherwise a background scan operation is triggered before
1684 any selection occurs.
1685 Each channel type has a separate rssi threshold; the default values are
1687 .It Cm roaming Ar mode
1688 When operating as a station, control how the system will
1689 behave when communication with the current access point
1693 argument may be one of
1695 (leave it to the hardware device to decide),
1697 (handle either in the device or the operating system\[em]as appropriate),
1699 (do nothing until explicitly instructed).
1700 By default, the device is left to handle this if it is
1701 capable; otherwise, the operating system will automatically
1702 attempt to reestablish communication.
1703 Manual mode is used by applications such as
1704 .Xr wpa_supplicant 8
1705 that want to control the selection of an access point.
1706 .It Cm rtsthreshold Ar length
1707 Set the threshold for which
1708 transmitted frames are preceded by transmission of an
1714 is the frame size in bytes and must be in the range 1 to 2346.
1722 disables transmission of RTS frames.
1723 Not all adapters support setting the RTS threshold.
1725 Initiate a scan of neighboring stations, wait for it to complete, and
1726 display all stations found.
1727 Only the super-user can initiate a scan.
1730 for information on the display.
1731 By default a background scan is done; otherwise a foreground
1732 scan is done and the station may roam to a different access point.
1735 request can be used to show recent scan results without
1736 initiating a new scan.
1737 .It Cm scanvalid Ar threshold
1738 Set the maximum time the scan cache contents are considered valid;
1739 i.e., will be used without first triggering a scan operation to
1743 parameter is specified in seconds and defaults to 60 seconds.
1744 The minimum setting for
1747 One should take care setting this threshold; if it is set too low
1748 then attempts to roam to another access point may trigger unnecessary
1749 background scan operations.
1751 Enable use of Short Guard Interval when operating in 802.11n
1753 NB: this currently enables Short GI on both HT40 and HT20 channels.
1754 To disable Short GI use
1757 Enable use of Static Spatial Multiplexing Power Save (SMPS)
1758 when operating in 802.11n.
1759 A station operating with Static SMPS maintains only a single
1760 receive chain active (this can significantly reduce power consumption).
1764 Enable use of Dynamic Spatial Multiplexing Power Save (SMPS)
1765 when operating in 802.11n.
1766 A station operating with Dynamic SMPS maintains only a single
1767 receive chain active but switches to multiple receive chains when it
1768 receives an RTS frame (this can significantly reduce power consumption).
1769 Note that stations cannot distinguish between RTS/CTS intended to
1770 enable multiple receive chains and those used for other purposes.
1774 Set the desired Service Set Identifier (aka network name).
1775 The SSID is a string up to 32 characters
1776 in length and may be specified as either a normal string or in
1777 hexadecimal when preceded by
1779 Additionally, the SSID may be cleared by setting it to
1781 .It Cm tdmaslot Ar slot
1782 When operating with TDMA, use the specified
1787 is a number between 0 and the maximum number of slots in the BSS.
1788 Note that a station configured as slot 0 is a master and
1789 will broadcast beacon frames advertising the BSS;
1790 stations configured to use other slots will always
1791 scan to locate a master before they ever transmit.
1795 .It Cm tdmaslotcnt Ar cnt
1796 When operating with TDMA, setup a BSS with
1799 The slot count may be at most 8.
1800 The current implementation is only tested with two stations
1801 (i.e., point to point applications).
1802 This setting is only meaningful when a station is configured as slot 0;
1803 other stations adopt this setting from the BSS they join.
1807 .It Cm tdmaslotlen Ar len
1808 When operating with TDMA, setup a BSS such that each station has a slot
1811 The slot length must be at least 150 microseconds (1/8 TU)
1812 and no more than 65 milliseconds.
1813 Note that setting too small a slot length may result in poor channel
1814 bandwidth utilization due to factors such as timer granularity and
1816 This setting is only meaningful when a station is configured as slot 0;
1817 other stations adopt this setting from the BSS they join.
1820 is set to 10 milliseconds.
1821 .It Cm tdmabintval Ar intval
1822 When operating with TDMA, setup a BSS such that beacons are transmitted every
1824 superframes to synchronize the TDMA slot timing.
1825 A superframe is defined as the number of slots times the slot length; e.g.,
1826 a BSS with two slots of 10 milliseconds has a 20 millisecond superframe.
1827 The beacon interval may not be zero.
1830 causes the timers to be resynchronized more often; this can be help if
1831 significant timer drift is observed.
1836 When operating as an access point with WPA/802.11i allow legacy
1837 stations to associate using static key WEP and open authentication.
1838 To disallow legacy station use of WEP, use
1840 .It Cm txpower Ar power
1841 Set the power used to transmit frames.
1844 argument is specified in .5 dBm units.
1845 Out of range values are truncated.
1846 Typically only a few discreet power settings are available and
1847 the driver will use the setting closest to the specified value.
1848 Not all adapters support changing the transmit power.
1849 .It Cm ucastrate Ar rate
1850 Set a fixed rate for transmitting unicast frames.
1851 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1852 This rate should be valid for the current operating conditions;
1853 if an invalid rate is specified drivers are free to chose an
1855 .It Cm wepmode Ar mode
1856 Set the desired WEP mode.
1857 Not all adapters support all modes.
1858 The set of valid modes is
1864 mode explicitly tells the adaptor to allow association with access
1865 points which allow both encrypted and unencrypted traffic.
1868 means that the access point must only allow encrypted connections.
1871 is generally another name for
1873 Modes are case insensitive.
1874 .It Cm weptxkey Ar index
1875 Set the WEP key to be used for transmission.
1876 This is the same as setting the default transmission key with
1878 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
1879 Set the selected WEP key.
1882 is not given, key 1 is set.
1883 A WEP key will be either 5 or 13
1884 characters (40 or 104 bits) depending on the local network and the
1885 capabilities of the adaptor.
1886 It may be specified either as a plain
1887 string or as a string of hexadecimal digits preceded by
1889 For maximum portability, hex keys are recommended;
1890 the mapping of text keys to WEP encryption is usually driver-specific.
1893 drivers do this mapping differently to
1895 A key may be cleared by setting it to
1897 If WEP is supported then there are at least four keys.
1898 Some adapters support more than four keys.
1899 If that is the case, then the first four keys
1900 (1-4) will be the standard temporary keys and any others will be adaptor
1901 specific keys such as permanent keys stored in NVRAM.
1903 Note that you must set a default transmit key with
1905 for the system to know which key to use in encrypting outbound traffic.
1907 Enable Wireless Multimedia Extensions (WME) support, if available,
1908 for the specified interface.
1909 WME is a subset of the IEEE 802.11e standard to support the
1910 efficient communication of realtime and multimedia data.
1911 To disable WME support, use
1913 Another name for this parameter is
1916 The following parameters are meaningful only when WME support is in use.
1917 Parameters are specified per-AC (Access Category) and
1918 split into those that are used by a station when acting
1919 as an access point and those for client stations in the BSS.
1920 The latter are received from the access point and may not be changed
1922 The following Access Categories are recognized:
1924 .Bl -tag -width ".Cm AC_BK" -compact
1928 best effort delivery,
1943 AC parameters are case-insensitive.
1944 Traffic classification is done in the operating system using the
1945 vlan priority associated with data frames or the
1946 ToS (Type of Service) indication in IP-encapsulated frames.
1947 If neither information is present, traffic is assigned to the
1948 Best Effort (BE) category.
1949 .Bl -tag -width indent
1951 Set the ACK policy for QoS transmissions by the local station;
1952 this controls whether or not data frames transmitted by a station
1953 require an ACK response from the receiving station.
1954 To disable waiting for an ACK use
1956 This parameter is applied only to the local station.
1958 Enable the Admission Control Mandatory (ACM) mechanism
1959 for transmissions by the local station.
1960 To disable the ACM use
1962 On stations in a BSS this parameter is read-only and indicates
1963 the setting received from the access point.
1964 NB: ACM is not supported right now.
1965 .It Cm aifs Ar ac Ar count
1966 Set the Arbitration Inter Frame Spacing (AIFS)
1967 channel access parameter to use for transmissions
1968 by the local station.
1969 On stations in a BSS this parameter is read-only and indicates
1970 the setting received from the access point.
1971 .It Cm cwmin Ar ac Ar count
1972 Set the CWmin channel access parameter to use for transmissions
1973 by the local station.
1974 On stations in a BSS this parameter is read-only and indicates
1975 the setting received from the access point.
1976 .It Cm cwmax Ar ac Ar count
1977 Set the CWmax channel access parameter to use for transmissions
1978 by the local station.
1979 On stations in a BSS this parameter is read-only and indicates
1980 the setting received from the access point.
1981 .It Cm txoplimit Ar ac Ar limit
1982 Set the Transmission Opportunity Limit channel access parameter
1983 to use for transmissions by the local station.
1984 This parameter defines an interval of time when a WME station
1985 has the right to initiate transmissions onto the wireless medium.
1986 On stations in a BSS this parameter is read-only and indicates
1987 the setting received from the access point.
1988 .It Cm bss:aifs Ar ac Ar count
1989 Set the AIFS channel access parameter to send to stations in a BSS.
1990 This parameter is meaningful only when operating in ap mode.
1991 .It Cm bss:cwmin Ar ac Ar count
1992 Set the CWmin channel access parameter to send to stations in a BSS.
1993 This parameter is meaningful only when operating in ap mode.
1994 .It Cm bss:cwmax Ar ac Ar count
1995 Set the CWmax channel access parameter to send to stations in a BSS.
1996 This parameter is meaningful only when operating in ap mode.
1997 .It Cm bss:txoplimit Ar ac Ar limit
1998 Set the TxOpLimit channel access parameter to send to stations in a BSS.
1999 This parameter is meaningful only when operating in ap mode.
2002 Enable Wireless Privacy Subscriber support.
2003 Note that WPS support requires a WPS-capable supplicant.
2004 To disable this function use
2008 The following parameters support an optional access control list
2009 feature available with some adapters when operating in ap mode; see
2011 This facility allows an access point to accept/deny association
2012 requests based on the MAC address of the station.
2013 Note that this feature does not significantly enhance security
2014 as MAC address spoofing is easy to do.
2015 .Bl -tag -width indent
2016 .It Cm mac:add Ar address
2017 Add the specified MAC address to the database.
2018 Depending on the policy setting association requests from the
2019 specified station will be allowed or denied.
2021 Set the ACL policy to permit association only by
2022 stations registered in the database.
2023 .It Cm mac:del Ar address
2024 Delete the specified MAC address from the database.
2026 Set the ACL policy to deny association only by
2027 stations registered in the database.
2028 .It Cm mac:kick Ar address
2029 Force the specified station to be deauthenticated.
2030 This typically is done to block a station after updating the
2033 Set the ACL policy to allow all stations to associate.
2035 Delete all entries in the database.
2037 Set the ACL policy to permit association only by
2038 stations approved by a RADIUS server.
2039 Note that this feature requires the
2041 program be configured to do the right thing
2042 as it handles the RADIUS processing
2043 (and marks stations as authorized).
2046 The following parameters are related to a wireless interface operating in mesh
2048 .Bl -tag -width indent
2049 .It Cm meshid Ar meshid
2050 Set the desired Mesh Identifier.
2051 The Mesh ID is a string up to 32 characters in length.
2052 A mesh interface must have a Mesh Identifier specified
2053 to reach an operational state.
2054 .It Cm meshttl Ar ttl
2055 Set the desired ``time to live'' for mesh forwarded packets;
2056 this is the number of hops a packet may be forwarded before
2058 The default setting for
2062 Enable or disable peering with neighbor mesh stations.
2063 Stations must peer before any data packets can be exchanged.
2068 Enable or disable forwarding packets by a mesh interface.
2073 This attribute specifies whether or not the mesh STA activates mesh gate
2078 .It Cm meshmetric Ar protocol
2081 as the link metric protocol used on a mesh network.
2082 The default protocol is called
2084 The mesh interface will restart after changing this setting.
2085 .It Cm meshpath Ar protocol
2088 as the path selection protocol used on a mesh network.
2089 The only available protocol at the moment is called
2091 (Hybrid Wireless Mesh Protocol).
2092 The mesh interface will restart after changing this setting.
2093 .It Cm hwmprootmode Ar mode
2094 Stations on a mesh network can operate as ``root nodes.''
2095 Root nodes try to find paths to all mesh nodes and advertise themselves
2097 When there is a root mesh node on a network, other mesh nodes can setup
2098 paths between themselves faster because they can use the root node
2099 to find the destination.
2100 This path may not be the best, but on-demand
2101 routing will eventually find the best path.
2102 The following modes are recognized:
2104 .Bl -tag -width ".Cm PROACTIVE" -compact
2108 Send broadcast path requests every two seconds.
2109 Nodes on the mesh without a path to this root mesh station with try to
2110 discover a path to us.
2112 Send broadcast path requests every two seconds and every node must reply
2113 with a path reply even if it already has a path to this root mesh station.
2115 Send broadcast root announcement (RANN) frames.
2116 Nodes on the mesh without a path to this root mesh station with try to
2117 discover a path to us.
2123 .It Cm hwmpmaxhops Ar cnt
2124 Set the maximum number of hops allowed in an HMWP path to
2126 The default setting for
2131 The following parameters are for compatibility with other systems:
2132 .Bl -tag -width indent
2134 Another name for the
2140 .It Cm stationname Ar name
2141 Set the name of this station.
2142 The station name is not part of the IEEE 802.11
2143 protocol though some interfaces support it.
2145 seems to be meaningful to identical or virtually identical equipment.
2146 Setting the station name is identical in syntax to setting the SSID.
2153 Another way of saying
2159 Another way of saying
2165 Another way of saying:
2166 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
2172 .Ar n : k1 , k2 , k3 , k4
2175 Another way of saying
2176 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
2181 Another way of saying
2188 The following parameters are specific to bridge interfaces:
2189 .Bl -tag -width indent
2190 .It Cm addm Ar interface
2191 Add the interface named by
2193 as a member of the bridge.
2194 The interface is put into promiscuous mode
2195 so that it can receive every packet sent on the network.
2196 .It Cm deletem Ar interface
2197 Remove the interface named by
2200 Promiscuous mode is disabled on the interface when
2201 it is removed from the bridge.
2202 .It Cm maxaddr Ar size
2203 Set the size of the bridge address cache to
2205 The default is 2000 entries.
2206 .It Cm timeout Ar seconds
2207 Set the timeout of address cache entries to
2212 is zero, then address cache entries will not be expired.
2213 The default is 1200 seconds.
2215 Display the addresses that have been learned by the bridge.
2216 .It Cm static Ar interface-name Ar address
2217 Add a static entry into the address cache pointing to
2218 .Ar interface-name .
2219 Static entries are never aged out of the cache or re-placed, even if the
2220 address is seen on a different interface.
2221 .It Cm deladdr Ar address
2224 from the address cache.
2226 Delete all dynamically-learned addresses from the address cache.
2228 Delete all addresses, including static addresses, from the address cache.
2229 .It Cm discover Ar interface
2230 Mark an interface as a
2233 When the bridge has no address cache entry
2234 (either dynamic or static)
2235 for the destination address of a packet,
2236 the bridge will forward the packet to all
2237 member interfaces marked as
2239 This is the default for all interfaces added to a bridge.
2240 .It Cm -discover Ar interface
2243 attribute on a member interface.
2244 For packets without the
2246 attribute, the only packets forwarded on the interface are broadcast
2247 or multicast packets and packets for which the destination address
2248 is known to be on the interface's segment.
2249 .It Cm learn Ar interface
2250 Mark an interface as a
2253 When a packet arrives on such an interface, the source
2254 address of the packet is entered into the address cache as being a
2255 destination address on the interface's segment.
2256 This is the default for all interfaces added to a bridge.
2257 .It Cm -learn Ar interface
2260 attribute on a member interface.
2261 .It Cm sticky Ar interface
2262 Mark an interface as a
2265 Dynamically learned address entries are treated at static once entered into
2267 Sticky entries are never aged out of the cache or replaced, even if the
2268 address is seen on a different interface.
2269 .It Cm -sticky Ar interface
2272 attribute on a member interface.
2273 .It Cm private Ar interface
2274 Mark an interface as a
2277 A private interface does not forward any traffic to any other port that is also
2278 a private interface.
2279 .It Cm -private Ar interface
2282 attribute on a member interface.
2283 .It Cm span Ar interface
2284 Add the interface named by
2286 as a span port on the bridge.
2287 Span ports transmit a copy of every frame received by the bridge.
2288 This is most useful for snooping a bridged network passively on
2289 another host connected to one of the span ports of the bridge.
2290 .It Cm -span Ar interface
2291 Delete the interface named by
2293 from the list of span ports of the bridge.
2294 .It Cm stp Ar interface
2295 Enable Spanning Tree protocol on
2299 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
2300 Spanning Tree is used to detect and remove loops in a network topology.
2301 .It Cm -stp Ar interface
2302 Disable Spanning Tree protocol on
2304 This is the default for all interfaces added to a bridge.
2305 .It Cm edge Ar interface
2309 An edge port connects directly to end stations cannot create bridging
2310 loops in the network, this allows it to transition straight to forwarding.
2311 .It Cm -edge Ar interface
2312 Disable edge status on
2314 .It Cm autoedge Ar interface
2317 to automatically detect edge status.
2318 This is the default for all interfaces added to a bridge.
2319 .It Cm -autoedge Ar interface
2320 Disable automatic edge status on
2322 .It Cm ptp Ar interface
2325 as a point to point link.
2326 This is required for straight transitions to forwarding and
2327 should be enabled on a direct link to another RSTP capable switch.
2328 .It Cm -ptp Ar interface
2329 Disable point to point link status on
2331 This should be disabled for a half duplex link and for an interface
2332 connected to a shared network segment,
2333 like a hub or a wireless network.
2334 .It Cm autoptp Ar interface
2335 Automatically detect the point to point status on
2337 by checking the full duplex link status.
2338 This is the default for interfaces added to the bridge.
2339 .It Cm -autoptp Ar interface
2340 Disable automatic point to point link detection on
2342 .It Cm maxage Ar seconds
2343 Set the time that a Spanning Tree protocol configuration is valid.
2344 The default is 20 seconds.
2345 The minimum is 6 seconds and the maximum is 40 seconds.
2346 .It Cm fwddelay Ar seconds
2347 Set the time that must pass before an interface begins forwarding
2348 packets when Spanning Tree is enabled.
2349 The default is 15 seconds.
2350 The minimum is 4 seconds and the maximum is 30 seconds.
2351 .It Cm hellotime Ar seconds
2352 Set the time between broadcasting of Spanning Tree protocol
2353 configuration messages.
2354 The hello time may only be changed when operating in legacy stp mode.
2355 The default is 2 seconds.
2356 The minimum is 1 second and the maximum is 2 seconds.
2357 .It Cm priority Ar value
2358 Set the bridge priority for Spanning Tree.
2359 The default is 32768.
2360 The minimum is 0 and the maximum is 61440.
2361 .It Cm proto Ar value
2362 Set the Spanning Tree protocol.
2363 The default is rstp.
2364 The available options are stp and rstp.
2365 .It Cm holdcnt Ar value
2366 Set the transmit hold count for Spanning Tree.
2367 This is the number of packets transmitted before being rate limited.
2369 The minimum is 1 and the maximum is 10.
2370 .It Cm ifpriority Ar interface Ar value
2371 Set the Spanning Tree priority of
2376 The minimum is 0 and the maximum is 240.
2377 .It Cm ifpathcost Ar interface Ar value
2378 Set the Spanning Tree path cost of
2382 The default is calculated from the link speed.
2383 To change a previously selected path cost back to automatic, set the
2385 The minimum is 1 and the maximum is 200000000.
2386 .It Cm ifmaxaddr Ar interface Ar size
2387 Set the maximum number of hosts allowed from an interface, packets with unknown
2388 source addresses are dropped until an existing host cache entry expires or is
2390 Set to 0 to disable.
2393 The following parameters are specific to lagg interfaces:
2394 .Bl -tag -width indent
2395 .It Cm laggport Ar interface
2396 Add the interface named by
2398 as a port of the aggregation interface.
2399 .It Cm -laggport Ar interface
2400 Remove the interface named by
2402 from the aggregation interface.
2403 .It Cm laggproto Ar proto
2404 Set the aggregation protocol.
2405 The default is failover.
2406 The available options are failover, fec, lacp, loadbalance, roundrobin and
2408 .It Cm lagghash Ar option Ns Oo , Ns Ar option Oc
2409 Set the packet layers to hash for aggregation protocols which load balance.
2412 The options can be combined using commas.
2414 .Bl -tag -width ".Cm l2" -compact
2416 src/dst mac address and optional vlan number.
2418 src/dst address for IPv4 or IPv6.
2420 src/dst port for TCP/UDP/SCTP.
2425 The following parameters are specific to IP tunnel interfaces,
2427 .Bl -tag -width indent
2428 .It Cm tunnel Ar src_addr dest_addr
2429 Configure the physical source and destination address for IP tunnel
2435 are interpreted as the outer source/destination for the encapsulating
2438 Unconfigure the physical source and destination address for IP tunnel
2439 interfaces previously configured with
2442 Another name for the
2445 .It Cm accept_rev_ethip_ver
2446 Set a flag to accept both correct EtherIP packets and ones
2447 with reversed version field.
2449 This is for backward compatibility with
2451 6.2, 6.3, 7.0, and 7.1.
2452 .It Cm -accept_rev_ethip_ver
2454 .Cm accept_rev_ethip_ver .
2455 .It Cm ignore_source
2456 Set a flag to accept encapsulated packets destined to this host
2457 independently from source address.
2458 This may be useful for hosts, that receive encapsulated packets
2459 from the load balancers.
2460 .It Cm -ignore_source
2463 .It Cm send_rev_ethip_ver
2464 Set a flag to send EtherIP packets with reversed version
2465 field intentionally.
2466 Disabled by default.
2467 This is for backward compatibility with
2469 6.2, 6.3, 7.0, and 7.1.
2470 .It Cm -send_rev_ethip_ver
2472 .Cm send_rev_ethip_ver .
2475 The following parameters are specific to GRE tunnel interfaces,
2477 .Bl -tag -width indent
2478 .It Cm grekey Ar key
2479 Configure the GRE key to be used for outgoing packets.
2481 .Xr gre 4 will always accept GRE packets with invalid or absent keys.
2482 This command will result in a four byte MTU reduction on the interface.
2485 The following parameters are specific to
2488 .Bl -tag -width indent
2489 .It Cm syncdev Ar iface
2490 Use the specified interface
2491 to send and receive pfsync state synchronisation messages.
2493 Stop sending pfsync state synchronisation messages over the network.
2494 .It Cm syncpeer Ar peer_address
2495 Make the pfsync link point-to-point rather than using
2496 multicast to broadcast the state synchronisation messages.
2497 The peer_address is the IP address of the other host taking part in
2500 Broadcast the packets using multicast.
2502 Set the maximum number of updates for a single state which
2503 can be collapsed into one.
2504 This is an 8-bit number; the default value is 128.
2506 Defer transmission of the first packet in a state until a peer has
2507 acknowledged that the associated state has been inserted.
2509 Do not defer the first packet in a state.
2510 This is the default.
2513 The following parameters are specific to
2516 .Bl -tag -width indent
2517 .It Cm vlan Ar vlan_tag
2518 Set the VLAN tag value to
2520 This value is a 12-bit VLAN Identifier (VID) which is used to create an 802.1Q
2521 VLAN header for packets sent from the
2528 must both be set at the same time.
2529 .It Cm vlandev Ar iface
2530 Associate the physical interface
2535 Packets transmitted through the
2538 diverted to the specified physical interface
2540 with 802.1Q VLAN encapsulation.
2541 Packets with 802.1Q encapsulation received
2542 by the parent interface with the correct VLAN Identifier will be diverted to
2548 interface is assigned a
2549 copy of the parent interface's flags and the parent's Ethernet address.
2554 must both be set at the same time.
2557 interface already has
2558 a physical interface associated with it, this command will fail.
2560 change the association to another physical interface, the existing
2561 association must be cleared first.
2563 Note: if the hardware tagging capability
2564 is set on the parent interface, the
2567 interface's behavior changes:
2570 interface recognizes that the
2571 parent interface supports insertion and extraction of VLAN tags on its
2572 own (usually in firmware) and that it should pass packets to and from
2573 the parent unaltered.
2574 .It Fl vlandev Op Ar iface
2577 pseudo device, disassociate the parent interface from it.
2578 This breaks the link between the
2580 interface and its parent,
2581 clears its VLAN Identifier, flags and its link address and shuts the interface
2585 argument is useless and hence deprecated.
2588 The following parameters are used to configure
2590 protocol on an interface:
2591 .Bl -tag -width indent
2593 Set the virtual host ID.
2594 This is a required setting to initiate
2596 If the virtual host ID does not exist yet, it is created and attached to the
2597 interface, otherwise configuration of an existing vhid is adjusted.
2600 keyword is supplied along with an
2604 address, then this address is configured to be run under control of the
2606 Whenever a last address that refers to a particular vhid is removed from an
2607 interface, the vhid is automatically removed from interface and destroyed.
2608 Any other configuration parameters for the
2610 protocol should be supplied along with the
2613 Acceptable values for vhid are 1 to 255.
2614 .It Cm advbase Ar seconds
2615 Specifies the base of the advertisement interval in seconds.
2616 The acceptable values are 1 to 255.
2617 The default value is 1.
2618 .It Cm advskew Ar interval
2619 Specifies the skew to add to the base advertisement interval to
2620 make one host advertise slower than another host.
2621 It is specified in 1/256 of seconds.
2622 The acceptable values are 1 to 254.
2623 The default value is 0.
2624 .It Cm pass Ar phrase
2625 Set the authentication key to
2627 .It Cm state Ar MASTER|BACKUP
2628 Forcibly change state of a given vhid.
2633 utility displays the current configuration for a network interface
2634 when no optional parameters are supplied.
2635 If a protocol family is specified,
2637 will report only the details specific to that protocol family.
2641 flag is passed before an interface name,
2643 will display the capability list and all
2644 of the supported media for the specified interface.
2647 flag is supplied, address lifetime is displayed for IPv6 addresses,
2648 as time offset string.
2652 flag may be used instead of an interface name.
2655 to display information about all interfaces in the system.
2658 flag limits this to interfaces that are down, and
2660 limits this to interfaces that are up.
2661 When no arguments are given,
2667 flag may be used to list all available interfaces on the system, with
2668 no other additional information.
2671 is specified, only interfaces of that type will be listed.
2673 will list only Ethernet adapters, excluding the loopback interface.
2674 Use of this flag is mutually exclusive
2675 with all other flags and commands, except for
2677 (only list interfaces that are down)
2680 (only list interfaces that are up).
2684 flag may be used to get more verbose status for an interface.
2688 flag may be used to list all of the interface cloners available on
2689 the system, with no additional information.
2690 Use of this flag is mutually exclusive with all other flags and commands.
2694 flag causes keying information for the interface, if available, to be
2696 For example, the values of 802.11 WEP keys and
2698 passphrases will be printed, if accessible to the current user.
2699 This information is not printed by default, as it may be considered
2702 If the network interface driver is not present in the kernel then
2704 will attempt to load it.
2707 flag disables this behavior.
2709 Only the super-user may modify the configuration of a network interface.
2711 Assign the IPv4 address
2713 with a network mask of
2717 .Dl # ifconfig fxp0 inet 192.0.2.10 netmask 255.255.255.0
2719 Add the IPv4 address
2721 with the CIDR network prefix
2727 as a synonym for the canonical form of the option
2729 .Dl # ifconfig ed0 inet 192.0.2.45/28 add
2731 Remove the IPv4 address
2735 .Dl # ifconfig ed0 inet 192.0.2.45 -alias
2737 Enable IPv6 functionality of the interface:
2738 .Dl # ifconfig em0 inet6 -ifdisabled
2740 Add the IPv6 address
2741 .Li 2001:DB8:DBDB::123/48
2744 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias
2745 Note that lower case hexadecimal IPv6 addresses are acceptable.
2747 Remove the IPv6 address added in the above example,
2750 character as shorthand for the network prefix,
2753 as a synonym for the canonical form of the option
2755 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 delete
2757 Configure a single CARP redundant address on igb0, and then switch it
2759 .Dl # ifconfig igb0 vhid 1 10.0.0.1/24 pass foobar up
2760 .Dl # ifconfig igb0 vhid 1 state master
2762 Configure the interface
2764 to use 100baseTX, full duplex Ethernet media options:
2765 .Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex
2767 Label the em0 interface as an uplink:
2768 .Dl # ifconfig em0 description \&"Uplink to Gigabit Switch 2\&"
2770 Create the software network interface
2772 .Dl # ifconfig gif1 create
2774 Destroy the software network interface
2776 .Dl # ifconfig gif1 destroy
2778 Display available wireless networks using
2780 .Dl # ifconfig wlan0 list scan
2782 Messages indicating the specified interface does not exist, the
2783 requested address is unknown, or the user is not privileged and
2784 tried to alter an interface's configuration.
2806 Basic IPv6 node operation requires a link-local address on each
2807 interface configured for IPv6.
2808 Normally, such an address is automatically configured by the
2809 kernel on each interface added to the system or enabled; this behavior may
2810 be disabled by setting per-interface flag
2811 .Cm -auto_linklocal .
2812 The default value of this flag is 1 and can be disabled by using the sysctl
2814 .Va net.inet6.ip6.auto_linklocal .
2816 Do not configure IPv6 addresses with no link-local address by using
2818 It can result in unexpected behaviors of the kernel.