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 .
741 The following parameters are specific for IPv6 addresses.
742 Note that the address family keyword
745 .Bl -tag -width indent
747 Set a flag to prefer address as a candidate of the source address for
749 .It Cm -prefer_source
754 The following parameters are specific to cloning
755 IEEE 802.11 wireless interfaces with the
758 .Bl -tag -width indent
759 .It Cm wlandev Ar device
762 as the parent for the cloned device.
763 .It Cm wlanmode Ar mode
764 Specify the operating mode for this cloned device.
782 The operating mode of a cloned interface cannot be changed.
785 mode is actually implemented as an
787 interface with special properties.
788 .It Cm wlanbssid Ar bssid
789 The 802.11 mac address to use for the bssid.
790 This must be specified at create time for a legacy
793 .It Cm wlanaddr Ar address
794 The local mac address.
795 If this is not specified then a mac address will automatically be assigned
796 to the cloned device.
797 Typically this address is the same as the address of the parent device
800 parameter is specified then the driver will craft a unique address for
801 the device (if supported).
805 device as operating in ``legacy mode''.
808 devices have a fixed peer relationship and do not, for example, roam
809 if their peer stops communicating.
810 For completeness a Dynamic WDS (DWDS) interface may marked as
813 Request a unique local mac address for the cloned device.
814 This is only possible if the device supports multiple mac addresses.
815 To force use of the parent's mac address use
818 Mark the cloned interface as depending on hardware support to
819 track received beacons.
820 To have beacons tracked in software use
826 can also be used to indicate no beacons should
827 be transmitted; this can be useful when creating a WDS configuration but
829 interfaces can only be created as companions to an access point.
832 The following parameters are specific to IEEE 802.11 wireless interfaces
836 .Bl -tag -width indent
838 Enable sending and receiving AMPDU frames when using 802.11n (default).
839 The 802.11n specification states a compliant station must be capable
840 of receiving AMPDU frames but transmission is optional.
843 to disable all use of AMPDU with 802.11n.
844 For testing and/or to work around interoperability problems one can use
848 to control use of AMPDU in one direction.
849 .It Cm ampdudensity Ar density
850 Set the AMPDU density parameter used when operating with 802.11n.
851 This parameter controls the inter-packet gap for AMPDU frames.
852 The sending device normally controls this setting but a receiving station
853 may request wider gaps.
856 are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds).
859 is treated the same as 0.
860 .It Cm ampdulimit Ar limit
861 Set the limit on packet size for receiving AMPDU frames when operating
865 are 8192, 16384, 32768, and 65536 but one can also specify
866 just the unique prefix: 8, 16, 32, 64.
867 Note the sender may limit the size of AMPDU frames to be less
868 than the maximum specified by the receiving station.
870 Enable sending and receiving AMSDU frames when using 802.11n.
871 By default AMSDU is received but not transmitted.
874 to disable all use of AMSDU with 802.11n.
875 For testing and/or to work around interoperability problems one can use
879 to control use of AMSDU in one direction.
880 .It Cm amsdulimit Ar limit
881 Set the limit on packet size for sending and receiving AMSDU frames
882 when operating with 802.11n.
885 are 7935 and 3839 (bytes).
886 Note the sender may limit the size of AMSDU frames to be less
887 than the maximum specified by the receiving station.
888 Note also that devices are not required to support the 7935 limit,
889 only 3839 is required by the specification and the larger value
890 may require more memory to be dedicated to support functionality
893 When operating as an access point, pass packets between
894 wireless clients directly (default).
895 To instead let them pass up through the
896 system and be forwarded using some other mechanism, use
898 Disabling the internal bridging
899 is useful when traffic is to be processed with
901 .It Cm authmode Ar mode
902 Set the desired authentication mode in infrastructure mode.
903 Not all adapters support all modes.
906 .Cm none , open , shared
912 (IEEE WPA/WPA2/802.11i).
917 modes are only useful when using an authentication service
918 (a supplicant for client operation or an authenticator when
919 operating as an access point).
920 Modes are case insensitive.
922 Enable background scanning when operating as a station.
923 Background scanning is a technique whereby a station associated to
924 an access point will temporarily leave the channel to scan for
925 neighboring stations.
926 This allows a station to maintain a cache of nearby access points
927 so that roaming between access points can be done without
928 a lengthy scan operation.
929 Background scanning is done only when a station is not busy and
930 any outbound traffic will cancel a scan operation.
931 Background scanning should never cause packets to be lost though
932 there may be some small latency if outbound traffic interrupts a
934 By default background scanning is enabled if the device is capable.
935 To disable background scanning, use
937 Background scanning is controlled by the
942 Background scanning must be enabled for roaming; this is an artifact
943 of the current implementation and may not be required in the future.
944 .It Cm bgscanidle Ar idletime
945 Set the minimum time a station must be idle (not transmitting or
946 receiving frames) before a background scan is initiated.
949 parameter is specified in milliseconds.
950 By default a station must be idle at least 250 milliseconds before
951 a background scan is initiated.
952 The idle time may not be set to less than 100 milliseconds.
953 .It Cm bgscanintvl Ar interval
954 Set the interval at which background scanning is attempted.
957 parameter is specified in seconds.
958 By default a background scan is considered every 300 seconds (5 minutes).
961 may not be set to less than 15 seconds.
962 .It Cm bintval Ar interval
963 Set the interval at which beacon frames are sent when operating in
967 parameter is specified in TU's (1024 usecs).
968 By default beacon frames are transmitted every 100 TU's.
969 .It Cm bmissthreshold Ar count
970 Set the number of consecutive missed beacons at which the station
971 will attempt to roam (i.e., search for a new access point).
974 parameter must be in the range 1 to 255; though the
975 upper bound may be reduced according to device capabilities.
976 The default threshold is 7 consecutive missed beacons; but
977 this may be overridden by the device driver.
982 .It Cm bssid Ar address
983 Specify the MAC address of the access point to use when operating
984 as a station in a BSS network.
985 This overrides any automatic selection done by the system.
986 To disable a previously selected access point, supply
991 This option is useful when more than one access point uses the same SSID.
997 Enable packet bursting.
998 Packet bursting is a transmission technique whereby the wireless
999 medium is acquired once to send multiple frames and the interframe
1001 This technique can significantly increase throughput by reducing
1002 transmission overhead.
1003 Packet bursting is supported by the 802.11e QoS specification
1004 and some devices that do not support QoS may still be capable.
1005 By default packet bursting is enabled if a device is capable
1007 To disable packet bursting, use
1009 .It Cm chanlist Ar channels
1010 Set the desired channels to use when scanning for access
1011 points, neighbors in an IBSS network, or looking for unoccupied
1012 channels when operating as an access point.
1013 The set of channels is specified as a comma-separated list with
1014 each element in the list representing either a single channel number or a range
1017 Channel numbers must be in the range 1 to 255 and be permissible
1018 according to the operating characteristics of the device.
1019 .It Cm channel Ar number
1020 Set a single desired channel.
1021 Channels range from 1 to 255, but the exact selection available
1022 depends on the region your adaptor was manufactured for.
1028 will clear any desired channel and, if the device is marked up,
1029 force a scan for a channel to operate on.
1030 Alternatively the frequency, in megahertz, may be specified
1031 instead of the channel number.
1033 When there are several ways to use a channel the channel
1034 number/frequency may be appended with attributes to clarify.
1035 For example, if a device is capable of operating on channel 6
1036 with 802.11n and 802.11g then one can specify that g-only use
1037 should be used by specifying ``6:g''.
1038 Similarly the channel width can be specified by appending it
1039 with ``/''; e.g., ``6/40'' specifies a 40MHz wide channel,
1040 These attributes can be combined as in: ``6:ht/40''.
1041 The full set of flags specified following a ``:'' are:
1047 (Atheros Dynamic Turbo mode),
1055 (Atheros Static Turbo mode),
1058 (Atheros Dynamic Turbo mode, or appended to ``st'' and ``dt'').
1059 The full set of channel widths following a '/' are:
1061 (5MHz aka quarter-rate channel),
1063 (10MHz aka half-rate channel),
1065 (20MHz mostly for use in specifying ht20),
1068 (40MHz mostly for use in specifying ht40).
1070 a 40MHz HT channel specification may include the location
1071 of the extension channel by appending ``+'' or ``-'' for above and below,
1072 respectively; e.g., ``2437:ht/40+'' specifies 40MHz wide HT operation
1073 with the center channel at frequency 2437 and the extension channel above.
1074 .It Cm country Ar name
1075 Set the country code to use in calculating the regulatory constraints
1077 In particular the set of available channels, how the wireless device
1078 will operation on the channels, and the maximum transmit power that
1079 can be used on a channel are defined by this setting.
1080 Country/Region codes are specified as a 2-character abbreviation
1081 defined by ISO 3166 or using a longer, but possibly ambiguous, spelling;
1082 e.g., "ES" and "Spain".
1083 The set of country codes are taken from
1084 .Pa /etc/regdomain.xml
1086 be viewed with the ``list countries'' request.
1087 Note that not all devices support changing the country code from a default
1088 setting; typically stored in EEPROM.
1096 Enable Dynamic Frequency Selection (DFS) as specified in 802.11h.
1097 DFS embodies several facilities including detection of overlapping
1098 radar signals, dynamic transmit power control, and channel selection
1099 according to a least-congested criteria.
1100 DFS support is mandatory for some 5GHz frequencies in certain
1101 locales (e.g., ETSI).
1102 By default DFS is enabled according to the regulatory definitions
1104 .Pa /etc/regdomain.xml
1105 and the current country code, regdomain,
1107 Note the underlying device (and driver) must support radar detection
1108 for full DFS support to work.
1109 To be fully compliant with the local regulatory agency frequencies that
1110 require DFS should not be used unless it is fully supported.
1113 to disable this functionality for testing.
1115 Enable support for the 802.11d specification (default).
1116 When this support is enabled in station mode, beacon frames that advertise
1117 a country code different than the currently configured country code will
1118 cause an event to be dispatched to user applications.
1119 This event can be used by the station to adopt that country code and
1120 operate according to the associated regulatory constraints.
1121 When operating as an access point with 802.11d enabled the beacon and
1122 probe response frames transmitted will advertise the current regulatory
1124 To disable 802.11d use
1127 Enable 802.11h support including spectrum management.
1128 When 802.11h is enabled beacon and probe response frames will have
1129 the SpectrumMgt bit set in the capabilities field and
1130 country and power constraint information elements will be present.
1131 802.11h support also includes handling Channel Switch Announcements (CSA)
1132 which are a mechanism to coordinate channel changes by an access point.
1133 By default 802.11h is enabled if the device is capable.
1134 To disable 802.11h use
1136 .It Cm deftxkey Ar index
1137 Set the default key to use for transmission.
1138 Typically this is only set when using WEP encryption.
1139 Note that you must set a default transmit key
1140 for the system to know which key to use in encrypting outbound traffic.
1143 is an alias for this request; it is provided for backwards compatibility.
1144 .It Cm dtimperiod Ar period
1147 period for transmitting buffered multicast data frames when
1148 operating in ap mode.
1151 specifies the number of beacon intervals between DTIM
1152 and must be in the range 1 to 15.
1153 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
1155 Enable the use of quiet IE.
1156 Hostap will use this to silence other
1157 stations to reduce interference for radar detection when
1158 operating on 5GHz frequency and doth support is enabled.
1161 to disable this functionality.
1162 .It Cm quiet_period Ar period
1165 to the number of beacon intervals between the start of regularly
1166 scheduled quiet intervals defined by Quiet element.
1167 .It Cm quiet_count Ar count
1170 to the number of TBTTs until the beacon interval during which the
1171 next quiet interval shall start.
1172 A value of 1 indicates the quiet
1173 interval will start during the beacon interval starting at the next
1175 A value 0 is reserved.
1176 .It Cm quiet_offset Ar offset
1179 to the offset of the start of the quiet interval from the TBTT
1180 specified by the Quiet count, expressed in TUs.
1183 shall be less than one beacon interval.
1184 .It Cm quiet_duration Ar dur
1187 to the duration of the Quiet interval, expressed in TUs.
1188 The value should be less than beacon interval.
1190 Enable the use of Atheros Dynamic Turbo mode when communicating with
1191 another Dynamic Turbo-capable station.
1192 Dynamic Turbo mode is an Atheros-specific mechanism by which
1193 stations switch between normal 802.11 operation and a ``boosted''
1194 mode in which a 40MHz wide channel is used for communication.
1195 Stations using Dynamic Turbo mode operate boosted only when the
1196 channel is free of non-dturbo stations; when a non-dturbo station
1197 is identified on the channel all stations will automatically drop
1198 back to normal operation.
1199 By default, Dynamic Turbo mode is not enabled, even if the device is capable.
1200 Note that turbo mode (dynamic or static) is only allowed on some
1201 channels depending on the regulatory constraints; use the
1203 command to identify the channels where turbo mode may be used.
1204 To disable Dynamic Turbo mode use
1207 Enable Dynamic WDS (DWDS) support.
1208 DWDS is a facility by which 4-address traffic can be carried between
1209 stations operating in infrastructure mode.
1210 A station first associates to an access point and authenticates using
1211 normal procedures (e.g., WPA).
1212 Then 4-address frames are passed to carry traffic for stations
1213 operating on either side of the wireless link.
1214 DWDS extends the normal WDS mechanism by leveraging existing security
1215 protocols and eliminating static binding.
1217 When DWDS is enabled on an access point 4-address frames received from
1218 an authorized station will generate a ``DWDS discovery'' event to user
1220 This event should be used to create a WDS interface that is bound
1221 to the remote station (and usually plumbed into a bridge).
1222 Once the WDS interface is up and running 4-address traffic then logically
1223 flows through that interface.
1225 When DWDS is enabled on a station, traffic with a destination address
1226 different from the peer station are encapsulated in a 4-address frame
1227 and transmitted to the peer.
1228 All 4-address traffic uses the security information of the stations
1229 (e.g., cryptographic keys).
1230 A station is associated using 802.11n facilities may transport
1231 4-address traffic using these same mechanisms; this depends on available
1232 resources and capabilities of the device.
1233 The DWDS implementation guards against layer 2 routing loops of
1236 Enable the use of Atheros Fast Frames when communicating with
1237 another Fast Frames-capable station.
1238 Fast Frames are an encapsulation technique by which two 802.3
1239 frames are transmitted in a single 802.11 frame.
1240 This can noticeably improve throughput but requires that the
1241 receiving station understand how to decapsulate the frame.
1242 Fast frame use is negotiated using the Atheros 802.11 vendor-specific
1243 protocol extension so enabling use is safe when communicating with
1244 non-Atheros devices.
1245 By default, use of fast frames is enabled if the device is capable.
1246 To explicitly disable fast frames, use
1248 .It Cm fragthreshold Ar length
1249 Set the threshold for which transmitted frames are broken into fragments.
1252 argument is the frame size in bytes and must be in the range 256 to 2346.
1260 disables transmit fragmentation.
1261 Not all adapters honor the fragmentation threshold.
1263 When operating as an access point, do not broadcast the SSID
1264 in beacon frames or respond to probe request frames unless
1265 they are directed to the ap (i.e., they include the ap's SSID).
1266 By default, the SSID is included in beacon frames and
1267 undirected probe request frames are answered.
1268 To re-enable the broadcast of the SSID etc., use
1271 Enable use of High Throughput (HT) when using 802.11n (default).
1272 The 802.11n specification includes mechanisms for operation
1273 on 20MHz and 40MHz wide channels using different signalling mechanisms
1274 than specified in 802.11b, 802.11g, and 802.11a.
1275 Stations negotiate use of these facilities, termed HT20 and HT40,
1276 when they associate.
1277 To disable all use of 802.11n use
1279 To disable use of HT20 (e.g., to force only HT40 use) use
1281 To disable use of HT40 use
1284 HT configuration is used to ``auto promote'' operation
1285 when several choices are available.
1286 For example, if a station associates to an 11n-capable access point
1287 it controls whether the station uses legacy operation, HT20, or HT40.
1288 When an 11n-capable device is setup as an access point and
1289 Auto Channel Selection is used to locate a channel to operate on,
1290 HT configuration controls whether legacy, HT20, or HT40 operation is setup
1291 on the selected channel.
1292 If a fixed channel is specified for a station then HT configuration can
1293 be given as part of the channel specification; e.g., 6:ht/20 to setup
1294 HT20 operation on channel 6.
1296 Enable use of compatibility support for pre-802.11n devices (default).
1297 The 802.11n protocol specification went through several incompatible iterations.
1298 Some vendors implemented 11n support to older specifications that
1299 will not interoperate with a purely 11n-compliant station.
1300 In particular the information elements included in management frames
1301 for old devices are different.
1302 When compatibility support is enabled both standard and compatible data
1304 Stations that associate using the compatibility mechanisms are flagged
1306 To disable compatibility support use
1308 .It Cm htprotmode Ar technique
1309 For interfaces operating in 802.11n, use the specified
1311 for protecting HT frames in a mixed legacy/HT network.
1312 The set of valid techniques is
1317 Technique names are case insensitive.
1319 Enable inactivity processing for stations associated to an
1320 access point (default).
1321 When operating as an access point the 802.11 layer monitors
1322 the activity of each associated station.
1323 When a station is inactive for 5 minutes it will send several
1324 ``probe frames'' to see if the station is still present.
1325 If no response is received then the station is deauthenticated.
1326 Applications that prefer to handle this work can disable this
1330 Set the location to use in calculating regulatory constraints.
1331 The location is also advertised in beacon and probe response frames
1332 when 802.11d is enabled with
1341 Display the list of channels available for use taking into account
1342 any restrictions set with the
1345 See the description of
1347 for more information.
1349 Display the adaptor's capabilities, including the operating
1352 Display the list of channels available for use.
1353 Channels are shown with their IEEE channel number, equivalent
1354 frequency, and usage modes.
1355 Channels identified as
1360 Channels identified as
1362 may be used only for Atheros' Static Turbo mode
1364 . Cm mediaopt turbo ) .
1365 Channels marked with a
1367 have a regulatory constraint that they be passively scanned.
1368 This means a station is not permitted to transmit on the channel until
1369 it identifies the channel is being used for 802.11 communication;
1370 typically by hearing a beacon frame from an access point operating
1373 is another way of requesting this information.
1374 By default a compacted list of channels is displayed; if the
1376 option is specified then all channels are shown.
1377 .It Cm list countries
1378 Display the set of country codes and regulatory domains that can be
1379 used in regulatory configuration.
1381 Display the current MAC Access Control List state.
1382 Each address is prefixed with a character that indicates the
1383 current policy applied to it:
1385 indicates the address is allowed access,
1387 indicates the address is denied access,
1389 indicates the address is present but the current policy open
1390 (so the ACL is not consulted).
1392 Displays the mesh routing table, used for forwarding packets on a mesh
1394 .It Cm list regdomain
1395 Display the current regulatory settings including the available channels
1396 and transmit power caps.
1398 Display the parameters that govern roaming operation.
1400 Display the parameters that govern transmit operation.
1402 Display the transmit power caps for each channel.
1404 Display the access points and/or ad-hoc neighbors
1405 located in the vicinity.
1406 This information may be updated automatically by the adapter
1409 request or through background scanning.
1410 Depending on the capabilities of the stations the following
1411 flags can be included in the output:
1415 Indicates that the station is permitted to send/receive data frames.
1417 Extended Rate Phy (ERP).
1418 Indicates that the station is operating in an 802.11g network
1419 using extended transmit rates.
1421 High Throughput (HT).
1422 Indicates that the station is using HT transmit rates.
1423 If a `+' follows immediately after then the station associated
1424 using deprecated mechanisms supported only when
1429 Indicates that the station is operating in power save mode.
1431 Quality of Service (QoS).
1432 Indicates that the station is using QoS encapsulation for
1434 QoS encapsulation is enabled only when WME mode is enabled.
1437 Indicates that the station is doing short preamble to optionally
1438 improve throughput performance with 802.11g and 802.11b.
1440 Transitional Security Network (TSN).
1441 Indicates that the station associated using TSN; see also
1445 Wi-Fi Protected Setup (WPS).
1446 Indicates that the station associated using WPS.
1449 By default interesting information elements captured from the neighboring
1450 stations are displayed at the end of each row.
1451 Possible elements include:
1453 (station supports WME),
1455 (station supports WPA),
1457 (station supports WPS),
1459 (station supports 802.11i/RSN),
1461 (station supports 802.11n/HT communication),
1463 (station supports Atheros protocol extensions),
1465 (station supports unknown vendor-specific extensions).
1468 flag is used all the information elements and their
1469 contents will be shown.
1472 flag also enables display of long SSIDs.
1475 command is another way of requesting this information.
1477 When operating as an access point display the stations that are
1478 currently associated.
1479 When operating in ad-hoc mode display stations identified as
1480 neighbors in the IBSS.
1481 When operating in mesh mode display stations identified as
1482 neighbors in the MBSS.
1483 When operating in station mode display the access point.
1484 Capabilities advertised by the stations are described under
1488 Depending on the capabilities of the stations the following
1489 flags can be included in the output:
1493 Indicates that the station is permitted to send/receive data frames.
1495 Extended Rate Phy (ERP).
1496 Indicates that the station is operating in an 802.11g network
1497 using extended transmit rates.
1499 High Throughput (HT).
1500 Indicates that the station is using HT transmit rates.
1501 If a `+' follows immediately after then the station associated
1502 using deprecated mechanisms supported only when
1507 Indicates that the station is operating in power save mode.
1509 Quality of Service (QoS).
1510 Indicates that the station is using QoS encapsulation for
1512 QoS encapsulation is enabled only when WME mode is enabled.
1515 Indicates that the station is doing short preamble to optionally
1516 improve throughput performance with 802.11g and 802.11b.
1518 Transitional Security Network (TSN).
1519 Indicates that the station associated using TSN; see also
1523 Wi-Fi Protected Setup (WPS).
1524 Indicates that the station associated using WPS.
1527 By default information elements received from associated stations
1528 are displayed in a short form; the
1530 flag causes this information to be displayed symbolically.
1532 Display the current channel parameters to use when operating in WME mode.
1535 option is specified then both channel and BSS parameters are displayed
1536 for each AC (first channel, then BSS).
1537 When WME mode is enabled for an adaptor this information will be
1538 displayed with the regular status; this command is mostly useful
1539 for examining parameters when WME mode is disabled.
1540 See the description of the
1542 directive for information on the various parameters.
1543 .It Cm maxretry Ar count
1544 Set the maximum number of tries to use in sending unicast frames.
1545 The default setting is 6 but drivers may override this with a value
1547 .It Cm mcastrate Ar rate
1548 Set the rate for transmitting multicast/broadcast frames.
1549 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1550 This rate should be valid for the current operating conditions;
1551 if an invalid rate is specified drivers are free to chose an
1553 .It Cm mgtrate Ar rate
1554 Set the rate for transmitting management and/or control frames.
1555 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1557 Set the location to use in calculating regulatory constraints.
1558 The location is also advertised in beacon and probe response frames
1559 when 802.11d is enabled with
1568 Enable powersave operation.
1569 When operating as a client, the station will conserve power by
1570 periodically turning off the radio and listening for
1571 messages from the access point telling it there are packets waiting.
1572 The station must then retrieve the packets.
1573 Not all devices support power save operation as a client.
1574 The 802.11 specification requires that all access points support
1575 power save but some drivers do not.
1578 to disable powersave operation when operating as a client.
1579 .It Cm powersavesleep Ar sleep
1580 Set the desired max powersave sleep time in TU's (1024 usecs).
1581 By default the max powersave sleep time is 100 TU's.
1582 .It Cm protmode Ar technique
1583 For interfaces operating in 802.11g, use the specified
1585 for protecting OFDM frames in a mixed 11b/11g network.
1586 The set of valid techniques is
1592 Technique names are case insensitive.
1593 Not all devices support
1595 as a protection technique.
1597 When operating as an access point in 802.11g mode allow only
1598 11g-capable stations to associate (11b-only stations are not
1599 permitted to associate).
1600 To allow both 11g and 11b-only stations to associate, use
1603 When operating as an access point in 802.11n mode allow only
1604 HT-capable stations to associate (legacy stations are not
1605 permitted to associate).
1606 To allow both HT and legacy stations to associate, use
1608 .It Cm regdomain Ar sku
1609 Set the regulatory domain to use in calculating the regulatory constraints
1611 In particular the set of available channels, how the wireless device
1612 will operation on the channels, and the maximum transmit power that
1613 can be used on a channel are defined by this setting.
1614 Regdomain codes (SKU's) are taken from
1615 .Pa /etc/regdomain.xml
1617 be viewed with the ``list countries'' request.
1618 Note that not all devices support changing the regdomain from a default
1619 setting; typically stored in EEPROM.
1627 Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n
1629 Note that RIFS must be supported by both the station and access point
1633 .It Cm roam:rate Ar rate
1634 Set the threshold for controlling roaming when operating in a BSS.
1637 parameter specifies the transmit rate in megabits
1638 at which roaming should be considered.
1639 If the current transmit rate drops below this setting and background scanning
1640 is enabled, then the system will check if a more desirable access point is
1641 available and switch over to it.
1642 The current scan cache contents are used if they are considered
1643 valid according to the
1645 parameter; otherwise a background scan operation is triggered before
1646 any selection occurs.
1647 Each channel type has a separate rate threshold; the default values are:
1648 12 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng).
1649 .It Cm roam:rssi Ar rssi
1650 Set the threshold for controlling roaming when operating in a BSS.
1653 parameter specifies the receive signal strength in dBm units
1654 at which roaming should be considered.
1655 If the current rssi drops below this setting and background scanning
1656 is enabled, then the system will check if a more desirable access point is
1657 available and switch over to it.
1658 The current scan cache contents are used if they are considered
1659 valid according to the
1661 parameter; otherwise a background scan operation is triggered before
1662 any selection occurs.
1663 Each channel type has a separate rssi threshold; the default values are
1665 .It Cm roaming Ar mode
1666 When operating as a station, control how the system will
1667 behave when communication with the current access point
1671 argument may be one of
1673 (leave it to the hardware device to decide),
1675 (handle either in the device or the operating system\[em]as appropriate),
1677 (do nothing until explicitly instructed).
1678 By default, the device is left to handle this if it is
1679 capable; otherwise, the operating system will automatically
1680 attempt to reestablish communication.
1681 Manual mode is used by applications such as
1682 .Xr wpa_supplicant 8
1683 that want to control the selection of an access point.
1684 .It Cm rtsthreshold Ar length
1685 Set the threshold for which
1686 transmitted frames are preceded by transmission of an
1692 is the frame size in bytes and must be in the range 1 to 2346.
1700 disables transmission of RTS frames.
1701 Not all adapters support setting the RTS threshold.
1703 Initiate a scan of neighboring stations, wait for it to complete, and
1704 display all stations found.
1705 Only the super-user can initiate a scan.
1708 for information on the display.
1709 By default a background scan is done; otherwise a foreground
1710 scan is done and the station may roam to a different access point.
1713 request can be used to show recent scan results without
1714 initiating a new scan.
1715 .It Cm scanvalid Ar threshold
1716 Set the maximum time the scan cache contents are considered valid;
1717 i.e., will be used without first triggering a scan operation to
1721 parameter is specified in seconds and defaults to 60 seconds.
1722 The minimum setting for
1725 One should take care setting this threshold; if it is set too low
1726 then attempts to roam to another access point may trigger unnecessary
1727 background scan operations.
1729 Enable use of Short Guard Interval when operating in 802.11n
1731 NB: this currently enables Short GI on both HT40 and HT20 channels.
1732 To disable Short GI use
1735 Enable use of Static Spatial Multiplexing Power Save (SMPS)
1736 when operating in 802.11n.
1737 A station operating with Static SMPS maintains only a single
1738 receive chain active (this can significantly reduce power consumption).
1742 Enable use of Dynamic Spatial Multiplexing Power Save (SMPS)
1743 when operating in 802.11n.
1744 A station operating with Dynamic SMPS maintains only a single
1745 receive chain active but switches to multiple receive chains when it
1746 receives an RTS frame (this can significantly reduce power consumption).
1747 Note that stations cannot distinguish between RTS/CTS intended to
1748 enable multiple receive chains and those used for other purposes.
1752 Set the desired Service Set Identifier (aka network name).
1753 The SSID is a string up to 32 characters
1754 in length and may be specified as either a normal string or in
1755 hexadecimal when preceded by
1757 Additionally, the SSID may be cleared by setting it to
1759 .It Cm tdmaslot Ar slot
1760 When operating with TDMA, use the specified
1765 is a number between 0 and the maximum number of slots in the BSS.
1766 Note that a station configured as slot 0 is a master and
1767 will broadcast beacon frames advertising the BSS;
1768 stations configured to use other slots will always
1769 scan to locate a master before they ever transmit.
1773 .It Cm tdmaslotcnt Ar cnt
1774 When operating with TDMA, setup a BSS with
1777 The slot count may be at most 8.
1778 The current implementation is only tested with two stations
1779 (i.e., point to point applications).
1780 This setting is only meaningful when a station is configured as slot 0;
1781 other stations adopt this setting from the BSS they join.
1785 .It Cm tdmaslotlen Ar len
1786 When operating with TDMA, setup a BSS such that each station has a slot
1789 The slot length must be at least 150 microseconds (1/8 TU)
1790 and no more than 65 milliseconds.
1791 Note that setting too small a slot length may result in poor channel
1792 bandwidth utilization due to factors such as timer granularity and
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.
1798 is set to 10 milliseconds.
1799 .It Cm tdmabintval Ar intval
1800 When operating with TDMA, setup a BSS such that beacons are transmitted every
1802 superframes to synchronize the TDMA slot timing.
1803 A superframe is defined as the number of slots times the slot length; e.g.,
1804 a BSS with two slots of 10 milliseconds has a 20 millisecond superframe.
1805 The beacon interval may not be zero.
1808 causes the timers to be resynchronized more often; this can be help if
1809 significant timer drift is observed.
1814 When operating as an access point with WPA/802.11i allow legacy
1815 stations to associate using static key WEP and open authentication.
1816 To disallow legacy station use of WEP, use
1818 .It Cm txpower Ar power
1819 Set the power used to transmit frames.
1822 argument is specified in .5 dBm units.
1823 Out of range values are truncated.
1824 Typically only a few discreet power settings are available and
1825 the driver will use the setting closest to the specified value.
1826 Not all adapters support changing the transmit power.
1827 .It Cm ucastrate Ar rate
1828 Set a fixed rate for transmitting unicast frames.
1829 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1830 This rate should be valid for the current operating conditions;
1831 if an invalid rate is specified drivers are free to chose an
1833 .It Cm wepmode Ar mode
1834 Set the desired WEP mode.
1835 Not all adapters support all modes.
1836 The set of valid modes is
1842 mode explicitly tells the adaptor to allow association with access
1843 points which allow both encrypted and unencrypted traffic.
1846 means that the access point must only allow encrypted connections.
1849 is generally another name for
1851 Modes are case insensitive.
1852 .It Cm weptxkey Ar index
1853 Set the WEP key to be used for transmission.
1854 This is the same as setting the default transmission key with
1856 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
1857 Set the selected WEP key.
1860 is not given, key 1 is set.
1861 A WEP key will be either 5 or 13
1862 characters (40 or 104 bits) depending on the local network and the
1863 capabilities of the adaptor.
1864 It may be specified either as a plain
1865 string or as a string of hexadecimal digits preceded by
1867 For maximum portability, hex keys are recommended;
1868 the mapping of text keys to WEP encryption is usually driver-specific.
1871 drivers do this mapping differently to
1873 A key may be cleared by setting it to
1875 If WEP is supported then there are at least four keys.
1876 Some adapters support more than four keys.
1877 If that is the case, then the first four keys
1878 (1-4) will be the standard temporary keys and any others will be adaptor
1879 specific keys such as permanent keys stored in NVRAM.
1881 Note that you must set a default transmit key with
1883 for the system to know which key to use in encrypting outbound traffic.
1885 Enable Wireless Multimedia Extensions (WME) support, if available,
1886 for the specified interface.
1887 WME is a subset of the IEEE 802.11e standard to support the
1888 efficient communication of realtime and multimedia data.
1889 To disable WME support, use
1891 Another name for this parameter is
1894 The following parameters are meaningful only when WME support is in use.
1895 Parameters are specified per-AC (Access Category) and
1896 split into those that are used by a station when acting
1897 as an access point and those for client stations in the BSS.
1898 The latter are received from the access point and may not be changed
1900 The following Access Categories are recognized:
1902 .Bl -tag -width ".Cm AC_BK" -compact
1906 best effort delivery,
1921 AC parameters are case-insensitive.
1922 Traffic classification is done in the operating system using the
1923 vlan priority associated with data frames or the
1924 ToS (Type of Service) indication in IP-encapsulated frames.
1925 If neither information is present, traffic is assigned to the
1926 Best Effort (BE) category.
1927 .Bl -tag -width indent
1929 Set the ACK policy for QoS transmissions by the local station;
1930 this controls whether or not data frames transmitted by a station
1931 require an ACK response from the receiving station.
1932 To disable waiting for an ACK use
1934 This parameter is applied only to the local station.
1936 Enable the Admission Control Mandatory (ACM) mechanism
1937 for transmissions by the local station.
1938 To disable the ACM use
1940 On stations in a BSS this parameter is read-only and indicates
1941 the setting received from the access point.
1942 NB: ACM is not supported right now.
1943 .It Cm aifs Ar ac Ar count
1944 Set the Arbitration Inter Frame Spacing (AIFS)
1945 channel access parameter to use for transmissions
1946 by the local station.
1947 On stations in a BSS this parameter is read-only and indicates
1948 the setting received from the access point.
1949 .It Cm cwmin Ar ac Ar count
1950 Set the CWmin channel access parameter to use for transmissions
1951 by the local station.
1952 On stations in a BSS this parameter is read-only and indicates
1953 the setting received from the access point.
1954 .It Cm cwmax Ar ac Ar count
1955 Set the CWmax channel access parameter to use for transmissions
1956 by the local station.
1957 On stations in a BSS this parameter is read-only and indicates
1958 the setting received from the access point.
1959 .It Cm txoplimit Ar ac Ar limit
1960 Set the Transmission Opportunity Limit channel access parameter
1961 to use for transmissions by the local station.
1962 This parameter defines an interval of time when a WME station
1963 has the right to initiate transmissions onto the wireless medium.
1964 On stations in a BSS this parameter is read-only and indicates
1965 the setting received from the access point.
1966 .It Cm bss:aifs Ar ac Ar count
1967 Set the AIFS channel access parameter to send to stations in a BSS.
1968 This parameter is meaningful only when operating in ap mode.
1969 .It Cm bss:cwmin Ar ac Ar count
1970 Set the CWmin channel access parameter to send to stations in a BSS.
1971 This parameter is meaningful only when operating in ap mode.
1972 .It Cm bss:cwmax Ar ac Ar count
1973 Set the CWmax channel access parameter to send to stations in a BSS.
1974 This parameter is meaningful only when operating in ap mode.
1975 .It Cm bss:txoplimit Ar ac Ar limit
1976 Set the TxOpLimit channel access parameter to send to stations in a BSS.
1977 This parameter is meaningful only when operating in ap mode.
1980 Enable Wireless Privacy Subscriber support.
1981 Note that WPS support requires a WPS-capable supplicant.
1982 To disable this function use
1986 The following parameters support an optional access control list
1987 feature available with some adapters when operating in ap mode; see
1989 This facility allows an access point to accept/deny association
1990 requests based on the MAC address of the station.
1991 Note that this feature does not significantly enhance security
1992 as MAC address spoofing is easy to do.
1993 .Bl -tag -width indent
1994 .It Cm mac:add Ar address
1995 Add the specified MAC address to the database.
1996 Depending on the policy setting association requests from the
1997 specified station will be allowed or denied.
1999 Set the ACL policy to permit association only by
2000 stations registered in the database.
2001 .It Cm mac:del Ar address
2002 Delete the specified MAC address from the database.
2004 Set the ACL policy to deny association only by
2005 stations registered in the database.
2006 .It Cm mac:kick Ar address
2007 Force the specified station to be deauthenticated.
2008 This typically is done to block a station after updating the
2011 Set the ACL policy to allow all stations to associate.
2013 Delete all entries in the database.
2015 Set the ACL policy to permit association only by
2016 stations approved by a RADIUS server.
2017 Note that this feature requires the
2019 program be configured to do the right thing
2020 as it handles the RADIUS processing
2021 (and marks stations as authorized).
2024 The following parameters are related to a wireless interface operating in mesh
2026 .Bl -tag -width indent
2027 .It Cm meshid Ar meshid
2028 Set the desired Mesh Identifier.
2029 The Mesh ID is a string up to 32 characters in length.
2030 A mesh interface must have a Mesh Identifier specified
2031 to reach an operational state.
2032 .It Cm meshttl Ar ttl
2033 Set the desired ``time to live'' for mesh forwarded packets;
2034 this is the number of hops a packet may be forwarded before
2036 The default setting for
2040 Enable or disable peering with neighbor mesh stations.
2041 Stations must peer before any data packets can be exchanged.
2046 Enable or disable forwarding packets by a mesh interface.
2051 This attribute specifies whether or not the mesh STA activates mesh gate
2056 .It Cm meshmetric Ar protocol
2059 as the link metric protocol used on a mesh network.
2060 The default protocol is called
2062 The mesh interface will restart after changing this setting.
2063 .It Cm meshpath Ar protocol
2066 as the path selection protocol used on a mesh network.
2067 The only available protocol at the moment is called
2069 (Hybrid Wireless Mesh Protocol).
2070 The mesh interface will restart after changing this setting.
2071 .It Cm hwmprootmode Ar mode
2072 Stations on a mesh network can operate as ``root nodes.''
2073 Root nodes try to find paths to all mesh nodes and advertise themselves
2075 When there is a root mesh node on a network, other mesh nodes can setup
2076 paths between themselves faster because they can use the root node
2077 to find the destination.
2078 This path may not be the best, but on-demand
2079 routing will eventually find the best path.
2080 The following modes are recognized:
2082 .Bl -tag -width ".Cm PROACTIVE" -compact
2086 Send broadcast path requests every two seconds.
2087 Nodes on the mesh without a path to this root mesh station with try to
2088 discover a path to us.
2090 Send broadcast path requests every two seconds and every node must reply
2091 with a path reply even if it already has a path to this root mesh station.
2093 Send broadcast root announcement (RANN) frames.
2094 Nodes on the mesh without a path to this root mesh station with try to
2095 discover a path to us.
2101 .It Cm hwmpmaxhops Ar cnt
2102 Set the maximum number of hops allowed in an HMWP path to
2104 The default setting for
2109 The following parameters are for compatibility with other systems:
2110 .Bl -tag -width indent
2112 Another name for the
2118 .It Cm stationname Ar name
2119 Set the name of this station.
2120 The station name is not part of the IEEE 802.11
2121 protocol though some interfaces support it.
2123 seems to be meaningful to identical or virtually identical equipment.
2124 Setting the station name is identical in syntax to setting the SSID.
2131 Another way of saying
2137 Another way of saying
2143 Another way of saying:
2144 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
2150 .Ar n : k1 , k2 , k3 , k4
2153 Another way of saying
2154 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
2159 Another way of saying
2166 The following parameters are specific to bridge interfaces:
2167 .Bl -tag -width indent
2168 .It Cm addm Ar interface
2169 Add the interface named by
2171 as a member of the bridge.
2172 The interface is put into promiscuous mode
2173 so that it can receive every packet sent on the network.
2174 .It Cm deletem Ar interface
2175 Remove the interface named by
2178 Promiscuous mode is disabled on the interface when
2179 it is removed from the bridge.
2180 .It Cm maxaddr Ar size
2181 Set the size of the bridge address cache to
2183 The default is 2000 entries.
2184 .It Cm timeout Ar seconds
2185 Set the timeout of address cache entries to
2190 is zero, then address cache entries will not be expired.
2191 The default is 1200 seconds.
2193 Display the addresses that have been learned by the bridge.
2194 .It Cm static Ar interface-name Ar address
2195 Add a static entry into the address cache pointing to
2196 .Ar interface-name .
2197 Static entries are never aged out of the cache or re-placed, even if the
2198 address is seen on a different interface.
2199 .It Cm deladdr Ar address
2202 from the address cache.
2204 Delete all dynamically-learned addresses from the address cache.
2206 Delete all addresses, including static addresses, from the address cache.
2207 .It Cm discover Ar interface
2208 Mark an interface as a
2211 When the bridge has no address cache entry
2212 (either dynamic or static)
2213 for the destination address of a packet,
2214 the bridge will forward the packet to all
2215 member interfaces marked as
2217 This is the default for all interfaces added to a bridge.
2218 .It Cm -discover Ar interface
2221 attribute on a member interface.
2222 For packets without the
2224 attribute, the only packets forwarded on the interface are broadcast
2225 or multicast packets and packets for which the destination address
2226 is known to be on the interface's segment.
2227 .It Cm learn Ar interface
2228 Mark an interface as a
2231 When a packet arrives on such an interface, the source
2232 address of the packet is entered into the address cache as being a
2233 destination address on the interface's segment.
2234 This is the default for all interfaces added to a bridge.
2235 .It Cm -learn Ar interface
2238 attribute on a member interface.
2239 .It Cm sticky Ar interface
2240 Mark an interface as a
2243 Dynamically learned address entries are treated at static once entered into
2245 Sticky entries are never aged out of the cache or replaced, even if the
2246 address is seen on a different interface.
2247 .It Cm -sticky Ar interface
2250 attribute on a member interface.
2251 .It Cm private Ar interface
2252 Mark an interface as a
2255 A private interface does not forward any traffic to any other port that is also
2256 a private interface.
2257 .It Cm -private Ar interface
2260 attribute on a member interface.
2261 .It Cm span Ar interface
2262 Add the interface named by
2264 as a span port on the bridge.
2265 Span ports transmit a copy of every frame received by the bridge.
2266 This is most useful for snooping a bridged network passively on
2267 another host connected to one of the span ports of the bridge.
2268 .It Cm -span Ar interface
2269 Delete the interface named by
2271 from the list of span ports of the bridge.
2272 .It Cm stp Ar interface
2273 Enable Spanning Tree protocol on
2277 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
2278 Spanning Tree is used to detect and remove loops in a network topology.
2279 .It Cm -stp Ar interface
2280 Disable Spanning Tree protocol on
2282 This is the default for all interfaces added to a bridge.
2283 .It Cm edge Ar interface
2287 An edge port connects directly to end stations cannot create bridging
2288 loops in the network, this allows it to transition straight to forwarding.
2289 .It Cm -edge Ar interface
2290 Disable edge status on
2292 .It Cm autoedge Ar interface
2295 to automatically detect edge status.
2296 This is the default for all interfaces added to a bridge.
2297 .It Cm -autoedge Ar interface
2298 Disable automatic edge status on
2300 .It Cm ptp Ar interface
2303 as a point to point link.
2304 This is required for straight transitions to forwarding and
2305 should be enabled on a direct link to another RSTP capable switch.
2306 .It Cm -ptp Ar interface
2307 Disable point to point link status on
2309 This should be disabled for a half duplex link and for an interface
2310 connected to a shared network segment,
2311 like a hub or a wireless network.
2312 .It Cm autoptp Ar interface
2313 Automatically detect the point to point status on
2315 by checking the full duplex link status.
2316 This is the default for interfaces added to the bridge.
2317 .It Cm -autoptp Ar interface
2318 Disable automatic point to point link detection on
2320 .It Cm maxage Ar seconds
2321 Set the time that a Spanning Tree protocol configuration is valid.
2322 The default is 20 seconds.
2323 The minimum is 6 seconds and the maximum is 40 seconds.
2324 .It Cm fwddelay Ar seconds
2325 Set the time that must pass before an interface begins forwarding
2326 packets when Spanning Tree is enabled.
2327 The default is 15 seconds.
2328 The minimum is 4 seconds and the maximum is 30 seconds.
2329 .It Cm hellotime Ar seconds
2330 Set the time between broadcasting of Spanning Tree protocol
2331 configuration messages.
2332 The hello time may only be changed when operating in legacy stp mode.
2333 The default is 2 seconds.
2334 The minimum is 1 second and the maximum is 2 seconds.
2335 .It Cm priority Ar value
2336 Set the bridge priority for Spanning Tree.
2337 The default is 32768.
2338 The minimum is 0 and the maximum is 61440.
2339 .It Cm proto Ar value
2340 Set the Spanning Tree protocol.
2341 The default is rstp.
2342 The available options are stp and rstp.
2343 .It Cm holdcnt Ar value
2344 Set the transmit hold count for Spanning Tree.
2345 This is the number of packets transmitted before being rate limited.
2347 The minimum is 1 and the maximum is 10.
2348 .It Cm ifpriority Ar interface Ar value
2349 Set the Spanning Tree priority of
2354 The minimum is 0 and the maximum is 240.
2355 .It Cm ifpathcost Ar interface Ar value
2356 Set the Spanning Tree path cost of
2360 The default is calculated from the link speed.
2361 To change a previously selected path cost back to automatic, set the
2363 The minimum is 1 and the maximum is 200000000.
2364 .It Cm ifmaxaddr Ar interface Ar size
2365 Set the maximum number of hosts allowed from an interface, packets with unknown
2366 source addresses are dropped until an existing host cache entry expires or is
2368 Set to 0 to disable.
2371 The following parameters are specific to lagg interfaces:
2372 .Bl -tag -width indent
2373 .It Cm laggport Ar interface
2374 Add the interface named by
2376 as a port of the aggregation interface.
2377 .It Cm -laggport Ar interface
2378 Remove the interface named by
2380 from the aggregation interface.
2381 .It Cm laggproto Ar proto
2382 Set the aggregation protocol.
2383 The default is failover.
2384 The available options are failover, fec, lacp, loadbalance, roundrobin and
2386 .It Cm lagghash Ar option Ns Oo , Ns Ar option Oc
2387 Set the packet layers to hash for aggregation protocols which load balance.
2390 The options can be combined using commas.
2392 .Bl -tag -width ".Cm l2" -compact
2394 src/dst mac address and optional vlan number.
2396 src/dst address for IPv4 or IPv6.
2398 src/dst port for TCP/UDP/SCTP.
2403 The following parameters are specific to IP tunnel interfaces,
2405 .Bl -tag -width indent
2406 .It Cm tunnel Ar src_addr dest_addr
2407 Configure the physical source and destination address for IP tunnel
2413 are interpreted as the outer source/destination for the encapsulating
2416 Unconfigure the physical source and destination address for IP tunnel
2417 interfaces previously configured with
2420 Another name for the
2423 .It Cm accept_rev_ethip_ver
2424 Set a flag to accept both correct EtherIP packets and ones
2425 with reversed version field.
2427 This is for backward compatibility with
2429 6.2, 6.3, 7.0, and 7.1.
2430 .It Cm -accept_rev_ethip_ver
2432 .Cm accept_rev_ethip_ver .
2433 .It Cm send_rev_ethip_ver
2434 Set a flag to send EtherIP packets with reversed version
2435 field intentionally.
2436 Disabled by default.
2437 This is for backward compatibility with
2439 6.2, 6.3, 7.0, and 7.1.
2440 .It Cm -send_rev_ethip_ver
2442 .Cm send_rev_ethip_ver .
2445 The following parameters are specific to GRE tunnel interfaces,
2447 .Bl -tag -width indent
2448 .It Cm grekey Ar key
2449 Configure the GRE key to be used for outgoing packets.
2451 .Xr gre 4 will always accept GRE packets with invalid or absent keys.
2452 This command will result in a four byte MTU reduction on the interface.
2455 The following parameters are specific to
2458 .Bl -tag -width indent
2459 .It Cm syncdev Ar iface
2460 Use the specified interface
2461 to send and receive pfsync state synchronisation messages.
2463 Stop sending pfsync state synchronisation messages over the network.
2464 .It Cm syncpeer Ar peer_address
2465 Make the pfsync link point-to-point rather than using
2466 multicast to broadcast the state synchronisation messages.
2467 The peer_address is the IP address of the other host taking part in
2470 Broadcast the packets using multicast.
2472 Set the maximum number of updates for a single state which
2473 can be collapsed into one.
2474 This is an 8-bit number; the default value is 128.
2476 Defer transmission of the first packet in a state until a peer has
2477 acknowledged that the associated state has been inserted.
2479 Do not defer the first packet in a state.
2480 This is the default.
2483 The following parameters are specific to
2486 .Bl -tag -width indent
2487 .It Cm vlan Ar vlan_tag
2488 Set the VLAN tag value to
2490 This value is a 12-bit VLAN Identifier (VID) which is used to create an 802.1Q
2491 VLAN header for packets sent from the
2498 must both be set at the same time.
2499 .It Cm vlandev Ar iface
2500 Associate the physical interface
2505 Packets transmitted through the
2508 diverted to the specified physical interface
2510 with 802.1Q VLAN encapsulation.
2511 Packets with 802.1Q encapsulation received
2512 by the parent interface with the correct VLAN Identifier will be diverted to
2518 interface is assigned a
2519 copy of the parent interface's flags and the parent's Ethernet address.
2524 must both be set at the same time.
2527 interface already has
2528 a physical interface associated with it, this command will fail.
2530 change the association to another physical interface, the existing
2531 association must be cleared first.
2533 Note: if the hardware tagging capability
2534 is set on the parent interface, the
2537 interface's behavior changes:
2540 interface recognizes that the
2541 parent interface supports insertion and extraction of VLAN tags on its
2542 own (usually in firmware) and that it should pass packets to and from
2543 the parent unaltered.
2544 .It Fl vlandev Op Ar iface
2547 pseudo device, disassociate the parent interface from it.
2548 This breaks the link between the
2550 interface and its parent,
2551 clears its VLAN Identifier, flags and its link address and shuts the interface
2555 argument is useless and hence deprecated.
2558 The following parameters are used to configure
2560 protocol on an interface:
2561 .Bl -tag -width indent
2563 Set the virtual host ID.
2564 This is a required setting to initiate
2566 If the virtual host ID does not exist yet, it is created and attached to the
2567 interface, otherwise configuration of an existing vhid is adjusted.
2570 keyword is supplied along with an
2574 address, then this address is configured to be run under control of the
2576 Whenever a last address that refers to a particular vhid is removed from an
2577 interface, the vhid is automatically removed from interface and destroyed.
2578 Any other configuration parameters for the
2580 protocol should be supplied along with the
2583 Acceptable values for vhid are 1 to 255.
2584 .It Cm advbase Ar seconds
2585 Specifies the base of the advertisement interval in seconds.
2586 The acceptable values are 1 to 255.
2587 The default value is 1.
2588 .It Cm advskew Ar interval
2589 Specifies the skew to add to the base advertisement interval to
2590 make one host advertise slower than another host.
2591 It is specified in 1/256 of seconds.
2592 The acceptable values are 1 to 254.
2593 The default value is 0.
2594 .It Cm pass Ar phrase
2595 Set the authentication key to
2597 .It Cm state Ar MASTER|BACKUP
2598 Forcibly change state of a given vhid.
2603 utility displays the current configuration for a network interface
2604 when no optional parameters are supplied.
2605 If a protocol family is specified,
2607 will report only the details specific to that protocol family.
2611 flag is passed before an interface name,
2613 will display the capability list and all
2614 of the supported media for the specified interface.
2617 flag is supplied, address lifetime is displayed for IPv6 addresses,
2618 as time offset string.
2622 flag may be used instead of an interface name.
2625 to display information about all interfaces in the system.
2628 flag limits this to interfaces that are down, and
2630 limits this to interfaces that are up.
2631 When no arguments are given,
2637 flag may be used to list all available interfaces on the system, with
2638 no other additional information.
2641 is specified, only interfaces of that type will be listed.
2643 will list only Ethernet adapters, excluding the loopback interface.
2644 Use of this flag is mutually exclusive
2645 with all other flags and commands, except for
2647 (only list interfaces that are down)
2650 (only list interfaces that are up).
2654 flag may be used to get more verbose status for an interface.
2658 flag may be used to list all of the interface cloners available on
2659 the system, with no additional information.
2660 Use of this flag is mutually exclusive with all other flags and commands.
2664 flag causes keying information for the interface, if available, to be
2666 For example, the values of 802.11 WEP keys and
2668 passphrases will be printed, if accessible to the current user.
2669 This information is not printed by default, as it may be considered
2672 If the network interface driver is not present in the kernel then
2674 will attempt to load it.
2677 flag disables this behavior.
2679 Only the super-user may modify the configuration of a network interface.
2681 Assign the IPv4 address
2683 with a network mask of
2687 .Dl # ifconfig fxp0 inet 192.0.2.10 netmask 255.255.255.0
2689 Add the IPv4 address
2691 with the CIDR network prefix
2697 as a synonym for the canonical form of the option
2699 .Dl # ifconfig ed0 inet 192.0.2.45/28 add
2701 Remove the IPv4 address
2705 .Dl # ifconfig ed0 inet 192.0.2.45 -alias
2707 Enable IPv6 functionality of the interface:
2708 .Dl # ifconfig em0 inet6 -ifdisabled
2710 Add the IPv6 address
2711 .Li 2001:DB8:DBDB::123/48
2714 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias
2715 Note that lower case hexadecimal IPv6 addresses are acceptable.
2717 Remove the IPv6 address added in the above example,
2720 character as shorthand for the network prefix,
2723 as a synonym for the canonical form of the option
2725 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 delete
2727 Configure a single CARP redundant address on igb0, and then switch it
2729 .Dl # ifconfig igb0 vhid 1 10.0.0.1/24 pass foobar up
2730 .Dl # ifconfig igb0 vhid 1 state master
2732 Configure the interface
2734 to use 100baseTX, full duplex Ethernet media options:
2735 .Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex
2737 Label the em0 interface as an uplink:
2738 .Dl # ifconfig em0 description \&"Uplink to Gigabit Switch 2\&"
2740 Create the software network interface
2742 .Dl # ifconfig gif1 create
2744 Destroy the software network interface
2746 .Dl # ifconfig gif1 destroy
2748 Display available wireless networks using
2750 .Dl # ifconfig wlan0 list scan
2752 Messages indicating the specified interface does not exist, the
2753 requested address is unknown, or the user is not privileged and
2754 tried to alter an interface's configuration.
2776 Basic IPv6 node operation requires a link-local address on each
2777 interface configured for IPv6.
2778 Normally, such an address is automatically configured by the
2779 kernel on each interface added to the system or enabled; this behavior may
2780 be disabled by setting per-interface flag
2781 .Cm -auto_linklocal .
2782 The default value of this flag is 1 and can be disabled by using the sysctl
2784 .Va net.inet6.ip6.auto_linklocal .
2786 Do not configure IPv6 addresses with no link-local address by using
2788 It can result in unexpected behaviors of the kernel.
projects / FreeBSD / stable / 10.git / blob