1 .\" Copyright (c) 1983, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 4. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" From: @(#)ifconfig.8 8.3 (Berkeley) 1/5/94
36 .Nd configure network interface parameters
80 utility is used to assign an address
81 to a network interface and/or configure
82 network interface parameters.
85 utility must be used at boot time to define the network address
86 of each interface present on a machine; it may also be used at
87 a later time to redefine an interface's address
88 or other operating parameters.
90 The following options are available:
91 .Bl -tag -width indent
94 .Tn DARPA Ns -Internet
96 the address is either a host name present in the host name data
101 Internet address expressed in the Internet standard
104 It is also possible to use the CIDR notation (also known as the
105 slash notation) to include the netmask.
106 That is, one can specify an address like
111 family, it is also possible to specify the prefix length using the slash
116 parameter below for more information.
117 .\" For the Xerox Network Systems(tm) family,
119 .\" .Ar net:a.b.c.d.e.f ,
122 .\" is the assigned network number (in decimal),
123 .\" and each of the six bytes of the host number,
127 .\" are specified in hexadecimal.
128 .\" The host number may be omitted on IEEE 802 protocol
129 .\" (Ethernet, FDDI, and Token Ring) interfaces,
130 .\" which use the hardware physical address,
131 .\" and on interfaces other than the first.
134 .\" family, addresses are specified as a long hexadecimal string,
135 .\" as in the Xerox family.
136 .\" However, two consecutive dots imply a zero
137 .\" byte, and the dots are optional, if the user wishes to (carefully)
138 .\" count out long strings of digits in network byte order.
143 is specified as a series of colon-separated hex digits.
145 e.g.\& set a new MAC address on an ethernet interface, though the
146 mechanism used is not ethernet-specific.
147 If the interface is already
148 up when this option is used, it will be briefly brought down and
149 then brought back up again in order to ensure that the receive
150 filter in the underlying ethernet hardware is properly reprogrammed.
151 .It Ar address_family
154 which affects interpretation of the remaining parameters.
155 Since an interface can receive transmissions in differing protocols
156 with different naming schemes, specifying the address family is recommended.
157 The address or protocol families currently
176 Specify the address of the correspondent on the other end
177 of a point to point link.
180 parameter is a string of the form
185 List the interfaces in the given group.
188 The following parameters may be set with
190 .Bl -tag -width indent
195 Introduced for compatibility
199 Establish an additional network address for this interface.
200 This is sometimes useful when changing network numbers, and
201 one wishes to accept packets addressed to the old interface.
202 If the address is on the same subnet as the first network address
203 for this interface, a non-conflicting netmask must be given.
208 Remove the network address specified.
209 This would be used if you incorrectly specified an alias, or it
210 was no longer needed.
211 If you have incorrectly set an NS address having the side effect
212 of specifying the host portion, removing all NS addresses will
213 allow you to respecify the host portion.
216 Specify that the address configured is an anycast address.
217 Based on the current specification,
218 only routers may configure anycast addresses.
219 Anycast address will not be used as source address of any of outgoing
222 Enable the use of the Address Resolution Protocol
225 between network level addresses and link level addresses (default).
226 This is currently implemented for mapping between
231 802 48-bit MAC addresses (Ethernet, FDDI, and Token Ring addresses).
233 Disable the use of the Address Resolution Protocol
236 If the Address Resolution Protocol is enabled,
237 the host will only reply to requests for its addresses,
238 and will never send any requests.
240 If the Address Resolution Protocol is enabled,
241 the host will perform normally,
242 sending out requests and listening for replies.
245 Specify the address to use to represent broadcasts to the
247 The default broadcast address is the address with a host part of all 1's.
249 Enable driver dependent debugging code; usually, this turns on
250 extra console error logging.
252 Disable driver dependent debugging code.
254 Put interface into permanently promiscuous mode.
256 Disable permanently promiscuous mode.
264 When an interface is marked
266 the system will not attempt to
267 transmit messages through that interface.
268 If possible, the interface will be reset to disable reception as well.
269 This action does not automatically disable routes using the interface.
270 .It Cm group Ar group-name
271 Assign the interface to a
273 Any interface can be in multiple groups.
275 Cloned interfaces are members of their interface family group by default.
276 For example, a PPP interface such as
278 is a member of the PPP interface family group,
280 .\" The interface(s) the default route(s) point to are members of the
283 .It Cm -group Ar group-name
284 Remove the interface from the given
289 (lowermost 64bit of an IPv6 address)
292 This is used to specify an Internet host who is willing to receive
293 IP packets encapsulating IPX packets bound for a remote network.
294 An apparent point to point link is constructed, and
295 the address specified will be taken as the IPX address and network
297 .It Cm maclabel Ar label
298 If Mandatory Access Control support is enabled in the kernel,
302 .\" .Xr maclabel 7 ) .
304 If the driver supports the media selection system, set the media type
307 Some interfaces support the mutually exclusive use of one of several
308 different physical media connectors.
309 For example, a 10Mbit/s Ethernet
310 interface might support the use of either
312 or twisted pair connectors.
313 Setting the media type to
315 would change the currently active connector to the AUI port.
318 would activate twisted pair.
319 Refer to the interfaces' driver
320 specific documentation or man page for a complete list of the
322 .It Cm mediaopt Ar opts
323 If the driver supports the media selection system, set the specified
324 media options on the interface.
328 is a comma delimited list of options to apply to the interface.
329 Refer to the interfaces' driver specific man page for a complete
330 list of available options.
331 .It Fl mediaopt Ar opts
332 If the driver supports the media selection system, disable the
333 specified media options on the interface.
335 If the driver supports the media selection system, set the specified
336 operating mode on the interface to
338 For IEEE 802.11 wireless interfaces that support multiple operating modes
339 this directive is used to select between 802.11a
346 .It Cm inst Ar minst , Cm instance Ar minst
347 Set the media instance to
349 This is useful for devices which have multiple physical layer interfaces
352 Set the interface name to
354 .It Cm rxcsum , txcsum
355 If the driver supports user-configurable checksum offloading,
356 enable receive (or transmit) checksum offloading on the interface.
357 Some drivers may not be able to enable these flags independently
358 of each other, so setting one may also set the other.
359 The driver will offload as much checksum work as it can reliably
360 support, the exact level of offloading varies between drivers.
361 .It Fl rxcsum , txcsum
362 If the driver supports user-configurable checksum offloading,
363 disable receive (or transmit) checksum offloading on the interface.
364 These settings may not always be independent of each other.
366 If the driver supports
368 segmentation offloading, enable TSO on the interface.
369 Some drivers may not be able to support TSO for
373 packets, so they may enable only one of them.
375 If the driver supports
377 segmentation offloading, disable TSO on the interface.
378 It will always disable TSO for
383 If the driver supports
385 large receive offloading, enable LRO on the interface.
387 If the driver supports
389 large receive offloading, disable LRO on the interface.
390 .It Cm wol , wol_ucast , wol_mcast , wol_magic
391 Enable Wake On Lan (WOL) support, if available.
392 WOL is a facility whereby a machine in a low power state may be woken
393 in response to a received packet.
394 There are three types of packets that may wake a system:
395 ucast (directed solely to the machine's mac address),
396 mcast (directed to a broadcast or multicast address),
398 magic (unicast or multicast frames with a ``magic contents'').
399 Not all devices support WOL, those that do indicate the mechanisms
400 they support in their capabilities.
402 is a synonym for enabling all available WOL mechanisms.
405 .It Cm vlanmtu , vlanhwtag, vlanhwfilter
406 If the driver offers user-configurable VLAN support, enable
407 reception of extended frames, tag processing in hardware, or
408 frame filtering in hardware,
410 Note that this must be issued on a physical interface associated with
415 .It Fl vlanmtu , vlanhwtag, vlanhwfilter
416 If the driver offers user-configurable VLAN support, disable
417 reception of extended frames, tag processing in hardware, or
418 frame filtering in hardware,
421 Move the interface to the
423 specified by name or JID.
424 If the jail has a virtual network stack, the interface will disappear
425 from the current environment and become visible to the jail.
427 Reclaim the interface from the
429 specified by name or JID.
430 If the jail has a virtual network stack, the interface will disappear
431 from the jail, and become visible to the current network environment.
435 feature and disable interrupts on the interface, if driver supports
440 feature and enable interrupt mode on the interface.
442 Create the specified network pseudo-device.
443 If the interface is given without a unit number, try to create a new
444 device with an arbitrary unit number.
445 If creation of an arbitrary device is successful, the new device name is
446 printed to standard output unless the interface is renamed or destroyed
451 Destroy the specified network pseudo-device.
467 Set the routing metric of the interface to
470 The routing metric is used by the routing protocol
472 Higher metrics have the effect of making a route
473 less favorable; metrics are counted as additional hops
474 to the destination network or host.
476 Set the maximum transmission unit of the interface to
478 default is interface specific.
479 The MTU is used to limit the size of packets that are transmitted on an
481 Not all interfaces support setting the MTU, and some interfaces have
483 .It Cm netmask Ar mask
486 Specify how much of the address to reserve for subdividing
487 networks into sub-networks.
488 The mask includes the network part of the local address
489 and the subnet part, which is taken from the host field of the address.
490 The mask can be specified as a single hexadecimal number
493 with a dot-notation Internet address,
494 or with a pseudo-network name listed in the network table
496 The mask contains 1's for the bit positions in the 32-bit address
497 which are to be used for the network and subnet parts,
498 and 0's for the host part.
499 The mask should contain at least the standard network portion,
500 and the subnet field should be contiguous with the network
503 The netmask can also be specified in CIDR notation after the address.
506 option above for more information.
507 .It Cm prefixlen Ar len
511 bits are reserved for subdividing networks into sub-networks.
514 must be integer, and for syntactical reason it must be between 0 to 128.
515 It is almost always 64 under the current IPv6 assignment rule.
516 If the parameter is omitted, 64 is used.
518 The prefix can also be specified using the slash notation after the address.
521 option above for more information.
524 .\" .It Cm nsellength Ar n
527 .\" This specifies a trailing number of bytes for a received
529 .\" used for local identification, the remaining leading part of which is
532 .\" (Network Entity Title).
533 .\" The default value is 1, which is conformant to US
535 .\" When an ISO address is set in an ifconfig command,
538 .\" which is being specified.
541 .\" 20 hex digits should be
544 .\" to be assigned to the interface.
545 .\" There is some evidence that a number different from 1 may be useful
548 .\" 37 type addresses.
549 .It Cm range Ar netrange
550 Under appletalk, set the interface to respond to a
553 .Ar startnet Ns - Ns Ar endnet .
554 Appletalk uses this scheme instead of
557 implements it internally as a set of netmasks.
562 Introduced for compatibility
566 The argument following this specifies the version (phase) of the
567 Appletalk network attached to the interface.
568 Values of 1 or 2 are permitted.
570 .It Cm link Op Cm 0 No - Cm 2
572 Enable special processing of the link level of the interface.
573 These three options are interface specific in actual effect, however,
574 they are in general used to select special modes of operation.
576 of this is to enable SLIP compression, or to select the connector type
577 for some Ethernet cards.
578 Refer to the man page for the specific driver
579 for more information.
581 .It Fl link Op Cm 0 No - Cm 2
583 Disable special processing at the link level with the specified interface.
585 Put the interface in monitor mode.
586 No packets are transmitted, and received packets are discarded after
590 Take the interface out of monitor mode.
594 This may be used to enable an interface after an
596 It happens automatically when setting the first address on an interface.
597 If the interface was reset when previously marked down,
598 the hardware will be re-initialized.
601 The following parameters are specific to cloning
602 IEEE 802.11 wireless interfaces with the
605 .Bl -tag -width indent
606 .It Cm wlandev Ar device
609 as the parent for the cloned device.
610 .It Cm wlanmode Ar mode
611 Specify the operating mode for this cloned device.
629 The operating mode of a cloned interface cannot be changed.
632 mode is actually implemented as an
634 interface with special properties.
635 .It Cm wlanbssid Ar bssid
636 The 802.11 mac address to use for the bssid.
637 This must be specified at create time for a legacy
640 .It Cm wlanaddr Ar address
641 The local mac address.
642 If this is not specified then a mac address will automatically be assigned
643 to the cloned device.
644 Typically this address is the same as the address of the parent device
647 parameter is specified then the driver will craft a unique address for
648 the device (if supported).
652 device as operating in ``legacy mode''.
655 devices have a fixed peer relationship and do not, for example, roam
656 if their peer stops communicating.
657 For completeness a Dynamic WDS (DWDS) interface may marked as
660 Request a unique local mac address for the cloned device.
661 This is only possible if the device supports multiple mac addresses.
662 To force use of the parent's mac address use
665 Mark the cloned interface as depending on hardware support to
666 track received beacons.
667 To have beacons tracked in software use
673 can also be used to indicate no beacons should
674 be transmitted; this can be useful when creating a WDS configuration but
676 interfaces can only be created as companions to an access point.
679 The following parameters are specific to IEEE 802.11 wireless interfaces
683 .Bl -tag -width indent
685 Enable sending and receiving AMPDU frames when using 802.11n (default).
686 The 802.11n specification states a compliant station must be capable
687 of receiving AMPDU frames but transmision is optional.
690 to disable all use of AMPDU with 802.11n.
691 For testing and/or to work around interoperability problems one can use
695 to control use of AMPDU in one direction.
696 .It Cm ampdudensity Ar density
697 Set the AMPDU density parameter used when operating with 802.11n.
698 This parameter controls the inter-packet gap for AMPDU frames.
699 The sending device normally controls this setting but a receiving station
700 may request wider gaps.
703 are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds).
706 is treated the same as 0.
707 .It Cm ampdulimit Ar limit
708 Set the limit on packet size for receiving AMPDU frames when operating
712 are 8192, 16384, 32768, and 65536 but one can also specify
713 just the unique prefix: 8, 16, 32, 64.
714 Note the sender may limit the size of AMPDU frames to be less
715 than the maximum specified by the receiving station.
717 Enable sending and receiving AMSDU frames when using 802.11n.
718 By default AMSDU is received but not transmitted.
721 to disable all use of AMSDU with 802.11n.
722 For testing and/or to work around interoperability problems one can use
726 to control use of AMSDU in one direction.
727 .It Cm amsdulimit Ar limit
728 Set the limit on packet size for sending and receiving AMSDU frames
729 when operating with 802.11n.
732 are 7935 and 3839 (bytes).
733 Note the sender may limit the size of AMSDU frames to be less
734 than the maximum specified by the receiving station.
735 Note also that devices are not required to support the 7935 limit,
736 only 3839 is required by the specification and the larger value
737 may require more memory to be dedicated to support functionality
740 When operating as an access point, pass packets between
741 wireless clients directly (default).
742 To instead let them pass up through the
743 system and be forwarded using some other mechanism, use
745 Disabling the internal bridging
746 is useful when traffic is to be processed with
748 .It Cm authmode Ar mode
749 Set the desired authentication mode in infrastructure mode.
750 Not all adapters support all modes.
753 .Cm none , open , shared
759 (IEEE WPA/WPA2/802.11i).
764 modes are only useful when using an authentication service
765 (a supplicant for client operation or an authenticator when
766 operating as an access point).
767 Modes are case insensitive.
769 Enable background scanning when operating as a station.
770 Background scanning is a technique whereby a station associated to
771 an access point will temporarily leave the channel to scan for
772 neighboring stations.
773 This allows a station to maintain a cache of nearby access points
774 so that roaming between access points can be done without
775 a lengthy scan operation.
776 Background scanning is done only when a station is not busy and
777 any outbound traffic will cancel a scan operation.
778 Background scanning should never cause packets to be lost though
779 there may be some small latency if outbound traffic interrupts a
781 By default background scanning is enabled if the device is capable.
782 To disable background scanning, use
784 Background scanning is controlled by the
789 Background scanning must be enabled for roaming; this is an artifact
790 of the current implementation and may not be required in the future.
791 .It Cm bgscanidle Ar idletime
792 Set the minimum time a station must be idle (not transmitting or
793 receiving frames) before a background scan is initiated.
796 parameter is specified in milliseconds.
797 By default a station must be idle at least 250 milliseconds before
798 a background scan is initiated.
799 The idle time may not be set to less than 100 milliseconds.
800 .It Cm bgscanintvl Ar interval
801 Set the interval at which background scanning is attempted.
804 parameter is specified in seconds.
805 By default a background scan is considered every 300 seconds (5 minutes).
808 may not be set to less than 15 seconds.
809 .It Cm bintval Ar interval
810 Set the interval at which beacon frames are sent when operating in
814 parameter is specified in TU's (1024 usecs).
815 By default beacon frames are transmitted every 100 TU's.
816 .It Cm bmissthreshold Ar count
817 Set the number of consecutive missed beacons at which the station
818 will attempt to roam (i.e., search for a new access point).
821 parameter must be in the range 1 to 255; though the
822 upper bound may be reduced according to device capabilities.
823 The default threshold is 7 consecutive missed beacons; but
824 this may be overridden by the device driver.
829 .It Cm bssid Ar address
830 Specify the MAC address of the access point to use when operating
831 as a station in a BSS network.
832 This overrides any automatic selection done by the system.
833 To disable a previously selected access point, supply
838 This option is useful when more than one access point uses the same SSID.
844 Enable packet bursting.
845 Packet bursting is a transmission technique whereby the wireless
846 medium is acquired once to send multiple frames and the interframe
848 This technique can significantly increase throughput by reducing
849 transmission overhead.
850 Packet bursting is supported by the 802.11e QoS specification
851 and some devices that do not support QoS may still be capable.
852 By default packet bursting is enabled if a device is capable
854 To disable packet bursting, use
856 .It Cm chanlist Ar channels
857 Set the desired channels to use when scanning for access
858 points, neighbors in an IBSS network, or looking for unoccupied
859 channels when operating as an access point.
860 The set of channels is specified as a comma-separated list with
861 each element in the list representing either a single channel number or a range
864 Channel numbers must be in the range 1 to 255 and be permissible
865 according to the operating characteristics of the device.
866 .It Cm channel Ar number
867 Set a single desired channel.
868 Channels range from 1 to 255, but the exact selection available
869 depends on the region your adaptor was manufactured for.
875 will clear any desired channel and, if the device is marked up,
876 force a scan for a channel to operate on.
877 Alternatively the frequency, in megahertz, may be specified
878 instead of the channel number.
880 When there are several ways to use a channel the channel
881 number/frequency may be appended with attributes to clarify.
882 For example, if a device is capable of operating on channel 6
883 with 802.11n and 802.11g then one can specify that g-only use
884 should be used by specifying ``6:g''.
885 Similarly the channel width can be specified by appending it
886 with ``/''; e.g. ``6/40'' specifies a 40MHz wide channel,
887 These attributes can be combined as in: ``6:ht/40''.
888 The full set of flags specified following a `:'' are:
894 (Atheros Dynamic Turbo mode),
902 (Atheros Static Turbo mode),
905 (Atheros Dynamic Turbo mode, or appended to ``st'' and ``dt'').
906 The full set of channel widths following a '/' are:
908 (5MHz aka quarter-rate channel),
910 (10MHz aka half-rate channel),
912 (20MHz mostly for use in specifying ht20),
915 (40MHz mostly for use in specifying ht40),
917 a 40MHz HT channel specification may include the location
918 of the extension channel by appending ``+'' or ``-'' for above and below,
919 respectively; e.g. ``2437:ht/40+'' specifies 40MHz wide HT operation
920 with the center channel at frequency 2437 and the extension channel above.
921 .It Cm country Ar name
922 Set the country code to use in calculating the regulatory constraints
924 In particular the set of available channels, how the wireless device
925 will operation on the channels, and the maximum transmit power that
926 can be used on a channel are defined by this setting.
927 Country/Region codes are specified as a 2-character abbreviation
928 defined by ISO 3166 or using a longer, but possibly ambiguous, spelling;
929 e.g. "ES" and "Spain".
930 The set of country codes are taken from /etc/regdomain.xml and can also
931 be viewed with the ``list countries'' request.
932 Note that not all devices support changing the country code from a default
933 setting; typically stored in EEPROM.
941 Enable Dynamic Frequency Selection (DFS) as specified in 802.11h.
942 DFS embodies several facilities including detection of overlapping
943 radar signals, dynamic transmit power control, and channel selection
944 according to a least-congested criteria.
945 DFS support is mandatory for some 5Ghz frequencies in certain
947 By default DFS is enabled according to the regulatory definitions
948 specified in /etc/regdomain.xml and the curent country code, regdomain,
950 Note the underlying device (and driver) must support radar detection
951 for full DFS support to work.
952 To be fully compliant with the local regulatory agency frequencies that
953 require DFS should not be used unless it is fully supported.
956 to disable this functionality for testing.
958 Enable support for the 802.11d specification (default).
959 When this support is enabled in station mode, beacon frames that advertise
960 a country code different than the currently configured country code will
961 cause an event to be dispatched to user applications.
962 This event can be used by the station to adopt that country code and
963 operate according to the associated regulatory constraints.
964 When operating as an access point with 802.11d enabled the beacon and
965 probe response frames transmitted will advertise the current regulatory
967 To disable 802.11d use
970 Enable 802.11h support including spectrum management.
971 When 802.11h is enabled beacon and probe response frames will have
972 the SpectrumMgt bit set in the capabilities field and
973 country and power constraint information elements will be present.
974 802.11h support also includes handling Channel Switch Announcements (CSA)
975 which are a mechanism to coordinate channel changes by an access point.
976 By default 802.11h is enabled if the device is capable.
977 To disable 802.11h use
979 .It Cm deftxkey Ar index
980 Set the default key to use for transmission.
981 Typically this is only set when using WEP encryption.
982 Note that you must set a default transmit key
983 for the system to know which key to use in encrypting outbound traffic.
986 is an alias for this request; it is provided for backwards compatibility.
987 .It Cm dtimperiod Ar period
990 period for transmitting buffered multicast data frames when
991 operating in ap mode.
994 specifies the number of beacon intervals between DTIM
995 and must be in the range 1 to 15.
996 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
998 Enable the use of Atheros Dynamic Turbo mode when communicating with
999 another Dynamic Turbo-capable station.
1000 Dynamic Turbo mode is an Atheros-specific mechanism by which
1001 stations switch between normal 802.11 operation and a ``boosted''
1002 mode in which a 40MHz wide channel is used for communication.
1003 Stations using Dynamic Turbo mode operate boosted only when the
1004 channel is free of non-dturbo stations; when a non-dturbo station
1005 is identified on the channel all stations will automatically drop
1006 back to normal operation.
1007 By default, Dynamic Turbo mode is not enabled, even if the device is capable.
1008 Note that turbo mode (dynamic or static) is only allowed on some
1009 channels depending on the regulatory constraints; use the
1011 command to identify the channels where turbo mode may be used.
1012 To disable Dynamic Turbo mode use
1015 Enable Dynamic WDS (DWDS) support.
1016 DWDS is a facility by which 4-address traffic can be carried between
1017 stations operating in infrastructure mode.
1018 A station first associates to an access point and authenticates using
1019 normal procedures (e.g. WPA).
1020 Then 4-address frames are passed to carry traffic for stations
1021 operating on either side of the wireless link.
1022 DWDS extends the normal WDS mechanism by leveraging existing security
1023 protocols and eliminating static binding.
1025 When DWDS is enabled on an access point 4-address frames received from
1026 an authorized station will generate a ``DWDS discovery'' event to user
1028 This event should be used to create a WDS interface that is bound
1029 to the remote station (and usually plumbed into a bridge).
1030 Once the WDS interface is up and running 4-address traffic then logically
1031 flows through that interface.
1033 When DWDS is enabled on a station, traffic with a destination address
1034 different from the peer station are encapsulated in a 4-address frame
1035 and transmitted to the peer.
1036 All 4-address traffic uses the security information of the stations
1037 (e.g. cryptographic keys).
1038 A station is associated using 802.11n facilities may transport
1039 4-address traffic using these same mechanisms; this depends on available
1040 resources and capabilities of the device.
1041 The DWDS implementation guards against layer 2 routing loops of
1044 Enable the use of Atheros Fast Frames when communicating with
1045 another Fast Frames-capable station.
1046 Fast Frames are an encapsulation technique by which two 802.3
1047 frames are transmitted in a single 802.11 frame.
1048 This can noticeably improve throughput but requires that the
1049 receiving station understand how to decapsulate the frame.
1050 Fast frame use is negotiated using the Atheros 802.11 vendor-specific
1051 protocol extension so enabling use is safe when communicating with
1052 non-Atheros devices.
1053 By default, use of fast frames is enabled if the device is capable.
1054 To explicitly disable fast frames, use
1056 .It Cm fragthreshold Ar length
1057 Set the threshold for which transmitted frames are broken into fragments.
1060 argument is the frame size in bytes and must be in the range 256 to 2346.
1068 disables transmit fragmentation.
1069 Not all adapters honor the fragmentation threshold.
1071 When operating as an access point, do not broadcast the SSID
1072 in beacon frames or respond to probe request frames unless
1073 they are directed to the ap (i.e., they include the ap's SSID).
1074 By default, the SSID is included in beacon frames and
1075 undirected probe request frames are answered.
1076 To re-enable the broadcast of the SSID etc., use
1079 Enable use of High Throughput (HT) when using 802.11n (default).
1080 The 802.11n specification includes mechanisms for operation
1081 on 20MHz and 40MHz wide channels using different signalling mechanisms
1082 than specified in 802.11b, 802.11g, and 802.11a.
1083 Stations negotiate use of these facilities, termed HT20 and HT40,
1084 when they associate.
1085 To disable all use of 802.11n use
1087 To disable use of HT20 (e.g. to force only HT40 use) use
1089 To disable use of HT40 use
1092 HT configuration is used to ``auto promote'' operation
1093 when several choices are available.
1094 For example, if a station associates to an 11n-capable access point
1095 it controls whether the station uses legacy operation, HT20, or HT40.
1096 When an 11n-capable device is setup as an access point and
1097 Auto Channel Selection is used to locate a channel to operate on,
1098 HT configuration controls whether legacy, HT20, or HT40 operation is setup
1099 on the selected channel.
1100 If a fixed channel is specified for a station then HT configuration can
1101 be given as part of the channel specification; e.g. 6:ht/20 to setup
1102 HT20 operation on channel 6.
1104 Enable use of compatibility support for pre-802.11n devices (default).
1105 The 802.11n protocol specification went through several incompatible iterations.
1106 Some vendors implemented 11n support to older specifications that
1107 will not interoperate with a purely 11n-compliant station.
1108 In particular the information elements included in management frames
1109 for old devices are different.
1110 When compatibility support is enabled both standard and compatible data
1112 Stations that associate using the compatiblity mechanisms are flagged
1114 To disable compatiblity support use
1116 .It Cm htprotmode Ar technique
1117 For interfaces operating in 802.11n, use the specified
1119 for protecting HT frames in a mixed legacy/HT network.
1120 The set of valid techniques is
1125 Technique names are case insensitive.
1127 Enable inactivity processing for stations associated to an
1128 access point (default).
1129 When operating as an access point the 802.11 layer monitors
1130 the activity of each associated station.
1131 When a station is inactive for 5 minutes it will send several
1132 ``probe frames'' to see if the station is still present.
1133 If no response is received then the station is deauthenticated.
1134 Applications that prefer to handle this work can disable this
1138 Set the location to use in calculating regulatory constraints.
1139 The location is also advertised in beacon and probe response frames
1140 when 802.11d is enabled with
1149 Display the list of channels available for use taking into account
1150 any restrictions set with the
1153 See the description of
1155 for more information.
1157 Display the adaptor's capabilities, including the operating
1160 Display the list of channels available for use.
1161 Channels are shown with their IEEE channel number, equivalent
1162 frequency, and usage modes.
1163 Channels identified as
1168 Channels identified as
1170 may be used only for Atheros' Static Turbo mode
1172 . Cm mediaopt turbo ) .
1173 Channels marked with a
1175 have a regulatory constraint that they be passively scanned.
1176 This means a station is not permitted to transmit on the channel until
1177 it identifies the channel is being used for 802.11 communication;
1178 typically by hearing a beacon frame from an access point operating
1181 is another way of requesting this information.
1182 By default a compacted list of channels is displayed; if the
1184 option is specified then all channels are shown.
1185 .It Cm list countries
1186 Display the set of country codes and regulatory domains that can be
1187 used in regulatory configuration.
1189 Display the current MAC Access Control List state.
1190 Each address is prefixed with a character that indicates the
1191 current policy applied to it:
1193 indicates the address is allowed access,
1195 indicates the address is denied access,
1197 indicates the address is present but the current policy open
1198 (so the ACL is not consulted).
1200 Displays the mesh routing table, used for forwarding packets on a mesh
1202 .It Cm list regdomain
1203 Display the current regulatory settings including the available channels
1204 and transmit power caps.
1206 Display the parameters that govern roaming operation.
1208 Display the parameters that govern transmit operation.
1210 Display the transmit power caps for each channel.
1212 Display the access points and/or ad-hoc neighbors
1213 located in the vicinity.
1214 This information may be updated automatically by the adapter
1217 request or through background scanning.
1218 Depending on the capabilities of the stations the following
1219 flags can be included in the output:
1223 Indicates that the station is permitted to send/receive data frames.
1225 Extended Rate Phy (ERP).
1226 Indicates that the station is operating in an 802.11g network
1227 using extended transmit rates.
1229 High Throughput (HT).
1230 Indicates that the station is using HT transmit rates.
1231 If a `+' follows immediately after then the station associated
1232 using deprecated mechanisms supported only when
1237 Indicates that the station is operating in power save mode.
1239 Quality of Service (QoS).
1240 Indicates that the station is using QoS encapsulation for
1242 QoS encapsulation is enabled only when WME mode is enabled.
1244 Transitional Security Network (TSN).
1245 Indicates that the station associated using TSN; see also
1249 Wi-Fi Protected Setup (WPS).
1250 Indicates that the station associated using WPS.
1253 By default interesting information elements captured from the neighboring
1254 stations are displayed at the end of each row.
1255 Possible elements include:
1257 (station supports WME),
1259 (station supports WPA),
1261 (station supports WPS),
1263 (station supports 802.11i/RSN),
1265 (station supports 802.11n/HT communication),
1267 (station supports Atheros protocol extensions),
1269 (station supports unknown vendor-specific extensions).
1272 flag is used all the information elements and their
1273 contents will be shown.
1276 flag also enables display of long SSIDs.
1279 command is another way of requesting this information.
1281 When operating as an access point display the stations that are
1282 currently associated.
1283 When operating in ad-hoc mode display stations identified as
1284 neighbors in the IBSS.
1285 When operating in mesh mode display stations identified as
1286 neighbors in the MBSS.
1287 When operating in station mode display the access point.
1288 Capabilities advertised by the stations are described under
1292 Depending on the capabilities of the stations the following
1293 flags can be included in the output:
1297 Indicates that the station is permitted to send/receive data frames.
1299 Extended Rate Phy (ERP).
1300 Indicates that the station is operating in an 802.11g network
1301 using extended transmit rates.
1303 High Throughput (HT).
1304 Indicates that the station is using HT transmit rates.
1305 If a `+' follows immediately after then the station associated
1306 using deprecated mechanisms supported only when
1311 Indicates that the station is operating in power save mode.
1313 Quality of Service (QoS).
1314 Indicates that the station is using QoS encapsulation for
1316 QoS encapsulation is enabled only when WME mode is enabled.
1318 Transitional Security Network (TSN).
1319 Indicates that the station associated using TSN; see also
1323 Wi-Fi Protected Setup (WPS).
1324 Indicates that the station associated using WPS.
1327 By default information elements received from associated stations
1328 are displayed in a short form; the
1330 flag causes this information to be displayed symbolically.
1332 Display the current channel parameters to use when operating in WME mode.
1335 option is specified then both channel and BSS parameters are displayed
1336 for each AC (first channel, then BSS).
1337 When WME mode is enabled for an adaptor this information will be
1338 displayed with the regular status; this command is mostly useful
1339 for examining parameters when WME mode is disabled.
1340 See the description of the
1342 directive for information on the various parameters.
1343 .It Cm maxretry Ar count
1344 Set the maximum number of tries to use in sending unicast frames.
1345 The default setting is 6 but drivers may override this with a value
1347 .It Cm mcastrate Ar rate
1348 Set the rate for transmitting multicast/broadcast frames.
1349 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
1350 This rate should be valid for the current operating conditions;
1351 if an invalid rate is specified drivers are free to chose an
1353 .It Cm mgtrate Ar rate
1354 Set the rate for transmitting management and/or control frames.
1355 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
1357 Set the location to use in calculating regulatory constraints.
1358 The location is also advertised in beacon and probe response frames
1359 when 802.11d is enabled with
1368 Enable powersave operation.
1369 When operating as a client, the station will conserve power by
1370 periodically turning off the radio and listening for
1371 messages from the access point telling it there are packets waiting.
1372 The station must then retrieve the packets.
1373 Not all devices support power save operation as a client.
1374 The 802.11 specification requires that all access points support
1375 power save but some drivers do not.
1378 to disable powersave operation when operating as a client.
1379 .It Cm powersavesleep Ar sleep
1380 Set the desired max powersave sleep time in TU's (1024 usecs).
1381 By default the max powersave sleep time is 100 TU's.
1382 .It Cm protmode Ar technique
1383 For interfaces operating in 802.11g, use the specified
1385 for protecting OFDM frames in a mixed 11b/11g network.
1386 The set of valid techniques is
1392 Technique names are case insensitive.
1393 Not all devices support
1395 as a protection technique.
1397 When operating as an access point in 802.11g mode allow only
1398 11g-capable stations to associate (11b-only stations are not
1399 permitted to associate).
1400 To allow both 11g and 11b-only stations to associate, use
1403 When operating as an access point in 802.11n mode allow only
1404 HT-capable stations to associate (legacy stations are not
1405 permitted to associate).
1406 To allow both HT and legacy stations to associate, use
1408 .It Cm regdomain Ar sku
1409 Set the regulatory domain to use in calculating the regulatory constraints
1411 In particular the set of available channels, how the wireless device
1412 will operation on the channels, and the maximum transmit power that
1413 can be used on a channel are defined by this setting.
1414 Regdomain codes (SKU's) are taken from /etc/regdomain.xml and can also
1415 be viewed with the ``list countries'' request.
1416 Note that not all devices support changing the regdomain from a default
1417 setting; typically stored in EEPROM.
1425 Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n
1427 Note that RIFS must be supported by both the station and access point
1431 .It Cm roam:rate Ar rate
1432 Set the threshold for controlling roaming when operating in a BSS.
1435 parameter specifies the transmit rate in megabits
1436 at which roaming should be considered.
1437 If the current transmit rate drops below this setting and background scanning
1438 is enabled, then the system will check if a more desirable access point is
1439 available and switch over to it.
1440 The current scan cache contents are used if they are considered
1441 valid according to the
1443 parameter; otherwise a background scan operation is triggered before
1444 any selection occurs.
1445 Each channel type has a separate rate threshold; the default values are:
1446 12 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng).
1447 .It Cm roam:rssi Ar rssi
1448 Set the threshold for controlling roaming when operating in a BSS.
1451 parameter specifies the receive signal strength in dBm units
1452 at which roaming should be considered.
1453 If the current rssi drops below this setting and background scanning
1454 is enabled, then the system will check if a more desirable access point is
1455 available and switch over to it.
1456 The current scan cache contents are used if they are considered
1457 valid according to the
1459 parameter; otherwise a background scan operation is triggered before
1460 any selection occurs.
1461 Each channel type has a separate rssi threshold; the default values are
1463 .It Cm roaming Ar mode
1464 When operating as a station, control how the system will
1465 behave when communication with the current access point
1469 argument may be one of
1471 (leave it to the hardware device to decide),
1473 (handle either in the device or the operating system\[em]as appropriate),
1475 (do nothing until explicitly instructed).
1476 By default, the device is left to handle this if it is
1477 capable; otherwise, the operating system will automatically
1478 attempt to reestablish communication.
1479 Manual mode is used by applications such as
1480 .Xr wpa_supplicant 8
1481 that want to control the selection of an access point.
1482 .It Cm rtsthreshold Ar length
1483 Set the threshold for which
1484 transmitted frames are preceded by transmission of an
1490 is the frame size in bytes and must be in the range 1 to 2346.
1498 disables transmission of RTS frames.
1499 Not all adapters support setting the RTS threshold.
1501 Initiate a scan of neighboring stations, wait for it to complete, and
1502 display all stations found.
1503 Only the super-user can initiate a scan.
1506 for information on the display.
1507 By default a background scan is done; otherwise a foreground
1508 scan is done and the station may roam to a different access point.
1511 request can be used to show recent scan results without
1512 initiating a new scan.
1513 .It Cm scanvalid Ar threshold
1514 Set the maximum time the scan cache contents are considered valid;
1515 i.e. will be used without first triggering a scan operation to
1519 parameter is specified in seconds and defaults to 60 seconds.
1520 The minimum setting for
1523 One should take care setting this threshold; if it is set too low
1524 then attempts to roam to another access point may trigger unnecessary
1525 background scan operations.
1527 Enable use of Short Guard Interval when operating in 802.11n
1529 NB: this currently enables Short GI on both HT40 and HT20 channels.
1530 To disable Short GI use
1533 Enable use of Static Spatial Multiplexing Power Save (SMPS)
1534 when operating in 802.11n.
1535 A station operating with Static SMPS maintains only a single
1536 receive chain active (this can significantly reduce power consumption).
1540 Enable use of Dynamic Spatial Multiplexing Power Save (SMPS)
1541 when operating in 802.11n.
1542 A station operating with Dynamic SMPS maintains only a single
1543 receive chain active but switches to multiple receive chains when it
1544 receives an RTS frame (this can significantly reduce power consumption).
1545 Note that stations cannot distinguish between RTS/CTS intended to
1546 enable multiple receive chains and those used for other purposes.
1550 Set the desired Service Set Identifier (aka network name).
1551 The SSID is a string up to 32 characters
1552 in length and may be specified as either a normal string or in
1553 hexadecimal when preceded by
1555 Additionally, the SSID may be cleared by setting it to
1557 .It Cm tdmaslot Ar slot
1558 When operating with TDMA, use the specified
1563 is a number between 0 and the maximum number of slots in the BSS.
1564 Note that a station configured as slot 0 is a master and
1565 will broadcast beacon frames advertising the BSS;
1566 stations configured to use other slots will always
1567 scan to locate a master before they ever transmit.
1571 .It Cm tdmaslotcnt Ar cnt
1572 When operating with TDMA, setup a BSS with
1575 The slot count may be at most 8.
1576 The current implementation is only tested with two stations
1577 (i.e. point to point applications).
1578 This setting is only meaningful when a station is configured as slot 0;
1579 other stations adopt this setting from the BSS they join.
1583 .It Cm tdmaslotlen Ar len
1584 When operating with TDMA, setup a BSS such that each station has a slot
1587 The slot length must be at least 150 microseconds (1/8 TU)
1588 and no more than 65 milliseconds.
1589 Note that setting too small a slot length may result in poor channel
1590 bandwidth utilization due to factors such as timer granularity and
1592 This setting is only meaningful when a station is configured as slot 0;
1593 other stations adopt this setting from the BSS they join.
1596 is set to 10 milliseconds.
1597 .It Cm tdmabintval Ar intval
1598 When operating with TDMA, setup a BSS such that beacons are transmitted every
1600 superframes to synchronize the TDMA slot timing.
1601 A superframe is defined as the number of slots times the slot length; e.g.
1602 a BSS with two slots of 10 milliseconds has a 20 millisecond superframe.
1603 The beacon interval may not be zero.
1606 causes the timers to be resynchronized more often; this can be help if
1607 significant timer drift is observed.
1612 When operating as an access point with WPA/802.11i allow legacy
1613 stations to associate using static key WEP and open authentication.
1614 To disallow legacy station use of WEP, use
1616 .It Cm txpower Ar power
1617 Set the power used to transmit frames.
1620 argument is specified in .5 dBm units.
1621 Out of range values are truncated.
1622 Typically only a few discreet power settings are available and
1623 the driver will use the setting closest to the specified value.
1624 Not all adapters support changing the transmit power.
1625 .It Cm ucastrate Ar rate
1626 Set a fixed rate for transmitting unicast frames.
1627 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
1628 This rate should be valid for the current operating conditions;
1629 if an invalid rate is specified drivers are free to chose an
1631 .It Cm wepmode Ar mode
1632 Set the desired WEP mode.
1633 Not all adapters support all modes.
1634 The set of valid modes is
1640 mode explicitly tells the adaptor to allow association with access
1641 points which allow both encrypted and unencrypted traffic.
1644 means that the access point must only allow encrypted connections.
1647 is generally another name for
1649 Modes are case insensitive.
1650 .It Cm weptxkey Ar index
1651 Set the WEP key to be used for transmission.
1652 This is the same as setting the default transmission key with
1654 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
1655 Set the selected WEP key.
1658 is not given, key 1 is set.
1659 A WEP key will be either 5 or 13
1660 characters (40 or 104 bits) depending of the local network and the
1661 capabilities of the adaptor.
1662 It may be specified either as a plain
1663 string or as a string of hexadecimal digits preceded by
1665 For maximum portability, hex keys are recommended;
1666 the mapping of text keys to WEP encryption is usually driver-specific.
1669 drivers do this mapping differently to
1671 A key may be cleared by setting it to
1673 If WEP is supported then there are at least four keys.
1674 Some adapters support more than four keys.
1675 If that is the case, then the first four keys
1676 (1-4) will be the standard temporary keys and any others will be adaptor
1677 specific keys such as permanent keys stored in NVRAM.
1679 Note that you must set a default transmit key with
1681 for the system to know which key to use in encrypting outbound traffic.
1683 Enable Wireless Multimedia Extensions (WME) support, if available,
1684 for the specified interface.
1685 WME is a subset of the IEEE 802.11e standard to support the
1686 efficient communication of realtime and multimedia data.
1687 To disable WME support, use
1689 Another name for this parameter is
1692 The following parameters are meaningful only when WME support is in use.
1693 Parameters are specified per-AC (Access Category) and
1694 split into those that are used by a station when acting
1695 as an access point and those for client stations in the BSS.
1696 The latter are received from the access point and may not be changed
1698 The following Access Categories are recognized:
1700 .Bl -tag -width ".Cm AC_BK" -compact
1704 best effort delivery,
1719 AC parameters are case-insensitive.
1720 Traffic classification is done in the operating system using the
1721 vlan priority associated with data frames or the
1722 ToS (Type of Service) indication in IP-encapsulated frames.
1723 If neither information is present, traffic is assigned to the
1724 Best Effort (BE) category.
1725 .Bl -tag -width indent
1727 Set the ACK policy for QoS transmissions by the local station;
1728 this controls whether or not data frames transmitted by a station
1729 require an ACK response from the receiving station.
1730 To disable waiting for an ACK use
1732 This parameter is applied only to the local station.
1734 Enable the Admission Control Mandatory (ACM) mechanism
1735 for transmissions by the local station.
1736 To disable the ACM use
1738 On stations in a BSS this parameter is read-only and indicates
1739 the setting received from the access point.
1740 NB: ACM is not supported right now.
1741 .It Cm aifs Ar ac Ar count
1742 Set the Arbitration Inter Frame Spacing (AIFS)
1743 channel access parameter to use for transmissions
1744 by the local station.
1745 On stations in a BSS this parameter is read-only and indicates
1746 the setting received from the access point.
1747 .It Cm cwmin Ar ac Ar count
1748 Set the CWmin channel access parameter to use for transmissions
1749 by the local station.
1750 On stations in a BSS this parameter is read-only and indicates
1751 the setting received from the access point.
1752 .It Cm cwmax Ar ac Ar count
1753 Set the CWmax channel access parameter to use for transmissions
1754 by the local station.
1755 On stations in a BSS this parameter is read-only and indicates
1756 the setting received from the access point.
1757 .It Cm txoplimit Ar ac Ar limit
1758 Set the Transmission Opportunity Limit channel access parameter
1759 to use for transmissions by the local station.
1760 This parameter defines an interval of time when a WME station
1761 has the right to initiate transmissions onto the wireless medium.
1762 On stations in a BSS this parameter is read-only and indicates
1763 the setting received from the access point.
1764 .It Cm bss:aifs Ar ac Ar count
1765 Set the AIFS channel access parameter to send to stations in a BSS.
1766 This parameter is meaningful only when operating in ap mode.
1767 .It Cm bss:cwmin Ar ac Ar count
1768 Set the CWmin channel access parameter to send to stations in a BSS.
1769 This parameter is meaningful only when operating in ap mode.
1770 .It Cm bss:cwmax Ar ac Ar count
1771 Set the CWmax channel access parameter to send to stations in a BSS.
1772 This parameter is meaningful only when operating in ap mode.
1773 .It Cm bss:txoplimit Ar ac Ar limit
1774 Set the TxOpLimit channel access parameter to send to stations in a BSS.
1775 This parameter is meaningful only when operating in ap mode.
1778 Enable Wireless Privacy Subscriber support.
1779 Note that WPS support requires a WPS-capable supplicant.
1780 To disable this function use
1784 The following parameters support an optional access control list
1785 feature available with some adapters when operating in ap mode; see
1787 This facility allows an access point to accept/deny association
1788 requests based on the MAC address of the station.
1789 Note that this feature does not significantly enhance security
1790 as MAC address spoofing is easy to do.
1791 .Bl -tag -width indent
1792 .It Cm mac:add Ar address
1793 Add the specified MAC address to the database.
1794 Depending on the policy setting association requests from the
1795 specified station will be allowed or denied.
1797 Set the ACL policy to permit association only by
1798 stations registered in the database.
1799 .It Cm mac:del Ar address
1800 Delete the specified MAC address from the database.
1802 Set the ACL policy to deny association only by
1803 stations registered in the database.
1804 .It Cm mac:kick Ar address
1805 Force the specified station to be deauthenticated.
1806 This typically is done to block a station after updating the
1809 Set the ACL policy to allow all stations to associate.
1811 Delete all entries in the database.
1813 Set the ACL policy to permit association only by
1814 stations approved by a RADIUS server.
1815 Note that this feature requires the
1817 program be configured to do the right thing
1818 as it handles the RADIUS processing
1819 (and marks stations as authorized).
1822 The following parameters are related to a wireless interface operating in mesh
1824 .Bl -tag -width indent
1825 .It Cm meshid Ar meshid
1826 Set the desired Mesh Identifier.
1827 The Mesh ID is a string up to 32 characters in length.
1828 A mesh interface must have a Mesh Identifier specified
1829 to reach an operational state.
1830 .It Cm meshttl Ar ttl
1831 Set the desired ``time to live'' for mesh forwarded packets;
1832 this is the number of hops a packet may be forwarded before
1834 The default setting for
1838 Enable or disable peering with neighbor mesh stations.
1839 Stations must peer before any data packets can be exchanged.
1844 Enable or disable forwarding packets by a mesh interface.
1848 .It Cm meshmetric Ar protocol
1851 as the link metric protocol used on a mesh network.
1852 The default protocol is called
1854 The mesh interface will restart after changing this setting.
1855 .It Cm meshpath Ar protocol
1858 as the path selection protocol used on a mesh network.
1859 The only available protocol at the moment is called
1861 (Hybrid Wireless Mesh Protocol).
1862 The mesh interface will restart after changing this setting.
1863 .It Cm hwmprootmode Ar mode
1864 Stations on a mesh network can operate as ``root nodes.''
1865 Root nodes try to find paths to all mesh nodes and advertise themselves
1867 When there is a root mesh node on a network, other mesh nodes can setup
1868 paths between themselves faster because they can use the root node
1869 to find the destination.
1870 This path may not be the best, but on-demand
1871 routing will eventually find the best path.
1872 The following modes are recognized:
1874 .Bl -tag -width ".Cm PROACTIVE" -compact
1878 Send broadcast path requests every two seconds.
1879 Nodes on the mesh without a path to this root mesh station with try to
1880 discover a path to us.
1882 Send broadcast path requests every two seconds and every node must reply with
1883 with a path reply even if it already has a path to this root mesh station,
1885 Send broadcast root annoucement (RANN) frames.
1886 Nodes on the mesh without a path to this root mesh station with try to
1887 discover a path to us.
1893 .It Cm hwmpmaxhops Ar cnt
1894 Set the maximum number of hops allowed in an HMWP path to
1896 The default setting for
1901 The following parameters are for compatibility with other systems:
1902 .Bl -tag -width indent
1904 Another name for the
1910 .It Cm stationname Ar name
1911 Set the name of this station.
1912 The station name is not part of the IEEE 802.11
1913 protocol though some interfaces support it.
1915 seems to be meaningful to identical or virtually identical equipment.
1916 Setting the station name is identical in syntax to setting the SSID.
1923 Another way of saying
1929 Another way of saying
1935 Another way of saying:
1936 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
1942 .Ar n : k1 , k2 , k3 , k4
1945 Another way of saying
1946 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
1951 Another way of saying
1958 The following parameters are specific to bridge interfaces:
1959 .Bl -tag -width indent
1960 .It Cm addm Ar interface
1961 Add the interface named by
1963 as a member of the bridge.
1964 The interface is put into promiscuous mode
1965 so that it can receive every packet sent on the network.
1966 .It Cm deletem Ar interface
1967 Remove the interface named by
1970 Promiscuous mode is disabled on the interface when
1971 it is removed from the bridge.
1972 .It Cm maxaddr Ar size
1973 Set the size of the bridge address cache to
1975 The default is 100 entries.
1976 .It Cm timeout Ar seconds
1977 Set the timeout of address cache entries to
1982 is zero, then address cache entries will not be expired.
1983 The default is 240 seconds.
1985 Display the addresses that have been learned by the bridge.
1986 .It Cm static Ar interface-name Ar address
1987 Add a static entry into the address cache pointing to
1988 .Ar interface-name .
1989 Static entries are never aged out of the cache or re-placed, even if the
1990 address is seen on a different interface.
1991 .It Cm deladdr Ar address
1994 from the address cache.
1996 Delete all dynamically-learned addresses from the address cache.
1998 Delete all addresses, including static addresses, from the address cache.
1999 .It Cm discover Ar interface
2000 Mark an interface as a
2003 When the bridge has no address cache entry
2004 (either dynamic or static)
2005 for the destination address of a packet,
2006 the bridge will forward the packet to all
2007 member interfaces marked as
2009 This is the default for all interfaces added to a bridge.
2010 .It Cm -discover Ar interface
2013 attribute on a member interface.
2014 For packets without the
2016 attribute, the only packets forwarded on the interface are broadcast
2017 or multicast packets and packets for which the destination address
2018 is known to be on the interface's segment.
2019 .It Cm learn Ar interface
2020 Mark an interface as a
2023 When a packet arrives on such an interface, the source
2024 address of the packet is entered into the address cache as being a
2025 destination address on the interface's segment.
2026 This is the default for all interfaces added to a bridge.
2027 .It Cm -learn Ar interface
2030 attribute on a member interface.
2031 .It Cm sticky Ar interface
2032 Mark an interface as a
2035 Dynamically learned address entries are treated at static once entered into
2037 Sticky entries are never aged out of the cache or replaced, even if the
2038 address is seen on a different interface.
2039 .It Cm -sticky Ar interface
2042 attribute on a member interface.
2043 .It Cm private Ar interface
2044 Mark an interface as a
2047 A private interface does not forward any traffic to any other port that is also
2048 a private interface.
2049 .It Cm -private Ar interface
2052 attribute on a member interface.
2053 .It Cm span Ar interface
2054 Add the interface named by
2056 as a span port on the bridge.
2057 Span ports transmit a copy of every frame received by the bridge.
2058 This is most useful for snooping a bridged network passively on
2059 another host connected to one of the span ports of the bridge.
2060 .It Cm -span Ar interface
2061 Delete the interface named by
2063 from the list of span ports of the bridge.
2064 .It Cm stp Ar interface
2065 Enable Spanning Tree protocol on
2069 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
2070 Spanning Tree is used to detect and remove loops in a network topology.
2071 .It Cm -stp Ar interface
2072 Disable Spanning Tree protocol on
2074 This is the default for all interfaces added to a bridge.
2075 .It Cm edge Ar interface
2079 An edge port connects directly to end stations cannot create bridging
2080 loops in the network, this allows it to transition straight to forwarding.
2081 .It Cm -edge Ar interface
2082 Disable edge status on
2084 .It Cm autoedge Ar interface
2087 to automatically detect edge status.
2088 This is the default for all interfaces added to a bridge.
2089 .It Cm -autoedge Ar interface
2090 Disable automatic edge status on
2092 .It Cm ptp Ar interface
2095 as a point to point link.
2096 This is required for straight transitions to forwarding and
2097 should be enabled on a direct link to another RSTP capable switch.
2098 .It Cm -ptp Ar interface
2099 Disable point to point link status on
2101 This should be disabled for a half duplex link and for an interface
2102 connected to a shared network segment,
2103 like a hub or a wireless network.
2104 .It Cm autoptp Ar interface
2105 Automatically detect the point to point status on
2107 by checking the full duplex link status.
2108 This is the default for interfaces added to the bridge.
2109 .It Cm -autoptp Ar interface
2110 Disable automatic point to point link detection on
2112 .It Cm maxage Ar seconds
2113 Set the time that a Spanning Tree protocol configuration is valid.
2114 The default is 20 seconds.
2115 The minimum is 6 seconds and the maximum is 40 seconds.
2116 .It Cm fwddelay Ar seconds
2117 Set the time that must pass before an interface begins forwarding
2118 packets when Spanning Tree is enabled.
2119 The default is 15 seconds.
2120 The minimum is 4 seconds and the maximum is 30 seconds.
2121 .It Cm hellotime Ar seconds
2122 Set the time between broadcasting of Spanning Tree protocol
2123 configuration messages.
2124 The hello time may only be changed when operating in legacy stp mode.
2125 The default is 2 seconds.
2126 The minimum is 1 second and the maximum is 2 seconds.
2127 .It Cm priority Ar value
2128 Set the bridge priority for Spanning Tree.
2129 The default is 32768.
2130 The minimum is 0 and the maximum is 61440.
2131 .It Cm proto Ar value
2132 Set the Spanning Tree protocol.
2133 The default is rstp.
2134 The available options are stp and rstp.
2135 .It Cm holdcnt Ar value
2136 Set the transmit hold count for Spanning Tree.
2137 This is the number of packets transmitted before being rate limited.
2139 The minimum is 1 and the maximum is 10.
2140 .It Cm ifpriority Ar interface Ar value
2141 Set the Spanning Tree priority of
2146 The minimum is 0 and the maximum is 240.
2147 .It Cm ifpathcost Ar interface Ar value
2148 Set the Spanning Tree path cost of
2152 The default is calculated from the link speed.
2153 To change a previously selected path cost back to automatic, set the
2155 The minimum is 1 and the maximum is 200000000.
2156 .It Cm ifmaxaddr Ar interface Ar size
2157 Set the maximum number of hosts allowed from an interface, packets with unknown
2158 source addresses are dropped until an existing host cache entry expires or is
2160 Set to 0 to disable.
2163 The following parameters are specific to lagg interfaces:
2164 .Bl -tag -width indent
2165 .It Cm laggport Ar interface
2166 Add the interface named by
2168 as a port of the aggregation interface.
2169 .It Cm -laggport Ar interface
2170 Remove the interface named by
2172 from the aggregation interface.
2173 .It Cm laggproto Ar proto
2174 Set the aggregation protocol.
2175 The default is failover.
2176 The available options are failover, fec, lacp, loadbalance, roundrobin and
2180 The following parameters are specific to IP tunnel interfaces,
2182 .Bl -tag -width indent
2183 .It Cm tunnel Ar src_addr dest_addr
2184 Configure the physical source and destination address for IP tunnel
2190 are interpreted as the outer source/destination for the encapsulating
2193 Unconfigure the physical source and destination address for IP tunnel
2194 interfaces previously configured with
2197 Another name for the
2200 .It Cm accept_rev_ethip_ver
2201 Set a flag to acccept both correct EtherIP packets and ones
2202 with reversed version field. Enabled by default.
2203 This is for backward compatibility with
2205 6.2, 6.3, 7.0, and 7.1.
2206 .It Cm -accept_rev_ethip_ver
2208 .Cm accept_rev_ethip_ver .
2209 .It Cm send_rev_ethip_ver
2210 Set a flag to send EtherIP packets with reversed version
2211 field intentionally. Disabled by default.
2212 This is for backward compatibility with
2214 6.2, 6.3, 7.0, and 7.1.
2215 .It Cm -send_rev_ethip_ver
2217 .Cm send_rev_ethip_ver .
2220 The following parameters are specific to GRE tunnel interfaces,
2222 .Bl -tag -width indent
2223 .It Cm grekey Ar key
2224 Configure the GRE key to be used for outgoing packets.
2226 .Xr gre 4 will always accept GRE packets with invalid or absent keys.
2227 This command will result in a four byte MTU reduction on the interface.
2230 The following parameters are specific to
2233 .Bl -tag -width indent
2235 Set the maximum number of updates for a single state which
2236 can be collapsed into one.
2237 This is an 8-bit number; the default value is 128.
2240 The following parameters are specific to
2243 .Bl -tag -width indent
2244 .It Cm vlan Ar vlan_tag
2245 Set the VLAN tag value to
2247 This value is a 16-bit number which is used to create an 802.1Q
2248 VLAN header for packets sent from the
2255 must both be set at the same time.
2256 .It Cm vlandev Ar iface
2257 Associate the physical interface
2262 Packets transmitted through the
2265 diverted to the specified physical interface
2267 with 802.1Q VLAN encapsulation.
2268 Packets with 802.1Q encapsulation received
2269 by the parent interface with the correct VLAN tag will be diverted to
2275 interface is assigned a
2276 copy of the parent interface's flags and the parent's ethernet address.
2281 must both be set at the same time.
2284 interface already has
2285 a physical interface associated with it, this command will fail.
2287 change the association to another physical interface, the existing
2288 association must be cleared first.
2290 Note: if the hardware tagging capability
2291 is set on the parent interface, the
2294 interface's behavior changes:
2297 interface recognizes that the
2298 parent interface supports insertion and extraction of VLAN tags on its
2299 own (usually in firmware) and that it should pass packets to and from
2300 the parent unaltered.
2301 .It Fl vlandev Op Ar iface
2304 pseudo device, disassociate the parent interface from it.
2305 This breaks the link between the
2307 interface and its parent,
2308 clears its VLAN tag, flags and its link address and shuts the interface down.
2311 argument is useless and hence deprecated.
2314 The following parameters are specific to
2317 .Bl -tag -width indent
2318 .It Cm advbase Ar seconds
2319 Specifies the base of the advertisement interval in seconds.
2320 The acceptable values are 1 to 255.
2321 The default value is 1.
2322 .\" The default value is
2323 .\" .Dv CARP_DFLTINTV .
2324 .It Cm advskew Ar interval
2325 Specifies the skew to add to the base advertisement interval to
2326 make one host advertise slower than another host.
2327 It is specified in 1/256 of seconds.
2328 The acceptable values are 1 to 254.
2329 The default value is 0.
2330 .It Cm pass Ar phrase
2331 Set the authentication key to
2334 Set the virtual host ID.
2335 This is a required setting.
2336 Acceptable values are 1 to 255.
2341 utility displays the current configuration for a network interface
2342 when no optional parameters are supplied.
2343 If a protocol family is specified,
2345 will report only the details specific to that protocol family.
2349 flag is passed before an interface name,
2351 will display the capability list and all
2352 of the supported media for the specified interface.
2355 flag is supplied, address lifetime is displayed for IPv6 addresses,
2356 as time offset string.
2360 flag may be used instead of an interface name.
2363 to display information about all interfaces in the system.
2366 flag limits this to interfaces that are down, and
2368 limits this to interfaces that are up.
2369 When no arguments are given,
2375 flag may be used to list all available interfaces on the system, with
2376 no other additional information.
2377 Use of this flag is mutually exclusive
2378 with all other flags and commands, except for
2380 (only list interfaces that are down)
2383 (only list interfaces that are up).
2387 flag may be used to get more verbose status for an interface.
2391 flag may be used to list all of the interface cloners available on
2392 the system, with no additional information.
2393 Use of this flag is mutually exclusive with all other flags and commands.
2397 flag causes keying information for the interface, if available, to be
2399 For example, the values of 802.11 WEP keys will be printed, if accessible to
2401 This information is not printed by default, as it may be considered
2404 If the network interface driver is not present in the kernel then
2406 will attempt to load it.
2409 flag disables this behavior.
2411 Only the super-user may modify the configuration of a network interface.
2413 The media selection system is relatively new and only some drivers support
2414 it (or have need for it).
2416 Assign the IPv4 address
2418 with a network mask of
2422 .Dl # ifconfig fxp0 inet 192.0.2.10 netmask 255.255.255.0
2424 Add the IPv4 address
2426 with the CIDR network prefix
2432 as a synonym for the canonical form of the option
2434 .Dl # ifconfig ed0 inet 192.0.2.45/28 add
2436 Remove the IPv4 address
2440 .Dl # ifconfig ed0 inet 192.0.2.45 -alias
2442 Add the IPv6 address
2443 .Li 2001:DB8:DBDB::123/48
2446 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias
2447 Note that lower case hexadecimal IPv6 addresses are acceptable.
2449 Remove the IPv6 address added in the above example,
2452 character as shorthand for the network prefix,
2455 as a synonym for the canonical form of the option
2457 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 delete
2459 Configure the interface
2461 to use 100baseTX, full duplex Ethernet media options:
2462 .Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex
2464 Create the software network interface
2466 .Dl # ifconfig gif1 create
2468 Destroy the software network interface
2470 .Dl # ifconfig gif1 destroy
2472 Messages indicating the specified interface does not exist, the
2473 requested address is unknown, or the user is not privileged and
2474 tried to alter an interface's configuration.
2494 Basic IPv6 node operation requires a link-local address on each
2495 interface configured for IPv6.
2496 Normally, such an address is automatically configured by the
2497 kernel on each interface added to the system; this behaviour may
2498 be disabled by setting the sysctl MIB variable
2499 .Va net.inet6.ip6.auto_linklocal
2502 If you delete such an address using
2504 the kernel may act very odd.
2505 Do this at your own risk.
projects / FreeBSD / releng / 8.0.git / blob