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
325 This is used to specify an Internet host who is willing to receive
326 IP packets encapsulating IPX packets bound for a remote network.
327 An apparent point to point link is constructed, and
328 the address specified will be taken as the IPX address and network
330 .It Cm maclabel Ar label
331 If Mandatory Access Control support is enabled in the kernel,
335 .\" .Xr maclabel 7 ) .
337 If the driver supports the media selection system, set the media type
340 Some interfaces support the mutually exclusive use of one of several
341 different physical media connectors.
342 For example, a 10Mbit/s Ethernet
343 interface might support the use of either
345 or twisted pair connectors.
346 Setting the media type to
348 would change the currently active connector to the AUI port.
351 would activate twisted pair.
352 Refer to the interfaces' driver
353 specific documentation or man page for a complete list of the
355 .It Cm mediaopt Ar opts
356 If the driver supports the media selection system, set the specified
357 media options on the interface.
361 is a comma delimited list of options to apply to the interface.
362 Refer to the interfaces' driver specific man page for a complete
363 list of available options.
364 .It Fl mediaopt Ar opts
365 If the driver supports the media selection system, disable the
366 specified media options on the interface.
368 If the driver supports the media selection system, set the specified
369 operating mode on the interface to
371 For IEEE 802.11 wireless interfaces that support multiple operating modes
372 this directive is used to select between 802.11a
379 .It Cm inst Ar minst , Cm instance Ar minst
380 Set the media instance to
382 This is useful for devices which have multiple physical layer interfaces
385 Set the interface name to
387 .It Cm rxcsum , txcsum , rxcsum6 , txcsum6
388 If the driver supports user-configurable checksum offloading,
389 enable receive (or transmit) checksum offloading on the interface.
390 The feature can be turned on selectively per protocol family.
392 .Cm rxcsum6 , txcsum6
398 Some drivers may not be able to enable these flags independently
399 of each other, so setting one may also set the other.
400 The driver will offload as much checksum work as it can reliably
401 support, the exact level of offloading varies between drivers.
402 .It Fl rxcsum , txcsum , rxcsum6 , txcsum6
403 If the driver supports user-configurable checksum offloading,
404 disable receive (or transmit) checksum offloading on the interface.
405 The feature can be turned off selectively per protocol family.
407 .Fl rxcsum6 , txcsum6
413 These settings may not always be independent of each other.
415 If the driver supports
417 segmentation offloading, enable TSO on the interface.
418 Some drivers may not be able to support TSO for
422 packets, so they may enable only one of them.
424 If the driver supports
426 segmentation offloading, disable TSO on the interface.
427 It will always disable TSO for
432 If the driver supports
434 segmentation offloading for
438 use one of these to selectively enabled it only for one protocol family.
440 If the driver supports
442 segmentation offloading for
446 use one of these to selectively disable it only for one protocol family.
448 If the driver supports
450 large receive offloading, enable LRO on the interface.
452 If the driver supports
454 large receive offloading, disable LRO on the interface.
455 .It Cm wol , wol_ucast , wol_mcast , wol_magic
456 Enable Wake On Lan (WOL) support, if available.
457 WOL is a facility whereby a machine in a low power state may be woken
458 in response to a received packet.
459 There are three types of packets that may wake a system:
460 ucast (directed solely to the machine's mac address),
461 mcast (directed to a broadcast or multicast address),
463 magic (unicast or multicast frames with a ``magic contents'').
464 Not all devices support WOL, those that do indicate the mechanisms
465 they support in their capabilities.
467 is a synonym for enabling all available WOL mechanisms.
470 .It Cm vlanmtu , vlanhwtag, vlanhwfilter, vlanhwcsum, vlanhwtso
471 If the driver offers user-configurable VLAN support, enable
472 reception of extended frames, tag processing in hardware,
473 frame filtering in hardware, checksum offloading, or TSO on VLAN,
475 Note that this must be issued on a physical interface associated with
480 .It Fl vlanmtu , vlanhwtag, vlanhwfilter, vlanhwtso
481 If the driver offers user-configurable VLAN support, disable
482 reception of extended frames, tag processing in hardware,
483 frame filtering in hardware, or TSO on VLAN,
486 Move the interface to the
488 specified by name or JID.
489 If the jail has a virtual network stack, the interface will disappear
490 from the current environment and become visible to the jail.
492 Reclaim the interface from the
494 specified by name or JID.
495 If the jail has a virtual network stack, the interface will disappear
496 from the jail, and become visible to the current network environment.
500 feature and disable interrupts on the interface, if driver supports
505 feature and enable interrupt mode on the interface.
507 Create the specified network pseudo-device.
508 If the interface is given without a unit number, try to create a new
509 device with an arbitrary unit number.
510 If creation of an arbitrary device is successful, the new device name is
511 printed to standard output unless the interface is renamed or destroyed
516 Destroy the specified network pseudo-device.
532 Set the routing metric of the interface to
535 The routing metric is used by the routing protocol
537 Higher metrics have the effect of making a route
538 less favorable; metrics are counted as additional hops
539 to the destination network or host.
541 Set the maximum transmission unit of the interface to
543 default is interface specific.
544 The MTU is used to limit the size of packets that are transmitted on an
546 Not all interfaces support setting the MTU, and some interfaces have
548 .It Cm netmask Ar mask
551 Specify how much of the address to reserve for subdividing
552 networks into sub-networks.
553 The mask includes the network part of the local address
554 and the subnet part, which is taken from the host field of the address.
555 The mask can be specified as a single hexadecimal number
558 with a dot-notation Internet address,
559 or with a pseudo-network name listed in the network table
561 The mask contains 1's for the bit positions in the 32-bit address
562 which are to be used for the network and subnet parts,
563 and 0's for the host part.
564 The mask should contain at least the standard network portion,
565 and the subnet field should be contiguous with the network
568 The netmask can also be specified in CIDR notation after the address.
571 option above for more information.
572 .It Cm prefixlen Ar len
576 bits are reserved for subdividing networks into sub-networks.
579 must be integer, and for syntactical reason it must be between 0 to 128.
580 It is almost always 64 under the current IPv6 assignment rule.
581 If the parameter is omitted, 64 is used.
583 The prefix can also be specified using the slash notation after the address.
586 option above for more information.
589 .\" .It Cm nsellength Ar n
592 .\" This specifies a trailing number of bytes for a received
594 .\" used for local identification, the remaining leading part of which is
597 .\" (Network Entity Title).
598 .\" The default value is 1, which is conformant to US
600 .\" When an ISO address is set in an ifconfig command,
603 .\" which is being specified.
606 .\" 20 hex digits should be
609 .\" to be assigned to the interface.
610 .\" There is some evidence that a number different from 1 may be useful
613 .\" 37 type addresses.
614 .It Cm range Ar netrange
615 Under appletalk, set the interface to respond to a
618 .Ar startnet Ns - Ns Ar endnet .
619 Appletalk uses this scheme instead of
622 implements it internally as a set of netmasks.
627 Introduced for compatibility
631 The argument following this specifies the version (phase) of the
632 Appletalk network attached to the interface.
633 Values of 1 or 2 are permitted.
635 .It Cm link Op Cm 0 No - Cm 2
637 Enable special processing of the link level of the interface.
638 These three options are interface specific in actual effect, however,
639 they are in general used to select special modes of operation.
641 of this is to enable SLIP compression, or to select the connector type
642 for some Ethernet cards.
643 Refer to the man page for the specific driver
644 for more information.
646 .It Fl link Op Cm 0 No - Cm 2
648 Disable special processing at the link level with the specified interface.
650 Put the interface in monitor mode.
651 No packets are transmitted, and received packets are discarded after
655 Take the interface out of monitor mode.
659 This may be used to enable an interface after an
661 It happens automatically when setting the first address on an interface.
662 If the interface was reset when previously marked down,
663 the hardware will be re-initialized.
666 The following parameters are for ICMPv6 Neighbor Discovery Protocol.
667 Note that the address family keyword
670 .Bl -tag -width indent
672 Set a flag to enable accepting ICMPv6 Router Advertisement messages.
676 .Va net.inet6.ip6.accept_rtadv
677 controls whether this flag is set by default or not.
682 Set a flag to control whether routers from which the system accepts
683 Router Advertisement messages will be added to the Default Router List
687 flag is disabled, this flag has no effect.
691 .Va net.inet6.ip6.no_radr
692 controls whether this flag is set by default or not.
696 .It Cm auto_linklocal
697 Set a flag to perform automatic link-local address configuration when
698 the interface becomes available.
702 .Va net.inet6.ip6.auto_linklocal
703 controls whether this flag is set by default or not.
704 .It Cm -auto_linklocal
708 Set the specified interface as the default route when there is no
714 Set a flag to disable all of IPv6 network communications on the
716 Note that if there are already configured IPv6
717 addresses on that interface, all of them are marked as
719 and DAD will be performed when this flag is cleared.
723 When this flag is cleared and
725 flag is enabled, automatic configuration of a link-local address is
728 Set a flag to enable Neighbor Unreachability Detection.
732 .It Cm no_prefer_iface
733 Set a flag to not prefer address on the interface as candidates of the
734 source address for outgoing packets, even when the interface is
736 .It Cm -no_prefer_iface
738 .Cm no_prefer_iface .
740 Set a flag to disable Duplicate Address Detection.
745 Set a flag to disable loopback detection in Enhanced Duplicate Address
747 When this flag is set,
748 Duplicate Address Detection will stop in a finite number of probings
749 even if a loopback configuration is detected.
755 The following parameters are specific for IPv6 addresses.
756 Note that the address family keyword
759 .Bl -tag -width indent
761 Set a flag to prefer address as a candidate of the source address for
763 .It Cm -prefer_source
768 The following parameters are specific to cloning
769 IEEE 802.11 wireless interfaces with the
772 .Bl -tag -width indent
773 .It Cm wlandev Ar device
776 as the parent for the cloned device.
777 .It Cm wlanmode Ar mode
778 Specify the operating mode for this cloned device.
796 The operating mode of a cloned interface cannot be changed.
799 mode is actually implemented as an
801 interface with special properties.
802 .It Cm wlanbssid Ar bssid
803 The 802.11 mac address to use for the bssid.
804 This must be specified at create time for a legacy
807 .It Cm wlanaddr Ar address
808 The local mac address.
809 If this is not specified then a mac address will automatically be assigned
810 to the cloned device.
811 Typically this address is the same as the address of the parent device
814 parameter is specified then the driver will craft a unique address for
815 the device (if supported).
819 device as operating in ``legacy mode''.
822 devices have a fixed peer relationship and do not, for example, roam
823 if their peer stops communicating.
824 For completeness a Dynamic WDS (DWDS) interface may marked as
827 Request a unique local mac address for the cloned device.
828 This is only possible if the device supports multiple mac addresses.
829 To force use of the parent's mac address use
832 Mark the cloned interface as depending on hardware support to
833 track received beacons.
834 To have beacons tracked in software use
840 can also be used to indicate no beacons should
841 be transmitted; this can be useful when creating a WDS configuration but
843 interfaces can only be created as companions to an access point.
846 The following parameters are specific to IEEE 802.11 wireless interfaces
850 .Bl -tag -width indent
852 Enable sending and receiving AMPDU frames when using 802.11n (default).
853 The 802.11n specification states a compliant station must be capable
854 of receiving AMPDU frames but transmission is optional.
857 to disable all use of AMPDU with 802.11n.
858 For testing and/or to work around interoperability problems one can use
862 to control use of AMPDU in one direction.
863 .It Cm ampdudensity Ar density
864 Set the AMPDU density parameter used when operating with 802.11n.
865 This parameter controls the inter-packet gap for AMPDU frames.
866 The sending device normally controls this setting but a receiving station
867 may request wider gaps.
870 are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds).
873 is treated the same as 0.
874 .It Cm ampdulimit Ar limit
875 Set the limit on packet size for receiving AMPDU frames when operating
879 are 8192, 16384, 32768, and 65536 but one can also specify
880 just the unique prefix: 8, 16, 32, 64.
881 Note the sender may limit the size of AMPDU frames to be less
882 than the maximum specified by the receiving station.
884 Enable sending and receiving AMSDU frames when using 802.11n.
885 By default AMSDU is received but not transmitted.
888 to disable all use of AMSDU with 802.11n.
889 For testing and/or to work around interoperability problems one can use
893 to control use of AMSDU in one direction.
894 .It Cm amsdulimit Ar limit
895 Set the limit on packet size for sending and receiving AMSDU frames
896 when operating with 802.11n.
899 are 7935 and 3839 (bytes).
900 Note the sender may limit the size of AMSDU frames to be less
901 than the maximum specified by the receiving station.
902 Note also that devices are not required to support the 7935 limit,
903 only 3839 is required by the specification and the larger value
904 may require more memory to be dedicated to support functionality
907 When operating as an access point, pass packets between
908 wireless clients directly (default).
909 To instead let them pass up through the
910 system and be forwarded using some other mechanism, use
912 Disabling the internal bridging
913 is useful when traffic is to be processed with
915 .It Cm authmode Ar mode
916 Set the desired authentication mode in infrastructure mode.
917 Not all adapters support all modes.
920 .Cm none , open , shared
926 (IEEE WPA/WPA2/802.11i).
931 modes are only useful when using an authentication service
932 (a supplicant for client operation or an authenticator when
933 operating as an access point).
934 Modes are case insensitive.
936 Enable background scanning when operating as a station.
937 Background scanning is a technique whereby a station associated to
938 an access point will temporarily leave the channel to scan for
939 neighboring stations.
940 This allows a station to maintain a cache of nearby access points
941 so that roaming between access points can be done without
942 a lengthy scan operation.
943 Background scanning is done only when a station is not busy and
944 any outbound traffic will cancel a scan operation.
945 Background scanning should never cause packets to be lost though
946 there may be some small latency if outbound traffic interrupts a
948 By default background scanning is enabled if the device is capable.
949 To disable background scanning, use
951 Background scanning is controlled by the
956 Background scanning must be enabled for roaming; this is an artifact
957 of the current implementation and may not be required in the future.
958 .It Cm bgscanidle Ar idletime
959 Set the minimum time a station must be idle (not transmitting or
960 receiving frames) before a background scan is initiated.
963 parameter is specified in milliseconds.
964 By default a station must be idle at least 250 milliseconds before
965 a background scan is initiated.
966 The idle time may not be set to less than 100 milliseconds.
967 .It Cm bgscanintvl Ar interval
968 Set the interval at which background scanning is attempted.
971 parameter is specified in seconds.
972 By default a background scan is considered every 300 seconds (5 minutes).
975 may not be set to less than 15 seconds.
976 .It Cm bintval Ar interval
977 Set the interval at which beacon frames are sent when operating in
981 parameter is specified in TU's (1024 usecs).
982 By default beacon frames are transmitted every 100 TU's.
983 .It Cm bmissthreshold Ar count
984 Set the number of consecutive missed beacons at which the station
985 will attempt to roam (i.e., search for a new access point).
988 parameter must be in the range 1 to 255; though the
989 upper bound may be reduced according to device capabilities.
990 The default threshold is 7 consecutive missed beacons; but
991 this may be overridden by the device driver.
996 .It Cm bssid Ar address
997 Specify the MAC address of the access point to use when operating
998 as a station in a BSS network.
999 This overrides any automatic selection done by the system.
1000 To disable a previously selected access point, supply
1005 This option is useful when more than one access point uses the same SSID.
1006 Another name for the
1011 Enable packet bursting.
1012 Packet bursting is a transmission technique whereby the wireless
1013 medium is acquired once to send multiple frames and the interframe
1015 This technique can significantly increase throughput by reducing
1016 transmission overhead.
1017 Packet bursting is supported by the 802.11e QoS specification
1018 and some devices that do not support QoS may still be capable.
1019 By default packet bursting is enabled if a device is capable
1021 To disable packet bursting, use
1023 .It Cm chanlist Ar channels
1024 Set the desired channels to use when scanning for access
1025 points, neighbors in an IBSS network, or looking for unoccupied
1026 channels when operating as an access point.
1027 The set of channels is specified as a comma-separated list with
1028 each element in the list representing either a single channel number or a range
1031 Channel numbers must be in the range 1 to 255 and be permissible
1032 according to the operating characteristics of the device.
1033 .It Cm channel Ar number
1034 Set a single desired channel.
1035 Channels range from 1 to 255, but the exact selection available
1036 depends on the region your adaptor was manufactured for.
1042 will clear any desired channel and, if the device is marked up,
1043 force a scan for a channel to operate on.
1044 Alternatively the frequency, in megahertz, may be specified
1045 instead of the channel number.
1047 When there are several ways to use a channel the channel
1048 number/frequency may be appended with attributes to clarify.
1049 For example, if a device is capable of operating on channel 6
1050 with 802.11n and 802.11g then one can specify that g-only use
1051 should be used by specifying ``6:g''.
1052 Similarly the channel width can be specified by appending it
1053 with ``/''; e.g., ``6/40'' specifies a 40MHz wide channel,
1054 These attributes can be combined as in: ``6:ht/40''.
1055 The full set of flags specified following a ``:'' are:
1061 (Atheros Dynamic Turbo mode),
1069 (Atheros Static Turbo mode),
1072 (Atheros Dynamic Turbo mode, or appended to ``st'' and ``dt'').
1073 The full set of channel widths following a '/' are:
1075 (5MHz aka quarter-rate channel),
1077 (10MHz aka half-rate channel),
1079 (20MHz mostly for use in specifying ht20),
1082 (40MHz mostly for use in specifying ht40).
1084 a 40MHz HT channel specification may include the location
1085 of the extension channel by appending ``+'' or ``-'' for above and below,
1086 respectively; e.g., ``2437:ht/40+'' specifies 40MHz wide HT operation
1087 with the center channel at frequency 2437 and the extension channel above.
1088 .It Cm country Ar name
1089 Set the country code to use in calculating the regulatory constraints
1091 In particular the set of available channels, how the wireless device
1092 will operation on the channels, and the maximum transmit power that
1093 can be used on a channel are defined by this setting.
1094 Country/Region codes are specified as a 2-character abbreviation
1095 defined by ISO 3166 or using a longer, but possibly ambiguous, spelling;
1096 e.g., "ES" and "Spain".
1097 The set of country codes are taken from
1098 .Pa /etc/regdomain.xml
1100 be viewed with the ``list countries'' request.
1101 Note that not all devices support changing the country code from a default
1102 setting; typically stored in EEPROM.
1110 Enable Dynamic Frequency Selection (DFS) as specified in 802.11h.
1111 DFS embodies several facilities including detection of overlapping
1112 radar signals, dynamic transmit power control, and channel selection
1113 according to a least-congested criteria.
1114 DFS support is mandatory for some 5GHz frequencies in certain
1115 locales (e.g., ETSI).
1116 By default DFS is enabled according to the regulatory definitions
1118 .Pa /etc/regdomain.xml
1119 and the current country code, regdomain,
1121 Note the underlying device (and driver) must support radar detection
1122 for full DFS support to work.
1123 To be fully compliant with the local regulatory agency frequencies that
1124 require DFS should not be used unless it is fully supported.
1127 to disable this functionality for testing.
1129 Enable support for the 802.11d specification (default).
1130 When this support is enabled in station mode, beacon frames that advertise
1131 a country code different than the currently configured country code will
1132 cause an event to be dispatched to user applications.
1133 This event can be used by the station to adopt that country code and
1134 operate according to the associated regulatory constraints.
1135 When operating as an access point with 802.11d enabled the beacon and
1136 probe response frames transmitted will advertise the current regulatory
1138 To disable 802.11d use
1141 Enable 802.11h support including spectrum management.
1142 When 802.11h is enabled beacon and probe response frames will have
1143 the SpectrumMgt bit set in the capabilities field and
1144 country and power constraint information elements will be present.
1145 802.11h support also includes handling Channel Switch Announcements (CSA)
1146 which are a mechanism to coordinate channel changes by an access point.
1147 By default 802.11h is enabled if the device is capable.
1148 To disable 802.11h use
1150 .It Cm deftxkey Ar index
1151 Set the default key to use for transmission.
1152 Typically this is only set when using WEP encryption.
1153 Note that you must set a default transmit key
1154 for the system to know which key to use in encrypting outbound traffic.
1157 is an alias for this request; it is provided for backwards compatibility.
1158 .It Cm dtimperiod Ar period
1161 period for transmitting buffered multicast data frames when
1162 operating in ap mode.
1165 specifies the number of beacon intervals between DTIM
1166 and must be in the range 1 to 15.
1167 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
1169 Enable the use of quiet IE.
1170 Hostap will use this to silence other
1171 stations to reduce interference for radar detection when
1172 operating on 5GHz frequency and doth support is enabled.
1175 to disable this functionality.
1176 .It Cm quiet_period Ar period
1179 to the number of beacon intervals between the start of regularly
1180 scheduled quiet intervals defined by Quiet element.
1181 .It Cm quiet_count Ar count
1184 to the number of TBTTs until the beacon interval during which the
1185 next quiet interval shall start.
1186 A value of 1 indicates the quiet
1187 interval will start during the beacon interval starting at the next
1189 A value 0 is reserved.
1190 .It Cm quiet_offset Ar offset
1193 to the offset of the start of the quiet interval from the TBTT
1194 specified by the Quiet count, expressed in TUs.
1197 shall be less than one beacon interval.
1198 .It Cm quiet_duration Ar dur
1201 to the duration of the Quiet interval, expressed in TUs.
1202 The value should be less than beacon interval.
1204 Enable the use of Atheros Dynamic Turbo mode when communicating with
1205 another Dynamic Turbo-capable station.
1206 Dynamic Turbo mode is an Atheros-specific mechanism by which
1207 stations switch between normal 802.11 operation and a ``boosted''
1208 mode in which a 40MHz wide channel is used for communication.
1209 Stations using Dynamic Turbo mode operate boosted only when the
1210 channel is free of non-dturbo stations; when a non-dturbo station
1211 is identified on the channel all stations will automatically drop
1212 back to normal operation.
1213 By default, Dynamic Turbo mode is not enabled, even if the device is capable.
1214 Note that turbo mode (dynamic or static) is only allowed on some
1215 channels depending on the regulatory constraints; use the
1217 command to identify the channels where turbo mode may be used.
1218 To disable Dynamic Turbo mode use
1221 Enable Dynamic WDS (DWDS) support.
1222 DWDS is a facility by which 4-address traffic can be carried between
1223 stations operating in infrastructure mode.
1224 A station first associates to an access point and authenticates using
1225 normal procedures (e.g., WPA).
1226 Then 4-address frames are passed to carry traffic for stations
1227 operating on either side of the wireless link.
1228 DWDS extends the normal WDS mechanism by leveraging existing security
1229 protocols and eliminating static binding.
1231 When DWDS is enabled on an access point 4-address frames received from
1232 an authorized station will generate a ``DWDS discovery'' event to user
1234 This event should be used to create a WDS interface that is bound
1235 to the remote station (and usually plumbed into a bridge).
1236 Once the WDS interface is up and running 4-address traffic then logically
1237 flows through that interface.
1239 When DWDS is enabled on a station, traffic with a destination address
1240 different from the peer station are encapsulated in a 4-address frame
1241 and transmitted to the peer.
1242 All 4-address traffic uses the security information of the stations
1243 (e.g., cryptographic keys).
1244 A station is associated using 802.11n facilities may transport
1245 4-address traffic using these same mechanisms; this depends on available
1246 resources and capabilities of the device.
1247 The DWDS implementation guards against layer 2 routing loops of
1250 Enable the use of Atheros Fast Frames when communicating with
1251 another Fast Frames-capable station.
1252 Fast Frames are an encapsulation technique by which two 802.3
1253 frames are transmitted in a single 802.11 frame.
1254 This can noticeably improve throughput but requires that the
1255 receiving station understand how to decapsulate the frame.
1256 Fast frame use is negotiated using the Atheros 802.11 vendor-specific
1257 protocol extension so enabling use is safe when communicating with
1258 non-Atheros devices.
1259 By default, use of fast frames is enabled if the device is capable.
1260 To explicitly disable fast frames, use
1262 .It Cm fragthreshold Ar length
1263 Set the threshold for which transmitted frames are broken into fragments.
1266 argument is the frame size in bytes and must be in the range 256 to 2346.
1274 disables transmit fragmentation.
1275 Not all adapters honor the fragmentation threshold.
1277 When operating as an access point, do not broadcast the SSID
1278 in beacon frames or respond to probe request frames unless
1279 they are directed to the ap (i.e., they include the ap's SSID).
1280 By default, the SSID is included in beacon frames and
1281 undirected probe request frames are answered.
1282 To re-enable the broadcast of the SSID etc., use
1285 Enable use of High Throughput (HT) when using 802.11n (default).
1286 The 802.11n specification includes mechanisms for operation
1287 on 20MHz and 40MHz wide channels using different signalling mechanisms
1288 than specified in 802.11b, 802.11g, and 802.11a.
1289 Stations negotiate use of these facilities, termed HT20 and HT40,
1290 when they associate.
1291 To disable all use of 802.11n use
1293 To disable use of HT20 (e.g., to force only HT40 use) use
1295 To disable use of HT40 use
1298 HT configuration is used to ``auto promote'' operation
1299 when several choices are available.
1300 For example, if a station associates to an 11n-capable access point
1301 it controls whether the station uses legacy operation, HT20, or HT40.
1302 When an 11n-capable device is setup as an access point and
1303 Auto Channel Selection is used to locate a channel to operate on,
1304 HT configuration controls whether legacy, HT20, or HT40 operation is setup
1305 on the selected channel.
1306 If a fixed channel is specified for a station then HT configuration can
1307 be given as part of the channel specification; e.g., 6:ht/20 to setup
1308 HT20 operation on channel 6.
1310 Enable use of compatibility support for pre-802.11n devices (default).
1311 The 802.11n protocol specification went through several incompatible iterations.
1312 Some vendors implemented 11n support to older specifications that
1313 will not interoperate with a purely 11n-compliant station.
1314 In particular the information elements included in management frames
1315 for old devices are different.
1316 When compatibility support is enabled both standard and compatible data
1318 Stations that associate using the compatibility mechanisms are flagged
1320 To disable compatibility support use
1322 .It Cm htprotmode Ar technique
1323 For interfaces operating in 802.11n, use the specified
1325 for protecting HT frames in a mixed legacy/HT network.
1326 The set of valid techniques is
1331 Technique names are case insensitive.
1333 Enable inactivity processing for stations associated to an
1334 access point (default).
1335 When operating as an access point the 802.11 layer monitors
1336 the activity of each associated station.
1337 When a station is inactive for 5 minutes it will send several
1338 ``probe frames'' to see if the station is still present.
1339 If no response is received then the station is deauthenticated.
1340 Applications that prefer to handle this work can disable this
1344 Set the location to use in calculating regulatory constraints.
1345 The location is also advertised in beacon and probe response frames
1346 when 802.11d is enabled with
1355 Display the list of channels available for use taking into account
1356 any restrictions set with the
1359 See the description of
1361 for more information.
1363 Display the adaptor's capabilities, including the operating
1366 Display the list of channels available for use.
1367 Channels are shown with their IEEE channel number, equivalent
1368 frequency, and usage modes.
1369 Channels identified as
1374 Channels identified as
1376 may be used only for Atheros' Static Turbo mode
1378 . Cm mediaopt turbo ) .
1379 Channels marked with a
1381 have a regulatory constraint that they be passively scanned.
1382 This means a station is not permitted to transmit on the channel until
1383 it identifies the channel is being used for 802.11 communication;
1384 typically by hearing a beacon frame from an access point operating
1387 is another way of requesting this information.
1388 By default a compacted list of channels is displayed; if the
1390 option is specified then all channels are shown.
1391 .It Cm list countries
1392 Display the set of country codes and regulatory domains that can be
1393 used in regulatory configuration.
1395 Display the current MAC Access Control List state.
1396 Each address is prefixed with a character that indicates the
1397 current policy applied to it:
1399 indicates the address is allowed access,
1401 indicates the address is denied access,
1403 indicates the address is present but the current policy open
1404 (so the ACL is not consulted).
1406 Displays the mesh routing table, used for forwarding packets on a mesh
1408 .It Cm list regdomain
1409 Display the current regulatory settings including the available channels
1410 and transmit power caps.
1412 Display the parameters that govern roaming operation.
1414 Display the parameters that govern transmit operation.
1416 Display the transmit power caps for each channel.
1418 Display the access points and/or ad-hoc neighbors
1419 located in the vicinity.
1420 This information may be updated automatically by the adapter
1423 request or through background scanning.
1424 Depending on the capabilities of the stations the following
1425 flags can be included in the output:
1429 Indicates that the station is permitted to send/receive data frames.
1431 Extended Rate Phy (ERP).
1432 Indicates that the station is operating in an 802.11g network
1433 using extended transmit rates.
1435 High Throughput (HT).
1436 Indicates that the station is using HT transmit rates.
1437 If a `+' follows immediately after then the station associated
1438 using deprecated mechanisms supported only when
1443 Indicates that the station is operating in power save mode.
1445 Quality of Service (QoS).
1446 Indicates that the station is using QoS encapsulation for
1448 QoS encapsulation is enabled only when WME mode is enabled.
1451 Indicates that the station is doing short preamble to optionally
1452 improve throughput performance with 802.11g and 802.11b.
1454 Transitional Security Network (TSN).
1455 Indicates that the station associated using TSN; see also
1459 Wi-Fi Protected Setup (WPS).
1460 Indicates that the station associated using WPS.
1463 By default interesting information elements captured from the neighboring
1464 stations are displayed at the end of each row.
1465 Possible elements include:
1467 (station supports WME),
1469 (station supports WPA),
1471 (station supports WPS),
1473 (station supports 802.11i/RSN),
1475 (station supports 802.11n/HT communication),
1477 (station supports Atheros protocol extensions),
1479 (station supports unknown vendor-specific extensions).
1482 flag is used all the information elements and their
1483 contents will be shown.
1486 flag also enables display of long SSIDs.
1489 command is another way of requesting this information.
1491 When operating as an access point display the stations that are
1492 currently associated.
1493 When operating in ad-hoc mode display stations identified as
1494 neighbors in the IBSS.
1495 When operating in mesh mode display stations identified as
1496 neighbors in the MBSS.
1497 When operating in station mode display the access point.
1498 Capabilities advertised by the stations are described under
1502 Depending on the capabilities of the stations the following
1503 flags can be included in the output:
1507 Indicates that the station is permitted to send/receive data frames.
1509 Extended Rate Phy (ERP).
1510 Indicates that the station is operating in an 802.11g network
1511 using extended transmit rates.
1513 High Throughput (HT).
1514 Indicates that the station is using HT transmit rates.
1515 If a `+' follows immediately after then the station associated
1516 using deprecated mechanisms supported only when
1521 Indicates that the station is operating in power save mode.
1523 Quality of Service (QoS).
1524 Indicates that the station is using QoS encapsulation for
1526 QoS encapsulation is enabled only when WME mode is enabled.
1529 Indicates that the station is doing short preamble to optionally
1530 improve throughput performance with 802.11g and 802.11b.
1532 Transitional Security Network (TSN).
1533 Indicates that the station associated using TSN; see also
1537 Wi-Fi Protected Setup (WPS).
1538 Indicates that the station associated using WPS.
1541 By default information elements received from associated stations
1542 are displayed in a short form; the
1544 flag causes this information to be displayed symbolically.
1546 Display the current channel parameters to use when operating in WME mode.
1549 option is specified then both channel and BSS parameters are displayed
1550 for each AC (first channel, then BSS).
1551 When WME mode is enabled for an adaptor this information will be
1552 displayed with the regular status; this command is mostly useful
1553 for examining parameters when WME mode is disabled.
1554 See the description of the
1556 directive for information on the various parameters.
1557 .It Cm maxretry Ar count
1558 Set the maximum number of tries to use in sending unicast frames.
1559 The default setting is 6 but drivers may override this with a value
1561 .It Cm mcastrate Ar rate
1562 Set the rate for transmitting multicast/broadcast frames.
1563 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1564 This rate should be valid for the current operating conditions;
1565 if an invalid rate is specified drivers are free to chose an
1567 .It Cm mgtrate Ar rate
1568 Set the rate for transmitting management and/or control frames.
1569 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1571 Set the location to use in calculating regulatory constraints.
1572 The location is also advertised in beacon and probe response frames
1573 when 802.11d is enabled with
1582 Enable powersave operation.
1583 When operating as a client, the station will conserve power by
1584 periodically turning off the radio and listening for
1585 messages from the access point telling it there are packets waiting.
1586 The station must then retrieve the packets.
1587 Not all devices support power save operation as a client.
1588 The 802.11 specification requires that all access points support
1589 power save but some drivers do not.
1592 to disable powersave operation when operating as a client.
1593 .It Cm powersavesleep Ar sleep
1594 Set the desired max powersave sleep time in TU's (1024 usecs).
1595 By default the max powersave sleep time is 100 TU's.
1596 .It Cm protmode Ar technique
1597 For interfaces operating in 802.11g, use the specified
1599 for protecting OFDM frames in a mixed 11b/11g network.
1600 The set of valid techniques is
1606 Technique names are case insensitive.
1607 Not all devices support
1609 as a protection technique.
1611 When operating as an access point in 802.11g mode allow only
1612 11g-capable stations to associate (11b-only stations are not
1613 permitted to associate).
1614 To allow both 11g and 11b-only stations to associate, use
1617 When operating as an access point in 802.11n mode allow only
1618 HT-capable stations to associate (legacy stations are not
1619 permitted to associate).
1620 To allow both HT and legacy stations to associate, use
1622 .It Cm regdomain Ar sku
1623 Set the regulatory domain to use in calculating the regulatory constraints
1625 In particular the set of available channels, how the wireless device
1626 will operation on the channels, and the maximum transmit power that
1627 can be used on a channel are defined by this setting.
1628 Regdomain codes (SKU's) are taken from
1629 .Pa /etc/regdomain.xml
1631 be viewed with the ``list countries'' request.
1632 Note that not all devices support changing the regdomain from a default
1633 setting; typically stored in EEPROM.
1641 Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n
1643 Note that RIFS must be supported by both the station and access point
1647 .It Cm roam:rate Ar rate
1648 Set the threshold for controlling roaming when operating in a BSS.
1651 parameter specifies the transmit rate in megabits
1652 at which roaming should be considered.
1653 If the current transmit rate drops below this setting and background scanning
1654 is enabled, then the system will check if a more desirable access point is
1655 available and switch over to it.
1656 The current scan cache contents are used if they are considered
1657 valid according to the
1659 parameter; otherwise a background scan operation is triggered before
1660 any selection occurs.
1661 Each channel type has a separate rate threshold; the default values are:
1662 12 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng).
1663 .It Cm roam:rssi Ar rssi
1664 Set the threshold for controlling roaming when operating in a BSS.
1667 parameter specifies the receive signal strength in dBm units
1668 at which roaming should be considered.
1669 If the current rssi drops below this setting and background scanning
1670 is enabled, then the system will check if a more desirable access point is
1671 available and switch over to it.
1672 The current scan cache contents are used if they are considered
1673 valid according to the
1675 parameter; otherwise a background scan operation is triggered before
1676 any selection occurs.
1677 Each channel type has a separate rssi threshold; the default values are
1679 .It Cm roaming Ar mode
1680 When operating as a station, control how the system will
1681 behave when communication with the current access point
1685 argument may be one of
1687 (leave it to the hardware device to decide),
1689 (handle either in the device or the operating system\[em]as appropriate),
1691 (do nothing until explicitly instructed).
1692 By default, the device is left to handle this if it is
1693 capable; otherwise, the operating system will automatically
1694 attempt to reestablish communication.
1695 Manual mode is used by applications such as
1696 .Xr wpa_supplicant 8
1697 that want to control the selection of an access point.
1698 .It Cm rtsthreshold Ar length
1699 Set the threshold for which
1700 transmitted frames are preceded by transmission of an
1706 is the frame size in bytes and must be in the range 1 to 2346.
1714 disables transmission of RTS frames.
1715 Not all adapters support setting the RTS threshold.
1717 Initiate a scan of neighboring stations, wait for it to complete, and
1718 display all stations found.
1719 Only the super-user can initiate a scan.
1722 for information on the display.
1723 By default a background scan is done; otherwise a foreground
1724 scan is done and the station may roam to a different access point.
1727 request can be used to show recent scan results without
1728 initiating a new scan.
1729 .It Cm scanvalid Ar threshold
1730 Set the maximum time the scan cache contents are considered valid;
1731 i.e., will be used without first triggering a scan operation to
1735 parameter is specified in seconds and defaults to 60 seconds.
1736 The minimum setting for
1739 One should take care setting this threshold; if it is set too low
1740 then attempts to roam to another access point may trigger unnecessary
1741 background scan operations.
1743 Enable use of Short Guard Interval when operating in 802.11n
1745 NB: this currently enables Short GI on both HT40 and HT20 channels.
1746 To disable Short GI use
1749 Enable use of Static Spatial Multiplexing Power Save (SMPS)
1750 when operating in 802.11n.
1751 A station operating with Static SMPS maintains only a single
1752 receive chain active (this can significantly reduce power consumption).
1756 Enable use of Dynamic Spatial Multiplexing Power Save (SMPS)
1757 when operating in 802.11n.
1758 A station operating with Dynamic SMPS maintains only a single
1759 receive chain active but switches to multiple receive chains when it
1760 receives an RTS frame (this can significantly reduce power consumption).
1761 Note that stations cannot distinguish between RTS/CTS intended to
1762 enable multiple receive chains and those used for other purposes.
1766 Set the desired Service Set Identifier (aka network name).
1767 The SSID is a string up to 32 characters
1768 in length and may be specified as either a normal string or in
1769 hexadecimal when preceded by
1771 Additionally, the SSID may be cleared by setting it to
1773 .It Cm tdmaslot Ar slot
1774 When operating with TDMA, use the specified
1779 is a number between 0 and the maximum number of slots in the BSS.
1780 Note that a station configured as slot 0 is a master and
1781 will broadcast beacon frames advertising the BSS;
1782 stations configured to use other slots will always
1783 scan to locate a master before they ever transmit.
1787 .It Cm tdmaslotcnt Ar cnt
1788 When operating with TDMA, setup a BSS with
1791 The slot count may be at most 8.
1792 The current implementation is only tested with two stations
1793 (i.e., point to point applications).
1794 This setting is only meaningful when a station is configured as slot 0;
1795 other stations adopt this setting from the BSS they join.
1799 .It Cm tdmaslotlen Ar len
1800 When operating with TDMA, setup a BSS such that each station has a slot
1803 The slot length must be at least 150 microseconds (1/8 TU)
1804 and no more than 65 milliseconds.
1805 Note that setting too small a slot length may result in poor channel
1806 bandwidth utilization due to factors such as timer granularity and
1808 This setting is only meaningful when a station is configured as slot 0;
1809 other stations adopt this setting from the BSS they join.
1812 is set to 10 milliseconds.
1813 .It Cm tdmabintval Ar intval
1814 When operating with TDMA, setup a BSS such that beacons are transmitted every
1816 superframes to synchronize the TDMA slot timing.
1817 A superframe is defined as the number of slots times the slot length; e.g.,
1818 a BSS with two slots of 10 milliseconds has a 20 millisecond superframe.
1819 The beacon interval may not be zero.
1822 causes the timers to be resynchronized more often; this can be help if
1823 significant timer drift is observed.
1828 When operating as an access point with WPA/802.11i allow legacy
1829 stations to associate using static key WEP and open authentication.
1830 To disallow legacy station use of WEP, use
1832 .It Cm txpower Ar power
1833 Set the power used to transmit frames.
1836 argument is specified in .5 dBm units.
1837 Out of range values are truncated.
1838 Typically only a few discreet power settings are available and
1839 the driver will use the setting closest to the specified value.
1840 Not all adapters support changing the transmit power.
1841 .It Cm ucastrate Ar rate
1842 Set a fixed rate for transmitting unicast frames.
1843 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1844 This rate should be valid for the current operating conditions;
1845 if an invalid rate is specified drivers are free to chose an
1847 .It Cm wepmode Ar mode
1848 Set the desired WEP mode.
1849 Not all adapters support all modes.
1850 The set of valid modes is
1856 mode explicitly tells the adaptor to allow association with access
1857 points which allow both encrypted and unencrypted traffic.
1860 means that the access point must only allow encrypted connections.
1863 is generally another name for
1865 Modes are case insensitive.
1866 .It Cm weptxkey Ar index
1867 Set the WEP key to be used for transmission.
1868 This is the same as setting the default transmission key with
1870 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
1871 Set the selected WEP key.
1874 is not given, key 1 is set.
1875 A WEP key will be either 5 or 13
1876 characters (40 or 104 bits) depending on the local network and the
1877 capabilities of the adaptor.
1878 It may be specified either as a plain
1879 string or as a string of hexadecimal digits preceded by
1881 For maximum portability, hex keys are recommended;
1882 the mapping of text keys to WEP encryption is usually driver-specific.
1885 drivers do this mapping differently to
1887 A key may be cleared by setting it to
1889 If WEP is supported then there are at least four keys.
1890 Some adapters support more than four keys.
1891 If that is the case, then the first four keys
1892 (1-4) will be the standard temporary keys and any others will be adaptor
1893 specific keys such as permanent keys stored in NVRAM.
1895 Note that you must set a default transmit key with
1897 for the system to know which key to use in encrypting outbound traffic.
1899 Enable Wireless Multimedia Extensions (WME) support, if available,
1900 for the specified interface.
1901 WME is a subset of the IEEE 802.11e standard to support the
1902 efficient communication of realtime and multimedia data.
1903 To disable WME support, use
1905 Another name for this parameter is
1908 The following parameters are meaningful only when WME support is in use.
1909 Parameters are specified per-AC (Access Category) and
1910 split into those that are used by a station when acting
1911 as an access point and those for client stations in the BSS.
1912 The latter are received from the access point and may not be changed
1914 The following Access Categories are recognized:
1916 .Bl -tag -width ".Cm AC_BK" -compact
1920 best effort delivery,
1935 AC parameters are case-insensitive.
1936 Traffic classification is done in the operating system using the
1937 vlan priority associated with data frames or the
1938 ToS (Type of Service) indication in IP-encapsulated frames.
1939 If neither information is present, traffic is assigned to the
1940 Best Effort (BE) category.
1941 .Bl -tag -width indent
1943 Set the ACK policy for QoS transmissions by the local station;
1944 this controls whether or not data frames transmitted by a station
1945 require an ACK response from the receiving station.
1946 To disable waiting for an ACK use
1948 This parameter is applied only to the local station.
1950 Enable the Admission Control Mandatory (ACM) mechanism
1951 for transmissions by the local station.
1952 To disable the ACM use
1954 On stations in a BSS this parameter is read-only and indicates
1955 the setting received from the access point.
1956 NB: ACM is not supported right now.
1957 .It Cm aifs Ar ac Ar count
1958 Set the Arbitration Inter Frame Spacing (AIFS)
1959 channel access parameter to use for transmissions
1960 by the local station.
1961 On stations in a BSS this parameter is read-only and indicates
1962 the setting received from the access point.
1963 .It Cm cwmin Ar ac Ar count
1964 Set the CWmin channel access parameter to use for transmissions
1965 by the local station.
1966 On stations in a BSS this parameter is read-only and indicates
1967 the setting received from the access point.
1968 .It Cm cwmax Ar ac Ar count
1969 Set the CWmax channel access parameter to use for transmissions
1970 by the local station.
1971 On stations in a BSS this parameter is read-only and indicates
1972 the setting received from the access point.
1973 .It Cm txoplimit Ar ac Ar limit
1974 Set the Transmission Opportunity Limit channel access parameter
1975 to use for transmissions by the local station.
1976 This parameter defines an interval of time when a WME station
1977 has the right to initiate transmissions onto the wireless medium.
1978 On stations in a BSS this parameter is read-only and indicates
1979 the setting received from the access point.
1980 .It Cm bss:aifs Ar ac Ar count
1981 Set the AIFS channel access parameter to send to stations in a BSS.
1982 This parameter is meaningful only when operating in ap mode.
1983 .It Cm bss:cwmin Ar ac Ar count
1984 Set the CWmin channel access parameter to send to stations in a BSS.
1985 This parameter is meaningful only when operating in ap mode.
1986 .It Cm bss:cwmax Ar ac Ar count
1987 Set the CWmax channel access parameter to send to stations in a BSS.
1988 This parameter is meaningful only when operating in ap mode.
1989 .It Cm bss:txoplimit Ar ac Ar limit
1990 Set the TxOpLimit channel access parameter to send to stations in a BSS.
1991 This parameter is meaningful only when operating in ap mode.
1994 Enable Wireless Privacy Subscriber support.
1995 Note that WPS support requires a WPS-capable supplicant.
1996 To disable this function use
2000 The following parameters support an optional access control list
2001 feature available with some adapters when operating in ap mode; see
2003 This facility allows an access point to accept/deny association
2004 requests based on the MAC address of the station.
2005 Note that this feature does not significantly enhance security
2006 as MAC address spoofing is easy to do.
2007 .Bl -tag -width indent
2008 .It Cm mac:add Ar address
2009 Add the specified MAC address to the database.
2010 Depending on the policy setting association requests from the
2011 specified station will be allowed or denied.
2013 Set the ACL policy to permit association only by
2014 stations registered in the database.
2015 .It Cm mac:del Ar address
2016 Delete the specified MAC address from the database.
2018 Set the ACL policy to deny association only by
2019 stations registered in the database.
2020 .It Cm mac:kick Ar address
2021 Force the specified station to be deauthenticated.
2022 This typically is done to block a station after updating the
2025 Set the ACL policy to allow all stations to associate.
2027 Delete all entries in the database.
2029 Set the ACL policy to permit association only by
2030 stations approved by a RADIUS server.
2031 Note that this feature requires the
2033 program be configured to do the right thing
2034 as it handles the RADIUS processing
2035 (and marks stations as authorized).
2038 The following parameters are related to a wireless interface operating in mesh
2040 .Bl -tag -width indent
2041 .It Cm meshid Ar meshid
2042 Set the desired Mesh Identifier.
2043 The Mesh ID is a string up to 32 characters in length.
2044 A mesh interface must have a Mesh Identifier specified
2045 to reach an operational state.
2046 .It Cm meshttl Ar ttl
2047 Set the desired ``time to live'' for mesh forwarded packets;
2048 this is the number of hops a packet may be forwarded before
2050 The default setting for
2054 Enable or disable peering with neighbor mesh stations.
2055 Stations must peer before any data packets can be exchanged.
2060 Enable or disable forwarding packets by a mesh interface.
2065 This attribute specifies whether or not the mesh STA activates mesh gate
2070 .It Cm meshmetric Ar protocol
2073 as the link metric protocol used on a mesh network.
2074 The default protocol is called
2076 The mesh interface will restart after changing this setting.
2077 .It Cm meshpath Ar protocol
2080 as the path selection protocol used on a mesh network.
2081 The only available protocol at the moment is called
2083 (Hybrid Wireless Mesh Protocol).
2084 The mesh interface will restart after changing this setting.
2085 .It Cm hwmprootmode Ar mode
2086 Stations on a mesh network can operate as ``root nodes.''
2087 Root nodes try to find paths to all mesh nodes and advertise themselves
2089 When there is a root mesh node on a network, other mesh nodes can setup
2090 paths between themselves faster because they can use the root node
2091 to find the destination.
2092 This path may not be the best, but on-demand
2093 routing will eventually find the best path.
2094 The following modes are recognized:
2096 .Bl -tag -width ".Cm PROACTIVE" -compact
2100 Send broadcast path requests every two seconds.
2101 Nodes on the mesh without a path to this root mesh station with try to
2102 discover a path to us.
2104 Send broadcast path requests every two seconds and every node must reply
2105 with a path reply even if it already has a path to this root mesh station.
2107 Send broadcast root announcement (RANN) frames.
2108 Nodes on the mesh without a path to this root mesh station with try to
2109 discover a path to us.
2115 .It Cm hwmpmaxhops Ar cnt
2116 Set the maximum number of hops allowed in an HMWP path to
2118 The default setting for
2123 The following parameters are for compatibility with other systems:
2124 .Bl -tag -width indent
2126 Another name for the
2132 .It Cm stationname Ar name
2133 Set the name of this station.
2134 The station name is not part of the IEEE 802.11
2135 protocol though some interfaces support it.
2137 seems to be meaningful to identical or virtually identical equipment.
2138 Setting the station name is identical in syntax to setting the SSID.
2145 Another way of saying
2151 Another way of saying
2157 Another way of saying:
2158 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
2164 .Ar n : k1 , k2 , k3 , k4
2167 Another way of saying
2168 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
2173 Another way of saying
2180 The following parameters are specific to bridge interfaces:
2181 .Bl -tag -width indent
2182 .It Cm addm Ar interface
2183 Add the interface named by
2185 as a member of the bridge.
2186 The interface is put into promiscuous mode
2187 so that it can receive every packet sent on the network.
2188 .It Cm deletem Ar interface
2189 Remove the interface named by
2192 Promiscuous mode is disabled on the interface when
2193 it is removed from the bridge.
2194 .It Cm maxaddr Ar size
2195 Set the size of the bridge address cache to
2197 The default is 2000 entries.
2198 .It Cm timeout Ar seconds
2199 Set the timeout of address cache entries to
2204 is zero, then address cache entries will not be expired.
2205 The default is 1200 seconds.
2207 Display the addresses that have been learned by the bridge.
2208 .It Cm static Ar interface-name Ar address
2209 Add a static entry into the address cache pointing to
2210 .Ar interface-name .
2211 Static entries are never aged out of the cache or re-placed, even if the
2212 address is seen on a different interface.
2213 .It Cm deladdr Ar address
2216 from the address cache.
2218 Delete all dynamically-learned addresses from the address cache.
2220 Delete all addresses, including static addresses, from the address cache.
2221 .It Cm discover Ar interface
2222 Mark an interface as a
2225 When the bridge has no address cache entry
2226 (either dynamic or static)
2227 for the destination address of a packet,
2228 the bridge will forward the packet to all
2229 member interfaces marked as
2231 This is the default for all interfaces added to a bridge.
2232 .It Cm -discover Ar interface
2235 attribute on a member interface.
2236 For packets without the
2238 attribute, the only packets forwarded on the interface are broadcast
2239 or multicast packets and packets for which the destination address
2240 is known to be on the interface's segment.
2241 .It Cm learn Ar interface
2242 Mark an interface as a
2245 When a packet arrives on such an interface, the source
2246 address of the packet is entered into the address cache as being a
2247 destination address on the interface's segment.
2248 This is the default for all interfaces added to a bridge.
2249 .It Cm -learn Ar interface
2252 attribute on a member interface.
2253 .It Cm sticky Ar interface
2254 Mark an interface as a
2257 Dynamically learned address entries are treated at static once entered into
2259 Sticky entries are never aged out of the cache or replaced, even if the
2260 address is seen on a different interface.
2261 .It Cm -sticky Ar interface
2264 attribute on a member interface.
2265 .It Cm private Ar interface
2266 Mark an interface as a
2269 A private interface does not forward any traffic to any other port that is also
2270 a private interface.
2271 .It Cm -private Ar interface
2274 attribute on a member interface.
2275 .It Cm span Ar interface
2276 Add the interface named by
2278 as a span port on the bridge.
2279 Span ports transmit a copy of every frame received by the bridge.
2280 This is most useful for snooping a bridged network passively on
2281 another host connected to one of the span ports of the bridge.
2282 .It Cm -span Ar interface
2283 Delete the interface named by
2285 from the list of span ports of the bridge.
2286 .It Cm stp Ar interface
2287 Enable Spanning Tree protocol on
2291 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
2292 Spanning Tree is used to detect and remove loops in a network topology.
2293 .It Cm -stp Ar interface
2294 Disable Spanning Tree protocol on
2296 This is the default for all interfaces added to a bridge.
2297 .It Cm edge Ar interface
2301 An edge port connects directly to end stations cannot create bridging
2302 loops in the network, this allows it to transition straight to forwarding.
2303 .It Cm -edge Ar interface
2304 Disable edge status on
2306 .It Cm autoedge Ar interface
2309 to automatically detect edge status.
2310 This is the default for all interfaces added to a bridge.
2311 .It Cm -autoedge Ar interface
2312 Disable automatic edge status on
2314 .It Cm ptp Ar interface
2317 as a point to point link.
2318 This is required for straight transitions to forwarding and
2319 should be enabled on a direct link to another RSTP capable switch.
2320 .It Cm -ptp Ar interface
2321 Disable point to point link status on
2323 This should be disabled for a half duplex link and for an interface
2324 connected to a shared network segment,
2325 like a hub or a wireless network.
2326 .It Cm autoptp Ar interface
2327 Automatically detect the point to point status on
2329 by checking the full duplex link status.
2330 This is the default for interfaces added to the bridge.
2331 .It Cm -autoptp Ar interface
2332 Disable automatic point to point link detection on
2334 .It Cm maxage Ar seconds
2335 Set the time that a Spanning Tree protocol configuration is valid.
2336 The default is 20 seconds.
2337 The minimum is 6 seconds and the maximum is 40 seconds.
2338 .It Cm fwddelay Ar seconds
2339 Set the time that must pass before an interface begins forwarding
2340 packets when Spanning Tree is enabled.
2341 The default is 15 seconds.
2342 The minimum is 4 seconds and the maximum is 30 seconds.
2343 .It Cm hellotime Ar seconds
2344 Set the time between broadcasting of Spanning Tree protocol
2345 configuration messages.
2346 The hello time may only be changed when operating in legacy stp mode.
2347 The default is 2 seconds.
2348 The minimum is 1 second and the maximum is 2 seconds.
2349 .It Cm priority Ar value
2350 Set the bridge priority for Spanning Tree.
2351 The default is 32768.
2352 The minimum is 0 and the maximum is 61440.
2353 .It Cm proto Ar value
2354 Set the Spanning Tree protocol.
2355 The default is rstp.
2356 The available options are stp and rstp.
2357 .It Cm holdcnt Ar value
2358 Set the transmit hold count for Spanning Tree.
2359 This is the number of packets transmitted before being rate limited.
2361 The minimum is 1 and the maximum is 10.
2362 .It Cm ifpriority Ar interface Ar value
2363 Set the Spanning Tree priority of
2368 The minimum is 0 and the maximum is 240.
2369 .It Cm ifpathcost Ar interface Ar value
2370 Set the Spanning Tree path cost of
2374 The default is calculated from the link speed.
2375 To change a previously selected path cost back to automatic, set the
2377 The minimum is 1 and the maximum is 200000000.
2378 .It Cm ifmaxaddr Ar interface Ar size
2379 Set the maximum number of hosts allowed from an interface, packets with unknown
2380 source addresses are dropped until an existing host cache entry expires or is
2382 Set to 0 to disable.
2385 The following parameters are specific to lagg interfaces:
2386 .Bl -tag -width indent
2387 .It Cm laggport Ar interface
2388 Add the interface named by
2390 as a port of the aggregation interface.
2391 .It Cm -laggport Ar interface
2392 Remove the interface named by
2394 from the aggregation interface.
2395 .It Cm laggproto Ar proto
2396 Set the aggregation protocol.
2397 The default is failover.
2398 The available options are failover, fec, lacp, loadbalance, roundrobin and
2400 .It Cm lagghash Ar option Ns Oo , Ns Ar option Oc
2401 Set the packet layers to hash for aggregation protocols which load balance.
2404 The options can be combined using commas.
2406 .Bl -tag -width ".Cm l2" -compact
2408 src/dst mac address and optional vlan number.
2410 src/dst address for IPv4 or IPv6.
2412 src/dst port for TCP/UDP/SCTP.
2417 The following parameters are specific to IP tunnel interfaces,
2419 .Bl -tag -width indent
2420 .It Cm tunnel Ar src_addr dest_addr
2421 Configure the physical source and destination address for IP tunnel
2427 are interpreted as the outer source/destination for the encapsulating
2430 Unconfigure the physical source and destination address for IP tunnel
2431 interfaces previously configured with
2434 Another name for the
2437 .It Cm accept_rev_ethip_ver
2438 Set a flag to accept both correct EtherIP packets and ones
2439 with reversed version field.
2441 This is for backward compatibility with
2443 6.2, 6.3, 7.0, and 7.1.
2444 .It Cm -accept_rev_ethip_ver
2446 .Cm accept_rev_ethip_ver .
2447 .It Cm send_rev_ethip_ver
2448 Set a flag to send EtherIP packets with reversed version
2449 field intentionally.
2450 Disabled by default.
2451 This is for backward compatibility with
2453 6.2, 6.3, 7.0, and 7.1.
2454 .It Cm -send_rev_ethip_ver
2456 .Cm send_rev_ethip_ver .
2459 The following parameters are specific to GRE tunnel interfaces,
2461 .Bl -tag -width indent
2462 .It Cm grekey Ar key
2463 Configure the GRE key to be used for outgoing packets.
2465 .Xr gre 4 will always accept GRE packets with invalid or absent keys.
2466 This command will result in a four byte MTU reduction on the interface.
2469 The following parameters are specific to
2472 .Bl -tag -width indent
2473 .It Cm syncdev Ar iface
2474 Use the specified interface
2475 to send and receive pfsync state synchronisation messages.
2477 Stop sending pfsync state synchronisation messages over the network.
2478 .It Cm syncpeer Ar peer_address
2479 Make the pfsync link point-to-point rather than using
2480 multicast to broadcast the state synchronisation messages.
2481 The peer_address is the IP address of the other host taking part in
2484 Broadcast the packets using multicast.
2486 Set the maximum number of updates for a single state which
2487 can be collapsed into one.
2488 This is an 8-bit number; the default value is 128.
2490 Defer transmission of the first packet in a state until a peer has
2491 acknowledged that the associated state has been inserted.
2493 Do not defer the first packet in a state.
2494 This is the default.
2497 The following parameters are specific to
2500 .Bl -tag -width indent
2501 .It Cm vlan Ar vlan_tag
2502 Set the VLAN tag value to
2504 This value is a 12-bit VLAN Identifier (VID) which is used to create an 802.1Q
2505 VLAN header for packets sent from the
2512 must both be set at the same time.
2513 .It Cm vlandev Ar iface
2514 Associate the physical interface
2519 Packets transmitted through the
2522 diverted to the specified physical interface
2524 with 802.1Q VLAN encapsulation.
2525 Packets with 802.1Q encapsulation received
2526 by the parent interface with the correct VLAN Identifier will be diverted to
2532 interface is assigned a
2533 copy of the parent interface's flags and the parent's Ethernet address.
2538 must both be set at the same time.
2541 interface already has
2542 a physical interface associated with it, this command will fail.
2544 change the association to another physical interface, the existing
2545 association must be cleared first.
2547 Note: if the hardware tagging capability
2548 is set on the parent interface, the
2551 interface's behavior changes:
2554 interface recognizes that the
2555 parent interface supports insertion and extraction of VLAN tags on its
2556 own (usually in firmware) and that it should pass packets to and from
2557 the parent unaltered.
2558 .It Fl vlandev Op Ar iface
2561 pseudo device, disassociate the parent interface from it.
2562 This breaks the link between the
2564 interface and its parent,
2565 clears its VLAN Identifier, flags and its link address and shuts the interface
2569 argument is useless and hence deprecated.
2572 The following parameters are used to configure
2574 protocol on an interface:
2575 .Bl -tag -width indent
2577 Set the virtual host ID.
2578 This is a required setting to initiate
2580 If the virtual host ID does not exist yet, it is created and attached to the
2581 interface, otherwise configuration of an existing vhid is adjusted.
2584 keyword is supplied along with an
2588 address, then this address is configured to be run under control of the
2590 Whenever a last address that refers to a particular vhid is removed from an
2591 interface, the vhid is automatically removed from interface and destroyed.
2592 Any other configuration parameters for the
2594 protocol should be supplied along with the
2597 Acceptable values for vhid are 1 to 255.
2598 .It Cm advbase Ar seconds
2599 Specifies the base of the advertisement interval in seconds.
2600 The acceptable values are 1 to 255.
2601 The default value is 1.
2602 .It Cm advskew Ar interval
2603 Specifies the skew to add to the base advertisement interval to
2604 make one host advertise slower than another host.
2605 It is specified in 1/256 of seconds.
2606 The acceptable values are 1 to 254.
2607 The default value is 0.
2608 .It Cm pass Ar phrase
2609 Set the authentication key to
2611 .It Cm state Ar MASTER|BACKUP
2612 Forcibly change state of a given vhid.
2617 utility displays the current configuration for a network interface
2618 when no optional parameters are supplied.
2619 If a protocol family is specified,
2621 will report only the details specific to that protocol family.
2625 flag is passed before an interface name,
2627 will display the capability list and all
2628 of the supported media for the specified interface.
2631 flag is supplied, address lifetime is displayed for IPv6 addresses,
2632 as time offset string.
2636 flag may be used instead of an interface name.
2639 to display information about all interfaces in the system.
2642 flag limits this to interfaces that are down, and
2644 limits this to interfaces that are up.
2645 When no arguments are given,
2651 flag may be used to list all available interfaces on the system, with
2652 no other additional information.
2655 is specified, only interfaces of that type will be listed.
2657 will list only Ethernet adapters, excluding the loopback interface.
2658 Use of this flag is mutually exclusive
2659 with all other flags and commands, except for
2661 (only list interfaces that are down)
2664 (only list interfaces that are up).
2668 flag may be used to get more verbose status for an interface.
2672 flag may be used to list all of the interface cloners available on
2673 the system, with no additional information.
2674 Use of this flag is mutually exclusive with all other flags and commands.
2678 flag causes keying information for the interface, if available, to be
2680 For example, the values of 802.11 WEP keys and
2682 passphrases will be printed, if accessible to the current user.
2683 This information is not printed by default, as it may be considered
2686 If the network interface driver is not present in the kernel then
2688 will attempt to load it.
2691 flag disables this behavior.
2693 Only the super-user may modify the configuration of a network interface.
2695 Assign the IPv4 address
2697 with a network mask of
2701 .Dl # ifconfig fxp0 inet 192.0.2.10 netmask 255.255.255.0
2703 Add the IPv4 address
2705 with the CIDR network prefix
2711 as a synonym for the canonical form of the option
2713 .Dl # ifconfig ed0 inet 192.0.2.45/28 add
2715 Remove the IPv4 address
2719 .Dl # ifconfig ed0 inet 192.0.2.45 -alias
2721 Enable IPv6 functionality of the interface:
2722 .Dl # ifconfig em0 inet6 -ifdisabled
2724 Add the IPv6 address
2725 .Li 2001:DB8:DBDB::123/48
2728 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias
2729 Note that lower case hexadecimal IPv6 addresses are acceptable.
2731 Remove the IPv6 address added in the above example,
2734 character as shorthand for the network prefix,
2737 as a synonym for the canonical form of the option
2739 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 delete
2741 Configure a single CARP redundant address on igb0, and then switch it
2743 .Dl # ifconfig igb0 vhid 1 10.0.0.1/24 pass foobar up
2744 .Dl # ifconfig igb0 vhid 1 state master
2746 Configure the interface
2748 to use 100baseTX, full duplex Ethernet media options:
2749 .Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex
2751 Label the em0 interface as an uplink:
2752 .Dl # ifconfig em0 description \&"Uplink to Gigabit Switch 2\&"
2754 Create the software network interface
2756 .Dl # ifconfig gif1 create
2758 Destroy the software network interface
2760 .Dl # ifconfig gif1 destroy
2762 Display available wireless networks using
2764 .Dl # ifconfig wlan0 list scan
2766 Messages indicating the specified interface does not exist, the
2767 requested address is unknown, or the user is not privileged and
2768 tried to alter an interface's configuration.
2790 Basic IPv6 node operation requires a link-local address on each
2791 interface configured for IPv6.
2792 Normally, such an address is automatically configured by the
2793 kernel on each interface added to the system or enabled; this behavior may
2794 be disabled by setting per-interface flag
2795 .Cm -auto_linklocal .
2796 The default value of this flag is 1 and can be disabled by using the sysctl
2798 .Va net.inet6.ip6.auto_linklocal .
2800 Do not configure IPv6 addresses with no link-local address by using
2802 It can result in unexpected behaviors of the kernel.
projects / FreeBSD / stable / 10.git / blob